commerce-sdk-isomorphic 4.0.1-preview-shopper-configurations.0 → 4.1.0
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/README.md +57 -0
- package/lib/clientConfig.cjs.d.ts +4 -2
- package/lib/clientConfig.cjs.js +1 -1
- package/lib/clientConfig.d.ts +4 -2
- package/lib/clientConfig.js +1 -1
- package/lib/helpers.cjs.d.ts +9 -9
- package/lib/helpers.cjs.js +1 -1
- package/lib/helpers.d.ts +9 -9
- package/lib/helpers.js +1 -1
- package/lib/index.cjs.d.ts +333 -1025
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +333 -1025
- package/lib/index.esm.js +1 -1
- package/lib/shopperBaskets.cjs.d.ts +6 -1
- package/lib/shopperBaskets.cjs.js +1 -1
- package/lib/shopperBaskets.d.ts +6 -1
- package/lib/shopperBaskets.js +1 -1
- package/lib/shopperBasketsv2.cjs.d.ts +6 -1
- package/lib/shopperBasketsv2.cjs.js +1 -1
- package/lib/shopperBasketsv2.d.ts +6 -1
- package/lib/shopperBasketsv2.js +1 -1
- package/lib/shopperConsents.cjs.d.ts +6 -1
- package/lib/shopperConsents.cjs.js +1 -1
- package/lib/shopperConsents.d.ts +6 -1
- package/lib/shopperConsents.js +1 -1
- package/lib/shopperContext.cjs.d.ts +6 -1
- package/lib/shopperContext.cjs.js +1 -1
- package/lib/shopperContext.d.ts +6 -1
- package/lib/shopperContext.js +1 -1
- package/lib/shopperCustomers.cjs.d.ts +11 -246
- package/lib/shopperCustomers.cjs.js +1 -1
- package/lib/shopperCustomers.d.ts +11 -246
- package/lib/shopperCustomers.js +1 -1
- package/lib/shopperExperience.cjs.d.ts +6 -1
- package/lib/shopperExperience.cjs.js +1 -1
- package/lib/shopperExperience.d.ts +6 -1
- package/lib/shopperExperience.js +1 -1
- package/lib/shopperGiftCertificates.cjs.d.ts +6 -1
- package/lib/shopperGiftCertificates.cjs.js +1 -1
- package/lib/shopperGiftCertificates.d.ts +6 -1
- package/lib/shopperGiftCertificates.js +1 -1
- package/lib/shopperLogin.cjs.d.ts +6 -1
- package/lib/shopperLogin.cjs.js +1 -1
- package/lib/shopperLogin.d.ts +6 -1
- package/lib/shopperLogin.js +1 -1
- package/lib/shopperOrders.cjs.d.ts +6 -1
- package/lib/shopperOrders.cjs.js +1 -1
- package/lib/shopperOrders.d.ts +6 -1
- package/lib/shopperOrders.js +1 -1
- package/lib/shopperProducts.cjs.d.ts +6 -1
- package/lib/shopperProducts.cjs.js +1 -1
- package/lib/shopperProducts.d.ts +6 -1
- package/lib/shopperProducts.js +1 -1
- package/lib/shopperPromotions.cjs.d.ts +6 -1
- package/lib/shopperPromotions.cjs.js +1 -1
- package/lib/shopperPromotions.d.ts +6 -1
- package/lib/shopperPromotions.js +1 -1
- package/lib/shopperSearch.cjs.d.ts +6 -1
- package/lib/shopperSearch.cjs.js +1 -1
- package/lib/shopperSearch.d.ts +6 -1
- package/lib/shopperSearch.js +1 -1
- package/lib/shopperSeo.cjs.d.ts +6 -1
- package/lib/shopperSeo.cjs.js +1 -1
- package/lib/shopperSeo.d.ts +6 -1
- package/lib/shopperSeo.js +1 -1
- package/lib/shopperStores.cjs.d.ts +6 -1
- package/lib/shopperStores.cjs.js +1 -1
- package/lib/shopperStores.d.ts +6 -1
- package/lib/shopperStores.js +1 -1
- package/lib/version.cjs.d.ts +1 -1
- package/lib/version.cjs.js +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +4 -4
- package/lib/shopperConfigurations.cjs.d.ts +0 -601
- package/lib/shopperConfigurations.cjs.js +0 -1
- package/lib/shopperConfigurations.d.ts +0 -601
- package/lib/shopperConfigurations.js +0 -1
|
@@ -70,6 +70,7 @@ type BrowserRequestInit = RequestInit;
|
|
|
70
70
|
* Using the right properties in the right context is left to the user.
|
|
71
71
|
*/
|
|
72
72
|
type FetchOptions = NodeRequestInit & BrowserRequestInit;
|
|
73
|
+
type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
|
|
73
74
|
/**
|
|
74
75
|
* Base options that can be passed to the `ClientConfig` class.
|
|
75
76
|
*/
|
|
@@ -81,6 +82,7 @@ interface ClientConfigInit<Params extends BaseUriParameters> {
|
|
|
81
82
|
};
|
|
82
83
|
parameters: Params;
|
|
83
84
|
fetchOptions?: FetchOptions;
|
|
85
|
+
fetch?: FetchFunction;
|
|
84
86
|
transformRequest?: (data: unknown, headers: {
|
|
85
87
|
[key: string]: string;
|
|
86
88
|
}) => Required<FetchOptions>["body"];
|
|
@@ -97,6 +99,7 @@ declare class ClientConfig<Params extends BaseUriParameters> implements ClientCo
|
|
|
97
99
|
};
|
|
98
100
|
parameters: Params;
|
|
99
101
|
fetchOptions: FetchOptions;
|
|
102
|
+
fetch?: FetchFunction;
|
|
100
103
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
101
104
|
throwOnBadResponse: boolean;
|
|
102
105
|
constructor(config: ClientConfigInit<Params>);
|
|
@@ -2124,34 +2127,6 @@ type CustomerPaymentInstrumentRequest = {
|
|
|
2124
2127
|
} & {
|
|
2125
2128
|
[key: string]: any;
|
|
2126
2129
|
};
|
|
2127
|
-
/**
|
|
2128
|
-
* @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
|
|
2129
|
-
*
|
|
2130
|
-
* @property expirationMonth: The month when the payment card expires.
|
|
2131
|
-
*
|
|
2132
|
-
* @property expirationYear: The year when the payment card expires.
|
|
2133
|
-
*
|
|
2134
|
-
*/
|
|
2135
|
-
type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
|
|
2136
|
-
expirationMonth?: number;
|
|
2137
|
-
expirationYear?: number;
|
|
2138
|
-
} & {
|
|
2139
|
-
[key: string]: any;
|
|
2140
|
-
};
|
|
2141
|
-
/**
|
|
2142
|
-
* @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
|
|
2143
|
-
*
|
|
2144
|
-
* @property default: The default payment instrument.
|
|
2145
|
-
*
|
|
2146
|
-
* @property paymentCard:
|
|
2147
|
-
*
|
|
2148
|
-
*/
|
|
2149
|
-
type CustomerPaymentInstrumentUpdateRequest = {
|
|
2150
|
-
default?: boolean;
|
|
2151
|
-
paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
|
|
2152
|
-
} & {
|
|
2153
|
-
[key: string]: any;
|
|
2154
|
-
};
|
|
2155
2130
|
/**
|
|
2156
2131
|
* @type ProductListEvent: Document representing a product list event.
|
|
2157
2132
|
*
|
|
@@ -2794,14 +2769,6 @@ type updateCustomerPasswordPathParameters = {
|
|
|
2794
2769
|
customerId: string;
|
|
2795
2770
|
organizationId: string;
|
|
2796
2771
|
};
|
|
2797
|
-
type updateCustomerPaymentInstrumentQueryParameters = {
|
|
2798
|
-
siteId: string;
|
|
2799
|
-
};
|
|
2800
|
-
type updateCustomerPaymentInstrumentPathParameters = {
|
|
2801
|
-
paymentInstrumentId: string;
|
|
2802
|
-
customerId: string;
|
|
2803
|
-
organizationId: string;
|
|
2804
|
-
};
|
|
2805
2772
|
type updateCustomerProductListQueryParameters = {
|
|
2806
2773
|
siteId: string;
|
|
2807
2774
|
};
|
|
@@ -2822,11 +2789,11 @@ type updateCustomerProductListItemPathParameters = {
|
|
|
2822
2789
|
/**
|
|
2823
2790
|
* All path parameters that are used by at least one ShopperCustomers method.
|
|
2824
2791
|
*/
|
|
2825
|
-
type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters &
|
|
2792
|
+
type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
|
|
2826
2793
|
/**
|
|
2827
2794
|
* All query parameters that are used by at least one ShopperCustomers method.
|
|
2828
2795
|
*/
|
|
2829
|
-
type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters &
|
|
2796
|
+
type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
|
|
2830
2797
|
/**
|
|
2831
2798
|
* All parameters that are used by ShopperCustomers.
|
|
2832
2799
|
*/
|
|
@@ -2946,7 +2913,6 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
2946
2913
|
updateCustomer: string;
|
|
2947
2914
|
updateCustomerAddress: string;
|
|
2948
2915
|
updateCustomerPassword: string;
|
|
2949
|
-
updateCustomerPaymentInstrument: string;
|
|
2950
2916
|
updateCustomerProductList: string;
|
|
2951
2917
|
updateCustomerProductListItem: string;
|
|
2952
2918
|
};
|
|
@@ -3249,18 +3215,6 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
3249
3215
|
"organizationId",
|
|
3250
3216
|
"siteId"
|
|
3251
3217
|
];
|
|
3252
|
-
readonly updateCustomerPaymentInstrument: readonly [
|
|
3253
|
-
"paymentInstrumentId",
|
|
3254
|
-
"customerId",
|
|
3255
|
-
"organizationId",
|
|
3256
|
-
"siteId"
|
|
3257
|
-
];
|
|
3258
|
-
readonly updateCustomerPaymentInstrumentRequired: readonly [
|
|
3259
|
-
"paymentInstrumentId",
|
|
3260
|
-
"customerId",
|
|
3261
|
-
"organizationId",
|
|
3262
|
-
"siteId"
|
|
3263
|
-
];
|
|
3264
3218
|
readonly updateCustomerProductList: readonly [
|
|
3265
3219
|
"listId",
|
|
3266
3220
|
"customerId",
|
|
@@ -4695,61 +4649,6 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
4695
4649
|
};
|
|
4696
4650
|
body: PasswordChangeRequest & CustomRequestBody;
|
|
4697
4651
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
4698
|
-
/**
|
|
4699
|
-
*
|
|
4700
|
-
*
|
|
4701
|
-
* If you would like to get a raw Response object use the other updateCustomerPaymentInstrument function.
|
|
4702
|
-
*
|
|
4703
|
-
* @param options - An object containing the options for this method.
|
|
4704
|
-
* @param options.parameters - An object containing the parameters for this method.
|
|
4705
|
-
* @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
|
|
4706
|
-
* @param options.parameters.customerId - The customer ID.
|
|
4707
|
-
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
4708
|
-
* @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
|
|
4709
|
-
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
4710
|
-
* @param options.body - The data to send as the request body.
|
|
4711
|
-
*
|
|
4712
|
-
* @returns A promise of type CustomerPaymentInstrument.
|
|
4713
|
-
*/
|
|
4714
|
-
updateCustomerPaymentInstrument(options: RequireParametersUnlessAllAreOptional<{
|
|
4715
|
-
parameters?: CompositeParameters<{
|
|
4716
|
-
paymentInstrumentId: string;
|
|
4717
|
-
customerId: string;
|
|
4718
|
-
organizationId: string;
|
|
4719
|
-
siteId: string;
|
|
4720
|
-
} & QueryParameters, ConfigParameters>;
|
|
4721
|
-
headers?: {
|
|
4722
|
-
[key: string]: string;
|
|
4723
|
-
};
|
|
4724
|
-
body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
|
|
4725
|
-
}>): Promise<CustomerPaymentInstrument>;
|
|
4726
|
-
/**
|
|
4727
|
-
*
|
|
4728
|
-
*
|
|
4729
|
-
* @param options - An object containing the options for this method.
|
|
4730
|
-
* @param options.parameters - An object containing the parameters for this method.
|
|
4731
|
-
* @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
|
|
4732
|
-
* @param options.parameters.customerId - The customer ID.
|
|
4733
|
-
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
4734
|
-
* @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
|
|
4735
|
-
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
4736
|
-
* @param options.body - The data to send as the request body.
|
|
4737
|
-
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
4738
|
-
*
|
|
4739
|
-
* @returns A promise of type Response if rawResponse is true, a promise of type CustomerPaymentInstrument otherwise.
|
|
4740
|
-
*/
|
|
4741
|
-
updateCustomerPaymentInstrument<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
4742
|
-
parameters?: CompositeParameters<{
|
|
4743
|
-
paymentInstrumentId: string;
|
|
4744
|
-
customerId: string;
|
|
4745
|
-
organizationId: string;
|
|
4746
|
-
siteId: string;
|
|
4747
|
-
} & QueryParameters, ConfigParameters>;
|
|
4748
|
-
headers?: {
|
|
4749
|
-
[key: string]: string;
|
|
4750
|
-
};
|
|
4751
|
-
body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
|
|
4752
|
-
}>, rawResponse?: T): Promise<T extends true ? Response : CustomerPaymentInstrument>;
|
|
4753
4652
|
/**
|
|
4754
4653
|
*
|
|
4755
4654
|
*
|
|
@@ -4959,6 +4858,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
4959
4858
|
* Using the right properties in the right context is left to the user.
|
|
4960
4859
|
*/
|
|
4961
4860
|
type FetchOptions = NodeRequestInit & BrowserRequestInit;
|
|
4861
|
+
type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
|
|
4962
4862
|
/**
|
|
4963
4863
|
* Base options that can be passed to the `ClientConfig` class.
|
|
4964
4864
|
*/
|
|
@@ -4970,12 +4870,12 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
4970
4870
|
};
|
|
4971
4871
|
parameters: Params;
|
|
4972
4872
|
fetchOptions?: FetchOptions;
|
|
4873
|
+
fetch?: FetchFunction;
|
|
4973
4874
|
transformRequest?: (data: unknown, headers: {
|
|
4974
4875
|
[key: string]: string;
|
|
4975
4876
|
}) => Required<FetchOptions>["body"];
|
|
4976
4877
|
throwOnBadResponse?: boolean;
|
|
4977
4878
|
}
|
|
4978
|
-
type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
|
|
4979
4879
|
/**
|
|
4980
4880
|
* Configuration parameters common to Commerce SDK clients
|
|
4981
4881
|
*/
|
|
@@ -4987,6 +4887,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
4987
4887
|
};
|
|
4988
4888
|
parameters: Params;
|
|
4989
4889
|
fetchOptions: FetchOptions;
|
|
4890
|
+
fetch?: FetchFunction;
|
|
4990
4891
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
4991
4892
|
throwOnBadResponse: boolean;
|
|
4992
4893
|
constructor(config: ClientConfigInit<Params>);
|
|
@@ -7014,34 +6915,6 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
7014
6915
|
} & {
|
|
7015
6916
|
[key: string]: any;
|
|
7016
6917
|
};
|
|
7017
|
-
/**
|
|
7018
|
-
* @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
|
|
7019
|
-
*
|
|
7020
|
-
* @property expirationMonth: The month when the payment card expires.
|
|
7021
|
-
*
|
|
7022
|
-
* @property expirationYear: The year when the payment card expires.
|
|
7023
|
-
*
|
|
7024
|
-
*/
|
|
7025
|
-
type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
|
|
7026
|
-
expirationMonth?: number;
|
|
7027
|
-
expirationYear?: number;
|
|
7028
|
-
} & {
|
|
7029
|
-
[key: string]: any;
|
|
7030
|
-
};
|
|
7031
|
-
/**
|
|
7032
|
-
* @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
|
|
7033
|
-
*
|
|
7034
|
-
* @property default: The default payment instrument.
|
|
7035
|
-
*
|
|
7036
|
-
* @property paymentCard:
|
|
7037
|
-
*
|
|
7038
|
-
*/
|
|
7039
|
-
type CustomerPaymentInstrumentUpdateRequest = {
|
|
7040
|
-
default?: boolean;
|
|
7041
|
-
paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
|
|
7042
|
-
} & {
|
|
7043
|
-
[key: string]: any;
|
|
7044
|
-
};
|
|
7045
6918
|
/**
|
|
7046
6919
|
* @type ProductListEvent: Document representing a product list event.
|
|
7047
6920
|
*
|
|
@@ -7684,14 +7557,6 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
7684
7557
|
customerId: string;
|
|
7685
7558
|
organizationId: string;
|
|
7686
7559
|
};
|
|
7687
|
-
type updateCustomerPaymentInstrumentQueryParameters = {
|
|
7688
|
-
siteId: string;
|
|
7689
|
-
};
|
|
7690
|
-
type updateCustomerPaymentInstrumentPathParameters = {
|
|
7691
|
-
paymentInstrumentId: string;
|
|
7692
|
-
customerId: string;
|
|
7693
|
-
organizationId: string;
|
|
7694
|
-
};
|
|
7695
7560
|
type updateCustomerProductListQueryParameters = {
|
|
7696
7561
|
siteId: string;
|
|
7697
7562
|
};
|
|
@@ -7712,11 +7577,11 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
7712
7577
|
/**
|
|
7713
7578
|
* All path parameters that are used by at least one ShopperCustomers method.
|
|
7714
7579
|
*/
|
|
7715
|
-
type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters &
|
|
7580
|
+
type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
|
|
7716
7581
|
/**
|
|
7717
7582
|
* All query parameters that are used by at least one ShopperCustomers method.
|
|
7718
7583
|
*/
|
|
7719
|
-
type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters &
|
|
7584
|
+
type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
|
|
7720
7585
|
/**
|
|
7721
7586
|
* All parameters that are used by ShopperCustomers.
|
|
7722
7587
|
*/
|
|
@@ -7836,7 +7701,6 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
7836
7701
|
updateCustomer: string;
|
|
7837
7702
|
updateCustomerAddress: string;
|
|
7838
7703
|
updateCustomerPassword: string;
|
|
7839
|
-
updateCustomerPaymentInstrument: string;
|
|
7840
7704
|
updateCustomerProductList: string;
|
|
7841
7705
|
updateCustomerProductListItem: string;
|
|
7842
7706
|
};
|
|
@@ -8139,18 +8003,6 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
8139
8003
|
"organizationId",
|
|
8140
8004
|
"siteId"
|
|
8141
8005
|
];
|
|
8142
|
-
readonly updateCustomerPaymentInstrument: readonly [
|
|
8143
|
-
"paymentInstrumentId",
|
|
8144
|
-
"customerId",
|
|
8145
|
-
"organizationId",
|
|
8146
|
-
"siteId"
|
|
8147
|
-
];
|
|
8148
|
-
readonly updateCustomerPaymentInstrumentRequired: readonly [
|
|
8149
|
-
"paymentInstrumentId",
|
|
8150
|
-
"customerId",
|
|
8151
|
-
"organizationId",
|
|
8152
|
-
"siteId"
|
|
8153
|
-
];
|
|
8154
8006
|
readonly updateCustomerProductList: readonly [
|
|
8155
8007
|
"listId",
|
|
8156
8008
|
"customerId",
|
|
@@ -9585,61 +9437,6 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
9585
9437
|
};
|
|
9586
9438
|
body: PasswordChangeRequest & CustomRequestBody;
|
|
9587
9439
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
9588
|
-
/**
|
|
9589
|
-
*
|
|
9590
|
-
*
|
|
9591
|
-
* If you would like to get a raw Response object use the other updateCustomerPaymentInstrument function.
|
|
9592
|
-
*
|
|
9593
|
-
* @param options - An object containing the options for this method.
|
|
9594
|
-
* @param options.parameters - An object containing the parameters for this method.
|
|
9595
|
-
* @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
|
|
9596
|
-
* @param options.parameters.customerId - The customer ID.
|
|
9597
|
-
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
9598
|
-
* @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
|
|
9599
|
-
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
9600
|
-
* @param options.body - The data to send as the request body.
|
|
9601
|
-
*
|
|
9602
|
-
* @returns A promise of type CustomerPaymentInstrument.
|
|
9603
|
-
*/
|
|
9604
|
-
updateCustomerPaymentInstrument(options: RequireParametersUnlessAllAreOptional<{
|
|
9605
|
-
parameters?: CompositeParameters<{
|
|
9606
|
-
paymentInstrumentId: string;
|
|
9607
|
-
customerId: string;
|
|
9608
|
-
organizationId: string;
|
|
9609
|
-
siteId: string;
|
|
9610
|
-
} & QueryParameters, ConfigParameters>;
|
|
9611
|
-
headers?: {
|
|
9612
|
-
[key: string]: string;
|
|
9613
|
-
};
|
|
9614
|
-
body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
|
|
9615
|
-
}>): Promise<CustomerPaymentInstrument>;
|
|
9616
|
-
/**
|
|
9617
|
-
*
|
|
9618
|
-
*
|
|
9619
|
-
* @param options - An object containing the options for this method.
|
|
9620
|
-
* @param options.parameters - An object containing the parameters for this method.
|
|
9621
|
-
* @param options.parameters.paymentInstrumentId - The ID of the payment instrument to be retrievedCustomer.
|
|
9622
|
-
* @param options.parameters.customerId - The customer ID.
|
|
9623
|
-
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
9624
|
-
* @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
|
|
9625
|
-
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
9626
|
-
* @param options.body - The data to send as the request body.
|
|
9627
|
-
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
9628
|
-
*
|
|
9629
|
-
* @returns A promise of type Response if rawResponse is true, a promise of type CustomerPaymentInstrument otherwise.
|
|
9630
|
-
*/
|
|
9631
|
-
updateCustomerPaymentInstrument<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
9632
|
-
parameters?: CompositeParameters<{
|
|
9633
|
-
paymentInstrumentId: string;
|
|
9634
|
-
customerId: string;
|
|
9635
|
-
organizationId: string;
|
|
9636
|
-
siteId: string;
|
|
9637
|
-
} & QueryParameters, ConfigParameters>;
|
|
9638
|
-
headers?: {
|
|
9639
|
-
[key: string]: string;
|
|
9640
|
-
};
|
|
9641
|
-
body: CustomerPaymentInstrumentUpdateRequest & CustomRequestBody;
|
|
9642
|
-
}>, rawResponse?: T): Promise<T extends true ? Response : CustomerPaymentInstrument>;
|
|
9643
9440
|
/**
|
|
9644
9441
|
*
|
|
9645
9442
|
*
|
|
@@ -11797,34 +11594,6 @@ declare namespace ShopperCustomersModelTypes {
|
|
|
11797
11594
|
} & {
|
|
11798
11595
|
[key: string]: any;
|
|
11799
11596
|
};
|
|
11800
|
-
/**
|
|
11801
|
-
* @type CustomerPaymentInstrumentUpdateRequestPaymentCard: The payment card expiration information.
|
|
11802
|
-
*
|
|
11803
|
-
* @property expirationMonth: The month when the payment card expires.
|
|
11804
|
-
*
|
|
11805
|
-
* @property expirationYear: The year when the payment card expires.
|
|
11806
|
-
*
|
|
11807
|
-
*/
|
|
11808
|
-
type CustomerPaymentInstrumentUpdateRequestPaymentCard = {
|
|
11809
|
-
expirationMonth?: number;
|
|
11810
|
-
expirationYear?: number;
|
|
11811
|
-
} & {
|
|
11812
|
-
[key: string]: any;
|
|
11813
|
-
};
|
|
11814
|
-
/**
|
|
11815
|
-
* @type CustomerPaymentInstrumentUpdateRequest: Document representing a customer payment instrument update request. Only allows updating the default flag and card expiration date.
|
|
11816
|
-
*
|
|
11817
|
-
* @property default: The default payment instrument.
|
|
11818
|
-
*
|
|
11819
|
-
* @property paymentCard:
|
|
11820
|
-
*
|
|
11821
|
-
*/
|
|
11822
|
-
type CustomerPaymentInstrumentUpdateRequest = {
|
|
11823
|
-
default?: boolean;
|
|
11824
|
-
paymentCard?: CustomerPaymentInstrumentUpdateRequestPaymentCard;
|
|
11825
|
-
} & {
|
|
11826
|
-
[key: string]: any;
|
|
11827
|
-
};
|
|
11828
11597
|
/**
|
|
11829
11598
|
* @type ProductListEvent: Document representing a product list event.
|
|
11830
11599
|
*
|
|
@@ -12318,8 +12087,6 @@ declare namespace ShopperCustomersTypes {
|
|
|
12318
12087
|
type updateCustomerAddressPathParameters = ShopperCustomersApiTypes.updateCustomerAddressPathParameters;
|
|
12319
12088
|
type updateCustomerPasswordQueryParameters = ShopperCustomersApiTypes.updateCustomerPasswordQueryParameters;
|
|
12320
12089
|
type updateCustomerPasswordPathParameters = ShopperCustomersApiTypes.updateCustomerPasswordPathParameters;
|
|
12321
|
-
type updateCustomerPaymentInstrumentQueryParameters = ShopperCustomersApiTypes.updateCustomerPaymentInstrumentQueryParameters;
|
|
12322
|
-
type updateCustomerPaymentInstrumentPathParameters = ShopperCustomersApiTypes.updateCustomerPaymentInstrumentPathParameters;
|
|
12323
12090
|
type updateCustomerProductListQueryParameters = ShopperCustomersApiTypes.updateCustomerProductListQueryParameters;
|
|
12324
12091
|
type updateCustomerProductListPathParameters = ShopperCustomersApiTypes.updateCustomerProductListPathParameters;
|
|
12325
12092
|
type updateCustomerProductListItemQueryParameters = ShopperCustomersApiTypes.updateCustomerProductListItemQueryParameters;
|
|
@@ -12344,8 +12111,6 @@ declare namespace ShopperCustomersTypes {
|
|
|
12344
12111
|
type CustomerPaymentCardRequest = ShopperCustomersModelTypes.CustomerPaymentCardRequest;
|
|
12345
12112
|
type CustomerPaymentInstrument = ShopperCustomersModelTypes.CustomerPaymentInstrument;
|
|
12346
12113
|
type CustomerPaymentInstrumentRequest = ShopperCustomersModelTypes.CustomerPaymentInstrumentRequest;
|
|
12347
|
-
type CustomerPaymentInstrumentUpdateRequest = ShopperCustomersModelTypes.CustomerPaymentInstrumentUpdateRequest;
|
|
12348
|
-
type CustomerPaymentInstrumentUpdateRequestPaymentCard = ShopperCustomersModelTypes.CustomerPaymentInstrumentUpdateRequestPaymentCard;
|
|
12349
12114
|
type CustomerProductList = ShopperCustomersModelTypes.CustomerProductList;
|
|
12350
12115
|
type CustomerProductListTypeEnum = ShopperCustomersModelTypes.CustomerProductListTypeEnum;
|
|
12351
12116
|
type CustomerProductListItem = ShopperCustomersModelTypes.CustomerProductListItem;
|
|
@@ -12422,4 +12187,4 @@ declare namespace ShopperCustomersTypes {
|
|
|
12422
12187
|
type VariationAttributeValue = ShopperCustomersModelTypes.VariationAttributeValue;
|
|
12423
12188
|
type VariationGroup = ShopperCustomersModelTypes.VariationGroup;
|
|
12424
12189
|
}
|
|
12425
|
-
export { defaultBaseUri, createCustomerAddressQueryParameters, createCustomerAddressPathParameters, createCustomerPaymentInstrumentQueryParameters, createCustomerPaymentInstrumentPathParameters, createCustomerProductListQueryParameters, createCustomerProductListPathParameters, createCustomerProductListItemQueryParameters, createCustomerProductListItemPathParameters, deleteCustomerPaymentInstrumentQueryParameters, deleteCustomerPaymentInstrumentPathParameters, deleteCustomerProductListQueryParameters, deleteCustomerProductListPathParameters, deleteCustomerProductListItemQueryParameters, deleteCustomerProductListItemPathParameters, getCustomerQueryParameters, getCustomerPathParameters, getCustomerAddressQueryParameters, getCustomerAddressPathParameters, getCustomerBasketsQueryParameters, getCustomerBasketsPathParameters, getCustomerOrdersQueryParameters, getCustomerOrdersPathParameters, getCustomerPaymentInstrumentQueryParameters, getCustomerPaymentInstrumentPathParameters, getCustomerProductListQueryParameters, getCustomerProductListPathParameters, getCustomerProductListItemQueryParameters, getCustomerProductListItemPathParameters, getCustomerProductListsQueryParameters, getCustomerProductListsPathParameters, getExternalProfileQueryParameters, getExternalProfilePathParameters, getProductListItemQueryParameters, getProductListItemPathParameters, getPublicProductListQueryParameters, getPublicProductListPathParameters, getPublicProductListsBySearchTermQueryParameters, getPublicProductListsBySearchTermPathParameters, getResetPasswordTokenQueryParameters, getResetPasswordTokenPathParameters, registerCustomerQueryParameters, registerCustomerPathParameters, registerExternalProfileQueryParameters, registerExternalProfilePathParameters, removeCustomerAddressQueryParameters, removeCustomerAddressPathParameters, resetPasswordQueryParameters, resetPasswordPathParameters, updateCustomerQueryParameters, updateCustomerPathParameters, updateCustomerAddressQueryParameters, updateCustomerAddressPathParameters, updateCustomerPasswordQueryParameters, updateCustomerPasswordPathParameters,
|
|
12190
|
+
export { defaultBaseUri, createCustomerAddressQueryParameters, createCustomerAddressPathParameters, createCustomerPaymentInstrumentQueryParameters, createCustomerPaymentInstrumentPathParameters, createCustomerProductListQueryParameters, createCustomerProductListPathParameters, createCustomerProductListItemQueryParameters, createCustomerProductListItemPathParameters, deleteCustomerPaymentInstrumentQueryParameters, deleteCustomerPaymentInstrumentPathParameters, deleteCustomerProductListQueryParameters, deleteCustomerProductListPathParameters, deleteCustomerProductListItemQueryParameters, deleteCustomerProductListItemPathParameters, getCustomerQueryParameters, getCustomerPathParameters, getCustomerAddressQueryParameters, getCustomerAddressPathParameters, getCustomerBasketsQueryParameters, getCustomerBasketsPathParameters, getCustomerOrdersQueryParameters, getCustomerOrdersPathParameters, getCustomerPaymentInstrumentQueryParameters, getCustomerPaymentInstrumentPathParameters, getCustomerProductListQueryParameters, getCustomerProductListPathParameters, getCustomerProductListItemQueryParameters, getCustomerProductListItemPathParameters, getCustomerProductListsQueryParameters, getCustomerProductListsPathParameters, getExternalProfileQueryParameters, getExternalProfilePathParameters, getProductListItemQueryParameters, getProductListItemPathParameters, getPublicProductListQueryParameters, getPublicProductListPathParameters, getPublicProductListsBySearchTermQueryParameters, getPublicProductListsBySearchTermPathParameters, getResetPasswordTokenQueryParameters, getResetPasswordTokenPathParameters, registerCustomerQueryParameters, registerCustomerPathParameters, registerExternalProfileQueryParameters, registerExternalProfilePathParameters, removeCustomerAddressQueryParameters, removeCustomerAddressPathParameters, resetPasswordQueryParameters, resetPasswordPathParameters, updateCustomerQueryParameters, updateCustomerPathParameters, updateCustomerAddressQueryParameters, updateCustomerAddressPathParameters, updateCustomerPasswordQueryParameters, updateCustomerPasswordPathParameters, updateCustomerProductListQueryParameters, updateCustomerProductListPathParameters, updateCustomerProductListItemQueryParameters, updateCustomerProductListItemPathParameters, ShopperCustomersPathParameters, ShopperCustomersQueryParameters, ShopperCustomersParameters, ShopperCustomers, Basket, BasketChannelTypeEnum, BasketTaxationEnum, BasketsResult, BonusDiscountLineItem, BundledProduct, CouponItem, CouponItemStatusCodeEnum, CurrencyCode, Customer, CustomerAuthTypeEnum, CustomerAddress, CustomerAddressInfo, CustomerExtProfileRequest, CustomerExternalProfile, CustomerInfo, CustomerOrderResult, CustomerPaymentCardRequest, CustomerPaymentInstrument, CustomerPaymentInstrumentRequest, CustomerProductList, CustomerProductListTypeEnum, CustomerProductListItem, CustomerProductListItemTypeEnum, CustomerProductListRegistrant, CustomerProductListResult, CustomerRegistration, Discount, DiscountTypeEnum, ErrorResponse, GiftCertificateItem, GroupedTaxItem, Image, ImageGroup, Inventory, Master, NoValue, Option, OptionItem, OptionValue, Order, OrderChannelTypeEnum, OrderConfirmationStatusEnum, OrderExportStatusEnum, OrderPaymentStatusEnum, OrderShippingStatusEnum, OrderStatusEnum, OrderTaxationEnum, OrderAddress, OrderPaymentInstrument, PageMetaTag, PaginatedResultBase, PasswordChangeRequest, PaymentBankAccountRequest, PaymentCard, PriceAdjustment, PriceRange, Product, ProductDetailsLink, ProductItem, ProductLink, ProductLinkTypeEnum, ProductListEvent, ProductListItemReference, ProductListItemReferenceTypeEnum, ProductListLink, ProductListLinkTypeEnum, ProductListRegistrant, ProductListShippingAddress, ProductPriceTable, ProductPromotion, ProductType, PublicProductList, PublicProductListTypeEnum, PublicProductListInfo, PublicProductListInfoTypeEnum, PublicProductListItem, PublicProductListItemTypeEnum, PublicProductListResult, Recommendation, RecommendationType, ResetPasswordRequest, ResetPasswordToken, ResetPasswordTokenRequest, ResultBase, Shipment, ShipmentShippingStatusEnum, ShippingItem, ShippingMethod, ShippingPromotion, Status, Variant, VariationAttribute, VariationAttributeValue, VariationGroup, ShopperCustomersTypes };
|