Class: WalleeRubySdk::SubscriptionProductMeteredFeeTiersService

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubscriptionProductMeteredFeeTiersService

Returns a new instance of SubscriptionProductMeteredFeeTiersService.



28
29
30
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 28

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



25
26
27
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 25

def api_client
  @api_client
end

Instance Method Details

#delete_subscriptions_products_metered_fees_fee_id_tiers_id(fee_id, id, space, opts = {}) ⇒ nil

Delete a metered fee tier

Parameters:

  • fee_id (Integer)
  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

  • (nil) 


37
38
39
40
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 37

def delete_subscriptions_products_metered_fees_fee_id_tiers_id(fee_id, id, space, opts = {})
  delete_subscriptions_products_metered_fees_fee_id_tiers_id_with_http_info(fee_id, id, space, opts)
  nil
end

#delete_subscriptions_products_metered_fees_fee_id_tiers_id_with_http_info(fee_id, id, space, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Returns nil, response status code and response headers.

Parameters:

  • fee_id (Integer)
  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
95
96
97
98
99
100
101
102
103
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 49

def delete_subscriptions_products_metered_fees_fee_id_tiers_id_with_http_info(fee_id, id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionProductMeteredFeeTiersService.delete_subscriptions_products_metered_fees_fee_id_tiers_id ...'
  end
  # verify the required parameter 'fee_id' is set
  if @api_client.config.client_side_validation && fee_id.nil?
    fail ArgumentError, "Missing the required parameter 'fee_id' when calling SubscriptionProductMeteredFeeTiersService.delete_subscriptions_products_metered_fees_fee_id_tiers_id"
  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 SubscriptionProductMeteredFeeTiersService.delete_subscriptions_products_metered_fees_fee_id_tiers_id"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling SubscriptionProductMeteredFeeTiersService.delete_subscriptions_products_metered_fees_fee_id_tiers_id"
  end
  # resource path
  local_var_path = '/subscriptions/products/metered-fees/{feeId}/tiers/{id}'.sub('{' + 'feeId' + '}', CGI.escape(fee_id.to_s)).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']
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

  # return_type
  return_type = opts[:debug_return_type]

  new_options = opts.merge(
    :operation => :"SubscriptionProductMeteredFeeTiersService.delete_subscriptions_products_metered_fees_fee_id_tiers_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionProductMeteredFeeTiersService#delete_subscriptions_products_metered_fees_fee_id_tiers_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_subscriptions_products_metered_fees_fee_id_tiers(fee_id, space, opts = {}) ⇒ ProductMeteredFeeTierListResponse

List all metered fee tiers

Parameters:

  • fee_id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :after (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately after the named object.

  • :before (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately before the named object.

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :order (SortingOrder) —

    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.

Returns:



116
117
118
119
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 116

def get_subscriptions_products_metered_fees_fee_id_tiers(fee_id, space, opts = {})
  data, _status_code, _headers = get_subscriptions_products_metered_fees_fee_id_tiers_with_http_info(fee_id, space, opts)
  data
end

#get_subscriptions_products_metered_fees_fee_id_tiers_id(fee_id, id, space, opts = {}) ⇒ ProductMeteredTierFee

Retrieve a metered fee tier

Parameters:

  • fee_id (Integer)
  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



213
214
215
216
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 213

def get_subscriptions_products_metered_fees_fee_id_tiers_id(fee_id, id, space, opts = {})
  data, _status_code, _headers = get_subscriptions_products_metered_fees_fee_id_tiers_id_with_http_info(fee_id, id, space, opts)
  data
end

#get_subscriptions_products_metered_fees_fee_id_tiers_id_with_http_info(fee_id, id, space, opts = {}) ⇒ Array<(ProductMeteredTierFee, Integer, Hash)>

Returns ProductMeteredTierFee data, response status code and response headers.

Parameters:

  • fee_id (Integer)
  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

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

    ProductMeteredTierFee data, response status code and response headers



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
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
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 226

def get_subscriptions_products_metered_fees_fee_id_tiers_id_with_http_info(fee_id, id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_id ...'
  end
  # verify the required parameter 'fee_id' is set
  if @api_client.config.client_side_validation && fee_id.nil?
    fail ArgumentError, "Missing the required parameter 'fee_id' when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_id"
  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 SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_id"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_id"
  end
  # resource path
  local_var_path = '/subscriptions/products/metered-fees/{feeId}/tiers/{id}'.sub('{' + 'feeId' + '}', CGI.escape(fee_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # 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']
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

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

  new_options = opts.merge(
    :operation => :"SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionProductMeteredFeeTiersService#get_subscriptions_products_metered_fees_fee_id_tiers_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_subscriptions_products_metered_fees_fee_id_tiers_search(fee_id, space, opts = {}) ⇒ ProductMeteredFeeTierSearchResponse

Search metered fee tiers

Parameters:

  • fee_id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:



294
295
296
297
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 294

def get_subscriptions_products_metered_fees_fee_id_tiers_search(fee_id, space, opts = {})
  data, _status_code, _headers = get_subscriptions_products_metered_fees_fee_id_tiers_search_with_http_info(fee_id, space, opts)
  data
end

#get_subscriptions_products_metered_fees_fee_id_tiers_search_with_http_info(fee_id, space, opts = {}) ⇒ Array<(ProductMeteredFeeTierSearchResponse, Integer, Hash)>

Returns ProductMeteredFeeTierSearchResponse data, response status code and response headers.

Parameters:

  • fee_id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :offset (Integer) —

    A cursor for pagination, specifies the number of objects to skip.

  • :order (String) —

    The fields and order to sort the objects by.

  • :query (String) —

    The search query to filter the objects by.

Returns:



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
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 310

def get_subscriptions_products_metered_fees_fee_id_tiers_search_with_http_info(fee_id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_search ...'
  end
  # verify the required parameter 'fee_id' is set
  if @api_client.config.client_side_validation && fee_id.nil?
    fail ArgumentError, "Missing the required parameter 'fee_id' when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_search"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_search"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_search, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_search, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_search, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = '/subscriptions/products/metered-fees/{feeId}/tiers/search'.sub('{' + 'feeId' + '}', CGI.escape(fee_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?
  query_params[:'limit'] = opts[:'limit'] unless opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] unless opts[:'offset'].nil?
  query_params[:'order'] = opts[:'order'] unless opts[:'order'].nil?
  query_params[:'query'] = opts[:'query'] unless opts[:'query'].nil?

  # 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']
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

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

  new_options = opts.merge(
    :operation => :"SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers_search",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionProductMeteredFeeTiersService#get_subscriptions_products_metered_fees_fee_id_tiers_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#get_subscriptions_products_metered_fees_fee_id_tiers_with_http_info(fee_id, space, opts = {}) ⇒ Array<(ProductMeteredFeeTierListResponse, Integer, Hash)>

Returns ProductMeteredFeeTierListResponse data, response status code and response headers.

Parameters:

  • fee_id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :after (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately after the named object.

  • :before (Integer) —

    Set to an object&#39;s ID to retrieve the page of objects coming immediately before the named object.

  • :expand (Array<String>)
  • :limit (Integer) —

    A limit on the number of objects to be returned, between 1 and 100. Default is 10.

  • :order (SortingOrder) —

    Specify to retrieve objects in chronological (ASC) or reverse chronological (DESC) order.

Returns:



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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 132

def get_subscriptions_products_metered_fees_fee_id_tiers_with_http_info(fee_id, space, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers ...'
  end
  # verify the required parameter 'fee_id' is set
  if @api_client.config.client_side_validation && fee_id.nil?
    fail ArgumentError, "Missing the required parameter 'fee_id' when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers"
  end
  if @api_client.config.client_side_validation && !opts[:'after'].nil? && opts[:'after'] < 1
    fail ArgumentError, 'invalid value for "opts[:"after"]" when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'before'].nil? && opts[:'before'] < 1
    fail ArgumentError, 'invalid value for "opts[:"before"]" when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/subscriptions/products/metered-fees/{feeId}/tiers'.sub('{' + 'feeId' + '}', CGI.escape(fee_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'after'] = opts[:'after'] unless opts[:'after'].nil?
  query_params[:'before'] = opts[:'before'] unless opts[:'before'].nil?
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?
  query_params[:'limit'] = opts[:'limit'] unless opts[:'limit'].nil?
  query_params[:'order'] = opts[:'order'] unless opts[:'order'].nil?

  # 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']
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

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

  new_options = opts.merge(
    :operation => :"SubscriptionProductMeteredFeeTiersService.get_subscriptions_products_metered_fees_fee_id_tiers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionProductMeteredFeeTiersService#get_subscriptions_products_metered_fees_fee_id_tiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#patch_subscriptions_products_metered_fees_fee_id_tiers_id(fee_id, id, space, product_metered_tier_fee_update, opts = {}) ⇒ ProductMeteredTierFee

Update a metered fee tier

Parameters:

  • fee_id (Integer)
  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



388
389
390
391
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 388

def patch_subscriptions_products_metered_fees_fee_id_tiers_id(fee_id, id, space, product_metered_tier_fee_update, opts = {})
  data, _status_code, _headers = patch_subscriptions_products_metered_fees_fee_id_tiers_id_with_http_info(fee_id, id, space, product_metered_tier_fee_update, opts)
  data
end

#patch_subscriptions_products_metered_fees_fee_id_tiers_id_with_http_info(fee_id, id, space, product_metered_tier_fee_update, opts = {}) ⇒ Array<(ProductMeteredTierFee, Integer, Hash)>

Returns ProductMeteredTierFee data, response status code and response headers.

Parameters:

  • fee_id (Integer)
  • id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

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

    ProductMeteredTierFee data, response status code and response headers



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
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 402

def patch_subscriptions_products_metered_fees_fee_id_tiers_id_with_http_info(fee_id, id, space, product_metered_tier_fee_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionProductMeteredFeeTiersService.patch_subscriptions_products_metered_fees_fee_id_tiers_id ...'
  end
  # verify the required parameter 'fee_id' is set
  if @api_client.config.client_side_validation && fee_id.nil?
    fail ArgumentError, "Missing the required parameter 'fee_id' when calling SubscriptionProductMeteredFeeTiersService.patch_subscriptions_products_metered_fees_fee_id_tiers_id"
  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 SubscriptionProductMeteredFeeTiersService.patch_subscriptions_products_metered_fees_fee_id_tiers_id"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling SubscriptionProductMeteredFeeTiersService.patch_subscriptions_products_metered_fees_fee_id_tiers_id"
  end
  # verify the required parameter 'product_metered_tier_fee_update' is set
  if @api_client.config.client_side_validation && product_metered_tier_fee_update.nil?
    fail ArgumentError, "Missing the required parameter 'product_metered_tier_fee_update' when calling SubscriptionProductMeteredFeeTiersService.patch_subscriptions_products_metered_fees_fee_id_tiers_id"
  end
  # resource path
  local_var_path = '/subscriptions/products/metered-fees/{feeId}/tiers/{id}'.sub('{' + 'feeId' + '}', CGI.escape(fee_id.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # 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'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

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

  new_options = opts.merge(
    :operation => :"SubscriptionProductMeteredFeeTiersService.patch_subscriptions_products_metered_fees_fee_id_tiers_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionProductMeteredFeeTiersService#patch_subscriptions_products_metered_fees_fee_id_tiers_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end

#post_subscriptions_products_metered_fees_fee_id_tiers(fee_id, space, product_metered_tier_fee_update, opts = {}) ⇒ ProductMeteredTierFee

Create a metered fee tier

Parameters:

  • fee_id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:



476
477
478
479
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 476

def post_subscriptions_products_metered_fees_fee_id_tiers(fee_id, space, product_metered_tier_fee_update, opts = {})
  data, _status_code, _headers = post_subscriptions_products_metered_fees_fee_id_tiers_with_http_info(fee_id, space, product_metered_tier_fee_update, opts)
  data
end

#post_subscriptions_products_metered_fees_fee_id_tiers_with_http_info(fee_id, space, product_metered_tier_fee_update, opts = {}) ⇒ Array<(ProductMeteredTierFee, Integer, Hash)>

Returns ProductMeteredTierFee data, response status code and response headers.

Parameters:

  • fee_id (Integer)
  • space (Integer) —

    Specifies the ID of the space the operation should be executed in.

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>)

Returns:

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

    ProductMeteredTierFee data, response status code and response headers



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'lib/wallee-ruby-sdk/service/subscription_product_metered_fee_tiers_service.rb', line 489

def post_subscriptions_products_metered_fees_fee_id_tiers_with_http_info(fee_id, space, product_metered_tier_fee_update, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriptionProductMeteredFeeTiersService.post_subscriptions_products_metered_fees_fee_id_tiers ...'
  end
  # verify the required parameter 'fee_id' is set
  if @api_client.config.client_side_validation && fee_id.nil?
    fail ArgumentError, "Missing the required parameter 'fee_id' when calling SubscriptionProductMeteredFeeTiersService.post_subscriptions_products_metered_fees_fee_id_tiers"
  end
  # verify the required parameter 'space' is set
  if @api_client.config.client_side_validation && space.nil?
    fail ArgumentError, "Missing the required parameter 'space' when calling SubscriptionProductMeteredFeeTiersService.post_subscriptions_products_metered_fees_fee_id_tiers"
  end
  # verify the required parameter 'product_metered_tier_fee_update' is set
  if @api_client.config.client_side_validation && product_metered_tier_fee_update.nil?
    fail ArgumentError, "Missing the required parameter 'product_metered_tier_fee_update' when calling SubscriptionProductMeteredFeeTiersService.post_subscriptions_products_metered_fees_fee_id_tiers"
  end
  # resource path
  local_var_path = '/subscriptions/products/metered-fees/{feeId}/tiers'.sub('{' + 'feeId' + '}', CGI.escape(fee_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil?

  # 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'])
  unless content_type.nil?
    header_params['Content-Type'] = content_type
  end
  header_params[:'Space'] = space

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

  # connection timeout
  connection_timeout = @api_client.config.timeout

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

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

  new_options = opts.merge(
    :operation => :"SubscriptionProductMeteredFeeTiersService.post_subscriptions_products_metered_fees_fee_id_tiers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, new_options, connection_timeout)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionProductMeteredFeeTiersService#post_subscriptions_products_metered_fees_fee_id_tiers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}"
  end
  return data, status_code, headers
end