commerce-sdk-isomorphic 5.1.0 → 5.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -32992,6 +32992,9 @@ type CustomerAddress = {
32992
32992
  * @property companyName: The customer\'s company name.
32993
32993
  * - **Max Length:** 256
32994
32994
  *
32995
+ * @property crmContactId: The customer\'s core contact ID.
32996
+ * - **Max Length:** 18
32997
+ *
32995
32998
  * @property creationDate: Returns the value of attribute \'creationDate\'.
32996
32999
  *
32997
33000
  * @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 +33074,7 @@ type Customer = {
33071
33074
  authType?: CustomerAuthTypeEnum;
33072
33075
  birthday?: string;
33073
33076
  companyName?: string;
33077
+ crmContactId?: string;
33074
33078
  creationDate?: string;
33075
33079
  currentPassword?: string;
33076
33080
  customerId?: string;
@@ -33836,6 +33840,54 @@ type PasswordChangeRequest = {
33836
33840
  } & {
33837
33841
  [key: string]: any;
33838
33842
  };
33843
+ /**
33844
+ * @type PaymentMethodReferenceSetupRequestGatewayProperties: Properties specific to the payment gateway
33845
+ *
33846
+ * @property stripe: # Stripe-specific properties.
33847
+ *
33848
+ * @property adyen: # Adyen-specific properties.
33849
+ *
33850
+ */
33851
+ type PaymentMethodReferenceSetupRequestGatewayProperties = {
33852
+ stripe?: {
33853
+ [key: string]: any;
33854
+ };
33855
+ adyen?: {
33856
+ [key: string]: any;
33857
+ };
33858
+ } & {
33859
+ [key: string]: any;
33860
+ };
33861
+ /**
33862
+ * @type PaymentMethodReferenceSetupRequest: Request to set up a new payment method reference.
33863
+ *
33864
+ * @property paymentMethodType: Payment Method Type
33865
+ * - **Max Length:** 256
33866
+ *
33867
+ * @property gatewayProperties:
33868
+ *
33869
+ */
33870
+ type PaymentMethodReferenceSetupRequest = {
33871
+ paymentMethodType?: string;
33872
+ gatewayProperties: PaymentMethodReferenceSetupRequestGatewayProperties;
33873
+ } & {
33874
+ [key: string]: any;
33875
+ };
33876
+ /**
33877
+ * @type PaymentMethodReferenceSetupResponse: Response from setting up a new payment method reference.
33878
+ *
33879
+ * @property paymentMethodReferenceSetupId: The provider-specific identifier for the payment method reference setup (e.g., Stripe Setup Intent ID, Adyen pspReference).
33880
+ * - **Max Length:** 256
33881
+ *
33882
+ * @property gatewayProperties:
33883
+ *
33884
+ */
33885
+ type PaymentMethodReferenceSetupResponse = {
33886
+ paymentMethodReferenceSetupId: string;
33887
+ gatewayProperties?: PaymentMethodReferenceSetupRequestGatewayProperties;
33888
+ } & {
33889
+ [key: string]: any;
33890
+ };
33839
33891
  /**
33840
33892
  * @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
33893
  *
@@ -34240,6 +34292,14 @@ type resetPasswordQueryParameters$0 = {
34240
34292
  type resetPasswordPathParameters$0 = {
34241
34293
  organizationId: string;
34242
34294
  };
34295
+ type setupCustomerPaymentMethodReferenceQueryParameters = {
34296
+ siteId: string;
34297
+ zoneId: string;
34298
+ };
34299
+ type setupCustomerPaymentMethodReferencePathParameters = {
34300
+ customerId: string;
34301
+ organizationId: string;
34302
+ };
34243
34303
  type updateCustomerQueryParameters = {
34244
34304
  siteId: string;
34245
34305
  };
@@ -34290,11 +34350,11 @@ type updateCustomerProductListItemPathParameters = {
34290
34350
  /**
34291
34351
  * All path parameters that are used by at least one ShopperCustomers method.
34292
34352
  */
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 & {}>;
34353
+ 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
34354
  /**
34295
34355
  * All query parameters that are used by at least one ShopperCustomers method.
34296
34356
  */
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 & {}>;
34357
+ 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
34358
  /**
34299
34359
  * All parameters that are used by ShopperCustomers.
34300
34360
  */
@@ -34415,6 +34475,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
34415
34475
  registerExternalProfile: string;
34416
34476
  removeCustomerAddress: string;
34417
34477
  resetPassword: string;
34478
+ setupCustomerPaymentMethodReference: string;
34418
34479
  updateCustomer: string;
34419
34480
  updateCustomerAddress: string;
34420
34481
  updateCustomerPassword: string;
@@ -34716,6 +34777,18 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
34716
34777
  "organizationId",
34717
34778
  "siteId"
34718
34779
  ];
34780
+ readonly setupCustomerPaymentMethodReference: readonly [
34781
+ "customerId",
34782
+ "organizationId",
34783
+ "siteId",
34784
+ "zoneId"
34785
+ ];
34786
+ readonly setupCustomerPaymentMethodReferenceRequired: readonly [
34787
+ "customerId",
34788
+ "organizationId",
34789
+ "siteId",
34790
+ "zoneId"
34791
+ ];
34719
34792
  readonly updateCustomer: readonly [
34720
34793
  "customerId",
34721
34794
  "organizationId",
@@ -35069,7 +35142,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
35069
35142
  };
35070
35143
  }>, rawResponse?: T): Promise<T extends true ? Response : void>;
35071
35144
  /**
35072
- * Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
35145
+ * 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
35146
  *
35074
35147
  * If you would like to get a raw Response object use the other deleteCustomerPaymentMethodReference function.
35075
35148
  *
@@ -35097,7 +35170,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
35097
35170
  };
35098
35171
  }>): Promise<void>;
35099
35172
  /**
35100
- * Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
35173
+ * 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
35174
  *
35102
35175
  * @param options - An object containing the options for this method.
35103
35176
  * @param options.parameters - An object containing the parameters for this method.
@@ -35403,7 +35476,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
35403
35476
  * @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
35477
  directly from Salesforce Order Management (SOM). The system returns the retrieved SOM order data, along with any orders not yet
35405
35478
  transferred to SOM. If your instance is not integrated with SOM, the `expand=som` command is disregarded.
35406
- * @param options.parameters.limit - Maximum records to retrieve per request, not to exceed 50. Defaults to 10.
35479
+ * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 10.
35407
35480
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
35408
35481
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
35409
35482
  *
@@ -35441,7 +35514,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
35441
35514
  * @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
35515
  directly from Salesforce Order Management (SOM). The system returns the retrieved SOM order data, along with any orders not yet
35443
35516
  transferred to SOM. If your instance is not integrated with SOM, the `expand=som` command is disregarded.
35444
- * @param options.parameters.limit - Maximum records to retrieve per request, not to exceed 50. Defaults to 10.
35517
+ * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 10.
35445
35518
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
35446
35519
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
35447
35520
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -36163,6 +36236,61 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
36163
36236
  };
36164
36237
  body: ResetPasswordRequest & CustomRequestBody;
36165
36238
  }>, rawResponse?: T): Promise<T extends true ? Response : void>;
36239
+ /**
36240
+ * Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
36241
+ *
36242
+ * If you would like to get a raw Response object use the other setupCustomerPaymentMethodReference function.
36243
+ *
36244
+ * @param options - An object containing the options for this method.
36245
+ * @param options.parameters - An object containing the parameters for this method.
36246
+ * @param options.parameters.customerId - The customer ID.
36247
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
36248
+ * @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.
36249
+ * @param options.parameters.zoneId - The zone identifier for the payment configuration.
36250
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
36251
+ * @param options.body - The data to send as the request body.
36252
+ *
36253
+ * @returns A promise of type PaymentMethodReferenceSetupResponse.
36254
+ */
36255
+ setupCustomerPaymentMethodReference(options: RequireParametersUnlessAllAreOptional<{
36256
+ parameters?: CompositeParameters<{
36257
+ customerId: string;
36258
+ organizationId: string;
36259
+ siteId: string;
36260
+ zoneId: string;
36261
+ } & QueryParameters, ConfigParameters>;
36262
+ headers?: {
36263
+ [key: string]: string;
36264
+ };
36265
+ body: PaymentMethodReferenceSetupRequest & CustomRequestBody;
36266
+ }>): Promise<PaymentMethodReferenceSetupResponse>;
36267
+ /**
36268
+ * Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
36269
+ *
36270
+ * @param options - An object containing the options for this method.
36271
+ * @param options.parameters - An object containing the parameters for this method.
36272
+ * @param options.parameters.customerId - The customer ID.
36273
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
36274
+ * @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.
36275
+ * @param options.parameters.zoneId - The zone identifier for the payment configuration.
36276
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
36277
+ * @param options.body - The data to send as the request body.
36278
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
36279
+ *
36280
+ * @returns A promise of type Response if rawResponse is true, a promise of type PaymentMethodReferenceSetupResponse otherwise.
36281
+ */
36282
+ setupCustomerPaymentMethodReference<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
36283
+ parameters?: CompositeParameters<{
36284
+ customerId: string;
36285
+ organizationId: string;
36286
+ siteId: string;
36287
+ zoneId: string;
36288
+ } & QueryParameters, ConfigParameters>;
36289
+ headers?: {
36290
+ [key: string]: string;
36291
+ };
36292
+ body: PaymentMethodReferenceSetupRequest & CustomRequestBody;
36293
+ }>, rawResponse?: T): Promise<T extends true ? Response : PaymentMethodReferenceSetupResponse>;
36166
36294
  /**
36167
36295
  *
36168
36296
  *
@@ -38386,6 +38514,9 @@ declare namespace ShopperCustomersApiTypes {
38386
38514
  * @property companyName: The customer\'s company name.
38387
38515
  * - **Max Length:** 256
38388
38516
  *
38517
+ * @property crmContactId: The customer\'s core contact ID.
38518
+ * - **Max Length:** 18
38519
+ *
38389
38520
  * @property creationDate: Returns the value of attribute \'creationDate\'.
38390
38521
  *
38391
38522
  * @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 +38596,7 @@ declare namespace ShopperCustomersApiTypes {
38465
38596
  authType?: CustomerAuthTypeEnum;
38466
38597
  birthday?: string;
38467
38598
  companyName?: string;
38599
+ crmContactId?: string;
38468
38600
  creationDate?: string;
38469
38601
  currentPassword?: string;
38470
38602
  customerId?: string;
@@ -39270,6 +39402,54 @@ declare namespace ShopperCustomersApiTypes {
39270
39402
  } & {
39271
39403
  [key: string]: any;
39272
39404
  };
39405
+ /**
39406
+ * @type PaymentMethodReferenceSetupRequestGatewayProperties: Properties specific to the payment gateway
39407
+ *
39408
+ * @property stripe: # Stripe-specific properties.
39409
+ *
39410
+ * @property adyen: # Adyen-specific properties.
39411
+ *
39412
+ */
39413
+ type PaymentMethodReferenceSetupRequestGatewayProperties = {
39414
+ stripe?: {
39415
+ [key: string]: any;
39416
+ };
39417
+ adyen?: {
39418
+ [key: string]: any;
39419
+ };
39420
+ } & {
39421
+ [key: string]: any;
39422
+ };
39423
+ /**
39424
+ * @type PaymentMethodReferenceSetupRequest: Request to set up a new payment method reference.
39425
+ *
39426
+ * @property paymentMethodType: Payment Method Type
39427
+ * - **Max Length:** 256
39428
+ *
39429
+ * @property gatewayProperties:
39430
+ *
39431
+ */
39432
+ type PaymentMethodReferenceSetupRequest = {
39433
+ paymentMethodType?: string;
39434
+ gatewayProperties: PaymentMethodReferenceSetupRequestGatewayProperties;
39435
+ } & {
39436
+ [key: string]: any;
39437
+ };
39438
+ /**
39439
+ * @type PaymentMethodReferenceSetupResponse: Response from setting up a new payment method reference.
39440
+ *
39441
+ * @property paymentMethodReferenceSetupId: The provider-specific identifier for the payment method reference setup (e.g., Stripe Setup Intent ID, Adyen pspReference).
39442
+ * - **Max Length:** 256
39443
+ *
39444
+ * @property gatewayProperties:
39445
+ *
39446
+ */
39447
+ type PaymentMethodReferenceSetupResponse = {
39448
+ paymentMethodReferenceSetupId: string;
39449
+ gatewayProperties?: PaymentMethodReferenceSetupRequestGatewayProperties;
39450
+ } & {
39451
+ [key: string]: any;
39452
+ };
39273
39453
  /**
39274
39454
  * @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
39455
  *
@@ -39688,6 +39868,14 @@ declare namespace ShopperCustomersApiTypes {
39688
39868
  type resetPasswordPathParameters = {
39689
39869
  organizationId: string;
39690
39870
  };
39871
+ type setupCustomerPaymentMethodReferenceQueryParameters = {
39872
+ siteId: string;
39873
+ zoneId: string;
39874
+ };
39875
+ type setupCustomerPaymentMethodReferencePathParameters = {
39876
+ customerId: string;
39877
+ organizationId: string;
39878
+ };
39691
39879
  type updateCustomerQueryParameters = {
39692
39880
  siteId: string;
39693
39881
  };
@@ -39738,11 +39926,11 @@ declare namespace ShopperCustomersApiTypes {
39738
39926
  /**
39739
39927
  * All path parameters that are used by at least one ShopperCustomers method.
39740
39928
  */
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 & {}>;
39929
+ 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
39930
  /**
39743
39931
  * All query parameters that are used by at least one ShopperCustomers method.
39744
39932
  */
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 & {}>;
39933
+ 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
39934
  /**
39747
39935
  * All parameters that are used by ShopperCustomers.
39748
39936
  */
@@ -39863,6 +40051,7 @@ declare namespace ShopperCustomersApiTypes {
39863
40051
  registerExternalProfile: string;
39864
40052
  removeCustomerAddress: string;
39865
40053
  resetPassword: string;
40054
+ setupCustomerPaymentMethodReference: string;
39866
40055
  updateCustomer: string;
39867
40056
  updateCustomerAddress: string;
39868
40057
  updateCustomerPassword: string;
@@ -40164,6 +40353,18 @@ declare namespace ShopperCustomersApiTypes {
40164
40353
  "organizationId",
40165
40354
  "siteId"
40166
40355
  ];
40356
+ readonly setupCustomerPaymentMethodReference: readonly [
40357
+ "customerId",
40358
+ "organizationId",
40359
+ "siteId",
40360
+ "zoneId"
40361
+ ];
40362
+ readonly setupCustomerPaymentMethodReferenceRequired: readonly [
40363
+ "customerId",
40364
+ "organizationId",
40365
+ "siteId",
40366
+ "zoneId"
40367
+ ];
40167
40368
  readonly updateCustomer: readonly [
40168
40369
  "customerId",
40169
40370
  "organizationId",
@@ -40517,7 +40718,7 @@ declare namespace ShopperCustomersApiTypes {
40517
40718
  };
40518
40719
  }>, rawResponse?: T): Promise<T extends true ? Response : void>;
40519
40720
  /**
40520
- * Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
40721
+ * 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
40722
  *
40522
40723
  * If you would like to get a raw Response object use the other deleteCustomerPaymentMethodReference function.
40523
40724
  *
@@ -40545,7 +40746,7 @@ declare namespace ShopperCustomersApiTypes {
40545
40746
  };
40546
40747
  }>): Promise<void>;
40547
40748
  /**
40548
- * Deletes a specific payment method reference from a customer's account using the payment method reference ID and account ID.
40749
+ * 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
40750
  *
40550
40751
  * @param options - An object containing the options for this method.
40551
40752
  * @param options.parameters - An object containing the parameters for this method.
@@ -40851,7 +41052,7 @@ declare namespace ShopperCustomersApiTypes {
40851
41052
  * @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
41053
  directly from Salesforce Order Management (SOM). The system returns the retrieved SOM order data, along with any orders not yet
40853
41054
  transferred to SOM. If your instance is not integrated with SOM, the `expand=som` command is disregarded.
40854
- * @param options.parameters.limit - Maximum records to retrieve per request, not to exceed 50. Defaults to 10.
41055
+ * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 10.
40855
41056
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
40856
41057
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
40857
41058
  *
@@ -40889,7 +41090,7 @@ declare namespace ShopperCustomersApiTypes {
40889
41090
  * @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
41091
  directly from Salesforce Order Management (SOM). The system returns the retrieved SOM order data, along with any orders not yet
40891
41092
  transferred to SOM. If your instance is not integrated with SOM, the `expand=som` command is disregarded.
40892
- * @param options.parameters.limit - Maximum records to retrieve per request, not to exceed 50. Defaults to 10.
41093
+ * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 50 (maximum). Defaults to 10.
40893
41094
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
40894
41095
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
40895
41096
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -41611,6 +41812,61 @@ declare namespace ShopperCustomersApiTypes {
41611
41812
  };
41612
41813
  body: ResetPasswordRequest & CustomRequestBody;
41613
41814
  }>, rawResponse?: T): Promise<T extends true ? Response : void>;
41815
+ /**
41816
+ * Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
41817
+ *
41818
+ * If you would like to get a raw Response object use the other setupCustomerPaymentMethodReference function.
41819
+ *
41820
+ * @param options - An object containing the options for this method.
41821
+ * @param options.parameters - An object containing the parameters for this method.
41822
+ * @param options.parameters.customerId - The customer ID.
41823
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
41824
+ * @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.
41825
+ * @param options.parameters.zoneId - The zone identifier for the payment configuration.
41826
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
41827
+ * @param options.body - The data to send as the request body.
41828
+ *
41829
+ * @returns A promise of type PaymentMethodReferenceSetupResponse.
41830
+ */
41831
+ setupCustomerPaymentMethodReference(options: RequireParametersUnlessAllAreOptional<{
41832
+ parameters?: CompositeParameters<{
41833
+ customerId: string;
41834
+ organizationId: string;
41835
+ siteId: string;
41836
+ zoneId: string;
41837
+ } & QueryParameters, ConfigParameters>;
41838
+ headers?: {
41839
+ [key: string]: string;
41840
+ };
41841
+ body: PaymentMethodReferenceSetupRequest & CustomRequestBody;
41842
+ }>): Promise<PaymentMethodReferenceSetupResponse>;
41843
+ /**
41844
+ * Initiates the setup of a new payment method reference for a customer. This endpoint requires Salesforce Payments integration.
41845
+ *
41846
+ * @param options - An object containing the options for this method.
41847
+ * @param options.parameters - An object containing the parameters for this method.
41848
+ * @param options.parameters.customerId - The customer ID.
41849
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
41850
+ * @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.
41851
+ * @param options.parameters.zoneId - The zone identifier for the payment configuration.
41852
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
41853
+ * @param options.body - The data to send as the request body.
41854
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
41855
+ *
41856
+ * @returns A promise of type Response if rawResponse is true, a promise of type PaymentMethodReferenceSetupResponse otherwise.
41857
+ */
41858
+ setupCustomerPaymentMethodReference<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
41859
+ parameters?: CompositeParameters<{
41860
+ customerId: string;
41861
+ organizationId: string;
41862
+ siteId: string;
41863
+ zoneId: string;
41864
+ } & QueryParameters, ConfigParameters>;
41865
+ headers?: {
41866
+ [key: string]: string;
41867
+ };
41868
+ body: PaymentMethodReferenceSetupRequest & CustomRequestBody;
41869
+ }>, rawResponse?: T): Promise<T extends true ? Response : PaymentMethodReferenceSetupResponse>;
41614
41870
  /**
41615
41871
  *
41616
41872
  *
@@ -43722,6 +43978,9 @@ declare namespace ShopperCustomersModelTypes {
43722
43978
  * @property companyName: The customer\'s company name.
43723
43979
  * - **Max Length:** 256
43724
43980
  *
43981
+ * @property crmContactId: The customer\'s core contact ID.
43982
+ * - **Max Length:** 18
43983
+ *
43725
43984
  * @property creationDate: Returns the value of attribute \'creationDate\'.
43726
43985
  *
43727
43986
  * @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 +44060,7 @@ declare namespace ShopperCustomersModelTypes {
43801
44060
  authType?: CustomerAuthTypeEnum;
43802
44061
  birthday?: string;
43803
44062
  companyName?: string;
44063
+ crmContactId?: string;
43804
44064
  creationDate?: string;
43805
44065
  currentPassword?: string;
43806
44066
  customerId?: string;
@@ -44606,6 +44866,54 @@ declare namespace ShopperCustomersModelTypes {
44606
44866
  } & {
44607
44867
  [key: string]: any;
44608
44868
  };
44869
+ /**
44870
+ * @type PaymentMethodReferenceSetupRequestGatewayProperties: Properties specific to the payment gateway
44871
+ *
44872
+ * @property stripe: # Stripe-specific properties.
44873
+ *
44874
+ * @property adyen: # Adyen-specific properties.
44875
+ *
44876
+ */
44877
+ type PaymentMethodReferenceSetupRequestGatewayProperties = {
44878
+ stripe?: {
44879
+ [key: string]: any;
44880
+ };
44881
+ adyen?: {
44882
+ [key: string]: any;
44883
+ };
44884
+ } & {
44885
+ [key: string]: any;
44886
+ };
44887
+ /**
44888
+ * @type PaymentMethodReferenceSetupRequest: Request to set up a new payment method reference.
44889
+ *
44890
+ * @property paymentMethodType: Payment Method Type
44891
+ * - **Max Length:** 256
44892
+ *
44893
+ * @property gatewayProperties:
44894
+ *
44895
+ */
44896
+ type PaymentMethodReferenceSetupRequest = {
44897
+ paymentMethodType?: string;
44898
+ gatewayProperties: PaymentMethodReferenceSetupRequestGatewayProperties;
44899
+ } & {
44900
+ [key: string]: any;
44901
+ };
44902
+ /**
44903
+ * @type PaymentMethodReferenceSetupResponse: Response from setting up a new payment method reference.
44904
+ *
44905
+ * @property paymentMethodReferenceSetupId: The provider-specific identifier for the payment method reference setup (e.g., Stripe Setup Intent ID, Adyen pspReference).
44906
+ * - **Max Length:** 256
44907
+ *
44908
+ * @property gatewayProperties:
44909
+ *
44910
+ */
44911
+ type PaymentMethodReferenceSetupResponse = {
44912
+ paymentMethodReferenceSetupId: string;
44913
+ gatewayProperties?: PaymentMethodReferenceSetupRequestGatewayProperties;
44914
+ } & {
44915
+ [key: string]: any;
44916
+ };
44609
44917
  /**
44610
44918
  * @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
44919
  *
@@ -44877,6 +45185,8 @@ declare namespace ShopperCustomersTypes {
44877
45185
  type removeCustomerAddressPathParameters = ShopperCustomersApiTypes.removeCustomerAddressPathParameters;
44878
45186
  type resetPasswordQueryParameters = ShopperCustomersApiTypes.resetPasswordQueryParameters;
44879
45187
  type resetPasswordPathParameters = ShopperCustomersApiTypes.resetPasswordPathParameters;
45188
+ type setupCustomerPaymentMethodReferenceQueryParameters = ShopperCustomersApiTypes.setupCustomerPaymentMethodReferenceQueryParameters;
45189
+ type setupCustomerPaymentMethodReferencePathParameters = ShopperCustomersApiTypes.setupCustomerPaymentMethodReferencePathParameters;
44880
45190
  type updateCustomerQueryParameters = ShopperCustomersApiTypes.updateCustomerQueryParameters;
44881
45191
  type updateCustomerPathParameters = ShopperCustomersApiTypes.updateCustomerPathParameters;
44882
45192
  type updateCustomerAddressQueryParameters = ShopperCustomersApiTypes.updateCustomerAddressQueryParameters;
@@ -44958,6 +45268,9 @@ declare namespace ShopperCustomersTypes {
44958
45268
  type PasswordChangeRequest = ShopperCustomersModelTypes.PasswordChangeRequest;
44959
45269
  type PaymentBankAccountRequest = ShopperCustomersModelTypes.PaymentBankAccountRequest;
44960
45270
  type PaymentCard = ShopperCustomersModelTypes.PaymentCard;
45271
+ type PaymentMethodReferenceSetupRequest = ShopperCustomersModelTypes.PaymentMethodReferenceSetupRequest;
45272
+ type PaymentMethodReferenceSetupRequestGatewayProperties = ShopperCustomersModelTypes.PaymentMethodReferenceSetupRequestGatewayProperties;
45273
+ type PaymentMethodReferenceSetupResponse = ShopperCustomersModelTypes.PaymentMethodReferenceSetupResponse;
44961
45274
  type PriceAdjustment = ShopperCustomersModelTypes.PriceAdjustment;
44962
45275
  type PriceRange = ShopperCustomersModelTypes.PriceRange;
44963
45276
  type Product = ShopperCustomersModelTypes.Product;
@@ -45000,6 +45313,24 @@ declare namespace ShopperCustomersTypes {
45000
45313
  type VariationAttributeValue = ShopperCustomersModelTypes.VariationAttributeValue;
45001
45314
  type VariationGroup = ShopperCustomersModelTypes.VariationGroup;
45002
45315
  }
45316
+ /**
45317
+ * @type CampaignQualifier: A campaign and promotion pair to resolve qualification for.
45318
+ *
45319
+ * @property campaignId: The identifier of the campaign.
45320
+ * - **Min Length:** 1
45321
+ * - **Max Length:** 256
45322
+ *
45323
+ * @property promotionId: The identifier of the promotion within the campaign.
45324
+ * - **Min Length:** 1
45325
+ * - **Max Length:** 256
45326
+ *
45327
+ */
45328
+ type CampaignQualifier = {
45329
+ campaignId: string;
45330
+ promotionId: string;
45331
+ } & {
45332
+ [key: string]: any;
45333
+ };
45003
45334
  /**
45004
45335
  * @type Region:
45005
45336
  *
@@ -45024,18 +45355,38 @@ type Region = {
45024
45355
  * @property typeId: Component type identifier.
45025
45356
  * - **Max Length:** 256
45026
45357
  *
45358
+ * @property name: Display name of the component.
45359
+ * - **Max Length:** 256
45360
+ *
45361
+ * @property fragment: Indicates whether the component is a fragment. True if the component is a fragment, otherwise false.
45362
+ *
45363
+ * @property contentLinkUuid: Represents a globally unique identifier for every instance of a content component (or fragment) rendered on a page.
45364
+ * - **Max Length:** 256
45365
+ *
45027
45366
  * @property data: The configuration data assigned to the component.
45028
45367
  *
45368
+ * @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.
45369
+ *
45370
+ * @property visible: Whether the component is visible based on the current visiblity rules and context.
45371
+ *
45029
45372
  * @property custom: Any custom data added by the custom code for this component.
45030
45373
  *
45374
+ * @property designMetadata: Design metadata of the component. This includes information about the component type definition needed by the page designer for design-time functionality.
45375
+ *
45031
45376
  * @property regions: The regions (and their assigned components) for the component.
45032
45377
  *
45033
45378
  */
45034
45379
  type Component = {
45035
45380
  id: string;
45036
45381
  typeId: string;
45382
+ name?: string;
45383
+ fragment?: boolean;
45384
+ contentLinkUuid?: string;
45037
45385
  data?: object;
45386
+ localized?: boolean;
45387
+ visible?: boolean;
45038
45388
  custom?: object;
45389
+ designMetadata?: object;
45039
45390
  regions?: Array<Region>;
45040
45391
  } & {
45041
45392
  [key: string]: any;
@@ -45216,6 +45567,24 @@ type ContentSearchResult = {
45216
45567
  } & {
45217
45568
  [key: string]: any;
45218
45569
  };
45570
+ /**
45571
+ * @type DataBindingRequirement: A data binding requirement specifying a provider type and record identifier to resolve.
45572
+ *
45573
+ * @property type: The data provider type identifier.
45574
+ * - **Min Length:** 1
45575
+ * - **Max Length:** 256
45576
+ *
45577
+ * @property id: The record identifier to resolve from the data provider.
45578
+ * - **Min Length:** 1
45579
+ * - **Max Length:** 256
45580
+ *
45581
+ */
45582
+ type DataBindingRequirement = {
45583
+ type: string;
45584
+ id: string;
45585
+ } & {
45586
+ [key: string]: any;
45587
+ };
45219
45588
  /**
45220
45589
  * @type LocaleCode
45221
45590
  * 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 +45621,12 @@ type LocaleCode$3 = string;
45252
45621
  *
45253
45622
  * @property custom: Any custom data added by the custom code for the page type.
45254
45623
  *
45624
+ * @property visible: Whether the page is visible based on the current visiblity rules and context.
45625
+ *
45626
+ * @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.
45627
+ *
45628
+ * @property designMetadata: Design metadata of the page. This includes information about the page type definition needed by the page designer for design-time functionality.
45629
+ *
45255
45630
  * @property regions: The regions (and their assigned components) for the page.
45256
45631
  *
45257
45632
  */
@@ -45266,6 +45641,9 @@ type Page = {
45266
45641
  pageKeywords?: string;
45267
45642
  data?: object;
45268
45643
  custom?: object;
45644
+ visible?: boolean;
45645
+ localized?: boolean;
45646
+ designMetadata?: object;
45269
45647
  regions?: Array<Region>;
45270
45648
  } & {
45271
45649
  [key: string]: any;
@@ -45281,6 +45659,52 @@ type PageResult = {
45281
45659
  } & {
45282
45660
  [key: string]: any;
45283
45661
  };
45662
+ /**
45663
+ * @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.
45664
+ *
45665
+ * @property customerGroups: List of customer group identifiers to resolve qualification for.
45666
+ *
45667
+ * @property campaignQualifiers: List of campaign and promotion pairs to resolve qualification for.
45668
+ *
45669
+ * @property dataBindings: List of data binding requirements to resolve, each specifying a provider type and record identifier.
45670
+ *
45671
+ */
45672
+ type QualifierResolveRequest = {
45673
+ customerGroups?: Array<string>;
45674
+ campaignQualifiers?: Array<CampaignQualifier>;
45675
+ dataBindings?: Array<DataBindingRequirement>;
45676
+ } & {
45677
+ [key: string]: any;
45678
+ };
45679
+ /**
45680
+ * @type QualifierResolveResponse: Response containing the resolved qualification results for customer groups, campaign qualifiers, and data bindings.
45681
+ *
45682
+ * @property customerGroups: Map of customer group identifiers to their qualification status. True if the user is qualified, false otherwise.
45683
+ *
45684
+ * @property campaignQualifiers: Map of campaign identifiers to a map of promotion identifiers and their qualification status. True if the user is applicable, false otherwise.
45685
+ *
45686
+ * @property dataBindings: Resolved data binding objects grouped by provider type, then by record identifier. Used by the expression resolver to evaluate attribute expressions.
45687
+ *
45688
+ */
45689
+ type QualifierResolveResponse = {
45690
+ customerGroups?: {
45691
+ [key: string]: boolean;
45692
+ };
45693
+ campaignQualifiers?: {
45694
+ [key: string]: {
45695
+ [key: string]: boolean;
45696
+ };
45697
+ };
45698
+ dataBindings?: {
45699
+ [key: string]: {
45700
+ [key: string]: {
45701
+ [key: string]: any;
45702
+ };
45703
+ };
45704
+ };
45705
+ } & {
45706
+ [key: string]: any;
45707
+ };
45284
45708
  type getContentQueryParameters = {
45285
45709
  siteId: string;
45286
45710
  locale?: LocaleCode$3;
@@ -45337,6 +45761,13 @@ type getPagesQueryParameters = {
45337
45761
  type getPagesPathParameters = {
45338
45762
  organizationId: string;
45339
45763
  };
45764
+ type resolveQualifiersQueryParameters = {
45765
+ siteId: string;
45766
+ locale?: LocaleCode$3;
45767
+ };
45768
+ type resolveQualifiersPathParameters = {
45769
+ organizationId: string;
45770
+ };
45340
45771
  type searchContentQueryParameters = {
45341
45772
  q?: string;
45342
45773
  refine?: string;
@@ -45352,11 +45783,11 @@ type searchContentPathParameters = {
45352
45783
  /**
45353
45784
  * All path parameters that are used by at least one ShopperExperience method.
45354
45785
  */
45355
- type ShopperExperiencePathParameters = Partial<getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & searchContentPathParameters & {}>;
45786
+ type ShopperExperiencePathParameters = Partial<getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & resolveQualifiersPathParameters & searchContentPathParameters & {}>;
45356
45787
  /**
45357
45788
  * All query parameters that are used by at least one ShopperExperience method.
45358
45789
  */
45359
- type ShopperExperienceQueryParameters = Partial<getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & searchContentQueryParameters & {}>;
45790
+ type ShopperExperienceQueryParameters = Partial<getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & resolveQualifiersQueryParameters & searchContentQueryParameters & {}>;
45360
45791
  /**
45361
45792
  * All parameters that are used by ShopperExperience.
45362
45793
  */
@@ -45368,7 +45799,7 @@ type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriPara
45368
45799
  * *[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/shopper-experience/shopper-experience-oas-v1-public.yaml)
45369
45800
 
45370
45801
  # API Overview
45371
- Use the Shopper Experience API to look up page information for pages that are created in Page Designer, content assets and to access content folders.
45802
+ 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
45803
 
45373
45804
  ## Authentication & Authorization
45374
45805
 
@@ -45392,12 +45823,27 @@ type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriPara
45392
45823
 
45393
45824
  Only content folders that are marked as online are returned in the API responses.
45394
45825
 
45826
+ ### Search Content Assets
45827
+ Search for content assets using keywords and refinement filters. The search functionality supports:
45828
+
45829
+ - Keyword-based search across content assets
45830
+ - Refinement attributes to filter results, for example, by folder or content type
45831
+ - Sorting by configurable attributes
45832
+ - Pagination for large result sets (up to 200 items per page)
45833
+
45834
+ Only content assets that are online and assigned to a folder are included in search results.
45835
+
45836
+ ### Batch Retrieval
45837
+ Retrieve multiple content assets or content folders in a single API request for improved performance (up to 50 content assets or folders at once).
45838
+
45395
45839
  ## Page Responses
45396
45840
  Responses for pages include the following:
45397
45841
 
45398
45842
  - The entire component hierarchy of the page at design time.
45399
45843
  - All merchant data provided at design time.
45400
45844
  - Server-side scripting data provided at run time.
45845
+ - Tracking for each rendered component or fragment using a globally unique content link UUID.
45846
+ - Support for reusable component fragments that can be shared across multiple pages.
45401
45847
 
45402
45848
  Both the page and components contain the values of all native and custom attributes that have been populated during page authoring.
45403
45849
 
@@ -45451,6 +45897,7 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
45451
45897
  getMultipleContent: string;
45452
45898
  getPage: string;
45453
45899
  getPages: string;
45900
+ resolveQualifiers: string;
45454
45901
  searchContent: string;
45455
45902
  };
45456
45903
  constructor(config: ClientConfigInit<ConfigParameters>);
@@ -45529,6 +45976,15 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
45529
45976
  "aspectTypeId",
45530
45977
  "siteId"
45531
45978
  ];
45979
+ readonly resolveQualifiers: readonly [
45980
+ "organizationId",
45981
+ "siteId",
45982
+ "locale"
45983
+ ];
45984
+ readonly resolveQualifiersRequired: readonly [
45985
+ "organizationId",
45986
+ "siteId"
45987
+ ];
45532
45988
  readonly searchContent: readonly [
45533
45989
  "organizationId",
45534
45990
  "siteId",
@@ -45938,6 +46394,73 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
45938
46394
  [key: string]: string;
45939
46395
  };
45940
46396
  }>, rawResponse?: T): Promise<T extends true ? Response : PageResult>;
46397
+ /**
46398
+ * Resolves a list of customer groups, campaigns, promotions, and data bindings for the given user.
46399
+
46400
+ The endpoint takes each value and determines whether the user is active for the item:
46401
+ - Customer groups are verified against the user's qualification via the EffectiveContext.
46402
+ - Campaign qualifiers are checked to determine if the user is applicable for each campaign and promotion.
46403
+ - Data bindings are resolved by fetching the requested records from their respective data providers.
46404
+
46405
+ 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.
46406
+
46407
+ *
46408
+ * If you would like to get a raw Response object use the other resolveQualifiers function.
46409
+ *
46410
+ * @param options - An object containing the options for this method.
46411
+ * @param options.parameters - An object containing the parameters for this method.
46412
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
46413
+ * @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.
46414
+ * @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.
46415
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
46416
+ * @param options.body - The data to send as the request body.
46417
+ *
46418
+ * @returns A promise of type QualifierResolveResponse.
46419
+ */
46420
+ resolveQualifiers(options: RequireParametersUnlessAllAreOptional<{
46421
+ parameters?: CompositeParameters<{
46422
+ organizationId: string;
46423
+ siteId: string;
46424
+ locale?: LocaleCode$3;
46425
+ } & QueryParameters, ConfigParameters>;
46426
+ headers?: {
46427
+ [key: string]: string;
46428
+ };
46429
+ body: QualifierResolveRequest & CustomRequestBody;
46430
+ }>): Promise<QualifierResolveResponse>;
46431
+ /**
46432
+ * Resolves a list of customer groups, campaigns, promotions, and data bindings for the given user.
46433
+
46434
+ The endpoint takes each value and determines whether the user is active for the item:
46435
+ - Customer groups are verified against the user's qualification via the EffectiveContext.
46436
+ - Campaign qualifiers are checked to determine if the user is applicable for each campaign and promotion.
46437
+ - Data bindings are resolved by fetching the requested records from their respective data providers.
46438
+
46439
+ 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.
46440
+
46441
+ *
46442
+ * @param options - An object containing the options for this method.
46443
+ * @param options.parameters - An object containing the parameters for this method.
46444
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
46445
+ * @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.
46446
+ * @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.
46447
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
46448
+ * @param options.body - The data to send as the request body.
46449
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
46450
+ *
46451
+ * @returns A promise of type Response if rawResponse is true, a promise of type QualifierResolveResponse otherwise.
46452
+ */
46453
+ resolveQualifiers<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
46454
+ parameters?: CompositeParameters<{
46455
+ organizationId: string;
46456
+ siteId: string;
46457
+ locale?: LocaleCode$3;
46458
+ } & QueryParameters, ConfigParameters>;
46459
+ headers?: {
46460
+ [key: string]: string;
46461
+ };
46462
+ body: QualifierResolveRequest & CustomRequestBody;
46463
+ }>, rawResponse?: T): Promise<T extends true ? Response : QualifierResolveResponse>;
45941
46464
  /**
45942
46465
  * Provides keyword and refinement search functionality for content assets. The search result contains only content
45943
46466
  that is online and assigned to a folder.
@@ -45965,7 +46488,7 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
45965
46488
 
45966
46489
  Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes.
45967
46490
  * @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 - Maximum records to retrieve per request, not to exceed 200. Defaults to 50.
46491
+ * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
45969
46492
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
45970
46493
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
45971
46494
  *
@@ -46011,7 +46534,7 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
46011
46534
 
46012
46535
  Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes.
46013
46536
  * @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 - Maximum records to retrieve per request, not to exceed 200. Defaults to 50.
46537
+ * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
46015
46538
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
46016
46539
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
46017
46540
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -46148,6 +46671,24 @@ declare namespace ShopperExperienceApiTypes {
46148
46671
  constructor(config: ClientConfigInit<Params>);
46149
46672
  static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
46150
46673
  }
46674
+ /**
46675
+ * @type CampaignQualifier: A campaign and promotion pair to resolve qualification for.
46676
+ *
46677
+ * @property campaignId: The identifier of the campaign.
46678
+ * - **Min Length:** 1
46679
+ * - **Max Length:** 256
46680
+ *
46681
+ * @property promotionId: The identifier of the promotion within the campaign.
46682
+ * - **Min Length:** 1
46683
+ * - **Max Length:** 256
46684
+ *
46685
+ */
46686
+ type CampaignQualifier = {
46687
+ campaignId: string;
46688
+ promotionId: string;
46689
+ } & {
46690
+ [key: string]: any;
46691
+ };
46151
46692
  /**
46152
46693
  * @type Region:
46153
46694
  *
@@ -46172,18 +46713,38 @@ declare namespace ShopperExperienceApiTypes {
46172
46713
  * @property typeId: Component type identifier.
46173
46714
  * - **Max Length:** 256
46174
46715
  *
46716
+ * @property name: Display name of the component.
46717
+ * - **Max Length:** 256
46718
+ *
46719
+ * @property fragment: Indicates whether the component is a fragment. True if the component is a fragment, otherwise false.
46720
+ *
46721
+ * @property contentLinkUuid: Represents a globally unique identifier for every instance of a content component (or fragment) rendered on a page.
46722
+ * - **Max Length:** 256
46723
+ *
46175
46724
  * @property data: The configuration data assigned to the component.
46176
46725
  *
46726
+ * @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.
46727
+ *
46728
+ * @property visible: Whether the component is visible based on the current visiblity rules and context.
46729
+ *
46177
46730
  * @property custom: Any custom data added by the custom code for this component.
46178
46731
  *
46732
+ * @property designMetadata: Design metadata of the component. This includes information about the component type definition needed by the page designer for design-time functionality.
46733
+ *
46179
46734
  * @property regions: The regions (and their assigned components) for the component.
46180
46735
  *
46181
46736
  */
46182
46737
  type Component = {
46183
46738
  id: string;
46184
46739
  typeId: string;
46740
+ name?: string;
46741
+ fragment?: boolean;
46742
+ contentLinkUuid?: string;
46185
46743
  data?: object;
46744
+ localized?: boolean;
46745
+ visible?: boolean;
46186
46746
  custom?: object;
46747
+ designMetadata?: object;
46187
46748
  regions?: Array<Region>;
46188
46749
  } & {
46189
46750
  [key: string]: any;
@@ -46364,6 +46925,24 @@ declare namespace ShopperExperienceApiTypes {
46364
46925
  } & {
46365
46926
  [key: string]: any;
46366
46927
  };
46928
+ /**
46929
+ * @type DataBindingRequirement: A data binding requirement specifying a provider type and record identifier to resolve.
46930
+ *
46931
+ * @property type: The data provider type identifier.
46932
+ * - **Min Length:** 1
46933
+ * - **Max Length:** 256
46934
+ *
46935
+ * @property id: The record identifier to resolve from the data provider.
46936
+ * - **Min Length:** 1
46937
+ * - **Max Length:** 256
46938
+ *
46939
+ */
46940
+ type DataBindingRequirement = {
46941
+ type: string;
46942
+ id: string;
46943
+ } & {
46944
+ [key: string]: any;
46945
+ };
46367
46946
  /**
46368
46947
  * @type ErrorResponse:
46369
46948
  *
@@ -46423,6 +47002,12 @@ declare namespace ShopperExperienceApiTypes {
46423
47002
  *
46424
47003
  * @property custom: Any custom data added by the custom code for the page type.
46425
47004
  *
47005
+ * @property visible: Whether the page is visible based on the current visiblity rules and context.
47006
+ *
47007
+ * @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.
47008
+ *
47009
+ * @property designMetadata: Design metadata of the page. This includes information about the page type definition needed by the page designer for design-time functionality.
47010
+ *
46426
47011
  * @property regions: The regions (and their assigned components) for the page.
46427
47012
  *
46428
47013
  */
@@ -46437,6 +47022,9 @@ declare namespace ShopperExperienceApiTypes {
46437
47022
  pageKeywords?: string;
46438
47023
  data?: object;
46439
47024
  custom?: object;
47025
+ visible?: boolean;
47026
+ localized?: boolean;
47027
+ designMetadata?: object;
46440
47028
  regions?: Array<Region>;
46441
47029
  } & {
46442
47030
  [key: string]: any;
@@ -46469,6 +47057,52 @@ declare namespace ShopperExperienceApiTypes {
46469
47057
  } & {
46470
47058
  [key: string]: any;
46471
47059
  };
47060
+ /**
47061
+ * @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.
47062
+ *
47063
+ * @property customerGroups: List of customer group identifiers to resolve qualification for.
47064
+ *
47065
+ * @property campaignQualifiers: List of campaign and promotion pairs to resolve qualification for.
47066
+ *
47067
+ * @property dataBindings: List of data binding requirements to resolve, each specifying a provider type and record identifier.
47068
+ *
47069
+ */
47070
+ type QualifierResolveRequest = {
47071
+ customerGroups?: Array<string>;
47072
+ campaignQualifiers?: Array<CampaignQualifier>;
47073
+ dataBindings?: Array<DataBindingRequirement>;
47074
+ } & {
47075
+ [key: string]: any;
47076
+ };
47077
+ /**
47078
+ * @type QualifierResolveResponse: Response containing the resolved qualification results for customer groups, campaign qualifiers, and data bindings.
47079
+ *
47080
+ * @property customerGroups: Map of customer group identifiers to their qualification status. True if the user is qualified, false otherwise.
47081
+ *
47082
+ * @property campaignQualifiers: Map of campaign identifiers to a map of promotion identifiers and their qualification status. True if the user is applicable, false otherwise.
47083
+ *
47084
+ * @property dataBindings: Resolved data binding objects grouped by provider type, then by record identifier. Used by the expression resolver to evaluate attribute expressions.
47085
+ *
47086
+ */
47087
+ type QualifierResolveResponse = {
47088
+ customerGroups?: {
47089
+ [key: string]: boolean;
47090
+ };
47091
+ campaignQualifiers?: {
47092
+ [key: string]: {
47093
+ [key: string]: boolean;
47094
+ };
47095
+ };
47096
+ dataBindings?: {
47097
+ [key: string]: {
47098
+ [key: string]: {
47099
+ [key: string]: any;
47100
+ };
47101
+ };
47102
+ };
47103
+ } & {
47104
+ [key: string]: any;
47105
+ };
46472
47106
  /**
46473
47107
  * @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
47108
  *
@@ -46539,6 +47173,13 @@ declare namespace ShopperExperienceApiTypes {
46539
47173
  type getPagesPathParameters = {
46540
47174
  organizationId: string;
46541
47175
  };
47176
+ type resolveQualifiersQueryParameters = {
47177
+ siteId: string;
47178
+ locale?: LocaleCode$0;
47179
+ };
47180
+ type resolveQualifiersPathParameters = {
47181
+ organizationId: string;
47182
+ };
46542
47183
  type searchContentQueryParameters = {
46543
47184
  q?: string;
46544
47185
  refine?: string;
@@ -46554,11 +47195,11 @@ declare namespace ShopperExperienceApiTypes {
46554
47195
  /**
46555
47196
  * All path parameters that are used by at least one ShopperExperience method.
46556
47197
  */
46557
- type ShopperExperiencePathParameters = Partial<getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & searchContentPathParameters & {}>;
47198
+ type ShopperExperiencePathParameters = Partial<getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & resolveQualifiersPathParameters & searchContentPathParameters & {}>;
46558
47199
  /**
46559
47200
  * All query parameters that are used by at least one ShopperExperience method.
46560
47201
  */
46561
- type ShopperExperienceQueryParameters = Partial<getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & searchContentQueryParameters & {}>;
47202
+ type ShopperExperienceQueryParameters = Partial<getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & resolveQualifiersQueryParameters & searchContentQueryParameters & {}>;
46562
47203
  /**
46563
47204
  * All parameters that are used by ShopperExperience.
46564
47205
  */
@@ -46570,7 +47211,7 @@ declare namespace ShopperExperienceApiTypes {
46570
47211
  * *[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/shopper-experience/shopper-experience-oas-v1-public.yaml)
46571
47212
 
46572
47213
  # API Overview
46573
- Use the Shopper Experience API to look up page information for pages that are created in Page Designer, content assets and to access content folders.
47214
+ 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
47215
 
46575
47216
  ## Authentication & Authorization
46576
47217
 
@@ -46594,12 +47235,27 @@ declare namespace ShopperExperienceApiTypes {
46594
47235
 
46595
47236
  Only content folders that are marked as online are returned in the API responses.
46596
47237
 
47238
+ ### Search Content Assets
47239
+ Search for content assets using keywords and refinement filters. The search functionality supports:
47240
+
47241
+ - Keyword-based search across content assets
47242
+ - Refinement attributes to filter results, for example, by folder or content type
47243
+ - Sorting by configurable attributes
47244
+ - Pagination for large result sets (up to 200 items per page)
47245
+
47246
+ Only content assets that are online and assigned to a folder are included in search results.
47247
+
47248
+ ### Batch Retrieval
47249
+ Retrieve multiple content assets or content folders in a single API request for improved performance (up to 50 content assets or folders at once).
47250
+
46597
47251
  ## Page Responses
46598
47252
  Responses for pages include the following:
46599
47253
 
46600
47254
  - The entire component hierarchy of the page at design time.
46601
47255
  - All merchant data provided at design time.
46602
47256
  - Server-side scripting data provided at run time.
47257
+ - Tracking for each rendered component or fragment using a globally unique content link UUID.
47258
+ - Support for reusable component fragments that can be shared across multiple pages.
46603
47259
 
46604
47260
  Both the page and components contain the values of all native and custom attributes that have been populated during page authoring.
46605
47261
 
@@ -46653,6 +47309,7 @@ declare namespace ShopperExperienceApiTypes {
46653
47309
  getMultipleContent: string;
46654
47310
  getPage: string;
46655
47311
  getPages: string;
47312
+ resolveQualifiers: string;
46656
47313
  searchContent: string;
46657
47314
  };
46658
47315
  constructor(config: ClientConfigInit<ConfigParameters>);
@@ -46731,6 +47388,15 @@ declare namespace ShopperExperienceApiTypes {
46731
47388
  "aspectTypeId",
46732
47389
  "siteId"
46733
47390
  ];
47391
+ readonly resolveQualifiers: readonly [
47392
+ "organizationId",
47393
+ "siteId",
47394
+ "locale"
47395
+ ];
47396
+ readonly resolveQualifiersRequired: readonly [
47397
+ "organizationId",
47398
+ "siteId"
47399
+ ];
46734
47400
  readonly searchContent: readonly [
46735
47401
  "organizationId",
46736
47402
  "siteId",
@@ -47140,6 +47806,73 @@ declare namespace ShopperExperienceApiTypes {
47140
47806
  [key: string]: string;
47141
47807
  };
47142
47808
  }>, rawResponse?: T): Promise<T extends true ? Response : PageResult>;
47809
+ /**
47810
+ * Resolves a list of customer groups, campaigns, promotions, and data bindings for the given user.
47811
+
47812
+ The endpoint takes each value and determines whether the user is active for the item:
47813
+ - Customer groups are verified against the user's qualification via the EffectiveContext.
47814
+ - Campaign qualifiers are checked to determine if the user is applicable for each campaign and promotion.
47815
+ - Data bindings are resolved by fetching the requested records from their respective data providers.
47816
+
47817
+ 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.
47818
+
47819
+ *
47820
+ * If you would like to get a raw Response object use the other resolveQualifiers function.
47821
+ *
47822
+ * @param options - An object containing the options for this method.
47823
+ * @param options.parameters - An object containing the parameters for this method.
47824
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
47825
+ * @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.
47826
+ * @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.
47827
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
47828
+ * @param options.body - The data to send as the request body.
47829
+ *
47830
+ * @returns A promise of type QualifierResolveResponse.
47831
+ */
47832
+ resolveQualifiers(options: RequireParametersUnlessAllAreOptional<{
47833
+ parameters?: CompositeParameters<{
47834
+ organizationId: string;
47835
+ siteId: string;
47836
+ locale?: LocaleCode$0;
47837
+ } & QueryParameters, ConfigParameters>;
47838
+ headers?: {
47839
+ [key: string]: string;
47840
+ };
47841
+ body: QualifierResolveRequest & CustomRequestBody;
47842
+ }>): Promise<QualifierResolveResponse>;
47843
+ /**
47844
+ * Resolves a list of customer groups, campaigns, promotions, and data bindings for the given user.
47845
+
47846
+ The endpoint takes each value and determines whether the user is active for the item:
47847
+ - Customer groups are verified against the user's qualification via the EffectiveContext.
47848
+ - Campaign qualifiers are checked to determine if the user is applicable for each campaign and promotion.
47849
+ - Data bindings are resolved by fetching the requested records from their respective data providers.
47850
+
47851
+ 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.
47852
+
47853
+ *
47854
+ * @param options - An object containing the options for this method.
47855
+ * @param options.parameters - An object containing the parameters for this method.
47856
+ * @param options.parameters.organizationId - An identifier for the organization the request is being made by
47857
+ * @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.
47858
+ * @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.
47859
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
47860
+ * @param options.body - The data to send as the request body.
47861
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
47862
+ *
47863
+ * @returns A promise of type Response if rawResponse is true, a promise of type QualifierResolveResponse otherwise.
47864
+ */
47865
+ resolveQualifiers<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
47866
+ parameters?: CompositeParameters<{
47867
+ organizationId: string;
47868
+ siteId: string;
47869
+ locale?: LocaleCode$0;
47870
+ } & QueryParameters, ConfigParameters>;
47871
+ headers?: {
47872
+ [key: string]: string;
47873
+ };
47874
+ body: QualifierResolveRequest & CustomRequestBody;
47875
+ }>, rawResponse?: T): Promise<T extends true ? Response : QualifierResolveResponse>;
47143
47876
  /**
47144
47877
  * Provides keyword and refinement search functionality for content assets. The search result contains only content
47145
47878
  that is online and assigned to a folder.
@@ -47167,7 +47900,7 @@ declare namespace ShopperExperienceApiTypes {
47167
47900
 
47168
47901
  Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes.
47169
47902
  * @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 - Maximum records to retrieve per request, not to exceed 200. Defaults to 50.
47903
+ * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
47171
47904
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
47172
47905
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
47173
47906
  *
@@ -47213,7 +47946,7 @@ declare namespace ShopperExperienceApiTypes {
47213
47946
 
47214
47947
  Precondition: You have to select your sorting attributes in Business Manager > YourSite > Search Indexes > Content Index > Sorting Attributes.
47215
47948
  * @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 - Maximum records to retrieve per request, not to exceed 200. Defaults to 50.
47949
+ * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
47217
47950
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
47218
47951
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
47219
47952
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -47238,6 +47971,24 @@ declare namespace ShopperExperienceApiTypes {
47238
47971
  }
47239
47972
  }
47240
47973
  declare namespace ShopperExperienceModelTypes {
47974
+ /**
47975
+ * @type CampaignQualifier: A campaign and promotion pair to resolve qualification for.
47976
+ *
47977
+ * @property campaignId: The identifier of the campaign.
47978
+ * - **Min Length:** 1
47979
+ * - **Max Length:** 256
47980
+ *
47981
+ * @property promotionId: The identifier of the promotion within the campaign.
47982
+ * - **Min Length:** 1
47983
+ * - **Max Length:** 256
47984
+ *
47985
+ */
47986
+ type CampaignQualifier = {
47987
+ campaignId: string;
47988
+ promotionId: string;
47989
+ } & {
47990
+ [key: string]: any;
47991
+ };
47241
47992
  /**
47242
47993
  * @type Region:
47243
47994
  *
@@ -47262,18 +48013,38 @@ declare namespace ShopperExperienceModelTypes {
47262
48013
  * @property typeId: Component type identifier.
47263
48014
  * - **Max Length:** 256
47264
48015
  *
48016
+ * @property name: Display name of the component.
48017
+ * - **Max Length:** 256
48018
+ *
48019
+ * @property fragment: Indicates whether the component is a fragment. True if the component is a fragment, otherwise false.
48020
+ *
48021
+ * @property contentLinkUuid: Represents a globally unique identifier for every instance of a content component (or fragment) rendered on a page.
48022
+ * - **Max Length:** 256
48023
+ *
47265
48024
  * @property data: The configuration data assigned to the component.
47266
48025
  *
48026
+ * @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.
48027
+ *
48028
+ * @property visible: Whether the component is visible based on the current visiblity rules and context.
48029
+ *
47267
48030
  * @property custom: Any custom data added by the custom code for this component.
47268
48031
  *
48032
+ * @property designMetadata: Design metadata of the component. This includes information about the component type definition needed by the page designer for design-time functionality.
48033
+ *
47269
48034
  * @property regions: The regions (and their assigned components) for the component.
47270
48035
  *
47271
48036
  */
47272
48037
  type Component = {
47273
48038
  id: string;
47274
48039
  typeId: string;
48040
+ name?: string;
48041
+ fragment?: boolean;
48042
+ contentLinkUuid?: string;
47275
48043
  data?: object;
48044
+ localized?: boolean;
48045
+ visible?: boolean;
47276
48046
  custom?: object;
48047
+ designMetadata?: object;
47277
48048
  regions?: Array<Region>;
47278
48049
  } & {
47279
48050
  [key: string]: any;
@@ -47454,6 +48225,24 @@ declare namespace ShopperExperienceModelTypes {
47454
48225
  } & {
47455
48226
  [key: string]: any;
47456
48227
  };
48228
+ /**
48229
+ * @type DataBindingRequirement: A data binding requirement specifying a provider type and record identifier to resolve.
48230
+ *
48231
+ * @property type: The data provider type identifier.
48232
+ * - **Min Length:** 1
48233
+ * - **Max Length:** 256
48234
+ *
48235
+ * @property id: The record identifier to resolve from the data provider.
48236
+ * - **Min Length:** 1
48237
+ * - **Max Length:** 256
48238
+ *
48239
+ */
48240
+ type DataBindingRequirement = {
48241
+ type: string;
48242
+ id: string;
48243
+ } & {
48244
+ [key: string]: any;
48245
+ };
47457
48246
  /**
47458
48247
  * @type ErrorResponse:
47459
48248
  *
@@ -47513,6 +48302,12 @@ declare namespace ShopperExperienceModelTypes {
47513
48302
  *
47514
48303
  * @property custom: Any custom data added by the custom code for the page type.
47515
48304
  *
48305
+ * @property visible: Whether the page is visible based on the current visiblity rules and context.
48306
+ *
48307
+ * @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.
48308
+ *
48309
+ * @property designMetadata: Design metadata of the page. This includes information about the page type definition needed by the page designer for design-time functionality.
48310
+ *
47516
48311
  * @property regions: The regions (and their assigned components) for the page.
47517
48312
  *
47518
48313
  */
@@ -47527,6 +48322,9 @@ declare namespace ShopperExperienceModelTypes {
47527
48322
  pageKeywords?: string;
47528
48323
  data?: object;
47529
48324
  custom?: object;
48325
+ visible?: boolean;
48326
+ localized?: boolean;
48327
+ designMetadata?: object;
47530
48328
  regions?: Array<Region>;
47531
48329
  } & {
47532
48330
  [key: string]: any;
@@ -47559,6 +48357,52 @@ declare namespace ShopperExperienceModelTypes {
47559
48357
  } & {
47560
48358
  [key: string]: any;
47561
48359
  };
48360
+ /**
48361
+ * @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.
48362
+ *
48363
+ * @property customerGroups: List of customer group identifiers to resolve qualification for.
48364
+ *
48365
+ * @property campaignQualifiers: List of campaign and promotion pairs to resolve qualification for.
48366
+ *
48367
+ * @property dataBindings: List of data binding requirements to resolve, each specifying a provider type and record identifier.
48368
+ *
48369
+ */
48370
+ type QualifierResolveRequest = {
48371
+ customerGroups?: Array<string>;
48372
+ campaignQualifiers?: Array<CampaignQualifier>;
48373
+ dataBindings?: Array<DataBindingRequirement>;
48374
+ } & {
48375
+ [key: string]: any;
48376
+ };
48377
+ /**
48378
+ * @type QualifierResolveResponse: Response containing the resolved qualification results for customer groups, campaign qualifiers, and data bindings.
48379
+ *
48380
+ * @property customerGroups: Map of customer group identifiers to their qualification status. True if the user is qualified, false otherwise.
48381
+ *
48382
+ * @property campaignQualifiers: Map of campaign identifiers to a map of promotion identifiers and their qualification status. True if the user is applicable, false otherwise.
48383
+ *
48384
+ * @property dataBindings: Resolved data binding objects grouped by provider type, then by record identifier. Used by the expression resolver to evaluate attribute expressions.
48385
+ *
48386
+ */
48387
+ type QualifierResolveResponse = {
48388
+ customerGroups?: {
48389
+ [key: string]: boolean;
48390
+ };
48391
+ campaignQualifiers?: {
48392
+ [key: string]: {
48393
+ [key: string]: boolean;
48394
+ };
48395
+ };
48396
+ dataBindings?: {
48397
+ [key: string]: {
48398
+ [key: string]: {
48399
+ [key: string]: any;
48400
+ };
48401
+ };
48402
+ };
48403
+ } & {
48404
+ [key: string]: any;
48405
+ };
47562
48406
  /**
47563
48407
  * @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
48408
  *
@@ -47590,9 +48434,12 @@ declare namespace ShopperExperienceTypes {
47590
48434
  type getPagePathParameters = ShopperExperienceApiTypes.getPagePathParameters;
47591
48435
  type getPagesQueryParameters = ShopperExperienceApiTypes.getPagesQueryParameters;
47592
48436
  type getPagesPathParameters = ShopperExperienceApiTypes.getPagesPathParameters;
48437
+ type resolveQualifiersQueryParameters = ShopperExperienceApiTypes.resolveQualifiersQueryParameters;
48438
+ type resolveQualifiersPathParameters = ShopperExperienceApiTypes.resolveQualifiersPathParameters;
47593
48439
  type searchContentQueryParameters = ShopperExperienceApiTypes.searchContentQueryParameters;
47594
48440
  type searchContentPathParameters = ShopperExperienceApiTypes.searchContentPathParameters;
47595
48441
  // Model types
48442
+ type CampaignQualifier = ShopperExperienceModelTypes.CampaignQualifier;
47596
48443
  type Component = ShopperExperienceModelTypes.Component;
47597
48444
  type Content = ShopperExperienceModelTypes.Content;
47598
48445
  type ContentFolder = ShopperExperienceModelTypes.ContentFolder;
@@ -47601,11 +48448,14 @@ declare namespace ShopperExperienceTypes {
47601
48448
  type ContentSearchRefinement = ShopperExperienceModelTypes.ContentSearchRefinement;
47602
48449
  type ContentSearchRefinementValue = ShopperExperienceModelTypes.ContentSearchRefinementValue;
47603
48450
  type ContentSearchResult = ShopperExperienceModelTypes.ContentSearchResult;
48451
+ type DataBindingRequirement = ShopperExperienceModelTypes.DataBindingRequirement;
47604
48452
  type ErrorResponse = ShopperExperienceModelTypes.ErrorResponse;
47605
48453
  type LocaleCode = ShopperExperienceModelTypes.LocaleCode;
47606
48454
  type Page = ShopperExperienceModelTypes.Page;
47607
48455
  type PageResult = ShopperExperienceModelTypes.PageResult;
47608
48456
  type PaginatedResultBase = ShopperExperienceModelTypes.PaginatedResultBase;
48457
+ type QualifierResolveRequest = ShopperExperienceModelTypes.QualifierResolveRequest;
48458
+ type QualifierResolveResponse = ShopperExperienceModelTypes.QualifierResolveResponse;
47609
48459
  type Region = ShopperExperienceModelTypes.Region;
47610
48460
  type ResultBase = ShopperExperienceModelTypes.ResultBase;
47611
48461
  }
@@ -68216,6 +69066,7 @@ declare namespace helpers {
68216
69066
  usid?: string;
68217
69067
  dnt?: boolean;
68218
69068
  };
69069
+ enableHttpOnlySessionCookies?: boolean;
68219
69070
  }): Promise<TokenResponse>;
68220
69071
  /**
68221
69072
  * 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 +69094,7 @@ declare namespace helpers {
68243
69094
  credentials: {
68244
69095
  clientSecret: string;
68245
69096
  };
69097
+ enableHttpOnlySessionCookies?: boolean;
68246
69098
  }): Promise<TokenResponse>;
68247
69099
  /**
68248
69100
  * 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 +69118,7 @@ declare namespace helpers {
68266
69118
  usid?: string;
68267
69119
  dnt?: boolean;
68268
69120
  } & CustomQueryParameters;
69121
+ enableHttpOnlySessionCookies?: boolean;
68269
69122
  }): Promise<TokenResponse>;
68270
69123
  /**
68271
69124
  * 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 +69154,7 @@ declare namespace helpers {
68301
69154
  dnt?: boolean;
68302
69155
  };
68303
69156
  body?: CustomRequestBody;
69157
+ enableHttpOnlySessionCookies?: boolean;
68304
69158
  }): Promise<TokenResponse>;
68305
69159
  /** Function to send passwordless login token
68306
69160
  * **Note** At the moment, passwordless is only supported on private client
@@ -68375,6 +69229,7 @@ declare namespace helpers {
68375
69229
  pwdlessLoginToken: string;
68376
69230
  dnt?: string;
68377
69231
  };
69232
+ enableHttpOnlySessionCookies?: boolean;
68378
69233
  }): Promise<TokenResponse>;
68379
69234
  /**
68380
69235
  * Exchange a refresh token for a new access token.
@@ -68401,6 +69256,7 @@ declare namespace helpers {
68401
69256
  credentials?: {
68402
69257
  clientSecret?: string;
68403
69258
  };
69259
+ enableHttpOnlySessionCookies?: boolean;
68404
69260
  }): Promise<TokenResponse>;
68405
69261
  /**
68406
69262
  * 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.