Class: CyberSource::InstrumentIdentifierApi
- Inherits:
-
Object
- Object
- CyberSource::InstrumentIdentifierApi
- Defined in:
- lib/cybersource_rest_client/api/instrument_identifier_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_instrument_identifier(profile_id, create_instrument_identifier_request, opts = {}) ⇒ TmsV1InstrumentIdentifiersPost200Response
Create an Instrument Identifier.
-
#create_instrument_identifier_with_http_info(profile_id, create_instrument_identifier_request, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPost200Response, Fixnum, Hash)>
Create an Instrument Identifier.
-
#delete_instrument_identifier(profile_id, token_id, opts = {}) ⇒ nil
Delete an Instrument Identifier.
-
#delete_instrument_identifier_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete an Instrument Identifier.
-
#get_all_payment_instruments(profile_id, token_id, opts = {}) ⇒ TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response
Retrieve all Payment Instruments.
-
#get_all_payment_instruments_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response, Fixnum, Hash)>
Retrieve all Payment Instruments.
-
#get_instrument_identifier(profile_id, token_id, opts = {}) ⇒ TmsV1InstrumentIdentifiersPost200Response
Retrieve an Instrument Identifier.
-
#get_instrument_identifier_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPost200Response, Fixnum, Hash)>
Retrieve an Instrument Identifier.
-
#initialize(api_client = ApiClient.default, config) ⇒ InstrumentIdentifierApi
constructor
A new instance of InstrumentIdentifierApi.
-
#update_instrument_identifier(profile_id, token_id, update_instrument_identifier_request, opts = {}) ⇒ TmsV1InstrumentIdentifiersPost200Response
Update a Instrument Identifier.
-
#update_instrument_identifier_with_http_info(profile_id, token_id, update_instrument_identifier_request, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPost200Response, Fixnum, Hash)>
Update a Instrument Identifier.
Constructor Details
#initialize(api_client = ApiClient.default, config) ⇒ InstrumentIdentifierApi
Returns a new instance of InstrumentIdentifierApi.
19 20 21 22 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_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/instrument_identifier_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_instrument_identifier(profile_id, create_instrument_identifier_request, opts = {}) ⇒ TmsV1InstrumentIdentifiersPost200Response
Create an Instrument Identifier
28 29 30 31 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 28 def create_instrument_identifier(profile_id, create_instrument_identifier_request, opts = {}) data, status_code, headers = create_instrument_identifier_with_http_info(profile_id, create_instrument_identifier_request, opts) return data, status_code, headers end |
#create_instrument_identifier_with_http_info(profile_id, create_instrument_identifier_request, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPost200Response, Fixnum, Hash)>
Create an Instrument Identifier
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 38 def create_instrument_identifier_with_http_info(profile_id, create_instrument_identifier_request, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.create_instrument_identifier ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'profile_id' is set if @api_client.config.client_side_validation && profile_id.nil? fail ArgumentError, "Missing the required parameter 'profile_id' when calling InstrumentIdentifierApi.create_instrument_identifier" end if @api_client.config.client_side_validation && profile_id.to_s.length > 36 fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.create_instrument_identifier, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && profile_id.to_s.length < 36 fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.create_instrument_identifier, the character length must be great than or equal to 36.' end # verify the required parameter 'create_instrument_identifier_request' is set if @api_client.config.client_side_validation && create_instrument_identifier_request.nil? fail ArgumentError, "Missing the required parameter 'create_instrument_identifier_request' when calling InstrumentIdentifierApi.create_instrument_identifier" end # resource path local_var_path = 'tms/v1/instrumentidentifiers' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = profile_id # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(create_instrument_identifier_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 => 'TmsV1InstrumentIdentifiersPost200Response') if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#create_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |
#delete_instrument_identifier(profile_id, token_id, opts = {}) ⇒ nil
Delete an Instrument Identifier
106 107 108 109 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 106 def delete_instrument_identifier(profile_id, token_id, opts = {}) data, status_code, headers = delete_instrument_identifier_with_http_info(profile_id, token_id, opts) return data, status_code, headers end |
#delete_instrument_identifier_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete an Instrument Identifier
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 116 def delete_instrument_identifier_with_http_info(profile_id, token_id, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.delete_instrument_identifier ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'profile_id' is set if @api_client.config.client_side_validation && profile_id.nil? fail ArgumentError, "Missing the required parameter 'profile_id' when calling InstrumentIdentifierApi.delete_instrument_identifier" end if @api_client.config.client_side_validation && profile_id.to_s.length > 36 fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.delete_instrument_identifier, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && profile_id.to_s.length < 36 fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.delete_instrument_identifier, the character length must be great than or equal to 36.' end # verify the required parameter 'token_id' is set if @api_client.config.client_side_validation && token_id.nil? fail ArgumentError, "Missing the required parameter 'token_id' when calling InstrumentIdentifierApi.delete_instrument_identifier" end if @api_client.config.client_side_validation && token_id.to_s.length > 32 fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.delete_instrument_identifier, the character length must be smaller than or equal to 32.' end if @api_client.config.client_side_validation && token_id.to_s.length < 16 fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.delete_instrument_identifier, the character length must be great than or equal to 16.' end # resource path local_var_path = 'tms/v1/instrumentidentifiers/{tokenId}'.sub('{' + 'tokenId' + '}', token_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;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = profile_id # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:DELETE, 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 begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#delete_instrument_identifier\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_payment_instruments(profile_id, token_id, opts = {}) ⇒ TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response
Retrieve all Payment Instruments
193 194 195 196 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 193 def get_all_payment_instruments(profile_id, token_id, opts = {}) data, status_code, headers = get_all_payment_instruments_with_http_info(profile_id, token_id, opts) return data, status_code, headers end |
#get_all_payment_instruments_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response, Fixnum, Hash)>
Retrieve all Payment Instruments
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 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 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 205 def get_all_payment_instruments_with_http_info(profile_id, token_id, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.get_all_payment_instruments ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'profile_id' is set if @api_client.config.client_side_validation && profile_id.nil? fail ArgumentError, "Missing the required parameter 'profile_id' when calling InstrumentIdentifierApi.get_all_payment_instruments" end if @api_client.config.client_side_validation && profile_id.to_s.length > 36 fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.get_all_payment_instruments, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && profile_id.to_s.length < 36 fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.get_all_payment_instruments, the character length must be great than or equal to 36.' end # verify the required parameter 'token_id' is set if @api_client.config.client_side_validation && token_id.nil? fail ArgumentError, "Missing the required parameter 'token_id' when calling InstrumentIdentifierApi.get_all_payment_instruments" end if @api_client.config.client_side_validation && token_id.to_s.length > 32 fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.get_all_payment_instruments, the character length must be smaller than or equal to 32.' end if @api_client.config.client_side_validation && token_id.to_s.length < 16 fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.get_all_payment_instruments, the character length must be great than or equal to 16.' end if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0 fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling InstrumentIdentifierApi.get_all_payment_instruments, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InstrumentIdentifierApi.get_all_payment_instruments, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InstrumentIdentifierApi.get_all_payment_instruments, must be greater than or equal to 1.' end # resource path local_var_path = 'tms/v1/instrumentidentifiers/{tokenId}/paymentinstruments'.sub('{' + 'tokenId' + '}', token_id.to_s) # query parameters query_params = {} query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = profile_id # 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 => 'TmsV1InstrumentIdentifiersPaymentInstrumentsGet200Response') if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#get_all_payment_instruments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |
#get_instrument_identifier(profile_id, token_id, opts = {}) ⇒ TmsV1InstrumentIdentifiersPost200Response
Retrieve an Instrument Identifier
295 296 297 298 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 295 def get_instrument_identifier(profile_id, token_id, opts = {}) data, status_code, headers = get_instrument_identifier_with_http_info(profile_id, token_id, opts) return data, status_code, headers end |
#get_instrument_identifier_with_http_info(profile_id, token_id, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPost200Response, Fixnum, Hash)>
Retrieve an Instrument Identifier
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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 305 def get_instrument_identifier_with_http_info(profile_id, token_id, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.get_instrument_identifier ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'profile_id' is set if @api_client.config.client_side_validation && profile_id.nil? fail ArgumentError, "Missing the required parameter 'profile_id' when calling InstrumentIdentifierApi.get_instrument_identifier" end if @api_client.config.client_side_validation && profile_id.to_s.length > 36 fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.get_instrument_identifier, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && profile_id.to_s.length < 36 fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.get_instrument_identifier, the character length must be great than or equal to 36.' end # verify the required parameter 'token_id' is set if @api_client.config.client_side_validation && token_id.nil? fail ArgumentError, "Missing the required parameter 'token_id' when calling InstrumentIdentifierApi.get_instrument_identifier" end if @api_client.config.client_side_validation && token_id.to_s.length > 32 fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.get_instrument_identifier, the character length must be smaller than or equal to 32.' end if @api_client.config.client_side_validation && token_id.to_s.length < 16 fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.get_instrument_identifier, the character length must be great than or equal to 16.' end # resource path local_var_path = 'tms/v1/instrumentidentifiers/{tokenId}'.sub('{' + 'tokenId' + '}', token_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;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = profile_id # 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 => 'TmsV1InstrumentIdentifiersPost200Response') if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#get_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |
#update_instrument_identifier(profile_id, token_id, update_instrument_identifier_request, opts = {}) ⇒ TmsV1InstrumentIdentifiersPost200Response
Update a Instrument Identifier
382 383 384 385 |
# File 'lib/cybersource_rest_client/api/instrument_identifier_api.rb', line 382 def update_instrument_identifier(profile_id, token_id, update_instrument_identifier_request, opts = {}) data, status_code, headers = update_instrument_identifier_with_http_info(profile_id, token_id, update_instrument_identifier_request, opts) return data, status_code, headers end |
#update_instrument_identifier_with_http_info(profile_id, token_id, update_instrument_identifier_request, opts = {}) ⇒ Array<(TmsV1InstrumentIdentifiersPost200Response, Fixnum, Hash)>
Update a Instrument Identifier
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 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/cybersource_rest_client/api/instrument_identifier_api.rb', line 393 def update_instrument_identifier_with_http_info(profile_id, token_id, update_instrument_identifier_request, opts = {}) if @api_client.config.debugging begin raise @api_client.config.logger.debug 'Calling API: InstrumentIdentifierApi.update_instrument_identifier ...' rescue puts 'Cannot write to log' end end # verify the required parameter 'profile_id' is set if @api_client.config.client_side_validation && profile_id.nil? fail ArgumentError, "Missing the required parameter 'profile_id' when calling InstrumentIdentifierApi.update_instrument_identifier" end if @api_client.config.client_side_validation && profile_id.to_s.length > 36 fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.update_instrument_identifier, the character length must be smaller than or equal to 36.' end if @api_client.config.client_side_validation && profile_id.to_s.length < 36 fail ArgumentError, 'invalid value for "profile_id" when calling InstrumentIdentifierApi.update_instrument_identifier, the character length must be great than or equal to 36.' end # verify the required parameter 'token_id' is set if @api_client.config.client_side_validation && token_id.nil? fail ArgumentError, "Missing the required parameter 'token_id' when calling InstrumentIdentifierApi.update_instrument_identifier" end if @api_client.config.client_side_validation && token_id.to_s.length > 32 fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.update_instrument_identifier, the character length must be smaller than or equal to 32.' end if @api_client.config.client_side_validation && token_id.to_s.length < 16 fail ArgumentError, 'invalid value for "token_id" when calling InstrumentIdentifierApi.update_instrument_identifier, the character length must be great than or equal to 16.' end # verify the required parameter 'update_instrument_identifier_request' is set if @api_client.config.client_side_validation && update_instrument_identifier_request.nil? fail ArgumentError, "Missing the required parameter 'update_instrument_identifier_request' when calling InstrumentIdentifierApi.update_instrument_identifier" end # resource path local_var_path = 'tms/v1/instrumentidentifiers/{tokenId}'.sub('{' + 'tokenId' + '}', token_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;charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8']) header_params[:'profile-id'] = profile_id # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(update_instrument_identifier_request) 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 => 'TmsV1InstrumentIdentifiersPost200Response') if @api_client.config.debugging begin raise @api_client.config.logger.debug "API called: InstrumentIdentifierApi#update_instrument_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" rescue puts 'Cannot write to log' end end return data, status_code, headers end |