checkout-intents 0.6.0 → 0.7.0
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/CHANGELOG.md +21 -0
- data/README.md +1 -1
- data/lib/checkout_intents/models/product.rb +91 -1
- data/lib/checkout_intents/models/shipment.rb +182 -56
- data/lib/checkout_intents/models/shipment_tracking.rb +19 -5
- data/lib/checkout_intents/version.rb +1 -1
- data/rbi/checkout_intents/models/product.rbi +147 -3
- data/rbi/checkout_intents/models/shipment.rbi +260 -52
- data/rbi/checkout_intents/models/shipment_tracking.rbi +40 -10
- data/sig/checkout_intents/models/product.rbs +75 -3
- data/sig/checkout_intents/models/shipment.rbs +80 -52
- data/sig/checkout_intents/models/shipment_tracking.rbs +14 -4
- 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: 2e6a738279554d9f65a411cd5d8475cbce024a705696876fed888ce2e58c7fb5
|
|
4
|
+
data.tar.gz: dec6c733a985601e4faf948670ffe7a5a96ae4519580cc63d0f36a7d9df7db72
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 03e9be985efaa9946f6a5807c7f098788fbb20392af6d027d92d34c48bbc016c69b00bfa809bdc96053eccb191a95793b56104bcd3ce6ebb2ff3416cb066d657
|
|
7
|
+
data.tar.gz: 9c150551abddfef046a323bb5a32b3f955ee66b9ee9e587bbd55892f312d7bd283c04354877f283ecd21aa501072a2192df1be80a2d6239899a6b5b484093c63
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.7.0 (2026-03-07)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.6.0...v0.7.0](https://github.com/rye-com/checkout-intents-ruby/compare/v0.6.0...v0.7.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* add variant types and wire through extraction pipeline (RYE-6876) ([4d90f56](https://github.com/rye-com/checkout-intents-ruby/commit/4d90f5640f2abb45d6a7b1c7e3385118f4bba6f7))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Bug Fixes
|
|
13
|
+
|
|
14
|
+
* handle [@type](https://github.com/type) array and AggregateOffer array in JSON-LD parser ([37533f9](https://github.com/rye-com/checkout-intents-ruby/commit/37533f93ebc03a0164626535b7832a8c9181707f))
|
|
15
|
+
* **internal:** missing imports ([44f5484](https://github.com/rye-com/checkout-intents-ruby/commit/44f5484ebd8caa4bc01174d7d0c692bb3ff2c8ee))
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Chores
|
|
19
|
+
|
|
20
|
+
* **internal:** format and fix absolute references ([894137b](https://github.com/rye-com/checkout-intents-ruby/commit/894137b268199fe83dffed5464a77c4d41f77e8d))
|
|
21
|
+
* **internal:** improvements ([9abfe08](https://github.com/rye-com/checkout-intents-ruby/commit/9abfe0853ef6f0949e9f56501561db3b9a451d98))
|
|
22
|
+
* **internal:** improvements ([63be470](https://github.com/rye-com/checkout-intents-ruby/commit/63be470fe4430ed0bf6aac561474988d23f54e21))
|
|
23
|
+
|
|
3
24
|
## 0.6.0 (2026-02-28)
|
|
4
25
|
|
|
5
26
|
Full Changelog: [v0.5.0...v0.6.0](https://github.com/rye-com/checkout-intents-ruby/compare/v0.5.0...v0.6.0)
|
data/README.md
CHANGED
|
@@ -61,7 +61,21 @@ module CheckoutIntents
|
|
|
61
61
|
# @return [String]
|
|
62
62
|
required :url, String
|
|
63
63
|
|
|
64
|
-
# @!
|
|
64
|
+
# @!attribute variant_dimensions
|
|
65
|
+
#
|
|
66
|
+
# @return [Array<::CheckoutIntents::Models::Product::VariantDimension>, nil]
|
|
67
|
+
optional :variant_dimensions,
|
|
68
|
+
-> {
|
|
69
|
+
::CheckoutIntents::Internal::Type::ArrayOf[::CheckoutIntents::Product::VariantDimension]
|
|
70
|
+
},
|
|
71
|
+
api_name: :variantDimensions
|
|
72
|
+
|
|
73
|
+
# @!attribute variants
|
|
74
|
+
#
|
|
75
|
+
# @return [Array<::CheckoutIntents::Models::Product::Variant>, nil]
|
|
76
|
+
optional :variants, -> { ::CheckoutIntents::Internal::Type::ArrayOf[::CheckoutIntents::Product::Variant] }
|
|
77
|
+
|
|
78
|
+
# @!method initialize(id:, availability:, brand:, description:, images:, is_purchasable:, name:, price:, sku:, url:, variant_dimensions: nil, variants: nil)
|
|
65
79
|
# Some parameter documentations has been truncated, see
|
|
66
80
|
# {::CheckoutIntents::Models::Product} for more details.
|
|
67
81
|
#
|
|
@@ -84,6 +98,82 @@ module CheckoutIntents
|
|
|
84
98
|
# @param sku [String, nil]
|
|
85
99
|
#
|
|
86
100
|
# @param url [String]
|
|
101
|
+
#
|
|
102
|
+
# @param variant_dimensions [Array<::CheckoutIntents::Models::Product::VariantDimension>]
|
|
103
|
+
#
|
|
104
|
+
# @param variants [Array<::CheckoutIntents::Models::Product::Variant>]
|
|
105
|
+
|
|
106
|
+
class VariantDimension < ::CheckoutIntents::Internal::Type::BaseModel
|
|
107
|
+
# @!attribute name
|
|
108
|
+
#
|
|
109
|
+
# @return [String]
|
|
110
|
+
required :name, String
|
|
111
|
+
|
|
112
|
+
# @!attribute values
|
|
113
|
+
#
|
|
114
|
+
# @return [Array<String>]
|
|
115
|
+
required :values, ::CheckoutIntents::Internal::Type::ArrayOf[String]
|
|
116
|
+
|
|
117
|
+
# @!method initialize(name:, values:)
|
|
118
|
+
# @param name [String]
|
|
119
|
+
# @param values [Array<String>]
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
class Variant < ::CheckoutIntents::Internal::Type::BaseModel
|
|
123
|
+
# @!attribute attributes
|
|
124
|
+
# Construct a type with a set of properties K of type T
|
|
125
|
+
#
|
|
126
|
+
# @return [Hash{Symbol=>String}]
|
|
127
|
+
required :attributes, ::CheckoutIntents::Internal::Type::HashOf[String]
|
|
128
|
+
|
|
129
|
+
# @!attribute availability
|
|
130
|
+
# The availability status of a product.
|
|
131
|
+
#
|
|
132
|
+
# - `in_stock`: Product is available for immediate purchase
|
|
133
|
+
# - `out_of_stock`: Product is currently unavailable
|
|
134
|
+
# - `preorder`: Product is available for pre-order before release
|
|
135
|
+
# - `backorder`: Product is temporarily out of stock but can be ordered
|
|
136
|
+
# - `unknown`: Availability could not be determined
|
|
137
|
+
#
|
|
138
|
+
# @return [Symbol, ::CheckoutIntents::Models::ProductAvailability]
|
|
139
|
+
required :availability, enum: -> { ::CheckoutIntents::ProductAvailability }
|
|
140
|
+
|
|
141
|
+
# @!attribute images
|
|
142
|
+
#
|
|
143
|
+
# @return [Array<::CheckoutIntents::Models::ProductImage>]
|
|
144
|
+
required :images, -> { ::CheckoutIntents::Internal::Type::ArrayOf[::CheckoutIntents::ProductImage] }
|
|
145
|
+
|
|
146
|
+
# @!attribute name
|
|
147
|
+
#
|
|
148
|
+
# @return [String, nil]
|
|
149
|
+
required :name, String, nil?: true
|
|
150
|
+
|
|
151
|
+
# @!attribute price
|
|
152
|
+
#
|
|
153
|
+
# @return [::CheckoutIntents::Models::Money]
|
|
154
|
+
required :price, -> { ::CheckoutIntents::Money }
|
|
155
|
+
|
|
156
|
+
# @!attribute sku
|
|
157
|
+
#
|
|
158
|
+
# @return [String, nil]
|
|
159
|
+
required :sku, String, nil?: true
|
|
160
|
+
|
|
161
|
+
# @!method initialize(attributes:, availability:, images:, name:, price:, sku:)
|
|
162
|
+
# Some parameter documentations has been truncated, see
|
|
163
|
+
# {::CheckoutIntents::Models::Product::Variant} for more details.
|
|
164
|
+
#
|
|
165
|
+
# @param attributes [Hash{Symbol=>String}] Construct a type with a set of properties K of type T
|
|
166
|
+
#
|
|
167
|
+
# @param availability [Symbol, ::CheckoutIntents::Models::ProductAvailability] The availability status of a product.
|
|
168
|
+
#
|
|
169
|
+
# @param images [Array<::CheckoutIntents::Models::ProductImage>]
|
|
170
|
+
#
|
|
171
|
+
# @param name [String, nil]
|
|
172
|
+
#
|
|
173
|
+
# @param price [::CheckoutIntents::Models::Money]
|
|
174
|
+
#
|
|
175
|
+
# @param sku [String, nil]
|
|
176
|
+
end
|
|
87
177
|
end
|
|
88
178
|
end
|
|
89
179
|
end
|
|
@@ -35,6 +35,8 @@ module CheckoutIntents
|
|
|
35
35
|
required :created_at, Time, api_name: :createdAt
|
|
36
36
|
|
|
37
37
|
# @!attribute external_id
|
|
38
|
+
# The external ID is provided by the marketplace and matches the shipment to their
|
|
39
|
+
# system.
|
|
38
40
|
#
|
|
39
41
|
# @return [String]
|
|
40
42
|
required :external_id, String, api_name: :externalId
|
|
@@ -70,14 +72,26 @@ module CheckoutIntents
|
|
|
70
72
|
required :updated_at, Time, api_name: :updatedAt
|
|
71
73
|
|
|
72
74
|
# @!method initialize(id:, checkout_intent_id:, created_at:, external_id:, shipped_at:, status:, tracking:, tracking_events:, updated_at:)
|
|
75
|
+
# Some parameter documentations has been truncated, see
|
|
76
|
+
# {::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingShipped}
|
|
77
|
+
# for more details.
|
|
78
|
+
#
|
|
73
79
|
# @param id [String]
|
|
80
|
+
#
|
|
74
81
|
# @param checkout_intent_id [String]
|
|
82
|
+
#
|
|
75
83
|
# @param created_at [Time]
|
|
76
|
-
#
|
|
84
|
+
#
|
|
85
|
+
# @param external_id [String] The external ID is provided by the marketplace and matches the shipment to their
|
|
86
|
+
#
|
|
77
87
|
# @param shipped_at [Time]
|
|
88
|
+
#
|
|
78
89
|
# @param status [Symbol, ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingShipped::Status]
|
|
90
|
+
#
|
|
79
91
|
# @param tracking [::CheckoutIntents::Models::ShipmentTracking]
|
|
92
|
+
#
|
|
80
93
|
# @param tracking_events [Array<::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingShipped::TrackingEvent>]
|
|
94
|
+
#
|
|
81
95
|
# @param updated_at [Time]
|
|
82
96
|
|
|
83
97
|
# @see ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingShipped#status
|
|
@@ -96,27 +110,25 @@ module CheckoutIntents
|
|
|
96
110
|
# @return [String, nil]
|
|
97
111
|
required :description, String, nil?: true
|
|
98
112
|
|
|
99
|
-
# @!attribute display_date
|
|
100
|
-
#
|
|
101
|
-
# @return [String, nil]
|
|
102
|
-
required :display_date, String, api_name: :displayDate, nil?: true
|
|
103
|
-
|
|
104
|
-
# @!attribute display_time
|
|
105
|
-
#
|
|
106
|
-
# @return [String, nil]
|
|
107
|
-
required :display_time, String, api_name: :displayTime, nil?: true
|
|
108
|
-
|
|
109
113
|
# @!attribute location
|
|
110
114
|
#
|
|
111
115
|
# @return [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingShipped::TrackingEvent::Location]
|
|
112
116
|
required :location,
|
|
113
117
|
-> { ::CheckoutIntents::Shipment::WithStatusBaseShipmentWithTrackingShipped::TrackingEvent::Location }
|
|
114
118
|
|
|
115
|
-
# @!
|
|
119
|
+
# @!attribute timestamp
|
|
120
|
+
#
|
|
121
|
+
# @return [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingShipped::TrackingEvent::Timestamp, nil]
|
|
122
|
+
required :timestamp,
|
|
123
|
+
-> {
|
|
124
|
+
::CheckoutIntents::Shipment::WithStatusBaseShipmentWithTrackingShipped::TrackingEvent::Timestamp
|
|
125
|
+
},
|
|
126
|
+
nil?: true
|
|
127
|
+
|
|
128
|
+
# @!method initialize(description:, location:, timestamp:)
|
|
116
129
|
# @param description [String, nil]
|
|
117
|
-
# @param display_date [String, nil]
|
|
118
|
-
# @param display_time [String, nil]
|
|
119
130
|
# @param location [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingShipped::TrackingEvent::Location]
|
|
131
|
+
# @param timestamp [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingShipped::TrackingEvent::Timestamp, nil]
|
|
120
132
|
|
|
121
133
|
# @see ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingShipped::TrackingEvent#location
|
|
122
134
|
class Location < ::CheckoutIntents::Internal::Type::BaseModel
|
|
@@ -140,6 +152,26 @@ module CheckoutIntents
|
|
|
140
152
|
# @param country [String, nil]
|
|
141
153
|
# @param province [String, nil]
|
|
142
154
|
end
|
|
155
|
+
|
|
156
|
+
# @see ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingShipped::TrackingEvent#timestamp
|
|
157
|
+
class Timestamp < ::CheckoutIntents::Internal::Type::BaseModel
|
|
158
|
+
# @!attribute local
|
|
159
|
+
# ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
|
|
160
|
+
#
|
|
161
|
+
# @return [String]
|
|
162
|
+
required :local, String
|
|
163
|
+
|
|
164
|
+
# @!attribute utc
|
|
165
|
+
# UTC timestamp
|
|
166
|
+
#
|
|
167
|
+
# @return [Time]
|
|
168
|
+
required :utc, Time
|
|
169
|
+
|
|
170
|
+
# @!method initialize(local:, utc:)
|
|
171
|
+
# @param local [String] ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
|
|
172
|
+
#
|
|
173
|
+
# @param utc [Time] UTC timestamp
|
|
174
|
+
end
|
|
143
175
|
end
|
|
144
176
|
end
|
|
145
177
|
|
|
@@ -165,6 +197,8 @@ module CheckoutIntents
|
|
|
165
197
|
required :delivered_at, Time, api_name: :deliveredAt
|
|
166
198
|
|
|
167
199
|
# @!attribute external_id
|
|
200
|
+
# The external ID is provided by the marketplace and matches the shipment to their
|
|
201
|
+
# system.
|
|
168
202
|
#
|
|
169
203
|
# @return [String]
|
|
170
204
|
required :external_id, String, api_name: :externalId
|
|
@@ -199,15 +233,27 @@ module CheckoutIntents
|
|
|
199
233
|
required :updated_at, Time, api_name: :updatedAt
|
|
200
234
|
|
|
201
235
|
# @!method initialize(id:, checkout_intent_id:, created_at:, delivered_at:, external_id:, shipped_at:, status:, tracking:, tracking_events:, updated_at:)
|
|
236
|
+
# Some parameter documentations has been truncated, see
|
|
237
|
+
# {::CheckoutIntents::Models::Shipment::DeliveredShipment} for more details.
|
|
238
|
+
#
|
|
202
239
|
# @param id [String]
|
|
240
|
+
#
|
|
203
241
|
# @param checkout_intent_id [String]
|
|
242
|
+
#
|
|
204
243
|
# @param created_at [Time]
|
|
244
|
+
#
|
|
205
245
|
# @param delivered_at [Time]
|
|
206
|
-
#
|
|
246
|
+
#
|
|
247
|
+
# @param external_id [String] The external ID is provided by the marketplace and matches the shipment to their
|
|
248
|
+
#
|
|
207
249
|
# @param shipped_at [Time]
|
|
250
|
+
#
|
|
208
251
|
# @param status [Symbol, ::CheckoutIntents::Models::Shipment::DeliveredShipment::Status]
|
|
252
|
+
#
|
|
209
253
|
# @param tracking [::CheckoutIntents::Models::ShipmentTracking]
|
|
254
|
+
#
|
|
210
255
|
# @param tracking_events [Array<::CheckoutIntents::Models::Shipment::DeliveredShipment::TrackingEvent>]
|
|
256
|
+
#
|
|
211
257
|
# @param updated_at [Time]
|
|
212
258
|
|
|
213
259
|
# @see ::CheckoutIntents::Models::Shipment::DeliveredShipment#status
|
|
@@ -226,26 +272,22 @@ module CheckoutIntents
|
|
|
226
272
|
# @return [String, nil]
|
|
227
273
|
required :description, String, nil?: true
|
|
228
274
|
|
|
229
|
-
# @!attribute display_date
|
|
230
|
-
#
|
|
231
|
-
# @return [String, nil]
|
|
232
|
-
required :display_date, String, api_name: :displayDate, nil?: true
|
|
233
|
-
|
|
234
|
-
# @!attribute display_time
|
|
235
|
-
#
|
|
236
|
-
# @return [String, nil]
|
|
237
|
-
required :display_time, String, api_name: :displayTime, nil?: true
|
|
238
|
-
|
|
239
275
|
# @!attribute location
|
|
240
276
|
#
|
|
241
277
|
# @return [::CheckoutIntents::Models::Shipment::DeliveredShipment::TrackingEvent::Location]
|
|
242
278
|
required :location, -> { ::CheckoutIntents::Shipment::DeliveredShipment::TrackingEvent::Location }
|
|
243
279
|
|
|
244
|
-
# @!
|
|
280
|
+
# @!attribute timestamp
|
|
281
|
+
#
|
|
282
|
+
# @return [::CheckoutIntents::Models::Shipment::DeliveredShipment::TrackingEvent::Timestamp, nil]
|
|
283
|
+
required :timestamp,
|
|
284
|
+
-> { ::CheckoutIntents::Shipment::DeliveredShipment::TrackingEvent::Timestamp },
|
|
285
|
+
nil?: true
|
|
286
|
+
|
|
287
|
+
# @!method initialize(description:, location:, timestamp:)
|
|
245
288
|
# @param description [String, nil]
|
|
246
|
-
# @param display_date [String, nil]
|
|
247
|
-
# @param display_time [String, nil]
|
|
248
289
|
# @param location [::CheckoutIntents::Models::Shipment::DeliveredShipment::TrackingEvent::Location]
|
|
290
|
+
# @param timestamp [::CheckoutIntents::Models::Shipment::DeliveredShipment::TrackingEvent::Timestamp, nil]
|
|
249
291
|
|
|
250
292
|
# @see ::CheckoutIntents::Models::Shipment::DeliveredShipment::TrackingEvent#location
|
|
251
293
|
class Location < ::CheckoutIntents::Internal::Type::BaseModel
|
|
@@ -269,6 +311,26 @@ module CheckoutIntents
|
|
|
269
311
|
# @param country [String, nil]
|
|
270
312
|
# @param province [String, nil]
|
|
271
313
|
end
|
|
314
|
+
|
|
315
|
+
# @see ::CheckoutIntents::Models::Shipment::DeliveredShipment::TrackingEvent#timestamp
|
|
316
|
+
class Timestamp < ::CheckoutIntents::Internal::Type::BaseModel
|
|
317
|
+
# @!attribute local
|
|
318
|
+
# ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
|
|
319
|
+
#
|
|
320
|
+
# @return [String]
|
|
321
|
+
required :local, String
|
|
322
|
+
|
|
323
|
+
# @!attribute utc
|
|
324
|
+
# UTC timestamp
|
|
325
|
+
#
|
|
326
|
+
# @return [Time]
|
|
327
|
+
required :utc, Time
|
|
328
|
+
|
|
329
|
+
# @!method initialize(local:, utc:)
|
|
330
|
+
# @param local [String] ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
|
|
331
|
+
#
|
|
332
|
+
# @param utc [Time] UTC timestamp
|
|
333
|
+
end
|
|
272
334
|
end
|
|
273
335
|
end
|
|
274
336
|
|
|
@@ -289,6 +351,8 @@ module CheckoutIntents
|
|
|
289
351
|
required :created_at, Time, api_name: :createdAt
|
|
290
352
|
|
|
291
353
|
# @!attribute external_id
|
|
354
|
+
# The external ID is provided by the marketplace and matches the shipment to their
|
|
355
|
+
# system.
|
|
292
356
|
#
|
|
293
357
|
# @return [String]
|
|
294
358
|
required :external_id, String, api_name: :externalId
|
|
@@ -324,14 +388,26 @@ module CheckoutIntents
|
|
|
324
388
|
required :updated_at, Time, api_name: :updatedAt
|
|
325
389
|
|
|
326
390
|
# @!method initialize(id:, checkout_intent_id:, created_at:, external_id:, shipped_at:, status:, tracking:, tracking_events:, updated_at:)
|
|
391
|
+
# Some parameter documentations has been truncated, see
|
|
392
|
+
# {::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingDelayed}
|
|
393
|
+
# for more details.
|
|
394
|
+
#
|
|
327
395
|
# @param id [String]
|
|
396
|
+
#
|
|
328
397
|
# @param checkout_intent_id [String]
|
|
398
|
+
#
|
|
329
399
|
# @param created_at [Time]
|
|
330
|
-
#
|
|
400
|
+
#
|
|
401
|
+
# @param external_id [String] The external ID is provided by the marketplace and matches the shipment to their
|
|
402
|
+
#
|
|
331
403
|
# @param shipped_at [Time]
|
|
404
|
+
#
|
|
332
405
|
# @param status [Symbol, ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingDelayed::Status]
|
|
406
|
+
#
|
|
333
407
|
# @param tracking [::CheckoutIntents::Models::ShipmentTracking]
|
|
408
|
+
#
|
|
334
409
|
# @param tracking_events [Array<::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingDelayed::TrackingEvent>]
|
|
410
|
+
#
|
|
335
411
|
# @param updated_at [Time]
|
|
336
412
|
|
|
337
413
|
# @see ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingDelayed#status
|
|
@@ -350,27 +426,25 @@ module CheckoutIntents
|
|
|
350
426
|
# @return [String, nil]
|
|
351
427
|
required :description, String, nil?: true
|
|
352
428
|
|
|
353
|
-
# @!attribute display_date
|
|
354
|
-
#
|
|
355
|
-
# @return [String, nil]
|
|
356
|
-
required :display_date, String, api_name: :displayDate, nil?: true
|
|
357
|
-
|
|
358
|
-
# @!attribute display_time
|
|
359
|
-
#
|
|
360
|
-
# @return [String, nil]
|
|
361
|
-
required :display_time, String, api_name: :displayTime, nil?: true
|
|
362
|
-
|
|
363
429
|
# @!attribute location
|
|
364
430
|
#
|
|
365
431
|
# @return [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingDelayed::TrackingEvent::Location]
|
|
366
432
|
required :location,
|
|
367
433
|
-> { ::CheckoutIntents::Shipment::WithStatusBaseShipmentWithTrackingDelayed::TrackingEvent::Location }
|
|
368
434
|
|
|
369
|
-
# @!
|
|
435
|
+
# @!attribute timestamp
|
|
436
|
+
#
|
|
437
|
+
# @return [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingDelayed::TrackingEvent::Timestamp, nil]
|
|
438
|
+
required :timestamp,
|
|
439
|
+
-> {
|
|
440
|
+
::CheckoutIntents::Shipment::WithStatusBaseShipmentWithTrackingDelayed::TrackingEvent::Timestamp
|
|
441
|
+
},
|
|
442
|
+
nil?: true
|
|
443
|
+
|
|
444
|
+
# @!method initialize(description:, location:, timestamp:)
|
|
370
445
|
# @param description [String, nil]
|
|
371
|
-
# @param display_date [String, nil]
|
|
372
|
-
# @param display_time [String, nil]
|
|
373
446
|
# @param location [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingDelayed::TrackingEvent::Location]
|
|
447
|
+
# @param timestamp [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingDelayed::TrackingEvent::Timestamp, nil]
|
|
374
448
|
|
|
375
449
|
# @see ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingDelayed::TrackingEvent#location
|
|
376
450
|
class Location < ::CheckoutIntents::Internal::Type::BaseModel
|
|
@@ -394,6 +468,26 @@ module CheckoutIntents
|
|
|
394
468
|
# @param country [String, nil]
|
|
395
469
|
# @param province [String, nil]
|
|
396
470
|
end
|
|
471
|
+
|
|
472
|
+
# @see ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingDelayed::TrackingEvent#timestamp
|
|
473
|
+
class Timestamp < ::CheckoutIntents::Internal::Type::BaseModel
|
|
474
|
+
# @!attribute local
|
|
475
|
+
# ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
|
|
476
|
+
#
|
|
477
|
+
# @return [String]
|
|
478
|
+
required :local, String
|
|
479
|
+
|
|
480
|
+
# @!attribute utc
|
|
481
|
+
# UTC timestamp
|
|
482
|
+
#
|
|
483
|
+
# @return [Time]
|
|
484
|
+
required :utc, Time
|
|
485
|
+
|
|
486
|
+
# @!method initialize(local:, utc:)
|
|
487
|
+
# @param local [String] ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
|
|
488
|
+
#
|
|
489
|
+
# @param utc [Time] UTC timestamp
|
|
490
|
+
end
|
|
397
491
|
end
|
|
398
492
|
end
|
|
399
493
|
|
|
@@ -414,6 +508,8 @@ module CheckoutIntents
|
|
|
414
508
|
required :created_at, Time, api_name: :createdAt
|
|
415
509
|
|
|
416
510
|
# @!attribute external_id
|
|
511
|
+
# The external ID is provided by the marketplace and matches the shipment to their
|
|
512
|
+
# system.
|
|
417
513
|
#
|
|
418
514
|
# @return [String]
|
|
419
515
|
required :external_id, String, api_name: :externalId
|
|
@@ -449,14 +545,26 @@ module CheckoutIntents
|
|
|
449
545
|
required :updated_at, Time, api_name: :updatedAt
|
|
450
546
|
|
|
451
547
|
# @!method initialize(id:, checkout_intent_id:, created_at:, external_id:, shipped_at:, status:, tracking:, tracking_events:, updated_at:)
|
|
548
|
+
# Some parameter documentations has been truncated, see
|
|
549
|
+
# {::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery}
|
|
550
|
+
# for more details.
|
|
551
|
+
#
|
|
452
552
|
# @param id [String]
|
|
553
|
+
#
|
|
453
554
|
# @param checkout_intent_id [String]
|
|
555
|
+
#
|
|
454
556
|
# @param created_at [Time]
|
|
455
|
-
#
|
|
557
|
+
#
|
|
558
|
+
# @param external_id [String] The external ID is provided by the marketplace and matches the shipment to their
|
|
559
|
+
#
|
|
456
560
|
# @param shipped_at [Time]
|
|
561
|
+
#
|
|
457
562
|
# @param status [Symbol, ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery::Status]
|
|
563
|
+
#
|
|
458
564
|
# @param tracking [::CheckoutIntents::Models::ShipmentTracking]
|
|
565
|
+
#
|
|
459
566
|
# @param tracking_events [Array<::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery::TrackingEvent>]
|
|
567
|
+
#
|
|
460
568
|
# @param updated_at [Time]
|
|
461
569
|
|
|
462
570
|
# @see ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery#status
|
|
@@ -475,27 +583,25 @@ module CheckoutIntents
|
|
|
475
583
|
# @return [String, nil]
|
|
476
584
|
required :description, String, nil?: true
|
|
477
585
|
|
|
478
|
-
# @!attribute display_date
|
|
479
|
-
#
|
|
480
|
-
# @return [String, nil]
|
|
481
|
-
required :display_date, String, api_name: :displayDate, nil?: true
|
|
482
|
-
|
|
483
|
-
# @!attribute display_time
|
|
484
|
-
#
|
|
485
|
-
# @return [String, nil]
|
|
486
|
-
required :display_time, String, api_name: :displayTime, nil?: true
|
|
487
|
-
|
|
488
586
|
# @!attribute location
|
|
489
587
|
#
|
|
490
588
|
# @return [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery::TrackingEvent::Location]
|
|
491
589
|
required :location,
|
|
492
590
|
-> { ::CheckoutIntents::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery::TrackingEvent::Location }
|
|
493
591
|
|
|
494
|
-
# @!
|
|
592
|
+
# @!attribute timestamp
|
|
593
|
+
#
|
|
594
|
+
# @return [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery::TrackingEvent::Timestamp, nil]
|
|
595
|
+
required :timestamp,
|
|
596
|
+
-> {
|
|
597
|
+
::CheckoutIntents::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery::TrackingEvent::Timestamp
|
|
598
|
+
},
|
|
599
|
+
nil?: true
|
|
600
|
+
|
|
601
|
+
# @!method initialize(description:, location:, timestamp:)
|
|
495
602
|
# @param description [String, nil]
|
|
496
|
-
# @param display_date [String, nil]
|
|
497
|
-
# @param display_time [String, nil]
|
|
498
603
|
# @param location [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery::TrackingEvent::Location]
|
|
604
|
+
# @param timestamp [::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery::TrackingEvent::Timestamp, nil]
|
|
499
605
|
|
|
500
606
|
# @see ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery::TrackingEvent#location
|
|
501
607
|
class Location < ::CheckoutIntents::Internal::Type::BaseModel
|
|
@@ -519,6 +625,26 @@ module CheckoutIntents
|
|
|
519
625
|
# @param country [String, nil]
|
|
520
626
|
# @param province [String, nil]
|
|
521
627
|
end
|
|
628
|
+
|
|
629
|
+
# @see ::CheckoutIntents::Models::Shipment::WithStatusBaseShipmentWithTrackingOutForDelivery::TrackingEvent#timestamp
|
|
630
|
+
class Timestamp < ::CheckoutIntents::Internal::Type::BaseModel
|
|
631
|
+
# @!attribute local
|
|
632
|
+
# ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
|
|
633
|
+
#
|
|
634
|
+
# @return [String]
|
|
635
|
+
required :local, String
|
|
636
|
+
|
|
637
|
+
# @!attribute utc
|
|
638
|
+
# UTC timestamp
|
|
639
|
+
#
|
|
640
|
+
# @return [Time]
|
|
641
|
+
required :utc, Time
|
|
642
|
+
|
|
643
|
+
# @!method initialize(local:, utc:)
|
|
644
|
+
# @param local [String] ISO 8601 string with timezone offset, e.g. "2025-02-05T17:02:00.000-05:00"
|
|
645
|
+
#
|
|
646
|
+
# @param utc [Time] UTC timestamp
|
|
647
|
+
end
|
|
522
648
|
end
|
|
523
649
|
end
|
|
524
650
|
|
|
@@ -13,21 +13,35 @@ module CheckoutIntents
|
|
|
13
13
|
# @return [String, nil]
|
|
14
14
|
optional :carrier_name, String, api_name: :carrierName, nil?: true
|
|
15
15
|
|
|
16
|
-
# @!attribute
|
|
16
|
+
# @!attribute delivery_date
|
|
17
17
|
#
|
|
18
|
-
# @return [
|
|
19
|
-
optional :
|
|
18
|
+
# @return [::CheckoutIntents::Models::ShipmentTracking::DeliveryDate, nil]
|
|
19
|
+
optional :delivery_date,
|
|
20
|
+
-> { ::CheckoutIntents::ShipmentTracking::DeliveryDate },
|
|
21
|
+
api_name: :deliveryDate,
|
|
22
|
+
nil?: true
|
|
20
23
|
|
|
21
24
|
# @!attribute url
|
|
22
25
|
#
|
|
23
26
|
# @return [String, nil]
|
|
24
27
|
optional :url, String, nil?: true
|
|
25
28
|
|
|
26
|
-
# @!method initialize(number:, carrier_name: nil,
|
|
29
|
+
# @!method initialize(number:, carrier_name: nil, delivery_date: nil, url: nil)
|
|
27
30
|
# @param number [String, nil]
|
|
28
31
|
# @param carrier_name [String, nil]
|
|
29
|
-
# @param
|
|
32
|
+
# @param delivery_date [::CheckoutIntents::Models::ShipmentTracking::DeliveryDate, nil]
|
|
30
33
|
# @param url [String, nil]
|
|
34
|
+
|
|
35
|
+
# @see ::CheckoutIntents::Models::ShipmentTracking#delivery_date
|
|
36
|
+
class DeliveryDate < ::CheckoutIntents::Internal::Type::BaseModel
|
|
37
|
+
# @!attribute estimated
|
|
38
|
+
#
|
|
39
|
+
# @return [Time]
|
|
40
|
+
required :estimated, Time
|
|
41
|
+
|
|
42
|
+
# @!method initialize(estimated:)
|
|
43
|
+
# @param estimated [Time]
|
|
44
|
+
end
|
|
31
45
|
end
|
|
32
46
|
end
|
|
33
47
|
end
|