smooch-api 1.0.0

data/docs/MenuItem.md

@@ -0,0 +1,11 @@
+# SmoochApi::MenuItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The button text of the menu item. | 
+**uri** | **String** | A valid address, like http://smooch.io. Required for a *link* type item. | [optional] 
+**type** | **String** | Can either be [link](https://docs.smooch.io/javascript/#links) or [postback](https://docs.smooch.io/javascript/#postbacks), which correspond to Smooch’s [link and postback actions]((https://docs.smooch.io/javascript/#action-buttons). | 
+**postback** | **String** | A payload for a postback. Required for a *postback* type item. | [optional] 
+
+

data/docs/MenuResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::MenuResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**menu** | [**Menu**](Menu.md) | The menu. | 
+
+

data/docs/Message.md

@@ -0,0 +1,23 @@
+# SmoochApi::Message
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **String** | The message ID, generated automatically. | 
+**author_id** | **String** | The ID of the message's author. | 
+**role** | **String** | The role of the individual posting the message. Can be either *appUser* or *appMaker*. | 
+**type** | **String** | The message type. | 
+**name** | **String** | The display name of the message author. | 
+**text** | **String** | The message text. Required for text messages.  | 
+**email** | **String** | The email address of the message author. | [optional] 
+**avatar_url** | **String** | The URL of the desired message avatar image. | 
+**received** | **Float** | The unix timestamp of the moment the message was received. | 
+**media_url** | **String** | The mediaUrl for the image. Required for image messages.  | [optional] 
+**media_type** | **String** | The mediaType for the image. Required for image messages.  | [optional] 
+**metadata** | **Object** | Flat JSON object containing any custom properties associated with the message. | [optional] 
+**items** | [**Array<MessageItem>**](MessageItem.md) | The items in the message list. Required for carousel and list messages.  | [optional] 
+**actions** | [**Array<Action>**](Action.md) | The actions in the message. | [optional] 
+**payload** | **String** | The payload of a reply action, if applicable. | [optional] 
+**display_settings** | [**DisplaySettings**](DisplaySettings.md) | Settings to adjust the carousel layout. See [Display Settings](https://docs.smooch.io/rest/#display-settings). | [optional] 
+
+

data/docs/MessageItem.md

@@ -0,0 +1,13 @@
+# SmoochApi::MessageItem
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | The title of the message item. | 
+**description** | **String** | The text description, or subtitle. | [optional] 
+**media_url** | **String** | The image URL to be shown in the carousel/list item. | [optional] 
+**size** | **String** | The size of the image to be shown in the carousel/list item. Only top item of Facebook Messenger carousel supported. Choose from *compact* and *large*.  | [optional] 
+**media_type** | **String** | If a *mediaUrl* was specified, the media type is defined here, for example *image/jpeg*. | [optional] 
+**actions** | [**Array<Action>**](Action.md) | Array of [action buttons](https://docs.smooch.io/rest/#action-buttons). At least 1 is required, a maximum of 3 are allowed. | 
+
+

data/docs/MessagePost.md

@@ -0,0 +1,20 @@
+# SmoochApi::MessagePost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **String** | The role of the individual posting the message. Can be either *appUser* or *appMaker*. | 
+**type** | **String** | The message type. | 
+**name** | **String** | The display name of the message author. | [optional] 
+**email** | **String** | The email address of the message author. | [optional] 
+**avatar_url** | **String** | The URL of the desired message avatar image. | [optional] 
+**metadata** | **Object** | Flat JSON object containing any custom properties associated with the message. | [optional] 
+**payload** | **String** | The payload of a reply action, if applicable. | [optional] 
+**text** | **String** | The message text. Required for text messages.  | [optional] 
+**media_url** | **String** | The mediaUrl for the image. Required for image messages.  | [optional] 
+**media_type** | **String** | The mediaType for the image. Required for image messages.  | [optional] 
+**items** | [**Array<MessageItem>**](MessageItem.md) | The items in the message list. Required for carousel and list messages.  | [optional] 
+**actions** | [**Array<Action>**](Action.md) | The actions in the message. | [optional] 
+**destination** | [**Destination**](Destination.md) | Specifies which channel to deliver a message to. See [list integrations](https://docs.smooch.io/rest/#list-integrations) to get integration ID and type. | [optional] 
+
+

data/docs/MessageResponse.md

@@ -0,0 +1,9 @@
+# SmoochApi::MessageResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **Object** | The message. | 
+**conversation** | [**Conversation**](Conversation.md) | The conversation. | 
+
+

data/docs/PostMessagesResponse.md

@@ -0,0 +1,9 @@
+# SmoochApi::PostMessagesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**Conversation**](Conversation.md) | The conversation. | [optional] 
+**messages** | [**Array<Message>**](Message.md) | The messages. | [optional] 
+
+

data/docs/SecretKey.md

@@ -0,0 +1,10 @@
+# SmoochApi::SecretKey
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **String** | The secret key ID, generated automatically. | 
+**secret** | **String** | The secret itself. | 
+**name** | **String** | A friendly identifier for the secret key. | 
+
+

data/docs/SecretKeyCreate.md

@@ -0,0 +1,8 @@
+# SmoochApi::SecretKeyCreate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | A friendly identifier for the secret key. | 
+
+

data/docs/SecretKeyResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::SecretKeyResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | [**SecretKey**](SecretKey.md) | The secret key. | [optional] 
+
+

data/docs/TrackEventResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::TrackEventResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation_updated** | **BOOLEAN** | Flag indicating if the conversation was updated. | [optional] 
+
+

data/docs/TypingActivityTrigger.md

@@ -0,0 +1,11 @@
+# SmoochApi::TypingActivityTrigger
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **String** | The role of the actor. Must be *appMaker*. | 
+**type** | **String** | The type of activity to trigger. Must be either *typing:start* or *typing:stop*. | 
+**name** | **String** | The name of the app maker that starts or stops typing a response. | [optional] 
+**avatar_url** | **String** | The avatar URL of the app maker that starts typing a response. | [optional] 
+
+

data/docs/Webhook.md

@@ -0,0 +1,11 @@
+# SmoochApi::Webhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **String** | The webhook ID, generated automatically. | 
+**target** | **String** | URL to be called when the webhook is triggered. | 
+**triggers** | **Array<String>** | An array of triggers you wish to have the webhook listen to. If unspecified the default trigger is *message*. | 
+**secret** | **String** | Secret which will be transmitted with each webhook invocation and can be used to verify the authenticity of the caller. | 
+
+

data/docs/WebhookApi.md

@@ -0,0 +1,287 @@
+# SmoochApi::WebhookApi
+
+All URIs are relative to *https://api.smooch.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_webhook**](WebhookApi.md#create_webhook) | **POST** /apps/{appId}/webhooks | 
+[**delete_webhook**](WebhookApi.md#delete_webhook) | **DELETE** /apps/{appId}/webhooks/{webhookId} | 
+[**get_webhook**](WebhookApi.md#get_webhook) | **GET** /apps/{appId}/webhooks/{webhookId} | 
+[**list_webhooks**](WebhookApi.md#list_webhooks) | **GET** /apps/{appId}/webhooks | 
+[**update_webhook**](WebhookApi.md#update_webhook) | **PUT** /apps/{appId}/webhooks/{webhookId} | 
+
+
+# **create_webhook**
+> WebhookResponse create_webhook(app_id, webhook_create_body)
+
+
+
+Create a webhook for the specified app.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::WebhookApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+webhook_create_body = SmoochApi::WebhookCreate.new # WebhookCreate | Body for a createWebhook request. 
+
+
+begin
+  result = api_instance.create_webhook(app_id, webhook_create_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling WebhookApi->create_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **webhook_create_body** | [**WebhookCreate**](WebhookCreate.md)| Body for a createWebhook request.  | 
+
+### Return type
+
+[**WebhookResponse**](WebhookResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_webhook**
+> delete_webhook(app_id, webhook_id)
+
+
+
+Delete the specified webhook.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::WebhookApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+webhook_id = "webhook_id_example" # String | Identifies the webhook.
+
+
+begin
+  api_instance.delete_webhook(app_id, webhook_id)
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling WebhookApi->delete_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **webhook_id** | **String**| Identifies the webhook. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_webhook**
+> WebhookResponse get_webhook(app_id, webhook_id)
+
+
+
+Get the specified webhook.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::WebhookApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+webhook_id = "webhook_id_example" # String | Identifies the webhook.
+
+
+begin
+  result = api_instance.get_webhook(app_id, webhook_id)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling WebhookApi->get_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **webhook_id** | **String**| Identifies the webhook. | 
+
+### Return type
+
+[**WebhookResponse**](WebhookResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_webhooks**
+> ListWebhooksResponse list_webhooks(app_id, )
+
+
+
+List webhooks for the specified app.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::WebhookApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+
+begin
+  result = api_instance.list_webhooks(app_id, )
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling WebhookApi->list_webhooks: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+
+### Return type
+
+[**ListWebhooksResponse**](ListWebhooksResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_webhook**
+> WebhookResponse update_webhook(app_id, webhook_idwebhook_update_body)
+
+
+
+Update the specified webhook.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::WebhookApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+webhook_id = "webhook_id_example" # String | Identifies the webhook.
+
+webhook_update_body = SmoochApi::WebhookUpdate.new # WebhookUpdate | Body for an updateWebhook request. 
+
+
+begin
+  result = api_instance.update_webhook(app_id, webhook_idwebhook_update_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling WebhookApi->update_webhook: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **webhook_id** | **String**| Identifies the webhook. | 
+ **webhook_update_body** | [**WebhookUpdate**](WebhookUpdate.md)| Body for an updateWebhook request.  | 
+
+### Return type
+
+[**WebhookResponse**](WebhookResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+