subfi_pay 0.1.0

data/docs/SubscriptionAttributesSubscription.md

@@ -0,0 +1,30 @@
+# SubFiPay::SubscriptionAttributesSubscription
+
+## 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::SubscriptionAttributesSubscription.new(
+  connected_account_id: null,
+  customer_id: null,
+  payment_method_id: null,
+  amount: null,
+  interval: null,
+  interval_count: null,
+  next_payment_date: null
+)
+```
+

data/docs/SubscriptionCreateRequest.md

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

data/docs/SubscriptionCreateRequestSubscription.md

@@ -0,0 +1,30 @@
+# SubFiPay::SubscriptionCreateRequestSubscription
+
+## 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::SubscriptionCreateRequestSubscription.new(
+  connected_account_id: null,
+  customer_id: null,
+  payment_method_id: null,
+  amount: null,
+  interval: null,
+  interval_count: null,
+  next_payment_date: null
+)
+```
+

data/docs/SubscriptionResponse.md

@@ -0,0 +1,36 @@
+# SubFiPay::SubscriptionResponse
+
+## 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] |
+| **state** | **String** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'subfi_pay'
+
+instance = SubFiPay::SubscriptionResponse.new(
+  connected_account_id: null,
+  customer_id: null,
+  payment_method_id: null,
+  amount: null,
+  interval: null,
+  interval_count: null,
+  next_payment_date: null,
+  state: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/SubscriptionsApi.md

@@ -0,0 +1,155 @@
+# SubFiPay::SubscriptionsApi
+
+All URIs are relative to *https://pay-sandbox.subfi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_subscription**](SubscriptionsApi.md#create_subscription) | **POST** /subscriptions | Create a new subscription |
+| [**get_subscription**](SubscriptionsApi.md#get_subscription) | **GET** /subscriptions/{id} | Retrieve a subscription by ID |
+
+
+## create_subscription
+
+> <SubscriptionResponse> create_subscription(x_api_version, x_account_id, subscription_create_request)
+
+Create a new subscription
+
+### 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::SubscriptionsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+subscription_create_request = SubFiPay::SubscriptionCreateRequest.new # SubscriptionCreateRequest | 
+
+begin
+  # Create a new subscription
+  result = api_instance.create_subscription(x_api_version, x_account_id, subscription_create_request)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling SubscriptionsApi->create_subscription: #{e}"
+end
+```
+
+#### Using the create_subscription_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriptionResponse>, Integer, Hash)> create_subscription_with_http_info(x_api_version, x_account_id, subscription_create_request)
+
+```ruby
+begin
+  # Create a new subscription
+  data, status_code, headers = api_instance.create_subscription_with_http_info(x_api_version, x_account_id, subscription_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriptionResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling SubscriptionsApi->create_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **subscription_create_request** | [**SubscriptionCreateRequest**](SubscriptionCreateRequest.md) |  |  |
+
+### Return type
+
+[**SubscriptionResponse**](SubscriptionResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_subscription
+
+> <SubscriptionResponse> get_subscription(x_api_version, x_account_id, id)
+
+Retrieve a subscription 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::SubscriptionsApi.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 subscription to retrieve
+
+begin
+  # Retrieve a subscription by ID
+  result = api_instance.get_subscription(x_api_version, x_account_id, id)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling SubscriptionsApi->get_subscription: #{e}"
+end
+```
+
+#### Using the get_subscription_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriptionResponse>, Integer, Hash)> get_subscription_with_http_info(x_api_version, x_account_id, id)
+
+```ruby
+begin
+  # Retrieve a subscription by ID
+  data, status_code, headers = api_instance.get_subscription_with_http_info(x_api_version, x_account_id, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriptionResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling SubscriptionsApi->get_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **id** | **String** | The ID of the subscription to retrieve |  |
+
+### Return type
+
+[**SubscriptionResponse**](SubscriptionResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/WebhookEndpoint.md

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

data/docs/WebhookEndpointsApi.md

@@ -0,0 +1,380 @@
+# SubFiPay::WebhookEndpointsApi
+
+All URIs are relative to *https://pay-sandbox.subfi.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_webhook_endpoint**](WebhookEndpointsApi.md#create_webhook_endpoint) | **POST** /webhook_endpoints | Create a webhook endpoint |
+| [**delete_webhook_endpoint**](WebhookEndpointsApi.md#delete_webhook_endpoint) | **DELETE** /webhook_endpoints/{id} | Delete a webhook endpoint by ID |
+| [**get_webhook_endpoint**](WebhookEndpointsApi.md#get_webhook_endpoint) | **GET** /webhook_endpoints/{id} | Retrieve a webhook endpoint by ID |
+| [**list_webhook_endpoints**](WebhookEndpointsApi.md#list_webhook_endpoints) | **GET** /webhook_endpoints | List all webhook endpoints |
+| [**update_webhook_endpoint**](WebhookEndpointsApi.md#update_webhook_endpoint) | **PATCH** /webhook_endpoints/{id} | Update a webhook endpoint by ID |
+
+
+## create_webhook_endpoint
+
+> <WebhookEndpoint> create_webhook_endpoint(x_api_version, create_webhook_endpoint_request)
+
+Create a webhook endpoint
+
+### 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::WebhookEndpointsApi.new
+x_api_version = 'x_api_version_example' # String | 
+create_webhook_endpoint_request = SubFiPay::CreateWebhookEndpointRequest.new # CreateWebhookEndpointRequest | 
+
+begin
+  # Create a webhook endpoint
+  result = api_instance.create_webhook_endpoint(x_api_version, create_webhook_endpoint_request)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->create_webhook_endpoint: #{e}"
+end
+```
+
+#### Using the create_webhook_endpoint_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookEndpoint>, Integer, Hash)> create_webhook_endpoint_with_http_info(x_api_version, create_webhook_endpoint_request)
+
+```ruby
+begin
+  # Create a webhook endpoint
+  data, status_code, headers = api_instance.create_webhook_endpoint_with_http_info(x_api_version, create_webhook_endpoint_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookEndpoint>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->create_webhook_endpoint_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **create_webhook_endpoint_request** | [**CreateWebhookEndpointRequest**](CreateWebhookEndpointRequest.md) |  |  |
+
+### Return type
+
+[**WebhookEndpoint**](WebhookEndpoint.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_webhook_endpoint
+
+> delete_webhook_endpoint(x_api_version, x_account_id, id)
+
+Delete a webhook endpoint 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::WebhookEndpointsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+id = 'id_example' # String | 
+
+begin
+  # Delete a webhook endpoint by ID
+  api_instance.delete_webhook_endpoint(x_api_version, x_account_id, id)
+rescue SubFiPay::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->delete_webhook_endpoint: #{e}"
+end
+```
+
+#### Using the delete_webhook_endpoint_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_webhook_endpoint_with_http_info(x_api_version, x_account_id, id)
+
+```ruby
+begin
+  # Delete a webhook endpoint by ID
+  data, status_code, headers = api_instance.delete_webhook_endpoint_with_http_info(x_api_version, x_account_id, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue SubFiPay::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->delete_webhook_endpoint_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_webhook_endpoint
+
+> <WebhookEndpoint> get_webhook_endpoint(x_api_version, x_account_id, id)
+
+Retrieve a webhook endpoint 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::WebhookEndpointsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+id = 'id_example' # String | 
+
+begin
+  # Retrieve a webhook endpoint by ID
+  result = api_instance.get_webhook_endpoint(x_api_version, x_account_id, id)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->get_webhook_endpoint: #{e}"
+end
+```
+
+#### Using the get_webhook_endpoint_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookEndpoint>, Integer, Hash)> get_webhook_endpoint_with_http_info(x_api_version, x_account_id, id)
+
+```ruby
+begin
+  # Retrieve a webhook endpoint by ID
+  data, status_code, headers = api_instance.get_webhook_endpoint_with_http_info(x_api_version, x_account_id, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookEndpoint>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->get_webhook_endpoint_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**WebhookEndpoint**](WebhookEndpoint.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_webhook_endpoints
+
+> <ListWebhookEndpointsResponse> list_webhook_endpoints(x_api_version, x_account_id, opts)
+
+List all webhook endpoints
+
+### 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::WebhookEndpointsApi.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.
+}
+
+begin
+  # List all webhook endpoints
+  result = api_instance.list_webhook_endpoints(x_api_version, x_account_id, opts)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->list_webhook_endpoints: #{e}"
+end
+```
+
+#### Using the list_webhook_endpoints_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListWebhookEndpointsResponse>, Integer, Hash)> list_webhook_endpoints_with_http_info(x_api_version, x_account_id, opts)
+
+```ruby
+begin
+  # List all webhook endpoints
+  data, status_code, headers = api_instance.list_webhook_endpoints_with_http_info(x_api_version, x_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListWebhookEndpointsResponse>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->list_webhook_endpoints_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] |
+
+### Return type
+
+[**ListWebhookEndpointsResponse**](ListWebhookEndpointsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_webhook_endpoint
+
+> <WebhookEndpoint> update_webhook_endpoint(x_api_version, x_account_id, id, create_webhook_endpoint_request)
+
+Update a webhook endpoint 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::WebhookEndpointsApi.new
+x_api_version = 'x_api_version_example' # String | 
+x_account_id = 'x_account_id_example' # String | 
+id = 'id_example' # String | 
+create_webhook_endpoint_request = SubFiPay::CreateWebhookEndpointRequest.new # CreateWebhookEndpointRequest | 
+
+begin
+  # Update a webhook endpoint by ID
+  result = api_instance.update_webhook_endpoint(x_api_version, x_account_id, id, create_webhook_endpoint_request)
+  p result
+rescue SubFiPay::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->update_webhook_endpoint: #{e}"
+end
+```
+
+#### Using the update_webhook_endpoint_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookEndpoint>, Integer, Hash)> update_webhook_endpoint_with_http_info(x_api_version, x_account_id, id, create_webhook_endpoint_request)
+
+```ruby
+begin
+  # Update a webhook endpoint by ID
+  data, status_code, headers = api_instance.update_webhook_endpoint_with_http_info(x_api_version, x_account_id, id, create_webhook_endpoint_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookEndpoint>
+rescue SubFiPay::ApiError => e
+  puts "Error when calling WebhookEndpointsApi->update_webhook_endpoint_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_api_version** | **String** |  |  |
+| **x_account_id** | **String** |  |  |
+| **id** | **String** |  |  |
+| **create_webhook_endpoint_request** | [**CreateWebhookEndpointRequest**](CreateWebhookEndpointRequest.md) |  |  |
+
+### Return type
+
+[**WebhookEndpoint**](WebhookEndpoint.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+