commerce-sdk-isomorphic 5.1.0 → 5.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -0
- package/lib/index.cjs.d.ts +963 -23
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +963 -23
- package/lib/index.esm.js +1 -1
- package/package.json +3 -3
package/lib/index.esm.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
/// <reference types="node-fetch" />
|
|
1
2
|
/*
|
|
2
3
|
* Copyright (c) 2021, salesforce.com, inc.
|
|
3
4
|
* All rights reserved.
|
|
@@ -97,6 +98,7 @@ interface ClientConfigInit<Params extends BaseUriParameters> {
|
|
|
97
98
|
[key: string]: string;
|
|
98
99
|
}) => Required<FetchOptions>["body"];
|
|
99
100
|
throwOnBadResponse?: boolean;
|
|
101
|
+
throwOnMaintenanceHeader?: boolean;
|
|
100
102
|
}
|
|
101
103
|
/**
|
|
102
104
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -112,6 +114,7 @@ declare class ClientConfig<Params extends BaseUriParameters> implements ClientCo
|
|
|
112
114
|
fetch?: FetchFunction;
|
|
113
115
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
114
116
|
throwOnBadResponse: boolean;
|
|
117
|
+
throwOnMaintenanceHeader: boolean;
|
|
115
118
|
constructor(config: ClientConfigInit<Params>);
|
|
116
119
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
117
120
|
}
|
|
@@ -2943,6 +2946,7 @@ declare namespace ShopperLoginApiTypes {
|
|
|
2943
2946
|
[key: string]: string;
|
|
2944
2947
|
}) => Required<FetchOptions>["body"];
|
|
2945
2948
|
throwOnBadResponse?: boolean;
|
|
2949
|
+
throwOnMaintenanceHeader?: boolean;
|
|
2946
2950
|
}
|
|
2947
2951
|
/**
|
|
2948
2952
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -2958,6 +2962,7 @@ declare namespace ShopperLoginApiTypes {
|
|
|
2958
2962
|
fetch?: FetchFunction;
|
|
2959
2963
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
2960
2964
|
throwOnBadResponse: boolean;
|
|
2965
|
+
throwOnMaintenanceHeader: boolean;
|
|
2961
2966
|
constructor(config: ClientConfigInit<Params>);
|
|
2962
2967
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
2963
2968
|
}
|
|
@@ -10795,6 +10800,7 @@ declare namespace ShopperBasketsApiTypes {
|
|
|
10795
10800
|
[key: string]: string;
|
|
10796
10801
|
}) => Required<FetchOptions>["body"];
|
|
10797
10802
|
throwOnBadResponse?: boolean;
|
|
10803
|
+
throwOnMaintenanceHeader?: boolean;
|
|
10798
10804
|
}
|
|
10799
10805
|
/**
|
|
10800
10806
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -10810,6 +10816,7 @@ declare namespace ShopperBasketsApiTypes {
|
|
|
10810
10816
|
fetch?: FetchFunction;
|
|
10811
10817
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
10812
10818
|
throwOnBadResponse: boolean;
|
|
10819
|
+
throwOnMaintenanceHeader: boolean;
|
|
10813
10820
|
constructor(config: ClientConfigInit<Params>);
|
|
10814
10821
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
10815
10822
|
}
|
|
@@ -21402,6 +21409,7 @@ declare namespace ShopperBasketsV2ApiTypes {
|
|
|
21402
21409
|
[key: string]: string;
|
|
21403
21410
|
}) => Required<FetchOptions>["body"];
|
|
21404
21411
|
throwOnBadResponse?: boolean;
|
|
21412
|
+
throwOnMaintenanceHeader?: boolean;
|
|
21405
21413
|
}
|
|
21406
21414
|
/**
|
|
21407
21415
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -21417,6 +21425,7 @@ declare namespace ShopperBasketsV2ApiTypes {
|
|
|
21417
21425
|
fetch?: FetchFunction;
|
|
21418
21426
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
21419
21427
|
throwOnBadResponse: boolean;
|
|
21428
|
+
throwOnMaintenanceHeader: boolean;
|
|
21420
21429
|
constructor(config: ClientConfigInit<Params>);
|
|
21421
21430
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
21422
21431
|
}
|
|
@@ -28044,6 +28053,7 @@ declare namespace ShopperConfigurationsApiTypes {
|
|
|
28044
28053
|
[key: string]: string;
|
|
28045
28054
|
}) => Required<FetchOptions>["body"];
|
|
28046
28055
|
throwOnBadResponse?: boolean;
|
|
28056
|
+
throwOnMaintenanceHeader?: boolean;
|
|
28047
28057
|
}
|
|
28048
28058
|
/**
|
|
28049
28059
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -28059,6 +28069,7 @@ declare namespace ShopperConfigurationsApiTypes {
|
|
|
28059
28069
|
fetch?: FetchFunction;
|
|
28060
28070
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
28061
28071
|
throwOnBadResponse: boolean;
|
|
28072
|
+
throwOnMaintenanceHeader: boolean;
|
|
28062
28073
|
constructor(config: ClientConfigInit<Params>);
|
|
28063
28074
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
28064
28075
|
}
|
|
@@ -29039,6 +29050,7 @@ declare namespace ShopperConsentsApiTypes {
|
|
|
29039
29050
|
[key: string]: string;
|
|
29040
29051
|
}) => Required<FetchOptions>["body"];
|
|
29041
29052
|
throwOnBadResponse?: boolean;
|
|
29053
|
+
throwOnMaintenanceHeader?: boolean;
|
|
29042
29054
|
}
|
|
29043
29055
|
/**
|
|
29044
29056
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -29054,6 +29066,7 @@ declare namespace ShopperConsentsApiTypes {
|
|
|
29054
29066
|
fetch?: FetchFunction;
|
|
29055
29067
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
29056
29068
|
throwOnBadResponse: boolean;
|
|
29069
|
+
throwOnMaintenanceHeader: boolean;
|
|
29057
29070
|
constructor(config: ClientConfigInit<Params>);
|
|
29058
29071
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
29059
29072
|
}
|
|
@@ -30549,6 +30562,7 @@ declare namespace ShopperContextsApiTypes {
|
|
|
30549
30562
|
[key: string]: string;
|
|
30550
30563
|
}) => Required<FetchOptions>["body"];
|
|
30551
30564
|
throwOnBadResponse?: boolean;
|
|
30565
|
+
throwOnMaintenanceHeader?: boolean;
|
|
30552
30566
|
}
|
|
30553
30567
|
/**
|
|
30554
30568
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -30564,6 +30578,7 @@ declare namespace ShopperContextsApiTypes {
|
|
|
30564
30578
|
fetch?: FetchFunction;
|
|
30565
30579
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
30566
30580
|
throwOnBadResponse: boolean;
|
|
30581
|
+
throwOnMaintenanceHeader: boolean;
|
|
30567
30582
|
constructor(config: ClientConfigInit<Params>);
|
|
30568
30583
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
30569
30584
|
}
|
|
@@ -32992,6 +33007,9 @@ type CustomerAddress = {
|
|
|
32992
33007
|
* @property companyName: The customer\'s company name.
|
|
32993
33008
|
* - **Max Length:** 256
|
|
32994
33009
|
*
|
|
33010
|
+
* @property crmContactId: The customer\'s core contact ID.
|
|
33011
|
+
* - **Max Length:** 18
|
|
33012
|
+
*
|
|
32995
33013
|
* @property creationDate: Returns the value of attribute \'creationDate\'.
|
|
32996
33014
|
*
|
|
32997
33015
|
* @property currentPassword: The shopper\'s current password. This is only used when attempting to update a shopper\'s `loginId` in a PATCH call. This value is never returned in any response for security reasons, but is validated and must match shopper\'s existing password in order to update `loginId`. Otherwise, an HTTP 400 statusCode is returned and the `loginId` is not updated. This field and functionality is available with B2C Commerce version 24.7.
|
|
@@ -33071,6 +33089,7 @@ type Customer = {
|
|
|
33071
33089
|
authType?: CustomerAuthTypeEnum;
|
|
33072
33090
|
birthday?: string;
|
|
33073
33091
|
companyName?: string;
|
|
33092
|
+
crmContactId?: string;
|
|
33074
33093
|
creationDate?: string;
|
|
33075
33094
|
currentPassword?: string;
|
|
33076
33095
|
customerId?: string;
|
|
@@ -33836,6 +33855,54 @@ type PasswordChangeRequest = {
|
|
|
33836
33855
|
} & {
|
|
33837
33856
|
[key: string]: any;
|
|
33838
33857
|
};
|
|
33858
|
+
/**
|
|
33859
|
+
* @type PaymentMethodReferenceSetupRequestGatewayProperties: Properties specific to the payment gateway
|
|
33860
|
+
*
|
|
33861
|
+
* @property stripe: # Stripe-specific properties.
|
|
33862
|
+
*
|
|
33863
|
+
* @property adyen: # Adyen-specific properties.
|
|
33864
|
+
*
|
|
33865
|
+
*/
|
|
33866
|
+
type PaymentMethodReferenceSetupRequestGatewayProperties = {
|
|
33867
|
+
stripe?: {
|
|
33868
|
+
[key: string]: any;
|
|
33869
|
+
};
|
|
33870
|
+
adyen?: {
|
|
33871
|
+
[key: string]: any;
|
|
33872
|
+
};
|
|
33873
|
+
} & {
|
|
33874
|
+
[key: string]: any;
|
|
33875
|
+
};
|
|
33876
|
+
/**
|
|
33877
|
+
* @type PaymentMethodReferenceSetupRequest: Request to set up a new payment method reference.
|
|
33878
|
+
*
|
|
33879
|
+
* @property paymentMethodType: Payment Method Type
|
|
33880
|
+
* - **Max Length:** 256
|
|
33881
|
+
*
|
|
33882
|
+
* @property gatewayProperties:
|
|
33883
|
+
*
|
|
33884
|
+
*/
|
|
33885
|
+
type PaymentMethodReferenceSetupRequest = {
|
|
33886
|
+
paymentMethodType?: string;
|
|
33887
|
+
gatewayProperties: PaymentMethodReferenceSetupRequestGatewayProperties;
|
|
33888
|
+
} & {
|
|
33889
|
+
[key: string]: any;
|
|
33890
|
+
};
|
|
33891
|
+
/**
|
|
33892
|
+
* @type PaymentMethodReferenceSetupResponse: Response from setting up a new payment method reference.
|
|
33893
|
+
*
|
|
33894
|
+
* @property paymentMethodReferenceSetupId: The provider-specific identifier for the payment method reference setup (e.g., Stripe Setup Intent ID, Adyen pspReference).
|
|
33895
|
+
* - **Max Length:** 256
|
|
33896
|
+
*
|
|
33897
|
+
* @property gatewayProperties:
|
|
33898
|
+
*
|
|
33899
|
+
*/
|
|
33900
|
+
type PaymentMethodReferenceSetupResponse = {
|
|
33901
|
+
paymentMethodReferenceSetupId: string;
|
|
33902
|
+
gatewayProperties?: PaymentMethodReferenceSetupRequestGatewayProperties;
|
|
33903
|
+
} & {
|
|
33904
|
+
[key: string]: any;
|
|
33905
|
+
};
|
|
33839
33906
|
/**
|
|
33840
33907
|
* @type ProductListRegistrant: A `ProductListRegistrant` is typically associated with an event-related product list, such as a gift registry. It holds information about a person associated with the event, such as a bride or groom.
|
|
33841
33908
|
*
|
|
@@ -34240,6 +34307,14 @@ type resetPasswordQueryParameters$0 = {
|
|
|
34240
34307
|
type resetPasswordPathParameters$0 = {
|
|
34241
34308
|
organizationId: string;
|
|
34242
34309
|
};
|
|
34310
|
+
type setupCustomerPaymentMethodReferenceQueryParameters = {
|
|
34311
|
+
siteId: string;
|
|
34312
|
+
zoneId: string;
|
|
34313
|
+
};
|
|
34314
|
+
type setupCustomerPaymentMethodReferencePathParameters = {
|
|
34315
|
+
customerId: string;
|
|
34316
|
+
organizationId: string;
|
|
34317
|
+
};
|
|
34243
34318
|
type updateCustomerQueryParameters = {
|
|
34244
34319
|
siteId: string;
|
|
34245
34320
|
};
|
|
@@ -34290,11 +34365,11 @@ type updateCustomerProductListItemPathParameters = {
|
|
|
34290
34365
|
/**
|
|
34291
34366
|
* All path parameters that are used by at least one ShopperCustomers method.
|
|
34292
34367
|
*/
|
|
34293
|
-
type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerPaymentMethodReferencePathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListItemsPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters$0 & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerPaymentInstrumentPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
|
|
34368
|
+
type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerPaymentMethodReferencePathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListItemsPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters$0 & setupCustomerPaymentMethodReferencePathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerPaymentInstrumentPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
|
|
34294
34369
|
/**
|
|
34295
34370
|
* All query parameters that are used by at least one ShopperCustomers method.
|
|
34296
34371
|
*/
|
|
34297
|
-
type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerPaymentMethodReferenceQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListItemsQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters$0 & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerPaymentInstrumentQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
|
|
34372
|
+
type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerPaymentMethodReferenceQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListItemsQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters$0 & setupCustomerPaymentMethodReferenceQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerPaymentInstrumentQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
|
|
34298
34373
|
/**
|
|
34299
34374
|
* All parameters that are used by ShopperCustomers.
|
|
34300
34375
|
*/
|
|
@@ -34415,6 +34490,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
34415
34490
|
registerExternalProfile: string;
|
|
34416
34491
|
removeCustomerAddress: string;
|
|
34417
34492
|
resetPassword: string;
|
|
34493
|
+
setupCustomerPaymentMethodReference: string;
|
|
34418
34494
|
updateCustomer: string;
|
|
34419
34495
|
updateCustomerAddress: string;
|
|
34420
34496
|
updateCustomerPassword: string;
|
|
@@ -34716,6 +34792,18 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
34716
34792
|
"organizationId",
|
|
34717
34793
|
"siteId"
|
|
34718
34794
|
];
|
|
34795
|
+
readonly setupCustomerPaymentMethodReference: readonly [
|
|
34796
|
+
"customerId",
|
|
34797
|
+
"organizationId",
|
|
34798
|
+
"siteId",
|
|
34799
|
+
"zoneId"
|
|
34800
|
+
];
|
|
34801
|
+
readonly setupCustomerPaymentMethodReferenceRequired: readonly [
|
|
34802
|
+
"customerId",
|
|
34803
|
+
"organizationId",
|
|
34804
|
+
"siteId",
|
|
34805
|
+
"zoneId"
|
|
34806
|
+
];
|
|
34719
34807
|
readonly updateCustomer: readonly [
|
|
34720
34808
|
"customerId",
|
|
34721
34809
|
"organizationId",
|
|
@@ -35069,7 +35157,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
35069
35157
|
};
|
|
35070
35158
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
35071
35159
|
/**
|
|
35072
|
-
* Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
|
|
35160
|
+
* Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID. This endpoint requires Salesforce Payments integration.
|
|
35073
35161
|
*
|
|
35074
35162
|
* If you would like to get a raw Response object use the other deleteCustomerPaymentMethodReference function.
|
|
35075
35163
|
*
|
|
@@ -35097,7 +35185,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
35097
35185
|
};
|
|
35098
35186
|
}>): Promise<void>;
|
|
35099
35187
|
/**
|
|
35100
|
-
* Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
|
|
35188
|
+
* Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID. This endpoint requires Salesforce Payments integration.
|
|
35101
35189
|
*
|
|
35102
35190
|
* @param options - An object containing the options for this method.
|
|
35103
35191
|
* @param options.parameters - An object containing the parameters for this method.
|
|
@@ -35403,7 +35491,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
35403
35491
|
* @param options.parameters.expand - This parameter enhances the order result with extra data. By using `expand=som`, all orders for the current customer are loaded
|
|
35404
35492
|
directly from Salesforce Order Management (SOM). The system returns the retrieved SOM order data, along with any orders not yet
|
|
35405
35493
|
transferred to SOM. If your instance is not integrated with SOM, the `expand=som` command is disregarded.
|
|
35406
|
-
* @param options.parameters.limit -
|
|
35494
|
+
* @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 10.
|
|
35407
35495
|
* @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
|
|
35408
35496
|
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
35409
35497
|
*
|
|
@@ -35441,7 +35529,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
35441
35529
|
* @param options.parameters.expand - This parameter enhances the order result with extra data. By using `expand=som`, all orders for the current customer are loaded
|
|
35442
35530
|
directly from Salesforce Order Management (SOM). The system returns the retrieved SOM order data, along with any orders not yet
|
|
35443
35531
|
transferred to SOM. If your instance is not integrated with SOM, the `expand=som` command is disregarded.
|
|
35444
|
-
* @param options.parameters.limit -
|
|
35532
|
+
* @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 10.
|
|
35445
35533
|
* @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
|
|
35446
35534
|
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
35447
35535
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -36163,6 +36251,61 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
|
|
|
36163
36251
|
};
|
|
36164
36252
|
body: ResetPasswordRequest & CustomRequestBody;
|
|
36165
36253
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
36254
|
+
/**
|
|
36255
|
+
* Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
|
|
36256
|
+
*
|
|
36257
|
+
* If you would like to get a raw Response object use the other setupCustomerPaymentMethodReference function.
|
|
36258
|
+
*
|
|
36259
|
+
* @param options - An object containing the options for this method.
|
|
36260
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
36261
|
+
* @param options.parameters.customerId - The customer ID.
|
|
36262
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
36263
|
+
* @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.
|
|
36264
|
+
* @param options.parameters.zoneId - The zone identifier for the payment configuration.
|
|
36265
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
36266
|
+
* @param options.body - The data to send as the request body.
|
|
36267
|
+
*
|
|
36268
|
+
* @returns A promise of type PaymentMethodReferenceSetupResponse.
|
|
36269
|
+
*/
|
|
36270
|
+
setupCustomerPaymentMethodReference(options: RequireParametersUnlessAllAreOptional<{
|
|
36271
|
+
parameters?: CompositeParameters<{
|
|
36272
|
+
customerId: string;
|
|
36273
|
+
organizationId: string;
|
|
36274
|
+
siteId: string;
|
|
36275
|
+
zoneId: string;
|
|
36276
|
+
} & QueryParameters, ConfigParameters>;
|
|
36277
|
+
headers?: {
|
|
36278
|
+
[key: string]: string;
|
|
36279
|
+
};
|
|
36280
|
+
body: PaymentMethodReferenceSetupRequest & CustomRequestBody;
|
|
36281
|
+
}>): Promise<PaymentMethodReferenceSetupResponse>;
|
|
36282
|
+
/**
|
|
36283
|
+
* Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
|
|
36284
|
+
*
|
|
36285
|
+
* @param options - An object containing the options for this method.
|
|
36286
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
36287
|
+
* @param options.parameters.customerId - The customer ID.
|
|
36288
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
36289
|
+
* @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.
|
|
36290
|
+
* @param options.parameters.zoneId - The zone identifier for the payment configuration.
|
|
36291
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
36292
|
+
* @param options.body - The data to send as the request body.
|
|
36293
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
36294
|
+
*
|
|
36295
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type PaymentMethodReferenceSetupResponse otherwise.
|
|
36296
|
+
*/
|
|
36297
|
+
setupCustomerPaymentMethodReference<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
36298
|
+
parameters?: CompositeParameters<{
|
|
36299
|
+
customerId: string;
|
|
36300
|
+
organizationId: string;
|
|
36301
|
+
siteId: string;
|
|
36302
|
+
zoneId: string;
|
|
36303
|
+
} & QueryParameters, ConfigParameters>;
|
|
36304
|
+
headers?: {
|
|
36305
|
+
[key: string]: string;
|
|
36306
|
+
};
|
|
36307
|
+
body: PaymentMethodReferenceSetupRequest & CustomRequestBody;
|
|
36308
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : PaymentMethodReferenceSetupResponse>;
|
|
36166
36309
|
/**
|
|
36167
36310
|
*
|
|
36168
36311
|
*
|
|
@@ -36604,6 +36747,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
36604
36747
|
[key: string]: string;
|
|
36605
36748
|
}) => Required<FetchOptions>["body"];
|
|
36606
36749
|
throwOnBadResponse?: boolean;
|
|
36750
|
+
throwOnMaintenanceHeader?: boolean;
|
|
36607
36751
|
}
|
|
36608
36752
|
/**
|
|
36609
36753
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -36619,6 +36763,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
36619
36763
|
fetch?: FetchFunction;
|
|
36620
36764
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
36621
36765
|
throwOnBadResponse: boolean;
|
|
36766
|
+
throwOnMaintenanceHeader: boolean;
|
|
36622
36767
|
constructor(config: ClientConfigInit<Params>);
|
|
36623
36768
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
36624
36769
|
}
|
|
@@ -38386,6 +38531,9 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
38386
38531
|
* @property companyName: The customer\'s company name.
|
|
38387
38532
|
* - **Max Length:** 256
|
|
38388
38533
|
*
|
|
38534
|
+
* @property crmContactId: The customer\'s core contact ID.
|
|
38535
|
+
* - **Max Length:** 18
|
|
38536
|
+
*
|
|
38389
38537
|
* @property creationDate: Returns the value of attribute \'creationDate\'.
|
|
38390
38538
|
*
|
|
38391
38539
|
* @property currentPassword: The shopper\'s current password. This is only used when attempting to update a shopper\'s `loginId` in a PATCH call. This value is never returned in any response for security reasons, but is validated and must match shopper\'s existing password in order to update `loginId`. Otherwise, an HTTP 400 statusCode is returned and the `loginId` is not updated. This field and functionality is available with B2C Commerce version 24.7.
|
|
@@ -38465,6 +38613,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
38465
38613
|
authType?: CustomerAuthTypeEnum;
|
|
38466
38614
|
birthday?: string;
|
|
38467
38615
|
companyName?: string;
|
|
38616
|
+
crmContactId?: string;
|
|
38468
38617
|
creationDate?: string;
|
|
38469
38618
|
currentPassword?: string;
|
|
38470
38619
|
customerId?: string;
|
|
@@ -39270,6 +39419,54 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
39270
39419
|
} & {
|
|
39271
39420
|
[key: string]: any;
|
|
39272
39421
|
};
|
|
39422
|
+
/**
|
|
39423
|
+
* @type PaymentMethodReferenceSetupRequestGatewayProperties: Properties specific to the payment gateway
|
|
39424
|
+
*
|
|
39425
|
+
* @property stripe: # Stripe-specific properties.
|
|
39426
|
+
*
|
|
39427
|
+
* @property adyen: # Adyen-specific properties.
|
|
39428
|
+
*
|
|
39429
|
+
*/
|
|
39430
|
+
type PaymentMethodReferenceSetupRequestGatewayProperties = {
|
|
39431
|
+
stripe?: {
|
|
39432
|
+
[key: string]: any;
|
|
39433
|
+
};
|
|
39434
|
+
adyen?: {
|
|
39435
|
+
[key: string]: any;
|
|
39436
|
+
};
|
|
39437
|
+
} & {
|
|
39438
|
+
[key: string]: any;
|
|
39439
|
+
};
|
|
39440
|
+
/**
|
|
39441
|
+
* @type PaymentMethodReferenceSetupRequest: Request to set up a new payment method reference.
|
|
39442
|
+
*
|
|
39443
|
+
* @property paymentMethodType: Payment Method Type
|
|
39444
|
+
* - **Max Length:** 256
|
|
39445
|
+
*
|
|
39446
|
+
* @property gatewayProperties:
|
|
39447
|
+
*
|
|
39448
|
+
*/
|
|
39449
|
+
type PaymentMethodReferenceSetupRequest = {
|
|
39450
|
+
paymentMethodType?: string;
|
|
39451
|
+
gatewayProperties: PaymentMethodReferenceSetupRequestGatewayProperties;
|
|
39452
|
+
} & {
|
|
39453
|
+
[key: string]: any;
|
|
39454
|
+
};
|
|
39455
|
+
/**
|
|
39456
|
+
* @type PaymentMethodReferenceSetupResponse: Response from setting up a new payment method reference.
|
|
39457
|
+
*
|
|
39458
|
+
* @property paymentMethodReferenceSetupId: The provider-specific identifier for the payment method reference setup (e.g., Stripe Setup Intent ID, Adyen pspReference).
|
|
39459
|
+
* - **Max Length:** 256
|
|
39460
|
+
*
|
|
39461
|
+
* @property gatewayProperties:
|
|
39462
|
+
*
|
|
39463
|
+
*/
|
|
39464
|
+
type PaymentMethodReferenceSetupResponse = {
|
|
39465
|
+
paymentMethodReferenceSetupId: string;
|
|
39466
|
+
gatewayProperties?: PaymentMethodReferenceSetupRequestGatewayProperties;
|
|
39467
|
+
} & {
|
|
39468
|
+
[key: string]: any;
|
|
39469
|
+
};
|
|
39273
39470
|
/**
|
|
39274
39471
|
* @type ProductListRegistrant: A `ProductListRegistrant` is typically associated with an event-related product list, such as a gift registry. It holds information about a person associated with the event, such as a bride or groom.
|
|
39275
39472
|
*
|
|
@@ -39688,6 +39885,14 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
39688
39885
|
type resetPasswordPathParameters = {
|
|
39689
39886
|
organizationId: string;
|
|
39690
39887
|
};
|
|
39888
|
+
type setupCustomerPaymentMethodReferenceQueryParameters = {
|
|
39889
|
+
siteId: string;
|
|
39890
|
+
zoneId: string;
|
|
39891
|
+
};
|
|
39892
|
+
type setupCustomerPaymentMethodReferencePathParameters = {
|
|
39893
|
+
customerId: string;
|
|
39894
|
+
organizationId: string;
|
|
39895
|
+
};
|
|
39691
39896
|
type updateCustomerQueryParameters = {
|
|
39692
39897
|
siteId: string;
|
|
39693
39898
|
};
|
|
@@ -39738,11 +39943,11 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
39738
39943
|
/**
|
|
39739
39944
|
* All path parameters that are used by at least one ShopperCustomers method.
|
|
39740
39945
|
*/
|
|
39741
|
-
type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerPaymentMethodReferencePathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListItemsPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerPaymentInstrumentPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
|
|
39946
|
+
type ShopperCustomersPathParameters = Partial<createCustomerAddressPathParameters & createCustomerPaymentInstrumentPathParameters & createCustomerProductListPathParameters & createCustomerProductListItemPathParameters & deleteCustomerPaymentInstrumentPathParameters & deleteCustomerPaymentMethodReferencePathParameters & deleteCustomerProductListPathParameters & deleteCustomerProductListItemPathParameters & getCustomerPathParameters & getCustomerAddressPathParameters & getCustomerBasketsPathParameters & getCustomerOrdersPathParameters & getCustomerPaymentInstrumentPathParameters & getCustomerProductListPathParameters & getCustomerProductListItemPathParameters & getCustomerProductListsPathParameters & getExternalProfilePathParameters & getProductListItemPathParameters & getPublicProductListPathParameters & getPublicProductListItemsPathParameters & getPublicProductListsBySearchTermPathParameters & getResetPasswordTokenPathParameters & registerCustomerPathParameters & registerExternalProfilePathParameters & removeCustomerAddressPathParameters & resetPasswordPathParameters & setupCustomerPaymentMethodReferencePathParameters & updateCustomerPathParameters & updateCustomerAddressPathParameters & updateCustomerPasswordPathParameters & updateCustomerPaymentInstrumentPathParameters & updateCustomerProductListPathParameters & updateCustomerProductListItemPathParameters & {}>;
|
|
39742
39947
|
/**
|
|
39743
39948
|
* All query parameters that are used by at least one ShopperCustomers method.
|
|
39744
39949
|
*/
|
|
39745
|
-
type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerPaymentMethodReferenceQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListItemsQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerPaymentInstrumentQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
|
|
39950
|
+
type ShopperCustomersQueryParameters = Partial<createCustomerAddressQueryParameters & createCustomerPaymentInstrumentQueryParameters & createCustomerProductListQueryParameters & createCustomerProductListItemQueryParameters & deleteCustomerPaymentInstrumentQueryParameters & deleteCustomerPaymentMethodReferenceQueryParameters & deleteCustomerProductListQueryParameters & deleteCustomerProductListItemQueryParameters & getCustomerQueryParameters & getCustomerAddressQueryParameters & getCustomerBasketsQueryParameters & getCustomerOrdersQueryParameters & getCustomerPaymentInstrumentQueryParameters & getCustomerProductListQueryParameters & getCustomerProductListItemQueryParameters & getCustomerProductListsQueryParameters & getExternalProfileQueryParameters & getProductListItemQueryParameters & getPublicProductListQueryParameters & getPublicProductListItemsQueryParameters & getPublicProductListsBySearchTermQueryParameters & getResetPasswordTokenQueryParameters & registerCustomerQueryParameters & registerExternalProfileQueryParameters & removeCustomerAddressQueryParameters & resetPasswordQueryParameters & setupCustomerPaymentMethodReferenceQueryParameters & updateCustomerQueryParameters & updateCustomerAddressQueryParameters & updateCustomerPasswordQueryParameters & updateCustomerPaymentInstrumentQueryParameters & updateCustomerProductListQueryParameters & updateCustomerProductListItemQueryParameters & {}>;
|
|
39746
39951
|
/**
|
|
39747
39952
|
* All parameters that are used by ShopperCustomers.
|
|
39748
39953
|
*/
|
|
@@ -39863,6 +40068,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
39863
40068
|
registerExternalProfile: string;
|
|
39864
40069
|
removeCustomerAddress: string;
|
|
39865
40070
|
resetPassword: string;
|
|
40071
|
+
setupCustomerPaymentMethodReference: string;
|
|
39866
40072
|
updateCustomer: string;
|
|
39867
40073
|
updateCustomerAddress: string;
|
|
39868
40074
|
updateCustomerPassword: string;
|
|
@@ -40164,6 +40370,18 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
40164
40370
|
"organizationId",
|
|
40165
40371
|
"siteId"
|
|
40166
40372
|
];
|
|
40373
|
+
readonly setupCustomerPaymentMethodReference: readonly [
|
|
40374
|
+
"customerId",
|
|
40375
|
+
"organizationId",
|
|
40376
|
+
"siteId",
|
|
40377
|
+
"zoneId"
|
|
40378
|
+
];
|
|
40379
|
+
readonly setupCustomerPaymentMethodReferenceRequired: readonly [
|
|
40380
|
+
"customerId",
|
|
40381
|
+
"organizationId",
|
|
40382
|
+
"siteId",
|
|
40383
|
+
"zoneId"
|
|
40384
|
+
];
|
|
40167
40385
|
readonly updateCustomer: readonly [
|
|
40168
40386
|
"customerId",
|
|
40169
40387
|
"organizationId",
|
|
@@ -40517,7 +40735,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
40517
40735
|
};
|
|
40518
40736
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
40519
40737
|
/**
|
|
40520
|
-
* Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
|
|
40738
|
+
* Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID. This endpoint requires Salesforce Payments integration.
|
|
40521
40739
|
*
|
|
40522
40740
|
* If you would like to get a raw Response object use the other deleteCustomerPaymentMethodReference function.
|
|
40523
40741
|
*
|
|
@@ -40545,7 +40763,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
40545
40763
|
};
|
|
40546
40764
|
}>): Promise<void>;
|
|
40547
40765
|
/**
|
|
40548
|
-
* Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
|
|
40766
|
+
* Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID. This endpoint requires Salesforce Payments integration.
|
|
40549
40767
|
*
|
|
40550
40768
|
* @param options - An object containing the options for this method.
|
|
40551
40769
|
* @param options.parameters - An object containing the parameters for this method.
|
|
@@ -40851,7 +41069,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
40851
41069
|
* @param options.parameters.expand - This parameter enhances the order result with extra data. By using `expand=som`, all orders for the current customer are loaded
|
|
40852
41070
|
directly from Salesforce Order Management (SOM). The system returns the retrieved SOM order data, along with any orders not yet
|
|
40853
41071
|
transferred to SOM. If your instance is not integrated with SOM, the `expand=som` command is disregarded.
|
|
40854
|
-
* @param options.parameters.limit -
|
|
41072
|
+
* @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 10.
|
|
40855
41073
|
* @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
|
|
40856
41074
|
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
40857
41075
|
*
|
|
@@ -40889,7 +41107,7 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
40889
41107
|
* @param options.parameters.expand - This parameter enhances the order result with extra data. By using `expand=som`, all orders for the current customer are loaded
|
|
40890
41108
|
directly from Salesforce Order Management (SOM). The system returns the retrieved SOM order data, along with any orders not yet
|
|
40891
41109
|
transferred to SOM. If your instance is not integrated with SOM, the `expand=som` command is disregarded.
|
|
40892
|
-
* @param options.parameters.limit -
|
|
41110
|
+
* @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 10.
|
|
40893
41111
|
* @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
|
|
40894
41112
|
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
40895
41113
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -41611,6 +41829,61 @@ declare namespace ShopperCustomersApiTypes {
|
|
|
41611
41829
|
};
|
|
41612
41830
|
body: ResetPasswordRequest & CustomRequestBody;
|
|
41613
41831
|
}>, rawResponse?: T): Promise<T extends true ? Response : void>;
|
|
41832
|
+
/**
|
|
41833
|
+
* Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
|
|
41834
|
+
*
|
|
41835
|
+
* If you would like to get a raw Response object use the other setupCustomerPaymentMethodReference function.
|
|
41836
|
+
*
|
|
41837
|
+
* @param options - An object containing the options for this method.
|
|
41838
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
41839
|
+
* @param options.parameters.customerId - The customer ID.
|
|
41840
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
41841
|
+
* @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.
|
|
41842
|
+
* @param options.parameters.zoneId - The zone identifier for the payment configuration.
|
|
41843
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
41844
|
+
* @param options.body - The data to send as the request body.
|
|
41845
|
+
*
|
|
41846
|
+
* @returns A promise of type PaymentMethodReferenceSetupResponse.
|
|
41847
|
+
*/
|
|
41848
|
+
setupCustomerPaymentMethodReference(options: RequireParametersUnlessAllAreOptional<{
|
|
41849
|
+
parameters?: CompositeParameters<{
|
|
41850
|
+
customerId: string;
|
|
41851
|
+
organizationId: string;
|
|
41852
|
+
siteId: string;
|
|
41853
|
+
zoneId: string;
|
|
41854
|
+
} & QueryParameters, ConfigParameters>;
|
|
41855
|
+
headers?: {
|
|
41856
|
+
[key: string]: string;
|
|
41857
|
+
};
|
|
41858
|
+
body: PaymentMethodReferenceSetupRequest & CustomRequestBody;
|
|
41859
|
+
}>): Promise<PaymentMethodReferenceSetupResponse>;
|
|
41860
|
+
/**
|
|
41861
|
+
* Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
|
|
41862
|
+
*
|
|
41863
|
+
* @param options - An object containing the options for this method.
|
|
41864
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
41865
|
+
* @param options.parameters.customerId - The customer ID.
|
|
41866
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
41867
|
+
* @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.
|
|
41868
|
+
* @param options.parameters.zoneId - The zone identifier for the payment configuration.
|
|
41869
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
41870
|
+
* @param options.body - The data to send as the request body.
|
|
41871
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
41872
|
+
*
|
|
41873
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type PaymentMethodReferenceSetupResponse otherwise.
|
|
41874
|
+
*/
|
|
41875
|
+
setupCustomerPaymentMethodReference<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
41876
|
+
parameters?: CompositeParameters<{
|
|
41877
|
+
customerId: string;
|
|
41878
|
+
organizationId: string;
|
|
41879
|
+
siteId: string;
|
|
41880
|
+
zoneId: string;
|
|
41881
|
+
} & QueryParameters, ConfigParameters>;
|
|
41882
|
+
headers?: {
|
|
41883
|
+
[key: string]: string;
|
|
41884
|
+
};
|
|
41885
|
+
body: PaymentMethodReferenceSetupRequest & CustomRequestBody;
|
|
41886
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : PaymentMethodReferenceSetupResponse>;
|
|
41614
41887
|
/**
|
|
41615
41888
|
*
|
|
41616
41889
|
*
|
|
@@ -43722,6 +43995,9 @@ declare namespace ShopperCustomersModelTypes {
|
|
|
43722
43995
|
* @property companyName: The customer\'s company name.
|
|
43723
43996
|
* - **Max Length:** 256
|
|
43724
43997
|
*
|
|
43998
|
+
* @property crmContactId: The customer\'s core contact ID.
|
|
43999
|
+
* - **Max Length:** 18
|
|
44000
|
+
*
|
|
43725
44001
|
* @property creationDate: Returns the value of attribute \'creationDate\'.
|
|
43726
44002
|
*
|
|
43727
44003
|
* @property currentPassword: The shopper\'s current password. This is only used when attempting to update a shopper\'s `loginId` in a PATCH call. This value is never returned in any response for security reasons, but is validated and must match shopper\'s existing password in order to update `loginId`. Otherwise, an HTTP 400 statusCode is returned and the `loginId` is not updated. This field and functionality is available with B2C Commerce version 24.7.
|
|
@@ -43801,6 +44077,7 @@ declare namespace ShopperCustomersModelTypes {
|
|
|
43801
44077
|
authType?: CustomerAuthTypeEnum;
|
|
43802
44078
|
birthday?: string;
|
|
43803
44079
|
companyName?: string;
|
|
44080
|
+
crmContactId?: string;
|
|
43804
44081
|
creationDate?: string;
|
|
43805
44082
|
currentPassword?: string;
|
|
43806
44083
|
customerId?: string;
|
|
@@ -44606,6 +44883,54 @@ declare namespace ShopperCustomersModelTypes {
|
|
|
44606
44883
|
} & {
|
|
44607
44884
|
[key: string]: any;
|
|
44608
44885
|
};
|
|
44886
|
+
/**
|
|
44887
|
+
* @type PaymentMethodReferenceSetupRequestGatewayProperties: Properties specific to the payment gateway
|
|
44888
|
+
*
|
|
44889
|
+
* @property stripe: # Stripe-specific properties.
|
|
44890
|
+
*
|
|
44891
|
+
* @property adyen: # Adyen-specific properties.
|
|
44892
|
+
*
|
|
44893
|
+
*/
|
|
44894
|
+
type PaymentMethodReferenceSetupRequestGatewayProperties = {
|
|
44895
|
+
stripe?: {
|
|
44896
|
+
[key: string]: any;
|
|
44897
|
+
};
|
|
44898
|
+
adyen?: {
|
|
44899
|
+
[key: string]: any;
|
|
44900
|
+
};
|
|
44901
|
+
} & {
|
|
44902
|
+
[key: string]: any;
|
|
44903
|
+
};
|
|
44904
|
+
/**
|
|
44905
|
+
* @type PaymentMethodReferenceSetupRequest: Request to set up a new payment method reference.
|
|
44906
|
+
*
|
|
44907
|
+
* @property paymentMethodType: Payment Method Type
|
|
44908
|
+
* - **Max Length:** 256
|
|
44909
|
+
*
|
|
44910
|
+
* @property gatewayProperties:
|
|
44911
|
+
*
|
|
44912
|
+
*/
|
|
44913
|
+
type PaymentMethodReferenceSetupRequest = {
|
|
44914
|
+
paymentMethodType?: string;
|
|
44915
|
+
gatewayProperties: PaymentMethodReferenceSetupRequestGatewayProperties;
|
|
44916
|
+
} & {
|
|
44917
|
+
[key: string]: any;
|
|
44918
|
+
};
|
|
44919
|
+
/**
|
|
44920
|
+
* @type PaymentMethodReferenceSetupResponse: Response from setting up a new payment method reference.
|
|
44921
|
+
*
|
|
44922
|
+
* @property paymentMethodReferenceSetupId: The provider-specific identifier for the payment method reference setup (e.g., Stripe Setup Intent ID, Adyen pspReference).
|
|
44923
|
+
* - **Max Length:** 256
|
|
44924
|
+
*
|
|
44925
|
+
* @property gatewayProperties:
|
|
44926
|
+
*
|
|
44927
|
+
*/
|
|
44928
|
+
type PaymentMethodReferenceSetupResponse = {
|
|
44929
|
+
paymentMethodReferenceSetupId: string;
|
|
44930
|
+
gatewayProperties?: PaymentMethodReferenceSetupRequestGatewayProperties;
|
|
44931
|
+
} & {
|
|
44932
|
+
[key: string]: any;
|
|
44933
|
+
};
|
|
44609
44934
|
/**
|
|
44610
44935
|
* @type ProductListRegistrant: A `ProductListRegistrant` is typically associated with an event-related product list, such as a gift registry. It holds information about a person associated with the event, such as a bride or groom.
|
|
44611
44936
|
*
|
|
@@ -44877,6 +45202,8 @@ declare namespace ShopperCustomersTypes {
|
|
|
44877
45202
|
type removeCustomerAddressPathParameters = ShopperCustomersApiTypes.removeCustomerAddressPathParameters;
|
|
44878
45203
|
type resetPasswordQueryParameters = ShopperCustomersApiTypes.resetPasswordQueryParameters;
|
|
44879
45204
|
type resetPasswordPathParameters = ShopperCustomersApiTypes.resetPasswordPathParameters;
|
|
45205
|
+
type setupCustomerPaymentMethodReferenceQueryParameters = ShopperCustomersApiTypes.setupCustomerPaymentMethodReferenceQueryParameters;
|
|
45206
|
+
type setupCustomerPaymentMethodReferencePathParameters = ShopperCustomersApiTypes.setupCustomerPaymentMethodReferencePathParameters;
|
|
44880
45207
|
type updateCustomerQueryParameters = ShopperCustomersApiTypes.updateCustomerQueryParameters;
|
|
44881
45208
|
type updateCustomerPathParameters = ShopperCustomersApiTypes.updateCustomerPathParameters;
|
|
44882
45209
|
type updateCustomerAddressQueryParameters = ShopperCustomersApiTypes.updateCustomerAddressQueryParameters;
|
|
@@ -44958,6 +45285,9 @@ declare namespace ShopperCustomersTypes {
|
|
|
44958
45285
|
type PasswordChangeRequest = ShopperCustomersModelTypes.PasswordChangeRequest;
|
|
44959
45286
|
type PaymentBankAccountRequest = ShopperCustomersModelTypes.PaymentBankAccountRequest;
|
|
44960
45287
|
type PaymentCard = ShopperCustomersModelTypes.PaymentCard;
|
|
45288
|
+
type PaymentMethodReferenceSetupRequest = ShopperCustomersModelTypes.PaymentMethodReferenceSetupRequest;
|
|
45289
|
+
type PaymentMethodReferenceSetupRequestGatewayProperties = ShopperCustomersModelTypes.PaymentMethodReferenceSetupRequestGatewayProperties;
|
|
45290
|
+
type PaymentMethodReferenceSetupResponse = ShopperCustomersModelTypes.PaymentMethodReferenceSetupResponse;
|
|
44961
45291
|
type PriceAdjustment = ShopperCustomersModelTypes.PriceAdjustment;
|
|
44962
45292
|
type PriceRange = ShopperCustomersModelTypes.PriceRange;
|
|
44963
45293
|
type Product = ShopperCustomersModelTypes.Product;
|
|
@@ -45000,6 +45330,24 @@ declare namespace ShopperCustomersTypes {
|
|
|
45000
45330
|
type VariationAttributeValue = ShopperCustomersModelTypes.VariationAttributeValue;
|
|
45001
45331
|
type VariationGroup = ShopperCustomersModelTypes.VariationGroup;
|
|
45002
45332
|
}
|
|
45333
|
+
/**
|
|
45334
|
+
* @type CampaignQualifier: A campaign and promotion pair to resolve qualification for.
|
|
45335
|
+
*
|
|
45336
|
+
* @property campaignId: The identifier of the campaign.
|
|
45337
|
+
* - **Min Length:** 1
|
|
45338
|
+
* - **Max Length:** 256
|
|
45339
|
+
*
|
|
45340
|
+
* @property promotionId: The identifier of the promotion within the campaign.
|
|
45341
|
+
* - **Min Length:** 1
|
|
45342
|
+
* - **Max Length:** 256
|
|
45343
|
+
*
|
|
45344
|
+
*/
|
|
45345
|
+
type CampaignQualifier = {
|
|
45346
|
+
campaignId: string;
|
|
45347
|
+
promotionId: string;
|
|
45348
|
+
} & {
|
|
45349
|
+
[key: string]: any;
|
|
45350
|
+
};
|
|
45003
45351
|
/**
|
|
45004
45352
|
* @type Region:
|
|
45005
45353
|
*
|
|
@@ -45024,18 +45372,38 @@ type Region = {
|
|
|
45024
45372
|
* @property typeId: Component type identifier.
|
|
45025
45373
|
* - **Max Length:** 256
|
|
45026
45374
|
*
|
|
45375
|
+
* @property name: Display name of the component.
|
|
45376
|
+
* - **Max Length:** 256
|
|
45377
|
+
*
|
|
45378
|
+
* @property fragment: Indicates whether the component is a fragment. True if the component is a fragment, otherwise false.
|
|
45379
|
+
*
|
|
45380
|
+
* @property contentLinkUuid: Represents a globally unique identifier for every instance of a content component (or fragment) rendered on a page.
|
|
45381
|
+
* - **Max Length:** 256
|
|
45382
|
+
*
|
|
45027
45383
|
* @property data: The configuration data assigned to the component.
|
|
45028
45384
|
*
|
|
45385
|
+
* @property localized: Whether the component has been localized with content in the current locale. If false, the components content will fallback to the default locale.
|
|
45386
|
+
*
|
|
45387
|
+
* @property visible: Whether the component is visible based on the current visiblity rules and context.
|
|
45388
|
+
*
|
|
45029
45389
|
* @property custom: Any custom data added by the custom code for this component.
|
|
45030
45390
|
*
|
|
45391
|
+
* @property designMetadata: Design metadata of the component. This includes information about the component type definition needed by the page designer for design-time functionality.
|
|
45392
|
+
*
|
|
45031
45393
|
* @property regions: The regions (and their assigned components) for the component.
|
|
45032
45394
|
*
|
|
45033
45395
|
*/
|
|
45034
45396
|
type Component = {
|
|
45035
45397
|
id: string;
|
|
45036
45398
|
typeId: string;
|
|
45399
|
+
name?: string;
|
|
45400
|
+
fragment?: boolean;
|
|
45401
|
+
contentLinkUuid?: string;
|
|
45037
45402
|
data?: object;
|
|
45403
|
+
localized?: boolean;
|
|
45404
|
+
visible?: boolean;
|
|
45038
45405
|
custom?: object;
|
|
45406
|
+
designMetadata?: object;
|
|
45039
45407
|
regions?: Array<Region>;
|
|
45040
45408
|
} & {
|
|
45041
45409
|
[key: string]: any;
|
|
@@ -45216,6 +45584,24 @@ type ContentSearchResult = {
|
|
|
45216
45584
|
} & {
|
|
45217
45585
|
[key: string]: any;
|
|
45218
45586
|
};
|
|
45587
|
+
/**
|
|
45588
|
+
* @type DataBindingRequirement: A data binding requirement specifying a provider type and record identifier to resolve.
|
|
45589
|
+
*
|
|
45590
|
+
* @property type: The data provider type identifier.
|
|
45591
|
+
* - **Min Length:** 1
|
|
45592
|
+
* - **Max Length:** 256
|
|
45593
|
+
*
|
|
45594
|
+
* @property id: The record identifier to resolve from the data provider.
|
|
45595
|
+
* - **Min Length:** 1
|
|
45596
|
+
* - **Max Length:** 256
|
|
45597
|
+
*
|
|
45598
|
+
*/
|
|
45599
|
+
type DataBindingRequirement = {
|
|
45600
|
+
type: string;
|
|
45601
|
+
id: string;
|
|
45602
|
+
} & {
|
|
45603
|
+
[key: string]: any;
|
|
45604
|
+
};
|
|
45219
45605
|
/**
|
|
45220
45606
|
* @type LocaleCode
|
|
45221
45607
|
* A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
|
|
@@ -45252,6 +45638,12 @@ type LocaleCode$3 = string;
|
|
|
45252
45638
|
*
|
|
45253
45639
|
* @property custom: Any custom data added by the custom code for the page type.
|
|
45254
45640
|
*
|
|
45641
|
+
* @property visible: Whether the page is visible based on the current visiblity rules and context.
|
|
45642
|
+
*
|
|
45643
|
+
* @property localized: Whether the page has been localized with content in the current locale. If false, the page content will fallback to the default locale.
|
|
45644
|
+
*
|
|
45645
|
+
* @property designMetadata: Design metadata of the page. This includes information about the page type definition needed by the page designer for design-time functionality.
|
|
45646
|
+
*
|
|
45255
45647
|
* @property regions: The regions (and their assigned components) for the page.
|
|
45256
45648
|
*
|
|
45257
45649
|
*/
|
|
@@ -45266,6 +45658,9 @@ type Page = {
|
|
|
45266
45658
|
pageKeywords?: string;
|
|
45267
45659
|
data?: object;
|
|
45268
45660
|
custom?: object;
|
|
45661
|
+
visible?: boolean;
|
|
45662
|
+
localized?: boolean;
|
|
45663
|
+
designMetadata?: object;
|
|
45269
45664
|
regions?: Array<Region>;
|
|
45270
45665
|
} & {
|
|
45271
45666
|
[key: string]: any;
|
|
@@ -45281,6 +45676,52 @@ type PageResult = {
|
|
|
45281
45676
|
} & {
|
|
45282
45677
|
[key: string]: any;
|
|
45283
45678
|
};
|
|
45679
|
+
/**
|
|
45680
|
+
* @type QualifierResolveRequest: Request body for resolving customer group qualifications, campaign promotion eligibility, and data bindings. All fields are optional. An empty body is valid and returns an empty response.
|
|
45681
|
+
*
|
|
45682
|
+
* @property customerGroups: List of customer group identifiers to resolve qualification for.
|
|
45683
|
+
*
|
|
45684
|
+
* @property campaignQualifiers: List of campaign and promotion pairs to resolve qualification for.
|
|
45685
|
+
*
|
|
45686
|
+
* @property dataBindings: List of data binding requirements to resolve, each specifying a provider type and record identifier.
|
|
45687
|
+
*
|
|
45688
|
+
*/
|
|
45689
|
+
type QualifierResolveRequest = {
|
|
45690
|
+
customerGroups?: Array<string>;
|
|
45691
|
+
campaignQualifiers?: Array<CampaignQualifier>;
|
|
45692
|
+
dataBindings?: Array<DataBindingRequirement>;
|
|
45693
|
+
} & {
|
|
45694
|
+
[key: string]: any;
|
|
45695
|
+
};
|
|
45696
|
+
/**
|
|
45697
|
+
* @type QualifierResolveResponse: Response containing the resolved qualification results for customer groups, campaign qualifiers, and data bindings.
|
|
45698
|
+
*
|
|
45699
|
+
* @property customerGroups: Map of customer group identifiers to their qualification status. True if the user is qualified, false otherwise.
|
|
45700
|
+
*
|
|
45701
|
+
* @property campaignQualifiers: Map of campaign identifiers to a map of promotion identifiers and their qualification status. True if the user is applicable, false otherwise.
|
|
45702
|
+
*
|
|
45703
|
+
* @property dataBindings: Resolved data binding objects grouped by provider type, then by record identifier. Used by the expression resolver to evaluate attribute expressions.
|
|
45704
|
+
*
|
|
45705
|
+
*/
|
|
45706
|
+
type QualifierResolveResponse = {
|
|
45707
|
+
customerGroups?: {
|
|
45708
|
+
[key: string]: boolean;
|
|
45709
|
+
};
|
|
45710
|
+
campaignQualifiers?: {
|
|
45711
|
+
[key: string]: {
|
|
45712
|
+
[key: string]: boolean;
|
|
45713
|
+
};
|
|
45714
|
+
};
|
|
45715
|
+
dataBindings?: {
|
|
45716
|
+
[key: string]: {
|
|
45717
|
+
[key: string]: {
|
|
45718
|
+
[key: string]: any;
|
|
45719
|
+
};
|
|
45720
|
+
};
|
|
45721
|
+
};
|
|
45722
|
+
} & {
|
|
45723
|
+
[key: string]: any;
|
|
45724
|
+
};
|
|
45284
45725
|
type getContentQueryParameters = {
|
|
45285
45726
|
siteId: string;
|
|
45286
45727
|
locale?: LocaleCode$3;
|
|
@@ -45337,6 +45778,13 @@ type getPagesQueryParameters = {
|
|
|
45337
45778
|
type getPagesPathParameters = {
|
|
45338
45779
|
organizationId: string;
|
|
45339
45780
|
};
|
|
45781
|
+
type resolveQualifiersQueryParameters = {
|
|
45782
|
+
siteId: string;
|
|
45783
|
+
locale?: LocaleCode$3;
|
|
45784
|
+
};
|
|
45785
|
+
type resolveQualifiersPathParameters = {
|
|
45786
|
+
organizationId: string;
|
|
45787
|
+
};
|
|
45340
45788
|
type searchContentQueryParameters = {
|
|
45341
45789
|
q?: string;
|
|
45342
45790
|
refine?: string;
|
|
@@ -45352,11 +45800,11 @@ type searchContentPathParameters = {
|
|
|
45352
45800
|
/**
|
|
45353
45801
|
* All path parameters that are used by at least one ShopperExperience method.
|
|
45354
45802
|
*/
|
|
45355
|
-
type ShopperExperiencePathParameters = Partial<getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & searchContentPathParameters & {}>;
|
|
45803
|
+
type ShopperExperiencePathParameters = Partial<getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & resolveQualifiersPathParameters & searchContentPathParameters & {}>;
|
|
45356
45804
|
/**
|
|
45357
45805
|
* All query parameters that are used by at least one ShopperExperience method.
|
|
45358
45806
|
*/
|
|
45359
|
-
type ShopperExperienceQueryParameters = Partial<getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & searchContentQueryParameters & {}>;
|
|
45807
|
+
type ShopperExperienceQueryParameters = Partial<getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & resolveQualifiersQueryParameters & searchContentQueryParameters & {}>;
|
|
45360
45808
|
/**
|
|
45361
45809
|
* All parameters that are used by ShopperExperience.
|
|
45362
45810
|
*/
|
|
@@ -45368,7 +45816,7 @@ type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriPara
|
|
|
45368
45816
|
* *[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/shopper-experience/shopper-experience-oas-v1-public.yaml)
|
|
45369
45817
|
|
|
45370
45818
|
# API Overview
|
|
45371
|
-
Use the Shopper Experience API to look up page information for pages
|
|
45819
|
+
Use the Shopper Experience API to look up page information for pages created in Page Designer, search and retrieve content assets, and access content folders.
|
|
45372
45820
|
|
|
45373
45821
|
## Authentication & Authorization
|
|
45374
45822
|
|
|
@@ -45392,12 +45840,27 @@ type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriPara
|
|
|
45392
45840
|
|
|
45393
45841
|
Only content folders that are marked as online are returned in the API responses.
|
|
45394
45842
|
|
|
45843
|
+
### Search Content Assets
|
|
45844
|
+
Search for content assets using keywords and refinement filters. The search functionality supports:
|
|
45845
|
+
|
|
45846
|
+
- Keyword-based search across content assets
|
|
45847
|
+
- Refinement attributes to filter results, for example, by folder or content type
|
|
45848
|
+
- Sorting by configurable attributes
|
|
45849
|
+
- Pagination for large result sets (up to 200 items per page)
|
|
45850
|
+
|
|
45851
|
+
Only content assets that are online and assigned to a folder are included in search results.
|
|
45852
|
+
|
|
45853
|
+
### Batch Retrieval
|
|
45854
|
+
Retrieve multiple content assets or content folders in a single API request for improved performance (up to 50 content assets or folders at once).
|
|
45855
|
+
|
|
45395
45856
|
## Page Responses
|
|
45396
45857
|
Responses for pages include the following:
|
|
45397
45858
|
|
|
45398
45859
|
- The entire component hierarchy of the page at design time.
|
|
45399
45860
|
- All merchant data provided at design time.
|
|
45400
45861
|
- Server-side scripting data provided at run time.
|
|
45862
|
+
- Tracking for each rendered component or fragment using a globally unique content link UUID.
|
|
45863
|
+
- Support for reusable component fragments that can be shared across multiple pages.
|
|
45401
45864
|
|
|
45402
45865
|
Both the page and components contain the values of all native and custom attributes that have been populated during page authoring.
|
|
45403
45866
|
|
|
@@ -45451,6 +45914,7 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
|
|
|
45451
45914
|
getMultipleContent: string;
|
|
45452
45915
|
getPage: string;
|
|
45453
45916
|
getPages: string;
|
|
45917
|
+
resolveQualifiers: string;
|
|
45454
45918
|
searchContent: string;
|
|
45455
45919
|
};
|
|
45456
45920
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
@@ -45529,6 +45993,15 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
|
|
|
45529
45993
|
"aspectTypeId",
|
|
45530
45994
|
"siteId"
|
|
45531
45995
|
];
|
|
45996
|
+
readonly resolveQualifiers: readonly [
|
|
45997
|
+
"organizationId",
|
|
45998
|
+
"siteId",
|
|
45999
|
+
"locale"
|
|
46000
|
+
];
|
|
46001
|
+
readonly resolveQualifiersRequired: readonly [
|
|
46002
|
+
"organizationId",
|
|
46003
|
+
"siteId"
|
|
46004
|
+
];
|
|
45532
46005
|
readonly searchContent: readonly [
|
|
45533
46006
|
"organizationId",
|
|
45534
46007
|
"siteId",
|
|
@@ -45938,6 +46411,73 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
|
|
|
45938
46411
|
[key: string]: string;
|
|
45939
46412
|
};
|
|
45940
46413
|
}>, rawResponse?: T): Promise<T extends true ? Response : PageResult>;
|
|
46414
|
+
/**
|
|
46415
|
+
* Resolves a list of customer groups, campaigns, promotions, and data bindings for the given user.
|
|
46416
|
+
|
|
46417
|
+
The endpoint takes each value and determines whether the user is active for the item:
|
|
46418
|
+
- Customer groups are verified against the user's qualification via the EffectiveContext.
|
|
46419
|
+
- Campaign qualifiers are checked to determine if the user is applicable for each campaign and promotion.
|
|
46420
|
+
- Data bindings are resolved by fetching the requested records from their respective data providers.
|
|
46421
|
+
|
|
46422
|
+
Returns a boolean result for each provided qualifier and resolved data binding objects grouped by provider type and record identifier. If a qualifier cannot be validated, `false` is returned for that item. If a data binding cannot be resolved, it is omitted from the response.
|
|
46423
|
+
|
|
46424
|
+
*
|
|
46425
|
+
* If you would like to get a raw Response object use the other resolveQualifiers function.
|
|
46426
|
+
*
|
|
46427
|
+
* @param options - An object containing the options for this method.
|
|
46428
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
46429
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
46430
|
+
* @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.
|
|
46431
|
+
* @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
|
|
46432
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
46433
|
+
* @param options.body - The data to send as the request body.
|
|
46434
|
+
*
|
|
46435
|
+
* @returns A promise of type QualifierResolveResponse.
|
|
46436
|
+
*/
|
|
46437
|
+
resolveQualifiers(options: RequireParametersUnlessAllAreOptional<{
|
|
46438
|
+
parameters?: CompositeParameters<{
|
|
46439
|
+
organizationId: string;
|
|
46440
|
+
siteId: string;
|
|
46441
|
+
locale?: LocaleCode$3;
|
|
46442
|
+
} & QueryParameters, ConfigParameters>;
|
|
46443
|
+
headers?: {
|
|
46444
|
+
[key: string]: string;
|
|
46445
|
+
};
|
|
46446
|
+
body: QualifierResolveRequest & CustomRequestBody;
|
|
46447
|
+
}>): Promise<QualifierResolveResponse>;
|
|
46448
|
+
/**
|
|
46449
|
+
* Resolves a list of customer groups, campaigns, promotions, and data bindings for the given user.
|
|
46450
|
+
|
|
46451
|
+
The endpoint takes each value and determines whether the user is active for the item:
|
|
46452
|
+
- Customer groups are verified against the user's qualification via the EffectiveContext.
|
|
46453
|
+
- Campaign qualifiers are checked to determine if the user is applicable for each campaign and promotion.
|
|
46454
|
+
- Data bindings are resolved by fetching the requested records from their respective data providers.
|
|
46455
|
+
|
|
46456
|
+
Returns a boolean result for each provided qualifier and resolved data binding objects grouped by provider type and record identifier. If a qualifier cannot be validated, `false` is returned for that item. If a data binding cannot be resolved, it is omitted from the response.
|
|
46457
|
+
|
|
46458
|
+
*
|
|
46459
|
+
* @param options - An object containing the options for this method.
|
|
46460
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
46461
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
46462
|
+
* @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.
|
|
46463
|
+
* @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
|
|
46464
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
46465
|
+
* @param options.body - The data to send as the request body.
|
|
46466
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
46467
|
+
*
|
|
46468
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type QualifierResolveResponse otherwise.
|
|
46469
|
+
*/
|
|
46470
|
+
resolveQualifiers<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
46471
|
+
parameters?: CompositeParameters<{
|
|
46472
|
+
organizationId: string;
|
|
46473
|
+
siteId: string;
|
|
46474
|
+
locale?: LocaleCode$3;
|
|
46475
|
+
} & QueryParameters, ConfigParameters>;
|
|
46476
|
+
headers?: {
|
|
46477
|
+
[key: string]: string;
|
|
46478
|
+
};
|
|
46479
|
+
body: QualifierResolveRequest & CustomRequestBody;
|
|
46480
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : QualifierResolveResponse>;
|
|
45941
46481
|
/**
|
|
45942
46482
|
* Provides keyword and refinement search functionality for content assets. The search result contains only content
|
|
45943
46483
|
that is online and assigned to a folder.
|
|
@@ -45965,7 +46505,7 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
|
|
|
45965
46505
|
|
|
45966
46506
|
Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes.
|
|
45967
46507
|
* @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
|
|
45968
|
-
* @param options.parameters.limit -
|
|
46508
|
+
* @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
|
|
45969
46509
|
* @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
|
|
45970
46510
|
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
45971
46511
|
*
|
|
@@ -46011,7 +46551,7 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
|
|
|
46011
46551
|
|
|
46012
46552
|
Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes.
|
|
46013
46553
|
* @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
|
|
46014
|
-
* @param options.parameters.limit -
|
|
46554
|
+
* @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
|
|
46015
46555
|
* @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
|
|
46016
46556
|
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
46017
46557
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -46130,6 +46670,7 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46130
46670
|
[key: string]: string;
|
|
46131
46671
|
}) => Required<FetchOptions>["body"];
|
|
46132
46672
|
throwOnBadResponse?: boolean;
|
|
46673
|
+
throwOnMaintenanceHeader?: boolean;
|
|
46133
46674
|
}
|
|
46134
46675
|
/**
|
|
46135
46676
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -46145,9 +46686,28 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46145
46686
|
fetch?: FetchFunction;
|
|
46146
46687
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
46147
46688
|
throwOnBadResponse: boolean;
|
|
46689
|
+
throwOnMaintenanceHeader: boolean;
|
|
46148
46690
|
constructor(config: ClientConfigInit<Params>);
|
|
46149
46691
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
46150
46692
|
}
|
|
46693
|
+
/**
|
|
46694
|
+
* @type CampaignQualifier: A campaign and promotion pair to resolve qualification for.
|
|
46695
|
+
*
|
|
46696
|
+
* @property campaignId: The identifier of the campaign.
|
|
46697
|
+
* - **Min Length:** 1
|
|
46698
|
+
* - **Max Length:** 256
|
|
46699
|
+
*
|
|
46700
|
+
* @property promotionId: The identifier of the promotion within the campaign.
|
|
46701
|
+
* - **Min Length:** 1
|
|
46702
|
+
* - **Max Length:** 256
|
|
46703
|
+
*
|
|
46704
|
+
*/
|
|
46705
|
+
type CampaignQualifier = {
|
|
46706
|
+
campaignId: string;
|
|
46707
|
+
promotionId: string;
|
|
46708
|
+
} & {
|
|
46709
|
+
[key: string]: any;
|
|
46710
|
+
};
|
|
46151
46711
|
/**
|
|
46152
46712
|
* @type Region:
|
|
46153
46713
|
*
|
|
@@ -46172,18 +46732,38 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46172
46732
|
* @property typeId: Component type identifier.
|
|
46173
46733
|
* - **Max Length:** 256
|
|
46174
46734
|
*
|
|
46735
|
+
* @property name: Display name of the component.
|
|
46736
|
+
* - **Max Length:** 256
|
|
46737
|
+
*
|
|
46738
|
+
* @property fragment: Indicates whether the component is a fragment. True if the component is a fragment, otherwise false.
|
|
46739
|
+
*
|
|
46740
|
+
* @property contentLinkUuid: Represents a globally unique identifier for every instance of a content component (or fragment) rendered on a page.
|
|
46741
|
+
* - **Max Length:** 256
|
|
46742
|
+
*
|
|
46175
46743
|
* @property data: The configuration data assigned to the component.
|
|
46176
46744
|
*
|
|
46745
|
+
* @property localized: Whether the component has been localized with content in the current locale. If false, the components content will fallback to the default locale.
|
|
46746
|
+
*
|
|
46747
|
+
* @property visible: Whether the component is visible based on the current visiblity rules and context.
|
|
46748
|
+
*
|
|
46177
46749
|
* @property custom: Any custom data added by the custom code for this component.
|
|
46178
46750
|
*
|
|
46751
|
+
* @property designMetadata: Design metadata of the component. This includes information about the component type definition needed by the page designer for design-time functionality.
|
|
46752
|
+
*
|
|
46179
46753
|
* @property regions: The regions (and their assigned components) for the component.
|
|
46180
46754
|
*
|
|
46181
46755
|
*/
|
|
46182
46756
|
type Component = {
|
|
46183
46757
|
id: string;
|
|
46184
46758
|
typeId: string;
|
|
46759
|
+
name?: string;
|
|
46760
|
+
fragment?: boolean;
|
|
46761
|
+
contentLinkUuid?: string;
|
|
46185
46762
|
data?: object;
|
|
46763
|
+
localized?: boolean;
|
|
46764
|
+
visible?: boolean;
|
|
46186
46765
|
custom?: object;
|
|
46766
|
+
designMetadata?: object;
|
|
46187
46767
|
regions?: Array<Region>;
|
|
46188
46768
|
} & {
|
|
46189
46769
|
[key: string]: any;
|
|
@@ -46364,6 +46944,24 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46364
46944
|
} & {
|
|
46365
46945
|
[key: string]: any;
|
|
46366
46946
|
};
|
|
46947
|
+
/**
|
|
46948
|
+
* @type DataBindingRequirement: A data binding requirement specifying a provider type and record identifier to resolve.
|
|
46949
|
+
*
|
|
46950
|
+
* @property type: The data provider type identifier.
|
|
46951
|
+
* - **Min Length:** 1
|
|
46952
|
+
* - **Max Length:** 256
|
|
46953
|
+
*
|
|
46954
|
+
* @property id: The record identifier to resolve from the data provider.
|
|
46955
|
+
* - **Min Length:** 1
|
|
46956
|
+
* - **Max Length:** 256
|
|
46957
|
+
*
|
|
46958
|
+
*/
|
|
46959
|
+
type DataBindingRequirement = {
|
|
46960
|
+
type: string;
|
|
46961
|
+
id: string;
|
|
46962
|
+
} & {
|
|
46963
|
+
[key: string]: any;
|
|
46964
|
+
};
|
|
46367
46965
|
/**
|
|
46368
46966
|
* @type ErrorResponse:
|
|
46369
46967
|
*
|
|
@@ -46423,6 +47021,12 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46423
47021
|
*
|
|
46424
47022
|
* @property custom: Any custom data added by the custom code for the page type.
|
|
46425
47023
|
*
|
|
47024
|
+
* @property visible: Whether the page is visible based on the current visiblity rules and context.
|
|
47025
|
+
*
|
|
47026
|
+
* @property localized: Whether the page has been localized with content in the current locale. If false, the page content will fallback to the default locale.
|
|
47027
|
+
*
|
|
47028
|
+
* @property designMetadata: Design metadata of the page. This includes information about the page type definition needed by the page designer for design-time functionality.
|
|
47029
|
+
*
|
|
46426
47030
|
* @property regions: The regions (and their assigned components) for the page.
|
|
46427
47031
|
*
|
|
46428
47032
|
*/
|
|
@@ -46437,6 +47041,9 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46437
47041
|
pageKeywords?: string;
|
|
46438
47042
|
data?: object;
|
|
46439
47043
|
custom?: object;
|
|
47044
|
+
visible?: boolean;
|
|
47045
|
+
localized?: boolean;
|
|
47046
|
+
designMetadata?: object;
|
|
46440
47047
|
regions?: Array<Region>;
|
|
46441
47048
|
} & {
|
|
46442
47049
|
[key: string]: any;
|
|
@@ -46469,6 +47076,52 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46469
47076
|
} & {
|
|
46470
47077
|
[key: string]: any;
|
|
46471
47078
|
};
|
|
47079
|
+
/**
|
|
47080
|
+
* @type QualifierResolveRequest: Request body for resolving customer group qualifications, campaign promotion eligibility, and data bindings. All fields are optional. An empty body is valid and returns an empty response.
|
|
47081
|
+
*
|
|
47082
|
+
* @property customerGroups: List of customer group identifiers to resolve qualification for.
|
|
47083
|
+
*
|
|
47084
|
+
* @property campaignQualifiers: List of campaign and promotion pairs to resolve qualification for.
|
|
47085
|
+
*
|
|
47086
|
+
* @property dataBindings: List of data binding requirements to resolve, each specifying a provider type and record identifier.
|
|
47087
|
+
*
|
|
47088
|
+
*/
|
|
47089
|
+
type QualifierResolveRequest = {
|
|
47090
|
+
customerGroups?: Array<string>;
|
|
47091
|
+
campaignQualifiers?: Array<CampaignQualifier>;
|
|
47092
|
+
dataBindings?: Array<DataBindingRequirement>;
|
|
47093
|
+
} & {
|
|
47094
|
+
[key: string]: any;
|
|
47095
|
+
};
|
|
47096
|
+
/**
|
|
47097
|
+
* @type QualifierResolveResponse: Response containing the resolved qualification results for customer groups, campaign qualifiers, and data bindings.
|
|
47098
|
+
*
|
|
47099
|
+
* @property customerGroups: Map of customer group identifiers to their qualification status. True if the user is qualified, false otherwise.
|
|
47100
|
+
*
|
|
47101
|
+
* @property campaignQualifiers: Map of campaign identifiers to a map of promotion identifiers and their qualification status. True if the user is applicable, false otherwise.
|
|
47102
|
+
*
|
|
47103
|
+
* @property dataBindings: Resolved data binding objects grouped by provider type, then by record identifier. Used by the expression resolver to evaluate attribute expressions.
|
|
47104
|
+
*
|
|
47105
|
+
*/
|
|
47106
|
+
type QualifierResolveResponse = {
|
|
47107
|
+
customerGroups?: {
|
|
47108
|
+
[key: string]: boolean;
|
|
47109
|
+
};
|
|
47110
|
+
campaignQualifiers?: {
|
|
47111
|
+
[key: string]: {
|
|
47112
|
+
[key: string]: boolean;
|
|
47113
|
+
};
|
|
47114
|
+
};
|
|
47115
|
+
dataBindings?: {
|
|
47116
|
+
[key: string]: {
|
|
47117
|
+
[key: string]: {
|
|
47118
|
+
[key: string]: any;
|
|
47119
|
+
};
|
|
47120
|
+
};
|
|
47121
|
+
};
|
|
47122
|
+
} & {
|
|
47123
|
+
[key: string]: any;
|
|
47124
|
+
};
|
|
46472
47125
|
/**
|
|
46473
47126
|
* @type ResultBase: Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema. Additionally it needs to be defined what data is returned.
|
|
46474
47127
|
*
|
|
@@ -46539,6 +47192,13 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46539
47192
|
type getPagesPathParameters = {
|
|
46540
47193
|
organizationId: string;
|
|
46541
47194
|
};
|
|
47195
|
+
type resolveQualifiersQueryParameters = {
|
|
47196
|
+
siteId: string;
|
|
47197
|
+
locale?: LocaleCode$0;
|
|
47198
|
+
};
|
|
47199
|
+
type resolveQualifiersPathParameters = {
|
|
47200
|
+
organizationId: string;
|
|
47201
|
+
};
|
|
46542
47202
|
type searchContentQueryParameters = {
|
|
46543
47203
|
q?: string;
|
|
46544
47204
|
refine?: string;
|
|
@@ -46554,11 +47214,11 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46554
47214
|
/**
|
|
46555
47215
|
* All path parameters that are used by at least one ShopperExperience method.
|
|
46556
47216
|
*/
|
|
46557
|
-
type ShopperExperiencePathParameters = Partial<getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & searchContentPathParameters & {}>;
|
|
47217
|
+
type ShopperExperiencePathParameters = Partial<getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & resolveQualifiersPathParameters & searchContentPathParameters & {}>;
|
|
46558
47218
|
/**
|
|
46559
47219
|
* All query parameters that are used by at least one ShopperExperience method.
|
|
46560
47220
|
*/
|
|
46561
|
-
type ShopperExperienceQueryParameters = Partial<getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & searchContentQueryParameters & {}>;
|
|
47221
|
+
type ShopperExperienceQueryParameters = Partial<getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & resolveQualifiersQueryParameters & searchContentQueryParameters & {}>;
|
|
46562
47222
|
/**
|
|
46563
47223
|
* All parameters that are used by ShopperExperience.
|
|
46564
47224
|
*/
|
|
@@ -46570,7 +47230,7 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46570
47230
|
* *[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/shopper-experience/shopper-experience-oas-v1-public.yaml)
|
|
46571
47231
|
|
|
46572
47232
|
# API Overview
|
|
46573
|
-
Use the Shopper Experience API to look up page information for pages
|
|
47233
|
+
Use the Shopper Experience API to look up page information for pages created in Page Designer, search and retrieve content assets, and access content folders.
|
|
46574
47234
|
|
|
46575
47235
|
## Authentication & Authorization
|
|
46576
47236
|
|
|
@@ -46594,12 +47254,27 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46594
47254
|
|
|
46595
47255
|
Only content folders that are marked as online are returned in the API responses.
|
|
46596
47256
|
|
|
47257
|
+
### Search Content Assets
|
|
47258
|
+
Search for content assets using keywords and refinement filters. The search functionality supports:
|
|
47259
|
+
|
|
47260
|
+
- Keyword-based search across content assets
|
|
47261
|
+
- Refinement attributes to filter results, for example, by folder or content type
|
|
47262
|
+
- Sorting by configurable attributes
|
|
47263
|
+
- Pagination for large result sets (up to 200 items per page)
|
|
47264
|
+
|
|
47265
|
+
Only content assets that are online and assigned to a folder are included in search results.
|
|
47266
|
+
|
|
47267
|
+
### Batch Retrieval
|
|
47268
|
+
Retrieve multiple content assets or content folders in a single API request for improved performance (up to 50 content assets or folders at once).
|
|
47269
|
+
|
|
46597
47270
|
## Page Responses
|
|
46598
47271
|
Responses for pages include the following:
|
|
46599
47272
|
|
|
46600
47273
|
- The entire component hierarchy of the page at design time.
|
|
46601
47274
|
- All merchant data provided at design time.
|
|
46602
47275
|
- Server-side scripting data provided at run time.
|
|
47276
|
+
- Tracking for each rendered component or fragment using a globally unique content link UUID.
|
|
47277
|
+
- Support for reusable component fragments that can be shared across multiple pages.
|
|
46603
47278
|
|
|
46604
47279
|
Both the page and components contain the values of all native and custom attributes that have been populated during page authoring.
|
|
46605
47280
|
|
|
@@ -46653,6 +47328,7 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46653
47328
|
getMultipleContent: string;
|
|
46654
47329
|
getPage: string;
|
|
46655
47330
|
getPages: string;
|
|
47331
|
+
resolveQualifiers: string;
|
|
46656
47332
|
searchContent: string;
|
|
46657
47333
|
};
|
|
46658
47334
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
@@ -46731,6 +47407,15 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
46731
47407
|
"aspectTypeId",
|
|
46732
47408
|
"siteId"
|
|
46733
47409
|
];
|
|
47410
|
+
readonly resolveQualifiers: readonly [
|
|
47411
|
+
"organizationId",
|
|
47412
|
+
"siteId",
|
|
47413
|
+
"locale"
|
|
47414
|
+
];
|
|
47415
|
+
readonly resolveQualifiersRequired: readonly [
|
|
47416
|
+
"organizationId",
|
|
47417
|
+
"siteId"
|
|
47418
|
+
];
|
|
46734
47419
|
readonly searchContent: readonly [
|
|
46735
47420
|
"organizationId",
|
|
46736
47421
|
"siteId",
|
|
@@ -47140,6 +47825,73 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
47140
47825
|
[key: string]: string;
|
|
47141
47826
|
};
|
|
47142
47827
|
}>, rawResponse?: T): Promise<T extends true ? Response : PageResult>;
|
|
47828
|
+
/**
|
|
47829
|
+
* Resolves a list of customer groups, campaigns, promotions, and data bindings for the given user.
|
|
47830
|
+
|
|
47831
|
+
The endpoint takes each value and determines whether the user is active for the item:
|
|
47832
|
+
- Customer groups are verified against the user's qualification via the EffectiveContext.
|
|
47833
|
+
- Campaign qualifiers are checked to determine if the user is applicable for each campaign and promotion.
|
|
47834
|
+
- Data bindings are resolved by fetching the requested records from their respective data providers.
|
|
47835
|
+
|
|
47836
|
+
Returns a boolean result for each provided qualifier and resolved data binding objects grouped by provider type and record identifier. If a qualifier cannot be validated, `false` is returned for that item. If a data binding cannot be resolved, it is omitted from the response.
|
|
47837
|
+
|
|
47838
|
+
*
|
|
47839
|
+
* If you would like to get a raw Response object use the other resolveQualifiers function.
|
|
47840
|
+
*
|
|
47841
|
+
* @param options - An object containing the options for this method.
|
|
47842
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
47843
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
47844
|
+
* @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.
|
|
47845
|
+
* @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
|
|
47846
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
47847
|
+
* @param options.body - The data to send as the request body.
|
|
47848
|
+
*
|
|
47849
|
+
* @returns A promise of type QualifierResolveResponse.
|
|
47850
|
+
*/
|
|
47851
|
+
resolveQualifiers(options: RequireParametersUnlessAllAreOptional<{
|
|
47852
|
+
parameters?: CompositeParameters<{
|
|
47853
|
+
organizationId: string;
|
|
47854
|
+
siteId: string;
|
|
47855
|
+
locale?: LocaleCode$0;
|
|
47856
|
+
} & QueryParameters, ConfigParameters>;
|
|
47857
|
+
headers?: {
|
|
47858
|
+
[key: string]: string;
|
|
47859
|
+
};
|
|
47860
|
+
body: QualifierResolveRequest & CustomRequestBody;
|
|
47861
|
+
}>): Promise<QualifierResolveResponse>;
|
|
47862
|
+
/**
|
|
47863
|
+
* Resolves a list of customer groups, campaigns, promotions, and data bindings for the given user.
|
|
47864
|
+
|
|
47865
|
+
The endpoint takes each value and determines whether the user is active for the item:
|
|
47866
|
+
- Customer groups are verified against the user's qualification via the EffectiveContext.
|
|
47867
|
+
- Campaign qualifiers are checked to determine if the user is applicable for each campaign and promotion.
|
|
47868
|
+
- Data bindings are resolved by fetching the requested records from their respective data providers.
|
|
47869
|
+
|
|
47870
|
+
Returns a boolean result for each provided qualifier and resolved data binding objects grouped by provider type and record identifier. If a qualifier cannot be validated, `false` is returned for that item. If a data binding cannot be resolved, it is omitted from the response.
|
|
47871
|
+
|
|
47872
|
+
*
|
|
47873
|
+
* @param options - An object containing the options for this method.
|
|
47874
|
+
* @param options.parameters - An object containing the parameters for this method.
|
|
47875
|
+
* @param options.parameters.organizationId - An identifier for the organization the request is being made by
|
|
47876
|
+
* @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.
|
|
47877
|
+
* @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
|
|
47878
|
+
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
47879
|
+
* @param options.body - The data to send as the request body.
|
|
47880
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
47881
|
+
*
|
|
47882
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type QualifierResolveResponse otherwise.
|
|
47883
|
+
*/
|
|
47884
|
+
resolveQualifiers<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
47885
|
+
parameters?: CompositeParameters<{
|
|
47886
|
+
organizationId: string;
|
|
47887
|
+
siteId: string;
|
|
47888
|
+
locale?: LocaleCode$0;
|
|
47889
|
+
} & QueryParameters, ConfigParameters>;
|
|
47890
|
+
headers?: {
|
|
47891
|
+
[key: string]: string;
|
|
47892
|
+
};
|
|
47893
|
+
body: QualifierResolveRequest & CustomRequestBody;
|
|
47894
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : QualifierResolveResponse>;
|
|
47143
47895
|
/**
|
|
47144
47896
|
* Provides keyword and refinement search functionality for content assets. The search result contains only content
|
|
47145
47897
|
that is online and assigned to a folder.
|
|
@@ -47167,7 +47919,7 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
47167
47919
|
|
|
47168
47920
|
Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes.
|
|
47169
47921
|
* @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
|
|
47170
|
-
* @param options.parameters.limit -
|
|
47922
|
+
* @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
|
|
47171
47923
|
* @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
|
|
47172
47924
|
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
47173
47925
|
*
|
|
@@ -47213,7 +47965,7 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
47213
47965
|
|
|
47214
47966
|
Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes.
|
|
47215
47967
|
* @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
|
|
47216
|
-
* @param options.parameters.limit -
|
|
47968
|
+
* @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
|
|
47217
47969
|
* @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
|
|
47218
47970
|
* @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
|
|
47219
47971
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -47238,6 +47990,24 @@ declare namespace ShopperExperienceApiTypes {
|
|
|
47238
47990
|
}
|
|
47239
47991
|
}
|
|
47240
47992
|
declare namespace ShopperExperienceModelTypes {
|
|
47993
|
+
/**
|
|
47994
|
+
* @type CampaignQualifier: A campaign and promotion pair to resolve qualification for.
|
|
47995
|
+
*
|
|
47996
|
+
* @property campaignId: The identifier of the campaign.
|
|
47997
|
+
* - **Min Length:** 1
|
|
47998
|
+
* - **Max Length:** 256
|
|
47999
|
+
*
|
|
48000
|
+
* @property promotionId: The identifier of the promotion within the campaign.
|
|
48001
|
+
* - **Min Length:** 1
|
|
48002
|
+
* - **Max Length:** 256
|
|
48003
|
+
*
|
|
48004
|
+
*/
|
|
48005
|
+
type CampaignQualifier = {
|
|
48006
|
+
campaignId: string;
|
|
48007
|
+
promotionId: string;
|
|
48008
|
+
} & {
|
|
48009
|
+
[key: string]: any;
|
|
48010
|
+
};
|
|
47241
48011
|
/**
|
|
47242
48012
|
* @type Region:
|
|
47243
48013
|
*
|
|
@@ -47262,18 +48032,38 @@ declare namespace ShopperExperienceModelTypes {
|
|
|
47262
48032
|
* @property typeId: Component type identifier.
|
|
47263
48033
|
* - **Max Length:** 256
|
|
47264
48034
|
*
|
|
48035
|
+
* @property name: Display name of the component.
|
|
48036
|
+
* - **Max Length:** 256
|
|
48037
|
+
*
|
|
48038
|
+
* @property fragment: Indicates whether the component is a fragment. True if the component is a fragment, otherwise false.
|
|
48039
|
+
*
|
|
48040
|
+
* @property contentLinkUuid: Represents a globally unique identifier for every instance of a content component (or fragment) rendered on a page.
|
|
48041
|
+
* - **Max Length:** 256
|
|
48042
|
+
*
|
|
47265
48043
|
* @property data: The configuration data assigned to the component.
|
|
47266
48044
|
*
|
|
48045
|
+
* @property localized: Whether the component has been localized with content in the current locale. If false, the components content will fallback to the default locale.
|
|
48046
|
+
*
|
|
48047
|
+
* @property visible: Whether the component is visible based on the current visiblity rules and context.
|
|
48048
|
+
*
|
|
47267
48049
|
* @property custom: Any custom data added by the custom code for this component.
|
|
47268
48050
|
*
|
|
48051
|
+
* @property designMetadata: Design metadata of the component. This includes information about the component type definition needed by the page designer for design-time functionality.
|
|
48052
|
+
*
|
|
47269
48053
|
* @property regions: The regions (and their assigned components) for the component.
|
|
47270
48054
|
*
|
|
47271
48055
|
*/
|
|
47272
48056
|
type Component = {
|
|
47273
48057
|
id: string;
|
|
47274
48058
|
typeId: string;
|
|
48059
|
+
name?: string;
|
|
48060
|
+
fragment?: boolean;
|
|
48061
|
+
contentLinkUuid?: string;
|
|
47275
48062
|
data?: object;
|
|
48063
|
+
localized?: boolean;
|
|
48064
|
+
visible?: boolean;
|
|
47276
48065
|
custom?: object;
|
|
48066
|
+
designMetadata?: object;
|
|
47277
48067
|
regions?: Array<Region>;
|
|
47278
48068
|
} & {
|
|
47279
48069
|
[key: string]: any;
|
|
@@ -47454,6 +48244,24 @@ declare namespace ShopperExperienceModelTypes {
|
|
|
47454
48244
|
} & {
|
|
47455
48245
|
[key: string]: any;
|
|
47456
48246
|
};
|
|
48247
|
+
/**
|
|
48248
|
+
* @type DataBindingRequirement: A data binding requirement specifying a provider type and record identifier to resolve.
|
|
48249
|
+
*
|
|
48250
|
+
* @property type: The data provider type identifier.
|
|
48251
|
+
* - **Min Length:** 1
|
|
48252
|
+
* - **Max Length:** 256
|
|
48253
|
+
*
|
|
48254
|
+
* @property id: The record identifier to resolve from the data provider.
|
|
48255
|
+
* - **Min Length:** 1
|
|
48256
|
+
* - **Max Length:** 256
|
|
48257
|
+
*
|
|
48258
|
+
*/
|
|
48259
|
+
type DataBindingRequirement = {
|
|
48260
|
+
type: string;
|
|
48261
|
+
id: string;
|
|
48262
|
+
} & {
|
|
48263
|
+
[key: string]: any;
|
|
48264
|
+
};
|
|
47457
48265
|
/**
|
|
47458
48266
|
* @type ErrorResponse:
|
|
47459
48267
|
*
|
|
@@ -47513,6 +48321,12 @@ declare namespace ShopperExperienceModelTypes {
|
|
|
47513
48321
|
*
|
|
47514
48322
|
* @property custom: Any custom data added by the custom code for the page type.
|
|
47515
48323
|
*
|
|
48324
|
+
* @property visible: Whether the page is visible based on the current visiblity rules and context.
|
|
48325
|
+
*
|
|
48326
|
+
* @property localized: Whether the page has been localized with content in the current locale. If false, the page content will fallback to the default locale.
|
|
48327
|
+
*
|
|
48328
|
+
* @property designMetadata: Design metadata of the page. This includes information about the page type definition needed by the page designer for design-time functionality.
|
|
48329
|
+
*
|
|
47516
48330
|
* @property regions: The regions (and their assigned components) for the page.
|
|
47517
48331
|
*
|
|
47518
48332
|
*/
|
|
@@ -47527,6 +48341,9 @@ declare namespace ShopperExperienceModelTypes {
|
|
|
47527
48341
|
pageKeywords?: string;
|
|
47528
48342
|
data?: object;
|
|
47529
48343
|
custom?: object;
|
|
48344
|
+
visible?: boolean;
|
|
48345
|
+
localized?: boolean;
|
|
48346
|
+
designMetadata?: object;
|
|
47530
48347
|
regions?: Array<Region>;
|
|
47531
48348
|
} & {
|
|
47532
48349
|
[key: string]: any;
|
|
@@ -47559,6 +48376,52 @@ declare namespace ShopperExperienceModelTypes {
|
|
|
47559
48376
|
} & {
|
|
47560
48377
|
[key: string]: any;
|
|
47561
48378
|
};
|
|
48379
|
+
/**
|
|
48380
|
+
* @type QualifierResolveRequest: Request body for resolving customer group qualifications, campaign promotion eligibility, and data bindings. All fields are optional. An empty body is valid and returns an empty response.
|
|
48381
|
+
*
|
|
48382
|
+
* @property customerGroups: List of customer group identifiers to resolve qualification for.
|
|
48383
|
+
*
|
|
48384
|
+
* @property campaignQualifiers: List of campaign and promotion pairs to resolve qualification for.
|
|
48385
|
+
*
|
|
48386
|
+
* @property dataBindings: List of data binding requirements to resolve, each specifying a provider type and record identifier.
|
|
48387
|
+
*
|
|
48388
|
+
*/
|
|
48389
|
+
type QualifierResolveRequest = {
|
|
48390
|
+
customerGroups?: Array<string>;
|
|
48391
|
+
campaignQualifiers?: Array<CampaignQualifier>;
|
|
48392
|
+
dataBindings?: Array<DataBindingRequirement>;
|
|
48393
|
+
} & {
|
|
48394
|
+
[key: string]: any;
|
|
48395
|
+
};
|
|
48396
|
+
/**
|
|
48397
|
+
* @type QualifierResolveResponse: Response containing the resolved qualification results for customer groups, campaign qualifiers, and data bindings.
|
|
48398
|
+
*
|
|
48399
|
+
* @property customerGroups: Map of customer group identifiers to their qualification status. True if the user is qualified, false otherwise.
|
|
48400
|
+
*
|
|
48401
|
+
* @property campaignQualifiers: Map of campaign identifiers to a map of promotion identifiers and their qualification status. True if the user is applicable, false otherwise.
|
|
48402
|
+
*
|
|
48403
|
+
* @property dataBindings: Resolved data binding objects grouped by provider type, then by record identifier. Used by the expression resolver to evaluate attribute expressions.
|
|
48404
|
+
*
|
|
48405
|
+
*/
|
|
48406
|
+
type QualifierResolveResponse = {
|
|
48407
|
+
customerGroups?: {
|
|
48408
|
+
[key: string]: boolean;
|
|
48409
|
+
};
|
|
48410
|
+
campaignQualifiers?: {
|
|
48411
|
+
[key: string]: {
|
|
48412
|
+
[key: string]: boolean;
|
|
48413
|
+
};
|
|
48414
|
+
};
|
|
48415
|
+
dataBindings?: {
|
|
48416
|
+
[key: string]: {
|
|
48417
|
+
[key: string]: {
|
|
48418
|
+
[key: string]: any;
|
|
48419
|
+
};
|
|
48420
|
+
};
|
|
48421
|
+
};
|
|
48422
|
+
} & {
|
|
48423
|
+
[key: string]: any;
|
|
48424
|
+
};
|
|
47562
48425
|
/**
|
|
47563
48426
|
* @type ResultBase: Schema defining generic list result. Each response schema of a resource requiring a list response should extend this schema. Additionally it needs to be defined what data is returned.
|
|
47564
48427
|
*
|
|
@@ -47590,9 +48453,12 @@ declare namespace ShopperExperienceTypes {
|
|
|
47590
48453
|
type getPagePathParameters = ShopperExperienceApiTypes.getPagePathParameters;
|
|
47591
48454
|
type getPagesQueryParameters = ShopperExperienceApiTypes.getPagesQueryParameters;
|
|
47592
48455
|
type getPagesPathParameters = ShopperExperienceApiTypes.getPagesPathParameters;
|
|
48456
|
+
type resolveQualifiersQueryParameters = ShopperExperienceApiTypes.resolveQualifiersQueryParameters;
|
|
48457
|
+
type resolveQualifiersPathParameters = ShopperExperienceApiTypes.resolveQualifiersPathParameters;
|
|
47593
48458
|
type searchContentQueryParameters = ShopperExperienceApiTypes.searchContentQueryParameters;
|
|
47594
48459
|
type searchContentPathParameters = ShopperExperienceApiTypes.searchContentPathParameters;
|
|
47595
48460
|
// Model types
|
|
48461
|
+
type CampaignQualifier = ShopperExperienceModelTypes.CampaignQualifier;
|
|
47596
48462
|
type Component = ShopperExperienceModelTypes.Component;
|
|
47597
48463
|
type Content = ShopperExperienceModelTypes.Content;
|
|
47598
48464
|
type ContentFolder = ShopperExperienceModelTypes.ContentFolder;
|
|
@@ -47601,11 +48467,14 @@ declare namespace ShopperExperienceTypes {
|
|
|
47601
48467
|
type ContentSearchRefinement = ShopperExperienceModelTypes.ContentSearchRefinement;
|
|
47602
48468
|
type ContentSearchRefinementValue = ShopperExperienceModelTypes.ContentSearchRefinementValue;
|
|
47603
48469
|
type ContentSearchResult = ShopperExperienceModelTypes.ContentSearchResult;
|
|
48470
|
+
type DataBindingRequirement = ShopperExperienceModelTypes.DataBindingRequirement;
|
|
47604
48471
|
type ErrorResponse = ShopperExperienceModelTypes.ErrorResponse;
|
|
47605
48472
|
type LocaleCode = ShopperExperienceModelTypes.LocaleCode;
|
|
47606
48473
|
type Page = ShopperExperienceModelTypes.Page;
|
|
47607
48474
|
type PageResult = ShopperExperienceModelTypes.PageResult;
|
|
47608
48475
|
type PaginatedResultBase = ShopperExperienceModelTypes.PaginatedResultBase;
|
|
48476
|
+
type QualifierResolveRequest = ShopperExperienceModelTypes.QualifierResolveRequest;
|
|
48477
|
+
type QualifierResolveResponse = ShopperExperienceModelTypes.QualifierResolveResponse;
|
|
47609
48478
|
type Region = ShopperExperienceModelTypes.Region;
|
|
47610
48479
|
type ResultBase = ShopperExperienceModelTypes.ResultBase;
|
|
47611
48480
|
}
|
|
@@ -47897,6 +48766,7 @@ declare namespace ShopperGiftCertificatesApiTypes {
|
|
|
47897
48766
|
[key: string]: string;
|
|
47898
48767
|
}) => Required<FetchOptions>["body"];
|
|
47899
48768
|
throwOnBadResponse?: boolean;
|
|
48769
|
+
throwOnMaintenanceHeader?: boolean;
|
|
47900
48770
|
}
|
|
47901
48771
|
/**
|
|
47902
48772
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -47912,6 +48782,7 @@ declare namespace ShopperGiftCertificatesApiTypes {
|
|
|
47912
48782
|
fetch?: FetchFunction;
|
|
47913
48783
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
47914
48784
|
throwOnBadResponse: boolean;
|
|
48785
|
+
throwOnMaintenanceHeader: boolean;
|
|
47915
48786
|
constructor(config: ClientConfigInit<Params>);
|
|
47916
48787
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
47917
48788
|
}
|
|
@@ -50752,6 +51623,7 @@ declare namespace ShopperOrdersApiTypes {
|
|
|
50752
51623
|
[key: string]: string;
|
|
50753
51624
|
}) => Required<FetchOptions>["body"];
|
|
50754
51625
|
throwOnBadResponse?: boolean;
|
|
51626
|
+
throwOnMaintenanceHeader?: boolean;
|
|
50755
51627
|
}
|
|
50756
51628
|
/**
|
|
50757
51629
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -50767,6 +51639,7 @@ declare namespace ShopperOrdersApiTypes {
|
|
|
50767
51639
|
fetch?: FetchFunction;
|
|
50768
51640
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
50769
51641
|
throwOnBadResponse: boolean;
|
|
51642
|
+
throwOnMaintenanceHeader: boolean;
|
|
50770
51643
|
constructor(config: ClientConfigInit<Params>);
|
|
50771
51644
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
50772
51645
|
}
|
|
@@ -55328,6 +56201,7 @@ declare namespace ShopperPaymentsApiTypes {
|
|
|
55328
56201
|
[key: string]: string;
|
|
55329
56202
|
}) => Required<FetchOptions>["body"];
|
|
55330
56203
|
throwOnBadResponse?: boolean;
|
|
56204
|
+
throwOnMaintenanceHeader?: boolean;
|
|
55331
56205
|
}
|
|
55332
56206
|
/**
|
|
55333
56207
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -55343,6 +56217,7 @@ declare namespace ShopperPaymentsApiTypes {
|
|
|
55343
56217
|
fetch?: FetchFunction;
|
|
55344
56218
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
55345
56219
|
throwOnBadResponse: boolean;
|
|
56220
|
+
throwOnMaintenanceHeader: boolean;
|
|
55346
56221
|
constructor(config: ClientConfigInit<Params>);
|
|
55347
56222
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
55348
56223
|
}
|
|
@@ -57094,6 +57969,7 @@ declare namespace ShopperProductsApiTypes {
|
|
|
57094
57969
|
[key: string]: string;
|
|
57095
57970
|
}) => Required<FetchOptions>["body"];
|
|
57096
57971
|
throwOnBadResponse?: boolean;
|
|
57972
|
+
throwOnMaintenanceHeader?: boolean;
|
|
57097
57973
|
}
|
|
57098
57974
|
/**
|
|
57099
57975
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -57109,6 +57985,7 @@ declare namespace ShopperProductsApiTypes {
|
|
|
57109
57985
|
fetch?: FetchFunction;
|
|
57110
57986
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
57111
57987
|
throwOnBadResponse: boolean;
|
|
57988
|
+
throwOnMaintenanceHeader: boolean;
|
|
57112
57989
|
constructor(config: ClientConfigInit<Params>);
|
|
57113
57990
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
57114
57991
|
}
|
|
@@ -59584,6 +60461,7 @@ declare namespace ShopperPromotionsApiTypes {
|
|
|
59584
60461
|
[key: string]: string;
|
|
59585
60462
|
}) => Required<FetchOptions>["body"];
|
|
59586
60463
|
throwOnBadResponse?: boolean;
|
|
60464
|
+
throwOnMaintenanceHeader?: boolean;
|
|
59587
60465
|
}
|
|
59588
60466
|
/**
|
|
59589
60467
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -59599,6 +60477,7 @@ declare namespace ShopperPromotionsApiTypes {
|
|
|
59599
60477
|
fetch?: FetchFunction;
|
|
59600
60478
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
59601
60479
|
throwOnBadResponse: boolean;
|
|
60480
|
+
throwOnMaintenanceHeader: boolean;
|
|
59602
60481
|
constructor(config: ClientConfigInit<Params>);
|
|
59603
60482
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
59604
60483
|
}
|
|
@@ -61306,6 +62185,7 @@ declare namespace ShopperSearchApiTypes {
|
|
|
61306
62185
|
[key: string]: string;
|
|
61307
62186
|
}) => Required<FetchOptions>["body"];
|
|
61308
62187
|
throwOnBadResponse?: boolean;
|
|
62188
|
+
throwOnMaintenanceHeader?: boolean;
|
|
61309
62189
|
}
|
|
61310
62190
|
/**
|
|
61311
62191
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -61321,6 +62201,7 @@ declare namespace ShopperSearchApiTypes {
|
|
|
61321
62201
|
fetch?: FetchFunction;
|
|
61322
62202
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
61323
62203
|
throwOnBadResponse: boolean;
|
|
62204
|
+
throwOnMaintenanceHeader: boolean;
|
|
61324
62205
|
constructor(config: ClientConfigInit<Params>);
|
|
61325
62206
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
61326
62207
|
}
|
|
@@ -63661,6 +64542,7 @@ declare namespace ShopperSEOApiTypes {
|
|
|
63661
64542
|
[key: string]: string;
|
|
63662
64543
|
}) => Required<FetchOptions>["body"];
|
|
63663
64544
|
throwOnBadResponse?: boolean;
|
|
64545
|
+
throwOnMaintenanceHeader?: boolean;
|
|
63664
64546
|
}
|
|
63665
64547
|
/**
|
|
63666
64548
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -63676,6 +64558,7 @@ declare namespace ShopperSEOApiTypes {
|
|
|
63676
64558
|
fetch?: FetchFunction;
|
|
63677
64559
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
63678
64560
|
throwOnBadResponse: boolean;
|
|
64561
|
+
throwOnMaintenanceHeader: boolean;
|
|
63679
64562
|
constructor(config: ClientConfigInit<Params>);
|
|
63680
64563
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
63681
64564
|
}
|
|
@@ -64505,6 +65388,7 @@ declare namespace ShopperStoresApiTypes {
|
|
|
64505
65388
|
[key: string]: string;
|
|
64506
65389
|
}) => Required<FetchOptions>["body"];
|
|
64507
65390
|
throwOnBadResponse?: boolean;
|
|
65391
|
+
throwOnMaintenanceHeader?: boolean;
|
|
64508
65392
|
}
|
|
64509
65393
|
/**
|
|
64510
65394
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -64520,6 +65404,7 @@ declare namespace ShopperStoresApiTypes {
|
|
|
64520
65404
|
fetch?: FetchFunction;
|
|
64521
65405
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
64522
65406
|
throwOnBadResponse: boolean;
|
|
65407
|
+
throwOnMaintenanceHeader: boolean;
|
|
64523
65408
|
constructor(config: ClientConfigInit<Params>);
|
|
64524
65409
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
64525
65410
|
}
|
|
@@ -65215,6 +66100,33 @@ declare class TemplateURL extends URL {
|
|
|
65215
66100
|
*/
|
|
65216
66101
|
static renderTemplateUri(template: string, parameters?: PathParameters): string;
|
|
65217
66102
|
}
|
|
66103
|
+
/**
|
|
66104
|
+
* Extends the Error class with the the error being a combination of status code
|
|
66105
|
+
* and text retrieved from the response.
|
|
66106
|
+
*
|
|
66107
|
+
* @class ResponseError
|
|
66108
|
+
* @extends Error
|
|
66109
|
+
*/
|
|
66110
|
+
declare class ResponseError extends Error {
|
|
66111
|
+
response: Response;
|
|
66112
|
+
constructor(response: Response);
|
|
66113
|
+
}
|
|
66114
|
+
/**
|
|
66115
|
+
* Error thrown when the sfdc_maintenance header is detected in a response
|
|
66116
|
+
* and throwOnMaintenanceHeader is enabled in client configuration.
|
|
66117
|
+
*
|
|
66118
|
+
* @class MaintenanceError
|
|
66119
|
+
* @extends Error
|
|
66120
|
+
*/
|
|
66121
|
+
declare class MaintenanceError extends Error {
|
|
66122
|
+
readonly response: Response | import("node-fetch").Response;
|
|
66123
|
+
readonly maintenanceType: "system" | "site";
|
|
66124
|
+
readonly status = 503;
|
|
66125
|
+
constructor(response: Response | import("node-fetch").Response, maintenanceType: "system" | "site");
|
|
66126
|
+
}
|
|
66127
|
+
declare module MaintenanceErrorWrapper {
|
|
66128
|
+
export { MaintenanceError };
|
|
66129
|
+
}
|
|
65218
66130
|
declare namespace helpers {
|
|
65219
66131
|
/*
|
|
65220
66132
|
* Copyright (c) 2023, Salesforce, Inc.
|
|
@@ -65311,6 +66223,7 @@ declare namespace helpers {
|
|
|
65311
66223
|
[key: string]: string;
|
|
65312
66224
|
}) => Required<FetchOptions>["body"];
|
|
65313
66225
|
throwOnBadResponse?: boolean;
|
|
66226
|
+
throwOnMaintenanceHeader?: boolean;
|
|
65314
66227
|
}
|
|
65315
66228
|
/**
|
|
65316
66229
|
* Configuration parameters common to Commerce SDK clients
|
|
@@ -65326,6 +66239,7 @@ declare namespace helpers {
|
|
|
65326
66239
|
fetch?: FetchFunction;
|
|
65327
66240
|
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
65328
66241
|
throwOnBadResponse: boolean;
|
|
66242
|
+
throwOnMaintenanceHeader: boolean;
|
|
65329
66243
|
constructor(config: ClientConfigInit<Params>);
|
|
65330
66244
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
65331
66245
|
}
|
|
@@ -68216,6 +69130,7 @@ declare namespace helpers {
|
|
|
68216
69130
|
usid?: string;
|
|
68217
69131
|
dnt?: boolean;
|
|
68218
69132
|
};
|
|
69133
|
+
enableHttpOnlySessionCookies?: boolean;
|
|
68219
69134
|
}): Promise<TokenResponse>;
|
|
68220
69135
|
/**
|
|
68221
69136
|
* A single function to execute the ShopperLogin Private Client Guest Login as described in the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas-private-client.html).
|
|
@@ -68243,6 +69158,7 @@ declare namespace helpers {
|
|
|
68243
69158
|
credentials: {
|
|
68244
69159
|
clientSecret: string;
|
|
68245
69160
|
};
|
|
69161
|
+
enableHttpOnlySessionCookies?: boolean;
|
|
68246
69162
|
}): Promise<TokenResponse>;
|
|
68247
69163
|
/**
|
|
68248
69164
|
* A single function to execute the ShopperLogin Public Client Guest Login with proof key for code exchange flow as described in the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary).
|
|
@@ -68266,6 +69182,7 @@ declare namespace helpers {
|
|
|
68266
69182
|
usid?: string;
|
|
68267
69183
|
dnt?: boolean;
|
|
68268
69184
|
} & CustomQueryParameters;
|
|
69185
|
+
enableHttpOnlySessionCookies?: boolean;
|
|
68269
69186
|
}): Promise<TokenResponse>;
|
|
68270
69187
|
/**
|
|
68271
69188
|
* A single function to execute the ShopperLogin Public Client Registered User B2C Login with proof key for code exchange flow as described in the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary).
|
|
@@ -68301,6 +69218,7 @@ declare namespace helpers {
|
|
|
68301
69218
|
dnt?: boolean;
|
|
68302
69219
|
};
|
|
68303
69220
|
body?: CustomRequestBody;
|
|
69221
|
+
enableHttpOnlySessionCookies?: boolean;
|
|
68304
69222
|
}): Promise<TokenResponse>;
|
|
68305
69223
|
/** Function to send passwordless login token
|
|
68306
69224
|
* **Note** At the moment, passwordless is only supported on private client
|
|
@@ -68375,6 +69293,7 @@ declare namespace helpers {
|
|
|
68375
69293
|
pwdlessLoginToken: string;
|
|
68376
69294
|
dnt?: string;
|
|
68377
69295
|
};
|
|
69296
|
+
enableHttpOnlySessionCookies?: boolean;
|
|
68378
69297
|
}): Promise<TokenResponse>;
|
|
68379
69298
|
/**
|
|
68380
69299
|
* Exchange a refresh token for a new access token.
|
|
@@ -68401,6 +69320,7 @@ declare namespace helpers {
|
|
|
68401
69320
|
credentials?: {
|
|
68402
69321
|
clientSecret?: string;
|
|
68403
69322
|
};
|
|
69323
|
+
enableHttpOnlySessionCookies?: boolean;
|
|
68404
69324
|
}): Promise<TokenResponse>;
|
|
68405
69325
|
/**
|
|
68406
69326
|
* Logout a shopper. The shoppers access token and refresh token will be revoked and if the shopper authenticated with ECOM the OCAPI JWT will also be revoked.
|
|
@@ -68474,6 +69394,26 @@ declare namespace helpers {
|
|
|
68474
69394
|
clientConfig: ClientConfigInit<CustomParams>;
|
|
68475
69395
|
rawResponse?: boolean | undefined;
|
|
68476
69396
|
}) => Promise<Response | unknown>;
|
|
69397
|
+
/*
|
|
69398
|
+
* Copyright (c) 2025, salesforce.com, inc.
|
|
69399
|
+
* All rights reserved.
|
|
69400
|
+
* SPDX-License-Identifier: BSD-3-Clause
|
|
69401
|
+
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
69402
|
+
*/
|
|
69403
|
+
/**
|
|
69404
|
+
* Error thrown when the sfdc_maintenance header is detected in a response
|
|
69405
|
+
* and throwOnMaintenanceHeader is enabled in client configuration.
|
|
69406
|
+
*
|
|
69407
|
+
* @class MaintenanceError
|
|
69408
|
+
* @extends Error
|
|
69409
|
+
*/
|
|
69410
|
+
class MaintenanceError extends Error {
|
|
69411
|
+
readonly response: Response | import("node-fetch").Response;
|
|
69412
|
+
readonly maintenanceType: "system" | "site";
|
|
69413
|
+
readonly status = 503;
|
|
69414
|
+
constructor(response: Response | import("node-fetch").Response, maintenanceType: "system" | "site");
|
|
69415
|
+
}
|
|
69416
|
+
import __default = MaintenanceErrorWrapper.MaintenanceError;
|
|
68477
69417
|
/**
|
|
68478
69418
|
* A wrapper function around fetch designed for making requests using the SDK
|
|
68479
69419
|
* @param url - The url of the resource that you wish to fetch
|
|
@@ -68505,5 +69445,5 @@ declare namespace helpers {
|
|
|
68505
69445
|
*/
|
|
68506
69446
|
const encodeSCAPISpecialCharacters: (str: string) => string;
|
|
68507
69447
|
}
|
|
68508
|
-
export { ShopperLogin, ShopperBaskets, ShopperBasketsV2, ShopperConfigurations, ShopperConsents, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperOrders, ShopperPayments, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSEO, ShopperStores, ClientConfig, TemplateURL, helpers };
|
|
69448
|
+
export { ShopperLogin, ShopperBaskets, ShopperBasketsV2, ShopperConfigurations, ShopperConsents, ShopperContexts, ShopperCustomers, ShopperExperience, ShopperGiftCertificates, ShopperOrders, ShopperPayments, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSEO, ShopperStores, ClientConfig, TemplateURL, ResponseError, MaintenanceError, helpers };
|
|
68509
69449
|
export type { ShopperLoginTypes, ShopperBasketsTypes, ShopperBasketsV2Types, ShopperConfigurationsTypes, ShopperConsentsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperOrdersTypes, ShopperPaymentsTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ShopperSEOTypes, ShopperStoresTypes, ClientConfigInit, FetchFunction, FetchOptions };
|