commerce-sdk-isomorphic 1.8.0 → 1.9.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 +7 -1
- package/LICENSE.txt +1 -1
- package/lib/index.cjs.d.ts +1333 -317
- package/lib/index.cjs.js +1 -1
- package/lib/index.esm.d.ts +1333 -317
- package/lib/index.esm.js +1 -1
- package/package.json +2 -1
package/lib/index.cjs.d.ts
CHANGED
|
@@ -7884,6 +7884,9 @@ type ProductListItemReference$0 = {
|
|
|
7884
7884
|
} & {
|
|
7885
7885
|
[key: string]: any;
|
|
7886
7886
|
};
|
|
7887
|
+
type RangeFilter$1 = {
|
|
7888
|
+
[key: string]: any;
|
|
7889
|
+
};
|
|
7887
7890
|
type TermQuery$1 = {
|
|
7888
7891
|
fields: Array<string>;
|
|
7889
7892
|
operator: string;
|
|
@@ -13068,6 +13071,12 @@ declare namespace ShopperCustomersTypes {
|
|
|
13068
13071
|
}>, rawResponse?: T): Promise<T extends true ? Response : PublicProductListItem>;
|
|
13069
13072
|
}
|
|
13070
13073
|
}
|
|
13074
|
+
type BoolFilter$2 = {
|
|
13075
|
+
filters?: Array<any>;
|
|
13076
|
+
operator: string;
|
|
13077
|
+
} & {
|
|
13078
|
+
[key: string]: any;
|
|
13079
|
+
};
|
|
13071
13080
|
type MatchAllQuery$2 = {} & {
|
|
13072
13081
|
[key: string]: any;
|
|
13073
13082
|
};
|
|
@@ -13077,6 +13086,11 @@ type FilteredQuery$2 = {
|
|
|
13077
13086
|
} & {
|
|
13078
13087
|
[key: string]: any;
|
|
13079
13088
|
};
|
|
13089
|
+
type QueryFilter$2 = {
|
|
13090
|
+
query: any;
|
|
13091
|
+
} & {
|
|
13092
|
+
[key: string]: any;
|
|
13093
|
+
};
|
|
13080
13094
|
type Query$2 = {
|
|
13081
13095
|
boolQuery?: BoolQuery$1;
|
|
13082
13096
|
filteredQuery?: FilteredQuery$2;
|
|
@@ -13094,12 +13108,30 @@ type TermQuery$2 = {
|
|
|
13094
13108
|
} & {
|
|
13095
13109
|
[key: string]: any;
|
|
13096
13110
|
};
|
|
13111
|
+
type TermFilter$2 = {
|
|
13112
|
+
field: string;
|
|
13113
|
+
operator: string;
|
|
13114
|
+
values?: Array<any>;
|
|
13115
|
+
} & {
|
|
13116
|
+
[key: string]: any;
|
|
13117
|
+
};
|
|
13097
13118
|
type TextQuery$2 = {
|
|
13098
13119
|
fields: Array<string>;
|
|
13099
13120
|
searchPhrase: string;
|
|
13100
13121
|
} & {
|
|
13101
13122
|
[key: string]: any;
|
|
13102
13123
|
};
|
|
13124
|
+
type Range2Filter$2 = {
|
|
13125
|
+
filterMode?: string;
|
|
13126
|
+
fromField: string;
|
|
13127
|
+
fromInclusive?: boolean;
|
|
13128
|
+
fromValue?: any;
|
|
13129
|
+
toField: string;
|
|
13130
|
+
toInclusive?: boolean;
|
|
13131
|
+
toValue?: any;
|
|
13132
|
+
} & {
|
|
13133
|
+
[key: string]: any;
|
|
13134
|
+
};
|
|
13103
13135
|
type BoolQuery$2 = {
|
|
13104
13136
|
must?: Array<any>;
|
|
13105
13137
|
mustNot?: Array<any>;
|
|
@@ -13114,6 +13146,15 @@ type NestedQuery$2 = {
|
|
|
13114
13146
|
} & {
|
|
13115
13147
|
[key: string]: any;
|
|
13116
13148
|
};
|
|
13149
|
+
type Filter$2 = {
|
|
13150
|
+
boolFilter?: BoolFilter$2;
|
|
13151
|
+
queryFilter?: QueryFilter$2;
|
|
13152
|
+
range2Filter?: Range2Filter$2;
|
|
13153
|
+
rangeFilter?: RangeFilter$1;
|
|
13154
|
+
termFilter?: TermFilter$2;
|
|
13155
|
+
} & {
|
|
13156
|
+
[key: string]: any;
|
|
13157
|
+
};
|
|
13117
13158
|
type Sort$2 = {
|
|
13118
13159
|
field: string;
|
|
13119
13160
|
sortOrder?: string;
|
|
@@ -14083,23 +14124,46 @@ declare namespace ShopperDiscoverySearchTypes {
|
|
|
14083
14124
|
}>, rawResponse?: T): Promise<T extends true ? Response : Suggestions>;
|
|
14084
14125
|
}
|
|
14085
14126
|
}
|
|
14086
|
-
type
|
|
14087
|
-
|
|
14088
|
-
|
|
14127
|
+
type PageResult = {
|
|
14128
|
+
data: Array<Page>;
|
|
14129
|
+
} & {
|
|
14130
|
+
[key: string]: any;
|
|
14131
|
+
};
|
|
14132
|
+
type Page = {
|
|
14133
|
+
id: string;
|
|
14134
|
+
typeId: string;
|
|
14135
|
+
aspectTypeId?: string;
|
|
14136
|
+
name?: string;
|
|
14089
14137
|
description?: string;
|
|
14090
|
-
|
|
14091
|
-
|
|
14092
|
-
|
|
14093
|
-
|
|
14094
|
-
|
|
14095
|
-
|
|
14096
|
-
|
|
14097
|
-
|
|
14138
|
+
pageTitle?: string;
|
|
14139
|
+
pageDescription?: string;
|
|
14140
|
+
pageKeywords?: string;
|
|
14141
|
+
data?: {} & {
|
|
14142
|
+
[key: string]: any;
|
|
14143
|
+
};
|
|
14144
|
+
custom?: {} & {
|
|
14145
|
+
[key: string]: any;
|
|
14146
|
+
};
|
|
14147
|
+
regions?: Array<Region>;
|
|
14098
14148
|
} & {
|
|
14099
14149
|
[key: string]: any;
|
|
14100
14150
|
};
|
|
14101
|
-
type
|
|
14102
|
-
|
|
14151
|
+
type Region = {
|
|
14152
|
+
id: string;
|
|
14153
|
+
components?: Array<Component>;
|
|
14154
|
+
} & {
|
|
14155
|
+
[key: string]: any;
|
|
14156
|
+
};
|
|
14157
|
+
type Component = {
|
|
14158
|
+
id: string;
|
|
14159
|
+
typeId: string;
|
|
14160
|
+
data?: {} & {
|
|
14161
|
+
[key: string]: any;
|
|
14162
|
+
};
|
|
14163
|
+
custom?: {} & {
|
|
14164
|
+
[key: string]: any;
|
|
14165
|
+
};
|
|
14166
|
+
regions?: Array<Region>;
|
|
14103
14167
|
} & {
|
|
14104
14168
|
[key: string]: any;
|
|
14105
14169
|
};
|
|
@@ -14107,7 +14171,7 @@ type RangeFilter$3 = {
|
|
|
14107
14171
|
[key: string]: any;
|
|
14108
14172
|
};
|
|
14109
14173
|
type BoolFilter$3 = {
|
|
14110
|
-
filters?: Array<
|
|
14174
|
+
filters?: Array<Filter$2>;
|
|
14111
14175
|
operator: string;
|
|
14112
14176
|
} & {
|
|
14113
14177
|
[key: string]: any;
|
|
@@ -14116,13 +14180,13 @@ type MatchAllQuery$3 = {} & {
|
|
|
14116
14180
|
[key: string]: any;
|
|
14117
14181
|
};
|
|
14118
14182
|
type FilteredQuery$3 = {
|
|
14119
|
-
filter:
|
|
14120
|
-
query:
|
|
14183
|
+
filter: Filter$2;
|
|
14184
|
+
query: Query$2;
|
|
14121
14185
|
} & {
|
|
14122
14186
|
[key: string]: any;
|
|
14123
14187
|
};
|
|
14124
14188
|
type QueryFilter$3 = {
|
|
14125
|
-
query:
|
|
14189
|
+
query: Query$2;
|
|
14126
14190
|
} & {
|
|
14127
14191
|
[key: string]: any;
|
|
14128
14192
|
};
|
|
@@ -14168,15 +14232,15 @@ type Range2Filter$3 = {
|
|
|
14168
14232
|
[key: string]: any;
|
|
14169
14233
|
};
|
|
14170
14234
|
type BoolQuery$3 = {
|
|
14171
|
-
must?: Array<
|
|
14172
|
-
mustNot?: Array<
|
|
14173
|
-
should?: Array<
|
|
14235
|
+
must?: Array<Query$3>;
|
|
14236
|
+
mustNot?: Array<Query$3>;
|
|
14237
|
+
should?: Array<Query$3>;
|
|
14174
14238
|
} & {
|
|
14175
14239
|
[key: string]: any;
|
|
14176
14240
|
};
|
|
14177
14241
|
type NestedQuery$3 = {
|
|
14178
14242
|
path: string;
|
|
14179
|
-
query:
|
|
14243
|
+
query: Query$3;
|
|
14180
14244
|
scoreMode?: string;
|
|
14181
14245
|
} & {
|
|
14182
14246
|
[key: string]: any;
|
|
@@ -14207,31 +14271,38 @@ type PropertyValueDefinition$2 = {
|
|
|
14207
14271
|
value: string;
|
|
14208
14272
|
};
|
|
14209
14273
|
/**
|
|
14210
|
-
* All path parameters that are used by at least one
|
|
14274
|
+
* All path parameters that are used by at least one ShopperExperience method.
|
|
14211
14275
|
*/
|
|
14212
|
-
type
|
|
14276
|
+
type ShopperExperiencePathParameters = {
|
|
14213
14277
|
organizationId?: string;
|
|
14278
|
+
pageId?: string;
|
|
14214
14279
|
};
|
|
14215
14280
|
/**
|
|
14216
|
-
* All query parameters that are used by at least one
|
|
14281
|
+
* All query parameters that are used by at least one ShopperExperience method.
|
|
14217
14282
|
*/
|
|
14218
|
-
type
|
|
14283
|
+
type ShopperExperienceQueryParameters = {
|
|
14284
|
+
categoryId?: string;
|
|
14285
|
+
productId?: string;
|
|
14286
|
+
aspectTypeId?: string;
|
|
14287
|
+
aspectAttributes?: string;
|
|
14288
|
+
parameters?: string;
|
|
14219
14289
|
siteId?: string;
|
|
14290
|
+
locale?: string;
|
|
14220
14291
|
};
|
|
14221
14292
|
/**
|
|
14222
|
-
* All parameters that are used by
|
|
14293
|
+
* All parameters that are used by ShopperExperience.
|
|
14223
14294
|
*/
|
|
14224
|
-
type
|
|
14295
|
+
type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriParameters & ShopperExperienceQueryParameters;
|
|
14225
14296
|
/**
|
|
14226
|
-
* [Shopper
|
|
14297
|
+
* [Shopper Experience](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-experience:Summary)
|
|
14227
14298
|
* ==================================
|
|
14228
14299
|
*
|
|
14229
|
-
*
|
|
14300
|
+
* **<br />
|
|
14230
14301
|
*
|
|
14231
14302
|
* Simple example:
|
|
14232
14303
|
*
|
|
14233
14304
|
* ```typescript
|
|
14234
|
-
* import {
|
|
14305
|
+
* import { ShopperExperience } from "commerce-sdk-isomorphic";
|
|
14235
14306
|
*
|
|
14236
14307
|
* const clientConfig = {
|
|
14237
14308
|
* parameters: {
|
|
@@ -14241,76 +14312,190 @@ type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters &
|
|
|
14241
14312
|
* siteId: "XX"
|
|
14242
14313
|
* }
|
|
14243
14314
|
* };
|
|
14244
|
-
* const
|
|
14315
|
+
* const shopperExperienceClient = new ShopperExperience(clientConfig);
|
|
14245
14316
|
* ```
|
|
14246
14317
|
*
|
|
14247
14318
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
14248
|
-
* API Version: 1.0.
|
|
14319
|
+
* API Version: 1.0.3<br />
|
|
14249
14320
|
* Last Updated: <br />
|
|
14250
14321
|
* </span>
|
|
14251
14322
|
|
|
14252
14323
|
*
|
|
14253
14324
|
|
|
14254
14325
|
*/
|
|
14255
|
-
declare class
|
|
14326
|
+
declare class ShopperExperience<ConfigParameters extends ShopperExperienceParameters & Record<string, unknown>> {
|
|
14256
14327
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
14257
14328
|
clientConfig: ClientConfig<ConfigParameters> & {
|
|
14258
14329
|
baseUri: string;
|
|
14259
14330
|
};
|
|
14260
|
-
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/
|
|
14331
|
+
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/{version}";
|
|
14261
14332
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
14262
14333
|
/**
|
|
14263
|
-
*
|
|
14334
|
+
* Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
|
|
14335
|
+
|
|
14336
|
+
Either `categoryId` or `productId` must be given in addition to `aspectTypeId`. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most.
|
|
14337
|
+
|
|
14338
|
+
**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
|
|
14264
14339
|
*
|
|
14265
|
-
* If you would like to get a raw Response object use the other
|
|
14340
|
+
* If you would like to get a raw Response object use the other getPages function.
|
|
14266
14341
|
*
|
|
14267
14342
|
* @param options - An object containing the options for this method.
|
|
14268
14343
|
* @param parameters - An object containing the parameters for this method.
|
|
14269
|
-
* @param organizationId -
|
|
14344
|
+
* @param organizationId -
|
|
14345
|
+
* @param categoryId - Category identifier that is used for searching the page assignment. Must be provided if no `productId` is provided.
|
|
14346
|
+
* @param productId - Product identifier that is used for searching the page assignment. Must be provided if no `categoryId` is provided.
|
|
14347
|
+
* @param aspectTypeId - Aspect type identifier that is used for searching the page assignment in conjunction with either the `productId` or `categoryId`.
|
|
14348
|
+
* @param aspectAttributes - A JSON respresentation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
|
|
14349
|
+
* @param parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
|
|
14270
14350
|
* @param siteId -
|
|
14351
|
+
* @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.
|
|
14352
|
+
Below are some valid examples:
|
|
14353
|
+
- en-US
|
|
14354
|
+
- de-AT
|
|
14355
|
+
- de
|
|
14356
|
+
- default
|
|
14271
14357
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
14272
14358
|
* sent with this request.
|
|
14273
|
-
* @param body - The data to send as the request body.
|
|
14274
14359
|
*
|
|
14275
|
-
* @returns A promise of type
|
|
14360
|
+
* @returns A promise of type PageResult.
|
|
14276
14361
|
*
|
|
14277
14362
|
*/
|
|
14278
|
-
|
|
14363
|
+
getPages(options?: RequireParametersUnlessAllAreOptional<{
|
|
14279
14364
|
parameters?: CompositeParameters<{
|
|
14280
14365
|
organizationId: string;
|
|
14366
|
+
categoryId?: string;
|
|
14367
|
+
productId?: string;
|
|
14368
|
+
aspectTypeId: string;
|
|
14369
|
+
aspectAttributes?: string;
|
|
14370
|
+
parameters?: string;
|
|
14281
14371
|
siteId: string;
|
|
14372
|
+
locale?: string;
|
|
14282
14373
|
}, ConfigParameters>;
|
|
14283
14374
|
headers?: {
|
|
14284
14375
|
[key: string]: string;
|
|
14285
14376
|
};
|
|
14286
|
-
|
|
14287
|
-
}>): Promise<GiftCertificate>;
|
|
14377
|
+
}>): Promise<PageResult>;
|
|
14288
14378
|
/**
|
|
14289
|
-
*
|
|
14379
|
+
* Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
|
|
14380
|
+
|
|
14381
|
+
Either `categoryId` or `productId` must be given in addition to `aspectTypeId`. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most.
|
|
14382
|
+
|
|
14383
|
+
**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
|
|
14290
14384
|
*
|
|
14291
14385
|
* @param options - An object containing the options for this method.
|
|
14292
14386
|
* @param parameters - An object containing the parameters for this method.
|
|
14293
|
-
* @param organizationId -
|
|
14387
|
+
* @param organizationId -
|
|
14388
|
+
* @param categoryId - Category identifier that is used for searching the page assignment. Must be provided if no `productId` is provided.
|
|
14389
|
+
* @param productId - Product identifier that is used for searching the page assignment. Must be provided if no `categoryId` is provided.
|
|
14390
|
+
* @param aspectTypeId - Aspect type identifier that is used for searching the page assignment in conjunction with either the `productId` or `categoryId`.
|
|
14391
|
+
* @param aspectAttributes - A JSON respresentation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
|
|
14392
|
+
* @param parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
|
|
14294
14393
|
* @param siteId -
|
|
14394
|
+
* @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.
|
|
14395
|
+
Below are some valid examples:
|
|
14396
|
+
- en-US
|
|
14397
|
+
- de-AT
|
|
14398
|
+
- de
|
|
14399
|
+
- default
|
|
14295
14400
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
14296
14401
|
* sent with this request.
|
|
14297
|
-
* @param body - The data to send as the request body.
|
|
14298
14402
|
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
14299
|
-
* @returns A promise of type Response if rawResponse is true, a promise of type
|
|
14403
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type PageResult otherwise.
|
|
14300
14404
|
*
|
|
14301
14405
|
*/
|
|
14302
|
-
|
|
14406
|
+
getPages<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
14303
14407
|
parameters?: CompositeParameters<{
|
|
14304
14408
|
organizationId: string;
|
|
14409
|
+
categoryId?: string;
|
|
14410
|
+
productId?: string;
|
|
14411
|
+
aspectTypeId: string;
|
|
14412
|
+
aspectAttributes?: string;
|
|
14413
|
+
parameters?: string;
|
|
14305
14414
|
siteId: string;
|
|
14415
|
+
locale?: string;
|
|
14306
14416
|
}, ConfigParameters>;
|
|
14307
14417
|
headers?: {
|
|
14308
14418
|
[key: string]: string;
|
|
14309
14419
|
};
|
|
14310
|
-
|
|
14311
|
-
|
|
14420
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : PageResult>;
|
|
14421
|
+
/**
|
|
14422
|
+
* Get a Page Designer page based on a single page ID. The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility.
|
|
14423
|
+
|
|
14424
|
+
**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
|
|
14425
|
+
*
|
|
14426
|
+
* If you would like to get a raw Response object use the other getPage function.
|
|
14427
|
+
*
|
|
14428
|
+
* @param options - An object containing the options for this method.
|
|
14429
|
+
* @param parameters - An object containing the parameters for this method.
|
|
14430
|
+
* @param organizationId -
|
|
14431
|
+
* @param pageId - Identifier for the requested page.
|
|
14432
|
+
* @param aspectAttributes - A JSON respresentation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
|
|
14433
|
+
* @param parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
|
|
14434
|
+
* @param siteId -
|
|
14435
|
+
* @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.
|
|
14436
|
+
Below are some valid examples:
|
|
14437
|
+
- en-US
|
|
14438
|
+
- de-AT
|
|
14439
|
+
- de
|
|
14440
|
+
- default
|
|
14441
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
14442
|
+
* sent with this request.
|
|
14443
|
+
*
|
|
14444
|
+
* @returns A promise of type Page.
|
|
14445
|
+
*
|
|
14446
|
+
*/
|
|
14447
|
+
getPage(options?: RequireParametersUnlessAllAreOptional<{
|
|
14448
|
+
parameters?: CompositeParameters<{
|
|
14449
|
+
organizationId: string;
|
|
14450
|
+
pageId: string;
|
|
14451
|
+
aspectAttributes?: string;
|
|
14452
|
+
parameters?: string;
|
|
14453
|
+
siteId: string;
|
|
14454
|
+
locale?: string;
|
|
14455
|
+
}, ConfigParameters>;
|
|
14456
|
+
headers?: {
|
|
14457
|
+
[key: string]: string;
|
|
14458
|
+
};
|
|
14459
|
+
}>): Promise<Page>;
|
|
14460
|
+
/**
|
|
14461
|
+
* Get a Page Designer page based on a single page ID. The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility.
|
|
14462
|
+
|
|
14463
|
+
**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
|
|
14464
|
+
*
|
|
14465
|
+
* @param options - An object containing the options for this method.
|
|
14466
|
+
* @param parameters - An object containing the parameters for this method.
|
|
14467
|
+
* @param organizationId -
|
|
14468
|
+
* @param pageId - Identifier for the requested page.
|
|
14469
|
+
* @param aspectAttributes - A JSON respresentation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
|
|
14470
|
+
* @param parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
|
|
14471
|
+
* @param siteId -
|
|
14472
|
+
* @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.
|
|
14473
|
+
Below are some valid examples:
|
|
14474
|
+
- en-US
|
|
14475
|
+
- de-AT
|
|
14476
|
+
- de
|
|
14477
|
+
- default
|
|
14478
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
14479
|
+
* sent with this request.
|
|
14480
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
14481
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type Page otherwise.
|
|
14482
|
+
*
|
|
14483
|
+
*/
|
|
14484
|
+
getPage<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
14485
|
+
parameters?: CompositeParameters<{
|
|
14486
|
+
organizationId: string;
|
|
14487
|
+
pageId: string;
|
|
14488
|
+
aspectAttributes?: string;
|
|
14489
|
+
parameters?: string;
|
|
14490
|
+
siteId: string;
|
|
14491
|
+
locale?: string;
|
|
14492
|
+
}, ConfigParameters>;
|
|
14493
|
+
headers?: {
|
|
14494
|
+
[key: string]: string;
|
|
14495
|
+
};
|
|
14496
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : Page>;
|
|
14312
14497
|
}
|
|
14313
|
-
declare namespace
|
|
14498
|
+
declare namespace ShopperExperienceTypes {
|
|
14314
14499
|
/*
|
|
14315
14500
|
* Copyright (c) 2021, salesforce.com, inc.
|
|
14316
14501
|
* All rights reserved.
|
|
@@ -14387,23 +14572,46 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
14387
14572
|
constructor(config: ClientConfigInit<Params>);
|
|
14388
14573
|
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
14389
14574
|
}
|
|
14390
|
-
type
|
|
14391
|
-
|
|
14392
|
-
|
|
14575
|
+
type PageResult = {
|
|
14576
|
+
data: Array<Page>;
|
|
14577
|
+
} & {
|
|
14578
|
+
[key: string]: any;
|
|
14579
|
+
};
|
|
14580
|
+
type Page = {
|
|
14581
|
+
id: string;
|
|
14582
|
+
typeId: string;
|
|
14583
|
+
aspectTypeId?: string;
|
|
14584
|
+
name?: string;
|
|
14393
14585
|
description?: string;
|
|
14394
|
-
|
|
14395
|
-
|
|
14396
|
-
|
|
14397
|
-
|
|
14398
|
-
|
|
14399
|
-
|
|
14400
|
-
|
|
14401
|
-
|
|
14586
|
+
pageTitle?: string;
|
|
14587
|
+
pageDescription?: string;
|
|
14588
|
+
pageKeywords?: string;
|
|
14589
|
+
data?: {} & {
|
|
14590
|
+
[key: string]: any;
|
|
14591
|
+
};
|
|
14592
|
+
custom?: {} & {
|
|
14593
|
+
[key: string]: any;
|
|
14594
|
+
};
|
|
14595
|
+
regions?: Array<Region>;
|
|
14402
14596
|
} & {
|
|
14403
14597
|
[key: string]: any;
|
|
14404
14598
|
};
|
|
14405
|
-
type
|
|
14406
|
-
|
|
14599
|
+
type Region = {
|
|
14600
|
+
id: string;
|
|
14601
|
+
components?: Array<Component>;
|
|
14602
|
+
} & {
|
|
14603
|
+
[key: string]: any;
|
|
14604
|
+
};
|
|
14605
|
+
type Component = {
|
|
14606
|
+
id: string;
|
|
14607
|
+
typeId: string;
|
|
14608
|
+
data?: {} & {
|
|
14609
|
+
[key: string]: any;
|
|
14610
|
+
};
|
|
14611
|
+
custom?: {} & {
|
|
14612
|
+
[key: string]: any;
|
|
14613
|
+
};
|
|
14614
|
+
regions?: Array<Region>;
|
|
14407
14615
|
} & {
|
|
14408
14616
|
[key: string]: any;
|
|
14409
14617
|
};
|
|
@@ -14458,7 +14666,7 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
14458
14666
|
};
|
|
14459
14667
|
type SearchRequest = {
|
|
14460
14668
|
limit?: number;
|
|
14461
|
-
query:
|
|
14669
|
+
query: Query$3;
|
|
14462
14670
|
sorts?: Array<Sort$3>;
|
|
14463
14671
|
offset?: any;
|
|
14464
14672
|
} & {
|
|
@@ -14492,7 +14700,7 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
14492
14700
|
[key: string]: any;
|
|
14493
14701
|
};
|
|
14494
14702
|
type PaginatedSearchResult = {
|
|
14495
|
-
query:
|
|
14703
|
+
query: Query$3;
|
|
14496
14704
|
sorts?: Array<Sort$3>;
|
|
14497
14705
|
limit: number;
|
|
14498
14706
|
hits?: Array<object>;
|
|
@@ -14512,13 +14720,13 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
14512
14720
|
[key: string]: any;
|
|
14513
14721
|
};
|
|
14514
14722
|
type BoolFilter = {
|
|
14515
|
-
filters?: Array<
|
|
14723
|
+
filters?: Array<Filter$3>;
|
|
14516
14724
|
operator: string;
|
|
14517
14725
|
} & {
|
|
14518
14726
|
[key: string]: any;
|
|
14519
14727
|
};
|
|
14520
14728
|
type PaginatedSearchResultBase = {
|
|
14521
|
-
query:
|
|
14729
|
+
query: Query$3;
|
|
14522
14730
|
sorts?: Array<Sort$3>;
|
|
14523
14731
|
limit: number;
|
|
14524
14732
|
hits?: Array<object>;
|
|
@@ -14531,13 +14739,13 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
14531
14739
|
[key: string]: any;
|
|
14532
14740
|
};
|
|
14533
14741
|
type FilteredQuery = {
|
|
14534
|
-
filter:
|
|
14535
|
-
query:
|
|
14742
|
+
filter: Filter$3;
|
|
14743
|
+
query: Query$3;
|
|
14536
14744
|
} & {
|
|
14537
14745
|
[key: string]: any;
|
|
14538
14746
|
};
|
|
14539
14747
|
type QueryFilter = {
|
|
14540
|
-
query:
|
|
14748
|
+
query: Query$3;
|
|
14541
14749
|
} & {
|
|
14542
14750
|
[key: string]: any;
|
|
14543
14751
|
};
|
|
@@ -14583,9 +14791,9 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
14583
14791
|
[key: string]: any;
|
|
14584
14792
|
};
|
|
14585
14793
|
type BoolQuery = {
|
|
14586
|
-
must?: Array<
|
|
14587
|
-
mustNot?: Array<
|
|
14588
|
-
should?: Array<
|
|
14794
|
+
must?: Array<Query>;
|
|
14795
|
+
mustNot?: Array<Query>;
|
|
14796
|
+
should?: Array<Query>;
|
|
14589
14797
|
} & {
|
|
14590
14798
|
[key: string]: any;
|
|
14591
14799
|
};
|
|
@@ -14599,7 +14807,7 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
14599
14807
|
};
|
|
14600
14808
|
type NestedQuery = {
|
|
14601
14809
|
path: string;
|
|
14602
|
-
query:
|
|
14810
|
+
query: Query;
|
|
14603
14811
|
scoreMode?: string;
|
|
14604
14812
|
} & {
|
|
14605
14813
|
[key: string]: any;
|
|
@@ -14621,7 +14829,7 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
14621
14829
|
};
|
|
14622
14830
|
type SearchRequestBase = {
|
|
14623
14831
|
limit?: number;
|
|
14624
|
-
query:
|
|
14832
|
+
query: Query;
|
|
14625
14833
|
sorts?: Array<Sort>;
|
|
14626
14834
|
offset?: any;
|
|
14627
14835
|
} & {
|
|
@@ -14666,31 +14874,38 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
14666
14874
|
value: string;
|
|
14667
14875
|
};
|
|
14668
14876
|
/**
|
|
14669
|
-
* All path parameters that are used by at least one
|
|
14877
|
+
* All path parameters that are used by at least one ShopperExperience method.
|
|
14670
14878
|
*/
|
|
14671
|
-
type
|
|
14879
|
+
type ShopperExperiencePathParameters = {
|
|
14672
14880
|
organizationId?: string;
|
|
14881
|
+
pageId?: string;
|
|
14673
14882
|
};
|
|
14674
14883
|
/**
|
|
14675
|
-
* All query parameters that are used by at least one
|
|
14884
|
+
* All query parameters that are used by at least one ShopperExperience method.
|
|
14676
14885
|
*/
|
|
14677
|
-
type
|
|
14886
|
+
type ShopperExperienceQueryParameters = {
|
|
14887
|
+
categoryId?: string;
|
|
14888
|
+
productId?: string;
|
|
14889
|
+
aspectTypeId?: string;
|
|
14890
|
+
aspectAttributes?: string;
|
|
14891
|
+
parameters?: string;
|
|
14678
14892
|
siteId?: string;
|
|
14893
|
+
locale?: string;
|
|
14679
14894
|
};
|
|
14680
14895
|
/**
|
|
14681
|
-
* All parameters that are used by
|
|
14896
|
+
* All parameters that are used by ShopperExperience.
|
|
14682
14897
|
*/
|
|
14683
|
-
type
|
|
14898
|
+
type ShopperExperienceParameters = ShopperExperiencePathParameters & BaseUriParameters & ShopperExperienceQueryParameters;
|
|
14684
14899
|
/**
|
|
14685
|
-
* [Shopper
|
|
14900
|
+
* [Shopper Experience](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-experience:Summary)
|
|
14686
14901
|
* ==================================
|
|
14687
14902
|
*
|
|
14688
|
-
*
|
|
14903
|
+
* **<br />
|
|
14689
14904
|
*
|
|
14690
14905
|
* Simple example:
|
|
14691
14906
|
*
|
|
14692
14907
|
* ```typescript
|
|
14693
|
-
* import {
|
|
14908
|
+
* import { ShopperExperience } from "commerce-sdk-isomorphic";
|
|
14694
14909
|
*
|
|
14695
14910
|
* const clientConfig = {
|
|
14696
14911
|
* parameters: {
|
|
@@ -14700,36 +14915,837 @@ declare namespace ShopperGiftCertificatesTypes {
|
|
|
14700
14915
|
* siteId: "XX"
|
|
14701
14916
|
* }
|
|
14702
14917
|
* };
|
|
14703
|
-
* const
|
|
14918
|
+
* const shopperExperienceClient = new ShopperExperience(clientConfig);
|
|
14704
14919
|
* ```
|
|
14705
14920
|
*
|
|
14706
14921
|
* <span style="font-size:.7em; display:block; text-align: right">
|
|
14707
|
-
* API Version: 1.0.
|
|
14922
|
+
* API Version: 1.0.3<br />
|
|
14708
14923
|
* Last Updated: <br />
|
|
14709
14924
|
* </span>
|
|
14710
14925
|
|
|
14711
14926
|
*
|
|
14712
14927
|
|
|
14713
14928
|
*/
|
|
14714
|
-
class
|
|
14929
|
+
class ShopperExperience<ConfigParameters extends ShopperExperienceParameters & Record<string, unknown>> {
|
|
14715
14930
|
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
14716
14931
|
clientConfig: ClientConfig<ConfigParameters> & {
|
|
14717
14932
|
baseUri: string;
|
|
14718
14933
|
};
|
|
14719
|
-
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/
|
|
14934
|
+
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/{version}";
|
|
14720
14935
|
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
14721
14936
|
/**
|
|
14722
|
-
*
|
|
14937
|
+
* Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
|
|
14938
|
+
|
|
14939
|
+
Either `categoryId` or `productId` must be given in addition to `aspectTypeId`. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most.
|
|
14940
|
+
|
|
14941
|
+
**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
|
|
14723
14942
|
*
|
|
14724
|
-
* If you would like to get a raw Response object use the other
|
|
14943
|
+
* If you would like to get a raw Response object use the other getPages function.
|
|
14725
14944
|
*
|
|
14726
14945
|
* @param options - An object containing the options for this method.
|
|
14727
14946
|
* @param parameters - An object containing the parameters for this method.
|
|
14728
|
-
* @param organizationId -
|
|
14947
|
+
* @param organizationId -
|
|
14948
|
+
* @param categoryId - Category identifier that is used for searching the page assignment. Must be provided if no `productId` is provided.
|
|
14949
|
+
* @param productId - Product identifier that is used for searching the page assignment. Must be provided if no `categoryId` is provided.
|
|
14950
|
+
* @param aspectTypeId - Aspect type identifier that is used for searching the page assignment in conjunction with either the `productId` or `categoryId`.
|
|
14951
|
+
* @param aspectAttributes - A JSON respresentation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
|
|
14952
|
+
* @param parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
|
|
14729
14953
|
* @param siteId -
|
|
14954
|
+
* @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.
|
|
14955
|
+
Below are some valid examples:
|
|
14956
|
+
- en-US
|
|
14957
|
+
- de-AT
|
|
14958
|
+
- de
|
|
14959
|
+
- default
|
|
14730
14960
|
* @param headers - An object literal of key value pairs of the headers to be
|
|
14731
14961
|
* sent with this request.
|
|
14732
|
-
*
|
|
14962
|
+
*
|
|
14963
|
+
* @returns A promise of type PageResult.
|
|
14964
|
+
*
|
|
14965
|
+
*/
|
|
14966
|
+
getPages(options?: RequireParametersUnlessAllAreOptional<{
|
|
14967
|
+
parameters?: CompositeParameters<{
|
|
14968
|
+
organizationId: string;
|
|
14969
|
+
categoryId?: string;
|
|
14970
|
+
productId?: string;
|
|
14971
|
+
aspectTypeId: string;
|
|
14972
|
+
aspectAttributes?: string;
|
|
14973
|
+
parameters?: string;
|
|
14974
|
+
siteId: string;
|
|
14975
|
+
locale?: string;
|
|
14976
|
+
}, ConfigParameters>;
|
|
14977
|
+
headers?: {
|
|
14978
|
+
[key: string]: string;
|
|
14979
|
+
};
|
|
14980
|
+
}>): Promise<PageResult>;
|
|
14981
|
+
/**
|
|
14982
|
+
* Get Page Designer pages. The results will apply the visibility rules for each page's components, such as personalization or scheduled visibility.
|
|
14983
|
+
|
|
14984
|
+
Either `categoryId` or `productId` must be given in addition to `aspectTypeId`. Because only a single page-to-product and page-to-category assignment per aspect type can be authored today, the returned results contains one element at most.
|
|
14985
|
+
|
|
14986
|
+
**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
|
|
14987
|
+
*
|
|
14988
|
+
* @param options - An object containing the options for this method.
|
|
14989
|
+
* @param parameters - An object containing the parameters for this method.
|
|
14990
|
+
* @param organizationId -
|
|
14991
|
+
* @param categoryId - Category identifier that is used for searching the page assignment. Must be provided if no `productId` is provided.
|
|
14992
|
+
* @param productId - Product identifier that is used for searching the page assignment. Must be provided if no `categoryId` is provided.
|
|
14993
|
+
* @param aspectTypeId - Aspect type identifier that is used for searching the page assignment in conjunction with either the `productId` or `categoryId`.
|
|
14994
|
+
* @param aspectAttributes - A JSON respresentation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
|
|
14995
|
+
* @param parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
|
|
14996
|
+
* @param siteId -
|
|
14997
|
+
* @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.
|
|
14998
|
+
Below are some valid examples:
|
|
14999
|
+
- en-US
|
|
15000
|
+
- de-AT
|
|
15001
|
+
- de
|
|
15002
|
+
- default
|
|
15003
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
15004
|
+
* sent with this request.
|
|
15005
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
15006
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type PageResult otherwise.
|
|
15007
|
+
*
|
|
15008
|
+
*/
|
|
15009
|
+
getPages<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
15010
|
+
parameters?: CompositeParameters<{
|
|
15011
|
+
organizationId: string;
|
|
15012
|
+
categoryId?: string;
|
|
15013
|
+
productId?: string;
|
|
15014
|
+
aspectTypeId: string;
|
|
15015
|
+
aspectAttributes?: string;
|
|
15016
|
+
parameters?: string;
|
|
15017
|
+
siteId: string;
|
|
15018
|
+
locale?: string;
|
|
15019
|
+
}, ConfigParameters>;
|
|
15020
|
+
headers?: {
|
|
15021
|
+
[key: string]: string;
|
|
15022
|
+
};
|
|
15023
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : PageResult>;
|
|
15024
|
+
/**
|
|
15025
|
+
* Get a Page Designer page based on a single page ID. The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility.
|
|
15026
|
+
|
|
15027
|
+
**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
|
|
15028
|
+
*
|
|
15029
|
+
* If you would like to get a raw Response object use the other getPage function.
|
|
15030
|
+
*
|
|
15031
|
+
* @param options - An object containing the options for this method.
|
|
15032
|
+
* @param parameters - An object containing the parameters for this method.
|
|
15033
|
+
* @param organizationId -
|
|
15034
|
+
* @param pageId - Identifier for the requested page.
|
|
15035
|
+
* @param aspectAttributes - A JSON respresentation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
|
|
15036
|
+
* @param parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
|
|
15037
|
+
* @param siteId -
|
|
15038
|
+
* @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.
|
|
15039
|
+
Below are some valid examples:
|
|
15040
|
+
- en-US
|
|
15041
|
+
- de-AT
|
|
15042
|
+
- de
|
|
15043
|
+
- default
|
|
15044
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
15045
|
+
* sent with this request.
|
|
15046
|
+
*
|
|
15047
|
+
* @returns A promise of type Page.
|
|
15048
|
+
*
|
|
15049
|
+
*/
|
|
15050
|
+
getPage(options?: RequireParametersUnlessAllAreOptional<{
|
|
15051
|
+
parameters?: CompositeParameters<{
|
|
15052
|
+
organizationId: string;
|
|
15053
|
+
pageId: string;
|
|
15054
|
+
aspectAttributes?: string;
|
|
15055
|
+
parameters?: string;
|
|
15056
|
+
siteId: string;
|
|
15057
|
+
locale?: string;
|
|
15058
|
+
}, ConfigParameters>;
|
|
15059
|
+
headers?: {
|
|
15060
|
+
[key: string]: string;
|
|
15061
|
+
};
|
|
15062
|
+
}>): Promise<Page>;
|
|
15063
|
+
/**
|
|
15064
|
+
* Get a Page Designer page based on a single page ID. The results will apply the visibility rules for the page's components, such as personalization or scheduled visibility.
|
|
15065
|
+
|
|
15066
|
+
**Important**: Because this resource uses the GET method, you must not pass sensitive data (payment card information, for example) and must not perform any transactional processes within the server-side scripts that are run for the page and components.
|
|
15067
|
+
*
|
|
15068
|
+
* @param options - An object containing the options for this method.
|
|
15069
|
+
* @param parameters - An object containing the parameters for this method.
|
|
15070
|
+
* @param organizationId -
|
|
15071
|
+
* @param pageId - Identifier for the requested page.
|
|
15072
|
+
* @param aspectAttributes - A JSON respresentation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
|
|
15073
|
+
* @param parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
|
|
15074
|
+
* @param siteId -
|
|
15075
|
+
* @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.
|
|
15076
|
+
Below are some valid examples:
|
|
15077
|
+
- en-US
|
|
15078
|
+
- de-AT
|
|
15079
|
+
- de
|
|
15080
|
+
- default
|
|
15081
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
15082
|
+
* sent with this request.
|
|
15083
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
15084
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type Page otherwise.
|
|
15085
|
+
*
|
|
15086
|
+
*/
|
|
15087
|
+
getPage<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
|
|
15088
|
+
parameters?: CompositeParameters<{
|
|
15089
|
+
organizationId: string;
|
|
15090
|
+
pageId: string;
|
|
15091
|
+
aspectAttributes?: string;
|
|
15092
|
+
parameters?: string;
|
|
15093
|
+
siteId: string;
|
|
15094
|
+
locale?: string;
|
|
15095
|
+
}, ConfigParameters>;
|
|
15096
|
+
headers?: {
|
|
15097
|
+
[key: string]: string;
|
|
15098
|
+
};
|
|
15099
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : Page>;
|
|
15100
|
+
}
|
|
15101
|
+
}
|
|
15102
|
+
type GiftCertificate = {
|
|
15103
|
+
amount: number;
|
|
15104
|
+
balance: number;
|
|
15105
|
+
description?: string;
|
|
15106
|
+
enabled: boolean;
|
|
15107
|
+
maskedGiftCertificateCode: string;
|
|
15108
|
+
merchantId: string;
|
|
15109
|
+
message?: string;
|
|
15110
|
+
recipientEmail: string;
|
|
15111
|
+
recipientName: string;
|
|
15112
|
+
senderName: string;
|
|
15113
|
+
status: string;
|
|
15114
|
+
} & {
|
|
15115
|
+
[key: string]: any;
|
|
15116
|
+
};
|
|
15117
|
+
type GiftCertificateRequest = {
|
|
15118
|
+
giftCertificateCode: string;
|
|
15119
|
+
} & {
|
|
15120
|
+
[key: string]: any;
|
|
15121
|
+
};
|
|
15122
|
+
type RangeFilter$4 = {
|
|
15123
|
+
[key: string]: any;
|
|
15124
|
+
};
|
|
15125
|
+
type BoolFilter$4 = {
|
|
15126
|
+
filters?: Array<any>;
|
|
15127
|
+
operator: string;
|
|
15128
|
+
} & {
|
|
15129
|
+
[key: string]: any;
|
|
15130
|
+
};
|
|
15131
|
+
type MatchAllQuery$4 = {} & {
|
|
15132
|
+
[key: string]: any;
|
|
15133
|
+
};
|
|
15134
|
+
type FilteredQuery$4 = {
|
|
15135
|
+
filter: any;
|
|
15136
|
+
query: any;
|
|
15137
|
+
} & {
|
|
15138
|
+
[key: string]: any;
|
|
15139
|
+
};
|
|
15140
|
+
type QueryFilter$4 = {
|
|
15141
|
+
query: any;
|
|
15142
|
+
} & {
|
|
15143
|
+
[key: string]: any;
|
|
15144
|
+
};
|
|
15145
|
+
type Query$4 = {
|
|
15146
|
+
boolQuery?: BoolQuery$3;
|
|
15147
|
+
filteredQuery?: FilteredQuery$4;
|
|
15148
|
+
matchAllQuery?: MatchAllQuery$4;
|
|
15149
|
+
nestedQuery?: NestedQuery$3;
|
|
15150
|
+
termQuery?: TermQuery$3;
|
|
15151
|
+
textQuery?: TextQuery$3;
|
|
15152
|
+
} & {
|
|
15153
|
+
[key: string]: any;
|
|
15154
|
+
};
|
|
15155
|
+
type TermQuery$4 = {
|
|
15156
|
+
fields: Array<string>;
|
|
15157
|
+
operator: string;
|
|
15158
|
+
values?: Array<any>;
|
|
15159
|
+
} & {
|
|
15160
|
+
[key: string]: any;
|
|
15161
|
+
};
|
|
15162
|
+
type TermFilter$4 = {
|
|
15163
|
+
field: string;
|
|
15164
|
+
operator: string;
|
|
15165
|
+
values?: Array<any>;
|
|
15166
|
+
} & {
|
|
15167
|
+
[key: string]: any;
|
|
15168
|
+
};
|
|
15169
|
+
type TextQuery$4 = {
|
|
15170
|
+
fields: Array<string>;
|
|
15171
|
+
searchPhrase: string;
|
|
15172
|
+
} & {
|
|
15173
|
+
[key: string]: any;
|
|
15174
|
+
};
|
|
15175
|
+
type Range2Filter$4 = {
|
|
15176
|
+
filterMode?: string;
|
|
15177
|
+
fromField: string;
|
|
15178
|
+
fromInclusive?: boolean;
|
|
15179
|
+
fromValue?: any;
|
|
15180
|
+
toField: string;
|
|
15181
|
+
toInclusive?: boolean;
|
|
15182
|
+
toValue?: any;
|
|
15183
|
+
} & {
|
|
15184
|
+
[key: string]: any;
|
|
15185
|
+
};
|
|
15186
|
+
type BoolQuery$4 = {
|
|
15187
|
+
must?: Array<any>;
|
|
15188
|
+
mustNot?: Array<any>;
|
|
15189
|
+
should?: Array<any>;
|
|
15190
|
+
} & {
|
|
15191
|
+
[key: string]: any;
|
|
15192
|
+
};
|
|
15193
|
+
type NestedQuery$4 = {
|
|
15194
|
+
path: string;
|
|
15195
|
+
query: any;
|
|
15196
|
+
scoreMode?: string;
|
|
15197
|
+
} & {
|
|
15198
|
+
[key: string]: any;
|
|
15199
|
+
};
|
|
15200
|
+
type Filter$4 = {
|
|
15201
|
+
boolFilter?: BoolFilter$4;
|
|
15202
|
+
queryFilter?: QueryFilter$4;
|
|
15203
|
+
range2Filter?: Range2Filter$4;
|
|
15204
|
+
rangeFilter?: RangeFilter$4;
|
|
15205
|
+
termFilter?: TermFilter$4;
|
|
15206
|
+
} & {
|
|
15207
|
+
[key: string]: any;
|
|
15208
|
+
};
|
|
15209
|
+
type Sort$4 = {
|
|
15210
|
+
field: string;
|
|
15211
|
+
sortOrder?: string;
|
|
15212
|
+
} & {
|
|
15213
|
+
[key: string]: any;
|
|
15214
|
+
};
|
|
15215
|
+
type L10nString$3 = {} & {
|
|
15216
|
+
[key: string]: any;
|
|
15217
|
+
};
|
|
15218
|
+
type PropertyValueDefinition$3 = {
|
|
15219
|
+
description: L10nString$3;
|
|
15220
|
+
displayValue: L10nString$3;
|
|
15221
|
+
id: string;
|
|
15222
|
+
position?: number;
|
|
15223
|
+
value: string;
|
|
15224
|
+
};
|
|
15225
|
+
/**
|
|
15226
|
+
* All path parameters that are used by at least one ShopperGiftCertificates method.
|
|
15227
|
+
*/
|
|
15228
|
+
type ShopperGiftCertificatesPathParameters = {
|
|
15229
|
+
organizationId?: string;
|
|
15230
|
+
};
|
|
15231
|
+
/**
|
|
15232
|
+
* All query parameters that are used by at least one ShopperGiftCertificates method.
|
|
15233
|
+
*/
|
|
15234
|
+
type ShopperGiftCertificatesQueryParameters = {
|
|
15235
|
+
siteId?: string;
|
|
15236
|
+
};
|
|
15237
|
+
/**
|
|
15238
|
+
* All parameters that are used by ShopperGiftCertificates.
|
|
15239
|
+
*/
|
|
15240
|
+
type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters & BaseUriParameters & ShopperGiftCertificatesQueryParameters;
|
|
15241
|
+
/**
|
|
15242
|
+
* [Shopper Gift Certificates](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-gift-certificates:Summary)
|
|
15243
|
+
* ==================================
|
|
15244
|
+
*
|
|
15245
|
+
* *Obtain details about a gift certificate.*<br />
|
|
15246
|
+
*
|
|
15247
|
+
* Simple example:
|
|
15248
|
+
*
|
|
15249
|
+
* ```typescript
|
|
15250
|
+
* import { ShopperGiftCertificates } from "commerce-sdk-isomorphic";
|
|
15251
|
+
*
|
|
15252
|
+
* const clientConfig = {
|
|
15253
|
+
* parameters: {
|
|
15254
|
+
* clientId: "XXXXXX",
|
|
15255
|
+
* organizationId: "XXXX",
|
|
15256
|
+
* shortCode: "XXX",
|
|
15257
|
+
* siteId: "XX"
|
|
15258
|
+
* }
|
|
15259
|
+
* };
|
|
15260
|
+
* const shopperGiftCertificatesClient = new ShopperGiftCertificates(clientConfig);
|
|
15261
|
+
* ```
|
|
15262
|
+
*
|
|
15263
|
+
* <span style="font-size:.7em; display:block; text-align: right">
|
|
15264
|
+
* API Version: 1.0.12<br />
|
|
15265
|
+
* Last Updated: <br />
|
|
15266
|
+
* </span>
|
|
15267
|
+
|
|
15268
|
+
*
|
|
15269
|
+
|
|
15270
|
+
*/
|
|
15271
|
+
declare class ShopperGiftCertificates<ConfigParameters extends ShopperGiftCertificatesParameters & Record<string, unknown>> {
|
|
15272
|
+
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
15273
|
+
clientConfig: ClientConfig<ConfigParameters> & {
|
|
15274
|
+
baseUri: string;
|
|
15275
|
+
};
|
|
15276
|
+
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-gift-certificates/{version}";
|
|
15277
|
+
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
15278
|
+
/**
|
|
15279
|
+
* Action to retrieve an existing gift certificate.
|
|
15280
|
+
*
|
|
15281
|
+
* If you would like to get a raw Response object use the other getGiftCertificate function.
|
|
15282
|
+
*
|
|
15283
|
+
* @param options - An object containing the options for this method.
|
|
15284
|
+
* @param parameters - An object containing the parameters for this method.
|
|
15285
|
+
* @param organizationId - An identifier for the organization the request is being made by.
|
|
15286
|
+
* @param siteId -
|
|
15287
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
15288
|
+
* sent with this request.
|
|
15289
|
+
* @param body - The data to send as the request body.
|
|
15290
|
+
*
|
|
15291
|
+
* @returns A promise of type GiftCertificate.
|
|
15292
|
+
*
|
|
15293
|
+
*/
|
|
15294
|
+
getGiftCertificate(options: RequireParametersUnlessAllAreOptional<{
|
|
15295
|
+
parameters?: CompositeParameters<{
|
|
15296
|
+
organizationId: string;
|
|
15297
|
+
siteId: string;
|
|
15298
|
+
}, ConfigParameters>;
|
|
15299
|
+
headers?: {
|
|
15300
|
+
[key: string]: string;
|
|
15301
|
+
};
|
|
15302
|
+
body: GiftCertificateRequest;
|
|
15303
|
+
}>): Promise<GiftCertificate>;
|
|
15304
|
+
/**
|
|
15305
|
+
* Action to retrieve an existing gift certificate.
|
|
15306
|
+
*
|
|
15307
|
+
* @param options - An object containing the options for this method.
|
|
15308
|
+
* @param parameters - An object containing the parameters for this method.
|
|
15309
|
+
* @param organizationId - An identifier for the organization the request is being made by.
|
|
15310
|
+
* @param siteId -
|
|
15311
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
15312
|
+
* sent with this request.
|
|
15313
|
+
* @param body - The data to send as the request body.
|
|
15314
|
+
* @param rawResponse - Set to true to return entire Response object instead of DTO.
|
|
15315
|
+
* @returns A promise of type Response if rawResponse is true, a promise of type GiftCertificate otherwise.
|
|
15316
|
+
*
|
|
15317
|
+
*/
|
|
15318
|
+
getGiftCertificate<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
|
|
15319
|
+
parameters?: CompositeParameters<{
|
|
15320
|
+
organizationId: string;
|
|
15321
|
+
siteId: string;
|
|
15322
|
+
}, ConfigParameters>;
|
|
15323
|
+
headers?: {
|
|
15324
|
+
[key: string]: string;
|
|
15325
|
+
};
|
|
15326
|
+
body: GiftCertificateRequest;
|
|
15327
|
+
}>, rawResponse?: T): Promise<T extends true ? Response : GiftCertificate>;
|
|
15328
|
+
}
|
|
15329
|
+
declare namespace ShopperGiftCertificatesTypes {
|
|
15330
|
+
/*
|
|
15331
|
+
* Copyright (c) 2021, salesforce.com, inc.
|
|
15332
|
+
* All rights reserved.
|
|
15333
|
+
* SPDX-License-Identifier: BSD-3-Clause
|
|
15334
|
+
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
|
|
15335
|
+
*/
|
|
15336
|
+
type CompositeParameters<MethodParameters extends Record<string, unknown>, ConfigParameters extends Record<string, unknown>> = Omit<MethodParameters, keyof ConfigParameters> & Partial<MethodParameters>;
|
|
15337
|
+
type RequireParametersUnlessAllAreOptional<T extends {
|
|
15338
|
+
parameters?: Record<string, unknown>;
|
|
15339
|
+
}> = Record<string, never> extends NonNullable<T["parameters"]> ? T : T & Required<Pick<T, "parameters">>;
|
|
15340
|
+
/**
|
|
15341
|
+
* Template parameters used in the base URI of all API endpoints. `version` will default to `"v1"`
|
|
15342
|
+
* if not specified.
|
|
15343
|
+
*/
|
|
15344
|
+
interface BaseUriParameters {
|
|
15345
|
+
shortCode: string;
|
|
15346
|
+
version?: string; // Optional, will default to "v1" if not provided.
|
|
15347
|
+
}
|
|
15348
|
+
/**
|
|
15349
|
+
* Generic interface for path parameters.
|
|
15350
|
+
*/
|
|
15351
|
+
interface PathParameters {
|
|
15352
|
+
[key: string]: string | number | boolean;
|
|
15353
|
+
}
|
|
15354
|
+
/**
|
|
15355
|
+
* Generic interface for query parameters.
|
|
15356
|
+
*/
|
|
15357
|
+
interface QueryParameters {
|
|
15358
|
+
[key: string]: string | number | boolean | string[] | number[];
|
|
15359
|
+
}
|
|
15360
|
+
/**
|
|
15361
|
+
* Generic interface for all parameter types.
|
|
15362
|
+
*/
|
|
15363
|
+
type UrlParameters = PathParameters | QueryParameters;
|
|
15364
|
+
/**
|
|
15365
|
+
* Alias for `RequestInit` from TypeScript's DOM lib, to more clearly differentiate
|
|
15366
|
+
* it from the `RequestInit` provided by node-fetch.
|
|
15367
|
+
*/
|
|
15368
|
+
type BrowserRequestInit = RequestInit;
|
|
15369
|
+
/**
|
|
15370
|
+
* Any properties supported in either the browser or node are accepted.
|
|
15371
|
+
* Using the right properties in the right context is left to the user.
|
|
15372
|
+
*/
|
|
15373
|
+
type FetchOptions = NodeRequestInit & BrowserRequestInit;
|
|
15374
|
+
/**
|
|
15375
|
+
* Base options that can be passed to the `ClientConfig` class.
|
|
15376
|
+
*/
|
|
15377
|
+
interface ClientConfigInit<Params extends BaseUriParameters> {
|
|
15378
|
+
baseUri?: string;
|
|
15379
|
+
proxy?: string;
|
|
15380
|
+
headers?: {
|
|
15381
|
+
[key: string]: string;
|
|
15382
|
+
};
|
|
15383
|
+
parameters: Params;
|
|
15384
|
+
fetchOptions?: FetchOptions;
|
|
15385
|
+
transformRequest?: (data: unknown, headers: {
|
|
15386
|
+
[key: string]: string;
|
|
15387
|
+
}) => Required<FetchOptions>["body"];
|
|
15388
|
+
throwOnBadResponse?: boolean;
|
|
15389
|
+
}
|
|
15390
|
+
/**
|
|
15391
|
+
* Configuration parameters common to Commerce SDK clients
|
|
15392
|
+
*/
|
|
15393
|
+
class ClientConfig<Params extends BaseUriParameters> implements ClientConfigInit<Params> {
|
|
15394
|
+
baseUri?: string;
|
|
15395
|
+
proxy?: string;
|
|
15396
|
+
headers: {
|
|
15397
|
+
[key: string]: string;
|
|
15398
|
+
};
|
|
15399
|
+
parameters: Params;
|
|
15400
|
+
fetchOptions: FetchOptions;
|
|
15401
|
+
transformRequest: NonNullable<ClientConfigInit<Params>["transformRequest"]>;
|
|
15402
|
+
throwOnBadResponse: boolean;
|
|
15403
|
+
constructor(config: ClientConfigInit<Params>);
|
|
15404
|
+
static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
|
|
15405
|
+
}
|
|
15406
|
+
type GiftCertificate = {
|
|
15407
|
+
amount: number;
|
|
15408
|
+
balance: number;
|
|
15409
|
+
description?: string;
|
|
15410
|
+
enabled: boolean;
|
|
15411
|
+
maskedGiftCertificateCode: string;
|
|
15412
|
+
merchantId: string;
|
|
15413
|
+
message?: string;
|
|
15414
|
+
recipientEmail: string;
|
|
15415
|
+
recipientName: string;
|
|
15416
|
+
senderName: string;
|
|
15417
|
+
status: string;
|
|
15418
|
+
} & {
|
|
15419
|
+
[key: string]: any;
|
|
15420
|
+
};
|
|
15421
|
+
type GiftCertificateRequest = {
|
|
15422
|
+
giftCertificateCode: string;
|
|
15423
|
+
} & {
|
|
15424
|
+
[key: string]: any;
|
|
15425
|
+
};
|
|
15426
|
+
type ErrorResponse = {
|
|
15427
|
+
type: string;
|
|
15428
|
+
title?: string;
|
|
15429
|
+
detail?: string;
|
|
15430
|
+
instance?: string;
|
|
15431
|
+
} & {
|
|
15432
|
+
[key: string]: any;
|
|
15433
|
+
};
|
|
15434
|
+
type ChangeControlled = {
|
|
15435
|
+
creationDate?: any;
|
|
15436
|
+
modificationDate?: any;
|
|
15437
|
+
createdBy?: string;
|
|
15438
|
+
lastModifiedBy?: string;
|
|
15439
|
+
} & {
|
|
15440
|
+
[key: string]: any;
|
|
15441
|
+
};
|
|
15442
|
+
type RangeFilter = {
|
|
15443
|
+
[key: string]: any;
|
|
15444
|
+
};
|
|
15445
|
+
type ChangeControlledDataType = {
|
|
15446
|
+
creationDate?: any;
|
|
15447
|
+
modificationDate?: any;
|
|
15448
|
+
createdBy?: string;
|
|
15449
|
+
lastModifiedBy?: string;
|
|
15450
|
+
} & {
|
|
15451
|
+
[key: string]: any;
|
|
15452
|
+
};
|
|
15453
|
+
type Error = {
|
|
15454
|
+
type: string;
|
|
15455
|
+
title?: string;
|
|
15456
|
+
detail?: string;
|
|
15457
|
+
instance?: string;
|
|
15458
|
+
} & {
|
|
15459
|
+
[key: string]: any;
|
|
15460
|
+
};
|
|
15461
|
+
type Money = {
|
|
15462
|
+
currencyMnemonic?: string;
|
|
15463
|
+
value?: number;
|
|
15464
|
+
} & {
|
|
15465
|
+
[key: string]: any;
|
|
15466
|
+
};
|
|
15467
|
+
type SimpleSearchResult = {
|
|
15468
|
+
limit: number;
|
|
15469
|
+
hits?: Array<object>;
|
|
15470
|
+
offset: any;
|
|
15471
|
+
total: any;
|
|
15472
|
+
} & {
|
|
15473
|
+
[key: string]: any;
|
|
15474
|
+
};
|
|
15475
|
+
type SearchRequest = {
|
|
15476
|
+
limit?: number;
|
|
15477
|
+
query: any;
|
|
15478
|
+
sorts?: Array<Sort$4>;
|
|
15479
|
+
offset?: any;
|
|
15480
|
+
} & {
|
|
15481
|
+
[key: string]: any;
|
|
15482
|
+
};
|
|
15483
|
+
type PropertyDefinition = {
|
|
15484
|
+
defaultValue?: PropertyValueDefinition$3;
|
|
15485
|
+
id?: string;
|
|
15486
|
+
name: L10nString$3;
|
|
15487
|
+
description: L10nString$3;
|
|
15488
|
+
key?: boolean;
|
|
15489
|
+
localizable?: boolean;
|
|
15490
|
+
mandatory?: boolean;
|
|
15491
|
+
max?: number;
|
|
15492
|
+
minLength?: number;
|
|
15493
|
+
min?: number;
|
|
15494
|
+
multiValueType?: boolean;
|
|
15495
|
+
regularExpression?: string;
|
|
15496
|
+
scale?: number;
|
|
15497
|
+
searchable?: boolean;
|
|
15498
|
+
siteSpecific?: boolean;
|
|
15499
|
+
system?: boolean;
|
|
15500
|
+
unit?: L10nString$3;
|
|
15501
|
+
possibleValues?: Array<PropertyValueDefinition$3>;
|
|
15502
|
+
type: string;
|
|
15503
|
+
visible?: boolean;
|
|
15504
|
+
} & {
|
|
15505
|
+
[key: string]: any;
|
|
15506
|
+
};
|
|
15507
|
+
type LocalizedString = {} & {
|
|
15508
|
+
[key: string]: any;
|
|
15509
|
+
};
|
|
15510
|
+
type PaginatedSearchResult = {
|
|
15511
|
+
query: any;
|
|
15512
|
+
sorts?: Array<Sort$4>;
|
|
15513
|
+
limit: number;
|
|
15514
|
+
hits?: Array<object>;
|
|
15515
|
+
offset: any;
|
|
15516
|
+
total: any;
|
|
15517
|
+
} & {
|
|
15518
|
+
[key: string]: any;
|
|
15519
|
+
};
|
|
15520
|
+
type ClosedObject = {} & {
|
|
15521
|
+
[key: string]: any;
|
|
15522
|
+
};
|
|
15523
|
+
type OpenObject = {} & {
|
|
15524
|
+
[key: string]: any;
|
|
15525
|
+
};
|
|
15526
|
+
type NoPropertiesAllowed = {};
|
|
15527
|
+
type SpecifiedPropertiesAllowed = {} & {
|
|
15528
|
+
[key: string]: any;
|
|
15529
|
+
};
|
|
15530
|
+
type BoolFilter = {
|
|
15531
|
+
filters?: Array<any>;
|
|
15532
|
+
operator: string;
|
|
15533
|
+
} & {
|
|
15534
|
+
[key: string]: any;
|
|
15535
|
+
};
|
|
15536
|
+
type PaginatedSearchResultBase = {
|
|
15537
|
+
query: any;
|
|
15538
|
+
sorts?: Array<Sort$4>;
|
|
15539
|
+
limit: number;
|
|
15540
|
+
hits?: Array<object>;
|
|
15541
|
+
offset: any;
|
|
15542
|
+
total: any;
|
|
15543
|
+
} & {
|
|
15544
|
+
[key: string]: any;
|
|
15545
|
+
};
|
|
15546
|
+
type MatchAllQuery = {} & {
|
|
15547
|
+
[key: string]: any;
|
|
15548
|
+
};
|
|
15549
|
+
type FilteredQuery = {
|
|
15550
|
+
filter: any;
|
|
15551
|
+
query: any;
|
|
15552
|
+
} & {
|
|
15553
|
+
[key: string]: any;
|
|
15554
|
+
};
|
|
15555
|
+
type QueryFilter = {
|
|
15556
|
+
query: any;
|
|
15557
|
+
} & {
|
|
15558
|
+
[key: string]: any;
|
|
15559
|
+
};
|
|
15560
|
+
type Query = {
|
|
15561
|
+
boolQuery?: BoolQuery$4;
|
|
15562
|
+
filteredQuery?: FilteredQuery;
|
|
15563
|
+
matchAllQuery?: MatchAllQuery;
|
|
15564
|
+
nestedQuery?: NestedQuery$4;
|
|
15565
|
+
termQuery?: TermQuery$4;
|
|
15566
|
+
textQuery?: TextQuery$4;
|
|
15567
|
+
} & {
|
|
15568
|
+
[key: string]: any;
|
|
15569
|
+
};
|
|
15570
|
+
type TermQuery = {
|
|
15571
|
+
fields: Array<string>;
|
|
15572
|
+
operator: string;
|
|
15573
|
+
values?: Array<any>;
|
|
15574
|
+
} & {
|
|
15575
|
+
[key: string]: any;
|
|
15576
|
+
};
|
|
15577
|
+
type TermFilter = {
|
|
15578
|
+
field: string;
|
|
15579
|
+
operator: string;
|
|
15580
|
+
values?: Array<any>;
|
|
15581
|
+
} & {
|
|
15582
|
+
[key: string]: any;
|
|
15583
|
+
};
|
|
15584
|
+
type TextQuery = {
|
|
15585
|
+
fields: Array<string>;
|
|
15586
|
+
searchPhrase: string;
|
|
15587
|
+
} & {
|
|
15588
|
+
[key: string]: any;
|
|
15589
|
+
};
|
|
15590
|
+
type Range2Filter = {
|
|
15591
|
+
filterMode?: string;
|
|
15592
|
+
fromField: string;
|
|
15593
|
+
fromInclusive?: boolean;
|
|
15594
|
+
fromValue?: any;
|
|
15595
|
+
toField: string;
|
|
15596
|
+
toInclusive?: boolean;
|
|
15597
|
+
toValue?: any;
|
|
15598
|
+
} & {
|
|
15599
|
+
[key: string]: any;
|
|
15600
|
+
};
|
|
15601
|
+
type BoolQuery = {
|
|
15602
|
+
must?: Array<any>;
|
|
15603
|
+
mustNot?: Array<any>;
|
|
15604
|
+
should?: Array<any>;
|
|
15605
|
+
} & {
|
|
15606
|
+
[key: string]: any;
|
|
15607
|
+
};
|
|
15608
|
+
type SimpleSearchResultBase = {
|
|
15609
|
+
limit: number;
|
|
15610
|
+
hits?: Array<object>;
|
|
15611
|
+
offset: any;
|
|
15612
|
+
total: any;
|
|
15613
|
+
} & {
|
|
15614
|
+
[key: string]: any;
|
|
15615
|
+
};
|
|
15616
|
+
type NestedQuery = {
|
|
15617
|
+
path: string;
|
|
15618
|
+
query: any;
|
|
15619
|
+
scoreMode?: string;
|
|
15620
|
+
} & {
|
|
15621
|
+
[key: string]: any;
|
|
15622
|
+
};
|
|
15623
|
+
type Filter = {
|
|
15624
|
+
boolFilter?: BoolFilter;
|
|
15625
|
+
queryFilter?: QueryFilter;
|
|
15626
|
+
range2Filter?: Range2Filter;
|
|
15627
|
+
rangeFilter?: RangeFilter;
|
|
15628
|
+
termFilter?: TermFilter;
|
|
15629
|
+
} & {
|
|
15630
|
+
[key: string]: any;
|
|
15631
|
+
};
|
|
15632
|
+
type Sort = {
|
|
15633
|
+
field: string;
|
|
15634
|
+
sortOrder?: string;
|
|
15635
|
+
} & {
|
|
15636
|
+
[key: string]: any;
|
|
15637
|
+
};
|
|
15638
|
+
type SearchRequestBase = {
|
|
15639
|
+
limit?: number;
|
|
15640
|
+
query: any;
|
|
15641
|
+
sorts?: Array<Sort>;
|
|
15642
|
+
offset?: any;
|
|
15643
|
+
} & {
|
|
15644
|
+
[key: string]: any;
|
|
15645
|
+
};
|
|
15646
|
+
type MoneyMnemonic = {
|
|
15647
|
+
currencyMnemonic?: string;
|
|
15648
|
+
value?: number;
|
|
15649
|
+
} & {
|
|
15650
|
+
[key: string]: any;
|
|
15651
|
+
};
|
|
15652
|
+
type L10nString = {} & {
|
|
15653
|
+
[key: string]: any;
|
|
15654
|
+
};
|
|
15655
|
+
type AttributeDefinition = {
|
|
15656
|
+
defaultValue?: PropertyValueDefinition$3;
|
|
15657
|
+
id?: string;
|
|
15658
|
+
name: L10nString;
|
|
15659
|
+
description: L10nString;
|
|
15660
|
+
key?: boolean;
|
|
15661
|
+
localizable?: boolean;
|
|
15662
|
+
mandatory?: boolean;
|
|
15663
|
+
max?: number;
|
|
15664
|
+
minLength?: number;
|
|
15665
|
+
min?: number;
|
|
15666
|
+
multiValueType?: boolean;
|
|
15667
|
+
regularExpression?: string;
|
|
15668
|
+
scale?: number;
|
|
15669
|
+
searchable?: boolean;
|
|
15670
|
+
siteSpecific?: boolean;
|
|
15671
|
+
system?: boolean;
|
|
15672
|
+
unit?: L10nString;
|
|
15673
|
+
possibleValues?: Array<PropertyValueDefinition$3>;
|
|
15674
|
+
type: string;
|
|
15675
|
+
visible?: boolean;
|
|
15676
|
+
};
|
|
15677
|
+
type PropertyValueDefinition = {
|
|
15678
|
+
description: L10nString;
|
|
15679
|
+
displayValue: L10nString;
|
|
15680
|
+
id: string;
|
|
15681
|
+
position?: number;
|
|
15682
|
+
value: string;
|
|
15683
|
+
};
|
|
15684
|
+
/**
|
|
15685
|
+
* All path parameters that are used by at least one ShopperGiftCertificates method.
|
|
15686
|
+
*/
|
|
15687
|
+
type ShopperGiftCertificatesPathParameters = {
|
|
15688
|
+
organizationId?: string;
|
|
15689
|
+
};
|
|
15690
|
+
/**
|
|
15691
|
+
* All query parameters that are used by at least one ShopperGiftCertificates method.
|
|
15692
|
+
*/
|
|
15693
|
+
type ShopperGiftCertificatesQueryParameters = {
|
|
15694
|
+
siteId?: string;
|
|
15695
|
+
};
|
|
15696
|
+
/**
|
|
15697
|
+
* All parameters that are used by ShopperGiftCertificates.
|
|
15698
|
+
*/
|
|
15699
|
+
type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters & BaseUriParameters & ShopperGiftCertificatesQueryParameters;
|
|
15700
|
+
/**
|
|
15701
|
+
* [Shopper Gift Certificates](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-gift-certificates:Summary)
|
|
15702
|
+
* ==================================
|
|
15703
|
+
*
|
|
15704
|
+
* *Obtain details about a gift certificate.*<br />
|
|
15705
|
+
*
|
|
15706
|
+
* Simple example:
|
|
15707
|
+
*
|
|
15708
|
+
* ```typescript
|
|
15709
|
+
* import { ShopperGiftCertificates } from "commerce-sdk-isomorphic";
|
|
15710
|
+
*
|
|
15711
|
+
* const clientConfig = {
|
|
15712
|
+
* parameters: {
|
|
15713
|
+
* clientId: "XXXXXX",
|
|
15714
|
+
* organizationId: "XXXX",
|
|
15715
|
+
* shortCode: "XXX",
|
|
15716
|
+
* siteId: "XX"
|
|
15717
|
+
* }
|
|
15718
|
+
* };
|
|
15719
|
+
* const shopperGiftCertificatesClient = new ShopperGiftCertificates(clientConfig);
|
|
15720
|
+
* ```
|
|
15721
|
+
*
|
|
15722
|
+
* <span style="font-size:.7em; display:block; text-align: right">
|
|
15723
|
+
* API Version: 1.0.12<br />
|
|
15724
|
+
* Last Updated: <br />
|
|
15725
|
+
* </span>
|
|
15726
|
+
|
|
15727
|
+
*
|
|
15728
|
+
|
|
15729
|
+
*/
|
|
15730
|
+
class ShopperGiftCertificates<ConfigParameters extends ShopperGiftCertificatesParameters & Record<string, unknown>> {
|
|
15731
|
+
// baseUri is not required on ClientConfig, but we know that we provide one in the class constructor
|
|
15732
|
+
clientConfig: ClientConfig<ConfigParameters> & {
|
|
15733
|
+
baseUri: string;
|
|
15734
|
+
};
|
|
15735
|
+
static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/pricing/shopper-gift-certificates/{version}";
|
|
15736
|
+
constructor(config: ClientConfigInit<ConfigParameters>);
|
|
15737
|
+
/**
|
|
15738
|
+
* Action to retrieve an existing gift certificate.
|
|
15739
|
+
*
|
|
15740
|
+
* If you would like to get a raw Response object use the other getGiftCertificate function.
|
|
15741
|
+
*
|
|
15742
|
+
* @param options - An object containing the options for this method.
|
|
15743
|
+
* @param parameters - An object containing the parameters for this method.
|
|
15744
|
+
* @param organizationId - An identifier for the organization the request is being made by.
|
|
15745
|
+
* @param siteId -
|
|
15746
|
+
* @param headers - An object literal of key value pairs of the headers to be
|
|
15747
|
+
* sent with this request.
|
|
15748
|
+
* @param body - The data to send as the request body.
|
|
14733
15749
|
*
|
|
14734
15750
|
* @returns A promise of type GiftCertificate.
|
|
14735
15751
|
*
|
|
@@ -14901,60 +15917,60 @@ type SessionBridgeTokenRequest = {
|
|
|
14901
15917
|
} & {
|
|
14902
15918
|
[key: string]: any;
|
|
14903
15919
|
};
|
|
14904
|
-
type RangeFilter$
|
|
15920
|
+
type RangeFilter$5 = {
|
|
14905
15921
|
[key: string]: any;
|
|
14906
15922
|
};
|
|
14907
|
-
type BoolFilter$
|
|
14908
|
-
filters?: Array<Filter$
|
|
15923
|
+
type BoolFilter$5 = {
|
|
15924
|
+
filters?: Array<Filter$4>;
|
|
14909
15925
|
operator: string;
|
|
14910
15926
|
} & {
|
|
14911
15927
|
[key: string]: any;
|
|
14912
15928
|
};
|
|
14913
|
-
type MatchAllQuery$
|
|
15929
|
+
type MatchAllQuery$5 = {} & {
|
|
14914
15930
|
[key: string]: any;
|
|
14915
15931
|
};
|
|
14916
|
-
type FilteredQuery$
|
|
14917
|
-
filter: Filter$
|
|
14918
|
-
query: Query$
|
|
15932
|
+
type FilteredQuery$5 = {
|
|
15933
|
+
filter: Filter$4;
|
|
15934
|
+
query: Query$4;
|
|
14919
15935
|
} & {
|
|
14920
15936
|
[key: string]: any;
|
|
14921
15937
|
};
|
|
14922
|
-
type QueryFilter$
|
|
14923
|
-
query: Query$
|
|
15938
|
+
type QueryFilter$5 = {
|
|
15939
|
+
query: Query$4;
|
|
14924
15940
|
} & {
|
|
14925
15941
|
[key: string]: any;
|
|
14926
15942
|
};
|
|
14927
|
-
type Query$
|
|
14928
|
-
boolQuery?: BoolQuery$
|
|
14929
|
-
filteredQuery?: FilteredQuery$
|
|
14930
|
-
matchAllQuery?: MatchAllQuery$
|
|
14931
|
-
nestedQuery?: NestedQuery$
|
|
14932
|
-
termQuery?: TermQuery$
|
|
14933
|
-
textQuery?: TextQuery$
|
|
15943
|
+
type Query$5 = {
|
|
15944
|
+
boolQuery?: BoolQuery$4;
|
|
15945
|
+
filteredQuery?: FilteredQuery$5;
|
|
15946
|
+
matchAllQuery?: MatchAllQuery$5;
|
|
15947
|
+
nestedQuery?: NestedQuery$4;
|
|
15948
|
+
termQuery?: TermQuery$4;
|
|
15949
|
+
textQuery?: TextQuery$4;
|
|
14934
15950
|
} & {
|
|
14935
15951
|
[key: string]: any;
|
|
14936
15952
|
};
|
|
14937
|
-
type TermQuery$
|
|
15953
|
+
type TermQuery$5 = {
|
|
14938
15954
|
fields: Array<string>;
|
|
14939
15955
|
operator: string;
|
|
14940
15956
|
values?: Array<any>;
|
|
14941
15957
|
} & {
|
|
14942
15958
|
[key: string]: any;
|
|
14943
15959
|
};
|
|
14944
|
-
type TermFilter$
|
|
15960
|
+
type TermFilter$5 = {
|
|
14945
15961
|
field: string;
|
|
14946
15962
|
operator: string;
|
|
14947
15963
|
values?: Array<any>;
|
|
14948
15964
|
} & {
|
|
14949
15965
|
[key: string]: any;
|
|
14950
15966
|
};
|
|
14951
|
-
type TextQuery$
|
|
15967
|
+
type TextQuery$5 = {
|
|
14952
15968
|
fields: Array<string>;
|
|
14953
15969
|
searchPhrase: string;
|
|
14954
15970
|
} & {
|
|
14955
15971
|
[key: string]: any;
|
|
14956
15972
|
};
|
|
14957
|
-
type Range2Filter$
|
|
15973
|
+
type Range2Filter$5 = {
|
|
14958
15974
|
filterMode?: string;
|
|
14959
15975
|
fromField: string;
|
|
14960
15976
|
fromInclusive?: boolean;
|
|
@@ -14965,41 +15981,41 @@ type Range2Filter$4 = {
|
|
|
14965
15981
|
} & {
|
|
14966
15982
|
[key: string]: any;
|
|
14967
15983
|
};
|
|
14968
|
-
type BoolQuery$
|
|
14969
|
-
must?: Array<Query$
|
|
14970
|
-
mustNot?: Array<Query$
|
|
14971
|
-
should?: Array<Query$
|
|
15984
|
+
type BoolQuery$5 = {
|
|
15985
|
+
must?: Array<Query$5>;
|
|
15986
|
+
mustNot?: Array<Query$5>;
|
|
15987
|
+
should?: Array<Query$5>;
|
|
14972
15988
|
} & {
|
|
14973
15989
|
[key: string]: any;
|
|
14974
15990
|
};
|
|
14975
|
-
type NestedQuery$
|
|
15991
|
+
type NestedQuery$5 = {
|
|
14976
15992
|
path: string;
|
|
14977
|
-
query: Query$
|
|
15993
|
+
query: Query$5;
|
|
14978
15994
|
scoreMode?: string;
|
|
14979
15995
|
} & {
|
|
14980
15996
|
[key: string]: any;
|
|
14981
15997
|
};
|
|
14982
|
-
type Filter$
|
|
14983
|
-
boolFilter?: BoolFilter$
|
|
14984
|
-
queryFilter?: QueryFilter$
|
|
14985
|
-
range2Filter?: Range2Filter$
|
|
14986
|
-
rangeFilter?: RangeFilter$
|
|
14987
|
-
termFilter?: TermFilter$
|
|
15998
|
+
type Filter$5 = {
|
|
15999
|
+
boolFilter?: BoolFilter$5;
|
|
16000
|
+
queryFilter?: QueryFilter$5;
|
|
16001
|
+
range2Filter?: Range2Filter$5;
|
|
16002
|
+
rangeFilter?: RangeFilter$5;
|
|
16003
|
+
termFilter?: TermFilter$5;
|
|
14988
16004
|
} & {
|
|
14989
16005
|
[key: string]: any;
|
|
14990
16006
|
};
|
|
14991
|
-
type Sort$
|
|
16007
|
+
type Sort$5 = {
|
|
14992
16008
|
field: string;
|
|
14993
16009
|
sortOrder?: string;
|
|
14994
16010
|
} & {
|
|
14995
16011
|
[key: string]: any;
|
|
14996
16012
|
};
|
|
14997
|
-
type L10nString$
|
|
16013
|
+
type L10nString$4 = {} & {
|
|
14998
16014
|
[key: string]: any;
|
|
14999
16015
|
};
|
|
15000
|
-
type PropertyValueDefinition$
|
|
15001
|
-
description: L10nString$
|
|
15002
|
-
displayValue: L10nString$
|
|
16016
|
+
type PropertyValueDefinition$4 = {
|
|
16017
|
+
description: L10nString$4;
|
|
16018
|
+
displayValue: L10nString$4;
|
|
15003
16019
|
id: string;
|
|
15004
16020
|
position?: number;
|
|
15005
16021
|
value: string;
|
|
@@ -16295,17 +17311,17 @@ declare namespace ShopperLoginTypes {
|
|
|
16295
17311
|
};
|
|
16296
17312
|
type SearchRequest = {
|
|
16297
17313
|
limit?: number;
|
|
16298
|
-
query: Query$
|
|
16299
|
-
sorts?: Array<Sort$
|
|
17314
|
+
query: Query$5;
|
|
17315
|
+
sorts?: Array<Sort$5>;
|
|
16300
17316
|
offset?: any;
|
|
16301
17317
|
} & {
|
|
16302
17318
|
[key: string]: any;
|
|
16303
17319
|
};
|
|
16304
17320
|
type PropertyDefinition = {
|
|
16305
|
-
defaultValue?: PropertyValueDefinition$
|
|
17321
|
+
defaultValue?: PropertyValueDefinition$4;
|
|
16306
17322
|
id?: string;
|
|
16307
|
-
name: L10nString$
|
|
16308
|
-
description: L10nString$
|
|
17323
|
+
name: L10nString$4;
|
|
17324
|
+
description: L10nString$4;
|
|
16309
17325
|
key?: boolean;
|
|
16310
17326
|
localizable?: boolean;
|
|
16311
17327
|
mandatory?: boolean;
|
|
@@ -16318,8 +17334,8 @@ declare namespace ShopperLoginTypes {
|
|
|
16318
17334
|
searchable?: boolean;
|
|
16319
17335
|
siteSpecific?: boolean;
|
|
16320
17336
|
system?: boolean;
|
|
16321
|
-
unit?: L10nString$
|
|
16322
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
17337
|
+
unit?: L10nString$4;
|
|
17338
|
+
possibleValues?: Array<PropertyValueDefinition$4>;
|
|
16323
17339
|
type: string;
|
|
16324
17340
|
visible?: boolean;
|
|
16325
17341
|
} & {
|
|
@@ -16329,8 +17345,8 @@ declare namespace ShopperLoginTypes {
|
|
|
16329
17345
|
[key: string]: any;
|
|
16330
17346
|
};
|
|
16331
17347
|
type PaginatedSearchResult = {
|
|
16332
|
-
query: Query$
|
|
16333
|
-
sorts?: Array<Sort$
|
|
17348
|
+
query: Query$5;
|
|
17349
|
+
sorts?: Array<Sort$5>;
|
|
16334
17350
|
limit: number;
|
|
16335
17351
|
hits?: Array<object>;
|
|
16336
17352
|
offset: any;
|
|
@@ -16349,14 +17365,14 @@ declare namespace ShopperLoginTypes {
|
|
|
16349
17365
|
[key: string]: any;
|
|
16350
17366
|
};
|
|
16351
17367
|
type BoolFilter = {
|
|
16352
|
-
filters?: Array<Filter$
|
|
17368
|
+
filters?: Array<Filter$5>;
|
|
16353
17369
|
operator: string;
|
|
16354
17370
|
} & {
|
|
16355
17371
|
[key: string]: any;
|
|
16356
17372
|
};
|
|
16357
17373
|
type PaginatedSearchResultBase = {
|
|
16358
|
-
query: Query$
|
|
16359
|
-
sorts?: Array<Sort$
|
|
17374
|
+
query: Query$5;
|
|
17375
|
+
sorts?: Array<Sort$5>;
|
|
16360
17376
|
limit: number;
|
|
16361
17377
|
hits?: Array<object>;
|
|
16362
17378
|
offset: any;
|
|
@@ -16368,23 +17384,23 @@ declare namespace ShopperLoginTypes {
|
|
|
16368
17384
|
[key: string]: any;
|
|
16369
17385
|
};
|
|
16370
17386
|
type FilteredQuery = {
|
|
16371
|
-
filter: Filter$
|
|
16372
|
-
query: Query$
|
|
17387
|
+
filter: Filter$5;
|
|
17388
|
+
query: Query$5;
|
|
16373
17389
|
} & {
|
|
16374
17390
|
[key: string]: any;
|
|
16375
17391
|
};
|
|
16376
17392
|
type QueryFilter = {
|
|
16377
|
-
query: Query$
|
|
17393
|
+
query: Query$5;
|
|
16378
17394
|
} & {
|
|
16379
17395
|
[key: string]: any;
|
|
16380
17396
|
};
|
|
16381
17397
|
type Query = {
|
|
16382
|
-
boolQuery?: BoolQuery$
|
|
17398
|
+
boolQuery?: BoolQuery$5;
|
|
16383
17399
|
filteredQuery?: FilteredQuery;
|
|
16384
17400
|
matchAllQuery?: MatchAllQuery;
|
|
16385
|
-
nestedQuery?: NestedQuery$
|
|
16386
|
-
termQuery?: TermQuery$
|
|
16387
|
-
textQuery?: TextQuery$
|
|
17401
|
+
nestedQuery?: NestedQuery$5;
|
|
17402
|
+
termQuery?: TermQuery$5;
|
|
17403
|
+
textQuery?: TextQuery$5;
|
|
16388
17404
|
} & {
|
|
16389
17405
|
[key: string]: any;
|
|
16390
17406
|
};
|
|
@@ -16474,7 +17490,7 @@ declare namespace ShopperLoginTypes {
|
|
|
16474
17490
|
[key: string]: any;
|
|
16475
17491
|
};
|
|
16476
17492
|
type AttributeDefinition = {
|
|
16477
|
-
defaultValue?: PropertyValueDefinition$
|
|
17493
|
+
defaultValue?: PropertyValueDefinition$4;
|
|
16478
17494
|
id?: string;
|
|
16479
17495
|
name: L10nString;
|
|
16480
17496
|
description: L10nString;
|
|
@@ -16491,7 +17507,7 @@ declare namespace ShopperLoginTypes {
|
|
|
16491
17507
|
siteSpecific?: boolean;
|
|
16492
17508
|
system?: boolean;
|
|
16493
17509
|
unit?: L10nString;
|
|
16494
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
17510
|
+
possibleValues?: Array<PropertyValueDefinition$4>;
|
|
16495
17511
|
type: string;
|
|
16496
17512
|
visible?: boolean;
|
|
16497
17513
|
};
|
|
@@ -17517,57 +18533,57 @@ declare namespace ShopperLoginTypes {
|
|
|
17517
18533
|
}>, rawResponse?: T): Promise<T extends true ? Response : Object>;
|
|
17518
18534
|
}
|
|
17519
18535
|
}
|
|
17520
|
-
type BoolFilter$
|
|
17521
|
-
filters?: Array<Filter$
|
|
18536
|
+
type BoolFilter$6 = {
|
|
18537
|
+
filters?: Array<Filter$5>;
|
|
17522
18538
|
operator: string;
|
|
17523
18539
|
} & {
|
|
17524
18540
|
[key: string]: any;
|
|
17525
18541
|
};
|
|
17526
|
-
type MatchAllQuery$
|
|
18542
|
+
type MatchAllQuery$6 = {} & {
|
|
17527
18543
|
[key: string]: any;
|
|
17528
18544
|
};
|
|
17529
|
-
type FilteredQuery$
|
|
17530
|
-
filter: Filter$
|
|
17531
|
-
query: Query$
|
|
18545
|
+
type FilteredQuery$6 = {
|
|
18546
|
+
filter: Filter$5;
|
|
18547
|
+
query: Query$5;
|
|
17532
18548
|
} & {
|
|
17533
18549
|
[key: string]: any;
|
|
17534
18550
|
};
|
|
17535
|
-
type QueryFilter$
|
|
17536
|
-
query: Query$
|
|
18551
|
+
type QueryFilter$6 = {
|
|
18552
|
+
query: Query$5;
|
|
17537
18553
|
} & {
|
|
17538
18554
|
[key: string]: any;
|
|
17539
18555
|
};
|
|
17540
|
-
type Query$
|
|
17541
|
-
boolQuery?: BoolQuery$
|
|
17542
|
-
filteredQuery?: FilteredQuery$
|
|
17543
|
-
matchAllQuery?: MatchAllQuery$
|
|
17544
|
-
nestedQuery?: NestedQuery$
|
|
17545
|
-
termQuery?: TermQuery$
|
|
17546
|
-
textQuery?: TextQuery$
|
|
18556
|
+
type Query$6 = {
|
|
18557
|
+
boolQuery?: BoolQuery$5;
|
|
18558
|
+
filteredQuery?: FilteredQuery$6;
|
|
18559
|
+
matchAllQuery?: MatchAllQuery$6;
|
|
18560
|
+
nestedQuery?: NestedQuery$5;
|
|
18561
|
+
termQuery?: TermQuery$5;
|
|
18562
|
+
textQuery?: TextQuery$5;
|
|
17547
18563
|
} & {
|
|
17548
18564
|
[key: string]: any;
|
|
17549
18565
|
};
|
|
17550
|
-
type TermQuery$
|
|
18566
|
+
type TermQuery$6 = {
|
|
17551
18567
|
fields: Array<string>;
|
|
17552
18568
|
operator: string;
|
|
17553
18569
|
values?: Array<any>;
|
|
17554
18570
|
} & {
|
|
17555
18571
|
[key: string]: any;
|
|
17556
18572
|
};
|
|
17557
|
-
type TermFilter$
|
|
18573
|
+
type TermFilter$6 = {
|
|
17558
18574
|
field: string;
|
|
17559
18575
|
operator: string;
|
|
17560
18576
|
values?: Array<any>;
|
|
17561
18577
|
} & {
|
|
17562
18578
|
[key: string]: any;
|
|
17563
18579
|
};
|
|
17564
|
-
type TextQuery$
|
|
18580
|
+
type TextQuery$6 = {
|
|
17565
18581
|
fields: Array<string>;
|
|
17566
18582
|
searchPhrase: string;
|
|
17567
18583
|
} & {
|
|
17568
18584
|
[key: string]: any;
|
|
17569
18585
|
};
|
|
17570
|
-
type Range2Filter$
|
|
18586
|
+
type Range2Filter$6 = {
|
|
17571
18587
|
filterMode?: string;
|
|
17572
18588
|
fromField: string;
|
|
17573
18589
|
fromInclusive?: boolean;
|
|
@@ -17578,36 +18594,36 @@ type Range2Filter$5 = {
|
|
|
17578
18594
|
} & {
|
|
17579
18595
|
[key: string]: any;
|
|
17580
18596
|
};
|
|
17581
|
-
type BoolQuery$
|
|
17582
|
-
must?: Array<Query$
|
|
17583
|
-
mustNot?: Array<Query$
|
|
17584
|
-
should?: Array<Query$
|
|
18597
|
+
type BoolQuery$6 = {
|
|
18598
|
+
must?: Array<Query$6>;
|
|
18599
|
+
mustNot?: Array<Query$6>;
|
|
18600
|
+
should?: Array<Query$6>;
|
|
17585
18601
|
} & {
|
|
17586
18602
|
[key: string]: any;
|
|
17587
18603
|
};
|
|
17588
|
-
type NestedQuery$
|
|
18604
|
+
type NestedQuery$6 = {
|
|
17589
18605
|
path: string;
|
|
17590
|
-
query: Query$
|
|
18606
|
+
query: Query$6;
|
|
17591
18607
|
scoreMode?: string;
|
|
17592
18608
|
} & {
|
|
17593
18609
|
[key: string]: any;
|
|
17594
18610
|
};
|
|
17595
|
-
type Filter$
|
|
17596
|
-
boolFilter?: BoolFilter$
|
|
17597
|
-
queryFilter?: QueryFilter$
|
|
17598
|
-
range2Filter?: Range2Filter$
|
|
17599
|
-
rangeFilter?: RangeFilter$
|
|
17600
|
-
termFilter?: TermFilter$
|
|
18611
|
+
type Filter$6 = {
|
|
18612
|
+
boolFilter?: BoolFilter$6;
|
|
18613
|
+
queryFilter?: QueryFilter$6;
|
|
18614
|
+
range2Filter?: Range2Filter$6;
|
|
18615
|
+
rangeFilter?: RangeFilter$5;
|
|
18616
|
+
termFilter?: TermFilter$6;
|
|
17601
18617
|
} & {
|
|
17602
18618
|
[key: string]: any;
|
|
17603
18619
|
};
|
|
17604
|
-
type Sort$
|
|
18620
|
+
type Sort$6 = {
|
|
17605
18621
|
field: string;
|
|
17606
18622
|
sortOrder?: string;
|
|
17607
18623
|
} & {
|
|
17608
18624
|
[key: string]: any;
|
|
17609
18625
|
};
|
|
17610
|
-
type RangeFilter$
|
|
18626
|
+
type RangeFilter$6 = {
|
|
17611
18627
|
field: string;
|
|
17612
18628
|
from?: any;
|
|
17613
18629
|
fromInclusive?: boolean;
|
|
@@ -17616,12 +18632,12 @@ type RangeFilter$5 = {
|
|
|
17616
18632
|
} & {
|
|
17617
18633
|
[key: string]: any;
|
|
17618
18634
|
};
|
|
17619
|
-
type L10nString$
|
|
18635
|
+
type L10nString$5 = {} & {
|
|
17620
18636
|
[key: string]: any;
|
|
17621
18637
|
};
|
|
17622
|
-
type PropertyValueDefinition$
|
|
17623
|
-
description: L10nString$
|
|
17624
|
-
displayValue: L10nString$
|
|
18638
|
+
type PropertyValueDefinition$5 = {
|
|
18639
|
+
description: L10nString$5;
|
|
18640
|
+
displayValue: L10nString$5;
|
|
17625
18641
|
id: string;
|
|
17626
18642
|
position?: number;
|
|
17627
18643
|
value: string;
|
|
@@ -18651,17 +19667,17 @@ declare namespace ShopperOrdersTypes {
|
|
|
18651
19667
|
};
|
|
18652
19668
|
type SearchRequest = {
|
|
18653
19669
|
limit?: number;
|
|
18654
|
-
query: Query$
|
|
18655
|
-
sorts?: Array<Sort$
|
|
19670
|
+
query: Query$6;
|
|
19671
|
+
sorts?: Array<Sort$6>;
|
|
18656
19672
|
offset?: any;
|
|
18657
19673
|
} & {
|
|
18658
19674
|
[key: string]: any;
|
|
18659
19675
|
};
|
|
18660
19676
|
type PropertyDefinition = {
|
|
18661
|
-
defaultValue?: PropertyValueDefinition$
|
|
19677
|
+
defaultValue?: PropertyValueDefinition$5;
|
|
18662
19678
|
id?: string;
|
|
18663
|
-
name: L10nString$
|
|
18664
|
-
description: L10nString$
|
|
19679
|
+
name: L10nString$5;
|
|
19680
|
+
description: L10nString$5;
|
|
18665
19681
|
key?: boolean;
|
|
18666
19682
|
localizable?: boolean;
|
|
18667
19683
|
mandatory?: boolean;
|
|
@@ -18674,8 +19690,8 @@ declare namespace ShopperOrdersTypes {
|
|
|
18674
19690
|
searchable?: boolean;
|
|
18675
19691
|
siteSpecific?: boolean;
|
|
18676
19692
|
system?: boolean;
|
|
18677
|
-
unit?: L10nString$
|
|
18678
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
19693
|
+
unit?: L10nString$5;
|
|
19694
|
+
possibleValues?: Array<PropertyValueDefinition$5>;
|
|
18679
19695
|
type: string;
|
|
18680
19696
|
visible?: boolean;
|
|
18681
19697
|
} & {
|
|
@@ -18685,8 +19701,8 @@ declare namespace ShopperOrdersTypes {
|
|
|
18685
19701
|
[key: string]: any;
|
|
18686
19702
|
};
|
|
18687
19703
|
type PaginatedSearchResult = {
|
|
18688
|
-
query: Query$
|
|
18689
|
-
sorts?: Array<Sort$
|
|
19704
|
+
query: Query$6;
|
|
19705
|
+
sorts?: Array<Sort$6>;
|
|
18690
19706
|
limit: number;
|
|
18691
19707
|
hits?: Array<object>;
|
|
18692
19708
|
offset: any;
|
|
@@ -18705,14 +19721,14 @@ declare namespace ShopperOrdersTypes {
|
|
|
18705
19721
|
[key: string]: any;
|
|
18706
19722
|
};
|
|
18707
19723
|
type BoolFilter = {
|
|
18708
|
-
filters?: Array<Filter$
|
|
19724
|
+
filters?: Array<Filter$6>;
|
|
18709
19725
|
operator: string;
|
|
18710
19726
|
} & {
|
|
18711
19727
|
[key: string]: any;
|
|
18712
19728
|
};
|
|
18713
19729
|
type PaginatedSearchResultBase = {
|
|
18714
|
-
query: Query$
|
|
18715
|
-
sorts?: Array<Sort$
|
|
19730
|
+
query: Query$6;
|
|
19731
|
+
sorts?: Array<Sort$6>;
|
|
18716
19732
|
limit: number;
|
|
18717
19733
|
hits?: Array<object>;
|
|
18718
19734
|
offset: any;
|
|
@@ -18724,23 +19740,23 @@ declare namespace ShopperOrdersTypes {
|
|
|
18724
19740
|
[key: string]: any;
|
|
18725
19741
|
};
|
|
18726
19742
|
type FilteredQuery = {
|
|
18727
|
-
filter: Filter$
|
|
18728
|
-
query: Query$
|
|
19743
|
+
filter: Filter$6;
|
|
19744
|
+
query: Query$6;
|
|
18729
19745
|
} & {
|
|
18730
19746
|
[key: string]: any;
|
|
18731
19747
|
};
|
|
18732
19748
|
type QueryFilter = {
|
|
18733
|
-
query: Query$
|
|
19749
|
+
query: Query$6;
|
|
18734
19750
|
} & {
|
|
18735
19751
|
[key: string]: any;
|
|
18736
19752
|
};
|
|
18737
19753
|
type Query = {
|
|
18738
|
-
boolQuery?: BoolQuery$
|
|
19754
|
+
boolQuery?: BoolQuery$6;
|
|
18739
19755
|
filteredQuery?: FilteredQuery;
|
|
18740
19756
|
matchAllQuery?: MatchAllQuery;
|
|
18741
|
-
nestedQuery?: NestedQuery$
|
|
18742
|
-
termQuery?: TermQuery$
|
|
18743
|
-
textQuery?: TextQuery$
|
|
19757
|
+
nestedQuery?: NestedQuery$6;
|
|
19758
|
+
termQuery?: TermQuery$6;
|
|
19759
|
+
textQuery?: TextQuery$6;
|
|
18744
19760
|
} & {
|
|
18745
19761
|
[key: string]: any;
|
|
18746
19762
|
};
|
|
@@ -18801,7 +19817,7 @@ declare namespace ShopperOrdersTypes {
|
|
|
18801
19817
|
boolFilter?: BoolFilter;
|
|
18802
19818
|
queryFilter?: QueryFilter;
|
|
18803
19819
|
range2Filter?: Range2Filter;
|
|
18804
|
-
rangeFilter?: RangeFilter$
|
|
19820
|
+
rangeFilter?: RangeFilter$6;
|
|
18805
19821
|
termFilter?: TermFilter;
|
|
18806
19822
|
} & {
|
|
18807
19823
|
[key: string]: any;
|
|
@@ -18839,7 +19855,7 @@ declare namespace ShopperOrdersTypes {
|
|
|
18839
19855
|
[key: string]: any;
|
|
18840
19856
|
};
|
|
18841
19857
|
type AttributeDefinition = {
|
|
18842
|
-
defaultValue?: PropertyValueDefinition$
|
|
19858
|
+
defaultValue?: PropertyValueDefinition$5;
|
|
18843
19859
|
id?: string;
|
|
18844
19860
|
name: L10nString;
|
|
18845
19861
|
description: L10nString;
|
|
@@ -18856,7 +19872,7 @@ declare namespace ShopperOrdersTypes {
|
|
|
18856
19872
|
siteSpecific?: boolean;
|
|
18857
19873
|
system?: boolean;
|
|
18858
19874
|
unit?: L10nString;
|
|
18859
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
19875
|
+
possibleValues?: Array<PropertyValueDefinition$5>;
|
|
18860
19876
|
type: string;
|
|
18861
19877
|
visible?: boolean;
|
|
18862
19878
|
};
|
|
@@ -20097,60 +21113,60 @@ type BundledProduct$0 = {
|
|
|
20097
21113
|
} & {
|
|
20098
21114
|
[key: string]: any;
|
|
20099
21115
|
};
|
|
20100
|
-
type RangeFilter$
|
|
21116
|
+
type RangeFilter$7 = {
|
|
20101
21117
|
[key: string]: any;
|
|
20102
21118
|
};
|
|
20103
|
-
type BoolFilter$
|
|
20104
|
-
filters?: Array<Filter$
|
|
21119
|
+
type BoolFilter$7 = {
|
|
21120
|
+
filters?: Array<Filter$6>;
|
|
20105
21121
|
operator: string;
|
|
20106
21122
|
} & {
|
|
20107
21123
|
[key: string]: any;
|
|
20108
21124
|
};
|
|
20109
|
-
type MatchAllQuery$
|
|
21125
|
+
type MatchAllQuery$7 = {} & {
|
|
20110
21126
|
[key: string]: any;
|
|
20111
21127
|
};
|
|
20112
|
-
type FilteredQuery$
|
|
20113
|
-
filter: Filter$
|
|
20114
|
-
query: Query$
|
|
21128
|
+
type FilteredQuery$7 = {
|
|
21129
|
+
filter: Filter$6;
|
|
21130
|
+
query: Query$6;
|
|
20115
21131
|
} & {
|
|
20116
21132
|
[key: string]: any;
|
|
20117
21133
|
};
|
|
20118
|
-
type QueryFilter$
|
|
20119
|
-
query: Query$
|
|
21134
|
+
type QueryFilter$7 = {
|
|
21135
|
+
query: Query$6;
|
|
20120
21136
|
} & {
|
|
20121
21137
|
[key: string]: any;
|
|
20122
21138
|
};
|
|
20123
|
-
type Query$
|
|
20124
|
-
boolQuery?: BoolQuery$
|
|
20125
|
-
filteredQuery?: FilteredQuery$
|
|
20126
|
-
matchAllQuery?: MatchAllQuery$
|
|
20127
|
-
nestedQuery?: NestedQuery$
|
|
20128
|
-
termQuery?: TermQuery$
|
|
20129
|
-
textQuery?: TextQuery$
|
|
21139
|
+
type Query$7 = {
|
|
21140
|
+
boolQuery?: BoolQuery$6;
|
|
21141
|
+
filteredQuery?: FilteredQuery$7;
|
|
21142
|
+
matchAllQuery?: MatchAllQuery$7;
|
|
21143
|
+
nestedQuery?: NestedQuery$6;
|
|
21144
|
+
termQuery?: TermQuery$6;
|
|
21145
|
+
textQuery?: TextQuery$6;
|
|
20130
21146
|
} & {
|
|
20131
21147
|
[key: string]: any;
|
|
20132
21148
|
};
|
|
20133
|
-
type TermQuery$
|
|
21149
|
+
type TermQuery$7 = {
|
|
20134
21150
|
fields: Array<string>;
|
|
20135
21151
|
operator: string;
|
|
20136
21152
|
values?: Array<any>;
|
|
20137
21153
|
} & {
|
|
20138
21154
|
[key: string]: any;
|
|
20139
21155
|
};
|
|
20140
|
-
type TermFilter$
|
|
21156
|
+
type TermFilter$7 = {
|
|
20141
21157
|
field: string;
|
|
20142
21158
|
operator: string;
|
|
20143
21159
|
values?: Array<any>;
|
|
20144
21160
|
} & {
|
|
20145
21161
|
[key: string]: any;
|
|
20146
21162
|
};
|
|
20147
|
-
type TextQuery$
|
|
21163
|
+
type TextQuery$7 = {
|
|
20148
21164
|
fields: Array<string>;
|
|
20149
21165
|
searchPhrase: string;
|
|
20150
21166
|
} & {
|
|
20151
21167
|
[key: string]: any;
|
|
20152
21168
|
};
|
|
20153
|
-
type Range2Filter$
|
|
21169
|
+
type Range2Filter$7 = {
|
|
20154
21170
|
filterMode?: string;
|
|
20155
21171
|
fromField: string;
|
|
20156
21172
|
fromInclusive?: boolean;
|
|
@@ -20161,41 +21177,41 @@ type Range2Filter$6 = {
|
|
|
20161
21177
|
} & {
|
|
20162
21178
|
[key: string]: any;
|
|
20163
21179
|
};
|
|
20164
|
-
type BoolQuery$
|
|
20165
|
-
must?: Array<Query$
|
|
20166
|
-
mustNot?: Array<Query$
|
|
20167
|
-
should?: Array<Query$
|
|
21180
|
+
type BoolQuery$7 = {
|
|
21181
|
+
must?: Array<Query$7>;
|
|
21182
|
+
mustNot?: Array<Query$7>;
|
|
21183
|
+
should?: Array<Query$7>;
|
|
20168
21184
|
} & {
|
|
20169
21185
|
[key: string]: any;
|
|
20170
21186
|
};
|
|
20171
|
-
type NestedQuery$
|
|
21187
|
+
type NestedQuery$7 = {
|
|
20172
21188
|
path: string;
|
|
20173
|
-
query: Query$
|
|
21189
|
+
query: Query$7;
|
|
20174
21190
|
scoreMode?: string;
|
|
20175
21191
|
} & {
|
|
20176
21192
|
[key: string]: any;
|
|
20177
21193
|
};
|
|
20178
|
-
type Filter$
|
|
20179
|
-
boolFilter?: BoolFilter$
|
|
20180
|
-
queryFilter?: QueryFilter$
|
|
20181
|
-
range2Filter?: Range2Filter$
|
|
20182
|
-
rangeFilter?: RangeFilter$
|
|
20183
|
-
termFilter?: TermFilter$
|
|
21194
|
+
type Filter$7 = {
|
|
21195
|
+
boolFilter?: BoolFilter$7;
|
|
21196
|
+
queryFilter?: QueryFilter$7;
|
|
21197
|
+
range2Filter?: Range2Filter$7;
|
|
21198
|
+
rangeFilter?: RangeFilter$7;
|
|
21199
|
+
termFilter?: TermFilter$7;
|
|
20184
21200
|
} & {
|
|
20185
21201
|
[key: string]: any;
|
|
20186
21202
|
};
|
|
20187
|
-
type Sort$
|
|
21203
|
+
type Sort$7 = {
|
|
20188
21204
|
field: string;
|
|
20189
21205
|
sortOrder?: string;
|
|
20190
21206
|
} & {
|
|
20191
21207
|
[key: string]: any;
|
|
20192
21208
|
};
|
|
20193
|
-
type L10nString$
|
|
21209
|
+
type L10nString$6 = {} & {
|
|
20194
21210
|
[key: string]: any;
|
|
20195
21211
|
};
|
|
20196
|
-
type PropertyValueDefinition$
|
|
20197
|
-
description: L10nString$
|
|
20198
|
-
displayValue: L10nString$
|
|
21212
|
+
type PropertyValueDefinition$6 = {
|
|
21213
|
+
description: L10nString$6;
|
|
21214
|
+
displayValue: L10nString$6;
|
|
20199
21215
|
id: string;
|
|
20200
21216
|
position?: number;
|
|
20201
21217
|
value: string;
|
|
@@ -20902,17 +21918,17 @@ declare namespace ShopperProductsTypes {
|
|
|
20902
21918
|
};
|
|
20903
21919
|
type SearchRequest = {
|
|
20904
21920
|
limit?: number;
|
|
20905
|
-
query: Query$
|
|
20906
|
-
sorts?: Array<Sort$
|
|
21921
|
+
query: Query$7;
|
|
21922
|
+
sorts?: Array<Sort$7>;
|
|
20907
21923
|
offset?: any;
|
|
20908
21924
|
} & {
|
|
20909
21925
|
[key: string]: any;
|
|
20910
21926
|
};
|
|
20911
21927
|
type PropertyDefinition = {
|
|
20912
|
-
defaultValue?: PropertyValueDefinition$
|
|
21928
|
+
defaultValue?: PropertyValueDefinition$6;
|
|
20913
21929
|
id?: string;
|
|
20914
|
-
name: L10nString$
|
|
20915
|
-
description: L10nString$
|
|
21930
|
+
name: L10nString$6;
|
|
21931
|
+
description: L10nString$6;
|
|
20916
21932
|
key?: boolean;
|
|
20917
21933
|
localizable?: boolean;
|
|
20918
21934
|
mandatory?: boolean;
|
|
@@ -20925,8 +21941,8 @@ declare namespace ShopperProductsTypes {
|
|
|
20925
21941
|
searchable?: boolean;
|
|
20926
21942
|
siteSpecific?: boolean;
|
|
20927
21943
|
system?: boolean;
|
|
20928
|
-
unit?: L10nString$
|
|
20929
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
21944
|
+
unit?: L10nString$6;
|
|
21945
|
+
possibleValues?: Array<PropertyValueDefinition$6>;
|
|
20930
21946
|
type: string;
|
|
20931
21947
|
visible?: boolean;
|
|
20932
21948
|
} & {
|
|
@@ -20936,8 +21952,8 @@ declare namespace ShopperProductsTypes {
|
|
|
20936
21952
|
[key: string]: any;
|
|
20937
21953
|
};
|
|
20938
21954
|
type PaginatedSearchResult = {
|
|
20939
|
-
query: Query$
|
|
20940
|
-
sorts?: Array<Sort$
|
|
21955
|
+
query: Query$7;
|
|
21956
|
+
sorts?: Array<Sort$7>;
|
|
20941
21957
|
limit: number;
|
|
20942
21958
|
hits?: Array<object>;
|
|
20943
21959
|
offset: any;
|
|
@@ -20956,14 +21972,14 @@ declare namespace ShopperProductsTypes {
|
|
|
20956
21972
|
[key: string]: any;
|
|
20957
21973
|
};
|
|
20958
21974
|
type BoolFilter = {
|
|
20959
|
-
filters?: Array<Filter$
|
|
21975
|
+
filters?: Array<Filter$7>;
|
|
20960
21976
|
operator: string;
|
|
20961
21977
|
} & {
|
|
20962
21978
|
[key: string]: any;
|
|
20963
21979
|
};
|
|
20964
21980
|
type PaginatedSearchResultBase = {
|
|
20965
|
-
query: Query$
|
|
20966
|
-
sorts?: Array<Sort$
|
|
21981
|
+
query: Query$7;
|
|
21982
|
+
sorts?: Array<Sort$7>;
|
|
20967
21983
|
limit: number;
|
|
20968
21984
|
hits?: Array<object>;
|
|
20969
21985
|
offset: any;
|
|
@@ -20975,23 +21991,23 @@ declare namespace ShopperProductsTypes {
|
|
|
20975
21991
|
[key: string]: any;
|
|
20976
21992
|
};
|
|
20977
21993
|
type FilteredQuery = {
|
|
20978
|
-
filter: Filter$
|
|
20979
|
-
query: Query$
|
|
21994
|
+
filter: Filter$7;
|
|
21995
|
+
query: Query$7;
|
|
20980
21996
|
} & {
|
|
20981
21997
|
[key: string]: any;
|
|
20982
21998
|
};
|
|
20983
21999
|
type QueryFilter = {
|
|
20984
|
-
query: Query$
|
|
22000
|
+
query: Query$7;
|
|
20985
22001
|
} & {
|
|
20986
22002
|
[key: string]: any;
|
|
20987
22003
|
};
|
|
20988
22004
|
type Query = {
|
|
20989
|
-
boolQuery?: BoolQuery$
|
|
22005
|
+
boolQuery?: BoolQuery$7;
|
|
20990
22006
|
filteredQuery?: FilteredQuery;
|
|
20991
22007
|
matchAllQuery?: MatchAllQuery;
|
|
20992
|
-
nestedQuery?: NestedQuery$
|
|
20993
|
-
termQuery?: TermQuery$
|
|
20994
|
-
textQuery?: TextQuery$
|
|
22008
|
+
nestedQuery?: NestedQuery$7;
|
|
22009
|
+
termQuery?: TermQuery$7;
|
|
22010
|
+
textQuery?: TextQuery$7;
|
|
20995
22011
|
} & {
|
|
20996
22012
|
[key: string]: any;
|
|
20997
22013
|
};
|
|
@@ -21081,7 +22097,7 @@ declare namespace ShopperProductsTypes {
|
|
|
21081
22097
|
[key: string]: any;
|
|
21082
22098
|
};
|
|
21083
22099
|
type AttributeDefinition = {
|
|
21084
|
-
defaultValue?: PropertyValueDefinition$
|
|
22100
|
+
defaultValue?: PropertyValueDefinition$6;
|
|
21085
22101
|
id?: string;
|
|
21086
22102
|
name: L10nString;
|
|
21087
22103
|
description: L10nString;
|
|
@@ -21098,7 +22114,7 @@ declare namespace ShopperProductsTypes {
|
|
|
21098
22114
|
siteSpecific?: boolean;
|
|
21099
22115
|
system?: boolean;
|
|
21100
22116
|
unit?: L10nString;
|
|
21101
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
22117
|
+
possibleValues?: Array<PropertyValueDefinition$6>;
|
|
21102
22118
|
type: string;
|
|
21103
22119
|
visible?: boolean;
|
|
21104
22120
|
};
|
|
@@ -21460,45 +22476,45 @@ type PromotionResult = {
|
|
|
21460
22476
|
} & {
|
|
21461
22477
|
[key: string]: any;
|
|
21462
22478
|
};
|
|
21463
|
-
type TermQuery$
|
|
22479
|
+
type TermQuery$8 = {
|
|
21464
22480
|
fields: Array<string>;
|
|
21465
22481
|
operator: string;
|
|
21466
22482
|
values?: Array<any>;
|
|
21467
22483
|
} & {
|
|
21468
22484
|
[key: string]: any;
|
|
21469
22485
|
};
|
|
21470
|
-
type TextQuery$
|
|
22486
|
+
type TextQuery$8 = {
|
|
21471
22487
|
fields: Array<string>;
|
|
21472
22488
|
searchPhrase: string;
|
|
21473
22489
|
} & {
|
|
21474
22490
|
[key: string]: any;
|
|
21475
22491
|
};
|
|
21476
|
-
type BoolQuery$
|
|
22492
|
+
type BoolQuery$8 = {
|
|
21477
22493
|
must?: Array<any>;
|
|
21478
22494
|
mustNot?: Array<any>;
|
|
21479
22495
|
should?: Array<any>;
|
|
21480
22496
|
} & {
|
|
21481
22497
|
[key: string]: any;
|
|
21482
22498
|
};
|
|
21483
|
-
type NestedQuery$
|
|
22499
|
+
type NestedQuery$8 = {
|
|
21484
22500
|
path: string;
|
|
21485
22501
|
query: any;
|
|
21486
22502
|
scoreMode?: string;
|
|
21487
22503
|
} & {
|
|
21488
22504
|
[key: string]: any;
|
|
21489
22505
|
};
|
|
21490
|
-
type Sort$
|
|
22506
|
+
type Sort$8 = {
|
|
21491
22507
|
field: string;
|
|
21492
22508
|
sortOrder?: string;
|
|
21493
22509
|
} & {
|
|
21494
22510
|
[key: string]: any;
|
|
21495
22511
|
};
|
|
21496
|
-
type L10nString$
|
|
22512
|
+
type L10nString$7 = {} & {
|
|
21497
22513
|
[key: string]: any;
|
|
21498
22514
|
};
|
|
21499
|
-
type PropertyValueDefinition$
|
|
21500
|
-
description: L10nString$
|
|
21501
|
-
displayValue: L10nString$
|
|
22515
|
+
type PropertyValueDefinition$7 = {
|
|
22516
|
+
description: L10nString$7;
|
|
22517
|
+
displayValue: L10nString$7;
|
|
21502
22518
|
id: string;
|
|
21503
22519
|
position?: number;
|
|
21504
22520
|
value: string;
|
|
@@ -21835,16 +22851,16 @@ declare namespace ShopperPromotionsTypes {
|
|
|
21835
22851
|
type SearchRequest = {
|
|
21836
22852
|
limit?: number;
|
|
21837
22853
|
query: any;
|
|
21838
|
-
sorts?: Array<Sort$
|
|
22854
|
+
sorts?: Array<Sort$8>;
|
|
21839
22855
|
offset?: any;
|
|
21840
22856
|
} & {
|
|
21841
22857
|
[key: string]: any;
|
|
21842
22858
|
};
|
|
21843
22859
|
type PropertyDefinition = {
|
|
21844
|
-
defaultValue?: PropertyValueDefinition$
|
|
22860
|
+
defaultValue?: PropertyValueDefinition$7;
|
|
21845
22861
|
id?: string;
|
|
21846
|
-
name: L10nString$
|
|
21847
|
-
description: L10nString$
|
|
22862
|
+
name: L10nString$7;
|
|
22863
|
+
description: L10nString$7;
|
|
21848
22864
|
key?: boolean;
|
|
21849
22865
|
localizable?: boolean;
|
|
21850
22866
|
mandatory?: boolean;
|
|
@@ -21857,8 +22873,8 @@ declare namespace ShopperPromotionsTypes {
|
|
|
21857
22873
|
searchable?: boolean;
|
|
21858
22874
|
siteSpecific?: boolean;
|
|
21859
22875
|
system?: boolean;
|
|
21860
|
-
unit?: L10nString$
|
|
21861
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
22876
|
+
unit?: L10nString$7;
|
|
22877
|
+
possibleValues?: Array<PropertyValueDefinition$7>;
|
|
21862
22878
|
type: string;
|
|
21863
22879
|
visible?: boolean;
|
|
21864
22880
|
} & {
|
|
@@ -21869,7 +22885,7 @@ declare namespace ShopperPromotionsTypes {
|
|
|
21869
22885
|
};
|
|
21870
22886
|
type PaginatedSearchResult = {
|
|
21871
22887
|
query: any;
|
|
21872
|
-
sorts?: Array<Sort$
|
|
22888
|
+
sorts?: Array<Sort$8>;
|
|
21873
22889
|
limit: number;
|
|
21874
22890
|
hits?: Array<object>;
|
|
21875
22891
|
offset: any;
|
|
@@ -21895,7 +22911,7 @@ declare namespace ShopperPromotionsTypes {
|
|
|
21895
22911
|
};
|
|
21896
22912
|
type PaginatedSearchResultBase = {
|
|
21897
22913
|
query: any;
|
|
21898
|
-
sorts?: Array<Sort$
|
|
22914
|
+
sorts?: Array<Sort$8>;
|
|
21899
22915
|
limit: number;
|
|
21900
22916
|
hits?: Array<object>;
|
|
21901
22917
|
offset: any;
|
|
@@ -21918,12 +22934,12 @@ declare namespace ShopperPromotionsTypes {
|
|
|
21918
22934
|
[key: string]: any;
|
|
21919
22935
|
};
|
|
21920
22936
|
type Query = {
|
|
21921
|
-
boolQuery?: BoolQuery$
|
|
22937
|
+
boolQuery?: BoolQuery$8;
|
|
21922
22938
|
filteredQuery?: FilteredQuery;
|
|
21923
22939
|
matchAllQuery?: MatchAllQuery;
|
|
21924
|
-
nestedQuery?: NestedQuery$
|
|
21925
|
-
termQuery?: TermQuery$
|
|
21926
|
-
textQuery?: TextQuery$
|
|
22940
|
+
nestedQuery?: NestedQuery$8;
|
|
22941
|
+
termQuery?: TermQuery$8;
|
|
22942
|
+
textQuery?: TextQuery$8;
|
|
21927
22943
|
} & {
|
|
21928
22944
|
[key: string]: any;
|
|
21929
22945
|
};
|
|
@@ -22013,7 +23029,7 @@ declare namespace ShopperPromotionsTypes {
|
|
|
22013
23029
|
[key: string]: any;
|
|
22014
23030
|
};
|
|
22015
23031
|
type AttributeDefinition = {
|
|
22016
|
-
defaultValue?: PropertyValueDefinition$
|
|
23032
|
+
defaultValue?: PropertyValueDefinition$7;
|
|
22017
23033
|
id?: string;
|
|
22018
23034
|
name: L10nString;
|
|
22019
23035
|
description: L10nString;
|
|
@@ -22030,7 +23046,7 @@ declare namespace ShopperPromotionsTypes {
|
|
|
22030
23046
|
siteSpecific?: boolean;
|
|
22031
23047
|
system?: boolean;
|
|
22032
23048
|
unit?: L10nString;
|
|
22033
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
23049
|
+
possibleValues?: Array<PropertyValueDefinition$7>;
|
|
22034
23050
|
type: string;
|
|
22035
23051
|
visible?: boolean;
|
|
22036
23052
|
};
|
|
@@ -22226,40 +23242,40 @@ declare namespace ShopperPromotionsTypes {
|
|
|
22226
23242
|
}>, rawResponse?: T): Promise<T extends true ? Response : PromotionResult>;
|
|
22227
23243
|
}
|
|
22228
23244
|
}
|
|
22229
|
-
type TermQuery$
|
|
23245
|
+
type TermQuery$9 = {
|
|
22230
23246
|
fields: Array<string>;
|
|
22231
23247
|
operator: string;
|
|
22232
23248
|
values?: Array<any>;
|
|
22233
23249
|
} & {
|
|
22234
23250
|
[key: string]: any;
|
|
22235
23251
|
};
|
|
22236
|
-
type TextQuery$
|
|
23252
|
+
type TextQuery$9 = {
|
|
22237
23253
|
fields: Array<string>;
|
|
22238
23254
|
searchPhrase: string;
|
|
22239
23255
|
} & {
|
|
22240
23256
|
[key: string]: any;
|
|
22241
23257
|
};
|
|
22242
|
-
type BoolQuery$
|
|
23258
|
+
type BoolQuery$9 = {
|
|
22243
23259
|
must?: Array<any>;
|
|
22244
23260
|
mustNot?: Array<any>;
|
|
22245
23261
|
should?: Array<any>;
|
|
22246
23262
|
} & {
|
|
22247
23263
|
[key: string]: any;
|
|
22248
23264
|
};
|
|
22249
|
-
type NestedQuery$
|
|
23265
|
+
type NestedQuery$9 = {
|
|
22250
23266
|
path: string;
|
|
22251
23267
|
query: any;
|
|
22252
23268
|
scoreMode?: string;
|
|
22253
23269
|
} & {
|
|
22254
23270
|
[key: string]: any;
|
|
22255
23271
|
};
|
|
22256
|
-
type Sort$
|
|
23272
|
+
type Sort$9 = {
|
|
22257
23273
|
field: string;
|
|
22258
23274
|
sortOrder?: string;
|
|
22259
23275
|
} & {
|
|
22260
23276
|
[key: string]: any;
|
|
22261
23277
|
};
|
|
22262
|
-
type RangeFilter$
|
|
23278
|
+
type RangeFilter$9 = {
|
|
22263
23279
|
field: string;
|
|
22264
23280
|
from?: any;
|
|
22265
23281
|
fromInclusive?: boolean;
|
|
@@ -22268,12 +23284,12 @@ type RangeFilter$8 = {
|
|
|
22268
23284
|
} & {
|
|
22269
23285
|
[key: string]: any;
|
|
22270
23286
|
};
|
|
22271
|
-
type L10nString$
|
|
23287
|
+
type L10nString$8 = {} & {
|
|
22272
23288
|
[key: string]: any;
|
|
22273
23289
|
};
|
|
22274
|
-
type PropertyValueDefinition$
|
|
22275
|
-
description: L10nString$
|
|
22276
|
-
displayValue: L10nString$
|
|
23290
|
+
type PropertyValueDefinition$8 = {
|
|
23291
|
+
description: L10nString$8;
|
|
23292
|
+
displayValue: L10nString$8;
|
|
22277
23293
|
id: string;
|
|
22278
23294
|
position?: number;
|
|
22279
23295
|
value: string;
|
|
@@ -22769,16 +23785,16 @@ declare namespace ShopperSearchTypes {
|
|
|
22769
23785
|
type SearchRequest = {
|
|
22770
23786
|
limit?: number;
|
|
22771
23787
|
query: any;
|
|
22772
|
-
sorts?: Array<Sort$
|
|
23788
|
+
sorts?: Array<Sort$9>;
|
|
22773
23789
|
offset?: any;
|
|
22774
23790
|
} & {
|
|
22775
23791
|
[key: string]: any;
|
|
22776
23792
|
};
|
|
22777
23793
|
type PropertyDefinition = {
|
|
22778
|
-
defaultValue?: PropertyValueDefinition$
|
|
23794
|
+
defaultValue?: PropertyValueDefinition$8;
|
|
22779
23795
|
id?: string;
|
|
22780
|
-
name: L10nString$
|
|
22781
|
-
description: L10nString$
|
|
23796
|
+
name: L10nString$8;
|
|
23797
|
+
description: L10nString$8;
|
|
22782
23798
|
key?: boolean;
|
|
22783
23799
|
localizable?: boolean;
|
|
22784
23800
|
mandatory?: boolean;
|
|
@@ -22791,8 +23807,8 @@ declare namespace ShopperSearchTypes {
|
|
|
22791
23807
|
searchable?: boolean;
|
|
22792
23808
|
siteSpecific?: boolean;
|
|
22793
23809
|
system?: boolean;
|
|
22794
|
-
unit?: L10nString$
|
|
22795
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
23810
|
+
unit?: L10nString$8;
|
|
23811
|
+
possibleValues?: Array<PropertyValueDefinition$8>;
|
|
22796
23812
|
type: string;
|
|
22797
23813
|
visible?: boolean;
|
|
22798
23814
|
} & {
|
|
@@ -22803,7 +23819,7 @@ declare namespace ShopperSearchTypes {
|
|
|
22803
23819
|
};
|
|
22804
23820
|
type PaginatedSearchResult = {
|
|
22805
23821
|
query: any;
|
|
22806
|
-
sorts?: Array<Sort$
|
|
23822
|
+
sorts?: Array<Sort$9>;
|
|
22807
23823
|
limit: number;
|
|
22808
23824
|
hits?: Array<object>;
|
|
22809
23825
|
offset: any;
|
|
@@ -22829,7 +23845,7 @@ declare namespace ShopperSearchTypes {
|
|
|
22829
23845
|
};
|
|
22830
23846
|
type PaginatedSearchResultBase = {
|
|
22831
23847
|
query: any;
|
|
22832
|
-
sorts?: Array<Sort$
|
|
23848
|
+
sorts?: Array<Sort$9>;
|
|
22833
23849
|
limit: number;
|
|
22834
23850
|
hits?: Array<object>;
|
|
22835
23851
|
offset: any;
|
|
@@ -22852,12 +23868,12 @@ declare namespace ShopperSearchTypes {
|
|
|
22852
23868
|
[key: string]: any;
|
|
22853
23869
|
};
|
|
22854
23870
|
type Query = {
|
|
22855
|
-
boolQuery?: BoolQuery$
|
|
23871
|
+
boolQuery?: BoolQuery$9;
|
|
22856
23872
|
filteredQuery?: FilteredQuery;
|
|
22857
23873
|
matchAllQuery?: MatchAllQuery;
|
|
22858
|
-
nestedQuery?: NestedQuery$
|
|
22859
|
-
termQuery?: TermQuery$
|
|
22860
|
-
textQuery?: TextQuery$
|
|
23874
|
+
nestedQuery?: NestedQuery$9;
|
|
23875
|
+
termQuery?: TermQuery$9;
|
|
23876
|
+
textQuery?: TextQuery$9;
|
|
22861
23877
|
} & {
|
|
22862
23878
|
[key: string]: any;
|
|
22863
23879
|
};
|
|
@@ -22918,7 +23934,7 @@ declare namespace ShopperSearchTypes {
|
|
|
22918
23934
|
boolFilter?: BoolFilter;
|
|
22919
23935
|
queryFilter?: QueryFilter;
|
|
22920
23936
|
range2Filter?: Range2Filter;
|
|
22921
|
-
rangeFilter?: RangeFilter$
|
|
23937
|
+
rangeFilter?: RangeFilter$9;
|
|
22922
23938
|
termFilter?: TermFilter;
|
|
22923
23939
|
} & {
|
|
22924
23940
|
[key: string]: any;
|
|
@@ -22956,7 +23972,7 @@ declare namespace ShopperSearchTypes {
|
|
|
22956
23972
|
[key: string]: any;
|
|
22957
23973
|
};
|
|
22958
23974
|
type AttributeDefinition = {
|
|
22959
|
-
defaultValue?: PropertyValueDefinition$
|
|
23975
|
+
defaultValue?: PropertyValueDefinition$8;
|
|
22960
23976
|
id?: string;
|
|
22961
23977
|
name: L10nString;
|
|
22962
23978
|
description: L10nString;
|
|
@@ -22973,7 +23989,7 @@ declare namespace ShopperSearchTypes {
|
|
|
22973
23989
|
siteSpecific?: boolean;
|
|
22974
23990
|
system?: boolean;
|
|
22975
23991
|
unit?: L10nString;
|
|
22976
|
-
possibleValues?: Array<PropertyValueDefinition$
|
|
23992
|
+
possibleValues?: Array<PropertyValueDefinition$8>;
|
|
22977
23993
|
type: string;
|
|
22978
23994
|
visible?: boolean;
|
|
22979
23995
|
};
|
|
@@ -25072,5 +26088,5 @@ declare namespace helpers {
|
|
|
25072
26088
|
refreshToken: string;
|
|
25073
26089
|
}): Promise<TokenResponse>;
|
|
25074
26090
|
}
|
|
25075
|
-
export { ShopperBaskets, ShopperContexts, ShopperCustomers, ShopperDiscoverySearch, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ClientConfig, TemplateURL, helpers };
|
|
25076
|
-
export type { ShopperBasketsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperDiscoverySearchTypes, ShopperGiftCertificatesTypes, ShopperLoginTypes, ShopperOrdersTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ClientConfigInit };
|
|
26091
|
+
export { ShopperBaskets, ShopperContexts, ShopperCustomers, ShopperDiscoverySearch, ShopperExperience, ShopperGiftCertificates, ShopperLogin, ShopperOrders, ShopperProducts, ShopperPromotions, ShopperSearch, ClientConfig, TemplateURL, helpers };
|
|
26092
|
+
export type { ShopperBasketsTypes, ShopperContextsTypes, ShopperCustomersTypes, ShopperDiscoverySearchTypes, ShopperExperienceTypes, ShopperGiftCertificatesTypes, ShopperLoginTypes, ShopperOrdersTypes, ShopperProductsTypes, ShopperPromotionsTypes, ShopperSearchTypes, ClientConfigInit };
|