sunshine-conversations-client 9.1.1

data/docs/AttachmentSchema.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::AttachmentSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**media_url** | **String** | Uploaded attachment’s url | [optional] 
+**media_type** | **String** | Uploaded attachment's media type | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AttachmentSchema.new(media_url: https://smooch.io/rocks.smooch.media-dev/apps/5ec41c54fe13cc5ac404bedc/conversations/c616a583e4c240a871818541/TmYMVQUBNsQRItX4fKf4aC-T/Screen%20Shot%202020-09-02%20at%204.04.41%20PM.png,
+                                 media_type: image/png)
+```
+
+

data/docs/AttachmentUploadBody.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::AttachmentUploadBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source** | **File** |  | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AttachmentUploadBody.new(source: null)
+```
+
+

data/docs/AttachmentsApi.md

@@ -0,0 +1,254 @@
+# SunshineConversationsClient::AttachmentsApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_attachment**](AttachmentsApi.md#delete_attachment) | **POST** /v2/apps/{appId}/attachments/remove | Delete Attachment
+[**generate_media_json_web_token**](AttachmentsApi.md#generate_media_json_web_token) | **POST** /v2/apps/{appId}/attachments/token | Generate Media Token
+[**set_cookie**](AttachmentsApi.md#set_cookie) | **GET** /v2/apps/{appId}/attachments/cookie | Set Cookie
+[**upload_attachment**](AttachmentsApi.md#upload_attachment) | **POST** /v2/apps/{appId}/attachments | Upload Attachment
+
+
+
+## delete_attachment
+
+> Object delete_attachment(app_id, attachment_delete_body)
+
+Delete Attachment
+
+Remove an attachment uploaded to Sunshine Conversations through the Upload attachment API. See [Attachments for Messages](#section/Attachments-for-Messages) to have attachments automatically deleted when deleting messages, conversations or users. <aside class=\"notice\">Note that deleted attachments can remain available on our CDN’s cache up to 15 minutes after the delete call.</aside> 
+
+### 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::AttachmentsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+attachment_delete_body = SunshineConversationsClient::AttachmentDeleteBody.new # AttachmentDeleteBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Delete Attachment
+  result = api_instance.delete_attachment(app_id, attachment_delete_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AttachmentsApi->delete_attachment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **attachment_delete_body** | [**AttachmentDeleteBody**](AttachmentDeleteBody.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## generate_media_json_web_token
+
+> AttachmentMediaTokenResponse generate_media_json_web_token(app_id, attachment_media_token_body)
+
+Generate Media Token
+
+Generates a media JWT for a list of attachment paths. This media token is a prerequisite for setting the cookie needed to visualize a private attachment. <aside class=\"notice\">Note you have the ability to allow files using different rules, see <a href=\"https://docs.smooch.io/guide/private-attachments\">Private Attachments</a> for more details.</aside> 
+
+### 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::AttachmentsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+attachment_media_token_body = SunshineConversationsClient::AttachmentMediaTokenBody.new # AttachmentMediaTokenBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Generate Media Token
+  result = api_instance.generate_media_json_web_token(app_id, attachment_media_token_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AttachmentsApi->generate_media_json_web_token: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **attachment_media_token_body** | [**AttachmentMediaTokenBody**](AttachmentMediaTokenBody.md)|  | 
+
+### Return type
+
+[**AttachmentMediaTokenResponse**](AttachmentMediaTokenResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## set_cookie
+
+> Object set_cookie(app_id)
+
+Set Cookie
+
+With the media JWT retrieved, pass it in the header of the below request as it’s authorization in order to set a cookie in the user’s browser corresponding to the path within the media JWT. The expiration date of this cookie will match the expiration date of the media JWT. This cookie will be needed to visualize a private attachment. 
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::AttachmentsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+# Be sure to add the required body parameters
+
+begin
+  #Set Cookie
+  result = api_instance.set_cookie(app_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AttachmentsApi->set_cookie: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## upload_attachment
+
+> AttachmentResponse upload_attachment(app_id, access, source, opts)
+
+Upload Attachment
+
+Upload an attachment to Sunshine Conversations to use in future messages. Files are uploaded using the multipart/form-data content type. Use the returned mediaUrl to send a file, image or carousel message. <aside class=\"notice\">Note that Sunshine Conversations limits the size and type of file you can upload to the platform. See the <a href=\"https://docs.smooch.io/guide/validating-files\">file validation</a> guide for more details.</aside> 
+
+### 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::AttachmentsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+access = 'public' # String | The access level for the attachment. Currently the available access levels are public and private.
+source = File.new('/path/to/file') # File | 
+# Be sure to add the required body parameters
+opts = {
+  _for: 'message', # String | Specifies the intended container for the attachment, to enable automatic attachment deletion (on deletion of associated message, conversation or user). For now, only message is supported. See [Attachments for Messages](#section/Attachments-for-Messages) for details.
+  conversation_id: 'c616a583e4c240a871818541' # String | Links the attachment getting uploaded to the conversation ID.
+}
+
+begin
+  #Upload Attachment
+  result = api_instance.upload_attachment(app_id, access, source, opts)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AttachmentsApi->upload_attachment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **access** | **String**| The access level for the attachment. Currently the available access levels are public and private. | [default to &#39;public&#39;]
+ **source** | **File**|  | 
+ **_for** | **String**| Specifies the intended container for the attachment, to enable automatic attachment deletion (on deletion of associated message, conversation or user). For now, only message is supported. See [Attachments for Messages](#section/Attachments-for-Messages) for details. | [optional] 
+ **conversation_id** | **String**| Links the attachment getting uploaded to the conversation ID. | [optional] 
+
+### Return type
+
+[**AttachmentResponse**](AttachmentResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/Author.md

@@ -0,0 +1,25 @@
+# SunshineConversationsClient::Author
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of the author. | 
+**user_id** | **String** | The id of the user. Only supported when `type` is user. | [optional] 
+**user_external_id** | **String** | The externalId of the user. Only supported when `type` is user. | [optional] 
+**display_name** | **String** | The display name of the message author. | [optional] 
+**avatar_url** | **String** | A custom message icon url. The image must be in either JPG, PNG, or GIF format | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Author.new(type: business,
+                                 user_id: 5963c0d619a30a2e00de36b8,
+                                 user_external_id: your-own-id,
+                                 display_name: Steve,
+                                 avatar_url: null)
+```
+
+

data/docs/AuthorWebhook.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::AuthorWebhook
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The `type` of the author. | 
+**user_id** | **String** | The id of the user. Only supported when author `type` is `user`. | [optional] 
+**user** | [**User**](User.md) | The user that authored the message or activity. `profile` is included in the payload if the `includeFullUser` option is enabled. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AuthorWebhook.new(type: null,
+                                 user_id: 5963c0d619a30a2e00de36b8,
+                                 user: null)
+```
+
+

data/docs/Buy.md

@@ -0,0 +1,25 @@
+# SunshineConversationsClient::Buy
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of action. | [default to 'buy']
+**text** | **String** | The button text. | 
+**amount** | **Integer** | The amount being charged. It needs to be specified in cents and is an integer (9.99$ -> 999). | 
+**currency** | **String** | An ISO 4217 standard currency code in lowercase. Used for actions of type buy. | [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::Buy.new(type: null,
+                                 text: Buy vinegar,
+                                 amount: 8000,
+                                 currency: CAD,
+                                 metadata: {"lang":"en-ca"})
+```
+
+

data/docs/CarouselMessage.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::CarouselMessage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of message. | [default to 'carousel']
+**text** | **String** | The fallback text message used when carousel messages are not supported by the channel. | [optional] [readonly] 
+**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] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::CarouselMessage.new(type: null,
+                                 text: null,
+                                 items: null,
+                                 display_settings: null)
+```
+
+

data/docs/CarouselMessageDisplaySettings.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::CarouselMessageDisplaySettings
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image_aspect_ratio** | **String** | Specifies how to display all carousel images. Valid values are horizontal (default) and square. Only supported in Facebook Messenger, Web Messenger, Android SDK and iOS SDK carousels. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::CarouselMessageDisplaySettings.new(image_aspect_ratio: null)
+```
+
+

data/docs/Client.md

@@ -0,0 +1,37 @@
+# SunshineConversationsClient::Client
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the client. | [optional] 
+**type** | [**ClientType**](ClientType.md) |  | [optional] 
+**status** | **String** | The client status. Indicates if the client is able to receive messages or not. Can be pending, inactive, active, or blocked. | [optional] 
+**integration_id** | **String** | The ID of the integration that the client was created for. Unused for clients of type sdk, as they incorporate multiple integrations. | [optional] 
+**external_id** | **String** | The ID of the user on an external channel. For example, the user’s phone number for Twilio, or their page-scoped user ID for Facebook Messenger. Applies only to non-SDK clients. | [optional] 
+**last_seen** | **String** | A datetime string with the format `YYYY-MM-DDThh:mm:ss.SSSZ` representing the last time the user interacted with this client. | [optional] 
+**linked_at** | **String** | A timestamp signifying when the client was added to the user. Formatted as `YYYY-MM-DDThh:mm:ss.SSSZ`. | [optional] 
+**display_name** | **String** | The user's display name on the channel. | [optional] 
+**avatar_url** | **String** | The URL for the user's avatar on the channel. | [optional] 
+**info** | [**Object**](.md) | A flat curated object with properties that vary for each client platform. All keys are optional and not guaranteed to be available. | [optional] 
+**raw** | [**Object**](.md) | An object with raw properties that vary for each client platform. All keys are optional and not guaranteed to be available. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Client.new(id: 5c9a34160c89726709136733,
+                                 type: null,
+                                 status: active,
+                                 integration_id: 582dedf230e788746891281a,
+                                 external_id: your-own-id,
+                                 last_seen: 2020-08-20T16:13:07.462Z,
+                                 linked_at: 2020-06-23T14:33:47.492Z,
+                                 display_name: Steve,
+                                 avatar_url: null,
+                                 info: null,
+                                 raw: null)
+```
+
+