ultracart_api 4.0.35.rc → 4.0.36.rc
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 +4 -0
- data/docs/ConversationApi.md +71 -0
- data/lib/ultracart_api/api/conversation_api.rb +64 -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: 48a8d98870978d4d0dfcc2904b6c54831dca31a5073c3154542204bfaa991b1a
|
|
4
|
+
data.tar.gz: db252c18d5b411e4b58d79b7f601289f093a114666653e35e90621f85d768378
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 54ede9528dc838fba02b330d81ce3ed7a2cdcd2f7ad50ff88993086d938072a0106b447f79dd460510960cb174412072d27fff0fdca71376c1b4ff90d3472fdd
|
|
7
|
+
data.tar.gz: 45d7d2d3a29e74a0d214cba7eab1b8d4878c69c8325e9d825ec47c916776bb6ec1bdf9390760c28e7abe25e398371dd5df5da9caf61122cb086eaca4a0994db5
|
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.36.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.36.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.36.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.36.rc'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -133,6 +133,7 @@ Class | Method | HTTP request | Description
|
|
|
133
133
|
*UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
|
|
134
134
|
*UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
|
|
135
135
|
*UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
|
|
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
|
|
136
137
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
|
137
138
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
|
138
139
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
|
@@ -1158,6 +1159,7 @@ Not every change is committed to every SDK.
|
|
|
1158
1159
|
|
|
1159
1160
|
| Version | Date | Comments |
|
|
1160
1161
|
| --: | :-: | --- |
|
|
1162
|
+
| 4.0.36-RC | 07/18/2022 | twilio dev |
|
|
1161
1163
|
| 4.0.35-RC | 07/14/2022 | Add channel storefront_oid to the customer activity record |
|
|
1162
1164
|
| 4.0.34-RC | 07/11/2022 | Customer API - mergeCustomer method |
|
|
1163
1165
|
| 4.0.33-RC | 07/05/2022 | docs update |
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **conversation_participant_arn** | **String** | | [optional] |
|
|
8
8
|
| **jwt** | **String** | | [optional] |
|
|
9
|
+
| **merchant_id** | **String** | | [optional] |
|
|
10
|
+
| **twilio_phone_numbers** | **Array<String>** | | [optional] |
|
|
9
11
|
| **websocket_url** | **String** | | [optional] |
|
|
10
12
|
|
|
11
13
|
## Example
|
|
@@ -16,6 +18,8 @@ require 'ultracart_api'
|
|
|
16
18
|
instance = UltracartClient::ConversationAgentAuthResponse.new(
|
|
17
19
|
conversation_participant_arn: null,
|
|
18
20
|
jwt: null,
|
|
21
|
+
merchant_id: null,
|
|
22
|
+
twilio_phone_numbers: null,
|
|
19
23
|
websocket_url: null
|
|
20
24
|
)
|
|
21
25
|
```
|
data/docs/ConversationApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
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 |
|
|
@@ -151,6 +152,76 @@ end
|
|
|
151
152
|
- **Accept**: application/json
|
|
152
153
|
|
|
153
154
|
|
|
155
|
+
## get_conversation_multimedia_upload_url
|
|
156
|
+
|
|
157
|
+
> get_conversation_multimedia_upload_url(extension)
|
|
158
|
+
|
|
159
|
+
Get a presigned conersation multimedia upload URL
|
|
160
|
+
|
|
161
|
+
Get a presigned conersation multimedia upload URL
|
|
162
|
+
|
|
163
|
+
### Examples
|
|
164
|
+
|
|
165
|
+
```ruby
|
|
166
|
+
require 'time'
|
|
167
|
+
require 'ultracart_api'
|
|
168
|
+
require 'json'
|
|
169
|
+
require 'yaml'
|
|
170
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
171
|
+
|
|
172
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
173
|
+
# As such, this might not be the best way to use this object.
|
|
174
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
175
|
+
|
|
176
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
177
|
+
extension = 'extension_example' # String |
|
|
178
|
+
|
|
179
|
+
begin
|
|
180
|
+
# Get a presigned conersation multimedia upload URL
|
|
181
|
+
api_instance.get_conversation_multimedia_upload_url(extension)
|
|
182
|
+
rescue UltracartClient::ApiError => e
|
|
183
|
+
puts "Error when calling ConversationApi->get_conversation_multimedia_upload_url: #{e}"
|
|
184
|
+
end
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
#### Using the get_conversation_multimedia_upload_url_with_http_info variant
|
|
188
|
+
|
|
189
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
190
|
+
|
|
191
|
+
> <Array(nil, Integer, Hash)> get_conversation_multimedia_upload_url_with_http_info(extension)
|
|
192
|
+
|
|
193
|
+
```ruby
|
|
194
|
+
begin
|
|
195
|
+
# Get a presigned conersation multimedia upload URL
|
|
196
|
+
data, status_code, headers = api_instance.get_conversation_multimedia_upload_url_with_http_info(extension)
|
|
197
|
+
p status_code # => 2xx
|
|
198
|
+
p headers # => { ... }
|
|
199
|
+
p data # => nil
|
|
200
|
+
rescue UltracartClient::ApiError => e
|
|
201
|
+
puts "Error when calling ConversationApi->get_conversation_multimedia_upload_url_with_http_info: #{e}"
|
|
202
|
+
end
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### Parameters
|
|
206
|
+
|
|
207
|
+
| Name | Type | Description | Notes |
|
|
208
|
+
| ---- | ---- | ----------- | ----- |
|
|
209
|
+
| **extension** | **String** | | |
|
|
210
|
+
|
|
211
|
+
### Return type
|
|
212
|
+
|
|
213
|
+
nil (empty response body)
|
|
214
|
+
|
|
215
|
+
### Authorization
|
|
216
|
+
|
|
217
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
218
|
+
|
|
219
|
+
### HTTP request headers
|
|
220
|
+
|
|
221
|
+
- **Content-Type**: Not defined
|
|
222
|
+
- **Accept**: application/json
|
|
223
|
+
|
|
224
|
+
|
|
154
225
|
## get_conversations
|
|
155
226
|
|
|
156
227
|
> <ConversationsResponse> get_conversations(opts)
|
|
@@ -154,6 +154,70 @@ module UltracartClient
|
|
|
154
154
|
return data, status_code, headers
|
|
155
155
|
end
|
|
156
156
|
|
|
157
|
+
# Get a presigned conersation multimedia upload URL
|
|
158
|
+
# Get a presigned conersation multimedia upload URL
|
|
159
|
+
# @param extension [String]
|
|
160
|
+
# @param [Hash] opts the optional parameters
|
|
161
|
+
# @return [nil]
|
|
162
|
+
def get_conversation_multimedia_upload_url(extension, opts = {})
|
|
163
|
+
get_conversation_multimedia_upload_url_with_http_info(extension, opts)
|
|
164
|
+
nil
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
# Get a presigned conersation multimedia upload URL
|
|
168
|
+
# Get a presigned conersation multimedia upload URL
|
|
169
|
+
# @param extension [String]
|
|
170
|
+
# @param [Hash] opts the optional parameters
|
|
171
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
172
|
+
def get_conversation_multimedia_upload_url_with_http_info(extension, opts = {})
|
|
173
|
+
if @api_client.config.debugging
|
|
174
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_multimedia_upload_url ...'
|
|
175
|
+
end
|
|
176
|
+
# verify the required parameter 'extension' is set
|
|
177
|
+
if @api_client.config.client_side_validation && extension.nil?
|
|
178
|
+
fail ArgumentError, "Missing the required parameter 'extension' when calling ConversationApi.get_conversation_multimedia_upload_url"
|
|
179
|
+
end
|
|
180
|
+
# resource path
|
|
181
|
+
local_var_path = '/conversation/upload_url/{extension}'.sub('{' + 'extension' + '}', CGI.escape(extension.to_s))
|
|
182
|
+
|
|
183
|
+
# query parameters
|
|
184
|
+
query_params = opts[:query_params] || {}
|
|
185
|
+
|
|
186
|
+
# header parameters
|
|
187
|
+
header_params = opts[:header_params] || {}
|
|
188
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
189
|
+
# HTTP header 'Accept' (if needed)
|
|
190
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
191
|
+
|
|
192
|
+
# form parameters
|
|
193
|
+
form_params = opts[:form_params] || {}
|
|
194
|
+
|
|
195
|
+
# http body (model)
|
|
196
|
+
post_body = opts[:debug_body]
|
|
197
|
+
|
|
198
|
+
# return_type
|
|
199
|
+
return_type = opts[:debug_return_type]
|
|
200
|
+
|
|
201
|
+
# auth_names
|
|
202
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
203
|
+
|
|
204
|
+
new_options = opts.merge(
|
|
205
|
+
:operation => :"ConversationApi.get_conversation_multimedia_upload_url",
|
|
206
|
+
:header_params => header_params,
|
|
207
|
+
:query_params => query_params,
|
|
208
|
+
:form_params => form_params,
|
|
209
|
+
:body => post_body,
|
|
210
|
+
:auth_names => auth_names,
|
|
211
|
+
:return_type => return_type
|
|
212
|
+
)
|
|
213
|
+
|
|
214
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
215
|
+
if @api_client.config.debugging
|
|
216
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_multimedia_upload_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
217
|
+
end
|
|
218
|
+
return data, status_code, headers
|
|
219
|
+
end
|
|
220
|
+
|
|
157
221
|
# Retrieve a list of conversation summaries newest to oldest
|
|
158
222
|
# Retrieve a list of conversation summaries that are ordered newest to oldest, include the most recent message and whether its been read.
|
|
159
223
|
# @param [Hash] opts the optional parameters
|
|
@@ -19,6 +19,10 @@ module UltracartClient
|
|
|
19
19
|
|
|
20
20
|
attr_accessor :jwt
|
|
21
21
|
|
|
22
|
+
attr_accessor :merchant_id
|
|
23
|
+
|
|
24
|
+
attr_accessor :twilio_phone_numbers
|
|
25
|
+
|
|
22
26
|
attr_accessor :websocket_url
|
|
23
27
|
|
|
24
28
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
@@ -26,6 +30,8 @@ module UltracartClient
|
|
|
26
30
|
{
|
|
27
31
|
:'conversation_participant_arn' => :'conversation_participant_arn',
|
|
28
32
|
:'jwt' => :'jwt',
|
|
33
|
+
:'merchant_id' => :'merchant_id',
|
|
34
|
+
:'twilio_phone_numbers' => :'twilio_phone_numbers',
|
|
29
35
|
:'websocket_url' => :'websocket_url'
|
|
30
36
|
}
|
|
31
37
|
end
|
|
@@ -40,6 +46,8 @@ module UltracartClient
|
|
|
40
46
|
{
|
|
41
47
|
:'conversation_participant_arn' => :'String',
|
|
42
48
|
:'jwt' => :'String',
|
|
49
|
+
:'merchant_id' => :'String',
|
|
50
|
+
:'twilio_phone_numbers' => :'Array<String>',
|
|
43
51
|
:'websocket_url' => :'String'
|
|
44
52
|
}
|
|
45
53
|
end
|
|
@@ -73,6 +81,16 @@ module UltracartClient
|
|
|
73
81
|
self.jwt = attributes[:'jwt']
|
|
74
82
|
end
|
|
75
83
|
|
|
84
|
+
if attributes.key?(:'merchant_id')
|
|
85
|
+
self.merchant_id = attributes[:'merchant_id']
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
if attributes.key?(:'twilio_phone_numbers')
|
|
89
|
+
if (value = attributes[:'twilio_phone_numbers']).is_a?(Array)
|
|
90
|
+
self.twilio_phone_numbers = value
|
|
91
|
+
end
|
|
92
|
+
end
|
|
93
|
+
|
|
76
94
|
if attributes.key?(:'websocket_url')
|
|
77
95
|
self.websocket_url = attributes[:'websocket_url']
|
|
78
96
|
end
|
|
@@ -98,6 +116,8 @@ module UltracartClient
|
|
|
98
116
|
self.class == o.class &&
|
|
99
117
|
conversation_participant_arn == o.conversation_participant_arn &&
|
|
100
118
|
jwt == o.jwt &&
|
|
119
|
+
merchant_id == o.merchant_id &&
|
|
120
|
+
twilio_phone_numbers == o.twilio_phone_numbers &&
|
|
101
121
|
websocket_url == o.websocket_url
|
|
102
122
|
end
|
|
103
123
|
|
|
@@ -110,7 +130,7 @@ module UltracartClient
|
|
|
110
130
|
# Calculates hash code according to all attributes.
|
|
111
131
|
# @return [Integer] Hash code
|
|
112
132
|
def hash
|
|
113
|
-
[conversation_participant_arn, jwt, websocket_url].hash
|
|
133
|
+
[conversation_participant_arn, jwt, merchant_id, twilio_phone_numbers, websocket_url].hash
|
|
114
134
|
end
|
|
115
135
|
|
|
116
136
|
# 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: 4.0.
|
|
4
|
+
version: 4.0.36.rc
|
|
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
|