ultracart_api 4.1.99 → 4.1.100
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 +3 -2
- data/docs/WebhookApi.md +9 -0
- data/docs/WebhookLog.md +4 -0
- data/docs/WebhookLogSummary.md +8 -0
- data/lib/ultracart_api/api/webhook_api.rb +27 -0
- data/lib/ultracart_api/models/webhook_log.rb +25 -1
- data/lib/ultracart_api/models/webhook_log_summary.rb +45 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e7a303f3bed2f17419b03f618b74e08c3c8c6dc6abd8d60574eaeffc57113b0b
|
|
4
|
+
data.tar.gz: dc72bdb2ca0f71b51d84727e3a777d379e01898ae10f9e6945a0a980d0adf999
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 99ffb91087ff03deb5049f6056de8adce790f2ba32c31c8e7b97df6748b7f7de5aa8e7a71caf2637922e883807091eed0498feb7f1cb4b9a229e965b8f89c3c5
|
|
7
|
+
data.tar.gz: 46f4a9bf5529f74e8aa03d64f4e864ad8417010d32f3bc1f8bc7f82137a7685d72dbebe9db169efd58f711b1f7400a1dc0464396b1cd2636d88af3daea04a560
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
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.1.
|
|
10
|
+
- Package version: 4.1.100
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.100'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -1775,6 +1775,7 @@ Not every change is committed to every SDK.
|
|
|
1775
1775
|
|
|
1776
1776
|
| Version | Date | Comments |
|
|
1777
1777
|
| --: | :-: | --- |
|
|
1778
|
+
| 4.1.100 | 06/05/2026 | webhook log summary filtering |
|
|
1778
1779
|
| 4.1.99 | 06/05/2026 | added webhook name and merchant_comments |
|
|
1779
1780
|
| 4.1.98 | 06/04/2026 | coupon - new coupon type for amount off items with free shipping |
|
|
1780
1781
|
| 4.1.97 | 06/03/2026 | fraud api alpha version |
|
data/docs/WebhookApi.md
CHANGED
|
@@ -362,6 +362,15 @@ end
|
|
|
362
362
|
| Name | Type | Description | Notes |
|
|
363
363
|
| ---- | ---- | ----------- | ----- |
|
|
364
364
|
| **webhook_oid** | **Integer** | The webhook oid to retrieve log summaries for. | |
|
|
365
|
+
| **request_id** | **String** | Filter by request id | [optional] |
|
|
366
|
+
| **begin_date** | **String** | Filter to deliveries on or after this date/time | [optional] |
|
|
367
|
+
| **end_date** | **String** | Filter to deliveries on or before this date/time | [optional] |
|
|
368
|
+
| **status** | **String** | Filter by HTTP status code | [optional] |
|
|
369
|
+
| **success** | **Boolean** | Filter by success (true) or failure (false) | [optional] |
|
|
370
|
+
| **event** | **String** | Filter by an event name contained in the delivery | [optional] |
|
|
371
|
+
| **order_id** | **String** | Filter by an order id contained in the delivery | [optional] |
|
|
372
|
+
| **request** | **String** | Filter by text contained in the request payload | [optional] |
|
|
373
|
+
| **duration** | **Integer** | Filter to deliveries that took at least this many milliseconds | [optional] |
|
|
365
374
|
| **_limit** | **Integer** | The maximum number of records to return on this one API call. | [optional][default to 100] |
|
|
366
375
|
| **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
|
|
367
376
|
| **_since** | **String** | Fetch log summaries that have been delivered since this date/time. | [optional] |
|
data/docs/WebhookLog.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **delivery_dts** | **String** | Date/time of delivery | [optional] |
|
|
8
8
|
| **duration** | **Integer** | Number of milliseconds to process the notification | [optional] |
|
|
9
|
+
| **event_names** | **Array<String>** | Event names contained in this delivery | [optional] |
|
|
10
|
+
| **order_ids** | **Array<String>** | Order ids contained in this delivery | [optional] |
|
|
9
11
|
| **queue_delay** | **Integer** | Number of milliseconds of delay caused by queuing | [optional] |
|
|
10
12
|
| **request** | **String** | Request payload (first 100,000 characters) | [optional] |
|
|
11
13
|
| **request_headers** | [**Array<HTTPHeader>**](HTTPHeader.md) | Request headers sent to the server | [optional] |
|
|
@@ -25,6 +27,8 @@ require 'ultracart_api'
|
|
|
25
27
|
instance = UltracartClient::WebhookLog.new(
|
|
26
28
|
delivery_dts: null,
|
|
27
29
|
duration: null,
|
|
30
|
+
event_names: null,
|
|
31
|
+
order_ids: null,
|
|
28
32
|
queue_delay: null,
|
|
29
33
|
request: null,
|
|
30
34
|
request_headers: null,
|
data/docs/WebhookLogSummary.md
CHANGED
|
@@ -5,7 +5,11 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **delivery_dts** | **String** | Date/time of the delivery | [optional] |
|
|
8
|
+
| **duration** | **Integer** | Number of milliseconds to process the notification | [optional] |
|
|
9
|
+
| **event_names** | **Array<String>** | Event names contained in this delivery | [optional] |
|
|
10
|
+
| **order_ids** | **Array<String>** | Order ids contained in this delivery | [optional] |
|
|
8
11
|
| **request_id** | **String** | Request id | [optional] |
|
|
12
|
+
| **status_code** | **Integer** | HTTP status code received from the server | [optional] |
|
|
9
13
|
| **success** | **Boolean** | True if the notification was successful | [optional] |
|
|
10
14
|
|
|
11
15
|
## Example
|
|
@@ -15,7 +19,11 @@ require 'ultracart_api'
|
|
|
15
19
|
|
|
16
20
|
instance = UltracartClient::WebhookLogSummary.new(
|
|
17
21
|
delivery_dts: null,
|
|
22
|
+
duration: null,
|
|
23
|
+
event_names: null,
|
|
24
|
+
order_ids: null,
|
|
18
25
|
request_id: null,
|
|
26
|
+
status_code: null,
|
|
19
27
|
success: null
|
|
20
28
|
)
|
|
21
29
|
```
|
|
@@ -297,6 +297,15 @@ module UltracartClient
|
|
|
297
297
|
# Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
298
298
|
# @param webhook_oid [Integer] The webhook oid to retrieve log summaries for.
|
|
299
299
|
# @param [Hash] opts the optional parameters
|
|
300
|
+
# @option opts [String] :request_id Filter by request id
|
|
301
|
+
# @option opts [String] :begin_date Filter to deliveries on or after this date/time
|
|
302
|
+
# @option opts [String] :end_date Filter to deliveries on or before this date/time
|
|
303
|
+
# @option opts [String] :status Filter by HTTP status code
|
|
304
|
+
# @option opts [Boolean] :success Filter by success (true) or failure (false)
|
|
305
|
+
# @option opts [String] :event Filter by an event name contained in the delivery
|
|
306
|
+
# @option opts [String] :order_id Filter by an order id contained in the delivery
|
|
307
|
+
# @option opts [String] :request Filter by text contained in the request payload
|
|
308
|
+
# @option opts [Integer] :duration Filter to deliveries that took at least this many milliseconds
|
|
300
309
|
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (default to 100)
|
|
301
310
|
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
|
|
302
311
|
# @option opts [String] :_since Fetch log summaries that have been delivered since this date/time.
|
|
@@ -310,6 +319,15 @@ module UltracartClient
|
|
|
310
319
|
# Retrieves the log summary information for a given webhook. This is useful for displaying all the various logs that can be viewed.
|
|
311
320
|
# @param webhook_oid [Integer] The webhook oid to retrieve log summaries for.
|
|
312
321
|
# @param [Hash] opts the optional parameters
|
|
322
|
+
# @option opts [String] :request_id Filter by request id
|
|
323
|
+
# @option opts [String] :begin_date Filter to deliveries on or after this date/time
|
|
324
|
+
# @option opts [String] :end_date Filter to deliveries on or before this date/time
|
|
325
|
+
# @option opts [String] :status Filter by HTTP status code
|
|
326
|
+
# @option opts [Boolean] :success Filter by success (true) or failure (false)
|
|
327
|
+
# @option opts [String] :event Filter by an event name contained in the delivery
|
|
328
|
+
# @option opts [String] :order_id Filter by an order id contained in the delivery
|
|
329
|
+
# @option opts [String] :request Filter by text contained in the request payload
|
|
330
|
+
# @option opts [Integer] :duration Filter to deliveries that took at least this many milliseconds
|
|
313
331
|
# @option opts [Integer] :_limit The maximum number of records to return on this one API call. (default to 100)
|
|
314
332
|
# @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
|
|
315
333
|
# @option opts [String] :_since Fetch log summaries that have been delivered since this date/time.
|
|
@@ -327,6 +345,15 @@ module UltracartClient
|
|
|
327
345
|
|
|
328
346
|
# query parameters
|
|
329
347
|
query_params = opts[:query_params] || {}
|
|
348
|
+
query_params[:'requestId'] = opts[:'request_id'] if !opts[:'request_id'].nil?
|
|
349
|
+
query_params[:'beginDate'] = opts[:'begin_date'] if !opts[:'begin_date'].nil?
|
|
350
|
+
query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
|
351
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
352
|
+
query_params[:'success'] = opts[:'success'] if !opts[:'success'].nil?
|
|
353
|
+
query_params[:'event'] = opts[:'event'] if !opts[:'event'].nil?
|
|
354
|
+
query_params[:'orderId'] = opts[:'order_id'] if !opts[:'order_id'].nil?
|
|
355
|
+
query_params[:'request'] = opts[:'request'] if !opts[:'request'].nil?
|
|
356
|
+
query_params[:'duration'] = opts[:'duration'] if !opts[:'duration'].nil?
|
|
330
357
|
query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
|
|
331
358
|
query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
|
|
332
359
|
query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
|
|
@@ -21,6 +21,12 @@ module UltracartClient
|
|
|
21
21
|
# Number of milliseconds to process the notification
|
|
22
22
|
attr_accessor :duration
|
|
23
23
|
|
|
24
|
+
# Event names contained in this delivery
|
|
25
|
+
attr_accessor :event_names
|
|
26
|
+
|
|
27
|
+
# Order ids contained in this delivery
|
|
28
|
+
attr_accessor :order_ids
|
|
29
|
+
|
|
24
30
|
# Number of milliseconds of delay caused by queuing
|
|
25
31
|
attr_accessor :queue_delay
|
|
26
32
|
|
|
@@ -56,6 +62,8 @@ module UltracartClient
|
|
|
56
62
|
{
|
|
57
63
|
:'delivery_dts' => :'delivery_dts',
|
|
58
64
|
:'duration' => :'duration',
|
|
65
|
+
:'event_names' => :'event_names',
|
|
66
|
+
:'order_ids' => :'order_ids',
|
|
59
67
|
:'queue_delay' => :'queue_delay',
|
|
60
68
|
:'request' => :'request',
|
|
61
69
|
:'request_headers' => :'request_headers',
|
|
@@ -79,6 +87,8 @@ module UltracartClient
|
|
|
79
87
|
{
|
|
80
88
|
:'delivery_dts' => :'String',
|
|
81
89
|
:'duration' => :'Integer',
|
|
90
|
+
:'event_names' => :'Array<String>',
|
|
91
|
+
:'order_ids' => :'Array<String>',
|
|
82
92
|
:'queue_delay' => :'Integer',
|
|
83
93
|
:'request' => :'String',
|
|
84
94
|
:'request_headers' => :'Array<HTTPHeader>',
|
|
@@ -121,6 +131,18 @@ module UltracartClient
|
|
|
121
131
|
self.duration = attributes[:'duration']
|
|
122
132
|
end
|
|
123
133
|
|
|
134
|
+
if attributes.key?(:'event_names')
|
|
135
|
+
if (value = attributes[:'event_names']).is_a?(Array)
|
|
136
|
+
self.event_names = value
|
|
137
|
+
end
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
if attributes.key?(:'order_ids')
|
|
141
|
+
if (value = attributes[:'order_ids']).is_a?(Array)
|
|
142
|
+
self.order_ids = value
|
|
143
|
+
end
|
|
144
|
+
end
|
|
145
|
+
|
|
124
146
|
if attributes.key?(:'queue_delay')
|
|
125
147
|
self.queue_delay = attributes[:'queue_delay']
|
|
126
148
|
end
|
|
@@ -186,6 +208,8 @@ module UltracartClient
|
|
|
186
208
|
self.class == o.class &&
|
|
187
209
|
delivery_dts == o.delivery_dts &&
|
|
188
210
|
duration == o.duration &&
|
|
211
|
+
event_names == o.event_names &&
|
|
212
|
+
order_ids == o.order_ids &&
|
|
189
213
|
queue_delay == o.queue_delay &&
|
|
190
214
|
request == o.request &&
|
|
191
215
|
request_headers == o.request_headers &&
|
|
@@ -207,7 +231,7 @@ module UltracartClient
|
|
|
207
231
|
# Calculates hash code according to all attributes.
|
|
208
232
|
# @return [Integer] Hash code
|
|
209
233
|
def hash
|
|
210
|
-
[delivery_dts, duration, queue_delay, request, request_headers, request_id, response, response_headers, status_code, success, uri, webhook_oid].hash
|
|
234
|
+
[delivery_dts, duration, event_names, order_ids, queue_delay, request, request_headers, request_id, response, response_headers, status_code, success, uri, webhook_oid].hash
|
|
211
235
|
end
|
|
212
236
|
|
|
213
237
|
# Builds the object from hash
|
|
@@ -18,9 +18,21 @@ module UltracartClient
|
|
|
18
18
|
# Date/time of the delivery
|
|
19
19
|
attr_accessor :delivery_dts
|
|
20
20
|
|
|
21
|
+
# Number of milliseconds to process the notification
|
|
22
|
+
attr_accessor :duration
|
|
23
|
+
|
|
24
|
+
# Event names contained in this delivery
|
|
25
|
+
attr_accessor :event_names
|
|
26
|
+
|
|
27
|
+
# Order ids contained in this delivery
|
|
28
|
+
attr_accessor :order_ids
|
|
29
|
+
|
|
21
30
|
# Request id
|
|
22
31
|
attr_accessor :request_id
|
|
23
32
|
|
|
33
|
+
# HTTP status code received from the server
|
|
34
|
+
attr_accessor :status_code
|
|
35
|
+
|
|
24
36
|
# True if the notification was successful
|
|
25
37
|
attr_accessor :success
|
|
26
38
|
|
|
@@ -28,7 +40,11 @@ module UltracartClient
|
|
|
28
40
|
def self.attribute_map
|
|
29
41
|
{
|
|
30
42
|
:'delivery_dts' => :'delivery_dts',
|
|
43
|
+
:'duration' => :'duration',
|
|
44
|
+
:'event_names' => :'event_names',
|
|
45
|
+
:'order_ids' => :'order_ids',
|
|
31
46
|
:'request_id' => :'request_id',
|
|
47
|
+
:'status_code' => :'status_code',
|
|
32
48
|
:'success' => :'success'
|
|
33
49
|
}
|
|
34
50
|
end
|
|
@@ -42,7 +58,11 @@ module UltracartClient
|
|
|
42
58
|
def self.openapi_types
|
|
43
59
|
{
|
|
44
60
|
:'delivery_dts' => :'String',
|
|
61
|
+
:'duration' => :'Integer',
|
|
62
|
+
:'event_names' => :'Array<String>',
|
|
63
|
+
:'order_ids' => :'Array<String>',
|
|
45
64
|
:'request_id' => :'String',
|
|
65
|
+
:'status_code' => :'Integer',
|
|
46
66
|
:'success' => :'Boolean'
|
|
47
67
|
}
|
|
48
68
|
end
|
|
@@ -72,10 +92,30 @@ module UltracartClient
|
|
|
72
92
|
self.delivery_dts = attributes[:'delivery_dts']
|
|
73
93
|
end
|
|
74
94
|
|
|
95
|
+
if attributes.key?(:'duration')
|
|
96
|
+
self.duration = attributes[:'duration']
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
if attributes.key?(:'event_names')
|
|
100
|
+
if (value = attributes[:'event_names']).is_a?(Array)
|
|
101
|
+
self.event_names = value
|
|
102
|
+
end
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
if attributes.key?(:'order_ids')
|
|
106
|
+
if (value = attributes[:'order_ids']).is_a?(Array)
|
|
107
|
+
self.order_ids = value
|
|
108
|
+
end
|
|
109
|
+
end
|
|
110
|
+
|
|
75
111
|
if attributes.key?(:'request_id')
|
|
76
112
|
self.request_id = attributes[:'request_id']
|
|
77
113
|
end
|
|
78
114
|
|
|
115
|
+
if attributes.key?(:'status_code')
|
|
116
|
+
self.status_code = attributes[:'status_code']
|
|
117
|
+
end
|
|
118
|
+
|
|
79
119
|
if attributes.key?(:'success')
|
|
80
120
|
self.success = attributes[:'success']
|
|
81
121
|
end
|
|
@@ -100,7 +140,11 @@ module UltracartClient
|
|
|
100
140
|
return true if self.equal?(o)
|
|
101
141
|
self.class == o.class &&
|
|
102
142
|
delivery_dts == o.delivery_dts &&
|
|
143
|
+
duration == o.duration &&
|
|
144
|
+
event_names == o.event_names &&
|
|
145
|
+
order_ids == o.order_ids &&
|
|
103
146
|
request_id == o.request_id &&
|
|
147
|
+
status_code == o.status_code &&
|
|
104
148
|
success == o.success
|
|
105
149
|
end
|
|
106
150
|
|
|
@@ -113,7 +157,7 @@ module UltracartClient
|
|
|
113
157
|
# Calculates hash code according to all attributes.
|
|
114
158
|
# @return [Integer] Hash code
|
|
115
159
|
def hash
|
|
116
|
-
[delivery_dts, request_id, success].hash
|
|
160
|
+
[delivery_dts, duration, event_names, order_ids, request_id, status_code, success].hash
|
|
117
161
|
end
|
|
118
162
|
|
|
119
163
|
# Builds the object from hash
|