ultracart_api 4.0.95.rc → 4.0.97.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 +20 -4
- data/docs/ConversationApi.md +439 -5
- data/docs/ConversationCannedMessage.md +2 -2
- data/docs/ConversationDepartment.md +26 -0
- data/docs/ConversationDepartmentResponse.md +26 -0
- data/docs/ConversationDepartmentsResponse.md +26 -0
- data/docs/ConversationEngagement.md +30 -0
- data/docs/ConversationEngagementResponse.md +26 -0
- data/docs/ConversationEngagementsResponse.md +26 -0
- data/docs/ConversationJoinRequest.md +18 -0
- data/docs/ConversationMessage.md +4 -0
- data/docs/ConversationMessageTranslation.md +20 -0
- data/docs/ConversationParticipant.md +6 -0
- data/docs/ConversationWebchatQueueStatusQueueEntry.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +412 -1
- data/lib/ultracart_api/models/conversation_canned_message.rb +8 -8
- data/lib/ultracart_api/models/conversation_department.rb +255 -0
- data/lib/ultracart_api/models/conversation_department_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_departments_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_engagement.rb +275 -0
- data/lib/ultracart_api/models/conversation_engagement_response.rb +256 -0
- data/lib/ultracart_api/models/conversation_engagements_response.rb +258 -0
- data/lib/ultracart_api/models/conversation_join_request.rb +219 -0
- data/lib/ultracart_api/models/conversation_message.rb +21 -1
- data/lib/ultracart_api/models/conversation_message_translation.rb +228 -0
- data/lib/ultracart_api/models/conversation_participant.rb +28 -1
- 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 +8 -0
- metadata +18 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 294d5bdc4522349efee081d02d82ac9dc5893b8479931d7bd878de20ceba5f7e
|
4
|
+
data.tar.gz: 133d2c89438760ba5852cf886d14c9933d9fad98802f3dfb51fa225b5be5b009
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c118588dbacdfd72c426a85524752175e0d91fa1fcb8c1fb4219adae424d90776e48570ce16da5bb7775765bec36f1c5b97a47d84c0528f65eeaf43e87b12a58
|
7
|
+
data.tar.gz: 29bfe3f819d8bf5241ca4c7b3f0fb4a63c1091fee4939054db601b1a0bf9b1b666d1b518422641697313d98e6b6db1343a3a12ea1cfb03e714866b890130c7cf
|
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.97.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.97.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.97.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.97.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -136,17 +136,23 @@ Class | Method | HTTP request | Description
|
|
136
136
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
137
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
|
138
138
|
*UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
|
139
|
+
*UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
140
|
+
*UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
139
141
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
140
142
|
*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
|
141
143
|
*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
|
142
144
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
143
145
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
146
|
+
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
147
|
+
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
144
148
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
145
149
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
146
150
|
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
147
151
|
*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
|
148
152
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
149
153
|
*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
|
154
|
+
*UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
|
155
|
+
*UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
|
150
156
|
*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
|
151
157
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
152
158
|
*UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
|
@@ -599,6 +605,12 @@ Class | Method | HTTP request | Description
|
|
599
605
|
- [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
|
600
606
|
- [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
|
601
607
|
- [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
|
608
|
+
- [UltracartClient::ConversationDepartment](docs/ConversationDepartment.md)
|
609
|
+
- [UltracartClient::ConversationDepartmentResponse](docs/ConversationDepartmentResponse.md)
|
610
|
+
- [UltracartClient::ConversationDepartmentsResponse](docs/ConversationDepartmentsResponse.md)
|
611
|
+
- [UltracartClient::ConversationEngagement](docs/ConversationEngagement.md)
|
612
|
+
- [UltracartClient::ConversationEngagementResponse](docs/ConversationEngagementResponse.md)
|
613
|
+
- [UltracartClient::ConversationEngagementsResponse](docs/ConversationEngagementsResponse.md)
|
602
614
|
- [UltracartClient::ConversationEventAddCoupon](docs/ConversationEventAddCoupon.md)
|
603
615
|
- [UltracartClient::ConversationEventAddItem](docs/ConversationEventAddItem.md)
|
604
616
|
- [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
|
@@ -606,7 +618,9 @@ Class | Method | HTTP request | Description
|
|
606
618
|
- [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
|
607
619
|
- [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
|
608
620
|
- [UltracartClient::ConversationEventWebchatContext](docs/ConversationEventWebchatContext.md)
|
621
|
+
- [UltracartClient::ConversationJoinRequest](docs/ConversationJoinRequest.md)
|
609
622
|
- [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
|
623
|
+
- [UltracartClient::ConversationMessageTranslation](docs/ConversationMessageTranslation.md)
|
610
624
|
- [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
|
611
625
|
- [UltracartClient::ConversationMessagesResponse](docs/ConversationMessagesResponse.md)
|
612
626
|
- [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
|
@@ -1244,6 +1258,8 @@ Not every change is committed to every SDK.
|
|
1244
1258
|
|
1245
1259
|
| Version | Date | Comments |
|
1246
1260
|
| --: | :-: | --- |
|
1261
|
+
| 4.0.97-RC | 12/13/2022 | conversations - add email and sms_phone to participant object |
|
1262
|
+
| 4.0.96-RC | 12/09/2022 | conversations - message translation |
|
1247
1263
|
| 4.0.95-RC | 12/08/2022 | conversation canned messages |
|
1248
1264
|
| 4.0.94-RC | 12/08/2022 | communications - expose the rebuild percentage |
|
1249
1265
|
| 4.0.93-RC | 12/06/2022 | convo - add session_start_dts to webchat context, cart - add customer_profile.signup_dts |
|
data/docs/ConversationApi.md
CHANGED
@@ -9,17 +9,23 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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 |
|
16
18
|
| [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message |
|
19
|
+
| [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department |
|
20
|
+
| [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement |
|
17
21
|
| [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
|
18
22
|
| [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
|
19
23
|
| [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
|
20
24
|
| [**search_conversation_canned_messages**](ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code |
|
21
25
|
| [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
|
22
26
|
| [**update_conversation_canned_message**](ConversationApi.md#update_conversation_canned_message) | **PUT** /conversation/canned_messages/{conversation_canned_message_oid} | Update a canned message |
|
27
|
+
| [**update_conversation_department**](ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department |
|
28
|
+
| [**update_conversation_engagement**](ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement |
|
23
29
|
| [**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
30
|
|
25
31
|
|
@@ -372,6 +378,142 @@ end
|
|
372
378
|
- **Accept**: application/json
|
373
379
|
|
374
380
|
|
381
|
+
## get_conversation_departments
|
382
|
+
|
383
|
+
> <ConversationDepartmentsResponse> get_conversation_departments
|
384
|
+
|
385
|
+
Retrieve a list of departments ordered by name
|
386
|
+
|
387
|
+
Retrieve a list of departments ordered by name
|
388
|
+
|
389
|
+
### Examples
|
390
|
+
|
391
|
+
```ruby
|
392
|
+
require 'time'
|
393
|
+
require 'ultracart_api'
|
394
|
+
require 'json'
|
395
|
+
require 'yaml'
|
396
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
397
|
+
|
398
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
399
|
+
# As such, this might not be the best way to use this object.
|
400
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
401
|
+
|
402
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
403
|
+
|
404
|
+
begin
|
405
|
+
# Retrieve a list of departments ordered by name
|
406
|
+
result = api_instance.get_conversation_departments
|
407
|
+
p result
|
408
|
+
rescue UltracartClient::ApiError => e
|
409
|
+
puts "Error when calling ConversationApi->get_conversation_departments: #{e}"
|
410
|
+
end
|
411
|
+
```
|
412
|
+
|
413
|
+
#### Using the get_conversation_departments_with_http_info variant
|
414
|
+
|
415
|
+
This returns an Array which contains the response data, status code and headers.
|
416
|
+
|
417
|
+
> <Array(<ConversationDepartmentsResponse>, Integer, Hash)> get_conversation_departments_with_http_info
|
418
|
+
|
419
|
+
```ruby
|
420
|
+
begin
|
421
|
+
# Retrieve a list of departments ordered by name
|
422
|
+
data, status_code, headers = api_instance.get_conversation_departments_with_http_info
|
423
|
+
p status_code # => 2xx
|
424
|
+
p headers # => { ... }
|
425
|
+
p data # => <ConversationDepartmentsResponse>
|
426
|
+
rescue UltracartClient::ApiError => e
|
427
|
+
puts "Error when calling ConversationApi->get_conversation_departments_with_http_info: #{e}"
|
428
|
+
end
|
429
|
+
```
|
430
|
+
|
431
|
+
### Parameters
|
432
|
+
|
433
|
+
This endpoint does not need any parameter.
|
434
|
+
|
435
|
+
### Return type
|
436
|
+
|
437
|
+
[**ConversationDepartmentsResponse**](ConversationDepartmentsResponse.md)
|
438
|
+
|
439
|
+
### Authorization
|
440
|
+
|
441
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
442
|
+
|
443
|
+
### HTTP request headers
|
444
|
+
|
445
|
+
- **Content-Type**: Not defined
|
446
|
+
- **Accept**: application/json
|
447
|
+
|
448
|
+
|
449
|
+
## get_conversation_engagements
|
450
|
+
|
451
|
+
> <ConversationEngagementsResponse> get_conversation_engagements
|
452
|
+
|
453
|
+
Retrieve a list of engagements ordered by name
|
454
|
+
|
455
|
+
Retrieve a list of engagements ordered by name
|
456
|
+
|
457
|
+
### Examples
|
458
|
+
|
459
|
+
```ruby
|
460
|
+
require 'time'
|
461
|
+
require 'ultracart_api'
|
462
|
+
require 'json'
|
463
|
+
require 'yaml'
|
464
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
465
|
+
|
466
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
467
|
+
# As such, this might not be the best way to use this object.
|
468
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
469
|
+
|
470
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
471
|
+
|
472
|
+
begin
|
473
|
+
# Retrieve a list of engagements ordered by name
|
474
|
+
result = api_instance.get_conversation_engagements
|
475
|
+
p result
|
476
|
+
rescue UltracartClient::ApiError => e
|
477
|
+
puts "Error when calling ConversationApi->get_conversation_engagements: #{e}"
|
478
|
+
end
|
479
|
+
```
|
480
|
+
|
481
|
+
#### Using the get_conversation_engagements_with_http_info variant
|
482
|
+
|
483
|
+
This returns an Array which contains the response data, status code and headers.
|
484
|
+
|
485
|
+
> <Array(<ConversationEngagementsResponse>, Integer, Hash)> get_conversation_engagements_with_http_info
|
486
|
+
|
487
|
+
```ruby
|
488
|
+
begin
|
489
|
+
# Retrieve a list of engagements ordered by name
|
490
|
+
data, status_code, headers = api_instance.get_conversation_engagements_with_http_info
|
491
|
+
p status_code # => 2xx
|
492
|
+
p headers # => { ... }
|
493
|
+
p data # => <ConversationEngagementsResponse>
|
494
|
+
rescue UltracartClient::ApiError => e
|
495
|
+
puts "Error when calling ConversationApi->get_conversation_engagements_with_http_info: #{e}"
|
496
|
+
end
|
497
|
+
```
|
498
|
+
|
499
|
+
### Parameters
|
500
|
+
|
501
|
+
This endpoint does not need any parameter.
|
502
|
+
|
503
|
+
### Return type
|
504
|
+
|
505
|
+
[**ConversationEngagementsResponse**](ConversationEngagementsResponse.md)
|
506
|
+
|
507
|
+
### Authorization
|
508
|
+
|
509
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
510
|
+
|
511
|
+
### HTTP request headers
|
512
|
+
|
513
|
+
- **Content-Type**: Not defined
|
514
|
+
- **Accept**: application/json
|
515
|
+
|
516
|
+
|
375
517
|
## get_conversation_messages
|
376
518
|
|
377
519
|
> <ConversationMessagesResponse> get_conversation_messages(conversation_uuid, since, opts)
|
@@ -738,9 +880,151 @@ end
|
|
738
880
|
- **Accept**: application/json
|
739
881
|
|
740
882
|
|
883
|
+
## insert_conversation_department
|
884
|
+
|
885
|
+
> <ConversationDepartmentResponse> insert_conversation_department(department)
|
886
|
+
|
887
|
+
Insert a department
|
888
|
+
|
889
|
+
Insert a department
|
890
|
+
|
891
|
+
### Examples
|
892
|
+
|
893
|
+
```ruby
|
894
|
+
require 'time'
|
895
|
+
require 'ultracart_api'
|
896
|
+
require 'json'
|
897
|
+
require 'yaml'
|
898
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
899
|
+
|
900
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
901
|
+
# As such, this might not be the best way to use this object.
|
902
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
903
|
+
|
904
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
905
|
+
department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
|
906
|
+
|
907
|
+
begin
|
908
|
+
# Insert a department
|
909
|
+
result = api_instance.insert_conversation_department(department)
|
910
|
+
p result
|
911
|
+
rescue UltracartClient::ApiError => e
|
912
|
+
puts "Error when calling ConversationApi->insert_conversation_department: #{e}"
|
913
|
+
end
|
914
|
+
```
|
915
|
+
|
916
|
+
#### Using the insert_conversation_department_with_http_info variant
|
917
|
+
|
918
|
+
This returns an Array which contains the response data, status code and headers.
|
919
|
+
|
920
|
+
> <Array(<ConversationDepartmentResponse>, Integer, Hash)> insert_conversation_department_with_http_info(department)
|
921
|
+
|
922
|
+
```ruby
|
923
|
+
begin
|
924
|
+
# Insert a department
|
925
|
+
data, status_code, headers = api_instance.insert_conversation_department_with_http_info(department)
|
926
|
+
p status_code # => 2xx
|
927
|
+
p headers # => { ... }
|
928
|
+
p data # => <ConversationDepartmentResponse>
|
929
|
+
rescue UltracartClient::ApiError => e
|
930
|
+
puts "Error when calling ConversationApi->insert_conversation_department_with_http_info: #{e}"
|
931
|
+
end
|
932
|
+
```
|
933
|
+
|
934
|
+
### Parameters
|
935
|
+
|
936
|
+
| Name | Type | Description | Notes |
|
937
|
+
| ---- | ---- | ----------- | ----- |
|
938
|
+
| **department** | [**ConversationDepartment**](ConversationDepartment.md) | Department | |
|
939
|
+
|
940
|
+
### Return type
|
941
|
+
|
942
|
+
[**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
|
943
|
+
|
944
|
+
### Authorization
|
945
|
+
|
946
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
947
|
+
|
948
|
+
### HTTP request headers
|
949
|
+
|
950
|
+
- **Content-Type**: application/json
|
951
|
+
- **Accept**: application/json
|
952
|
+
|
953
|
+
|
954
|
+
## insert_conversation_engagement
|
955
|
+
|
956
|
+
> <ConversationEngagementResponse> insert_conversation_engagement(engagement)
|
957
|
+
|
958
|
+
Insert a engagement
|
959
|
+
|
960
|
+
Insert a engagement
|
961
|
+
|
962
|
+
### Examples
|
963
|
+
|
964
|
+
```ruby
|
965
|
+
require 'time'
|
966
|
+
require 'ultracart_api'
|
967
|
+
require 'json'
|
968
|
+
require 'yaml'
|
969
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
970
|
+
|
971
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
972
|
+
# As such, this might not be the best way to use this object.
|
973
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
974
|
+
|
975
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
976
|
+
engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
|
977
|
+
|
978
|
+
begin
|
979
|
+
# Insert a engagement
|
980
|
+
result = api_instance.insert_conversation_engagement(engagement)
|
981
|
+
p result
|
982
|
+
rescue UltracartClient::ApiError => e
|
983
|
+
puts "Error when calling ConversationApi->insert_conversation_engagement: #{e}"
|
984
|
+
end
|
985
|
+
```
|
986
|
+
|
987
|
+
#### Using the insert_conversation_engagement_with_http_info variant
|
988
|
+
|
989
|
+
This returns an Array which contains the response data, status code and headers.
|
990
|
+
|
991
|
+
> <Array(<ConversationEngagementResponse>, Integer, Hash)> insert_conversation_engagement_with_http_info(engagement)
|
992
|
+
|
993
|
+
```ruby
|
994
|
+
begin
|
995
|
+
# Insert a engagement
|
996
|
+
data, status_code, headers = api_instance.insert_conversation_engagement_with_http_info(engagement)
|
997
|
+
p status_code # => 2xx
|
998
|
+
p headers # => { ... }
|
999
|
+
p data # => <ConversationEngagementResponse>
|
1000
|
+
rescue UltracartClient::ApiError => e
|
1001
|
+
puts "Error when calling ConversationApi->insert_conversation_engagement_with_http_info: #{e}"
|
1002
|
+
end
|
1003
|
+
```
|
1004
|
+
|
1005
|
+
### Parameters
|
1006
|
+
|
1007
|
+
| Name | Type | Description | Notes |
|
1008
|
+
| ---- | ---- | ----------- | ----- |
|
1009
|
+
| **engagement** | [**ConversationEngagement**](ConversationEngagement.md) | Engagement | |
|
1010
|
+
|
1011
|
+
### Return type
|
1012
|
+
|
1013
|
+
[**ConversationEngagementResponse**](ConversationEngagementResponse.md)
|
1014
|
+
|
1015
|
+
### Authorization
|
1016
|
+
|
1017
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1018
|
+
|
1019
|
+
### HTTP request headers
|
1020
|
+
|
1021
|
+
- **Content-Type**: application/json
|
1022
|
+
- **Accept**: application/json
|
1023
|
+
|
1024
|
+
|
741
1025
|
## join_conversation
|
742
1026
|
|
743
|
-
> join_conversation(conversation_uuid)
|
1027
|
+
> join_conversation(conversation_uuid, opts)
|
744
1028
|
|
745
1029
|
Join a conversation
|
746
1030
|
|
@@ -761,10 +1045,13 @@ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/
|
|
761
1045
|
|
762
1046
|
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
763
1047
|
conversation_uuid = 'conversation_uuid_example' # String |
|
1048
|
+
opts = {
|
1049
|
+
join_request: UltracartClient::ConversationJoinRequest.new # ConversationJoinRequest | Join request
|
1050
|
+
}
|
764
1051
|
|
765
1052
|
begin
|
766
1053
|
# Join a conversation
|
767
|
-
api_instance.join_conversation(conversation_uuid)
|
1054
|
+
api_instance.join_conversation(conversation_uuid, opts)
|
768
1055
|
rescue UltracartClient::ApiError => e
|
769
1056
|
puts "Error when calling ConversationApi->join_conversation: #{e}"
|
770
1057
|
end
|
@@ -774,12 +1061,12 @@ end
|
|
774
1061
|
|
775
1062
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
776
1063
|
|
777
|
-
> <Array(nil, Integer, Hash)> join_conversation_with_http_info(conversation_uuid)
|
1064
|
+
> <Array(nil, Integer, Hash)> join_conversation_with_http_info(conversation_uuid, opts)
|
778
1065
|
|
779
1066
|
```ruby
|
780
1067
|
begin
|
781
1068
|
# Join a conversation
|
782
|
-
data, status_code, headers = api_instance.join_conversation_with_http_info(conversation_uuid)
|
1069
|
+
data, status_code, headers = api_instance.join_conversation_with_http_info(conversation_uuid, opts)
|
783
1070
|
p status_code # => 2xx
|
784
1071
|
p headers # => { ... }
|
785
1072
|
p data # => nil
|
@@ -793,6 +1080,7 @@ end
|
|
793
1080
|
| Name | Type | Description | Notes |
|
794
1081
|
| ---- | ---- | ----------- | ----- |
|
795
1082
|
| **conversation_uuid** | **String** | | |
|
1083
|
+
| **join_request** | [**ConversationJoinRequest**](ConversationJoinRequest.md) | Join request | [optional] |
|
796
1084
|
|
797
1085
|
### Return type
|
798
1086
|
|
@@ -804,7 +1092,7 @@ nil (empty response body)
|
|
804
1092
|
|
805
1093
|
### HTTP request headers
|
806
1094
|
|
807
|
-
- **Content-Type**:
|
1095
|
+
- **Content-Type**: application/json
|
808
1096
|
- **Accept**: application/json
|
809
1097
|
|
810
1098
|
|
@@ -1163,6 +1451,152 @@ end
|
|
1163
1451
|
- **Accept**: application/json
|
1164
1452
|
|
1165
1453
|
|
1454
|
+
## update_conversation_department
|
1455
|
+
|
1456
|
+
> <ConversationDepartmentResponse> update_conversation_department(conversation_department_oid, department)
|
1457
|
+
|
1458
|
+
Update a department
|
1459
|
+
|
1460
|
+
Update a department
|
1461
|
+
|
1462
|
+
### Examples
|
1463
|
+
|
1464
|
+
```ruby
|
1465
|
+
require 'time'
|
1466
|
+
require 'ultracart_api'
|
1467
|
+
require 'json'
|
1468
|
+
require 'yaml'
|
1469
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1470
|
+
|
1471
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1472
|
+
# As such, this might not be the best way to use this object.
|
1473
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1474
|
+
|
1475
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1476
|
+
conversation_department_oid = 56 # Integer |
|
1477
|
+
department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
|
1478
|
+
|
1479
|
+
begin
|
1480
|
+
# Update a department
|
1481
|
+
result = api_instance.update_conversation_department(conversation_department_oid, department)
|
1482
|
+
p result
|
1483
|
+
rescue UltracartClient::ApiError => e
|
1484
|
+
puts "Error when calling ConversationApi->update_conversation_department: #{e}"
|
1485
|
+
end
|
1486
|
+
```
|
1487
|
+
|
1488
|
+
#### Using the update_conversation_department_with_http_info variant
|
1489
|
+
|
1490
|
+
This returns an Array which contains the response data, status code and headers.
|
1491
|
+
|
1492
|
+
> <Array(<ConversationDepartmentResponse>, Integer, Hash)> update_conversation_department_with_http_info(conversation_department_oid, department)
|
1493
|
+
|
1494
|
+
```ruby
|
1495
|
+
begin
|
1496
|
+
# Update a department
|
1497
|
+
data, status_code, headers = api_instance.update_conversation_department_with_http_info(conversation_department_oid, department)
|
1498
|
+
p status_code # => 2xx
|
1499
|
+
p headers # => { ... }
|
1500
|
+
p data # => <ConversationDepartmentResponse>
|
1501
|
+
rescue UltracartClient::ApiError => e
|
1502
|
+
puts "Error when calling ConversationApi->update_conversation_department_with_http_info: #{e}"
|
1503
|
+
end
|
1504
|
+
```
|
1505
|
+
|
1506
|
+
### Parameters
|
1507
|
+
|
1508
|
+
| Name | Type | Description | Notes |
|
1509
|
+
| ---- | ---- | ----------- | ----- |
|
1510
|
+
| **conversation_department_oid** | **Integer** | | |
|
1511
|
+
| **department** | [**ConversationDepartment**](ConversationDepartment.md) | Department | |
|
1512
|
+
|
1513
|
+
### Return type
|
1514
|
+
|
1515
|
+
[**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
|
1516
|
+
|
1517
|
+
### Authorization
|
1518
|
+
|
1519
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1520
|
+
|
1521
|
+
### HTTP request headers
|
1522
|
+
|
1523
|
+
- **Content-Type**: application/json
|
1524
|
+
- **Accept**: application/json
|
1525
|
+
|
1526
|
+
|
1527
|
+
## update_conversation_engagement
|
1528
|
+
|
1529
|
+
> <ConversationEngagementResponse> update_conversation_engagement(conversation_engagement_oid, engagement)
|
1530
|
+
|
1531
|
+
Update a engagement
|
1532
|
+
|
1533
|
+
Update a engagement
|
1534
|
+
|
1535
|
+
### Examples
|
1536
|
+
|
1537
|
+
```ruby
|
1538
|
+
require 'time'
|
1539
|
+
require 'ultracart_api'
|
1540
|
+
require 'json'
|
1541
|
+
require 'yaml'
|
1542
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1543
|
+
|
1544
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1545
|
+
# As such, this might not be the best way to use this object.
|
1546
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1547
|
+
|
1548
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1549
|
+
conversation_engagement_oid = 56 # Integer |
|
1550
|
+
engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
|
1551
|
+
|
1552
|
+
begin
|
1553
|
+
# Update a engagement
|
1554
|
+
result = api_instance.update_conversation_engagement(conversation_engagement_oid, engagement)
|
1555
|
+
p result
|
1556
|
+
rescue UltracartClient::ApiError => e
|
1557
|
+
puts "Error when calling ConversationApi->update_conversation_engagement: #{e}"
|
1558
|
+
end
|
1559
|
+
```
|
1560
|
+
|
1561
|
+
#### Using the update_conversation_engagement_with_http_info variant
|
1562
|
+
|
1563
|
+
This returns an Array which contains the response data, status code and headers.
|
1564
|
+
|
1565
|
+
> <Array(<ConversationEngagementResponse>, Integer, Hash)> update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement)
|
1566
|
+
|
1567
|
+
```ruby
|
1568
|
+
begin
|
1569
|
+
# Update a engagement
|
1570
|
+
data, status_code, headers = api_instance.update_conversation_engagement_with_http_info(conversation_engagement_oid, engagement)
|
1571
|
+
p status_code # => 2xx
|
1572
|
+
p headers # => { ... }
|
1573
|
+
p data # => <ConversationEngagementResponse>
|
1574
|
+
rescue UltracartClient::ApiError => e
|
1575
|
+
puts "Error when calling ConversationApi->update_conversation_engagement_with_http_info: #{e}"
|
1576
|
+
end
|
1577
|
+
```
|
1578
|
+
|
1579
|
+
### Parameters
|
1580
|
+
|
1581
|
+
| Name | Type | Description | Notes |
|
1582
|
+
| ---- | ---- | ----------- | ----- |
|
1583
|
+
| **conversation_engagement_oid** | **Integer** | | |
|
1584
|
+
| **engagement** | [**ConversationEngagement**](ConversationEngagement.md) | Engagement | |
|
1585
|
+
|
1586
|
+
### Return type
|
1587
|
+
|
1588
|
+
[**ConversationEngagementResponse**](ConversationEngagementResponse.md)
|
1589
|
+
|
1590
|
+
### Authorization
|
1591
|
+
|
1592
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1593
|
+
|
1594
|
+
### HTTP request headers
|
1595
|
+
|
1596
|
+
- **Content-Type**: application/json
|
1597
|
+
- **Accept**: application/json
|
1598
|
+
|
1599
|
+
|
1166
1600
|
## update_conversation_webchat_queue_status
|
1167
1601
|
|
1168
1602
|
> update_conversation_webchat_queue_status(queue_name, status_request)
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **canned_message** | **String** | | [optional] |
|
8
8
|
| **conversation_canned_message_oid** | **Integer** | | [optional] |
|
9
|
-
| **
|
9
|
+
| **conversation_department_oids** | **Array<Integer>** | | [optional] |
|
10
10
|
| **short_code** | **String** | | [optional] |
|
11
11
|
|
12
12
|
## Example
|
@@ -17,7 +17,7 @@ require 'ultracart_api'
|
|
17
17
|
instance = UltracartClient::ConversationCannedMessage.new(
|
18
18
|
canned_message: null,
|
19
19
|
conversation_canned_message_oid: null,
|
20
|
-
|
20
|
+
conversation_department_oids: null,
|
21
21
|
short_code: null
|
22
22
|
)
|
23
23
|
```
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::ConversationDepartment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conversation_department_oid** | **Integer** | | [optional] |
|
8
|
+
| **delete_me** | **Boolean** | | [optional] |
|
9
|
+
| **department_name** | **String** | | [optional] |
|
10
|
+
| **merchant_id** | **String** | | [optional] |
|
11
|
+
| **settings** | **Object** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::ConversationDepartment.new(
|
19
|
+
conversation_department_oid: null,
|
20
|
+
delete_me: null,
|
21
|
+
department_name: null,
|
22
|
+
merchant_id: null,
|
23
|
+
settings: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|