@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, Search } 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
|
*
|
|
@@ -1778,7 +1777,7 @@ export interface Product extends ProductTypedPropertiesOneOf {
|
|
|
1778
1777
|
variantSummary?: VariantSummary;
|
|
1779
1778
|
}
|
|
1780
1779
|
/** @oneof */
|
|
1781
|
-
|
|
1780
|
+
interface ProductTypedPropertiesOneOf {
|
|
1782
1781
|
/**
|
|
1783
1782
|
* Physical properties.
|
|
1784
1783
|
*
|
|
@@ -1786,7 +1785,7 @@ export interface ProductTypedPropertiesOneOf {
|
|
|
1786
1785
|
*/
|
|
1787
1786
|
physicalProperties?: PhysicalProperties;
|
|
1788
1787
|
}
|
|
1789
|
-
|
|
1788
|
+
interface RichContent {
|
|
1790
1789
|
/** Node objects representing a rich content document. */
|
|
1791
1790
|
nodes?: Node[];
|
|
1792
1791
|
/** Object metadata. */
|
|
@@ -1794,7 +1793,7 @@ export interface RichContent {
|
|
|
1794
1793
|
/** Global styling for header, paragraph, block quote, and code block nodes in the object. */
|
|
1795
1794
|
documentStyle?: DocumentStyle;
|
|
1796
1795
|
}
|
|
1797
|
-
|
|
1796
|
+
interface Node extends NodeDataOneOf {
|
|
1798
1797
|
/** Data for a button node. */
|
|
1799
1798
|
buttonData?: ButtonData;
|
|
1800
1799
|
/** Data for a code block node. */
|
|
@@ -1859,7 +1858,7 @@ export interface Node extends NodeDataOneOf {
|
|
|
1859
1858
|
style?: NodeStyle;
|
|
1860
1859
|
}
|
|
1861
1860
|
/** @oneof */
|
|
1862
|
-
|
|
1861
|
+
interface NodeDataOneOf {
|
|
1863
1862
|
/** Data for a button node. */
|
|
1864
1863
|
buttonData?: ButtonData;
|
|
1865
1864
|
/** Data for a code block node. */
|
|
@@ -1915,7 +1914,7 @@ export interface NodeDataOneOf {
|
|
|
1915
1914
|
/** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
|
|
1916
1915
|
layoutCellData?: LayoutCellData;
|
|
1917
1916
|
}
|
|
1918
|
-
|
|
1917
|
+
declare enum NodeType {
|
|
1919
1918
|
PARAGRAPH = "PARAGRAPH",
|
|
1920
1919
|
TEXT = "TEXT",
|
|
1921
1920
|
HEADING = "HEADING",
|
|
@@ -1952,8 +1951,8 @@ export declare enum NodeType {
|
|
|
1952
1951
|
LAYOUT_CELL = "LAYOUT_CELL"
|
|
1953
1952
|
}
|
|
1954
1953
|
/** @enumType */
|
|
1955
|
-
|
|
1956
|
-
|
|
1954
|
+
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';
|
|
1955
|
+
interface NodeStyle {
|
|
1957
1956
|
/** The top padding value in pixels. */
|
|
1958
1957
|
paddingTop?: string | null;
|
|
1959
1958
|
/** The bottom padding value in pixels. */
|
|
@@ -1961,7 +1960,7 @@ export interface NodeStyle {
|
|
|
1961
1960
|
/** The background color as a hexadecimal value. */
|
|
1962
1961
|
backgroundColor?: string | null;
|
|
1963
1962
|
}
|
|
1964
|
-
|
|
1963
|
+
interface ButtonData {
|
|
1965
1964
|
/** Styling for the button's container. */
|
|
1966
1965
|
containerData?: PluginContainerData;
|
|
1967
1966
|
/** The button type. */
|
|
@@ -1973,7 +1972,7 @@ export interface ButtonData {
|
|
|
1973
1972
|
/** Button link details. */
|
|
1974
1973
|
link?: Link;
|
|
1975
1974
|
}
|
|
1976
|
-
|
|
1975
|
+
interface Border {
|
|
1977
1976
|
/**
|
|
1978
1977
|
* Deprecated: Use `borderWidth` in `styles` instead.
|
|
1979
1978
|
* @deprecated
|
|
@@ -1985,7 +1984,7 @@ export interface Border {
|
|
|
1985
1984
|
*/
|
|
1986
1985
|
radius?: number | null;
|
|
1987
1986
|
}
|
|
1988
|
-
|
|
1987
|
+
interface Colors {
|
|
1989
1988
|
/**
|
|
1990
1989
|
* Deprecated: Use `textColor` in `styles` instead.
|
|
1991
1990
|
* @deprecated
|
|
@@ -2002,7 +2001,7 @@ export interface Colors {
|
|
|
2002
2001
|
*/
|
|
2003
2002
|
background?: string | null;
|
|
2004
2003
|
}
|
|
2005
|
-
|
|
2004
|
+
interface PluginContainerData {
|
|
2006
2005
|
/** The width of the node when it's displayed. */
|
|
2007
2006
|
width?: PluginContainerDataWidth;
|
|
2008
2007
|
/** The node's alignment within its container. */
|
|
@@ -2014,7 +2013,7 @@ export interface PluginContainerData {
|
|
|
2014
2013
|
/** 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`. */
|
|
2015
2014
|
textWrap?: boolean | null;
|
|
2016
2015
|
}
|
|
2017
|
-
|
|
2016
|
+
declare enum WidthType {
|
|
2018
2017
|
/** Width matches the content width */
|
|
2019
2018
|
CONTENT = "CONTENT",
|
|
2020
2019
|
/** Small Width */
|
|
@@ -2025,8 +2024,8 @@ export declare enum WidthType {
|
|
|
2025
2024
|
FULL_WIDTH = "FULL_WIDTH"
|
|
2026
2025
|
}
|
|
2027
2026
|
/** @enumType */
|
|
2028
|
-
|
|
2029
|
-
|
|
2027
|
+
type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
|
|
2028
|
+
interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
|
|
2030
2029
|
/**
|
|
2031
2030
|
* One of the following predefined width options:
|
|
2032
2031
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -2039,7 +2038,7 @@ export interface PluginContainerDataWidth extends PluginContainerDataWidthDataOn
|
|
|
2039
2038
|
custom?: string | null;
|
|
2040
2039
|
}
|
|
2041
2040
|
/** @oneof */
|
|
2042
|
-
|
|
2041
|
+
interface PluginContainerDataWidthDataOneOf {
|
|
2043
2042
|
/**
|
|
2044
2043
|
* One of the following predefined width options:
|
|
2045
2044
|
* `CONTENT`: The width of the container matches the content width.
|
|
@@ -2051,7 +2050,7 @@ export interface PluginContainerDataWidthDataOneOf {
|
|
|
2051
2050
|
/** A custom width value in pixels. */
|
|
2052
2051
|
custom?: string | null;
|
|
2053
2052
|
}
|
|
2054
|
-
|
|
2053
|
+
declare enum PluginContainerDataAlignment {
|
|
2055
2054
|
/** Center Alignment */
|
|
2056
2055
|
CENTER = "CENTER",
|
|
2057
2056
|
/** Left Alignment */
|
|
@@ -2060,8 +2059,8 @@ export declare enum PluginContainerDataAlignment {
|
|
|
2060
2059
|
RIGHT = "RIGHT"
|
|
2061
2060
|
}
|
|
2062
2061
|
/** @enumType */
|
|
2063
|
-
|
|
2064
|
-
|
|
2062
|
+
type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
2063
|
+
interface Spoiler {
|
|
2065
2064
|
/** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
|
|
2066
2065
|
enabled?: boolean | null;
|
|
2067
2066
|
/** The description displayed on top of the spoiler cover. */
|
|
@@ -2069,19 +2068,19 @@ export interface Spoiler {
|
|
|
2069
2068
|
/** The text for the button used to remove the spoiler cover. */
|
|
2070
2069
|
buttonText?: string | null;
|
|
2071
2070
|
}
|
|
2072
|
-
|
|
2071
|
+
interface Height {
|
|
2073
2072
|
/** A custom height value in pixels. */
|
|
2074
2073
|
custom?: string | null;
|
|
2075
2074
|
}
|
|
2076
|
-
|
|
2075
|
+
declare enum Type {
|
|
2077
2076
|
/** Regular link button */
|
|
2078
2077
|
LINK = "LINK",
|
|
2079
2078
|
/** Triggers custom action that is defined in plugin configuration by the consumer */
|
|
2080
2079
|
ACTION = "ACTION"
|
|
2081
2080
|
}
|
|
2082
2081
|
/** @enumType */
|
|
2083
|
-
|
|
2084
|
-
|
|
2082
|
+
type TypeWithLiterals = Type | 'LINK' | 'ACTION';
|
|
2083
|
+
interface Styles {
|
|
2085
2084
|
/**
|
|
2086
2085
|
* Deprecated: Use `borderWidth` and `borderRadius` instead.
|
|
2087
2086
|
* @deprecated
|
|
@@ -2134,7 +2133,7 @@ export interface Styles {
|
|
|
2134
2133
|
/** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
|
|
2135
2134
|
buttonSize?: string | null;
|
|
2136
2135
|
}
|
|
2137
|
-
|
|
2136
|
+
interface Link extends LinkDataOneOf {
|
|
2138
2137
|
/** The absolute URL for the linked document. */
|
|
2139
2138
|
url?: string;
|
|
2140
2139
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
@@ -2153,13 +2152,13 @@ export interface Link extends LinkDataOneOf {
|
|
|
2153
2152
|
customData?: string | null;
|
|
2154
2153
|
}
|
|
2155
2154
|
/** @oneof */
|
|
2156
|
-
|
|
2155
|
+
interface LinkDataOneOf {
|
|
2157
2156
|
/** The absolute URL for the linked document. */
|
|
2158
2157
|
url?: string;
|
|
2159
2158
|
/** The target node's ID. Used for linking to another node in this object. */
|
|
2160
2159
|
anchor?: string;
|
|
2161
2160
|
}
|
|
2162
|
-
|
|
2161
|
+
declare enum Target {
|
|
2163
2162
|
/** Opens the linked document in the same frame as it was clicked (this is default) */
|
|
2164
2163
|
SELF = "SELF",
|
|
2165
2164
|
/** Opens the linked document in a new window or tab */
|
|
@@ -2170,8 +2169,8 @@ export declare enum Target {
|
|
|
2170
2169
|
TOP = "TOP"
|
|
2171
2170
|
}
|
|
2172
2171
|
/** @enumType */
|
|
2173
|
-
|
|
2174
|
-
|
|
2172
|
+
type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
|
|
2173
|
+
interface Rel {
|
|
2175
2174
|
/** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
|
|
2176
2175
|
nofollow?: boolean | null;
|
|
2177
2176
|
/** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
|
|
@@ -2181,17 +2180,17 @@ export interface Rel {
|
|
|
2181
2180
|
/** Indicates that this link protect referral information from being passed to the target website. */
|
|
2182
2181
|
noreferrer?: boolean | null;
|
|
2183
2182
|
}
|
|
2184
|
-
|
|
2183
|
+
interface CodeBlockData {
|
|
2185
2184
|
/** Styling for the code block's text. */
|
|
2186
2185
|
textStyle?: TextStyle;
|
|
2187
2186
|
}
|
|
2188
|
-
|
|
2187
|
+
interface TextStyle {
|
|
2189
2188
|
/** Text alignment. Defaults to `AUTO`. */
|
|
2190
2189
|
textAlignment?: TextAlignmentWithLiterals;
|
|
2191
2190
|
/** 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. */
|
|
2192
2191
|
lineHeight?: string | null;
|
|
2193
2192
|
}
|
|
2194
|
-
|
|
2193
|
+
declare enum TextAlignment {
|
|
2195
2194
|
/** browser default, eqivalent to `initial` */
|
|
2196
2195
|
AUTO = "AUTO",
|
|
2197
2196
|
/** Left align */
|
|
@@ -2204,8 +2203,8 @@ export declare enum TextAlignment {
|
|
|
2204
2203
|
JUSTIFY = "JUSTIFY"
|
|
2205
2204
|
}
|
|
2206
2205
|
/** @enumType */
|
|
2207
|
-
|
|
2208
|
-
|
|
2206
|
+
type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
|
|
2207
|
+
interface DividerData {
|
|
2209
2208
|
/** Styling for the divider's container. */
|
|
2210
2209
|
containerData?: PluginContainerData;
|
|
2211
2210
|
/** Divider line style. */
|
|
@@ -2215,7 +2214,7 @@ export interface DividerData {
|
|
|
2215
2214
|
/** Divider alignment. */
|
|
2216
2215
|
alignment?: AlignmentWithLiterals;
|
|
2217
2216
|
}
|
|
2218
|
-
|
|
2217
|
+
declare enum LineStyle {
|
|
2219
2218
|
/** Single Line */
|
|
2220
2219
|
SINGLE = "SINGLE",
|
|
2221
2220
|
/** Double Line */
|
|
@@ -2226,8 +2225,8 @@ export declare enum LineStyle {
|
|
|
2226
2225
|
DOTTED = "DOTTED"
|
|
2227
2226
|
}
|
|
2228
2227
|
/** @enumType */
|
|
2229
|
-
|
|
2230
|
-
|
|
2228
|
+
type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
|
|
2229
|
+
declare enum Width {
|
|
2231
2230
|
/** Large line */
|
|
2232
2231
|
LARGE = "LARGE",
|
|
2233
2232
|
/** Medium line */
|
|
@@ -2236,8 +2235,8 @@ export declare enum Width {
|
|
|
2236
2235
|
SMALL = "SMALL"
|
|
2237
2236
|
}
|
|
2238
2237
|
/** @enumType */
|
|
2239
|
-
|
|
2240
|
-
|
|
2238
|
+
type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
|
|
2239
|
+
declare enum Alignment {
|
|
2241
2240
|
/** Center alignment */
|
|
2242
2241
|
CENTER = "CENTER",
|
|
2243
2242
|
/** Left alignment */
|
|
@@ -2246,8 +2245,8 @@ export declare enum Alignment {
|
|
|
2246
2245
|
RIGHT = "RIGHT"
|
|
2247
2246
|
}
|
|
2248
2247
|
/** @enumType */
|
|
2249
|
-
|
|
2250
|
-
|
|
2248
|
+
type AlignmentWithLiterals = Alignment | 'CENTER' | 'LEFT' | 'RIGHT';
|
|
2249
|
+
interface FileData {
|
|
2251
2250
|
/** Styling for the file's container. */
|
|
2252
2251
|
containerData?: PluginContainerData;
|
|
2253
2252
|
/** The source for the file's data. */
|
|
@@ -2270,7 +2269,7 @@ export interface FileData {
|
|
|
2270
2269
|
/** File size in KB. */
|
|
2271
2270
|
sizeInKb?: string | null;
|
|
2272
2271
|
}
|
|
2273
|
-
|
|
2272
|
+
declare enum ViewMode {
|
|
2274
2273
|
/** No PDF view */
|
|
2275
2274
|
NONE = "NONE",
|
|
2276
2275
|
/** Full PDF view */
|
|
@@ -2279,8 +2278,8 @@ export declare enum ViewMode {
|
|
|
2279
2278
|
MINI = "MINI"
|
|
2280
2279
|
}
|
|
2281
2280
|
/** @enumType */
|
|
2282
|
-
|
|
2283
|
-
|
|
2281
|
+
type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
|
|
2282
|
+
interface FileSource extends FileSourceDataOneOf {
|
|
2284
2283
|
/** The absolute URL for the file's source. */
|
|
2285
2284
|
url?: string | null;
|
|
2286
2285
|
/**
|
|
@@ -2294,7 +2293,7 @@ export interface FileSource extends FileSourceDataOneOf {
|
|
|
2294
2293
|
private?: boolean | null;
|
|
2295
2294
|
}
|
|
2296
2295
|
/** @oneof */
|
|
2297
|
-
|
|
2296
|
+
interface FileSourceDataOneOf {
|
|
2298
2297
|
/** The absolute URL for the file's source. */
|
|
2299
2298
|
url?: string | null;
|
|
2300
2299
|
/**
|
|
@@ -2305,7 +2304,7 @@ export interface FileSourceDataOneOf {
|
|
|
2305
2304
|
/** An ID that's resolved to a URL by a resolver function. */
|
|
2306
2305
|
id?: string | null;
|
|
2307
2306
|
}
|
|
2308
|
-
|
|
2307
|
+
interface PDFSettings {
|
|
2309
2308
|
/**
|
|
2310
2309
|
* PDF view mode. One of the following:
|
|
2311
2310
|
* `NONE` : The PDF isn't displayed.
|
|
@@ -2318,7 +2317,7 @@ export interface PDFSettings {
|
|
|
2318
2317
|
/** Sets whether the PDF print button is disabled. Defaults to `false`. */
|
|
2319
2318
|
disablePrint?: boolean | null;
|
|
2320
2319
|
}
|
|
2321
|
-
|
|
2320
|
+
interface GalleryData {
|
|
2322
2321
|
/** Styling for the gallery's container. */
|
|
2323
2322
|
containerData?: PluginContainerData;
|
|
2324
2323
|
/** The items in the gallery. */
|
|
@@ -2330,7 +2329,7 @@ export interface GalleryData {
|
|
|
2330
2329
|
/** Sets whether the gallery's download button is disabled. Defaults to `false`. */
|
|
2331
2330
|
disableDownload?: boolean | null;
|
|
2332
2331
|
}
|
|
2333
|
-
|
|
2332
|
+
interface V1Media {
|
|
2334
2333
|
/** The source for the media's data. */
|
|
2335
2334
|
src?: FileSource;
|
|
2336
2335
|
/** Media width in pixels. */
|
|
@@ -2340,19 +2339,19 @@ export interface V1Media {
|
|
|
2340
2339
|
/** Media duration in seconds. Only relevant for audio and video files. */
|
|
2341
2340
|
duration?: number | null;
|
|
2342
2341
|
}
|
|
2343
|
-
|
|
2342
|
+
interface Image {
|
|
2344
2343
|
/** Image file details. */
|
|
2345
2344
|
media?: V1Media;
|
|
2346
2345
|
/** Link details for images that are links. */
|
|
2347
2346
|
link?: Link;
|
|
2348
2347
|
}
|
|
2349
|
-
|
|
2348
|
+
interface Video {
|
|
2350
2349
|
/** Video file details. */
|
|
2351
2350
|
media?: V1Media;
|
|
2352
2351
|
/** Video thumbnail file details. */
|
|
2353
2352
|
thumbnail?: V1Media;
|
|
2354
2353
|
}
|
|
2355
|
-
|
|
2354
|
+
interface Item extends ItemDataOneOf {
|
|
2356
2355
|
/** An image item. */
|
|
2357
2356
|
image?: Image;
|
|
2358
2357
|
/** A video item. */
|
|
@@ -2363,13 +2362,13 @@ export interface Item extends ItemDataOneOf {
|
|
|
2363
2362
|
altText?: string | null;
|
|
2364
2363
|
}
|
|
2365
2364
|
/** @oneof */
|
|
2366
|
-
|
|
2365
|
+
interface ItemDataOneOf {
|
|
2367
2366
|
/** An image item. */
|
|
2368
2367
|
image?: Image;
|
|
2369
2368
|
/** A video item. */
|
|
2370
2369
|
video?: Video;
|
|
2371
2370
|
}
|
|
2372
|
-
|
|
2371
|
+
interface GalleryOptions {
|
|
2373
2372
|
/** Gallery layout. */
|
|
2374
2373
|
layout?: Layout;
|
|
2375
2374
|
/** Styling for gallery items. */
|
|
@@ -2377,7 +2376,7 @@ export interface GalleryOptions {
|
|
|
2377
2376
|
/** Styling for gallery thumbnail images. */
|
|
2378
2377
|
thumbnails?: Thumbnails;
|
|
2379
2378
|
}
|
|
2380
|
-
|
|
2379
|
+
declare enum LayoutType {
|
|
2381
2380
|
/** Collage type */
|
|
2382
2381
|
COLLAGE = "COLLAGE",
|
|
2383
2382
|
/** Masonry type */
|
|
@@ -2400,24 +2399,24 @@ export declare enum LayoutType {
|
|
|
2400
2399
|
FULLSIZE = "FULLSIZE"
|
|
2401
2400
|
}
|
|
2402
2401
|
/** @enumType */
|
|
2403
|
-
|
|
2404
|
-
|
|
2402
|
+
type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
|
|
2403
|
+
declare enum Orientation {
|
|
2405
2404
|
/** Rows Orientation */
|
|
2406
2405
|
ROWS = "ROWS",
|
|
2407
2406
|
/** Columns Orientation */
|
|
2408
2407
|
COLUMNS = "COLUMNS"
|
|
2409
2408
|
}
|
|
2410
2409
|
/** @enumType */
|
|
2411
|
-
|
|
2412
|
-
|
|
2410
|
+
type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
|
|
2411
|
+
declare enum Crop {
|
|
2413
2412
|
/** Crop to fill */
|
|
2414
2413
|
FILL = "FILL",
|
|
2415
2414
|
/** Crop to fit */
|
|
2416
2415
|
FIT = "FIT"
|
|
2417
2416
|
}
|
|
2418
2417
|
/** @enumType */
|
|
2419
|
-
|
|
2420
|
-
|
|
2418
|
+
type CropWithLiterals = Crop | 'FILL' | 'FIT';
|
|
2419
|
+
declare enum ThumbnailsAlignment {
|
|
2421
2420
|
/** Top alignment */
|
|
2422
2421
|
TOP = "TOP",
|
|
2423
2422
|
/** Right alignment */
|
|
@@ -2430,8 +2429,8 @@ export declare enum ThumbnailsAlignment {
|
|
|
2430
2429
|
NONE = "NONE"
|
|
2431
2430
|
}
|
|
2432
2431
|
/** @enumType */
|
|
2433
|
-
|
|
2434
|
-
|
|
2432
|
+
type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
|
|
2433
|
+
interface Layout {
|
|
2435
2434
|
/** Gallery layout type. */
|
|
2436
2435
|
type?: LayoutTypeWithLiterals;
|
|
2437
2436
|
/** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
|
|
@@ -2443,7 +2442,7 @@ export interface Layout {
|
|
|
2443
2442
|
/** The number of columns to display on mobile screens. */
|
|
2444
2443
|
mobileNumberOfColumns?: number | null;
|
|
2445
2444
|
}
|
|
2446
|
-
|
|
2445
|
+
interface ItemStyle {
|
|
2447
2446
|
/** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
|
|
2448
2447
|
targetSize?: number | null;
|
|
2449
2448
|
/** Item ratio */
|
|
@@ -2453,13 +2452,13 @@ export interface ItemStyle {
|
|
|
2453
2452
|
/** The spacing between items in pixels. */
|
|
2454
2453
|
spacing?: number | null;
|
|
2455
2454
|
}
|
|
2456
|
-
|
|
2455
|
+
interface Thumbnails {
|
|
2457
2456
|
/** Thumbnail alignment. */
|
|
2458
2457
|
placement?: ThumbnailsAlignmentWithLiterals;
|
|
2459
2458
|
/** Spacing between thumbnails in pixels. */
|
|
2460
2459
|
spacing?: number | null;
|
|
2461
2460
|
}
|
|
2462
|
-
|
|
2461
|
+
interface GIFData {
|
|
2463
2462
|
/** Styling for the GIF's container. */
|
|
2464
2463
|
containerData?: PluginContainerData;
|
|
2465
2464
|
/** The source of the full size GIF. */
|
|
@@ -2473,7 +2472,7 @@ export interface GIFData {
|
|
|
2473
2472
|
/** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
|
|
2474
2473
|
gifType?: GIFTypeWithLiterals;
|
|
2475
2474
|
}
|
|
2476
|
-
|
|
2475
|
+
interface GIF {
|
|
2477
2476
|
/**
|
|
2478
2477
|
* GIF format URL.
|
|
2479
2478
|
* @format WEB_URL
|
|
@@ -2490,13 +2489,13 @@ export interface GIF {
|
|
|
2490
2489
|
*/
|
|
2491
2490
|
still?: string | null;
|
|
2492
2491
|
}
|
|
2493
|
-
|
|
2492
|
+
declare enum GIFType {
|
|
2494
2493
|
NORMAL = "NORMAL",
|
|
2495
2494
|
STICKER = "STICKER"
|
|
2496
2495
|
}
|
|
2497
2496
|
/** @enumType */
|
|
2498
|
-
|
|
2499
|
-
|
|
2497
|
+
type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
|
|
2498
|
+
interface HeadingData {
|
|
2500
2499
|
/** Heading level from 1-6. */
|
|
2501
2500
|
level?: number;
|
|
2502
2501
|
/** Styling for the heading text. */
|
|
@@ -2504,7 +2503,7 @@ export interface HeadingData {
|
|
|
2504
2503
|
/** Indentation level from 1-4. */
|
|
2505
2504
|
indentation?: number | null;
|
|
2506
2505
|
}
|
|
2507
|
-
|
|
2506
|
+
interface HTMLData extends HTMLDataDataOneOf {
|
|
2508
2507
|
/** The URL for the HTML code for the node. */
|
|
2509
2508
|
url?: string;
|
|
2510
2509
|
/** The HTML code for the node. */
|
|
@@ -2522,7 +2521,7 @@ export interface HTMLData extends HTMLDataDataOneOf {
|
|
|
2522
2521
|
autoHeight?: boolean | null;
|
|
2523
2522
|
}
|
|
2524
2523
|
/** @oneof */
|
|
2525
|
-
|
|
2524
|
+
interface HTMLDataDataOneOf {
|
|
2526
2525
|
/** The URL for the HTML code for the node. */
|
|
2527
2526
|
url?: string;
|
|
2528
2527
|
/** The HTML code for the node. */
|
|
@@ -2533,13 +2532,13 @@ export interface HTMLDataDataOneOf {
|
|
|
2533
2532
|
*/
|
|
2534
2533
|
isAdsense?: boolean | null;
|
|
2535
2534
|
}
|
|
2536
|
-
|
|
2535
|
+
declare enum Source {
|
|
2537
2536
|
HTML = "HTML",
|
|
2538
2537
|
ADSENSE = "ADSENSE"
|
|
2539
2538
|
}
|
|
2540
2539
|
/** @enumType */
|
|
2541
|
-
|
|
2542
|
-
|
|
2540
|
+
type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
|
|
2541
|
+
interface ImageData {
|
|
2543
2542
|
/** Styling for the image's container. */
|
|
2544
2543
|
containerData?: PluginContainerData;
|
|
2545
2544
|
/** Image file details. */
|
|
@@ -2562,7 +2561,7 @@ export interface ImageData {
|
|
|
2562
2561
|
/** Styling for the image. */
|
|
2563
2562
|
styles?: ImageDataStyles;
|
|
2564
2563
|
}
|
|
2565
|
-
|
|
2564
|
+
interface StylesBorder {
|
|
2566
2565
|
/** Border width in pixels. */
|
|
2567
2566
|
width?: number | null;
|
|
2568
2567
|
/**
|
|
@@ -2573,11 +2572,11 @@ export interface StylesBorder {
|
|
|
2573
2572
|
/** Border radius in pixels. */
|
|
2574
2573
|
radius?: number | null;
|
|
2575
2574
|
}
|
|
2576
|
-
|
|
2575
|
+
interface ImageDataStyles {
|
|
2577
2576
|
/** Border attributes. */
|
|
2578
2577
|
border?: StylesBorder;
|
|
2579
2578
|
}
|
|
2580
|
-
|
|
2579
|
+
interface LinkPreviewData {
|
|
2581
2580
|
/** Styling for the link preview's container. */
|
|
2582
2581
|
containerData?: PluginContainerData;
|
|
2583
2582
|
/** Link details. */
|
|
@@ -2593,7 +2592,7 @@ export interface LinkPreviewData {
|
|
|
2593
2592
|
/** Styling for the link preview. */
|
|
2594
2593
|
styles?: LinkPreviewDataStyles;
|
|
2595
2594
|
}
|
|
2596
|
-
|
|
2595
|
+
declare enum Position {
|
|
2597
2596
|
/** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
|
|
2598
2597
|
START = "START",
|
|
2599
2598
|
/** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
|
|
@@ -2604,8 +2603,8 @@ export declare enum Position {
|
|
|
2604
2603
|
HIDDEN = "HIDDEN"
|
|
2605
2604
|
}
|
|
2606
2605
|
/** @enumType */
|
|
2607
|
-
|
|
2608
|
-
|
|
2606
|
+
type PositionWithLiterals = Position | 'START' | 'END' | 'TOP' | 'HIDDEN';
|
|
2607
|
+
interface LinkPreviewDataStyles {
|
|
2609
2608
|
/**
|
|
2610
2609
|
* Background color as a hexadecimal value.
|
|
2611
2610
|
* @format COLOR_HEX
|
|
@@ -2638,13 +2637,13 @@ export interface LinkPreviewDataStyles {
|
|
|
2638
2637
|
/** Position of thumbnail. Defaults to `START`. */
|
|
2639
2638
|
thumbnailPosition?: PositionWithLiterals;
|
|
2640
2639
|
}
|
|
2641
|
-
|
|
2640
|
+
interface MapData {
|
|
2642
2641
|
/** Styling for the map's container. */
|
|
2643
2642
|
containerData?: PluginContainerData;
|
|
2644
2643
|
/** Map settings. */
|
|
2645
2644
|
mapSettings?: MapSettings;
|
|
2646
2645
|
}
|
|
2647
|
-
|
|
2646
|
+
interface MapSettings {
|
|
2648
2647
|
/** The address to display on the map. */
|
|
2649
2648
|
address?: string | null;
|
|
2650
2649
|
/** Sets whether the map is draggable. */
|
|
@@ -2668,7 +2667,7 @@ export interface MapSettings {
|
|
|
2668
2667
|
/** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
|
|
2669
2668
|
mapType?: MapTypeWithLiterals;
|
|
2670
2669
|
}
|
|
2671
|
-
|
|
2670
|
+
declare enum MapType {
|
|
2672
2671
|
/** Roadmap map type */
|
|
2673
2672
|
ROADMAP = "ROADMAP",
|
|
2674
2673
|
/** Satellite map type */
|
|
@@ -2679,8 +2678,8 @@ export declare enum MapType {
|
|
|
2679
2678
|
TERRAIN = "TERRAIN"
|
|
2680
2679
|
}
|
|
2681
2680
|
/** @enumType */
|
|
2682
|
-
|
|
2683
|
-
|
|
2681
|
+
type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
|
|
2682
|
+
interface ParagraphData {
|
|
2684
2683
|
/** Styling for the paragraph text. */
|
|
2685
2684
|
textStyle?: TextStyle;
|
|
2686
2685
|
/** Indentation level from 1-4. */
|
|
@@ -2688,7 +2687,7 @@ export interface ParagraphData {
|
|
|
2688
2687
|
/** Paragraph level */
|
|
2689
2688
|
level?: number | null;
|
|
2690
2689
|
}
|
|
2691
|
-
|
|
2690
|
+
interface PollData {
|
|
2692
2691
|
/** Styling for the poll's container. */
|
|
2693
2692
|
containerData?: PluginContainerData;
|
|
2694
2693
|
/** Poll data. */
|
|
@@ -2698,7 +2697,7 @@ export interface PollData {
|
|
|
2698
2697
|
/** Styling for the poll and voting options. */
|
|
2699
2698
|
design?: Design;
|
|
2700
2699
|
}
|
|
2701
|
-
|
|
2700
|
+
declare enum ViewRole {
|
|
2702
2701
|
/** Only Poll creator can view the results */
|
|
2703
2702
|
CREATOR = "CREATOR",
|
|
2704
2703
|
/** Anyone who voted can see the results */
|
|
@@ -2707,16 +2706,16 @@ export declare enum ViewRole {
|
|
|
2707
2706
|
EVERYONE = "EVERYONE"
|
|
2708
2707
|
}
|
|
2709
2708
|
/** @enumType */
|
|
2710
|
-
|
|
2711
|
-
|
|
2709
|
+
type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
|
|
2710
|
+
declare enum VoteRole {
|
|
2712
2711
|
/** Logged in member */
|
|
2713
2712
|
SITE_MEMBERS = "SITE_MEMBERS",
|
|
2714
2713
|
/** Anyone */
|
|
2715
2714
|
ALL = "ALL"
|
|
2716
2715
|
}
|
|
2717
2716
|
/** @enumType */
|
|
2718
|
-
|
|
2719
|
-
|
|
2717
|
+
type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
|
|
2718
|
+
interface Permissions {
|
|
2720
2719
|
/** Sets who can view the poll results. */
|
|
2721
2720
|
view?: ViewRoleWithLiterals;
|
|
2722
2721
|
/** Sets who can vote. */
|
|
@@ -2724,7 +2723,7 @@ export interface Permissions {
|
|
|
2724
2723
|
/** Sets whether one voter can vote multiple times. Defaults to `false`. */
|
|
2725
2724
|
allowMultipleVotes?: boolean | null;
|
|
2726
2725
|
}
|
|
2727
|
-
|
|
2726
|
+
interface Option {
|
|
2728
2727
|
/** Option ID. */
|
|
2729
2728
|
id?: string | null;
|
|
2730
2729
|
/** Option title. */
|
|
@@ -2732,7 +2731,7 @@ export interface Option {
|
|
|
2732
2731
|
/** The image displayed with the option. */
|
|
2733
2732
|
image?: V1Media;
|
|
2734
2733
|
}
|
|
2735
|
-
|
|
2734
|
+
interface PollSettings {
|
|
2736
2735
|
/** Permissions settings for voting. */
|
|
2737
2736
|
permissions?: Permissions;
|
|
2738
2737
|
/** Sets whether voters are displayed in the vote results. Defaults to `true`. */
|
|
@@ -2740,23 +2739,23 @@ export interface PollSettings {
|
|
|
2740
2739
|
/** Sets whether the vote count is displayed. Defaults to `true`. */
|
|
2741
2740
|
showVotesCount?: boolean | null;
|
|
2742
2741
|
}
|
|
2743
|
-
|
|
2742
|
+
declare enum PollLayoutType {
|
|
2744
2743
|
/** List */
|
|
2745
2744
|
LIST = "LIST",
|
|
2746
2745
|
/** Grid */
|
|
2747
2746
|
GRID = "GRID"
|
|
2748
2747
|
}
|
|
2749
2748
|
/** @enumType */
|
|
2750
|
-
|
|
2751
|
-
|
|
2749
|
+
type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
|
|
2750
|
+
declare enum PollLayoutDirection {
|
|
2752
2751
|
/** Left-to-right */
|
|
2753
2752
|
LTR = "LTR",
|
|
2754
2753
|
/** Right-to-left */
|
|
2755
2754
|
RTL = "RTL"
|
|
2756
2755
|
}
|
|
2757
2756
|
/** @enumType */
|
|
2758
|
-
|
|
2759
|
-
|
|
2757
|
+
type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
|
|
2758
|
+
interface PollLayout {
|
|
2760
2759
|
/** The layout for displaying the voting options. */
|
|
2761
2760
|
type?: PollLayoutTypeWithLiterals;
|
|
2762
2761
|
/** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
|
|
@@ -2764,11 +2763,11 @@ export interface PollLayout {
|
|
|
2764
2763
|
/** Sets whether to display the main poll image. Defaults to `false`. */
|
|
2765
2764
|
enableImage?: boolean | null;
|
|
2766
2765
|
}
|
|
2767
|
-
|
|
2766
|
+
interface OptionLayout {
|
|
2768
2767
|
/** Sets whether to display option images. Defaults to `false`. */
|
|
2769
2768
|
enableImage?: boolean | null;
|
|
2770
2769
|
}
|
|
2771
|
-
|
|
2770
|
+
declare enum BackgroundType {
|
|
2772
2771
|
/** Color background type */
|
|
2773
2772
|
COLOR = "COLOR",
|
|
2774
2773
|
/** Image background type */
|
|
@@ -2777,8 +2776,8 @@ export declare enum BackgroundType {
|
|
|
2777
2776
|
GRADIENT = "GRADIENT"
|
|
2778
2777
|
}
|
|
2779
2778
|
/** @enumType */
|
|
2780
|
-
|
|
2781
|
-
|
|
2779
|
+
type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
|
|
2780
|
+
interface Gradient {
|
|
2782
2781
|
/** The gradient angle in degrees. */
|
|
2783
2782
|
angle?: number | null;
|
|
2784
2783
|
/**
|
|
@@ -2792,7 +2791,7 @@ export interface Gradient {
|
|
|
2792
2791
|
*/
|
|
2793
2792
|
lastColor?: string | null;
|
|
2794
2793
|
}
|
|
2795
|
-
|
|
2794
|
+
interface Background extends BackgroundBackgroundOneOf {
|
|
2796
2795
|
/**
|
|
2797
2796
|
* The background color as a hexademical value.
|
|
2798
2797
|
* @format COLOR_HEX
|
|
@@ -2806,7 +2805,7 @@ export interface Background extends BackgroundBackgroundOneOf {
|
|
|
2806
2805
|
type?: BackgroundTypeWithLiterals;
|
|
2807
2806
|
}
|
|
2808
2807
|
/** @oneof */
|
|
2809
|
-
|
|
2808
|
+
interface BackgroundBackgroundOneOf {
|
|
2810
2809
|
/**
|
|
2811
2810
|
* The background color as a hexademical value.
|
|
2812
2811
|
* @format COLOR_HEX
|
|
@@ -2817,17 +2816,17 @@ export interface BackgroundBackgroundOneOf {
|
|
|
2817
2816
|
/** Details for a gradient background. */
|
|
2818
2817
|
gradient?: Gradient;
|
|
2819
2818
|
}
|
|
2820
|
-
|
|
2819
|
+
interface PollDesign {
|
|
2821
2820
|
/** Background styling. */
|
|
2822
2821
|
background?: Background;
|
|
2823
2822
|
/** Border radius in pixels. */
|
|
2824
2823
|
borderRadius?: number | null;
|
|
2825
2824
|
}
|
|
2826
|
-
|
|
2825
|
+
interface OptionDesign {
|
|
2827
2826
|
/** Border radius in pixels. */
|
|
2828
2827
|
borderRadius?: number | null;
|
|
2829
2828
|
}
|
|
2830
|
-
|
|
2829
|
+
interface Poll {
|
|
2831
2830
|
/** Poll ID. */
|
|
2832
2831
|
id?: string | null;
|
|
2833
2832
|
/** Poll title. */
|
|
@@ -2841,26 +2840,26 @@ export interface Poll {
|
|
|
2841
2840
|
/** The poll's permissions and display settings. */
|
|
2842
2841
|
settings?: PollSettings;
|
|
2843
2842
|
}
|
|
2844
|
-
|
|
2843
|
+
interface PollDataLayout {
|
|
2845
2844
|
/** Poll layout settings. */
|
|
2846
2845
|
poll?: PollLayout;
|
|
2847
2846
|
/** Voting otpions layout settings. */
|
|
2848
2847
|
options?: OptionLayout;
|
|
2849
2848
|
}
|
|
2850
|
-
|
|
2849
|
+
interface Design {
|
|
2851
2850
|
/** Styling for the poll. */
|
|
2852
2851
|
poll?: PollDesign;
|
|
2853
2852
|
/** Styling for voting options. */
|
|
2854
2853
|
options?: OptionDesign;
|
|
2855
2854
|
}
|
|
2856
|
-
|
|
2855
|
+
interface TextData {
|
|
2857
2856
|
/** The text to apply decorations to. */
|
|
2858
2857
|
text?: string;
|
|
2859
2858
|
/** The decorations to apply. */
|
|
2860
2859
|
decorations?: Decoration[];
|
|
2861
2860
|
}
|
|
2862
2861
|
/** Adds appearence changes to text */
|
|
2863
|
-
|
|
2862
|
+
interface Decoration extends DecorationDataOneOf {
|
|
2864
2863
|
/** Data for an anchor link decoration. */
|
|
2865
2864
|
anchorData?: AnchorData;
|
|
2866
2865
|
/** Data for a color decoration. */
|
|
@@ -2885,7 +2884,7 @@ export interface Decoration extends DecorationDataOneOf {
|
|
|
2885
2884
|
type?: DecorationTypeWithLiterals;
|
|
2886
2885
|
}
|
|
2887
2886
|
/** @oneof */
|
|
2888
|
-
|
|
2887
|
+
interface DecorationDataOneOf {
|
|
2889
2888
|
/** Data for an anchor link decoration. */
|
|
2890
2889
|
anchorData?: AnchorData;
|
|
2891
2890
|
/** Data for a color decoration. */
|
|
@@ -2907,7 +2906,7 @@ export interface DecorationDataOneOf {
|
|
|
2907
2906
|
/** Data for a strikethrough decoration. Defaults to `true`. */
|
|
2908
2907
|
strikethroughData?: boolean | null;
|
|
2909
2908
|
}
|
|
2910
|
-
|
|
2909
|
+
declare enum DecorationType {
|
|
2911
2910
|
BOLD = "BOLD",
|
|
2912
2911
|
ITALIC = "ITALIC",
|
|
2913
2912
|
UNDERLINE = "UNDERLINE",
|
|
@@ -2921,22 +2920,22 @@ export declare enum DecorationType {
|
|
|
2921
2920
|
STRIKETHROUGH = "STRIKETHROUGH"
|
|
2922
2921
|
}
|
|
2923
2922
|
/** @enumType */
|
|
2924
|
-
|
|
2925
|
-
|
|
2923
|
+
type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH';
|
|
2924
|
+
interface AnchorData {
|
|
2926
2925
|
/** The target node's ID. */
|
|
2927
2926
|
anchor?: string;
|
|
2928
2927
|
}
|
|
2929
|
-
|
|
2928
|
+
interface ColorData {
|
|
2930
2929
|
/** The text's background color as a hexadecimal value. */
|
|
2931
2930
|
background?: string | null;
|
|
2932
2931
|
/** The text's foreground color as a hexadecimal value. */
|
|
2933
2932
|
foreground?: string | null;
|
|
2934
2933
|
}
|
|
2935
|
-
|
|
2934
|
+
interface LinkData {
|
|
2936
2935
|
/** Link details. */
|
|
2937
2936
|
link?: Link;
|
|
2938
2937
|
}
|
|
2939
|
-
|
|
2938
|
+
interface MentionData {
|
|
2940
2939
|
/** The mentioned user's name. */
|
|
2941
2940
|
name?: string;
|
|
2942
2941
|
/** The version of the user's name that appears after the `@` character in the mention. */
|
|
@@ -2944,23 +2943,23 @@ export interface MentionData {
|
|
|
2944
2943
|
/** Mentioned user's ID. */
|
|
2945
2944
|
id?: string | null;
|
|
2946
2945
|
}
|
|
2947
|
-
|
|
2946
|
+
interface FontSizeData {
|
|
2948
2947
|
/** The units used for the font size. */
|
|
2949
2948
|
unit?: FontTypeWithLiterals;
|
|
2950
2949
|
/** Font size value. */
|
|
2951
2950
|
value?: number | null;
|
|
2952
2951
|
}
|
|
2953
|
-
|
|
2952
|
+
declare enum FontType {
|
|
2954
2953
|
PX = "PX",
|
|
2955
2954
|
EM = "EM"
|
|
2956
2955
|
}
|
|
2957
2956
|
/** @enumType */
|
|
2958
|
-
|
|
2959
|
-
|
|
2957
|
+
type FontTypeWithLiterals = FontType | 'PX' | 'EM';
|
|
2958
|
+
interface SpoilerData {
|
|
2960
2959
|
/** Spoiler ID. */
|
|
2961
2960
|
id?: string | null;
|
|
2962
2961
|
}
|
|
2963
|
-
|
|
2962
|
+
interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
2964
2963
|
/** Data for embedded Wix Bookings content. */
|
|
2965
2964
|
bookingData?: BookingData;
|
|
2966
2965
|
/** Data for embedded Wix Events content. */
|
|
@@ -2982,30 +2981,30 @@ export interface AppEmbedData extends AppEmbedDataAppDataOneOf {
|
|
|
2982
2981
|
image?: V1Media;
|
|
2983
2982
|
}
|
|
2984
2983
|
/** @oneof */
|
|
2985
|
-
|
|
2984
|
+
interface AppEmbedDataAppDataOneOf {
|
|
2986
2985
|
/** Data for embedded Wix Bookings content. */
|
|
2987
2986
|
bookingData?: BookingData;
|
|
2988
2987
|
/** Data for embedded Wix Events content. */
|
|
2989
2988
|
eventData?: EventData;
|
|
2990
2989
|
}
|
|
2991
|
-
|
|
2990
|
+
declare enum AppType {
|
|
2992
2991
|
PRODUCT = "PRODUCT",
|
|
2993
2992
|
EVENT = "EVENT",
|
|
2994
2993
|
BOOKING = "BOOKING"
|
|
2995
2994
|
}
|
|
2996
2995
|
/** @enumType */
|
|
2997
|
-
|
|
2998
|
-
|
|
2996
|
+
type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
|
|
2997
|
+
interface BookingData {
|
|
2999
2998
|
/** Booking duration in minutes. */
|
|
3000
2999
|
durations?: string | null;
|
|
3001
3000
|
}
|
|
3002
|
-
|
|
3001
|
+
interface EventData {
|
|
3003
3002
|
/** Event schedule. */
|
|
3004
3003
|
scheduling?: string | null;
|
|
3005
3004
|
/** Event location. */
|
|
3006
3005
|
location?: string | null;
|
|
3007
3006
|
}
|
|
3008
|
-
|
|
3007
|
+
interface VideoData {
|
|
3009
3008
|
/** Styling for the video's container. */
|
|
3010
3009
|
containerData?: PluginContainerData;
|
|
3011
3010
|
/** Video details. */
|
|
@@ -3019,7 +3018,7 @@ export interface VideoData {
|
|
|
3019
3018
|
/** Video options. */
|
|
3020
3019
|
options?: PlaybackOptions;
|
|
3021
3020
|
}
|
|
3022
|
-
|
|
3021
|
+
interface PlaybackOptions {
|
|
3023
3022
|
/** Sets whether the media will automatically start playing. */
|
|
3024
3023
|
autoPlay?: boolean | null;
|
|
3025
3024
|
/** Sets whether media's will be looped. */
|
|
@@ -3027,7 +3026,7 @@ export interface PlaybackOptions {
|
|
|
3027
3026
|
/** Sets whether media's controls will be shown. */
|
|
3028
3027
|
showControls?: boolean | null;
|
|
3029
3028
|
}
|
|
3030
|
-
|
|
3029
|
+
interface EmbedData {
|
|
3031
3030
|
/** Styling for the oEmbed node's container. */
|
|
3032
3031
|
containerData?: PluginContainerData;
|
|
3033
3032
|
/** An [oEmbed](https://www.oembed.com) object. */
|
|
@@ -3035,7 +3034,7 @@ export interface EmbedData {
|
|
|
3035
3034
|
/** Origin asset source. */
|
|
3036
3035
|
src?: string | null;
|
|
3037
3036
|
}
|
|
3038
|
-
|
|
3037
|
+
interface Oembed {
|
|
3039
3038
|
/** The resource type. */
|
|
3040
3039
|
type?: string | null;
|
|
3041
3040
|
/** The width of the resource specified in the `url` property in pixels. */
|
|
@@ -3067,7 +3066,7 @@ export interface Oembed {
|
|
|
3067
3066
|
/** The oEmbed version number. This value must be `1.0`. */
|
|
3068
3067
|
version?: string | null;
|
|
3069
3068
|
}
|
|
3070
|
-
|
|
3069
|
+
interface CollapsibleListData {
|
|
3071
3070
|
/** Styling for the collapsible list's container. */
|
|
3072
3071
|
containerData?: PluginContainerData;
|
|
3073
3072
|
/** If `true`, only one item can be expanded at a time. Defaults to `false`. */
|
|
@@ -3079,7 +3078,7 @@ export interface CollapsibleListData {
|
|
|
3079
3078
|
/** If `true`, The collapsible item will appear in search results as an FAQ. */
|
|
3080
3079
|
isQapageData?: boolean | null;
|
|
3081
3080
|
}
|
|
3082
|
-
|
|
3081
|
+
declare enum InitialExpandedItems {
|
|
3083
3082
|
/** First item will be expended initally */
|
|
3084
3083
|
FIRST = "FIRST",
|
|
3085
3084
|
/** All items will expended initally */
|
|
@@ -3088,16 +3087,16 @@ export declare enum InitialExpandedItems {
|
|
|
3088
3087
|
NONE = "NONE"
|
|
3089
3088
|
}
|
|
3090
3089
|
/** @enumType */
|
|
3091
|
-
|
|
3092
|
-
|
|
3090
|
+
type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
|
|
3091
|
+
declare enum Direction {
|
|
3093
3092
|
/** Left-to-right */
|
|
3094
3093
|
LTR = "LTR",
|
|
3095
3094
|
/** Right-to-left */
|
|
3096
3095
|
RTL = "RTL"
|
|
3097
3096
|
}
|
|
3098
3097
|
/** @enumType */
|
|
3099
|
-
|
|
3100
|
-
|
|
3098
|
+
type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
|
|
3099
|
+
interface TableData {
|
|
3101
3100
|
/** Styling for the table's container. */
|
|
3102
3101
|
containerData?: PluginContainerData;
|
|
3103
3102
|
/** The table's dimensions. */
|
|
@@ -3112,7 +3111,7 @@ export interface TableData {
|
|
|
3112
3111
|
/** Sets whether the table's first column is a header. Defaults to `false`. */
|
|
3113
3112
|
columnHeader?: boolean | null;
|
|
3114
3113
|
}
|
|
3115
|
-
|
|
3114
|
+
interface Dimensions {
|
|
3116
3115
|
/** An array representing relative width of each column in relation to the other columns. */
|
|
3117
3116
|
colsWidthRatio?: number[];
|
|
3118
3117
|
/** An array representing the height of each row in pixels. */
|
|
@@ -3120,13 +3119,13 @@ export interface Dimensions {
|
|
|
3120
3119
|
/** An array representing the minimum width of each column in pixels. */
|
|
3121
3120
|
colsMinWidth?: number[];
|
|
3122
3121
|
}
|
|
3123
|
-
|
|
3122
|
+
interface TableCellData {
|
|
3124
3123
|
/** Styling for the cell's background color and text alignment. */
|
|
3125
3124
|
cellStyle?: CellStyle;
|
|
3126
3125
|
/** The cell's border colors. */
|
|
3127
3126
|
borderColors?: BorderColors;
|
|
3128
3127
|
}
|
|
3129
|
-
|
|
3128
|
+
declare enum VerticalAlignment {
|
|
3130
3129
|
/** Top alignment */
|
|
3131
3130
|
TOP = "TOP",
|
|
3132
3131
|
/** Middle alignment */
|
|
@@ -3135,8 +3134,8 @@ export declare enum VerticalAlignment {
|
|
|
3135
3134
|
BOTTOM = "BOTTOM"
|
|
3136
3135
|
}
|
|
3137
3136
|
/** @enumType */
|
|
3138
|
-
|
|
3139
|
-
|
|
3137
|
+
type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
|
|
3138
|
+
interface CellStyle {
|
|
3140
3139
|
/** Vertical alignment for the cell's text. */
|
|
3141
3140
|
verticalAlignment?: VerticalAlignmentWithLiterals;
|
|
3142
3141
|
/**
|
|
@@ -3145,7 +3144,7 @@ export interface CellStyle {
|
|
|
3145
3144
|
*/
|
|
3146
3145
|
backgroundColor?: string | null;
|
|
3147
3146
|
}
|
|
3148
|
-
|
|
3147
|
+
interface BorderColors {
|
|
3149
3148
|
/**
|
|
3150
3149
|
* Left border color as a hexadecimal value.
|
|
3151
3150
|
* @format COLOR_HEX
|
|
@@ -3173,22 +3172,20 @@ export interface BorderColors {
|
|
|
3173
3172
|
*
|
|
3174
3173
|
* The JSON representation for `NullValue` is JSON `null`.
|
|
3175
3174
|
*/
|
|
3176
|
-
|
|
3175
|
+
declare enum NullValue {
|
|
3177
3176
|
/** Null value. */
|
|
3178
3177
|
NULL_VALUE = "NULL_VALUE"
|
|
3179
3178
|
}
|
|
3180
|
-
/** @enumType */
|
|
3181
|
-
export type NullValueWithLiterals = NullValue | 'NULL_VALUE';
|
|
3182
3179
|
/**
|
|
3183
3180
|
* `ListValue` is a wrapper around a repeated field of values.
|
|
3184
3181
|
*
|
|
3185
3182
|
* The JSON representation for `ListValue` is JSON array.
|
|
3186
3183
|
*/
|
|
3187
|
-
|
|
3184
|
+
interface ListValue {
|
|
3188
3185
|
/** Repeated field of dynamically typed values. */
|
|
3189
3186
|
values?: any[];
|
|
3190
3187
|
}
|
|
3191
|
-
|
|
3188
|
+
interface AudioData {
|
|
3192
3189
|
/** Styling for the audio node's container. */
|
|
3193
3190
|
containerData?: PluginContainerData;
|
|
3194
3191
|
/** Audio file details. */
|
|
@@ -3204,7 +3201,7 @@ export interface AudioData {
|
|
|
3204
3201
|
/** An HTML version of the audio node. */
|
|
3205
3202
|
html?: string | null;
|
|
3206
3203
|
}
|
|
3207
|
-
|
|
3204
|
+
interface OrderedListData {
|
|
3208
3205
|
/** Indentation level from 0-4. */
|
|
3209
3206
|
indentation?: number;
|
|
3210
3207
|
/** Offset level from 0-4. */
|
|
@@ -3212,24 +3209,24 @@ export interface OrderedListData {
|
|
|
3212
3209
|
/** List start number. */
|
|
3213
3210
|
start?: number | null;
|
|
3214
3211
|
}
|
|
3215
|
-
|
|
3212
|
+
interface BulletedListData {
|
|
3216
3213
|
/** Indentation level from 0-4. */
|
|
3217
3214
|
indentation?: number;
|
|
3218
3215
|
/** Offset level from 0-4. */
|
|
3219
3216
|
offset?: number | null;
|
|
3220
3217
|
}
|
|
3221
|
-
|
|
3218
|
+
interface BlockquoteData {
|
|
3222
3219
|
/** Indentation level from 1-4. */
|
|
3223
3220
|
indentation?: number;
|
|
3224
3221
|
}
|
|
3225
|
-
|
|
3222
|
+
interface CaptionData {
|
|
3226
3223
|
textStyle?: TextStyle;
|
|
3227
3224
|
}
|
|
3228
|
-
|
|
3225
|
+
interface LayoutCellData {
|
|
3229
3226
|
/** Size of the cell in 12 columns grid. */
|
|
3230
3227
|
colSpan?: number | null;
|
|
3231
3228
|
}
|
|
3232
|
-
|
|
3229
|
+
interface Metadata {
|
|
3233
3230
|
/** Schema version. */
|
|
3234
3231
|
version?: number;
|
|
3235
3232
|
/**
|
|
@@ -3246,7 +3243,7 @@ export interface Metadata {
|
|
|
3246
3243
|
/** Object ID. */
|
|
3247
3244
|
_id?: string | null;
|
|
3248
3245
|
}
|
|
3249
|
-
|
|
3246
|
+
interface DocumentStyle {
|
|
3250
3247
|
/** Styling for H1 nodes. */
|
|
3251
3248
|
headerOne?: TextNodeStyle;
|
|
3252
3249
|
/** Styling for H2 nodes. */
|
|
@@ -3266,7 +3263,7 @@ export interface DocumentStyle {
|
|
|
3266
3263
|
/** Styling for code block nodes. */
|
|
3267
3264
|
codeBlock?: TextNodeStyle;
|
|
3268
3265
|
}
|
|
3269
|
-
|
|
3266
|
+
interface TextNodeStyle {
|
|
3270
3267
|
/** The decorations to apply to the node. */
|
|
3271
3268
|
decorations?: Decoration[];
|
|
3272
3269
|
/** Padding and background color for the node. */
|
|
@@ -3274,7 +3271,7 @@ export interface TextNodeStyle {
|
|
|
3274
3271
|
/** Line height for text in the node. */
|
|
3275
3272
|
lineHeight?: string | null;
|
|
3276
3273
|
}
|
|
3277
|
-
|
|
3274
|
+
interface Media {
|
|
3278
3275
|
/**
|
|
3279
3276
|
* Main media (image, video, etc.) associated with this product.
|
|
3280
3277
|
* @readonly
|
|
@@ -3286,7 +3283,7 @@ export interface Media {
|
|
|
3286
3283
|
*/
|
|
3287
3284
|
itemsInfo?: MediaItemsInfo;
|
|
3288
3285
|
}
|
|
3289
|
-
|
|
3286
|
+
interface ProductMedia extends ProductMediaSetByOneOf, ProductMediaMediaOneOf {
|
|
3290
3287
|
/**
|
|
3291
3288
|
* Set media by ID of an existing file in Wix Media Manager.
|
|
3292
3289
|
* @minLength 1
|
|
@@ -3338,7 +3335,7 @@ export interface ProductMedia extends ProductMediaSetByOneOf, ProductMediaMediaO
|
|
|
3338
3335
|
uploadId?: string;
|
|
3339
3336
|
}
|
|
3340
3337
|
/** @oneof */
|
|
3341
|
-
|
|
3338
|
+
interface ProductMediaSetByOneOf {
|
|
3342
3339
|
/**
|
|
3343
3340
|
* Set media by ID of an existing file in Wix Media Manager.
|
|
3344
3341
|
* @minLength 1
|
|
@@ -3352,7 +3349,7 @@ export interface ProductMediaSetByOneOf {
|
|
|
3352
3349
|
url?: string;
|
|
3353
3350
|
}
|
|
3354
3351
|
/** @oneof */
|
|
3355
|
-
|
|
3352
|
+
interface ProductMediaMediaOneOf {
|
|
3356
3353
|
/**
|
|
3357
3354
|
* Product image.
|
|
3358
3355
|
* @readonly
|
|
@@ -3364,7 +3361,7 @@ export interface ProductMediaMediaOneOf {
|
|
|
3364
3361
|
*/
|
|
3365
3362
|
video?: string;
|
|
3366
3363
|
}
|
|
3367
|
-
|
|
3364
|
+
interface VideoResolution {
|
|
3368
3365
|
/**
|
|
3369
3366
|
* Video URL.
|
|
3370
3367
|
* @format WEB_URL
|
|
@@ -3380,7 +3377,7 @@ export interface VideoResolution {
|
|
|
3380
3377
|
*/
|
|
3381
3378
|
format?: string;
|
|
3382
3379
|
}
|
|
3383
|
-
|
|
3380
|
+
declare enum MediaType {
|
|
3384
3381
|
UNKNOWN_MEDIA_TYPE = "UNKNOWN_MEDIA_TYPE",
|
|
3385
3382
|
/** Image media type. */
|
|
3386
3383
|
IMAGE = "IMAGE",
|
|
@@ -3388,8 +3385,8 @@ export declare enum MediaType {
|
|
|
3388
3385
|
VIDEO = "VIDEO"
|
|
3389
3386
|
}
|
|
3390
3387
|
/** @enumType */
|
|
3391
|
-
|
|
3392
|
-
|
|
3388
|
+
type MediaTypeWithLiterals = MediaType | 'UNKNOWN_MEDIA_TYPE' | 'IMAGE' | 'VIDEO';
|
|
3389
|
+
interface Thumbnail {
|
|
3393
3390
|
/**
|
|
3394
3391
|
* Thumbnail url.
|
|
3395
3392
|
* @format WEB_URL
|
|
@@ -3406,7 +3403,7 @@ export interface Thumbnail {
|
|
|
3406
3403
|
*/
|
|
3407
3404
|
altText?: string | null;
|
|
3408
3405
|
}
|
|
3409
|
-
|
|
3406
|
+
interface MediaItemsInfo {
|
|
3410
3407
|
/**
|
|
3411
3408
|
* All media items (images, videos etc) associated with this product.
|
|
3412
3409
|
* @maxSize 15
|
|
@@ -3418,13 +3415,13 @@ export interface MediaItemsInfo {
|
|
|
3418
3415
|
* The search engines use this information for ranking purposes, or to display snippets in the search results.
|
|
3419
3416
|
* 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.
|
|
3420
3417
|
*/
|
|
3421
|
-
|
|
3418
|
+
interface SeoSchema {
|
|
3422
3419
|
/** SEO tag information. */
|
|
3423
3420
|
tags?: Tag[];
|
|
3424
3421
|
/** SEO general settings. */
|
|
3425
3422
|
settings?: Settings;
|
|
3426
3423
|
}
|
|
3427
|
-
|
|
3424
|
+
interface Keyword {
|
|
3428
3425
|
/** Keyword value. */
|
|
3429
3426
|
term?: string;
|
|
3430
3427
|
/** Whether the keyword is the main focus keyword. */
|
|
@@ -3435,7 +3432,7 @@ export interface Keyword {
|
|
|
3435
3432
|
*/
|
|
3436
3433
|
origin?: string | null;
|
|
3437
3434
|
}
|
|
3438
|
-
|
|
3435
|
+
interface Tag {
|
|
3439
3436
|
/**
|
|
3440
3437
|
* SEO tag type.
|
|
3441
3438
|
*
|
|
@@ -3457,7 +3454,7 @@ export interface Tag {
|
|
|
3457
3454
|
/** Whether the tag is disabled. */
|
|
3458
3455
|
disabled?: boolean;
|
|
3459
3456
|
}
|
|
3460
|
-
|
|
3457
|
+
interface Settings {
|
|
3461
3458
|
/**
|
|
3462
3459
|
* Whether the Auto Redirect feature, which creates `301 redirects` on a slug change, is enabled.
|
|
3463
3460
|
*
|
|
@@ -3471,7 +3468,7 @@ export interface Settings {
|
|
|
3471
3468
|
*/
|
|
3472
3469
|
keywords?: Keyword[];
|
|
3473
3470
|
}
|
|
3474
|
-
|
|
3471
|
+
interface ConnectedOption extends ConnectedOptionOptionSettingsOneOf {
|
|
3475
3472
|
/** Choices settings. */
|
|
3476
3473
|
choicesSettings?: ChoicesSettings;
|
|
3477
3474
|
/**
|
|
@@ -3490,11 +3487,11 @@ export interface ConnectedOption extends ConnectedOptionOptionSettingsOneOf {
|
|
|
3490
3487
|
optionRenderType?: ProductOptionRenderTypeWithLiterals;
|
|
3491
3488
|
}
|
|
3492
3489
|
/** @oneof */
|
|
3493
|
-
|
|
3490
|
+
interface ConnectedOptionOptionSettingsOneOf {
|
|
3494
3491
|
/** Choices settings. */
|
|
3495
3492
|
choicesSettings?: ChoicesSettings;
|
|
3496
3493
|
}
|
|
3497
|
-
|
|
3494
|
+
declare enum ProductOptionRenderType {
|
|
3498
3495
|
/** Not implemented. */
|
|
3499
3496
|
UNKNOWN_OPTION_RENDER_TYPE = "UNKNOWN_OPTION_RENDER_TYPE",
|
|
3500
3497
|
/** Text choices. */
|
|
@@ -3503,8 +3500,8 @@ export declare enum ProductOptionRenderType {
|
|
|
3503
3500
|
SWATCH_CHOICES = "SWATCH_CHOICES"
|
|
3504
3501
|
}
|
|
3505
3502
|
/** @enumType */
|
|
3506
|
-
|
|
3507
|
-
|
|
3503
|
+
type ProductOptionRenderTypeWithLiterals = ProductOptionRenderType | 'UNKNOWN_OPTION_RENDER_TYPE' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
|
|
3504
|
+
interface ChoicesSettings {
|
|
3508
3505
|
/**
|
|
3509
3506
|
* List of available choices for the option.
|
|
3510
3507
|
* @minSize 1
|
|
@@ -3513,7 +3510,7 @@ export interface ChoicesSettings {
|
|
|
3513
3510
|
*/
|
|
3514
3511
|
choices?: ConnectedOptionChoice[];
|
|
3515
3512
|
}
|
|
3516
|
-
|
|
3513
|
+
interface ConnectedOptionChoice extends ConnectedOptionChoiceValueOneOf {
|
|
3517
3514
|
/**
|
|
3518
3515
|
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
3519
3516
|
* @minLength 3
|
|
@@ -3555,7 +3552,7 @@ export interface ConnectedOptionChoice extends ConnectedOptionChoiceValueOneOf {
|
|
|
3555
3552
|
visible?: boolean;
|
|
3556
3553
|
}
|
|
3557
3554
|
/** @oneof */
|
|
3558
|
-
|
|
3555
|
+
interface ConnectedOptionChoiceValueOneOf {
|
|
3559
3556
|
/**
|
|
3560
3557
|
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
3561
3558
|
* @minLength 3
|
|
@@ -3563,7 +3560,7 @@ export interface ConnectedOptionChoiceValueOneOf {
|
|
|
3563
3560
|
*/
|
|
3564
3561
|
colorCode?: string;
|
|
3565
3562
|
}
|
|
3566
|
-
|
|
3563
|
+
declare enum ChoiceType {
|
|
3567
3564
|
UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
|
|
3568
3565
|
/** Text choice. */
|
|
3569
3566
|
CHOICE_TEXT = "CHOICE_TEXT",
|
|
@@ -3575,8 +3572,8 @@ export declare enum ChoiceType {
|
|
|
3575
3572
|
IMAGE = "IMAGE"
|
|
3576
3573
|
}
|
|
3577
3574
|
/** @enumType */
|
|
3578
|
-
|
|
3579
|
-
|
|
3575
|
+
type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR' | 'MULTIPLE_COLORS' | 'IMAGE';
|
|
3576
|
+
interface MultipleColors {
|
|
3580
3577
|
/**
|
|
3581
3578
|
* List of color codes.
|
|
3582
3579
|
* @minLength 3
|
|
@@ -3586,7 +3583,7 @@ export interface MultipleColors {
|
|
|
3586
3583
|
*/
|
|
3587
3584
|
colorCodes?: string[];
|
|
3588
3585
|
}
|
|
3589
|
-
|
|
3586
|
+
interface ConnectedModifier extends ConnectedModifierModifierSettingsOneOf {
|
|
3590
3587
|
/** Free text modifier settings. */
|
|
3591
3588
|
freeTextSettings?: FreeTextSettings;
|
|
3592
3589
|
/** Choice settings. */
|
|
@@ -3609,13 +3606,13 @@ export interface ConnectedModifier extends ConnectedModifierModifierSettingsOneO
|
|
|
3609
3606
|
mandatory?: boolean;
|
|
3610
3607
|
}
|
|
3611
3608
|
/** @oneof */
|
|
3612
|
-
|
|
3609
|
+
interface ConnectedModifierModifierSettingsOneOf {
|
|
3613
3610
|
/** Free text modifier settings. */
|
|
3614
3611
|
freeTextSettings?: FreeTextSettings;
|
|
3615
3612
|
/** Choice settings. */
|
|
3616
3613
|
choicesSettings?: ModifierChoicesSettings;
|
|
3617
3614
|
}
|
|
3618
|
-
|
|
3615
|
+
declare enum ModifierRenderType {
|
|
3619
3616
|
/** Not implemented. */
|
|
3620
3617
|
UNKNOWN_MODIFIER_RENDER_TYPE = "UNKNOWN_MODIFIER_RENDER_TYPE",
|
|
3621
3618
|
/** Free text. */
|
|
@@ -3626,8 +3623,8 @@ export declare enum ModifierRenderType {
|
|
|
3626
3623
|
SWATCH_CHOICES = "SWATCH_CHOICES"
|
|
3627
3624
|
}
|
|
3628
3625
|
/** @enumType */
|
|
3629
|
-
|
|
3630
|
-
|
|
3626
|
+
type ModifierRenderTypeWithLiterals = ModifierRenderType | 'UNKNOWN_MODIFIER_RENDER_TYPE' | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
|
|
3627
|
+
interface FreeTextSettings {
|
|
3631
3628
|
/** Minimum number of characters. */
|
|
3632
3629
|
minCharCount?: number;
|
|
3633
3630
|
/**
|
|
@@ -3647,7 +3644,7 @@ export interface FreeTextSettings {
|
|
|
3647
3644
|
*/
|
|
3648
3645
|
title?: string;
|
|
3649
3646
|
}
|
|
3650
|
-
|
|
3647
|
+
interface ModifierChoicesSettings {
|
|
3651
3648
|
/**
|
|
3652
3649
|
* List of modifier choices.
|
|
3653
3650
|
* @minSize 1
|
|
@@ -3656,7 +3653,7 @@ export interface ModifierChoicesSettings {
|
|
|
3656
3653
|
*/
|
|
3657
3654
|
choices?: ConnectedModifierChoice[];
|
|
3658
3655
|
}
|
|
3659
|
-
|
|
3656
|
+
interface ConnectedModifierChoice extends ConnectedModifierChoiceValueOneOf {
|
|
3660
3657
|
/**
|
|
3661
3658
|
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
3662
3659
|
* @minLength 3
|
|
@@ -3695,7 +3692,7 @@ export interface ConnectedModifierChoice extends ConnectedModifierChoiceValueOne
|
|
|
3695
3692
|
addedPrice?: string | null;
|
|
3696
3693
|
}
|
|
3697
3694
|
/** @oneof */
|
|
3698
|
-
|
|
3695
|
+
interface ConnectedModifierChoiceValueOneOf {
|
|
3699
3696
|
/**
|
|
3700
3697
|
* Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
3701
3698
|
* @minLength 3
|
|
@@ -3703,7 +3700,7 @@ export interface ConnectedModifierChoiceValueOneOf {
|
|
|
3703
3700
|
*/
|
|
3704
3701
|
colorCode?: string;
|
|
3705
3702
|
}
|
|
3706
|
-
|
|
3703
|
+
interface Brand {
|
|
3707
3704
|
/**
|
|
3708
3705
|
* Brand ID.
|
|
3709
3706
|
* @format GUID
|
|
@@ -3715,7 +3712,7 @@ export interface Brand {
|
|
|
3715
3712
|
*/
|
|
3716
3713
|
name?: string | null;
|
|
3717
3714
|
}
|
|
3718
|
-
|
|
3715
|
+
interface InfoSection {
|
|
3719
3716
|
/**
|
|
3720
3717
|
* Info section ID.
|
|
3721
3718
|
* @format GUID
|
|
@@ -3755,7 +3752,7 @@ export interface InfoSection {
|
|
|
3755
3752
|
*/
|
|
3756
3753
|
plainDescription?: string | null;
|
|
3757
3754
|
}
|
|
3758
|
-
|
|
3755
|
+
interface Ribbon {
|
|
3759
3756
|
/**
|
|
3760
3757
|
* Ribbon ID.
|
|
3761
3758
|
* @minLength 1
|
|
@@ -3768,7 +3765,7 @@ export interface Ribbon {
|
|
|
3768
3765
|
*/
|
|
3769
3766
|
name?: string | null;
|
|
3770
3767
|
}
|
|
3771
|
-
|
|
3768
|
+
interface ProductCategoriesInfo {
|
|
3772
3769
|
/**
|
|
3773
3770
|
* A list of categories related to product.
|
|
3774
3771
|
* @readonly
|
|
@@ -3776,7 +3773,7 @@ export interface ProductCategoriesInfo {
|
|
|
3776
3773
|
*/
|
|
3777
3774
|
categories?: ProductCategory[];
|
|
3778
3775
|
}
|
|
3779
|
-
|
|
3776
|
+
interface ProductCategory {
|
|
3780
3777
|
/**
|
|
3781
3778
|
* Category ID.
|
|
3782
3779
|
* @format GUID
|
|
@@ -3788,7 +3785,7 @@ export interface ProductCategory {
|
|
|
3788
3785
|
*/
|
|
3789
3786
|
index?: number | null;
|
|
3790
3787
|
}
|
|
3791
|
-
|
|
3788
|
+
interface ProductCategoryIdsInfo {
|
|
3792
3789
|
/**
|
|
3793
3790
|
* A list of category ids related to product.
|
|
3794
3791
|
* @readonly
|
|
@@ -3797,13 +3794,13 @@ export interface ProductCategoryIdsInfo {
|
|
|
3797
3794
|
*/
|
|
3798
3795
|
categoryIds?: string[];
|
|
3799
3796
|
}
|
|
3800
|
-
|
|
3797
|
+
interface PriceRange {
|
|
3801
3798
|
/** Minimum value. */
|
|
3802
3799
|
minValue?: FixedMonetaryAmount;
|
|
3803
3800
|
/** Maximum value. */
|
|
3804
3801
|
maxValue?: FixedMonetaryAmount;
|
|
3805
3802
|
}
|
|
3806
|
-
|
|
3803
|
+
interface FixedMonetaryAmount {
|
|
3807
3804
|
/**
|
|
3808
3805
|
* Monetary amount. For example, `"3.99"`, or `"-4.99"` for a negative amount.
|
|
3809
3806
|
* @decimalValue options { gte:0, lte:999999999, maxScale:3 }
|
|
@@ -3817,7 +3814,7 @@ export interface FixedMonetaryAmount {
|
|
|
3817
3814
|
*/
|
|
3818
3815
|
formattedAmount?: string | null;
|
|
3819
3816
|
}
|
|
3820
|
-
|
|
3817
|
+
interface Inventory {
|
|
3821
3818
|
/**
|
|
3822
3819
|
* Current availability status.
|
|
3823
3820
|
* @readonly
|
|
@@ -3834,7 +3831,7 @@ export interface Inventory {
|
|
|
3834
3831
|
*/
|
|
3835
3832
|
preorderAvailability?: ProductPreorderAvailabilityWithLiterals;
|
|
3836
3833
|
}
|
|
3837
|
-
|
|
3834
|
+
declare enum AvailabilityStatus {
|
|
3838
3835
|
UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
|
|
3839
3836
|
/** All variants are in stock and available for purchase. */
|
|
3840
3837
|
IN_STOCK = "IN_STOCK",
|
|
@@ -3844,8 +3841,8 @@ export declare enum AvailabilityStatus {
|
|
|
3844
3841
|
PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
|
|
3845
3842
|
}
|
|
3846
3843
|
/** @enumType */
|
|
3847
|
-
|
|
3848
|
-
|
|
3844
|
+
type AvailabilityStatusWithLiterals = AvailabilityStatus | 'UNKNOWN_AVAILABILITY_STATUS' | 'IN_STOCK' | 'OUT_OF_STOCK' | 'PARTIALLY_OUT_OF_STOCK';
|
|
3845
|
+
declare enum PreorderStatus {
|
|
3849
3846
|
UNKNOWN_PREORDER_STATUS = "UNKNOWN_PREORDER_STATUS",
|
|
3850
3847
|
/** All variants are enabled for preorder. */
|
|
3851
3848
|
ENABLED = "ENABLED",
|
|
@@ -3855,8 +3852,8 @@ export declare enum PreorderStatus {
|
|
|
3855
3852
|
PARTIALLY_ENABLED = "PARTIALLY_ENABLED"
|
|
3856
3853
|
}
|
|
3857
3854
|
/** @enumType */
|
|
3858
|
-
|
|
3859
|
-
|
|
3855
|
+
type PreorderStatusWithLiterals = PreorderStatus | 'UNKNOWN_PREORDER_STATUS' | 'ENABLED' | 'DISABLED' | 'PARTIALLY_ENABLED';
|
|
3856
|
+
declare enum ProductPreorderAvailability {
|
|
3860
3857
|
UNKNOWN_PREORDER_AVAILABILITY_STATUS = "UNKNOWN_PREORDER_AVAILABILITY_STATUS",
|
|
3861
3858
|
/** All the product variants are available for preorder. */
|
|
3862
3859
|
ALL_VARIANTS = "ALL_VARIANTS",
|
|
@@ -3866,8 +3863,8 @@ export declare enum ProductPreorderAvailability {
|
|
|
3866
3863
|
SOME_VARIANTS = "SOME_VARIANTS"
|
|
3867
3864
|
}
|
|
3868
3865
|
/** @enumType */
|
|
3869
|
-
|
|
3870
|
-
|
|
3866
|
+
type ProductPreorderAvailabilityWithLiterals = ProductPreorderAvailability | 'UNKNOWN_PREORDER_AVAILABILITY_STATUS' | 'ALL_VARIANTS' | 'NO_VARIANTS' | 'SOME_VARIANTS';
|
|
3867
|
+
declare enum ProductType {
|
|
3871
3868
|
/** Not implemented. */
|
|
3872
3869
|
UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
|
|
3873
3870
|
/** Physical product. */
|
|
@@ -3876,8 +3873,8 @@ export declare enum ProductType {
|
|
|
3876
3873
|
DIGITAL = "DIGITAL"
|
|
3877
3874
|
}
|
|
3878
3875
|
/** @enumType */
|
|
3879
|
-
|
|
3880
|
-
|
|
3876
|
+
type ProductTypeWithLiterals = ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'PHYSICAL' | 'DIGITAL';
|
|
3877
|
+
interface PhysicalProperties {
|
|
3881
3878
|
/**
|
|
3882
3879
|
* Price per unit settings.
|
|
3883
3880
|
* > **Note:** Use this field only when relevant. For example, for products that are sold by weight, volume, or length.
|
|
@@ -3910,7 +3907,7 @@ export interface PhysicalProperties {
|
|
|
3910
3907
|
*/
|
|
3911
3908
|
deliveryProfileId?: string | null;
|
|
3912
3909
|
}
|
|
3913
|
-
|
|
3910
|
+
interface PricePerUnitSettings {
|
|
3914
3911
|
/**
|
|
3915
3912
|
* Quantity.
|
|
3916
3913
|
* For example, to define price per per 100 grams, set this field to `100`.
|
|
@@ -3924,7 +3921,7 @@ export interface PricePerUnitSettings {
|
|
|
3924
3921
|
*/
|
|
3925
3922
|
measurementUnit?: MeasurementUnitWithLiterals;
|
|
3926
3923
|
}
|
|
3927
|
-
|
|
3924
|
+
interface WeightRange {
|
|
3928
3925
|
/**
|
|
3929
3926
|
* Minimum weight across all variants associated with this product.
|
|
3930
3927
|
* @max 999999999.99
|
|
@@ -3936,13 +3933,13 @@ export interface WeightRange {
|
|
|
3936
3933
|
*/
|
|
3937
3934
|
maxValue?: number;
|
|
3938
3935
|
}
|
|
3939
|
-
|
|
3936
|
+
interface PricePerUnitRange {
|
|
3940
3937
|
/** Minimum price per unit across all variants. */
|
|
3941
3938
|
minValue?: PricePerUnitRangePricePerUnit;
|
|
3942
3939
|
/** Maximum price per unit across all variants. */
|
|
3943
3940
|
maxValue?: PricePerUnitRangePricePerUnit;
|
|
3944
3941
|
}
|
|
3945
|
-
|
|
3942
|
+
interface PricePerUnitRangePricePerUnit {
|
|
3946
3943
|
/**
|
|
3947
3944
|
* Calculated value of price per unit. Takes into account pricePerUnit settings of product and variants and price of variants.
|
|
3948
3945
|
* 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$).
|
|
@@ -3958,14 +3955,14 @@ export interface PricePerUnitRangePricePerUnit {
|
|
|
3958
3955
|
*/
|
|
3959
3956
|
description?: string | null;
|
|
3960
3957
|
}
|
|
3961
|
-
|
|
3958
|
+
interface WeightMeasurementUnitInfo {
|
|
3962
3959
|
/**
|
|
3963
3960
|
* Weight measurement unit.
|
|
3964
3961
|
* @readonly
|
|
3965
3962
|
*/
|
|
3966
3963
|
weightMeasurementUnit?: WeightUnitWithLiterals;
|
|
3967
3964
|
}
|
|
3968
|
-
|
|
3965
|
+
interface BreadcrumbsInfo {
|
|
3969
3966
|
/**
|
|
3970
3967
|
* Breadcrumbs.
|
|
3971
3968
|
* @readonly
|
|
@@ -3973,7 +3970,7 @@ export interface BreadcrumbsInfo {
|
|
|
3973
3970
|
*/
|
|
3974
3971
|
breadcrumbs?: BreadCrumb[];
|
|
3975
3972
|
}
|
|
3976
|
-
|
|
3973
|
+
interface BreadCrumb {
|
|
3977
3974
|
/**
|
|
3978
3975
|
* Category ID.
|
|
3979
3976
|
* @format GUID
|
|
@@ -3992,7 +3989,7 @@ export interface BreadCrumb {
|
|
|
3992
3989
|
*/
|
|
3993
3990
|
categorySlug?: string;
|
|
3994
3991
|
}
|
|
3995
|
-
|
|
3992
|
+
interface VariantsInfo {
|
|
3996
3993
|
/**
|
|
3997
3994
|
* List of related variants.
|
|
3998
3995
|
* @minSize 1
|
|
@@ -4000,7 +3997,7 @@ export interface VariantsInfo {
|
|
|
4000
3997
|
*/
|
|
4001
3998
|
variants?: Variant[];
|
|
4002
3999
|
}
|
|
4003
|
-
|
|
4000
|
+
interface Variant extends VariantTypedPropertiesOneOf {
|
|
4004
4001
|
/** Physical properties. Must be passed when `productType: PHYSICAL` */
|
|
4005
4002
|
physicalProperties?: VariantPhysicalProperties;
|
|
4006
4003
|
/** Digital properties. Must be passed when `productType: DIGITAL` */
|
|
@@ -4065,13 +4062,13 @@ export interface Variant extends VariantTypedPropertiesOneOf {
|
|
|
4065
4062
|
inventoryStatus?: InventoryStatus;
|
|
4066
4063
|
}
|
|
4067
4064
|
/** @oneof */
|
|
4068
|
-
|
|
4065
|
+
interface VariantTypedPropertiesOneOf {
|
|
4069
4066
|
/** Physical properties. Must be passed when `productType: PHYSICAL` */
|
|
4070
4067
|
physicalProperties?: VariantPhysicalProperties;
|
|
4071
4068
|
/** Digital properties. Must be passed when `productType: DIGITAL` */
|
|
4072
4069
|
digitalProperties?: VariantDigitalProperties;
|
|
4073
4070
|
}
|
|
4074
|
-
|
|
4071
|
+
interface OptionChoice {
|
|
4075
4072
|
/** Option and choice IDs. These match the IDs of the option and choice from the product's options field. */
|
|
4076
4073
|
optionChoiceIds?: OptionChoiceIds;
|
|
4077
4074
|
/**
|
|
@@ -4081,7 +4078,7 @@ export interface OptionChoice {
|
|
|
4081
4078
|
*/
|
|
4082
4079
|
optionChoiceNames?: OptionChoiceNames;
|
|
4083
4080
|
}
|
|
4084
|
-
|
|
4081
|
+
interface OptionChoiceIds {
|
|
4085
4082
|
/**
|
|
4086
4083
|
* Option ID.
|
|
4087
4084
|
* @minLength 1
|
|
@@ -4096,7 +4093,7 @@ export interface OptionChoiceIds {
|
|
|
4096
4093
|
*/
|
|
4097
4094
|
choiceId?: string;
|
|
4098
4095
|
}
|
|
4099
|
-
|
|
4096
|
+
interface OptionChoiceNames {
|
|
4100
4097
|
/**
|
|
4101
4098
|
* Option name.
|
|
4102
4099
|
* @minLength 1
|
|
@@ -4112,13 +4109,13 @@ export interface OptionChoiceNames {
|
|
|
4112
4109
|
/** Render type. */
|
|
4113
4110
|
renderType?: ProductOptionRenderTypeWithLiterals;
|
|
4114
4111
|
}
|
|
4115
|
-
|
|
4112
|
+
interface PriceInfo {
|
|
4116
4113
|
/** Variant price. Must be greater or equal to 0. */
|
|
4117
4114
|
actualPrice?: FixedMonetaryAmount;
|
|
4118
4115
|
/** 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. */
|
|
4119
4116
|
compareAtPrice?: FixedMonetaryAmount;
|
|
4120
4117
|
}
|
|
4121
|
-
|
|
4118
|
+
interface RevenueDetails {
|
|
4122
4119
|
/** Item cost. */
|
|
4123
4120
|
cost?: FixedMonetaryAmount;
|
|
4124
4121
|
/**
|
|
@@ -4134,7 +4131,7 @@ export interface RevenueDetails {
|
|
|
4134
4131
|
*/
|
|
4135
4132
|
profitMargin?: number;
|
|
4136
4133
|
}
|
|
4137
|
-
|
|
4134
|
+
interface VariantPhysicalProperties {
|
|
4138
4135
|
/**
|
|
4139
4136
|
* Variant shipping weight.
|
|
4140
4137
|
* product.physicalProperties.shipping_weight_range values are taken from here.
|
|
@@ -4148,7 +4145,7 @@ export interface VariantPhysicalProperties {
|
|
|
4148
4145
|
*/
|
|
4149
4146
|
pricePerUnit?: PricePerUnit;
|
|
4150
4147
|
}
|
|
4151
|
-
|
|
4148
|
+
interface PricePerUnit {
|
|
4152
4149
|
/**
|
|
4153
4150
|
* Price per unit data for this variant.
|
|
4154
4151
|
* `measurementUnit` value must correspond to the measurement unit set on the product.
|
|
@@ -4169,11 +4166,11 @@ export interface PricePerUnit {
|
|
|
4169
4166
|
*/
|
|
4170
4167
|
description?: string | null;
|
|
4171
4168
|
}
|
|
4172
|
-
|
|
4169
|
+
interface VariantDigitalProperties {
|
|
4173
4170
|
/** Digital file which will be downloaded by customer after successful purchase. */
|
|
4174
4171
|
digitalFile?: SecuredMedia;
|
|
4175
4172
|
}
|
|
4176
|
-
|
|
4173
|
+
interface SecuredMedia {
|
|
4177
4174
|
/**
|
|
4178
4175
|
* Media ID in media manager.
|
|
4179
4176
|
* @minLength 1
|
|
@@ -4202,7 +4199,7 @@ export interface SecuredMedia {
|
|
|
4202
4199
|
*/
|
|
4203
4200
|
fileType?: FileTypeWithLiterals;
|
|
4204
4201
|
}
|
|
4205
|
-
|
|
4202
|
+
declare enum FileType {
|
|
4206
4203
|
/** Unspecified file type. */
|
|
4207
4204
|
UNSPECIFIED = "UNSPECIFIED",
|
|
4208
4205
|
/** Secure picture file. */
|
|
@@ -4217,15 +4214,15 @@ export declare enum FileType {
|
|
|
4217
4214
|
SECURE_ARCHIVE = "SECURE_ARCHIVE"
|
|
4218
4215
|
}
|
|
4219
4216
|
/** @enumType */
|
|
4220
|
-
|
|
4221
|
-
|
|
4217
|
+
type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
|
|
4218
|
+
interface SubscriptionPricesInfo {
|
|
4222
4219
|
/**
|
|
4223
4220
|
* Subscription prices.
|
|
4224
4221
|
* @maxSize 6
|
|
4225
4222
|
*/
|
|
4226
4223
|
subscriptionPrices?: SubscriptionPrice[];
|
|
4227
4224
|
}
|
|
4228
|
-
|
|
4225
|
+
interface SubscriptionPrice {
|
|
4229
4226
|
/**
|
|
4230
4227
|
* Subscription ID.
|
|
4231
4228
|
* @format GUID
|
|
@@ -4243,7 +4240,7 @@ export interface SubscriptionPrice {
|
|
|
4243
4240
|
*/
|
|
4244
4241
|
pricePerUnit?: SubscriptionPricePerUnit;
|
|
4245
4242
|
}
|
|
4246
|
-
|
|
4243
|
+
interface SubscriptionPricePerUnit {
|
|
4247
4244
|
/**
|
|
4248
4245
|
* Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.
|
|
4249
4246
|
* @readonly
|
|
@@ -4258,13 +4255,13 @@ export interface SubscriptionPricePerUnit {
|
|
|
4258
4255
|
*/
|
|
4259
4256
|
description?: string | null;
|
|
4260
4257
|
}
|
|
4261
|
-
|
|
4258
|
+
interface InventoryStatus {
|
|
4262
4259
|
/** Whether the variant is in stock. */
|
|
4263
4260
|
inStock?: boolean;
|
|
4264
4261
|
/** Whether preorder is enabled for this variant. */
|
|
4265
4262
|
preorderEnabled?: boolean;
|
|
4266
4263
|
}
|
|
4267
|
-
|
|
4264
|
+
interface ExtendedFields {
|
|
4268
4265
|
/**
|
|
4269
4266
|
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
4270
4267
|
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
@@ -4275,7 +4272,7 @@ export interface ExtendedFields {
|
|
|
4275
4272
|
*/
|
|
4276
4273
|
namespaces?: Record<string, Record<string, any>>;
|
|
4277
4274
|
}
|
|
4278
|
-
|
|
4275
|
+
interface SubscriptionDetails {
|
|
4279
4276
|
/**
|
|
4280
4277
|
* Subscriptions.
|
|
4281
4278
|
* @minSize 1
|
|
@@ -4289,7 +4286,7 @@ export interface SubscriptionDetails {
|
|
|
4289
4286
|
*/
|
|
4290
4287
|
allowOneTimePurchases?: boolean | null;
|
|
4291
4288
|
}
|
|
4292
|
-
|
|
4289
|
+
interface Subscription extends SubscriptionCyclesOneOf {
|
|
4293
4290
|
/** Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`. */
|
|
4294
4291
|
autoRenewal?: boolean;
|
|
4295
4292
|
/**
|
|
@@ -4339,7 +4336,7 @@ export interface Subscription extends SubscriptionCyclesOneOf {
|
|
|
4339
4336
|
discount?: SubscriptionDiscount;
|
|
4340
4337
|
}
|
|
4341
4338
|
/** @oneof */
|
|
4342
|
-
|
|
4339
|
+
interface SubscriptionCyclesOneOf {
|
|
4343
4340
|
/** Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`. */
|
|
4344
4341
|
autoRenewal?: boolean;
|
|
4345
4342
|
/**
|
|
@@ -4350,7 +4347,7 @@ export interface SubscriptionCyclesOneOf {
|
|
|
4350
4347
|
billingCycles?: number;
|
|
4351
4348
|
}
|
|
4352
4349
|
/** Frequency unit of recurring payment */
|
|
4353
|
-
|
|
4350
|
+
declare enum SubscriptionFrequency {
|
|
4354
4351
|
UNDEFINED = "UNDEFINED",
|
|
4355
4352
|
DAY = "DAY",
|
|
4356
4353
|
WEEK = "WEEK",
|
|
@@ -4358,8 +4355,8 @@ export declare enum SubscriptionFrequency {
|
|
|
4358
4355
|
YEAR = "YEAR"
|
|
4359
4356
|
}
|
|
4360
4357
|
/** @enumType */
|
|
4361
|
-
|
|
4362
|
-
|
|
4358
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
4359
|
+
interface SubscriptionDiscount extends SubscriptionDiscountDiscountOneOf {
|
|
4363
4360
|
/**
|
|
4364
4361
|
* Amount to discount from the variant discounted_price.
|
|
4365
4362
|
* @decimalValue options { gt:0, lte:999999999, maxScale:3 }
|
|
@@ -4375,7 +4372,7 @@ export interface SubscriptionDiscount extends SubscriptionDiscountDiscountOneOf
|
|
|
4375
4372
|
type?: DiscountTypeWithLiterals;
|
|
4376
4373
|
}
|
|
4377
4374
|
/** @oneof */
|
|
4378
|
-
|
|
4375
|
+
interface SubscriptionDiscountDiscountOneOf {
|
|
4379
4376
|
/**
|
|
4380
4377
|
* Amount to discount from the variant discounted_price.
|
|
4381
4378
|
* @decimalValue options { gt:0, lte:999999999, maxScale:3 }
|
|
@@ -4388,7 +4385,7 @@ export interface SubscriptionDiscountDiscountOneOf {
|
|
|
4388
4385
|
*/
|
|
4389
4386
|
percentOff?: number;
|
|
4390
4387
|
}
|
|
4391
|
-
|
|
4388
|
+
declare enum DiscountType {
|
|
4392
4389
|
UNKNOWN_DISCOUNT = "UNKNOWN_DISCOUNT",
|
|
4393
4390
|
/** Discount by a specific amount. */
|
|
4394
4391
|
AMOUNT = "AMOUNT",
|
|
@@ -4396,15 +4393,15 @@ export declare enum DiscountType {
|
|
|
4396
4393
|
PERCENT = "PERCENT"
|
|
4397
4394
|
}
|
|
4398
4395
|
/** @enumType */
|
|
4399
|
-
|
|
4400
|
-
|
|
4396
|
+
type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_DISCOUNT' | 'AMOUNT' | 'PERCENT';
|
|
4397
|
+
interface VariantSummary {
|
|
4401
4398
|
/**
|
|
4402
4399
|
* The total number of variants for the product.
|
|
4403
4400
|
* @readonly
|
|
4404
4401
|
*/
|
|
4405
4402
|
variantCount?: number;
|
|
4406
4403
|
}
|
|
4407
|
-
|
|
4404
|
+
interface MinVariantPriceInfo {
|
|
4408
4405
|
/**
|
|
4409
4406
|
* Subscription price calculated by applying subscription discount to the variant `price.actualPrice`
|
|
4410
4407
|
* @readonly
|
|
@@ -4449,13 +4446,13 @@ export interface MinVariantPriceInfo {
|
|
|
4449
4446
|
/** 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. */
|
|
4450
4447
|
compareAtPrice?: FixedMonetaryAmount;
|
|
4451
4448
|
}
|
|
4452
|
-
|
|
4449
|
+
interface MigrateProductVariantsResponse {
|
|
4453
4450
|
}
|
|
4454
|
-
|
|
4451
|
+
interface RecoverProductVariantsRequest {
|
|
4455
4452
|
}
|
|
4456
|
-
|
|
4453
|
+
interface RecoverProductVariantsResponse {
|
|
4457
4454
|
}
|
|
4458
|
-
|
|
4455
|
+
interface DomainEvent extends DomainEventBodyOneOf {
|
|
4459
4456
|
createdEvent?: EntityCreatedEvent;
|
|
4460
4457
|
updatedEvent?: EntityUpdatedEvent;
|
|
4461
4458
|
deletedEvent?: EntityDeletedEvent;
|
|
@@ -4490,19 +4487,19 @@ export interface DomainEvent extends DomainEventBodyOneOf {
|
|
|
4490
4487
|
entityEventSequence?: string | null;
|
|
4491
4488
|
}
|
|
4492
4489
|
/** @oneof */
|
|
4493
|
-
|
|
4490
|
+
interface DomainEventBodyOneOf {
|
|
4494
4491
|
createdEvent?: EntityCreatedEvent;
|
|
4495
4492
|
updatedEvent?: EntityUpdatedEvent;
|
|
4496
4493
|
deletedEvent?: EntityDeletedEvent;
|
|
4497
4494
|
actionEvent?: ActionEvent;
|
|
4498
4495
|
}
|
|
4499
|
-
|
|
4496
|
+
interface EntityCreatedEvent {
|
|
4500
4497
|
entity?: string;
|
|
4501
4498
|
}
|
|
4502
|
-
|
|
4499
|
+
interface RestoreInfo {
|
|
4503
4500
|
deletedDate?: Date | null;
|
|
4504
4501
|
}
|
|
4505
|
-
|
|
4502
|
+
interface EntityUpdatedEvent {
|
|
4506
4503
|
/**
|
|
4507
4504
|
* Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
|
|
4508
4505
|
* This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
|
|
@@ -4510,16 +4507,16 @@ export interface EntityUpdatedEvent {
|
|
|
4510
4507
|
*/
|
|
4511
4508
|
currentEntity?: string;
|
|
4512
4509
|
}
|
|
4513
|
-
|
|
4510
|
+
interface EntityDeletedEvent {
|
|
4514
4511
|
/** Entity that was deleted. */
|
|
4515
4512
|
deletedEntity?: string | null;
|
|
4516
4513
|
}
|
|
4517
|
-
|
|
4514
|
+
interface ActionEvent {
|
|
4518
4515
|
body?: string;
|
|
4519
4516
|
}
|
|
4520
|
-
|
|
4517
|
+
interface Empty {
|
|
4521
4518
|
}
|
|
4522
|
-
|
|
4519
|
+
interface MessageEnvelope {
|
|
4523
4520
|
/**
|
|
4524
4521
|
* App instance ID.
|
|
4525
4522
|
* @format GUID
|
|
@@ -4535,7 +4532,7 @@ export interface MessageEnvelope {
|
|
|
4535
4532
|
/** Stringify payload. */
|
|
4536
4533
|
data?: string;
|
|
4537
4534
|
}
|
|
4538
|
-
|
|
4535
|
+
interface IdentificationData extends IdentificationDataIdOneOf {
|
|
4539
4536
|
/**
|
|
4540
4537
|
* ID of a site visitor that has not logged in to the site.
|
|
4541
4538
|
* @format GUID
|
|
@@ -4560,7 +4557,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
4560
4557
|
identityType?: WebhookIdentityTypeWithLiterals;
|
|
4561
4558
|
}
|
|
4562
4559
|
/** @oneof */
|
|
4563
|
-
|
|
4560
|
+
interface IdentificationDataIdOneOf {
|
|
4564
4561
|
/**
|
|
4565
4562
|
* ID of a site visitor that has not logged in to the site.
|
|
4566
4563
|
* @format GUID
|
|
@@ -4582,7 +4579,7 @@ export interface IdentificationDataIdOneOf {
|
|
|
4582
4579
|
*/
|
|
4583
4580
|
appId?: string;
|
|
4584
4581
|
}
|
|
4585
|
-
|
|
4582
|
+
declare enum WebhookIdentityType {
|
|
4586
4583
|
UNKNOWN = "UNKNOWN",
|
|
4587
4584
|
ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
|
|
4588
4585
|
MEMBER = "MEMBER",
|
|
@@ -4590,58 +4587,8 @@ export declare enum WebhookIdentityType {
|
|
|
4590
4587
|
APP = "APP"
|
|
4591
4588
|
}
|
|
4592
4589
|
/** @enumType */
|
|
4593
|
-
|
|
4594
|
-
|
|
4595
|
-
/**
|
|
4596
|
-
* Retrieves a list of ReadOnlyVariants, given the provided [paging, filtering, and sorting][1].
|
|
4597
|
-
* Up to 1,000 ReadOnlyVariants can be returned per request.
|
|
4598
|
-
* To learn how to query ReadOnlyVariants, see [API Query Language][2].
|
|
4599
|
-
* [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
|
|
4600
|
-
* [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
|
|
4601
|
-
* @internal
|
|
4602
|
-
* @documentationMaturity preview
|
|
4603
|
-
* @permissionScope Manage Stores - all permissions
|
|
4604
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4605
|
-
* @permissionScope Manage Stores
|
|
4606
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4607
|
-
* @permissionScope Read products in v3 catalog
|
|
4608
|
-
* @permissionScopeId SCOPE.STORES.PRODUCT_READ
|
|
4609
|
-
* @permissionScope Read v3 catalog
|
|
4610
|
-
* @permissionScopeId SCOPE.STORES.CATALOG_READ
|
|
4611
|
-
* @permissionScope Manage Products
|
|
4612
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
4613
|
-
* @permissionScope Read Stores - all read permissions
|
|
4614
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
4615
|
-
* @permissionScope Read Products
|
|
4616
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
4617
|
-
* @permissionScope Product v3 read admin
|
|
4618
|
-
* @permissionScopeId SCOPE.STORES.PRODUCT_READ_ADMIN
|
|
4619
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
4620
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4621
|
-
* @permissionScope Manage v3 catalog
|
|
4622
|
-
* @permissionScopeId SCOPE.STORES.CATALOG_WRITE
|
|
4623
|
-
* @permissionScope Manage Orders
|
|
4624
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
4625
|
-
* @permissionScope Manage Stores - all permissions
|
|
4626
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4627
|
-
* @permissionScope Manage Stores
|
|
4628
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4629
|
-
* @permissionScope Manage Products
|
|
4630
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
4631
|
-
* @permissionScope Read Stores - all read permissions
|
|
4632
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
4633
|
-
* @permissionScope Read Products
|
|
4634
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
4635
|
-
* @permissionScope Product v3 read admin
|
|
4636
|
-
* @permissionScopeId SCOPE.STORES.PRODUCT_READ_ADMIN
|
|
4637
|
-
* @permissionId WIX_STORES.READ_ONLY_VARIANT_READ
|
|
4638
|
-
* @permissionId WIX_STORES.READ_ONLY_VARIANT_READ_HIDDEN
|
|
4639
|
-
* @applicableIdentity APP
|
|
4640
|
-
* @applicableIdentity VISITOR
|
|
4641
|
-
* @fqn com.wix.stores.catalog.product.variants.reader.api.v3.ProductVariantsReader.QueryVariants
|
|
4642
|
-
*/
|
|
4643
|
-
export declare function queryVariants(options?: QueryVariantsOptions): VariantsQueryBuilder;
|
|
4644
|
-
export interface QueryVariantsOptions {
|
|
4590
|
+
type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
4591
|
+
interface QueryVariantsOptions {
|
|
4645
4592
|
/**
|
|
4646
4593
|
* A list of requested fields to be included in the response.
|
|
4647
4594
|
* @maxSize 100
|
|
@@ -4655,13 +4602,13 @@ interface QueryCursorResult {
|
|
|
4655
4602
|
length: number;
|
|
4656
4603
|
pageSize: number;
|
|
4657
4604
|
}
|
|
4658
|
-
|
|
4605
|
+
interface VariantsQueryResult extends QueryCursorResult {
|
|
4659
4606
|
items: ReadOnlyVariant[];
|
|
4660
4607
|
query: VariantsQueryBuilder;
|
|
4661
4608
|
next: () => Promise<VariantsQueryResult>;
|
|
4662
4609
|
prev: () => Promise<VariantsQueryResult>;
|
|
4663
4610
|
}
|
|
4664
|
-
|
|
4611
|
+
interface VariantsQueryBuilder {
|
|
4665
4612
|
/** @param propertyName - Property whose value is compared with `value`.
|
|
4666
4613
|
* @param value - Value to compare against.
|
|
4667
4614
|
* @documentationMaturity preview
|
|
@@ -4725,66 +4672,14 @@ export interface VariantsQueryBuilder {
|
|
|
4725
4672
|
/** @documentationMaturity preview */
|
|
4726
4673
|
find: () => Promise<VariantsQueryResult>;
|
|
4727
4674
|
}
|
|
4728
|
-
|
|
4729
|
-
* Search Variants using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language)
|
|
4730
|
-
* >**Notes:**
|
|
4731
|
-
* + If you don't have permissions to read non visible products then variants related to non-visible products will be filtered out from response.
|
|
4732
|
-
* In such case non visible variants also will be filtered out.
|
|
4733
|
-
* @param search - WQL expression
|
|
4734
|
-
* @internal
|
|
4735
|
-
* @documentationMaturity preview
|
|
4736
|
-
* @requiredField search
|
|
4737
|
-
* @permissionId WIX_STORES.READ_ONLY_VARIANT_READ
|
|
4738
|
-
* @permissionId WIX_STORES.READ_ONLY_VARIANT_READ_HIDDEN
|
|
4739
|
-
* @permissionScope Manage Stores - all permissions
|
|
4740
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4741
|
-
* @permissionScope Manage Stores
|
|
4742
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4743
|
-
* @permissionScope Read products in v3 catalog
|
|
4744
|
-
* @permissionScopeId SCOPE.STORES.PRODUCT_READ
|
|
4745
|
-
* @permissionScope Read v3 catalog
|
|
4746
|
-
* @permissionScopeId SCOPE.STORES.CATALOG_READ
|
|
4747
|
-
* @permissionScope Manage Products
|
|
4748
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
4749
|
-
* @permissionScope Read Stores - all read permissions
|
|
4750
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
4751
|
-
* @permissionScope Read Products
|
|
4752
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
4753
|
-
* @permissionScope Product v3 read admin
|
|
4754
|
-
* @permissionScopeId SCOPE.STORES.PRODUCT_READ_ADMIN
|
|
4755
|
-
* @permissionScope Manage Restaurants - all permissions
|
|
4756
|
-
* @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
|
|
4757
|
-
* @permissionScope Manage v3 catalog
|
|
4758
|
-
* @permissionScopeId SCOPE.STORES.CATALOG_WRITE
|
|
4759
|
-
* @permissionScope Manage Orders
|
|
4760
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-ORDERS
|
|
4761
|
-
* @permissionScope Manage Stores - all permissions
|
|
4762
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
|
|
4763
|
-
* @permissionScope Manage Stores
|
|
4764
|
-
* @permissionScopeId SCOPE.STORES.MANAGE-STORES
|
|
4765
|
-
* @permissionScope Manage Products
|
|
4766
|
-
* @permissionScopeId SCOPE.DC-STORES.MANAGE-PRODUCTS
|
|
4767
|
-
* @permissionScope Read Stores - all read permissions
|
|
4768
|
-
* @permissionScopeId SCOPE.DC-STORES-MEGA.READ-STORES
|
|
4769
|
-
* @permissionScope Read Products
|
|
4770
|
-
* @permissionScopeId SCOPE.DC-STORES.READ-PRODUCTS
|
|
4771
|
-
* @permissionScope Product v3 read admin
|
|
4772
|
-
* @permissionScopeId SCOPE.STORES.PRODUCT_READ_ADMIN
|
|
4773
|
-
* @applicableIdentity APP
|
|
4774
|
-
* @applicableIdentity VISITOR
|
|
4775
|
-
* @fqn com.wix.stores.catalog.product.variants.reader.api.v3.ProductVariantsReader.SearchVariants
|
|
4776
|
-
*/
|
|
4777
|
-
export declare function searchVariants(search: ReadOnlyVariantSearch, options?: SearchVariantsOptions): Promise<NonNullablePaths<SearchVariantsResponse, {
|
|
4778
|
-
[P in ReadOnlyVariantNonNullablePaths]: `variants.${number}.${P}`;
|
|
4779
|
-
}[ReadOnlyVariantNonNullablePaths] | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`>>;
|
|
4780
|
-
export interface SearchVariantsOptions {
|
|
4675
|
+
interface SearchVariantsOptions {
|
|
4781
4676
|
/**
|
|
4782
4677
|
* A list of requested fields to be included in the response.
|
|
4783
4678
|
* @maxSize 100
|
|
4784
4679
|
*/
|
|
4785
4680
|
fields?: RequestedFieldsWithLiterals[];
|
|
4786
4681
|
}
|
|
4787
|
-
|
|
4682
|
+
interface ReadOnlyVariantSearchSpec extends SearchSpec {
|
|
4788
4683
|
aggregatable: [
|
|
4789
4684
|
'barcode',
|
|
4790
4685
|
'internalMetadata.rowState',
|
|
@@ -4837,8 +4732,8 @@ export interface ReadOnlyVariantSearchSpec extends SearchSpec {
|
|
|
4837
4732
|
}
|
|
4838
4733
|
];
|
|
4839
4734
|
}
|
|
4840
|
-
|
|
4841
|
-
|
|
4735
|
+
type CommonSearchWithEntityContext = Search<ReadOnlyVariant, ReadOnlyVariantSearchSpec>;
|
|
4736
|
+
type ReadOnlyVariantSearch = {
|
|
4842
4737
|
/**
|
|
4843
4738
|
Cursor pointing to page of results.
|
|
4844
4739
|
When requesting 'cursor_paging.cursor', no `filter`, `sort` or `search` can be provided.
|
|
@@ -4953,4 +4848,5 @@ export type ReadOnlyVariantSearch = {
|
|
|
4953
4848
|
*/
|
|
4954
4849
|
timeZone?: CommonSearchWithEntityContext['timeZone'] | null;
|
|
4955
4850
|
};
|
|
4956
|
-
|
|
4851
|
+
|
|
4852
|
+
export { DecorationType as $, AggregationType as A, LayoutType as B, CommonSortOrder as C, DateHistogramAggregationInterval as D, Crop as E, ThumbnailsAlignment as F, GIFType as G, Source as H, InternalRowState as I, Position as J, MapType as K, LineStyle as L, MeasurementUnit as M, NestedAggregationType as N, Orientation as O, ProductMediaMediaType as P, type QueryVariantsOptions as Q, type ReadOnlyVariantSearch as R, type SearchVariantsOptions as S, Type as T, ViewRole as U, type VariantsQueryBuilder as V, WeightUnit as W, VoteRole as X, PollLayoutType as Y, PollLayoutDirection as Z, BackgroundType as _, type SearchVariantsResponse as a, type ScalarAggregation as a$, FontType as a0, AppType as a1, InitialExpandedItems as a2, Direction as a3, VerticalAlignment as a4, NullValue as a5, MediaType as a6, ProductOptionRenderType as a7, ChoiceType as a8, ModifierRenderType as a9, type V3SubscriptionPricesInfo as aA, type V3SubscriptionPrice as aB, type V3SubscriptionPricePerUnit as aC, type V3InventoryStatus as aD, type ProductFields as aE, type ProductFieldsTypedPropertiesOneOf as aF, type V3PhysicalProperties as aG, type V3WeightMeasurementUnitInfo as aH, type InternalMetadata as aI, type QueryVariantsRequest as aJ, type CursorQuery as aK, type CursorQueryPagingMethodOneOf as aL, type Sorting as aM, type CursorPaging as aN, type QueryVariantsResponse as aO, type CursorPagingMetadata as aP, type Cursors as aQ, type SearchVariantsRequest as aR, type CursorSearch as aS, type CursorSearchPagingMethodOneOf as aT, type Aggregation as aU, type AggregationKindOneOf as aV, type RangeBucket as aW, type IncludeMissingValuesOptions as aX, type ValueAggregation as aY, type ValueAggregationOptionsOneOf as aZ, type RangeAggregation as a_, AvailabilityStatus as aa, PreorderStatus as ab, ProductPreorderAvailability as ac, ProductType as ad, FileType as ae, SubscriptionFrequency as af, DiscountType as ag, WebhookIdentityType as ah, type ReadOnlyVariant as ai, type ReadOnlyVariantTypedPropertiesOneOf as aj, type V3OptionChoice as ak, type V3OptionChoiceIds as al, type V3OptionChoiceNames as am, type V3PriceInfo as an, type V3FixedMonetaryAmount as ao, type V3RevenueDetails as ap, type V3ProductMedia as aq, type V3ProductMediaSetByOneOf as ar, type V3ProductMediaMediaOneOf as as, type CommonVideoResolution as at, type V3Thumbnail as au, type V3VariantPhysicalProperties as av, type V3PricePerUnit as aw, type V3PricePerUnitSettings as ax, type V3VariantDigitalProperties as ay, type V3SecuredMedia as az, SecuredMediaFileType as b, type Styles as b$, type DateHistogramAggregation as b0, type NestedAggregationItem as b1, type NestedAggregationItemKindOneOf as b2, type NestedAggregation as b3, type SearchDetails as b4, type AggregationData as b5, type ValueAggregationResult as b6, type RangeAggregationResult as b7, type NestedAggregationResults as b8, type NestedAggregationResultsResultOneOf as b9, type AggregationRangeAggregation as bA, type AggregationScalarAggregation as bB, type AggregationDateHistogramAggregation as bC, type NestedAggregationNestedAggregationItem as bD, type NestedAggregationNestedAggregationItemKindOneOf as bE, type AggregationNestedAggregation as bF, type GroupByAggregation as bG, type GroupByAggregationKindOneOf as bH, type CommonSearchDetails as bI, type PlatformPaging as bJ, type DeprecatedSearchVariantsWithOffsetResponse as bK, type PagingMetadata as bL, type MigrateProductVariantsRequest as bM, type Product as bN, type ProductTypedPropertiesOneOf as bO, type RichContent as bP, type Node as bQ, type NodeDataOneOf as bR, type NodeStyle as bS, type ButtonData as bT, type Border as bU, type Colors as bV, type PluginContainerData as bW, type PluginContainerDataWidth as bX, type PluginContainerDataWidthDataOneOf as bY, type Spoiler as bZ, type Height as b_, type ValueResults as ba, type RangeResults as bb, type AggregationResultsScalarResult as bc, type NestedValueAggregationResult as bd, type ValueResult as be, type RangeResult as bf, type ScalarResult as bg, type NestedResultValue as bh, type NestedResultValueResultOneOf as bi, type Results as bj, type DateHistogramResult as bk, type GroupByValueResults as bl, type DateHistogramResults as bm, type NestedResults as bn, type AggregationResults as bo, type AggregationResultsResultOneOf as bp, type DeprecatedSearchVariantsWithOffsetRequest as bq, type PlatformOffsetSearch as br, type PlatformOffsetSearchPagingMethodOneOf as bs, type CommonSorting as bt, type CommonAggregation as bu, type CommonAggregationKindOneOf as bv, type RangeAggregationRangeBucket as bw, type ValueAggregationIncludeMissingValuesOptions as bx, type AggregationValueAggregation as by, type AggregationValueAggregationOptionsOneOf as bz, V3ProductType as c, type Oembed as c$, type Link as c0, type LinkDataOneOf as c1, type Rel as c2, type CodeBlockData as c3, type TextStyle as c4, type DividerData as c5, type FileData as c6, type FileSource as c7, type FileSourceDataOneOf as c8, type PDFSettings as c9, type PollSettings as cA, type PollLayout as cB, type OptionLayout as cC, type Gradient as cD, type Background as cE, type BackgroundBackgroundOneOf as cF, type PollDesign as cG, type OptionDesign as cH, type Poll as cI, type PollDataLayout as cJ, type Design as cK, type TextData as cL, type Decoration as cM, type DecorationDataOneOf as cN, type AnchorData as cO, type ColorData as cP, type LinkData as cQ, type MentionData as cR, type FontSizeData as cS, type SpoilerData as cT, type AppEmbedData as cU, type AppEmbedDataAppDataOneOf as cV, type BookingData as cW, type EventData as cX, type VideoData as cY, type PlaybackOptions as cZ, type EmbedData as c_, type GalleryData as ca, type V1Media as cb, type Image as cc, type Video as cd, type Item as ce, type ItemDataOneOf as cf, type GalleryOptions as cg, type Layout as ch, type ItemStyle as ci, type Thumbnails as cj, type GIFData as ck, type GIF as cl, type HeadingData as cm, type HTMLData as cn, type HTMLDataDataOneOf as co, type ImageData as cp, type StylesBorder as cq, type ImageDataStyles as cr, type LinkPreviewData as cs, type LinkPreviewDataStyles as ct, type MapData as cu, type MapSettings as cv, type ParagraphData as cw, type PollData as cx, type Permissions as cy, type Option as cz, SortOrder as d, type PriceInfo as d$, type CollapsibleListData as d0, type TableData as d1, type Dimensions as d2, type TableCellData as d3, type CellStyle as d4, type BorderColors as d5, type ListValue as d6, type AudioData as d7, type OrderedListData as d8, type BulletedListData as d9, type FreeTextSettings as dA, type ModifierChoicesSettings as dB, type ConnectedModifierChoice as dC, type ConnectedModifierChoiceValueOneOf as dD, type Brand as dE, type InfoSection as dF, type Ribbon as dG, type ProductCategoriesInfo as dH, type ProductCategory as dI, type ProductCategoryIdsInfo as dJ, type PriceRange as dK, type FixedMonetaryAmount as dL, type Inventory as dM, type PhysicalProperties as dN, type PricePerUnitSettings as dO, type WeightRange as dP, type PricePerUnitRange as dQ, type PricePerUnitRangePricePerUnit as dR, type WeightMeasurementUnitInfo as dS, type BreadcrumbsInfo as dT, type BreadCrumb as dU, type VariantsInfo as dV, type Variant as dW, type VariantTypedPropertiesOneOf as dX, type OptionChoice as dY, type OptionChoiceIds as dZ, type OptionChoiceNames as d_, type BlockquoteData as da, type CaptionData as db, type LayoutCellData as dc, type Metadata as dd, type DocumentStyle as de, type TextNodeStyle as df, type Media as dg, type ProductMedia as dh, type ProductMediaSetByOneOf as di, type ProductMediaMediaOneOf as dj, type VideoResolution as dk, type Thumbnail as dl, type MediaItemsInfo as dm, type SeoSchema as dn, type Keyword as dp, type Tag as dq, type Settings as dr, type ConnectedOption as ds, type ConnectedOptionOptionSettingsOneOf as dt, type ChoicesSettings as du, type ConnectedOptionChoice as dv, type ConnectedOptionChoiceValueOneOf as dw, type MultipleColors as dx, type ConnectedModifier as dy, type ConnectedModifierModifierSettingsOneOf as dz, RequestedFields as e, type RevenueDetails as e0, type VariantPhysicalProperties as e1, type PricePerUnit as e2, type VariantDigitalProperties as e3, type SecuredMedia as e4, type SubscriptionPricesInfo as e5, type SubscriptionPrice as e6, type SubscriptionPricePerUnit as e7, type InventoryStatus as e8, type ExtendedFields as e9, type SubscriptionDetails as ea, type Subscription as eb, type SubscriptionCyclesOneOf as ec, type SubscriptionDiscount as ed, type SubscriptionDiscountDiscountOneOf as ee, type VariantSummary as ef, type MinVariantPriceInfo as eg, type MigrateProductVariantsResponse as eh, type RecoverProductVariantsRequest as ei, type RecoverProductVariantsResponse as ej, type DomainEvent as ek, type DomainEventBodyOneOf as el, type EntityCreatedEvent as em, type RestoreInfo as en, type EntityUpdatedEvent as eo, type EntityDeletedEvent as ep, type ActionEvent as eq, type Empty as er, type MessageEnvelope as es, type IdentificationData as et, type IdentificationDataIdOneOf as eu, type VariantsQueryResult as ev, type ReadOnlyVariantSearchSpec as ew, SortType as f, SortDirection as g, MissingValues as h, ScalarType as i, Interval as j, Mode as k, ValueAggregationSortType as l, ValueAggregationSortDirection as m, ValueAggregationMissingValues as n, CommonScalarType as o, NestedAggregationNestedAggregationType as p, CommonAggregationType as q, SearchDetailsMode as r, NodeType as s, WidthType as t, PluginContainerDataAlignment as u, Target as v, TextAlignment as w, Width as x, Alignment as y, ViewMode as z };
|