subskribe_sandbox 1.0.0

data/docs/InvoiceBalanceJson.md

@@ -0,0 +1,11 @@
+# SubskribeSandboxClient::InvoiceBalanceJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** |  | [optional] 
+**invoice_number** | **String** |  | [optional] 
+**balance** | **Float** |  | [optional] 
+**updated_on** | **Integer** |  | [optional] 
+
+

data/docs/InvoiceItemJson.md

@@ -0,0 +1,27 @@
+# SubskribeSandboxClient::InvoiceItemJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**plan_id** | **String** |  | [optional] 
+**charge_id** | **String** |  | [optional] 
+**order_id** | **String** |  | [optional] 
+**order_line_item_id** | **String** |  | [optional] 
+**subscription_charge_id** | **String** |  | [optional] 
+**subscription_charge_group_id** | **String** |  | [optional] 
+**list_amount** | **Float** |  | [optional] 
+**discount_amount** | **Float** |  | [optional] 
+**amount** | **Float** |  | [optional] 
+**tax_amount** | **Float** |  | [optional] 
+**tax_rate** | [**TaxRateJson**](TaxRateJson.md) |  | [optional] 
+**list_unit_price** | **Float** |  | [optional] 
+**sell_unit_price** | **Float** |  | [optional] 
+**quantity** | **Integer** |  | [optional] 
+**drawdown_quantity_used** | **Integer** |  | [optional] 
+**drawdown_quantity_remaining** | **Integer** |  | [optional] 
+**period_start_date** | **Integer** |  | [optional] 
+**period_end_date** | **Integer** |  | [optional] 
+**is_billed** | **BOOLEAN** |  | [optional] 
+
+

data/docs/InvoiceItemPreviewJson.md

@@ -0,0 +1,13 @@
+# SubskribeSandboxClient::InvoiceItemPreviewJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_line_item_id** | **String** |  | [optional] 
+**amount** | **Float** |  | [optional] 
+**list_amount** | **Float** |  | [optional] 
+**discount_amount** | **Float** |  | [optional] 
+**list_unit_price** | **Float** |  | [optional] 
+**sell_unit_price** | **Float** |  | [optional] 
+
+

data/docs/InvoiceJson.md

@@ -0,0 +1,31 @@
+# SubskribeSandboxClient::InvoiceJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invoice_number** | **String** |  | [optional] 
+**posted_date** | **Integer** |  | [optional] 
+**invoice_date** | **Integer** |  | [optional] 
+**voided_date** | **Integer** |  | [optional] 
+**due_date** | **Integer** |  | [optional] 
+**currency** | **String** |  | [optional] 
+**payment_term** | **String** |  | [optional] 
+**total_discount** | **Float** |  | [optional] 
+**sub_total** | **Float** |  | [optional] 
+**tax_total** | **Float** |  | [optional] 
+**tax_transaction_code** | **String** |  | [optional] 
+**total** | **Float** |  | [optional] 
+**subscription_id** | **String** |  | [optional] 
+**account_id** | **String** |  | [optional] 
+**invoice_items** | [**Array<InvoiceItemJson>**](InvoiceItemJson.md) |  | [optional] 
+**billing_contact** | [**AccountContactJson**](AccountContactJson.md) |  | [optional] 
+**shipping_contact** | [**AccountContactJson**](AccountContactJson.md) |  | [optional] 
+**status** | **String** |  | [optional] 
+**purchase_order_number** | **String** |  | [optional] 
+**purchase_order_required** | **BOOLEAN** |  | [optional] 
+**note** | **String** |  | [optional] 
+**email_notifiers_list** | [**EmailNotifiersList**](EmailNotifiersList.md) |  | [optional] 
+**erp_id** | **String** |  | [optional] 
+**generation_method** | **String** |  | [optional] 
+
+

data/docs/InvoiceJsonPaginationResponse.md

@@ -0,0 +1,10 @@
+# SubskribeSandboxClient::InvoiceJsonPaginationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<InvoiceJson>**](InvoiceJson.md) |  | [optional] 
+**num_elements** | **Integer** |  | [optional] 
+**next_cursor** | **String** |  | [optional] 
+
+

data/docs/InvoiceNumberPrefix.md

@@ -0,0 +1,8 @@
+# SubskribeSandboxClient::InvoiceNumberPrefix
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**prefix** | **String** |  | [optional] 
+
+

data/docs/InvoicePreviewJson.md

@@ -0,0 +1,12 @@
+# SubskribeSandboxClient::InvoicePreviewJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_id** | **String** |  | [optional] 
+**line_items** | [**Array<InvoiceItemPreviewJson>**](InvoiceItemPreviewJson.md) |  | [optional] 
+**total** | **Float** |  | [optional] 
+**total_discount** | **Float** |  | [optional] 
+**created_on** | **Integer** |  | [optional] 
+
+

data/docs/LedgerAccount.md

@@ -0,0 +1,16 @@
+# SubskribeSandboxClient::LedgerAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**entity_ids** | **Array<String>** |  | [optional] 
+**name** | **String** |  | [optional] 
+**account_code** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**account_type** | **String** |  | [optional] 
+**is_default** | **BOOLEAN** |  | [optional] 
+**in_use** | **BOOLEAN** |  | [optional] 
+**default** | **BOOLEAN** |  | [optional] 
+**id** | **String** |  | [optional] 
+
+

data/docs/LedgerAccountMapping.md

@@ -0,0 +1,12 @@
+# SubskribeSandboxClient::LedgerAccountMapping
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tax_liability_account_id** | **String** |  | [optional] 
+**deferred_revenue_account_id** | **String** |  | [optional] 
+**recognized_revenue_account_id** | **String** |  | [optional] 
+**contract_asset_account_id** | **String** |  | [optional] 
+**ledger_account_ids** | **Array<String>** |  | [optional] 
+
+

data/docs/MetricsJson.md

@@ -0,0 +1,17 @@
+# SubskribeSandboxClient::MetricsJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tcv** | **Float** |  | [optional] 
+**recurring_total** | **Float** |  | [optional] 
+**non_recurring_total** | **Float** |  | [optional] 
+**arr** | **Float** |  | [optional] 
+**entry_arr** | **Float** |  | [optional] 
+**exit_arr** | **Float** |  | [optional] 
+**average_arr** | **Float** |  | [optional] 
+**arr_trend** | [**Array<TimeSeriesAmountJson>**](TimeSeriesAmountJson.md) |  | [optional] 
+**delta_tcv** | **Float** |  | [optional] 
+**delta_arr** | **Float** |  | [optional] 
+
+

data/docs/MetricsReportingApi.md

@@ -0,0 +1,228 @@
+# SubskribeSandboxClient::MetricsReportingApi
+
+All URIs are relative to *https://api.sandbox.subskribe.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_external_arr_metrics**](MetricsReportingApi.md#add_external_arr_metrics) | **POST** /metricsReporting/externalArrMetrics | submit request to generate external arr metrics
+[**get_external_arr_metrics**](MetricsReportingApi.md#get_external_arr_metrics) | **GET** /metricsReporting/externalArrMetrics/{id} | gets external arr metrics request for the provided id
+[**get_external_arr_metrics1**](MetricsReportingApi.md#get_external_arr_metrics1) | **GET** /metricsReporting/externalArrMetrics | gets external arr metrics requests submitted
+[**populate_arr_metrics_for_subscription**](MetricsReportingApi.md#populate_arr_metrics_for_subscription) | **PUT** /metricsReporting/populateArrMetrics/subscriptions/{subscriptionId} | submit request to generate/regenerate arr metrics for a subscription
+
+
+# **add_external_arr_metrics**
+> add_external_arr_metrics(opts)
+
+submit request to generate external arr metrics
+
+returns the request with its captured id. Arr metrics will be generated as a backend job
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_sandbox'
+# setup authorization
+SubskribeSandboxClient.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 = SubskribeSandboxClient::MetricsReportingApi.new
+
+opts = { 
+  body: SubskribeSandboxClient::ExternalArrScheduleJson.new # ExternalArrScheduleJson | 
+}
+
+begin
+  #submit request to generate external arr metrics
+  api_instance.add_external_arr_metrics(opts)
+rescue SubskribeSandboxClient::ApiError => e
+  puts "Exception when calling MetricsReportingApi->add_external_arr_metrics: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ExternalArrScheduleJson**](ExternalArrScheduleJson.md)|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_external_arr_metrics**
+> get_external_arr_metrics(id)
+
+gets external arr metrics request for the provided id
+
+returns the external arr metrics request for the provided id
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_sandbox'
+# setup authorization
+SubskribeSandboxClient.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 = SubskribeSandboxClient::MetricsReportingApi.new
+
+id = 'id_example' # String | id of the externalArrMetrics request
+
+
+begin
+  #gets external arr metrics request for the provided id
+  api_instance.get_external_arr_metrics(id)
+rescue SubskribeSandboxClient::ApiError => e
+  puts "Exception when calling MetricsReportingApi->get_external_arr_metrics: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id of the externalArrMetrics request | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_external_arr_metrics1**
+> get_external_arr_metrics1(opts)
+
+gets external arr metrics requests submitted
+
+returns the paginated list of external arr metrics requests
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_sandbox'
+# setup authorization
+SubskribeSandboxClient.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 = SubskribeSandboxClient::MetricsReportingApi.new
+
+opts = { 
+  cursor: 'cursor_example', # String | 
+  limit: 56 # Integer | 
+}
+
+begin
+  #gets external arr metrics requests submitted
+  api_instance.get_external_arr_metrics1(opts)
+rescue SubskribeSandboxClient::ApiError => e
+  puts "Exception when calling MetricsReportingApi->get_external_arr_metrics1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cursor** | [**String**](.md)|  | [optional] 
+ **limit** | **Integer**|  | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **populate_arr_metrics_for_subscription**
+> populate_arr_metrics_for_subscription(subscription_id)
+
+submit request to generate/regenerate arr metrics for a subscription
+
+returns 200 if the result is successfully submitted to a background task
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_sandbox'
+# setup authorization
+SubskribeSandboxClient.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 = SubskribeSandboxClient::MetricsReportingApi.new
+
+subscription_id = 'subscription_id_example' # String | id of the subscription
+
+
+begin
+  #submit request to generate/regenerate arr metrics for a subscription
+  api_instance.populate_arr_metrics_for_subscription(subscription_id)
+rescue SubskribeSandboxClient::ApiError => e
+  puts "Exception when calling MetricsReportingApi->populate_arr_metrics_for_subscription: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subscription_id** | **String**| id of the subscription | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/NotificationTargetAndSubscriptions.md

@@ -0,0 +1,13 @@
+# SubskribeSandboxClient::NotificationTargetAndSubscriptions
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**notification_id** | **String** |  | [optional] 
+**notification_target_type** | **String** |  | [optional] 
+**notification_target** | **String** |  | [optional] 
+**subscribed_events** | **Array<String>** |  | [optional] 
+
+

data/docs/NotificationsApi.md

@@ -0,0 +1,226 @@
+# SubskribeSandboxClient::NotificationsApi
+
+All URIs are relative to *https://api.sandbox.subskribe.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_target_and_events_subscriptions**](NotificationsApi.md#add_target_and_events_subscriptions) | **POST** /notifications | Add a notification target
+[**get_all_notification_subscriptions_for_tenant**](NotificationsApi.md#get_all_notification_subscriptions_for_tenant) | **GET** /notifications | Get all notifications
+[**subscribe_existing_notification_target_to_event**](NotificationsApi.md#subscribe_existing_notification_target_to_event) | **POST** /notifications/{notificationId} | Attach an event to a notification
+[**unsubscribe_target_or_event**](NotificationsApi.md#unsubscribe_target_or_event) | **POST** /notifications/unsubscribe/{notificationId} | Unsubscribe from an event
+
+
+# **add_target_and_events_subscriptions**
+> NotificationTargetAndSubscriptions add_target_and_events_subscriptions(body)
+
+Add a notification target
+
+Adds a notification target and events according to the specified parameters
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_sandbox'
+# setup authorization
+SubskribeSandboxClient.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 = SubskribeSandboxClient::NotificationsApi.new
+
+body = SubskribeSandboxClient::NotificationTargetAndSubscriptions.new # NotificationTargetAndSubscriptions | json representing the notification details
+
+
+begin
+  #Add a notification target
+  result = api_instance.add_target_and_events_subscriptions(body)
+  p result
+rescue SubskribeSandboxClient::ApiError => e
+  puts "Exception when calling NotificationsApi->add_target_and_events_subscriptions: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**NotificationTargetAndSubscriptions**](NotificationTargetAndSubscriptions.md)| json representing the notification details | 
+
+### Return type
+
+[**NotificationTargetAndSubscriptions**](NotificationTargetAndSubscriptions.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_all_notification_subscriptions_for_tenant**
+> Array<NotificationTargetAndSubscriptions> get_all_notification_subscriptions_for_tenant
+
+Get all notifications
+
+Returns all notification subscriptions for your tenant
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_sandbox'
+# setup authorization
+SubskribeSandboxClient.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 = SubskribeSandboxClient::NotificationsApi.new
+
+begin
+  #Get all notifications
+  result = api_instance.get_all_notification_subscriptions_for_tenant
+  p result
+rescue SubskribeSandboxClient::ApiError => e
+  puts "Exception when calling NotificationsApi->get_all_notification_subscriptions_for_tenant: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<NotificationTargetAndSubscriptions>**](NotificationTargetAndSubscriptions.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **subscribe_existing_notification_target_to_event**
+> subscribe_existing_notification_target_to_event(notification_id, notification_event_type)
+
+Attach an event to a notification
+
+Attaches a notification event to the target specified by the notification id
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_sandbox'
+# setup authorization
+SubskribeSandboxClient.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 = SubskribeSandboxClient::NotificationsApi.new
+
+notification_id = 'notification_id_example' # String | id of the notification target
+
+notification_event_type = 'notification_event_type_example' # String | type of event
+
+
+begin
+  #Attach an event to a notification
+  api_instance.subscribe_existing_notification_target_to_event(notification_id, notification_event_type)
+rescue SubskribeSandboxClient::ApiError => e
+  puts "Exception when calling NotificationsApi->subscribe_existing_notification_target_to_event: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **notification_id** | **String**| id of the notification target | 
+ **notification_event_type** | **String**| type of event | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **unsubscribe_target_or_event**
+> unsubscribe_target_or_event(notification_id, notification_event_type)
+
+Unsubscribe from an event
+
+Unsubscribes the specified notification target from the specified event
+
+### Example
+```ruby
+# load the gem
+require 'subskribe_sandbox'
+# setup authorization
+SubskribeSandboxClient.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 = SubskribeSandboxClient::NotificationsApi.new
+
+notification_id = 'notification_id_example' # String | id of the notification target
+
+notification_event_type = 'notification_event_type_example' # String | type of event
+
+
+begin
+  #Unsubscribe from an event
+  api_instance.unsubscribe_target_or_event(notification_id, notification_event_type)
+rescue SubskribeSandboxClient::ApiError => e
+  puts "Exception when calling NotificationsApi->unsubscribe_target_or_event: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **notification_id** | **String**| id of the notification target | 
+ **notification_event_type** | **String**| type of event | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/NumberConfig.md

@@ -0,0 +1,12 @@
+# SubskribeSandboxClient::NumberConfig
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**config_id** | **String** |  | [optional] 
+**scheme** | **String** |  | [optional] 
+**prefix** | **String** |  | [optional] 
+**length** | **Integer** |  | [optional] 
+**next_sequence_number** | **Integer** |  | [optional] 
+
+

data/docs/Opportunity.md

@@ -0,0 +1,20 @@
+# SubskribeSandboxClient::Opportunity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**entity_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**stage** | **String** |  | [optional] 
+**crm_id** | **String** |  | [optional] 
+**account_id** | **String** |  | [optional] 
+**created_on** | **Integer** |  | [optional] 
+**updated_on** | **Integer** |  | [optional] 
+**opportunity_crm_type** | **String** |  | [optional] 
+**is_closed** | **BOOLEAN** |  | [optional] 
+**primary_order_id** | **String** |  | [optional] 
+**opportunity_id** | **String** |  | [optional] 
+
+