yapstone-payments 1.0.0

data/docs/Phone.md

@@ -0,0 +1,21 @@
+# Yapstone::Phone
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**country_dialing_code** | **Integer** | The prefix for dialing a country with no special characters or spaces. | [optional] 
+**number** | **String** | phone number | [optional] 
+**extension** | **Integer** | If there is an extension associated with the number, it appears here. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::Phone.new(country_dialing_code: null,
+                                 number: null,
+                                 extension: null)
+```
+
+

data/docs/ProcessPayment.md

@@ -0,0 +1,29 @@
+# Yapstone::ProcessPayment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**channel** | **String** | The mode of communication (or channel) used to process the payment. | [optional] 
+**client_correlation_id** | **String** | A unique identifier that is attached to all transactions that have to do with a particular payment. You can track all the steps a payment went through using this ID.  | [optional] 
+**client_unique_transaction_id** | **String** | This is the unique transaction ID for one transaction to do with a payment being processed. You can use this to retrieve a specific transaction vs. a set of associated transactions (which is what you would use the clientCorrelationId for). You can use this to identify duplicate requests.  | [optional] 
+**marketplace** | [**MarketplaceData**](MarketplaceData.md) |  | [optional] 
+**customer** | [**Customer**](Customer.md) |  | [optional] 
+**payment_details** | [**PaymentDetails**](PaymentDetails.md) |  | [optional] 
+**custom_data** | **Hash<String, String>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::ProcessPayment.new(channel: null,
+                                 client_correlation_id: null,
+                                 client_unique_transaction_id: null,
+                                 marketplace: null,
+                                 customer: null,
+                                 payment_details: null,
+                                 custom_data: null)
+```
+
+

data/docs/PropertyInfo.md

@@ -0,0 +1,21 @@
+# Yapstone::PropertyInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address** | [**Address**](Address.md) |  | [optional] 
+**external_property_id** | **String** | Unique identifier for a property.  | [optional] 
+**property_name** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PropertyInfo.new(address: null,
+                                 external_property_id: null,
+                                 property_name: null)
+```
+
+

data/docs/PropertyInfoResponse.md

@@ -0,0 +1,19 @@
+# Yapstone::PropertyInfoResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**external_property_id** | **String** | Optionally provide your system's internal identifier for this entity, for use later if you need to correlate data across systems or consolidate records.  | [optional] 
+**property_id** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::PropertyInfoResponse.new(external_property_id: 967055d5-ebdf-4e38-908c-6ed3ec5043dc,
+                                 property_id: null)
+```
+
+

data/docs/RefundAction.md

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

data/docs/RefundCancelResponse.md

@@ -0,0 +1,21 @@
+# Yapstone::RefundCancelResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**refund_id** | **String** | refundId | [optional] 
+**status** | [**Status**](Status.md) |  | [optional] 
+**transactions** | [**Array<RefundCancelTransactionResponse>**](RefundCancelTransactionResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::RefundCancelResponse.new(refund_id: null,
+                                 status: null,
+                                 transactions: null)
+```
+
+

data/docs/RefundCancelTransactionResponse.md

@@ -0,0 +1,19 @@
+# Yapstone::RefundCancelTransactionResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_id** | **String** | A unique identifier for the specific transaction associated with the payment you are cancelling.  | [optional] 
+**response** | **String** | Response | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::RefundCancelTransactionResponse.new(transaction_id: null,
+                                 response: null)
+```
+
+

data/docs/RefundRequest.md

@@ -0,0 +1,25 @@
+# Yapstone::RefundRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_correlation_id** | **String** | client correlation id | [optional] 
+**client_unique_transaction_id** | **String** | clientUniqueTransactionId used to identify duplicate request | [optional] 
+**payment_id** | **String** |  | [optional] 
+**amount** | [**Amount**](Amount.md) |  | [optional] 
+**transactions** | [**Array<Transaction>**](Transaction.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::RefundRequest.new(client_correlation_id: null,
+                                 client_unique_transaction_id: null,
+                                 payment_id: null,
+                                 amount: null,
+                                 transactions: null)
+```
+
+

data/docs/RefundResponse.md

@@ -0,0 +1,29 @@
+# Yapstone::RefundResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_correlation_id** | **String** |  | [optional] 
+**client_unique_transaction_id** | **String** | Provide a nonce for this request. Yapstone's system will use this to prevent request duplication or accidental retry from causing multiple payments.  | [optional] 
+**action** | [**RefundAction**](RefundAction.md) |  | [optional] 
+**payment_id** | **String** |  | [optional] 
+**refund_id** | **String** |  | [optional] 
+**status** | [**Status**](Status.md) |  | [optional] 
+**refund_transactions** | [**Array<RefundTransactions>**](RefundTransactions.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::RefundResponse.new(client_correlation_id: null,
+                                 client_unique_transaction_id: 4ed13361-5d66-4b76-8c6c-b462d5f638a7,
+                                 action: null,
+                                 payment_id: null,
+                                 refund_id: null,
+                                 status: null,
+                                 refund_transactions: null)
+```
+
+

data/docs/RefundStatus.md

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

data/docs/RefundTransactions.md

@@ -0,0 +1,27 @@
+# Yapstone::RefundTransactions
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_unique_transaction_id** | **String** | clientUniqueTransactionId | [optional] 
+**refund_id** | **String** |  | [optional] 
+**refund_transaction_id** | **String** | Unique identifier provided by Yapstone for the transaction.  | [optional] 
+**line_items** | [**Array<LineItemDetails>**](LineItemDetails.md) |  | [optional] 
+**status** | [**RefundStatus**](RefundStatus.md) |  | [optional] 
+**transaction_type** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'Yapstone'
+
+instance = Yapstone::RefundTransactions.new(client_unique_transaction_id: null,
+                                 refund_id: null,
+                                 refund_transaction_id: null,
+                                 line_items: null,
+                                 status: null,
+                                 transaction_type: null)
+```
+
+

data/docs/RefundsApi.md

@@ -0,0 +1,378 @@
+# Yapstone::RefundsApi
+
+All URIs are relative to *https://api-prod-sandbox.yapstone.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**cancel_refund**](RefundsApi.md#cancel_refund) | **DELETE** /v2/refunds/refund/{refundId} | Cancel Payment by payment Id
+[**create_payment_refund**](RefundsApi.md#create_payment_refund) | **POST** /v2/refunds/payment | Create a refund
+[**create_transaction_refund**](RefundsApi.md#create_transaction_refund) | **POST** /v2/refunds/transaction | Create a refund
+[**get_by_originaltransaction_id**](RefundsApi.md#get_by_originaltransaction_id) | **GET** /v2/refunds/transaction/{transactionId} | Get master Transaction details including all refund details by transaction Id
+[**get_refund**](RefundsApi.md#get_refund) | **GET** /v2/refunds/refund/{refundId} | Get master payment details including all refund detail by refund ID.
+[**get_refund_by_payment_id**](RefundsApi.md#get_refund_by_payment_id) | **GET** /v2/refunds/payment/{paymentId} | Get master payment details including all refund details by Payment Id.
+
+
+
+## cancel_refund
+
+> RefundCancelResponse cancel_refund(authorization, x_yapstone_ip_address, refund_id, opts)
+
+Cancel Payment by payment Id
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::RefundsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | Ip Address of the client
+refund_id = 'refund_id_example' # String | refundId
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | X-Yapstone-Trace-Id
+  x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | Device Finger Print Id
+}
+
+begin
+  #Cancel Payment by payment Id
+  result = api_instance.cancel_refund(authorization, x_yapstone_ip_address, refund_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling RefundsApi->cancel_refund: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| Ip Address of the client | 
+ **refund_id** | **String**| refundId | 
+ **x_yapstone_trace_id** | **String**| X-Yapstone-Trace-Id | [optional] 
+ **x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional] 
+
+### Return type
+
+[**RefundCancelResponse**](RefundCancelResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_payment_refund
+
+> RefundResponse create_payment_refund(authorization, x_yapstone_ip_address, refund_request, opts)
+
+Create a refund
+
+Create a refund for a payment that was processed
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::RefundsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
+refund_request = Yapstone::RefundRequest.new # RefundRequest | 
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | Device Finger Print Id
+}
+
+begin
+  #Create a refund
+  result = api_instance.create_payment_refund(authorization, x_yapstone_ip_address, refund_request, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling RefundsApi->create_payment_refund: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| IP Address of the client | 
+ **refund_request** | [**RefundRequest**](RefundRequest.md)|  | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+ **x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional] 
+
+### Return type
+
+[**RefundResponse**](RefundResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_transaction_refund
+
+> RefundResponse create_transaction_refund(authorization, x_yapstone_ip_address, transaction, opts)
+
+Create a refund
+
+Use this end point to kick off a refund for transaction. If you've already captured the transaction, this will result in a refund of the amount captured and the details of that refund will be returned in the response body. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::RefundsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
+transaction = Yapstone::Transaction.new # Transaction | 
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+  x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | Device Finger Print Id
+}
+
+begin
+  #Create a refund
+  result = api_instance.create_transaction_refund(authorization, x_yapstone_ip_address, transaction, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling RefundsApi->create_transaction_refund: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| IP Address of the client | 
+ **transaction** | [**Transaction**](Transaction.md)|  | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+ **x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional] 
+
+### Return type
+
+[**RefundResponse**](RefundResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_by_originaltransaction_id
+
+> TransactionResponse get_by_originaltransaction_id(authorization, x_yapstone_ip_address, transaction_id, opts)
+
+Get master Transaction details including all refund details by transaction Id
+
+Transactions are nested inside payments. Master transactions are nested inside the master payment. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::RefundsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
+transaction_id = 'transaction_id_example' # String | transactionId
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example' # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+}
+
+begin
+  #Get master Transaction details including all refund details by transaction Id
+  result = api_instance.get_by_originaltransaction_id(authorization, x_yapstone_ip_address, transaction_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling RefundsApi->get_by_originaltransaction_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| IP Address of the client | 
+ **transaction_id** | **String**| transactionId | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+
+### Return type
+
+[**TransactionResponse**](TransactionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_refund
+
+> RefundResponse get_refund(authorization, x_yapstone_ip_address, refund_id, opts)
+
+Get master payment details including all refund detail by refund ID.
+
+A master payment is the initial payment that all other payment details and transactions tied to that payment connect to. You can use a refund ID to retrieve master payment information. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::RefundsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
+refund_id = 'refund_id_example' # String | refundId
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example' # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+}
+
+begin
+  #Get master payment details including all refund detail by refund ID.
+  result = api_instance.get_refund(authorization, x_yapstone_ip_address, refund_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling RefundsApi->get_refund: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| IP Address of the client | 
+ **refund_id** | **String**| refundId | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+
+### Return type
+
+[**RefundResponse**](RefundResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_refund_by_payment_id
+
+> RefundResponse get_refund_by_payment_id(authorization, x_yapstone_ip_address, payment_id, opts)
+
+Get master payment details including all refund details by Payment Id.
+
+A master payment is the initial payment that all other payment details and transactions tied to that payment connect to. 
+
+### Example
+
+```ruby
+# load the gem
+require 'yapstone-payments'
+# setup authorization
+Yapstone.configure do |config|
+  # Configure Bearer authorization (JWT): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Yapstone::RefundsApi.new
+authorization = 'authorization_example' # String | Authorization
+x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
+payment_id = 'payment_id_example' # String | paymentId
+opts = {
+  x_yapstone_trace_id: 'x_yapstone_trace_id_example' # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. 
+}
+
+begin
+  #Get master payment details including all refund details by Payment Id.
+  result = api_instance.get_refund_by_payment_id(authorization, x_yapstone_ip_address, payment_id, opts)
+  p result
+rescue Yapstone::ApiError => e
+  puts "Exception when calling RefundsApi->get_refund_by_payment_id: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **authorization** | **String**| Authorization | 
+ **x_yapstone_ip_address** | **String**| IP Address of the client | 
+ **payment_id** | **String**| paymentId | 
+ **x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.  | [optional] 
+
+### Return type
+
+[**RefundResponse**](RefundResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+