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
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**businessSystems** | [**Array<BusinessSystemItem>**](BusinessSystemItem.md) | An array of objects containing the business system type and the id. |
|
7
7
|
|
8
8
|
|
data/docs/AppUserLink.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**type** | **String** | The type of the channel to link. |
|
7
|
-
**
|
7
|
+
**phoneNumber** | **String** | A String of the appUser’s phone number. It must contain the + prefix and the country code. Required for *messenger*, *twilio* and *messagebird* linking. | [optional]
|
8
8
|
**address** | **String** | A String of the appUser’s email address. Required for *mailgun* linking. | [optional]
|
9
|
-
**
|
9
|
+
**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]
|
10
10
|
**surname** | **String** | A String of the appUser’s surname. Used as additional criteria to increase the likelihood of a match. (Optional) Used for *messenger* linking. | [optional]
|
11
11
|
**subject** | **String** | Subject for the outgoing email. (Optional) Used for *mailgun* linking. | [optional]
|
12
12
|
**confirmation** | [**Confirmation**](Confirmation.md) | Allows you to specify the strategy used to initiate a link with the target user. |
|
data/docs/AppUserPreCreate.md
CHANGED
@@ -3,11 +3,11 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
6
|
+
**userId** | **String** | The app user's userId. This ID is specified by the appMaker. |
|
7
|
+
**givenName** | **String** | The app user's given name. | [optional]
|
8
8
|
**surname** | **String** | The app user's surname. | [optional]
|
9
9
|
**email** | **String** | The app user's email. | [optional]
|
10
|
-
**
|
10
|
+
**signedUpAt** | **String** | A datetime string with the format *yyyy-mm-ddThh:mm:ssZ* representing the moment an appUser was created. | [optional]
|
11
11
|
**properties** | **Object** | Custom properties for the app user. | [optional]
|
12
12
|
|
13
13
|
|
data/docs/AppUserResponse.md
CHANGED
data/docs/AppUserUpdate.md
CHANGED
@@ -3,10 +3,10 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**givenName** | **String** | The app user's given name. | [optional]
|
7
7
|
**surname** | **String** | The app user's surname. | [optional]
|
8
8
|
**email** | **String** | The app user's email. | [optional]
|
9
|
-
**
|
9
|
+
**signedUpAt** | **String** | A datetime string with the format *yyyy-mm-ddThh:mm:ssZ* representing the moment an appUser was created. | [optional]
|
10
10
|
**properties** | **Object** | Custom properties for the app user. | [optional]
|
11
11
|
|
12
12
|
|
data/docs/AttachmentRemove.md
CHANGED
@@ -3,6 +3,6 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
6
|
+
**mediaUrl** | **String** | The mediaUrl for the message. Required for image/file messages. |
|
7
7
|
|
8
8
|
|
data/docs/AttachmentResponse.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
6
|
+
**mediaUrl** | **String** | The mediaUrl for the message. Required for image/file messages. |
|
7
|
+
**mediaType** | **String** | The mediaType for the message. Required for image/file messages. |
|
8
8
|
|
9
9
|
|
data/docs/AttachmentsApi.md
CHANGED
@@ -9,7 +9,7 @@ Method | HTTP request | Description
|
|
9
9
|
|
10
10
|
|
11
11
|
# **remove_attachment**
|
12
|
-
> remove_attachment(
|
12
|
+
> remove_attachment(appId, attachmentRemoveBody)
|
13
13
|
|
14
14
|
|
15
15
|
|
@@ -28,13 +28,13 @@ end
|
|
28
28
|
|
29
29
|
api_instance = SmoochApi::AttachmentsApi.new
|
30
30
|
|
31
|
-
|
31
|
+
appId = "appId_example" # String | Identifies the app.
|
32
32
|
|
33
|
-
|
33
|
+
attachmentRemoveBody = SmoochApi::AttachmentRemove.new # AttachmentRemove | Body for a removeAttachment request.
|
34
34
|
|
35
35
|
|
36
36
|
begin
|
37
|
-
api_instance.remove_attachment(
|
37
|
+
api_instance.remove_attachment(appId, attachmentRemoveBody)
|
38
38
|
rescue SmoochApi::ApiError => e
|
39
39
|
puts "Exception when calling AttachmentsApi->remove_attachment: #{e}"
|
40
40
|
end
|
@@ -44,8 +44,8 @@ end
|
|
44
44
|
|
45
45
|
Name | Type | Description | Notes
|
46
46
|
------------- | ------------- | ------------- | -------------
|
47
|
-
**
|
48
|
-
**
|
47
|
+
**appId** | **String**| Identifies the app. |
|
48
|
+
**attachmentRemoveBody** | [**AttachmentRemove**](AttachmentRemove.md)| Body for a removeAttachment request. |
|
49
49
|
|
50
50
|
### Return type
|
51
51
|
|
@@ -63,7 +63,7 @@ nil (empty response body)
|
|
63
63
|
|
64
64
|
|
65
65
|
# **upload_attachment**
|
66
|
-
> AttachmentResponse upload_attachment(
|
66
|
+
> AttachmentResponse upload_attachment(appId, source, access, opts)
|
67
67
|
|
68
68
|
|
69
69
|
|
@@ -82,20 +82,20 @@ end
|
|
82
82
|
|
83
83
|
api_instance = SmoochApi::AttachmentsApi.new
|
84
84
|
|
85
|
-
|
85
|
+
appId = "appId_example" # String | Identifies the app.
|
86
86
|
|
87
87
|
source = File.new("/path/to/file.txt") # File | File to be uploaded
|
88
88
|
|
89
89
|
access = "access_example" # String | Access level for the resulting file
|
90
90
|
|
91
91
|
opts = {
|
92
|
-
|
93
|
-
|
94
|
-
|
92
|
+
for: "for_example", # String | The intended container for the attachment
|
93
|
+
appUserId: "appUserId_example", # String | The appUserId of the user that will receive the attachment Used in attachments for messages
|
94
|
+
userId: "userId_example" # String | The userId of the user that will receive the attachment Used in attachments for messages
|
95
95
|
}
|
96
96
|
|
97
97
|
begin
|
98
|
-
result = api_instance.upload_attachment(
|
98
|
+
result = api_instance.upload_attachment(appId, source, access, opts)
|
99
99
|
p result
|
100
100
|
rescue SmoochApi::ApiError => e
|
101
101
|
puts "Exception when calling AttachmentsApi->upload_attachment: #{e}"
|
@@ -106,12 +106,12 @@ end
|
|
106
106
|
|
107
107
|
Name | Type | Description | Notes
|
108
108
|
------------- | ------------- | ------------- | -------------
|
109
|
-
**
|
109
|
+
**appId** | **String**| Identifies the app. |
|
110
110
|
**source** | **File**| File to be uploaded |
|
111
111
|
**access** | **String**| Access level for the resulting file |
|
112
|
-
**
|
113
|
-
**
|
114
|
-
**
|
112
|
+
**for** | **String**| The intended container for the attachment | [optional]
|
113
|
+
**appUserId** | **String**| The appUserId of the user that will receive the attachment Used in attachments for messages | [optional]
|
114
|
+
**userId** | **String**| The userId of the user that will receive the attachment Used in attachments for messages | [optional]
|
115
115
|
|
116
116
|
### Return type
|
117
117
|
|
data/docs/AuthCodeResponse.md
CHANGED
data/docs/BusinessSystemItem.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**type** | **String** | The type of business system (ex. slack, hipchat, zendesk etc...) |
|
7
|
-
**
|
8
|
-
**
|
9
|
-
**
|
10
|
-
**
|
7
|
+
**channelId** | **String** | The channel id for a *slack* integration | [optional]
|
8
|
+
**ticketId** | **String** | The ticket id for a *zendesk* integration | [optional]
|
9
|
+
**roomId** | **Integer** | The room id for a *hipchat* integration | [optional]
|
10
|
+
**conversationId** | **String** | The conversation id for a *helpscout* integration | [optional]
|
11
11
|
|
12
12
|
|
data/docs/ChannelEntityItem.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**type** | **String** | The type of channel (ex. messenger, viber, twilio etc...) |
|
7
|
-
**
|
8
|
-
**
|
7
|
+
**phoneNumber** | **String** | The phone number for a *twilio*, *messageBird* integration | [optional]
|
8
|
+
**userId** | **String** | The userId for a *messenger*, *viber*, *line*, *wechat* integration | [optional]
|
9
9
|
**address** | **String** | The email address for a *frontendEmail*, *mailgun* integration | [optional]
|
10
|
-
**
|
10
|
+
**chatId** | **String** | The chat id for a *telegram* integration | [optional]
|
11
11
|
|
12
12
|
|
data/docs/Client.md
CHANGED
@@ -5,11 +5,11 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**id** | **String** | An identifier for the client. Must be globally unique. |
|
7
7
|
**active** | **BOOLEAN** | Flag indicating if the client is active. | [optional]
|
8
|
-
**
|
8
|
+
**lastSeen** | **String** | The date time the client was last seen. | [optional]
|
9
9
|
**platform** | **String** | The client's platform. |
|
10
|
-
**
|
11
|
-
**
|
12
|
-
**
|
10
|
+
**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]
|
11
|
+
**appVersion** | **String** | A reserved string field for reporting the app version running on the device. | [optional]
|
12
|
+
**displayName** | **String** | The client's display name. | [optional]
|
13
13
|
**info** | [**ClientInfo**](ClientInfo.md) | | [optional]
|
14
14
|
**raw** | **Object** | An Object with raw properties that vary for each client platform. All keys are optional and not guaranteed to be available. | [optional]
|
15
15
|
|
data/docs/ClientInfo.md
CHANGED
@@ -3,20 +3,20 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
6
|
+
**appName** | **String** | Name of the app associated with the client. | [optional]
|
7
|
+
**avatarUrl** | **String** | The client's avatar URL. | [optional]
|
8
8
|
**carrier** | **String** | The client's carrier. | [optional]
|
9
9
|
**city** | **String** | The client's city. | [optional]
|
10
10
|
**country** | **String** | The client's country. | [optional]
|
11
|
-
**
|
12
|
-
**
|
11
|
+
**deviceModel** | **String** | The client's device model. | [optional]
|
12
|
+
**devicePlatform** | **String** | The client's device platform. | [optional]
|
13
13
|
**gender** | **String** | The client user's gender. | [optional]
|
14
|
-
**
|
14
|
+
**isPaymentEnabled** | **BOOLEAN** | Whether or not payment is enabled for client. | [optional]
|
15
15
|
**locale** | **String** | The client's locale. | [optional]
|
16
16
|
**os** | **String** | The client's OS. | [optional]
|
17
|
-
**
|
18
|
-
**
|
19
|
-
**
|
17
|
+
**osVersion** | **String** | The client's OS version. | [optional]
|
18
|
+
**phoneNumber** | **String** | The client's phone number. | [optional]
|
19
|
+
**radioAccessTechnology** | **String** | The client's radioAccessTechnology (Ex. HSDPA). | [optional]
|
20
20
|
**state** | **String** | The client's state or province. | [optional]
|
21
21
|
**timezone** | **Integer** | The client's timezone offset. | [optional]
|
22
22
|
**wifi** | **String** | Whether or not the client has wifi. | [optional]
|
data/docs/Conversation.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**
|
7
|
-
**
|
6
|
+
**id** | **String** | The conversation ID, generated automatically. |
|
7
|
+
**unreadCount** | **Integer** | The number of unread messages in the conversation. |
|
8
8
|
|
9
9
|
|
data/docs/ConversationApi.md
CHANGED
@@ -13,7 +13,7 @@ Method | HTTP request | Description
|
|
13
13
|
|
14
14
|
|
15
15
|
# **delete_message**
|
16
|
-
> delete_message(
|
16
|
+
> delete_message(appId, userId, messageId)
|
17
17
|
|
18
18
|
|
19
19
|
|
@@ -32,15 +32,15 @@ end
|
|
32
32
|
|
33
33
|
api_instance = SmoochApi::ConversationApi.new
|
34
34
|
|
35
|
-
|
35
|
+
appId = "appId_example" # String | Identifies the app.
|
36
36
|
|
37
|
-
|
37
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
38
38
|
|
39
|
-
|
39
|
+
messageId = "messageId_example" # String | Identifies the message.
|
40
40
|
|
41
41
|
|
42
42
|
begin
|
43
|
-
api_instance.delete_message(
|
43
|
+
api_instance.delete_message(appId, userId, messageId)
|
44
44
|
rescue SmoochApi::ApiError => e
|
45
45
|
puts "Exception when calling ConversationApi->delete_message: #{e}"
|
46
46
|
end
|
@@ -50,9 +50,9 @@ end
|
|
50
50
|
|
51
51
|
Name | Type | Description | Notes
|
52
52
|
------------- | ------------- | ------------- | -------------
|
53
|
-
**
|
54
|
-
**
|
55
|
-
**
|
53
|
+
**appId** | **String**| Identifies the app. |
|
54
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
55
|
+
**messageId** | **String**| Identifies the message. |
|
56
56
|
|
57
57
|
### Return type
|
58
58
|
|
@@ -70,7 +70,7 @@ nil (empty response body)
|
|
70
70
|
|
71
71
|
|
72
72
|
# **delete_messages**
|
73
|
-
> delete_messages(
|
73
|
+
> delete_messages(appId, userId, )
|
74
74
|
|
75
75
|
|
76
76
|
|
@@ -89,13 +89,13 @@ end
|
|
89
89
|
|
90
90
|
api_instance = SmoochApi::ConversationApi.new
|
91
91
|
|
92
|
-
|
92
|
+
appId = "appId_example" # String | Identifies the app.
|
93
93
|
|
94
|
-
|
94
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
95
95
|
|
96
96
|
|
97
97
|
begin
|
98
|
-
api_instance.delete_messages(
|
98
|
+
api_instance.delete_messages(appId, userId, )
|
99
99
|
rescue SmoochApi::ApiError => e
|
100
100
|
puts "Exception when calling ConversationApi->delete_messages: #{e}"
|
101
101
|
end
|
@@ -105,8 +105,8 @@ end
|
|
105
105
|
|
106
106
|
Name | Type | Description | Notes
|
107
107
|
------------- | ------------- | ------------- | -------------
|
108
|
-
**
|
109
|
-
**
|
108
|
+
**appId** | **String**| Identifies the app. |
|
109
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
110
110
|
|
111
111
|
### Return type
|
112
112
|
|
@@ -124,7 +124,7 @@ nil (empty response body)
|
|
124
124
|
|
125
125
|
|
126
126
|
# **get_messages**
|
127
|
-
> GetMessagesResponse get_messages(
|
127
|
+
> GetMessagesResponse get_messages(appId, userId, , opts)
|
128
128
|
|
129
129
|
|
130
130
|
|
@@ -143,9 +143,9 @@ end
|
|
143
143
|
|
144
144
|
api_instance = SmoochApi::ConversationApi.new
|
145
145
|
|
146
|
-
|
146
|
+
appId = "appId_example" # String | Identifies the app.
|
147
147
|
|
148
|
-
|
148
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
149
149
|
|
150
150
|
opts = {
|
151
151
|
before: "before_example", # String | Timestamp of message. The API will return 100 messages before the specified timestamp (excluding any messages with the provided timestamp).
|
@@ -153,7 +153,7 @@ opts = {
|
|
153
153
|
}
|
154
154
|
|
155
155
|
begin
|
156
|
-
result = api_instance.get_messages(
|
156
|
+
result = api_instance.get_messages(appId, userId, , opts)
|
157
157
|
p result
|
158
158
|
rescue SmoochApi::ApiError => e
|
159
159
|
puts "Exception when calling ConversationApi->get_messages: #{e}"
|
@@ -164,8 +164,8 @@ end
|
|
164
164
|
|
165
165
|
Name | Type | Description | Notes
|
166
166
|
------------- | ------------- | ------------- | -------------
|
167
|
-
**
|
168
|
-
**
|
167
|
+
**appId** | **String**| Identifies the app. |
|
168
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
169
169
|
**before** | **String**| Timestamp of message. The API will return 100 messages before the specified timestamp (excluding any messages with the provided timestamp). | [optional]
|
170
170
|
**after** | **String**| Timestamp of message. The API will return 100 messages after the specified timestamp (excluding any messages with the provided timestamp). | [optional]
|
171
171
|
|
@@ -185,7 +185,7 @@ Name | Type | Description | Notes
|
|
185
185
|
|
186
186
|
|
187
187
|
# **post_message**
|
188
|
-
> MessageResponse post_message(
|
188
|
+
> MessageResponse post_message(appId, userId, messagePostBody)
|
189
189
|
|
190
190
|
|
191
191
|
|
@@ -204,15 +204,15 @@ end
|
|
204
204
|
|
205
205
|
api_instance = SmoochApi::ConversationApi.new
|
206
206
|
|
207
|
-
|
207
|
+
appId = "appId_example" # String | Identifies the app.
|
208
208
|
|
209
|
-
|
209
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
210
210
|
|
211
|
-
|
211
|
+
messagePostBody = SmoochApi::MessagePost.new # MessagePost | Body for a postMessage request. Additional arguments are necessary based on message type ([text](https://docs.smooch.io/rest#text-message), [image](https://docs.smooch.io/rest#image-message), [carousel](https://docs.smooch.io/rest#carousel-message), [list](https://docs.smooch.io/rest#list-message))
|
212
212
|
|
213
213
|
|
214
214
|
begin
|
215
|
-
result = api_instance.post_message(
|
215
|
+
result = api_instance.post_message(appId, userId, messagePostBody)
|
216
216
|
p result
|
217
217
|
rescue SmoochApi::ApiError => e
|
218
218
|
puts "Exception when calling ConversationApi->post_message: #{e}"
|
@@ -223,9 +223,9 @@ end
|
|
223
223
|
|
224
224
|
Name | Type | Description | Notes
|
225
225
|
------------- | ------------- | ------------- | -------------
|
226
|
-
**
|
227
|
-
**
|
228
|
-
**
|
226
|
+
**appId** | **String**| Identifies the app. |
|
227
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
228
|
+
**messagePostBody** | [**MessagePost**](MessagePost.md)| Body for a postMessage request. Additional arguments are necessary based on message type ([text](https://docs.smooch.io/rest#text-message), [image](https://docs.smooch.io/rest#image-message), [carousel](https://docs.smooch.io/rest#carousel-message), [list](https://docs.smooch.io/rest#list-message)) |
|
229
229
|
|
230
230
|
### Return type
|
231
231
|
|
@@ -243,7 +243,7 @@ Name | Type | Description | Notes
|
|
243
243
|
|
244
244
|
|
245
245
|
# **reset_unread_count**
|
246
|
-
> reset_unread_count(
|
246
|
+
> reset_unread_count(appId, userId, )
|
247
247
|
|
248
248
|
|
249
249
|
|
@@ -262,13 +262,13 @@ end
|
|
262
262
|
|
263
263
|
api_instance = SmoochApi::ConversationApi.new
|
264
264
|
|
265
|
-
|
265
|
+
appId = "appId_example" # String | Identifies the app.
|
266
266
|
|
267
|
-
|
267
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
268
268
|
|
269
269
|
|
270
270
|
begin
|
271
|
-
api_instance.reset_unread_count(
|
271
|
+
api_instance.reset_unread_count(appId, userId, )
|
272
272
|
rescue SmoochApi::ApiError => e
|
273
273
|
puts "Exception when calling ConversationApi->reset_unread_count: #{e}"
|
274
274
|
end
|
@@ -278,8 +278,8 @@ end
|
|
278
278
|
|
279
279
|
Name | Type | Description | Notes
|
280
280
|
------------- | ------------- | ------------- | -------------
|
281
|
-
**
|
282
|
-
**
|
281
|
+
**appId** | **String**| Identifies the app. |
|
282
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
283
283
|
|
284
284
|
### Return type
|
285
285
|
|
@@ -297,7 +297,7 @@ nil (empty response body)
|
|
297
297
|
|
298
298
|
|
299
299
|
# **trigger_typing_activity**
|
300
|
-
> trigger_typing_activity(
|
300
|
+
> trigger_typing_activity(appId, userId, typingActivityTriggerBody)
|
301
301
|
|
302
302
|
|
303
303
|
|
@@ -316,15 +316,15 @@ end
|
|
316
316
|
|
317
317
|
api_instance = SmoochApi::ConversationApi.new
|
318
318
|
|
319
|
-
|
319
|
+
appId = "appId_example" # String | Identifies the app.
|
320
320
|
|
321
|
-
|
321
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
322
322
|
|
323
|
-
|
323
|
+
typingActivityTriggerBody = SmoochApi::TypingActivityTrigger.new # TypingActivityTrigger | Body for a triggerTypingActivity request.
|
324
324
|
|
325
325
|
|
326
326
|
begin
|
327
|
-
api_instance.trigger_typing_activity(
|
327
|
+
api_instance.trigger_typing_activity(appId, userId, typingActivityTriggerBody)
|
328
328
|
rescue SmoochApi::ApiError => e
|
329
329
|
puts "Exception when calling ConversationApi->trigger_typing_activity: #{e}"
|
330
330
|
end
|
@@ -334,9 +334,9 @@ end
|
|
334
334
|
|
335
335
|
Name | Type | Description | Notes
|
336
336
|
------------- | ------------- | ------------- | -------------
|
337
|
-
**
|
338
|
-
**
|
339
|
-
**
|
337
|
+
**appId** | **String**| Identifies the app. |
|
338
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
339
|
+
**typingActivityTriggerBody** | [**TypingActivityTrigger**](TypingActivityTrigger.md)| Body for a triggerTypingActivity request. |
|
340
340
|
|
341
341
|
### Return type
|
342
342
|
|