@wix/auto_sdk_stores_read-only-variants-v-3 1.0.29 → 1.0.31

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.
Files changed (27) hide show
  1. package/build/cjs/index.js.map +1 -1
  2. package/build/cjs/index.typings.js.map +1 -1
  3. package/build/cjs/meta.d.ts +3689 -1
  4. package/build/cjs/meta.js +684 -0
  5. package/build/cjs/meta.js.map +1 -1
  6. package/build/es/index.mjs.map +1 -1
  7. package/build/es/index.typings.mjs.map +1 -1
  8. package/build/es/meta.d.mts +3689 -1
  9. package/build/es/meta.mjs +610 -0
  10. package/build/es/meta.mjs.map +1 -1
  11. package/build/internal/cjs/index.d.ts +2 -2
  12. package/build/internal/cjs/index.js.map +1 -1
  13. package/build/internal/cjs/index.typings.d.ts +2 -2
  14. package/build/internal/cjs/index.typings.js.map +1 -1
  15. package/build/internal/cjs/meta.d.ts +3690 -2
  16. package/build/internal/cjs/meta.js +684 -0
  17. package/build/internal/cjs/meta.js.map +1 -1
  18. package/build/internal/cjs/{stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DXrWs8PM.d.ts → stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-rZglDgDZ.d.ts} +6 -0
  19. package/build/internal/es/index.d.mts +2 -2
  20. package/build/internal/es/index.mjs.map +1 -1
  21. package/build/internal/es/index.typings.d.mts +2 -2
  22. package/build/internal/es/index.typings.mjs.map +1 -1
  23. package/build/internal/es/meta.d.mts +3690 -2
  24. package/build/internal/es/meta.mjs +610 -0
  25. package/build/internal/es/meta.mjs.map +1 -1
  26. package/build/internal/es/{stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DXrWs8PM.d.mts → stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-rZglDgDZ.d.mts} +6 -0
  27. package/package.json +3 -3
@@ -1,4 +1,4 @@
1
- import { aQ as QueryVariantsRequest$1, aV as QueryVariantsResponse$1, aY as SearchVariantsRequest$1, a as SearchVariantsResponse$1 } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-DXrWs8PM.mjs';
1
+ import { aQ as QueryVariantsRequest$1, aV as QueryVariantsResponse$1, aY as SearchVariantsRequest$1, a as SearchVariantsResponse$1 } from './stores-catalog-v3-read-only-variant-read-only-variants-v-3.universal-rZglDgDZ.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -739,6 +739,22 @@ declare enum WeightUnit {
739
739
  }
740
740
  /** @enumType */
741
741
  type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
742
+ interface InternalMetadata {
743
+ }
744
+ declare enum InternalRowState {
745
+ /** Not implemented. */
746
+ UNKNOWN_ROW_STATE = "UNKNOWN_ROW_STATE",
747
+ /** Variant is ready to be read. */
748
+ READY = "READY",
749
+ /** Variant is being processed. */
750
+ IN_PROCESS = "IN_PROCESS",
751
+ /** Variant is soft deleted. */
752
+ SOFT_DELETED = "SOFT_DELETED",
753
+ /** Variant is permanently deleted. */
754
+ PERMANENTLY_DELETED = "PERMANENTLY_DELETED"
755
+ }
756
+ /** @enumType */
757
+ type InternalRowStateWithLiterals = InternalRowState | 'UNKNOWN_ROW_STATE' | 'READY' | 'IN_PROCESS' | 'SOFT_DELETED' | 'PERMANENTLY_DELETED';
742
758
  interface QueryVariantsRequest {
743
759
  /** WQL expression for filtering variants. */
744
760
  query?: CursorQuery;
@@ -1360,6 +1376,3678 @@ interface AggregationResultsResultOneOf {
1360
1376
  /** Nested aggregation results */
1361
1377
  nested?: NestedResults;
1362
1378
  }
1379
+ interface DeprecatedSearchVariantsWithOffsetRequest {
1380
+ /** Search parameters with offset-based pagination. */
1381
+ search?: PlatformOffsetSearch;
1382
+ /**
1383
+ * List of additional fields to include in the response.
1384
+ * See VariantOps.RequestedFields for available options.
1385
+ * @maxSize 100
1386
+ */
1387
+ fields?: RequestedFieldsWithLiterals[];
1388
+ }
1389
+ interface PlatformOffsetSearch extends PlatformOffsetSearchPagingMethodOneOf {
1390
+ /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
1391
+ paging?: PlatformPaging;
1392
+ /** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
1393
+ filter?: Record<string, any> | null;
1394
+ /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
1395
+ sort?: CommonSorting[];
1396
+ /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
1397
+ aggregations?: CommonAggregation[];
1398
+ /** free text to match in searchable fields */
1399
+ search?: CommonSearchDetails;
1400
+ }
1401
+ /** @oneof */
1402
+ interface PlatformOffsetSearchPagingMethodOneOf {
1403
+ /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
1404
+ paging?: PlatformPaging;
1405
+ }
1406
+ interface CommonSorting {
1407
+ /**
1408
+ * Name of the field to sort by.
1409
+ * @maxLength 512
1410
+ */
1411
+ fieldName?: string;
1412
+ /** Sort order. */
1413
+ order?: CommonSortOrderWithLiterals;
1414
+ }
1415
+ declare enum CommonSortOrder {
1416
+ ASC = "ASC",
1417
+ DESC = "DESC"
1418
+ }
1419
+ /** @enumType */
1420
+ type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
1421
+ interface CommonAggregation extends CommonAggregationKindOneOf {
1422
+ /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
1423
+ value?: AggregationValueAggregation;
1424
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
1425
+ range?: AggregationRangeAggregation;
1426
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
1427
+ scalar?: AggregationScalarAggregation;
1428
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
1429
+ dateHistogram?: AggregationDateHistogramAggregation;
1430
+ /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
1431
+ nested?: AggregationNestedAggregation;
1432
+ /**
1433
+ * Aggregation name, returned in `aggregations.results.name`.
1434
+ * @maxLength 100
1435
+ */
1436
+ name?: string | null;
1437
+ /** Type of aggregation to perform. Must align with the corresponding aggregation field. */
1438
+ type?: CommonAggregationTypeWithLiterals;
1439
+ /**
1440
+ * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
1441
+ * @maxLength 200
1442
+ */
1443
+ fieldPath?: string;
1444
+ /**
1445
+ * Deprecated. Use `nested` instead.
1446
+ * @deprecated Deprecated. Use `nested` instead.
1447
+ * @replacedBy kind.nested
1448
+ * @targetRemovalDate 2024-03-30
1449
+ */
1450
+ groupBy?: GroupByAggregation;
1451
+ }
1452
+ /** @oneof */
1453
+ interface CommonAggregationKindOneOf {
1454
+ /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
1455
+ value?: AggregationValueAggregation;
1456
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
1457
+ range?: AggregationRangeAggregation;
1458
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
1459
+ scalar?: AggregationScalarAggregation;
1460
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
1461
+ dateHistogram?: AggregationDateHistogramAggregation;
1462
+ /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
1463
+ nested?: AggregationNestedAggregation;
1464
+ }
1465
+ interface RangeAggregationRangeBucket {
1466
+ /** Inclusive lower bound of the range. Required if `to` is not provided. */
1467
+ from?: number | null;
1468
+ /** Exclusive upper bound of the range. Required if `from` is not provided. */
1469
+ to?: number | null;
1470
+ }
1471
+ declare enum ValueAggregationSortType {
1472
+ /** Number of matches in the results. */
1473
+ COUNT = "COUNT",
1474
+ /** Alphabetically by the field value. */
1475
+ VALUE = "VALUE"
1476
+ }
1477
+ /** @enumType */
1478
+ type ValueAggregationSortTypeWithLiterals = ValueAggregationSortType | 'COUNT' | 'VALUE';
1479
+ declare enum ValueAggregationSortDirection {
1480
+ /** Descending order. */
1481
+ DESC = "DESC",
1482
+ /** Ascending order. */
1483
+ ASC = "ASC"
1484
+ }
1485
+ /** @enumType */
1486
+ type ValueAggregationSortDirectionWithLiterals = ValueAggregationSortDirection | 'DESC' | 'ASC';
1487
+ declare enum ValueAggregationMissingValues {
1488
+ /** Exclude missing values from the aggregation results. */
1489
+ EXCLUDE = "EXCLUDE",
1490
+ /** Include missing values in the aggregation results. */
1491
+ INCLUDE = "INCLUDE"
1492
+ }
1493
+ /** @enumType */
1494
+ type ValueAggregationMissingValuesWithLiterals = ValueAggregationMissingValues | 'EXCLUDE' | 'INCLUDE';
1495
+ interface ValueAggregationIncludeMissingValuesOptions {
1496
+ /**
1497
+ * Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans.
1498
+ * @maxLength 20
1499
+ */
1500
+ addToBucket?: string;
1501
+ }
1502
+ declare enum CommonScalarType {
1503
+ UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
1504
+ /** Total number of distinct values. */
1505
+ COUNT_DISTINCT = "COUNT_DISTINCT",
1506
+ /** Minimum value. */
1507
+ MIN = "MIN",
1508
+ /** Maximum value. */
1509
+ MAX = "MAX"
1510
+ }
1511
+ /** @enumType */
1512
+ type CommonScalarTypeWithLiterals = CommonScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
1513
+ interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
1514
+ /** Options for including missing values in results. */
1515
+ includeOptions?: ValueAggregationIncludeMissingValuesOptions;
1516
+ /** Sort type. */
1517
+ sortType?: ValueAggregationSortTypeWithLiterals;
1518
+ /** Sort direction. */
1519
+ sortDirection?: ValueAggregationSortDirectionWithLiterals;
1520
+ /**
1521
+ * Number of aggregation results to return.
1522
+ * Min: `1`
1523
+ * Max: `250`
1524
+ * Default: `10`
1525
+ */
1526
+ limit?: number | null;
1527
+ /**
1528
+ * Whether to include or exclude missing values in the aggregation results.
1529
+ * Default: `EXCLUDE`.
1530
+ */
1531
+ missingValues?: ValueAggregationMissingValuesWithLiterals;
1532
+ }
1533
+ /** @oneof */
1534
+ interface AggregationValueAggregationOptionsOneOf {
1535
+ /** Options for including missing values in results. */
1536
+ includeOptions?: ValueAggregationIncludeMissingValuesOptions;
1537
+ }
1538
+ declare enum NestedAggregationNestedAggregationType {
1539
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1540
+ /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
1541
+ VALUE = "VALUE",
1542
+ /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
1543
+ RANGE = "RANGE",
1544
+ /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
1545
+ SCALAR = "SCALAR",
1546
+ /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
1547
+ DATE_HISTOGRAM = "DATE_HISTOGRAM"
1548
+ }
1549
+ /** @enumType */
1550
+ type NestedAggregationNestedAggregationTypeWithLiterals = NestedAggregationNestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
1551
+ interface AggregationRangeAggregation {
1552
+ /**
1553
+ * List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds.
1554
+ * @maxSize 50
1555
+ */
1556
+ buckets?: RangeAggregationRangeBucket[];
1557
+ }
1558
+ interface AggregationScalarAggregation {
1559
+ /** Operator type for the scalar aggregation. */
1560
+ type?: CommonScalarTypeWithLiterals;
1561
+ }
1562
+ interface AggregationDateHistogramAggregation {
1563
+ /** Interval for date histogram aggregation. */
1564
+ interval?: DateHistogramAggregationIntervalWithLiterals;
1565
+ }
1566
+ declare enum DateHistogramAggregationInterval {
1567
+ UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
1568
+ YEAR = "YEAR",
1569
+ MONTH = "MONTH",
1570
+ WEEK = "WEEK",
1571
+ DAY = "DAY",
1572
+ HOUR = "HOUR",
1573
+ MINUTE = "MINUTE",
1574
+ SECOND = "SECOND"
1575
+ }
1576
+ /** @enumType */
1577
+ type DateHistogramAggregationIntervalWithLiterals = DateHistogramAggregationInterval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
1578
+ interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
1579
+ /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
1580
+ value?: AggregationValueAggregation;
1581
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
1582
+ range?: AggregationRangeAggregation;
1583
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
1584
+ scalar?: AggregationScalarAggregation;
1585
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
1586
+ dateHistogram?: AggregationDateHistogramAggregation;
1587
+ /**
1588
+ * Unique, caller-defined aggregation name, returned in `aggregations.results`.
1589
+ * @maxLength 100
1590
+ */
1591
+ name?: string | null;
1592
+ /** Type of aggregation to perform. The matching aggregation field must be passed. */
1593
+ type?: NestedAggregationNestedAggregationTypeWithLiterals;
1594
+ /**
1595
+ * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
1596
+ * @maxLength 200
1597
+ */
1598
+ fieldPath?: string;
1599
+ }
1600
+ /** @oneof */
1601
+ interface NestedAggregationNestedAggregationItemKindOneOf {
1602
+ /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
1603
+ value?: AggregationValueAggregation;
1604
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
1605
+ range?: AggregationRangeAggregation;
1606
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
1607
+ scalar?: AggregationScalarAggregation;
1608
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
1609
+ dateHistogram?: AggregationDateHistogramAggregation;
1610
+ }
1611
+ declare enum CommonAggregationType {
1612
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
1613
+ /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
1614
+ VALUE = "VALUE",
1615
+ /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
1616
+ RANGE = "RANGE",
1617
+ /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
1618
+ SCALAR = "SCALAR",
1619
+ /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
1620
+ DATE_HISTOGRAM = "DATE_HISTOGRAM",
1621
+ /** Flattened list of aggregations, where each aggregation is nested within previous one. */
1622
+ NESTED = "NESTED"
1623
+ }
1624
+ /** @enumType */
1625
+ type CommonAggregationTypeWithLiterals = CommonAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
1626
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
1627
+ interface AggregationNestedAggregation {
1628
+ /**
1629
+ * Flattened list of aggregations, where each aggregation is nested within previous one.
1630
+ * @minSize 2
1631
+ * @maxSize 3
1632
+ */
1633
+ nestedAggregations?: NestedAggregationNestedAggregationItem[];
1634
+ }
1635
+ interface GroupByAggregation extends GroupByAggregationKindOneOf {
1636
+ /** Value aggregation configuration. */
1637
+ value?: AggregationValueAggregation;
1638
+ /**
1639
+ * Unique, caller-defined aggregation name, returned in `aggregations.results`.
1640
+ * @maxLength 100
1641
+ */
1642
+ name?: string | null;
1643
+ /**
1644
+ * Field to aggregate by.
1645
+ * @maxLength 200
1646
+ */
1647
+ fieldPath?: string;
1648
+ }
1649
+ /** @oneof */
1650
+ interface GroupByAggregationKindOneOf {
1651
+ /** Value aggregation configuration. */
1652
+ value?: AggregationValueAggregation;
1653
+ }
1654
+ interface CommonSearchDetails {
1655
+ /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
1656
+ mode?: SearchDetailsModeWithLiterals;
1657
+ /**
1658
+ * Search term or expression.
1659
+ * @maxLength 100
1660
+ */
1661
+ expression?: string | null;
1662
+ /**
1663
+ * Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
1664
+ * @maxLength 200
1665
+ * @maxSize 20
1666
+ */
1667
+ fields?: string[];
1668
+ /** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
1669
+ fuzzy?: boolean;
1670
+ }
1671
+ declare enum SearchDetailsMode {
1672
+ /** At least one of the search terms must be present. */
1673
+ OR = "OR",
1674
+ /** All search terms must be present. */
1675
+ AND = "AND"
1676
+ }
1677
+ /** @enumType */
1678
+ type SearchDetailsModeWithLiterals = SearchDetailsMode | 'OR' | 'AND';
1679
+ interface PlatformPaging {
1680
+ /**
1681
+ * Number of items to load.
1682
+ * @max 100
1683
+ */
1684
+ limit?: number | null;
1685
+ /** Number of items to skip in the current sort order. */
1686
+ offset?: number | null;
1687
+ }
1688
+ interface DeprecatedSearchVariantsWithOffsetResponse {
1689
+ /** Variants matching the search criteria. */
1690
+ variants?: ReadOnlyVariant[];
1691
+ /** Pagination information for offset-based results. */
1692
+ pagingMetadata?: PagingMetadata;
1693
+ /** Aggregation results for faceted search. */
1694
+ aggregationData?: Aggregation;
1695
+ }
1696
+ interface PagingMetadata {
1697
+ /** Number of items returned in the response. */
1698
+ count?: number | null;
1699
+ /** Offset that was requested. */
1700
+ offset?: number | null;
1701
+ /** Total number of items that match the query. */
1702
+ total?: number | null;
1703
+ /** Flag that indicates the server failed to calculate the `total` field. */
1704
+ tooManyToCount?: boolean | null;
1705
+ }
1706
+ interface MigrateProductVariantsRequest {
1707
+ /** Product containing variants to migrate. */
1708
+ product?: Product;
1709
+ /** Event sequence number for the migration. */
1710
+ eventSequence?: string | null;
1711
+ }
1712
+ interface Product extends ProductTypedPropertiesOneOf {
1713
+ /**
1714
+ * Physical properties.
1715
+ *
1716
+ * Required when `productType: PHYSICAL`.
1717
+ */
1718
+ physicalProperties?: PhysicalProperties;
1719
+ /**
1720
+ * Product ID.
1721
+ * @minLength 1
1722
+ * @maxLength 36
1723
+ * @immutable
1724
+ * @readonly
1725
+ */
1726
+ id?: string | null;
1727
+ /**
1728
+ * Revision number, which increments by 1 each time the product is updated.
1729
+ * To prevent conflicting changes,
1730
+ * the current revision must be passed when updating the product.
1731
+ *
1732
+ * Ignored when creating a product.
1733
+ * @readonly
1734
+ */
1735
+ revision?: string | null;
1736
+ /**
1737
+ * Date and time the product was created.
1738
+ * @readonly
1739
+ */
1740
+ createdDate?: Date | null;
1741
+ /**
1742
+ * Date and time the product was updated.
1743
+ * @readonly
1744
+ */
1745
+ updatedDate?: Date | null;
1746
+ /**
1747
+ * Product name. Translatable.
1748
+ * @minLength 1
1749
+ * @maxLength 80
1750
+ */
1751
+ name?: string | null;
1752
+ /**
1753
+ * Product slug.
1754
+ *
1755
+ * If not provided, the slug is autogenerated based on the product name.
1756
+ * @format URL_SLUG
1757
+ */
1758
+ slug?: string | null;
1759
+ /**
1760
+ * URL to the site's product page.
1761
+ *
1762
+ * > **Note:** Returned only when you pass `"URL"` to the `fields` array in Products API requests.
1763
+ * @readonly
1764
+ */
1765
+ url?: PageUrlV2;
1766
+ /**
1767
+ * Product description using rich content.
1768
+ * > **Note:** Returned only when you pass `"DESCRIPTION"` to the `fields` array in Products API requests.
1769
+ *
1770
+ * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="indent.emoji.divider.codeBlock.file.gallery.giphy.image.table.link.textHighlight.textColor" exampleid="7dc9240e-d548-417a-abcf-0291b68b4303">
1771
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
1772
+ * </widget>
1773
+ */
1774
+ description?: RichContent;
1775
+ /**
1776
+ * Product description in HTML.
1777
+ *
1778
+ * + When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
1779
+ * + `plainDescription` is ignored when value is also passed to the `description` field.
1780
+ * > **Note:** Returned only when you pass `"PLAIN_DESCRIPTION"` to the `fields` array in Products API requests.
1781
+ * @maxLength 16000
1782
+ */
1783
+ plainDescription?: string | null;
1784
+ /**
1785
+ * Whether the product is visible to site visitors on the site.
1786
+ *
1787
+ * Default: `true`
1788
+ */
1789
+ visible?: boolean | null;
1790
+ /**
1791
+ * Whether the product is visible in POS (point of sale).
1792
+ *
1793
+ * Default: `true`
1794
+ * > **Note:** Always `false` for `productType: DIGITAL`.
1795
+ */
1796
+ visibleInPos?: boolean | null;
1797
+ /** Product media items. */
1798
+ media?: Media;
1799
+ /** Product SEO data. */
1800
+ seoData?: SeoSchema;
1801
+ /**
1802
+ * Tax group ID.
1803
+ * @format GUID
1804
+ */
1805
+ taxGroupId?: string | null;
1806
+ /**
1807
+ * Product options. Allows the customer to customize the product. For example, selecting color, size, and more.
1808
+ *
1809
+ * Always generates variants: every variant must have exactly one choice related to each option.
1810
+ * Since options and variants tightly coupled and rely on each other they usually should be provided together in all operations.
1811
+ * @maxSize 6
1812
+ */
1813
+ options?: ConnectedOption[];
1814
+ /**
1815
+ * Product modifiers.
1816
+ *
1817
+ * Allows the customer to customize product, e.g. select Color, Size and so on similarly to `options` but with one main difference - `modifiers` never generate any variants.
1818
+ * @maxSize 10
1819
+ */
1820
+ modifiers?: ConnectedModifier[];
1821
+ /**
1822
+ * Product brand.
1823
+ *
1824
+ * + Pass `brand.name` to add a new brand while creating a product.
1825
+ * + Pass an existing brand's `id` to assign that brand to the product.
1826
+ */
1827
+ brand?: Brand;
1828
+ /**
1829
+ * Product info section.
1830
+ *
1831
+ * + Pass `infoSection.uniqueName`, `infoSection.title`, and `infoSection.description` to add a new info section while creating a product.
1832
+ * + Pass an existing info section's `id` or `uniqueName` to assign that info section to the product.
1833
+ * @maxSize 10
1834
+ */
1835
+ infoSections?: InfoSection[];
1836
+ /**
1837
+ * Product ribbon.
1838
+ *
1839
+ * + Pass `ribbon.name` to add a new ribbon while creating a product.
1840
+ * + Pass an existing ribbon's `id` or `name` to assign that ribbon to the product.
1841
+ */
1842
+ ribbon?: Ribbon;
1843
+ /**
1844
+ * List of categories that directly contain this product.
1845
+ *
1846
+ * Updated automatically when a product is added/removed from a category, when an item is moved within a category, or when a category is deleted.
1847
+ * > **Note:** Returned only when you pass `"DIRECT_CATEGORIES_INFO"` to the `fields` array in Products API requests.
1848
+ * @readonly
1849
+ */
1850
+ directCategoriesInfo?: ProductCategoriesInfo;
1851
+ /**
1852
+ * List of categories that directly contain this product, as well as their parent categories.
1853
+ * > **Note:** Returned only when you pass `"ALL_CATEGORIES_INFO"` to the `fields` array in Products API requests.
1854
+ * @readonly
1855
+ */
1856
+ allCategoriesInfo?: ProductCategoriesInfo;
1857
+ /**
1858
+ * The ID of the product's primary direct category, which defines the product’s breadcrumbs path. For example, if the product's main category is "T-Shirts" (which is a subcategory of "Clothing"), the breadcrumbs path will be "Clothing > T-Shirts".
1859
+ * @format GUID
1860
+ */
1861
+ mainCategoryId?: string | null;
1862
+ /**
1863
+ * Product cost range - minimum and maximum costs of all product variants.
1864
+ *
1865
+ * > **Note:** Returned only when the following conditions are met:
1866
+ * > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests.
1867
+ * > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
1868
+ * @readonly
1869
+ */
1870
+ costRange?: PriceRange;
1871
+ /**
1872
+ * Product inventory info.
1873
+ * @readonly
1874
+ */
1875
+ inventory?: Inventory;
1876
+ /**
1877
+ * Product type.
1878
+ *
1879
+ * When passing `productType: PHYSICAL`, you must also pass `physicalProperties`.
1880
+ * @immutable
1881
+ */
1882
+ productType?: ProductTypeWithLiterals;
1883
+ /**
1884
+ * A unique human-friendly identifier for the product.
1885
+ * Unlike the product ID, the handle can be set by the user to ensure consistency across multiple platforms.
1886
+ * In case handle wasn't given, the handle will be automatically generated.
1887
+ * @minLength 1
1888
+ * @maxLength 100
1889
+ * @readonly
1890
+ */
1891
+ handle?: string | null;
1892
+ /**
1893
+ * Currency used for the pricing of this product, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
1894
+ *
1895
+ * Defaults to the currency defined in the site settings, unless specified in `x-wix-currency` header.
1896
+ * > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
1897
+ * @format CURRENCY
1898
+ * @readonly
1899
+ */
1900
+ currency?: string | null;
1901
+ /**
1902
+ * Breadcrumbs of the `mainCategoryId`. Used to navigate to parent categories.
1903
+ * > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Products API requests.
1904
+ * @readonly
1905
+ */
1906
+ breadcrumbsInfo?: BreadcrumbsInfo;
1907
+ /**
1908
+ * Product actualPrice range - minimum and maximum prices of all product variants.
1909
+ * @readonly
1910
+ */
1911
+ actualPriceRange?: PriceRange;
1912
+ /**
1913
+ * Product compareAtPrice range - minimum and maximum compare at prices of all product variants.
1914
+ * @readonly
1915
+ */
1916
+ compareAtPriceRange?: PriceRange;
1917
+ /**
1918
+ * Product variants. Each variant must reference all product options via its `choices` array.
1919
+ * Each choice references an option using `optionChoiceNames` for all requests.
1920
+ */
1921
+ variantsInfo?: VariantsInfo;
1922
+ /**
1923
+ * Custom extended fields for the product object.
1924
+ *
1925
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
1926
+ */
1927
+ extendedFields?: ExtendedFields;
1928
+ /** Product subscriptions. */
1929
+ subscriptionDetails?: SubscriptionDetails;
1930
+ /**
1931
+ * The total number of variants for the product.
1932
+ * @readonly
1933
+ */
1934
+ variantSummary?: VariantSummary;
1935
+ }
1936
+ /** @oneof */
1937
+ interface ProductTypedPropertiesOneOf {
1938
+ /**
1939
+ * Physical properties.
1940
+ *
1941
+ * Required when `productType: PHYSICAL`.
1942
+ */
1943
+ physicalProperties?: PhysicalProperties;
1944
+ }
1945
+ interface PageUrlV2 {
1946
+ /** The relative path for the page within the site. For example, `/product-page/a-product`. */
1947
+ relativePath?: string;
1948
+ /** The page's full URL. For example, `https://mysite.com/product-page/a-product`. */
1949
+ url?: string | null;
1950
+ }
1951
+ interface RichContent {
1952
+ /** Node objects representing a rich content document. */
1953
+ nodes?: Node[];
1954
+ /** Object metadata. */
1955
+ metadata?: Metadata;
1956
+ /** Global styling for header, paragraph, block quote, and code block nodes in the object. */
1957
+ documentStyle?: DocumentStyle;
1958
+ }
1959
+ interface Node extends NodeDataOneOf {
1960
+ /** Data for a button node. */
1961
+ buttonData?: ButtonData;
1962
+ /** Data for a code block node. */
1963
+ codeBlockData?: CodeBlockData;
1964
+ /** Data for a divider node. */
1965
+ dividerData?: DividerData;
1966
+ /** Data for a file node. */
1967
+ fileData?: FileData;
1968
+ /** Data for a gallery node. */
1969
+ galleryData?: GalleryData;
1970
+ /** Data for a GIF node. */
1971
+ gifData?: GIFData;
1972
+ /** Data for a heading node. */
1973
+ headingData?: HeadingData;
1974
+ /** Data for an embedded HTML node. */
1975
+ htmlData?: HTMLData;
1976
+ /** Data for an image node. */
1977
+ imageData?: ImageData;
1978
+ /** Data for a link preview node. */
1979
+ linkPreviewData?: LinkPreviewData;
1980
+ /** @deprecated */
1981
+ mapData?: MapData;
1982
+ /** Data for a paragraph node. */
1983
+ paragraphData?: ParagraphData;
1984
+ /** Data for a poll node. */
1985
+ pollData?: PollData;
1986
+ /** Data for a text node. Used to apply decorations to text. */
1987
+ textData?: TextData;
1988
+ /** Data for an app embed node. */
1989
+ appEmbedData?: AppEmbedData;
1990
+ /** Data for a video node. */
1991
+ videoData?: VideoData;
1992
+ /** Data for an oEmbed node. */
1993
+ embedData?: EmbedData;
1994
+ /** Data for a collapsible list node. */
1995
+ collapsibleListData?: CollapsibleListData;
1996
+ /** Data for a table node. */
1997
+ tableData?: TableData;
1998
+ /** Data for a table cell node. */
1999
+ tableCellData?: TableCellData;
2000
+ /** Data for a custom external node. */
2001
+ externalData?: Record<string, any> | null;
2002
+ /** Data for an audio node. */
2003
+ audioData?: AudioData;
2004
+ /** Data for an ordered list node. */
2005
+ orderedListData?: OrderedListData;
2006
+ /** Data for a bulleted list node. */
2007
+ bulletedListData?: BulletedListData;
2008
+ /** Data for a block quote node. */
2009
+ blockquoteData?: BlockquoteData;
2010
+ /** Data for a caption node. */
2011
+ captionData?: CaptionData;
2012
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
2013
+ layoutCellData?: LayoutCellData;
2014
+ /** Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format. */
2015
+ type?: NodeTypeWithLiterals;
2016
+ /** Node ID. */
2017
+ id?: string;
2018
+ /** A list of child nodes. */
2019
+ nodes?: Node[];
2020
+ /** Padding and background color styling for the node. */
2021
+ style?: NodeStyle;
2022
+ }
2023
+ /** @oneof */
2024
+ interface NodeDataOneOf {
2025
+ /** Data for a button node. */
2026
+ buttonData?: ButtonData;
2027
+ /** Data for a code block node. */
2028
+ codeBlockData?: CodeBlockData;
2029
+ /** Data for a divider node. */
2030
+ dividerData?: DividerData;
2031
+ /** Data for a file node. */
2032
+ fileData?: FileData;
2033
+ /** Data for a gallery node. */
2034
+ galleryData?: GalleryData;
2035
+ /** Data for a GIF node. */
2036
+ gifData?: GIFData;
2037
+ /** Data for a heading node. */
2038
+ headingData?: HeadingData;
2039
+ /** Data for an embedded HTML node. */
2040
+ htmlData?: HTMLData;
2041
+ /** Data for an image node. */
2042
+ imageData?: ImageData;
2043
+ /** Data for a link preview node. */
2044
+ linkPreviewData?: LinkPreviewData;
2045
+ /** @deprecated */
2046
+ mapData?: MapData;
2047
+ /** Data for a paragraph node. */
2048
+ paragraphData?: ParagraphData;
2049
+ /** Data for a poll node. */
2050
+ pollData?: PollData;
2051
+ /** Data for a text node. Used to apply decorations to text. */
2052
+ textData?: TextData;
2053
+ /** Data for an app embed node. */
2054
+ appEmbedData?: AppEmbedData;
2055
+ /** Data for a video node. */
2056
+ videoData?: VideoData;
2057
+ /** Data for an oEmbed node. */
2058
+ embedData?: EmbedData;
2059
+ /** Data for a collapsible list node. */
2060
+ collapsibleListData?: CollapsibleListData;
2061
+ /** Data for a table node. */
2062
+ tableData?: TableData;
2063
+ /** Data for a table cell node. */
2064
+ tableCellData?: TableCellData;
2065
+ /** Data for a custom external node. */
2066
+ externalData?: Record<string, any> | null;
2067
+ /** Data for an audio node. */
2068
+ audioData?: AudioData;
2069
+ /** Data for an ordered list node. */
2070
+ orderedListData?: OrderedListData;
2071
+ /** Data for a bulleted list node. */
2072
+ bulletedListData?: BulletedListData;
2073
+ /** Data for a block quote node. */
2074
+ blockquoteData?: BlockquoteData;
2075
+ /** Data for a caption node. */
2076
+ captionData?: CaptionData;
2077
+ /** LayoutData layout_data = 31; // Data for a layout node. Reserved for future use. */
2078
+ layoutCellData?: LayoutCellData;
2079
+ }
2080
+ declare enum NodeType {
2081
+ PARAGRAPH = "PARAGRAPH",
2082
+ TEXT = "TEXT",
2083
+ HEADING = "HEADING",
2084
+ BULLETED_LIST = "BULLETED_LIST",
2085
+ ORDERED_LIST = "ORDERED_LIST",
2086
+ LIST_ITEM = "LIST_ITEM",
2087
+ BLOCKQUOTE = "BLOCKQUOTE",
2088
+ CODE_BLOCK = "CODE_BLOCK",
2089
+ VIDEO = "VIDEO",
2090
+ DIVIDER = "DIVIDER",
2091
+ FILE = "FILE",
2092
+ GALLERY = "GALLERY",
2093
+ GIF = "GIF",
2094
+ HTML = "HTML",
2095
+ IMAGE = "IMAGE",
2096
+ LINK_PREVIEW = "LINK_PREVIEW",
2097
+ /** @deprecated */
2098
+ MAP = "MAP",
2099
+ POLL = "POLL",
2100
+ APP_EMBED = "APP_EMBED",
2101
+ BUTTON = "BUTTON",
2102
+ COLLAPSIBLE_LIST = "COLLAPSIBLE_LIST",
2103
+ TABLE = "TABLE",
2104
+ EMBED = "EMBED",
2105
+ COLLAPSIBLE_ITEM = "COLLAPSIBLE_ITEM",
2106
+ COLLAPSIBLE_ITEM_TITLE = "COLLAPSIBLE_ITEM_TITLE",
2107
+ COLLAPSIBLE_ITEM_BODY = "COLLAPSIBLE_ITEM_BODY",
2108
+ TABLE_CELL = "TABLE_CELL",
2109
+ TABLE_ROW = "TABLE_ROW",
2110
+ EXTERNAL = "EXTERNAL",
2111
+ AUDIO = "AUDIO",
2112
+ CAPTION = "CAPTION",
2113
+ LAYOUT = "LAYOUT",
2114
+ LAYOUT_CELL = "LAYOUT_CELL"
2115
+ }
2116
+ /** @enumType */
2117
+ 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';
2118
+ interface NodeStyle {
2119
+ /** The top padding value in pixels. */
2120
+ paddingTop?: string | null;
2121
+ /** The bottom padding value in pixels. */
2122
+ paddingBottom?: string | null;
2123
+ /** The background color as a hexadecimal value. */
2124
+ backgroundColor?: string | null;
2125
+ }
2126
+ interface ButtonData {
2127
+ /** Styling for the button's container. */
2128
+ containerData?: PluginContainerData;
2129
+ /** The button type. */
2130
+ type?: ButtonDataTypeWithLiterals;
2131
+ /** Styling for the button. */
2132
+ styles?: Styles;
2133
+ /** The text to display on the button. */
2134
+ text?: string | null;
2135
+ /** Button link details. */
2136
+ link?: Link;
2137
+ }
2138
+ interface Border {
2139
+ /**
2140
+ * Deprecated: Use `borderWidth` in `styles` instead.
2141
+ * @deprecated
2142
+ */
2143
+ width?: number | null;
2144
+ /**
2145
+ * Deprecated: Use `borderRadius` in `styles` instead.
2146
+ * @deprecated
2147
+ */
2148
+ radius?: number | null;
2149
+ }
2150
+ interface Colors {
2151
+ /**
2152
+ * Deprecated: Use `textColor` in `styles` instead.
2153
+ * @deprecated
2154
+ */
2155
+ text?: string | null;
2156
+ /**
2157
+ * Deprecated: Use `borderColor` in `styles` instead.
2158
+ * @deprecated
2159
+ */
2160
+ border?: string | null;
2161
+ /**
2162
+ * Deprecated: Use `backgroundColor` in `styles` instead.
2163
+ * @deprecated
2164
+ */
2165
+ background?: string | null;
2166
+ }
2167
+ interface PluginContainerData {
2168
+ /** The width of the node when it's displayed. */
2169
+ width?: PluginContainerDataWidth;
2170
+ /** The node's alignment within its container. */
2171
+ alignment?: PluginContainerDataAlignmentWithLiterals;
2172
+ /** Spoiler cover settings for the node. */
2173
+ spoiler?: Spoiler;
2174
+ /** The height of the node when it's displayed. */
2175
+ height?: Height;
2176
+ /** 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`. */
2177
+ textWrap?: boolean | null;
2178
+ }
2179
+ declare enum WidthType {
2180
+ /** Width matches the content width */
2181
+ CONTENT = "CONTENT",
2182
+ /** Small Width */
2183
+ SMALL = "SMALL",
2184
+ /** Width will match the original asset width */
2185
+ ORIGINAL = "ORIGINAL",
2186
+ /** coast-to-coast display */
2187
+ FULL_WIDTH = "FULL_WIDTH"
2188
+ }
2189
+ /** @enumType */
2190
+ type WidthTypeWithLiterals = WidthType | 'CONTENT' | 'SMALL' | 'ORIGINAL' | 'FULL_WIDTH';
2191
+ interface PluginContainerDataWidth extends PluginContainerDataWidthDataOneOf {
2192
+ /**
2193
+ * One of the following predefined width options:
2194
+ * `CONTENT`: The width of the container matches the content width.
2195
+ * `SMALL`: A small width.
2196
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
2197
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
2198
+ */
2199
+ size?: WidthTypeWithLiterals;
2200
+ /** A custom width value in pixels. */
2201
+ custom?: string | null;
2202
+ }
2203
+ /** @oneof */
2204
+ interface PluginContainerDataWidthDataOneOf {
2205
+ /**
2206
+ * One of the following predefined width options:
2207
+ * `CONTENT`: The width of the container matches the content width.
2208
+ * `SMALL`: A small width.
2209
+ * `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width.
2210
+ * `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
2211
+ */
2212
+ size?: WidthTypeWithLiterals;
2213
+ /** A custom width value in pixels. */
2214
+ custom?: string | null;
2215
+ }
2216
+ declare enum PluginContainerDataAlignment {
2217
+ /** Center Alignment */
2218
+ CENTER = "CENTER",
2219
+ /** Left Alignment */
2220
+ LEFT = "LEFT",
2221
+ /** Right Alignment */
2222
+ RIGHT = "RIGHT"
2223
+ }
2224
+ /** @enumType */
2225
+ type PluginContainerDataAlignmentWithLiterals = PluginContainerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
2226
+ interface Spoiler {
2227
+ /** Sets whether the spoiler cover is enabled for this node. Defaults to `false`. */
2228
+ enabled?: boolean | null;
2229
+ /** The description displayed on top of the spoiler cover. */
2230
+ description?: string | null;
2231
+ /** The text for the button used to remove the spoiler cover. */
2232
+ buttonText?: string | null;
2233
+ }
2234
+ interface Height {
2235
+ /** A custom height value in pixels. */
2236
+ custom?: string | null;
2237
+ }
2238
+ declare enum ButtonDataType {
2239
+ /** Regular link button */
2240
+ LINK = "LINK",
2241
+ /** Triggers custom action that is defined in plugin configuration by the consumer */
2242
+ ACTION = "ACTION"
2243
+ }
2244
+ /** @enumType */
2245
+ type ButtonDataTypeWithLiterals = ButtonDataType | 'LINK' | 'ACTION';
2246
+ interface Styles {
2247
+ /**
2248
+ * Deprecated: Use `borderWidth` and `borderRadius` instead.
2249
+ * @deprecated
2250
+ */
2251
+ border?: Border;
2252
+ /**
2253
+ * Deprecated: Use `textColor`, `borderColor` and `backgroundColor` instead.
2254
+ * @deprecated
2255
+ */
2256
+ colors?: Colors;
2257
+ /** Border width in pixels. */
2258
+ borderWidth?: number | null;
2259
+ /**
2260
+ * Deprecated: Use `borderWidth` for normal/hover states instead.
2261
+ * @deprecated
2262
+ */
2263
+ borderWidthHover?: number | null;
2264
+ /** Border radius in pixels. */
2265
+ borderRadius?: number | null;
2266
+ /**
2267
+ * Border color as a hexadecimal value.
2268
+ * @format COLOR_HEX
2269
+ */
2270
+ borderColor?: string | null;
2271
+ /**
2272
+ * Border color as a hexadecimal value (hover state).
2273
+ * @format COLOR_HEX
2274
+ */
2275
+ borderColorHover?: string | null;
2276
+ /**
2277
+ * Text color as a hexadecimal value.
2278
+ * @format COLOR_HEX
2279
+ */
2280
+ textColor?: string | null;
2281
+ /**
2282
+ * Text color as a hexadecimal value (hover state).
2283
+ * @format COLOR_HEX
2284
+ */
2285
+ textColorHover?: string | null;
2286
+ /**
2287
+ * Background color as a hexadecimal value.
2288
+ * @format COLOR_HEX
2289
+ */
2290
+ backgroundColor?: string | null;
2291
+ /**
2292
+ * Background color as a hexadecimal value (hover state).
2293
+ * @format COLOR_HEX
2294
+ */
2295
+ backgroundColorHover?: string | null;
2296
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
2297
+ buttonSize?: string | null;
2298
+ }
2299
+ interface Link extends LinkDataOneOf {
2300
+ /** The absolute URL for the linked document. */
2301
+ url?: string;
2302
+ /** The target node's ID. Used for linking to another node in this object. */
2303
+ anchor?: string;
2304
+ /**
2305
+ * he HTML `target` attribute value for the link. This property defines where the linked document opens as follows:
2306
+ * `SELF` - Default. Opens the linked document in the same frame as the link.
2307
+ * `BLANK` - Opens the linked document in a new browser tab or window.
2308
+ * `PARENT` - Opens the linked document in the link's parent frame.
2309
+ * `TOP` - Opens the linked document in the full body of the link's browser tab or window.
2310
+ */
2311
+ target?: TargetWithLiterals;
2312
+ /** The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document. */
2313
+ rel?: Rel;
2314
+ /** A serialized object used for a custom or external link panel. */
2315
+ customData?: string | null;
2316
+ }
2317
+ /** @oneof */
2318
+ interface LinkDataOneOf {
2319
+ /** The absolute URL for the linked document. */
2320
+ url?: string;
2321
+ /** The target node's ID. Used for linking to another node in this object. */
2322
+ anchor?: string;
2323
+ }
2324
+ declare enum Target {
2325
+ /** Opens the linked document in the same frame as it was clicked (this is default) */
2326
+ SELF = "SELF",
2327
+ /** Opens the linked document in a new window or tab */
2328
+ BLANK = "BLANK",
2329
+ /** Opens the linked document in the parent frame */
2330
+ PARENT = "PARENT",
2331
+ /** Opens the linked document in the full body of the window */
2332
+ TOP = "TOP"
2333
+ }
2334
+ /** @enumType */
2335
+ type TargetWithLiterals = Target | 'SELF' | 'BLANK' | 'PARENT' | 'TOP';
2336
+ interface Rel {
2337
+ /** Indicates to search engine crawlers not to follow the link. Defaults to `false`. */
2338
+ nofollow?: boolean | null;
2339
+ /** Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`. */
2340
+ sponsored?: boolean | null;
2341
+ /** Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`. */
2342
+ ugc?: boolean | null;
2343
+ /** Indicates that this link protect referral information from being passed to the target website. */
2344
+ noreferrer?: boolean | null;
2345
+ }
2346
+ interface CodeBlockData {
2347
+ /** Styling for the code block's text. */
2348
+ textStyle?: TextStyle;
2349
+ }
2350
+ interface TextStyle {
2351
+ /** Text alignment. Defaults to `AUTO`. */
2352
+ textAlignment?: TextAlignmentWithLiterals;
2353
+ /** 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. */
2354
+ lineHeight?: string | null;
2355
+ }
2356
+ declare enum TextAlignment {
2357
+ /** browser default, eqivalent to `initial` */
2358
+ AUTO = "AUTO",
2359
+ /** Left align */
2360
+ LEFT = "LEFT",
2361
+ /** Right align */
2362
+ RIGHT = "RIGHT",
2363
+ /** Center align */
2364
+ CENTER = "CENTER",
2365
+ /** Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line */
2366
+ JUSTIFY = "JUSTIFY"
2367
+ }
2368
+ /** @enumType */
2369
+ type TextAlignmentWithLiterals = TextAlignment | 'AUTO' | 'LEFT' | 'RIGHT' | 'CENTER' | 'JUSTIFY';
2370
+ interface DividerData {
2371
+ /** Styling for the divider's container. */
2372
+ containerData?: PluginContainerData;
2373
+ /** Divider line style. */
2374
+ lineStyle?: LineStyleWithLiterals;
2375
+ /** Divider width. */
2376
+ width?: WidthWithLiterals;
2377
+ /** Divider alignment. */
2378
+ alignment?: DividerDataAlignmentWithLiterals;
2379
+ }
2380
+ declare enum LineStyle {
2381
+ /** Single Line */
2382
+ SINGLE = "SINGLE",
2383
+ /** Double Line */
2384
+ DOUBLE = "DOUBLE",
2385
+ /** Dashed Line */
2386
+ DASHED = "DASHED",
2387
+ /** Dotted Line */
2388
+ DOTTED = "DOTTED"
2389
+ }
2390
+ /** @enumType */
2391
+ type LineStyleWithLiterals = LineStyle | 'SINGLE' | 'DOUBLE' | 'DASHED' | 'DOTTED';
2392
+ declare enum Width {
2393
+ /** Large line */
2394
+ LARGE = "LARGE",
2395
+ /** Medium line */
2396
+ MEDIUM = "MEDIUM",
2397
+ /** Small line */
2398
+ SMALL = "SMALL"
2399
+ }
2400
+ /** @enumType */
2401
+ type WidthWithLiterals = Width | 'LARGE' | 'MEDIUM' | 'SMALL';
2402
+ declare enum DividerDataAlignment {
2403
+ /** Center alignment */
2404
+ CENTER = "CENTER",
2405
+ /** Left alignment */
2406
+ LEFT = "LEFT",
2407
+ /** Right alignment */
2408
+ RIGHT = "RIGHT"
2409
+ }
2410
+ /** @enumType */
2411
+ type DividerDataAlignmentWithLiterals = DividerDataAlignment | 'CENTER' | 'LEFT' | 'RIGHT';
2412
+ interface FileData {
2413
+ /** Styling for the file's container. */
2414
+ containerData?: PluginContainerData;
2415
+ /** The source for the file's data. */
2416
+ src?: FileSource;
2417
+ /** File name. */
2418
+ name?: string | null;
2419
+ /** File type. */
2420
+ type?: string | null;
2421
+ /**
2422
+ * Use `sizeInKb` instead.
2423
+ * @deprecated
2424
+ */
2425
+ size?: number | null;
2426
+ /** Settings for PDF files. */
2427
+ pdfSettings?: PDFSettings;
2428
+ /** File MIME type. */
2429
+ mimeType?: string | null;
2430
+ /** File path. */
2431
+ path?: string | null;
2432
+ /** File size in KB. */
2433
+ sizeInKb?: string | null;
2434
+ }
2435
+ declare enum ViewMode {
2436
+ /** No PDF view */
2437
+ NONE = "NONE",
2438
+ /** Full PDF view */
2439
+ FULL = "FULL",
2440
+ /** Mini PDF view */
2441
+ MINI = "MINI"
2442
+ }
2443
+ /** @enumType */
2444
+ type ViewModeWithLiterals = ViewMode | 'NONE' | 'FULL' | 'MINI';
2445
+ interface FileSource extends FileSourceDataOneOf {
2446
+ /** The absolute URL for the file's source. */
2447
+ url?: string | null;
2448
+ /**
2449
+ * Custom ID. Use `id` instead.
2450
+ * @deprecated
2451
+ */
2452
+ custom?: string | null;
2453
+ /** An ID that's resolved to a URL by a resolver function. */
2454
+ id?: string | null;
2455
+ /** Indicates whether the file's source is private. Defaults to `false`. */
2456
+ private?: boolean | null;
2457
+ }
2458
+ /** @oneof */
2459
+ interface FileSourceDataOneOf {
2460
+ /** The absolute URL for the file's source. */
2461
+ url?: string | null;
2462
+ /**
2463
+ * Custom ID. Use `id` instead.
2464
+ * @deprecated
2465
+ */
2466
+ custom?: string | null;
2467
+ /** An ID that's resolved to a URL by a resolver function. */
2468
+ id?: string | null;
2469
+ }
2470
+ interface PDFSettings {
2471
+ /**
2472
+ * PDF view mode. One of the following:
2473
+ * `NONE` : The PDF isn't displayed.
2474
+ * `FULL` : A full page view of the PDF is displayed.
2475
+ * `MINI` : A mini view of the PDF is displayed.
2476
+ */
2477
+ viewMode?: ViewModeWithLiterals;
2478
+ /** Sets whether the PDF download button is disabled. Defaults to `false`. */
2479
+ disableDownload?: boolean | null;
2480
+ /** Sets whether the PDF print button is disabled. Defaults to `false`. */
2481
+ disablePrint?: boolean | null;
2482
+ }
2483
+ interface GalleryData {
2484
+ /** Styling for the gallery's container. */
2485
+ containerData?: PluginContainerData;
2486
+ /** The items in the gallery. */
2487
+ items?: Item[];
2488
+ /** Options for defining the gallery's appearance. */
2489
+ options?: GalleryOptions;
2490
+ /** Sets whether the gallery's expand button is disabled. Defaults to `false`. */
2491
+ disableExpand?: boolean | null;
2492
+ /** Sets whether the gallery's download button is disabled. Defaults to `false`. */
2493
+ disableDownload?: boolean | null;
2494
+ }
2495
+ interface V1Media {
2496
+ /** The source for the media's data. */
2497
+ src?: FileSource;
2498
+ /** Media width in pixels. */
2499
+ width?: number | null;
2500
+ /** Media height in pixels. */
2501
+ height?: number | null;
2502
+ /** Media duration in seconds. Only relevant for audio and video files. */
2503
+ duration?: number | null;
2504
+ }
2505
+ interface ItemImage {
2506
+ /** Image file details. */
2507
+ media?: V1Media;
2508
+ /** Link details for images that are links. */
2509
+ link?: Link;
2510
+ }
2511
+ interface Video {
2512
+ /** Video file details. */
2513
+ media?: V1Media;
2514
+ /** Video thumbnail file details. */
2515
+ thumbnail?: V1Media;
2516
+ }
2517
+ interface Item extends ItemDataOneOf {
2518
+ /** An image item. */
2519
+ image?: ItemImage;
2520
+ /** A video item. */
2521
+ video?: Video;
2522
+ /** Item title. */
2523
+ title?: string | null;
2524
+ /** Item's alternative text. */
2525
+ altText?: string | null;
2526
+ }
2527
+ /** @oneof */
2528
+ interface ItemDataOneOf {
2529
+ /** An image item. */
2530
+ image?: ItemImage;
2531
+ /** A video item. */
2532
+ video?: Video;
2533
+ }
2534
+ interface GalleryOptions {
2535
+ /** Gallery layout. */
2536
+ layout?: GalleryOptionsLayout;
2537
+ /** Styling for gallery items. */
2538
+ item?: ItemStyle;
2539
+ /** Styling for gallery thumbnail images. */
2540
+ thumbnails?: Thumbnails;
2541
+ }
2542
+ declare enum LayoutType {
2543
+ /** Collage type */
2544
+ COLLAGE = "COLLAGE",
2545
+ /** Masonry type */
2546
+ MASONRY = "MASONRY",
2547
+ /** Grid type */
2548
+ GRID = "GRID",
2549
+ /** Thumbnail type */
2550
+ THUMBNAIL = "THUMBNAIL",
2551
+ /** Slider type */
2552
+ SLIDER = "SLIDER",
2553
+ /** Slideshow type */
2554
+ SLIDESHOW = "SLIDESHOW",
2555
+ /** Panorama type */
2556
+ PANORAMA = "PANORAMA",
2557
+ /** Column type */
2558
+ COLUMN = "COLUMN",
2559
+ /** Magic type */
2560
+ MAGIC = "MAGIC",
2561
+ /** Fullsize images type */
2562
+ FULLSIZE = "FULLSIZE"
2563
+ }
2564
+ /** @enumType */
2565
+ type LayoutTypeWithLiterals = LayoutType | 'COLLAGE' | 'MASONRY' | 'GRID' | 'THUMBNAIL' | 'SLIDER' | 'SLIDESHOW' | 'PANORAMA' | 'COLUMN' | 'MAGIC' | 'FULLSIZE';
2566
+ declare enum Orientation {
2567
+ /** Rows Orientation */
2568
+ ROWS = "ROWS",
2569
+ /** Columns Orientation */
2570
+ COLUMNS = "COLUMNS"
2571
+ }
2572
+ /** @enumType */
2573
+ type OrientationWithLiterals = Orientation | 'ROWS' | 'COLUMNS';
2574
+ declare enum Crop {
2575
+ /** Crop to fill */
2576
+ FILL = "FILL",
2577
+ /** Crop to fit */
2578
+ FIT = "FIT"
2579
+ }
2580
+ /** @enumType */
2581
+ type CropWithLiterals = Crop | 'FILL' | 'FIT';
2582
+ declare enum ThumbnailsAlignment {
2583
+ /** Top alignment */
2584
+ TOP = "TOP",
2585
+ /** Right alignment */
2586
+ RIGHT = "RIGHT",
2587
+ /** Bottom alignment */
2588
+ BOTTOM = "BOTTOM",
2589
+ /** Left alignment */
2590
+ LEFT = "LEFT",
2591
+ /** No thumbnail */
2592
+ NONE = "NONE"
2593
+ }
2594
+ /** @enumType */
2595
+ type ThumbnailsAlignmentWithLiterals = ThumbnailsAlignment | 'TOP' | 'RIGHT' | 'BOTTOM' | 'LEFT' | 'NONE';
2596
+ interface GalleryOptionsLayout {
2597
+ /** Gallery layout type. */
2598
+ type?: LayoutTypeWithLiterals;
2599
+ /** Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`. */
2600
+ horizontalScroll?: boolean | null;
2601
+ /** Gallery orientation. */
2602
+ orientation?: OrientationWithLiterals;
2603
+ /** The number of columns to display on full size screens. */
2604
+ numberOfColumns?: number | null;
2605
+ /** The number of columns to display on mobile screens. */
2606
+ mobileNumberOfColumns?: number | null;
2607
+ }
2608
+ interface ItemStyle {
2609
+ /** Desirable dimension for each item in pixels (behvaior changes according to gallery type) */
2610
+ targetSize?: number | null;
2611
+ /** Item ratio */
2612
+ ratio?: number | null;
2613
+ /** Sets how item images are cropped. */
2614
+ crop?: CropWithLiterals;
2615
+ /** The spacing between items in pixels. */
2616
+ spacing?: number | null;
2617
+ }
2618
+ interface Thumbnails {
2619
+ /** Thumbnail alignment. */
2620
+ placement?: ThumbnailsAlignmentWithLiterals;
2621
+ /** Spacing between thumbnails in pixels. */
2622
+ spacing?: number | null;
2623
+ }
2624
+ interface GIFData {
2625
+ /** Styling for the GIF's container. */
2626
+ containerData?: PluginContainerData;
2627
+ /** The source of the full size GIF. */
2628
+ original?: GIF;
2629
+ /** The source of the downsized GIF. */
2630
+ downsized?: GIF;
2631
+ /** Height in pixels. */
2632
+ height?: number;
2633
+ /** Width in pixels. */
2634
+ width?: number;
2635
+ /** Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`. */
2636
+ gifType?: GIFTypeWithLiterals;
2637
+ }
2638
+ interface GIF {
2639
+ /**
2640
+ * GIF format URL.
2641
+ * @format WEB_URL
2642
+ */
2643
+ gif?: string | null;
2644
+ /**
2645
+ * MP4 format URL.
2646
+ * @format WEB_URL
2647
+ */
2648
+ mp4?: string | null;
2649
+ /**
2650
+ * Thumbnail URL.
2651
+ * @format WEB_URL
2652
+ */
2653
+ still?: string | null;
2654
+ }
2655
+ declare enum GIFType {
2656
+ NORMAL = "NORMAL",
2657
+ STICKER = "STICKER"
2658
+ }
2659
+ /** @enumType */
2660
+ type GIFTypeWithLiterals = GIFType | 'NORMAL' | 'STICKER';
2661
+ interface HeadingData {
2662
+ /** Heading level from 1-6. */
2663
+ level?: number;
2664
+ /** Styling for the heading text. */
2665
+ textStyle?: TextStyle;
2666
+ /** Indentation level from 1-4. */
2667
+ indentation?: number | null;
2668
+ }
2669
+ interface HTMLData extends HTMLDataDataOneOf {
2670
+ /** The URL for the HTML code for the node. */
2671
+ url?: string;
2672
+ /** The HTML code for the node. */
2673
+ html?: string;
2674
+ /**
2675
+ * Whether this is an AdSense element. Use `source` instead.
2676
+ * @deprecated
2677
+ */
2678
+ isAdsense?: boolean | null;
2679
+ /** Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`. */
2680
+ containerData?: PluginContainerData;
2681
+ /** The type of HTML code. */
2682
+ source?: SourceWithLiterals;
2683
+ /** If container height is aligned with its content height. Defaults to `true`. */
2684
+ autoHeight?: boolean | null;
2685
+ }
2686
+ /** @oneof */
2687
+ interface HTMLDataDataOneOf {
2688
+ /** The URL for the HTML code for the node. */
2689
+ url?: string;
2690
+ /** The HTML code for the node. */
2691
+ html?: string;
2692
+ /**
2693
+ * Whether this is an AdSense element. Use `source` instead.
2694
+ * @deprecated
2695
+ */
2696
+ isAdsense?: boolean | null;
2697
+ }
2698
+ declare enum Source {
2699
+ HTML = "HTML",
2700
+ ADSENSE = "ADSENSE"
2701
+ }
2702
+ /** @enumType */
2703
+ type SourceWithLiterals = Source | 'HTML' | 'ADSENSE';
2704
+ interface ImageData {
2705
+ /** Styling for the image's container. */
2706
+ containerData?: PluginContainerData;
2707
+ /** Image file details. */
2708
+ image?: V1Media;
2709
+ /** Link details for images that are links. */
2710
+ link?: Link;
2711
+ /** Sets whether the image expands to full screen when clicked. Defaults to `false`. */
2712
+ disableExpand?: boolean | null;
2713
+ /** Image's alternative text. */
2714
+ altText?: string | null;
2715
+ /**
2716
+ * Deprecated: use Caption node instead.
2717
+ * @deprecated
2718
+ */
2719
+ caption?: string | null;
2720
+ /** Sets whether the image's download button is disabled. Defaults to `false`. */
2721
+ disableDownload?: boolean | null;
2722
+ /** Sets whether the image is decorative and does not need an explanation. Defaults to `false`. */
2723
+ decorative?: boolean | null;
2724
+ /** Styling for the image. */
2725
+ styles?: ImageDataStyles;
2726
+ }
2727
+ interface StylesBorder {
2728
+ /** Border width in pixels. */
2729
+ width?: number | null;
2730
+ /**
2731
+ * Border color as a hexadecimal value.
2732
+ * @format COLOR_HEX
2733
+ */
2734
+ color?: string | null;
2735
+ /** Border radius in pixels. */
2736
+ radius?: number | null;
2737
+ }
2738
+ interface ImageDataStyles {
2739
+ /** Border attributes. */
2740
+ border?: StylesBorder;
2741
+ }
2742
+ interface LinkPreviewData {
2743
+ /** Styling for the link preview's container. */
2744
+ containerData?: PluginContainerData;
2745
+ /** Link details. */
2746
+ link?: Link;
2747
+ /** Preview title. */
2748
+ title?: string | null;
2749
+ /** Preview thumbnail URL. */
2750
+ thumbnailUrl?: string | null;
2751
+ /** Preview description. */
2752
+ description?: string | null;
2753
+ /** The preview content as HTML. */
2754
+ html?: string | null;
2755
+ /** Styling for the link preview. */
2756
+ styles?: LinkPreviewDataStyles;
2757
+ }
2758
+ declare enum StylesPosition {
2759
+ /** Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts) */
2760
+ START = "START",
2761
+ /** Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts) */
2762
+ END = "END",
2763
+ /** Thumbnail positioned at the top */
2764
+ TOP = "TOP",
2765
+ /** Thumbnail hidden and not displayed */
2766
+ HIDDEN = "HIDDEN"
2767
+ }
2768
+ /** @enumType */
2769
+ type StylesPositionWithLiterals = StylesPosition | 'START' | 'END' | 'TOP' | 'HIDDEN';
2770
+ interface LinkPreviewDataStyles {
2771
+ /**
2772
+ * Background color as a hexadecimal value.
2773
+ * @format COLOR_HEX
2774
+ */
2775
+ backgroundColor?: string | null;
2776
+ /**
2777
+ * Title color as a hexadecimal value.
2778
+ * @format COLOR_HEX
2779
+ */
2780
+ titleColor?: string | null;
2781
+ /**
2782
+ * Subtitle color as a hexadecimal value.
2783
+ * @format COLOR_HEX
2784
+ */
2785
+ subtitleColor?: string | null;
2786
+ /**
2787
+ * Link color as a hexadecimal value.
2788
+ * @format COLOR_HEX
2789
+ */
2790
+ linkColor?: string | null;
2791
+ /** Border width in pixels. */
2792
+ borderWidth?: number | null;
2793
+ /** Border radius in pixels. */
2794
+ borderRadius?: number | null;
2795
+ /**
2796
+ * Border color as a hexadecimal value.
2797
+ * @format COLOR_HEX
2798
+ */
2799
+ borderColor?: string | null;
2800
+ /** Position of thumbnail. Defaults to `START`. */
2801
+ thumbnailPosition?: StylesPositionWithLiterals;
2802
+ }
2803
+ interface MapData {
2804
+ /** Styling for the map's container. */
2805
+ containerData?: PluginContainerData;
2806
+ /** Map settings. */
2807
+ mapSettings?: MapSettings;
2808
+ }
2809
+ interface MapSettings {
2810
+ /** The address to display on the map. */
2811
+ address?: string | null;
2812
+ /** Sets whether the map is draggable. */
2813
+ draggable?: boolean | null;
2814
+ /** Sets whether the location marker is visible. */
2815
+ marker?: boolean | null;
2816
+ /** Sets whether street view control is enabled. */
2817
+ streetViewControl?: boolean | null;
2818
+ /** Sets whether zoom control is enabled. */
2819
+ zoomControl?: boolean | null;
2820
+ /** Location latitude. */
2821
+ lat?: number | null;
2822
+ /** Location longitude. */
2823
+ lng?: number | null;
2824
+ /** Location name. */
2825
+ locationName?: string | null;
2826
+ /** Sets whether view mode control is enabled. */
2827
+ viewModeControl?: boolean | null;
2828
+ /** Initial zoom value. */
2829
+ initialZoom?: number | null;
2830
+ /** Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types. */
2831
+ mapType?: MapTypeWithLiterals;
2832
+ }
2833
+ declare enum MapType {
2834
+ /** Roadmap map type */
2835
+ ROADMAP = "ROADMAP",
2836
+ /** Satellite map type */
2837
+ SATELITE = "SATELITE",
2838
+ /** Hybrid map type */
2839
+ HYBRID = "HYBRID",
2840
+ /** Terrain map type */
2841
+ TERRAIN = "TERRAIN"
2842
+ }
2843
+ /** @enumType */
2844
+ type MapTypeWithLiterals = MapType | 'ROADMAP' | 'SATELITE' | 'HYBRID' | 'TERRAIN';
2845
+ interface ParagraphData {
2846
+ /** Styling for the paragraph text. */
2847
+ textStyle?: TextStyle;
2848
+ /** Indentation level from 1-4. */
2849
+ indentation?: number | null;
2850
+ /** Paragraph level */
2851
+ level?: number | null;
2852
+ }
2853
+ interface PollData {
2854
+ /** Styling for the poll's container. */
2855
+ containerData?: PluginContainerData;
2856
+ /** Poll data. */
2857
+ poll?: Poll;
2858
+ /** Layout settings for the poll and voting options. */
2859
+ layout?: PollDataLayout;
2860
+ /** Styling for the poll and voting options. */
2861
+ design?: Design;
2862
+ }
2863
+ declare enum ViewRole {
2864
+ /** Only Poll creator can view the results */
2865
+ CREATOR = "CREATOR",
2866
+ /** Anyone who voted can see the results */
2867
+ VOTERS = "VOTERS",
2868
+ /** Anyone can see the results, even if one didn't vote */
2869
+ EVERYONE = "EVERYONE"
2870
+ }
2871
+ /** @enumType */
2872
+ type ViewRoleWithLiterals = ViewRole | 'CREATOR' | 'VOTERS' | 'EVERYONE';
2873
+ declare enum VoteRole {
2874
+ /** Logged in member */
2875
+ SITE_MEMBERS = "SITE_MEMBERS",
2876
+ /** Anyone */
2877
+ ALL = "ALL"
2878
+ }
2879
+ /** @enumType */
2880
+ type VoteRoleWithLiterals = VoteRole | 'SITE_MEMBERS' | 'ALL';
2881
+ interface Permissions {
2882
+ /** Sets who can view the poll results. */
2883
+ view?: ViewRoleWithLiterals;
2884
+ /** Sets who can vote. */
2885
+ vote?: VoteRoleWithLiterals;
2886
+ /** Sets whether one voter can vote multiple times. Defaults to `false`. */
2887
+ allowMultipleVotes?: boolean | null;
2888
+ }
2889
+ interface Option {
2890
+ /** Option ID. */
2891
+ id?: string | null;
2892
+ /** Option title. */
2893
+ title?: string | null;
2894
+ /** The image displayed with the option. */
2895
+ image?: V1Media;
2896
+ }
2897
+ interface PollSettings {
2898
+ /** Permissions settings for voting. */
2899
+ permissions?: Permissions;
2900
+ /** Sets whether voters are displayed in the vote results. Defaults to `true`. */
2901
+ showVoters?: boolean | null;
2902
+ /** Sets whether the vote count is displayed. Defaults to `true`. */
2903
+ showVotesCount?: boolean | null;
2904
+ }
2905
+ declare enum PollLayoutType {
2906
+ /** List */
2907
+ LIST = "LIST",
2908
+ /** Grid */
2909
+ GRID = "GRID"
2910
+ }
2911
+ /** @enumType */
2912
+ type PollLayoutTypeWithLiterals = PollLayoutType | 'LIST' | 'GRID';
2913
+ declare enum PollLayoutDirection {
2914
+ /** Left-to-right */
2915
+ LTR = "LTR",
2916
+ /** Right-to-left */
2917
+ RTL = "RTL"
2918
+ }
2919
+ /** @enumType */
2920
+ type PollLayoutDirectionWithLiterals = PollLayoutDirection | 'LTR' | 'RTL';
2921
+ interface PollLayout {
2922
+ /** The layout for displaying the voting options. */
2923
+ type?: PollLayoutTypeWithLiterals;
2924
+ /** The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right. */
2925
+ direction?: PollLayoutDirectionWithLiterals;
2926
+ /** Sets whether to display the main poll image. Defaults to `false`. */
2927
+ enableImage?: boolean | null;
2928
+ }
2929
+ interface OptionLayout {
2930
+ /** Sets whether to display option images. Defaults to `false`. */
2931
+ enableImage?: boolean | null;
2932
+ }
2933
+ declare enum BackgroundType {
2934
+ /** Color background type */
2935
+ COLOR = "COLOR",
2936
+ /** Image background type */
2937
+ IMAGE = "IMAGE",
2938
+ /** Gradiant background type */
2939
+ GRADIENT = "GRADIENT"
2940
+ }
2941
+ /** @enumType */
2942
+ type BackgroundTypeWithLiterals = BackgroundType | 'COLOR' | 'IMAGE' | 'GRADIENT';
2943
+ interface Gradient {
2944
+ /** The gradient angle in degrees. */
2945
+ angle?: number | null;
2946
+ /**
2947
+ * The start color as a hexademical value.
2948
+ * @format COLOR_HEX
2949
+ */
2950
+ startColor?: string | null;
2951
+ /**
2952
+ * The end color as a hexademical value.
2953
+ * @format COLOR_HEX
2954
+ */
2955
+ lastColor?: string | null;
2956
+ }
2957
+ interface Background extends BackgroundBackgroundOneOf {
2958
+ /**
2959
+ * The background color as a hexademical value.
2960
+ * @format COLOR_HEX
2961
+ */
2962
+ color?: string | null;
2963
+ /** An image to use for the background. */
2964
+ image?: V1Media;
2965
+ /** Details for a gradient background. */
2966
+ gradient?: Gradient;
2967
+ /** Background type. For each option, include the relevant details. */
2968
+ type?: BackgroundTypeWithLiterals;
2969
+ }
2970
+ /** @oneof */
2971
+ interface BackgroundBackgroundOneOf {
2972
+ /**
2973
+ * The background color as a hexademical value.
2974
+ * @format COLOR_HEX
2975
+ */
2976
+ color?: string | null;
2977
+ /** An image to use for the background. */
2978
+ image?: V1Media;
2979
+ /** Details for a gradient background. */
2980
+ gradient?: Gradient;
2981
+ }
2982
+ interface PollDesign {
2983
+ /** Background styling. */
2984
+ background?: Background;
2985
+ /** Border radius in pixels. */
2986
+ borderRadius?: number | null;
2987
+ }
2988
+ interface OptionDesign {
2989
+ /** Border radius in pixels. */
2990
+ borderRadius?: number | null;
2991
+ }
2992
+ interface Poll {
2993
+ /** Poll ID. */
2994
+ id?: string | null;
2995
+ /** Poll title. */
2996
+ title?: string | null;
2997
+ /** Poll creator ID. */
2998
+ creatorId?: string | null;
2999
+ /** Main poll image. */
3000
+ image?: V1Media;
3001
+ /** Voting options. */
3002
+ options?: Option[];
3003
+ /** The poll's permissions and display settings. */
3004
+ settings?: PollSettings;
3005
+ }
3006
+ interface PollDataLayout {
3007
+ /** Poll layout settings. */
3008
+ poll?: PollLayout;
3009
+ /** Voting otpions layout settings. */
3010
+ options?: OptionLayout;
3011
+ }
3012
+ interface Design {
3013
+ /** Styling for the poll. */
3014
+ poll?: PollDesign;
3015
+ /** Styling for voting options. */
3016
+ options?: OptionDesign;
3017
+ }
3018
+ interface TextData {
3019
+ /** The text to apply decorations to. */
3020
+ text?: string;
3021
+ /** The decorations to apply. */
3022
+ decorations?: Decoration[];
3023
+ }
3024
+ /** Adds appearence changes to text */
3025
+ interface Decoration extends DecorationDataOneOf {
3026
+ /** Data for an anchor link decoration. */
3027
+ anchorData?: AnchorData;
3028
+ /** Data for a color decoration. */
3029
+ colorData?: ColorData;
3030
+ /** Data for an external link decoration. */
3031
+ linkData?: LinkData;
3032
+ /** Data for a mention decoration. */
3033
+ mentionData?: MentionData;
3034
+ /** Data for a font size decoration. */
3035
+ fontSizeData?: FontSizeData;
3036
+ /** Font weight for a bold decoration. */
3037
+ fontWeightValue?: number | null;
3038
+ /** Data for an italic decoration. Defaults to `true`. */
3039
+ italicData?: boolean | null;
3040
+ /** Data for an underline decoration. Defaults to `true`. */
3041
+ underlineData?: boolean | null;
3042
+ /** Data for a spoiler decoration. */
3043
+ spoilerData?: SpoilerData;
3044
+ /** Data for a strikethrough decoration. Defaults to `true`. */
3045
+ strikethroughData?: boolean | null;
3046
+ /** Data for a superscript decoration. Defaults to `true`. */
3047
+ superscriptData?: boolean | null;
3048
+ /** Data for a subscript decoration. Defaults to `true`. */
3049
+ subscriptData?: boolean | null;
3050
+ /** The type of decoration to apply. */
3051
+ type?: DecorationTypeWithLiterals;
3052
+ }
3053
+ /** @oneof */
3054
+ interface DecorationDataOneOf {
3055
+ /** Data for an anchor link decoration. */
3056
+ anchorData?: AnchorData;
3057
+ /** Data for a color decoration. */
3058
+ colorData?: ColorData;
3059
+ /** Data for an external link decoration. */
3060
+ linkData?: LinkData;
3061
+ /** Data for a mention decoration. */
3062
+ mentionData?: MentionData;
3063
+ /** Data for a font size decoration. */
3064
+ fontSizeData?: FontSizeData;
3065
+ /** Font weight for a bold decoration. */
3066
+ fontWeightValue?: number | null;
3067
+ /** Data for an italic decoration. Defaults to `true`. */
3068
+ italicData?: boolean | null;
3069
+ /** Data for an underline decoration. Defaults to `true`. */
3070
+ underlineData?: boolean | null;
3071
+ /** Data for a spoiler decoration. */
3072
+ spoilerData?: SpoilerData;
3073
+ /** Data for a strikethrough decoration. Defaults to `true`. */
3074
+ strikethroughData?: boolean | null;
3075
+ /** Data for a superscript decoration. Defaults to `true`. */
3076
+ superscriptData?: boolean | null;
3077
+ /** Data for a subscript decoration. Defaults to `true`. */
3078
+ subscriptData?: boolean | null;
3079
+ }
3080
+ declare enum DecorationType {
3081
+ BOLD = "BOLD",
3082
+ ITALIC = "ITALIC",
3083
+ UNDERLINE = "UNDERLINE",
3084
+ SPOILER = "SPOILER",
3085
+ ANCHOR = "ANCHOR",
3086
+ MENTION = "MENTION",
3087
+ LINK = "LINK",
3088
+ COLOR = "COLOR",
3089
+ FONT_SIZE = "FONT_SIZE",
3090
+ EXTERNAL = "EXTERNAL",
3091
+ STRIKETHROUGH = "STRIKETHROUGH",
3092
+ SUPERSCRIPT = "SUPERSCRIPT",
3093
+ SUBSCRIPT = "SUBSCRIPT"
3094
+ }
3095
+ /** @enumType */
3096
+ type DecorationTypeWithLiterals = DecorationType | 'BOLD' | 'ITALIC' | 'UNDERLINE' | 'SPOILER' | 'ANCHOR' | 'MENTION' | 'LINK' | 'COLOR' | 'FONT_SIZE' | 'EXTERNAL' | 'STRIKETHROUGH' | 'SUPERSCRIPT' | 'SUBSCRIPT';
3097
+ interface AnchorData {
3098
+ /** The target node's ID. */
3099
+ anchor?: string;
3100
+ }
3101
+ interface ColorData {
3102
+ /** The text's background color as a hexadecimal value. */
3103
+ background?: string | null;
3104
+ /** The text's foreground color as a hexadecimal value. */
3105
+ foreground?: string | null;
3106
+ }
3107
+ interface LinkData {
3108
+ /** Link details. */
3109
+ link?: Link;
3110
+ }
3111
+ interface MentionData {
3112
+ /** The mentioned user's name. */
3113
+ name?: string;
3114
+ /** The version of the user's name that appears after the `@` character in the mention. */
3115
+ slug?: string;
3116
+ /** Mentioned user's ID. */
3117
+ id?: string | null;
3118
+ }
3119
+ interface FontSizeData {
3120
+ /** The units used for the font size. */
3121
+ unit?: FontTypeWithLiterals;
3122
+ /** Font size value. */
3123
+ value?: number | null;
3124
+ }
3125
+ declare enum FontType {
3126
+ PX = "PX",
3127
+ EM = "EM"
3128
+ }
3129
+ /** @enumType */
3130
+ type FontTypeWithLiterals = FontType | 'PX' | 'EM';
3131
+ interface SpoilerData {
3132
+ /** Spoiler ID. */
3133
+ id?: string | null;
3134
+ }
3135
+ interface AppEmbedData extends AppEmbedDataAppDataOneOf {
3136
+ /** Data for embedded Wix Bookings content. */
3137
+ bookingData?: BookingData;
3138
+ /** Data for embedded Wix Events content. */
3139
+ eventData?: EventData;
3140
+ /** The type of Wix App content being embedded. */
3141
+ type?: AppTypeWithLiterals;
3142
+ /** The ID of the embedded content. */
3143
+ itemId?: string | null;
3144
+ /** The name of the embedded content. */
3145
+ name?: string | null;
3146
+ /**
3147
+ * Deprecated: Use `image` instead.
3148
+ * @deprecated
3149
+ */
3150
+ imageSrc?: string | null;
3151
+ /** The URL for the embedded content. */
3152
+ url?: string | null;
3153
+ /** An image for the embedded content. */
3154
+ image?: V1Media;
3155
+ /** Whether to hide the image. */
3156
+ hideImage?: boolean | null;
3157
+ /** Whether to hide the title. */
3158
+ hideTitle?: boolean | null;
3159
+ /** Whether to hide the price. */
3160
+ hidePrice?: boolean | null;
3161
+ /** Whether to hide the description (Event and Booking). */
3162
+ hideDescription?: boolean | null;
3163
+ /** Whether to hide the date and time (Event). */
3164
+ hideDateTime?: boolean | null;
3165
+ /** Whether to hide the location (Event). */
3166
+ hideLocation?: boolean | null;
3167
+ /** Whether to hide the duration (Booking). */
3168
+ hideDuration?: boolean | null;
3169
+ /** Whether to hide the button. */
3170
+ hideButton?: boolean | null;
3171
+ /** Whether to hide the ribbon. */
3172
+ hideRibbon?: boolean | null;
3173
+ /** Button styling options. */
3174
+ buttonStyles?: ButtonStyles;
3175
+ /** Image styling options. */
3176
+ imageStyles?: ImageStyles;
3177
+ /** Ribbon styling options. */
3178
+ ribbonStyles?: RibbonStyles;
3179
+ /** Card styling options. */
3180
+ cardStyles?: CardStyles;
3181
+ /** Styling for the app embed's container. */
3182
+ containerData?: PluginContainerData;
3183
+ /** Pricing data for embedded Wix App content. */
3184
+ pricingData?: PricingData;
3185
+ }
3186
+ /** @oneof */
3187
+ interface AppEmbedDataAppDataOneOf {
3188
+ /** Data for embedded Wix Bookings content. */
3189
+ bookingData?: BookingData;
3190
+ /** Data for embedded Wix Events content. */
3191
+ eventData?: EventData;
3192
+ }
3193
+ declare enum Position {
3194
+ /** Image positioned at the start (left in LTR layouts, right in RTL layouts) */
3195
+ START = "START",
3196
+ /** Image positioned at the end (right in LTR layouts, left in RTL layouts) */
3197
+ END = "END",
3198
+ /** Image positioned at the top */
3199
+ TOP = "TOP"
3200
+ }
3201
+ /** @enumType */
3202
+ type PositionWithLiterals = Position | 'START' | 'END' | 'TOP';
3203
+ declare enum AspectRatio {
3204
+ /** 1:1 aspect ratio */
3205
+ SQUARE = "SQUARE",
3206
+ /** 16:9 aspect ratio */
3207
+ RECTANGLE = "RECTANGLE"
3208
+ }
3209
+ /** @enumType */
3210
+ type AspectRatioWithLiterals = AspectRatio | 'SQUARE' | 'RECTANGLE';
3211
+ declare enum Resizing {
3212
+ /** Fill the container, may crop the image */
3213
+ FILL = "FILL",
3214
+ /** Fit the image within the container */
3215
+ FIT = "FIT"
3216
+ }
3217
+ /** @enumType */
3218
+ type ResizingWithLiterals = Resizing | 'FILL' | 'FIT';
3219
+ declare enum Placement {
3220
+ /** Ribbon placed on the image */
3221
+ IMAGE = "IMAGE",
3222
+ /** Ribbon placed on the product information */
3223
+ PRODUCT_INFO = "PRODUCT_INFO"
3224
+ }
3225
+ /** @enumType */
3226
+ type PlacementWithLiterals = Placement | 'IMAGE' | 'PRODUCT_INFO';
3227
+ declare enum Type {
3228
+ /** Card with visible border and background */
3229
+ CONTAINED = "CONTAINED",
3230
+ /** Card without visible border */
3231
+ FRAMELESS = "FRAMELESS"
3232
+ }
3233
+ /** @enumType */
3234
+ type TypeWithLiterals = Type | 'CONTAINED' | 'FRAMELESS';
3235
+ declare enum Alignment {
3236
+ /** Content aligned to start (left in LTR layouts, right in RTL layouts) */
3237
+ START = "START",
3238
+ /** Content centered */
3239
+ CENTER = "CENTER",
3240
+ /** Content aligned to end (right in LTR layouts, left in RTL layouts) */
3241
+ END = "END"
3242
+ }
3243
+ /** @enumType */
3244
+ type AlignmentWithLiterals = Alignment | 'START' | 'CENTER' | 'END';
3245
+ declare enum Layout {
3246
+ /** Elements stacked vertically */
3247
+ STACKED = "STACKED",
3248
+ /** Elements arranged horizontally */
3249
+ SIDE_BY_SIDE = "SIDE_BY_SIDE"
3250
+ }
3251
+ /** @enumType */
3252
+ type LayoutWithLiterals = Layout | 'STACKED' | 'SIDE_BY_SIDE';
3253
+ declare enum AppType {
3254
+ PRODUCT = "PRODUCT",
3255
+ EVENT = "EVENT",
3256
+ BOOKING = "BOOKING"
3257
+ }
3258
+ /** @enumType */
3259
+ type AppTypeWithLiterals = AppType | 'PRODUCT' | 'EVENT' | 'BOOKING';
3260
+ interface BookingData {
3261
+ /** Booking duration in minutes. */
3262
+ durations?: string | null;
3263
+ }
3264
+ interface EventData {
3265
+ /** Event schedule. */
3266
+ scheduling?: string | null;
3267
+ /** Event location. */
3268
+ location?: string | null;
3269
+ }
3270
+ interface ButtonStyles {
3271
+ /** Text to display on the button. */
3272
+ buttonText?: string | null;
3273
+ /** Border width in pixels. */
3274
+ borderWidth?: number | null;
3275
+ /** Border radius in pixels. */
3276
+ borderRadius?: number | null;
3277
+ /**
3278
+ * Border color as a hexadecimal value.
3279
+ * @format COLOR_HEX
3280
+ */
3281
+ borderColor?: string | null;
3282
+ /**
3283
+ * Text color as a hexadecimal value.
3284
+ * @format COLOR_HEX
3285
+ */
3286
+ textColor?: string | null;
3287
+ /**
3288
+ * Background color as a hexadecimal value.
3289
+ * @format COLOR_HEX
3290
+ */
3291
+ backgroundColor?: string | null;
3292
+ /**
3293
+ * Border color as a hexadecimal value (hover state).
3294
+ * @format COLOR_HEX
3295
+ */
3296
+ borderColorHover?: string | null;
3297
+ /**
3298
+ * Text color as a hexadecimal value (hover state).
3299
+ * @format COLOR_HEX
3300
+ */
3301
+ textColorHover?: string | null;
3302
+ /**
3303
+ * Background color as a hexadecimal value (hover state).
3304
+ * @format COLOR_HEX
3305
+ */
3306
+ backgroundColorHover?: string | null;
3307
+ /** Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`. */
3308
+ buttonSize?: string | null;
3309
+ }
3310
+ interface ImageStyles {
3311
+ /** Whether to hide the image. */
3312
+ hideImage?: boolean | null;
3313
+ /** Position of image. Defaults to `START`. */
3314
+ imagePosition?: PositionWithLiterals;
3315
+ /** Aspect ratio for the image. Defaults to `SQUARE`. */
3316
+ aspectRatio?: AspectRatioWithLiterals;
3317
+ /** How the image should be resized. Defaults to `FILL`. */
3318
+ resizing?: ResizingWithLiterals;
3319
+ /**
3320
+ * Image border color as a hexadecimal value.
3321
+ * @format COLOR_HEX
3322
+ */
3323
+ borderColor?: string | null;
3324
+ /** Image border width in pixels. */
3325
+ borderWidth?: number | null;
3326
+ /** Image border radius in pixels. */
3327
+ borderRadius?: number | null;
3328
+ }
3329
+ interface RibbonStyles {
3330
+ /** Text to display on the ribbon. */
3331
+ ribbonText?: string | null;
3332
+ /**
3333
+ * Ribbon background color as a hexadecimal value.
3334
+ * @format COLOR_HEX
3335
+ */
3336
+ backgroundColor?: string | null;
3337
+ /**
3338
+ * Ribbon text color as a hexadecimal value.
3339
+ * @format COLOR_HEX
3340
+ */
3341
+ textColor?: string | null;
3342
+ /**
3343
+ * Ribbon border color as a hexadecimal value.
3344
+ * @format COLOR_HEX
3345
+ */
3346
+ borderColor?: string | null;
3347
+ /** Ribbon border width in pixels. */
3348
+ borderWidth?: number | null;
3349
+ /** Ribbon border radius in pixels. */
3350
+ borderRadius?: number | null;
3351
+ /** Placement of the ribbon. Defaults to `IMAGE`. */
3352
+ ribbonPlacement?: PlacementWithLiterals;
3353
+ }
3354
+ interface CardStyles {
3355
+ /**
3356
+ * Card background color as a hexadecimal value.
3357
+ * @format COLOR_HEX
3358
+ */
3359
+ backgroundColor?: string | null;
3360
+ /**
3361
+ * Card border color as a hexadecimal value.
3362
+ * @format COLOR_HEX
3363
+ */
3364
+ borderColor?: string | null;
3365
+ /** Card border width in pixels. */
3366
+ borderWidth?: number | null;
3367
+ /** Card border radius in pixels. */
3368
+ borderRadius?: number | null;
3369
+ /** Card type. Defaults to `CONTAINED`. */
3370
+ type?: TypeWithLiterals;
3371
+ /** Content alignment. Defaults to `START`. */
3372
+ alignment?: AlignmentWithLiterals;
3373
+ /** Layout for title and price. Defaults to `STACKED`. */
3374
+ titlePriceLayout?: LayoutWithLiterals;
3375
+ /**
3376
+ * Title text color as a hexadecimal value.
3377
+ * @format COLOR_HEX
3378
+ */
3379
+ titleColor?: string | null;
3380
+ /**
3381
+ * Text color as a hexadecimal value.
3382
+ * @format COLOR_HEX
3383
+ */
3384
+ textColor?: string | null;
3385
+ }
3386
+ interface PricingData {
3387
+ /**
3388
+ * Minimum numeric price value as string (e.g., "10.99").
3389
+ * @decimalValue options { maxScale:2 }
3390
+ */
3391
+ valueFrom?: string | null;
3392
+ /**
3393
+ * Maximum numeric price value as string (e.g., "19.99").
3394
+ * @decimalValue options { maxScale:2 }
3395
+ */
3396
+ valueTo?: string | null;
3397
+ /**
3398
+ * Numeric price value as string after discount application (e.g., "15.99").
3399
+ * @decimalValue options { maxScale:2 }
3400
+ */
3401
+ discountedValue?: string | null;
3402
+ /**
3403
+ * Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
3404
+ * @format CURRENCY
3405
+ */
3406
+ currency?: string | null;
3407
+ /**
3408
+ * Pricing plan ID.
3409
+ * @format GUID
3410
+ */
3411
+ pricingPlanId?: string | null;
3412
+ }
3413
+ interface VideoData {
3414
+ /** Styling for the video's container. */
3415
+ containerData?: PluginContainerData;
3416
+ /** Video details. */
3417
+ video?: V1Media;
3418
+ /** Video thumbnail details. */
3419
+ thumbnail?: V1Media;
3420
+ /** Sets whether the video's download button is disabled. Defaults to `false`. */
3421
+ disableDownload?: boolean | null;
3422
+ /** Video title. */
3423
+ title?: string | null;
3424
+ /** Video options. */
3425
+ options?: PlaybackOptions;
3426
+ }
3427
+ interface PlaybackOptions {
3428
+ /** Sets whether the media will automatically start playing. */
3429
+ autoPlay?: boolean | null;
3430
+ /** Sets whether media's will be looped. */
3431
+ playInLoop?: boolean | null;
3432
+ /** Sets whether media's controls will be shown. */
3433
+ showControls?: boolean | null;
3434
+ }
3435
+ interface EmbedData {
3436
+ /** Styling for the oEmbed node's container. */
3437
+ containerData?: PluginContainerData;
3438
+ /** An [oEmbed](https://www.oembed.com) object. */
3439
+ oembed?: Oembed;
3440
+ /** Origin asset source. */
3441
+ src?: string | null;
3442
+ }
3443
+ interface Oembed {
3444
+ /** The resource type. */
3445
+ type?: string | null;
3446
+ /** The width of the resource specified in the `url` property in pixels. */
3447
+ width?: number | null;
3448
+ /** The height of the resource specified in the `url` property in pixels. */
3449
+ height?: number | null;
3450
+ /** Resource title. */
3451
+ title?: string | null;
3452
+ /** The source URL for the resource. */
3453
+ url?: string | null;
3454
+ /** HTML for embedding a video player. The HTML should have no padding or margins. */
3455
+ html?: string | null;
3456
+ /** The name of the author or owner of the resource. */
3457
+ authorName?: string | null;
3458
+ /** The URL for the author or owner of the resource. */
3459
+ authorUrl?: string | null;
3460
+ /** The name of the resource provider. */
3461
+ providerName?: string | null;
3462
+ /** The URL for the resource provider. */
3463
+ providerUrl?: string | null;
3464
+ /** The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined. */
3465
+ thumbnailUrl?: string | null;
3466
+ /** The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined. */
3467
+ thumbnailWidth?: string | null;
3468
+ /** The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined. */
3469
+ thumbnailHeight?: string | null;
3470
+ /** The URL for an embedded viedo. */
3471
+ videoUrl?: string | null;
3472
+ /** The oEmbed version number. This value must be `1.0`. */
3473
+ version?: string | null;
3474
+ }
3475
+ interface CollapsibleListData {
3476
+ /** Styling for the collapsible list's container. */
3477
+ containerData?: PluginContainerData;
3478
+ /** If `true`, only one item can be expanded at a time. Defaults to `false`. */
3479
+ expandOnlyOne?: boolean | null;
3480
+ /** Sets which items are expanded when the page loads. */
3481
+ initialExpandedItems?: InitialExpandedItemsWithLiterals;
3482
+ /** The direction of the text in the list. Either left-to-right or right-to-left. */
3483
+ direction?: DirectionWithLiterals;
3484
+ /** If `true`, The collapsible item will appear in search results as an FAQ. */
3485
+ isQapageData?: boolean | null;
3486
+ }
3487
+ declare enum InitialExpandedItems {
3488
+ /** First item will be expended initally */
3489
+ FIRST = "FIRST",
3490
+ /** All items will expended initally */
3491
+ ALL = "ALL",
3492
+ /** All items collapsed initally */
3493
+ NONE = "NONE"
3494
+ }
3495
+ /** @enumType */
3496
+ type InitialExpandedItemsWithLiterals = InitialExpandedItems | 'FIRST' | 'ALL' | 'NONE';
3497
+ declare enum Direction {
3498
+ /** Left-to-right */
3499
+ LTR = "LTR",
3500
+ /** Right-to-left */
3501
+ RTL = "RTL"
3502
+ }
3503
+ /** @enumType */
3504
+ type DirectionWithLiterals = Direction | 'LTR' | 'RTL';
3505
+ interface TableData {
3506
+ /** Styling for the table's container. */
3507
+ containerData?: PluginContainerData;
3508
+ /** The table's dimensions. */
3509
+ dimensions?: Dimensions;
3510
+ /**
3511
+ * Deprecated: Use `rowHeader` and `columnHeader` instead.
3512
+ * @deprecated
3513
+ */
3514
+ header?: boolean | null;
3515
+ /** Sets whether the table's first row is a header. Defaults to `false`. */
3516
+ rowHeader?: boolean | null;
3517
+ /** Sets whether the table's first column is a header. Defaults to `false`. */
3518
+ columnHeader?: boolean | null;
3519
+ }
3520
+ interface Dimensions {
3521
+ /** An array representing relative width of each column in relation to the other columns. */
3522
+ colsWidthRatio?: number[];
3523
+ /** An array representing the height of each row in pixels. */
3524
+ rowsHeight?: number[];
3525
+ /** An array representing the minimum width of each column in pixels. */
3526
+ colsMinWidth?: number[];
3527
+ }
3528
+ interface TableCellData {
3529
+ /** Styling for the cell's background color and text alignment. */
3530
+ cellStyle?: CellStyle;
3531
+ /** The cell's border colors. */
3532
+ borderColors?: BorderColors;
3533
+ }
3534
+ declare enum VerticalAlignment {
3535
+ /** Top alignment */
3536
+ TOP = "TOP",
3537
+ /** Middle alignment */
3538
+ MIDDLE = "MIDDLE",
3539
+ /** Bottom alignment */
3540
+ BOTTOM = "BOTTOM"
3541
+ }
3542
+ /** @enumType */
3543
+ type VerticalAlignmentWithLiterals = VerticalAlignment | 'TOP' | 'MIDDLE' | 'BOTTOM';
3544
+ interface CellStyle {
3545
+ /** Vertical alignment for the cell's text. */
3546
+ verticalAlignment?: VerticalAlignmentWithLiterals;
3547
+ /**
3548
+ * Cell background color as a hexadecimal value.
3549
+ * @format COLOR_HEX
3550
+ */
3551
+ backgroundColor?: string | null;
3552
+ }
3553
+ interface BorderColors {
3554
+ /**
3555
+ * Left border color as a hexadecimal value.
3556
+ * @format COLOR_HEX
3557
+ */
3558
+ left?: string | null;
3559
+ /**
3560
+ * Right border color as a hexadecimal value.
3561
+ * @format COLOR_HEX
3562
+ */
3563
+ right?: string | null;
3564
+ /**
3565
+ * Top border color as a hexadecimal value.
3566
+ * @format COLOR_HEX
3567
+ */
3568
+ top?: string | null;
3569
+ /**
3570
+ * Bottom border color as a hexadecimal value.
3571
+ * @format COLOR_HEX
3572
+ */
3573
+ bottom?: string | null;
3574
+ }
3575
+ /**
3576
+ * `NullValue` is a singleton enumeration to represent the null value for the
3577
+ * `Value` type union.
3578
+ *
3579
+ * The JSON representation for `NullValue` is JSON `null`.
3580
+ */
3581
+ declare enum NullValue {
3582
+ /** Null value. */
3583
+ NULL_VALUE = "NULL_VALUE"
3584
+ }
3585
+ /** @enumType */
3586
+ type NullValueWithLiterals = NullValue | 'NULL_VALUE';
3587
+ /**
3588
+ * `ListValue` is a wrapper around a repeated field of values.
3589
+ *
3590
+ * The JSON representation for `ListValue` is JSON array.
3591
+ */
3592
+ interface ListValue {
3593
+ /** Repeated field of dynamically typed values. */
3594
+ values?: any[];
3595
+ }
3596
+ interface AudioData {
3597
+ /** Styling for the audio node's container. */
3598
+ containerData?: PluginContainerData;
3599
+ /** Audio file details. */
3600
+ audio?: V1Media;
3601
+ /** Sets whether the audio node's download button is disabled. Defaults to `false`. */
3602
+ disableDownload?: boolean | null;
3603
+ /** Cover image. */
3604
+ coverImage?: V1Media;
3605
+ /** Track name. */
3606
+ name?: string | null;
3607
+ /** Author name. */
3608
+ authorName?: string | null;
3609
+ /** An HTML version of the audio node. */
3610
+ html?: string | null;
3611
+ }
3612
+ interface OrderedListData {
3613
+ /** Indentation level from 0-4. */
3614
+ indentation?: number;
3615
+ /** Offset level from 0-4. */
3616
+ offset?: number | null;
3617
+ /** List start number. */
3618
+ start?: number | null;
3619
+ }
3620
+ interface BulletedListData {
3621
+ /** Indentation level from 0-4. */
3622
+ indentation?: number;
3623
+ /** Offset level from 0-4. */
3624
+ offset?: number | null;
3625
+ }
3626
+ interface BlockquoteData {
3627
+ /** Indentation level from 1-4. */
3628
+ indentation?: number;
3629
+ }
3630
+ interface CaptionData {
3631
+ textStyle?: TextStyle;
3632
+ }
3633
+ interface LayoutCellData {
3634
+ /** Size of the cell in 12 columns grid. */
3635
+ colSpan?: number | null;
3636
+ }
3637
+ interface Metadata {
3638
+ /** Schema version. */
3639
+ version?: number;
3640
+ /**
3641
+ * When the object was created.
3642
+ * @readonly
3643
+ * @deprecated
3644
+ */
3645
+ createdTimestamp?: Date | null;
3646
+ /**
3647
+ * When the object was most recently updated.
3648
+ * @deprecated
3649
+ */
3650
+ updatedTimestamp?: Date | null;
3651
+ /** Object ID. */
3652
+ id?: string | null;
3653
+ }
3654
+ interface DocumentStyle {
3655
+ /** Styling for H1 nodes. */
3656
+ headerOne?: TextNodeStyle;
3657
+ /** Styling for H2 nodes. */
3658
+ headerTwo?: TextNodeStyle;
3659
+ /** Styling for H3 nodes. */
3660
+ headerThree?: TextNodeStyle;
3661
+ /** Styling for H4 nodes. */
3662
+ headerFour?: TextNodeStyle;
3663
+ /** Styling for H5 nodes. */
3664
+ headerFive?: TextNodeStyle;
3665
+ /** Styling for H6 nodes. */
3666
+ headerSix?: TextNodeStyle;
3667
+ /** Styling for paragraph nodes. */
3668
+ paragraph?: TextNodeStyle;
3669
+ /** Styling for block quote nodes. */
3670
+ blockquote?: TextNodeStyle;
3671
+ /** Styling for code block nodes. */
3672
+ codeBlock?: TextNodeStyle;
3673
+ }
3674
+ interface TextNodeStyle {
3675
+ /** The decorations to apply to the node. */
3676
+ decorations?: Decoration[];
3677
+ /** Padding and background color for the node. */
3678
+ nodeStyle?: NodeStyle;
3679
+ /** Line height for text in the node. */
3680
+ lineHeight?: string | null;
3681
+ }
3682
+ interface Media {
3683
+ /**
3684
+ * Main media (image, video, etc.) associated with this product.
3685
+ * @readonly
3686
+ */
3687
+ main?: ProductMedia;
3688
+ /**
3689
+ * All media items.
3690
+ * > **Note:** Returned only when you pass `"MEDIA_ITEMS_INFO"` to the `fields` array in Products API requests.
3691
+ */
3692
+ itemsInfo?: MediaItemsInfo;
3693
+ }
3694
+ interface ProductMedia extends ProductMediaSetByOneOf, ProductMediaMediaOneOf {
3695
+ /**
3696
+ * Set media by ID of an existing file in Wix Media Manager.
3697
+ * @minLength 1
3698
+ * @maxLength 200
3699
+ */
3700
+ id?: string;
3701
+ /**
3702
+ * Set media using an external media URL.
3703
+ * @format WEB_URL
3704
+ */
3705
+ url?: string;
3706
+ /**
3707
+ * Product image.
3708
+ * @readonly
3709
+ */
3710
+ image?: Image;
3711
+ /**
3712
+ * Product video.
3713
+ * @readonly
3714
+ */
3715
+ video?: VideoV2;
3716
+ /**
3717
+ * Image alt text.
3718
+ * @minLength 1
3719
+ * @maxLength 1000
3720
+ */
3721
+ altText?: string | null;
3722
+ /**
3723
+ * Media display name.
3724
+ * Allows to override the default media name. Can be passed only when `setBy: url`.
3725
+ * @maxLength 80
3726
+ */
3727
+ displayName?: string | null;
3728
+ /**
3729
+ * Media type.
3730
+ * @readonly
3731
+ */
3732
+ mediaType?: MediaTypeWithLiterals;
3733
+ /**
3734
+ * Media thumbnail.
3735
+ * > **Note:** Returned only when you pass `"THUMBNAIL"` to the `fields` array in Products API requests.
3736
+ */
3737
+ thumbnail?: Thumbnail;
3738
+ /**
3739
+ * ID used to upload media to Wix Media Manager.
3740
+ * @readonly
3741
+ * @format GUID
3742
+ */
3743
+ uploadId?: string;
3744
+ }
3745
+ /** @oneof */
3746
+ interface ProductMediaSetByOneOf {
3747
+ /**
3748
+ * Set media by ID of an existing file in Wix Media Manager.
3749
+ * @minLength 1
3750
+ * @maxLength 200
3751
+ */
3752
+ id?: string;
3753
+ /**
3754
+ * Set media using an external media URL.
3755
+ * @format WEB_URL
3756
+ */
3757
+ url?: string;
3758
+ }
3759
+ /** @oneof */
3760
+ interface ProductMediaMediaOneOf {
3761
+ /**
3762
+ * Product image.
3763
+ * @readonly
3764
+ */
3765
+ image?: Image;
3766
+ /**
3767
+ * Product video.
3768
+ * @readonly
3769
+ */
3770
+ video?: VideoV2;
3771
+ }
3772
+ interface Image {
3773
+ /**
3774
+ * WixMedia image ID.
3775
+ * @maxLength 400
3776
+ */
3777
+ id?: string;
3778
+ /**
3779
+ * Image URL.
3780
+ * @format WEB_URL
3781
+ */
3782
+ url?: string;
3783
+ /**
3784
+ * Original image height.
3785
+ * @readonly
3786
+ */
3787
+ height?: number;
3788
+ /**
3789
+ * Original image width.
3790
+ * @readonly
3791
+ */
3792
+ width?: number;
3793
+ /**
3794
+ * Image alt text.
3795
+ * @maxLength 200
3796
+ */
3797
+ altText?: string | null;
3798
+ /**
3799
+ * Image filename.
3800
+ * @readonly
3801
+ * @maxLength 200
3802
+ */
3803
+ filename?: string | null;
3804
+ }
3805
+ interface VideoV2 {
3806
+ /**
3807
+ * WixMedia ID.
3808
+ * @maxLength 400
3809
+ */
3810
+ id?: string;
3811
+ /**
3812
+ * Available resolutions for the video, starting with the optimal resolution.
3813
+ * @readonly
3814
+ * @maxSize 100
3815
+ */
3816
+ resolutions?: VideoResolution[];
3817
+ /**
3818
+ * Video filename.
3819
+ * @readonly
3820
+ * @maxLength 200
3821
+ */
3822
+ filename?: string | null;
3823
+ }
3824
+ interface VideoResolution {
3825
+ /**
3826
+ * Video URL.
3827
+ * @format WEB_URL
3828
+ */
3829
+ url?: string;
3830
+ /** Video height. */
3831
+ height?: number;
3832
+ /** Video width. */
3833
+ width?: number;
3834
+ /**
3835
+ * Video format for example, mp4, hls.
3836
+ * @maxLength 200
3837
+ */
3838
+ format?: string;
3839
+ }
3840
+ declare enum MediaType {
3841
+ UNKNOWN_MEDIA_TYPE = "UNKNOWN_MEDIA_TYPE",
3842
+ /** Image media type. */
3843
+ IMAGE = "IMAGE",
3844
+ /** Video media type. */
3845
+ VIDEO = "VIDEO"
3846
+ }
3847
+ /** @enumType */
3848
+ type MediaTypeWithLiterals = MediaType | 'UNKNOWN_MEDIA_TYPE' | 'IMAGE' | 'VIDEO';
3849
+ interface Thumbnail {
3850
+ /**
3851
+ * Thumbnail url.
3852
+ * @format WEB_URL
3853
+ */
3854
+ url?: string;
3855
+ /** Thumbnail height. */
3856
+ height?: number;
3857
+ /** Thumbnail width. */
3858
+ width?: number;
3859
+ /**
3860
+ * Thumbnail alt text.
3861
+ * @minLength 1
3862
+ * @maxLength 1000
3863
+ */
3864
+ altText?: string | null;
3865
+ }
3866
+ interface MediaItemsInfo {
3867
+ /**
3868
+ * All media items (images, videos etc) associated with this product.
3869
+ * @maxSize 15
3870
+ */
3871
+ items?: ProductMedia[];
3872
+ }
3873
+ /**
3874
+ * The SEO schema object contains data about different types of meta tags. It makes sure that the information about your page is presented properly to search engines.
3875
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
3876
+ * 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.
3877
+ */
3878
+ interface SeoSchema {
3879
+ /** SEO tag information. */
3880
+ tags?: Tag[];
3881
+ /** SEO general settings. */
3882
+ settings?: Settings;
3883
+ }
3884
+ interface Keyword {
3885
+ /** Keyword value. */
3886
+ term?: string;
3887
+ /** Whether the keyword is the main focus keyword. */
3888
+ isMain?: boolean;
3889
+ /**
3890
+ * The source that added the keyword terms to the SEO settings.
3891
+ * @maxLength 1000
3892
+ */
3893
+ origin?: string | null;
3894
+ }
3895
+ interface Tag {
3896
+ /**
3897
+ * SEO tag type.
3898
+ *
3899
+ *
3900
+ * Supported values: `title`, `meta`, `script`, `link`.
3901
+ */
3902
+ type?: string;
3903
+ /**
3904
+ * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
3905
+ * For example: `{"name": "description", "content": "the description itself"}`.
3906
+ */
3907
+ props?: Record<string, any> | null;
3908
+ /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
3909
+ meta?: Record<string, any> | null;
3910
+ /** SEO tag inner content. For example, `<title> inner content </title>`. */
3911
+ children?: string;
3912
+ /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
3913
+ custom?: boolean;
3914
+ /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
3915
+ disabled?: boolean;
3916
+ }
3917
+ interface Settings {
3918
+ /**
3919
+ * Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.
3920
+ *
3921
+ *
3922
+ * Default: `false` (automatical redirect is enabled).
3923
+ */
3924
+ preventAutoRedirect?: boolean;
3925
+ /**
3926
+ * User-selected keyword terms for a specific page.
3927
+ * @maxSize 5
3928
+ */
3929
+ keywords?: Keyword[];
3930
+ }
3931
+ interface ConnectedOption extends ConnectedOptionOptionSettingsOneOf {
3932
+ /** Choices settings. */
3933
+ choicesSettings?: ChoicesSettings;
3934
+ /**
3935
+ * ID of a customization with `customizationType: PRODUCT_OPTION`.
3936
+ * @minLength 1
3937
+ * @maxLength 36
3938
+ */
3939
+ id?: string | null;
3940
+ /**
3941
+ * Option name.
3942
+ * @minLength 1
3943
+ * @maxLength 50
3944
+ */
3945
+ name?: string | null;
3946
+ /** Option render type. */
3947
+ optionRenderType?: ProductOptionRenderTypeWithLiterals;
3948
+ }
3949
+ /** @oneof */
3950
+ interface ConnectedOptionOptionSettingsOneOf {
3951
+ /** Choices settings. */
3952
+ choicesSettings?: ChoicesSettings;
3953
+ }
3954
+ declare enum ProductOptionRenderType {
3955
+ /** Not implemented. */
3956
+ UNKNOWN_OPTION_RENDER_TYPE = "UNKNOWN_OPTION_RENDER_TYPE",
3957
+ /** Text choices. */
3958
+ TEXT_CHOICES = "TEXT_CHOICES",
3959
+ /** Swatch choices. */
3960
+ SWATCH_CHOICES = "SWATCH_CHOICES"
3961
+ }
3962
+ /** @enumType */
3963
+ type ProductOptionRenderTypeWithLiterals = ProductOptionRenderType | 'UNKNOWN_OPTION_RENDER_TYPE' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
3964
+ interface ChoicesSettings {
3965
+ /**
3966
+ * List of available choices for the option.
3967
+ * @minSize 1
3968
+ * @maxSize 100
3969
+ * @immutable
3970
+ */
3971
+ choices?: ConnectedOptionChoice[];
3972
+ }
3973
+ interface ConnectedOptionChoice extends ConnectedOptionChoiceValueOneOf {
3974
+ /**
3975
+ * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
3976
+ * @minLength 3
3977
+ * @maxLength 20
3978
+ */
3979
+ colorCode?: string;
3980
+ /**
3981
+ * The id of the choice.
3982
+ * @format GUID
3983
+ */
3984
+ choiceId?: string | null;
3985
+ /**
3986
+ * Product media overrides. When not empty only these images will be shown when such choices selected by customer. Otherwise all images of product.
3987
+ * When several choices from different options selected only media filter present in `media_overrides` of ALL choices will be shown.
3988
+ * For example if Color:red has images 1,2,3 and Material:Silk has images 2,3,5 then only images 2,3 will be shown when both of them selected.
3989
+ * @maxSize 100
3990
+ */
3991
+ linkedMedia?: ProductMedia[];
3992
+ /** The type of this choice. */
3993
+ choiceType?: ChoiceTypeWithLiterals;
3994
+ /**
3995
+ * Choice name.
3996
+ * @minLength 1
3997
+ * @maxLength 50
3998
+ */
3999
+ name?: string | null;
4000
+ /**
4001
+ * A flag that indicates if at least one variant with this choice is in stock in the default store's location.
4002
+ * For example, a product with 'Color' and 'Size' options with variants: [Blue, Small] which is out of stock and [Red Large] which is in stock. For choice 'Blue' ths flag will be 'false' and for 'Red' the flag will be true
4003
+ * @readonly
4004
+ */
4005
+ inStock?: boolean;
4006
+ /**
4007
+ * Whether at least one variant with this choice is visible.
4008
+ *
4009
+ * Default: `false`
4010
+ * @readonly
4011
+ */
4012
+ visible?: boolean;
4013
+ }
4014
+ /** @oneof */
4015
+ interface ConnectedOptionChoiceValueOneOf {
4016
+ /**
4017
+ * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
4018
+ * @minLength 3
4019
+ * @maxLength 20
4020
+ */
4021
+ colorCode?: string;
4022
+ }
4023
+ declare enum ChoiceType {
4024
+ UNKNOWN_CHOICE_TYPE = "UNKNOWN_CHOICE_TYPE",
4025
+ /** Text choice. */
4026
+ CHOICE_TEXT = "CHOICE_TEXT",
4027
+ /** Single color choice. */
4028
+ ONE_COLOR = "ONE_COLOR",
4029
+ /** Multiple colors choice. */
4030
+ MULTIPLE_COLORS = "MULTIPLE_COLORS",
4031
+ /** Image choice. */
4032
+ IMAGE = "IMAGE"
4033
+ }
4034
+ /** @enumType */
4035
+ type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR' | 'MULTIPLE_COLORS' | 'IMAGE';
4036
+ interface MultipleColors {
4037
+ /**
4038
+ * List of color codes.
4039
+ * @minLength 3
4040
+ * @maxLength 20
4041
+ * @minSize 2
4042
+ * @maxSize 2
4043
+ */
4044
+ colorCodes?: string[];
4045
+ }
4046
+ interface ConnectedModifier extends ConnectedModifierModifierSettingsOneOf {
4047
+ /** Free text modifier settings. */
4048
+ freeTextSettings?: FreeTextSettings;
4049
+ /** Choice settings. */
4050
+ choicesSettings?: ModifierChoicesSettings;
4051
+ /**
4052
+ * ID of a customization with `customizationType: MODIFIER`.
4053
+ * @minLength 1
4054
+ * @maxLength 36
4055
+ */
4056
+ id?: string | null;
4057
+ /**
4058
+ * Modifier title.
4059
+ * @minLength 1
4060
+ * @maxLength 50
4061
+ */
4062
+ name?: string | null;
4063
+ /** Modifier render type. */
4064
+ modifierRenderType?: ModifierRenderTypeWithLiterals;
4065
+ /** Whether customer input is required for this modifier. */
4066
+ mandatory?: boolean;
4067
+ }
4068
+ /** @oneof */
4069
+ interface ConnectedModifierModifierSettingsOneOf {
4070
+ /** Free text modifier settings. */
4071
+ freeTextSettings?: FreeTextSettings;
4072
+ /** Choice settings. */
4073
+ choicesSettings?: ModifierChoicesSettings;
4074
+ }
4075
+ declare enum ModifierRenderType {
4076
+ /** Not implemented. */
4077
+ UNKNOWN_MODIFIER_RENDER_TYPE = "UNKNOWN_MODIFIER_RENDER_TYPE",
4078
+ /** Free text. */
4079
+ FREE_TEXT = "FREE_TEXT",
4080
+ /** Text choices. */
4081
+ TEXT_CHOICES = "TEXT_CHOICES",
4082
+ /** Swatch choices. */
4083
+ SWATCH_CHOICES = "SWATCH_CHOICES"
4084
+ }
4085
+ /** @enumType */
4086
+ type ModifierRenderTypeWithLiterals = ModifierRenderType | 'UNKNOWN_MODIFIER_RENDER_TYPE' | 'FREE_TEXT' | 'TEXT_CHOICES' | 'SWATCH_CHOICES';
4087
+ interface FreeTextSettings {
4088
+ /** Minimum number of characters. */
4089
+ minCharCount?: number;
4090
+ /**
4091
+ * Maximum number of characters.
4092
+ * @max 500
4093
+ */
4094
+ maxCharCount?: number;
4095
+ /**
4096
+ * Default amount to be added to the product's price.
4097
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
4098
+ */
4099
+ defaultAddedPrice?: string | null;
4100
+ /**
4101
+ * Title of the text to be input by the customer.
4102
+ * @minLength 1
4103
+ * @maxLength 150
4104
+ */
4105
+ title?: string;
4106
+ }
4107
+ interface ModifierChoicesSettings {
4108
+ /**
4109
+ * List of modifier choices.
4110
+ * @minSize 1
4111
+ * @maxSize 100
4112
+ * @immutable
4113
+ */
4114
+ choices?: ConnectedModifierChoice[];
4115
+ }
4116
+ interface ConnectedModifierChoice extends ConnectedModifierChoiceValueOneOf {
4117
+ /**
4118
+ * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
4119
+ * @minLength 3
4120
+ * @maxLength 20
4121
+ */
4122
+ colorCode?: string;
4123
+ /**
4124
+ * Choice ID.
4125
+ * @format GUID
4126
+ */
4127
+ choiceId?: string | null;
4128
+ /**
4129
+ * Product media.
4130
+ * @maxSize 100
4131
+ */
4132
+ linkedMedia?: ProductMedia[];
4133
+ /** Choice type. */
4134
+ choiceType?: ChoiceTypeWithLiterals;
4135
+ /**
4136
+ * Modifier key. Used for eCommerce integration.
4137
+ * @readonly
4138
+ * @minLength 1
4139
+ * @maxLength 50
4140
+ */
4141
+ key?: string;
4142
+ /**
4143
+ * Choice name.
4144
+ * @minLength 1
4145
+ * @maxLength 50
4146
+ */
4147
+ name?: string | null;
4148
+ /**
4149
+ * Added price.
4150
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
4151
+ */
4152
+ addedPrice?: string | null;
4153
+ }
4154
+ /** @oneof */
4155
+ interface ConnectedModifierChoiceValueOneOf {
4156
+ /**
4157
+ * Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
4158
+ * @minLength 3
4159
+ * @maxLength 20
4160
+ */
4161
+ colorCode?: string;
4162
+ }
4163
+ interface Brand {
4164
+ /**
4165
+ * Brand ID.
4166
+ * @format GUID
4167
+ */
4168
+ id?: string | null;
4169
+ /**
4170
+ * Brand name.
4171
+ * @maxLength 50
4172
+ */
4173
+ name?: string | null;
4174
+ }
4175
+ interface InfoSection {
4176
+ /**
4177
+ * Info section ID.
4178
+ * @format GUID
4179
+ */
4180
+ id?: string | null;
4181
+ /**
4182
+ * Info section unique name.
4183
+ * > **Note:** Returned only when you pass `"INFO_SECTION"` to the `fields` array in Products API requests.
4184
+ * @maxLength 100
4185
+ */
4186
+ uniqueName?: string | null;
4187
+ /**
4188
+ * Info section title.
4189
+ * > **Note:** Returned only when you pass `"INFO_SECTION"` to the `fields` array in Products API requests.
4190
+ * @minLength 1
4191
+ * @maxLength 50
4192
+ * @readonly
4193
+ */
4194
+ title?: string | null;
4195
+ /**
4196
+ * Info section description using rich content.
4197
+ * > **Note:** Returned only when you pass `"INFO_SECTION_DESCRIPTION"` to the `fields` array in Products API requests.
4198
+ *
4199
+ * <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="indent.emoji.divider.codeBlock.file.gallery.giphy.image.table.link.textHighlight.textColor" exampleid="7dc9240e-d548-417a-abcf-0291b68b4303">
4200
+ * <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a>
4201
+ * </widget>
4202
+ * @readonly
4203
+ */
4204
+ description?: RichContent;
4205
+ /**
4206
+ * Info section description in HTML.
4207
+ *
4208
+ * When provided on create/update, this string must be a valid HTML. It will then be converted to rich content.
4209
+ * `plainDescription` is ignored when value is also passed to the `description` field.
4210
+ * > **Note:** Returned only when you pass `"INFO_SECTION_PLAIN_DESCRIPTION"` to the `fields` array in Products API requests.
4211
+ * @maxLength 16000
4212
+ */
4213
+ plainDescription?: string | null;
4214
+ }
4215
+ interface Ribbon {
4216
+ /**
4217
+ * Ribbon ID.
4218
+ * @minLength 1
4219
+ * @maxLength 36
4220
+ */
4221
+ id?: string | null;
4222
+ /**
4223
+ * Ribbon name.
4224
+ * @maxLength 30
4225
+ */
4226
+ name?: string | null;
4227
+ }
4228
+ interface ProductCategoriesInfo {
4229
+ /**
4230
+ * A list of categories related to product.
4231
+ * @readonly
4232
+ * @maxSize 2000
4233
+ */
4234
+ categories?: ProductCategory[];
4235
+ }
4236
+ interface ProductCategory {
4237
+ /**
4238
+ * Category ID.
4239
+ * @format GUID
4240
+ */
4241
+ id?: string;
4242
+ /**
4243
+ * Index location of the product within the category, which can be utilized for sorting products in a specific category. For detailed instructions on how to set this up, refer to the [Add and arrange products in category](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category) sample flow.
4244
+ * @max 200
4245
+ */
4246
+ index?: number | null;
4247
+ }
4248
+ interface ProductCategoryIdsInfo {
4249
+ /**
4250
+ * A list of category ids related to product.
4251
+ * @readonly
4252
+ * @maxSize 2000
4253
+ * @format GUID
4254
+ */
4255
+ categoryIds?: string[];
4256
+ }
4257
+ interface PriceRange {
4258
+ /** Minimum value. */
4259
+ minValue?: FixedMonetaryAmount;
4260
+ /** Maximum value. */
4261
+ maxValue?: FixedMonetaryAmount;
4262
+ }
4263
+ interface FixedMonetaryAmount {
4264
+ /**
4265
+ * Monetary amount. For example, `"3.99"`, or `"-4.99"` for a negative amount.
4266
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
4267
+ */
4268
+ amount?: string;
4269
+ /**
4270
+ * Formatted monetary amount. For example, `"$3.99"`.
4271
+ * > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
4272
+ * @readonly
4273
+ * @maxLength 20
4274
+ */
4275
+ formattedAmount?: string | null;
4276
+ }
4277
+ interface Inventory {
4278
+ /**
4279
+ * Current availability status.
4280
+ * @readonly
4281
+ */
4282
+ availabilityStatus?: AvailabilityStatusWithLiterals;
4283
+ /**
4284
+ * Current preorder status.
4285
+ * @readonly
4286
+ */
4287
+ preorderStatus?: PreorderStatusWithLiterals;
4288
+ /**
4289
+ * Preorder availability status.
4290
+ * @readonly
4291
+ */
4292
+ preorderAvailability?: ProductPreorderAvailabilityWithLiterals;
4293
+ }
4294
+ declare enum AvailabilityStatus {
4295
+ UNKNOWN_AVAILABILITY_STATUS = "UNKNOWN_AVAILABILITY_STATUS",
4296
+ /** All variants are in stock and available for purchase. */
4297
+ IN_STOCK = "IN_STOCK",
4298
+ /** All variants are out of stock. */
4299
+ OUT_OF_STOCK = "OUT_OF_STOCK",
4300
+ /** Some variants are out of stock and some are in stock and available for purchase. */
4301
+ PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
4302
+ }
4303
+ /** @enumType */
4304
+ type AvailabilityStatusWithLiterals = AvailabilityStatus | 'UNKNOWN_AVAILABILITY_STATUS' | 'IN_STOCK' | 'OUT_OF_STOCK' | 'PARTIALLY_OUT_OF_STOCK';
4305
+ declare enum PreorderStatus {
4306
+ UNKNOWN_PREORDER_STATUS = "UNKNOWN_PREORDER_STATUS",
4307
+ /** All variants are enabled for preorder. */
4308
+ ENABLED = "ENABLED",
4309
+ /** All variants are disabled for preorder. */
4310
+ DISABLED = "DISABLED",
4311
+ /** Some variants are disabled and some are enabled for preorder. */
4312
+ PARTIALLY_ENABLED = "PARTIALLY_ENABLED"
4313
+ }
4314
+ /** @enumType */
4315
+ type PreorderStatusWithLiterals = PreorderStatus | 'UNKNOWN_PREORDER_STATUS' | 'ENABLED' | 'DISABLED' | 'PARTIALLY_ENABLED';
4316
+ declare enum ProductPreorderAvailability {
4317
+ UNKNOWN_PREORDER_AVAILABILITY_STATUS = "UNKNOWN_PREORDER_AVAILABILITY_STATUS",
4318
+ /** All the product variants are available for preorder. */
4319
+ ALL_VARIANTS = "ALL_VARIANTS",
4320
+ /** None of the product variants are available for preorder. */
4321
+ NO_VARIANTS = "NO_VARIANTS",
4322
+ /** Some of the product variants are available for preorder. */
4323
+ SOME_VARIANTS = "SOME_VARIANTS"
4324
+ }
4325
+ /** @enumType */
4326
+ type ProductPreorderAvailabilityWithLiterals = ProductPreorderAvailability | 'UNKNOWN_PREORDER_AVAILABILITY_STATUS' | 'ALL_VARIANTS' | 'NO_VARIANTS' | 'SOME_VARIANTS';
4327
+ declare enum ProductType {
4328
+ /** Not implemented. */
4329
+ UNKNOWN_PRODUCT_TYPE = "UNKNOWN_PRODUCT_TYPE",
4330
+ /** Physical product. */
4331
+ PHYSICAL = "PHYSICAL",
4332
+ /** Digital product. */
4333
+ DIGITAL = "DIGITAL"
4334
+ }
4335
+ /** @enumType */
4336
+ type ProductTypeWithLiterals = ProductType | 'UNKNOWN_PRODUCT_TYPE' | 'PHYSICAL' | 'DIGITAL';
4337
+ interface PhysicalProperties {
4338
+ /**
4339
+ * Price per unit settings.
4340
+ * > **Note:** Use this field only when relevant. For example, for products that are sold by weight, volume, or length.
4341
+ */
4342
+ pricePerUnit?: PricePerUnitSettings;
4343
+ /**
4344
+ * Fulfiller ID.
4345
+ * @format GUID
4346
+ */
4347
+ fulfillerId?: string | null;
4348
+ /**
4349
+ * Product shipping weight range - Calculated from the lightest and heaviest variant shipping weights.
4350
+ * @readonly
4351
+ */
4352
+ shippingWeightRange?: WeightRange;
4353
+ /**
4354
+ * Product price per unit range. The minimum and maximum price per unit of all the variants.
4355
+ * @readonly
4356
+ */
4357
+ pricePerUnitRange?: PricePerUnitRange;
4358
+ /**
4359
+ * Weight measurement unit.
4360
+ * > **Note:** Returned only when you pass `"WEIGHT_MEASUREMENT_UNIT_INFO"` to the `fields` array in Products API requests.
4361
+ * @readonly
4362
+ */
4363
+ weightMeasurementUnitInfo?: WeightMeasurementUnitInfo;
4364
+ /**
4365
+ * Delivery profile ID.
4366
+ * @format GUID
4367
+ */
4368
+ deliveryProfileId?: string | null;
4369
+ }
4370
+ interface PricePerUnitSettings {
4371
+ /**
4372
+ * Quantity.
4373
+ * For example, to define price per per 100 grams, set this field to `100`.
4374
+ * @min 0.01
4375
+ * @max 999999999.99
4376
+ */
4377
+ quantity?: number;
4378
+ /**
4379
+ * Measurement unit.
4380
+ * For example, to define price per 100 grams, set this field to "G".
4381
+ */
4382
+ measurementUnit?: MeasurementUnitWithLiterals;
4383
+ }
4384
+ interface WeightRange {
4385
+ /**
4386
+ * Minimum weight across all variants associated with this product.
4387
+ * @max 999999999.99
4388
+ */
4389
+ minValue?: number;
4390
+ /**
4391
+ * Maximum weight across all variants associated with this product.
4392
+ * @max 999999999.99
4393
+ */
4394
+ maxValue?: number;
4395
+ }
4396
+ interface PricePerUnitRange {
4397
+ /** Minimum price per unit across all variants. */
4398
+ minValue?: PricePerUnitRangePricePerUnit;
4399
+ /** Maximum price per unit across all variants. */
4400
+ maxValue?: PricePerUnitRangePricePerUnit;
4401
+ }
4402
+ interface PricePerUnitRangePricePerUnit {
4403
+ /**
4404
+ * Calculated value of price per unit. Takes into account pricePerUnit settings of product and variants and price of variants.
4405
+ * 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$).
4406
+ * @readonly
4407
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
4408
+ */
4409
+ value?: string;
4410
+ /**
4411
+ * Price per unit info in the format of variant specific data / product setting, for example €4.00 / 1 Kg.
4412
+ * > **Note:** This field is returned by the API only when you pass `fields: "CURRENCY"` in a request.
4413
+ * @readonly
4414
+ * @maxLength 100
4415
+ */
4416
+ description?: string | null;
4417
+ }
4418
+ interface WeightMeasurementUnitInfo {
4419
+ /**
4420
+ * Weight measurement unit.
4421
+ * @readonly
4422
+ */
4423
+ weightMeasurementUnit?: WeightUnitWithLiterals;
4424
+ }
4425
+ interface BreadcrumbsInfo {
4426
+ /**
4427
+ * Breadcrumbs.
4428
+ * @readonly
4429
+ * @maxSize 5
4430
+ */
4431
+ breadcrumbs?: BreadCrumb[];
4432
+ }
4433
+ interface BreadCrumb {
4434
+ /**
4435
+ * Category ID.
4436
+ * @format GUID
4437
+ */
4438
+ categoryId?: string;
4439
+ /**
4440
+ * Category name.
4441
+ * @minLength 1
4442
+ * @maxLength 80
4443
+ */
4444
+ categoryName?: string;
4445
+ /**
4446
+ * Category slug.
4447
+ * @minLength 1
4448
+ * @maxLength 100
4449
+ */
4450
+ categorySlug?: string;
4451
+ }
4452
+ interface VariantsInfo {
4453
+ /**
4454
+ * List of related variants.
4455
+ * @minSize 1
4456
+ * @maxSize 1000
4457
+ */
4458
+ variants?: Variant[];
4459
+ }
4460
+ interface Variant extends VariantTypedPropertiesOneOf {
4461
+ /** Physical properties. Must be passed when `productType: PHYSICAL` */
4462
+ physicalProperties?: VariantPhysicalProperties;
4463
+ /** Digital properties. Must be passed when `productType: DIGITAL` */
4464
+ digitalProperties?: VariantDigitalProperties;
4465
+ /**
4466
+ * Variant ID.
4467
+ * @format GUID
4468
+ * @immutable
4469
+ */
4470
+ id?: string | null;
4471
+ /**
4472
+ * Whether the variant is visible to site visitors.
4473
+ *
4474
+ * Default: `true`
4475
+ */
4476
+ visible?: boolean | null;
4477
+ /**
4478
+ * Variant SKU (stock keeping unit).
4479
+ * @minLength 1
4480
+ * @maxLength 40
4481
+ */
4482
+ sku?: string | null;
4483
+ /**
4484
+ * Variant barcode.
4485
+ * @minLength 1
4486
+ * @maxLength 40
4487
+ */
4488
+ barcode?: string | null;
4489
+ /**
4490
+ * List of choices that define the product's variant, which requires exactly one choice per product option.
4491
+ * Must use `optionChoiceNames` in all requests this field is required.
4492
+ * Empty only for default variants of unmanaged products.
4493
+ * @maxSize 6
4494
+ * @immutable
4495
+ */
4496
+ choices?: OptionChoice[];
4497
+ /** Variant price. */
4498
+ price?: PriceInfo;
4499
+ /**
4500
+ * Variant revenue details.
4501
+ *
4502
+ * > **Note:** Returned only when the following conditions are met:
4503
+ * > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests.
4504
+ * > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
4505
+ */
4506
+ revenueDetails?: RevenueDetails;
4507
+ /**
4508
+ * Variant media.
4509
+ * @readonly
4510
+ */
4511
+ media?: ProductMedia;
4512
+ /**
4513
+ * Subscription prices calculated by applying subscription discount to the variant `price.actual_price`.
4514
+ * > **Note:** Returned only when you pass `"SUBSCRIPTION_PRICES_INFO"` to the `fields` array in Products API requests.
4515
+ * @readonly
4516
+ */
4517
+ subscriptionPricesInfo?: SubscriptionPricesInfo;
4518
+ /**
4519
+ * Variant inventory status.
4520
+ * @readonly
4521
+ */
4522
+ inventoryStatus?: InventoryStatus;
4523
+ }
4524
+ /** @oneof */
4525
+ interface VariantTypedPropertiesOneOf {
4526
+ /** Physical properties. Must be passed when `productType: PHYSICAL` */
4527
+ physicalProperties?: VariantPhysicalProperties;
4528
+ /** Digital properties. Must be passed when `productType: DIGITAL` */
4529
+ digitalProperties?: VariantDigitalProperties;
4530
+ }
4531
+ interface OptionChoice {
4532
+ /** Option and choice IDs. These match the IDs of the option and choice from the product's options field. */
4533
+ optionChoiceIds?: OptionChoiceIds;
4534
+ /**
4535
+ * Option and choice names.
4536
+ * This needs to be used in all requests `OptionChoice` is needed, and all `OptionChoiceNames` fields are required.
4537
+ * > **Note:** Returned only when you pass `"VARIANT_OPTION_CHOICE_NAMES"` to the `fields` array in Products API requests.
4538
+ */
4539
+ optionChoiceNames?: OptionChoiceNames;
4540
+ }
4541
+ interface OptionChoiceIds {
4542
+ /**
4543
+ * Option ID.
4544
+ * @minLength 1
4545
+ * @maxLength 36
4546
+ * @immutable
4547
+ */
4548
+ optionId?: string;
4549
+ /**
4550
+ * Choice ID.
4551
+ * @format GUID
4552
+ * @immutable
4553
+ */
4554
+ choiceId?: string;
4555
+ }
4556
+ interface OptionChoiceNames {
4557
+ /**
4558
+ * Option name.
4559
+ * @minLength 1
4560
+ */
4561
+ optionName?: string;
4562
+ /**
4563
+ * Choice name.
4564
+ * @minLength 1
4565
+ */
4566
+ choiceName?: string;
4567
+ /** Render type. */
4568
+ renderType?: ProductOptionRenderTypeWithLiterals;
4569
+ }
4570
+ interface PriceInfo {
4571
+ /** Variant price. Must be greater or equal to 0. */
4572
+ actualPrice?: FixedMonetaryAmount;
4573
+ /** 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. */
4574
+ compareAtPrice?: FixedMonetaryAmount;
4575
+ }
4576
+ interface RevenueDetails {
4577
+ /** Item cost. */
4578
+ cost?: FixedMonetaryAmount;
4579
+ /**
4580
+ * Profit. Calculated by reducing `cost` from `discountedPrice`.
4581
+ * @readonly
4582
+ */
4583
+ profit?: FixedMonetaryAmount;
4584
+ /**
4585
+ * Profit Margin. Calculated by dividing `profit` by `discountedPrice`.
4586
+ * The result is rounded to 4 decimal places.
4587
+ * @readonly
4588
+ * @max 1
4589
+ */
4590
+ profitMargin?: number;
4591
+ }
4592
+ interface VariantPhysicalProperties {
4593
+ /**
4594
+ * Variant shipping weight.
4595
+ * product.physicalProperties.shipping_weight_range values are taken from here.
4596
+ * @max 999999999.99
4597
+ */
4598
+ weight?: number | null;
4599
+ /**
4600
+ * Price per unit info, in order to show price per unit on the product page.
4601
+ * For example if one sells cheese and defines 100g here then we know that buying this variant buyer receives 100g of cheese.
4602
+ * But on product page price will be displayed for units defined on product level. See `pricePerUnit.value` to understand how it's calculated.
4603
+ */
4604
+ pricePerUnit?: PricePerUnit;
4605
+ }
4606
+ interface PricePerUnit {
4607
+ /**
4608
+ * Price per unit data for this variant.
4609
+ * `measurementUnit` value must correspond to the measurement unit set on the product.
4610
+ */
4611
+ settings?: PricePerUnitSettings;
4612
+ /**
4613
+ * Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant.
4614
+ * 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$).
4615
+ * @readonly
4616
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
4617
+ */
4618
+ value?: string;
4619
+ /**
4620
+ * Price per unit description.
4621
+ * > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
4622
+ * @readonly
4623
+ * @maxLength 100
4624
+ */
4625
+ description?: string | null;
4626
+ }
4627
+ interface VariantDigitalProperties {
4628
+ /** Digital file which will be downloaded by customer after successful purchase. */
4629
+ digitalFile?: SecuredMedia;
4630
+ }
4631
+ interface SecuredMedia {
4632
+ /**
4633
+ * Media ID in media manager.
4634
+ * @minLength 1
4635
+ * @maxLength 100
4636
+ */
4637
+ id?: string;
4638
+ /**
4639
+ * Original file name.
4640
+ * @minLength 1
4641
+ * @maxLength 1000
4642
+ * @readonly
4643
+ */
4644
+ fileName?: string;
4645
+ /**
4646
+ * Original file size.
4647
+ * @minLength 1
4648
+ * @maxLength 1000
4649
+ * @readonly
4650
+ * @format DECIMAL_VALUE
4651
+ * @decimalValue options { maxScale:0 }
4652
+ */
4653
+ fileSize?: string | null;
4654
+ /**
4655
+ * File type.
4656
+ * @readonly
4657
+ */
4658
+ fileType?: FileTypeWithLiterals;
4659
+ }
4660
+ declare enum FileType {
4661
+ /** Unspecified file type. */
4662
+ UNSPECIFIED = "UNSPECIFIED",
4663
+ /** Secure picture file. */
4664
+ SECURE_PICTURE = "SECURE_PICTURE",
4665
+ /** Secure video file. */
4666
+ SECURE_VIDEO = "SECURE_VIDEO",
4667
+ /** Secure document file. */
4668
+ SECURE_DOCUMENT = "SECURE_DOCUMENT",
4669
+ /** Secure music file. */
4670
+ SECURE_MUSIC = "SECURE_MUSIC",
4671
+ /** Secure archive file. */
4672
+ SECURE_ARCHIVE = "SECURE_ARCHIVE"
4673
+ }
4674
+ /** @enumType */
4675
+ type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
4676
+ interface SubscriptionPricesInfo {
4677
+ /**
4678
+ * Subscription prices.
4679
+ * @maxSize 6
4680
+ */
4681
+ subscriptionPrices?: SubscriptionPrice[];
4682
+ }
4683
+ interface SubscriptionPrice {
4684
+ /**
4685
+ * Subscription ID.
4686
+ * @format GUID
4687
+ * @readonly
4688
+ */
4689
+ subscriptionId?: string;
4690
+ /**
4691
+ * Subscription price calculated by applying subscription discount to the variant `price.actual_price`
4692
+ * @readonly
4693
+ */
4694
+ price?: FixedMonetaryAmount;
4695
+ /**
4696
+ * Price per unit info.
4697
+ * @readonly
4698
+ */
4699
+ pricePerUnit?: SubscriptionPricePerUnit;
4700
+ }
4701
+ interface SubscriptionPricePerUnit {
4702
+ /**
4703
+ * Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.
4704
+ * @readonly
4705
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
4706
+ */
4707
+ value?: string;
4708
+ /**
4709
+ * Price per unit description.
4710
+ * > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
4711
+ * @readonly
4712
+ * @maxLength 20
4713
+ */
4714
+ description?: string | null;
4715
+ }
4716
+ interface InventoryStatus {
4717
+ /** Whether the variant is in stock. */
4718
+ inStock?: boolean;
4719
+ /** Whether preorder is enabled for this variant. */
4720
+ preorderEnabled?: boolean;
4721
+ }
4722
+ interface ExtendedFields {
4723
+ /**
4724
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
4725
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
4726
+ *
4727
+ * You can only access fields for which you have the appropriate permissions.
4728
+ *
4729
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
4730
+ */
4731
+ namespaces?: Record<string, Record<string, any>>;
4732
+ }
4733
+ interface SubscriptionDetails {
4734
+ /**
4735
+ * Subscriptions.
4736
+ * @minSize 1
4737
+ * @maxSize 6
4738
+ */
4739
+ subscriptions?: Subscription[];
4740
+ /**
4741
+ * Whether to allow one-time purchases in addition to subscription-based purchases.
4742
+ *
4743
+ * Default: `false`
4744
+ */
4745
+ allowOneTimePurchases?: boolean | null;
4746
+ }
4747
+ interface Subscription extends SubscriptionCyclesOneOf {
4748
+ /** Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`. */
4749
+ autoRenewal?: boolean;
4750
+ /**
4751
+ * Number of billing cycles before subscription ends.
4752
+ * @min 2
4753
+ * @max 999
4754
+ */
4755
+ billingCycles?: number;
4756
+ /**
4757
+ * Subscription ID.
4758
+ * @format GUID
4759
+ * @immutable
4760
+ */
4761
+ id?: string | null;
4762
+ /**
4763
+ * Subscription title.
4764
+ * @minLength 1
4765
+ * @maxLength 20
4766
+ */
4767
+ title?: string;
4768
+ /**
4769
+ * Subscription description.
4770
+ * @maxLength 60
4771
+ */
4772
+ description?: string | null;
4773
+ /**
4774
+ * Whether the subscription is visible to site visitors.
4775
+ *
4776
+ * Default: `true`
4777
+ */
4778
+ visible?: boolean | null;
4779
+ /**
4780
+ * Frequency of recurring payment.
4781
+ * For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.
4782
+ */
4783
+ frequency?: SubscriptionFrequencyWithLiterals;
4784
+ /**
4785
+ * Interval of recurring payment. Default: `1`. For example, if `frequency: MONTH`, `billingCycles: 3` and `interval: 2`; payment will be made every 2 months for a total of 6 months.
4786
+ * @min 1
4787
+ * @max 50
4788
+ */
4789
+ interval?: number | null;
4790
+ /**
4791
+ * Discount info (optional).
4792
+ * For example, a $20 discount would be `amount: 20`, `type: AMOUNT`.
4793
+ */
4794
+ discount?: SubscriptionDiscount;
4795
+ }
4796
+ /** @oneof */
4797
+ interface SubscriptionCyclesOneOf {
4798
+ /** Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`. */
4799
+ autoRenewal?: boolean;
4800
+ /**
4801
+ * Number of billing cycles before subscription ends.
4802
+ * @min 2
4803
+ * @max 999
4804
+ */
4805
+ billingCycles?: number;
4806
+ }
4807
+ /** Frequency unit of recurring payment */
4808
+ declare enum SubscriptionFrequency {
4809
+ UNDEFINED = "UNDEFINED",
4810
+ DAY = "DAY",
4811
+ WEEK = "WEEK",
4812
+ MONTH = "MONTH",
4813
+ YEAR = "YEAR"
4814
+ }
4815
+ /** @enumType */
4816
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
4817
+ interface SubscriptionDiscount extends SubscriptionDiscountDiscountOneOf {
4818
+ /**
4819
+ * Amount to discount from the variant discounted_price.
4820
+ * @decimalValue options { gt:0, lte:999999999, maxScale:3 }
4821
+ */
4822
+ amountOff?: string;
4823
+ /**
4824
+ * Percentage to discount from variant discounted_price.
4825
+ * @min 0.1
4826
+ * @max 99.9
4827
+ */
4828
+ percentOff?: number;
4829
+ /** Discount type. */
4830
+ type?: DiscountTypeWithLiterals;
4831
+ }
4832
+ /** @oneof */
4833
+ interface SubscriptionDiscountDiscountOneOf {
4834
+ /**
4835
+ * Amount to discount from the variant discounted_price.
4836
+ * @decimalValue options { gt:0, lte:999999999, maxScale:3 }
4837
+ */
4838
+ amountOff?: string;
4839
+ /**
4840
+ * Percentage to discount from variant discounted_price.
4841
+ * @min 0.1
4842
+ * @max 99.9
4843
+ */
4844
+ percentOff?: number;
4845
+ }
4846
+ declare enum DiscountType {
4847
+ UNKNOWN_DISCOUNT = "UNKNOWN_DISCOUNT",
4848
+ /** Discount by a specific amount. */
4849
+ AMOUNT = "AMOUNT",
4850
+ /** Discount by a percentage. */
4851
+ PERCENT = "PERCENT"
4852
+ }
4853
+ /** @enumType */
4854
+ type DiscountTypeWithLiterals = DiscountType | 'UNKNOWN_DISCOUNT' | 'AMOUNT' | 'PERCENT';
4855
+ interface VariantSummary {
4856
+ /**
4857
+ * The total number of variants for the product.
4858
+ * @readonly
4859
+ */
4860
+ variantCount?: number;
4861
+ }
4862
+ interface MinVariantPriceInfo {
4863
+ /**
4864
+ * Subscription price calculated by applying subscription discount to the variant `price.actualPrice`
4865
+ * @readonly
4866
+ */
4867
+ minSubscriptionPrice?: FixedMonetaryAmount;
4868
+ /**
4869
+ * Subscription price per unit calculated value of price per unit.
4870
+ * Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.
4871
+ * @readonly
4872
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
4873
+ */
4874
+ minSubscriptionPricePerUnit?: string | null;
4875
+ /**
4876
+ * Variant price per unit.
4877
+ * @readonly
4878
+ */
4879
+ pricePerUnitData?: PricePerUnit;
4880
+ /**
4881
+ * Variant SKU (stock keeping unit).
4882
+ * @readonly
4883
+ * @minLength 1
4884
+ * @maxLength 40
4885
+ */
4886
+ sku?: string | null;
4887
+ /**
4888
+ * Variant shipping weight.
4889
+ * @readonly
4890
+ * @max 999999999.99
4891
+ */
4892
+ weight?: number | null;
4893
+ /**
4894
+ * Variant revenue details.
4895
+ *
4896
+ * > **Note:** Returned only when the following conditions are met:
4897
+ * > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests.
4898
+ * > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
4899
+ * @readonly
4900
+ */
4901
+ revenueDetails?: RevenueDetails;
4902
+ /** Variant price. Must be greater or equal to 0. */
4903
+ actualPrice?: FixedMonetaryAmount;
4904
+ /** 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. */
4905
+ compareAtPrice?: FixedMonetaryAmount;
4906
+ }
4907
+ interface MigrateProductVariantsResponse {
4908
+ }
4909
+ interface RecoverProductVariantsRequest {
4910
+ }
4911
+ interface RecoverProductVariantsResponse {
4912
+ }
4913
+ interface DomainEvent extends DomainEventBodyOneOf {
4914
+ createdEvent?: EntityCreatedEvent;
4915
+ updatedEvent?: EntityUpdatedEvent;
4916
+ deletedEvent?: EntityDeletedEvent;
4917
+ actionEvent?: ActionEvent;
4918
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
4919
+ id?: string;
4920
+ /**
4921
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
4922
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
4923
+ */
4924
+ entityFqdn?: string;
4925
+ /**
4926
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
4927
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
4928
+ */
4929
+ slug?: string;
4930
+ /** ID of the entity associated with the event. */
4931
+ entityId?: string;
4932
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
4933
+ eventTime?: Date | null;
4934
+ /**
4935
+ * Whether the event was triggered as a result of a privacy regulation application
4936
+ * (for example, GDPR).
4937
+ */
4938
+ triggeredByAnonymizeRequest?: boolean | null;
4939
+ /** If present, indicates the action that triggered the event. */
4940
+ originatedFrom?: string | null;
4941
+ /**
4942
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
4943
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
4944
+ */
4945
+ entityEventSequence?: string | null;
4946
+ }
4947
+ /** @oneof */
4948
+ interface DomainEventBodyOneOf {
4949
+ createdEvent?: EntityCreatedEvent;
4950
+ updatedEvent?: EntityUpdatedEvent;
4951
+ deletedEvent?: EntityDeletedEvent;
4952
+ actionEvent?: ActionEvent;
4953
+ }
4954
+ interface EntityCreatedEvent {
4955
+ entityAsJson?: string;
4956
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
4957
+ restoreInfo?: RestoreInfo;
4958
+ }
4959
+ interface RestoreInfo {
4960
+ deletedDate?: Date | null;
4961
+ }
4962
+ interface EntityUpdatedEvent {
4963
+ /**
4964
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
4965
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
4966
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
4967
+ */
4968
+ currentEntityAsJson?: string;
4969
+ }
4970
+ interface EntityDeletedEvent {
4971
+ /** Entity that was deleted. */
4972
+ deletedEntityAsJson?: string | null;
4973
+ }
4974
+ interface ActionEvent {
4975
+ bodyAsJson?: string;
4976
+ }
4977
+ interface Empty {
4978
+ }
4979
+ interface MessageEnvelope {
4980
+ /**
4981
+ * App instance ID.
4982
+ * @format GUID
4983
+ */
4984
+ instanceId?: string | null;
4985
+ /**
4986
+ * Event type.
4987
+ * @maxLength 150
4988
+ */
4989
+ eventType?: string;
4990
+ /** The identification type and identity data. */
4991
+ identity?: IdentificationData;
4992
+ /** Stringify payload. */
4993
+ data?: string;
4994
+ }
4995
+ interface IdentificationData extends IdentificationDataIdOneOf {
4996
+ /**
4997
+ * ID of a site visitor that has not logged in to the site.
4998
+ * @format GUID
4999
+ */
5000
+ anonymousVisitorId?: string;
5001
+ /**
5002
+ * ID of a site visitor that has logged in to the site.
5003
+ * @format GUID
5004
+ */
5005
+ memberId?: string;
5006
+ /**
5007
+ * ID of a Wix user (site owner, contributor, etc.).
5008
+ * @format GUID
5009
+ */
5010
+ wixUserId?: string;
5011
+ /**
5012
+ * ID of an app.
5013
+ * @format GUID
5014
+ */
5015
+ appId?: string;
5016
+ /** @readonly */
5017
+ identityType?: WebhookIdentityTypeWithLiterals;
5018
+ }
5019
+ /** @oneof */
5020
+ interface IdentificationDataIdOneOf {
5021
+ /**
5022
+ * ID of a site visitor that has not logged in to the site.
5023
+ * @format GUID
5024
+ */
5025
+ anonymousVisitorId?: string;
5026
+ /**
5027
+ * ID of a site visitor that has logged in to the site.
5028
+ * @format GUID
5029
+ */
5030
+ memberId?: string;
5031
+ /**
5032
+ * ID of a Wix user (site owner, contributor, etc.).
5033
+ * @format GUID
5034
+ */
5035
+ wixUserId?: string;
5036
+ /**
5037
+ * ID of an app.
5038
+ * @format GUID
5039
+ */
5040
+ appId?: string;
5041
+ }
5042
+ declare enum WebhookIdentityType {
5043
+ UNKNOWN = "UNKNOWN",
5044
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
5045
+ MEMBER = "MEMBER",
5046
+ WIX_USER = "WIX_USER",
5047
+ APP = "APP"
5048
+ }
5049
+ /** @enumType */
5050
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1363
5051
 
1364
5052
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
1365
5053
  getUrl: (context: any) => string;
@@ -1374,4 +5062,4 @@ type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q
1374
5062
  declare function queryVariants(): __PublicMethodMetaInfo<'POST', {}, QueryVariantsRequest$1, QueryVariantsRequest, QueryVariantsResponse$1, QueryVariantsResponse>;
1375
5063
  declare function searchVariants(): __PublicMethodMetaInfo<'POST', {}, SearchVariantsRequest$1, SearchVariantsRequest, SearchVariantsResponse$1, SearchVariantsResponse>;
1376
5064
 
1377
- export { type __PublicMethodMetaInfo, queryVariants, searchVariants };
5065
+ export { type ActionEvent as ActionEventOriginal, type AggregationData as AggregationDataOriginal, type AggregationDateHistogramAggregation as AggregationDateHistogramAggregationOriginal, type AggregationKindOneOf as AggregationKindOneOfOriginal, type AggregationNestedAggregation as AggregationNestedAggregationOriginal, type Aggregation as AggregationOriginal, type AggregationRangeAggregation as AggregationRangeAggregationOriginal, type AggregationResults as AggregationResultsOriginal, type AggregationResultsResultOneOf as AggregationResultsResultOneOfOriginal, type AggregationResultsScalarResult as AggregationResultsScalarResultOriginal, type AggregationScalarAggregation as AggregationScalarAggregationOriginal, AggregationType as AggregationTypeOriginal, type AggregationTypeWithLiterals as AggregationTypeWithLiteralsOriginal, type AggregationValueAggregationOptionsOneOf as AggregationValueAggregationOptionsOneOfOriginal, type AggregationValueAggregation as AggregationValueAggregationOriginal, Alignment as AlignmentOriginal, type AlignmentWithLiterals as AlignmentWithLiteralsOriginal, type AnchorData as AnchorDataOriginal, type AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOfOriginal, type AppEmbedData as AppEmbedDataOriginal, AppType as AppTypeOriginal, type AppTypeWithLiterals as AppTypeWithLiteralsOriginal, AspectRatio as AspectRatioOriginal, type AspectRatioWithLiterals as AspectRatioWithLiteralsOriginal, type AudioData as AudioDataOriginal, AvailabilityStatus as AvailabilityStatusOriginal, type AvailabilityStatusWithLiterals as AvailabilityStatusWithLiteralsOriginal, type BackgroundBackgroundOneOf as BackgroundBackgroundOneOfOriginal, type Background as BackgroundOriginal, BackgroundType as BackgroundTypeOriginal, type BackgroundTypeWithLiterals as BackgroundTypeWithLiteralsOriginal, type BlockquoteData as BlockquoteDataOriginal, type BookingData as BookingDataOriginal, type BorderColors as BorderColorsOriginal, type Border as BorderOriginal, type Brand as BrandOriginal, type BreadCrumb as BreadCrumbOriginal, type BreadcrumbsInfo as BreadcrumbsInfoOriginal, type BulletedListData as BulletedListDataOriginal, type ButtonData as ButtonDataOriginal, ButtonDataType as ButtonDataTypeOriginal, type ButtonDataTypeWithLiterals as ButtonDataTypeWithLiteralsOriginal, type ButtonStyles as ButtonStylesOriginal, type CaptionData as CaptionDataOriginal, type CardStyles as CardStylesOriginal, type CellStyle as CellStyleOriginal, ChoiceType as ChoiceTypeOriginal, type ChoiceTypeWithLiterals as ChoiceTypeWithLiteralsOriginal, type ChoicesSettings as ChoicesSettingsOriginal, type CodeBlockData as CodeBlockDataOriginal, type CollapsibleListData as CollapsibleListDataOriginal, type ColorData as ColorDataOriginal, type Colors as ColorsOriginal, type CommonAggregationKindOneOf as CommonAggregationKindOneOfOriginal, type CommonAggregation as CommonAggregationOriginal, CommonAggregationType as CommonAggregationTypeOriginal, type CommonAggregationTypeWithLiterals as CommonAggregationTypeWithLiteralsOriginal, type CommonImage as CommonImageOriginal, CommonScalarType as CommonScalarTypeOriginal, type CommonScalarTypeWithLiterals as CommonScalarTypeWithLiteralsOriginal, type CommonSearchDetails as CommonSearchDetailsOriginal, CommonSortOrder as CommonSortOrderOriginal, type CommonSortOrderWithLiterals as CommonSortOrderWithLiteralsOriginal, type CommonSorting as CommonSortingOriginal, type CommonVideoResolution as CommonVideoResolutionOriginal, type CommonVideoV2 as CommonVideoV2Original, type ConnectedModifierChoice as ConnectedModifierChoiceOriginal, type ConnectedModifierChoiceValueOneOf as ConnectedModifierChoiceValueOneOfOriginal, type ConnectedModifierModifierSettingsOneOf as ConnectedModifierModifierSettingsOneOfOriginal, type ConnectedModifier as ConnectedModifierOriginal, type ConnectedOptionChoice as ConnectedOptionChoiceOriginal, type ConnectedOptionChoiceValueOneOf as ConnectedOptionChoiceValueOneOfOriginal, type ConnectedOptionOptionSettingsOneOf as ConnectedOptionOptionSettingsOneOfOriginal, type ConnectedOption as ConnectedOptionOriginal, Crop as CropOriginal, type CropWithLiterals as CropWithLiteralsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, DateHistogramAggregationInterval as DateHistogramAggregationIntervalOriginal, type DateHistogramAggregationIntervalWithLiterals as DateHistogramAggregationIntervalWithLiteralsOriginal, type DateHistogramAggregation as DateHistogramAggregationOriginal, type DateHistogramResult as DateHistogramResultOriginal, type DateHistogramResults as DateHistogramResultsOriginal, type DecorationDataOneOf as DecorationDataOneOfOriginal, type Decoration as DecorationOriginal, DecorationType as DecorationTypeOriginal, type DecorationTypeWithLiterals as DecorationTypeWithLiteralsOriginal, type DeprecatedSearchVariantsWithOffsetRequest as DeprecatedSearchVariantsWithOffsetRequestOriginal, type DeprecatedSearchVariantsWithOffsetResponse as DeprecatedSearchVariantsWithOffsetResponseOriginal, type Design as DesignOriginal, type Dimensions as DimensionsOriginal, Direction as DirectionOriginal, type DirectionWithLiterals as DirectionWithLiteralsOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, DividerDataAlignment as DividerDataAlignmentOriginal, type DividerDataAlignmentWithLiterals as DividerDataAlignmentWithLiteralsOriginal, type DividerData as DividerDataOriginal, type DocumentStyle as DocumentStyleOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EmbedData as EmbedDataOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EventData as EventDataOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FileData as FileDataOriginal, type FileSourceDataOneOf as FileSourceDataOneOfOriginal, type FileSource as FileSourceOriginal, FileType as FileTypeOriginal, type FileTypeWithLiterals as FileTypeWithLiteralsOriginal, type FixedMonetaryAmount as FixedMonetaryAmountOriginal, type FontSizeData as FontSizeDataOriginal, FontType as FontTypeOriginal, type FontTypeWithLiterals as FontTypeWithLiteralsOriginal, type FreeTextSettings as FreeTextSettingsOriginal, type GIFData as GIFDataOriginal, type GIF as GIFOriginal, GIFType as GIFTypeOriginal, type GIFTypeWithLiterals as GIFTypeWithLiteralsOriginal, type GalleryData as GalleryDataOriginal, type GalleryOptionsLayout as GalleryOptionsLayoutOriginal, type GalleryOptions as GalleryOptionsOriginal, type Gradient as GradientOriginal, type GroupByAggregationKindOneOf as GroupByAggregationKindOneOfOriginal, type GroupByAggregation as GroupByAggregationOriginal, type GroupByValueResults as GroupByValueResultsOriginal, type HTMLDataDataOneOf as HTMLDataDataOneOfOriginal, type HTMLData as HTMLDataOriginal, type HeadingData as HeadingDataOriginal, type Height as HeightOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ImageData as ImageDataOriginal, type ImageDataStyles as ImageDataStylesOriginal, type Image as ImageOriginal, type ImageStyles as ImageStylesOriginal, type IncludeMissingValuesOptions as IncludeMissingValuesOptionsOriginal, type InfoSection as InfoSectionOriginal, InitialExpandedItems as InitialExpandedItemsOriginal, type InitialExpandedItemsWithLiterals as InitialExpandedItemsWithLiteralsOriginal, type InternalMetadata as InternalMetadataOriginal, InternalRowState as InternalRowStateOriginal, type InternalRowStateWithLiterals as InternalRowStateWithLiteralsOriginal, Interval as IntervalOriginal, type IntervalWithLiterals as IntervalWithLiteralsOriginal, type Inventory as InventoryOriginal, type InventoryStatus as InventoryStatusOriginal, type ItemDataOneOf as ItemDataOneOfOriginal, type ItemImage as ItemImageOriginal, type Item as ItemOriginal, type ItemStyle as ItemStyleOriginal, type Keyword as KeywordOriginal, type LayoutCellData as LayoutCellDataOriginal, Layout as LayoutOriginal, LayoutType as LayoutTypeOriginal, type LayoutTypeWithLiterals as LayoutTypeWithLiteralsOriginal, type LayoutWithLiterals as LayoutWithLiteralsOriginal, LineStyle as LineStyleOriginal, type LineStyleWithLiterals as LineStyleWithLiteralsOriginal, type LinkDataOneOf as LinkDataOneOfOriginal, type LinkData as LinkDataOriginal, type Link as LinkOriginal, type LinkPreviewData as LinkPreviewDataOriginal, type LinkPreviewDataStyles as LinkPreviewDataStylesOriginal, type ListValue as ListValueOriginal, type MapData as MapDataOriginal, type MapSettings as MapSettingsOriginal, MapType as MapTypeOriginal, type MapTypeWithLiterals as MapTypeWithLiteralsOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MediaItemsInfo as MediaItemsInfoOriginal, type Media as MediaOriginal, MediaType as MediaTypeOriginal, type MediaTypeWithLiterals as MediaTypeWithLiteralsOriginal, type MentionData as MentionDataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Metadata as MetadataOriginal, type MigrateProductVariantsRequest as MigrateProductVariantsRequestOriginal, type MigrateProductVariantsResponse as MigrateProductVariantsResponseOriginal, type MinVariantPriceInfo as MinVariantPriceInfoOriginal, MissingValues as MissingValuesOriginal, type MissingValuesWithLiterals as MissingValuesWithLiteralsOriginal, Mode as ModeOriginal, type ModeWithLiterals as ModeWithLiteralsOriginal, type ModifierChoicesSettings as ModifierChoicesSettingsOriginal, ModifierRenderType as ModifierRenderTypeOriginal, type ModifierRenderTypeWithLiterals as ModifierRenderTypeWithLiteralsOriginal, type MultipleColors as MultipleColorsOriginal, type NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOfOriginal, type NestedAggregationItem as NestedAggregationItemOriginal, type NestedAggregationNestedAggregationItemKindOneOf as NestedAggregationNestedAggregationItemKindOneOfOriginal, type NestedAggregationNestedAggregationItem as NestedAggregationNestedAggregationItemOriginal, NestedAggregationNestedAggregationType as NestedAggregationNestedAggregationTypeOriginal, type NestedAggregationNestedAggregationTypeWithLiterals as NestedAggregationNestedAggregationTypeWithLiteralsOriginal, type NestedAggregation as NestedAggregationOriginal, type NestedAggregationResults as NestedAggregationResultsOriginal, type NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOfOriginal, NestedAggregationType as NestedAggregationTypeOriginal, type NestedAggregationTypeWithLiterals as NestedAggregationTypeWithLiteralsOriginal, type NestedResultValue as NestedResultValueOriginal, type NestedResultValueResultOneOf as NestedResultValueResultOneOfOriginal, type NestedResults as NestedResultsOriginal, type NestedValueAggregationResult as NestedValueAggregationResultOriginal, type NodeDataOneOf as NodeDataOneOfOriginal, type Node as NodeOriginal, type NodeStyle as NodeStyleOriginal, NodeType as NodeTypeOriginal, type NodeTypeWithLiterals as NodeTypeWithLiteralsOriginal, NullValue as NullValueOriginal, type NullValueWithLiterals as NullValueWithLiteralsOriginal, type Oembed as OembedOriginal, type OptionChoiceIds as OptionChoiceIdsOriginal, type OptionChoiceNames as OptionChoiceNamesOriginal, type OptionChoice as OptionChoiceOriginal, type OptionDesign as OptionDesignOriginal, type OptionLayout as OptionLayoutOriginal, type Option as OptionOriginal, type OrderedListData as OrderedListDataOriginal, Orientation as OrientationOriginal, type OrientationWithLiterals as OrientationWithLiteralsOriginal, type PDFSettings as PDFSettingsOriginal, type PageUrlV2 as PageUrlV2Original, type PagingMetadata as PagingMetadataOriginal, type ParagraphData as ParagraphDataOriginal, type Permissions as PermissionsOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlatformOffsetSearch as PlatformOffsetSearchOriginal, type PlatformOffsetSearchPagingMethodOneOf as PlatformOffsetSearchPagingMethodOneOfOriginal, type PlatformPaging as PlatformPagingOriginal, type PlaybackOptions as PlaybackOptionsOriginal, PluginContainerDataAlignment as PluginContainerDataAlignmentOriginal, type PluginContainerDataAlignmentWithLiterals as PluginContainerDataAlignmentWithLiteralsOriginal, type PluginContainerData as PluginContainerDataOriginal, type PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOfOriginal, type PluginContainerDataWidth as PluginContainerDataWidthOriginal, type PollDataLayout as PollDataLayoutOriginal, type PollData as PollDataOriginal, type PollDesign as PollDesignOriginal, PollLayoutDirection as PollLayoutDirectionOriginal, type PollLayoutDirectionWithLiterals as PollLayoutDirectionWithLiteralsOriginal, type PollLayout as PollLayoutOriginal, PollLayoutType as PollLayoutTypeOriginal, type PollLayoutTypeWithLiterals as PollLayoutTypeWithLiteralsOriginal, type Poll as PollOriginal, type PollSettings as PollSettingsOriginal, Position as PositionOriginal, type PositionWithLiterals as PositionWithLiteralsOriginal, PreorderStatus as PreorderStatusOriginal, type PreorderStatusWithLiterals as PreorderStatusWithLiteralsOriginal, type PriceInfo as PriceInfoOriginal, type PricePerUnit as PricePerUnitOriginal, type PricePerUnitRange as PricePerUnitRangeOriginal, type PricePerUnitRangePricePerUnit as PricePerUnitRangePricePerUnitOriginal, type PricePerUnitSettings as PricePerUnitSettingsOriginal, type PriceRange as PriceRangeOriginal, type PricingData as PricingDataOriginal, type ProductCategoriesInfo as ProductCategoriesInfoOriginal, type ProductCategoryIdsInfo as ProductCategoryIdsInfoOriginal, type ProductCategory as ProductCategoryOriginal, type ProductFields as ProductFieldsOriginal, type ProductFieldsTypedPropertiesOneOf as ProductFieldsTypedPropertiesOneOfOriginal, type ProductMediaMediaOneOf as ProductMediaMediaOneOfOriginal, ProductMediaMediaType as ProductMediaMediaTypeOriginal, type ProductMediaMediaTypeWithLiterals as ProductMediaMediaTypeWithLiteralsOriginal, type ProductMedia as ProductMediaOriginal, type ProductMediaSetByOneOf as ProductMediaSetByOneOfOriginal, ProductOptionRenderType as ProductOptionRenderTypeOriginal, type ProductOptionRenderTypeWithLiterals as ProductOptionRenderTypeWithLiteralsOriginal, type Product as ProductOriginal, ProductPreorderAvailability as ProductPreorderAvailabilityOriginal, type ProductPreorderAvailabilityWithLiterals as ProductPreorderAvailabilityWithLiteralsOriginal, ProductType as ProductTypeOriginal, type ProductTypeWithLiterals as ProductTypeWithLiteralsOriginal, type ProductTypedPropertiesOneOf as ProductTypedPropertiesOneOfOriginal, type QueryVariantsRequest as QueryVariantsRequestOriginal, type QueryVariantsResponse as QueryVariantsResponseOriginal, type RangeAggregation as RangeAggregationOriginal, type RangeAggregationRangeBucket as RangeAggregationRangeBucketOriginal, type RangeAggregationResult as RangeAggregationResultOriginal, type RangeBucket as RangeBucketOriginal, type RangeResult as RangeResultOriginal, type RangeResults as RangeResultsOriginal, type ReadOnlyVariant as ReadOnlyVariantOriginal, type ReadOnlyVariantTypedPropertiesOneOf as ReadOnlyVariantTypedPropertiesOneOfOriginal, type RecoverProductVariantsRequest as RecoverProductVariantsRequestOriginal, type RecoverProductVariantsResponse as RecoverProductVariantsResponseOriginal, type Rel as RelOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, Resizing as ResizingOriginal, type ResizingWithLiterals as ResizingWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type Results as ResultsOriginal, type RevenueDetails as RevenueDetailsOriginal, type Ribbon as RibbonOriginal, type RibbonStyles as RibbonStylesOriginal, type RichContent as RichContentOriginal, type ScalarAggregation as ScalarAggregationOriginal, type ScalarResult as ScalarResultOriginal, ScalarType as ScalarTypeOriginal, type ScalarTypeWithLiterals as ScalarTypeWithLiteralsOriginal, SearchDetailsMode as SearchDetailsModeOriginal, type SearchDetailsModeWithLiterals as SearchDetailsModeWithLiteralsOriginal, type SearchDetails as SearchDetailsOriginal, type SearchVariantsRequest as SearchVariantsRequestOriginal, type SearchVariantsResponse as SearchVariantsResponseOriginal, SecuredMediaFileType as SecuredMediaFileTypeOriginal, type SecuredMediaFileTypeWithLiterals as SecuredMediaFileTypeWithLiteralsOriginal, type SecuredMedia as SecuredMediaOriginal, type SeoSchema as SeoSchemaOriginal, type Settings as SettingsOriginal, SortDirection as SortDirectionOriginal, type SortDirectionWithLiterals as SortDirectionWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, SortType as SortTypeOriginal, type SortTypeWithLiterals as SortTypeWithLiteralsOriginal, type Sorting as SortingOriginal, Source as SourceOriginal, type SourceWithLiterals as SourceWithLiteralsOriginal, type SpoilerData as SpoilerDataOriginal, type Spoiler as SpoilerOriginal, type StylesBorder as StylesBorderOriginal, type Styles as StylesOriginal, StylesPosition as StylesPositionOriginal, type StylesPositionWithLiterals as StylesPositionWithLiteralsOriginal, type SubscriptionCyclesOneOf as SubscriptionCyclesOneOfOriginal, type SubscriptionDetails as SubscriptionDetailsOriginal, type SubscriptionDiscountDiscountOneOf as SubscriptionDiscountDiscountOneOfOriginal, type SubscriptionDiscount as SubscriptionDiscountOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type Subscription as SubscriptionOriginal, type SubscriptionPrice as SubscriptionPriceOriginal, type SubscriptionPricePerUnit as SubscriptionPricePerUnitOriginal, type SubscriptionPricesInfo as SubscriptionPricesInfoOriginal, type TableCellData as TableCellDataOriginal, type TableData as TableDataOriginal, type Tag as TagOriginal, Target as TargetOriginal, type TargetWithLiterals as TargetWithLiteralsOriginal, TextAlignment as TextAlignmentOriginal, type TextAlignmentWithLiterals as TextAlignmentWithLiteralsOriginal, type TextData as TextDataOriginal, type TextNodeStyle as TextNodeStyleOriginal, type TextStyle as TextStyleOriginal, type Thumbnail as ThumbnailOriginal, ThumbnailsAlignment as ThumbnailsAlignmentOriginal, type ThumbnailsAlignmentWithLiterals as ThumbnailsAlignmentWithLiteralsOriginal, type Thumbnails as ThumbnailsOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type V1Media as V1MediaOriginal, type V3FixedMonetaryAmount as V3FixedMonetaryAmountOriginal, type V3InventoryStatus as V3InventoryStatusOriginal, type V3OptionChoiceIds as V3OptionChoiceIdsOriginal, type V3OptionChoiceNames as V3OptionChoiceNamesOriginal, type V3OptionChoice as V3OptionChoiceOriginal, type V3PhysicalProperties as V3PhysicalPropertiesOriginal, type V3PriceInfo as V3PriceInfoOriginal, type V3PricePerUnit as V3PricePerUnitOriginal, type V3PricePerUnitSettings as V3PricePerUnitSettingsOriginal, type V3ProductMediaMediaOneOf as V3ProductMediaMediaOneOfOriginal, type V3ProductMedia as V3ProductMediaOriginal, type V3ProductMediaSetByOneOf as V3ProductMediaSetByOneOfOriginal, V3ProductType as V3ProductTypeOriginal, type V3ProductTypeWithLiterals as V3ProductTypeWithLiteralsOriginal, type V3RevenueDetails as V3RevenueDetailsOriginal, type V3SecuredMedia as V3SecuredMediaOriginal, type V3SubscriptionPrice as V3SubscriptionPriceOriginal, type V3SubscriptionPricePerUnit as V3SubscriptionPricePerUnitOriginal, type V3SubscriptionPricesInfo as V3SubscriptionPricesInfoOriginal, type V3Thumbnail as V3ThumbnailOriginal, type V3VariantDigitalProperties as V3VariantDigitalPropertiesOriginal, type V3VariantPhysicalProperties as V3VariantPhysicalPropertiesOriginal, type V3WeightMeasurementUnitInfo as V3WeightMeasurementUnitInfoOriginal, type ValueAggregationIncludeMissingValuesOptions as ValueAggregationIncludeMissingValuesOptionsOriginal, ValueAggregationMissingValues as ValueAggregationMissingValuesOriginal, type ValueAggregationMissingValuesWithLiterals as ValueAggregationMissingValuesWithLiteralsOriginal, type ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOfOriginal, type ValueAggregation as ValueAggregationOriginal, type ValueAggregationResult as ValueAggregationResultOriginal, ValueAggregationSortDirection as ValueAggregationSortDirectionOriginal, type ValueAggregationSortDirectionWithLiterals as ValueAggregationSortDirectionWithLiteralsOriginal, ValueAggregationSortType as ValueAggregationSortTypeOriginal, type ValueAggregationSortTypeWithLiterals as ValueAggregationSortTypeWithLiteralsOriginal, type ValueResult as ValueResultOriginal, type ValueResults as ValueResultsOriginal, type VariantDigitalProperties as VariantDigitalPropertiesOriginal, type Variant as VariantOriginal, type VariantPhysicalProperties as VariantPhysicalPropertiesOriginal, type VariantSummary as VariantSummaryOriginal, type VariantTypedPropertiesOneOf as VariantTypedPropertiesOneOfOriginal, type VariantsInfo as VariantsInfoOriginal, VerticalAlignment as VerticalAlignmentOriginal, type VerticalAlignmentWithLiterals as VerticalAlignmentWithLiteralsOriginal, type VideoData as VideoDataOriginal, type Video as VideoOriginal, type VideoResolution as VideoResolutionOriginal, type VideoV2 as VideoV2Original, ViewMode as ViewModeOriginal, type ViewModeWithLiterals as ViewModeWithLiteralsOriginal, ViewRole as ViewRoleOriginal, type ViewRoleWithLiterals as ViewRoleWithLiteralsOriginal, VoteRole as VoteRoleOriginal, type VoteRoleWithLiterals as VoteRoleWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WeightMeasurementUnitInfo as WeightMeasurementUnitInfoOriginal, type WeightRange as WeightRangeOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, Width as WidthOriginal, WidthType as WidthTypeOriginal, type WidthTypeWithLiterals as WidthTypeWithLiteralsOriginal, type WidthWithLiterals as WidthWithLiteralsOriginal, type __PublicMethodMetaInfo, queryVariants, searchVariants };