RubyGems - first_data_gateway - Versions diffs - 1.6.0 → 1.9.0 - Mend

first_data_gateway 1.6.0 → 1.9.0

Files changed (852) hide show

@@ -1,70 +0,0 @@
-# OpenapiClient::CardInfoLookupApi
-All URIs are relative to *https://cert.api.firstdata.com/gateway/v2*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**card_info_lookup**](CardInfoLookupApi.md#card_info_lookup) | **POST** /card-information | Card information lookup.
-## card_info_lookup
-> CardInfoLookupResponse card_info_lookup(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, opts)
-Card information lookup.
-Use this to look up card related information such as issuer country, card function and card brand.
-### Example
-```ruby
-# load the gem
-require 'openapi_client'
-api_instance = OpenapiClient::CardInfoLookupApi.new
-content_type = 'application/json' # String | Content type.
-client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
-api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-card_info_lookup_request = OpenapiClient::CardInfoLookupRequest.new # CardInfoLookupRequest | Accepted request type: CardInfoLookupRequest.
-opts = {
-  message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
-  region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
-}
-begin
-  #Card information lookup.
-  result = api_instance.card_info_lookup(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, opts)
-  p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling CardInfoLookupApi->card_info_lookup: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **content_type** | **String**| Content type. | [default to &#39;application/json&#39;]
- **client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format. |
- **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. |
- **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
- **card_info_lookup_request** | [**CardInfoLookupRequest**](CardInfoLookupRequest.md)| Accepted request type: CardInfoLookupRequest. |
- **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
- **region** | **String**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional]
-### Return type
-[**CardInfoLookupResponse**](CardInfoLookupResponse.md)
-### Authorization
-No authorization required
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json

data/docs/CardVerificationApi.md DELETED

@@ -1,70 +0,0 @@
-# OpenapiClient::CardVerificationApi
-All URIs are relative to *https://cert.api.firstdata.com/gateway/v2*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**verify_card**](CardVerificationApi.md#verify_card) | **POST** /card-verification | Verify a payment card.
-## verify_card
-> TransactionResponse verify_card(content_type, client_request_id, api_key, timestamp, card_verification_request, opts)
-Verify a payment card.
-Use this to perform card verification for a payment card.
-### Example
-```ruby
-# load the gem
-require 'openapi_client'
-api_instance = OpenapiClient::CardVerificationApi.new
-content_type = 'application/json' # String | Content type.
-client_request_id = 'client_request_id_example' # String | A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
-api_key = 'api_key_example' # String | Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-card_verification_request = OpenapiClient::CardVerificationRequest.new # CardVerificationRequest | Accepted request type: CardVerificationRequest.
-opts = {
-  message_signature: 'message_signature_example', # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
-  region: 'region_example' # String | Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
-}
-begin
-  #Verify a payment card.
-  result = api_instance.verify_card(content_type, client_request_id, api_key, timestamp, card_verification_request, opts)
-  p result
-rescue OpenapiClient::ApiError => e
-  puts "Exception when calling CardVerificationApi->verify_card: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **content_type** | **String**| Content type. | [default to &#39;application/json&#39;]
- **client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format. |
- **api_key** | **String**| Key given to merchant after boarding associating their requests with the appropriate app in Apigee. |
- **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
- **card_verification_request** | [**CardVerificationRequest**](CardVerificationRequest.md)| Accepted request type: CardVerificationRequest. |
- **message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. | [optional]
- **region** | **String**| Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing. | [optional]
-### Return type
-[**TransactionResponse**](TransactionResponse.md)
-### Authorization
-No authorization required
-### HTTP request headers
-- **Content-Type**: application/json
-- **Accept**: application/json

data/lib/openapi_client/api/card_info_lookup_api.rb DELETED

@@ -1,125 +0,0 @@
-=begin
-#Payment Gateway API Specification.
-#The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
-The version of the OpenAPI document: 6.10.1.20200226.002
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: unset
-=end
-require 'cgi'
-module OpenapiClient
-  class CardInfoLookupApi
-    attr_accessor :api_client
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Card information lookup.
-    # Use this to look up card related information such as issuer country, card function and card brand.
-    # @param content_type [String] Content type.
-    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
-    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-    # @param card_info_lookup_request [CardInfoLookupRequest] Accepted request type: CardInfoLookupRequest.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
-    # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
-    # @return [CardInfoLookupResponse]
-    def card_info_lookup(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, opts = {})
-      data, _status_code, _headers = card_info_lookup_with_http_info(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, opts)
-      data
-    end
-    # Card information lookup.
-    # Use this to look up card related information such as issuer country, card function and card brand.
-    # @param content_type [String] Content type.
-    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
-    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-    # @param card_info_lookup_request [CardInfoLookupRequest] Accepted request type: CardInfoLookupRequest.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
-    # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
-    # @return [Array<(CardInfoLookupResponse, Integer, Hash)>] CardInfoLookupResponse data, response status code and response headers
-    def card_info_lookup_with_http_info(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CardInfoLookupApi.card_info_lookup ...'
-      end
-      # verify the required parameter 'content_type' is set
-      if @api_client.config.client_side_validation && content_type.nil?
-        fail ArgumentError, "Missing the required parameter 'content_type' when calling CardInfoLookupApi.card_info_lookup"
-      end
-      # verify enum value
-      allowable_values = ["application/json"]
-      if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
-        fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
-      end
-      # verify the required parameter 'client_request_id' is set
-      if @api_client.config.client_side_validation && client_request_id.nil?
-        fail ArgumentError, "Missing the required parameter 'client_request_id' when calling CardInfoLookupApi.card_info_lookup"
-      end
-      # verify the required parameter 'api_key' is set
-      if @api_client.config.client_side_validation && api_key.nil?
-        fail ArgumentError, "Missing the required parameter 'api_key' when calling CardInfoLookupApi.card_info_lookup"
-      end
-      # verify the required parameter 'timestamp' is set
-      if @api_client.config.client_side_validation && timestamp.nil?
-        fail ArgumentError, "Missing the required parameter 'timestamp' when calling CardInfoLookupApi.card_info_lookup"
-      end
-      # verify the required parameter 'card_info_lookup_request' is set
-      if @api_client.config.client_side_validation && card_info_lookup_request.nil?
-        fail ArgumentError, "Missing the required parameter 'card_info_lookup_request' when calling CardInfoLookupApi.card_info_lookup"
-      end
-      # resource path
-      local_var_path = '/card-information'
-      # query parameters
-      query_params = opts[:query_params] || {}
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      # header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-      # header_params[:'Content-Type'] = content_type
-      header_params[:'Client-Request-Id'] = client_request_id
-      header_params[:'Api-Key'] = api_key
-      header_params[:'Timestamp'] = timestamp
-      header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
-      header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?
-      # form parameters
-      form_params = opts[:form_params] || {}
-      # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(card_info_lookup_request)
-      # return_type
-      return_type = opts[:return_type] || 'CardInfoLookupResponse'
-      # auth_names
-      auth_names = opts[:auth_names] || []
-      new_options = opts.merge(
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'CardInfoLookupResponse',
-        :default_error_type => 'ErrorResponse')
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CardInfoLookupApi#card_info_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end

data/lib/openapi_client/api/card_verification_api.rb DELETED

@@ -1,125 +0,0 @@
-=begin
-#Payment Gateway API Specification.
-#The documentation here is designed to provide all of the technical guidance required to consume and integrate with our APIs for payment processing. To learn more about our APIs please visit https://docs.firstdata.com/org/gateway.
-The version of the OpenAPI document: 6.10.1.20200226.002
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: unset
-=end
-require 'cgi'
-module OpenapiClient
-  class CardVerificationApi
-    attr_accessor :api_client
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Verify a payment card.
-    # Use this to perform card verification for a payment card.
-    # @param content_type [String] Content type.
-    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
-    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-    # @param card_verification_request [CardVerificationRequest] Accepted request type: CardVerificationRequest.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
-    # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
-    # @return [TransactionResponse]
-    def verify_card(content_type, client_request_id, api_key, timestamp, card_verification_request, opts = {})
-      data, _status_code, _headers = verify_card_with_http_info(content_type, client_request_id, api_key, timestamp, card_verification_request, opts)
-      data
-    end
-    # Verify a payment card.
-    # Use this to perform card verification for a payment card.
-    # @param content_type [String] Content type.
-    # @param client_request_id [String] A client-generated ID for request tracking and signature creation, unique per request.  This is also used for idempotency control. We recommend 128-bit UUID format.
-    # @param api_key [String] Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-    # @param timestamp [Integer] Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
-    # @param card_verification_request [CardVerificationRequest] Accepted request type: CardVerificationRequest.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :message_signature Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
-    # @option opts [String] :region Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.
-    # @return [Array<(TransactionResponse, Integer, Hash)>] TransactionResponse data, response status code and response headers
-    def verify_card_with_http_info(content_type, client_request_id, api_key, timestamp, card_verification_request, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: CardVerificationApi.verify_card ...'
-      end
-      # verify the required parameter 'content_type' is set
-      if @api_client.config.client_side_validation && content_type.nil?
-        fail ArgumentError, "Missing the required parameter 'content_type' when calling CardVerificationApi.verify_card"
-      end
-      # verify enum value
-      allowable_values = ["application/json"]
-      if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
-        fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
-      end
-      # verify the required parameter 'client_request_id' is set
-      if @api_client.config.client_side_validation && client_request_id.nil?
-        fail ArgumentError, "Missing the required parameter 'client_request_id' when calling CardVerificationApi.verify_card"
-      end
-      # verify the required parameter 'api_key' is set
-      if @api_client.config.client_side_validation && api_key.nil?
-        fail ArgumentError, "Missing the required parameter 'api_key' when calling CardVerificationApi.verify_card"
-      end
-      # verify the required parameter 'timestamp' is set
-      if @api_client.config.client_side_validation && timestamp.nil?
-        fail ArgumentError, "Missing the required parameter 'timestamp' when calling CardVerificationApi.verify_card"
-      end
-      # verify the required parameter 'card_verification_request' is set
-      if @api_client.config.client_side_validation && card_verification_request.nil?
-        fail ArgumentError, "Missing the required parameter 'card_verification_request' when calling CardVerificationApi.verify_card"
-      end
-      # resource path
-      local_var_path = '/card-verification'
-      # query parameters
-      query_params = opts[:query_params] || {}
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      # header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-      # header_params[:'Content-Type'] = content_type
-      header_params[:'Client-Request-Id'] = client_request_id
-      header_params[:'Api-Key'] = api_key
-      header_params[:'Timestamp'] = timestamp
-      header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
-      header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?
-      # form parameters
-      form_params = opts[:form_params] || {}
-      # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(card_verification_request)
-      # return_type
-      return_type = opts[:return_type] || 'TransactionResponse'
-      # auth_names
-      auth_names = opts[:auth_names] || []
-      new_options = opts.merge(
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'TransactionResponse',
-        :default_error_type => 'ErrorResponse')
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: CardVerificationApi#verify_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end