notifo-io-easierlife 1.0.0

data/docs/ListResponseDtoOfLogEntryDto.md

@@ -0,0 +1,20 @@
+# Notifo::ListResponseDtoOfLogEntryDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<LogEntryDto>**](LogEntryDto.md) | The items. |  |
+| **total** | **Integer** | The total number of items. |  |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::ListResponseDtoOfLogEntryDto.new(
+  items: null,
+  total: null
+)
+```
+

data/docs/ListResponseDtoOfMediaDto.md

@@ -0,0 +1,20 @@
+# Notifo::ListResponseDtoOfMediaDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<MediaDto>**](MediaDto.md) | The items. |  |
+| **total** | **Integer** | The total number of items. |  |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::ListResponseDtoOfMediaDto.new(
+  items: null,
+  total: null
+)
+```
+

data/docs/ListResponseDtoOfSubscriptionDto.md

@@ -0,0 +1,20 @@
+# Notifo::ListResponseDtoOfSubscriptionDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<SubscriptionDto>**](SubscriptionDto.md) | The items. |  |
+| **total** | **Integer** | The total number of items. |  |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::ListResponseDtoOfSubscriptionDto.new(
+  items: null,
+  total: null
+)
+```
+

data/docs/ListResponseDtoOfTemplateDto.md

@@ -0,0 +1,20 @@
+# Notifo::ListResponseDtoOfTemplateDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<TemplateDto>**](TemplateDto.md) | The items. |  |
+| **total** | **Integer** | The total number of items. |  |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::ListResponseDtoOfTemplateDto.new(
+  items: null,
+  total: null
+)
+```
+

data/docs/ListResponseDtoOfTopicDto.md

@@ -0,0 +1,20 @@
+# Notifo::ListResponseDtoOfTopicDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<TopicDto>**](TopicDto.md) | The items. |  |
+| **total** | **Integer** | The total number of items. |  |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::ListResponseDtoOfTopicDto.new(
+  items: null,
+  total: null
+)
+```
+

data/docs/ListResponseDtoOfUserDto.md

@@ -0,0 +1,20 @@
+# Notifo::ListResponseDtoOfUserDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<UserDto>**](UserDto.md) | The items. |  |
+| **total** | **Integer** | The total number of items. |  |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::ListResponseDtoOfUserDto.new(
+  items: null,
+  total: null
+)
+```
+

data/docs/LogEntryDto.md

@@ -0,0 +1,24 @@
+# Notifo::LogEntryDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The log message. |  |
+| **first_seen** | **Time** | The first time this message has been seen. |  |
+| **last_seen** | **Time** | The last time this message has been seen. |  |
+| **count** | **Integer** | The number of items the message has been seen. |  |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::LogEntryDto.new(
+  message: null,
+  first_seen: null,
+  last_seen: null,
+  count: null
+)
+```
+

data/docs/LogsApi.md

@@ -0,0 +1,78 @@
+# Notifo::LogsApi
+
+All URIs are relative to *https://notifo.easierlife.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**logs_get_logs**](LogsApi.md#logs_get_logs) | **GET** /api/apps/{appId}/logs | Query log entries. |
+
+
+## logs_get_logs
+
+> <ListResponseDtoOfLogEntryDto> logs_get_logs(app_id, opts)
+
+Query log entries.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::LogsApi.new
+app_id = 'app_id_example' # String | The app where the log entries belongs 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
+  # Query log entries.
+  result = api_instance.logs_get_logs(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling LogsApi->logs_get_logs: #{e}"
+end
+```
+
+#### Using the logs_get_logs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponseDtoOfLogEntryDto>, Integer, Hash)> logs_get_logs_with_http_info(app_id, opts)
+
+```ruby
+begin
+  # Query log entries.
+  data, status_code, headers = api_instance.logs_get_logs_with_http_info(app_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponseDtoOfLogEntryDto>
+rescue Notifo::ApiError => e
+  puts "Error when calling LogsApi->logs_get_logs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the log entries 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
+
+[**ListResponseDtoOfLogEntryDto**](ListResponseDtoOfLogEntryDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/MediaApi.md

@@ -0,0 +1,382 @@
+# Notifo::MediaApi
+
+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
+
+> media_delete(app_id, file_name)
+
+Delete a media.
+
+### Examples
+
+```ruby
+require 'time'
+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
+rescue Notifo::ApiError => e
+  puts "Error when calling MediaApi->media_delete_with_http_info: #{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. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## media_download
+
+> File media_download(app_id, file_name, opts)
+
+Download a media object.
+
+### Examples
+
+```ruby
+require 'time'
+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 = {
+  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.
+  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.
+}
+
+begin
+  # 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}"
+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] |
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream, application/json
+
+
+## media_download2
+
+> File media_download2(app_id, file_name, opts)
+
+Download a media object.
+
+### Examples
+
+```ruby
+require 'time'
+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 = {
+  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.
+  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.
+}
+
+begin
+  # 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}"
+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] |
+
+### Return type
+
+**File**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/octet-stream, application/json
+
+
+## media_get_medias
+
+> <ListResponseDtoOfMediaDto> media_get_medias(app_id, opts)
+
+Query media items.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::MediaApi.new
+app_id = 'app_id_example' # String | The app where the media belongs 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
+  # 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}"
+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] |
+
+### Return type
+
+[**ListResponseDtoOfMediaDto**](ListResponseDtoOfMediaDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## media_upload
+
+> media_upload(app_id, opts)
+
+Upload a media object.
+
+### Examples
+
+```ruby
+require 'time'
+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 | 
+}
+
+begin
+  # 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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app id where the media belongs to. |  |
+| **file** | **File** |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+