notifo-io 1.0.0.pre

data/docs/MediaDto.md

@@ -0,0 +1,28 @@
+# 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
+)
+```
+

data/docs/MediaType.md

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

data/docs/NotificationFormattingDto.md

@@ -0,0 +1,32 @@
+# 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
+)
+```
+

data/docs/NotificationSettingDto.md

@@ -0,0 +1,20 @@
+# 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
+)
+```
+

data/docs/PublishManyRequestDto.md

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

data/docs/PublishRequestDto.md

@@ -0,0 +1,36 @@
+# Notifo::PublishRequestDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **topic** | **String** | The topic path. | [optional] |
+| **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** | [**OneOfNotificationFormattingDto**](OneOfNotificationFormattingDto.md) | Preformatting when no template is used. | [optional] |
+| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | The notification settings. | [optional] |
+| **properties** | [**OneOfmap**](OneOfmap.md) | User defined properties. | [optional] |
+| **scheduling** | [**OneOfSchedulingDto**](OneOfSchedulingDto.md) | The scheduling options. | [optional] |
+| **silent** | **Boolean** | True when silent. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::PublishRequestDto.new(
+  topic: null,
+  creator_id: null,
+  template_code: null,
+  data: null,
+  timestamp: null,
+  preformatted: null,
+  settings: null,
+  properties: null,
+  scheduling: null,
+  silent: null
+)
+```
+

data/docs/ResizeMode.md

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

data/docs/SchedulingDto.md

@@ -0,0 +1,24 @@
+# Notifo::SchedulingDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**OneOfSchedulingType**](OneOfSchedulingType.md) | The scheduling type. | [optional] |
+| **next_week_day** | [**OneOfIsoDayOfWeek**](OneOfIsoDayOfWeek.md) | To schedule the event at the next day of the week. | [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
+)
+```
+

data/docs/SchedulingType.md

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

data/docs/SubscribeDto.md

@@ -0,0 +1,20 @@
+# Notifo::SubscribeDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **topic_prefix** | **String** | The topic to add. | [optional] |
+| **topic_settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::SubscribeDto.new(
+  topic_prefix: null,
+  topic_settings: null
+)
+```
+

data/docs/SubscriptionDto.md

@@ -0,0 +1,20 @@
+# Notifo::SubscriptionDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **topic_prefix** | **String** | The topic to add. | [optional] |
+| **topic_settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::SubscriptionDto.new(
+  topic_prefix: null,
+  topic_settings: null
+)
+```
+

data/docs/TemplateDto.md

@@ -0,0 +1,22 @@
+# Notifo::TemplateDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | The code of the template. | [optional] |
+| **formatting** | [**OneOfNotificationFormattingDto**](OneOfNotificationFormattingDto.md) | The formatting. | [optional] |
+| **settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::TemplateDto.new(
+  code: null,
+  formatting: null,
+  settings: null
+)
+```
+

data/docs/TemplatesApi.md

@@ -0,0 +1,208 @@
+# Notifo::TemplatesApi
+
+All URIs are relative to *https://app.notifo.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**templates_delete_template**](TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template. |
+| [**templates_get_templates**](TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates. |
+| [**templates_post_templates**](TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates. |
+
+
+## templates_delete_template
+
+> <ListResponseDtoOfTemplateDto> templates_delete_template(app_id, code)
+
+Delete a template.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::TemplatesApi.new
+app_id = 'app_id_example' # String | The app where the templates belong to.
+code = 'code_example' # String | The template code to delete.
+
+begin
+  # Delete a template.
+  result = api_instance.templates_delete_template(app_id, code)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling TemplatesApi->templates_delete_template: #{e}"
+end
+```
+
+#### Using the templates_delete_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponseDtoOfTemplateDto>, Integer, Hash)> templates_delete_template_with_http_info(app_id, code)
+
+```ruby
+begin
+  # Delete a template.
+  data, status_code, headers = api_instance.templates_delete_template_with_http_info(app_id, code)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponseDtoOfTemplateDto>
+rescue Notifo::ApiError => e
+  puts "Error when calling TemplatesApi->templates_delete_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the templates belong to. |  |
+| **code** | **String** | The template code to delete. |  |
+
+### Return type
+
+[**ListResponseDtoOfTemplateDto**](ListResponseDtoOfTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## templates_get_templates
+
+> <ListResponseDtoOfTemplateDto> templates_get_templates(app_id, opts)
+
+Query templates.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::TemplatesApi.new
+app_id = 'app_id_example' # String | The app where the templates 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 templates.
+  result = api_instance.templates_get_templates(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling TemplatesApi->templates_get_templates: #{e}"
+end
+```
+
+#### Using the templates_get_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponseDtoOfTemplateDto>, Integer, Hash)> templates_get_templates_with_http_info(app_id, opts)
+
+```ruby
+begin
+  # Query templates.
+  data, status_code, headers = api_instance.templates_get_templates_with_http_info(app_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponseDtoOfTemplateDto>
+rescue Notifo::ApiError => e
+  puts "Error when calling TemplatesApi->templates_get_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the templates 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
+
+[**ListResponseDtoOfTemplateDto**](ListResponseDtoOfTemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## templates_post_templates
+
+> <Array<TemplateDto>> templates_post_templates(app_id, upsert_templates_dto)
+
+Upsert templates.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::TemplatesApi.new
+app_id = 'app_id_example' # String | The app where the templates belong to.
+upsert_templates_dto = Notifo::UpsertTemplatesDto.new # UpsertTemplatesDto | The upsert request.
+
+begin
+  # Upsert templates.
+  result = api_instance.templates_post_templates(app_id, upsert_templates_dto)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling TemplatesApi->templates_post_templates: #{e}"
+end
+```
+
+#### Using the templates_post_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<TemplateDto>>, Integer, Hash)> templates_post_templates_with_http_info(app_id, upsert_templates_dto)
+
+```ruby
+begin
+  # Upsert templates.
+  data, status_code, headers = api_instance.templates_post_templates_with_http_info(app_id, upsert_templates_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<TemplateDto>>
+rescue Notifo::ApiError => e
+  puts "Error when calling TemplatesApi->templates_post_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the templates belong to. |  |
+| **upsert_templates_dto** | [**UpsertTemplatesDto**](UpsertTemplatesDto.md) | The upsert request. |  |
+
+### Return type
+
+[**Array&lt;TemplateDto&gt;**](TemplateDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+