subskribe_dev 1.1.0 → 1.2.0

data/docs/Attachment.md

@@ -0,0 +1,17 @@
+# SubskribeDevClient::Attachment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | 
+**name** | **String** |  | 
+**description** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**account_id** | **String** |  | [optional] 
+**tag** | **String** |  | [optional] 
+**in_use** | **BOOLEAN** |  | [optional] 
+**is_deleted** | **BOOLEAN** |  | [optional] 
+**created_on** | **Integer** |  | 
+**updated_on** | **Integer** |  | [optional] 
+
+

data/docs/AttachmentsApi.md

@@ -0,0 +1,294 @@
+# SubskribeDevClient::AttachmentsApi
+
+All URIs are relative to *https://api.dev2.subskribe.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_attachment_to_account**](AttachmentsApi.md#add_attachment_to_account) | **POST** /attachments/account/{accountId} | Add an attachment
+[**delete_attachment_from_account**](AttachmentsApi.md#delete_attachment_from_account) | **DELETE** /attachments/{attachmentId} | Delete an attachment
+[**get_attachment**](AttachmentsApi.md#get_attachment) | **GET** /attachments/{attachmentId} | Get attachment contents
+[**list_account_attachments**](AttachmentsApi.md#list_account_attachments) | **GET** /attachments/account/{accountId} | Get attachments for an account
+[**modify_attachment**](AttachmentsApi.md#modify_attachment) | **PUT** /attachments | Update the details of an attachment
+
+
+# **add_attachment_to_account**
+> Attachment add_attachment_to_account(account_id, opts)
+
+Add an attachment
+
+Attaches a document to the specified account. The post body should contain the body of the document that is to be attached. On success the Id of the attachment 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::AttachmentsApi.new
+
+account_id = 'account_id_example' # String | id of the account to attach the document to
+
+opts = { 
+  file: File.new('/path/to/file.txt'), # File | 
+  file_name: 'file_name_example', # String | name to associate with the attachment
+  description: 'description_example', # String | description of the document
+  size: 789, # Integer | size in bytes of the document
+  tag: 'tag_example' # String | tag to apply to the attachment
+}
+
+begin
+  #Add an attachment
+  result = api_instance.add_attachment_to_account(account_id, opts)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AttachmentsApi->add_attachment_to_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| id of the account to attach the document to | 
+ **file** | **File**|  | [optional] 
+ **file_name** | **String**| name to associate with the attachment | [optional] 
+ **description** | **String**| description of the document | [optional] 
+ **size** | **Integer**| size in bytes of the document | [optional] 
+ **tag** | **String**| tag to apply to the attachment | [optional] 
+
+### Return type
+
+[**Attachment**](Attachment.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+
+# **delete_attachment_from_account**
+> delete_attachment_from_account(attachment_id)
+
+Delete an attachment
+
+Unattaches and deletes the specified document
+
+### 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::AttachmentsApi.new
+
+attachment_id = 'attachment_id_example' # String | id of the attachment
+
+
+begin
+  #Delete an attachment
+  api_instance.delete_attachment_from_account(attachment_id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AttachmentsApi->delete_attachment_from_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **attachment_id** | [**String**](.md)| id of the attachment | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_attachment**
+> get_attachment(attachment_id)
+
+Get attachment contents
+
+Gets the contents of the specified attachment
+
+### 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::AttachmentsApi.new
+
+attachment_id = 'attachment_id_example' # String | id of the attachment
+
+
+begin
+  #Get attachment contents
+  api_instance.get_attachment(attachment_id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AttachmentsApi->get_attachment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **attachment_id** | [**String**](.md)| id of the attachment | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/octet-stream, application/json
+
+
+
+# **list_account_attachments**
+> Array<Attachment> list_account_attachments(account_id)
+
+Get attachments for an account
+
+Lists all the documents attached to 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::AttachmentsApi.new
+
+account_id = 'account_id_example' # String | id of the attachment
+
+
+begin
+  #Get attachments for an account
+  result = api_instance.list_account_attachments(account_id)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AttachmentsApi->list_account_attachments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_id** | **String**| id of the attachment | 
+
+### Return type
+
+[**Array<Attachment>**](Attachment.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **modify_attachment**
+> Attachment modify_attachment(opts)
+
+Update the details of an attachment
+
+Updates the details of the specified document
+
+### 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::AttachmentsApi.new
+
+opts = { 
+  body: SubskribeDevClient::Attachment.new # Attachment | json representing the attachment
+}
+
+begin
+  #Update the details of an attachment
+  result = api_instance.modify_attachment(opts)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AttachmentsApi->modify_attachment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**Attachment**](Attachment.md)| json representing the attachment | [optional] 
+
+### Return type
+
+[**Attachment**](Attachment.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AttributeReference.md

@@ -0,0 +1,9 @@
+# SubskribeDevClient::AttributeReference
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attribute_definition_id** | **String** |  | [optional] 
+**attribute_value** | **String** |  | [optional] 
+
+

data/docs/AuthSamlIntegrationJson.md

@@ -0,0 +1,10 @@
+# SubskribeDevClient::AuthSamlIntegrationJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attribute_mapping** | **Hash<String, String>** |  | [optional] 
+**metadata_url** | **String** |  | [optional] 
+**provider_name** | **String** |  | [optional] 
+
+

data/docs/AuthenticationApi.md

@@ -0,0 +1,329 @@
+# SubskribeDevClient::AuthenticationApi
+
+All URIs are relative to *https://api.dev2.subskribe.net*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_saml_integration**](AuthenticationApi.md#add_saml_integration) | **POST** /auth/saml | Add a saml integration
+[**create_api_key**](AuthenticationApi.md#create_api_key) | **POST** /apikey | Create a new api key
+[**get_all_api_keys**](AuthenticationApi.md#get_all_api_keys) | **GET** /apikey | Retrieves all API keys
+[**get_api_key_by_id**](AuthenticationApi.md#get_api_key_by_id) | **GET** /apikey/{id} | Retrieve an API key by id
+[**revoke_api_key**](AuthenticationApi.md#revoke_api_key) | **DELETE** /apikey/revoke | revoke all keys
+[**revoke_api_key_by_id**](AuthenticationApi.md#revoke_api_key_by_id) | **DELETE** /apikey/revoke/{id} | revoke an API key by id
+
+
+# **add_saml_integration**
+> add_saml_integration(opts)
+
+Add a saml integration
+
+Adds a saml integration
+
+### 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::AuthenticationApi.new
+
+opts = { 
+  body: SubskribeDevClient::AuthSamlIntegrationJson.new # AuthSamlIntegrationJson | saml representing the integration
+}
+
+begin
+  #Add a saml integration
+  api_instance.add_saml_integration(opts)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AuthenticationApi->add_saml_integration: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**AuthSamlIntegrationJson**](AuthSamlIntegrationJson.md)| saml representing the integration | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_api_key**
+> String create_api_key(opts)
+
+Create a new api key
+
+Create a new api key with the specified parameters. The new key 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::AuthenticationApi.new
+
+opts = { 
+  role: 'role_example', # String | Role-based permissions to be associated with the key. Specify this OR userId.
+  expiry: 789, # Integer | Time of expiry in seconds since Epoch (GMT)
+  user_id: 'user_id_example', # String | User to associate key with. Specify this OR role.
+  entity_id: 'entity_id_example' # String | Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *).
+}
+
+begin
+  #Create a new api key
+  result = api_instance.create_api_key(opts)
+  p result
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AuthenticationApi->create_api_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role** | **String**| Role-based permissions to be associated with the key. Specify this OR userId. | [optional] 
+ **expiry** | **Integer**| Time of expiry in seconds since Epoch (GMT) | [optional] 
+ **user_id** | **String**| User to associate key with. Specify this OR role. | [optional] 
+ **entity_id** | **String**| Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *). | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_all_api_keys**
+> get_all_api_keys
+
+Retrieves all API keys
+
+Retrieves a list of (maximum 500 items) all API keys (including expired and deactivated keys)
+
+### 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::AuthenticationApi.new
+
+begin
+  #Retrieves all API keys
+  api_instance.get_all_api_keys
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AuthenticationApi->get_all_api_keys: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_api_key_by_id**
+> get_api_key_by_id(id)
+
+Retrieve an API key by id
+
+Retrieve an api key referenced by its 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::AuthenticationApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  #Retrieve an API key by id
+  api_instance.get_api_key_by_id(id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AuthenticationApi->get_api_key_by_id: #{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**: application/json
+ - **Accept**: application/json
+
+
+
+# **revoke_api_key**
+> revoke_api_key
+
+revoke all keys
+
+Revokes all keys 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::AuthenticationApi.new
+
+begin
+  #revoke all keys
+  api_instance.revoke_api_key
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AuthenticationApi->revoke_api_key: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **revoke_api_key_by_id**
+> revoke_api_key_by_id(id)
+
+revoke an API key by id
+
+Revoke an api key referenced by its 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::AuthenticationApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  #revoke an API key by id
+  api_instance.revoke_api_key_by_id(id)
+rescue SubskribeDevClient::ApiError => e
+  puts "Exception when calling AuthenticationApi->revoke_api_key_by_id: #{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**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AutomatedInvoiceRule.md

@@ -0,0 +1,24 @@
+# SubskribeDevClient::AutomatedInvoiceRule
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**enabled** | **BOOLEAN** |  | [optional] 
+**description** | **String** |  | [optional] 
+**cron_expression** | **String** |  | [optional] 
+**updated_on** | **Integer** |  | [optional] 
+**created_on** | **Integer** |  | [optional] 
+**last_execution_date** | **Integer** |  | [optional] 
+**cron_expression_meaning** | **String** |  | [optional] 
+**next_execution_date** | **Integer** |  | [optional] 
+**target_duration** | **Integer** |  | [optional] 
+**invoice_duration** | **Integer** |  | [optional] 
+**include_usage_charge** | **BOOLEAN** |  | [optional] 
+**include_non_usage_charge** | **BOOLEAN** |  | [optional] 
+**auto_post_invoice** | **BOOLEAN** |  | [optional] 
+**auto_email_invoice** | **BOOLEAN** |  | [optional] 
+**first_execution_date** | **Integer** |  | [optional] 
+
+

data/docs/AutomatedInvoiceRuleRequestJson.md

@@ -0,0 +1,20 @@
+# SubskribeDevClient::AutomatedInvoiceRuleRequestJson
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | 
+**description** | **String** |  | [optional] 
+**cron_expression** | **String** |  | 
+**first_execution_date** | **Integer** |  | 
+**last_execution_date** | **Integer** |  | [optional] 
+**target_duration** | **Integer** |  | [optional] 
+**invoice_duration** | **Integer** |  | [optional] 
+**include_usage_charge** | **BOOLEAN** |  | [optional] 
+**include_non_usage_charge** | **BOOLEAN** |  | [optional] 
+**auto_post_invoice** | **BOOLEAN** |  | [optional] 
+**auto_email_invoice** | **BOOLEAN** |  | [optional] 
+**enabled** | **BOOLEAN** |  | [optional] 
+
+