first_data_gateway 1.2.0 → 1.3.0

data/docs/Shipping.md

@@ -1,10 +1,21 @@
 # OpenapiClient::Shipping
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | Name of customer for shipping. | [optional] 
 **contact** | [**Contact**](Contact.md) |  | [optional] 
 **address** | [**Address**](Address.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Shipping.new(name: John Doe,
+                                 contact: null,
+                                 address: null)
+```
+
 

data/docs/SoftDescriptor.md

@@ -1,9 +1,19 @@
 # OpenapiClient::SoftDescriptor
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **dynamic_merchant_name** | **String** | Store \"doing-business-as\" name. | 
 **mcc** | **String** | The 4-digit merchant category code (MCC). The merchant might be associated with multiple MCCs. In that case the MCC provided here will be the one that better describes the current transaction. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SoftDescriptor.new(dynamic_merchant_name: Merchant XYZ,
+                                 mcc: 7311)
+```
+
 

data/docs/SplitShipment.md

@@ -1,9 +1,19 @@
 # OpenapiClient::SplitShipment
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **total_count** | **Integer** | Total count of the shipment, can be set at preauth or the first postauth. | [optional] 
-**final_shipment** | **BOOLEAN** | Indicates whether the transaction is the final shipment. | [optional] [default to false]
+**final_shipment** | **Boolean** | Indicates whether the transaction is the final shipment. | [optional] [default to false]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SplitShipment.new(total_count: 5,
+                                 final_shipment: null)
+```
 
 

data/docs/StoredCredential.md

@@ -1,11 +1,23 @@
 # OpenapiClient::StoredCredential
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **sequence** | **String** | Indicates if the transaction is first or subsequent. Valid values are 'FIRST' and 'SUBSEQUENT'. | 
-**scheduled** | **BOOLEAN** | Indicates if the transaction is scheduled or part of an installment. | 
+**scheduled** | **Boolean** | Indicates if the transaction is scheduled or part of an installment. | 
 **referenced_scheme_transaction_id** | **String** | The transaction ID received from schemes for the initial transaction. Required if sequence is 'SUBSEQUENT'. | [optional] 
 **initiator** | **String** | Indicates whether it is a merchant-initiated or explicitly consented to by card holder. Valid values are 'MERCHANT' and 'CARDHOLDER'. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::StoredCredential.new(sequence: FIRST,
+                                 scheduled: true,
+                                 referenced_scheme_transaction_id: 019087868716215,
+                                 initiator: MERCHANT)
+```
+
 

data/docs/SubMerchantData.md

@@ -1,6 +1,7 @@
 # OpenapiClient::SubMerchantData
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **mcc** | **String** | Merchant category code. | 
@@ -10,4 +11,17 @@ Name | Type | Description | Notes
 **document** | [**Document**](Document.md) |  | [optional] 
 **merchant_id** | **String** | Sub-merchant ID. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SubMerchantData.new(mcc: 7311,
+                                 legal_name: Walmart Inc.,
+                                 timezone: Europe/London,
+                                 address: null,
+                                 document: null,
+                                 merchant_id: 987654321)
+```
+
 

data/docs/SubMerchantSplit.md

@@ -1,9 +1,19 @@
 # OpenapiClient::SubMerchantSplit
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **merchant_id** | **String** | ID of merchant for tracking. | 
 **amount** | **Float** | The amount each sub-merchant receives. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::SubMerchantSplit.new(merchant_id: 100000001,
+                                 amount: 25.06)
+```
+
 

data/docs/Transaction.md

@@ -1,6 +1,7 @@
 # OpenapiClient::Transaction
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **transaction_state** | **String** | The state of the transaction. | [optional] 
@@ -16,4 +17,23 @@ Name | Type | Description | Notes
 **user_id** | **String** | The user ID. | [optional] 
 **processor** | [**ProcessorData**](ProcessorData.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::Transaction.new(transaction_state: AUTHORIZED,
+                                 ipg_transaction_id: 838916029301,
+                                 order_id: 123456,
+                                 transaction_type: null,
+                                 payment_method_details: null,
+                                 transaction_amount: null,
+                                 submission_component: API,
+                                 payer_security_level: m,
+                                 transaction_time: 1518811817,
+                                 store_id: 1109959991,
+                                 user_id: 1,
+                                 processor: null)
+```
+
 

data/docs/TransactionErrorResponse.md

@@ -1,6 +1,7 @@
 # OpenapiClient::TransactionErrorResponse
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
@@ -28,4 +29,35 @@ Name | Type | Description | Notes
 **account_updater_response** | [**AccountUpdaterResponse**](AccountUpdaterResponse.md) |  | [optional] 
 **error** | [**Error**](Error.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TransactionErrorResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 ipg_transaction_id: 838916029301,
+                                 order_id: 123456,
+                                 transaction_type: null,
+                                 payment_token: null,
+                                 transaction_origin: null,
+                                 payment_method_details: null,
+                                 country: USA,
+                                 terminal_id: 123456,
+                                 merchant_transaction_id: lsk23532djljff3,
+                                 transaction_time: 1518811817,
+                                 approved_amount: null,
+                                 transaction_status: APPROVED,
+                                 transaction_state: AUTHORIZED,
+                                 secure3d_response: null,
+                                 redirect_url: http://pay.issuer-bank.com/sessionID=123&sharedKey=456,
+                                 authentication_redirect: null,
+                                 scheme_transaction_id: 019078743804756,
+                                 processor: null,
+                                 additional_details: null,
+                                 account_updater_response: null,
+                                 error: null)
+```
+
 

data/docs/TransactionOrigin.md

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

data/docs/TransactionResponse.md

@@ -1,6 +1,7 @@
 # OpenapiClient::TransactionResponse
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional] 
@@ -27,4 +28,34 @@ Name | Type | Description | Notes
 **additional_details** | [**AdditionalTransactionDetails**](AdditionalTransactionDetails.md) |  | [optional] 
 **account_updater_response** | [**AccountUpdaterResponse**](AccountUpdaterResponse.md) |  | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::TransactionResponse.new(client_request_id: 30dd879c-ee2f-11db-8314-0800200c9a66,
+                                 api_trace_id: rrt-0bd552c12342d3448-b-ea-1142-12938318-7,
+                                 response_type: null,
+                                 ipg_transaction_id: 838916029301,
+                                 order_id: 123456,
+                                 transaction_type: null,
+                                 payment_token: null,
+                                 transaction_origin: null,
+                                 payment_method_details: null,
+                                 country: USA,
+                                 terminal_id: 123456,
+                                 merchant_transaction_id: lsk23532djljff3,
+                                 transaction_time: 1518811817,
+                                 approved_amount: null,
+                                 transaction_status: APPROVED,
+                                 transaction_state: AUTHORIZED,
+                                 secure3d_response: null,
+                                 redirect_url: http://pay.issuer-bank.com/sessionID=123&sharedKey=456,
+                                 authentication_redirect: null,
+                                 scheme_transaction_id: 019078743804756,
+                                 processor: null,
+                                 additional_details: null,
+                                 account_updater_response: null)
+```
+
 

data/docs/TransactionType.md

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

data/docs/UnionPayAuthenticationRequest.md

@@ -1,9 +1,17 @@
 # OpenapiClient::UnionPayAuthenticationRequest
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Indicates what kind of authentication scheme the merchant wants to use on the card. | 
 **sms_phone_number** | **String** | Mobile number for SMS verification. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UnionPayAuthenticationRequest.new(sms_phone_number: 86-13012345678)
+```
+
 

data/docs/UnionPayAuthenticationRequestAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::UnionPayAuthenticationRequestAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms_phone_number** | **String** | Mobile number for SMS verification. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UnionPayAuthenticationRequestAllOf.new(sms_phone_number: 86-13012345678)
+```
+
+

data/docs/UnionPayAuthenticationVerificationRequest.md

@@ -1,12 +1,17 @@
 # OpenapiClient::UnionPayAuthenticationVerificationRequest
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**store_id** | **String** | An optional Outlet ID for clients that support multiple stores in the same developer app. | [optional] 
-**request_type** | **String** | Object name of the authentication verification request. | 
-**security_code** | **String** | Card security code if required by merchant. | [optional] 
-**billing_address** | [**Address**](Address.md) |  | [optional] 
 **sms_verification_code** | **String** | Customer mobile number for SMS verification. | 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UnionPayAuthenticationVerificationRequest.new(sms_verification_code: 111111)
+```
+
 

data/docs/UnionPayAuthenticationVerificationRequestAllOf.md

@@ -0,0 +1,17 @@
+# OpenapiClient::UnionPayAuthenticationVerificationRequestAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms_verification_code** | **String** | Customer mobile number for SMS verification. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UnionPayAuthenticationVerificationRequestAllOf.new(sms_verification_code: 111111)
+```
+
+

data/docs/UsePaymentToken.md

@@ -1,10 +1,21 @@
 # OpenapiClient::UsePaymentToken
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **value** | **String** | Client-supplied payment token value. | 
 **function** | [**CardFunction**](CardFunction.md) |  | [optional] 
 **security_code** | **String** | Card verification value/number. | [optional] 
 
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::UsePaymentToken.new(value: 1235325235236,
+                                 function: null,
+                                 security_code: 977)
+```
+
 

data/docs/VoidTransaction.md

@@ -1,10 +1,16 @@
 # OpenapiClient::VoidTransaction
 
 ## Properties
+
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**request_type** | **String** | Object name of the secondary transaction request. | 
-**store_id** | **String** | An optional outlet ID for clients that support multiple stores in the same developer app. | [optional] 
-**comments** | **String** | Comment for the secondary transaction. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::VoidTransaction.new()
+```
 
 

data/docs/WalletPaymentMethod.md

@@ -0,0 +1,17 @@
+# OpenapiClient::WalletPaymentMethod
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wallet_type** | **String** | Type of wallet. | 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::WalletPaymentMethod.new(wallet_type: EncryptedApplePayWalletPaymentMethod)
+```
+
+

data/docs/WalletPreAuthTransaction.md

@@ -0,0 +1,21 @@
+# OpenapiClient::WalletPreAuthTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wallet_payment_method** | [**WalletPaymentMethod**](WalletPaymentMethod.md) |  | 
+**split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 
+**payment_facilitator** | [**PaymentFacilitator**](PaymentFacilitator.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::WalletPreAuthTransaction.new(wallet_payment_method: null,
+                                 split_shipment: null,
+                                 payment_facilitator: null)
+```
+
+

data/docs/WalletPreAuthTransactionAllOf.md

@@ -0,0 +1,21 @@
+# OpenapiClient::WalletPreAuthTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wallet_payment_method** | [**WalletPaymentMethod**](WalletPaymentMethod.md) |  | 
+**split_shipment** | [**SplitShipment**](SplitShipment.md) |  | [optional] 
+**payment_facilitator** | [**PaymentFacilitator**](PaymentFacilitator.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::WalletPreAuthTransactionAllOf.new(wallet_payment_method: null,
+                                 split_shipment: null,
+                                 payment_facilitator: null)
+```
+
+

data/docs/WalletSaleTransaction.md

@@ -0,0 +1,19 @@
+# OpenapiClient::WalletSaleTransaction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wallet_payment_method** | [**WalletPaymentMethod**](WalletPaymentMethod.md) |  | 
+**payment_facilitator** | [**PaymentFacilitator**](PaymentFacilitator.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::WalletSaleTransaction.new(wallet_payment_method: null,
+                                 payment_facilitator: null)
+```
+
+

data/docs/WalletSaleTransactionAllOf.md

@@ -0,0 +1,19 @@
+# OpenapiClient::WalletSaleTransactionAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wallet_payment_method** | [**WalletPaymentMethod**](WalletPaymentMethod.md) |  | 
+**payment_facilitator** | [**PaymentFacilitator**](PaymentFacilitator.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = OpenapiClient::WalletSaleTransactionAllOf.new(wallet_payment_method: null,
+                                 payment_facilitator: null)
+```
+
+

data/lib/openapi_client/api/authentication_api.rb

@@ -3,7 +3,7 @@
 
 #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.
 
-OpenAPI spec version: 6.6.0.20190329.001
+The version of the OpenAPI document: 6.6.0.20190507.002
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: unset
@@ -21,10 +21,10 @@ module OpenapiClient
     end
     # Generate an access token for user authentication.
     # This is the access token generation call for authorizing subsequent financial transactions. A valid access token is required for web client requests.
-    # @param content_type Content type.
-    # @param client_request_id 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 Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-    # @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+    # @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 [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.
     # @return [AccessTokenResponse]
@@ -35,13 +35,13 @@ module OpenapiClient
 
     # Generate an access token for user authentication.
     # This is the access token generation call for authorizing subsequent financial transactions. A valid access token is required for web client requests.
-    # @param content_type Content type.
-    # @param client_request_id 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 Key given to merchant after boarding associating their requests with the appropriate app in Apigee.
-    # @param timestamp Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+    # @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 [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.
-    # @return [Array<(AccessTokenResponse, Fixnum, Hash)>] AccessTokenResponse data, response status code and response headers
+    # @return [Array<(AccessTokenResponse, Integer, Hash)>] AccessTokenResponse data, response status code and response headers
     def authentication_access_tokens_post_with_http_info(content_type, client_request_id, api_key, timestamp, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthenticationApi.authentication_access_tokens_post ...'
@@ -51,8 +51,9 @@ module OpenapiClient
         fail ArgumentError, "Missing the required parameter 'content_type' when calling AuthenticationApi.authentication_access_tokens_post"
       end
       # verify enum value
-      if @api_client.config.client_side_validation && !['application/json'].include?(content_type)
-        fail ArgumentError, "invalid value for 'content_type', must be one of application/json"
+      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?
@@ -70,10 +71,10 @@ module OpenapiClient
       local_var_path = '/authentication/access-tokens'
 
       # query parameters
-      query_params = {}
+      query_params = opts[:query_params] || {}
 
       # header parameters
-      header_params = {}
+      header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       # header_params[:'Content-Type'] = content_type
@@ -83,24 +84,31 @@ module OpenapiClient
       header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
 
       # form parameters
-      form_params = {}
+      form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = nil
-      auth_names = []
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'AccessTokenResponse' 
+
+      # 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 => 'AccessTokenResponse',
+        :return_type => 'AccessTokenResponse',  
         :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: AuthenticationApi#authentication_access_tokens_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
-
   end
 end