Module: Ruconomic::API::SubscriptionLine

Extended by:
WebService
Defined in:
lib/ruconomic/api/subscription_line.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 line. Parameters: subscriptionHandle: Handle for a subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

.find_by_productHash

Note:

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

Returns handles for subscription lines that use a given products. Parameters: product: The product to search for.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

.find_by_product_listHash

Note:

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

Returns handles for subscription lines that use a given set of products. Parameters: products: The products to search for.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

def self.find_by_product_list
  response = invoke('SubscriptionLine_FindByProductList') 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 subscription lines that use a given subscriptions. Parameters: subscription: The subscription to search for.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

def self.find_by_subscription
  response = invoke('SubscriptionLine_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 subscription lines 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:



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

def self.find_by_subscripton_list
  response = invoke('SubscriptionLine_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 subsciption lines.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

def self.get_data
  response = invoke('SubscriptionLine_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 subscription line data objects for subscription lines. Parameters: entityHandles: The array of subscription line handles.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

.get_departmentHash

Note:

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

Gets a handle for the department of a subscription line. The department is only accessible when there is access to the Dimension add-on module. Parameters: subscriptionLineHandle: Handle for the subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

def self.get_department
  response = invoke('SubscriptionLine_GetDepartment') 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 a subscription line. Parameters: SubscriptionLineHandle: Handle for the subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

.get_productHash

Note:

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

Gets a handle for the product of a subscription line. Parameters: SubscriptionLineHandle: Handle for the subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

.get_product_nameHash

Note:

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

Gets the description of a subscription line. Parameters: subscriptionLineHandle: Handle for the subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

.get_quantityHash

Note:

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

Gets the primary quantity of a subscription line. Parameters: subscriptionLineHandle: Handle for the subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

def self.get_quantity
  response = invoke('SubscriptionLine_GetQuantity') 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

Gets the special price of a product. Parameters: subscriptionLineHandle: Handle for the current subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

def self.get_special_price
  response = invoke('SubscriptionLine_GetSpecialPrice') 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 a subscription line. Parameters: SubscriptionLineHandle: Handle for the subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

.set_departmentHash

Note:

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

Sets the department of a subscription line. The department is only accessible when there is access to the Dimension add-on module. The department cannot be set when the distribution key is set. Parameters: subscriptionLineHandle: Handle for the subscription line. value: Handle for the new department of the subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

.set_productHash

Note:

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

Sets the product of a subscription line. Setting the product also sets the unit cost price to the cost price of the product. The product must be set before setting the quantity and the unit net price. Parameters: SubscriptionLineHandle: Handle for the subscription line. valueHandle: Handle for the new product of the subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

.set_product_nameHash

Note:

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

Sets the description of a subscription line. Parameters: subscriptionLineHandle: Handle for the subscription line. value: The new description of the subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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

.set_quantityHash

Note:

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

Sets the primary quantity of a subscription line. The product of the subscription line must be set before setting this property. Parameters: subscriptionLineHandle: Handle for the subscription line. value: The new primary quantity of the subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

def self.set_quantity
  response = invoke('SubscriptionLine_SetQuantity') 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

Sets the special price of a product. Parameters: subscriptionLineHandle: Handle for the current subscription line.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

def self.set_special_price
  response = invoke('SubscriptionLine_SetSpecialPrice') 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 line from a data object. Parameters: data: The data object.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

def self.update_from_data
  response = invoke('SubscriptionLine_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 subscription lines from data objects. Parameters: dataArray: The array of data objects.

Returns:

  • (Hash)

    The body content of the SOAP response.

See Also:



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

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