sunshine-conversations-client 9.1.1

data/docs/ConversationReadEventAllOf.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::ConversationReadEventAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payload** | [**ConversationReadEventAllOfPayload**](ConversationReadEventAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationReadEventAllOf.new(payload: null)
+```
+
+

data/docs/ConversationReadEventAllOfPayload.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ConversationReadEventAllOfPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation in which the message was read. | [optional] 
+**activity** | [**Activity**](Activity.md) | The activity that was sent. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationReadEventAllOfPayload.new(conversation: null,
+                                 activity: null)
+```
+
+

data/docs/ConversationResponse.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::ConversationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**Conversation**](Conversation.md) | The conversation. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationResponse.new(conversation: null)
+```
+
+

data/docs/ConversationTruncated.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::ConversationTruncated
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the conversation. | [optional] 
+**type** | [**ConversationType**](ConversationType.md) |  | [optional] 
+**active_switchboard_integration** | [**SwitchboardIntegrationWebhook**](SwitchboardIntegrationWebhook.md) | The current switchboard integration that is in control of the conversation. This field is omitted if no `activeSwitchboardIntegration` exists for the conversation. | [optional] 
+**pending_switchboard_integration** | [**SwitchboardIntegrationWebhook**](SwitchboardIntegrationWebhook.md) | The switchboard integration that is awaiting control. This field is omitted if no switchboard integration has been previously offered control. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationTruncated.new(id: c93bb9c14dde8ffb94564eae,
+                                 type: null,
+                                 active_switchboard_integration: null,
+                                 pending_switchboard_integration: null)
+```
+
+

data/docs/ConversationType.md

@@ -0,0 +1,16 @@
+# SunshineConversationsClient::ConversationType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationType.new()
+```
+
+

data/docs/ConversationTypingEvent.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::ConversationTypingEvent
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the event. May be used to ensure that an event is not processed twice in the case of a webhook that is re-tried due to an error or timeout. | [optional] 
+**type** | **String** | The type of the event. Will match one of the subscribed triggers for your [webhook](#operation/createWebhook). | [optional] 
+**created_at** | **String** | A timestamp signifying when the event was generated. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 
+**payload** | [**ConversationTypingEventAllOfPayload**](ConversationTypingEventAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationTypingEvent.new(id: null,
+                                 type: null,
+                                 created_at: null,
+                                 payload: null)
+```
+
+

data/docs/ConversationTypingEventAllOf.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::ConversationTypingEventAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payload** | [**ConversationTypingEventAllOfPayload**](ConversationTypingEventAllOfPayload.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationTypingEventAllOf.new(payload: null)
+```
+
+

data/docs/ConversationTypingEventAllOfPayload.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ConversationTypingEventAllOfPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conversation** | [**ConversationTruncated**](ConversationTruncated.md) | The conversation in which the activity was sent. | [optional] 
+**activity** | [**Activity**](Activity.md) | The activity that was sent. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationTypingEventAllOfPayload.new(conversation: null,
+                                 activity: null)
+```
+
+

data/docs/ConversationUpdateBody.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::ConversationUpdateBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**display_name** | **String** | A friendly name for the conversation, may be displayed to the business or the user.  | [optional] 
+**description** | **String** | A short text describing the conversation. | [optional] 
+**icon_url** | **String** | A custom conversation icon url. The image must be in either JPG, PNG, or GIF format | [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] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationUpdateBody.new(display_name: My conversation,
+                                 description: Conversation between Rogers and Carl.,
+                                 icon_url: https://www.gravatar.com/image.jpg,
+                                 metadata: {"lang":"en-ca"})
+```
+
+

data/docs/ConversationsApi.md

@@ -0,0 +1,319 @@
+# SunshineConversationsClient::ConversationsApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_conversation**](ConversationsApi.md#create_conversation) | **POST** /v2/apps/{appId}/conversations | Create Conversation
+[**delete_conversation**](ConversationsApi.md#delete_conversation) | **DELETE** /v2/apps/{appId}/conversations/{conversationId} | Delete Conversation
+[**get_conversation**](ConversationsApi.md#get_conversation) | **GET** /v2/apps/{appId}/conversations/{conversationId} | Get Conversation
+[**list_conversations**](ConversationsApi.md#list_conversations) | **GET** /v2/apps/{appId}/conversations | List Conversations
+[**update_conversation**](ConversationsApi.md#update_conversation) | **PATCH** /v2/apps/{appId}/conversations/{conversationId} | Update Conversation
+
+
+
+## create_conversation
+
+> ConversationResponse create_conversation(app_id, conversation_create_body)
+
+Create Conversation
+
+Create a conversation for the specified user(s).
+
+### 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::ConversationsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_create_body = SunshineConversationsClient::ConversationCreateBody.new # ConversationCreateBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Create Conversation
+  result = api_instance.create_conversation(app_id, conversation_create_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ConversationsApi->create_conversation: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_create_body** | [**ConversationCreateBody**](ConversationCreateBody.md)|  | 
+
+### Return type
+
+[**ConversationResponse**](ConversationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_conversation
+
+> Object delete_conversation(app_id, conversation_id)
+
+Delete Conversation
+
+Delete an entire conversation record, along with its messages and attachments. Note that the default conversation cannot be deleted, but the messages contained [can be](#deleteAllMessages).
+
+### 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::ConversationsApi.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 Conversation
+  result = api_instance.delete_conversation(app_id, conversation_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ConversationsApi->delete_conversation: #{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
+
+
+## get_conversation
+
+> ConversationResponse get_conversation(app_id, conversation_id)
+
+Get Conversation
+
+Fetches an individual 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::ConversationsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+# Be sure to add the required body parameters
+
+begin
+  #Get Conversation
+  result = api_instance.get_conversation(app_id, conversation_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ConversationsApi->get_conversation: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+
+### Return type
+
+[**ConversationResponse**](ConversationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_conversations
+
+> ConversationListResponse list_conversations(app_id, filter, opts)
+
+List Conversations
+
+Lists all conversations that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits). ```shell /v2/apps/:appId/conversations?filter[userId]=42589ad070d43be9b00ff7e5 ``` 
+
+### 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::ConversationsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+filter = SunshineConversationsClient::ConversationListFilter.new # ConversationListFilter | Contains parameters for filtering the results.
+# Be sure to add the required body parameters
+opts = {
+  page: SunshineConversationsClient::Page.new # Page | Contains parameters for applying cursor pagination.
+}
+
+begin
+  #List Conversations
+  result = api_instance.list_conversations(app_id, filter, opts)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ConversationsApi->list_conversations: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **filter** | [**ConversationListFilter**](.md)| Contains parameters for filtering the results. | 
+ **page** | [**Page**](.md)| Contains parameters for applying cursor pagination. | [optional] 
+
+### Return type
+
+[**ConversationListResponse**](ConversationListResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_conversation
+
+> ConversationResponse update_conversation(app_id, conversation_id, conversation_update_body)
+
+Update Conversation
+
+Updates a conversation record.
+
+### 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::ConversationsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+conversation_update_body = SunshineConversationsClient::ConversationUpdateBody.new # ConversationUpdateBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Update Conversation
+  result = api_instance.update_conversation(app_id, conversation_id, conversation_update_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ConversationsApi->update_conversation: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **conversation_update_body** | [**ConversationUpdateBody**](ConversationUpdateBody.md)|  | 
+
+### Return type
+
+[**ConversationResponse**](ConversationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+