smooch-api 5.26.0 → 5.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2727c1b447fe8d1aa90b56594946efb1b2e72c5
-  data.tar.gz: 9e8963b11b0a1f30d8653c6f0c51f507176e6afb
+  metadata.gz: 90d0d302fd9a6eafb34e7aff8d955eb17c745f59
+  data.tar.gz: 739432170aa2c2872700a9818a42bf5bc18ddfc2
 SHA512:
-  metadata.gz: b11f0920c3dd52f00dd66a408622bfe6dbe2dd4aa78cbc60bf3b33f2cf78099a90b2270f170f531d1dcb14ad1b81886e7dbc42d5bb05ec84376d61ba236700b8
-  data.tar.gz: 1c68d47c89909996083ea286fa56f2e662cea97572c5f0f9fa5e7b178c913f5f7e17808174f35b2a2200caeb18214dcb9cc50f142b0ecbc465c6bc675c2772b1
+  metadata.gz: 1b5ce4afbaf6f19262135f339ea6f3200310640b69be4b8383af900f39bd17881c0aa7e03af77560b0aa350558bf93d026f24f4e52e0cb19a79a5148697658cf
+  data.tar.gz: b3eb46087e0bc572a68df4c9fafe84eb39a50e4fec689cc8c4adc411b7868143d0d19f8717d05f3493a0750230290b73e98e3357dca0048fc488fb0c50f3afa2

data/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/README.md

@@ -25,7 +25,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 5.26.0'
+    gem 'smooch-api', '~> 5.34.0'
 
 ## Getting Started
 
@@ -110,6 +110,7 @@ Class | Method | HTTP request | Description
 *SmoochApi::AppApi* | [**delete_secret_key**](docs/AppApi.md#delete_secret_key) | **DELETE** /v1.1/apps/{appId}/keys/{keyId} | 
 *SmoochApi::AppApi* | [**get_app**](docs/AppApi.md#get_app) | **GET** /v1.1/apps/{appId} | 
 *SmoochApi::AppApi* | [**get_app_jwt**](docs/AppApi.md#get_app_jwt) | **GET** /v1.1/apps/{appId}/keys/{keyId}/jwt | 
+*SmoochApi::AppApi* | [**get_sdk_ids**](docs/AppApi.md#get_sdk_ids) | **GET** /v1.1/apps/{appId}/sdks | 
 *SmoochApi::AppApi* | [**get_secret_key**](docs/AppApi.md#get_secret_key) | **GET** /v1.1/apps/{appId}/keys/{keyId} | 
 *SmoochApi::AppApi* | [**list_apps**](docs/AppApi.md#list_apps) | **GET** /v1.1/apps | 
 *SmoochApi::AppApi* | [**list_secret_keys**](docs/AppApi.md#list_secret_keys) | **GET** /v1.1/apps/{appId}/keys | 
@@ -220,6 +221,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::FieldPost](docs/FieldPost.md)
  - [SmoochApi::GetIntegrationProfileResponse](docs/GetIntegrationProfileResponse.md)
  - [SmoochApi::GetMessagesResponse](docs/GetMessagesResponse.md)
+ - [SmoochApi::GetSdkIdsResponse](docs/GetSdkIdsResponse.md)
  - [SmoochApi::Integration](docs/Integration.md)
  - [SmoochApi::IntegrationCreate](docs/IntegrationCreate.md)
  - [SmoochApi::IntegrationProfileUpdate](docs/IntegrationProfileUpdate.md)
@@ -288,3 +290,14 @@ Class | Method | HTTP request | Description
 - **API key parameter name**: Authorization
 - **Location**: HTTP header
 
+
+## Copyright and license
+
+Copyright 2018 Zendesk, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

data/docs/AppApi.md

@@ -10,6 +10,7 @@ Method | HTTP request | Description
 [**delete_secret_key**](AppApi.md#delete_secret_key) | **DELETE** /v1.1/apps/{appId}/keys/{keyId} | 
 [**get_app**](AppApi.md#get_app) | **GET** /v1.1/apps/{appId} | 
 [**get_app_jwt**](AppApi.md#get_app_jwt) | **GET** /v1.1/apps/{appId}/keys/{keyId}/jwt | 
+[**get_sdk_ids**](AppApi.md#get_sdk_ids) | **GET** /v1.1/apps/{appId}/sdks | 
 [**get_secret_key**](AppApi.md#get_secret_key) | **GET** /v1.1/apps/{appId}/keys/{keyId} | 
 [**list_apps**](AppApi.md#list_apps) | **GET** /v1.1/apps | 
 [**list_secret_keys**](AppApi.md#list_secret_keys) | **GET** /v1.1/apps/{appId}/keys | 
@@ -377,6 +378,65 @@ Name | Type | Description  | Notes
 
 
 
+# **get_sdk_ids**
+> GetSdkIdsResponse get_sdk_ids(appId)
+
+
+
+Retrieve the IDs of the three SDK integrations (`android`, `ios`, and `web`) for the specified app, to be used when initializing the SDKs.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure HTTP basic authorization (recommended): basicAuth
+  config.username = 'API_KEY_ID'
+  config.password = 'API_KEY_SECRET'
+
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::AppApi.new
+
+appId = "appId_example" # String | Identifies the app.
+
+
+begin
+  result = api_instance.get_sdk_ids(appId)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->get_sdk_ids: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appId** | **String**| Identifies the app. | 
+
+### Return type
+
+[**GetSdkIdsResponse**](GetSdkIdsResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_secret_key**
 > SecretKeyResponse get_secret_key(appId, keyId)
 

data/docs/AppUserLink.md

@@ -4,6 +4,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The type of the channel to link. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. | 
+**integrationId** | **String** | The id of the integration to link, it must match the provided type. | [optional] 
 **phoneNumber** | **String** | A String of the appUser’s phone number. It must contain the + prefix and the country code. Required for *messenger*, *twilio*, *messagebird* and *whatsapp* linking.  | [optional] 
 **address** | **String** | A String of the appUser’s email address. Required for *mailgun* linking.  | [optional] 
 **givenName** | **String** | A String of the appUser’s given name. Used as additional criteria to increase the likelihood of a match. (Optional) Used for *messenger* linking.  | [optional] 

data/docs/GetSdkIdsResponse.md

@@ -0,0 +1,10 @@
+# SmoochApi::GetSdkIdsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**androidIntegrationId** | **String** | The ID of the `android` integration, used when initializing the Android SDK. | 
+**iosIntegrationId** | **String** | The ID of the `ios` integration, used when initializing the iOS SDK. | 
+**webIntegrationId** | **String** | The ID of the `web` integration, used when initializing the Web Messenger SDK. | 
+
+

data/docs/Integration.md

@@ -6,12 +6,12 @@ Name | Type | Description | Notes
 **id** | **String** | The integration ID, generated automatically. | 
 **type** | **String** | The integration type. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. | 
 **displayName** | **String** | The integration display name. Used to map a human-friendly name to an integration.  | [optional] 
-**pageAccessToken** | **String** | Facebook Page Access Token. Required for *messenger* integrations.  | [optional] 
-**appId** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger* and *wechat* integrations.  | [optional] 
-**appSecret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger* and *wechat* integrations.  | [optional] 
+**pageAccessToken** | **String** | Facebook Page Access Token. Required for *messenger* and *instagram* integrations.  | [optional] 
+**appId** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger*, *instagram* and *wechat* integrations.  | [optional] 
+**appSecret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger*, *instagram* and *wechat* integrations.  | [optional] 
 **accessTokenUrl** | **String** | Optional endpoint to generate access tokens for WeChat. Used to coordinate API access with third party systems.  | [optional] 
 **webhookSecret** | **String** | Secret to verify webhooks. Returned on successful *wechat* and *messagebird* integrations.  | [optional] 
-**pageId** | **String** | Facebook Page App ID. Returned on successful *messenger* integrations.  | [optional] 
+**pageId** | **String** | Facebook Page App ID. Returned on successful *messenger* and *instagram* integrations.  | [optional] 
 **accountSid** | **String** | Twilio Account SID. Required for *twilio* integrations.  | [optional] 
 **authToken** | **String** | Twilio Auth Token. Required for *twilio* integrations.  | [optional] 
 **phoneNumberSid** | **String** | SID for specific phone number. Required for *twilio* integrations.  | [optional] 
@@ -44,13 +44,14 @@ Name | Type | Description | Notes
 **consumerSecret** | **String** | The consumer secret for your Twitter app. Required for *twitter* integrations.  | [optional] 
 **accessTokenKey** | **String** | The access token key obtained from your user via oauth. Required for *twitter* integrations.  | [optional] 
 **accessTokenSecret** | **String** | The access token secret obtained from your user via oauth. Required for *twitter* integrations.  | [optional] 
-**userId** | **String** | The twitter userId. Returned on successful *twitter* integrations.  | [optional] 
-**username** | **String** | The username for the account. Returned on successful *twitter* and *telegram* integrations. Required for *WhatsApp* integrations. (this usage is deprecated)  | [optional] 
+**userId** | **String** | The twitter userId or Facebook userId. Returned on successful *twitter* and *instagram* integrations.  | [optional] 
+**username** | **String** | A twitter, telegram and facebook account username Returned on successful *twitter*, *telegram* and *instagram* integrations. Required for *WhatsApp* integrations. (this usage is deprecated)  | [optional] 
 **apiKey** | **String** | The public API key of your Mailgun account. Required for *mailgun* integrations.  | [optional] 
 **domain** | **String** | The domain used to relay email. Required for *mailgun* integrations.  | [optional] 
 **incomingAddress** | **String** | Smooch will receive all emails sent to this address. Required for *mailgun* integrations.  | [optional] 
 **accessKey** | **String** | The public API key of your MessageBird account. Required for *messagebird* integrations.  | [optional] 
 **originator** | **String** | Smooch will receive all messages sent to this phone number. Required for *messagebird* integrations.  | [optional] 
+**signingKey** | **String** | The signing key of your MessageBird account. Used to validate the webhooks' origin. (Optional) Used for *messagebird* integrations.  | [optional] 
 **brandColor** | **String** | This color will be used in the messenger header and the button or tab in idle state. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **fixedIntroPane** | **BOOLEAN** | When `true`, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. The default value is `false`. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **conversationColor** | **String** | This color will be used for customer messages, quick replies and actions in the footer. (Optional) Used for *Web Messenger* integrations.  | [optional] 
@@ -60,12 +61,16 @@ Name | Type | Description | Notes
 **buttonWidth** | **String** | With the button style Web Messenger, you have the option of specifying its width. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **buttonHeight** | **String** | With the button style Web Messenger, you have the option of specifying its height. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **integrationOrder** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed (Optional) Used for *Web Messenger* integrations.  | [optional] 
-**businessName** | **String** | A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
+**businessName** | **String** | A custom business name for the Web Messenger or Instagram Business account name. (Optional) Used for *Web Messenger* integrations.  | [optional] 
+**businessUsername** | **String** | Instagram Business account username.  | [optional] 
 **businessIconUrl** | **String** | A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **backgroundImageUrl** | **String** | A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **originWhitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454 `scheme \"://\" host [ \":\" port ]`, where scheme is `http` or `https`. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **hideUnsubscribeLink** | **BOOLEAN** | When `true`, unsubscribe links will not be included in outbound emails. If this setting is enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. (Optional) Used for *mailgun* integrations.  | [optional] 
 **status** | **String** | The integration status. See [**IntegrationStatusEnum**](Enums.md#IntegrationStatusEnum) for available values. [More info](https://docs.smooch.io/#integration-status). | [optional] 
 **error** | **String** | The error causing the integration to fail. Will be present when `status` is 'error'. | [optional] 
+**apiSecret** | **String** | A key tied to Apple Business Chat Messaging Service Provider | [optional] 
+**businessId** | **String** | A unique ID tied to the brand using Apple Business Chat or the Instagram Business ID  | [optional] 
+**mspId** | **String** | A unique identifier for an Apple Business Chat partner registered as a Messaging Service Provider through Apple Business Register | [optional] 
 
 

data/docs/IntegrationCreate.md

@@ -5,9 +5,9 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | The integration type. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. | 
 **displayName** | **String** | The integration display name. Used to map a human-friendly name to an integration.  | [optional] 
-**pageAccessToken** | **String** | Facebook Page Access Token. Required for *messenger* integrations.  | [optional] 
-**appId** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger* and *wechat* integrations.  | [optional] 
-**appSecret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger* and *wechat* integrations.  | [optional] 
+**pageAccessToken** | **String** | Facebook Page Access Token. Required for *messenger* and *instagram* integrations.  | [optional] 
+**appId** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger*, *instagram* and *wechat* integrations.  | [optional] 
+**appSecret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger*, *instagram* and *wechat* integrations.  | [optional] 
 **accountSid** | **String** | Twilio Account SID. Required for *twilio* integrations.  | [optional] 
 **authToken** | **String** | Twilio Auth Token. Required for *twilio* integrations.  | [optional] 
 **baseUrl** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations. (this usage is deprecated)  | [optional] 
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
 **fromAddress** | **String** | Email address to use as the `From` and `Reply-To` address if it must be different from `incomingAddress`. Only use this option if the address that you supply is configured to forward emails to the `incomingAddress`, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user's email client.  (Optional) Used for *mailgun* integrations.  | [optional] 
 **certificate** | **String** | The binary of your APN certificate base64 encoded. Required for *apn* integrations.  | [optional] 
 **password** | **String** | The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (this usage is deprecated) (Optional) Used for *apn* integrations.  | [optional] 
-**username** | **String** | The username for the account. Returned on successful *twitter* and *telegram* integrations. Required for *WhatsApp* integrations. (this usage is deprecated)  | [optional] 
+**username** | **String** | A twitter, telegram and facebook account username Returned on successful *twitter*, *telegram* and *instagram* integrations. Required for *WhatsApp* integrations. (this usage is deprecated)  | [optional] 
 **autoUpdateBadge** | **BOOLEAN** | Use the unread count of the conversation as the application badge. (Optional) Used for *apn* integrations.  | [optional] 
 **production** | **BOOLEAN** | Flag specifying the APN environment to connect to (`production` if true, `sandbox` otherwise). Defaults to value inferred from certificate if not specified. (Optional) Used for *apn* integrations.  | [optional] 
 **serverKey** | **String** | Your server key from the fcm console. Required for *fcm* integrations.  | [optional] 
@@ -47,11 +47,18 @@ Name | Type | Description | Notes
 **buttonWidth** | **String** | With the button style Web Messenger, you have the option of specifying its width. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **buttonHeight** | **String** | With the button style Web Messenger, you have the option of specifying its height. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **integrationOrder** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed (Optional) Used for *Web Messenger* integrations.  | [optional] 
-**businessName** | **String** | A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
+**businessName** | **String** | A custom business name for the Web Messenger or Instagram Business account name. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **businessIconUrl** | **String** | A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **backgroundImageUrl** | **String** | A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **originWhitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454 `scheme \"://\" host [ \":\" port ]`, where scheme is `http` or `https`. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **qrCodeUrl** | **String** | URL provided by LINE in the [Developer Console](https://developers.line.biz/console/).  | [optional] 
 **hideUnsubscribeLink** | **BOOLEAN** | When `true`, unsubscribe links will not be included in outbound emails. If this setting is enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. (Optional) Used for *mailgun* integrations.  | [optional] 
+**signingKey** | **String** | The signing key of your MessageBird account. Used to validate the webhooks' origin. (Optional) Used for *messagebird* integrations.  | [optional] 
+**apiKey** | **String** | The public API key of your Mailgun account. Required for *mailgun* integrations.  | [optional] 
+**domain** | **String** | The domain used to relay email. Required for *mailgun* integrations.  | [optional] 
+**incomingAddress** | **String** | Smooch will receive all emails sent to this address. Required for *mailgun* integrations.  | [optional] 
+**apiSecret** | **String** | A key tied to Apple Business Chat Messaging Service Provider | [optional] 
+**businessId** | **String** | A unique ID tied to the brand using Apple Business Chat or the Instagram Business ID  | [optional] 
+**mspId** | **String** | A unique identifier for an Apple Business Chat partner registered as a Messaging Service Provider through Apple Business Register | [optional] 
 
 

data/docs/IntegrationUpdate.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **buttonWidth** | **String** | With the button style Web Messenger, you have the option of specifying its width. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **buttonHeight** | **String** | With the button style Web Messenger, you have the option of specifying its height. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **integrationOrder** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed (Optional) Used for *Web Messenger* integrations.  | [optional] 
-**businessName** | **String** | A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
+**businessName** | **String** | A custom business name for the Web Messenger or Instagram Business account name. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **businessIconUrl** | **String** | A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **backgroundImageUrl** | **String** | A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations.  | [optional] 
 **originWhitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454 `scheme \"://\" host [ \":\" port ]`, where scheme is `http` or `https`. (Optional) Used for *Web Messenger* integrations.  | [optional] 

data/docs/Message.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **received** | **Float** | The unix timestamp of the moment the message was received. | 
 **mediaUrl** | **String** | The mediaUrl for the message. Required for image/file messages.  | [optional] 
 **mediaType** | **String** | The mediaType for the message. Required for image/file messages.  | [optional] 
+**altText** | **String** | An optional description of the image or the file for accessibility purposes. The field will be saved by default with the file name as the value. | [optional] 
 **metadata** | **Object** | Flat JSON object containing any custom properties associated with the message. | [optional] 
 **items** | [**Array<MessageItem>**](MessageItem.md) | The items in the message list. Required for carousel and list messages.  | [optional] 
 **actions** | [**Array<Action>**](Action.md) | The actions in the message. | [optional] 

data/docs/MessageItem.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 **title** | **String** | The title of the message item. | 
 **description** | **String** | The text description, or subtitle. | [optional] 
 **mediaUrl** | **String** | The image URL to be shown in the carousel/list item. | [optional] 
+**altText** | **String** | An optional description of the media for accessibility purposes. The field will be saved by default with the file name as the value. | [optional] 
 **size** | **String** | The size of the image to be shown in the carousel/list item. Only top item of Facebook Messenger carousel supported. See [**MessageItemSizeEnum**](Enums.md#MessageItemSizeEnum) for available values.  | [optional] 
 **mediaType** | **String** | If a *mediaUrl* was specified, the media type is defined here, for example *image/jpeg*. | [optional] 
 **actions** | [**Array<Action>**](Action.md) | Array of [action buttons](https://docs.smooch.io/rest/#action-buttons). At least 1 is required, a maximum of 3 are allowed. | 

data/docs/MessagePost.md

@@ -13,6 +13,7 @@ Name | Type | Description | Notes
 **text** | **String** | The message text. Required for text messages.  | [optional] 
 **mediaUrl** | **String** | The mediaUrl for the message. Required for image/file messages.  | [optional] 
 **mediaType** | **String** | The mediaType for the message. Required for image/file messages.  | [optional] 
+**altText** | **String** | An optional description of the image or the file for accessibility purposes. The field will be saved by default with the file name as the value. | [optional] 
 **items** | [**Array<MessageItem>**](MessageItem.md) | The items in the message list. Required for carousel and list messages.  | [optional] 
 **actions** | [**Array<Action>**](Action.md) | The actions in the message. | [optional] 
 **blockChatInput** | **BOOLEAN** | Indicates if the Web SDK chat input should be blocked. Defaults to false. Only for form messages.  | [optional]