subfi_pay 0.1.0

data/docs/PaymentMethodsApi.md

@@ -0,0 +1,239 @@
+# SubFiPay::PaymentMethodsApi
+
+All URIs are relative to *https://pay-sandbox.subfi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_payment_method**](PaymentMethodsApi.md#create_payment_method) | **POST** /payment_methods | Create a payment method |
+| [**get_payment_method**](PaymentMethodsApi.md#get_payment_method) | **GET** /payment_methods/{id} | Retrieve a payment method |
+| [**list_payment_methods**](PaymentMethodsApi.md#list_payment_methods) | **GET** /payment_methods | List all payment methods |
+
+
+## create_payment_method
+
+> <PaymentMethodResponse> create_payment_method(x_api_version, x_account_id, payment_method_attributes, opts)
+
+Create a payment method
+
+### 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::PaymentMethodsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+payment_method_attributes = SubFiPay::PaymentMethodAttributes.new({type: 'type_example'}) # PaymentMethodAttributes | 
+opts = {
+  x_idempotency_key: 'x_idempotency_key_example' # String | 
+}
+
+begin
+  # Create a payment method
+  result = api_instance.create_payment_method(x_api_version, x_account_id, payment_method_attributes, opts)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling PaymentMethodsApi->create_payment_method: #{e}"
+end
+```
+
+#### Using the create_payment_method_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentMethodResponse>, Integer, Hash)> create_payment_method_with_http_info(x_api_version, x_account_id, payment_method_attributes, opts)
+
+```ruby
+begin
+  # Create a payment method
+  data, status_code, headers = api_instance.create_payment_method_with_http_info(x_api_version, x_account_id, payment_method_attributes, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentMethodResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling PaymentMethodsApi->create_payment_method_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **payment_method_attributes** | [**PaymentMethodAttributes**](PaymentMethodAttributes.md) |  |  |
+| **x_idempotency_key** | **String** |  | [optional] |
+
+### Return type
+
+[**PaymentMethodResponse**](PaymentMethodResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_payment_method
+
+> <PaymentMethodResponse> get_payment_method(x_api_version, x_account_id, id)
+
+Retrieve a payment method
+
+### 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::PaymentMethodsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+id = 'id_example' # String | 
+
+begin
+  # Retrieve a payment method
+  result = api_instance.get_payment_method(x_api_version, x_account_id, id)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling PaymentMethodsApi->get_payment_method: #{e}"
+end
+```
+
+#### Using the get_payment_method_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PaymentMethodResponse>, Integer, Hash)> get_payment_method_with_http_info(x_api_version, x_account_id, id)
+
+```ruby
+begin
+  # Retrieve a payment method
+  data, status_code, headers = api_instance.get_payment_method_with_http_info(x_api_version, x_account_id, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PaymentMethodResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling PaymentMethodsApi->get_payment_method_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**PaymentMethodResponse**](PaymentMethodResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_payment_methods
+
+> <ListPaymentMethodsResponse> list_payment_methods(x_api_version, x_account_id, customer_id, opts)
+
+List all payment methods
+
+### 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::PaymentMethodsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+customer_id = 'customer_id_example' # String | The ID of the customer to filter payment methods by.
+opts = {
+  page: 56, # Integer | The page of results to retrieve.
+  per_page: 56 # Integer | Number of results per page.
+}
+
+begin
+  # List all payment methods
+  result = api_instance.list_payment_methods(x_api_version, x_account_id, customer_id, opts)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling PaymentMethodsApi->list_payment_methods: #{e}"
+end
+```
+
+#### Using the list_payment_methods_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListPaymentMethodsResponse>, Integer, Hash)> list_payment_methods_with_http_info(x_api_version, x_account_id, customer_id, opts)
+
+```ruby
+begin
+  # List all payment methods
+  data, status_code, headers = api_instance.list_payment_methods_with_http_info(x_api_version, x_account_id, customer_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListPaymentMethodsResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling PaymentMethodsApi->list_payment_methods_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **customer_id** | **String** | The ID of the customer to filter payment methods by. |  |
+| **page** | **Integer** | The page of results to retrieve. | [optional] |
+| **per_page** | **Integer** | Number of results per page. | [optional] |
+
+### Return type
+
+[**ListPaymentMethodsResponse**](ListPaymentMethodsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RefundAttributes.md

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

data/docs/RefundResponse.md

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

data/docs/RefundsApi.md

@@ -0,0 +1,311 @@
+# SubFiPay::RefundsApi
+
+All URIs are relative to *https://pay-sandbox.subfi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_refund**](RefundsApi.md#cancel_refund) | **PUT** /refunds/{id}/cancel | Cancel a refund |
+| [**create_refund**](RefundsApi.md#create_refund) | **POST** /refunds | Create a refund |
+| [**get_refund**](RefundsApi.md#get_refund) | **GET** /refunds/{id} | Get a refund by ID |
+| [**list_refunds**](RefundsApi.md#list_refunds) | **GET** /refunds | List refunds for a Charge |
+
+
+## cancel_refund
+
+> <RefundResponse> cancel_refund(x_api_version, x_account_id, id)
+
+Cancel a refund
+
+### 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::RefundsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+id = 'id_example' # String | The ID of the refund to cancel.
+
+begin
+  # Cancel a refund
+  result = api_instance.cancel_refund(x_api_version, x_account_id, id)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling RefundsApi->cancel_refund: #{e}"
+end
+```
+
+#### Using the cancel_refund_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RefundResponse>, Integer, Hash)> cancel_refund_with_http_info(x_api_version, x_account_id, id)
+
+```ruby
+begin
+  # Cancel a refund
+  data, status_code, headers = api_instance.cancel_refund_with_http_info(x_api_version, x_account_id, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RefundResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling RefundsApi->cancel_refund_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **id** | **String** | The ID of the refund to cancel. |  |
+
+### Return type
+
+[**RefundResponse**](RefundResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_refund
+
+> <RefundResponse> create_refund(x_api_version, x_account_id, refund_attributes, opts)
+
+Create a refund
+
+### 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::RefundsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+refund_attributes = SubFiPay::RefundAttributes.new({charge_id: 'charge_id_example'}) # RefundAttributes | 
+opts = {
+  x_idempotency_key: 'x_idempotency_key_example' # String | 
+}
+
+begin
+  # Create a refund
+  result = api_instance.create_refund(x_api_version, x_account_id, refund_attributes, opts)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling RefundsApi->create_refund: #{e}"
+end
+```
+
+#### Using the create_refund_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RefundResponse>, Integer, Hash)> create_refund_with_http_info(x_api_version, x_account_id, refund_attributes, opts)
+
+```ruby
+begin
+  # Create a refund
+  data, status_code, headers = api_instance.create_refund_with_http_info(x_api_version, x_account_id, refund_attributes, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RefundResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling RefundsApi->create_refund_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **refund_attributes** | [**RefundAttributes**](RefundAttributes.md) |  |  |
+| **x_idempotency_key** | **String** |  | [optional] |
+
+### Return type
+
+[**RefundResponse**](RefundResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_refund
+
+> <RefundResponse> get_refund(x_api_version, x_account_id, id, opts)
+
+Get a refund 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::RefundsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+id = 'id_example' # String | The ID of the refund to retrieve.
+opts = {
+  connected_account_id: 'connected_account_id_example' # String | Filter results by sub_merchant ID.
+}
+
+begin
+  # Get a refund by ID
+  result = api_instance.get_refund(x_api_version, x_account_id, id, opts)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling RefundsApi->get_refund: #{e}"
+end
+```
+
+#### Using the get_refund_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RefundResponse>, Integer, Hash)> get_refund_with_http_info(x_api_version, x_account_id, id, opts)
+
+```ruby
+begin
+  # Get a refund by ID
+  data, status_code, headers = api_instance.get_refund_with_http_info(x_api_version, x_account_id, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RefundResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling RefundsApi->get_refund_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **id** | **String** | The ID of the refund to retrieve. |  |
+| **connected_account_id** | **String** | Filter results by sub_merchant ID. | [optional] |
+
+### Return type
+
+[**RefundResponse**](RefundResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_refunds
+
+> <ListRefundsResponse> list_refunds(x_api_version, x_account_id, charge_id)
+
+List refunds for 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::RefundsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+charge_id = 'charge_id_example' # String | The ID of the charge to which this refund belongs.
+
+begin
+  # List refunds for a Charge
+  result = api_instance.list_refunds(x_api_version, x_account_id, charge_id)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling RefundsApi->list_refunds: #{e}"
+end
+```
+
+#### Using the list_refunds_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListRefundsResponse>, Integer, Hash)> list_refunds_with_http_info(x_api_version, x_account_id, charge_id)
+
+```ruby
+begin
+  # List refunds for a Charge
+  data, status_code, headers = api_instance.list_refunds_with_http_info(x_api_version, x_account_id, charge_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListRefundsResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling RefundsApi->list_refunds_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **charge_id** | **String** | The ID of the charge to which this refund belongs. |  |
+
+### Return type
+
+[**ListRefundsResponse**](ListRefundsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RollAccessKeyAttributes.md

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

data/docs/RollAccessKeyAttributesAccessKey.md

@@ -0,0 +1,18 @@
+# SubFiPay::RollAccessKeyAttributesAccessKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::RollAccessKeyAttributesAccessKey.new(
+  expires_at: null
+)
+```
+

data/docs/RollAccessKeyRequest.md

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

data/docs/RollAccessKeyRequestAccessKey.md

@@ -0,0 +1,18 @@
+# SubFiPay::RollAccessKeyRequestAccessKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::RollAccessKeyRequestAccessKey.new(
+  expires_at: null
+)
+```
+

data/docs/SubscriptionAttributes.md

@@ -0,0 +1,30 @@
+# SubFiPay::SubscriptionAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connected_account_id** | **String** |  | [optional] |
+| **customer_id** | **String** |  | [optional] |
+| **payment_method_id** | **String** |  | [optional] |
+| **amount** | **Integer** |  | [optional] |
+| **interval** | **String** |  | [optional] |
+| **interval_count** | **Integer** |  | [optional] |
+| **next_payment_date** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::SubscriptionAttributes.new(
+  connected_account_id: null,
+  customer_id: null,
+  payment_method_id: null,
+  amount: null,
+  interval: null,
+  interval_count: null,
+  next_payment_date: null
+)
+```
+