commerce-sdk-isomorphic 1.13.1 → 2.0.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.
@@ -4,6 +4,7 @@
4
4
  * SPDX-License-Identifier: BSD-3-Clause
5
5
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
6
6
  */
7
+ import { BodyInit } from "node-fetch";
7
8
  import { RequestInit as NodeRequestInit } from "node-fetch";
8
9
  /*
9
10
  * Copyright (c) 2023, Salesforce, Inc.
@@ -524,6 +525,10 @@ type Basket = {
524
525
  } & {
525
526
  [key: string]: any;
526
527
  };
528
+ type OrderLookupRequest = {
529
+ email: string;
530
+ orderViewCode: string;
531
+ };
527
532
  type OrderPaymentInstrumentRequest = {
528
533
  amount?: number;
529
534
  bankRoutingNumber?: string;
@@ -7241,6 +7246,7 @@ type ShopperContext = {
7241
7246
  assignmentQualifiers?: {} & {
7242
7247
  [key: string]: any;
7243
7248
  };
7249
+ clientIp?: string;
7244
7250
  } & {
7245
7251
  [key: string]: any;
7246
7252
  };
@@ -7387,7 +7393,7 @@ type ShopperContextsParameters = ShopperContextsPathParameters & BaseUriParamete
7387
7393
  * ```
7388
7394
  *
7389
7395
  * <span style="font-size:.7em; display:block; text-align: right">
7390
- * API Version: 0.0.23<br />
7396
+ * API Version: 0.0.26<br />
7391
7397
  * Last Updated: <br />
7392
7398
  * </span>
7393
7399
 
@@ -7727,6 +7733,7 @@ declare namespace ShopperContextsTypes {
7727
7733
  assignmentQualifiers?: {} & {
7728
7734
  [key: string]: any;
7729
7735
  };
7736
+ clientIp?: string;
7730
7737
  } & {
7731
7738
  [key: string]: any;
7732
7739
  };
@@ -8028,7 +8035,7 @@ declare namespace ShopperContextsTypes {
8028
8035
  * ```
8029
8036
  *
8030
8037
  * <span style="font-size:.7em; display:block; text-align: right">
8031
- * API Version: 0.0.23<br />
8038
+ * API Version: 0.0.26<br />
8032
8039
  * Last Updated: <br />
8033
8040
  * </span>
8034
8041
 
@@ -8356,12 +8363,6 @@ type BasketsResult$0 = {
8356
8363
  } & {
8357
8364
  [key: string]: any;
8358
8365
  };
8359
- type TrustedSystemAuthRequest = {
8360
- clientId: string;
8361
- login: string;
8362
- } & {
8363
- [key: string]: any;
8364
- };
8365
8366
  type ResetPasswordRequest = {
8366
8367
  resetToken: string;
8367
8368
  login: string;
@@ -8580,10 +8581,10 @@ type CustomerPaymentInstrument = {
8580
8581
  creationDate?: any;
8581
8582
  lastModified?: any;
8582
8583
  maskedGiftCertificateCode?: string;
8583
- paymentBankAccount: PaymentBankAccount;
8584
- paymentCard: PaymentCard$0;
8585
- paymentInstrumentId: string;
8586
- paymentMethodId: string;
8584
+ paymentBankAccount?: PaymentBankAccount;
8585
+ paymentCard?: PaymentCard$0;
8586
+ paymentInstrumentId?: string;
8587
+ paymentMethodId?: string;
8587
8588
  } & {
8588
8589
  [key: string]: any;
8589
8590
  };
@@ -8737,11 +8738,6 @@ type PasswordChangeRequest = {
8737
8738
  } & {
8738
8739
  [key: string]: any;
8739
8740
  };
8740
- type AuthRequest = {
8741
- type?: string;
8742
- } & {
8743
- [key: string]: any;
8744
- };
8745
8741
  type Inventory = {
8746
8742
  ats?: number;
8747
8743
  backorderable?: boolean;
@@ -8785,6 +8781,7 @@ type Basket$0 = {
8785
8781
  currency: string;
8786
8782
  customerInfo: CustomerInfo$0;
8787
8783
  giftCertificateItems?: Array<GiftCertificateItem>;
8784
+ groupedTaxItems?: Array<GroupedTaxItem>;
8788
8785
  inventoryReservationExpiry?: any;
8789
8786
  lastModified: any;
8790
8787
  merchandizeTotalTax: number;
@@ -8802,15 +8799,17 @@ type Basket$0 = {
8802
8799
  sourceCode?: string;
8803
8800
  taxTotal: number;
8804
8801
  taxation: string;
8802
+ taxRoundedAtGroup?: boolean;
8803
+ temporaryBasket?: boolean;
8805
8804
  } & {
8806
8805
  [key: string]: any;
8807
8806
  };
8808
8807
  type CustomerPaymentInstrumentRequest = {
8809
- bankRoutingNumber: string;
8810
- giftCertificateCode: string;
8808
+ bankRoutingNumber?: string;
8809
+ giftCertificateCode?: string;
8811
8810
  paymentBankAccount?: PaymentBankAccountRequest;
8812
- paymentCard: CustomerPaymentCardRequest;
8813
- paymentMethodId: string;
8811
+ paymentCard?: CustomerPaymentCardRequest;
8812
+ paymentMethodId?: string;
8814
8813
  } & {
8815
8814
  [key: string]: any;
8816
8815
  };
@@ -8835,6 +8834,7 @@ type Customer = {
8835
8834
  creationDate?: any;
8836
8835
  customerId?: string;
8837
8836
  customerNo?: string;
8837
+ currentPassword?: string;
8838
8838
  email?: string;
8839
8839
  enabled?: boolean;
8840
8840
  fax?: string;
@@ -8945,6 +8945,10 @@ type ProductListLink$0 = {
8945
8945
  } & {
8946
8946
  [key: string]: any;
8947
8947
  };
8948
+ type GroupedTaxItem$0 = {
8949
+ taxRate?: number;
8950
+ taxValue?: number;
8951
+ };
8948
8952
  type ProductListRegistrant = {
8949
8953
  firstName: string;
8950
8954
  lastName: string;
@@ -9221,7 +9225,6 @@ type ShopperCustomersPathParameters = {
9221
9225
  */
9222
9226
  type ShopperCustomersQueryParameters = {
9223
9227
  siteId?: string;
9224
- clientId?: string;
9225
9228
  externalId?: string;
9226
9229
  authenticationProviderId?: string;
9227
9230
  crossSites?: boolean;
@@ -9261,7 +9264,7 @@ type ShopperCustomersParameters = ShopperCustomersPathParameters & BaseUriParame
9261
9264
  * ```
9262
9265
  *
9263
9266
  * <span style="font-size:.7em; display:block; text-align: right">
9264
- * API Version: 0.0.43<br />
9267
+ * API Version: 0.0.48<br />
9265
9268
  * Last Updated: <br />
9266
9269
  * </span>
9267
9270
 
@@ -9276,7 +9279,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
9276
9279
  static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/customer/shopper-customers/{version}";
9277
9280
  constructor(config: ClientConfigInit<ConfigParameters>);
9278
9281
  /**
9279
- * Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API.
9282
+ * Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API. The return type object for this endpoint is a common customer object shared by multiple Shopper Customer endpoints. In this case, all customer object details are returned, but attributes that are not included in the response, although they might be part of the customer object, are ignored. For example, although address information is included in the customer object, it is not displayed in the response for this endpoint and is ignored.
9280
9283
  *
9281
9284
  * If you would like to get a raw Response object use the other registerCustomer function.
9282
9285
  *
@@ -9304,7 +9307,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
9304
9307
  body: CustomerRegistration;
9305
9308
  }>): Promise<Customer>;
9306
9309
  /**
9307
- * Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API.
9310
+ * Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API. The return type object for this endpoint is a common customer object shared by multiple Shopper Customer endpoints. In this case, all customer object details are returned, but attributes that are not included in the response, although they might be part of the customer object, are ignored. For example, although address information is included in the customer object, it is not displayed in the response for this endpoint and is ignored.
9308
9311
  *
9309
9312
  * @param options - An object containing the options for this method.
9310
9313
  * @param parameters - An object containing the parameters for this method.
@@ -9329,240 +9332,6 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
9329
9332
  };
9330
9333
  body: CustomerRegistration;
9331
9334
  }>, rawResponse?: T): Promise<T extends true ? Response : Customer>;
9332
- /**
9333
- * 🚨 **DEPRECATION NOTICE**
9334
-
9335
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
9336
-
9337
- ---
9338
-
9339
- Log the user out.
9340
- *
9341
- * If you would like to get a raw Response object use the other invalidateCustomerAuth function.
9342
- *
9343
- * @param options - An object containing the options for this method.
9344
- * @param parameters - An object containing the parameters for this method.
9345
- * @param organizationId -
9346
- * @param siteId -
9347
- * @param headers - An object literal of key value pairs of the headers to be
9348
- * sent with this request.
9349
- *
9350
- * @returns A promise of type void.
9351
- *
9352
- */
9353
- invalidateCustomerAuth(options?: RequireParametersUnlessAllAreOptional<{
9354
- parameters?: CompositeParameters<{
9355
- organizationId: string;
9356
- siteId: string;
9357
- } & {
9358
- [key in `c_${string}`]: any;
9359
- }, ConfigParameters>;
9360
- headers?: {
9361
- [key: string]: string;
9362
- };
9363
- }>): Promise<void>;
9364
- /**
9365
- * 🚨 **DEPRECATION NOTICE**
9366
-
9367
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
9368
-
9369
- ---
9370
-
9371
- Log the user out.
9372
- *
9373
- * @param options - An object containing the options for this method.
9374
- * @param parameters - An object containing the parameters for this method.
9375
- * @param organizationId -
9376
- * @param siteId -
9377
- * @param headers - An object literal of key value pairs of the headers to be
9378
- * sent with this request.
9379
- * @param rawResponse - Set to true to return entire Response object instead of DTO.
9380
- * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
9381
- *
9382
- */
9383
- invalidateCustomerAuth<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
9384
- parameters?: CompositeParameters<{
9385
- organizationId: string;
9386
- siteId: string;
9387
- } & {
9388
- [key in `c_${string}`]: any;
9389
- }, ConfigParameters>;
9390
- headers?: {
9391
- [key: string]: string;
9392
- };
9393
- }>, rawResponse?: T): Promise<T extends true ? Response : void>;
9394
- /**
9395
- * 🚨 **DEPRECATION NOTICE**
9396
-
9397
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
9398
-
9399
- ---
9400
-
9401
- Obtains a new JSON Web Token (JWT) for a guest or registered
9402
- customer. Tokens are returned as an HTTP `Authorization: Bearer` response
9403
- header entry. The following kinds of request are supported, as specified by the
9404
- `type`:
9405
-
9406
- - `\{\"type\": \"guest\"\}` → Creates a guest (non-authenticated) customer and returns a token for the customer.
9407
- - `\{\"type\": \"credentials\"\}` → Authenticates credentials passed in the `HTTP Authorization: Basic` request header and returns a token for a successfully authenticated customer (otherwise, it throws an `AuthenticationFailedException`). This type of request also updates profile attributes for the customer (for example, `last-visited`) and handles the maximum number of failed login attempts.
9408
- - `\{\"type\": \"refresh\"\}` → Examines the token passed in the `HTTP Authorization: Bearer` request header. If valid, a new token is returned with an updated expiry time.
9409
-
9410
- The JWT contains 3 sections:
9411
-
9412
- 1. Header: Specifies token type and algorithm used.
9413
- 2. Payload: Contains customer information, client ID, issue, and expiration time.
9414
- 3. Signature: Records the token signature.
9415
-
9416
- A token is created and returned to the client whenever a registered customer logs in (`credentials` type) or a guest customer requests it (`guest` type). The token is returned in the response header as `Authorization: Bearer --token--`.
9417
-
9418
- The client has to include the token in the request header as `Authorization: Bearer --token--` in any follow-up request. The server declines any follow-up requests without a token. The server declines any requests that cannot be verified based on the token signature or expiration time. A token nearing its expiration time should be exchanged for a new one (`refresh` type).
9419
- *
9420
- * If you would like to get a raw Response object use the other authorizeCustomer function.
9421
- *
9422
- * @param options - An object containing the options for this method.
9423
- * @param parameters - An object containing the parameters for this method.
9424
- * @param organizationId -
9425
- * @param clientId - Client ID for application identification
9426
- * @param siteId -
9427
- * @param headers - An object literal of key value pairs of the headers to be
9428
- * sent with this request.
9429
- * @param body - The data to send as the request body.
9430
- *
9431
- * @returns A promise of type Customer.
9432
- *
9433
- */
9434
- authorizeCustomer(options: RequireParametersUnlessAllAreOptional<{
9435
- parameters?: CompositeParameters<{
9436
- organizationId: string;
9437
- clientId: string;
9438
- siteId: string;
9439
- } & {
9440
- [key in `c_${string}`]: any;
9441
- }, ConfigParameters>;
9442
- headers?: {
9443
- [key: string]: string;
9444
- };
9445
- body: AuthRequest;
9446
- }>): Promise<Customer>;
9447
- /**
9448
- * 🚨 **DEPRECATION NOTICE**
9449
-
9450
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
9451
-
9452
- ---
9453
-
9454
- Obtains a new JSON Web Token (JWT) for a guest or registered
9455
- customer. Tokens are returned as an HTTP `Authorization: Bearer` response
9456
- header entry. The following kinds of request are supported, as specified by the
9457
- `type`:
9458
-
9459
- - `\{\"type\": \"guest\"\}` → Creates a guest (non-authenticated) customer and returns a token for the customer.
9460
- - `\{\"type\": \"credentials\"\}` → Authenticates credentials passed in the `HTTP Authorization: Basic` request header and returns a token for a successfully authenticated customer (otherwise, it throws an `AuthenticationFailedException`). This type of request also updates profile attributes for the customer (for example, `last-visited`) and handles the maximum number of failed login attempts.
9461
- - `\{\"type\": \"refresh\"\}` → Examines the token passed in the `HTTP Authorization: Bearer` request header. If valid, a new token is returned with an updated expiry time.
9462
-
9463
- The JWT contains 3 sections:
9464
-
9465
- 1. Header: Specifies token type and algorithm used.
9466
- 2. Payload: Contains customer information, client ID, issue, and expiration time.
9467
- 3. Signature: Records the token signature.
9468
-
9469
- A token is created and returned to the client whenever a registered customer logs in (`credentials` type) or a guest customer requests it (`guest` type). The token is returned in the response header as `Authorization: Bearer --token--`.
9470
-
9471
- The client has to include the token in the request header as `Authorization: Bearer --token--` in any follow-up request. The server declines any follow-up requests without a token. The server declines any requests that cannot be verified based on the token signature or expiration time. A token nearing its expiration time should be exchanged for a new one (`refresh` type).
9472
- *
9473
- * @param options - An object containing the options for this method.
9474
- * @param parameters - An object containing the parameters for this method.
9475
- * @param organizationId -
9476
- * @param clientId - Client ID for application identification
9477
- * @param siteId -
9478
- * @param headers - An object literal of key value pairs of the headers to be
9479
- * sent with this request.
9480
- * @param body - The data to send as the request body.
9481
- * @param rawResponse - Set to true to return entire Response object instead of DTO.
9482
- * @returns A promise of type Response if rawResponse is true, a promise of type Customer otherwise.
9483
- *
9484
- */
9485
- authorizeCustomer<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
9486
- parameters?: CompositeParameters<{
9487
- organizationId: string;
9488
- clientId: string;
9489
- siteId: string;
9490
- } & {
9491
- [key in `c_${string}`]: any;
9492
- }, ConfigParameters>;
9493
- headers?: {
9494
- [key: string]: string;
9495
- };
9496
- body: AuthRequest;
9497
- }>, rawResponse?: T): Promise<T extends true ? Response : Customer>;
9498
- /**
9499
- * 🚨 **DEPRECATION NOTICE**
9500
-
9501
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
9502
-
9503
- ---
9504
-
9505
- Obtain the JSON Web Token (JWT) for registered customers whose credentials are stored using a third party system. Accepts `loginId` and
9506
- `clientId`, returns a customer object in the response body and the JWT generated against the `clientId` in the response header.
9507
- *
9508
- * If you would like to get a raw Response object use the other authorizeTrustedSystem function.
9509
- *
9510
- * @param options - An object containing the options for this method.
9511
- * @param parameters - An object containing the parameters for this method.
9512
- * @param organizationId -
9513
- * @param siteId -
9514
- * @param headers - An object literal of key value pairs of the headers to be
9515
- * sent with this request.
9516
- * @param body - The data to send as the request body.
9517
- *
9518
- * @returns A promise of type Customer.
9519
- *
9520
- */
9521
- authorizeTrustedSystem(options: RequireParametersUnlessAllAreOptional<{
9522
- parameters?: CompositeParameters<{
9523
- organizationId: string;
9524
- siteId: string;
9525
- } & {
9526
- [key in `c_${string}`]: any;
9527
- }, ConfigParameters>;
9528
- headers?: {
9529
- [key: string]: string;
9530
- };
9531
- body: TrustedSystemAuthRequest;
9532
- }>): Promise<Customer>;
9533
- /**
9534
- * 🚨 **DEPRECATION NOTICE**
9535
-
9536
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
9537
-
9538
- ---
9539
-
9540
- Obtain the JSON Web Token (JWT) for registered customers whose credentials are stored using a third party system. Accepts `loginId` and
9541
- `clientId`, returns a customer object in the response body and the JWT generated against the `clientId` in the response header.
9542
- *
9543
- * @param options - An object containing the options for this method.
9544
- * @param parameters - An object containing the parameters for this method.
9545
- * @param organizationId -
9546
- * @param siteId -
9547
- * @param headers - An object literal of key value pairs of the headers to be
9548
- * sent with this request.
9549
- * @param body - The data to send as the request body.
9550
- * @param rawResponse - Set to true to return entire Response object instead of DTO.
9551
- * @returns A promise of type Response if rawResponse is true, a promise of type Customer otherwise.
9552
- *
9553
- */
9554
- authorizeTrustedSystem<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
9555
- parameters?: CompositeParameters<{
9556
- organizationId: string;
9557
- siteId: string;
9558
- } & {
9559
- [key in `c_${string}`]: any;
9560
- }, ConfigParameters>;
9561
- headers?: {
9562
- [key: string]: string;
9563
- };
9564
- body: TrustedSystemAuthRequest;
9565
- }>, rawResponse?: T): Promise<T extends true ? Response : Customer>;
9566
9335
  /**
9567
9336
  * Reset customer password, after obtaining a reset token. This is the second step in the reset customer password flow, where a customer password is reset by providing the new credentials along with a reset token. This call should be preceded by a call to the /create-reset-token endpoint.
9568
9337
  *
@@ -10194,7 +9963,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
10194
9963
  * @param parameters - An object containing the parameters for this method.
10195
9964
  * @param organizationId -
10196
9965
  * @param customerId - The customer ID.
10197
- * @param crossSites -
9966
+ * @param crossSites - The flag indicating whether all sites should be searched. This flag is ignored unless a valid User / Agent is present with a trusted agent on behalf (TAOB) token. Without a TAOB token, only the customer's orders placed on the site specified by siteId are returned.
10198
9967
  * @param from -
10199
9968
  * @param until -
10200
9969
  * @param status -
@@ -10232,7 +10001,7 @@ declare class ShopperCustomers<ConfigParameters extends ShopperCustomersParamete
10232
10001
  * @param parameters - An object containing the parameters for this method.
10233
10002
  * @param organizationId -
10234
10003
  * @param customerId - The customer ID.
10235
- * @param crossSites -
10004
+ * @param crossSites - The flag indicating whether all sites should be searched. This flag is ignored unless a valid User / Agent is present with a trusted agent on behalf (TAOB) token. Without a TAOB token, only the customer's orders placed on the site specified by siteId are returned.
10236
10005
  * @param from -
10237
10006
  * @param until -
10238
10007
  * @param status -
@@ -11664,10 +11433,10 @@ declare namespace ShopperCustomersTypes {
11664
11433
  creationDate?: any;
11665
11434
  lastModified?: any;
11666
11435
  maskedGiftCertificateCode?: string;
11667
- paymentBankAccount: PaymentBankAccount;
11668
- paymentCard: PaymentCard;
11669
- paymentInstrumentId: string;
11670
- paymentMethodId: string;
11436
+ paymentBankAccount?: PaymentBankAccount;
11437
+ paymentCard?: PaymentCard;
11438
+ paymentInstrumentId?: string;
11439
+ paymentMethodId?: string;
11671
11440
  } & {
11672
11441
  [key: string]: any;
11673
11442
  };
@@ -11869,6 +11638,7 @@ declare namespace ShopperCustomersTypes {
11869
11638
  currency: string;
11870
11639
  customerInfo: CustomerInfo;
11871
11640
  giftCertificateItems?: Array<GiftCertificateItem$0>;
11641
+ groupedTaxItems?: Array<GroupedTaxItem$0>;
11872
11642
  inventoryReservationExpiry?: any;
11873
11643
  lastModified: any;
11874
11644
  merchandizeTotalTax: number;
@@ -11886,15 +11656,17 @@ declare namespace ShopperCustomersTypes {
11886
11656
  sourceCode?: string;
11887
11657
  taxTotal: number;
11888
11658
  taxation: string;
11659
+ taxRoundedAtGroup?: boolean;
11660
+ temporaryBasket?: boolean;
11889
11661
  } & {
11890
11662
  [key: string]: any;
11891
11663
  };
11892
11664
  type CustomerPaymentInstrumentRequest = {
11893
- bankRoutingNumber: string;
11894
- giftCertificateCode: string;
11665
+ bankRoutingNumber?: string;
11666
+ giftCertificateCode?: string;
11895
11667
  paymentBankAccount?: PaymentBankAccountRequest;
11896
- paymentCard: CustomerPaymentCardRequest;
11897
- paymentMethodId: string;
11668
+ paymentCard?: CustomerPaymentCardRequest;
11669
+ paymentMethodId?: string;
11898
11670
  } & {
11899
11671
  [key: string]: any;
11900
11672
  };
@@ -11919,6 +11691,7 @@ declare namespace ShopperCustomersTypes {
11919
11691
  creationDate?: any;
11920
11692
  customerId?: string;
11921
11693
  customerNo?: string;
11694
+ currentPassword?: string;
11922
11695
  email?: string;
11923
11696
  enabled?: boolean;
11924
11697
  fax?: string;
@@ -12029,6 +11802,10 @@ declare namespace ShopperCustomersTypes {
12029
11802
  } & {
12030
11803
  [key: string]: any;
12031
11804
  };
11805
+ type GroupedTaxItem = {
11806
+ taxRate?: number;
11807
+ taxValue?: number;
11808
+ };
12032
11809
  type ProductListRegistrant = {
12033
11810
  firstName: string;
12034
11811
  lastName: string;
@@ -12460,7 +12237,6 @@ declare namespace ShopperCustomersTypes {
12460
12237
  */
12461
12238
  type ShopperCustomersQueryParameters = {
12462
12239
  siteId?: string;
12463
- clientId?: string;
12464
12240
  externalId?: string;
12465
12241
  authenticationProviderId?: string;
12466
12242
  crossSites?: boolean;
@@ -12500,7 +12276,7 @@ declare namespace ShopperCustomersTypes {
12500
12276
  * ```
12501
12277
  *
12502
12278
  * <span style="font-size:.7em; display:block; text-align: right">
12503
- * API Version: 0.0.43<br />
12279
+ * API Version: 0.0.48<br />
12504
12280
  * Last Updated: <br />
12505
12281
  * </span>
12506
12282
 
@@ -12515,7 +12291,7 @@ declare namespace ShopperCustomersTypes {
12515
12291
  static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/customer/shopper-customers/{version}";
12516
12292
  constructor(config: ClientConfigInit<ConfigParameters>);
12517
12293
  /**
12518
- * Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API.
12294
+ * Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API. The return type object for this endpoint is a common customer object shared by multiple Shopper Customer endpoints. In this case, all customer object details are returned, but attributes that are not included in the response, although they might be part of the customer object, are ignored. For example, although address information is included in the customer object, it is not displayed in the response for this endpoint and is ignored.
12519
12295
  *
12520
12296
  * If you would like to get a raw Response object use the other registerCustomer function.
12521
12297
  *
@@ -12543,7 +12319,7 @@ declare namespace ShopperCustomersTypes {
12543
12319
  body: CustomerRegistration;
12544
12320
  }>): Promise<Customer>;
12545
12321
  /**
12546
- * Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API.
12322
+ * Registers a new customer. The mandatory data are the credentials, profile last name, and email. This requires a JSON Web Token (JWT) which needs to be obtained using the POST /customers/auth API with type \"guest\", or from the Shopper Login (SLAS) API. The return type object for this endpoint is a common customer object shared by multiple Shopper Customer endpoints. In this case, all customer object details are returned, but attributes that are not included in the response, although they might be part of the customer object, are ignored. For example, although address information is included in the customer object, it is not displayed in the response for this endpoint and is ignored.
12547
12323
  *
12548
12324
  * @param options - An object containing the options for this method.
12549
12325
  * @param parameters - An object containing the parameters for this method.
@@ -12569,15 +12345,9 @@ declare namespace ShopperCustomersTypes {
12569
12345
  body: CustomerRegistration;
12570
12346
  }>, rawResponse?: T): Promise<T extends true ? Response : Customer>;
12571
12347
  /**
12572
- * 🚨 **DEPRECATION NOTICE**
12573
-
12574
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
12575
-
12576
- ---
12577
-
12578
- Log the user out.
12348
+ * Reset customer password, after obtaining a reset token. This is the second step in the reset customer password flow, where a customer password is reset by providing the new credentials along with a reset token. This call should be preceded by a call to the /create-reset-token endpoint.
12579
12349
  *
12580
- * If you would like to get a raw Response object use the other invalidateCustomerAuth function.
12350
+ * If you would like to get a raw Response object use the other resetPassword function.
12581
12351
  *
12582
12352
  * @param options - An object containing the options for this method.
12583
12353
  * @param parameters - An object containing the parameters for this method.
@@ -12585,11 +12355,12 @@ declare namespace ShopperCustomersTypes {
12585
12355
  * @param siteId -
12586
12356
  * @param headers - An object literal of key value pairs of the headers to be
12587
12357
  * sent with this request.
12358
+ * @param body - The data to send as the request body.
12588
12359
  *
12589
12360
  * @returns A promise of type void.
12590
12361
  *
12591
12362
  */
12592
- invalidateCustomerAuth(options?: RequireParametersUnlessAllAreOptional<{
12363
+ resetPassword(options: RequireParametersUnlessAllAreOptional<{
12593
12364
  parameters?: CompositeParameters<{
12594
12365
  organizationId: string;
12595
12366
  siteId: string;
@@ -12599,15 +12370,10 @@ declare namespace ShopperCustomersTypes {
12599
12370
  headers?: {
12600
12371
  [key: string]: string;
12601
12372
  };
12373
+ body: ResetPasswordRequest;
12602
12374
  }>): Promise<void>;
12603
12375
  /**
12604
- * 🚨 **DEPRECATION NOTICE**
12605
-
12606
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
12607
-
12608
- ---
12609
-
12610
- Log the user out.
12376
+ * Reset customer password, after obtaining a reset token. This is the second step in the reset customer password flow, where a customer password is reset by providing the new credentials along with a reset token. This call should be preceded by a call to the /create-reset-token endpoint.
12611
12377
  *
12612
12378
  * @param options - An object containing the options for this method.
12613
12379
  * @param parameters - An object containing the parameters for this method.
@@ -12615,11 +12381,12 @@ declare namespace ShopperCustomersTypes {
12615
12381
  * @param siteId -
12616
12382
  * @param headers - An object literal of key value pairs of the headers to be
12617
12383
  * sent with this request.
12384
+ * @param body - The data to send as the request body.
12618
12385
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
12619
12386
  * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
12620
12387
  *
12621
12388
  */
12622
- invalidateCustomerAuth<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
12389
+ resetPassword<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
12623
12390
  parameters?: CompositeParameters<{
12624
12391
  organizationId: string;
12625
12392
  siteId: string;
@@ -12629,51 +12396,27 @@ declare namespace ShopperCustomersTypes {
12629
12396
  headers?: {
12630
12397
  [key: string]: string;
12631
12398
  };
12399
+ body: ResetPasswordRequest;
12632
12400
  }>, rawResponse?: T): Promise<T extends true ? Response : void>;
12633
12401
  /**
12634
- * 🚨 **DEPRECATION NOTICE**
12635
-
12636
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
12637
-
12638
- ---
12639
-
12640
- Obtains a new JSON Web Token (JWT) for a guest or registered
12641
- customer. Tokens are returned as an HTTP `Authorization: Bearer` response
12642
- header entry. The following kinds of request are supported, as specified by the
12643
- `type`:
12644
-
12645
- - `\{\"type\": \"guest\"\}` → Creates a guest (non-authenticated) customer and returns a token for the customer.
12646
- - `\{\"type\": \"credentials\"\}` → Authenticates credentials passed in the `HTTP Authorization: Basic` request header and returns a token for a successfully authenticated customer (otherwise, it throws an `AuthenticationFailedException`). This type of request also updates profile attributes for the customer (for example, `last-visited`) and handles the maximum number of failed login attempts.
12647
- - `\{\"type\": \"refresh\"\}` → Examines the token passed in the `HTTP Authorization: Bearer` request header. If valid, a new token is returned with an updated expiry time.
12648
-
12649
- The JWT contains 3 sections:
12650
-
12651
- 1. Header: Specifies token type and algorithm used.
12652
- 2. Payload: Contains customer information, client ID, issue, and expiration time.
12653
- 3. Signature: Records the token signature.
12654
-
12655
- A token is created and returned to the client whenever a registered customer logs in (`credentials` type) or a guest customer requests it (`guest` type). The token is returned in the response header as `Authorization: Bearer --token--`.
12656
-
12657
- The client has to include the token in the request header as `Authorization: Bearer --token--` in any follow-up request. The server declines any follow-up requests without a token. The server declines any requests that cannot be verified based on the token signature or expiration time. A token nearing its expiration time should be exchanged for a new one (`refresh` type).
12402
+ * Get reset password token. This is the first step in the reset customer password flow, where a password reset token is requested for future use to reset a customer password. This call should be followed by a call to the /reset endpoint.
12658
12403
  *
12659
- * If you would like to get a raw Response object use the other authorizeCustomer function.
12404
+ * If you would like to get a raw Response object use the other getResetPasswordToken function.
12660
12405
  *
12661
12406
  * @param options - An object containing the options for this method.
12662
12407
  * @param parameters - An object containing the parameters for this method.
12663
12408
  * @param organizationId -
12664
- * @param clientId - Client ID for application identification
12665
12409
  * @param siteId -
12666
12410
  * @param headers - An object literal of key value pairs of the headers to be
12667
12411
  * sent with this request.
12668
12412
  * @param body - The data to send as the request body.
12669
12413
  *
12670
- * @returns A promise of type Customer.
12414
+ * @returns A promise of type ResetPasswordToken.
12671
12415
  *
12672
12416
  */
12673
- authorizeCustomer(options: RequireParametersUnlessAllAreOptional<{
12417
+ getResetPasswordToken(options: RequireParametersUnlessAllAreOptional<{
12674
12418
  parameters?: CompositeParameters<{
12675
12419
  organizationId: string;
12676
- clientId: string;
12677
12420
  siteId: string;
12678
12421
  } & {
12679
12422
  [key in `c_${string}`]: any;
@@ -12681,211 +12424,10 @@ declare namespace ShopperCustomersTypes {
12681
12424
  headers?: {
12682
12425
  [key: string]: string;
12683
12426
  };
12684
- body: AuthRequest;
12685
- }>): Promise<Customer>;
12427
+ body: ResetPasswordTokenRequest;
12428
+ }>): Promise<ResetPasswordToken>;
12686
12429
  /**
12687
- * 🚨 **DEPRECATION NOTICE**
12688
-
12689
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
12690
-
12691
- ---
12692
-
12693
- Obtains a new JSON Web Token (JWT) for a guest or registered
12694
- customer. Tokens are returned as an HTTP `Authorization: Bearer` response
12695
- header entry. The following kinds of request are supported, as specified by the
12696
- `type`:
12697
-
12698
- - `\{\"type\": \"guest\"\}` → Creates a guest (non-authenticated) customer and returns a token for the customer.
12699
- - `\{\"type\": \"credentials\"\}` → Authenticates credentials passed in the `HTTP Authorization: Basic` request header and returns a token for a successfully authenticated customer (otherwise, it throws an `AuthenticationFailedException`). This type of request also updates profile attributes for the customer (for example, `last-visited`) and handles the maximum number of failed login attempts.
12700
- - `\{\"type\": \"refresh\"\}` → Examines the token passed in the `HTTP Authorization: Bearer` request header. If valid, a new token is returned with an updated expiry time.
12701
-
12702
- The JWT contains 3 sections:
12703
-
12704
- 1. Header: Specifies token type and algorithm used.
12705
- 2. Payload: Contains customer information, client ID, issue, and expiration time.
12706
- 3. Signature: Records the token signature.
12707
-
12708
- A token is created and returned to the client whenever a registered customer logs in (`credentials` type) or a guest customer requests it (`guest` type). The token is returned in the response header as `Authorization: Bearer --token--`.
12709
-
12710
- The client has to include the token in the request header as `Authorization: Bearer --token--` in any follow-up request. The server declines any follow-up requests without a token. The server declines any requests that cannot be verified based on the token signature or expiration time. A token nearing its expiration time should be exchanged for a new one (`refresh` type).
12711
- *
12712
- * @param options - An object containing the options for this method.
12713
- * @param parameters - An object containing the parameters for this method.
12714
- * @param organizationId -
12715
- * @param clientId - Client ID for application identification
12716
- * @param siteId -
12717
- * @param headers - An object literal of key value pairs of the headers to be
12718
- * sent with this request.
12719
- * @param body - The data to send as the request body.
12720
- * @param rawResponse - Set to true to return entire Response object instead of DTO.
12721
- * @returns A promise of type Response if rawResponse is true, a promise of type Customer otherwise.
12722
- *
12723
- */
12724
- authorizeCustomer<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
12725
- parameters?: CompositeParameters<{
12726
- organizationId: string;
12727
- clientId: string;
12728
- siteId: string;
12729
- } & {
12730
- [key in `c_${string}`]: any;
12731
- }, ConfigParameters>;
12732
- headers?: {
12733
- [key: string]: string;
12734
- };
12735
- body: AuthRequest;
12736
- }>, rawResponse?: T): Promise<T extends true ? Response : Customer>;
12737
- /**
12738
- * 🚨 **DEPRECATION NOTICE**
12739
-
12740
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
12741
-
12742
- ---
12743
-
12744
- Obtain the JSON Web Token (JWT) for registered customers whose credentials are stored using a third party system. Accepts `loginId` and
12745
- `clientId`, returns a customer object in the response body and the JWT generated against the `clientId` in the response header.
12746
- *
12747
- * If you would like to get a raw Response object use the other authorizeTrustedSystem function.
12748
- *
12749
- * @param options - An object containing the options for this method.
12750
- * @param parameters - An object containing the parameters for this method.
12751
- * @param organizationId -
12752
- * @param siteId -
12753
- * @param headers - An object literal of key value pairs of the headers to be
12754
- * sent with this request.
12755
- * @param body - The data to send as the request body.
12756
- *
12757
- * @returns A promise of type Customer.
12758
- *
12759
- */
12760
- authorizeTrustedSystem(options: RequireParametersUnlessAllAreOptional<{
12761
- parameters?: CompositeParameters<{
12762
- organizationId: string;
12763
- siteId: string;
12764
- } & {
12765
- [key in `c_${string}`]: any;
12766
- }, ConfigParameters>;
12767
- headers?: {
12768
- [key: string]: string;
12769
- };
12770
- body: TrustedSystemAuthRequest;
12771
- }>): Promise<Customer>;
12772
- /**
12773
- * 🚨 **DEPRECATION NOTICE**
12774
-
12775
- To enhance the security and availability of Salesforce services, this endpoint is now **deprecated**, and **we plan to remove it in mid-2022**. This endpoint is not available to new customers, and we discourage existing customers from using it. Instead, we strongly recommend using the endpoints of the [Shopper Login and API Access Service](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary) (SLAS) because they meet our rigorous standards for security and availability.
12776
-
12777
- ---
12778
-
12779
- Obtain the JSON Web Token (JWT) for registered customers whose credentials are stored using a third party system. Accepts `loginId` and
12780
- `clientId`, returns a customer object in the response body and the JWT generated against the `clientId` in the response header.
12781
- *
12782
- * @param options - An object containing the options for this method.
12783
- * @param parameters - An object containing the parameters for this method.
12784
- * @param organizationId -
12785
- * @param siteId -
12786
- * @param headers - An object literal of key value pairs of the headers to be
12787
- * sent with this request.
12788
- * @param body - The data to send as the request body.
12789
- * @param rawResponse - Set to true to return entire Response object instead of DTO.
12790
- * @returns A promise of type Response if rawResponse is true, a promise of type Customer otherwise.
12791
- *
12792
- */
12793
- authorizeTrustedSystem<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
12794
- parameters?: CompositeParameters<{
12795
- organizationId: string;
12796
- siteId: string;
12797
- } & {
12798
- [key in `c_${string}`]: any;
12799
- }, ConfigParameters>;
12800
- headers?: {
12801
- [key: string]: string;
12802
- };
12803
- body: TrustedSystemAuthRequest;
12804
- }>, rawResponse?: T): Promise<T extends true ? Response : Customer>;
12805
- /**
12806
- * Reset customer password, after obtaining a reset token. This is the second step in the reset customer password flow, where a customer password is reset by providing the new credentials along with a reset token. This call should be preceded by a call to the /create-reset-token endpoint.
12807
- *
12808
- * If you would like to get a raw Response object use the other resetPassword function.
12809
- *
12810
- * @param options - An object containing the options for this method.
12811
- * @param parameters - An object containing the parameters for this method.
12812
- * @param organizationId -
12813
- * @param siteId -
12814
- * @param headers - An object literal of key value pairs of the headers to be
12815
- * sent with this request.
12816
- * @param body - The data to send as the request body.
12817
- *
12818
- * @returns A promise of type void.
12819
- *
12820
- */
12821
- resetPassword(options: RequireParametersUnlessAllAreOptional<{
12822
- parameters?: CompositeParameters<{
12823
- organizationId: string;
12824
- siteId: string;
12825
- } & {
12826
- [key in `c_${string}`]: any;
12827
- }, ConfigParameters>;
12828
- headers?: {
12829
- [key: string]: string;
12830
- };
12831
- body: ResetPasswordRequest;
12832
- }>): Promise<void>;
12833
- /**
12834
- * Reset customer password, after obtaining a reset token. This is the second step in the reset customer password flow, where a customer password is reset by providing the new credentials along with a reset token. This call should be preceded by a call to the /create-reset-token endpoint.
12835
- *
12836
- * @param options - An object containing the options for this method.
12837
- * @param parameters - An object containing the parameters for this method.
12838
- * @param organizationId -
12839
- * @param siteId -
12840
- * @param headers - An object literal of key value pairs of the headers to be
12841
- * sent with this request.
12842
- * @param body - The data to send as the request body.
12843
- * @param rawResponse - Set to true to return entire Response object instead of DTO.
12844
- * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
12845
- *
12846
- */
12847
- resetPassword<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
12848
- parameters?: CompositeParameters<{
12849
- organizationId: string;
12850
- siteId: string;
12851
- } & {
12852
- [key in `c_${string}`]: any;
12853
- }, ConfigParameters>;
12854
- headers?: {
12855
- [key: string]: string;
12856
- };
12857
- body: ResetPasswordRequest;
12858
- }>, rawResponse?: T): Promise<T extends true ? Response : void>;
12859
- /**
12860
- * Get reset password token. This is the first step in the reset customer password flow, where a password reset token is requested for future use to reset a customer password. This call should be followed by a call to the /reset endpoint.
12861
- *
12862
- * If you would like to get a raw Response object use the other getResetPasswordToken function.
12863
- *
12864
- * @param options - An object containing the options for this method.
12865
- * @param parameters - An object containing the parameters for this method.
12866
- * @param organizationId -
12867
- * @param siteId -
12868
- * @param headers - An object literal of key value pairs of the headers to be
12869
- * sent with this request.
12870
- * @param body - The data to send as the request body.
12871
- *
12872
- * @returns A promise of type ResetPasswordToken.
12873
- *
12874
- */
12875
- getResetPasswordToken(options: RequireParametersUnlessAllAreOptional<{
12876
- parameters?: CompositeParameters<{
12877
- organizationId: string;
12878
- siteId: string;
12879
- } & {
12880
- [key in `c_${string}`]: any;
12881
- }, ConfigParameters>;
12882
- headers?: {
12883
- [key: string]: string;
12884
- };
12885
- body: ResetPasswordTokenRequest;
12886
- }>): Promise<ResetPasswordToken>;
12887
- /**
12888
- * Get reset password token. This is the first step in the reset customer password flow, where a password reset token is requested for future use to reset a customer password. This call should be followed by a call to the /reset endpoint.
12430
+ * Get reset password token. This is the first step in the reset customer password flow, where a password reset token is requested for future use to reset a customer password. This call should be followed by a call to the /reset endpoint.
12889
12431
  *
12890
12432
  * @param options - An object containing the options for this method.
12891
12433
  * @param parameters - An object containing the parameters for this method.
@@ -13433,7 +12975,7 @@ declare namespace ShopperCustomersTypes {
13433
12975
  * @param parameters - An object containing the parameters for this method.
13434
12976
  * @param organizationId -
13435
12977
  * @param customerId - The customer ID.
13436
- * @param crossSites -
12978
+ * @param crossSites - The flag indicating whether all sites should be searched. This flag is ignored unless a valid User / Agent is present with a trusted agent on behalf (TAOB) token. Without a TAOB token, only the customer's orders placed on the site specified by siteId are returned.
13437
12979
  * @param from -
13438
12980
  * @param until -
13439
12981
  * @param status -
@@ -13471,7 +13013,7 @@ declare namespace ShopperCustomersTypes {
13471
13013
  * @param parameters - An object containing the parameters for this method.
13472
13014
  * @param organizationId -
13473
13015
  * @param customerId - The customer ID.
13474
- * @param crossSites -
13016
+ * @param crossSites - The flag indicating whether all sites should be searched. This flag is ignored unless a valid User / Agent is present with a trusted agent on behalf (TAOB) token. Without a TAOB token, only the customer's orders placed on the site specified by siteId are returned.
13475
13017
  * @param from -
13476
13018
  * @param until -
13477
13019
  * @param status -
@@ -16620,7 +16162,7 @@ type RangeFilter$4 = {
16620
16162
  [key: string]: any;
16621
16163
  };
16622
16164
  type BoolFilter$4 = {
16623
- filters?: Array<any>;
16165
+ filters?: Array<Filter$3>;
16624
16166
  operator: string;
16625
16167
  } & {
16626
16168
  [key: string]: any;
@@ -16629,13 +16171,13 @@ type MatchAllQuery$4 = {} & {
16629
16171
  [key: string]: any;
16630
16172
  };
16631
16173
  type FilteredQuery$4 = {
16632
- filter: any;
16633
- query: any;
16174
+ filter: Filter$3;
16175
+ query: Query$3;
16634
16176
  } & {
16635
16177
  [key: string]: any;
16636
16178
  };
16637
16179
  type QueryFilter$4 = {
16638
- query: any;
16180
+ query: Query$3;
16639
16181
  } & {
16640
16182
  [key: string]: any;
16641
16183
  };
@@ -16681,15 +16223,15 @@ type Range2Filter$4 = {
16681
16223
  [key: string]: any;
16682
16224
  };
16683
16225
  type BoolQuery$4 = {
16684
- must?: Array<any>;
16685
- mustNot?: Array<any>;
16686
- should?: Array<any>;
16226
+ must?: Array<Query$4>;
16227
+ mustNot?: Array<Query$4>;
16228
+ should?: Array<Query$4>;
16687
16229
  } & {
16688
16230
  [key: string]: any;
16689
16231
  };
16690
16232
  type NestedQuery$4 = {
16691
16233
  path: string;
16692
- query: any;
16234
+ query: Query$4;
16693
16235
  scoreMode?: string;
16694
16236
  } & {
16695
16237
  [key: string]: any;
@@ -16758,7 +16300,7 @@ type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters &
16758
16300
  * ```
16759
16301
  *
16760
16302
  * <span style="font-size:.7em; display:block; text-align: right">
16761
- * API Version: 1.0.12<br />
16303
+ * API Version: 1.0.15<br />
16762
16304
  * Last Updated: <br />
16763
16305
  * </span>
16764
16306
 
@@ -16989,7 +16531,7 @@ declare namespace ShopperGiftCertificatesTypes {
16989
16531
  };
16990
16532
  type SearchRequest = {
16991
16533
  limit?: number;
16992
- query: any;
16534
+ query: Query$4;
16993
16535
  sorts?: Array<Sort$4>;
16994
16536
  offset?: any;
16995
16537
  } & {
@@ -17023,7 +16565,7 @@ declare namespace ShopperGiftCertificatesTypes {
17023
16565
  [key: string]: any;
17024
16566
  };
17025
16567
  type PaginatedSearchResult = {
17026
- query: any;
16568
+ query: Query$4;
17027
16569
  sorts?: Array<Sort$4>;
17028
16570
  limit: number;
17029
16571
  hits?: Array<object>;
@@ -17043,13 +16585,13 @@ declare namespace ShopperGiftCertificatesTypes {
17043
16585
  [key: string]: any;
17044
16586
  };
17045
16587
  type BoolFilter = {
17046
- filters?: Array<any>;
16588
+ filters?: Array<Filter$4>;
17047
16589
  operator: string;
17048
16590
  } & {
17049
16591
  [key: string]: any;
17050
16592
  };
17051
16593
  type PaginatedSearchResultBase = {
17052
- query: any;
16594
+ query: Query$4;
17053
16595
  sorts?: Array<Sort$4>;
17054
16596
  limit: number;
17055
16597
  hits?: Array<object>;
@@ -17062,13 +16604,13 @@ declare namespace ShopperGiftCertificatesTypes {
17062
16604
  [key: string]: any;
17063
16605
  };
17064
16606
  type FilteredQuery = {
17065
- filter: any;
17066
- query: any;
16607
+ filter: Filter$4;
16608
+ query: Query$4;
17067
16609
  } & {
17068
16610
  [key: string]: any;
17069
16611
  };
17070
16612
  type QueryFilter = {
17071
- query: any;
16613
+ query: Query$4;
17072
16614
  } & {
17073
16615
  [key: string]: any;
17074
16616
  };
@@ -17114,9 +16656,9 @@ declare namespace ShopperGiftCertificatesTypes {
17114
16656
  [key: string]: any;
17115
16657
  };
17116
16658
  type BoolQuery = {
17117
- must?: Array<any>;
17118
- mustNot?: Array<any>;
17119
- should?: Array<any>;
16659
+ must?: Array<Query>;
16660
+ mustNot?: Array<Query>;
16661
+ should?: Array<Query>;
17120
16662
  } & {
17121
16663
  [key: string]: any;
17122
16664
  };
@@ -17130,7 +16672,7 @@ declare namespace ShopperGiftCertificatesTypes {
17130
16672
  };
17131
16673
  type NestedQuery = {
17132
16674
  path: string;
17133
- query: any;
16675
+ query: Query;
17134
16676
  scoreMode?: string;
17135
16677
  } & {
17136
16678
  [key: string]: any;
@@ -17152,7 +16694,7 @@ declare namespace ShopperGiftCertificatesTypes {
17152
16694
  };
17153
16695
  type SearchRequestBase = {
17154
16696
  limit?: number;
17155
- query: any;
16697
+ query: Query;
17156
16698
  sorts?: Array<Sort>;
17157
16699
  offset?: any;
17158
16700
  } & {
@@ -17235,7 +16777,7 @@ declare namespace ShopperGiftCertificatesTypes {
17235
16777
  * ```
17236
16778
  *
17237
16779
  * <span style="font-size:.7em; display:block; text-align: right">
17238
- * API Version: 1.0.12<br />
16780
+ * API Version: 1.0.15<br />
17239
16781
  * Last Updated: <br />
17240
16782
  * </span>
17241
16783
 
@@ -20419,6 +19961,7 @@ type PaymentCardSpec$0 = {
20419
19961
  name?: string;
20420
19962
  numberLengths?: Array<string>;
20421
19963
  numberPrefixes?: Array<string>;
19964
+ securityCodeLength?: number;
20422
19965
  } & {
20423
19966
  [key: string]: any;
20424
19967
  };
@@ -20674,6 +20217,7 @@ type Basket$1 = {
20674
20217
  currency?: string;
20675
20218
  customerInfo?: CustomerInfo$1;
20676
20219
  giftCertificateItems?: Array<GiftCertificateItem$0>;
20220
+ groupedTaxItems?: Array<GroupedTaxItem$0>;
20677
20221
  inventoryReservationExpiry?: any;
20678
20222
  lastModified?: any;
20679
20223
  merchandizeTotalTax?: number;
@@ -20691,9 +20235,15 @@ type Basket$1 = {
20691
20235
  sourceCode?: string;
20692
20236
  taxTotal?: number;
20693
20237
  taxation?: string;
20238
+ taxRoundedAtGroup?: boolean;
20239
+ temporaryBasket?: boolean;
20694
20240
  } & {
20695
20241
  [key: string]: any;
20696
20242
  };
20243
+ type OrderLookupRequest$0 = {
20244
+ email: string;
20245
+ orderViewCode: string;
20246
+ };
20697
20247
  type OrderPaymentInstrumentRequest$0 = {
20698
20248
  amount?: number;
20699
20249
  bankRoutingNumber?: string;
@@ -20723,6 +20273,10 @@ type ProductListLink$1 = {
20723
20273
  } & {
20724
20274
  [key: string]: any;
20725
20275
  };
20276
+ type GroupedTaxItem$1 = {
20277
+ taxRate?: number;
20278
+ taxValue?: number;
20279
+ };
20726
20280
  type Order$1 = {
20727
20281
  adjustedMerchandizeTotalTax?: number;
20728
20282
  adjustedShippingTotalTax?: number;
@@ -20740,6 +20294,8 @@ type Order$1 = {
20740
20294
  externalOrderStatus?: string;
20741
20295
  giftCertificateItems?: Array<GiftCertificateItem$1>;
20742
20296
  globalPartyId?: string;
20297
+ groupedTaxItems?: Array<GroupedTaxItem$1>;
20298
+ guest?: boolean;
20743
20299
  lastModified?: any;
20744
20300
  merchandizeTotalTax?: number;
20745
20301
  notes?: SimpleLink$1;
@@ -20747,6 +20303,7 @@ type Order$1 = {
20747
20303
  orderPriceAdjustments?: Array<PriceAdjustment$1>;
20748
20304
  orderToken?: string;
20749
20305
  orderTotal?: number;
20306
+ orderViewCode?: string;
20750
20307
  paymentInstruments?: Array<OrderPaymentInstrument$1>;
20751
20308
  paymentStatus?: string;
20752
20309
  productItems?: Array<ProductItem$1>;
@@ -20760,6 +20317,7 @@ type Order$1 = {
20760
20317
  siteId?: string;
20761
20318
  sourceCode?: string;
20762
20319
  status?: string;
20320
+ taxRoundedAtGroup?: boolean;
20763
20321
  taxTotal?: number;
20764
20322
  taxation?: string;
20765
20323
  } & {
@@ -20848,7 +20406,7 @@ type ShopperOrdersParameters = ShopperOrdersPathParameters & BaseUriParameters &
20848
20406
  * ```
20849
20407
  *
20850
20408
  * <span style="font-size:.7em; display:block; text-align: right">
20851
- * API Version: 0.3.5<br />
20409
+ * API Version: 0.4.7<br />
20852
20410
  * Last Updated: <br />
20853
20411
  * </span>
20854
20412
 
@@ -20999,14 +20557,18 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
20999
20557
  };
21000
20558
  }>, rawResponse?: T): Promise<T extends true ? Response : Order$1>;
21001
20559
  /**
21002
- * Adds a payment instrument to an order.
20560
+ * Use this endpoint to lookup a guest order.
20561
+
20562
+ **Important**: This endpoint uses the [ShopperTokenTsob](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=security%3AShopperTokenTsob) security scheme. Always check the Security section of the endpoint documentation, which is hidden by default.
20563
+
20564
+ The API uses the `orderViewCode` generated during the order creation and the `email` of the order customer to lookup a guest order. If email is not provided on the order, the field can be left blank in the lookup request.
20565
+ **Note**: In the no email on order scenario, the custom implementation must include an additional verification of an order attribute. For example, a postal code or mobile number.
20566
+
20567
+ This API can also be used for looking up an order for a registered customer. In addition to the verification steps used for guest order lookup, the API also verifies that the customer ID of the order matches with the customer ID supplied in the `ShopperTokenTsob`.
21003
20568
 
21004
- Details:
21005
20569
 
21006
- The payment instrument is added with the provided details. The payment method must be applicable for the order see GET
21007
- /baskets/\{basketId\}/payment-methods, if the payment method is 'CREDIT_CARD' a paymentCard must be specified in the request.
21008
20570
  *
21009
- * If you would like to get a raw Response object use the other createPaymentInstrumentForOrder function.
20571
+ * If you would like to get a raw Response object use the other guestOrderLookup function.
21010
20572
  *
21011
20573
  * @param options - An object containing the options for this method.
21012
20574
  * @param parameters - An object containing the parameters for this method.
@@ -21026,7 +20588,7 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
21026
20588
  * @returns A promise of type Order.
21027
20589
  *
21028
20590
  */
21029
- createPaymentInstrumentForOrder(options: RequireParametersUnlessAllAreOptional<{
20591
+ guestOrderLookup(options: RequireParametersUnlessAllAreOptional<{
21030
20592
  parameters?: CompositeParameters<{
21031
20593
  organizationId: string;
21032
20594
  orderNo: string;
@@ -21038,15 +20600,19 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
21038
20600
  headers?: {
21039
20601
  [key: string]: string;
21040
20602
  };
21041
- body: OrderPaymentInstrumentRequest$0;
20603
+ body: OrderLookupRequest$0;
21042
20604
  }>): Promise<Order$1>;
21043
20605
  /**
21044
- * Adds a payment instrument to an order.
20606
+ * Use this endpoint to lookup a guest order.
20607
+
20608
+ **Important**: This endpoint uses the [ShopperTokenTsob](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=security%3AShopperTokenTsob) security scheme. Always check the Security section of the endpoint documentation, which is hidden by default.
20609
+
20610
+ The API uses the `orderViewCode` generated during the order creation and the `email` of the order customer to lookup a guest order. If email is not provided on the order, the field can be left blank in the lookup request.
20611
+ **Note**: In the no email on order scenario, the custom implementation must include an additional verification of an order attribute. For example, a postal code or mobile number.
20612
+
20613
+ This API can also be used for looking up an order for a registered customer. In addition to the verification steps used for guest order lookup, the API also verifies that the customer ID of the order matches with the customer ID supplied in the `ShopperTokenTsob`.
21045
20614
 
21046
- Details:
21047
20615
 
21048
- The payment instrument is added with the provided details. The payment method must be applicable for the order see GET
21049
- /baskets/\{basketId\}/payment-methods, if the payment method is 'CREDIT_CARD' a paymentCard must be specified in the request.
21050
20616
  *
21051
20617
  * @param options - An object containing the options for this method.
21052
20618
  * @param parameters - An object containing the parameters for this method.
@@ -21066,7 +20632,7 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
21066
20632
  * @returns A promise of type Response if rawResponse is true, a promise of type Order otherwise.
21067
20633
  *
21068
20634
  */
21069
- createPaymentInstrumentForOrder<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
20635
+ guestOrderLookup<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
21070
20636
  parameters?: CompositeParameters<{
21071
20637
  organizationId: string;
21072
20638
  orderNo: string;
@@ -21078,18 +20644,22 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
21078
20644
  headers?: {
21079
20645
  [key: string]: string;
21080
20646
  };
21081
- body: OrderPaymentInstrumentRequest$0;
20647
+ body: OrderLookupRequest$0;
21082
20648
  }>, rawResponse?: T): Promise<T extends true ? Response : Order$1>;
21083
20649
  /**
21084
- * Removes a payment instrument of an order.
20650
+ * Adds a payment instrument to an order.
20651
+
20652
+ Details:
20653
+
20654
+ The payment instrument is added with the provided details. The payment method must be applicable for the order see GET
20655
+ /baskets/\{basketId\}/payment-methods, if the payment method is 'CREDIT_CARD' a paymentCard must be specified in the request.
21085
20656
  *
21086
- * If you would like to get a raw Response object use the other removePaymentInstrumentFromOrder function.
20657
+ * If you would like to get a raw Response object use the other createPaymentInstrumentForOrder function.
21087
20658
  *
21088
20659
  * @param options - An object containing the options for this method.
21089
20660
  * @param parameters - An object containing the parameters for this method.
21090
20661
  * @param organizationId - An identifier for the organization the request is being made by.
21091
20662
  * @param orderNo - The order number of the order to be modified.
21092
- * @param paymentInstrumentId - The ID of the payment instrument to be updated.
21093
20663
  * @param siteId -
21094
20664
  * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
21095
20665
  Below are some valid examples:
@@ -21099,15 +20669,15 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
21099
20669
  - default
21100
20670
  * @param headers - An object literal of key value pairs of the headers to be
21101
20671
  * sent with this request.
20672
+ * @param body - The data to send as the request body.
21102
20673
  *
21103
20674
  * @returns A promise of type Order.
21104
20675
  *
21105
20676
  */
21106
- removePaymentInstrumentFromOrder(options?: RequireParametersUnlessAllAreOptional<{
20677
+ createPaymentInstrumentForOrder(options: RequireParametersUnlessAllAreOptional<{
21107
20678
  parameters?: CompositeParameters<{
21108
20679
  organizationId: string;
21109
20680
  orderNo: string;
21110
- paymentInstrumentId: string;
21111
20681
  siteId: string;
21112
20682
  locale?: string;
21113
20683
  } & {
@@ -21116,15 +20686,20 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
21116
20686
  headers?: {
21117
20687
  [key: string]: string;
21118
20688
  };
20689
+ body: OrderPaymentInstrumentRequest$0;
21119
20690
  }>): Promise<Order$1>;
21120
20691
  /**
21121
- * Removes a payment instrument of an order.
20692
+ * Adds a payment instrument to an order.
20693
+
20694
+ Details:
20695
+
20696
+ The payment instrument is added with the provided details. The payment method must be applicable for the order see GET
20697
+ /baskets/\{basketId\}/payment-methods, if the payment method is 'CREDIT_CARD' a paymentCard must be specified in the request.
21122
20698
  *
21123
20699
  * @param options - An object containing the options for this method.
21124
20700
  * @param parameters - An object containing the parameters for this method.
21125
20701
  * @param organizationId - An identifier for the organization the request is being made by.
21126
20702
  * @param orderNo - The order number of the order to be modified.
21127
- * @param paymentInstrumentId - The ID of the payment instrument to be updated.
21128
20703
  * @param siteId -
21129
20704
  * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
21130
20705
  Below are some valid examples:
@@ -21134,15 +20709,15 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
21134
20709
  - default
21135
20710
  * @param headers - An object literal of key value pairs of the headers to be
21136
20711
  * sent with this request.
20712
+ * @param body - The data to send as the request body.
21137
20713
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
21138
20714
  * @returns A promise of type Response if rawResponse is true, a promise of type Order otherwise.
21139
20715
  *
21140
20716
  */
21141
- removePaymentInstrumentFromOrder<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
20717
+ createPaymentInstrumentForOrder<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
21142
20718
  parameters?: CompositeParameters<{
21143
20719
  organizationId: string;
21144
20720
  orderNo: string;
21145
- paymentInstrumentId: string;
21146
20721
  siteId: string;
21147
20722
  locale?: string;
21148
20723
  } & {
@@ -21151,17 +20726,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
21151
20726
  headers?: {
21152
20727
  [key: string]: string;
21153
20728
  };
20729
+ body: OrderPaymentInstrumentRequest$0;
21154
20730
  }>, rawResponse?: T): Promise<T extends true ? Response : Order$1>;
21155
20731
  /**
21156
- * Updates a payment instrument of an order.
21157
-
21158
- Details:
21159
-
21160
- The payment instrument is updated with the provided details. The payment method must be applicable for the
21161
- order see GET /baskets/\{basketId\}/payment-methods, if the payment method is 'CREDIT_CARD' a
21162
- paymentCard must be specified in the request.
20732
+ * Removes a payment instrument of an order.
21163
20733
  *
21164
- * If you would like to get a raw Response object use the other updatePaymentInstrumentForOrder function.
20734
+ * If you would like to get a raw Response object use the other removePaymentInstrumentFromOrder function.
21165
20735
  *
21166
20736
  * @param options - An object containing the options for this method.
21167
20737
  * @param parameters - An object containing the parameters for this method.
@@ -21177,12 +20747,90 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
21177
20747
  - default
21178
20748
  * @param headers - An object literal of key value pairs of the headers to be
21179
20749
  * sent with this request.
21180
- * @param body - The data to send as the request body.
21181
20750
  *
21182
20751
  * @returns A promise of type Order.
21183
20752
  *
21184
20753
  */
21185
- updatePaymentInstrumentForOrder(options: RequireParametersUnlessAllAreOptional<{
20754
+ removePaymentInstrumentFromOrder(options?: RequireParametersUnlessAllAreOptional<{
20755
+ parameters?: CompositeParameters<{
20756
+ organizationId: string;
20757
+ orderNo: string;
20758
+ paymentInstrumentId: string;
20759
+ siteId: string;
20760
+ locale?: string;
20761
+ } & {
20762
+ [key in `c_${string}`]: any;
20763
+ }, ConfigParameters>;
20764
+ headers?: {
20765
+ [key: string]: string;
20766
+ };
20767
+ }>): Promise<Order$1>;
20768
+ /**
20769
+ * Removes a payment instrument of an order.
20770
+ *
20771
+ * @param options - An object containing the options for this method.
20772
+ * @param parameters - An object containing the parameters for this method.
20773
+ * @param organizationId - An identifier for the organization the request is being made by.
20774
+ * @param orderNo - The order number of the order to be modified.
20775
+ * @param paymentInstrumentId - The ID of the payment instrument to be updated.
20776
+ * @param siteId -
20777
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
20778
+ Below are some valid examples:
20779
+ - en-US
20780
+ - de-AT
20781
+ - de
20782
+ - default
20783
+ * @param headers - An object literal of key value pairs of the headers to be
20784
+ * sent with this request.
20785
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
20786
+ * @returns A promise of type Response if rawResponse is true, a promise of type Order otherwise.
20787
+ *
20788
+ */
20789
+ removePaymentInstrumentFromOrder<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
20790
+ parameters?: CompositeParameters<{
20791
+ organizationId: string;
20792
+ orderNo: string;
20793
+ paymentInstrumentId: string;
20794
+ siteId: string;
20795
+ locale?: string;
20796
+ } & {
20797
+ [key in `c_${string}`]: any;
20798
+ }, ConfigParameters>;
20799
+ headers?: {
20800
+ [key: string]: string;
20801
+ };
20802
+ }>, rawResponse?: T): Promise<T extends true ? Response : Order$1>;
20803
+ /**
20804
+ * Updates a payment instrument of an order.
20805
+
20806
+ Details:
20807
+
20808
+ The payment instrument is updated with the provided details. The payment method must be applicable for the
20809
+ order see GET /baskets/\{basketId\}/payment-methods, if the payment method is 'CREDIT_CARD' a
20810
+ paymentCard must be specified in the request.
20811
+ *
20812
+ * If you would like to get a raw Response object use the other updatePaymentInstrumentForOrder function.
20813
+ *
20814
+ * @param options - An object containing the options for this method.
20815
+ * @param parameters - An object containing the parameters for this method.
20816
+ * @param organizationId - An identifier for the organization the request is being made by.
20817
+ * @param orderNo - The order number of the order to be modified.
20818
+ * @param paymentInstrumentId - The ID of the payment instrument to be updated.
20819
+ * @param siteId -
20820
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
20821
+ Below are some valid examples:
20822
+ - en-US
20823
+ - de-AT
20824
+ - de
20825
+ - default
20826
+ * @param headers - An object literal of key value pairs of the headers to be
20827
+ * sent with this request.
20828
+ * @param body - The data to send as the request body.
20829
+ *
20830
+ * @returns A promise of type Order.
20831
+ *
20832
+ */
20833
+ updatePaymentInstrumentForOrder(options: RequireParametersUnlessAllAreOptional<{
21186
20834
  parameters?: CompositeParameters<{
21187
20835
  organizationId: string;
21188
20836
  orderNo: string;
@@ -21711,6 +21359,7 @@ declare namespace ShopperOrdersTypes {
21711
21359
  name?: string;
21712
21360
  numberLengths?: Array<string>;
21713
21361
  numberPrefixes?: Array<string>;
21362
+ securityCodeLength?: number;
21714
21363
  } & {
21715
21364
  [key: string]: any;
21716
21365
  };
@@ -21737,12 +21386,6 @@ declare namespace ShopperOrdersTypes {
21737
21386
  } & {
21738
21387
  [key: string]: any;
21739
21388
  };
21740
- type BasketsResult = {
21741
- baskets: Array<Basket$1>;
21742
- total: number;
21743
- } & {
21744
- [key: string]: any;
21745
- };
21746
21389
  type PriceAdjustmentRequest = {
21747
21390
  discount?: DiscountRequest$0;
21748
21391
  itemId?: string;
@@ -22009,6 +21652,7 @@ declare namespace ShopperOrdersTypes {
22009
21652
  currency?: string;
22010
21653
  customerInfo?: CustomerInfo;
22011
21654
  giftCertificateItems?: Array<GiftCertificateItem$1>;
21655
+ groupedTaxItems?: Array<GroupedTaxItem$1>;
22012
21656
  inventoryReservationExpiry?: any;
22013
21657
  lastModified?: any;
22014
21658
  merchandizeTotalTax?: number;
@@ -22026,9 +21670,15 @@ declare namespace ShopperOrdersTypes {
22026
21670
  sourceCode?: string;
22027
21671
  taxTotal?: number;
22028
21672
  taxation?: string;
21673
+ taxRoundedAtGroup?: boolean;
21674
+ temporaryBasket?: boolean;
22029
21675
  } & {
22030
21676
  [key: string]: any;
22031
21677
  };
21678
+ type OrderLookupRequest = {
21679
+ email: string;
21680
+ orderViewCode: string;
21681
+ };
22032
21682
  type OrderPaymentInstrumentRequest = {
22033
21683
  amount?: number;
22034
21684
  bankRoutingNumber?: string;
@@ -22058,6 +21708,10 @@ declare namespace ShopperOrdersTypes {
22058
21708
  } & {
22059
21709
  [key: string]: any;
22060
21710
  };
21711
+ type GroupedTaxItem = {
21712
+ taxRate?: number;
21713
+ taxValue?: number;
21714
+ };
22061
21715
  type Order = {
22062
21716
  adjustedMerchandizeTotalTax?: number;
22063
21717
  adjustedShippingTotalTax?: number;
@@ -22075,6 +21729,8 @@ declare namespace ShopperOrdersTypes {
22075
21729
  externalOrderStatus?: string;
22076
21730
  giftCertificateItems?: Array<GiftCertificateItem>;
22077
21731
  globalPartyId?: string;
21732
+ groupedTaxItems?: Array<GroupedTaxItem>;
21733
+ guest?: boolean;
22078
21734
  lastModified?: any;
22079
21735
  merchandizeTotalTax?: number;
22080
21736
  notes?: SimpleLink;
@@ -22082,6 +21738,7 @@ declare namespace ShopperOrdersTypes {
22082
21738
  orderPriceAdjustments?: Array<PriceAdjustment>;
22083
21739
  orderToken?: string;
22084
21740
  orderTotal?: number;
21741
+ orderViewCode?: string;
22085
21742
  paymentInstruments?: Array<OrderPaymentInstrument>;
22086
21743
  paymentStatus?: string;
22087
21744
  productItems?: Array<ProductItem>;
@@ -22095,6 +21752,7 @@ declare namespace ShopperOrdersTypes {
22095
21752
  siteId?: string;
22096
21753
  sourceCode?: string;
22097
21754
  status?: string;
21755
+ taxRoundedAtGroup?: boolean;
22098
21756
  taxTotal?: number;
22099
21757
  taxation?: string;
22100
21758
  } & {
@@ -22207,7 +21865,7 @@ declare namespace ShopperOrdersTypes {
22207
21865
  * ```
22208
21866
  *
22209
21867
  * <span style="font-size:.7em; display:block; text-align: right">
22210
- * API Version: 0.3.5<br />
21868
+ * API Version: 0.4.7<br />
22211
21869
  * Last Updated: <br />
22212
21870
  * </span>
22213
21871
 
@@ -22357,6 +22015,96 @@ declare namespace ShopperOrdersTypes {
22357
22015
  [key: string]: string;
22358
22016
  };
22359
22017
  }>, rawResponse?: T): Promise<T extends true ? Response : Order>;
22018
+ /**
22019
+ * Use this endpoint to lookup a guest order.
22020
+
22021
+ **Important**: This endpoint uses the [ShopperTokenTsob](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=security%3AShopperTokenTsob) security scheme. Always check the Security section of the endpoint documentation, which is hidden by default.
22022
+
22023
+ The API uses the `orderViewCode` generated during the order creation and the `email` of the order customer to lookup a guest order. If email is not provided on the order, the field can be left blank in the lookup request.
22024
+ **Note**: In the no email on order scenario, the custom implementation must include an additional verification of an order attribute. For example, a postal code or mobile number.
22025
+
22026
+ This API can also be used for looking up an order for a registered customer. In addition to the verification steps used for guest order lookup, the API also verifies that the customer ID of the order matches with the customer ID supplied in the `ShopperTokenTsob`.
22027
+
22028
+
22029
+ *
22030
+ * If you would like to get a raw Response object use the other guestOrderLookup function.
22031
+ *
22032
+ * @param options - An object containing the options for this method.
22033
+ * @param parameters - An object containing the parameters for this method.
22034
+ * @param organizationId - An identifier for the organization the request is being made by.
22035
+ * @param orderNo - The order number of the order to be modified.
22036
+ * @param siteId -
22037
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
22038
+ Below are some valid examples:
22039
+ - en-US
22040
+ - de-AT
22041
+ - de
22042
+ - default
22043
+ * @param headers - An object literal of key value pairs of the headers to be
22044
+ * sent with this request.
22045
+ * @param body - The data to send as the request body.
22046
+ *
22047
+ * @returns A promise of type Order.
22048
+ *
22049
+ */
22050
+ guestOrderLookup(options: RequireParametersUnlessAllAreOptional<{
22051
+ parameters?: CompositeParameters<{
22052
+ organizationId: string;
22053
+ orderNo: string;
22054
+ siteId: string;
22055
+ locale?: string;
22056
+ } & {
22057
+ [key in `c_${string}`]: any;
22058
+ }, ConfigParameters>;
22059
+ headers?: {
22060
+ [key: string]: string;
22061
+ };
22062
+ body: OrderLookupRequest;
22063
+ }>): Promise<Order>;
22064
+ /**
22065
+ * Use this endpoint to lookup a guest order.
22066
+
22067
+ **Important**: This endpoint uses the [ShopperTokenTsob](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=security%3AShopperTokenTsob) security scheme. Always check the Security section of the endpoint documentation, which is hidden by default.
22068
+
22069
+ The API uses the `orderViewCode` generated during the order creation and the `email` of the order customer to lookup a guest order. If email is not provided on the order, the field can be left blank in the lookup request.
22070
+ **Note**: In the no email on order scenario, the custom implementation must include an additional verification of an order attribute. For example, a postal code or mobile number.
22071
+
22072
+ This API can also be used for looking up an order for a registered customer. In addition to the verification steps used for guest order lookup, the API also verifies that the customer ID of the order matches with the customer ID supplied in the `ShopperTokenTsob`.
22073
+
22074
+
22075
+ *
22076
+ * @param options - An object containing the options for this method.
22077
+ * @param parameters - An object containing the parameters for this method.
22078
+ * @param organizationId - An identifier for the organization the request is being made by.
22079
+ * @param orderNo - The order number of the order to be modified.
22080
+ * @param siteId -
22081
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
22082
+ Below are some valid examples:
22083
+ - en-US
22084
+ - de-AT
22085
+ - de
22086
+ - default
22087
+ * @param headers - An object literal of key value pairs of the headers to be
22088
+ * sent with this request.
22089
+ * @param body - The data to send as the request body.
22090
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
22091
+ * @returns A promise of type Response if rawResponse is true, a promise of type Order otherwise.
22092
+ *
22093
+ */
22094
+ guestOrderLookup<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
22095
+ parameters?: CompositeParameters<{
22096
+ organizationId: string;
22097
+ orderNo: string;
22098
+ siteId: string;
22099
+ locale?: string;
22100
+ } & {
22101
+ [key in `c_${string}`]: any;
22102
+ }, ConfigParameters>;
22103
+ headers?: {
22104
+ [key: string]: string;
22105
+ };
22106
+ body: OrderLookupRequest;
22107
+ }>, rawResponse?: T): Promise<T extends true ? Response : Order>;
22360
22108
  /**
22361
22109
  * Adds a payment instrument to an order.
22362
22110
 
@@ -22766,6 +22514,7 @@ type Category = {
22766
22514
  id: string;
22767
22515
  image?: string;
22768
22516
  name?: string;
22517
+ onlineSubCategoriesCount?: any;
22769
22518
  pageDescription?: string;
22770
22519
  pageKeywords?: string;
22771
22520
  pageTitle?: string;
@@ -23100,10 +22849,10 @@ type ShopperProductsQueryParameters = {
23100
22849
  */
23101
22850
  type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParameters & ShopperProductsQueryParameters;
23102
22851
  /**
23103
- * [](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=:Summary)
22852
+ * [Shopper Products](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-products:Summary)
23104
22853
  * ==================================
23105
22854
  *
23106
- * **<br />
22855
+ * *Display product details across your storefront.*<br />
23107
22856
  *
23108
22857
  * Simple example:
23109
22858
  *
@@ -23122,7 +22871,7 @@ type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParamete
23122
22871
  * ```
23123
22872
  *
23124
22873
  * <span style="font-size:.7em; display:block; text-align: right">
23125
- * API Version: <br />
22874
+ * API Version: 0.0.32<br />
23126
22875
  * Last Updated: <br />
23127
22876
  * </span>
23128
22877
 
@@ -23144,7 +22893,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
23144
22893
  * @param options - An object containing the options for this method.
23145
22894
  * @param parameters - An object containing the parameters for this method.
23146
22895
  * @param organizationId -
23147
- * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations.The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
22896
+ * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
23148
22897
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
23149
22898
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
23150
22899
  * @param currency - The currency mnemonic specified for price.
@@ -23184,7 +22933,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
23184
22933
  * @param options - An object containing the options for this method.
23185
22934
  * @param parameters - An object containing the parameters for this method.
23186
22935
  * @param organizationId -
23187
- * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations.The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
22936
+ * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
23188
22937
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
23189
22938
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
23190
22939
  * @param currency - The currency mnemonic specified for price.
@@ -23227,7 +22976,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
23227
22976
  * @param parameters - An object containing the parameters for this method.
23228
22977
  * @param organizationId -
23229
22978
  * @param id - The ID of the requested product.
23230
- * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations. The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
22979
+ * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
23231
22980
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
23232
22981
  * @param currency - The currency mnemonic specified for price.
23233
22982
  * @param expand - The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations). All expand parameters are used for the request when no expand parameter is provided. The value "none" may be used to turn off all expand options.
@@ -23267,7 +23016,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
23267
23016
  * @param parameters - An object containing the parameters for this method.
23268
23017
  * @param organizationId -
23269
23018
  * @param id - The ID of the requested product.
23270
- * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations. The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
23019
+ * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
23271
23020
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
23272
23021
  * @param currency - The currency mnemonic specified for price.
23273
23022
  * @param expand - The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations). All expand parameters are used for the request when no expand parameter is provided. The value "none" may be used to turn off all expand options.
@@ -23559,6 +23308,7 @@ declare namespace ShopperProductsTypes {
23559
23308
  id: string;
23560
23309
  image?: string;
23561
23310
  name?: string;
23311
+ onlineSubCategoriesCount?: any;
23562
23312
  pageDescription?: string;
23563
23313
  pageKeywords?: string;
23564
23314
  pageTitle?: string;
@@ -24048,10 +23798,10 @@ declare namespace ShopperProductsTypes {
24048
23798
  */
24049
23799
  type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParameters & ShopperProductsQueryParameters;
24050
23800
  /**
24051
- * [](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=:Summary)
23801
+ * [Shopper Products](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-products:Summary)
24052
23802
  * ==================================
24053
23803
  *
24054
- * **<br />
23804
+ * *Display product details across your storefront.*<br />
24055
23805
  *
24056
23806
  * Simple example:
24057
23807
  *
@@ -24070,7 +23820,7 @@ declare namespace ShopperProductsTypes {
24070
23820
  * ```
24071
23821
  *
24072
23822
  * <span style="font-size:.7em; display:block; text-align: right">
24073
- * API Version: <br />
23823
+ * API Version: 0.0.32<br />
24074
23824
  * Last Updated: <br />
24075
23825
  * </span>
24076
23826
 
@@ -24092,7 +23842,7 @@ declare namespace ShopperProductsTypes {
24092
23842
  * @param options - An object containing the options for this method.
24093
23843
  * @param parameters - An object containing the parameters for this method.
24094
23844
  * @param organizationId -
24095
- * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations.The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
23845
+ * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
24096
23846
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
24097
23847
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
24098
23848
  * @param currency - The currency mnemonic specified for price.
@@ -24132,7 +23882,7 @@ declare namespace ShopperProductsTypes {
24132
23882
  * @param options - An object containing the options for this method.
24133
23883
  * @param parameters - An object containing the parameters for this method.
24134
23884
  * @param organizationId -
24135
- * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations.The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
23885
+ * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
24136
23886
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
24137
23887
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
24138
23888
  * @param currency - The currency mnemonic specified for price.
@@ -24175,7 +23925,7 @@ declare namespace ShopperProductsTypes {
24175
23925
  * @param parameters - An object containing the parameters for this method.
24176
23926
  * @param organizationId -
24177
23927
  * @param id - The ID of the requested product.
24178
- * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations. The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
23928
+ * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
24179
23929
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
24180
23930
  * @param currency - The currency mnemonic specified for price.
24181
23931
  * @param expand - The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations). All expand parameters are used for the request when no expand parameter is provided. The value "none" may be used to turn off all expand options.
@@ -24215,7 +23965,7 @@ declare namespace ShopperProductsTypes {
24215
23965
  * @param parameters - An object containing the parameters for this method.
24216
23966
  * @param organizationId -
24217
23967
  * @param id - The ID of the requested product.
24218
- * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations. The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
23968
+ * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
24219
23969
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
24220
23970
  * @param currency - The currency mnemonic specified for price.
24221
23971
  * @param expand - The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations). All expand parameters are used for the request when no expand parameter is provided. The value "none" may be used to turn off all expand options.
@@ -24391,7 +24141,7 @@ type Promotion = {
24391
24141
  [key: string]: any;
24392
24142
  };
24393
24143
  type PromotionResult = {
24394
- count: number;
24144
+ limit: number;
24395
24145
  data: Array<Promotion>;
24396
24146
  total: number;
24397
24147
  } & {
@@ -24401,7 +24151,7 @@ type RangeFilter$8 = {
24401
24151
  [key: string]: any;
24402
24152
  };
24403
24153
  type BoolFilter$8 = {
24404
- filters?: Array<any>;
24154
+ filters?: Array<Filter$7>;
24405
24155
  operator: string;
24406
24156
  } & {
24407
24157
  [key: string]: any;
@@ -24410,13 +24160,13 @@ type MatchAllQuery$8 = {} & {
24410
24160
  [key: string]: any;
24411
24161
  };
24412
24162
  type FilteredQuery$8 = {
24413
- filter: any;
24414
- query: any;
24163
+ filter: Filter$7;
24164
+ query: Query$7;
24415
24165
  } & {
24416
24166
  [key: string]: any;
24417
24167
  };
24418
24168
  type QueryFilter$8 = {
24419
- query: any;
24169
+ query: Query$7;
24420
24170
  } & {
24421
24171
  [key: string]: any;
24422
24172
  };
@@ -24462,15 +24212,15 @@ type Range2Filter$8 = {
24462
24212
  [key: string]: any;
24463
24213
  };
24464
24214
  type BoolQuery$8 = {
24465
- must?: Array<any>;
24466
- mustNot?: Array<any>;
24467
- should?: Array<any>;
24215
+ must?: Array<Query$8>;
24216
+ mustNot?: Array<Query$8>;
24217
+ should?: Array<Query$8>;
24468
24218
  } & {
24469
24219
  [key: string]: any;
24470
24220
  };
24471
24221
  type NestedQuery$8 = {
24472
24222
  path: string;
24473
- query: any;
24223
+ query: Query$8;
24474
24224
  scoreMode?: string;
24475
24225
  } & {
24476
24226
  [key: string]: any;
@@ -24545,7 +24295,7 @@ type ShopperPromotionsParameters = ShopperPromotionsPathParameters & BaseUriPara
24545
24295
  * ```
24546
24296
  *
24547
24297
  * <span style="font-size:.7em; display:block; text-align: right">
24548
- * API Version: 1.0.21<br />
24298
+ * API Version: 1.0.25<br />
24549
24299
  * Last Updated: <br />
24550
24300
  * </span>
24551
24301
 
@@ -24796,7 +24546,7 @@ declare namespace ShopperPromotionsTypes {
24796
24546
  [key: string]: any;
24797
24547
  };
24798
24548
  type PromotionResult = {
24799
- count: number;
24549
+ limit: number;
24800
24550
  data: Array<Promotion>;
24801
24551
  total: number;
24802
24552
  } & {
@@ -24853,7 +24603,7 @@ declare namespace ShopperPromotionsTypes {
24853
24603
  };
24854
24604
  type SearchRequest = {
24855
24605
  limit?: number;
24856
- query: any;
24606
+ query: Query$8;
24857
24607
  sorts?: Array<Sort$8>;
24858
24608
  offset?: any;
24859
24609
  } & {
@@ -24887,7 +24637,7 @@ declare namespace ShopperPromotionsTypes {
24887
24637
  [key: string]: any;
24888
24638
  };
24889
24639
  type PaginatedSearchResult = {
24890
- query: any;
24640
+ query: Query$8;
24891
24641
  sorts?: Array<Sort$8>;
24892
24642
  limit: number;
24893
24643
  hits?: Array<object>;
@@ -24907,13 +24657,13 @@ declare namespace ShopperPromotionsTypes {
24907
24657
  [key: string]: any;
24908
24658
  };
24909
24659
  type BoolFilter = {
24910
- filters?: Array<any>;
24660
+ filters?: Array<Filter$8>;
24911
24661
  operator: string;
24912
24662
  } & {
24913
24663
  [key: string]: any;
24914
24664
  };
24915
24665
  type PaginatedSearchResultBase = {
24916
- query: any;
24666
+ query: Query$8;
24917
24667
  sorts?: Array<Sort$8>;
24918
24668
  limit: number;
24919
24669
  hits?: Array<object>;
@@ -24926,13 +24676,13 @@ declare namespace ShopperPromotionsTypes {
24926
24676
  [key: string]: any;
24927
24677
  };
24928
24678
  type FilteredQuery = {
24929
- filter: any;
24930
- query: any;
24679
+ filter: Filter$8;
24680
+ query: Query$8;
24931
24681
  } & {
24932
24682
  [key: string]: any;
24933
24683
  };
24934
24684
  type QueryFilter = {
24935
- query: any;
24685
+ query: Query$8;
24936
24686
  } & {
24937
24687
  [key: string]: any;
24938
24688
  };
@@ -24978,9 +24728,9 @@ declare namespace ShopperPromotionsTypes {
24978
24728
  [key: string]: any;
24979
24729
  };
24980
24730
  type BoolQuery = {
24981
- must?: Array<any>;
24982
- mustNot?: Array<any>;
24983
- should?: Array<any>;
24731
+ must?: Array<Query>;
24732
+ mustNot?: Array<Query>;
24733
+ should?: Array<Query>;
24984
24734
  } & {
24985
24735
  [key: string]: any;
24986
24736
  };
@@ -24994,7 +24744,7 @@ declare namespace ShopperPromotionsTypes {
24994
24744
  };
24995
24745
  type NestedQuery = {
24996
24746
  path: string;
24997
- query: any;
24747
+ query: Query;
24998
24748
  scoreMode?: string;
24999
24749
  } & {
25000
24750
  [key: string]: any;
@@ -25016,7 +24766,7 @@ declare namespace ShopperPromotionsTypes {
25016
24766
  };
25017
24767
  type SearchRequestBase = {
25018
24768
  limit?: number;
25019
- query: any;
24769
+ query: Query;
25020
24770
  sorts?: Array<Sort>;
25021
24771
  offset?: any;
25022
24772
  } & {
@@ -25105,7 +24855,7 @@ declare namespace ShopperPromotionsTypes {
25105
24855
  * ```
25106
24856
  *
25107
24857
  * <span style="font-size:.7em; display:block; text-align: right">
25108
- * API Version: 1.0.21<br />
24858
+ * API Version: 1.0.25<br />
25109
24859
  * Last Updated: <br />
25110
24860
  * </span>
25111
24861
 
@@ -25253,43 +25003,152 @@ declare namespace ShopperPromotionsTypes {
25253
25003
  }>, rawResponse?: T): Promise<T extends true ? Response : PromotionResult>;
25254
25004
  }
25255
25005
  }
25256
- type ProductPriceTable$0 = {
25257
- price?: number;
25258
- pricebook?: string;
25259
- quantity?: number;
25006
+ type BoolFilter$9 = {
25007
+ filters?: Array<Filter$8>;
25008
+ operator: string;
25260
25009
  } & {
25261
25010
  [key: string]: any;
25262
25011
  };
25263
- type ProductRef = {
25264
- id: string;
25265
- } & {
25012
+ type MatchAllQuery$9 = {} & {
25266
25013
  [key: string]: any;
25267
25014
  };
25268
- type SuggestedTerms = {
25269
- originalTerm: string;
25270
- terms?: Array<SuggestedTerm>;
25015
+ type FilteredQuery$9 = {
25016
+ filter: Filter$8;
25017
+ query: Query$8;
25271
25018
  } & {
25272
25019
  [key: string]: any;
25273
25020
  };
25274
- type PriceRange$0 = {
25275
- maxPrice?: number;
25276
- minPrice?: number;
25277
- pricebook?: string;
25021
+ type QueryFilter$9 = {
25022
+ query: Query$8;
25278
25023
  } & {
25279
25024
  [key: string]: any;
25280
25025
  };
25281
- type CategorySuggestions = {
25282
- categories?: Array<SuggestedCategory>;
25283
- suggestedPhrases?: Array<SuggestedPhrase>;
25284
- suggestedTerms: Array<SuggestedTerms>;
25026
+ type Query$9 = {
25027
+ boolQuery?: BoolQuery$8;
25028
+ filteredQuery?: FilteredQuery$9;
25029
+ matchAllQuery?: MatchAllQuery$9;
25030
+ nestedQuery?: NestedQuery$8;
25031
+ termQuery?: TermQuery$8;
25032
+ textQuery?: TextQuery$8;
25285
25033
  } & {
25286
25034
  [key: string]: any;
25287
25035
  };
25288
- type SuggestedProduct = {
25289
- currency: any;
25290
- price: number;
25291
- productId: string;
25292
- productName: string;
25036
+ type TermQuery$9 = {
25037
+ fields: Array<string>;
25038
+ operator: string;
25039
+ values?: Array<any>;
25040
+ } & {
25041
+ [key: string]: any;
25042
+ };
25043
+ type TermFilter$9 = {
25044
+ field: string;
25045
+ operator: string;
25046
+ values?: Array<any>;
25047
+ } & {
25048
+ [key: string]: any;
25049
+ };
25050
+ type TextQuery$9 = {
25051
+ fields: Array<string>;
25052
+ searchPhrase: string;
25053
+ } & {
25054
+ [key: string]: any;
25055
+ };
25056
+ type Range2Filter$9 = {
25057
+ filterMode?: string;
25058
+ fromField: string;
25059
+ fromInclusive?: boolean;
25060
+ fromValue?: any;
25061
+ toField: string;
25062
+ toInclusive?: boolean;
25063
+ toValue?: any;
25064
+ } & {
25065
+ [key: string]: any;
25066
+ };
25067
+ type BoolQuery$9 = {
25068
+ must?: Array<Query$9>;
25069
+ mustNot?: Array<Query$9>;
25070
+ should?: Array<Query$9>;
25071
+ } & {
25072
+ [key: string]: any;
25073
+ };
25074
+ type NestedQuery$9 = {
25075
+ path: string;
25076
+ query: Query$9;
25077
+ scoreMode?: string;
25078
+ } & {
25079
+ [key: string]: any;
25080
+ };
25081
+ type Filter$9 = {
25082
+ boolFilter?: BoolFilter$9;
25083
+ queryFilter?: QueryFilter$9;
25084
+ range2Filter?: Range2Filter$9;
25085
+ rangeFilter?: RangeFilter$8;
25086
+ termFilter?: TermFilter$9;
25087
+ } & {
25088
+ [key: string]: any;
25089
+ };
25090
+ type Sort$9 = {
25091
+ field: string;
25092
+ sortOrder?: string;
25093
+ } & {
25094
+ [key: string]: any;
25095
+ };
25096
+ type RangeFilter$9 = {
25097
+ field: string;
25098
+ from?: any;
25099
+ fromInclusive?: boolean;
25100
+ to?: any;
25101
+ toInclusive?: boolean;
25102
+ } & {
25103
+ [key: string]: any;
25104
+ };
25105
+ type L10nString$8 = {} & {
25106
+ [key: string]: any;
25107
+ };
25108
+ type PropertyValueDefinition$8 = {
25109
+ description: L10nString$8;
25110
+ displayValue: L10nString$8;
25111
+ id: string;
25112
+ position?: number;
25113
+ value: string;
25114
+ };
25115
+ type ProductPriceTable$0 = {
25116
+ price?: number;
25117
+ pricebook?: string;
25118
+ quantity?: number;
25119
+ } & {
25120
+ [key: string]: any;
25121
+ };
25122
+ type ProductRef = {
25123
+ id: string;
25124
+ } & {
25125
+ [key: string]: any;
25126
+ };
25127
+ type SuggestedTerms = {
25128
+ originalTerm: string;
25129
+ terms?: Array<SuggestedTerm>;
25130
+ } & {
25131
+ [key: string]: any;
25132
+ };
25133
+ type PriceRange$0 = {
25134
+ maxPrice?: number;
25135
+ minPrice?: number;
25136
+ pricebook?: string;
25137
+ } & {
25138
+ [key: string]: any;
25139
+ };
25140
+ type CategorySuggestions = {
25141
+ categories?: Array<SuggestedCategory>;
25142
+ suggestedPhrases?: Array<SuggestedPhrase>;
25143
+ suggestedTerms: Array<SuggestedTerms>;
25144
+ } & {
25145
+ [key: string]: any;
25146
+ };
25147
+ type SuggestedProduct = {
25148
+ currency: string;
25149
+ price: number;
25150
+ productId: string;
25151
+ productName: string;
25293
25152
  } & {
25294
25153
  [key: string]: any;
25295
25154
  };
@@ -25402,7 +25261,7 @@ type CustomSuggestions = {
25402
25261
  [key: string]: any;
25403
25262
  };
25404
25263
  type ProductSearchHit = {
25405
- currency?: any;
25264
+ currency?: string;
25406
25265
  hitType?: string;
25407
25266
  image?: Image$0;
25408
25267
  orderable?: boolean;
@@ -25492,13 +25351,13 @@ type ShopperSearchPathParameters = {
25492
25351
  * All query parameters that are used by at least one ShopperSearch method.
25493
25352
  */
25494
25353
  type ShopperSearchQueryParameters = {
25495
- select?: any;
25496
- siteId?: any;
25354
+ select?: string;
25355
+ siteId?: string;
25497
25356
  q?: string;
25498
25357
  refine?: Array<string>;
25499
25358
  sort?: string;
25500
- currency?: any;
25501
- locale?: any;
25359
+ currency?: string;
25360
+ locale?: string;
25502
25361
  expand?: Array<string>;
25503
25362
  allImages?: boolean;
25504
25363
  perPricebook?: boolean;
@@ -25533,7 +25392,7 @@ type ShopperSearchParameters = ShopperSearchPathParameters & BaseUriParameters &
25533
25392
  * ```
25534
25393
  *
25535
25394
  * <span style="font-size:.7em; display:block; text-align: right">
25536
- * API Version: 1.0.38<br />
25395
+ * API Version: 1.0.40<br />
25537
25396
  * Last Updated: <br />
25538
25397
  * </span>
25539
25398
 
@@ -25555,7 +25414,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
25555
25414
  *
25556
25415
  * @param options - An object containing the options for this method.
25557
25416
  * @param parameters - An object containing the parameters for this method.
25558
- * @param organizationId -
25417
+ * @param organizationId - An identifier for the organization the request is being made by.
25559
25418
  * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
25560
25419
  * @param siteId -
25561
25420
  * @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
@@ -25588,13 +25447,13 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
25588
25447
  productSearch(options?: RequireParametersUnlessAllAreOptional<{
25589
25448
  parameters?: CompositeParameters<{
25590
25449
  organizationId: string;
25591
- select?: any;
25592
- siteId: any;
25450
+ select?: string;
25451
+ siteId: string;
25593
25452
  q?: string;
25594
25453
  refine?: Array<string>;
25595
25454
  sort?: string;
25596
- currency?: any;
25597
- locale?: any;
25455
+ currency?: string;
25456
+ locale?: string;
25598
25457
  expand?: Array<string>;
25599
25458
  allImages?: boolean;
25600
25459
  perPricebook?: boolean;
@@ -25614,7 +25473,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
25614
25473
  *
25615
25474
  * @param options - An object containing the options for this method.
25616
25475
  * @param parameters - An object containing the parameters for this method.
25617
- * @param organizationId -
25476
+ * @param organizationId - An identifier for the organization the request is being made by.
25618
25477
  * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
25619
25478
  * @param siteId -
25620
25479
  * @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
@@ -25647,13 +25506,13 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
25647
25506
  productSearch<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
25648
25507
  parameters?: CompositeParameters<{
25649
25508
  organizationId: string;
25650
- select?: any;
25651
- siteId: any;
25509
+ select?: string;
25510
+ siteId: string;
25652
25511
  q?: string;
25653
25512
  refine?: Array<string>;
25654
25513
  sort?: string;
25655
- currency?: any;
25656
- locale?: any;
25514
+ currency?: string;
25515
+ locale?: string;
25657
25516
  expand?: Array<string>;
25658
25517
  allImages?: boolean;
25659
25518
  perPricebook?: boolean;
@@ -25674,7 +25533,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
25674
25533
  *
25675
25534
  * @param options - An object containing the options for this method.
25676
25535
  * @param parameters - An object containing the parameters for this method.
25677
- * @param organizationId -
25536
+ * @param organizationId - An identifier for the organization the request is being made by.
25678
25537
  * @param siteId -
25679
25538
  * @param q - The search phrase (q) for which suggestions are evaluated. Search suggestions are determined when the search phrase input is at least three (default) characters long. The value is configurable in the Business Manager.
25680
25539
  * @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
@@ -25689,11 +25548,11 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
25689
25548
  getSearchSuggestions(options?: RequireParametersUnlessAllAreOptional<{
25690
25549
  parameters?: CompositeParameters<{
25691
25550
  organizationId: string;
25692
- siteId: any;
25551
+ siteId: string;
25693
25552
  q: string;
25694
25553
  limit?: number;
25695
- currency?: any;
25696
- locale?: any;
25554
+ currency?: string;
25555
+ locale?: string;
25697
25556
  } & {
25698
25557
  [key in `c_${string}`]: any;
25699
25558
  }, ConfigParameters>;
@@ -25706,7 +25565,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
25706
25565
  *
25707
25566
  * @param options - An object containing the options for this method.
25708
25567
  * @param parameters - An object containing the parameters for this method.
25709
- * @param organizationId -
25568
+ * @param organizationId - An identifier for the organization the request is being made by.
25710
25569
  * @param siteId -
25711
25570
  * @param q - The search phrase (q) for which suggestions are evaluated. Search suggestions are determined when the search phrase input is at least three (default) characters long. The value is configurable in the Business Manager.
25712
25571
  * @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
@@ -25721,11 +25580,11 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
25721
25580
  getSearchSuggestions<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
25722
25581
  parameters?: CompositeParameters<{
25723
25582
  organizationId: string;
25724
- siteId: any;
25583
+ siteId: string;
25725
25584
  q: string;
25726
25585
  limit?: number;
25727
- currency?: any;
25728
- locale?: any;
25586
+ currency?: string;
25587
+ locale?: string;
25729
25588
  } & {
25730
25589
  [key in `c_${string}`]: any;
25731
25590
  }, ConfigParameters>;
@@ -25825,100 +25684,332 @@ declare namespace ShopperSearchTypes {
25825
25684
  constructor(config: ClientConfigInit<Params>);
25826
25685
  static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
25827
25686
  }
25828
- type ErrorResponse = {
25829
- type: string;
25830
- title?: string;
25831
- detail?: string;
25832
- instance?: string;
25687
+ type Money = {
25688
+ currencyMnemonic?: string;
25689
+ value?: number;
25833
25690
  } & {
25834
25691
  [key: string]: any;
25835
25692
  };
25836
- type ChangeControlled = {
25837
- creationDate?: any;
25838
- modificationDate?: any;
25839
- createdBy?: string;
25840
- lastModifiedBy?: string;
25693
+ type SimpleSearchResult = {
25694
+ limit: number;
25695
+ hits?: Array<object>;
25696
+ offset: any;
25697
+ total: any;
25841
25698
  } & {
25842
25699
  [key: string]: any;
25843
25700
  };
25844
- type ChangeControlledDataType = {
25845
- creationDate?: any;
25846
- modificationDate?: any;
25847
- createdBy?: string;
25848
- lastModifiedBy?: string;
25701
+ type SearchRequest = {
25702
+ limit?: number;
25703
+ query: Query$9;
25704
+ sorts?: Array<Sort$9>;
25705
+ offset?: any;
25849
25706
  } & {
25850
25707
  [key: string]: any;
25851
25708
  };
25852
- type Error = {
25709
+ type PropertyDefinition = {
25710
+ defaultValue?: PropertyValueDefinition$8;
25711
+ id?: string;
25712
+ name: L10nString$8;
25713
+ description: L10nString$8;
25714
+ key?: boolean;
25715
+ localizable?: boolean;
25716
+ mandatory?: boolean;
25717
+ max?: number;
25718
+ minLength?: number;
25719
+ min?: number;
25720
+ multiValueType?: boolean;
25721
+ regularExpression?: string;
25722
+ scale?: number;
25723
+ searchable?: boolean;
25724
+ siteSpecific?: boolean;
25725
+ system?: boolean;
25726
+ unit?: L10nString$8;
25727
+ possibleValues?: Array<PropertyValueDefinition$8>;
25853
25728
  type: string;
25854
- title?: string;
25855
- detail?: string;
25856
- instance?: string;
25729
+ visible?: boolean;
25857
25730
  } & {
25858
25731
  [key: string]: any;
25859
25732
  };
25860
- type ProductPriceTable = {
25861
- price?: number;
25862
- pricebook?: string;
25863
- quantity?: number;
25864
- } & {
25733
+ type LocalizedString = {} & {
25865
25734
  [key: string]: any;
25866
25735
  };
25867
- type ProductRef = {
25868
- id: string;
25736
+ type PaginatedSearchResult = {
25737
+ query: Query$9;
25738
+ sorts?: Array<Sort$9>;
25739
+ limit: number;
25740
+ hits?: Array<object>;
25741
+ offset: any;
25742
+ total: any;
25869
25743
  } & {
25870
25744
  [key: string]: any;
25871
25745
  };
25872
- type SuggestedTerms = {
25873
- originalTerm: string;
25874
- terms?: Array<SuggestedTerm>;
25875
- } & {
25746
+ type ClosedObject = {} & {
25876
25747
  [key: string]: any;
25877
25748
  };
25878
- type PriceRange = {
25879
- maxPrice?: number;
25880
- minPrice?: number;
25881
- pricebook?: string;
25882
- } & {
25749
+ type OpenObject = {} & {
25883
25750
  [key: string]: any;
25884
25751
  };
25885
- type CategorySuggestions = {
25886
- categories?: Array<SuggestedCategory>;
25887
- suggestedPhrases?: Array<SuggestedPhrase>;
25888
- suggestedTerms: Array<SuggestedTerms>;
25889
- } & {
25752
+ type NoPropertiesAllowed = {};
25753
+ type SpecifiedPropertiesAllowed = {} & {
25890
25754
  [key: string]: any;
25891
25755
  };
25892
- type SuggestedProduct = {
25893
- currency: any;
25894
- price: number;
25895
- productId: string;
25896
- productName: string;
25756
+ type BoolFilter = {
25757
+ filters?: Array<Filter$9>;
25758
+ operator: string;
25897
25759
  } & {
25898
25760
  [key: string]: any;
25899
25761
  };
25900
- type SuggestedPhrase = {
25901
- exactMatch: boolean;
25902
- phrase: string;
25762
+ type PaginatedSearchResultBase = {
25763
+ query: Query$9;
25764
+ sorts?: Array<Sort$9>;
25765
+ limit: number;
25766
+ hits?: Array<object>;
25767
+ offset: any;
25768
+ total: any;
25903
25769
  } & {
25904
25770
  [key: string]: any;
25905
25771
  };
25906
- type VariationAttribute = {
25907
- id: string;
25908
- name?: string;
25909
- values?: Array<VariationAttributeValue$1>;
25910
- } & {
25772
+ type MatchAllQuery = {} & {
25911
25773
  [key: string]: any;
25912
25774
  };
25913
- type ProductSuggestions = {
25914
- products?: Array<SuggestedProduct>;
25915
- suggestedPhrases?: Array<SuggestedPhrase>;
25916
- suggestedTerms: Array<SuggestedTerms>;
25775
+ type FilteredQuery = {
25776
+ filter: Filter$9;
25777
+ query: Query$9;
25917
25778
  } & {
25918
25779
  [key: string]: any;
25919
25780
  };
25920
- type SuggestedCategory = {
25921
- id: string;
25781
+ type QueryFilter = {
25782
+ query: Query$9;
25783
+ } & {
25784
+ [key: string]: any;
25785
+ };
25786
+ type Query = {
25787
+ boolQuery?: BoolQuery$9;
25788
+ filteredQuery?: FilteredQuery;
25789
+ matchAllQuery?: MatchAllQuery;
25790
+ nestedQuery?: NestedQuery$9;
25791
+ termQuery?: TermQuery$9;
25792
+ textQuery?: TextQuery$9;
25793
+ } & {
25794
+ [key: string]: any;
25795
+ };
25796
+ type TermQuery = {
25797
+ fields: Array<string>;
25798
+ operator: string;
25799
+ values?: Array<any>;
25800
+ } & {
25801
+ [key: string]: any;
25802
+ };
25803
+ type TermFilter = {
25804
+ field: string;
25805
+ operator: string;
25806
+ values?: Array<any>;
25807
+ } & {
25808
+ [key: string]: any;
25809
+ };
25810
+ type TextQuery = {
25811
+ fields: Array<string>;
25812
+ searchPhrase: string;
25813
+ } & {
25814
+ [key: string]: any;
25815
+ };
25816
+ type Range2Filter = {
25817
+ filterMode?: string;
25818
+ fromField: string;
25819
+ fromInclusive?: boolean;
25820
+ fromValue?: any;
25821
+ toField: string;
25822
+ toInclusive?: boolean;
25823
+ toValue?: any;
25824
+ } & {
25825
+ [key: string]: any;
25826
+ };
25827
+ type BoolQuery = {
25828
+ must?: Array<Query>;
25829
+ mustNot?: Array<Query>;
25830
+ should?: Array<Query>;
25831
+ } & {
25832
+ [key: string]: any;
25833
+ };
25834
+ type SimpleSearchResultBase = {
25835
+ limit: number;
25836
+ hits?: Array<object>;
25837
+ offset: any;
25838
+ total: any;
25839
+ } & {
25840
+ [key: string]: any;
25841
+ };
25842
+ type NestedQuery = {
25843
+ path: string;
25844
+ query: Query;
25845
+ scoreMode?: string;
25846
+ } & {
25847
+ [key: string]: any;
25848
+ };
25849
+ type Filter = {
25850
+ boolFilter?: BoolFilter;
25851
+ queryFilter?: QueryFilter;
25852
+ range2Filter?: Range2Filter;
25853
+ rangeFilter?: RangeFilter$9;
25854
+ termFilter?: TermFilter;
25855
+ } & {
25856
+ [key: string]: any;
25857
+ };
25858
+ type Sort = {
25859
+ field: string;
25860
+ sortOrder?: string;
25861
+ } & {
25862
+ [key: string]: any;
25863
+ };
25864
+ type RangeFilter = {
25865
+ field: string;
25866
+ from?: any;
25867
+ fromInclusive?: boolean;
25868
+ to?: any;
25869
+ toInclusive?: boolean;
25870
+ } & {
25871
+ [key: string]: any;
25872
+ };
25873
+ type SearchRequestBase = {
25874
+ limit?: number;
25875
+ query: Query;
25876
+ sorts?: Array<Sort>;
25877
+ offset?: any;
25878
+ } & {
25879
+ [key: string]: any;
25880
+ };
25881
+ type MoneyMnemonic = {
25882
+ currencyMnemonic?: string;
25883
+ value?: number;
25884
+ } & {
25885
+ [key: string]: any;
25886
+ };
25887
+ type L10nString = {} & {
25888
+ [key: string]: any;
25889
+ };
25890
+ type AttributeDefinition = {
25891
+ defaultValue?: PropertyValueDefinition$8;
25892
+ id?: string;
25893
+ name: L10nString;
25894
+ description: L10nString;
25895
+ key?: boolean;
25896
+ localizable?: boolean;
25897
+ mandatory?: boolean;
25898
+ max?: number;
25899
+ minLength?: number;
25900
+ min?: number;
25901
+ multiValueType?: boolean;
25902
+ regularExpression?: string;
25903
+ scale?: number;
25904
+ searchable?: boolean;
25905
+ siteSpecific?: boolean;
25906
+ system?: boolean;
25907
+ unit?: L10nString;
25908
+ possibleValues?: Array<PropertyValueDefinition$8>;
25909
+ type: string;
25910
+ visible?: boolean;
25911
+ };
25912
+ type PropertyValueDefinition = {
25913
+ description: L10nString;
25914
+ displayValue: L10nString;
25915
+ id: string;
25916
+ position?: number;
25917
+ value: string;
25918
+ };
25919
+ type ErrorResponse = {
25920
+ type: string;
25921
+ title?: string;
25922
+ detail?: string;
25923
+ instance?: string;
25924
+ } & {
25925
+ [key: string]: any;
25926
+ };
25927
+ type ChangeControlled = {
25928
+ creationDate?: any;
25929
+ modificationDate?: any;
25930
+ createdBy?: string;
25931
+ lastModifiedBy?: string;
25932
+ } & {
25933
+ [key: string]: any;
25934
+ };
25935
+ type ChangeControlledDataType = {
25936
+ creationDate?: any;
25937
+ modificationDate?: any;
25938
+ createdBy?: string;
25939
+ lastModifiedBy?: string;
25940
+ } & {
25941
+ [key: string]: any;
25942
+ };
25943
+ type Error = {
25944
+ type: string;
25945
+ title?: string;
25946
+ detail?: string;
25947
+ instance?: string;
25948
+ } & {
25949
+ [key: string]: any;
25950
+ };
25951
+ type ProductPriceTable = {
25952
+ price?: number;
25953
+ pricebook?: string;
25954
+ quantity?: number;
25955
+ } & {
25956
+ [key: string]: any;
25957
+ };
25958
+ type ProductRef = {
25959
+ id: string;
25960
+ } & {
25961
+ [key: string]: any;
25962
+ };
25963
+ type SuggestedTerms = {
25964
+ originalTerm: string;
25965
+ terms?: Array<SuggestedTerm>;
25966
+ } & {
25967
+ [key: string]: any;
25968
+ };
25969
+ type PriceRange = {
25970
+ maxPrice?: number;
25971
+ minPrice?: number;
25972
+ pricebook?: string;
25973
+ } & {
25974
+ [key: string]: any;
25975
+ };
25976
+ type CategorySuggestions = {
25977
+ categories?: Array<SuggestedCategory>;
25978
+ suggestedPhrases?: Array<SuggestedPhrase>;
25979
+ suggestedTerms: Array<SuggestedTerms>;
25980
+ } & {
25981
+ [key: string]: any;
25982
+ };
25983
+ type SuggestedProduct = {
25984
+ currency: string;
25985
+ price: number;
25986
+ productId: string;
25987
+ productName: string;
25988
+ } & {
25989
+ [key: string]: any;
25990
+ };
25991
+ type SuggestedPhrase = {
25992
+ exactMatch: boolean;
25993
+ phrase: string;
25994
+ } & {
25995
+ [key: string]: any;
25996
+ };
25997
+ type VariationAttribute = {
25998
+ id: string;
25999
+ name?: string;
26000
+ values?: Array<VariationAttributeValue$1>;
26001
+ } & {
26002
+ [key: string]: any;
26003
+ };
26004
+ type ProductSuggestions = {
26005
+ products?: Array<SuggestedProduct>;
26006
+ suggestedPhrases?: Array<SuggestedPhrase>;
26007
+ suggestedTerms: Array<SuggestedTerms>;
26008
+ } & {
26009
+ [key: string]: any;
26010
+ };
26011
+ type SuggestedCategory = {
26012
+ id: string;
25922
26013
  name: string;
25923
26014
  parentCategoryName: string;
25924
26015
  } & {
@@ -26006,7 +26097,7 @@ declare namespace ShopperSearchTypes {
26006
26097
  [key: string]: any;
26007
26098
  };
26008
26099
  type ProductSearchHit = {
26009
- currency?: any;
26100
+ currency?: string;
26010
26101
  hitType?: string;
26011
26102
  image?: Image$1;
26012
26103
  orderable?: boolean;
@@ -26096,13 +26187,13 @@ declare namespace ShopperSearchTypes {
26096
26187
  * All query parameters that are used by at least one ShopperSearch method.
26097
26188
  */
26098
26189
  type ShopperSearchQueryParameters = {
26099
- select?: any;
26100
- siteId?: any;
26190
+ select?: string;
26191
+ siteId?: string;
26101
26192
  q?: string;
26102
26193
  refine?: Array<string>;
26103
26194
  sort?: string;
26104
- currency?: any;
26105
- locale?: any;
26195
+ currency?: string;
26196
+ locale?: string;
26106
26197
  expand?: Array<string>;
26107
26198
  allImages?: boolean;
26108
26199
  perPricebook?: boolean;
@@ -26137,7 +26228,7 @@ declare namespace ShopperSearchTypes {
26137
26228
  * ```
26138
26229
  *
26139
26230
  * <span style="font-size:.7em; display:block; text-align: right">
26140
- * API Version: 1.0.38<br />
26231
+ * API Version: 1.0.40<br />
26141
26232
  * Last Updated: <br />
26142
26233
  * </span>
26143
26234
 
@@ -26159,7 +26250,7 @@ declare namespace ShopperSearchTypes {
26159
26250
  *
26160
26251
  * @param options - An object containing the options for this method.
26161
26252
  * @param parameters - An object containing the parameters for this method.
26162
- * @param organizationId -
26253
+ * @param organizationId - An identifier for the organization the request is being made by.
26163
26254
  * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
26164
26255
  * @param siteId -
26165
26256
  * @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
@@ -26192,13 +26283,13 @@ declare namespace ShopperSearchTypes {
26192
26283
  productSearch(options?: RequireParametersUnlessAllAreOptional<{
26193
26284
  parameters?: CompositeParameters<{
26194
26285
  organizationId: string;
26195
- select?: any;
26196
- siteId: any;
26286
+ select?: string;
26287
+ siteId: string;
26197
26288
  q?: string;
26198
26289
  refine?: Array<string>;
26199
26290
  sort?: string;
26200
- currency?: any;
26201
- locale?: any;
26291
+ currency?: string;
26292
+ locale?: string;
26202
26293
  expand?: Array<string>;
26203
26294
  allImages?: boolean;
26204
26295
  perPricebook?: boolean;
@@ -26218,7 +26309,7 @@ declare namespace ShopperSearchTypes {
26218
26309
  *
26219
26310
  * @param options - An object containing the options for this method.
26220
26311
  * @param parameters - An object containing the parameters for this method.
26221
- * @param organizationId -
26312
+ * @param organizationId - An identifier for the organization the request is being made by.
26222
26313
  * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations and filter expressions.The actual selector value must be enclosed within parentheses.
26223
26314
  * @param siteId -
26224
26315
  * @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
@@ -26251,13 +26342,13 @@ declare namespace ShopperSearchTypes {
26251
26342
  productSearch<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
26252
26343
  parameters?: CompositeParameters<{
26253
26344
  organizationId: string;
26254
- select?: any;
26255
- siteId: any;
26345
+ select?: string;
26346
+ siteId: string;
26256
26347
  q?: string;
26257
26348
  refine?: Array<string>;
26258
26349
  sort?: string;
26259
- currency?: any;
26260
- locale?: any;
26350
+ currency?: string;
26351
+ locale?: string;
26261
26352
  expand?: Array<string>;
26262
26353
  allImages?: boolean;
26263
26354
  perPricebook?: boolean;
@@ -26278,7 +26369,7 @@ declare namespace ShopperSearchTypes {
26278
26369
  *
26279
26370
  * @param options - An object containing the options for this method.
26280
26371
  * @param parameters - An object containing the parameters for this method.
26281
- * @param organizationId -
26372
+ * @param organizationId - An identifier for the organization the request is being made by.
26282
26373
  * @param siteId -
26283
26374
  * @param q - The search phrase (q) for which suggestions are evaluated. Search suggestions are determined when the search phrase input is at least three (default) characters long. The value is configurable in the Business Manager.
26284
26375
  * @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
@@ -26293,11 +26384,11 @@ declare namespace ShopperSearchTypes {
26293
26384
  getSearchSuggestions(options?: RequireParametersUnlessAllAreOptional<{
26294
26385
  parameters?: CompositeParameters<{
26295
26386
  organizationId: string;
26296
- siteId: any;
26387
+ siteId: string;
26297
26388
  q: string;
26298
26389
  limit?: number;
26299
- currency?: any;
26300
- locale?: any;
26390
+ currency?: string;
26391
+ locale?: string;
26301
26392
  } & {
26302
26393
  [key in `c_${string}`]: any;
26303
26394
  }, ConfigParameters>;
@@ -26310,7 +26401,7 @@ declare namespace ShopperSearchTypes {
26310
26401
  *
26311
26402
  * @param options - An object containing the options for this method.
26312
26403
  * @param parameters - An object containing the parameters for this method.
26313
- * @param organizationId -
26404
+ * @param organizationId - An identifier for the organization the request is being made by.
26314
26405
  * @param siteId -
26315
26406
  * @param q - The search phrase (q) for which suggestions are evaluated. Search suggestions are determined when the search phrase input is at least three (default) characters long. The value is configurable in the Business Manager.
26316
26407
  * @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
@@ -26325,11 +26416,11 @@ declare namespace ShopperSearchTypes {
26325
26416
  getSearchSuggestions<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
26326
26417
  parameters?: CompositeParameters<{
26327
26418
  organizationId: string;
26328
- siteId: any;
26419
+ siteId: string;
26329
26420
  q: string;
26330
26421
  limit?: number;
26331
- currency?: any;
26332
- locale?: any;
26422
+ currency?: string;
26423
+ locale?: string;
26333
26424
  } & {
26334
26425
  [key in `c_${string}`]: any;
26335
26426
  }, ConfigParameters>;
@@ -26339,57 +26430,57 @@ declare namespace ShopperSearchTypes {
26339
26430
  }>, rawResponse?: T): Promise<T extends true ? Response : SuggestionResult>;
26340
26431
  }
26341
26432
  }
26342
- type BoolFilter$9 = {
26343
- filters?: Array<Filter$8>;
26433
+ type BoolFilter$10 = {
26434
+ filters?: Array<Filter$9>;
26344
26435
  operator: string;
26345
26436
  } & {
26346
26437
  [key: string]: any;
26347
26438
  };
26348
- type MatchAllQuery$9 = {} & {
26439
+ type MatchAllQuery$10 = {} & {
26349
26440
  [key: string]: any;
26350
26441
  };
26351
- type FilteredQuery$9 = {
26352
- filter: Filter$8;
26353
- query: Query$8;
26442
+ type FilteredQuery$10 = {
26443
+ filter: Filter$9;
26444
+ query: Query$9;
26354
26445
  } & {
26355
26446
  [key: string]: any;
26356
26447
  };
26357
- type QueryFilter$9 = {
26358
- query: Query$8;
26448
+ type QueryFilter$10 = {
26449
+ query: Query$9;
26359
26450
  } & {
26360
26451
  [key: string]: any;
26361
26452
  };
26362
- type Query$9 = {
26363
- boolQuery?: BoolQuery$8;
26364
- filteredQuery?: FilteredQuery$9;
26365
- matchAllQuery?: MatchAllQuery$9;
26366
- nestedQuery?: NestedQuery$8;
26367
- termQuery?: TermQuery$8;
26368
- textQuery?: TextQuery$8;
26453
+ type Query$10 = {
26454
+ boolQuery?: BoolQuery$9;
26455
+ filteredQuery?: FilteredQuery$10;
26456
+ matchAllQuery?: MatchAllQuery$10;
26457
+ nestedQuery?: NestedQuery$9;
26458
+ termQuery?: TermQuery$9;
26459
+ textQuery?: TextQuery$9;
26369
26460
  } & {
26370
26461
  [key: string]: any;
26371
26462
  };
26372
- type TermQuery$9 = {
26463
+ type TermQuery$10 = {
26373
26464
  fields: Array<string>;
26374
26465
  operator: string;
26375
26466
  values?: Array<any>;
26376
26467
  } & {
26377
26468
  [key: string]: any;
26378
26469
  };
26379
- type TermFilter$9 = {
26470
+ type TermFilter$10 = {
26380
26471
  field: string;
26381
26472
  operator: string;
26382
26473
  values?: Array<any>;
26383
26474
  } & {
26384
26475
  [key: string]: any;
26385
26476
  };
26386
- type TextQuery$9 = {
26477
+ type TextQuery$10 = {
26387
26478
  fields: Array<string>;
26388
26479
  searchPhrase: string;
26389
26480
  } & {
26390
26481
  [key: string]: any;
26391
26482
  };
26392
- type Range2Filter$9 = {
26483
+ type Range2Filter$10 = {
26393
26484
  filterMode?: string;
26394
26485
  fromField: string;
26395
26486
  fromInclusive?: boolean;
@@ -26400,36 +26491,36 @@ type Range2Filter$9 = {
26400
26491
  } & {
26401
26492
  [key: string]: any;
26402
26493
  };
26403
- type BoolQuery$9 = {
26404
- must?: Array<Query$9>;
26405
- mustNot?: Array<Query$9>;
26406
- should?: Array<Query$9>;
26494
+ type BoolQuery$10 = {
26495
+ must?: Array<Query$10>;
26496
+ mustNot?: Array<Query$10>;
26497
+ should?: Array<Query$10>;
26407
26498
  } & {
26408
26499
  [key: string]: any;
26409
26500
  };
26410
- type NestedQuery$9 = {
26501
+ type NestedQuery$10 = {
26411
26502
  path: string;
26412
- query: Query$9;
26503
+ query: Query$10;
26413
26504
  scoreMode?: string;
26414
26505
  } & {
26415
26506
  [key: string]: any;
26416
26507
  };
26417
- type Filter$9 = {
26418
- boolFilter?: BoolFilter$9;
26419
- queryFilter?: QueryFilter$9;
26420
- range2Filter?: Range2Filter$9;
26421
- rangeFilter?: RangeFilter$8;
26422
- termFilter?: TermFilter$9;
26508
+ type Filter$10 = {
26509
+ boolFilter?: BoolFilter$10;
26510
+ queryFilter?: QueryFilter$10;
26511
+ range2Filter?: Range2Filter$10;
26512
+ rangeFilter?: RangeFilter$9;
26513
+ termFilter?: TermFilter$10;
26423
26514
  } & {
26424
26515
  [key: string]: any;
26425
26516
  };
26426
- type Sort$9 = {
26517
+ type Sort$10 = {
26427
26518
  field: string;
26428
26519
  sortOrder?: string;
26429
26520
  } & {
26430
26521
  [key: string]: any;
26431
26522
  };
26432
- type RangeFilter$9 = {
26523
+ type RangeFilter$10 = {
26433
26524
  field: string;
26434
26525
  from?: any;
26435
26526
  fromInclusive?: boolean;
@@ -26438,12 +26529,12 @@ type RangeFilter$9 = {
26438
26529
  } & {
26439
26530
  [key: string]: any;
26440
26531
  };
26441
- type L10nString$8 = {} & {
26532
+ type L10nString$9 = {} & {
26442
26533
  [key: string]: any;
26443
26534
  };
26444
- type PropertyValueDefinition$8 = {
26445
- description: L10nString$8;
26446
- displayValue: L10nString$8;
26535
+ type PropertyValueDefinition$9 = {
26536
+ description: L10nString$9;
26537
+ displayValue: L10nString$9;
26447
26538
  id: string;
26448
26539
  position?: number;
26449
26540
  value: string;
@@ -26504,7 +26595,7 @@ type ShopperSeoParameters = ShopperSeoPathParameters & BaseUriParameters & Shopp
26504
26595
  * ```
26505
26596
  *
26506
26597
  * <span style="font-size:.7em; display:block; text-align: right">
26507
- * API Version: 1.0.6<br />
26598
+ * API Version: 1.0.8<br />
26508
26599
  * Last Updated: <br />
26509
26600
  * </span>
26510
26601
 
@@ -26519,33 +26610,908 @@ declare class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<
26519
26610
  static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/site/shopper-seo/{version}";
26520
26611
  constructor(config: ClientConfigInit<ConfigParameters>);
26521
26612
  /**
26522
- * Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
26613
+ * Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
26614
+ *
26615
+ * If you would like to get a raw Response object use the other getUrlMapping function.
26616
+ *
26617
+ * @param options - An object containing the options for this method.
26618
+ * @param parameters - An object containing the parameters for this method.
26619
+ * @param organizationId - An identifier for the organization the request is being made by.
26620
+ * @param urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for "www.abc.com/blue/new-arrivals/tops" is "blue/new-arrivals/tops". There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters. Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
26621
+ * @param siteId -
26622
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
26623
+ Below are some valid examples:
26624
+ - en-US
26625
+ - de-AT
26626
+ - de
26627
+ - default
26628
+ Please note that if no locale is specified, the default site locale will be used.
26629
+ * @param headers - An object literal of key value pairs of the headers to be
26630
+ * sent with this request.
26631
+ *
26632
+ * @returns A promise of type UrlMapping.
26633
+ *
26634
+ */
26635
+ getUrlMapping(options?: RequireParametersUnlessAllAreOptional<{
26636
+ parameters?: CompositeParameters<{
26637
+ organizationId: string;
26638
+ urlSegment: string;
26639
+ siteId: string;
26640
+ locale?: string;
26641
+ } & {
26642
+ [key in `c_${string}`]: any;
26643
+ }, ConfigParameters>;
26644
+ headers?: {
26645
+ [key: string]: string;
26646
+ };
26647
+ }>): Promise<UrlMapping>;
26648
+ /**
26649
+ * Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
26650
+ *
26651
+ * @param options - An object containing the options for this method.
26652
+ * @param parameters - An object containing the parameters for this method.
26653
+ * @param organizationId - An identifier for the organization the request is being made by.
26654
+ * @param urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for "www.abc.com/blue/new-arrivals/tops" is "blue/new-arrivals/tops". There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters. Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
26655
+ * @param siteId -
26656
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
26657
+ Below are some valid examples:
26658
+ - en-US
26659
+ - de-AT
26660
+ - de
26661
+ - default
26662
+ Please note that if no locale is specified, the default site locale will be used.
26663
+ * @param headers - An object literal of key value pairs of the headers to be
26664
+ * sent with this request.
26665
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
26666
+ * @returns A promise of type Response if rawResponse is true, a promise of type UrlMapping otherwise.
26667
+ *
26668
+ */
26669
+ getUrlMapping<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
26670
+ parameters?: CompositeParameters<{
26671
+ organizationId: string;
26672
+ urlSegment: string;
26673
+ siteId: string;
26674
+ locale?: string;
26675
+ } & {
26676
+ [key in `c_${string}`]: any;
26677
+ }, ConfigParameters>;
26678
+ headers?: {
26679
+ [key: string]: string;
26680
+ };
26681
+ }>, rawResponse?: T): Promise<T extends true ? Response : UrlMapping>;
26682
+ }
26683
+ declare namespace ShopperSeoTypes {
26684
+ /*
26685
+ * Copyright (c) 2023, Salesforce, Inc.
26686
+ * All rights reserved.
26687
+ * SPDX-License-Identifier: BSD-3-Clause
26688
+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
26689
+ */
26690
+ /**
26691
+ * Makes a type easier to read.
26692
+ */
26693
+ type Prettify<T> = NonNullable<{
26694
+ [K in keyof T]: T[K];
26695
+ }>;
26696
+ /**
26697
+ * Generates the types required on a method, based on those provided in the config.
26698
+ */
26699
+ type CompositeParameters<MethodParameters extends Record<string, unknown>, ConfigParameters extends Record<string, unknown>> = Prettify<Omit<MethodParameters, keyof ConfigParameters> & Partial<MethodParameters>>;
26700
+ /**
26701
+ * If an object has a `parameters` property, and the `parameters` object has required properties,
26702
+ * then the `parameters` property on the root object is marked as required.
26703
+ */
26704
+ type RequireParametersUnlessAllAreOptional<T extends {
26705
+ parameters?: Record<string, unknown>;
26706
+ }> = Record<string, never> extends NonNullable<T["parameters"]> ? T : Prettify<T & Required<Pick<T, "parameters">>>;
26707
+ /**
26708
+ * Template parameters used in the base URI of all API endpoints. `version` will default to `"v1"`
26709
+ * if not specified.
26710
+ */
26711
+ interface BaseUriParameters {
26712
+ shortCode: string;
26713
+ version?: string; // Optional, will default to "v1" if not provided.
26714
+ }
26715
+ /**
26716
+ * Generic interface for path parameters.
26717
+ */
26718
+ interface PathParameters {
26719
+ [key: string]: string | number | boolean;
26720
+ }
26721
+ /**
26722
+ * Generic interface for query parameters.
26723
+ */
26724
+ interface QueryParameters {
26725
+ [key: string]: string | number | boolean | string[] | number[];
26726
+ }
26727
+ /**
26728
+ * Generic interface for all parameter types.
26729
+ */
26730
+ type UrlParameters = PathParameters | QueryParameters;
26731
+ /**
26732
+ * Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
26733
+ * it from the `RequestInit` provided by node-fetch.
26734
+ */
26735
+ type BrowserRequestInit = RequestInit;
26736
+ /**
26737
+ * Any properties supported in either the browser or node are accepted.
26738
+ * Using the right properties in the right context is left to the user.
26739
+ */
26740
+ type FetchOptions = NodeRequestInit & BrowserRequestInit;
26741
+ /**
26742
+ * Base options that can be passed to the `ClientConfig` class.
26743
+ */
26744
+ interface ClientConfigInit<Params extends BaseUriParameters> {
26745
+ baseUri?: string;
26746
+ proxy?: string;
26747
+ headers?: {
26748
+ [key: string]: string;
26749
+ };
26750
+ parameters: Params;
26751
+ fetchOptions?: FetchOptions;
26752
+ transformRequest?: (data: unknown, headers: {
26753
+ [key: string]: string;
26754
+ }) => Required<FetchOptions>["body"];
26755
+ throwOnBadResponse?: boolean;
26756
+ }
26757
+ type FetchFunction = (input: RequestInfo, init?: FetchOptions | undefined) => Promise<Response>;
26758
+ /**
26759
+ * Configuration parameters common to Commerce SDK clients
26760
+ */
26761
+ class ClientConfig<Params extends BaseUriParameters> implements ClientConfigInit<Params> {
26762
+ baseUri?: string;
26763
+ proxy?: string;
26764
+ headers: {
26765
+ [key: string]: string;
26766
+ };
26767
+ parameters: Params;
26768
+ fetchOptions: FetchOptions;
26769
+ transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
26770
+ throwOnBadResponse: boolean;
26771
+ constructor(config: ClientConfigInit<Params>);
26772
+ static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
26773
+ }
26774
+ type Money = {
26775
+ currencyMnemonic?: string;
26776
+ value?: number;
26777
+ } & {
26778
+ [key: string]: any;
26779
+ };
26780
+ type SimpleSearchResult = {
26781
+ limit: number;
26782
+ hits?: Array<object>;
26783
+ offset: any;
26784
+ total: any;
26785
+ } & {
26786
+ [key: string]: any;
26787
+ };
26788
+ type SearchRequest = {
26789
+ limit?: number;
26790
+ query: Query$10;
26791
+ sorts?: Array<Sort$10>;
26792
+ offset?: any;
26793
+ } & {
26794
+ [key: string]: any;
26795
+ };
26796
+ type PropertyDefinition = {
26797
+ defaultValue?: PropertyValueDefinition$9;
26798
+ id?: string;
26799
+ name: L10nString$9;
26800
+ description: L10nString$9;
26801
+ key?: boolean;
26802
+ localizable?: boolean;
26803
+ mandatory?: boolean;
26804
+ max?: number;
26805
+ minLength?: number;
26806
+ min?: number;
26807
+ multiValueType?: boolean;
26808
+ regularExpression?: string;
26809
+ scale?: number;
26810
+ searchable?: boolean;
26811
+ siteSpecific?: boolean;
26812
+ system?: boolean;
26813
+ unit?: L10nString$9;
26814
+ possibleValues?: Array<PropertyValueDefinition$9>;
26815
+ type: string;
26816
+ visible?: boolean;
26817
+ } & {
26818
+ [key: string]: any;
26819
+ };
26820
+ type LocalizedString = {} & {
26821
+ [key: string]: any;
26822
+ };
26823
+ type PaginatedSearchResult = {
26824
+ query: Query$10;
26825
+ sorts?: Array<Sort$10>;
26826
+ limit: number;
26827
+ hits?: Array<object>;
26828
+ offset: any;
26829
+ total: any;
26830
+ } & {
26831
+ [key: string]: any;
26832
+ };
26833
+ type ClosedObject = {} & {
26834
+ [key: string]: any;
26835
+ };
26836
+ type OpenObject = {} & {
26837
+ [key: string]: any;
26838
+ };
26839
+ type NoPropertiesAllowed = {};
26840
+ type SpecifiedPropertiesAllowed = {} & {
26841
+ [key: string]: any;
26842
+ };
26843
+ type BoolFilter = {
26844
+ filters?: Array<Filter$10>;
26845
+ operator: string;
26846
+ } & {
26847
+ [key: string]: any;
26848
+ };
26849
+ type PaginatedSearchResultBase = {
26850
+ query: Query$10;
26851
+ sorts?: Array<Sort$10>;
26852
+ limit: number;
26853
+ hits?: Array<object>;
26854
+ offset: any;
26855
+ total: any;
26856
+ } & {
26857
+ [key: string]: any;
26858
+ };
26859
+ type MatchAllQuery = {} & {
26860
+ [key: string]: any;
26861
+ };
26862
+ type FilteredQuery = {
26863
+ filter: Filter$10;
26864
+ query: Query$10;
26865
+ } & {
26866
+ [key: string]: any;
26867
+ };
26868
+ type QueryFilter = {
26869
+ query: Query$10;
26870
+ } & {
26871
+ [key: string]: any;
26872
+ };
26873
+ type Query = {
26874
+ boolQuery?: BoolQuery$10;
26875
+ filteredQuery?: FilteredQuery;
26876
+ matchAllQuery?: MatchAllQuery;
26877
+ nestedQuery?: NestedQuery$10;
26878
+ termQuery?: TermQuery$10;
26879
+ textQuery?: TextQuery$10;
26880
+ } & {
26881
+ [key: string]: any;
26882
+ };
26883
+ type TermQuery = {
26884
+ fields: Array<string>;
26885
+ operator: string;
26886
+ values?: Array<any>;
26887
+ } & {
26888
+ [key: string]: any;
26889
+ };
26890
+ type TermFilter = {
26891
+ field: string;
26892
+ operator: string;
26893
+ values?: Array<any>;
26894
+ } & {
26895
+ [key: string]: any;
26896
+ };
26897
+ type TextQuery = {
26898
+ fields: Array<string>;
26899
+ searchPhrase: string;
26900
+ } & {
26901
+ [key: string]: any;
26902
+ };
26903
+ type Range2Filter = {
26904
+ filterMode?: string;
26905
+ fromField: string;
26906
+ fromInclusive?: boolean;
26907
+ fromValue?: any;
26908
+ toField: string;
26909
+ toInclusive?: boolean;
26910
+ toValue?: any;
26911
+ } & {
26912
+ [key: string]: any;
26913
+ };
26914
+ type BoolQuery = {
26915
+ must?: Array<Query>;
26916
+ mustNot?: Array<Query>;
26917
+ should?: Array<Query>;
26918
+ } & {
26919
+ [key: string]: any;
26920
+ };
26921
+ type SimpleSearchResultBase = {
26922
+ limit: number;
26923
+ hits?: Array<object>;
26924
+ offset: any;
26925
+ total: any;
26926
+ } & {
26927
+ [key: string]: any;
26928
+ };
26929
+ type NestedQuery = {
26930
+ path: string;
26931
+ query: Query;
26932
+ scoreMode?: string;
26933
+ } & {
26934
+ [key: string]: any;
26935
+ };
26936
+ type Filter = {
26937
+ boolFilter?: BoolFilter;
26938
+ queryFilter?: QueryFilter;
26939
+ range2Filter?: Range2Filter;
26940
+ rangeFilter?: RangeFilter$10;
26941
+ termFilter?: TermFilter;
26942
+ } & {
26943
+ [key: string]: any;
26944
+ };
26945
+ type Sort = {
26946
+ field: string;
26947
+ sortOrder?: string;
26948
+ } & {
26949
+ [key: string]: any;
26950
+ };
26951
+ type RangeFilter = {
26952
+ field: string;
26953
+ from?: any;
26954
+ fromInclusive?: boolean;
26955
+ to?: any;
26956
+ toInclusive?: boolean;
26957
+ } & {
26958
+ [key: string]: any;
26959
+ };
26960
+ type SearchRequestBase = {
26961
+ limit?: number;
26962
+ query: Query;
26963
+ sorts?: Array<Sort>;
26964
+ offset?: any;
26965
+ } & {
26966
+ [key: string]: any;
26967
+ };
26968
+ type MoneyMnemonic = {
26969
+ currencyMnemonic?: string;
26970
+ value?: number;
26971
+ } & {
26972
+ [key: string]: any;
26973
+ };
26974
+ type L10nString = {} & {
26975
+ [key: string]: any;
26976
+ };
26977
+ type AttributeDefinition = {
26978
+ defaultValue?: PropertyValueDefinition$9;
26979
+ id?: string;
26980
+ name: L10nString;
26981
+ description: L10nString;
26982
+ key?: boolean;
26983
+ localizable?: boolean;
26984
+ mandatory?: boolean;
26985
+ max?: number;
26986
+ minLength?: number;
26987
+ min?: number;
26988
+ multiValueType?: boolean;
26989
+ regularExpression?: string;
26990
+ scale?: number;
26991
+ searchable?: boolean;
26992
+ siteSpecific?: boolean;
26993
+ system?: boolean;
26994
+ unit?: L10nString;
26995
+ possibleValues?: Array<PropertyValueDefinition$9>;
26996
+ type: string;
26997
+ visible?: boolean;
26998
+ };
26999
+ type PropertyValueDefinition = {
27000
+ description: L10nString;
27001
+ displayValue: L10nString;
27002
+ id: string;
27003
+ position?: number;
27004
+ value: string;
27005
+ };
27006
+ type UrlMapping = {
27007
+ resourceType?: string;
27008
+ resourceSubType?: string;
27009
+ resourceId?: string;
27010
+ refinements?: {} & {
27011
+ [key: string]: any;
27012
+ };
27013
+ statusCode?: number;
27014
+ destinationUrl?: string;
27015
+ copySourceParams?: boolean;
27016
+ additionalUrlParams?: string;
27017
+ productCategoryId?: string;
27018
+ } & {
27019
+ [key: string]: any;
27020
+ };
27021
+ type ErrorResponse = {
27022
+ type: string;
27023
+ title?: string;
27024
+ detail?: string;
27025
+ instance?: string;
27026
+ } & {
27027
+ [key: string]: any;
27028
+ };
27029
+ type ChangeControlled = {
27030
+ creationDate?: any;
27031
+ modificationDate?: any;
27032
+ createdBy?: string;
27033
+ lastModifiedBy?: string;
27034
+ } & {
27035
+ [key: string]: any;
27036
+ };
27037
+ type ChangeControlledDataType = {
27038
+ creationDate?: any;
27039
+ modificationDate?: any;
27040
+ createdBy?: string;
27041
+ lastModifiedBy?: string;
27042
+ } & {
27043
+ [key: string]: any;
27044
+ };
27045
+ type Error = {
27046
+ type: string;
27047
+ title?: string;
27048
+ detail?: string;
27049
+ instance?: string;
27050
+ } & {
27051
+ [key: string]: any;
27052
+ };
27053
+ /**
27054
+ * All path parameters that are used by at least one ShopperSeo method.
27055
+ */
27056
+ type ShopperSeoPathParameters = {
27057
+ organizationId?: string;
27058
+ };
27059
+ /**
27060
+ * All query parameters that are used by at least one ShopperSeo method.
27061
+ */
27062
+ type ShopperSeoQueryParameters = {
27063
+ urlSegment?: string;
27064
+ siteId?: string;
27065
+ locale?: string;
27066
+ };
27067
+ /**
27068
+ * All parameters that are used by ShopperSeo.
27069
+ */
27070
+ type ShopperSeoParameters = ShopperSeoPathParameters & BaseUriParameters & ShopperSeoQueryParameters;
27071
+ /**
27072
+ * [Shopper Seo](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-seo:Summary)
27073
+ * ==================================
27074
+ *
27075
+ * **<br />
27076
+ *
27077
+ * Simple example:
27078
+ *
27079
+ * ```typescript
27080
+ * import { ShopperSeo } from "commerce-sdk-isomorphic";
27081
+ *
27082
+ * const clientConfig = {
27083
+ * parameters: {
27084
+ * clientId: "XXXXXX",
27085
+ * organizationId: "XXXX",
27086
+ * shortCode: "XXX",
27087
+ * siteId: "XX"
27088
+ * }
27089
+ * };
27090
+ * const shopperSeoClient = new ShopperSeo(clientConfig);
27091
+ * ```
27092
+ *
27093
+ * <span style="font-size:.7em; display:block; text-align: right">
27094
+ * API Version: 1.0.8<br />
27095
+ * Last Updated: <br />
27096
+ * </span>
27097
+
27098
+ *
27099
+
27100
+ */
27101
+ class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<string, unknown>> {
27102
+ // baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
27103
+ clientConfig: ClientConfig<ConfigParameters> & {
27104
+ baseUri: string;
27105
+ };
27106
+ static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/site/shopper-seo/{version}";
27107
+ constructor(config: ClientConfigInit<ConfigParameters>);
27108
+ /**
27109
+ * Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
27110
+ *
27111
+ * If you would like to get a raw Response object use the other getUrlMapping function.
27112
+ *
27113
+ * @param options - An object containing the options for this method.
27114
+ * @param parameters - An object containing the parameters for this method.
27115
+ * @param organizationId - An identifier for the organization the request is being made by.
27116
+ * @param urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for "www.abc.com/blue/new-arrivals/tops" is "blue/new-arrivals/tops". There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters. Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
27117
+ * @param siteId -
27118
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
27119
+ Below are some valid examples:
27120
+ - en-US
27121
+ - de-AT
27122
+ - de
27123
+ - default
27124
+ Please note that if no locale is specified, the default site locale will be used.
27125
+ * @param headers - An object literal of key value pairs of the headers to be
27126
+ * sent with this request.
27127
+ *
27128
+ * @returns A promise of type UrlMapping.
27129
+ *
27130
+ */
27131
+ getUrlMapping(options?: RequireParametersUnlessAllAreOptional<{
27132
+ parameters?: CompositeParameters<{
27133
+ organizationId: string;
27134
+ urlSegment: string;
27135
+ siteId: string;
27136
+ locale?: string;
27137
+ } & {
27138
+ [key in `c_${string}`]: any;
27139
+ }, ConfigParameters>;
27140
+ headers?: {
27141
+ [key: string]: string;
27142
+ };
27143
+ }>): Promise<UrlMapping>;
27144
+ /**
27145
+ * Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
27146
+ *
27147
+ * @param options - An object containing the options for this method.
27148
+ * @param parameters - An object containing the parameters for this method.
27149
+ * @param organizationId - An identifier for the organization the request is being made by.
27150
+ * @param urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for "www.abc.com/blue/new-arrivals/tops" is "blue/new-arrivals/tops". There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters. Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
27151
+ * @param siteId -
27152
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
27153
+ Below are some valid examples:
27154
+ - en-US
27155
+ - de-AT
27156
+ - de
27157
+ - default
27158
+ Please note that if no locale is specified, the default site locale will be used.
27159
+ * @param headers - An object literal of key value pairs of the headers to be
27160
+ * sent with this request.
27161
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
27162
+ * @returns A promise of type Response if rawResponse is true, a promise of type UrlMapping otherwise.
27163
+ *
27164
+ */
27165
+ getUrlMapping<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
27166
+ parameters?: CompositeParameters<{
27167
+ organizationId: string;
27168
+ urlSegment: string;
27169
+ siteId: string;
27170
+ locale?: string;
27171
+ } & {
27172
+ [key in `c_${string}`]: any;
27173
+ }, ConfigParameters>;
27174
+ headers?: {
27175
+ [key: string]: string;
27176
+ };
27177
+ }>, rawResponse?: T): Promise<T extends true ? Response : UrlMapping>;
27178
+ }
27179
+ }
27180
+ type BoolFilter$11 = {
27181
+ filters?: Array<Filter$10>;
27182
+ operator: string;
27183
+ } & {
27184
+ [key: string]: any;
27185
+ };
27186
+ type MatchAllQuery$11 = {} & {
27187
+ [key: string]: any;
27188
+ };
27189
+ type FilteredQuery$11 = {
27190
+ filter: Filter$10;
27191
+ query: Query$10;
27192
+ } & {
27193
+ [key: string]: any;
27194
+ };
27195
+ type QueryFilter$11 = {
27196
+ query: Query$10;
27197
+ } & {
27198
+ [key: string]: any;
27199
+ };
27200
+ type Query$11 = {
27201
+ boolQuery?: BoolQuery$10;
27202
+ filteredQuery?: FilteredQuery$11;
27203
+ matchAllQuery?: MatchAllQuery$11;
27204
+ nestedQuery?: NestedQuery$10;
27205
+ termQuery?: TermQuery$10;
27206
+ textQuery?: TextQuery$10;
27207
+ } & {
27208
+ [key: string]: any;
27209
+ };
27210
+ type TermQuery$11 = {
27211
+ fields: Array<string>;
27212
+ operator: string;
27213
+ values?: Array<any>;
27214
+ } & {
27215
+ [key: string]: any;
27216
+ };
27217
+ type TermFilter$11 = {
27218
+ field: string;
27219
+ operator: string;
27220
+ values?: Array<any>;
27221
+ } & {
27222
+ [key: string]: any;
27223
+ };
27224
+ type TextQuery$11 = {
27225
+ fields: Array<string>;
27226
+ searchPhrase: string;
27227
+ } & {
27228
+ [key: string]: any;
27229
+ };
27230
+ type Range2Filter$11 = {
27231
+ filterMode?: string;
27232
+ fromField: string;
27233
+ fromInclusive?: boolean;
27234
+ fromValue?: any;
27235
+ toField: string;
27236
+ toInclusive?: boolean;
27237
+ toValue?: any;
27238
+ } & {
27239
+ [key: string]: any;
27240
+ };
27241
+ type BoolQuery$11 = {
27242
+ must?: Array<Query$11>;
27243
+ mustNot?: Array<Query$11>;
27244
+ should?: Array<Query$11>;
27245
+ } & {
27246
+ [key: string]: any;
27247
+ };
27248
+ type NestedQuery$11 = {
27249
+ path: string;
27250
+ query: Query$11;
27251
+ scoreMode?: string;
27252
+ } & {
27253
+ [key: string]: any;
27254
+ };
27255
+ type Filter$11 = {
27256
+ boolFilter?: BoolFilter$11;
27257
+ queryFilter?: QueryFilter$11;
27258
+ range2Filter?: Range2Filter$11;
27259
+ rangeFilter?: RangeFilter$10;
27260
+ termFilter?: TermFilter$11;
27261
+ } & {
27262
+ [key: string]: any;
27263
+ };
27264
+ type Sort$11 = {
27265
+ field: string;
27266
+ sortOrder?: string;
27267
+ } & {
27268
+ [key: string]: any;
27269
+ };
27270
+ type RangeFilter$11 = {
27271
+ field: string;
27272
+ from?: any;
27273
+ fromInclusive?: boolean;
27274
+ to?: any;
27275
+ toInclusive?: boolean;
27276
+ } & {
27277
+ [key: string]: any;
27278
+ };
27279
+ type L10nString$10 = {} & {
27280
+ [key: string]: any;
27281
+ };
27282
+ type PropertyValueDefinition$10 = {
27283
+ description: L10nString$10;
27284
+ displayValue: L10nString$10;
27285
+ id: string;
27286
+ position?: number;
27287
+ value: string;
27288
+ };
27289
+ type StoreResult = {
27290
+ limit: number;
27291
+ data: Array<Store>;
27292
+ offset?: any;
27293
+ total: any;
27294
+ } & {
27295
+ [key: string]: any;
27296
+ };
27297
+ type Store = {
27298
+ address1?: string;
27299
+ address2?: string;
27300
+ city?: string;
27301
+ countryCode?: string;
27302
+ distance?: number;
27303
+ distanceUnit?: string;
27304
+ email?: string;
27305
+ fax?: string;
27306
+ id: string;
27307
+ image?: string;
27308
+ inventoryId?: string;
27309
+ latitude?: number;
27310
+ longitude?: number;
27311
+ name?: string;
27312
+ phone?: string;
27313
+ posEnabled?: boolean;
27314
+ postalCode?: string;
27315
+ stateCode?: string;
27316
+ storeEvents?: string;
27317
+ storeHours?: string;
27318
+ storeLocatorEnabled?: boolean;
27319
+ } & {
27320
+ [key: string]: any;
27321
+ };
27322
+ /**
27323
+ * All path parameters that are used by at least one ShopperStores method.
27324
+ */
27325
+ type ShopperStoresPathParameters = {
27326
+ organizationId?: string;
27327
+ };
27328
+ /**
27329
+ * All query parameters that are used by at least one ShopperStores method.
27330
+ */
27331
+ type ShopperStoresQueryParameters = {
27332
+ countryCode?: string;
27333
+ distanceUnit?: string;
27334
+ latitude?: number;
27335
+ longitude?: number;
27336
+ maxDistance?: number;
27337
+ postalCode?: string;
27338
+ siteId?: string;
27339
+ locale?: string;
27340
+ offset?: any;
27341
+ limit?: number;
27342
+ ids?: string;
27343
+ };
27344
+ /**
27345
+ * All parameters that are used by ShopperStores.
27346
+ */
27347
+ type ShopperStoresParameters = ShopperStoresPathParameters & BaseUriParameters & ShopperStoresQueryParameters;
27348
+ /**
27349
+ * [Shopper Stores](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-stores:Summary)
27350
+ * ==================================
27351
+ *
27352
+ * *Search for a specific store or stores in an area.*<br />
27353
+ *
27354
+ * Simple example:
27355
+ *
27356
+ * ```typescript
27357
+ * import { ShopperStores } from "commerce-sdk-isomorphic";
27358
+ *
27359
+ * const clientConfig = {
27360
+ * parameters: {
27361
+ * clientId: "XXXXXX",
27362
+ * organizationId: "XXXX",
27363
+ * shortCode: "XXX",
27364
+ * siteId: "XX"
27365
+ * }
27366
+ * };
27367
+ * const shopperStoresClient = new ShopperStores(clientConfig);
27368
+ * ```
27369
+ *
27370
+ * <span style="font-size:.7em; display:block; text-align: right">
27371
+ * API Version: 1.0.13<br />
27372
+ * Last Updated: <br />
27373
+ * </span>
27374
+ * @beta
27375
+ *
27376
+ *
27377
+
27378
+ */
27379
+ declare class ShopperStores<ConfigParameters extends ShopperStoresParameters & Record<string, unknown>> {
27380
+ // baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
27381
+ clientConfig: ClientConfig<ConfigParameters> & {
27382
+ baseUri: string;
27383
+ };
27384
+ static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/store/shopper-stores/{version}";
27385
+ constructor(config: ClientConfigInit<ConfigParameters>);
27386
+ /**
27387
+ * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation. The distance is interpreted either in miles or kilometers, depending on the distanceUnit input parameter. The location is specified either by directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
27388
+ *
27389
+ * If you would like to get a raw Response object use the other searchStores function.
27390
+ *
27391
+ * @param options - An object containing the options for this method.
27392
+ * @param parameters - An object containing the parameters for this method.
27393
+ * @param organizationId - An identifier for the organization the request is being made by.
27394
+ * @param countryCode - The two letter ISO country code, such as "US". This value is required when a postalCode is provided.
27395
+ * @param distanceUnit - The distance unit. Supported values are "mi" (miles) and "km" (kilometers). The default is "km".
27396
+ * @param latitude - The geographical latitude to search for stores (value range -90.00 .. 90.00). This value is required when a longitude is provided.
27397
+ * @param longitude - The geographical longitude to search for stores (value range -180.00 .. 180.00). You must provide a longitude when a latitude is provided.
27398
+ * @param maxDistance - The area (radius) in distanceUnit where stores will be searched.
27399
+ * @param postalCode - The postal code, such as "84121". You must provide a countryCode when a postalCode is provided.
27400
+ * @param siteId -
27401
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
27402
+ Below are some valid examples:
27403
+ - en-US
27404
+ - de-AT
27405
+ - de
27406
+ - default
27407
+ * @param offset -
27408
+ * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
27409
+ * @param headers - An object literal of key value pairs of the headers to be
27410
+ * sent with this request.
27411
+ *
27412
+ * @returns A promise of type StoreResult.
27413
+ *
27414
+ * @beta
27415
+ *
27416
+ */
27417
+ searchStores(options?: RequireParametersUnlessAllAreOptional<{
27418
+ parameters?: CompositeParameters<{
27419
+ organizationId: string;
27420
+ countryCode?: string;
27421
+ distanceUnit?: string;
27422
+ latitude?: number;
27423
+ longitude?: number;
27424
+ maxDistance?: number;
27425
+ postalCode?: string;
27426
+ siteId: string;
27427
+ locale?: string;
27428
+ offset?: any;
27429
+ limit?: number;
27430
+ } & {
27431
+ [key in `c_${string}`]: any;
27432
+ }, ConfigParameters>;
27433
+ headers?: {
27434
+ [key: string]: string;
27435
+ };
27436
+ }>): Promise<StoreResult>;
27437
+ /**
27438
+ * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation. The distance is interpreted either in miles or kilometers, depending on the distanceUnit input parameter. The location is specified either by directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
26523
27439
  *
26524
- * If you would like to get a raw Response object use the other getUrlMapping function.
27440
+ * @param options - An object containing the options for this method.
27441
+ * @param parameters - An object containing the parameters for this method.
27442
+ * @param organizationId - An identifier for the organization the request is being made by.
27443
+ * @param countryCode - The two letter ISO country code, such as "US". This value is required when a postalCode is provided.
27444
+ * @param distanceUnit - The distance unit. Supported values are "mi" (miles) and "km" (kilometers). The default is "km".
27445
+ * @param latitude - The geographical latitude to search for stores (value range -90.00 .. 90.00). This value is required when a longitude is provided.
27446
+ * @param longitude - The geographical longitude to search for stores (value range -180.00 .. 180.00). You must provide a longitude when a latitude is provided.
27447
+ * @param maxDistance - The area (radius) in distanceUnit where stores will be searched.
27448
+ * @param postalCode - The postal code, such as "84121". You must provide a countryCode when a postalCode is provided.
27449
+ * @param siteId -
27450
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
27451
+ Below are some valid examples:
27452
+ - en-US
27453
+ - de-AT
27454
+ - de
27455
+ - default
27456
+ * @param offset -
27457
+ * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
27458
+ * @param headers - An object literal of key value pairs of the headers to be
27459
+ * sent with this request.
27460
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
27461
+ * @returns A promise of type Response if rawResponse is true, a promise of type StoreResult otherwise.
27462
+ *
27463
+ * @beta
27464
+ *
27465
+ */
27466
+ searchStores<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
27467
+ parameters?: CompositeParameters<{
27468
+ organizationId: string;
27469
+ countryCode?: string;
27470
+ distanceUnit?: string;
27471
+ latitude?: number;
27472
+ longitude?: number;
27473
+ maxDistance?: number;
27474
+ postalCode?: string;
27475
+ siteId: string;
27476
+ locale?: string;
27477
+ offset?: any;
27478
+ limit?: number;
27479
+ } & {
27480
+ [key in `c_${string}`]: any;
27481
+ }, ConfigParameters>;
27482
+ headers?: {
27483
+ [key: string]: string;
27484
+ };
27485
+ }>, rawResponse?: T): Promise<T extends true ? Response : StoreResult>;
27486
+ /**
27487
+ * Returns stores identified by the IDs provided as input.
27488
+ *
27489
+ * If you would like to get a raw Response object use the other getStores function.
26525
27490
  *
26526
27491
  * @param options - An object containing the options for this method.
26527
27492
  * @param parameters - An object containing the parameters for this method.
26528
27493
  * @param organizationId - An identifier for the organization the request is being made by.
26529
- * @param urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for "www.abc.com/blue/new-arrivals/tops" is "blue/new-arrivals/tops". There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters. Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
26530
27494
  * @param siteId -
27495
+ * @param ids - The IDs of a requested stores (comma separated, max 50 IDs).
26531
27496
  * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
26532
27497
  Below are some valid examples:
26533
27498
  - en-US
26534
27499
  - de-AT
26535
27500
  - de
26536
27501
  - default
26537
- Please note that if no locale is specified, the default site locale will be used.
26538
27502
  * @param headers - An object literal of key value pairs of the headers to be
26539
27503
  * sent with this request.
26540
27504
  *
26541
- * @returns A promise of type UrlMapping.
27505
+ * @returns A promise of type StoreResult.
27506
+ *
27507
+ * @beta
26542
27508
  *
26543
27509
  */
26544
- getUrlMapping(options?: RequireParametersUnlessAllAreOptional<{
27510
+ getStores(options?: RequireParametersUnlessAllAreOptional<{
26545
27511
  parameters?: CompositeParameters<{
26546
27512
  organizationId: string;
26547
- urlSegment: string;
26548
27513
  siteId: string;
27514
+ ids: string;
26549
27515
  locale?: string;
26550
27516
  } & {
26551
27517
  [key in `c_${string}`]: any;
@@ -26553,33 +27519,34 @@ declare class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<
26553
27519
  headers?: {
26554
27520
  [key: string]: string;
26555
27521
  };
26556
- }>): Promise<UrlMapping>;
27522
+ }>): Promise<StoreResult>;
26557
27523
  /**
26558
- * Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
27524
+ * Returns stores identified by the IDs provided as input.
26559
27525
  *
26560
27526
  * @param options - An object containing the options for this method.
26561
27527
  * @param parameters - An object containing the parameters for this method.
26562
27528
  * @param organizationId - An identifier for the organization the request is being made by.
26563
- * @param urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for "www.abc.com/blue/new-arrivals/tops" is "blue/new-arrivals/tops". There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters. Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
26564
27529
  * @param siteId -
27530
+ * @param ids - The IDs of a requested stores (comma separated, max 50 IDs).
26565
27531
  * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
26566
27532
  Below are some valid examples:
26567
27533
  - en-US
26568
27534
  - de-AT
26569
27535
  - de
26570
27536
  - default
26571
- Please note that if no locale is specified, the default site locale will be used.
26572
27537
  * @param headers - An object literal of key value pairs of the headers to be
26573
27538
  * sent with this request.
26574
27539
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
26575
- * @returns A promise of type Response if rawResponse is true, a promise of type UrlMapping otherwise.
27540
+ * @returns A promise of type Response if rawResponse is true, a promise of type StoreResult otherwise.
27541
+ *
27542
+ * @beta
26576
27543
  *
26577
27544
  */
26578
- getUrlMapping<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
27545
+ getStores<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
26579
27546
  parameters?: CompositeParameters<{
26580
27547
  organizationId: string;
26581
- urlSegment: string;
26582
27548
  siteId: string;
27549
+ ids: string;
26583
27550
  locale?: string;
26584
27551
  } & {
26585
27552
  [key in `c_${string}`]: any;
@@ -26587,9 +27554,9 @@ declare class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<
26587
27554
  headers?: {
26588
27555
  [key: string]: string;
26589
27556
  };
26590
- }>, rawResponse?: T): Promise<T extends true ? Response : UrlMapping>;
27557
+ }>, rawResponse?: T): Promise<T extends true ? Response : StoreResult>;
26591
27558
  }
26592
- declare namespace ShopperSeoTypes {
27559
+ declare namespace ShopperStoresTypes {
26593
27560
  /*
26594
27561
  * Copyright (c) 2023, Salesforce, Inc.
26595
27562
  * All rights reserved.
@@ -26696,17 +27663,17 @@ declare namespace ShopperSeoTypes {
26696
27663
  };
26697
27664
  type SearchRequest = {
26698
27665
  limit?: number;
26699
- query: Query$9;
26700
- sorts?: Array<Sort$9>;
27666
+ query: Query$11;
27667
+ sorts?: Array<Sort$11>;
26701
27668
  offset?: any;
26702
27669
  } & {
26703
27670
  [key: string]: any;
26704
27671
  };
26705
27672
  type PropertyDefinition = {
26706
- defaultValue?: PropertyValueDefinition$8;
27673
+ defaultValue?: PropertyValueDefinition$10;
26707
27674
  id?: string;
26708
- name: L10nString$8;
26709
- description: L10nString$8;
27675
+ name: L10nString$10;
27676
+ description: L10nString$10;
26710
27677
  key?: boolean;
26711
27678
  localizable?: boolean;
26712
27679
  mandatory?: boolean;
@@ -26719,8 +27686,8 @@ declare namespace ShopperSeoTypes {
26719
27686
  searchable?: boolean;
26720
27687
  siteSpecific?: boolean;
26721
27688
  system?: boolean;
26722
- unit?: L10nString$8;
26723
- possibleValues?: Array<PropertyValueDefinition$8>;
27689
+ unit?: L10nString$10;
27690
+ possibleValues?: Array<PropertyValueDefinition$10>;
26724
27691
  type: string;
26725
27692
  visible?: boolean;
26726
27693
  } & {
@@ -26730,8 +27697,8 @@ declare namespace ShopperSeoTypes {
26730
27697
  [key: string]: any;
26731
27698
  };
26732
27699
  type PaginatedSearchResult = {
26733
- query: Query$9;
26734
- sorts?: Array<Sort$9>;
27700
+ query: Query$11;
27701
+ sorts?: Array<Sort$11>;
26735
27702
  limit: number;
26736
27703
  hits?: Array<object>;
26737
27704
  offset: any;
@@ -26750,14 +27717,14 @@ declare namespace ShopperSeoTypes {
26750
27717
  [key: string]: any;
26751
27718
  };
26752
27719
  type BoolFilter = {
26753
- filters?: Array<Filter$9>;
27720
+ filters?: Array<Filter$11>;
26754
27721
  operator: string;
26755
27722
  } & {
26756
27723
  [key: string]: any;
26757
27724
  };
26758
27725
  type PaginatedSearchResultBase = {
26759
- query: Query$9;
26760
- sorts?: Array<Sort$9>;
27726
+ query: Query$11;
27727
+ sorts?: Array<Sort$11>;
26761
27728
  limit: number;
26762
27729
  hits?: Array<object>;
26763
27730
  offset: any;
@@ -26769,23 +27736,23 @@ declare namespace ShopperSeoTypes {
26769
27736
  [key: string]: any;
26770
27737
  };
26771
27738
  type FilteredQuery = {
26772
- filter: Filter$9;
26773
- query: Query$9;
27739
+ filter: Filter$11;
27740
+ query: Query$11;
26774
27741
  } & {
26775
27742
  [key: string]: any;
26776
27743
  };
26777
27744
  type QueryFilter = {
26778
- query: Query$9;
27745
+ query: Query$11;
26779
27746
  } & {
26780
27747
  [key: string]: any;
26781
27748
  };
26782
27749
  type Query = {
26783
- boolQuery?: BoolQuery$9;
27750
+ boolQuery?: BoolQuery$11;
26784
27751
  filteredQuery?: FilteredQuery;
26785
27752
  matchAllQuery?: MatchAllQuery;
26786
- nestedQuery?: NestedQuery$9;
26787
- termQuery?: TermQuery$9;
26788
- textQuery?: TextQuery$9;
27753
+ nestedQuery?: NestedQuery$11;
27754
+ termQuery?: TermQuery$11;
27755
+ textQuery?: TextQuery$11;
26789
27756
  } & {
26790
27757
  [key: string]: any;
26791
27758
  };
@@ -26846,7 +27813,7 @@ declare namespace ShopperSeoTypes {
26846
27813
  boolFilter?: BoolFilter;
26847
27814
  queryFilter?: QueryFilter;
26848
27815
  range2Filter?: Range2Filter;
26849
- rangeFilter?: RangeFilter$9;
27816
+ rangeFilter?: RangeFilter$11;
26850
27817
  termFilter?: TermFilter;
26851
27818
  } & {
26852
27819
  [key: string]: any;
@@ -26884,7 +27851,7 @@ declare namespace ShopperSeoTypes {
26884
27851
  [key: string]: any;
26885
27852
  };
26886
27853
  type AttributeDefinition = {
26887
- defaultValue?: PropertyValueDefinition$8;
27854
+ defaultValue?: PropertyValueDefinition$10;
26888
27855
  id?: string;
26889
27856
  name: L10nString;
26890
27857
  description: L10nString;
@@ -26901,7 +27868,7 @@ declare namespace ShopperSeoTypes {
26901
27868
  siteSpecific?: boolean;
26902
27869
  system?: boolean;
26903
27870
  unit?: L10nString;
26904
- possibleValues?: Array<PropertyValueDefinition$8>;
27871
+ possibleValues?: Array<PropertyValueDefinition$10>;
26905
27872
  type: string;
26906
27873
  visible?: boolean;
26907
27874
  };
@@ -26912,21 +27879,6 @@ declare namespace ShopperSeoTypes {
26912
27879
  position?: number;
26913
27880
  value: string;
26914
27881
  };
26915
- type UrlMapping = {
26916
- resourceType?: string;
26917
- resourceSubType?: string;
26918
- resourceId?: string;
26919
- refinements?: {} & {
26920
- [key: string]: any;
26921
- };
26922
- statusCode?: number;
26923
- destinationUrl?: string;
26924
- copySourceParams?: boolean;
26925
- additionalUrlParams?: string;
26926
- productCategoryId?: string;
26927
- } & {
26928
- [key: string]: any;
26929
- };
26930
27882
  type ErrorResponse = {
26931
27883
  type: string;
26932
27884
  title?: string;
@@ -26959,34 +27911,75 @@ declare namespace ShopperSeoTypes {
26959
27911
  } & {
26960
27912
  [key: string]: any;
26961
27913
  };
27914
+ type StoreResult = {
27915
+ limit: number;
27916
+ data: Array<Store>;
27917
+ offset?: any;
27918
+ total: any;
27919
+ } & {
27920
+ [key: string]: any;
27921
+ };
27922
+ type Store = {
27923
+ address1?: string;
27924
+ address2?: string;
27925
+ city?: string;
27926
+ countryCode?: string;
27927
+ distance?: number;
27928
+ distanceUnit?: string;
27929
+ email?: string;
27930
+ fax?: string;
27931
+ id: string;
27932
+ image?: string;
27933
+ inventoryId?: string;
27934
+ latitude?: number;
27935
+ longitude?: number;
27936
+ name?: string;
27937
+ phone?: string;
27938
+ posEnabled?: boolean;
27939
+ postalCode?: string;
27940
+ stateCode?: string;
27941
+ storeEvents?: string;
27942
+ storeHours?: string;
27943
+ storeLocatorEnabled?: boolean;
27944
+ } & {
27945
+ [key: string]: any;
27946
+ };
26962
27947
  /**
26963
- * All path parameters that are used by at least one ShopperSeo method.
27948
+ * All path parameters that are used by at least one ShopperStores method.
26964
27949
  */
26965
- type ShopperSeoPathParameters = {
27950
+ type ShopperStoresPathParameters = {
26966
27951
  organizationId?: string;
26967
27952
  };
26968
27953
  /**
26969
- * All query parameters that are used by at least one ShopperSeo method.
27954
+ * All query parameters that are used by at least one ShopperStores method.
26970
27955
  */
26971
- type ShopperSeoQueryParameters = {
26972
- urlSegment?: string;
27956
+ type ShopperStoresQueryParameters = {
27957
+ countryCode?: string;
27958
+ distanceUnit?: string;
27959
+ latitude?: number;
27960
+ longitude?: number;
27961
+ maxDistance?: number;
27962
+ postalCode?: string;
26973
27963
  siteId?: string;
26974
27964
  locale?: string;
27965
+ offset?: any;
27966
+ limit?: number;
27967
+ ids?: string;
26975
27968
  };
26976
27969
  /**
26977
- * All parameters that are used by ShopperSeo.
27970
+ * All parameters that are used by ShopperStores.
26978
27971
  */
26979
- type ShopperSeoParameters = ShopperSeoPathParameters & BaseUriParameters & ShopperSeoQueryParameters;
27972
+ type ShopperStoresParameters = ShopperStoresPathParameters & BaseUriParameters & ShopperStoresQueryParameters;
26980
27973
  /**
26981
- * [Shopper Seo](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-seo:Summary)
27974
+ * [Shopper Stores](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-stores:Summary)
26982
27975
  * ==================================
26983
27976
  *
26984
- * **<br />
27977
+ * *Search for a specific store or stores in an area.*<br />
26985
27978
  *
26986
27979
  * Simple example:
26987
27980
  *
26988
27981
  * ```typescript
26989
- * import { ShopperSeo } from "commerce-sdk-isomorphic";
27982
+ * import { ShopperStores } from "commerce-sdk-isomorphic";
26990
27983
  *
26991
27984
  * const clientConfig = {
26992
27985
  * parameters: {
@@ -26996,33 +27989,39 @@ declare namespace ShopperSeoTypes {
26996
27989
  * siteId: "XX"
26997
27990
  * }
26998
27991
  * };
26999
- * const shopperSeoClient = new ShopperSeo(clientConfig);
27992
+ * const shopperStoresClient = new ShopperStores(clientConfig);
27000
27993
  * ```
27001
27994
  *
27002
27995
  * <span style="font-size:.7em; display:block; text-align: right">
27003
- * API Version: 1.0.6<br />
27996
+ * API Version: 1.0.13<br />
27004
27997
  * Last Updated: <br />
27005
27998
  * </span>
27006
-
27999
+ * @beta
28000
+ *
27007
28001
  *
27008
28002
 
27009
28003
  */
27010
- class ShopperSeo<ConfigParameters extends ShopperSeoParameters & Record<string, unknown>> {
28004
+ class ShopperStores<ConfigParameters extends ShopperStoresParameters & Record<string, unknown>> {
27011
28005
  // baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
27012
28006
  clientConfig: ClientConfig<ConfigParameters> & {
27013
28007
  baseUri: string;
27014
28008
  };
27015
- static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/site/shopper-seo/{version}";
28009
+ static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/store/shopper-stores/{version}";
27016
28010
  constructor(config: ClientConfigInit<ConfigParameters>);
27017
28011
  /**
27018
- * Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
28012
+ * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation. The distance is interpreted either in miles or kilometers, depending on the distanceUnit input parameter. The location is specified either by directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
27019
28013
  *
27020
- * If you would like to get a raw Response object use the other getUrlMapping function.
28014
+ * If you would like to get a raw Response object use the other searchStores function.
27021
28015
  *
27022
28016
  * @param options - An object containing the options for this method.
27023
28017
  * @param parameters - An object containing the parameters for this method.
27024
28018
  * @param organizationId - An identifier for the organization the request is being made by.
27025
- * @param urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for "www.abc.com/blue/new-arrivals/tops" is "blue/new-arrivals/tops". There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters. Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
28019
+ * @param countryCode - The two letter ISO country code, such as "US". This value is required when a postalCode is provided.
28020
+ * @param distanceUnit - The distance unit. Supported values are "mi" (miles) and "km" (kilometers). The default is "km".
28021
+ * @param latitude - The geographical latitude to search for stores (value range -90.00 .. 90.00). This value is required when a longitude is provided.
28022
+ * @param longitude - The geographical longitude to search for stores (value range -180.00 .. 180.00). You must provide a longitude when a latitude is provided.
28023
+ * @param maxDistance - The area (radius) in distanceUnit where stores will be searched.
28024
+ * @param postalCode - The postal code, such as "84121". You must provide a countryCode when a postalCode is provided.
27026
28025
  * @param siteId -
27027
28026
  * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
27028
28027
  Below are some valid examples:
@@ -27030,33 +28029,48 @@ declare namespace ShopperSeoTypes {
27030
28029
  - de-AT
27031
28030
  - de
27032
28031
  - default
27033
- Please note that if no locale is specified, the default site locale will be used.
28032
+ * @param offset -
28033
+ * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
27034
28034
  * @param headers - An object literal of key value pairs of the headers to be
27035
28035
  * sent with this request.
27036
28036
  *
27037
- * @returns A promise of type UrlMapping.
28037
+ * @returns A promise of type StoreResult.
28038
+ *
28039
+ * @beta
27038
28040
  *
27039
28041
  */
27040
- getUrlMapping(options?: RequireParametersUnlessAllAreOptional<{
28042
+ searchStores(options?: RequireParametersUnlessAllAreOptional<{
27041
28043
  parameters?: CompositeParameters<{
27042
28044
  organizationId: string;
27043
- urlSegment: string;
28045
+ countryCode?: string;
28046
+ distanceUnit?: string;
28047
+ latitude?: number;
28048
+ longitude?: number;
28049
+ maxDistance?: number;
28050
+ postalCode?: string;
27044
28051
  siteId: string;
27045
28052
  locale?: string;
28053
+ offset?: any;
28054
+ limit?: number;
27046
28055
  } & {
27047
28056
  [key in `c_${string}`]: any;
27048
28057
  }, ConfigParameters>;
27049
28058
  headers?: {
27050
28059
  [key: string]: string;
27051
28060
  };
27052
- }>): Promise<UrlMapping>;
28061
+ }>): Promise<StoreResult>;
27053
28062
  /**
27054
- * Gets URL mapping information for a URL that a shopper clicked or typed in. The mapping information is based on URL rules and redirects set up in Business Manager. For more information about prerequisites and sample usage, see [URL Resolution](/docs/commerce/commerce-api/guide/url-resolution.html). You can customize the behavior of this endpoint by using hooks. See the hooks for getUrlMapping in the [Hook List](https://developer.salesforce.com/docs/commerce/commerce-api/guide/hook_list.html).
28063
+ * This resource retrieves a list of stores for the given site that are within a configured distance of a geolocation. The distance is interpreted either in miles or kilometers, depending on the distanceUnit input parameter. The location is specified either by directly providing a latitude and longitude coordinate pair, or by providing a country and a postal code. If a postal code is passed, the resource looks in the system's geolocation mappings to find the coordinates for this postal code. If no matching geolocation is found, the resource returns an empty list of stores. If coordinates are passed, the values for country and postal code are ignored.
27055
28064
  *
27056
28065
  * @param options - An object containing the options for this method.
27057
28066
  * @param parameters - An object containing the parameters for this method.
27058
28067
  * @param organizationId - An identifier for the organization the request is being made by.
27059
- * @param urlSegment - The part of the requested URL that comes after the domain name. For example, the urlSegment for "www.abc.com/blue/new-arrivals/tops" is "blue/new-arrivals/tops". There's no limit on the length of the urlSegment. However, for this endpoint, the maximum allowed length of the URL (after URL encoding) is 2047 characters. Make this field URL-encoded so that it properly handles special values such as whitespace. If a urlSegment includes a query string, a 404 error code is returned.
28068
+ * @param countryCode - The two letter ISO country code, such as "US". This value is required when a postalCode is provided.
28069
+ * @param distanceUnit - The distance unit. Supported values are "mi" (miles) and "km" (kilometers). The default is "km".
28070
+ * @param latitude - The geographical latitude to search for stores (value range -90.00 .. 90.00). This value is required when a longitude is provided.
28071
+ * @param longitude - The geographical longitude to search for stores (value range -180.00 .. 180.00). You must provide a longitude when a latitude is provided.
28072
+ * @param maxDistance - The area (radius) in distanceUnit where stores will be searched.
28073
+ * @param postalCode - The postal code, such as "84121". You must provide a countryCode when a postalCode is provided.
27060
28074
  * @param siteId -
27061
28075
  * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
27062
28076
  Below are some valid examples:
@@ -27064,26 +28078,108 @@ declare namespace ShopperSeoTypes {
27064
28078
  - de-AT
27065
28079
  - de
27066
28080
  - default
27067
- Please note that if no locale is specified, the default site locale will be used.
28081
+ * @param offset -
28082
+ * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
27068
28083
  * @param headers - An object literal of key value pairs of the headers to be
27069
28084
  * sent with this request.
27070
28085
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
27071
- * @returns A promise of type Response if rawResponse is true, a promise of type UrlMapping otherwise.
28086
+ * @returns A promise of type Response if rawResponse is true, a promise of type StoreResult otherwise.
28087
+ *
28088
+ * @beta
27072
28089
  *
27073
28090
  */
27074
- getUrlMapping<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
28091
+ searchStores<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
27075
28092
  parameters?: CompositeParameters<{
27076
28093
  organizationId: string;
27077
- urlSegment: string;
28094
+ countryCode?: string;
28095
+ distanceUnit?: string;
28096
+ latitude?: number;
28097
+ longitude?: number;
28098
+ maxDistance?: number;
28099
+ postalCode?: string;
27078
28100
  siteId: string;
27079
28101
  locale?: string;
28102
+ offset?: any;
28103
+ limit?: number;
27080
28104
  } & {
27081
28105
  [key in `c_${string}`]: any;
27082
28106
  }, ConfigParameters>;
27083
28107
  headers?: {
27084
28108
  [key: string]: string;
27085
28109
  };
27086
- }>, rawResponse?: T): Promise<T extends true ? Response : UrlMapping>;
28110
+ }>, rawResponse?: T): Promise<T extends true ? Response : StoreResult>;
28111
+ /**
28112
+ * Returns stores identified by the IDs provided as input.
28113
+ *
28114
+ * If you would like to get a raw Response object use the other getStores function.
28115
+ *
28116
+ * @param options - An object containing the options for this method.
28117
+ * @param parameters - An object containing the parameters for this method.
28118
+ * @param organizationId - An identifier for the organization the request is being made by.
28119
+ * @param siteId -
28120
+ * @param ids - The IDs of a requested stores (comma separated, max 50 IDs).
28121
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
28122
+ Below are some valid examples:
28123
+ - en-US
28124
+ - de-AT
28125
+ - de
28126
+ - default
28127
+ * @param headers - An object literal of key value pairs of the headers to be
28128
+ * sent with this request.
28129
+ *
28130
+ * @returns A promise of type StoreResult.
28131
+ *
28132
+ * @beta
28133
+ *
28134
+ */
28135
+ getStores(options?: RequireParametersUnlessAllAreOptional<{
28136
+ parameters?: CompositeParameters<{
28137
+ organizationId: string;
28138
+ siteId: string;
28139
+ ids: string;
28140
+ locale?: string;
28141
+ } & {
28142
+ [key in `c_${string}`]: any;
28143
+ }, ConfigParameters>;
28144
+ headers?: {
28145
+ [key: string]: string;
28146
+ };
28147
+ }>): Promise<StoreResult>;
28148
+ /**
28149
+ * Returns stores identified by the IDs provided as input.
28150
+ *
28151
+ * @param options - An object containing the options for this method.
28152
+ * @param parameters - An object containing the parameters for this method.
28153
+ * @param organizationId - An identifier for the organization the request is being made by.
28154
+ * @param siteId -
28155
+ * @param ids - The IDs of a requested stores (comma separated, max 50 IDs).
28156
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
28157
+ Below are some valid examples:
28158
+ - en-US
28159
+ - de-AT
28160
+ - de
28161
+ - default
28162
+ * @param headers - An object literal of key value pairs of the headers to be
28163
+ * sent with this request.
28164
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
28165
+ * @returns A promise of type Response if rawResponse is true, a promise of type StoreResult otherwise.
28166
+ *
28167
+ * @beta
28168
+ *
28169
+ */
28170
+ getStores<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
28171
+ parameters?: CompositeParameters<{
28172
+ organizationId: string;
28173
+ siteId: string;
28174
+ ids: string;
28175
+ locale?: string;
28176
+ } & {
28177
+ [key in `c_${string}`]: any;
28178
+ }, ConfigParameters>;
28179
+ headers?: {
28180
+ [key: string]: string;
28181
+ };
28182
+ }>, rawResponse?: T): Promise<T extends true ? Response : StoreResult>;
27087
28183
  }
27088
28184
  }
27089
28185
  declare class TemplateURL extends URL {
@@ -28908,6 +30004,81 @@ declare namespace helpers {
28908
30004
  accessToken: string;
28909
30005
  refreshToken: string;
28910
30006
  }): Promise<TokenResponse>;
30007
+ interface CustomParams {
30008
+ apiName?: string;
30009
+ apiVersion?: string;
30010
+ endpointPath?: string;
30011
+ organizationId?: string;
30012
+ shortCode: string;
30013
+ [key: string]: unknown;
30014
+ }
30015
+ /**
30016
+ * A helper function designed to make calls to a custom API endpoint
30017
+ * For more information about custom APIs, please refer to the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/guide/custom-apis.html)
30018
+ * @param args - Argument object containing data used for custom API request
30019
+ * @param args.options - An object containing any custom settings you want to apply to the request
30020
+ * @param args.options.method? - The request HTTP operation. 'GET' is the default if no method is provided.
30021
+ * @param args.options.parameters? - Query parameters that are added to the request
30022
+ * @param args.options.customApiPathParameters? - Path parameters used for custom API. Required path parameters (apiName, endpointPath, organizationId, and shortCode) can be in this object, or args.clientConfig.parameters. apiVersion is defaulted to 'v1' if not provided.
30023
+ * @param args.options.headers? - Headers that are added to the request. Authorization header should be in this parameter or in the clientConfig.headers. If "Content-Type" is not provided in either header, it will be defaulted to "application/json".
30024
+ * @param args.options.body? - Body that is used for the request
30025
+ * @param args.clientConfig - Client Configuration object used by the SDK with properties that can affect the fetch call
30026
+ * @param args.clientConfig.parameters - Path parameters used for custom API endpoints. The required properties are: apiName, endpointPath, organizationId, and shortCode. An error will be thrown if these are not provided.
30027
+ * @param args.clientConfig.headers? - Additional headers that are added to the request. Authorization header should be in this argument or in the options?.headers. options?.headers will override any duplicate properties. If "Content-Type" is not provided in either header, it will be defaulted to "application/json".
30028
+ * @param args.clientConfig.baseUri? - baseUri used for the request, where the path parameters are wrapped in curly braces. Default value is 'https://{shortCode}.api.commercecloud.salesforce.com/custom/{apiName}/{apiVersion}'
30029
+ * @param args.clientConfig.fetchOptions? - fetchOptions that are passed onto the fetch request
30030
+ * @param args.clientConfig.throwOnBadResponse? - flag that when set true will throw a response error if the fetch request fails (returns with a status code outside the range of 200-299 or 304 redirect)
30031
+ * @param args.clientConfig.proxy? - Routes API calls through a proxy when set
30032
+ * @param args.rawResponse? - Flag to return the raw response from the fetch call. True for raw response object, false for the data from the response
30033
+ * @returns Raw response or data from response based on rawResponse argument from fetch call
30034
+ */
30035
+ const callCustomEndpoint: (args: {
30036
+ options: {
30037
+ method?: string | undefined;
30038
+ parameters?: {
30039
+ [key: string]: string | number | boolean | string[] | number[];
30040
+ } | undefined;
30041
+ customApiPathParameters?: {
30042
+ apiName?: string | undefined;
30043
+ apiVersion?: string | undefined;
30044
+ endpointPath?: string | undefined;
30045
+ organizationId?: string | undefined;
30046
+ shortCode?: string | undefined;
30047
+ } | undefined;
30048
+ headers?: ({
30049
+ authorization?: string | undefined;
30050
+ } & {
30051
+ [key: string]: string;
30052
+ }) | undefined;
30053
+ body?: BodyInit | globalThis.BodyInit | unknown;
30054
+ };
30055
+ clientConfig: ClientConfigInit<CustomParams>;
30056
+ rawResponse?: boolean | undefined;
30057
+ }) => Promise<Response | unknown>;
30058
+ /**
30059
+ * A wrapper function around fetch designed for making requests using the SDK
30060
+ * @param url - The url of the resource that you wish to fetch
30061
+ * @param options? - An object containing any custom settings you want to apply to the request
30062
+ * @param options.method? - The request HTTP operation. 'GET' is the default if no method is provided.
30063
+ * @param options.headers? - Headers that are added to the request. Authorization header should be in this argument or in the clientConfig.headers
30064
+ * @param options.body? - Body that is used for the request
30065
+ * @param clientConfig? - Client Configuration object used by the SDK with properties that can affect the fetch call
30066
+ * @param clientConfig.headers? - Additional headers that are added to the request. Authorization header should be in this argument or in the options?.headers. options?.headers will override any duplicate properties.
30067
+ * @param clientConfig.fetchOptions? - fetchOptions that are passed onto the fetch request
30068
+ * @param clientConfig.throwOnBadResponse? - flag that when set true will throw a response error if the fetch request fails
30069
+ * @param rawResponse? - Flag to return the raw response from the fetch call. True for raw response object, false for the data from the response
30070
+ * @returns Raw response or data from response based on rawResponse argument from fetch call
30071
+ */
30072
+ // eslint-disable-next-line import/prefer-default-export
30073
+ const doFetch: <Params extends BaseUriParameters>(url: string, options?: {
30074
+ method?: string | undefined;
30075
+ headers?: ({
30076
+ authorization?: string | undefined;
30077
+ } & {
30078
+ [key: string]: string;
30079
+ }) | undefined;
30080
+ body?: BodyInit | globalThis.BodyInit | unknown;
30081
+ } | undefined, clientConfig?: ClientConfigInit<Params> | undefined, rawResponse?: boolean | undefined) => Promise<Response | unknown>;
28911
30082
  }
28912
- export { ShopperBaskets, ShopperContexts, ShopperCustomers, ShopperDiscoverySearch, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSeo, ClientConfig, TemplateURL, helpers };
28913
- export type { ShopperBasketsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperDiscoverySearchTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperLoginTypes, ShopperOrdersTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ShopperSeoTypes, ClientConfigInit };
30083
+ export { ShopperBaskets, ShopperContexts, ShopperCustomers, ShopperDiscoverySearch, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ShopperSeo, ShopperStores, ClientConfig, TemplateURL, helpers };
30084
+ export type { ShopperBasketsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperDiscoverySearchTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperLoginTypes, ShopperOrdersTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ShopperSeoTypes, ShopperStoresTypes, ClientConfigInit };