smooch-api 4.1.0 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 403be64f63748939d8342c7c4c1d12efeab09f9f
|
|
4
|
+
data.tar.gz: 3b0d427c05f3b533b77ecb580141ac4de87d6112
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 40ce47f78d15bc495165940bf2c84dd8fa5af675554fa60e8599d21cf85034d568b68f12f42ac2f2fa7c82c03612143e53dc2b1307b7b4e227fd0965c0465676
|
|
7
|
+
data.tar.gz: 2474b68d17b7711d9fcc849450e4285b77542287c833093909aace3dc3e9deae9e910d07599d5287b3150cb53ff393a2c39e7065a9e8d03cf44abbff9f16743e
|
data/README.md
CHANGED
|
@@ -25,7 +25,7 @@ gem install smooch-api
|
|
|
25
25
|
|
|
26
26
|
Add this to the Gemfile:
|
|
27
27
|
|
|
28
|
-
gem 'smooch-api', '~> 4.
|
|
28
|
+
gem 'smooch-api', '~> 4.2.0'
|
|
29
29
|
|
|
30
30
|
## Getting Started
|
|
31
31
|
|
|
@@ -69,11 +69,11 @@ end
|
|
|
69
69
|
|
|
70
70
|
api_instance = SmoochApi::AppApi.new
|
|
71
71
|
|
|
72
|
-
|
|
72
|
+
appCreateBody = SmoochApi::AppCreate.new # AppCreate | Body for a createApp request.
|
|
73
73
|
|
|
74
74
|
|
|
75
75
|
begin
|
|
76
|
-
result = api_instance.create_app(
|
|
76
|
+
result = api_instance.create_app(appCreateBody)
|
|
77
77
|
p result
|
|
78
78
|
rescue SmoochApi::ApiError => e
|
|
79
79
|
puts "Exception when calling AppApi->create_app: #{e}"
|
|
@@ -210,6 +210,8 @@ Class | Method | HTTP request | Description
|
|
|
210
210
|
- [SmoochApi::MenuResponse](docs/MenuResponse.md)
|
|
211
211
|
- [SmoochApi::Message](docs/Message.md)
|
|
212
212
|
- [SmoochApi::MessageItem](docs/MessageItem.md)
|
|
213
|
+
- [SmoochApi::MessageOverride](docs/MessageOverride.md)
|
|
214
|
+
- [SmoochApi::MessageOverrideWhatsapp](docs/MessageOverrideWhatsapp.md)
|
|
213
215
|
- [SmoochApi::MessagePost](docs/MessagePost.md)
|
|
214
216
|
- [SmoochApi::MessageResponse](docs/MessageResponse.md)
|
|
215
217
|
- [SmoochApi::SecretKey](docs/SecretKey.md)
|
data/docs/Action.md
CHANGED
|
@@ -10,10 +10,10 @@ Name | Type | Description | Notes
|
|
|
10
10
|
**amount** | **Integer** | The amount being charged. It needs to be specified in cents and is an integer. Required for *buy* actions. | [optional]
|
|
11
11
|
**currency** | **String** | The currency of the amount being charged (USD, CAD, etc.). | [optional]
|
|
12
12
|
**default** | **BOOLEAN** | Flag indicating if the message action is the default for a message item in Facebook Messenger. | [optional]
|
|
13
|
-
**
|
|
13
|
+
**iconUrl** | **String** | An icon to render next to the reply option (Facebook Messenger and Web Messenger only). | [optional]
|
|
14
14
|
**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]
|
|
15
15
|
**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]
|
|
16
16
|
**size** | **String** | The size used to display the webview. Allowed values are [\"compact\", \"tall\", \"full\"]. (Optional) Used for *webview* actions. | [optional]
|
|
17
|
-
**
|
|
17
|
+
**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]
|
|
18
18
|
|
|
19
19
|
|
data/docs/App.md
CHANGED
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**
|
|
7
|
-
**
|
|
6
|
+
**id** | **String** | The app's ID. |
|
|
7
|
+
**appToken** | **String** | The appToken, used to initialize the Web, iOS and Android clients and to make calls to the app user facing API. |
|
|
8
8
|
**name** | **String** | The app's name. |
|
|
9
9
|
**settings** | [**AppSettings**](AppSettings.md) | | [optional]
|
|
10
10
|
**metadata** | **Object** | Flat JSON object containing any custom properties associated with the app. | [optional]
|
data/docs/AppApi.md
CHANGED
|
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
|
17
17
|
|
|
18
18
|
|
|
19
19
|
# **create_app**
|
|
20
|
-
> AppResponse create_app(
|
|
20
|
+
> AppResponse create_app(appCreateBody)
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
|
|
@@ -36,11 +36,11 @@ end
|
|
|
36
36
|
|
|
37
37
|
api_instance = SmoochApi::AppApi.new
|
|
38
38
|
|
|
39
|
-
|
|
39
|
+
appCreateBody = SmoochApi::AppCreate.new # AppCreate | Body for a createApp request.
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
begin
|
|
43
|
-
result = api_instance.create_app(
|
|
43
|
+
result = api_instance.create_app(appCreateBody)
|
|
44
44
|
p result
|
|
45
45
|
rescue SmoochApi::ApiError => e
|
|
46
46
|
puts "Exception when calling AppApi->create_app: #{e}"
|
|
@@ -51,7 +51,7 @@ end
|
|
|
51
51
|
|
|
52
52
|
Name | Type | Description | Notes
|
|
53
53
|
------------- | ------------- | ------------- | -------------
|
|
54
|
-
**
|
|
54
|
+
**appCreateBody** | [**AppCreate**](AppCreate.md)| Body for a createApp request. |
|
|
55
55
|
|
|
56
56
|
### Return type
|
|
57
57
|
|
|
@@ -69,7 +69,7 @@ Name | Type | Description | Notes
|
|
|
69
69
|
|
|
70
70
|
|
|
71
71
|
# **create_secret_key**
|
|
72
|
-
> SecretKeyResponse create_secret_key(
|
|
72
|
+
> SecretKeyResponse create_secret_key(appId, secretKeyCreateBody)
|
|
73
73
|
|
|
74
74
|
|
|
75
75
|
|
|
@@ -88,13 +88,13 @@ end
|
|
|
88
88
|
|
|
89
89
|
api_instance = SmoochApi::AppApi.new
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
appId = "appId_example" # String | Identifies the app.
|
|
92
92
|
|
|
93
|
-
|
|
93
|
+
secretKeyCreateBody = SmoochApi::SecretKeyCreate.new # SecretKeyCreate | Body for a createSecretKey request.
|
|
94
94
|
|
|
95
95
|
|
|
96
96
|
begin
|
|
97
|
-
result = api_instance.create_secret_key(
|
|
97
|
+
result = api_instance.create_secret_key(appId, secretKeyCreateBody)
|
|
98
98
|
p result
|
|
99
99
|
rescue SmoochApi::ApiError => e
|
|
100
100
|
puts "Exception when calling AppApi->create_secret_key: #{e}"
|
|
@@ -105,8 +105,8 @@ end
|
|
|
105
105
|
|
|
106
106
|
Name | Type | Description | Notes
|
|
107
107
|
------------- | ------------- | ------------- | -------------
|
|
108
|
-
**
|
|
109
|
-
**
|
|
108
|
+
**appId** | **String**| Identifies the app. |
|
|
109
|
+
**secretKeyCreateBody** | [**SecretKeyCreate**](SecretKeyCreate.md)| Body for a createSecretKey request. |
|
|
110
110
|
|
|
111
111
|
### Return type
|
|
112
112
|
|
|
@@ -124,7 +124,7 @@ Name | Type | Description | Notes
|
|
|
124
124
|
|
|
125
125
|
|
|
126
126
|
# **delete_app**
|
|
127
|
-
> delete_app(
|
|
127
|
+
> delete_app(appId, )
|
|
128
128
|
|
|
129
129
|
|
|
130
130
|
|
|
@@ -143,11 +143,11 @@ end
|
|
|
143
143
|
|
|
144
144
|
api_instance = SmoochApi::AppApi.new
|
|
145
145
|
|
|
146
|
-
|
|
146
|
+
appId = "appId_example" # String | Identifies the app.
|
|
147
147
|
|
|
148
148
|
|
|
149
149
|
begin
|
|
150
|
-
api_instance.delete_app(
|
|
150
|
+
api_instance.delete_app(appId, )
|
|
151
151
|
rescue SmoochApi::ApiError => e
|
|
152
152
|
puts "Exception when calling AppApi->delete_app: #{e}"
|
|
153
153
|
end
|
|
@@ -157,7 +157,7 @@ end
|
|
|
157
157
|
|
|
158
158
|
Name | Type | Description | Notes
|
|
159
159
|
------------- | ------------- | ------------- | -------------
|
|
160
|
-
**
|
|
160
|
+
**appId** | **String**| Identifies the app. |
|
|
161
161
|
|
|
162
162
|
### Return type
|
|
163
163
|
|
|
@@ -175,7 +175,7 @@ nil (empty response body)
|
|
|
175
175
|
|
|
176
176
|
|
|
177
177
|
# **delete_secret_key**
|
|
178
|
-
> delete_secret_key(
|
|
178
|
+
> delete_secret_key(appId, keyId)
|
|
179
179
|
|
|
180
180
|
|
|
181
181
|
|
|
@@ -194,13 +194,13 @@ end
|
|
|
194
194
|
|
|
195
195
|
api_instance = SmoochApi::AppApi.new
|
|
196
196
|
|
|
197
|
-
|
|
197
|
+
appId = "appId_example" # String | Identifies the app.
|
|
198
198
|
|
|
199
|
-
|
|
199
|
+
keyId = "keyId_example" # String | Identifies the secret key.
|
|
200
200
|
|
|
201
201
|
|
|
202
202
|
begin
|
|
203
|
-
api_instance.delete_secret_key(
|
|
203
|
+
api_instance.delete_secret_key(appId, keyId)
|
|
204
204
|
rescue SmoochApi::ApiError => e
|
|
205
205
|
puts "Exception when calling AppApi->delete_secret_key: #{e}"
|
|
206
206
|
end
|
|
@@ -210,8 +210,8 @@ end
|
|
|
210
210
|
|
|
211
211
|
Name | Type | Description | Notes
|
|
212
212
|
------------- | ------------- | ------------- | -------------
|
|
213
|
-
**
|
|
214
|
-
**
|
|
213
|
+
**appId** | **String**| Identifies the app. |
|
|
214
|
+
**keyId** | **String**| Identifies the secret key. |
|
|
215
215
|
|
|
216
216
|
### Return type
|
|
217
217
|
|
|
@@ -229,7 +229,7 @@ nil (empty response body)
|
|
|
229
229
|
|
|
230
230
|
|
|
231
231
|
# **get_app**
|
|
232
|
-
> AppResponse get_app(
|
|
232
|
+
> AppResponse get_app(appId, )
|
|
233
233
|
|
|
234
234
|
|
|
235
235
|
|
|
@@ -248,11 +248,11 @@ end
|
|
|
248
248
|
|
|
249
249
|
api_instance = SmoochApi::AppApi.new
|
|
250
250
|
|
|
251
|
-
|
|
251
|
+
appId = "appId_example" # String | Identifies the app.
|
|
252
252
|
|
|
253
253
|
|
|
254
254
|
begin
|
|
255
|
-
result = api_instance.get_app(
|
|
255
|
+
result = api_instance.get_app(appId, )
|
|
256
256
|
p result
|
|
257
257
|
rescue SmoochApi::ApiError => e
|
|
258
258
|
puts "Exception when calling AppApi->get_app: #{e}"
|
|
@@ -263,7 +263,7 @@ end
|
|
|
263
263
|
|
|
264
264
|
Name | Type | Description | Notes
|
|
265
265
|
------------- | ------------- | ------------- | -------------
|
|
266
|
-
**
|
|
266
|
+
**appId** | **String**| Identifies the app. |
|
|
267
267
|
|
|
268
268
|
### Return type
|
|
269
269
|
|
|
@@ -281,7 +281,7 @@ Name | Type | Description | Notes
|
|
|
281
281
|
|
|
282
282
|
|
|
283
283
|
# **get_app_jwt**
|
|
284
|
-
> JwtResponse get_app_jwt(
|
|
284
|
+
> JwtResponse get_app_jwt(appId, keyId)
|
|
285
285
|
|
|
286
286
|
|
|
287
287
|
|
|
@@ -300,13 +300,13 @@ end
|
|
|
300
300
|
|
|
301
301
|
api_instance = SmoochApi::AppApi.new
|
|
302
302
|
|
|
303
|
-
|
|
303
|
+
appId = "appId_example" # String | Identifies the app.
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
keyId = "keyId_example" # String | Identifies the secret key.
|
|
306
306
|
|
|
307
307
|
|
|
308
308
|
begin
|
|
309
|
-
result = api_instance.get_app_jwt(
|
|
309
|
+
result = api_instance.get_app_jwt(appId, keyId)
|
|
310
310
|
p result
|
|
311
311
|
rescue SmoochApi::ApiError => e
|
|
312
312
|
puts "Exception when calling AppApi->get_app_jwt: #{e}"
|
|
@@ -317,8 +317,8 @@ end
|
|
|
317
317
|
|
|
318
318
|
Name | Type | Description | Notes
|
|
319
319
|
------------- | ------------- | ------------- | -------------
|
|
320
|
-
**
|
|
321
|
-
**
|
|
320
|
+
**appId** | **String**| Identifies the app. |
|
|
321
|
+
**keyId** | **String**| Identifies the secret key. |
|
|
322
322
|
|
|
323
323
|
### Return type
|
|
324
324
|
|
|
@@ -336,7 +336,7 @@ Name | Type | Description | Notes
|
|
|
336
336
|
|
|
337
337
|
|
|
338
338
|
# **get_secret_key**
|
|
339
|
-
> SecretKeyResponse get_secret_key(
|
|
339
|
+
> SecretKeyResponse get_secret_key(appId, keyId)
|
|
340
340
|
|
|
341
341
|
|
|
342
342
|
|
|
@@ -355,13 +355,13 @@ end
|
|
|
355
355
|
|
|
356
356
|
api_instance = SmoochApi::AppApi.new
|
|
357
357
|
|
|
358
|
-
|
|
358
|
+
appId = "appId_example" # String | Identifies the app.
|
|
359
359
|
|
|
360
|
-
|
|
360
|
+
keyId = "keyId_example" # String | Identifies the secret key.
|
|
361
361
|
|
|
362
362
|
|
|
363
363
|
begin
|
|
364
|
-
result = api_instance.get_secret_key(
|
|
364
|
+
result = api_instance.get_secret_key(appId, keyId)
|
|
365
365
|
p result
|
|
366
366
|
rescue SmoochApi::ApiError => e
|
|
367
367
|
puts "Exception when calling AppApi->get_secret_key: #{e}"
|
|
@@ -372,8 +372,8 @@ end
|
|
|
372
372
|
|
|
373
373
|
Name | Type | Description | Notes
|
|
374
374
|
------------- | ------------- | ------------- | -------------
|
|
375
|
-
**
|
|
376
|
-
**
|
|
375
|
+
**appId** | **String**| Identifies the app. |
|
|
376
|
+
**keyId** | **String**| Identifies the secret key. |
|
|
377
377
|
|
|
378
378
|
### Return type
|
|
379
379
|
|
|
@@ -413,7 +413,7 @@ api_instance = SmoochApi::AppApi.new
|
|
|
413
413
|
opts = {
|
|
414
414
|
limit: 25, # Integer | The number of records to return.
|
|
415
415
|
offset: 0, # Integer | The number of initial records to skip before picking records to return.
|
|
416
|
-
|
|
416
|
+
serviceAccountId: "" # String | The service account ID for which to list apps.
|
|
417
417
|
}
|
|
418
418
|
|
|
419
419
|
begin
|
|
@@ -430,7 +430,7 @@ Name | Type | Description | Notes
|
|
|
430
430
|
------------- | ------------- | ------------- | -------------
|
|
431
431
|
**limit** | **Integer**| The number of records to return. | [optional] [default to 25]
|
|
432
432
|
**offset** | **Integer**| The number of initial records to skip before picking records to return. | [optional] [default to 0]
|
|
433
|
-
**
|
|
433
|
+
**serviceAccountId** | **String**| The service account ID for which to list apps. | [optional] [default to ]
|
|
434
434
|
|
|
435
435
|
### Return type
|
|
436
436
|
|
|
@@ -448,7 +448,7 @@ Name | Type | Description | Notes
|
|
|
448
448
|
|
|
449
449
|
|
|
450
450
|
# **list_secret_keys**
|
|
451
|
-
> ListSecretKeysResponse list_secret_keys(
|
|
451
|
+
> ListSecretKeysResponse list_secret_keys(appId, )
|
|
452
452
|
|
|
453
453
|
|
|
454
454
|
|
|
@@ -467,11 +467,11 @@ end
|
|
|
467
467
|
|
|
468
468
|
api_instance = SmoochApi::AppApi.new
|
|
469
469
|
|
|
470
|
-
|
|
470
|
+
appId = "appId_example" # String | Identifies the app.
|
|
471
471
|
|
|
472
472
|
|
|
473
473
|
begin
|
|
474
|
-
result = api_instance.list_secret_keys(
|
|
474
|
+
result = api_instance.list_secret_keys(appId, )
|
|
475
475
|
p result
|
|
476
476
|
rescue SmoochApi::ApiError => e
|
|
477
477
|
puts "Exception when calling AppApi->list_secret_keys: #{e}"
|
|
@@ -482,7 +482,7 @@ end
|
|
|
482
482
|
|
|
483
483
|
Name | Type | Description | Notes
|
|
484
484
|
------------- | ------------- | ------------- | -------------
|
|
485
|
-
**
|
|
485
|
+
**appId** | **String**| Identifies the app. |
|
|
486
486
|
|
|
487
487
|
### Return type
|
|
488
488
|
|
|
@@ -500,7 +500,7 @@ Name | Type | Description | Notes
|
|
|
500
500
|
|
|
501
501
|
|
|
502
502
|
# **update_app**
|
|
503
|
-
> AppResponse update_app(
|
|
503
|
+
> AppResponse update_app(appId, appUpdateBody)
|
|
504
504
|
|
|
505
505
|
|
|
506
506
|
|
|
@@ -519,13 +519,13 @@ end
|
|
|
519
519
|
|
|
520
520
|
api_instance = SmoochApi::AppApi.new
|
|
521
521
|
|
|
522
|
-
|
|
522
|
+
appId = "appId_example" # String | Identifies the app.
|
|
523
523
|
|
|
524
|
-
|
|
524
|
+
appUpdateBody = SmoochApi::AppUpdate.new # AppUpdate | Body for an updateApp request.
|
|
525
525
|
|
|
526
526
|
|
|
527
527
|
begin
|
|
528
|
-
result = api_instance.update_app(
|
|
528
|
+
result = api_instance.update_app(appId, appUpdateBody)
|
|
529
529
|
p result
|
|
530
530
|
rescue SmoochApi::ApiError => e
|
|
531
531
|
puts "Exception when calling AppApi->update_app: #{e}"
|
|
@@ -536,8 +536,8 @@ end
|
|
|
536
536
|
|
|
537
537
|
Name | Type | Description | Notes
|
|
538
538
|
------------- | ------------- | ------------- | -------------
|
|
539
|
-
**
|
|
540
|
-
**
|
|
539
|
+
**appId** | **String**| Identifies the app. |
|
|
540
|
+
**appUpdateBody** | [**AppUpdate**](AppUpdate.md)| Body for an updateApp request. |
|
|
541
541
|
|
|
542
542
|
### Return type
|
|
543
543
|
|
data/docs/AppSettings.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**
|
|
7
|
-
**
|
|
6
|
+
**maskCreditCardNumbers** | **BOOLEAN** | Flag specifying whether credit card numbers will be automatically masked if sent through Smooch. | [optional]
|
|
7
|
+
**useAnimalNames** | **BOOLEAN** | Flag specifying whether animal names should be used for anonymous users. | [optional]
|
|
8
8
|
|
|
9
9
|
|
data/docs/AppUser.md
CHANGED
|
@@ -3,15 +3,15 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**
|
|
7
|
-
**
|
|
8
|
-
**
|
|
6
|
+
**id** | **String** | The app user's ID, generated automatically. |
|
|
7
|
+
**userId** | **String** | The app user's userId. This ID is specified by the appMaker. | [optional]
|
|
8
|
+
**givenName** | **String** | The app user's given name. | [optional]
|
|
9
9
|
**surname** | **String** | The app user's surname. | [optional]
|
|
10
10
|
**email** | **String** | The app user's email. | [optional]
|
|
11
|
-
**
|
|
11
|
+
**signedUpAt** | **String** | A datetime string with the format *yyyy-mm-ddThh:mm:ssZ* representing the moment an appUser was created. | [optional]
|
|
12
12
|
**properties** | **Object** | Custom properties for the app user. |
|
|
13
|
-
**
|
|
13
|
+
**conversationStarted** | **BOOLEAN** | Flag indicating if the conversation has started for the app user. |
|
|
14
14
|
**clients** | [**Array<Client>**](Client.md) | List of clients associated with the app user. | [optional]
|
|
15
|
-
**
|
|
15
|
+
**pendingClients** | [**Array<Client>**](Client.md) | As clients, but containing linked clients which have not been confirmed yet (i.e. Twilio SMS). | [optional]
|
|
16
16
|
|
|
17
17
|
|
data/docs/AppUserApi.md
CHANGED
|
@@ -19,7 +19,7 @@ Method | HTTP request | Description
|
|
|
19
19
|
|
|
20
20
|
|
|
21
21
|
# **delete_app_user**
|
|
22
|
-
> delete_app_user(
|
|
22
|
+
> delete_app_user(appId, userId, )
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
|
|
@@ -38,13 +38,13 @@ end
|
|
|
38
38
|
|
|
39
39
|
api_instance = SmoochApi::AppUserApi.new
|
|
40
40
|
|
|
41
|
-
|
|
41
|
+
appId = "appId_example" # String | Identifies the app.
|
|
42
42
|
|
|
43
|
-
|
|
43
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
44
44
|
|
|
45
45
|
|
|
46
46
|
begin
|
|
47
|
-
api_instance.delete_app_user(
|
|
47
|
+
api_instance.delete_app_user(appId, userId, )
|
|
48
48
|
rescue SmoochApi::ApiError => e
|
|
49
49
|
puts "Exception when calling AppUserApi->delete_app_user: #{e}"
|
|
50
50
|
end
|
|
@@ -54,8 +54,8 @@ end
|
|
|
54
54
|
|
|
55
55
|
Name | Type | Description | Notes
|
|
56
56
|
------------- | ------------- | ------------- | -------------
|
|
57
|
-
**
|
|
58
|
-
**
|
|
57
|
+
**appId** | **String**| Identifies the app. |
|
|
58
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
|
59
59
|
|
|
60
60
|
### Return type
|
|
61
61
|
|
|
@@ -73,7 +73,7 @@ nil (empty response body)
|
|
|
73
73
|
|
|
74
74
|
|
|
75
75
|
# **delete_app_user_profile**
|
|
76
|
-
> AppUserResponse delete_app_user_profile(
|
|
76
|
+
> AppUserResponse delete_app_user_profile(appId, userId, )
|
|
77
77
|
|
|
78
78
|
|
|
79
79
|
|
|
@@ -92,13 +92,13 @@ end
|
|
|
92
92
|
|
|
93
93
|
api_instance = SmoochApi::AppUserApi.new
|
|
94
94
|
|
|
95
|
-
|
|
95
|
+
appId = "appId_example" # String | Identifies the app.
|
|
96
96
|
|
|
97
|
-
|
|
97
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
98
98
|
|
|
99
99
|
|
|
100
100
|
begin
|
|
101
|
-
result = api_instance.delete_app_user_profile(
|
|
101
|
+
result = api_instance.delete_app_user_profile(appId, userId, )
|
|
102
102
|
p result
|
|
103
103
|
rescue SmoochApi::ApiError => e
|
|
104
104
|
puts "Exception when calling AppUserApi->delete_app_user_profile: #{e}"
|
|
@@ -109,8 +109,8 @@ end
|
|
|
109
109
|
|
|
110
110
|
Name | Type | Description | Notes
|
|
111
111
|
------------- | ------------- | ------------- | -------------
|
|
112
|
-
**
|
|
113
|
-
**
|
|
112
|
+
**appId** | **String**| Identifies the app. |
|
|
113
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
|
114
114
|
|
|
115
115
|
### Return type
|
|
116
116
|
|
|
@@ -128,7 +128,7 @@ Name | Type | Description | Notes
|
|
|
128
128
|
|
|
129
129
|
|
|
130
130
|
# **get_app_user**
|
|
131
|
-
> AppUserResponse get_app_user(
|
|
131
|
+
> AppUserResponse get_app_user(appId, userId, )
|
|
132
132
|
|
|
133
133
|
|
|
134
134
|
|
|
@@ -147,13 +147,13 @@ end
|
|
|
147
147
|
|
|
148
148
|
api_instance = SmoochApi::AppUserApi.new
|
|
149
149
|
|
|
150
|
-
|
|
150
|
+
appId = "appId_example" # String | Identifies the app.
|
|
151
151
|
|
|
152
|
-
|
|
152
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
153
153
|
|
|
154
154
|
|
|
155
155
|
begin
|
|
156
|
-
result = api_instance.get_app_user(
|
|
156
|
+
result = api_instance.get_app_user(appId, userId, )
|
|
157
157
|
p result
|
|
158
158
|
rescue SmoochApi::ApiError => e
|
|
159
159
|
puts "Exception when calling AppUserApi->get_app_user: #{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
|
|
|
170
170
|
### Return type
|
|
171
171
|
|
|
@@ -183,7 +183,7 @@ Name | Type | Description | Notes
|
|
|
183
183
|
|
|
184
184
|
|
|
185
185
|
# **get_app_user_auth_code**
|
|
186
|
-
> AuthCodeResponse get_app_user_auth_code(
|
|
186
|
+
> AuthCodeResponse get_app_user_auth_code(appId, userId, )
|
|
187
187
|
|
|
188
188
|
|
|
189
189
|
|
|
@@ -202,13 +202,13 @@ end
|
|
|
202
202
|
|
|
203
203
|
api_instance = SmoochApi::AppUserApi.new
|
|
204
204
|
|
|
205
|
-
|
|
205
|
+
appId = "appId_example" # String | Identifies the app.
|
|
206
206
|
|
|
207
|
-
|
|
207
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
208
208
|
|
|
209
209
|
|
|
210
210
|
begin
|
|
211
|
-
result = api_instance.get_app_user_auth_code(
|
|
211
|
+
result = api_instance.get_app_user_auth_code(appId, userId, )
|
|
212
212
|
p result
|
|
213
213
|
rescue SmoochApi::ApiError => e
|
|
214
214
|
puts "Exception when calling AppUserApi->get_app_user_auth_code: #{e}"
|
|
@@ -219,8 +219,8 @@ end
|
|
|
219
219
|
|
|
220
220
|
Name | Type | Description | Notes
|
|
221
221
|
------------- | ------------- | ------------- | -------------
|
|
222
|
-
**
|
|
223
|
-
**
|
|
222
|
+
**appId** | **String**| Identifies the app. |
|
|
223
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
|
224
224
|
|
|
225
225
|
### Return type
|
|
226
226
|
|
|
@@ -238,7 +238,7 @@ Name | Type | Description | Notes
|
|
|
238
238
|
|
|
239
239
|
|
|
240
240
|
# **get_app_user_business_system_ids**
|
|
241
|
-
> AppUserBusinessSystemsResponse get_app_user_business_system_ids(
|
|
241
|
+
> AppUserBusinessSystemsResponse get_app_user_business_system_ids(appId, userId, )
|
|
242
242
|
|
|
243
243
|
|
|
244
244
|
|
|
@@ -257,13 +257,13 @@ end
|
|
|
257
257
|
|
|
258
258
|
api_instance = SmoochApi::AppUserApi.new
|
|
259
259
|
|
|
260
|
-
|
|
260
|
+
appId = "appId_example" # String | Identifies the app.
|
|
261
261
|
|
|
262
|
-
|
|
262
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
263
263
|
|
|
264
264
|
|
|
265
265
|
begin
|
|
266
|
-
result = api_instance.get_app_user_business_system_ids(
|
|
266
|
+
result = api_instance.get_app_user_business_system_ids(appId, userId, )
|
|
267
267
|
p result
|
|
268
268
|
rescue SmoochApi::ApiError => e
|
|
269
269
|
puts "Exception when calling AppUserApi->get_app_user_business_system_ids: #{e}"
|
|
@@ -274,8 +274,8 @@ end
|
|
|
274
274
|
|
|
275
275
|
Name | Type | Description | Notes
|
|
276
276
|
------------- | ------------- | ------------- | -------------
|
|
277
|
-
**
|
|
278
|
-
**
|
|
277
|
+
**appId** | **String**| Identifies the app. |
|
|
278
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
|
279
279
|
|
|
280
280
|
### Return type
|
|
281
281
|
|
|
@@ -293,7 +293,7 @@ Name | Type | Description | Notes
|
|
|
293
293
|
|
|
294
294
|
|
|
295
295
|
# **get_app_user_entity_ids**
|
|
296
|
-
> AppUserChannelsResponse get_app_user_entity_ids(
|
|
296
|
+
> AppUserChannelsResponse get_app_user_entity_ids(appId, userId, )
|
|
297
297
|
|
|
298
298
|
|
|
299
299
|
|
|
@@ -312,13 +312,13 @@ end
|
|
|
312
312
|
|
|
313
313
|
api_instance = SmoochApi::AppUserApi.new
|
|
314
314
|
|
|
315
|
-
|
|
315
|
+
appId = "appId_example" # String | Identifies the app.
|
|
316
316
|
|
|
317
|
-
|
|
317
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
318
318
|
|
|
319
319
|
|
|
320
320
|
begin
|
|
321
|
-
result = api_instance.get_app_user_entity_ids(
|
|
321
|
+
result = api_instance.get_app_user_entity_ids(appId, userId, )
|
|
322
322
|
p result
|
|
323
323
|
rescue SmoochApi::ApiError => e
|
|
324
324
|
puts "Exception when calling AppUserApi->get_app_user_entity_ids: #{e}"
|
|
@@ -329,8 +329,8 @@ end
|
|
|
329
329
|
|
|
330
330
|
Name | Type | Description | Notes
|
|
331
331
|
------------- | ------------- | ------------- | -------------
|
|
332
|
-
**
|
|
333
|
-
**
|
|
332
|
+
**appId** | **String**| Identifies the app. |
|
|
333
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
|
334
334
|
|
|
335
335
|
### Return type
|
|
336
336
|
|
|
@@ -348,7 +348,7 @@ Name | Type | Description | Notes
|
|
|
348
348
|
|
|
349
349
|
|
|
350
350
|
# **get_link_requests**
|
|
351
|
-
> LinkRequestResponse get_link_requests(
|
|
351
|
+
> LinkRequestResponse get_link_requests(appId, userId, integrationIds)
|
|
352
352
|
|
|
353
353
|
|
|
354
354
|
|
|
@@ -367,15 +367,15 @@ end
|
|
|
367
367
|
|
|
368
368
|
api_instance = SmoochApi::AppUserApi.new
|
|
369
369
|
|
|
370
|
-
|
|
370
|
+
appId = "appId_example" # String | Identifies the app.
|
|
371
371
|
|
|
372
|
-
|
|
372
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
373
373
|
|
|
374
|
-
|
|
374
|
+
integrationIds = ["integrationIds_example"] # Array<String> | List of integration IDs
|
|
375
375
|
|
|
376
376
|
|
|
377
377
|
begin
|
|
378
|
-
result = api_instance.get_link_requests(
|
|
378
|
+
result = api_instance.get_link_requests(appId, userId, integrationIds)
|
|
379
379
|
p result
|
|
380
380
|
rescue SmoochApi::ApiError => e
|
|
381
381
|
puts "Exception when calling AppUserApi->get_link_requests: #{e}"
|
|
@@ -386,9 +386,9 @@ end
|
|
|
386
386
|
|
|
387
387
|
Name | Type | Description | Notes
|
|
388
388
|
------------- | ------------- | ------------- | -------------
|
|
389
|
-
**
|
|
390
|
-
**
|
|
391
|
-
**
|
|
389
|
+
**appId** | **String**| Identifies the app. |
|
|
390
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
|
391
|
+
**integrationIds** | [**Array<String>**](String.md)| List of integration IDs |
|
|
392
392
|
|
|
393
393
|
### Return type
|
|
394
394
|
|
|
@@ -406,7 +406,7 @@ Name | Type | Description | Notes
|
|
|
406
406
|
|
|
407
407
|
|
|
408
408
|
# **link_app_user**
|
|
409
|
-
> AppUserResponse link_app_user(
|
|
409
|
+
> AppUserResponse link_app_user(appId, userId, appUserLinkBody)
|
|
410
410
|
|
|
411
411
|
|
|
412
412
|
|
|
@@ -425,15 +425,15 @@ end
|
|
|
425
425
|
|
|
426
426
|
api_instance = SmoochApi::AppUserApi.new
|
|
427
427
|
|
|
428
|
-
|
|
428
|
+
appId = "appId_example" # String | Identifies the app.
|
|
429
429
|
|
|
430
|
-
|
|
430
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
431
431
|
|
|
432
|
-
|
|
432
|
+
appUserLinkBody = SmoochApi::AppUserLink.new # AppUserLink | Body for a linkAppUser request.
|
|
433
433
|
|
|
434
434
|
|
|
435
435
|
begin
|
|
436
|
-
result = api_instance.link_app_user(
|
|
436
|
+
result = api_instance.link_app_user(appId, userId, appUserLinkBody)
|
|
437
437
|
p result
|
|
438
438
|
rescue SmoochApi::ApiError => e
|
|
439
439
|
puts "Exception when calling AppUserApi->link_app_user: #{e}"
|
|
@@ -444,9 +444,9 @@ end
|
|
|
444
444
|
|
|
445
445
|
Name | Type | Description | Notes
|
|
446
446
|
------------- | ------------- | ------------- | -------------
|
|
447
|
-
**
|
|
448
|
-
**
|
|
449
|
-
**
|
|
447
|
+
**appId** | **String**| Identifies the app. |
|
|
448
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
|
449
|
+
**appUserLinkBody** | [**AppUserLink**](AppUserLink.md)| Body for a linkAppUser request. |
|
|
450
450
|
|
|
451
451
|
### Return type
|
|
452
452
|
|
|
@@ -464,7 +464,7 @@ Name | Type | Description | Notes
|
|
|
464
464
|
|
|
465
465
|
|
|
466
466
|
# **post_image_message**
|
|
467
|
-
> MessageResponse post_image_message(
|
|
467
|
+
> MessageResponse post_image_message(appId, userId, source, role)
|
|
468
468
|
|
|
469
469
|
|
|
470
470
|
|
|
@@ -483,9 +483,9 @@ end
|
|
|
483
483
|
|
|
484
484
|
api_instance = SmoochApi::AppUserApi.new
|
|
485
485
|
|
|
486
|
-
|
|
486
|
+
appId = "appId_example" # String | Identifies the app.
|
|
487
487
|
|
|
488
|
-
|
|
488
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
489
489
|
|
|
490
490
|
source = File.new("/path/to/file.txt") # File | Image to be uploaded
|
|
491
491
|
|
|
@@ -493,7 +493,7 @@ role = "role_example" # String | Role of the sender
|
|
|
493
493
|
|
|
494
494
|
|
|
495
495
|
begin
|
|
496
|
-
result = api_instance.post_image_message(
|
|
496
|
+
result = api_instance.post_image_message(appId, userId, source, role)
|
|
497
497
|
p result
|
|
498
498
|
rescue SmoochApi::ApiError => e
|
|
499
499
|
puts "Exception when calling AppUserApi->post_image_message: #{e}"
|
|
@@ -504,8 +504,8 @@ end
|
|
|
504
504
|
|
|
505
505
|
Name | Type | Description | Notes
|
|
506
506
|
------------- | ------------- | ------------- | -------------
|
|
507
|
-
**
|
|
508
|
-
**
|
|
507
|
+
**appId** | **String**| Identifies the app. |
|
|
508
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
|
509
509
|
**source** | **File**| Image to be uploaded |
|
|
510
510
|
**role** | **String**| Role of the sender |
|
|
511
511
|
|
|
@@ -525,7 +525,7 @@ Name | Type | Description | Notes
|
|
|
525
525
|
|
|
526
526
|
|
|
527
527
|
# **pre_create_app_user**
|
|
528
|
-
> AppUserResponse pre_create_app_user(
|
|
528
|
+
> AppUserResponse pre_create_app_user(appId, appUserPreCreateBody)
|
|
529
529
|
|
|
530
530
|
|
|
531
531
|
|
|
@@ -544,13 +544,13 @@ end
|
|
|
544
544
|
|
|
545
545
|
api_instance = SmoochApi::AppUserApi.new
|
|
546
546
|
|
|
547
|
-
|
|
547
|
+
appId = "appId_example" # String | Identifies the app.
|
|
548
548
|
|
|
549
|
-
|
|
549
|
+
appUserPreCreateBody = SmoochApi::AppUserPreCreate.new # AppUserPreCreate | Body for a preCreateAppUser request.
|
|
550
550
|
|
|
551
551
|
|
|
552
552
|
begin
|
|
553
|
-
result = api_instance.pre_create_app_user(
|
|
553
|
+
result = api_instance.pre_create_app_user(appId, appUserPreCreateBody)
|
|
554
554
|
p result
|
|
555
555
|
rescue SmoochApi::ApiError => e
|
|
556
556
|
puts "Exception when calling AppUserApi->pre_create_app_user: #{e}"
|
|
@@ -561,8 +561,8 @@ end
|
|
|
561
561
|
|
|
562
562
|
Name | Type | Description | Notes
|
|
563
563
|
------------- | ------------- | ------------- | -------------
|
|
564
|
-
**
|
|
565
|
-
**
|
|
564
|
+
**appId** | **String**| Identifies the app. |
|
|
565
|
+
**appUserPreCreateBody** | [**AppUserPreCreate**](AppUserPreCreate.md)| Body for a preCreateAppUser request. |
|
|
566
566
|
|
|
567
567
|
### Return type
|
|
568
568
|
|
|
@@ -580,7 +580,7 @@ Name | Type | Description | Notes
|
|
|
580
580
|
|
|
581
581
|
|
|
582
582
|
# **unlink_app_user**
|
|
583
|
-
> unlink_app_user(
|
|
583
|
+
> unlink_app_user(appId, userId, channel)
|
|
584
584
|
|
|
585
585
|
|
|
586
586
|
|
|
@@ -599,15 +599,15 @@ end
|
|
|
599
599
|
|
|
600
600
|
api_instance = SmoochApi::AppUserApi.new
|
|
601
601
|
|
|
602
|
-
|
|
602
|
+
appId = "appId_example" # String | Identifies the app.
|
|
603
603
|
|
|
604
|
-
|
|
604
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
605
605
|
|
|
606
606
|
channel = "channel_example" # String | Name of the channel.
|
|
607
607
|
|
|
608
608
|
|
|
609
609
|
begin
|
|
610
|
-
api_instance.unlink_app_user(
|
|
610
|
+
api_instance.unlink_app_user(appId, userId, channel)
|
|
611
611
|
rescue SmoochApi::ApiError => e
|
|
612
612
|
puts "Exception when calling AppUserApi->unlink_app_user: #{e}"
|
|
613
613
|
end
|
|
@@ -617,8 +617,8 @@ end
|
|
|
617
617
|
|
|
618
618
|
Name | Type | Description | Notes
|
|
619
619
|
------------- | ------------- | ------------- | -------------
|
|
620
|
-
**
|
|
621
|
-
**
|
|
620
|
+
**appId** | **String**| Identifies the app. |
|
|
621
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
|
622
622
|
**channel** | **String**| Name of the channel. |
|
|
623
623
|
|
|
624
624
|
### Return type
|
|
@@ -637,7 +637,7 @@ nil (empty response body)
|
|
|
637
637
|
|
|
638
638
|
|
|
639
639
|
# **update_app_user**
|
|
640
|
-
> AppUserResponse update_app_user(
|
|
640
|
+
> AppUserResponse update_app_user(appId, userId, appUserUpdateBody)
|
|
641
641
|
|
|
642
642
|
|
|
643
643
|
|
|
@@ -656,15 +656,15 @@ end
|
|
|
656
656
|
|
|
657
657
|
api_instance = SmoochApi::AppUserApi.new
|
|
658
658
|
|
|
659
|
-
|
|
659
|
+
appId = "appId_example" # String | Identifies the app.
|
|
660
660
|
|
|
661
|
-
|
|
661
|
+
userId = "userId_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
|
662
662
|
|
|
663
|
-
|
|
663
|
+
appUserUpdateBody = SmoochApi::AppUserUpdate.new # AppUserUpdate | Body for an updateAppUser request.
|
|
664
664
|
|
|
665
665
|
|
|
666
666
|
begin
|
|
667
|
-
result = api_instance.update_app_user(
|
|
667
|
+
result = api_instance.update_app_user(appId, userId, appUserUpdateBody)
|
|
668
668
|
p result
|
|
669
669
|
rescue SmoochApi::ApiError => e
|
|
670
670
|
puts "Exception when calling AppUserApi->update_app_user: #{e}"
|
|
@@ -675,9 +675,9 @@ end
|
|
|
675
675
|
|
|
676
676
|
Name | Type | Description | Notes
|
|
677
677
|
------------- | ------------- | ------------- | -------------
|
|
678
|
-
**
|
|
679
|
-
**
|
|
680
|
-
**
|
|
678
|
+
**appId** | **String**| Identifies the app. |
|
|
679
|
+
**userId** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
|
680
|
+
**appUserUpdateBody** | [**AppUserUpdate**](AppUserUpdate.md)| Body for an updateAppUser request. |
|
|
681
681
|
|
|
682
682
|
### Return type
|
|
683
683
|
|