first_data_gateway 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c07c45d746d164f204a5b7186c2a67c561907aa5
+  data.tar.gz: ea9d532763d9e84834cfd296a9864ee7e69f04cf
+SHA512:
+  metadata.gz: 6b8abda3582ec5ef39a7299a8871b7967c299c1b98cddb608d169e184e9348929b1b75fc0ace7caf12535a61e34fbabc2c685a861bd7640ef31768d25b2dae41
+  data.tar.gz: a457e5b6daa645027832c17545ab4a441519f966fef875f241a7918831deea7a99955f585f646d5ff7593119fb73da09e1940b8d6fbd875931544a3afceede65

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,123 @@
+# FirstApiClient
+
+## Installation
+
+### Install the gem
+
+```shell
+gem install first_api_client
+```
+(for development, run `gem install --dev first_api_client` to install the development dependencies)
+
+Then add the gem to your Gemfile:
+
+    gem 'first_api_client', '~> 1.0.0'
+
+### Install from Git
+
+Add the following in the Gemfile:
+
+    gem 'swagger_client', :git => 'https://github.com/GBSEcom/Ruby.git'
+
+## Getting Started
+
+```ruby
+# Load the gem
+require 'swagger_client'
+require 'simple_client'
+
+api_key = "Your API Key here"
+api_secret = "Your API Secret here"
+
+credentials = SimpleClient::MerchantCredentials.new(api_key, api_secret)
+
+gateway = SimpleClient::Gateway.create(credentials)
+
+payload = 	"{ 
+				\"amount\":{
+					\"currency\":\"USD\",
+					\"total\":\"12.10\"
+				},
+				\"paymentMethod\":{
+					\"paymentCard\":{
+						\"expiryDate\":{
+							\"month\":\"12\",
+							\"year\":\"21\"
+						},
+						\"number\":\"5500000000000004\"
+					},
+					\"type\":\"PAYMENT_CARD\"
+				},
+				\"transactionType\":\"SALE\"
+			}"
+result = gateway.primary_payment_transaction(payload)
+p JSON.generate(result.to_hash)
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://cert.api.firstdata.com/gateway*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*SwaggerClient::AuthenticationApi* | [**v1_authentication_access_tokens_post**](docs/AuthenticationApi.md#v1_authentication_access_tokens_post) | **POST** /v1/authentication/access-tokens | Generate an access token for user authentication
+*SwaggerClient::OrderApi* | [**perform_payment_post_authorisation**](docs/OrderApi.md#perform_payment_post_authorisation) | **POST** /v1/orders/{order-id}/postauth | Use this to capture/complete a transaction. Partial postauths are allowed.
+*SwaggerClient::OrderApi* | [**return_transaction**](docs/OrderApi.md#return_transaction) | **POST** /v1/orders/{order-id}/return | Use this to return/refund on the order. Partial returns are allowed.
+*SwaggerClient::PaymentApi* | [**perform_payment_post_authorisation**](docs/PaymentApi.md#perform_payment_post_authorisation) | **POST** /v1/payments/{transaction-id}/postauth | Use this to capture/complete a transaction. Partial postauths are allowed.
+*SwaggerClient::PaymentApi* | [**primary_payment_transaction**](docs/PaymentApi.md#primary_payment_transaction) | **POST** /v1/payments | Generate a primary transaction
+*SwaggerClient::PaymentApi* | [**return_transaction**](docs/PaymentApi.md#return_transaction) | **POST** /v1/payments/{transaction-id}/return | Return/refund a transaction.
+*SwaggerClient::PaymentApi* | [**transaction_inquiry**](docs/PaymentApi.md#transaction_inquiry) | **GET** /v1/payments/{transaction-id} | Retrieve the state of a transaction
+*SwaggerClient::PaymentApi* | [**void_transaction**](docs/PaymentApi.md#void_transaction) | **POST** /v1/payments/{transaction-id}/void | Reverse a previous action on an existing transaction
+
+
+## Documentation for Models
+
+ - [SwaggerClient::AccessTokenResponse](docs/AccessTokenResponse.md)
+ - [SwaggerClient::Address](docs/Address.md)
+ - [SwaggerClient::Airline](docs/Airline.md)
+ - [SwaggerClient::AirlineAncillaryServiceCategory](docs/AirlineAncillaryServiceCategory.md)
+ - [SwaggerClient::AirlineTravelRoute](docs/AirlineTravelRoute.md)
+ - [SwaggerClient::Amount](docs/Amount.md)
+ - [SwaggerClient::AmountComponents](docs/AmountComponents.md)
+ - [SwaggerClient::AuthenticationResponseVerification](docs/AuthenticationResponseVerification.md)
+ - [SwaggerClient::BasketItem](docs/BasketItem.md)
+ - [SwaggerClient::Billing](docs/Billing.md)
+ - [SwaggerClient::CarRental](docs/CarRental.md)
+ - [SwaggerClient::CarRentalExtraCharges](docs/CarRentalExtraCharges.md)
+ - [SwaggerClient::CardVerificationsTransaction](docs/CardVerificationsTransaction.md)
+ - [SwaggerClient::ClientLocale](docs/ClientLocale.md)
+ - [SwaggerClient::Contact](docs/Contact.md)
+ - [SwaggerClient::Error](docs/Error.md)
+ - [SwaggerClient::ErrorDetails](docs/ErrorDetails.md)
+ - [SwaggerClient::ErrorResponse](docs/ErrorResponse.md)
+ - [SwaggerClient::Expiration](docs/Expiration.md)
+ - [SwaggerClient::Frequency](docs/Frequency.md)
+ - [SwaggerClient::IndustrySpecificExtensions](docs/IndustrySpecificExtensions.md)
+ - [SwaggerClient::InstallmentOptions](docs/InstallmentOptions.md)
+ - [SwaggerClient::Lodging](docs/Lodging.md)
+ - [SwaggerClient::LodgingExtraCharges](docs/LodgingExtraCharges.md)
+ - [SwaggerClient::Order](docs/Order.md)
+ - [SwaggerClient::PayPal](docs/PayPal.md)
+ - [SwaggerClient::PaymentCard](docs/PaymentCard.md)
+ - [SwaggerClient::PaymentCardAuthenticationRequest](docs/PaymentCardAuthenticationRequest.md)
+ - [SwaggerClient::PaymentCardAuthenticationResult](docs/PaymentCardAuthenticationResult.md)
+ - [SwaggerClient::PaymentMethod](docs/PaymentMethod.md)
+ - [SwaggerClient::PaymentSchedulesRequest](docs/PaymentSchedulesRequest.md)
+ - [SwaggerClient::PaymentSchedulesResponse](docs/PaymentSchedulesResponse.md)
+ - [SwaggerClient::PaymentUrlRequest](docs/PaymentUrlRequest.md)
+ - [SwaggerClient::PaymentUrlResponse](docs/PaymentUrlResponse.md)
+ - [SwaggerClient::PrimaryTransaction](docs/PrimaryTransaction.md)
+ - [SwaggerClient::PrimaryTransactionAdditionalDetails](docs/PrimaryTransactionAdditionalDetails.md)
+ - [SwaggerClient::ProcessorData](docs/ProcessorData.md)
+ - [SwaggerClient::ResponseType](docs/ResponseType.md)
+ - [SwaggerClient::SecondaryTransaction](docs/SecondaryTransaction.md)
+ - [SwaggerClient::Sepa](docs/Sepa.md)
+ - [SwaggerClient::SepaMandate](docs/SepaMandate.md)
+ - [SwaggerClient::Shipping](docs/Shipping.md)
+ - [SwaggerClient::SplitShipment](docs/SplitShipment.md)
+ - [SwaggerClient::StoredCredential](docs/StoredCredential.md)
+ - [SwaggerClient::TransactionResponse](docs/TransactionResponse.md)
+ - [SwaggerClient::TransactionResponseAuthenticationRedirect](docs/TransactionResponseAuthenticationRedirect.md)
+ - [SwaggerClient::TransactionResponseAuthenticationRedirectParams](docs/TransactionResponseAuthenticationRedirectParams.md)
+ - [SwaggerClient::TransactionType](docs/TransactionType.md)
+ - [SwaggerClient::TransactionErrorResponse](docs/TransactionErrorResponse.md)

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AccessTokenResponse.md

@@ -0,0 +1,11 @@
+# SwaggerClient::AccessTokenResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**access_token** | **String** | Access Token for authentication | [optional] 
+**client_request_id** | **String** | Echoes back the value from the request header for tracking | [optional] 
+**api_trace_id** | **String** | Request identifier in API. Use this to request logs from support. | [optional] 
+**request_status** | **String** | The result of the requested operation. If this is anything other than 'SUCCESS', please refer to the 400s HTTP error codes. See ErrorResponse object for details. | [optional] 
+
+

data/docs/Address.md

@@ -0,0 +1,14 @@
+# SwaggerClient::Address
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**company** | **String** | If it's a business, enter the name here. | [optional] 
+**address1** | **String** | street address or P.O.Box number | [optional] 
+**address2** | **String** | additional address information | [optional] 
+**city** | **String** | City or Locality | [optional] 
+**region** | **String** | State or Province | [optional] 
+**postal_code** | **String** | ZIP code or postal code | [optional] 
+**country** | **String** | Country name | [optional] 
+
+

data/docs/Airline.md

@@ -0,0 +1,21 @@
+# SwaggerClient::Airline
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**passenger_name** | **String** |  | [optional] 
+**ticket_number** | **String** |  | [optional] 
+**issuing_carrier** | **String** |  | [optional] 
+**carrier_name** | **String** |  | [optional] 
+**travel_agency_iata_code** | **String** |  | [optional] 
+**travel_agency_name** | **String** |  | [optional] 
+**airline_plan_number** | **String** |  | [optional] 
+**airline_invoice_number** | **String** |  | [optional] 
+**reservation_system** | **String** |  | [optional] 
+**restricted** | **BOOLEAN** |  | [optional] 
+**travel_route** | [**Array<AirlineTravelRoute>**](AirlineTravelRoute.md) |  | [optional] 
+**related_ticket_number** | **String** |  | [optional] 
+**ancillary_service_category** | [**Array<AirlineAncillaryServiceCategory>**](AirlineAncillaryServiceCategory.md) | Identify the purchase of ancillary goods or services with a false value. If this element is not provided, the transaction is assumed to be a purchase of an airline ticket. | [optional] 
+**ticket_purchase** | **BOOLEAN** |  | [optional] 
+
+

data/docs/AirlineAncillaryServiceCategory.md

@@ -0,0 +1,8 @@
+# SwaggerClient::AirlineAncillaryServiceCategory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**service_category** | **String** |  | [optional] 
+
+

data/docs/AirlineTravelRoute.md

@@ -0,0 +1,16 @@
+# SwaggerClient::AirlineTravelRoute
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**departure_date** | **Date** | Date of departure | [optional] 
+**origin** | **String** |  | [optional] 
+**destination** | **String** |  | [optional] 
+**carrier_code** | **String** |  | [optional] 
+**service_class** | **String** |  | [optional] 
+**stopover_type** | **String** |  | [optional] 
+**fare_basis_code** | **String** |  | [optional] 
+**departure_tax** | **Float** |  | [optional] 
+**flight_number** | **String** |  | [optional] 
+
+

data/docs/Amount.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Amount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Float** |  | 
+**currency** | **String** | ISO 4217 currency code (http://en.wikipedia.org/wiki/ISO_4217). | 
+**components** | [**AmountComponents**](AmountComponents.md) |  | [optional] 
+
+

data/docs/AmountComponents.md

@@ -0,0 +1,14 @@
+# SwaggerClient::AmountComponents
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subtotal** | **Float** |  | [optional] 
+**vat_amount** | **Float** |  | [optional] 
+**local_tax** | **Float** |  | [optional] 
+**shipping** | **Float** |  | [optional] 
+**cashback** | **Float** |  | [optional] 
+**tip** | **Float** |  | [optional] 
+**convenience_fee** | **Float** |  | [optional] 
+
+

data/docs/AuthenticationApi.md

@@ -0,0 +1,68 @@
+# SwaggerClient::AuthenticationApi
+
+All URIs are relative to *https://cert.api.firstdata.com/gateway*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**v1_authentication_access_tokens_post**](AuthenticationApi.md#v1_authentication_access_tokens_post) | **POST** /v1/authentication/access-tokens | Generate an access token for user authentication
+
+
+# **v1_authentication_access_tokens_post**
+> AccessTokenResponse v1_authentication_access_tokens_post(content_type, client_request_id, api_key, timestamp, message_signature, )
+
+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. 
+
+### Example
+```ruby
+# load the gem
+require 'swagger_client'
+
+api_instance = SwaggerClient::AuthenticationApi.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 | 
+
+timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
+
+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.
+
+
+begin
+  #Generate an access token for user authentication
+  result = api_instance.v1_authentication_access_tokens_post(content_type, client_request_id, api_key, timestamp, message_signature, )
+  p result
+rescue SwaggerClient::ApiError => e
+  puts "Exception when calling AuthenticationApi->v1_authentication_access_tokens_post: #{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**|  | 
+ **timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). | 
+ **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. | 
+
+### Return type
+
+[**AccessTokenResponse**](AccessTokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AuthenticationResponseVerification.md

@@ -0,0 +1,10 @@
+# SwaggerClient::AuthenticationResponseVerification
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**md** | **String** |  | [optional] 
+**pa_res** | **String** |  | [optional] 
+
+

data/docs/BasketItem.md

@@ -0,0 +1,11 @@
+# SwaggerClient::BasketItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Item ID | [optional] 
+**description** | **String** | Referenced parent Business Entity ID in master database for the outlets // COPY-PASTE ERROR? | [optional] 
+**unit_price** | [**Amount**](Amount.md) |  | [optional] 
+**count** | **Integer** | Total quantity of items | [optional] 
+
+

data/docs/Billing.md

@@ -0,0 +1,13 @@
+# SwaggerClient::Billing
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**personal_number** | **String** |  | [optional] 
+**birth_date** | **Date** |  | [optional] 
+**gender** | **String** |  | [optional] 
+**contact** | [**Contact**](Contact.md) |  | [optional] 
+**address** | [**Address**](Address.md) |  | [optional] 
+
+

data/docs/CarRental.md

@@ -0,0 +1,15 @@
+# SwaggerClient::CarRental
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**agreement_number** | **String** |  | [optional] 
+**renter_name** | **String** |  | [optional] 
+**return_city** | **String** |  | [optional] 
+**return_date** | **Date** |  | [optional] 
+**pickup_date** | **Date** |  | [optional] 
+**rental_class_id** | **String** |  | [optional] 
+**extra_charges** | [**Array<CarRentalExtraCharges>**](CarRentalExtraCharges.md) |  | [optional] 
+**no_show_indicator** | **BOOLEAN** |  | [optional] 
+
+

data/docs/CarRentalExtraCharges.md

@@ -0,0 +1,8 @@
+# SwaggerClient::CarRentalExtraCharges
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**charge_item** | **String** |  | [optional] 
+
+

data/docs/CardVerificationsTransaction.md

@@ -0,0 +1,9 @@
+# SwaggerClient::CardVerificationsTransaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**store_id** | **String** | Optional Outlet ID for clients that support multiple store in the same app | [optional] 
+**payment_method** | [**PaymentMethod**](PaymentMethod.md) |  | 
+
+

data/docs/ClientLocale.md

@@ -0,0 +1,9 @@
+# SwaggerClient::ClientLocale
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**language** | **String** | Language spoken by client. | 
+**country** | **String** | Country of the client. | 
+
+

data/docs/Contact.md

@@ -0,0 +1,11 @@
+# SwaggerClient::Contact
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone** | **String** |  | [optional] 
+**mobile_phone** | **String** |  | [optional] 
+**fax** | **String** |  | [optional] 
+**email** | **String** |  | [optional] 
+
+

data/docs/Error.md

@@ -0,0 +1,10 @@
+# SwaggerClient::Error
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Uniquely identifies an error condition. Client applications need to read and handle errors based on this. | [optional] 
+**message** | **String** | A generic description of the error condition. | [optional] 
+**details** | [**Array<ErrorDetails>**](ErrorDetails.md) | Detailed information about message format errors. | [optional] 
+
+