@epcc-sdk/sdks-shopper 0.0.4 → 0.0.6
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/client/@tanstack/react-query.gen.d.ts +65 -3
- package/dist/client/@tanstack/react-query.gen.js +41 -1
- package/dist/client/sdk.gen.d.ts +25 -10
- package/dist/client/sdk.gen.js +26 -0
- package/dist/client/transformers.gen.d.ts +2 -1
- package/dist/client/transformers.gen.js +16 -0
- package/dist/client/types.gen.d.ts +442 -156
- package/package.json +3 -3
|
@@ -3171,6 +3171,15 @@ export type CartCheckoutTimestamps = {
|
|
|
3171
3171
|
*/
|
|
3172
3172
|
updated_at?: unknown;
|
|
3173
3173
|
};
|
|
3174
|
+
/**
|
|
3175
|
+
* Included is an array of resources that are included in the response.
|
|
3176
|
+
*/
|
|
3177
|
+
export type CartInclude = {
|
|
3178
|
+
/**
|
|
3179
|
+
* The cart items associated with a cart.
|
|
3180
|
+
*/
|
|
3181
|
+
items?: Array<CartItemObject>;
|
|
3182
|
+
};
|
|
3174
3183
|
/**
|
|
3175
3184
|
* Whether a plan is active on a subscription using that offering. The `active_plan` attribute is null if a plan is not active in a subscription.
|
|
3176
3185
|
*/
|
|
@@ -3197,13 +3206,13 @@ export type SubscriptionJobType = "subscription_job";
|
|
|
3197
3206
|
export type SubscriptionImportType = "subscription_import";
|
|
3198
3207
|
export type SubscriptionImportErrorType = "subscription_import_error";
|
|
3199
3208
|
export type SubscriptionImportError = {
|
|
3200
|
-
id:
|
|
3209
|
+
id: SubscriptionsUuid;
|
|
3201
3210
|
type: SubscriptionImportErrorType;
|
|
3202
3211
|
meta: SubscriptionImportErrorMeta;
|
|
3203
3212
|
};
|
|
3204
3213
|
export type SubscriptionImportErrorMeta = {
|
|
3205
3214
|
owner: string;
|
|
3206
|
-
timestamps:
|
|
3215
|
+
timestamps: SubscriptionsTimestamps;
|
|
3207
3216
|
error: string;
|
|
3208
3217
|
field: string;
|
|
3209
3218
|
/**
|
|
@@ -3230,16 +3239,6 @@ export type LinkObject = {
|
|
|
3230
3239
|
title?: string;
|
|
3231
3240
|
describedby?: string;
|
|
3232
3241
|
};
|
|
3233
|
-
export type Timestamps = {
|
|
3234
|
-
/**
|
|
3235
|
-
* The date and time a resource was updated.
|
|
3236
|
-
*/
|
|
3237
|
-
updated_at: string;
|
|
3238
|
-
/**
|
|
3239
|
-
* The date and time a resource was created.
|
|
3240
|
-
*/
|
|
3241
|
-
created_at: string;
|
|
3242
|
-
};
|
|
3243
3242
|
/**
|
|
3244
3243
|
* The status of a subscription, either `active` or `inactive`.
|
|
3245
3244
|
*/
|
|
@@ -3264,7 +3263,7 @@ export type SingleRelationship = {
|
|
|
3264
3263
|
links?: RelationshipLinks;
|
|
3265
3264
|
};
|
|
3266
3265
|
export type RelationshipData = {
|
|
3267
|
-
id:
|
|
3266
|
+
id: SubscriptionsUuid;
|
|
3268
3267
|
/**
|
|
3269
3268
|
* This represents the type of resource being returned.
|
|
3270
3269
|
*/
|
|
@@ -3375,21 +3374,21 @@ export type PriceFormatting = {
|
|
|
3375
3374
|
formatted: string;
|
|
3376
3375
|
};
|
|
3377
3376
|
export type Feature = {
|
|
3378
|
-
id?:
|
|
3377
|
+
id?: SubscriptionsUuid;
|
|
3379
3378
|
type: SubscriptionFeatureType;
|
|
3380
3379
|
attributes: FeatureResponseAttributes;
|
|
3381
3380
|
meta: FeatureMeta;
|
|
3382
3381
|
};
|
|
3383
3382
|
export type FeatureMeta = {
|
|
3384
3383
|
owner: OwnerMeta;
|
|
3385
|
-
timestamps:
|
|
3384
|
+
timestamps: SubscriptionsTimestamps;
|
|
3386
3385
|
};
|
|
3387
3386
|
export type FeatureCreate = {
|
|
3388
3387
|
type: SubscriptionFeatureType;
|
|
3389
3388
|
attributes: FeatureAttributes;
|
|
3390
3389
|
};
|
|
3391
3390
|
export type FeatureUpdate = {
|
|
3392
|
-
id:
|
|
3391
|
+
id: SubscriptionsUuid;
|
|
3393
3392
|
type: SubscriptionFeatureType;
|
|
3394
3393
|
attributes: FeatureUpdateAttributes;
|
|
3395
3394
|
};
|
|
@@ -3408,7 +3407,7 @@ export type FeaturePromotion = {
|
|
|
3408
3407
|
*/
|
|
3409
3408
|
name: string;
|
|
3410
3409
|
tag: FeatureTag;
|
|
3411
|
-
promotion_id?:
|
|
3410
|
+
promotion_id?: SubscriptionsUuid;
|
|
3412
3411
|
};
|
|
3413
3412
|
export type FeaturePromotionAttributes = {
|
|
3414
3413
|
type: "promotion";
|
|
@@ -3463,7 +3462,7 @@ export type FeatureUpdateAttributes = {
|
|
|
3463
3462
|
configuration?: FeatureConfiguration;
|
|
3464
3463
|
};
|
|
3465
3464
|
export type Product2 = {
|
|
3466
|
-
id?:
|
|
3465
|
+
id?: SubscriptionsUuid;
|
|
3467
3466
|
type: SubscriptionProductType;
|
|
3468
3467
|
attributes: ProductResponseAttributes;
|
|
3469
3468
|
meta: ProductMeta2;
|
|
@@ -3471,14 +3470,14 @@ export type Product2 = {
|
|
|
3471
3470
|
export type ProductMeta2 = {
|
|
3472
3471
|
display_price?: DisplayPrice2;
|
|
3473
3472
|
owner: OwnerMeta;
|
|
3474
|
-
timestamps:
|
|
3473
|
+
timestamps: SubscriptionsTimestamps;
|
|
3475
3474
|
};
|
|
3476
3475
|
export type ProductCreate = {
|
|
3477
3476
|
type: SubscriptionProductType;
|
|
3478
3477
|
attributes: ProductAttributes2;
|
|
3479
3478
|
};
|
|
3480
3479
|
export type ProductUpdate = {
|
|
3481
|
-
id:
|
|
3480
|
+
id: SubscriptionsUuid;
|
|
3482
3481
|
type: SubscriptionProductType;
|
|
3483
3482
|
attributes: ProductUpdateAttributes;
|
|
3484
3483
|
};
|
|
@@ -3491,7 +3490,7 @@ export type OfferingProductResponseExtraAttributes = {
|
|
|
3491
3490
|
[key: string]: FeatureProductConfiguration;
|
|
3492
3491
|
};
|
|
3493
3492
|
};
|
|
3494
|
-
export type ProductResponseAttributes = ProductAttributes2 &
|
|
3493
|
+
export type ProductResponseAttributes = ProductAttributes2 & SubscriptionsTimestamps;
|
|
3495
3494
|
export type ProductAttributes2 = {
|
|
3496
3495
|
external_ref?: ExternalRef;
|
|
3497
3496
|
/**
|
|
@@ -3544,21 +3543,21 @@ export type ProductUpdateAttributes = {
|
|
|
3544
3543
|
price_units?: NullablePriceUnits;
|
|
3545
3544
|
};
|
|
3546
3545
|
export type DunningRule = {
|
|
3547
|
-
id?:
|
|
3546
|
+
id?: SubscriptionsUuid;
|
|
3548
3547
|
type: SubscriptionDunningRuleType;
|
|
3549
3548
|
attributes: DunningRuleAttributes;
|
|
3550
3549
|
meta: DunningRuleMeta;
|
|
3551
3550
|
};
|
|
3552
3551
|
export type DunningRuleMeta = {
|
|
3553
3552
|
owner: OwnerMeta;
|
|
3554
|
-
timestamps:
|
|
3553
|
+
timestamps: SubscriptionsTimestamps;
|
|
3555
3554
|
};
|
|
3556
3555
|
export type DunningRuleCreate = {
|
|
3557
3556
|
type: SubscriptionDunningRuleType;
|
|
3558
3557
|
attributes: DunningRuleAttributes;
|
|
3559
3558
|
};
|
|
3560
3559
|
export type DunningRuleUpdate = {
|
|
3561
|
-
id:
|
|
3560
|
+
id: SubscriptionsUuid;
|
|
3562
3561
|
type: SubscriptionDunningRuleType;
|
|
3563
3562
|
attributes: DunningRuleUpdateAttributes;
|
|
3564
3563
|
};
|
|
@@ -3652,23 +3651,23 @@ export type DunningRuleUpdateAttributes = {
|
|
|
3652
3651
|
default?: boolean;
|
|
3653
3652
|
};
|
|
3654
3653
|
export type ProrationPolicy = {
|
|
3655
|
-
id?:
|
|
3654
|
+
id?: SubscriptionsUuid;
|
|
3656
3655
|
type: ProrationPolicyType;
|
|
3657
3656
|
attributes: ProrationPolicyResponseAttributes;
|
|
3658
3657
|
meta: ProrationPolicyMeta;
|
|
3659
3658
|
};
|
|
3660
3659
|
export type ProrationPolicyUpdate = {
|
|
3661
|
-
id:
|
|
3660
|
+
id: SubscriptionsUuid;
|
|
3662
3661
|
type: ProrationPolicyType;
|
|
3663
3662
|
attributes: ProrationPolicyUpdateAttributes;
|
|
3664
3663
|
};
|
|
3665
3664
|
export type ProrationPolicyRelationshipAttributes = {
|
|
3666
3665
|
type: ProrationPolicyType;
|
|
3667
|
-
id:
|
|
3666
|
+
id: SubscriptionsUuid;
|
|
3668
3667
|
};
|
|
3669
3668
|
export type ProrationPolicyUpdateRelationshipAttributes = {
|
|
3670
3669
|
type: ProrationPolicyType;
|
|
3671
|
-
id:
|
|
3670
|
+
id: SubscriptionsUuid;
|
|
3672
3671
|
} | null;
|
|
3673
3672
|
export type ProrationPolicyResponseAttributes = ProrationPolicyAttributes;
|
|
3674
3673
|
export type ProrationPolicyCreate = {
|
|
@@ -3713,28 +3712,28 @@ export type ProrationPolicyUpdateAttributes = {
|
|
|
3713
3712
|
};
|
|
3714
3713
|
export type ProrationPolicyMeta = {
|
|
3715
3714
|
owner: OwnerMeta;
|
|
3716
|
-
timestamps:
|
|
3715
|
+
timestamps: SubscriptionsTimestamps;
|
|
3717
3716
|
};
|
|
3718
3717
|
export type Plan = {
|
|
3719
|
-
id?:
|
|
3718
|
+
id?: SubscriptionsUuid;
|
|
3720
3719
|
type: SubscriptionPlanType;
|
|
3721
3720
|
attributes: PlanResponseAttributes;
|
|
3722
3721
|
meta: PlanMeta;
|
|
3723
3722
|
};
|
|
3724
3723
|
export type PlanMeta = {
|
|
3725
3724
|
owner: OwnerMeta;
|
|
3726
|
-
timestamps:
|
|
3725
|
+
timestamps: SubscriptionsTimestamps;
|
|
3727
3726
|
};
|
|
3728
3727
|
export type PlanCreate = {
|
|
3729
3728
|
type: SubscriptionPlanType;
|
|
3730
3729
|
attributes: PlanAttributes;
|
|
3731
3730
|
};
|
|
3732
3731
|
export type PlanUpdate = {
|
|
3733
|
-
id:
|
|
3732
|
+
id: SubscriptionsUuid;
|
|
3734
3733
|
type: SubscriptionPlanType;
|
|
3735
3734
|
attributes: PlanUpdateAttributes;
|
|
3736
3735
|
};
|
|
3737
|
-
export type PlanResponseAttributes = PlanAttributes &
|
|
3736
|
+
export type PlanResponseAttributes = PlanAttributes & SubscriptionsTimestamps;
|
|
3738
3737
|
/**
|
|
3739
3738
|
* The unit of time that billing intervals are measured.
|
|
3740
3739
|
*/
|
|
@@ -3853,18 +3852,18 @@ export type BuildOffering = {
|
|
|
3853
3852
|
/**
|
|
3854
3853
|
* Either references of existing features (id or external_ref) to be attached to the offering or feature information to be created directly within the offering
|
|
3855
3854
|
*/
|
|
3856
|
-
features?: Array<ExternalRef | FeatureAttributes |
|
|
3855
|
+
features?: Array<ExternalRef | FeatureAttributes | SubscriptionsUuid>;
|
|
3857
3856
|
/**
|
|
3858
3857
|
* Either references of existing products (id or external_ref) to be attached to the offering or product information to be created directly within the offering
|
|
3859
3858
|
*/
|
|
3860
|
-
products: Array<ExternalRef | ProductAttributes2 |
|
|
3859
|
+
products: Array<ExternalRef | ProductAttributes2 | SubscriptionsUuid>;
|
|
3861
3860
|
/**
|
|
3862
3861
|
* Either references of existing plans (id or external_ref) to be attached to the offering or plan information to be created directly within the offering
|
|
3863
3862
|
*/
|
|
3864
|
-
plans: Array<ExternalRef | PlanAttributes |
|
|
3863
|
+
plans: Array<ExternalRef | PlanAttributes | SubscriptionsUuid>;
|
|
3865
3864
|
};
|
|
3866
3865
|
export type Offering = {
|
|
3867
|
-
id?:
|
|
3866
|
+
id?: SubscriptionsUuid;
|
|
3868
3867
|
type: SubscriptionOfferingType;
|
|
3869
3868
|
attributes: OfferingResponseAttributes;
|
|
3870
3869
|
relationships?: Relationships;
|
|
@@ -3878,7 +3877,7 @@ export type OfferingIncludes = {
|
|
|
3878
3877
|
export type OfferingMeta = {
|
|
3879
3878
|
external_product_refs: Array<OfferingProductExternalRefMeta>;
|
|
3880
3879
|
owner: OwnerMeta;
|
|
3881
|
-
timestamps:
|
|
3880
|
+
timestamps: SubscriptionsTimestamps;
|
|
3882
3881
|
};
|
|
3883
3882
|
export type OfferingCreate = {
|
|
3884
3883
|
type: SubscriptionOfferingType;
|
|
@@ -3886,7 +3885,7 @@ export type OfferingCreate = {
|
|
|
3886
3885
|
relationships?: OfferingRelationships;
|
|
3887
3886
|
};
|
|
3888
3887
|
export type OfferingProductUpdate = {
|
|
3889
|
-
id:
|
|
3888
|
+
id: SubscriptionsUuid;
|
|
3890
3889
|
type: SubscriptionOfferingProductType;
|
|
3891
3890
|
attributes: OfferingProductUpdateAttributes;
|
|
3892
3891
|
};
|
|
@@ -3938,31 +3937,31 @@ export type FeatureProductConfigurationUpdate = (({
|
|
|
3938
3937
|
type: "access" | "promotion" | "usage";
|
|
3939
3938
|
};
|
|
3940
3939
|
export type OfferingFeatureUpdate = {
|
|
3941
|
-
id:
|
|
3940
|
+
id: SubscriptionsUuid;
|
|
3942
3941
|
type: SubscriptionOfferingFeatureType;
|
|
3943
3942
|
attributes: FeatureUpdateAttributes;
|
|
3944
3943
|
};
|
|
3945
3944
|
export type OfferingFeature = {
|
|
3946
|
-
id?:
|
|
3945
|
+
id?: SubscriptionsUuid;
|
|
3947
3946
|
type: SubscriptionOfferingFeatureType;
|
|
3948
3947
|
attributes: FeatureResponseAttributes;
|
|
3949
3948
|
relationships?: Relationships;
|
|
3950
3949
|
meta: FeatureMeta;
|
|
3951
3950
|
};
|
|
3952
3951
|
export type OfferingProduct = {
|
|
3953
|
-
id?:
|
|
3952
|
+
id?: SubscriptionsUuid;
|
|
3954
3953
|
type: SubscriptionOfferingProductType;
|
|
3955
3954
|
attributes: OfferingProductResponseAttributes;
|
|
3956
3955
|
relationships?: Relationships;
|
|
3957
3956
|
meta: ProductMeta2;
|
|
3958
3957
|
};
|
|
3959
3958
|
export type OfferingPlanUpdate = {
|
|
3960
|
-
id:
|
|
3959
|
+
id: SubscriptionsUuid;
|
|
3961
3960
|
type: SubscriptionOfferingPlanType;
|
|
3962
3961
|
attributes: PlanUpdateAttributes;
|
|
3963
3962
|
};
|
|
3964
3963
|
export type OfferingPlan = {
|
|
3965
|
-
id?:
|
|
3964
|
+
id?: SubscriptionsUuid;
|
|
3966
3965
|
type: SubscriptionOfferingPlanType;
|
|
3967
3966
|
attributes: PlanResponseAttributes;
|
|
3968
3967
|
relationships?: Relationships;
|
|
@@ -3973,39 +3972,39 @@ export type OfferingPlanMeta = {
|
|
|
3973
3972
|
display_price?: DisplayPrice2;
|
|
3974
3973
|
active_plan?: ActivePlan;
|
|
3975
3974
|
owner: OwnerMeta;
|
|
3976
|
-
timestamps:
|
|
3975
|
+
timestamps: SubscriptionsTimestamps;
|
|
3977
3976
|
};
|
|
3978
3977
|
/**
|
|
3979
3978
|
* A list of feature IDs to attach to the offering. See [**List Features**](/docs/api/subscriptions/list-features).
|
|
3980
3979
|
*/
|
|
3981
3980
|
export type OfferingFeatureAttach = {
|
|
3982
|
-
features: Array<
|
|
3981
|
+
features: Array<SubscriptionsUuid>;
|
|
3983
3982
|
};
|
|
3984
3983
|
/**
|
|
3985
3984
|
* A list of plan IDs to attach to the offering. See [**List Plans**](/docs/api/subscriptions/list-plans).
|
|
3986
3985
|
*/
|
|
3987
3986
|
export type OfferingPlanAttach = {
|
|
3988
|
-
plans: Array<
|
|
3987
|
+
plans: Array<SubscriptionsUuid>;
|
|
3989
3988
|
};
|
|
3990
3989
|
/**
|
|
3991
3990
|
* A list of product IDs to attach to the offering. See [**List Products**](/docs/api/subscriptions/list-products).
|
|
3992
3991
|
*/
|
|
3993
3992
|
export type OfferingProductAttach = {
|
|
3994
|
-
products: Array<
|
|
3993
|
+
products: Array<SubscriptionsUuid>;
|
|
3995
3994
|
};
|
|
3996
3995
|
/**
|
|
3997
3996
|
* A list of product IDs to replace on the offering. See [**List Products**](/docs/api/subscriptions/list-products).
|
|
3998
3997
|
*/
|
|
3999
3998
|
export type OfferingProductReplace = {
|
|
4000
|
-
products: Array<
|
|
3999
|
+
products: Array<SubscriptionsUuid>;
|
|
4001
4000
|
};
|
|
4002
4001
|
export type OfferingUpdate = unknown & {
|
|
4003
|
-
id:
|
|
4002
|
+
id: SubscriptionsUuid;
|
|
4004
4003
|
type: SubscriptionOfferingType;
|
|
4005
4004
|
attributes?: OfferingUpdateAttributes;
|
|
4006
4005
|
relationships?: OfferingUpdateRelationships;
|
|
4007
4006
|
};
|
|
4008
|
-
export type OfferingResponseAttributes = OfferingAttributes &
|
|
4007
|
+
export type OfferingResponseAttributes = OfferingAttributes & SubscriptionsTimestamps;
|
|
4009
4008
|
export type OfferingAttributes = {
|
|
4010
4009
|
external_ref?: ExternalRef;
|
|
4011
4010
|
/**
|
|
@@ -4036,11 +4035,11 @@ export type OfferingUpdateRelationships = {
|
|
|
4036
4035
|
};
|
|
4037
4036
|
export type BuildSubscription = {
|
|
4038
4037
|
external_ref?: ExternalRef;
|
|
4039
|
-
account_id:
|
|
4040
|
-
address_id?:
|
|
4038
|
+
account_id: SubscriptionsUuid;
|
|
4039
|
+
address_id?: SubscriptionsUuid;
|
|
4041
4040
|
offering_external_ref?: ExternalRef;
|
|
4042
|
-
offering_id?:
|
|
4043
|
-
plan_id?:
|
|
4041
|
+
offering_id?: SubscriptionsUuid;
|
|
4042
|
+
plan_id?: SubscriptionsUuid;
|
|
4044
4043
|
currency: CurrencyIdentifier;
|
|
4045
4044
|
payment_authority?: PaymentAuthority;
|
|
4046
4045
|
manual_payments: ManualPayments;
|
|
@@ -4075,7 +4074,7 @@ export type SelectedPlanMetaAttributes = {
|
|
|
4075
4074
|
selected?: boolean;
|
|
4076
4075
|
};
|
|
4077
4076
|
export type Subscription = {
|
|
4078
|
-
id?:
|
|
4077
|
+
id?: SubscriptionsUuid;
|
|
4079
4078
|
type: SubscriptionType;
|
|
4080
4079
|
attributes: SubscriptionAttributes;
|
|
4081
4080
|
relationships?: Relationships;
|
|
@@ -4083,10 +4082,10 @@ export type Subscription = {
|
|
|
4083
4082
|
};
|
|
4084
4083
|
export type ManageSubscriptionProducts = {
|
|
4085
4084
|
type: "attach" | "detach" | "replace";
|
|
4086
|
-
products: Array<
|
|
4085
|
+
products: Array<SubscriptionsUuid>;
|
|
4087
4086
|
};
|
|
4088
4087
|
export type SubscriptionUpdate = {
|
|
4089
|
-
id:
|
|
4088
|
+
id: SubscriptionsUuid;
|
|
4090
4089
|
type: SubscriptionType;
|
|
4091
4090
|
attributes: SubscriptionUpdateAttributes;
|
|
4092
4091
|
};
|
|
@@ -4138,7 +4137,7 @@ export type SubscriptionMeta = {
|
|
|
4138
4137
|
*/
|
|
4139
4138
|
invoice_after: string;
|
|
4140
4139
|
};
|
|
4141
|
-
export type SubscriptionTimestamps =
|
|
4140
|
+
export type SubscriptionTimestamps = SubscriptionsTimestamps & {
|
|
4142
4141
|
/**
|
|
4143
4142
|
* The date and time a subscription was cancelled.
|
|
4144
4143
|
*/
|
|
@@ -4166,10 +4165,10 @@ export type SubscriptionTimestamps = Timestamps & {
|
|
|
4166
4165
|
};
|
|
4167
4166
|
export type SubscriptionAttributes = {
|
|
4168
4167
|
external_ref?: ExternalRef;
|
|
4169
|
-
account_id:
|
|
4170
|
-
address_id?:
|
|
4168
|
+
account_id: SubscriptionsUuid;
|
|
4169
|
+
address_id?: SubscriptionsUuid;
|
|
4171
4170
|
offering: Offering;
|
|
4172
|
-
plan_id:
|
|
4171
|
+
plan_id: SubscriptionsUuid;
|
|
4173
4172
|
currency: CurrencyIdentifier;
|
|
4174
4173
|
payment_authority?: PaymentAuthority;
|
|
4175
4174
|
};
|
|
@@ -4200,7 +4199,7 @@ export type StateMeta = {
|
|
|
4200
4199
|
created_at: string;
|
|
4201
4200
|
};
|
|
4202
4201
|
export type SubscriptionState = {
|
|
4203
|
-
id?:
|
|
4202
|
+
id?: SubscriptionsUuid;
|
|
4204
4203
|
type: SubscriptionStateType;
|
|
4205
4204
|
attributes: SubscriptionStateAttributes;
|
|
4206
4205
|
meta: StateMeta;
|
|
@@ -4258,7 +4257,7 @@ export type PaymentAuthorityStripe = {
|
|
|
4258
4257
|
card_id?: string;
|
|
4259
4258
|
};
|
|
4260
4259
|
export type Import = {
|
|
4261
|
-
id?:
|
|
4260
|
+
id?: SubscriptionsUuid;
|
|
4262
4261
|
type: SubscriptionImportType;
|
|
4263
4262
|
attributes: ImportAttributes;
|
|
4264
4263
|
meta: ImportMeta;
|
|
@@ -4339,7 +4338,7 @@ export type ImportRecords = {
|
|
|
4339
4338
|
};
|
|
4340
4339
|
};
|
|
4341
4340
|
export type Job = {
|
|
4342
|
-
id?:
|
|
4341
|
+
id?: SubscriptionsUuid;
|
|
4343
4342
|
type: SubscriptionJobType;
|
|
4344
4343
|
attributes: JobResponseAttributes;
|
|
4345
4344
|
relationships?: Relationships;
|
|
@@ -4391,7 +4390,7 @@ export type PaymentRunReport = {
|
|
|
4391
4390
|
failed_payments: number;
|
|
4392
4391
|
total_collected: unknown & Price;
|
|
4393
4392
|
};
|
|
4394
|
-
export type JobTimestamps =
|
|
4393
|
+
export type JobTimestamps = SubscriptionsTimestamps & {
|
|
4395
4394
|
/**
|
|
4396
4395
|
* The date and time a job is started.
|
|
4397
4396
|
*/
|
|
@@ -4405,7 +4404,7 @@ export type JobCreate = {
|
|
|
4405
4404
|
type: SubscriptionJobType;
|
|
4406
4405
|
attributes: JobCreateAttributes;
|
|
4407
4406
|
};
|
|
4408
|
-
export type JobResponseAttributes = JobCreateAttributes & JobAttributes &
|
|
4407
|
+
export type JobResponseAttributes = JobCreateAttributes & JobAttributes & SubscriptionsTimestamps;
|
|
4409
4408
|
/**
|
|
4410
4409
|
* The type of job. One of the following:
|
|
4411
4410
|
* - `billing_run` - a billing run job.
|
|
@@ -4427,7 +4426,7 @@ export type JobAttributes = {
|
|
|
4427
4426
|
status: "pending" | "started" | "success" | "failed";
|
|
4428
4427
|
};
|
|
4429
4428
|
export type InvoiceTaxItems = {
|
|
4430
|
-
invoice_id:
|
|
4429
|
+
invoice_id: SubscriptionsUuid;
|
|
4431
4430
|
tax_items: Array<TaxItem>;
|
|
4432
4431
|
};
|
|
4433
4432
|
export type TaxItem = {
|
|
@@ -4453,13 +4452,13 @@ export type TaxItem = {
|
|
|
4453
4452
|
jurisdiction?: string;
|
|
4454
4453
|
};
|
|
4455
4454
|
export type SubscriptionInvoice = {
|
|
4456
|
-
id?:
|
|
4455
|
+
id?: SubscriptionsUuid;
|
|
4457
4456
|
type: SubscriptionInvoiceType;
|
|
4458
4457
|
attributes: SubscriptionInvoiceAttributes;
|
|
4459
4458
|
meta: SubscriptionInvoiceMeta;
|
|
4460
4459
|
};
|
|
4461
4460
|
export type UpdateInvoicePayment = {
|
|
4462
|
-
id:
|
|
4461
|
+
id: SubscriptionsUuid;
|
|
4463
4462
|
type: SubscriptionInvoicePaymentType;
|
|
4464
4463
|
attributes: UpdateInvoicePaymentAttributes;
|
|
4465
4464
|
};
|
|
@@ -4482,21 +4481,21 @@ export type UpdateInvoicePaymentAttributes = {
|
|
|
4482
4481
|
payment_taken_at?: string;
|
|
4483
4482
|
};
|
|
4484
4483
|
export type SubscriptionInvoicePayment = {
|
|
4485
|
-
id:
|
|
4484
|
+
id: SubscriptionsUuid;
|
|
4486
4485
|
type: SubscriptionInvoicePaymentType;
|
|
4487
4486
|
attributes: SubscriptionInvoicePaymentAttributes;
|
|
4488
4487
|
meta: SubscriptionInvoicePaymentMeta;
|
|
4489
4488
|
};
|
|
4490
4489
|
export type SubscriptionInvoiceMeta = {
|
|
4491
4490
|
owner: OwnerMeta;
|
|
4492
|
-
subscription_id?:
|
|
4493
|
-
subscriber_id?:
|
|
4491
|
+
subscription_id?: SubscriptionsUuid;
|
|
4492
|
+
subscriber_id?: SubscriptionsUuid;
|
|
4494
4493
|
price?: SingleCurrencyPrice;
|
|
4495
4494
|
timestamps: InvoiceTimestamps;
|
|
4496
4495
|
proration_events: Array<ProrationEvent>;
|
|
4497
4496
|
};
|
|
4498
4497
|
export type ProrationEvent = {
|
|
4499
|
-
proration_policy_id:
|
|
4498
|
+
proration_policy_id: SubscriptionsUuid;
|
|
4500
4499
|
/**
|
|
4501
4500
|
* The value as a whole number of the currency's smallest subdivision
|
|
4502
4501
|
*/
|
|
@@ -4514,7 +4513,7 @@ export type ProrationEvent = {
|
|
|
4514
4513
|
*/
|
|
4515
4514
|
prorated_at: string;
|
|
4516
4515
|
};
|
|
4517
|
-
export type InvoiceTimestamps =
|
|
4516
|
+
export type InvoiceTimestamps = SubscriptionsTimestamps & {
|
|
4518
4517
|
/**
|
|
4519
4518
|
* The date and time taxes were added to an invoice.
|
|
4520
4519
|
*/
|
|
@@ -4522,16 +4521,16 @@ export type InvoiceTimestamps = Timestamps & {
|
|
|
4522
4521
|
};
|
|
4523
4522
|
export type SubscriptionInvoicePaymentMeta = {
|
|
4524
4523
|
owner: OwnerMeta;
|
|
4525
|
-
subscription_id:
|
|
4526
|
-
invoice_id:
|
|
4527
|
-
job_id:
|
|
4524
|
+
subscription_id: SubscriptionsUuid;
|
|
4525
|
+
invoice_id: SubscriptionsUuid;
|
|
4526
|
+
job_id: SubscriptionsUuid;
|
|
4528
4527
|
timestamps: InvoicePaymentTimestamps;
|
|
4529
4528
|
/**
|
|
4530
4529
|
* Whether manual payments are enabled or the payment will be handled by the configured gateway.
|
|
4531
4530
|
*/
|
|
4532
4531
|
manual_payment: boolean;
|
|
4533
4532
|
};
|
|
4534
|
-
export type InvoicePaymentTimestamps =
|
|
4533
|
+
export type InvoicePaymentTimestamps = SubscriptionsTimestamps & {
|
|
4535
4534
|
/**
|
|
4536
4535
|
* The date and time a payment was taken.
|
|
4537
4536
|
*/
|
|
@@ -4602,7 +4601,7 @@ export type SubscriptionInvoiceItem = {
|
|
|
4602
4601
|
*/
|
|
4603
4602
|
description: string;
|
|
4604
4603
|
price: SingleCurrencyPrice;
|
|
4605
|
-
product_id?:
|
|
4604
|
+
product_id?: SubscriptionsUuid;
|
|
4606
4605
|
/**
|
|
4607
4606
|
* The start date and time of the billing period in this price
|
|
4608
4607
|
*/
|
|
@@ -4612,37 +4611,10 @@ export type SubscriptionInvoiceItem = {
|
|
|
4612
4611
|
*/
|
|
4613
4612
|
until_time_period?: string;
|
|
4614
4613
|
};
|
|
4615
|
-
export type ErrorResponse2 = {
|
|
4616
|
-
errors: Array<Error2>;
|
|
4617
|
-
};
|
|
4618
|
-
export type Error2 = {
|
|
4619
|
-
/**
|
|
4620
|
-
* The HTTP response code of the error.
|
|
4621
|
-
*/
|
|
4622
|
-
status: string;
|
|
4623
|
-
/**
|
|
4624
|
-
* A brief summary of the error.
|
|
4625
|
-
*/
|
|
4626
|
-
title: string;
|
|
4627
|
-
/**
|
|
4628
|
-
* Optional additional detail about the error.
|
|
4629
|
-
*/
|
|
4630
|
-
detail?: string;
|
|
4631
|
-
/**
|
|
4632
|
-
* Additional supporting meta data for the error.
|
|
4633
|
-
*/
|
|
4634
|
-
meta?: {
|
|
4635
|
-
[key: string]: unknown;
|
|
4636
|
-
};
|
|
4637
|
-
};
|
|
4638
4614
|
/**
|
|
4639
4615
|
* The three-letter [**ISO currency code**](https://www.iso.org/iso-4217-currency-codes.html) in uppercase.
|
|
4640
4616
|
*/
|
|
4641
4617
|
export type CurrencyIdentifier = string;
|
|
4642
|
-
/**
|
|
4643
|
-
* The unique identifier.
|
|
4644
|
-
*/
|
|
4645
|
-
export type Uuid = string;
|
|
4646
4618
|
/**
|
|
4647
4619
|
* The owner of a resource, either `store` or `organization`.
|
|
4648
4620
|
*/
|
|
@@ -4652,19 +4624,19 @@ export type OwnerMeta = string;
|
|
|
4652
4624
|
*/
|
|
4653
4625
|
export type OfferingProductExternalRefMeta = string;
|
|
4654
4626
|
export type Subscriber = {
|
|
4655
|
-
id?:
|
|
4627
|
+
id?: SubscriptionsUuid;
|
|
4656
4628
|
type: SubscriptionSubscriberType;
|
|
4657
4629
|
attributes: SubscriberResponseAttributes;
|
|
4658
4630
|
meta: SubscriberMeta;
|
|
4659
4631
|
};
|
|
4660
4632
|
export type SubscriberMeta = {
|
|
4661
4633
|
owner: OwnerMeta;
|
|
4662
|
-
timestamps:
|
|
4634
|
+
timestamps: SubscriptionsTimestamps;
|
|
4663
4635
|
};
|
|
4664
4636
|
export type SubscriptionSubscriberType = "subscription_subscriber";
|
|
4665
|
-
export type SubscriberResponseAttributes = SubscriberAttributes &
|
|
4637
|
+
export type SubscriberResponseAttributes = SubscriberAttributes & SubscriptionsTimestamps;
|
|
4666
4638
|
export type SubscriberAttributes = {
|
|
4667
|
-
account_id:
|
|
4639
|
+
account_id: SubscriptionsUuid;
|
|
4668
4640
|
/**
|
|
4669
4641
|
* The name of the subscriber.
|
|
4670
4642
|
*/
|
|
@@ -4691,7 +4663,7 @@ export type SubscriberCreate = {
|
|
|
4691
4663
|
attributes: SubscriberAttributes;
|
|
4692
4664
|
};
|
|
4693
4665
|
export type SubscriberUpdate = {
|
|
4694
|
-
id:
|
|
4666
|
+
id: SubscriptionsUuid;
|
|
4695
4667
|
type: SubscriptionSubscriberType;
|
|
4696
4668
|
attributes: SubscriberUpdateAttributes;
|
|
4697
4669
|
};
|
|
@@ -4700,7 +4672,7 @@ export type ScheduleCreate = {
|
|
|
4700
4672
|
attributes: ScheduleAttributes;
|
|
4701
4673
|
};
|
|
4702
4674
|
export type Schedule2 = {
|
|
4703
|
-
id?:
|
|
4675
|
+
id?: SubscriptionsUuid;
|
|
4704
4676
|
type: SubscriptionScheduleType;
|
|
4705
4677
|
attributes: ScheduleResponseAttributes;
|
|
4706
4678
|
meta: ScheduleMeta;
|
|
@@ -4708,10 +4680,10 @@ export type Schedule2 = {
|
|
|
4708
4680
|
export type ScheduleMeta = {
|
|
4709
4681
|
scheduled_for?: Date;
|
|
4710
4682
|
owner: OwnerMeta;
|
|
4711
|
-
timestamps:
|
|
4683
|
+
timestamps: SubscriptionsTimestamps;
|
|
4712
4684
|
};
|
|
4713
4685
|
export type SubscriptionScheduleType = "subscription_schedule";
|
|
4714
|
-
export type ScheduleResponseAttributes = ScheduleAttributes &
|
|
4686
|
+
export type ScheduleResponseAttributes = ScheduleAttributes & SubscriptionsTimestamps;
|
|
4715
4687
|
export type ScheduleAttributes = {
|
|
4716
4688
|
external_ref?: ExternalRef;
|
|
4717
4689
|
/**
|
|
@@ -4748,10 +4720,245 @@ export type ScheduleJob = {
|
|
|
4748
4720
|
job_type: JobType;
|
|
4749
4721
|
};
|
|
4750
4722
|
export type ScheduleUpdate = {
|
|
4751
|
-
id:
|
|
4723
|
+
id: SubscriptionsUuid;
|
|
4752
4724
|
type: SubscriptionScheduleType;
|
|
4753
4725
|
attributes: ScheduleUpdateAttributes;
|
|
4754
4726
|
};
|
|
4727
|
+
export type SubscriptionsTimestamps = {
|
|
4728
|
+
/**
|
|
4729
|
+
* The date and time a resource was updated.
|
|
4730
|
+
*/
|
|
4731
|
+
updated_at: string;
|
|
4732
|
+
/**
|
|
4733
|
+
* The date and time a resource was created.
|
|
4734
|
+
*/
|
|
4735
|
+
created_at: string;
|
|
4736
|
+
};
|
|
4737
|
+
export type SubscriptionsErrorResponse = {
|
|
4738
|
+
errors: Array<SubscriptionsError>;
|
|
4739
|
+
};
|
|
4740
|
+
export type SubscriptionsError = {
|
|
4741
|
+
/**
|
|
4742
|
+
* The HTTP response code of the error.
|
|
4743
|
+
*/
|
|
4744
|
+
status: string;
|
|
4745
|
+
/**
|
|
4746
|
+
* A brief summary of the error.
|
|
4747
|
+
*/
|
|
4748
|
+
title: string;
|
|
4749
|
+
/**
|
|
4750
|
+
* Optional additional detail about the error.
|
|
4751
|
+
*/
|
|
4752
|
+
detail?: string;
|
|
4753
|
+
/**
|
|
4754
|
+
* Additional supporting meta data for the error.
|
|
4755
|
+
*/
|
|
4756
|
+
meta?: {
|
|
4757
|
+
[key: string]: unknown;
|
|
4758
|
+
};
|
|
4759
|
+
};
|
|
4760
|
+
/**
|
|
4761
|
+
* The unique identifier.
|
|
4762
|
+
*/
|
|
4763
|
+
export type SubscriptionsUuid = string;
|
|
4764
|
+
export type StockType = "stock";
|
|
4765
|
+
export type StockTransactionType = "stock-transaction";
|
|
4766
|
+
export type MultipleProducts = {
|
|
4767
|
+
type?: "stock";
|
|
4768
|
+
/**
|
|
4769
|
+
* The unique identifier of the product.
|
|
4770
|
+
*/
|
|
4771
|
+
id: string;
|
|
4772
|
+
};
|
|
4773
|
+
export type TransactionResponseAttributes = {
|
|
4774
|
+
/**
|
|
4775
|
+
* The type of action performed by this transaction.
|
|
4776
|
+
*
|
|
4777
|
+
* - **increment** - use this when you want to make products available for purchase, for example, when you have received stock from a supplier.
|
|
4778
|
+
*
|
|
4779
|
+
* - **decrement** - Use this when you want to remove stock from product inventory.
|
|
4780
|
+
*
|
|
4781
|
+
* - **allocate** - Use this when you want to allocate stock, normally to a reseller who sells on the stock.
|
|
4782
|
+
*
|
|
4783
|
+
* - **deallocate** - Use this when you want to deallocate any previously allocated stock.
|
|
4784
|
+
*
|
|
4785
|
+
*/
|
|
4786
|
+
action: "increment" | "decrement" | "allocate" | "deallocate";
|
|
4787
|
+
product_id: InventoriesUuid;
|
|
4788
|
+
/**
|
|
4789
|
+
* The amount of stock affected by the stock transaction.
|
|
4790
|
+
*/
|
|
4791
|
+
quantity: BigInt;
|
|
4792
|
+
/**
|
|
4793
|
+
* The slug of the location that the transaction should act on.
|
|
4794
|
+
*/
|
|
4795
|
+
location?: string;
|
|
4796
|
+
};
|
|
4797
|
+
export type StockCreate = {
|
|
4798
|
+
id?: InventoriesUuid;
|
|
4799
|
+
type: StockType;
|
|
4800
|
+
attributes: StockCreateAttributes;
|
|
4801
|
+
};
|
|
4802
|
+
export type StockUpdateRequest = {
|
|
4803
|
+
id: InventoriesUuid;
|
|
4804
|
+
type: StockType;
|
|
4805
|
+
attributes: StockUpdateAttributes;
|
|
4806
|
+
};
|
|
4807
|
+
export type StockUpdateAttributes = {
|
|
4808
|
+
locations?: NullableLocations;
|
|
4809
|
+
};
|
|
4810
|
+
export type NullableLocation = {
|
|
4811
|
+
available: BigInt;
|
|
4812
|
+
} | null;
|
|
4813
|
+
export type NullableLocations = {
|
|
4814
|
+
[key: string]: NullableLocation;
|
|
4815
|
+
};
|
|
4816
|
+
export type StockCreateAttributes = {
|
|
4817
|
+
available?: BigInt;
|
|
4818
|
+
locations?: {
|
|
4819
|
+
[key: string]: {
|
|
4820
|
+
available: BigInt;
|
|
4821
|
+
};
|
|
4822
|
+
};
|
|
4823
|
+
};
|
|
4824
|
+
export type StockResponse = {
|
|
4825
|
+
id: InventoriesUuid;
|
|
4826
|
+
type: StockType;
|
|
4827
|
+
attributes: StockResponseAttributes;
|
|
4828
|
+
meta: StockMeta;
|
|
4829
|
+
};
|
|
4830
|
+
export type StockResponseAttributes = {
|
|
4831
|
+
available: BigInt;
|
|
4832
|
+
allocated: BigInt;
|
|
4833
|
+
total: BigInt;
|
|
4834
|
+
locations?: StockLocations;
|
|
4835
|
+
};
|
|
4836
|
+
export type StockLocations = {
|
|
4837
|
+
[key: string]: {
|
|
4838
|
+
available: BigInt;
|
|
4839
|
+
allocated: BigInt;
|
|
4840
|
+
total: BigInt;
|
|
4841
|
+
};
|
|
4842
|
+
};
|
|
4843
|
+
export type TransactionCreate = {
|
|
4844
|
+
type: StockTransactionType;
|
|
4845
|
+
attributes: TransactionCreateAttributes;
|
|
4846
|
+
};
|
|
4847
|
+
export type TransactionCreateAttributes = {
|
|
4848
|
+
product_id?: InventoriesUuid;
|
|
4849
|
+
/**
|
|
4850
|
+
* The type of action being performed by this transaction.
|
|
4851
|
+
*
|
|
4852
|
+
* - **increment** - use this when you want to make products available for purchase, for example, when you have received stock from a supplier.
|
|
4853
|
+
*
|
|
4854
|
+
* - **decrement** - Use this when you want to remove stock from product inventory.
|
|
4855
|
+
*
|
|
4856
|
+
* - **allocate** - Use this when you want to allocate stock, normally to a reseller who sells on the stock.
|
|
4857
|
+
*
|
|
4858
|
+
* - **deallocate** - Use this when you want to deallocate any previously allocated stock.
|
|
4859
|
+
*
|
|
4860
|
+
* - **set** - Use this when you want to set total stock to a specific value.
|
|
4861
|
+
*
|
|
4862
|
+
*/
|
|
4863
|
+
action: "increment" | "decrement" | "allocate" | "deallocate" | "set";
|
|
4864
|
+
/**
|
|
4865
|
+
* The amount of stock affected by the stock transaction.
|
|
4866
|
+
*/
|
|
4867
|
+
quantity: BigInt;
|
|
4868
|
+
/**
|
|
4869
|
+
* The slug of the location that the transaction should act on.
|
|
4870
|
+
*/
|
|
4871
|
+
location?: string;
|
|
4872
|
+
};
|
|
4873
|
+
export type Location = {
|
|
4874
|
+
id: InventoriesUuid;
|
|
4875
|
+
type: InventoryLocationType;
|
|
4876
|
+
attributes: LocationAttributes;
|
|
4877
|
+
meta?: Meta;
|
|
4878
|
+
};
|
|
4879
|
+
export type LocationAttributes = {
|
|
4880
|
+
name: string;
|
|
4881
|
+
external_ref?: string;
|
|
4882
|
+
slug: string;
|
|
4883
|
+
description?: string;
|
|
4884
|
+
address?: Array<string>;
|
|
4885
|
+
geolocation?: GeolocationDetails;
|
|
4886
|
+
};
|
|
4887
|
+
export type LocationUpdateAttributes = {
|
|
4888
|
+
name?: string;
|
|
4889
|
+
external_ref?: string | null;
|
|
4890
|
+
slug?: string;
|
|
4891
|
+
description?: string | null;
|
|
4892
|
+
address?: Array<string | null> | null;
|
|
4893
|
+
geolocation?: GeolocationDetails;
|
|
4894
|
+
};
|
|
4895
|
+
/**
|
|
4896
|
+
* The longitude and latitude of a location.
|
|
4897
|
+
*/
|
|
4898
|
+
export type GeolocationDetails = {
|
|
4899
|
+
lat: number;
|
|
4900
|
+
lon: number;
|
|
4901
|
+
} | null;
|
|
4902
|
+
export type LocationRequest = {
|
|
4903
|
+
type?: InventoryLocationType;
|
|
4904
|
+
attributes: LocationAttributes;
|
|
4905
|
+
};
|
|
4906
|
+
export type LocationUpdateRequest = {
|
|
4907
|
+
id: InventoriesUuid;
|
|
4908
|
+
type: InventoryLocationType;
|
|
4909
|
+
attributes: LocationUpdateAttributes;
|
|
4910
|
+
};
|
|
4911
|
+
export type InventoryLocationType = "inventory_location";
|
|
4912
|
+
export type StockMeta = {
|
|
4913
|
+
stock_id: InventoriesUuid;
|
|
4914
|
+
timestamps: InventoriesTimestamps;
|
|
4915
|
+
};
|
|
4916
|
+
export type Meta = {
|
|
4917
|
+
timestamps: InventoriesTimestamps;
|
|
4918
|
+
};
|
|
4919
|
+
export type InventoriesTransactionResponse = {
|
|
4920
|
+
id: InventoriesUuid;
|
|
4921
|
+
type: StockTransactionType;
|
|
4922
|
+
attributes: TransactionResponseAttributes;
|
|
4923
|
+
meta?: Meta;
|
|
4924
|
+
};
|
|
4925
|
+
/**
|
|
4926
|
+
* The unique identifier.
|
|
4927
|
+
*/
|
|
4928
|
+
export type InventoriesUuid = string;
|
|
4929
|
+
export type InventoriesTimestamps = {
|
|
4930
|
+
/**
|
|
4931
|
+
* The date and time a resource was updated.
|
|
4932
|
+
*/
|
|
4933
|
+
updated_at?: string;
|
|
4934
|
+
/**
|
|
4935
|
+
* The date and time a resource was created.
|
|
4936
|
+
*/
|
|
4937
|
+
created_at: string;
|
|
4938
|
+
};
|
|
4939
|
+
export type InventoriesErrorResponse = {
|
|
4940
|
+
errors: Array<InventoriesError>;
|
|
4941
|
+
};
|
|
4942
|
+
export type InventoriesError = {
|
|
4943
|
+
/**
|
|
4944
|
+
* The HTTP response code of the error.
|
|
4945
|
+
*/
|
|
4946
|
+
status: string;
|
|
4947
|
+
/**
|
|
4948
|
+
* A brief summary of the error.
|
|
4949
|
+
*/
|
|
4950
|
+
title: string;
|
|
4951
|
+
/**
|
|
4952
|
+
* Optional additional detail about the error.
|
|
4953
|
+
*/
|
|
4954
|
+
detail?: string;
|
|
4955
|
+
/**
|
|
4956
|
+
* Additional supporting meta data for the error.
|
|
4957
|
+
*/
|
|
4958
|
+
meta?: {
|
|
4959
|
+
[key: string]: unknown;
|
|
4960
|
+
};
|
|
4961
|
+
};
|
|
4755
4962
|
/**
|
|
4756
4963
|
* The language and locale your storefront prefers. See [Accept-Language](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language).
|
|
4757
4964
|
*/
|
|
@@ -4802,23 +5009,37 @@ export type Offset = BigInt;
|
|
|
4802
5009
|
* Product tags are used to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. You can enhance your product list using tags, enabling you to refine your product list and run targeted promotions. Tags are used to refine the eligibility criteria for a rule. Requests populate the catalog rule tag using the `EP-Context-Tag` header.
|
|
4803
5010
|
*/
|
|
4804
5011
|
export type Tag = string;
|
|
4805
|
-
|
|
4806
|
-
* Some Subscriptions API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.
|
|
4807
|
-
*
|
|
4808
|
-
*/
|
|
4809
|
-
export type Filter = string;
|
|
5012
|
+
export type CartInclude2 = Array<"items">;
|
|
4810
5013
|
/**
|
|
4811
5014
|
* A comma-separated list of resources to include. See [Characteristics of Include Parameter](/guides/Getting-Started/includes#characteristics-of-include-parameter).
|
|
4812
5015
|
*/
|
|
4813
5016
|
export type Include2 = string;
|
|
5017
|
+
/**
|
|
5018
|
+
* Some Subscriptions API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.
|
|
5019
|
+
*
|
|
5020
|
+
*/
|
|
5021
|
+
export type SubscriptionsFilter = string;
|
|
4814
5022
|
/**
|
|
4815
5023
|
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
4816
5024
|
*/
|
|
4817
|
-
export type
|
|
5025
|
+
export type SubscriptionsPageLimit = BigInt;
|
|
4818
5026
|
/**
|
|
4819
5027
|
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
4820
5028
|
*/
|
|
4821
|
-
export type
|
|
5029
|
+
export type SubscriptionsPageOffset = BigInt;
|
|
5030
|
+
/**
|
|
5031
|
+
* Some Inventories API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.
|
|
5032
|
+
*
|
|
5033
|
+
*/
|
|
5034
|
+
export type InventoriesFilter = string;
|
|
5035
|
+
/**
|
|
5036
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
5037
|
+
*/
|
|
5038
|
+
export type InventoriesPageLimit = number;
|
|
5039
|
+
/**
|
|
5040
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
5041
|
+
*/
|
|
5042
|
+
export type InventoriesPageOffset = number;
|
|
4822
5043
|
/**
|
|
4823
5044
|
* The bundle configuration.
|
|
4824
5045
|
*/
|
|
@@ -6639,13 +6860,10 @@ export type DeleteACartResponses = {
|
|
|
6639
6860
|
export type DeleteACartResponse = DeleteACartResponses[keyof DeleteACartResponses];
|
|
6640
6861
|
export type GetCartData = {
|
|
6641
6862
|
body?: never;
|
|
6642
|
-
path
|
|
6643
|
-
|
|
6644
|
-
|
|
6645
|
-
*/
|
|
6646
|
-
cartID: string;
|
|
6863
|
+
path?: never;
|
|
6864
|
+
query?: {
|
|
6865
|
+
include?: Array<"items">;
|
|
6647
6866
|
};
|
|
6648
|
-
query?: never;
|
|
6649
6867
|
url: "/v2/carts/{cartID}";
|
|
6650
6868
|
};
|
|
6651
6869
|
export type GetCartErrors = {
|
|
@@ -7725,7 +7943,7 @@ export type GetSubscriptionProductData = {
|
|
|
7725
7943
|
/**
|
|
7726
7944
|
* The unique identifier of a product.
|
|
7727
7945
|
*/
|
|
7728
|
-
product_uuid:
|
|
7946
|
+
product_uuid: SubscriptionsUuid;
|
|
7729
7947
|
};
|
|
7730
7948
|
query?: never;
|
|
7731
7949
|
url: "/v2/subscriptions/products/{product_uuid}";
|
|
@@ -7734,15 +7952,15 @@ export type GetSubscriptionProductErrors = {
|
|
|
7734
7952
|
/**
|
|
7735
7953
|
* Bad request. The request failed validation.
|
|
7736
7954
|
*/
|
|
7737
|
-
400:
|
|
7955
|
+
400: SubscriptionsErrorResponse;
|
|
7738
7956
|
/**
|
|
7739
7957
|
* Not found. The requested entity does not exist.
|
|
7740
7958
|
*/
|
|
7741
|
-
404:
|
|
7959
|
+
404: SubscriptionsErrorResponse;
|
|
7742
7960
|
/**
|
|
7743
7961
|
* Internal server error. There was a system failure in the platform.
|
|
7744
7962
|
*/
|
|
7745
|
-
500:
|
|
7963
|
+
500: SubscriptionsErrorResponse;
|
|
7746
7964
|
};
|
|
7747
7965
|
export type GetSubscriptionProductError = GetSubscriptionProductErrors[keyof GetSubscriptionProductErrors];
|
|
7748
7966
|
export type GetSubscriptionProductResponses = {
|
|
@@ -7760,7 +7978,7 @@ export type GetPlanData = {
|
|
|
7760
7978
|
/**
|
|
7761
7979
|
* The unique identifier of the plan.
|
|
7762
7980
|
*/
|
|
7763
|
-
plan_uuid:
|
|
7981
|
+
plan_uuid: SubscriptionsUuid;
|
|
7764
7982
|
};
|
|
7765
7983
|
query?: never;
|
|
7766
7984
|
url: "/v2/subscriptions/plans/{plan_uuid}";
|
|
@@ -7769,15 +7987,15 @@ export type GetPlanErrors = {
|
|
|
7769
7987
|
/**
|
|
7770
7988
|
* Bad request. The request failed validation.
|
|
7771
7989
|
*/
|
|
7772
|
-
400:
|
|
7990
|
+
400: SubscriptionsErrorResponse;
|
|
7773
7991
|
/**
|
|
7774
7992
|
* Not found. The requested entity does not exist.
|
|
7775
7993
|
*/
|
|
7776
|
-
404:
|
|
7994
|
+
404: SubscriptionsErrorResponse;
|
|
7777
7995
|
/**
|
|
7778
7996
|
* Internal server error. There was a system failure in the platform.
|
|
7779
7997
|
*/
|
|
7780
|
-
500:
|
|
7998
|
+
500: SubscriptionsErrorResponse;
|
|
7781
7999
|
};
|
|
7782
8000
|
export type GetPlanError = GetPlanErrors[keyof GetPlanErrors];
|
|
7783
8001
|
export type GetPlanResponses = {
|
|
@@ -7817,11 +8035,11 @@ export type ListOfferingsErrors = {
|
|
|
7817
8035
|
/**
|
|
7818
8036
|
* Bad request. The request failed validation.
|
|
7819
8037
|
*/
|
|
7820
|
-
400:
|
|
8038
|
+
400: SubscriptionsErrorResponse;
|
|
7821
8039
|
/**
|
|
7822
8040
|
* Internal server error. There was a system failure in the platform.
|
|
7823
8041
|
*/
|
|
7824
|
-
500:
|
|
8042
|
+
500: SubscriptionsErrorResponse;
|
|
7825
8043
|
};
|
|
7826
8044
|
export type ListOfferingsError = ListOfferingsErrors[keyof ListOfferingsErrors];
|
|
7827
8045
|
export type ListOfferingsResponses = {
|
|
@@ -7841,7 +8059,7 @@ export type GetOfferingData = {
|
|
|
7841
8059
|
/**
|
|
7842
8060
|
* The unique identifier of the offering.
|
|
7843
8061
|
*/
|
|
7844
|
-
offering_uuid:
|
|
8062
|
+
offering_uuid: SubscriptionsUuid;
|
|
7845
8063
|
};
|
|
7846
8064
|
query?: {
|
|
7847
8065
|
/**
|
|
@@ -7855,15 +8073,15 @@ export type GetOfferingErrors = {
|
|
|
7855
8073
|
/**
|
|
7856
8074
|
* Bad request. The request failed validation.
|
|
7857
8075
|
*/
|
|
7858
|
-
400:
|
|
8076
|
+
400: SubscriptionsErrorResponse;
|
|
7859
8077
|
/**
|
|
7860
8078
|
* Not found. The requested entity does not exist.
|
|
7861
8079
|
*/
|
|
7862
|
-
404:
|
|
8080
|
+
404: SubscriptionsErrorResponse;
|
|
7863
8081
|
/**
|
|
7864
8082
|
* Internal server error. There was a system failure in the platform.
|
|
7865
8083
|
*/
|
|
7866
|
-
500:
|
|
8084
|
+
500: SubscriptionsErrorResponse;
|
|
7867
8085
|
};
|
|
7868
8086
|
export type GetOfferingError = GetOfferingErrors[keyof GetOfferingErrors];
|
|
7869
8087
|
export type GetOfferingResponses = {
|
|
@@ -7882,7 +8100,7 @@ export type ListOfferingPlansData = {
|
|
|
7882
8100
|
/**
|
|
7883
8101
|
* The unique identifier of the offering.
|
|
7884
8102
|
*/
|
|
7885
|
-
offering_uuid:
|
|
8103
|
+
offering_uuid: SubscriptionsUuid;
|
|
7886
8104
|
};
|
|
7887
8105
|
query?: {
|
|
7888
8106
|
/**
|
|
@@ -7900,11 +8118,11 @@ export type ListOfferingPlansErrors = {
|
|
|
7900
8118
|
/**
|
|
7901
8119
|
* Not found. The requested entity does not exist.
|
|
7902
8120
|
*/
|
|
7903
|
-
404:
|
|
8121
|
+
404: SubscriptionsErrorResponse;
|
|
7904
8122
|
/**
|
|
7905
8123
|
* Internal server error. There was a system failure in the platform.
|
|
7906
8124
|
*/
|
|
7907
|
-
500:
|
|
8125
|
+
500: SubscriptionsErrorResponse;
|
|
7908
8126
|
};
|
|
7909
8127
|
export type ListOfferingPlansError = ListOfferingPlansErrors[keyof ListOfferingPlansErrors];
|
|
7910
8128
|
export type ListOfferingPlansResponses = {
|
|
@@ -7923,7 +8141,7 @@ export type ListOfferingFeaturesData = {
|
|
|
7923
8141
|
/**
|
|
7924
8142
|
* The unique identifier of the offering.
|
|
7925
8143
|
*/
|
|
7926
|
-
offering_uuid:
|
|
8144
|
+
offering_uuid: SubscriptionsUuid;
|
|
7927
8145
|
};
|
|
7928
8146
|
query?: {
|
|
7929
8147
|
/**
|
|
@@ -7941,11 +8159,11 @@ export type ListOfferingFeaturesErrors = {
|
|
|
7941
8159
|
/**
|
|
7942
8160
|
* Not found. The requested entity does not exist.
|
|
7943
8161
|
*/
|
|
7944
|
-
404:
|
|
8162
|
+
404: SubscriptionsErrorResponse;
|
|
7945
8163
|
/**
|
|
7946
8164
|
* Internal server error. There was a system failure in the platform.
|
|
7947
8165
|
*/
|
|
7948
|
-
500:
|
|
8166
|
+
500: SubscriptionsErrorResponse;
|
|
7949
8167
|
};
|
|
7950
8168
|
export type ListOfferingFeaturesError = ListOfferingFeaturesErrors[keyof ListOfferingFeaturesErrors];
|
|
7951
8169
|
export type ListOfferingFeaturesResponses = {
|
|
@@ -7964,7 +8182,7 @@ export type ListOfferingProductsData = {
|
|
|
7964
8182
|
/**
|
|
7965
8183
|
* The unique identifier of the offering.
|
|
7966
8184
|
*/
|
|
7967
|
-
offering_uuid:
|
|
8185
|
+
offering_uuid: SubscriptionsUuid;
|
|
7968
8186
|
};
|
|
7969
8187
|
query?: {
|
|
7970
8188
|
/**
|
|
@@ -7982,11 +8200,11 @@ export type ListOfferingProductsErrors = {
|
|
|
7982
8200
|
/**
|
|
7983
8201
|
* Not found. The requested entity does not exist.
|
|
7984
8202
|
*/
|
|
7985
|
-
404:
|
|
8203
|
+
404: SubscriptionsErrorResponse;
|
|
7986
8204
|
/**
|
|
7987
8205
|
* Internal server error. There was a system failure in the platform.
|
|
7988
8206
|
*/
|
|
7989
|
-
500:
|
|
8207
|
+
500: SubscriptionsErrorResponse;
|
|
7990
8208
|
};
|
|
7991
8209
|
export type ListOfferingProductsError = ListOfferingProductsErrors[keyof ListOfferingProductsErrors];
|
|
7992
8210
|
export type ListOfferingProductsResponses = {
|
|
@@ -8005,7 +8223,7 @@ export type GetFeatureData = {
|
|
|
8005
8223
|
/**
|
|
8006
8224
|
* The unique identifier of a feature.
|
|
8007
8225
|
*/
|
|
8008
|
-
feature_uuid:
|
|
8226
|
+
feature_uuid: SubscriptionsUuid;
|
|
8009
8227
|
};
|
|
8010
8228
|
query?: never;
|
|
8011
8229
|
url: "/v2/subscriptions/features/{feature_uuid}";
|
|
@@ -8014,15 +8232,15 @@ export type GetFeatureErrors = {
|
|
|
8014
8232
|
/**
|
|
8015
8233
|
* Bad request. The request failed validation.
|
|
8016
8234
|
*/
|
|
8017
|
-
400:
|
|
8235
|
+
400: SubscriptionsErrorResponse;
|
|
8018
8236
|
/**
|
|
8019
8237
|
* Not found. The requested entity does not exist.
|
|
8020
8238
|
*/
|
|
8021
|
-
404:
|
|
8239
|
+
404: SubscriptionsErrorResponse;
|
|
8022
8240
|
/**
|
|
8023
8241
|
* Internal server error. There was a system failure in the platform.
|
|
8024
8242
|
*/
|
|
8025
|
-
500:
|
|
8243
|
+
500: SubscriptionsErrorResponse;
|
|
8026
8244
|
};
|
|
8027
8245
|
export type GetFeatureError = GetFeatureErrors[keyof GetFeatureErrors];
|
|
8028
8246
|
export type GetFeatureResponses = {
|
|
@@ -8034,3 +8252,71 @@ export type GetFeatureResponses = {
|
|
|
8034
8252
|
};
|
|
8035
8253
|
};
|
|
8036
8254
|
export type GetFeatureResponse = GetFeatureResponses[keyof GetFeatureResponses];
|
|
8255
|
+
export type GetStockData = {
|
|
8256
|
+
body?: never;
|
|
8257
|
+
path: {
|
|
8258
|
+
/**
|
|
8259
|
+
* The unique identifier of the product.
|
|
8260
|
+
*/
|
|
8261
|
+
product_uuid: InventoriesUuid;
|
|
8262
|
+
};
|
|
8263
|
+
query?: never;
|
|
8264
|
+
url: "/v2/inventories/{product_uuid}";
|
|
8265
|
+
};
|
|
8266
|
+
export type GetStockErrors = {
|
|
8267
|
+
/**
|
|
8268
|
+
* Not found. The requested entity does not exist.
|
|
8269
|
+
*/
|
|
8270
|
+
404: InventoriesErrorResponse;
|
|
8271
|
+
/**
|
|
8272
|
+
* Internal server error. There was a system failure in the platform.
|
|
8273
|
+
*/
|
|
8274
|
+
500: InventoriesErrorResponse;
|
|
8275
|
+
};
|
|
8276
|
+
export type GetStockError = GetStockErrors[keyof GetStockErrors];
|
|
8277
|
+
export type GetStockResponses = {
|
|
8278
|
+
/**
|
|
8279
|
+
* Success. Returns the stock for the given product UUID
|
|
8280
|
+
*/
|
|
8281
|
+
200: {
|
|
8282
|
+
data: StockResponse;
|
|
8283
|
+
};
|
|
8284
|
+
};
|
|
8285
|
+
export type GetStockResponse = GetStockResponses[keyof GetStockResponses];
|
|
8286
|
+
export type ListLocationsData = {
|
|
8287
|
+
body?: never;
|
|
8288
|
+
path?: never;
|
|
8289
|
+
query?: {
|
|
8290
|
+
/**
|
|
8291
|
+
* The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8292
|
+
*/
|
|
8293
|
+
"page[offset]"?: number;
|
|
8294
|
+
/**
|
|
8295
|
+
* The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the the [**page length**](https://elasticpath.dev/docs/commerce-cloud/global-project-settings/settings-overview#page-length) store setting is used.
|
|
8296
|
+
*/
|
|
8297
|
+
"page[limit]"?: number;
|
|
8298
|
+
/**
|
|
8299
|
+
* Some Inventories API endpoints support filtering. For the general syntax, see [**Filtering**](/guides/Getting-Started/filtering), but you must go to a specific endpoint to understand the attributes and operators an endpoint supports.
|
|
8300
|
+
*
|
|
8301
|
+
*/
|
|
8302
|
+
filter?: string;
|
|
8303
|
+
};
|
|
8304
|
+
url: "/v2/inventories/locations";
|
|
8305
|
+
};
|
|
8306
|
+
export type ListLocationsErrors = {
|
|
8307
|
+
/**
|
|
8308
|
+
* Bad request. The request failed validation.
|
|
8309
|
+
*/
|
|
8310
|
+
400: InventoriesErrorResponse;
|
|
8311
|
+
};
|
|
8312
|
+
export type ListLocationsError = ListLocationsErrors[keyof ListLocationsErrors];
|
|
8313
|
+
export type ListLocationsResponses = {
|
|
8314
|
+
/**
|
|
8315
|
+
* Success. A list of locations is returned
|
|
8316
|
+
*/
|
|
8317
|
+
200: {
|
|
8318
|
+
data?: Array<Location>;
|
|
8319
|
+
links?: Links2;
|
|
8320
|
+
};
|
|
8321
|
+
};
|
|
8322
|
+
export type ListLocationsResponse = ListLocationsResponses[keyof ListLocationsResponses];
|