ultracart_api 3.10.79 → 3.10.80

Sign up to get free protection for your applications and to get access to all the features.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +20 -4
  3. data/docs/ConversationApi.md +308 -2
  4. data/docs/ConversationCannedMessage.md +1 -1
  5. data/docs/ConversationDepartment.md +12 -0
  6. data/docs/ConversationDepartmentResponse.md +12 -0
  7. data/docs/ConversationDepartmentSettings.md +7 -0
  8. data/docs/ConversationDepartmentsResponse.md +12 -0
  9. data/docs/ConversationEngagement.md +14 -0
  10. data/docs/ConversationEngagementEquation.md +7 -0
  11. data/docs/ConversationEngagementResponse.md +12 -0
  12. data/docs/ConversationEngagementsResponse.md +12 -0
  13. data/docs/ConversationJoinRequest.md +8 -0
  14. data/docs/ConversationParticipant.md +2 -0
  15. data/docs/ConversationWebchatQueueStatusQueueEntry.md +1 -0
  16. data/lib/ultracart_api/api/conversation_api.rb +333 -1
  17. data/lib/ultracart_api/models/conversation_canned_message.rb +1 -1
  18. data/lib/ultracart_api/models/conversation_department.rb +220 -0
  19. data/lib/ultracart_api/models/conversation_department_response.rb +221 -0
  20. data/lib/ultracart_api/models/conversation_department_settings.rb +175 -0
  21. data/lib/ultracart_api/models/conversation_departments_response.rb +223 -0
  22. data/lib/ultracart_api/models/conversation_engagement.rb +240 -0
  23. data/lib/ultracart_api/models/conversation_engagement_equation.rb +175 -0
  24. data/lib/ultracart_api/models/conversation_engagement_response.rb +221 -0
  25. data/lib/ultracart_api/models/conversation_engagements_response.rb +223 -0
  26. data/lib/ultracart_api/models/conversation_join_request.rb +184 -0
  27. data/lib/ultracart_api/models/conversation_participant.rb +19 -1
  28. data/lib/ultracart_api/models/conversation_webchat_queue_status_queue_entry.rb +10 -1
  29. data/lib/ultracart_api/version.rb +1 -1
  30. data/lib/ultracart_api.rb +9 -0
  31. metadata +20 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4f1b06246610265119d5f2c024c15f2ed7990269ba30d41c48a21b1501b3e712
4
- data.tar.gz: 6982b8c9c64cf0229e7bf41b4601e3901f32af9cb8c87d8ff851807d32a55913
3
+ metadata.gz: 2b6a4f696143d6c4b507ba947b4546b37a161906814a0907c6eebf351ff1f71d
4
+ data.tar.gz: 19662799cfbf6a3850df1d3493a296d9ed11538d82e1dbb6e41d75c3980b6423
5
5
  SHA512:
6
- metadata.gz: f54d96485071188f8169164e15419e2d46b615ef074c0c5247439c8877b2fe70ac651ec83d9e8f467bf3069a03b5247b93f93a04f3c68501b841e438042611c6
7
- data.tar.gz: c8520b58a27a96d3e2a8b747492e43ebaecbcfe3f89f2707680f3428535999632f8e4bf0e0da0ba3e976551721ee1225a4acfe06cc286ae5a9f04ea23e2808a6
6
+ metadata.gz: 8a31b0c962791a1220f043729e5f0d70820118c1c8e142db6916604e5387bd0c0b113036686942959a7d17669e3c7424bf17bf5944a6283489f935c2a4cf694f
7
+ data.tar.gz: 8421b0a573e868534462320dafda3dcaecb8bc9e3f6dad03c2e427e759be3b91de676c4bfb40460d3d51b29168300acda10ff9485d1b05d26a1a66e0f50a0f33
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.79
10
+ - Package version: 3.10.80
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.79.gem
27
+ gem install ./ultracart_api-3.10.80.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.10.79.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.10.80.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.79'
35
+ gem 'ultracart_api', '~> 3.10.80'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -130,17 +130,23 @@ Class | Method | HTTP request | Description
130
130
  *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
131
131
  *UltracartClient::ConversationApi* | [**get_conversation_canned_messages**](docs/ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
132
132
  *UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
133
+ *UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
134
+ *UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
133
135
  *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
134
136
  *UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
135
137
  *UltracartClient::ConversationApi* | [**get_conversation_webchat_queue_statuses**](docs/ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
136
138
  *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
137
139
  *UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
140
+ *UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
141
+ *UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
138
142
  *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
139
143
  *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
140
144
  *UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
141
145
  *UltracartClient::ConversationApi* | [**search_conversation_canned_messages**](docs/ConversationApi.md#search_conversation_canned_messages) | **POST** /conversation/canned_messages/search | Search for canned messages by short_code
142
146
  *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
143
147
  *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
148
+ *UltracartClient::ConversationApi* | [**update_conversation_department**](docs/ConversationApi.md#update_conversation_department) | **PUT** /conversation/departments/{conversation_department_oid} | Update a department
149
+ *UltracartClient::ConversationApi* | [**update_conversation_engagement**](docs/ConversationApi.md#update_conversation_engagement) | **PUT** /conversation/engagements/{conversation_engagement_oid} | Update a engagement
144
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
145
151
  *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
146
152
  *UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
@@ -593,6 +599,14 @@ Class | Method | HTTP request | Description
593
599
  - [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
594
600
  - [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
595
601
  - [UltracartClient::ConversationCannedMessagesSearch](docs/ConversationCannedMessagesSearch.md)
602
+ - [UltracartClient::ConversationDepartment](docs/ConversationDepartment.md)
603
+ - [UltracartClient::ConversationDepartmentResponse](docs/ConversationDepartmentResponse.md)
604
+ - [UltracartClient::ConversationDepartmentSettings](docs/ConversationDepartmentSettings.md)
605
+ - [UltracartClient::ConversationDepartmentsResponse](docs/ConversationDepartmentsResponse.md)
606
+ - [UltracartClient::ConversationEngagement](docs/ConversationEngagement.md)
607
+ - [UltracartClient::ConversationEngagementEquation](docs/ConversationEngagementEquation.md)
608
+ - [UltracartClient::ConversationEngagementResponse](docs/ConversationEngagementResponse.md)
609
+ - [UltracartClient::ConversationEngagementsResponse](docs/ConversationEngagementsResponse.md)
596
610
  - [UltracartClient::ConversationEventAddCoupon](docs/ConversationEventAddCoupon.md)
597
611
  - [UltracartClient::ConversationEventAddItem](docs/ConversationEventAddItem.md)
598
612
  - [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
@@ -600,6 +614,7 @@ Class | Method | HTTP request | Description
600
614
  - [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
601
615
  - [UltracartClient::ConversationEventTyping](docs/ConversationEventTyping.md)
602
616
  - [UltracartClient::ConversationEventWebchatContext](docs/ConversationEventWebchatContext.md)
617
+ - [UltracartClient::ConversationJoinRequest](docs/ConversationJoinRequest.md)
603
618
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
604
619
  - [UltracartClient::ConversationMessageTranslation](docs/ConversationMessageTranslation.md)
605
620
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
@@ -1236,6 +1251,7 @@ Not every change is committed to every SDK.
1236
1251
 
1237
1252
  | Version | Date | Comments |
1238
1253
  | --: | :-: | --- |
1254
+ | 3.10.80 | 12/13/2022 | conversations - add email and sms_phone to participant object |
1239
1255
  | 3.10.79 | 12/09/2022 | conversations - message translation |
1240
1256
  | 3.10.78 | 12/08/2022 | conversation canned messages |
1241
1257
  | 3.10.77 | 12/08/2022 | communications - expose the rebuild percentage |
@@ -9,17 +9,23 @@ Method | HTTP request | Description
9
9
  [**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
10
10
  [**get_conversation_canned_messages**](ConversationApi.md#get_conversation_canned_messages) | **GET** /conversation/canned_messages | Retrieve a list of canned messages ordered by short_code
11
11
  [**get_conversation_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
12
+ [**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
13
+ [**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
12
14
  [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
13
15
  [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
14
16
  [**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses
15
17
  [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
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
 
@@ -261,6 +267,96 @@ Name | Type | Description | Notes
261
267
 
262
268
 
263
269
 
270
+ # **get_conversation_departments**
271
+ > ConversationDepartmentsResponse get_conversation_departments
272
+
273
+ Retrieve a list of departments ordered by name
274
+
275
+ Retrieve a list of departments ordered by name
276
+
277
+ ### Example
278
+ ```ruby
279
+ # load the gem
280
+ require 'ultracart_api'
281
+
282
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
283
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
284
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
285
+
286
+
287
+
288
+ begin
289
+ #Retrieve a list of departments ordered by name
290
+ result = api_instance.get_conversation_departments
291
+ p result
292
+ rescue UltracartClient::ApiError => e
293
+ puts "Exception when calling ConversationApi->get_conversation_departments: #{e}"
294
+ end
295
+ ```
296
+
297
+ ### Parameters
298
+ This endpoint does not need any parameter.
299
+
300
+ ### Return type
301
+
302
+ [**ConversationDepartmentsResponse**](ConversationDepartmentsResponse.md)
303
+
304
+ ### Authorization
305
+
306
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
307
+
308
+ ### HTTP request headers
309
+
310
+ - **Content-Type**: application/json
311
+ - **Accept**: application/json
312
+
313
+
314
+
315
+ # **get_conversation_engagements**
316
+ > ConversationEngagementsResponse get_conversation_engagements
317
+
318
+ Retrieve a list of engagements ordered by name
319
+
320
+ Retrieve a list of engagements ordered by name
321
+
322
+ ### Example
323
+ ```ruby
324
+ # load the gem
325
+ require 'ultracart_api'
326
+
327
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
328
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
329
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
330
+
331
+
332
+
333
+ begin
334
+ #Retrieve a list of engagements ordered by name
335
+ result = api_instance.get_conversation_engagements
336
+ p result
337
+ rescue UltracartClient::ApiError => e
338
+ puts "Exception when calling ConversationApi->get_conversation_engagements: #{e}"
339
+ end
340
+ ```
341
+
342
+ ### Parameters
343
+ This endpoint does not need any parameter.
344
+
345
+ ### Return type
346
+
347
+ [**ConversationEngagementsResponse**](ConversationEngagementsResponse.md)
348
+
349
+ ### Authorization
350
+
351
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
352
+
353
+ ### HTTP request headers
354
+
355
+ - **Content-Type**: application/json
356
+ - **Accept**: application/json
357
+
358
+
359
+
264
360
  # **get_conversation_messages**
265
361
  > ConversationMessagesResponse get_conversation_messages(conversation_uuid, since, opts)
266
362
 
@@ -520,8 +616,108 @@ Name | Type | Description | Notes
520
616
 
521
617
 
522
618
 
619
+ # **insert_conversation_department**
620
+ > ConversationDepartmentResponse insert_conversation_department(department)
621
+
622
+ Insert a department
623
+
624
+ Insert a department
625
+
626
+ ### Example
627
+ ```ruby
628
+ # load the gem
629
+ require 'ultracart_api'
630
+
631
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
632
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
633
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
634
+
635
+
636
+ department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
637
+
638
+
639
+ begin
640
+ #Insert a department
641
+ result = api_instance.insert_conversation_department(department)
642
+ p result
643
+ rescue UltracartClient::ApiError => e
644
+ puts "Exception when calling ConversationApi->insert_conversation_department: #{e}"
645
+ end
646
+ ```
647
+
648
+ ### Parameters
649
+
650
+ Name | Type | Description | Notes
651
+ ------------- | ------------- | ------------- | -------------
652
+ **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
653
+
654
+ ### Return type
655
+
656
+ [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
657
+
658
+ ### Authorization
659
+
660
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
661
+
662
+ ### HTTP request headers
663
+
664
+ - **Content-Type**: application/json
665
+ - **Accept**: application/json
666
+
667
+
668
+
669
+ # **insert_conversation_engagement**
670
+ > ConversationEngagementResponse insert_conversation_engagement(engagement)
671
+
672
+ Insert a engagement
673
+
674
+ Insert a engagement
675
+
676
+ ### Example
677
+ ```ruby
678
+ # load the gem
679
+ require 'ultracart_api'
680
+
681
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
682
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
683
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
684
+
685
+
686
+ engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
687
+
688
+
689
+ begin
690
+ #Insert a engagement
691
+ result = api_instance.insert_conversation_engagement(engagement)
692
+ p result
693
+ rescue UltracartClient::ApiError => e
694
+ puts "Exception when calling ConversationApi->insert_conversation_engagement: #{e}"
695
+ end
696
+ ```
697
+
698
+ ### Parameters
699
+
700
+ Name | Type | Description | Notes
701
+ ------------- | ------------- | ------------- | -------------
702
+ **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
703
+
704
+ ### Return type
705
+
706
+ [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
707
+
708
+ ### Authorization
709
+
710
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
711
+
712
+ ### HTTP request headers
713
+
714
+ - **Content-Type**: application/json
715
+ - **Accept**: application/json
716
+
717
+
718
+
523
719
  # **join_conversation**
524
- > join_conversation(conversation_uuid)
720
+ > join_conversation(conversation_uuid, opts)
525
721
 
526
722
  Join a conversation
527
723
 
@@ -539,10 +735,13 @@ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, fa
539
735
 
540
736
  conversation_uuid = 'conversation_uuid_example' # String |
541
737
 
738
+ opts = {
739
+ join_request: UltracartClient::ConversationJoinRequest.new # ConversationJoinRequest | Join request
740
+ }
542
741
 
543
742
  begin
544
743
  #Join a conversation
545
- api_instance.join_conversation(conversation_uuid)
744
+ api_instance.join_conversation(conversation_uuid, opts)
546
745
  rescue UltracartClient::ApiError => e
547
746
  puts "Exception when calling ConversationApi->join_conversation: #{e}"
548
747
  end
@@ -553,6 +752,7 @@ end
553
752
  Name | Type | Description | Notes
554
753
  ------------- | ------------- | ------------- | -------------
555
754
  **conversation_uuid** | **String**| |
755
+ **join_request** | [**ConversationJoinRequest**](ConversationJoinRequest.md)| Join request | [optional]
556
756
 
557
757
  ### Return type
558
758
 
@@ -820,6 +1020,112 @@ Name | Type | Description | Notes
820
1020
 
821
1021
 
822
1022
 
1023
+ # **update_conversation_department**
1024
+ > ConversationDepartmentResponse update_conversation_department(conversation_department_oid, department)
1025
+
1026
+ Update a department
1027
+
1028
+ Update a department
1029
+
1030
+ ### Example
1031
+ ```ruby
1032
+ # load the gem
1033
+ require 'ultracart_api'
1034
+
1035
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1036
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1037
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1038
+
1039
+
1040
+ conversation_department_oid = 56 # Integer |
1041
+
1042
+ department = UltracartClient::ConversationDepartment.new # ConversationDepartment | Department
1043
+
1044
+
1045
+ begin
1046
+ #Update a department
1047
+ result = api_instance.update_conversation_department(conversation_department_oid, department)
1048
+ p result
1049
+ rescue UltracartClient::ApiError => e
1050
+ puts "Exception when calling ConversationApi->update_conversation_department: #{e}"
1051
+ end
1052
+ ```
1053
+
1054
+ ### Parameters
1055
+
1056
+ Name | Type | Description | Notes
1057
+ ------------- | ------------- | ------------- | -------------
1058
+ **conversation_department_oid** | **Integer**| |
1059
+ **department** | [**ConversationDepartment**](ConversationDepartment.md)| Department |
1060
+
1061
+ ### Return type
1062
+
1063
+ [**ConversationDepartmentResponse**](ConversationDepartmentResponse.md)
1064
+
1065
+ ### Authorization
1066
+
1067
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1068
+
1069
+ ### HTTP request headers
1070
+
1071
+ - **Content-Type**: application/json
1072
+ - **Accept**: application/json
1073
+
1074
+
1075
+
1076
+ # **update_conversation_engagement**
1077
+ > ConversationEngagementResponse update_conversation_engagement(conversation_engagement_oid, engagement)
1078
+
1079
+ Update a engagement
1080
+
1081
+ Update a engagement
1082
+
1083
+ ### Example
1084
+ ```ruby
1085
+ # load the gem
1086
+ require 'ultracart_api'
1087
+
1088
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1089
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1090
+ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
1091
+
1092
+
1093
+ conversation_engagement_oid = 56 # Integer |
1094
+
1095
+ engagement = UltracartClient::ConversationEngagement.new # ConversationEngagement | Engagement
1096
+
1097
+
1098
+ begin
1099
+ #Update a engagement
1100
+ result = api_instance.update_conversation_engagement(conversation_engagement_oid, engagement)
1101
+ p result
1102
+ rescue UltracartClient::ApiError => e
1103
+ puts "Exception when calling ConversationApi->update_conversation_engagement: #{e}"
1104
+ end
1105
+ ```
1106
+
1107
+ ### Parameters
1108
+
1109
+ Name | Type | Description | Notes
1110
+ ------------- | ------------- | ------------- | -------------
1111
+ **conversation_engagement_oid** | **Integer**| |
1112
+ **engagement** | [**ConversationEngagement**](ConversationEngagement.md)| Engagement |
1113
+
1114
+ ### Return type
1115
+
1116
+ [**ConversationEngagementResponse**](ConversationEngagementResponse.md)
1117
+
1118
+ ### Authorization
1119
+
1120
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1121
+
1122
+ ### HTTP request headers
1123
+
1124
+ - **Content-Type**: application/json
1125
+ - **Accept**: application/json
1126
+
1127
+
1128
+
823
1129
  # **update_conversation_webchat_queue_status**
824
1130
  > update_conversation_webchat_queue_status(queue_name, status_request)
825
1131
 
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **canned_message** | **String** | | [optional]
7
7
  **conversation_canned_message_oid** | **Integer** | | [optional]
8
- **conversation_department_oids** | **Array<String>** | | [optional]
8
+ **conversation_department_oids** | **Array<Integer>** | | [optional]
9
9
  **short_code** | **String** | | [optional]
10
10
 
11
11
 
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationDepartment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **conversation_department_oid** | **Integer** | | [optional]
7
+ **delete_me** | **BOOLEAN** | | [optional]
8
+ **department_name** | **String** | | [optional]
9
+ **merchant_id** | **String** | | [optional]
10
+ **settings** | [**ConversationDepartmentSettings**](ConversationDepartmentSettings.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationDepartmentResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **conversation_department** | [**ConversationDepartment**](ConversationDepartment.md) | | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,7 @@
1
+ # UltracartClient::ConversationDepartmentSettings
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
7
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationDepartmentsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **conversation_departments** | [**Array<ConversationDepartment>**](ConversationDepartment.md) | | [optional]
7
+ **error** | [**Error**](Error.md) | | [optional]
8
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,14 @@
1
+ # UltracartClient::ConversationEngagement
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **conversation_engagement_oid** | **Integer** | | [optional]
7
+ **customer_greeting** | **String** | | [optional]
8
+ **department_oids** | **Array<Integer>** | | [optional]
9
+ **engagement_name** | **String** | | [optional]
10
+ **equation** | [**ConversationEngagementEquation**](ConversationEngagementEquation.md) | | [optional]
11
+ **time_on_page** | **Integer** | | [optional]
12
+ **visitor_type** | **String** | | [optional]
13
+
14
+
@@ -0,0 +1,7 @@
1
+ # UltracartClient::ConversationEngagementEquation
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
7
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ConversationEngagementResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **conversation_engagement** | [**ConversationEngagement**](ConversationEngagement.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::ConversationEngagementsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **conversation_engagements** | [**Array<ConversationEngagement>**](ConversationEngagement.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,8 @@
1
+ # UltracartClient::ConversationJoinRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **participant_language_iso_code** | **String** | | [optional]
7
+
8
+
@@ -6,11 +6,13 @@ Name | Type | Description | Notes
6
6
  **conversation_participant_arn** | **String** | | [optional]
7
7
  **conversation_participant_name** | **String** | | [optional]
8
8
  **conversation_participant_uuid** | **String** | | [optional]
9
+ **email** | **String** | | [optional]
9
10
  **joined_dts** | **String** | Joined conversation date/time | [optional]
10
11
  **language_iso_code** | **String** | | [optional]
11
12
  **last_message_dts** | **String** | Last message date/time | [optional]
12
13
  **left_dts** | **String** | Left conversation date/time | [optional]
13
14
  **profile_image_url** | **String** | | [optional]
15
+ **sms_phone_number** | **String** | | [optional]
14
16
  **status** | **String** | | [optional]
15
17
  **timezone** | **String** | | [optional]
16
18
  **unread_messages** | **Integer** | | [optional]
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
8
8
  **conversation_webchat_queue_uuid** | **String** | | [optional]
9
9
  **email** | **String** | | [optional]
10
10
  **join_dts** | **String** | Date/time the customer joined the queue | [optional]
11
+ **participant_language_iso_code** | **String** | | [optional]
11
12
  **question** | **String** | | [optional]
12
13
 
13
14