sunshine-conversations-client 9.1.1

data/docs/ParticipantWithUserId.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ParticipantWithUserId
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | The id of the user that will be participating in the conversation. It will return `404` if the user can’t be found. One of `userId` or `userExternalId` is required, but not both. | [optional] 
+**subscribe_sdk_client** | **Boolean** | When passed as true, the SDK client of the concerned participant will be subscribed to the conversation. The user will start receiving push notifications for this conversation right away, without having to view the conversation on the SDK beforehand. An SDK client will be created for users that don’t already have one. This field is required if the conversation is of type `sdkGroup`. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ParticipantWithUserId.new(user_id: 42589ad070d43be9b00ff7e5,
+                                 subscribe_sdk_client: false)
+```
+
+

data/docs/ParticipantsApi.md

@@ -0,0 +1,199 @@
+# SunshineConversationsClient::ParticipantsApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**join_conversation**](ParticipantsApi.md#join_conversation) | **POST** /v2/apps/{appId}/conversations/{conversationId}/join | Join Conversation
+[**leave_conversation**](ParticipantsApi.md#leave_conversation) | **POST** /v2/apps/{appId}/conversations/{conversationId}/leave | Leave Conversation
+[**list_participants**](ParticipantsApi.md#list_participants) | **GET** /v2/apps/{appId}/conversations/{conversationId}/participants | List Participants
+
+
+
+## join_conversation
+
+> ParticipantResponse join_conversation(app_id, conversation_id, participant_join_body)
+
+Join Conversation
+
+Adds a user to a conversation using either their userId or userExternalId. The endpoint only supports adding a participant to a sdkGroup 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::ParticipantsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+participant_join_body = SunshineConversationsClient::ParticipantJoinBody.new # ParticipantJoinBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Join Conversation
+  result = api_instance.join_conversation(app_id, conversation_id, participant_join_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ParticipantsApi->join_conversation: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **participant_join_body** | [**ParticipantJoinBody**](ParticipantJoinBody.md)|  | 
+
+### Return type
+
+[**ParticipantResponse**](ParticipantResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## leave_conversation
+
+> Object leave_conversation(app_id, conversation_id, participant_leave_body)
+
+Leave Conversation
+
+Removes a user from a conversation using either their userId, userExternalId, or participantId. 
+
+### 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::ParticipantsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
+participant_leave_body = SunshineConversationsClient::ParticipantLeaveBody.new # ParticipantLeaveBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Leave Conversation
+  result = api_instance.leave_conversation(app_id, conversation_id, participant_leave_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ParticipantsApi->leave_conversation: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **conversation_id** | **String**| Identifies the conversation. | 
+ **participant_leave_body** | [**ParticipantLeaveBody**](ParticipantLeaveBody.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_participants
+
+> ParticipantListResponse list_participants(app_id, conversation_id, opts)
+
+List Participants
+
+Lists all the participants of a particular conversation. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits).  ```shell /v2/apps/:appId/conversations/:conversationId/participants?page[before]=26508c10541a4b0ff472e5e2 ``` 
+
+### 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::ParticipantsApi.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 Participants
+  result = api_instance.list_participants(app_id, conversation_id, opts)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ParticipantsApi->list_participants: #{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
+
+[**ParticipantListResponse**](ParticipantListResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PassControlBody.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::PassControlBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**switchboard_integration** | **String** | The id or the name of the switchboard integration that will become active. May also use the `next` keyword to transfer control to the next switchboard integration designated in the switchboard hierarchy configuration | 
+**metadata** | **Object** | 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. The metadata object will be included in the `switchboard:passControl` webhook. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::PassControlBody.new(switchboard_integration: next,
+                                 metadata: null)
+```
+
+

data/docs/Postback.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::Postback
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of action. | [default to 'postback']
+**text** | **String** | The button text. | 
+**payload** | **String** | The payload of a postback or reply button. | 
+**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::Postback.new(type: null,
+                                 text: null,
+                                 payload: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+

data/docs/PostbackWebhook.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::PostbackWebhook
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payload** | **String** | The payload associated with the postback. | [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::PostbackWebhook.new(payload: null,
+                                 metadata: {"lang":"en-ca"})
+```
+
+

data/docs/PrechatCapture.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::PrechatCapture
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**avatar_url** | **String** | Sets the URL of the avatar to use for the automatic reply to the prechat capture messages. | [optional] [default to 'undefined']
+**enabled** | **Boolean** | If true, enables the Prechat Capture add-on when the Web Messenger is initialized. | [optional] [default to false]
+**enable_email_linking** | **Boolean** | f true and Mailgun is integrated, will automatically link submitted emails. | [optional] [default to false]
+**fields** | [**Array<Field>**](Field.md) | Array of Fields. Overrides the default Prechat Capture fields to define a custom form. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::PrechatCapture.new(avatar_url: https://domain.com/images/avatar.png,
+                                 enabled: null,
+                                 enable_email_linking: null,
+                                 fields: [{"type":"email","name":"email","label":"Email","placeholder":"your@email.com"},{"type":"text","name":"company-website","label":"Company website","placeholder":"mycompany.com"}])
+```
+
+

data/docs/Profile.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::Profile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**given_name** | **String** | The user's given name (first name). | [optional] 
+**surname** | **String** | The user's surname (last name). | [optional] 
+**email** | **String** | The user's email address. | [optional] 
+**avatar_url** | **String** | The user's avatar. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Profile.new(given_name: Jane,
+                                 surname: Doe,
+                                 email: jane.doe@gmail.com,
+                                 avatar_url: https://s3.amazonaws.com/avatar.jpg)
+```
+
+

data/docs/QuotedMessage.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::QuotedMessage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of quotedMessage - `externalMessageId` if no Sunshine Conversations message matched the quoted message. | [optional] [default to 'externalMessageId']
+**message** | [**Message**](Message.md) |  | [optional] 
+**external_message_id** | **String** | The external message Id of the quoted message. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::QuotedMessage.new(type: null,
+                                 message: null,
+                                 external_message_id: null)
+```
+
+

data/docs/QuotedMessageExternalMessageId.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::QuotedMessageExternalMessageId
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of quotedMessage - `externalMessageId` if no Sunshine Conversations message matched the quoted message. | [optional] [default to 'externalMessageId']
+**external_message_id** | **String** | The external message Id of the quoted message. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::QuotedMessageExternalMessageId.new(type: null,
+                                 external_message_id: null)
+```
+
+

data/docs/QuotedMessageMessage.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::QuotedMessageMessage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of quotedMessage - a complete Sunshine Conversations message is provided. | [optional] [default to 'message']
+**message** | [**Message**](Message.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::QuotedMessageMessage.new(type: null,
+                                 message: null)
+```
+
+

data/docs/Referral.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::Referral
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The referral’s identifier. | [optional] 
+**details** | [**ReferralDetails**](ReferralDetails.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Referral.new(code: null,
+                                 details: null)
+```
+
+

data/docs/ReferralDetails.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::ReferralDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source** | **String** | The source of the referral - MESSENGER_CODE, ADS etc… | [optional] 
+**type** | **String** | The type of referral, typically OPEN-THREAD. | [optional] 
+**ad_id** | **String** | If the referral came from an ad, this field will be present with the ad’s Id. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ReferralDetails.new(source: MESSENGER_CODE,
+                                 type: OPEN-THREAD,
+                                 ad_id: 4216212847577)
+```
+
+

data/docs/Reply.md

@@ -0,0 +1,25 @@
+# SunshineConversationsClient::Reply
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of action. | 
+**text** | **String** | The button text. Text longer than 20 characters will be truncated on Facebook Messenger, and longer than 40 characters will be truncated on Web Messenger, iOS, and Android. | 
+**payload** | **String** | A string payload to help you identify the action context. Used when posting the reply. You can also use metadata for more complex needs. | 
+**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] 
+**icon_url** | **String** | An icon to render next to the reply option. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Reply.new(type: null,
+                                 text: null,
+                                 payload: null,
+                                 metadata: {"lang":"en-ca"},
+                                 icon_url: null)
+```
+
+