first_data_gateway 1.2.0 → 1.3.0

data/docs/CarRental.md

@@ -1,6 +1,7 @@
 # OpenapiClient::CarRental
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **agreement_number** | **String** | The car rental agreement number. | [optional] 
@@ -10,6 +11,21 @@ Name | Type | Description | Notes
 **pickup_date** | **Date** | The date the car rental begins. | [optional] 
 **rental_class_id** | **String** | The classification of the rental car. | [optional] 
 **extra_charges** | [**Array<CarRentalExtraCharges>**](CarRentalExtraCharges.md) | Array containing information about charges other than the rental rate. | [optional] 
-**no_show_indicator** | **BOOLEAN** | Indicates if the transaction is related to a no-show charge. | [optional] 
+**no_show_indicator** | **Boolean** | Indicates if the transaction is related to a no-show charge. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CarRental.new(agreement_number: 100001145699,
+                                 renter_name: Frank Bisignano,
+                                 return_city: Atlanta,
+                                 return_date: null,
+                                 pickup_date: null,
+                                 rental_class_id: ABCDEF,
+                                 extra_charges: [{"chargeItem":"GAS"},{"chargeItem":"EXTRA_MILEAGE"}],
+                                 no_show_indicator: false)
+```
 
 

data/docs/CarRentalExtraCharges.md

@@ -1,8 +1,17 @@
 # OpenapiClient::CarRentalExtraCharges
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **charge_item** | **String** | Additional charge item. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CarRentalExtraCharges.new(charge_item: GAS)
+```
+
 

data/docs/Card.md

@@ -1,6 +1,7 @@
 # OpenapiClient::Card
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **ta_token** | **String** | TransArmor token value. Either the token fields or card number field must contain a value. | [optional] 
@@ -12,4 +13,19 @@ Name | Type | Description | Notes
 **issuer** | **String** | The company (usually a bank) that issued the card. | [optional] 
 **card_reissued_number** | **String** | A number that distinguishes between two plastic cards with the same card number in the event of the card being re-issued. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Card.new(ta_token: 7591787425749818,
+                                 ta_token_key: ab56,
+                                 cardholder_name: John F. Doe,
+                                 card_number: 5424180279791732,
+                                 exp_date: 122028,
+                                 cvv: Y,
+                                 issuer: Bank of America,
+                                 card_reissued_number: 2)
+```
+
 

data/docs/CardFunction.md

@@ -1,7 +1,16 @@
 # OpenapiClient::CardFunction
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CardFunction.new()
+```
+
 

data/docs/CardInfo.md

@@ -1,6 +1,7 @@
 # OpenapiClient::CardInfo
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **brand** | **String** | The card brand. | [optional] 
@@ -10,4 +11,17 @@ Name | Type | Description | Notes
 **issuer_country** | **String** | The country of the issuer. | [optional] 
 **issuer_name** | **String** | The name of the issuer. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CardInfo.new(brand: VISA,
+                                 brand_product_id: VISA BUSINESS,
+                                 card_function: null,
+                                 commercial_card: CORPORATE,
+                                 issuer_country: DE,
+                                 issuer_name: First National Bank of Omaha)
+```
+
 

data/docs/CardInfoLookupApi.md

@@ -7,7 +7,9 @@ Method | HTTP request | Description
 [**card_info_lookup**](CardInfoLookupApi.md#card_info_lookup) | **POST** /card-information | Card information lookup.
 
 
-# **card_info_lookup**
+
+## card_info_lookup
+
 > CardInfoLookupResponse card_info_lookup(content_type, client_request_id, api_key, timestamp, card_info_lookup_request, opts)
 
 Card information lookup.
@@ -15,6 +17,7 @@ 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'
@@ -41,6 +44,7 @@ end
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **content_type** | **String**| Content type. | [default to 'application/json']
@@ -61,8 +65,6 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: application/json
+- **Accept**: application/json
 

data/docs/CardInfoLookupRequest.md

@@ -1,9 +1,19 @@
 # OpenapiClient::CardInfoLookupRequest
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **store_id** | **String** | An optional outlet id for clients that support multiple stores in the same developer app. | [optional] 
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CardInfoLookupRequest.new(store_id: 12345500000,
+                                 payment_card: null)
+```
+
 

data/docs/CardInfoLookupResponse.md

@@ -1,6 +1,7 @@
 # OpenapiClient::CardInfoLookupResponse
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
@@ -9,4 +10,16 @@ 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::CardInfoLookupResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 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

@@ -7,7 +7,9 @@ Method | HTTP request | Description
 [**verify_card**](CardVerificationApi.md#verify_card) | **POST** /card-verification | Verify a payment card.
 
 
-# **verify_card**
+
+## verify_card
+
 > TransactionResponse verify_card(content_type, client_request_id, api_key, timestamp, card_verification_request, opts)
 
 Verify a payment card.
@@ -15,6 +17,7 @@ Verify a payment card.
 Use this to perform card verification for a payment card.
 
 ### Example
+
 ```ruby
 # load the gem
 require 'openapi_client'
@@ -41,6 +44,7 @@ end
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **content_type** | **String**| Content type. | [default to 'application/json']
@@ -61,8 +65,6 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: application/json
+- **Accept**: application/json
 

data/docs/CardVerificationRequest.md

@@ -1,10 +1,21 @@
 # OpenapiClient::CardVerificationRequest
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payment_card** | [**PaymentCard**](PaymentCard.md) |  | 
 **billing_address** | [**Address**](Address.md) |  | [optional] 
 **store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CardVerificationRequest.new(payment_card: null,
+                                 billing_address: null,
+                                 store_id: 12345500000)
+```
+
 

data/docs/ChinaDomestic.md

@@ -1,6 +1,7 @@
 # OpenapiClient::ChinaDomestic
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **product_code** | **String** | Use this to indicate the product code according to the product category list. | 
@@ -8,8 +9,23 @@ Name | Type | Description | Notes
 **product_price** | **Float** | Rate amount in 3 decimal 12 bytes total digit. | 
 **product_description** | **String** | The product description. | 
 **redirect_url** | **String** | Use this to indicate the product code according to the product category list. | 
-**limit_card_function_to_debit** | **BOOLEAN** | Use this to limit card functions to debit cards. | [optional] 
+**limit_card_function_to_debit** | **Boolean** | Use this to limit card functions to debit cards. | [optional] 
 **customer_id** | **String** | Use this to indicate the CUP customer ID if known. | [optional] 
 **bank_id** | **String** | Use this to indicate the CUP bank ID if known. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ChinaDomestic.new(product_code: R2D2C3PO,
+                                 product_quantity: 10,
+                                 product_price: 3.2,
+                                 product_description: Best product ever,
+                                 redirect_url: www.urlredirectedto.com,
+                                 limit_card_function_to_debit: true,
+                                 customer_id: ID3Bs,
+                                 bank_id: 123456)
+```
+
 

data/docs/ChinaDomesticPaymentMethod.md

@@ -1,9 +1,19 @@
 # OpenapiClient::ChinaDomesticPaymentMethod
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **china_domestic** | [**ChinaDomestic**](ChinaDomestic.md) |  | 
 **brand** | **String** |  | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ChinaDomesticPaymentMethod.new(china_domestic: null,
+                                 brand: null)
+```
+
 

data/docs/ChinaDomesticPaymentMethodAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::ChinaDomesticPaymentMethodAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**china_domestic** | [**ChinaDomestic**](ChinaDomestic.md) |  | 
+**brand** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ChinaDomesticPaymentMethodAllOf.new(china_domestic: null,
+                                 brand: null)
+```
+
+

data/docs/ChinaPnRSaleTransaction.md

@@ -1,14 +1,17 @@
 # OpenapiClient::ChinaPnRSaleTransaction
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Object name of the primary transaction request. | 
-**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
-**merchant_transaction_id** | **String** | The unique merchant transaction ID from the request header, if supplied. | [optional] 
-**transaction_amount** | [**Amount**](Amount.md) |  | 
-**transaction_origin** | [**TransactionOrigin**](TransactionOrigin.md) |  | [optional] 
-**order** | [**Order**](Order.md) |  | [optional] 
 **payment_method** | [**ChinaDomesticPaymentMethod**](ChinaDomesticPaymentMethod.md) |  | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ChinaPnRSaleTransaction.new(payment_method: null)
+```
+
 

data/docs/ChinaPnRSaleTransactionAllOf.md

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

data/docs/ClientLocale.md

@@ -1,9 +1,19 @@
 # OpenapiClient::ClientLocale
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **language** | **String** | Language used by client. | 
 **country** | **String** | Country of the client. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::ClientLocale.new(language: en,
+                                 country: GB)
+```
+
 

data/docs/Contact.md

@@ -1,6 +1,7 @@
 # OpenapiClient::Contact
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **phone** | **String** | Primary phone number. | [optional] 
@@ -8,4 +9,15 @@ Name | Type | Description | Notes
 **fax** | **String** | Fax number. | [optional] 
 **email** | **String** | Email address. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Contact.new(phone: 5555555555,
+                                 mobile_phone: 5555555555,
+                                 fax: 5555555555,
+                                 email: john@test.com)
+```
+
 

data/docs/CreatePaymentToken.md

@@ -1,10 +1,21 @@
 # OpenapiClient::CreatePaymentToken
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **value** | **String** | Client-supplied payment token value. Only applicable for DataVault tokenization scheme. | [optional] 
-**reusable** | **BOOLEAN** | If the token is reusable. | [optional] [default to true]
-**decline_duplicates** | **BOOLEAN** | Decline duplicate payment info if client token is supplied. | [optional] [default to false]
+**reusable** | **Boolean** | If the token is reusable. | [optional] [default to true]
+**decline_duplicates** | **Boolean** | Decline duplicate payment info if client token is supplied. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CreatePaymentToken.new(value: 234ljl124l12,
+                                 reusable: true,
+                                 decline_duplicates: false)
+```
 
 

data/docs/CurrencyConversion.md

@@ -1,9 +1,19 @@
 # OpenapiClient::CurrencyConversion
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **conversion_type** | **String** | Type of currency conversion. | 
 **inquiry_rate_id** | **String** | Inquiry rate id. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CurrencyConversion.new(conversion_type: Dcc,
+                                 inquiry_rate_id: 123456)
+```
+
 

data/docs/CurrencyConversionApi.md

@@ -7,7 +7,9 @@ Method | HTTP request | Description
 [**get_exchange_rate**](CurrencyConversionApi.md#get_exchange_rate) | **POST** /exchange-rates | Generate dynamic currency conversion transactions.
 
 
-# **get_exchange_rate**
+
+## get_exchange_rate
+
 > ExchangeRateResponse get_exchange_rate(content_type, client_request_id, api_key, timestamp, exchange_rate_request, opts)
 
 Generate dynamic currency conversion transactions.
@@ -15,6 +17,7 @@ Generate dynamic currency conversion transactions.
 Sale, return and lookup exchange rate with dynamic currency conversion option.
 
 ### Example
+
 ```ruby
 # load the gem
 require 'openapi_client'
@@ -41,6 +44,7 @@ end
 
 ### Parameters
 
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **content_type** | **String**| Content type. | [default to 'application/json']
@@ -61,8 +65,6 @@ No authorization required
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
-
-
+- **Content-Type**: application/json
+- **Accept**: application/json
 

data/docs/Customer.md

@@ -1,6 +1,7 @@
 # OpenapiClient::Customer
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | Unique ID for the customer, if registered. This field is required if the parent object is present. | 
@@ -16,4 +17,23 @@ Name | Type | Description | Notes
 **address** | [**CustomerAddress**](CustomerAddress.md) |  | [optional] 
 **user_defined** | [**Object**](.md) | A JSON object that can carry any additional information about the customer that might be helpful for fraud detection. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Customer.new(id: 125Xasdf57D,
+                                 start_date: 2017-01-04,
+                                 first_name: John,
+                                 last_name: Smith,
+                                 middle_name: Joseph,
+                                 email: accept@xyz.com,
+                                 session_id: session-1,
+                                 username: username,
+                                 gender: male,
+                                 date_of_birth: 1982,
+                                 address: null,
+                                 user_defined: {"previouslyAffected":"Y"})
+```
+
 

data/docs/CustomerAddress.md

@@ -1,6 +1,7 @@
 # OpenapiClient::CustomerAddress
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **street** | **String** | First line of street address. | 
@@ -11,4 +12,18 @@ Name | Type | Description | Notes
 **phone** | [**CustomerAddressPhone**](CustomerAddressPhone.md) |  | [optional] 
 **zip_postal_code** | **String** | Postal code. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CustomerAddress.new(street: Apartment 123,
+                                 street2: 123 Main Street,
+                                 state_province: NY,
+                                 city: New York,
+                                 country: US,
+                                 phone: null,
+                                 zip_postal_code: 11375)
+```
+
 

data/docs/CustomerAddressPhone.md

@@ -1,9 +1,19 @@
 # OpenapiClient::CustomerAddressPhone
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | Type of phone. | [optional] 
 **number** | **String** | Free form phone number. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::CustomerAddressPhone.new(type: mobile,
+                                 number: 212-515-1212)
+```
+
 

data/docs/DCCExchangeRateRequest.md

@@ -1,11 +1,17 @@
 # OpenapiClient::DCCExchangeRateRequest
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Object name of the exchange rate request. | 
-**base_amount** | **Float** | The original amount of the merchant currency for calculation. | 
-**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same app. | [optional] 
 **bin** | **String** | A bank identification number (BIN) of the card to be used for DCC. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::DCCExchangeRateRequest.new(bin: 411111)
+```
+
 

data/docs/DCCExchangeRateRequestAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::DCCExchangeRateRequestAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bin** | **String** | A bank identification number (BIN) of the card to be used for DCC. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::DCCExchangeRateRequestAllOf.new(bin: 411111)
+```
+
+

data/docs/Dcc.md

@@ -1,10 +1,17 @@
 # OpenapiClient::Dcc
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**conversion_type** | **String** | Type of currency conversion. | 
-**inquiry_rate_id** | **String** | Inquiry rate id. | 
-**dcc_applied** | **BOOLEAN** | Indicates whether customer agrees with rate to be used. | 
+**dcc_applied** | **Boolean** | Indicates whether customer agrees with rate to be used. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Dcc.new(dcc_applied: true)
+```
 
 

data/docs/DccAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::DccAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dcc_applied** | **Boolean** | Indicates whether customer agrees with rate to be used. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::DccAllOf.new(dcc_applied: true)
+```
+
+