notifo-io 1.0.0.pre

data/docs/TopicDto.md

@@ -0,0 +1,22 @@
+# Notifo::TopicDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **path** | **String** | The topic path. | [optional] |
+| **last_update** | **Time** | THe last update to the topic. | [optional] |
+| **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::TopicDto.new(
+  path: null,
+  last_update: null,
+  counters: null
+)
+```
+

data/docs/TopicsApi.md

@@ -0,0 +1,270 @@
+# Notifo::TopicsApi
+
+All URIs are relative to *https://app.notifo.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**topics_get_subscription**](TopicsApi.md#topics_get_subscription) | **GET** /api/web/subscriptions/{topic} | Gets a user subscription. |
+| [**topics_get_topics**](TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics. |
+| [**topics_subscribe**](TopicsApi.md#topics_subscribe) | **POST** /api/web/subscriptions/{topic} | Creates a user subscription. |
+| [**topics_unsubscribe**](TopicsApi.md#topics_unsubscribe) | **DELETE** /api/web/subscriptions/{topic} | Deletes a user subscription. |
+
+
+## topics_get_subscription
+
+> topics_get_subscription(topic)
+
+Gets a user subscription.
+
+User Id and App Id are resolved using the API token.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::TopicsApi.new
+topic = 'topic_example' # String | The topic path.
+
+begin
+  # Gets a user subscription.
+  api_instance.topics_get_subscription(topic)
+rescue Notifo::ApiError => e
+  puts "Error when calling TopicsApi->topics_get_subscription: #{e}"
+end
+```
+
+#### Using the topics_get_subscription_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)> topics_get_subscription_with_http_info(topic)
+
+```ruby
+begin
+  # Gets a user subscription.
+  data, status_code, headers = api_instance.topics_get_subscription_with_http_info(topic)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Notifo::ApiError => e
+  puts "Error when calling TopicsApi->topics_get_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **topic** | **String** | The topic path. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## topics_get_topics
+
+> <ListResponseDtoOfTopicDto> topics_get_topics(app_id, opts)
+
+Query topics.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::TopicsApi.new
+app_id = 'app_id_example' # String | The app where the topics 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 topics.
+  result = api_instance.topics_get_topics(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling TopicsApi->topics_get_topics: #{e}"
+end
+```
+
+#### Using the topics_get_topics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponseDtoOfTopicDto>, Integer, Hash)> topics_get_topics_with_http_info(app_id, opts)
+
+```ruby
+begin
+  # Query topics.
+  data, status_code, headers = api_instance.topics_get_topics_with_http_info(app_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponseDtoOfTopicDto>
+rescue Notifo::ApiError => e
+  puts "Error when calling TopicsApi->topics_get_topics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the topics 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
+
+[**ListResponseDtoOfTopicDto**](ListResponseDtoOfTopicDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## topics_subscribe
+
+> topics_subscribe(topic)
+
+Creates a user subscription.
+
+User Id and App Id are resolved using the API token.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::TopicsApi.new
+topic = 'topic_example' # String | The topic path.
+
+begin
+  # Creates a user subscription.
+  api_instance.topics_subscribe(topic)
+rescue Notifo::ApiError => e
+  puts "Error when calling TopicsApi->topics_subscribe: #{e}"
+end
+```
+
+#### Using the topics_subscribe_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)> topics_subscribe_with_http_info(topic)
+
+```ruby
+begin
+  # Creates a user subscription.
+  data, status_code, headers = api_instance.topics_subscribe_with_http_info(topic)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Notifo::ApiError => e
+  puts "Error when calling TopicsApi->topics_subscribe_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **topic** | **String** | The topic path. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## topics_unsubscribe
+
+> topics_unsubscribe(topic)
+
+Deletes a user subscription.
+
+User Id and App Id are resolved using the API token.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::TopicsApi.new
+topic = 'topic_example' # String | The topic path.
+
+begin
+  # Deletes a user subscription.
+  api_instance.topics_unsubscribe(topic)
+rescue Notifo::ApiError => e
+  puts "Error when calling TopicsApi->topics_unsubscribe: #{e}"
+end
+```
+
+#### Using the topics_unsubscribe_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)> topics_unsubscribe_with_http_info(topic)
+
+```ruby
+begin
+  # Deletes a user subscription.
+  data, status_code, headers = api_instance.topics_unsubscribe_with_http_info(topic)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Notifo::ApiError => e
+  puts "Error when calling TopicsApi->topics_unsubscribe_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **topic** | **String** | The topic path. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/UpsertAppDto.md

@@ -0,0 +1,36 @@
+# Notifo::UpsertAppDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The app name. | [optional] |
+| **languages** | **Array<String>** | The supported languages. | [optional] |
+| **email_address** | **String** | The sender email address. | [optional] |
+| **email_name** | **String** | The sender email name. | [optional] |
+| **firebase_project** | **String** | The firebase project ID. | [optional] |
+| **firebase_credential** | **String** | The firebase credentials. | [optional] |
+| **webhook_url** | **String** | The webhook URL. | [optional] |
+| **confirm_url** | **String** | The confirm URL. | [optional] |
+| **allow_email** | **Boolean** | True, when emails are allowed. | [optional] |
+| **allow_sms** | **Boolean** | True, when SMS are allowed. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::UpsertAppDto.new(
+  name: null,
+  languages: null,
+  email_address: null,
+  email_name: null,
+  firebase_project: null,
+  firebase_credential: null,
+  webhook_url: null,
+  confirm_url: null,
+  allow_email: null,
+  allow_sms: null
+)
+```
+

data/docs/UpsertTemplateDto.md

@@ -0,0 +1,22 @@
+# Notifo::UpsertTemplateDto
+
+## 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::UpsertTemplateDto.new(
+  code: null,
+  formatting: null,
+  settings: null
+)
+```
+

data/docs/UpsertTemplatesDto.md

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

data/docs/UpsertUserDto.md

@@ -0,0 +1,32 @@
+# Notifo::UpsertUserDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The id of the user. | [optional] |
+| **full_name** | **String** | The full name of the user. | [optional] |
+| **email_address** | **String** | The email of the user. | [optional] |
+| **phone_number** | **String** | The phone number. | [optional] |
+| **preferred_language** | **String** | The preferred language of the user. | [optional] |
+| **preferred_timezone** | **String** | The timezone of the user. | [optional] |
+| **requires_whitelisted_topics** | **Boolean** | True when only whitelisted topic are allowed. | [optional] |
+| **settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::UpsertUserDto.new(
+  id: null,
+  full_name: null,
+  email_address: null,
+  phone_number: null,
+  preferred_language: null,
+  preferred_timezone: null,
+  requires_whitelisted_topics: null,
+  settings: null
+)
+```
+

data/docs/UpsertUsersDto.md

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

data/docs/UserDto.md

@@ -0,0 +1,36 @@
+# Notifo::UserDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The id of the user. | [optional] |
+| **api_key** | **String** | The unique api key for the user. | [optional] |
+| **full_name** | **String** | The full name of the user. | [optional] |
+| **email_address** | **String** | The email of the user. | [optional] |
+| **phone_number** | **String** | The phone number. | [optional] |
+| **preferred_language** | **String** | The preferred language of the user. | [optional] |
+| **preferred_timezone** | **String** | The timezone of the user. | [optional] |
+| **requires_whitelisted_topics** | **Boolean** | True when only whitelisted topic are allowed. | [optional] |
+| **settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
+| **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
+
+## Example
+
+```ruby
+require 'notifo'
+
+instance = Notifo::UserDto.new(
+  id: null,
+  api_key: null,
+  full_name: null,
+  email_address: null,
+  phone_number: null,
+  preferred_language: null,
+  preferred_timezone: null,
+  requires_whitelisted_topics: null,
+  settings: null,
+  counters: null
+)
+```
+