notifo-io 1.0.0.pre → 1.0.1.2

data/docs/EventProperties.md

@@ -0,0 +1,6 @@
+# Notifo::EventProperties
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/EventsApi.md

@@ -1,68 +1,48 @@
 # Notifo::EventsApi
 
-All URIs are relative to *https://app.notifo.io*
+All URIs are relative to *https://notifo.easierlife.com*
 
-| 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. |
+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_post_events2**](EventsApi.md#events_post_events2) | **POST** /api/me/events | Publish an event for the current user.
 
-
-## events_get_events
-
-> <ListResponseDtoOfEventDto> events_get_events(app_id, opts)
+# **events_get_events**
+> ListResponseDtoOfEventDto events_get_events(app_id, opts)
 
 Query events.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::EventsApi.new
 app_id = 'app_id_example' # String | The app where the events 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 events.
+  #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}"
+  puts "Exception when calling EventsApi->events_get_events: #{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] |
+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
 
@@ -74,58 +54,83 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
-- **Accept**: application/json
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
 
 
-## events_post_events
 
-> events_post_events(app_id, publish_many_request_dto)
+# **events_post_events**
+> events_post_events(bodyapp_id)
 
 Publish events.
 
-### Examples
-
+### Example
 ```ruby
-require 'time'
+# load the gem
 require 'notifo'
 
 api_instance = Notifo::EventsApi.new
+body = Notifo::PublishManyDto.new # PublishManyDto | The publish request.
 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)
+  #Publish events.
+  api_instance.events_post_events(bodyapp_id)
 rescue Notifo::ApiError => e
-  puts "Error when calling EventsApi->events_post_events: #{e}"
+  puts "Exception when calling EventsApi->events_post_events: #{e}"
 end
 ```
 
-#### Using the events_post_events_with_http_info variant
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**PublishManyDto**](PublishManyDto.md)| The publish request. | 
+ **app_id** | **String**| The app where the events belongs to. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
 
-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)
 
+# **events_post_events2**
+> events_post_events2(body)
+
+Publish an event for the current user.
+
+### Example
 ```ruby
+# load the gem
+require 'notifo'
+
+api_instance = Notifo::EventsApi.new
+body = Notifo::PublishDto.new # PublishDto | The publish request.
+
+
 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
+  #Publish an event for the current user.
+  api_instance.events_post_events2(body)
 rescue Notifo::ApiError => e
-  puts "Error when calling EventsApi->events_post_events_with_http_info: #{e}"
+  puts "Exception when calling EventsApi->events_post_events2: #{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. |  |
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**PublishDto**](PublishDto.md)| The publish request. | 
 
 ### Return type
 
@@ -137,6 +142,8 @@ No authorization required
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: application/json
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
 

data/docs/IntegrationCreatedDto.md

@@ -0,0 +1,8 @@
+# Notifo::IntegrationCreatedDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the integration. | 
+**integration** | [**ConfiguredIntegrationDto**](ConfiguredIntegrationDto.md) |  | 
+

data/docs/IntegrationDefinitionDto.md

@@ -0,0 +1,11 @@
+# Notifo::IntegrationDefinitionDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | The title of the integration. | 
+**logo_url** | **String** | The logo URL for the integration. | 
+**description** | **String** | The optional description of the integration. | [optional] 
+**properties** | [**Array<IntegrationPropertyDto>**](IntegrationPropertyDto.md) | The properties to configure. | 
+**capabilities** | **Array<String>** | The features of the integration. | 
+

data/docs/IntegrationProperties.md

@@ -0,0 +1,6 @@
+# Notifo::IntegrationProperties
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/IntegrationPropertyDto.md

@@ -0,0 +1,17 @@
+# Notifo::IntegrationPropertyDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The field name for the property. | 
+**type** | [**IntegrationPropertyType**](IntegrationPropertyType.md) |  | 
+**editor_description** | **String** | The optional description. | [optional] 
+**editor_label** | **String** | The optional label. | [optional] 
+**summary** | **BOOLEAN** | True to show this property in the summary. | [optional] 
+**is_required** | **BOOLEAN** | True when required. | [optional] 
+**min_value** | **Integer** | The min value (for numbers). | [optional] 
+**max_value** | **Integer** | The max value (for numbers). | [optional] 
+**min_length** | **Integer** | The min length (for strings). | [optional] 
+**max_length** | **Integer** | The min length (for strings). | [optional] 
+**default_value** | [****](.md) | The default value. | [optional] 
+

data/docs/IntegrationPropertyType.md

@@ -0,0 +1,6 @@
+# Notifo::IntegrationPropertyType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/IntegrationStatus.md

@@ -0,0 +1,6 @@
+# Notifo::IntegrationStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+

data/docs/IsoDayOfWeek.md

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

data/docs/ListResponseDtoOfEventDto.md

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

data/docs/ListResponseDtoOfLogEntryDto.md

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

data/docs/ListResponseDtoOfMediaDto.md

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

data/docs/ListResponseDtoOfMobilePushTokenDto.md

@@ -0,0 +1,8 @@
+# Notifo::ListResponseDtoOfMobilePushTokenDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<MobilePushTokenDto>**](MobilePushTokenDto.md) | The items. | 
+**total** | **Integer** | The total number of items. | 
+

data/docs/ListResponseDtoOfNotificationDto.md

@@ -0,0 +1,8 @@
+# Notifo::ListResponseDtoOfNotificationDto
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**Array<NotificationDto>**](NotificationDto.md) | The items. | 
+**total** | **Integer** | The total number of items. | 
+

data/docs/ListResponseDtoOfSubscriptionDto.md

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

data/docs/ListResponseDtoOfTemplateDto.md

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