subskribe_dev 1.1.0 → 1.2.0

data/docs/PaginatedResponse.md

@@ -0,0 +1,10 @@
+# SubskribeDevClient::PaginatedResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | **Array<Object>** |  | [optional] 
+**count** | **Integer** |  | [optional] 
+**page_token** | **String** |  | [optional] 
+
+

data/docs/PaymentBalanceJson.md

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

data/docs/PaymentConfiguration.md

@@ -0,0 +1,8 @@
+# SubskribeDevClient::PaymentConfiguration
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**supported_payment_types** | **Array<String>** |  | [optional] 
+
+

data/docs/PaymentJson.md

@@ -0,0 +1,16 @@
+# SubskribeDevClient::PaymentJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**payment_id** | **String** |  | [optional] 
+**account_id** | **String** |  | 
+**payment_method_id** | **String** |  | 
+**currency_code** | **String** |  | [optional] 
+**state** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**amount** | **Float** |  | [optional] 
+**payment_date** | **Integer** |  | [optional] 
+
+

data/docs/PaymentJsonPaginationResponse.md

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

data/docs/PaymentTermSettingsJson.md

@@ -0,0 +1,10 @@
+# SubskribeDevClient::PaymentTermSettingsJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**default_payment_terms** | **Array<String>** |  | 
+**default_payment_term** | **String** |  | 
+**custom_payment_terms_allowed** | **BOOLEAN** |  | 
+
+

data/docs/PaymentsApi.md

@@ -0,0 +1,450 @@
+# SubskribeDevClient::PaymentsApi
+
+All URIs are relative to *https://api.dev2.subskribe.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_account_payment**](PaymentsApi.md#get_account_payment) | **GET** /payments/account/{id} | Get payments
+[**get_account_payment_management_link**](PaymentsApi.md#get_account_payment_management_link) | **GET** /payments/account-payment/{id} | Get account payment management link
+[**get_payment**](PaymentsApi.md#get_payment) | **GET** /payments/{id} | Get payment details
+[**get_payment_balance**](PaymentsApi.md#get_payment_balance) | **GET** /payments/{id}/balance | Get payment balance
+[**get_payment_configuration**](PaymentsApi.md#get_payment_configuration) | **GET** /payments/configuration | Get payment configuration
+[**get_payments**](PaymentsApi.md#get_payments) | **GET** /payments | Get all payments
+[**update_payment_configuration**](PaymentsApi.md#update_payment_configuration) | **POST** /payments/configuration | Update payment configuration
+[**void_payment**](PaymentsApi.md#void_payment) | **PUT** /payments/{id}/void | Voids a payment
+
+
+# **get_account_payment**
+> Array<PaymentJson> get_account_payment(id)
+
+Get payments
+
+Returns the payments for the specified account
+
+### 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::PaymentsApi.new
+
+id = 'id_example' # String | id of the account
+
+
+begin
+  #Get payments
+  result = api_instance.get_account_payment(id)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling PaymentsApi->get_account_payment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id of the account | 
+
+### Return type
+
+[**Array<PaymentJson>**](PaymentJson.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_account_payment_management_link**
+> String get_account_payment_management_link(id)
+
+Get account payment management link
+
+Returns a payment management link for an account
+
+### 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::PaymentsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  #Get account payment management link
+  result = api_instance.get_account_payment_management_link(id)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling PaymentsApi->get_account_payment_management_link: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_payment**
+> PaymentJson get_payment(id)
+
+Get payment details
+
+Gets the details of the specified payment
+
+### 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::PaymentsApi.new
+
+id = 'id_example' # String | id of the payment
+
+
+begin
+  #Get payment details
+  result = api_instance.get_payment(id)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling PaymentsApi->get_payment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id of the payment | 
+
+### Return type
+
+[**PaymentJson**](PaymentJson.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_payment_balance**
+> PaymentBalanceJson get_payment_balance(id)
+
+Get payment balance
+
+Gets the balance of a payment
+
+### 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::PaymentsApi.new
+
+id = 'id_example' # String | id of the payment
+
+
+begin
+  #Get payment balance
+  result = api_instance.get_payment_balance(id)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling PaymentsApi->get_payment_balance: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| id of the payment | 
+
+### Return type
+
+[**PaymentBalanceJson**](PaymentBalanceJson.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_payment_configuration**
+> PaymentConfiguration get_payment_configuration
+
+Get payment configuration
+
+Returns the payment configuration for your tenant
+
+### 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::PaymentsApi.new
+
+begin
+  #Get payment configuration
+  result = api_instance.get_payment_configuration
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling PaymentsApi->get_payment_configuration: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PaymentConfiguration**](PaymentConfiguration.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_payments**
+> PaymentJsonPaginationResponse get_payments(opts)
+
+Get all payments
+
+Returns all payments for you tenant. The results are paginated. To fetch all take the cursor returned from a call and pass it to a subsequent call.
+
+### 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::PaymentsApi.new
+
+opts = { 
+  cursor: 'cursor_example', # String | cursor returned from previous call
+  limit: 56 # Integer | number of results per page
+}
+
+begin
+  #Get all payments
+  result = api_instance.get_payments(opts)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling PaymentsApi->get_payments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cursor** | [**String**](.md)| cursor returned from previous call | [optional] 
+ **limit** | **Integer**| number of results per page | [optional] 
+
+### Return type
+
+[**PaymentJsonPaginationResponse**](PaymentJsonPaginationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **update_payment_configuration**
+> PaymentConfiguration update_payment_configuration(opts)
+
+Update payment configuration
+
+Updates the payment configuration for your tenant.
+
+### 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::PaymentsApi.new
+
+opts = { 
+  body: [SubskribeDevClient::Array<String>.new] # Array<String> | Payment types to set. Options can be one or more of the allowable values
+}
+
+begin
+  #Update payment configuration
+  result = api_instance.update_payment_configuration(opts)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling PaymentsApi->update_payment_configuration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | **Array&lt;String&gt;**| Payment types to set. Options can be one or more of the allowable values | [optional] 
+
+### Return type
+
+[**PaymentConfiguration**](PaymentConfiguration.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **void_payment**
+> PaymentJson void_payment(id, opts)
+
+Voids a payment
+
+Voids the specified 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::PaymentsApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  body: SubskribeDevClient::VoidPaymentJson.new # VoidPaymentJson | 
+}
+
+begin
+  #Voids a payment
+  result = api_instance.void_payment(id, opts)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling PaymentsApi->void_payment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **body** | [**VoidPaymentJson**](VoidPaymentJson.md)|  | [optional] 
+
+### Return type
+
+[**PaymentJson**](PaymentJson.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/PlanJson.md

@@ -0,0 +1,20 @@
+# SubskribeDevClient::PlanJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**entity_ids** | **Array<String>** |  | [optional] 
+**name** | **String** |  | [optional] 
+**display_name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**status** | **String** |  | 
+**product_id** | **String** |  | [optional] 
+**charges** | [**Array<ChargeJson>**](ChargeJson.md) |  | [optional] 
+**currency** | **String** |  | [optional] 
+**external_id** | **String** |  | [optional] 
+**template_ids** | **Array<String>** |  | [optional] 
+**custom_fields** | [**Hash<String, CustomFieldValue>**](CustomFieldValue.md) |  | [optional] 
+**updated_on** | **Integer** |  | [optional] 
+
+

data/docs/PlanJsonPaginationResponse.md

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

data/docs/PredefinedReportDefChartJson.md

@@ -0,0 +1,17 @@
+# SubskribeDevClient::PredefinedReportDefChartJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**chart_type** | **String** |  | [optional] 
+**main_axis_key** | **String** |  | [optional] 
+**cross_axis_key** | **String** |  | [optional] 
+**main_axis_label** | **String** |  | [optional] 
+**cross_axis_label** | **String** |  | [optional] 
+**main_axis_scale** | **String** |  | [optional] 
+**cross_axis_scale** | **String** |  | [optional] 
+**title** | **String** |  | [optional] 
+**sort_by** | **String** |  | [optional] 
+**show_legend** | **BOOLEAN** |  | [optional] 
+
+

data/docs/PredefinedReportDefJson.md

@@ -0,0 +1,12 @@
+# SubskribeDevClient::PredefinedReportDefJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**report_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**filters** | [**Array<PredefinedReportParamObject>**](PredefinedReportParamObject.md) |  | [optional] 
+**chart** | [**PredefinedReportDefChartJson**](PredefinedReportDefChartJson.md) |  | [optional] 
+
+

data/docs/PredefinedReportDefsJson.md

@@ -0,0 +1,8 @@
+# SubskribeDevClient::PredefinedReportDefsJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**report_defs** | [**Array<PredefinedReportDefJson>**](PredefinedReportDefJson.md) |  | [optional] 
+
+

data/docs/PredefinedReportJson.md

@@ -0,0 +1,11 @@
+# SubskribeDevClient::PredefinedReportJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**report_id** | **String** |  | [optional] 
+**params** | **Hash<String, Object>** |  | [optional] 
+**duration** | [**ReportDuration**](ReportDuration.md) |  | [optional] 
+**report_date** | **Integer** |  | [optional] 
+
+

data/docs/PredefinedReportParam.md

@@ -0,0 +1,14 @@
+# SubskribeDevClient::PredefinedReportParam
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**type** | **String** |  | 
+**datatype** | **String** |  | 
+**allowed_values** | **Array<String>** |  | [optional] 
+**default_value** | **Object** |  | [optional] 
+**optional** | **BOOLEAN** |  | [optional] 
+
+

data/docs/PredefinedReportParamObject.md

@@ -0,0 +1,14 @@
+# SubskribeDevClient::PredefinedReportParamObject
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**type** | **String** |  | 
+**datatype** | **String** |  | 
+**allowed_values** | **Array<String>** |  | [optional] 
+**default_value** | **Object** |  | [optional] 
+**optional** | **BOOLEAN** |  | [optional] 
+
+

data/docs/PrepaidStats.md

@@ -0,0 +1,22 @@
+# SubskribeDevClient::PrepaidStats
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_id** | **String** |  | [optional] 
+**account_name** | **String** |  | [optional] 
+**account_crm_id** | **String** |  | [optional] 
+**subscription_id** | **String** |  | [optional] 
+**entity_display_id** | **String** |  | [optional] 
+**subscription_start_date** | **Integer** |  | [optional] 
+**subscription_end_date** | **Integer** |  | [optional] 
+**plan_name** | **String** |  | [optional] 
+**drawdown_charge_name** | **String** |  | [optional] 
+**provisioned_quantity** | **Float** |  | [optional] 
+**starting_quantity** | **Float** |  | [optional] 
+**remaining_quantity** | **Float** |  | [optional] 
+**consumed_quantity** | **Float** |  | [optional] 
+**period_start** | **Integer** |  | [optional] 
+**period_end** | **Integer** |  | [optional] 
+
+

data/docs/PriceTierJson.md

@@ -0,0 +1,10 @@
+# SubskribeDevClient::PriceTierJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**until_quantity** | **String** |  | 
+**amount** | **Float** |  | 
+**overage** | **Float** |  | [optional] 
+
+