agent_push_kit 0.1.0

data/docs/MembershipUser.md

@@ -0,0 +1,22 @@
+# AgentPushKit::MembershipUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **email** | **String** |  |  |
+| **display_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::MembershipUser.new(
+  id: null,
+  email: null,
+  display_name: null
+)
+```
+

data/docs/Organization.md

@@ -0,0 +1,32 @@
+# AgentPushKit::Organization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **role** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **joined_at** | **Time** |  |  |
+| **api_key** | [**ApiKeySummary**](ApiKeySummary.md) |  | [optional] |
+| **_count** | [**OrganizationCount**](OrganizationCount.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::Organization.new(
+  id: null,
+  name: null,
+  role: null,
+  created_at: null,
+  updated_at: null,
+  joined_at: null,
+  api_key: null,
+  _count: null
+)
+```
+

data/docs/OrganizationApiKeyCreated.md

@@ -0,0 +1,24 @@
+# AgentPushKit::OrganizationApiKeyCreated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key_prefix** | **String** |  |  |
+| **last_four** | **String** |  |  |
+| **updated_at** | **Time** |  |  |
+| **api_key** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::OrganizationApiKeyCreated.new(
+  key_prefix: null,
+  last_four: null,
+  updated_at: null,
+  api_key: null
+)
+```
+

data/docs/OrganizationCount.md

@@ -0,0 +1,20 @@
+# AgentPushKit::OrganizationCount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **memberships** | **Integer** |  | [optional] |
+| **services** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::OrganizationCount.new(
+  memberships: null,
+  services: null
+)
+```
+

data/docs/OrganizationCreated.md

@@ -0,0 +1,20 @@
+# AgentPushKit::OrganizationCreated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization** | [**OrganizationRecord**](OrganizationRecord.md) |  |  |
+| **api_key** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::OrganizationCreated.new(
+  organization: null,
+  api_key: null
+)
+```
+

data/docs/OrganizationRecord.md

@@ -0,0 +1,24 @@
+# AgentPushKit::OrganizationRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::OrganizationRecord.new(
+  id: null,
+  name: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/PasswordLoginInput.md

@@ -0,0 +1,20 @@
+# AgentPushKit::PasswordLoginInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **password** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::PasswordLoginInput.new(
+  email: null,
+  password: null
+)
+```
+

data/docs/PasswordResetCompleteInput.md

@@ -0,0 +1,20 @@
+# AgentPushKit::PasswordResetCompleteInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** |  |  |
+| **password** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::PasswordResetCompleteInput.new(
+  token: null,
+  password: null
+)
+```
+

data/docs/PasswordResetRequestInput.md

@@ -0,0 +1,18 @@
+# AgentPushKit::PasswordResetRequestInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::PasswordResetRequestInput.new(
+  email: null
+)
+```
+

data/docs/PreferenceRecord.md

@@ -0,0 +1,24 @@
+# AgentPushKit::PreferenceRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service_id** | **String** |  |  |
+| **type_key** | **String** |  |  |
+| **enabled** | **Boolean** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::PreferenceRecord.new(
+  service_id: null,
+  type_key: null,
+  enabled: null,
+  updated_at: null
+)
+```
+

data/docs/PreferencesApi.md

@@ -0,0 +1,287 @@
+# AgentPushKit::PreferencesApi
+
+All URIs are relative to *https://api.chatdna.co/agent-push-kit/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_preferences**](PreferencesApi.md#list_preferences) | **GET** /organizations/{organizationId}/preferences | List service defaults and exact-type overrides |
+| [**remove_type_preference**](PreferencesApi.md#remove_type_preference) | **DELETE** /services/{serviceId}/types/{type}/preference | Remove an exact-type override so it inherits the service default |
+| [**set_service_preference**](PreferencesApi.md#set_service_preference) | **PUT** /services/{serviceId}/preference | Enable or disable pushes for a service by default |
+| [**set_type_preference**](PreferencesApi.md#set_type_preference) | **PUT** /services/{serviceId}/types/{type}/preference | Override push delivery for one exact notification type |
+
+
+## list_preferences
+
+> <Array<ServicePreference>> list_preferences(organization_id)
+
+List service defaults and exact-type overrides
+
+### Examples
+
+```ruby
+require 'time'
+require 'agent_push_kit'
+# setup authorization
+AgentPushKit.configure do |config|
+  # Configure Bearer authorization (Agent Push Kit JWT or apt_ token): UserOrAgent
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AgentPushKit::PreferencesApi.new
+organization_id = 'organization_id_example' # String | 
+
+begin
+  # List service defaults and exact-type overrides
+  result = api_instance.list_preferences(organization_id)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling PreferencesApi->list_preferences: #{e}"
+end
+```
+
+#### Using the list_preferences_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ServicePreference>>, Integer, Hash)> list_preferences_with_http_info(organization_id)
+
+```ruby
+begin
+  # List service defaults and exact-type overrides
+  data, status_code, headers = api_instance.list_preferences_with_http_info(organization_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ServicePreference>>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling PreferencesApi->list_preferences_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;ServicePreference&gt;**](ServicePreference.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remove_type_preference
+
+> <InheritedResponse> remove_type_preference(service_id, type)
+
+Remove an exact-type override so it inherits the service default
+
+### Examples
+
+```ruby
+require 'time'
+require 'agent_push_kit'
+# setup authorization
+AgentPushKit.configure do |config|
+  # Configure Bearer authorization (Agent Push Kit JWT or apt_ token): UserOrAgent
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AgentPushKit::PreferencesApi.new
+service_id = 'service_id_example' # String | 
+type = 'type_example' # String | 
+
+begin
+  # Remove an exact-type override so it inherits the service default
+  result = api_instance.remove_type_preference(service_id, type)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling PreferencesApi->remove_type_preference: #{e}"
+end
+```
+
+#### Using the remove_type_preference_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InheritedResponse>, Integer, Hash)> remove_type_preference_with_http_info(service_id, type)
+
+```ruby
+begin
+  # Remove an exact-type override so it inherits the service default
+  data, status_code, headers = api_instance.remove_type_preference_with_http_info(service_id, type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InheritedResponse>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling PreferencesApi->remove_type_preference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service_id** | **String** |  |  |
+| **type** | **String** |  |  |
+
+### Return type
+
+[**InheritedResponse**](InheritedResponse.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## set_service_preference
+
+> <PreferenceRecord> set_service_preference(service_id, set_enabled_input)
+
+Enable or disable pushes for a service by default
+
+### Examples
+
+```ruby
+require 'time'
+require 'agent_push_kit'
+# setup authorization
+AgentPushKit.configure do |config|
+  # Configure Bearer authorization (Agent Push Kit JWT or apt_ token): UserOrAgent
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AgentPushKit::PreferencesApi.new
+service_id = 'service_id_example' # String | 
+set_enabled_input = AgentPushKit::SetEnabledInput.new({enabled: false}) # SetEnabledInput | 
+
+begin
+  # Enable or disable pushes for a service by default
+  result = api_instance.set_service_preference(service_id, set_enabled_input)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling PreferencesApi->set_service_preference: #{e}"
+end
+```
+
+#### Using the set_service_preference_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PreferenceRecord>, Integer, Hash)> set_service_preference_with_http_info(service_id, set_enabled_input)
+
+```ruby
+begin
+  # Enable or disable pushes for a service by default
+  data, status_code, headers = api_instance.set_service_preference_with_http_info(service_id, set_enabled_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PreferenceRecord>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling PreferencesApi->set_service_preference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service_id** | **String** |  |  |
+| **set_enabled_input** | [**SetEnabledInput**](SetEnabledInput.md) |  |  |
+
+### Return type
+
+[**PreferenceRecord**](PreferenceRecord.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## set_type_preference
+
+> <PreferenceRecord> set_type_preference(service_id, type, set_enabled_input)
+
+Override push delivery for one exact notification type
+
+### Examples
+
+```ruby
+require 'time'
+require 'agent_push_kit'
+# setup authorization
+AgentPushKit.configure do |config|
+  # Configure Bearer authorization (Agent Push Kit JWT or apt_ token): UserOrAgent
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AgentPushKit::PreferencesApi.new
+service_id = 'service_id_example' # String | 
+type = 'type_example' # String | 
+set_enabled_input = AgentPushKit::SetEnabledInput.new({enabled: false}) # SetEnabledInput | 
+
+begin
+  # Override push delivery for one exact notification type
+  result = api_instance.set_type_preference(service_id, type, set_enabled_input)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling PreferencesApi->set_type_preference: #{e}"
+end
+```
+
+#### Using the set_type_preference_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PreferenceRecord>, Integer, Hash)> set_type_preference_with_http_info(service_id, type, set_enabled_input)
+
+```ruby
+begin
+  # Override push delivery for one exact notification type
+  data, status_code, headers = api_instance.set_type_preference_with_http_info(service_id, type, set_enabled_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PreferenceRecord>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling PreferencesApi->set_type_preference_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **service_id** | **String** |  |  |
+| **type** | **String** |  |  |
+| **set_enabled_input** | [**SetEnabledInput**](SetEnabledInput.md) |  |  |
+
+### Return type
+
+[**PreferenceRecord**](PreferenceRecord.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ProviderLoginInput.md

@@ -0,0 +1,20 @@
+# AgentPushKit::ProviderLoginInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id_token** | **String** |  |  |
+| **display_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::ProviderLoginInput.new(
+  id_token: null,
+  display_name: null
+)
+```
+

data/docs/RegisterDeviceInput.md

@@ -0,0 +1,24 @@
+# AgentPushKit::RegisterDeviceInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **device_token** | **String** |  |  |
+| **installation_id** | **String** |  |  |
+| **environment** | **String** |  |  |
+| **app_version** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::RegisterDeviceInput.new(
+  device_token: null,
+  installation_id: null,
+  environment: null,
+  app_version: null
+)
+```
+

data/docs/RegisterInput.md

@@ -0,0 +1,22 @@
+# AgentPushKit::RegisterInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **password** | **String** |  |  |
+| **display_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::RegisterInput.new(
+  email: null,
+  password: null,
+  display_name: null
+)
+```
+

data/docs/RegisterWebPushSubscriptionInput.md

@@ -0,0 +1,20 @@
+# AgentPushKit::RegisterWebPushSubscriptionInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **endpoint** | **String** |  |  |
+| **keys** | [**RegisterWebPushSubscriptionInputKeys**](RegisterWebPushSubscriptionInputKeys.md) |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::RegisterWebPushSubscriptionInput.new(
+  endpoint: null,
+  keys: null
+)
+```
+

data/docs/RegisterWebPushSubscriptionInputKeys.md

@@ -0,0 +1,20 @@
+# AgentPushKit::RegisterWebPushSubscriptionInputKeys
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **p256dh** | **String** |  |  |
+| **auth** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::RegisterWebPushSubscriptionInputKeys.new(
+  p256dh: null,
+  auth: null
+)
+```
+

data/docs/RevokedResponse.md

@@ -0,0 +1,18 @@
+# AgentPushKit::RevokedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **revoked** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::RevokedResponse.new(
+  revoked: null
+)
+```
+

data/docs/SearchEventsInput.md

@@ -0,0 +1,22 @@
+# AgentPushKit::SearchEventsInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filter** | [**EventFilter**](EventFilter.md) |  |  |
+| **cursor** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::SearchEventsInput.new(
+  filter: null,
+  cursor: null,
+  limit: null
+)
+```
+