@ecomiq/core 0.1.3 → 0.1.5

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.
Files changed (53) hide show
  1. package/dist/api.cjs +19 -5
  2. package/dist/api.cjs.map +1 -1
  3. package/dist/api.js +19 -5
  4. package/dist/api.js.map +1 -1
  5. package/dist/client-4ZTG2RZ3.d.ts +195 -0
  6. package/dist/client-BpX4yR6S.d.cts +195 -0
  7. package/dist/client.cjs +320 -6
  8. package/dist/client.cjs.map +1 -1
  9. package/dist/client.d.cts +13 -84
  10. package/dist/client.d.ts +13 -84
  11. package/dist/client.js +320 -6
  12. package/dist/client.js.map +1 -1
  13. package/dist/index.cjs +471 -6
  14. package/dist/index.cjs.map +1 -1
  15. package/dist/index.d.cts +326 -323
  16. package/dist/index.d.ts +326 -323
  17. package/dist/index.js +440 -7
  18. package/dist/index.js.map +1 -1
  19. package/dist/models/collections.d.cts +4 -4
  20. package/dist/models/collections.d.ts +4 -4
  21. package/dist/models/customer-address.cjs +41 -0
  22. package/dist/models/customer-address.cjs.map +1 -0
  23. package/dist/models/customer-address.d.cts +160 -0
  24. package/dist/models/customer-address.d.ts +160 -0
  25. package/dist/models/customer-address.js +36 -0
  26. package/dist/models/customer-address.js.map +1 -0
  27. package/dist/models/customer-order.cjs +161 -0
  28. package/dist/models/customer-order.cjs.map +1 -0
  29. package/dist/models/customer-order.d.cts +896 -0
  30. package/dist/models/customer-order.d.ts +896 -0
  31. package/dist/models/customer-order.js +149 -0
  32. package/dist/models/customer-order.js.map +1 -0
  33. package/dist/models/customer-profile.cjs +126 -0
  34. package/dist/models/customer-profile.cjs.map +1 -0
  35. package/dist/models/customer-profile.d.cts +178 -0
  36. package/dist/models/customer-profile.d.ts +178 -0
  37. package/dist/models/customer-profile.js +118 -0
  38. package/dist/models/customer-profile.js.map +1 -0
  39. package/dist/models/geo.d.cts +14 -14
  40. package/dist/models/geo.d.ts +14 -14
  41. package/dist/models/products.d.cts +130 -130
  42. package/dist/models/products.d.ts +130 -130
  43. package/dist/models/search.d.cts +4 -4
  44. package/dist/models/search.d.ts +4 -4
  45. package/dist/models/settings.d.cts +798 -798
  46. package/dist/models/settings.d.ts +798 -798
  47. package/dist/models/storefront-cart.d.cts +80 -80
  48. package/dist/models/storefront-cart.d.ts +80 -80
  49. package/dist/models/storefront-checkout.d.cts +400 -400
  50. package/dist/models/storefront-checkout.d.ts +400 -400
  51. package/dist/models/storefront-reviews.d.cts +8 -8
  52. package/dist/models/storefront-reviews.d.ts +8 -8
  53. package/package.json +16 -1
package/dist/index.d.cts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { Api } from './api.cjs';
2
2
  export { ApiError, CreateApiOptions, DEFAULT_API_BASE_URL, DEFAULT_API_VERSION, createApi, resolveApiBaseUrl } from './api.cjs';
3
- export { CreateClientOptions, StorefrontClient, createClient, createStorefrontClient } from './client.cjs';
3
+ export { C as CreateClientOptions, a as CustomerAddressMutationResponse, b as CustomerAddressMutationResponseSchema, c as CustomerAddressRequestOptions, d as CustomerOrderRequestOptions, e as CustomerRequestOptions, S as StorefrontClient, f as createClient, g as createCustomerAddress, h as createStorefrontClient, i as deleteCustomerAddress, j as getCustomerAddresses, k as getCustomerMe, l as getCustomerOrder, m as getCustomerOrders, p as patchCustomer, r as registerCustomer, u as updateCustomerAddress } from './client-BpX4yR6S.cjs';
4
4
  import { CmsPageDetailsDto } from './models/settings.cjs';
5
5
  export { CmsBlockDto, CmsBlockDtoSchema, CmsBrandingSettingsDtoSchema, CmsContactSettingsDtoSchema, CmsContentChannelSchema, CmsCustomScriptsDtoSchema, CmsMenuDto, CmsMenuDtoSchema, CmsMenuItem, CmsMenuItemSchema, CmsPageDetailsDtoSchema, CmsPageStatusSchema, CmsSectionDto, CmsSectionDtoSchema, CmsSeoSettingsDtoSchema, CmsSiteSettingsDtoSchema, CmsSnapshotDto, CmsSnapshotDtoSchema, CmsSocialLinksDtoSchema, CmsTrackingSettingsDtoSchema, JsonElement, JsonElementSchema, StoreCheckoutCartPageSettingsSchema, StoreCheckoutGeneralSettingsSchema, StoreCheckoutOrderBumpSettingsSchema, StoreCheckoutOrdersAndPaymentsSettingsSchema, StoreCheckoutSettingsSchema, StoreCheckoutShippingSettingsSchema, StoreFeatureFlagsSchema, StoreModel, StoreModelSchema, StoreSettingsSnapshotDto, StoreSettingsSnapshotDtoSchema, StoreThemeSettingsSchema, StoreTypeSchema, StoreVisibilitySchema, StorefrontCheckoutSettingsSchema, StorefrontCmsBrandingSchema, StorefrontCmsContactSchema, StorefrontCmsCustomScriptsSchema, StorefrontCmsPageSchema, StorefrontCmsSeoSchema, StorefrontCmsSettingsSchema, StorefrontCmsSocialLinksSchema, StorefrontCmsTrackingSchema, StorefrontFeaturesEnabledSchema, StorefrontMenu, StorefrontMenuItem, StorefrontMenuItemSchema, StorefrontMenuSchema, StorefrontSettings, StorefrontSettingsSchema, StorefrontStoreSchema, StorefrontStoreTypeSchema, StorefrontThemeConfigSchema, getMenuItems } from './models/settings.cjs';
6
6
  export { Collection, CollectionSchema, Collections, CollectionsSchema } from './models/collections.cjs';
@@ -16,6 +16,9 @@ import { CreateProductReviewParams, ListProductReviewsParams } from './models/st
16
16
  export { CreateProductReviewParamsSchema, ListProductReviewsParamsSchema, StorefrontReview, StorefrontReviewSchema, StorefrontReviews, StorefrontReviewsSchema } from './models/storefront-reviews.cjs';
17
17
  import { Countries, GetDepartmentsParams, Departments, GetDistrictsParams, Districts, GetProvincesParams, Provinces } from './models/geo.cjs';
18
18
  export { CountriesSchema, Country, CountrySchema, Department, DepartmentSchema, DepartmentsSchema, District, DistrictSchema, DistrictsSchema, GeoDivision, GeoDivisionSchema, GeoDivisionType, GeoDivisionTypeSchema, GetDepartmentsParamsParsed, GetDepartmentsParamsSchema, GetDistrictsParamsParsed, GetDistrictsParamsSchema, GetProvincesParamsParsed, GetProvincesParamsSchema, Province, ProvinceSchema, ProvincesSchema } from './models/geo.cjs';
19
+ export { CustomerAddress, CustomerAddressSchema, CustomerAddressUpsertInput, CustomerAddressUpsertInputSchema, CustomerAddresses, CustomerAddressesSchema, CustomerSavedAddress, toCustomerSavedAddresses } from './models/customer-address.cjs';
20
+ export { CustomerMe, CustomerMeSchema, CustomerProfile, CustomerProfilePatch, CustomerProfilePatchSchema, CustomerProfileSchema, CustomerRegisterRequest, CustomerRegisterRequestSchema, customerMeToProfile, customerMeToProfilePatch, customerProfileToPatch } from './models/customer-profile.cjs';
21
+ export { CustomerOrderDetail, CustomerOrderDetailDto, CustomerOrderDetailSchema, CustomerOrderLineItem, CustomerOrderLineItemSchema, CustomerOrderList, CustomerOrderListItem, CustomerOrderListItemDto, CustomerOrderListItemSchema, CustomerOrderListSchema, CustomerOrderPayment, CustomerOrderPaymentSchema, CustomerOrderShippingAddress, CustomerOrderShippingAddressSchema, CustomerOrderStatusTimelineEntry, CustomerOrderStatusTimelineSchema, customerOrderStatusTone, formatCustomerOrderStatus, formatOrderDate, formatOrderDateTime } from './models/customer-order.cjs';
19
22
  import 'zod';
20
23
 
21
24
  declare function getProducts(api: Api, params?: ProductsParamsInput): Promise<{
@@ -25,9 +28,9 @@ declare function getProducts(api: Api, params?: ProductsParamsInput): Promise<{
25
28
  totalPages: number;
26
29
  products: {
27
30
  status: string;
28
- name: string;
29
31
  id: string;
30
32
  slug: string;
33
+ name: string;
31
34
  imageUrl: string;
32
35
  productType: string;
33
36
  price: number;
@@ -42,27 +45,27 @@ declare function getProducts(api: Api, params?: ProductsParamsInput): Promise<{
42
45
  tags: string[];
43
46
  }[];
44
47
  filters: {
48
+ type: "list" | "price_range";
45
49
  values: {
46
50
  value: string;
47
- label: string | null;
48
51
  count: number;
52
+ label: string | null;
49
53
  selected: boolean;
50
54
  }[];
51
- type: "list" | "price_range";
52
- min: number | null;
53
- max: number | null;
54
55
  id: string;
55
56
  label: string;
57
+ min: number | null;
58
+ max: number | null;
56
59
  selectedMin: number | null;
57
60
  selectedMax: number | null;
58
61
  }[];
59
62
  }>;
60
63
  declare function getProductBySlug(api: Api, slug: string, params?: ProductDetailParams): Promise<{
61
64
  status: string;
62
- name: string;
63
65
  id: string;
64
- description: string;
65
66
  slug: string;
67
+ name: string;
68
+ description: string;
66
69
  imageUrl: string;
67
70
  productType: string;
68
71
  price: number;
@@ -79,17 +82,17 @@ declare function getProductBySlug(api: Api, slug: string, params?: ProductDetail
79
82
  }[];
80
83
  categoryId: string | null;
81
84
  specifications: {
85
+ key: string;
82
86
  value: string;
83
87
  name: string;
84
- key: string;
85
88
  }[];
86
89
  variants: {
87
- status: string;
88
90
  options: {
91
+ key: string;
89
92
  value: string;
90
93
  name: string;
91
- key: string;
92
94
  }[];
95
+ status: string;
93
96
  id: string | null;
94
97
  price: number;
95
98
  compareAtPrice: number | null;
@@ -115,10 +118,10 @@ declare function getProductBySlug(api: Api, slug: string, params?: ProductDetail
115
118
  requiresShipping: boolean;
116
119
  }[];
117
120
  sizeGuide: {
118
- name: string;
119
121
  id: string;
120
- description: string | null;
121
122
  slug: string;
123
+ name: string;
124
+ description: string | null;
122
125
  imageUrl: string | null;
123
126
  gender: string;
124
127
  measurementType: string;
@@ -129,12 +132,12 @@ declare function getProductBySlug(api: Api, slug: string, params?: ProductDetail
129
132
  order: number;
130
133
  sizeKey: string;
131
134
  measurements: {
135
+ key: string;
132
136
  value: number | null;
133
137
  name: string;
138
+ description: string | null;
134
139
  min: number | null;
135
140
  max: number | null;
136
- description: string | null;
137
- key: string;
138
141
  }[];
139
142
  }[];
140
143
  } | null;
@@ -149,9 +152,9 @@ declare function getProductBySlug(api: Api, slug: string, params?: ProductDetail
149
152
  }>;
150
153
  declare function getRelatedProducts(api: Api, params: RelatedProductsParams): Promise<{
151
154
  status: string;
152
- name: string;
153
155
  id: string;
154
156
  slug: string;
157
+ name: string;
155
158
  imageUrl: string;
156
159
  productType: string;
157
160
  price: number;
@@ -167,9 +170,9 @@ declare function getRelatedProducts(api: Api, params: RelatedProductsParams): Pr
167
170
  }[]>;
168
171
 
169
172
  declare function autocompleteProducts(api: Api, params: ProductAutocompleteParams): Promise<{
170
- name: string;
171
173
  id: string;
172
174
  slug: string;
175
+ name: string;
173
176
  imageUrl: string;
174
177
  }[]>;
175
178
 
@@ -177,95 +180,95 @@ declare function listProductReviews(api: Api, params: ListProductReviewsParams):
177
180
  totalCount: number | null;
178
181
  data: {
179
182
  id: string;
180
- createdOn: string;
181
183
  productId: string;
182
184
  isVerifiedPurchase: boolean;
183
185
  rating: number;
184
186
  title: string | null;
185
187
  content: string;
186
188
  reviewerName: string | null;
189
+ createdOn: string;
187
190
  }[];
188
191
  hasNextPage: boolean;
189
192
  nextCursor: string | null;
190
193
  }>;
191
194
  declare function createProductReview(api: Api, params: CreateProductReviewParams): Promise<{
192
195
  id: string;
193
- createdOn: string;
194
196
  productId: string;
195
197
  isVerifiedPurchase: boolean;
196
198
  rating: number;
197
199
  title: string | null;
198
200
  content: string;
199
201
  reviewerName: string | null;
202
+ createdOn: string;
200
203
  }>;
201
204
 
202
205
  declare function createCart(api: Api, params: CreateCartParams): Promise<{
203
206
  status: "inProgress" | "pending" | "completed" | "abandoned" | "cancelled" | "expired" | "failed";
204
- email: string | null;
205
207
  id: string;
206
208
  phone: string | null;
207
- items: {
208
- id: string;
209
- productId: number;
210
- quantity: number;
211
- variantId: number;
212
- unitPrice: number;
213
- bundleItems: {
214
- imageUrl: string | null;
215
- brand: string | null;
216
- productId: number;
217
- sku: string | null;
218
- quantity: number;
219
- variantId: number;
220
- productName: string;
221
- variantName: string | null;
222
- }[];
223
- title: string;
224
- variantLabel: string | null;
225
- productHandle: string | null;
226
- thumbnail: string | null;
227
- variantSku: string | null;
228
- compareAtUnitPrice: number | null;
229
- }[];
230
209
  cartNumber: string;
210
+ email: string | null;
231
211
  firstName: string | null;
232
212
  lastName: string | null;
233
213
  currencyCode: string;
234
214
  completedAt: string | null;
235
215
  shippingAddress: {
236
216
  name: string | null;
237
- company: string | null;
238
- phone: string | null;
239
217
  address1: string;
240
218
  city: string;
241
219
  countryCode: string;
220
+ company: string | null;
242
221
  address2: string | null;
243
222
  province: string | null;
244
223
  postalCode: string | null;
245
224
  district: string | null;
225
+ phone: string | null;
246
226
  latitude: number | null;
247
227
  longitude: number | null;
248
228
  } | null;
249
229
  billingAddress: {
250
230
  name: string | null;
251
- company: string | null;
252
- phone: string | null;
253
231
  address1: string;
254
232
  city: string;
255
233
  countryCode: string;
234
+ company: string | null;
256
235
  address2: string | null;
257
236
  province: string | null;
258
237
  postalCode: string | null;
259
238
  district: string | null;
239
+ phone: string | null;
260
240
  latitude: number | null;
261
241
  longitude: number | null;
262
242
  } | null;
263
243
  promotionCodes: string[];
244
+ items: {
245
+ id: string;
246
+ productId: number;
247
+ quantity: number;
248
+ variantId: number;
249
+ unitPrice: number;
250
+ bundleItems: {
251
+ imageUrl: string | null;
252
+ brand: string | null;
253
+ productId: number;
254
+ sku: string | null;
255
+ quantity: number;
256
+ variantId: number;
257
+ productName: string;
258
+ variantName: string | null;
259
+ }[];
260
+ title: string;
261
+ variantLabel: string | null;
262
+ productHandle: string | null;
263
+ thumbnail: string | null;
264
+ variantSku: string | null;
265
+ compareAtUnitPrice: number | null;
266
+ }[];
264
267
  shippingMethods: {
265
- name: string;
266
268
  id: string;
267
- sellerId: string | null;
269
+ name: string;
268
270
  description: string | null;
271
+ sellerId: string | null;
269
272
  locationId: string | null;
270
273
  shippingMethodId: string | null;
271
274
  rateId: string | null;
@@ -289,71 +292,71 @@ declare function createCart(api: Api, params: CreateCartParams): Promise<{
289
292
  }>;
290
293
  declare function getCart(api: Api, params: GetCartParams): Promise<{
291
294
  status: "inProgress" | "pending" | "completed" | "abandoned" | "cancelled" | "expired" | "failed";
292
- email: string | null;
293
295
  id: string;
294
296
  phone: string | null;
295
- items: {
296
- id: string;
297
- productId: number;
298
- quantity: number;
299
- variantId: number;
300
- unitPrice: number;
301
- bundleItems: {
302
- imageUrl: string | null;
303
- brand: string | null;
304
- productId: number;
305
- sku: string | null;
306
- quantity: number;
307
- variantId: number;
308
- productName: string;
309
- variantName: string | null;
310
- }[];
311
- title: string;
312
- variantLabel: string | null;
313
- productHandle: string | null;
314
- thumbnail: string | null;
315
- variantSku: string | null;
316
- compareAtUnitPrice: number | null;
317
- }[];
318
297
  cartNumber: string;
298
+ email: string | null;
319
299
  firstName: string | null;
320
300
  lastName: string | null;
321
301
  currencyCode: string;
322
302
  completedAt: string | null;
323
303
  shippingAddress: {
324
304
  name: string | null;
325
- company: string | null;
326
- phone: string | null;
327
305
  address1: string;
328
306
  city: string;
329
307
  countryCode: string;
308
+ company: string | null;
330
309
  address2: string | null;
331
310
  province: string | null;
332
311
  postalCode: string | null;
333
312
  district: string | null;
313
+ phone: string | null;
334
314
  latitude: number | null;
335
315
  longitude: number | null;
336
316
  } | null;
337
317
  billingAddress: {
338
318
  name: string | null;
339
- company: string | null;
340
- phone: string | null;
341
319
  address1: string;
342
320
  city: string;
343
321
  countryCode: string;
322
+ company: string | null;
344
323
  address2: string | null;
345
324
  province: string | null;
346
325
  postalCode: string | null;
347
326
  district: string | null;
327
+ phone: string | null;
348
328
  latitude: number | null;
349
329
  longitude: number | null;
350
330
  } | null;
351
331
  promotionCodes: string[];
332
+ items: {
333
+ id: string;
334
+ productId: number;
335
+ quantity: number;
336
+ variantId: number;
337
+ unitPrice: number;
338
+ bundleItems: {
339
+ imageUrl: string | null;
340
+ brand: string | null;
341
+ productId: number;
342
+ sku: string | null;
343
+ quantity: number;
344
+ variantId: number;
345
+ productName: string;
346
+ variantName: string | null;
347
+ }[];
348
+ title: string;
349
+ variantLabel: string | null;
350
+ productHandle: string | null;
351
+ thumbnail: string | null;
352
+ variantSku: string | null;
353
+ compareAtUnitPrice: number | null;
354
+ }[];
352
355
  shippingMethods: {
353
- name: string;
354
356
  id: string;
355
- sellerId: string | null;
357
+ name: string;
356
358
  description: string | null;
359
+ sellerId: string | null;
357
360
  locationId: string | null;
358
361
  shippingMethodId: string | null;
359
362
  rateId: string | null;
@@ -377,71 +380,71 @@ declare function getCart(api: Api, params: GetCartParams): Promise<{
377
380
  }>;
378
381
  declare function addCartItem(api: Api, params: AddCartItemParams): Promise<{
379
382
  status: "inProgress" | "pending" | "completed" | "abandoned" | "cancelled" | "expired" | "failed";
380
- email: string | null;
381
383
  id: string;
382
384
  phone: string | null;
383
- items: {
384
- id: string;
385
- productId: number;
386
- quantity: number;
387
- variantId: number;
388
- unitPrice: number;
389
- bundleItems: {
390
- imageUrl: string | null;
391
- brand: string | null;
392
- productId: number;
393
- sku: string | null;
394
- quantity: number;
395
- variantId: number;
396
- productName: string;
397
- variantName: string | null;
398
- }[];
399
- title: string;
400
- variantLabel: string | null;
401
- productHandle: string | null;
402
- thumbnail: string | null;
403
- variantSku: string | null;
404
- compareAtUnitPrice: number | null;
405
- }[];
406
385
  cartNumber: string;
386
+ email: string | null;
407
387
  firstName: string | null;
408
388
  lastName: string | null;
409
389
  currencyCode: string;
410
390
  completedAt: string | null;
411
391
  shippingAddress: {
412
392
  name: string | null;
413
- company: string | null;
414
- phone: string | null;
415
393
  address1: string;
416
394
  city: string;
417
395
  countryCode: string;
396
+ company: string | null;
418
397
  address2: string | null;
419
398
  province: string | null;
420
399
  postalCode: string | null;
421
400
  district: string | null;
401
+ phone: string | null;
422
402
  latitude: number | null;
423
403
  longitude: number | null;
424
404
  } | null;
425
405
  billingAddress: {
426
406
  name: string | null;
427
- company: string | null;
428
- phone: string | null;
429
407
  address1: string;
430
408
  city: string;
431
409
  countryCode: string;
410
+ company: string | null;
432
411
  address2: string | null;
433
412
  province: string | null;
434
413
  postalCode: string | null;
435
414
  district: string | null;
415
+ phone: string | null;
436
416
  latitude: number | null;
437
417
  longitude: number | null;
438
418
  } | null;
439
419
  promotionCodes: string[];
420
+ items: {
421
+ id: string;
422
+ productId: number;
423
+ quantity: number;
424
+ variantId: number;
425
+ unitPrice: number;
426
+ bundleItems: {
427
+ imageUrl: string | null;
428
+ brand: string | null;
429
+ productId: number;
430
+ sku: string | null;
431
+ quantity: number;
432
+ variantId: number;
433
+ productName: string;
434
+ variantName: string | null;
435
+ }[];
436
+ title: string;
437
+ variantLabel: string | null;
438
+ productHandle: string | null;
439
+ thumbnail: string | null;
440
+ variantSku: string | null;
441
+ compareAtUnitPrice: number | null;
442
+ }[];
440
443
  shippingMethods: {
441
- name: string;
442
444
  id: string;
443
- sellerId: string | null;
445
+ name: string;
444
446
  description: string | null;
447
+ sellerId: string | null;
445
448
  locationId: string | null;
446
449
  shippingMethodId: string | null;
447
450
  rateId: string | null;
@@ -465,73 +468,73 @@ declare function addCartItem(api: Api, params: AddCartItemParams): Promise<{
465
468
  }>;
466
469
  declare function updateCartItemQuantity(api: Api, params: UpdateCartItemQuantityParams): Promise<{
467
470
  status: "inProgress" | "pending" | "completed" | "abandoned" | "cancelled" | "expired" | "failed";
468
- email: string | null;
469
471
  id: string;
470
472
  phone: string | null;
471
- items: {
472
- id: string;
473
- productId: number;
474
- quantity: number;
475
- variantId: number;
476
- unitPrice: number;
477
- bundleItems: {
478
- imageUrl: string | null;
479
- brand: string | null;
480
- productId: number;
481
- sku: string | null;
482
- quantity: number;
483
- variantId: number;
484
- productName: string;
485
- variantName: string | null;
486
- }[];
487
- title: string;
488
- variantLabel: string | null;
489
- productHandle: string | null;
490
- thumbnail: string | null;
491
- variantSku: string | null;
492
- compareAtUnitPrice: number | null;
493
- }[];
494
473
  cartNumber: string;
474
+ email: string | null;
495
475
  firstName: string | null;
496
476
  lastName: string | null;
497
477
  currencyCode: string;
498
478
  completedAt: string | null;
499
479
  shippingAddress: {
500
480
  name: string | null;
501
- company: string | null;
502
- phone: string | null;
503
481
  address1: string;
504
482
  city: string;
505
483
  countryCode: string;
484
+ company: string | null;
506
485
  address2: string | null;
507
486
  province: string | null;
508
487
  postalCode: string | null;
509
488
  district: string | null;
489
+ phone: string | null;
510
490
  latitude: number | null;
511
491
  longitude: number | null;
512
492
  } | null;
513
493
  billingAddress: {
514
494
  name: string | null;
515
- company: string | null;
516
- phone: string | null;
517
495
  address1: string;
518
496
  city: string;
519
497
  countryCode: string;
498
+ company: string | null;
520
499
  address2: string | null;
521
500
  province: string | null;
522
501
  postalCode: string | null;
523
502
  district: string | null;
503
+ phone: string | null;
524
504
  latitude: number | null;
525
505
  longitude: number | null;
526
506
  } | null;
527
507
  promotionCodes: string[];
528
- shippingMethods: {
529
- name: string;
508
+ items: {
530
509
  id: string;
531
- sellerId: string | null;
532
- description: string | null;
533
- locationId: string | null;
534
- shippingMethodId: string | null;
510
+ productId: number;
511
+ quantity: number;
512
+ variantId: number;
513
+ unitPrice: number;
514
+ bundleItems: {
515
+ imageUrl: string | null;
516
+ brand: string | null;
517
+ productId: number;
518
+ sku: string | null;
519
+ quantity: number;
520
+ variantId: number;
521
+ productName: string;
522
+ variantName: string | null;
523
+ }[];
524
+ title: string;
525
+ variantLabel: string | null;
526
+ productHandle: string | null;
527
+ thumbnail: string | null;
528
+ variantSku: string | null;
529
+ compareAtUnitPrice: number | null;
530
+ }[];
531
+ shippingMethods: {
532
+ id: string;
533
+ name: string;
534
+ description: string | null;
535
+ sellerId: string | null;
536
+ locationId: string | null;
537
+ shippingMethodId: string | null;
535
538
  rateId: string | null;
536
539
  total: number;
537
540
  estimatedDays: number | null;
@@ -553,71 +556,71 @@ declare function updateCartItemQuantity(api: Api, params: UpdateCartItemQuantity
553
556
  }>;
554
557
  declare function removeCartItem(api: Api, params: RemoveCartItemParams): Promise<{
555
558
  status: "inProgress" | "pending" | "completed" | "abandoned" | "cancelled" | "expired" | "failed";
556
- email: string | null;
557
559
  id: string;
558
560
  phone: string | null;
559
- items: {
560
- id: string;
561
- productId: number;
562
- quantity: number;
563
- variantId: number;
564
- unitPrice: number;
565
- bundleItems: {
566
- imageUrl: string | null;
567
- brand: string | null;
568
- productId: number;
569
- sku: string | null;
570
- quantity: number;
571
- variantId: number;
572
- productName: string;
573
- variantName: string | null;
574
- }[];
575
- title: string;
576
- variantLabel: string | null;
577
- productHandle: string | null;
578
- thumbnail: string | null;
579
- variantSku: string | null;
580
- compareAtUnitPrice: number | null;
581
- }[];
582
561
  cartNumber: string;
562
+ email: string | null;
583
563
  firstName: string | null;
584
564
  lastName: string | null;
585
565
  currencyCode: string;
586
566
  completedAt: string | null;
587
567
  shippingAddress: {
588
568
  name: string | null;
589
- company: string | null;
590
- phone: string | null;
591
569
  address1: string;
592
570
  city: string;
593
571
  countryCode: string;
572
+ company: string | null;
594
573
  address2: string | null;
595
574
  province: string | null;
596
575
  postalCode: string | null;
597
576
  district: string | null;
577
+ phone: string | null;
598
578
  latitude: number | null;
599
579
  longitude: number | null;
600
580
  } | null;
601
581
  billingAddress: {
602
582
  name: string | null;
603
- company: string | null;
604
- phone: string | null;
605
583
  address1: string;
606
584
  city: string;
607
585
  countryCode: string;
586
+ company: string | null;
608
587
  address2: string | null;
609
588
  province: string | null;
610
589
  postalCode: string | null;
611
590
  district: string | null;
591
+ phone: string | null;
612
592
  latitude: number | null;
613
593
  longitude: number | null;
614
594
  } | null;
615
595
  promotionCodes: string[];
596
+ items: {
597
+ id: string;
598
+ productId: number;
599
+ quantity: number;
600
+ variantId: number;
601
+ unitPrice: number;
602
+ bundleItems: {
603
+ imageUrl: string | null;
604
+ brand: string | null;
605
+ productId: number;
606
+ sku: string | null;
607
+ quantity: number;
608
+ variantId: number;
609
+ productName: string;
610
+ variantName: string | null;
611
+ }[];
612
+ title: string;
613
+ variantLabel: string | null;
614
+ productHandle: string | null;
615
+ thumbnail: string | null;
616
+ variantSku: string | null;
617
+ compareAtUnitPrice: number | null;
618
+ }[];
616
619
  shippingMethods: {
617
- name: string;
618
620
  id: string;
619
- sellerId: string | null;
621
+ name: string;
620
622
  description: string | null;
623
+ sellerId: string | null;
621
624
  locationId: string | null;
622
625
  shippingMethodId: string | null;
623
626
  rateId: string | null;
@@ -647,71 +650,71 @@ declare function getShippingOptions(api: Api, params: GetShippingOptionsParams):
647
650
  /** PUT /v1/carts/{id}/shipping-method */
648
651
  declare function putCartShippingMethod(api: Api, params: PutShippingMethodParams): Promise<{
649
652
  status: "inProgress" | "pending" | "completed" | "abandoned" | "cancelled" | "expired" | "failed";
650
- email: string | null;
651
653
  id: string;
652
654
  phone: string | null;
653
- items: {
654
- id: string;
655
- productId: number;
656
- quantity: number;
657
- variantId: number;
658
- unitPrice: number;
659
- bundleItems: {
660
- imageUrl: string | null;
661
- brand: string | null;
662
- productId: number;
663
- sku: string | null;
664
- quantity: number;
665
- variantId: number;
666
- productName: string;
667
- variantName: string | null;
668
- }[];
669
- title: string;
670
- variantLabel: string | null;
671
- productHandle: string | null;
672
- thumbnail: string | null;
673
- variantSku: string | null;
674
- compareAtUnitPrice: number | null;
675
- }[];
676
655
  cartNumber: string;
656
+ email: string | null;
677
657
  firstName: string | null;
678
658
  lastName: string | null;
679
659
  currencyCode: string;
680
660
  completedAt: string | null;
681
661
  shippingAddress: {
682
662
  name: string | null;
683
- company: string | null;
684
- phone: string | null;
685
663
  address1: string;
686
664
  city: string;
687
665
  countryCode: string;
666
+ company: string | null;
688
667
  address2: string | null;
689
668
  province: string | null;
690
669
  postalCode: string | null;
691
670
  district: string | null;
671
+ phone: string | null;
692
672
  latitude: number | null;
693
673
  longitude: number | null;
694
674
  } | null;
695
675
  billingAddress: {
696
676
  name: string | null;
697
- company: string | null;
698
- phone: string | null;
699
677
  address1: string;
700
678
  city: string;
701
679
  countryCode: string;
680
+ company: string | null;
702
681
  address2: string | null;
703
682
  province: string | null;
704
683
  postalCode: string | null;
705
684
  district: string | null;
685
+ phone: string | null;
706
686
  latitude: number | null;
707
687
  longitude: number | null;
708
688
  } | null;
709
689
  promotionCodes: string[];
690
+ items: {
691
+ id: string;
692
+ productId: number;
693
+ quantity: number;
694
+ variantId: number;
695
+ unitPrice: number;
696
+ bundleItems: {
697
+ imageUrl: string | null;
698
+ brand: string | null;
699
+ productId: number;
700
+ sku: string | null;
701
+ quantity: number;
702
+ variantId: number;
703
+ productName: string;
704
+ variantName: string | null;
705
+ }[];
706
+ title: string;
707
+ variantLabel: string | null;
708
+ productHandle: string | null;
709
+ thumbnail: string | null;
710
+ variantSku: string | null;
711
+ compareAtUnitPrice: number | null;
712
+ }[];
710
713
  shippingMethods: {
711
- name: string;
712
714
  id: string;
713
- sellerId: string | null;
715
+ name: string;
714
716
  description: string | null;
717
+ sellerId: string | null;
715
718
  locationId: string | null;
716
719
  shippingMethodId: string | null;
717
720
  rateId: string | null;
@@ -736,71 +739,71 @@ declare function putCartShippingMethod(api: Api, params: PutShippingMethodParams
736
739
  /** PATCH /v1/carts/{id}/buyer */
737
740
  declare function patchCartBuyer(api: Api, params: CartBuyerParams): Promise<{
738
741
  status: "inProgress" | "pending" | "completed" | "abandoned" | "cancelled" | "expired" | "failed";
739
- email: string | null;
740
742
  id: string;
741
743
  phone: string | null;
742
- items: {
743
- id: string;
744
- productId: number;
745
- quantity: number;
746
- variantId: number;
747
- unitPrice: number;
748
- bundleItems: {
749
- imageUrl: string | null;
750
- brand: string | null;
751
- productId: number;
752
- sku: string | null;
753
- quantity: number;
754
- variantId: number;
755
- productName: string;
756
- variantName: string | null;
757
- }[];
758
- title: string;
759
- variantLabel: string | null;
760
- productHandle: string | null;
761
- thumbnail: string | null;
762
- variantSku: string | null;
763
- compareAtUnitPrice: number | null;
764
- }[];
765
744
  cartNumber: string;
745
+ email: string | null;
766
746
  firstName: string | null;
767
747
  lastName: string | null;
768
748
  currencyCode: string;
769
749
  completedAt: string | null;
770
750
  shippingAddress: {
771
751
  name: string | null;
772
- company: string | null;
773
- phone: string | null;
774
752
  address1: string;
775
753
  city: string;
776
754
  countryCode: string;
755
+ company: string | null;
777
756
  address2: string | null;
778
757
  province: string | null;
779
758
  postalCode: string | null;
780
759
  district: string | null;
760
+ phone: string | null;
781
761
  latitude: number | null;
782
762
  longitude: number | null;
783
763
  } | null;
784
764
  billingAddress: {
785
765
  name: string | null;
786
- company: string | null;
787
- phone: string | null;
788
766
  address1: string;
789
767
  city: string;
790
768
  countryCode: string;
769
+ company: string | null;
791
770
  address2: string | null;
792
771
  province: string | null;
793
772
  postalCode: string | null;
794
773
  district: string | null;
774
+ phone: string | null;
795
775
  latitude: number | null;
796
776
  longitude: number | null;
797
777
  } | null;
798
778
  promotionCodes: string[];
779
+ items: {
780
+ id: string;
781
+ productId: number;
782
+ quantity: number;
783
+ variantId: number;
784
+ unitPrice: number;
785
+ bundleItems: {
786
+ imageUrl: string | null;
787
+ brand: string | null;
788
+ productId: number;
789
+ sku: string | null;
790
+ quantity: number;
791
+ variantId: number;
792
+ productName: string;
793
+ variantName: string | null;
794
+ }[];
795
+ title: string;
796
+ variantLabel: string | null;
797
+ productHandle: string | null;
798
+ thumbnail: string | null;
799
+ variantSku: string | null;
800
+ compareAtUnitPrice: number | null;
801
+ }[];
799
802
  shippingMethods: {
800
- name: string;
801
803
  id: string;
802
- sellerId: string | null;
804
+ name: string;
803
805
  description: string | null;
806
+ sellerId: string | null;
804
807
  locationId: string | null;
805
808
  shippingMethodId: string | null;
806
809
  rateId: string | null;
@@ -825,71 +828,71 @@ declare function patchCartBuyer(api: Api, params: CartBuyerParams): Promise<{
825
828
  /** PATCH /v1/carts/{id}/addresses */
826
829
  declare function patchCartAddresses(api: Api, params: CartAddressesParams): Promise<{
827
830
  status: "inProgress" | "pending" | "completed" | "abandoned" | "cancelled" | "expired" | "failed";
828
- email: string | null;
829
831
  id: string;
830
832
  phone: string | null;
831
- items: {
832
- id: string;
833
- productId: number;
834
- quantity: number;
835
- variantId: number;
836
- unitPrice: number;
837
- bundleItems: {
838
- imageUrl: string | null;
839
- brand: string | null;
840
- productId: number;
841
- sku: string | null;
842
- quantity: number;
843
- variantId: number;
844
- productName: string;
845
- variantName: string | null;
846
- }[];
847
- title: string;
848
- variantLabel: string | null;
849
- productHandle: string | null;
850
- thumbnail: string | null;
851
- variantSku: string | null;
852
- compareAtUnitPrice: number | null;
853
- }[];
854
833
  cartNumber: string;
834
+ email: string | null;
855
835
  firstName: string | null;
856
836
  lastName: string | null;
857
837
  currencyCode: string;
858
838
  completedAt: string | null;
859
839
  shippingAddress: {
860
840
  name: string | null;
861
- company: string | null;
862
- phone: string | null;
863
841
  address1: string;
864
842
  city: string;
865
843
  countryCode: string;
844
+ company: string | null;
866
845
  address2: string | null;
867
846
  province: string | null;
868
847
  postalCode: string | null;
869
848
  district: string | null;
849
+ phone: string | null;
870
850
  latitude: number | null;
871
851
  longitude: number | null;
872
852
  } | null;
873
853
  billingAddress: {
874
854
  name: string | null;
875
- company: string | null;
876
- phone: string | null;
877
855
  address1: string;
878
856
  city: string;
879
857
  countryCode: string;
858
+ company: string | null;
880
859
  address2: string | null;
881
860
  province: string | null;
882
861
  postalCode: string | null;
883
862
  district: string | null;
863
+ phone: string | null;
884
864
  latitude: number | null;
885
865
  longitude: number | null;
886
866
  } | null;
887
867
  promotionCodes: string[];
868
+ items: {
869
+ id: string;
870
+ productId: number;
871
+ quantity: number;
872
+ variantId: number;
873
+ unitPrice: number;
874
+ bundleItems: {
875
+ imageUrl: string | null;
876
+ brand: string | null;
877
+ productId: number;
878
+ sku: string | null;
879
+ quantity: number;
880
+ variantId: number;
881
+ productName: string;
882
+ variantName: string | null;
883
+ }[];
884
+ title: string;
885
+ variantLabel: string | null;
886
+ productHandle: string | null;
887
+ thumbnail: string | null;
888
+ variantSku: string | null;
889
+ compareAtUnitPrice: number | null;
890
+ }[];
888
891
  shippingMethods: {
889
- name: string;
890
892
  id: string;
891
- sellerId: string | null;
893
+ name: string;
892
894
  description: string | null;
895
+ sellerId: string | null;
893
896
  locationId: string | null;
894
897
  shippingMethodId: string | null;
895
898
  rateId: string | null;
@@ -918,71 +921,71 @@ declare function uploadPaymentReceipt(api: Api, params: UploadPaymentReceiptPara
918
921
  /** POST /v1/carts/{id}/promotion-codes */
919
922
  declare function addCartPromotionCode(api: Api, params: CartPromotionCodeParams): Promise<{
920
923
  status: "inProgress" | "pending" | "completed" | "abandoned" | "cancelled" | "expired" | "failed";
921
- email: string | null;
922
924
  id: string;
923
925
  phone: string | null;
924
- items: {
925
- id: string;
926
- productId: number;
927
- quantity: number;
928
- variantId: number;
929
- unitPrice: number;
930
- bundleItems: {
931
- imageUrl: string | null;
932
- brand: string | null;
933
- productId: number;
934
- sku: string | null;
935
- quantity: number;
936
- variantId: number;
937
- productName: string;
938
- variantName: string | null;
939
- }[];
940
- title: string;
941
- variantLabel: string | null;
942
- productHandle: string | null;
943
- thumbnail: string | null;
944
- variantSku: string | null;
945
- compareAtUnitPrice: number | null;
946
- }[];
947
926
  cartNumber: string;
927
+ email: string | null;
948
928
  firstName: string | null;
949
929
  lastName: string | null;
950
930
  currencyCode: string;
951
931
  completedAt: string | null;
952
932
  shippingAddress: {
953
933
  name: string | null;
954
- company: string | null;
955
- phone: string | null;
956
934
  address1: string;
957
935
  city: string;
958
936
  countryCode: string;
937
+ company: string | null;
959
938
  address2: string | null;
960
939
  province: string | null;
961
940
  postalCode: string | null;
962
941
  district: string | null;
942
+ phone: string | null;
963
943
  latitude: number | null;
964
944
  longitude: number | null;
965
945
  } | null;
966
946
  billingAddress: {
967
947
  name: string | null;
968
- company: string | null;
969
- phone: string | null;
970
948
  address1: string;
971
949
  city: string;
972
950
  countryCode: string;
951
+ company: string | null;
973
952
  address2: string | null;
974
953
  province: string | null;
975
954
  postalCode: string | null;
976
955
  district: string | null;
956
+ phone: string | null;
977
957
  latitude: number | null;
978
958
  longitude: number | null;
979
959
  } | null;
980
960
  promotionCodes: string[];
961
+ items: {
962
+ id: string;
963
+ productId: number;
964
+ quantity: number;
965
+ variantId: number;
966
+ unitPrice: number;
967
+ bundleItems: {
968
+ imageUrl: string | null;
969
+ brand: string | null;
970
+ productId: number;
971
+ sku: string | null;
972
+ quantity: number;
973
+ variantId: number;
974
+ productName: string;
975
+ variantName: string | null;
976
+ }[];
977
+ title: string;
978
+ variantLabel: string | null;
979
+ productHandle: string | null;
980
+ thumbnail: string | null;
981
+ variantSku: string | null;
982
+ compareAtUnitPrice: number | null;
983
+ }[];
981
984
  shippingMethods: {
982
- name: string;
983
985
  id: string;
984
- sellerId: string | null;
986
+ name: string;
985
987
  description: string | null;
988
+ sellerId: string | null;
986
989
  locationId: string | null;
987
990
  shippingMethodId: string | null;
988
991
  rateId: string | null;
@@ -1007,71 +1010,71 @@ declare function addCartPromotionCode(api: Api, params: CartPromotionCodeParams)
1007
1010
  /** DELETE /v1/carts/{id}/promotion-codes/{code} */
1008
1011
  declare function removeCartPromotionCode(api: Api, params: CartPromotionCodeParams): Promise<{
1009
1012
  status: "inProgress" | "pending" | "completed" | "abandoned" | "cancelled" | "expired" | "failed";
1010
- email: string | null;
1011
1013
  id: string;
1012
1014
  phone: string | null;
1013
- items: {
1014
- id: string;
1015
- productId: number;
1016
- quantity: number;
1017
- variantId: number;
1018
- unitPrice: number;
1019
- bundleItems: {
1020
- imageUrl: string | null;
1021
- brand: string | null;
1022
- productId: number;
1023
- sku: string | null;
1024
- quantity: number;
1025
- variantId: number;
1026
- productName: string;
1027
- variantName: string | null;
1028
- }[];
1029
- title: string;
1030
- variantLabel: string | null;
1031
- productHandle: string | null;
1032
- thumbnail: string | null;
1033
- variantSku: string | null;
1034
- compareAtUnitPrice: number | null;
1035
- }[];
1036
1015
  cartNumber: string;
1016
+ email: string | null;
1037
1017
  firstName: string | null;
1038
1018
  lastName: string | null;
1039
1019
  currencyCode: string;
1040
1020
  completedAt: string | null;
1041
1021
  shippingAddress: {
1042
1022
  name: string | null;
1043
- company: string | null;
1044
- phone: string | null;
1045
1023
  address1: string;
1046
1024
  city: string;
1047
1025
  countryCode: string;
1026
+ company: string | null;
1048
1027
  address2: string | null;
1049
1028
  province: string | null;
1050
1029
  postalCode: string | null;
1051
1030
  district: string | null;
1031
+ phone: string | null;
1052
1032
  latitude: number | null;
1053
1033
  longitude: number | null;
1054
1034
  } | null;
1055
1035
  billingAddress: {
1056
1036
  name: string | null;
1057
- company: string | null;
1058
- phone: string | null;
1059
1037
  address1: string;
1060
1038
  city: string;
1061
1039
  countryCode: string;
1040
+ company: string | null;
1062
1041
  address2: string | null;
1063
1042
  province: string | null;
1064
1043
  postalCode: string | null;
1065
1044
  district: string | null;
1045
+ phone: string | null;
1066
1046
  latitude: number | null;
1067
1047
  longitude: number | null;
1068
1048
  } | null;
1069
1049
  promotionCodes: string[];
1050
+ items: {
1051
+ id: string;
1052
+ productId: number;
1053
+ quantity: number;
1054
+ variantId: number;
1055
+ unitPrice: number;
1056
+ bundleItems: {
1057
+ imageUrl: string | null;
1058
+ brand: string | null;
1059
+ productId: number;
1060
+ sku: string | null;
1061
+ quantity: number;
1062
+ variantId: number;
1063
+ productName: string;
1064
+ variantName: string | null;
1065
+ }[];
1066
+ title: string;
1067
+ variantLabel: string | null;
1068
+ productHandle: string | null;
1069
+ thumbnail: string | null;
1070
+ variantSku: string | null;
1071
+ compareAtUnitPrice: number | null;
1072
+ }[];
1070
1073
  shippingMethods: {
1071
- name: string;
1072
1074
  id: string;
1073
- sellerId: string | null;
1075
+ name: string;
1074
1076
  description: string | null;
1077
+ sellerId: string | null;
1075
1078
  locationId: string | null;
1076
1079
  shippingMethodId: string | null;
1077
1080
  rateId: string | null;