Class: CyberSource::SubscriptionsApi
- Inherits:
-
Object
- Object
- CyberSource::SubscriptionsApi
- Defined in:
- lib/cybersource_rest_client/api/subscriptions_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#activate_subscription(id, opts = {}) ⇒ InlineResponse2009
Activate a Subscription Activate a ‘CANCELLED` Or `SUSPENDED` Subscription.
-
#activate_subscription_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2009, Fixnum, Hash)>
Activate a Subscription Activate a `CANCELLED` Or `SUSPENDED` Subscription.
-
#cancel_subscription(id, opts = {}) ⇒ InlineResponse202
Cancel a Subscription Cancel a Subscription.
-
#cancel_subscription_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse202, Fixnum, Hash)>
Cancel a Subscription Cancel a Subscription.
-
#create_subscription(create_subscription_request, opts = {}) ⇒ InlineResponse2011
Create a Subscription Create a Recurring Billing Subscription.
-
#create_subscription_with_http_info(create_subscription_request, opts = {}) ⇒ Array<(InlineResponse2011, Fixnum, Hash)>
Create a Subscription Create a Recurring Billing Subscription.
-
#get_all_subscriptions(opts = {}) ⇒ InlineResponse2006
Get a List of Subscriptions Retrieve Subscriptions by Subscription Code & Subscription Status.
-
#get_all_subscriptions_with_http_info(opts = {}) ⇒ Array<(InlineResponse2006, Fixnum, Hash)>
Get a List of Subscriptions Retrieve Subscriptions by Subscription Code & Subscription Status.
-
#get_subscription(id, opts = {}) ⇒ InlineResponse2007
Get a Subscription Get a Subscription by Subscription Id.
-
#get_subscription_code(opts = {}) ⇒ InlineResponse20010
Get a Subscription Code Get a Unique Subscription Code.
-
#get_subscription_code_with_http_info(opts = {}) ⇒ Array<(InlineResponse20010, Fixnum, Hash)>
Get a Subscription Code Get a Unique Subscription Code.
-
#get_subscription_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2007, Fixnum, Hash)>
Get a Subscription Get a Subscription by Subscription Id.
-
#initialize(api_client = ApiClient.default, config) ⇒ SubscriptionsApi
constructor
A new instance of SubscriptionsApi.
-
#suspend_subscription(id, opts = {}) ⇒ InlineResponse2021
Suspend a Subscription Suspend a Subscription.
-
#suspend_subscription_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2021, Fixnum, Hash)>
Suspend a Subscription Suspend a Subscription.
-
#update_subscription(id, update_subscription, opts = {}) ⇒ InlineResponse2008
Update a Subscription Update a Subscription by Subscription Id.
-
#update_subscription_with_http_info(id, update_subscription, opts = {}) ⇒ Array<(InlineResponse2008, Fixnum, Hash)>
Update a Subscription Update a Subscription by Subscription Id.
Constructor Details
#initialize(api_client = ApiClient.default, config) ⇒ SubscriptionsApi
Returns a new instance of SubscriptionsApi.
19 20 21 22 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 19 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.
17 18 19 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#activate_subscription(id, opts = {}) ⇒ InlineResponse2009
Activate a Subscription Activate a ‘CANCELLED` Or `SUSPENDED` Subscription
29 30 31 32 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 29 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<(InlineResponse2009, Fixnum, Hash)>
Activate a Subscription Activate a `CANCELLED` Or `SUSPENDED` Subscription
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 40 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 = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['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(opts[:'activate_subscription_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 => 'InlineResponse2009') 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 = {}) ⇒ InlineResponse202
Cancel a Subscription Cancel a Subscription
96 97 98 99 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 96 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<(InlineResponse202, Fixnum, Hash)>
Cancel a Subscription Cancel a Subscription
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 152 153 154 155 156 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 107 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/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(opts[:'cancel_subscription_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 => 'InlineResponse202') 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 = {}) ⇒ InlineResponse2011
Create a Subscription Create a Recurring Billing Subscription
162 163 164 165 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 162 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<(InlineResponse2011, Fixnum, Hash)>
Create a Subscription Create a Recurring Billing Subscription
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 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 172 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/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) 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 => 'InlineResponse2011') 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 = {}) ⇒ InlineResponse2006
Get a List of Subscriptions Retrieve Subscriptions by Subscription Code & Subscription Status.
230 231 232 233 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 230 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<(InlineResponse2006, Fixnum, Hash)>
Get a List of Subscriptions Retrieve Subscriptions by Subscription Code & Subscription Status.
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 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 243 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/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 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 => 'InlineResponse2006') 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 = {}) ⇒ InlineResponse2007
Get a Subscription Get a Subscription by Subscription Id
302 303 304 305 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 302 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 = {}) ⇒ InlineResponse20010
Get a Subscription Code Get a Unique Subscription Code
370 371 372 373 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 370 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<(InlineResponse20010, Fixnum, Hash)>
Get a Subscription Code Get a Unique Subscription Code
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 379 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/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 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 => 'InlineResponse20010') 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<(InlineResponse2007, Fixnum, Hash)>
Get a Subscription Get a Subscription by Subscription Id
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 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 312 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/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 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 => 'InlineResponse2007') 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 = {}) ⇒ InlineResponse2021
Suspend a Subscription Suspend a Subscription
435 436 437 438 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 435 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<(InlineResponse2021, Fixnum, Hash)>
Suspend a Subscription Suspend a Subscription
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 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 446 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/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(opts[:'suspend_subscription_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 => 'InlineResponse2021') 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 = {}) ⇒ InlineResponse2008
Update a Subscription Update a Subscription by Subscription Id
502 503 504 505 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 502 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<(InlineResponse2008, Fixnum, Hash)>
Update a Subscription Update a Subscription by Subscription Id
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 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 |
# File 'lib/cybersource_rest_client/api/subscriptions_api.rb', line 513 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/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) 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 => 'InlineResponse2008') 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 |