ultracart_api 4.0.86.rc → 4.0.88.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 +7 -4
- data/docs/ConversationApi.md +71 -0
- data/docs/ConversationMessage.md +2 -0
- data/docs/CouponPercentOffMsrpItems.md +5 -1
- data/lib/ultracart_api/api/conversation_api.rb +64 -0
- data/lib/ultracart_api/models/conversation_message.rb +11 -1
- data/lib/ultracart_api/models/coupon_percent_off_msrp_items.rb +24 -4
- 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: 70f39317e942ba4cfd827cef236e6937ab5b284ef21b145acddfda442ed1f9f5
|
4
|
+
data.tar.gz: 2dfbfdfadad666579f4ebdbaf3581465a5b8a6aa18828df25fe510413b257c8f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 493368cf8f53a5e116293ffd7acd058559c1f01faafe9e864ca767e101a2b6cb612248a06e8c4af89944dca2070a7c68f201ae5f89733be3aac64b17787ec7dd
|
7
|
+
data.tar.gz: 5723985c0b5173dd5a9213c9a0d3f4a28a85c248278eff01d73b6a28c7abe01508cf7e567ceafaea8f52ea5add6f35dd7f24decbcae5cbe0cdf813b909965072
|
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.88.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.88.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.88.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.88.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -141,6 +141,7 @@ Class | Method | HTTP request | Description
|
|
141
141
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
142
142
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
143
143
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
144
|
+
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
144
145
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
145
146
|
*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
|
146
147
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
@@ -1233,6 +1234,8 @@ Not every change is committed to every SDK.
|
|
1233
1234
|
|
1234
1235
|
| Version | Date | Comments |
|
1235
1236
|
| --: | :-: | --- |
|
1237
|
+
| 4.0.88-RC | 11/29/2022 | converstation marked convo read method |
|
1238
|
+
| 4.0.87-RC | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
|
1236
1239
|
| 4.0.86-RC | 11/21/2022 | conversation context method |
|
1237
1240
|
| 4.0.85-RC | 11/21/2022 | adjusted conversation event model |
|
1238
1241
|
| 4.0.84-RC | 11/15/2022 | conversation methods bug fix |
|
data/docs/ConversationApi.md
CHANGED
@@ -14,6 +14,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
14
14
|
| [**get_conversations**](ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest |
|
15
15
|
| [**join_conversation**](ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation |
|
16
16
|
| [**leave_conversation**](ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation |
|
17
|
+
| [**mark_read_conversation**](ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read |
|
17
18
|
| [**start_conversation**](ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation |
|
18
19
|
| [**update_conversation_webchat_queue_status**](ConversationApi.md#update_conversation_webchat_queue_status) | **PUT** /conversation/conversations/queues/{queue_name}/status | Update status within the queue |
|
19
20
|
|
@@ -734,6 +735,76 @@ nil (empty response body)
|
|
734
735
|
- **Accept**: application/json
|
735
736
|
|
736
737
|
|
738
|
+
## mark_read_conversation
|
739
|
+
|
740
|
+
> mark_read_conversation(conversation_uuid)
|
741
|
+
|
742
|
+
Mark a conversation as read
|
743
|
+
|
744
|
+
Mark a conversation as read
|
745
|
+
|
746
|
+
### Examples
|
747
|
+
|
748
|
+
```ruby
|
749
|
+
require 'time'
|
750
|
+
require 'ultracart_api'
|
751
|
+
require 'json'
|
752
|
+
require 'yaml'
|
753
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
754
|
+
|
755
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
756
|
+
# As such, this might not be the best way to use this object.
|
757
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
758
|
+
|
759
|
+
api = UltracartClient::ConversationApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
760
|
+
conversation_uuid = 'conversation_uuid_example' # String |
|
761
|
+
|
762
|
+
begin
|
763
|
+
# Mark a conversation as read
|
764
|
+
api_instance.mark_read_conversation(conversation_uuid)
|
765
|
+
rescue UltracartClient::ApiError => e
|
766
|
+
puts "Error when calling ConversationApi->mark_read_conversation: #{e}"
|
767
|
+
end
|
768
|
+
```
|
769
|
+
|
770
|
+
#### Using the mark_read_conversation_with_http_info variant
|
771
|
+
|
772
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
773
|
+
|
774
|
+
> <Array(nil, Integer, Hash)> mark_read_conversation_with_http_info(conversation_uuid)
|
775
|
+
|
776
|
+
```ruby
|
777
|
+
begin
|
778
|
+
# Mark a conversation as read
|
779
|
+
data, status_code, headers = api_instance.mark_read_conversation_with_http_info(conversation_uuid)
|
780
|
+
p status_code # => 2xx
|
781
|
+
p headers # => { ... }
|
782
|
+
p data # => nil
|
783
|
+
rescue UltracartClient::ApiError => e
|
784
|
+
puts "Error when calling ConversationApi->mark_read_conversation_with_http_info: #{e}"
|
785
|
+
end
|
786
|
+
```
|
787
|
+
|
788
|
+
### Parameters
|
789
|
+
|
790
|
+
| Name | Type | Description | Notes |
|
791
|
+
| ---- | ---- | ----------- | ----- |
|
792
|
+
| **conversation_uuid** | **String** | | |
|
793
|
+
|
794
|
+
### Return type
|
795
|
+
|
796
|
+
nil (empty response body)
|
797
|
+
|
798
|
+
### Authorization
|
799
|
+
|
800
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
801
|
+
|
802
|
+
### HTTP request headers
|
803
|
+
|
804
|
+
- **Content-Type**: Not defined
|
805
|
+
- **Accept**: application/json
|
806
|
+
|
807
|
+
|
737
808
|
## start_conversation
|
738
809
|
|
739
810
|
> <ConversationStartResponse> start_conversation(start_request)
|
data/docs/ConversationMessage.md
CHANGED
@@ -9,6 +9,7 @@
|
|
9
9
|
| **body** | **String** | | [optional] |
|
10
10
|
| **client_message_id** | **String** | | [optional] |
|
11
11
|
| **conversation_message_uuid** | **String** | | [optional] |
|
12
|
+
| **delay_until_dts** | **String** | Delay message transmission until date/time | [optional] |
|
12
13
|
| **media_urls** | **Array<String>** | | [optional] |
|
13
14
|
| **merchant_id** | **String** | | [optional] |
|
14
15
|
| **message_dts** | **String** | Message date/time | [optional] |
|
@@ -28,6 +29,7 @@ instance = UltracartClient::ConversationMessage.new(
|
|
28
29
|
body: null,
|
29
30
|
client_message_id: null,
|
30
31
|
conversation_message_uuid: null,
|
32
|
+
delay_until_dts: null,
|
31
33
|
media_urls: null,
|
32
34
|
merchant_id: null,
|
33
35
|
message_dts: null,
|
@@ -8,6 +8,8 @@
|
|
8
8
|
| **excluded_items** | **Array<String>** | A list of items which cannot be discounted. | [optional] |
|
9
9
|
| **items** | **Array<String>** | An list of items which will receive a discount. | [optional] |
|
10
10
|
| **limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional] |
|
11
|
+
| **minimum_cumulative_msrp** | **Float** | The (optional) minimum cumulative msrp of qualifying items. | [optional] |
|
12
|
+
| **minimum_subtotal** | **Float** | The (optional) minimum subtotal of qualifying items. | [optional] |
|
11
13
|
|
12
14
|
## Example
|
13
15
|
|
@@ -18,7 +20,9 @@ instance = UltracartClient::CouponPercentOffMsrpItems.new(
|
|
18
20
|
discount_percent: null,
|
19
21
|
excluded_items: null,
|
20
22
|
items: null,
|
21
|
-
limit: null
|
23
|
+
limit: null,
|
24
|
+
minimum_cumulative_msrp: null,
|
25
|
+
minimum_subtotal: null
|
22
26
|
)
|
23
27
|
```
|
24
28
|
|
@@ -672,6 +672,70 @@ module UltracartClient
|
|
672
672
|
return data, status_code, headers
|
673
673
|
end
|
674
674
|
|
675
|
+
# Mark a conversation as read
|
676
|
+
# Mark a conversation as read
|
677
|
+
# @param conversation_uuid [String]
|
678
|
+
# @param [Hash] opts the optional parameters
|
679
|
+
# @return [nil]
|
680
|
+
def mark_read_conversation(conversation_uuid, opts = {})
|
681
|
+
mark_read_conversation_with_http_info(conversation_uuid, opts)
|
682
|
+
nil
|
683
|
+
end
|
684
|
+
|
685
|
+
# Mark a conversation as read
|
686
|
+
# Mark a conversation as read
|
687
|
+
# @param conversation_uuid [String]
|
688
|
+
# @param [Hash] opts the optional parameters
|
689
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
690
|
+
def mark_read_conversation_with_http_info(conversation_uuid, opts = {})
|
691
|
+
if @api_client.config.debugging
|
692
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.mark_read_conversation ...'
|
693
|
+
end
|
694
|
+
# verify the required parameter 'conversation_uuid' is set
|
695
|
+
if @api_client.config.client_side_validation && conversation_uuid.nil?
|
696
|
+
fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.mark_read_conversation"
|
697
|
+
end
|
698
|
+
# resource path
|
699
|
+
local_var_path = '/conversation/conversations/{conversation_uuid}/markread'.sub('{' + 'conversation_uuid' + '}', CGI.escape(conversation_uuid.to_s))
|
700
|
+
|
701
|
+
# query parameters
|
702
|
+
query_params = opts[:query_params] || {}
|
703
|
+
|
704
|
+
# header parameters
|
705
|
+
header_params = opts[:header_params] || {}
|
706
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
707
|
+
# HTTP header 'Accept' (if needed)
|
708
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
709
|
+
|
710
|
+
# form parameters
|
711
|
+
form_params = opts[:form_params] || {}
|
712
|
+
|
713
|
+
# http body (model)
|
714
|
+
post_body = opts[:debug_body]
|
715
|
+
|
716
|
+
# return_type
|
717
|
+
return_type = opts[:debug_return_type]
|
718
|
+
|
719
|
+
# auth_names
|
720
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
721
|
+
|
722
|
+
new_options = opts.merge(
|
723
|
+
:operation => :"ConversationApi.mark_read_conversation",
|
724
|
+
:header_params => header_params,
|
725
|
+
:query_params => query_params,
|
726
|
+
:form_params => form_params,
|
727
|
+
:body => post_body,
|
728
|
+
:auth_names => auth_names,
|
729
|
+
:return_type => return_type
|
730
|
+
)
|
731
|
+
|
732
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
733
|
+
if @api_client.config.debugging
|
734
|
+
@api_client.config.logger.debug "API called: ConversationApi#mark_read_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
735
|
+
end
|
736
|
+
return data, status_code, headers
|
737
|
+
end
|
738
|
+
|
675
739
|
# Start a conversation
|
676
740
|
# Start a new conversation
|
677
741
|
# @param start_request [ConversationStartRequest] Start request
|
@@ -25,6 +25,9 @@ module UltracartClient
|
|
25
25
|
|
26
26
|
attr_accessor :conversation_message_uuid
|
27
27
|
|
28
|
+
# Delay message transmission until date/time
|
29
|
+
attr_accessor :delay_until_dts
|
30
|
+
|
28
31
|
attr_accessor :media_urls
|
29
32
|
|
30
33
|
attr_accessor :merchant_id
|
@@ -72,6 +75,7 @@ module UltracartClient
|
|
72
75
|
:'body' => :'body',
|
73
76
|
:'client_message_id' => :'client_message_id',
|
74
77
|
:'conversation_message_uuid' => :'conversation_message_uuid',
|
78
|
+
:'delay_until_dts' => :'delay_until_dts',
|
75
79
|
:'media_urls' => :'media_urls',
|
76
80
|
:'merchant_id' => :'merchant_id',
|
77
81
|
:'message_dts' => :'message_dts',
|
@@ -95,6 +99,7 @@ module UltracartClient
|
|
95
99
|
:'body' => :'String',
|
96
100
|
:'client_message_id' => :'String',
|
97
101
|
:'conversation_message_uuid' => :'String',
|
102
|
+
:'delay_until_dts' => :'String',
|
98
103
|
:'media_urls' => :'Array<String>',
|
99
104
|
:'merchant_id' => :'String',
|
100
105
|
:'message_dts' => :'String',
|
@@ -146,6 +151,10 @@ module UltracartClient
|
|
146
151
|
self.conversation_message_uuid = attributes[:'conversation_message_uuid']
|
147
152
|
end
|
148
153
|
|
154
|
+
if attributes.key?(:'delay_until_dts')
|
155
|
+
self.delay_until_dts = attributes[:'delay_until_dts']
|
156
|
+
end
|
157
|
+
|
149
158
|
if attributes.key?(:'media_urls')
|
150
159
|
if (value = attributes[:'media_urls']).is_a?(Array)
|
151
160
|
self.media_urls = value
|
@@ -216,6 +225,7 @@ module UltracartClient
|
|
216
225
|
body == o.body &&
|
217
226
|
client_message_id == o.client_message_id &&
|
218
227
|
conversation_message_uuid == o.conversation_message_uuid &&
|
228
|
+
delay_until_dts == o.delay_until_dts &&
|
219
229
|
media_urls == o.media_urls &&
|
220
230
|
merchant_id == o.merchant_id &&
|
221
231
|
message_dts == o.message_dts &&
|
@@ -234,7 +244,7 @@ module UltracartClient
|
|
234
244
|
# Calculates hash code according to all attributes.
|
235
245
|
# @return [Integer] Hash code
|
236
246
|
def hash
|
237
|
-
[author_conversation_participant_arn, author_conversation_participant_name, body, client_message_id, conversation_message_uuid, media_urls, merchant_id, message_dts, message_epoch, transport_statuses, type, upload_keys].hash
|
247
|
+
[author_conversation_participant_arn, author_conversation_participant_name, body, client_message_id, conversation_message_uuid, delay_until_dts, media_urls, merchant_id, message_dts, message_epoch, transport_statuses, type, upload_keys].hash
|
238
248
|
end
|
239
249
|
|
240
250
|
# Builds the object from hash
|
@@ -27,13 +27,21 @@ module UltracartClient
|
|
27
27
|
# The (optional) maximum quantity of discounted items.
|
28
28
|
attr_accessor :limit
|
29
29
|
|
30
|
+
# The (optional) minimum cumulative msrp of qualifying items.
|
31
|
+
attr_accessor :minimum_cumulative_msrp
|
32
|
+
|
33
|
+
# The (optional) minimum subtotal of qualifying items.
|
34
|
+
attr_accessor :minimum_subtotal
|
35
|
+
|
30
36
|
# Attribute mapping from ruby-style variable name to JSON key.
|
31
37
|
def self.attribute_map
|
32
38
|
{
|
33
39
|
:'discount_percent' => :'discount_percent',
|
34
40
|
:'excluded_items' => :'excluded_items',
|
35
41
|
:'items' => :'items',
|
36
|
-
:'limit' => :'limit'
|
42
|
+
:'limit' => :'limit',
|
43
|
+
:'minimum_cumulative_msrp' => :'minimum_cumulative_msrp',
|
44
|
+
:'minimum_subtotal' => :'minimum_subtotal'
|
37
45
|
}
|
38
46
|
end
|
39
47
|
|
@@ -48,7 +56,9 @@ module UltracartClient
|
|
48
56
|
:'discount_percent' => :'Float',
|
49
57
|
:'excluded_items' => :'Array<String>',
|
50
58
|
:'items' => :'Array<String>',
|
51
|
-
:'limit' => :'Integer'
|
59
|
+
:'limit' => :'Integer',
|
60
|
+
:'minimum_cumulative_msrp' => :'Float',
|
61
|
+
:'minimum_subtotal' => :'Float'
|
52
62
|
}
|
53
63
|
end
|
54
64
|
|
@@ -92,6 +102,14 @@ module UltracartClient
|
|
92
102
|
if attributes.key?(:'limit')
|
93
103
|
self.limit = attributes[:'limit']
|
94
104
|
end
|
105
|
+
|
106
|
+
if attributes.key?(:'minimum_cumulative_msrp')
|
107
|
+
self.minimum_cumulative_msrp = attributes[:'minimum_cumulative_msrp']
|
108
|
+
end
|
109
|
+
|
110
|
+
if attributes.key?(:'minimum_subtotal')
|
111
|
+
self.minimum_subtotal = attributes[:'minimum_subtotal']
|
112
|
+
end
|
95
113
|
end
|
96
114
|
|
97
115
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -115,7 +133,9 @@ module UltracartClient
|
|
115
133
|
discount_percent == o.discount_percent &&
|
116
134
|
excluded_items == o.excluded_items &&
|
117
135
|
items == o.items &&
|
118
|
-
limit == o.limit
|
136
|
+
limit == o.limit &&
|
137
|
+
minimum_cumulative_msrp == o.minimum_cumulative_msrp &&
|
138
|
+
minimum_subtotal == o.minimum_subtotal
|
119
139
|
end
|
120
140
|
|
121
141
|
# @see the `==` method
|
@@ -127,7 +147,7 @@ module UltracartClient
|
|
127
147
|
# Calculates hash code according to all attributes.
|
128
148
|
# @return [Integer] Hash code
|
129
149
|
def hash
|
130
|
-
[discount_percent, excluded_items, items, limit].hash
|
150
|
+
[discount_percent, excluded_items, items, limit, minimum_cumulative_msrp, minimum_subtotal].hash
|
131
151
|
end
|
132
152
|
|
133
153
|
# 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.88.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-11-
|
11
|
+
date: 2022-11-29 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|