ultracart_api 3.10.77 → 3.10.78
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 +13 -4
- data/docs/ConversationApi.md +202 -0
- data/docs/ConversationCannedMessage.md +11 -0
- data/docs/ConversationCannedMessageResponse.md +12 -0
- data/docs/ConversationCannedMessagesResponse.md +12 -0
- data/docs/ConversationCannedMessagesSearch.md +9 -0
- data/lib/ultracart_api/api/conversation_api.rb +220 -0
- data/lib/ultracart_api/models/conversation_canned_message.rb +213 -0
- data/lib/ultracart_api/models/conversation_canned_message_response.rb +221 -0
- data/lib/ultracart_api/models/conversation_canned_messages_response.rb +223 -0
- data/lib/ultracart_api/models/conversation_canned_messages_search.rb +193 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- metadata +9 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8dba3aa9669a53a816b945cdb630c69d92d9dd667c2f2c069170b19c3de5042f
|
|
4
|
+
data.tar.gz: 4414ec7a133fa59e800122ae660049ed63e305e86ecddcae5c9690b578391f68
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 13c976e33702d296530faa05b767d498c7f88dc7cd555529908368ca15937b73ab1d6c86fd959eeb434ad9365d57f771974ce873a1d023959c2e4787477122bd
|
|
7
|
+
data.tar.gz: 7ed1d9e19ad3593cd7fb15a0790490fb45f90074bc28af91af928fbf26d2de2322549daf135589aca4206786d3f28b4b034c44a62eee748b0e9695ce17058d19
|
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.78
|
|
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.78.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.78.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.78'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -128,15 +128,19 @@ Class | Method | HTTP request | Description
|
|
|
128
128
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
129
129
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
130
130
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
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
|
|
131
132
|
*UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
|
|
132
133
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
|
133
134
|
*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
|
|
134
135
|
*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
|
|
135
136
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
|
137
|
+
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
|
136
138
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
|
137
139
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
|
138
140
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
|
141
|
+
*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
|
|
139
142
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
|
143
|
+
*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
|
|
140
144
|
*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
|
|
141
145
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
|
142
146
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
|
@@ -585,6 +589,10 @@ Class | Method | HTTP request | Description
|
|
|
585
589
|
- [UltracartClient::Conversation](docs/Conversation.md)
|
|
586
590
|
- [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
|
|
587
591
|
- [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
|
|
592
|
+
- [UltracartClient::ConversationCannedMessage](docs/ConversationCannedMessage.md)
|
|
593
|
+
- [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
|
|
594
|
+
- [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
|
|
595
|
+
- [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
|
|
588
596
|
- [UltracartClient::ConversationEventAddCoupon](docs/ConversationEventAddCoupon.md)
|
|
589
597
|
- [UltracartClient::ConversationEventAddItem](docs/ConversationEventAddItem.md)
|
|
590
598
|
- [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
|
|
@@ -1227,6 +1235,7 @@ Not every change is committed to every SDK.
|
|
|
1227
1235
|
|
|
1228
1236
|
| Version | Date | Comments |
|
|
1229
1237
|
| --: | :-: | --- |
|
|
1238
|
+
| 3.10.78 | 12/08/2022 | conversation canned messages |
|
|
1230
1239
|
| 3.10.77 | 12/08/2022 | communications - expose the rebuild percentage |
|
|
1231
1240
|
| 3.10.76 | 12/06/2022 | convo - add session_start_dts to webchat context, cart - add customer_profile.signup_dts |
|
|
1232
1241
|
| 3.10.75 | 12/06/2022 | customer api - expose edi information and editor values |
|
data/docs/ConversationApi.md
CHANGED
|
@@ -7,15 +7,19 @@ Method | HTTP request | Description
|
|
|
7
7
|
[**get_agent_keep_alive**](ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
|
8
8
|
[**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
9
9
|
[**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
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
|
|
10
11
|
[**get_conversation_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
|
|
11
12
|
[**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
|
12
13
|
[**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
|
|
13
14
|
[**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
|
|
14
15
|
[**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
|
16
|
+
[**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
|
15
17
|
[**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
|
16
18
|
[**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
|
17
19
|
[**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
|
20
|
+
[**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
|
|
18
21
|
[**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
|
22
|
+
[**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message
|
|
19
23
|
[**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue
|
|
20
24
|
|
|
21
25
|
|
|
@@ -162,6 +166,51 @@ Name | Type | Description | Notes
|
|
|
162
166
|
|
|
163
167
|
|
|
164
168
|
|
|
169
|
+
# **get_conversation_canned_messages**
|
|
170
|
+
> ConversationCannedMessagesResponse get_conversation_canned_messages
|
|
171
|
+
|
|
172
|
+
Retrieve a list of canned messages ordered by short_code
|
|
173
|
+
|
|
174
|
+
Retrieve a list of canned messages ordered by short_code
|
|
175
|
+
|
|
176
|
+
### Example
|
|
177
|
+
```ruby
|
|
178
|
+
# load the gem
|
|
179
|
+
require 'ultracart_api'
|
|
180
|
+
|
|
181
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
182
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
183
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
begin
|
|
188
|
+
#Retrieve a list of canned messages ordered by short_code
|
|
189
|
+
result = api_instance.get_conversation_canned_messages
|
|
190
|
+
p result
|
|
191
|
+
rescue UltracartClient::ApiError => e
|
|
192
|
+
puts "Exception when calling ConversationApi->get_conversation_canned_messages: #{e}"
|
|
193
|
+
end
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Parameters
|
|
197
|
+
This endpoint does not need any parameter.
|
|
198
|
+
|
|
199
|
+
### Return type
|
|
200
|
+
|
|
201
|
+
[**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
|
|
202
|
+
|
|
203
|
+
### Authorization
|
|
204
|
+
|
|
205
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
206
|
+
|
|
207
|
+
### HTTP request headers
|
|
208
|
+
|
|
209
|
+
- **Content-Type**: application/json
|
|
210
|
+
- **Accept**: application/json
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
165
214
|
# **get_conversation_context**
|
|
166
215
|
> ConversationWebchatContext get_conversation_context(conversation_uuid)
|
|
167
216
|
|
|
@@ -421,6 +470,56 @@ Name | Type | Description | Notes
|
|
|
421
470
|
|
|
422
471
|
|
|
423
472
|
|
|
473
|
+
# **insert_conversation_canned_message**
|
|
474
|
+
> ConversationCannedMessageResponse insert_conversation_canned_message(canned_message)
|
|
475
|
+
|
|
476
|
+
Insert a canned message
|
|
477
|
+
|
|
478
|
+
Insert a canned message
|
|
479
|
+
|
|
480
|
+
### Example
|
|
481
|
+
```ruby
|
|
482
|
+
# load the gem
|
|
483
|
+
require 'ultracart_api'
|
|
484
|
+
|
|
485
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
486
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
487
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
begin
|
|
494
|
+
#Insert a canned message
|
|
495
|
+
result = api_instance.insert_conversation_canned_message(canned_message)
|
|
496
|
+
p result
|
|
497
|
+
rescue UltracartClient::ApiError => e
|
|
498
|
+
puts "Exception when calling ConversationApi->insert_conversation_canned_message: #{e}"
|
|
499
|
+
end
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
### Parameters
|
|
503
|
+
|
|
504
|
+
Name | Type | Description | Notes
|
|
505
|
+
------------- | ------------- | ------------- | -------------
|
|
506
|
+
**canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
|
|
507
|
+
|
|
508
|
+
### Return type
|
|
509
|
+
|
|
510
|
+
[**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
|
|
511
|
+
|
|
512
|
+
### Authorization
|
|
513
|
+
|
|
514
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
515
|
+
|
|
516
|
+
### HTTP request headers
|
|
517
|
+
|
|
518
|
+
- **Content-Type**: application/json
|
|
519
|
+
- **Accept**: application/json
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
424
523
|
# **join_conversation**
|
|
425
524
|
> join_conversation(conversation_uuid)
|
|
426
525
|
|
|
@@ -568,6 +667,56 @@ nil (empty response body)
|
|
|
568
667
|
|
|
569
668
|
|
|
570
669
|
|
|
670
|
+
# **search_conversation_canned_messages**
|
|
671
|
+
> ConversationCannedMessagesResponse search_conversation_canned_messages(search_request)
|
|
672
|
+
|
|
673
|
+
Search for canned messages by short_code
|
|
674
|
+
|
|
675
|
+
Search for canned messages by short_code
|
|
676
|
+
|
|
677
|
+
### Example
|
|
678
|
+
```ruby
|
|
679
|
+
# load the gem
|
|
680
|
+
require 'ultracart_api'
|
|
681
|
+
|
|
682
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
683
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
684
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
search_request = UltracartClient::ConversationCannedMessagesSearch.new # ConversationCannedMessagesSearch | Search request
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
begin
|
|
691
|
+
#Search for canned messages by short_code
|
|
692
|
+
result = api_instance.search_conversation_canned_messages(search_request)
|
|
693
|
+
p result
|
|
694
|
+
rescue UltracartClient::ApiError => e
|
|
695
|
+
puts "Exception when calling ConversationApi->search_conversation_canned_messages: #{e}"
|
|
696
|
+
end
|
|
697
|
+
```
|
|
698
|
+
|
|
699
|
+
### Parameters
|
|
700
|
+
|
|
701
|
+
Name | Type | Description | Notes
|
|
702
|
+
------------- | ------------- | ------------- | -------------
|
|
703
|
+
**search_request** | [**ConversationCannedMessagesSearch**](ConversationCannedMessagesSearch.md)| Search request |
|
|
704
|
+
|
|
705
|
+
### Return type
|
|
706
|
+
|
|
707
|
+
[**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
|
|
708
|
+
|
|
709
|
+
### Authorization
|
|
710
|
+
|
|
711
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
712
|
+
|
|
713
|
+
### HTTP request headers
|
|
714
|
+
|
|
715
|
+
- **Content-Type**: application/json
|
|
716
|
+
- **Accept**: application/json
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
|
|
571
720
|
# **start_conversation**
|
|
572
721
|
> ConversationStartResponse start_conversation(start_request)
|
|
573
722
|
|
|
@@ -618,6 +767,59 @@ Name | Type | Description | Notes
|
|
|
618
767
|
|
|
619
768
|
|
|
620
769
|
|
|
770
|
+
# **update_conversation_canned_message**
|
|
771
|
+
> ConversationCannedMessageResponse update_conversation_canned_message(conversation_canned_message_oid, canned_message)
|
|
772
|
+
|
|
773
|
+
Update a canned message
|
|
774
|
+
|
|
775
|
+
Update a canned message
|
|
776
|
+
|
|
777
|
+
### Example
|
|
778
|
+
```ruby
|
|
779
|
+
# load the gem
|
|
780
|
+
require 'ultracart_api'
|
|
781
|
+
|
|
782
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
783
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
784
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
conversation_canned_message_oid = 56 # Integer |
|
|
788
|
+
|
|
789
|
+
canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
begin
|
|
793
|
+
#Update a canned message
|
|
794
|
+
result = api_instance.update_conversation_canned_message(conversation_canned_message_oid, canned_message)
|
|
795
|
+
p result
|
|
796
|
+
rescue UltracartClient::ApiError => e
|
|
797
|
+
puts "Exception when calling ConversationApi->update_conversation_canned_message: #{e}"
|
|
798
|
+
end
|
|
799
|
+
```
|
|
800
|
+
|
|
801
|
+
### Parameters
|
|
802
|
+
|
|
803
|
+
Name | Type | Description | Notes
|
|
804
|
+
------------- | ------------- | ------------- | -------------
|
|
805
|
+
**conversation_canned_message_oid** | **Integer**| |
|
|
806
|
+
**canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md)| Canned message |
|
|
807
|
+
|
|
808
|
+
### Return type
|
|
809
|
+
|
|
810
|
+
[**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
|
|
811
|
+
|
|
812
|
+
### Authorization
|
|
813
|
+
|
|
814
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
815
|
+
|
|
816
|
+
### HTTP request headers
|
|
817
|
+
|
|
818
|
+
- **Content-Type**: application/json
|
|
819
|
+
- **Accept**: application/json
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
621
823
|
# **update_conversation_webchat_queue_status**
|
|
622
824
|
> update_conversation_webchat_queue_status(queue_name, status_request)
|
|
623
825
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# UltracartClient::ConversationCannedMessage
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**canned_message** | **String** | | [optional]
|
|
7
|
+
**conversation_canned_message_oid** | **Integer** | | [optional]
|
|
8
|
+
**conversation_webchat_queue_uuids** | **Array<String>** | | [optional]
|
|
9
|
+
**short_code** | **String** | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ConversationCannedMessageResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**conversation_canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.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::ConversationCannedMessagesResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**conversation_canned_messages** | [**Array<ConversationCannedMessage>**](ConversationCannedMessage.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,9 @@
|
|
|
1
|
+
# UltracartClient::ConversationCannedMessagesSearch
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**max_results** | **Integer** | | [optional]
|
|
7
|
+
**short_code** | **String** | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -187,6 +187,55 @@ module UltracartClient
|
|
|
187
187
|
end
|
|
188
188
|
return data, status_code, headers
|
|
189
189
|
end
|
|
190
|
+
# Retrieve a list of canned messages ordered by short_code
|
|
191
|
+
# Retrieve a list of canned messages ordered by short_code
|
|
192
|
+
# @param [Hash] opts the optional parameters
|
|
193
|
+
# @return [ConversationCannedMessagesResponse]
|
|
194
|
+
def get_conversation_canned_messages(opts = {})
|
|
195
|
+
data, _status_code, _headers = get_conversation_canned_messages_with_http_info(opts)
|
|
196
|
+
data
|
|
197
|
+
end
|
|
198
|
+
|
|
199
|
+
# Retrieve a list of canned messages ordered by short_code
|
|
200
|
+
# Retrieve a list of canned messages ordered by short_code
|
|
201
|
+
# @param [Hash] opts the optional parameters
|
|
202
|
+
# @return [Array<(ConversationCannedMessagesResponse, Fixnum, Hash)>] ConversationCannedMessagesResponse data, response status code and response headers
|
|
203
|
+
def get_conversation_canned_messages_with_http_info(opts = {})
|
|
204
|
+
if @api_client.config.debugging
|
|
205
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_canned_messages ...'
|
|
206
|
+
end
|
|
207
|
+
# resource path
|
|
208
|
+
local_var_path = '/conversation/canned_messages'
|
|
209
|
+
|
|
210
|
+
# query parameters
|
|
211
|
+
query_params = {}
|
|
212
|
+
|
|
213
|
+
# header parameters
|
|
214
|
+
header_params = {}
|
|
215
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
216
|
+
# HTTP header 'Accept' (if needed)
|
|
217
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
218
|
+
# HTTP header 'Content-Type'
|
|
219
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
220
|
+
|
|
221
|
+
# form parameters
|
|
222
|
+
form_params = {}
|
|
223
|
+
|
|
224
|
+
# http body (model)
|
|
225
|
+
post_body = nil
|
|
226
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
227
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
228
|
+
:header_params => header_params,
|
|
229
|
+
:query_params => query_params,
|
|
230
|
+
:form_params => form_params,
|
|
231
|
+
:body => post_body,
|
|
232
|
+
:auth_names => auth_names,
|
|
233
|
+
:return_type => 'ConversationCannedMessagesResponse')
|
|
234
|
+
if @api_client.config.debugging
|
|
235
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_canned_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
236
|
+
end
|
|
237
|
+
return data, status_code, headers
|
|
238
|
+
end
|
|
190
239
|
# Get a webchat conversation context
|
|
191
240
|
# Get a webchat conversation context
|
|
192
241
|
# @param conversation_uuid
|
|
@@ -471,6 +520,61 @@ module UltracartClient
|
|
|
471
520
|
end
|
|
472
521
|
return data, status_code, headers
|
|
473
522
|
end
|
|
523
|
+
# Insert a canned message
|
|
524
|
+
# Insert a canned message
|
|
525
|
+
# @param canned_message Canned message
|
|
526
|
+
# @param [Hash] opts the optional parameters
|
|
527
|
+
# @return [ConversationCannedMessageResponse]
|
|
528
|
+
def insert_conversation_canned_message(canned_message, opts = {})
|
|
529
|
+
data, _status_code, _headers = insert_conversation_canned_message_with_http_info(canned_message, opts)
|
|
530
|
+
data
|
|
531
|
+
end
|
|
532
|
+
|
|
533
|
+
# Insert a canned message
|
|
534
|
+
# Insert a canned message
|
|
535
|
+
# @param canned_message Canned message
|
|
536
|
+
# @param [Hash] opts the optional parameters
|
|
537
|
+
# @return [Array<(ConversationCannedMessageResponse, Fixnum, Hash)>] ConversationCannedMessageResponse data, response status code and response headers
|
|
538
|
+
def insert_conversation_canned_message_with_http_info(canned_message, opts = {})
|
|
539
|
+
if @api_client.config.debugging
|
|
540
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.insert_conversation_canned_message ...'
|
|
541
|
+
end
|
|
542
|
+
# verify the required parameter 'canned_message' is set
|
|
543
|
+
if @api_client.config.client_side_validation && canned_message.nil?
|
|
544
|
+
fail ArgumentError, "Missing the required parameter 'canned_message' when calling ConversationApi.insert_conversation_canned_message"
|
|
545
|
+
end
|
|
546
|
+
# resource path
|
|
547
|
+
local_var_path = '/conversation/canned_messages'
|
|
548
|
+
|
|
549
|
+
# query parameters
|
|
550
|
+
query_params = {}
|
|
551
|
+
|
|
552
|
+
# header parameters
|
|
553
|
+
header_params = {}
|
|
554
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
555
|
+
# HTTP header 'Accept' (if needed)
|
|
556
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
557
|
+
# HTTP header 'Content-Type'
|
|
558
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
559
|
+
|
|
560
|
+
# form parameters
|
|
561
|
+
form_params = {}
|
|
562
|
+
|
|
563
|
+
# http body (model)
|
|
564
|
+
post_body = @api_client.object_to_http_body(canned_message)
|
|
565
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
566
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
567
|
+
:header_params => header_params,
|
|
568
|
+
:query_params => query_params,
|
|
569
|
+
:form_params => form_params,
|
|
570
|
+
:body => post_body,
|
|
571
|
+
:auth_names => auth_names,
|
|
572
|
+
:return_type => 'ConversationCannedMessageResponse')
|
|
573
|
+
if @api_client.config.debugging
|
|
574
|
+
@api_client.config.logger.debug "API called: ConversationApi#insert_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
575
|
+
end
|
|
576
|
+
return data, status_code, headers
|
|
577
|
+
end
|
|
474
578
|
# Join a conversation
|
|
475
579
|
# Join a conversation
|
|
476
580
|
# @param conversation_uuid
|
|
@@ -633,6 +737,61 @@ module UltracartClient
|
|
|
633
737
|
end
|
|
634
738
|
return data, status_code, headers
|
|
635
739
|
end
|
|
740
|
+
# Search for canned messages by short_code
|
|
741
|
+
# Search for canned messages by short_code
|
|
742
|
+
# @param search_request Search request
|
|
743
|
+
# @param [Hash] opts the optional parameters
|
|
744
|
+
# @return [ConversationCannedMessagesResponse]
|
|
745
|
+
def search_conversation_canned_messages(search_request, opts = {})
|
|
746
|
+
data, _status_code, _headers = search_conversation_canned_messages_with_http_info(search_request, opts)
|
|
747
|
+
data
|
|
748
|
+
end
|
|
749
|
+
|
|
750
|
+
# Search for canned messages by short_code
|
|
751
|
+
# Search for canned messages by short_code
|
|
752
|
+
# @param search_request Search request
|
|
753
|
+
# @param [Hash] opts the optional parameters
|
|
754
|
+
# @return [Array<(ConversationCannedMessagesResponse, Fixnum, Hash)>] ConversationCannedMessagesResponse data, response status code and response headers
|
|
755
|
+
def search_conversation_canned_messages_with_http_info(search_request, opts = {})
|
|
756
|
+
if @api_client.config.debugging
|
|
757
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.search_conversation_canned_messages ...'
|
|
758
|
+
end
|
|
759
|
+
# verify the required parameter 'search_request' is set
|
|
760
|
+
if @api_client.config.client_side_validation && search_request.nil?
|
|
761
|
+
fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.search_conversation_canned_messages"
|
|
762
|
+
end
|
|
763
|
+
# resource path
|
|
764
|
+
local_var_path = '/conversation/canned_messages/search'
|
|
765
|
+
|
|
766
|
+
# query parameters
|
|
767
|
+
query_params = {}
|
|
768
|
+
|
|
769
|
+
# header parameters
|
|
770
|
+
header_params = {}
|
|
771
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
772
|
+
# HTTP header 'Accept' (if needed)
|
|
773
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
774
|
+
# HTTP header 'Content-Type'
|
|
775
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
776
|
+
|
|
777
|
+
# form parameters
|
|
778
|
+
form_params = {}
|
|
779
|
+
|
|
780
|
+
# http body (model)
|
|
781
|
+
post_body = @api_client.object_to_http_body(search_request)
|
|
782
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
783
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
784
|
+
:header_params => header_params,
|
|
785
|
+
:query_params => query_params,
|
|
786
|
+
:form_params => form_params,
|
|
787
|
+
:body => post_body,
|
|
788
|
+
:auth_names => auth_names,
|
|
789
|
+
:return_type => 'ConversationCannedMessagesResponse')
|
|
790
|
+
if @api_client.config.debugging
|
|
791
|
+
@api_client.config.logger.debug "API called: ConversationApi#search_conversation_canned_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
792
|
+
end
|
|
793
|
+
return data, status_code, headers
|
|
794
|
+
end
|
|
636
795
|
# Start a conversation
|
|
637
796
|
# Start a new conversation
|
|
638
797
|
# @param start_request Start request
|
|
@@ -688,6 +847,67 @@ module UltracartClient
|
|
|
688
847
|
end
|
|
689
848
|
return data, status_code, headers
|
|
690
849
|
end
|
|
850
|
+
# Update a canned message
|
|
851
|
+
# Update a canned message
|
|
852
|
+
# @param conversation_canned_message_oid
|
|
853
|
+
# @param canned_message Canned message
|
|
854
|
+
# @param [Hash] opts the optional parameters
|
|
855
|
+
# @return [ConversationCannedMessageResponse]
|
|
856
|
+
def update_conversation_canned_message(conversation_canned_message_oid, canned_message, opts = {})
|
|
857
|
+
data, _status_code, _headers = update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts)
|
|
858
|
+
data
|
|
859
|
+
end
|
|
860
|
+
|
|
861
|
+
# Update a canned message
|
|
862
|
+
# Update a canned message
|
|
863
|
+
# @param conversation_canned_message_oid
|
|
864
|
+
# @param canned_message Canned message
|
|
865
|
+
# @param [Hash] opts the optional parameters
|
|
866
|
+
# @return [Array<(ConversationCannedMessageResponse, Fixnum, Hash)>] ConversationCannedMessageResponse data, response status code and response headers
|
|
867
|
+
def update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message, opts = {})
|
|
868
|
+
if @api_client.config.debugging
|
|
869
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.update_conversation_canned_message ...'
|
|
870
|
+
end
|
|
871
|
+
# verify the required parameter 'conversation_canned_message_oid' is set
|
|
872
|
+
if @api_client.config.client_side_validation && conversation_canned_message_oid.nil?
|
|
873
|
+
fail ArgumentError, "Missing the required parameter 'conversation_canned_message_oid' when calling ConversationApi.update_conversation_canned_message"
|
|
874
|
+
end
|
|
875
|
+
# verify the required parameter 'canned_message' is set
|
|
876
|
+
if @api_client.config.client_side_validation && canned_message.nil?
|
|
877
|
+
fail ArgumentError, "Missing the required parameter 'canned_message' when calling ConversationApi.update_conversation_canned_message"
|
|
878
|
+
end
|
|
879
|
+
# resource path
|
|
880
|
+
local_var_path = '/conversation/canned_messages/{conversation_canned_message_oid}'.sub('{' + 'conversation_canned_message_oid' + '}', conversation_canned_message_oid.to_s)
|
|
881
|
+
|
|
882
|
+
# query parameters
|
|
883
|
+
query_params = {}
|
|
884
|
+
|
|
885
|
+
# header parameters
|
|
886
|
+
header_params = {}
|
|
887
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
888
|
+
# HTTP header 'Accept' (if needed)
|
|
889
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
890
|
+
# HTTP header 'Content-Type'
|
|
891
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
892
|
+
|
|
893
|
+
# form parameters
|
|
894
|
+
form_params = {}
|
|
895
|
+
|
|
896
|
+
# http body (model)
|
|
897
|
+
post_body = @api_client.object_to_http_body(canned_message)
|
|
898
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
899
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
900
|
+
:header_params => header_params,
|
|
901
|
+
:query_params => query_params,
|
|
902
|
+
:form_params => form_params,
|
|
903
|
+
:body => post_body,
|
|
904
|
+
:auth_names => auth_names,
|
|
905
|
+
:return_type => 'ConversationCannedMessageResponse')
|
|
906
|
+
if @api_client.config.debugging
|
|
907
|
+
@api_client.config.logger.debug "API called: ConversationApi#update_conversation_canned_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
908
|
+
end
|
|
909
|
+
return data, status_code, headers
|
|
910
|
+
end
|
|
691
911
|
# Update status within the queue
|
|
692
912
|
# Update status within the queue
|
|
693
913
|
# @param queue_name
|