notifo-io 1.0.0.pre

data/docs/UsersApi.md

@@ -0,0 +1,610 @@
+# Notifo::UsersApi
+
+All URIs are relative to *https://app.notifo.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**users_delete_allowed_topic**](UsersApi.md#users_delete_allowed_topic) | **DELETE** /api/apps/{appId}/users/{id}/allowed-topics/{prefix} | Remove an allowed topic. |
+| [**users_delete_subscription**](UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} | Remove a user subscriptions. |
+| [**users_delete_user**](UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user. |
+| [**users_get_subscriptions**](UsersApi.md#users_get_subscriptions) | **GET** /api/apps/{appId}/users/{id}/subscriptions | Query user subscriptions. |
+| [**users_get_user**](UsersApi.md#users_get_user) | **GET** /api/apps/{appId}/users/{id} | Get a user. |
+| [**users_get_users**](UsersApi.md#users_get_users) | **GET** /api/apps/{appId}/users | Query users. |
+| [**users_post_allowed_topic**](UsersApi.md#users_post_allowed_topic) | **POST** /api/apps/{appId}/users/{id}/allowed-topics | Add an allowed topic. |
+| [**users_post_subscription**](UsersApi.md#users_post_subscription) | **POST** /api/apps/{appId}/users/{id}/subscriptions | Upsert a user subscriptions. |
+| [**users_post_users**](UsersApi.md#users_post_users) | **POST** /api/apps/{appId}/users | Upsert users. |
+
+
+## users_delete_allowed_topic
+
+> users_delete_allowed_topic(app_id, id, prefix)
+
+Remove an allowed topic.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the users belong to.
+id = 'id_example' # String | The user id.
+prefix = 'prefix_example' # String | The topic prefix.
+
+begin
+  # Remove an allowed topic.
+  api_instance.users_delete_allowed_topic(app_id, id, prefix)
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_delete_allowed_topic: #{e}"
+end
+```
+
+#### Using the users_delete_allowed_topic_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)> users_delete_allowed_topic_with_http_info(app_id, id, prefix)
+
+```ruby
+begin
+  # Remove an allowed topic.
+  data, status_code, headers = api_instance.users_delete_allowed_topic_with_http_info(app_id, id, prefix)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_delete_allowed_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the users belong to. |  |
+| **id** | **String** | The user id. |  |
+| **prefix** | **String** | The topic prefix. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_delete_subscription
+
+> users_delete_subscription(app_id, id, prefix)
+
+Remove a user subscriptions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the user belongs to.
+id = 'id_example' # String | The user id.
+prefix = 'prefix_example' # String | The topic prefix.
+
+begin
+  # Remove a user subscriptions.
+  api_instance.users_delete_subscription(app_id, id, prefix)
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_delete_subscription: #{e}"
+end
+```
+
+#### Using the users_delete_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)> users_delete_subscription_with_http_info(app_id, id, prefix)
+
+```ruby
+begin
+  # Remove a user subscriptions.
+  data, status_code, headers = api_instance.users_delete_subscription_with_http_info(app_id, id, prefix)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_delete_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the user belongs to. |  |
+| **id** | **String** | The user id. |  |
+| **prefix** | **String** | The topic prefix. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_delete_user
+
+> <ListResponseDtoOfUserDto> users_delete_user(app_id, id)
+
+Delete a user.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the users belongs to.
+id = 'id_example' # String | The user id to delete.
+
+begin
+  # Delete a user.
+  result = api_instance.users_delete_user(app_id, id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_delete_user: #{e}"
+end
+```
+
+#### Using the users_delete_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_delete_user_with_http_info(app_id, id)
+
+```ruby
+begin
+  # Delete a user.
+  data, status_code, headers = api_instance.users_delete_user_with_http_info(app_id, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponseDtoOfUserDto>
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_delete_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the users belongs to. |  |
+| **id** | **String** | The user id to delete. |  |
+
+### Return type
+
+[**ListResponseDtoOfUserDto**](ListResponseDtoOfUserDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_get_subscriptions
+
+> <ListResponseDtoOfSubscriptionDto> users_get_subscriptions(app_id, id, opts)
+
+Query user subscriptions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the user belongs to.
+id = 'id_example' # String | The user id.
+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 user subscriptions.
+  result = api_instance.users_get_subscriptions(app_id, id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_get_subscriptions: #{e}"
+end
+```
+
+#### Using the users_get_subscriptions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponseDtoOfSubscriptionDto>, Integer, Hash)> users_get_subscriptions_with_http_info(app_id, id, opts)
+
+```ruby
+begin
+  # Query user subscriptions.
+  data, status_code, headers = api_instance.users_get_subscriptions_with_http_info(app_id, id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponseDtoOfSubscriptionDto>
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_get_subscriptions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the user belongs to. |  |
+| **id** | **String** | The user id. |  |
+| **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
+
+[**ListResponseDtoOfSubscriptionDto**](ListResponseDtoOfSubscriptionDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_get_user
+
+> <ListResponseDtoOfUserDto> users_get_user(app_id, id)
+
+Get a user.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the user belongs to.
+id = 'id_example' # String | The user id.
+
+begin
+  # Get a user.
+  result = api_instance.users_get_user(app_id, id)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_get_user: #{e}"
+end
+```
+
+#### Using the users_get_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_get_user_with_http_info(app_id, id)
+
+```ruby
+begin
+  # Get a user.
+  data, status_code, headers = api_instance.users_get_user_with_http_info(app_id, id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponseDtoOfUserDto>
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_get_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the user belongs to. |  |
+| **id** | **String** | The user id. |  |
+
+### Return type
+
+[**ListResponseDtoOfUserDto**](ListResponseDtoOfUserDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_get_users
+
+> <ListResponseDtoOfUserDto> users_get_users(app_id, opts)
+
+Query users.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the users 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 users.
+  result = api_instance.users_get_users(app_id, opts)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_get_users: #{e}"
+end
+```
+
+#### Using the users_get_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_get_users_with_http_info(app_id, opts)
+
+```ruby
+begin
+  # Query users.
+  data, status_code, headers = api_instance.users_get_users_with_http_info(app_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListResponseDtoOfUserDto>
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_get_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the users 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
+
+[**ListResponseDtoOfUserDto**](ListResponseDtoOfUserDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_post_allowed_topic
+
+> users_post_allowed_topic(app_id, id, add_allowed_topic_request)
+
+Add an allowed topic.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the users belong to.
+id = 'id_example' # String | The user id.
+add_allowed_topic_request = Notifo::AddAllowedTopicRequest.new # AddAllowedTopicRequest | The upsert request.
+
+begin
+  # Add an allowed topic.
+  api_instance.users_post_allowed_topic(app_id, id, add_allowed_topic_request)
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_post_allowed_topic: #{e}"
+end
+```
+
+#### Using the users_post_allowed_topic_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)> users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_request)
+
+```ruby
+begin
+  # Add an allowed topic.
+  data, status_code, headers = api_instance.users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_post_allowed_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the users belong to. |  |
+| **id** | **String** | The user id. |  |
+| **add_allowed_topic_request** | [**AddAllowedTopicRequest**](AddAllowedTopicRequest.md) | The upsert request. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## users_post_subscription
+
+> users_post_subscription(app_id, id, subscribe_dto)
+
+Upsert a user subscriptions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the user belongs to.
+id = 'id_example' # String | The user id.
+subscribe_dto = Notifo::SubscribeDto.new # SubscribeDto | The subscription object.
+
+begin
+  # Upsert a user subscriptions.
+  api_instance.users_post_subscription(app_id, id, subscribe_dto)
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_post_subscription: #{e}"
+end
+```
+
+#### Using the users_post_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)> users_post_subscription_with_http_info(app_id, id, subscribe_dto)
+
+```ruby
+begin
+  # Upsert a user subscriptions.
+  data, status_code, headers = api_instance.users_post_subscription_with_http_info(app_id, id, subscribe_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_post_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the user belongs to. |  |
+| **id** | **String** | The user id. |  |
+| **subscribe_dto** | [**SubscribeDto**](SubscribeDto.md) | The subscription object. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## users_post_users
+
+> <Array<UserDto>> users_post_users(app_id, upsert_users_dto)
+
+Upsert users.
+
+### Examples
+
+```ruby
+require 'time'
+require 'notifo'
+
+api_instance = Notifo::UsersApi.new
+app_id = 'app_id_example' # String | The app where the users belong to.
+upsert_users_dto = Notifo::UpsertUsersDto.new # UpsertUsersDto | The upsert request.
+
+begin
+  # Upsert users.
+  result = api_instance.users_post_users(app_id, upsert_users_dto)
+  p result
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_post_users: #{e}"
+end
+```
+
+#### Using the users_post_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<UserDto>>, Integer, Hash)> users_post_users_with_http_info(app_id, upsert_users_dto)
+
+```ruby
+begin
+  # Upsert users.
+  data, status_code, headers = api_instance.users_post_users_with_http_info(app_id, upsert_users_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<UserDto>>
+rescue Notifo::ApiError => e
+  puts "Error when calling UsersApi->users_post_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | The app where the users belong to. |  |
+| **upsert_users_dto** | [**UpsertUsersDto**](UpsertUsersDto.md) | The upsert request. |  |
+
+### Return type
+
+[**Array&lt;UserDto&gt;**](UserDto.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+