@epcc-sdk/sdks-shopper 0.0.21 → 0.0.22
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.
|
@@ -2252,7 +2252,9 @@ export declare const postV2AccountMembersTokensQueryKey: (options?: Options<Post
|
|
|
2252
2252
|
})[];
|
|
2253
2253
|
export declare const postV2AccountMembersTokensOptions: (options?: Options<PostV2AccountMembersTokensData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<{
|
|
2254
2254
|
data?: Array<import("../types.gen").AccountManagementAuthenticationTokenResponse>;
|
|
2255
|
-
meta?: import("../types.gen").MetaList
|
|
2255
|
+
meta?: import("../types.gen").MetaList & {
|
|
2256
|
+
account_member_id?: import("../types.gen").MetaAccountMemberId;
|
|
2257
|
+
};
|
|
2256
2258
|
links?: {
|
|
2257
2259
|
current?: string;
|
|
2258
2260
|
first?: string;
|
|
@@ -2262,7 +2264,9 @@ export declare const postV2AccountMembersTokensOptions: (options?: Options<PostV
|
|
|
2262
2264
|
};
|
|
2263
2265
|
}, Error, {
|
|
2264
2266
|
data?: Array<import("../types.gen").AccountManagementAuthenticationTokenResponse>;
|
|
2265
|
-
meta?: import("../types.gen").MetaList
|
|
2267
|
+
meta?: import("../types.gen").MetaList & {
|
|
2268
|
+
account_member_id?: import("../types.gen").MetaAccountMemberId;
|
|
2269
|
+
};
|
|
2266
2270
|
links?: {
|
|
2267
2271
|
current?: string;
|
|
2268
2272
|
first?: string;
|
|
@@ -2276,7 +2280,9 @@ export declare const postV2AccountMembersTokensOptions: (options?: Options<PostV
|
|
|
2276
2280
|
})[]>, "queryFn"> & {
|
|
2277
2281
|
queryFn?: import("@tanstack/react-query").QueryFunction<{
|
|
2278
2282
|
data?: Array<import("../types.gen").AccountManagementAuthenticationTokenResponse>;
|
|
2279
|
-
meta?: import("../types.gen").MetaList
|
|
2283
|
+
meta?: import("../types.gen").MetaList & {
|
|
2284
|
+
account_member_id?: import("../types.gen").MetaAccountMemberId;
|
|
2285
|
+
};
|
|
2280
2286
|
links?: {
|
|
2281
2287
|
current?: string;
|
|
2282
2288
|
first?: string;
|
|
@@ -2295,7 +2301,9 @@ export declare const postV2AccountMembersTokensOptions: (options?: Options<PostV
|
|
|
2295
2301
|
})[] & {
|
|
2296
2302
|
[dataTagSymbol]: {
|
|
2297
2303
|
data?: Array<import("../types.gen").AccountManagementAuthenticationTokenResponse>;
|
|
2298
|
-
meta?: import("../types.gen").MetaList
|
|
2304
|
+
meta?: import("../types.gen").MetaList & {
|
|
2305
|
+
account_member_id?: import("../types.gen").MetaAccountMemberId;
|
|
2306
|
+
};
|
|
2299
2307
|
links?: {
|
|
2300
2308
|
current?: string;
|
|
2301
2309
|
first?: string;
|
|
@@ -2309,7 +2317,9 @@ export declare const postV2AccountMembersTokensOptions: (options?: Options<PostV
|
|
|
2309
2317
|
};
|
|
2310
2318
|
export declare const postV2AccountMembersTokensMutation: (options?: Partial<Options<PostV2AccountMembersTokensData>>) => UseMutationOptions<{
|
|
2311
2319
|
data?: Array<import("../types.gen").AccountManagementAuthenticationTokenResponse>;
|
|
2312
|
-
meta?: import("../types.gen").MetaList
|
|
2320
|
+
meta?: import("../types.gen").MetaList & {
|
|
2321
|
+
account_member_id?: import("../types.gen").MetaAccountMemberId;
|
|
2322
|
+
};
|
|
2313
2323
|
links?: {
|
|
2314
2324
|
current?: string;
|
|
2315
2325
|
first?: string;
|
package/dist/client/sdk.gen.d.ts
CHANGED
|
@@ -2477,7 +2477,9 @@ export declare const getV2AccountsAccountIdAccountMemberships: <ThrowOnError ext
|
|
|
2477
2477
|
*/
|
|
2478
2478
|
export declare const postV2AccountMembersTokens: <ThrowOnError extends boolean = false>(options?: Options<PostV2AccountMembersTokensData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<{
|
|
2479
2479
|
data?: Array<import("./types.gen").AccountManagementAuthenticationTokenResponse>;
|
|
2480
|
-
meta?: import("./types.gen").MetaList
|
|
2480
|
+
meta?: import("./types.gen").MetaList & {
|
|
2481
|
+
account_member_id?: import("./types.gen").MetaAccountMemberId;
|
|
2482
|
+
};
|
|
2481
2483
|
links?: {
|
|
2482
2484
|
current?: string;
|
|
2483
2485
|
first?: string;
|
|
@@ -1854,30 +1854,11 @@ export type CartResponse = {
|
|
|
1854
1854
|
timestamps?: CartCheckoutTimestamps;
|
|
1855
1855
|
};
|
|
1856
1856
|
relationships?: {
|
|
1857
|
-
customers?:
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
type?: string;
|
|
1863
|
-
/**
|
|
1864
|
-
* The ID of the customer.
|
|
1865
|
-
*/
|
|
1866
|
-
readonly id?: string;
|
|
1867
|
-
};
|
|
1868
|
-
};
|
|
1869
|
-
items?: {
|
|
1870
|
-
data?: {
|
|
1871
|
-
/**
|
|
1872
|
-
* The type of related object.
|
|
1873
|
-
*/
|
|
1874
|
-
type?: string;
|
|
1875
|
-
/**
|
|
1876
|
-
* The unique identifier for the cart item
|
|
1877
|
-
*/
|
|
1878
|
-
readonly id?: string;
|
|
1879
|
-
};
|
|
1880
|
-
};
|
|
1857
|
+
customers?: RelationshipArray;
|
|
1858
|
+
items?: RelationshipArray;
|
|
1859
|
+
accounts?: RelationshipArray;
|
|
1860
|
+
custom_discounts?: RelationshipArray;
|
|
1861
|
+
promotions?: RelationshipArray;
|
|
1881
1862
|
};
|
|
1882
1863
|
};
|
|
1883
1864
|
export type CartItemsObjectRequest = CartItemObject | SubscriptionItemObject | CartMergeObjectRequest | CustomItemObject | ReOrderObjectRequest | PromotionItemObject;
|
|
@@ -2271,11 +2252,11 @@ export type CartsBulkCustomDiscounts = {
|
|
|
2271
2252
|
options?: AddAllOrNothingOptionsObject;
|
|
2272
2253
|
};
|
|
2273
2254
|
export type CartsBulkCustomDiscountsResponse = {
|
|
2274
|
-
data?: Array<CartsCustomDiscountsResponse &
|
|
2255
|
+
data?: Array<CartsCustomDiscountsResponse & CartItemBulkCustomDiscountResponse>;
|
|
2275
2256
|
options?: AddAllOrNothingOptionsObject;
|
|
2276
2257
|
};
|
|
2277
2258
|
export type CartItemBulkCustomDiscountObject = CartsCustomDiscountsObject & CustomDiscountRelationshipsCartItemRequest;
|
|
2278
|
-
export type
|
|
2259
|
+
export type CartItemBulkCustomDiscountResponse = CartsCustomDiscountsResponse & CustomDiscountRelationshipsCartItemRequest;
|
|
2279
2260
|
export type CartsCustomDiscountsObject = {
|
|
2280
2261
|
/**
|
|
2281
2262
|
* Specifies an amount to be applied for the custom discount. It must be less than zero.
|
|
@@ -2812,10 +2793,38 @@ export type OrderPriceData = {
|
|
|
2812
2793
|
*/
|
|
2813
2794
|
currency?: string;
|
|
2814
2795
|
/**
|
|
2815
|
-
* Whether
|
|
2796
|
+
* Whether this price is tax inclusive.
|
|
2816
2797
|
*/
|
|
2817
2798
|
includes_tax?: boolean;
|
|
2818
2799
|
};
|
|
2800
|
+
/**
|
|
2801
|
+
* Relationship data entry
|
|
2802
|
+
*/
|
|
2803
|
+
export type RelationshipItem = {
|
|
2804
|
+
/**
|
|
2805
|
+
* The type of related resource.
|
|
2806
|
+
*/
|
|
2807
|
+
type?: string;
|
|
2808
|
+
/**
|
|
2809
|
+
* The ID of the related resource.
|
|
2810
|
+
*/
|
|
2811
|
+
id?: string;
|
|
2812
|
+
};
|
|
2813
|
+
/**
|
|
2814
|
+
* Array of relationships
|
|
2815
|
+
*/
|
|
2816
|
+
export type RelationshipArray = {
|
|
2817
|
+
/**
|
|
2818
|
+
* Individual relationships
|
|
2819
|
+
*/
|
|
2820
|
+
data?: Array<RelationshipItem>;
|
|
2821
|
+
};
|
|
2822
|
+
/**
|
|
2823
|
+
* Single relationship
|
|
2824
|
+
*/
|
|
2825
|
+
export type SingleRelationship = {
|
|
2826
|
+
data?: RelationshipItem;
|
|
2827
|
+
};
|
|
2819
2828
|
export type FormattedPriceData = {
|
|
2820
2829
|
/**
|
|
2821
2830
|
* The raw total of this cart.
|
|
@@ -2951,6 +2960,14 @@ export type OrderResponse = {
|
|
|
2951
2960
|
billing_address?: BillingAddress;
|
|
2952
2961
|
contact?: Contact;
|
|
2953
2962
|
shipping_address?: ShippingAddress;
|
|
2963
|
+
relationships?: {
|
|
2964
|
+
items?: RelationshipArray;
|
|
2965
|
+
custom_discounts?: RelationshipArray;
|
|
2966
|
+
promotions?: RelationshipArray;
|
|
2967
|
+
customer?: SingleRelationship;
|
|
2968
|
+
account?: SingleRelationship;
|
|
2969
|
+
account_member?: SingleRelationship;
|
|
2970
|
+
};
|
|
2954
2971
|
};
|
|
2955
2972
|
export type OrderMeta = {
|
|
2956
2973
|
timestamps?: CartCheckoutTimestamps;
|
|
@@ -2959,9 +2976,12 @@ export type OrderMeta = {
|
|
|
2959
2976
|
without_tax?: FormattedPriceData;
|
|
2960
2977
|
tax?: FormattedPriceData;
|
|
2961
2978
|
discount?: FormattedPriceData;
|
|
2979
|
+
balance_owing?: FormattedPriceData;
|
|
2962
2980
|
paid?: FormattedPriceData;
|
|
2963
2981
|
authorized?: FormattedPriceData;
|
|
2964
2982
|
without_discount?: FormattedPriceData;
|
|
2983
|
+
shipping?: FormattedPriceData;
|
|
2984
|
+
shipping_discount?: FormattedPriceData;
|
|
2965
2985
|
};
|
|
2966
2986
|
};
|
|
2967
2987
|
export type CustomerCheckout = {
|
|
@@ -3269,7 +3289,7 @@ export type Status = "active" | "inactive";
|
|
|
3269
3289
|
* Relationships are established between different subscription entities. For example, a product and a plan are related to an offering, as both are attached to it.
|
|
3270
3290
|
*/
|
|
3271
3291
|
export type Relationships = unknown;
|
|
3272
|
-
export type Relationship =
|
|
3292
|
+
export type Relationship = SubscriptionsSingleRelationship | ManyRelationship;
|
|
3273
3293
|
/**
|
|
3274
3294
|
* The list of resources that are related.
|
|
3275
3295
|
*/
|
|
@@ -3277,13 +3297,6 @@ export type ManyRelationship = {
|
|
|
3277
3297
|
data?: Array<RelationshipData>;
|
|
3278
3298
|
links?: RelationshipLinks;
|
|
3279
3299
|
};
|
|
3280
|
-
/**
|
|
3281
|
-
* The subscription resource that is related.
|
|
3282
|
-
*/
|
|
3283
|
-
export type SingleRelationship = {
|
|
3284
|
-
data?: RelationshipData;
|
|
3285
|
-
links?: RelationshipLinks;
|
|
3286
|
-
};
|
|
3287
3300
|
export type RelationshipData = {
|
|
3288
3301
|
id: SubscriptionsUuid;
|
|
3289
3302
|
/**
|
|
@@ -4756,6 +4769,13 @@ export type SubscriptionsTimestamps = {
|
|
|
4756
4769
|
*/
|
|
4757
4770
|
created_at: string;
|
|
4758
4771
|
};
|
|
4772
|
+
/**
|
|
4773
|
+
* The subscription resource that is related.
|
|
4774
|
+
*/
|
|
4775
|
+
export type SubscriptionsSingleRelationship = {
|
|
4776
|
+
data?: RelationshipData;
|
|
4777
|
+
links?: RelationshipLinks;
|
|
4778
|
+
};
|
|
4759
4779
|
export type SubscriptionsErrorResponse = {
|
|
4760
4780
|
errors: Array<SubscriptionsError>;
|
|
4761
4781
|
};
|
|
@@ -5184,6 +5204,10 @@ export type MetaListResults = {
|
|
|
5184
5204
|
*/
|
|
5185
5205
|
total?: number;
|
|
5186
5206
|
};
|
|
5207
|
+
/**
|
|
5208
|
+
* The unique identifier for the Account Member that authenticated. This is useful if `account_member_self_management` is enabled in [Account Authentication Settings](/docs/api/accounts/get-v-2-settings-account-authentication), so that the user can update details for their account.
|
|
5209
|
+
*/
|
|
5210
|
+
export type MetaAccountMemberId = string;
|
|
5187
5211
|
export type MetaList = {
|
|
5188
5212
|
page?: MetaListPage;
|
|
5189
5213
|
results?: MetaListResults;
|
|
@@ -5239,7 +5263,7 @@ export type AccountResponse = Account & ReadOnlyParentId & {
|
|
|
5239
5263
|
};
|
|
5240
5264
|
};
|
|
5241
5265
|
/**
|
|
5242
|
-
* Whether a user with [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) can update their own account member details. By default, this is disabled
|
|
5266
|
+
* Whether a user with an [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) can update their own account member details. By default, this is `disabled`. Set to `update_only` if you want the user to be able to update their own account member details (e.g., name, email, and if applicable their username and password). The user can update their own account member details by updating their [User Authentication Info](/docs/authentication/single-sign-on/user-authentication-info-api/update-a-user-authentication-info) using the `account_member_id` retrieved from the `meta` in the response of [Generating an Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) as the `id` and find the authentication credentials to update by calling the [Get All User Authentication Password Profile Info](/docs/authentication/single-sign-on/user-authentication-password-profiles-api/get-all-user-authentication-password-profile-info) endpoint.
|
|
5243
5267
|
*/
|
|
5244
5268
|
export type AccountMemberSelfManagement = "disabled" | "update_only";
|
|
5245
5269
|
export type AccountAuthenticationSettings = {
|
|
@@ -5256,7 +5280,7 @@ export type AccountAuthenticationSettings = {
|
|
|
5256
5280
|
*/
|
|
5257
5281
|
auto_create_account_for_account_members?: boolean;
|
|
5258
5282
|
/**
|
|
5259
|
-
* Whether a user with [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) can update their own account member details. By default, this is disabled
|
|
5283
|
+
* Whether a user with an [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) can update their own account member details. By default, this is `disabled`. Set to `update_only` if you want the user to be able to update their own account member details (e.g., name, email, and if applicable their username and password). The user can update their own account member details by updating their [User Authentication Info](/docs/authentication/single-sign-on/user-authentication-info-api/update-a-user-authentication-info) using the `account_member_id` retrieved from the `meta` in the response of [Generating an Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens) as the `id` and find the authentication credentials to update by calling the [Get All User Authentication Password Profile Info](/docs/authentication/single-sign-on/user-authentication-password-profiles-api/get-all-user-authentication-password-profile-info) endpoint.
|
|
5260
5284
|
*/
|
|
5261
5285
|
account_member_self_management?: "disabled" | "update_only";
|
|
5262
5286
|
/**
|
|
@@ -7720,7 +7744,7 @@ export type GetCartsResponses = {
|
|
|
7720
7744
|
};
|
|
7721
7745
|
export type GetCartsResponse = GetCartsResponses[keyof GetCartsResponses];
|
|
7722
7746
|
export type CreateACartData = {
|
|
7723
|
-
body?: {
|
|
7747
|
+
body?: ResponseData & {
|
|
7724
7748
|
data?: CartsRequest;
|
|
7725
7749
|
};
|
|
7726
7750
|
headers?: {
|
|
@@ -9850,7 +9874,9 @@ export type PostV2AccountMembersTokensResponses = {
|
|
|
9850
9874
|
*/
|
|
9851
9875
|
201: {
|
|
9852
9876
|
data?: Array<AccountManagementAuthenticationTokenResponse>;
|
|
9853
|
-
meta?: MetaList
|
|
9877
|
+
meta?: MetaList & {
|
|
9878
|
+
account_member_id?: MetaAccountMemberId;
|
|
9879
|
+
};
|
|
9854
9880
|
links?: {
|
|
9855
9881
|
/**
|
|
9856
9882
|
* Always the current page.
|