commerce-sdk-isomorphic 1.12.0 → 1.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/lib/index.cjs.d.ts +321 -503
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +321 -503
- package/lib/index.esm.js +1 -1
- package/package.json +1 -1
package/lib/index.esm.d.ts
CHANGED
|
@@ -697,7 +697,7 @@ type ShopperBasketsParameters = ShopperBasketsPathParameters & BaseUriParameters
|
|
|
697
697
|
* ```
|
|
698
698
|
*
|
|
699
699
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
700
|
-
* API Version: 2.0.
|
|
700
|
+
* API Version: 2.0.3<br />
|
|
701
701
|
* Last Updated: <br />
|
|
702
702
|
* </span>
|
|
703
703
|
|
|
@@ -4397,7 +4397,7 @@ declare namespace ShopperBasketsTypes {
|
|
|
4397
4397
|
* ```
|
|
4398
4398
|
*
|
|
4399
4399
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
4400
|
-
* API Version: 2.0.
|
|
4400
|
+
* API Version: 2.0.3<br />
|
|
4401
4401
|
* Last Updated: <br />
|
|
4402
4402
|
* </span>
|
|
4403
4403
|
|
|
@@ -17584,7 +17584,7 @@ type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & S
|
|
|
17584
17584
|
* ```
|
|
17585
17585
|
*
|
|
17586
17586
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
17587
|
-
* API Version: 1.39.
|
|
17587
|
+
* API Version: 1.39.22<br />
|
|
17588
17588
|
* Last Updated: <br />
|
|
17589
17589
|
* </span>
|
|
17590
17590
|
|
|
@@ -19214,7 +19214,7 @@ declare namespace ShopperLoginTypes {
|
|
|
19214
19214
|
* ```
|
|
19215
19215
|
*
|
|
19216
19216
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
19217
|
-
* API Version: 1.39.
|
|
19217
|
+
* API Version: 1.39.22<br />
|
|
19218
19218
|
* Last Updated: <br />
|
|
19219
19219
|
* </span>
|
|
19220
19220
|
|
|
@@ -24400,6 +24400,36 @@ type PromotionResult = {
|
|
|
24400
24400
|
type RangeFilter$8 = {
|
|
24401
24401
|
[key: string]: any;
|
|
24402
24402
|
};
|
|
24403
|
+
type BoolFilter$8 = {
|
|
24404
|
+
filters?: Array<any>;
|
|
24405
|
+
operator: string;
|
|
24406
|
+
} & {
|
|
24407
|
+
[key: string]: any;
|
|
24408
|
+
};
|
|
24409
|
+
type MatchAllQuery$8 = {} & {
|
|
24410
|
+
[key: string]: any;
|
|
24411
|
+
};
|
|
24412
|
+
type FilteredQuery$8 = {
|
|
24413
|
+
filter: any;
|
|
24414
|
+
query: any;
|
|
24415
|
+
} & {
|
|
24416
|
+
[key: string]: any;
|
|
24417
|
+
};
|
|
24418
|
+
type QueryFilter$8 = {
|
|
24419
|
+
query: any;
|
|
24420
|
+
} & {
|
|
24421
|
+
[key: string]: any;
|
|
24422
|
+
};
|
|
24423
|
+
type Query$8 = {
|
|
24424
|
+
boolQuery?: BoolQuery$7;
|
|
24425
|
+
filteredQuery?: FilteredQuery$8;
|
|
24426
|
+
matchAllQuery?: MatchAllQuery$8;
|
|
24427
|
+
nestedQuery?: NestedQuery$7;
|
|
24428
|
+
termQuery?: TermQuery$7;
|
|
24429
|
+
textQuery?: TextQuery$7;
|
|
24430
|
+
} & {
|
|
24431
|
+
[key: string]: any;
|
|
24432
|
+
};
|
|
24403
24433
|
type TermQuery$8 = {
|
|
24404
24434
|
fields: Array<string>;
|
|
24405
24435
|
operator: string;
|
|
@@ -24407,12 +24437,30 @@ type TermQuery$8 = {
|
|
|
24407
24437
|
} & {
|
|
24408
24438
|
[key: string]: any;
|
|
24409
24439
|
};
|
|
24440
|
+
type TermFilter$8 = {
|
|
24441
|
+
field: string;
|
|
24442
|
+
operator: string;
|
|
24443
|
+
values?: Array<any>;
|
|
24444
|
+
} & {
|
|
24445
|
+
[key: string]: any;
|
|
24446
|
+
};
|
|
24410
24447
|
type TextQuery$8 = {
|
|
24411
24448
|
fields: Array<string>;
|
|
24412
24449
|
searchPhrase: string;
|
|
24413
24450
|
} & {
|
|
24414
24451
|
[key: string]: any;
|
|
24415
24452
|
};
|
|
24453
|
+
type Range2Filter$8 = {
|
|
24454
|
+
filterMode?: string;
|
|
24455
|
+
fromField: string;
|
|
24456
|
+
fromInclusive?: boolean;
|
|
24457
|
+
fromValue?: any;
|
|
24458
|
+
toField: string;
|
|
24459
|
+
toInclusive?: boolean;
|
|
24460
|
+
toValue?: any;
|
|
24461
|
+
} & {
|
|
24462
|
+
[key: string]: any;
|
|
24463
|
+
};
|
|
24416
24464
|
type BoolQuery$8 = {
|
|
24417
24465
|
must?: Array<any>;
|
|
24418
24466
|
mustNot?: Array<any>;
|
|
@@ -24427,6 +24475,15 @@ type NestedQuery$8 = {
|
|
|
24427
24475
|
} & {
|
|
24428
24476
|
[key: string]: any;
|
|
24429
24477
|
};
|
|
24478
|
+
type Filter$8 = {
|
|
24479
|
+
boolFilter?: BoolFilter$8;
|
|
24480
|
+
queryFilter?: QueryFilter$8;
|
|
24481
|
+
range2Filter?: Range2Filter$8;
|
|
24482
|
+
rangeFilter?: RangeFilter$8;
|
|
24483
|
+
termFilter?: TermFilter$8;
|
|
24484
|
+
} & {
|
|
24485
|
+
[key: string]: any;
|
|
24486
|
+
};
|
|
24430
24487
|
type Sort$8 = {
|
|
24431
24488
|
field: string;
|
|
24432
24489
|
sortOrder?: string;
|
|
@@ -25196,115 +25253,13 @@ declare namespace ShopperPromotionsTypes {
|
|
|
25196
25253
|
}>, rawResponse?: T): Promise<T extends true ? Response : PromotionResult>;
|
|
25197
25254
|
}
|
|
25198
25255
|
}
|
|
25199
|
-
type
|
|
25200
|
-
|
|
25201
|
-
|
|
25202
|
-
|
|
25203
|
-
[key: string]: any;
|
|
25204
|
-
};
|
|
25205
|
-
type MatchAllQuery$9 = {} & {
|
|
25206
|
-
[key: string]: any;
|
|
25207
|
-
};
|
|
25208
|
-
type FilteredQuery$9 = {
|
|
25209
|
-
filter: any;
|
|
25210
|
-
query: any;
|
|
25211
|
-
} & {
|
|
25212
|
-
[key: string]: any;
|
|
25213
|
-
};
|
|
25214
|
-
type QueryFilter$9 = {
|
|
25215
|
-
query: any;
|
|
25216
|
-
} & {
|
|
25217
|
-
[key: string]: any;
|
|
25218
|
-
};
|
|
25219
|
-
type Query$9 = {
|
|
25220
|
-
boolQuery?: BoolQuery$8;
|
|
25221
|
-
filteredQuery?: FilteredQuery$9;
|
|
25222
|
-
matchAllQuery?: MatchAllQuery$9;
|
|
25223
|
-
nestedQuery?: NestedQuery$8;
|
|
25224
|
-
termQuery?: TermQuery$8;
|
|
25225
|
-
textQuery?: TextQuery$8;
|
|
25226
|
-
} & {
|
|
25227
|
-
[key: string]: any;
|
|
25228
|
-
};
|
|
25229
|
-
type TermQuery$9 = {
|
|
25230
|
-
fields: Array<string>;
|
|
25231
|
-
operator: string;
|
|
25232
|
-
values?: Array<any>;
|
|
25233
|
-
} & {
|
|
25234
|
-
[key: string]: any;
|
|
25235
|
-
};
|
|
25236
|
-
type TermFilter$9 = {
|
|
25237
|
-
field: string;
|
|
25238
|
-
operator: string;
|
|
25239
|
-
values?: Array<any>;
|
|
25240
|
-
} & {
|
|
25241
|
-
[key: string]: any;
|
|
25242
|
-
};
|
|
25243
|
-
type TextQuery$9 = {
|
|
25244
|
-
fields: Array<string>;
|
|
25245
|
-
searchPhrase: string;
|
|
25246
|
-
} & {
|
|
25247
|
-
[key: string]: any;
|
|
25248
|
-
};
|
|
25249
|
-
type Range2Filter$9 = {
|
|
25250
|
-
filterMode?: string;
|
|
25251
|
-
fromField: string;
|
|
25252
|
-
fromInclusive?: boolean;
|
|
25253
|
-
fromValue?: any;
|
|
25254
|
-
toField: string;
|
|
25255
|
-
toInclusive?: boolean;
|
|
25256
|
-
toValue?: any;
|
|
25257
|
-
} & {
|
|
25258
|
-
[key: string]: any;
|
|
25259
|
-
};
|
|
25260
|
-
type BoolQuery$9 = {
|
|
25261
|
-
must?: Array<any>;
|
|
25262
|
-
mustNot?: Array<any>;
|
|
25263
|
-
should?: Array<any>;
|
|
25264
|
-
} & {
|
|
25265
|
-
[key: string]: any;
|
|
25266
|
-
};
|
|
25267
|
-
type NestedQuery$9 = {
|
|
25268
|
-
path: string;
|
|
25269
|
-
query: any;
|
|
25270
|
-
scoreMode?: string;
|
|
25271
|
-
} & {
|
|
25272
|
-
[key: string]: any;
|
|
25273
|
-
};
|
|
25274
|
-
type Filter$9 = {
|
|
25275
|
-
boolFilter?: BoolFilter$9;
|
|
25276
|
-
queryFilter?: QueryFilter$9;
|
|
25277
|
-
range2Filter?: Range2Filter$9;
|
|
25278
|
-
rangeFilter?: RangeFilter$8;
|
|
25279
|
-
termFilter?: TermFilter$9;
|
|
25280
|
-
} & {
|
|
25281
|
-
[key: string]: any;
|
|
25282
|
-
};
|
|
25283
|
-
type Sort$9 = {
|
|
25284
|
-
field: string;
|
|
25285
|
-
sortOrder?: string;
|
|
25286
|
-
} & {
|
|
25287
|
-
[key: string]: any;
|
|
25288
|
-
};
|
|
25289
|
-
type RangeFilter$9 = {
|
|
25290
|
-
field: string;
|
|
25291
|
-
from?: any;
|
|
25292
|
-
fromInclusive?: boolean;
|
|
25293
|
-
to?: any;
|
|
25294
|
-
toInclusive?: boolean;
|
|
25256
|
+
type ProductPriceTable$0 = {
|
|
25257
|
+
price?: number;
|
|
25258
|
+
pricebook?: string;
|
|
25259
|
+
quantity?: number;
|
|
25295
25260
|
} & {
|
|
25296
25261
|
[key: string]: any;
|
|
25297
25262
|
};
|
|
25298
|
-
type L10nString$8 = {} & {
|
|
25299
|
-
[key: string]: any;
|
|
25300
|
-
};
|
|
25301
|
-
type PropertyValueDefinition$8 = {
|
|
25302
|
-
description: L10nString$8;
|
|
25303
|
-
displayValue: L10nString$8;
|
|
25304
|
-
id: string;
|
|
25305
|
-
position?: number;
|
|
25306
|
-
value: string;
|
|
25307
|
-
};
|
|
25308
25263
|
type ProductRef = {
|
|
25309
25264
|
id: string;
|
|
25310
25265
|
} & {
|
|
@@ -25316,6 +25271,13 @@ type SuggestedTerms = {
|
|
|
25316
25271
|
} & {
|
|
25317
25272
|
[key: string]: any;
|
|
25318
25273
|
};
|
|
25274
|
+
type PriceRange$0 = {
|
|
25275
|
+
maxPrice?: number;
|
|
25276
|
+
minPrice?: number;
|
|
25277
|
+
pricebook?: string;
|
|
25278
|
+
} & {
|
|
25279
|
+
[key: string]: any;
|
|
25280
|
+
};
|
|
25319
25281
|
type CategorySuggestions = {
|
|
25320
25282
|
categories?: Array<SuggestedCategory>;
|
|
25321
25283
|
suggestedPhrases?: Array<SuggestedPhrase>;
|
|
@@ -25324,7 +25286,7 @@ type CategorySuggestions = {
|
|
|
25324
25286
|
[key: string]: any;
|
|
25325
25287
|
};
|
|
25326
25288
|
type SuggestedProduct = {
|
|
25327
|
-
currency:
|
|
25289
|
+
currency: any;
|
|
25328
25290
|
price: number;
|
|
25329
25291
|
productId: string;
|
|
25330
25292
|
productName: string;
|
|
@@ -25369,6 +25331,28 @@ type ProductType$1 = {
|
|
|
25369
25331
|
} & {
|
|
25370
25332
|
[key: string]: any;
|
|
25371
25333
|
};
|
|
25334
|
+
type Variant$1 = {
|
|
25335
|
+
orderable?: boolean;
|
|
25336
|
+
price?: number;
|
|
25337
|
+
productId: string;
|
|
25338
|
+
tieredPrices?: Array<ProductPriceTable$0>;
|
|
25339
|
+
variationValues?: {} & {
|
|
25340
|
+
[key: string]: any;
|
|
25341
|
+
};
|
|
25342
|
+
productPromotions?: Array<ProductPromotion$0>;
|
|
25343
|
+
} & {
|
|
25344
|
+
[key: string]: any;
|
|
25345
|
+
};
|
|
25346
|
+
type VariationGroup$1 = {
|
|
25347
|
+
orderable: boolean;
|
|
25348
|
+
price: number;
|
|
25349
|
+
productId: string;
|
|
25350
|
+
variationValues: {} & {
|
|
25351
|
+
[key: string]: any;
|
|
25352
|
+
};
|
|
25353
|
+
} & {
|
|
25354
|
+
[key: string]: any;
|
|
25355
|
+
};
|
|
25372
25356
|
type BrandSuggestions = {} & {
|
|
25373
25357
|
[key: string]: any;
|
|
25374
25358
|
};
|
|
@@ -25388,6 +25372,13 @@ type ProductSearchSortingOption = {
|
|
|
25388
25372
|
} & {
|
|
25389
25373
|
[key: string]: any;
|
|
25390
25374
|
};
|
|
25375
|
+
type ImageGroup$1 = {
|
|
25376
|
+
images: Array<Image$0>;
|
|
25377
|
+
variationAttributes?: Array<VariationAttribute$1>;
|
|
25378
|
+
viewType: string;
|
|
25379
|
+
} & {
|
|
25380
|
+
[key: string]: any;
|
|
25381
|
+
};
|
|
25391
25382
|
type SuggestedTerm = {
|
|
25392
25383
|
completed: boolean;
|
|
25393
25384
|
corrected: boolean;
|
|
@@ -25411,7 +25402,7 @@ type CustomSuggestions = {
|
|
|
25411
25402
|
[key: string]: any;
|
|
25412
25403
|
};
|
|
25413
25404
|
type ProductSearchHit = {
|
|
25414
|
-
currency?:
|
|
25405
|
+
currency?: any;
|
|
25415
25406
|
hitType?: string;
|
|
25416
25407
|
image?: Image$0;
|
|
25417
25408
|
orderable?: boolean;
|
|
@@ -25426,11 +25417,17 @@ type ProductSearchHit = {
|
|
|
25426
25417
|
representedProduct?: ProductRef;
|
|
25427
25418
|
representedProducts?: Array<ProductRef>;
|
|
25428
25419
|
variationAttributes?: Array<VariationAttribute$1>;
|
|
25420
|
+
imageGroups?: Array<ImageGroup$1>;
|
|
25421
|
+
priceRanges?: Array<PriceRange$0>;
|
|
25422
|
+
productPromotions?: Array<ProductPromotion$0>;
|
|
25423
|
+
tieredPrices?: Array<ProductPriceTable$0>;
|
|
25424
|
+
variants?: Array<Variant$1>;
|
|
25425
|
+
variationGroups?: Array<VariationGroup$1>;
|
|
25429
25426
|
} & {
|
|
25430
25427
|
[key: string]: any;
|
|
25431
25428
|
};
|
|
25432
25429
|
type ProductSearchResult = {
|
|
25433
|
-
limit:
|
|
25430
|
+
limit: any;
|
|
25434
25431
|
hits: Array<ProductSearchHit>;
|
|
25435
25432
|
query: string;
|
|
25436
25433
|
refinements: Array<ProductSearchRefinement>;
|
|
@@ -25463,6 +25460,13 @@ type VariationAttributeValue$1 = {
|
|
|
25463
25460
|
} & {
|
|
25464
25461
|
[key: string]: any;
|
|
25465
25462
|
};
|
|
25463
|
+
type ProductPromotion$1 = {
|
|
25464
|
+
calloutMsg: string;
|
|
25465
|
+
promotionId: string;
|
|
25466
|
+
promotionalPrice: number;
|
|
25467
|
+
} & {
|
|
25468
|
+
[key: string]: any;
|
|
25469
|
+
};
|
|
25466
25470
|
type Suggestion$0 = {
|
|
25467
25471
|
suggestedPhrases?: Array<SuggestedPhrase>;
|
|
25468
25472
|
suggestedTerms: Array<SuggestedTerms>;
|
|
@@ -25488,14 +25492,17 @@ type ShopperSearchPathParameters = {
|
|
|
25488
25492
|
* All query parameters that are used by at least one ShopperSearch method.
|
|
25489
25493
|
*/
|
|
25490
25494
|
type ShopperSearchQueryParameters = {
|
|
25491
|
-
|
|
25495
|
+
select?: any;
|
|
25496
|
+
siteId?: any;
|
|
25492
25497
|
q?: string;
|
|
25493
25498
|
refine?: Array<string>;
|
|
25494
25499
|
sort?: string;
|
|
25495
|
-
currency?:
|
|
25496
|
-
locale?:
|
|
25500
|
+
currency?: any;
|
|
25501
|
+
locale?: any;
|
|
25497
25502
|
expand?: Array<string>;
|
|
25498
|
-
|
|
25503
|
+
allImages?: boolean;
|
|
25504
|
+
perPricebook?: boolean;
|
|
25505
|
+
allVariationProperties?: boolean;
|
|
25499
25506
|
limit?: number;
|
|
25500
25507
|
};
|
|
25501
25508
|
/**
|
|
@@ -25525,7 +25532,7 @@ type ShopperSearchParameters = ShopperSearchPathParameters & BaseUriParameters &
|
|
|
25525
25532
|
* ```
|
|
25526
25533
|
*
|
|
25527
25534
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
25528
|
-
* API Version: 1.0.
|
|
25535
|
+
* API Version: 1.0.38<br />
|
|
25529
25536
|
* Last Updated: <br />
|
|
25530
25537
|
* </span>
|
|
25531
25538
|
|
|
@@ -25547,7 +25554,8 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25547
25554
|
*
|
|
25548
25555
|
* @param options - An object containing the options for this method.
|
|
25549
25556
|
* @param parameters - An object containing the parameters for this method.
|
|
25550
|
-
* @param organizationId -
|
|
25557
|
+
* @param organizationId -
|
|
25558
|
+
* @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.
|
|
25551
25559
|
* @param siteId -
|
|
25552
25560
|
* @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
|
|
25553
25561
|
* @param refine - Parameter that represents a refinement attribute or values pair. Refinement attribute ID and
|
|
@@ -25564,9 +25572,10 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25564
25572
|
* @param sort - The ID of the sorting option to sort the search hits.
|
|
25565
25573
|
* @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
|
|
25566
25574
|
* @param locale -
|
|
25567
|
-
* @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations).
|
|
25568
|
-
* @param
|
|
25569
|
-
* @param
|
|
25575
|
+
* @param expand - The expand parameter. A comma-separated list with the allowed values (availability, images, prices, represented_products, variations, promotions, custom_properties). The expand parameter `availability, images, prices, represented_products, variations` is used as the default value when no expand parameter is provided. The value `none` can be used to turn off all expand options. The expand values `promotions` and `custom_properties` are optional and are available from version 24.3 and 24.4, respectively.
|
|
25576
|
+
* @param allImages - When this flag is passed along with the expand parameter `images` in the request, a property named `imageGroups`, which contains an image model, is returned in the response. If the flag is set to `true`, the whole image model is returned. If it is set to `false`, the returned image model contains only matching images. If no flag is passed in the request, the response does not include the `imageGroups property`. This parameter is available from version 24.3.
|
|
25577
|
+
* @param perPricebook - When this flag is passed as `true` in the request, along with the expand parameter `prices`, then per PriceBook prices and tiered prices (if available) are returned. This parameter is available from version 24.3.
|
|
25578
|
+
* @param allVariationProperties - The flag that indicates which variation properties are to be included in the result. When the flag is passed as `true` along with the expand parameter `variations` in the request, all variation properties (`variationAttributes`, `variationGroups`, and `variants`) are returned. When it is passed as `false` along with the expand parameter `variations` in the request, only the default property (`variationAttributes`) is returned. This parameter is available from version 24.3.
|
|
25570
25579
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
25571
25580
|
* sent with this request.
|
|
25572
25581
|
*
|
|
@@ -25576,15 +25585,17 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25576
25585
|
productSearch(options?: RequireParametersUnlessAllAreOptional<{
|
|
25577
25586
|
parameters?: CompositeParameters<{
|
|
25578
25587
|
organizationId: string;
|
|
25579
|
-
|
|
25588
|
+
select?: any;
|
|
25589
|
+
siteId: any;
|
|
25580
25590
|
q?: string;
|
|
25581
25591
|
refine?: Array<string>;
|
|
25582
25592
|
sort?: string;
|
|
25583
|
-
currency?:
|
|
25584
|
-
locale?:
|
|
25593
|
+
currency?: any;
|
|
25594
|
+
locale?: any;
|
|
25585
25595
|
expand?: Array<string>;
|
|
25586
|
-
|
|
25587
|
-
|
|
25596
|
+
allImages?: boolean;
|
|
25597
|
+
perPricebook?: boolean;
|
|
25598
|
+
allVariationProperties?: boolean;
|
|
25588
25599
|
} & {
|
|
25589
25600
|
[key in `c_${string}`]: any;
|
|
25590
25601
|
}, ConfigParameters>;
|
|
@@ -25598,7 +25609,8 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25598
25609
|
*
|
|
25599
25610
|
* @param options - An object containing the options for this method.
|
|
25600
25611
|
* @param parameters - An object containing the parameters for this method.
|
|
25601
|
-
* @param organizationId -
|
|
25612
|
+
* @param organizationId -
|
|
25613
|
+
* @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.
|
|
25602
25614
|
* @param siteId -
|
|
25603
25615
|
* @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
|
|
25604
25616
|
* @param refine - Parameter that represents a refinement attribute or values pair. Refinement attribute ID and
|
|
@@ -25615,9 +25627,10 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25615
25627
|
* @param sort - The ID of the sorting option to sort the search hits.
|
|
25616
25628
|
* @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
|
|
25617
25629
|
* @param locale -
|
|
25618
|
-
* @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations).
|
|
25619
|
-
* @param
|
|
25620
|
-
* @param
|
|
25630
|
+
* @param expand - The expand parameter. A comma-separated list with the allowed values (availability, images, prices, represented_products, variations, promotions, custom_properties). The expand parameter `availability, images, prices, represented_products, variations` is used as the default value when no expand parameter is provided. The value `none` can be used to turn off all expand options. The expand values `promotions` and `custom_properties` are optional and are available from version 24.3 and 24.4, respectively.
|
|
25631
|
+
* @param allImages - When this flag is passed along with the expand parameter `images` in the request, a property named `imageGroups`, which contains an image model, is returned in the response. If the flag is set to `true`, the whole image model is returned. If it is set to `false`, the returned image model contains only matching images. If no flag is passed in the request, the response does not include the `imageGroups property`. This parameter is available from version 24.3.
|
|
25632
|
+
* @param perPricebook - When this flag is passed as `true` in the request, along with the expand parameter `prices`, then per PriceBook prices and tiered prices (if available) are returned. This parameter is available from version 24.3.
|
|
25633
|
+
* @param allVariationProperties - The flag that indicates which variation properties are to be included in the result. When the flag is passed as `true` along with the expand parameter `variations` in the request, all variation properties (`variationAttributes`, `variationGroups`, and `variants`) are returned. When it is passed as `false` along with the expand parameter `variations` in the request, only the default property (`variationAttributes`) is returned. This parameter is available from version 24.3.
|
|
25621
25634
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
25622
25635
|
* sent with this request.
|
|
25623
25636
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -25627,15 +25640,17 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25627
25640
|
productSearch<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
25628
25641
|
parameters?: CompositeParameters<{
|
|
25629
25642
|
organizationId: string;
|
|
25630
|
-
|
|
25643
|
+
select?: any;
|
|
25644
|
+
siteId: any;
|
|
25631
25645
|
q?: string;
|
|
25632
25646
|
refine?: Array<string>;
|
|
25633
25647
|
sort?: string;
|
|
25634
|
-
currency?:
|
|
25635
|
-
locale?:
|
|
25648
|
+
currency?: any;
|
|
25649
|
+
locale?: any;
|
|
25636
25650
|
expand?: Array<string>;
|
|
25637
|
-
|
|
25638
|
-
|
|
25651
|
+
allImages?: boolean;
|
|
25652
|
+
perPricebook?: boolean;
|
|
25653
|
+
allVariationProperties?: boolean;
|
|
25639
25654
|
} & {
|
|
25640
25655
|
[key in `c_${string}`]: any;
|
|
25641
25656
|
}, ConfigParameters>;
|
|
@@ -25650,7 +25665,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25650
25665
|
*
|
|
25651
25666
|
* @param options - An object containing the options for this method.
|
|
25652
25667
|
* @param parameters - An object containing the parameters for this method.
|
|
25653
|
-
* @param organizationId -
|
|
25668
|
+
* @param organizationId -
|
|
25654
25669
|
* @param siteId -
|
|
25655
25670
|
* @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.
|
|
25656
25671
|
* @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).
|
|
@@ -25665,11 +25680,11 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25665
25680
|
getSearchSuggestions(options?: RequireParametersUnlessAllAreOptional<{
|
|
25666
25681
|
parameters?: CompositeParameters<{
|
|
25667
25682
|
organizationId: string;
|
|
25668
|
-
siteId:
|
|
25683
|
+
siteId: any;
|
|
25669
25684
|
q: string;
|
|
25670
25685
|
limit?: number;
|
|
25671
|
-
currency?:
|
|
25672
|
-
locale?:
|
|
25686
|
+
currency?: any;
|
|
25687
|
+
locale?: any;
|
|
25673
25688
|
} & {
|
|
25674
25689
|
[key in `c_${string}`]: any;
|
|
25675
25690
|
}, ConfigParameters>;
|
|
@@ -25682,7 +25697,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25682
25697
|
*
|
|
25683
25698
|
* @param options - An object containing the options for this method.
|
|
25684
25699
|
* @param parameters - An object containing the parameters for this method.
|
|
25685
|
-
* @param organizationId -
|
|
25700
|
+
* @param organizationId -
|
|
25686
25701
|
* @param siteId -
|
|
25687
25702
|
* @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.
|
|
25688
25703
|
* @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).
|
|
@@ -25697,11 +25712,11 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
|
|
|
25697
25712
|
getSearchSuggestions<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
25698
25713
|
parameters?: CompositeParameters<{
|
|
25699
25714
|
organizationId: string;
|
|
25700
|
-
siteId:
|
|
25715
|
+
siteId: any;
|
|
25701
25716
|
q: string;
|
|
25702
25717
|
limit?: number;
|
|
25703
|
-
currency?:
|
|
25704
|
-
locale?:
|
|
25718
|
+
currency?: any;
|
|
25719
|
+
locale?: any;
|
|
25705
25720
|
} & {
|
|
25706
25721
|
[key in `c_${string}`]: any;
|
|
25707
25722
|
}, ConfigParameters>;
|
|
@@ -25801,278 +25816,28 @@ declare namespace ShopperSearchTypes {
|
|
|
25801
25816
|
constructor(config: ClientConfigInit<Params>);
|
|
25802
25817
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
25803
25818
|
}
|
|
25804
|
-
type
|
|
25805
|
-
|
|
25806
|
-
|
|
25819
|
+
type ProductPriceTable = {
|
|
25820
|
+
price?: number;
|
|
25821
|
+
pricebook?: string;
|
|
25822
|
+
quantity?: number;
|
|
25807
25823
|
} & {
|
|
25808
25824
|
[key: string]: any;
|
|
25809
25825
|
};
|
|
25810
|
-
type
|
|
25811
|
-
|
|
25812
|
-
hits?: Array<object>;
|
|
25813
|
-
offset: any;
|
|
25814
|
-
total: any;
|
|
25826
|
+
type ProductRef = {
|
|
25827
|
+
id: string;
|
|
25815
25828
|
} & {
|
|
25816
25829
|
[key: string]: any;
|
|
25817
25830
|
};
|
|
25818
|
-
type
|
|
25819
|
-
|
|
25820
|
-
|
|
25821
|
-
sorts?: Array<Sort$9>;
|
|
25822
|
-
offset?: any;
|
|
25831
|
+
type SuggestedTerms = {
|
|
25832
|
+
originalTerm: string;
|
|
25833
|
+
terms?: Array<SuggestedTerm>;
|
|
25823
25834
|
} & {
|
|
25824
25835
|
[key: string]: any;
|
|
25825
25836
|
};
|
|
25826
|
-
type
|
|
25827
|
-
|
|
25828
|
-
|
|
25829
|
-
|
|
25830
|
-
description: L10nString$8;
|
|
25831
|
-
key?: boolean;
|
|
25832
|
-
localizable?: boolean;
|
|
25833
|
-
mandatory?: boolean;
|
|
25834
|
-
max?: number;
|
|
25835
|
-
minLength?: number;
|
|
25836
|
-
min?: number;
|
|
25837
|
-
multiValueType?: boolean;
|
|
25838
|
-
regularExpression?: string;
|
|
25839
|
-
scale?: number;
|
|
25840
|
-
searchable?: boolean;
|
|
25841
|
-
siteSpecific?: boolean;
|
|
25842
|
-
system?: boolean;
|
|
25843
|
-
unit?: L10nString$8;
|
|
25844
|
-
possibleValues?: Array<PropertyValueDefinition$8>;
|
|
25845
|
-
type: string;
|
|
25846
|
-
visible?: boolean;
|
|
25847
|
-
} & {
|
|
25848
|
-
[key: string]: any;
|
|
25849
|
-
};
|
|
25850
|
-
type LocalizedString = {} & {
|
|
25851
|
-
[key: string]: any;
|
|
25852
|
-
};
|
|
25853
|
-
type PaginatedSearchResult = {
|
|
25854
|
-
query: any;
|
|
25855
|
-
sorts?: Array<Sort$9>;
|
|
25856
|
-
limit: number;
|
|
25857
|
-
hits?: Array<object>;
|
|
25858
|
-
offset: any;
|
|
25859
|
-
total: any;
|
|
25860
|
-
} & {
|
|
25861
|
-
[key: string]: any;
|
|
25862
|
-
};
|
|
25863
|
-
type ClosedObject = {} & {
|
|
25864
|
-
[key: string]: any;
|
|
25865
|
-
};
|
|
25866
|
-
type OpenObject = {} & {
|
|
25867
|
-
[key: string]: any;
|
|
25868
|
-
};
|
|
25869
|
-
type NoPropertiesAllowed = {};
|
|
25870
|
-
type SpecifiedPropertiesAllowed = {} & {
|
|
25871
|
-
[key: string]: any;
|
|
25872
|
-
};
|
|
25873
|
-
type BoolFilter = {
|
|
25874
|
-
filters?: Array<any>;
|
|
25875
|
-
operator: string;
|
|
25876
|
-
} & {
|
|
25877
|
-
[key: string]: any;
|
|
25878
|
-
};
|
|
25879
|
-
type PaginatedSearchResultBase = {
|
|
25880
|
-
query: any;
|
|
25881
|
-
sorts?: Array<Sort$9>;
|
|
25882
|
-
limit: number;
|
|
25883
|
-
hits?: Array<object>;
|
|
25884
|
-
offset: any;
|
|
25885
|
-
total: any;
|
|
25886
|
-
} & {
|
|
25887
|
-
[key: string]: any;
|
|
25888
|
-
};
|
|
25889
|
-
type MatchAllQuery = {} & {
|
|
25890
|
-
[key: string]: any;
|
|
25891
|
-
};
|
|
25892
|
-
type FilteredQuery = {
|
|
25893
|
-
filter: any;
|
|
25894
|
-
query: any;
|
|
25895
|
-
} & {
|
|
25896
|
-
[key: string]: any;
|
|
25897
|
-
};
|
|
25898
|
-
type QueryFilter = {
|
|
25899
|
-
query: any;
|
|
25900
|
-
} & {
|
|
25901
|
-
[key: string]: any;
|
|
25902
|
-
};
|
|
25903
|
-
type Query = {
|
|
25904
|
-
boolQuery?: BoolQuery$9;
|
|
25905
|
-
filteredQuery?: FilteredQuery;
|
|
25906
|
-
matchAllQuery?: MatchAllQuery;
|
|
25907
|
-
nestedQuery?: NestedQuery$9;
|
|
25908
|
-
termQuery?: TermQuery$9;
|
|
25909
|
-
textQuery?: TextQuery$9;
|
|
25910
|
-
} & {
|
|
25911
|
-
[key: string]: any;
|
|
25912
|
-
};
|
|
25913
|
-
type TermQuery = {
|
|
25914
|
-
fields: Array<string>;
|
|
25915
|
-
operator: string;
|
|
25916
|
-
values?: Array<any>;
|
|
25917
|
-
} & {
|
|
25918
|
-
[key: string]: any;
|
|
25919
|
-
};
|
|
25920
|
-
type TermFilter = {
|
|
25921
|
-
field: string;
|
|
25922
|
-
operator: string;
|
|
25923
|
-
values?: Array<any>;
|
|
25924
|
-
} & {
|
|
25925
|
-
[key: string]: any;
|
|
25926
|
-
};
|
|
25927
|
-
type TextQuery = {
|
|
25928
|
-
fields: Array<string>;
|
|
25929
|
-
searchPhrase: string;
|
|
25930
|
-
} & {
|
|
25931
|
-
[key: string]: any;
|
|
25932
|
-
};
|
|
25933
|
-
type Range2Filter = {
|
|
25934
|
-
filterMode?: string;
|
|
25935
|
-
fromField: string;
|
|
25936
|
-
fromInclusive?: boolean;
|
|
25937
|
-
fromValue?: any;
|
|
25938
|
-
toField: string;
|
|
25939
|
-
toInclusive?: boolean;
|
|
25940
|
-
toValue?: any;
|
|
25941
|
-
} & {
|
|
25942
|
-
[key: string]: any;
|
|
25943
|
-
};
|
|
25944
|
-
type BoolQuery = {
|
|
25945
|
-
must?: Array<any>;
|
|
25946
|
-
mustNot?: Array<any>;
|
|
25947
|
-
should?: Array<any>;
|
|
25948
|
-
} & {
|
|
25949
|
-
[key: string]: any;
|
|
25950
|
-
};
|
|
25951
|
-
type SimpleSearchResultBase = {
|
|
25952
|
-
limit: number;
|
|
25953
|
-
hits?: Array<object>;
|
|
25954
|
-
offset: any;
|
|
25955
|
-
total: any;
|
|
25956
|
-
} & {
|
|
25957
|
-
[key: string]: any;
|
|
25958
|
-
};
|
|
25959
|
-
type NestedQuery = {
|
|
25960
|
-
path: string;
|
|
25961
|
-
query: any;
|
|
25962
|
-
scoreMode?: string;
|
|
25963
|
-
} & {
|
|
25964
|
-
[key: string]: any;
|
|
25965
|
-
};
|
|
25966
|
-
type Filter = {
|
|
25967
|
-
boolFilter?: BoolFilter;
|
|
25968
|
-
queryFilter?: QueryFilter;
|
|
25969
|
-
range2Filter?: Range2Filter;
|
|
25970
|
-
rangeFilter?: RangeFilter$9;
|
|
25971
|
-
termFilter?: TermFilter;
|
|
25972
|
-
} & {
|
|
25973
|
-
[key: string]: any;
|
|
25974
|
-
};
|
|
25975
|
-
type Sort = {
|
|
25976
|
-
field: string;
|
|
25977
|
-
sortOrder?: string;
|
|
25978
|
-
} & {
|
|
25979
|
-
[key: string]: any;
|
|
25980
|
-
};
|
|
25981
|
-
type RangeFilter = {
|
|
25982
|
-
field: string;
|
|
25983
|
-
from?: any;
|
|
25984
|
-
fromInclusive?: boolean;
|
|
25985
|
-
to?: any;
|
|
25986
|
-
toInclusive?: boolean;
|
|
25987
|
-
} & {
|
|
25988
|
-
[key: string]: any;
|
|
25989
|
-
};
|
|
25990
|
-
type SearchRequestBase = {
|
|
25991
|
-
limit?: number;
|
|
25992
|
-
query: any;
|
|
25993
|
-
sorts?: Array<Sort>;
|
|
25994
|
-
offset?: any;
|
|
25995
|
-
} & {
|
|
25996
|
-
[key: string]: any;
|
|
25997
|
-
};
|
|
25998
|
-
type MoneyMnemonic = {
|
|
25999
|
-
currencyMnemonic?: string;
|
|
26000
|
-
value?: number;
|
|
26001
|
-
} & {
|
|
26002
|
-
[key: string]: any;
|
|
26003
|
-
};
|
|
26004
|
-
type L10nString = {} & {
|
|
26005
|
-
[key: string]: any;
|
|
26006
|
-
};
|
|
26007
|
-
type AttributeDefinition = {
|
|
26008
|
-
defaultValue?: PropertyValueDefinition$8;
|
|
26009
|
-
id?: string;
|
|
26010
|
-
name: L10nString;
|
|
26011
|
-
description: L10nString;
|
|
26012
|
-
key?: boolean;
|
|
26013
|
-
localizable?: boolean;
|
|
26014
|
-
mandatory?: boolean;
|
|
26015
|
-
max?: number;
|
|
26016
|
-
minLength?: number;
|
|
26017
|
-
min?: number;
|
|
26018
|
-
multiValueType?: boolean;
|
|
26019
|
-
regularExpression?: string;
|
|
26020
|
-
scale?: number;
|
|
26021
|
-
searchable?: boolean;
|
|
26022
|
-
siteSpecific?: boolean;
|
|
26023
|
-
system?: boolean;
|
|
26024
|
-
unit?: L10nString;
|
|
26025
|
-
possibleValues?: Array<PropertyValueDefinition$8>;
|
|
26026
|
-
type: string;
|
|
26027
|
-
visible?: boolean;
|
|
26028
|
-
};
|
|
26029
|
-
type PropertyValueDefinition = {
|
|
26030
|
-
description: L10nString;
|
|
26031
|
-
displayValue: L10nString;
|
|
26032
|
-
id: string;
|
|
26033
|
-
position?: number;
|
|
26034
|
-
value: string;
|
|
26035
|
-
};
|
|
26036
|
-
type ErrorResponse = {
|
|
26037
|
-
type: string;
|
|
26038
|
-
title?: string;
|
|
26039
|
-
detail?: string;
|
|
26040
|
-
instance?: string;
|
|
26041
|
-
} & {
|
|
26042
|
-
[key: string]: any;
|
|
26043
|
-
};
|
|
26044
|
-
type ChangeControlled = {
|
|
26045
|
-
creationDate?: any;
|
|
26046
|
-
modificationDate?: any;
|
|
26047
|
-
createdBy?: string;
|
|
26048
|
-
lastModifiedBy?: string;
|
|
26049
|
-
} & {
|
|
26050
|
-
[key: string]: any;
|
|
26051
|
-
};
|
|
26052
|
-
type ChangeControlledDataType = {
|
|
26053
|
-
creationDate?: any;
|
|
26054
|
-
modificationDate?: any;
|
|
26055
|
-
createdBy?: string;
|
|
26056
|
-
lastModifiedBy?: string;
|
|
26057
|
-
} & {
|
|
26058
|
-
[key: string]: any;
|
|
26059
|
-
};
|
|
26060
|
-
type Error = {
|
|
26061
|
-
type: string;
|
|
26062
|
-
title?: string;
|
|
26063
|
-
detail?: string;
|
|
26064
|
-
instance?: string;
|
|
26065
|
-
} & {
|
|
26066
|
-
[key: string]: any;
|
|
26067
|
-
};
|
|
26068
|
-
type ProductRef = {
|
|
26069
|
-
id: string;
|
|
26070
|
-
} & {
|
|
26071
|
-
[key: string]: any;
|
|
26072
|
-
};
|
|
26073
|
-
type SuggestedTerms = {
|
|
26074
|
-
originalTerm: string;
|
|
26075
|
-
terms?: Array<SuggestedTerm>;
|
|
25837
|
+
type PriceRange = {
|
|
25838
|
+
maxPrice?: number;
|
|
25839
|
+
minPrice?: number;
|
|
25840
|
+
pricebook?: string;
|
|
26076
25841
|
} & {
|
|
26077
25842
|
[key: string]: any;
|
|
26078
25843
|
};
|
|
@@ -26084,7 +25849,7 @@ declare namespace ShopperSearchTypes {
|
|
|
26084
25849
|
[key: string]: any;
|
|
26085
25850
|
};
|
|
26086
25851
|
type SuggestedProduct = {
|
|
26087
|
-
currency:
|
|
25852
|
+
currency: any;
|
|
26088
25853
|
price: number;
|
|
26089
25854
|
productId: string;
|
|
26090
25855
|
productName: string;
|
|
@@ -26129,6 +25894,28 @@ declare namespace ShopperSearchTypes {
|
|
|
26129
25894
|
} & {
|
|
26130
25895
|
[key: string]: any;
|
|
26131
25896
|
};
|
|
25897
|
+
type Variant = {
|
|
25898
|
+
orderable?: boolean;
|
|
25899
|
+
price?: number;
|
|
25900
|
+
productId: string;
|
|
25901
|
+
tieredPrices?: Array<ProductPriceTable>;
|
|
25902
|
+
variationValues?: {} & {
|
|
25903
|
+
[key: string]: any;
|
|
25904
|
+
};
|
|
25905
|
+
productPromotions?: Array<ProductPromotion$1>;
|
|
25906
|
+
} & {
|
|
25907
|
+
[key: string]: any;
|
|
25908
|
+
};
|
|
25909
|
+
type VariationGroup = {
|
|
25910
|
+
orderable: boolean;
|
|
25911
|
+
price: number;
|
|
25912
|
+
productId: string;
|
|
25913
|
+
variationValues: {} & {
|
|
25914
|
+
[key: string]: any;
|
|
25915
|
+
};
|
|
25916
|
+
} & {
|
|
25917
|
+
[key: string]: any;
|
|
25918
|
+
};
|
|
26132
25919
|
type BrandSuggestions = {} & {
|
|
26133
25920
|
[key: string]: any;
|
|
26134
25921
|
};
|
|
@@ -26148,6 +25935,13 @@ declare namespace ShopperSearchTypes {
|
|
|
26148
25935
|
} & {
|
|
26149
25936
|
[key: string]: any;
|
|
26150
25937
|
};
|
|
25938
|
+
type ImageGroup = {
|
|
25939
|
+
images: Array<Image$1>;
|
|
25940
|
+
variationAttributes?: Array<VariationAttribute>;
|
|
25941
|
+
viewType: string;
|
|
25942
|
+
} & {
|
|
25943
|
+
[key: string]: any;
|
|
25944
|
+
};
|
|
26151
25945
|
type SuggestedTerm = {
|
|
26152
25946
|
completed: boolean;
|
|
26153
25947
|
corrected: boolean;
|
|
@@ -26171,7 +25965,7 @@ declare namespace ShopperSearchTypes {
|
|
|
26171
25965
|
[key: string]: any;
|
|
26172
25966
|
};
|
|
26173
25967
|
type ProductSearchHit = {
|
|
26174
|
-
currency?:
|
|
25968
|
+
currency?: any;
|
|
26175
25969
|
hitType?: string;
|
|
26176
25970
|
image?: Image$1;
|
|
26177
25971
|
orderable?: boolean;
|
|
@@ -26186,11 +25980,17 @@ declare namespace ShopperSearchTypes {
|
|
|
26186
25980
|
representedProduct?: ProductRef;
|
|
26187
25981
|
representedProducts?: Array<ProductRef>;
|
|
26188
25982
|
variationAttributes?: Array<VariationAttribute>;
|
|
25983
|
+
imageGroups?: Array<ImageGroup>;
|
|
25984
|
+
priceRanges?: Array<PriceRange>;
|
|
25985
|
+
productPromotions?: Array<ProductPromotion$1>;
|
|
25986
|
+
tieredPrices?: Array<ProductPriceTable>;
|
|
25987
|
+
variants?: Array<Variant>;
|
|
25988
|
+
variationGroups?: Array<VariationGroup>;
|
|
26189
25989
|
} & {
|
|
26190
25990
|
[key: string]: any;
|
|
26191
25991
|
};
|
|
26192
25992
|
type ProductSearchResult = {
|
|
26193
|
-
limit:
|
|
25993
|
+
limit: any;
|
|
26194
25994
|
hits: Array<ProductSearchHit>;
|
|
26195
25995
|
query: string;
|
|
26196
25996
|
refinements: Array<ProductSearchRefinement>;
|
|
@@ -26223,6 +26023,13 @@ declare namespace ShopperSearchTypes {
|
|
|
26223
26023
|
} & {
|
|
26224
26024
|
[key: string]: any;
|
|
26225
26025
|
};
|
|
26026
|
+
type ProductPromotion = {
|
|
26027
|
+
calloutMsg: string;
|
|
26028
|
+
promotionId: string;
|
|
26029
|
+
promotionalPrice: number;
|
|
26030
|
+
} & {
|
|
26031
|
+
[key: string]: any;
|
|
26032
|
+
};
|
|
26226
26033
|
type Suggestion = {
|
|
26227
26034
|
suggestedPhrases?: Array<SuggestedPhrase>;
|
|
26228
26035
|
suggestedTerms: Array<SuggestedTerms>;
|
|
@@ -26248,14 +26055,17 @@ declare namespace ShopperSearchTypes {
|
|
|
26248
26055
|
* All query parameters that are used by at least one ShopperSearch method.
|
|
26249
26056
|
*/
|
|
26250
26057
|
type ShopperSearchQueryParameters = {
|
|
26251
|
-
|
|
26058
|
+
select?: any;
|
|
26059
|
+
siteId?: any;
|
|
26252
26060
|
q?: string;
|
|
26253
26061
|
refine?: Array<string>;
|
|
26254
26062
|
sort?: string;
|
|
26255
|
-
currency?:
|
|
26256
|
-
locale?:
|
|
26063
|
+
currency?: any;
|
|
26064
|
+
locale?: any;
|
|
26257
26065
|
expand?: Array<string>;
|
|
26258
|
-
|
|
26066
|
+
allImages?: boolean;
|
|
26067
|
+
perPricebook?: boolean;
|
|
26068
|
+
allVariationProperties?: boolean;
|
|
26259
26069
|
limit?: number;
|
|
26260
26070
|
};
|
|
26261
26071
|
/**
|
|
@@ -26285,7 +26095,7 @@ declare namespace ShopperSearchTypes {
|
|
|
26285
26095
|
* ```
|
|
26286
26096
|
*
|
|
26287
26097
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
26288
|
-
* API Version: 1.0.
|
|
26098
|
+
* API Version: 1.0.38<br />
|
|
26289
26099
|
* Last Updated: <br />
|
|
26290
26100
|
* </span>
|
|
26291
26101
|
|
|
@@ -26307,7 +26117,8 @@ declare namespace ShopperSearchTypes {
|
|
|
26307
26117
|
*
|
|
26308
26118
|
* @param options - An object containing the options for this method.
|
|
26309
26119
|
* @param parameters - An object containing the parameters for this method.
|
|
26310
|
-
* @param organizationId -
|
|
26120
|
+
* @param organizationId -
|
|
26121
|
+
* @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.
|
|
26311
26122
|
* @param siteId -
|
|
26312
26123
|
* @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
|
|
26313
26124
|
* @param refine - Parameter that represents a refinement attribute or values pair. Refinement attribute ID and
|
|
@@ -26324,9 +26135,10 @@ declare namespace ShopperSearchTypes {
|
|
|
26324
26135
|
* @param sort - The ID of the sorting option to sort the search hits.
|
|
26325
26136
|
* @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
|
|
26326
26137
|
* @param locale -
|
|
26327
|
-
* @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations).
|
|
26328
|
-
* @param
|
|
26329
|
-
* @param
|
|
26138
|
+
* @param expand - The expand parameter. A comma-separated list with the allowed values (availability, images, prices, represented_products, variations, promotions, custom_properties). The expand parameter `availability, images, prices, represented_products, variations` is used as the default value when no expand parameter is provided. The value `none` can be used to turn off all expand options. The expand values `promotions` and `custom_properties` are optional and are available from version 24.3 and 24.4, respectively.
|
|
26139
|
+
* @param allImages - When this flag is passed along with the expand parameter `images` in the request, a property named `imageGroups`, which contains an image model, is returned in the response. If the flag is set to `true`, the whole image model is returned. If it is set to `false`, the returned image model contains only matching images. If no flag is passed in the request, the response does not include the `imageGroups property`. This parameter is available from version 24.3.
|
|
26140
|
+
* @param perPricebook - When this flag is passed as `true` in the request, along with the expand parameter `prices`, then per PriceBook prices and tiered prices (if available) are returned. This parameter is available from version 24.3.
|
|
26141
|
+
* @param allVariationProperties - The flag that indicates which variation properties are to be included in the result. When the flag is passed as `true` along with the expand parameter `variations` in the request, all variation properties (`variationAttributes`, `variationGroups`, and `variants`) are returned. When it is passed as `false` along with the expand parameter `variations` in the request, only the default property (`variationAttributes`) is returned. This parameter is available from version 24.3.
|
|
26330
26142
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
26331
26143
|
* sent with this request.
|
|
26332
26144
|
*
|
|
@@ -26336,15 +26148,17 @@ declare namespace ShopperSearchTypes {
|
|
|
26336
26148
|
productSearch(options?: RequireParametersUnlessAllAreOptional<{
|
|
26337
26149
|
parameters?: CompositeParameters<{
|
|
26338
26150
|
organizationId: string;
|
|
26339
|
-
|
|
26151
|
+
select?: any;
|
|
26152
|
+
siteId: any;
|
|
26340
26153
|
q?: string;
|
|
26341
26154
|
refine?: Array<string>;
|
|
26342
26155
|
sort?: string;
|
|
26343
|
-
currency?:
|
|
26344
|
-
locale?:
|
|
26156
|
+
currency?: any;
|
|
26157
|
+
locale?: any;
|
|
26345
26158
|
expand?: Array<string>;
|
|
26346
|
-
|
|
26347
|
-
|
|
26159
|
+
allImages?: boolean;
|
|
26160
|
+
perPricebook?: boolean;
|
|
26161
|
+
allVariationProperties?: boolean;
|
|
26348
26162
|
} & {
|
|
26349
26163
|
[key in `c_${string}`]: any;
|
|
26350
26164
|
}, ConfigParameters>;
|
|
@@ -26358,7 +26172,8 @@ declare namespace ShopperSearchTypes {
|
|
|
26358
26172
|
*
|
|
26359
26173
|
* @param options - An object containing the options for this method.
|
|
26360
26174
|
* @param parameters - An object containing the parameters for this method.
|
|
26361
|
-
* @param organizationId -
|
|
26175
|
+
* @param organizationId -
|
|
26176
|
+
* @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.
|
|
26362
26177
|
* @param siteId -
|
|
26363
26178
|
* @param q - The query phrase to search for. For example to search for a product "shirt", type q=shirt.
|
|
26364
26179
|
* @param refine - Parameter that represents a refinement attribute or values pair. Refinement attribute ID and
|
|
@@ -26375,9 +26190,10 @@ declare namespace ShopperSearchTypes {
|
|
|
26375
26190
|
* @param sort - The ID of the sorting option to sort the search hits.
|
|
26376
26191
|
* @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
|
|
26377
26192
|
* @param locale -
|
|
26378
|
-
* @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations).
|
|
26379
|
-
* @param
|
|
26380
|
-
* @param
|
|
26193
|
+
* @param expand - The expand parameter. A comma-separated list with the allowed values (availability, images, prices, represented_products, variations, promotions, custom_properties). The expand parameter `availability, images, prices, represented_products, variations` is used as the default value when no expand parameter is provided. The value `none` can be used to turn off all expand options. The expand values `promotions` and `custom_properties` are optional and are available from version 24.3 and 24.4, respectively.
|
|
26194
|
+
* @param allImages - When this flag is passed along with the expand parameter `images` in the request, a property named `imageGroups`, which contains an image model, is returned in the response. If the flag is set to `true`, the whole image model is returned. If it is set to `false`, the returned image model contains only matching images. If no flag is passed in the request, the response does not include the `imageGroups property`. This parameter is available from version 24.3.
|
|
26195
|
+
* @param perPricebook - When this flag is passed as `true` in the request, along with the expand parameter `prices`, then per PriceBook prices and tiered prices (if available) are returned. This parameter is available from version 24.3.
|
|
26196
|
+
* @param allVariationProperties - The flag that indicates which variation properties are to be included in the result. When the flag is passed as `true` along with the expand parameter `variations` in the request, all variation properties (`variationAttributes`, `variationGroups`, and `variants`) are returned. When it is passed as `false` along with the expand parameter `variations` in the request, only the default property (`variationAttributes`) is returned. This parameter is available from version 24.3.
|
|
26381
26197
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
26382
26198
|
* sent with this request.
|
|
26383
26199
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
@@ -26387,15 +26203,17 @@ declare namespace ShopperSearchTypes {
|
|
|
26387
26203
|
productSearch<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
26388
26204
|
parameters?: CompositeParameters<{
|
|
26389
26205
|
organizationId: string;
|
|
26390
|
-
|
|
26206
|
+
select?: any;
|
|
26207
|
+
siteId: any;
|
|
26391
26208
|
q?: string;
|
|
26392
26209
|
refine?: Array<string>;
|
|
26393
26210
|
sort?: string;
|
|
26394
|
-
currency?:
|
|
26395
|
-
locale?:
|
|
26211
|
+
currency?: any;
|
|
26212
|
+
locale?: any;
|
|
26396
26213
|
expand?: Array<string>;
|
|
26397
|
-
|
|
26398
|
-
|
|
26214
|
+
allImages?: boolean;
|
|
26215
|
+
perPricebook?: boolean;
|
|
26216
|
+
allVariationProperties?: boolean;
|
|
26399
26217
|
} & {
|
|
26400
26218
|
[key in `c_${string}`]: any;
|
|
26401
26219
|
}, ConfigParameters>;
|
|
@@ -26410,7 +26228,7 @@ declare namespace ShopperSearchTypes {
|
|
|
26410
26228
|
*
|
|
26411
26229
|
* @param options - An object containing the options for this method.
|
|
26412
26230
|
* @param parameters - An object containing the parameters for this method.
|
|
26413
|
-
* @param organizationId -
|
|
26231
|
+
* @param organizationId -
|
|
26414
26232
|
* @param siteId -
|
|
26415
26233
|
* @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.
|
|
26416
26234
|
* @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).
|
|
@@ -26425,11 +26243,11 @@ declare namespace ShopperSearchTypes {
|
|
|
26425
26243
|
getSearchSuggestions(options?: RequireParametersUnlessAllAreOptional<{
|
|
26426
26244
|
parameters?: CompositeParameters<{
|
|
26427
26245
|
organizationId: string;
|
|
26428
|
-
siteId:
|
|
26246
|
+
siteId: any;
|
|
26429
26247
|
q: string;
|
|
26430
26248
|
limit?: number;
|
|
26431
|
-
currency?:
|
|
26432
|
-
locale?:
|
|
26249
|
+
currency?: any;
|
|
26250
|
+
locale?: any;
|
|
26433
26251
|
} & {
|
|
26434
26252
|
[key in `c_${string}`]: any;
|
|
26435
26253
|
}, ConfigParameters>;
|
|
@@ -26442,7 +26260,7 @@ declare namespace ShopperSearchTypes {
|
|
|
26442
26260
|
*
|
|
26443
26261
|
* @param options - An object containing the options for this method.
|
|
26444
26262
|
* @param parameters - An object containing the parameters for this method.
|
|
26445
|
-
* @param organizationId -
|
|
26263
|
+
* @param organizationId -
|
|
26446
26264
|
* @param siteId -
|
|
26447
26265
|
* @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.
|
|
26448
26266
|
* @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).
|
|
@@ -26457,11 +26275,11 @@ declare namespace ShopperSearchTypes {
|
|
|
26457
26275
|
getSearchSuggestions<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
26458
26276
|
parameters?: CompositeParameters<{
|
|
26459
26277
|
organizationId: string;
|
|
26460
|
-
siteId:
|
|
26278
|
+
siteId: any;
|
|
26461
26279
|
q: string;
|
|
26462
26280
|
limit?: number;
|
|
26463
|
-
currency?:
|
|
26464
|
-
locale?:
|
|
26281
|
+
currency?: any;
|
|
26282
|
+
locale?: any;
|
|
26465
26283
|
} & {
|
|
26466
26284
|
[key in `c_${string}`]: any;
|
|
26467
26285
|
}, ConfigParameters>;
|
|
@@ -26471,57 +26289,57 @@ declare namespace ShopperSearchTypes {
|
|
|
26471
26289
|
}>, rawResponse?: T): Promise<T extends true ? Response : SuggestionResult>;
|
|
26472
26290
|
}
|
|
26473
26291
|
}
|
|
26474
|
-
type BoolFilter$
|
|
26475
|
-
filters?: Array<Filter$
|
|
26292
|
+
type BoolFilter$9 = {
|
|
26293
|
+
filters?: Array<Filter$8>;
|
|
26476
26294
|
operator: string;
|
|
26477
26295
|
} & {
|
|
26478
26296
|
[key: string]: any;
|
|
26479
26297
|
};
|
|
26480
|
-
type MatchAllQuery$
|
|
26298
|
+
type MatchAllQuery$9 = {} & {
|
|
26481
26299
|
[key: string]: any;
|
|
26482
26300
|
};
|
|
26483
|
-
type FilteredQuery$
|
|
26484
|
-
filter: Filter$
|
|
26485
|
-
query: Query$
|
|
26301
|
+
type FilteredQuery$9 = {
|
|
26302
|
+
filter: Filter$8;
|
|
26303
|
+
query: Query$8;
|
|
26486
26304
|
} & {
|
|
26487
26305
|
[key: string]: any;
|
|
26488
26306
|
};
|
|
26489
|
-
type QueryFilter$
|
|
26490
|
-
query: Query$
|
|
26307
|
+
type QueryFilter$9 = {
|
|
26308
|
+
query: Query$8;
|
|
26491
26309
|
} & {
|
|
26492
26310
|
[key: string]: any;
|
|
26493
26311
|
};
|
|
26494
|
-
type Query$
|
|
26495
|
-
boolQuery?: BoolQuery$
|
|
26496
|
-
filteredQuery?: FilteredQuery$
|
|
26497
|
-
matchAllQuery?: MatchAllQuery$
|
|
26498
|
-
nestedQuery?: NestedQuery$
|
|
26499
|
-
termQuery?: TermQuery$
|
|
26500
|
-
textQuery?: TextQuery$
|
|
26312
|
+
type Query$9 = {
|
|
26313
|
+
boolQuery?: BoolQuery$8;
|
|
26314
|
+
filteredQuery?: FilteredQuery$9;
|
|
26315
|
+
matchAllQuery?: MatchAllQuery$9;
|
|
26316
|
+
nestedQuery?: NestedQuery$8;
|
|
26317
|
+
termQuery?: TermQuery$8;
|
|
26318
|
+
textQuery?: TextQuery$8;
|
|
26501
26319
|
} & {
|
|
26502
26320
|
[key: string]: any;
|
|
26503
26321
|
};
|
|
26504
|
-
type TermQuery$
|
|
26322
|
+
type TermQuery$9 = {
|
|
26505
26323
|
fields: Array<string>;
|
|
26506
26324
|
operator: string;
|
|
26507
26325
|
values?: Array<any>;
|
|
26508
26326
|
} & {
|
|
26509
26327
|
[key: string]: any;
|
|
26510
26328
|
};
|
|
26511
|
-
type TermFilter$
|
|
26329
|
+
type TermFilter$9 = {
|
|
26512
26330
|
field: string;
|
|
26513
26331
|
operator: string;
|
|
26514
26332
|
values?: Array<any>;
|
|
26515
26333
|
} & {
|
|
26516
26334
|
[key: string]: any;
|
|
26517
26335
|
};
|
|
26518
|
-
type TextQuery$
|
|
26336
|
+
type TextQuery$9 = {
|
|
26519
26337
|
fields: Array<string>;
|
|
26520
26338
|
searchPhrase: string;
|
|
26521
26339
|
} & {
|
|
26522
26340
|
[key: string]: any;
|
|
26523
26341
|
};
|
|
26524
|
-
type Range2Filter$
|
|
26342
|
+
type Range2Filter$9 = {
|
|
26525
26343
|
filterMode?: string;
|
|
26526
26344
|
fromField: string;
|
|
26527
26345
|
fromInclusive?: boolean;
|
|
@@ -26532,36 +26350,36 @@ type Range2Filter$10 = {
|
|
|
26532
26350
|
} & {
|
|
26533
26351
|
[key: string]: any;
|
|
26534
26352
|
};
|
|
26535
|
-
type BoolQuery$
|
|
26536
|
-
must?: Array<Query$
|
|
26537
|
-
mustNot?: Array<Query$
|
|
26538
|
-
should?: Array<Query$
|
|
26353
|
+
type BoolQuery$9 = {
|
|
26354
|
+
must?: Array<Query$9>;
|
|
26355
|
+
mustNot?: Array<Query$9>;
|
|
26356
|
+
should?: Array<Query$9>;
|
|
26539
26357
|
} & {
|
|
26540
26358
|
[key: string]: any;
|
|
26541
26359
|
};
|
|
26542
|
-
type NestedQuery$
|
|
26360
|
+
type NestedQuery$9 = {
|
|
26543
26361
|
path: string;
|
|
26544
|
-
query: Query$
|
|
26362
|
+
query: Query$9;
|
|
26545
26363
|
scoreMode?: string;
|
|
26546
26364
|
} & {
|
|
26547
26365
|
[key: string]: any;
|
|
26548
26366
|
};
|
|
26549
|
-
type Filter$
|
|
26550
|
-
boolFilter?: BoolFilter$
|
|
26551
|
-
queryFilter?: QueryFilter$
|
|
26552
|
-
range2Filter?: Range2Filter$
|
|
26553
|
-
rangeFilter?: RangeFilter$
|
|
26554
|
-
termFilter?: TermFilter$
|
|
26367
|
+
type Filter$9 = {
|
|
26368
|
+
boolFilter?: BoolFilter$9;
|
|
26369
|
+
queryFilter?: QueryFilter$9;
|
|
26370
|
+
range2Filter?: Range2Filter$9;
|
|
26371
|
+
rangeFilter?: RangeFilter$8;
|
|
26372
|
+
termFilter?: TermFilter$9;
|
|
26555
26373
|
} & {
|
|
26556
26374
|
[key: string]: any;
|
|
26557
26375
|
};
|
|
26558
|
-
type Sort$
|
|
26376
|
+
type Sort$9 = {
|
|
26559
26377
|
field: string;
|
|
26560
26378
|
sortOrder?: string;
|
|
26561
26379
|
} & {
|
|
26562
26380
|
[key: string]: any;
|
|
26563
26381
|
};
|
|
26564
|
-
type RangeFilter$
|
|
26382
|
+
type RangeFilter$9 = {
|
|
26565
26383
|
field: string;
|
|
26566
26384
|
from?: any;
|
|
26567
26385
|
fromInclusive?: boolean;
|
|
@@ -26570,12 +26388,12 @@ type RangeFilter$10 = {
|
|
|
26570
26388
|
} & {
|
|
26571
26389
|
[key: string]: any;
|
|
26572
26390
|
};
|
|
26573
|
-
type L10nString$
|
|
26391
|
+
type L10nString$8 = {} & {
|
|
26574
26392
|
[key: string]: any;
|
|
26575
26393
|
};
|
|
26576
|
-
type PropertyValueDefinition$
|
|
26577
|
-
description: L10nString$
|
|
26578
|
-
displayValue: L10nString$
|
|
26394
|
+
type PropertyValueDefinition$8 = {
|
|
26395
|
+
description: L10nString$8;
|
|
26396
|
+
displayValue: L10nString$8;
|
|
26579
26397
|
id: string;
|
|
26580
26398
|
position?: number;
|
|
26581
26399
|
value: string;
|
|
@@ -26636,7 +26454,7 @@ type ShopperSeoParameters = ShopperSeoPathParameters & BaseUriParameters & Shopp
|
|
|
26636
26454
|
* ```
|
|
26637
26455
|
*
|
|
26638
26456
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
26639
|
-
* API Version: 1.0.
|
|
26457
|
+
* API Version: 1.0.6<br />
|
|
26640
26458
|
* Last Updated: <br />
|
|
26641
26459
|
* </span>
|
|
26642
26460
|
|
|
@@ -26828,17 +26646,17 @@ declare namespace ShopperSeoTypes {
|
|
|
26828
26646
|
};
|
|
26829
26647
|
type SearchRequest = {
|
|
26830
26648
|
limit?: number;
|
|
26831
|
-
query: Query$
|
|
26832
|
-
sorts?: Array<Sort$
|
|
26649
|
+
query: Query$9;
|
|
26650
|
+
sorts?: Array<Sort$9>;
|
|
26833
26651
|
offset?: any;
|
|
26834
26652
|
} & {
|
|
26835
26653
|
[key: string]: any;
|
|
26836
26654
|
};
|
|
26837
26655
|
type PropertyDefinition = {
|
|
26838
|
-
defaultValue?: PropertyValueDefinition$
|
|
26656
|
+
defaultValue?: PropertyValueDefinition$8;
|
|
26839
26657
|
id?: string;
|
|
26840
|
-
name: L10nString$
|
|
26841
|
-
description: L10nString$
|
|
26658
|
+
name: L10nString$8;
|
|
26659
|
+
description: L10nString$8;
|
|
26842
26660
|
key?: boolean;
|
|
26843
26661
|
localizable?: boolean;
|
|
26844
26662
|
mandatory?: boolean;
|
|
@@ -26851,8 +26669,8 @@ declare namespace ShopperSeoTypes {
|
|
|
26851
26669
|
searchable?: boolean;
|
|
26852
26670
|
siteSpecific?: boolean;
|
|
26853
26671
|
system?: boolean;
|
|
26854
|
-
unit?: L10nString$
|
|
26855
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
26672
|
+
unit?: L10nString$8;
|
|
26673
|
+
possibleValues?: Array<PropertyValueDefinition$8>;
|
|
26856
26674
|
type: string;
|
|
26857
26675
|
visible?: boolean;
|
|
26858
26676
|
} & {
|
|
@@ -26862,8 +26680,8 @@ declare namespace ShopperSeoTypes {
|
|
|
26862
26680
|
[key: string]: any;
|
|
26863
26681
|
};
|
|
26864
26682
|
type PaginatedSearchResult = {
|
|
26865
|
-
query: Query$
|
|
26866
|
-
sorts?: Array<Sort$
|
|
26683
|
+
query: Query$9;
|
|
26684
|
+
sorts?: Array<Sort$9>;
|
|
26867
26685
|
limit: number;
|
|
26868
26686
|
hits?: Array<object>;
|
|
26869
26687
|
offset: any;
|
|
@@ -26882,14 +26700,14 @@ declare namespace ShopperSeoTypes {
|
|
|
26882
26700
|
[key: string]: any;
|
|
26883
26701
|
};
|
|
26884
26702
|
type BoolFilter = {
|
|
26885
|
-
filters?: Array<Filter$
|
|
26703
|
+
filters?: Array<Filter$9>;
|
|
26886
26704
|
operator: string;
|
|
26887
26705
|
} & {
|
|
26888
26706
|
[key: string]: any;
|
|
26889
26707
|
};
|
|
26890
26708
|
type PaginatedSearchResultBase = {
|
|
26891
|
-
query: Query$
|
|
26892
|
-
sorts?: Array<Sort$
|
|
26709
|
+
query: Query$9;
|
|
26710
|
+
sorts?: Array<Sort$9>;
|
|
26893
26711
|
limit: number;
|
|
26894
26712
|
hits?: Array<object>;
|
|
26895
26713
|
offset: any;
|
|
@@ -26901,23 +26719,23 @@ declare namespace ShopperSeoTypes {
|
|
|
26901
26719
|
[key: string]: any;
|
|
26902
26720
|
};
|
|
26903
26721
|
type FilteredQuery = {
|
|
26904
|
-
filter: Filter$
|
|
26905
|
-
query: Query$
|
|
26722
|
+
filter: Filter$9;
|
|
26723
|
+
query: Query$9;
|
|
26906
26724
|
} & {
|
|
26907
26725
|
[key: string]: any;
|
|
26908
26726
|
};
|
|
26909
26727
|
type QueryFilter = {
|
|
26910
|
-
query: Query$
|
|
26728
|
+
query: Query$9;
|
|
26911
26729
|
} & {
|
|
26912
26730
|
[key: string]: any;
|
|
26913
26731
|
};
|
|
26914
26732
|
type Query = {
|
|
26915
|
-
boolQuery?: BoolQuery$
|
|
26733
|
+
boolQuery?: BoolQuery$9;
|
|
26916
26734
|
filteredQuery?: FilteredQuery;
|
|
26917
26735
|
matchAllQuery?: MatchAllQuery;
|
|
26918
|
-
nestedQuery?: NestedQuery$
|
|
26919
|
-
termQuery?: TermQuery$
|
|
26920
|
-
textQuery?: TextQuery$
|
|
26736
|
+
nestedQuery?: NestedQuery$9;
|
|
26737
|
+
termQuery?: TermQuery$9;
|
|
26738
|
+
textQuery?: TextQuery$9;
|
|
26921
26739
|
} & {
|
|
26922
26740
|
[key: string]: any;
|
|
26923
26741
|
};
|
|
@@ -26978,7 +26796,7 @@ declare namespace ShopperSeoTypes {
|
|
|
26978
26796
|
boolFilter?: BoolFilter;
|
|
26979
26797
|
queryFilter?: QueryFilter;
|
|
26980
26798
|
range2Filter?: Range2Filter;
|
|
26981
|
-
rangeFilter?: RangeFilter$
|
|
26799
|
+
rangeFilter?: RangeFilter$9;
|
|
26982
26800
|
termFilter?: TermFilter;
|
|
26983
26801
|
} & {
|
|
26984
26802
|
[key: string]: any;
|
|
@@ -27016,7 +26834,7 @@ declare namespace ShopperSeoTypes {
|
|
|
27016
26834
|
[key: string]: any;
|
|
27017
26835
|
};
|
|
27018
26836
|
type AttributeDefinition = {
|
|
27019
|
-
defaultValue?: PropertyValueDefinition$
|
|
26837
|
+
defaultValue?: PropertyValueDefinition$8;
|
|
27020
26838
|
id?: string;
|
|
27021
26839
|
name: L10nString;
|
|
27022
26840
|
description: L10nString;
|
|
@@ -27033,7 +26851,7 @@ declare namespace ShopperSeoTypes {
|
|
|
27033
26851
|
siteSpecific?: boolean;
|
|
27034
26852
|
system?: boolean;
|
|
27035
26853
|
unit?: L10nString;
|
|
27036
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
26854
|
+
possibleValues?: Array<PropertyValueDefinition$8>;
|
|
27037
26855
|
type: string;
|
|
27038
26856
|
visible?: boolean;
|
|
27039
26857
|
};
|
|
@@ -27132,7 +26950,7 @@ declare namespace ShopperSeoTypes {
|
|
|
27132
26950
|
* ```
|
|
27133
26951
|
*
|
|
27134
26952
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
27135
|
-
* API Version: 1.0.
|
|
26953
|
+
* API Version: 1.0.6<br />
|
|
27136
26954
|
* Last Updated: <br />
|
|
27137
26955
|
* </span>
|
|
27138
26956
|
|
|
@@ -27808,7 +27626,7 @@ declare namespace helpers {
|
|
|
27808
27626
|
* ```
|
|
27809
27627
|
*
|
|
27810
27628
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
27811
|
-
* API Version: 1.39.
|
|
27629
|
+
* API Version: 1.39.22<br />
|
|
27812
27630
|
* Last Updated: <br />
|
|
27813
27631
|
* </span>
|
|
27814
27632
|
|