notifo-io 1.0.1 → 1.1.0

data/docs/MessagingTemplatesApi.md

@@ -0,0 +1,394 @@
+# Notifo::MessagingTemplatesApi
+
+All URIs are relative to *https://notifo.easierlife.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**messaging_templates_delete_template**](MessagingTemplatesApi.md#messaging_templates_delete_template) | **DELETE** /api/apps/{appId}/messaging-templates/{id} | Delete a channel template.
+[**messaging_templates_delete_template_language**](MessagingTemplatesApi.md#messaging_templates_delete_template_language) | **DELETE** /api/apps/{appId}/messaging-templates/{id}/{language} | Delete a language channel template.
+[**messaging_templates_get_template**](MessagingTemplatesApi.md#messaging_templates_get_template) | **GET** /api/apps/{appId}/messaging-templates/{id} | Get the channel template by id.
+[**messaging_templates_get_templates**](MessagingTemplatesApi.md#messaging_templates_get_templates) | **GET** /api/apps/{appId}/messaging-templates | Get the channel templates.
+[**messaging_templates_post_template**](MessagingTemplatesApi.md#messaging_templates_post_template) | **POST** /api/apps/{appId}/messaging-templates | Create a channel template.
+[**messaging_templates_post_template_language**](MessagingTemplatesApi.md#messaging_templates_post_template_language) | **POST** /api/apps/{appId}/messaging-templates/{id} | Create an app template language.
+[**messaging_templates_put_template**](MessagingTemplatesApi.md#messaging_templates_put_template) | **PUT** /api/apps/{appId}/messaging-templates/{id} | Update an app template.
+[**messaging_templates_put_template_language**](MessagingTemplatesApi.md#messaging_templates_put_template_language) | **PUT** /api/apps/{appId}/messaging-templates/{id}/{language} | Update a channel template language.
+
+# **messaging_templates_delete_template**
+> messaging_templates_delete_template(app_id, id)
+
+Delete a channel template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MessagingTemplatesApi.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
+  #Delete a channel template.
+  api_instance.messaging_templates_delete_template(app_id, id)
+rescue Notifo::ApiError => e
+  puts "Exception when calling MessagingTemplatesApi->messaging_templates_delete_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
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **messaging_templates_delete_template_language**
+> messaging_templates_delete_template_language(app_id, id, language)
+
+Delete a language channel template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MessagingTemplatesApi.new
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+language = 'language_example' # String | The language.
+
+
+begin
+  #Delete a language channel template.
+  api_instance.messaging_templates_delete_template_language(app_id, id, language)
+rescue Notifo::ApiError => e
+  puts "Exception when calling MessagingTemplatesApi->messaging_templates_delete_template_language: #{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. | 
+ **language** | **String**| The language. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **messaging_templates_get_template**
+> ChannelTemplateDetailsDtoOfMessagingTemplateDto messaging_templates_get_template(app_id, id)
+
+Get the channel template by id.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MessagingTemplatesApi.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.messaging_templates_get_template(app_id, id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling MessagingTemplatesApi->messaging_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
+
+[**ChannelTemplateDetailsDtoOfMessagingTemplateDto**](ChannelTemplateDetailsDtoOfMessagingTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **messaging_templates_get_templates**
+> ListResponseDtoOfChannelTemplateDto messaging_templates_get_templates(app_id, opts)
+
+Get the channel templates.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MessagingTemplatesApi.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.messaging_templates_get_templates(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling MessagingTemplatesApi->messaging_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
+
+
+
+# **messaging_templates_post_template**
+> ChannelTemplateDetailsDtoOfMessagingTemplateDto messaging_templates_post_template(bodyapp_id)
+
+Create a channel template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MessagingTemplatesApi.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.messaging_templates_post_template(bodyapp_id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling MessagingTemplatesApi->messaging_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
+
+[**ChannelTemplateDetailsDtoOfMessagingTemplateDto**](ChannelTemplateDetailsDtoOfMessagingTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **messaging_templates_post_template_language**
+> MessagingTemplateDto messaging_templates_post_template_language(bodyapp_idid)
+
+Create an app template language.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MessagingTemplatesApi.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.
+id = 'id_example' # String | The template ID.
+
+
+begin
+  #Create an app template language.
+  result = api_instance.messaging_templates_post_template_language(bodyapp_idid)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling MessagingTemplatesApi->messaging_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. | 
+ **id** | **String**| The template ID. | 
+
+### Return type
+
+[**MessagingTemplateDto**](MessagingTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **messaging_templates_put_template**
+> messaging_templates_put_template(bodyapp_idid)
+
+Update an app template.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MessagingTemplatesApi.new
+body = Notifo::UpdateChannelTemplateDtoOfMessagingTemplateDto.new # UpdateChannelTemplateDtoOfMessagingTemplateDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+
+
+begin
+  #Update an app template.
+  api_instance.messaging_templates_put_template(bodyapp_idid)
+rescue Notifo::ApiError => e
+  puts "Exception when calling MessagingTemplatesApi->messaging_templates_put_template: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**UpdateChannelTemplateDtoOfMessagingTemplateDto**](UpdateChannelTemplateDtoOfMessagingTemplateDto.md)| The request object. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **id** | **String**| The template ID. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **messaging_templates_put_template_language**
+> messaging_templates_put_template_language(bodyapp_ididlanguage)
+
+Update a channel template language.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MessagingTemplatesApi.new
+body = Notifo::MessagingTemplateDto.new # MessagingTemplateDto | The request object.
+app_id = 'app_id_example' # String | The id of the app where the templates belong to.
+id = 'id_example' # String | The template ID.
+language = 'language_example' # String | The language.
+
+
+begin
+  #Update a channel template language.
+  api_instance.messaging_templates_put_template_language(bodyapp_ididlanguage)
+rescue Notifo::ApiError => e
+  puts "Exception when calling MessagingTemplatesApi->messaging_templates_put_template_language: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**MessagingTemplateDto**](MessagingTemplateDto.md)| The request object. | 
+ **app_id** | **String**| The id of the app where the templates belong to. | 
+ **id** | **String**| The template ID. | 
+ **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/MobileDeviceType.md

@@ -0,0 +1,6 @@
+# Notifo::MobileDeviceType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/MobilePushApi.md

@@ -0,0 +1,135 @@
+# Notifo::MobilePushApi
+
+All URIs are relative to *https://notifo.easierlife.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**mobile_push_delete_my_token**](MobilePushApi.md#mobile_push_delete_my_token) | **DELETE** /api/me/mobilepush/{token} | Deletes a mobile push token for the current user.
+[**mobile_push_get_my_token**](MobilePushApi.md#mobile_push_get_my_token) | **GET** /api/me/mobilepush | Returns the mobile push tokens.
+[**mobile_push_post_my_token**](MobilePushApi.md#mobile_push_post_my_token) | **POST** /api/me/mobilepush | Register a mobile push token for the current user.
+
+# **mobile_push_delete_my_token**
+> mobile_push_delete_my_token(token)
+
+Deletes a mobile push token for the current user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MobilePushApi.new
+token = 'token_example' # String | The token to remove.
+
+
+begin
+  #Deletes a mobile push token for the current user.
+  api_instance.mobile_push_delete_my_token(token)
+rescue Notifo::ApiError => e
+  puts "Exception when calling MobilePushApi->mobile_push_delete_my_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **token** | **String**| The token to remove. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **mobile_push_get_my_token**
+> ListResponseDtoOfMobilePushTokenDto mobile_push_get_my_token
+
+Returns the mobile push tokens.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MobilePushApi.new
+
+begin
+  #Returns the mobile push tokens.
+  result = api_instance.mobile_push_get_my_token
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling MobilePushApi->mobile_push_get_my_token: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListResponseDtoOfMobilePushTokenDto**](ListResponseDtoOfMobilePushTokenDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **mobile_push_post_my_token**
+> mobile_push_post_my_token(body)
+
+Register a mobile push token for the current user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::MobilePushApi.new
+body = Notifo::RegisterMobileTokenDto.new # RegisterMobileTokenDto | The request object.
+
+
+begin
+  #Register a mobile push token for the current user.
+  api_instance.mobile_push_post_my_token(body)
+rescue Notifo::ApiError => e
+  puts "Exception when calling MobilePushApi->mobile_push_post_my_token: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**RegisterMobileTokenDto**](RegisterMobileTokenDto.md)| The request object. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/MobilePushTokenDto.md

@@ -0,0 +1,9 @@
+# Notifo::MobilePushTokenDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **String** | The token. | 
+**device_type** | [**MobileDeviceType**](MobileDeviceType.md) |  | 
+**last_wakeup** | **DateTime** | The last time the device was woken up. | [optional] 
+

data/docs/MobilePushTokenDto2.md

@@ -0,0 +1,8 @@
+# Notifo::MobilePushTokenDto2
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **String** | The device token. | 
+**device_type** | [**MobileDeviceType**](MobileDeviceType.md) |  | [optional] 
+

data/docs/NotificationFormattingDto.md

@@ -1,32 +1,14 @@
 # Notifo::NotificationFormattingDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **subject** | **Hash<String, String>** |  |  |
-| **body** | **Hash<String, String>** |  | [optional] |
-| **confirm_text** | **Hash<String, String>** |  | [optional] |
-| **image_small** | **Hash<String, String>** |  | [optional] |
-| **image_large** | **Hash<String, String>** |  | [optional] |
-| **link_url** | **Hash<String, String>** |  | [optional] |
-| **link_text** | **Hash<String, String>** |  | [optional] |
-| **confirm_mode** | [**ConfirmMode**](ConfirmMode.md) |  |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::NotificationFormattingDto.new(
-  subject: null,
-  body: null,
-  confirm_text: null,
-  image_small: null,
-  image_large: null,
-  link_url: null,
-  link_text: null,
-  confirm_mode: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**subject** | [**LocalizedText**](LocalizedText.md) |  | 
+**body** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**confirm_text** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**image_small** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**image_large** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**link_url** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**link_text** | [**LocalizedText**](LocalizedText.md) |  | [optional] 
+**confirm_mode** | [**ConfirmMode**](ConfirmMode.md) |  | [optional] 
 

data/docs/NotificationProperties.md

@@ -0,0 +1,6 @@
+# Notifo::NotificationProperties
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+