@gethydra/sdk 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +1068 -351
- package/dist/index.js +36 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -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;
|
|
@@ -3382,6 +3495,20 @@ interface components {
|
|
|
3382
3495
|
/** @example If an account exists, a reset link has been sent. */
|
|
3383
3496
|
message: string;
|
|
3384
3497
|
};
|
|
3498
|
+
SubscribeCheckout: {
|
|
3499
|
+
/**
|
|
3500
|
+
* Format: uri
|
|
3501
|
+
* @example https://checkout.stripe.com/c/pay/cs_test_abc
|
|
3502
|
+
*/
|
|
3503
|
+
checkout_url: string;
|
|
3504
|
+
};
|
|
3505
|
+
MembershipPortal: {
|
|
3506
|
+
/**
|
|
3507
|
+
* Format: uri
|
|
3508
|
+
* @example https://billing.stripe.com/p/session/abc
|
|
3509
|
+
*/
|
|
3510
|
+
portal_url: string;
|
|
3511
|
+
};
|
|
3385
3512
|
AnalyticsSummary: {
|
|
3386
3513
|
period: {
|
|
3387
3514
|
/** @example 2026-08-01 */
|
|
@@ -4742,6 +4869,40 @@ interface operations {
|
|
|
4742
4869
|
};
|
|
4743
4870
|
};
|
|
4744
4871
|
};
|
|
4872
|
+
updateApiKeyName: {
|
|
4873
|
+
parameters: {
|
|
4874
|
+
query?: never;
|
|
4875
|
+
header?: never;
|
|
4876
|
+
path: {
|
|
4877
|
+
id: string;
|
|
4878
|
+
};
|
|
4879
|
+
cookie?: never;
|
|
4880
|
+
};
|
|
4881
|
+
requestBody?: {
|
|
4882
|
+
content: {
|
|
4883
|
+
"application/json": {
|
|
4884
|
+
/**
|
|
4885
|
+
* @description Display name for the key. Null to clear.
|
|
4886
|
+
* @example Storefront
|
|
4887
|
+
*/
|
|
4888
|
+
name: string | null;
|
|
4889
|
+
};
|
|
4890
|
+
};
|
|
4891
|
+
};
|
|
4892
|
+
responses: {
|
|
4893
|
+
/** @description Updated key metadata */
|
|
4894
|
+
200: {
|
|
4895
|
+
headers: {
|
|
4896
|
+
[name: string]: unknown;
|
|
4897
|
+
};
|
|
4898
|
+
content: {
|
|
4899
|
+
"application/json": {
|
|
4900
|
+
data: components["schemas"]["ApiKey"];
|
|
4901
|
+
};
|
|
4902
|
+
};
|
|
4903
|
+
};
|
|
4904
|
+
};
|
|
4905
|
+
};
|
|
4745
4906
|
updateApiKeyPermissions: {
|
|
4746
4907
|
parameters: {
|
|
4747
4908
|
query?: never;
|
|
@@ -6390,7 +6551,7 @@ interface operations {
|
|
|
6390
6551
|
low_stock_threshold?: number | null;
|
|
6391
6552
|
/** @example 1 */
|
|
6392
6553
|
qty_step?: number | null;
|
|
6393
|
-
/** @example
|
|
6554
|
+
/** @example 0.5 */
|
|
6394
6555
|
weight?: number;
|
|
6395
6556
|
/**
|
|
6396
6557
|
* @default g
|
|
@@ -6516,7 +6677,7 @@ interface operations {
|
|
|
6516
6677
|
content: {
|
|
6517
6678
|
"multipart/form-data": {
|
|
6518
6679
|
/** Format: binary */
|
|
6519
|
-
file
|
|
6680
|
+
file?: string;
|
|
6520
6681
|
lqip?: string;
|
|
6521
6682
|
};
|
|
6522
6683
|
};
|
|
@@ -6757,7 +6918,7 @@ interface operations {
|
|
|
6757
6918
|
low_stock_threshold?: number | null;
|
|
6758
6919
|
/** @example 1 */
|
|
6759
6920
|
qty_step?: number | null;
|
|
6760
|
-
/** @example
|
|
6921
|
+
/** @example 0.5 */
|
|
6761
6922
|
weight?: number | null;
|
|
6762
6923
|
/**
|
|
6763
6924
|
* @example g
|
|
@@ -7127,7 +7288,7 @@ interface operations {
|
|
|
7127
7288
|
content: {
|
|
7128
7289
|
"multipart/form-data": {
|
|
7129
7290
|
/** Format: binary */
|
|
7130
|
-
file
|
|
7291
|
+
file?: string;
|
|
7131
7292
|
lqip?: string;
|
|
7132
7293
|
};
|
|
7133
7294
|
};
|
|
@@ -11685,7 +11846,7 @@ interface operations {
|
|
|
11685
11846
|
/** @example USD */
|
|
11686
11847
|
currency: string;
|
|
11687
11848
|
items?: {
|
|
11688
|
-
/** @example
|
|
11849
|
+
/** @example 0.5 */
|
|
11689
11850
|
weight_grams: number;
|
|
11690
11851
|
/** @example 2 */
|
|
11691
11852
|
quantity: number;
|
|
@@ -11761,7 +11922,7 @@ interface operations {
|
|
|
11761
11922
|
* "order.paid"
|
|
11762
11923
|
* ]
|
|
11763
11924
|
*/
|
|
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")[];
|
|
11925
|
+
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
11926
|
/**
|
|
11766
11927
|
* @default active
|
|
11767
11928
|
* @example active
|
|
@@ -11855,7 +12016,7 @@ interface operations {
|
|
|
11855
12016
|
* "product.updated"
|
|
11856
12017
|
* ]
|
|
11857
12018
|
*/
|
|
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")[];
|
|
12019
|
+
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
12020
|
/**
|
|
11860
12021
|
* @example active
|
|
11861
12022
|
* @enum {string}
|
|
@@ -12110,13 +12271,13 @@ interface operations {
|
|
|
12110
12271
|
};
|
|
12111
12272
|
};
|
|
12112
12273
|
};
|
|
12113
|
-
|
|
12274
|
+
listFilterAttributes: {
|
|
12114
12275
|
parameters: {
|
|
12115
12276
|
query?: {
|
|
12116
12277
|
limit?: number;
|
|
12117
12278
|
cursor?: string;
|
|
12118
12279
|
fields?: string;
|
|
12119
|
-
sort?: "
|
|
12280
|
+
sort?: "position" | "created_at";
|
|
12120
12281
|
order?: "asc" | "desc";
|
|
12121
12282
|
};
|
|
12122
12283
|
header?: never;
|
|
@@ -12125,14 +12286,14 @@ interface operations {
|
|
|
12125
12286
|
};
|
|
12126
12287
|
requestBody?: never;
|
|
12127
12288
|
responses: {
|
|
12128
|
-
/** @description Paginated
|
|
12289
|
+
/** @description Paginated filter attribute list */
|
|
12129
12290
|
200: {
|
|
12130
12291
|
headers: {
|
|
12131
12292
|
[name: string]: unknown;
|
|
12132
12293
|
};
|
|
12133
12294
|
content: {
|
|
12134
12295
|
"application/json": {
|
|
12135
|
-
data: components["schemas"]["
|
|
12296
|
+
data: components["schemas"]["FilterAttribute"][];
|
|
12136
12297
|
pagination: {
|
|
12137
12298
|
cursor: string | null;
|
|
12138
12299
|
has_more: boolean;
|
|
@@ -12143,7 +12304,7 @@ interface operations {
|
|
|
12143
12304
|
};
|
|
12144
12305
|
};
|
|
12145
12306
|
};
|
|
12146
|
-
|
|
12307
|
+
createFilterAttribute: {
|
|
12147
12308
|
parameters: {
|
|
12148
12309
|
query?: never;
|
|
12149
12310
|
header?: never;
|
|
@@ -12153,64 +12314,47 @@ interface operations {
|
|
|
12153
12314
|
requestBody?: {
|
|
12154
12315
|
content: {
|
|
12155
12316
|
"application/json": {
|
|
12156
|
-
/** @example
|
|
12157
|
-
|
|
12158
|
-
/** @example
|
|
12159
|
-
|
|
12317
|
+
/** @example metal */
|
|
12318
|
+
key: string;
|
|
12319
|
+
/** @example Metal */
|
|
12320
|
+
label: string;
|
|
12321
|
+
/**
|
|
12322
|
+
* @example spec
|
|
12323
|
+
* @enum {string}
|
|
12324
|
+
*/
|
|
12325
|
+
source_type: "spec" | "option" | "field" | "tag" | "price" | "availability";
|
|
12326
|
+
/** @example Metal */
|
|
12327
|
+
source_key?: string | null;
|
|
12328
|
+
/** @example 0 */
|
|
12329
|
+
position?: number;
|
|
12160
12330
|
};
|
|
12161
12331
|
};
|
|
12162
12332
|
};
|
|
12163
12333
|
responses: {
|
|
12164
|
-
/** @description
|
|
12334
|
+
/** @description Filter attribute created */
|
|
12165
12335
|
201: {
|
|
12166
12336
|
headers: {
|
|
12167
12337
|
[name: string]: unknown;
|
|
12168
12338
|
};
|
|
12169
12339
|
content: {
|
|
12170
12340
|
"application/json": {
|
|
12171
|
-
data: components["schemas"]["
|
|
12341
|
+
data: components["schemas"]["FilterAttribute"];
|
|
12172
12342
|
};
|
|
12173
12343
|
};
|
|
12174
12344
|
};
|
|
12175
12345
|
};
|
|
12176
12346
|
};
|
|
12177
|
-
|
|
12347
|
+
discoverFilterSources: {
|
|
12178
12348
|
parameters: {
|
|
12179
|
-
query
|
|
12180
|
-
path: string;
|
|
12181
|
-
};
|
|
12349
|
+
query?: never;
|
|
12182
12350
|
header?: never;
|
|
12183
12351
|
path?: never;
|
|
12184
12352
|
cookie?: never;
|
|
12185
12353
|
};
|
|
12186
12354
|
requestBody?: never;
|
|
12187
12355
|
responses: {
|
|
12188
|
-
/** @description
|
|
12356
|
+
/** @description Available filter sources */
|
|
12189
12357
|
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
12358
|
headers: {
|
|
12215
12359
|
[name: string]: unknown;
|
|
12216
12360
|
};
|
|
@@ -12218,70 +12362,33 @@ interface operations {
|
|
|
12218
12362
|
};
|
|
12219
12363
|
};
|
|
12220
12364
|
};
|
|
12221
|
-
|
|
12365
|
+
getFilterAttribute: {
|
|
12222
12366
|
parameters: {
|
|
12223
12367
|
query?: {
|
|
12224
|
-
limit?: number;
|
|
12225
|
-
cursor?: string;
|
|
12226
12368
|
fields?: string;
|
|
12227
|
-
sort?: "created_at" | "updated_at" | "name";
|
|
12228
|
-
order?: "asc" | "desc";
|
|
12229
|
-
search?: string;
|
|
12230
12369
|
};
|
|
12231
12370
|
header?: never;
|
|
12232
|
-
path
|
|
12371
|
+
path: {
|
|
12372
|
+
id: string;
|
|
12373
|
+
};
|
|
12233
12374
|
cookie?: never;
|
|
12234
12375
|
};
|
|
12235
12376
|
requestBody?: never;
|
|
12236
12377
|
responses: {
|
|
12237
|
-
/** @description
|
|
12378
|
+
/** @description Filter attribute details */
|
|
12238
12379
|
200: {
|
|
12239
12380
|
headers: {
|
|
12240
12381
|
[name: string]: unknown;
|
|
12241
12382
|
};
|
|
12242
12383
|
content: {
|
|
12243
12384
|
"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"];
|
|
12385
|
+
data: components["schemas"]["FilterAttribute"];
|
|
12279
12386
|
};
|
|
12280
12387
|
};
|
|
12281
12388
|
};
|
|
12282
12389
|
};
|
|
12283
12390
|
};
|
|
12284
|
-
|
|
12391
|
+
deleteFilterAttribute: {
|
|
12285
12392
|
parameters: {
|
|
12286
12393
|
query?: never;
|
|
12287
12394
|
header?: never;
|
|
@@ -12292,7 +12399,7 @@ interface operations {
|
|
|
12292
12399
|
};
|
|
12293
12400
|
requestBody?: never;
|
|
12294
12401
|
responses: {
|
|
12295
|
-
/** @description
|
|
12402
|
+
/** @description Filter attribute deleted */
|
|
12296
12403
|
204: {
|
|
12297
12404
|
headers: {
|
|
12298
12405
|
[name: string]: unknown;
|
|
@@ -12301,7 +12408,7 @@ interface operations {
|
|
|
12301
12408
|
};
|
|
12302
12409
|
};
|
|
12303
12410
|
};
|
|
12304
|
-
|
|
12411
|
+
updateFilterAttribute: {
|
|
12305
12412
|
parameters: {
|
|
12306
12413
|
query?: never;
|
|
12307
12414
|
header?: never;
|
|
@@ -12313,53 +12420,332 @@ interface operations {
|
|
|
12313
12420
|
requestBody?: {
|
|
12314
12421
|
content: {
|
|
12315
12422
|
"application/json": {
|
|
12316
|
-
/** @example
|
|
12317
|
-
|
|
12423
|
+
/** @example metal */
|
|
12424
|
+
key?: string;
|
|
12425
|
+
/** @example Metal */
|
|
12426
|
+
label?: string;
|
|
12427
|
+
/**
|
|
12428
|
+
* @example spec
|
|
12429
|
+
* @enum {string}
|
|
12430
|
+
*/
|
|
12431
|
+
source_type?: "spec" | "option" | "field" | "tag" | "price" | "availability";
|
|
12432
|
+
/** @example Metal */
|
|
12433
|
+
source_key?: string | null;
|
|
12434
|
+
/** @example 1 */
|
|
12435
|
+
position?: number;
|
|
12318
12436
|
};
|
|
12319
12437
|
};
|
|
12320
12438
|
};
|
|
12321
12439
|
responses: {
|
|
12322
|
-
/** @description
|
|
12440
|
+
/** @description Filter attribute updated */
|
|
12323
12441
|
200: {
|
|
12324
12442
|
headers: {
|
|
12325
12443
|
[name: string]: unknown;
|
|
12326
12444
|
};
|
|
12327
12445
|
content: {
|
|
12328
12446
|
"application/json": {
|
|
12329
|
-
data: components["schemas"]["
|
|
12447
|
+
data: components["schemas"]["FilterAttribute"];
|
|
12330
12448
|
};
|
|
12331
12449
|
};
|
|
12332
12450
|
};
|
|
12333
12451
|
};
|
|
12334
12452
|
};
|
|
12335
|
-
|
|
12453
|
+
reorderFilterAttributes: {
|
|
12336
12454
|
parameters: {
|
|
12337
12455
|
query?: never;
|
|
12338
12456
|
header?: never;
|
|
12339
12457
|
path?: never;
|
|
12340
12458
|
cookie?: never;
|
|
12341
12459
|
};
|
|
12342
|
-
requestBody?:
|
|
12460
|
+
requestBody?: {
|
|
12461
|
+
content: {
|
|
12462
|
+
"application/json": {
|
|
12463
|
+
/**
|
|
12464
|
+
* @example [
|
|
12465
|
+
* {
|
|
12466
|
+
* "id": "fa_abc123",
|
|
12467
|
+
* "position": 0
|
|
12468
|
+
* }
|
|
12469
|
+
* ]
|
|
12470
|
+
*/
|
|
12471
|
+
items: {
|
|
12472
|
+
/** @example fa_abc123 */
|
|
12473
|
+
id: string;
|
|
12474
|
+
/** @example 0 */
|
|
12475
|
+
position: number;
|
|
12476
|
+
}[];
|
|
12477
|
+
};
|
|
12478
|
+
};
|
|
12479
|
+
};
|
|
12343
12480
|
responses: {
|
|
12344
|
-
/** @description
|
|
12481
|
+
/** @description Reordered filter attribute list */
|
|
12345
12482
|
200: {
|
|
12346
12483
|
headers: {
|
|
12347
12484
|
[name: string]: unknown;
|
|
12348
12485
|
};
|
|
12349
12486
|
content: {
|
|
12350
12487
|
"application/json": {
|
|
12351
|
-
data: components["schemas"]["
|
|
12488
|
+
data: components["schemas"]["FilterAttribute"][];
|
|
12489
|
+
pagination: {
|
|
12490
|
+
cursor: string | null;
|
|
12491
|
+
has_more: boolean;
|
|
12492
|
+
total: number;
|
|
12493
|
+
};
|
|
12352
12494
|
};
|
|
12353
12495
|
};
|
|
12354
12496
|
};
|
|
12355
12497
|
};
|
|
12356
12498
|
};
|
|
12357
|
-
|
|
12499
|
+
listRedirects: {
|
|
12358
12500
|
parameters: {
|
|
12359
|
-
query?:
|
|
12360
|
-
|
|
12361
|
-
|
|
12362
|
-
|
|
12501
|
+
query?: {
|
|
12502
|
+
limit?: number;
|
|
12503
|
+
cursor?: string;
|
|
12504
|
+
fields?: string;
|
|
12505
|
+
sort?: "created_at" | "updated_at" | "title" | "relevance";
|
|
12506
|
+
order?: "asc" | "desc";
|
|
12507
|
+
};
|
|
12508
|
+
header?: never;
|
|
12509
|
+
path?: never;
|
|
12510
|
+
cookie?: never;
|
|
12511
|
+
};
|
|
12512
|
+
requestBody?: never;
|
|
12513
|
+
responses: {
|
|
12514
|
+
/** @description Paginated redirect list */
|
|
12515
|
+
200: {
|
|
12516
|
+
headers: {
|
|
12517
|
+
[name: string]: unknown;
|
|
12518
|
+
};
|
|
12519
|
+
content: {
|
|
12520
|
+
"application/json": {
|
|
12521
|
+
data: components["schemas"]["Redirect"][];
|
|
12522
|
+
pagination: {
|
|
12523
|
+
cursor: string | null;
|
|
12524
|
+
has_more: boolean;
|
|
12525
|
+
total: number;
|
|
12526
|
+
};
|
|
12527
|
+
};
|
|
12528
|
+
};
|
|
12529
|
+
};
|
|
12530
|
+
};
|
|
12531
|
+
};
|
|
12532
|
+
createRedirect: {
|
|
12533
|
+
parameters: {
|
|
12534
|
+
query?: never;
|
|
12535
|
+
header?: never;
|
|
12536
|
+
path?: never;
|
|
12537
|
+
cookie?: never;
|
|
12538
|
+
};
|
|
12539
|
+
requestBody?: {
|
|
12540
|
+
content: {
|
|
12541
|
+
"application/json": {
|
|
12542
|
+
/** @example /old-product-page */
|
|
12543
|
+
old_path: string;
|
|
12544
|
+
/** @example /products/classic-cotton-t-shirt */
|
|
12545
|
+
new_path: string;
|
|
12546
|
+
};
|
|
12547
|
+
};
|
|
12548
|
+
};
|
|
12549
|
+
responses: {
|
|
12550
|
+
/** @description Redirect created */
|
|
12551
|
+
201: {
|
|
12552
|
+
headers: {
|
|
12553
|
+
[name: string]: unknown;
|
|
12554
|
+
};
|
|
12555
|
+
content: {
|
|
12556
|
+
"application/json": {
|
|
12557
|
+
data: components["schemas"]["Redirect"];
|
|
12558
|
+
};
|
|
12559
|
+
};
|
|
12560
|
+
};
|
|
12561
|
+
};
|
|
12562
|
+
};
|
|
12563
|
+
lookupRedirect: {
|
|
12564
|
+
parameters: {
|
|
12565
|
+
query: {
|
|
12566
|
+
path: string;
|
|
12567
|
+
};
|
|
12568
|
+
header?: never;
|
|
12569
|
+
path?: never;
|
|
12570
|
+
cookie?: never;
|
|
12571
|
+
};
|
|
12572
|
+
requestBody?: never;
|
|
12573
|
+
responses: {
|
|
12574
|
+
/** @description Redirect found */
|
|
12575
|
+
200: {
|
|
12576
|
+
headers: {
|
|
12577
|
+
[name: string]: unknown;
|
|
12578
|
+
};
|
|
12579
|
+
content: {
|
|
12580
|
+
"application/json": {
|
|
12581
|
+
data: components["schemas"]["Redirect"];
|
|
12582
|
+
};
|
|
12583
|
+
};
|
|
12584
|
+
};
|
|
12585
|
+
};
|
|
12586
|
+
};
|
|
12587
|
+
deleteRedirect: {
|
|
12588
|
+
parameters: {
|
|
12589
|
+
query?: never;
|
|
12590
|
+
header?: never;
|
|
12591
|
+
path: {
|
|
12592
|
+
id: string;
|
|
12593
|
+
};
|
|
12594
|
+
cookie?: never;
|
|
12595
|
+
};
|
|
12596
|
+
requestBody?: never;
|
|
12597
|
+
responses: {
|
|
12598
|
+
/** @description Redirect deleted */
|
|
12599
|
+
204: {
|
|
12600
|
+
headers: {
|
|
12601
|
+
[name: string]: unknown;
|
|
12602
|
+
};
|
|
12603
|
+
content?: never;
|
|
12604
|
+
};
|
|
12605
|
+
};
|
|
12606
|
+
};
|
|
12607
|
+
listTags: {
|
|
12608
|
+
parameters: {
|
|
12609
|
+
query?: {
|
|
12610
|
+
limit?: number;
|
|
12611
|
+
cursor?: string;
|
|
12612
|
+
fields?: string;
|
|
12613
|
+
sort?: "created_at" | "updated_at" | "name";
|
|
12614
|
+
order?: "asc" | "desc";
|
|
12615
|
+
search?: string;
|
|
12616
|
+
};
|
|
12617
|
+
header?: never;
|
|
12618
|
+
path?: never;
|
|
12619
|
+
cookie?: never;
|
|
12620
|
+
};
|
|
12621
|
+
requestBody?: never;
|
|
12622
|
+
responses: {
|
|
12623
|
+
/** @description Paginated tag list */
|
|
12624
|
+
200: {
|
|
12625
|
+
headers: {
|
|
12626
|
+
[name: string]: unknown;
|
|
12627
|
+
};
|
|
12628
|
+
content: {
|
|
12629
|
+
"application/json": {
|
|
12630
|
+
data: components["schemas"]["Tag"][];
|
|
12631
|
+
pagination: {
|
|
12632
|
+
cursor: string | null;
|
|
12633
|
+
has_more: boolean;
|
|
12634
|
+
total: number;
|
|
12635
|
+
};
|
|
12636
|
+
};
|
|
12637
|
+
};
|
|
12638
|
+
};
|
|
12639
|
+
};
|
|
12640
|
+
};
|
|
12641
|
+
createTag: {
|
|
12642
|
+
parameters: {
|
|
12643
|
+
query?: never;
|
|
12644
|
+
header?: never;
|
|
12645
|
+
path?: never;
|
|
12646
|
+
cookie?: never;
|
|
12647
|
+
};
|
|
12648
|
+
requestBody?: {
|
|
12649
|
+
content: {
|
|
12650
|
+
"application/json": {
|
|
12651
|
+
/** @example summer */
|
|
12652
|
+
name: string;
|
|
12653
|
+
};
|
|
12654
|
+
};
|
|
12655
|
+
};
|
|
12656
|
+
responses: {
|
|
12657
|
+
/** @description Tag created */
|
|
12658
|
+
201: {
|
|
12659
|
+
headers: {
|
|
12660
|
+
[name: string]: unknown;
|
|
12661
|
+
};
|
|
12662
|
+
content: {
|
|
12663
|
+
"application/json": {
|
|
12664
|
+
data: components["schemas"]["Tag"];
|
|
12665
|
+
};
|
|
12666
|
+
};
|
|
12667
|
+
};
|
|
12668
|
+
};
|
|
12669
|
+
};
|
|
12670
|
+
deleteTag: {
|
|
12671
|
+
parameters: {
|
|
12672
|
+
query?: never;
|
|
12673
|
+
header?: never;
|
|
12674
|
+
path: {
|
|
12675
|
+
id: string;
|
|
12676
|
+
};
|
|
12677
|
+
cookie?: never;
|
|
12678
|
+
};
|
|
12679
|
+
requestBody?: never;
|
|
12680
|
+
responses: {
|
|
12681
|
+
/** @description Tag deleted */
|
|
12682
|
+
204: {
|
|
12683
|
+
headers: {
|
|
12684
|
+
[name: string]: unknown;
|
|
12685
|
+
};
|
|
12686
|
+
content?: never;
|
|
12687
|
+
};
|
|
12688
|
+
};
|
|
12689
|
+
};
|
|
12690
|
+
updateTag: {
|
|
12691
|
+
parameters: {
|
|
12692
|
+
query?: never;
|
|
12693
|
+
header?: never;
|
|
12694
|
+
path: {
|
|
12695
|
+
id: string;
|
|
12696
|
+
};
|
|
12697
|
+
cookie?: never;
|
|
12698
|
+
};
|
|
12699
|
+
requestBody?: {
|
|
12700
|
+
content: {
|
|
12701
|
+
"application/json": {
|
|
12702
|
+
/** @example summer-2026 */
|
|
12703
|
+
name: string;
|
|
12704
|
+
};
|
|
12705
|
+
};
|
|
12706
|
+
};
|
|
12707
|
+
responses: {
|
|
12708
|
+
/** @description Tag updated */
|
|
12709
|
+
200: {
|
|
12710
|
+
headers: {
|
|
12711
|
+
[name: string]: unknown;
|
|
12712
|
+
};
|
|
12713
|
+
content: {
|
|
12714
|
+
"application/json": {
|
|
12715
|
+
data: components["schemas"]["Tag"];
|
|
12716
|
+
};
|
|
12717
|
+
};
|
|
12718
|
+
};
|
|
12719
|
+
};
|
|
12720
|
+
};
|
|
12721
|
+
listProductTypes: {
|
|
12722
|
+
parameters: {
|
|
12723
|
+
query?: never;
|
|
12724
|
+
header?: never;
|
|
12725
|
+
path?: never;
|
|
12726
|
+
cookie?: never;
|
|
12727
|
+
};
|
|
12728
|
+
requestBody?: never;
|
|
12729
|
+
responses: {
|
|
12730
|
+
/** @description Product type list */
|
|
12731
|
+
200: {
|
|
12732
|
+
headers: {
|
|
12733
|
+
[name: string]: unknown;
|
|
12734
|
+
};
|
|
12735
|
+
content: {
|
|
12736
|
+
"application/json": {
|
|
12737
|
+
data: components["schemas"]["ProductTypeItem"][];
|
|
12738
|
+
};
|
|
12739
|
+
};
|
|
12740
|
+
};
|
|
12741
|
+
};
|
|
12742
|
+
};
|
|
12743
|
+
createProductType: {
|
|
12744
|
+
parameters: {
|
|
12745
|
+
query?: never;
|
|
12746
|
+
header?: never;
|
|
12747
|
+
path?: never;
|
|
12748
|
+
cookie?: never;
|
|
12363
12749
|
};
|
|
12364
12750
|
requestBody?: {
|
|
12365
12751
|
content: {
|
|
@@ -12641,29 +13027,248 @@ interface operations {
|
|
|
12641
13027
|
};
|
|
12642
13028
|
};
|
|
12643
13029
|
responses: {
|
|
12644
|
-
/** @description Promotion updated */
|
|
13030
|
+
/** @description Promotion updated */
|
|
13031
|
+
200: {
|
|
13032
|
+
headers: {
|
|
13033
|
+
[name: string]: unknown;
|
|
13034
|
+
};
|
|
13035
|
+
content: {
|
|
13036
|
+
"application/json": {
|
|
13037
|
+
data: components["schemas"]["Promotion"];
|
|
13038
|
+
};
|
|
13039
|
+
};
|
|
13040
|
+
};
|
|
13041
|
+
};
|
|
13042
|
+
};
|
|
13043
|
+
listDiscounts: {
|
|
13044
|
+
parameters: {
|
|
13045
|
+
query?: {
|
|
13046
|
+
limit?: number;
|
|
13047
|
+
cursor?: string;
|
|
13048
|
+
fields?: string;
|
|
13049
|
+
sort?: "created_at" | "updated_at" | "code";
|
|
13050
|
+
order?: "asc" | "desc";
|
|
13051
|
+
status?: "active" | "disabled";
|
|
13052
|
+
search?: string;
|
|
13053
|
+
};
|
|
13054
|
+
header?: never;
|
|
13055
|
+
path?: never;
|
|
13056
|
+
cookie?: never;
|
|
13057
|
+
};
|
|
13058
|
+
requestBody?: never;
|
|
13059
|
+
responses: {
|
|
13060
|
+
/** @description Paginated discount list */
|
|
13061
|
+
200: {
|
|
13062
|
+
headers: {
|
|
13063
|
+
[name: string]: unknown;
|
|
13064
|
+
};
|
|
13065
|
+
content: {
|
|
13066
|
+
"application/json": {
|
|
13067
|
+
data: components["schemas"]["Discount"][];
|
|
13068
|
+
pagination: {
|
|
13069
|
+
cursor: string | null;
|
|
13070
|
+
has_more: boolean;
|
|
13071
|
+
total: number;
|
|
13072
|
+
};
|
|
13073
|
+
};
|
|
13074
|
+
};
|
|
13075
|
+
};
|
|
13076
|
+
};
|
|
13077
|
+
};
|
|
13078
|
+
createDiscount: {
|
|
13079
|
+
parameters: {
|
|
13080
|
+
query?: never;
|
|
13081
|
+
header?: never;
|
|
13082
|
+
path?: never;
|
|
13083
|
+
cookie?: never;
|
|
13084
|
+
};
|
|
13085
|
+
requestBody?: {
|
|
13086
|
+
content: {
|
|
13087
|
+
"application/json": {
|
|
13088
|
+
/** @example SUMMER20 */
|
|
13089
|
+
code: string;
|
|
13090
|
+
/** @example Summer Sale 20% */
|
|
13091
|
+
title: string;
|
|
13092
|
+
/**
|
|
13093
|
+
* @example percentage
|
|
13094
|
+
* @enum {string}
|
|
13095
|
+
*/
|
|
13096
|
+
type: "percentage" | "fixed_amount";
|
|
13097
|
+
/** @example 20 */
|
|
13098
|
+
value: number;
|
|
13099
|
+
/**
|
|
13100
|
+
* @default active
|
|
13101
|
+
* @example active
|
|
13102
|
+
* @enum {string}
|
|
13103
|
+
*/
|
|
13104
|
+
status?: "active" | "disabled";
|
|
13105
|
+
/** @example 5000 */
|
|
13106
|
+
min_subtotal?: number | null;
|
|
13107
|
+
/** @example 2 */
|
|
13108
|
+
min_quantity?: number | null;
|
|
13109
|
+
/** @example 1000 */
|
|
13110
|
+
max_uses?: number | null;
|
|
13111
|
+
/** @example 1 */
|
|
13112
|
+
max_uses_per_customer?: number | null;
|
|
13113
|
+
/**
|
|
13114
|
+
* @default true
|
|
13115
|
+
* @example true
|
|
13116
|
+
*/
|
|
13117
|
+
exclusive?: boolean;
|
|
13118
|
+
/**
|
|
13119
|
+
* @default true
|
|
13120
|
+
* @example true
|
|
13121
|
+
*/
|
|
13122
|
+
combinable_with_promotions?: boolean;
|
|
13123
|
+
/** @example null */
|
|
13124
|
+
customer_group_ids?: string[] | null;
|
|
13125
|
+
/**
|
|
13126
|
+
* Format: date-time
|
|
13127
|
+
* @example 2026-06-01T00:00:00Z
|
|
13128
|
+
*/
|
|
13129
|
+
starts_at: string;
|
|
13130
|
+
/**
|
|
13131
|
+
* Format: date-time
|
|
13132
|
+
* @example 2026-08-31T23:59:59Z
|
|
13133
|
+
*/
|
|
13134
|
+
ends_at?: string | null;
|
|
13135
|
+
};
|
|
13136
|
+
};
|
|
13137
|
+
};
|
|
13138
|
+
responses: {
|
|
13139
|
+
/** @description Discount created */
|
|
13140
|
+
201: {
|
|
13141
|
+
headers: {
|
|
13142
|
+
[name: string]: unknown;
|
|
13143
|
+
};
|
|
13144
|
+
content: {
|
|
13145
|
+
"application/json": {
|
|
13146
|
+
data: components["schemas"]["Discount"];
|
|
13147
|
+
};
|
|
13148
|
+
};
|
|
13149
|
+
};
|
|
13150
|
+
};
|
|
13151
|
+
};
|
|
13152
|
+
getDiscount: {
|
|
13153
|
+
parameters: {
|
|
13154
|
+
query?: never;
|
|
13155
|
+
header?: never;
|
|
13156
|
+
path: {
|
|
13157
|
+
id: string;
|
|
13158
|
+
};
|
|
13159
|
+
cookie?: never;
|
|
13160
|
+
};
|
|
13161
|
+
requestBody?: never;
|
|
13162
|
+
responses: {
|
|
13163
|
+
/** @description Discount details */
|
|
13164
|
+
200: {
|
|
13165
|
+
headers: {
|
|
13166
|
+
[name: string]: unknown;
|
|
13167
|
+
};
|
|
13168
|
+
content: {
|
|
13169
|
+
"application/json": {
|
|
13170
|
+
data: components["schemas"]["Discount"];
|
|
13171
|
+
};
|
|
13172
|
+
};
|
|
13173
|
+
};
|
|
13174
|
+
};
|
|
13175
|
+
};
|
|
13176
|
+
deleteDiscount: {
|
|
13177
|
+
parameters: {
|
|
13178
|
+
query?: never;
|
|
13179
|
+
header?: never;
|
|
13180
|
+
path: {
|
|
13181
|
+
id: string;
|
|
13182
|
+
};
|
|
13183
|
+
cookie?: never;
|
|
13184
|
+
};
|
|
13185
|
+
requestBody?: never;
|
|
13186
|
+
responses: {
|
|
13187
|
+
/** @description Discount deleted */
|
|
13188
|
+
204: {
|
|
13189
|
+
headers: {
|
|
13190
|
+
[name: string]: unknown;
|
|
13191
|
+
};
|
|
13192
|
+
content?: never;
|
|
13193
|
+
};
|
|
13194
|
+
};
|
|
13195
|
+
};
|
|
13196
|
+
updateDiscount: {
|
|
13197
|
+
parameters: {
|
|
13198
|
+
query?: never;
|
|
13199
|
+
header?: never;
|
|
13200
|
+
path: {
|
|
13201
|
+
id: string;
|
|
13202
|
+
};
|
|
13203
|
+
cookie?: never;
|
|
13204
|
+
};
|
|
13205
|
+
requestBody?: {
|
|
13206
|
+
content: {
|
|
13207
|
+
"application/json": {
|
|
13208
|
+
/** @example Summer Sale Updated */
|
|
13209
|
+
title?: string;
|
|
13210
|
+
/**
|
|
13211
|
+
* @example percentage
|
|
13212
|
+
* @enum {string}
|
|
13213
|
+
*/
|
|
13214
|
+
type?: "percentage" | "fixed_amount";
|
|
13215
|
+
/** @example 25 */
|
|
13216
|
+
value?: number;
|
|
13217
|
+
/**
|
|
13218
|
+
* @example active
|
|
13219
|
+
* @enum {string}
|
|
13220
|
+
*/
|
|
13221
|
+
status?: "active" | "disabled";
|
|
13222
|
+
/** @example 5000 */
|
|
13223
|
+
min_subtotal?: number | null;
|
|
13224
|
+
/** @example 2 */
|
|
13225
|
+
min_quantity?: number | null;
|
|
13226
|
+
/** @example 1000 */
|
|
13227
|
+
max_uses?: number | null;
|
|
13228
|
+
/** @example 1 */
|
|
13229
|
+
max_uses_per_customer?: number | null;
|
|
13230
|
+
/** @example true */
|
|
13231
|
+
exclusive?: boolean;
|
|
13232
|
+
/** @example true */
|
|
13233
|
+
combinable_with_promotions?: boolean;
|
|
13234
|
+
/** @example null */
|
|
13235
|
+
customer_group_ids?: string[] | null;
|
|
13236
|
+
/**
|
|
13237
|
+
* Format: date-time
|
|
13238
|
+
* @example 2026-06-01T00:00:00Z
|
|
13239
|
+
*/
|
|
13240
|
+
starts_at?: string;
|
|
13241
|
+
/**
|
|
13242
|
+
* Format: date-time
|
|
13243
|
+
* @example 2026-08-31T23:59:59Z
|
|
13244
|
+
*/
|
|
13245
|
+
ends_at?: string | null;
|
|
13246
|
+
};
|
|
13247
|
+
};
|
|
13248
|
+
};
|
|
13249
|
+
responses: {
|
|
13250
|
+
/** @description Discount updated */
|
|
12645
13251
|
200: {
|
|
12646
13252
|
headers: {
|
|
12647
13253
|
[name: string]: unknown;
|
|
12648
13254
|
};
|
|
12649
13255
|
content: {
|
|
12650
13256
|
"application/json": {
|
|
12651
|
-
data: components["schemas"]["
|
|
13257
|
+
data: components["schemas"]["Discount"];
|
|
12652
13258
|
};
|
|
12653
13259
|
};
|
|
12654
13260
|
};
|
|
12655
13261
|
};
|
|
12656
13262
|
};
|
|
12657
|
-
|
|
13263
|
+
listMembershipPlans: {
|
|
12658
13264
|
parameters: {
|
|
12659
13265
|
query?: {
|
|
12660
13266
|
limit?: number;
|
|
12661
13267
|
cursor?: string;
|
|
12662
13268
|
fields?: string;
|
|
12663
|
-
sort?: "created_at" | "updated_at" | "
|
|
13269
|
+
sort?: "created_at" | "updated_at" | "name";
|
|
12664
13270
|
order?: "asc" | "desc";
|
|
12665
|
-
status?: "active" | "
|
|
12666
|
-
search?: string;
|
|
13271
|
+
status?: "active" | "archived";
|
|
12667
13272
|
};
|
|
12668
13273
|
header?: never;
|
|
12669
13274
|
path?: never;
|
|
@@ -12671,14 +13276,14 @@ interface operations {
|
|
|
12671
13276
|
};
|
|
12672
13277
|
requestBody?: never;
|
|
12673
13278
|
responses: {
|
|
12674
|
-
/** @description Paginated
|
|
13279
|
+
/** @description Paginated plan list */
|
|
12675
13280
|
200: {
|
|
12676
13281
|
headers: {
|
|
12677
13282
|
[name: string]: unknown;
|
|
12678
13283
|
};
|
|
12679
13284
|
content: {
|
|
12680
13285
|
"application/json": {
|
|
12681
|
-
data: components["schemas"]["
|
|
13286
|
+
data: components["schemas"]["MembershipPlan"][];
|
|
12682
13287
|
pagination: {
|
|
12683
13288
|
cursor: string | null;
|
|
12684
13289
|
has_more: boolean;
|
|
@@ -12689,7 +13294,7 @@ interface operations {
|
|
|
12689
13294
|
};
|
|
12690
13295
|
};
|
|
12691
13296
|
};
|
|
12692
|
-
|
|
13297
|
+
createMembershipPlan: {
|
|
12693
13298
|
parameters: {
|
|
12694
13299
|
query?: never;
|
|
12695
13300
|
header?: never;
|
|
@@ -12699,71 +13304,58 @@ interface operations {
|
|
|
12699
13304
|
requestBody?: {
|
|
12700
13305
|
content: {
|
|
12701
13306
|
"application/json": {
|
|
12702
|
-
/** @example
|
|
12703
|
-
|
|
12704
|
-
/** @example
|
|
12705
|
-
|
|
13307
|
+
/** @example VIP Membership */
|
|
13308
|
+
name: string;
|
|
13309
|
+
/** @example Unlock wholesale pricing */
|
|
13310
|
+
description?: string;
|
|
13311
|
+
/** @example vip-membership */
|
|
13312
|
+
slug: string;
|
|
12706
13313
|
/**
|
|
12707
|
-
* @
|
|
12708
|
-
* @
|
|
13314
|
+
* @description Price in cents
|
|
13315
|
+
* @example 1199
|
|
12709
13316
|
*/
|
|
12710
|
-
|
|
12711
|
-
/** @example
|
|
12712
|
-
|
|
13317
|
+
amount: number;
|
|
13318
|
+
/** @example gbp */
|
|
13319
|
+
currency: string;
|
|
12713
13320
|
/**
|
|
12714
|
-
* @
|
|
12715
|
-
* @example active
|
|
13321
|
+
* @example month
|
|
12716
13322
|
* @enum {string}
|
|
12717
13323
|
*/
|
|
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;
|
|
13324
|
+
interval: "month" | "year";
|
|
12739
13325
|
/**
|
|
12740
|
-
*
|
|
12741
|
-
* @example
|
|
13326
|
+
* @default 1
|
|
13327
|
+
* @example 1
|
|
12742
13328
|
*/
|
|
12743
|
-
|
|
13329
|
+
interval_count?: number;
|
|
13330
|
+
/** @example 14 */
|
|
13331
|
+
trial_days?: number;
|
|
12744
13332
|
/**
|
|
12745
|
-
*
|
|
12746
|
-
* @example
|
|
13333
|
+
* @description Auto-assign members to this group
|
|
13334
|
+
* @example cg_abc123
|
|
12747
13335
|
*/
|
|
12748
|
-
|
|
13336
|
+
customer_group_id?: string;
|
|
13337
|
+
/** @default {} */
|
|
13338
|
+
metadata?: {
|
|
13339
|
+
[key: string]: string | number;
|
|
13340
|
+
};
|
|
12749
13341
|
};
|
|
12750
13342
|
};
|
|
12751
13343
|
};
|
|
12752
13344
|
responses: {
|
|
12753
|
-
/** @description
|
|
13345
|
+
/** @description Plan created */
|
|
12754
13346
|
201: {
|
|
12755
13347
|
headers: {
|
|
12756
13348
|
[name: string]: unknown;
|
|
12757
13349
|
};
|
|
12758
13350
|
content: {
|
|
12759
13351
|
"application/json": {
|
|
12760
|
-
data: components["schemas"]["
|
|
13352
|
+
data: components["schemas"]["MembershipPlan"];
|
|
12761
13353
|
};
|
|
12762
13354
|
};
|
|
12763
13355
|
};
|
|
12764
13356
|
};
|
|
12765
13357
|
};
|
|
12766
|
-
|
|
13358
|
+
getMembershipPlan: {
|
|
12767
13359
|
parameters: {
|
|
12768
13360
|
query?: never;
|
|
12769
13361
|
header?: never;
|
|
@@ -12774,20 +13366,20 @@ interface operations {
|
|
|
12774
13366
|
};
|
|
12775
13367
|
requestBody?: never;
|
|
12776
13368
|
responses: {
|
|
12777
|
-
/** @description
|
|
13369
|
+
/** @description Plan details */
|
|
12778
13370
|
200: {
|
|
12779
13371
|
headers: {
|
|
12780
13372
|
[name: string]: unknown;
|
|
12781
13373
|
};
|
|
12782
13374
|
content: {
|
|
12783
13375
|
"application/json": {
|
|
12784
|
-
data: components["schemas"]["
|
|
13376
|
+
data: components["schemas"]["MembershipPlan"];
|
|
12785
13377
|
};
|
|
12786
13378
|
};
|
|
12787
13379
|
};
|
|
12788
13380
|
};
|
|
12789
13381
|
};
|
|
12790
|
-
|
|
13382
|
+
deleteMembershipPlan: {
|
|
12791
13383
|
parameters: {
|
|
12792
13384
|
query?: never;
|
|
12793
13385
|
header?: never;
|
|
@@ -12798,7 +13390,7 @@ interface operations {
|
|
|
12798
13390
|
};
|
|
12799
13391
|
requestBody?: never;
|
|
12800
13392
|
responses: {
|
|
12801
|
-
/** @description
|
|
13393
|
+
/** @description Plan archived */
|
|
12802
13394
|
204: {
|
|
12803
13395
|
headers: {
|
|
12804
13396
|
[name: string]: unknown;
|
|
@@ -12807,7 +13399,7 @@ interface operations {
|
|
|
12807
13399
|
};
|
|
12808
13400
|
};
|
|
12809
13401
|
};
|
|
12810
|
-
|
|
13402
|
+
updateMembershipPlan: {
|
|
12811
13403
|
parameters: {
|
|
12812
13404
|
query?: never;
|
|
12813
13405
|
header?: never;
|
|
@@ -12819,56 +13411,70 @@ interface operations {
|
|
|
12819
13411
|
requestBody?: {
|
|
12820
13412
|
content: {
|
|
12821
13413
|
"application/json": {
|
|
12822
|
-
/** @example
|
|
12823
|
-
|
|
12824
|
-
/**
|
|
12825
|
-
|
|
12826
|
-
* @enum {string}
|
|
12827
|
-
*/
|
|
12828
|
-
type?: "percentage" | "fixed_amount";
|
|
12829
|
-
/** @example 25 */
|
|
12830
|
-
value?: number;
|
|
13414
|
+
/** @example VIP Membership */
|
|
13415
|
+
name?: string;
|
|
13416
|
+
/** @example Unlock wholesale pricing */
|
|
13417
|
+
description?: string | null;
|
|
12831
13418
|
/**
|
|
12832
13419
|
* @example active
|
|
12833
13420
|
* @enum {string}
|
|
12834
13421
|
*/
|
|
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;
|
|
13422
|
+
status?: "active" | "archived";
|
|
13423
|
+
/** @example 14 */
|
|
13424
|
+
trial_days?: number | null;
|
|
13425
|
+
/** @example cg_abc123 */
|
|
13426
|
+
customer_group_id?: string | null;
|
|
13427
|
+
metadata?: {
|
|
13428
|
+
[key: string]: string | number;
|
|
13429
|
+
};
|
|
12860
13430
|
};
|
|
12861
13431
|
};
|
|
12862
13432
|
};
|
|
12863
13433
|
responses: {
|
|
12864
|
-
/** @description
|
|
13434
|
+
/** @description Plan updated */
|
|
12865
13435
|
200: {
|
|
12866
13436
|
headers: {
|
|
12867
13437
|
[name: string]: unknown;
|
|
12868
13438
|
};
|
|
12869
13439
|
content: {
|
|
12870
13440
|
"application/json": {
|
|
12871
|
-
data: components["schemas"]["
|
|
13441
|
+
data: components["schemas"]["MembershipPlan"];
|
|
13442
|
+
};
|
|
13443
|
+
};
|
|
13444
|
+
};
|
|
13445
|
+
};
|
|
13446
|
+
};
|
|
13447
|
+
listMembershipSubscriptions: {
|
|
13448
|
+
parameters: {
|
|
13449
|
+
query?: {
|
|
13450
|
+
limit?: number;
|
|
13451
|
+
cursor?: string;
|
|
13452
|
+
fields?: string;
|
|
13453
|
+
sort?: "created_at" | "updated_at";
|
|
13454
|
+
order?: "asc" | "desc";
|
|
13455
|
+
status?: "active" | "trialing" | "past_due" | "cancelled" | "expired" | "pending";
|
|
13456
|
+
plan_id?: string;
|
|
13457
|
+
customer_id?: string;
|
|
13458
|
+
};
|
|
13459
|
+
header?: never;
|
|
13460
|
+
path?: never;
|
|
13461
|
+
cookie?: never;
|
|
13462
|
+
};
|
|
13463
|
+
requestBody?: never;
|
|
13464
|
+
responses: {
|
|
13465
|
+
/** @description Paginated subscription list */
|
|
13466
|
+
200: {
|
|
13467
|
+
headers: {
|
|
13468
|
+
[name: string]: unknown;
|
|
13469
|
+
};
|
|
13470
|
+
content: {
|
|
13471
|
+
"application/json": {
|
|
13472
|
+
data: components["schemas"]["CustomerMembership"][];
|
|
13473
|
+
pagination: {
|
|
13474
|
+
cursor: string | null;
|
|
13475
|
+
has_more: boolean;
|
|
13476
|
+
total: number;
|
|
13477
|
+
};
|
|
12872
13478
|
};
|
|
12873
13479
|
};
|
|
12874
13480
|
};
|
|
@@ -15978,6 +16584,95 @@ interface operations {
|
|
|
15978
16584
|
};
|
|
15979
16585
|
};
|
|
15980
16586
|
};
|
|
16587
|
+
getCustomerMembership: {
|
|
16588
|
+
parameters: {
|
|
16589
|
+
query?: never;
|
|
16590
|
+
header?: never;
|
|
16591
|
+
path?: never;
|
|
16592
|
+
cookie?: never;
|
|
16593
|
+
};
|
|
16594
|
+
requestBody?: never;
|
|
16595
|
+
responses: {
|
|
16596
|
+
/** @description Active membership or null */
|
|
16597
|
+
200: {
|
|
16598
|
+
headers: {
|
|
16599
|
+
[name: string]: unknown;
|
|
16600
|
+
};
|
|
16601
|
+
content?: never;
|
|
16602
|
+
};
|
|
16603
|
+
};
|
|
16604
|
+
};
|
|
16605
|
+
subscribeMembership: {
|
|
16606
|
+
parameters: {
|
|
16607
|
+
query?: never;
|
|
16608
|
+
header?: never;
|
|
16609
|
+
path?: never;
|
|
16610
|
+
cookie?: never;
|
|
16611
|
+
};
|
|
16612
|
+
requestBody?: {
|
|
16613
|
+
content: {
|
|
16614
|
+
"application/json": {
|
|
16615
|
+
/** @example mplan_abc123 */
|
|
16616
|
+
plan_id: string;
|
|
16617
|
+
/**
|
|
16618
|
+
* Format: uri
|
|
16619
|
+
* @example https://auriclejewelry.com/account/membership?success=true
|
|
16620
|
+
*/
|
|
16621
|
+
success_url: string;
|
|
16622
|
+
/**
|
|
16623
|
+
* Format: uri
|
|
16624
|
+
* @example https://auriclejewelry.com/vip-membership
|
|
16625
|
+
*/
|
|
16626
|
+
cancel_url: string;
|
|
16627
|
+
};
|
|
16628
|
+
};
|
|
16629
|
+
};
|
|
16630
|
+
responses: {
|
|
16631
|
+
/** @description Stripe Checkout URL */
|
|
16632
|
+
200: {
|
|
16633
|
+
headers: {
|
|
16634
|
+
[name: string]: unknown;
|
|
16635
|
+
};
|
|
16636
|
+
content: {
|
|
16637
|
+
"application/json": {
|
|
16638
|
+
data: components["schemas"]["SubscribeCheckout"];
|
|
16639
|
+
};
|
|
16640
|
+
};
|
|
16641
|
+
};
|
|
16642
|
+
};
|
|
16643
|
+
};
|
|
16644
|
+
getMembershipPortal: {
|
|
16645
|
+
parameters: {
|
|
16646
|
+
query?: never;
|
|
16647
|
+
header?: never;
|
|
16648
|
+
path?: never;
|
|
16649
|
+
cookie?: never;
|
|
16650
|
+
};
|
|
16651
|
+
requestBody?: {
|
|
16652
|
+
content: {
|
|
16653
|
+
"application/json": {
|
|
16654
|
+
/**
|
|
16655
|
+
* Format: uri
|
|
16656
|
+
* @example https://auriclejewelry.com/account/membership
|
|
16657
|
+
*/
|
|
16658
|
+
return_url: string;
|
|
16659
|
+
};
|
|
16660
|
+
};
|
|
16661
|
+
};
|
|
16662
|
+
responses: {
|
|
16663
|
+
/** @description Portal URL */
|
|
16664
|
+
200: {
|
|
16665
|
+
headers: {
|
|
16666
|
+
[name: string]: unknown;
|
|
16667
|
+
};
|
|
16668
|
+
content: {
|
|
16669
|
+
"application/json": {
|
|
16670
|
+
data: components["schemas"]["MembershipPortal"];
|
|
16671
|
+
};
|
|
16672
|
+
};
|
|
16673
|
+
};
|
|
16674
|
+
};
|
|
16675
|
+
};
|
|
15981
16676
|
getAnalyticsSummary: {
|
|
15982
16677
|
parameters: {
|
|
15983
16678
|
query?: {
|
|
@@ -16298,9 +16993,9 @@ type ProductStats = components['schemas']['ProductStats'];
|
|
|
16298
16993
|
type Variant$1 = components['schemas']['Variant'];
|
|
16299
16994
|
type Image$1 = components['schemas']['Image'];
|
|
16300
16995
|
type GenerateVariantsResult = components['schemas']['GenerateVariantsResult'];
|
|
16301
|
-
type ListParams$
|
|
16302
|
-
type CreateBody$
|
|
16303
|
-
type UpdateBody$
|
|
16996
|
+
type ListParams$o = NonNullable<operations['listProducts']['parameters']['query']>;
|
|
16997
|
+
type CreateBody$k = NonNullable<operations['createProduct']['requestBody']>['content']['application/json'];
|
|
16998
|
+
type UpdateBody$k = NonNullable<operations['updateProduct']['requestBody']>['content']['application/json'];
|
|
16304
16999
|
type DuplicateBody = NonNullable<operations['duplicateProduct']['requestBody']>['content']['application/json'];
|
|
16305
17000
|
type CreateVariantBody = NonNullable<operations['createProductVariant']['requestBody']>['content']['application/json'];
|
|
16306
17001
|
type GenerateVariantsBody = NonNullable<operations['generateProductVariants']['requestBody']>['content']['application/json'];
|
|
@@ -16308,17 +17003,17 @@ type AttachImagesBody = NonNullable<operations['attachProductImages']['requestBo
|
|
|
16308
17003
|
declare class ProductsResource {
|
|
16309
17004
|
private client;
|
|
16310
17005
|
constructor(client: Hydra);
|
|
16311
|
-
list(params?: ListParams$
|
|
16312
|
-
iterate(params?: Omit<ListParams$
|
|
16313
|
-
toArray(params?: Omit<ListParams$
|
|
17006
|
+
list(params?: ListParams$o): Promise<ListResponse<Product>>;
|
|
17007
|
+
iterate(params?: Omit<ListParams$o, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Product, void, undefined>;
|
|
17008
|
+
toArray(params?: Omit<ListParams$o, 'cursor'>, options?: PaginateOptions & {
|
|
16314
17009
|
limit?: number;
|
|
16315
17010
|
}): Promise<Product[]>;
|
|
16316
|
-
get(id: string, params?: Pick<ListParams$
|
|
16317
|
-
create(body: CreateBody$
|
|
16318
|
-
update(id: string, body: UpdateBody$
|
|
17011
|
+
get(id: string, params?: Pick<ListParams$o, 'expand' | 'currency' | 'fields'>): Promise<DataResponse<Product>>;
|
|
17012
|
+
create(body: CreateBody$k, options?: ResourceRequestOptions): Promise<DataResponse<Product>>;
|
|
17013
|
+
update(id: string, body: UpdateBody$k): Promise<DataResponse<Product>>;
|
|
16319
17014
|
delete(id: string): Promise<void>;
|
|
16320
17015
|
batchCreate(body: {
|
|
16321
|
-
products: CreateBody$
|
|
17016
|
+
products: CreateBody$k[];
|
|
16322
17017
|
}, options?: ResourceRequestOptions): Promise<DataResponse<Product[]>>;
|
|
16323
17018
|
duplicate(id: string, body: DuplicateBody): Promise<DataResponse<Product>>;
|
|
16324
17019
|
getStats(id: string): Promise<DataResponse<ProductStats>>;
|
|
@@ -16336,7 +17031,7 @@ declare class ProductsResource {
|
|
|
16336
17031
|
|
|
16337
17032
|
type Variant = components['schemas']['Variant'];
|
|
16338
17033
|
type VariantPrice = components['schemas']['VariantPrice'];
|
|
16339
|
-
type UpdateBody$
|
|
17034
|
+
type UpdateBody$j = NonNullable<operations['updateVariant']['requestBody']>['content']['application/json'];
|
|
16340
17035
|
type UpsertPriceBody = NonNullable<operations['upsertVariantPrice']['requestBody']>['content']['application/json'];
|
|
16341
17036
|
declare class VariantsResource {
|
|
16342
17037
|
private client;
|
|
@@ -16346,7 +17041,7 @@ declare class VariantsResource {
|
|
|
16346
17041
|
currency?: string;
|
|
16347
17042
|
fields?: string;
|
|
16348
17043
|
}): Promise<DataResponse<Variant>>;
|
|
16349
|
-
update(id: string, body: UpdateBody$
|
|
17044
|
+
update(id: string, body: UpdateBody$j): Promise<DataResponse<Variant>>;
|
|
16350
17045
|
delete(id: string): Promise<void>;
|
|
16351
17046
|
listPrices(variantId: string): Promise<DataResponse<Record<string, VariantPrice>>>;
|
|
16352
17047
|
upsertPrice(variantId: string, priceKeySlug: string, body: UpsertPriceBody): Promise<DataResponse<VariantPrice>>;
|
|
@@ -16358,23 +17053,23 @@ declare class VariantsResource {
|
|
|
16358
17053
|
}
|
|
16359
17054
|
|
|
16360
17055
|
type Collection = components['schemas']['Collection'];
|
|
16361
|
-
type ListParams$
|
|
16362
|
-
type CreateBody$
|
|
16363
|
-
type UpdateBody$
|
|
17056
|
+
type ListParams$n = NonNullable<operations['listCollections']['parameters']['query']>;
|
|
17057
|
+
type CreateBody$j = NonNullable<operations['createCollection']['requestBody']>['content']['application/json'];
|
|
17058
|
+
type UpdateBody$i = NonNullable<operations['updateCollection']['requestBody']>['content']['application/json'];
|
|
16364
17059
|
type AddProductsBody = NonNullable<operations['addCollectionProducts']['requestBody']>['content']['application/json'];
|
|
16365
17060
|
type ReorderProductsBody = NonNullable<operations['reorderCollectionProducts']['requestBody']>['content']['application/json'];
|
|
16366
17061
|
type ReorderCollectionsBody = NonNullable<operations['reorderCollections']['requestBody']>['content']['application/json'];
|
|
16367
17062
|
declare class CollectionsResource {
|
|
16368
17063
|
private client;
|
|
16369
17064
|
constructor(client: Hydra);
|
|
16370
|
-
list(params?: ListParams$
|
|
16371
|
-
iterate(params?: Omit<ListParams$
|
|
16372
|
-
toArray(params?: Omit<ListParams$
|
|
17065
|
+
list(params?: ListParams$n): Promise<ListResponse<Collection>>;
|
|
17066
|
+
iterate(params?: Omit<ListParams$n, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Collection, void, undefined>;
|
|
17067
|
+
toArray(params?: Omit<ListParams$n, 'cursor'>, options?: PaginateOptions & {
|
|
16373
17068
|
limit?: number;
|
|
16374
17069
|
}): Promise<Collection[]>;
|
|
16375
|
-
get(id: string, params?: Pick<ListParams$
|
|
16376
|
-
create(body: CreateBody$
|
|
16377
|
-
update(id: string, body: UpdateBody$
|
|
17070
|
+
get(id: string, params?: Pick<ListParams$n, 'expand' | 'fields'>): Promise<DataResponse<Collection>>;
|
|
17071
|
+
create(body: CreateBody$j, options?: ResourceRequestOptions): Promise<DataResponse<Collection>>;
|
|
17072
|
+
update(id: string, body: UpdateBody$i): Promise<DataResponse<Collection>>;
|
|
16378
17073
|
delete(id: string): Promise<void>;
|
|
16379
17074
|
tree(): Promise<DataResponse<unknown>>;
|
|
16380
17075
|
reorder(body: ReorderCollectionsBody): Promise<void>;
|
|
@@ -16404,13 +17099,13 @@ declare class CartResource {
|
|
|
16404
17099
|
|
|
16405
17100
|
type CheckoutCreate = components['schemas']['CheckoutCreate'];
|
|
16406
17101
|
type CheckoutGet = components['schemas']['CheckoutGet'];
|
|
16407
|
-
type CreateBody$
|
|
17102
|
+
type CreateBody$i = NonNullable<operations['createCheckout']['requestBody']>['content']['application/json'];
|
|
16408
17103
|
type ApplyDiscountBody = NonNullable<operations['applyCheckoutDiscount']['requestBody']>['content']['application/json'];
|
|
16409
17104
|
type ApplyCreditBody = NonNullable<operations['applyCheckoutCredit']['requestBody']>['content']['application/json'];
|
|
16410
17105
|
declare class CheckoutResource {
|
|
16411
17106
|
private client;
|
|
16412
17107
|
constructor(client: Hydra);
|
|
16413
|
-
create(body: CreateBody$
|
|
17108
|
+
create(body: CreateBody$i, options?: ResourceRequestOptions): Promise<DataResponse<CheckoutCreate>>;
|
|
16414
17109
|
get(id: string): Promise<DataResponse<CheckoutGet>>;
|
|
16415
17110
|
applyDiscount(checkoutId: string, body: ApplyDiscountBody): Promise<DataResponse<CheckoutGet>>;
|
|
16416
17111
|
removeDiscount(checkoutId: string): Promise<DataResponse<CheckoutGet>>;
|
|
@@ -16421,15 +17116,15 @@ declare class CheckoutResource {
|
|
|
16421
17116
|
|
|
16422
17117
|
type Order$1 = components['schemas']['Order'];
|
|
16423
17118
|
type FulfillmentOrder$1 = components['schemas']['FulfillmentOrder'];
|
|
16424
|
-
type ListParams$
|
|
16425
|
-
type CreateBody$
|
|
16426
|
-
type UpdateBody$
|
|
17119
|
+
type ListParams$m = NonNullable<operations['listOrders']['parameters']['query']>;
|
|
17120
|
+
type CreateBody$h = NonNullable<operations['createOrder']['requestBody']>['content']['application/json'];
|
|
17121
|
+
type UpdateBody$h = NonNullable<operations['updateOrder']['requestBody']>['content']['application/json'];
|
|
16427
17122
|
declare class OrdersResource {
|
|
16428
17123
|
private client;
|
|
16429
17124
|
constructor(client: Hydra);
|
|
16430
|
-
list(params?: ListParams$
|
|
16431
|
-
iterate(params?: Omit<ListParams$
|
|
16432
|
-
toArray(params?: Omit<ListParams$
|
|
17125
|
+
list(params?: ListParams$m): Promise<ListResponse<Order$1>>;
|
|
17126
|
+
iterate(params?: Omit<ListParams$m, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Order$1, void, undefined>;
|
|
17127
|
+
toArray(params?: Omit<ListParams$m, 'cursor'>, options?: PaginateOptions & {
|
|
16433
17128
|
limit?: number;
|
|
16434
17129
|
}): Promise<Order$1[]>;
|
|
16435
17130
|
get(id: string, params?: {
|
|
@@ -16437,8 +17132,8 @@ declare class OrdersResource {
|
|
|
16437
17132
|
currency?: string;
|
|
16438
17133
|
fields?: string;
|
|
16439
17134
|
}): Promise<DataResponse<Order$1>>;
|
|
16440
|
-
create(body: CreateBody$
|
|
16441
|
-
update(id: string, body: UpdateBody$
|
|
17135
|
+
create(body: CreateBody$h, options?: ResourceRequestOptions): Promise<DataResponse<Order$1>>;
|
|
17136
|
+
update(id: string, body: UpdateBody$h): Promise<DataResponse<Order$1>>;
|
|
16442
17137
|
listFulfillmentOrders(orderId: string): Promise<DataResponse<FulfillmentOrder$1[]>>;
|
|
16443
17138
|
/**
|
|
16444
17139
|
* Returns the API path for downloading the invoice PDF for an order.
|
|
@@ -16452,34 +17147,34 @@ declare class OrdersResource {
|
|
|
16452
17147
|
}
|
|
16453
17148
|
|
|
16454
17149
|
type Fulfillment = components['schemas']['Fulfillment'];
|
|
16455
|
-
type CreateBody$
|
|
16456
|
-
type UpdateBody$
|
|
17150
|
+
type CreateBody$g = NonNullable<operations['createFulfillment']['requestBody']>['content']['application/json'];
|
|
17151
|
+
type UpdateBody$g = NonNullable<operations['updateFulfillment']['requestBody']>['content']['application/json'];
|
|
16457
17152
|
type CancelBody = NonNullable<operations['cancelFulfillment']['requestBody']>['content']['application/json'];
|
|
16458
17153
|
declare class FulfillmentsResource {
|
|
16459
17154
|
private client;
|
|
16460
17155
|
constructor(client: Hydra);
|
|
16461
17156
|
/** Create a fulfillment for a fulfillment order */
|
|
16462
|
-
create(fulfillmentOrderId: string, body: CreateBody$
|
|
16463
|
-
update(id: string, body: UpdateBody$
|
|
17157
|
+
create(fulfillmentOrderId: string, body: CreateBody$g, options?: ResourceRequestOptions): Promise<DataResponse<Fulfillment>>;
|
|
17158
|
+
update(id: string, body: UpdateBody$g): Promise<DataResponse<Fulfillment>>;
|
|
16464
17159
|
cancel(id: string, body?: CancelBody): Promise<DataResponse<Fulfillment>>;
|
|
16465
17160
|
}
|
|
16466
17161
|
|
|
16467
17162
|
type Refund = components['schemas']['Refund'];
|
|
16468
|
-
type ListParams$
|
|
16469
|
-
type CreateBody$
|
|
17163
|
+
type ListParams$l = NonNullable<operations['listRefunds']['parameters']['query']>;
|
|
17164
|
+
type CreateBody$f = NonNullable<operations['createOrderRefund']['requestBody']>['content']['application/json'];
|
|
16470
17165
|
declare class RefundsResource {
|
|
16471
17166
|
private client;
|
|
16472
17167
|
constructor(client: Hydra);
|
|
16473
|
-
list(params?: ListParams$
|
|
16474
|
-
iterate(params?: Omit<ListParams$
|
|
16475
|
-
toArray(params?: Omit<ListParams$
|
|
17168
|
+
list(params?: ListParams$l): Promise<ListResponse<Refund>>;
|
|
17169
|
+
iterate(params?: Omit<ListParams$l, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Refund, void, undefined>;
|
|
17170
|
+
toArray(params?: Omit<ListParams$l, 'cursor'>, options?: PaginateOptions & {
|
|
16476
17171
|
limit?: number;
|
|
16477
17172
|
}): Promise<Refund[]>;
|
|
16478
17173
|
get(id: string, params?: {
|
|
16479
17174
|
expand?: string;
|
|
16480
17175
|
fields?: string;
|
|
16481
17176
|
}): Promise<DataResponse<Refund>>;
|
|
16482
|
-
create(orderId: string, body: CreateBody$
|
|
17177
|
+
create(orderId: string, body: CreateBody$f, options?: ResourceRequestOptions): Promise<DataResponse<Refund>>;
|
|
16483
17178
|
listByOrder(orderId: string): Promise<DataResponse<Refund[]>>;
|
|
16484
17179
|
retry(id: string): Promise<DataResponse<Refund>>;
|
|
16485
17180
|
/**
|
|
@@ -16490,24 +17185,24 @@ declare class RefundsResource {
|
|
|
16490
17185
|
}
|
|
16491
17186
|
|
|
16492
17187
|
type Return = components['schemas']['Return'];
|
|
16493
|
-
type ListParams$
|
|
16494
|
-
type CreateBody$
|
|
17188
|
+
type ListParams$k = NonNullable<operations['listReturns']['parameters']['query']>;
|
|
17189
|
+
type CreateBody$e = NonNullable<operations['createOrderReturn']['requestBody']>['content']['application/json'];
|
|
16495
17190
|
type ApproveBody = NonNullable<operations['approveReturn']['requestBody']>['content']['application/json'];
|
|
16496
17191
|
type ReceiveBody$1 = NonNullable<operations['receiveReturn']['requestBody']>['content']['application/json'];
|
|
16497
17192
|
type RejectBody = NonNullable<operations['rejectReturn']['requestBody']>['content']['application/json'];
|
|
16498
17193
|
declare class ReturnsResource {
|
|
16499
17194
|
private client;
|
|
16500
17195
|
constructor(client: Hydra);
|
|
16501
|
-
list(params?: ListParams$
|
|
16502
|
-
iterate(params?: Omit<ListParams$
|
|
16503
|
-
toArray(params?: Omit<ListParams$
|
|
17196
|
+
list(params?: ListParams$k): Promise<ListResponse<Return>>;
|
|
17197
|
+
iterate(params?: Omit<ListParams$k, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Return, void, undefined>;
|
|
17198
|
+
toArray(params?: Omit<ListParams$k, 'cursor'>, options?: PaginateOptions & {
|
|
16504
17199
|
limit?: number;
|
|
16505
17200
|
}): Promise<Return[]>;
|
|
16506
17201
|
get(id: string, params?: {
|
|
16507
17202
|
expand?: string;
|
|
16508
17203
|
fields?: string;
|
|
16509
17204
|
}): Promise<DataResponse<Return>>;
|
|
16510
|
-
create(orderId: string, body: CreateBody$
|
|
17205
|
+
create(orderId: string, body: CreateBody$e, options?: ResourceRequestOptions): Promise<DataResponse<Return>>;
|
|
16511
17206
|
listByOrder(orderId: string): Promise<DataResponse<Return[]>>;
|
|
16512
17207
|
approve(id: string, body?: ApproveBody): Promise<DataResponse<Return>>;
|
|
16513
17208
|
receive(id: string, body?: ReceiveBody$1): Promise<DataResponse<Return>>;
|
|
@@ -16519,17 +17214,17 @@ declare class ReturnsResource {
|
|
|
16519
17214
|
type DraftOrder = components['schemas']['DraftOrder'];
|
|
16520
17215
|
type DraftOrderLineItem = components['schemas']['DraftOrderLineItem'];
|
|
16521
17216
|
type Order = components['schemas']['Order'];
|
|
16522
|
-
type ListParams$
|
|
16523
|
-
type CreateBody$
|
|
16524
|
-
type UpdateBody$
|
|
17217
|
+
type ListParams$j = NonNullable<operations['listDraftOrders']['parameters']['query']>;
|
|
17218
|
+
type CreateBody$d = NonNullable<operations['createDraftOrder']['requestBody']>['content']['application/json'];
|
|
17219
|
+
type UpdateBody$f = NonNullable<operations['updateDraftOrder']['requestBody']>['content']['application/json'];
|
|
16525
17220
|
type AddItemsBody = NonNullable<operations['addDraftOrderItems']['requestBody']>['content']['application/json'];
|
|
16526
17221
|
type UpdateItemBody$2 = NonNullable<operations['updateDraftOrderItem']['requestBody']>['content']['application/json'];
|
|
16527
17222
|
declare class DraftOrdersResource {
|
|
16528
17223
|
private client;
|
|
16529
17224
|
constructor(client: Hydra);
|
|
16530
|
-
list(params?: ListParams$
|
|
16531
|
-
iterate(params?: Omit<ListParams$
|
|
16532
|
-
toArray(params?: Omit<ListParams$
|
|
17225
|
+
list(params?: ListParams$j): Promise<ListResponse<DraftOrder>>;
|
|
17226
|
+
iterate(params?: Omit<ListParams$j, 'cursor'>, options?: PaginateOptions): AsyncGenerator<DraftOrder, void, undefined>;
|
|
17227
|
+
toArray(params?: Omit<ListParams$j, 'cursor'>, options?: PaginateOptions & {
|
|
16533
17228
|
limit?: number;
|
|
16534
17229
|
}): Promise<DraftOrder[]>;
|
|
16535
17230
|
get(id: string, params?: {
|
|
@@ -16537,8 +17232,8 @@ declare class DraftOrdersResource {
|
|
|
16537
17232
|
currency?: string;
|
|
16538
17233
|
fields?: string;
|
|
16539
17234
|
}): Promise<DataResponse<DraftOrder>>;
|
|
16540
|
-
create(body: CreateBody$
|
|
16541
|
-
update(id: string, body: UpdateBody$
|
|
17235
|
+
create(body: CreateBody$d, options?: ResourceRequestOptions): Promise<DataResponse<DraftOrder>>;
|
|
17236
|
+
update(id: string, body: UpdateBody$f): Promise<DataResponse<DraftOrder>>;
|
|
16542
17237
|
delete(id: string): Promise<void>;
|
|
16543
17238
|
addItems(draftOrderId: string, body: AddItemsBody): Promise<DataResponse<DraftOrderLineItem[]>>;
|
|
16544
17239
|
updateItem(draftOrderId: string, itemId: string, body: UpdateItemBody$2): Promise<DataResponse<DraftOrderLineItem>>;
|
|
@@ -16553,22 +17248,22 @@ declare class DraftOrdersResource {
|
|
|
16553
17248
|
}
|
|
16554
17249
|
|
|
16555
17250
|
type Customer = components['schemas']['Customer'];
|
|
16556
|
-
type ListParams$
|
|
16557
|
-
type CreateBody$
|
|
16558
|
-
type UpdateBody$
|
|
17251
|
+
type ListParams$i = NonNullable<operations['listCustomers']['parameters']['query']>;
|
|
17252
|
+
type CreateBody$c = NonNullable<operations['createCustomer']['requestBody']>['content']['application/json'];
|
|
17253
|
+
type UpdateBody$e = NonNullable<operations['updateCustomer']['requestBody']>['content']['application/json'];
|
|
16559
17254
|
type CreateAddressBody$1 = NonNullable<operations['createCustomerAddress']['requestBody']>['content']['application/json'];
|
|
16560
17255
|
type CreateNoteBody$1 = NonNullable<operations['createCustomerNote']['requestBody']>['content']['application/json'];
|
|
16561
17256
|
declare class CustomersResource {
|
|
16562
17257
|
private client;
|
|
16563
17258
|
constructor(client: Hydra);
|
|
16564
|
-
list(params?: ListParams$
|
|
16565
|
-
iterate(params?: Omit<ListParams$
|
|
16566
|
-
toArray(params?: Omit<ListParams$
|
|
17259
|
+
list(params?: ListParams$i): Promise<ListResponse<Customer>>;
|
|
17260
|
+
iterate(params?: Omit<ListParams$i, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Customer, void, undefined>;
|
|
17261
|
+
toArray(params?: Omit<ListParams$i, 'cursor'>, options?: PaginateOptions & {
|
|
16567
17262
|
limit?: number;
|
|
16568
17263
|
}): Promise<Customer[]>;
|
|
16569
|
-
get(id: string, params?: Pick<ListParams$
|
|
16570
|
-
create(body: CreateBody$
|
|
16571
|
-
update(id: string, body: UpdateBody$
|
|
17264
|
+
get(id: string, params?: Pick<ListParams$i, 'expand' | 'fields'>): Promise<DataResponse<Customer>>;
|
|
17265
|
+
create(body: CreateBody$c, options?: ResourceRequestOptions): Promise<DataResponse<Customer>>;
|
|
17266
|
+
update(id: string, body: UpdateBody$e): Promise<DataResponse<Customer>>;
|
|
16572
17267
|
delete(id: string): Promise<void>;
|
|
16573
17268
|
listAddresses(customerId: string): Promise<DataResponse<unknown[]>>;
|
|
16574
17269
|
createAddress(customerId: string, body: CreateAddressBody$1): Promise<DataResponse<unknown>>;
|
|
@@ -16582,38 +17277,38 @@ declare class CustomersResource {
|
|
|
16582
17277
|
}
|
|
16583
17278
|
|
|
16584
17279
|
type CustomerGroup = components['schemas']['CustomerGroup'];
|
|
16585
|
-
type ListParams$
|
|
16586
|
-
type CreateBody$
|
|
16587
|
-
type UpdateBody$
|
|
17280
|
+
type ListParams$h = NonNullable<operations['listCustomerGroups']['parameters']['query']>;
|
|
17281
|
+
type CreateBody$b = NonNullable<operations['createCustomerGroup']['requestBody']>['content']['application/json'];
|
|
17282
|
+
type UpdateBody$d = NonNullable<operations['updateCustomerGroup']['requestBody']>['content']['application/json'];
|
|
16588
17283
|
type AddMembersBody = NonNullable<operations['addCustomerGroupMembers']['requestBody']>['content']['application/json'];
|
|
16589
17284
|
declare class CustomerGroupsResource {
|
|
16590
17285
|
private client;
|
|
16591
17286
|
constructor(client: Hydra);
|
|
16592
|
-
list(params?: ListParams$
|
|
16593
|
-
iterate(params?: Omit<ListParams$
|
|
16594
|
-
toArray(params?: Omit<ListParams$
|
|
17287
|
+
list(params?: ListParams$h): Promise<ListResponse<CustomerGroup>>;
|
|
17288
|
+
iterate(params?: Omit<ListParams$h, 'cursor'>, options?: PaginateOptions): AsyncGenerator<CustomerGroup, void, undefined>;
|
|
17289
|
+
toArray(params?: Omit<ListParams$h, 'cursor'>, options?: PaginateOptions & {
|
|
16595
17290
|
limit?: number;
|
|
16596
17291
|
}): Promise<CustomerGroup[]>;
|
|
16597
17292
|
get(id: string): Promise<DataResponse<CustomerGroup>>;
|
|
16598
|
-
create(body: CreateBody$
|
|
16599
|
-
update(id: string, body: UpdateBody$
|
|
17293
|
+
create(body: CreateBody$b, options?: ResourceRequestOptions): Promise<DataResponse<CustomerGroup>>;
|
|
17294
|
+
update(id: string, body: UpdateBody$d): Promise<DataResponse<CustomerGroup>>;
|
|
16600
17295
|
delete(id: string): Promise<void>;
|
|
16601
17296
|
addMembers(groupId: string, body: AddMembersBody): Promise<void>;
|
|
16602
17297
|
removeMember(groupId: string, customerId: string): Promise<void>;
|
|
16603
17298
|
}
|
|
16604
17299
|
|
|
16605
|
-
type UpdateBody$
|
|
17300
|
+
type UpdateBody$c = NonNullable<operations['updateAddress']['requestBody']>['content']['application/json'];
|
|
16606
17301
|
declare class AddressesResource {
|
|
16607
17302
|
private client;
|
|
16608
17303
|
constructor(client: Hydra);
|
|
16609
|
-
update(id: string, body: UpdateBody$
|
|
17304
|
+
update(id: string, body: UpdateBody$c): Promise<DataResponse<unknown>>;
|
|
16610
17305
|
delete(id: string): Promise<void>;
|
|
16611
17306
|
}
|
|
16612
17307
|
|
|
16613
17308
|
type InventoryLevel = components['schemas']['InventoryLevel'];
|
|
16614
17309
|
type InventoryAdjustment = components['schemas']['InventoryAdjustment'];
|
|
16615
17310
|
type ProductAdjustment = components['schemas']['ProductAdjustment'];
|
|
16616
|
-
type ListParams$
|
|
17311
|
+
type ListParams$g = NonNullable<operations['listInventory']['parameters']['query']>;
|
|
16617
17312
|
type SetBody = NonNullable<operations['setInventory']['requestBody']>['content']['application/json'];
|
|
16618
17313
|
type AdjustBody = NonNullable<operations['adjustInventory']['requestBody']>['content']['application/json'];
|
|
16619
17314
|
type InventoryResult = InventoryLevel & {
|
|
@@ -16622,9 +17317,9 @@ type InventoryResult = InventoryLevel & {
|
|
|
16622
17317
|
declare class InventoryResource {
|
|
16623
17318
|
private client;
|
|
16624
17319
|
constructor(client: Hydra);
|
|
16625
|
-
list(params?: ListParams$
|
|
16626
|
-
iterate(params?: Omit<ListParams$
|
|
16627
|
-
toArray(params?: Omit<ListParams$
|
|
17320
|
+
list(params?: ListParams$g): Promise<ListResponse<InventoryLevel>>;
|
|
17321
|
+
iterate(params?: Omit<ListParams$g, 'cursor'>, options?: PaginateOptions): AsyncGenerator<InventoryLevel, void, undefined>;
|
|
17322
|
+
toArray(params?: Omit<ListParams$g, 'cursor'>, options?: PaginateOptions & {
|
|
16628
17323
|
limit?: number;
|
|
16629
17324
|
}): Promise<InventoryLevel[]>;
|
|
16630
17325
|
listAdjustments(params: {
|
|
@@ -16696,90 +17391,90 @@ declare class ShippingResource {
|
|
|
16696
17391
|
}
|
|
16697
17392
|
|
|
16698
17393
|
type Promotion = components['schemas']['Promotion'];
|
|
16699
|
-
type ListParams$
|
|
16700
|
-
type CreateBody$
|
|
16701
|
-
type UpdateBody$
|
|
17394
|
+
type ListParams$f = NonNullable<operations['listPromotions']['parameters']['query']>;
|
|
17395
|
+
type CreateBody$a = NonNullable<operations['createPromotion']['requestBody']>['content']['application/json'];
|
|
17396
|
+
type UpdateBody$b = NonNullable<operations['updatePromotion']['requestBody']>['content']['application/json'];
|
|
16702
17397
|
declare class PromotionsResource {
|
|
16703
17398
|
private client;
|
|
16704
17399
|
constructor(client: Hydra);
|
|
16705
|
-
list(params?: ListParams$
|
|
16706
|
-
iterate(params?: Omit<ListParams$
|
|
16707
|
-
toArray(params?: Omit<ListParams$
|
|
17400
|
+
list(params?: ListParams$f): Promise<ListResponse<Promotion>>;
|
|
17401
|
+
iterate(params?: Omit<ListParams$f, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Promotion, void, undefined>;
|
|
17402
|
+
toArray(params?: Omit<ListParams$f, 'cursor'>, options?: PaginateOptions & {
|
|
16708
17403
|
limit?: number;
|
|
16709
17404
|
}): Promise<Promotion[]>;
|
|
16710
17405
|
get(id: string): Promise<DataResponse<Promotion>>;
|
|
16711
|
-
create(body: CreateBody$
|
|
16712
|
-
update(id: string, body: UpdateBody$
|
|
17406
|
+
create(body: CreateBody$a, options?: ResourceRequestOptions): Promise<DataResponse<Promotion>>;
|
|
17407
|
+
update(id: string, body: UpdateBody$b): Promise<DataResponse<Promotion>>;
|
|
16713
17408
|
delete(id: string): Promise<void>;
|
|
16714
17409
|
}
|
|
16715
17410
|
|
|
16716
17411
|
type Discount = components['schemas']['Discount'];
|
|
16717
|
-
type ListParams$
|
|
16718
|
-
type CreateBody$
|
|
16719
|
-
type UpdateBody$
|
|
17412
|
+
type ListParams$e = NonNullable<operations['listDiscounts']['parameters']['query']>;
|
|
17413
|
+
type CreateBody$9 = NonNullable<operations['createDiscount']['requestBody']>['content']['application/json'];
|
|
17414
|
+
type UpdateBody$a = NonNullable<operations['updateDiscount']['requestBody']>['content']['application/json'];
|
|
16720
17415
|
declare class DiscountsResource {
|
|
16721
17416
|
private client;
|
|
16722
17417
|
constructor(client: Hydra);
|
|
16723
|
-
list(params?: ListParams$
|
|
16724
|
-
iterate(params?: Omit<ListParams$
|
|
16725
|
-
toArray(params?: Omit<ListParams$
|
|
17418
|
+
list(params?: ListParams$e): Promise<ListResponse<Discount>>;
|
|
17419
|
+
iterate(params?: Omit<ListParams$e, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Discount, void, undefined>;
|
|
17420
|
+
toArray(params?: Omit<ListParams$e, 'cursor'>, options?: PaginateOptions & {
|
|
16726
17421
|
limit?: number;
|
|
16727
17422
|
}): Promise<Discount[]>;
|
|
16728
17423
|
get(id: string): Promise<DataResponse<Discount>>;
|
|
16729
|
-
create(body: CreateBody$
|
|
16730
|
-
update(id: string, body: UpdateBody$
|
|
17424
|
+
create(body: CreateBody$9, options?: ResourceRequestOptions): Promise<DataResponse<Discount>>;
|
|
17425
|
+
update(id: string, body: UpdateBody$a): Promise<DataResponse<Discount>>;
|
|
16731
17426
|
delete(id: string): Promise<void>;
|
|
16732
17427
|
}
|
|
16733
17428
|
|
|
16734
17429
|
type Image = components['schemas']['Image'];
|
|
16735
|
-
type ListParams$
|
|
16736
|
-
type UpdateBody$
|
|
16737
|
-
type ReorderBody$
|
|
17430
|
+
type ListParams$d = NonNullable<operations['listImages']['parameters']['query']>;
|
|
17431
|
+
type UpdateBody$9 = NonNullable<operations['updateImage']['requestBody']>['content']['application/json'];
|
|
17432
|
+
type ReorderBody$2 = NonNullable<operations['reorderImages']['requestBody']>['content']['application/json'];
|
|
16738
17433
|
declare class ImagesResource {
|
|
16739
17434
|
private client;
|
|
16740
17435
|
constructor(client: Hydra);
|
|
16741
|
-
list(params?: ListParams$
|
|
16742
|
-
iterate(params?: Omit<ListParams$
|
|
16743
|
-
toArray(params?: Omit<ListParams$
|
|
17436
|
+
list(params?: ListParams$d): Promise<ListResponse<Image>>;
|
|
17437
|
+
iterate(params?: Omit<ListParams$d, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Image, void, undefined>;
|
|
17438
|
+
toArray(params?: Omit<ListParams$d, 'cursor'>, options?: PaginateOptions & {
|
|
16744
17439
|
limit?: number;
|
|
16745
17440
|
}): Promise<Image[]>;
|
|
16746
17441
|
/** Upload an image to the store library */
|
|
16747
17442
|
upload(formData: FormData): Promise<DataResponse<Image>>;
|
|
16748
|
-
update(id: string, body: UpdateBody$
|
|
17443
|
+
update(id: string, body: UpdateBody$9): Promise<DataResponse<Image>>;
|
|
16749
17444
|
delete(id: string): Promise<void>;
|
|
16750
17445
|
detach(id: string): Promise<void>;
|
|
16751
17446
|
batchDelete(imageIds: string[]): Promise<void>;
|
|
16752
17447
|
batchDetach(imageIds: string[]): Promise<void>;
|
|
16753
|
-
reorder(body: ReorderBody$
|
|
17448
|
+
reorder(body: ReorderBody$2): Promise<void>;
|
|
16754
17449
|
}
|
|
16755
17450
|
|
|
16756
17451
|
type Webhook = components['schemas']['Webhook'];
|
|
16757
|
-
type ListParams$
|
|
16758
|
-
type CreateBody$
|
|
16759
|
-
type UpdateBody$
|
|
17452
|
+
type ListParams$c = NonNullable<operations['listWebhooks']['parameters']['query']>;
|
|
17453
|
+
type CreateBody$8 = NonNullable<operations['createWebhook']['requestBody']>['content']['application/json'];
|
|
17454
|
+
type UpdateBody$8 = NonNullable<operations['updateWebhook']['requestBody']>['content']['application/json'];
|
|
16760
17455
|
declare class WebhooksResource {
|
|
16761
17456
|
private client;
|
|
16762
17457
|
constructor(client: Hydra);
|
|
16763
|
-
list(params?: ListParams$
|
|
16764
|
-
iterate(params?: Omit<ListParams$
|
|
16765
|
-
toArray(params?: Omit<ListParams$
|
|
17458
|
+
list(params?: ListParams$c): Promise<ListResponse<Webhook>>;
|
|
17459
|
+
iterate(params?: Omit<ListParams$c, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Webhook, void, undefined>;
|
|
17460
|
+
toArray(params?: Omit<ListParams$c, 'cursor'>, options?: PaginateOptions & {
|
|
16766
17461
|
limit?: number;
|
|
16767
17462
|
}): Promise<Webhook[]>;
|
|
16768
17463
|
get(id: string): Promise<DataResponse<Webhook>>;
|
|
16769
|
-
create(body: CreateBody$
|
|
16770
|
-
update(id: string, body: UpdateBody$
|
|
17464
|
+
create(body: CreateBody$8, options?: ResourceRequestOptions): Promise<DataResponse<Webhook>>;
|
|
17465
|
+
update(id: string, body: UpdateBody$8): Promise<DataResponse<Webhook>>;
|
|
16771
17466
|
delete(id: string): Promise<void>;
|
|
16772
17467
|
}
|
|
16773
17468
|
|
|
16774
17469
|
type Store = components['schemas']['Store'];
|
|
16775
|
-
type UpdateBody$
|
|
17470
|
+
type UpdateBody$7 = NonNullable<operations['updateStore']['requestBody']>['content']['application/json'];
|
|
16776
17471
|
declare class StoreResource {
|
|
16777
17472
|
private client;
|
|
16778
17473
|
constructor(client: Hydra);
|
|
16779
17474
|
get(params?: {
|
|
16780
17475
|
fields?: string;
|
|
16781
17476
|
}): Promise<DataResponse<Store>>;
|
|
16782
|
-
update(body: UpdateBody$
|
|
17477
|
+
update(body: UpdateBody$7): Promise<DataResponse<Store>>;
|
|
16783
17478
|
getDomainRecord(): Promise<DataResponse<unknown>>;
|
|
16784
17479
|
verifyDomain(): Promise<DataResponse<unknown>>;
|
|
16785
17480
|
publish(): Promise<DataResponse<{
|
|
@@ -16791,42 +17486,42 @@ declare class StoreResource {
|
|
|
16791
17486
|
}
|
|
16792
17487
|
|
|
16793
17488
|
type Tag = components['schemas']['Tag'];
|
|
16794
|
-
type ListParams$
|
|
16795
|
-
type CreateBody$
|
|
16796
|
-
type UpdateBody$
|
|
17489
|
+
type ListParams$b = NonNullable<operations['listTags']['parameters']['query']>;
|
|
17490
|
+
type CreateBody$7 = NonNullable<operations['createTag']['requestBody']>['content']['application/json'];
|
|
17491
|
+
type UpdateBody$6 = NonNullable<operations['updateTag']['requestBody']>['content']['application/json'];
|
|
16797
17492
|
declare class TagsResource {
|
|
16798
17493
|
private client;
|
|
16799
17494
|
constructor(client: Hydra);
|
|
16800
|
-
list(params?: ListParams$
|
|
16801
|
-
iterate(params?: Omit<ListParams$
|
|
16802
|
-
toArray(params?: Omit<ListParams$
|
|
17495
|
+
list(params?: ListParams$b): Promise<ListResponse<Tag>>;
|
|
17496
|
+
iterate(params?: Omit<ListParams$b, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Tag, void, undefined>;
|
|
17497
|
+
toArray(params?: Omit<ListParams$b, 'cursor'>, options?: PaginateOptions & {
|
|
16803
17498
|
limit?: number;
|
|
16804
17499
|
}): Promise<Tag[]>;
|
|
16805
|
-
create(body: CreateBody$
|
|
16806
|
-
update(id: string, body: UpdateBody$
|
|
17500
|
+
create(body: CreateBody$7, options?: ResourceRequestOptions): Promise<DataResponse<Tag>>;
|
|
17501
|
+
update(id: string, body: UpdateBody$6): Promise<DataResponse<Tag>>;
|
|
16807
17502
|
delete(id: string): Promise<void>;
|
|
16808
17503
|
}
|
|
16809
17504
|
|
|
16810
17505
|
type Redirect = components['schemas']['Redirect'];
|
|
16811
|
-
type ListParams$
|
|
16812
|
-
type CreateBody$
|
|
17506
|
+
type ListParams$a = NonNullable<operations['listRedirects']['parameters']['query']>;
|
|
17507
|
+
type CreateBody$6 = NonNullable<operations['createRedirect']['requestBody']>['content']['application/json'];
|
|
16813
17508
|
declare class RedirectsResource {
|
|
16814
17509
|
private client;
|
|
16815
17510
|
constructor(client: Hydra);
|
|
16816
|
-
list(params?: ListParams$
|
|
16817
|
-
iterate(params?: Omit<ListParams$
|
|
16818
|
-
toArray(params?: Omit<ListParams$
|
|
17511
|
+
list(params?: ListParams$a): Promise<ListResponse<Redirect>>;
|
|
17512
|
+
iterate(params?: Omit<ListParams$a, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Redirect, void, undefined>;
|
|
17513
|
+
toArray(params?: Omit<ListParams$a, 'cursor'>, options?: PaginateOptions & {
|
|
16819
17514
|
limit?: number;
|
|
16820
17515
|
}): Promise<Redirect[]>;
|
|
16821
|
-
create(body: CreateBody$
|
|
17516
|
+
create(body: CreateBody$6, options?: ResourceRequestOptions): Promise<DataResponse<Redirect>>;
|
|
16822
17517
|
lookup(path: string): Promise<DataResponse<Redirect>>;
|
|
16823
17518
|
delete(id: string): Promise<void>;
|
|
16824
17519
|
}
|
|
16825
17520
|
|
|
16826
17521
|
type Company = components['schemas']['Company'];
|
|
16827
|
-
type ListParams$
|
|
16828
|
-
type CreateBody$
|
|
16829
|
-
type UpdateBody$
|
|
17522
|
+
type ListParams$9 = NonNullable<operations['listCompanies']['parameters']['query']>;
|
|
17523
|
+
type CreateBody$5 = NonNullable<operations['createCompany']['requestBody']>['content']['application/json'];
|
|
17524
|
+
type UpdateBody$5 = NonNullable<operations['updateCompany']['requestBody']>['content']['application/json'];
|
|
16830
17525
|
type CreateAddressBody = NonNullable<operations['createCompanyAddress']['requestBody']>['content']['application/json'];
|
|
16831
17526
|
type UpdateAddressBody = NonNullable<operations['updateCompanyAddress']['requestBody']>['content']['application/json'];
|
|
16832
17527
|
type CreateContactBody = NonNullable<operations['createCompanyContact']['requestBody']>['content']['application/json'];
|
|
@@ -16835,14 +17530,14 @@ type CreateNoteBody = NonNullable<operations['createCompanyNote']['requestBody']
|
|
|
16835
17530
|
declare class CompaniesResource {
|
|
16836
17531
|
private client;
|
|
16837
17532
|
constructor(client: Hydra);
|
|
16838
|
-
list(params?: ListParams$
|
|
16839
|
-
iterate(params?: Omit<ListParams$
|
|
16840
|
-
toArray(params?: Omit<ListParams$
|
|
17533
|
+
list(params?: ListParams$9): Promise<ListResponse<Company>>;
|
|
17534
|
+
iterate(params?: Omit<ListParams$9, 'cursor'>, options?: PaginateOptions): AsyncGenerator<Company, void, undefined>;
|
|
17535
|
+
toArray(params?: Omit<ListParams$9, 'cursor'>, options?: PaginateOptions & {
|
|
16841
17536
|
limit?: number;
|
|
16842
17537
|
}): Promise<Company[]>;
|
|
16843
|
-
get(id: string, params?: Pick<ListParams$
|
|
16844
|
-
create(body: CreateBody$
|
|
16845
|
-
update(id: string, body: UpdateBody$
|
|
17538
|
+
get(id: string, params?: Pick<ListParams$9, 'expand' | 'fields'>): Promise<DataResponse<Company>>;
|
|
17539
|
+
create(body: CreateBody$5, options?: ResourceRequestOptions): Promise<DataResponse<Company>>;
|
|
17540
|
+
update(id: string, body: UpdateBody$5): Promise<DataResponse<Company>>;
|
|
16846
17541
|
delete(id: string): Promise<void>;
|
|
16847
17542
|
listAddresses(companyId: string): Promise<DataResponse<unknown[]>>;
|
|
16848
17543
|
createAddress(companyId: string, body: CreateAddressBody): Promise<DataResponse<unknown>>;
|
|
@@ -16858,23 +17553,23 @@ declare class CompaniesResource {
|
|
|
16858
17553
|
}
|
|
16859
17554
|
|
|
16860
17555
|
type PurchaseOrder = components['schemas']['PurchaseOrder'];
|
|
16861
|
-
type ListParams$
|
|
16862
|
-
type CreateBody$
|
|
16863
|
-
type UpdateBody$
|
|
17556
|
+
type ListParams$8 = NonNullable<operations['listPurchaseOrders']['parameters']['query']>;
|
|
17557
|
+
type CreateBody$4 = NonNullable<operations['createPurchaseOrder']['requestBody']>['content']['application/json'];
|
|
17558
|
+
type UpdateBody$4 = NonNullable<operations['updatePurchaseOrder']['requestBody']>['content']['application/json'];
|
|
16864
17559
|
type AddItemBody = NonNullable<operations['addPurchaseOrderItems']['requestBody']>['content']['application/json'];
|
|
16865
17560
|
type UpdateItemBody$1 = NonNullable<operations['updatePurchaseOrderItem']['requestBody']>['content']['application/json'];
|
|
16866
17561
|
type ReceiveBody = NonNullable<operations['receivePurchaseOrderItems']['requestBody']>['content']['application/json'];
|
|
16867
17562
|
declare class PurchaseOrdersResource {
|
|
16868
17563
|
private client;
|
|
16869
17564
|
constructor(client: Hydra);
|
|
16870
|
-
list(params?: ListParams$
|
|
16871
|
-
iterate(params?: Omit<ListParams$
|
|
16872
|
-
toArray(params?: Omit<ListParams$
|
|
17565
|
+
list(params?: ListParams$8): Promise<ListResponse<PurchaseOrder>>;
|
|
17566
|
+
iterate(params?: Omit<ListParams$8, 'cursor'>, options?: PaginateOptions): AsyncGenerator<PurchaseOrder, void, undefined>;
|
|
17567
|
+
toArray(params?: Omit<ListParams$8, 'cursor'>, options?: PaginateOptions & {
|
|
16873
17568
|
limit?: number;
|
|
16874
17569
|
}): Promise<PurchaseOrder[]>;
|
|
16875
|
-
get(id: string, params?: Pick<ListParams$
|
|
16876
|
-
create(body: CreateBody$
|
|
16877
|
-
update(id: string, body: UpdateBody$
|
|
17570
|
+
get(id: string, params?: Pick<ListParams$8, 'expand' | 'fields'>): Promise<DataResponse<PurchaseOrder>>;
|
|
17571
|
+
create(body: CreateBody$4, options?: ResourceRequestOptions): Promise<DataResponse<PurchaseOrder>>;
|
|
17572
|
+
update(id: string, body: UpdateBody$4): Promise<DataResponse<PurchaseOrder>>;
|
|
16878
17573
|
delete(id: string): Promise<void>;
|
|
16879
17574
|
addItem(purchaseOrderId: string, body: AddItemBody): Promise<DataResponse<unknown>>;
|
|
16880
17575
|
updateItem(purchaseOrderId: string, itemId: string, body: UpdateItemBody$1): Promise<DataResponse<unknown>>;
|
|
@@ -16897,19 +17592,19 @@ declare class FulfillmentOrdersResource {
|
|
|
16897
17592
|
listForOrder(orderId: string): Promise<DataResponse<FulfillmentOrder[]>>;
|
|
16898
17593
|
}
|
|
16899
17594
|
|
|
16900
|
-
type ListParams$
|
|
16901
|
-
type CreateBody$
|
|
16902
|
-
type UpdateBody$
|
|
16903
|
-
type ReorderBody = NonNullable<operations['reorderMetafieldDefinitions']['requestBody']>['content']['application/json'];
|
|
17595
|
+
type ListParams$7 = NonNullable<operations['listMetafieldDefinitions']['parameters']['query']>;
|
|
17596
|
+
type CreateBody$3 = NonNullable<operations['createMetafieldDefinition']['requestBody']>['content']['application/json'];
|
|
17597
|
+
type UpdateBody$3 = NonNullable<operations['updateMetafieldDefinition']['requestBody']>['content']['application/json'];
|
|
17598
|
+
type ReorderBody$1 = NonNullable<operations['reorderMetafieldDefinitions']['requestBody']>['content']['application/json'];
|
|
16904
17599
|
declare class MetafieldsResource {
|
|
16905
17600
|
private client;
|
|
16906
17601
|
constructor(client: Hydra);
|
|
16907
17602
|
/** List metafield definitions for the store */
|
|
16908
|
-
listDefinitions(params?: ListParams$
|
|
16909
|
-
createDefinition(body: CreateBody$
|
|
16910
|
-
updateDefinition(ownerType: string, slug: string, body: UpdateBody$
|
|
17603
|
+
listDefinitions(params?: ListParams$7): Promise<DataResponse<unknown[]>>;
|
|
17604
|
+
createDefinition(body: CreateBody$3): Promise<DataResponse<unknown>>;
|
|
17605
|
+
updateDefinition(ownerType: string, slug: string, body: UpdateBody$3): Promise<DataResponse<unknown>>;
|
|
16911
17606
|
archiveDefinition(ownerType: string, slug: string): Promise<void>;
|
|
16912
|
-
reorderDefinitions(ownerType: string, body: ReorderBody): Promise<void>;
|
|
17607
|
+
reorderDefinitions(ownerType: string, body: ReorderBody$1): Promise<void>;
|
|
16913
17608
|
}
|
|
16914
17609
|
|
|
16915
17610
|
type TaxGroup = components['schemas']['TaxGroup'];
|
|
@@ -16953,14 +17648,35 @@ declare class TaxResource {
|
|
|
16953
17648
|
}
|
|
16954
17649
|
|
|
16955
17650
|
type ExchangeRate = components['schemas']['ExchangeRate'];
|
|
16956
|
-
type ListParams$
|
|
17651
|
+
type ListParams$6 = NonNullable<operations['listExchangeRates']['parameters']['query']>;
|
|
16957
17652
|
declare class ExchangeRatesResource {
|
|
16958
17653
|
private client;
|
|
16959
17654
|
constructor(client: Hydra);
|
|
16960
|
-
list(params?: ListParams$
|
|
17655
|
+
list(params?: ListParams$6): Promise<DataResponse<ExchangeRate[]>>;
|
|
16961
17656
|
refresh(): Promise<DataResponse<unknown>>;
|
|
16962
17657
|
}
|
|
16963
17658
|
|
|
17659
|
+
type FilterAttribute = components['schemas']['FilterAttribute'];
|
|
17660
|
+
type ListParams$5 = NonNullable<operations['listFilterAttributes']['parameters']['query']>;
|
|
17661
|
+
type CreateBody$2 = NonNullable<operations['createFilterAttribute']['requestBody']>['content']['application/json'];
|
|
17662
|
+
type UpdateBody$2 = NonNullable<operations['updateFilterAttribute']['requestBody']>['content']['application/json'];
|
|
17663
|
+
type ReorderBody = NonNullable<operations['reorderFilterAttributes']['requestBody']>['content']['application/json'];
|
|
17664
|
+
declare class FilterAttributesResource {
|
|
17665
|
+
private client;
|
|
17666
|
+
constructor(client: Hydra);
|
|
17667
|
+
list(params?: ListParams$5): Promise<ListResponse<FilterAttribute>>;
|
|
17668
|
+
iterate(params?: Omit<ListParams$5, 'cursor'>, options?: PaginateOptions): AsyncGenerator<FilterAttribute, void, undefined>;
|
|
17669
|
+
toArray(params?: Omit<ListParams$5, 'cursor'>, options?: PaginateOptions & {
|
|
17670
|
+
limit?: number;
|
|
17671
|
+
}): Promise<FilterAttribute[]>;
|
|
17672
|
+
get(id: string): Promise<DataResponse<FilterAttribute>>;
|
|
17673
|
+
create(body: CreateBody$2, options?: ResourceRequestOptions): Promise<DataResponse<FilterAttribute>>;
|
|
17674
|
+
update(id: string, body: UpdateBody$2): Promise<DataResponse<FilterAttribute>>;
|
|
17675
|
+
delete(id: string): Promise<void>;
|
|
17676
|
+
reorder(body: ReorderBody): Promise<ListResponse<FilterAttribute>>;
|
|
17677
|
+
discover(): Promise<DataResponse<unknown[]>>;
|
|
17678
|
+
}
|
|
17679
|
+
|
|
16964
17680
|
type NavigationMenu = components['schemas']['NavigationMenu'];
|
|
16965
17681
|
type NavigationItem = components['schemas']['NavigationItem'];
|
|
16966
17682
|
type ListParams$4 = NonNullable<operations['listNavigationMenus']['parameters']['query']>;
|
|
@@ -17210,6 +17926,7 @@ declare class Hydra {
|
|
|
17210
17926
|
readonly metafields: MetafieldsResource;
|
|
17211
17927
|
readonly tax: TaxResource;
|
|
17212
17928
|
readonly exchangeRates: ExchangeRatesResource;
|
|
17929
|
+
readonly filterAttributes: FilterAttributesResource;
|
|
17213
17930
|
readonly navigation: NavigationResource;
|
|
17214
17931
|
readonly notifications: NotificationsResource;
|
|
17215
17932
|
readonly analytics: AnalyticsResource;
|