Class: CyberSource::SubscriptionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/subscriptions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ SubscriptionsApi

Returns a new instance of SubscriptionsApi.



18
19
20
21
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 18

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#activate_subscription(id, opts = {}) ⇒ ActivateSubscriptionResponse

Reactivating a Suspended Subscription # Reactivating a Suspended Subscription You can reactivate a suspended subscription for the next billing cycle. You cannot reactivate a canceled or completed subscription. You can specify whether you want to process missed payments for the period during which the subscription was suspended using the ‘processMissedPayments` query parameter by setting it to true or false. If no value is specified, the system will default to `true`. Important: The "processMissedPayments" query parameter is only effective when the Ask each time before reactivating option is selected in the reactivation settings. If any other option is chosen, the value provided in the request will be ignored by the system. For more information, see the [Recurring Billing User Guide](developer.cybersource.com/docs/cybs/en-us/recurring-billing/user/all/rest/recurring-billing-user/recurring-billing-user-about-guide.html). You can check how many payments were missed and the total amount by retrieving the subscription details, where you will find the `reactivationInformation` object. See: [Retrieving a Subscription](developer.cybersource.com/docs/cybs/en-us/recurring-billing/developer/all/rest/recurring-billing-dev/recur-bill-subscriptions/recur-bill-getting-a-subscription.html).

Parameters:

  • id —

    Subscription Id

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

    the optional parameters

Options Hash (opts):

  • :process_missed_payments (BOOLEAN) —

    Indicates if missed payments should be processed from the period when the subscription was suspended. By default, this is set to true. When any option other than "Ask each time before reactivating" is selected in the reactivation settings, the value that you enter will be ignored. (default to true)

Returns:



30
31
32
33
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 30

def activate_subscription(id, opts = {})
  data, status_code, headers = activate_subscription_with_http_info(id, opts)
  return data, status_code, headers
end

#activate_subscription_with_http_info(id, opts = {}) ⇒ Array<(ActivateSubscriptionResponse, Fixnum, Hash)>

Reactivating a Suspended Subscription # Reactivating a Suspended Subscription You can reactivate a suspended subscription for the next billing cycle. You cannot reactivate a canceled or completed subscription. You can specify whether you want to process missed payments for the period during which the subscription was suspended using the &#x60;processMissedPayments&#x60; query parameter by setting it to true or false. If no value is specified, the system will default to &#x60;true&#x60;. Important: The &quot;processMissedPayments&quot; query parameter is only effective when the Ask each time before reactivating option is selected in the reactivation settings. If any other option is chosen, the value provided in the request will be ignored by the system. For more information, see the [Recurring Billing User Guide](developer.cybersource.com/docs/cybs/en-us/recurring-billing/user/all/rest/recurring-billing-user/recurring-billing-user-about-guide.html). You can check how many payments were missed and the total amount by retrieving the subscription details, where you will find the &#x60;reactivationInformation&#x60; object. See: [Retrieving a Subscription](developer.cybersource.com/docs/cybs/en-us/recurring-billing/developer/all/rest/recurring-billing-dev/recur-bill-subscriptions/recur-bill-getting-a-subscription.html).

Parameters:

  • id —

    Subscription Id

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

    the optional parameters

Options Hash (opts):

  • :process_missed_payments (BOOLEAN) —

    Indicates if missed payments should be processed from the period when the subscription was suspended. By default, this is set to true. When any option other than &quot;Ask each time before reactivating&quot; is selected in the reactivation settings, the value that you enter will be ignored.

Returns:



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
95
96
97
98
99
100
101
102
103
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 41

def activate_subscription_with_http_info(id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: SubscriptionsApi.activate_subscription ...'
        rescue
            puts 'Cannot write to log'
        end
  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 SubscriptionsApi.activate_subscription"
  end
  # resource path
  local_var_path = 'rbs/v1/subscriptions/{id}/activate'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'processMissedPayments'] = opts[:'process_missed_payments'] if !opts[:'process_missed_payments'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  if 'POST' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["activate_subscription","activate_subscription_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'ActivateSubscriptionResponse')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: SubscriptionsApi#activate_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#cancel_subscription(id, opts = {}) ⇒ CancelSubscriptionResponse

Cancel a Subscription Cancel a Subscription

Parameters:

  • id —

    Subscription Id

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

    the optional parameters

Returns:



111
112
113
114
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 111

def cancel_subscription(id, opts = {})
  data, status_code, headers = cancel_subscription_with_http_info(id, opts)
  return data, status_code, headers
end

#cancel_subscription_with_http_info(id, opts = {}) ⇒ Array<(CancelSubscriptionResponse, Fixnum, Hash)>

Cancel a Subscription Cancel a Subscription

Parameters:

  • id —

    Subscription Id

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

    the optional parameters

Returns:

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

    CancelSubscriptionResponse data, response status code and response headers



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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 121

def cancel_subscription_with_http_info(id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: SubscriptionsApi.cancel_subscription ...'
        rescue
            puts 'Cannot write to log'
        end
  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 SubscriptionsApi.cancel_subscription"
  end
  # resource path
  local_var_path = 'rbs/v1/subscriptions/{id}/cancel'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  if 'POST' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["cancel_subscription","cancel_subscription_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'CancelSubscriptionResponse')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: SubscriptionsApi#cancel_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#create_subscription(create_subscription_request, opts = {}) ⇒ CreateSubscriptionResponse

Create a Subscription Create a Recurring Billing Subscription

Parameters:

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

    the optional parameters

Returns:



190
191
192
193
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 190

def create_subscription(create_subscription_request, opts = {})
  data, status_code, headers = create_subscription_with_http_info(create_subscription_request, opts)
  return data, status_code, headers
end

#create_subscription_with_http_info(create_subscription_request, opts = {}) ⇒ Array<(CreateSubscriptionResponse, Fixnum, Hash)>

Create a Subscription Create a Recurring Billing Subscription

Parameters:

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

    the optional parameters

Returns:

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

    CreateSubscriptionResponse data, response status code and response headers



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
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
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 200

def create_subscription_with_http_info(create_subscription_request, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: SubscriptionsApi.create_subscription ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'create_subscription_request' is set
  if @api_client.config.client_side_validation && create_subscription_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_subscription_request' when calling SubscriptionsApi.create_subscription"
  end
  # resource path
  local_var_path = 'rbs/v1/subscriptions'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(create_subscription_request)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'CreateSubscriptionRequest', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "false"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["create_subscription","create_subscription_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'CreateSubscriptionResponse')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: SubscriptionsApi#create_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_all_subscriptions(opts = {}) ⇒ GetAllSubscriptionsResponse

Get a List of Subscriptions Retrieve Subscriptions by Subscription Code & Subscription Status.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Page offset number.

  • :limit (Integer) —

    Number of items to be returned. Default - &#x60;20&#x60;, Max - &#x60;100&#x60;

  • :code (String) —

    Filter by Subscription Code

  • :status (String) —

    Filter by Subscription Status

Returns:



270
271
272
273
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 270

def get_all_subscriptions(opts = {})
  data, status_code, headers = get_all_subscriptions_with_http_info(opts)
  return data, status_code, headers
end

#get_all_subscriptions_with_http_info(opts = {}) ⇒ Array<(GetAllSubscriptionsResponse, Fixnum, Hash)>

Get a List of Subscriptions Retrieve Subscriptions by Subscription Code &amp; Subscription Status.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Page offset number.

  • :limit (Integer) —

    Number of items to be returned. Default - &#x60;20&#x60;, Max - &#x60;100&#x60;

  • :code (String) —

    Filter by Subscription Code

  • :status (String) —

    Filter by Subscription Status

Returns:



283
284
285
286
287
288
289
290
291
292
293
294
295
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
343
344
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 283

def get_all_subscriptions_with_http_info(opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: SubscriptionsApi.get_all_subscriptions ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # resource path
  local_var_path = 'rbs/v1/subscriptions'

  # query parameters
  query_params = {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["get_all_subscriptions","get_all_subscriptions_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'GetAllSubscriptionsResponse')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: SubscriptionsApi#get_all_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_subscription(id, opts = {}) ⇒ GetSubscriptionResponse

Get a Subscription Get a Subscription by Subscription Id

Parameters:

  • id —

    Subscription Id

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

    the optional parameters

Returns:



352
353
354
355
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 352

def get_subscription(id, opts = {})
  data, status_code, headers = get_subscription_with_http_info(id, opts)
  return data, status_code, headers
end

#get_subscription_code(opts = {}) ⇒ GetSubscriptionCodeResponse

Get a Subscription Code Get a Unique Subscription Code

Parameters:

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

    the optional parameters

Returns:



430
431
432
433
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 430

def get_subscription_code(opts = {})
  data, status_code, headers = get_subscription_code_with_http_info(opts)
  return data, status_code, headers
end

#get_subscription_code_with_http_info(opts = {}) ⇒ Array<(GetSubscriptionCodeResponse, Fixnum, Hash)>

Get a Subscription Code Get a Unique Subscription Code

Parameters:

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

    the optional parameters

Returns:



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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 439

def get_subscription_code_with_http_info(opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: SubscriptionsApi.get_subscription_code ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # resource path
  local_var_path = 'rbs/v1/subscriptions/code'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["get_subscription_code","get_subscription_code_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'GetSubscriptionCodeResponse')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: SubscriptionsApi#get_subscription_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#get_subscription_with_http_info(id, opts = {}) ⇒ Array<(GetSubscriptionResponse, Fixnum, Hash)>

Get a Subscription Get a Subscription by Subscription Id

Parameters:

  • id —

    Subscription Id

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

    the optional parameters

Returns:

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

    GetSubscriptionResponse data, response status code and response headers



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
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 362

def get_subscription_with_http_info(id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: SubscriptionsApi.get_subscription ...'
        rescue
            puts 'Cannot write to log'
        end
  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 SubscriptionsApi.get_subscription"
  end
  # resource path
  local_var_path = 'rbs/v1/subscriptions/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  if 'GET' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["get_subscription","get_subscription_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'GetSubscriptionResponse')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: SubscriptionsApi#get_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#suspend_subscription(id, opts = {}) ⇒ SuspendSubscriptionResponse

Suspend a Subscription Suspend a Subscription

Parameters:

  • id —

    Subscription Id

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

    the optional parameters

Returns:



504
505
506
507
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 504

def suspend_subscription(id, opts = {})
  data, status_code, headers = suspend_subscription_with_http_info(id, opts)
  return data, status_code, headers
end

#suspend_subscription_with_http_info(id, opts = {}) ⇒ Array<(SuspendSubscriptionResponse, Fixnum, Hash)>

Suspend a Subscription Suspend a Subscription

Parameters:

  • id —

    Subscription Id

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

    the optional parameters

Returns:



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
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 514

def suspend_subscription_with_http_info(id, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: SubscriptionsApi.suspend_subscription ...'
        rescue
            puts 'Cannot write to log'
        end
  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 SubscriptionsApi.suspend_subscription"
  end
  # resource path
  local_var_path = 'rbs/v1/subscriptions/{id}/suspend'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  if 'POST' == 'POST'
    post_body = '{}'
  else
    post_body = nil
  end
  inbound_mle_status = "false"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["suspend_subscription","suspend_subscription_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  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 => 'SuspendSubscriptionResponse')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: SubscriptionsApi#suspend_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end

#update_subscription(id, update_subscription, opts = {}) ⇒ UpdateSubscriptionResponse

Update a Subscription Update a Subscription by Subscription Id

Parameters:

  • id —

    Subscription Id

  • update_subscription —

    Update Subscription

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

    the optional parameters

Returns:



584
585
586
587
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 584

def update_subscription(id, update_subscription, opts = {})
  data, status_code, headers = update_subscription_with_http_info(id, update_subscription, opts)
  return data, status_code, headers
end

#update_subscription_with_http_info(id, update_subscription, opts = {}) ⇒ Array<(UpdateSubscriptionResponse, Fixnum, Hash)>

Update a Subscription Update a Subscription by Subscription Id

Parameters:

  • id —

    Subscription Id

  • update_subscription —

    Update Subscription

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

    the optional parameters

Returns:

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

    UpdateSubscriptionResponse data, response status code and response headers



595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
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
 
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 595

def update_subscription_with_http_info(id, update_subscription, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: SubscriptionsApi.update_subscription ...'
        rescue
            puts 'Cannot write to log'
        end
  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 SubscriptionsApi.update_subscription"
  end
  # verify the required parameter 'update_subscription' is set
  if @api_client.config.client_side_validation && update_subscription.nil?
    fail ArgumentError, "Missing the required parameter 'update_subscription' when calling SubscriptionsApi.update_subscription"
  end
  # resource path
  local_var_path = 'rbs/v1/subscriptions/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/hal+json', 'application/json;charset=utf-8', 'application/hal+json;charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(update_subscription)
  sdk_tracker = SdkTracker.new
  post_body = sdk_tracker.insert_developer_id_tracker(post_body, 'UpdateSubscription', @api_client.config.host, @api_client.merchantconfig.defaultDeveloperId)
  inbound_mle_status = "false"      
  if MLEUtility.check_is_mle_for_API(@api_client.merchantconfig, inbound_mle_status, ["update_subscription","update_subscription_with_http_info"])
    begin
      post_body = MLEUtility.encrypt_request_payload(@api_client.merchantconfig, post_body)
    rescue
      raise
    end
  end
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UpdateSubscriptionResponse')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: SubscriptionsApi#update_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end