notifo-io 1.0.0.pre

data/docs/ConfigsApi.md

@@ -0,0 +1,127 @@
+# Notifo::ConfigsApi
+
+All URIs are relative to *https://app.notifo.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**configs_get_languages**](ConfigsApi.md#configs_get_languages) | **GET** /api/languages | Get all supported languages. |
+| [**configs_get_timezones**](ConfigsApi.md#configs_get_timezones) | **GET** /api/timezones | Get all supported timezones. |
+
+
+## configs_get_languages
+
+> Array<String> configs_get_languages
+
+Get all supported languages.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::ConfigsApi.new
+
+begin
+  # Get all supported languages.
+  result = api_instance.configs_get_languages
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling ConfigsApi->configs_get_languages: #{e}"
+end
+```
+
+#### Using the configs_get_languages_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;String&gt;, Integer, Hash)> configs_get_languages_with_http_info
+
+```ruby
+begin
+  # Get all supported languages.
+  data, status_code, headers = api_instance.configs_get_languages_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;String&gt;
+rescue Notifo::ApiError => e
+  puts "Error when calling ConfigsApi->configs_get_languages_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array&lt;String&gt;**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## configs_get_timezones
+
+> Array&lt;String&gt; configs_get_timezones
+
+Get all supported timezones.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::ConfigsApi.new
+
+begin
+  # Get all supported timezones.
+  result = api_instance.configs_get_timezones
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling ConfigsApi->configs_get_timezones: #{e}"
+end
+```
+
+#### Using the configs_get_timezones_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;String&gt;, Integer, Hash)> configs_get_timezones_with_http_info
+
+```ruby
+begin
+  # Get all supported timezones.
+  data, status_code, headers = api_instance.configs_get_timezones_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;String&gt;
+rescue Notifo::ApiError => e
+  puts "Error when calling ConfigsApi->configs_get_timezones_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Array&lt;String&gt;**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ConfirmMode.md

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

data/docs/CreateEmailTemplateDto.md

@@ -0,0 +1,18 @@
+# Notifo::CreateEmailTemplateDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **language** | **String** | The new language. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::CreateEmailTemplateDto.new(
+  language: null
+)
+```
+

data/docs/EmailTemplateDto.md

@@ -0,0 +1,22 @@
+# Notifo::EmailTemplateDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject** | **String** | The subject text. | [optional] |
+| **body_html** | **String** | The body html template. | [optional] |
+| **body_text** | **String** | The body text template. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::EmailTemplateDto.new(
+  subject: null,
+  body_html: null,
+  body_text: null
+)
+```
+

data/docs/EmailVerificationStatus.md

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

data/docs/ErrorDto.md

@@ -0,0 +1,26 @@
+# Notifo::ErrorDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | The error message. | [optional] |
+| **trace_id** | **String** | The optional trace id. | [optional] |
+| **type** | **String** | The error type, usually a link. | [optional] |
+| **details** | **Array<String>** | Detailed error messages. | [optional] |
+| **status_code** | **Integer** | Status code of the http response. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::ErrorDto.new(
+  message: null,
+  trace_id: null,
+  type: null,
+  details: null,
+  status_code: null
+)
+```
+

data/docs/EventDto.md

@@ -0,0 +1,40 @@
+# Notifo::EventDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The id of the event. | [optional] |
+| **topic** | **String** | The topic path. | [optional] |
+| **creator_id** | **String** | A custom id to identity the creator. | [optional] |
+| **display_name** | **String** | The display name. | [optional] |
+| **data** | **String** | Additional user defined data. | [optional] |
+| **created** | **Time** | The time when the event has been created. | [optional] |
+| **formatting** | [**OneOfNotificationFormattingDto**](OneOfNotificationFormattingDto.md) | The final formatting infos. | [optional] |
+| **settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
+| **properties** | [**OneOfmap**](OneOfmap.md) | User defined properties. | [optional] |
+| **scheduling** | [**OneOfSchedulingDto**](OneOfSchedulingDto.md) | The scheduling options. | [optional] |
+| **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
+| **silent** | **Boolean** | True when silent. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::EventDto.new(
+  id: null,
+  topic: null,
+  creator_id: null,
+  display_name: null,
+  data: null,
+  created: null,
+  formatting: null,
+  settings: null,
+  properties: null,
+  scheduling: null,
+  counters: null,
+  silent: null
+)
+```
+

data/docs/EventsApi.md

@@ -0,0 +1,142 @@
+# Notifo::EventsApi
+
+All URIs are relative to *https://app.notifo.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**events_get_events**](EventsApi.md#events_get_events) | **GET** /api/apps/{appId}/events | Query events. |
+| [**events_post_events**](EventsApi.md#events_post_events) | **POST** /api/apps/{appId}/events | Publish events. |
+
+
+## events_get_events
+
+> <ListResponseDtoOfEventDto> events_get_events(app_id, opts)
+
+Query events.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::EventsApi.new
+app_id = 'app_id_example' # String | The app where the events 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 events.
+  result = api_instance.events_get_events(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling EventsApi->events_get_events: #{e}"
+end
+```
+
+#### Using the events_get_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponseDtoOfEventDto>, Integer, Hash)> events_get_events_with_http_info(app_id, opts)
+
+```ruby
+begin
+  # Query events.
+  data, status_code, headers = api_instance.events_get_events_with_http_info(app_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponseDtoOfEventDto>
+rescue Notifo::ApiError => e
+  puts "Error when calling EventsApi->events_get_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the events 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
+
+[**ListResponseDtoOfEventDto**](ListResponseDtoOfEventDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## events_post_events
+
+> events_post_events(app_id, publish_many_request_dto)
+
+Publish events.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::EventsApi.new
+app_id = 'app_id_example' # String | The app where the events belongs to.
+publish_many_request_dto = Notifo::PublishManyRequestDto.new # PublishManyRequestDto | The publish request.
+
+begin
+  # Publish events.
+  api_instance.events_post_events(app_id, publish_many_request_dto)
+rescue Notifo::ApiError => e
+  puts "Error when calling EventsApi->events_post_events: #{e}"
+end
+```
+
+#### Using the events_post_events_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)> events_post_events_with_http_info(app_id, publish_many_request_dto)
+
+```ruby
+begin
+  # Publish events.
+  data, status_code, headers = api_instance.events_post_events_with_http_info(app_id, publish_many_request_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Notifo::ApiError => e
+  puts "Error when calling EventsApi->events_post_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the events belongs to. |  |
+| **publish_many_request_dto** | [**PublishManyRequestDto**](PublishManyRequestDto.md) | The publish request. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/InlineObject.md

@@ -0,0 +1,18 @@
+# Notifo::InlineObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **File** |  | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::InlineObject.new(
+  file: null
+)
+```
+

data/docs/IsoDayOfWeek.md

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