notifo-io 1.0.1 → 1.1.0

data/docs/MediaApi.md

@@ -1,64 +1,44 @@
 # Notifo::MediaApi
 
-All URIs are relative to *http://localhost*
+All URIs are relative to *https://notifo.easierlife.com*
 
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**media_delete**](MediaApi.md#media_delete) | **DELETE** /api/apps/{appId}/media/{fileName} | Delete a media. |
-| [**media_download**](MediaApi.md#media_download) | **GET** /api/apps/{appId}/media/{fileName} | Download a media object. |
-| [**media_download2**](MediaApi.md#media_download2) | **GET** /api/assets/{appId}/{fileName} | Download a media object. |
-| [**media_get_medias**](MediaApi.md#media_get_medias) | **GET** /api/apps/{appId}/media | Query media items. |
-| [**media_upload**](MediaApi.md#media_upload) | **POST** /api/apps/{appId}/media | Upload a media object. |
-
-
-## media_delete
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**media_delete**](MediaApi.md#media_delete) | **DELETE** /api/apps/{appId}/media/{fileName} | Delete a media.
+[**media_download**](MediaApi.md#media_download) | **GET** /api/apps/{appId}/media/{fileName} | Download a media object.
+[**media_download2**](MediaApi.md#media_download2) | **GET** /api/assets/{appId}/{fileName} | Download a media object.
+[**media_get_medias**](MediaApi.md#media_get_medias) | **GET** /api/apps/{appId}/media | Query media items.
+[**media_upload**](MediaApi.md#media_upload) | **POST** /api/apps/{appId}/media | Upload a media object.
 
+# **media_delete**
 > media_delete(app_id, file_name)
 
 Delete a media.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::MediaApi.new
 app_id = 'app_id_example' # String | The app id where the media belongs to.
 file_name = 'file_name_example' # String | The file name of the media.
 
-begin
-  # Delete a media.
-  api_instance.media_delete(app_id, file_name)
-rescue Notifo::ApiError => e
-  puts "Error when calling MediaApi->media_delete: #{e}"
-end
-```
-
-#### Using the media_delete_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> media_delete_with_http_info(app_id, file_name)
 
-```ruby
 begin
-  # Delete a media.
-  data, status_code, headers = api_instance.media_delete_with_http_info(app_id, file_name)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
+  #Delete a media.
+  api_instance.media_delete(app_id, file_name)
 rescue Notifo::ApiError => e
-  puts "Error when calling MediaApi->media_delete_with_http_info: #{e}"
+  puts "Exception when calling MediaApi->media_delete: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app id where the media belongs to. |  |
-| **file_name** | **String** | The file name of the media. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app id where the media belongs to. | 
+ **file_name** | **String**| The file name of the media. | 
 
 ### Return type
 
@@ -70,85 +50,66 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## media_download
 
-> File media_download(app_id, file_name, opts)
+# **media_download**
+> String media_download(app_id, file_name, opts)
 
 Download a media object.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::MediaApi.new
 app_id = 'app_id_example' # String | The app id where the media belongs to.
 file_name = 'file_name_example' # String | The name of the media to download.
-opts = {
+opts = { 
   cache: 789, # Integer | The cache duration.
   download: 56, # Integer | Set it to 1 to create a download response.
   width: 56, # Integer | The target width when an image.
   height: 56, # Integer | The target height when an image.
   quality: 56, # Integer | The target quality when an image.
   preset: 'preset_example', # String | A preset dimension.
-  mode: Notifo::ResizeMode::CROP, # ResizeMode | The resize mode.
+  mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
   focus_x: 3.4, # Float | The x position of the focues point.
   focus_y: 3.4, # Float | The y position of the focues point.
-  force: true # Boolean | True to resize it and clear the cache.
+  force: true # BOOLEAN | True to resize it and clear the cache.
 }
 
 begin
-  # Download a media object.
+  #Download a media object.
   result = api_instance.media_download(app_id, file_name, opts)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling MediaApi->media_download: #{e}"
-end
-```
-
-#### Using the media_download_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(File, Integer, Hash)> media_download_with_http_info(app_id, file_name, opts)
-
-```ruby
-begin
-  # Download a media object.
-  data, status_code, headers = api_instance.media_download_with_http_info(app_id, file_name, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => File
-rescue Notifo::ApiError => e
-  puts "Error when calling MediaApi->media_download_with_http_info: #{e}"
+  puts "Exception when calling MediaApi->media_download: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app id where the media belongs to. |  |
-| **file_name** | **String** | The name of the media to download. |  |
-| **cache** | **Integer** | The cache duration. | [optional] |
-| **download** | **Integer** | Set it to 1 to create a download response. | [optional] |
-| **width** | **Integer** | The target width when an image. | [optional] |
-| **height** | **Integer** | The target height when an image. | [optional] |
-| **quality** | **Integer** | The target quality when an image. | [optional] |
-| **preset** | **String** | A preset dimension. | [optional] |
-| **mode** | [**ResizeMode**](.md) | The resize mode. | [optional] |
-| **focus_x** | **Float** | The x position of the focues point. | [optional] |
-| **focus_y** | **Float** | The y position of the focues point. | [optional] |
-| **force** | **Boolean** | True to resize it and clear the cache. | [optional] |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app id where the media belongs to. | 
+ **file_name** | **String**| The name of the media to download. | 
+ **cache** | **Integer**| The cache duration. | [optional] 
+ **download** | **Integer**| Set it to 1 to create a download response. | [optional] 
+ **width** | **Integer**| The target width when an image. | [optional] 
+ **height** | **Integer**| The target height when an image. | [optional] 
+ **quality** | **Integer**| The target quality when an image. | [optional] 
+ **preset** | **String**| A preset dimension. | [optional] 
+ **mode** | [**ResizeMode**](.md)| The resize mode. | [optional] 
+ **focus_x** | **Float**| The x position of the focues point. | [optional] 
+ **focus_y** | **Float**| The y position of the focues point. | [optional] 
+ **force** | **BOOLEAN**| True to resize it and clear the cache. | [optional] 
 
 ### Return type
 
-**File**
+**String**
 
 ### Authorization
 
@@ -156,85 +117,66 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/octet-stream, application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/octet-stream, application/json
 
 
-## media_download2
 
-> File media_download2(app_id, file_name, opts)
+# **media_download2**
+> String media_download2(app_id, file_name, opts)
 
 Download a media object.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::MediaApi.new
 app_id = 'app_id_example' # String | The app id where the media belongs to.
 file_name = 'file_name_example' # String | The name of the media to download.
-opts = {
+opts = { 
   cache: 789, # Integer | The cache duration.
   download: 56, # Integer | Set it to 1 to create a download response.
   width: 56, # Integer | The target width when an image.
   height: 56, # Integer | The target height when an image.
   quality: 56, # Integer | The target quality when an image.
   preset: 'preset_example', # String | A preset dimension.
-  mode: Notifo::ResizeMode::CROP, # ResizeMode | The resize mode.
+  mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
   focus_x: 3.4, # Float | The x position of the focues point.
   focus_y: 3.4, # Float | The y position of the focues point.
-  force: true # Boolean | True to resize it and clear the cache.
+  force: true # BOOLEAN | True to resize it and clear the cache.
 }
 
 begin
-  # Download a media object.
+  #Download a media object.
   result = api_instance.media_download2(app_id, file_name, opts)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling MediaApi->media_download2: #{e}"
-end
-```
-
-#### Using the media_download2_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(File, Integer, Hash)> media_download2_with_http_info(app_id, file_name, opts)
-
-```ruby
-begin
-  # Download a media object.
-  data, status_code, headers = api_instance.media_download2_with_http_info(app_id, file_name, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => File
-rescue Notifo::ApiError => e
-  puts "Error when calling MediaApi->media_download2_with_http_info: #{e}"
+  puts "Exception when calling MediaApi->media_download2: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app id where the media belongs to. |  |
-| **file_name** | **String** | The name of the media to download. |  |
-| **cache** | **Integer** | The cache duration. | [optional] |
-| **download** | **Integer** | Set it to 1 to create a download response. | [optional] |
-| **width** | **Integer** | The target width when an image. | [optional] |
-| **height** | **Integer** | The target height when an image. | [optional] |
-| **quality** | **Integer** | The target quality when an image. | [optional] |
-| **preset** | **String** | A preset dimension. | [optional] |
-| **mode** | [**ResizeMode**](.md) | The resize mode. | [optional] |
-| **focus_x** | **Float** | The x position of the focues point. | [optional] |
-| **focus_y** | **Float** | The y position of the focues point. | [optional] |
-| **force** | **Boolean** | True to resize it and clear the cache. | [optional] |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app id where the media belongs to. | 
+ **file_name** | **String**| The name of the media to download. | 
+ **cache** | **Integer**| The cache duration. | [optional] 
+ **download** | **Integer**| Set it to 1 to create a download response. | [optional] 
+ **width** | **Integer**| The target width when an image. | [optional] 
+ **height** | **Integer**| The target height when an image. | [optional] 
+ **quality** | **Integer**| The target quality when an image. | [optional] 
+ **preset** | **String**| A preset dimension. | [optional] 
+ **mode** | [**ResizeMode**](.md)| The resize mode. | [optional] 
+ **focus_x** | **Float**| The x position of the focues point. | [optional] 
+ **focus_y** | **Float**| The y position of the focues point. | [optional] 
+ **force** | **BOOLEAN**| True to resize it and clear the cache. | [optional] 
 
 ### Return type
 
-**File**
+**String**
 
 ### Authorization
 
@@ -242,65 +184,46 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/octet-stream, application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/octet-stream, application/json
 
 
-## media_get_medias
 
-> <ListResponseDtoOfMediaDto> media_get_medias(app_id, opts)
+# **media_get_medias**
+> ListResponseDtoOfMediaDto media_get_medias(app_id, opts)
 
 Query media items.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::MediaApi.new
 app_id = 'app_id_example' # String | The app where the media belongs to.
-opts = {
+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 media items.
+  #Query media items.
   result = api_instance.media_get_medias(app_id, opts)
   p result
 rescue Notifo::ApiError => e
-  puts "Error when calling MediaApi->media_get_medias: #{e}"
-end
-```
-
-#### Using the media_get_medias_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<ListResponseDtoOfMediaDto>, Integer, Hash)> media_get_medias_with_http_info(app_id, opts)
-
-```ruby
-begin
-  # Query media items.
-  data, status_code, headers = api_instance.media_get_medias_with_http_info(app_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <ListResponseDtoOfMediaDto>
-rescue Notifo::ApiError => e
-  puts "Error when calling MediaApi->media_get_medias_with_http_info: #{e}"
+  puts "Exception when calling MediaApi->media_get_medias: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app where the media belongs 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] |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app where the media belongs 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
 
@@ -312,60 +235,41 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## media_upload
 
+# **media_upload**
 > media_upload(app_id, opts)
 
 Upload a media object.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::MediaApi.new
 app_id = 'app_id_example' # String | The app id where the media belongs to.
-opts = {
-  file: File.new('/path/to/some/file') # File | 
+opts = { 
+  file: 'file_example' # String | 
 }
 
 begin
-  # Upload a media object.
+  #Upload a media object.
   api_instance.media_upload(app_id, opts)
 rescue Notifo::ApiError => e
-  puts "Error when calling MediaApi->media_upload: #{e}"
-end
-```
-
-#### Using the media_upload_with_http_info variant
-
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
-
-> <Array(nil, Integer, Hash)> media_upload_with_http_info(app_id, opts)
-
-```ruby
-begin
-  # Upload a media object.
-  data, status_code, headers = api_instance.media_upload_with_http_info(app_id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => nil
-rescue Notifo::ApiError => e
-  puts "Error when calling MediaApi->media_upload_with_http_info: #{e}"
+  puts "Exception when calling MediaApi->media_upload: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **app_id** | **String** | The app id where the media belongs to. |  |
-| **file** | **File** |  | [optional] |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| The app id where the media belongs to. | 
+ **file** | **String**|  | [optional] 
 
 ### Return type
 
@@ -377,6 +281,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: multipart/form-data
-- **Accept**: application/json
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
 

data/docs/MediaDto.md

@@ -1,30 +1,15 @@
 # Notifo::MediaDto
 
 ## Properties
-
-| 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** | **Hash<String, String>** |  |  |
-
-## Example
-
-```ruby
-require 'notifo'
-
-instance = Notifo::MediaDto.new(
-  mime_type: null,
-  file_name: null,
-  file_info: null,
-  file_size: null,
-  url: 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. | 
+**url** | **String** | The url to the media item. | 
+**file_size** | **Integer** | The size of the media file. | 
+**created** | **DateTime** | The date time (ISO 8601) when the media has been created. | 
+**last_update** | **DateTime** | The date time (ISO 8601) when the media has been updated. | 
+**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/MessagingTemplateDto.md

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