smooch-api 4.1.0 → 4.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -3
- data/docs/Action.md +2 -2
- data/docs/App.md +2 -2
- data/docs/AppApi.md +48 -48
- data/docs/AppSettings.md +2 -2
- data/docs/AppUser.md +6 -6
- data/docs/AppUserApi.md +78 -78
- data/docs/AppUserBusinessSystemsResponse.md +1 -1
- data/docs/AppUserLink.md +2 -2
- data/docs/AppUserPreCreate.md +3 -3
- data/docs/AppUserResponse.md +1 -1
- data/docs/AppUserUpdate.md +2 -2
- data/docs/AttachmentRemove.md +1 -1
- data/docs/AttachmentResponse.md +2 -2
- data/docs/AttachmentsApi.md +16 -16
- data/docs/AuthCodeResponse.md +1 -1
- data/docs/BusinessSystemItem.md +4 -4
- data/docs/ChannelEntityItem.md +3 -3
- data/docs/Client.md +4 -4
- data/docs/ClientInfo.md +8 -8
- data/docs/Conversation.md +2 -2
- data/docs/ConversationApi.md +42 -42
- data/docs/Destination.md +2 -2
- data/docs/DisplaySettings.md +1 -1
- data/docs/GetMessagesResponse.md +1 -1
- data/docs/Integration.md +44 -44
- data/docs/IntegrationApi.md +66 -66
- data/docs/IntegrationCreate.md +36 -36
- data/docs/IntegrationProfileUpdate.md +1 -1
- data/docs/IntegrationUpdate.md +16 -16
- data/docs/LinkRequestResponse.md +1 -1
- data/docs/LinkRequestResponseLinkRequests.md +1 -1
- data/docs/ListAppsResponse.md +1 -1
- data/docs/ListServiceAccountsResponse.md +2 -2
- data/docs/ListTemplatesResponse.md +1 -1
- data/docs/MenuApi.md +14 -14
- data/docs/Message.md +6 -6
- data/docs/MessageItem.md +2 -2
- data/docs/MessageOverride.md +8 -0
- data/docs/MessageOverrideWhatsapp.md +8 -0
- data/docs/MessagePost.md +4 -3
- data/docs/MessageResponse.md +1 -1
- data/docs/SecretKey.md +1 -1
- data/docs/ServiceAccount.md +1 -1
- data/docs/ServiceAccountApi.md +46 -46
- data/docs/ServiceAccountResponse.md +1 -1
- data/docs/Template.md +1 -1
- data/docs/TemplateApi.md +30 -30
- data/docs/TypingActivityTrigger.md +1 -1
- data/docs/Webhook.md +1 -1
- data/docs/WebhookApi.md +30 -30
- data/lib/smooch-api.rb +3 -1
- data/lib/smooch-api/api/app_api.rb +112 -112
- data/lib/smooch-api/api/app_user_api.rb +190 -190
- data/lib/smooch-api/api/attachments_api.rb +34 -34
- data/lib/smooch-api/api/conversation_api.rb +102 -102
- data/lib/smooch-api/api/integration_api.rb +161 -161
- data/lib/smooch-api/api/menu_api.rb +34 -34
- data/lib/smooch-api/api/service_account_api.rb +109 -109
- data/lib/smooch-api/api/template_api.rb +73 -73
- data/lib/smooch-api/api/webhook_api.rb +73 -73
- data/lib/smooch-api/api_client.rb +1 -1
- data/lib/smooch-api/api_error.rb +1 -1
- data/lib/smooch-api/configuration.rb +1 -1
- data/lib/smooch-api/models/action.rb +12 -12
- data/lib/smooch-api/models/app.rb +18 -18
- data/lib/smooch-api/models/app_create.rb +1 -1
- data/lib/smooch-api/models/app_response.rb +1 -1
- data/lib/smooch-api/models/app_settings.rb +12 -12
- data/lib/smooch-api/models/app_update.rb +1 -1
- data/lib/smooch-api/models/app_user.rb +38 -38
- data/lib/smooch-api/models/app_user_business_systems_response.rb +10 -10
- data/lib/smooch-api/models/app_user_channels_response.rb +1 -1
- data/lib/smooch-api/models/app_user_link.rb +12 -12
- data/lib/smooch-api/models/app_user_pre_create.rb +20 -20
- data/lib/smooch-api/models/app_user_response.rb +10 -10
- data/lib/smooch-api/models/app_user_update.rb +12 -12
- data/lib/smooch-api/models/attachment_remove.rb +10 -10
- data/lib/smooch-api/models/attachment_response.rb +18 -18
- data/lib/smooch-api/models/auth_code_response.rb +10 -10
- data/lib/smooch-api/models/business_system_item.rb +22 -22
- data/lib/smooch-api/models/channel_entity_item.rb +17 -17
- data/lib/smooch-api/models/client.rb +22 -22
- data/lib/smooch-api/models/client_info.rb +42 -42
- data/lib/smooch-api/models/confirmation.rb +1 -1
- data/lib/smooch-api/models/conversation.rb +18 -18
- data/lib/smooch-api/models/destination.rb +18 -18
- data/lib/smooch-api/models/display_settings.rb +7 -7
- data/lib/smooch-api/models/get_messages_response.rb +7 -7
- data/lib/smooch-api/models/integration.rb +225 -225
- data/lib/smooch-api/models/integration_create.rb +182 -182
- data/lib/smooch-api/models/integration_profile_update.rb +7 -7
- data/lib/smooch-api/models/integration_response.rb +1 -1
- data/lib/smooch-api/models/integration_update.rb +82 -82
- data/lib/smooch-api/models/jwt_response.rb +1 -1
- data/lib/smooch-api/models/link_request_response.rb +7 -7
- data/lib/smooch-api/models/link_request_response_link_requests.rb +10 -10
- data/lib/smooch-api/models/list_apps_response.rb +7 -7
- data/lib/smooch-api/models/list_integrations_response.rb +1 -1
- data/lib/smooch-api/models/list_secret_keys_response.rb +1 -1
- data/lib/smooch-api/models/list_service_accounts_response.rb +12 -12
- data/lib/smooch-api/models/list_templates_response.rb +7 -7
- data/lib/smooch-api/models/list_webhooks_response.rb +1 -1
- data/lib/smooch-api/models/menu.rb +1 -1
- data/lib/smooch-api/models/menu_item.rb +1 -1
- data/lib/smooch-api/models/menu_response.rb +1 -1
- data/lib/smooch-api/models/message.rb +41 -41
- data/lib/smooch-api/models/message_item.rb +12 -12
- data/lib/smooch-api/models/message_override.rb +188 -0
- data/lib/smooch-api/models/message_override_whatsapp.rb +189 -0
- data/lib/smooch-api/models/message_post.rb +30 -20
- data/lib/smooch-api/models/message_response.rb +7 -7
- data/lib/smooch-api/models/secret_key.rb +10 -10
- data/lib/smooch-api/models/secret_key_create.rb +1 -1
- data/lib/smooch-api/models/secret_key_response.rb +1 -1
- data/lib/smooch-api/models/service_account.rb +10 -10
- data/lib/smooch-api/models/service_account_create.rb +1 -1
- data/lib/smooch-api/models/service_account_response.rb +7 -7
- data/lib/smooch-api/models/service_account_update.rb +1 -1
- data/lib/smooch-api/models/source.rb +1 -1
- data/lib/smooch-api/models/sub_menu_item.rb +1 -1
- data/lib/smooch-api/models/template.rb +10 -10
- data/lib/smooch-api/models/template_create.rb +1 -1
- data/lib/smooch-api/models/template_response.rb +1 -1
- data/lib/smooch-api/models/template_update.rb +1 -1
- data/lib/smooch-api/models/typing_activity_trigger.rb +7 -7
- data/lib/smooch-api/models/webhook.rb +10 -10
- data/lib/smooch-api/models/webhook_create.rb +1 -1
- data/lib/smooch-api/models/webhook_response.rb +1 -1
- data/lib/smooch-api/models/webhook_update.rb +1 -1
- data/lib/smooch-api/version.rb +2 -2
- data/smooch-api.gemspec +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +6 -2
data/docs/IntegrationCreate.md
CHANGED
@@ -4,47 +4,47 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**type** | **String** | The integration type. |
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
7
|
+
**pageAccessToken** | **String** | Facebook Page Access Token. Required for *messenger* integrations. | [optional]
|
8
|
+
**appId** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger* and *wechat* integrations. | [optional]
|
9
|
+
**appSecret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger* and *wechat* integrations. | [optional]
|
10
|
+
**accountSid** | **String** | Twilio Account SID. Required for *twilio* integrations. | [optional]
|
11
|
+
**authToken** | **String** | Twilio Auth Token. Required for *twilio* integrations. | [optional]
|
12
|
+
**baseUrl** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations. | [optional]
|
13
|
+
**hsmFallbackLanguage** | **String** | Specification of a fallback language. (Optional) Used for *WhatsApp* integrations. | [optional]
|
14
|
+
**phoneNumberSid** | **String** | SID for specific phone number. Required for *twilio* integrations. | [optional]
|
15
15
|
**token** | **String** | Telegram Bot Token OR Viber Public Account token. Required for *twilio* and *viber* integrations. | [optional]
|
16
|
-
**
|
17
|
-
**
|
18
|
-
**
|
19
|
-
**
|
20
|
-
**
|
16
|
+
**channelId** | **String** | LINE Channel ID. Required for *line* integrations. | [optional]
|
17
|
+
**channelSecret** | **String** | LINE Channel Secret. Required for *line* integrations. | [optional]
|
18
|
+
**channelAccessToken** | **String** | LINE Channel Access Token. Required for *line* integrations. | [optional]
|
19
|
+
**encodingAesKey** | **String** | AES Encoding Key. (Optional) Used for *wechat* integrations. | [optional]
|
20
|
+
**fromAddress** | **String** | Email will display as coming from this address. (Optional) Used for *frontendEmail* integrations. | [optional]
|
21
21
|
**certificate** | **String** | The binary of your APN certificate base64 encoded. Required for *apn* integrations. | [optional]
|
22
22
|
**password** | **String** | The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (Optional) Used for *apn* integrations. | [optional]
|
23
23
|
**username** | **String** | The username for the account. Required for *WhatsApp* integrations. Returned on successful *twitter* and *telegram* integrations. | [optional]
|
24
|
-
**
|
25
|
-
**
|
26
|
-
**
|
24
|
+
**autoUpdateBadge** | **BOOLEAN** | Use the unread count of the conversation as the application badge. (Optional) Used for *apn* integrations. | [optional]
|
25
|
+
**serverKey** | **String** | Your server key from the fcm console. Required for *fcm* integrations. | [optional]
|
26
|
+
**senderId** | **String** | Your sender id from the fcm console. Required for *fcm* integrations. | [optional]
|
27
27
|
**tier** | **String** | Your Twitter app’s tier. Accepted values are enterprise or premium. | [optional]
|
28
|
-
**
|
29
|
-
**
|
30
|
-
**
|
31
|
-
**
|
32
|
-
**
|
33
|
-
**
|
34
|
-
**
|
28
|
+
**envName** | **String** | The Twitter environment name, e.g.: env-beta. Required for *twitter* integrations with *premium* tier. | [optional]
|
29
|
+
**consumerKey** | **String** | The consumer key for your Twitter app. Required for *twitter* integrations. | [optional]
|
30
|
+
**consumerSecret** | **String** | The consumer secret for your Twitter app. Required for *twitter* integrations. | [optional]
|
31
|
+
**accessTokenKey** | **String** | The access token key obtained from your user via oauth. Required for *twitter* integrations. | [optional]
|
32
|
+
**accessTokenSecret** | **String** | The access token secret obtained from your user via oauth. Required for *twitter* integrations. | [optional]
|
33
|
+
**accessTokenUrl** | **String** | Optional endpoint to generate access tokens for WeChat. Used to coordinate API access with third party systems. | [optional]
|
34
|
+
**accessKey** | **String** | The public API key of your MessageBird account. Required for *messagebird* integrations. | [optional]
|
35
35
|
**originator** | **String** | Smooch will receive all messages sent to this phone number. Required for *messagebird* integrations. | [optional]
|
36
|
-
**
|
37
|
-
**
|
38
|
-
**
|
39
|
-
**
|
40
|
-
**
|
41
|
-
**
|
42
|
-
**
|
43
|
-
**
|
44
|
-
**
|
45
|
-
**
|
46
|
-
**
|
47
|
-
**
|
48
|
-
**
|
36
|
+
**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]
|
37
|
+
**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]
|
38
|
+
**conversationColor** | **String** | This color will be used for customer messages, quick replies and actions in the footer. (Optional) Used for *Web Messenger* integrations. | [optional]
|
39
|
+
**actionColor** | **String** | This color will be used for call-to-actions inside your messages. (Optional) Used for *Web Messenger* integrations. | [optional]
|
40
|
+
**displayStyle** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. (Optional) Used for *Web Messenger* integrations. | [optional]
|
41
|
+
**buttonIconUrl** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. (Optional) Used for *Web Messenger* integrations. | [optional]
|
42
|
+
**buttonWidth** | **String** | With the button style Web Messenger, you have the option of specifying its width. (Optional) Used for *Web Messenger* integrations. | [optional]
|
43
|
+
**buttonHeight** | **String** | With the button style Web Messenger, you have the option of specifying its height. (Optional) Used for *Web Messenger* integrations. | [optional]
|
44
|
+
**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]
|
45
|
+
**businessName** | **String** | A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
|
46
|
+
**businessIconUrl** | **String** | A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
|
47
|
+
**backgroundImageUrl** | **String** | A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
|
48
|
+
**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]
|
49
49
|
|
50
50
|
|
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**address** | **String** | Address of the business. Maximum of 256 characters. | [optional]
|
8
8
|
**description** | **String** | Description of the business. Maximum of 256 characters. | [optional]
|
9
9
|
**email** | **String** | Email address to contact the business. Maximum of 128 characters. | [optional]
|
10
|
-
**
|
10
|
+
**photoUrl** | **String** | URL where the business' profile photo is hosted. WhatsApp recommends an image with dimensions of 640x640 and max size of 63KB. | [optional]
|
11
11
|
**vertical** | **String** | Industry of the business. Maximum of 128 characters. | [optional]
|
12
12
|
**websites** | **Array<String>** | URLs associated with the business. Maximum of 2 websites. | [optional]
|
13
13
|
|
data/docs/IntegrationUpdate.md
CHANGED
@@ -3,21 +3,21 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
13
|
-
**
|
14
|
-
**
|
15
|
-
**
|
16
|
-
**
|
17
|
-
**
|
18
|
-
**
|
19
|
-
**
|
20
|
-
**
|
21
|
-
**
|
6
|
+
**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]
|
7
|
+
**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]
|
8
|
+
**conversationColor** | **String** | This color will be used for customer messages, quick replies and actions in the footer. (Optional) Used for *Web Messenger* integrations. | [optional]
|
9
|
+
**actionColor** | **String** | This color will be used for call-to-actions inside your messages. (Optional) Used for *Web Messenger* integrations. | [optional]
|
10
|
+
**displayStyle** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. (Optional) Used for *Web Messenger* integrations. | [optional]
|
11
|
+
**buttonIconUrl** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. (Optional) Used for *Web Messenger* integrations. | [optional]
|
12
|
+
**buttonWidth** | **String** | With the button style Web Messenger, you have the option of specifying its width. (Optional) Used for *Web Messenger* integrations. | [optional]
|
13
|
+
**buttonHeight** | **String** | With the button style Web Messenger, you have the option of specifying its height. (Optional) Used for *Web Messenger* integrations. | [optional]
|
14
|
+
**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]
|
15
|
+
**businessName** | **String** | A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
|
16
|
+
**businessIconUrl** | **String** | A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
|
17
|
+
**backgroundImageUrl** | **String** | A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
|
18
|
+
**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]
|
19
|
+
**channelId** | **String** | LINE Channel ID. Required for *line* integrations. | [optional]
|
20
|
+
**channelSecret** | **String** | LINE Channel Secret. Required for *line* integrations. | [optional]
|
21
|
+
**hsmFallbackLanguage** | **String** | Specification of a fallback language. (Optional) Used for *WhatsApp* integrations. | [optional]
|
22
22
|
|
23
23
|
|
data/docs/LinkRequestResponse.md
CHANGED
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**linkRequests** | [**Array<LinkRequestResponseLinkRequests>**](LinkRequestResponseLinkRequests.md) | The list of link requests. | [optional]
|
7
7
|
|
8
8
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**integrationId** | **String** | The integration ID. |
|
7
7
|
**type** | **String** | The integration type. |
|
8
8
|
**code** | **String** | The link request code. |
|
9
9
|
**url** | **String** | The link request url. |
|
data/docs/ListAppsResponse.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**apps** | [**Array<App>**](App.md) | The list of apps. | [optional]
|
7
|
-
**
|
7
|
+
**hasMore** | **BOOLEAN** | Flag indicating if there are more apps that are not present in the response. | [optional]
|
8
8
|
**offset** | **Integer** | The number of app records skipped in the returned list. | [optional]
|
9
9
|
|
10
10
|
|
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
6
|
+
**serviceAccounts** | [**Array<ServiceAccount>**](ServiceAccount.md) | The list of service accounts. | [optional]
|
7
|
+
**hasMore** | **BOOLEAN** | Flag indicating if there are more service accounts that are not present in the response. | [optional]
|
8
8
|
**offset** | **Integer** | The number of service account records skipped in the returned list. | [optional]
|
9
9
|
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**templates** | [**Array<Template>**](Template.md) | The list of templates. |
|
7
|
-
**
|
7
|
+
**hasMore** | **BOOLEAN** | Flag indicating if there are more templates that are not present in the response. | [optional]
|
8
8
|
**offset** | **Integer** | The number of template records skipped in the returned list. | [optional]
|
9
9
|
|
10
10
|
|
data/docs/MenuApi.md
CHANGED
@@ -10,7 +10,7 @@ Method | HTTP request | Description
|
|
10
10
|
|
11
11
|
|
12
12
|
# **delete_menu**
|
13
|
-
> MenuResponse delete_menu(
|
13
|
+
> MenuResponse delete_menu(appId, )
|
14
14
|
|
15
15
|
|
16
16
|
|
@@ -29,11 +29,11 @@ end
|
|
29
29
|
|
30
30
|
api_instance = SmoochApi::MenuApi.new
|
31
31
|
|
32
|
-
|
32
|
+
appId = "appId_example" # String | Identifies the app.
|
33
33
|
|
34
34
|
|
35
35
|
begin
|
36
|
-
result = api_instance.delete_menu(
|
36
|
+
result = api_instance.delete_menu(appId, )
|
37
37
|
p result
|
38
38
|
rescue SmoochApi::ApiError => e
|
39
39
|
puts "Exception when calling MenuApi->delete_menu: #{e}"
|
@@ -44,7 +44,7 @@ end
|
|
44
44
|
|
45
45
|
Name | Type | Description | Notes
|
46
46
|
------------- | ------------- | ------------- | -------------
|
47
|
-
**
|
47
|
+
**appId** | **String**| Identifies the app. |
|
48
48
|
|
49
49
|
### Return type
|
50
50
|
|
@@ -62,7 +62,7 @@ Name | Type | Description | Notes
|
|
62
62
|
|
63
63
|
|
64
64
|
# **get_menu**
|
65
|
-
> MenuResponse get_menu(
|
65
|
+
> MenuResponse get_menu(appId, )
|
66
66
|
|
67
67
|
|
68
68
|
|
@@ -81,11 +81,11 @@ end
|
|
81
81
|
|
82
82
|
api_instance = SmoochApi::MenuApi.new
|
83
83
|
|
84
|
-
|
84
|
+
appId = "appId_example" # String | Identifies the app.
|
85
85
|
|
86
86
|
|
87
87
|
begin
|
88
|
-
result = api_instance.get_menu(
|
88
|
+
result = api_instance.get_menu(appId, )
|
89
89
|
p result
|
90
90
|
rescue SmoochApi::ApiError => e
|
91
91
|
puts "Exception when calling MenuApi->get_menu: #{e}"
|
@@ -96,7 +96,7 @@ end
|
|
96
96
|
|
97
97
|
Name | Type | Description | Notes
|
98
98
|
------------- | ------------- | ------------- | -------------
|
99
|
-
**
|
99
|
+
**appId** | **String**| Identifies the app. |
|
100
100
|
|
101
101
|
### Return type
|
102
102
|
|
@@ -114,7 +114,7 @@ Name | Type | Description | Notes
|
|
114
114
|
|
115
115
|
|
116
116
|
# **update_menu**
|
117
|
-
> MenuResponse update_menu(
|
117
|
+
> MenuResponse update_menu(appId, menuUpdateBody)
|
118
118
|
|
119
119
|
|
120
120
|
|
@@ -133,13 +133,13 @@ end
|
|
133
133
|
|
134
134
|
api_instance = SmoochApi::MenuApi.new
|
135
135
|
|
136
|
-
|
136
|
+
appId = "appId_example" # String | Identifies the app.
|
137
137
|
|
138
|
-
|
138
|
+
menuUpdateBody = SmoochApi::Menu.new # Menu | Body for a updateMenu request.
|
139
139
|
|
140
140
|
|
141
141
|
begin
|
142
|
-
result = api_instance.update_menu(
|
142
|
+
result = api_instance.update_menu(appId, menuUpdateBody)
|
143
143
|
p result
|
144
144
|
rescue SmoochApi::ApiError => e
|
145
145
|
puts "Exception when calling MenuApi->update_menu: #{e}"
|
@@ -150,8 +150,8 @@ end
|
|
150
150
|
|
151
151
|
Name | Type | Description | Notes
|
152
152
|
------------- | ------------- | ------------- | -------------
|
153
|
-
**
|
154
|
-
**
|
153
|
+
**appId** | **String**| Identifies the app. |
|
154
|
+
**menuUpdateBody** | [**Menu**](Menu.md)| Body for a updateMenu request. |
|
155
155
|
|
156
156
|
### Return type
|
157
157
|
|
data/docs/Message.md
CHANGED
@@ -3,22 +3,22 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
6
|
+
**id** | **String** | The message ID, generated automatically. |
|
7
|
+
**authorId** | **String** | The ID of the message's author. |
|
8
8
|
**role** | **String** | The role of the individual posting the message. Can be either *appUser* or *appMaker*. |
|
9
9
|
**type** | **String** | The message type. |
|
10
10
|
**source** | [**Source**](Source.md) | The source of the message. | [optional]
|
11
11
|
**name** | **String** | The display name of the message author. |
|
12
12
|
**text** | **String** | The message text. Required for text messages. |
|
13
13
|
**email** | **String** | The email address of the message author. | [optional]
|
14
|
-
**
|
14
|
+
**avatarUrl** | **String** | The URL of the desired message avatar image. |
|
15
15
|
**received** | **Float** | The unix timestamp of the moment the message was received. |
|
16
|
-
**
|
17
|
-
**
|
16
|
+
**mediaUrl** | **String** | The mediaUrl for the message. Required for image/file messages. | [optional]
|
17
|
+
**mediaType** | **String** | The mediaType for the message. Required for image/file messages. | [optional]
|
18
18
|
**metadata** | **Object** | Flat JSON object containing any custom properties associated with the message. | [optional]
|
19
19
|
**items** | [**Array<MessageItem>**](MessageItem.md) | The items in the message list. Required for carousel and list messages. | [optional]
|
20
20
|
**actions** | [**Array<Action>**](Action.md) | The actions in the message. | [optional]
|
21
21
|
**payload** | **String** | The payload of a reply action, if applicable. | [optional]
|
22
|
-
**
|
22
|
+
**displaySettings** | [**DisplaySettings**](DisplaySettings.md) | Settings to adjust the carousel layout. See [Display Settings](https://docs.smooch.io/rest/#display-settings). | [optional]
|
23
23
|
|
24
24
|
|
data/docs/MessageItem.md
CHANGED
@@ -5,9 +5,9 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**title** | **String** | The title of the message item. |
|
7
7
|
**description** | **String** | The text description, or subtitle. | [optional]
|
8
|
-
**
|
8
|
+
**mediaUrl** | **String** | The image URL to be shown in the carousel/list item. | [optional]
|
9
9
|
**size** | **String** | The size of the image to be shown in the carousel/list item. Only top item of Facebook Messenger carousel supported. Choose from *compact* and *large*. | [optional]
|
10
|
-
**
|
10
|
+
**mediaType** | **String** | If a *mediaUrl* was specified, the media type is defined here, for example *image/jpeg*. | [optional]
|
11
11
|
**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. |
|
12
12
|
|
13
13
|
|
data/docs/MessagePost.md
CHANGED
@@ -7,14 +7,15 @@ Name | Type | Description | Notes
|
|
7
7
|
**type** | **String** | The message type. |
|
8
8
|
**name** | **String** | The display name of the message author. | [optional]
|
9
9
|
**email** | **String** | The email address of the message author. | [optional]
|
10
|
-
**
|
10
|
+
**avatarUrl** | **String** | The URL of the desired message avatar image. | [optional]
|
11
11
|
**metadata** | **Object** | Flat JSON object containing any custom properties associated with the message. | [optional]
|
12
12
|
**payload** | **String** | The payload of a reply action, if applicable. | [optional]
|
13
13
|
**text** | **String** | The message text. Required for text messages. | [optional]
|
14
|
-
**
|
15
|
-
**
|
14
|
+
**mediaUrl** | **String** | The mediaUrl for the message. Required for image/file messages. | [optional]
|
15
|
+
**mediaType** | **String** | The mediaType for the message. Required for image/file messages. | [optional]
|
16
16
|
**items** | [**Array<MessageItem>**](MessageItem.md) | The items in the message list. Required for carousel and list messages. | [optional]
|
17
17
|
**actions** | [**Array<Action>**](Action.md) | The actions in the message. | [optional]
|
18
18
|
**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]
|
19
|
+
**override** | [**MessageOverride**](MessageOverride.md) | Specifies channel-specific overrides to use in order to bypass Smooch's message translation logic. | [optional]
|
19
20
|
|
20
21
|
|
data/docs/MessageResponse.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**message** | [**Message**](Message.md) | The message. |
|
7
|
-
**
|
7
|
+
**extraMessages** | [**Array<Message>**](Message.md) | List of extra messages created. | [optional]
|
8
8
|
**conversation** | [**Conversation**](Conversation.md) | The conversation. |
|
9
9
|
|
10
10
|
|
data/docs/SecretKey.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**id** | **String** | The secret key ID, generated automatically. |
|
7
7
|
**secret** | **String** | The secret itself. |
|
8
8
|
**name** | **String** | A friendly identifier for the secret key. |
|
9
9
|
|
data/docs/ServiceAccount.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**id** | **String** | The service account's ID. |
|
7
7
|
**name** | **String** | The service account's name. |
|
8
8
|
|
9
9
|
|
data/docs/ServiceAccountApi.md
CHANGED
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
17
17
|
|
18
18
|
|
19
19
|
# **create_secret_key**
|
20
|
-
> SecretKeyResponse create_secret_key(
|
20
|
+
> SecretKeyResponse create_secret_key(serviceAccountId, secretKeyCreateBody)
|
21
21
|
|
22
22
|
|
23
23
|
|
@@ -36,13 +36,13 @@ end
|
|
36
36
|
|
37
37
|
api_instance = SmoochApi::ServiceAccountApi.new
|
38
38
|
|
39
|
-
|
39
|
+
serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.
|
40
40
|
|
41
|
-
|
41
|
+
secretKeyCreateBody = SmoochApi::SecretKeyCreate.new # SecretKeyCreate | Body for a createSecretKey request.
|
42
42
|
|
43
43
|
|
44
44
|
begin
|
45
|
-
result = api_instance.create_secret_key(
|
45
|
+
result = api_instance.create_secret_key(serviceAccountId, secretKeyCreateBody)
|
46
46
|
p result
|
47
47
|
rescue SmoochApi::ApiError => e
|
48
48
|
puts "Exception when calling ServiceAccountApi->create_secret_key: #{e}"
|
@@ -53,8 +53,8 @@ end
|
|
53
53
|
|
54
54
|
Name | Type | Description | Notes
|
55
55
|
------------- | ------------- | ------------- | -------------
|
56
|
-
**
|
57
|
-
**
|
56
|
+
**serviceAccountId** | **String**| Identifies the service account. |
|
57
|
+
**secretKeyCreateBody** | [**SecretKeyCreate**](SecretKeyCreate.md)| Body for a createSecretKey request. |
|
58
58
|
|
59
59
|
### Return type
|
60
60
|
|
@@ -72,7 +72,7 @@ Name | Type | Description | Notes
|
|
72
72
|
|
73
73
|
|
74
74
|
# **create_service_account**
|
75
|
-
> ServiceAccountResponse create_service_account(
|
75
|
+
> ServiceAccountResponse create_service_account(serviceAccountCreateBody)
|
76
76
|
|
77
77
|
|
78
78
|
|
@@ -91,11 +91,11 @@ end
|
|
91
91
|
|
92
92
|
api_instance = SmoochApi::ServiceAccountApi.new
|
93
93
|
|
94
|
-
|
94
|
+
serviceAccountCreateBody = SmoochApi::ServiceAccountCreate.new # ServiceAccountCreate | Body for a createServiceAccount request.
|
95
95
|
|
96
96
|
|
97
97
|
begin
|
98
|
-
result = api_instance.create_service_account(
|
98
|
+
result = api_instance.create_service_account(serviceAccountCreateBody)
|
99
99
|
p result
|
100
100
|
rescue SmoochApi::ApiError => e
|
101
101
|
puts "Exception when calling ServiceAccountApi->create_service_account: #{e}"
|
@@ -106,7 +106,7 @@ end
|
|
106
106
|
|
107
107
|
Name | Type | Description | Notes
|
108
108
|
------------- | ------------- | ------------- | -------------
|
109
|
-
**
|
109
|
+
**serviceAccountCreateBody** | [**ServiceAccountCreate**](ServiceAccountCreate.md)| Body for a createServiceAccount request. |
|
110
110
|
|
111
111
|
### Return type
|
112
112
|
|
@@ -124,7 +124,7 @@ Name | Type | Description | Notes
|
|
124
124
|
|
125
125
|
|
126
126
|
# **delete_secret_key**
|
127
|
-
> delete_secret_key(
|
127
|
+
> delete_secret_key(serviceAccountId, keyId)
|
128
128
|
|
129
129
|
|
130
130
|
|
@@ -143,13 +143,13 @@ end
|
|
143
143
|
|
144
144
|
api_instance = SmoochApi::ServiceAccountApi.new
|
145
145
|
|
146
|
-
|
146
|
+
serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.
|
147
147
|
|
148
|
-
|
148
|
+
keyId = "keyId_example" # String | Identifies the secret key.
|
149
149
|
|
150
150
|
|
151
151
|
begin
|
152
|
-
api_instance.delete_secret_key(
|
152
|
+
api_instance.delete_secret_key(serviceAccountId, keyId)
|
153
153
|
rescue SmoochApi::ApiError => e
|
154
154
|
puts "Exception when calling ServiceAccountApi->delete_secret_key: #{e}"
|
155
155
|
end
|
@@ -159,8 +159,8 @@ end
|
|
159
159
|
|
160
160
|
Name | Type | Description | Notes
|
161
161
|
------------- | ------------- | ------------- | -------------
|
162
|
-
**
|
163
|
-
**
|
162
|
+
**serviceAccountId** | **String**| Identifies the service account. |
|
163
|
+
**keyId** | **String**| Identifies the secret key. |
|
164
164
|
|
165
165
|
### Return type
|
166
166
|
|
@@ -178,7 +178,7 @@ nil (empty response body)
|
|
178
178
|
|
179
179
|
|
180
180
|
# **delete_service_account**
|
181
|
-
> delete_service_account(
|
181
|
+
> delete_service_account(serviceAccountId, )
|
182
182
|
|
183
183
|
|
184
184
|
|
@@ -197,11 +197,11 @@ end
|
|
197
197
|
|
198
198
|
api_instance = SmoochApi::ServiceAccountApi.new
|
199
199
|
|
200
|
-
|
200
|
+
serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.
|
201
201
|
|
202
202
|
|
203
203
|
begin
|
204
|
-
api_instance.delete_service_account(
|
204
|
+
api_instance.delete_service_account(serviceAccountId, )
|
205
205
|
rescue SmoochApi::ApiError => e
|
206
206
|
puts "Exception when calling ServiceAccountApi->delete_service_account: #{e}"
|
207
207
|
end
|
@@ -211,7 +211,7 @@ end
|
|
211
211
|
|
212
212
|
Name | Type | Description | Notes
|
213
213
|
------------- | ------------- | ------------- | -------------
|
214
|
-
**
|
214
|
+
**serviceAccountId** | **String**| Identifies the service account. |
|
215
215
|
|
216
216
|
### Return type
|
217
217
|
|
@@ -229,7 +229,7 @@ nil (empty response body)
|
|
229
229
|
|
230
230
|
|
231
231
|
# **get_jwt**
|
232
|
-
> JwtResponse get_jwt(
|
232
|
+
> JwtResponse get_jwt(serviceAccountId, keyId)
|
233
233
|
|
234
234
|
|
235
235
|
|
@@ -248,13 +248,13 @@ end
|
|
248
248
|
|
249
249
|
api_instance = SmoochApi::ServiceAccountApi.new
|
250
250
|
|
251
|
-
|
251
|
+
serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.
|
252
252
|
|
253
|
-
|
253
|
+
keyId = "keyId_example" # String | Identifies the secret key.
|
254
254
|
|
255
255
|
|
256
256
|
begin
|
257
|
-
result = api_instance.get_jwt(
|
257
|
+
result = api_instance.get_jwt(serviceAccountId, keyId)
|
258
258
|
p result
|
259
259
|
rescue SmoochApi::ApiError => e
|
260
260
|
puts "Exception when calling ServiceAccountApi->get_jwt: #{e}"
|
@@ -265,8 +265,8 @@ end
|
|
265
265
|
|
266
266
|
Name | Type | Description | Notes
|
267
267
|
------------- | ------------- | ------------- | -------------
|
268
|
-
**
|
269
|
-
**
|
268
|
+
**serviceAccountId** | **String**| Identifies the service account. |
|
269
|
+
**keyId** | **String**| Identifies the secret key. |
|
270
270
|
|
271
271
|
### Return type
|
272
272
|
|
@@ -284,7 +284,7 @@ Name | Type | Description | Notes
|
|
284
284
|
|
285
285
|
|
286
286
|
# **get_secret_key**
|
287
|
-
> SecretKeyResponse get_secret_key(
|
287
|
+
> SecretKeyResponse get_secret_key(serviceAccountId, keyId)
|
288
288
|
|
289
289
|
|
290
290
|
|
@@ -303,13 +303,13 @@ end
|
|
303
303
|
|
304
304
|
api_instance = SmoochApi::ServiceAccountApi.new
|
305
305
|
|
306
|
-
|
306
|
+
serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.
|
307
307
|
|
308
|
-
|
308
|
+
keyId = "keyId_example" # String | Identifies the secret key.
|
309
309
|
|
310
310
|
|
311
311
|
begin
|
312
|
-
result = api_instance.get_secret_key(
|
312
|
+
result = api_instance.get_secret_key(serviceAccountId, keyId)
|
313
313
|
p result
|
314
314
|
rescue SmoochApi::ApiError => e
|
315
315
|
puts "Exception when calling ServiceAccountApi->get_secret_key: #{e}"
|
@@ -320,8 +320,8 @@ end
|
|
320
320
|
|
321
321
|
Name | Type | Description | Notes
|
322
322
|
------------- | ------------- | ------------- | -------------
|
323
|
-
**
|
324
|
-
**
|
323
|
+
**serviceAccountId** | **String**| Identifies the service account. |
|
324
|
+
**keyId** | **String**| Identifies the secret key. |
|
325
325
|
|
326
326
|
### Return type
|
327
327
|
|
@@ -339,7 +339,7 @@ Name | Type | Description | Notes
|
|
339
339
|
|
340
340
|
|
341
341
|
# **get_service_account**
|
342
|
-
> ServiceAccountResponse get_service_account(
|
342
|
+
> ServiceAccountResponse get_service_account(serviceAccountId, )
|
343
343
|
|
344
344
|
|
345
345
|
|
@@ -358,11 +358,11 @@ end
|
|
358
358
|
|
359
359
|
api_instance = SmoochApi::ServiceAccountApi.new
|
360
360
|
|
361
|
-
|
361
|
+
serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.
|
362
362
|
|
363
363
|
|
364
364
|
begin
|
365
|
-
result = api_instance.get_service_account(
|
365
|
+
result = api_instance.get_service_account(serviceAccountId, )
|
366
366
|
p result
|
367
367
|
rescue SmoochApi::ApiError => e
|
368
368
|
puts "Exception when calling ServiceAccountApi->get_service_account: #{e}"
|
@@ -373,7 +373,7 @@ end
|
|
373
373
|
|
374
374
|
Name | Type | Description | Notes
|
375
375
|
------------- | ------------- | ------------- | -------------
|
376
|
-
**
|
376
|
+
**serviceAccountId** | **String**| Identifies the service account. |
|
377
377
|
|
378
378
|
### Return type
|
379
379
|
|
@@ -391,7 +391,7 @@ Name | Type | Description | Notes
|
|
391
391
|
|
392
392
|
|
393
393
|
# **list_secret_keys**
|
394
|
-
> ListSecretKeysResponse list_secret_keys(
|
394
|
+
> ListSecretKeysResponse list_secret_keys(serviceAccountId, )
|
395
395
|
|
396
396
|
|
397
397
|
|
@@ -410,11 +410,11 @@ end
|
|
410
410
|
|
411
411
|
api_instance = SmoochApi::ServiceAccountApi.new
|
412
412
|
|
413
|
-
|
413
|
+
serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.
|
414
414
|
|
415
415
|
|
416
416
|
begin
|
417
|
-
result = api_instance.list_secret_keys(
|
417
|
+
result = api_instance.list_secret_keys(serviceAccountId, )
|
418
418
|
p result
|
419
419
|
rescue SmoochApi::ApiError => e
|
420
420
|
puts "Exception when calling ServiceAccountApi->list_secret_keys: #{e}"
|
@@ -425,7 +425,7 @@ end
|
|
425
425
|
|
426
426
|
Name | Type | Description | Notes
|
427
427
|
------------- | ------------- | ------------- | -------------
|
428
|
-
**
|
428
|
+
**serviceAccountId** | **String**| Identifies the service account. |
|
429
429
|
|
430
430
|
### Return type
|
431
431
|
|
@@ -498,7 +498,7 @@ Name | Type | Description | Notes
|
|
498
498
|
|
499
499
|
|
500
500
|
# **update_service_account**
|
501
|
-
> ServiceAccountResponse update_service_account(
|
501
|
+
> ServiceAccountResponse update_service_account(serviceAccountId, serviceAccountUpdateBody)
|
502
502
|
|
503
503
|
|
504
504
|
|
@@ -517,13 +517,13 @@ end
|
|
517
517
|
|
518
518
|
api_instance = SmoochApi::ServiceAccountApi.new
|
519
519
|
|
520
|
-
|
520
|
+
serviceAccountId = "serviceAccountId_example" # String | Identifies the service account.
|
521
521
|
|
522
|
-
|
522
|
+
serviceAccountUpdateBody = SmoochApi::ServiceAccountUpdate.new # ServiceAccountUpdate | Body for an updateServiceAccount request.
|
523
523
|
|
524
524
|
|
525
525
|
begin
|
526
|
-
result = api_instance.update_service_account(
|
526
|
+
result = api_instance.update_service_account(serviceAccountId, serviceAccountUpdateBody)
|
527
527
|
p result
|
528
528
|
rescue SmoochApi::ApiError => e
|
529
529
|
puts "Exception when calling ServiceAccountApi->update_service_account: #{e}"
|
@@ -534,8 +534,8 @@ end
|
|
534
534
|
|
535
535
|
Name | Type | Description | Notes
|
536
536
|
------------- | ------------- | ------------- | -------------
|
537
|
-
**
|
538
|
-
**
|
537
|
+
**serviceAccountId** | **String**| Identifies the service account. |
|
538
|
+
**serviceAccountUpdateBody** | [**ServiceAccountUpdate**](ServiceAccountUpdate.md)| Body for an updateServiceAccount request. |
|
539
539
|
|
540
540
|
### Return type
|
541
541
|
|