Module: Ruconomic::API::Subscription

Extended by:
WebService
Defined in:
lib/ruconomic/api/subscription.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 subscription. Parameters: subscriptionNumber: subscription number for the subscription. subscriptionName: subscription name for the subscription. description: description for the subscription. includeName: Enables include name for the subscription. subscriptionInterval: subscription interval for the subscription, calendarYearBasis: Enables calendar year for the subscription. collection: Collection for the subscription. addPeriod: enables add period for the subscription. allowMoreThanOneForEachDebtor: enables to allow more than one for each debitor for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


288
289
290
291
292
# File 'lib/ruconomic/api/subscription.rb', line 288

def self.create
  response = invoke('Subscription_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 subscription from a data object. Parameters: data: The data object that specifies the properties of the new subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

def self.create_from_data
  response = invoke('Subscription_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 subscriptions from data objects. Parameters: dataArray: The array of data objects that specifies the properties of the new subscriptions.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

def self.create_from_data_array
  response = invoke('Subscription_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 subscription. Parameters: subscriptionHandle: Handle for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


345
346
347
348
349
# File 'lib/ruconomic/api/subscription.rb', line 345

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

.find_by_nameHash

Note:

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

Returns handles for the subscriptions with the given name. Parameters: name: The name to search for.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

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

.find_by_numberHash

Note:

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

Returns handle for subscription with a given number.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

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

.get_add_periodHash

Note:

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

Gets the status whether or not a period should be added after the subscription name. Parameters: subscriptionHandle: Handle for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


240
241
242
243
244
# File 'lib/ruconomic/api/subscription.rb', line 240

def self.get_add_period
  response = invoke('Subscription_GetAddPeriod') 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 subscriptions.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


367
368
369
370
371
# File 'lib/ruconomic/api/subscription.rb', line 367

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

.get_allow_more_than_one_for_each_debtorHash

Note:

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

Gets or sets whether more than one subscription is allowed for each debtor. Parameters: subscriptionHandle: Handle for the subscription.


276
277
278
279
280
# File 'lib/ruconomic/api/subscription.rb', line 276

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

.get_calendar_year_basisHash

Note:

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

Gets whether or not the subscripton should be created based on the calendar year. Parameters: subscriptionHandle: Handle for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


192
193
194
195
196
# File 'lib/ruconomic/api/subscription.rb', line 192

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

.get_collectionHash

Note:

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

Gets whether or not there should be a Full or Proportional collection for the subscription. Parameters: subscriptionHandle: Handle for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


228
229
230
231
232
# File 'lib/ruconomic/api/subscription.rb', line 228

def self.get_collection
  response = invoke('Subscription_GetCollection') 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 subscription data object for a given subscripton. Parameters: entityHandle: A handle for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

def self.get_data
  response = invoke('Subscription_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 current subscriptions objects for a given set of subscription handles. Parameters: entityHandles: An array of the subscription handles.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

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

.get_descriptionHash

Note:

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

Gets the description for the subscription. Parameters: subscriptionHandle: Handle for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


120
121
122
123
124
# File 'lib/ruconomic/api/subscription.rb', line 120

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

.get_include_nameHash

Note:

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

Gets whether or not the subscription name should be included as the first product line. Parameters: subscriptionHandle: Handle for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


144
145
146
147
148
# File 'lib/ruconomic/api/subscription.rb', line 144

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

.get_nameHash

Note:

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

Gets the name of the subscription. Parameters: subscriptionHandle: Handle for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


96
97
98
99
100
# File 'lib/ruconomic/api/subscription.rb', line 96

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

.get_next_available_numberHash

Note:

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

Returns the next available subscription number.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


333
334
335
336
337
# File 'lib/ruconomic/api/subscription.rb', line 333

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

.get_numberHash

Note:

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

Gets the number of the subscription. Parameters: subscriptionHandle: Handle for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


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

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

.get_subscribersHash

Note:

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

Gets handles for the subscribers of the subscription

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


356
357
358
359
360
# File 'lib/ruconomic/api/subscription.rb', line 356

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

.get_subscription_intervalHash

Note:

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

Gets the interval of the subscription. Parameters: subscriptionHandle: Handle for the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


180
181
182
183
184
# File 'lib/ruconomic/api/subscription.rb', line 180

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

.get_subscription_linesHash

Note:

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

Returns handles for the lines of the subscription

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


322
323
324
325
326
# File 'lib/ruconomic/api/subscription.rb', line 322

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

.set_add_periodHash

Note:

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

Sets the status whether or not a period should be added after the subscription name. Parameters: subscriptionHandle: Handle for the subscription. value: The status whether or not a period should be added after the subscription name.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


252
253
254
255
256
# File 'lib/ruconomic/api/subscription.rb', line 252

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

.set_allow_more_than_one_for_each_debtorHash

Note:

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

Sets or sets whether more than one subscription is allowed for each debtor. Parameters: subscriptionHandle: Handle for the subscription. value: The new value of the property.


264
265
266
267
268
# File 'lib/ruconomic/api/subscription.rb', line 264

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

.set_calendar_year_basisHash

Note:

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

Sets whether or not the subscripton should be created based on the calendar year. Parameters: subscriptionHandle: Handle for the subscription. value: The new calendar year state of the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


204
205
206
207
208
# File 'lib/ruconomic/api/subscription.rb', line 204

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

.set_collectionHash

Note:

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

Sets whether or not there should be a Full or Proportional collection for the subscription. Parameters: subscriptionHandle: Handle for the subscription. value: The new collection type of the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


216
217
218
219
220
# File 'lib/ruconomic/api/subscription.rb', line 216

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

.set_descriptionHash

Note:

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

Sets the description for the subscription. Parameters: subscriptionHandle: Handle for the subscription. value: The new description of the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


132
133
134
135
136
# File 'lib/ruconomic/api/subscription.rb', line 132

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

.set_include_nameHash

Note:

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

Sets whether or not the subscription name should be included as the first product line. Parameters: subscriptionHandle: Handle for the subscription. value: The new value of the parameter.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


156
157
158
159
160
# File 'lib/ruconomic/api/subscription.rb', line 156

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

.set_nameHash

Note:

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

Set the name of the subscription. Parameters: subscriptionHandle: Handle for the subscription. value: The new name of the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


108
109
110
111
112
# File 'lib/ruconomic/api/subscription.rb', line 108

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

.set_subscription_intervalHash

Note:

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

Sets the interval of the subscription. Parameters: subscriptionHandle: Handle for the subscription. value: The new interval of the subscription.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:


168
169
170
171
172
# File 'lib/ruconomic/api/subscription.rb', line 168

def self.set_subscription_interval
  response = invoke('Subscription_SetSubscriptionInterval') 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 subscription 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/subscription.rb', line 48

def self.update_from_data
  response = invoke('Subscription_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 subscriptions 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/subscription.rb', line 36

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