subskribe_dev 1.1.0 → 1.2.0

data/docs/CustomizationApi.md

@@ -0,0 +1,244 @@
+# SubskribeDevClient::CustomizationApi
+
+All URIs are relative to *https://api.dev2.subskribe.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**compile_order_creation_customization_zeppa_script**](CustomizationApi.md#compile_order_creation_customization_zeppa_script) | **PUT** /beta/customization/orderCreationCustomization/compile | Compile and Verify a order creation customization for correctness
+[**compile_plan_selection_customization_zeppa_script**](CustomizationApi.md#compile_plan_selection_customization_zeppa_script) | **PUT** /beta/customization/planSelectionCustomization/compile | Compile and Verify a plan selection customization for correctness
+[**test_order_creation_customization_zeppa_script**](CustomizationApi.md#test_order_creation_customization_zeppa_script) | **PUT** /beta/customization/orderCreationCustomization/test | Test a order creation customization zeppa script
+[**test_plan_selection_customization_zeppa_script**](CustomizationApi.md#test_plan_selection_customization_zeppa_script) | **PUT** /beta/customization/planSelectionCustomization/test | Test a plan selection customization zeppa script
+
+
+# **compile_order_creation_customization_zeppa_script**
+> compile_order_creation_customization_zeppa_script(order_id, body, opts)
+
+Compile and Verify a order creation customization for correctness
+
+if this endpoint returns OK it means the plan order customization zeppa script has successfully compiled
+
+### 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::CustomizationApi.new
+
+order_id = 'order_id_example' # String | order id against which the compilation should happen
+
+body = 'body_example' # String | the zeppa script that needs to be compiled
+
+opts = { 
+  user_id: 'user_id_example' # String | order id against which the compilation should happen
+}
+
+begin
+  #Compile and Verify a order creation customization for correctness
+  api_instance.compile_order_creation_customization_zeppa_script(order_id, body, opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling CustomizationApi->compile_order_creation_customization_zeppa_script: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| order id against which the compilation should happen | 
+ **body** | **String**| the zeppa script that needs to be compiled | 
+ **user_id** | **String**| order id against which the compilation should happen | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **compile_plan_selection_customization_zeppa_script**
+> compile_plan_selection_customization_zeppa_script(account_id, body)
+
+Compile and Verify a plan selection customization for correctness
+
+if this endpoint returns OK it means the plan selection customization zeppa script has successfully compiled
+
+### 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::CustomizationApi.new
+
+account_id = 'account_id_example' # String | account id against which the compilation should happen
+
+body = 'body_example' # String | the zeppa script that needs to be compiled
+
+
+begin
+  #Compile and Verify a plan selection customization for correctness
+  api_instance.compile_plan_selection_customization_zeppa_script(account_id, body)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling CustomizationApi->compile_plan_selection_customization_zeppa_script: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| account id against which the compilation should happen | 
+ **body** | **String**| the zeppa script that needs to be compiled | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **test_order_creation_customization_zeppa_script**
+> test_order_creation_customization_zeppa_script(order_id, body, opts)
+
+Test a order creation customization zeppa script
+
+runs the provided zeppa script and returns a list of Rule actions that were applicable after zeppa script ran
+
+### 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::CustomizationApi.new
+
+order_id = 'order_id_example' # String | order id against which the test needs to happen
+
+body = 'body_example' # String | the zeppa script that needs to be tested
+
+opts = { 
+  user_id: 'user_id_example' # String | the user id against which this test needs to happen, the user should be part of the tenancy
+}
+
+begin
+  #Test a order creation customization zeppa script
+  api_instance.test_order_creation_customization_zeppa_script(order_id, body, opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling CustomizationApi->test_order_creation_customization_zeppa_script: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| order id against which the test needs to happen | 
+ **body** | **String**| the zeppa script that needs to be tested | 
+ **user_id** | **String**| the user id against which this test needs to happen, the user should be part of the tenancy | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+
+# **test_plan_selection_customization_zeppa_script**
+> test_plan_selection_customization_zeppa_script(account_id, body)
+
+Test a plan selection customization zeppa script
+
+runs the provided zeppa script and returns a list of Rule actions that were applicable after zeppa script ran
+
+### 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::CustomizationApi.new
+
+account_id = 'account_id_example' # String | account id against which the test needs to happen
+
+body = 'body_example' # String | the zeppa script that needs to be tested
+
+
+begin
+  #Test a plan selection customization zeppa script
+  api_instance.test_plan_selection_customization_zeppa_script(account_id, body)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling CustomizationApi->test_plan_selection_customization_zeppa_script: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| account id against which the test needs to happen | 
+ **body** | **String**| the zeppa script that needs to be tested | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: text/plain
+ - **Accept**: application/json
+
+
+

data/docs/DataImport.md

@@ -0,0 +1,19 @@
+# SubskribeDevClient::DataImport
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**import_id** | **String** |  | [optional] 
+**entity_ids** | **Array<String>** |  | [optional] 
+**file_name** | **String** |  | [optional] 
+**file_type** | **String** |  | [optional] 
+**file_size_bytes** | **Integer** |  | [optional] 
+**row_count** | **Integer** |  | [optional] 
+**imported_by** | **String** |  | [optional] 
+**imported_on** | **Integer** |  | [optional] 
+**domain** | **String** |  | [optional] 
+**operation** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**completed_on** | **Integer** |  | [optional] 
+
+

data/docs/DefaultApi.md

@@ -0,0 +1,225 @@
+# SubskribeDevClient::DefaultApi
+
+All URIs are relative to *https://api.dev2.subskribe.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_and_apply_payment**](DefaultApi.md#add_and_apply_payment) | **POST** /settlements/addAndApplyPayment | Apply a payment on a specific invoice
+[**get_order_document**](DefaultApi.md#get_order_document) | **GET** /documentLinks/{id} | 
+[**validate_address**](DefaultApi.md#validate_address) | **POST** /anrok/validate | Validate an address with Anrok
+[**validate_address1**](DefaultApi.md#validate_address1) | **POST** /taxjar/validate | Validate an address with TaxJar
+
+
+# **add_and_apply_payment**
+> add_and_apply_payment(body)
+
+Apply a payment on a specific invoice
+
+Apply a payment per the specified parameters.
+
+### 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::DefaultApi.new
+
+body = SubskribeDevClient::AddAndApplyPaymentApplicationJson.new # AddAndApplyPaymentApplicationJson | add and apply payment parameters in json
+
+
+begin
+  #Apply a payment on a specific invoice
+  api_instance.add_and_apply_payment(body)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling DefaultApi->add_and_apply_payment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AddAndApplyPaymentApplicationJson**](AddAndApplyPaymentApplicationJson.md)| add and apply payment parameters in json | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_order_document**
+> get_order_document(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::DefaultApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  api_instance.get_order_document(id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling DefaultApi->get_order_document: #{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**: text/html, application/json
+
+
+
+# **validate_address**
+> AccountAddress validate_address(opts)
+
+Validate an address with Anrok
+
+
+
+### 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::DefaultApi.new
+
+opts = { 
+  body: SubskribeDevClient::AccountAddress.new # AccountAddress | Address input as a JSON
+}
+
+begin
+  #Validate an address with Anrok
+  result = api_instance.validate_address(opts)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling DefaultApi->validate_address: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AccountAddress**](AccountAddress.md)| Address input as a JSON | [optional] 
+
+### Return type
+
+[**AccountAddress**](AccountAddress.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **validate_address1**
+> AccountAddress validate_address1(opts)
+
+Validate an address with TaxJar
+
+Returns a suggested addresses if found
+
+### 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::DefaultApi.new
+
+opts = { 
+  body: SubskribeDevClient::AccountAddress.new # AccountAddress | Address input as a JSON
+}
+
+begin
+  #Validate an address with TaxJar
+  result = api_instance.validate_address1(opts)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling DefaultApi->validate_address1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AccountAddress**](AccountAddress.md)| Address input as a JSON | [optional] 
+
+### Return type
+
+[**AccountAddress**](AccountAddress.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/DiscountDetailJson.md

@@ -0,0 +1,13 @@
+# SubskribeDevClient::DiscountDetailJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**percent** | **Float** |  | [optional] 
+**discount_amount** | **Float** |  | [optional] 
+**status** | **String** |  | [optional] 
+**discounted_price** | **Float** |  | [optional] 
+**amount** | **Float** |  | [optional] 
+
+

data/docs/DiscountJson.md

@@ -0,0 +1,12 @@
+# SubskribeDevClient::DiscountJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**percent** | **Float** |  | [optional] 
+**discount_amount** | **Float** |  | [optional] 
+**status** | **String** |  | [optional] 
+**discounted_price** | **Float** |  | [optional] 
+
+