first_data_gateway 1.7.1 → 1.8.0

data/docs/BrandingStyleConfigurationResponseAllOf.md

@@ -1,17 +0,0 @@
-# OpenapiClient::BrandingStyleConfigurationResponseAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**stores** | [**Array<BrandingStyleConfigurationResult>**](BrandingStyleConfigurationResult.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::BrandingStyleConfigurationResponseAllOf.new(stores: null)
-```
-
-

data/docs/CardInfoLookupApi.md

@@ -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 'application/json']
- **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/CardInfoLookupResponseAllOf.md

@@ -1,19 +0,0 @@
-# OpenapiClient::CardInfoLookupResponseAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**card_details** | [**Array<CardInfo>**](CardInfo.md) | One or more card information retrieved based on BIN. | [optional] 
-**request_status** | **String** | Request status. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::CardInfoLookupResponseAllOf.new(card_details: [{"brand":"VISA","brandProductId":"VISA BUSINESS","cardFunction":"credit","commercialCard":"CORPORATE","issuerCountry":"DE","issuerName":"First National Bank of Omaha"}],
-                                 request_status: SUCCESS)
-```
-
-

data/docs/CardVerificationApi.md

@@ -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 'application/json']
- **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/docs/ClientRegistrationAllOf.md

@@ -1,17 +0,0 @@
-# OpenapiClient::ClientRegistrationAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**original_transaction_type** | **String** | Defines the type of the original transaction that is being evaluated for the Fraud Score. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::ClientRegistrationAllOf.new(original_transaction_type: registration/client)
-```
-
-

data/docs/CustomerAddressAllOf.md

@@ -1,17 +0,0 @@
-# OpenapiClient::CustomerAddressAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**phone** | [**Phone**](Phone.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::CustomerAddressAllOf.new(phone: null)
-```
-
-

data/docs/DeleteBrandingStyleConfigurationResponseAllOf.md

@@ -1,19 +0,0 @@
-# OpenapiClient::DeleteBrandingStyleConfigurationResponseAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**store_id** | **String** | Store ID number. | [optional] 
-**status** | **String** | Status from delete branding style configuration process. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::DeleteBrandingStyleConfigurationResponseAllOf.new(store_id: 12345500000,
-                                 status: SUCCESS. Style properties were successfully reset to default.)
-```
-
-

data/docs/DisbursementTransactionTypeAllOf.md

@@ -1,17 +0,0 @@
-# OpenapiClient::DisbursementTransactionTypeAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**disbursement_type** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::DisbursementTransactionTypeAllOf.new(disbursement_type: null)
-```
-
-

data/docs/ErrorResponseAllOf.md

@@ -1,17 +0,0 @@
-# OpenapiClient::ErrorResponseAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**error** | [**Error**](Error.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::ErrorResponseAllOf.new(error: null)
-```
-
-

data/docs/FraudSettingsResponseAllOf.md

@@ -1,31 +0,0 @@
-# OpenapiClient::FraudSettingsResponseAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**store_id** | **String** | The outlet ID. | [optional] 
-**blocked_card_numbers** | [**Array<BlockedCardNumber>**](BlockedCardNumber.md) | List of blocked card numbers. | [optional] 
-**blocked_names** | **Array<String>** | List of blocked fraud names. | [optional] 
-**blocked_domain_names** | **Array<String>** | List of blocked fraud domain names. | [optional] 
-**blocked_ip_or_class_c_addresses** | **Array<String>** | List of blocked fraud IP address/Class C. | [optional] 
-**maximum_purchase_amount** | [**Array<MaximumPurchaseAmount>**](MaximumPurchaseAmount.md) | Maximum purchase amount limit. | [optional] 
-**lockout_time** | [**LockoutTime**](LockoutTime.md) |  | [optional] 
-**country_profile** | **String** | Country profile. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::FraudSettingsResponseAllOf.new(store_id: 12345500000,
-                                 blocked_card_numbers: [{"cardNumber":"542418...1745","tokenIdentifier":"06a569340ae1b8a60d1a961971f255b2ba35c03c8ea5660be6c253c0eb76e2dd"},{"cardNumber":"542418...1746","tokenIdentifier":"06a569340ae1b8a60d1a961971f255b2ba3554258ea5660be6c253c0eb76e245"}],
-                                 blocked_names: ["name123","adhoc"],
-                                 blocked_domain_names: ["co.uk","uk.net"],
-                                 blocked_ip_or_class_c_addresses: ["123.56.78.88","12.45.33.45"],
-                                 maximum_purchase_amount: [{"currency":"EUR","maxAmount":"7789"},{"currency":"USD","maxAmount":"5569"}],
-                                 lockout_time: null,
-                                 country_profile: All countries)
-```
-
-

data/docs/FundingTransactionTypeAllOf.md

@@ -1,17 +0,0 @@
-# OpenapiClient::FundingTransactionTypeAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**disbursement_type** | **String** |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::FundingTransactionTypeAllOf.new(disbursement_type: null)
-```
-
-

data/docs/OrderResponseAllOf.md

@@ -1,25 +0,0 @@
-# OpenapiClient::OrderResponseAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
-**billing** | [**Billing**](Billing.md) |  | [optional] 
-**shipping** | [**Shipping**](Shipping.md) |  | [optional] 
-**transactions** | [**Array<TransactionResponse>**](TransactionResponse.md) | Required for some payment methods (for example, Klarna). | [optional] 
-**additional_details** | [**AdditionalDetails**](AdditionalDetails.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::OrderResponseAllOf.new(order_id: 123456,
-                                 billing: null,
-                                 shipping: null,
-                                 transactions: [{"transactionState":"AUTHORIZED","ipgTransactionId":"838916029301","transactionType":"SALE","transactionAmount":{"total":10.24,"currency":"USD"},"storeId":"1109959991"}],
-                                 additional_details: null)
-```
-
-

data/docs/PaymentRegistrationAllOf.md

@@ -1,27 +0,0 @@
-# OpenapiClient::PaymentRegistrationAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**original_transaction_type** | **String** | Defines the type of the original transaction that is being evaluated for the Fraud Score. | [optional] 
-**issuer_response** | [**IssuerResponse**](IssuerResponse.md) |  | [optional] 
-**verification_avs** | [**VerificationAvs**](VerificationAvs.md) |  | [optional] 
-**verification3ds** | [**Verification3ds**](Verification3ds.md) |  | [optional] 
-**verification_cvv** | [**VerificationCvv**](VerificationCvv.md) |  | [optional] 
-**registration_method** | [**RegistrationMethod**](RegistrationMethod.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::PaymentRegistrationAllOf.new(original_transaction_type: registration/method/card,
-                                 issuer_response: null,
-                                 verification_avs: null,
-                                 verification3ds: null,
-                                 verification_cvv: null,
-                                 registration_method: null)
-```
-
-

data/docs/PaymentSchedulesResponseAllOf.md

@@ -1,21 +0,0 @@
-# OpenapiClient::PaymentSchedulesResponseAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**request_status** | **String** | Result of requested operation. If it's anything other than 'SUCCESS', please refer to 400s HTTP error codes or decline. See Error object for details. | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
-**transaction_response** | [**TransactionResponse**](TransactionResponse.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::PaymentSchedulesResponseAllOf.new(request_status: SUCCESS,
-                                 order_id: 123456,
-                                 transaction_response: null)
-```
-
-

data/docs/PaymentTokenUpdateResponseAllOf.md

@@ -1,21 +0,0 @@
-# OpenapiClient::PaymentTokenUpdateResponseAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**request_status** | **String** | The status of the request. | [optional] 
-**request_time** | **Integer** | Time of the request. | [optional] 
-**errors** | [**Array<Error>**](Error.md) |  | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::PaymentTokenUpdateResponseAllOf.new(request_status: APPROVED,
-                                 request_time: 1554308829345,
-                                 errors: null)
-```
-
-

data/docs/PaymentTokenizationResponseAllOf.md

@@ -1,31 +0,0 @@
-# OpenapiClient::PaymentTokenizationResponseAllOf
-
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**request_status** | **String** | The status of the request. | [optional] 
-**request_time** | **Integer** | Time of the request. | [optional] 
-**brand** | **String** | Card brand. | [optional] 
-**country** | **String** | Country of the card issued. | [optional] 
-**payment_token** | [**PaymentTokenDetails**](PaymentTokenDetails.md) |  | [optional] 
-**payment_card** | [**PaymentCard**](PaymentCard.md) |  | [optional] 
-**processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
-**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID. | [optional] 
-
-## Code Sample
-
-```ruby
-require 'OpenapiClient'
-
-instance = OpenapiClient::PaymentTokenizationResponseAllOf.new(request_status: DELETED,
-                                 request_time: 1554308829345,
-                                 brand: VISA,
-                                 country: Germany,
-                                 payment_token: null,
-                                 payment_card: null,
-                                 processor: null,
-                                 order_id: R-44df6542-ae0b-4415-88e8-7f3e62cc9e5d)
-```
-
-