sunshine-conversations-client 9.1.1

data/docs/MessagePost.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::MessagePost
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**author** | [**Author**](Author.md) | The author of the message. | 
+**content** | [**Content**](Content.md) | The content of the message. | 
+**destination** | [**Destination**](Destination.md) |  | [optional] 
+**metadata** | [**Object**](.md) | Flat object containing custom properties. Strings, numbers and booleans  are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.  | [optional] 
+**override** | [**MessageOverride**](MessageOverride.md) |  | [optional] 
+**message_schema** | **String** | Send WhatsApp Message Templates using \"whatsapp\", while populating the message key using the native [WhatsApp schema](https://developers.facebook.com/docs/whatsapp/api/messages/message-templates). When the `messageSchema` is specified, the message is automatically converted to the Sunshine Conversations schema to be stored in the conversation record. The Sunshine Conversations message schema is also used in the API response. Go to [Post Message API](https://docs.smooch.io/guide/whatsapp/#post-message-api) to view an example.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MessagePost.new(author: null,
+                                 content: null,
+                                 destination: null,
+                                 metadata: {"lang":"en-ca"},
+                                 override: null,
+                                 message_schema: whatsapp)
+```
+
+

data/docs/MessagePostResponse.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::MessagePostResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<Message>**](Message.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MessagePostResponse.new(messages: null)
+```
+
+

data/docs/MessageWebhook.md

@@ -0,0 +1,31 @@
+# SunshineConversationsClient::MessageWebhook
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the message. | [optional] 
+**received** | **String** | A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing when Sunshine Conversations received the message. | [optional] 
+**author** | [**AuthorWebhook**](AuthorWebhook.md) |  | [optional] 
+**content** | [**Content**](Content.md) | The content of the message. | [optional] 
+**source** | [**Source**](Source.md) |  | [optional] 
+**quoted_message** | [**QuotedMessage**](QuotedMessage.md) | The quoted message is currently only available for WhatsApp and Web Messenger `formResponse` messages. | [optional] 
+**metadata** | **Object** |  | [optional] 
+**deleted** | **Boolean** | true if the message serves as a placeholder for one that has been deleted. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MessageWebhook.new(id: 5e552ef595e5206375bb835d,
+                                 received: 2019-03-21T18:48:52.760Z,
+                                 author: null,
+                                 content: null,
+                                 source: null,
+                                 quoted_message: null,
+                                 metadata: null,
+                                 deleted: null)
+```
+
+

data/docs/Messagebird.md

@@ -0,0 +1,25 @@
+# SunshineConversationsClient::Messagebird
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'messagebird']
+**access_key** | **String** | The public API key of your MessageBird account. | 
+**signing_key** | **String** | The signing key of your MessageBird account. Used to validate the webhooks' origin. | 
+**originator** | **String** | Sunshine Conversations will receive all messages sent to this phone number. | 
+**webhook_secret** | **String** | The secret that is used to configure webhooks in MessageBird. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Messagebird.new(type: null,
+                                 access_key: 9V2iJmd93kFJ390L9495JCl11,
+                                 signing_key: Uu6N09Lkdji3820DJIO89I39sl9dJ,
+                                 originator: 12262121021,
+                                 webhook_secret: 72ade38394d1da51566cede33bd1e67e)
+```
+
+

data/docs/MessagebirdAllOf.md

@@ -0,0 +1,25 @@
+# SunshineConversationsClient::MessagebirdAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'messagebird']
+**access_key** | **String** | The public API key of your MessageBird account. | 
+**signing_key** | **String** | The signing key of your MessageBird account. Used to validate the webhooks' origin. | 
+**originator** | **String** | Sunshine Conversations will receive all messages sent to this phone number. | 
+**webhook_secret** | **String** | The secret that is used to configure webhooks in MessageBird. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MessagebirdAllOf.new(type: null,
+                                 access_key: 9V2iJmd93kFJ390L9495JCl11,
+                                 signing_key: Uu6N09Lkdji3820DJIO89I39sl9dJ,
+                                 originator: 12262121021,
+                                 webhook_secret: 72ade38394d1da51566cede33bd1e67e)
+```
+
+

data/docs/MessagesApi.md

@@ -0,0 +1,260 @@
+# SunshineConversationsClient::MessagesApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_all_messages**](MessagesApi.md#delete_all_messages) | **DELETE** /v2/apps/{appId}/conversations/{conversationId}/messages | Delete All Messages
+[**delete_message**](MessagesApi.md#delete_message) | **DELETE** /v2/apps/{appId}/conversations/{conversationId}/messages/{messageId} | Delete Message
+[**list_messages**](MessagesApi.md#list_messages) | **GET** /v2/apps/{appId}/conversations/{conversationId}/messages | List Messages
+[**post_message**](MessagesApi.md#post_message) | **POST** /v2/apps/{appId}/conversations/{conversationId}/messages | Post Message
+
+
+
+## delete_all_messages
+
+> Object delete_all_messages(app_id, conversation_id)
+
+Delete All Messages
+
+Delete all messages of a particular conversation.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::MessagesApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+# Be sure to add the required body parameters
+
+begin
+  #Delete All Messages
+  result = api_instance.delete_all_messages(app_id, conversation_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling MessagesApi->delete_all_messages: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_message
+
+> Object delete_message(app_id, conversation_id, message_id)
+
+Delete Message
+
+Delete a single message of a particular conversation.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::MessagesApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+message_id = '029c31f25a21b47effd7be90' # String | The id of the message.
+# Be sure to add the required body parameters
+
+begin
+  #Delete Message
+  result = api_instance.delete_message(app_id, conversation_id, message_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling MessagesApi->delete_message: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **message_id** | **String**| The id of the message. | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_messages
+
+> MessageListResponse list_messages(app_id, conversation_id, opts)
+
+List Messages
+
+List all messages for a particular conversation. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits), in the _backwards_ direction, with the most recent (i.e. last) page of messages being returned by default. The `hasMore` flag indicates whether more messages exist in the direction you are currently paginating through. To page backwards in the history, use the `beforeCursor` or follow the `prev` link. The page size limit is fixed at 100 messages per page.  ```shell /v2/apps/:appId/conversations/:conversationId/messages?page[before]=5f32b88acf6bf25073b2be56 ``` 
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::MessagesApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+# Be sure to add the required body parameters
+opts = {
+  page: SunshineConversationsClient::Page.new # Page | Contains parameters for applying cursor pagination.
+}
+
+begin
+  #List Messages
+  result = api_instance.list_messages(app_id, conversation_id, opts)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling MessagesApi->list_messages: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **page** | [**Page**](.md)| Contains parameters for applying cursor pagination. | [optional] 
+
+### Return type
+
+[**MessageListResponse**](MessageListResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_message
+
+> MessagePostResponse post_message(app_id, conversation_id, message_post)
+
+Post Message
+
+Send a message in a particular conversation.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::MessagesApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+message_post = SunshineConversationsClient::MessagePost.new # MessagePost | 
+# Be sure to add the required body parameters
+
+begin
+  #Post Message
+  result = api_instance.post_message(app_id, conversation_id, message_post)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling MessagesApi->post_message: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **message_post** | [**MessagePost**](MessagePost.md)|  | 
+
+### Return type
+
+[**MessagePostResponse**](MessagePostResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Messenger.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::Messenger
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'messenger']
+**page_access_token** | **String** | A Facebook Page Access Token. | 
+**app_id** | **String** | A Facebook App ID. | 
+**app_secret** | **String** | A Facebook App Secret. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Messenger.new(type: null,
+                                 page_access_token: your_access_token,
+                                 app_id: your_facebook_app_id,
+                                 app_secret: your_facebook_app_secret)
+```
+
+

data/docs/MessengerAllOf.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::MessengerAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'messenger']
+**page_access_token** | **String** | A Facebook Page Access Token. | 
+**app_id** | **String** | A Facebook App ID. | 
+**app_secret** | **String** | A Facebook App Secret. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MessengerAllOf.new(type: null,
+                                 page_access_token: your_access_token,
+                                 app_id: your_facebook_app_id,
+                                 app_secret: your_facebook_app_secret)
+```
+
+

data/docs/MessengerUpdate.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::MessengerUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. | [optional] 
+**page_access_token** | **String** | A Facebook Page Access Token. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MessengerUpdate.new(display_name: My awesome integration,
+                                 page_access_token: your_access_token)
+```
+
+