agent_push_kit 0.1.0

data/docs/DevicesApi.md

@@ -0,0 +1,344 @@
+# AgentPushKit::DevicesApi
+
+All URIs are relative to *https://api.chatdna.co/agent-push-kit/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_web_push_configuration**](DevicesApi.md#get_web_push_configuration) | **GET** /web-push/configuration | Get browser push availability and its public VAPID key |
+| [**register_device**](DevicesApi.md#register_device) | **POST** /devices | Register or refresh an APNs device |
+| [**register_web_push_subscription**](DevicesApi.md#register_web_push_subscription) | **POST** /web-push/subscriptions | Register or refresh a browser push subscription |
+| [**remove_device**](DevicesApi.md#remove_device) | **DELETE** /devices/{installationId} | Disable push delivery to one installation |
+| [**remove_web_push_subscription**](DevicesApi.md#remove_web_push_subscription) | **DELETE** /web-push/subscriptions/{subscriptionId} | Disable a browser push subscription |
+
+
+## get_web_push_configuration
+
+> <WebPushConfiguration> get_web_push_configuration
+
+Get browser push availability and its public VAPID key
+
+### 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::DevicesApi.new
+
+begin
+  # Get browser push availability and its public VAPID key
+  result = api_instance.get_web_push_configuration
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling DevicesApi->get_web_push_configuration: #{e}"
+end
+```
+
+#### Using the get_web_push_configuration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebPushConfiguration>, Integer, Hash)> get_web_push_configuration_with_http_info
+
+```ruby
+begin
+  # Get browser push availability and its public VAPID key
+  data, status_code, headers = api_instance.get_web_push_configuration_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebPushConfiguration>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling DevicesApi->get_web_push_configuration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WebPushConfiguration**](WebPushConfiguration.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## register_device
+
+> <Device> register_device(register_device_input)
+
+Register or refresh an APNs device
+
+### 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::DevicesApi.new
+register_device_input = AgentPushKit::RegisterDeviceInput.new({device_token: 'device_token_example', installation_id: 'installation_id_example', environment: 'SANDBOX'}) # RegisterDeviceInput | 
+
+begin
+  # Register or refresh an APNs device
+  result = api_instance.register_device(register_device_input)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling DevicesApi->register_device: #{e}"
+end
+```
+
+#### Using the register_device_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Device>, Integer, Hash)> register_device_with_http_info(register_device_input)
+
+```ruby
+begin
+  # Register or refresh an APNs device
+  data, status_code, headers = api_instance.register_device_with_http_info(register_device_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Device>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling DevicesApi->register_device_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **register_device_input** | [**RegisterDeviceInput**](RegisterDeviceInput.md) |  |  |
+
+### Return type
+
+[**Device**](Device.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## register_web_push_subscription
+
+> <WebPushSubscription> register_web_push_subscription(register_web_push_subscription_input)
+
+Register or refresh a browser push subscription
+
+### 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::DevicesApi.new
+register_web_push_subscription_input = AgentPushKit::RegisterWebPushSubscriptionInput.new({endpoint: 'endpoint_example', keys: AgentPushKit::RegisterWebPushSubscriptionInputKeys.new({p256dh: 'p256dh_example', auth: 'auth_example'})}) # RegisterWebPushSubscriptionInput | 
+
+begin
+  # Register or refresh a browser push subscription
+  result = api_instance.register_web_push_subscription(register_web_push_subscription_input)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling DevicesApi->register_web_push_subscription: #{e}"
+end
+```
+
+#### Using the register_web_push_subscription_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebPushSubscription>, Integer, Hash)> register_web_push_subscription_with_http_info(register_web_push_subscription_input)
+
+```ruby
+begin
+  # Register or refresh a browser push subscription
+  data, status_code, headers = api_instance.register_web_push_subscription_with_http_info(register_web_push_subscription_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebPushSubscription>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling DevicesApi->register_web_push_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **register_web_push_subscription_input** | [**RegisterWebPushSubscriptionInput**](RegisterWebPushSubscriptionInput.md) |  |  |
+
+### Return type
+
+[**WebPushSubscription**](WebPushSubscription.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## remove_device
+
+> <DisabledResponse> remove_device(installation_id)
+
+Disable push delivery to one installation
+
+### 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::DevicesApi.new
+installation_id = 'installation_id_example' # String | 
+
+begin
+  # Disable push delivery to one installation
+  result = api_instance.remove_device(installation_id)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling DevicesApi->remove_device: #{e}"
+end
+```
+
+#### Using the remove_device_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DisabledResponse>, Integer, Hash)> remove_device_with_http_info(installation_id)
+
+```ruby
+begin
+  # Disable push delivery to one installation
+  data, status_code, headers = api_instance.remove_device_with_http_info(installation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DisabledResponse>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling DevicesApi->remove_device_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **installation_id** | **String** |  |  |
+
+### Return type
+
+[**DisabledResponse**](DisabledResponse.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remove_web_push_subscription
+
+> <DisabledResponse> remove_web_push_subscription(subscription_id)
+
+Disable a browser push subscription
+
+### 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::DevicesApi.new
+subscription_id = 'subscription_id_example' # String | 
+
+begin
+  # Disable a browser push subscription
+  result = api_instance.remove_web_push_subscription(subscription_id)
+  p result
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling DevicesApi->remove_web_push_subscription: #{e}"
+end
+```
+
+#### Using the remove_web_push_subscription_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DisabledResponse>, Integer, Hash)> remove_web_push_subscription_with_http_info(subscription_id)
+
+```ruby
+begin
+  # Disable a browser push subscription
+  data, status_code, headers = api_instance.remove_web_push_subscription_with_http_info(subscription_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DisabledResponse>
+rescue AgentPushKit::ApiError => e
+  puts "Error when calling DevicesApi->remove_web_push_subscription_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription_id** | **String** |  |  |
+
+### Return type
+
+[**DisabledResponse**](DisabledResponse.md)
+
+### Authorization
+
+[UserOrAgent](../README.md#UserOrAgent)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DisabledResponse.md

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

data/docs/ErrorResponse.md

@@ -0,0 +1,22 @@
+# AgentPushKit::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status_code** | **Integer** |  |  |
+| **message** | **String** |  |  |
+| **error** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::ErrorResponse.new(
+  status_code: null,
+  message: null,
+  error: null
+)
+```
+

data/docs/EventDetail.md

@@ -0,0 +1,36 @@
+# AgentPushKit::EventDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **type** | **String** |  |  |
+| **title** | **String** |  |  |
+| **body** | **String** |  |  |
+| **external_id** | **String** |  |  |
+| **action_url** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **service** | [**ServiceSummary**](ServiceSummary.md) |  |  |
+| **service_id** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::EventDetail.new(
+  id: null,
+  type: null,
+  title: null,
+  body: null,
+  external_id: null,
+  action_url: null,
+  created_at: null,
+  service: null,
+  service_id: null,
+  metadata: null
+)
+```
+

data/docs/EventFilter.md

@@ -0,0 +1,53 @@
+# AgentPushKit::EventFilter
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'agent_push_kit'
+
+AgentPushKit::EventFilter.openapi_one_of
+# =>
+# [
+#   :'FilterGroup',
+#   :'FilterNot',
+#   :'TextFilterCondition',
+#   :'TimeFilterCondition'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'agent_push_kit'
+
+AgentPushKit::EventFilter.build(data)
+# => #<FilterGroup:0x00007fdd4aab02a0>
+
+AgentPushKit::EventFilter.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `FilterGroup`
+- `FilterNot`
+- `TextFilterCondition`
+- `TimeFilterCondition`
+- `nil` (if no type matches)
+

data/docs/EventPage.md

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

data/docs/EventSummary.md

@@ -0,0 +1,32 @@
+# AgentPushKit::EventSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **type** | **String** |  |  |
+| **title** | **String** |  |  |
+| **body** | **String** |  |  |
+| **external_id** | **String** |  |  |
+| **action_url** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **service** | [**ServiceSummary**](ServiceSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'agent_push_kit'
+
+instance = AgentPushKit::EventSummary.new(
+  id: null,
+  type: null,
+  title: null,
+  body: null,
+  external_id: null,
+  action_url: null,
+  created_at: null,
+  service: null
+)
+```
+