subskribe_dev 1.1.0 → 1.3.0

data/docs/DiscountsApi.md

@@ -0,0 +1,337 @@
+# SubskribeDevClient::DiscountsApi
+
+All URIs are relative to *https://api.app.subskribe.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_discount**](DiscountsApi.md#add_discount) | **POST** /discounts | Create a discount
+[**delete_discount**](DiscountsApi.md#delete_discount) | **DELETE** /discounts/{id} | Delete a discount
+[**get_discount**](DiscountsApi.md#get_discount) | **GET** /discounts/{id} | Get discount
+[**get_discounts**](DiscountsApi.md#get_discounts) | **GET** /discounts | Get discounts
+[**update_discount**](DiscountsApi.md#update_discount) | **PUT** /discounts/{id} | Update discount details
+[**update_discount_status**](DiscountsApi.md#update_discount_status) | **PUT** /discounts/{id}/status/{status} | Update discount status
+
+
+# **add_discount**
+> String add_discount(opts)
+
+Create a discount
+
+Creates a discount with the specified details. On success, the ID of the new discount is returned.
+
+### 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::DiscountsApi.new
+
+opts = { 
+  body: SubskribeDevClient::DiscountJson.new # DiscountJson | details of the discount
+}
+
+begin
+  #Create a discount
+  result = api_instance.add_discount(opts)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling DiscountsApi->add_discount: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**DiscountJson**](DiscountJson.md)| details of the discount | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_discount**
+> delete_discount(id)
+
+Delete a discount
+
+Deletes a discount. Note that a discount may not be deleted if it is in use.
+
+### 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::DiscountsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  #Delete a discount
+  api_instance.delete_discount(id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling DiscountsApi->delete_discount: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_discount**
+> DiscountJson get_discount(id)
+
+Get discount
+
+Returns the details of the specified discount.
+
+### 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::DiscountsApi.new
+
+id = 'id_example' # String | id of the discount
+
+
+begin
+  #Get discount
+  result = api_instance.get_discount(id)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling DiscountsApi->get_discount: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id of the discount | 
+
+### Return type
+
+[**DiscountJson**](DiscountJson.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_discounts**
+> Array<DiscountJson> get_discounts
+
+Get discounts
+
+Returns all discounts that have been defined
+
+### 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::DiscountsApi.new
+
+begin
+  #Get discounts
+  result = api_instance.get_discounts
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling DiscountsApi->get_discounts: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<DiscountJson>**](DiscountJson.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_discount**
+> update_discount(id, opts)
+
+Update discount details
+
+Updates the details of the specified discount. Note that a discount cannot be updated once it is in use by an order.
+
+### 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::DiscountsApi.new
+
+id = 'id_example' # String | id of the discount
+
+opts = { 
+  body: SubskribeDevClient::DiscountJson.new # DiscountJson | 
+}
+
+begin
+  #Update discount details
+  api_instance.update_discount(id, opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling DiscountsApi->update_discount: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id of the discount | 
+ **body** | [**DiscountJson**](DiscountJson.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_discount_status**
+> update_discount_status(id, status)
+
+Update discount status
+
+Updates the status of a discount
+
+### 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::DiscountsApi.new
+
+id = 'id_example' # String | id of the discount
+
+status = 'status_example' # String | new status to set
+
+
+begin
+  #Update discount status
+  api_instance.update_discount_status(id, status)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling DiscountsApi->update_discount_status: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id of the discount | 
+ **status** | **String**| new status to set | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DocuSignIntegrationRequestJson.md

@@ -0,0 +1,10 @@
+# SubskribeDevClient::DocuSignIntegrationRequestJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** |  | [optional] 
+**client_secret** | **String** |  | [optional] 
+**environment** | **String** |  | [optional] 
+
+

data/docs/DocuSignIntegrationResponseJson.md

@@ -0,0 +1,11 @@
+# SubskribeDevClient::DocuSignIntegrationResponseJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **String** |  | [optional] 
+**integration_id** | **String** |  | [optional] 
+**environment** | **String** |  | [optional] 
+**is_completed** | **BOOLEAN** |  | [optional] 
+
+

data/docs/DocumentCustomContent.md

@@ -0,0 +1,11 @@
+# SubskribeDevClient::DocumentCustomContent
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**order_id** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+**content** | **String** |  | [optional] 
+
+

data/docs/DocumentSection.md

@@ -0,0 +1,13 @@
+# SubskribeDevClient::DocumentSection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**entity_ids** | **Array<String>** |  | [optional] 
+**name** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+**location** | **String** |  | [optional] 
+**deleted** | **BOOLEAN** |  | [optional] 
+
+

data/docs/DocumentTemplateJson.md

@@ -0,0 +1,15 @@
+# SubskribeDevClient::DocumentTemplateJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**entity_ids** | **Array<String>** |  | [optional] 
+**name** | **String** |  | [optional] 
+**section_uuid** | **String** |  | [optional] 
+**type** | **String** |  | 
+**description** | **String** |  | [optional] 
+**content** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+

data/docs/DunningSettingJson.md

@@ -0,0 +1,9 @@
+# SubskribeDevClient::DunningSettingJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_enabled** | **BOOLEAN** |  | 
+**dunning_type_map** | **Hash<String, BOOLEAN>** |  | [optional] 
+
+

data/docs/ERPApi.md

@@ -0,0 +1,278 @@
+# SubskribeDevClient::ERPApi
+
+All URIs are relative to *https://api.app.subskribe.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**process_delete_tasks**](ERPApi.md#process_delete_tasks) | **POST** /erp/processDeleteTasks/{accountingPeriodId} | Trigger ERP journal entry deletion task
+[**process_sync_tasks**](ERPApi.md#process_sync_tasks) | **POST** /erp/processSyncTasks/{accountingPeriodId} | Trigger ERP journal entry sync task
+[**sync_credit_memo_to_erp**](ERPApi.md#sync_credit_memo_to_erp) | **POST** /erp/syncCreditMemo/{creditMemoNumber} | Trigger ERP credit memo sync task
+[**sync_invoice_to_erp**](ERPApi.md#sync_invoice_to_erp) | **POST** /erp/syncInvoice/{invoiceId} | Trigger ERP invoice sync task
+[**sync_void_invoice_to_erp**](ERPApi.md#sync_void_invoice_to_erp) | **POST** /erp/syncVoidInvoice/{invoiceNumber} | Trigger ERP void invoice sync task
+
+
+# **process_delete_tasks**
+> process_delete_tasks(accounting_period_id)
+
+Trigger ERP journal entry deletion task
+
+Trigger ERP journal entry deletion task for the given accounting period 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::ERPApi.new
+
+accounting_period_id = 'accounting_period_id_example' # String | 
+
+
+begin
+  #Trigger ERP journal entry deletion task
+  api_instance.process_delete_tasks(accounting_period_id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling ERPApi->process_delete_tasks: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accounting_period_id** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **process_sync_tasks**
+> process_sync_tasks(accounting_period_id)
+
+Trigger ERP journal entry sync task
+
+Trigger ERP journal entry sync task for given accounting period 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::ERPApi.new
+
+accounting_period_id = 'accounting_period_id_example' # String | 
+
+
+begin
+  #Trigger ERP journal entry sync task
+  api_instance.process_sync_tasks(accounting_period_id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling ERPApi->process_sync_tasks: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accounting_period_id** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **sync_credit_memo_to_erp**
+> sync_credit_memo_to_erp(credit_memo_number)
+
+Trigger ERP credit memo sync task
+
+Trigger ERP credit memo sync task for the given credit memo number
+
+### 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::ERPApi.new
+
+credit_memo_number = 'credit_memo_number_example' # String | 
+
+
+begin
+  #Trigger ERP credit memo sync task
+  api_instance.sync_credit_memo_to_erp(credit_memo_number)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling ERPApi->sync_credit_memo_to_erp: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **credit_memo_number** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **sync_invoice_to_erp**
+> sync_invoice_to_erp(invoice_id)
+
+Trigger ERP invoice sync task
+
+Trigger ERP invoice sync task for the given invoice 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::ERPApi.new
+
+invoice_id = 'invoice_id_example' # String | 
+
+
+begin
+  #Trigger ERP invoice sync task
+  api_instance.sync_invoice_to_erp(invoice_id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling ERPApi->sync_invoice_to_erp: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **invoice_id** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **sync_void_invoice_to_erp**
+> sync_void_invoice_to_erp(invoice_number)
+
+Trigger ERP void invoice sync task
+
+Trigger ERP void invoice sync task for the given invoice number
+
+### 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::ERPApi.new
+
+invoice_number = 'invoice_number_example' # String | 
+
+
+begin
+  #Trigger ERP void invoice sync task
+  api_instance.sync_void_invoice_to_erp(invoice_number)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling ERPApi->sync_void_invoice_to_erp: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **invoice_number** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/EmailNotifiersList.md

@@ -0,0 +1,10 @@
+# SubskribeDevClient::EmailNotifiersList
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to_ids** | **Array<String>** |  | [optional] 
+**cc_ids** | **Array<String>** |  | [optional] 
+**bcc_ids** | **Array<String>** |  | [optional] 
+
+