@spree/sdk 0.6.9 → 0.7.1
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.
- package/README.md +118 -120
- package/dist/index-CgJG4R8P.d.cts +989 -0
- package/dist/index-CgJG4R8P.d.ts +989 -0
- package/dist/index.cjs +43 -82
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +78 -124
- package/dist/index.d.ts +78 -124
- package/dist/index.js +43 -80
- package/dist/index.js.map +1 -1
- package/dist/types/index.d.cts +1 -1181
- package/dist/types/index.d.ts +1 -1181
- package/dist/zod/index.cjs +310 -551
- package/dist/zod/index.cjs.map +1 -1
- package/dist/zod/index.d.cts +119 -713
- package/dist/zod/index.d.ts +119 -713
- package/dist/zod/index.js +256 -490
- package/dist/zod/index.js.map +1 -1
- package/package.json +3 -2
package/dist/types/index.d.ts
CHANGED
|
@@ -1,1181 +1 @@
|
|
|
1
|
-
|
|
2
|
-
id: string;
|
|
3
|
-
firstname: string | null;
|
|
4
|
-
lastname: string | null;
|
|
5
|
-
full_name: string;
|
|
6
|
-
address1: string | null;
|
|
7
|
-
address2: string | null;
|
|
8
|
-
city: string | null;
|
|
9
|
-
zipcode: string | null;
|
|
10
|
-
phone: string | null;
|
|
11
|
-
company: string | null;
|
|
12
|
-
country_name: string;
|
|
13
|
-
country_iso: string;
|
|
14
|
-
state_text: string | null;
|
|
15
|
-
state_abbr: string | null;
|
|
16
|
-
quick_checkout: boolean;
|
|
17
|
-
state_name: string | null;
|
|
18
|
-
};
|
|
19
|
-
|
|
20
|
-
type AdminCustomer = {
|
|
21
|
-
id: string;
|
|
22
|
-
email: string;
|
|
23
|
-
first_name: string | null;
|
|
24
|
-
last_name: string | null;
|
|
25
|
-
created_at: string;
|
|
26
|
-
updated_at: string;
|
|
27
|
-
addresses: Array<StoreAddress>;
|
|
28
|
-
default_billing_address: StoreAddress | null;
|
|
29
|
-
default_shipping_address: StoreAddress | null;
|
|
30
|
-
phone: string | null;
|
|
31
|
-
login: string | null;
|
|
32
|
-
accepts_email_marketing: boolean;
|
|
33
|
-
last_sign_in_at: string | null;
|
|
34
|
-
current_sign_in_at: string | null;
|
|
35
|
-
sign_in_count: number;
|
|
36
|
-
failed_attempts: number;
|
|
37
|
-
last_sign_in_ip: string | null;
|
|
38
|
-
current_sign_in_ip: string | null;
|
|
39
|
-
orders?: Array<AdminOrder>;
|
|
40
|
-
};
|
|
41
|
-
|
|
42
|
-
type AdminLineItem = {
|
|
43
|
-
id: string;
|
|
44
|
-
variant_id: string;
|
|
45
|
-
quantity: number;
|
|
46
|
-
currency: string;
|
|
47
|
-
name: string;
|
|
48
|
-
slug: string;
|
|
49
|
-
options_text: string;
|
|
50
|
-
price: string;
|
|
51
|
-
display_price: string;
|
|
52
|
-
total: string;
|
|
53
|
-
display_total: string;
|
|
54
|
-
adjustment_total: string;
|
|
55
|
-
display_adjustment_total: string;
|
|
56
|
-
additional_tax_total: string;
|
|
57
|
-
display_additional_tax_total: string;
|
|
58
|
-
included_tax_total: string;
|
|
59
|
-
display_included_tax_total: string;
|
|
60
|
-
promo_total: string;
|
|
61
|
-
display_promo_total: string;
|
|
62
|
-
pre_tax_amount: string;
|
|
63
|
-
display_pre_tax_amount: string;
|
|
64
|
-
discounted_amount: string;
|
|
65
|
-
display_discounted_amount: string;
|
|
66
|
-
display_compare_at_amount: string | null;
|
|
67
|
-
created_at: string;
|
|
68
|
-
updated_at: string;
|
|
69
|
-
compare_at_amount: string | null;
|
|
70
|
-
thumbnail_url: string | null;
|
|
71
|
-
option_values: Array<StoreOptionValue>;
|
|
72
|
-
digital_links: Array<StoreDigitalLink>;
|
|
73
|
-
metadata: Record<string, unknown> | null;
|
|
74
|
-
};
|
|
75
|
-
|
|
76
|
-
type AdminMetafield = {
|
|
77
|
-
id: string;
|
|
78
|
-
name: string;
|
|
79
|
-
type: string;
|
|
80
|
-
key: string;
|
|
81
|
-
value: any;
|
|
82
|
-
display_on: string;
|
|
83
|
-
};
|
|
84
|
-
|
|
85
|
-
type AdminOrder = {
|
|
86
|
-
id: string;
|
|
87
|
-
number: string;
|
|
88
|
-
state: string;
|
|
89
|
-
checkout_steps: Array<string>;
|
|
90
|
-
token: string;
|
|
91
|
-
email: string | null;
|
|
92
|
-
special_instructions: string | null;
|
|
93
|
-
currency: string;
|
|
94
|
-
locale: string | null;
|
|
95
|
-
item_count: number;
|
|
96
|
-
state_lock_version: number;
|
|
97
|
-
shipment_state: string | null;
|
|
98
|
-
payment_state: string | null;
|
|
99
|
-
item_total: string;
|
|
100
|
-
display_item_total: string;
|
|
101
|
-
ship_total: string;
|
|
102
|
-
display_ship_total: string;
|
|
103
|
-
adjustment_total: string;
|
|
104
|
-
display_adjustment_total: string;
|
|
105
|
-
promo_total: string;
|
|
106
|
-
display_promo_total: string;
|
|
107
|
-
tax_total: string;
|
|
108
|
-
display_tax_total: string;
|
|
109
|
-
included_tax_total: string;
|
|
110
|
-
display_included_tax_total: string;
|
|
111
|
-
additional_tax_total: string;
|
|
112
|
-
display_additional_tax_total: string;
|
|
113
|
-
total: string;
|
|
114
|
-
display_total: string;
|
|
115
|
-
completed_at: string | null;
|
|
116
|
-
created_at: string;
|
|
117
|
-
updated_at: string;
|
|
118
|
-
order_promotions: Array<StoreOrderPromotion>;
|
|
119
|
-
line_items: Array<AdminLineItem>;
|
|
120
|
-
shipments: Array<StoreShipment>;
|
|
121
|
-
payments: Array<StorePayment>;
|
|
122
|
-
bill_address: StoreAddress | null;
|
|
123
|
-
ship_address: StoreAddress | null;
|
|
124
|
-
payment_methods: Array<StorePaymentMethod>;
|
|
125
|
-
channel: string | null;
|
|
126
|
-
last_ip_address: string | null;
|
|
127
|
-
considered_risky: boolean;
|
|
128
|
-
confirmation_delivered: boolean;
|
|
129
|
-
store_owner_notification_delivered: boolean;
|
|
130
|
-
internal_note: string | null;
|
|
131
|
-
approver_id: string | null;
|
|
132
|
-
canceled_at: string | null;
|
|
133
|
-
approved_at: string | null;
|
|
134
|
-
metadata: Record<string, unknown> | null;
|
|
135
|
-
canceler_id: string | null;
|
|
136
|
-
created_by_id: string | null;
|
|
137
|
-
user?: AdminCustomer;
|
|
138
|
-
};
|
|
139
|
-
|
|
140
|
-
type AdminPrice = {
|
|
141
|
-
id: string;
|
|
142
|
-
amount: string | null;
|
|
143
|
-
amount_in_cents: number | null;
|
|
144
|
-
compare_at_amount: string | null;
|
|
145
|
-
compare_at_amount_in_cents: number | null;
|
|
146
|
-
currency: string | null;
|
|
147
|
-
display_amount: string | null;
|
|
148
|
-
display_compare_at_amount: string | null;
|
|
149
|
-
price_list_id: string | null;
|
|
150
|
-
variant_id: string | null;
|
|
151
|
-
created_at: string;
|
|
152
|
-
updated_at: string;
|
|
153
|
-
};
|
|
154
|
-
|
|
155
|
-
type AdminProduct = {
|
|
156
|
-
id: string;
|
|
157
|
-
name: string;
|
|
158
|
-
description: string | null;
|
|
159
|
-
slug: string;
|
|
160
|
-
meta_description: string | null;
|
|
161
|
-
meta_keywords: string | null;
|
|
162
|
-
variant_count: number;
|
|
163
|
-
available_on: string | null;
|
|
164
|
-
created_at: string;
|
|
165
|
-
updated_at: string;
|
|
166
|
-
purchasable: boolean;
|
|
167
|
-
in_stock: boolean;
|
|
168
|
-
backorderable: boolean;
|
|
169
|
-
available: boolean;
|
|
170
|
-
default_variant_id: string;
|
|
171
|
-
thumbnail_url: string | null;
|
|
172
|
-
tags: Array<string>;
|
|
173
|
-
price: StorePrice;
|
|
174
|
-
original_price: StorePrice | null;
|
|
175
|
-
images?: Array<StoreImage>;
|
|
176
|
-
variants?: Array<AdminVariant>;
|
|
177
|
-
default_variant?: AdminVariant;
|
|
178
|
-
master_variant?: AdminVariant;
|
|
179
|
-
option_types?: Array<StoreOptionType>;
|
|
180
|
-
taxons?: Array<StoreTaxon>;
|
|
181
|
-
metafields?: Array<AdminMetafield>;
|
|
182
|
-
status: string;
|
|
183
|
-
make_active_at: string | null;
|
|
184
|
-
discontinue_on: string | null;
|
|
185
|
-
deleted_at: string | null;
|
|
186
|
-
cost_price: string | null;
|
|
187
|
-
cost_currency: string | null;
|
|
188
|
-
};
|
|
189
|
-
|
|
190
|
-
type AdminTaxon = {
|
|
191
|
-
id: string;
|
|
192
|
-
name: string;
|
|
193
|
-
permalink: string;
|
|
194
|
-
position: number;
|
|
195
|
-
depth: number;
|
|
196
|
-
meta_title: string | null;
|
|
197
|
-
meta_description: string | null;
|
|
198
|
-
meta_keywords: string | null;
|
|
199
|
-
children_count: number;
|
|
200
|
-
created_at: string;
|
|
201
|
-
updated_at: string;
|
|
202
|
-
parent_id: string | null;
|
|
203
|
-
taxonomy_id: string;
|
|
204
|
-
description: string;
|
|
205
|
-
description_html: string;
|
|
206
|
-
image_url: string | null;
|
|
207
|
-
square_image_url: string | null;
|
|
208
|
-
is_root: boolean;
|
|
209
|
-
is_child: boolean;
|
|
210
|
-
is_leaf: boolean;
|
|
211
|
-
parent?: StoreTaxon;
|
|
212
|
-
children?: Array<StoreTaxon>;
|
|
213
|
-
ancestors?: Array<StoreTaxon>;
|
|
214
|
-
metafields?: Array<AdminMetafield>;
|
|
215
|
-
lft: number;
|
|
216
|
-
rgt: number;
|
|
217
|
-
};
|
|
218
|
-
|
|
219
|
-
type AdminTaxonomy = {
|
|
220
|
-
id: string;
|
|
221
|
-
name: string;
|
|
222
|
-
position: number;
|
|
223
|
-
created_at: string;
|
|
224
|
-
updated_at: string;
|
|
225
|
-
root_id: string | null;
|
|
226
|
-
root?: StoreTaxon;
|
|
227
|
-
taxons?: Array<StoreTaxon>;
|
|
228
|
-
metafields?: Array<AdminMetafield>;
|
|
229
|
-
};
|
|
230
|
-
|
|
231
|
-
type AdminVariant = {
|
|
232
|
-
id: string;
|
|
233
|
-
product_id: string;
|
|
234
|
-
sku: string | null;
|
|
235
|
-
is_master: boolean;
|
|
236
|
-
options_text: string;
|
|
237
|
-
track_inventory: boolean;
|
|
238
|
-
image_count: number;
|
|
239
|
-
created_at: string;
|
|
240
|
-
updated_at: string;
|
|
241
|
-
thumbnail: string | null;
|
|
242
|
-
purchasable: boolean;
|
|
243
|
-
in_stock: boolean;
|
|
244
|
-
backorderable: boolean;
|
|
245
|
-
weight: number | null;
|
|
246
|
-
height: number | null;
|
|
247
|
-
width: number | null;
|
|
248
|
-
depth: number | null;
|
|
249
|
-
price: StorePrice;
|
|
250
|
-
original_price: StorePrice | null;
|
|
251
|
-
images?: Array<StoreImage>;
|
|
252
|
-
option_values: Array<StoreOptionValue>;
|
|
253
|
-
metafields?: Array<AdminMetafield>;
|
|
254
|
-
position: number;
|
|
255
|
-
tax_category_id: string | null;
|
|
256
|
-
cost_price: string | null;
|
|
257
|
-
cost_currency: string | null;
|
|
258
|
-
deleted_at: string | null;
|
|
259
|
-
total_on_hand: number | null;
|
|
260
|
-
prices?: Array<AdminPrice>;
|
|
261
|
-
};
|
|
262
|
-
|
|
263
|
-
type StoreAsset = {
|
|
264
|
-
id: string;
|
|
265
|
-
viewable_id: string;
|
|
266
|
-
type: string | null;
|
|
267
|
-
viewable_type: string;
|
|
268
|
-
position: number | null;
|
|
269
|
-
alt: string | null;
|
|
270
|
-
created_at: string;
|
|
271
|
-
updated_at: string;
|
|
272
|
-
};
|
|
273
|
-
|
|
274
|
-
type StoreBase = {
|
|
275
|
-
id: string;
|
|
276
|
-
};
|
|
277
|
-
|
|
278
|
-
type StoreCountry = {
|
|
279
|
-
iso: string;
|
|
280
|
-
iso3: string;
|
|
281
|
-
name: string;
|
|
282
|
-
states_required: boolean;
|
|
283
|
-
zipcode_required: boolean;
|
|
284
|
-
states?: Array<StoreState>;
|
|
285
|
-
market?: StoreMarket | null;
|
|
286
|
-
};
|
|
287
|
-
|
|
288
|
-
type StoreCreditCard = {
|
|
289
|
-
id: string;
|
|
290
|
-
cc_type: string;
|
|
291
|
-
last_digits: string;
|
|
292
|
-
month: number;
|
|
293
|
-
year: number;
|
|
294
|
-
name: string | null;
|
|
295
|
-
default: boolean;
|
|
296
|
-
gateway_payment_profile_id: string | null;
|
|
297
|
-
};
|
|
298
|
-
|
|
299
|
-
type StoreCurrency = {
|
|
300
|
-
iso_code: string;
|
|
301
|
-
name: string;
|
|
302
|
-
symbol: string;
|
|
303
|
-
};
|
|
304
|
-
|
|
305
|
-
type StoreCustomerReturn = {
|
|
306
|
-
id: string;
|
|
307
|
-
number: string;
|
|
308
|
-
created_at: string;
|
|
309
|
-
updated_at: string;
|
|
310
|
-
stock_location_id: string | null;
|
|
311
|
-
};
|
|
312
|
-
|
|
313
|
-
type StoreCustomer = {
|
|
314
|
-
id: string;
|
|
315
|
-
email: string;
|
|
316
|
-
first_name: string | null;
|
|
317
|
-
last_name: string | null;
|
|
318
|
-
created_at: string;
|
|
319
|
-
updated_at: string;
|
|
320
|
-
addresses: Array<StoreAddress>;
|
|
321
|
-
default_billing_address: StoreAddress | null;
|
|
322
|
-
default_shipping_address: StoreAddress | null;
|
|
323
|
-
};
|
|
324
|
-
|
|
325
|
-
type StoreDigitalLink = {
|
|
326
|
-
id: string;
|
|
327
|
-
access_counter: number;
|
|
328
|
-
filename: string;
|
|
329
|
-
content_type: string;
|
|
330
|
-
created_at: string;
|
|
331
|
-
updated_at: string;
|
|
332
|
-
download_url: string;
|
|
333
|
-
authorizable: boolean;
|
|
334
|
-
expired: boolean;
|
|
335
|
-
access_limit_exceeded: boolean;
|
|
336
|
-
};
|
|
337
|
-
|
|
338
|
-
type StoreDigital = {
|
|
339
|
-
id: string;
|
|
340
|
-
created_at: string;
|
|
341
|
-
updated_at: string;
|
|
342
|
-
variant_id: string | null;
|
|
343
|
-
};
|
|
344
|
-
|
|
345
|
-
type StoreExport = {
|
|
346
|
-
id: string;
|
|
347
|
-
number: string;
|
|
348
|
-
type: string | null;
|
|
349
|
-
format: string | null;
|
|
350
|
-
created_at: string;
|
|
351
|
-
updated_at: string;
|
|
352
|
-
user_id: string | null;
|
|
353
|
-
};
|
|
354
|
-
|
|
355
|
-
type StoreGiftCardBatch = {
|
|
356
|
-
id: string;
|
|
357
|
-
codes_count: number;
|
|
358
|
-
currency: string | null;
|
|
359
|
-
prefix: string | null;
|
|
360
|
-
created_at: string;
|
|
361
|
-
updated_at: string;
|
|
362
|
-
amount: string | null;
|
|
363
|
-
expires_at: string | null;
|
|
364
|
-
created_by_id: string | null;
|
|
365
|
-
};
|
|
366
|
-
|
|
367
|
-
type StoreGiftCard = {
|
|
368
|
-
id: string;
|
|
369
|
-
code: string;
|
|
370
|
-
state: string;
|
|
371
|
-
currency: string;
|
|
372
|
-
amount: string;
|
|
373
|
-
amount_used: string;
|
|
374
|
-
amount_authorized: string;
|
|
375
|
-
amount_remaining: string;
|
|
376
|
-
display_amount: string;
|
|
377
|
-
display_amount_used: string;
|
|
378
|
-
display_amount_remaining: string;
|
|
379
|
-
expires_at: string | null;
|
|
380
|
-
redeemed_at: string | null;
|
|
381
|
-
expired: boolean;
|
|
382
|
-
active: boolean;
|
|
383
|
-
created_at: string;
|
|
384
|
-
updated_at: string;
|
|
385
|
-
};
|
|
386
|
-
|
|
387
|
-
type StoreImage = {
|
|
388
|
-
id: string;
|
|
389
|
-
viewable_id: string;
|
|
390
|
-
type: string | null;
|
|
391
|
-
viewable_type: string;
|
|
392
|
-
position: number | null;
|
|
393
|
-
alt: string | null;
|
|
394
|
-
created_at: string;
|
|
395
|
-
updated_at: string;
|
|
396
|
-
original_url: string | null;
|
|
397
|
-
mini_url: string | null;
|
|
398
|
-
small_url: string | null;
|
|
399
|
-
medium_url: string | null;
|
|
400
|
-
large_url: string | null;
|
|
401
|
-
xlarge_url: string | null;
|
|
402
|
-
og_image_url: string | null;
|
|
403
|
-
};
|
|
404
|
-
|
|
405
|
-
type StoreImportRow = {
|
|
406
|
-
id: string;
|
|
407
|
-
row_number: number;
|
|
408
|
-
status: string;
|
|
409
|
-
validation_errors: unknown;
|
|
410
|
-
item_type: string | null;
|
|
411
|
-
created_at: string;
|
|
412
|
-
updated_at: string;
|
|
413
|
-
import_id: string | null;
|
|
414
|
-
item_id: string | null;
|
|
415
|
-
};
|
|
416
|
-
|
|
417
|
-
type StoreImport = {
|
|
418
|
-
id: string;
|
|
419
|
-
number: string;
|
|
420
|
-
type: string | null;
|
|
421
|
-
rows_count: number;
|
|
422
|
-
created_at: string;
|
|
423
|
-
updated_at: string;
|
|
424
|
-
status: string;
|
|
425
|
-
owner_type: string | null;
|
|
426
|
-
owner_id: string | null;
|
|
427
|
-
user_id: string | null;
|
|
428
|
-
};
|
|
429
|
-
|
|
430
|
-
type StoreInvitation = {
|
|
431
|
-
id: string;
|
|
432
|
-
email: string;
|
|
433
|
-
resource_type: string | null;
|
|
434
|
-
inviter_type: string | null;
|
|
435
|
-
invitee_type: string | null;
|
|
436
|
-
created_at: string;
|
|
437
|
-
updated_at: string;
|
|
438
|
-
status: string;
|
|
439
|
-
resource_id: string | null;
|
|
440
|
-
inviter_id: string | null;
|
|
441
|
-
invitee_id: string | null;
|
|
442
|
-
role_id: string | null;
|
|
443
|
-
expires_at: string | null;
|
|
444
|
-
accepted_at: string | null;
|
|
445
|
-
};
|
|
446
|
-
|
|
447
|
-
type StoreLineItem = {
|
|
448
|
-
id: string;
|
|
449
|
-
variant_id: string;
|
|
450
|
-
quantity: number;
|
|
451
|
-
currency: string;
|
|
452
|
-
name: string;
|
|
453
|
-
slug: string;
|
|
454
|
-
options_text: string;
|
|
455
|
-
price: string;
|
|
456
|
-
display_price: string;
|
|
457
|
-
total: string;
|
|
458
|
-
display_total: string;
|
|
459
|
-
adjustment_total: string;
|
|
460
|
-
display_adjustment_total: string;
|
|
461
|
-
additional_tax_total: string;
|
|
462
|
-
display_additional_tax_total: string;
|
|
463
|
-
included_tax_total: string;
|
|
464
|
-
display_included_tax_total: string;
|
|
465
|
-
promo_total: string;
|
|
466
|
-
display_promo_total: string;
|
|
467
|
-
pre_tax_amount: string;
|
|
468
|
-
display_pre_tax_amount: string;
|
|
469
|
-
discounted_amount: string;
|
|
470
|
-
display_discounted_amount: string;
|
|
471
|
-
display_compare_at_amount: string | null;
|
|
472
|
-
created_at: string;
|
|
473
|
-
updated_at: string;
|
|
474
|
-
compare_at_amount: string | null;
|
|
475
|
-
thumbnail_url: string | null;
|
|
476
|
-
option_values: Array<StoreOptionValue>;
|
|
477
|
-
digital_links: Array<StoreDigitalLink>;
|
|
478
|
-
};
|
|
479
|
-
|
|
480
|
-
type StoreLocale = {
|
|
481
|
-
code: string;
|
|
482
|
-
name: string;
|
|
483
|
-
};
|
|
484
|
-
|
|
485
|
-
type StoreMarket = {
|
|
486
|
-
id: string;
|
|
487
|
-
name: string;
|
|
488
|
-
currency: string;
|
|
489
|
-
default_locale: string;
|
|
490
|
-
tax_inclusive: boolean;
|
|
491
|
-
default: boolean;
|
|
492
|
-
supported_locales: Array<string>;
|
|
493
|
-
countries?: Array<StoreCountry>;
|
|
494
|
-
};
|
|
495
|
-
|
|
496
|
-
type StoreMetafield = {
|
|
497
|
-
id: string;
|
|
498
|
-
name: string;
|
|
499
|
-
type: string;
|
|
500
|
-
key: string;
|
|
501
|
-
value: any;
|
|
502
|
-
};
|
|
503
|
-
|
|
504
|
-
type StoreNewsletterSubscriber = {
|
|
505
|
-
id: string;
|
|
506
|
-
email: string;
|
|
507
|
-
created_at: string;
|
|
508
|
-
updated_at: string;
|
|
509
|
-
verified: boolean;
|
|
510
|
-
verified_at: string | null;
|
|
511
|
-
user_id: string | null;
|
|
512
|
-
};
|
|
513
|
-
|
|
514
|
-
type StoreOptionType = {
|
|
515
|
-
id: string;
|
|
516
|
-
name: string;
|
|
517
|
-
presentation: string;
|
|
518
|
-
position: number;
|
|
519
|
-
};
|
|
520
|
-
|
|
521
|
-
type StoreOptionValue = {
|
|
522
|
-
id: string;
|
|
523
|
-
option_type_id: string;
|
|
524
|
-
name: string;
|
|
525
|
-
presentation: string;
|
|
526
|
-
position: number;
|
|
527
|
-
option_type_name: string;
|
|
528
|
-
option_type_presentation: string;
|
|
529
|
-
};
|
|
530
|
-
|
|
531
|
-
type StoreOrderPromotion = {
|
|
532
|
-
id: string;
|
|
533
|
-
promotion_id: string;
|
|
534
|
-
name: string;
|
|
535
|
-
description: string | null;
|
|
536
|
-
code: string | null;
|
|
537
|
-
amount: string;
|
|
538
|
-
display_amount: string;
|
|
539
|
-
};
|
|
540
|
-
|
|
541
|
-
type StoreOrder = {
|
|
542
|
-
id: string;
|
|
543
|
-
number: string;
|
|
544
|
-
state: string;
|
|
545
|
-
checkout_steps: Array<string>;
|
|
546
|
-
token: string;
|
|
547
|
-
email: string | null;
|
|
548
|
-
special_instructions: string | null;
|
|
549
|
-
currency: string;
|
|
550
|
-
locale: string | null;
|
|
551
|
-
item_count: number;
|
|
552
|
-
state_lock_version: number;
|
|
553
|
-
shipment_state: string | null;
|
|
554
|
-
payment_state: string | null;
|
|
555
|
-
item_total: string;
|
|
556
|
-
display_item_total: string;
|
|
557
|
-
ship_total: string;
|
|
558
|
-
display_ship_total: string;
|
|
559
|
-
adjustment_total: string;
|
|
560
|
-
display_adjustment_total: string;
|
|
561
|
-
promo_total: string;
|
|
562
|
-
display_promo_total: string;
|
|
563
|
-
tax_total: string;
|
|
564
|
-
display_tax_total: string;
|
|
565
|
-
included_tax_total: string;
|
|
566
|
-
display_included_tax_total: string;
|
|
567
|
-
additional_tax_total: string;
|
|
568
|
-
display_additional_tax_total: string;
|
|
569
|
-
total: string;
|
|
570
|
-
display_total: string;
|
|
571
|
-
completed_at: string | null;
|
|
572
|
-
created_at: string;
|
|
573
|
-
updated_at: string;
|
|
574
|
-
order_promotions: Array<StoreOrderPromotion>;
|
|
575
|
-
line_items: Array<StoreLineItem>;
|
|
576
|
-
shipments: Array<StoreShipment>;
|
|
577
|
-
payments: Array<StorePayment>;
|
|
578
|
-
bill_address: StoreAddress | null;
|
|
579
|
-
ship_address: StoreAddress | null;
|
|
580
|
-
payment_methods: Array<StorePaymentMethod>;
|
|
581
|
-
};
|
|
582
|
-
|
|
583
|
-
type StorePaymentMethod = {
|
|
584
|
-
id: string;
|
|
585
|
-
name: string;
|
|
586
|
-
description: string | null;
|
|
587
|
-
type: string;
|
|
588
|
-
session_required: boolean;
|
|
589
|
-
};
|
|
590
|
-
|
|
591
|
-
type StorePayment = {
|
|
592
|
-
id: string;
|
|
593
|
-
payment_method_id: string;
|
|
594
|
-
state: string;
|
|
595
|
-
response_code: string | null;
|
|
596
|
-
number: string;
|
|
597
|
-
amount: string;
|
|
598
|
-
display_amount: string;
|
|
599
|
-
created_at: string;
|
|
600
|
-
updated_at: string;
|
|
601
|
-
source_type: 'credit_card' | 'store_credit' | 'payment_source' | null;
|
|
602
|
-
source_id: string | null;
|
|
603
|
-
source: StoreCreditCard | StoreStoreCredit | StorePaymentSource | null;
|
|
604
|
-
payment_method: StorePaymentMethod;
|
|
605
|
-
};
|
|
606
|
-
|
|
607
|
-
type StorePaymentSession = {
|
|
608
|
-
id: string;
|
|
609
|
-
status: string;
|
|
610
|
-
currency: string;
|
|
611
|
-
external_id: string;
|
|
612
|
-
external_data: Record<string, unknown>;
|
|
613
|
-
customer_external_id: string | null;
|
|
614
|
-
expires_at: string | null;
|
|
615
|
-
created_at: string;
|
|
616
|
-
updated_at: string;
|
|
617
|
-
amount: string;
|
|
618
|
-
payment_method_id: string;
|
|
619
|
-
order_id: string;
|
|
620
|
-
payment_method: StorePaymentMethod;
|
|
621
|
-
payment?: StorePayment;
|
|
622
|
-
};
|
|
623
|
-
|
|
624
|
-
type StorePaymentSetupSession = {
|
|
625
|
-
id: string;
|
|
626
|
-
status: string;
|
|
627
|
-
external_id: string | null;
|
|
628
|
-
external_client_secret: string | null;
|
|
629
|
-
external_data: Record<string, unknown>;
|
|
630
|
-
created_at: string;
|
|
631
|
-
updated_at: string;
|
|
632
|
-
payment_method_id: string | null;
|
|
633
|
-
payment_source_id: string | null;
|
|
634
|
-
payment_source_type: string | null;
|
|
635
|
-
customer_id: string | null;
|
|
636
|
-
payment_method: StorePaymentMethod;
|
|
637
|
-
};
|
|
638
|
-
|
|
639
|
-
type StorePaymentSource = {
|
|
640
|
-
id: string;
|
|
641
|
-
gateway_payment_profile_id: string | null;
|
|
642
|
-
};
|
|
643
|
-
|
|
644
|
-
type StorePrice = {
|
|
645
|
-
id: string;
|
|
646
|
-
amount: string | null;
|
|
647
|
-
amount_in_cents: number | null;
|
|
648
|
-
compare_at_amount: string | null;
|
|
649
|
-
compare_at_amount_in_cents: number | null;
|
|
650
|
-
currency: string | null;
|
|
651
|
-
display_amount: string | null;
|
|
652
|
-
display_compare_at_amount: string | null;
|
|
653
|
-
price_list_id: string | null;
|
|
654
|
-
};
|
|
655
|
-
|
|
656
|
-
type StoreProduct = {
|
|
657
|
-
id: string;
|
|
658
|
-
name: string;
|
|
659
|
-
description: string | null;
|
|
660
|
-
slug: string;
|
|
661
|
-
meta_description: string | null;
|
|
662
|
-
meta_keywords: string | null;
|
|
663
|
-
variant_count: number;
|
|
664
|
-
available_on: string | null;
|
|
665
|
-
created_at: string;
|
|
666
|
-
updated_at: string;
|
|
667
|
-
purchasable: boolean;
|
|
668
|
-
in_stock: boolean;
|
|
669
|
-
backorderable: boolean;
|
|
670
|
-
available: boolean;
|
|
671
|
-
default_variant_id: string;
|
|
672
|
-
thumbnail_url: string | null;
|
|
673
|
-
tags: Array<string>;
|
|
674
|
-
price: StorePrice;
|
|
675
|
-
original_price: StorePrice | null;
|
|
676
|
-
images?: Array<StoreImage>;
|
|
677
|
-
variants?: Array<StoreVariant>;
|
|
678
|
-
default_variant?: StoreVariant;
|
|
679
|
-
master_variant?: StoreVariant;
|
|
680
|
-
option_types?: Array<StoreOptionType>;
|
|
681
|
-
taxons?: Array<StoreTaxon>;
|
|
682
|
-
metafields?: Array<StoreMetafield>;
|
|
683
|
-
};
|
|
684
|
-
|
|
685
|
-
type StorePromotion = {
|
|
686
|
-
id: string;
|
|
687
|
-
name: string;
|
|
688
|
-
description: string | null;
|
|
689
|
-
code: string | null;
|
|
690
|
-
type: string | null;
|
|
691
|
-
kind: string | null;
|
|
692
|
-
path: string | null;
|
|
693
|
-
match_policy: string | null;
|
|
694
|
-
usage_limit: number | null;
|
|
695
|
-
advertise: boolean;
|
|
696
|
-
multi_codes: boolean;
|
|
697
|
-
code_prefix: string | null;
|
|
698
|
-
number_of_codes: number | null;
|
|
699
|
-
starts_at: string | null;
|
|
700
|
-
expires_at: string | null;
|
|
701
|
-
created_at: string;
|
|
702
|
-
updated_at: string;
|
|
703
|
-
promotion_category_id: string | null;
|
|
704
|
-
};
|
|
705
|
-
|
|
706
|
-
type StoreRefund = {
|
|
707
|
-
id: string;
|
|
708
|
-
transaction_id: string | null;
|
|
709
|
-
created_at: string;
|
|
710
|
-
updated_at: string;
|
|
711
|
-
amount: string | null;
|
|
712
|
-
payment_id: string | null;
|
|
713
|
-
refund_reason_id: string | null;
|
|
714
|
-
reimbursement_id: string | null;
|
|
715
|
-
};
|
|
716
|
-
|
|
717
|
-
type StoreReimbursement = {
|
|
718
|
-
id: string;
|
|
719
|
-
number: string;
|
|
720
|
-
reimbursement_status: string | null;
|
|
721
|
-
created_at: string;
|
|
722
|
-
updated_at: string;
|
|
723
|
-
total: string | null;
|
|
724
|
-
order_id: string | null;
|
|
725
|
-
customer_return_id: string | null;
|
|
726
|
-
};
|
|
727
|
-
|
|
728
|
-
type StoreReport = {
|
|
729
|
-
id: string;
|
|
730
|
-
type: string | null;
|
|
731
|
-
currency: string | null;
|
|
732
|
-
created_at: string;
|
|
733
|
-
updated_at: string;
|
|
734
|
-
user_id: string | null;
|
|
735
|
-
date_from: string | null;
|
|
736
|
-
date_to: string | null;
|
|
737
|
-
};
|
|
738
|
-
|
|
739
|
-
type StoreReturnAuthorization = {
|
|
740
|
-
id: string;
|
|
741
|
-
number: string;
|
|
742
|
-
created_at: string;
|
|
743
|
-
updated_at: string;
|
|
744
|
-
state: string;
|
|
745
|
-
order_id: string | null;
|
|
746
|
-
stock_location_id: string | null;
|
|
747
|
-
return_authorization_reason_id: string | null;
|
|
748
|
-
};
|
|
749
|
-
|
|
750
|
-
type StoreReturnItem = {
|
|
751
|
-
id: string;
|
|
752
|
-
reception_status: string | null;
|
|
753
|
-
acceptance_status: string | null;
|
|
754
|
-
created_at: string;
|
|
755
|
-
updated_at: string;
|
|
756
|
-
pre_tax_amount: string | null;
|
|
757
|
-
included_tax_total: string | null;
|
|
758
|
-
additional_tax_total: string | null;
|
|
759
|
-
inventory_unit_id: string | null;
|
|
760
|
-
return_authorization_id: string | null;
|
|
761
|
-
customer_return_id: string | null;
|
|
762
|
-
reimbursement_id: string | null;
|
|
763
|
-
exchange_variant_id: string | null;
|
|
764
|
-
};
|
|
765
|
-
|
|
766
|
-
type StoreShipment = {
|
|
767
|
-
id: string;
|
|
768
|
-
number: string;
|
|
769
|
-
state: string;
|
|
770
|
-
tracking: string | null;
|
|
771
|
-
tracking_url: string | null;
|
|
772
|
-
cost: string;
|
|
773
|
-
display_cost: string;
|
|
774
|
-
shipped_at: string | null;
|
|
775
|
-
created_at: string;
|
|
776
|
-
updated_at: string;
|
|
777
|
-
shipping_method: StoreShippingMethod;
|
|
778
|
-
stock_location: StoreStockLocation;
|
|
779
|
-
shipping_rates: Array<StoreShippingRate>;
|
|
780
|
-
};
|
|
781
|
-
|
|
782
|
-
type StoreShippingMethod = {
|
|
783
|
-
id: string;
|
|
784
|
-
name: string;
|
|
785
|
-
code: string | null;
|
|
786
|
-
};
|
|
787
|
-
|
|
788
|
-
type StoreShippingRate = {
|
|
789
|
-
id: string;
|
|
790
|
-
shipping_method_id: string;
|
|
791
|
-
name: string;
|
|
792
|
-
selected: boolean;
|
|
793
|
-
cost: string;
|
|
794
|
-
display_cost: string;
|
|
795
|
-
shipping_method: StoreShippingMethod;
|
|
796
|
-
};
|
|
797
|
-
|
|
798
|
-
type StoreState = {
|
|
799
|
-
abbr: string;
|
|
800
|
-
name: string;
|
|
801
|
-
};
|
|
802
|
-
|
|
803
|
-
type StoreStockItem = {
|
|
804
|
-
id: string;
|
|
805
|
-
count_on_hand: number;
|
|
806
|
-
backorderable: boolean;
|
|
807
|
-
created_at: string;
|
|
808
|
-
updated_at: string;
|
|
809
|
-
stock_location_id: string | null;
|
|
810
|
-
variant_id: string | null;
|
|
811
|
-
};
|
|
812
|
-
|
|
813
|
-
type StoreStockLocation = {
|
|
814
|
-
id: string;
|
|
815
|
-
state_abbr: string | null;
|
|
816
|
-
name: string;
|
|
817
|
-
address1: string | null;
|
|
818
|
-
city: string | null;
|
|
819
|
-
zipcode: string | null;
|
|
820
|
-
country_iso: string | null;
|
|
821
|
-
country_name: string | null;
|
|
822
|
-
state_text: string | null;
|
|
823
|
-
};
|
|
824
|
-
|
|
825
|
-
type StoreStockMovement = {
|
|
826
|
-
id: string;
|
|
827
|
-
quantity: number;
|
|
828
|
-
action: string | null;
|
|
829
|
-
originator_type: string | null;
|
|
830
|
-
created_at: string;
|
|
831
|
-
updated_at: string;
|
|
832
|
-
originator_id: string | null;
|
|
833
|
-
stock_item_id: string | null;
|
|
834
|
-
};
|
|
835
|
-
|
|
836
|
-
type StoreStockTransfer = {
|
|
837
|
-
id: string;
|
|
838
|
-
number: string | null;
|
|
839
|
-
type: string | null;
|
|
840
|
-
reference: string | null;
|
|
841
|
-
created_at: string;
|
|
842
|
-
updated_at: string;
|
|
843
|
-
source_location_id: string | null;
|
|
844
|
-
destination_location_id: string | null;
|
|
845
|
-
};
|
|
846
|
-
|
|
847
|
-
type StoreStoreCredit = {
|
|
848
|
-
id: string;
|
|
849
|
-
amount: string;
|
|
850
|
-
amount_used: string;
|
|
851
|
-
amount_remaining: string;
|
|
852
|
-
display_amount: string;
|
|
853
|
-
display_amount_used: string;
|
|
854
|
-
display_amount_remaining: string;
|
|
855
|
-
currency: string;
|
|
856
|
-
};
|
|
857
|
-
|
|
858
|
-
type StoreTaxon = {
|
|
859
|
-
id: string;
|
|
860
|
-
name: string;
|
|
861
|
-
permalink: string;
|
|
862
|
-
position: number;
|
|
863
|
-
depth: number;
|
|
864
|
-
meta_title: string | null;
|
|
865
|
-
meta_description: string | null;
|
|
866
|
-
meta_keywords: string | null;
|
|
867
|
-
children_count: number;
|
|
868
|
-
created_at: string;
|
|
869
|
-
updated_at: string;
|
|
870
|
-
parent_id: string | null;
|
|
871
|
-
taxonomy_id: string;
|
|
872
|
-
description: string;
|
|
873
|
-
description_html: string;
|
|
874
|
-
image_url: string | null;
|
|
875
|
-
square_image_url: string | null;
|
|
876
|
-
is_root: boolean;
|
|
877
|
-
is_child: boolean;
|
|
878
|
-
is_leaf: boolean;
|
|
879
|
-
parent?: StoreTaxon;
|
|
880
|
-
children?: Array<StoreTaxon>;
|
|
881
|
-
ancestors?: Array<StoreTaxon>;
|
|
882
|
-
metafields?: Array<StoreMetafield>;
|
|
883
|
-
};
|
|
884
|
-
|
|
885
|
-
type StoreTaxonomy = {
|
|
886
|
-
id: string;
|
|
887
|
-
name: string;
|
|
888
|
-
position: number;
|
|
889
|
-
created_at: string;
|
|
890
|
-
updated_at: string;
|
|
891
|
-
root_id: string | null;
|
|
892
|
-
root?: StoreTaxon;
|
|
893
|
-
taxons?: Array<StoreTaxon>;
|
|
894
|
-
metafields?: Array<StoreMetafield>;
|
|
895
|
-
};
|
|
896
|
-
|
|
897
|
-
type StoreVariant = {
|
|
898
|
-
id: string;
|
|
899
|
-
product_id: string;
|
|
900
|
-
sku: string | null;
|
|
901
|
-
is_master: boolean;
|
|
902
|
-
options_text: string;
|
|
903
|
-
track_inventory: boolean;
|
|
904
|
-
image_count: number;
|
|
905
|
-
created_at: string;
|
|
906
|
-
updated_at: string;
|
|
907
|
-
thumbnail: string | null;
|
|
908
|
-
purchasable: boolean;
|
|
909
|
-
in_stock: boolean;
|
|
910
|
-
backorderable: boolean;
|
|
911
|
-
weight: number | null;
|
|
912
|
-
height: number | null;
|
|
913
|
-
width: number | null;
|
|
914
|
-
depth: number | null;
|
|
915
|
-
price: StorePrice;
|
|
916
|
-
original_price: StorePrice | null;
|
|
917
|
-
images?: Array<StoreImage>;
|
|
918
|
-
option_values: Array<StoreOptionValue>;
|
|
919
|
-
metafields?: Array<StoreMetafield>;
|
|
920
|
-
};
|
|
921
|
-
|
|
922
|
-
type StoreWishedItem = {
|
|
923
|
-
id: string;
|
|
924
|
-
variant_id: string;
|
|
925
|
-
wishlist_id: string;
|
|
926
|
-
quantity: number;
|
|
927
|
-
created_at: string;
|
|
928
|
-
updated_at: string;
|
|
929
|
-
variant: StoreVariant;
|
|
930
|
-
};
|
|
931
|
-
|
|
932
|
-
type StoreWishlist = {
|
|
933
|
-
id: string;
|
|
934
|
-
name: string;
|
|
935
|
-
token: string;
|
|
936
|
-
created_at: string;
|
|
937
|
-
updated_at: string;
|
|
938
|
-
is_default: boolean;
|
|
939
|
-
is_private: boolean;
|
|
940
|
-
items?: Array<StoreWishedItem>;
|
|
941
|
-
};
|
|
942
|
-
|
|
943
|
-
interface LocaleDefaults {
|
|
944
|
-
locale?: string;
|
|
945
|
-
currency?: string;
|
|
946
|
-
country?: string;
|
|
947
|
-
}
|
|
948
|
-
interface PaginationMeta {
|
|
949
|
-
page: number;
|
|
950
|
-
limit: number;
|
|
951
|
-
count: number;
|
|
952
|
-
pages: number;
|
|
953
|
-
from: number;
|
|
954
|
-
to: number;
|
|
955
|
-
in: number;
|
|
956
|
-
previous: number | null;
|
|
957
|
-
next: number | null;
|
|
958
|
-
}
|
|
959
|
-
interface ListResponse<T> {
|
|
960
|
-
data: T[];
|
|
961
|
-
}
|
|
962
|
-
interface PaginatedResponse<T> extends ListResponse<T> {
|
|
963
|
-
meta: PaginationMeta;
|
|
964
|
-
}
|
|
965
|
-
interface ErrorResponse {
|
|
966
|
-
error: {
|
|
967
|
-
code: string;
|
|
968
|
-
message: string;
|
|
969
|
-
details?: Record<string, string[]>;
|
|
970
|
-
};
|
|
971
|
-
}
|
|
972
|
-
interface AuthTokens {
|
|
973
|
-
token: string;
|
|
974
|
-
user: {
|
|
975
|
-
id: string;
|
|
976
|
-
email: string;
|
|
977
|
-
first_name: string | null;
|
|
978
|
-
last_name: string | null;
|
|
979
|
-
};
|
|
980
|
-
}
|
|
981
|
-
interface LoginCredentials {
|
|
982
|
-
email: string;
|
|
983
|
-
password: string;
|
|
984
|
-
}
|
|
985
|
-
interface RegisterParams {
|
|
986
|
-
email: string;
|
|
987
|
-
password: string;
|
|
988
|
-
password_confirmation: string;
|
|
989
|
-
first_name?: string;
|
|
990
|
-
last_name?: string;
|
|
991
|
-
}
|
|
992
|
-
interface ListParams {
|
|
993
|
-
page?: number;
|
|
994
|
-
limit?: number;
|
|
995
|
-
/** Sort order. Prefix with - for descending, e.g. '-created_at', 'name'. Comma-separated for multiple fields. */
|
|
996
|
-
sort?: string;
|
|
997
|
-
/** Associations to expand. Supports dot notation for nested expand (max 4 levels), e.g. ['variants', 'variants.images'] */
|
|
998
|
-
expand?: string[];
|
|
999
|
-
/** Fields to include in response, e.g. ['name', 'slug', 'price']. Omit to return all fields. 'id' is always included. */
|
|
1000
|
-
fields?: string[];
|
|
1001
|
-
}
|
|
1002
|
-
interface ProductListParams extends ListParams {
|
|
1003
|
-
/** Sort: 'price', '-price', 'best_selling', 'name', '-name', '-available_on', 'available_on' */
|
|
1004
|
-
sort?: string;
|
|
1005
|
-
/** Full-text search across name and SKU */
|
|
1006
|
-
multi_search?: string;
|
|
1007
|
-
/** Filter: name contains */
|
|
1008
|
-
name_cont?: string;
|
|
1009
|
-
/** Filter: price >= value */
|
|
1010
|
-
price_gte?: number;
|
|
1011
|
-
/** Filter: price <= value */
|
|
1012
|
-
price_lte?: number;
|
|
1013
|
-
/** Filter by option value prefix IDs */
|
|
1014
|
-
with_option_value_ids?: string[];
|
|
1015
|
-
/** Filter: only in-stock products */
|
|
1016
|
-
in_stock?: boolean;
|
|
1017
|
-
/** Filter: only out-of-stock products */
|
|
1018
|
-
out_of_stock?: boolean;
|
|
1019
|
-
/** Filter: products in taxon */
|
|
1020
|
-
taxons_id_eq?: string;
|
|
1021
|
-
/** Any additional Ransack predicate */
|
|
1022
|
-
[key: string]: string | number | boolean | (string | number)[] | undefined;
|
|
1023
|
-
}
|
|
1024
|
-
interface TaxonListParams extends ListParams {
|
|
1025
|
-
/** Sort order, e.g. 'name', '-created_at' */
|
|
1026
|
-
sort?: string;
|
|
1027
|
-
/** Filter: name contains */
|
|
1028
|
-
name_cont?: string;
|
|
1029
|
-
taxonomy_id_eq?: string | number;
|
|
1030
|
-
parent_id_eq?: string | number;
|
|
1031
|
-
depth_eq?: number;
|
|
1032
|
-
/** Any additional Ransack predicate */
|
|
1033
|
-
[key: string]: string | number | boolean | (string | number)[] | undefined;
|
|
1034
|
-
}
|
|
1035
|
-
interface OrderListParams extends ListParams {
|
|
1036
|
-
/** Sort order, e.g. 'completed_at desc' */
|
|
1037
|
-
sort?: string;
|
|
1038
|
-
/** Full-text search across number, email, customer name */
|
|
1039
|
-
multi_search?: string;
|
|
1040
|
-
state_eq?: string;
|
|
1041
|
-
completed_at_gte?: string;
|
|
1042
|
-
completed_at_lte?: string;
|
|
1043
|
-
/** Any additional Ransack predicate */
|
|
1044
|
-
[key: string]: string | number | boolean | (string | number)[] | undefined;
|
|
1045
|
-
}
|
|
1046
|
-
interface LineItemInput {
|
|
1047
|
-
/** Prefixed variant ID (e.g., "variant_k5nR8xLq") */
|
|
1048
|
-
variant_id: string;
|
|
1049
|
-
/** Quantity to set (defaults to 1 if omitted) */
|
|
1050
|
-
quantity?: number;
|
|
1051
|
-
/** Arbitrary key-value metadata (merged with existing on upsert) */
|
|
1052
|
-
metadata?: Record<string, unknown>;
|
|
1053
|
-
}
|
|
1054
|
-
interface CreateCartParams {
|
|
1055
|
-
/** Arbitrary key-value metadata (stored, not returned in responses) */
|
|
1056
|
-
metadata?: Record<string, unknown>;
|
|
1057
|
-
/** Line items to add to the cart on creation */
|
|
1058
|
-
line_items?: LineItemInput[];
|
|
1059
|
-
}
|
|
1060
|
-
interface AddLineItemParams {
|
|
1061
|
-
variant_id: string;
|
|
1062
|
-
quantity: number;
|
|
1063
|
-
/** Arbitrary key-value metadata (stored, not returned in responses) */
|
|
1064
|
-
metadata?: Record<string, unknown>;
|
|
1065
|
-
}
|
|
1066
|
-
interface UpdateLineItemParams {
|
|
1067
|
-
quantity?: number;
|
|
1068
|
-
/** Arbitrary key-value metadata (merged with existing) */
|
|
1069
|
-
metadata?: Record<string, unknown>;
|
|
1070
|
-
}
|
|
1071
|
-
interface AddressParams {
|
|
1072
|
-
firstname: string;
|
|
1073
|
-
lastname: string;
|
|
1074
|
-
address1: string;
|
|
1075
|
-
address2?: string;
|
|
1076
|
-
city: string;
|
|
1077
|
-
zipcode: string;
|
|
1078
|
-
phone?: string;
|
|
1079
|
-
company?: string;
|
|
1080
|
-
/** ISO 3166-1 alpha-2 country code (e.g., "US", "DE") */
|
|
1081
|
-
country_iso: string;
|
|
1082
|
-
/** ISO 3166-2 subdivision code without country prefix (e.g., "CA", "NY") */
|
|
1083
|
-
state_abbr?: string;
|
|
1084
|
-
/** State name - used for countries without predefined states */
|
|
1085
|
-
state_name?: string;
|
|
1086
|
-
/** When true, relaxes validation requirements (name, phone, zipcode, street) */
|
|
1087
|
-
quick_checkout?: boolean;
|
|
1088
|
-
}
|
|
1089
|
-
interface UpdateOrderParams {
|
|
1090
|
-
email?: string;
|
|
1091
|
-
currency?: string;
|
|
1092
|
-
locale?: string;
|
|
1093
|
-
special_instructions?: string;
|
|
1094
|
-
/** Arbitrary key-value metadata (merged with existing) */
|
|
1095
|
-
metadata?: Record<string, unknown>;
|
|
1096
|
-
/** Existing address ID to use */
|
|
1097
|
-
bill_address_id?: string;
|
|
1098
|
-
/** Existing address ID to use */
|
|
1099
|
-
ship_address_id?: string;
|
|
1100
|
-
/** New billing address */
|
|
1101
|
-
bill_address?: AddressParams;
|
|
1102
|
-
/** New shipping address */
|
|
1103
|
-
ship_address?: AddressParams;
|
|
1104
|
-
/** Line items to upsert (sets quantity for existing, creates new) */
|
|
1105
|
-
line_items?: LineItemInput[];
|
|
1106
|
-
}
|
|
1107
|
-
interface CreatePaymentSessionParams {
|
|
1108
|
-
payment_method_id: string;
|
|
1109
|
-
amount?: string;
|
|
1110
|
-
external_data?: Record<string, unknown>;
|
|
1111
|
-
}
|
|
1112
|
-
interface UpdatePaymentSessionParams {
|
|
1113
|
-
amount?: string;
|
|
1114
|
-
external_data?: Record<string, unknown>;
|
|
1115
|
-
}
|
|
1116
|
-
interface CompletePaymentSessionParams {
|
|
1117
|
-
session_result?: string;
|
|
1118
|
-
external_data?: Record<string, unknown>;
|
|
1119
|
-
}
|
|
1120
|
-
interface CreatePaymentSetupSessionParams {
|
|
1121
|
-
payment_method_id: string;
|
|
1122
|
-
external_data?: Record<string, unknown>;
|
|
1123
|
-
}
|
|
1124
|
-
interface CompletePaymentSetupSessionParams {
|
|
1125
|
-
external_data?: Record<string, unknown>;
|
|
1126
|
-
}
|
|
1127
|
-
interface FilterOption {
|
|
1128
|
-
id: string;
|
|
1129
|
-
count: number;
|
|
1130
|
-
}
|
|
1131
|
-
interface OptionFilterOption extends FilterOption {
|
|
1132
|
-
name: string;
|
|
1133
|
-
presentation: string;
|
|
1134
|
-
position: number;
|
|
1135
|
-
}
|
|
1136
|
-
interface TaxonFilterOption {
|
|
1137
|
-
id: string;
|
|
1138
|
-
name: string;
|
|
1139
|
-
permalink: string;
|
|
1140
|
-
count: number;
|
|
1141
|
-
}
|
|
1142
|
-
interface PriceRangeFilter {
|
|
1143
|
-
id: 'price';
|
|
1144
|
-
type: 'price_range';
|
|
1145
|
-
min: number;
|
|
1146
|
-
max: number;
|
|
1147
|
-
currency: string;
|
|
1148
|
-
}
|
|
1149
|
-
interface AvailabilityFilter {
|
|
1150
|
-
id: 'availability';
|
|
1151
|
-
type: 'availability';
|
|
1152
|
-
options: FilterOption[];
|
|
1153
|
-
}
|
|
1154
|
-
interface OptionFilter {
|
|
1155
|
-
id: string;
|
|
1156
|
-
type: 'option';
|
|
1157
|
-
name: string;
|
|
1158
|
-
presentation: string;
|
|
1159
|
-
options: OptionFilterOption[];
|
|
1160
|
-
}
|
|
1161
|
-
interface TaxonFilter {
|
|
1162
|
-
id: 'taxons';
|
|
1163
|
-
type: 'taxon';
|
|
1164
|
-
options: TaxonFilterOption[];
|
|
1165
|
-
}
|
|
1166
|
-
type ProductFilter = PriceRangeFilter | AvailabilityFilter | OptionFilter | TaxonFilter;
|
|
1167
|
-
interface SortOption {
|
|
1168
|
-
id: string;
|
|
1169
|
-
}
|
|
1170
|
-
interface ProductFiltersResponse {
|
|
1171
|
-
filters: ProductFilter[];
|
|
1172
|
-
sort_options: SortOption[];
|
|
1173
|
-
default_sort: string;
|
|
1174
|
-
total_count: number;
|
|
1175
|
-
}
|
|
1176
|
-
interface ProductFiltersParams {
|
|
1177
|
-
taxon_id?: string;
|
|
1178
|
-
q?: Record<string, unknown>;
|
|
1179
|
-
}
|
|
1180
|
-
|
|
1181
|
-
export type { AddLineItemParams, AddressParams, AdminCustomer, AdminLineItem, AdminMetafield, AdminOrder, AdminPrice, AdminProduct, AdminTaxon, AdminTaxonomy, AdminVariant, AuthTokens, AvailabilityFilter, CompletePaymentSessionParams, CompletePaymentSetupSessionParams, CreateCartParams, CreatePaymentSessionParams, CreatePaymentSetupSessionParams, ErrorResponse, FilterOption, LineItemInput, ListParams, ListResponse, LocaleDefaults, LoginCredentials, OptionFilter, OptionFilterOption, OrderListParams, PaginatedResponse, PaginationMeta, PriceRangeFilter, ProductFilter, ProductFiltersParams, ProductFiltersResponse, ProductListParams, RegisterParams, SortOption, StoreAddress, StoreAsset, StoreBase, StoreCountry, StoreCreditCard, StoreCurrency, StoreCustomer, StoreCustomerReturn, StoreDigital, StoreDigitalLink, StoreExport, StoreGiftCard, StoreGiftCardBatch, StoreImage, StoreImport, StoreImportRow, StoreInvitation, StoreLineItem, StoreLocale, StoreMarket, StoreMetafield, StoreNewsletterSubscriber, StoreOptionType, StoreOptionValue, StoreOrder, StoreOrderPromotion, StorePayment, StorePaymentMethod, StorePaymentSession, StorePaymentSetupSession, StorePaymentSource, StorePrice, StoreProduct, StorePromotion, StoreRefund, StoreReimbursement, StoreReport, StoreReturnAuthorization, StoreReturnItem, StoreShipment, StoreShippingMethod, StoreShippingRate, StoreState, StoreStockItem, StoreStockLocation, StoreStockMovement, StoreStockTransfer, StoreStoreCredit, StoreTaxon, StoreTaxonomy, StoreVariant, StoreWishedItem, StoreWishlist, TaxonFilter, TaxonFilterOption, TaxonListParams, UpdateLineItemParams, UpdateOrderParams, UpdatePaymentSessionParams };
|
|
1
|
+
export { n as AddLineItemParams, w as Address, x as AddressParams, I as Asset, A as AuthTokens, J as AvailabilityFilter, K as Base, u as CompletePaymentSessionParams, E as CompletePaymentSetupSessionParams, C as Country, m as CreateCartParams, r as CreatePaymentSessionParams, B as CreatePaymentSetupSessionParams, y as CreditCard, k as Currency, v as Customer, N as CustomerReturn, Q as Digital, V as DigitalLink, X as ErrorResponse, Y as Export, Z as FilterOption, G as GiftCard, _ as GiftCardBatch, $ as Image, a0 as Import, a1 as ImportRow, a2 as Invitation, a3 as LineItem, a4 as LineItemInput, g as ListParams, j as ListResponse, l as Locale, a5 as LocaleDefaults, L as LoginCredentials, M as Market, a6 as Metafield, a7 as NewsletterSubscriber, a8 as OptionFilter, a9 as OptionFilterOption, aa as OptionType, ab as OptionValue, O as Order, z as OrderListParams, ac as OrderPromotion, c as PaginatedResponse, ad as PaginationMeta, p as Payment, q as PaymentMethod, s as PaymentSession, D as PaymentSetupSession, ae as PaymentSource, af as Price, ag as PriceRangeFilter, d as Product, ah as ProductFilter, e as ProductFiltersParams, f as ProductFiltersResponse, P as ProductListParams, ai as Promotion, aj as Refund, a as RegisterParams, ak as Reimbursement, al as Report, am as ReturnAuthorization, an as ReturnItem, S as Shipment, ao as ShippingCategory, ap as ShippingMethod, aq as ShippingRate, ar as SortOption, at as State, au as StockItem, av as StockLocation, aw as StockMovement, ax as StockTransfer, w as StoreAddress, I as StoreAsset, C as StoreCountry, ay as StoreCredit, y as StoreCreditCard, k as StoreCurrency, v as StoreCustomer, N as StoreCustomerReturn, Q as StoreDigital, V as StoreDigitalLink, G as StoreGiftCard, _ as StoreGiftCardBatch, $ as StoreImage, a3 as StoreLineItem, l as StoreLocale, M as StoreMarket, a6 as StoreMetafield, aa as StoreOptionType, ab as StoreOptionValue, O as StoreOrder, ac as StoreOrderPromotion, p as StorePayment, q as StorePaymentMethod, s as StorePaymentSession, D as StorePaymentSetupSession, ae as StorePaymentSource, af as StorePrice, d as StoreProduct, ai as StorePromotion, aj as StoreRefund, ak as StoreReimbursement, am as StoreReturnAuthorization, an as StoreReturnItem, S as StoreShipment, ao as StoreShippingCategory, ap as StoreShippingMethod, aq as StoreShippingRate, at as StoreState, au as StoreStockItem, av as StoreStockLocation, ay as StoreStoreCredit, az as StoreTaxCategory, i as StoreTaxon, T as StoreTaxonomy, aA as StoreVariant, F as StoreWishedItem, W as StoreWishlist, az as TaxCategory, i as Taxon, aB as TaxonFilter, aC as TaxonFilterOption, h as TaxonListParams, T as Taxonomy, o as UpdateLineItemParams, U as UpdateOrderParams, t as UpdatePaymentSessionParams, aA as Variant, F as WishedItem, W as Wishlist } from '../index-CgJG4R8P.js';
|