agent_push_kit 0.1.0

data/docs/EventsApi.md

@@ -0,0 +1,505 @@
+# AgentPushKit::EventsApi
+
+All URIs are relative to *https://api.chatdna.co/agent-push-kit/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_event**](EventsApi.md#get_event) | **GET** /organizations/{organizationId}/events/{eventId} | Get one event including metadata |
+| [**list_events**](EventsApi.md#list_events) | **GET** /organizations/{organizationId}/events | List a paginated inbox |
+| [**list_notification_types**](EventsApi.md#list_notification_types) | **GET** /organizations/{organizationId}/types | List distinct notification types |
+| [**list_services**](EventsApi.md#list_services) | **GET** /organizations/{organizationId}/services | List services discovered from ingested events |
+| [**search_events**](EventsApi.md#search_events) | **POST** /organizations/{organizationId}/events/search | Search events with a validated Boolean filter tree |
+| [**send_event**](EventsApi.md#send_event) | **POST** /events | Send an event using an application ingestion key |
+| [**send_event_as_user**](EventsApi.md#send_event_as_user) | **POST** /organizations/{organizationId}/events | Send an event as an authenticated user or agent |
+
+
+## get_event
+
+> <EventDetail> get_event(organization_id, event_id)
+
+Get one event including metadata
+
+### 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::EventsApi.new
+organization_id = 'organization_id_example' # String | 
+event_id = 'event_id_example' # String | 
+
+begin
+  # Get one event including metadata
+  result = api_instance.get_event(organization_id, event_id)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->get_event: #{e}"
+end
+```
+
+#### Using the get_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EventDetail>, Integer, Hash)> get_event_with_http_info(organization_id, event_id)
+
+```ruby
+begin
+  # Get one event including metadata
+  data, status_code, headers = api_instance.get_event_with_http_info(organization_id, event_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EventDetail>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->get_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+| **event_id** | **String** |  |  |
+
+### Return type
+
+[**EventDetail**](EventDetail.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_events
+
+> <EventPage> list_events(organization_id, opts)
+
+List a paginated inbox
+
+### 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::EventsApi.new
+organization_id = 'organization_id_example' # String | 
+opts = {
+  service: 'service_example', # String | 
+  type: 'type_example', # String | 
+  search: 'search_example', # String | 
+  cursor: 'cursor_example', # String | 
+  limit: 56 # Integer | 
+}
+
+begin
+  # List a paginated inbox
+  result = api_instance.list_events(organization_id, opts)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->list_events: #{e}"
+end
+```
+
+#### Using the list_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EventPage>, Integer, Hash)> list_events_with_http_info(organization_id, opts)
+
+```ruby
+begin
+  # List a paginated inbox
+  data, status_code, headers = api_instance.list_events_with_http_info(organization_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EventPage>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->list_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+| **service** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **search** | **String** |  | [optional] |
+| **cursor** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+
+### Return type
+
+[**EventPage**](EventPage.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_notification_types
+
+> Array&lt;String&gt; list_notification_types(organization_id, opts)
+
+List distinct notification types
+
+### 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::EventsApi.new
+organization_id = 'organization_id_example' # String | 
+opts = {
+  service_id: 'service_id_example' # String | Optionally restrict types to one service ID.
+}
+
+begin
+  # List distinct notification types
+  result = api_instance.list_notification_types(organization_id, opts)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->list_notification_types: #{e}"
+end
+```
+
+#### Using the list_notification_types_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Array&lt;String&gt;, Integer, Hash)> list_notification_types_with_http_info(organization_id, opts)
+
+```ruby
+begin
+  # List distinct notification types
+  data, status_code, headers = api_instance.list_notification_types_with_http_info(organization_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Array&lt;String&gt;
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->list_notification_types_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+| **service_id** | **String** | Optionally restrict types to one service ID. | [optional] |
+
+### Return type
+
+**Array&lt;String&gt;**
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_services
+
+> <Array<Service>> list_services(organization_id)
+
+List services discovered from ingested events
+
+### 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::EventsApi.new
+organization_id = 'organization_id_example' # String | 
+
+begin
+  # List services discovered from ingested events
+  result = api_instance.list_services(organization_id)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->list_services: #{e}"
+end
+```
+
+#### Using the list_services_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Service>>, Integer, Hash)> list_services_with_http_info(organization_id)
+
+```ruby
+begin
+  # List services discovered from ingested events
+  data, status_code, headers = api_instance.list_services_with_http_info(organization_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Service>>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->list_services_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+
+### Return type
+
+[**Array&lt;Service&gt;**](Service.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## search_events
+
+> <EventPage> search_events(organization_id, search_events_input)
+
+Search events with a validated Boolean filter tree
+
+### 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::EventsApi.new
+organization_id = 'organization_id_example' # String | 
+search_events_input = AgentPushKit::SearchEventsInput.new({filter: AgentPushKit::FilterGroup.new({operator: 'AND', children: [AgentPushKit::FilterGroup.new({operator: 'AND', children: []})]})}) # SearchEventsInput | 
+
+begin
+  # Search events with a validated Boolean filter tree
+  result = api_instance.search_events(organization_id, search_events_input)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->search_events: #{e}"
+end
+```
+
+#### Using the search_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EventPage>, Integer, Hash)> search_events_with_http_info(organization_id, search_events_input)
+
+```ruby
+begin
+  # Search events with a validated Boolean filter tree
+  data, status_code, headers = api_instance.search_events_with_http_info(organization_id, search_events_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EventPage>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->search_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+| **search_events_input** | [**SearchEventsInput**](SearchEventsInput.md) |  |  |
+
+### Return type
+
+[**EventPage**](EventPage.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_event
+
+> <IngestionResult> send_event(send_event_input)
+
+Send an event using an application ingestion key
+
+### Examples
+
+```ruby
+require 'time'
+require 'agent_push_kit'
+# setup authorization
+AgentPushKit.configure do |config|
+  # Configure Bearer authorization (apk_): OrganizationApiKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = AgentPushKit::EventsApi.new
+send_event_input = AgentPushKit::SendEventInput.new({service: 'service_example', type: 'type_example', title: 'title_example', body: 'body_example'}) # SendEventInput | 
+
+begin
+  # Send an event using an application ingestion key
+  result = api_instance.send_event(send_event_input)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->send_event: #{e}"
+end
+```
+
+#### Using the send_event_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IngestionResult>, Integer, Hash)> send_event_with_http_info(send_event_input)
+
+```ruby
+begin
+  # Send an event using an application ingestion key
+  data, status_code, headers = api_instance.send_event_with_http_info(send_event_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IngestionResult>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->send_event_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_event_input** | [**SendEventInput**](SendEventInput.md) |  |  |
+
+### Return type
+
+[**IngestionResult**](IngestionResult.md)
+
+### Authorization
+
+[OrganizationApiKey](../README.md#OrganizationApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_event_as_user
+
+> <IngestionResult> send_event_as_user(organization_id, send_event_input)
+
+Send an event as an authenticated user or agent
+
+### 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::EventsApi.new
+organization_id = 'organization_id_example' # String | 
+send_event_input = AgentPushKit::SendEventInput.new({service: 'service_example', type: 'type_example', title: 'title_example', body: 'body_example'}) # SendEventInput | 
+
+begin
+  # Send an event as an authenticated user or agent
+  result = api_instance.send_event_as_user(organization_id, send_event_input)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->send_event_as_user: #{e}"
+end
+```
+
+#### Using the send_event_as_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IngestionResult>, Integer, Hash)> send_event_as_user_with_http_info(organization_id, send_event_input)
+
+```ruby
+begin
+  # Send an event as an authenticated user or agent
+  data, status_code, headers = api_instance.send_event_as_user_with_http_info(organization_id, send_event_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IngestionResult>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling EventsApi->send_event_as_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** |  |  |
+| **send_event_input** | [**SendEventInput**](SendEventInput.md) |  |  |
+
+### Return type
+
+[**IngestionResult**](IngestionResult.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FilterGroup.md

@@ -0,0 +1,20 @@
+# AgentPushKit::FilterGroup
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **operator** | **String** |  |  |
+| **children** | [**Array<EventFilter>**](EventFilter.md) |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::FilterGroup.new(
+  operator: null,
+  children: null
+)
+```
+

data/docs/FilterNot.md

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

data/docs/HealthApi.md

@@ -0,0 +1,67 @@
+# AgentPushKit::HealthApi
+
+All URIs are relative to *https://api.chatdna.co/agent-push-kit/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_health**](HealthApi.md#get_health) | **GET** /health | Check Agent Push Kit API health |
+
+
+## get_health
+
+> <HealthResponse> get_health
+
+Check Agent Push Kit API health
+
+### Examples
+
+```ruby
+require 'time'
+require 'agent_push_kit'
+
+api_instance = AgentPushKit::HealthApi.new
+
+begin
+  # Check Agent Push Kit API health
+  result = api_instance.get_health
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling HealthApi->get_health: #{e}"
+end
+```
+
+#### Using the get_health_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<HealthResponse>, Integer, Hash)> get_health_with_http_info
+
+```ruby
+begin
+  # Check Agent Push Kit API health
+  data, status_code, headers = api_instance.get_health_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <HealthResponse>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling HealthApi->get_health_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**HealthResponse**](HealthResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/HealthResponse.md

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

data/docs/IngestionResult.md

@@ -0,0 +1,22 @@
+# AgentPushKit::IngestionResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | [**EventDetail**](EventDetail.md) |  |  |
+| **duplicate** | **Boolean** |  |  |
+| **delivery** | [**DeliverySummary**](DeliverySummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::IngestionResult.new(
+  event: null,
+  duplicate: null,
+  delivery: null
+)
+```
+

data/docs/InheritedResponse.md

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

data/docs/Membership.md

@@ -0,0 +1,24 @@
+# AgentPushKit::Membership
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **role** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **user** | [**MembershipUser**](MembershipUser.md) |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::Membership.new(
+  id: null,
+  role: null,
+  created_at: null,
+  user: null
+)
+```
+