Class: Solifyn::ProductAddOnsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/solifyn/api/product_add_ons_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProductAddOnsApi

Returns a new instance of ProductAddOnsApi.



19
20
21
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#products_create_addon(id, addon_create, opts = {}) ⇒ Addon

Create Product Add-on Attach a new add-on configuration to a product.

Parameters:

  • id (String) —

    The parent product ID.

  • addon_create (AddonCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 28

def products_create_addon(id, addon_create, opts = {})
  data, _status_code, _headers = products_create_addon_with_http_info(id, addon_create, opts)
  data
end

#products_create_addon_with_http_info(id, addon_create, opts = {}) ⇒ Array<(Addon, Integer, Hash)>

Create Product Add-on Attach a new add-on configuration to a product.

Parameters:

  • id (String) —

    The parent product ID.

  • addon_create (AddonCreate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Addon, Integer, Hash)>) —

    Addon data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 39

def products_create_addon_with_http_info(id, addon_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductAddOnsApi.products_create_addon ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductAddOnsApi.products_create_addon"
  end
  # verify the required parameter 'addon_create' is set
  if @api_client.config.client_side_validation && addon_create.nil?
    fail ArgumentError, "Missing the required parameter 'addon_create' when calling ProductAddOnsApi.products_create_addon"
  end
  # resource path
  local_var_path = '/v1/products/{id}/addons'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(addon_create)

  # return_type
  return_type = opts[:debug_return_type] || 'Addon'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ProductAddOnsApi.products_create_addon",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductAddOnsApi#products_create_addon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#products_delete_addon(id, addon_id, opts = {}) ⇒ ProductMessageResponseDto

Delete Product Add-on Remove an add-on configuration from a product.

Parameters:

  • id (String) —

    The parent product ID.

  • addon_id (String) —

    The add-on product ID to remove.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 102

def products_delete_addon(id, addon_id, opts = {})
  data, _status_code, _headers = products_delete_addon_with_http_info(id, addon_id, opts)
  data
end

#products_delete_addon_with_http_info(id, addon_id, opts = {}) ⇒ Array<(ProductMessageResponseDto, Integer, Hash)>

Delete Product Add-on Remove an add-on configuration from a product.

Parameters:

  • id (String) —

    The parent product ID.

  • addon_id (String) —

    The add-on product ID to remove.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ProductMessageResponseDto, Integer, Hash)>) —

    ProductMessageResponseDto data, response status code and response headers



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 113

def products_delete_addon_with_http_info(id, addon_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductAddOnsApi.products_delete_addon ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductAddOnsApi.products_delete_addon"
  end
  # verify the required parameter 'addon_id' is set
  if @api_client.config.client_side_validation && addon_id.nil?
    fail ArgumentError, "Missing the required parameter 'addon_id' when calling ProductAddOnsApi.products_delete_addon"
  end
  # resource path
  local_var_path = '/v1/products/{id}/addons/{addonId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'addonId' + '}', CGI.escape(addon_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ProductMessageResponseDto'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ProductAddOnsApi.products_delete_addon",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductAddOnsApi#products_delete_addon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#products_get_addon(id, addon_id, opts = {}) ⇒ Addon

Retrieve Product Add-on Retrieve a specific add-on configuration of a product.

Parameters:

  • id (String) —

    The parent product ID.

  • addon_id (String) —

    The add-on product ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



171
172
173
174
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 171

def products_get_addon(id, addon_id, opts = {})
  data, _status_code, _headers = products_get_addon_with_http_info(id, addon_id, opts)
  data
end

#products_get_addon_with_http_info(id, addon_id, opts = {}) ⇒ Array<(Addon, Integer, Hash)>

Retrieve Product Add-on Retrieve a specific add-on configuration of a product.

Parameters:

  • id (String) —

    The parent product ID.

  • addon_id (String) —

    The add-on product ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Addon, Integer, Hash)>) —

    Addon data, response status code and response headers



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 182

def products_get_addon_with_http_info(id, addon_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductAddOnsApi.products_get_addon ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductAddOnsApi.products_get_addon"
  end
  # verify the required parameter 'addon_id' is set
  if @api_client.config.client_side_validation && addon_id.nil?
    fail ArgumentError, "Missing the required parameter 'addon_id' when calling ProductAddOnsApi.products_get_addon"
  end
  # resource path
  local_var_path = '/v1/products/{id}/addons/{addonId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'addonId' + '}', CGI.escape(addon_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Addon'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ProductAddOnsApi.products_get_addon",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductAddOnsApi#products_get_addon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#products_list_addons(id, opts = {}) ⇒ Array<Addon>

List Product Add-ons Retrieve all add-on configurations attached to a product.

Parameters:

  • id (String) —

    The parent product ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



239
240
241
242
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 239

def products_list_addons(id, opts = {})
  data, _status_code, _headers = products_list_addons_with_http_info(id, opts)
  data
end

#products_list_addons_with_http_info(id, opts = {}) ⇒ Array<(Array<Addon>, Integer, Hash)>

List Product Add-ons Retrieve all add-on configurations attached to a product.

Parameters:

  • id (String) —

    The parent product ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<Addon>, Integer, Hash)>) —

    Array<Addon> data, response status code and response headers



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 249

def products_list_addons_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductAddOnsApi.products_list_addons ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductAddOnsApi.products_list_addons"
  end
  # resource path
  local_var_path = '/v1/products/{id}/addons'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Addon>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ProductAddOnsApi.products_list_addons",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductAddOnsApi#products_list_addons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#products_list_all_addons(opts = {}) ⇒ nil

List All Add-ons Retrieve all configured add-on configurations for the active business.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


301
302
303
304
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 301

def products_list_all_addons(opts = {})
  products_list_all_addons_with_http_info(opts)
  nil
end

#products_list_all_addons_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

List All Add-ons Retrieve all configured add-on configurations for the active business.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 310

def products_list_all_addons_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductAddOnsApi.products_list_all_addons ...'
  end
  # resource path
  local_var_path = '/v1/products/all-addons/list'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ProductAddOnsApi.products_list_all_addons",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductAddOnsApi#products_list_all_addons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#products_update_addon(id, addon_id, addon_update, opts = {}) ⇒ Addon

Update Product Add-on Update an existing add-on configuration for a product.

Parameters:

  • id (String) —

    The parent product ID.

  • addon_id (String) —

    The add-on product ID.

  • addon_update (AddonUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



359
360
361
362
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 359

def products_update_addon(id, addon_id, addon_update, opts = {})
  data, _status_code, _headers = products_update_addon_with_http_info(id, addon_id, addon_update, opts)
  data
end

#products_update_addon_with_http_info(id, addon_id, addon_update, opts = {}) ⇒ Array<(Addon, Integer, Hash)>

Update Product Add-on Update an existing add-on configuration for a product.

Parameters:

  • id (String) —

    The parent product ID.

  • addon_id (String) —

    The add-on product ID.

  • addon_update (AddonUpdate)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Addon, Integer, Hash)>) —

    Addon data, response status code and response headers



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/solifyn/api/product_add_ons_api.rb', line 371

def products_update_addon_with_http_info(id, addon_id, addon_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductAddOnsApi.products_update_addon ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductAddOnsApi.products_update_addon"
  end
  # verify the required parameter 'addon_id' is set
  if @api_client.config.client_side_validation && addon_id.nil?
    fail ArgumentError, "Missing the required parameter 'addon_id' when calling ProductAddOnsApi.products_update_addon"
  end
  # verify the required parameter 'addon_update' is set
  if @api_client.config.client_side_validation && addon_update.nil?
    fail ArgumentError, "Missing the required parameter 'addon_update' when calling ProductAddOnsApi.products_update_addon"
  end
  # resource path
  local_var_path = '/v1/products/{id}/addons/{addonId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'addonId' + '}', CGI.escape(addon_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(addon_update)

  # return_type
  return_type = opts[:debug_return_type] || 'Addon'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

  new_options = opts.merge(
    :operation => :"ProductAddOnsApi.products_update_addon",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductAddOnsApi#products_update_addon\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end