sunshine-conversations-client 9.1.1

data/docs/ClientAssociation.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ClientAssociation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**ClientType**](ClientType.md) |  | [optional] 
+**client_id** | **String** | The id of the client being referenced. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ClientAssociation.new(type: null,
+                                 client_id: 42589ad070d43be9b00ff7e5)
+```
+
+

data/docs/ClientCreate.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::ClientCreate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**match_criteria** | [**MatchCriteria**](MatchCriteria.md) |  | 
+**confirmation** | [**Confirmation**](Confirmation.md) |  | 
+**target** | [**Target**](Target.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ClientCreate.new(match_criteria: null,
+                                 confirmation: null,
+                                 target: null)
+```
+
+

data/docs/ClientListResponse.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::ClientListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**clients** | [**Array<Client>**](Client.md) | List of returned clients. | [optional] 
+**meta** | [**Meta**](Meta.md) |  | [optional] 
+**links** | [**Links**](Links.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ClientListResponse.new(clients: null,
+                                 meta: null,
+                                 links: null)
+```
+
+

data/docs/ClientResponse.md

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

data/docs/ClientType.md

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

data/docs/ClientsApi.md

@@ -0,0 +1,199 @@
+# SunshineConversationsClient::ClientsApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_client**](ClientsApi.md#create_client) | **POST** /v2/apps/{appId}/users/{userIdOrExternalId}/clients | Create Client
+[**list_clients**](ClientsApi.md#list_clients) | **GET** /v2/apps/{appId}/users/{userIdOrExternalId}/clients | List Clients
+[**remove_client**](ClientsApi.md#remove_client) | **DELETE** /v2/apps/{appId}/users/{userIdOrExternalId}/clients/{clientId} | Remove Client
+
+
+
+## create_client
+
+> ClientResponse create_client(app_id, user_id_or_external_id, client_create)
+
+Create Client
+
+Create a client and link it to a channel specified by the matchCriteria.type.
+
+### 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::ClientsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+user_id_or_external_id = '42589ad070d43be9b00ff7e5' # String | The user's id or externalId.
+client_create = {"matchCriteria":{"type":"mailgun","integrationId":"582dedf230e788746891281a","primary":true,"address":"steveb@channel5.com","subject":"New message from {appName}"},"confirmation":{"type":"immediate","message":{"author":{"type":"business","displayName":"Steve","avatarUrl":"https://www.gravatar.com/image.jpg"},"content":{"type":"text","text":"Hello!"},"metadata":{"lang":"en-ca"}}},"target":{"conversationId":"029c31f25a21b47effd7be90"}} # ClientCreate | 
+# Be sure to add the required body parameters
+
+begin
+  #Create Client
+  result = api_instance.create_client(app_id, user_id_or_external_id, client_create)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ClientsApi->create_client: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **user_id_or_external_id** | **String**| The user's id or externalId. | 
+ **client_create** | [**ClientCreate**](ClientCreate.md)|  | 
+
+### Return type
+
+[**ClientResponse**](ClientResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_clients
+
+> ClientListResponse list_clients(app_id, user_id_or_external_id, opts)
+
+List Clients
+
+Get all the clients for a particular user, including both linked clients and pending clients. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits).  ```shell /v2/apps/:appId/users/:userId/clients?page[after]=5ebee0975ac5304b664a12fa ``` 
+
+### 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::ClientsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+user_id_or_external_id = '42589ad070d43be9b00ff7e5' # String | The user's id or externalId.
+# Be sure to add the required body parameters
+opts = {
+  page: SunshineConversationsClient::Page.new # Page | Contains parameters for applying cursor pagination.
+}
+
+begin
+  #List Clients
+  result = api_instance.list_clients(app_id, user_id_or_external_id, opts)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ClientsApi->list_clients: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **user_id_or_external_id** | **String**| The user's id or externalId. | 
+ **page** | [**Page**](.md)| Contains parameters for applying cursor pagination. | [optional] 
+
+### Return type
+
+[**ClientListResponse**](ClientListResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remove_client
+
+> Object remove_client(app_id, user_id_or_external_id, client_id)
+
+Remove Client
+
+Remove a particular client and unsubscribe it from all connected conversations.
+
+### 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::ClientsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+user_id_or_external_id = '42589ad070d43be9b00ff7e5' # String | The user's id or externalId.
+client_id = '5d8cff3cd55b040010928b5b' # String | The client's id.
+# Be sure to add the required body parameters
+
+begin
+  #Remove Client
+  result = api_instance.remove_client(app_id, user_id_or_external_id, client_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling ClientsApi->remove_client: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **user_id_or_external_id** | **String**| The user's id or externalId. | 
+ **client_id** | **String**| The client's id. | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Confirmation.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::Confirmation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of confirmation. | 
+**message** | [**MessagePost**](MessagePost.md) | The message used to reach out to the user, if desired. Messages sent via this method can only be of type text and image. If actions are included they can only be of type link. The confirmation message will not be added to the user’s conversation. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Confirmation.new(type: null,
+                                 message: null)
+```
+
+

data/docs/Content.md

@@ -0,0 +1,41 @@
+# SunshineConversationsClient::Content
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of message. | [default to 'location']
+**text** | **String** | The fallback text message used when location messages are not supported by the channel. | [optional] [readonly] 
+**actions** | [**Array<ActionSubset>**](ActionSubset.md) | An array of objects representing the actions associated with the message. The array length is limited by the third party channel. | [optional] 
+**items** | [**Array<Item>**](Item.md) | An array of objects representing the items associated with the message. Only present in carousel and list type messages. | 
+**display_settings** | [**CarouselMessageDisplaySettings**](CarouselMessageDisplaySettings.md) |  | [optional] 
+**media_url** | **String** | The URL for media, such as an image, attached to the message. | 
+**media_size** | **Float** | The size of the media. | [optional] [readonly] 
+**media_type** | **String** | The media type of the file. | [optional] [readonly] 
+**block_chat_input** | **Boolean** | true if the message should block the chat input on Web Messenger. form message only. | [optional] 
+**fields** | [**Array<Field>**](Field.md) | Array of field objects that contain the submitted fields. | 
+**text_fallback** | **String** | A string containing the `label: value` of all fields, each separated by a newline character. | [optional] [readonly] 
+**coordinates** | [**LocationMessageCoordinates**](LocationMessageCoordinates.md) |  | 
+**location** | [**LocationMessageLocation**](LocationMessageLocation.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Content.new(type: null,
+                                 text: null,
+                                 actions: null,
+                                 items: null,
+                                 display_settings: null,
+                                 media_url: null,
+                                 media_size: null,
+                                 media_type: null,
+                                 block_chat_input: null,
+                                 fields: null,
+                                 text_fallback: null,
+                                 coordinates: null,
+                                 location: null)
+```
+
+

data/docs/Conversation.md

@@ -0,0 +1,37 @@
+# SunshineConversationsClient::Conversation
+
+## 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] 
+**is_default** | **Boolean** | Whether the conversation is the default conversation for the user. Will be true for the first personal conversation created for the user, and false in all other cases.  | [optional] 
+**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] 
+**business_last_read** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the conversation was last marked as read with role business.  | [optional] 
+**last_updated_at** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the last message was received in the conversation, or the creation time if no messages have been received yet.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Conversation.new(id: c93bb9c14dde8ffb94564eae,
+                                 type: null,
+                                 active_switchboard_integration: null,
+                                 pending_switchboard_integration: null,
+                                 is_default: false,
+                                 display_name: My conversation,
+                                 description: Conversation between Rogers and Carl.,
+                                 icon_url: https://www.gravatar.com/image.jpg,
+                                 metadata: {"lang":"en-ca"},
+                                 business_last_read: 2020-06-23T14:33:47.492Z,
+                                 last_updated_at: 2020-06-26T14:33:47.120Z)
+```
+
+

data/docs/ConversationAllOf.md

@@ -0,0 +1,29 @@
+# SunshineConversationsClient::ConversationAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**is_default** | **Boolean** | Whether the conversation is the default conversation for the user. Will be true for the first personal conversation created for the user, and false in all other cases.  | [optional] 
+**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] 
+**business_last_read** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the conversation was last marked as read with role business.  | [optional] 
+**last_updated_at** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the moment the last message was received in the conversation, or the creation time if no messages have been received yet.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ConversationAllOf.new(is_default: false,
+                                 display_name: My conversation,
+                                 description: Conversation between Rogers and Carl.,
+                                 icon_url: https://www.gravatar.com/image.jpg,
+                                 metadata: {"lang":"en-ca"},
+                                 business_last_read: 2020-06-23T14:33:47.492Z,
+                                 last_updated_at: 2020-06-26T14:33:47.120Z)
+```
+
+

data/docs/ConversationCreateBody.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::ConversationCreateBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**ConversationType**](ConversationType.md) |  | 
+**participants** | [**Array<ParticipantSubSchema>**](ParticipantSubSchema.md) | The users participating in the conversation. For `personal` conversations, this field is required with a length of exactly 1. For `sdkGroup` conversations, must have a length less than or equal to 10. Can be omitted to have a conversation with no participants if the type is `sdkGroup`.  | [optional] 
+**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::ConversationCreateBody.new(type: null,
+                                 participants: null,
+                                 display_name: My conversation,
+                                 description: Conversation between Rogers and Carl.,
+                                 icon_url: https://www.gravatar.com/image.jpg,
+                                 metadata: {"lang":"en-ca"})
+```
+
+