notifo-io 1.0.0.pre → 1.0.1.2

data/docs/MediaDto.md

@@ -1,28 +1,13 @@
 # Notifo::MediaDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **mime_type** | **String** | The mime type. | [optional] |
-| **file_name** | **String** | The file name. | [optional] |
-| **file_info** | **String** | Generated information about the file. | [optional] |
-| **file_size** | **Integer** | The size of the media file. | [optional] |
-| **type** | [**OneOfMediaType**](OneOfMediaType.md) | The type of the media. | [optional] |
-| **metadata** | [**OneOfmap**](OneOfmap.md) | Metadata about the media. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::MediaDto.new(
-  mime_type: null,
-  file_name: null,
-  file_info: null,
-  file_size: null,
-  type: null,
-  metadata: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mime_type** | **String** | The mime type. | 
+**file_name** | **String** | The file name. | 
+**file_info** | **String** | Generated information about the file. | 
+**file_size** | **Integer** | The size of the media file. | 
+**url** | **String** | The url to the media item. | 
+**type** | [**MediaType**](MediaType.md) |  | 
+**metadata** | [**MediaMetadata**](MediaMetadata.md) |  | 
 

data/docs/MediaMetadata.md

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

data/docs/MediaType.md

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

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_token**](MobilePushApi.md#mobile_push_delete_token) | **DELETE** /api/me/mobilepush/{token} | Deletes a mobile push token for the current user.
+[**mobile_push_get_tokens**](MobilePushApi.md#mobile_push_get_tokens) | **GET** /api/me/mobilepush | Returns the mobile push tokens.
+[**mobile_push_post_token**](MobilePushApi.md#mobile_push_post_token) | **POST** /api/me/mobilepush | Register a mobile push token for the current user.
+
+# **mobile_push_delete_token**
+> mobile_push_delete_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_token(token)
+rescue Notifo::ApiError => e
+  puts "Exception when calling MobilePushApi->mobile_push_delete_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_tokens**
+> ListResponseDtoOfMobilePushTokenDto mobile_push_get_tokens
+
+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_tokens
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling MobilePushApi->mobile_push_get_tokens: #{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_token**
+> mobile_push_post_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_token(body)
+rescue Notifo::ApiError => e
+  puts "Exception when calling MobilePushApi->mobile_push_post_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,8 @@
+# Notifo::MobilePushTokenDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**token** | **String** | The device token. | 
+**device_type** | [**MobileDeviceType**](MobileDeviceType.md) |  | [optional] 
+

data/docs/NotificationDto.md

@@ -0,0 +1,21 @@
+# Notifo::NotificationDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the notification. | 
+**subject** | **String** | The subject of the notification in the language of the user. | 
+**silent** | **BOOLEAN** | True when the notification is silent. | 
+**is_confirmed** | **BOOLEAN** | True when the notification has been confirmed. | 
+**is_seen** | **BOOLEAN** | True when the notification has been seen. | 
+**created** | **DateTime** | The timestamp when the notification has been created. | 
+**body** | **String** | The optional body text. | [optional] 
+**image_small** | **String** | The optional link to the small image. | [optional] 
+**image_large** | **String** | The optional link to the large image. | [optional] 
+**tracking_url** | **String** | The tracking url that needs to be invoked to mark the notifiation as seen. | [optional] 
+**link_url** | **String** | An optional link. | [optional] 
+**link_text** | **String** | The link text. | [optional] 
+**confirm_text** | **String** | The text for the confirm button. | [optional] 
+**confirm_url** | **String** | The tracking url that needs to be invoked to mark the notifiation as confirmed. | [optional] 
+**data** | **String** | Optional data, usually a json object. | [optional] 
+

data/docs/NotificationFormattingDto.md

@@ -1,32 +1,14 @@
 # Notifo::NotificationFormattingDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **subject** | [**OneOfmap**](OneOfmap.md) | The required subject with one entry per language. | [optional] |
-| **body** | [**OneOfmap**](OneOfmap.md) | The optional body with one entry per language. | [optional] |
-| **confirm_text** | [**OneOfmap**](OneOfmap.md) | The optional confirm text with one entry per language. | [optional] |
-| **image_small** | [**OneOfmap**](OneOfmap.md) | The optional small image with one entry per language. | [optional] |
-| **image_large** | [**OneOfmap**](OneOfmap.md) | The optional large image with one entry per language. | [optional] |
-| **link_url** | [**OneOfmap**](OneOfmap.md) | The optional link url with one entry per language. | [optional] |
-| **link_text** | [**OneOfmap**](OneOfmap.md) | The optional link name with one entry per language. | [optional] |
-| **confirm_mode** | [**OneOfConfirmMode**](OneOfConfirmMode.md) | The confirmation mode. | [optional] |
-
-## 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) |  | 
 

data/docs/NotificationSend.md

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

data/docs/NotificationSettingDto.md

@@ -1,20 +1,8 @@
 # Notifo::NotificationSettingDto
 
 ## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **_send** | **Boolean** | True or false to send the notification for the channel. | [optional] |
-| **delay_in_seconds** | **Integer** | The delay in seconds. | [optional] |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::NotificationSettingDto.new(
-  _send: null,
-  delay_in_seconds: null
-)
-```
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**send** | [**NotificationSend**](NotificationSend.md) |  | 
+**delay_in_seconds** | **Integer** | The delay in seconds. | [optional] 
 

data/docs/NotificationsApi.md

@@ -0,0 +1,141 @@
+# Notifo::NotificationsApi
+
+All URIs are relative to *https://notifo.easierlife.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**notifications_confirm**](NotificationsApi.md#notifications_confirm) | **POST** /api/me/notifications/handled | Confirms the user notifications for the current user.
+[**notifications_get_archive**](NotificationsApi.md#notifications_get_archive) | **GET** /api/me/notifications/archive | Query archhived user notifications of the current user.
+[**notifications_get_notifications**](NotificationsApi.md#notifications_get_notifications) | **GET** /api/me/notifications | Query user notifications of the current user.
+
+# **notifications_confirm**
+> notifications_confirm(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(body)
+rescue Notifo::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_confirm: #{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_archive**
+> ListResponseDtoOfNotificationDto notifications_get_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_archive
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_get_archive: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListResponseDtoOfNotificationDto**](ListResponseDtoOfNotificationDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **notifications_get_notifications**
+> ListResponseDtoOfNotificationDto notifications_get_notifications(opts)
+
+Query user notifications of the current user.
+
+### Example
+```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::NotificationsApi.new
+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
+  #Query user notifications of the current user.
+  result = api_instance.notifications_get_notifications(opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Exception when calling NotificationsApi->notifications_get_notifications: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+[**ListResponseDtoOfNotificationDto**](ListResponseDtoOfNotificationDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+