@wix/auto_sdk_stores_read-only-variants-v-3 1.0.9 → 1.0.11
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/build/{cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts → index.d.mts} +410 -528
- package/build/{es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts → index.d.ts} +410 -528
- package/build/index.js +923 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +831 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/index.d.mts +35 -0
- package/build/internal/index.d.ts +35 -0
- package/build/internal/index.js +923 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +831 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +1271 -0
- package/build/internal/meta.d.ts +1271 -0
- package/build/internal/meta.js +209 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +181 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/internal/{cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts → stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-Co7RmbZM.d.mts} +412 -516
- package/build/internal/{es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.d.ts → stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-Co7RmbZM.d.ts} +412 -516
- package/build/meta.d.mts +1271 -0
- package/build/meta.d.ts +1271 -0
- package/build/meta.js +209 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +181 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -3
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +0 -2
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.js +0 -79
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.d.ts +0 -16
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.js +0 -145
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.d.ts +0 -14
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.js +0 -66
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +0 -4
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +0 -89
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +0 -4698
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js +0 -695
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +0 -1
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +0 -910
- package/build/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -3
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +0 -2
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.js +0 -8
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.js.map +0 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.d.ts +0 -16
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.js +0 -140
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.js.map +0 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.d.ts +0 -14
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.js +0 -38
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.js.map +0 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +0 -4
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +0 -16
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +0 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +0 -4698
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js +0 -691
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +0 -1
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +0 -881
- package/build/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -54
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +0 -8
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.js +0 -79
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.d.ts +0 -16
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.js +0 -145
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.d.ts +0 -14
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.js +0 -66
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +0 -30
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +0 -89
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +0 -4698
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js +0 -695
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +0 -1
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +0 -910
- package/build/internal/cjs/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -54
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.d.ts +0 -8
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.js +0 -8
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.context.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.d.ts +0 -16
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.js +0 -140
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.http.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.d.ts +0 -14
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.js +0 -38
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.meta.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.d.ts +0 -30
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js +0 -16
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.public.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.d.ts +0 -4698
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js +0 -691
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.types.js.map +0 -1
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js +0 -881
- package/build/internal/es/src/stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal.js.map +0 -1
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
1
|
+
import { SearchSpec } from '@wix/sdk-types';
|
|
2
|
+
|
|
3
|
+
interface ReadOnlyVariant extends ReadOnlyVariantTypedPropertiesOneOf {
|
|
3
4
|
/** Physical properties. Must be passed when `productType: PHYSICAL` */
|
|
4
5
|
physicalProperties?: V3VariantPhysicalProperties;
|
|
5
6
|
/** Digital properties. Must be passed when `productType: DIGITAL` */
|
|
@@ -75,13 +76,13 @@ export interface ReadOnlyVariant extends ReadOnlyVariantTypedPropertiesOneOf {
|
|
|
75
76
|
productData?: ProductFields;
|
|
76
77
|
}
|
|
77
78
|
/** @oneof */
|
|
78
|
-
|
|
79
|
+
interface ReadOnlyVariantTypedPropertiesOneOf {
|
|
79
80
|
/** Physical properties. Must be passed when `productType: PHYSICAL` */
|
|
80
81
|
physicalProperties?: V3VariantPhysicalProperties;
|
|
81
82
|
/** Digital properties. Must be passed when `productType: DIGITAL` */
|
|
82
83
|
digitalProperties?: V3VariantDigitalProperties;
|
|
83
84
|
}
|
|
84
|
-
|
|
85
|
+
interface V3OptionChoice {
|
|
85
86
|
/**
|
|
86
87
|
* Option and choice IDs.
|
|
87
88
|
* @readonly
|
|
@@ -93,7 +94,7 @@ export interface V3OptionChoice {
|
|
|
93
94
|
*/
|
|
94
95
|
optionChoiceNames?: V3OptionChoiceNames;
|
|
95
96
|
}
|
|
96
|
-
|
|
97
|
+
interface V3OptionChoiceIds {
|
|
97
98
|
/**
|
|
98
99
|
* Option ID.
|
|
99
100
|
* @minLength 1
|
|
@@ -108,7 +109,7 @@ export interface V3OptionChoiceIds {
|
|
|
108
109
|
*/
|
|
109
110
|
choiceId?: string;
|
|
110
111
|
}
|
|
111
|
-
|
|
112
|
+
interface V3OptionChoiceNames {
|
|
112
113
|
/**
|
|
113
114
|
* Option name.
|
|
114
115
|
* @minLength 1
|
|
@@ -130,7 +131,7 @@ export interface V3OptionChoiceNames {
|
|
|
130
131
|
*/
|
|
131
132
|
renderType?: string;
|
|
132
133
|
}
|
|
133
|
-
|
|
134
|
+
interface V3PriceInfo {
|
|
134
135
|
/**
|
|
135
136
|
* Variant price.
|
|
136
137
|
* @readonly
|
|
@@ -142,7 +143,7 @@ export interface V3PriceInfo {
|
|
|
142
143
|
*/
|
|
143
144
|
compareAtPrice?: V3FixedMonetaryAmount;
|
|
144
145
|
}
|
|
145
|
-
|
|
146
|
+
interface V3FixedMonetaryAmount {
|
|
146
147
|
/**
|
|
147
148
|
* Monetary amount. For example, `"3.99"`, or `"-4.99"` for a negative amount.
|
|
148
149
|
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
@@ -156,7 +157,7 @@ export interface V3FixedMonetaryAmount {
|
|
|
156
157
|
*/
|
|
157
158
|
formattedAmount?: string | null;
|
|
158
159
|
}
|
|
159
|
-
|
|
160
|
+
interface V3RevenueDetails {
|
|
160
161
|
/**
|
|
161
162
|
* Item cost.
|
|
162
163
|
* @readonly
|
|
@@ -175,7 +176,7 @@ export interface V3RevenueDetails {
|
|
|
175
176
|
*/
|
|
176
177
|
profitMargin?: number;
|
|
177
178
|
}
|
|
178
|
-
|
|
179
|
+
interface V3ProductMedia extends V3ProductMediaSetByOneOf, V3ProductMediaMediaOneOf {
|
|
179
180
|
/**
|
|
180
181
|
* ID of existing media from Wix Media Manager.
|
|
181
182
|
* @minLength 1
|
|
@@ -231,7 +232,7 @@ export interface V3ProductMedia extends V3ProductMediaSetByOneOf, V3ProductMedia
|
|
|
231
232
|
uploadId?: string;
|
|
232
233
|
}
|
|
233
234
|
/** @oneof */
|
|
234
|
-
|
|
235
|
+
interface V3ProductMediaSetByOneOf {
|
|
235
236
|
/**
|
|
236
237
|
* ID of existing media from Wix Media Manager.
|
|
237
238
|
* @minLength 1
|
|
@@ -247,7 +248,7 @@ export interface V3ProductMediaSetByOneOf {
|
|
|
247
248
|
url?: string;
|
|
248
249
|
}
|
|
249
250
|
/** @oneof */
|
|
250
|
-
|
|
251
|
+
interface V3ProductMediaMediaOneOf {
|
|
251
252
|
/**
|
|
252
253
|
* Product image.
|
|
253
254
|
* @readonly
|
|
@@ -259,7 +260,7 @@ export interface V3ProductMediaMediaOneOf {
|
|
|
259
260
|
*/
|
|
260
261
|
video?: string;
|
|
261
262
|
}
|
|
262
|
-
|
|
263
|
+
interface CommonVideoResolution {
|
|
263
264
|
/**
|
|
264
265
|
* Video URL.
|
|
265
266
|
* @format WEB_URL
|
|
@@ -275,7 +276,7 @@ export interface CommonVideoResolution {
|
|
|
275
276
|
*/
|
|
276
277
|
format?: string;
|
|
277
278
|
}
|
|
278
|
-
|
|
279
|
+
declare enum ProductMediaMediaType {
|
|
279
280
|
UNKNOWN_MEDIA_TYPE = "UNKNOWN_MEDIA_TYPE",
|
|
280
281
|
/** Image media type. */
|
|
281
282
|
IMAGE = "IMAGE",
|
|
@@ -283,8 +284,8 @@ export declare enum ProductMediaMediaType {
|
|
|
283
284
|
VIDEO = "VIDEO"
|
|
284
285
|
}
|
|
285
286
|
/** @enumType */
|
|
286
|
-
|
|
287
|
-
|
|
287
|
+
type ProductMediaMediaTypeWithLiterals = ProductMediaMediaType | 'UNKNOWN_MEDIA_TYPE' | 'IMAGE' | 'VIDEO';
|
|
288
|
+
interface V3Thumbnail {
|
|
288
289
|
/**
|
|
289
290
|
* Thumbnail url.
|
|
290
291
|
* @format WEB_URL
|
|
@@ -309,7 +310,7 @@ export interface V3Thumbnail {
|
|
|
309
310
|
*/
|
|
310
311
|
altText?: string | null;
|
|
311
312
|
}
|
|
312
|
-
|
|
313
|
+
interface V3VariantPhysicalProperties {
|
|
313
314
|
/**
|
|
314
315
|
* Variant shipping weight.
|
|
315
316
|
* @max 999999999.99
|
|
@@ -324,7 +325,7 @@ export interface V3VariantPhysicalProperties {
|
|
|
324
325
|
*/
|
|
325
326
|
pricePerUnit?: V3PricePerUnit;
|
|
326
327
|
}
|
|
327
|
-
|
|
328
|
+
interface V3PricePerUnit {
|
|
328
329
|
/**
|
|
329
330
|
* Price per unit data for this variant.
|
|
330
331
|
* `measurementUnit` value must correspond to the measurement unit set on the product.
|
|
@@ -345,7 +346,7 @@ export interface V3PricePerUnit {
|
|
|
345
346
|
*/
|
|
346
347
|
description?: string | null;
|
|
347
348
|
}
|
|
348
|
-
|
|
349
|
+
interface V3PricePerUnitSettings {
|
|
349
350
|
/**
|
|
350
351
|
* Quantity.
|
|
351
352
|
* For example, to define price per per 100 grams, set this field to `100`.
|
|
@@ -361,7 +362,7 @@ export interface V3PricePerUnitSettings {
|
|
|
361
362
|
*/
|
|
362
363
|
measurementUnit?: MeasurementUnitWithLiterals;
|
|
363
364
|
}
|
|
364
|
-
|
|
365
|
+
declare enum MeasurementUnit {
|
|
365
366
|
UNSPECIFIED = "UNSPECIFIED",
|
|
366
367
|
ML = "ML",
|
|
367
368
|
CL = "CL",
|
|
@@ -386,15 +387,15 @@ export declare enum MeasurementUnit {
|
|
|
386
387
|
SQFT = "SQFT"
|
|
387
388
|
}
|
|
388
389
|
/** @enumType */
|
|
389
|
-
|
|
390
|
-
|
|
390
|
+
type MeasurementUnitWithLiterals = MeasurementUnit | 'UNSPECIFIED' | 'ML' | 'CL' | 'L' | 'CBM' | 'MG' | 'G' | 'KG' | 'MM' | 'CM' | 'M' | 'SQM' | 'OZ' | 'LB' | 'FLOZ' | 'PT' | 'QT' | 'GAL' | 'IN' | 'FT' | 'YD' | 'SQFT';
|
|
391
|
+
interface V3VariantDigitalProperties {
|
|
391
392
|
/**
|
|
392
393
|
* Digital file which will be downloaded by customer after successful purchase.
|
|
393
394
|
* @readonly
|
|
394
395
|
*/
|
|
395
396
|
digitalFile?: V3SecuredMedia;
|
|
396
397
|
}
|
|
397
|
-
|
|
398
|
+
interface V3SecuredMedia {
|
|
398
399
|
/**
|
|
399
400
|
* Media ID in media manager.
|
|
400
401
|
* @minLength 1
|
|
@@ -424,7 +425,7 @@ export interface V3SecuredMedia {
|
|
|
424
425
|
*/
|
|
425
426
|
fileType?: SecuredMediaFileTypeWithLiterals;
|
|
426
427
|
}
|
|
427
|
-
|
|
428
|
+
declare enum SecuredMediaFileType {
|
|
428
429
|
/** Unspecified file type. */
|
|
429
430
|
UNSPECIFIED = "UNSPECIFIED",
|
|
430
431
|
/** Secure picture file. */
|
|
@@ -439,8 +440,8 @@ export declare enum SecuredMediaFileType {
|
|
|
439
440
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
440
441
|
}
|
|
441
442
|
/** @enumType */
|
|
442
|
-
|
|
443
|
-
|
|
443
|
+
type SecuredMediaFileTypeWithLiterals = SecuredMediaFileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
444
|
+
interface V3SubscriptionPricesInfo {
|
|
444
445
|
/**
|
|
445
446
|
* Subscription prices.
|
|
446
447
|
* @maxSize 6
|
|
@@ -448,7 +449,7 @@ export interface V3SubscriptionPricesInfo {
|
|
|
448
449
|
*/
|
|
449
450
|
subscriptionPrices?: V3SubscriptionPrice[];
|
|
450
451
|
}
|
|
451
|
-
|
|
452
|
+
interface V3SubscriptionPrice {
|
|
452
453
|
/**
|
|
453
454
|
* Subscription ID.
|
|
454
455
|
* @format GUID
|
|
@@ -466,7 +467,7 @@ export interface V3SubscriptionPrice {
|
|
|
466
467
|
*/
|
|
467
468
|
pricePerUnit?: V3SubscriptionPricePerUnit;
|
|
468
469
|
}
|
|
469
|
-
|
|
470
|
+
interface V3SubscriptionPricePerUnit {
|
|
470
471
|
/**
|
|
471
472
|
* Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.
|
|
472
473
|
* @readonly
|
|
@@ -480,7 +481,7 @@ export interface V3SubscriptionPricePerUnit {
|
|
|
480
481
|
*/
|
|
481
482
|
description?: string | null;
|
|
482
483
|
}
|
|
483
|
-
|
|
484
|
+
interface V3InventoryStatus {
|
|
484
485
|
/**
|
|
485
486
|
* Whether the variant is in stock.
|
|
486
487
|
* @readonly
|
|
@@ -492,7 +493,7 @@ export interface V3InventoryStatus {
|
|
|
492
493
|
*/
|
|
493
494
|
preorderEnabled?: boolean;
|
|
494
495
|
}
|
|
495
|
-
|
|
496
|
+
interface ProductFields extends ProductFieldsTypedPropertiesOneOf {
|
|
496
497
|
/**
|
|
497
498
|
* Physical properties.
|
|
498
499
|
*
|
|
@@ -561,7 +562,7 @@ export interface ProductFields extends ProductFieldsTypedPropertiesOneOf {
|
|
|
561
562
|
revision?: string | null;
|
|
562
563
|
}
|
|
563
564
|
/** @oneof */
|
|
564
|
-
|
|
565
|
+
interface ProductFieldsTypedPropertiesOneOf {
|
|
565
566
|
/**
|
|
566
567
|
* Physical properties.
|
|
567
568
|
*
|
|
@@ -569,7 +570,7 @@ export interface ProductFieldsTypedPropertiesOneOf {
|
|
|
569
570
|
*/
|
|
570
571
|
physicalProperties?: V3PhysicalProperties;
|
|
571
572
|
}
|
|
572
|
-
|
|
573
|
+
declare enum V3ProductType {
|
|
573
574
|
/** Not implemented. */
|
|
574
575
|
UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
|
|
575
576
|
/** Physical product. */
|
|
@@ -578,8 +579,8 @@ export declare enum V3ProductType {
|
|
|
578
579
|
DIGITAL = "DIGITAL"
|
|
579
580
|
}
|
|
580
581
|
/** @enumType */
|
|
581
|
-
|
|
582
|
-
|
|
582
|
+
type V3ProductTypeWithLiterals = V3ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'PHYSICAL' | 'DIGITAL';
|
|
583
|
+
interface V3PhysicalProperties {
|
|
583
584
|
/**
|
|
584
585
|
* Weight measurement unit.
|
|
585
586
|
* > **Note:** Returned only when you pass `"WEIGHT_MEASUREMENT_UNIT_INFO"` to the `fields` array in Products API requests.
|
|
@@ -587,14 +588,14 @@ export interface V3PhysicalProperties {
|
|
|
587
588
|
*/
|
|
588
589
|
weightMeasurementUnitInfo?: V3WeightMeasurementUnitInfo;
|
|
589
590
|
}
|
|
590
|
-
|
|
591
|
+
interface V3WeightMeasurementUnitInfo {
|
|
591
592
|
/**
|
|
592
593
|
* Weight measurement unit.
|
|
593
594
|
* @readonly
|
|
594
595
|
*/
|
|
595
596
|
weightMeasurementUnit?: WeightUnitWithLiterals;
|
|
596
597
|
}
|
|
597
|
-
|
|
598
|
+
declare enum WeightUnit {
|
|
598
599
|
/** Weight unit can't be classified due to an error. */
|
|
599
600
|
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
600
601
|
/** Kilograms. */
|
|
@@ -603,10 +604,10 @@ export declare enum WeightUnit {
|
|
|
603
604
|
LB = "LB"
|
|
604
605
|
}
|
|
605
606
|
/** @enumType */
|
|
606
|
-
|
|
607
|
-
|
|
607
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
608
|
+
interface InternalMetadata {
|
|
608
609
|
}
|
|
609
|
-
|
|
610
|
+
declare enum InternalRowState {
|
|
610
611
|
/** Not implemented. */
|
|
611
612
|
UNKNOWN_ROW_STATE = "UNKNOWN_ROW_STATE",
|
|
612
613
|
/** Variant is ready to be read. */
|
|
@@ -618,9 +619,7 @@ export declare enum InternalRowState {
|
|
|
618
619
|
/** Variant is permanently deleted. */
|
|
619
620
|
PERMANENTLY_DELETED = "PERMANENTLY_DELETED"
|
|
620
621
|
}
|
|
621
|
-
|
|
622
|
-
export type InternalRowStateWithLiterals = InternalRowState | 'UNKNOWN_ROW_STATE' | 'READY' | 'IN_PROCESS' | 'SOFT_DELETED' | 'PERMANENTLY_DELETED';
|
|
623
|
-
export interface QueryVariantsRequest {
|
|
622
|
+
interface QueryVariantsRequest {
|
|
624
623
|
/** WQL expression. */
|
|
625
624
|
query?: CursorQuery;
|
|
626
625
|
/**
|
|
@@ -629,7 +628,7 @@ export interface QueryVariantsRequest {
|
|
|
629
628
|
*/
|
|
630
629
|
fields?: RequestedFieldsWithLiterals[];
|
|
631
630
|
}
|
|
632
|
-
|
|
631
|
+
interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
633
632
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
634
633
|
cursorPaging?: CursorPaging;
|
|
635
634
|
/**
|
|
@@ -649,11 +648,11 @@ export interface CursorQuery extends CursorQueryPagingMethodOneOf {
|
|
|
649
648
|
sort?: Sorting[];
|
|
650
649
|
}
|
|
651
650
|
/** @oneof */
|
|
652
|
-
|
|
651
|
+
interface CursorQueryPagingMethodOneOf {
|
|
653
652
|
/** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
|
|
654
653
|
cursorPaging?: CursorPaging;
|
|
655
654
|
}
|
|
656
|
-
|
|
655
|
+
interface Sorting {
|
|
657
656
|
/**
|
|
658
657
|
* Name of the field to sort by.
|
|
659
658
|
* @maxLength 512
|
|
@@ -662,13 +661,13 @@ export interface Sorting {
|
|
|
662
661
|
/** Sort order. */
|
|
663
662
|
order?: SortOrderWithLiterals;
|
|
664
663
|
}
|
|
665
|
-
|
|
664
|
+
declare enum SortOrder {
|
|
666
665
|
ASC = "ASC",
|
|
667
666
|
DESC = "DESC"
|
|
668
667
|
}
|
|
669
668
|
/** @enumType */
|
|
670
|
-
|
|
671
|
-
|
|
669
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
670
|
+
interface CursorPaging {
|
|
672
671
|
/**
|
|
673
672
|
* Maximum number of items to return in the results.
|
|
674
673
|
* @max 1000
|
|
@@ -683,7 +682,7 @@ export interface CursorPaging {
|
|
|
683
682
|
*/
|
|
684
683
|
cursor?: string | null;
|
|
685
684
|
}
|
|
686
|
-
|
|
685
|
+
declare enum RequestedFields {
|
|
687
686
|
/** Not implemented. */
|
|
688
687
|
UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
|
|
689
688
|
CURRENCY = "CURRENCY",
|
|
@@ -693,14 +692,14 @@ export declare enum RequestedFields {
|
|
|
693
692
|
WEIGHT_MEASUREMENT_UNIT_INFO = "WEIGHT_MEASUREMENT_UNIT_INFO"
|
|
694
693
|
}
|
|
695
694
|
/** @enumType */
|
|
696
|
-
|
|
697
|
-
|
|
695
|
+
type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'CURRENCY' | 'MERCHANT_DATA' | 'SUBSCRIPTION_PRICES_INFO' | 'WEIGHT_MEASUREMENT_UNIT_INFO';
|
|
696
|
+
interface QueryVariantsResponse {
|
|
698
697
|
/** List of ReadOnlyVariants. */
|
|
699
698
|
variants?: ReadOnlyVariant[];
|
|
700
699
|
/** Paging metadata */
|
|
701
700
|
pagingMetadata?: CursorPagingMetadata;
|
|
702
701
|
}
|
|
703
|
-
|
|
702
|
+
interface CursorPagingMetadata {
|
|
704
703
|
/** Number of items returned in the response. */
|
|
705
704
|
count?: number | null;
|
|
706
705
|
/** Cursor strings that point to the next page, previous page, or both. */
|
|
@@ -713,7 +712,7 @@ export interface CursorPagingMetadata {
|
|
|
713
712
|
*/
|
|
714
713
|
hasNext?: boolean | null;
|
|
715
714
|
}
|
|
716
|
-
|
|
715
|
+
interface Cursors {
|
|
717
716
|
/**
|
|
718
717
|
* Cursor string pointing to the next page in the list of results.
|
|
719
718
|
* @maxLength 16000
|
|
@@ -725,7 +724,7 @@ export interface Cursors {
|
|
|
725
724
|
*/
|
|
726
725
|
prev?: string | null;
|
|
727
726
|
}
|
|
728
|
-
|
|
727
|
+
interface SearchVariantsRequest {
|
|
729
728
|
/** WQL expression */
|
|
730
729
|
search?: CursorSearch;
|
|
731
730
|
/**
|
|
@@ -734,7 +733,7 @@ export interface SearchVariantsRequest {
|
|
|
734
733
|
*/
|
|
735
734
|
fields?: RequestedFieldsWithLiterals[];
|
|
736
735
|
}
|
|
737
|
-
|
|
736
|
+
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
738
737
|
/**
|
|
739
738
|
* Cursor pointing to page of results.
|
|
740
739
|
* When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
@@ -767,14 +766,14 @@ export interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
|
767
766
|
timeZone?: string | null;
|
|
768
767
|
}
|
|
769
768
|
/** @oneof */
|
|
770
|
-
|
|
769
|
+
interface CursorSearchPagingMethodOneOf {
|
|
771
770
|
/**
|
|
772
771
|
* Cursor pointing to page of results.
|
|
773
772
|
* When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
774
773
|
*/
|
|
775
774
|
cursorPaging?: CursorPaging;
|
|
776
775
|
}
|
|
777
|
-
|
|
776
|
+
interface Aggregation extends AggregationKindOneOf {
|
|
778
777
|
/** Value aggregation */
|
|
779
778
|
value?: ValueAggregation;
|
|
780
779
|
/** Range aggregation */
|
|
@@ -799,7 +798,7 @@ export interface Aggregation extends AggregationKindOneOf {
|
|
|
799
798
|
fieldPath?: string;
|
|
800
799
|
}
|
|
801
800
|
/** @oneof */
|
|
802
|
-
|
|
801
|
+
interface AggregationKindOneOf {
|
|
803
802
|
/** Value aggregation */
|
|
804
803
|
value?: ValueAggregation;
|
|
805
804
|
/** Range aggregation */
|
|
@@ -811,44 +810,44 @@ export interface AggregationKindOneOf {
|
|
|
811
810
|
/** Nested aggregation */
|
|
812
811
|
nested?: NestedAggregation;
|
|
813
812
|
}
|
|
814
|
-
|
|
813
|
+
interface RangeBucket {
|
|
815
814
|
/** Inclusive lower bound of the range. Required if to is not given */
|
|
816
815
|
from?: number | null;
|
|
817
816
|
/** Exclusive upper bound of the range. Required if from is not given */
|
|
818
817
|
to?: number | null;
|
|
819
818
|
}
|
|
820
|
-
|
|
819
|
+
declare enum SortType {
|
|
821
820
|
/** Should sort by number of matches */
|
|
822
821
|
COUNT = "COUNT",
|
|
823
822
|
/** Should sort by value of the field alphabetically */
|
|
824
823
|
VALUE = "VALUE"
|
|
825
824
|
}
|
|
826
825
|
/** @enumType */
|
|
827
|
-
|
|
828
|
-
|
|
826
|
+
type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
827
|
+
declare enum SortDirection {
|
|
829
828
|
/** Should sort in descending order */
|
|
830
829
|
DESC = "DESC",
|
|
831
830
|
/** Should sort in ascending order */
|
|
832
831
|
ASC = "ASC"
|
|
833
832
|
}
|
|
834
833
|
/** @enumType */
|
|
835
|
-
|
|
836
|
-
|
|
834
|
+
type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
835
|
+
declare enum MissingValues {
|
|
837
836
|
/** Should missing values be excluded from the aggregation results */
|
|
838
837
|
EXCLUDE = "EXCLUDE",
|
|
839
838
|
/** Should missing values be included in the aggregation results */
|
|
840
839
|
INCLUDE = "INCLUDE"
|
|
841
840
|
}
|
|
842
841
|
/** @enumType */
|
|
843
|
-
|
|
844
|
-
|
|
842
|
+
type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
843
|
+
interface IncludeMissingValuesOptions {
|
|
845
844
|
/**
|
|
846
845
|
* Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
|
|
847
846
|
* @maxLength 20
|
|
848
847
|
*/
|
|
849
848
|
addToBucket?: string;
|
|
850
849
|
}
|
|
851
|
-
|
|
850
|
+
declare enum ScalarType {
|
|
852
851
|
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
853
852
|
/** Count of distinct values */
|
|
854
853
|
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
@@ -858,8 +857,8 @@ export declare enum ScalarType {
|
|
|
858
857
|
MAX = "MAX"
|
|
859
858
|
}
|
|
860
859
|
/** @enumType */
|
|
861
|
-
|
|
862
|
-
|
|
860
|
+
type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
861
|
+
interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
863
862
|
/** Options for including missing values */
|
|
864
863
|
includeOptions?: IncludeMissingValuesOptions;
|
|
865
864
|
/** Should sort by number of matches or value of the field */
|
|
@@ -872,11 +871,11 @@ export interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
|
872
871
|
missingValues?: MissingValuesWithLiterals;
|
|
873
872
|
}
|
|
874
873
|
/** @oneof */
|
|
875
|
-
|
|
874
|
+
interface ValueAggregationOptionsOneOf {
|
|
876
875
|
/** Options for including missing values */
|
|
877
876
|
includeOptions?: IncludeMissingValuesOptions;
|
|
878
877
|
}
|
|
879
|
-
|
|
878
|
+
declare enum NestedAggregationType {
|
|
880
879
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
881
880
|
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
882
881
|
VALUE = "VALUE",
|
|
@@ -888,23 +887,23 @@ export declare enum NestedAggregationType {
|
|
|
888
887
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
889
888
|
}
|
|
890
889
|
/** @enumType */
|
|
891
|
-
|
|
892
|
-
|
|
890
|
+
type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
891
|
+
interface RangeAggregation {
|
|
893
892
|
/**
|
|
894
893
|
* List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds
|
|
895
894
|
* @maxSize 50
|
|
896
895
|
*/
|
|
897
896
|
buckets?: RangeBucket[];
|
|
898
897
|
}
|
|
899
|
-
|
|
898
|
+
interface ScalarAggregation {
|
|
900
899
|
/** Define the operator for the scalar aggregation */
|
|
901
900
|
type?: ScalarTypeWithLiterals;
|
|
902
901
|
}
|
|
903
|
-
|
|
902
|
+
interface DateHistogramAggregation {
|
|
904
903
|
/** Interval for date histogram aggregation */
|
|
905
904
|
interval?: IntervalWithLiterals;
|
|
906
905
|
}
|
|
907
|
-
|
|
906
|
+
declare enum Interval {
|
|
908
907
|
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
909
908
|
/** Yearly interval */
|
|
910
909
|
YEAR = "YEAR",
|
|
@@ -922,8 +921,8 @@ export declare enum Interval {
|
|
|
922
921
|
SECOND = "SECOND"
|
|
923
922
|
}
|
|
924
923
|
/** @enumType */
|
|
925
|
-
|
|
926
|
-
|
|
924
|
+
type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
925
|
+
interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
927
926
|
/** Value aggregation */
|
|
928
927
|
value?: ValueAggregation;
|
|
929
928
|
/** Range aggregation */
|
|
@@ -946,7 +945,7 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
|
946
945
|
fieldPath?: string;
|
|
947
946
|
}
|
|
948
947
|
/** @oneof */
|
|
949
|
-
|
|
948
|
+
interface NestedAggregationItemKindOneOf {
|
|
950
949
|
/** Value aggregation */
|
|
951
950
|
value?: ValueAggregation;
|
|
952
951
|
/** Range aggregation */
|
|
@@ -956,7 +955,7 @@ export interface NestedAggregationItemKindOneOf {
|
|
|
956
955
|
/** Date histogram aggregation */
|
|
957
956
|
dateHistogram?: DateHistogramAggregation;
|
|
958
957
|
}
|
|
959
|
-
|
|
958
|
+
declare enum AggregationType {
|
|
960
959
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
961
960
|
/** An aggregation where result buckets are dynamically built - one per unique value */
|
|
962
961
|
VALUE = "VALUE",
|
|
@@ -970,9 +969,9 @@ export declare enum AggregationType {
|
|
|
970
969
|
NESTED = "NESTED"
|
|
971
970
|
}
|
|
972
971
|
/** @enumType */
|
|
973
|
-
|
|
972
|
+
type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
974
973
|
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
975
|
-
|
|
974
|
+
interface NestedAggregation {
|
|
976
975
|
/**
|
|
977
976
|
* Flattened list of aggregations, where each next aggregation is nested within previous one
|
|
978
977
|
* @minSize 2
|
|
@@ -980,7 +979,7 @@ export interface NestedAggregation {
|
|
|
980
979
|
*/
|
|
981
980
|
nestedAggregations?: NestedAggregationItem[];
|
|
982
981
|
}
|
|
983
|
-
|
|
982
|
+
interface SearchDetails {
|
|
984
983
|
/** Defines how separate search terms in `expression` are combined */
|
|
985
984
|
mode?: ModeWithLiterals;
|
|
986
985
|
/**
|
|
@@ -997,15 +996,15 @@ export interface SearchDetails {
|
|
|
997
996
|
/** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
|
|
998
997
|
fuzzy?: boolean;
|
|
999
998
|
}
|
|
1000
|
-
|
|
999
|
+
declare enum Mode {
|
|
1001
1000
|
/** Any of the search terms must be present */
|
|
1002
1001
|
OR = "OR",
|
|
1003
1002
|
/** All search terms must be present */
|
|
1004
1003
|
AND = "AND"
|
|
1005
1004
|
}
|
|
1006
1005
|
/** @enumType */
|
|
1007
|
-
|
|
1008
|
-
|
|
1006
|
+
type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
1007
|
+
interface SearchVariantsResponse {
|
|
1009
1008
|
/** Variants which satisfy the provided query. */
|
|
1010
1009
|
variants?: ReadOnlyVariant[];
|
|
1011
1010
|
/** Paging metadata. Contains cursor which can be used in next query. */
|
|
@@ -1013,14 +1012,14 @@ export interface SearchVariantsResponse {
|
|
|
1013
1012
|
/** Aggregation data. */
|
|
1014
1013
|
aggregationData?: AggregationData;
|
|
1015
1014
|
}
|
|
1016
|
-
|
|
1015
|
+
interface AggregationData {
|
|
1017
1016
|
/**
|
|
1018
1017
|
* key = aggregation name (as derived from search request)
|
|
1019
1018
|
* @maxSize 10000
|
|
1020
1019
|
*/
|
|
1021
1020
|
results?: AggregationResults[];
|
|
1022
1021
|
}
|
|
1023
|
-
|
|
1022
|
+
interface ValueAggregationResult {
|
|
1024
1023
|
/**
|
|
1025
1024
|
* Value of the field
|
|
1026
1025
|
* @maxLength 100
|
|
@@ -1029,7 +1028,7 @@ export interface ValueAggregationResult {
|
|
|
1029
1028
|
/** Count of entities with this value */
|
|
1030
1029
|
count?: number;
|
|
1031
1030
|
}
|
|
1032
|
-
|
|
1031
|
+
interface RangeAggregationResult {
|
|
1033
1032
|
/** Inclusive lower bound of the range */
|
|
1034
1033
|
from?: number | null;
|
|
1035
1034
|
/** Exclusive upper bound of the range */
|
|
@@ -1037,7 +1036,7 @@ export interface RangeAggregationResult {
|
|
|
1037
1036
|
/** Count of entities in this range */
|
|
1038
1037
|
count?: number;
|
|
1039
1038
|
}
|
|
1040
|
-
|
|
1039
|
+
interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
|
|
1041
1040
|
/** Value aggregation results */
|
|
1042
1041
|
values?: ValueResults;
|
|
1043
1042
|
/** Range aggregation results */
|
|
@@ -1058,7 +1057,7 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
|
|
|
1058
1057
|
fieldPath?: string;
|
|
1059
1058
|
}
|
|
1060
1059
|
/** @oneof */
|
|
1061
|
-
|
|
1060
|
+
interface NestedAggregationResultsResultOneOf {
|
|
1062
1061
|
/** Value aggregation results */
|
|
1063
1062
|
values?: ValueResults;
|
|
1064
1063
|
/** Range aggregation results */
|
|
@@ -1066,27 +1065,27 @@ export interface NestedAggregationResultsResultOneOf {
|
|
|
1066
1065
|
/** Scalar aggregation results */
|
|
1067
1066
|
scalar?: AggregationResultsScalarResult;
|
|
1068
1067
|
}
|
|
1069
|
-
|
|
1068
|
+
interface ValueResults {
|
|
1070
1069
|
/**
|
|
1071
1070
|
* List of value aggregations
|
|
1072
1071
|
* @maxSize 250
|
|
1073
1072
|
*/
|
|
1074
1073
|
results?: ValueAggregationResult[];
|
|
1075
1074
|
}
|
|
1076
|
-
|
|
1075
|
+
interface RangeResults {
|
|
1077
1076
|
/**
|
|
1078
1077
|
* List of ranges returned in same order as requested
|
|
1079
1078
|
* @maxSize 50
|
|
1080
1079
|
*/
|
|
1081
1080
|
results?: RangeAggregationResult[];
|
|
1082
1081
|
}
|
|
1083
|
-
|
|
1082
|
+
interface AggregationResultsScalarResult {
|
|
1084
1083
|
/** Type of scalar aggregation */
|
|
1085
1084
|
type?: ScalarTypeWithLiterals;
|
|
1086
1085
|
/** Value of the scalar aggregation */
|
|
1087
1086
|
value?: number;
|
|
1088
1087
|
}
|
|
1089
|
-
|
|
1088
|
+
interface NestedValueAggregationResult {
|
|
1090
1089
|
/**
|
|
1091
1090
|
* Value of the field
|
|
1092
1091
|
* @maxLength 1000
|
|
@@ -1095,7 +1094,7 @@ export interface NestedValueAggregationResult {
|
|
|
1095
1094
|
/** Nested aggregations */
|
|
1096
1095
|
nestedResults?: NestedAggregationResults;
|
|
1097
1096
|
}
|
|
1098
|
-
|
|
1097
|
+
interface ValueResult {
|
|
1099
1098
|
/**
|
|
1100
1099
|
* Value of the field
|
|
1101
1100
|
* @maxLength 1000
|
|
@@ -1104,7 +1103,7 @@ export interface ValueResult {
|
|
|
1104
1103
|
/** Count of entities with this value */
|
|
1105
1104
|
count?: number | null;
|
|
1106
1105
|
}
|
|
1107
|
-
|
|
1106
|
+
interface RangeResult {
|
|
1108
1107
|
/** Inclusive lower bound of the range */
|
|
1109
1108
|
from?: number | null;
|
|
1110
1109
|
/** Exclusive upper bound of the range */
|
|
@@ -1112,11 +1111,11 @@ export interface RangeResult {
|
|
|
1112
1111
|
/** Count of entities in this range */
|
|
1113
1112
|
count?: number | null;
|
|
1114
1113
|
}
|
|
1115
|
-
|
|
1114
|
+
interface ScalarResult {
|
|
1116
1115
|
/** Value of the scalar aggregation */
|
|
1117
1116
|
value?: number;
|
|
1118
1117
|
}
|
|
1119
|
-
|
|
1118
|
+
interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
1120
1119
|
/** Value aggregation result */
|
|
1121
1120
|
value?: ValueResult;
|
|
1122
1121
|
/** Range aggregation result */
|
|
@@ -1127,7 +1126,7 @@ export interface NestedResultValue extends NestedResultValueResultOneOf {
|
|
|
1127
1126
|
dateHistogram?: ValueResult;
|
|
1128
1127
|
}
|
|
1129
1128
|
/** @oneof */
|
|
1130
|
-
|
|
1129
|
+
interface NestedResultValueResultOneOf {
|
|
1131
1130
|
/** Value aggregation result */
|
|
1132
1131
|
value?: ValueResult;
|
|
1133
1132
|
/** Range aggregation result */
|
|
@@ -1137,11 +1136,11 @@ export interface NestedResultValueResultOneOf {
|
|
|
1137
1136
|
/** Date histogram aggregation result */
|
|
1138
1137
|
dateHistogram?: ValueResult;
|
|
1139
1138
|
}
|
|
1140
|
-
|
|
1139
|
+
interface Results {
|
|
1141
1140
|
/** List of nested aggregations */
|
|
1142
1141
|
results?: Record<string, NestedResultValue>;
|
|
1143
1142
|
}
|
|
1144
|
-
|
|
1143
|
+
interface DateHistogramResult {
|
|
1145
1144
|
/**
|
|
1146
1145
|
* Date in ISO 8601 format
|
|
1147
1146
|
* @maxLength 100
|
|
@@ -1150,14 +1149,14 @@ export interface DateHistogramResult {
|
|
|
1150
1149
|
/** Count of documents in the bucket */
|
|
1151
1150
|
count?: number;
|
|
1152
1151
|
}
|
|
1153
|
-
|
|
1152
|
+
interface GroupByValueResults {
|
|
1154
1153
|
/**
|
|
1155
1154
|
* List of value aggregations
|
|
1156
1155
|
* @maxSize 1000
|
|
1157
1156
|
*/
|
|
1158
1157
|
results?: NestedValueAggregationResult[];
|
|
1159
1158
|
}
|
|
1160
|
-
|
|
1159
|
+
interface DateHistogramResults {
|
|
1161
1160
|
/**
|
|
1162
1161
|
* List of date histogram aggregations
|
|
1163
1162
|
* @maxSize 200
|
|
@@ -1168,14 +1167,14 @@ export interface DateHistogramResults {
|
|
|
1168
1167
|
* Results of `NESTED` aggregation type in a flattened form
|
|
1169
1168
|
* aggregations in resulting array are keyed by requested aggregation `name`.
|
|
1170
1169
|
*/
|
|
1171
|
-
|
|
1170
|
+
interface NestedResults {
|
|
1172
1171
|
/**
|
|
1173
1172
|
* List of nested aggregations
|
|
1174
1173
|
* @maxSize 1000
|
|
1175
1174
|
*/
|
|
1176
1175
|
results?: Results[];
|
|
1177
1176
|
}
|
|
1178
|
-
|
|
1177
|
+
interface AggregationResults extends AggregationResultsResultOneOf {
|
|
1179
1178
|
/** Value aggregation results */
|
|
1180
1179
|
values?: ValueResults;
|
|
1181
1180
|
/** Range aggregation results */
|
|
@@ -1202,7 +1201,7 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
|
|
|
1202
1201
|
fieldPath?: string;
|
|
1203
1202
|
}
|
|
1204
1203
|
/** @oneof */
|
|
1205
|
-
|
|
1204
|
+
interface AggregationResultsResultOneOf {
|
|
1206
1205
|
/** Value aggregation results */
|
|
1207
1206
|
values?: ValueResults;
|
|
1208
1207
|
/** Range aggregation results */
|
|
@@ -1216,7 +1215,7 @@ export interface AggregationResultsResultOneOf {
|
|
|
1216
1215
|
/** Nested aggregation results */
|
|
1217
1216
|
nested?: NestedResults;
|
|
1218
1217
|
}
|
|
1219
|
-
|
|
1218
|
+
interface DeprecatedSearchVariantsWithOffsetRequest {
|
|
1220
1219
|
/** Filter and sort with limit/offset based paging */
|
|
1221
1220
|
search?: PlatformOffsetSearch;
|
|
1222
1221
|
/**
|
|
@@ -1225,7 +1224,7 @@ export interface DeprecatedSearchVariantsWithOffsetRequest {
|
|
|
1225
1224
|
*/
|
|
1226
1225
|
fields?: RequestedFieldsWithLiterals[];
|
|
1227
1226
|
}
|
|
1228
|
-
|
|
1227
|
+
interface PlatformOffsetSearch extends PlatformOffsetSearchPagingMethodOneOf {
|
|
1229
1228
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
1230
1229
|
paging?: PlatformPaging;
|
|
1231
1230
|
/** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
|
|
@@ -1238,11 +1237,11 @@ export interface PlatformOffsetSearch extends PlatformOffsetSearchPagingMethodOn
|
|
|
1238
1237
|
search?: CommonSearchDetails;
|
|
1239
1238
|
}
|
|
1240
1239
|
/** @oneof */
|
|
1241
|
-
|
|
1240
|
+
interface PlatformOffsetSearchPagingMethodOneOf {
|
|
1242
1241
|
/** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
|
|
1243
1242
|
paging?: PlatformPaging;
|
|
1244
1243
|
}
|
|
1245
|
-
|
|
1244
|
+
interface CommonSorting {
|
|
1246
1245
|
/**
|
|
1247
1246
|
* Name of the field to sort by.
|
|
1248
1247
|
* @maxLength 512
|
|
@@ -1251,13 +1250,13 @@ export interface CommonSorting {
|
|
|
1251
1250
|
/** Sort order. */
|
|
1252
1251
|
order?: CommonSortOrderWithLiterals;
|
|
1253
1252
|
}
|
|
1254
|
-
|
|
1253
|
+
declare enum CommonSortOrder {
|
|
1255
1254
|
ASC = "ASC",
|
|
1256
1255
|
DESC = "DESC"
|
|
1257
1256
|
}
|
|
1258
1257
|
/** @enumType */
|
|
1259
|
-
|
|
1260
|
-
|
|
1258
|
+
type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
|
|
1259
|
+
interface CommonAggregation extends CommonAggregationKindOneOf {
|
|
1261
1260
|
/** Value aggregation. */
|
|
1262
1261
|
value?: AggregationValueAggregation;
|
|
1263
1262
|
/** Range aggregation. */
|
|
@@ -1289,7 +1288,7 @@ export interface CommonAggregation extends CommonAggregationKindOneOf {
|
|
|
1289
1288
|
groupBy?: GroupByAggregation;
|
|
1290
1289
|
}
|
|
1291
1290
|
/** @oneof */
|
|
1292
|
-
|
|
1291
|
+
interface CommonAggregationKindOneOf {
|
|
1293
1292
|
/** Value aggregation. */
|
|
1294
1293
|
value?: AggregationValueAggregation;
|
|
1295
1294
|
/** Range aggregation. */
|
|
@@ -1301,44 +1300,44 @@ export interface CommonAggregationKindOneOf {
|
|
|
1301
1300
|
/** Nested aggregation. */
|
|
1302
1301
|
nested?: AggregationNestedAggregation;
|
|
1303
1302
|
}
|
|
1304
|
-
|
|
1303
|
+
interface RangeAggregationRangeBucket {
|
|
1305
1304
|
/** Inclusive lower bound of the range. Required if `to` is not provided. */
|
|
1306
1305
|
from?: number | null;
|
|
1307
1306
|
/** Exclusive upper bound of the range. Required if `from` is not provided. */
|
|
1308
1307
|
to?: number | null;
|
|
1309
1308
|
}
|
|
1310
|
-
|
|
1309
|
+
declare enum ValueAggregationSortType {
|
|
1311
1310
|
/** Sort by number of matches. */
|
|
1312
1311
|
COUNT = "COUNT",
|
|
1313
1312
|
/** Sort by value of the field alphabetically. */
|
|
1314
1313
|
VALUE = "VALUE"
|
|
1315
1314
|
}
|
|
1316
1315
|
/** @enumType */
|
|
1317
|
-
|
|
1318
|
-
|
|
1316
|
+
type ValueAggregationSortTypeWithLiterals = ValueAggregationSortType | 'COUNT' | 'VALUE';
|
|
1317
|
+
declare enum ValueAggregationSortDirection {
|
|
1319
1318
|
/** Sort in descending order. */
|
|
1320
1319
|
DESC = "DESC",
|
|
1321
1320
|
/** Sort in ascending order. */
|
|
1322
1321
|
ASC = "ASC"
|
|
1323
1322
|
}
|
|
1324
1323
|
/** @enumType */
|
|
1325
|
-
|
|
1326
|
-
|
|
1324
|
+
type ValueAggregationSortDirectionWithLiterals = ValueAggregationSortDirection | 'DESC' | 'ASC';
|
|
1325
|
+
declare enum ValueAggregationMissingValues {
|
|
1327
1326
|
/** Exclude missing values from the aggregation results. */
|
|
1328
1327
|
EXCLUDE = "EXCLUDE",
|
|
1329
1328
|
/** Include missing values in the aggregation results. */
|
|
1330
1329
|
INCLUDE = "INCLUDE"
|
|
1331
1330
|
}
|
|
1332
1331
|
/** @enumType */
|
|
1333
|
-
|
|
1334
|
-
|
|
1332
|
+
type ValueAggregationMissingValuesWithLiterals = ValueAggregationMissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
1333
|
+
interface ValueAggregationIncludeMissingValuesOptions {
|
|
1335
1334
|
/**
|
|
1336
1335
|
* Specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
|
|
1337
1336
|
* @maxLength 20
|
|
1338
1337
|
*/
|
|
1339
1338
|
addToBucket?: string;
|
|
1340
1339
|
}
|
|
1341
|
-
|
|
1340
|
+
declare enum CommonScalarType {
|
|
1342
1341
|
UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
|
|
1343
1342
|
/** Count of distinct values. */
|
|
1344
1343
|
COUNT_DISTINCT = "COUNT_DISTINCT",
|
|
@@ -1348,8 +1347,8 @@ export declare enum CommonScalarType {
|
|
|
1348
1347
|
MAX = "MAX"
|
|
1349
1348
|
}
|
|
1350
1349
|
/** @enumType */
|
|
1351
|
-
|
|
1352
|
-
|
|
1350
|
+
type CommonScalarTypeWithLiterals = CommonScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
1351
|
+
interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
|
|
1353
1352
|
/** Options for including missing values. */
|
|
1354
1353
|
includeOptions?: ValueAggregationIncludeMissingValuesOptions;
|
|
1355
1354
|
/** Whether to sort by number of matches or value of the field. */
|
|
@@ -1362,11 +1361,11 @@ export interface AggregationValueAggregation extends AggregationValueAggregation
|
|
|
1362
1361
|
missingValues?: ValueAggregationMissingValuesWithLiterals;
|
|
1363
1362
|
}
|
|
1364
1363
|
/** @oneof */
|
|
1365
|
-
|
|
1364
|
+
interface AggregationValueAggregationOptionsOneOf {
|
|
1366
1365
|
/** Options for including missing values. */
|
|
1367
1366
|
includeOptions?: ValueAggregationIncludeMissingValuesOptions;
|
|
1368
1367
|
}
|
|
1369
|
-
|
|
1368
|
+
declare enum NestedAggregationNestedAggregationType {
|
|
1370
1369
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
1371
1370
|
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
1372
1371
|
VALUE = "VALUE",
|
|
@@ -1378,23 +1377,23 @@ export declare enum NestedAggregationNestedAggregationType {
|
|
|
1378
1377
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
1379
1378
|
}
|
|
1380
1379
|
/** @enumType */
|
|
1381
|
-
|
|
1382
|
-
|
|
1380
|
+
type NestedAggregationNestedAggregationTypeWithLiterals = NestedAggregationNestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
1381
|
+
interface AggregationRangeAggregation {
|
|
1383
1382
|
/**
|
|
1384
1383
|
* List of range buckets, where during aggregation each entity will be placed in the first bucket its value falls into, based on the provided range bounds.
|
|
1385
1384
|
* @maxSize 50
|
|
1386
1385
|
*/
|
|
1387
1386
|
buckets?: RangeAggregationRangeBucket[];
|
|
1388
1387
|
}
|
|
1389
|
-
|
|
1388
|
+
interface AggregationScalarAggregation {
|
|
1390
1389
|
/** Define the operator for the scalar aggregation. */
|
|
1391
1390
|
type?: CommonScalarTypeWithLiterals;
|
|
1392
1391
|
}
|
|
1393
|
-
|
|
1392
|
+
interface AggregationDateHistogramAggregation {
|
|
1394
1393
|
/** Interval for date histogram aggregation. */
|
|
1395
1394
|
interval?: DateHistogramAggregationIntervalWithLiterals;
|
|
1396
1395
|
}
|
|
1397
|
-
|
|
1396
|
+
declare enum DateHistogramAggregationInterval {
|
|
1398
1397
|
UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
|
|
1399
1398
|
/** Yearly interval */
|
|
1400
1399
|
YEAR = "YEAR",
|
|
@@ -1412,8 +1411,8 @@ export declare enum DateHistogramAggregationInterval {
|
|
|
1412
1411
|
SECOND = "SECOND"
|
|
1413
1412
|
}
|
|
1414
1413
|
/** @enumType */
|
|
1415
|
-
|
|
1416
|
-
|
|
1414
|
+
type DateHistogramAggregationIntervalWithLiterals = DateHistogramAggregationInterval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
1415
|
+
interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
|
|
1417
1416
|
/** Value aggregation. */
|
|
1418
1417
|
value?: AggregationValueAggregation;
|
|
1419
1418
|
/** Range aggregation. */
|
|
@@ -1436,7 +1435,7 @@ export interface NestedAggregationNestedAggregationItem extends NestedAggregatio
|
|
|
1436
1435
|
fieldPath?: string;
|
|
1437
1436
|
}
|
|
1438
1437
|
/** @oneof */
|
|
1439
|
-
|
|
1438
|
+
interface NestedAggregationNestedAggregationItemKindOneOf {
|
|
1440
1439
|
/** Value aggregation. */
|
|
1441
1440
|
value?: AggregationValueAggregation;
|
|
1442
1441
|
/** Range aggregation. */
|
|
@@ -1446,7 +1445,7 @@ export interface NestedAggregationNestedAggregationItemKindOneOf {
|
|
|
1446
1445
|
/** Date histogram aggregation. */
|
|
1447
1446
|
dateHistogram?: AggregationDateHistogramAggregation;
|
|
1448
1447
|
}
|
|
1449
|
-
|
|
1448
|
+
declare enum CommonAggregationType {
|
|
1450
1449
|
UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
|
|
1451
1450
|
/** An aggregation where result buckets are dynamically built - one per unique value. */
|
|
1452
1451
|
VALUE = "VALUE",
|
|
@@ -1460,9 +1459,9 @@ export declare enum CommonAggregationType {
|
|
|
1460
1459
|
NESTED = "NESTED"
|
|
1461
1460
|
}
|
|
1462
1461
|
/** @enumType */
|
|
1463
|
-
|
|
1462
|
+
type CommonAggregationTypeWithLiterals = CommonAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
1464
1463
|
/** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
|
|
1465
|
-
|
|
1464
|
+
interface AggregationNestedAggregation {
|
|
1466
1465
|
/**
|
|
1467
1466
|
* Flattened list of aggregations, where each next aggregation is nested within previous one.
|
|
1468
1467
|
* @minSize 2
|
|
@@ -1470,7 +1469,7 @@ export interface AggregationNestedAggregation {
|
|
|
1470
1469
|
*/
|
|
1471
1470
|
nestedAggregations?: NestedAggregationNestedAggregationItem[];
|
|
1472
1471
|
}
|
|
1473
|
-
|
|
1472
|
+
interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
1474
1473
|
/** Value aggregation configuration. */
|
|
1475
1474
|
value?: AggregationValueAggregation;
|
|
1476
1475
|
/**
|
|
@@ -1485,11 +1484,11 @@ export interface GroupByAggregation extends GroupByAggregationKindOneOf {
|
|
|
1485
1484
|
fieldPath?: string;
|
|
1486
1485
|
}
|
|
1487
1486
|
/** @oneof */
|
|
1488
|
-
|
|
1487
|
+
interface GroupByAggregationKindOneOf {
|
|
1489
1488
|
/** Value aggregation configuration. */
|
|
1490
1489
|
value?: AggregationValueAggregation;
|
|
1491
1490
|
}
|
|
1492
|
-
|
|
1491
|
+
interface CommonSearchDetails {
|
|
1493
1492
|
/** Defines how separate search terms in `expression` are combined. */
|
|
1494
1493
|
mode?: SearchDetailsModeWithLiterals;
|
|
1495
1494
|
/**
|
|
@@ -1506,15 +1505,15 @@ export interface CommonSearchDetails {
|
|
|
1506
1505
|
/** Whether to use auto fuzzy search (allowing typos by a managed proximity algorithm). */
|
|
1507
1506
|
fuzzy?: boolean;
|
|
1508
1507
|
}
|
|
1509
|
-
|
|
1508
|
+
declare enum SearchDetailsMode {
|
|
1510
1509
|
/** Any of the search terms must be present. */
|
|
1511
1510
|
OR = "OR",
|
|
1512
1511
|
/** All search terms must be present. */
|
|
1513
1512
|
AND = "AND"
|
|
1514
1513
|
}
|
|
1515
1514
|
/** @enumType */
|
|
1516
|
-
|
|
1517
|
-
|
|
1515
|
+
type SearchDetailsModeWithLiterals = SearchDetailsMode | 'OR' | 'AND';
|
|
1516
|
+
interface PlatformPaging {
|
|
1518
1517
|
/**
|
|
1519
1518
|
* Number of items to load.
|
|
1520
1519
|
* @max 100
|
|
@@ -1523,7 +1522,7 @@ export interface PlatformPaging {
|
|
|
1523
1522
|
/** Number of items to skip in the current sort order. */
|
|
1524
1523
|
offset?: number | null;
|
|
1525
1524
|
}
|
|
1526
|
-
|
|
1525
|
+
interface DeprecatedSearchVariantsWithOffsetResponse {
|
|
1527
1526
|
/** Products which satisfy the provided query. */
|
|
1528
1527
|
variants?: ReadOnlyVariant[];
|
|
1529
1528
|
/** Paging metadata. */
|
|
@@ -1531,7 +1530,7 @@ export interface DeprecatedSearchVariantsWithOffsetResponse {
|
|
|
1531
1530
|
/** Aggregation data. */
|
|
1532
1531
|
aggregationData?: Aggregation;
|
|
1533
1532
|
}
|
|
1534
|
-
|
|
1533
|
+
interface PagingMetadata {
|
|
1535
1534
|
/** Number of items returned in the response. */
|
|
1536
1535
|
count?: number | null;
|
|
1537
1536
|
/** Offset that was requested. */
|
|
@@ -1541,13 +1540,13 @@ export interface PagingMetadata {
|
|
|
1541
1540
|
/** Flag that indicates the server failed to calculate the `total` field. */
|
|
1542
1541
|
tooManyToCount?: boolean | null;
|
|
1543
1542
|
}
|
|
1544
|
-
|
|
1543
|
+
interface MigrateProductVariantsRequest {
|
|
1545
1544
|
/** The product */
|
|
1546
1545
|
product?: Product;
|
|
1547
1546
|
/** The event sequence number of the product. */
|
|
1548
1547
|
eventSequence?: string | null;
|
|
1549
1548
|
}
|
|
1550
|
-
|
|
1549
|
+
interface Product extends ProductTypedPropertiesOneOf {
|
|
1551
1550
|
/**
|
|
1552
1551
|
* Physical properties.
|
|
1553
1552
|
*
|
|
@@ -1772,7 +1771,7 @@ export interface Product extends ProductTypedPropertiesOneOf {
|
|
|
1772
1771
|
variantSummary?: VariantSummary;
|
|
1773
1772
|
}
|
|
1774
1773
|
/** @oneof */
|
|
1775
|
-
|
|
1774
|
+
interface ProductTypedPropertiesOneOf {
|
|
1776
1775
|
/**
|
|
1777
1776
|
* Physical properties.
|
|
1778
1777
|
*
|
|
@@ -1780,7 +1779,7 @@ export interface ProductTypedPropertiesOneOf {
|
|
|
1780
1779
|
*/
|
|
1781
1780
|
physicalProperties?: PhysicalProperties;
|
|
1782
1781
|
}
|
|
1783
|
-
|
|
1782
|
+
interface RichContent {
|
|
1784
1783
|
/** Node objects representing a rich content document. */
|
|
1785
1784
|
nodes?: Node[];
|
|
1786
1785
|
/** Object metadata. */
|
|
@@ -1788,7 +1787,7 @@ export interface RichContent {
|
|
|
1788
1787
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1789
1788
|
documentStyle?: DocumentStyle;
|
|
1790
1789
|
}
|
|
1791
|
-
|
|
1790
|
+
interface Node extends NodeDataOneOf {
|
|
1792
1791
|
/** Data for a button node. */
|
|
1793
1792
|
buttonData?: ButtonData;
|
|
1794
1793
|
/** Data for a code block node. */
|
|
@@ -1853,7 +1852,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1853
1852
|
style?: NodeStyle;
|
|
1854
1853
|
}
|
|
1855
1854
|
/** @oneof */
|
|
1856
|
-
|
|
1855
|
+
interface NodeDataOneOf {
|
|
1857
1856
|
/** Data for a button node. */
|
|
1858
1857
|
buttonData?: ButtonData;
|
|
1859
1858
|
/** Data for a code block node. */
|
|
@@ -1909,7 +1908,7 @@ export interface NodeDataOneOf {
|
|
|
1909
1908
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1910
1909
|
layoutCellData?: LayoutCellData;
|
|
1911
1910
|
}
|
|
1912
|
-
|
|
1911
|
+
declare enum NodeType {
|
|
1913
1912
|
PARAGRAPH = "PARAGRAPH",
|
|
1914
1913
|
TEXT = "TEXT",
|
|
1915
1914
|
HEADING = "HEADING",
|
|
@@ -1946,8 +1945,8 @@ export declare enum NodeType {
|
|
|
1946
1945
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1947
1946
|
}
|
|
1948
1947
|
/** @enumType */
|
|
1949
|
-
|
|
1950
|
-
|
|
1948
|
+
type NodeTypeWithLiterals = NodeType | 'PARAGRAPH' | 'TEXT' | 'HEADING' | 'BULLETED_LIST' | 'ORDERED_LIST' | 'LIST_ITEM' | 'BLOCKQUOTE' | 'CODE_BLOCK' | 'VIDEO' | 'DIVIDER' | 'FILE' | 'GALLERY' | 'GIF' | 'HTML' | 'IMAGE' | 'LINK_PREVIEW' | 'MAP' | 'POLL' | 'APP_EMBED' | 'BUTTON' | 'COLLAPSIBLE_LIST' | 'TABLE' | 'EMBED' | 'COLLAPSIBLE_ITEM' | 'COLLAPSIBLE_ITEM_TITLE' | 'COLLAPSIBLE_ITEM_BODY' | 'TABLE_CELL' | 'TABLE_ROW' | 'EXTERNAL' | 'AUDIO' | 'CAPTION' | 'LAYOUT' | 'LAYOUT_CELL';
|
|
1949
|
+
interface NodeStyle {
|
|
1951
1950
|
/** The top padding value in pixels. */
|
|
1952
1951
|
paddingTop?: string | null;
|
|
1953
1952
|
/** The bottom padding value in pixels. */
|
|
@@ -1955,7 +1954,7 @@ export interface NodeStyle {
|
|
|
1955
1954
|
/** The background color as a hexadecimal value. */
|
|
1956
1955
|
backgroundColor?: string | null;
|
|
1957
1956
|
}
|
|
1958
|
-
|
|
1957
|
+
interface ButtonData {
|
|
1959
1958
|
/** Styling for the button's container. */
|
|
1960
1959
|
containerData?: PluginContainerData;
|
|
1961
1960
|
/** The button type. */
|
|
@@ -1967,7 +1966,7 @@ export interface ButtonData {
|
|
|
1967
1966
|
/** Button link details. */
|
|
1968
1967
|
link?: Link;
|
|
1969
1968
|
}
|
|
1970
|
-
|
|
1969
|
+
interface Border {
|
|
1971
1970
|
/**
|
|
1972
1971
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
1973
1972
|
* @deprecated
|
|
@@ -1979,7 +1978,7 @@ export interface Border {
|
|
|
1979
1978
|
*/
|
|
1980
1979
|
radius?: number | null;
|
|
1981
1980
|
}
|
|
1982
|
-
|
|
1981
|
+
interface Colors {
|
|
1983
1982
|
/**
|
|
1984
1983
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
1985
1984
|
* @deprecated
|
|
@@ -1996,7 +1995,7 @@ export interface Colors {
|
|
|
1996
1995
|
*/
|
|
1997
1996
|
background?: string | null;
|
|
1998
1997
|
}
|
|
1999
|
-
|
|
1998
|
+
interface PluginContainerData {
|
|
2000
1999
|
/** The width of the node when it's displayed. */
|
|
2001
2000
|
width?: PluginContainerDataWidth;
|
|
2002
2001
|
/** The node's alignment within its container. */
|
|
@@ -2008,7 +2007,7 @@ export interface PluginContainerData {
|
|
|
2008
2007
|
/** Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`. */
|
|
2009
2008
|
textWrap?: boolean | null;
|
|
2010
2009
|
}
|
|
2011
|
-
|
|
2010
|
+
declare enum WidthType {
|
|
2012
2011
|
/** Width matches the content width */
|
|
2013
2012
|
CONTENT = "CONTENT",
|
|
2014
2013
|
/** Small Width */
|
|
@@ -2019,8 +2018,8 @@ export declare enum WidthType {
|
|
|
2019
2018
|
FULL_WIDTH = "FULL_WIDTH"
|
|
2020
2019
|
}
|
|
2021
2020
|
/** @enumType */
|
|
2022
|
-
|
|
2023
|
-
|
|
2021
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
2022
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
2024
2023
|
/**
|
|
2025
2024
|
* One of the following predefined width options:
|
|
2026
2025
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -2033,7 +2032,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
2033
2032
|
custom?: string | null;
|
|
2034
2033
|
}
|
|
2035
2034
|
/** @oneof */
|
|
2036
|
-
|
|
2035
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
2037
2036
|
/**
|
|
2038
2037
|
* One of the following predefined width options:
|
|
2039
2038
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -2045,7 +2044,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
2045
2044
|
/** A custom width value in pixels. */
|
|
2046
2045
|
custom?: string | null;
|
|
2047
2046
|
}
|
|
2048
|
-
|
|
2047
|
+
declare enum PluginContainerDataAlignment {
|
|
2049
2048
|
/** Center Alignment */
|
|
2050
2049
|
CENTER = "CENTER",
|
|
2051
2050
|
/** Left Alignment */
|
|
@@ -2054,8 +2053,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
2054
2053
|
RIGHT = "RIGHT"
|
|
2055
2054
|
}
|
|
2056
2055
|
/** @enumType */
|
|
2057
|
-
|
|
2058
|
-
|
|
2056
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
2057
|
+
interface Spoiler {
|
|
2059
2058
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
2060
2059
|
enabled?: boolean | null;
|
|
2061
2060
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -2063,19 +2062,19 @@ export interface Spoiler {
|
|
|
2063
2062
|
/** The text for the button used to remove the spoiler cover. */
|
|
2064
2063
|
buttonText?: string | null;
|
|
2065
2064
|
}
|
|
2066
|
-
|
|
2065
|
+
interface Height {
|
|
2067
2066
|
/** A custom height value in pixels. */
|
|
2068
2067
|
custom?: string | null;
|
|
2069
2068
|
}
|
|
2070
|
-
|
|
2069
|
+
declare enum Type {
|
|
2071
2070
|
/** Regular link button */
|
|
2072
2071
|
LINK = "LINK",
|
|
2073
2072
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
2074
2073
|
ACTION = "ACTION"
|
|
2075
2074
|
}
|
|
2076
2075
|
/** @enumType */
|
|
2077
|
-
|
|
2078
|
-
|
|
2076
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
2077
|
+
interface Styles {
|
|
2079
2078
|
/**
|
|
2080
2079
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
2081
2080
|
* @deprecated
|
|
@@ -2128,7 +2127,7 @@ export interface Styles {
|
|
|
2128
2127
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
2129
2128
|
buttonSize?: string | null;
|
|
2130
2129
|
}
|
|
2131
|
-
|
|
2130
|
+
interface Link extends LinkDataOneOf {
|
|
2132
2131
|
/** The absolute URL for the linked document. */
|
|
2133
2132
|
url?: string;
|
|
2134
2133
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -2147,13 +2146,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
2147
2146
|
customData?: string | null;
|
|
2148
2147
|
}
|
|
2149
2148
|
/** @oneof */
|
|
2150
|
-
|
|
2149
|
+
interface LinkDataOneOf {
|
|
2151
2150
|
/** The absolute URL for the linked document. */
|
|
2152
2151
|
url?: string;
|
|
2153
2152
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
2154
2153
|
anchor?: string;
|
|
2155
2154
|
}
|
|
2156
|
-
|
|
2155
|
+
declare enum Target {
|
|
2157
2156
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
2158
2157
|
SELF = "SELF",
|
|
2159
2158
|
/** Opens the linked document in a new window or tab */
|
|
@@ -2164,8 +2163,8 @@ export declare enum Target {
|
|
|
2164
2163
|
TOP = "TOP"
|
|
2165
2164
|
}
|
|
2166
2165
|
/** @enumType */
|
|
2167
|
-
|
|
2168
|
-
|
|
2166
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
2167
|
+
interface Rel {
|
|
2169
2168
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
2170
2169
|
nofollow?: boolean | null;
|
|
2171
2170
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -2175,17 +2174,17 @@ export interface Rel {
|
|
|
2175
2174
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
2176
2175
|
noreferrer?: boolean | null;
|
|
2177
2176
|
}
|
|
2178
|
-
|
|
2177
|
+
interface CodeBlockData {
|
|
2179
2178
|
/** Styling for the code block's text. */
|
|
2180
2179
|
textStyle?: TextStyle;
|
|
2181
2180
|
}
|
|
2182
|
-
|
|
2181
|
+
interface TextStyle {
|
|
2183
2182
|
/** Text alignment. Defaults to `AUTO`. */
|
|
2184
2183
|
textAlignment?: TextAlignmentWithLiterals;
|
|
2185
2184
|
/** A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px. */
|
|
2186
2185
|
lineHeight?: string | null;
|
|
2187
2186
|
}
|
|
2188
|
-
|
|
2187
|
+
declare enum TextAlignment {
|
|
2189
2188
|
/** browser default, eqivalent to `initial` */
|
|
2190
2189
|
AUTO = "AUTO",
|
|
2191
2190
|
/** Left align */
|
|
@@ -2198,8 +2197,8 @@ export declare enum TextAlignment {
|
|
|
2198
2197
|
JUSTIFY = "JUSTIFY"
|
|
2199
2198
|
}
|
|
2200
2199
|
/** @enumType */
|
|
2201
|
-
|
|
2202
|
-
|
|
2200
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
2201
|
+
interface DividerData {
|
|
2203
2202
|
/** Styling for the divider's container. */
|
|
2204
2203
|
containerData?: PluginContainerData;
|
|
2205
2204
|
/** Divider line style. */
|
|
@@ -2209,7 +2208,7 @@ export interface DividerData {
|
|
|
2209
2208
|
/** Divider alignment. */
|
|
2210
2209
|
alignment?: AlignmentWithLiterals;
|
|
2211
2210
|
}
|
|
2212
|
-
|
|
2211
|
+
declare enum LineStyle {
|
|
2213
2212
|
/** Single Line */
|
|
2214
2213
|
SINGLE = "SINGLE",
|
|
2215
2214
|
/** Double Line */
|
|
@@ -2220,8 +2219,8 @@ export declare enum LineStyle {
|
|
|
2220
2219
|
DOTTED = "DOTTED"
|
|
2221
2220
|
}
|
|
2222
2221
|
/** @enumType */
|
|
2223
|
-
|
|
2224
|
-
|
|
2222
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
2223
|
+
declare enum Width {
|
|
2225
2224
|
/** Large line */
|
|
2226
2225
|
LARGE = "LARGE",
|
|
2227
2226
|
/** Medium line */
|
|
@@ -2230,8 +2229,8 @@ export declare enum Width {
|
|
|
2230
2229
|
SMALL = "SMALL"
|
|
2231
2230
|
}
|
|
2232
2231
|
/** @enumType */
|
|
2233
|
-
|
|
2234
|
-
|
|
2232
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
2233
|
+
declare enum Alignment {
|
|
2235
2234
|
/** Center alignment */
|
|
2236
2235
|
CENTER = "CENTER",
|
|
2237
2236
|
/** Left alignment */
|
|
@@ -2240,8 +2239,8 @@ export declare enum Alignment {
|
|
|
2240
2239
|
RIGHT = "RIGHT"
|
|
2241
2240
|
}
|
|
2242
2241
|
/** @enumType */
|
|
2243
|
-
|
|
2244
|
-
|
|
2242
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
2243
|
+
interface FileData {
|
|
2245
2244
|
/** Styling for the file's container. */
|
|
2246
2245
|
containerData?: PluginContainerData;
|
|
2247
2246
|
/** The source for the file's data. */
|
|
@@ -2264,7 +2263,7 @@ export interface FileData {
|
|
|
2264
2263
|
/** File size in KB. */
|
|
2265
2264
|
sizeInKb?: string | null;
|
|
2266
2265
|
}
|
|
2267
|
-
|
|
2266
|
+
declare enum ViewMode {
|
|
2268
2267
|
/** No PDF view */
|
|
2269
2268
|
NONE = "NONE",
|
|
2270
2269
|
/** Full PDF view */
|
|
@@ -2273,8 +2272,8 @@ export declare enum ViewMode {
|
|
|
2273
2272
|
MINI = "MINI"
|
|
2274
2273
|
}
|
|
2275
2274
|
/** @enumType */
|
|
2276
|
-
|
|
2277
|
-
|
|
2275
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
2276
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
2278
2277
|
/** The absolute URL for the file's source. */
|
|
2279
2278
|
url?: string | null;
|
|
2280
2279
|
/**
|
|
@@ -2288,7 +2287,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
2288
2287
|
private?: boolean | null;
|
|
2289
2288
|
}
|
|
2290
2289
|
/** @oneof */
|
|
2291
|
-
|
|
2290
|
+
interface FileSourceDataOneOf {
|
|
2292
2291
|
/** The absolute URL for the file's source. */
|
|
2293
2292
|
url?: string | null;
|
|
2294
2293
|
/**
|
|
@@ -2299,7 +2298,7 @@ export interface FileSourceDataOneOf {
|
|
|
2299
2298
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
2300
2299
|
id?: string | null;
|
|
2301
2300
|
}
|
|
2302
|
-
|
|
2301
|
+
interface PDFSettings {
|
|
2303
2302
|
/**
|
|
2304
2303
|
* PDF view mode. One of the following:
|
|
2305
2304
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -2312,7 +2311,7 @@ export interface PDFSettings {
|
|
|
2312
2311
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
2313
2312
|
disablePrint?: boolean | null;
|
|
2314
2313
|
}
|
|
2315
|
-
|
|
2314
|
+
interface GalleryData {
|
|
2316
2315
|
/** Styling for the gallery's container. */
|
|
2317
2316
|
containerData?: PluginContainerData;
|
|
2318
2317
|
/** The items in the gallery. */
|
|
@@ -2324,7 +2323,7 @@ export interface GalleryData {
|
|
|
2324
2323
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
2325
2324
|
disableDownload?: boolean | null;
|
|
2326
2325
|
}
|
|
2327
|
-
|
|
2326
|
+
interface V1Media {
|
|
2328
2327
|
/** The source for the media's data. */
|
|
2329
2328
|
src?: FileSource;
|
|
2330
2329
|
/** Media width in pixels. */
|
|
@@ -2334,19 +2333,19 @@ export interface V1Media {
|
|
|
2334
2333
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
2335
2334
|
duration?: number | null;
|
|
2336
2335
|
}
|
|
2337
|
-
|
|
2336
|
+
interface Image {
|
|
2338
2337
|
/** Image file details. */
|
|
2339
2338
|
media?: V1Media;
|
|
2340
2339
|
/** Link details for images that are links. */
|
|
2341
2340
|
link?: Link;
|
|
2342
2341
|
}
|
|
2343
|
-
|
|
2342
|
+
interface Video {
|
|
2344
2343
|
/** Video file details. */
|
|
2345
2344
|
media?: V1Media;
|
|
2346
2345
|
/** Video thumbnail file details. */
|
|
2347
2346
|
thumbnail?: V1Media;
|
|
2348
2347
|
}
|
|
2349
|
-
|
|
2348
|
+
interface Item extends ItemDataOneOf {
|
|
2350
2349
|
/** An image item. */
|
|
2351
2350
|
image?: Image;
|
|
2352
2351
|
/** A video item. */
|
|
@@ -2357,13 +2356,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
2357
2356
|
altText?: string | null;
|
|
2358
2357
|
}
|
|
2359
2358
|
/** @oneof */
|
|
2360
|
-
|
|
2359
|
+
interface ItemDataOneOf {
|
|
2361
2360
|
/** An image item. */
|
|
2362
2361
|
image?: Image;
|
|
2363
2362
|
/** A video item. */
|
|
2364
2363
|
video?: Video;
|
|
2365
2364
|
}
|
|
2366
|
-
|
|
2365
|
+
interface GalleryOptions {
|
|
2367
2366
|
/** Gallery layout. */
|
|
2368
2367
|
layout?: Layout;
|
|
2369
2368
|
/** Styling for gallery items. */
|
|
@@ -2371,7 +2370,7 @@ export interface GalleryOptions {
|
|
|
2371
2370
|
/** Styling for gallery thumbnail images. */
|
|
2372
2371
|
thumbnails?: Thumbnails;
|
|
2373
2372
|
}
|
|
2374
|
-
|
|
2373
|
+
declare enum LayoutType {
|
|
2375
2374
|
/** Collage type */
|
|
2376
2375
|
COLLAGE = "COLLAGE",
|
|
2377
2376
|
/** Masonry type */
|
|
@@ -2394,24 +2393,24 @@ export declare enum LayoutType {
|
|
|
2394
2393
|
FULLSIZE = "FULLSIZE"
|
|
2395
2394
|
}
|
|
2396
2395
|
/** @enumType */
|
|
2397
|
-
|
|
2398
|
-
|
|
2396
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
2397
|
+
declare enum Orientation {
|
|
2399
2398
|
/** Rows Orientation */
|
|
2400
2399
|
ROWS = "ROWS",
|
|
2401
2400
|
/** Columns Orientation */
|
|
2402
2401
|
COLUMNS = "COLUMNS"
|
|
2403
2402
|
}
|
|
2404
2403
|
/** @enumType */
|
|
2405
|
-
|
|
2406
|
-
|
|
2404
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
2405
|
+
declare enum Crop {
|
|
2407
2406
|
/** Crop to fill */
|
|
2408
2407
|
FILL = "FILL",
|
|
2409
2408
|
/** Crop to fit */
|
|
2410
2409
|
FIT = "FIT"
|
|
2411
2410
|
}
|
|
2412
2411
|
/** @enumType */
|
|
2413
|
-
|
|
2414
|
-
|
|
2412
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
2413
|
+
declare enum ThumbnailsAlignment {
|
|
2415
2414
|
/** Top alignment */
|
|
2416
2415
|
TOP = "TOP",
|
|
2417
2416
|
/** Right alignment */
|
|
@@ -2424,8 +2423,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
2424
2423
|
NONE = "NONE"
|
|
2425
2424
|
}
|
|
2426
2425
|
/** @enumType */
|
|
2427
|
-
|
|
2428
|
-
|
|
2426
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
2427
|
+
interface Layout {
|
|
2429
2428
|
/** Gallery layout type. */
|
|
2430
2429
|
type?: LayoutTypeWithLiterals;
|
|
2431
2430
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -2437,7 +2436,7 @@ export interface Layout {
|
|
|
2437
2436
|
/** The number of columns to display on mobile screens. */
|
|
2438
2437
|
mobileNumberOfColumns?: number | null;
|
|
2439
2438
|
}
|
|
2440
|
-
|
|
2439
|
+
interface ItemStyle {
|
|
2441
2440
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
2442
2441
|
targetSize?: number | null;
|
|
2443
2442
|
/** Item ratio */
|
|
@@ -2447,13 +2446,13 @@ export interface ItemStyle {
|
|
|
2447
2446
|
/** The spacing between items in pixels. */
|
|
2448
2447
|
spacing?: number | null;
|
|
2449
2448
|
}
|
|
2450
|
-
|
|
2449
|
+
interface Thumbnails {
|
|
2451
2450
|
/** Thumbnail alignment. */
|
|
2452
2451
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
2453
2452
|
/** Spacing between thumbnails in pixels. */
|
|
2454
2453
|
spacing?: number | null;
|
|
2455
2454
|
}
|
|
2456
|
-
|
|
2455
|
+
interface GIFData {
|
|
2457
2456
|
/** Styling for the GIF's container. */
|
|
2458
2457
|
containerData?: PluginContainerData;
|
|
2459
2458
|
/** The source of the full size GIF. */
|
|
@@ -2467,7 +2466,7 @@ export interface GIFData {
|
|
|
2467
2466
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
2468
2467
|
gifType?: GIFTypeWithLiterals;
|
|
2469
2468
|
}
|
|
2470
|
-
|
|
2469
|
+
interface GIF {
|
|
2471
2470
|
/**
|
|
2472
2471
|
* GIF format URL.
|
|
2473
2472
|
* @format WEB_URL
|
|
@@ -2484,13 +2483,13 @@ export interface GIF {
|
|
|
2484
2483
|
*/
|
|
2485
2484
|
still?: string | null;
|
|
2486
2485
|
}
|
|
2487
|
-
|
|
2486
|
+
declare enum GIFType {
|
|
2488
2487
|
NORMAL = "NORMAL",
|
|
2489
2488
|
STICKER = "STICKER"
|
|
2490
2489
|
}
|
|
2491
2490
|
/** @enumType */
|
|
2492
|
-
|
|
2493
|
-
|
|
2491
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
2492
|
+
interface HeadingData {
|
|
2494
2493
|
/** Heading level from 1-6. */
|
|
2495
2494
|
level?: number;
|
|
2496
2495
|
/** Styling for the heading text. */
|
|
@@ -2498,7 +2497,7 @@ export interface HeadingData {
|
|
|
2498
2497
|
/** Indentation level from 1-4. */
|
|
2499
2498
|
indentation?: number | null;
|
|
2500
2499
|
}
|
|
2501
|
-
|
|
2500
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
2502
2501
|
/** The URL for the HTML code for the node. */
|
|
2503
2502
|
url?: string;
|
|
2504
2503
|
/** The HTML code for the node. */
|
|
@@ -2516,7 +2515,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
2516
2515
|
autoHeight?: boolean | null;
|
|
2517
2516
|
}
|
|
2518
2517
|
/** @oneof */
|
|
2519
|
-
|
|
2518
|
+
interface HTMLDataDataOneOf {
|
|
2520
2519
|
/** The URL for the HTML code for the node. */
|
|
2521
2520
|
url?: string;
|
|
2522
2521
|
/** The HTML code for the node. */
|
|
@@ -2527,13 +2526,13 @@ export interface HTMLDataDataOneOf {
|
|
|
2527
2526
|
*/
|
|
2528
2527
|
isAdsense?: boolean | null;
|
|
2529
2528
|
}
|
|
2530
|
-
|
|
2529
|
+
declare enum Source {
|
|
2531
2530
|
HTML = "HTML",
|
|
2532
2531
|
ADSENSE = "ADSENSE"
|
|
2533
2532
|
}
|
|
2534
2533
|
/** @enumType */
|
|
2535
|
-
|
|
2536
|
-
|
|
2534
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
2535
|
+
interface ImageData {
|
|
2537
2536
|
/** Styling for the image's container. */
|
|
2538
2537
|
containerData?: PluginContainerData;
|
|
2539
2538
|
/** Image file details. */
|
|
@@ -2556,7 +2555,7 @@ export interface ImageData {
|
|
|
2556
2555
|
/** Styling for the image. */
|
|
2557
2556
|
styles?: ImageDataStyles;
|
|
2558
2557
|
}
|
|
2559
|
-
|
|
2558
|
+
interface StylesBorder {
|
|
2560
2559
|
/** Border width in pixels. */
|
|
2561
2560
|
width?: number | null;
|
|
2562
2561
|
/**
|
|
@@ -2567,11 +2566,11 @@ export interface StylesBorder {
|
|
|
2567
2566
|
/** Border radius in pixels. */
|
|
2568
2567
|
radius?: number | null;
|
|
2569
2568
|
}
|
|
2570
|
-
|
|
2569
|
+
interface ImageDataStyles {
|
|
2571
2570
|
/** Border attributes. */
|
|
2572
2571
|
border?: StylesBorder;
|
|
2573
2572
|
}
|
|
2574
|
-
|
|
2573
|
+
interface LinkPreviewData {
|
|
2575
2574
|
/** Styling for the link preview's container. */
|
|
2576
2575
|
containerData?: PluginContainerData;
|
|
2577
2576
|
/** Link details. */
|
|
@@ -2587,7 +2586,7 @@ export interface LinkPreviewData {
|
|
|
2587
2586
|
/** Styling for the link preview. */
|
|
2588
2587
|
styles?: LinkPreviewDataStyles;
|
|
2589
2588
|
}
|
|
2590
|
-
|
|
2589
|
+
declare enum Position {
|
|
2591
2590
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
2592
2591
|
START = "START",
|
|
2593
2592
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -2598,8 +2597,8 @@ export declare enum Position {
|
|
|
2598
2597
|
HIDDEN = "HIDDEN"
|
|
2599
2598
|
}
|
|
2600
2599
|
/** @enumType */
|
|
2601
|
-
|
|
2602
|
-
|
|
2600
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2601
|
+
interface LinkPreviewDataStyles {
|
|
2603
2602
|
/**
|
|
2604
2603
|
* Background color as a hexadecimal value.
|
|
2605
2604
|
* @format COLOR_HEX
|
|
@@ -2632,13 +2631,13 @@ export interface LinkPreviewDataStyles {
|
|
|
2632
2631
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2633
2632
|
thumbnailPosition?: PositionWithLiterals;
|
|
2634
2633
|
}
|
|
2635
|
-
|
|
2634
|
+
interface MapData {
|
|
2636
2635
|
/** Styling for the map's container. */
|
|
2637
2636
|
containerData?: PluginContainerData;
|
|
2638
2637
|
/** Map settings. */
|
|
2639
2638
|
mapSettings?: MapSettings;
|
|
2640
2639
|
}
|
|
2641
|
-
|
|
2640
|
+
interface MapSettings {
|
|
2642
2641
|
/** The address to display on the map. */
|
|
2643
2642
|
address?: string | null;
|
|
2644
2643
|
/** Sets whether the map is draggable. */
|
|
@@ -2662,7 +2661,7 @@ export interface MapSettings {
|
|
|
2662
2661
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2663
2662
|
mapType?: MapTypeWithLiterals;
|
|
2664
2663
|
}
|
|
2665
|
-
|
|
2664
|
+
declare enum MapType {
|
|
2666
2665
|
/** Roadmap map type */
|
|
2667
2666
|
ROADMAP = "ROADMAP",
|
|
2668
2667
|
/** Satellite map type */
|
|
@@ -2673,8 +2672,8 @@ export declare enum MapType {
|
|
|
2673
2672
|
TERRAIN = "TERRAIN"
|
|
2674
2673
|
}
|
|
2675
2674
|
/** @enumType */
|
|
2676
|
-
|
|
2677
|
-
|
|
2675
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2676
|
+
interface ParagraphData {
|
|
2678
2677
|
/** Styling for the paragraph text. */
|
|
2679
2678
|
textStyle?: TextStyle;
|
|
2680
2679
|
/** Indentation level from 1-4. */
|
|
@@ -2682,7 +2681,7 @@ export interface ParagraphData {
|
|
|
2682
2681
|
/** Paragraph level */
|
|
2683
2682
|
level?: number | null;
|
|
2684
2683
|
}
|
|
2685
|
-
|
|
2684
|
+
interface PollData {
|
|
2686
2685
|
/** Styling for the poll's container. */
|
|
2687
2686
|
containerData?: PluginContainerData;
|
|
2688
2687
|
/** Poll data. */
|
|
@@ -2692,7 +2691,7 @@ export interface PollData {
|
|
|
2692
2691
|
/** Styling for the poll and voting options. */
|
|
2693
2692
|
design?: Design;
|
|
2694
2693
|
}
|
|
2695
|
-
|
|
2694
|
+
declare enum ViewRole {
|
|
2696
2695
|
/** Only Poll creator can view the results */
|
|
2697
2696
|
CREATOR = "CREATOR",
|
|
2698
2697
|
/** Anyone who voted can see the results */
|
|
@@ -2701,16 +2700,16 @@ export declare enum ViewRole {
|
|
|
2701
2700
|
EVERYONE = "EVERYONE"
|
|
2702
2701
|
}
|
|
2703
2702
|
/** @enumType */
|
|
2704
|
-
|
|
2705
|
-
|
|
2703
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2704
|
+
declare enum VoteRole {
|
|
2706
2705
|
/** Logged in member */
|
|
2707
2706
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2708
2707
|
/** Anyone */
|
|
2709
2708
|
ALL = "ALL"
|
|
2710
2709
|
}
|
|
2711
2710
|
/** @enumType */
|
|
2712
|
-
|
|
2713
|
-
|
|
2711
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2712
|
+
interface Permissions {
|
|
2714
2713
|
/** Sets who can view the poll results. */
|
|
2715
2714
|
view?: ViewRoleWithLiterals;
|
|
2716
2715
|
/** Sets who can vote. */
|
|
@@ -2718,7 +2717,7 @@ export interface Permissions {
|
|
|
2718
2717
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2719
2718
|
allowMultipleVotes?: boolean | null;
|
|
2720
2719
|
}
|
|
2721
|
-
|
|
2720
|
+
interface Option {
|
|
2722
2721
|
/** Option ID. */
|
|
2723
2722
|
id?: string | null;
|
|
2724
2723
|
/** Option title. */
|
|
@@ -2726,7 +2725,7 @@ export interface Option {
|
|
|
2726
2725
|
/** The image displayed with the option. */
|
|
2727
2726
|
image?: V1Media;
|
|
2728
2727
|
}
|
|
2729
|
-
|
|
2728
|
+
interface PollSettings {
|
|
2730
2729
|
/** Permissions settings for voting. */
|
|
2731
2730
|
permissions?: Permissions;
|
|
2732
2731
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -2734,23 +2733,23 @@ export interface PollSettings {
|
|
|
2734
2733
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2735
2734
|
showVotesCount?: boolean | null;
|
|
2736
2735
|
}
|
|
2737
|
-
|
|
2736
|
+
declare enum PollLayoutType {
|
|
2738
2737
|
/** List */
|
|
2739
2738
|
LIST = "LIST",
|
|
2740
2739
|
/** Grid */
|
|
2741
2740
|
GRID = "GRID"
|
|
2742
2741
|
}
|
|
2743
2742
|
/** @enumType */
|
|
2744
|
-
|
|
2745
|
-
|
|
2743
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2744
|
+
declare enum PollLayoutDirection {
|
|
2746
2745
|
/** Left-to-right */
|
|
2747
2746
|
LTR = "LTR",
|
|
2748
2747
|
/** Right-to-left */
|
|
2749
2748
|
RTL = "RTL"
|
|
2750
2749
|
}
|
|
2751
2750
|
/** @enumType */
|
|
2752
|
-
|
|
2753
|
-
|
|
2751
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2752
|
+
interface PollLayout {
|
|
2754
2753
|
/** The layout for displaying the voting options. */
|
|
2755
2754
|
type?: PollLayoutTypeWithLiterals;
|
|
2756
2755
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -2758,11 +2757,11 @@ export interface PollLayout {
|
|
|
2758
2757
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2759
2758
|
enableImage?: boolean | null;
|
|
2760
2759
|
}
|
|
2761
|
-
|
|
2760
|
+
interface OptionLayout {
|
|
2762
2761
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
2763
2762
|
enableImage?: boolean | null;
|
|
2764
2763
|
}
|
|
2765
|
-
|
|
2764
|
+
declare enum BackgroundType {
|
|
2766
2765
|
/** Color background type */
|
|
2767
2766
|
COLOR = "COLOR",
|
|
2768
2767
|
/** Image background type */
|
|
@@ -2771,8 +2770,8 @@ export declare enum BackgroundType {
|
|
|
2771
2770
|
GRADIENT = "GRADIENT"
|
|
2772
2771
|
}
|
|
2773
2772
|
/** @enumType */
|
|
2774
|
-
|
|
2775
|
-
|
|
2773
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2774
|
+
interface Gradient {
|
|
2776
2775
|
/** The gradient angle in degrees. */
|
|
2777
2776
|
angle?: number | null;
|
|
2778
2777
|
/**
|
|
@@ -2786,7 +2785,7 @@ export interface Gradient {
|
|
|
2786
2785
|
*/
|
|
2787
2786
|
lastColor?: string | null;
|
|
2788
2787
|
}
|
|
2789
|
-
|
|
2788
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
2790
2789
|
/**
|
|
2791
2790
|
* The background color as a hexademical value.
|
|
2792
2791
|
* @format COLOR_HEX
|
|
@@ -2800,7 +2799,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2800
2799
|
type?: BackgroundTypeWithLiterals;
|
|
2801
2800
|
}
|
|
2802
2801
|
/** @oneof */
|
|
2803
|
-
|
|
2802
|
+
interface BackgroundBackgroundOneOf {
|
|
2804
2803
|
/**
|
|
2805
2804
|
* The background color as a hexademical value.
|
|
2806
2805
|
* @format COLOR_HEX
|
|
@@ -2811,17 +2810,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
2811
2810
|
/** Details for a gradient background. */
|
|
2812
2811
|
gradient?: Gradient;
|
|
2813
2812
|
}
|
|
2814
|
-
|
|
2813
|
+
interface PollDesign {
|
|
2815
2814
|
/** Background styling. */
|
|
2816
2815
|
background?: Background;
|
|
2817
2816
|
/** Border radius in pixels. */
|
|
2818
2817
|
borderRadius?: number | null;
|
|
2819
2818
|
}
|
|
2820
|
-
|
|
2819
|
+
interface OptionDesign {
|
|
2821
2820
|
/** Border radius in pixels. */
|
|
2822
2821
|
borderRadius?: number | null;
|
|
2823
2822
|
}
|
|
2824
|
-
|
|
2823
|
+
interface Poll {
|
|
2825
2824
|
/** Poll ID. */
|
|
2826
2825
|
id?: string | null;
|
|
2827
2826
|
/** Poll title. */
|
|
@@ -2835,26 +2834,26 @@ export interface Poll {
|
|
|
2835
2834
|
/** The poll's permissions and display settings. */
|
|
2836
2835
|
settings?: PollSettings;
|
|
2837
2836
|
}
|
|
2838
|
-
|
|
2837
|
+
interface PollDataLayout {
|
|
2839
2838
|
/** Poll layout settings. */
|
|
2840
2839
|
poll?: PollLayout;
|
|
2841
2840
|
/** Voting otpions layout settings. */
|
|
2842
2841
|
options?: OptionLayout;
|
|
2843
2842
|
}
|
|
2844
|
-
|
|
2843
|
+
interface Design {
|
|
2845
2844
|
/** Styling for the poll. */
|
|
2846
2845
|
poll?: PollDesign;
|
|
2847
2846
|
/** Styling for voting options. */
|
|
2848
2847
|
options?: OptionDesign;
|
|
2849
2848
|
}
|
|
2850
|
-
|
|
2849
|
+
interface TextData {
|
|
2851
2850
|
/** The text to apply decorations to. */
|
|
2852
2851
|
text?: string;
|
|
2853
2852
|
/** The decorations to apply. */
|
|
2854
2853
|
decorations?: Decoration[];
|
|
2855
2854
|
}
|
|
2856
2855
|
/** Adds appearence changes to text */
|
|
2857
|
-
|
|
2856
|
+
interface Decoration extends DecorationDataOneOf {
|
|
2858
2857
|
/** Data for an anchor link decoration. */
|
|
2859
2858
|
anchorData?: AnchorData;
|
|
2860
2859
|
/** Data for a color decoration. */
|
|
@@ -2879,7 +2878,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2879
2878
|
type?: DecorationTypeWithLiterals;
|
|
2880
2879
|
}
|
|
2881
2880
|
/** @oneof */
|
|
2882
|
-
|
|
2881
|
+
interface DecorationDataOneOf {
|
|
2883
2882
|
/** Data for an anchor link decoration. */
|
|
2884
2883
|
anchorData?: AnchorData;
|
|
2885
2884
|
/** Data for a color decoration. */
|
|
@@ -2901,7 +2900,7 @@ export interface DecorationDataOneOf {
|
|
|
2901
2900
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2902
2901
|
strikethroughData?: boolean | null;
|
|
2903
2902
|
}
|
|
2904
|
-
|
|
2903
|
+
declare enum DecorationType {
|
|
2905
2904
|
BOLD = "BOLD",
|
|
2906
2905
|
ITALIC = "ITALIC",
|
|
2907
2906
|
UNDERLINE = "UNDERLINE",
|
|
@@ -2915,22 +2914,22 @@ export declare enum DecorationType {
|
|
|
2915
2914
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
2916
2915
|
}
|
|
2917
2916
|
/** @enumType */
|
|
2918
|
-
|
|
2919
|
-
|
|
2917
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
2918
|
+
interface AnchorData {
|
|
2920
2919
|
/** The target node's ID. */
|
|
2921
2920
|
anchor?: string;
|
|
2922
2921
|
}
|
|
2923
|
-
|
|
2922
|
+
interface ColorData {
|
|
2924
2923
|
/** The text's background color as a hexadecimal value. */
|
|
2925
2924
|
background?: string | null;
|
|
2926
2925
|
/** The text's foreground color as a hexadecimal value. */
|
|
2927
2926
|
foreground?: string | null;
|
|
2928
2927
|
}
|
|
2929
|
-
|
|
2928
|
+
interface LinkData {
|
|
2930
2929
|
/** Link details. */
|
|
2931
2930
|
link?: Link;
|
|
2932
2931
|
}
|
|
2933
|
-
|
|
2932
|
+
interface MentionData {
|
|
2934
2933
|
/** The mentioned user's name. */
|
|
2935
2934
|
name?: string;
|
|
2936
2935
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -2938,23 +2937,23 @@ export interface MentionData {
|
|
|
2938
2937
|
/** Mentioned user's ID. */
|
|
2939
2938
|
id?: string | null;
|
|
2940
2939
|
}
|
|
2941
|
-
|
|
2940
|
+
interface FontSizeData {
|
|
2942
2941
|
/** The units used for the font size. */
|
|
2943
2942
|
unit?: FontTypeWithLiterals;
|
|
2944
2943
|
/** Font size value. */
|
|
2945
2944
|
value?: number | null;
|
|
2946
2945
|
}
|
|
2947
|
-
|
|
2946
|
+
declare enum FontType {
|
|
2948
2947
|
PX = "PX",
|
|
2949
2948
|
EM = "EM"
|
|
2950
2949
|
}
|
|
2951
2950
|
/** @enumType */
|
|
2952
|
-
|
|
2953
|
-
|
|
2951
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2952
|
+
interface SpoilerData {
|
|
2954
2953
|
/** Spoiler ID. */
|
|
2955
2954
|
id?: string | null;
|
|
2956
2955
|
}
|
|
2957
|
-
|
|
2956
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
2958
2957
|
/** Data for embedded Wix Bookings content. */
|
|
2959
2958
|
bookingData?: BookingData;
|
|
2960
2959
|
/** Data for embedded Wix Events content. */
|
|
@@ -2976,30 +2975,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2976
2975
|
image?: V1Media;
|
|
2977
2976
|
}
|
|
2978
2977
|
/** @oneof */
|
|
2979
|
-
|
|
2978
|
+
interface AppEmbedDataAppDataOneOf {
|
|
2980
2979
|
/** Data for embedded Wix Bookings content. */
|
|
2981
2980
|
bookingData?: BookingData;
|
|
2982
2981
|
/** Data for embedded Wix Events content. */
|
|
2983
2982
|
eventData?: EventData;
|
|
2984
2983
|
}
|
|
2985
|
-
|
|
2984
|
+
declare enum AppType {
|
|
2986
2985
|
PRODUCT = "PRODUCT",
|
|
2987
2986
|
EVENT = "EVENT",
|
|
2988
2987
|
BOOKING = "BOOKING"
|
|
2989
2988
|
}
|
|
2990
2989
|
/** @enumType */
|
|
2991
|
-
|
|
2992
|
-
|
|
2990
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2991
|
+
interface BookingData {
|
|
2993
2992
|
/** Booking duration in minutes. */
|
|
2994
2993
|
durations?: string | null;
|
|
2995
2994
|
}
|
|
2996
|
-
|
|
2995
|
+
interface EventData {
|
|
2997
2996
|
/** Event schedule. */
|
|
2998
2997
|
scheduling?: string | null;
|
|
2999
2998
|
/** Event location. */
|
|
3000
2999
|
location?: string | null;
|
|
3001
3000
|
}
|
|
3002
|
-
|
|
3001
|
+
interface VideoData {
|
|
3003
3002
|
/** Styling for the video's container. */
|
|
3004
3003
|
containerData?: PluginContainerData;
|
|
3005
3004
|
/** Video details. */
|
|
@@ -3013,7 +3012,7 @@ export interface VideoData {
|
|
|
3013
3012
|
/** Video options. */
|
|
3014
3013
|
options?: PlaybackOptions;
|
|
3015
3014
|
}
|
|
3016
|
-
|
|
3015
|
+
interface PlaybackOptions {
|
|
3017
3016
|
/** Sets whether the media will automatically start playing. */
|
|
3018
3017
|
autoPlay?: boolean | null;
|
|
3019
3018
|
/** Sets whether media's will be looped. */
|
|
@@ -3021,7 +3020,7 @@ export interface PlaybackOptions {
|
|
|
3021
3020
|
/** Sets whether media's controls will be shown. */
|
|
3022
3021
|
showControls?: boolean | null;
|
|
3023
3022
|
}
|
|
3024
|
-
|
|
3023
|
+
interface EmbedData {
|
|
3025
3024
|
/** Styling for the oEmbed node's container. */
|
|
3026
3025
|
containerData?: PluginContainerData;
|
|
3027
3026
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -3029,7 +3028,7 @@ export interface EmbedData {
|
|
|
3029
3028
|
/** Origin asset source. */
|
|
3030
3029
|
src?: string | null;
|
|
3031
3030
|
}
|
|
3032
|
-
|
|
3031
|
+
interface Oembed {
|
|
3033
3032
|
/** The resource type. */
|
|
3034
3033
|
type?: string | null;
|
|
3035
3034
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -3061,7 +3060,7 @@ export interface Oembed {
|
|
|
3061
3060
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
3062
3061
|
version?: string | null;
|
|
3063
3062
|
}
|
|
3064
|
-
|
|
3063
|
+
interface CollapsibleListData {
|
|
3065
3064
|
/** Styling for the collapsible list's container. */
|
|
3066
3065
|
containerData?: PluginContainerData;
|
|
3067
3066
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -3073,7 +3072,7 @@ export interface CollapsibleListData {
|
|
|
3073
3072
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
3074
3073
|
isQapageData?: boolean | null;
|
|
3075
3074
|
}
|
|
3076
|
-
|
|
3075
|
+
declare enum InitialExpandedItems {
|
|
3077
3076
|
/** First item will be expended initally */
|
|
3078
3077
|
FIRST = "FIRST",
|
|
3079
3078
|
/** All items will expended initally */
|
|
@@ -3082,16 +3081,16 @@ export declare enum InitialExpandedItems {
|
|
|
3082
3081
|
NONE = "NONE"
|
|
3083
3082
|
}
|
|
3084
3083
|
/** @enumType */
|
|
3085
|
-
|
|
3086
|
-
|
|
3084
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
3085
|
+
declare enum Direction {
|
|
3087
3086
|
/** Left-to-right */
|
|
3088
3087
|
LTR = "LTR",
|
|
3089
3088
|
/** Right-to-left */
|
|
3090
3089
|
RTL = "RTL"
|
|
3091
3090
|
}
|
|
3092
3091
|
/** @enumType */
|
|
3093
|
-
|
|
3094
|
-
|
|
3092
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
3093
|
+
interface TableData {
|
|
3095
3094
|
/** Styling for the table's container. */
|
|
3096
3095
|
containerData?: PluginContainerData;
|
|
3097
3096
|
/** The table's dimensions. */
|
|
@@ -3106,7 +3105,7 @@ export interface TableData {
|
|
|
3106
3105
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
3107
3106
|
columnHeader?: boolean | null;
|
|
3108
3107
|
}
|
|
3109
|
-
|
|
3108
|
+
interface Dimensions {
|
|
3110
3109
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
3111
3110
|
colsWidthRatio?: number[];
|
|
3112
3111
|
/** An array representing the height of each row in pixels. */
|
|
@@ -3114,13 +3113,13 @@ export interface Dimensions {
|
|
|
3114
3113
|
/** An array representing the minimum width of each column in pixels. */
|
|
3115
3114
|
colsMinWidth?: number[];
|
|
3116
3115
|
}
|
|
3117
|
-
|
|
3116
|
+
interface TableCellData {
|
|
3118
3117
|
/** Styling for the cell's background color and text alignment. */
|
|
3119
3118
|
cellStyle?: CellStyle;
|
|
3120
3119
|
/** The cell's border colors. */
|
|
3121
3120
|
borderColors?: BorderColors;
|
|
3122
3121
|
}
|
|
3123
|
-
|
|
3122
|
+
declare enum VerticalAlignment {
|
|
3124
3123
|
/** Top alignment */
|
|
3125
3124
|
TOP = "TOP",
|
|
3126
3125
|
/** Middle alignment */
|
|
@@ -3129,8 +3128,8 @@ export declare enum VerticalAlignment {
|
|
|
3129
3128
|
BOTTOM = "BOTTOM"
|
|
3130
3129
|
}
|
|
3131
3130
|
/** @enumType */
|
|
3132
|
-
|
|
3133
|
-
|
|
3131
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
3132
|
+
interface CellStyle {
|
|
3134
3133
|
/** Vertical alignment for the cell's text. */
|
|
3135
3134
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
3136
3135
|
/**
|
|
@@ -3139,7 +3138,7 @@ export interface CellStyle {
|
|
|
3139
3138
|
*/
|
|
3140
3139
|
backgroundColor?: string | null;
|
|
3141
3140
|
}
|
|
3142
|
-
|
|
3141
|
+
interface BorderColors {
|
|
3143
3142
|
/**
|
|
3144
3143
|
* Left border color as a hexadecimal value.
|
|
3145
3144
|
* @format COLOR_HEX
|
|
@@ -3167,22 +3166,20 @@ export interface BorderColors {
|
|
|
3167
3166
|
*
|
|
3168
3167
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
3169
3168
|
*/
|
|
3170
|
-
|
|
3169
|
+
declare enum NullValue {
|
|
3171
3170
|
/** Null value. */
|
|
3172
3171
|
NULL_VALUE = "NULL_VALUE"
|
|
3173
3172
|
}
|
|
3174
|
-
/** @enumType */
|
|
3175
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
3176
3173
|
/**
|
|
3177
3174
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
3178
3175
|
*
|
|
3179
3176
|
* The JSON representation for `ListValue` is JSON array.
|
|
3180
3177
|
*/
|
|
3181
|
-
|
|
3178
|
+
interface ListValue {
|
|
3182
3179
|
/** Repeated field of dynamically typed values. */
|
|
3183
3180
|
values?: any[];
|
|
3184
3181
|
}
|
|
3185
|
-
|
|
3182
|
+
interface AudioData {
|
|
3186
3183
|
/** Styling for the audio node's container. */
|
|
3187
3184
|
containerData?: PluginContainerData;
|
|
3188
3185
|
/** Audio file details. */
|
|
@@ -3198,7 +3195,7 @@ export interface AudioData {
|
|
|
3198
3195
|
/** An HTML version of the audio node. */
|
|
3199
3196
|
html?: string | null;
|
|
3200
3197
|
}
|
|
3201
|
-
|
|
3198
|
+
interface OrderedListData {
|
|
3202
3199
|
/** Indentation level from 0-4. */
|
|
3203
3200
|
indentation?: number;
|
|
3204
3201
|
/** Offset level from 0-4. */
|
|
@@ -3206,24 +3203,24 @@ export interface OrderedListData {
|
|
|
3206
3203
|
/** List start number. */
|
|
3207
3204
|
start?: number | null;
|
|
3208
3205
|
}
|
|
3209
|
-
|
|
3206
|
+
interface BulletedListData {
|
|
3210
3207
|
/** Indentation level from 0-4. */
|
|
3211
3208
|
indentation?: number;
|
|
3212
3209
|
/** Offset level from 0-4. */
|
|
3213
3210
|
offset?: number | null;
|
|
3214
3211
|
}
|
|
3215
|
-
|
|
3212
|
+
interface BlockquoteData {
|
|
3216
3213
|
/** Indentation level from 1-4. */
|
|
3217
3214
|
indentation?: number;
|
|
3218
3215
|
}
|
|
3219
|
-
|
|
3216
|
+
interface CaptionData {
|
|
3220
3217
|
textStyle?: TextStyle;
|
|
3221
3218
|
}
|
|
3222
|
-
|
|
3219
|
+
interface LayoutCellData {
|
|
3223
3220
|
/** Size of the cell in 12 columns grid. */
|
|
3224
3221
|
colSpan?: number | null;
|
|
3225
3222
|
}
|
|
3226
|
-
|
|
3223
|
+
interface Metadata {
|
|
3227
3224
|
/** Schema version. */
|
|
3228
3225
|
version?: number;
|
|
3229
3226
|
/**
|
|
@@ -3240,7 +3237,7 @@ export interface Metadata {
|
|
|
3240
3237
|
/** Object ID. */
|
|
3241
3238
|
_id?: string | null;
|
|
3242
3239
|
}
|
|
3243
|
-
|
|
3240
|
+
interface DocumentStyle {
|
|
3244
3241
|
/** Styling for H1 nodes. */
|
|
3245
3242
|
headerOne?: TextNodeStyle;
|
|
3246
3243
|
/** Styling for H2 nodes. */
|
|
@@ -3260,7 +3257,7 @@ export interface DocumentStyle {
|
|
|
3260
3257
|
/** Styling for code block nodes. */
|
|
3261
3258
|
codeBlock?: TextNodeStyle;
|
|
3262
3259
|
}
|
|
3263
|
-
|
|
3260
|
+
interface TextNodeStyle {
|
|
3264
3261
|
/** The decorations to apply to the node. */
|
|
3265
3262
|
decorations?: Decoration[];
|
|
3266
3263
|
/** Padding and background color for the node. */
|
|
@@ -3268,7 +3265,7 @@ export interface TextNodeStyle {
|
|
|
3268
3265
|
/** Line height for text in the node. */
|
|
3269
3266
|
lineHeight?: string | null;
|
|
3270
3267
|
}
|
|
3271
|
-
|
|
3268
|
+
interface Media {
|
|
3272
3269
|
/**
|
|
3273
3270
|
* Main media (image, video, etc.) associated with this product.
|
|
3274
3271
|
* @readonly
|
|
@@ -3280,7 +3277,7 @@ export interface Media {
|
|
|
3280
3277
|
*/
|
|
3281
3278
|
itemsInfo?: MediaItemsInfo;
|
|
3282
3279
|
}
|
|
3283
|
-
|
|
3280
|
+
interface ProductMedia extends ProductMediaSetByOneOf, ProductMediaMediaOneOf {
|
|
3284
3281
|
/**
|
|
3285
3282
|
* Set media by ID of an existing file in Wix Media Manager.
|
|
3286
3283
|
* @minLength 1
|
|
@@ -3332,7 +3329,7 @@ export interface ProductMedia extends ProductMediaSetByOneOf, ProductMediaMediaO
|
|
|
3332
3329
|
uploadId?: string;
|
|
3333
3330
|
}
|
|
3334
3331
|
/** @oneof */
|
|
3335
|
-
|
|
3332
|
+
interface ProductMediaSetByOneOf {
|
|
3336
3333
|
/**
|
|
3337
3334
|
* Set media by ID of an existing file in Wix Media Manager.
|
|
3338
3335
|
* @minLength 1
|
|
@@ -3346,7 +3343,7 @@ export interface ProductMediaSetByOneOf {
|
|
|
3346
3343
|
url?: string;
|
|
3347
3344
|
}
|
|
3348
3345
|
/** @oneof */
|
|
3349
|
-
|
|
3346
|
+
interface ProductMediaMediaOneOf {
|
|
3350
3347
|
/**
|
|
3351
3348
|
* Product image.
|
|
3352
3349
|
* @readonly
|
|
@@ -3358,7 +3355,7 @@ export interface ProductMediaMediaOneOf {
|
|
|
3358
3355
|
*/
|
|
3359
3356
|
video?: string;
|
|
3360
3357
|
}
|
|
3361
|
-
|
|
3358
|
+
interface VideoResolution {
|
|
3362
3359
|
/**
|
|
3363
3360
|
* Video URL.
|
|
3364
3361
|
* @format WEB_URL
|
|
@@ -3374,7 +3371,7 @@ export interface VideoResolution {
|
|
|
3374
3371
|
*/
|
|
3375
3372
|
format?: string;
|
|
3376
3373
|
}
|
|
3377
|
-
|
|
3374
|
+
declare enum MediaType {
|
|
3378
3375
|
UNKNOWN_MEDIA_TYPE = "UNKNOWN_MEDIA_TYPE",
|
|
3379
3376
|
/** Image media type. */
|
|
3380
3377
|
IMAGE = "IMAGE",
|
|
@@ -3382,8 +3379,8 @@ export declare enum MediaType {
|
|
|
3382
3379
|
VIDEO = "VIDEO"
|
|
3383
3380
|
}
|
|
3384
3381
|
/** @enumType */
|
|
3385
|
-
|
|
3386
|
-
|
|
3382
|
+
type MediaTypeWithLiterals = MediaType | 'UNKNOWN_MEDIA_TYPE' | 'IMAGE' | 'VIDEO';
|
|
3383
|
+
interface Thumbnail {
|
|
3387
3384
|
/**
|
|
3388
3385
|
* Thumbnail url.
|
|
3389
3386
|
* @format WEB_URL
|
|
@@ -3400,7 +3397,7 @@ export interface Thumbnail {
|
|
|
3400
3397
|
*/
|
|
3401
3398
|
altText?: string | null;
|
|
3402
3399
|
}
|
|
3403
|
-
|
|
3400
|
+
interface MediaItemsInfo {
|
|
3404
3401
|
/**
|
|
3405
3402
|
* All media items (images, videos etc) associated with this product.
|
|
3406
3403
|
* @maxSize 15
|
|
@@ -3412,13 +3409,13 @@ export interface MediaItemsInfo {
|
|
|
3412
3409
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
3413
3410
|
* This data will override other sources of tags (for example patterns) and will be included in the <head> section of the HTML document, while not being displayed on the page itself.
|
|
3414
3411
|
*/
|
|
3415
|
-
|
|
3412
|
+
interface SeoSchema {
|
|
3416
3413
|
/** SEO tag information. */
|
|
3417
3414
|
tags?: Tag[];
|
|
3418
3415
|
/** SEO general settings. */
|
|
3419
3416
|
settings?: Settings;
|
|
3420
3417
|
}
|
|
3421
|
-
|
|
3418
|
+
interface Keyword {
|
|
3422
3419
|
/** Keyword value. */
|
|
3423
3420
|
term?: string;
|
|
3424
3421
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -3429,7 +3426,7 @@ export interface Keyword {
|
|
|
3429
3426
|
*/
|
|
3430
3427
|
origin?: string | null;
|
|
3431
3428
|
}
|
|
3432
|
-
|
|
3429
|
+
interface Tag {
|
|
3433
3430
|
/**
|
|
3434
3431
|
* SEO tag type.
|
|
3435
3432
|
*
|
|
@@ -3451,7 +3448,7 @@ export interface Tag {
|
|
|
3451
3448
|
/** Whether the tag is disabled. */
|
|
3452
3449
|
disabled?: boolean;
|
|
3453
3450
|
}
|
|
3454
|
-
|
|
3451
|
+
interface Settings {
|
|
3455
3452
|
/**
|
|
3456
3453
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
3457
3454
|
*
|
|
@@ -3465,7 +3462,7 @@ export interface Settings {
|
|
|
3465
3462
|
*/
|
|
3466
3463
|
keywords?: Keyword[];
|
|
3467
3464
|
}
|
|
3468
|
-
|
|
3465
|
+
interface ConnectedOption extends ConnectedOptionOptionSettingsOneOf {
|
|
3469
3466
|
/** Choices settings. */
|
|
3470
3467
|
choicesSettings?: ChoicesSettings;
|
|
3471
3468
|
/**
|
|
@@ -3484,11 +3481,11 @@ export interface ConnectedOption extends ConnectedOptionOptionSettingsOneOf {
|
|
|
3484
3481
|
optionRenderType?: ProductOptionRenderTypeWithLiterals;
|
|
3485
3482
|
}
|
|
3486
3483
|
/** @oneof */
|
|
3487
|
-
|
|
3484
|
+
interface ConnectedOptionOptionSettingsOneOf {
|
|
3488
3485
|
/** Choices settings. */
|
|
3489
3486
|
choicesSettings?: ChoicesSettings;
|
|
3490
3487
|
}
|
|
3491
|
-
|
|
3488
|
+
declare enum ProductOptionRenderType {
|
|
3492
3489
|
/** Not implemented. */
|
|
3493
3490
|
UNKNOWN_OPTION_RENDER_TYPE = "UNKNOWN_OPTION_RENDER_TYPE",
|
|
3494
3491
|
/** Text choices. */
|
|
@@ -3497,8 +3494,8 @@ export declare enum ProductOptionRenderType {
|
|
|
3497
3494
|
SWATCH_CHOICES = "SWATCH_CHOICES"
|
|
3498
3495
|
}
|
|
3499
3496
|
/** @enumType */
|
|
3500
|
-
|
|
3501
|
-
|
|
3497
|
+
type ProductOptionRenderTypeWithLiterals = ProductOptionRenderType | 'UNKNOWN_OPTION_RENDER_TYPE' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
|
|
3498
|
+
interface ChoicesSettings {
|
|
3502
3499
|
/**
|
|
3503
3500
|
* List of available choices for the option.
|
|
3504
3501
|
* @minSize 1
|
|
@@ -3507,7 +3504,7 @@ export interface ChoicesSettings {
|
|
|
3507
3504
|
*/
|
|
3508
3505
|
choices?: ConnectedOptionChoice[];
|
|
3509
3506
|
}
|
|
3510
|
-
|
|
3507
|
+
interface ConnectedOptionChoice extends ConnectedOptionChoiceValueOneOf {
|
|
3511
3508
|
/**
|
|
3512
3509
|
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
3513
3510
|
* @minLength 3
|
|
@@ -3549,7 +3546,7 @@ export interface ConnectedOptionChoice extends ConnectedOptionChoiceValueOneOf {
|
|
|
3549
3546
|
visible?: boolean;
|
|
3550
3547
|
}
|
|
3551
3548
|
/** @oneof */
|
|
3552
|
-
|
|
3549
|
+
interface ConnectedOptionChoiceValueOneOf {
|
|
3553
3550
|
/**
|
|
3554
3551
|
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
3555
3552
|
* @minLength 3
|
|
@@ -3557,7 +3554,7 @@ export interface ConnectedOptionChoiceValueOneOf {
|
|
|
3557
3554
|
*/
|
|
3558
3555
|
colorCode?: string;
|
|
3559
3556
|
}
|
|
3560
|
-
|
|
3557
|
+
declare enum ChoiceType {
|
|
3561
3558
|
UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
|
|
3562
3559
|
/** Text choice. */
|
|
3563
3560
|
CHOICE_TEXT = "CHOICE_TEXT",
|
|
@@ -3569,8 +3566,8 @@ export declare enum ChoiceType {
|
|
|
3569
3566
|
IMAGE = "IMAGE"
|
|
3570
3567
|
}
|
|
3571
3568
|
/** @enumType */
|
|
3572
|
-
|
|
3573
|
-
|
|
3569
|
+
type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR' | 'MULTIPLE_COLORS' | 'IMAGE';
|
|
3570
|
+
interface MultipleColors {
|
|
3574
3571
|
/**
|
|
3575
3572
|
* List of color codes.
|
|
3576
3573
|
* @minLength 3
|
|
@@ -3580,7 +3577,7 @@ export interface MultipleColors {
|
|
|
3580
3577
|
*/
|
|
3581
3578
|
colorCodes?: string[];
|
|
3582
3579
|
}
|
|
3583
|
-
|
|
3580
|
+
interface ConnectedModifier extends ConnectedModifierModifierSettingsOneOf {
|
|
3584
3581
|
/** Free text modifier settings. */
|
|
3585
3582
|
freeTextSettings?: FreeTextSettings;
|
|
3586
3583
|
/** Choice settings. */
|
|
@@ -3603,13 +3600,13 @@ export interface ConnectedModifier extends ConnectedModifierModifierSettingsOneO
|
|
|
3603
3600
|
mandatory?: boolean;
|
|
3604
3601
|
}
|
|
3605
3602
|
/** @oneof */
|
|
3606
|
-
|
|
3603
|
+
interface ConnectedModifierModifierSettingsOneOf {
|
|
3607
3604
|
/** Free text modifier settings. */
|
|
3608
3605
|
freeTextSettings?: FreeTextSettings;
|
|
3609
3606
|
/** Choice settings. */
|
|
3610
3607
|
choicesSettings?: ModifierChoicesSettings;
|
|
3611
3608
|
}
|
|
3612
|
-
|
|
3609
|
+
declare enum ModifierRenderType {
|
|
3613
3610
|
/** Not implemented. */
|
|
3614
3611
|
UNKNOWN_MODIFIER_RENDER_TYPE = "UNKNOWN_MODIFIER_RENDER_TYPE",
|
|
3615
3612
|
/** Free text. */
|
|
@@ -3620,8 +3617,8 @@ export declare enum ModifierRenderType {
|
|
|
3620
3617
|
SWATCH_CHOICES = "SWATCH_CHOICES"
|
|
3621
3618
|
}
|
|
3622
3619
|
/** @enumType */
|
|
3623
|
-
|
|
3624
|
-
|
|
3620
|
+
type ModifierRenderTypeWithLiterals = ModifierRenderType | 'UNKNOWN_MODIFIER_RENDER_TYPE' | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
|
|
3621
|
+
interface FreeTextSettings {
|
|
3625
3622
|
/** Minimum number of characters. */
|
|
3626
3623
|
minCharCount?: number;
|
|
3627
3624
|
/**
|
|
@@ -3641,7 +3638,7 @@ export interface FreeTextSettings {
|
|
|
3641
3638
|
*/
|
|
3642
3639
|
title?: string;
|
|
3643
3640
|
}
|
|
3644
|
-
|
|
3641
|
+
interface ModifierChoicesSettings {
|
|
3645
3642
|
/**
|
|
3646
3643
|
* List of modifier choices.
|
|
3647
3644
|
* @minSize 1
|
|
@@ -3650,7 +3647,7 @@ export interface ModifierChoicesSettings {
|
|
|
3650
3647
|
*/
|
|
3651
3648
|
choices?: ConnectedModifierChoice[];
|
|
3652
3649
|
}
|
|
3653
|
-
|
|
3650
|
+
interface ConnectedModifierChoice extends ConnectedModifierChoiceValueOneOf {
|
|
3654
3651
|
/**
|
|
3655
3652
|
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
3656
3653
|
* @minLength 3
|
|
@@ -3689,7 +3686,7 @@ export interface ConnectedModifierChoice extends ConnectedModifierChoiceValueOne
|
|
|
3689
3686
|
addedPrice?: string | null;
|
|
3690
3687
|
}
|
|
3691
3688
|
/** @oneof */
|
|
3692
|
-
|
|
3689
|
+
interface ConnectedModifierChoiceValueOneOf {
|
|
3693
3690
|
/**
|
|
3694
3691
|
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
3695
3692
|
* @minLength 3
|
|
@@ -3697,7 +3694,7 @@ export interface ConnectedModifierChoiceValueOneOf {
|
|
|
3697
3694
|
*/
|
|
3698
3695
|
colorCode?: string;
|
|
3699
3696
|
}
|
|
3700
|
-
|
|
3697
|
+
interface Brand {
|
|
3701
3698
|
/**
|
|
3702
3699
|
* Brand ID.
|
|
3703
3700
|
* @format GUID
|
|
@@ -3709,7 +3706,7 @@ export interface Brand {
|
|
|
3709
3706
|
*/
|
|
3710
3707
|
name?: string | null;
|
|
3711
3708
|
}
|
|
3712
|
-
|
|
3709
|
+
interface InfoSection {
|
|
3713
3710
|
/**
|
|
3714
3711
|
* Info section ID.
|
|
3715
3712
|
* @format GUID
|
|
@@ -3749,7 +3746,7 @@ export interface InfoSection {
|
|
|
3749
3746
|
*/
|
|
3750
3747
|
plainDescription?: string | null;
|
|
3751
3748
|
}
|
|
3752
|
-
|
|
3749
|
+
interface Ribbon {
|
|
3753
3750
|
/**
|
|
3754
3751
|
* Ribbon ID.
|
|
3755
3752
|
* @minLength 1
|
|
@@ -3762,7 +3759,7 @@ export interface Ribbon {
|
|
|
3762
3759
|
*/
|
|
3763
3760
|
name?: string | null;
|
|
3764
3761
|
}
|
|
3765
|
-
|
|
3762
|
+
interface ProductCategoriesInfo {
|
|
3766
3763
|
/**
|
|
3767
3764
|
* A list of categories related to product.
|
|
3768
3765
|
* @readonly
|
|
@@ -3770,7 +3767,7 @@ export interface ProductCategoriesInfo {
|
|
|
3770
3767
|
*/
|
|
3771
3768
|
categories?: ProductCategory[];
|
|
3772
3769
|
}
|
|
3773
|
-
|
|
3770
|
+
interface ProductCategory {
|
|
3774
3771
|
/**
|
|
3775
3772
|
* Category ID.
|
|
3776
3773
|
* @format GUID
|
|
@@ -3782,7 +3779,7 @@ export interface ProductCategory {
|
|
|
3782
3779
|
*/
|
|
3783
3780
|
index?: number | null;
|
|
3784
3781
|
}
|
|
3785
|
-
|
|
3782
|
+
interface ProductCategoryIdsInfo {
|
|
3786
3783
|
/**
|
|
3787
3784
|
* A list of category ids related to product.
|
|
3788
3785
|
* @readonly
|
|
@@ -3791,13 +3788,13 @@ export interface ProductCategoryIdsInfo {
|
|
|
3791
3788
|
*/
|
|
3792
3789
|
categoryIds?: string[];
|
|
3793
3790
|
}
|
|
3794
|
-
|
|
3791
|
+
interface PriceRange {
|
|
3795
3792
|
/** Minimum value. */
|
|
3796
3793
|
minValue?: FixedMonetaryAmount;
|
|
3797
3794
|
/** Maximum value. */
|
|
3798
3795
|
maxValue?: FixedMonetaryAmount;
|
|
3799
3796
|
}
|
|
3800
|
-
|
|
3797
|
+
interface FixedMonetaryAmount {
|
|
3801
3798
|
/**
|
|
3802
3799
|
* Monetary amount. For example, `"3.99"`, or `"-4.99"` for a negative amount.
|
|
3803
3800
|
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
@@ -3811,7 +3808,7 @@ export interface FixedMonetaryAmount {
|
|
|
3811
3808
|
*/
|
|
3812
3809
|
formattedAmount?: string | null;
|
|
3813
3810
|
}
|
|
3814
|
-
|
|
3811
|
+
interface Inventory {
|
|
3815
3812
|
/**
|
|
3816
3813
|
* Current availability status.
|
|
3817
3814
|
* @readonly
|
|
@@ -3828,7 +3825,7 @@ export interface Inventory {
|
|
|
3828
3825
|
*/
|
|
3829
3826
|
preorderAvailability?: ProductPreorderAvailabilityWithLiterals;
|
|
3830
3827
|
}
|
|
3831
|
-
|
|
3828
|
+
declare enum AvailabilityStatus {
|
|
3832
3829
|
UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
|
|
3833
3830
|
/** All variants are in stock and available for purchase. */
|
|
3834
3831
|
IN_STOCK = "IN_STOCK",
|
|
@@ -3838,8 +3835,8 @@ export declare enum AvailabilityStatus {
|
|
|
3838
3835
|
PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
|
|
3839
3836
|
}
|
|
3840
3837
|
/** @enumType */
|
|
3841
|
-
|
|
3842
|
-
|
|
3838
|
+
type AvailabilityStatusWithLiterals = AvailabilityStatus | 'UNKNOWN_AVAILABILITY_STATUS' | 'IN_STOCK' | 'OUT_OF_STOCK' | 'PARTIALLY_OUT_OF_STOCK';
|
|
3839
|
+
declare enum PreorderStatus {
|
|
3843
3840
|
UNKNOWN_PREORDER_STATUS = "UNKNOWN_PREORDER_STATUS",
|
|
3844
3841
|
/** All variants are enabled for preorder. */
|
|
3845
3842
|
ENABLED = "ENABLED",
|
|
@@ -3849,8 +3846,8 @@ export declare enum PreorderStatus {
|
|
|
3849
3846
|
PARTIALLY_ENABLED = "PARTIALLY_ENABLED"
|
|
3850
3847
|
}
|
|
3851
3848
|
/** @enumType */
|
|
3852
|
-
|
|
3853
|
-
|
|
3849
|
+
type PreorderStatusWithLiterals = PreorderStatus | 'UNKNOWN_PREORDER_STATUS' | 'ENABLED' | 'DISABLED' | 'PARTIALLY_ENABLED';
|
|
3850
|
+
declare enum ProductPreorderAvailability {
|
|
3854
3851
|
UNKNOWN_PREORDER_AVAILABILITY_STATUS = "UNKNOWN_PREORDER_AVAILABILITY_STATUS",
|
|
3855
3852
|
/** All the product variants are available for preorder. */
|
|
3856
3853
|
ALL_VARIANTS = "ALL_VARIANTS",
|
|
@@ -3860,8 +3857,8 @@ export declare enum ProductPreorderAvailability {
|
|
|
3860
3857
|
SOME_VARIANTS = "SOME_VARIANTS"
|
|
3861
3858
|
}
|
|
3862
3859
|
/** @enumType */
|
|
3863
|
-
|
|
3864
|
-
|
|
3860
|
+
type ProductPreorderAvailabilityWithLiterals = ProductPreorderAvailability | 'UNKNOWN_PREORDER_AVAILABILITY_STATUS' | 'ALL_VARIANTS' | 'NO_VARIANTS' | 'SOME_VARIANTS';
|
|
3861
|
+
declare enum ProductType {
|
|
3865
3862
|
/** Not implemented. */
|
|
3866
3863
|
UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
|
|
3867
3864
|
/** Physical product. */
|
|
@@ -3870,8 +3867,8 @@ export declare enum ProductType {
|
|
|
3870
3867
|
DIGITAL = "DIGITAL"
|
|
3871
3868
|
}
|
|
3872
3869
|
/** @enumType */
|
|
3873
|
-
|
|
3874
|
-
|
|
3870
|
+
type ProductTypeWithLiterals = ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'PHYSICAL' | 'DIGITAL';
|
|
3871
|
+
interface PhysicalProperties {
|
|
3875
3872
|
/**
|
|
3876
3873
|
* Price per unit settings.
|
|
3877
3874
|
* > **Note:** Use this field only when relevant. For example, for products that are sold by weight, volume, or length.
|
|
@@ -3904,7 +3901,7 @@ export interface PhysicalProperties {
|
|
|
3904
3901
|
*/
|
|
3905
3902
|
deliveryProfileId?: string | null;
|
|
3906
3903
|
}
|
|
3907
|
-
|
|
3904
|
+
interface PricePerUnitSettings {
|
|
3908
3905
|
/**
|
|
3909
3906
|
* Quantity.
|
|
3910
3907
|
* For example, to define price per per 100 grams, set this field to `100`.
|
|
@@ -3918,7 +3915,7 @@ export interface PricePerUnitSettings {
|
|
|
3918
3915
|
*/
|
|
3919
3916
|
measurementUnit?: MeasurementUnitWithLiterals;
|
|
3920
3917
|
}
|
|
3921
|
-
|
|
3918
|
+
interface WeightRange {
|
|
3922
3919
|
/**
|
|
3923
3920
|
* Minimum weight across all variants associated with this product.
|
|
3924
3921
|
* @max 999999999.99
|
|
@@ -3930,13 +3927,13 @@ export interface WeightRange {
|
|
|
3930
3927
|
*/
|
|
3931
3928
|
maxValue?: number;
|
|
3932
3929
|
}
|
|
3933
|
-
|
|
3930
|
+
interface PricePerUnitRange {
|
|
3934
3931
|
/** Minimum price per unit across all variants. */
|
|
3935
3932
|
minValue?: PricePerUnitRangePricePerUnit;
|
|
3936
3933
|
/** Maximum price per unit across all variants. */
|
|
3937
3934
|
maxValue?: PricePerUnitRangePricePerUnit;
|
|
3938
3935
|
}
|
|
3939
|
-
|
|
3936
|
+
interface PricePerUnitRangePricePerUnit {
|
|
3940
3937
|
/**
|
|
3941
3938
|
* Calculated value of price per unit. Takes into account pricePerUnit settings of product and variants and price of variants.
|
|
3942
3939
|
* For example if discounted price is 2$, product's price per unit setting is 1 Kg, variant price per unit setting is 0.5 Kg then this value is 4$ (means variant weight is 0.5 Kg and it costs 2$ but we want to show price per 1 Kg so we show 4$).
|
|
@@ -3952,14 +3949,14 @@ export interface PricePerUnitRangePricePerUnit {
|
|
|
3952
3949
|
*/
|
|
3953
3950
|
description?: string | null;
|
|
3954
3951
|
}
|
|
3955
|
-
|
|
3952
|
+
interface WeightMeasurementUnitInfo {
|
|
3956
3953
|
/**
|
|
3957
3954
|
* Weight measurement unit.
|
|
3958
3955
|
* @readonly
|
|
3959
3956
|
*/
|
|
3960
3957
|
weightMeasurementUnit?: WeightUnitWithLiterals;
|
|
3961
3958
|
}
|
|
3962
|
-
|
|
3959
|
+
interface BreadcrumbsInfo {
|
|
3963
3960
|
/**
|
|
3964
3961
|
* Breadcrumbs.
|
|
3965
3962
|
* @readonly
|
|
@@ -3967,7 +3964,7 @@ export interface BreadcrumbsInfo {
|
|
|
3967
3964
|
*/
|
|
3968
3965
|
breadcrumbs?: BreadCrumb[];
|
|
3969
3966
|
}
|
|
3970
|
-
|
|
3967
|
+
interface BreadCrumb {
|
|
3971
3968
|
/**
|
|
3972
3969
|
* Category ID.
|
|
3973
3970
|
* @format GUID
|
|
@@ -3986,7 +3983,7 @@ export interface BreadCrumb {
|
|
|
3986
3983
|
*/
|
|
3987
3984
|
categorySlug?: string;
|
|
3988
3985
|
}
|
|
3989
|
-
|
|
3986
|
+
interface VariantsInfo {
|
|
3990
3987
|
/**
|
|
3991
3988
|
* List of related variants.
|
|
3992
3989
|
* @minSize 1
|
|
@@ -3994,7 +3991,7 @@ export interface VariantsInfo {
|
|
|
3994
3991
|
*/
|
|
3995
3992
|
variants?: Variant[];
|
|
3996
3993
|
}
|
|
3997
|
-
|
|
3994
|
+
interface Variant extends VariantTypedPropertiesOneOf {
|
|
3998
3995
|
/** Physical properties. Must be passed when `productType: PHYSICAL` */
|
|
3999
3996
|
physicalProperties?: VariantPhysicalProperties;
|
|
4000
3997
|
/** Digital properties. Must be passed when `productType: DIGITAL` */
|
|
@@ -4059,13 +4056,13 @@ export interface Variant extends VariantTypedPropertiesOneOf {
|
|
|
4059
4056
|
inventoryStatus?: InventoryStatus;
|
|
4060
4057
|
}
|
|
4061
4058
|
/** @oneof */
|
|
4062
|
-
|
|
4059
|
+
interface VariantTypedPropertiesOneOf {
|
|
4063
4060
|
/** Physical properties. Must be passed when `productType: PHYSICAL` */
|
|
4064
4061
|
physicalProperties?: VariantPhysicalProperties;
|
|
4065
4062
|
/** Digital properties. Must be passed when `productType: DIGITAL` */
|
|
4066
4063
|
digitalProperties?: VariantDigitalProperties;
|
|
4067
4064
|
}
|
|
4068
|
-
|
|
4065
|
+
interface OptionChoice {
|
|
4069
4066
|
/** Option and choice IDs. These match the IDs of the option and choice from the product's options field. */
|
|
4070
4067
|
optionChoiceIds?: OptionChoiceIds;
|
|
4071
4068
|
/**
|
|
@@ -4075,7 +4072,7 @@ export interface OptionChoice {
|
|
|
4075
4072
|
*/
|
|
4076
4073
|
optionChoiceNames?: OptionChoiceNames;
|
|
4077
4074
|
}
|
|
4078
|
-
|
|
4075
|
+
interface OptionChoiceIds {
|
|
4079
4076
|
/**
|
|
4080
4077
|
* Option ID.
|
|
4081
4078
|
* @minLength 1
|
|
@@ -4090,7 +4087,7 @@ export interface OptionChoiceIds {
|
|
|
4090
4087
|
*/
|
|
4091
4088
|
choiceId?: string;
|
|
4092
4089
|
}
|
|
4093
|
-
|
|
4090
|
+
interface OptionChoiceNames {
|
|
4094
4091
|
/**
|
|
4095
4092
|
* Option name.
|
|
4096
4093
|
* @minLength 1
|
|
@@ -4106,13 +4103,13 @@ export interface OptionChoiceNames {
|
|
|
4106
4103
|
/** Render type. */
|
|
4107
4104
|
renderType?: ProductOptionRenderTypeWithLiterals;
|
|
4108
4105
|
}
|
|
4109
|
-
|
|
4106
|
+
interface PriceInfo {
|
|
4110
4107
|
/** Variant price. Must be greater or equal to 0. */
|
|
4111
4108
|
actualPrice?: FixedMonetaryAmount;
|
|
4112
4109
|
/** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
|
|
4113
4110
|
compareAtPrice?: FixedMonetaryAmount;
|
|
4114
4111
|
}
|
|
4115
|
-
|
|
4112
|
+
interface RevenueDetails {
|
|
4116
4113
|
/** Item cost. */
|
|
4117
4114
|
cost?: FixedMonetaryAmount;
|
|
4118
4115
|
/**
|
|
@@ -4128,7 +4125,7 @@ export interface RevenueDetails {
|
|
|
4128
4125
|
*/
|
|
4129
4126
|
profitMargin?: number;
|
|
4130
4127
|
}
|
|
4131
|
-
|
|
4128
|
+
interface VariantPhysicalProperties {
|
|
4132
4129
|
/**
|
|
4133
4130
|
* Variant shipping weight.
|
|
4134
4131
|
* product.physicalProperties.shipping_weight_range values are taken from here.
|
|
@@ -4142,7 +4139,7 @@ export interface VariantPhysicalProperties {
|
|
|
4142
4139
|
*/
|
|
4143
4140
|
pricePerUnit?: PricePerUnit;
|
|
4144
4141
|
}
|
|
4145
|
-
|
|
4142
|
+
interface PricePerUnit {
|
|
4146
4143
|
/**
|
|
4147
4144
|
* Price per unit data for this variant.
|
|
4148
4145
|
* `measurementUnit` value must correspond to the measurement unit set on the product.
|
|
@@ -4163,11 +4160,11 @@ export interface PricePerUnit {
|
|
|
4163
4160
|
*/
|
|
4164
4161
|
description?: string | null;
|
|
4165
4162
|
}
|
|
4166
|
-
|
|
4163
|
+
interface VariantDigitalProperties {
|
|
4167
4164
|
/** Digital file which will be downloaded by customer after successful purchase. */
|
|
4168
4165
|
digitalFile?: SecuredMedia;
|
|
4169
4166
|
}
|
|
4170
|
-
|
|
4167
|
+
interface SecuredMedia {
|
|
4171
4168
|
/**
|
|
4172
4169
|
* Media ID in media manager.
|
|
4173
4170
|
* @minLength 1
|
|
@@ -4196,7 +4193,7 @@ export interface SecuredMedia {
|
|
|
4196
4193
|
*/
|
|
4197
4194
|
fileType?: FileTypeWithLiterals;
|
|
4198
4195
|
}
|
|
4199
|
-
|
|
4196
|
+
declare enum FileType {
|
|
4200
4197
|
/** Unspecified file type. */
|
|
4201
4198
|
UNSPECIFIED = "UNSPECIFIED",
|
|
4202
4199
|
/** Secure picture file. */
|
|
@@ -4211,15 +4208,15 @@ export declare enum FileType {
|
|
|
4211
4208
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
4212
4209
|
}
|
|
4213
4210
|
/** @enumType */
|
|
4214
|
-
|
|
4215
|
-
|
|
4211
|
+
type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
4212
|
+
interface SubscriptionPricesInfo {
|
|
4216
4213
|
/**
|
|
4217
4214
|
* Subscription prices.
|
|
4218
4215
|
* @maxSize 6
|
|
4219
4216
|
*/
|
|
4220
4217
|
subscriptionPrices?: SubscriptionPrice[];
|
|
4221
4218
|
}
|
|
4222
|
-
|
|
4219
|
+
interface SubscriptionPrice {
|
|
4223
4220
|
/**
|
|
4224
4221
|
* Subscription ID.
|
|
4225
4222
|
* @format GUID
|
|
@@ -4237,7 +4234,7 @@ export interface SubscriptionPrice {
|
|
|
4237
4234
|
*/
|
|
4238
4235
|
pricePerUnit?: SubscriptionPricePerUnit;
|
|
4239
4236
|
}
|
|
4240
|
-
|
|
4237
|
+
interface SubscriptionPricePerUnit {
|
|
4241
4238
|
/**
|
|
4242
4239
|
* Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.
|
|
4243
4240
|
* @readonly
|
|
@@ -4252,13 +4249,13 @@ export interface SubscriptionPricePerUnit {
|
|
|
4252
4249
|
*/
|
|
4253
4250
|
description?: string | null;
|
|
4254
4251
|
}
|
|
4255
|
-
|
|
4252
|
+
interface InventoryStatus {
|
|
4256
4253
|
/** Whether the variant is in stock. */
|
|
4257
4254
|
inStock?: boolean;
|
|
4258
4255
|
/** Whether preorder is enabled for this variant. */
|
|
4259
4256
|
preorderEnabled?: boolean;
|
|
4260
4257
|
}
|
|
4261
|
-
|
|
4258
|
+
interface ExtendedFields {
|
|
4262
4259
|
/**
|
|
4263
4260
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
4264
4261
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -4269,7 +4266,7 @@ export interface ExtendedFields {
|
|
|
4269
4266
|
*/
|
|
4270
4267
|
namespaces?: Record<string, Record<string, any>>;
|
|
4271
4268
|
}
|
|
4272
|
-
|
|
4269
|
+
interface SubscriptionDetails {
|
|
4273
4270
|
/**
|
|
4274
4271
|
* Subscriptions.
|
|
4275
4272
|
* @minSize 1
|
|
@@ -4283,7 +4280,7 @@ export interface SubscriptionDetails {
|
|
|
4283
4280
|
*/
|
|
4284
4281
|
allowOneTimePurchases?: boolean | null;
|
|
4285
4282
|
}
|
|
4286
|
-
|
|
4283
|
+
interface Subscription extends SubscriptionCyclesOneOf {
|
|
4287
4284
|
/** Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`. */
|
|
4288
4285
|
autoRenewal?: boolean;
|
|
4289
4286
|
/**
|
|
@@ -4333,7 +4330,7 @@ export interface Subscription extends SubscriptionCyclesOneOf {
|
|
|
4333
4330
|
discount?: SubscriptionDiscount;
|
|
4334
4331
|
}
|
|
4335
4332
|
/** @oneof */
|
|
4336
|
-
|
|
4333
|
+
interface SubscriptionCyclesOneOf {
|
|
4337
4334
|
/** Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`. */
|
|
4338
4335
|
autoRenewal?: boolean;
|
|
4339
4336
|
/**
|
|
@@ -4344,7 +4341,7 @@ export interface SubscriptionCyclesOneOf {
|
|
|
4344
4341
|
billingCycles?: number;
|
|
4345
4342
|
}
|
|
4346
4343
|
/** Frequency unit of recurring payment */
|
|
4347
|
-
|
|
4344
|
+
declare enum SubscriptionFrequency {
|
|
4348
4345
|
UNDEFINED = "UNDEFINED",
|
|
4349
4346
|
DAY = "DAY",
|
|
4350
4347
|
WEEK = "WEEK",
|
|
@@ -4352,8 +4349,8 @@ export declare enum SubscriptionFrequency {
|
|
|
4352
4349
|
YEAR = "YEAR"
|
|
4353
4350
|
}
|
|
4354
4351
|
/** @enumType */
|
|
4355
|
-
|
|
4356
|
-
|
|
4352
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
4353
|
+
interface SubscriptionDiscount extends SubscriptionDiscountDiscountOneOf {
|
|
4357
4354
|
/**
|
|
4358
4355
|
* Amount to discount from the variant discounted_price.
|
|
4359
4356
|
* @decimalValue options { gt:0, lte:999999999, maxScale:3 }
|
|
@@ -4369,7 +4366,7 @@ export interface SubscriptionDiscount extends SubscriptionDiscountDiscountOneOf
|
|
|
4369
4366
|
type?: DiscountTypeWithLiterals;
|
|
4370
4367
|
}
|
|
4371
4368
|
/** @oneof */
|
|
4372
|
-
|
|
4369
|
+
interface SubscriptionDiscountDiscountOneOf {
|
|
4373
4370
|
/**
|
|
4374
4371
|
* Amount to discount from the variant discounted_price.
|
|
4375
4372
|
* @decimalValue options { gt:0, lte:999999999, maxScale:3 }
|
|
@@ -4382,7 +4379,7 @@ export interface SubscriptionDiscountDiscountOneOf {
|
|
|
4382
4379
|
*/
|
|
4383
4380
|
percentOff?: number;
|
|
4384
4381
|
}
|
|
4385
|
-
|
|
4382
|
+
declare enum DiscountType {
|
|
4386
4383
|
UNKNOWN_DISCOUNT = "UNKNOWN_DISCOUNT",
|
|
4387
4384
|
/** Discount by a specific amount. */
|
|
4388
4385
|
AMOUNT = "AMOUNT",
|
|
@@ -4390,15 +4387,15 @@ export declare enum DiscountType {
|
|
|
4390
4387
|
PERCENT = "PERCENT"
|
|
4391
4388
|
}
|
|
4392
4389
|
/** @enumType */
|
|
4393
|
-
|
|
4394
|
-
|
|
4390
|
+
type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_DISCOUNT' | 'AMOUNT' | 'PERCENT';
|
|
4391
|
+
interface VariantSummary {
|
|
4395
4392
|
/**
|
|
4396
4393
|
* The total number of variants for the product.
|
|
4397
4394
|
* @readonly
|
|
4398
4395
|
*/
|
|
4399
4396
|
variantCount?: number;
|
|
4400
4397
|
}
|
|
4401
|
-
|
|
4398
|
+
interface MinVariantPriceInfo {
|
|
4402
4399
|
/**
|
|
4403
4400
|
* Subscription price calculated by applying subscription discount to the variant `price.actualPrice`
|
|
4404
4401
|
* @readonly
|
|
@@ -4443,13 +4440,13 @@ export interface MinVariantPriceInfo {
|
|
|
4443
4440
|
/** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
|
|
4444
4441
|
compareAtPrice?: FixedMonetaryAmount;
|
|
4445
4442
|
}
|
|
4446
|
-
|
|
4443
|
+
interface MigrateProductVariantsResponse {
|
|
4447
4444
|
}
|
|
4448
|
-
|
|
4445
|
+
interface RecoverProductVariantsRequest {
|
|
4449
4446
|
}
|
|
4450
|
-
|
|
4447
|
+
interface RecoverProductVariantsResponse {
|
|
4451
4448
|
}
|
|
4452
|
-
|
|
4449
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
4453
4450
|
createdEvent?: EntityCreatedEvent;
|
|
4454
4451
|
updatedEvent?: EntityUpdatedEvent;
|
|
4455
4452
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -4484,19 +4481,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
4484
4481
|
entityEventSequence?: string | null;
|
|
4485
4482
|
}
|
|
4486
4483
|
/** @oneof */
|
|
4487
|
-
|
|
4484
|
+
interface DomainEventBodyOneOf {
|
|
4488
4485
|
createdEvent?: EntityCreatedEvent;
|
|
4489
4486
|
updatedEvent?: EntityUpdatedEvent;
|
|
4490
4487
|
deletedEvent?: EntityDeletedEvent;
|
|
4491
4488
|
actionEvent?: ActionEvent;
|
|
4492
4489
|
}
|
|
4493
|
-
|
|
4490
|
+
interface EntityCreatedEvent {
|
|
4494
4491
|
entity?: string;
|
|
4495
4492
|
}
|
|
4496
|
-
|
|
4493
|
+
interface RestoreInfo {
|
|
4497
4494
|
deletedDate?: Date | null;
|
|
4498
4495
|
}
|
|
4499
|
-
|
|
4496
|
+
interface EntityUpdatedEvent {
|
|
4500
4497
|
/**
|
|
4501
4498
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
4502
4499
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -4504,16 +4501,16 @@ export interface EntityUpdatedEvent {
|
|
|
4504
4501
|
*/
|
|
4505
4502
|
currentEntity?: string;
|
|
4506
4503
|
}
|
|
4507
|
-
|
|
4504
|
+
interface EntityDeletedEvent {
|
|
4508
4505
|
/** Entity that was deleted. */
|
|
4509
4506
|
deletedEntity?: string | null;
|
|
4510
4507
|
}
|
|
4511
|
-
|
|
4508
|
+
interface ActionEvent {
|
|
4512
4509
|
body?: string;
|
|
4513
4510
|
}
|
|
4514
|
-
|
|
4511
|
+
interface Empty {
|
|
4515
4512
|
}
|
|
4516
|
-
|
|
4513
|
+
interface MessageEnvelope {
|
|
4517
4514
|
/**
|
|
4518
4515
|
* App instance ID.
|
|
4519
4516
|
* @format GUID
|
|
@@ -4529,7 +4526,7 @@ export interface MessageEnvelope {
|
|
|
4529
4526
|
/** Stringify payload. */
|
|
4530
4527
|
data?: string;
|
|
4531
4528
|
}
|
|
4532
|
-
|
|
4529
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4533
4530
|
/**
|
|
4534
4531
|
* ID of a site visitor that has not logged in to the site.
|
|
4535
4532
|
* @format GUID
|
|
@@ -4554,7 +4551,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
4554
4551
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4555
4552
|
}
|
|
4556
4553
|
/** @oneof */
|
|
4557
|
-
|
|
4554
|
+
interface IdentificationDataIdOneOf {
|
|
4558
4555
|
/**
|
|
4559
4556
|
* ID of a site visitor that has not logged in to the site.
|
|
4560
4557
|
* @format GUID
|
|
@@ -4576,7 +4573,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
4576
4573
|
*/
|
|
4577
4574
|
appId?: string;
|
|
4578
4575
|
}
|
|
4579
|
-
|
|
4576
|
+
declare enum WebhookIdentityType {
|
|
4580
4577
|
UNKNOWN = "UNKNOWN",
|
|
4581
4578
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
4582
4579
|
MEMBER = "MEMBER",
|
|
@@ -4584,8 +4581,8 @@ export declare enum WebhookIdentityType {
|
|
|
4584
4581
|
APP = "APP"
|
|
4585
4582
|
}
|
|
4586
4583
|
/** @enumType */
|
|
4587
|
-
|
|
4588
|
-
|
|
4584
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
4585
|
+
interface QueryVariantsOptions {
|
|
4589
4586
|
/**
|
|
4590
4587
|
* A list of requested fields to be included in the response.
|
|
4591
4588
|
* @maxSize 100
|
|
@@ -4599,13 +4596,13 @@ interface QueryCursorResult {
|
|
|
4599
4596
|
length: number;
|
|
4600
4597
|
pageSize: number;
|
|
4601
4598
|
}
|
|
4602
|
-
|
|
4599
|
+
interface VariantsQueryResult extends QueryCursorResult {
|
|
4603
4600
|
items: ReadOnlyVariant[];
|
|
4604
4601
|
query: VariantsQueryBuilder;
|
|
4605
4602
|
next: () => Promise<VariantsQueryResult>;
|
|
4606
4603
|
prev: () => Promise<VariantsQueryResult>;
|
|
4607
4604
|
}
|
|
4608
|
-
|
|
4605
|
+
interface VariantsQueryBuilder {
|
|
4609
4606
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4610
4607
|
* @param value - Value to compare against.
|
|
4611
4608
|
* @documentationMaturity preview
|
|
@@ -4669,14 +4666,14 @@ export interface VariantsQueryBuilder {
|
|
|
4669
4666
|
/** @documentationMaturity preview */
|
|
4670
4667
|
find: () => Promise<VariantsQueryResult>;
|
|
4671
4668
|
}
|
|
4672
|
-
|
|
4669
|
+
interface SearchVariantsOptions {
|
|
4673
4670
|
/**
|
|
4674
4671
|
* A list of requested fields to be included in the response.
|
|
4675
4672
|
* @maxSize 100
|
|
4676
4673
|
*/
|
|
4677
4674
|
fields?: RequestedFieldsWithLiterals[];
|
|
4678
4675
|
}
|
|
4679
|
-
|
|
4676
|
+
interface ReadOnlyVariantSearchSpec extends SearchSpec {
|
|
4680
4677
|
aggregatable: [
|
|
4681
4678
|
'barcode',
|
|
4682
4679
|
'internalMetadata.rowState',
|
|
@@ -4729,120 +4726,5 @@ export interface ReadOnlyVariantSearchSpec extends SearchSpec {
|
|
|
4729
4726
|
}
|
|
4730
4727
|
];
|
|
4731
4728
|
}
|
|
4732
|
-
|
|
4733
|
-
export type
|
|
4734
|
-
/**
|
|
4735
|
-
Cursor pointing to page of results.
|
|
4736
|
-
When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
4737
|
-
*/
|
|
4738
|
-
cursorPaging?: {
|
|
4739
|
-
/**
|
|
4740
|
-
Maximum number of items to return in the results.
|
|
4741
|
-
@max: 1000
|
|
4742
|
-
*/
|
|
4743
|
-
limit?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['limit'] | null;
|
|
4744
|
-
/**
|
|
4745
|
-
Pointer to the next or previous page in the list of results.
|
|
4746
|
-
|
|
4747
|
-
Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
4748
|
-
Not relevant for the first request.
|
|
4749
|
-
@maxLength: 16000
|
|
4750
|
-
*/
|
|
4751
|
-
cursor?: NonNullable<CommonSearchWithEntityContext['cursorPaging']>['cursor'] | null;
|
|
4752
|
-
};
|
|
4753
|
-
/**
|
|
4754
|
-
A filter object. See documentation [here](https://bo.wix.com/wix-docs/rnd/platformization-guidelines/api-query-language#platformization-guidelines_api-query-language_defining-in-protobuf)
|
|
4755
|
-
*/
|
|
4756
|
-
filter?: CommonSearchWithEntityContext['filter'] | null;
|
|
4757
|
-
/**
|
|
4758
|
-
Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
|
|
4759
|
-
@maxSize: 10
|
|
4760
|
-
*/
|
|
4761
|
-
sort?: {
|
|
4762
|
-
/**
|
|
4763
|
-
Name of the field to sort by.
|
|
4764
|
-
@maxLength: 512
|
|
4765
|
-
*/
|
|
4766
|
-
fieldName?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['fieldName'];
|
|
4767
|
-
/**
|
|
4768
|
-
Sort order.
|
|
4769
|
-
*/
|
|
4770
|
-
order?: NonNullable<CommonSearchWithEntityContext['sort']>[number]['order'];
|
|
4771
|
-
}[];
|
|
4772
|
-
/**
|
|
4773
|
-
Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
|
|
4774
|
-
@maxSize: 10
|
|
4775
|
-
*/
|
|
4776
|
-
aggregations?: {
|
|
4777
|
-
/**
|
|
4778
|
-
Value aggregation
|
|
4779
|
-
*/
|
|
4780
|
-
value?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['value'];
|
|
4781
|
-
/**
|
|
4782
|
-
Range aggregation
|
|
4783
|
-
*/
|
|
4784
|
-
range?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['range'];
|
|
4785
|
-
/**
|
|
4786
|
-
Scalar aggregation
|
|
4787
|
-
*/
|
|
4788
|
-
scalar?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['scalar'];
|
|
4789
|
-
/**
|
|
4790
|
-
Date histogram aggregation
|
|
4791
|
-
*/
|
|
4792
|
-
dateHistogram?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['dateHistogram'];
|
|
4793
|
-
/**
|
|
4794
|
-
Nested aggregation
|
|
4795
|
-
*/
|
|
4796
|
-
nested?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['nested'];
|
|
4797
|
-
/**
|
|
4798
|
-
User-defined name of aggregation, should be unique, will appear in aggregation results
|
|
4799
|
-
@maxLength: 100
|
|
4800
|
-
*/
|
|
4801
|
-
name?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['name'] | null;
|
|
4802
|
-
/**
|
|
4803
|
-
Type of aggregation, client must provide matching aggregation field below
|
|
4804
|
-
*/
|
|
4805
|
-
type?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['type'];
|
|
4806
|
-
/**
|
|
4807
|
-
Field to aggregate by, use dot notation to specify json path
|
|
4808
|
-
@maxLength: 200
|
|
4809
|
-
*/
|
|
4810
|
-
fieldPath?: NonNullable<CommonSearchWithEntityContext['aggregations']>[number]['fieldPath'];
|
|
4811
|
-
}[];
|
|
4812
|
-
/**
|
|
4813
|
-
Free text to match in searchable fields
|
|
4814
|
-
*/
|
|
4815
|
-
search?: {
|
|
4816
|
-
/**
|
|
4817
|
-
Defines how separate search terms in `expression` are combined
|
|
4818
|
-
*/
|
|
4819
|
-
mode?: NonNullable<CommonSearchWithEntityContext['search']>['mode'];
|
|
4820
|
-
/**
|
|
4821
|
-
Search term or expression
|
|
4822
|
-
@maxLength: 100
|
|
4823
|
-
*/
|
|
4824
|
-
expression?: NonNullable<CommonSearchWithEntityContext['search']>['expression'] | null;
|
|
4825
|
-
/**
|
|
4826
|
-
Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path
|
|
4827
|
-
@maxLength: 200,
|
|
4828
|
-
@maxSize: 20
|
|
4829
|
-
*/
|
|
4830
|
-
fields?: NonNullable<CommonSearchWithEntityContext['search']>['fields'];
|
|
4831
|
-
/**
|
|
4832
|
-
Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm)
|
|
4833
|
-
*/
|
|
4834
|
-
fuzzy?: NonNullable<CommonSearchWithEntityContext['search']>['fuzzy'];
|
|
4835
|
-
};
|
|
4836
|
-
/**
|
|
4837
|
-
UTC offset or IANA time zone. Valid values are
|
|
4838
|
-
ISO 8601 UTC offsets, such as +02:00 or -06:00,
|
|
4839
|
-
and IANA time zone IDs, such as Europe/Rome
|
|
4840
|
-
|
|
4841
|
-
Affects all filters and aggregations returned values.
|
|
4842
|
-
You may override this behavior in a specific filter by providing
|
|
4843
|
-
timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
|
|
4844
|
-
@maxLength: 50
|
|
4845
|
-
*/
|
|
4846
|
-
timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
|
|
4847
|
-
};
|
|
4848
|
-
export {};
|
|
4729
|
+
|
|
4730
|
+
export { type ActionEvent, type Aggregation, type AggregationData, type AggregationDateHistogramAggregation, type AggregationKindOneOf, type AggregationNestedAggregation, type AggregationRangeAggregation, type AggregationResults, type AggregationResultsResultOneOf, type AggregationResultsScalarResult, type AggregationScalarAggregation, AggregationType, type AggregationValueAggregation, type AggregationValueAggregationOptionsOneOf, Alignment, type AnchorData, type AppEmbedData, type AppEmbedDataAppDataOneOf, AppType, type AudioData, AvailabilityStatus, type Background, type BackgroundBackgroundOneOf, BackgroundType, type BlockquoteData, type BookingData, type Border, type BorderColors, type Brand, type BreadCrumb, type BreadcrumbsInfo, type BulletedListData, type ButtonData, type CaptionData, type CellStyle, ChoiceType, type ChoicesSettings, type CodeBlockData, type CollapsibleListData, type ColorData, type Colors, type CommonAggregation, type CommonAggregationKindOneOf, CommonAggregationType, CommonScalarType, type CommonSearchDetails, CommonSortOrder, type CommonSorting, type CommonVideoResolution, type ConnectedModifier, type ConnectedModifierChoice, type ConnectedModifierChoiceValueOneOf, type ConnectedModifierModifierSettingsOneOf, type ConnectedOption, type ConnectedOptionChoice, type ConnectedOptionChoiceValueOneOf, type ConnectedOptionOptionSettingsOneOf, Crop, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type CursorSearch, type CursorSearchPagingMethodOneOf, type Cursors, type DateHistogramAggregation, DateHistogramAggregationInterval, type DateHistogramResult, type DateHistogramResults, type Decoration, type DecorationDataOneOf, DecorationType, type DeprecatedSearchVariantsWithOffsetRequest, type DeprecatedSearchVariantsWithOffsetResponse, type Design, type Dimensions, Direction, DiscountType, type DividerData, type DocumentStyle, type DomainEvent, type DomainEventBodyOneOf, type EmbedData, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventData, type ExtendedFields, type FileData, type FileSource, type FileSourceDataOneOf, FileType, type FixedMonetaryAmount, type FontSizeData, FontType, type FreeTextSettings, type GIF, type GIFData, GIFType, type GalleryData, type GalleryOptions, type Gradient, type GroupByAggregation, type GroupByAggregationKindOneOf, type GroupByValueResults, type HTMLData, type HTMLDataDataOneOf, type HeadingData, type Height, type IdentificationData, type IdentificationDataIdOneOf, type Image, type ImageData, type ImageDataStyles, type IncludeMissingValuesOptions, type InfoSection, InitialExpandedItems, type InternalMetadata, InternalRowState, Interval, type Inventory, type InventoryStatus, type Item, type ItemDataOneOf, type ItemStyle, type Keyword, type Layout, type LayoutCellData, LayoutType, LineStyle, type Link, type LinkData, type LinkDataOneOf, type LinkPreviewData, type LinkPreviewDataStyles, type ListValue, type MapData, type MapSettings, MapType, MeasurementUnit, type Media, type MediaItemsInfo, MediaType, type MentionData, type MessageEnvelope, type Metadata, type MigrateProductVariantsRequest, type MigrateProductVariantsResponse, type MinVariantPriceInfo, MissingValues, Mode, type ModifierChoicesSettings, ModifierRenderType, type MultipleColors, type NestedAggregation, type NestedAggregationItem, type NestedAggregationItemKindOneOf, type NestedAggregationNestedAggregationItem, type NestedAggregationNestedAggregationItemKindOneOf, NestedAggregationNestedAggregationType, type NestedAggregationResults, type NestedAggregationResultsResultOneOf, NestedAggregationType, type NestedResultValue, type NestedResultValueResultOneOf, type NestedResults, type NestedValueAggregationResult, type Node, type NodeDataOneOf, type NodeStyle, NodeType, NullValue, type Oembed, type Option, type OptionChoice, type OptionChoiceIds, type OptionChoiceNames, type OptionDesign, type OptionLayout, type OrderedListData, Orientation, type PDFSettings, type PagingMetadata, type ParagraphData, type Permissions, type PhysicalProperties, type PlatformOffsetSearch, type PlatformOffsetSearchPagingMethodOneOf, type PlatformPaging, type PlaybackOptions, type PluginContainerData, PluginContainerDataAlignment, type PluginContainerDataWidth, type PluginContainerDataWidthDataOneOf, type Poll, type PollData, type PollDataLayout, type PollDesign, type PollLayout, PollLayoutDirection, PollLayoutType, type PollSettings, Position, PreorderStatus, type PriceInfo, type PricePerUnit, type PricePerUnitRange, type PricePerUnitRangePricePerUnit, type PricePerUnitSettings, type PriceRange, type Product, type ProductCategoriesInfo, type ProductCategory, type ProductCategoryIdsInfo, type ProductFields, type ProductFieldsTypedPropertiesOneOf, type ProductMedia, type ProductMediaMediaOneOf, ProductMediaMediaType, type ProductMediaSetByOneOf, ProductOptionRenderType, ProductPreorderAvailability, ProductType, type ProductTypedPropertiesOneOf, type QueryVariantsOptions, type QueryVariantsRequest, type QueryVariantsResponse, type RangeAggregation, type RangeAggregationRangeBucket, type RangeAggregationResult, type RangeBucket, type RangeResult, type RangeResults, type ReadOnlyVariant, type ReadOnlyVariantSearchSpec, type ReadOnlyVariantTypedPropertiesOneOf, type RecoverProductVariantsRequest, type RecoverProductVariantsResponse, type Rel, RequestedFields, type RestoreInfo, type Results, type RevenueDetails, type Ribbon, type RichContent, type ScalarAggregation, type ScalarResult, ScalarType, type SearchDetails, SearchDetailsMode, type SearchVariantsOptions, type SearchVariantsRequest, type SearchVariantsResponse, type SecuredMedia, SecuredMediaFileType, type SeoSchema, type Settings, SortDirection, SortOrder, SortType, type Sorting, Source, type Spoiler, type SpoilerData, type Styles, type StylesBorder, type Subscription, type SubscriptionCyclesOneOf, type SubscriptionDetails, type SubscriptionDiscount, type SubscriptionDiscountDiscountOneOf, SubscriptionFrequency, type SubscriptionPrice, type SubscriptionPricePerUnit, type SubscriptionPricesInfo, type TableCellData, type TableData, type Tag, Target, TextAlignment, type TextData, type TextNodeStyle, type TextStyle, type Thumbnail, type Thumbnails, ThumbnailsAlignment, Type, type V1Media, type V3FixedMonetaryAmount, type V3InventoryStatus, type V3OptionChoice, type V3OptionChoiceIds, type V3OptionChoiceNames, type V3PhysicalProperties, type V3PriceInfo, type V3PricePerUnit, type V3PricePerUnitSettings, type V3ProductMedia, type V3ProductMediaMediaOneOf, type V3ProductMediaSetByOneOf, V3ProductType, type V3RevenueDetails, type V3SecuredMedia, type V3SubscriptionPrice, type V3SubscriptionPricePerUnit, type V3SubscriptionPricesInfo, type V3Thumbnail, type V3VariantDigitalProperties, type V3VariantPhysicalProperties, type V3WeightMeasurementUnitInfo, type ValueAggregation, type ValueAggregationIncludeMissingValuesOptions, ValueAggregationMissingValues, type ValueAggregationOptionsOneOf, type ValueAggregationResult, ValueAggregationSortDirection, ValueAggregationSortType, type ValueResult, type ValueResults, type Variant, type VariantDigitalProperties, type VariantPhysicalProperties, type VariantSummary, type VariantTypedPropertiesOneOf, type VariantsInfo, type VariantsQueryBuilder, type VariantsQueryResult, VerticalAlignment, type Video, type VideoData, type VideoResolution, ViewMode, ViewRole, VoteRole, WebhookIdentityType, type WeightMeasurementUnitInfo, type WeightRange, WeightUnit, Width, WidthType };
|