@wix/auto_sdk_export-async-job_export-async-job 1.0.8 → 1.0.10

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.
@@ -300,6 +300,819 @@ interface GetExportAsyncJobResponse {
300
300
  /** The retrieved ExportAsyncJob */
301
301
  job?: ExportAsyncJob;
302
302
  }
303
+ interface CancelExportAsyncJobRequest {
304
+ /**
305
+ * Id of the Export to retrieve
306
+ * @format GUID
307
+ */
308
+ jobId?: string;
309
+ }
310
+ interface CancelExportAsyncJobResponse {
311
+ /** The retrieved ExportAsyncJob */
312
+ job?: ExportAsyncJob;
313
+ }
314
+ interface GenerateExportAsyncJobDownloadUrlRequest {
315
+ /**
316
+ * Id of the Export to retrieve
317
+ * @format GUID
318
+ */
319
+ jobId?: string;
320
+ }
321
+ interface GenerateExportAsyncJobDownloadUrlResponse {
322
+ /** The retrieved ExportAsyncJob */
323
+ job?: ExportAsyncJob;
324
+ }
325
+ interface QueryRequestLoose {
326
+ /** WQL expression */
327
+ query?: ExportQueryV2;
328
+ }
329
+ interface QueryVariantsExportSpiResponse {
330
+ items?: ProductOrVariant[];
331
+ pagingMetadata?: PagingMetadataV2;
332
+ }
333
+ interface ProductOrVariant {
334
+ kind?: string;
335
+ product?: Product;
336
+ variant?: StoreVariant;
337
+ }
338
+ interface Product {
339
+ /**
340
+ * Product ID (generated automatically by the catalog).
341
+ * @readonly
342
+ */
343
+ id?: string;
344
+ /**
345
+ * Product name.
346
+ *
347
+ * Min: 1 character
348
+ * Max: 80 characters
349
+ * @minLength 1
350
+ * @maxLength 80
351
+ */
352
+ name?: string | null;
353
+ /**
354
+ * A friendly URL name (generated automatically by the catalog when a product is created), can be updated.
355
+ * @maxLength 100
356
+ */
357
+ slug?: string;
358
+ /** Whether the product is visible to site visitors. */
359
+ visible?: boolean | null;
360
+ /** Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API. */
361
+ productType?: ProductTypeWithLiterals;
362
+ /**
363
+ * Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text).
364
+ * @maxLength 8000
365
+ */
366
+ description?: string | null;
367
+ /**
368
+ * Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty.
369
+ * @maxLength 40
370
+ */
371
+ sku?: string | null;
372
+ /**
373
+ * Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty.
374
+ * @max 999999999.99
375
+ */
376
+ weight?: number | null;
377
+ /**
378
+ * Product weight range. The minimum and maximum weights of all the variants.
379
+ * @readonly
380
+ */
381
+ weightRange?: NumericPropertyRange;
382
+ /**
383
+ * Product inventory status (in future this will be writable via Inventory API).
384
+ * @readonly
385
+ */
386
+ stock?: Stock;
387
+ /**
388
+ * Deprecated (use `priceData` instead).
389
+ * @readonly
390
+ * @deprecated
391
+ */
392
+ price?: PriceData;
393
+ /** Price data. */
394
+ priceData?: PriceData;
395
+ /**
396
+ * Price data, converted to the currency specified in request header.
397
+ * @readonly
398
+ */
399
+ convertedPriceData?: PriceData;
400
+ /**
401
+ * Product price range. The minimum and maximum prices of all the variants.
402
+ * @readonly
403
+ */
404
+ priceRange?: NumericPropertyRange;
405
+ /** Cost and profit data. */
406
+ costAndProfitData?: CostAndProfitData;
407
+ /**
408
+ * Product cost range. The minimum and maximum costs of all the variants.
409
+ * @readonly
410
+ */
411
+ costRange?: NumericPropertyRange;
412
+ /** Price per unit data. */
413
+ pricePerUnitData?: PricePerUnitData;
414
+ /** Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.). */
415
+ additionalInfoSections?: AdditionalInfoSection[];
416
+ /**
417
+ * Deprecated (use `ribbon` instead).
418
+ * @readonly
419
+ * @deprecated
420
+ */
421
+ ribbons?: Ribbon[];
422
+ /**
423
+ * Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).
424
+ * @readonly
425
+ */
426
+ media?: Media;
427
+ /**
428
+ * Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
429
+ * @readonly
430
+ */
431
+ customTextFields?: CustomTextField[];
432
+ /** Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data. */
433
+ manageVariants?: boolean | null;
434
+ /**
435
+ * Options for this product.
436
+ * @maxSize 6
437
+ */
438
+ productOptions?: ProductOption[];
439
+ /**
440
+ * Product page URL for this product (generated automatically by the server).
441
+ * @readonly
442
+ */
443
+ productPageUrl?: PageUrl;
444
+ /**
445
+ * Product’s unique numeric ID (assigned in ascending order).
446
+ * Primarily used for sorting and filtering when crawling all products.
447
+ * @readonly
448
+ */
449
+ numericId?: string;
450
+ /**
451
+ * Inventory item ID - ID referencing the inventory system.
452
+ * @readonly
453
+ */
454
+ inventoryItemId?: string;
455
+ /** Discount deducted from the product's original price. */
456
+ discount?: Discount;
457
+ /**
458
+ * A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
459
+ * @readonly
460
+ */
461
+ collectionIds?: string[];
462
+ /**
463
+ * Product variants, will be provided if the request was sent with the `includeVariants: true`.
464
+ *
465
+ * Max: 1,000 variants
466
+ * @readonly
467
+ * @maxSize 1000
468
+ */
469
+ variants?: Variant[];
470
+ /**
471
+ * Date and time the product was last updated.
472
+ * @readonly
473
+ */
474
+ lastUpdated?: Date | null;
475
+ /**
476
+ * Date and time the product was created.
477
+ * @readonly
478
+ */
479
+ createdDate?: Date | null;
480
+ /** Custom SEO data for the product. */
481
+ seoData?: SeoSchema;
482
+ /**
483
+ * Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out".
484
+ * @maxLength 30
485
+ */
486
+ ribbon?: string | null;
487
+ /**
488
+ * Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores).
489
+ * @minLength 1
490
+ * @maxLength 50
491
+ */
492
+ brand?: string | null;
493
+ }
494
+ declare enum ProductType {
495
+ unspecified_product_type = "unspecified_product_type",
496
+ physical = "physical",
497
+ digital = "digital"
498
+ }
499
+ /** @enumType */
500
+ type ProductTypeWithLiterals = ProductType | 'unspecified_product_type' | 'physical' | 'digital';
501
+ interface NumericPropertyRange {
502
+ /** Minimum value. */
503
+ minValue?: number;
504
+ /** Maximum value. */
505
+ maxValue?: number;
506
+ }
507
+ interface Stock {
508
+ /** Whether inventory is being tracked */
509
+ trackInventory?: boolean;
510
+ /**
511
+ * Quantity currently left in inventory
512
+ * @max 99999
513
+ */
514
+ quantity?: number | null;
515
+ /**
516
+ * Whether the product is currently in stock (relevant only when tracking manually)
517
+ * Deprecated (use `inventoryStatus` instead)
518
+ * @deprecated
519
+ */
520
+ inStock?: boolean;
521
+ /**
522
+ * The current status of the inventory
523
+ * + `IN_STOCK` - In stock
524
+ * + `OUT_OF_STOCK` - Not in stock
525
+ * + `PARTIALLY_OUT_OF_STOCK` - Some of the variants are not in stock
526
+ */
527
+ inventoryStatus?: InventoryStatusWithLiterals;
528
+ }
529
+ declare enum InventoryStatus {
530
+ /** In stock */
531
+ IN_STOCK = "IN_STOCK",
532
+ /** Not in stock */
533
+ OUT_OF_STOCK = "OUT_OF_STOCK",
534
+ /** Some of the variants are not in stock */
535
+ PARTIALLY_OUT_OF_STOCK = "PARTIALLY_OUT_OF_STOCK"
536
+ }
537
+ /** @enumType */
538
+ type InventoryStatusWithLiterals = InventoryStatus | 'IN_STOCK' | 'OUT_OF_STOCK' | 'PARTIALLY_OUT_OF_STOCK';
539
+ interface PriceData {
540
+ /**
541
+ * Product price currency
542
+ * @readonly
543
+ */
544
+ currency?: string;
545
+ /**
546
+ * Product price
547
+ * @max 999999999.99
548
+ */
549
+ price?: number | null;
550
+ /**
551
+ * Discounted product price (if no discounted price is set, the product price is returned)
552
+ * @readonly
553
+ */
554
+ discountedPrice?: number;
555
+ /**
556
+ * The product price and discounted price, formatted with the currency
557
+ * @readonly
558
+ */
559
+ formatted?: FormattedPrice;
560
+ /**
561
+ * Price per unit
562
+ * @readonly
563
+ */
564
+ pricePerUnit?: number | null;
565
+ }
566
+ interface FormattedPrice {
567
+ /** Product price formatted with the currency */
568
+ price?: string;
569
+ /** Discounted product price formatted with the currency (if no discounted price is set, the product formatted price is returned) */
570
+ discountedPrice?: string;
571
+ /**
572
+ * Price per unit
573
+ * @readonly
574
+ */
575
+ pricePerUnit?: string | null;
576
+ }
577
+ interface CostAndProfitData {
578
+ /**
579
+ * Item cost.
580
+ * @max 999999999.99
581
+ */
582
+ itemCost?: number | null;
583
+ /**
584
+ * Item cost formatted with currency symbol.
585
+ * @readonly
586
+ */
587
+ formattedItemCost?: string;
588
+ /**
589
+ * Profit. Calculated by reducing `cost` from `discounted_price`.
590
+ * @readonly
591
+ * @max 999999999.99
592
+ */
593
+ profit?: number;
594
+ /**
595
+ * Profit formatted with currency symbol.
596
+ * @readonly
597
+ */
598
+ formattedProfit?: string;
599
+ /**
600
+ * Profit Margin. Calculated by dividing `profit` by `discounted_price`.
601
+ * The result is rounded to 4 decimal places.
602
+ * @readonly
603
+ * @max 1
604
+ */
605
+ profitMargin?: number;
606
+ }
607
+ interface PricePerUnitData {
608
+ /**
609
+ * Total quantity
610
+ * @min 0.01
611
+ * @max 999999999.99
612
+ */
613
+ totalQuantity?: number;
614
+ /** Total measurement unit */
615
+ totalMeasurementUnit?: MeasurementUnitWithLiterals;
616
+ /**
617
+ * Base quantity
618
+ * @min 0.01
619
+ * @max 999999999.99
620
+ */
621
+ baseQuantity?: number;
622
+ /** Base measurement unit */
623
+ baseMeasurementUnit?: MeasurementUnitWithLiterals;
624
+ }
625
+ declare enum MeasurementUnit {
626
+ UNSPECIFIED = "UNSPECIFIED",
627
+ ML = "ML",
628
+ CL = "CL",
629
+ L = "L",
630
+ CBM = "CBM",
631
+ MG = "MG",
632
+ G = "G",
633
+ KG = "KG",
634
+ MM = "MM",
635
+ CM = "CM",
636
+ M = "M",
637
+ SQM = "SQM",
638
+ OZ = "OZ",
639
+ LB = "LB",
640
+ FLOZ = "FLOZ",
641
+ PT = "PT",
642
+ QT = "QT",
643
+ GAL = "GAL",
644
+ IN = "IN",
645
+ FT = "FT",
646
+ YD = "YD",
647
+ SQFT = "SQFT"
648
+ }
649
+ /** @enumType */
650
+ type MeasurementUnitWithLiterals = MeasurementUnit | 'UNSPECIFIED' | 'ML' | 'CL' | 'L' | 'CBM' | 'MG' | 'G' | 'KG' | 'MM' | 'CM' | 'M' | 'SQM' | 'OZ' | 'LB' | 'FLOZ' | 'PT' | 'QT' | 'GAL' | 'IN' | 'FT' | 'YD' | 'SQFT';
651
+ interface AdditionalInfoSection {
652
+ /**
653
+ * Product info section title
654
+ * @maxLength 50
655
+ */
656
+ title?: string;
657
+ /**
658
+ * Product info section description
659
+ * @maxLength 16000
660
+ */
661
+ description?: string;
662
+ }
663
+ interface Ribbon {
664
+ /**
665
+ * Ribbon text
666
+ * @maxLength 30
667
+ */
668
+ text?: string;
669
+ }
670
+ interface Media {
671
+ /** Primary media (image, video etc) associated with this product. */
672
+ mainMedia?: MediaItem;
673
+ /** Media (images, videos etc) associated with this product. */
674
+ items?: MediaItem[];
675
+ }
676
+ interface MediaItem extends MediaItemItemOneOf {
677
+ /** Image data (URL, size). */
678
+ image?: MediaItemUrlAndSize;
679
+ /** Video data (URL, size). */
680
+ video?: MediaItemVideo;
681
+ /** Media item thumbnail details. */
682
+ thumbnail?: MediaItemUrlAndSize;
683
+ /** Media item type (image, video, etc.). */
684
+ mediaType?: MediaItemTypeWithLiterals;
685
+ /** Media item title. */
686
+ title?: string;
687
+ /** Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`). */
688
+ id?: string;
689
+ }
690
+ /** @oneof */
691
+ interface MediaItemItemOneOf {
692
+ /** Image data (URL, size). */
693
+ image?: MediaItemUrlAndSize;
694
+ /** Video data (URL, size). */
695
+ video?: MediaItemVideo;
696
+ }
697
+ interface MediaItemUrlAndSize {
698
+ /**
699
+ * Media item URL.
700
+ * @format WEB_URL
701
+ */
702
+ url?: string;
703
+ /** Media item width. */
704
+ width?: number;
705
+ /** Media item height. */
706
+ height?: number;
707
+ /** Media format (mp4, png, etc.). */
708
+ format?: string | null;
709
+ /** Alt text. This text will be shown in case the image is not available. */
710
+ altText?: string | null;
711
+ }
712
+ declare enum MediaItemType {
713
+ unspecified_media_item_type = "unspecified_media_item_type",
714
+ /** Image media type. */
715
+ image = "image",
716
+ /** Video media type. */
717
+ video = "video",
718
+ /** Audio media type. */
719
+ audio = "audio",
720
+ /** Document media type. */
721
+ document = "document",
722
+ /** Zip media type. */
723
+ zip = "zip"
724
+ }
725
+ /** @enumType */
726
+ type MediaItemTypeWithLiterals = MediaItemType | 'unspecified_media_item_type' | 'image' | 'video' | 'audio' | 'document' | 'zip';
727
+ interface MediaItemVideo {
728
+ /** Data (URL, size) about each resolution for which this video is available. */
729
+ files?: MediaItemUrlAndSize[];
730
+ /** ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`. */
731
+ stillFrameMediaId?: string;
732
+ }
733
+ interface CustomTextField {
734
+ /**
735
+ * Text box title
736
+ * @maxLength 100
737
+ */
738
+ title?: string;
739
+ /**
740
+ * Text box input max length
741
+ * @max 500
742
+ */
743
+ maxLength?: number;
744
+ /** Whether this text box is mandatory */
745
+ mandatory?: boolean;
746
+ }
747
+ interface ProductOption {
748
+ /**
749
+ * Option type.
750
+ * @readonly
751
+ */
752
+ optionType?: OptionTypeWithLiterals;
753
+ /**
754
+ * Option name.
755
+ * @minLength 1
756
+ * @maxLength 50
757
+ */
758
+ name?: string;
759
+ /**
760
+ * Choices available for this option.
761
+ * @minSize 1
762
+ * @maxSize 100
763
+ */
764
+ choices?: Choice[];
765
+ }
766
+ declare enum OptionType {
767
+ /** Unspecified option type. */
768
+ unspecified_option_type = "unspecified_option_type",
769
+ /** Drop down. */
770
+ drop_down = "drop_down",
771
+ /** Color. */
772
+ color = "color"
773
+ }
774
+ /** @enumType */
775
+ type OptionTypeWithLiterals = OptionType | 'unspecified_option_type' | 'drop_down' | 'color';
776
+ interface Choice {
777
+ /**
778
+ * Choice value.
779
+ * @minLength 1
780
+ * @maxLength 50
781
+ */
782
+ value?: string;
783
+ /**
784
+ * Choice description.
785
+ * @minLength 1
786
+ * @maxLength 50
787
+ */
788
+ description?: string;
789
+ /**
790
+ * Media items (images, videos) associated with this choice
791
+ * @readonly
792
+ */
793
+ media?: Media;
794
+ /**
795
+ * Based on the customer’s choices, which (if any) variants that include the selected choices are in stock
796
+ * @readonly
797
+ */
798
+ inStock?: boolean;
799
+ /**
800
+ * Based on the customer’s choices, which (if any) variants that include the selected choices are visible
801
+ * @readonly
802
+ */
803
+ visible?: boolean;
804
+ }
805
+ interface PageUrl {
806
+ /** Base URL. For premium sites, this is the domain. For free sites, this is the site URL (e.g mysite.wixsite.com/mysite). */
807
+ base?: string;
808
+ /** Path to the product page - e.g /product-page/a-product. */
809
+ path?: string;
810
+ }
811
+ interface Discount {
812
+ /**
813
+ * Discount type:
814
+ * + `"AMOUNT"`
815
+ * + `"PERCENT"`
816
+ */
817
+ type?: DiscountTypeWithLiterals;
818
+ /** Discount value */
819
+ value?: number;
820
+ }
821
+ declare enum DiscountType {
822
+ UNDEFINED = "UNDEFINED",
823
+ /** No discount */
824
+ NONE = "NONE",
825
+ /** Discount by a fixed amount */
826
+ AMOUNT = "AMOUNT",
827
+ /** Discount by a percentage */
828
+ PERCENT = "PERCENT"
829
+ }
830
+ /** @enumType */
831
+ type DiscountTypeWithLiterals = DiscountType | 'UNDEFINED' | 'NONE' | 'AMOUNT' | 'PERCENT';
832
+ interface Variant {
833
+ /**
834
+ * Requested Variant ID
835
+ * @format GUID
836
+ */
837
+ id?: string;
838
+ /** Specific choices within a selection, as option-choice key-value pairs */
839
+ choices?: Record<string, string>;
840
+ variant?: VariantDataWithNoStock;
841
+ /**
842
+ * Variant inventory status.
843
+ * @readonly
844
+ */
845
+ stock?: VariantStock;
846
+ }
847
+ interface VariantDataWithNoStock {
848
+ /** Variant price. */
849
+ priceData?: PriceData;
850
+ /**
851
+ * Variant price data, converted to currency requested in header.
852
+ * @readonly
853
+ */
854
+ convertedPriceData?: PriceData;
855
+ /** Cost and profit data. */
856
+ costAndProfitData?: CostAndProfitData;
857
+ /** Variant weight. */
858
+ weight?: number;
859
+ /** Variant SKU (stock keeping unit). */
860
+ sku?: string;
861
+ /** Whether the variant is visible to customers. */
862
+ visible?: boolean;
863
+ }
864
+ interface VariantStock {
865
+ /** Whether inventory is being tracked. */
866
+ trackQuantity?: boolean;
867
+ /**
868
+ * Quantity currently left in inventory.
869
+ * @max 99999
870
+ */
871
+ quantity?: number | null;
872
+ /** Whether the product is currently in stock (relevant only when tracking manually). */
873
+ inStock?: boolean;
874
+ }
875
+ /**
876
+ * 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.
877
+ * The search engines use this information for ranking purposes, or to display snippets in the search results.
878
+ * 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.
879
+ */
880
+ interface SeoSchema {
881
+ /** SEO tag information. */
882
+ tags?: Tag[];
883
+ /** SEO general settings. */
884
+ settings?: Settings;
885
+ }
886
+ interface Keyword {
887
+ /** Keyword value. */
888
+ term?: string;
889
+ /** Whether the keyword is the main focus keyword. */
890
+ isMain?: boolean;
891
+ /**
892
+ * The source that added the keyword terms to the SEO settings.
893
+ * @maxLength 1000
894
+ */
895
+ origin?: string | null;
896
+ }
897
+ interface Tag {
898
+ /**
899
+ * SEO tag type.
900
+ *
901
+ *
902
+ * Supported values: `title`, `meta`, `script`, `link`.
903
+ */
904
+ type?: string;
905
+ /**
906
+ * A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.
907
+ * For example: `{"name": "description", "content": "the description itself"}`.
908
+ */
909
+ props?: Record<string, any> | null;
910
+ /** SEO tag metadata. For example, `{"height": 300, "width": 240}`. */
911
+ meta?: Record<string, any> | null;
912
+ /** SEO tag inner content. For example, `<title> inner content </title>`. */
913
+ children?: string;
914
+ /** Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages). */
915
+ custom?: boolean;
916
+ /** Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines. */
917
+ disabled?: boolean;
918
+ }
919
+ interface Settings {
920
+ /**
921
+ * 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.
922
+ *
923
+ *
924
+ * Default: `false` (automatical redirect is enabled).
925
+ */
926
+ preventAutoRedirect?: boolean;
927
+ /**
928
+ * User-selected keyword terms for a specific page.
929
+ * @maxSize 5
930
+ */
931
+ keywords?: Keyword[];
932
+ }
933
+ interface SecuredMedia {
934
+ /**
935
+ * Media ID in Wix Media Manager.
936
+ * @minLength 1
937
+ * @maxLength 100
938
+ */
939
+ id?: string;
940
+ /**
941
+ * Original filename.
942
+ * @minLength 1
943
+ * @maxLength 1000
944
+ */
945
+ fileName?: string;
946
+ /** File type. */
947
+ fileType?: FileTypeWithLiterals;
948
+ }
949
+ declare enum FileType {
950
+ UNSPECIFIED = "UNSPECIFIED",
951
+ SECURE_PICTURE = "SECURE_PICTURE",
952
+ SECURE_VIDEO = "SECURE_VIDEO",
953
+ SECURE_DOCUMENT = "SECURE_DOCUMENT",
954
+ SECURE_MUSIC = "SECURE_MUSIC",
955
+ SECURE_ARCHIVE = "SECURE_ARCHIVE"
956
+ }
957
+ /** @enumType */
958
+ type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
959
+ interface StoreVariant {
960
+ /** Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen: {productId}.{variantId}. */
961
+ id?: string;
962
+ /**
963
+ * Variant ID.
964
+ * @format GUID
965
+ */
966
+ variantId?: string;
967
+ /** Product ID. */
968
+ productId?: string;
969
+ /**
970
+ * Variant name.
971
+ * @minLength 1
972
+ * @maxLength 80
973
+ */
974
+ variantName?: string;
975
+ /**
976
+ * Product name.
977
+ * @minLength 1
978
+ * @maxLength 80
979
+ */
980
+ productName?: string;
981
+ /** Whether the variant is managed or represents a product. */
982
+ managedVariant?: boolean;
983
+ /**
984
+ * Variant SKU (stock keeping unit).
985
+ * @maxLength 40
986
+ */
987
+ sku?: string;
988
+ /** Variant inventory status. */
989
+ stock?: VariantStock;
990
+ /** The selected options of this variant. For example, `{"Color": "Blue", "Size": "Large"}`. */
991
+ choices?: Record<string, string>;
992
+ /**
993
+ * Collections that include this variant.
994
+ * @format GUID
995
+ */
996
+ collectionIds?: string[];
997
+ /**
998
+ * Media items (images, videos) associated with this variant.
999
+ * @readonly
1000
+ */
1001
+ media?: PlatformMedia;
1002
+ /** Preorder information. */
1003
+ preorderInfo?: PreorderInfo;
1004
+ }
1005
+ interface PlatformMedia extends PlatformMediaMediaOneOf {
1006
+ image?: Image;
1007
+ video?: VideoV2;
1008
+ }
1009
+ /** @oneof */
1010
+ interface PlatformMediaMediaOneOf {
1011
+ image?: Image;
1012
+ video?: VideoV2;
1013
+ }
1014
+ interface Image {
1015
+ /** WixMedia image ID. */
1016
+ id?: string;
1017
+ /** Image URL. */
1018
+ url?: string;
1019
+ /**
1020
+ * Original image height.
1021
+ * @readonly
1022
+ */
1023
+ height?: number;
1024
+ /**
1025
+ * Original image width.
1026
+ * @readonly
1027
+ */
1028
+ width?: number;
1029
+ /** Image alt text. */
1030
+ altText?: string | null;
1031
+ /**
1032
+ * Image filename.
1033
+ * @readonly
1034
+ */
1035
+ filename?: string | null;
1036
+ }
1037
+ interface FocalPoint {
1038
+ /** X-coordinate of the focal point. */
1039
+ x?: number;
1040
+ /** Y-coordinate of the focal point. */
1041
+ y?: number;
1042
+ /** crop by height */
1043
+ height?: number | null;
1044
+ /** crop by width */
1045
+ width?: number | null;
1046
+ }
1047
+ interface VideoV2 {
1048
+ /** WixMedia ID. */
1049
+ id?: string;
1050
+ /**
1051
+ * Available resolutions for the video, starting with the optimal resolution.
1052
+ * @readonly
1053
+ * @maxSize 100
1054
+ */
1055
+ resolutions?: VideoResolution[];
1056
+ /**
1057
+ * Video filename.
1058
+ * @readonly
1059
+ */
1060
+ filename?: string | null;
1061
+ }
1062
+ interface VideoResolution {
1063
+ /** Video URL. */
1064
+ url?: string;
1065
+ /** Video height. */
1066
+ height?: number;
1067
+ /** Video width. */
1068
+ width?: number;
1069
+ /** Video format for example, mp4, hls. */
1070
+ format?: string;
1071
+ }
1072
+ interface PreorderInfo {
1073
+ /** Whether the item is available for preorder. */
1074
+ enabled?: boolean;
1075
+ /**
1076
+ * A message the buyer will see when the item is out of stock and preorder is enabled.
1077
+ * @minLength 1
1078
+ * @maxLength 250
1079
+ */
1080
+ message?: string | null;
1081
+ /**
1082
+ * Number of products that can be preordered after stock reaches zero.
1083
+ * @max 100000
1084
+ */
1085
+ limit?: number | null;
1086
+ }
1087
+ interface QueryProductsExportSpiResponse {
1088
+ items?: ProductOrVariantV2[];
1089
+ pagingMetadata?: PagingMetadataV2;
1090
+ }
1091
+ interface ProductOrVariantV2 {
1092
+ kind?: string;
1093
+ product?: Product;
1094
+ variant?: Variant;
1095
+ }
1096
+ /** @docsIgnore */
1097
+ type CreateExportAsyncJobApplicationErrors = {
1098
+ code?: 'method_endpoint_not_found';
1099
+ description?: string;
1100
+ data?: Record<string, any>;
1101
+ };
1102
+ /** @docsIgnore */
1103
+ type GetExportAsyncJobApplicationErrors = {
1104
+ code?: 'job_not_found';
1105
+ description?: string;
1106
+ data?: Record<string, any>;
1107
+ } | {
1108
+ code?: 'get_async_job_internal';
1109
+ description?: string;
1110
+ data?: Record<string, any>;
1111
+ } | {
1112
+ code?: 'method_endpoint_permission_denied';
1113
+ description?: string;
1114
+ data?: Record<string, any>;
1115
+ };
303
1116
 
304
1117
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
305
1118
  getUrl: (context: any) => string;
@@ -316,4 +1129,4 @@ declare function getExportAsyncJob(): __PublicMethodMetaInfo<'GET', {
316
1129
  jobId: string;
317
1130
  }, GetExportAsyncJobRequest$1, GetExportAsyncJobRequest, GetExportAsyncJobResponse$1, GetExportAsyncJobResponse>;
318
1131
 
319
- export { type __PublicMethodMetaInfo, createExportAsyncJob, getExportAsyncJob };
1132
+ export { type AdditionalInfoSection as AdditionalInfoSectionOriginal, type ApplicationError as ApplicationErrorOriginal, ArrayFieldDelimiter as ArrayFieldDelimiterOriginal, type ArrayFieldDelimiterWithLiterals as ArrayFieldDelimiterWithLiteralsOriginal, type CancelExportAsyncJobRequest as CancelExportAsyncJobRequestOriginal, type CancelExportAsyncJobResponse as CancelExportAsyncJobResponseOriginal, type Choice as ChoiceOriginal, type CostAndProfitData as CostAndProfitDataOriginal, type CreateExportAsyncJobApplicationErrors as CreateExportAsyncJobApplicationErrorsOriginal, type CreateExportAsyncJobRequest as CreateExportAsyncJobRequestOriginal, type CreateExportAsyncJobResponse as CreateExportAsyncJobResponseOriginal, type Cursors as CursorsOriginal, type CustomTextField as CustomTextFieldOriginal, type DetailsKindOneOf as DetailsKindOneOfOriginal, type Details as DetailsOriginal, type Discount as DiscountOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type ExportAsyncJobData as ExportAsyncJobDataOriginal, type ExportAsyncJob as ExportAsyncJobOriginal, type ExportCursorPaging as ExportCursorPagingOriginal, type ExportQueryV2 as ExportQueryV2Original, type ExportQueryV2PagingMethodOneOf as ExportQueryV2PagingMethodOneOfOriginal, type FieldDescriptor as FieldDescriptorOriginal, type FieldViolation as FieldViolationOriginal, FileType as FileTypeOriginal, type FileTypeWithLiterals as FileTypeWithLiteralsOriginal, type FocalPoint as FocalPointOriginal, type FormattedPrice as FormattedPriceOriginal, type GenerateExportAsyncJobDownloadUrlRequest as GenerateExportAsyncJobDownloadUrlRequestOriginal, type GenerateExportAsyncJobDownloadUrlResponse as GenerateExportAsyncJobDownloadUrlResponseOriginal, type GetExportAsyncJobApplicationErrors as GetExportAsyncJobApplicationErrorsOriginal, type GetExportAsyncJobRequest as GetExportAsyncJobRequestOriginal, type GetExportAsyncJobResponse as GetExportAsyncJobResponseOriginal, type Image as ImageOriginal, InventoryStatus as InventoryStatusOriginal, type InventoryStatusWithLiterals as InventoryStatusWithLiteralsOriginal, type Keyword as KeywordOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MediaItemItemOneOf as MediaItemItemOneOfOriginal, type MediaItem as MediaItemOriginal, MediaItemType as MediaItemTypeOriginal, type MediaItemTypeWithLiterals as MediaItemTypeWithLiteralsOriginal, type MediaItemUrlAndSize as MediaItemUrlAndSizeOriginal, type MediaItemVideo as MediaItemVideoOriginal, type Media as MediaOriginal, type MethodMetadata as MethodMetadataOriginal, type MethodSpec as MethodSpecOriginal, type NumericPropertyRange as NumericPropertyRangeOriginal, OptionType as OptionTypeOriginal, type OptionTypeWithLiterals as OptionTypeWithLiteralsOriginal, type PageUrl as PageUrlOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type PlatformMediaMediaOneOf as PlatformMediaMediaOneOfOriginal, type PlatformMedia as PlatformMediaOriginal, type PreorderInfo as PreorderInfoOriginal, type PriceData as PriceDataOriginal, type PricePerUnitData as PricePerUnitDataOriginal, type ProductOption as ProductOptionOriginal, type ProductOrVariant as ProductOrVariantOriginal, type ProductOrVariantV2 as ProductOrVariantV2Original, type Product as ProductOriginal, ProductType as ProductTypeOriginal, type ProductTypeWithLiterals as ProductTypeWithLiteralsOriginal, QueryFieldNumber as QueryFieldNumberOriginal, type QueryFieldNumberWithLiterals as QueryFieldNumberWithLiteralsOriginal, type QueryProductsExportSpiResponse as QueryProductsExportSpiResponseOriginal, type QueryRequestLoose as QueryRequestLooseOriginal, type QueryVariantsExportSpiResponse as QueryVariantsExportSpiResponseOriginal, type Ribbon as RibbonOriginal, RuleType as RuleTypeOriginal, type RuleTypeWithLiterals as RuleTypeWithLiteralsOriginal, type SecuredMedia as SecuredMediaOriginal, type SeoSchema as SeoSchemaOriginal, type Settings as SettingsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type Stock as StockOriginal, type StoreVariant as StoreVariantOriginal, type SystemError as SystemErrorOriginal, type Tag as TagOriginal, type ValidationError as ValidationErrorOriginal, type VariantDataWithNoStock as VariantDataWithNoStockOriginal, type Variant as VariantOriginal, type VariantStock as VariantStockOriginal, type VideoResolution as VideoResolutionOriginal, type VideoV2 as VideoV2Original, type __PublicMethodMetaInfo, createExportAsyncJob, getExportAsyncJob };