subskribe_dev 1.1.0 → 1.3.0

data/docs/EntitiesApi.md

@@ -0,0 +1,561 @@
+# SubskribeDevClient::EntitiesApi
+
+All URIs are relative to *https://api.app.subskribe.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**account_entity_migration**](EntitiesApi.md#account_entity_migration) | **POST** /entities/migrate/account | Move account to a target entity
+[**composite_order_entity_migration**](EntitiesApi.md#composite_order_entity_migration) | **POST** /entities/migrate/compositeOrder | Move composite order to a target entity
+[**create**](EntitiesApi.md#create) | **POST** /entities | Create an entity
+[**delete_entity**](EntitiesApi.md#delete_entity) | **DELETE** /entities/{id} | Delete entity
+[**get_entities**](EntitiesApi.md#get_entities) | **GET** /entities | Gets entities
+[**get_entity_by_id**](EntitiesApi.md#get_entity_by_id) | **GET** /entities/{id} | Gets entity details
+[**get_logo**](EntitiesApi.md#get_logo) | **GET** /entities/logo/{entityId} | Get entity logo
+[**order_entity_migration**](EntitiesApi.md#order_entity_migration) | **POST** /entities/migrate/order | Update order entity
+[**subscription_entity_migration**](EntitiesApi.md#subscription_entity_migration) | **POST** /entities/migrate/subscription | Move subscription to a target entity
+[**upload_logo**](EntitiesApi.md#upload_logo) | **PUT** /entities/logo/{entityId} | Update entity logo
+
+
+# **account_entity_migration**
+> account_entity_migration(opts)
+
+Move account to a target entity
+
+Move account along with its subscriptions, orders, invoices and other associated transactions to a target entity
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntitiesApi.new
+
+opts = { 
+  target_entity_id: 'target_entity_id_example', # String | 
+  account_id: 'account_id_example' # String | 
+}
+
+begin
+  #Move account to a target entity
+  api_instance.account_entity_migration(opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntitiesApi->account_entity_migration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **target_entity_id** | **String**|  | [optional] 
+ **account_id** | **String**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **composite_order_entity_migration**
+> composite_order_entity_migration(opts)
+
+Move composite order to a target entity
+
+Move composite order along with its subscriptions, orders and other associated transactions to a target entity
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntitiesApi.new
+
+opts = { 
+  target_entity_id: 'target_entity_id_example', # String | 
+  composite_order_id: 'composite_order_id_example' # String | 
+}
+
+begin
+  #Move composite order to a target entity
+  api_instance.composite_order_entity_migration(opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntitiesApi->composite_order_entity_migration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **target_entity_id** | **String**|  | [optional] 
+ **composite_order_id** | **String**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **create**
+> create(opts)
+
+Create an entity
+
+Create an entity. On success return the created entity.
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntitiesApi.new
+
+opts = { 
+  body: SubskribeDevClient::EntityJson.new # EntityJson | entity
+}
+
+begin
+  #Create an entity
+  api_instance.create(opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntitiesApi->create: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**EntityJson**](EntityJson.md)| entity | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_entity**
+> delete_entity(id)
+
+Delete entity
+
+Delete the entity if there is no data associated with it.
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntitiesApi.new
+
+id = 'id_example' # String | entity id
+
+
+begin
+  #Delete entity
+  api_instance.delete_entity(id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntitiesApi->delete_entity: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| entity id | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_entities**
+> Array<EntityJson> get_entities
+
+Gets entities
+
+Gets all entities
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntitiesApi.new
+
+begin
+  #Gets entities
+  result = api_instance.get_entities
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntitiesApi->get_entities: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<EntityJson>**](EntityJson.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_entity_by_id**
+> Entity get_entity_by_id(id)
+
+Gets entity details
+
+Gets the entity details of the specified entity id
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntitiesApi.new
+
+id = 'id_example' # String | entity id
+
+
+begin
+  #Gets entity details
+  result = api_instance.get_entity_by_id(id)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntitiesApi->get_entity_by_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| entity id | 
+
+### Return type
+
+[**Entity**](Entity.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_logo**
+> get_logo(entity_id)
+
+Get entity logo
+
+Get the current logo stored for the given entity
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntitiesApi.new
+
+entity_id = 'entity_id_example' # String | 
+
+
+begin
+  #Get entity logo
+  api_instance.get_logo(entity_id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntitiesApi->get_logo: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **entity_id** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: image/png, application/json
+
+
+
+# **order_entity_migration**
+> order_entity_migration(opts)
+
+Update order entity
+
+Move order to a target entity
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntitiesApi.new
+
+opts = { 
+  target_entity_id: 'target_entity_id_example', # String | 
+  order_id: 'order_id_example' # String | 
+}
+
+begin
+  #Update order entity
+  api_instance.order_entity_migration(opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntitiesApi->order_entity_migration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **target_entity_id** | **String**|  | [optional] 
+ **order_id** | **String**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **subscription_entity_migration**
+> subscription_entity_migration(opts)
+
+Move subscription to a target entity
+
+Move subscription and associated transactions to a target entity
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntitiesApi.new
+
+opts = { 
+  target_entity_id: 'target_entity_id_example', # String | 
+  subscription_id: 'subscription_id_example' # String | 
+}
+
+begin
+  #Move subscription to a target entity
+  api_instance.subscription_entity_migration(opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntitiesApi->subscription_entity_migration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **target_entity_id** | **String**|  | [optional] 
+ **subscription_id** | **String**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **upload_logo**
+> upload_logo(entity_id, opts)
+
+Update entity logo
+
+Updates the logo used in external facing communication such as order forms and invoices
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntitiesApi.new
+
+entity_id = 'entity_id_example' # String | 
+
+opts = { 
+  file: File.new('/path/to/file.txt') # File | 
+}
+
+begin
+  #Update entity logo
+  api_instance.upload_logo(entity_id, opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntitiesApi->upload_logo: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **entity_id** | **String**|  | 
+ **file** | **File**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+

data/docs/Entity.md

@@ -0,0 +1,22 @@
+# SubskribeDevClient::Entity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**tenant_id** | **String** |  | [optional] 
+**entity_id** | **String** |  | [optional] 
+**display_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**proration_scheme** | **String** |  | [optional] 
+**proration_mode** | **String** |  | [optional] 
+**invoice_config_id** | **String** |  | [optional] 
+**invoice_config** | [**NumberConfig**](NumberConfig.md) |  | [optional] 
+**timezone** | [**TimeZone**](TimeZone.md) |  | [optional] 
+**functional_currency** | **String** |  | [optional] 
+**wire_instruction** | **String** |  | [optional] 
+**company_contact** | [**AccountContact**](AccountContact.md) |  | [optional] 
+**account_receivable_contact** | [**AccountContact**](AccountContact.md) |  | [optional] 
+**erp_id** | **String** |  | [optional] 
+
+

data/docs/EntityApi.md

@@ -0,0 +1,66 @@
+# SubskribeDevClient::EntityApi
+
+All URIs are relative to *https://api.dev2.subskribe.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**upload_logo**](EntityApi.md#upload_logo) | **PUT** /entities/logo/{entityId} | Update entity logo
+
+
+# **upload_logo**
+> upload_logo(entity_id, opts)
+
+Update entity logo
+
+Updates the logo used in external facing communication such as order forms and invoices
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_dev'
+# setup authorization
+SubskribeDevClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
+end
+
+api_instance = SubskribeDevClient::EntityApi.new
+
+entity_id = 'entity_id_example' # String | 
+
+opts = { 
+  file: File.new('/path/to/file.txt') # File | 
+}
+
+begin
+  #Update entity logo
+  api_instance.upload_logo(entity_id, opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling EntityApi->upload_logo: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **entity_id** | **String**|  | 
+ **file** | **File**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+

data/docs/EntityJson.md

@@ -0,0 +1,21 @@
+# SubskribeDevClient::EntityJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_id** | **String** |  | [optional] 
+**display_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**proration_scheme** | **String** |  | [optional] 
+**proration_mode** | **String** |  | [optional] 
+**invoice_config_id** | **String** |  | [optional] 
+**invoice_config** | [**NumberConfig**](NumberConfig.md) |  | [optional] 
+**credit_memo_config** | [**NumberConfig**](NumberConfig.md) |  | [optional] 
+**timezone** | **String** |  | [optional] 
+**functional_currency** | **String** |  | [optional] 
+**wire_instruction** | **String** |  | [optional] 
+**company_contact** | [**CompanyContactJson**](CompanyContactJson.md) |  | [optional] 
+**account_receivable_contact** | [**AccountReceivableContactJson**](AccountReceivableContactJson.md) |  | [optional] 
+**erp_id** | **String** |  | [optional] 
+
+

data/docs/EntityRef.md

@@ -0,0 +1,10 @@
+# SubskribeDevClient::EntityRef
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_id** | **String** |  | [optional] 
+**display_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/Entry.md

@@ -0,0 +1,10 @@
+# SubskribeDevClient::Entry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**row_number** | **Integer** |  | [optional] 
+**failed** | **BOOLEAN** |  | [optional] 
+**failure_reason** | **String** |  | [optional] 
+
+

data/docs/ExternalArrScheduleJson.md

@@ -0,0 +1,17 @@
+# SubskribeDevClient::ExternalArrScheduleJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**external_id** | **String** |  | [optional] 
+**start_date** | **Integer** |  | 
+**end_date** | **Integer** |  | 
+**category** | **String** |  | [optional] 
+**amount** | **Float** |  | 
+**quantity** | **Integer** |  | 
+**previous_schedule_id** | **String** |  | [optional] 
+**metadata** | **String** |  | [optional] 
+**submitted_by** | **String** |  | [optional] 
+
+