@wix/auto_sdk_stores_products-v-3 1.0.65 → 1.0.66

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.
@@ -1864,6 +1864,27 @@ interface BorderColors {
1864
1864
  */
1865
1865
  bottom?: string | null;
1866
1866
  }
1867
+ /**
1868
+ * `NullValue` is a singleton enumeration to represent the null value for the
1869
+ * `Value` type union.
1870
+ *
1871
+ * The JSON representation for `NullValue` is JSON `null`.
1872
+ */
1873
+ declare enum NullValue {
1874
+ /** Null value. */
1875
+ NULL_VALUE = "NULL_VALUE"
1876
+ }
1877
+ /** @enumType */
1878
+ type NullValueWithLiterals = NullValue | 'NULL_VALUE';
1879
+ /**
1880
+ * `ListValue` is a wrapper around a repeated field of values.
1881
+ *
1882
+ * The JSON representation for `ListValue` is JSON array.
1883
+ */
1884
+ interface ListValue {
1885
+ /** Repeated field of dynamically typed values. */
1886
+ values?: any[];
1887
+ }
1867
1888
  interface AudioData {
1868
1889
  /** Styling for the audio node's container. */
1869
1890
  containerData?: PluginContainerData;
@@ -2304,6 +2325,16 @@ declare enum ChoiceType {
2304
2325
  }
2305
2326
  /** @enumType */
2306
2327
  type ChoiceTypeWithLiterals = ChoiceType | 'UNKNOWN_CHOICE_TYPE' | 'CHOICE_TEXT' | 'ONE_COLOR' | 'MULTIPLE_COLORS' | 'IMAGE';
2328
+ interface MultipleColors {
2329
+ /**
2330
+ * List of color codes.
2331
+ * @minLength 3
2332
+ * @maxLength 20
2333
+ * @minSize 2
2334
+ * @maxSize 2
2335
+ */
2336
+ colorCodes?: string[];
2337
+ }
2307
2338
  interface ConnectedModifier extends ConnectedModifierModifierSettingsOneOf {
2308
2339
  /** Free text modifier settings. */
2309
2340
  freeTextSettings?: FreeTextSettings;
@@ -2506,6 +2537,15 @@ interface ProductCategory {
2506
2537
  */
2507
2538
  index?: number | null;
2508
2539
  }
2540
+ interface ProductCategoryIdsInfo {
2541
+ /**
2542
+ * A list of category ids related to product.
2543
+ * @readonly
2544
+ * @maxSize 2000
2545
+ * @format GUID
2546
+ */
2547
+ categoryIds?: string[];
2548
+ }
2509
2549
  interface PriceRange {
2510
2550
  /** Minimum value. */
2511
2551
  minValue?: FixedMonetaryAmount;
@@ -3147,6 +3187,82 @@ interface VariantSummary {
3147
3187
  */
3148
3188
  variantCount?: number;
3149
3189
  }
3190
+ interface MinVariantPriceInfo {
3191
+ /**
3192
+ * Subscription price calculated by applying subscription discount to the variant `price.actualPrice`
3193
+ * @readonly
3194
+ */
3195
+ minSubscriptionPrice?: FixedMonetaryAmount;
3196
+ /**
3197
+ * Subscription price per unit calculated value of price per unit.
3198
+ * Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.
3199
+ * @readonly
3200
+ * @decimalValue options { gte:0, lte:999999999, maxScale:3 }
3201
+ */
3202
+ minSubscriptionPricePerUnit?: string | null;
3203
+ /**
3204
+ * Variant price per unit.
3205
+ * @readonly
3206
+ */
3207
+ pricePerUnitData?: PricePerUnit;
3208
+ /**
3209
+ * Variant SKU (stock keeping unit).
3210
+ * @readonly
3211
+ * @minLength 1
3212
+ * @maxLength 40
3213
+ */
3214
+ sku?: string | null;
3215
+ /**
3216
+ * Variant shipping weight.
3217
+ * @readonly
3218
+ * @max 999999999.99
3219
+ */
3220
+ weight?: number | null;
3221
+ /**
3222
+ * Variant revenue details.
3223
+ *
3224
+ * > **Note:** Returned only when the following conditions are met:
3225
+ * > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests.
3226
+ * > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
3227
+ * @readonly
3228
+ */
3229
+ revenueDetails?: RevenueDetails;
3230
+ /** Variant price. Must be greater or equal to 0. */
3231
+ actualPrice?: FixedMonetaryAmount;
3232
+ /** The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings. */
3233
+ compareAtPrice?: FixedMonetaryAmount;
3234
+ }
3235
+ interface CreateBatchRequest {
3236
+ }
3237
+ interface CreateBatchResponse {
3238
+ /**
3239
+ * Batch ID to use in subsequent BulkAddItems and SubmitBatch calls
3240
+ * @format GUID
3241
+ */
3242
+ batchId?: string;
3243
+ }
3244
+ interface BulkAddProductsToBatchRequest {
3245
+ /**
3246
+ * Batch ID from CreateBatch
3247
+ * @format GUID
3248
+ */
3249
+ batchId?: string;
3250
+ /**
3251
+ * Products to add to the batch session
3252
+ * @minSize 1
3253
+ * @maxSize 100
3254
+ */
3255
+ products?: ProductItem[];
3256
+ }
3257
+ interface ProductItem {
3258
+ /** Product to upsert - handle field is required for identification */
3259
+ product?: ProductWithInventory;
3260
+ /**
3261
+ * Categories to set for the product.
3262
+ * Overrides any existing category assignments.
3263
+ */
3264
+ categoryIdsInfo?: V3ProductCategoryIdsInfo;
3265
+ }
3150
3266
  interface ProductWithInventory extends ProductWithInventoryTypedPropertiesOneOf {
3151
3267
  /**
3152
3268
  * Physical properties.
@@ -3481,6 +3597,37 @@ interface V3OptionChoiceNames {
3481
3597
  /** Render type. */
3482
3598
  renderType?: ProductOptionRenderTypeWithLiterals;
3483
3599
  }
3600
+ interface V3ProductCategoryIdsInfo {
3601
+ /**
3602
+ * List of category IDs to set for the product
3603
+ * @maxSize 1000
3604
+ * @format GUID
3605
+ */
3606
+ categoryIds?: string[];
3607
+ }
3608
+ interface BulkAddProductsToBatchResponse {
3609
+ /**
3610
+ * Items added by bulk action.
3611
+ * @minSize 1
3612
+ * @maxSize 100
3613
+ */
3614
+ results?: BulkItemResult[];
3615
+ /** Bulk action metadata. */
3616
+ bulkActionMetadata?: CommonBulkActionMetadata;
3617
+ }
3618
+ interface WixCommonItemMetadata {
3619
+ /**
3620
+ * Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed.
3621
+ * @format GUID
3622
+ */
3623
+ id?: string | null;
3624
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
3625
+ originalIndex?: number;
3626
+ /** Whether the requested action for this item was successful. When `false`, the `error` field is returned. */
3627
+ success?: boolean;
3628
+ /** Details about the error in case of failure. */
3629
+ error?: ApplicationError;
3630
+ }
3484
3631
  interface ApplicationError {
3485
3632
  /** Error code. */
3486
3633
  code?: string;
@@ -3489,6 +3636,430 @@ interface ApplicationError {
3489
3636
  /** Data related to the error. */
3490
3637
  data?: Record<string, any> | null;
3491
3638
  }
3639
+ interface BulkItemResult {
3640
+ /** Bulk action metadata for item. */
3641
+ itemMetadata?: WixCommonItemMetadata;
3642
+ }
3643
+ interface CommonBulkActionMetadata {
3644
+ /** Number of items that were successfully processed. */
3645
+ totalSuccesses?: number;
3646
+ /** Number of items that couldn't be processed. */
3647
+ totalFailures?: number;
3648
+ /** Number of failures without details because detailed failure threshold was exceeded. */
3649
+ undetailedFailures?: number;
3650
+ }
3651
+ interface SubmitBatchRequest {
3652
+ /**
3653
+ * Batch ID from CreateBatch
3654
+ * @format GUID
3655
+ */
3656
+ batchId?: string;
3657
+ }
3658
+ interface SubmitBatchResponse {
3659
+ /**
3660
+ * Job ID for async operation tracking. Pass to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/get-async-job) or [List Async Job Items](https://dev.wix.com/docs/rest/business-management/async-job/list-async-job-items) to retrieve details and metadata
3661
+ * @format GUID
3662
+ */
3663
+ jobId?: string;
3664
+ /** Total number of products submitted for processing */
3665
+ totalProducts?: number;
3666
+ }
3667
+ interface UpdateDocumentsEvent extends UpdateDocumentsEventOperationOneOf {
3668
+ /** insert/update documents */
3669
+ update?: DocumentUpdateOperation;
3670
+ /** delete by document ids */
3671
+ deleteByIds?: DeleteByIdsOperation;
3672
+ /** delete documents matching filter */
3673
+ deleteByFilter?: DeleteByFilterOperation;
3674
+ /** update documents matching filter */
3675
+ updateByFilter?: UpdateByFilterOperation;
3676
+ /** update only existing documents */
3677
+ updateExisting?: UpdateExistingOperation;
3678
+ /**
3679
+ * application which owns documents
3680
+ * @minLength 2
3681
+ */
3682
+ appDefId?: string | null;
3683
+ /**
3684
+ * type of the documents
3685
+ * @minLength 2
3686
+ */
3687
+ documentType?: string | null;
3688
+ /**
3689
+ * language of the documents
3690
+ * @minLength 2
3691
+ */
3692
+ language?: string | null;
3693
+ /**
3694
+ * site documents belong to
3695
+ * @minLength 2
3696
+ */
3697
+ msId?: string | null;
3698
+ }
3699
+ /** @oneof */
3700
+ interface UpdateDocumentsEventOperationOneOf {
3701
+ /** insert/update documents */
3702
+ update?: DocumentUpdateOperation;
3703
+ /** delete by document ids */
3704
+ deleteByIds?: DeleteByIdsOperation;
3705
+ /** delete documents matching filter */
3706
+ deleteByFilter?: DeleteByFilterOperation;
3707
+ /** update documents matching filter */
3708
+ updateByFilter?: UpdateByFilterOperation;
3709
+ /** update only existing documents */
3710
+ updateExisting?: UpdateExistingOperation;
3711
+ }
3712
+ interface DocumentUpdateOperation {
3713
+ /** documents to index or update */
3714
+ documents?: IndexDocument[];
3715
+ }
3716
+ interface IndexDocument {
3717
+ /** data bag with non-searchable fields (url, image) */
3718
+ payload?: DocumentPayload;
3719
+ /** what type of users should documents be visible to */
3720
+ exposure?: EnumWithLiterals;
3721
+ /** document with mandatory fields (id, title, description) and with fields specific to the type of the document */
3722
+ document?: Record<string, any> | null;
3723
+ /** what member groups is the document exposed to. Used only with GROUP_PROTECTED exposure */
3724
+ permittedMemberGroups?: string[];
3725
+ /** if true SEO is disabled for this document */
3726
+ seoHidden?: boolean | null;
3727
+ /** if true the page is a lightbox popup */
3728
+ isPopup?: boolean | null;
3729
+ }
3730
+ interface DocumentPayload {
3731
+ /** url of the page representing the document */
3732
+ url?: string | null;
3733
+ /** image which represents the document */
3734
+ documentImage?: DocumentImage;
3735
+ }
3736
+ interface DocumentImage {
3737
+ /** the name of the image */
3738
+ name?: string;
3739
+ /** the width of the image */
3740
+ width?: number;
3741
+ /** the height of the image */
3742
+ height?: number;
3743
+ }
3744
+ declare enum Enum {
3745
+ /** Default value. Means that permission not set */
3746
+ UNKNOWN = "UNKNOWN",
3747
+ /** Protected exposure. Exposed to members and owners */
3748
+ PROTECTED = "PROTECTED",
3749
+ /** Private exposure. Exposed to owners */
3750
+ PRIVATE = "PRIVATE",
3751
+ /** Public exposure. Visible to everyone */
3752
+ PUBLIC = "PUBLIC",
3753
+ /** Used for partial updates, to state that exposure is not changing */
3754
+ UNCHANGED = "UNCHANGED",
3755
+ /** Protected to members of permitted groups and owners */
3756
+ GROUP_PROTECTED = "GROUP_PROTECTED"
3757
+ }
3758
+ /** @enumType */
3759
+ type EnumWithLiterals = Enum | 'UNKNOWN' | 'PROTECTED' | 'PRIVATE' | 'PUBLIC' | 'UNCHANGED' | 'GROUP_PROTECTED';
3760
+ interface DeleteByIdsOperation {
3761
+ /** ids of the documents to delete */
3762
+ documentIds?: string[];
3763
+ }
3764
+ interface DeleteByFilterOperation {
3765
+ /** documents matching this filter wil be deleted. only filterable documents defined in document_type can be used for filtering */
3766
+ filter?: Record<string, any> | null;
3767
+ }
3768
+ interface UpdateByFilterOperation {
3769
+ /** documents matching this filter will be updated */
3770
+ filter?: Record<string, any> | null;
3771
+ /** partial document to apply */
3772
+ document?: IndexDocument;
3773
+ }
3774
+ interface UpdateExistingOperation {
3775
+ /** documents to update */
3776
+ documents?: IndexDocument[];
3777
+ }
3778
+ interface DomainEvent extends DomainEventBodyOneOf {
3779
+ createdEvent?: EntityCreatedEvent;
3780
+ updatedEvent?: EntityUpdatedEvent;
3781
+ deletedEvent?: EntityDeletedEvent;
3782
+ actionEvent?: ActionEvent;
3783
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
3784
+ id?: string;
3785
+ /**
3786
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
3787
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
3788
+ */
3789
+ entityFqdn?: string;
3790
+ /**
3791
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
3792
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
3793
+ */
3794
+ slug?: string;
3795
+ /** ID of the entity associated with the event. */
3796
+ entityId?: string;
3797
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
3798
+ eventTime?: Date | null;
3799
+ /**
3800
+ * Whether the event was triggered as a result of a privacy regulation application
3801
+ * (for example, GDPR).
3802
+ */
3803
+ triggeredByAnonymizeRequest?: boolean | null;
3804
+ /** If present, indicates the action that triggered the event. */
3805
+ originatedFrom?: string | null;
3806
+ /**
3807
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
3808
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
3809
+ */
3810
+ entityEventSequence?: string | null;
3811
+ }
3812
+ /** @oneof */
3813
+ interface DomainEventBodyOneOf {
3814
+ createdEvent?: EntityCreatedEvent;
3815
+ updatedEvent?: EntityUpdatedEvent;
3816
+ deletedEvent?: EntityDeletedEvent;
3817
+ actionEvent?: ActionEvent;
3818
+ }
3819
+ interface EntityCreatedEvent {
3820
+ entityAsJson?: string;
3821
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
3822
+ restoreInfo?: RestoreInfo;
3823
+ }
3824
+ interface RestoreInfo {
3825
+ deletedDate?: Date | null;
3826
+ }
3827
+ interface EntityUpdatedEvent {
3828
+ /**
3829
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
3830
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
3831
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
3832
+ */
3833
+ currentEntityAsJson?: string;
3834
+ }
3835
+ interface EntityDeletedEvent {
3836
+ /** Entity that was deleted. */
3837
+ deletedEntityAsJson?: string | null;
3838
+ }
3839
+ interface ActionEvent {
3840
+ bodyAsJson?: string;
3841
+ }
3842
+ interface Empty {
3843
+ }
3844
+ interface SearchIndexingNotification {
3845
+ /** new state of indexing for the site specified in ms_id */
3846
+ indexState?: StateWithLiterals;
3847
+ /** type of the document the notification is targeted for. Applies to all types if not provided */
3848
+ documentType?: string | null;
3849
+ /** languaInternalDocumentUpdateByFilterOperationge the notification is targeted for. Applies to all languages if not provided */
3850
+ language?: string | null;
3851
+ /**
3852
+ * site for which notification is targeted
3853
+ * @minLength 2
3854
+ */
3855
+ msId?: string | null;
3856
+ }
3857
+ declare enum State {
3858
+ /** default state */
3859
+ Unknown = "Unknown",
3860
+ /** metasite does not require site search indexing */
3861
+ Off = "Off",
3862
+ /** metasite requires site search indexing */
3863
+ On = "On"
3864
+ }
3865
+ /** @enumType */
3866
+ type StateWithLiterals = State | 'Unknown' | 'Off' | 'On';
3867
+ interface MessageEnvelope {
3868
+ /**
3869
+ * App instance ID.
3870
+ * @format GUID
3871
+ */
3872
+ instanceId?: string | null;
3873
+ /**
3874
+ * Event type.
3875
+ * @maxLength 150
3876
+ */
3877
+ eventType?: string;
3878
+ /** The identification type and identity data. */
3879
+ identity?: IdentificationData;
3880
+ /** Stringify payload. */
3881
+ data?: string;
3882
+ }
3883
+ interface IdentificationData extends IdentificationDataIdOneOf {
3884
+ /**
3885
+ * ID of a site visitor that has not logged in to the site.
3886
+ * @format GUID
3887
+ */
3888
+ anonymousVisitorId?: string;
3889
+ /**
3890
+ * ID of a site visitor that has logged in to the site.
3891
+ * @format GUID
3892
+ */
3893
+ memberId?: string;
3894
+ /**
3895
+ * ID of a Wix user (site owner, contributor, etc.).
3896
+ * @format GUID
3897
+ */
3898
+ wixUserId?: string;
3899
+ /**
3900
+ * ID of an app.
3901
+ * @format GUID
3902
+ */
3903
+ appId?: string;
3904
+ /** @readonly */
3905
+ identityType?: WebhookIdentityTypeWithLiterals;
3906
+ }
3907
+ /** @oneof */
3908
+ interface IdentificationDataIdOneOf {
3909
+ /**
3910
+ * ID of a site visitor that has not logged in to the site.
3911
+ * @format GUID
3912
+ */
3913
+ anonymousVisitorId?: string;
3914
+ /**
3915
+ * ID of a site visitor that has logged in to the site.
3916
+ * @format GUID
3917
+ */
3918
+ memberId?: string;
3919
+ /**
3920
+ * ID of a Wix user (site owner, contributor, etc.).
3921
+ * @format GUID
3922
+ */
3923
+ wixUserId?: string;
3924
+ /**
3925
+ * ID of an app.
3926
+ * @format GUID
3927
+ */
3928
+ appId?: string;
3929
+ }
3930
+ declare enum WebhookIdentityType {
3931
+ UNKNOWN = "UNKNOWN",
3932
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
3933
+ MEMBER = "MEMBER",
3934
+ WIX_USER = "WIX_USER",
3935
+ APP = "APP"
3936
+ }
3937
+ /** @enumType */
3938
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
3939
+ interface InvalidateCache extends InvalidateCacheGetByOneOf {
3940
+ /**
3941
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
3942
+ * @format GUID
3943
+ */
3944
+ metaSiteId?: string;
3945
+ /**
3946
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
3947
+ * @format GUID
3948
+ */
3949
+ siteId?: string;
3950
+ /** Invalidate by App */
3951
+ app?: App;
3952
+ /** Invalidate by page id */
3953
+ page?: Page;
3954
+ /** Invalidate by URI path */
3955
+ uri?: URI;
3956
+ /** Invalidate by file (for media files such as PDFs) */
3957
+ file?: File;
3958
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
3959
+ customTag?: CustomTag;
3960
+ /**
3961
+ * tell us why you're invalidating the cache. You don't need to add your app name
3962
+ * @maxLength 256
3963
+ */
3964
+ reason?: string | null;
3965
+ /** Is local DS */
3966
+ localDc?: boolean;
3967
+ hardPurge?: boolean;
3968
+ }
3969
+ /** @oneof */
3970
+ interface InvalidateCacheGetByOneOf {
3971
+ /**
3972
+ * Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!
3973
+ * @format GUID
3974
+ */
3975
+ metaSiteId?: string;
3976
+ /**
3977
+ * Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!
3978
+ * @format GUID
3979
+ */
3980
+ siteId?: string;
3981
+ /** Invalidate by App */
3982
+ app?: App;
3983
+ /** Invalidate by page id */
3984
+ page?: Page;
3985
+ /** Invalidate by URI path */
3986
+ uri?: URI;
3987
+ /** Invalidate by file (for media files such as PDFs) */
3988
+ file?: File;
3989
+ /** Invalidate by custom tag. Tags used in BO invalidation are disabled for this endpoint (more info: https://wix-bo.com/dev/clear-ssr-cache) */
3990
+ customTag?: CustomTag;
3991
+ }
3992
+ interface App {
3993
+ /**
3994
+ * The AppDefId
3995
+ * @minLength 1
3996
+ */
3997
+ appDefId?: string;
3998
+ /**
3999
+ * The instance Id
4000
+ * @format GUID
4001
+ */
4002
+ instanceId?: string;
4003
+ }
4004
+ interface Page {
4005
+ /**
4006
+ * the msid the page is on
4007
+ * @format GUID
4008
+ */
4009
+ metaSiteId?: string;
4010
+ /**
4011
+ * Invalidate by Page ID
4012
+ * @minLength 1
4013
+ */
4014
+ pageId?: string;
4015
+ }
4016
+ interface URI {
4017
+ /**
4018
+ * the msid the URI is on
4019
+ * @format GUID
4020
+ */
4021
+ metaSiteId?: string;
4022
+ /**
4023
+ * URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes
4024
+ * @minLength 1
4025
+ */
4026
+ uriPath?: string;
4027
+ }
4028
+ interface File {
4029
+ /**
4030
+ * the msid the file is related to
4031
+ * @format GUID
4032
+ */
4033
+ metaSiteId?: string;
4034
+ /**
4035
+ * Invalidate by filename (for media files such as PDFs)
4036
+ * @minLength 1
4037
+ * @maxLength 256
4038
+ */
4039
+ fileName?: string;
4040
+ }
4041
+ interface CustomTag {
4042
+ /**
4043
+ * the msid the tag is related to
4044
+ * @format GUID
4045
+ */
4046
+ metaSiteId?: string;
4047
+ /**
4048
+ * Tag to invalidate by
4049
+ * @minLength 1
4050
+ * @maxLength 256
4051
+ */
4052
+ tag?: string;
4053
+ }
4054
+ interface DoNotCallCreateProductRequest {
4055
+ /** Product to be created */
4056
+ product?: V3Product;
4057
+ /**
4058
+ * A list of requested fields to be included in the response.
4059
+ * @maxSize 100
4060
+ */
4061
+ fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
4062
+ }
3492
4063
  declare enum SingleEntityOpsRequestedFields {
3493
4064
  /** Not implemented. */
3494
4065
  UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
@@ -3530,12 +4101,430 @@ declare enum SingleEntityOpsRequestedFields {
3530
4101
  }
3531
4102
  /** @enumType */
3532
4103
  type SingleEntityOpsRequestedFieldsWithLiterals = SingleEntityOpsRequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'URL' | 'CURRENCY' | 'INFO_SECTION' | 'MERCHANT_DATA' | 'PLAIN_DESCRIPTION' | 'INFO_SECTION_PLAIN_DESCRIPTION' | 'SUBSCRIPTION_PRICES_INFO' | 'BREADCRUMBS_INFO' | 'WEIGHT_MEASUREMENT_UNIT_INFO' | 'VARIANT_OPTION_CHOICE_NAMES' | 'MEDIA_ITEMS_INFO' | 'DESCRIPTION' | 'DIRECT_CATEGORIES_INFO' | 'ALL_CATEGORIES_INFO' | 'INFO_SECTION_DESCRIPTION' | 'THUMBNAIL';
3533
- declare enum RequestedFields {
3534
- /** Not implemented. */
3535
- UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
3536
- /** The product's public storefront URL, including both relative path and full URL with base domain. */
3537
- URL = "URL",
3538
- /** Currency information including the currency code and formatted price amounts for storefront display. */
4104
+ interface DoNotCallCreateProductResponse {
4105
+ /** The created Product */
4106
+ product?: V3Product;
4107
+ }
4108
+ interface DuplicateMediaIdAssignedToProduct {
4109
+ /**
4110
+ * List of media IDs passed more than once.
4111
+ * @maxSize 15
4112
+ * @format GUID
4113
+ */
4114
+ mediaIds?: string[];
4115
+ }
4116
+ interface GetProductRequest {
4117
+ /**
4118
+ * Id of the Product to retrieve
4119
+ * @minLength 1
4120
+ * @maxLength 36
4121
+ */
4122
+ productId?: string;
4123
+ /**
4124
+ * A list of requested fields to be included in the response.
4125
+ * @maxSize 100
4126
+ */
4127
+ fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
4128
+ }
4129
+ interface GetProductResponse {
4130
+ /** The retrieved Product */
4131
+ product?: V3Product;
4132
+ }
4133
+ interface GetProductBySlugRequest {
4134
+ /**
4135
+ * Product slug. A permanent, friendly URL name unique per store.
4136
+ * @minLength 1
4137
+ * @maxLength 100
4138
+ */
4139
+ slug?: string;
4140
+ /**
4141
+ * A list of requested fields to be included in the response.
4142
+ * @maxSize 100
4143
+ */
4144
+ fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
4145
+ }
4146
+ interface GetProductBySlugResponse {
4147
+ /** The retrieved Product */
4148
+ product?: V3Product;
4149
+ }
4150
+ interface DoNotCallUpdateProductRequest {
4151
+ /** Product to be updated, may be partial */
4152
+ product?: V3Product;
4153
+ /**
4154
+ * A list of requested fields to be included in the response.
4155
+ * @maxSize 100
4156
+ */
4157
+ fields?: SingleEntityOpsRequestedFieldsWithLiterals[];
4158
+ }
4159
+ interface DoNotCallUpdateProductResponse {
4160
+ /** The updated Product */
4161
+ product?: V3Product;
4162
+ }
4163
+ interface VariantsRemoved {
4164
+ /**
4165
+ * Removed variants ids.
4166
+ * @format GUID
4167
+ * @minSize 1
4168
+ * @maxSize 1000
4169
+ */
4170
+ variantIds?: string[];
4171
+ }
4172
+ interface UnsupportedFieldMasks {
4173
+ /**
4174
+ * Field masks provided in request but not supported
4175
+ * @maxLength 1000
4176
+ * @maxSize 100
4177
+ */
4178
+ fieldMasks?: string[];
4179
+ }
4180
+ interface DeleteProductRequest {
4181
+ /**
4182
+ * Id of the Product to delete
4183
+ * @minLength 1
4184
+ * @maxLength 36
4185
+ */
4186
+ productId?: string;
4187
+ }
4188
+ interface DeleteProductResponse {
4189
+ }
4190
+ interface SearchProductsRequest {
4191
+ /**
4192
+ * WQL expression. Please pay attention that unlike other arrays when you want to filter by `inventory` or `variants` instead of standard array operators you must use `$matchItems` (for usage see examples).
4193
+ * It means that product will be returned only if one or more items satisfy all filters specified in $matchItems.
4194
+ * For example, if you have 2 variants: one visible with price 10 and another one not visible with price 20, when inside $matchItems you specify `visible:true` and `price > 15` nothing will be returned because there are no variants which satisfy both conditions.
4195
+ * You still can use `$isEmpty` and `$exists` operators for fields listed above.
4196
+ * See examples to understand supported capabilities.
4197
+ * This endpoint does not return variants-info, even though it is part of the entity, as including it would result in overly large response objects.
4198
+ * If you need variants-info, you can retrieve it for a specific product using the getProduct endpoint.
4199
+ */
4200
+ search?: CursorSearch;
4201
+ /**
4202
+ * A list of requested fields to be included in the response.
4203
+ * @maxSize 100
4204
+ */
4205
+ fields?: RequestedFieldsWithLiterals[];
4206
+ }
4207
+ interface CursorSearch extends CursorSearchPagingMethodOneOf {
4208
+ /**
4209
+ * Cursor paging options.
4210
+ *
4211
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
4212
+ */
4213
+ cursorPaging?: CursorPaging;
4214
+ /**
4215
+ * Filter object.
4216
+ *
4217
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
4218
+ */
4219
+ filter?: Record<string, any> | null;
4220
+ /**
4221
+ * List of sort objects.
4222
+ *
4223
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
4224
+ * @maxSize 10
4225
+ */
4226
+ sort?: Sorting[];
4227
+ /**
4228
+ * Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition.
4229
+ * @maxSize 10
4230
+ */
4231
+ aggregations?: Aggregation[];
4232
+ /** Free text to match in searchable fields. */
4233
+ search?: SearchDetails;
4234
+ /**
4235
+ * UTC offset or IANA time zone. Valid values are
4236
+ * ISO 8601 UTC offsets, such as +02:00 or -06:00,
4237
+ * and IANA time zone IDs, such as Europe/Rome
4238
+ *
4239
+ * Affects all filters and aggregations returned values.
4240
+ * You may override this behavior in a specific filter by providing
4241
+ * timestamps including time zone. e.g. `"2023-12-20T10:52:34.795Z"`
4242
+ * @maxLength 50
4243
+ */
4244
+ timeZone?: string | null;
4245
+ }
4246
+ /** @oneof */
4247
+ interface CursorSearchPagingMethodOneOf {
4248
+ /**
4249
+ * Cursor paging options.
4250
+ *
4251
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
4252
+ */
4253
+ cursorPaging?: CursorPaging;
4254
+ }
4255
+ interface Sorting {
4256
+ /**
4257
+ * Name of the field to sort by.
4258
+ * @maxLength 512
4259
+ */
4260
+ fieldName?: string;
4261
+ /** Sort order. */
4262
+ order?: SortOrderWithLiterals;
4263
+ }
4264
+ declare enum SortOrder {
4265
+ /** Ascending order. */
4266
+ ASC = "ASC",
4267
+ /** Descending order. */
4268
+ DESC = "DESC"
4269
+ }
4270
+ /** @enumType */
4271
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
4272
+ interface Aggregation extends AggregationKindOneOf {
4273
+ /** Value aggregation */
4274
+ value?: ValueAggregation;
4275
+ /** Range aggregation */
4276
+ range?: RangeAggregation;
4277
+ /** Scalar aggregation */
4278
+ scalar?: ScalarAggregation;
4279
+ /** Date histogram aggregation */
4280
+ dateHistogram?: DateHistogramAggregation;
4281
+ /** Nested aggregation */
4282
+ nested?: NestedAggregation;
4283
+ /**
4284
+ * User-defined name of aggregation, should be unique, will appear in aggregation results
4285
+ * @maxLength 100
4286
+ */
4287
+ name?: string | null;
4288
+ /** Type of aggregation, client must provide matching aggregation field below */
4289
+ type?: AggregationTypeWithLiterals;
4290
+ /**
4291
+ * Field to aggregate by, use dot notation to specify json path
4292
+ * @maxLength 200
4293
+ */
4294
+ fieldPath?: string;
4295
+ }
4296
+ /** @oneof */
4297
+ interface AggregationKindOneOf {
4298
+ /** Value aggregation */
4299
+ value?: ValueAggregation;
4300
+ /** Range aggregation */
4301
+ range?: RangeAggregation;
4302
+ /** Scalar aggregation */
4303
+ scalar?: ScalarAggregation;
4304
+ /** Date histogram aggregation */
4305
+ dateHistogram?: DateHistogramAggregation;
4306
+ /** Nested aggregation */
4307
+ nested?: NestedAggregation;
4308
+ }
4309
+ interface RangeBucket {
4310
+ /** Inclusive lower bound of the range. Required if to is not given */
4311
+ from?: number | null;
4312
+ /** Exclusive upper bound of the range. Required if from is not given */
4313
+ to?: number | null;
4314
+ }
4315
+ declare enum SortType {
4316
+ /** Should sort by number of matches. */
4317
+ COUNT = "COUNT",
4318
+ /** Should sort by value of the field alphabetically. */
4319
+ VALUE = "VALUE"
4320
+ }
4321
+ /** @enumType */
4322
+ type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
4323
+ declare enum SortDirection {
4324
+ /** Should sort by descending order. */
4325
+ DESC = "DESC",
4326
+ /** Should sort by ascending order. */
4327
+ ASC = "ASC"
4328
+ }
4329
+ /** @enumType */
4330
+ type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
4331
+ declare enum MissingValues {
4332
+ /** Exclude missing values from the aggregation results. */
4333
+ EXCLUDE = "EXCLUDE",
4334
+ /** Include missing values from the aggregation results. */
4335
+ INCLUDE = "INCLUDE"
4336
+ }
4337
+ /** @enumType */
4338
+ type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
4339
+ interface IncludeMissingValuesOptions {
4340
+ /**
4341
+ * Can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
4342
+ * @maxLength 20
4343
+ */
4344
+ addToBucket?: string;
4345
+ }
4346
+ declare enum ScalarType {
4347
+ /** Undefined scalar type. */
4348
+ UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
4349
+ /** Count of distinct values. */
4350
+ COUNT_DISTINCT = "COUNT_DISTINCT",
4351
+ /** Minimum value. */
4352
+ MIN = "MIN",
4353
+ /** Maximum value. */
4354
+ MAX = "MAX"
4355
+ }
4356
+ /** @enumType */
4357
+ type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
4358
+ interface ValueAggregation extends ValueAggregationOptionsOneOf {
4359
+ /** Options for including missing values */
4360
+ includeOptions?: IncludeMissingValuesOptions;
4361
+ /** Should sort by number of matches or value of the field */
4362
+ sortType?: SortTypeWithLiterals;
4363
+ /** Should sort in ascending or descending order */
4364
+ sortDirection?: SortDirectionWithLiterals;
4365
+ /** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
4366
+ limit?: number | null;
4367
+ /** Should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
4368
+ missingValues?: MissingValuesWithLiterals;
4369
+ }
4370
+ /** @oneof */
4371
+ interface ValueAggregationOptionsOneOf {
4372
+ /** Options for including missing values */
4373
+ includeOptions?: IncludeMissingValuesOptions;
4374
+ }
4375
+ declare enum NestedAggregationType {
4376
+ /** Undefined nested aggregation type. */
4377
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
4378
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
4379
+ VALUE = "VALUE",
4380
+ /** An aggregation where user can define set of ranges - each representing a bucket. */
4381
+ RANGE = "RANGE",
4382
+ /** A single-value metric aggregation. For example: min, max, sum, avg. */
4383
+ SCALAR = "SCALAR",
4384
+ /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
4385
+ DATE_HISTOGRAM = "DATE_HISTOGRAM"
4386
+ }
4387
+ /** @enumType */
4388
+ type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
4389
+ interface RangeAggregation {
4390
+ /**
4391
+ * List of range buckets, where during aggregation each entity will be placed in the first bucket where its value falls into based on provided range bounds
4392
+ * @maxSize 50
4393
+ */
4394
+ buckets?: RangeBucket[];
4395
+ }
4396
+ interface ScalarAggregation {
4397
+ /** Define the operator for the scalar aggregation */
4398
+ type?: ScalarTypeWithLiterals;
4399
+ }
4400
+ interface DateHistogramAggregation {
4401
+ /** Interval for date histogram aggregation */
4402
+ interval?: IntervalWithLiterals;
4403
+ }
4404
+ declare enum Interval {
4405
+ /** Undefined interval type. */
4406
+ UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
4407
+ /** Yearly interval. */
4408
+ YEAR = "YEAR",
4409
+ /** Monthly interval. */
4410
+ MONTH = "MONTH",
4411
+ /** Weekly interval. */
4412
+ WEEK = "WEEK",
4413
+ /** Daily interval. */
4414
+ DAY = "DAY",
4415
+ /** Hourly interval. */
4416
+ HOUR = "HOUR",
4417
+ /** Minute interval. */
4418
+ MINUTE = "MINUTE",
4419
+ /** Second interval. */
4420
+ SECOND = "SECOND"
4421
+ }
4422
+ /** @enumType */
4423
+ type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
4424
+ interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
4425
+ /** Value aggregation */
4426
+ value?: ValueAggregation;
4427
+ /** Range aggregation */
4428
+ range?: RangeAggregation;
4429
+ /** Scalar aggregation */
4430
+ scalar?: ScalarAggregation;
4431
+ /** Date histogram aggregation */
4432
+ dateHistogram?: DateHistogramAggregation;
4433
+ /**
4434
+ * User-defined name of aggregation, should be unique, will appear in aggregation results
4435
+ * @maxLength 100
4436
+ */
4437
+ name?: string | null;
4438
+ /** Type of aggregation, client must provide matching aggregation field below */
4439
+ type?: NestedAggregationTypeWithLiterals;
4440
+ /**
4441
+ * Field to aggregate by, use dont notation to specify json path
4442
+ * @maxLength 200
4443
+ */
4444
+ fieldPath?: string;
4445
+ }
4446
+ /** @oneof */
4447
+ interface NestedAggregationItemKindOneOf {
4448
+ /** Value aggregation */
4449
+ value?: ValueAggregation;
4450
+ /** Range aggregation */
4451
+ range?: RangeAggregation;
4452
+ /** Scalar aggregation */
4453
+ scalar?: ScalarAggregation;
4454
+ /** Date histogram aggregation */
4455
+ dateHistogram?: DateHistogramAggregation;
4456
+ }
4457
+ declare enum AggregationType {
4458
+ /** Undefined aggregation type. */
4459
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
4460
+ /** An aggregation where result buckets are dynamically built - one per unique value. */
4461
+ VALUE = "VALUE",
4462
+ /** An aggregation where a user can define set of ranges - each representing a bucket. */
4463
+ RANGE = "RANGE",
4464
+ /** A single-value metric aggregation. For example: min, max, sum, avg. */
4465
+ SCALAR = "SCALAR",
4466
+ /** An aggregation where result buckets are dynamically built - one per time interval (hour, day, week, etc.) */
4467
+ DATE_HISTOGRAM = "DATE_HISTOGRAM",
4468
+ /** A Multi-level aggregation where each next aggregation is nested within previous one. */
4469
+ NESTED = "NESTED"
4470
+ }
4471
+ /** @enumType */
4472
+ type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
4473
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
4474
+ interface NestedAggregation {
4475
+ /**
4476
+ * Flattened list of aggregations, where each next aggregation is nested within previous one
4477
+ * @minSize 2
4478
+ * @maxSize 3
4479
+ */
4480
+ nestedAggregations?: NestedAggregationItem[];
4481
+ }
4482
+ interface SearchDetails {
4483
+ /** Defines how separate search terms in `expression` are combined. */
4484
+ mode?: ModeWithLiterals;
4485
+ /**
4486
+ * Search term or expression
4487
+ * @maxLength 100
4488
+ */
4489
+ expression?: string | null;
4490
+ /**
4491
+ * Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path
4492
+ * @maxLength 200
4493
+ * @maxSize 20
4494
+ */
4495
+ fields?: string[];
4496
+ /** Flag if should use auto fuzzy search (allowing typos by a managed proximity algorithm) */
4497
+ fuzzy?: boolean;
4498
+ }
4499
+ declare enum Mode {
4500
+ /** Any of the search terms must be present. */
4501
+ OR = "OR",
4502
+ /** All search terms must be present. */
4503
+ AND = "AND"
4504
+ }
4505
+ /** @enumType */
4506
+ type ModeWithLiterals = Mode | 'OR' | 'AND';
4507
+ interface CursorPaging {
4508
+ /**
4509
+ * Maximum number of items to return in the results.
4510
+ * @max 100
4511
+ */
4512
+ limit?: number | null;
4513
+ /**
4514
+ * Pointer to the next or previous page in the list of results.
4515
+ *
4516
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
4517
+ * Not relevant for the first request.
4518
+ * @maxLength 16000
4519
+ */
4520
+ cursor?: string | null;
4521
+ }
4522
+ declare enum RequestedFields {
4523
+ /** Not implemented. */
4524
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
4525
+ /** The product's public storefront URL, including both relative path and full URL with base domain. */
4526
+ URL = "URL",
4527
+ /** Currency information including the currency code and formatted price amounts for storefront display. */
3539
4528
  CURRENCY = "CURRENCY",
3540
4529
  /** Returns basic info section metadata including IDs, unique names, and titles. Use with `INFO_SECTION_DESCRIPTION` or `INFO_SECTION_PLAIN_DESCRIPTION` to include content. */
3541
4530
  INFO_SECTION = "INFO_SECTION",
@@ -3569,8 +4558,1191 @@ declare enum RequestedFields {
3569
4558
  /** Returns an optimized thumbnail image with standard dimensions, suitable for listings or previews. */
3570
4559
  THUMBNAIL = "THUMBNAIL"
3571
4560
  }
3572
- /** @enumType */
3573
- type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'URL' | 'CURRENCY' | 'INFO_SECTION' | 'MERCHANT_DATA' | 'PLAIN_DESCRIPTION' | 'INFO_SECTION_PLAIN_DESCRIPTION' | 'SUBSCRIPTION_PRICES_INFO' | 'BREADCRUMBS_INFO' | 'WEIGHT_MEASUREMENT_UNIT_INFO' | 'VARIANT_OPTION_CHOICE_NAMES' | 'MEDIA_ITEMS_INFO' | 'DESCRIPTION' | 'DIRECT_CATEGORIES_INFO' | 'ALL_CATEGORIES_INFO' | 'INFO_SECTION_DESCRIPTION' | 'THUMBNAIL';
4561
+ /** @enumType */
4562
+ type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'URL' | 'CURRENCY' | 'INFO_SECTION' | 'MERCHANT_DATA' | 'PLAIN_DESCRIPTION' | 'INFO_SECTION_PLAIN_DESCRIPTION' | 'SUBSCRIPTION_PRICES_INFO' | 'BREADCRUMBS_INFO' | 'WEIGHT_MEASUREMENT_UNIT_INFO' | 'VARIANT_OPTION_CHOICE_NAMES' | 'MEDIA_ITEMS_INFO' | 'DESCRIPTION' | 'DIRECT_CATEGORIES_INFO' | 'ALL_CATEGORIES_INFO' | 'INFO_SECTION_DESCRIPTION' | 'THUMBNAIL';
4563
+ interface SearchProductsResponse {
4564
+ /** Products which satisfy the provided query. */
4565
+ products?: V3Product[];
4566
+ /** Paging metadata. Contains cursor which can be used in next query. */
4567
+ pagingMetadata?: CursorPagingMetadata;
4568
+ /** Aggregation data. */
4569
+ aggregationData?: AggregationData;
4570
+ }
4571
+ interface CursorPagingMetadata {
4572
+ /** Number of items returned in the response. */
4573
+ count?: number | null;
4574
+ /** Cursor strings that point to the next page, previous page, or both. */
4575
+ cursors?: Cursors;
4576
+ /**
4577
+ * Whether there are more pages to retrieve following the current page.
4578
+ *
4579
+ * + `true`: Another page of results can be retrieved.
4580
+ * + `false`: This is the last page.
4581
+ */
4582
+ hasNext?: boolean | null;
4583
+ }
4584
+ interface Cursors {
4585
+ /**
4586
+ * Cursor string pointing to the next page in the list of results.
4587
+ * @maxLength 16000
4588
+ */
4589
+ next?: string | null;
4590
+ /**
4591
+ * Cursor pointing to the previous page in the list of results.
4592
+ * @maxLength 16000
4593
+ */
4594
+ prev?: string | null;
4595
+ }
4596
+ interface AggregationData {
4597
+ /**
4598
+ * key = aggregation name (as derived from search request)
4599
+ * @maxSize 10000
4600
+ */
4601
+ results?: AggregationResults[];
4602
+ }
4603
+ interface ValueAggregationResult {
4604
+ /**
4605
+ * Value of the field
4606
+ * @maxLength 100
4607
+ */
4608
+ value?: string;
4609
+ /** Count of entities with this value */
4610
+ count?: number;
4611
+ }
4612
+ interface RangeAggregationResult {
4613
+ /** Inclusive lower bound of the range */
4614
+ from?: number | null;
4615
+ /** Exclusive upper bound of the range */
4616
+ to?: number | null;
4617
+ /** Count of entities in this range */
4618
+ count?: number;
4619
+ }
4620
+ interface NestedAggregationResults extends NestedAggregationResultsResultOneOf {
4621
+ /** Value aggregation results */
4622
+ values?: ValueResults;
4623
+ /** Range aggregation results */
4624
+ ranges?: RangeResults;
4625
+ /** Scalar aggregation results */
4626
+ scalar?: AggregationResultsScalarResult;
4627
+ /**
4628
+ * User-defined name of aggregation, matches the one provided in request
4629
+ * @maxLength 100
4630
+ */
4631
+ name?: string;
4632
+ /** Type of aggregation that matches result */
4633
+ type?: AggregationTypeWithLiterals;
4634
+ /**
4635
+ * Field to aggregate by, matches the one provided in request
4636
+ * @maxLength 200
4637
+ */
4638
+ fieldPath?: string;
4639
+ }
4640
+ /** @oneof */
4641
+ interface NestedAggregationResultsResultOneOf {
4642
+ /** Value aggregation results */
4643
+ values?: ValueResults;
4644
+ /** Range aggregation results */
4645
+ ranges?: RangeResults;
4646
+ /** Scalar aggregation results */
4647
+ scalar?: AggregationResultsScalarResult;
4648
+ }
4649
+ interface ValueResults {
4650
+ /**
4651
+ * List of value aggregations
4652
+ * @maxSize 250
4653
+ */
4654
+ results?: ValueAggregationResult[];
4655
+ }
4656
+ interface RangeResults {
4657
+ /**
4658
+ * List of ranges returned in same order as requested
4659
+ * @maxSize 50
4660
+ */
4661
+ results?: RangeAggregationResult[];
4662
+ }
4663
+ interface AggregationResultsScalarResult {
4664
+ /** Type of scalar aggregation */
4665
+ type?: ScalarTypeWithLiterals;
4666
+ /** Value of the scalar aggregation */
4667
+ value?: number;
4668
+ }
4669
+ interface NestedValueAggregationResult {
4670
+ /**
4671
+ * Value of the field
4672
+ * @maxLength 1000
4673
+ */
4674
+ value?: string;
4675
+ /** Nested aggregations */
4676
+ nestedResults?: NestedAggregationResults;
4677
+ }
4678
+ interface ValueResult {
4679
+ /**
4680
+ * Value of the field
4681
+ * @maxLength 1000
4682
+ */
4683
+ value?: string;
4684
+ /** Count of entities with this value */
4685
+ count?: number | null;
4686
+ }
4687
+ interface RangeResult {
4688
+ /** Inclusive lower bound of the range */
4689
+ from?: number | null;
4690
+ /** Exclusive upper bound of the range */
4691
+ to?: number | null;
4692
+ /** Count of entities in this range */
4693
+ count?: number | null;
4694
+ }
4695
+ interface ScalarResult {
4696
+ /** Value of the scalar aggregation */
4697
+ value?: number;
4698
+ }
4699
+ interface NestedResultValue extends NestedResultValueResultOneOf {
4700
+ /** Value aggregation result */
4701
+ value?: ValueResult;
4702
+ /** Range aggregation result */
4703
+ range?: RangeResult;
4704
+ /** Scalar aggregation result */
4705
+ scalar?: ScalarResult;
4706
+ /** Date histogram aggregation result */
4707
+ dateHistogram?: ValueResult;
4708
+ }
4709
+ /** @oneof */
4710
+ interface NestedResultValueResultOneOf {
4711
+ /** Value aggregation result */
4712
+ value?: ValueResult;
4713
+ /** Range aggregation result */
4714
+ range?: RangeResult;
4715
+ /** Scalar aggregation result */
4716
+ scalar?: ScalarResult;
4717
+ /** Date histogram aggregation result */
4718
+ dateHistogram?: ValueResult;
4719
+ }
4720
+ interface Results {
4721
+ /** List of nested aggregations */
4722
+ results?: Record<string, NestedResultValue>;
4723
+ }
4724
+ interface DateHistogramResult {
4725
+ /**
4726
+ * Date in ISO 8601 format
4727
+ * @maxLength 100
4728
+ */
4729
+ value?: string;
4730
+ /** Count of documents in the bucket */
4731
+ count?: number;
4732
+ }
4733
+ interface GroupByValueResults {
4734
+ /**
4735
+ * List of value aggregations
4736
+ * @maxSize 1000
4737
+ */
4738
+ results?: NestedValueAggregationResult[];
4739
+ }
4740
+ interface DateHistogramResults {
4741
+ /**
4742
+ * List of date histogram aggregations
4743
+ * @maxSize 200
4744
+ */
4745
+ results?: DateHistogramResult[];
4746
+ }
4747
+ /**
4748
+ * Results of `NESTED` aggregation type in a flattened form
4749
+ * aggregations in resulting array are keyed by requested aggregation `name`.
4750
+ */
4751
+ interface NestedResults {
4752
+ /**
4753
+ * List of nested aggregations
4754
+ * @maxSize 1000
4755
+ */
4756
+ results?: Results[];
4757
+ }
4758
+ interface AggregationResults extends AggregationResultsResultOneOf {
4759
+ /** Value aggregation results */
4760
+ values?: ValueResults;
4761
+ /** Range aggregation results */
4762
+ ranges?: RangeResults;
4763
+ /** Scalar aggregation results */
4764
+ scalar?: AggregationResultsScalarResult;
4765
+ /** Group by value aggregation results */
4766
+ groupedByValue?: GroupByValueResults;
4767
+ /** Date histogram aggregation results */
4768
+ dateHistogram?: DateHistogramResults;
4769
+ /** Nested aggregation results */
4770
+ nested?: NestedResults;
4771
+ /**
4772
+ * User-defined name of aggregation as derived from search request
4773
+ * @maxLength 100
4774
+ */
4775
+ name?: string;
4776
+ /** Type of aggregation that must match provided kind as derived from search request */
4777
+ type?: AggregationTypeWithLiterals;
4778
+ /**
4779
+ * Field to aggregate by as derived from search request
4780
+ * @maxLength 200
4781
+ */
4782
+ fieldPath?: string;
4783
+ }
4784
+ /** @oneof */
4785
+ interface AggregationResultsResultOneOf {
4786
+ /** Value aggregation results */
4787
+ values?: ValueResults;
4788
+ /** Range aggregation results */
4789
+ ranges?: RangeResults;
4790
+ /** Scalar aggregation results */
4791
+ scalar?: AggregationResultsScalarResult;
4792
+ /** Group by value aggregation results */
4793
+ groupedByValue?: GroupByValueResults;
4794
+ /** Date histogram aggregation results */
4795
+ dateHistogram?: DateHistogramResults;
4796
+ /** Nested aggregation results */
4797
+ nested?: NestedResults;
4798
+ }
4799
+ interface SearchRelatedProductsRequest {
4800
+ /** Search parameters. */
4801
+ searchRelated?: SearchRelated;
4802
+ }
4803
+ interface SearchRelated {
4804
+ /**
4805
+ * A list of entity IDs to search related entities for
4806
+ * @minSize 1
4807
+ * @maxSize 10
4808
+ * @maxLength 50
4809
+ */
4810
+ relatedToIds?: string[];
4811
+ /** Search details */
4812
+ search?: SearchRelatedDetails;
4813
+ /** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
4814
+ filter?: Record<string, any> | null;
4815
+ /**
4816
+ * Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]
4817
+ * @maxSize 10
4818
+ */
4819
+ sort?: Sorting[];
4820
+ /**
4821
+ * Number of related documents to return
4822
+ * @max 100
4823
+ */
4824
+ limit?: number | null;
4825
+ }
4826
+ interface SearchRelatedDetails {
4827
+ /**
4828
+ * Search term or expression
4829
+ * @maxLength 100
4830
+ */
4831
+ expression?: string | null;
4832
+ /**
4833
+ * Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path
4834
+ * @maxLength 200
4835
+ * @maxSize 20
4836
+ */
4837
+ fields?: string[];
4838
+ }
4839
+ interface SearchRelatedProductsResponse {
4840
+ /**
4841
+ * The IDs of related Products that satisfy the request.
4842
+ * @format GUID
4843
+ * @maxLength 100
4844
+ */
4845
+ productIds?: string[];
4846
+ }
4847
+ interface EventuallyConsistentQueryProductsRequest {
4848
+ /**
4849
+ * WQL expression. Please pay attention that unlike other arrays when you want to filter by `inventory`, `options` or `variants` instead of standard array operators you must use `$matchItems` (for usage see examples).
4850
+ * It means that product will be returned only if one or more items satisfy all filters specified in $matchItems.
4851
+ * For example, if you have 2 variants: one visible with price 10 and another one not visible with price 20, when inside $matchItems you specify `visible:true` and `price > 15` nothing will be returned because there are no variants which satisfy both conditions.
4852
+ * You still can use `$isEmpty` and `$exists` operators for fields listed above.
4853
+ * See examples to understand supported capabilities.
4854
+ */
4855
+ query?: CursorQuery;
4856
+ /**
4857
+ * A list of requested fields to be included in the response.
4858
+ * @maxSize 100
4859
+ */
4860
+ fields?: RequestedFieldsWithLiterals[];
4861
+ }
4862
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
4863
+ /**
4864
+ * Cursor paging options.
4865
+ *
4866
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
4867
+ */
4868
+ cursorPaging?: CursorPaging;
4869
+ /**
4870
+ * Filter object.
4871
+ *
4872
+ * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
4873
+ */
4874
+ filter?: Record<string, any> | null;
4875
+ /**
4876
+ * Sort object.
4877
+ *
4878
+ * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
4879
+ * @maxSize 5
4880
+ */
4881
+ sort?: Sorting[];
4882
+ }
4883
+ /** @oneof */
4884
+ interface CursorQueryPagingMethodOneOf {
4885
+ /**
4886
+ * Cursor paging options.
4887
+ *
4888
+ * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
4889
+ */
4890
+ cursorPaging?: CursorPaging;
4891
+ }
4892
+ interface EventuallyConsistentQueryProductsResponse {
4893
+ /** Products which satisfy the provided query. */
4894
+ products?: V3Product[];
4895
+ /** Paging metadata. Contains cursor which can be used in next query. */
4896
+ pagingMetadata?: CursorPagingMetadata;
4897
+ }
4898
+ interface QueryProductsRequest {
4899
+ /** WQL expression */
4900
+ query?: CursorQuery;
4901
+ /**
4902
+ * A list of requested fields to be included in the response.
4903
+ * @maxSize 100
4904
+ */
4905
+ fields?: RequestedFieldsWithLiterals[];
4906
+ }
4907
+ interface QueryProductsResponse {
4908
+ /** The retrieved Products */
4909
+ products?: V3Product[];
4910
+ /** Paging metadata. */
4911
+ pagingMetadata?: CursorPagingMetadata;
4912
+ }
4913
+ interface DeprecatedSearchProductsWithOffsetRequest {
4914
+ /** Filter and sort with limit/offset based paging */
4915
+ search?: PlatformOffsetSearch;
4916
+ /**
4917
+ * A list of requested fields to be included in the response.
4918
+ * @maxSize 100
4919
+ */
4920
+ fields?: RequestedFieldsWithLiterals[];
4921
+ }
4922
+ interface PlatformOffsetSearch extends PlatformOffsetSearchPagingMethodOneOf {
4923
+ /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
4924
+ paging?: PlatformPaging;
4925
+ /** A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language). */
4926
+ filter?: Record<string, any> | null;
4927
+ /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
4928
+ sort?: CommonSorting[];
4929
+ /** Aggregations | Faceted search: refers to a way to explore large amounts of data by displaying summaries about various partitions of the data and later allowing to narrow the navigation to a specific partition. */
4930
+ aggregations?: CommonAggregation[];
4931
+ /** free text to match in searchable fields */
4932
+ search?: CommonSearchDetails;
4933
+ }
4934
+ /** @oneof */
4935
+ interface PlatformOffsetSearchPagingMethodOneOf {
4936
+ /** Pointer to page of results using offset. Can not be used together with 'cursor_paging' */
4937
+ paging?: PlatformPaging;
4938
+ }
4939
+ interface CommonSorting {
4940
+ /**
4941
+ * Name of the field to sort by.
4942
+ * @maxLength 512
4943
+ */
4944
+ fieldName?: string;
4945
+ /** Sort order. */
4946
+ order?: CommonSortOrderWithLiterals;
4947
+ }
4948
+ declare enum CommonSortOrder {
4949
+ ASC = "ASC",
4950
+ DESC = "DESC"
4951
+ }
4952
+ /** @enumType */
4953
+ type CommonSortOrderWithLiterals = CommonSortOrder | 'ASC' | 'DESC';
4954
+ interface CommonAggregation extends CommonAggregationKindOneOf {
4955
+ /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
4956
+ value?: AggregationValueAggregation;
4957
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
4958
+ range?: AggregationRangeAggregation;
4959
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
4960
+ scalar?: AggregationScalarAggregation;
4961
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
4962
+ dateHistogram?: AggregationDateHistogramAggregation;
4963
+ /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
4964
+ nested?: AggregationNestedAggregation;
4965
+ /**
4966
+ * Aggregation name, returned in `aggregations.results.name`.
4967
+ * @maxLength 100
4968
+ */
4969
+ name?: string | null;
4970
+ /** Type of aggregation to perform. Must align with the corresponding aggregation field. */
4971
+ type?: CommonAggregationTypeWithLiterals;
4972
+ /**
4973
+ * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
4974
+ * @maxLength 200
4975
+ */
4976
+ fieldPath?: string;
4977
+ /**
4978
+ * Deprecated. Use `nested` instead.
4979
+ * @deprecated Deprecated. Use `nested` instead.
4980
+ * @replacedBy kind.nested
4981
+ * @targetRemovalDate 2024-03-30
4982
+ */
4983
+ groupBy?: GroupByAggregation;
4984
+ }
4985
+ /** @oneof */
4986
+ interface CommonAggregationKindOneOf {
4987
+ /** A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store. */
4988
+ value?: AggregationValueAggregation;
4989
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. */
4990
+ range?: AggregationRangeAggregation;
4991
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
4992
+ scalar?: AggregationScalarAggregation;
4993
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week. */
4994
+ dateHistogram?: AggregationDateHistogramAggregation;
4995
+ /** A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`. */
4996
+ nested?: AggregationNestedAggregation;
4997
+ }
4998
+ interface RangeAggregationRangeBucket {
4999
+ /** Inclusive lower bound of the range. Required if `to` is not provided. */
5000
+ from?: number | null;
5001
+ /** Exclusive upper bound of the range. Required if `from` is not provided. */
5002
+ to?: number | null;
5003
+ }
5004
+ declare enum ValueAggregationSortType {
5005
+ /** Number of matches in the results. */
5006
+ COUNT = "COUNT",
5007
+ /** Alphabetically by the field value. */
5008
+ VALUE = "VALUE"
5009
+ }
5010
+ /** @enumType */
5011
+ type ValueAggregationSortTypeWithLiterals = ValueAggregationSortType | 'COUNT' | 'VALUE';
5012
+ declare enum ValueAggregationSortDirection {
5013
+ /** Descending order. */
5014
+ DESC = "DESC",
5015
+ /** Ascending order. */
5016
+ ASC = "ASC"
5017
+ }
5018
+ /** @enumType */
5019
+ type ValueAggregationSortDirectionWithLiterals = ValueAggregationSortDirection | 'DESC' | 'ASC';
5020
+ declare enum ValueAggregationMissingValues {
5021
+ /** Exclude missing values from the aggregation results. */
5022
+ EXCLUDE = "EXCLUDE",
5023
+ /** Include missing values in the aggregation results. */
5024
+ INCLUDE = "INCLUDE"
5025
+ }
5026
+ /** @enumType */
5027
+ type ValueAggregationMissingValuesWithLiterals = ValueAggregationMissingValues | 'EXCLUDE' | 'INCLUDE';
5028
+ interface ValueAggregationIncludeMissingValuesOptions {
5029
+ /**
5030
+ * Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans.
5031
+ * @maxLength 20
5032
+ */
5033
+ addToBucket?: string;
5034
+ }
5035
+ declare enum CommonScalarType {
5036
+ UNKNOWN_SCALAR_TYPE = "UNKNOWN_SCALAR_TYPE",
5037
+ /** Total number of distinct values. */
5038
+ COUNT_DISTINCT = "COUNT_DISTINCT",
5039
+ /** Minimum value. */
5040
+ MIN = "MIN",
5041
+ /** Maximum value. */
5042
+ MAX = "MAX"
5043
+ }
5044
+ /** @enumType */
5045
+ type CommonScalarTypeWithLiterals = CommonScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
5046
+ interface AggregationValueAggregation extends AggregationValueAggregationOptionsOneOf {
5047
+ /** Options for including missing values in results. */
5048
+ includeOptions?: ValueAggregationIncludeMissingValuesOptions;
5049
+ /** Sort type. */
5050
+ sortType?: ValueAggregationSortTypeWithLiterals;
5051
+ /** Sort direction. */
5052
+ sortDirection?: ValueAggregationSortDirectionWithLiterals;
5053
+ /**
5054
+ * Number of aggregation results to return.
5055
+ * Min: `1`
5056
+ * Max: `250`
5057
+ * Default: `10`
5058
+ */
5059
+ limit?: number | null;
5060
+ /**
5061
+ * Whether to include or exclude missing values in the aggregation results.
5062
+ * Default: `EXCLUDE`.
5063
+ */
5064
+ missingValues?: ValueAggregationMissingValuesWithLiterals;
5065
+ }
5066
+ /** @oneof */
5067
+ interface AggregationValueAggregationOptionsOneOf {
5068
+ /** Options for including missing values in results. */
5069
+ includeOptions?: ValueAggregationIncludeMissingValuesOptions;
5070
+ }
5071
+ declare enum NestedAggregationNestedAggregationType {
5072
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
5073
+ /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
5074
+ VALUE = "VALUE",
5075
+ /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
5076
+ RANGE = "RANGE",
5077
+ /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
5078
+ SCALAR = "SCALAR",
5079
+ /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
5080
+ DATE_HISTOGRAM = "DATE_HISTOGRAM"
5081
+ }
5082
+ /** @enumType */
5083
+ type NestedAggregationNestedAggregationTypeWithLiterals = NestedAggregationNestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
5084
+ interface AggregationRangeAggregation {
5085
+ /**
5086
+ * List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds.
5087
+ * @maxSize 50
5088
+ */
5089
+ buckets?: RangeAggregationRangeBucket[];
5090
+ }
5091
+ interface AggregationScalarAggregation {
5092
+ /** Operator type for the scalar aggregation. */
5093
+ type?: CommonScalarTypeWithLiterals;
5094
+ }
5095
+ interface AggregationDateHistogramAggregation {
5096
+ /** Interval for date histogram aggregation. */
5097
+ interval?: DateHistogramAggregationIntervalWithLiterals;
5098
+ }
5099
+ declare enum DateHistogramAggregationInterval {
5100
+ UNKNOWN_INTERVAL = "UNKNOWN_INTERVAL",
5101
+ YEAR = "YEAR",
5102
+ MONTH = "MONTH",
5103
+ WEEK = "WEEK",
5104
+ DAY = "DAY",
5105
+ HOUR = "HOUR",
5106
+ MINUTE = "MINUTE",
5107
+ SECOND = "SECOND"
5108
+ }
5109
+ /** @enumType */
5110
+ type DateHistogramAggregationIntervalWithLiterals = DateHistogramAggregationInterval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
5111
+ interface NestedAggregationNestedAggregationItem extends NestedAggregationNestedAggregationItemKindOneOf {
5112
+ /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
5113
+ value?: AggregationValueAggregation;
5114
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
5115
+ range?: AggregationRangeAggregation;
5116
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
5117
+ scalar?: AggregationScalarAggregation;
5118
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
5119
+ dateHistogram?: AggregationDateHistogramAggregation;
5120
+ /**
5121
+ * Unique, caller-defined aggregation name, returned in `aggregations.results`.
5122
+ * @maxLength 100
5123
+ */
5124
+ name?: string | null;
5125
+ /** Type of aggregation to perform. The matching aggregation field must be passed. */
5126
+ type?: NestedAggregationNestedAggregationTypeWithLiterals;
5127
+ /**
5128
+ * Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
5129
+ * @maxLength 200
5130
+ */
5131
+ fieldPath?: string;
5132
+ }
5133
+ /** @oneof */
5134
+ interface NestedAggregationNestedAggregationItemKindOneOf {
5135
+ /** A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status. */
5136
+ value?: AggregationValueAggregation;
5137
+ /** A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
5138
+ range?: AggregationRangeAggregation;
5139
+ /** A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
5140
+ scalar?: AggregationScalarAggregation;
5141
+ /** A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria. */
5142
+ dateHistogram?: AggregationDateHistogramAggregation;
5143
+ }
5144
+ declare enum CommonAggregationType {
5145
+ UNKNOWN_AGGREGATION_TYPE = "UNKNOWN_AGGREGATION_TYPE",
5146
+ /** Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. */
5147
+ VALUE = "VALUE",
5148
+ /** Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. */
5149
+ RANGE = "RANGE",
5150
+ /** Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`. */
5151
+ SCALAR = "SCALAR",
5152
+ /** Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). */
5153
+ DATE_HISTOGRAM = "DATE_HISTOGRAM",
5154
+ /** Flattened list of aggregations, where each aggregation is nested within previous one. */
5155
+ NESTED = "NESTED"
5156
+ }
5157
+ /** @enumType */
5158
+ type CommonAggregationTypeWithLiterals = CommonAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
5159
+ /** Nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one. */
5160
+ interface AggregationNestedAggregation {
5161
+ /**
5162
+ * Flattened list of aggregations, where each aggregation is nested within previous one.
5163
+ * @minSize 2
5164
+ * @maxSize 3
5165
+ */
5166
+ nestedAggregations?: NestedAggregationNestedAggregationItem[];
5167
+ }
5168
+ interface GroupByAggregation extends GroupByAggregationKindOneOf {
5169
+ /** Value aggregation configuration. */
5170
+ value?: AggregationValueAggregation;
5171
+ /**
5172
+ * Unique, caller-defined aggregation name, returned in `aggregations.results`.
5173
+ * @maxLength 100
5174
+ */
5175
+ name?: string | null;
5176
+ /**
5177
+ * Field to aggregate by.
5178
+ * @maxLength 200
5179
+ */
5180
+ fieldPath?: string;
5181
+ }
5182
+ /** @oneof */
5183
+ interface GroupByAggregationKindOneOf {
5184
+ /** Value aggregation configuration. */
5185
+ value?: AggregationValueAggregation;
5186
+ }
5187
+ interface CommonSearchDetails {
5188
+ /** Search mode. Defines the search logic for combining multiple terms in the `expression`. */
5189
+ mode?: SearchDetailsModeWithLiterals;
5190
+ /**
5191
+ * Search term or expression.
5192
+ * @maxLength 100
5193
+ */
5194
+ expression?: string | null;
5195
+ /**
5196
+ * Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
5197
+ * @maxLength 200
5198
+ * @maxSize 20
5199
+ */
5200
+ fields?: string[];
5201
+ /** Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions. */
5202
+ fuzzy?: boolean;
5203
+ }
5204
+ declare enum SearchDetailsMode {
5205
+ /** At least one of the search terms must be present. */
5206
+ OR = "OR",
5207
+ /** All search terms must be present. */
5208
+ AND = "AND"
5209
+ }
5210
+ /** @enumType */
5211
+ type SearchDetailsModeWithLiterals = SearchDetailsMode | 'OR' | 'AND';
5212
+ interface PlatformPaging {
5213
+ /**
5214
+ * Number of items to load.
5215
+ * @max 100
5216
+ */
5217
+ limit?: number | null;
5218
+ /** Number of items to skip in the current sort order. */
5219
+ offset?: number | null;
5220
+ }
5221
+ interface DeprecatedSearchProductsWithOffsetResponse {
5222
+ /** Products which satisfy the provided query. */
5223
+ products?: V3Product[];
5224
+ /** Paging metadata. */
5225
+ pagingMetadata?: PagingMetadata;
5226
+ /** Aggregation data. */
5227
+ aggregationData?: AggregationData;
5228
+ }
5229
+ interface PagingMetadata {
5230
+ /** Number of items returned in the response. */
5231
+ count?: number | null;
5232
+ /** Offset that was requested. */
5233
+ offset?: number | null;
5234
+ /** Total number of items that match the query. */
5235
+ total?: number | null;
5236
+ /** Flag that indicates the server failed to calculate the `total` field. */
5237
+ tooManyToCount?: boolean | null;
5238
+ }
5239
+ interface RetrieveVariantsRequest {
5240
+ /**
5241
+ * Ids of the product and variants to retrieve
5242
+ * @maxSize 100
5243
+ */
5244
+ productVariantIds?: ProductVariantIds[];
5245
+ /**
5246
+ * Pointer to the next page in the list of results.
5247
+ * Pass the relevant cursor token from the `pagingMetadata` in the previous call's response.
5248
+ * Not relevant for the first request.
5249
+ */
5250
+ cursorPaging?: VariantsCursorPaging;
5251
+ /**
5252
+ * Fields to include in the response.
5253
+ * @maxSize 100
5254
+ */
5255
+ fields?: VariantsOpsRequestedFieldsWithLiterals[];
5256
+ }
5257
+ interface ProductVariantIds {
5258
+ /**
5259
+ * Product id of the requested variants.
5260
+ * @minLength 1
5261
+ * @maxLength 36
5262
+ */
5263
+ productId?: string;
5264
+ /**
5265
+ * A list of variant ids.
5266
+ * @maxSize 1000
5267
+ * @minLength 1
5268
+ * @maxLength 36
5269
+ */
5270
+ variantIds?: string[];
5271
+ }
5272
+ interface VariantsCursorPaging {
5273
+ /**
5274
+ * Maximum number of items to return in the results.
5275
+ * @max 1000
5276
+ */
5277
+ limit?: number | null;
5278
+ /**
5279
+ * Pointer to the next or previous page in the list of results.
5280
+ *
5281
+ * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
5282
+ * Not relevant for the first request.
5283
+ * @maxLength 64
5284
+ */
5285
+ cursor?: string | null;
5286
+ }
5287
+ declare enum VariantsOpsRequestedFields {
5288
+ /** Not implemented. */
5289
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
5290
+ CURRENCY = "CURRENCY",
5291
+ /** You can request merchant data only if you have the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. */
5292
+ MERCHANT_DATA = "MERCHANT_DATA",
5293
+ SUBSCRIPTION_PRICES_INFO = "SUBSCRIPTION_PRICES_INFO",
5294
+ VARIANT_OPTION_CHOICE_NAMES = "VARIANT_OPTION_CHOICE_NAMES",
5295
+ THUMBNAIL = "THUMBNAIL"
5296
+ }
5297
+ /** @enumType */
5298
+ type VariantsOpsRequestedFieldsWithLiterals = VariantsOpsRequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'CURRENCY' | 'MERCHANT_DATA' | 'SUBSCRIPTION_PRICES_INFO' | 'VARIANT_OPTION_CHOICE_NAMES' | 'THUMBNAIL';
5299
+ interface RetrieveVariantsResponse {
5300
+ /** The retrieved Products and Variants */
5301
+ productVariants?: ProductVariants[];
5302
+ /** Paging metadata. Contains cursor which can be used in next query. */
5303
+ pagingMetadata?: CursorPagingMetadata;
5304
+ }
5305
+ interface ProductVariants {
5306
+ /**
5307
+ * Product id of the requested variants.
5308
+ * @minLength 1
5309
+ * @maxLength 36
5310
+ */
5311
+ productId?: string;
5312
+ /**
5313
+ * A list of variants.
5314
+ * @maxSize 1000
5315
+ */
5316
+ variants?: Variant[];
5317
+ }
5318
+ interface CountProductsRequest {
5319
+ /**
5320
+ * A filter object. Learn more about [API query language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
5321
+ * To understand supported filters and limitations see `SearchProducts` method.
5322
+ */
5323
+ filter?: Record<string, any> | null;
5324
+ /** free text to match in searchable fields */
5325
+ search?: SearchDetails;
5326
+ }
5327
+ interface CountProductsResponse {
5328
+ /** The amount of products which apply to the request */
5329
+ count?: number;
5330
+ }
5331
+ interface DoNotCallBulkCreateProductsRequest {
5332
+ /**
5333
+ * List of products to be created.
5334
+ * @minSize 1
5335
+ * @maxSize 100
5336
+ */
5337
+ products?: V3Product[];
5338
+ /** Whether to return the full product entity in the response. */
5339
+ returnEntity?: boolean;
5340
+ /**
5341
+ * A list of requested fields to be included in the response. Relevant only if `return_entity` true.
5342
+ * @maxSize 100
5343
+ */
5344
+ fields?: RequestedFieldsWithLiterals[];
5345
+ }
5346
+ interface DoNotCallBulkCreateProductsResponse {
5347
+ /**
5348
+ * Products created by bulk action.
5349
+ * @minSize 1
5350
+ * @maxSize 100
5351
+ */
5352
+ results?: V3BulkProductResult[];
5353
+ /** Bulk action metadata. */
5354
+ bulkActionMetadata?: BulkActionMetadata;
5355
+ }
5356
+ interface V3BulkProductResult {
5357
+ /** Bulk action metadata for product. */
5358
+ itemMetadata?: CommonItemMetadata;
5359
+ /**
5360
+ * Full product entity.
5361
+ *
5362
+ * Returned only if `returnEntity: true` is passed in the request.
5363
+ */
5364
+ item?: V3Product;
5365
+ }
5366
+ interface CommonItemMetadata {
5367
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5368
+ id?: string | null;
5369
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5370
+ originalIndex?: number;
5371
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5372
+ success?: boolean;
5373
+ /** Details about the error in case of failure. */
5374
+ error?: ApplicationError;
5375
+ }
5376
+ interface BulkActionMetadata {
5377
+ /** Number of items that were successfully processed. */
5378
+ totalSuccesses?: number;
5379
+ /** Number of items that couldn't be processed. */
5380
+ totalFailures?: number;
5381
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5382
+ undetailedFailures?: number;
5383
+ }
5384
+ interface DoNotCallBulkUpdateProductsRequest {
5385
+ /**
5386
+ * List of products to be updated.
5387
+ * @minSize 1
5388
+ * @maxSize 100
5389
+ */
5390
+ products?: MaskedProduct[];
5391
+ /** Whether to return the full product entity in the response. */
5392
+ returnEntity?: boolean;
5393
+ /**
5394
+ * A list of requested fields to be included in the response. Relevant only if `return_entity` true.
5395
+ * @maxSize 100
5396
+ */
5397
+ fields?: RequestedFieldsWithLiterals[];
5398
+ }
5399
+ interface MaskedProduct {
5400
+ /** product to be updated, may be partial. */
5401
+ product?: V3Product;
5402
+ }
5403
+ interface DoNotCallBulkUpdateProductsResponse {
5404
+ /**
5405
+ * Products updated by bulk action.
5406
+ * @minSize 1
5407
+ * @maxSize 100
5408
+ */
5409
+ results?: V3BulkProductResult[];
5410
+ /** Bulk action metadata. */
5411
+ bulkActionMetadata?: BulkActionMetadata;
5412
+ }
5413
+ interface BulkUpdateProductsByFilterRequest {
5414
+ /**
5415
+ * Filter object in the following format:
5416
+ * `"filter" : {
5417
+ * "name": "value1",
5418
+ * "categoryIds":{"$in":["categoryId1", "categoryId2"]}
5419
+ * }`
5420
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
5421
+ */
5422
+ filter?: Record<string, any> | null;
5423
+ /** Product with new field values. */
5424
+ product?: V3Product;
5425
+ /** Free text to match in searchable fields */
5426
+ search?: SearchDetails;
5427
+ }
5428
+ interface BulkUpdateProductsByFilterResponse {
5429
+ /**
5430
+ * Job ID.
5431
+ *
5432
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
5433
+ * @format GUID
5434
+ */
5435
+ jobId?: string;
5436
+ }
5437
+ interface BulkDeleteProductsRequest {
5438
+ /**
5439
+ * IDs of products to be deleted.
5440
+ * @minLength 1
5441
+ * @maxLength 36
5442
+ * @minSize 1
5443
+ * @maxSize 100
5444
+ */
5445
+ productIds?: string[];
5446
+ }
5447
+ interface BulkDeleteProductsResponse {
5448
+ /**
5449
+ * Products deleted by bulk action.
5450
+ * @minSize 1
5451
+ * @maxSize 100
5452
+ */
5453
+ results?: BulkProductResult[];
5454
+ /** Bulk action metadata. */
5455
+ bulkActionMetadata?: BulkActionMetadata;
5456
+ }
5457
+ interface BulkProductResult {
5458
+ /** Information about successful action or error for failure. */
5459
+ itemMetadata?: CommonItemMetadata;
5460
+ }
5461
+ interface BulkDeleteProductsByFilterRequest {
5462
+ /**
5463
+ * Filter object in the following format:
5464
+ * `"filter" : {
5465
+ * "actualPriceRange.minValue": {"$lte": 5.99}
5466
+ * }`
5467
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
5468
+ */
5469
+ filter?: Record<string, any> | null;
5470
+ /** Free text to match in searchable fields */
5471
+ search?: SearchDetails;
5472
+ }
5473
+ interface BulkDeleteProductsByFilterResponse {
5474
+ /**
5475
+ * Job ID.
5476
+ *
5477
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
5478
+ * @format GUID
5479
+ */
5480
+ jobId?: string;
5481
+ }
5482
+ interface BulkAddInfoSectionsToProductsByFilterRequest {
5483
+ /**
5484
+ * Filter object in the following format:
5485
+ * `"filter" : {
5486
+ * "actualPriceRange.minValue": {"$lte": 5.99}
5487
+ * }`
5488
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
5489
+ */
5490
+ filter?: Record<string, any> | null;
5491
+ /**
5492
+ * Info sections to be added
5493
+ * @format GUID
5494
+ * @minSize 1
5495
+ * @maxSize 10
5496
+ */
5497
+ infoSectionIds?: string[];
5498
+ /** Free text to match in searchable fields */
5499
+ search?: SearchDetails;
5500
+ }
5501
+ interface BulkAddInfoSectionsToProductsByFilterResponse {
5502
+ /**
5503
+ * Job ID.
5504
+ *
5505
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
5506
+ * @format GUID
5507
+ */
5508
+ jobId?: string;
5509
+ }
5510
+ interface FulfillerDeleted {
5511
+ /** @format GUID */
5512
+ id?: string;
5513
+ }
5514
+ interface BulkAddInfoSectionsToProductsRequest {
5515
+ /**
5516
+ * Products to be updated with id and revision.
5517
+ * @minSize 1
5518
+ * @maxSize 100
5519
+ */
5520
+ products?: ProductIdWithRevision[];
5521
+ /**
5522
+ * Products to be updated with id and revision.
5523
+ * Info section to be added
5524
+ * @format GUID
5525
+ * @minSize 1
5526
+ * @maxSize 10
5527
+ */
5528
+ infoSectionIds?: string[];
5529
+ /** Whether to return all updated product entities in the response. Default: false */
5530
+ returnEntity?: boolean;
5531
+ /**
5532
+ * A list of requested fields to be included in the response.
5533
+ * @maxSize 100
5534
+ */
5535
+ fields?: RequestedFieldsWithLiterals[];
5536
+ }
5537
+ interface ProductIdWithRevision {
5538
+ /**
5539
+ * ID of product.
5540
+ * @minLength 1
5541
+ * @maxLength 36
5542
+ */
5543
+ productId?: string;
5544
+ /** The revision of the Product */
5545
+ revision?: string;
5546
+ }
5547
+ interface BulkAddInfoSectionsToProductsResponse {
5548
+ /**
5549
+ * Products updated by bulk action.
5550
+ * @minSize 1
5551
+ * @maxSize 100
5552
+ */
5553
+ results?: V3BulkProductResult[];
5554
+ /** Bulk action metadata. */
5555
+ bulkActionMetadata?: BulkActionMetadata;
5556
+ }
5557
+ interface BulkRemoveInfoSectionsFromProductsByFilterRequest {
5558
+ /**
5559
+ * Filter object in the following format:
5560
+ * `"filter" : {
5561
+ * "name": "value1",
5562
+ * "categoryIds":{"$in":["categoryId1", "categoryId2"]}
5563
+ * }`
5564
+ * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
5565
+ */
5566
+ filter?: Record<string, any> | null;
5567
+ /**
5568
+ * Info sections to be removed
5569
+ * @format GUID
5570
+ * @minSize 1
5571
+ * @maxSize 100
5572
+ */
5573
+ infoSectionIds?: string[];
5574
+ /** Free text to match in searchable fields */
5575
+ search?: SearchDetails;
5576
+ }
5577
+ interface BulkRemoveInfoSectionsFromProductsByFilterResponse {
5578
+ /**
5579
+ * Job ID.
5580
+ *
5581
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
5582
+ * @format GUID
5583
+ */
5584
+ jobId?: string;
5585
+ }
5586
+ interface BulkRemoveInfoSectionsFromProductsRequest {
5587
+ /**
5588
+ * Products to be updated with id and revision.
5589
+ * @minSize 1
5590
+ * @maxSize 100
5591
+ */
5592
+ products?: ProductIdWithRevision[];
5593
+ /**
5594
+ * Info section to be removed.
5595
+ * @format GUID
5596
+ * @minSize 1
5597
+ * @maxSize 100
5598
+ */
5599
+ infoSectionIds?: string[];
5600
+ /** Whether to return all updated product entities in the response. Default: false */
5601
+ returnEntity?: boolean;
5602
+ /**
5603
+ * A list of requested fields to be included in the response.
5604
+ * @maxSize 5
5605
+ */
5606
+ fields?: RequestedFieldsWithLiterals[];
5607
+ }
5608
+ interface BulkRemoveInfoSectionsFromProductsResponse {
5609
+ /**
5610
+ * Products updated by bulk action.
5611
+ * @minSize 1
5612
+ * @maxSize 100
5613
+ */
5614
+ results?: V3BulkProductResult[];
5615
+ /** Bulk action metadata. */
5616
+ bulkActionMetadata?: BulkActionMetadata;
5617
+ }
5618
+ interface BulkUpdateVariantsByFilterRequest {
5619
+ /** Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */
5620
+ filter?: Record<string, any> | null;
5621
+ /** Variant with new field values. */
5622
+ variant?: Variant;
5623
+ /** Free text to match in searchable fields */
5624
+ search?: SearchDetails;
5625
+ }
5626
+ interface BulkUpdateVariantsByFilterResponse {
5627
+ /**
5628
+ * Job ID.
5629
+ *
5630
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
5631
+ * @format GUID
5632
+ */
5633
+ jobId?: string;
5634
+ }
5635
+ interface BulkAdjustProductVariantsByFilterRequest {
5636
+ /** Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$contains` */
5637
+ filter?: Record<string, any> | null;
5638
+ /** The amount or percentage to change the variants cost by */
5639
+ cost?: AdjustValue;
5640
+ /** Defines rounding strategy of new calculated prices. Default: CURRENCY_PRECISION. */
5641
+ rounding?: RoundingStrategyWithLiterals;
5642
+ /** Free text to match in searchable fields */
5643
+ search?: SearchDetails;
5644
+ /** Actual price adjustment. */
5645
+ actualPrice?: AdjustValue;
5646
+ /** Compare at price adjustment. */
5647
+ compareAtPrice?: AdjustValue;
5648
+ /**
5649
+ * Set variant actualPrice from compareAtPrice by applying provided discount to it.
5650
+ * if compare-at-price doesn't exist, actualPrice will be set to compareAtPrice and the discount will be calculated from it.
5651
+ * For example variant compare at price 100$, variant actual price is 95$, requested `compareAtPriceDiscount.percentage` is 10, then old actual price ignored and new actual price set to 90 (100$ - 10%).
5652
+ */
5653
+ compareAtPriceDiscount?: UnsignedAdjustValue;
5654
+ }
5655
+ interface AdjustValue extends AdjustValueAdjustValueOneOf {
5656
+ /**
5657
+ * A decimal value to increase or reduce from the original value, can be negative.
5658
+ * @decimalValue options { gte:-999999999, lte:999999999, maxScale:2 }
5659
+ */
5660
+ amount?: string;
5661
+ /**
5662
+ * The percentage value to increase or reduce from the current value, can be negative.
5663
+ * @min -100
5664
+ * @max 1000
5665
+ */
5666
+ percentage?: number;
5667
+ }
5668
+ /** @oneof */
5669
+ interface AdjustValueAdjustValueOneOf {
5670
+ /**
5671
+ * A decimal value to increase or reduce from the original value, can be negative.
5672
+ * @decimalValue options { gte:-999999999, lte:999999999, maxScale:2 }
5673
+ */
5674
+ amount?: string;
5675
+ /**
5676
+ * The percentage value to increase or reduce from the current value, can be negative.
5677
+ * @min -100
5678
+ * @max 1000
5679
+ */
5680
+ percentage?: number;
5681
+ }
5682
+ declare enum RoundingStrategy {
5683
+ /** Undefined rounding strategy. */
5684
+ UNKNOWN_ROUNDING_STRATEGY = "UNKNOWN_ROUNDING_STRATEGY",
5685
+ /**
5686
+ * Calculated prices are saved without rounding to keep the maximum possible precision. It's a good idea to round numbers before displaying them.
5687
+ * For example, input $3.5555 -> saved value $3.5555
5688
+ */
5689
+ NO_ROUNDING = "NO_ROUNDING",
5690
+ /**
5691
+ * Calculated prices are rounded according to currency precision.
5692
+ * For example:, input $3.5555 -> saved value $3.56, input ¥3.5555 -> saved value ¥4
5693
+ */
5694
+ CURRENCY_PRECISION = "CURRENCY_PRECISION",
5695
+ /**
5696
+ * Calculated prices are rounded to nearest whole number.
5697
+ * For example, input $3.5555 -> saved value $4
5698
+ */
5699
+ NEAREST_WHOLE_NUMBER = "NEAREST_WHOLE_NUMBER"
5700
+ }
5701
+ /** @enumType */
5702
+ type RoundingStrategyWithLiterals = RoundingStrategy | 'UNKNOWN_ROUNDING_STRATEGY' | 'NO_ROUNDING' | 'CURRENCY_PRECISION' | 'NEAREST_WHOLE_NUMBER';
5703
+ interface UnsignedAdjustValue extends UnsignedAdjustValueAdjustValueOneOf {
5704
+ /**
5705
+ * A decimal value to reduce from the original value.
5706
+ * @decimalValue options { gte:0, lte:999999999, maxScale:2 }
5707
+ */
5708
+ amount?: string;
5709
+ /**
5710
+ * The percentage value to reduce from the original value.
5711
+ * @max 100
5712
+ */
5713
+ percentage?: number;
5714
+ }
5715
+ /** @oneof */
5716
+ interface UnsignedAdjustValueAdjustValueOneOf {
5717
+ /**
5718
+ * A decimal value to reduce from the original value.
5719
+ * @decimalValue options { gte:0, lte:999999999, maxScale:2 }
5720
+ */
5721
+ amount?: string;
5722
+ /**
5723
+ * The percentage value to reduce from the original value.
5724
+ * @max 100
5725
+ */
5726
+ percentage?: number;
5727
+ }
5728
+ interface BulkAdjustProductVariantsByFilterResponse {
5729
+ /**
5730
+ * Job ID.
5731
+ *
5732
+ * Pass this ID to [Get Async Job](https://dev.wix.com/docs/rest/business-management/async-job/introduction) to retrieve job details and metadata..
5733
+ * @format GUID
5734
+ */
5735
+ jobId?: string;
5736
+ }
5737
+ interface BulkInventoryItemAction {
5738
+ /**
5739
+ * Inventory items.
5740
+ * @maxSize 1000
5741
+ */
5742
+ inventoryItems?: InventoryItem[];
5743
+ /** Type of bulk inventory changed event - created, updated or deleted */
5744
+ eventType?: EventTypeWithLiterals;
5745
+ }
3574
5746
  /** Inventory Item. */
3575
5747
  interface InventoryItem extends InventoryItemTrackingMethodOneOf {
3576
5748
  /**
@@ -3715,6 +5887,23 @@ interface Product {
3715
5887
  /** Variant visible. */
3716
5888
  variantVisible?: boolean | null;
3717
5889
  }
5890
+ declare enum EventType {
5891
+ UNKNOWN = "UNKNOWN",
5892
+ CREATED = "CREATED",
5893
+ UPDATED = "UPDATED",
5894
+ DELETED = "DELETED"
5895
+ }
5896
+ /** @enumType */
5897
+ type EventTypeWithLiterals = EventType | 'UNKNOWN' | 'CREATED' | 'UPDATED' | 'DELETED';
5898
+ interface CalculateProductInventorPreorderStatusAsyncRequest {
5899
+ /**
5900
+ * ID of the product to calculate inventory for
5901
+ * @format GUID
5902
+ */
5903
+ productId?: string;
5904
+ }
5905
+ interface CalculateProductInventorPreorderStatusAsyncResponse {
5906
+ }
3718
5907
  interface CreateProductRequest {
3719
5908
  /**
3720
5909
  * Product to create.
@@ -3733,6 +5922,25 @@ interface CreateProductResponse {
3733
5922
  /** Created product. */
3734
5923
  product?: V3Product;
3735
5924
  }
5925
+ interface VariantsNotAlignedWithProduct {
5926
+ /**
5927
+ * Variants not aligned with product
5928
+ * @maxSize 1000
5929
+ */
5930
+ variants?: VariantNotAlignedWithProduct[];
5931
+ }
5932
+ interface VariantNotAlignedWithProduct {
5933
+ /**
5934
+ * variant id
5935
+ * @format GUID
5936
+ */
5937
+ variantId?: string;
5938
+ /**
5939
+ * what's wrong with this specific variant
5940
+ * @maxLength 200
5941
+ */
5942
+ errorDescription?: string;
5943
+ }
3736
5944
  interface CreateProductWithInventoryRequest {
3737
5945
  /**
3738
5946
  * Product to create with inventory.
@@ -3888,6 +6096,15 @@ interface UpstreamWixCommonItemMetadata {
3888
6096
  /** Details about the error in case of failure. */
3889
6097
  error?: ApplicationError;
3890
6098
  }
6099
+ interface InvalidDigitalFileIds {
6100
+ /**
6101
+ * ids of digital files which caused errors.
6102
+ * @maxSize 1000
6103
+ * @minLength 1
6104
+ * @maxLength 100
6105
+ */
6106
+ ids?: string[];
6107
+ }
3891
6108
  interface BulkCreateProductsWithInventoryRequest {
3892
6109
  /**
3893
6110
  * List of products to create with inventory.
@@ -5038,6 +7255,960 @@ interface TreeReference {
5038
7255
  */
5039
7256
  treeKey?: string | null;
5040
7257
  }
7258
+ /** @docsIgnore */
7259
+ type CreateProductApplicationErrors = {
7260
+ code?: 'MISSING_VARIANT_OPTION_CHOICE';
7261
+ description?: string;
7262
+ data?: Record<string, any>;
7263
+ } | {
7264
+ code?: 'DUPLICATE_VARIANT_OPTION_CHOICE';
7265
+ description?: string;
7266
+ data?: Record<string, any>;
7267
+ } | {
7268
+ code?: 'DUPLICATE_PRODUCT_OPTIONS';
7269
+ description?: string;
7270
+ data?: Record<string, any>;
7271
+ } | {
7272
+ code?: 'INVALID_DEFAULT_VARIANT';
7273
+ description?: string;
7274
+ data?: Record<string, any>;
7275
+ } | {
7276
+ code?: 'VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT';
7277
+ description?: string;
7278
+ data?: VariantsNotAlignedWithProduct;
7279
+ } | {
7280
+ code?: 'DUPLICATE_SLUG_ERROR';
7281
+ description?: string;
7282
+ data?: Record<string, any>;
7283
+ } | {
7284
+ code?: 'DIGITAL_FILE_NOT_FOUND_ERROR';
7285
+ description?: string;
7286
+ data?: Record<string, any>;
7287
+ } | {
7288
+ code?: 'BARCODE_ALREADY_EXIST_ERROR';
7289
+ description?: string;
7290
+ data?: Record<string, any>;
7291
+ } | {
7292
+ code?: 'DUPLICATE_BARCODE_ERROR';
7293
+ description?: string;
7294
+ data?: Record<string, any>;
7295
+ } | {
7296
+ code?: 'SKU_ALREADY_EXIST_ERROR';
7297
+ description?: string;
7298
+ data?: Record<string, any>;
7299
+ } | {
7300
+ code?: 'DUPLICATE_SKU_ERROR';
7301
+ description?: string;
7302
+ data?: Record<string, any>;
7303
+ } | {
7304
+ code?: 'VARIANT_ID_ALREADY_EXISTS';
7305
+ description?: string;
7306
+ data?: Record<string, any>;
7307
+ } | {
7308
+ code?: 'INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION';
7309
+ description?: string;
7310
+ data?: Record<string, any>;
7311
+ } | {
7312
+ code?: 'ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT';
7313
+ description?: string;
7314
+ data?: Record<string, any>;
7315
+ } | {
7316
+ code?: 'INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT';
7317
+ description?: string;
7318
+ data?: Record<string, any>;
7319
+ } | {
7320
+ code?: 'SUBSCRIPTION_ID_ALREADY_EXISTS';
7321
+ description?: string;
7322
+ data?: Record<string, any>;
7323
+ } | {
7324
+ code?: 'PRODUCTS_LIMIT_EXCEEDED';
7325
+ description?: string;
7326
+ data?: Record<string, any>;
7327
+ } | {
7328
+ code?: 'PRODUCT_MEDIA_NOT_EXIST';
7329
+ description?: string;
7330
+ data?: Record<string, any>;
7331
+ } | {
7332
+ code?: 'ONLY_SPACES_STRING_ERROR';
7333
+ description?: string;
7334
+ data?: Record<string, any>;
7335
+ } | {
7336
+ code?: 'BRAND_CREATION_FAILED';
7337
+ description?: string;
7338
+ data?: Record<string, any>;
7339
+ } | {
7340
+ code?: 'RIBBON_NOT_FOUND';
7341
+ description?: string;
7342
+ data?: Record<string, any>;
7343
+ } | {
7344
+ code?: 'RIBBON_CREATION_FAILED';
7345
+ description?: string;
7346
+ data?: Record<string, any>;
7347
+ } | {
7348
+ code?: 'INFO_SECTION_CREATION_FAILED';
7349
+ description?: string;
7350
+ data?: Record<string, any>;
7351
+ } | {
7352
+ code?: 'CUSTOMIZATION_NOT_EXIST';
7353
+ description?: string;
7354
+ data?: Record<string, any>;
7355
+ } | {
7356
+ code?: 'CUSTOMIZATIONS_CREATION_FAILED';
7357
+ description?: string;
7358
+ data?: Record<string, any>;
7359
+ } | {
7360
+ code?: 'ADD_CUSTOMIZATION_CHOICES_FAILED';
7361
+ description?: string;
7362
+ data?: Record<string, any>;
7363
+ } | {
7364
+ code?: 'CHOICE_NOT_EXIST';
7365
+ description?: string;
7366
+ data?: Record<string, any>;
7367
+ } | {
7368
+ code?: 'PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED';
7369
+ description?: string;
7370
+ data?: Record<string, any>;
7371
+ } | {
7372
+ code?: 'PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED';
7373
+ description?: string;
7374
+ data?: Record<string, any>;
7375
+ } | {
7376
+ code?: 'MODIFIER_NAME_AND_TYPE_REQUIRED';
7377
+ description?: string;
7378
+ data?: Record<string, any>;
7379
+ } | {
7380
+ code?: 'MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED';
7381
+ description?: string;
7382
+ data?: Record<string, any>;
7383
+ } | {
7384
+ code?: 'TOO_MANY_OPTIONS_IN_REQUEST';
7385
+ description?: string;
7386
+ data?: Record<string, any>;
7387
+ } | {
7388
+ code?: 'COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE';
7389
+ description?: string;
7390
+ data?: Record<string, any>;
7391
+ };
7392
+ /** @docsIgnore */
7393
+ type CreateProductValidationErrors = {
7394
+ ruleName?: 'VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED';
7395
+ } | {
7396
+ ruleName?: 'SUBSCRIPTION_INVALID_AUTO_RENEWAL';
7397
+ } | {
7398
+ ruleName?: 'DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS';
7399
+ } | {
7400
+ ruleName?: 'DESCRIPTION_SIZE_TOO_BIG';
7401
+ } | {
7402
+ ruleName?: 'DUPLICATE_MEDIA_ERROR';
7403
+ } | {
7404
+ ruleName?: 'BRAND_MISSING_ID';
7405
+ } | {
7406
+ ruleName?: 'PRICE_PER_UNIT_NOT_ALIGNED';
7407
+ };
7408
+ /** @docsIgnore */
7409
+ type CreateProductWithInventoryApplicationErrors = {
7410
+ code?: 'RIBBON_NOT_FOUND';
7411
+ description?: string;
7412
+ data?: Record<string, any>;
7413
+ } | {
7414
+ code?: 'RIBBON_CREATION_FAILED';
7415
+ description?: string;
7416
+ data?: Record<string, any>;
7417
+ } | {
7418
+ code?: 'INFO_SECTION_CREATION_FAILED';
7419
+ description?: string;
7420
+ data?: Record<string, any>;
7421
+ } | {
7422
+ code?: 'CUSTOMIZATION_NOT_EXIST';
7423
+ description?: string;
7424
+ data?: Record<string, any>;
7425
+ } | {
7426
+ code?: 'CUSTOMIZATIONS_CREATION_FAILED';
7427
+ description?: string;
7428
+ data?: Record<string, any>;
7429
+ } | {
7430
+ code?: 'ADD_CUSTOMIZATION_CHOICES_FAILED';
7431
+ description?: string;
7432
+ data?: Record<string, any>;
7433
+ } | {
7434
+ code?: 'CHOICE_NOT_EXIST';
7435
+ description?: string;
7436
+ data?: Record<string, any>;
7437
+ } | {
7438
+ code?: 'PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED';
7439
+ description?: string;
7440
+ data?: Record<string, any>;
7441
+ } | {
7442
+ code?: 'PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED';
7443
+ description?: string;
7444
+ data?: Record<string, any>;
7445
+ } | {
7446
+ code?: 'MODIFIER_NAME_AND_TYPE_REQUIRED';
7447
+ description?: string;
7448
+ data?: Record<string, any>;
7449
+ } | {
7450
+ code?: 'MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED';
7451
+ description?: string;
7452
+ data?: Record<string, any>;
7453
+ } | {
7454
+ code?: 'COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE';
7455
+ description?: string;
7456
+ data?: Record<string, any>;
7457
+ };
7458
+ /** @docsIgnore */
7459
+ type CreateProductWithInventoryValidationErrors = {
7460
+ ruleName?: 'REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE';
7461
+ } | {
7462
+ ruleName?: 'BRAND_MISSING_ID';
7463
+ } | {
7464
+ ruleName?: 'PRICE_PER_UNIT_NOT_ALIGNED';
7465
+ };
7466
+ /** @docsIgnore */
7467
+ type UpdateProductApplicationErrors = {
7468
+ code?: 'MISSING_VARIANT_OPTION_CHOICE';
7469
+ description?: string;
7470
+ data?: Record<string, any>;
7471
+ } | {
7472
+ code?: 'DUPLICATE_VARIANT_OPTION_CHOICE';
7473
+ description?: string;
7474
+ data?: Record<string, any>;
7475
+ } | {
7476
+ code?: 'DUPLICATE_PRODUCT_OPTIONS';
7477
+ description?: string;
7478
+ data?: Record<string, any>;
7479
+ } | {
7480
+ code?: 'INVALID_DEFAULT_VARIANT';
7481
+ description?: string;
7482
+ data?: Record<string, any>;
7483
+ } | {
7484
+ code?: 'FIELD_MASK_VALUE_NOT_SUPPORTED';
7485
+ description?: string;
7486
+ data?: UnsupportedFieldMasks;
7487
+ } | {
7488
+ code?: 'VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT';
7489
+ description?: string;
7490
+ data?: VariantsNotAlignedWithProduct;
7491
+ } | {
7492
+ code?: 'DUPLICATE_SLUG_ERROR';
7493
+ description?: string;
7494
+ data?: Record<string, any>;
7495
+ } | {
7496
+ code?: 'DIGITAL_FILE_NOT_FOUND_ERROR';
7497
+ description?: string;
7498
+ data?: Record<string, any>;
7499
+ } | {
7500
+ code?: 'BARCODE_ALREADY_EXIST_ERROR';
7501
+ description?: string;
7502
+ data?: Record<string, any>;
7503
+ } | {
7504
+ code?: 'DUPLICATE_BARCODE_ERROR';
7505
+ description?: string;
7506
+ data?: Record<string, any>;
7507
+ } | {
7508
+ code?: 'SKU_ALREADY_EXIST_ERROR';
7509
+ description?: string;
7510
+ data?: Record<string, any>;
7511
+ } | {
7512
+ code?: 'DUPLICATE_SKU_ERROR';
7513
+ description?: string;
7514
+ data?: Record<string, any>;
7515
+ } | {
7516
+ code?: 'VARIANT_ID_ALREADY_EXISTS';
7517
+ description?: string;
7518
+ data?: Record<string, any>;
7519
+ } | {
7520
+ code?: 'INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION';
7521
+ description?: string;
7522
+ data?: Record<string, any>;
7523
+ } | {
7524
+ code?: 'ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT';
7525
+ description?: string;
7526
+ data?: Record<string, any>;
7527
+ } | {
7528
+ code?: 'INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT';
7529
+ description?: string;
7530
+ data?: Record<string, any>;
7531
+ } | {
7532
+ code?: 'SUBSCRIPTION_ID_ALREADY_EXISTS';
7533
+ description?: string;
7534
+ data?: Record<string, any>;
7535
+ } | {
7536
+ code?: 'PREORDER_VALIDATION_ERROR';
7537
+ description?: string;
7538
+ data?: Record<string, any>;
7539
+ } | {
7540
+ code?: 'BRAND_CREATION_FAILED';
7541
+ description?: string;
7542
+ data?: Record<string, any>;
7543
+ } | {
7544
+ code?: 'RIBBON_NOT_FOUND';
7545
+ description?: string;
7546
+ data?: Record<string, any>;
7547
+ } | {
7548
+ code?: 'INFO_SECTION_ERROR_OCCURRED';
7549
+ description?: string;
7550
+ data?: Record<string, any>;
7551
+ } | {
7552
+ code?: 'CUSTOMIZATION_NOT_EXIST';
7553
+ description?: string;
7554
+ data?: Record<string, any>;
7555
+ } | {
7556
+ code?: 'ADD_CUSTOMIZATION_CHOICES_FAILED';
7557
+ description?: string;
7558
+ data?: Record<string, any>;
7559
+ } | {
7560
+ code?: 'CHOICE_NOT_EXIST';
7561
+ description?: string;
7562
+ data?: Record<string, any>;
7563
+ } | {
7564
+ code?: 'FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR';
7565
+ description?: string;
7566
+ data?: Record<string, any>;
7567
+ } | {
7568
+ code?: 'COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE';
7569
+ description?: string;
7570
+ data?: Record<string, any>;
7571
+ };
7572
+ /** @docsIgnore */
7573
+ type UpdateProductValidationErrors = {
7574
+ ruleName?: 'VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED';
7575
+ } | {
7576
+ ruleName?: 'MISSING_OPTIONS_ON_UPDATE_VARIANTS';
7577
+ } | {
7578
+ ruleName?: 'SUBSCRIPTION_INVALID_AUTO_RENEWAL';
7579
+ } | {
7580
+ ruleName?: 'DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS';
7581
+ } | {
7582
+ ruleName?: 'DESCRIPTION_SIZE_TOO_BIG';
7583
+ } | {
7584
+ ruleName?: 'DUPLICATE_MEDIA_ERROR';
7585
+ } | {
7586
+ ruleName?: 'BRAND_MISSING_ID';
7587
+ } | {
7588
+ ruleName?: 'PRICE_PER_UNIT_NOT_ALIGNED';
7589
+ };
7590
+ /** @docsIgnore */
7591
+ type UpdateProductWithInventoryApplicationErrors = {
7592
+ code?: 'RIBBON_NOT_FOUND';
7593
+ description?: string;
7594
+ data?: Record<string, any>;
7595
+ } | {
7596
+ code?: 'INFO_SECTION_ERROR_OCCURRED';
7597
+ description?: string;
7598
+ data?: Record<string, any>;
7599
+ } | {
7600
+ code?: 'CUSTOMIZATION_NOT_EXIST';
7601
+ description?: string;
7602
+ data?: Record<string, any>;
7603
+ } | {
7604
+ code?: 'ADD_CUSTOMIZATION_CHOICES_FAILED';
7605
+ description?: string;
7606
+ data?: Record<string, any>;
7607
+ } | {
7608
+ code?: 'CHOICE_NOT_EXIST';
7609
+ description?: string;
7610
+ data?: Record<string, any>;
7611
+ } | {
7612
+ code?: 'PRODUCT_RESTRICTION_ERROR';
7613
+ description?: string;
7614
+ data?: Record<string, any>;
7615
+ } | {
7616
+ code?: 'PREORDER_VALIDATION_ERROR';
7617
+ description?: string;
7618
+ data?: Record<string, any>;
7619
+ } | {
7620
+ code?: 'FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR';
7621
+ description?: string;
7622
+ data?: Record<string, any>;
7623
+ } | {
7624
+ code?: 'COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE';
7625
+ description?: string;
7626
+ data?: Record<string, any>;
7627
+ };
7628
+ /** @docsIgnore */
7629
+ type UpdateProductWithInventoryValidationErrors = {
7630
+ ruleName?: 'REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE';
7631
+ } | {
7632
+ ruleName?: 'BRAND_MISSING_ID';
7633
+ } | {
7634
+ ruleName?: 'PRICE_PER_UNIT_NOT_ALIGNED';
7635
+ };
7636
+ /** @docsIgnore */
7637
+ type BulkCreateProductsApplicationErrors = {
7638
+ code?: 'MISSING_VARIANT_OPTION_CHOICE';
7639
+ description?: string;
7640
+ data?: Record<string, any>;
7641
+ } | {
7642
+ code?: 'DUPLICATE_VARIANT_OPTION_CHOICE';
7643
+ description?: string;
7644
+ data?: Record<string, any>;
7645
+ } | {
7646
+ code?: 'DUPLICATE_PRODUCT_OPTIONS';
7647
+ description?: string;
7648
+ data?: Record<string, any>;
7649
+ } | {
7650
+ code?: 'INVALID_DEFAULT_VARIANT';
7651
+ description?: string;
7652
+ data?: Record<string, any>;
7653
+ } | {
7654
+ code?: 'VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT';
7655
+ description?: string;
7656
+ data?: VariantsNotAlignedWithProduct;
7657
+ } | {
7658
+ code?: 'DUPLICATE_SLUG_ERROR';
7659
+ description?: string;
7660
+ data?: Record<string, any>;
7661
+ } | {
7662
+ code?: 'DIGITAL_FILE_NOT_FOUND_ERROR';
7663
+ description?: string;
7664
+ data?: InvalidDigitalFileIds;
7665
+ } | {
7666
+ code?: 'BARCODE_ALREADY_EXIST_ERROR';
7667
+ description?: string;
7668
+ data?: Record<string, any>;
7669
+ } | {
7670
+ code?: 'DUPLICATE_BARCODE_ERROR';
7671
+ description?: string;
7672
+ data?: Record<string, any>;
7673
+ } | {
7674
+ code?: 'SKU_ALREADY_EXIST_ERROR';
7675
+ description?: string;
7676
+ data?: Record<string, any>;
7677
+ } | {
7678
+ code?: 'DUPLICATE_SKU_ERROR';
7679
+ description?: string;
7680
+ data?: Record<string, any>;
7681
+ } | {
7682
+ code?: 'VARIANT_ID_ALREADY_EXISTS';
7683
+ description?: string;
7684
+ data?: Record<string, any>;
7685
+ } | {
7686
+ code?: 'INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION';
7687
+ description?: string;
7688
+ data?: Record<string, any>;
7689
+ } | {
7690
+ code?: 'ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT';
7691
+ description?: string;
7692
+ data?: Record<string, any>;
7693
+ } | {
7694
+ code?: 'INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT';
7695
+ description?: string;
7696
+ data?: Record<string, any>;
7697
+ } | {
7698
+ code?: 'SUBSCRIPTION_ID_ALREADY_EXISTS';
7699
+ description?: string;
7700
+ data?: Record<string, any>;
7701
+ } | {
7702
+ code?: 'PRODUCTS_LIMIT_EXCEEDED';
7703
+ description?: string;
7704
+ data?: Record<string, any>;
7705
+ } | {
7706
+ code?: 'PRODUCT_MEDIA_NOT_EXIST';
7707
+ description?: string;
7708
+ data?: Record<string, any>;
7709
+ } | {
7710
+ code?: 'ONLY_SPACES_STRING_ERROR';
7711
+ description?: string;
7712
+ data?: Record<string, any>;
7713
+ } | {
7714
+ code?: 'BRAND_CREATION_FAILED';
7715
+ description?: string;
7716
+ data?: Record<string, any>;
7717
+ } | {
7718
+ code?: 'RIBBON_NOT_FOUND';
7719
+ description?: string;
7720
+ data?: Record<string, any>;
7721
+ } | {
7722
+ code?: 'RIBBON_CREATION_FAILED';
7723
+ description?: string;
7724
+ data?: Record<string, any>;
7725
+ } | {
7726
+ code?: 'INFO_SECTION_CREATION_FAILED';
7727
+ description?: string;
7728
+ data?: Record<string, any>;
7729
+ } | {
7730
+ code?: 'CUSTOMIZATION_NOT_EXIST';
7731
+ description?: string;
7732
+ data?: Record<string, any>;
7733
+ } | {
7734
+ code?: 'CUSTOMIZATIONS_CREATION_FAILED';
7735
+ description?: string;
7736
+ data?: Record<string, any>;
7737
+ } | {
7738
+ code?: 'ADD_CUSTOMIZATION_CHOICES_FAILED';
7739
+ description?: string;
7740
+ data?: Record<string, any>;
7741
+ } | {
7742
+ code?: 'CHOICE_NOT_EXIST';
7743
+ description?: string;
7744
+ data?: Record<string, any>;
7745
+ } | {
7746
+ code?: 'PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED';
7747
+ description?: string;
7748
+ data?: Record<string, any>;
7749
+ } | {
7750
+ code?: 'PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED';
7751
+ description?: string;
7752
+ data?: Record<string, any>;
7753
+ } | {
7754
+ code?: 'MODIFIER_NAME_AND_TYPE_REQUIRED';
7755
+ description?: string;
7756
+ data?: Record<string, any>;
7757
+ } | {
7758
+ code?: 'MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED';
7759
+ description?: string;
7760
+ data?: Record<string, any>;
7761
+ } | {
7762
+ code?: 'TOO_MANY_OPTIONS_IN_REQUEST';
7763
+ description?: string;
7764
+ data?: Record<string, any>;
7765
+ } | {
7766
+ code?: 'COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE';
7767
+ description?: string;
7768
+ data?: Record<string, any>;
7769
+ };
7770
+ /** @docsIgnore */
7771
+ type BulkCreateProductsValidationErrors = {
7772
+ ruleName?: 'VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED';
7773
+ } | {
7774
+ ruleName?: 'SUBSCRIPTION_INVALID_AUTO_RENEWAL';
7775
+ } | {
7776
+ ruleName?: 'DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS';
7777
+ } | {
7778
+ ruleName?: 'DESCRIPTION_SIZE_TOO_BIG';
7779
+ } | {
7780
+ ruleName?: 'DUPLICATE_MEDIA_ERROR';
7781
+ } | {
7782
+ ruleName?: 'ID_NOT_ALLOWED_IN_REQUEST';
7783
+ } | {
7784
+ ruleName?: 'BRAND_MISSING_ID';
7785
+ } | {
7786
+ ruleName?: 'PRICE_PER_UNIT_NOT_ALIGNED';
7787
+ };
7788
+ /** @docsIgnore */
7789
+ type BulkCreateProductsWithInventoryApplicationErrors = {
7790
+ code?: 'RIBBON_NOT_FOUND';
7791
+ description?: string;
7792
+ data?: Record<string, any>;
7793
+ } | {
7794
+ code?: 'RIBBON_CREATION_FAILED';
7795
+ description?: string;
7796
+ data?: Record<string, any>;
7797
+ } | {
7798
+ code?: 'INFO_SECTION_CREATION_FAILED';
7799
+ description?: string;
7800
+ data?: Record<string, any>;
7801
+ } | {
7802
+ code?: 'CUSTOMIZATION_NOT_EXIST';
7803
+ description?: string;
7804
+ data?: Record<string, any>;
7805
+ } | {
7806
+ code?: 'CUSTOMIZATIONS_CREATION_FAILED';
7807
+ description?: string;
7808
+ data?: Record<string, any>;
7809
+ } | {
7810
+ code?: 'ADD_CUSTOMIZATION_CHOICES_FAILED';
7811
+ description?: string;
7812
+ data?: Record<string, any>;
7813
+ } | {
7814
+ code?: 'CHOICE_NOT_EXIST';
7815
+ description?: string;
7816
+ data?: Record<string, any>;
7817
+ } | {
7818
+ code?: 'PRODUCT_OPTION_NAME_AND_TYPE_REQUIRED';
7819
+ description?: string;
7820
+ data?: Record<string, any>;
7821
+ } | {
7822
+ code?: 'PRODUCT_OPTION_CHOICE_NAME_AND_TYPE_REQUIRED';
7823
+ description?: string;
7824
+ data?: Record<string, any>;
7825
+ } | {
7826
+ code?: 'MODIFIER_NAME_AND_TYPE_REQUIRED';
7827
+ description?: string;
7828
+ data?: Record<string, any>;
7829
+ } | {
7830
+ code?: 'MODIFIER_CHOICE_NAME_AND_TYPE_REQUIRED';
7831
+ description?: string;
7832
+ data?: Record<string, any>;
7833
+ } | {
7834
+ code?: 'TOO_MANY_OPTIONS_IN_REQUEST';
7835
+ description?: string;
7836
+ data?: Record<string, any>;
7837
+ } | {
7838
+ code?: 'COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE';
7839
+ description?: string;
7840
+ data?: Record<string, any>;
7841
+ };
7842
+ /** @docsIgnore */
7843
+ type BulkCreateProductsWithInventoryValidationErrors = {
7844
+ ruleName?: 'REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE';
7845
+ } | {
7846
+ ruleName?: 'BRAND_MISSING_ID';
7847
+ } | {
7848
+ ruleName?: 'ID_NOT_ALLOWED_IN_REQUEST';
7849
+ } | {
7850
+ ruleName?: 'PRICE_PER_UNIT_NOT_ALIGNED';
7851
+ };
7852
+ /** @docsIgnore */
7853
+ type BulkUpdateProductsApplicationErrors = {
7854
+ code?: 'TOO_MANY_VARIANTS';
7855
+ description?: string;
7856
+ data?: Record<string, any>;
7857
+ } | {
7858
+ code?: 'MISSING_VARIANT_OPTION_CHOICE';
7859
+ description?: string;
7860
+ data?: Record<string, any>;
7861
+ } | {
7862
+ code?: 'DUPLICATE_VARIANT_OPTION_CHOICE';
7863
+ description?: string;
7864
+ data?: Record<string, any>;
7865
+ } | {
7866
+ code?: 'DUPLICATE_PRODUCT_OPTIONS';
7867
+ description?: string;
7868
+ data?: Record<string, any>;
7869
+ } | {
7870
+ code?: 'INVALID_DEFAULT_VARIANT';
7871
+ description?: string;
7872
+ data?: Record<string, any>;
7873
+ } | {
7874
+ code?: 'FIELD_MASK_VALUE_NOT_SUPPORTED';
7875
+ description?: string;
7876
+ data?: UnsupportedFieldMasks;
7877
+ } | {
7878
+ code?: 'VARIANTS_ARE_NOT_ALIGNED_WITH_PRODUCT';
7879
+ description?: string;
7880
+ data?: VariantsNotAlignedWithProduct;
7881
+ } | {
7882
+ code?: 'DUPLICATE_SLUG_ERROR';
7883
+ description?: string;
7884
+ data?: Record<string, any>;
7885
+ } | {
7886
+ code?: 'DIGITAL_FILE_NOT_FOUND_ERROR';
7887
+ description?: string;
7888
+ data?: Record<string, any>;
7889
+ } | {
7890
+ code?: 'BARCODE_ALREADY_EXIST_ERROR';
7891
+ description?: string;
7892
+ data?: Record<string, any>;
7893
+ } | {
7894
+ code?: 'DUPLICATE_BARCODE_ERROR';
7895
+ description?: string;
7896
+ data?: Record<string, any>;
7897
+ } | {
7898
+ code?: 'SKU_ALREADY_EXIST_ERROR';
7899
+ description?: string;
7900
+ data?: Record<string, any>;
7901
+ } | {
7902
+ code?: 'DUPLICATE_SKU_ERROR';
7903
+ description?: string;
7904
+ data?: Record<string, any>;
7905
+ } | {
7906
+ code?: 'VARIANT_ID_ALREADY_EXISTS';
7907
+ description?: string;
7908
+ data?: Record<string, any>;
7909
+ } | {
7910
+ code?: 'INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION';
7911
+ description?: string;
7912
+ data?: Record<string, any>;
7913
+ } | {
7914
+ code?: 'ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT';
7915
+ description?: string;
7916
+ data?: Record<string, any>;
7917
+ } | {
7918
+ code?: 'INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT';
7919
+ description?: string;
7920
+ data?: Record<string, any>;
7921
+ } | {
7922
+ code?: 'SUBSCRIPTION_ID_ALREADY_EXISTS';
7923
+ description?: string;
7924
+ data?: Record<string, any>;
7925
+ } | {
7926
+ code?: 'PREORDER_VALIDATION_ERROR';
7927
+ description?: string;
7928
+ data?: Record<string, any>;
7929
+ } | {
7930
+ code?: 'BRAND_CREATION_FAILED';
7931
+ description?: string;
7932
+ data?: Record<string, any>;
7933
+ } | {
7934
+ code?: 'RIBBON_NOT_FOUND';
7935
+ description?: string;
7936
+ data?: Record<string, any>;
7937
+ } | {
7938
+ code?: 'INFO_SECTION_ERROR_OCCURRED';
7939
+ description?: string;
7940
+ data?: Record<string, any>;
7941
+ } | {
7942
+ code?: 'CUSTOMIZATION_NOT_EXIST';
7943
+ description?: string;
7944
+ data?: Record<string, any>;
7945
+ } | {
7946
+ code?: 'ADD_CUSTOMIZATION_CHOICES_FAILED';
7947
+ description?: string;
7948
+ data?: Record<string, any>;
7949
+ } | {
7950
+ code?: 'CHOICE_NOT_EXIST';
7951
+ description?: string;
7952
+ data?: Record<string, any>;
7953
+ } | {
7954
+ code?: 'TOO_MANY_OPTIONS_IN_REQUEST';
7955
+ description?: string;
7956
+ data?: Record<string, any>;
7957
+ } | {
7958
+ code?: 'FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR';
7959
+ description?: string;
7960
+ data?: Record<string, any>;
7961
+ } | {
7962
+ code?: 'COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE';
7963
+ description?: string;
7964
+ data?: Record<string, any>;
7965
+ };
7966
+ /** @docsIgnore */
7967
+ type BulkUpdateProductsValidationErrors = {
7968
+ ruleName?: 'VARIANTS_TYPED_PROPERTIES_ARE_NOT_ALIGNED';
7969
+ } | {
7970
+ ruleName?: 'MISSING_OPTIONS_ON_UPDATE_VARIANTS';
7971
+ } | {
7972
+ ruleName?: 'SUBSCRIPTION_INVALID_AUTO_RENEWAL';
7973
+ } | {
7974
+ ruleName?: 'DIGITAL_PRODUCT_CANNOT_BE_VISIBLE_IN_POS';
7975
+ } | {
7976
+ ruleName?: 'DESCRIPTION_SIZE_TOO_BIG';
7977
+ } | {
7978
+ ruleName?: 'DUPLICATE_MEDIA_ERROR';
7979
+ } | {
7980
+ ruleName?: 'BRAND_MISSING_ID';
7981
+ } | {
7982
+ ruleName?: 'DUPLICATE_PRODUCT_IDS_REQUEST';
7983
+ } | {
7984
+ ruleName?: 'PRICE_PER_UNIT_NOT_ALIGNED';
7985
+ };
7986
+ /** @docsIgnore */
7987
+ type BulkUpdateProductsWithInventoryApplicationErrors = {
7988
+ code?: 'RIBBON_NOT_FOUND';
7989
+ description?: string;
7990
+ data?: Record<string, any>;
7991
+ } | {
7992
+ code?: 'INFO_SECTION_ERROR_OCCURRED';
7993
+ description?: string;
7994
+ data?: Record<string, any>;
7995
+ } | {
7996
+ code?: 'CUSTOMIZATION_NOT_EXIST';
7997
+ description?: string;
7998
+ data?: Record<string, any>;
7999
+ } | {
8000
+ code?: 'ADD_CUSTOMIZATION_CHOICES_FAILED';
8001
+ description?: string;
8002
+ data?: Record<string, any>;
8003
+ } | {
8004
+ code?: 'CHOICE_NOT_EXIST';
8005
+ description?: string;
8006
+ data?: Record<string, any>;
8007
+ } | {
8008
+ code?: 'PRODUCT_RESTRICTION_ERROR';
8009
+ description?: string;
8010
+ data?: Record<string, any>;
8011
+ } | {
8012
+ code?: 'PREORDER_VALIDATION_ERROR';
8013
+ description?: string;
8014
+ data?: Record<string, any>;
8015
+ } | {
8016
+ code?: 'TOO_MANY_OPTIONS_IN_REQUEST';
8017
+ description?: string;
8018
+ data?: Record<string, any>;
8019
+ } | {
8020
+ code?: 'FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR';
8021
+ description?: string;
8022
+ data?: Record<string, any>;
8023
+ } | {
8024
+ code?: 'COMPARE_AT_PRICE_LOWER_THAN_ACTUAL_PRICE';
8025
+ description?: string;
8026
+ data?: Record<string, any>;
8027
+ };
8028
+ /** @docsIgnore */
8029
+ type BulkUpdateProductsWithInventoryValidationErrors = {
8030
+ ruleName?: 'REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE';
8031
+ } | {
8032
+ ruleName?: 'BRAND_MISSING_ID';
8033
+ } | {
8034
+ ruleName?: 'DUPLICATE_PRODUCT_IDS_REQUEST';
8035
+ } | {
8036
+ ruleName?: 'PRICE_PER_UNIT_NOT_ALIGNED';
8037
+ };
8038
+ /** @docsIgnore */
8039
+ type BulkUpdateProductsByFilterApplicationErrors = {
8040
+ code?: 'FIELD_MASK_VALUE_NOT_SUPPORTED';
8041
+ description?: string;
8042
+ data?: UnsupportedFieldMasks;
8043
+ } | {
8044
+ code?: 'INVALID_PRODUCT_TYPE_FOR_SUBSCRIPTION';
8045
+ description?: string;
8046
+ data?: Record<string, any>;
8047
+ } | {
8048
+ code?: 'VARIANT_ID_ALREADY_EXISTS';
8049
+ description?: string;
8050
+ data?: Record<string, any>;
8051
+ } | {
8052
+ code?: 'ERROR_ALL_SUBSCRIPTIONS_HIDDEN_FOR_SUBSCRIPTION_ONLY_PRODUCT';
8053
+ description?: string;
8054
+ data?: Record<string, any>;
8055
+ } | {
8056
+ code?: 'INVALID_SUBSCRIPTION_DISCOUNT_AMOUNT';
8057
+ description?: string;
8058
+ data?: Record<string, any>;
8059
+ } | {
8060
+ code?: 'SUBSCRIPTION_ID_ALREADY_EXISTS';
8061
+ description?: string;
8062
+ data?: Record<string, any>;
8063
+ } | {
8064
+ code?: 'BRAND_CREATION_FAILED';
8065
+ description?: string;
8066
+ data?: Record<string, any>;
8067
+ } | {
8068
+ code?: 'RIBBON_NOT_FOUND';
8069
+ description?: string;
8070
+ data?: Record<string, any>;
8071
+ } | {
8072
+ code?: 'INFO_SECTION_ERROR_OCCURRED';
8073
+ description?: string;
8074
+ data?: Record<string, any>;
8075
+ } | {
8076
+ code?: 'CUSTOMIZATION_NOT_EXIST';
8077
+ description?: string;
8078
+ data?: Record<string, any>;
8079
+ } | {
8080
+ code?: 'ADD_CUSTOMIZATION_CHOICES_FAILED';
8081
+ description?: string;
8082
+ data?: Record<string, any>;
8083
+ } | {
8084
+ code?: 'CHOICE_NOT_EXIST';
8085
+ description?: string;
8086
+ data?: Record<string, any>;
8087
+ } | {
8088
+ code?: 'FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR';
8089
+ description?: string;
8090
+ data?: Record<string, any>;
8091
+ };
8092
+ /** @docsIgnore */
8093
+ type BulkUpdateProductsByFilterValidationErrors = {
8094
+ ruleName?: 'PRICE_PER_UNIT_NOT_ALIGNED';
8095
+ } | {
8096
+ ruleName?: 'MISSING_OPTIONS_ON_UPDATE_VARIANTS';
8097
+ } | {
8098
+ ruleName?: 'SUBSCRIPTION_INVALID_AUTO_RENEWAL';
8099
+ } | {
8100
+ ruleName?: 'DESCRIPTION_SIZE_TOO_BIG';
8101
+ };
8102
+ /** @docsIgnore */
8103
+ type BulkDeleteProductsValidationErrors = {
8104
+ ruleName?: 'DUPLICATE_PRODUCT_IDS_REQUEST';
8105
+ };
8106
+ /** @docsIgnore */
8107
+ type GetProductApplicationErrors = {
8108
+ code?: 'NO_PERMISSION_TO_READ_MERCHANT_DATA';
8109
+ description?: string;
8110
+ data?: Record<string, any>;
8111
+ } | {
8112
+ code?: 'NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS';
8113
+ description?: string;
8114
+ data?: Record<string, any>;
8115
+ };
8116
+ /** @docsIgnore */
8117
+ type GetProductBySlugApplicationErrors = {
8118
+ code?: 'NO_PERMISSION_TO_READ_MERCHANT_DATA';
8119
+ description?: string;
8120
+ data?: Record<string, any>;
8121
+ } | {
8122
+ code?: 'NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS';
8123
+ description?: string;
8124
+ data?: Record<string, any>;
8125
+ };
8126
+ /** @docsIgnore */
8127
+ type SearchProductsApplicationErrors = {
8128
+ code?: 'NO_PERMISSION_TO_READ_MERCHANT_DATA';
8129
+ description?: string;
8130
+ data?: Record<string, any>;
8131
+ } | {
8132
+ code?: 'NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS';
8133
+ description?: string;
8134
+ data?: Record<string, any>;
8135
+ };
8136
+ /** @docsIgnore */
8137
+ type QueryProductsApplicationErrors = {
8138
+ code?: 'NO_PERMISSION_TO_READ_MERCHANT_DATA';
8139
+ description?: string;
8140
+ data?: Record<string, any>;
8141
+ } | {
8142
+ code?: 'NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS';
8143
+ description?: string;
8144
+ data?: Record<string, any>;
8145
+ };
8146
+ /** @docsIgnore */
8147
+ type CountProductsApplicationErrors = {
8148
+ code?: 'NO_PERMISSION_TO_READ_MERCHANT_DATA';
8149
+ description?: string;
8150
+ data?: Record<string, any>;
8151
+ } | {
8152
+ code?: 'NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS';
8153
+ description?: string;
8154
+ data?: Record<string, any>;
8155
+ };
8156
+ /** @docsIgnore */
8157
+ type BulkUpdateProductVariantsByFilterApplicationErrors = {
8158
+ code?: 'FIELD_MASK_VALUE_NOT_SUPPORTED';
8159
+ description?: string;
8160
+ data?: UnsupportedFieldMasks;
8161
+ } | {
8162
+ code?: 'VARIANT_ID_ALREADY_EXISTS';
8163
+ description?: string;
8164
+ data?: Record<string, any>;
8165
+ } | {
8166
+ code?: 'FIELD_MASK_WITH_FIELD_NOT_PASSED_ERROR';
8167
+ description?: string;
8168
+ data?: Record<string, any>;
8169
+ };
8170
+ /** @docsIgnore */
8171
+ type BulkUpdateProductVariantsByFilterValidationErrors = {
8172
+ ruleName?: 'EMPTY_FIELD_MASK';
8173
+ } | {
8174
+ ruleName?: 'CANNOT_REMOVE_VARIANT_ACTUAL_PRICE';
8175
+ };
8176
+ /** @docsIgnore */
8177
+ type BulkAdjustProductVariantsByFilterApplicationErrors = {
8178
+ code?: 'ADJUSTED_ACTUAL_PRICE_OUT_OF_RANGE';
8179
+ description?: string;
8180
+ data?: Record<string, any>;
8181
+ } | {
8182
+ code?: 'ADJUSTED_COMPARE_AT_PRICE_OUT_OF_RANGE';
8183
+ description?: string;
8184
+ data?: Record<string, any>;
8185
+ } | {
8186
+ code?: 'ADJUSTED_COST_OUT_OF_RANGE';
8187
+ description?: string;
8188
+ data?: Record<string, any>;
8189
+ } | {
8190
+ code?: 'CANNOT_ADJUST_PRICE_RESTRICTED_VARIANT';
8191
+ description?: string;
8192
+ data?: Record<string, any>;
8193
+ };
8194
+ /** @docsIgnore */
8195
+ type BulkAdjustProductVariantsByFilterValidationErrors = {
8196
+ ruleName?: 'NO_VARIANT_ADJUSTMENTS_PASSED';
8197
+ } | {
8198
+ ruleName?: 'INVALID_PRICES_ADJUSTMENTS';
8199
+ };
8200
+ /** @docsIgnore */
8201
+ type BulkAddInfoSectionsToProductsByFilterApplicationErrors = {
8202
+ code?: 'TOO_MANY_INFO_SECTIONS_ERROR';
8203
+ description?: string;
8204
+ data?: Record<string, any>;
8205
+ };
8206
+ /** @docsIgnore */
8207
+ type BulkAddInfoSectionsToProductsApplicationErrors = {
8208
+ code?: 'TOO_MANY_INFO_SECTIONS_ERROR';
8209
+ description?: string;
8210
+ data?: Record<string, any>;
8211
+ };
5041
8212
 
5042
8213
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
5043
8214
  getUrl: (context: any) => string;
@@ -5086,4 +8257,4 @@ declare function bulkAddProductsToCategoriesByFilter(): __PublicMethodMetaInfo<'
5086
8257
  declare function bulkRemoveProductsFromCategoriesByFilter(): __PublicMethodMetaInfo<'POST', {}, BulkRemoveProductsFromCategoriesByFilterRequest$1, BulkRemoveProductsFromCategoriesByFilterRequest, BulkRemoveProductsFromCategoriesByFilterResponse$1, BulkRemoveProductsFromCategoriesByFilterResponse>;
5087
8258
  declare function getAllProductsCategory(): __PublicMethodMetaInfo<'GET', {}, GetAllProductsCategoryRequest$1, GetAllProductsCategoryRequest, GetAllProductsCategoryResponse$1, GetAllProductsCategoryResponse>;
5088
8259
 
5089
- export { type __PublicMethodMetaInfo, bulkAddInfoSectionsToProducts, bulkAddInfoSectionsToProductsByFilter, bulkAddProductsToCategoriesByFilter, bulkAdjustProductVariantsByFilter, bulkCreateProducts, bulkCreateProductsWithInventory, bulkDeleteProducts, bulkDeleteProductsByFilter, bulkRemoveInfoSectionsFromProducts, bulkRemoveInfoSectionsFromProductsByFilter, bulkRemoveProductsFromCategoriesByFilter, bulkUpdateProductVariantsByFilter, bulkUpdateProducts, bulkUpdateProductsByFilter, bulkUpdateProductsWithInventory, countProducts, createProduct, createProductWithInventory, deleteProduct, getAllProductsCategory, getProduct, getProductBySlug, queryProducts, searchProducts, updateProduct, updateProductWithInventory };
8260
+ export { type ActionEvent as ActionEventOriginal, type AdjustValueAdjustValueOneOf as AdjustValueAdjustValueOneOfOriginal, type AdjustValue as AdjustValueOriginal, type AggregationDataAggregationResults as AggregationDataAggregationResultsOriginal, type AggregationDataAggregationResultsResultOneOf as AggregationDataAggregationResultsResultOneOfOriginal, type AggregationDataAggregationResultsScalarResult as AggregationDataAggregationResultsScalarResultOriginal, type AggregationData as AggregationDataOriginal, AggregationDateHistogramAggregationInterval as AggregationDateHistogramAggregationIntervalOriginal, type AggregationDateHistogramAggregationIntervalWithLiterals as AggregationDateHistogramAggregationIntervalWithLiteralsOriginal, type AggregationDateHistogramAggregation as AggregationDateHistogramAggregationOriginal, type AggregationKindOneOf as AggregationKindOneOfOriginal, type AggregationNestedAggregationNestedAggregationItemKindOneOf as AggregationNestedAggregationNestedAggregationItemKindOneOfOriginal, type AggregationNestedAggregationNestedAggregationItem as AggregationNestedAggregationNestedAggregationItemOriginal, AggregationNestedAggregationNestedAggregationType as AggregationNestedAggregationNestedAggregationTypeOriginal, type AggregationNestedAggregationNestedAggregationTypeWithLiterals as AggregationNestedAggregationNestedAggregationTypeWithLiteralsOriginal, type AggregationNestedAggregation as AggregationNestedAggregationOriginal, type Aggregation as AggregationOriginal, type AggregationRangeAggregation as AggregationRangeAggregationOriginal, type AggregationRangeAggregationRangeBucket as AggregationRangeAggregationRangeBucketOriginal, type AggregationResultsDateHistogramResults as AggregationResultsDateHistogramResultsOriginal, type AggregationResultsGroupByValueResults as AggregationResultsGroupByValueResultsOriginal, type AggregationResultsNestedAggregationResults as AggregationResultsNestedAggregationResultsOriginal, type AggregationResultsNestedAggregationResultsResultOneOf as AggregationResultsNestedAggregationResultsResultOneOfOriginal, type AggregationResultsNestedResults as AggregationResultsNestedResultsOriginal, type AggregationResults as AggregationResultsOriginal, type AggregationResultsRangeResults as AggregationResultsRangeResultsOriginal, type AggregationResultsResultOneOf as AggregationResultsResultOneOfOriginal, type AggregationResultsScalarResult as AggregationResultsScalarResultOriginal, type AggregationResultsValueResults as AggregationResultsValueResultsOriginal, type AggregationScalarAggregation as AggregationScalarAggregationOriginal, AggregationType as AggregationTypeOriginal, type AggregationTypeWithLiterals as AggregationTypeWithLiteralsOriginal, type AggregationValueAggregationIncludeMissingValuesOptions as AggregationValueAggregationIncludeMissingValuesOptionsOriginal, AggregationValueAggregationMissingValues as AggregationValueAggregationMissingValuesOriginal, type AggregationValueAggregationMissingValuesWithLiterals as AggregationValueAggregationMissingValuesWithLiteralsOriginal, type AggregationValueAggregationOptionsOneOf as AggregationValueAggregationOptionsOneOfOriginal, type AggregationValueAggregation as AggregationValueAggregationOriginal, AggregationValueAggregationSortDirection as AggregationValueAggregationSortDirectionOriginal, type AggregationValueAggregationSortDirectionWithLiterals as AggregationValueAggregationSortDirectionWithLiteralsOriginal, AggregationValueAggregationSortType as AggregationValueAggregationSortTypeOriginal, type AggregationValueAggregationSortTypeWithLiterals as AggregationValueAggregationSortTypeWithLiteralsOriginal, Alignment as AlignmentOriginal, type AlignmentWithLiterals as AlignmentWithLiteralsOriginal, type AnchorData as AnchorDataOriginal, type AppEmbedDataAppDataOneOf as AppEmbedDataAppDataOneOfOriginal, type AppEmbedData as AppEmbedDataOriginal, type App as AppOriginal, AppType as AppTypeOriginal, type AppTypeWithLiterals as AppTypeWithLiteralsOriginal, type ApplicationError as ApplicationErrorOriginal, AspectRatio as AspectRatioOriginal, type AspectRatioWithLiterals as AspectRatioWithLiteralsOriginal, type AudioData as AudioDataOriginal, AvailabilityStatus as AvailabilityStatusOriginal, type AvailabilityStatusWithLiterals as AvailabilityStatusWithLiteralsOriginal, type BackgroundBackgroundOneOf as BackgroundBackgroundOneOfOriginal, type Background as BackgroundOriginal, BackgroundType as BackgroundTypeOriginal, type BackgroundTypeWithLiterals as BackgroundTypeWithLiteralsOriginal, type BlockquoteData as BlockquoteDataOriginal, type BookingData as BookingDataOriginal, type BorderColors as BorderColorsOriginal, type Border as BorderOriginal, type Brand as BrandOriginal, type BreadCrumb as BreadCrumbOriginal, type BreadcrumbsInfo as BreadcrumbsInfoOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkAddInfoSectionsToProductsApplicationErrors as BulkAddInfoSectionsToProductsApplicationErrorsOriginal, type BulkAddInfoSectionsToProductsByFilterApplicationErrors as BulkAddInfoSectionsToProductsByFilterApplicationErrorsOriginal, type BulkAddInfoSectionsToProductsByFilterRequest as BulkAddInfoSectionsToProductsByFilterRequestOriginal, type BulkAddInfoSectionsToProductsByFilterResponse as BulkAddInfoSectionsToProductsByFilterResponseOriginal, type BulkAddInfoSectionsToProductsRequest as BulkAddInfoSectionsToProductsRequestOriginal, type BulkAddInfoSectionsToProductsResponse as BulkAddInfoSectionsToProductsResponseOriginal, type BulkAddProductsToBatchRequest as BulkAddProductsToBatchRequestOriginal, type BulkAddProductsToBatchResponse as BulkAddProductsToBatchResponseOriginal, type BulkAddProductsToCategoriesByFilterRequest as BulkAddProductsToCategoriesByFilterRequestOriginal, type BulkAddProductsToCategoriesByFilterResponse as BulkAddProductsToCategoriesByFilterResponseOriginal, type BulkAdjustProductVariantsByFilterApplicationErrors as BulkAdjustProductVariantsByFilterApplicationErrorsOriginal, type BulkAdjustProductVariantsByFilterRequest as BulkAdjustProductVariantsByFilterRequestOriginal, BulkAdjustProductVariantsByFilterRequestRoundingStrategy as BulkAdjustProductVariantsByFilterRequestRoundingStrategyOriginal, type BulkAdjustProductVariantsByFilterRequestRoundingStrategyWithLiterals as BulkAdjustProductVariantsByFilterRequestRoundingStrategyWithLiteralsOriginal, type BulkAdjustProductVariantsByFilterResponse as BulkAdjustProductVariantsByFilterResponseOriginal, type BulkAdjustProductVariantsByFilterValidationErrors as BulkAdjustProductVariantsByFilterValidationErrorsOriginal, type BulkCreateProductsApplicationErrors as BulkCreateProductsApplicationErrorsOriginal, type BulkCreateProductsRequest as BulkCreateProductsRequestOriginal, type BulkCreateProductsResponse as BulkCreateProductsResponseOriginal, type BulkCreateProductsValidationErrors as BulkCreateProductsValidationErrorsOriginal, type BulkCreateProductsWithInventoryApplicationErrors as BulkCreateProductsWithInventoryApplicationErrorsOriginal, type BulkCreateProductsWithInventoryRequest as BulkCreateProductsWithInventoryRequestOriginal, type BulkCreateProductsWithInventoryResponse as BulkCreateProductsWithInventoryResponseOriginal, type BulkCreateProductsWithInventoryValidationErrors as BulkCreateProductsWithInventoryValidationErrorsOriginal, type BulkDeleteProductsByFilterRequest as BulkDeleteProductsByFilterRequestOriginal, type BulkDeleteProductsByFilterResponse as BulkDeleteProductsByFilterResponseOriginal, type BulkDeleteProductsRequest as BulkDeleteProductsRequestOriginal, type BulkDeleteProductsResponseBulkProductResult as BulkDeleteProductsResponseBulkProductResultOriginal, type BulkDeleteProductsResponse as BulkDeleteProductsResponseOriginal, type BulkDeleteProductsValidationErrors as BulkDeleteProductsValidationErrorsOriginal, type BulkInventoryItemAction as BulkInventoryItemActionOriginal, type BulkInventoryItemResult as BulkInventoryItemResultOriginal, type BulkInventoryItemResults as BulkInventoryItemResultsOriginal, type BulkItemResult as BulkItemResultOriginal, type BulkProductResult as BulkProductResultOriginal, type BulkProductResults as BulkProductResultsOriginal, type BulkRemoveInfoSectionsFromProductsByFilterRequest as BulkRemoveInfoSectionsFromProductsByFilterRequestOriginal, type BulkRemoveInfoSectionsFromProductsByFilterResponse as BulkRemoveInfoSectionsFromProductsByFilterResponseOriginal, type BulkRemoveInfoSectionsFromProductsRequest as BulkRemoveInfoSectionsFromProductsRequestOriginal, type BulkRemoveInfoSectionsFromProductsResponse as BulkRemoveInfoSectionsFromProductsResponseOriginal, type BulkRemoveProductsFromCategoriesByFilterRequest as BulkRemoveProductsFromCategoriesByFilterRequestOriginal, type BulkRemoveProductsFromCategoriesByFilterResponse as BulkRemoveProductsFromCategoriesByFilterResponseOriginal, type BulkUpdateProductVariantsByFilterApplicationErrors as BulkUpdateProductVariantsByFilterApplicationErrorsOriginal, type BulkUpdateProductVariantsByFilterRequest as BulkUpdateProductVariantsByFilterRequestOriginal, type BulkUpdateProductVariantsByFilterResponse as BulkUpdateProductVariantsByFilterResponseOriginal, type BulkUpdateProductVariantsByFilterValidationErrors as BulkUpdateProductVariantsByFilterValidationErrorsOriginal, type BulkUpdateProductsApplicationErrors as BulkUpdateProductsApplicationErrorsOriginal, type BulkUpdateProductsByFilterApplicationErrors as BulkUpdateProductsByFilterApplicationErrorsOriginal, type BulkUpdateProductsByFilterRequest as BulkUpdateProductsByFilterRequestOriginal, type BulkUpdateProductsByFilterResponse as BulkUpdateProductsByFilterResponseOriginal, type BulkUpdateProductsByFilterValidationErrors as BulkUpdateProductsByFilterValidationErrorsOriginal, type BulkUpdateProductsRequest as BulkUpdateProductsRequestOriginal, type BulkUpdateProductsResponse as BulkUpdateProductsResponseOriginal, type BulkUpdateProductsValidationErrors as BulkUpdateProductsValidationErrorsOriginal, type BulkUpdateProductsWithInventoryApplicationErrors as BulkUpdateProductsWithInventoryApplicationErrorsOriginal, type BulkUpdateProductsWithInventoryRequest as BulkUpdateProductsWithInventoryRequestOriginal, type BulkUpdateProductsWithInventoryResponse as BulkUpdateProductsWithInventoryResponseOriginal, type BulkUpdateProductsWithInventoryValidationErrors as BulkUpdateProductsWithInventoryValidationErrorsOriginal, type BulkUpdateVariantsByFilterRequest as BulkUpdateVariantsByFilterRequestOriginal, type BulkUpdateVariantsByFilterResponse as BulkUpdateVariantsByFilterResponseOriginal, type BulletedListData as BulletedListDataOriginal, type ButtonData as ButtonDataOriginal, ButtonDataType as ButtonDataTypeOriginal, type ButtonDataTypeWithLiterals as ButtonDataTypeWithLiteralsOriginal, type ButtonStyles as ButtonStylesOriginal, type CalculateProductInventorPreorderStatusAsyncRequest as CalculateProductInventorPreorderStatusAsyncRequestOriginal, type CalculateProductInventorPreorderStatusAsyncResponse as CalculateProductInventorPreorderStatusAsyncResponseOriginal, type CaptionData as CaptionDataOriginal, type CardStyles as CardStylesOriginal, type CatalogV3BulkProductResult as CatalogV3BulkProductResultOriginal, type CellStyle as CellStyleOriginal, ChoiceType as ChoiceTypeOriginal, type ChoiceTypeWithLiterals as ChoiceTypeWithLiteralsOriginal, type ChoicesSettings as ChoicesSettingsOriginal, type CodeBlockData as CodeBlockDataOriginal, type CollapsibleListData as CollapsibleListDataOriginal, type ColorData as ColorDataOriginal, type Colors as ColorsOriginal, type CommonAggregationData as CommonAggregationDataOriginal, type CommonAggregationDateHistogramAggregation as CommonAggregationDateHistogramAggregationOriginal, type CommonAggregationKindOneOf as CommonAggregationKindOneOfOriginal, type CommonAggregationNestedAggregation as CommonAggregationNestedAggregationOriginal, type CommonAggregation as CommonAggregationOriginal, type CommonAggregationRangeAggregation as CommonAggregationRangeAggregationOriginal, type CommonAggregationScalarAggregation as CommonAggregationScalarAggregationOriginal, CommonAggregationType as CommonAggregationTypeOriginal, type CommonAggregationTypeWithLiterals as CommonAggregationTypeWithLiteralsOriginal, type CommonAggregationValueAggregationOptionsOneOf as CommonAggregationValueAggregationOptionsOneOfOriginal, type CommonAggregationValueAggregation as CommonAggregationValueAggregationOriginal, type CommonBulkActionMetadata as CommonBulkActionMetadataOriginal, type CommonCursorPagingMetadata as CommonCursorPagingMetadataOriginal, type CommonCursorPaging as CommonCursorPagingOriginal, type CommonCursorQuery as CommonCursorQueryOriginal, type CommonCursorQueryPagingMethodOneOf as CommonCursorQueryPagingMethodOneOfOriginal, type CommonCursorSearch as CommonCursorSearchOriginal, type CommonCursorSearchPagingMethodOneOf as CommonCursorSearchPagingMethodOneOfOriginal, type CommonCursors as CommonCursorsOriginal, type CommonItemMetadata as CommonItemMetadataOriginal, CommonScalarType as CommonScalarTypeOriginal, type CommonScalarTypeWithLiterals as CommonScalarTypeWithLiteralsOriginal, CommonSearchDetailsMode as CommonSearchDetailsModeOriginal, type CommonSearchDetailsModeWithLiterals as CommonSearchDetailsModeWithLiteralsOriginal, type CommonSearchDetails as CommonSearchDetailsOriginal, CommonSortOrder as CommonSortOrderOriginal, type CommonSortOrderWithLiterals as CommonSortOrderWithLiteralsOriginal, type CommonSorting as CommonSortingOriginal, type ConnectedModifierChoice as ConnectedModifierChoiceOriginal, type ConnectedModifierChoiceValueOneOf as ConnectedModifierChoiceValueOneOfOriginal, type ConnectedModifierModifierSettingsOneOf as ConnectedModifierModifierSettingsOneOfOriginal, type ConnectedModifier as ConnectedModifierOriginal, type ConnectedOptionChoice as ConnectedOptionChoiceOriginal, type ConnectedOptionChoiceValueOneOf as ConnectedOptionChoiceValueOneOfOriginal, type ConnectedOptionOptionSettingsOneOf as ConnectedOptionOptionSettingsOneOfOriginal, type ConnectedOption as ConnectedOptionOriginal, type CountProductsApplicationErrors as CountProductsApplicationErrorsOriginal, type CountProductsRequest as CountProductsRequestOriginal, type CountProductsResponse as CountProductsResponseOriginal, type CreateBatchRequest as CreateBatchRequestOriginal, type CreateBatchResponse as CreateBatchResponseOriginal, type CreateProductApplicationErrors as CreateProductApplicationErrorsOriginal, type CreateProductRequest as CreateProductRequestOriginal, type CreateProductResponse as CreateProductResponseOriginal, type CreateProductValidationErrors as CreateProductValidationErrorsOriginal, type CreateProductWithInventoryApplicationErrors as CreateProductWithInventoryApplicationErrorsOriginal, type CreateProductWithInventoryRequest as CreateProductWithInventoryRequestOriginal, type CreateProductWithInventoryResponse as CreateProductWithInventoryResponseOriginal, type CreateProductWithInventoryValidationErrors as CreateProductWithInventoryValidationErrorsOriginal, Crop as CropOriginal, type CropWithLiterals as CropWithLiteralsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomTag as CustomTagOriginal, DateHistogramAggregationInterval as DateHistogramAggregationIntervalOriginal, type DateHistogramAggregationIntervalWithLiterals as DateHistogramAggregationIntervalWithLiteralsOriginal, type DateHistogramAggregation as DateHistogramAggregationOriginal, type DateHistogramResult as DateHistogramResultOriginal, type DateHistogramResultsDateHistogramResult as DateHistogramResultsDateHistogramResultOriginal, type DateHistogramResults as DateHistogramResultsOriginal, type DecorationDataOneOf as DecorationDataOneOfOriginal, type Decoration as DecorationOriginal, DecorationType as DecorationTypeOriginal, type DecorationTypeWithLiterals as DecorationTypeWithLiteralsOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteProductRequest as DeleteProductRequestOriginal, type DeleteProductResponse as DeleteProductResponseOriginal, type DeprecatedSearchProductsWithOffsetRequest as DeprecatedSearchProductsWithOffsetRequestOriginal, type DeprecatedSearchProductsWithOffsetResponse as DeprecatedSearchProductsWithOffsetResponseOriginal, type Design as DesignOriginal, type Dimensions as DimensionsOriginal, Direction as DirectionOriginal, type DirectionWithLiterals as DirectionWithLiteralsOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, DividerDataAlignment as DividerDataAlignmentOriginal, type DividerDataAlignmentWithLiterals as DividerDataAlignmentWithLiteralsOriginal, type DividerData as DividerDataOriginal, type DoNotCallBulkCreateProductsRequest as DoNotCallBulkCreateProductsRequestOriginal, type DoNotCallBulkCreateProductsResponse as DoNotCallBulkCreateProductsResponseOriginal, type DoNotCallBulkUpdateProductsRequest as DoNotCallBulkUpdateProductsRequestOriginal, type DoNotCallBulkUpdateProductsResponse as DoNotCallBulkUpdateProductsResponseOriginal, type DoNotCallCreateProductRequest as DoNotCallCreateProductRequestOriginal, type DoNotCallCreateProductResponse as DoNotCallCreateProductResponseOriginal, type DoNotCallUpdateProductRequest as DoNotCallUpdateProductRequestOriginal, type DoNotCallUpdateProductResponse as DoNotCallUpdateProductResponseOriginal, type DocumentImage as DocumentImageOriginal, type DocumentPayload as DocumentPayloadOriginal, type DocumentStyle as DocumentStyleOriginal, type DocumentUpdateOperation as DocumentUpdateOperationOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DuplicateMediaIdAssignedToProduct as DuplicateMediaIdAssignedToProductOriginal, type EmbedData as EmbedDataOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, Enum as EnumOriginal, type EnumWithLiterals as EnumWithLiteralsOriginal, type EventData as EventDataOriginal, EventType as EventTypeOriginal, type EventTypeWithLiterals as EventTypeWithLiteralsOriginal, type EventuallyConsistentQueryProductsRequest as EventuallyConsistentQueryProductsRequestOriginal, type EventuallyConsistentQueryProductsResponse as EventuallyConsistentQueryProductsResponseOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FileData as FileDataOriginal, type File as FileOriginal, type FileSourceDataOneOf as FileSourceDataOneOfOriginal, type FileSource as FileSourceOriginal, FileType as FileTypeOriginal, type FileTypeWithLiterals as FileTypeWithLiteralsOriginal, type FixedMonetaryAmount as FixedMonetaryAmountOriginal, type FontSizeData as FontSizeDataOriginal, FontType as FontTypeOriginal, type FontTypeWithLiterals as FontTypeWithLiteralsOriginal, type FreeTextSettings as FreeTextSettingsOriginal, type FulfillerDeleted as FulfillerDeletedOriginal, type GIFData as GIFDataOriginal, type GIF as GIFOriginal, GIFType as GIFTypeOriginal, type GIFTypeWithLiterals as GIFTypeWithLiteralsOriginal, type GalleryData as GalleryDataOriginal, type GalleryOptionsLayout as GalleryOptionsLayoutOriginal, type GalleryOptions as GalleryOptionsOriginal, type GetAllProductsCategoryRequest as GetAllProductsCategoryRequestOriginal, type GetAllProductsCategoryResponse as GetAllProductsCategoryResponseOriginal, type GetProductApplicationErrors as GetProductApplicationErrorsOriginal, type GetProductBySlugApplicationErrors as GetProductBySlugApplicationErrorsOriginal, type GetProductBySlugRequest as GetProductBySlugRequestOriginal, type GetProductBySlugResponse as GetProductBySlugResponseOriginal, type GetProductRequest as GetProductRequestOriginal, type GetProductResponse as GetProductResponseOriginal, type Gradient as GradientOriginal, type GroupByAggregationKindOneOf as GroupByAggregationKindOneOfOriginal, type GroupByAggregation as GroupByAggregationOriginal, type GroupByValueResultsNestedValueAggregationResult as GroupByValueResultsNestedValueAggregationResultOriginal, type GroupByValueResults as GroupByValueResultsOriginal, type HTMLDataDataOneOf as HTMLDataDataOneOfOriginal, type HTMLData as HTMLDataOriginal, type HeadingData as HeadingDataOriginal, type Height as HeightOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ImageData as ImageDataOriginal, type ImageDataStyles as ImageDataStylesOriginal, type Image as ImageOriginal, type ImageStyles as ImageStylesOriginal, type IncludeMissingValuesOptions as IncludeMissingValuesOptionsOriginal, type IndexDocument as IndexDocumentOriginal, type InfoSection as InfoSectionOriginal, InitialExpandedItems as InitialExpandedItemsOriginal, type InitialExpandedItemsWithLiterals as InitialExpandedItemsWithLiteralsOriginal, Interval as IntervalOriginal, type IntervalWithLiterals as IntervalWithLiteralsOriginal, type InvalidDigitalFileIds as InvalidDigitalFileIdsOriginal, type InvalidateCacheGetByOneOf as InvalidateCacheGetByOneOfOriginal, type InvalidateCache as InvalidateCacheOriginal, InventoryAvailabilityStatus as InventoryAvailabilityStatusOriginal, type InventoryAvailabilityStatusWithLiterals as InventoryAvailabilityStatusWithLiteralsOriginal, type InventoryItemComposite as InventoryItemCompositeOriginal, type InventoryItemCompositeTrackingMethodOneOf as InventoryItemCompositeTrackingMethodOneOfOriginal, type InventoryItem as InventoryItemOriginal, type InventoryItemTrackingMethodOneOf as InventoryItemTrackingMethodOneOfOriginal, type Inventory as InventoryOriginal, type InventoryStatus as InventoryStatusOriginal, type ItemDataOneOf as ItemDataOneOfOriginal, type ItemImage as ItemImageOriginal, type ItemMetadata as ItemMetadataOriginal, type Item as ItemOriginal, type ItemStyle as ItemStyleOriginal, type Keyword as KeywordOriginal, type LayoutCellData as LayoutCellDataOriginal, Layout as LayoutOriginal, LayoutType as LayoutTypeOriginal, type LayoutTypeWithLiterals as LayoutTypeWithLiteralsOriginal, type LayoutWithLiterals as LayoutWithLiteralsOriginal, LineStyle as LineStyleOriginal, type LineStyleWithLiterals as LineStyleWithLiteralsOriginal, type LinkDataOneOf as LinkDataOneOfOriginal, type LinkData as LinkDataOriginal, type Link as LinkOriginal, type LinkPreviewData as LinkPreviewDataOriginal, type LinkPreviewDataStyles as LinkPreviewDataStylesOriginal, type ListValue as ListValueOriginal, type MapData as MapDataOriginal, type MapSettings as MapSettingsOriginal, MapType as MapTypeOriginal, type MapTypeWithLiterals as MapTypeWithLiteralsOriginal, type MaskedProduct as MaskedProductOriginal, type MaskedProductWithInventory as MaskedProductWithInventoryOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MediaItemsInfo as MediaItemsInfoOriginal, type Media as MediaOriginal, MediaType as MediaTypeOriginal, type MediaTypeWithLiterals as MediaTypeWithLiteralsOriginal, type MentionData as MentionDataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Metadata as MetadataOriginal, type MinVariantPriceInfo as MinVariantPriceInfoOriginal, MissingValues as MissingValuesOriginal, type MissingValuesWithLiterals as MissingValuesWithLiteralsOriginal, Mode as ModeOriginal, type ModeWithLiterals as ModeWithLiteralsOriginal, type ModifierChoicesSettings as ModifierChoicesSettingsOriginal, ModifierRenderType as ModifierRenderTypeOriginal, type ModifierRenderTypeWithLiterals as ModifierRenderTypeWithLiteralsOriginal, type MultipleColors as MultipleColorsOriginal, type NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOfOriginal, type NestedAggregationItem as NestedAggregationItemOriginal, type NestedAggregationNestedAggregationItemKindOneOf as NestedAggregationNestedAggregationItemKindOneOfOriginal, type NestedAggregationNestedAggregationItem as NestedAggregationNestedAggregationItemOriginal, NestedAggregationNestedAggregationType as NestedAggregationNestedAggregationTypeOriginal, type NestedAggregationNestedAggregationTypeWithLiterals as NestedAggregationNestedAggregationTypeWithLiteralsOriginal, type NestedAggregation as NestedAggregationOriginal, type NestedAggregationResults as NestedAggregationResultsOriginal, type NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOfOriginal, NestedAggregationType as NestedAggregationTypeOriginal, type NestedAggregationTypeWithLiterals as NestedAggregationTypeWithLiteralsOriginal, type NestedResultValue as NestedResultValueOriginal, type NestedResultValueResultOneOf as NestedResultValueResultOneOfOriginal, type NestedResultsNestedResultValue as NestedResultsNestedResultValueOriginal, type NestedResultsNestedResultValueResultOneOf as NestedResultsNestedResultValueResultOneOfOriginal, type NestedResults as NestedResultsOriginal, type NestedResultsRangeResult as NestedResultsRangeResultOriginal, type NestedResultsResults as NestedResultsResultsOriginal, type NestedResultsScalarResult as NestedResultsScalarResultOriginal, type NestedResultsValueResult as NestedResultsValueResultOriginal, type NestedValueAggregationResult as NestedValueAggregationResultOriginal, type NodeDataOneOf as NodeDataOneOfOriginal, type Node as NodeOriginal, type NodeStyle as NodeStyleOriginal, NodeType as NodeTypeOriginal, type NodeTypeWithLiterals as NodeTypeWithLiteralsOriginal, NullValue as NullValueOriginal, type NullValueWithLiterals as NullValueWithLiteralsOriginal, type Oembed as OembedOriginal, type OptionChoiceIds as OptionChoiceIdsOriginal, type OptionChoiceNames as OptionChoiceNamesOriginal, type OptionChoice as OptionChoiceOriginal, type OptionChoiceReferences as OptionChoiceReferencesOriginal, type OptionDesign as OptionDesignOriginal, type OptionLayout as OptionLayoutOriginal, type Option as OptionOriginal, type OrderedListData as OrderedListDataOriginal, Orientation as OrientationOriginal, type OrientationWithLiterals as OrientationWithLiteralsOriginal, type PDFSettings as PDFSettingsOriginal, type Page as PageOriginal, type PageUrlV2 as PageUrlV2Original, type PagingMetadata as PagingMetadataOriginal, type ParagraphData as ParagraphDataOriginal, type Permissions as PermissionsOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlatformOffsetSearch as PlatformOffsetSearchOriginal, type PlatformOffsetSearchPagingMethodOneOf as PlatformOffsetSearchPagingMethodOneOfOriginal, type PlatformPaging as PlatformPagingOriginal, type PlaybackOptions as PlaybackOptionsOriginal, PluginContainerDataAlignment as PluginContainerDataAlignmentOriginal, type PluginContainerDataAlignmentWithLiterals as PluginContainerDataAlignmentWithLiteralsOriginal, type PluginContainerData as PluginContainerDataOriginal, type PluginContainerDataWidthDataOneOf as PluginContainerDataWidthDataOneOfOriginal, type PluginContainerDataWidth as PluginContainerDataWidthOriginal, type PollDataLayout as PollDataLayoutOriginal, type PollData as PollDataOriginal, type PollDesign as PollDesignOriginal, PollLayoutDirection as PollLayoutDirectionOriginal, type PollLayoutDirectionWithLiterals as PollLayoutDirectionWithLiteralsOriginal, type PollLayout as PollLayoutOriginal, PollLayoutType as PollLayoutTypeOriginal, type PollLayoutTypeWithLiterals as PollLayoutTypeWithLiteralsOriginal, type Poll as PollOriginal, type PollSettings as PollSettingsOriginal, Position as PositionOriginal, type PositionWithLiterals as PositionWithLiteralsOriginal, type PreorderInfo as PreorderInfoOriginal, PreorderStatus as PreorderStatusOriginal, type PreorderStatusWithLiterals as PreorderStatusWithLiteralsOriginal, type PriceInfo as PriceInfoOriginal, type PricePerUnit as PricePerUnitOriginal, type PricePerUnitRange as PricePerUnitRangeOriginal, type PricePerUnitRangePricePerUnit as PricePerUnitRangePricePerUnitOriginal, type PricePerUnitSettings as PricePerUnitSettingsOriginal, type PriceRange as PriceRangeOriginal, type PricingData as PricingDataOriginal, type ProductCategoriesInfo as ProductCategoriesInfoOriginal, type ProductCategoryIdsInfo as ProductCategoryIdsInfoOriginal, type ProductCategory as ProductCategoryOriginal, type ProductIdWithRevision as ProductIdWithRevisionOriginal, type ProductItem as ProductItemOriginal, type ProductMediaMediaOneOf as ProductMediaMediaOneOfOriginal, type ProductMedia as ProductMediaOriginal, type ProductMediaSetByOneOf as ProductMediaSetByOneOfOriginal, ProductOptionRenderType as ProductOptionRenderTypeOriginal, type ProductOptionRenderTypeWithLiterals as ProductOptionRenderTypeWithLiteralsOriginal, type Product as ProductOriginal, ProductPreorderAvailability as ProductPreorderAvailabilityOriginal, type ProductPreorderAvailabilityWithLiterals as ProductPreorderAvailabilityWithLiteralsOriginal, ProductType as ProductTypeOriginal, type ProductTypeWithLiterals as ProductTypeWithLiteralsOriginal, type ProductVariantIds as ProductVariantIdsOriginal, type ProductVariants as ProductVariantsOriginal, type ProductWithInventory as ProductWithInventoryOriginal, type ProductWithInventoryTypedPropertiesOneOf as ProductWithInventoryTypedPropertiesOneOfOriginal, type QueryProductsApplicationErrors as QueryProductsApplicationErrorsOriginal, type QueryProductsRequest as QueryProductsRequestOriginal, type QueryProductsResponse as QueryProductsResponseOriginal, type RangeAggregation as RangeAggregationOriginal, type RangeAggregationRangeBucket as RangeAggregationRangeBucketOriginal, type RangeAggregationResult as RangeAggregationResultOriginal, type RangeBucket as RangeBucketOriginal, type RangeResult as RangeResultOriginal, type RangeResults as RangeResultsOriginal, type RangeResultsRangeAggregationResult as RangeResultsRangeAggregationResultOriginal, type Rel as RelOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, Resizing as ResizingOriginal, type ResizingWithLiterals as ResizingWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type Results as ResultsOriginal, type RetrieveVariantsRequest as RetrieveVariantsRequestOriginal, type RetrieveVariantsResponse as RetrieveVariantsResponseOriginal, type RevenueDetails as RevenueDetailsOriginal, type Ribbon as RibbonOriginal, type RibbonStyles as RibbonStylesOriginal, type RichContent as RichContentOriginal, RoundingStrategy as RoundingStrategyOriginal, type RoundingStrategyWithLiterals as RoundingStrategyWithLiteralsOriginal, type ScalarAggregation as ScalarAggregationOriginal, type ScalarResult as ScalarResultOriginal, ScalarType as ScalarTypeOriginal, type ScalarTypeWithLiterals as ScalarTypeWithLiteralsOriginal, SearchDetailsMode as SearchDetailsModeOriginal, type SearchDetailsModeWithLiterals as SearchDetailsModeWithLiteralsOriginal, type SearchDetails as SearchDetailsOriginal, type SearchIndexingNotification as SearchIndexingNotificationOriginal, type SearchProductsApplicationErrors as SearchProductsApplicationErrorsOriginal, type SearchProductsRequest as SearchProductsRequestOriginal, type SearchProductsResponse as SearchProductsResponseOriginal, type SearchRelatedDetails as SearchRelatedDetailsOriginal, type SearchRelated as SearchRelatedOriginal, type SearchRelatedProductsRequest as SearchRelatedProductsRequestOriginal, type SearchRelatedProductsResponse as SearchRelatedProductsResponseOriginal, type SecuredMedia as SecuredMediaOriginal, type SeoSchema as SeoSchemaOriginal, type Settings as SettingsOriginal, SingleEntityOpsRequestedFields as SingleEntityOpsRequestedFieldsOriginal, type SingleEntityOpsRequestedFieldsWithLiterals as SingleEntityOpsRequestedFieldsWithLiteralsOriginal, SortDirection as SortDirectionOriginal, type SortDirectionWithLiterals as SortDirectionWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, SortType as SortTypeOriginal, type SortTypeWithLiterals as SortTypeWithLiteralsOriginal, type Sorting as SortingOriginal, Source as SourceOriginal, type SourceWithLiterals as SourceWithLiteralsOriginal, type SpoilerData as SpoilerDataOriginal, type Spoiler as SpoilerOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StylesBorder as StylesBorderOriginal, type Styles as StylesOriginal, StylesPosition as StylesPositionOriginal, type StylesPositionWithLiterals as StylesPositionWithLiteralsOriginal, type SubmitBatchRequest as SubmitBatchRequestOriginal, type SubmitBatchResponse as SubmitBatchResponseOriginal, type SubscriptionCyclesOneOf as SubscriptionCyclesOneOfOriginal, type SubscriptionDetails as SubscriptionDetailsOriginal, type SubscriptionDiscountDiscountOneOf as SubscriptionDiscountDiscountOneOfOriginal, type SubscriptionDiscount as SubscriptionDiscountOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type Subscription as SubscriptionOriginal, type SubscriptionPrice as SubscriptionPriceOriginal, type SubscriptionPricePerUnit as SubscriptionPricePerUnitOriginal, type SubscriptionPricesInfo as SubscriptionPricesInfoOriginal, type TableCellData as TableCellDataOriginal, type TableData as TableDataOriginal, type Tag as TagOriginal, Target as TargetOriginal, type TargetWithLiterals as TargetWithLiteralsOriginal, TextAlignment as TextAlignmentOriginal, type TextAlignmentWithLiterals as TextAlignmentWithLiteralsOriginal, type TextData as TextDataOriginal, type TextNodeStyle as TextNodeStyleOriginal, type TextStyle as TextStyleOriginal, type Thumbnail as ThumbnailOriginal, ThumbnailsAlignment as ThumbnailsAlignmentOriginal, type ThumbnailsAlignmentWithLiterals as ThumbnailsAlignmentWithLiteralsOriginal, type Thumbnails as ThumbnailsOriginal, type TreeReference as TreeReferenceOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type URI as URIOriginal, type UnsignedAdjustValueAdjustValueOneOf as UnsignedAdjustValueAdjustValueOneOfOriginal, type UnsignedAdjustValue as UnsignedAdjustValueOriginal, type UnsupportedFieldMasks as UnsupportedFieldMasksOriginal, type UpdateByFilterOperation as UpdateByFilterOperationOriginal, type UpdateDocumentsEventOperationOneOf as UpdateDocumentsEventOperationOneOfOriginal, type UpdateDocumentsEvent as UpdateDocumentsEventOriginal, type UpdateExistingOperation as UpdateExistingOperationOriginal, type UpdateProductApplicationErrors as UpdateProductApplicationErrorsOriginal, type UpdateProductRequest as UpdateProductRequestOriginal, type UpdateProductResponse as UpdateProductResponseOriginal, type UpdateProductValidationErrors as UpdateProductValidationErrorsOriginal, type UpdateProductWithInventoryApplicationErrors as UpdateProductWithInventoryApplicationErrorsOriginal, type UpdateProductWithInventoryRequest as UpdateProductWithInventoryRequestOriginal, type UpdateProductWithInventoryResponse as UpdateProductWithInventoryResponseOriginal, type UpdateProductWithInventoryValidationErrors as UpdateProductWithInventoryValidationErrorsOriginal, type UpstreamWixCommonItemMetadata as UpstreamWixCommonItemMetadataOriginal, type V1Media as V1MediaOriginal, type V3AdjustValueAdjustValueOneOf as V3AdjustValueAdjustValueOneOfOriginal, type V3AdjustValue as V3AdjustValueOriginal, type V3BulkAddInfoSectionsToProductsByFilterRequest as V3BulkAddInfoSectionsToProductsByFilterRequestOriginal, type V3BulkAddInfoSectionsToProductsByFilterResponse as V3BulkAddInfoSectionsToProductsByFilterResponseOriginal, type V3BulkAddInfoSectionsToProductsRequest as V3BulkAddInfoSectionsToProductsRequestOriginal, type V3BulkAddInfoSectionsToProductsResponse as V3BulkAddInfoSectionsToProductsResponseOriginal, type V3BulkAdjustProductVariantsByFilterRequest as V3BulkAdjustProductVariantsByFilterRequestOriginal, type V3BulkAdjustProductVariantsByFilterResponse as V3BulkAdjustProductVariantsByFilterResponseOriginal, type V3BulkDeleteProductsByFilterRequest as V3BulkDeleteProductsByFilterRequestOriginal, type V3BulkDeleteProductsByFilterResponse as V3BulkDeleteProductsByFilterResponseOriginal, type V3BulkDeleteProductsRequest as V3BulkDeleteProductsRequestOriginal, type V3BulkDeleteProductsResponse as V3BulkDeleteProductsResponseOriginal, type V3BulkProductResult as V3BulkProductResultOriginal, type V3BulkRemoveInfoSectionsFromProductsByFilterRequest as V3BulkRemoveInfoSectionsFromProductsByFilterRequestOriginal, type V3BulkRemoveInfoSectionsFromProductsByFilterResponse as V3BulkRemoveInfoSectionsFromProductsByFilterResponseOriginal, type V3BulkRemoveInfoSectionsFromProductsRequest as V3BulkRemoveInfoSectionsFromProductsRequestOriginal, type V3BulkRemoveInfoSectionsFromProductsResponse as V3BulkRemoveInfoSectionsFromProductsResponseOriginal, type V3BulkUpdateProductsByFilterRequest as V3BulkUpdateProductsByFilterRequestOriginal, type V3BulkUpdateProductsByFilterResponse as V3BulkUpdateProductsByFilterResponseOriginal, type V3CountProductsRequest as V3CountProductsRequestOriginal, type V3CountProductsResponse as V3CountProductsResponseOriginal, type V3DeleteProductRequest as V3DeleteProductRequestOriginal, type V3DeleteProductResponse as V3DeleteProductResponseOriginal, type V3GetProductBySlugRequest as V3GetProductBySlugRequestOriginal, type V3GetProductBySlugResponse as V3GetProductBySlugResponseOriginal, type V3GetProductRequest as V3GetProductRequestOriginal, type V3GetProductResponse as V3GetProductResponseOriginal, type V3MaskedProduct as V3MaskedProductOriginal, type V3OptionChoiceIds as V3OptionChoiceIdsOriginal, type V3OptionChoiceNames as V3OptionChoiceNamesOriginal, type V3ProductCategoryIdsInfo as V3ProductCategoryIdsInfoOriginal, type V3ProductIdWithRevision as V3ProductIdWithRevisionOriginal, type V3Product as V3ProductOriginal, type V3ProductTypedPropertiesOneOf as V3ProductTypedPropertiesOneOfOriginal, type V3QueryProductsRequest as V3QueryProductsRequestOriginal, type V3QueryProductsResponse as V3QueryProductsResponseOriginal, type V3SearchProductsRequest as V3SearchProductsRequestOriginal, type V3SearchProductsResponse as V3SearchProductsResponseOriginal, type V3UnsignedAdjustValueAdjustValueOneOf as V3UnsignedAdjustValueAdjustValueOneOfOriginal, type V3UnsignedAdjustValue as V3UnsignedAdjustValueOriginal, type V3VariantsInfo as V3VariantsInfoOriginal, type ValueAggregationIncludeMissingValuesOptions as ValueAggregationIncludeMissingValuesOptionsOriginal, ValueAggregationMissingValues as ValueAggregationMissingValuesOriginal, type ValueAggregationMissingValuesWithLiterals as ValueAggregationMissingValuesWithLiteralsOriginal, type ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOfOriginal, type ValueAggregation as ValueAggregationOriginal, type ValueAggregationResult as ValueAggregationResultOriginal, ValueAggregationSortDirection as ValueAggregationSortDirectionOriginal, type ValueAggregationSortDirectionWithLiterals as ValueAggregationSortDirectionWithLiteralsOriginal, ValueAggregationSortType as ValueAggregationSortTypeOriginal, type ValueAggregationSortTypeWithLiterals as ValueAggregationSortTypeWithLiteralsOriginal, type ValueResult as ValueResultOriginal, type ValueResults as ValueResultsOriginal, type ValueResultsValueAggregationResult as ValueResultsValueAggregationResultOriginal, type VariantDigitalProperties as VariantDigitalPropertiesOriginal, type VariantNotAlignedWithProduct as VariantNotAlignedWithProductOriginal, type Variant as VariantOriginal, type VariantPhysicalProperties as VariantPhysicalPropertiesOriginal, type VariantSummary as VariantSummaryOriginal, type VariantTypedPropertiesOneOf as VariantTypedPropertiesOneOfOriginal, type VariantWithInventory as VariantWithInventoryOriginal, type VariantWithInventoryTypedPropertiesOneOf as VariantWithInventoryTypedPropertiesOneOfOriginal, type VariantsCursorPaging as VariantsCursorPagingOriginal, type VariantsInfo as VariantsInfoOriginal, type VariantsNotAlignedWithProduct as VariantsNotAlignedWithProductOriginal, VariantsOpsRequestedFields as VariantsOpsRequestedFieldsOriginal, type VariantsOpsRequestedFieldsWithLiterals as VariantsOpsRequestedFieldsWithLiteralsOriginal, type VariantsRemoved as VariantsRemovedOriginal, VerticalAlignment as VerticalAlignmentOriginal, type VerticalAlignmentWithLiterals as VerticalAlignmentWithLiteralsOriginal, type VideoData as VideoDataOriginal, type Video as VideoOriginal, type VideoResolution as VideoResolutionOriginal, type VideoV2 as VideoV2Original, ViewMode as ViewModeOriginal, type ViewModeWithLiterals as ViewModeWithLiteralsOriginal, ViewRole as ViewRoleOriginal, type ViewRoleWithLiterals as ViewRoleWithLiteralsOriginal, VoteRole as VoteRoleOriginal, type VoteRoleWithLiterals as VoteRoleWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WeightMeasurementUnitInfo as WeightMeasurementUnitInfoOriginal, type WeightRange as WeightRangeOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, Width as WidthOriginal, WidthType as WidthTypeOriginal, type WidthTypeWithLiterals as WidthTypeWithLiteralsOriginal, type WidthWithLiterals as WidthWithLiteralsOriginal, type WixCommonAggregationKindOneOf as WixCommonAggregationKindOneOfOriginal, type WixCommonAggregation as WixCommonAggregationOriginal, WixCommonAggregationType as WixCommonAggregationTypeOriginal, type WixCommonAggregationTypeWithLiterals as WixCommonAggregationTypeWithLiteralsOriginal, type WixCommonBulkActionMetadata as WixCommonBulkActionMetadataOriginal, type WixCommonItemMetadata as WixCommonItemMetadataOriginal, WixCommonScalarType as WixCommonScalarTypeOriginal, type WixCommonScalarTypeWithLiterals as WixCommonScalarTypeWithLiteralsOriginal, type WixCommonSearchDetails as WixCommonSearchDetailsOriginal, WixCommonSortOrder as WixCommonSortOrderOriginal, type WixCommonSortOrderWithLiterals as WixCommonSortOrderWithLiteralsOriginal, type WixCommonSorting as WixCommonSortingOriginal, type __PublicMethodMetaInfo, bulkAddInfoSectionsToProducts, bulkAddInfoSectionsToProductsByFilter, bulkAddProductsToCategoriesByFilter, bulkAdjustProductVariantsByFilter, bulkCreateProducts, bulkCreateProductsWithInventory, bulkDeleteProducts, bulkDeleteProductsByFilter, bulkRemoveInfoSectionsFromProducts, bulkRemoveInfoSectionsFromProductsByFilter, bulkRemoveProductsFromCategoriesByFilter, bulkUpdateProductVariantsByFilter, bulkUpdateProducts, bulkUpdateProductsByFilter, bulkUpdateProductsWithInventory, countProducts, createProduct, createProductWithInventory, deleteProduct, getAllProductsCategory, getProduct, getProductBySlug, queryProducts, searchProducts, updateProduct, updateProductWithInventory };