smooch-api 1.12.0 → 2.0.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 +18 -25
- data/docs/AppUserApi.md +54 -83
- data/docs/ConversationApi.md +30 -15
- data/docs/MenuApi.md +26 -11
- data/lib/smooch-api.rb +1 -7
- data/lib/smooch-api/api/app_api.rb +1 -1
- data/lib/smooch-api/api/app_user_api.rb +91 -98
- data/lib/smooch-api/api/attachments_api.rb +1 -1
- data/lib/smooch-api/api/conversation_api.rb +51 -21
- data/lib/smooch-api/api/integration_api.rb +1 -1
- data/lib/smooch-api/api/menu_api.rb +31 -13
- data/lib/smooch-api/api/webhook_api.rb +1 -1
- 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 +1 -34
- data/lib/smooch-api/models/app.rb +1 -1
- 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 +1 -1
- data/lib/smooch-api/models/app_update.rb +1 -1
- data/lib/smooch-api/models/app_user.rb +1 -1
- data/lib/smooch-api/models/app_user_link.rb +1 -34
- data/lib/smooch-api/models/app_user_pre_create.rb +1 -1
- data/lib/smooch-api/models/app_user_response.rb +1 -1
- data/lib/smooch-api/models/app_user_update.rb +1 -1
- data/lib/smooch-api/models/attachment_response.rb +1 -1
- data/lib/smooch-api/models/client.rb +1 -34
- data/lib/smooch-api/models/client_info.rb +1 -1
- data/lib/smooch-api/models/confirmation.rb +1 -1
- data/lib/smooch-api/models/conversation.rb +1 -1
- data/lib/smooch-api/models/destination.rb +1 -1
- data/lib/smooch-api/models/device_response.rb +1 -1
- data/lib/smooch-api/models/device_update.rb +1 -1
- data/lib/smooch-api/models/display_settings.rb +1 -1
- data/lib/smooch-api/models/get_messages_response.rb +1 -1
- data/lib/smooch-api/models/integration.rb +1 -1
- data/lib/smooch-api/models/integration_create.rb +1 -1
- data/lib/smooch-api/models/integration_response.rb +1 -1
- data/lib/smooch-api/models/jwt_response.rb +1 -1
- data/lib/smooch-api/models/list_apps_response.rb +1 -1
- 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_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 +1 -34
- data/lib/smooch-api/models/message_item.rb +1 -1
- data/lib/smooch-api/models/message_post.rb +1 -34
- data/lib/smooch-api/models/message_response.rb +1 -1
- data/lib/smooch-api/models/secret_key.rb +1 -1
- 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/source.rb +1 -1
- data/lib/smooch-api/models/typing_activity_trigger.rb +1 -1
- data/lib/smooch-api/models/webhook.rb +1 -22
- data/lib/smooch-api/models/webhook_create.rb +1 -22
- data/lib/smooch-api/models/webhook_response.rb +1 -1
- data/lib/smooch-api/models/webhook_update.rb +1 -22
- 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 +3 -15
- data/docs/DeviceInit.md +0 -12
- data/docs/Event.md +0 -8
- data/docs/Init.md +0 -9
- data/docs/InitApi.md +0 -61
- data/docs/InitResponse.md +0 -9
- data/docs/TrackEventResponse.md +0 -8
- data/lib/smooch-api/api/init_api.rb +0 -78
- data/lib/smooch-api/models/device_init.rb +0 -271
- data/lib/smooch-api/models/event.rb +0 -194
- data/lib/smooch-api/models/init.rb +0 -203
- data/lib/smooch-api/models/init_response.rb +0 -209
- data/lib/smooch-api/models/track_event_response.rb +0 -189
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d6a4b7e38e45c4929787b1a2421d975f0d31dab9
|
4
|
+
data.tar.gz: 1df6e705354351d6fee90346fd76ef07e0e07b99
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 724f7fb072f29449493b0c9ea9217040a46056211c29f5cafe980a4537ede727501ee0599db530a1b7b600f080d8a08bc1def130097af6e6dda6147e4e143618
|
7
|
+
data.tar.gz: 66a42012d2e8af94b22b7dacd2969fe09eb16655e8a86f554eeffc692edc37766c403ad1f93a7c85b0a7b0a2477187fa33cf33bb8f15c744924077eeea3754ca
|
data/README.md
CHANGED
@@ -16,7 +16,7 @@ gem install smooch-api
|
|
16
16
|
|
17
17
|
Add this to the Gemfile:
|
18
18
|
|
19
|
-
gem 'smooch-api', '~>
|
19
|
+
gem 'smooch-api', '~> 2.0.0'
|
20
20
|
|
21
21
|
## Getting Started
|
22
22
|
|
@@ -88,23 +88,21 @@ Class | Method | HTTP request | Description
|
|
88
88
|
*SmoochApi::AppApi* | [**list_apps**](docs/AppApi.md#list_apps) | **GET** /apps |
|
89
89
|
*SmoochApi::AppApi* | [**list_secret_keys**](docs/AppApi.md#list_secret_keys) | **GET** /apps/{appId}/keys |
|
90
90
|
*SmoochApi::AppApi* | [**update_app**](docs/AppApi.md#update_app) | **PUT** /apps/{appId} |
|
91
|
-
*SmoochApi::AppUserApi* | [**app_user_device_update**](docs/AppUserApi.md#app_user_device_update) | **PUT** /appusers/{userId}/devices/{deviceId} |
|
92
|
-
*SmoochApi::AppUserApi* | [**delete_app_user_profile**](docs/AppUserApi.md#delete_app_user_profile) | **DELETE** /appusers/{userId}/profile |
|
93
|
-
*SmoochApi::AppUserApi* | [**get_app_user**](docs/AppUserApi.md#get_app_user) | **GET** /appusers/{userId} |
|
94
|
-
*SmoochApi::AppUserApi* | [**get_app_user_entity_ids**](docs/AppUserApi.md#get_app_user_entity_ids) | **GET** /appusers/{userId}/channels |
|
95
|
-
*SmoochApi::AppUserApi* | [**link_app_user**](docs/AppUserApi.md#link_app_user) | **POST** /appusers/{userId}/channels |
|
96
|
-
*SmoochApi::AppUserApi* | [**post_image_message**](docs/AppUserApi.md#post_image_message) | **POST** /appusers/{userId}/images |
|
97
|
-
*SmoochApi::AppUserApi* | [**pre_create_app_user**](docs/AppUserApi.md#pre_create_app_user) | **POST** /appusers |
|
98
|
-
*SmoochApi::AppUserApi* | [**
|
99
|
-
*SmoochApi::AppUserApi* | [**
|
100
|
-
*SmoochApi::AppUserApi* | [**update_app_user**](docs/AppUserApi.md#update_app_user) | **PUT** /appusers/{userId} |
|
91
|
+
*SmoochApi::AppUserApi* | [**app_user_device_update**](docs/AppUserApi.md#app_user_device_update) | **PUT** /apps/{appId}/appusers/{userId}/devices/{deviceId} |
|
92
|
+
*SmoochApi::AppUserApi* | [**delete_app_user_profile**](docs/AppUserApi.md#delete_app_user_profile) | **DELETE** /apps/{appId}/appusers/{userId}/profile |
|
93
|
+
*SmoochApi::AppUserApi* | [**get_app_user**](docs/AppUserApi.md#get_app_user) | **GET** /apps/{appId}/appusers/{userId} |
|
94
|
+
*SmoochApi::AppUserApi* | [**get_app_user_entity_ids**](docs/AppUserApi.md#get_app_user_entity_ids) | **GET** /apps/{appId}/appusers/{userId}/channels |
|
95
|
+
*SmoochApi::AppUserApi* | [**link_app_user**](docs/AppUserApi.md#link_app_user) | **POST** /apps/{appId}/appusers/{userId}/channels |
|
96
|
+
*SmoochApi::AppUserApi* | [**post_image_message**](docs/AppUserApi.md#post_image_message) | **POST** /apps/{appId}/appusers/{userId}/images |
|
97
|
+
*SmoochApi::AppUserApi* | [**pre_create_app_user**](docs/AppUserApi.md#pre_create_app_user) | **POST** /apps/{appId}/appusers |
|
98
|
+
*SmoochApi::AppUserApi* | [**unlink_app_user**](docs/AppUserApi.md#unlink_app_user) | **DELETE** /apps/{appId}/appusers/{userId}/channels/{channel} |
|
99
|
+
*SmoochApi::AppUserApi* | [**update_app_user**](docs/AppUserApi.md#update_app_user) | **PUT** /apps/{appId}/appusers/{userId} |
|
101
100
|
*SmoochApi::AttachmentsApi* | [**upload_attachment**](docs/AttachmentsApi.md#upload_attachment) | **POST** /apps/{appId}/attachments |
|
102
|
-
*SmoochApi::ConversationApi* | [**delete_messages**](docs/ConversationApi.md#delete_messages) | **DELETE** /appusers/{userId}/messages |
|
103
|
-
*SmoochApi::ConversationApi* | [**get_messages**](docs/ConversationApi.md#get_messages) | **GET** /appusers/{userId}/messages |
|
104
|
-
*SmoochApi::ConversationApi* | [**post_message**](docs/ConversationApi.md#post_message) | **POST** /appusers/{userId}/messages |
|
105
|
-
*SmoochApi::ConversationApi* | [**reset_unread_count**](docs/ConversationApi.md#reset_unread_count) | **POST** /appusers/{userId}/conversation/read |
|
106
|
-
*SmoochApi::ConversationApi* | [**trigger_typing_activity**](docs/ConversationApi.md#trigger_typing_activity) | **POST** /appusers/{userId}/conversation/activity |
|
107
|
-
*SmoochApi::InitApi* | [**init**](docs/InitApi.md#init) | **POST** /init |
|
101
|
+
*SmoochApi::ConversationApi* | [**delete_messages**](docs/ConversationApi.md#delete_messages) | **DELETE** /apps/{appId}/appusers/{userId}/messages |
|
102
|
+
*SmoochApi::ConversationApi* | [**get_messages**](docs/ConversationApi.md#get_messages) | **GET** /apps/{appId}/appusers/{userId}/messages |
|
103
|
+
*SmoochApi::ConversationApi* | [**post_message**](docs/ConversationApi.md#post_message) | **POST** /apps/{appId}/appusers/{userId}/messages |
|
104
|
+
*SmoochApi::ConversationApi* | [**reset_unread_count**](docs/ConversationApi.md#reset_unread_count) | **POST** /apps/{appId}/appusers/{userId}/conversation/read |
|
105
|
+
*SmoochApi::ConversationApi* | [**trigger_typing_activity**](docs/ConversationApi.md#trigger_typing_activity) | **POST** /apps/{appId}/appusers/{userId}/conversation/activity |
|
108
106
|
*SmoochApi::IntegrationApi* | [**create_integration**](docs/IntegrationApi.md#create_integration) | **POST** /apps/{appId}/integrations |
|
109
107
|
*SmoochApi::IntegrationApi* | [**create_integration_menu**](docs/IntegrationApi.md#create_integration_menu) | **POST** /apps/{appId}/integrations/{integrationId}/menu |
|
110
108
|
*SmoochApi::IntegrationApi* | [**delete_integration**](docs/IntegrationApi.md#delete_integration) | **DELETE** /apps/{appId}/integrations/{integrationId} |
|
@@ -113,9 +111,9 @@ Class | Method | HTTP request | Description
|
|
113
111
|
*SmoochApi::IntegrationApi* | [**get_integration_menu**](docs/IntegrationApi.md#get_integration_menu) | **GET** /apps/{appId}/integrations/{integrationId}/menu |
|
114
112
|
*SmoochApi::IntegrationApi* | [**list_integrations**](docs/IntegrationApi.md#list_integrations) | **GET** /apps/{appId}/integrations |
|
115
113
|
*SmoochApi::IntegrationApi* | [**update_integration_menu**](docs/IntegrationApi.md#update_integration_menu) | **PUT** /apps/{appId}/integrations/{integrationId}/menu |
|
116
|
-
*SmoochApi::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /menu |
|
117
|
-
*SmoochApi::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /menu |
|
118
|
-
*SmoochApi::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /menu |
|
114
|
+
*SmoochApi::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /apps/{appId}/menu |
|
115
|
+
*SmoochApi::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /apps/{appId}/menu |
|
116
|
+
*SmoochApi::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /apps/{appId}/menu |
|
119
117
|
*SmoochApi::WebhookApi* | [**create_webhook**](docs/WebhookApi.md#create_webhook) | **POST** /apps/{appId}/webhooks |
|
120
118
|
*SmoochApi::WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /apps/{appId}/webhooks/{webhookId} |
|
121
119
|
*SmoochApi::WebhookApi* | [**get_webhook**](docs/WebhookApi.md#get_webhook) | **GET** /apps/{appId}/webhooks/{webhookId} |
|
@@ -142,14 +140,10 @@ Class | Method | HTTP request | Description
|
|
142
140
|
- [SmoochApi::Confirmation](docs/Confirmation.md)
|
143
141
|
- [SmoochApi::Conversation](docs/Conversation.md)
|
144
142
|
- [SmoochApi::Destination](docs/Destination.md)
|
145
|
-
- [SmoochApi::DeviceInit](docs/DeviceInit.md)
|
146
143
|
- [SmoochApi::DeviceResponse](docs/DeviceResponse.md)
|
147
144
|
- [SmoochApi::DeviceUpdate](docs/DeviceUpdate.md)
|
148
145
|
- [SmoochApi::DisplaySettings](docs/DisplaySettings.md)
|
149
|
-
- [SmoochApi::Event](docs/Event.md)
|
150
146
|
- [SmoochApi::GetMessagesResponse](docs/GetMessagesResponse.md)
|
151
|
-
- [SmoochApi::Init](docs/Init.md)
|
152
|
-
- [SmoochApi::InitResponse](docs/InitResponse.md)
|
153
147
|
- [SmoochApi::Integration](docs/Integration.md)
|
154
148
|
- [SmoochApi::IntegrationCreate](docs/IntegrationCreate.md)
|
155
149
|
- [SmoochApi::IntegrationResponse](docs/IntegrationResponse.md)
|
@@ -169,7 +163,6 @@ Class | Method | HTTP request | Description
|
|
169
163
|
- [SmoochApi::SecretKeyCreate](docs/SecretKeyCreate.md)
|
170
164
|
- [SmoochApi::SecretKeyResponse](docs/SecretKeyResponse.md)
|
171
165
|
- [SmoochApi::Source](docs/Source.md)
|
172
|
-
- [SmoochApi::TrackEventResponse](docs/TrackEventResponse.md)
|
173
166
|
- [SmoochApi::TypingActivityTrigger](docs/TypingActivityTrigger.md)
|
174
167
|
- [SmoochApi::Webhook](docs/Webhook.md)
|
175
168
|
- [SmoochApi::WebhookCreate](docs/WebhookCreate.md)
|
data/docs/AppUserApi.md
CHANGED
@@ -4,20 +4,19 @@ All URIs are relative to *https://api.smooch.io/v1*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**app_user_device_update**](AppUserApi.md#app_user_device_update) | **PUT** /appusers/{userId}/devices/{deviceId} |
|
8
|
-
[**delete_app_user_profile**](AppUserApi.md#delete_app_user_profile) | **DELETE** /appusers/{userId}/profile |
|
9
|
-
[**get_app_user**](AppUserApi.md#get_app_user) | **GET** /appusers/{userId} |
|
10
|
-
[**get_app_user_entity_ids**](AppUserApi.md#get_app_user_entity_ids) | **GET** /appusers/{userId}/channels |
|
11
|
-
[**link_app_user**](AppUserApi.md#link_app_user) | **POST** /appusers/{userId}/channels |
|
12
|
-
[**post_image_message**](AppUserApi.md#post_image_message) | **POST** /appusers/{userId}/images |
|
13
|
-
[**pre_create_app_user**](AppUserApi.md#pre_create_app_user) | **POST** /appusers |
|
14
|
-
[**
|
15
|
-
[**
|
16
|
-
[**update_app_user**](AppUserApi.md#update_app_user) | **PUT** /appusers/{userId} |
|
7
|
+
[**app_user_device_update**](AppUserApi.md#app_user_device_update) | **PUT** /apps/{appId}/appusers/{userId}/devices/{deviceId} |
|
8
|
+
[**delete_app_user_profile**](AppUserApi.md#delete_app_user_profile) | **DELETE** /apps/{appId}/appusers/{userId}/profile |
|
9
|
+
[**get_app_user**](AppUserApi.md#get_app_user) | **GET** /apps/{appId}/appusers/{userId} |
|
10
|
+
[**get_app_user_entity_ids**](AppUserApi.md#get_app_user_entity_ids) | **GET** /apps/{appId}/appusers/{userId}/channels |
|
11
|
+
[**link_app_user**](AppUserApi.md#link_app_user) | **POST** /apps/{appId}/appusers/{userId}/channels |
|
12
|
+
[**post_image_message**](AppUserApi.md#post_image_message) | **POST** /apps/{appId}/appusers/{userId}/images |
|
13
|
+
[**pre_create_app_user**](AppUserApi.md#pre_create_app_user) | **POST** /apps/{appId}/appusers |
|
14
|
+
[**unlink_app_user**](AppUserApi.md#unlink_app_user) | **DELETE** /apps/{appId}/appusers/{userId}/channels/{channel} |
|
15
|
+
[**update_app_user**](AppUserApi.md#update_app_user) | **PUT** /apps/{appId}/appusers/{userId} |
|
17
16
|
|
18
17
|
|
19
18
|
# **app_user_device_update**
|
20
|
-
> DeviceResponse app_user_device_update(user_id, device_id, app_user_device_update_body)
|
19
|
+
> DeviceResponse app_user_device_update(app_id, user_id, device_id, app_user_device_update_body)
|
21
20
|
|
22
21
|
|
23
22
|
|
@@ -36,6 +35,8 @@ end
|
|
36
35
|
|
37
36
|
api_instance = SmoochApi::AppUserApi.new
|
38
37
|
|
38
|
+
app_id = "app_id_example" # String | Identifies the app.
|
39
|
+
|
39
40
|
user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
40
41
|
|
41
42
|
device_id = "device_id_example" # String | Identifies the device.
|
@@ -44,7 +45,7 @@ app_user_device_update_body = SmoochApi::DeviceUpdate.new # DeviceUpdate | Body
|
|
44
45
|
|
45
46
|
|
46
47
|
begin
|
47
|
-
result = api_instance.app_user_device_update(user_id, device_id, app_user_device_update_body)
|
48
|
+
result = api_instance.app_user_device_update(app_id, user_id, device_id, app_user_device_update_body)
|
48
49
|
p result
|
49
50
|
rescue SmoochApi::ApiError => e
|
50
51
|
puts "Exception when calling AppUserApi->app_user_device_update: #{e}"
|
@@ -55,6 +56,7 @@ end
|
|
55
56
|
|
56
57
|
Name | Type | Description | Notes
|
57
58
|
------------- | ------------- | ------------- | -------------
|
59
|
+
**app_id** | **String**| Identifies the app. |
|
58
60
|
**user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
59
61
|
**device_id** | **String**| Identifies the device. |
|
60
62
|
**app_user_device_update_body** | [**DeviceUpdate**](DeviceUpdate.md)| Body for an updateAppUserDevice request. |
|
@@ -75,7 +77,7 @@ Name | Type | Description | Notes
|
|
75
77
|
|
76
78
|
|
77
79
|
# **delete_app_user_profile**
|
78
|
-
> AppUserResponse delete_app_user_profile(user_id, )
|
80
|
+
> AppUserResponse delete_app_user_profile(app_id, user_id, )
|
79
81
|
|
80
82
|
|
81
83
|
|
@@ -94,11 +96,13 @@ end
|
|
94
96
|
|
95
97
|
api_instance = SmoochApi::AppUserApi.new
|
96
98
|
|
99
|
+
app_id = "app_id_example" # String | Identifies the app.
|
100
|
+
|
97
101
|
user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
98
102
|
|
99
103
|
|
100
104
|
begin
|
101
|
-
result = api_instance.delete_app_user_profile(user_id, )
|
105
|
+
result = api_instance.delete_app_user_profile(app_id, user_id, )
|
102
106
|
p result
|
103
107
|
rescue SmoochApi::ApiError => e
|
104
108
|
puts "Exception when calling AppUserApi->delete_app_user_profile: #{e}"
|
@@ -109,6 +113,7 @@ end
|
|
109
113
|
|
110
114
|
Name | Type | Description | Notes
|
111
115
|
------------- | ------------- | ------------- | -------------
|
116
|
+
**app_id** | **String**| Identifies the app. |
|
112
117
|
**user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
113
118
|
|
114
119
|
### Return type
|
@@ -127,7 +132,7 @@ Name | Type | Description | Notes
|
|
127
132
|
|
128
133
|
|
129
134
|
# **get_app_user**
|
130
|
-
> AppUserResponse get_app_user(user_id, )
|
135
|
+
> AppUserResponse get_app_user(app_id, user_id, )
|
131
136
|
|
132
137
|
|
133
138
|
|
@@ -146,11 +151,13 @@ end
|
|
146
151
|
|
147
152
|
api_instance = SmoochApi::AppUserApi.new
|
148
153
|
|
154
|
+
app_id = "app_id_example" # String | Identifies the app.
|
155
|
+
|
149
156
|
user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
150
157
|
|
151
158
|
|
152
159
|
begin
|
153
|
-
result = api_instance.get_app_user(user_id, )
|
160
|
+
result = api_instance.get_app_user(app_id, user_id, )
|
154
161
|
p result
|
155
162
|
rescue SmoochApi::ApiError => e
|
156
163
|
puts "Exception when calling AppUserApi->get_app_user: #{e}"
|
@@ -161,6 +168,7 @@ end
|
|
161
168
|
|
162
169
|
Name | Type | Description | Notes
|
163
170
|
------------- | ------------- | ------------- | -------------
|
171
|
+
**app_id** | **String**| Identifies the app. |
|
164
172
|
**user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
165
173
|
|
166
174
|
### Return type
|
@@ -179,7 +187,7 @@ Name | Type | Description | Notes
|
|
179
187
|
|
180
188
|
|
181
189
|
# **get_app_user_entity_ids**
|
182
|
-
> AppUserResponse get_app_user_entity_ids(user_id, )
|
190
|
+
> AppUserResponse get_app_user_entity_ids(app_id, user_id, )
|
183
191
|
|
184
192
|
|
185
193
|
|
@@ -198,11 +206,13 @@ end
|
|
198
206
|
|
199
207
|
api_instance = SmoochApi::AppUserApi.new
|
200
208
|
|
209
|
+
app_id = "app_id_example" # String | Identifies the app.
|
210
|
+
|
201
211
|
user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
202
212
|
|
203
213
|
|
204
214
|
begin
|
205
|
-
result = api_instance.get_app_user_entity_ids(user_id, )
|
215
|
+
result = api_instance.get_app_user_entity_ids(app_id, user_id, )
|
206
216
|
p result
|
207
217
|
rescue SmoochApi::ApiError => e
|
208
218
|
puts "Exception when calling AppUserApi->get_app_user_entity_ids: #{e}"
|
@@ -213,6 +223,7 @@ end
|
|
213
223
|
|
214
224
|
Name | Type | Description | Notes
|
215
225
|
------------- | ------------- | ------------- | -------------
|
226
|
+
**app_id** | **String**| Identifies the app. |
|
216
227
|
**user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
217
228
|
|
218
229
|
### Return type
|
@@ -231,7 +242,7 @@ Name | Type | Description | Notes
|
|
231
242
|
|
232
243
|
|
233
244
|
# **link_app_user**
|
234
|
-
> AppUserResponse link_app_user(user_id, app_user_link_body)
|
245
|
+
> AppUserResponse link_app_user(app_id, user_id, app_user_link_body)
|
235
246
|
|
236
247
|
|
237
248
|
|
@@ -250,13 +261,15 @@ end
|
|
250
261
|
|
251
262
|
api_instance = SmoochApi::AppUserApi.new
|
252
263
|
|
264
|
+
app_id = "app_id_example" # String | Identifies the app.
|
265
|
+
|
253
266
|
user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
254
267
|
|
255
268
|
app_user_link_body = SmoochApi::AppUserLink.new # AppUserLink | Body for a linkAppUser request.
|
256
269
|
|
257
270
|
|
258
271
|
begin
|
259
|
-
result = api_instance.link_app_user(user_id, app_user_link_body)
|
272
|
+
result = api_instance.link_app_user(app_id, user_id, app_user_link_body)
|
260
273
|
p result
|
261
274
|
rescue SmoochApi::ApiError => e
|
262
275
|
puts "Exception when calling AppUserApi->link_app_user: #{e}"
|
@@ -267,6 +280,7 @@ end
|
|
267
280
|
|
268
281
|
Name | Type | Description | Notes
|
269
282
|
------------- | ------------- | ------------- | -------------
|
283
|
+
**app_id** | **String**| Identifies the app. |
|
270
284
|
**user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
271
285
|
**app_user_link_body** | [**AppUserLink**](AppUserLink.md)| Body for a linkAppUser request. |
|
272
286
|
|
@@ -286,7 +300,7 @@ Name | Type | Description | Notes
|
|
286
300
|
|
287
301
|
|
288
302
|
# **post_image_message**
|
289
|
-
> MessageResponse post_image_message(user_id, source, role)
|
303
|
+
> MessageResponse post_image_message(app_id, user_id, source, role)
|
290
304
|
|
291
305
|
|
292
306
|
|
@@ -305,6 +319,8 @@ end
|
|
305
319
|
|
306
320
|
api_instance = SmoochApi::AppUserApi.new
|
307
321
|
|
322
|
+
app_id = "app_id_example" # String | Identifies the app.
|
323
|
+
|
308
324
|
user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
309
325
|
|
310
326
|
source = File.new("/path/to/file.txt") # File | Image to be uploaded
|
@@ -313,7 +329,7 @@ role = "role_example" # String | Role of the sender
|
|
313
329
|
|
314
330
|
|
315
331
|
begin
|
316
|
-
result = api_instance.post_image_message(user_id, source, role)
|
332
|
+
result = api_instance.post_image_message(app_id, user_id, source, role)
|
317
333
|
p result
|
318
334
|
rescue SmoochApi::ApiError => e
|
319
335
|
puts "Exception when calling AppUserApi->post_image_message: #{e}"
|
@@ -324,6 +340,7 @@ end
|
|
324
340
|
|
325
341
|
Name | Type | Description | Notes
|
326
342
|
------------- | ------------- | ------------- | -------------
|
343
|
+
**app_id** | **String**| Identifies the app. |
|
327
344
|
**user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
328
345
|
**source** | **File**| Image to be uploaded |
|
329
346
|
**role** | **String**| Role of the sender |
|
@@ -344,7 +361,7 @@ Name | Type | Description | Notes
|
|
344
361
|
|
345
362
|
|
346
363
|
# **pre_create_app_user**
|
347
|
-
> AppUserResponse pre_create_app_user(app_user_pre_create_body)
|
364
|
+
> AppUserResponse pre_create_app_user(app_id, app_user_pre_create_body)
|
348
365
|
|
349
366
|
|
350
367
|
|
@@ -363,11 +380,13 @@ end
|
|
363
380
|
|
364
381
|
api_instance = SmoochApi::AppUserApi.new
|
365
382
|
|
383
|
+
app_id = "app_id_example" # String | Identifies the app.
|
384
|
+
|
366
385
|
app_user_pre_create_body = SmoochApi::AppUserPreCreate.new # AppUserPreCreate | Body for a preCreateAppUser request.
|
367
386
|
|
368
387
|
|
369
388
|
begin
|
370
|
-
result = api_instance.pre_create_app_user(app_user_pre_create_body)
|
389
|
+
result = api_instance.pre_create_app_user(app_id, app_user_pre_create_body)
|
371
390
|
p result
|
372
391
|
rescue SmoochApi::ApiError => e
|
373
392
|
puts "Exception when calling AppUserApi->pre_create_app_user: #{e}"
|
@@ -378,6 +397,7 @@ end
|
|
378
397
|
|
379
398
|
Name | Type | Description | Notes
|
380
399
|
------------- | ------------- | ------------- | -------------
|
400
|
+
**app_id** | **String**| Identifies the app. |
|
381
401
|
**app_user_pre_create_body** | [**AppUserPreCreate**](AppUserPreCreate.md)| Body for a preCreateAppUser request. |
|
382
402
|
|
383
403
|
### Return type
|
@@ -395,63 +415,8 @@ Name | Type | Description | Notes
|
|
395
415
|
|
396
416
|
|
397
417
|
|
398
|
-
# **track_event**
|
399
|
-
> TrackEventResponse track_event(user_id, track_event_body)
|
400
|
-
|
401
|
-
|
402
|
-
|
403
|
-
Track an event for the given app user.
|
404
|
-
|
405
|
-
### Example
|
406
|
-
```ruby
|
407
|
-
# load the gem
|
408
|
-
require 'smooch-api'
|
409
|
-
# setup authorization
|
410
|
-
SmoochApi.configure do |config|
|
411
|
-
# Configure API key authorization: jwt
|
412
|
-
config.api_key['Authorization'] = 'YOUR JWT'
|
413
|
-
config.api_key_prefix['Authorization'] = 'Bearer'
|
414
|
-
end
|
415
|
-
|
416
|
-
api_instance = SmoochApi::AppUserApi.new
|
417
|
-
|
418
|
-
user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
419
|
-
|
420
|
-
track_event_body = SmoochApi::Event.new # Event | Body for a trackEvent request.
|
421
|
-
|
422
|
-
|
423
|
-
begin
|
424
|
-
result = api_instance.track_event(user_id, track_event_body)
|
425
|
-
p result
|
426
|
-
rescue SmoochApi::ApiError => e
|
427
|
-
puts "Exception when calling AppUserApi->track_event: #{e}"
|
428
|
-
end
|
429
|
-
```
|
430
|
-
|
431
|
-
### Parameters
|
432
|
-
|
433
|
-
Name | Type | Description | Notes
|
434
|
-
------------- | ------------- | ------------- | -------------
|
435
|
-
**user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
436
|
-
**track_event_body** | [**Event**](Event.md)| Body for a trackEvent request. |
|
437
|
-
|
438
|
-
### Return type
|
439
|
-
|
440
|
-
[**TrackEventResponse**](TrackEventResponse.md)
|
441
|
-
|
442
|
-
### Authorization
|
443
|
-
|
444
|
-
[jwt](../README.md#jwt)
|
445
|
-
|
446
|
-
### HTTP request headers
|
447
|
-
|
448
|
-
- **Content-Type**: application/json
|
449
|
-
- **Accept**: application/json
|
450
|
-
|
451
|
-
|
452
|
-
|
453
418
|
# **unlink_app_user**
|
454
|
-
> unlink_app_user(user_id, channel)
|
419
|
+
> unlink_app_user(app_id, user_id, channel)
|
455
420
|
|
456
421
|
|
457
422
|
|
@@ -470,13 +435,15 @@ end
|
|
470
435
|
|
471
436
|
api_instance = SmoochApi::AppUserApi.new
|
472
437
|
|
438
|
+
app_id = "app_id_example" # String | Identifies the app.
|
439
|
+
|
473
440
|
user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
474
441
|
|
475
442
|
channel = "channel_example" # String | Name of the channel.
|
476
443
|
|
477
444
|
|
478
445
|
begin
|
479
|
-
api_instance.unlink_app_user(user_id, channel)
|
446
|
+
api_instance.unlink_app_user(app_id, user_id, channel)
|
480
447
|
rescue SmoochApi::ApiError => e
|
481
448
|
puts "Exception when calling AppUserApi->unlink_app_user: #{e}"
|
482
449
|
end
|
@@ -486,6 +453,7 @@ end
|
|
486
453
|
|
487
454
|
Name | Type | Description | Notes
|
488
455
|
------------- | ------------- | ------------- | -------------
|
456
|
+
**app_id** | **String**| Identifies the app. |
|
489
457
|
**user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
490
458
|
**channel** | **String**| Name of the channel. |
|
491
459
|
|
@@ -505,7 +473,7 @@ nil (empty response body)
|
|
505
473
|
|
506
474
|
|
507
475
|
# **update_app_user**
|
508
|
-
> AppUserResponse update_app_user(user_id, app_user_update_body)
|
476
|
+
> AppUserResponse update_app_user(app_id, user_id, app_user_update_body)
|
509
477
|
|
510
478
|
|
511
479
|
|
@@ -524,13 +492,15 @@ end
|
|
524
492
|
|
525
493
|
api_instance = SmoochApi::AppUserApi.new
|
526
494
|
|
495
|
+
app_id = "app_id_example" # String | Identifies the app.
|
496
|
+
|
527
497
|
user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.
|
528
498
|
|
529
499
|
app_user_update_body = SmoochApi::AppUserUpdate.new # AppUserUpdate | Body for an updateAppUser request.
|
530
500
|
|
531
501
|
|
532
502
|
begin
|
533
|
-
result = api_instance.update_app_user(user_id, app_user_update_body)
|
503
|
+
result = api_instance.update_app_user(app_id, user_id, app_user_update_body)
|
534
504
|
p result
|
535
505
|
rescue SmoochApi::ApiError => e
|
536
506
|
puts "Exception when calling AppUserApi->update_app_user: #{e}"
|
@@ -541,6 +511,7 @@ end
|
|
541
511
|
|
542
512
|
Name | Type | Description | Notes
|
543
513
|
------------- | ------------- | ------------- | -------------
|
514
|
+
**app_id** | **String**| Identifies the app. |
|
544
515
|
**user_id** | **String**| Identifies the user. Can be either the smoochId or the userId. |
|
545
516
|
**app_user_update_body** | [**AppUserUpdate**](AppUserUpdate.md)| Body for an updateAppUser request. |
|
546
517
|
|