Module: Ruconomic::API::Subscriber

Extended by:
WebService
Defined in:
lib/ruconomic/api/subscriber.rb

Class Method Summary collapse

Class Method Details

.createHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Creates a new subscriber. Parameters: debtor: Handle for a debtor. subscription: Handle for a subscription. startDate: start date for subscriber. registeredDate: date registered. endDate: end date for subscriber

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


84
85
86
87
88
# File 'lib/ruconomic/api/subscriber.rb', line 84

def self.create
  response = invoke('Subscriber_Create') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.create_from_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Creates a new subscriber from a data object. Parameters: data: The data object that specifies the properties of the new subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


12
13
14
15
16
# File 'lib/ruconomic/api/subscriber.rb', line 12

def self.create_from_data
  response = invoke('Subscriber_CreateFromData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.create_from_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Creates new subscribers from data objects. Parameters: dataArray: The array of data objects that specifies the properties of the new subscribers.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


24
25
26
27
28
# File 'lib/ruconomic/api/subscriber.rb', line 24

def self.create_from_data_array
  response = invoke('Subscriber_CreateFromDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.deleteHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Deletes a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


131
132
133
134
135
# File 'lib/ruconomic/api/subscriber.rb', line 131

def self.delete
  response = invoke('Subscriber_Delete') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.find_by_subscriptionHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns handles for subscribers that use a given subscriptions. Parameters: subscription: The subscription to search for.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


107
108
109
110
111
# File 'lib/ruconomic/api/subscriber.rb', line 107

def self.find_by_subscription
  response = invoke('Subscriber_FindBySubscription') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.find_by_subscripton_listHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns handles for subscribers that use a given set of subscriptions. Parameters: subscriptions: The subscriptions to search for.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


119
120
121
122
123
# File 'lib/ruconomic/api/subscriber.rb', line 119

def self.find_by_subscripton_list
  response = invoke('Subscriber_FindBySubscriptonList') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_allHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns handles for all current subscribers.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


95
96
97
98
99
# File 'lib/ruconomic/api/subscriber.rb', line 95

def self.get_all
  response = invoke('Subscriber_GetAll') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_commentsHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the comments of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


359
360
361
362
363
# File 'lib/ruconomic/api/subscriber.rb', line 359

def self.get_comments
  response = invoke('Subscriber_GetComments') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns a subscriber data object for a given subscriber. Parameters: entityHandle: A handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


60
61
62
63
64
# File 'lib/ruconomic/api/subscriber.rb', line 60

def self.get_data
  response = invoke('Subscriber_GetData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Returns subscriber data objects for a given set of subscriber handles. Parameters: entityHandles: An array of the subscriber handles.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


72
73
74
75
76
# File 'lib/ruconomic/api/subscriber.rb', line 72

def self.get_data_array
  response = invoke('Subscriber_GetDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_debtorHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the debtor of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


143
144
145
146
147
# File 'lib/ruconomic/api/subscriber.rb', line 143

def self.get_debtor
  response = invoke('Subscriber_GetDebtor') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_discount_as_percentHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the discount percentage of a subscriber. Parameters: subscriberHandle: Handle for the discount percentage. value: The new name for the discount percentage.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


467
468
469
470
471
# File 'lib/ruconomic/api/subscriber.rb', line 467

def self.get_discount_as_percent
  response = invoke('Subscriber_GetDiscountAsPercent') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_discount_expiry_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the discount expiry date of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


311
312
313
314
315
# File 'lib/ruconomic/api/subscriber.rb', line 311

def self.get_discount_expiry_date
  response = invoke('Subscriber_GetDiscountExpiryDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_end_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the end date of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


263
264
265
266
267
# File 'lib/ruconomic/api/subscriber.rb', line 263

def self.get_end_date
  response = invoke('Subscriber_GetEndDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_expiry_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the expiry date of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


287
288
289
290
291
# File 'lib/ruconomic/api/subscriber.rb', line 287

def self.get_expiry_date
  response = invoke('Subscriber_GetExpiryDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_extra_text_for_invoiceHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets or sets the extra text for the invoice for the subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


335
336
337
338
339
# File 'lib/ruconomic/api/subscriber.rb', line 335

def self.get_extra_text_for_invoice
  response = invoke('Subscriber_GetExtraTextForInvoice') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_price_indexHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the price index of a subscriber. Parameters: subscriberHandle: Handle for the subscriber. value: The price index for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


443
444
445
446
447
# File 'lib/ruconomic/api/subscriber.rb', line 443

def self.get_price_index
  response = invoke('Subscriber_GetPriceIndex') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_projectHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the product of a subscriber. Parameters: SubscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


191
192
193
194
195
# File 'lib/ruconomic/api/subscriber.rb', line 191

def self.get_project
  response = invoke('Subscriber_GetProject') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_quantity_factorHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the quantity factor of a subscriber. Parameters: subscriberHandle: Handle for the subscriber. value: The quantity factor for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


419
420
421
422
423
# File 'lib/ruconomic/api/subscriber.rb', line 419

def self.get_quantity_factor
  response = invoke('Subscriber_GetQuantityFactor') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_registered_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the registered date of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


239
240
241
242
243
# File 'lib/ruconomic/api/subscriber.rb', line 239

def self.get_registered_date
  response = invoke('Subscriber_GetRegisteredDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_special_priceHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the special price of a subscriber. Parameters: subscriberHandle: Handle for the subscriber. value: The new special price for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


395
396
397
398
399
# File 'lib/ruconomic/api/subscriber.rb', line 395

def self.get_special_price
  response = invoke('Subscriber_GetSpecialPrice') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_start_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the start date of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


215
216
217
218
219
# File 'lib/ruconomic/api/subscriber.rb', line 215

def self.get_start_date
  response = invoke('Subscriber_GetStartDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.get_subscriptionHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets a handle for the subscription of the subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


167
168
169
170
171
# File 'lib/ruconomic/api/subscriber.rb', line 167

def self.get_subscription
  response = invoke('Subscriber_GetSubscription') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_commentsHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the comments of a subscriber. Parameters: subscriberHandle: Handle for the subscriber. value: The new name for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


371
372
373
374
375
# File 'lib/ruconomic/api/subscriber.rb', line 371

def self.set_comments
  response = invoke('Subscriber_SetComments') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_debtorHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets a handle for the debtor of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


155
156
157
158
159
# File 'lib/ruconomic/api/subscriber.rb', line 155

def self.set_debtor
  response = invoke('Subscriber_SetDebtor') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_discount_as_percentHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the discount percentage of a subscriber. Parameters: subscriberHandle: Handle for the discount percentage.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


455
456
457
458
459
# File 'lib/ruconomic/api/subscriber.rb', line 455

def self.set_discount_as_percent
  response = invoke('Subscriber_SetDiscountAsPercent') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_discount_expiry_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Set the discount expiry date of a subscriber. Parameters: subscriberHandle: Handle for the subscriber. value: The discount expiry date of the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


323
324
325
326
327
# File 'lib/ruconomic/api/subscriber.rb', line 323

def self.set_discount_expiry_date
  response = invoke('Subscriber_SetDiscountExpiryDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_end_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Set the end date of a subscriber. Parameters: subscriberHandle: Handle for the subscriber. value: The new end date of the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


275
276
277
278
279
# File 'lib/ruconomic/api/subscriber.rb', line 275

def self.set_end_date
  response = invoke('Subscriber_SetEndDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_expiry_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Set the expiry date of a subscriber. Parameters: subscriberHandle: Handle for the subscriber. value: The new expiry of the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


299
300
301
302
303
# File 'lib/ruconomic/api/subscriber.rb', line 299

def self.set_expiry_date
  response = invoke('Subscriber_SetExpiryDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_extra_text_for_invoiceHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the extra text for the invoice for the subscriber. Parameters: subscriberHandle: Handle for the subscriber. value: The extra text for the invoice for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


347
348
349
350
351
# File 'lib/ruconomic/api/subscriber.rb', line 347

def self.set_extra_text_for_invoice
  response = invoke('Subscriber_SetExtraTextForInvoice') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_price_indexHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the price index of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


431
432
433
434
435
# File 'lib/ruconomic/api/subscriber.rb', line 431

def self.set_price_index
  response = invoke('Subscriber_SetPriceIndex') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_projectHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets the product of a subscriber. Parameters: SubscriberHandle: Handle for the subscriber. valueHandle: Handle for the new product of the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


203
204
205
206
207
# File 'lib/ruconomic/api/subscriber.rb', line 203

def self.set_project
  response = invoke('Subscriber_SetProject') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_quantity_factorHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the quantity factor of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


407
408
409
410
411
# File 'lib/ruconomic/api/subscriber.rb', line 407

def self.set_quantity_factor
  response = invoke('Subscriber_SetQuantityFactor') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_registered_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Set the registered date of a subscriber. Parameters: subscriberHandle: Handle for the subscriber. value: The new registered date of the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


251
252
253
254
255
# File 'lib/ruconomic/api/subscriber.rb', line 251

def self.set_registered_date
  response = invoke('Subscriber_SetRegisteredDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_special_priceHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Gets the special price of a subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


383
384
385
386
387
# File 'lib/ruconomic/api/subscriber.rb', line 383

def self.set_special_price
  response = invoke('Subscriber_SetSpecialPrice') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_start_dateHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Set the start date of a subscriber. Parameters: subscriberHandle: Handle for the subscriber. value: The new start date of the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


227
228
229
230
231
# File 'lib/ruconomic/api/subscriber.rb', line 227

def self.set_start_date
  response = invoke('Subscriber_SetStartDate') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.set_subscriptionHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Sets a handle for the subscription of the subscriber. Parameters: subscriberHandle: Handle for the subscriber.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


179
180
181
182
183
# File 'lib/ruconomic/api/subscriber.rb', line 179

def self.set_subscription
  response = invoke('Subscriber_SetSubscription') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.update_from_dataHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Updates a subscriber from a data object. Parameters: data: The data object.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


48
49
50
51
52
# File 'lib/ruconomic/api/subscriber.rb', line 48

def self.update_from_data
  response = invoke('Subscriber_UpdateFromData') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end

.update_from_data_arrayHash

Note:

TODO: This method was autogenerated from the WSDL - see github.com/ta/ruconomic#contributing

Update subscribers from data objects. Parameters: dataArray: The array of data objects.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


36
37
38
39
40
# File 'lib/ruconomic/api/subscriber.rb', line 36

def self.update_from_data_array
  response = invoke('Subscriber_UpdateFromDataArray') do |message|
    raise "TODO: This method was autogenerated from the WSDL - see https://github.com/ta/ruconomic#contributing"
  end
end