sunshine-conversations-client 9.4.1 → 9.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fc03f92b99bea49559a9f2e8015f856baf7224c
-  data.tar.gz: dc62d4b9989d53ef317fa3eada2786c0bc91b49e
+  metadata.gz: 463c25c67746b75baefe183a32530d85ef991c88
+  data.tar.gz: 32fecd9b161c683ee3cf36fd1294c9b23c6fde4d
 SHA512:
-  metadata.gz: 897ced74bb733a891133c98d72d340f4db1dada5dbbabc7156149be9533fa6c76c14d30a5c12a8075a10c1685c9e7b8b0b0a20e9d692ada50d09b12acacbf818
-  data.tar.gz: e8b60a072fdb33a1be8be6c5d5bd0c30839e1174f94df712e198f0bdd4b0f0a4113a85b1de6eaf942f02739894e0a1aa3cb69db59a2a6724215a4c8155334511
+  metadata.gz: be3ba62af2d66e56390d97f85a60aa03d062b7dbc0c816e581c26b5e85e8a51fbed4a9dbc04a449e51bbfdef9c1d68e8ddf73642b7a8758d4baac2a4e17adba7
+  data.tar.gz: 6eaf438da768e80bc3035eb7cbb711bb37e8d96a4313cec78e6afe71994be91cb0e0245a104db7d4460928e261f62803930557ec8e3d0deb10ab48788ecdfbe5

data/CHANGELOG_RB.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [9.4.2] - 2021-01-06
+
+### Added
+
+- Added `phoneNumber` to the `integration` whatsapp response.
+- Added a message type `template` in the Post Message API.
+
+### Changed
+
+- Removed `channelId` and `channelSecret` as required fields when creating a LINE integration
+
+### Fixed
+
+- Fixed: property `messageSchema` should be `schema` in v2 Post Message API
+
 ## [9.4.1] - 2020-12-16
 
 ### Changed

data/README.md

@@ -4,8 +4,8 @@ SunshineConversationsClient - the Ruby gem for the Sunshine Conversations API
 
 This SDK is automatically generated by the [OpenAPI Generator Codegen](https://github.com/OpenAPITools/openapi-generator) project using the [Sunshine Conversations API spec](https://github.com/zendesk/sunshine-conversations-api-spec).
 
-- API version: 9.4.0
-- Package version: 9.4.1
+- API version: 9.4.2
+- Package version: 9.4.2
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Sunshine Conversations API Version
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./sunshine-conversations-client-9.4.1.gem
+gem install ./sunshine-conversations-client-9.4.2.gem
 ```
 
-(for development, run `gem install --dev ./sunshine-conversations-client-9.4.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./sunshine-conversations-client-9.4.2.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'sunshine-conversations-client', '~> 9.4.1'
+    gem 'sunshine-conversations-client', '~> 9.4.2'
 
 ### Install from Git
 
@@ -364,6 +364,7 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::Meta](docs/Meta.md)
  - [SunshineConversationsClient::OfferControlBody](docs/OfferControlBody.md)
  - [SunshineConversationsClient::Page](docs/Page.md)
+ - [SunshineConversationsClient::Page1](docs/Page1.md)
  - [SunshineConversationsClient::Participant](docs/Participant.md)
  - [SunshineConversationsClient::ParticipantJoinBody](docs/ParticipantJoinBody.md)
  - [SunshineConversationsClient::ParticipantLeaveBody](docs/ParticipantLeaveBody.md)
@@ -417,6 +418,7 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::Telegram](docs/Telegram.md)
  - [SunshineConversationsClient::TelegramAllOf](docs/TelegramAllOf.md)
  - [SunshineConversationsClient::TelegramUpdate](docs/TelegramUpdate.md)
+ - [SunshineConversationsClient::TemplateMessage](docs/TemplateMessage.md)
  - [SunshineConversationsClient::TextMessage](docs/TextMessage.md)
  - [SunshineConversationsClient::Twilio](docs/Twilio.md)
  - [SunshineConversationsClient::TwilioAllOf](docs/TwilioAllOf.md)

data/docs/Android.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'android']
+**type** | **String** | To configure an android integration, first visit the [Firebase Console](https://console.firebase.google.com/). Copy the `serverKey` and `senderId` from the Cloud Messaging tab in the settings of your project and call the create integrations endpoint with this data. If you would like to continue using your legacy GCM `serverKey` you can also obtain it from the [Google Developer Console](https://console.developers.google.com/).  | [optional] [default to 'android']
 **server_key** | **String** | Your server key from the fcm console. | [optional] 
 **sender_id** | **String** | Your sender id from the fcm console. | [optional] 
 **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional] 

data/docs/AndroidAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'android']
+**type** | **String** | To configure an android integration, first visit the [Firebase Console](https://console.firebase.google.com/). Copy the `serverKey` and `senderId` from the Cloud Messaging tab in the settings of your project and call the create integrations endpoint with this data. If you would like to continue using your legacy GCM `serverKey` you can also obtain it from the [Google Developer Console](https://console.developers.google.com/).  | [optional] [default to 'android']
 **server_key** | **String** | Your server key from the fcm console. | [optional] 
 **sender_id** | **String** | Your sender id from the fcm console. | [optional] 
 **can_user_create_more_conversations** | **Boolean** | Allows users to create more than one conversation on the android integration. | [optional] 

data/docs/Apple.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'apple']
+**type** | **String** | To configure an Apple Business Chat integration, acquire the required information and call the Create Integration endpoint.  | [optional] [default to 'apple']
 **business_id** | **String** | Apple Business Chat ID. | 
 **api_secret** | **String** | Your Apple API secret which is tied to your Messaging Service Provider. | 
 **msp_id** | **String** | Your Messaging Service Provider ID. | 

data/docs/AppleAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'apple']
+**type** | **String** | To configure an Apple Business Chat integration, acquire the required information and call the Create Integration endpoint.  | [optional] [default to 'apple']
 **business_id** | **String** | Apple Business Chat ID. | 
 **api_secret** | **String** | Your Apple API secret which is tied to your Messaging Service Provider. | 
 **msp_id** | **String** | Your Messaging Service Provider ID. | 

data/docs/Content.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of message. | [default to 'location']
+**type** | **String** | The type of message. | [default to 'template']
 **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. | 
@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **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] 
+**template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://docs.smooch.io/guide/whatsapp#sending-message-templates). `schema` must be set to `whatsapp`. | 
 
 ## Code Sample
 
@@ -37,7 +38,8 @@ instance = SunshineConversationsClient::Content.new(type: null,
                                  fields: null,
                                  text_fallback: null,
                                  coordinates: null,
-                                 location: null)
+                                 location: null,
+                                 template: null)
 ```
 
 

data/docs/Custom.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'custom']
+**type** | **String** | To configure a custom integration you need to setup a webhook with a set of triggers and target.  | [optional] [default to 'custom']
 **webhooks** | [**Array<Webhook>**](Webhook.md) | An array of webhooks associated with the custom integration. | 
 
 ## Code Sample

data/docs/CustomAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'custom']
+**type** | **String** | To configure a custom integration you need to setup a webhook with a set of triggers and target.  | [optional] [default to 'custom']
 **webhooks** | [**Array<Webhook>**](Webhook.md) | An array of webhooks associated with the custom integration. | 
 
 ## Code Sample

data/docs/Instagram.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'instagram']
+**type** | **String** | Instagram Direct setup steps:   - Take note of your Facebook app ID and secret (apps can be created at [developer.facebook.com](https://developer.facebook.com));   - The Facebook app must have been submitted to Facebook for app review with the \"manage_pages\" (to retrieve Page Access Tokens for the Pages and apps that the app user administers and to set a webhook), \"instagram_basic\", and \"instagram_manage_messages\" (to retrieve basic Instagram account information and send messages) permissions.   - In order to integrate an Instagram Direct app, you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token.  | [optional] [default to 'instagram']
 **page_access_token** | **String** | The Facebook Page Access Token of the Facebook page that is linked to your Instagram account. | 
 **app_id** | **String** | Your Facebook App ID. | 
 **app_secret** | **String** | Your Facebook App secret. | 

data/docs/InstagramAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'instagram']
+**type** | **String** | Instagram Direct setup steps:   - Take note of your Facebook app ID and secret (apps can be created at [developer.facebook.com](https://developer.facebook.com));   - The Facebook app must have been submitted to Facebook for app review with the \"manage_pages\" (to retrieve Page Access Tokens for the Pages and apps that the app user administers and to set a webhook), \"instagram_basic\", and \"instagram_manage_messages\" (to retrieve basic Instagram account information and send messages) permissions.   - In order to integrate an Instagram Direct app, you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token.  | [optional] [default to 'instagram']
 **page_access_token** | **String** | The Facebook Page Access Token of the Facebook page that is linked to your Instagram account. | 
 **app_id** | **String** | Your Facebook App ID. | 
 **app_secret** | **String** | Your Facebook App secret. | 

data/docs/Integration.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | The unique ID of the integration. | [optional] [readonly] 
-**type** | **String** | The type of integration. | 
+**type** | **String** |  | 
 **status** | [**Status**](Status.md) |  | [optional] 
 **display_name** | **String** | A human-friendly name used to identify the integration. | [optional] 
 

data/docs/Ios.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'ios']
+**type** | **String** | To configure an ios integration, call the create integration endpoint with a base64 encoded Apple Push Notification certificate from the [Apple Developer Portal](https://developer.apple.com/).  | [optional] [default to 'ios']
 **certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional] 
 **password** | **String** | The password for your APN certificate. | [optional] 
 **production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional] 

data/docs/IosAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'ios']
+**type** | **String** | To configure an ios integration, call the create integration endpoint with a base64 encoded Apple Push Notification certificate from the [Apple Developer Portal](https://developer.apple.com/).  | [optional] [default to 'ios']
 **certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional] 
 **password** | **String** | The password for your APN certificate. | [optional] 
 **production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional] 

data/docs/Line.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'line']
-**channel_id** | **String** | LINE Channel ID. | 
-**channel_secret** | **String** | LINE Channel Secret. | 
+**type** | **String** | For LINE, each of your customers will need to manually configure a webhook in their LINE configuration page that will point to Sunshine Conversations servers. You must instruct your customers how to configure this manually on their LINE bot page. Once you’ve acquired all the required information, call the Create Integration endpoint. Then, using the returned integration _id, your customer must set the Callback URL field in their LINE Business Center page. The URL should look like the following: `https://app.smooch.io:443/api/line/webhooks/{appId}/{integrationId}`.  | [optional] [default to 'line']
+**channel_id** | **String** | LINE Channel ID. Can be omitted along with `channelSecret` to integrate LINE to setup a webhook before receiving the `channelId` and `channelSecret` back from LINE. | [optional] 
+**channel_secret** | **String** | LINE Channel Secret. Can be omitted along with `channelId` to integrate LINE to setup a webhook before receiving the `channelId` and `channelSecret` back from LINE. | [optional] 
 **channel_access_token** | **String** | LINE Channel Access Token. | [optional] 
 **service_code** | **String** | LINE Service Code. | [optional] 
 **switcher_secret** | **String** | LINE Switcher Secret. | [optional] 

data/docs/LineAllOf.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'line']
-**channel_id** | **String** | LINE Channel ID. | 
-**channel_secret** | **String** | LINE Channel Secret. | 
+**type** | **String** | For LINE, each of your customers will need to manually configure a webhook in their LINE configuration page that will point to Sunshine Conversations servers. You must instruct your customers how to configure this manually on their LINE bot page. Once you’ve acquired all the required information, call the Create Integration endpoint. Then, using the returned integration _id, your customer must set the Callback URL field in their LINE Business Center page. The URL should look like the following: `https://app.smooch.io:443/api/line/webhooks/{appId}/{integrationId}`.  | [optional] [default to 'line']
+**channel_id** | **String** | LINE Channel ID. Can be omitted along with `channelSecret` to integrate LINE to setup a webhook before receiving the `channelId` and `channelSecret` back from LINE. | [optional] 
+**channel_secret** | **String** | LINE Channel Secret. Can be omitted along with `channelId` to integrate LINE to setup a webhook before receiving the `channelId` and `channelSecret` back from LINE. | [optional] 
 **channel_access_token** | **String** | LINE Channel Access Token. | [optional] 
 **service_code** | **String** | LINE Service Code. | [optional] 
 **switcher_secret** | **String** | LINE Switcher Secret. | [optional] 

data/docs/Mailgun.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'mailgun']
+**type** | **String** | To configure a Mailgun integration, visit the API Keys tab in the settings page of the Mailgun dashboard and copy your active API key. Call the Create Integration endpoint with your API Key, a domain you have configured in Mailgun, and the incoming address you would like to use. Must have the same domain as the one specified in the domain parameter.  | [optional] [default to 'mailgun']
 **api_key** | **String** | The public API key of your Mailgun account. | 
 **domain** | **String** | The domain used to relay email. This domain must be configured and verified in your Mailgun account. | 
 **incoming_address** | **String** | Sunshine Conversations will receive all emails sent to this address. It will also be used as the Reply-To address. | 

data/docs/MailgunAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'mailgun']
+**type** | **String** | To configure a Mailgun integration, visit the API Keys tab in the settings page of the Mailgun dashboard and copy your active API key. Call the Create Integration endpoint with your API Key, a domain you have configured in Mailgun, and the incoming address you would like to use. Must have the same domain as the one specified in the domain parameter.  | [optional] [default to 'mailgun']
 **api_key** | **String** | The public API key of your Mailgun account. | 
 **domain** | **String** | The domain used to relay email. This domain must be configured and verified in your Mailgun account. | 
 **incoming_address** | **String** | Sunshine Conversations will receive all emails sent to this address. It will also be used as the Reply-To address. | 

data/docs/MessagePost.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **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] 
+**schema** | **String** | When the `schema` is set to `whatsapp`, 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
 
@@ -21,7 +21,7 @@ instance = SunshineConversationsClient::MessagePost.new(author: null,
                                  destination: null,
                                  metadata: {"lang":"en-ca"},
                                  override: null,
-                                 message_schema: whatsapp)
+                                 schema: whatsapp)
 ```
 
 

data/docs/Messagebird.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'messagebird']
+**type** | **String** | To configure a MessageBird integration, acquire the accessKey, the signingKey and the MessageBird number you would like to use, then call the Create Integration endpoint. The response will include the integration’s `_id` and `webhookSecret`, which must be used to configure the webhook in MessageBird. In the Flow Builder for the MessageBird number you’ve used to integrate, add a new step with the following settings: - Create a new Call HTTP endpoint with SMS flow. - Select your desired SMS number for Incoming SMS. - Click on Forward to URL and set its method to POST. - Then, using the integration _id and webhookSecret returned from the create integration call, enter the following into the URL field:  `https://app.smooch.io/api/messagebird/webhooks/{appId}/{integrationId}/{webhookSecret}` - Select application/json for the Set Content-Type header field. - Save and publish your changes.  | [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. | 

data/docs/MessagebirdAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'messagebird']
+**type** | **String** | To configure a MessageBird integration, acquire the accessKey, the signingKey and the MessageBird number you would like to use, then call the Create Integration endpoint. The response will include the integration’s `_id` and `webhookSecret`, which must be used to configure the webhook in MessageBird. In the Flow Builder for the MessageBird number you’ve used to integrate, add a new step with the following settings: - Create a new Call HTTP endpoint with SMS flow. - Select your desired SMS number for Incoming SMS. - Click on Forward to URL and set its method to POST. - Then, using the integration _id and webhookSecret returned from the create integration call, enter the following into the URL field:  `https://app.smooch.io/api/messagebird/webhooks/{appId}/{integrationId}/{webhookSecret}` - Select application/json for the Set Content-Type header field. - Save and publish your changes.  | [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. | 

data/docs/MessagesApi.md

@@ -162,7 +162,7 @@ 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.
+  page: SunshineConversationsClient::Page1.new # Page1 | Contains parameters for applying cursor pagination.
 }
 
 begin
@@ -181,7 +181,7 @@ 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] 
+ **page** | [**Page1**](.md)| Contains parameters for applying cursor pagination. | [optional] 
 
 ### Return type
 

data/docs/Messenger.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'messenger']
+**type** | **String** | Facebook Messenger Setup steps: - Take note of your Facebook app ID and secret (apps can be created at developer.facebook.com); - The Facebook app must have been submitted to Facebook for app review with the “manage_pages” (to retrieve Page Access Tokens for the Pages, apps that the app user administers and set a webhook) and “pages_messaging” (to send messages) permissions. - In order to integrate a Facebook Messenger app you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token.  | [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. | 

data/docs/MessengerAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'messenger']
+**type** | **String** | Facebook Messenger Setup steps: - Take note of your Facebook app ID and secret (apps can be created at developer.facebook.com); - The Facebook app must have been submitted to Facebook for app review with the “manage_pages” (to retrieve Page Access Tokens for the Pages, apps that the app user administers and set a webhook) and “pages_messaging” (to send messages) permissions. - In order to integrate a Facebook Messenger app you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token.  | [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. | 

data/docs/Page1.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::Page1
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**after** | **String** | A record id. Results will only contain the records that come after the specified record.  Only one of `after` or `before` can be provided, not both.  | [optional] 
+**before** | **String** | A record id. Results will only contain the records that come before the specified record. Only one of `after` or `before` can be provided, not both.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Page1.new(after: 5e1606762556d93e9c176f69,
+                                 before: 5e1606762556d93e9c176f69)
+```
+
+

data/docs/Telegram.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'telegram']
+**type** | **String** | To configure a Telegram integration, acquire the required information from the user and call the Create Integration endpoint.  | [optional] [default to 'telegram']
 **token** | **String** | Telegram Bot Token. | 
 **username** | **String** | Username of the botId | [optional] [readonly] 
 **bot_id** | **String** | A human-friendly name used to identify the integration. | [optional] [readonly] 

data/docs/TelegramAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'telegram']
+**type** | **String** | To configure a Telegram integration, acquire the required information from the user and call the Create Integration endpoint.  | [optional] [default to 'telegram']
 **token** | **String** | Telegram Bot Token. | 
 **username** | **String** | Username of the botId | [optional] [readonly] 
 **bot_id** | **String** | A human-friendly name used to identify the integration. | [optional] [readonly] 

data/docs/TemplateMessage.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::TemplateMessage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of message. | [optional] [default to 'template']
+**template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://docs.smooch.io/guide/whatsapp#sending-message-templates). `schema` must be set to `whatsapp`. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::TemplateMessage.new(type: null,
+                                 template: null)
+```
+
+

data/docs/Twilio.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'twilio']
+**type** | **String** | To configure a Twilio integration, acquire the required information from the user and call the Create Integration endpoint.  | [optional] [default to 'twilio']
 **account_sid** | **String** | Twilio Account SID. | 
 **auth_token** | **String** | Twilio Auth Token. | 
 **phone_number_sid** | **String** | SID for specific phone number. | 

data/docs/TwilioAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'twilio']
+**type** | **String** | To configure a Twilio integration, acquire the required information from the user and call the Create Integration endpoint.  | [optional] [default to 'twilio']
 **account_sid** | **String** | Twilio Account SID. | 
 **auth_token** | **String** | Twilio Auth Token. | 
 **phone_number_sid** | **String** | SID for specific phone number. | 

data/docs/Twitter.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'twitter']
+**type** | **String** | To set up a Twitter integration, please follow the steps outlined in the [Twitter Setup Guide](https://docs.smooch.io/guide/twitter/#setup).  | [optional] [default to 'twitter']
 **tier** | **String** | Your Twitter app’s tier, sandbox, premium or enterprise. | 
 **env_name** | **String** | The Twitter dev environments label (required for sandbox and premium tiers). | [optional] 
 **consumer_key** | **String** | The consumer key for your Twitter app. | 

data/docs/TwitterAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'twitter']
+**type** | **String** | To set up a Twitter integration, please follow the steps outlined in the [Twitter Setup Guide](https://docs.smooch.io/guide/twitter/#setup).  | [optional] [default to 'twitter']
 **tier** | **String** | Your Twitter app’s tier, sandbox, premium or enterprise. | 
 **env_name** | **String** | The Twitter dev environments label (required for sandbox and premium tiers). | [optional] 
 **consumer_key** | **String** | The consumer key for your Twitter app. | 

data/docs/Viber.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of integration. | [optional] [default to 'viber']
+**type** | **String** | To configure a Viber integration, acquire the Viber Public Account token from the user and call the Create Integration endpoint.  | [optional] [default to 'viber']
 **token** | **String** | Viber Public Account token. | 
 **uri** | **String** | Unique URI of the Viber account. | [optional] [readonly] 
 **account_id** | **String** | Unique ID of the Viber account. | [optional] [readonly]