notifo-io 1.0.1.2 → 1.2.0

data/docs/SmsTemplatesApi.md

@@ -0,0 +1,394 @@
+# Notifo::SmsTemplatesApi
+
+All URIs are relative to *https://notifo-dev.easierlife.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**sms_templates_delete_template**](SmsTemplatesApi.md#sms_templates_delete_template) | **DELETE** /api/apps/{appId}/sms-templates/{code} | Delete a channel template.
+[**sms_templates_delete_template_language**](SmsTemplatesApi.md#sms_templates_delete_template_language) | **DELETE** /api/apps/{appId}/sms-templates/{code}/{language} | Delete a language channel template.
+[**sms_templates_get_template**](SmsTemplatesApi.md#sms_templates_get_template) | **GET** /api/apps/{appId}/sms-templates/{id} | Get the channel template by id.
+[**sms_templates_get_templates**](SmsTemplatesApi.md#sms_templates_get_templates) | **GET** /api/apps/{appId}/sms-templates | Get the channel templates.
+[**sms_templates_post_template**](SmsTemplatesApi.md#sms_templates_post_template) | **POST** /api/apps/{appId}/sms-templates | Create a channel template.
+[**sms_templates_post_template_language**](SmsTemplatesApi.md#sms_templates_post_template_language) | **POST** /api/apps/{appId}/sms-templates/{code} | Create an app template language.
+[**sms_templates_put_template**](SmsTemplatesApi.md#sms_templates_put_template) | **PUT** /api/apps/{appId}/sms-templates/{code} | Update an app template.
+[**sms_templates_put_template_language**](SmsTemplatesApi.md#sms_templates_put_template_language) | **PUT** /api/apps/{appId}/sms-templates/{code}/{language} | Update a channel template language.
+
+# **sms_templates_delete_template**
+> sms_templates_delete_template(app_id, code)
+
+Delete a channel template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SmsTemplatesApi.new
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+code = 'code_example' # String | The template ID.
+
+
+begin
+  #Delete a channel template.
+  api_instance.sms_templates_delete_template(app_id, code)
+rescue Notifo::ApiError => e
+  puts "Exception when calling SmsTemplatesApi->sms_templates_delete_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **code** | **String**| The template ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **sms_templates_delete_template_language**
+> sms_templates_delete_template_language(app_id, code, language)
+
+Delete a language channel template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SmsTemplatesApi.new
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+code = 'code_example' # String | The template ID.
+language = 'language_example' # String | The language.
+
+
+begin
+  #Delete a language channel template.
+  api_instance.sms_templates_delete_template_language(app_id, code, language)
+rescue Notifo::ApiError => e
+  puts "Exception when calling SmsTemplatesApi->sms_templates_delete_template_language: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **code** | **String**| The template ID. | 
+ **language** | **String**| The language. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **sms_templates_get_template**
+> ChannelTemplateDetailsDtoOfSmsTemplateDto sms_templates_get_template(app_id, id)
+
+Get the channel template by id.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SmsTemplatesApi.new
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+
+
+begin
+  #Get the channel template by id.
+  result = api_instance.sms_templates_get_template(app_id, id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling SmsTemplatesApi->sms_templates_get_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **id** | **String**| The template ID. | 
+
+### Return type
+
+[**ChannelTemplateDetailsDtoOfSmsTemplateDto**](ChannelTemplateDetailsDtoOfSmsTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **sms_templates_get_templates**
+> ListResponseDtoOfChannelTemplateDto sms_templates_get_templates(app_id, opts)
+
+Get the channel templates.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SmsTemplatesApi.new
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+opts = { 
+  query: 'query_example', # String | The optional query to search for items.
+  take: 56, # Integer | The number of items to return.
+  skip: 56 # Integer | The number of items to skip.
+}
+
+begin
+  #Get the channel templates.
+  result = api_instance.sms_templates_get_templates(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling SmsTemplatesApi->sms_templates_get_templates: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **query** | **String**| The optional query to search for items. | [optional] 
+ **take** | **Integer**| The number of items to return. | [optional] 
+ **skip** | **Integer**| The number of items to skip. | [optional] 
+
+### Return type
+
+[**ListResponseDtoOfChannelTemplateDto**](ListResponseDtoOfChannelTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **sms_templates_post_template**
+> ChannelTemplateDetailsDtoOfSmsTemplateDto sms_templates_post_template(bodyapp_id)
+
+Create a channel template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SmsTemplatesApi.new
+body = Notifo::CreateChannelTemplateDto.new # CreateChannelTemplateDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+
+
+begin
+  #Create a channel template.
+  result = api_instance.sms_templates_post_template(bodyapp_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling SmsTemplatesApi->sms_templates_post_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateChannelTemplateDto**](CreateChannelTemplateDto.md)| The request object. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+
+### Return type
+
+[**ChannelTemplateDetailsDtoOfSmsTemplateDto**](ChannelTemplateDetailsDtoOfSmsTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_templates_post_template_language**
+> SmsTemplateDto sms_templates_post_template_language(bodyapp_idcode)
+
+Create an app template language.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SmsTemplatesApi.new
+body = Notifo::CreateChannelTemplateLanguageDto.new # CreateChannelTemplateLanguageDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+code = 'code_example' # String | The template code.
+
+
+begin
+  #Create an app template language.
+  result = api_instance.sms_templates_post_template_language(bodyapp_idcode)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling SmsTemplatesApi->sms_templates_post_template_language: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**CreateChannelTemplateLanguageDto**](CreateChannelTemplateLanguageDto.md)| The request object. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **code** | **String**| The template code. | 
+
+### Return type
+
+[**SmsTemplateDto**](SmsTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_templates_put_template**
+> sms_templates_put_template(bodyapp_idcode)
+
+Update an app template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SmsTemplatesApi.new
+body = Notifo::UpdateChannelTemplateDtoOfSmsTemplateDto.new # UpdateChannelTemplateDtoOfSmsTemplateDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+code = 'code_example' # String | The template code.
+
+
+begin
+  #Update an app template.
+  api_instance.sms_templates_put_template(bodyapp_idcode)
+rescue Notifo::ApiError => e
+  puts "Exception when calling SmsTemplatesApi->sms_templates_put_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpdateChannelTemplateDtoOfSmsTemplateDto**](UpdateChannelTemplateDtoOfSmsTemplateDto.md)| The request object. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **code** | **String**| The template code. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **sms_templates_put_template_language**
+> sms_templates_put_template_language(bodyapp_idcodelanguage)
+
+Update a channel template language.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::SmsTemplatesApi.new
+body = Notifo::SmsTemplateDto.new # SmsTemplateDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+code = 'code_example' # String | The template code.
+language = 'language_example' # String | The language.
+
+
+begin
+  #Update a channel template language.
+  api_instance.sms_templates_put_template_language(bodyapp_idcodelanguage)
+rescue Notifo::ApiError => e
+  puts "Exception when calling SmsTemplatesApi->sms_templates_put_template_language: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**SmsTemplateDto**](SmsTemplateDto.md)| The request object. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **code** | **String**| The template code. | 
+ **language** | **String**| The language. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/SubscribeDto.md

@@ -0,0 +1,8 @@
+# Notifo::SubscribeDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**topic_prefix** | **String** | The topic to add. | 
+**topic_settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | [optional] 
+

data/docs/SubscribeManyDto.md

@@ -0,0 +1,8 @@
+# Notifo::SubscribeManyDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subscribe** | [**Array<SubscribeDto>**](SubscribeDto.md) | A list of topics to create. | [optional] 
+**unsubscribe** | **Array<String>** | A list of topics to unsubscribe from. | [optional] 
+

data/docs/SubscriptionDto.md

@@ -4,5 +4,5 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **topic_prefix** | **String** | The topic to add. | 
-**topic_settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] 
+**topic_settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | 
 

data/docs/SystemUserDto.md

@@ -0,0 +1,11 @@
+# Notifo::SystemUserDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the user. | 
+**email** | **String** | The email of the user. Unique value. | 
+**is_locked** | **BOOLEAN** | Determines if the user is locked. | 
+**roles** | **Array<String>** | Additional role for the user. | 
+**can_update** | **BOOLEAN** | True if the user can be updated. | [optional] 
+