smooch-api 5.7.0 → 5.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53a7d1c10ebc05bd858a1f7e34aed70776feafca
-  data.tar.gz: eb9db340fb6c330d0e2c4a65d58b7c0e1fb34f22
+  metadata.gz: eacfbd23af7878fa101cff6c9e700895d9fc048a
+  data.tar.gz: 207c01673bbc715c2db72ceebcf4fdfea7e34606
 SHA512:
-  metadata.gz: 88d2c67d5042d53d665c517132e89a95364742b241a4b6373067aba09c6082a31033dcc522b59b7b2b1768514bb66d72b0f2e08eac12bc3895389c346087b86f
-  data.tar.gz: dde5f758bf76b0e0d0edb6b1e2852ed7639604aace7d08641e96e2c04031d0fb8fa2e0b0fd3d443e4cd0ed924e8c52707df65de8d734b5fd03b9f05c8a1ec779
+  metadata.gz: 53e33e973b0c935dbf6b004a2de6b1275cca123eb05b43c45988a2c310114976a5e9b5c1fd629b0676dd98fda029e9d3a0979b253731db493b6d4bf70c77a5d5
+  data.tar.gz: f6dace030dccacf39407b45b7cc4adf03d948c68deee88f47205e4f4c3b77943b556faf95a5c352a59aeaf5377f9f884917aefc7bd1f4d15ed76411744196f49

data/README.md

@@ -25,7 +25,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 5.7.0'
+    gem 'smooch-api', '~> 5.8.0'
 
 ## Getting Started
 
@@ -129,6 +129,12 @@ Class | Method | HTTP request | Description
 *SmoochApi::ConversationApi* | [**get_messages**](docs/ConversationApi.md#get_messages) | **GET** /v1.1/apps/{appId}/appusers/{userId}/messages | 
 *SmoochApi::ConversationApi* | [**post_message**](docs/ConversationApi.md#post_message) | **POST** /v1.1/apps/{appId}/appusers/{userId}/messages | 
 *SmoochApi::ConversationApi* | [**reset_unread_count**](docs/ConversationApi.md#reset_unread_count) | **POST** /v1.1/apps/{appId}/appusers/{userId}/conversation/read | 
+*SmoochApi::DeploymentApi* | [**activate_phone_number**](docs/DeploymentApi.md#activate_phone_number) | **POST** /v1.1/whatsapp/deployments/{deploymentId}/activate | 
+*SmoochApi::DeploymentApi* | [**confirm_code**](docs/DeploymentApi.md#confirm_code) | **POST** /v1.1/whatsapp/deployments/{deploymentId}/code/confirm | 
+*SmoochApi::DeploymentApi* | [**create_deployment**](docs/DeploymentApi.md#create_deployment) | **POST** /v1.1/whatsapp/deployments | 
+*SmoochApi::DeploymentApi* | [**delete_deployment**](docs/DeploymentApi.md#delete_deployment) | **DELETE** /v1.1/whatsapp/deployments/{deploymentId} | 
+*SmoochApi::DeploymentApi* | [**get_deployment**](docs/DeploymentApi.md#get_deployment) | **GET** /v1.1/whatsapp/deployments/{deploymentId} | 
+*SmoochApi::DeploymentApi* | [**list_deployments**](docs/DeploymentApi.md#list_deployments) | **GET** /v1.1/whatsapp/deployments | 
 *SmoochApi::IntegrationApi* | [**create_integration**](docs/IntegrationApi.md#create_integration) | **POST** /v1.1/apps/{appId}/integrations | 
 *SmoochApi::IntegrationApi* | [**create_integration_menu**](docs/IntegrationApi.md#create_integration_menu) | **POST** /v1.1/apps/{appId}/integrations/{integrationId}/menu | 
 *SmoochApi::IntegrationApi* | [**delete_integration**](docs/IntegrationApi.md#delete_integration) | **DELETE** /v1.1/apps/{appId}/integrations/{integrationId} | 
@@ -191,6 +197,11 @@ Class | Method | HTTP request | Description
  - [SmoochApi::Confirmation](docs/Confirmation.md)
  - [SmoochApi::Conversation](docs/Conversation.md)
  - [SmoochApi::ConversationActivity](docs/ConversationActivity.md)
+ - [SmoochApi::Deployment](docs/Deployment.md)
+ - [SmoochApi::DeploymentActivatePhoneNumber](docs/DeploymentActivatePhoneNumber.md)
+ - [SmoochApi::DeploymentConfirmCode](docs/DeploymentConfirmCode.md)
+ - [SmoochApi::DeploymentCreate](docs/DeploymentCreate.md)
+ - [SmoochApi::DeploymentResponse](docs/DeploymentResponse.md)
  - [SmoochApi::Destination](docs/Destination.md)
  - [SmoochApi::DisplaySettings](docs/DisplaySettings.md)
  - [SmoochApi::Enums](docs/Enums.md)
@@ -205,6 +216,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::LinkRequestResponse](docs/LinkRequestResponse.md)
  - [SmoochApi::LinkRequestResponseLinkRequests](docs/LinkRequestResponseLinkRequests.md)
  - [SmoochApi::ListAppsResponse](docs/ListAppsResponse.md)
+ - [SmoochApi::ListDeploymentsResponse](docs/ListDeploymentsResponse.md)
  - [SmoochApi::ListIntegrationsResponse](docs/ListIntegrationsResponse.md)
  - [SmoochApi::ListSecretKeysResponse](docs/ListSecretKeysResponse.md)
  - [SmoochApi::ListServiceAccountsResponse](docs/ListServiceAccountsResponse.md)

data/docs/Action.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The action type. See Enums.md for available values. | 
+**type** | **String** | The action type. See [**ActionTypeEnum**](Enums.md#ActionTypeEnum) for available values. | 
 **text** | **String** | The button text. | 
 **payload** | **String** | The payload to be sent with the resulting webhook. Required for *postback* and *reply* actions.  | [optional] 
 **metadata** | **Object** | Flat JSON object containing any custom properties associated with the action. | [optional] 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **iconUrl** | **String** | An icon to render next to the reply option (Facebook Messenger and Web Messenger only). | [optional] 
 **uri** | **String** | The action URI. This is the link that will be used in the clients when clicking the button. Required for *link* and *webview* actions.  | [optional] 
 **fallback** | **String** | The webview action fallback uri. This is the link that will be used in clients that do not support webviews. Required for *webview* actions.  | [optional] 
-**size** | **String** | The size used to display the webview. Allowed values are [\"compact\", \"tall\", \"full\"]. (Optional) Used for *webview* actions. See Enums.md for available values.  | [optional] 
+**size** | **String** | The size used to display the webview. Allowed values are [\"compact\", \"tall\", \"full\"]. (Optional) Used for *webview* actions. See [**ActionSizeEnum**](Enums.md#ActionSizeEnum) for available values.  | [optional] 
 **extraChannelOptions** | **Object** | Extra options to pass directly to the channel API. See [Extra Channel Options](https://docs.smooch.io/rest#extra-channel-options-schema) | [optional] 
 
 

data/docs/AppUserLink.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of the channel to link. See Enums.md for available values. | 
+**type** | **String** | The type of the channel to link. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. | 
 **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/BusinessSystemItem.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of business system. See Enums.md for available values. | 
+**type** | **String** | The type of business system. See [**BusinessSystemTypeEnum**](Enums.md#BusinessSystemTypeEnum) for available values. | 
 **channelId** | **String** | The channel id for a *slack* integration | [optional] 
 **ticketId** | **String** | The ticket id for a *zendesk* integration | [optional] 
 **roomId** | **Integer** | The room id for a *hipchat* integration | [optional] 

data/docs/ChannelEntityItem.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of channel. See Enums.md for available values. | 
+**type** | **String** | The type of channel. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. | 
 **integrationId** | **String** | The ID of the integration. | [optional] 
 **phoneNumber** | **String** | The phone number for a *twilio* or *messagebird* integration | [optional] 
 **userId** | **String** | The userId for a *messenger*, *viber*, *line*, *wechat* or *twitter* integration | [optional] 

data/docs/Client.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 **id** | **String** | An identifier for the client. Must be globally unique. | 
 **active** | **BOOLEAN** | Flag indicating if the client is active. | [optional] 
 **lastSeen** | **String** | The date time the client was last seen. | [optional] 
-**platform** | **String** | The client's platform. See Enums.md for available values. | 
+**platform** | **String** | The client's platform. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. | 
 **integrationId** | **String** | The ID of the integration that the client was created for. | [optional] 
 **pushNotificationToken** | **String** | The GCM or APN token to be used for sending push notifications to the device. Applies to only *android* and *ios* clients.  | [optional] 
 **appVersion** | **String** | A reserved string field for reporting the app version running on the device. | [optional] 

data/docs/Confirmation.md

@@ -3,7 +3,7 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The confirmation type. See Enums.md for available values. | 
+**type** | **String** | The confirmation type. See [**ConfirmationTypeEnum**](Enums.md#ConfirmationTypeEnum) for available values. | 
 **message** | [**Message**](Message.md) | The message used to reach out to the user. Must be a valid message object as per the post message API. | [optional] 
 
 

data/docs/ConversationActivity.md

@@ -3,8 +3,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**role** | **String** | The role of the actor. Must be *appMaker*. See Enums.md for available values. | 
-**type** | **String** | The type of activity to trigger. Must be either *typing:start* or *typing:stop*. See Enums.md for available values. | 
+**role** | **String** | The role of the actor. Must be *appMaker*. See [**RoleEnum**](Enums.md#RoleEnum) for available values. | 
+**type** | **String** | The type of activity to trigger. Must be either *typing:start* or *typing:stop*. See [**MessageTypeEnum**](Enums.md#MessageTypeEnum) for available values. | 
 **name** | **String** | The name of the app maker that starts or stops typing a response. | [optional] 
 **avatarUrl** | **String** | The avatar URL of the app maker that starts typing a response. | [optional] 
 

data/docs/Deployment.md

@@ -0,0 +1,17 @@
+# SmoochApi::Deployment
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The deployment ID, generated automatically. | 
+**status** | **String** | The deployment status. See [**DeploymentStatusEnum**](Enums.md#DeploymentStatusEnum) for available values. | 
+**hosting** | **String** | The deployment hosting. See [**DeploymentHostingEnum**](Enums.md#DeploymentHostingEnum) for available values. | 
+**baseUrl** | **String** | The baseUrl of the deployment. Only present for `self` hosted deployments. | [optional] 
+**username** | **String** | The username of the deployment. Only present for `self` hosted deployments. | [optional] 
+**phoneNumber** | **String** | The phoneNumber of the deployment. Only present once the deployment has been registered. | [optional] 
+**callbackUrl** | **String** | The URL to be called by Smooch when the status of the deployment changes. | [optional] 
+**callbackSecret** | **String** | The secret used to secure the callback. | [optional] 
+**integrationId** | **String** | The integrationId of the integration using this deployment. | [optional] 
+**appId** | **String** | The appId of the integration using this deployment. | [optional] 
+
+

data/docs/DeploymentActivatePhoneNumber.md

@@ -0,0 +1,10 @@
+# SmoochApi::DeploymentActivatePhoneNumber
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phoneNumber** | **String** | The phone number to send the activation code to. | 
+**verifiedNameCertificate** | **String** | The verified name certificate for the phone number. | 
+**method** | **String** | The method desired to receive the activation code. See [**DeploymentActivationMethodEnum**](Enums.md#DeploymentActivationMethodEnum) for available values. | 
+
+

data/docs/DeploymentApi.md

@@ -0,0 +1,325 @@
+# SmoochApi::DeploymentApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**activate_phone_number**](DeploymentApi.md#activate_phone_number) | **POST** /v1.1/whatsapp/deployments/{deploymentId}/activate | 
+[**confirm_code**](DeploymentApi.md#confirm_code) | **POST** /v1.1/whatsapp/deployments/{deploymentId}/code/confirm | 
+[**create_deployment**](DeploymentApi.md#create_deployment) | **POST** /v1.1/whatsapp/deployments | 
+[**delete_deployment**](DeploymentApi.md#delete_deployment) | **DELETE** /v1.1/whatsapp/deployments/{deploymentId} | 
+[**get_deployment**](DeploymentApi.md#get_deployment) | **GET** /v1.1/whatsapp/deployments/{deploymentId} | 
+[**list_deployments**](DeploymentApi.md#list_deployments) | **GET** /v1.1/whatsapp/deployments | 
+
+
+# **activate_phone_number**
+> DeploymentResponse activate_phone_number(deploymentId, deploymentActivatePhoneNumberBody)
+
+
+
+Activate a phone number on the specified deployment.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::DeploymentApi.new
+
+deploymentId = "deploymentId_example" # String | Identifies the deployment.
+
+deploymentActivatePhoneNumberBody = SmoochApi::DeploymentActivatePhoneNumber.new # DeploymentActivatePhoneNumber | Body for an activatePhoneNumber request. 
+
+
+begin
+  result = api_instance.activate_phone_number(deploymentId, deploymentActivatePhoneNumberBody)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling DeploymentApi->activate_phone_number: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deploymentId** | **String**| Identifies the deployment. | 
+ **deploymentActivatePhoneNumberBody** | [**DeploymentActivatePhoneNumber**](DeploymentActivatePhoneNumber.md)| Body for an activatePhoneNumber request.  | 
+
+### Return type
+
+[**DeploymentResponse**](DeploymentResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **confirm_code**
+> DeploymentResponse confirm_code(deploymentId, deploymentConfirmCode)
+
+
+
+Confirm code to complete phone number activation.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::DeploymentApi.new
+
+deploymentId = "deploymentId_example" # String | Identifies the deployment.
+
+deploymentConfirmCode = SmoochApi::DeploymentConfirmCode.new # DeploymentConfirmCode | Body for a confirmCode request. 
+
+
+begin
+  result = api_instance.confirm_code(deploymentId, deploymentConfirmCode)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling DeploymentApi->confirm_code: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deploymentId** | **String**| Identifies the deployment. | 
+ **deploymentConfirmCode** | [**DeploymentConfirmCode**](DeploymentConfirmCode.md)| Body for a confirmCode request.  | 
+
+### Return type
+
+[**DeploymentResponse**](DeploymentResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_deployment**
+> DeploymentResponse create_deployment(deploymentCreateBody)
+
+
+
+Create a WhatsApp deployment.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::DeploymentApi.new
+
+deploymentCreateBody = SmoochApi::DeploymentCreate.new # DeploymentCreate | Body for a createDeployment request. 
+
+
+begin
+  result = api_instance.create_deployment(deploymentCreateBody)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling DeploymentApi->create_deployment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deploymentCreateBody** | [**DeploymentCreate**](DeploymentCreate.md)| Body for a createDeployment request.  | 
+
+### Return type
+
+[**DeploymentResponse**](DeploymentResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_deployment**
+> delete_deployment(deploymentId, )
+
+
+
+Delete the specified deployment.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::DeploymentApi.new
+
+deploymentId = "deploymentId_example" # String | Identifies the deployment.
+
+
+begin
+  api_instance.delete_deployment(deploymentId, )
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling DeploymentApi->delete_deployment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deploymentId** | **String**| Identifies the deployment. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_deployment**
+> DeploymentResponse get_deployment(deploymentId, )
+
+
+
+Get the specified deployment.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::DeploymentApi.new
+
+deploymentId = "deploymentId_example" # String | Identifies the deployment.
+
+
+begin
+  result = api_instance.get_deployment(deploymentId, )
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling DeploymentApi->get_deployment: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **deploymentId** | **String**| Identifies the deployment. | 
+
+### Return type
+
+[**DeploymentResponse**](DeploymentResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_deployments**
+> ListDeploymentsResponse list_deployments
+
+
+
+List owned WhatsApp deployments.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::DeploymentApi.new
+
+begin
+  result = api_instance.list_deployments
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling DeploymentApi->list_deployments: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListDeploymentsResponse**](ListDeploymentsResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+