agent_push_kit 0.1.0

data/docs/CreateAgentTokenInput.md

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

data/docs/CreateOrganizationInput.md

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

data/docs/CurrentAccount.md

@@ -0,0 +1,20 @@
+# AgentPushKit::CurrentAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | [**User**](User.md) |  |  |
+| **organizations** | [**Array<Organization>**](Organization.md) |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::CurrentAccount.new(
+  user: null,
+  organizations: null
+)
+```
+

data/docs/CustomerAccountsApi.md

@@ -0,0 +1,348 @@
+# AgentPushKit::CustomerAccountsApi
+
+All URIs are relative to *https://api.chatdna.co/agent-push-kit/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_organization_member**](CustomerAccountsApi.md#add_organization_member) | **POST** /organizations/{organizationId}/members | Add an already-registered user to a customer account |
+| [**create_organization**](CustomerAccountsApi.md#create_organization) | **POST** /organizations | Create another Agent Push Kit customer account |
+| [**list_organization_members**](CustomerAccountsApi.md#list_organization_members) | **GET** /organizations/{organizationId}/members | List members of a customer account |
+| [**list_organizations**](CustomerAccountsApi.md#list_organizations) | **GET** /organizations | List customer accounts available to the current user |
+| [**regenerate_organization_api_key**](CustomerAccountsApi.md#regenerate_organization_api_key) | **POST** /organizations/{organizationId}/api-key/regenerate | Rotate the application event-ingestion key |
+
+
+## add_organization_member
+
+> <Membership> add_organization_member(organization_id, add_member_input)
+
+Add an already-registered user to a customer account
+
+### 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::CustomerAccountsApi.new
+organization_id = 'organization_id_example' # String | 
+add_member_input = AgentPushKit::AddMemberInput.new({email: 'email_example'}) # AddMemberInput | 
+
+begin
+  # Add an already-registered user to a customer account
+  result = api_instance.add_organization_member(organization_id, add_member_input)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling CustomerAccountsApi->add_organization_member: #{e}"
+end
+```
+
+#### Using the add_organization_member_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Membership>, Integer, Hash)> add_organization_member_with_http_info(organization_id, add_member_input)
+
+```ruby
+begin
+  # Add an already-registered user to a customer account
+  data, status_code, headers = api_instance.add_organization_member_with_http_info(organization_id, add_member_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Membership>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling CustomerAccountsApi->add_organization_member_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+| **add_member_input** | [**AddMemberInput**](AddMemberInput.md) |  |  |
+
+### Return type
+
+[**Membership**](Membership.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_organization
+
+> <OrganizationCreated> create_organization(create_organization_input)
+
+Create another Agent Push Kit customer account
+
+### 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::CustomerAccountsApi.new
+create_organization_input = AgentPushKit::CreateOrganizationInput.new({name: 'name_example'}) # CreateOrganizationInput | 
+
+begin
+  # Create another Agent Push Kit customer account
+  result = api_instance.create_organization(create_organization_input)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling CustomerAccountsApi->create_organization: #{e}"
+end
+```
+
+#### Using the create_organization_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrganizationCreated>, Integer, Hash)> create_organization_with_http_info(create_organization_input)
+
+```ruby
+begin
+  # Create another Agent Push Kit customer account
+  data, status_code, headers = api_instance.create_organization_with_http_info(create_organization_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrganizationCreated>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling CustomerAccountsApi->create_organization_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_organization_input** | [**CreateOrganizationInput**](CreateOrganizationInput.md) |  |  |
+
+### Return type
+
+[**OrganizationCreated**](OrganizationCreated.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_organization_members
+
+> <Array<Membership>> list_organization_members(organization_id)
+
+List members of a customer account
+
+### 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::CustomerAccountsApi.new
+organization_id = 'organization_id_example' # String | 
+
+begin
+  # List members of a customer account
+  result = api_instance.list_organization_members(organization_id)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling CustomerAccountsApi->list_organization_members: #{e}"
+end
+```
+
+#### Using the list_organization_members_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Membership>>, Integer, Hash)> list_organization_members_with_http_info(organization_id)
+
+```ruby
+begin
+  # List members of a customer account
+  data, status_code, headers = api_instance.list_organization_members_with_http_info(organization_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Membership>>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling CustomerAccountsApi->list_organization_members_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;Membership&gt;**](Membership.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_organizations
+
+> <Array<Organization>> list_organizations
+
+List customer accounts available to the current user
+
+### 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::CustomerAccountsApi.new
+
+begin
+  # List customer accounts available to the current user
+  result = api_instance.list_organizations
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling CustomerAccountsApi->list_organizations: #{e}"
+end
+```
+
+#### Using the list_organizations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Organization>>, Integer, Hash)> list_organizations_with_http_info
+
+```ruby
+begin
+  # List customer accounts available to the current user
+  data, status_code, headers = api_instance.list_organizations_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Organization>>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling CustomerAccountsApi->list_organizations_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Organization&gt;**](Organization.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## regenerate_organization_api_key
+
+> <OrganizationApiKeyCreated> regenerate_organization_api_key(organization_id)
+
+Rotate the application event-ingestion key
+
+The previous `apk_` key stops working immediately. The replacement is returned only in this response.
+
+### 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::CustomerAccountsApi.new
+organization_id = 'organization_id_example' # String | 
+
+begin
+  # Rotate the application event-ingestion key
+  result = api_instance.regenerate_organization_api_key(organization_id)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling CustomerAccountsApi->regenerate_organization_api_key: #{e}"
+end
+```
+
+#### Using the regenerate_organization_api_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrganizationApiKeyCreated>, Integer, Hash)> regenerate_organization_api_key_with_http_info(organization_id)
+
+```ruby
+begin
+  # Rotate the application event-ingestion key
+  data, status_code, headers = api_instance.regenerate_organization_api_key_with_http_info(organization_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrganizationApiKeyCreated>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling CustomerAccountsApi->regenerate_organization_api_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+
+### Return type
+
+[**OrganizationApiKeyCreated**](OrganizationApiKeyCreated.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DeletedResponse.md

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

data/docs/DeliverySummary.md

@@ -0,0 +1,24 @@
+# AgentPushKit::DeliverySummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sent** | **Integer** |  |  |
+| **failed** | **Integer** |  |  |
+| **suppressed_users** | **Integer** |  |  |
+| **eligible_devices** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::DeliverySummary.new(
+  sent: null,
+  failed: null,
+  suppressed_users: null,
+  eligible_devices: null
+)
+```
+

data/docs/Device.md

@@ -0,0 +1,28 @@
+# AgentPushKit::Device
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **installation_id** | **String** |  |  |
+| **environment** | **String** |  |  |
+| **app_version** | **String** |  |  |
+| **enabled** | **Boolean** |  |  |
+| **last_seen_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::Device.new(
+  id: null,
+  installation_id: null,
+  environment: null,
+  app_version: null,
+  enabled: null,
+  last_seen_at: null
+)
+```
+