sib-api-v3-sdk 7.5.0 → 8.0.0

data/docs/MasterAccountApi.md

@@ -0,0 +1,367 @@
+# SibApiV3Sdk::MasterAccountApi
+
+All URIs are relative to *https://api.sendinblue.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**corporate_master_account_get**](MasterAccountApi.md#corporate_master_account_get) | **GET** /corporate/masterAccount | Get the details of requested master account
+[**corporate_sub_account_get**](MasterAccountApi.md#corporate_sub_account_get) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
+[**corporate_sub_account_id_get**](MasterAccountApi.md#corporate_sub_account_id_get) | **GET** /corporate/subAccount/{id} | Get sub-account details
+[**corporate_sub_account_id_plan_put**](MasterAccountApi.md#corporate_sub_account_id_plan_put) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
+[**corporate_sub_account_post**](MasterAccountApi.md#corporate_sub_account_post) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
+[**corporate_sub_account_sso_token_post**](MasterAccountApi.md#corporate_sub_account_sso_token_post) | **POST** /corporate/subAccount/ssoToken | Generate SSO token to access Sendinblue
+
+
+# **corporate_master_account_get**
+> MasterDetailsResponse corporate_master_account_get
+
+Get the details of requested master account
+
+This endpoint will provide the details of the master account.
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['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['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::MasterAccountApi.new
+
+begin
+  #Get the details of requested master account
+  result = api_instance.corporate_master_account_get
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling MasterAccountApi->corporate_master_account_get: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**MasterDetailsResponse**](MasterDetailsResponse.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **corporate_sub_account_get**
+> SubAccountsResponse corporate_sub_account_get(offset, limit)
+
+Get the list of all the sub-accounts of the master account.
+
+This endpoint will provide the list all the sub-accounts of the master account.
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['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['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::MasterAccountApi.new
+
+offset = 56 # Integer | Page number of sub-accounts listing
+
+limit = 56 # Integer | Number of sub-accounts to be displayed on each page
+
+
+begin
+  #Get the list of all the sub-accounts of the master account.
+  result = api_instance.corporate_sub_account_get(offset, limit)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling MasterAccountApi->corporate_sub_account_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **offset** | **Integer**| Page number of sub-accounts listing | 
+ **limit** | **Integer**| Number of sub-accounts to be displayed on each page | 
+
+### Return type
+
+[**SubAccountsResponse**](SubAccountsResponse.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **corporate_sub_account_id_get**
+> SubAccountDetailsResponse corporate_sub_account_id_get(id)
+
+Get sub-account details
+
+This endpoint will provide the details of specified sub-account organization
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['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['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::MasterAccountApi.new
+
+id = 789 # Integer | Id of the sub-account organization
+
+
+begin
+  #Get sub-account details
+  result = api_instance.corporate_sub_account_id_get(id)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling MasterAccountApi->corporate_sub_account_id_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Id of the sub-account organization | 
+
+### Return type
+
+[**SubAccountDetailsResponse**](SubAccountDetailsResponse.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **corporate_sub_account_id_plan_put**
+> corporate_sub_account_id_plan_put(id, update_plan_details)
+
+Update sub-account plan
+
+This endpoint will update the sub-account plan
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['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['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::MasterAccountApi.new
+
+id = 789 # Integer | Id of the sub-account organization
+
+update_plan_details = SibApiV3Sdk::SubAccountUpdatePlanRequest.new # SubAccountUpdatePlanRequest | Values to update a sub-account plan
+
+
+begin
+  #Update sub-account plan
+  api_instance.corporate_sub_account_id_plan_put(id, update_plan_details)
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling MasterAccountApi->corporate_sub_account_id_plan_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**| Id of the sub-account organization | 
+ **update_plan_details** | [**SubAccountUpdatePlanRequest**](SubAccountUpdatePlanRequest.md)| Values to update a sub-account plan | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **corporate_sub_account_post**
+> CreateModel corporate_sub_account_post(sub_account_create)
+
+Create a new sub-account under a master account.
+
+This endpoint will create a new sub-account under a master account
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['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['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::MasterAccountApi.new
+
+sub_account_create = SibApiV3Sdk::CreateSubAccount.new # CreateSubAccount | values to create new sub-account
+
+
+begin
+  #Create a new sub-account under a master account.
+  result = api_instance.corporate_sub_account_post(sub_account_create)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling MasterAccountApi->corporate_sub_account_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sub_account_create** | [**CreateSubAccount**](CreateSubAccount.md)| values to create new sub-account | 
+
+### Return type
+
+[**CreateModel**](CreateModel.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **corporate_sub_account_sso_token_post**
+> GetSsoToken corporate_sub_account_sso_token_post(sso_token_request)
+
+Generate SSO token to access Sendinblue
+
+This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced with actual token.
+
+### Example
+```ruby
+# load the gem
+require 'sib-api-v3-sdk'
+# setup authorization
+SibApiV3Sdk.configure do |config|
+  # Configure API key authorization: api-key
+  config.api_key['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['api-key'] = 'Bearer'
+
+  # Configure API key authorization: partner-key
+  config.api_key['partner-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['partner-key'] = 'Bearer'
+end
+
+api_instance = SibApiV3Sdk::MasterAccountApi.new
+
+sso_token_request = SibApiV3Sdk::SsoTokenRequest.new # SsoTokenRequest | Values to generate SSO token for sub-account
+
+
+begin
+  #Generate SSO token to access Sendinblue
+  result = api_instance.corporate_sub_account_sso_token_post(sso_token_request)
+  p result
+rescue SibApiV3Sdk::ApiError => e
+  puts "Exception when calling MasterAccountApi->corporate_sub_account_sso_token_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sso_token_request** | [**SsoTokenRequest**](SsoTokenRequest.md)| Values to generate SSO token for sub-account | 
+
+### Return type
+
+[**GetSsoToken**](GetSsoToken.md)
+
+### Authorization
+
+[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/MasterDetailsResponse.md

@@ -0,0 +1,14 @@
+# SibApiV3Sdk::MasterDetailsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Email id of master account | [optional] 
+**company_name** | **String** | Company name of master account organization | [optional] 
+**id** | **Integer** | Unique identifier of the master account organization | [optional] 
+**currency_code** | **String** | Currency code of the master account organization | [optional] 
+**timezone** | **String** | Timezone of the master account organization | [optional] 
+**billing_info** | [**MasterDetailsResponseBillingInfo**](MasterDetailsResponseBillingInfo.md) |  | [optional] 
+**plan_info** | [**MasterDetailsResponsePlanInfo**](MasterDetailsResponsePlanInfo.md) |  | [optional] 
+
+

data/docs/MasterDetailsResponseBillingInfo.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::MasterDetailsResponseBillingInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | Billing email id of master account | [optional] 
+**company_name** | **String** | Company name of master account | [optional] 
+**name** | [**MasterDetailsResponseBillingInfoName**](MasterDetailsResponseBillingInfoName.md) |  | [optional] 
+**address** | [**MasterDetailsResponseBillingInfoAddress**](MasterDetailsResponseBillingInfoAddress.md) |  | [optional] 
+
+

data/docs/MasterDetailsResponseBillingInfoAddress.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::MasterDetailsResponseBillingInfoAddress
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**street_address** | **String** | Street address | [optional] 
+**locality** | **String** | Locality | [optional] 
+**postal_code** | **String** | Postal code | [optional] 
+**state_code** | **String** | State code | [optional] 
+**country_code** | **String** | Country code | [optional] 
+
+

data/docs/MasterDetailsResponseBillingInfoName.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::MasterDetailsResponseBillingInfoName
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**given_name** | **String** | First name for billing | [optional] 
+**family_name** | **String** | Last name for billing | [optional] 
+
+

data/docs/MasterDetailsResponsePlanInfo.md

@@ -0,0 +1,13 @@
+# SibApiV3Sdk::MasterDetailsResponsePlanInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_code** | **String** | Plan currency | [optional] 
+**next_billing_at** | **Integer** | Timestamp of next billing date | [optional] 
+**price** | **Float** | Plan amount | [optional] 
+**plan_period** | **String** | Plan period type | [optional] 
+**sub_accounts** | **Integer** | Number of sub-accounts | [optional] 
+**features** | [**Array<MasterDetailsResponsePlanInfoFeatures>**](MasterDetailsResponsePlanInfoFeatures.md) | List of provided features in the plan | [optional] 
+
+

data/docs/MasterDetailsResponsePlanInfoFeatures.md

@@ -0,0 +1,12 @@
+# SibApiV3Sdk::MasterDetailsResponsePlanInfoFeatures
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the feature | [optional] 
+**unit_value** | **String** | Unit value of the feature | [optional] 
+**quantity** | **Integer** | Quantity provided in the plan | [optional] 
+**used** | **Integer** | Quantity consumed by master | [optional] 
+**remaining** | **Integer** | Quantity remaining in the plan | [optional] 
+
+

data/docs/Note.md

@@ -0,0 +1,14 @@
+# SibApiV3Sdk::Note
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique note Id | [optional] 
+**text** | **String** | Text content of a note | 
+**contact_ids** | **Array<Integer>** | Contact ids linked to a note | [optional] 
+**deal_ids** | **Array<String>** | Deal ids linked to a note | [optional] 
+**author_id** | **Object** | Account details of user which created the note | [optional] 
+**created_at** | **DateTime** | Note created date/time | [optional] 
+**updated_at** | **DateTime** | Note updated date/time | [optional] 
+
+

data/docs/NoteData.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::NoteData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | Text content of a note | 
+**contact_ids** | **Array<Integer>** | Contact Ids linked to a note | [optional] 
+**deal_ids** | **Array<String>** | Deal Ids linked to a note | [optional] 
+
+

data/docs/RequestContactExport.md

@@ -4,8 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **export_attributes** | **Array<String>** | List of all the attributes that you want to export. These attributes must be present in your contact database. For example, ['fname', 'lname', 'email']. | [optional] 
-**contact_filter** | **Object** | This attribute has been deprecated and will be removed by January 1st, 2021. Only one of the two filter options (contactFilter or customContactFilter) can be passed in the request. Set the filter for the contacts to be exported. For example, {\"blacklisted\":true} will export all the blacklisted contacts.  | [optional] 
-**custom_contact_filter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) |  | [optional] 
+**custom_contact_filter** | [**RequestContactExportCustomContactFilter**](RequestContactExportCustomContactFilter.md) |  | 
 **notify_url** | **String** | Webhook that will be called once the export process is finished. For reference, https://help.sendinblue.com/hc/en-us/articles/360007666479 | [optional] 
 
 

data/docs/SendSmtpEmail.md

@@ -11,11 +11,11 @@ Name | Type | Description | Notes
 **text_content** | **String** | Plain Text body of the message ( Ignored if 'templateId' is passed ) | [optional] 
 **subject** | **String** | Subject of the message. Mandatory if 'templateId' is not passed | [optional] 
 **reply_to** | [**SendSmtpEmailReplyTo**](SendSmtpEmailReplyTo.md) |  | [optional] 
-**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg and wmv ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] 
-**headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\"}`. | [optional] 
+**attachment** | [**Array<SendSmtpEmailAttachment>**](SendSmtpEmailAttachment.md) | Pass the absolute URL (no local file) or the base64 content of the attachment along with the attachment name (Mandatory if attachment content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\", \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\", \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac, wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv and pkpass ( If 'templateId' is passed and is in New Template Language format then both attachment url and content are accepted. If template is in Old template Language format, then 'attachment' is ignored ) | [optional] 
+**headers** | **Object** | Pass the set of custom headers (not the standard headers) that shall be sent along the mail headers in the original email. 'sender.ip' header can be set (only for dedicated ip users) to mention the IP to be used for sending transactional emails. Headers are allowed in `This-Case-Only` (i.e. words separated by hyphen with first letter of each word in capital letter), they will be converted to such case styling if not in this format in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\":\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`. | [optional] 
 **template_id** | **Integer** | Id of the template. Mandatory if messageVersions are passed | [optional] 
 **params** | **Object** | Pass the set of attributes to customize the template. For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template is in New Template Language format. | [optional] 
-**message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional] 
+**message_versions** | [**Array<SendSmtpEmailMessageVersions>**](SendSmtpEmailMessageVersions.md) | You can customize and send out multiple versions of a templateId. Some global parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also be customized specific to each version. Total number of recipients in one API request must not exceed 200. However, you can still pass upto 99 recipients maximum in one message version. The size of individual params in all the messageVersions shall not exceed 100 KB limit and that of cumulative params shall not exceed 1000 KB. This feature is currently in its beta version. You can follow this **step-by-step guide** on how to use **messageVersions** to batch send emails - https://developers.sendinblue.com/docs/batch-send-transactional-emails | [optional] 
 **tags** | **Array<String>** | Tag your emails to find them more easily | [optional] 
 
 

data/docs/SendTransacSms.md

@@ -9,5 +9,6 @@ Name | Type | Description | Notes
 **type** | **String** | Type of the SMS. Marketing SMS messages are those sent typically with marketing content. Transactional SMS messages are sent to individuals and are triggered in response to some action, such as a sign-up, purchase, etc. | [optional] [default to 'transactional']
 **tag** | **String** | Tag of the message | [optional] 
 **web_url** | **String** | Webhook to call for each event triggered by the message (delivered etc.) | [optional] 
+**unicode_enabled** | **BOOLEAN** | Format of the message. It indicates whether the content should be treated as unicode or not. | [optional] [default to false]
 
 

data/docs/SsoTokenRequest.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SsoTokenRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Id of the sub-account organization | 
+**email** | **String** | User email of sub-account organization | [optional] 
+
+

data/docs/SubAccountDetailsResponse.md

@@ -0,0 +1,11 @@
+# SibApiV3Sdk::SubAccountDetailsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the sub-account user | [optional] 
+**email** | **String** | Email id of the sub-account organization | [optional] 
+**company_name** | **String** | Sub-account company name | [optional] 
+**plan_info** | [**SubAccountDetailsResponsePlanInfo**](SubAccountDetailsResponsePlanInfo.md) |  | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfo.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credits** | [**SubAccountDetailsResponsePlanInfoCredits**](SubAccountDetailsResponsePlanInfoCredits.md) |  | [optional] 
+**features** | [**SubAccountDetailsResponsePlanInfoFeatures**](SubAccountDetailsResponsePlanInfoFeatures.md) |  | [optional] 
+**plan_type** | **String** | type of the plan | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoCredits.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoCredits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sms** | **Integer** | Sms quota of the sub-account | [optional] 
+**emails** | [**SubAccountDetailsResponsePlanInfoCreditsEmails**](SubAccountDetailsResponsePlanInfoCreditsEmails.md) |  | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoCreditsEmails.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoCreditsEmails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Integer** | Quantity of email messaging limits provided | [optional] 
+**remaining** | **Integer** | Available email messaging limits for use | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoFeatures.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeatures
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**inbox** | [**SubAccountDetailsResponsePlanInfoFeaturesInbox**](SubAccountDetailsResponsePlanInfoFeaturesInbox.md) |  | [optional] 
+**landing_page** | [**SubAccountDetailsResponsePlanInfoFeaturesLandingPage**](SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md) |  | [optional] 
+**users** | [**SubAccountDetailsResponsePlanInfoFeaturesUsers**](SubAccountDetailsResponsePlanInfoFeaturesUsers.md) |  | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoFeaturesInbox.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeaturesInbox
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Integer** | Quantity of inbox provided | [optional] 
+**remaining** | **Integer** | Available inboxes for use | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoFeaturesLandingPage.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeaturesLandingPage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Integer** | Quantity of landing pages provided | [optional] 
+**remaining** | **Integer** | Available landing pages for use | [optional] 
+
+

data/docs/SubAccountDetailsResponsePlanInfoFeaturesUsers.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountDetailsResponsePlanInfoFeaturesUsers
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quantity** | **Integer** | Quantity of multi-account's provided | [optional] 
+**remaining** | **Integer** | Available multi-accounts for use | [optional] 
+
+

data/docs/SubAccountUpdatePlanRequest.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountUpdatePlanRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**credits** | [**SubAccountUpdatePlanRequestCredits**](SubAccountUpdatePlanRequestCredits.md) |  | [optional] 
+**features** | [**SubAccountUpdatePlanRequestFeatures**](SubAccountUpdatePlanRequestFeatures.md) |  | [optional] 
+
+

data/docs/SubAccountUpdatePlanRequestCredits.md

@@ -0,0 +1,8 @@
+# SibApiV3Sdk::SubAccountUpdatePlanRequestCredits
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **Integer** | Number of email credits | [optional] 
+
+

data/docs/SubAccountUpdatePlanRequestFeatures.md

@@ -0,0 +1,10 @@
+# SibApiV3Sdk::SubAccountUpdatePlanRequestFeatures
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**users** | **Integer** | Number of multi-users | [optional] 
+**landing_page** | **Integer** | Number of landing pages | [optional] 
+**inbox** | **Integer** | Number of inboxes | [optional] 
+
+

data/docs/SubAccountsResponse.md

@@ -0,0 +1,9 @@
+# SibApiV3Sdk::SubAccountsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **Integer** | Total number of subaccounts | [optional] 
+**sub_accounts** | [**Array<SubAccountsResponseSubAccounts>**](SubAccountsResponseSubAccounts.md) |  | [optional] 
+
+