notifo-io 1.0.1 → 1.1.0

data/docs/NotificationsApi.md

@@ -0,0 +1,199 @@
+# Notifo::NotificationsApi
+
+All URIs are relative to *https://notifo.easierlife.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**notifications_confirm_me**](NotificationsApi.md#notifications_confirm_me) | **POST** /api/me/notifications/handled | Confirms the user notifications for the current user.
+[**notifications_get_my_archive**](NotificationsApi.md#notifications_get_my_archive) | **GET** /api/me/notifications/archive | Query archhived user notifications of the current user.
+[**notifications_get_my_notifications**](NotificationsApi.md#notifications_get_my_notifications) | **GET** /api/me/notifications | Query user notifications of the current user.
+[**notifications_get_notifications**](NotificationsApi.md#notifications_get_notifications) | **GET** /api/apps/{appId}/users/{id}/notifications | Query user notifications.
+
+# **notifications_confirm_me**
+> notifications_confirm_me(body)
+
+Confirms the user notifications for the current user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::NotificationsApi.new
+body = Notifo::TrackNotificationDto.new # TrackNotificationDto | The request object.
+
+
+begin
+  #Confirms the user notifications for the current user.
+  api_instance.notifications_confirm_me(body)
+rescue Notifo::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_confirm_me: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**TrackNotificationDto**](TrackNotificationDto.md)| The request object. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **notifications_get_my_archive**
+> ListResponseDtoOfUserNotificationDto notifications_get_my_archive
+
+Query archhived user notifications of the current user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::NotificationsApi.new
+
+begin
+  #Query archhived user notifications of the current user.
+  result = api_instance.notifications_get_my_archive
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_get_my_archive: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListResponseDtoOfUserNotificationDto**](ListResponseDtoOfUserNotificationDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **notifications_get_my_notifications**
+> ListResponseDtoOfUserNotificationDto notifications_get_my_notifications(opts)
+
+Query user notifications of the current user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::NotificationsApi.new
+opts = { 
+  channels: ['channels_example'], # Array<String> | The active channels.
+  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
+  #Query user notifications of the current user.
+  result = api_instance.notifications_get_my_notifications(opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_get_my_notifications: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **channels** | [**Array&lt;String&gt;**](String.md)| The active channels. | [optional] 
+ **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
+
+[**ListResponseDtoOfUserNotificationDto**](ListResponseDtoOfUserNotificationDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **notifications_get_notifications**
+> ListResponseDtoOfUserNotificationDetailsDto notifications_get_notifications(app_id, id, opts)
+
+Query user notifications.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::NotificationsApi.new
+app_id = 'app_id_example' # String | The app where the user belongs to.
+id = 'id_example' # String | The user id.
+opts = { 
+  channels: ['channels_example'], # Array<String> | The active channels.
+  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
+  #Query user notifications.
+  result = api_instance.notifications_get_notifications(app_id, id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_get_notifications: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app where the user belongs to. | 
+ **id** | **String**| The user id. | 
+ **channels** | [**Array&lt;String&gt;**](String.md)| The active channels. | [optional] 
+ **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
+
+[**ListResponseDtoOfUserNotificationDetailsDto**](ListResponseDtoOfUserNotificationDetailsDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/PingApi.md

@@ -0,0 +1,48 @@
+# Notifo::PingApi
+
+All URIs are relative to *https://notifo.easierlife.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**ping_get_ping**](PingApi.md#ping_get_ping) | **GET** /ping | Get ping status of the API.
+
+# **ping_get_ping**
+> ping_get_ping
+
+Get ping status of the API.
+
+Can be used to test, if the Squidex API is alive and responding.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::PingApi.new
+
+begin
+  #Get ping status of the API.
+  api_instance.ping_get_ping
+rescue Notifo::ApiError => e
+  puts "Exception when calling PingApi->ping_get_ping: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/ProcessStatus.md

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

data/docs/ProfileDto.md

@@ -1,32 +1,15 @@
 # Notifo::ProfileDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **full_name** | **String** | The full name of the user. |  |
-| **email_address** | **String** | The email of the user. |  |
-| **phone_number** | **String** | The phone number. | [optional] |
-| **preferred_language** | **String** | The preferred language of the user. | [optional] |
-| **preferred_timezone** | **String** | The timezone of the user. | [optional] |
-| **supported_languages** | **Array<String>** | The supported languages. |  |
-| **supported_timezones** | **Array<String>** | The supported timezones. |  |
-| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::ProfileDto.new(
-  full_name: null,
-  email_address: null,
-  phone_number: null,
-  preferred_language: null,
-  preferred_timezone: null,
-  supported_languages: null,
-  supported_timezones: null,
-  settings: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**full_name** | **String** | The full name of the user. | 
+**email_address** | **String** | The email of the user. | 
+**phone_number** | **String** | The phone number. | [optional] 
+**allowed_topics** | **Array<String>** | The allowed Topics. | [optional] 
+**preferred_language** | **String** | The preferred language of the user. | [optional] 
+**preferred_timezone** | **String** | The timezone of the user. | [optional] 
+**supported_languages** | **Array<String>** | The supported languages. | 
+**supported_timezones** | **Array<String>** | The supported timezones. | 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | 
 

data/docs/PublishDto.md

@@ -1,36 +1,18 @@
 # Notifo::PublishDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **topic** | **String** | The topic path. |  |
-| **creator_id** | **String** | A custom id to identity the creator. | [optional] |
-| **template_code** | **String** | The template code. | [optional] |
-| **data** | **String** | Additional user defined data. | [optional] |
-| **timestamp** | **Time** | A custom timestamp. | [optional] |
-| **preformatted** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | [optional] |
-| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | The notification settings. | [optional] |
-| **properties** | **Hash<String, String>** |  | [optional] |
-| **scheduling** | [**SchedulingDto**](SchedulingDto.md) |  | [optional] |
-| **silent** | **Boolean** | True when silent. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::PublishDto.new(
-  topic: null,
-  creator_id: null,
-  template_code: null,
-  data: null,
-  timestamp: null,
-  preformatted: null,
-  settings: null,
-  properties: null,
-  scheduling: null,
-  silent: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**topic** | **String** | The topic path. | 
+**creator_id** | **String** | A custom id to identity the creator. | [optional] 
+**template_code** | **String** | The template code. | [optional] 
+**data** | **String** | Additional user defined data. | [optional] 
+**timestamp** | **DateTime** | A custom timestamp. | [optional] 
+**preformatted** | [**NotificationFormattingDto**](NotificationFormattingDto.md) |  | [optional] 
+**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | The notification settings. | [optional] 
+**properties** | [**NotificationProperties**](NotificationProperties.md) |  | [optional] 
+**scheduling** | [**SchedulingDto**](SchedulingDto.md) |  | [optional] 
+**silent** | **BOOLEAN** | True when silent. | [optional] 
+**test** | **BOOLEAN** | True when using test integrations. | [optional] 
+**time_to_live_in_seconds** | **Integer** | The time to live in seconds. | [optional] 
 

data/docs/PublishManyDto.md

@@ -1,18 +1,7 @@
 # Notifo::PublishManyDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **requests** | [**Array<PublishDto>**](PublishDto.md) | The publish requests. |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::PublishManyDto.new(
-  requests: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requests** | [**Array<PublishDto>**](PublishDto.md) | The publish requests. | 
 

data/docs/RegisterMobileTokenDto.md

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

data/docs/ResizeMode.md

@@ -1,15 +1,6 @@
 # Notifo::ResizeMode
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::ResizeMode.new()
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
 

data/docs/SchedulingDto.md

@@ -1,24 +1,10 @@
 # Notifo::SchedulingDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **type** | [**SchedulingType**](SchedulingType.md) |  | [optional] |
-| **next_week_day** | [**IsoDayOfWeek**](IsoDayOfWeek.md) |  | [optional] |
-| **date** | **Date** | The scheduling date. | [optional] |
-| **time** | **String** | The scheduling time. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::SchedulingDto.new(
-  type: null,
-  next_week_day: null,
-  date: null,
-  time: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**SchedulingType**](SchedulingType.md) |  | [optional] 
+**next_week_day** | [**IsoDayOfWeek**](IsoDayOfWeek.md) |  | [optional] 
+**date** | **Date** | The scheduling date. | [optional] 
+**time** | **String** | The scheduling time. | [optional] 
 

data/docs/SchedulingType.md

@@ -1,15 +1,6 @@
 # Notifo::SchedulingType
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::SchedulingType.new()
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
 

data/docs/SmsTemplateDto.md

@@ -0,0 +1,7 @@
+# Notifo::SmsTemplateDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The template text. | 
+