@gethydra/sdk 0.1.0 → 0.1.2
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/dist/index.d.ts +1085 -354
- package/dist/index.js +36 -0
- package/package.json +2 -3
package/dist/index.d.ts
CHANGED
|
@@ -407,7 +407,7 @@ interface components {
|
|
|
407
407
|
id: string;
|
|
408
408
|
/** @example CI Pipeline */
|
|
409
409
|
name: string | null;
|
|
410
|
-
/** @example
|
|
410
|
+
/** @example sk_live_example */
|
|
411
411
|
key: string;
|
|
412
412
|
/** @example sk_live_ */
|
|
413
413
|
key_prefix: string;
|
|
@@ -2605,6 +2605,33 @@ interface components {
|
|
|
2605
2605
|
*/
|
|
2606
2606
|
created_at: string;
|
|
2607
2607
|
};
|
|
2608
|
+
FilterAttribute: {
|
|
2609
|
+
/** @example fa_abc123 */
|
|
2610
|
+
id: string;
|
|
2611
|
+
/** @example metal */
|
|
2612
|
+
key: string;
|
|
2613
|
+
/** @example Metal */
|
|
2614
|
+
label: string;
|
|
2615
|
+
/**
|
|
2616
|
+
* @example spec
|
|
2617
|
+
* @enum {string}
|
|
2618
|
+
*/
|
|
2619
|
+
source_type: "spec" | "option" | "field" | "tag" | "price" | "availability";
|
|
2620
|
+
/** @example Metal */
|
|
2621
|
+
source_key: string | null;
|
|
2622
|
+
/** @example 0 */
|
|
2623
|
+
position: number;
|
|
2624
|
+
/**
|
|
2625
|
+
* Format: date-time
|
|
2626
|
+
* @example 2026-01-15T09:30:00.000Z
|
|
2627
|
+
*/
|
|
2628
|
+
created_at: string;
|
|
2629
|
+
/**
|
|
2630
|
+
* Format: date-time
|
|
2631
|
+
* @example 2026-01-15T09:30:00.000Z
|
|
2632
|
+
*/
|
|
2633
|
+
updated_at: string;
|
|
2634
|
+
};
|
|
2608
2635
|
Redirect: {
|
|
2609
2636
|
/** @example rdr_abc123 */
|
|
2610
2637
|
id: string;
|
|
@@ -2765,6 +2792,92 @@ interface components {
|
|
|
2765
2792
|
*/
|
|
2766
2793
|
updated_at: string;
|
|
2767
2794
|
};
|
|
2795
|
+
MembershipPlan: {
|
|
2796
|
+
/** @example mplan_abc123 */
|
|
2797
|
+
id: string;
|
|
2798
|
+
/** @example VIP Membership */
|
|
2799
|
+
name: string;
|
|
2800
|
+
/** @example Unlock wholesale pricing */
|
|
2801
|
+
description: string | null;
|
|
2802
|
+
/** @example vip-membership */
|
|
2803
|
+
slug: string;
|
|
2804
|
+
/** @example price_1abc */
|
|
2805
|
+
stripe_price_id: string | null;
|
|
2806
|
+
/** @example 1199 */
|
|
2807
|
+
amount: number;
|
|
2808
|
+
/** @example gbp */
|
|
2809
|
+
currency: string;
|
|
2810
|
+
/** @example month */
|
|
2811
|
+
interval: string;
|
|
2812
|
+
/** @example 1 */
|
|
2813
|
+
interval_count: number;
|
|
2814
|
+
/** @example 14 */
|
|
2815
|
+
trial_days: number | null;
|
|
2816
|
+
/** @example cg_abc123 */
|
|
2817
|
+
customer_group_id: string | null;
|
|
2818
|
+
/** @example active */
|
|
2819
|
+
status: string;
|
|
2820
|
+
/** @example 42 */
|
|
2821
|
+
subscriber_count: number;
|
|
2822
|
+
/** @example {} */
|
|
2823
|
+
metadata: {
|
|
2824
|
+
[key: string]: string | number;
|
|
2825
|
+
};
|
|
2826
|
+
/**
|
|
2827
|
+
* Format: date-time
|
|
2828
|
+
* @example 2026-01-15T09:30:00.000Z
|
|
2829
|
+
*/
|
|
2830
|
+
created_at: string;
|
|
2831
|
+
/**
|
|
2832
|
+
* Format: date-time
|
|
2833
|
+
* @example 2026-02-20T14:15:00.000Z
|
|
2834
|
+
*/
|
|
2835
|
+
updated_at: string;
|
|
2836
|
+
};
|
|
2837
|
+
CustomerMembership: {
|
|
2838
|
+
/** @example cmem_abc123 */
|
|
2839
|
+
id: string;
|
|
2840
|
+
/** @example mplan_abc123 */
|
|
2841
|
+
plan_id: string;
|
|
2842
|
+
plan?: components["schemas"]["MembershipPlan"] & unknown;
|
|
2843
|
+
/** @example cus_abc123 */
|
|
2844
|
+
customer_id: string;
|
|
2845
|
+
/** @example sub_1abc */
|
|
2846
|
+
stripe_subscription_id: string | null;
|
|
2847
|
+
/** @example active */
|
|
2848
|
+
status: string;
|
|
2849
|
+
/**
|
|
2850
|
+
* Format: date-time
|
|
2851
|
+
* @example 2026-09-01T00:00:00.000Z
|
|
2852
|
+
*/
|
|
2853
|
+
current_period_start: string | null;
|
|
2854
|
+
/**
|
|
2855
|
+
* Format: date-time
|
|
2856
|
+
* @example 2026-10-01T00:00:00.000Z
|
|
2857
|
+
*/
|
|
2858
|
+
current_period_end: string | null;
|
|
2859
|
+
/** @example false */
|
|
2860
|
+
cancel_at_period_end: boolean;
|
|
2861
|
+
/**
|
|
2862
|
+
* Format: date-time
|
|
2863
|
+
* @example null
|
|
2864
|
+
*/
|
|
2865
|
+
cancelled_at: string | null;
|
|
2866
|
+
/** @example {} */
|
|
2867
|
+
metadata: {
|
|
2868
|
+
[key: string]: string | number;
|
|
2869
|
+
};
|
|
2870
|
+
/**
|
|
2871
|
+
* Format: date-time
|
|
2872
|
+
* @example 2026-01-15T09:30:00.000Z
|
|
2873
|
+
*/
|
|
2874
|
+
created_at: string;
|
|
2875
|
+
/**
|
|
2876
|
+
* Format: date-time
|
|
2877
|
+
* @example 2026-02-20T14:15:00.000Z
|
|
2878
|
+
*/
|
|
2879
|
+
updated_at: string;
|
|
2880
|
+
};
|
|
2768
2881
|
Refund: {
|
|
2769
2882
|
/** @example rfd_abc123 */
|
|
2770
2883
|
id: string;
|
|
@@ -3240,6 +3353,8 @@ interface components {
|
|
|
3240
3353
|
parent_item_id: string | null;
|
|
3241
3354
|
label: string;
|
|
3242
3355
|
url: string | null;
|
|
3356
|
+
/** @enum {string|null} */
|
|
3357
|
+
resource_type: "collection" | "product" | "page" | "custom" | null;
|
|
3243
3358
|
/** @enum {string} */
|
|
3244
3359
|
item_type: "link" | "heading" | "featured";
|
|
3245
3360
|
position: number;
|
|
@@ -3260,6 +3375,8 @@ interface components {
|
|
|
3260
3375
|
parent_item_id: string | null;
|
|
3261
3376
|
label: string;
|
|
3262
3377
|
url: string | null;
|
|
3378
|
+
/** @enum {string|null} */
|
|
3379
|
+
resource_type: "collection" | "product" | "page" | "custom" | null;
|
|
3263
3380
|
/** @enum {string} */
|
|
3264
3381
|
item_type: "link" | "heading" | "featured";
|
|
3265
3382
|
position: number;
|
|
@@ -3382,6 +3499,20 @@ interface components {
|
|
|
3382
3499
|
/** @example If an account exists, a reset link has been sent. */
|
|
3383
3500
|
message: string;
|
|
3384
3501
|
};
|
|
3502
|
+
SubscribeCheckout: {
|
|
3503
|
+
/**
|
|
3504
|
+
* Format: uri
|
|
3505
|
+
* @example https://checkout.stripe.com/c/pay/cs_test_abc
|
|
3506
|
+
*/
|
|
3507
|
+
checkout_url: string;
|
|
3508
|
+
};
|
|
3509
|
+
MembershipPortal: {
|
|
3510
|
+
/**
|
|
3511
|
+
* Format: uri
|
|
3512
|
+
* @example https://billing.stripe.com/p/session/abc
|
|
3513
|
+
*/
|
|
3514
|
+
portal_url: string;
|
|
3515
|
+
};
|
|
3385
3516
|
AnalyticsSummary: {
|
|
3386
3517
|
period: {
|
|
3387
3518
|
/** @example 2026-08-01 */
|
|
@@ -3692,13 +3823,13 @@ interface components {
|
|
|
3692
3823
|
slug: string;
|
|
3693
3824
|
};
|
|
3694
3825
|
api_keys: {
|
|
3695
|
-
/** @example
|
|
3826
|
+
/** @example sk_test_example */
|
|
3696
3827
|
sk_test: string;
|
|
3697
|
-
/** @example
|
|
3828
|
+
/** @example sk_live_example */
|
|
3698
3829
|
sk_live: string;
|
|
3699
|
-
/** @example
|
|
3830
|
+
/** @example pk_test_example */
|
|
3700
3831
|
pk_test: string;
|
|
3701
|
-
/** @example
|
|
3832
|
+
/** @example pk_live_example */
|
|
3702
3833
|
pk_live: string;
|
|
3703
3834
|
};
|
|
3704
3835
|
};
|
|
@@ -4742,6 +4873,40 @@ interface operations {
|
|
|
4742
4873
|
};
|
|
4743
4874
|
};
|
|
4744
4875
|
};
|
|
4876
|
+
updateApiKeyName: {
|
|
4877
|
+
parameters: {
|
|
4878
|
+
query?: never;
|
|
4879
|
+
header?: never;
|
|
4880
|
+
path: {
|
|
4881
|
+
id: string;
|
|
4882
|
+
};
|
|
4883
|
+
cookie?: never;
|
|
4884
|
+
};
|
|
4885
|
+
requestBody?: {
|
|
4886
|
+
content: {
|
|
4887
|
+
"application/json": {
|
|
4888
|
+
/**
|
|
4889
|
+
* @description Display name for the key. Null to clear.
|
|
4890
|
+
* @example Storefront
|
|
4891
|
+
*/
|
|
4892
|
+
name: string | null;
|
|
4893
|
+
};
|
|
4894
|
+
};
|
|
4895
|
+
};
|
|
4896
|
+
responses: {
|
|
4897
|
+
/** @description Updated key metadata */
|
|
4898
|
+
200: {
|
|
4899
|
+
headers: {
|
|
4900
|
+
[name: string]: unknown;
|
|
4901
|
+
};
|
|
4902
|
+
content: {
|
|
4903
|
+
"application/json": {
|
|
4904
|
+
data: components["schemas"]["ApiKey"];
|
|
4905
|
+
};
|
|
4906
|
+
};
|
|
4907
|
+
};
|
|
4908
|
+
};
|
|
4909
|
+
};
|
|
4745
4910
|
updateApiKeyPermissions: {
|
|
4746
4911
|
parameters: {
|
|
4747
4912
|
query?: never;
|
|
@@ -6390,7 +6555,7 @@ interface operations {
|
|
|
6390
6555
|
low_stock_threshold?: number | null;
|
|
6391
6556
|
/** @example 1 */
|
|
6392
6557
|
qty_step?: number | null;
|
|
6393
|
-
/** @example
|
|
6558
|
+
/** @example 0.5 */
|
|
6394
6559
|
weight?: number;
|
|
6395
6560
|
/**
|
|
6396
6561
|
* @default g
|
|
@@ -6516,7 +6681,7 @@ interface operations {
|
|
|
6516
6681
|
content: {
|
|
6517
6682
|
"multipart/form-data": {
|
|
6518
6683
|
/** Format: binary */
|
|
6519
|
-
file
|
|
6684
|
+
file?: string;
|
|
6520
6685
|
lqip?: string;
|
|
6521
6686
|
};
|
|
6522
6687
|
};
|
|
@@ -6757,7 +6922,7 @@ interface operations {
|
|
|
6757
6922
|
low_stock_threshold?: number | null;
|
|
6758
6923
|
/** @example 1 */
|
|
6759
6924
|
qty_step?: number | null;
|
|
6760
|
-
/** @example
|
|
6925
|
+
/** @example 0.5 */
|
|
6761
6926
|
weight?: number | null;
|
|
6762
6927
|
/**
|
|
6763
6928
|
* @example g
|
|
@@ -7127,7 +7292,7 @@ interface operations {
|
|
|
7127
7292
|
content: {
|
|
7128
7293
|
"multipart/form-data": {
|
|
7129
7294
|
/** Format: binary */
|
|
7130
|
-
file
|
|
7295
|
+
file?: string;
|
|
7131
7296
|
lqip?: string;
|
|
7132
7297
|
};
|
|
7133
7298
|
};
|
|
@@ -7279,7 +7444,7 @@ interface operations {
|
|
|
7279
7444
|
/** @example summer-essentials */
|
|
7280
7445
|
handle?: string;
|
|
7281
7446
|
/** @example Lightweight picks for warm weather. */
|
|
7282
|
-
description?: string;
|
|
7447
|
+
description?: string | null;
|
|
7283
7448
|
/**
|
|
7284
7449
|
* @default manual
|
|
7285
7450
|
* @example manual
|
|
@@ -7463,7 +7628,7 @@ interface operations {
|
|
|
7463
7628
|
/** @example summer-essentials */
|
|
7464
7629
|
handle?: string;
|
|
7465
7630
|
/** @example Lightweight picks for warm weather. */
|
|
7466
|
-
description?: string;
|
|
7631
|
+
description?: string | null;
|
|
7467
7632
|
/**
|
|
7468
7633
|
* @example manual
|
|
7469
7634
|
* @enum {string}
|
|
@@ -11685,7 +11850,7 @@ interface operations {
|
|
|
11685
11850
|
/** @example USD */
|
|
11686
11851
|
currency: string;
|
|
11687
11852
|
items?: {
|
|
11688
|
-
/** @example
|
|
11853
|
+
/** @example 0.5 */
|
|
11689
11854
|
weight_grams: number;
|
|
11690
11855
|
/** @example 2 */
|
|
11691
11856
|
quantity: number;
|
|
@@ -11761,7 +11926,7 @@ interface operations {
|
|
|
11761
11926
|
* "order.paid"
|
|
11762
11927
|
* ]
|
|
11763
11928
|
*/
|
|
11764
|
-
events: ("product.created" | "product.updated" | "product.deleted" | "order.created" | "order.paid" | "order.fulfilled" | "order.cancelled" | "order.refunded" | "company.created" | "company.updated" | "company.deleted" | "customer.created" | "customer.updated" | "discount.created" | "discount.updated" | "discount.deleted" | "draft_order.created" | "draft_order.updated" | "draft_order.completed" | "draft_order.deleted" | "fulfillment.created" | "fulfillment.updated" | "fulfillment.cancelled" | "fulfillment_order.created" | "inventory.low" | "location.created" | "location.updated" | "location.deleted" | "navigation.created" | "navigation.updated" | "navigation.deleted" | "shipping.zone.created" | "shipping.zone.updated" | "shipping.zone.deleted" | "post.created" | "post.updated" | "post.deleted" | "post.published" | "post.unpublished" | "promotion.created" | "promotion.updated" | "promotion.deleted" | "purchase_order.created" | "purchase_order.updated" | "purchase_order.received" | "purchase_order.cancelled" | "refund.created" | "refund.succeeded" | "refund.failed" | "return.requested" | "return.approved" | "return.received" | "return.rejected" | "return.cancelled" | "return.closed" | "store.published" | "store_credit.issued" | "store_credit.used" | "store_credit.expired" | "usage.warning")[];
|
|
11929
|
+
events: ("product.created" | "product.updated" | "product.deleted" | "order.created" | "order.paid" | "order.fulfilled" | "order.cancelled" | "order.refunded" | "company.created" | "company.updated" | "company.deleted" | "customer.created" | "customer.updated" | "discount.created" | "discount.updated" | "discount.deleted" | "draft_order.created" | "draft_order.updated" | "draft_order.completed" | "draft_order.deleted" | "filter_attribute.created" | "filter_attribute.updated" | "filter_attribute.deleted" | "fulfillment.created" | "fulfillment.updated" | "fulfillment.cancelled" | "fulfillment_order.created" | "inventory.low" | "location.created" | "location.updated" | "location.deleted" | "navigation.created" | "navigation.updated" | "navigation.deleted" | "shipping.zone.created" | "shipping.zone.updated" | "shipping.zone.deleted" | "post.created" | "post.updated" | "post.deleted" | "post.published" | "post.unpublished" | "promotion.created" | "promotion.updated" | "promotion.deleted" | "purchase_order.created" | "purchase_order.updated" | "purchase_order.received" | "purchase_order.cancelled" | "refund.created" | "refund.succeeded" | "refund.failed" | "return.requested" | "return.approved" | "return.received" | "return.rejected" | "return.cancelled" | "return.closed" | "store.published" | "store_credit.issued" | "store_credit.used" | "store_credit.expired" | "membership.created" | "membership.updated" | "membership.cancelled" | "membership.expired" | "usage.warning")[];
|
|
11765
11930
|
/**
|
|
11766
11931
|
* @default active
|
|
11767
11932
|
* @example active
|
|
@@ -11855,7 +12020,7 @@ interface operations {
|
|
|
11855
12020
|
* "product.updated"
|
|
11856
12021
|
* ]
|
|
11857
12022
|
*/
|
|
11858
|
-
events?: ("product.created" | "product.updated" | "product.deleted" | "order.created" | "order.paid" | "order.fulfilled" | "order.cancelled" | "order.refunded" | "company.created" | "company.updated" | "company.deleted" | "customer.created" | "customer.updated" | "discount.created" | "discount.updated" | "discount.deleted" | "draft_order.created" | "draft_order.updated" | "draft_order.completed" | "draft_order.deleted" | "fulfillment.created" | "fulfillment.updated" | "fulfillment.cancelled" | "fulfillment_order.created" | "inventory.low" | "location.created" | "location.updated" | "location.deleted" | "navigation.created" | "navigation.updated" | "navigation.deleted" | "shipping.zone.created" | "shipping.zone.updated" | "shipping.zone.deleted" | "post.created" | "post.updated" | "post.deleted" | "post.published" | "post.unpublished" | "promotion.created" | "promotion.updated" | "promotion.deleted" | "purchase_order.created" | "purchase_order.updated" | "purchase_order.received" | "purchase_order.cancelled" | "refund.created" | "refund.succeeded" | "refund.failed" | "return.requested" | "return.approved" | "return.received" | "return.rejected" | "return.cancelled" | "return.closed" | "store.published" | "store_credit.issued" | "store_credit.used" | "store_credit.expired" | "usage.warning")[];
|
|
12023
|
+
events?: ("product.created" | "product.updated" | "product.deleted" | "order.created" | "order.paid" | "order.fulfilled" | "order.cancelled" | "order.refunded" | "company.created" | "company.updated" | "company.deleted" | "customer.created" | "customer.updated" | "discount.created" | "discount.updated" | "discount.deleted" | "draft_order.created" | "draft_order.updated" | "draft_order.completed" | "draft_order.deleted" | "filter_attribute.created" | "filter_attribute.updated" | "filter_attribute.deleted" | "fulfillment.created" | "fulfillment.updated" | "fulfillment.cancelled" | "fulfillment_order.created" | "inventory.low" | "location.created" | "location.updated" | "location.deleted" | "navigation.created" | "navigation.updated" | "navigation.deleted" | "shipping.zone.created" | "shipping.zone.updated" | "shipping.zone.deleted" | "post.created" | "post.updated" | "post.deleted" | "post.published" | "post.unpublished" | "promotion.created" | "promotion.updated" | "promotion.deleted" | "purchase_order.created" | "purchase_order.updated" | "purchase_order.received" | "purchase_order.cancelled" | "refund.created" | "refund.succeeded" | "refund.failed" | "return.requested" | "return.approved" | "return.received" | "return.rejected" | "return.cancelled" | "return.closed" | "store.published" | "store_credit.issued" | "store_credit.used" | "store_credit.expired" | "membership.created" | "membership.updated" | "membership.cancelled" | "membership.expired" | "usage.warning")[];
|
|
11859
12024
|
/**
|
|
11860
12025
|
* @example active
|
|
11861
12026
|
* @enum {string}
|
|
@@ -12110,13 +12275,13 @@ interface operations {
|
|
|
12110
12275
|
};
|
|
12111
12276
|
};
|
|
12112
12277
|
};
|
|
12113
|
-
|
|
12278
|
+
listFilterAttributes: {
|
|
12114
12279
|
parameters: {
|
|
12115
12280
|
query?: {
|
|
12116
12281
|
limit?: number;
|
|
12117
12282
|
cursor?: string;
|
|
12118
12283
|
fields?: string;
|
|
12119
|
-
sort?: "
|
|
12284
|
+
sort?: "position" | "created_at";
|
|
12120
12285
|
order?: "asc" | "desc";
|
|
12121
12286
|
};
|
|
12122
12287
|
header?: never;
|
|
@@ -12125,14 +12290,14 @@ interface operations {
|
|
|
12125
12290
|
};
|
|
12126
12291
|
requestBody?: never;
|
|
12127
12292
|
responses: {
|
|
12128
|
-
/** @description Paginated
|
|
12293
|
+
/** @description Paginated filter attribute list */
|
|
12129
12294
|
200: {
|
|
12130
12295
|
headers: {
|
|
12131
12296
|
[name: string]: unknown;
|
|
12132
12297
|
};
|
|
12133
12298
|
content: {
|
|
12134
12299
|
"application/json": {
|
|
12135
|
-
data: components["schemas"]["
|
|
12300
|
+
data: components["schemas"]["FilterAttribute"][];
|
|
12136
12301
|
pagination: {
|
|
12137
12302
|
cursor: string | null;
|
|
12138
12303
|
has_more: boolean;
|
|
@@ -12143,7 +12308,7 @@ interface operations {
|
|
|
12143
12308
|
};
|
|
12144
12309
|
};
|
|
12145
12310
|
};
|
|
12146
|
-
|
|
12311
|
+
createFilterAttribute: {
|
|
12147
12312
|
parameters: {
|
|
12148
12313
|
query?: never;
|
|
12149
12314
|
header?: never;
|
|
@@ -12153,64 +12318,47 @@ interface operations {
|
|
|
12153
12318
|
requestBody?: {
|
|
12154
12319
|
content: {
|
|
12155
12320
|
"application/json": {
|
|
12156
|
-
/** @example
|
|
12157
|
-
|
|
12158
|
-
/** @example
|
|
12159
|
-
|
|
12321
|
+
/** @example metal */
|
|
12322
|
+
key: string;
|
|
12323
|
+
/** @example Metal */
|
|
12324
|
+
label: string;
|
|
12325
|
+
/**
|
|
12326
|
+
* @example spec
|
|
12327
|
+
* @enum {string}
|
|
12328
|
+
*/
|
|
12329
|
+
source_type: "spec" | "option" | "field" | "tag" | "price" | "availability";
|
|
12330
|
+
/** @example Metal */
|
|
12331
|
+
source_key?: string | null;
|
|
12332
|
+
/** @example 0 */
|
|
12333
|
+
position?: number;
|
|
12160
12334
|
};
|
|
12161
12335
|
};
|
|
12162
12336
|
};
|
|
12163
12337
|
responses: {
|
|
12164
|
-
/** @description
|
|
12338
|
+
/** @description Filter attribute created */
|
|
12165
12339
|
201: {
|
|
12166
12340
|
headers: {
|
|
12167
12341
|
[name: string]: unknown;
|
|
12168
12342
|
};
|
|
12169
12343
|
content: {
|
|
12170
12344
|
"application/json": {
|
|
12171
|
-
data: components["schemas"]["
|
|
12345
|
+
data: components["schemas"]["FilterAttribute"];
|
|
12172
12346
|
};
|
|
12173
12347
|
};
|
|
12174
12348
|
};
|
|
12175
12349
|
};
|
|
12176
12350
|
};
|
|
12177
|
-
|
|
12351
|
+
discoverFilterSources: {
|
|
12178
12352
|
parameters: {
|
|
12179
|
-
query
|
|
12180
|
-
path: string;
|
|
12181
|
-
};
|
|
12353
|
+
query?: never;
|
|
12182
12354
|
header?: never;
|
|
12183
12355
|
path?: never;
|
|
12184
12356
|
cookie?: never;
|
|
12185
12357
|
};
|
|
12186
12358
|
requestBody?: never;
|
|
12187
12359
|
responses: {
|
|
12188
|
-
/** @description
|
|
12360
|
+
/** @description Available filter sources */
|
|
12189
12361
|
200: {
|
|
12190
|
-
headers: {
|
|
12191
|
-
[name: string]: unknown;
|
|
12192
|
-
};
|
|
12193
|
-
content: {
|
|
12194
|
-
"application/json": {
|
|
12195
|
-
data: components["schemas"]["Redirect"];
|
|
12196
|
-
};
|
|
12197
|
-
};
|
|
12198
|
-
};
|
|
12199
|
-
};
|
|
12200
|
-
};
|
|
12201
|
-
deleteRedirect: {
|
|
12202
|
-
parameters: {
|
|
12203
|
-
query?: never;
|
|
12204
|
-
header?: never;
|
|
12205
|
-
path: {
|
|
12206
|
-
id: string;
|
|
12207
|
-
};
|
|
12208
|
-
cookie?: never;
|
|
12209
|
-
};
|
|
12210
|
-
requestBody?: never;
|
|
12211
|
-
responses: {
|
|
12212
|
-
/** @description Redirect deleted */
|
|
12213
|
-
204: {
|
|
12214
12362
|
headers: {
|
|
12215
12363
|
[name: string]: unknown;
|
|
12216
12364
|
};
|
|
@@ -12218,70 +12366,33 @@ interface operations {
|
|
|
12218
12366
|
};
|
|
12219
12367
|
};
|
|
12220
12368
|
};
|
|
12221
|
-
|
|
12369
|
+
getFilterAttribute: {
|
|
12222
12370
|
parameters: {
|
|
12223
12371
|
query?: {
|
|
12224
|
-
limit?: number;
|
|
12225
|
-
cursor?: string;
|
|
12226
12372
|
fields?: string;
|
|
12227
|
-
sort?: "created_at" | "updated_at" | "name";
|
|
12228
|
-
order?: "asc" | "desc";
|
|
12229
|
-
search?: string;
|
|
12230
12373
|
};
|
|
12231
12374
|
header?: never;
|
|
12232
|
-
path
|
|
12375
|
+
path: {
|
|
12376
|
+
id: string;
|
|
12377
|
+
};
|
|
12233
12378
|
cookie?: never;
|
|
12234
12379
|
};
|
|
12235
12380
|
requestBody?: never;
|
|
12236
12381
|
responses: {
|
|
12237
|
-
/** @description
|
|
12382
|
+
/** @description Filter attribute details */
|
|
12238
12383
|
200: {
|
|
12239
12384
|
headers: {
|
|
12240
12385
|
[name: string]: unknown;
|
|
12241
12386
|
};
|
|
12242
12387
|
content: {
|
|
12243
12388
|
"application/json": {
|
|
12244
|
-
data: components["schemas"]["
|
|
12245
|
-
pagination: {
|
|
12246
|
-
cursor: string | null;
|
|
12247
|
-
has_more: boolean;
|
|
12248
|
-
total: number;
|
|
12249
|
-
};
|
|
12250
|
-
};
|
|
12251
|
-
};
|
|
12252
|
-
};
|
|
12253
|
-
};
|
|
12254
|
-
};
|
|
12255
|
-
createTag: {
|
|
12256
|
-
parameters: {
|
|
12257
|
-
query?: never;
|
|
12258
|
-
header?: never;
|
|
12259
|
-
path?: never;
|
|
12260
|
-
cookie?: never;
|
|
12261
|
-
};
|
|
12262
|
-
requestBody?: {
|
|
12263
|
-
content: {
|
|
12264
|
-
"application/json": {
|
|
12265
|
-
/** @example summer */
|
|
12266
|
-
name: string;
|
|
12267
|
-
};
|
|
12268
|
-
};
|
|
12269
|
-
};
|
|
12270
|
-
responses: {
|
|
12271
|
-
/** @description Tag created */
|
|
12272
|
-
201: {
|
|
12273
|
-
headers: {
|
|
12274
|
-
[name: string]: unknown;
|
|
12275
|
-
};
|
|
12276
|
-
content: {
|
|
12277
|
-
"application/json": {
|
|
12278
|
-
data: components["schemas"]["Tag"];
|
|
12389
|
+
data: components["schemas"]["FilterAttribute"];
|
|
12279
12390
|
};
|
|
12280
12391
|
};
|
|
12281
12392
|
};
|
|
12282
12393
|
};
|
|
12283
12394
|
};
|
|
12284
|
-
|
|
12395
|
+
deleteFilterAttribute: {
|
|
12285
12396
|
parameters: {
|
|
12286
12397
|
query?: never;
|
|
12287
12398
|
header?: never;
|
|
@@ -12292,7 +12403,7 @@ interface operations {
|
|
|
12292
12403
|
};
|
|
12293
12404
|
requestBody?: never;
|
|
12294
12405
|
responses: {
|
|
12295
|
-
/** @description
|
|
12406
|
+
/** @description Filter attribute deleted */
|
|
12296
12407
|
204: {
|
|
12297
12408
|
headers: {
|
|
12298
12409
|
[name: string]: unknown;
|
|
@@ -12301,7 +12412,7 @@ interface operations {
|
|
|
12301
12412
|
};
|
|
12302
12413
|
};
|
|
12303
12414
|
};
|
|
12304
|
-
|
|
12415
|
+
updateFilterAttribute: {
|
|
12305
12416
|
parameters: {
|
|
12306
12417
|
query?: never;
|
|
12307
12418
|
header?: never;
|
|
@@ -12313,48 +12424,327 @@ interface operations {
|
|
|
12313
12424
|
requestBody?: {
|
|
12314
12425
|
content: {
|
|
12315
12426
|
"application/json": {
|
|
12316
|
-
/** @example
|
|
12317
|
-
|
|
12427
|
+
/** @example metal */
|
|
12428
|
+
key?: string;
|
|
12429
|
+
/** @example Metal */
|
|
12430
|
+
label?: string;
|
|
12431
|
+
/**
|
|
12432
|
+
* @example spec
|
|
12433
|
+
* @enum {string}
|
|
12434
|
+
*/
|
|
12435
|
+
source_type?: "spec" | "option" | "field" | "tag" | "price" | "availability";
|
|
12436
|
+
/** @example Metal */
|
|
12437
|
+
source_key?: string | null;
|
|
12438
|
+
/** @example 1 */
|
|
12439
|
+
position?: number;
|
|
12318
12440
|
};
|
|
12319
12441
|
};
|
|
12320
12442
|
};
|
|
12321
12443
|
responses: {
|
|
12322
|
-
/** @description
|
|
12444
|
+
/** @description Filter attribute updated */
|
|
12323
12445
|
200: {
|
|
12324
12446
|
headers: {
|
|
12325
12447
|
[name: string]: unknown;
|
|
12326
12448
|
};
|
|
12327
12449
|
content: {
|
|
12328
12450
|
"application/json": {
|
|
12329
|
-
data: components["schemas"]["
|
|
12451
|
+
data: components["schemas"]["FilterAttribute"];
|
|
12330
12452
|
};
|
|
12331
12453
|
};
|
|
12332
12454
|
};
|
|
12333
12455
|
};
|
|
12334
12456
|
};
|
|
12335
|
-
|
|
12457
|
+
reorderFilterAttributes: {
|
|
12336
12458
|
parameters: {
|
|
12337
12459
|
query?: never;
|
|
12338
12460
|
header?: never;
|
|
12339
12461
|
path?: never;
|
|
12340
12462
|
cookie?: never;
|
|
12341
12463
|
};
|
|
12342
|
-
requestBody?:
|
|
12464
|
+
requestBody?: {
|
|
12465
|
+
content: {
|
|
12466
|
+
"application/json": {
|
|
12467
|
+
/**
|
|
12468
|
+
* @example [
|
|
12469
|
+
* {
|
|
12470
|
+
* "id": "fa_abc123",
|
|
12471
|
+
* "position": 0
|
|
12472
|
+
* }
|
|
12473
|
+
* ]
|
|
12474
|
+
*/
|
|
12475
|
+
items: {
|
|
12476
|
+
/** @example fa_abc123 */
|
|
12477
|
+
id: string;
|
|
12478
|
+
/** @example 0 */
|
|
12479
|
+
position: number;
|
|
12480
|
+
}[];
|
|
12481
|
+
};
|
|
12482
|
+
};
|
|
12483
|
+
};
|
|
12343
12484
|
responses: {
|
|
12344
|
-
/** @description
|
|
12485
|
+
/** @description Reordered filter attribute list */
|
|
12345
12486
|
200: {
|
|
12346
12487
|
headers: {
|
|
12347
12488
|
[name: string]: unknown;
|
|
12348
12489
|
};
|
|
12349
12490
|
content: {
|
|
12350
12491
|
"application/json": {
|
|
12351
|
-
data: components["schemas"]["
|
|
12492
|
+
data: components["schemas"]["FilterAttribute"][];
|
|
12493
|
+
pagination: {
|
|
12494
|
+
cursor: string | null;
|
|
12495
|
+
has_more: boolean;
|
|
12496
|
+
total: number;
|
|
12497
|
+
};
|
|
12352
12498
|
};
|
|
12353
12499
|
};
|
|
12354
12500
|
};
|
|
12355
12501
|
};
|
|
12356
12502
|
};
|
|
12357
|
-
|
|
12503
|
+
listRedirects: {
|
|
12504
|
+
parameters: {
|
|
12505
|
+
query?: {
|
|
12506
|
+
limit?: number;
|
|
12507
|
+
cursor?: string;
|
|
12508
|
+
fields?: string;
|
|
12509
|
+
sort?: "created_at" | "updated_at" | "title" | "relevance";
|
|
12510
|
+
order?: "asc" | "desc";
|
|
12511
|
+
};
|
|
12512
|
+
header?: never;
|
|
12513
|
+
path?: never;
|
|
12514
|
+
cookie?: never;
|
|
12515
|
+
};
|
|
12516
|
+
requestBody?: never;
|
|
12517
|
+
responses: {
|
|
12518
|
+
/** @description Paginated redirect list */
|
|
12519
|
+
200: {
|
|
12520
|
+
headers: {
|
|
12521
|
+
[name: string]: unknown;
|
|
12522
|
+
};
|
|
12523
|
+
content: {
|
|
12524
|
+
"application/json": {
|
|
12525
|
+
data: components["schemas"]["Redirect"][];
|
|
12526
|
+
pagination: {
|
|
12527
|
+
cursor: string | null;
|
|
12528
|
+
has_more: boolean;
|
|
12529
|
+
total: number;
|
|
12530
|
+
};
|
|
12531
|
+
};
|
|
12532
|
+
};
|
|
12533
|
+
};
|
|
12534
|
+
};
|
|
12535
|
+
};
|
|
12536
|
+
createRedirect: {
|
|
12537
|
+
parameters: {
|
|
12538
|
+
query?: never;
|
|
12539
|
+
header?: never;
|
|
12540
|
+
path?: never;
|
|
12541
|
+
cookie?: never;
|
|
12542
|
+
};
|
|
12543
|
+
requestBody?: {
|
|
12544
|
+
content: {
|
|
12545
|
+
"application/json": {
|
|
12546
|
+
/** @example /old-product-page */
|
|
12547
|
+
old_path: string;
|
|
12548
|
+
/** @example /products/classic-cotton-t-shirt */
|
|
12549
|
+
new_path: string;
|
|
12550
|
+
};
|
|
12551
|
+
};
|
|
12552
|
+
};
|
|
12553
|
+
responses: {
|
|
12554
|
+
/** @description Redirect created */
|
|
12555
|
+
201: {
|
|
12556
|
+
headers: {
|
|
12557
|
+
[name: string]: unknown;
|
|
12558
|
+
};
|
|
12559
|
+
content: {
|
|
12560
|
+
"application/json": {
|
|
12561
|
+
data: components["schemas"]["Redirect"];
|
|
12562
|
+
};
|
|
12563
|
+
};
|
|
12564
|
+
};
|
|
12565
|
+
};
|
|
12566
|
+
};
|
|
12567
|
+
lookupRedirect: {
|
|
12568
|
+
parameters: {
|
|
12569
|
+
query: {
|
|
12570
|
+
path: string;
|
|
12571
|
+
};
|
|
12572
|
+
header?: never;
|
|
12573
|
+
path?: never;
|
|
12574
|
+
cookie?: never;
|
|
12575
|
+
};
|
|
12576
|
+
requestBody?: never;
|
|
12577
|
+
responses: {
|
|
12578
|
+
/** @description Redirect found */
|
|
12579
|
+
200: {
|
|
12580
|
+
headers: {
|
|
12581
|
+
[name: string]: unknown;
|
|
12582
|
+
};
|
|
12583
|
+
content: {
|
|
12584
|
+
"application/json": {
|
|
12585
|
+
data: components["schemas"]["Redirect"];
|
|
12586
|
+
};
|
|
12587
|
+
};
|
|
12588
|
+
};
|
|
12589
|
+
};
|
|
12590
|
+
};
|
|
12591
|
+
deleteRedirect: {
|
|
12592
|
+
parameters: {
|
|
12593
|
+
query?: never;
|
|
12594
|
+
header?: never;
|
|
12595
|
+
path: {
|
|
12596
|
+
id: string;
|
|
12597
|
+
};
|
|
12598
|
+
cookie?: never;
|
|
12599
|
+
};
|
|
12600
|
+
requestBody?: never;
|
|
12601
|
+
responses: {
|
|
12602
|
+
/** @description Redirect deleted */
|
|
12603
|
+
204: {
|
|
12604
|
+
headers: {
|
|
12605
|
+
[name: string]: unknown;
|
|
12606
|
+
};
|
|
12607
|
+
content?: never;
|
|
12608
|
+
};
|
|
12609
|
+
};
|
|
12610
|
+
};
|
|
12611
|
+
listTags: {
|
|
12612
|
+
parameters: {
|
|
12613
|
+
query?: {
|
|
12614
|
+
limit?: number;
|
|
12615
|
+
cursor?: string;
|
|
12616
|
+
fields?: string;
|
|
12617
|
+
sort?: "created_at" | "updated_at" | "name";
|
|
12618
|
+
order?: "asc" | "desc";
|
|
12619
|
+
search?: string;
|
|
12620
|
+
};
|
|
12621
|
+
header?: never;
|
|
12622
|
+
path?: never;
|
|
12623
|
+
cookie?: never;
|
|
12624
|
+
};
|
|
12625
|
+
requestBody?: never;
|
|
12626
|
+
responses: {
|
|
12627
|
+
/** @description Paginated tag list */
|
|
12628
|
+
200: {
|
|
12629
|
+
headers: {
|
|
12630
|
+
[name: string]: unknown;
|
|
12631
|
+
};
|
|
12632
|
+
content: {
|
|
12633
|
+
"application/json": {
|
|
12634
|
+
data: components["schemas"]["Tag"][];
|
|
12635
|
+
pagination: {
|
|
12636
|
+
cursor: string | null;
|
|
12637
|
+
has_more: boolean;
|
|
12638
|
+
total: number;
|
|
12639
|
+
};
|
|
12640
|
+
};
|
|
12641
|
+
};
|
|
12642
|
+
};
|
|
12643
|
+
};
|
|
12644
|
+
};
|
|
12645
|
+
createTag: {
|
|
12646
|
+
parameters: {
|
|
12647
|
+
query?: never;
|
|
12648
|
+
header?: never;
|
|
12649
|
+
path?: never;
|
|
12650
|
+
cookie?: never;
|
|
12651
|
+
};
|
|
12652
|
+
requestBody?: {
|
|
12653
|
+
content: {
|
|
12654
|
+
"application/json": {
|
|
12655
|
+
/** @example summer */
|
|
12656
|
+
name: string;
|
|
12657
|
+
};
|
|
12658
|
+
};
|
|
12659
|
+
};
|
|
12660
|
+
responses: {
|
|
12661
|
+
/** @description Tag created */
|
|
12662
|
+
201: {
|
|
12663
|
+
headers: {
|
|
12664
|
+
[name: string]: unknown;
|
|
12665
|
+
};
|
|
12666
|
+
content: {
|
|
12667
|
+
"application/json": {
|
|
12668
|
+
data: components["schemas"]["Tag"];
|
|
12669
|
+
};
|
|
12670
|
+
};
|
|
12671
|
+
};
|
|
12672
|
+
};
|
|
12673
|
+
};
|
|
12674
|
+
deleteTag: {
|
|
12675
|
+
parameters: {
|
|
12676
|
+
query?: never;
|
|
12677
|
+
header?: never;
|
|
12678
|
+
path: {
|
|
12679
|
+
id: string;
|
|
12680
|
+
};
|
|
12681
|
+
cookie?: never;
|
|
12682
|
+
};
|
|
12683
|
+
requestBody?: never;
|
|
12684
|
+
responses: {
|
|
12685
|
+
/** @description Tag deleted */
|
|
12686
|
+
204: {
|
|
12687
|
+
headers: {
|
|
12688
|
+
[name: string]: unknown;
|
|
12689
|
+
};
|
|
12690
|
+
content?: never;
|
|
12691
|
+
};
|
|
12692
|
+
};
|
|
12693
|
+
};
|
|
12694
|
+
updateTag: {
|
|
12695
|
+
parameters: {
|
|
12696
|
+
query?: never;
|
|
12697
|
+
header?: never;
|
|
12698
|
+
path: {
|
|
12699
|
+
id: string;
|
|
12700
|
+
};
|
|
12701
|
+
cookie?: never;
|
|
12702
|
+
};
|
|
12703
|
+
requestBody?: {
|
|
12704
|
+
content: {
|
|
12705
|
+
"application/json": {
|
|
12706
|
+
/** @example summer-2026 */
|
|
12707
|
+
name: string;
|
|
12708
|
+
};
|
|
12709
|
+
};
|
|
12710
|
+
};
|
|
12711
|
+
responses: {
|
|
12712
|
+
/** @description Tag updated */
|
|
12713
|
+
200: {
|
|
12714
|
+
headers: {
|
|
12715
|
+
[name: string]: unknown;
|
|
12716
|
+
};
|
|
12717
|
+
content: {
|
|
12718
|
+
"application/json": {
|
|
12719
|
+
data: components["schemas"]["Tag"];
|
|
12720
|
+
};
|
|
12721
|
+
};
|
|
12722
|
+
};
|
|
12723
|
+
};
|
|
12724
|
+
};
|
|
12725
|
+
listProductTypes: {
|
|
12726
|
+
parameters: {
|
|
12727
|
+
query?: never;
|
|
12728
|
+
header?: never;
|
|
12729
|
+
path?: never;
|
|
12730
|
+
cookie?: never;
|
|
12731
|
+
};
|
|
12732
|
+
requestBody?: never;
|
|
12733
|
+
responses: {
|
|
12734
|
+
/** @description Product type list */
|
|
12735
|
+
200: {
|
|
12736
|
+
headers: {
|
|
12737
|
+
[name: string]: unknown;
|
|
12738
|
+
};
|
|
12739
|
+
content: {
|
|
12740
|
+
"application/json": {
|
|
12741
|
+
data: components["schemas"]["ProductTypeItem"][];
|
|
12742
|
+
};
|
|
12743
|
+
};
|
|
12744
|
+
};
|
|
12745
|
+
};
|
|
12746
|
+
};
|
|
12747
|
+
createProductType: {
|
|
12358
12748
|
parameters: {
|
|
12359
12749
|
query?: never;
|
|
12360
12750
|
header?: never;
|
|
@@ -12641,29 +13031,248 @@ interface operations {
|
|
|
12641
13031
|
};
|
|
12642
13032
|
};
|
|
12643
13033
|
responses: {
|
|
12644
|
-
/** @description Promotion updated */
|
|
13034
|
+
/** @description Promotion updated */
|
|
13035
|
+
200: {
|
|
13036
|
+
headers: {
|
|
13037
|
+
[name: string]: unknown;
|
|
13038
|
+
};
|
|
13039
|
+
content: {
|
|
13040
|
+
"application/json": {
|
|
13041
|
+
data: components["schemas"]["Promotion"];
|
|
13042
|
+
};
|
|
13043
|
+
};
|
|
13044
|
+
};
|
|
13045
|
+
};
|
|
13046
|
+
};
|
|
13047
|
+
listDiscounts: {
|
|
13048
|
+
parameters: {
|
|
13049
|
+
query?: {
|
|
13050
|
+
limit?: number;
|
|
13051
|
+
cursor?: string;
|
|
13052
|
+
fields?: string;
|
|
13053
|
+
sort?: "created_at" | "updated_at" | "code";
|
|
13054
|
+
order?: "asc" | "desc";
|
|
13055
|
+
status?: "active" | "disabled";
|
|
13056
|
+
search?: string;
|
|
13057
|
+
};
|
|
13058
|
+
header?: never;
|
|
13059
|
+
path?: never;
|
|
13060
|
+
cookie?: never;
|
|
13061
|
+
};
|
|
13062
|
+
requestBody?: never;
|
|
13063
|
+
responses: {
|
|
13064
|
+
/** @description Paginated discount list */
|
|
13065
|
+
200: {
|
|
13066
|
+
headers: {
|
|
13067
|
+
[name: string]: unknown;
|
|
13068
|
+
};
|
|
13069
|
+
content: {
|
|
13070
|
+
"application/json": {
|
|
13071
|
+
data: components["schemas"]["Discount"][];
|
|
13072
|
+
pagination: {
|
|
13073
|
+
cursor: string | null;
|
|
13074
|
+
has_more: boolean;
|
|
13075
|
+
total: number;
|
|
13076
|
+
};
|
|
13077
|
+
};
|
|
13078
|
+
};
|
|
13079
|
+
};
|
|
13080
|
+
};
|
|
13081
|
+
};
|
|
13082
|
+
createDiscount: {
|
|
13083
|
+
parameters: {
|
|
13084
|
+
query?: never;
|
|
13085
|
+
header?: never;
|
|
13086
|
+
path?: never;
|
|
13087
|
+
cookie?: never;
|
|
13088
|
+
};
|
|
13089
|
+
requestBody?: {
|
|
13090
|
+
content: {
|
|
13091
|
+
"application/json": {
|
|
13092
|
+
/** @example SUMMER20 */
|
|
13093
|
+
code: string;
|
|
13094
|
+
/** @example Summer Sale 20% */
|
|
13095
|
+
title: string;
|
|
13096
|
+
/**
|
|
13097
|
+
* @example percentage
|
|
13098
|
+
* @enum {string}
|
|
13099
|
+
*/
|
|
13100
|
+
type: "percentage" | "fixed_amount";
|
|
13101
|
+
/** @example 20 */
|
|
13102
|
+
value: number;
|
|
13103
|
+
/**
|
|
13104
|
+
* @default active
|
|
13105
|
+
* @example active
|
|
13106
|
+
* @enum {string}
|
|
13107
|
+
*/
|
|
13108
|
+
status?: "active" | "disabled";
|
|
13109
|
+
/** @example 5000 */
|
|
13110
|
+
min_subtotal?: number | null;
|
|
13111
|
+
/** @example 2 */
|
|
13112
|
+
min_quantity?: number | null;
|
|
13113
|
+
/** @example 1000 */
|
|
13114
|
+
max_uses?: number | null;
|
|
13115
|
+
/** @example 1 */
|
|
13116
|
+
max_uses_per_customer?: number | null;
|
|
13117
|
+
/**
|
|
13118
|
+
* @default true
|
|
13119
|
+
* @example true
|
|
13120
|
+
*/
|
|
13121
|
+
exclusive?: boolean;
|
|
13122
|
+
/**
|
|
13123
|
+
* @default true
|
|
13124
|
+
* @example true
|
|
13125
|
+
*/
|
|
13126
|
+
combinable_with_promotions?: boolean;
|
|
13127
|
+
/** @example null */
|
|
13128
|
+
customer_group_ids?: string[] | null;
|
|
13129
|
+
/**
|
|
13130
|
+
* Format: date-time
|
|
13131
|
+
* @example 2026-06-01T00:00:00Z
|
|
13132
|
+
*/
|
|
13133
|
+
starts_at: string;
|
|
13134
|
+
/**
|
|
13135
|
+
* Format: date-time
|
|
13136
|
+
* @example 2026-08-31T23:59:59Z
|
|
13137
|
+
*/
|
|
13138
|
+
ends_at?: string | null;
|
|
13139
|
+
};
|
|
13140
|
+
};
|
|
13141
|
+
};
|
|
13142
|
+
responses: {
|
|
13143
|
+
/** @description Discount created */
|
|
13144
|
+
201: {
|
|
13145
|
+
headers: {
|
|
13146
|
+
[name: string]: unknown;
|
|
13147
|
+
};
|
|
13148
|
+
content: {
|
|
13149
|
+
"application/json": {
|
|
13150
|
+
data: components["schemas"]["Discount"];
|
|
13151
|
+
};
|
|
13152
|
+
};
|
|
13153
|
+
};
|
|
13154
|
+
};
|
|
13155
|
+
};
|
|
13156
|
+
getDiscount: {
|
|
13157
|
+
parameters: {
|
|
13158
|
+
query?: never;
|
|
13159
|
+
header?: never;
|
|
13160
|
+
path: {
|
|
13161
|
+
id: string;
|
|
13162
|
+
};
|
|
13163
|
+
cookie?: never;
|
|
13164
|
+
};
|
|
13165
|
+
requestBody?: never;
|
|
13166
|
+
responses: {
|
|
13167
|
+
/** @description Discount details */
|
|
13168
|
+
200: {
|
|
13169
|
+
headers: {
|
|
13170
|
+
[name: string]: unknown;
|
|
13171
|
+
};
|
|
13172
|
+
content: {
|
|
13173
|
+
"application/json": {
|
|
13174
|
+
data: components["schemas"]["Discount"];
|
|
13175
|
+
};
|
|
13176
|
+
};
|
|
13177
|
+
};
|
|
13178
|
+
};
|
|
13179
|
+
};
|
|
13180
|
+
deleteDiscount: {
|
|
13181
|
+
parameters: {
|
|
13182
|
+
query?: never;
|
|
13183
|
+
header?: never;
|
|
13184
|
+
path: {
|
|
13185
|
+
id: string;
|
|
13186
|
+
};
|
|
13187
|
+
cookie?: never;
|
|
13188
|
+
};
|
|
13189
|
+
requestBody?: never;
|
|
13190
|
+
responses: {
|
|
13191
|
+
/** @description Discount deleted */
|
|
13192
|
+
204: {
|
|
13193
|
+
headers: {
|
|
13194
|
+
[name: string]: unknown;
|
|
13195
|
+
};
|
|
13196
|
+
content?: never;
|
|
13197
|
+
};
|
|
13198
|
+
};
|
|
13199
|
+
};
|
|
13200
|
+
updateDiscount: {
|
|
13201
|
+
parameters: {
|
|
13202
|
+
query?: never;
|
|
13203
|
+
header?: never;
|
|
13204
|
+
path: {
|
|
13205
|
+
id: string;
|
|
13206
|
+
};
|
|
13207
|
+
cookie?: never;
|
|
13208
|
+
};
|
|
13209
|
+
requestBody?: {
|
|
13210
|
+
content: {
|
|
13211
|
+
"application/json": {
|
|
13212
|
+
/** @example Summer Sale Updated */
|
|
13213
|
+
title?: string;
|
|
13214
|
+
/**
|
|
13215
|
+
* @example percentage
|
|
13216
|
+
* @enum {string}
|
|
13217
|
+
*/
|
|
13218
|
+
type?: "percentage" | "fixed_amount";
|
|
13219
|
+
/** @example 25 */
|
|
13220
|
+
value?: number;
|
|
13221
|
+
/**
|
|
13222
|
+
* @example active
|
|
13223
|
+
* @enum {string}
|
|
13224
|
+
*/
|
|
13225
|
+
status?: "active" | "disabled";
|
|
13226
|
+
/** @example 5000 */
|
|
13227
|
+
min_subtotal?: number | null;
|
|
13228
|
+
/** @example 2 */
|
|
13229
|
+
min_quantity?: number | null;
|
|
13230
|
+
/** @example 1000 */
|
|
13231
|
+
max_uses?: number | null;
|
|
13232
|
+
/** @example 1 */
|
|
13233
|
+
max_uses_per_customer?: number | null;
|
|
13234
|
+
/** @example true */
|
|
13235
|
+
exclusive?: boolean;
|
|
13236
|
+
/** @example true */
|
|
13237
|
+
combinable_with_promotions?: boolean;
|
|
13238
|
+
/** @example null */
|
|
13239
|
+
customer_group_ids?: string[] | null;
|
|
13240
|
+
/**
|
|
13241
|
+
* Format: date-time
|
|
13242
|
+
* @example 2026-06-01T00:00:00Z
|
|
13243
|
+
*/
|
|
13244
|
+
starts_at?: string;
|
|
13245
|
+
/**
|
|
13246
|
+
* Format: date-time
|
|
13247
|
+
* @example 2026-08-31T23:59:59Z
|
|
13248
|
+
*/
|
|
13249
|
+
ends_at?: string | null;
|
|
13250
|
+
};
|
|
13251
|
+
};
|
|
13252
|
+
};
|
|
13253
|
+
responses: {
|
|
13254
|
+
/** @description Discount updated */
|
|
12645
13255
|
200: {
|
|
12646
13256
|
headers: {
|
|
12647
13257
|
[name: string]: unknown;
|
|
12648
13258
|
};
|
|
12649
13259
|
content: {
|
|
12650
13260
|
"application/json": {
|
|
12651
|
-
data: components["schemas"]["
|
|
13261
|
+
data: components["schemas"]["Discount"];
|
|
12652
13262
|
};
|
|
12653
13263
|
};
|
|
12654
13264
|
};
|
|
12655
13265
|
};
|
|
12656
13266
|
};
|
|
12657
|
-
|
|
13267
|
+
listMembershipPlans: {
|
|
12658
13268
|
parameters: {
|
|
12659
13269
|
query?: {
|
|
12660
13270
|
limit?: number;
|
|
12661
13271
|
cursor?: string;
|
|
12662
13272
|
fields?: string;
|
|
12663
|
-
sort?: "created_at" | "updated_at" | "
|
|
13273
|
+
sort?: "created_at" | "updated_at" | "name";
|
|
12664
13274
|
order?: "asc" | "desc";
|
|
12665
|
-
status?: "active" | "
|
|
12666
|
-
search?: string;
|
|
13275
|
+
status?: "active" | "archived";
|
|
12667
13276
|
};
|
|
12668
13277
|
header?: never;
|
|
12669
13278
|
path?: never;
|
|
@@ -12671,14 +13280,14 @@ interface operations {
|
|
|
12671
13280
|
};
|
|
12672
13281
|
requestBody?: never;
|
|
12673
13282
|
responses: {
|
|
12674
|
-
/** @description Paginated
|
|
13283
|
+
/** @description Paginated plan list */
|
|
12675
13284
|
200: {
|
|
12676
13285
|
headers: {
|
|
12677
13286
|
[name: string]: unknown;
|
|
12678
13287
|
};
|
|
12679
13288
|
content: {
|
|
12680
13289
|
"application/json": {
|
|
12681
|
-
data: components["schemas"]["
|
|
13290
|
+
data: components["schemas"]["MembershipPlan"][];
|
|
12682
13291
|
pagination: {
|
|
12683
13292
|
cursor: string | null;
|
|
12684
13293
|
has_more: boolean;
|
|
@@ -12689,7 +13298,7 @@ interface operations {
|
|
|
12689
13298
|
};
|
|
12690
13299
|
};
|
|
12691
13300
|
};
|
|
12692
|
-
|
|
13301
|
+
createMembershipPlan: {
|
|
12693
13302
|
parameters: {
|
|
12694
13303
|
query?: never;
|
|
12695
13304
|
header?: never;
|
|
@@ -12699,71 +13308,58 @@ interface operations {
|
|
|
12699
13308
|
requestBody?: {
|
|
12700
13309
|
content: {
|
|
12701
13310
|
"application/json": {
|
|
12702
|
-
/** @example
|
|
12703
|
-
|
|
12704
|
-
/** @example
|
|
12705
|
-
|
|
13311
|
+
/** @example VIP Membership */
|
|
13312
|
+
name: string;
|
|
13313
|
+
/** @example Unlock wholesale pricing */
|
|
13314
|
+
description?: string;
|
|
13315
|
+
/** @example vip-membership */
|
|
13316
|
+
slug: string;
|
|
12706
13317
|
/**
|
|
12707
|
-
* @
|
|
12708
|
-
* @
|
|
13318
|
+
* @description Price in cents
|
|
13319
|
+
* @example 1199
|
|
12709
13320
|
*/
|
|
12710
|
-
|
|
12711
|
-
/** @example
|
|
12712
|
-
|
|
13321
|
+
amount: number;
|
|
13322
|
+
/** @example gbp */
|
|
13323
|
+
currency: string;
|
|
12713
13324
|
/**
|
|
12714
|
-
* @
|
|
12715
|
-
* @example active
|
|
13325
|
+
* @example month
|
|
12716
13326
|
* @enum {string}
|
|
12717
13327
|
*/
|
|
12718
|
-
|
|
12719
|
-
/** @example 5000 */
|
|
12720
|
-
min_subtotal?: number | null;
|
|
12721
|
-
/** @example 2 */
|
|
12722
|
-
min_quantity?: number | null;
|
|
12723
|
-
/** @example 1000 */
|
|
12724
|
-
max_uses?: number | null;
|
|
12725
|
-
/** @example 1 */
|
|
12726
|
-
max_uses_per_customer?: number | null;
|
|
12727
|
-
/**
|
|
12728
|
-
* @default true
|
|
12729
|
-
* @example true
|
|
12730
|
-
*/
|
|
12731
|
-
exclusive?: boolean;
|
|
12732
|
-
/**
|
|
12733
|
-
* @default true
|
|
12734
|
-
* @example true
|
|
12735
|
-
*/
|
|
12736
|
-
combinable_with_promotions?: boolean;
|
|
12737
|
-
/** @example null */
|
|
12738
|
-
customer_group_ids?: string[] | null;
|
|
13328
|
+
interval: "month" | "year";
|
|
12739
13329
|
/**
|
|
12740
|
-
*
|
|
12741
|
-
* @example
|
|
13330
|
+
* @default 1
|
|
13331
|
+
* @example 1
|
|
12742
13332
|
*/
|
|
12743
|
-
|
|
13333
|
+
interval_count?: number;
|
|
13334
|
+
/** @example 14 */
|
|
13335
|
+
trial_days?: number;
|
|
12744
13336
|
/**
|
|
12745
|
-
*
|
|
12746
|
-
* @example
|
|
13337
|
+
* @description Auto-assign members to this group
|
|
13338
|
+
* @example cg_abc123
|
|
12747
13339
|
*/
|
|
12748
|
-
|
|
13340
|
+
customer_group_id?: string;
|
|
13341
|
+
/** @default {} */
|
|
13342
|
+
metadata?: {
|
|
13343
|
+
[key: string]: string | number;
|
|
13344
|
+
};
|
|
12749
13345
|
};
|
|
12750
13346
|
};
|
|
12751
13347
|
};
|
|
12752
13348
|
responses: {
|
|
12753
|
-
/** @description
|
|
13349
|
+
/** @description Plan created */
|
|
12754
13350
|
201: {
|
|
12755
13351
|
headers: {
|
|
12756
13352
|
[name: string]: unknown;
|
|
12757
13353
|
};
|
|
12758
13354
|
content: {
|
|
12759
13355
|
"application/json": {
|
|
12760
|
-
data: components["schemas"]["
|
|
13356
|
+
data: components["schemas"]["MembershipPlan"];
|
|
12761
13357
|
};
|
|
12762
13358
|
};
|
|
12763
13359
|
};
|
|
12764
13360
|
};
|
|
12765
13361
|
};
|
|
12766
|
-
|
|
13362
|
+
getMembershipPlan: {
|
|
12767
13363
|
parameters: {
|
|
12768
13364
|
query?: never;
|
|
12769
13365
|
header?: never;
|
|
@@ -12774,20 +13370,20 @@ interface operations {
|
|
|
12774
13370
|
};
|
|
12775
13371
|
requestBody?: never;
|
|
12776
13372
|
responses: {
|
|
12777
|
-
/** @description
|
|
13373
|
+
/** @description Plan details */
|
|
12778
13374
|
200: {
|
|
12779
13375
|
headers: {
|
|
12780
13376
|
[name: string]: unknown;
|
|
12781
13377
|
};
|
|
12782
13378
|
content: {
|
|
12783
13379
|
"application/json": {
|
|
12784
|
-
data: components["schemas"]["
|
|
13380
|
+
data: components["schemas"]["MembershipPlan"];
|
|
12785
13381
|
};
|
|
12786
13382
|
};
|
|
12787
13383
|
};
|
|
12788
13384
|
};
|
|
12789
13385
|
};
|
|
12790
|
-
|
|
13386
|
+
deleteMembershipPlan: {
|
|
12791
13387
|
parameters: {
|
|
12792
13388
|
query?: never;
|
|
12793
13389
|
header?: never;
|
|
@@ -12798,7 +13394,7 @@ interface operations {
|
|
|
12798
13394
|
};
|
|
12799
13395
|
requestBody?: never;
|
|
12800
13396
|
responses: {
|
|
12801
|
-
/** @description
|
|
13397
|
+
/** @description Plan archived */
|
|
12802
13398
|
204: {
|
|
12803
13399
|
headers: {
|
|
12804
13400
|
[name: string]: unknown;
|
|
@@ -12807,7 +13403,7 @@ interface operations {
|
|
|
12807
13403
|
};
|
|
12808
13404
|
};
|
|
12809
13405
|
};
|
|
12810
|
-
|
|
13406
|
+
updateMembershipPlan: {
|
|
12811
13407
|
parameters: {
|
|
12812
13408
|
query?: never;
|
|
12813
13409
|
header?: never;
|
|
@@ -12819,56 +13415,70 @@ interface operations {
|
|
|
12819
13415
|
requestBody?: {
|
|
12820
13416
|
content: {
|
|
12821
13417
|
"application/json": {
|
|
12822
|
-
/** @example
|
|
12823
|
-
|
|
12824
|
-
/**
|
|
12825
|
-
|
|
12826
|
-
* @enum {string}
|
|
12827
|
-
*/
|
|
12828
|
-
type?: "percentage" | "fixed_amount";
|
|
12829
|
-
/** @example 25 */
|
|
12830
|
-
value?: number;
|
|
13418
|
+
/** @example VIP Membership */
|
|
13419
|
+
name?: string;
|
|
13420
|
+
/** @example Unlock wholesale pricing */
|
|
13421
|
+
description?: string | null;
|
|
12831
13422
|
/**
|
|
12832
13423
|
* @example active
|
|
12833
13424
|
* @enum {string}
|
|
12834
13425
|
*/
|
|
12835
|
-
status?: "active" | "
|
|
12836
|
-
/** @example
|
|
12837
|
-
|
|
12838
|
-
/** @example
|
|
12839
|
-
|
|
12840
|
-
|
|
12841
|
-
|
|
12842
|
-
|
|
12843
|
-
max_uses_per_customer?: number | null;
|
|
12844
|
-
/** @example true */
|
|
12845
|
-
exclusive?: boolean;
|
|
12846
|
-
/** @example true */
|
|
12847
|
-
combinable_with_promotions?: boolean;
|
|
12848
|
-
/** @example null */
|
|
12849
|
-
customer_group_ids?: string[] | null;
|
|
12850
|
-
/**
|
|
12851
|
-
* Format: date-time
|
|
12852
|
-
* @example 2026-06-01T00:00:00Z
|
|
12853
|
-
*/
|
|
12854
|
-
starts_at?: string;
|
|
12855
|
-
/**
|
|
12856
|
-
* Format: date-time
|
|
12857
|
-
* @example 2026-08-31T23:59:59Z
|
|
12858
|
-
*/
|
|
12859
|
-
ends_at?: string | null;
|
|
13426
|
+
status?: "active" | "archived";
|
|
13427
|
+
/** @example 14 */
|
|
13428
|
+
trial_days?: number | null;
|
|
13429
|
+
/** @example cg_abc123 */
|
|
13430
|
+
customer_group_id?: string | null;
|
|
13431
|
+
metadata?: {
|
|
13432
|
+
[key: string]: string | number;
|
|
13433
|
+
};
|
|
12860
13434
|
};
|
|
12861
13435
|
};
|
|
12862
13436
|
};
|
|
12863
13437
|
responses: {
|
|
12864
|
-
/** @description
|
|
13438
|
+
/** @description Plan updated */
|
|
12865
13439
|
200: {
|
|
12866
13440
|
headers: {
|
|
12867
13441
|
[name: string]: unknown;
|
|
12868
13442
|
};
|
|
12869
13443
|
content: {
|
|
12870
13444
|
"application/json": {
|
|
12871
|
-
data: components["schemas"]["
|
|
13445
|
+
data: components["schemas"]["MembershipPlan"];
|
|
13446
|
+
};
|
|
13447
|
+
};
|
|
13448
|
+
};
|
|
13449
|
+
};
|
|
13450
|
+
};
|
|
13451
|
+
listMembershipSubscriptions: {
|
|
13452
|
+
parameters: {
|
|
13453
|
+
query?: {
|
|
13454
|
+
limit?: number;
|
|
13455
|
+
cursor?: string;
|
|
13456
|
+
fields?: string;
|
|
13457
|
+
sort?: "created_at" | "updated_at";
|
|
13458
|
+
order?: "asc" | "desc";
|
|
13459
|
+
status?: "active" | "trialing" | "past_due" | "cancelled" | "expired" | "pending";
|
|
13460
|
+
plan_id?: string;
|
|
13461
|
+
customer_id?: string;
|
|
13462
|
+
};
|
|
13463
|
+
header?: never;
|
|
13464
|
+
path?: never;
|
|
13465
|
+
cookie?: never;
|
|
13466
|
+
};
|
|
13467
|
+
requestBody?: never;
|
|
13468
|
+
responses: {
|
|
13469
|
+
/** @description Paginated subscription list */
|
|
13470
|
+
200: {
|
|
13471
|
+
headers: {
|
|
13472
|
+
[name: string]: unknown;
|
|
13473
|
+
};
|
|
13474
|
+
content: {
|
|
13475
|
+
"application/json": {
|
|
13476
|
+
data: components["schemas"]["CustomerMembership"][];
|
|
13477
|
+
pagination: {
|
|
13478
|
+
cursor: string | null;
|
|
13479
|
+
has_more: boolean;
|
|
13480
|
+
total: number;
|
|
13481
|
+
};
|
|
12872
13482
|
};
|
|
12873
13483
|
};
|
|
12874
13484
|
};
|
|
@@ -14704,6 +15314,8 @@ interface operations {
|
|
|
14704
15314
|
label: string;
|
|
14705
15315
|
/** @example /collections/women-dresses */
|
|
14706
15316
|
url?: string | null;
|
|
15317
|
+
/** @enum {string|null} */
|
|
15318
|
+
resource_type?: "collection" | "product" | "page" | "custom" | null;
|
|
14707
15319
|
/**
|
|
14708
15320
|
* @default link
|
|
14709
15321
|
* @enum {string}
|
|
@@ -14724,6 +15336,8 @@ interface operations {
|
|
|
14724
15336
|
label: string;
|
|
14725
15337
|
/** @example /collections/women-dresses */
|
|
14726
15338
|
url?: string | null;
|
|
15339
|
+
/** @enum {string|null} */
|
|
15340
|
+
resource_type?: "collection" | "product" | "page" | "custom" | null;
|
|
14727
15341
|
/**
|
|
14728
15342
|
* @default link
|
|
14729
15343
|
* @enum {string}
|
|
@@ -14744,6 +15358,8 @@ interface operations {
|
|
|
14744
15358
|
label: string;
|
|
14745
15359
|
/** @example /collections/women-dresses */
|
|
14746
15360
|
url?: string | null;
|
|
15361
|
+
/** @enum {string|null} */
|
|
15362
|
+
resource_type?: "collection" | "product" | "page" | "custom" | null;
|
|
14747
15363
|
/**
|
|
14748
15364
|
* @default link
|
|
14749
15365
|
* @enum {string}
|
|
@@ -14874,6 +15490,8 @@ interface operations {
|
|
|
14874
15490
|
label: string;
|
|
14875
15491
|
/** @example /collections/women */
|
|
14876
15492
|
url?: string | null;
|
|
15493
|
+
/** @enum {string|null} */
|
|
15494
|
+
resource_type?: "collection" | "product" | "page" | "custom" | null;
|
|
14877
15495
|
/**
|
|
14878
15496
|
* @default link
|
|
14879
15497
|
* @enum {string}
|
|
@@ -14976,6 +15594,8 @@ interface operations {
|
|
|
14976
15594
|
/** @example Women */
|
|
14977
15595
|
label?: string;
|
|
14978
15596
|
url?: string | null;
|
|
15597
|
+
/** @enum {string|null} */
|
|
15598
|
+
resource_type?: "collection" | "product" | "page" | "custom" | null;
|
|
14979
15599
|
/** @enum {string} */
|
|
14980
15600
|
item_type?: "link" | "heading" | "featured";
|
|
14981
15601
|
parent_item_id?: string | null;
|
|
@@ -15978,6 +16598,95 @@ interface operations {
|
|
|
15978
16598
|
};
|
|
15979
16599
|
};
|
|
15980
16600
|
};
|
|
16601
|
+
getCustomerMembership: {
|
|
16602
|
+
parameters: {
|
|
16603
|
+
query?: never;
|
|
16604
|
+
header?: never;
|
|
16605
|
+
path?: never;
|
|
16606
|
+
cookie?: never;
|
|
16607
|
+
};
|
|
16608
|
+
requestBody?: never;
|
|
16609
|
+
responses: {
|
|
16610
|
+
/** @description Active membership or null */
|
|
16611
|
+
200: {
|
|
16612
|
+
headers: {
|
|
16613
|
+
[name: string]: unknown;
|
|
16614
|
+
};
|
|
16615
|
+
content?: never;
|
|
16616
|
+
};
|
|
16617
|
+
};
|
|
16618
|
+
};
|
|
16619
|
+
subscribeMembership: {
|
|
16620
|
+
parameters: {
|
|
16621
|
+
query?: never;
|
|
16622
|
+
header?: never;
|
|
16623
|
+
path?: never;
|
|
16624
|
+
cookie?: never;
|
|
16625
|
+
};
|
|
16626
|
+
requestBody?: {
|
|
16627
|
+
content: {
|
|
16628
|
+
"application/json": {
|
|
16629
|
+
/** @example mplan_abc123 */
|
|
16630
|
+
plan_id: string;
|
|
16631
|
+
/**
|
|
16632
|
+
* Format: uri
|
|
16633
|
+
* @example https://auriclejewelry.com/account/membership?success=true
|
|
16634
|
+
*/
|
|
16635
|
+
success_url: string;
|
|
16636
|
+
/**
|
|
16637
|
+
* Format: uri
|
|
16638
|
+
* @example https://auriclejewelry.com/vip-membership
|
|
16639
|
+
*/
|
|
16640
|
+
cancel_url: string;
|
|
16641
|
+
};
|
|
16642
|
+
};
|
|
16643
|
+
};
|
|
16644
|
+
responses: {
|
|
16645
|
+
/** @description Stripe Checkout URL */
|
|
16646
|
+
200: {
|
|
16647
|
+
headers: {
|
|
16648
|
+
[name: string]: unknown;
|
|
16649
|
+
};
|
|
16650
|
+
content: {
|
|
16651
|
+
"application/json": {
|
|
16652
|
+
data: components["schemas"]["SubscribeCheckout"];
|
|
16653
|
+
};
|
|
16654
|
+
};
|
|
16655
|
+
};
|
|
16656
|
+
};
|
|
16657
|
+
};
|
|
16658
|
+
getMembershipPortal: {
|
|
16659
|
+
parameters: {
|
|
16660
|
+
query?: never;
|
|
16661
|
+
header?: never;
|
|
16662
|
+
path?: never;
|
|
16663
|
+
cookie?: never;
|
|
16664
|
+
};
|
|
16665
|
+
requestBody?: {
|
|
16666
|
+
content: {
|
|
16667
|
+
"application/json": {
|
|
16668
|
+
/**
|
|
16669
|
+
* Format: uri
|
|
16670
|
+
* @example https://auriclejewelry.com/account/membership
|
|
16671
|
+
*/
|
|
16672
|
+
return_url: string;
|
|
16673
|
+
};
|
|
16674
|
+
};
|
|
16675
|
+
};
|
|
16676
|
+
responses: {
|
|
16677
|
+
/** @description Portal URL */
|
|
16678
|
+
200: {
|
|
16679
|
+
headers: {
|
|
16680
|
+
[name: string]: unknown;
|
|
16681
|
+
};
|
|
16682
|
+
content: {
|
|
16683
|
+
"application/json": {
|
|
16684
|
+
data: components["schemas"]["MembershipPortal"];
|
|
16685
|
+
};
|
|
16686
|
+
};
|
|
16687
|
+
};
|
|
16688
|
+
};
|
|
16689
|
+
};
|
|
15981
16690
|
getAnalyticsSummary: {
|
|
15982
16691
|
parameters: {
|
|
15983
16692
|
query?: {
|
|
@@ -16298,9 +17007,9 @@ type ProductStats = components['schemas']['ProductStats'];
|
|
|
16298
17007
|
type Variant$1 = components['schemas']['Variant'];
|
|
16299
17008
|
type Image$1 = components['schemas']['Image'];
|
|
16300
17009
|
type GenerateVariantsResult = components['schemas']['GenerateVariantsResult'];
|
|
16301
|
-
type ListParams$
|
|
16302
|
-
type CreateBody$
|
|
16303
|
-
type UpdateBody$
|
|
17010
|
+
type ListParams$o = NonNullable<operations['listProducts']['parameters']['query']>;
|
|
17011
|
+
type CreateBody$k = NonNullable<operations['createProduct']['requestBody']>['content']['application/json'];
|
|
17012
|
+
type UpdateBody$k = NonNullable<operations['updateProduct']['requestBody']>['content']['application/json'];
|
|
16304
17013
|
type DuplicateBody = NonNullable<operations['duplicateProduct']['requestBody']>['content']['application/json'];
|
|
16305
17014
|
type CreateVariantBody = NonNullable<operations['createProductVariant']['requestBody']>['content']['application/json'];
|
|
16306
17015
|
type GenerateVariantsBody = NonNullable<operations['generateProductVariants']['requestBody']>['content']['application/json'];
|
|
@@ -16308,17 +17017,17 @@ type AttachImagesBody = NonNullable<operations['attachProductImages']['requestBo
|
|
|
16308
17017
|
declare class ProductsResource {
|
|
16309
17018
|
private client;
|
|
16310
17019
|
constructor(client: Hydra);
|
|
16311
|
-
list(params?: ListParams$
|
|
16312
|
-
iterate(params?: Omit<ListParams$
|
|
16313
|
-
toArray(params?: Omit<ListParams$
|
|
17020
|
+
list(params?: ListParams$o): Promise<ListResponse<Product>>;
|
|
17021
|
+
iterate(params?: Omit<ListParams$o, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Product, void, undefined>;
|
|
17022
|
+
toArray(params?: Omit<ListParams$o, 'cursor'>, options?: PaginateOptions & {
|
|
16314
17023
|
limit?: number;
|
|
16315
17024
|
}): Promise<Product[]>;
|
|
16316
|
-
get(id: string, params?: Pick<ListParams$
|
|
16317
|
-
create(body: CreateBody$
|
|
16318
|
-
update(id: string, body: UpdateBody$
|
|
17025
|
+
get(id: string, params?: Pick<ListParams$o, 'expand' | 'currency' | 'fields'>): Promise<DataResponse<Product>>;
|
|
17026
|
+
create(body: CreateBody$k, options?: ResourceRequestOptions): Promise<DataResponse<Product>>;
|
|
17027
|
+
update(id: string, body: UpdateBody$k): Promise<DataResponse<Product>>;
|
|
16319
17028
|
delete(id: string): Promise<void>;
|
|
16320
17029
|
batchCreate(body: {
|
|
16321
|
-
products: CreateBody$
|
|
17030
|
+
products: CreateBody$k[];
|
|
16322
17031
|
}, options?: ResourceRequestOptions): Promise<DataResponse<Product[]>>;
|
|
16323
17032
|
duplicate(id: string, body: DuplicateBody): Promise<DataResponse<Product>>;
|
|
16324
17033
|
getStats(id: string): Promise<DataResponse<ProductStats>>;
|
|
@@ -16336,7 +17045,7 @@ declare class ProductsResource {
|
|
|
16336
17045
|
|
|
16337
17046
|
type Variant = components['schemas']['Variant'];
|
|
16338
17047
|
type VariantPrice = components['schemas']['VariantPrice'];
|
|
16339
|
-
type UpdateBody$
|
|
17048
|
+
type UpdateBody$j = NonNullable<operations['updateVariant']['requestBody']>['content']['application/json'];
|
|
16340
17049
|
type UpsertPriceBody = NonNullable<operations['upsertVariantPrice']['requestBody']>['content']['application/json'];
|
|
16341
17050
|
declare class VariantsResource {
|
|
16342
17051
|
private client;
|
|
@@ -16346,7 +17055,7 @@ declare class VariantsResource {
|
|
|
16346
17055
|
currency?: string;
|
|
16347
17056
|
fields?: string;
|
|
16348
17057
|
}): Promise<DataResponse<Variant>>;
|
|
16349
|
-
update(id: string, body: UpdateBody$
|
|
17058
|
+
update(id: string, body: UpdateBody$j): Promise<DataResponse<Variant>>;
|
|
16350
17059
|
delete(id: string): Promise<void>;
|
|
16351
17060
|
listPrices(variantId: string): Promise<DataResponse<Record<string, VariantPrice>>>;
|
|
16352
17061
|
upsertPrice(variantId: string, priceKeySlug: string, body: UpsertPriceBody): Promise<DataResponse<VariantPrice>>;
|
|
@@ -16358,23 +17067,23 @@ declare class VariantsResource {
|
|
|
16358
17067
|
}
|
|
16359
17068
|
|
|
16360
17069
|
type Collection = components['schemas']['Collection'];
|
|
16361
|
-
type ListParams$
|
|
16362
|
-
type CreateBody$
|
|
16363
|
-
type UpdateBody$
|
|
17070
|
+
type ListParams$n = NonNullable<operations['listCollections']['parameters']['query']>;
|
|
17071
|
+
type CreateBody$j = NonNullable<operations['createCollection']['requestBody']>['content']['application/json'];
|
|
17072
|
+
type UpdateBody$i = NonNullable<operations['updateCollection']['requestBody']>['content']['application/json'];
|
|
16364
17073
|
type AddProductsBody = NonNullable<operations['addCollectionProducts']['requestBody']>['content']['application/json'];
|
|
16365
17074
|
type ReorderProductsBody = NonNullable<operations['reorderCollectionProducts']['requestBody']>['content']['application/json'];
|
|
16366
17075
|
type ReorderCollectionsBody = NonNullable<operations['reorderCollections']['requestBody']>['content']['application/json'];
|
|
16367
17076
|
declare class CollectionsResource {
|
|
16368
17077
|
private client;
|
|
16369
17078
|
constructor(client: Hydra);
|
|
16370
|
-
list(params?: ListParams$
|
|
16371
|
-
iterate(params?: Omit<ListParams$
|
|
16372
|
-
toArray(params?: Omit<ListParams$
|
|
17079
|
+
list(params?: ListParams$n): Promise<ListResponse<Collection>>;
|
|
17080
|
+
iterate(params?: Omit<ListParams$n, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Collection, void, undefined>;
|
|
17081
|
+
toArray(params?: Omit<ListParams$n, 'cursor'>, options?: PaginateOptions & {
|
|
16373
17082
|
limit?: number;
|
|
16374
17083
|
}): Promise<Collection[]>;
|
|
16375
|
-
get(id: string, params?: Pick<ListParams$
|
|
16376
|
-
create(body: CreateBody$
|
|
16377
|
-
update(id: string, body: UpdateBody$
|
|
17084
|
+
get(id: string, params?: Pick<ListParams$n, 'expand' | 'fields'>): Promise<DataResponse<Collection>>;
|
|
17085
|
+
create(body: CreateBody$j, options?: ResourceRequestOptions): Promise<DataResponse<Collection>>;
|
|
17086
|
+
update(id: string, body: UpdateBody$i): Promise<DataResponse<Collection>>;
|
|
16378
17087
|
delete(id: string): Promise<void>;
|
|
16379
17088
|
tree(): Promise<DataResponse<unknown>>;
|
|
16380
17089
|
reorder(body: ReorderCollectionsBody): Promise<void>;
|
|
@@ -16404,13 +17113,13 @@ declare class CartResource {
|
|
|
16404
17113
|
|
|
16405
17114
|
type CheckoutCreate = components['schemas']['CheckoutCreate'];
|
|
16406
17115
|
type CheckoutGet = components['schemas']['CheckoutGet'];
|
|
16407
|
-
type CreateBody$
|
|
17116
|
+
type CreateBody$i = NonNullable<operations['createCheckout']['requestBody']>['content']['application/json'];
|
|
16408
17117
|
type ApplyDiscountBody = NonNullable<operations['applyCheckoutDiscount']['requestBody']>['content']['application/json'];
|
|
16409
17118
|
type ApplyCreditBody = NonNullable<operations['applyCheckoutCredit']['requestBody']>['content']['application/json'];
|
|
16410
17119
|
declare class CheckoutResource {
|
|
16411
17120
|
private client;
|
|
16412
17121
|
constructor(client: Hydra);
|
|
16413
|
-
create(body: CreateBody$
|
|
17122
|
+
create(body: CreateBody$i, options?: ResourceRequestOptions): Promise<DataResponse<CheckoutCreate>>;
|
|
16414
17123
|
get(id: string): Promise<DataResponse<CheckoutGet>>;
|
|
16415
17124
|
applyDiscount(checkoutId: string, body: ApplyDiscountBody): Promise<DataResponse<CheckoutGet>>;
|
|
16416
17125
|
removeDiscount(checkoutId: string): Promise<DataResponse<CheckoutGet>>;
|
|
@@ -16421,15 +17130,15 @@ declare class CheckoutResource {
|
|
|
16421
17130
|
|
|
16422
17131
|
type Order$1 = components['schemas']['Order'];
|
|
16423
17132
|
type FulfillmentOrder$1 = components['schemas']['FulfillmentOrder'];
|
|
16424
|
-
type ListParams$
|
|
16425
|
-
type CreateBody$
|
|
16426
|
-
type UpdateBody$
|
|
17133
|
+
type ListParams$m = NonNullable<operations['listOrders']['parameters']['query']>;
|
|
17134
|
+
type CreateBody$h = NonNullable<operations['createOrder']['requestBody']>['content']['application/json'];
|
|
17135
|
+
type UpdateBody$h = NonNullable<operations['updateOrder']['requestBody']>['content']['application/json'];
|
|
16427
17136
|
declare class OrdersResource {
|
|
16428
17137
|
private client;
|
|
16429
17138
|
constructor(client: Hydra);
|
|
16430
|
-
list(params?: ListParams$
|
|
16431
|
-
iterate(params?: Omit<ListParams$
|
|
16432
|
-
toArray(params?: Omit<ListParams$
|
|
17139
|
+
list(params?: ListParams$m): Promise<ListResponse<Order$1>>;
|
|
17140
|
+
iterate(params?: Omit<ListParams$m, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Order$1, void, undefined>;
|
|
17141
|
+
toArray(params?: Omit<ListParams$m, 'cursor'>, options?: PaginateOptions & {
|
|
16433
17142
|
limit?: number;
|
|
16434
17143
|
}): Promise<Order$1[]>;
|
|
16435
17144
|
get(id: string, params?: {
|
|
@@ -16437,8 +17146,8 @@ declare class OrdersResource {
|
|
|
16437
17146
|
currency?: string;
|
|
16438
17147
|
fields?: string;
|
|
16439
17148
|
}): Promise<DataResponse<Order$1>>;
|
|
16440
|
-
create(body: CreateBody$
|
|
16441
|
-
update(id: string, body: UpdateBody$
|
|
17149
|
+
create(body: CreateBody$h, options?: ResourceRequestOptions): Promise<DataResponse<Order$1>>;
|
|
17150
|
+
update(id: string, body: UpdateBody$h): Promise<DataResponse<Order$1>>;
|
|
16442
17151
|
listFulfillmentOrders(orderId: string): Promise<DataResponse<FulfillmentOrder$1[]>>;
|
|
16443
17152
|
/**
|
|
16444
17153
|
* Returns the API path for downloading the invoice PDF for an order.
|
|
@@ -16452,34 +17161,34 @@ declare class OrdersResource {
|
|
|
16452
17161
|
}
|
|
16453
17162
|
|
|
16454
17163
|
type Fulfillment = components['schemas']['Fulfillment'];
|
|
16455
|
-
type CreateBody$
|
|
16456
|
-
type UpdateBody$
|
|
17164
|
+
type CreateBody$g = NonNullable<operations['createFulfillment']['requestBody']>['content']['application/json'];
|
|
17165
|
+
type UpdateBody$g = NonNullable<operations['updateFulfillment']['requestBody']>['content']['application/json'];
|
|
16457
17166
|
type CancelBody = NonNullable<operations['cancelFulfillment']['requestBody']>['content']['application/json'];
|
|
16458
17167
|
declare class FulfillmentsResource {
|
|
16459
17168
|
private client;
|
|
16460
17169
|
constructor(client: Hydra);
|
|
16461
17170
|
/** Create a fulfillment for a fulfillment order */
|
|
16462
|
-
create(fulfillmentOrderId: string, body: CreateBody$
|
|
16463
|
-
update(id: string, body: UpdateBody$
|
|
17171
|
+
create(fulfillmentOrderId: string, body: CreateBody$g, options?: ResourceRequestOptions): Promise<DataResponse<Fulfillment>>;
|
|
17172
|
+
update(id: string, body: UpdateBody$g): Promise<DataResponse<Fulfillment>>;
|
|
16464
17173
|
cancel(id: string, body?: CancelBody): Promise<DataResponse<Fulfillment>>;
|
|
16465
17174
|
}
|
|
16466
17175
|
|
|
16467
17176
|
type Refund = components['schemas']['Refund'];
|
|
16468
|
-
type ListParams$
|
|
16469
|
-
type CreateBody$
|
|
17177
|
+
type ListParams$l = NonNullable<operations['listRefunds']['parameters']['query']>;
|
|
17178
|
+
type CreateBody$f = NonNullable<operations['createOrderRefund']['requestBody']>['content']['application/json'];
|
|
16470
17179
|
declare class RefundsResource {
|
|
16471
17180
|
private client;
|
|
16472
17181
|
constructor(client: Hydra);
|
|
16473
|
-
list(params?: ListParams$
|
|
16474
|
-
iterate(params?: Omit<ListParams$
|
|
16475
|
-
toArray(params?: Omit<ListParams$
|
|
17182
|
+
list(params?: ListParams$l): Promise<ListResponse<Refund>>;
|
|
17183
|
+
iterate(params?: Omit<ListParams$l, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Refund, void, undefined>;
|
|
17184
|
+
toArray(params?: Omit<ListParams$l, 'cursor'>, options?: PaginateOptions & {
|
|
16476
17185
|
limit?: number;
|
|
16477
17186
|
}): Promise<Refund[]>;
|
|
16478
17187
|
get(id: string, params?: {
|
|
16479
17188
|
expand?: string;
|
|
16480
17189
|
fields?: string;
|
|
16481
17190
|
}): Promise<DataResponse<Refund>>;
|
|
16482
|
-
create(orderId: string, body: CreateBody$
|
|
17191
|
+
create(orderId: string, body: CreateBody$f, options?: ResourceRequestOptions): Promise<DataResponse<Refund>>;
|
|
16483
17192
|
listByOrder(orderId: string): Promise<DataResponse<Refund[]>>;
|
|
16484
17193
|
retry(id: string): Promise<DataResponse<Refund>>;
|
|
16485
17194
|
/**
|
|
@@ -16490,24 +17199,24 @@ declare class RefundsResource {
|
|
|
16490
17199
|
}
|
|
16491
17200
|
|
|
16492
17201
|
type Return = components['schemas']['Return'];
|
|
16493
|
-
type ListParams$
|
|
16494
|
-
type CreateBody$
|
|
17202
|
+
type ListParams$k = NonNullable<operations['listReturns']['parameters']['query']>;
|
|
17203
|
+
type CreateBody$e = NonNullable<operations['createOrderReturn']['requestBody']>['content']['application/json'];
|
|
16495
17204
|
type ApproveBody = NonNullable<operations['approveReturn']['requestBody']>['content']['application/json'];
|
|
16496
17205
|
type ReceiveBody$1 = NonNullable<operations['receiveReturn']['requestBody']>['content']['application/json'];
|
|
16497
17206
|
type RejectBody = NonNullable<operations['rejectReturn']['requestBody']>['content']['application/json'];
|
|
16498
17207
|
declare class ReturnsResource {
|
|
16499
17208
|
private client;
|
|
16500
17209
|
constructor(client: Hydra);
|
|
16501
|
-
list(params?: ListParams$
|
|
16502
|
-
iterate(params?: Omit<ListParams$
|
|
16503
|
-
toArray(params?: Omit<ListParams$
|
|
17210
|
+
list(params?: ListParams$k): Promise<ListResponse<Return>>;
|
|
17211
|
+
iterate(params?: Omit<ListParams$k, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Return, void, undefined>;
|
|
17212
|
+
toArray(params?: Omit<ListParams$k, 'cursor'>, options?: PaginateOptions & {
|
|
16504
17213
|
limit?: number;
|
|
16505
17214
|
}): Promise<Return[]>;
|
|
16506
17215
|
get(id: string, params?: {
|
|
16507
17216
|
expand?: string;
|
|
16508
17217
|
fields?: string;
|
|
16509
17218
|
}): Promise<DataResponse<Return>>;
|
|
16510
|
-
create(orderId: string, body: CreateBody$
|
|
17219
|
+
create(orderId: string, body: CreateBody$e, options?: ResourceRequestOptions): Promise<DataResponse<Return>>;
|
|
16511
17220
|
listByOrder(orderId: string): Promise<DataResponse<Return[]>>;
|
|
16512
17221
|
approve(id: string, body?: ApproveBody): Promise<DataResponse<Return>>;
|
|
16513
17222
|
receive(id: string, body?: ReceiveBody$1): Promise<DataResponse<Return>>;
|
|
@@ -16519,17 +17228,17 @@ declare class ReturnsResource {
|
|
|
16519
17228
|
type DraftOrder = components['schemas']['DraftOrder'];
|
|
16520
17229
|
type DraftOrderLineItem = components['schemas']['DraftOrderLineItem'];
|
|
16521
17230
|
type Order = components['schemas']['Order'];
|
|
16522
|
-
type ListParams$
|
|
16523
|
-
type CreateBody$
|
|
16524
|
-
type UpdateBody$
|
|
17231
|
+
type ListParams$j = NonNullable<operations['listDraftOrders']['parameters']['query']>;
|
|
17232
|
+
type CreateBody$d = NonNullable<operations['createDraftOrder']['requestBody']>['content']['application/json'];
|
|
17233
|
+
type UpdateBody$f = NonNullable<operations['updateDraftOrder']['requestBody']>['content']['application/json'];
|
|
16525
17234
|
type AddItemsBody = NonNullable<operations['addDraftOrderItems']['requestBody']>['content']['application/json'];
|
|
16526
17235
|
type UpdateItemBody$2 = NonNullable<operations['updateDraftOrderItem']['requestBody']>['content']['application/json'];
|
|
16527
17236
|
declare class DraftOrdersResource {
|
|
16528
17237
|
private client;
|
|
16529
17238
|
constructor(client: Hydra);
|
|
16530
|
-
list(params?: ListParams$
|
|
16531
|
-
iterate(params?: Omit<ListParams$
|
|
16532
|
-
toArray(params?: Omit<ListParams$
|
|
17239
|
+
list(params?: ListParams$j): Promise<ListResponse<DraftOrder>>;
|
|
17240
|
+
iterate(params?: Omit<ListParams$j, 'cursor'>, options?: PaginateOptions): AsyncGenerator<DraftOrder, void, undefined>;
|
|
17241
|
+
toArray(params?: Omit<ListParams$j, 'cursor'>, options?: PaginateOptions & {
|
|
16533
17242
|
limit?: number;
|
|
16534
17243
|
}): Promise<DraftOrder[]>;
|
|
16535
17244
|
get(id: string, params?: {
|
|
@@ -16537,8 +17246,8 @@ declare class DraftOrdersResource {
|
|
|
16537
17246
|
currency?: string;
|
|
16538
17247
|
fields?: string;
|
|
16539
17248
|
}): Promise<DataResponse<DraftOrder>>;
|
|
16540
|
-
create(body: CreateBody$
|
|
16541
|
-
update(id: string, body: UpdateBody$
|
|
17249
|
+
create(body: CreateBody$d, options?: ResourceRequestOptions): Promise<DataResponse<DraftOrder>>;
|
|
17250
|
+
update(id: string, body: UpdateBody$f): Promise<DataResponse<DraftOrder>>;
|
|
16542
17251
|
delete(id: string): Promise<void>;
|
|
16543
17252
|
addItems(draftOrderId: string, body: AddItemsBody): Promise<DataResponse<DraftOrderLineItem[]>>;
|
|
16544
17253
|
updateItem(draftOrderId: string, itemId: string, body: UpdateItemBody$2): Promise<DataResponse<DraftOrderLineItem>>;
|
|
@@ -16553,22 +17262,22 @@ declare class DraftOrdersResource {
|
|
|
16553
17262
|
}
|
|
16554
17263
|
|
|
16555
17264
|
type Customer = components['schemas']['Customer'];
|
|
16556
|
-
type ListParams$
|
|
16557
|
-
type CreateBody$
|
|
16558
|
-
type UpdateBody$
|
|
17265
|
+
type ListParams$i = NonNullable<operations['listCustomers']['parameters']['query']>;
|
|
17266
|
+
type CreateBody$c = NonNullable<operations['createCustomer']['requestBody']>['content']['application/json'];
|
|
17267
|
+
type UpdateBody$e = NonNullable<operations['updateCustomer']['requestBody']>['content']['application/json'];
|
|
16559
17268
|
type CreateAddressBody$1 = NonNullable<operations['createCustomerAddress']['requestBody']>['content']['application/json'];
|
|
16560
17269
|
type CreateNoteBody$1 = NonNullable<operations['createCustomerNote']['requestBody']>['content']['application/json'];
|
|
16561
17270
|
declare class CustomersResource {
|
|
16562
17271
|
private client;
|
|
16563
17272
|
constructor(client: Hydra);
|
|
16564
|
-
list(params?: ListParams$
|
|
16565
|
-
iterate(params?: Omit<ListParams$
|
|
16566
|
-
toArray(params?: Omit<ListParams$
|
|
17273
|
+
list(params?: ListParams$i): Promise<ListResponse<Customer>>;
|
|
17274
|
+
iterate(params?: Omit<ListParams$i, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Customer, void, undefined>;
|
|
17275
|
+
toArray(params?: Omit<ListParams$i, 'cursor'>, options?: PaginateOptions & {
|
|
16567
17276
|
limit?: number;
|
|
16568
17277
|
}): Promise<Customer[]>;
|
|
16569
|
-
get(id: string, params?: Pick<ListParams$
|
|
16570
|
-
create(body: CreateBody$
|
|
16571
|
-
update(id: string, body: UpdateBody$
|
|
17278
|
+
get(id: string, params?: Pick<ListParams$i, 'expand' | 'fields'>): Promise<DataResponse<Customer>>;
|
|
17279
|
+
create(body: CreateBody$c, options?: ResourceRequestOptions): Promise<DataResponse<Customer>>;
|
|
17280
|
+
update(id: string, body: UpdateBody$e): Promise<DataResponse<Customer>>;
|
|
16572
17281
|
delete(id: string): Promise<void>;
|
|
16573
17282
|
listAddresses(customerId: string): Promise<DataResponse<unknown[]>>;
|
|
16574
17283
|
createAddress(customerId: string, body: CreateAddressBody$1): Promise<DataResponse<unknown>>;
|
|
@@ -16582,38 +17291,38 @@ declare class CustomersResource {
|
|
|
16582
17291
|
}
|
|
16583
17292
|
|
|
16584
17293
|
type CustomerGroup = components['schemas']['CustomerGroup'];
|
|
16585
|
-
type ListParams$
|
|
16586
|
-
type CreateBody$
|
|
16587
|
-
type UpdateBody$
|
|
17294
|
+
type ListParams$h = NonNullable<operations['listCustomerGroups']['parameters']['query']>;
|
|
17295
|
+
type CreateBody$b = NonNullable<operations['createCustomerGroup']['requestBody']>['content']['application/json'];
|
|
17296
|
+
type UpdateBody$d = NonNullable<operations['updateCustomerGroup']['requestBody']>['content']['application/json'];
|
|
16588
17297
|
type AddMembersBody = NonNullable<operations['addCustomerGroupMembers']['requestBody']>['content']['application/json'];
|
|
16589
17298
|
declare class CustomerGroupsResource {
|
|
16590
17299
|
private client;
|
|
16591
17300
|
constructor(client: Hydra);
|
|
16592
|
-
list(params?: ListParams$
|
|
16593
|
-
iterate(params?: Omit<ListParams$
|
|
16594
|
-
toArray(params?: Omit<ListParams$
|
|
17301
|
+
list(params?: ListParams$h): Promise<ListResponse<CustomerGroup>>;
|
|
17302
|
+
iterate(params?: Omit<ListParams$h, 'cursor'>, options?: PaginateOptions): AsyncGenerator<CustomerGroup, void, undefined>;
|
|
17303
|
+
toArray(params?: Omit<ListParams$h, 'cursor'>, options?: PaginateOptions & {
|
|
16595
17304
|
limit?: number;
|
|
16596
17305
|
}): Promise<CustomerGroup[]>;
|
|
16597
17306
|
get(id: string): Promise<DataResponse<CustomerGroup>>;
|
|
16598
|
-
create(body: CreateBody$
|
|
16599
|
-
update(id: string, body: UpdateBody$
|
|
17307
|
+
create(body: CreateBody$b, options?: ResourceRequestOptions): Promise<DataResponse<CustomerGroup>>;
|
|
17308
|
+
update(id: string, body: UpdateBody$d): Promise<DataResponse<CustomerGroup>>;
|
|
16600
17309
|
delete(id: string): Promise<void>;
|
|
16601
17310
|
addMembers(groupId: string, body: AddMembersBody): Promise<void>;
|
|
16602
17311
|
removeMember(groupId: string, customerId: string): Promise<void>;
|
|
16603
17312
|
}
|
|
16604
17313
|
|
|
16605
|
-
type UpdateBody$
|
|
17314
|
+
type UpdateBody$c = NonNullable<operations['updateAddress']['requestBody']>['content']['application/json'];
|
|
16606
17315
|
declare class AddressesResource {
|
|
16607
17316
|
private client;
|
|
16608
17317
|
constructor(client: Hydra);
|
|
16609
|
-
update(id: string, body: UpdateBody$
|
|
17318
|
+
update(id: string, body: UpdateBody$c): Promise<DataResponse<unknown>>;
|
|
16610
17319
|
delete(id: string): Promise<void>;
|
|
16611
17320
|
}
|
|
16612
17321
|
|
|
16613
17322
|
type InventoryLevel = components['schemas']['InventoryLevel'];
|
|
16614
17323
|
type InventoryAdjustment = components['schemas']['InventoryAdjustment'];
|
|
16615
17324
|
type ProductAdjustment = components['schemas']['ProductAdjustment'];
|
|
16616
|
-
type ListParams$
|
|
17325
|
+
type ListParams$g = NonNullable<operations['listInventory']['parameters']['query']>;
|
|
16617
17326
|
type SetBody = NonNullable<operations['setInventory']['requestBody']>['content']['application/json'];
|
|
16618
17327
|
type AdjustBody = NonNullable<operations['adjustInventory']['requestBody']>['content']['application/json'];
|
|
16619
17328
|
type InventoryResult = InventoryLevel & {
|
|
@@ -16622,9 +17331,9 @@ type InventoryResult = InventoryLevel & {
|
|
|
16622
17331
|
declare class InventoryResource {
|
|
16623
17332
|
private client;
|
|
16624
17333
|
constructor(client: Hydra);
|
|
16625
|
-
list(params?: ListParams$
|
|
16626
|
-
iterate(params?: Omit<ListParams$
|
|
16627
|
-
toArray(params?: Omit<ListParams$
|
|
17334
|
+
list(params?: ListParams$g): Promise<ListResponse<InventoryLevel>>;
|
|
17335
|
+
iterate(params?: Omit<ListParams$g, 'cursor'>, options?: PaginateOptions): AsyncGenerator<InventoryLevel, void, undefined>;
|
|
17336
|
+
toArray(params?: Omit<ListParams$g, 'cursor'>, options?: PaginateOptions & {
|
|
16628
17337
|
limit?: number;
|
|
16629
17338
|
}): Promise<InventoryLevel[]>;
|
|
16630
17339
|
listAdjustments(params: {
|
|
@@ -16696,90 +17405,90 @@ declare class ShippingResource {
|
|
|
16696
17405
|
}
|
|
16697
17406
|
|
|
16698
17407
|
type Promotion = components['schemas']['Promotion'];
|
|
16699
|
-
type ListParams$
|
|
16700
|
-
type CreateBody$
|
|
16701
|
-
type UpdateBody$
|
|
17408
|
+
type ListParams$f = NonNullable<operations['listPromotions']['parameters']['query']>;
|
|
17409
|
+
type CreateBody$a = NonNullable<operations['createPromotion']['requestBody']>['content']['application/json'];
|
|
17410
|
+
type UpdateBody$b = NonNullable<operations['updatePromotion']['requestBody']>['content']['application/json'];
|
|
16702
17411
|
declare class PromotionsResource {
|
|
16703
17412
|
private client;
|
|
16704
17413
|
constructor(client: Hydra);
|
|
16705
|
-
list(params?: ListParams$
|
|
16706
|
-
iterate(params?: Omit<ListParams$
|
|
16707
|
-
toArray(params?: Omit<ListParams$
|
|
17414
|
+
list(params?: ListParams$f): Promise<ListResponse<Promotion>>;
|
|
17415
|
+
iterate(params?: Omit<ListParams$f, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Promotion, void, undefined>;
|
|
17416
|
+
toArray(params?: Omit<ListParams$f, 'cursor'>, options?: PaginateOptions & {
|
|
16708
17417
|
limit?: number;
|
|
16709
17418
|
}): Promise<Promotion[]>;
|
|
16710
17419
|
get(id: string): Promise<DataResponse<Promotion>>;
|
|
16711
|
-
create(body: CreateBody$
|
|
16712
|
-
update(id: string, body: UpdateBody$
|
|
17420
|
+
create(body: CreateBody$a, options?: ResourceRequestOptions): Promise<DataResponse<Promotion>>;
|
|
17421
|
+
update(id: string, body: UpdateBody$b): Promise<DataResponse<Promotion>>;
|
|
16713
17422
|
delete(id: string): Promise<void>;
|
|
16714
17423
|
}
|
|
16715
17424
|
|
|
16716
17425
|
type Discount = components['schemas']['Discount'];
|
|
16717
|
-
type ListParams$
|
|
16718
|
-
type CreateBody$
|
|
16719
|
-
type UpdateBody$
|
|
17426
|
+
type ListParams$e = NonNullable<operations['listDiscounts']['parameters']['query']>;
|
|
17427
|
+
type CreateBody$9 = NonNullable<operations['createDiscount']['requestBody']>['content']['application/json'];
|
|
17428
|
+
type UpdateBody$a = NonNullable<operations['updateDiscount']['requestBody']>['content']['application/json'];
|
|
16720
17429
|
declare class DiscountsResource {
|
|
16721
17430
|
private client;
|
|
16722
17431
|
constructor(client: Hydra);
|
|
16723
|
-
list(params?: ListParams$
|
|
16724
|
-
iterate(params?: Omit<ListParams$
|
|
16725
|
-
toArray(params?: Omit<ListParams$
|
|
17432
|
+
list(params?: ListParams$e): Promise<ListResponse<Discount>>;
|
|
17433
|
+
iterate(params?: Omit<ListParams$e, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Discount, void, undefined>;
|
|
17434
|
+
toArray(params?: Omit<ListParams$e, 'cursor'>, options?: PaginateOptions & {
|
|
16726
17435
|
limit?: number;
|
|
16727
17436
|
}): Promise<Discount[]>;
|
|
16728
17437
|
get(id: string): Promise<DataResponse<Discount>>;
|
|
16729
|
-
create(body: CreateBody$
|
|
16730
|
-
update(id: string, body: UpdateBody$
|
|
17438
|
+
create(body: CreateBody$9, options?: ResourceRequestOptions): Promise<DataResponse<Discount>>;
|
|
17439
|
+
update(id: string, body: UpdateBody$a): Promise<DataResponse<Discount>>;
|
|
16731
17440
|
delete(id: string): Promise<void>;
|
|
16732
17441
|
}
|
|
16733
17442
|
|
|
16734
17443
|
type Image = components['schemas']['Image'];
|
|
16735
|
-
type ListParams$
|
|
16736
|
-
type UpdateBody$
|
|
16737
|
-
type ReorderBody$
|
|
17444
|
+
type ListParams$d = NonNullable<operations['listImages']['parameters']['query']>;
|
|
17445
|
+
type UpdateBody$9 = NonNullable<operations['updateImage']['requestBody']>['content']['application/json'];
|
|
17446
|
+
type ReorderBody$2 = NonNullable<operations['reorderImages']['requestBody']>['content']['application/json'];
|
|
16738
17447
|
declare class ImagesResource {
|
|
16739
17448
|
private client;
|
|
16740
17449
|
constructor(client: Hydra);
|
|
16741
|
-
list(params?: ListParams$
|
|
16742
|
-
iterate(params?: Omit<ListParams$
|
|
16743
|
-
toArray(params?: Omit<ListParams$
|
|
17450
|
+
list(params?: ListParams$d): Promise<ListResponse<Image>>;
|
|
17451
|
+
iterate(params?: Omit<ListParams$d, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Image, void, undefined>;
|
|
17452
|
+
toArray(params?: Omit<ListParams$d, 'cursor'>, options?: PaginateOptions & {
|
|
16744
17453
|
limit?: number;
|
|
16745
17454
|
}): Promise<Image[]>;
|
|
16746
17455
|
/** Upload an image to the store library */
|
|
16747
17456
|
upload(formData: FormData): Promise<DataResponse<Image>>;
|
|
16748
|
-
update(id: string, body: UpdateBody$
|
|
17457
|
+
update(id: string, body: UpdateBody$9): Promise<DataResponse<Image>>;
|
|
16749
17458
|
delete(id: string): Promise<void>;
|
|
16750
17459
|
detach(id: string): Promise<void>;
|
|
16751
17460
|
batchDelete(imageIds: string[]): Promise<void>;
|
|
16752
17461
|
batchDetach(imageIds: string[]): Promise<void>;
|
|
16753
|
-
reorder(body: ReorderBody$
|
|
17462
|
+
reorder(body: ReorderBody$2): Promise<void>;
|
|
16754
17463
|
}
|
|
16755
17464
|
|
|
16756
17465
|
type Webhook = components['schemas']['Webhook'];
|
|
16757
|
-
type ListParams$
|
|
16758
|
-
type CreateBody$
|
|
16759
|
-
type UpdateBody$
|
|
17466
|
+
type ListParams$c = NonNullable<operations['listWebhooks']['parameters']['query']>;
|
|
17467
|
+
type CreateBody$8 = NonNullable<operations['createWebhook']['requestBody']>['content']['application/json'];
|
|
17468
|
+
type UpdateBody$8 = NonNullable<operations['updateWebhook']['requestBody']>['content']['application/json'];
|
|
16760
17469
|
declare class WebhooksResource {
|
|
16761
17470
|
private client;
|
|
16762
17471
|
constructor(client: Hydra);
|
|
16763
|
-
list(params?: ListParams$
|
|
16764
|
-
iterate(params?: Omit<ListParams$
|
|
16765
|
-
toArray(params?: Omit<ListParams$
|
|
17472
|
+
list(params?: ListParams$c): Promise<ListResponse<Webhook>>;
|
|
17473
|
+
iterate(params?: Omit<ListParams$c, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Webhook, void, undefined>;
|
|
17474
|
+
toArray(params?: Omit<ListParams$c, 'cursor'>, options?: PaginateOptions & {
|
|
16766
17475
|
limit?: number;
|
|
16767
17476
|
}): Promise<Webhook[]>;
|
|
16768
17477
|
get(id: string): Promise<DataResponse<Webhook>>;
|
|
16769
|
-
create(body: CreateBody$
|
|
16770
|
-
update(id: string, body: UpdateBody$
|
|
17478
|
+
create(body: CreateBody$8, options?: ResourceRequestOptions): Promise<DataResponse<Webhook>>;
|
|
17479
|
+
update(id: string, body: UpdateBody$8): Promise<DataResponse<Webhook>>;
|
|
16771
17480
|
delete(id: string): Promise<void>;
|
|
16772
17481
|
}
|
|
16773
17482
|
|
|
16774
17483
|
type Store = components['schemas']['Store'];
|
|
16775
|
-
type UpdateBody$
|
|
17484
|
+
type UpdateBody$7 = NonNullable<operations['updateStore']['requestBody']>['content']['application/json'];
|
|
16776
17485
|
declare class StoreResource {
|
|
16777
17486
|
private client;
|
|
16778
17487
|
constructor(client: Hydra);
|
|
16779
17488
|
get(params?: {
|
|
16780
17489
|
fields?: string;
|
|
16781
17490
|
}): Promise<DataResponse<Store>>;
|
|
16782
|
-
update(body: UpdateBody$
|
|
17491
|
+
update(body: UpdateBody$7): Promise<DataResponse<Store>>;
|
|
16783
17492
|
getDomainRecord(): Promise<DataResponse<unknown>>;
|
|
16784
17493
|
verifyDomain(): Promise<DataResponse<unknown>>;
|
|
16785
17494
|
publish(): Promise<DataResponse<{
|
|
@@ -16791,42 +17500,42 @@ declare class StoreResource {
|
|
|
16791
17500
|
}
|
|
16792
17501
|
|
|
16793
17502
|
type Tag = components['schemas']['Tag'];
|
|
16794
|
-
type ListParams$
|
|
16795
|
-
type CreateBody$
|
|
16796
|
-
type UpdateBody$
|
|
17503
|
+
type ListParams$b = NonNullable<operations['listTags']['parameters']['query']>;
|
|
17504
|
+
type CreateBody$7 = NonNullable<operations['createTag']['requestBody']>['content']['application/json'];
|
|
17505
|
+
type UpdateBody$6 = NonNullable<operations['updateTag']['requestBody']>['content']['application/json'];
|
|
16797
17506
|
declare class TagsResource {
|
|
16798
17507
|
private client;
|
|
16799
17508
|
constructor(client: Hydra);
|
|
16800
|
-
list(params?: ListParams$
|
|
16801
|
-
iterate(params?: Omit<ListParams$
|
|
16802
|
-
toArray(params?: Omit<ListParams$
|
|
17509
|
+
list(params?: ListParams$b): Promise<ListResponse<Tag>>;
|
|
17510
|
+
iterate(params?: Omit<ListParams$b, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Tag, void, undefined>;
|
|
17511
|
+
toArray(params?: Omit<ListParams$b, 'cursor'>, options?: PaginateOptions & {
|
|
16803
17512
|
limit?: number;
|
|
16804
17513
|
}): Promise<Tag[]>;
|
|
16805
|
-
create(body: CreateBody$
|
|
16806
|
-
update(id: string, body: UpdateBody$
|
|
17514
|
+
create(body: CreateBody$7, options?: ResourceRequestOptions): Promise<DataResponse<Tag>>;
|
|
17515
|
+
update(id: string, body: UpdateBody$6): Promise<DataResponse<Tag>>;
|
|
16807
17516
|
delete(id: string): Promise<void>;
|
|
16808
17517
|
}
|
|
16809
17518
|
|
|
16810
17519
|
type Redirect = components['schemas']['Redirect'];
|
|
16811
|
-
type ListParams$
|
|
16812
|
-
type CreateBody$
|
|
17520
|
+
type ListParams$a = NonNullable<operations['listRedirects']['parameters']['query']>;
|
|
17521
|
+
type CreateBody$6 = NonNullable<operations['createRedirect']['requestBody']>['content']['application/json'];
|
|
16813
17522
|
declare class RedirectsResource {
|
|
16814
17523
|
private client;
|
|
16815
17524
|
constructor(client: Hydra);
|
|
16816
|
-
list(params?: ListParams$
|
|
16817
|
-
iterate(params?: Omit<ListParams$
|
|
16818
|
-
toArray(params?: Omit<ListParams$
|
|
17525
|
+
list(params?: ListParams$a): Promise<ListResponse<Redirect>>;
|
|
17526
|
+
iterate(params?: Omit<ListParams$a, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Redirect, void, undefined>;
|
|
17527
|
+
toArray(params?: Omit<ListParams$a, 'cursor'>, options?: PaginateOptions & {
|
|
16819
17528
|
limit?: number;
|
|
16820
17529
|
}): Promise<Redirect[]>;
|
|
16821
|
-
create(body: CreateBody$
|
|
17530
|
+
create(body: CreateBody$6, options?: ResourceRequestOptions): Promise<DataResponse<Redirect>>;
|
|
16822
17531
|
lookup(path: string): Promise<DataResponse<Redirect>>;
|
|
16823
17532
|
delete(id: string): Promise<void>;
|
|
16824
17533
|
}
|
|
16825
17534
|
|
|
16826
17535
|
type Company = components['schemas']['Company'];
|
|
16827
|
-
type ListParams$
|
|
16828
|
-
type CreateBody$
|
|
16829
|
-
type UpdateBody$
|
|
17536
|
+
type ListParams$9 = NonNullable<operations['listCompanies']['parameters']['query']>;
|
|
17537
|
+
type CreateBody$5 = NonNullable<operations['createCompany']['requestBody']>['content']['application/json'];
|
|
17538
|
+
type UpdateBody$5 = NonNullable<operations['updateCompany']['requestBody']>['content']['application/json'];
|
|
16830
17539
|
type CreateAddressBody = NonNullable<operations['createCompanyAddress']['requestBody']>['content']['application/json'];
|
|
16831
17540
|
type UpdateAddressBody = NonNullable<operations['updateCompanyAddress']['requestBody']>['content']['application/json'];
|
|
16832
17541
|
type CreateContactBody = NonNullable<operations['createCompanyContact']['requestBody']>['content']['application/json'];
|
|
@@ -16835,14 +17544,14 @@ type CreateNoteBody = NonNullable<operations['createCompanyNote']['requestBody']
|
|
|
16835
17544
|
declare class CompaniesResource {
|
|
16836
17545
|
private client;
|
|
16837
17546
|
constructor(client: Hydra);
|
|
16838
|
-
list(params?: ListParams$
|
|
16839
|
-
iterate(params?: Omit<ListParams$
|
|
16840
|
-
toArray(params?: Omit<ListParams$
|
|
17547
|
+
list(params?: ListParams$9): Promise<ListResponse<Company>>;
|
|
17548
|
+
iterate(params?: Omit<ListParams$9, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Company, void, undefined>;
|
|
17549
|
+
toArray(params?: Omit<ListParams$9, 'cursor'>, options?: PaginateOptions & {
|
|
16841
17550
|
limit?: number;
|
|
16842
17551
|
}): Promise<Company[]>;
|
|
16843
|
-
get(id: string, params?: Pick<ListParams$
|
|
16844
|
-
create(body: CreateBody$
|
|
16845
|
-
update(id: string, body: UpdateBody$
|
|
17552
|
+
get(id: string, params?: Pick<ListParams$9, 'expand' | 'fields'>): Promise<DataResponse<Company>>;
|
|
17553
|
+
create(body: CreateBody$5, options?: ResourceRequestOptions): Promise<DataResponse<Company>>;
|
|
17554
|
+
update(id: string, body: UpdateBody$5): Promise<DataResponse<Company>>;
|
|
16846
17555
|
delete(id: string): Promise<void>;
|
|
16847
17556
|
listAddresses(companyId: string): Promise<DataResponse<unknown[]>>;
|
|
16848
17557
|
createAddress(companyId: string, body: CreateAddressBody): Promise<DataResponse<unknown>>;
|
|
@@ -16858,23 +17567,23 @@ declare class CompaniesResource {
|
|
|
16858
17567
|
}
|
|
16859
17568
|
|
|
16860
17569
|
type PurchaseOrder = components['schemas']['PurchaseOrder'];
|
|
16861
|
-
type ListParams$
|
|
16862
|
-
type CreateBody$
|
|
16863
|
-
type UpdateBody$
|
|
17570
|
+
type ListParams$8 = NonNullable<operations['listPurchaseOrders']['parameters']['query']>;
|
|
17571
|
+
type CreateBody$4 = NonNullable<operations['createPurchaseOrder']['requestBody']>['content']['application/json'];
|
|
17572
|
+
type UpdateBody$4 = NonNullable<operations['updatePurchaseOrder']['requestBody']>['content']['application/json'];
|
|
16864
17573
|
type AddItemBody = NonNullable<operations['addPurchaseOrderItems']['requestBody']>['content']['application/json'];
|
|
16865
17574
|
type UpdateItemBody$1 = NonNullable<operations['updatePurchaseOrderItem']['requestBody']>['content']['application/json'];
|
|
16866
17575
|
type ReceiveBody = NonNullable<operations['receivePurchaseOrderItems']['requestBody']>['content']['application/json'];
|
|
16867
17576
|
declare class PurchaseOrdersResource {
|
|
16868
17577
|
private client;
|
|
16869
17578
|
constructor(client: Hydra);
|
|
16870
|
-
list(params?: ListParams$
|
|
16871
|
-
iterate(params?: Omit<ListParams$
|
|
16872
|
-
toArray(params?: Omit<ListParams$
|
|
17579
|
+
list(params?: ListParams$8): Promise<ListResponse<PurchaseOrder>>;
|
|
17580
|
+
iterate(params?: Omit<ListParams$8, 'cursor'>, options?: PaginateOptions): AsyncGenerator<PurchaseOrder, void, undefined>;
|
|
17581
|
+
toArray(params?: Omit<ListParams$8, 'cursor'>, options?: PaginateOptions & {
|
|
16873
17582
|
limit?: number;
|
|
16874
17583
|
}): Promise<PurchaseOrder[]>;
|
|
16875
|
-
get(id: string, params?: Pick<ListParams$
|
|
16876
|
-
create(body: CreateBody$
|
|
16877
|
-
update(id: string, body: UpdateBody$
|
|
17584
|
+
get(id: string, params?: Pick<ListParams$8, 'expand' | 'fields'>): Promise<DataResponse<PurchaseOrder>>;
|
|
17585
|
+
create(body: CreateBody$4, options?: ResourceRequestOptions): Promise<DataResponse<PurchaseOrder>>;
|
|
17586
|
+
update(id: string, body: UpdateBody$4): Promise<DataResponse<PurchaseOrder>>;
|
|
16878
17587
|
delete(id: string): Promise<void>;
|
|
16879
17588
|
addItem(purchaseOrderId: string, body: AddItemBody): Promise<DataResponse<unknown>>;
|
|
16880
17589
|
updateItem(purchaseOrderId: string, itemId: string, body: UpdateItemBody$1): Promise<DataResponse<unknown>>;
|
|
@@ -16897,19 +17606,19 @@ declare class FulfillmentOrdersResource {
|
|
|
16897
17606
|
listForOrder(orderId: string): Promise<DataResponse<FulfillmentOrder[]>>;
|
|
16898
17607
|
}
|
|
16899
17608
|
|
|
16900
|
-
type ListParams$
|
|
16901
|
-
type CreateBody$
|
|
16902
|
-
type UpdateBody$
|
|
16903
|
-
type ReorderBody = NonNullable<operations['reorderMetafieldDefinitions']['requestBody']>['content']['application/json'];
|
|
17609
|
+
type ListParams$7 = NonNullable<operations['listMetafieldDefinitions']['parameters']['query']>;
|
|
17610
|
+
type CreateBody$3 = NonNullable<operations['createMetafieldDefinition']['requestBody']>['content']['application/json'];
|
|
17611
|
+
type UpdateBody$3 = NonNullable<operations['updateMetafieldDefinition']['requestBody']>['content']['application/json'];
|
|
17612
|
+
type ReorderBody$1 = NonNullable<operations['reorderMetafieldDefinitions']['requestBody']>['content']['application/json'];
|
|
16904
17613
|
declare class MetafieldsResource {
|
|
16905
17614
|
private client;
|
|
16906
17615
|
constructor(client: Hydra);
|
|
16907
17616
|
/** List metafield definitions for the store */
|
|
16908
|
-
listDefinitions(params?: ListParams$
|
|
16909
|
-
createDefinition(body: CreateBody$
|
|
16910
|
-
updateDefinition(ownerType: string, slug: string, body: UpdateBody$
|
|
17617
|
+
listDefinitions(params?: ListParams$7): Promise<DataResponse<unknown[]>>;
|
|
17618
|
+
createDefinition(body: CreateBody$3): Promise<DataResponse<unknown>>;
|
|
17619
|
+
updateDefinition(ownerType: string, slug: string, body: UpdateBody$3): Promise<DataResponse<unknown>>;
|
|
16911
17620
|
archiveDefinition(ownerType: string, slug: string): Promise<void>;
|
|
16912
|
-
reorderDefinitions(ownerType: string, body: ReorderBody): Promise<void>;
|
|
17621
|
+
reorderDefinitions(ownerType: string, body: ReorderBody$1): Promise<void>;
|
|
16913
17622
|
}
|
|
16914
17623
|
|
|
16915
17624
|
type TaxGroup = components['schemas']['TaxGroup'];
|
|
@@ -16953,14 +17662,35 @@ declare class TaxResource {
|
|
|
16953
17662
|
}
|
|
16954
17663
|
|
|
16955
17664
|
type ExchangeRate = components['schemas']['ExchangeRate'];
|
|
16956
|
-
type ListParams$
|
|
17665
|
+
type ListParams$6 = NonNullable<operations['listExchangeRates']['parameters']['query']>;
|
|
16957
17666
|
declare class ExchangeRatesResource {
|
|
16958
17667
|
private client;
|
|
16959
17668
|
constructor(client: Hydra);
|
|
16960
|
-
list(params?: ListParams$
|
|
17669
|
+
list(params?: ListParams$6): Promise<DataResponse<ExchangeRate[]>>;
|
|
16961
17670
|
refresh(): Promise<DataResponse<unknown>>;
|
|
16962
17671
|
}
|
|
16963
17672
|
|
|
17673
|
+
type FilterAttribute = components['schemas']['FilterAttribute'];
|
|
17674
|
+
type ListParams$5 = NonNullable<operations['listFilterAttributes']['parameters']['query']>;
|
|
17675
|
+
type CreateBody$2 = NonNullable<operations['createFilterAttribute']['requestBody']>['content']['application/json'];
|
|
17676
|
+
type UpdateBody$2 = NonNullable<operations['updateFilterAttribute']['requestBody']>['content']['application/json'];
|
|
17677
|
+
type ReorderBody = NonNullable<operations['reorderFilterAttributes']['requestBody']>['content']['application/json'];
|
|
17678
|
+
declare class FilterAttributesResource {
|
|
17679
|
+
private client;
|
|
17680
|
+
constructor(client: Hydra);
|
|
17681
|
+
list(params?: ListParams$5): Promise<ListResponse<FilterAttribute>>;
|
|
17682
|
+
iterate(params?: Omit<ListParams$5, 'cursor'>, options?: PaginateOptions): AsyncGenerator<FilterAttribute, void, undefined>;
|
|
17683
|
+
toArray(params?: Omit<ListParams$5, 'cursor'>, options?: PaginateOptions & {
|
|
17684
|
+
limit?: number;
|
|
17685
|
+
}): Promise<FilterAttribute[]>;
|
|
17686
|
+
get(id: string): Promise<DataResponse<FilterAttribute>>;
|
|
17687
|
+
create(body: CreateBody$2, options?: ResourceRequestOptions): Promise<DataResponse<FilterAttribute>>;
|
|
17688
|
+
update(id: string, body: UpdateBody$2): Promise<DataResponse<FilterAttribute>>;
|
|
17689
|
+
delete(id: string): Promise<void>;
|
|
17690
|
+
reorder(body: ReorderBody): Promise<ListResponse<FilterAttribute>>;
|
|
17691
|
+
discover(): Promise<DataResponse<unknown[]>>;
|
|
17692
|
+
}
|
|
17693
|
+
|
|
16964
17694
|
type NavigationMenu = components['schemas']['NavigationMenu'];
|
|
16965
17695
|
type NavigationItem = components['schemas']['NavigationItem'];
|
|
16966
17696
|
type ListParams$4 = NonNullable<operations['listNavigationMenus']['parameters']['query']>;
|
|
@@ -17210,6 +17940,7 @@ declare class Hydra {
|
|
|
17210
17940
|
readonly metafields: MetafieldsResource;
|
|
17211
17941
|
readonly tax: TaxResource;
|
|
17212
17942
|
readonly exchangeRates: ExchangeRatesResource;
|
|
17943
|
+
readonly filterAttributes: FilterAttributesResource;
|
|
17213
17944
|
readonly navigation: NavigationResource;
|
|
17214
17945
|
readonly notifications: NotificationsResource;
|
|
17215
17946
|
readonly analytics: AnalyticsResource;
|