@wix/app-extensions 1.0.7 → 1.0.8

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.
@@ -116,124 +116,6 @@ interface ComponentData extends ComponentDataDataOneOf {
116
116
  /** Bookings Staff Sorting Provider SPI */
117
117
  staffSortingProvider?: StaffSortingProviderConfig;
118
118
  }
119
- /** @oneof */
120
- interface ComponentDataDataOneOf {
121
- /**
122
- * Create a widget iframe that users can display on their site. We recommend submitting a proposal before using iframes in your app.
123
- * Learn More: https://devforum.wix.com/en/article/widget-components
124
- */
125
- widgetComponentData?: WidgetComponentData;
126
- /**
127
- * Display an iframe as a page on a user's site.
128
- * Learn More: https://dev.wix.com/docs/build-apps/developer-tools/extensions/iframes/guide-to-page-extensions
129
- */
130
- pageComponentData?: PageComponentData;
131
- /**
132
- * Open an iframe in the Dashboard, or add a link to a page on your platform.
133
- * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/external-links/about-external-link-extensions
134
- */
135
- dashboardComponentData?: DashboardComponentData;
136
- /**
137
- * Use an invisible iframe to track activity. It’s added to every page on the site (max. 1).
138
- * Learn More: https://devforum.wix.com/en/article/worker-components
139
- */
140
- workerComponentData?: WorkerComponentData;
141
- /**
142
- * Inject a script into a site’s HTML code.
143
- * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/embedded-scripts/about-embedded-scripts
144
- */
145
- embeddedScriptComponentData?: EmbeddedScriptComponentData;
146
- /**
147
- * Extend a site’s CMS to store and manage custom data.
148
- * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/data-collections/about-data-collections-extensions
149
- */
150
- dataComponent?: DataComponent;
151
- /**
152
- * Display a widget that fits into a predefined slot in a Wix app.
153
- * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-plugins/about-site-plugin-extensions
154
- */
155
- widgetPlugin?: WidgetPluginComponentData;
156
- /**
157
- * Provide custom shipping rates to a site's cart and checkout.
158
- * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/shipping-rates-integration-service-plugin/introduction
159
- */
160
- ecomShippingRates?: ShippingRatesConfig;
161
- /** Extend a Wix entity with custom fields for your app */
162
- dataExtensions?: DataExtensionsComponentData;
163
- /**
164
- * Become a Wix catalog provider and integrate any external repository of sellable items with the Wix eCommerce platform.
165
- * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/catalog-service-plugin/introduction
166
- */
167
- ecomCatalog?: CatalogSPIConfig;
168
- /**
169
- * Implement gift card benefits such as balance retrieval, redemption, and voiding transactions.
170
- * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/gift-cards-service-plugin/introduction
171
- */
172
- giftCardsProvider?: GiftCardProviderConfig;
173
- /**
174
- * Provide SEO keyword suggestions to site collaborators, report quota usage, and provide a page where users can upgrade their plan.
175
- * Learn More: https://dev.wix.com/docs/rest/api-reference/marketing/seo-keywords-suggestions-v-1/introduction
176
- */
177
- seoKeywordsSuggestions?: SeoKeywordsSuggestionsSPIConfig;
178
- /**
179
- * Configure a page for your app that will be embedded in the Wix Dashboard.
180
- * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/dashboard-pages/about-dashboard-page-extensions
181
- */
182
- backOfficePage?: BackOfficePage;
183
- /**
184
- * Provide custom additional fees that are added to a site's cart and checkout.
185
- * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/additional-fees-service-plugin/introduction
186
- */
187
- ecomAdditionalFees?: AdditionalFeesSPIConfig;
188
- /** Bookings Pricing Provider SPI */
189
- bookingsPricingProvider?: BookingsPricingProviderConfig;
190
- /**
191
- * Apply custom charges to a site based on usage of your app's services.
192
- * Learn More: https://dev.wix.com/docs/rest/api-reference/app-management/apps/custom-charges-spi/introduction
193
- */
194
- premiumCustomCharges?: CustomChargesConfig;
195
- /**
196
- * Validate items in a site's cart and checkout based on custom logic.
197
- * Learn More: https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/validations-integration-spi/introduction
198
- */
199
- ecomValidations?: ValidationsSPIConfig;
200
- /**
201
- * Build a tool that adds functionality to the Wix editors.
202
- * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/editor-extensions/about-editor-extensions
203
- */
204
- editorAddon?: EditorAddon;
205
- /** External Database component */
206
- externalDatabaseProvider?: ExternalDatabaseSpiConfig;
207
- /**
208
- * Integrate your service with Wix's payment process to allow merchants to request and use your services on their Wix sites.
209
- * Learn More: https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/payment-settings-integration-service-plugin/introduction
210
- */
211
- ecomPaymentSettings?: PaymentSettingsSPIConfig;
212
- /**
213
- * Add a site page that displays selected widgets.
214
- * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-pages/about-site-page-extensions
215
- */
216
- unifiedPage?: UnifiedPage;
217
- /** Create a reusable modal that can be utilized across multiple pages within your app and in other applications. */
218
- backOfficeModal?: BackOfficeModal;
219
- /**
220
- * Display a draggable widget on a site using a self-hosted custom element.
221
- * Learn More: https://dev.wix.com/docs/build-apps/develop-your-app/extensions/site-extensions/site-widgets/about-site-widget-extensions
222
- */
223
- customElementWidget?: CustomElementWidget;
224
- /**
225
- * Integrate any external inventory with the Wix eCommerce platform.
226
- * Learn More: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/catalogs/inventory-service-plugin/introduction
227
- */
228
- ecomInventory?: InventorySpiConfig;
229
- /**
230
- * Restriction service plugin for editing products managed by third-party fulfillment apps, such as dropshipping or print-on-demand services
231
- * Learn More: https://dev.wix.com/docs/rest/business-solutions/stores/service-plugins/product-restrictions-v3/introduction
232
- */
233
- storesProductRestrictions?: ProductRestrictionsConfig;
234
- /** Bookings Staff Sorting Provider SPI */
235
- staffSortingProvider?: StaffSortingProviderConfig;
236
- }
237
119
  /** An iframe to be displayed on the user’s site */
238
120
  interface WidgetComponentData {
239
121
  /** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */
@@ -319,141 +201,6 @@ interface WidgetComponentData {
319
201
  /** should be <%=serviceUrl('your_artifact_id', '<resource-path>')%>, this field will later be used to trasform the settings url field in both the component and the **derived widget** */
320
202
  settingsEndpointUrlV1Template?: string | null;
321
203
  }
322
- /** Allow users to resize and move the widget, or pin it to a specific position on all pages of the site. */
323
- interface FixedPositionOptions {
324
- /** Vertical widget position in the browser window */
325
- widgetVertical?: WidgetVerticalWithLiterals;
326
- /** Horizontal widget position in the browser window */
327
- widgetHorizontal?: WidgetHorizontalWithLiterals;
328
- }
329
- /** Vertical widget position in the browser window */
330
- declare enum WidgetVertical {
331
- NONE_VERTICAL = "NONE_VERTICAL",
332
- TOP = "TOP",
333
- CENTER_VERTICAL = "CENTER_VERTICAL",
334
- BOTTOM = "BOTTOM"
335
- }
336
- /** @enumType */
337
- type WidgetVerticalWithLiterals = WidgetVertical | 'NONE_VERTICAL' | 'TOP' | 'CENTER_VERTICAL' | 'BOTTOM';
338
- /** Horizontal widget position in the browser window */
339
- declare enum WidgetHorizontal {
340
- NONE_HORIZONTAL = "NONE_HORIZONTAL",
341
- LEFT = "LEFT",
342
- CENTER_HORIZONTAL = "CENTER_HORIZONTAL",
343
- RIGHT = "RIGHT"
344
- }
345
- /** @enumType */
346
- type WidgetHorizontalWithLiterals = WidgetHorizontal | 'NONE_HORIZONTAL' | 'LEFT' | 'CENTER_HORIZONTAL' | 'RIGHT';
347
- /** Widget will automatically be stretched to this width after installing it */
348
- declare enum WidgetWidthType {
349
- NONE_TYPE = "NONE_TYPE",
350
- /** A custom width for the widget */
351
- CUSTOM = "CUSTOM",
352
- /** Full width of the browser window */
353
- FULL = "FULL"
354
- }
355
- /** @enumType */
356
- type WidgetWidthTypeWithLiterals = WidgetWidthType | 'NONE_TYPE' | 'CUSTOM' | 'FULL';
357
- interface WidgetDisplay {
358
- name?: string;
359
- /**
360
- * short description about the widget
361
- * @maxLength 300
362
- */
363
- shortDescription?: string | null;
364
- /** images showing off how the widget looks */
365
- images?: string[];
366
- /** optional, if no order exist for all components, will be decided by order in array (non-deterministic) */
367
- order?: number | null;
368
- price?: number | null;
369
- variationId?: string | null;
370
- }
371
- interface Position {
372
- region?: RegionWithLiterals;
373
- }
374
- declare enum Region {
375
- no_region = "no_region",
376
- header = "header",
377
- pageContainer = "pageContainer",
378
- footer = "footer"
379
- }
380
- /** @enumType */
381
- type RegionWithLiterals = Region | 'no_region' | 'header' | 'pageContainer' | 'footer';
382
- interface SubPage {
383
- /** The path of the subpage */
384
- key?: string;
385
- /** If it's sub entities are enumerable for querying (for example, a search endpoint is not enumerable) */
386
- enumerable?: boolean;
387
- /** Should hide inner routes of this sub page from floating dynamic pages navigation bar */
388
- hideFromFloatingNavBar?: boolean;
389
- /** Should hide this sub page from selections in link panel */
390
- hideFromLinkPanel?: boolean;
391
- }
392
- interface IsStretched {
393
- desktop?: boolean | null;
394
- tablet?: boolean | null;
395
- mobile?: boolean | null;
396
- }
397
- interface Margins {
398
- desktop?: DisplayProperties;
399
- tablet?: DisplayProperties;
400
- mobile?: DisplayProperties;
401
- }
402
- interface DisplayProperties {
403
- top?: DisplayValue;
404
- right?: DisplayValue;
405
- bottom?: DisplayValue;
406
- left?: DisplayValue;
407
- }
408
- interface DisplayValue {
409
- type?: UnitTypeWithLiterals;
410
- value?: number | null;
411
- }
412
- declare enum UnitType {
413
- NO_UNIT = "NO_UNIT",
414
- AUTO = "AUTO",
415
- PX = "PX",
416
- VH = "VH",
417
- VW = "VW",
418
- PERCENTAGE = "PERCENTAGE"
419
- }
420
- /** @enumType */
421
- type UnitTypeWithLiterals = UnitType | 'NO_UNIT' | 'AUTO' | 'PX' | 'VH' | 'VW' | 'PERCENTAGE';
422
- interface Docking {
423
- desktop?: DockingProperties;
424
- tablet?: DockingProperties;
425
- mobile?: DockingProperties;
426
- }
427
- interface DockingProperties {
428
- horizontal?: HorizontalDockingWithLiterals;
429
- vertical?: VerticalDockingWithLiterals;
430
- }
431
- declare enum HorizontalDocking {
432
- NO_HDOCKING = "NO_HDOCKING",
433
- LEFT_DOCKING = "LEFT_DOCKING",
434
- HCENTER = "HCENTER",
435
- RIGHT_DOCKING = "RIGHT_DOCKING"
436
- }
437
- /** @enumType */
438
- type HorizontalDockingWithLiterals = HorizontalDocking | 'NO_HDOCKING' | 'LEFT_DOCKING' | 'HCENTER' | 'RIGHT_DOCKING';
439
- declare enum VerticalDocking {
440
- NO_VDOCKING = "NO_VDOCKING",
441
- TOP_DOCKING = "TOP_DOCKING",
442
- VCENTER = "VCENTER",
443
- BOTTOM_DOCKING = "BOTTOM_DOCKING"
444
- }
445
- /** @enumType */
446
- type VerticalDockingWithLiterals = VerticalDocking | 'NO_VDOCKING' | 'TOP_DOCKING' | 'VCENTER' | 'BOTTOM_DOCKING';
447
- interface Height {
448
- desktop?: DisplayValue;
449
- tablet?: DisplayValue;
450
- mobile?: DisplayValue;
451
- }
452
- interface ApiWidth {
453
- desktop?: DisplayValue;
454
- tablet?: DisplayValue;
455
- mobile?: DisplayValue;
456
- }
457
204
  /** An iframe to be displayed as a full page on the user’s site */
458
205
  interface PageComponentData {
459
206
  /** Hide this page from the user’s site menu */
@@ -532,79 +279,6 @@ interface PageComponentData {
532
279
  */
533
280
  shortDescription?: string | null;
534
281
  }
535
- interface Padding {
536
- desktop?: DisplayProperties;
537
- tablet?: DisplayProperties;
538
- mobile?: DisplayProperties;
539
- }
540
- interface PageReplaceOptions extends PageReplaceOptionsOptionsOneOf {
541
- replacingOptions?: ReplacingOptions;
542
- replaceableOptions?: ReplaceableOptions;
543
- type?: ReplacementTypeWithLiterals;
544
- }
545
- /** @oneof */
546
- interface PageReplaceOptionsOptionsOneOf {
547
- replacingOptions?: ReplacingOptions;
548
- replaceableOptions?: ReplaceableOptions;
549
- }
550
- interface PageReplace {
551
- /**
552
- * The app id of the page the app can replace
553
- * @format GUID
554
- */
555
- appId?: string;
556
- /**
557
- * The page id the app can replace
558
- * @format GUID
559
- */
560
- pageId?: string;
561
- }
562
- declare enum ReplacementType {
563
- UNKNOWN_REPLACEMENT = "UNKNOWN_REPLACEMENT",
564
- REPLACING = "REPLACING",
565
- REPLACEABLE = "REPLACEABLE"
566
- }
567
- /** @enumType */
568
- type ReplacementTypeWithLiterals = ReplacementType | 'UNKNOWN_REPLACEMENT' | 'REPLACING' | 'REPLACEABLE';
569
- interface ReplacingOptions {
570
- /** describe the page and application id that this page will replace. */
571
- pageReplace?: PageReplace;
572
- }
573
- interface ReplaceableOptions {
574
- /** toggle to mark whether this page can be replaced by other page or app. */
575
- isReplaceable?: boolean;
576
- }
577
- /** The types of public APIs exposed by the Plugin */
578
- declare enum PluginInterface {
579
- /** No public APIs exposed */
580
- NONE_INTERFACE = "NONE_INTERFACE",
581
- /** The slot requires the REVIEWS interface to be implemented by the plugin. The plugin specifies the implementation of the REVIEWS interface */
582
- REVIEWS = "REVIEWS",
583
- /** The slot requires the RATINGS_SUMMARY interface to be implemented by the plugin. The plugin specifies the implementation of the RATINGS_SUMMARY interface */
584
- RATINGS_SUMMARY = "RATINGS_SUMMARY",
585
- /** The slot requires the RATINGS_SUMMARY_OOI_LIST interface to be implemented by the plugin. The plugin specifies the implementation of the RATINGS_SUMMARY_OOI_LIST interface */
586
- RATINGS_SUMMARY_OOI_LIST = "RATINGS_SUMMARY_OOI_LIST",
587
- /** The slot requires the BOOKINGS_SERVICE interface to be implemented by the plugin. The plugin specifies the implementation of the BOOKINGS_SERVICE interface */
588
- BOOKINGS_SERVICE = "BOOKINGS_SERVICE",
589
- /** The slot requires the BOOKINGS_FORM interface to be implemented by the plugin. The plugin specifies the implementation of the BOOKINGS_FORM interface */
590
- BOOKINGS_FORM = "BOOKINGS_FORM",
591
- /** The slot requires the BASE interface to be implemented by the plugin. The plugin specifies the implementation of the BASE interface */
592
- BASE = "BASE",
593
- /** The slot requires the EVENT interface to be implemented by the plugin. The plugin specifies the implementation of the EVENT interface */
594
- EVENT = "EVENT",
595
- /** The slot requires the PRODUCT interface to be implemented by the plugin. The plugin specifies the implementation of the PRODUCT interface */
596
- PRODUCT = "PRODUCT",
597
- /** The slot requires the CHECKOUT interface to be implemented by the plugin. The plugin specifies the implementation of the CHECKOUT interface */
598
- CHECKOUT = "CHECKOUT",
599
- /** The slot requires the CATEGORY interface to be implemented by the plugin. The plugin specifies the implementation of the CATEGORY interface */
600
- CATEGORY = "CATEGORY",
601
- /** The slot requires the BOOKINGS_CALENDAR interface to be implemented by the plugin. The plugin specifies the implementation of the BOOKINGS_CALENDAR interface */
602
- BOOKINGS_CALENDAR = "BOOKINGS_CALENDAR",
603
- /** The slot requires the CART interface to be implemented by the plugin. The plugin specifies the implementation of the CART interface */
604
- CART = "CART"
605
- }
606
- /** @enumType */
607
- type PluginInterfaceWithLiterals = PluginInterface | 'NONE_INTERFACE' | 'REVIEWS' | 'RATINGS_SUMMARY' | 'RATINGS_SUMMARY_OOI_LIST' | 'BOOKINGS_SERVICE' | 'BOOKINGS_FORM' | 'BASE' | 'EVENT' | 'PRODUCT' | 'CHECKOUT' | 'CATEGORY' | 'BOOKINGS_CALENDAR' | 'CART';
608
282
  /**
609
283
  * An iframe that opens in the user’s Wix Dashboard,
610
284
  * or add a link to open the page directly in your platform.
@@ -638,115 +312,6 @@ interface WorkerComponentData {
638
312
  */
639
313
  workerEndpointUrl?: string;
640
314
  }
641
- /** Defines the main preset per breakpoint for the widget. */
642
- interface MainPresets {
643
- /** The main desktop preset. */
644
- desktopPresetId?: string;
645
- /** The main tablet preset. */
646
- tabletPresetId?: string;
647
- /** The main mobile preset. */
648
- mobilePresetId?: string;
649
- }
650
- interface BaseInfo {
651
- /**
652
- * The name of the component
653
- * @minLength 1
654
- * @maxLength 30
655
- */
656
- name?: string;
657
- /** The internal id of the component by the own app */
658
- id?: string;
659
- /**
660
- * The description of the component by the own app
661
- * @maxLength 130
662
- */
663
- description?: string;
664
- /** Reference to help articles about the widget */
665
- helpResources?: HelpResources;
666
- }
667
- interface HelpResources {
668
- /**
669
- * The Wix Answers' article related to the component (chosen by own app)
670
- * @format GUID
671
- */
672
- articleId?: string;
673
- }
674
- interface WidgetInstallationSettings extends WidgetInstallationSettingsTargetContainerOneOf {
675
- /** Which static container should the widget be installed at */
676
- staticContainer?: StaticContainerWithLiterals;
677
- /**
678
- * Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
679
- * @deprecated Deprecated, autoAdd should be mapped to static_container HOMEPAGE, essential should be mapped to container. Shared installation settings for unified components
680
- * @replacedBy static_container
681
- * @targetRemovalDate 2026-02-26
682
- */
683
- base?: BaseInstallation;
684
- /**
685
- * Deprecated, default_preset should be mapped to presets, region is not relevant. Widget installation settings for unified components
686
- * @deprecated Deprecated, default_preset should be mapped to presets, region is not relevant. Widget installation settings for unified components
687
- * @replacedBy presets
688
- * @targetRemovalDate 2026-02-26
689
- */
690
- widget?: WidgetInstallation;
691
- /** Default presets per breakpoint with which the widget should be installed */
692
- presets?: DefaultPresets;
693
- }
694
- /** @oneof */
695
- interface WidgetInstallationSettingsTargetContainerOneOf {
696
- /** Which static container should the widget be installed at */
697
- staticContainer?: StaticContainerWithLiterals;
698
- }
699
- interface BaseInstallation {
700
- /** Auto add component to stage */
701
- autoAdd?: boolean;
702
- /** Mark component as essential for the existence of the app (force to delete the whole app) */
703
- essential?: boolean;
704
- /** Max instances of the component that can be on site */
705
- maxInstances?: number | null;
706
- }
707
- interface WidgetInstallation {
708
- /** Preset should be selected defaultly with installation */
709
- defaultPreset?: MainPresets;
710
- /** Region of widget */
711
- region?: RegionTypeWithLiterals;
712
- }
713
- declare enum RegionType {
714
- HEADER = "HEADER",
715
- BODY = "BODY",
716
- FOOTER = "FOOTER"
717
- }
718
- /** @enumType */
719
- type RegionTypeWithLiterals = RegionType | 'HEADER' | 'BODY' | 'FOOTER';
720
- interface DefaultPresets {
721
- /**
722
- * Default preset ID in small (mobile) breakpoint
723
- * @minLength 1
724
- * @maxLength 50
725
- */
726
- small?: string | null;
727
- /**
728
- * Deprecated, use default - Default preset ID in large (desktop) breakpoint
729
- * @minLength 1
730
- * @maxLength 50
731
- * @deprecated Deprecated, use default - Default preset ID in large (desktop) breakpoint
732
- * @replacedBy default
733
- * @targetRemovalDate 2025-12-02
734
- */
735
- large?: string | null;
736
- /**
737
- * Default preset ID
738
- * @minLength 1
739
- * @maxLength 50
740
- */
741
- default?: string | null;
742
- }
743
- declare enum StaticContainer {
744
- UNKNOWN_CONTAINER = "UNKNOWN_CONTAINER",
745
- /** Widget should be installed in the homepage */
746
- HOMEPAGE = "HOMEPAGE"
747
- }
748
- /** @enumType */
749
- type StaticContainerWithLiterals = StaticContainer | 'UNKNOWN_CONTAINER' | 'HOMEPAGE';
750
315
  /** Inject third party scripts into the user’s site */
751
316
  interface EmbeddedScriptComponentData {
752
317
  /** The script */
@@ -774,70 +339,6 @@ interface EmbeddedScriptComponentData {
774
339
  */
775
340
  dependencies?: WixDependency[];
776
341
  }
777
- /** Category of pages this will be embedded on (single, many, none) */
778
- declare enum EmbeddedScriptPages {
779
- /** It will not be embedded */
780
- NONE_PAGES = "NONE_PAGES",
781
- /** It will be embedded once */
782
- ONCE = "ONCE",
783
- /** It will be embedded multiple times on specific pages */
784
- SPECIFIC_PAGES = "SPECIFIC_PAGES"
785
- }
786
- /** @enumType */
787
- type EmbeddedScriptPagesWithLiterals = EmbeddedScriptPages | 'NONE_PAGES' | 'ONCE' | 'SPECIFIC_PAGES';
788
- /** Where that embed will be rendered */
789
- declare enum EmbeddedScriptPlacement {
790
- /** It will not be rendered */
791
- NONE_PLACEMENT = "NONE_PLACEMENT",
792
- /** In the document head */
793
- HEAD = "HEAD",
794
- /** Prepended before all children already rendered in the body tag */
795
- BODY_START = "BODY_START",
796
- /** Appended after the last child already rendered in the body tag */
797
- BODY_END = "BODY_END"
798
- }
799
- /** @enumType */
800
- type EmbeddedScriptPlacementWithLiterals = EmbeddedScriptPlacement | 'NONE_PLACEMENT' | 'HEAD' | 'BODY_START' | 'BODY_END';
801
- /** Embed category defined for Privacy regulation compliance in EU and CCPA in the US */
802
- declare enum EmbedCategory {
803
- /** Not categorized yet */
804
- UNKNOWN = "UNKNOWN",
805
- /** Must load regardless of policy */
806
- ESSENTIAL = "ESSENTIAL",
807
- /** Adds optional functionality to the site */
808
- FUNCTIONAL = "FUNCTIONAL",
809
- /** Adds analytics abilities to the site */
810
- ANALYTICS = "ANALYTICS",
811
- /** Adds advertising content or advertising tracking to the site */
812
- ADVERTISING = "ADVERTISING"
813
- }
814
- /** @enumType */
815
- type EmbedCategoryWithLiterals = EmbedCategory | 'UNKNOWN' | 'ESSENTIAL' | 'FUNCTIONAL' | 'ANALYTICS' | 'ADVERTISING';
816
- interface WixDependency {
817
- /**
818
- * The fully qualified package name from npm, example: @wix/frontend-location
819
- * @minLength 2
820
- * @maxLength 100
821
- */
822
- packageName?: string;
823
- /** The major version of the package (this may be a detail included in the package name, but is conventional in NPM with semver semantics */
824
- version?: number;
825
- }
826
- declare enum ExtensionType {
827
- NONE_EXTENSION = "NONE_EXTENSION",
828
- PAYMENTS_GATEWAY_EXTENSION = "PAYMENTS_GATEWAY_EXTENSION",
829
- COUPONS_EXTENSION = "COUPONS_EXTENSION",
830
- DROPSHIPPING_EXTENSION = "DROPSHIPPING_EXTENSION",
831
- FULFILMENT_EXTENSION = "FULFILMENT_EXTENSION",
832
- DROPSHIPPING_SUPPLIER_EXTENSION = "DROPSHIPPING_SUPPLIER_EXTENSION",
833
- FULFILLMENT_CENTER_EXTENSION = "FULFILLMENT_CENTER_EXTENSION",
834
- RESTAURANTS_POS_EXTENSION = "RESTAURANTS_POS_EXTENSION",
835
- ART_STORE_EXTENSION = "ART_STORE_EXTENSION",
836
- ASCEND_AUTOMATION_EXTENSION = "ASCEND_AUTOMATION_EXTENSION",
837
- CONTACT_LABELS_EXTENSION = "CONTACT_LABELS_EXTENSION"
838
- }
839
- /** @enumType */
840
- type ExtensionTypeWithLiterals = ExtensionType | 'NONE_EXTENSION' | 'PAYMENTS_GATEWAY_EXTENSION' | 'COUPONS_EXTENSION' | 'DROPSHIPPING_EXTENSION' | 'FULFILMENT_EXTENSION' | 'DROPSHIPPING_SUPPLIER_EXTENSION' | 'FULFILLMENT_CENTER_EXTENSION' | 'RESTAURANTS_POS_EXTENSION' | 'ART_STORE_EXTENSION' | 'ASCEND_AUTOMATION_EXTENSION' | 'CONTACT_LABELS_EXTENSION';
841
342
  /** An extension for adding data collections to a site when the app is installed. */
842
343
  interface DataComponent {
843
344
  /**
@@ -846,286 +347,6 @@ interface DataComponent {
846
347
  */
847
348
  collections?: Collection[];
848
349
  }
849
- interface Field extends FieldTypeOptionsOneOf {
850
- /** Metadata for a reference field. */
851
- referenceOptions?: ReferenceOptions;
852
- /** Metadata for a multi-reference field. */
853
- multiReferenceOptions?: MultiReferenceOptions;
854
- /** Metadata for an object field. */
855
- objectOptions?: ObjectOptions;
856
- /** Metadata for an array field. */
857
- arrayOptions?: ArrayOptions;
858
- /**
859
- * Required. Unique identifier for the field. For example, `firstName`.
860
- * @minLength 1
861
- * @maxLength 1000
862
- */
863
- key?: string;
864
- /**
865
- * Field's display name when displayed in the CMS. For example, `First Name`.
866
- * @minLength 1
867
- * @maxLength 1000
868
- */
869
- displayName?: string | null;
870
- /**
871
- * Required. Field's data type.
872
- *
873
- * Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
874
- */
875
- type?: FieldTypeWithLiterals;
876
- /** Whether the field is encrypted. */
877
- encrypted?: boolean;
878
- /**
879
- * Field description.
880
- * @maxLength 16000
881
- */
882
- description?: string | null;
883
- }
884
- /** @oneof */
885
- interface FieldTypeOptionsOneOf {
886
- /** Metadata for a reference field. */
887
- referenceOptions?: ReferenceOptions;
888
- /** Metadata for a multi-reference field. */
889
- multiReferenceOptions?: MultiReferenceOptions;
890
- /** Metadata for an object field. */
891
- objectOptions?: ObjectOptions;
892
- /** Metadata for an array field. */
893
- arrayOptions?: ArrayOptions;
894
- }
895
- declare enum FieldType {
896
- UNKNOWN_FIELD_TYPE = "UNKNOWN_FIELD_TYPE",
897
- /** Plain-text string. */
898
- TEXT = "TEXT",
899
- /** Number. */
900
- NUMBER = "NUMBER",
901
- /** Date string in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DD`. */
902
- DATE = "DATE",
903
- /** [JavaScript Date object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) (SDK) or an object in the following format: `"someFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. */
904
- DATETIME = "DATETIME",
905
- /** Web URL or a [Media Manager](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction) URL. */
906
- IMAGE = "IMAGE",
907
- /** Boolean `true` or `false` value. */
908
- BOOLEAN = "BOOLEAN",
909
- /** Web URL or a [Media Manager](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction) URL. */
910
- DOCUMENT = "DOCUMENT",
911
- /** URL in one of the following formats: `http://`, `https://`, `ftp://`, `mailto:`, `sms:`, `tel:`. */
912
- URL = "URL",
913
- /** [Rich-text](https://dev.wix.com/docs/rest/articles/getting-started/rich-text) string that may contain a subset of HTML tags. */
914
- RICH_TEXT = "RICH_TEXT",
915
- /** Web URL or a [Media Manager](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction) URL. */
916
- VIDEO = "VIDEO",
917
- /** Any field type. */
918
- ANY = "ANY",
919
- /** Array of strings. */
920
- ARRAY_STRING = "ARRAY_STRING",
921
- /** Array of documents: web or [Media Manager](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction) URLs. */
922
- ARRAY_DOCUMENT = "ARRAY_DOCUMENT",
923
- /** Web URL or a [Media Manager](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction) URL. */
924
- AUDIO = "AUDIO",
925
- /** Time string in `hh:mm:ss.SSS` format. */
926
- TIME = "TIME",
927
- /** Language codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format. These may include country codes in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#officially_assigned_code_elements) format. */
928
- LANGUAGE = "LANGUAGE",
929
- /** [Rich content](https://dev.wix.com/docs/ricos/getting-started/introduction). */
930
- RICH_CONTENT = "RICH_CONTENT",
931
- /** Array of web or [Media Manager](https://dev.wix.com/docs/rest/assets/media/media-manager/introduction) URLs. */
932
- MEDIA_GALLERY = "MEDIA_GALLERY",
933
- /** Physical [address object](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-types-in-wix-data#address-object). */
934
- ADDRESS = "ADDRESS",
935
- /**
936
- * Reference to another item in another collection. See [Query Referenced Data Items](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-items/query-referenced-data-items) to learn about item references.
937
- *
938
- * If you select this type, then you must pass the `referencedCollectionId` field as well.
939
- */
940
- REFERENCE = "REFERENCE",
941
- /** References to multiple items in another collection. See [Query Referenced Data Items](https://dev.wix.com/docs/api-reference/business-solutions/cms/data-items/query-referenced-data-items) to learn about item references. */
942
- MULTI_REFERENCE = "MULTI_REFERENCE",
943
- /** JSON object. */
944
- OBJECT = "OBJECT",
945
- /** Array. */
946
- ARRAY = "ARRAY"
947
- }
948
- /** @enumType */
949
- type FieldTypeWithLiterals = FieldType | 'UNKNOWN_FIELD_TYPE' | 'TEXT' | 'NUMBER' | 'DATE' | 'DATETIME' | 'IMAGE' | 'BOOLEAN' | 'DOCUMENT' | 'URL' | 'RICH_TEXT' | 'VIDEO' | 'ANY' | 'ARRAY_STRING' | 'ARRAY_DOCUMENT' | 'AUDIO' | 'TIME' | 'LANGUAGE' | 'RICH_CONTENT' | 'MEDIA_GALLERY' | 'ADDRESS' | 'REFERENCE' | 'MULTI_REFERENCE' | 'OBJECT' | 'ARRAY';
950
- interface ObjectOptions {
951
- /**
952
- * Fields within the object.
953
- * @maxSize 1000
954
- */
955
- fields?: ObjectField[];
956
- }
957
- interface ArrayOptions extends ArrayOptionsElementTypeOptionsOneOf {
958
- /** Metadata for an object field. */
959
- objectOptions?: ObjectOptions;
960
- /** Metadata for an array field. */
961
- arrayOptions?: ArrayOptions;
962
- /** Element's data type. */
963
- elementType?: FieldTypeWithLiterals;
964
- }
965
- /** @oneof */
966
- interface ArrayOptionsElementTypeOptionsOneOf {
967
- /** Metadata for an object field. */
968
- objectOptions?: ObjectOptions;
969
- /** Metadata for an array field. */
970
- arrayOptions?: ArrayOptions;
971
- }
972
- interface ObjectField extends ObjectFieldTypeOptionsOneOf {
973
- /** Metadata for an object field. */
974
- objectOptions?: ObjectOptions;
975
- /** Metadata for an array field. */
976
- arrayOptions?: ArrayOptions;
977
- /**
978
- * Field ID.
979
- * @minLength 1
980
- * @maxLength 1000
981
- */
982
- key?: string;
983
- /**
984
- * Display name for the field.
985
- * @minLength 1
986
- * @maxLength 1000
987
- */
988
- displayName?: string | null;
989
- /**
990
- * Field type.
991
- *
992
- * Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
993
- */
994
- type?: FieldTypeWithLiterals;
995
- }
996
- /** @oneof */
997
- interface ObjectFieldTypeOptionsOneOf {
998
- /** Metadata for an object field. */
999
- objectOptions?: ObjectOptions;
1000
- /** Metadata for an array field. */
1001
- arrayOptions?: ArrayOptions;
1002
- }
1003
- interface ReferenceOptions {
1004
- /**
1005
- * Referenced collection ID.
1006
- * @minLength 1
1007
- * @maxLength 256
1008
- */
1009
- referencedCollectionId?: string;
1010
- }
1011
- interface MultiReferenceOptions {
1012
- /**
1013
- * Referenced collection ID.
1014
- * @minLength 1
1015
- * @maxLength 256
1016
- */
1017
- referencedCollectionId?: string;
1018
- }
1019
- /** Data permissions defined by access level for each action. */
1020
- interface DataPermissions {
1021
- /** Required. Access level required to read data items. */
1022
- itemRead?: AccessLevelWithLiterals;
1023
- /** Required. Access level required to insert data items. */
1024
- itemInsert?: AccessLevelWithLiterals;
1025
- /** Required. Access level required to update data items. */
1026
- itemUpdate?: AccessLevelWithLiterals;
1027
- /** Required. Access level required to remove data items. */
1028
- itemRemove?: AccessLevelWithLiterals;
1029
- }
1030
- /**
1031
- * Describes who can perform certain action.
1032
- * Each level includes all levels below it (except UNDEFINED).
1033
- */
1034
- declare enum AccessLevel {
1035
- /** Not set. */
1036
- UNDEFINED = "UNDEFINED",
1037
- /** Anyone, including site visitors. */
1038
- ANYONE = "ANYONE",
1039
- /** Any signed-in user, including site members and collaborators. */
1040
- SITE_MEMBER = "SITE_MEMBER",
1041
- /** Any signed-in user, but site members only have access to their own items. */
1042
- SITE_MEMBER_AUTHOR = "SITE_MEMBER_AUTHOR",
1043
- /** Site collaborator that has a role with CMS access permission. */
1044
- CMS_EDITOR = "CMS_EDITOR",
1045
- /** CMS administrators and users or roles granted special access. */
1046
- PRIVILEGED = "PRIVILEGED"
1047
- }
1048
- /** @enumType */
1049
- type AccessLevelWithLiterals = AccessLevel | 'UNDEFINED' | 'ANYONE' | 'SITE_MEMBER' | 'SITE_MEMBER_AUTHOR' | 'CMS_EDITOR' | 'PRIVILEGED';
1050
- interface Index {
1051
- /**
1052
- * Fields for which the index is defined.
1053
- *
1054
- * Max: 3 fields (for a unique index: 1 field)
1055
- * @minSize 1
1056
- * @maxSize 3
1057
- */
1058
- fields?: IndexField[];
1059
- /**
1060
- * Whether the index enforces uniqueness of values in the field for which it is defined.
1061
- * If `true`, the index can have only one field.
1062
- *
1063
- * Default: `false`
1064
- */
1065
- unique?: boolean;
1066
- }
1067
- /**
1068
- * Order determines how values are ordered in the index. This is important when
1069
- * ordering and/or range querying by indexed fields.
1070
- */
1071
- declare enum Order {
1072
- ASC = "ASC",
1073
- DESC = "DESC"
1074
- }
1075
- /** @enumType */
1076
- type OrderWithLiterals = Order | 'ASC' | 'DESC';
1077
- interface IndexField {
1078
- /**
1079
- * Path of the field to index. For example: `title` or `options.price`.
1080
- * @minLength 1
1081
- * @maxLength 128
1082
- */
1083
- path?: string;
1084
- /**
1085
- * Sort order for the index. Base on how the data is regularly queried.
1086
- *
1087
- * Default: `ASC`
1088
- */
1089
- order?: OrderWithLiterals;
1090
- }
1091
- interface Collection {
1092
- /**
1093
- * Required. Collection ID suffix. The app namespace is automatically prepended in the CMS.
1094
- * For example, the full ID for `my-products-1` becomes `@company/app-name/my-products-1`.
1095
- * @maxLength 256
1096
- */
1097
- idSuffix?: string;
1098
- /**
1099
- * Collection's display name as shown in the CMS. For example, `My First Collection`.
1100
- * @minLength 1
1101
- * @maxLength 1000
1102
- */
1103
- displayName?: string | null;
1104
- /**
1105
- * Field whose value the CMS displays to represent the collection item when referenced in a different collection.
1106
- * @minLength 1
1107
- * @maxLength 1000
1108
- */
1109
- displayField?: string | null;
1110
- /**
1111
- * Required. Collection's field structure.
1112
- * @minSize 1
1113
- * @maxSize 1000
1114
- */
1115
- fields?: Field[];
1116
- /** Required. Levels of permission for accessing and modifying data, defined by the lowest role needed to perform each action. */
1117
- dataPermissions?: DataPermissions;
1118
- /**
1119
- * Indexes defined for the collection. An index is a map of a collection's data, organized according to specific fields to increase query speed.
1120
- * @maxSize 3
1121
- */
1122
- indexes?: Index[];
1123
- /**
1124
- * Optional initial data to populate the collection with.
1125
- * @maxSize 1000
1126
- */
1127
- initialData?: Record<string, any>[] | null;
1128
- }
1129
350
  /** A component to be rendered within Widget Slots */
1130
351
  interface WidgetPluginComponentData {
1131
352
  /**
@@ -1142,47 +363,6 @@ interface WidgetPluginComponentData {
1142
363
  /** Widget plugin installation settings. */
1143
364
  installation?: PluginInstallationSettings;
1144
365
  }
1145
- /** Marketing information about the plugin. */
1146
- interface PluginMarketData {
1147
- /**
1148
- * Plugin name.
1149
- * @minLength 1
1150
- * @maxLength 50
1151
- */
1152
- name?: string;
1153
- /**
1154
- * Plugin description.
1155
- * @maxLength 130
1156
- */
1157
- description?: string;
1158
- /**
1159
- * Plugin logo. 35x35px in JPG or PNG format.
1160
- * @format WEB_URL
1161
- */
1162
- logoUrl?: string | null;
1163
- }
1164
- /** Combination of IDs that uniquely identify a slot in the app component. */
1165
- interface PluginPlacement {
1166
- /**
1167
- * Slot app definition ID.
1168
- * @format GUID
1169
- */
1170
- appDefinitionId?: string;
1171
- /**
1172
- * Slot app component ID.
1173
- * @format GUID
1174
- */
1175
- widgetId?: string;
1176
- /**
1177
- * Slot ID.
1178
- * @minLength 1
1179
- */
1180
- slotId?: string;
1181
- }
1182
- interface PluginInstallationSettings {
1183
- /** Shared installation settings for unified components */
1184
- base?: BaseInstallation;
1185
- }
1186
366
  interface ShippingRatesConfig {
1187
367
  /**
1188
368
  * Base URI where the endpoints are called.
@@ -1224,35 +404,6 @@ interface ShippingRatesConfig {
1224
404
  */
1225
405
  thumbnailUrl?: string | null;
1226
406
  }
1227
- interface SpiBaseUri {
1228
- /**
1229
- * Base URI where the methods are called. Wix appends the path to the `baseUri`.
1230
- * For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
1231
- * @minLength 6
1232
- * @maxLength 2048
1233
- */
1234
- baseUri?: string;
1235
- /** Alternate, custom URIs to replace the default URIs for specific service plugin methods. */
1236
- alternativeUris?: AlternativeUri[];
1237
- }
1238
- interface AlternativeUri {
1239
- /**
1240
- * Name of the method to create a custom URI for.
1241
- *
1242
- * For `methodName`, use the name of the method in PascalCase.
1243
- * For example, for Get Shipping Rates use `GetShippingRates`.
1244
- * @minLength 3
1245
- * @maxLength 128
1246
- */
1247
- methodName?: string;
1248
- /**
1249
- * Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI.
1250
- * Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
1251
- * @minLength 6
1252
- * @maxLength 2048
1253
- */
1254
- absoluteUri?: string;
1255
- }
1256
407
  /** A component holding schema of Data Extensions */
1257
408
  interface DataExtensionsComponentData {
1258
409
  /** FQDN of the entity that the application extends */
@@ -1273,70 +424,6 @@ interface CatalogSPIConfig {
1273
424
  /** Configuration details for discounts applied to specific items in the catalog. */
1274
425
  specificItemsDiscount?: DiscountConfig;
1275
426
  }
1276
- interface DiscountConfig {
1277
- /**
1278
- * Whether the discount is enabled.
1279
- *
1280
- * Default: `false`.
1281
- */
1282
- enabled?: boolean;
1283
- /**
1284
- * Translation key for text to display to the site owner.
1285
- * @minLength 5
1286
- * @maxLength 100
1287
- */
1288
- translationKey?: string;
1289
- }
1290
- /** List of back-office hosting platforms */
1291
- declare enum BackOfficeHostingPlatforms {
1292
- NO_HOSTING_PLATFORM = "NO_HOSTING_PLATFORM",
1293
- /** Site Dashboard (The Wix Dashboard) */
1294
- BUSINESS_MANAGER = "BUSINESS_MANAGER",
1295
- /** User Account Dashboard */
1296
- ACCOUNT_MANAGER = "ACCOUNT_MANAGER",
1297
- /** Internal: Dev center */
1298
- DEV_CENTER = "DEV_CENTER",
1299
- /** Enterprise dashboard (available to enterprise accounts only) */
1300
- ENTERPRISE = "ENTERPRISE",
1301
- /** Partners dashboard (available to partners accounts only) */
1302
- PARTNERS_DASHBOARD = "PARTNERS_DASHBOARD",
1303
- /** Employee only financial support dashboard */
1304
- FINANCIALS_INTERNAL_BO = "FINANCIALS_INTERNAL_BO",
1305
- /** FED Guild POC dashboard */
1306
- FED_GUILD_POC = "FED_GUILD_POC",
1307
- /** Studio dashboard */
1308
- STUDIO_DASHBOARD = "STUDIO_DASHBOARD",
1309
- /** Channels dashboard (available to channels accounts only) */
1310
- CHANNELS = "CHANNELS",
1311
- /** Wix internal dashboard for data tools (proffesional data consumers, i.e Business Analysts, Data Engineers...) */
1312
- DATA_TOOLS = "DATA_TOOLS",
1313
- /** Internal back-office for payment service provider management */
1314
- PSP_BACKOFFICE = "PSP_BACKOFFICE",
1315
- /** Rise.ai account dashboard */
1316
- RISE_PLATFORM_ACCOUNT_DASHBOARD = "RISE_PLATFORM_ACCOUNT_DASHBOARD",
1317
- /** Enterprise demo dashboard (available to possible enterprise accounts for demo purposes) */
1318
- DEMO_DASHBOARD_ENTERPRISE = "DEMO_DASHBOARD_ENTERPRISE",
1319
- /** A new AI scheduling assistant product dashboard (codename: "Nownia") */
1320
- AI_SCHEDULING_ASSISTANT_DASHBOARD = "AI_SCHEDULING_ASSISTANT_DASHBOARD",
1321
- /** Employee only getting paid cluster dashboard */
1322
- GETTING_PAID = "GETTING_PAID",
1323
- /** Wix internal dashboard for data (non proffesional data consumers, i.e any Wix Employee that has a need for BI data) */
1324
- DATA = "DATA",
1325
- /** Dashboard for viral forms/lite events/etc */
1326
- LITE_DASHBOARD = "LITE_DASHBOARD",
1327
- /** Picasso AI application POC */
1328
- PICASSO_EDITOR = "PICASSO_EDITOR",
1329
- /** Base44 Host Dashboard POC */
1330
- BASE44_DASHBOARD_POC = "BASE44_DASHBOARD_POC",
1331
- /** Wixel Editor */
1332
- WIXEL_EDITOR = "WIXEL_EDITOR",
1333
- /** Base44 Platform */
1334
- BASE44_PLATFORM = "BASE44_PLATFORM",
1335
- /** Payments by Wix Back Office */
1336
- PAYMENTS_BO = "PAYMENTS_BO"
1337
- }
1338
- /** @enumType */
1339
- type BackOfficeHostingPlatformsWithLiterals = BackOfficeHostingPlatforms | 'NO_HOSTING_PLATFORM' | 'BUSINESS_MANAGER' | 'ACCOUNT_MANAGER' | 'DEV_CENTER' | 'ENTERPRISE' | 'PARTNERS_DASHBOARD' | 'FINANCIALS_INTERNAL_BO' | 'FED_GUILD_POC' | 'STUDIO_DASHBOARD' | 'CHANNELS' | 'DATA_TOOLS' | 'PSP_BACKOFFICE' | 'RISE_PLATFORM_ACCOUNT_DASHBOARD' | 'DEMO_DASHBOARD_ENTERPRISE' | 'AI_SCHEDULING_ASSISTANT_DASHBOARD' | 'GETTING_PAID' | 'DATA' | 'LITE_DASHBOARD' | 'PICASSO_EDITOR' | 'BASE44_DASHBOARD_POC' | 'WIXEL_EDITOR' | 'BASE44_PLATFORM' | 'PAYMENTS_BO';
1340
427
  interface GiftCardProviderConfig {
1341
428
  /** The URL of the SPI implementation */
1342
429
  deploymentUri?: string;
@@ -1417,85 +504,6 @@ interface BackOfficePage extends BackOfficePageAssetOneOf {
1417
504
  */
1418
505
  layoutMode?: LayoutModeWithLiterals;
1419
506
  }
1420
- /** @oneof */
1421
- interface BackOfficePageAssetOneOf {
1422
- /** @format WEB_URL */
1423
- iframeUrl?: string;
1424
- }
1425
- interface ComponentMetaData {
1426
- /**
1427
- * @minLength 1
1428
- * @maxLength 200
1429
- */
1430
- title?: string | null;
1431
- /**
1432
- * @minLength 1
1433
- * @maxLength 200
1434
- */
1435
- description?: string | null;
1436
- /**
1437
- * Searchable keywords
1438
- * @maxSize 100
1439
- */
1440
- keywords?: Keywords[];
1441
- /** Is searchable */
1442
- searchable?: boolean;
1443
- }
1444
- interface Keywords {
1445
- /** Keyword ID */
1446
- id?: string;
1447
- /**
1448
- * @minLength 1
1449
- * @maxLength 200
1450
- */
1451
- value?: string;
1452
- }
1453
- interface PageAnchor {
1454
- /**
1455
- * A URL path relative to the page route for direct navigation to a specific section
1456
- * @minLength 1
1457
- * @maxLength 100
1458
- */
1459
- relativeUrl?: string;
1460
- /**
1461
- * [Wix Design System icon](https://www.wix-pages.com/wix-design-system-employees/?path=/story/foundations-icons--icons).
1462
- * Use the full size key. The icon will be rendered in an appropriate size.
1463
- * @minLength 3
1464
- * @maxLength 50
1465
- */
1466
- iconKey?: string | null;
1467
- /** metadata for the page anchor */
1468
- metaData?: AnchorMetaData;
1469
- /**
1470
- * anchor ID
1471
- * @maxLength 50
1472
- */
1473
- id?: string;
1474
- }
1475
- interface AnchorMetaData {
1476
- /**
1477
- * @minLength 1
1478
- * @maxLength 200
1479
- */
1480
- title?: string | null;
1481
- /**
1482
- * @minLength 1
1483
- * @maxLength 200
1484
- */
1485
- description?: string | null;
1486
- /**
1487
- * anchor keywords
1488
- * @maxSize 100
1489
- */
1490
- keywords?: Keywords[];
1491
- }
1492
- declare enum LayoutMode {
1493
- STANDARD_VIEW = "STANDARD_VIEW",
1494
- BUILDER_VIEW = "BUILDER_VIEW",
1495
- EXPANDED_VIEW = "EXPANDED_VIEW"
1496
- }
1497
- /** @enumType */
1498
- type LayoutModeWithLiterals = LayoutMode | 'STANDARD_VIEW' | 'BUILDER_VIEW' | 'EXPANDED_VIEW';
1499
507
  interface AdditionalFeesSPIConfig {
1500
508
  /**
1501
509
  * Base URI where the endpoints are called.
@@ -1731,6 +739,8 @@ declare enum ComponentType {
1731
739
  GENERIC_FUNCTION_ACTIVATION = "GENERIC_FUNCTION_ACTIVATION",
1732
740
  BOOKING_ACTION_URLS_PROVIDER = "BOOKING_ACTION_URLS_PROVIDER"
1733
741
  }
742
+ /** @enumType */
743
+ type ComponentTypeWithLiterals = ComponentType | 'NONE' | 'STUDIO' | 'PLATFORM' | 'WORKER' | 'DASHBOARD' | 'WIDGET' | 'PAGE' | 'DASHBOARD_PLATFORM' | 'STUDIO_WIDGET' | 'EMBEDDED_SCRIPT' | 'EXTENSION' | 'SNIPPET_SOLUTION' | 'DATA_COMPONENT' | 'WEB' | 'DC_CONFIG' | 'WIDGET_OUT_OF_IFRAME' | 'PAGE_OUT_OF_IFRAME' | 'STATIC_FILE' | 'APP_CONFIG' | 'MULTIPLE_DASHBOARDS' | 'PAYMENTS_GATEWAY' | 'CODE_PACKAGE' | 'AUTOMATION_TRIGGER' | 'INVOICES_ACTIONS' | 'DASHBOARD_APPLICATION' | 'CONTACT_LABELS' | 'WIDGET_PLUGIN' | 'CROSS_SELL' | 'LOCAL_DELIVERY' | 'PAYMENT_PROVIDER' | 'ECOM_MEMBERSHIPS' | 'ECOM_LINE_ITEMS_ENRICHER' | 'ECOM_SHIPPING_RATES' | 'SHIPPING_LABEL_CARRIER' | 'RESTAURANTS_POS' | 'FICTIONAL_SHIPPING_PROVIDER' | 'ALERT_ENRICHER' | 'DATA_EXTENSIONS' | 'GENERIC_HOOKS' | 'AUTOMATIONS_ACTION_PROVIDER' | 'ECOM_CATALOG' | 'BACK_OFFICE_EXTENSION_CONTAINER' | 'BACK_OFFICE_EXTENSION' | 'AUTOMATIONS_TRIGGER_PROVIDER' | 'IDENTITY_PRE_REGISTRATION' | 'PREMIUM_PRODUCTS_PATHS' | 'ECOM_CUSTOM_SCOPE' | 'GIFT_CARDS_PROVIDER' | 'DEALER_EXTERNAL_FILTER_PROVIDER' | 'ECOM_DROPSHIPPING_PROVIDER' | 'INVOICES_PROVIDER' | 'SEO_KEYWORDS_SUGGESTIONS' | 'ECOM_DISCOUNTS_TRIGGER' | 'MULTILINGUAL_CONTENT_PROVIDER' | 'APPLICATION_AUTOMATION' | 'BACK_OFFICE_SIDEBAR_CATEGORY' | 'BACK_OFFICE_PAGE' | 'ECOM_ADDITIONAL_FEES' | 'PING_USER_NOTIFICATION' | 'ECOM_RECOMMENDATIONS_PROVIDER' | 'BOOKINGS_PRICING_PROVIDER' | 'IDENTITY_AUTHENTICATOR' | 'IDENTITY_IDP_CONNECTOR' | 'ITEMS_SELECTION_PROVIDER' | 'PORTFOLIO_SYNCED_PROJECTS_PROVIDER' | 'COMMUNICATION_CHANNEL' | 'IDENTITY_POST_LOGIN' | 'BACK_OFFICE_WIDGET' | 'SOCIAL_MARKETING_DESIGN' | 'FORMS_SUBMISSIONS_PROVIDER' | 'WIX_OFFERING' | 'DEV_CENTER_TESTING_COMPONENT' | 'COMPONENTS_VALIDATOR_PROVIDER' | 'COMPONENTS_TRANSLATIONS_ADDITIONAL_FIELDS_PROVIDER' | 'FORMS_SCHEMA_PROVIDER' | 'BOOKINGS_EXTERNAL_CALENDAR_PROVIDER' | 'ECOM_DEFAULT_TAXATION_CATEGORY' | 'VIEWER_DYNAMIC_SITE_STRUCTURE_PROVIDER' | 'PING_UOU_NOTIFICATION' | 'HEADLESS_OAUTH' | 'ECOM_TAX_CALCULATOR_SPI' | 'COMMENTS_MODERATION_PROVIDER' | 'GRID_APP_FILES_TRANSFORMER' | 'BENEFIT_PROGRAMS_POLICY_PROVIDER' | 'PREMIUM_CUSTOM_CHARGES' | 'ECOM_VALIDATIONS' | 'COMPONENT_REFERENCE_DATA_PROVIDER' | 'WIX_REVIEWS_PRODUCT_CATALOG' | 'SOCIAL_MARKETING_DESIGNS_PROVIDER' | 'GOOGLE_BUSINESS_PROFILE_FEATURE_PROVIDER' | 'COMMENTS_FILTER_PROVIDER' | 'BILLING_TAX_ID_VALIDATOR' | 'PING_SETTINGS_GROUP' | 'FORMS_SPAM_SUBMISSIONS_PROVIDER' | 'EDITOR_ADDON' | 'EXTERNAL_DATABASE_PROVIDER' | 'ECOM_PAYMENT_SETTINGS' | 'NOTIFICATION_TOPIC' | 'NOTIFICATION_PREFERENCES_FILTER_PROVIDER' | 'BOOKINGS_RESOURCE_TYPES_PROVIDER' | 'PRICING_PLANS_FORM_CONFIGURATION' | 'USER_NOTIFICATION' | 'CONTACT_NOTIFICATION' | 'UNIFIED_PAGE' | 'AVAILABILITY_TIME_SLOTS_CONFIGURATION_PROVIDER' | 'PROPOSAL_EDITOR_PROVIDER' | 'CUSTOM_TABLE_RESERVATIONS_PROVIDER' | 'COMMENTS_CONTEXT_PROVIDER' | 'FORMS_SPAM_SUBMISSION_REPORTS_PROVIDER' | 'AUTOMATIONS_VELO_ACTION_PROVIDER' | 'CALENDAR_EVENT_TYPE_PROVIDER' | 'RESERVED' | 'SMS_ACTION_MESSAGE' | 'BOOKING_POLICY_PROVIDER' | 'MULTI_SERVICE_BOOKING_POLICY_PROVIDER' | 'AI_ASSISTANT' | 'FORMS_SUBMISSIONS_EXTENSION_PROVIDER' | 'MULTILINGUAL_TRANSLATION_SCHEMA' | 'TAX_CALCULATION_PROVIDER' | 'TAX_GROUPS_PROVIDER' | 'BACK_OFFICE_MODAL' | 'DEPLOYMENT_PIPELINE_PROVIDER' | 'CUSTOM_ELEMENT_WIDGET' | 'BACK_OFFICE_EXTENSION_WIDGET' | 'BACK_OFFICE_EXTENSION_MENU_ITEM' | 'FORM_TEMPLATE' | 'NOTIFICATION_CONTENT' | 'BROADCAST_LIST' | 'PARTNERS_PAYOUTS' | 'WIX_REVIEWS_ENTITY_CATALOG' | 'VELO_PUBLISH_PIPELINE_TASK_PROVIDER' | 'FUNCTIONS_SHOP_PRICE_PROVIDER' | 'FUNCTION' | 'ECOM_CHECKOUT_CONTENT' | 'COMMUNICATION_CHANNEL_PROVIDER' | 'WEBHOOK' | 'TOPOLOGY' | 'LOYALTY_CUSTOM_REWARDS' | 'FUNCTION_RECIPE' | 'BACK_OFFICE_EXTERNAL_URL' | 'IDENTITY_FACTOR' | 'ECOM_DISCOUNTS' | 'VELO_CUSTOM_CSS' | 'DEALER_ADAPTIVE_COMPONENT_PROVIDER' | 'AI_ASSISTANT_ACTION' | 'ECOM_INVENTORY' | 'MONITORING' | 'PAPI_PROVIDER' | 'UNIFIED_LIGHTBOX' | 'FORMS_EXTENSION_PROVIDER' | 'MULTILINGUAL_TRANSLATION_SCHEMA_GROUP' | 'PANEL' | 'PREMIUM_PURCHASE_VALIDATIONS' | 'BROWSER_STORAGE' | 'SDK_DEFINITION' | 'SITE_WIDGET_SLOT' | 'CALENDAR_EVENT_VALIDATION_PROVIDER' | 'CLIENT_SIDE_SERVICE' | 'BILLING_SETTINGS' | 'PATTERNS_WIZARD' | 'APPLICATION_PROFILE' | 'TEXT_TO_SPEECH_ACTION_MESSAGE' | 'AUDIENCE_PROVIDER' | 'PRICING_PLANS_PRICE' | 'PRICING_PLAN_START_DATE_LIMITS' | 'PRICING_PLAN_START_DATE_RULES' | 'EVENTS_TICKET_RESERVATIONS' | 'PAYMENTS_DISPUTE_SERVICE_PLUGIN' | 'PRICING_PLANS_FEES' | 'EDITOR_REACT_COMPONENT' | 'SUPPLIERS_HUB_MARKETPLACE' | 'FORM_SCHEMA_DYNAMIC_VALUES' | 'BLOG_PAYWALL_PROVIDER' | 'LOYALTY_CUSTOM_REWARDS_V2' | 'STORES_PRODUCT_RESTRICTIONS' | 'FORM_SUBMISSION_MODERATION' | 'EVENTS_EVENT_BADGES' | 'BILLING_OPERATION' | 'BACK_OFFICE_CUSTOMIZATION' | 'COMPONENT_ENRICHER_PROVIDER' | 'BACK_OFFICE_RESTRICTED_CUSTOMIZATION' | 'EDITOR_APP_PREVIEWS_POC' | 'LEGENDS_PERSONA_CONFIGURATION' | 'WIX_HOSTING_APP_DEPLOYMENT_PROVIDER' | 'BACKEND_WORKER' | 'EVENT_TIME_SLOTS_CONFIGURATION_PROVIDER' | 'WIX_HOSTING_APP_ENVIRONMENT_PROVIDER' | 'SDK_EXPORTS' | 'VIEWER_SERVICE' | 'WIX_PAYMENTS_PROVIDER_ACCOUNT_SERVICE_PLUGIN' | 'CONTACTS_SEGMENTS_V2_FILTER_PROVIDER' | 'ANALYTICS_PRODUCT_CATALOG' | 'SITE_MIGRATION' | 'RESTAURANTS_POS_PROVIDER_SETTINGS_SERVICE_PLUGIN' | 'WIX_VIBE_CODING_INSTRUCTIONS' | 'TAX_EXEMPT_GROUPS_PROVIDER' | 'BOOKING_AUTOMATIONS_CONFIGURATION' | 'WIX_VIBE_COMPONENT' | 'WIXEL' | 'STAFF_SORTING_PROVIDER' | 'FUNCTION_ECOM_DISCOUNT_TRIGGER_ELIGIBILITY_PROVIDER' | 'FUNCTIONS_ASSISTANT_TOOLS' | 'SITE_MAP_INFO_PROVIDER' | 'WIX_AI_GATEWAY_CALLBACK' | 'URL_MAPPER_PROVIDER' | 'PROVIDER_SUPPRESSION_SERVICE_PLUGIN' | 'ECOM_FORMS' | 'EDITOR_CONTEXT_PROVIDER' | 'EDITOR_FUNCTION_LIBRARY' | 'BOOKINGS_PLATFORM_CONFIGURATION' | 'BOOKINGS_VALIDATION_PROVIDER' | 'APP_ROUTER' | 'WIXEL_BINDING' | 'SHUB_MARKETPLACE_PROVIDER' | 'GENERIC_FUNCTION_ACTIVATION' | 'BOOKING_ACTION_URLS_PROVIDER';
1734
744
  interface CustomChargesConfig {
1735
745
  /**
1736
746
  * Base URI where the endpoints are called. Wix appends the endpoint path to the base URI.
@@ -1771,56 +781,6 @@ interface EditorAddon {
1771
781
  /** Toggle to mark whether the editor should revoke an app that contains this component. */
1772
782
  excludeFromAutoRevoke?: boolean;
1773
783
  }
1774
- interface InitialPosition {
1775
- /** Offset from the left. For example, `"50px"`. */
1776
- x?: string;
1777
- /** Offset from the top. For example, `"50px"`. */
1778
- y?: string;
1779
- }
1780
- interface ToolPanelConfig {
1781
- /**
1782
- * Iframe URL that hosts the add-on tool panel's content.
1783
- * @format WEB_URL
1784
- */
1785
- url?: string;
1786
- /** Addon tool panel width. */
1787
- width?: string;
1788
- /** Addon tool panel height. */
1789
- height?: string;
1790
- /**
1791
- * Initial position of the opened panel.
1792
- * Offset from top left corner of the container.
1793
- */
1794
- initialPosition?: InitialPosition;
1795
- }
1796
- interface AddonMarketData {
1797
- /**
1798
- * Addon name.
1799
- * @minLength 5
1800
- */
1801
- name?: string;
1802
- /**
1803
- * Deprecated, use teaser
1804
- * @minLength 10
1805
- * @deprecated
1806
- * @replacedBy teaser
1807
- * @targetRemovalDate 2025-06-01
1808
- */
1809
- description?: string;
1810
- /**
1811
- * URL source of the addon's icon. Must be 36px x 36px in JPG or PNG format.
1812
- * @format WEB_URL
1813
- */
1814
- iconUrl?: string | null;
1815
- /** Author's name. */
1816
- author?: string;
1817
- /**
1818
- * Addon teaser.
1819
- * @minLength 10
1820
- * @maxLength 60
1821
- */
1822
- teaser?: string | null;
1823
- }
1824
784
  interface ExternalDatabaseSpiConfig {
1825
785
  /** The URI where the service provider is deployed. */
1826
786
  uriConfig?: SpiBaseUri;
@@ -1857,57 +817,6 @@ interface UnifiedPage {
1857
817
  /** Settings for how the page integrates with the editor */
1858
818
  editorSettings?: UnifiedPageEditorSettings;
1859
819
  }
1860
- interface PageInstallationSettings {
1861
- /** Shared installation settings for unified components */
1862
- base?: BaseInstallation;
1863
- /** Page installation settings for unified components */
1864
- page?: PageInstallation;
1865
- }
1866
- interface PageInstallation {
1867
- /**
1868
- * slug of the page (last part of url that point to the page)
1869
- * @minLength 1
1870
- * @maxLength 200
1871
- */
1872
- slug?: string;
1873
- /** Should add page to site menu */
1874
- addToSiteMenu?: boolean;
1875
- /** Can page be linked through link panel */
1876
- linkable?: boolean;
1877
- }
1878
- interface PageContent {
1879
- /** Widgets to add as content in page */
1880
- widgets?: WidgetAsContent[];
1881
- }
1882
- interface WidgetAsContent {
1883
- /**
1884
- * GUID of widget to use as content of page
1885
- * @format GUID
1886
- */
1887
- widgetGuid?: string;
1888
- /** The preset should be used */
1889
- preset?: MainPresets;
1890
- /** Mark widget as essential for the existence of the app (force to delete the whole app) */
1891
- essential?: boolean | null;
1892
- }
1893
- interface UnifiedPageEditorSettings {
1894
- /** Basic editor settings that are relevant to all page types */
1895
- base?: PageEditorSettings;
1896
- /**
1897
- * slug of the page (last part of url that point to the page)
1898
- * @minLength 1
1899
- * @maxLength 200
1900
- */
1901
- slug?: string | null;
1902
- }
1903
- interface PageEditorSettings {
1904
- /** Add the page to the site menu */
1905
- addToSiteMenu?: boolean | null;
1906
- /** Can a page be linked through the link panel */
1907
- linkable?: boolean | null;
1908
- /** Can a page be duplicated in the editor (if no essential widget is added in the container) */
1909
- duplicatable?: boolean | null;
1910
- }
1911
820
  /** A modal in one of the back-office platforms */
1912
821
  interface BackOfficeModal extends BackOfficeModalContentOneOf {
1913
822
  /**
@@ -1948,14 +857,6 @@ interface BackOfficeModal extends BackOfficeModalContentOneOf {
1948
857
  */
1949
858
  iconKey?: string | null;
1950
859
  }
1951
- /** @oneof */
1952
- interface BackOfficeModalContentOneOf {
1953
- /**
1954
- * Iframe URL that hosts the modal's content.
1955
- * @format WEB_URL
1956
- */
1957
- iframeUrl?: string;
1958
- }
1959
860
  interface CustomElementWidget {
1960
861
  /** Base info of component by shared logic of unified components */
1961
862
  base?: BaseInfo;
@@ -1978,123 +879,6 @@ interface CustomElementWidget {
1978
879
  */
1979
880
  presets?: Preset[];
1980
881
  }
1981
- interface WidgetData {
1982
- /**
1983
- * The script url that should render on the widget
1984
- * @format WEB_URL
1985
- */
1986
- scriptUrl?: string;
1987
- /**
1988
- * Unique tag name to use in order to connect your JS script to your web component
1989
- * @minLength 2
1990
- * @maxLength 64
1991
- */
1992
- tagName?: string;
1993
- /** Type of JavaScript modularization approach used in the custom element */
1994
- scriptType?: CustomElementScriptTypeWithLiterals;
1995
- }
1996
- declare enum CustomElementScriptType {
1997
- NONE = "NONE",
1998
- /** CommonJS modularization approach */
1999
- COMMON_JS = "COMMON_JS",
2000
- /** ES Module modularization approach */
2001
- ES_MODULE = "ES_MODULE"
2002
- }
2003
- /** @enumType */
2004
- type CustomElementScriptTypeWithLiterals = CustomElementScriptType | 'NONE' | 'COMMON_JS' | 'ES_MODULE';
2005
- interface EditorBehaviors {
2006
- /** The settings behavior definition for the widget */
2007
- settings?: SettingsPanel;
2008
- /** The dashboard behavior definition for the widget */
2009
- dashboard?: Dashboard;
2010
- }
2011
- interface SettingsPanel {
2012
- /**
2013
- * The settings panel URL for this component
2014
- * @format WEB_URL
2015
- */
2016
- settingsUrl?: string | null;
2017
- }
2018
- interface Dashboard {
2019
- /**
2020
- * The dashboard page guid for the widget manage of the widget
2021
- * @format GUID
2022
- */
2023
- dashboardPageComponentId?: string;
2024
- }
2025
- interface WidgetSize {
2026
- /** define the size of the widget's height */
2027
- height?: WidgetSizeHeight;
2028
- /** define the size of the widget's width */
2029
- width?: WidgetSizeWidth;
2030
- }
2031
- declare enum HeightMode {
2032
- UNKNOWN = "UNKNOWN",
2033
- /** Height is calculated by content */
2034
- AUTO = "AUTO",
2035
- /** Height is fixed require size in px */
2036
- FIXED = "FIXED"
2037
- }
2038
- /** @enumType */
2039
- type HeightModeWithLiterals = HeightMode | 'UNKNOWN' | 'AUTO' | 'FIXED';
2040
- interface WidgetSizeHeight {
2041
- /** Height calculation mode */
2042
- heightMode?: HeightModeWithLiterals;
2043
- /**
2044
- * Default height in pixels
2045
- * @max 9999
2046
- */
2047
- defaultHeight?: number;
2048
- }
2049
- interface WidgetSizeWidth {
2050
- /** Boolean to set stretch, will place the widget stretched to the full width of the container */
2051
- allowStretch?: boolean;
2052
- /**
2053
- * Default width in pixels
2054
- * @max 9999
2055
- */
2056
- defaultWidth?: number;
2057
- /** Boolean to set stretch by default on installation, if true will place the widget stretched to the full width of the container */
2058
- stretchByDefault?: boolean;
2059
- }
2060
- interface Preset {
2061
- /**
2062
- * The id of the preset
2063
- * @minLength 1
2064
- * @maxLength 50
2065
- */
2066
- id?: string;
2067
- /**
2068
- * Display name of the preset
2069
- * @minLength 1
2070
- * @maxLength 30
2071
- */
2072
- name?: string;
2073
- /** Defines data for screen size for the preset */
2074
- breakpoints?: Breakpoints;
2075
- /**
2076
- * URL of an image to show as the preset's thumbnail in the editor
2077
- * @format WEB_URL
2078
- */
2079
- thumbnailUrl?: string | null;
2080
- }
2081
- interface Breakpoints {
2082
- /** Defines data for small screen size */
2083
- small?: Breakpoint;
2084
- /** Defines data for medium screen size */
2085
- medium?: Breakpoint;
2086
- /** Defines data for large screen size */
2087
- large?: Breakpoint;
2088
- }
2089
- interface Breakpoint {
2090
- /** The size of the preset */
2091
- size?: WidgetSize;
2092
- /**
2093
- * A different preset id to be used according to breakpoint
2094
- * @maxLength 50
2095
- */
2096
- presetId?: string;
2097
- }
2098
882
  interface InventorySpiConfig {
2099
883
  /**
2100
884
  * Base URI where the endpoints are called.
@@ -2110,59 +894,6 @@ interface ProductRestrictionsConfig {
2110
894
  /** Product restrictions configuration. */
2111
895
  productRestrictionsConfig?: RestrictionsConfig;
2112
896
  }
2113
- interface RestrictionsConfig {
2114
- /**
2115
- * Prices restrictions.
2116
- *
2117
- * Affected fields:
2118
- * * `variantsInfo.variants.price.actualPrice.amount`
2119
- * * `variantsInfo.variants.price.compareAtPrice.amount`
2120
- * * `inventory.trackingMethod.quantity`
2121
- */
2122
- prices?: Restriction;
2123
- /**
2124
- * Options restrictions.
2125
- *
2126
- * Affected field: `options` (all nested fields except `linkedMedia`)
2127
- */
2128
- options?: Restriction;
2129
- /**
2130
- * Modifier restrictions.
2131
- *
2132
- * Affected field: `modifiers` (all nested fields except `linkedMedia`)
2133
- */
2134
- modifiers?: Restriction;
2135
- /**
2136
- * Inventory restrictions.
2137
- *
2138
- * Affected fields:
2139
- * * `variantsInfo.variants.sku`
2140
- * * `variantsInfo.variants.barcode`
2141
- * * `inventory.trackingMethod.quantity`
2142
- */
2143
- inventory?: Restriction;
2144
- /**
2145
- * Pre order restrictions.
2146
- *
2147
- * Affected field: `inventory.preorderInfo`
2148
- */
2149
- preOrder?: Restriction;
2150
- /** Whether to disallow product duplication or display a warning when duplicating a product. */
2151
- duplicateProduct?: Restriction;
2152
- }
2153
- interface Restriction {
2154
- /** Restriction level. */
2155
- restrictionLevel?: RestrictionLevelWithLiterals;
2156
- }
2157
- declare enum RestrictionLevel {
2158
- UNKNOWN_RESTRICTION_TYPE = "UNKNOWN_RESTRICTION_TYPE",
2159
- /** Users can edit the product field after acknowledging a warning modal. */
2160
- WARNING = "WARNING",
2161
- /** Users **cannot** edit the product field. */
2162
- LOCKED = "LOCKED"
2163
- }
2164
- /** @enumType */
2165
- type RestrictionLevelWithLiterals = RestrictionLevel | 'UNKNOWN_RESTRICTION_TYPE' | 'WARNING' | 'LOCKED';
2166
897
  interface StaffSortingProviderConfig {
2167
898
  /** URI where the SPI Implementer is deployed */
2168
899
  deploymentUri?: SpiBaseUri;
@@ -2182,10 +913,6 @@ interface StaffSortingProviderConfig {
2182
913
  */
2183
914
  dashboardPluginId?: string | null;
2184
915
  }
2185
- interface ExtensionData {
2186
- data?: string;
2187
- extensionType?: ExtensionTypeWithLiterals;
2188
- }
2189
916
  interface ExtensionData {
2190
917
  compId: string;
2191
918
  compType: ComponentType;
@@ -2513,4 +1240,4 @@ declare function staffSortingProvider({ id, data, name, }: {
2513
1240
  name?: string;
2514
1241
  }): ExtensionData;
2515
1242
 
2516
- export { backOfficeModal, backOfficePage, bookingsPricingProvider, customElementWidget, dashboard, dataComponent, dataExtensions, ecomAdditionalFees, ecomCatalog, ecomInventory, ecomPaymentSettings, ecomShippingRates, ecomValidations, editorAddon, embeddedScript, externalDatabaseProvider, giftCardsProvider, page, premiumCustomCharges, seoKeywordsSuggestions, staffSortingProvider, storesProductRestrictions, unifiedPage, widget, widgetPlugin, worker };
1243
+ export { type AdditionalFeesSPIConfig, type BackOfficeModal, type BackOfficePage, type BookingsPricingProviderConfig, type CatalogSPIConfig, type ComponentData, ComponentType, type ComponentTypeWithLiterals, type CustomChargesConfig, type CustomElementWidget, type DashboardComponentData, type DataComponent, type DataExtensionsComponentData, type EditorAddon, type EmbeddedScriptComponentData, type ExtensionData, type ExternalDatabaseSpiConfig, type GiftCardProviderConfig, type InventorySpiConfig, type PageComponentData, type PaymentSettingsSPIConfig, type ProductRestrictionsConfig, type SeoKeywordsSuggestionsSPIConfig, type ShippingRatesConfig, type StaffSortingProviderConfig, type UnifiedPage, type ValidationsSPIConfig, type WidgetComponentData, type WidgetPluginComponentData, type WorkerComponentData, backOfficeModal, backOfficePage, bookingsPricingProvider, customElementWidget, dashboard, dataComponent, dataExtensions, ecomAdditionalFees, ecomCatalog, ecomInventory, ecomPaymentSettings, ecomShippingRates, ecomValidations, editorAddon, embeddedScript, externalDatabaseProvider, giftCardsProvider, page, premiumCustomCharges, seoKeywordsSuggestions, staffSortingProvider, storesProductRestrictions, unifiedPage, widget, widgetPlugin, worker };