ultracart_api 3.10.69 → 3.10.71
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 +50 -0
- data/docs/ConversationMessage.md +1 -0
- data/docs/CouponPercentOffMsrpItems.md +2 -0
- data/lib/ultracart_api/api/conversation_api.rb +54 -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: 8c7426f708a2732a49b6b1d0acde9c62450df77d0c306ae15dffd84b5c0087eb
|
4
|
+
data.tar.gz: c868275006dca84d6e5aa55d1714720a664aa1ce054d18d446942b06d91aad67
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6dd95ac18e894a49cafbc4d2901aa50b8b0bb6086f326e6cd19cae049bf531ce7c5763b43d486cfd4c281df16b06b2186b38d71b967e9436886657bd2080f70f
|
7
|
+
data.tar.gz: 19ea9f0798d761d980be54530e0aee1f7c547d1d15ff686b472a124ebc48a8784a86b4b8afe76438e5cdc6ecf75a4ff46a1473320fd15d5666efbd8b19888628
|
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.71
|
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.71.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.71.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.71'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -135,6 +135,7 @@ Class | Method | HTTP request | Description
|
|
135
135
|
*UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
|
136
136
|
*UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
|
137
137
|
*UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
|
138
|
+
*UltracartClient::ConversationApi* | [**mark_read_conversation**](docs/ConversationApi.md#mark_read_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/markread | Mark a conversation as read
|
138
139
|
*UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
|
139
140
|
*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
|
140
141
|
*UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
|
@@ -1224,6 +1225,8 @@ Not every change is committed to every SDK.
|
|
1224
1225
|
|
1225
1226
|
| Version | Date | Comments |
|
1226
1227
|
| --: | :-: | --- |
|
1228
|
+
| 3.10.71 | 11/29/2022 | converstation marked convo read method |
|
1229
|
+
| 3.10.70 | 11/21/2022 | coupon - addl optional minimums for percent off msrp items coupon |
|
1227
1230
|
| 3.10.69 | 11/21/2022 | conversation context method |
|
1228
1231
|
| 3.10.68 | 11/21/2022 | adjusted conversation event model |
|
1229
1232
|
| 3.10.67 | 11/15/2022 | conversation methods bug fix |
|
data/docs/ConversationApi.md
CHANGED
@@ -14,6 +14,7 @@ Method | HTTP request | Description
|
|
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
|
|
@@ -518,6 +519,55 @@ nil (empty response body)
|
|
518
519
|
|
519
520
|
|
520
521
|
|
522
|
+
# **mark_read_conversation**
|
523
|
+
> mark_read_conversation(conversation_uuid)
|
524
|
+
|
525
|
+
Mark a conversation as read
|
526
|
+
|
527
|
+
Mark a conversation as read
|
528
|
+
|
529
|
+
### Example
|
530
|
+
```ruby
|
531
|
+
# load the gem
|
532
|
+
require 'ultracart_api'
|
533
|
+
|
534
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
535
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
536
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
537
|
+
|
538
|
+
|
539
|
+
conversation_uuid = 'conversation_uuid_example' # String |
|
540
|
+
|
541
|
+
|
542
|
+
begin
|
543
|
+
#Mark a conversation as read
|
544
|
+
api_instance.mark_read_conversation(conversation_uuid)
|
545
|
+
rescue UltracartClient::ApiError => e
|
546
|
+
puts "Exception when calling ConversationApi->mark_read_conversation: #{e}"
|
547
|
+
end
|
548
|
+
```
|
549
|
+
|
550
|
+
### Parameters
|
551
|
+
|
552
|
+
Name | Type | Description | Notes
|
553
|
+
------------- | ------------- | ------------- | -------------
|
554
|
+
**conversation_uuid** | **String**| |
|
555
|
+
|
556
|
+
### Return type
|
557
|
+
|
558
|
+
nil (empty response body)
|
559
|
+
|
560
|
+
### Authorization
|
561
|
+
|
562
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
563
|
+
|
564
|
+
### HTTP request headers
|
565
|
+
|
566
|
+
- **Content-Type**: application/json
|
567
|
+
- **Accept**: application/json
|
568
|
+
|
569
|
+
|
570
|
+
|
521
571
|
# **start_conversation**
|
522
572
|
> ConversationStartResponse start_conversation(start_request)
|
523
573
|
|
data/docs/ConversationMessage.md
CHANGED
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**body** | **String** | | [optional]
|
9
9
|
**client_message_id** | **String** | | [optional]
|
10
10
|
**conversation_message_uuid** | **String** | | [optional]
|
11
|
+
**delay_until_dts** | **String** | Delay message transmission until date/time | [optional]
|
11
12
|
**media_urls** | **Array<String>** | | [optional]
|
12
13
|
**merchant_id** | **String** | | [optional]
|
13
14
|
**message_dts** | **String** | Message date/time | [optional]
|
@@ -7,5 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**excluded_items** | **Array<String>** | A list of items which cannot be discounted. | [optional]
|
8
8
|
**items** | **Array<String>** | An list of items which will receive a discount. | [optional]
|
9
9
|
**limit** | **Integer** | The (optional) maximum quantity of discounted items. | [optional]
|
10
|
+
**minimum_cumulative_msrp** | **Float** | The (optional) minimum cumulative msrp of qualifying items. | [optional]
|
11
|
+
**minimum_subtotal** | **Float** | The (optional) minimum subtotal of qualifying items. | [optional]
|
10
12
|
|
11
13
|
|
@@ -579,6 +579,60 @@ module UltracartClient
|
|
579
579
|
end
|
580
580
|
return data, status_code, headers
|
581
581
|
end
|
582
|
+
# Mark a conversation as read
|
583
|
+
# Mark a conversation as read
|
584
|
+
# @param conversation_uuid
|
585
|
+
# @param [Hash] opts the optional parameters
|
586
|
+
# @return [nil]
|
587
|
+
def mark_read_conversation(conversation_uuid, opts = {})
|
588
|
+
mark_read_conversation_with_http_info(conversation_uuid, opts)
|
589
|
+
nil
|
590
|
+
end
|
591
|
+
|
592
|
+
# Mark a conversation as read
|
593
|
+
# Mark a conversation as read
|
594
|
+
# @param conversation_uuid
|
595
|
+
# @param [Hash] opts the optional parameters
|
596
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
597
|
+
def mark_read_conversation_with_http_info(conversation_uuid, opts = {})
|
598
|
+
if @api_client.config.debugging
|
599
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.mark_read_conversation ...'
|
600
|
+
end
|
601
|
+
# verify the required parameter 'conversation_uuid' is set
|
602
|
+
if @api_client.config.client_side_validation && conversation_uuid.nil?
|
603
|
+
fail ArgumentError, "Missing the required parameter 'conversation_uuid' when calling ConversationApi.mark_read_conversation"
|
604
|
+
end
|
605
|
+
# resource path
|
606
|
+
local_var_path = '/conversation/conversations/{conversation_uuid}/markread'.sub('{' + 'conversation_uuid' + '}', conversation_uuid.to_s)
|
607
|
+
|
608
|
+
# query parameters
|
609
|
+
query_params = {}
|
610
|
+
|
611
|
+
# header parameters
|
612
|
+
header_params = {}
|
613
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
614
|
+
# HTTP header 'Accept' (if needed)
|
615
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
616
|
+
# HTTP header 'Content-Type'
|
617
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
618
|
+
|
619
|
+
# form parameters
|
620
|
+
form_params = {}
|
621
|
+
|
622
|
+
# http body (model)
|
623
|
+
post_body = nil
|
624
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
625
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
626
|
+
:header_params => header_params,
|
627
|
+
:query_params => query_params,
|
628
|
+
:form_params => form_params,
|
629
|
+
:body => post_body,
|
630
|
+
:auth_names => auth_names)
|
631
|
+
if @api_client.config.debugging
|
632
|
+
@api_client.config.logger.debug "API called: ConversationApi#mark_read_conversation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
633
|
+
end
|
634
|
+
return data, status_code, headers
|
635
|
+
end
|
582
636
|
# Start a conversation
|
583
637
|
# Start a new conversation
|
584
638
|
# @param start_request Start request
|
@@ -24,6 +24,9 @@ module UltracartClient
|
|
24
24
|
|
25
25
|
attr_accessor :conversation_message_uuid
|
26
26
|
|
27
|
+
# Delay message transmission until date/time
|
28
|
+
attr_accessor :delay_until_dts
|
29
|
+
|
27
30
|
attr_accessor :media_urls
|
28
31
|
|
29
32
|
attr_accessor :merchant_id
|
@@ -71,6 +74,7 @@ module UltracartClient
|
|
71
74
|
:'body' => :'body',
|
72
75
|
:'client_message_id' => :'client_message_id',
|
73
76
|
:'conversation_message_uuid' => :'conversation_message_uuid',
|
77
|
+
:'delay_until_dts' => :'delay_until_dts',
|
74
78
|
:'media_urls' => :'media_urls',
|
75
79
|
:'merchant_id' => :'merchant_id',
|
76
80
|
:'message_dts' => :'message_dts',
|
@@ -89,6 +93,7 @@ module UltracartClient
|
|
89
93
|
:'body' => :'String',
|
90
94
|
:'client_message_id' => :'String',
|
91
95
|
:'conversation_message_uuid' => :'String',
|
96
|
+
:'delay_until_dts' => :'String',
|
92
97
|
:'media_urls' => :'Array<String>',
|
93
98
|
:'merchant_id' => :'String',
|
94
99
|
:'message_dts' => :'String',
|
@@ -127,6 +132,10 @@ module UltracartClient
|
|
127
132
|
self.conversation_message_uuid = attributes[:'conversation_message_uuid']
|
128
133
|
end
|
129
134
|
|
135
|
+
if attributes.has_key?(:'delay_until_dts')
|
136
|
+
self.delay_until_dts = attributes[:'delay_until_dts']
|
137
|
+
end
|
138
|
+
|
130
139
|
if attributes.has_key?(:'media_urls')
|
131
140
|
if (value = attributes[:'media_urls']).is_a?(Array)
|
132
141
|
self.media_urls = value
|
@@ -197,6 +206,7 @@ module UltracartClient
|
|
197
206
|
body == o.body &&
|
198
207
|
client_message_id == o.client_message_id &&
|
199
208
|
conversation_message_uuid == o.conversation_message_uuid &&
|
209
|
+
delay_until_dts == o.delay_until_dts &&
|
200
210
|
media_urls == o.media_urls &&
|
201
211
|
merchant_id == o.merchant_id &&
|
202
212
|
message_dts == o.message_dts &&
|
@@ -215,7 +225,7 @@ module UltracartClient
|
|
215
225
|
# Calculates hash code according to all attributes.
|
216
226
|
# @return [Fixnum] Hash code
|
217
227
|
def hash
|
218
|
-
[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
|
228
|
+
[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
|
219
229
|
end
|
220
230
|
|
221
231
|
# Builds the object from hash
|
@@ -26,13 +26,21 @@ module UltracartClient
|
|
26
26
|
# The (optional) maximum quantity of discounted items.
|
27
27
|
attr_accessor :limit
|
28
28
|
|
29
|
+
# The (optional) minimum cumulative msrp of qualifying items.
|
30
|
+
attr_accessor :minimum_cumulative_msrp
|
31
|
+
|
32
|
+
# The (optional) minimum subtotal of qualifying items.
|
33
|
+
attr_accessor :minimum_subtotal
|
34
|
+
|
29
35
|
# Attribute mapping from ruby-style variable name to JSON key.
|
30
36
|
def self.attribute_map
|
31
37
|
{
|
32
38
|
:'discount_percent' => :'discount_percent',
|
33
39
|
:'excluded_items' => :'excluded_items',
|
34
40
|
:'items' => :'items',
|
35
|
-
:'limit' => :'limit'
|
41
|
+
:'limit' => :'limit',
|
42
|
+
:'minimum_cumulative_msrp' => :'minimum_cumulative_msrp',
|
43
|
+
:'minimum_subtotal' => :'minimum_subtotal'
|
36
44
|
}
|
37
45
|
end
|
38
46
|
|
@@ -42,7 +50,9 @@ module UltracartClient
|
|
42
50
|
:'discount_percent' => :'Float',
|
43
51
|
:'excluded_items' => :'Array<String>',
|
44
52
|
:'items' => :'Array<String>',
|
45
|
-
:'limit' => :'Integer'
|
53
|
+
:'limit' => :'Integer',
|
54
|
+
:'minimum_cumulative_msrp' => :'Float',
|
55
|
+
:'minimum_subtotal' => :'Float'
|
46
56
|
}
|
47
57
|
end
|
48
58
|
|
@@ -73,6 +83,14 @@ module UltracartClient
|
|
73
83
|
if attributes.has_key?(:'limit')
|
74
84
|
self.limit = attributes[:'limit']
|
75
85
|
end
|
86
|
+
|
87
|
+
if attributes.has_key?(:'minimum_cumulative_msrp')
|
88
|
+
self.minimum_cumulative_msrp = attributes[:'minimum_cumulative_msrp']
|
89
|
+
end
|
90
|
+
|
91
|
+
if attributes.has_key?(:'minimum_subtotal')
|
92
|
+
self.minimum_subtotal = attributes[:'minimum_subtotal']
|
93
|
+
end
|
76
94
|
end
|
77
95
|
|
78
96
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -96,7 +114,9 @@ module UltracartClient
|
|
96
114
|
discount_percent == o.discount_percent &&
|
97
115
|
excluded_items == o.excluded_items &&
|
98
116
|
items == o.items &&
|
99
|
-
limit == o.limit
|
117
|
+
limit == o.limit &&
|
118
|
+
minimum_cumulative_msrp == o.minimum_cumulative_msrp &&
|
119
|
+
minimum_subtotal == o.minimum_subtotal
|
100
120
|
end
|
101
121
|
|
102
122
|
# @see the `==` method
|
@@ -108,7 +128,7 @@ module UltracartClient
|
|
108
128
|
# Calculates hash code according to all attributes.
|
109
129
|
# @return [Fixnum] Hash code
|
110
130
|
def hash
|
111
|
-
[discount_percent, excluded_items, items, limit].hash
|
131
|
+
[discount_percent, excluded_items, items, limit, minimum_cumulative_msrp, minimum_subtotal].hash
|
112
132
|
end
|
113
133
|
|
114
134
|
# 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.71
|
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
|