ultracart_api 4.0.97.rc → 4.0.99.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 +144 -0
- data/docs/ConversationAutocompleteRequest.md +20 -0
- data/docs/ConversationAutocompleteResponse.md +30 -0
- data/docs/ConversationAutocompleteValue.md +20 -0
- data/docs/ConversationSearchRequest.md +40 -0
- data/docs/ConversationSearchResponse.md +22 -0
- data/lib/ultracart_api/api/conversation_api.rb +138 -0
- data/lib/ultracart_api/models/conversation_autocomplete_request.rb +228 -0
- data/lib/ultracart_api/models/conversation_autocomplete_response.rb +276 -0
- data/lib/ultracart_api/models/conversation_autocomplete_value.rb +228 -0
- data/lib/ultracart_api/models/conversation_search_request.rb +320 -0
- data/lib/ultracart_api/models/conversation_search_response.rb +237 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a804dd2ab329cf54941436d968e7c1f530e1f2cc3707c346cb1fb66f017c072c
|
4
|
+
data.tar.gz: 6eb5984033165cf26cea8e5f2bbdbe3aea611ace052c84c53483681d3383634c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3a328e1e9ce59f8312f6bc0493da67eeb702545d2de8e375550b04717dbae15e73a34a6140e1251a96d10e71d883e42035ca948e9c601e26eca3fc3a4dfc4f28
|
7
|
+
data.tar.gz: f6fc39d982342451ad265ede657fb873ef7e02f9baa39e35bc84f1504b13cb276adde51c428a805bd286116a8ed84e1a8d349993d1ea6dc629f05a1928d74668
|
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.99.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.99.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.99.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.99.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -142,6 +142,8 @@ Class | Method | HTTP request | Description
|
|
142
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
|
143
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
|
144
144
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
145
|
+
*UltracartClient::ConversationApi* | [**get_conversations_autocomplete**](docs/ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field
|
146
|
+
*UltracartClient::ConversationApi* | [**get_conversations_search**](docs/ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations
|
145
147
|
*UltracartClient::ConversationApi* | [**insert_conversation_canned_message**](docs/ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message
|
146
148
|
*UltracartClient::ConversationApi* | [**insert_conversation_department**](docs/ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department
|
147
149
|
*UltracartClient::ConversationApi* | [**insert_conversation_engagement**](docs/ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement
|
@@ -601,6 +603,9 @@ Class | Method | HTTP request | Description
|
|
601
603
|
- [UltracartClient::Conversation](docs/Conversation.md)
|
602
604
|
- [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
|
603
605
|
- [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
|
606
|
+
- [UltracartClient::ConversationAutocompleteRequest](docs/ConversationAutocompleteRequest.md)
|
607
|
+
- [UltracartClient::ConversationAutocompleteResponse](docs/ConversationAutocompleteResponse.md)
|
608
|
+
- [UltracartClient::ConversationAutocompleteValue](docs/ConversationAutocompleteValue.md)
|
604
609
|
- [UltracartClient::ConversationCannedMessage](docs/ConversationCannedMessage.md)
|
605
610
|
- [UltracartClient::ConversationCannedMessageResponse](docs/ConversationCannedMessageResponse.md)
|
606
611
|
- [UltracartClient::ConversationCannedMessagesResponse](docs/ConversationCannedMessagesResponse.md)
|
@@ -627,6 +632,8 @@ Class | Method | HTTP request | Description
|
|
627
632
|
- [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
|
628
633
|
- [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
|
629
634
|
- [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
|
635
|
+
- [UltracartClient::ConversationSearchRequest](docs/ConversationSearchRequest.md)
|
636
|
+
- [UltracartClient::ConversationSearchResponse](docs/ConversationSearchResponse.md)
|
630
637
|
- [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
|
631
638
|
- [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
|
632
639
|
- [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
|
@@ -1258,6 +1265,8 @@ Not every change is committed to every SDK.
|
|
1258
1265
|
|
1259
1266
|
| Version | Date | Comments |
|
1260
1267
|
| --: | :-: | --- |
|
1268
|
+
| 4.0.99-RC | 12/15/2022 | conversation search - added start date filtering |
|
1269
|
+
| 4.0.98-RC | 12/15/2022 | conversation searching |
|
1261
1270
|
| 4.0.97-RC | 12/13/2022 | conversations - add email and sms_phone to participant object |
|
1262
1271
|
| 4.0.96-RC | 12/09/2022 | conversations - message translation |
|
1263
1272
|
| 4.0.95-RC | 12/08/2022 | conversation canned messages |
|
data/docs/ConversationApi.md
CHANGED
@@ -15,6 +15,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
15
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 |
|
16
16
|
| [**get_conversation_webchat_queue_statuses**](ConversationApi.md#get_conversation_webchat_queue_statuses) | **GET** /conversation/conversations/queues/statuses | Retrieve a conversation webchat queue statuses |
|
17
17
|
| [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest |
|
18
|
+
| [**get_conversations_autocomplete**](ConversationApi.md#get_conversations_autocomplete) | **POST** /conversation/conversations/autocomplete | Retrieve a list of matching terms for a search field |
|
19
|
+
| [**get_conversations_search**](ConversationApi.md#get_conversations_search) | **POST** /conversation/conversations/search | Search conversations |
|
18
20
|
| [**insert_conversation_canned_message**](ConversationApi.md#insert_conversation_canned_message) | **POST** /conversation/canned_messages | Insert a canned message |
|
19
21
|
| [**insert_conversation_department**](ConversationApi.md#insert_conversation_department) | **POST** /conversation/departments | Insert a department |
|
20
22
|
| [**insert_conversation_engagement**](ConversationApi.md#insert_conversation_engagement) | **POST** /conversation/engagements | Insert a engagement |
|
@@ -809,6 +811,148 @@ end
|
|
809
811
|
- **Accept**: application/json
|
810
812
|
|
811
813
|
|
814
|
+
## get_conversations_autocomplete
|
815
|
+
|
816
|
+
> <ConversationAutocompleteResponse> get_conversations_autocomplete(autocomplete_request)
|
817
|
+
|
818
|
+
Retrieve a list of matching terms for a search field
|
819
|
+
|
820
|
+
Retrieve a list of matching terms for a search field
|
821
|
+
|
822
|
+
### Examples
|
823
|
+
|
824
|
+
```ruby
|
825
|
+
require 'time'
|
826
|
+
require 'ultracart_api'
|
827
|
+
require 'json'
|
828
|
+
require 'yaml'
|
829
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
830
|
+
|
831
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
832
|
+
# As such, this might not be the best way to use this object.
|
833
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
834
|
+
|
835
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
836
|
+
autocomplete_request = UltracartClient::ConversationAutocompleteRequest.new # ConversationAutocompleteRequest | Autocomplete Request
|
837
|
+
|
838
|
+
begin
|
839
|
+
# Retrieve a list of matching terms for a search field
|
840
|
+
result = api_instance.get_conversations_autocomplete(autocomplete_request)
|
841
|
+
p result
|
842
|
+
rescue UltracartClient::ApiError => e
|
843
|
+
puts "Error when calling ConversationApi->get_conversations_autocomplete: #{e}"
|
844
|
+
end
|
845
|
+
```
|
846
|
+
|
847
|
+
#### Using the get_conversations_autocomplete_with_http_info variant
|
848
|
+
|
849
|
+
This returns an Array which contains the response data, status code and headers.
|
850
|
+
|
851
|
+
> <Array(<ConversationAutocompleteResponse>, Integer, Hash)> get_conversations_autocomplete_with_http_info(autocomplete_request)
|
852
|
+
|
853
|
+
```ruby
|
854
|
+
begin
|
855
|
+
# Retrieve a list of matching terms for a search field
|
856
|
+
data, status_code, headers = api_instance.get_conversations_autocomplete_with_http_info(autocomplete_request)
|
857
|
+
p status_code # => 2xx
|
858
|
+
p headers # => { ... }
|
859
|
+
p data # => <ConversationAutocompleteResponse>
|
860
|
+
rescue UltracartClient::ApiError => e
|
861
|
+
puts "Error when calling ConversationApi->get_conversations_autocomplete_with_http_info: #{e}"
|
862
|
+
end
|
863
|
+
```
|
864
|
+
|
865
|
+
### Parameters
|
866
|
+
|
867
|
+
| Name | Type | Description | Notes |
|
868
|
+
| ---- | ---- | ----------- | ----- |
|
869
|
+
| **autocomplete_request** | [**ConversationAutocompleteRequest**](ConversationAutocompleteRequest.md) | Autocomplete Request | |
|
870
|
+
|
871
|
+
### Return type
|
872
|
+
|
873
|
+
[**ConversationAutocompleteResponse**](ConversationAutocompleteResponse.md)
|
874
|
+
|
875
|
+
### Authorization
|
876
|
+
|
877
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
878
|
+
|
879
|
+
### HTTP request headers
|
880
|
+
|
881
|
+
- **Content-Type**: application/json
|
882
|
+
- **Accept**: application/json
|
883
|
+
|
884
|
+
|
885
|
+
## get_conversations_search
|
886
|
+
|
887
|
+
> <ConversationSearchResponse> get_conversations_search(search_request)
|
888
|
+
|
889
|
+
Search conversations
|
890
|
+
|
891
|
+
Search conversations
|
892
|
+
|
893
|
+
### Examples
|
894
|
+
|
895
|
+
```ruby
|
896
|
+
require 'time'
|
897
|
+
require 'ultracart_api'
|
898
|
+
require 'json'
|
899
|
+
require 'yaml'
|
900
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
901
|
+
|
902
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
903
|
+
# As such, this might not be the best way to use this object.
|
904
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
905
|
+
|
906
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
907
|
+
search_request = UltracartClient::ConversationSearchRequest.new # ConversationSearchRequest | Search Request
|
908
|
+
|
909
|
+
begin
|
910
|
+
# Search conversations
|
911
|
+
result = api_instance.get_conversations_search(search_request)
|
912
|
+
p result
|
913
|
+
rescue UltracartClient::ApiError => e
|
914
|
+
puts "Error when calling ConversationApi->get_conversations_search: #{e}"
|
915
|
+
end
|
916
|
+
```
|
917
|
+
|
918
|
+
#### Using the get_conversations_search_with_http_info variant
|
919
|
+
|
920
|
+
This returns an Array which contains the response data, status code and headers.
|
921
|
+
|
922
|
+
> <Array(<ConversationSearchResponse>, Integer, Hash)> get_conversations_search_with_http_info(search_request)
|
923
|
+
|
924
|
+
```ruby
|
925
|
+
begin
|
926
|
+
# Search conversations
|
927
|
+
data, status_code, headers = api_instance.get_conversations_search_with_http_info(search_request)
|
928
|
+
p status_code # => 2xx
|
929
|
+
p headers # => { ... }
|
930
|
+
p data # => <ConversationSearchResponse>
|
931
|
+
rescue UltracartClient::ApiError => e
|
932
|
+
puts "Error when calling ConversationApi->get_conversations_search_with_http_info: #{e}"
|
933
|
+
end
|
934
|
+
```
|
935
|
+
|
936
|
+
### Parameters
|
937
|
+
|
938
|
+
| Name | Type | Description | Notes |
|
939
|
+
| ---- | ---- | ----------- | ----- |
|
940
|
+
| **search_request** | [**ConversationSearchRequest**](ConversationSearchRequest.md) | Search Request | |
|
941
|
+
|
942
|
+
### Return type
|
943
|
+
|
944
|
+
[**ConversationSearchResponse**](ConversationSearchResponse.md)
|
945
|
+
|
946
|
+
### Authorization
|
947
|
+
|
948
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
949
|
+
|
950
|
+
### HTTP request headers
|
951
|
+
|
952
|
+
- **Content-Type**: application/json
|
953
|
+
- **Accept**: application/json
|
954
|
+
|
955
|
+
|
812
956
|
## insert_conversation_canned_message
|
813
957
|
|
814
958
|
> <ConversationCannedMessageResponse> insert_conversation_canned_message(canned_message)
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::ConversationAutocompleteRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **field** | **String** | | [optional] |
|
8
|
+
| **term** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::ConversationAutocompleteRequest.new(
|
16
|
+
field: null,
|
17
|
+
term: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# UltracartClient::ConversationAutocompleteResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **field** | **String** | | [optional] |
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
10
|
+
| **results** | [**Array<ConversationAutocompleteValue>**](ConversationAutocompleteValue.md) | | [optional] |
|
11
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
12
|
+
| **term** | **String** | | [optional] |
|
13
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ultracart_api'
|
19
|
+
|
20
|
+
instance = UltracartClient::ConversationAutocompleteResponse.new(
|
21
|
+
error: null,
|
22
|
+
field: null,
|
23
|
+
metadata: null,
|
24
|
+
results: null,
|
25
|
+
success: null,
|
26
|
+
term: null,
|
27
|
+
warning: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::ConversationAutocompleteValue
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **description** | **String** | | [optional] |
|
8
|
+
| **value** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::ConversationAutocompleteValue.new(
|
16
|
+
description: null,
|
17
|
+
value: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# UltracartClient::ConversationSearchRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **date_end** | **String** | End of the range | [optional] |
|
8
|
+
| **date_start** | **String** | Start of the range | [optional] |
|
9
|
+
| **email_filter** | **String** | | [optional] |
|
10
|
+
| **language_filter** | **String** | | [optional] |
|
11
|
+
| **medium_filter** | **String** | | [optional] |
|
12
|
+
| **order_by_newest** | **Boolean** | | [optional] |
|
13
|
+
| **order_by_oldest** | **Boolean** | | [optional] |
|
14
|
+
| **range_begin** | **Integer** | | [optional] |
|
15
|
+
| **range_end** | **Integer** | | [optional] |
|
16
|
+
| **sms_phone_number_filter** | **String** | | [optional] |
|
17
|
+
| **text_search** | **String** | | [optional] |
|
18
|
+
| **visible_filter** | **Boolean** | | [optional] |
|
19
|
+
|
20
|
+
## Example
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'ultracart_api'
|
24
|
+
|
25
|
+
instance = UltracartClient::ConversationSearchRequest.new(
|
26
|
+
date_end: null,
|
27
|
+
date_start: null,
|
28
|
+
email_filter: null,
|
29
|
+
language_filter: null,
|
30
|
+
medium_filter: null,
|
31
|
+
order_by_newest: null,
|
32
|
+
order_by_oldest: null,
|
33
|
+
range_begin: null,
|
34
|
+
range_end: null,
|
35
|
+
sms_phone_number_filter: null,
|
36
|
+
text_search: null,
|
37
|
+
visible_filter: null
|
38
|
+
)
|
39
|
+
```
|
40
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# UltracartClient::ConversationSearchResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **range_begin** | **Integer** | | [optional] |
|
8
|
+
| **range_end** | **Integer** | | [optional] |
|
9
|
+
| **total** | **Integer** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ultracart_api'
|
15
|
+
|
16
|
+
instance = UltracartClient::ConversationSearchResponse.new(
|
17
|
+
range_begin: null,
|
18
|
+
range_end: null,
|
19
|
+
total: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -718,6 +718,144 @@ module UltracartClient
|
|
718
718
|
return data, status_code, headers
|
719
719
|
end
|
720
720
|
|
721
|
+
# Retrieve a list of matching terms for a search field
|
722
|
+
# Retrieve a list of matching terms for a search field
|
723
|
+
# @param autocomplete_request [ConversationAutocompleteRequest] Autocomplete Request
|
724
|
+
# @param [Hash] opts the optional parameters
|
725
|
+
# @return [ConversationAutocompleteResponse]
|
726
|
+
def get_conversations_autocomplete(autocomplete_request, opts = {})
|
727
|
+
data, _status_code, _headers = get_conversations_autocomplete_with_http_info(autocomplete_request, opts)
|
728
|
+
data
|
729
|
+
end
|
730
|
+
|
731
|
+
# Retrieve a list of matching terms for a search field
|
732
|
+
# Retrieve a list of matching terms for a search field
|
733
|
+
# @param autocomplete_request [ConversationAutocompleteRequest] Autocomplete Request
|
734
|
+
# @param [Hash] opts the optional parameters
|
735
|
+
# @return [Array<(ConversationAutocompleteResponse, Integer, Hash)>] ConversationAutocompleteResponse data, response status code and response headers
|
736
|
+
def get_conversations_autocomplete_with_http_info(autocomplete_request, opts = {})
|
737
|
+
if @api_client.config.debugging
|
738
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_autocomplete ...'
|
739
|
+
end
|
740
|
+
# verify the required parameter 'autocomplete_request' is set
|
741
|
+
if @api_client.config.client_side_validation && autocomplete_request.nil?
|
742
|
+
fail ArgumentError, "Missing the required parameter 'autocomplete_request' when calling ConversationApi.get_conversations_autocomplete"
|
743
|
+
end
|
744
|
+
# resource path
|
745
|
+
local_var_path = '/conversation/conversations/autocomplete'
|
746
|
+
|
747
|
+
# query parameters
|
748
|
+
query_params = opts[:query_params] || {}
|
749
|
+
|
750
|
+
# header parameters
|
751
|
+
header_params = opts[:header_params] || {}
|
752
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
753
|
+
# HTTP header 'Accept' (if needed)
|
754
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
755
|
+
# HTTP header 'Content-Type'
|
756
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
757
|
+
if !content_type.nil?
|
758
|
+
header_params['Content-Type'] = content_type
|
759
|
+
end
|
760
|
+
|
761
|
+
# form parameters
|
762
|
+
form_params = opts[:form_params] || {}
|
763
|
+
|
764
|
+
# http body (model)
|
765
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(autocomplete_request)
|
766
|
+
|
767
|
+
# return_type
|
768
|
+
return_type = opts[:debug_return_type] || 'ConversationAutocompleteResponse'
|
769
|
+
|
770
|
+
# auth_names
|
771
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
772
|
+
|
773
|
+
new_options = opts.merge(
|
774
|
+
:operation => :"ConversationApi.get_conversations_autocomplete",
|
775
|
+
:header_params => header_params,
|
776
|
+
:query_params => query_params,
|
777
|
+
:form_params => form_params,
|
778
|
+
:body => post_body,
|
779
|
+
:auth_names => auth_names,
|
780
|
+
:return_type => return_type
|
781
|
+
)
|
782
|
+
|
783
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
784
|
+
if @api_client.config.debugging
|
785
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversations_autocomplete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
786
|
+
end
|
787
|
+
return data, status_code, headers
|
788
|
+
end
|
789
|
+
|
790
|
+
# Search conversations
|
791
|
+
# Search conversations
|
792
|
+
# @param search_request [ConversationSearchRequest] Search Request
|
793
|
+
# @param [Hash] opts the optional parameters
|
794
|
+
# @return [ConversationSearchResponse]
|
795
|
+
def get_conversations_search(search_request, opts = {})
|
796
|
+
data, _status_code, _headers = get_conversations_search_with_http_info(search_request, opts)
|
797
|
+
data
|
798
|
+
end
|
799
|
+
|
800
|
+
# Search conversations
|
801
|
+
# Search conversations
|
802
|
+
# @param search_request [ConversationSearchRequest] Search Request
|
803
|
+
# @param [Hash] opts the optional parameters
|
804
|
+
# @return [Array<(ConversationSearchResponse, Integer, Hash)>] ConversationSearchResponse data, response status code and response headers
|
805
|
+
def get_conversations_search_with_http_info(search_request, opts = {})
|
806
|
+
if @api_client.config.debugging
|
807
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversations_search ...'
|
808
|
+
end
|
809
|
+
# verify the required parameter 'search_request' is set
|
810
|
+
if @api_client.config.client_side_validation && search_request.nil?
|
811
|
+
fail ArgumentError, "Missing the required parameter 'search_request' when calling ConversationApi.get_conversations_search"
|
812
|
+
end
|
813
|
+
# resource path
|
814
|
+
local_var_path = '/conversation/conversations/search'
|
815
|
+
|
816
|
+
# query parameters
|
817
|
+
query_params = opts[:query_params] || {}
|
818
|
+
|
819
|
+
# header parameters
|
820
|
+
header_params = opts[:header_params] || {}
|
821
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
822
|
+
# HTTP header 'Accept' (if needed)
|
823
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
824
|
+
# HTTP header 'Content-Type'
|
825
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
826
|
+
if !content_type.nil?
|
827
|
+
header_params['Content-Type'] = content_type
|
828
|
+
end
|
829
|
+
|
830
|
+
# form parameters
|
831
|
+
form_params = opts[:form_params] || {}
|
832
|
+
|
833
|
+
# http body (model)
|
834
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(search_request)
|
835
|
+
|
836
|
+
# return_type
|
837
|
+
return_type = opts[:debug_return_type] || 'ConversationSearchResponse'
|
838
|
+
|
839
|
+
# auth_names
|
840
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
841
|
+
|
842
|
+
new_options = opts.merge(
|
843
|
+
:operation => :"ConversationApi.get_conversations_search",
|
844
|
+
:header_params => header_params,
|
845
|
+
:query_params => query_params,
|
846
|
+
:form_params => form_params,
|
847
|
+
:body => post_body,
|
848
|
+
:auth_names => auth_names,
|
849
|
+
:return_type => return_type
|
850
|
+
)
|
851
|
+
|
852
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
853
|
+
if @api_client.config.debugging
|
854
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversations_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
855
|
+
end
|
856
|
+
return data, status_code, headers
|
857
|
+
end
|
858
|
+
|
721
859
|
# Insert a canned message
|
722
860
|
# Insert a canned message
|
723
861
|
# @param canned_message [ConversationCannedMessage] Canned message
|