subfi_pay 0.1.0

data/docs/ChargesApi.md

@@ -0,0 +1,167 @@
+# SubFiPay::ChargesApi
+
+All URIs are relative to *https://pay-sandbox.subfi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_charge**](ChargesApi.md#get_charge) | **GET** /charges/{id} | Retrieve a charge |
+| [**list_charges**](ChargesApi.md#list_charges) | **GET** /charges | List all charges |
+
+
+## get_charge
+
+> <ChargeResponse> get_charge(x_api_version, x_account_id, id, opts)
+
+Retrieve a charge
+
+### Examples
+
+```ruby
+require 'time'
+require 'subfi_pay'
+# setup authorization
+SubFiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = SubFiPay::ChargesApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+id = 'id_example' # String | 
+opts = {
+  connected_account_id: 'connected_account_id_example' # String | Filter results by sub_merchant ID.
+}
+
+begin
+  # Retrieve a charge
+  result = api_instance.get_charge(x_api_version, x_account_id, id, opts)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling ChargesApi->get_charge: #{e}"
+end
+```
+
+#### Using the get_charge_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ChargeResponse>, Integer, Hash)> get_charge_with_http_info(x_api_version, x_account_id, id, opts)
+
+```ruby
+begin
+  # Retrieve a charge
+  data, status_code, headers = api_instance.get_charge_with_http_info(x_api_version, x_account_id, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ChargeResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling ChargesApi->get_charge_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **id** | **String** |  |  |
+| **connected_account_id** | **String** | Filter results by sub_merchant ID. | [optional] |
+
+### Return type
+
+[**ChargeResponse**](ChargeResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_charges
+
+> <ListChargesResponse> list_charges(x_api_version, x_account_id, opts)
+
+List all charges
+
+### Examples
+
+```ruby
+require 'time'
+require 'subfi_pay'
+# setup authorization
+SubFiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['ApiKeyAuth'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['ApiKeyAuth'] = 'Bearer'
+end
+
+api_instance = SubFiPay::ChargesApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+opts = {
+  page: 56, # Integer | The page of results to retrieve.
+  per_page: 56, # Integer | Number of results per page.
+  connected_account_id: 'connected_account_id_example', # String | Filter results by sub_merchant ID.
+  payment_intent_id: 'payment_intent_id_example' # String | Filter results by payment intent ID.
+}
+
+begin
+  # List all charges
+  result = api_instance.list_charges(x_api_version, x_account_id, opts)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling ChargesApi->list_charges: #{e}"
+end
+```
+
+#### Using the list_charges_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListChargesResponse>, Integer, Hash)> list_charges_with_http_info(x_api_version, x_account_id, opts)
+
+```ruby
+begin
+  # List all charges
+  data, status_code, headers = api_instance.list_charges_with_http_info(x_api_version, x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListChargesResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling ChargesApi->list_charges_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **page** | **Integer** | The page of results to retrieve. | [optional] |
+| **per_page** | **Integer** | Number of results per page. | [optional] |
+| **connected_account_id** | **String** | Filter results by sub_merchant ID. | [optional] |
+| **payment_intent_id** | **String** | Filter results by payment intent ID. | [optional] |
+
+### Return type
+
+[**ListChargesResponse**](ListChargesResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ConnectedAccountAttributes.md

@@ -0,0 +1,20 @@
+# SubFiPay::ConnectedAccountAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **worldpay_merchant_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::ConnectedAccountAttributes.new(
+  name: null,
+  worldpay_merchant_id: null
+)
+```
+

data/docs/ConnectedAccountResponse.md

@@ -0,0 +1,26 @@
+# SubFiPay::ConnectedAccountResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **worldpay_merchant_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::ConnectedAccountResponse.new(
+  id: null,
+  created_at: null,
+  updated_at: null,
+  name: null,
+  worldpay_merchant_id: null
+)
+```
+

data/docs/CreateAccountRequest.md

@@ -0,0 +1,18 @@
+# SubFiPay::CreateAccountRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account** | [**CreateAccountRequestAccount**](CreateAccountRequestAccount.md) |  |  |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CreateAccountRequest.new(
+  account: null
+)
+```
+

data/docs/CreateAccountRequestAccount.md

@@ -0,0 +1,20 @@
+# SubFiPay::CreateAccountRequestAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **worldpay_merchant_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CreateAccountRequestAccount.new(
+  name: null,
+  worldpay_merchant_id: null
+)
+```
+

data/docs/CreateCustomerRequest.md

@@ -0,0 +1,24 @@
+# SubFiPay::CreateCustomerRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CreateCustomerRequest.new(
+  customer_id: null,
+  name: null,
+  email: null,
+  phone: null
+)
+```
+

data/docs/CreateWebhookEndpointRequest.md

@@ -0,0 +1,18 @@
+# SubFiPay::CreateWebhookEndpointRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_endpoint** | [**CreateWebhookEndpointRequestWebhookEndpoint**](CreateWebhookEndpointRequestWebhookEndpoint.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CreateWebhookEndpointRequest.new(
+  webhook_endpoint: null
+)
+```
+

data/docs/CreateWebhookEndpointRequestWebhookEndpoint.md

@@ -0,0 +1,28 @@
+# SubFiPay::CreateWebhookEndpointRequestWebhookEndpoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **enabled** | **Boolean** |  | [optional] |
+| **secret** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **connected_account_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CreateWebhookEndpointRequestWebhookEndpoint.new(
+  event: null,
+  metadata: null,
+  enabled: null,
+  secret: null,
+  url: null,
+  connected_account_id: null
+)
+```
+

data/docs/Customer.md

@@ -0,0 +1,26 @@
+# SubFiPay::Customer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::Customer.new(
+  name: null,
+  email: null,
+  phone: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/CustomerAttributes.md

@@ -0,0 +1,24 @@
+# SubFiPay::CustomerAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CustomerAttributes.new(
+  name: null,
+  email: null,
+  phone: null,
+  metadata: null
+)
+```
+

data/docs/CustomerAttributesCustomer.md

@@ -0,0 +1,24 @@
+# SubFiPay::CustomerAttributesCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CustomerAttributesCustomer.new(
+  name: null,
+  email: null,
+  phone: null,
+  metadata: null
+)
+```
+

data/docs/CustomerCreateRequest.md

@@ -0,0 +1,18 @@
+# SubFiPay::CustomerCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer** | [**CustomerAttributes**](CustomerAttributes.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CustomerCreateRequest.new(
+  customer: null
+)
+```
+

data/docs/CustomerUpdateAttributes.md

@@ -0,0 +1,20 @@
+# SubFiPay::CustomerUpdateAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **default_payment_method_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CustomerUpdateAttributes.new(
+  name: null,
+  default_payment_method_id: null
+)
+```
+

data/docs/CustomerUpdateAttributesCustomer.md

@@ -0,0 +1,20 @@
+# SubFiPay::CustomerUpdateAttributesCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **default_payment_method_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CustomerUpdateAttributesCustomer.new(
+  name: null,
+  default_payment_method_id: null
+)
+```
+

data/docs/CustomerUpdateRequest.md

@@ -0,0 +1,18 @@
+# SubFiPay::CustomerUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer** | [**CustomerUpdateAttributes**](CustomerUpdateAttributes.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CustomerUpdateRequest.new(
+  customer: null
+)
+```
+