ultracart_api 3.10.20 → 3.10.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +6 -4
- data/docs/ConversationAgentAuthResponse.md +2 -0
- data/docs/ConversationApi.md +50 -0
- data/lib/ultracart_api/api/conversation_api.rb +54 -0
- data/lib/ultracart_api/models/conversation_agent_auth_response.rb +21 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: c38d42fb8aa1750dc4b564905fc831a34f209712e9836ce9c3a765627392ecf8
|
|
4
|
+
data.tar.gz: 13eeb92e656872f30b59cfc2a846fb53b545f92fbac712893dc2281bdfeb7171
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 912827d25b77988d39226206abbd359a03ff6afa693a6842d0506615e2101e2afb2f64cfda3edbbe1307c37d521f838a2558afe3dd47d2a1520b3b2685520faa
|
|
7
|
+
data.tar.gz: e2610697a9dde0ad25bb05ddab905009aa5d62170cf180093656c2004df206936d66bae218337946f2ffeac657aa675f49fe47f729c9d7aa97680744a71bc39c
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 3.10.
|
|
10
|
+
- Package version: 3.10.21
|
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
|
13
13
|
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
|
24
24
|
Then either install the gem locally:
|
|
25
25
|
|
|
26
26
|
```shell
|
|
27
|
-
gem install ./ultracart_api-3.10.
|
|
27
|
+
gem install ./ultracart_api-3.10.21.gem
|
|
28
28
|
```
|
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.21.gem` to install the development dependencies)
|
|
30
30
|
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
32
32
|
|
|
33
33
|
Finally add this to the Gemfile:
|
|
34
34
|
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
|
35
|
+
gem 'ultracart_api', '~> 3.10.21'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -127,6 +127,7 @@ Class | Method | HTTP request | Description
|
|
|
127
127
|
*UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
|
128
128
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
129
129
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
130
|
+
*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
|
|
130
131
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
|
131
132
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
|
132
133
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
|
@@ -1150,6 +1151,7 @@ Not every change is committed to every SDK.
|
|
|
1150
1151
|
|
|
1151
1152
|
| Version | Date | Comments |
|
|
1152
1153
|
| --: | :-: | --- |
|
|
1154
|
+
| 3.10.21 | 07/18/2022 | twilio dev |
|
|
1153
1155
|
| 3.10.20 | 07/14/2022 | Add channel storefront_oid to the customer activity record |
|
|
1154
1156
|
| 3.10.19 | 07/11/2022 | Customer API - mergeCustomer method |
|
|
1155
1157
|
| 3.10.18 | 06/23/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
|
|
@@ -5,6 +5,8 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**conversation_participant_arn** | **String** | | [optional]
|
|
7
7
|
**jwt** | **String** | | [optional]
|
|
8
|
+
**merchant_id** | **String** | | [optional]
|
|
9
|
+
**twilio_phone_numbers** | **Array<String>** | | [optional]
|
|
8
10
|
**websocket_url** | **String** | | [optional]
|
|
9
11
|
|
|
10
12
|
|
data/docs/ConversationApi.md
CHANGED
|
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**get_agent_websocket_authorization**](ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
8
8
|
[**get_conversation**](ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
9
|
+
[**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
|
|
9
10
|
[**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
|
10
11
|
[**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
|
11
12
|
[**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
|
@@ -107,6 +108,55 @@ Name | Type | Description | Notes
|
|
|
107
108
|
|
|
108
109
|
|
|
109
110
|
|
|
111
|
+
# **get_conversation_multimedia_upload_url**
|
|
112
|
+
> get_conversation_multimedia_upload_url(extension)
|
|
113
|
+
|
|
114
|
+
Get a presigned conersation multimedia upload URL
|
|
115
|
+
|
|
116
|
+
Get a presigned conersation multimedia upload URL
|
|
117
|
+
|
|
118
|
+
### Example
|
|
119
|
+
```ruby
|
|
120
|
+
# load the gem
|
|
121
|
+
require 'ultracart_api'
|
|
122
|
+
|
|
123
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
124
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
125
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
extension = 'extension_example' # String |
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
begin
|
|
132
|
+
#Get a presigned conersation multimedia upload URL
|
|
133
|
+
api_instance.get_conversation_multimedia_upload_url(extension)
|
|
134
|
+
rescue UltracartClient::ApiError => e
|
|
135
|
+
puts "Exception when calling ConversationApi->get_conversation_multimedia_upload_url: #{e}"
|
|
136
|
+
end
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Parameters
|
|
140
|
+
|
|
141
|
+
Name | Type | Description | Notes
|
|
142
|
+
------------- | ------------- | ------------- | -------------
|
|
143
|
+
**extension** | **String**| |
|
|
144
|
+
|
|
145
|
+
### Return type
|
|
146
|
+
|
|
147
|
+
nil (empty response body)
|
|
148
|
+
|
|
149
|
+
### Authorization
|
|
150
|
+
|
|
151
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
152
|
+
|
|
153
|
+
### HTTP request headers
|
|
154
|
+
|
|
155
|
+
- **Content-Type**: application/json
|
|
156
|
+
- **Accept**: application/json
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
110
160
|
# **get_conversations**
|
|
111
161
|
> ConversationsResponse get_conversations(opts)
|
|
112
162
|
|
|
@@ -136,6 +136,60 @@ module UltracartClient
|
|
|
136
136
|
end
|
|
137
137
|
return data, status_code, headers
|
|
138
138
|
end
|
|
139
|
+
# Get a presigned conersation multimedia upload URL
|
|
140
|
+
# Get a presigned conersation multimedia upload URL
|
|
141
|
+
# @param extension
|
|
142
|
+
# @param [Hash] opts the optional parameters
|
|
143
|
+
# @return [nil]
|
|
144
|
+
def get_conversation_multimedia_upload_url(extension, opts = {})
|
|
145
|
+
get_conversation_multimedia_upload_url_with_http_info(extension, opts)
|
|
146
|
+
nil
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
# Get a presigned conersation multimedia upload URL
|
|
150
|
+
# Get a presigned conersation multimedia upload URL
|
|
151
|
+
# @param extension
|
|
152
|
+
# @param [Hash] opts the optional parameters
|
|
153
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
154
|
+
def get_conversation_multimedia_upload_url_with_http_info(extension, opts = {})
|
|
155
|
+
if @api_client.config.debugging
|
|
156
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_multimedia_upload_url ...'
|
|
157
|
+
end
|
|
158
|
+
# verify the required parameter 'extension' is set
|
|
159
|
+
if @api_client.config.client_side_validation && extension.nil?
|
|
160
|
+
fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_multimedia_upload_url"
|
|
161
|
+
end
|
|
162
|
+
# resource path
|
|
163
|
+
local_var_path = '/conversation/upload_url/{extension}'.sub('{' + 'extension' + '}', extension.to_s)
|
|
164
|
+
|
|
165
|
+
# query parameters
|
|
166
|
+
query_params = {}
|
|
167
|
+
|
|
168
|
+
# header parameters
|
|
169
|
+
header_params = {}
|
|
170
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
171
|
+
# HTTP header 'Accept' (if needed)
|
|
172
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
173
|
+
# HTTP header 'Content-Type'
|
|
174
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
175
|
+
|
|
176
|
+
# form parameters
|
|
177
|
+
form_params = {}
|
|
178
|
+
|
|
179
|
+
# http body (model)
|
|
180
|
+
post_body = nil
|
|
181
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
182
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
183
|
+
:header_params => header_params,
|
|
184
|
+
:query_params => query_params,
|
|
185
|
+
:form_params => form_params,
|
|
186
|
+
:body => post_body,
|
|
187
|
+
:auth_names => auth_names)
|
|
188
|
+
if @api_client.config.debugging
|
|
189
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_multimedia_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
190
|
+
end
|
|
191
|
+
return data, status_code, headers
|
|
192
|
+
end
|
|
139
193
|
# Retrieve a list of conversation summaries newest to oldest
|
|
140
194
|
# Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
|
|
141
195
|
# @param [Hash] opts the optional parameters
|
|
@@ -18,6 +18,10 @@ module UltracartClient
|
|
|
18
18
|
|
|
19
19
|
attr_accessor :jwt
|
|
20
20
|
|
|
21
|
+
attr_accessor :merchant_id
|
|
22
|
+
|
|
23
|
+
attr_accessor :twilio_phone_numbers
|
|
24
|
+
|
|
21
25
|
attr_accessor :websocket_url
|
|
22
26
|
|
|
23
27
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -25,6 +29,8 @@ module UltracartClient
|
|
|
25
29
|
{
|
|
26
30
|
:'conversation_participant_arn' => :'conversation_participant_arn',
|
|
27
31
|
:'jwt' => :'jwt',
|
|
32
|
+
:'merchant_id' => :'merchant_id',
|
|
33
|
+
:'twilio_phone_numbers' => :'twilio_phone_numbers',
|
|
28
34
|
:'websocket_url' => :'websocket_url'
|
|
29
35
|
}
|
|
30
36
|
end
|
|
@@ -34,6 +40,8 @@ module UltracartClient
|
|
|
34
40
|
{
|
|
35
41
|
:'conversation_participant_arn' => :'String',
|
|
36
42
|
:'jwt' => :'String',
|
|
43
|
+
:'merchant_id' => :'String',
|
|
44
|
+
:'twilio_phone_numbers' => :'Array<String>',
|
|
37
45
|
:'websocket_url' => :'String'
|
|
38
46
|
}
|
|
39
47
|
end
|
|
@@ -54,6 +62,16 @@ module UltracartClient
|
|
|
54
62
|
self.jwt = attributes[:'jwt']
|
|
55
63
|
end
|
|
56
64
|
|
|
65
|
+
if attributes.has_key?(:'merchant_id')
|
|
66
|
+
self.merchant_id = attributes[:'merchant_id']
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
if attributes.has_key?(:'twilio_phone_numbers')
|
|
70
|
+
if (value = attributes[:'twilio_phone_numbers']).is_a?(Array)
|
|
71
|
+
self.twilio_phone_numbers = value
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
57
75
|
if attributes.has_key?(:'websocket_url')
|
|
58
76
|
self.websocket_url = attributes[:'websocket_url']
|
|
59
77
|
end
|
|
@@ -79,6 +97,8 @@ module UltracartClient
|
|
|
79
97
|
self.class == o.class &&
|
|
80
98
|
conversation_participant_arn == o.conversation_participant_arn &&
|
|
81
99
|
jwt == o.jwt &&
|
|
100
|
+
merchant_id == o.merchant_id &&
|
|
101
|
+
twilio_phone_numbers == o.twilio_phone_numbers &&
|
|
82
102
|
websocket_url == o.websocket_url
|
|
83
103
|
end
|
|
84
104
|
|
|
@@ -91,7 +111,7 @@ module UltracartClient
|
|
|
91
111
|
# Calculates hash code according to all attributes.
|
|
92
112
|
# @return [Fixnum] Hash code
|
|
93
113
|
def hash
|
|
94
|
-
[conversation_participant_arn, jwt, websocket_url].hash
|
|
114
|
+
[conversation_participant_arn, jwt, merchant_id, twilio_phone_numbers, websocket_url].hash
|
|
95
115
|
end
|
|
96
116
|
|
|
97
117
|
# Builds the object from hash
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: ultracart_api
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.10.
|
|
4
|
+
version: 3.10.21
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2022-07-
|
|
11
|
+
date: 2022-07-18 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|