ultracart_api 3.10.79 → 3.10.81
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +27 -4
- data/docs/ConversationApi.md +410 -2
- data/docs/ConversationAutocompleteRequest.md +9 -0
- data/docs/ConversationAutocompleteResponse.md +14 -0
- data/docs/ConversationCannedMessage.md +1 -1
- data/docs/ConversationDepartment.md +12 -0
- data/docs/ConversationDepartmentResponse.md +12 -0
- data/docs/ConversationDepartmentSettings.md +7 -0
- data/docs/ConversationDepartmentsResponse.md +12 -0
- data/docs/ConversationEngagement.md +14 -0
- data/docs/ConversationEngagementEquation.md +7 -0
- data/docs/ConversationEngagementResponse.md +12 -0
- data/docs/ConversationEngagementsResponse.md +12 -0
- data/docs/ConversationJoinRequest.md +8 -0
- data/docs/ConversationParticipant.md +2 -0
- data/docs/ConversationSearchRequest.md +17 -0
- data/docs/ConversationSearchResponse.md +10 -0
- data/docs/ConversationWebchatQueueStatusQueueEntry.md +1 -0
- data/lib/ultracart_api/api/conversation_api.rb +443 -1
- data/lib/ultracart_api/models/conversation_autocomplete_request.rb +193 -0
- data/lib/ultracart_api/models/conversation_autocomplete_response.rb +241 -0
- data/lib/ultracart_api/models/conversation_canned_message.rb +1 -1
- data/lib/ultracart_api/models/conversation_department.rb +220 -0
- data/lib/ultracart_api/models/conversation_department_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_department_settings.rb +175 -0
- data/lib/ultracart_api/models/conversation_departments_response.rb +223 -0
- data/lib/ultracart_api/models/conversation_engagement.rb +240 -0
- data/lib/ultracart_api/models/conversation_engagement_equation.rb +175 -0
- data/lib/ultracart_api/models/conversation_engagement_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_engagements_response.rb +223 -0
- data/lib/ultracart_api/models/conversation_join_request.rb +184 -0
- data/lib/ultracart_api/models/conversation_participant.rb +19 -1
- data/lib/ultracart_api/models/conversation_search_request.rb +265 -0
- data/lib/ultracart_api/models/conversation_search_response.rb +202 -0
- data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +10 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +13 -0
- metadata +28 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 06c357e935ee1e8ba7df4774cf3bb451d1bb312f791d215d785a0379ad5181ba
|
4
|
+
data.tar.gz: 6b6c63d5b5c705abe450b15d07ee25259091468ae3b6373437709868b4a3fa4f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3c0ab1e20aa5aca0e2260d57c366ed62d7b37ac49126a6dd592a589f771ccaa03f2a65a8669612e48a850af6b1c69f5859edaf1cacfe4f157bd7ea67eb4e7fc1
|
7
|
+
data.tar.gz: 287a398c2da5e9a3f8312cdbb9639ceb164addbee4a494beac618c301b3e7306fb451441681792a964d3d52a8326221ac13fad546f94281c128c4b197566ec93
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.81
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.81.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.81.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.81'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -130,17 +130,25 @@ Class | Method | HTTP request | Description
|
|
130
130
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
131
131
|
*UltracartClient::ConversationApi* | [**get_conversation_canned_messages**](docs/ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
|
132
132
|
*UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
|
133
|
+
*UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
134
|
+
*UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
133
135
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
134
136
|
*UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
|
135
137
|
*UltracartClient::ConversationApi* | [**get_conversation_webchat_queue_statuses**](docs/ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
|
136
138
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
139
|
+
*UltracartClient::ConversationApi* | [**get_conversations_autocomplete**](docs/ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field
|
140
|
+
*UltracartClient::ConversationApi* | [**get_conversations_search**](docs/ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
|
137
141
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
142
|
+
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
143
|
+
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
138
144
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
139
145
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
140
146
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
141
147
|
*UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
|
142
148
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
143
149
|
*UltracartClient::ConversationApi* | [**update_conversation_canned_message**](docs/ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
|
150
|
+
*UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
|
151
|
+
*UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
|
144
152
|
*UltracartClient::ConversationApi* | [**update_conversation_webchat_queue_status**](docs/ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
|
145
153
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
146
154
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
@@ -589,10 +597,20 @@ Class | Method | HTTP request | Description
|
|
589
597
|
- [UltracartClient::Conversation](docs/Conversation.md)
|
590
598
|
- [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
|
591
599
|
- [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
|
600
|
+
- [UltracartClient::ConversationAutocompleteRequest](docs/ConversationAutocompleteRequest.md)
|
601
|
+
- [UltracartClient::ConversationAutocompleteResponse](docs/ConversationAutocompleteResponse.md)
|
592
602
|
- [UltracartClient::ConversationCannedMessage](docs/ConversationCannedMessage.md)
|
593
603
|
- [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
|
594
604
|
- [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
|
595
605
|
- [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
|
606
|
+
- [UltracartClient::ConversationDepartment](docs/ConversationDepartment.md)
|
607
|
+
- [UltracartClient::ConversationDepartmentResponse](docs/ConversationDepartmentResponse.md)
|
608
|
+
- [UltracartClient::ConversationDepartmentSettings](docs/ConversationDepartmentSettings.md)
|
609
|
+
- [UltracartClient::ConversationDepartmentsResponse](docs/ConversationDepartmentsResponse.md)
|
610
|
+
- [UltracartClient::ConversationEngagement](docs/ConversationEngagement.md)
|
611
|
+
- [UltracartClient::ConversationEngagementEquation](docs/ConversationEngagementEquation.md)
|
612
|
+
- [UltracartClient::ConversationEngagementResponse](docs/ConversationEngagementResponse.md)
|
613
|
+
- [UltracartClient::ConversationEngagementsResponse](docs/ConversationEngagementsResponse.md)
|
596
614
|
- [UltracartClient::ConversationEventAddCoupon](docs/ConversationEventAddCoupon.md)
|
597
615
|
- [UltracartClient::ConversationEventAddItem](docs/ConversationEventAddItem.md)
|
598
616
|
- [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
|
@@ -600,6 +618,7 @@ Class | Method | HTTP request | Description
|
|
600
618
|
- [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
|
601
619
|
- [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
|
602
620
|
- [UltracartClient::ConversationEventWebchatContext](docs/ConversationEventWebchatContext.md)
|
621
|
+
- [UltracartClient::ConversationJoinRequest](docs/ConversationJoinRequest.md)
|
603
622
|
- [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
|
604
623
|
- [UltracartClient::ConversationMessageTranslation](docs/ConversationMessageTranslation.md)
|
605
624
|
- [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
|
@@ -608,6 +627,8 @@ Class | Method | HTTP request | Description
|
|
608
627
|
- [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
|
609
628
|
- [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
|
610
629
|
- [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
|
630
|
+
- [UltracartClient::ConversationSearchRequest](docs/ConversationSearchRequest.md)
|
631
|
+
- [UltracartClient::ConversationSearchResponse](docs/ConversationSearchResponse.md)
|
611
632
|
- [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
|
612
633
|
- [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
|
613
634
|
- [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
|
@@ -1236,6 +1257,8 @@ Not every change is committed to every SDK.
|
|
1236
1257
|
|
1237
1258
|
| Version | Date | Comments |
|
1238
1259
|
| --: | :-: | --- |
|
1260
|
+
| 3.10.81 | 12/15/2022 | conversation searching |
|
1261
|
+
| 3.10.80 | 12/13/2022 | conversations - add email and sms_phone to participant object |
|
1239
1262
|
| 3.10.79 | 12/09/2022 | conversations - message translation |
|
1240
1263
|
| 3.10.78 | 12/08/2022 | conversation canned messages |
|
1241
1264
|
| 3.10.77 | 12/08/2022 | communications - expose the rebuild percentage |
|
data/docs/ConversationApi.md
CHANGED
@@ -9,17 +9,25 @@ Method | HTTP request | Description
|
|
9
9
|
[**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
10
10
|
[**get_conversation_canned_messages**](ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
|
11
11
|
[**get_conversation_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
|
12
|
+
[**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
13
|
+
[**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
12
14
|
[**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
13
15
|
[**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
|
14
16
|
[**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
|
15
17
|
[**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
18
|
+
[**get_conversations_autocomplete**](ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field
|
19
|
+
[**get_conversations_search**](ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
|
16
20
|
[**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
21
|
+
[**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
22
|
+
[**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
17
23
|
[**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
18
24
|
[**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
19
25
|
[**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
20
26
|
[**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
|
21
27
|
[**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
22
28
|
[**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
|
29
|
+
[**update_conversation_department**](ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
|
30
|
+
[**update_conversation_engagement**](ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
|
23
31
|
[**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
|
24
32
|
|
25
33
|
|
@@ -261,6 +269,96 @@ Name | Type | Description | Notes
|
|
261
269
|
|
262
270
|
|
263
271
|
|
272
|
+
# **get_conversation_departments**
|
273
|
+
> ConversationDepartmentsResponse get_conversation_departments
|
274
|
+
|
275
|
+
Retrieve a list of departments ordered by name
|
276
|
+
|
277
|
+
Retrieve a list of departments ordered by name
|
278
|
+
|
279
|
+
### Example
|
280
|
+
```ruby
|
281
|
+
# load the gem
|
282
|
+
require 'ultracart_api'
|
283
|
+
|
284
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
285
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
286
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
begin
|
291
|
+
#Retrieve a list of departments ordered by name
|
292
|
+
result = api_instance.get_conversation_departments
|
293
|
+
p result
|
294
|
+
rescue UltracartClient::ApiError => e
|
295
|
+
puts "Exception when calling ConversationApi->get_conversation_departments: #{e}"
|
296
|
+
end
|
297
|
+
```
|
298
|
+
|
299
|
+
### Parameters
|
300
|
+
This endpoint does not need any parameter.
|
301
|
+
|
302
|
+
### Return type
|
303
|
+
|
304
|
+
[**ConversationDepartmentsResponse**](ConversationDepartmentsResponse.md)
|
305
|
+
|
306
|
+
### Authorization
|
307
|
+
|
308
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
309
|
+
|
310
|
+
### HTTP request headers
|
311
|
+
|
312
|
+
- **Content-Type**: application/json
|
313
|
+
- **Accept**: application/json
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
# **get_conversation_engagements**
|
318
|
+
> ConversationEngagementsResponse get_conversation_engagements
|
319
|
+
|
320
|
+
Retrieve a list of engagements ordered by name
|
321
|
+
|
322
|
+
Retrieve a list of engagements ordered by name
|
323
|
+
|
324
|
+
### Example
|
325
|
+
```ruby
|
326
|
+
# load the gem
|
327
|
+
require 'ultracart_api'
|
328
|
+
|
329
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
330
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
331
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
332
|
+
|
333
|
+
|
334
|
+
|
335
|
+
begin
|
336
|
+
#Retrieve a list of engagements ordered by name
|
337
|
+
result = api_instance.get_conversation_engagements
|
338
|
+
p result
|
339
|
+
rescue UltracartClient::ApiError => e
|
340
|
+
puts "Exception when calling ConversationApi->get_conversation_engagements: #{e}"
|
341
|
+
end
|
342
|
+
```
|
343
|
+
|
344
|
+
### Parameters
|
345
|
+
This endpoint does not need any parameter.
|
346
|
+
|
347
|
+
### Return type
|
348
|
+
|
349
|
+
[**ConversationEngagementsResponse**](ConversationEngagementsResponse.md)
|
350
|
+
|
351
|
+
### Authorization
|
352
|
+
|
353
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
354
|
+
|
355
|
+
### HTTP request headers
|
356
|
+
|
357
|
+
- **Content-Type**: application/json
|
358
|
+
- **Accept**: application/json
|
359
|
+
|
360
|
+
|
361
|
+
|
264
362
|
# **get_conversation_messages**
|
265
363
|
> ConversationMessagesResponse get_conversation_messages(conversation_uuid, since, opts)
|
266
364
|
|
@@ -470,6 +568,106 @@ Name | Type | Description | Notes
|
|
470
568
|
|
471
569
|
|
472
570
|
|
571
|
+
# **get_conversations_autocomplete**
|
572
|
+
> ConversationAutocompleteResponse get_conversations_autocomplete(autocomplete_request)
|
573
|
+
|
574
|
+
Retrieve a list of matching terms for a search field
|
575
|
+
|
576
|
+
Retrieve a list of matching terms for a search field
|
577
|
+
|
578
|
+
### Example
|
579
|
+
```ruby
|
580
|
+
# load the gem
|
581
|
+
require 'ultracart_api'
|
582
|
+
|
583
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
584
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
585
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
586
|
+
|
587
|
+
|
588
|
+
autocomplete_request = UltracartClient::ConversationAutocompleteRequest.new # ConversationAutocompleteRequest | Autocomplete Request
|
589
|
+
|
590
|
+
|
591
|
+
begin
|
592
|
+
#Retrieve a list of matching terms for a search field
|
593
|
+
result = api_instance.get_conversations_autocomplete(autocomplete_request)
|
594
|
+
p result
|
595
|
+
rescue UltracartClient::ApiError => e
|
596
|
+
puts "Exception when calling ConversationApi->get_conversations_autocomplete: #{e}"
|
597
|
+
end
|
598
|
+
```
|
599
|
+
|
600
|
+
### Parameters
|
601
|
+
|
602
|
+
Name | Type | Description | Notes
|
603
|
+
------------- | ------------- | ------------- | -------------
|
604
|
+
**autocomplete_request** | [**ConversationAutocompleteRequest**](ConversationAutocompleteRequest.md)| Autocomplete Request |
|
605
|
+
|
606
|
+
### Return type
|
607
|
+
|
608
|
+
[**ConversationAutocompleteResponse**](ConversationAutocompleteResponse.md)
|
609
|
+
|
610
|
+
### Authorization
|
611
|
+
|
612
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
613
|
+
|
614
|
+
### HTTP request headers
|
615
|
+
|
616
|
+
- **Content-Type**: application/json
|
617
|
+
- **Accept**: application/json
|
618
|
+
|
619
|
+
|
620
|
+
|
621
|
+
# **get_conversations_search**
|
622
|
+
> ConversationSearchResponse get_conversations_search(search_request)
|
623
|
+
|
624
|
+
Search conversations
|
625
|
+
|
626
|
+
Search conversations
|
627
|
+
|
628
|
+
### Example
|
629
|
+
```ruby
|
630
|
+
# load the gem
|
631
|
+
require 'ultracart_api'
|
632
|
+
|
633
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
634
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
635
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
636
|
+
|
637
|
+
|
638
|
+
search_request = UltracartClient::ConversationSearchRequest.new # ConversationSearchRequest | Search Request
|
639
|
+
|
640
|
+
|
641
|
+
begin
|
642
|
+
#Search conversations
|
643
|
+
result = api_instance.get_conversations_search(search_request)
|
644
|
+
p result
|
645
|
+
rescue UltracartClient::ApiError => e
|
646
|
+
puts "Exception when calling ConversationApi->get_conversations_search: #{e}"
|
647
|
+
end
|
648
|
+
```
|
649
|
+
|
650
|
+
### Parameters
|
651
|
+
|
652
|
+
Name | Type | Description | Notes
|
653
|
+
------------- | ------------- | ------------- | -------------
|
654
|
+
**search_request** | [**ConversationSearchRequest**](ConversationSearchRequest.md)| Search Request |
|
655
|
+
|
656
|
+
### Return type
|
657
|
+
|
658
|
+
[**ConversationSearchResponse**](ConversationSearchResponse.md)
|
659
|
+
|
660
|
+
### Authorization
|
661
|
+
|
662
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
663
|
+
|
664
|
+
### HTTP request headers
|
665
|
+
|
666
|
+
- **Content-Type**: application/json
|
667
|
+
- **Accept**: application/json
|
668
|
+
|
669
|
+
|
670
|
+
|
473
671
|
# **insert_conversation_canned_message**
|
474
672
|
> ConversationCannedMessageResponse insert_conversation_canned_message(canned_message)
|
475
673
|
|
@@ -520,8 +718,108 @@ Name | Type | Description | Notes
|
|
520
718
|
|
521
719
|
|
522
720
|
|
721
|
+
# **insert_conversation_department**
|
722
|
+
> ConversationDepartmentResponse insert_conversation_department(department)
|
723
|
+
|
724
|
+
Insert a department
|
725
|
+
|
726
|
+
Insert a department
|
727
|
+
|
728
|
+
### Example
|
729
|
+
```ruby
|
730
|
+
# load the gem
|
731
|
+
require 'ultracart_api'
|
732
|
+
|
733
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
734
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
735
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
736
|
+
|
737
|
+
|
738
|
+
department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
|
739
|
+
|
740
|
+
|
741
|
+
begin
|
742
|
+
#Insert a department
|
743
|
+
result = api_instance.insert_conversation_department(department)
|
744
|
+
p result
|
745
|
+
rescue UltracartClient::ApiError => e
|
746
|
+
puts "Exception when calling ConversationApi->insert_conversation_department: #{e}"
|
747
|
+
end
|
748
|
+
```
|
749
|
+
|
750
|
+
### Parameters
|
751
|
+
|
752
|
+
Name | Type | Description | Notes
|
753
|
+
------------- | ------------- | ------------- | -------------
|
754
|
+
**department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
|
755
|
+
|
756
|
+
### Return type
|
757
|
+
|
758
|
+
[**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
|
759
|
+
|
760
|
+
### Authorization
|
761
|
+
|
762
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
763
|
+
|
764
|
+
### HTTP request headers
|
765
|
+
|
766
|
+
- **Content-Type**: application/json
|
767
|
+
- **Accept**: application/json
|
768
|
+
|
769
|
+
|
770
|
+
|
771
|
+
# **insert_conversation_engagement**
|
772
|
+
> ConversationEngagementResponse insert_conversation_engagement(engagement)
|
773
|
+
|
774
|
+
Insert a engagement
|
775
|
+
|
776
|
+
Insert a engagement
|
777
|
+
|
778
|
+
### Example
|
779
|
+
```ruby
|
780
|
+
# load the gem
|
781
|
+
require 'ultracart_api'
|
782
|
+
|
783
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
784
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
785
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
786
|
+
|
787
|
+
|
788
|
+
engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
|
789
|
+
|
790
|
+
|
791
|
+
begin
|
792
|
+
#Insert a engagement
|
793
|
+
result = api_instance.insert_conversation_engagement(engagement)
|
794
|
+
p result
|
795
|
+
rescue UltracartClient::ApiError => e
|
796
|
+
puts "Exception when calling ConversationApi->insert_conversation_engagement: #{e}"
|
797
|
+
end
|
798
|
+
```
|
799
|
+
|
800
|
+
### Parameters
|
801
|
+
|
802
|
+
Name | Type | Description | Notes
|
803
|
+
------------- | ------------- | ------------- | -------------
|
804
|
+
**engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
|
805
|
+
|
806
|
+
### Return type
|
807
|
+
|
808
|
+
[**ConversationEngagementResponse**](ConversationEngagementResponse.md)
|
809
|
+
|
810
|
+
### Authorization
|
811
|
+
|
812
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
813
|
+
|
814
|
+
### HTTP request headers
|
815
|
+
|
816
|
+
- **Content-Type**: application/json
|
817
|
+
- **Accept**: application/json
|
818
|
+
|
819
|
+
|
820
|
+
|
523
821
|
# **join_conversation**
|
524
|
-
> join_conversation(conversation_uuid)
|
822
|
+
> join_conversation(conversation_uuid, opts)
|
525
823
|
|
526
824
|
Join a conversation
|
527
825
|
|
@@ -539,10 +837,13 @@ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, fa
|
|
539
837
|
|
540
838
|
conversation_uuid = 'conversation_uuid_example' # String |
|
541
839
|
|
840
|
+
opts = {
|
841
|
+
join_request: UltracartClient::ConversationJoinRequest.new # ConversationJoinRequest | Join request
|
842
|
+
}
|
542
843
|
|
543
844
|
begin
|
544
845
|
#Join a conversation
|
545
|
-
api_instance.join_conversation(conversation_uuid)
|
846
|
+
api_instance.join_conversation(conversation_uuid, opts)
|
546
847
|
rescue UltracartClient::ApiError => e
|
547
848
|
puts "Exception when calling ConversationApi->join_conversation: #{e}"
|
548
849
|
end
|
@@ -553,6 +854,7 @@ end
|
|
553
854
|
Name | Type | Description | Notes
|
554
855
|
------------- | ------------- | ------------- | -------------
|
555
856
|
**conversation_uuid** | **String**| |
|
857
|
+
**join_request** | [**ConversationJoinRequest**](ConversationJoinRequest.md)| Join request | [optional]
|
556
858
|
|
557
859
|
### Return type
|
558
860
|
|
@@ -820,6 +1122,112 @@ Name | Type | Description | Notes
|
|
820
1122
|
|
821
1123
|
|
822
1124
|
|
1125
|
+
# **update_conversation_department**
|
1126
|
+
> ConversationDepartmentResponse update_conversation_department(conversation_department_oid, department)
|
1127
|
+
|
1128
|
+
Update a department
|
1129
|
+
|
1130
|
+
Update a department
|
1131
|
+
|
1132
|
+
### Example
|
1133
|
+
```ruby
|
1134
|
+
# load the gem
|
1135
|
+
require 'ultracart_api'
|
1136
|
+
|
1137
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1138
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1139
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
1140
|
+
|
1141
|
+
|
1142
|
+
conversation_department_oid = 56 # Integer |
|
1143
|
+
|
1144
|
+
department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
|
1145
|
+
|
1146
|
+
|
1147
|
+
begin
|
1148
|
+
#Update a department
|
1149
|
+
result = api_instance.update_conversation_department(conversation_department_oid, department)
|
1150
|
+
p result
|
1151
|
+
rescue UltracartClient::ApiError => e
|
1152
|
+
puts "Exception when calling ConversationApi->update_conversation_department: #{e}"
|
1153
|
+
end
|
1154
|
+
```
|
1155
|
+
|
1156
|
+
### Parameters
|
1157
|
+
|
1158
|
+
Name | Type | Description | Notes
|
1159
|
+
------------- | ------------- | ------------- | -------------
|
1160
|
+
**conversation_department_oid** | **Integer**| |
|
1161
|
+
**department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
|
1162
|
+
|
1163
|
+
### Return type
|
1164
|
+
|
1165
|
+
[**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
|
1166
|
+
|
1167
|
+
### Authorization
|
1168
|
+
|
1169
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1170
|
+
|
1171
|
+
### HTTP request headers
|
1172
|
+
|
1173
|
+
- **Content-Type**: application/json
|
1174
|
+
- **Accept**: application/json
|
1175
|
+
|
1176
|
+
|
1177
|
+
|
1178
|
+
# **update_conversation_engagement**
|
1179
|
+
> ConversationEngagementResponse update_conversation_engagement(conversation_engagement_oid, engagement)
|
1180
|
+
|
1181
|
+
Update a engagement
|
1182
|
+
|
1183
|
+
Update a engagement
|
1184
|
+
|
1185
|
+
### Example
|
1186
|
+
```ruby
|
1187
|
+
# load the gem
|
1188
|
+
require 'ultracart_api'
|
1189
|
+
|
1190
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1191
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1192
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
1193
|
+
|
1194
|
+
|
1195
|
+
conversation_engagement_oid = 56 # Integer |
|
1196
|
+
|
1197
|
+
engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
|
1198
|
+
|
1199
|
+
|
1200
|
+
begin
|
1201
|
+
#Update a engagement
|
1202
|
+
result = api_instance.update_conversation_engagement(conversation_engagement_oid, engagement)
|
1203
|
+
p result
|
1204
|
+
rescue UltracartClient::ApiError => e
|
1205
|
+
puts "Exception when calling ConversationApi->update_conversation_engagement: #{e}"
|
1206
|
+
end
|
1207
|
+
```
|
1208
|
+
|
1209
|
+
### Parameters
|
1210
|
+
|
1211
|
+
Name | Type | Description | Notes
|
1212
|
+
------------- | ------------- | ------------- | -------------
|
1213
|
+
**conversation_engagement_oid** | **Integer**| |
|
1214
|
+
**engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
|
1215
|
+
|
1216
|
+
### Return type
|
1217
|
+
|
1218
|
+
[**ConversationEngagementResponse**](ConversationEngagementResponse.md)
|
1219
|
+
|
1220
|
+
### Authorization
|
1221
|
+
|
1222
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1223
|
+
|
1224
|
+
### HTTP request headers
|
1225
|
+
|
1226
|
+
- **Content-Type**: application/json
|
1227
|
+
- **Accept**: application/json
|
1228
|
+
|
1229
|
+
|
1230
|
+
|
823
1231
|
# **update_conversation_webchat_queue_status**
|
824
1232
|
> update_conversation_webchat_queue_status(queue_name, status_request)
|
825
1233
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::ConversationAutocompleteResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**field** | **String** | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**results** | **Array<String>** | | [optional]
|
10
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
11
|
+
**term** | **String** | | [optional]
|
12
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
13
|
+
|
14
|
+
|
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**canned_message** | **String** | | [optional]
|
7
7
|
**conversation_canned_message_oid** | **Integer** | | [optional]
|
8
|
-
**conversation_department_oids** | **Array<
|
8
|
+
**conversation_department_oids** | **Array<Integer>** | | [optional]
|
9
9
|
**short_code** | **String** | | [optional]
|
10
10
|
|
11
11
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationDepartment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_department_oid** | **Integer** | | [optional]
|
7
|
+
**delete_me** | **BOOLEAN** | | [optional]
|
8
|
+
**department_name** | **String** | | [optional]
|
9
|
+
**merchant_id** | **String** | | [optional]
|
10
|
+
**settings** | [**ConversationDepartmentSettings**](ConversationDepartmentSettings.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationDepartmentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_department** | [**ConversationDepartment**](ConversationDepartment.md) | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ConversationDepartmentsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**conversation_departments** | [**Array<ConversationDepartment>**](ConversationDepartment.md) | | [optional]
|
7
|
+
**error** | [**Error**](Error.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|