smooch-api 5.12.0 → 5.13.0

data/docs/DeploymentApi.md

@@ -25,7 +25,10 @@ Activate a phone number on the specified deployment.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -80,7 +83,10 @@ Confirm code to complete phone number activation.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -135,7 +141,10 @@ Create a WhatsApp deployment.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -187,7 +196,10 @@ Delete the specified deployment.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -238,7 +250,10 @@ Get the specified deployment.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -290,7 +305,10 @@ List owned WhatsApp deployments.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end

data/docs/Enums.md

@@ -18,6 +18,8 @@ Name | Type | Description | Notes
 **menuItemType** | **String** |  | [optional] 
 **messageItemSize** | **String** |  | [optional] 
 **messageType** | **String** |  | [optional] 
+**fieldType** | **String** |  | [optional] 
+**quotedMessageType** | **String** |  | [optional] 
 **role** | **String** |  | [optional] 
 **webhookTriggers** | **String** |  | [optional] 
 

data/docs/Field.md

@@ -0,0 +1,19 @@
+# SmoochApi::Field
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The field ID, generated automatically. | [optional] 
+**type** | **String** | The field type. See [**FieldTypeEnum**](Enums.md#FieldTypeEnum) for available values. | 
+**name** | **String** | The name of the field. Each field name must be unique per form. | 
+**label** | **String** | The label to be displayed with the field. | 
+**placeholder** | **String** | The placeholder text of the field that will be rendered. Only for form messages  | [optional] 
+**minSize** | **Integer** | The minimum possible length of the response. Defaults to 1 if not specified. Only for text fields in form messages.  | [optional] 
+**maxSize** | **Integer** | The maximum possible length of the response. Defaults to 128 if not specified. Only for text fields in form messages.  | [optional] 
+**options** | [**Array<Option>**](Option.md) | The field options that can be selected. The array is limited to 20 options. Only for select fields in form messages.  | [optional] 
+**selectSize** | **Integer** | The select size, generated automatically. Only for select fields in form messages.  | [optional] 
+**text** | **String** | The text response to a text field. Required for text fields in form response messages.  | [optional] 
+**email** | **String** | The email response to an email field. Required for email fields in form response messages.  | [optional] 
+**select** | [**Array<Select>**](Select.md) | The options selected as a response to a select field. Required for select fields in form response messages.  | [optional] 
+
+

data/docs/FieldPost.md

@@ -0,0 +1,14 @@
+# SmoochApi::FieldPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The field type. See [**FieldTypeEnum**](Enums.md#FieldTypeEnum) for available values. | 
+**name** | **String** | The name of the field. Each field name must be unique per form. | 
+**label** | **String** | The label to be displayed with the field. | 
+**placeholder** | **String** | The placeholder text of the field that will be rendered. Only for form messages  | [optional] 
+**minSize** | **Integer** | The minimum possible length of the response. Defaults to 1 if not specified. Only for text fields in form messages.  | [optional] 
+**maxSize** | **Integer** | The maximum possible length of the response. Defaults to 128 if not specified. Only for text fields in form messages.  | [optional] 
+**options** | [**Array<Option>**](Option.md) | The field options that can be selected. The array is limited to 20 options. Only for select fields in form messages.  | [optional] 
+
+

data/docs/IntegrationApi.md

@@ -31,7 +31,10 @@ Create an integration for the specified app.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -86,7 +89,10 @@ Create the specified integration’s menu, overriding the app menu if configured
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -144,7 +150,10 @@ Delete the specified integration.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -198,7 +207,10 @@ Delete the specified integration’s menu.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -252,7 +264,10 @@ Get the specified integration.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -307,7 +322,10 @@ Get the specified integration's menu.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -362,7 +380,10 @@ Get the specified integration’s profile.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -417,7 +438,10 @@ List integrations for the specified app.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -477,7 +501,10 @@ Update the specified integration.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -535,7 +562,10 @@ Update the specified integration’s menu.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -593,7 +623,10 @@ Update the specified integration’s profile.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -650,7 +683,10 @@ Upload a photo to be used for the the specified integration’s profile.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end

data/docs/MenuApi.md

@@ -22,7 +22,10 @@ Remove the specified app’s menu.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -74,7 +77,10 @@ Get the specified app’s menu.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -126,7 +132,10 @@ Configure the specified app’s menu.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end

data/docs/Message.md

@@ -20,5 +20,10 @@ Name | Type | Description | Notes
 **actions** | [**Array<Action>**](Action.md) | The actions in the message. | [optional] 
 **payload** | **String** | The payload of a reply action, if applicable. | [optional] 
 **displaySettings** | [**DisplaySettings**](DisplaySettings.md) | Settings to adjust the carousel layout. See [Display Settings](https://docs.smooch.io/rest/#display-settings). | [optional] 
+**blockChatInput** | **BOOLEAN** | Indicates if the Web SDK chat input should be blocked. Defaults to false. Only for form messages.  | [optional] 
+**fields** | [**Array<Field>**](Field.md) | The fields in the form. Required for form and formResponse messages.  | [optional] 
+**submitted** | **BOOLEAN** | Indicates if the form was submitted. Generated automatically. | [optional] 
+**quotedMessage** | [**QuotedMessage**](QuotedMessage.md) | The form message a formResponse message responds to. Required for formResponse messages.  | [optional] 
+**textFallback** | **String** | The text fallback displayed in channels that do not support form messages. Only for formResponse messages. Generated automatically.  | [optional] 
 
 

data/docs/MessagePost.md

@@ -15,6 +15,8 @@ Name | Type | Description | Notes
 **mediaType** | **String** | The mediaType for the message. Required for image/file messages.  | [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] 
+**fields** | [**Array<FieldPost>**](FieldPost.md) | The fields in the form. Required for form messages.  | [optional] 
 **destination** | [**Destination**](Destination.md) | Specifies which channel to deliver a message to. See [list integrations](https://docs.smooch.io/rest/#list-integrations) to get integration ID and type. | [optional] 
 **override** | [**MessageOverride**](MessageOverride.md) | Specifies channel-specific overrides to use in order to bypass Smooch's message translation logic. | [optional] 
 

data/docs/Option.md

@@ -0,0 +1,9 @@
+# SmoochApi::Option
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the option. It must be unique per field. | 
+**label** | **String** | The label the option will be displayed with on Web Messenger. | 
+
+

data/docs/QuotedMessage.md

@@ -0,0 +1,10 @@
+# SmoochApi::QuotedMessage
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The quoted message type. See [**QuotedMessageTypeEnum**](Enums.md#QuotedMessageTypeEnum) for available values. | 
+**externalMessageId** | **String** | The external message Id of the quoted message. Only for quoted messages with type set to externalMessageId.  | [optional] 
+**content** | [**Message**](Message.md) |  | [optional] 
+
+

data/docs/Select.md

@@ -0,0 +1,10 @@
+# SmoochApi::Select
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The select ID, generated automatically. | [optional] 
+**name** | **String** | The name of the selected option. | 
+**label** | **String** | The label of the selected option. | 
+
+

data/docs/ServiceAccountApi.md

@@ -29,7 +29,10 @@ Create a secret key for the specified service account.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -84,7 +87,10 @@ Create a new service account.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -136,7 +142,10 @@ Delete the specified service account secret key.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -190,7 +199,10 @@ Delete the specified service account.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -241,7 +253,10 @@ Get an account-scoped JWT for the specified service account secret key.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -296,7 +311,10 @@ Get the specified service account secret key.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -351,7 +369,10 @@ Get the specified service account.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -403,7 +424,10 @@ List the secret keys for the specified service account.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -455,7 +479,10 @@ List all service accounts configured.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end
@@ -510,7 +537,10 @@ Update the specified service account.
 require 'smooch-api'
 # setup authorization
 SmoochApi.configure do |config|
-  # Configure API key authorization: jwt
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
   config.api_key['Authorization'] = 'YOUR JWT'
   config.api_key_prefix['Authorization'] = 'Bearer'
 end