subfi_pay 0.1.0

data/docs/AccountsApi.md

@@ -0,0 +1,227 @@
+# SubFiPay::AccountsApi
+
+All URIs are relative to *https://pay-sandbox.subfi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_account**](AccountsApi.md#create_account) | **POST** /accounts | Create a new account |
+| [**get_account**](AccountsApi.md#get_account) | **GET** /accounts/{id} | Retrieve an account by ID |
+| [**list_accounts**](AccountsApi.md#list_accounts) | **GET** /accounts | List all accounts |
+
+
+## create_account
+
+> <AccountResponse> create_account(x_api_version, account_create_request)
+
+Create a new account
+
+### 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::AccountsApi.new
+x_api_version = 'x_api_version_example' # String | 
+account_create_request = SubFiPay::AccountCreateRequest.new # AccountCreateRequest | 
+
+begin
+  # Create a new account
+  result = api_instance.create_account(x_api_version, account_create_request)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling AccountsApi->create_account: #{e}"
+end
+```
+
+#### Using the create_account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountResponse>, Integer, Hash)> create_account_with_http_info(x_api_version, account_create_request)
+
+```ruby
+begin
+  # Create a new account
+  data, status_code, headers = api_instance.create_account_with_http_info(x_api_version, account_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling AccountsApi->create_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **account_create_request** | [**AccountCreateRequest**](AccountCreateRequest.md) |  |  |
+
+### Return type
+
+[**AccountResponse**](AccountResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_account
+
+> <AccountResponse> get_account(x_api_version, id)
+
+Retrieve an account by ID
+
+### 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::AccountsApi.new
+x_api_version = 'x_api_version_example' # String | 
+id = 'id_example' # String | 
+
+begin
+  # Retrieve an account by ID
+  result = api_instance.get_account(x_api_version, id)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling AccountsApi->get_account: #{e}"
+end
+```
+
+#### Using the get_account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AccountResponse>, Integer, Hash)> get_account_with_http_info(x_api_version, id)
+
+```ruby
+begin
+  # Retrieve an account by ID
+  data, status_code, headers = api_instance.get_account_with_http_info(x_api_version, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AccountResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling AccountsApi->get_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**AccountResponse**](AccountResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_accounts
+
+> <ListAccountsResponse> list_accounts(x_api_version, opts)
+
+List all accounts
+
+### 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::AccountsApi.new
+x_api_version = 'x_api_version_example' # String | 
+opts = {
+  page: 56, # Integer | The page of results to retrieve.
+  per_page: 56 # Integer | Number of results per page.
+}
+
+begin
+  # List all accounts
+  result = api_instance.list_accounts(x_api_version, opts)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling AccountsApi->list_accounts: #{e}"
+end
+```
+
+#### Using the list_accounts_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListAccountsResponse>, Integer, Hash)> list_accounts_with_http_info(x_api_version, opts)
+
+```ruby
+begin
+  # List all accounts
+  data, status_code, headers = api_instance.list_accounts_with_http_info(x_api_version, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListAccountsResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling AccountsApi->list_accounts_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **page** | **Integer** | The page of results to retrieve. | [optional] |
+| **per_page** | **Integer** | Number of results per page. | [optional] |
+
+### Return type
+
+[**ListAccountsResponse**](ListAccountsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BalanceTransactionAttributes.md

@@ -0,0 +1,30 @@
+# SubFiPay::BalanceTransactionAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** |  | [optional] |
+| **charge_id** | **String** |  | [optional] |
+| **fee** | **Integer** |  | [optional] |
+| **net** | **Integer** |  | [optional] |
+| **refund_id** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::BalanceTransactionAttributes.new(
+  amount: null,
+  charge_id: null,
+  fee: null,
+  net: null,
+  refund_id: null,
+  state: null,
+  type: null
+)
+```
+

data/docs/BalanceTransactionResponse.md

@@ -0,0 +1,38 @@
+# SubFiPay::BalanceTransactionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+| **connected_account_id** | **String** |  | [optional] |
+| **amount** | **Integer** |  | [optional] |
+| **charge_id** | **String** |  | [optional] |
+| **fee** | **Integer** |  | [optional] |
+| **net** | **Integer** |  | [optional] |
+| **refund_id** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::BalanceTransactionResponse.new(
+  id: null,
+  created_at: null,
+  updated_at: null,
+  connected_account_id: null,
+  amount: null,
+  charge_id: null,
+  fee: null,
+  net: null,
+  refund_id: null,
+  state: null,
+  type: null
+)
+```
+

data/docs/BalanceTransactionsApi.md

@@ -0,0 +1,87 @@
+# SubFiPay::BalanceTransactionsApi
+
+All URIs are relative to *https://pay-sandbox.subfi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_balance_transactions**](BalanceTransactionsApi.md#list_balance_transactions) | **GET** /balance_transactions | List all balance transactions |
+
+
+## list_balance_transactions
+
+> <ListBalanceTransactionsResponse> list_balance_transactions(x_api_version, x_account_id, opts)
+
+List all balance transactions
+
+### 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::BalanceTransactionsApi.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.
+}
+
+begin
+  # List all balance transactions
+  result = api_instance.list_balance_transactions(x_api_version, x_account_id, opts)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling BalanceTransactionsApi->list_balance_transactions: #{e}"
+end
+```
+
+#### Using the list_balance_transactions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListBalanceTransactionsResponse>, Integer, Hash)> list_balance_transactions_with_http_info(x_api_version, x_account_id, opts)
+
+```ruby
+begin
+  # List all balance transactions
+  data, status_code, headers = api_instance.list_balance_transactions_with_http_info(x_api_version, x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListBalanceTransactionsResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling BalanceTransactionsApi->list_balance_transactions_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] |
+
+### Return type
+
+[**ListBalanceTransactionsResponse**](ListBalanceTransactionsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BankAccountProfile.md

@@ -0,0 +1,28 @@
+# SubFiPay::BankAccountProfile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_holder_name** | **String** |  | [optional] |
+| **bank_name** | **String** |  | [optional] |
+| **account_holder_type** | **String** |  | [optional] |
+| **account_type** | **String** |  | [optional] |
+| **encrypted_account_number** | **String** |  | [optional] |
+| **routing_number** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::BankAccountProfile.new(
+  account_holder_name: null,
+  bank_name: null,
+  account_holder_type: null,
+  account_type: null,
+  encrypted_account_number: null,
+  routing_number: null
+)
+```
+

data/docs/BillingAddress.md

@@ -0,0 +1,36 @@
+# SubFiPay::BillingAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **address_line1** | **String** |  | [optional] |
+| **address_line2** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **postal_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::BillingAddress.new(
+  first_name: null,
+  last_name: null,
+  email: null,
+  phone: null,
+  address_line1: null,
+  address_line2: null,
+  city: null,
+  state: null,
+  country: null,
+  postal_code: null
+)
+```
+

data/docs/CardProfile.md

@@ -0,0 +1,42 @@
+# SubFiPay::CardProfile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **avs_check** | **String** |  | [optional] |
+| **avs_check_message** | **String** |  | [optional] |
+| **brand** | **String** |  | [optional] |
+| **cvc_check** | **String** |  | [optional] |
+| **cvc_check_message** | **String** |  | [optional] |
+| **exp_month** | **Integer** |  | [optional] |
+| **exp_year** | **Integer** |  | [optional] |
+| **funding** | **String** |  | [optional] |
+| **first6** | **String** |  | [optional] |
+| **last4** | **String** |  | [optional] |
+| **three_d_secure_supported** | **Boolean** |  | [optional] |
+| **token** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::CardProfile.new(
+  avs_check: null,
+  avs_check_message: null,
+  brand: null,
+  cvc_check: null,
+  cvc_check_message: null,
+  exp_month: null,
+  exp_year: null,
+  funding: null,
+  first6: null,
+  last4: null,
+  three_d_secure_supported: null,
+  token: null,
+  state: null
+)
+```
+

data/docs/ChargeAttributes.md

@@ -0,0 +1,26 @@
+# SubFiPay::ChargeAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Integer** |  |  |
+| **description** | **String** |  | [optional] |
+| **payment_method_id** | **String** |  |  |
+| **connected_account_id** | **String** |  | [optional] |
+| **immediate_capture** | **Boolean** | Determines whether the charge should be captured immediately | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::ChargeAttributes.new(
+  amount: null,
+  description: null,
+  payment_method_id: null,
+  connected_account_id: null,
+  immediate_capture: null
+)
+```
+

data/docs/ChargeResponse.md

@@ -0,0 +1,42 @@
+# SubFiPay::ChargeResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **captured_at** | **Time** |  | [optional] |
+| **failure_reason** | **String** |  | [optional] |
+| **account_id** | **String** |  | [optional] |
+| **payment_method** | [**PaymentMethodResponse**](PaymentMethodResponse.md) |  | [optional] |
+| **processor_id** | **String** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **amount** | **Integer** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **immediate_capture** | **Boolean** | Determines whether the charge should be captured immediately | [optional] |
+| **payment_method_id** | **String** |  | [optional] |
+| **connected_account_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::ChargeResponse.new(
+  id: null,
+  captured_at: null,
+  failure_reason: null,
+  account_id: null,
+  payment_method: null,
+  processor_id: null,
+  state: null,
+  created_at: null,
+  amount: null,
+  description: null,
+  immediate_capture: null,
+  payment_method_id: null,
+  connected_account_id: null
+)
+```
+