ultracart_api 4.0.94.rc → 4.0.95.rc
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +13 -4
- data/docs/ConversationApi.md +287 -0
- data/docs/ConversationCannedMessage.md +24 -0
- data/docs/ConversationCannedMessageResponse.md +26 -0
- data/docs/ConversationCannedMessagesResponse.md +26 -0
- data/docs/ConversationCannedMessagesSearch.md +20 -0
- data/lib/ultracart_api/api/conversation_api.rb +271 -0
- data/lib/ultracart_api/models/conversation_canned_message.rb +248 -0
- data/lib/ultracart_api/models/conversation_canned_message_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_canned_messages_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_canned_messages_search.rb +228 -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: 36e518c83bd978f50011032dbcb6aced171395215db766263e3f18715e875682
|
4
|
+
data.tar.gz: bd6c2d10572e34a4faf79ae5f9672f7fa4830938419249983eff85414fc4a1f8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 99b661a9ad10ff5f1e14d18bd214e63928655712f9ac0be1cb186352655055d4660a57d07fb1ff217d3ffda7a82cd67de11d353865d3ff52ff4d92eadc8bb22c
|
7
|
+
data.tar.gz: dd631f76a7580b5aa371454453908f383eb3fa85c4465d7b133d3d6849e7a029ec9b2f71b359626095682c5f16184aa29261ace258919ba79952514924bc021d
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 4.0.
|
10
|
+
- Package version: 4.0.95.rc
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.95.rc.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.95.rc.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.95.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -134,15 +134,19 @@ Class | Method | HTTP request | Description
|
|
134
134
|
*UltracartClient::ConversationApi* | [**get_agent_keep_alive**](docs/ConversationApi.md#get_agent_keep_alive) | **GET** /conversation/agent/keepalive | Agent keep alive
|
135
135
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
136
136
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
137
|
+
*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
|
137
138
|
*UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
|
138
139
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
139
140
|
*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
|
140
141
|
*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
|
141
142
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
143
|
+
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
142
144
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
143
145
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
144
146
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
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
|
145
148
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
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
|
146
150
|
*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
|
147
151
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
148
152
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
@@ -591,6 +595,10 @@ Class | Method | HTTP request | Description
|
|
591
595
|
- [UltracartClient::Conversation](docs/Conversation.md)
|
592
596
|
- [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
|
593
597
|
- [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
|
598
|
+
- [UltracartClient::ConversationCannedMessage](docs/ConversationCannedMessage.md)
|
599
|
+
- [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
|
600
|
+
- [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
|
601
|
+
- [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
|
594
602
|
- [UltracartClient::ConversationEventAddCoupon](docs/ConversationEventAddCoupon.md)
|
595
603
|
- [UltracartClient::ConversationEventAddItem](docs/ConversationEventAddItem.md)
|
596
604
|
- [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
|
@@ -1236,6 +1244,7 @@ Not every change is committed to every SDK.
|
|
1236
1244
|
|
1237
1245
|
| Version | Date | Comments |
|
1238
1246
|
| --: | :-: | --- |
|
1247
|
+
| 4.0.95-RC | 12/08/2022 | conversation canned messages |
|
1239
1248
|
| 4.0.94-RC | 12/08/2022 | communications - expose the rebuild percentage |
|
1240
1249
|
| 4.0.93-RC | 12/06/2022 | convo - add session_start_dts to webchat context, cart - add customer_profile.signup_dts |
|
1241
1250
|
| 4.0.92-RC | 12/06/2022 | customer api - expose edi information and editor values |
|
data/docs/ConversationApi.md
CHANGED
@@ -7,15 +7,19 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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
|
|
@@ -229,6 +233,74 @@ end
|
|
229
233
|
- **Accept**: application/json
|
230
234
|
|
231
235
|
|
236
|
+
## get_conversation_canned_messages
|
237
|
+
|
238
|
+
> <ConversationCannedMessagesResponse> get_conversation_canned_messages
|
239
|
+
|
240
|
+
Retrieve a list of canned messages ordered by short_code
|
241
|
+
|
242
|
+
Retrieve a list of canned messages ordered by short_code
|
243
|
+
|
244
|
+
### Examples
|
245
|
+
|
246
|
+
```ruby
|
247
|
+
require 'time'
|
248
|
+
require 'ultracart_api'
|
249
|
+
require 'json'
|
250
|
+
require 'yaml'
|
251
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
252
|
+
|
253
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
254
|
+
# As such, this might not be the best way to use this object.
|
255
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
256
|
+
|
257
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
258
|
+
|
259
|
+
begin
|
260
|
+
# Retrieve a list of canned messages ordered by short_code
|
261
|
+
result = api_instance.get_conversation_canned_messages
|
262
|
+
p result
|
263
|
+
rescue UltracartClient::ApiError => e
|
264
|
+
puts "Error when calling ConversationApi->get_conversation_canned_messages: #{e}"
|
265
|
+
end
|
266
|
+
```
|
267
|
+
|
268
|
+
#### Using the get_conversation_canned_messages_with_http_info variant
|
269
|
+
|
270
|
+
This returns an Array which contains the response data, status code and headers.
|
271
|
+
|
272
|
+
> <Array(<ConversationCannedMessagesResponse>, Integer, Hash)> get_conversation_canned_messages_with_http_info
|
273
|
+
|
274
|
+
```ruby
|
275
|
+
begin
|
276
|
+
# Retrieve a list of canned messages ordered by short_code
|
277
|
+
data, status_code, headers = api_instance.get_conversation_canned_messages_with_http_info
|
278
|
+
p status_code # => 2xx
|
279
|
+
p headers # => { ... }
|
280
|
+
p data # => <ConversationCannedMessagesResponse>
|
281
|
+
rescue UltracartClient::ApiError => e
|
282
|
+
puts "Error when calling ConversationApi->get_conversation_canned_messages_with_http_info: #{e}"
|
283
|
+
end
|
284
|
+
```
|
285
|
+
|
286
|
+
### Parameters
|
287
|
+
|
288
|
+
This endpoint does not need any parameter.
|
289
|
+
|
290
|
+
### Return type
|
291
|
+
|
292
|
+
[**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
|
293
|
+
|
294
|
+
### Authorization
|
295
|
+
|
296
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
297
|
+
|
298
|
+
### HTTP request headers
|
299
|
+
|
300
|
+
- **Content-Type**: Not defined
|
301
|
+
- **Accept**: application/json
|
302
|
+
|
303
|
+
|
232
304
|
## get_conversation_context
|
233
305
|
|
234
306
|
> <ConversationWebchatContext> get_conversation_context(conversation_uuid)
|
@@ -595,6 +667,77 @@ end
|
|
595
667
|
- **Accept**: application/json
|
596
668
|
|
597
669
|
|
670
|
+
## insert_conversation_canned_message
|
671
|
+
|
672
|
+
> <ConversationCannedMessageResponse> insert_conversation_canned_message(canned_message)
|
673
|
+
|
674
|
+
Insert a canned message
|
675
|
+
|
676
|
+
Insert a canned message
|
677
|
+
|
678
|
+
### Examples
|
679
|
+
|
680
|
+
```ruby
|
681
|
+
require 'time'
|
682
|
+
require 'ultracart_api'
|
683
|
+
require 'json'
|
684
|
+
require 'yaml'
|
685
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
686
|
+
|
687
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
688
|
+
# As such, this might not be the best way to use this object.
|
689
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
690
|
+
|
691
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
692
|
+
canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
|
693
|
+
|
694
|
+
begin
|
695
|
+
# Insert a canned message
|
696
|
+
result = api_instance.insert_conversation_canned_message(canned_message)
|
697
|
+
p result
|
698
|
+
rescue UltracartClient::ApiError => e
|
699
|
+
puts "Error when calling ConversationApi->insert_conversation_canned_message: #{e}"
|
700
|
+
end
|
701
|
+
```
|
702
|
+
|
703
|
+
#### Using the insert_conversation_canned_message_with_http_info variant
|
704
|
+
|
705
|
+
This returns an Array which contains the response data, status code and headers.
|
706
|
+
|
707
|
+
> <Array(<ConversationCannedMessageResponse>, Integer, Hash)> insert_conversation_canned_message_with_http_info(canned_message)
|
708
|
+
|
709
|
+
```ruby
|
710
|
+
begin
|
711
|
+
# Insert a canned message
|
712
|
+
data, status_code, headers = api_instance.insert_conversation_canned_message_with_http_info(canned_message)
|
713
|
+
p status_code # => 2xx
|
714
|
+
p headers # => { ... }
|
715
|
+
p data # => <ConversationCannedMessageResponse>
|
716
|
+
rescue UltracartClient::ApiError => e
|
717
|
+
puts "Error when calling ConversationApi->insert_conversation_canned_message_with_http_info: #{e}"
|
718
|
+
end
|
719
|
+
```
|
720
|
+
|
721
|
+
### Parameters
|
722
|
+
|
723
|
+
| Name | Type | Description | Notes |
|
724
|
+
| ---- | ---- | ----------- | ----- |
|
725
|
+
| **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md) | Canned message | |
|
726
|
+
|
727
|
+
### Return type
|
728
|
+
|
729
|
+
[**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
|
730
|
+
|
731
|
+
### Authorization
|
732
|
+
|
733
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
734
|
+
|
735
|
+
### HTTP request headers
|
736
|
+
|
737
|
+
- **Content-Type**: application/json
|
738
|
+
- **Accept**: application/json
|
739
|
+
|
740
|
+
|
598
741
|
## join_conversation
|
599
742
|
|
600
743
|
> join_conversation(conversation_uuid)
|
@@ -805,6 +948,77 @@ nil (empty response body)
|
|
805
948
|
- **Accept**: application/json
|
806
949
|
|
807
950
|
|
951
|
+
## search_conversation_canned_messages
|
952
|
+
|
953
|
+
> <ConversationCannedMessagesResponse> search_conversation_canned_messages(search_request)
|
954
|
+
|
955
|
+
Search for canned messages by short_code
|
956
|
+
|
957
|
+
Search for canned messages by short_code
|
958
|
+
|
959
|
+
### Examples
|
960
|
+
|
961
|
+
```ruby
|
962
|
+
require 'time'
|
963
|
+
require 'ultracart_api'
|
964
|
+
require 'json'
|
965
|
+
require 'yaml'
|
966
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
967
|
+
|
968
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
969
|
+
# As such, this might not be the best way to use this object.
|
970
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
971
|
+
|
972
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
973
|
+
search_request = UltracartClient::ConversationCannedMessagesSearch.new # ConversationCannedMessagesSearch | Search request
|
974
|
+
|
975
|
+
begin
|
976
|
+
# Search for canned messages by short_code
|
977
|
+
result = api_instance.search_conversation_canned_messages(search_request)
|
978
|
+
p result
|
979
|
+
rescue UltracartClient::ApiError => e
|
980
|
+
puts "Error when calling ConversationApi->search_conversation_canned_messages: #{e}"
|
981
|
+
end
|
982
|
+
```
|
983
|
+
|
984
|
+
#### Using the search_conversation_canned_messages_with_http_info variant
|
985
|
+
|
986
|
+
This returns an Array which contains the response data, status code and headers.
|
987
|
+
|
988
|
+
> <Array(<ConversationCannedMessagesResponse>, Integer, Hash)> search_conversation_canned_messages_with_http_info(search_request)
|
989
|
+
|
990
|
+
```ruby
|
991
|
+
begin
|
992
|
+
# Search for canned messages by short_code
|
993
|
+
data, status_code, headers = api_instance.search_conversation_canned_messages_with_http_info(search_request)
|
994
|
+
p status_code # => 2xx
|
995
|
+
p headers # => { ... }
|
996
|
+
p data # => <ConversationCannedMessagesResponse>
|
997
|
+
rescue UltracartClient::ApiError => e
|
998
|
+
puts "Error when calling ConversationApi->search_conversation_canned_messages_with_http_info: #{e}"
|
999
|
+
end
|
1000
|
+
```
|
1001
|
+
|
1002
|
+
### Parameters
|
1003
|
+
|
1004
|
+
| Name | Type | Description | Notes |
|
1005
|
+
| ---- | ---- | ----------- | ----- |
|
1006
|
+
| **search_request** | [**ConversationCannedMessagesSearch**](ConversationCannedMessagesSearch.md) | Search request | |
|
1007
|
+
|
1008
|
+
### Return type
|
1009
|
+
|
1010
|
+
[**ConversationCannedMessagesResponse**](ConversationCannedMessagesResponse.md)
|
1011
|
+
|
1012
|
+
### Authorization
|
1013
|
+
|
1014
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1015
|
+
|
1016
|
+
### HTTP request headers
|
1017
|
+
|
1018
|
+
- **Content-Type**: application/json
|
1019
|
+
- **Accept**: application/json
|
1020
|
+
|
1021
|
+
|
808
1022
|
## start_conversation
|
809
1023
|
|
810
1024
|
> <ConversationStartResponse> start_conversation(start_request)
|
@@ -876,6 +1090,79 @@ end
|
|
876
1090
|
- **Accept**: application/json
|
877
1091
|
|
878
1092
|
|
1093
|
+
## update_conversation_canned_message
|
1094
|
+
|
1095
|
+
> <ConversationCannedMessageResponse> update_conversation_canned_message(conversation_canned_message_oid, canned_message)
|
1096
|
+
|
1097
|
+
Update a canned message
|
1098
|
+
|
1099
|
+
Update a canned message
|
1100
|
+
|
1101
|
+
### Examples
|
1102
|
+
|
1103
|
+
```ruby
|
1104
|
+
require 'time'
|
1105
|
+
require 'ultracart_api'
|
1106
|
+
require 'json'
|
1107
|
+
require 'yaml'
|
1108
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1109
|
+
|
1110
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1111
|
+
# As such, this might not be the best way to use this object.
|
1112
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1113
|
+
|
1114
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1115
|
+
conversation_canned_message_oid = 56 # Integer |
|
1116
|
+
canned_message = UltracartClient::ConversationCannedMessage.new # ConversationCannedMessage | Canned message
|
1117
|
+
|
1118
|
+
begin
|
1119
|
+
# Update a canned message
|
1120
|
+
result = api_instance.update_conversation_canned_message(conversation_canned_message_oid, canned_message)
|
1121
|
+
p result
|
1122
|
+
rescue UltracartClient::ApiError => e
|
1123
|
+
puts "Error when calling ConversationApi->update_conversation_canned_message: #{e}"
|
1124
|
+
end
|
1125
|
+
```
|
1126
|
+
|
1127
|
+
#### Using the update_conversation_canned_message_with_http_info variant
|
1128
|
+
|
1129
|
+
This returns an Array which contains the response data, status code and headers.
|
1130
|
+
|
1131
|
+
> <Array(<ConversationCannedMessageResponse>, Integer, Hash)> update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message)
|
1132
|
+
|
1133
|
+
```ruby
|
1134
|
+
begin
|
1135
|
+
# Update a canned message
|
1136
|
+
data, status_code, headers = api_instance.update_conversation_canned_message_with_http_info(conversation_canned_message_oid, canned_message)
|
1137
|
+
p status_code # => 2xx
|
1138
|
+
p headers # => { ... }
|
1139
|
+
p data # => <ConversationCannedMessageResponse>
|
1140
|
+
rescue UltracartClient::ApiError => e
|
1141
|
+
puts "Error when calling ConversationApi->update_conversation_canned_message_with_http_info: #{e}"
|
1142
|
+
end
|
1143
|
+
```
|
1144
|
+
|
1145
|
+
### Parameters
|
1146
|
+
|
1147
|
+
| Name | Type | Description | Notes |
|
1148
|
+
| ---- | ---- | ----------- | ----- |
|
1149
|
+
| **conversation_canned_message_oid** | **Integer** | | |
|
1150
|
+
| **canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md) | Canned message | |
|
1151
|
+
|
1152
|
+
### Return type
|
1153
|
+
|
1154
|
+
[**ConversationCannedMessageResponse**](ConversationCannedMessageResponse.md)
|
1155
|
+
|
1156
|
+
### Authorization
|
1157
|
+
|
1158
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1159
|
+
|
1160
|
+
### HTTP request headers
|
1161
|
+
|
1162
|
+
- **Content-Type**: application/json
|
1163
|
+
- **Accept**: application/json
|
1164
|
+
|
1165
|
+
|
879
1166
|
## update_conversation_webchat_queue_status
|
880
1167
|
|
881
1168
|
> update_conversation_webchat_queue_status(queue_name, status_request)
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# UltracartClient::ConversationCannedMessage
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **canned_message** | **String** | | [optional] |
|
8
|
+
| **conversation_canned_message_oid** | **Integer** | | [optional] |
|
9
|
+
| **conversation_webchat_queue_uuids** | **Array<String>** | | [optional] |
|
10
|
+
| **short_code** | **String** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'ultracart_api'
|
16
|
+
|
17
|
+
instance = UltracartClient::ConversationCannedMessage.new(
|
18
|
+
canned_message: null,
|
19
|
+
conversation_canned_message_oid: null,
|
20
|
+
conversation_webchat_queue_uuids: null,
|
21
|
+
short_code: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationCannedMessageResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_canned_message** | [**ConversationCannedMessage**](ConversationCannedMessage.md) | | [optional] |
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationCannedMessageResponse.new(
|
19
|
+
conversation_canned_message: null,
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationCannedMessagesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_canned_messages** | [**Array<ConversationCannedMessage>**](ConversationCannedMessage.md) | | [optional] |
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationCannedMessagesResponse.new(
|
19
|
+
conversation_canned_messages: null,
|
20
|
+
error: null,
|
21
|
+
metadata: null,
|
22
|
+
success: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::ConversationCannedMessagesSearch
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **max_results** | **Integer** | | [optional] |
|
8
|
+
| **short_code** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::ConversationCannedMessagesSearch.new(
|
16
|
+
max_results: null,
|
17
|
+
short_code: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|