Class: WhiteLabelMachineName::SubscriptionService

Inherits:
Object
  • Object
show all
Defined in:
lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubscriptionService

Returns a new instance of SubscriptionService.



24
25
26
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

#apply_changes(space_id, request, opts = {}) ⇒ SubscriptionVersion

apply changes This operation allows to apply changes on a subscription.

Parameters:

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

    the optional parameters

Returns:



34
35
36
37
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 34

def apply_changes(space_id, request, opts = {})
  data, _status_code, _headers = apply_changes_with_http_info(space_id, request, opts)
  return data
end

#apply_changes_with_http_info(space_id, request, opts = {}) ⇒ Array<(SubscriptionVersion, Fixnum, Hash)>

apply changes This operation allows to apply changes on a subscription.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SubscriptionVersion, Fixnum, Hash)>) —

    SubscriptionVersion data, response status code and response headers



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 45

def apply_changes_with_http_info(space_id, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.apply_changes ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.apply_changes" if space_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling SubscriptionService.apply_changes" if request.nil?
  # resource path
  local_var_path = "/subscription/applyChanges".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#apply_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#call_initialize(space_id, subscription_id, opts = {}) ⇒ SubscriptionCharge

initialize The initialize operation initializes a subscription. This method uses charge flows to carry out the transaction.

Parameters:

  • space_id
  • subscription_id —

    The provided subscription id will be used to lookup the subscription which should be initialized.

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

    the optional parameters

Returns:



96
97
98
99
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 96

def call_initialize(space_id, subscription_id, opts = {})
  data, _status_code, _headers = call_initialize_with_http_info(space_id, subscription_id, opts)
  return data
end

#call_initialize_with_http_info(space_id, subscription_id, opts = {}) ⇒ Array<(SubscriptionCharge, Fixnum, Hash)>

initialize The initialize operation initializes a subscription. This method uses charge flows to carry out the transaction.

Parameters:

  • space_id
  • subscription_id —

    The provided subscription id will be used to lookup the subscription which should be initialized.

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

    the optional parameters

Returns:

  • (Array<(SubscriptionCharge, Fixnum, Hash)>) —

    SubscriptionCharge data, response status code and response headers



107
108
109
110
111
112
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 107

def call_initialize_with_http_info(space_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.call_initialize ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.call_initialize" if space_id.nil?
  # verify the required parameter 'subscription_id' is set
  fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscriptionService.call_initialize" if subscription_id.nil?
  # resource path
  local_var_path = "/subscription/initialize".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'subscriptionId'] = subscription_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionCharge')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#call_initialize\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#count(space_id, opts = {}) ⇒ Integer

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

  • (Integer) 


159
160
161
162
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 159

def count(space_id, opts = {})
  data, _status_code, _headers = count_with_http_info(space_id, opts)
  return data
end

#count_with_http_info(space_id, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>

Count Counts the number of items in the database as restricted by the given filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :filter (EntityQueryFilter) —

    The filter which restricts the entities which are used to calculate the count.

Returns:

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

    Integer data, response status code and response headers



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
204
205
206
207
208
209
210
211
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 170

def count_with_http_info(space_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.count ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.count" if space_id.nil?
  # resource path
  local_var_path = "/subscription/count".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'filter'])
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Integer')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(space_id, create_request, opts = {}) ⇒ SubscriptionVersion

Create The create operation creates a new subscription and a corresponding subscription version.

Parameters:

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

    the optional parameters

Returns:



219
220
221
222
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 219

def create(space_id, create_request, opts = {})
  data, _status_code, _headers = create_with_http_info(space_id, create_request, opts)
  return data
end

#create_with_http_info(space_id, create_request, opts = {}) ⇒ Array<(SubscriptionVersion, Fixnum, Hash)>

Create The create operation creates a new subscription and a corresponding subscription version.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SubscriptionVersion, Fixnum, Hash)>) —

    SubscriptionVersion data, response status code and response headers



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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 230

def create_with_http_info(space_id, create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.create ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.create" if space_id.nil?
  # verify the required parameter 'create_request' is set
  fail ArgumentError, "Missing the required parameter 'create_request' when calling SubscriptionService.create" if create_request.nil?
  # resource path
  local_var_path = "/subscription/create".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#initialize_subscriber_present(space_id, subscription_id, opts = {}) ⇒ SubscriptionCharge

initializeSubscriberPresent The initialize operation initializes a subscription when the subscriber is present. The method will initialize a transaction which has to be completed by using the transaction service.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :success_url (String) —

    The subscriber will be redirected to the success URL when the transaction is successful.

  • :failed_url (String) —

    The subscriber will be redirected to the fail URL when the transaction fails.

Returns:



283
284
285
286
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 283

def initialize_subscriber_present(space_id, subscription_id, opts = {})
  data, _status_code, _headers = initialize_subscriber_present_with_http_info(space_id, subscription_id, opts)
  return data
end

#initialize_subscriber_present_with_http_info(space_id, subscription_id, opts = {}) ⇒ Array<(SubscriptionCharge, Fixnum, Hash)>

initializeSubscriberPresent The initialize operation initializes a subscription when the subscriber is present. The method will initialize a transaction which has to be completed by using the transaction service.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :success_url (String) —

    The subscriber will be redirected to the success URL when the transaction is successful.

  • :failed_url (String) —

    The subscriber will be redirected to the fail URL when the transaction fails.

Returns:

  • (Array<(SubscriptionCharge, Fixnum, Hash)>) —

    SubscriptionCharge data, response status code and response headers



296
297
298
299
300
301
302
303
304
305
306
307
308
309
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 296

def initialize_subscriber_present_with_http_info(space_id, subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.initialize_subscriber_present ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.initialize_subscriber_present" if space_id.nil?
  # verify the required parameter 'subscription_id' is set
  fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscriptionService.initialize_subscriber_present" if subscription_id.nil?
  # resource path
  local_var_path = "/subscription/initializeSubscriberPresent".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'subscriptionId'] = subscription_id
  query_params[:'successUrl'] = opts[:'success_url'] if !opts[:'success_url'].nil?
  query_params[:'failedUrl'] = opts[:'failed_url'] if !opts[:'failed_url'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionCharge')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#initialize_subscriber_present\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(space_id, id, opts = {}) ⇒ Subscription

Read Reads the entity with the given ‘id’ and returns it.

Parameters:

  • space_id
  • id —

    The id of the subscription which should be returned.

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

    the optional parameters

Returns:



350
351
352
353
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 350

def read(space_id, id, opts = {})
  data, _status_code, _headers = read_with_http_info(space_id, id, opts)
  return data
end

#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(Subscription, Fixnum, Hash)>

Read Reads the entity with the given &#39;id&#39; and returns it.

Parameters:

  • space_id
  • id —

    The id of the subscription which should be returned.

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

    the optional parameters

Returns:

  • (Array<(Subscription, Fixnum, Hash)>) —

    Subscription data, response status code and response headers



361
362
363
364
365
366
367
368
369
370
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 361

def read_with_http_info(space_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.read ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.read" if space_id.nil?
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling SubscriptionService.read" if id.nil?
  # resource path
  local_var_path = "/subscription/read".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search(space_id, query, opts = {}) ⇒ Array<Subscription>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the subscriptions which are returned by the search.

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

    the optional parameters

Returns:



413
414
415
416
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 413

def search(space_id, query, opts = {})
  data, _status_code, _headers = search_with_http_info(space_id, query, opts)
  return data
end

#search_subscription_invoices(space_id, subscription_id, query, opts = {}) ⇒ Array<TransactionInvoice>

Search Subscription Invoices This operation allows to search for subscription invoices.

Parameters:

  • space_id
  • subscription_id —

    The id of the subscription for which the invoices should be searched for.

  • query —

    The query restricts the invoices which are returned by the search.

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

    the optional parameters

Returns:



476
477
478
479
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 476

def search_subscription_invoices(space_id, subscription_id, query, opts = {})
  data, _status_code, _headers = search_subscription_invoices_with_http_info(space_id, subscription_id, query, opts)
  return data
end

#search_subscription_invoices_with_http_info(space_id, subscription_id, query, opts = {}) ⇒ Array<(Array<TransactionInvoice>, Fixnum, Hash)>

Search Subscription Invoices This operation allows to search for subscription invoices.

Parameters:

  • space_id
  • subscription_id —

    The id of the subscription for which the invoices should be searched for.

  • query —

    The query restricts the invoices which are returned by the search.

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

    the optional parameters

Returns:

  • (Array<(Array<TransactionInvoice>, Fixnum, Hash)>) —

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



488
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 488

def search_subscription_invoices_with_http_info(space_id, subscription_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.search_subscription_invoices ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.search_subscription_invoices" if space_id.nil?
  # verify the required parameter 'subscription_id' is set
  fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscriptionService.search_subscription_invoices" if subscription_id.nil?
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling SubscriptionService.search_subscription_invoices" if query.nil?
  # resource path
  local_var_path = "/subscription/searchSubscriptionInvoices".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'subscriptionId'] = subscription_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<TransactionInvoice>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#search_subscription_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<Subscription>, Fixnum, Hash)>

Search Searches for the entities as specified by the given query.

Parameters:

  • space_id
  • query —

    The query restricts the subscriptions which are returned by the search.

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

    the optional parameters

Returns:

  • (Array<(Array<Subscription>, Fixnum, Hash)>) —

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



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
467
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 424

def search_with_http_info(space_id, query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.search ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.search" if space_id.nil?
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling SubscriptionService.search" if query.nil?
  # resource path
  local_var_path = "/subscription/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(query)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<Subscription>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#terminate(space_id, subscription_id, respect_termination_period, opts = {}) ⇒ nil

terminate This operation allows to terminate a subscription.

Parameters:

  • space_id
  • subscription_id —

    The subscription id identifies the subscription which should be terminated.

  • respect_termination_period —

    The respect termination period controls whether the termination period configured on the product version should be respected or if the operation should take effect immediately.

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

    the optional parameters

Returns:

  • (nil) 


543
544
545
546
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 543

def terminate(space_id, subscription_id, respect_termination_period, opts = {})
  terminate_with_http_info(space_id, subscription_id, respect_termination_period, opts)
  return nil
end

#terminate_with_http_info(space_id, subscription_id, respect_termination_period, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

terminate This operation allows to terminate a subscription.

Parameters:

  • space_id
  • subscription_id —

    The subscription id identifies the subscription which should be terminated.

  • respect_termination_period —

    The respect termination period controls whether the termination period configured on the product version should be respected or if the operation should take effect immediately.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 555

def terminate_with_http_info(space_id, subscription_id, respect_termination_period, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.terminate ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.terminate" if space_id.nil?
  # verify the required parameter 'subscription_id' is set
  fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscriptionService.terminate" if subscription_id.nil?
  # verify the required parameter 'respect_termination_period' is set
  fail ArgumentError, "Missing the required parameter 'respect_termination_period' when calling SubscriptionService.terminate" if respect_termination_period.nil?
  # resource path
  local_var_path = "/subscription/terminate".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'subscriptionId'] = subscription_id
  query_params[:'respectTerminationPeriod'] = respect_termination_period

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#terminate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(space_id, subscription_id, request, opts = {}) ⇒ Subscription

update This operation allows to update the subscription.

Parameters:

  • space_id
  • subscription_id
  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



610
611
612
613
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 610

def update(space_id, subscription_id, request, opts = {})
  data, _status_code, _headers = update_with_http_info(space_id, subscription_id, request, opts)
  return data
end

#update_product_version(space_id, subscription_id, respect_termination_period, opts = {}) ⇒ SubscriptionVersion

update product version The update product version operation updates the product version of the subscription to the latest active product version.

Parameters:

  • space_id
  • subscription_id —

    The subscription id identifies the subscription which should be updated to the latest version.

  • respect_termination_period —

    The subscription version may be retired. The respect termination period controls whether the termination period configured on the product version should be respected or if the operation should take effect immediately.

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

    the optional parameters

Returns:



677
678
679
680
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 677

def update_product_version(space_id, subscription_id, respect_termination_period, opts = {})
  data, _status_code, _headers = update_product_version_with_http_info(space_id, subscription_id, respect_termination_period, opts)
  return data
end

#update_product_version_with_http_info(space_id, subscription_id, respect_termination_period, opts = {}) ⇒ Array<(SubscriptionVersion, Fixnum, Hash)>

update product version The update product version operation updates the product version of the subscription to the latest active product version.

Parameters:

  • space_id
  • subscription_id —

    The subscription id identifies the subscription which should be updated to the latest version.

  • respect_termination_period —

    The subscription version may be retired. The respect termination period controls whether the termination period configured on the product version should be respected or if the operation should take effect immediately.

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

    the optional parameters

Returns:

  • (Array<(SubscriptionVersion, Fixnum, Hash)>) —

    SubscriptionVersion data, response status code and response headers



689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 689

def update_product_version_with_http_info(space_id, subscription_id, respect_termination_period, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.update_product_version ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.update_product_version" if space_id.nil?
  # verify the required parameter 'subscription_id' is set
  fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscriptionService.update_product_version" if subscription_id.nil?
  # verify the required parameter 'respect_termination_period' is set
  fail ArgumentError, "Missing the required parameter 'respect_termination_period' when calling SubscriptionService.update_product_version" if respect_termination_period.nil?
  # resource path
  local_var_path = "/subscription/updateProductVersion".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'subscriptionId'] = subscription_id
  query_params[:'respectTerminationPeriod'] = respect_termination_period

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = []
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SubscriptionVersion')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#update_product_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_with_http_info(space_id, subscription_id, request, opts = {}) ⇒ Array<(Subscription, Fixnum, Hash)>

update This operation allows to update the subscription.

Parameters:

  • space_id
  • subscription_id
  • request
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Subscription, Fixnum, Hash)>) —

    Subscription data, response status code and response headers



622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
 
# File 'lib/whitelabelmachinename-ruby-sdk/api/subscription_service_api.rb', line 622

def update_with_http_info(space_id, subscription_id, request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SubscriptionService.update ..."
  end
  # verify the required parameter 'space_id' is set
  fail ArgumentError, "Missing the required parameter 'space_id' when calling SubscriptionService.update" if space_id.nil?
  # verify the required parameter 'subscription_id' is set
  fail ArgumentError, "Missing the required parameter 'subscription_id' when calling SubscriptionService.update" if subscription_id.nil?
  # verify the required parameter 'request' is set
  fail ArgumentError, "Missing the required parameter 'request' when calling SubscriptionService.update" if request.nil?
  # resource path
  local_var_path = "/subscription/update".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'spaceId'] = space_id
  query_params[:'subscriptionId'] = subscription_id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Subscription')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscriptionService#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end