@wix/auto_sdk_stores_products-v-3 1.0.46 → 1.0.47
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/cjs/index.d.ts +62 -41
- package/build/cjs/index.js.map +1 -1
- package/build/es/index.d.mts +62 -41
- package/build/es/index.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +62 -41
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/es/index.d.mts +62 -41
- package/build/internal/es/index.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/index.d.ts
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
|
-
import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
1
|
+
import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
|
|
2
2
|
import { V as V3Product, C as CreateProductOptions, a as CreateProductApplicationErrors, b as CreateProductValidationErrors, P as ProductWithInventory, c as CreateProductWithInventoryOptions, d as CreateProductWithInventoryResponse, U as UpdateProduct, e as UpdateProductOptions, f as UpdateProductApplicationErrors, g as UpdateProductValidationErrors, h as UpdateProductWithInventoryProduct, i as UpdateProductWithInventoryOptions, j as UpdateProductWithInventoryResponse, B as BulkCreateProductsOptions, k as BulkCreateProductsResponse, l as BulkCreateProductsApplicationErrors, m as BulkCreateProductsValidationErrors, n as BulkCreateProductsWithInventoryOptions, o as BulkCreateProductsWithInventoryResponse, p as V3MaskedProduct, q as BulkUpdateProductsOptions, r as BulkUpdateProductsResponse, s as BulkUpdateProductsApplicationErrors, t as BulkUpdateProductsValidationErrors, M as MaskedProductWithInventory, u as BulkUpdateProductsWithInventoryOptions, v as BulkUpdateProductsWithInventoryResponse, w as BulkUpdateProductsByFilterOptions, x as V3BulkUpdateProductsByFilterResponse, y as BulkUpdateProductsByFilterApplicationErrors, z as BulkUpdateProductsByFilterValidationErrors, A as V3BulkDeleteProductsResponse, D as BulkDeleteProductsByFilterOptions, E as V3BulkDeleteProductsByFilterResponse, G as GetProductOptions, F as GetProductBySlugOptions, H as V3GetProductBySlugResponse, I as V3ProductSearch, S as SearchProductsOptions, J as V3SearchProductsResponse, Q as QueryProductsOptions, K as ProductsQueryBuilder, L as CountProductsOptions, N as V3CountProductsResponse, O as BulkUpdateProductVariantsByFilterOptions, R as BulkUpdateProductVariantsByFilterResponse, T as BulkUpdateProductVariantsByFilterApplicationErrors, W as BulkUpdateProductVariantsByFilterValidationErrors, X as BulkAdjustProductVariantsByFilterOptions, Y as V3BulkAdjustProductVariantsByFilterResponse, Z as BulkAdjustProductVariantsByFilterApplicationErrors, _ as BulkAddInfoSectionsToProductsByFilterOptions, $ as V3BulkAddInfoSectionsToProductsByFilterResponse, a0 as BulkAddInfoSectionsToProductsByFilterApplicationErrors, a1 as V3ProductIdWithRevision, a2 as BulkAddInfoSectionsToProductsOptions, a3 as V3BulkAddInfoSectionsToProductsResponse, a4 as BulkAddInfoSectionsToProductsApplicationErrors, a5 as BulkRemoveInfoSectionsFromProductsByFilterOptions, a6 as V3BulkRemoveInfoSectionsFromProductsByFilterResponse, a7 as BulkRemoveInfoSectionsFromProductsOptions, a8 as V3BulkRemoveInfoSectionsFromProductsResponse, a9 as BulkAddProductsToCategoriesByFilterOptions, aa as BulkAddProductsToCategoriesByFilterResponse, ab as BulkRemoveProductsFromCategoriesByFilterOptions, ac as BulkRemoveProductsFromCategoriesByFilterResponse, ad as GetAllProductsCategoryResponse, ae as ProductCreatedEnvelope, af as ProductDeletedEnvelope, ag as ProductUpdatedEnvelope } from './stores-catalog-v3-product-products-v-3.universal-BxxKSsqd.js';
|
|
3
3
|
export { eg as ActionEvent, go as AdjustValue, gp as AdjustValueAdjustValueOneOf, eK as Aggregation, e$ as AggregationData, hN as AggregationDataAggregationResults, hO as AggregationDataAggregationResultsResultOneOf, hB as AggregationDataAggregationResultsScalarResult, fG as AggregationDateHistogramAggregation, bu as AggregationDateHistogramAggregationInterval, eL as AggregationKindOneOf, fJ as AggregationNestedAggregation, ho as AggregationNestedAggregationNestedAggregationItem, hp as AggregationNestedAggregationNestedAggregationItemKindOneOf, bt as AggregationNestedAggregationNestedAggregationType, fE as AggregationRangeAggregation, hh as AggregationRangeAggregationRangeBucket, fi as AggregationResults, hL as AggregationResultsDateHistogramResults, hK as AggregationResultsGroupByValueResults, hx as AggregationResultsNestedAggregationResults, hy as AggregationResultsNestedAggregationResultsResultOneOf, hM as AggregationResultsNestedResults, hA as AggregationResultsRangeResults, fj as AggregationResultsResultOneOf, f6 as AggregationResultsScalarResult, hz as AggregationResultsValueResults, fF as AggregationScalarAggregation, b7 as AggregationType, fC as AggregationValueAggregation, hi as AggregationValueAggregationIncludeMissingValuesOptions, br as AggregationValueAggregationMissingValues, fD as AggregationValueAggregationOptionsOneOf, bq as AggregationValueAggregationSortDirection, bp as AggregationValueAggregationSortType, ap as Alignment, cx as AnchorData, eo as App, cD as AppEmbedData, cE as AppEmbedDataAppDataOneOf, aG as AppType, f$ as ApplicationError, cS as AudioData, bl as AvailabilityStatus, cn as Background, co as BackgroundBackgroundOneOf, aD as BackgroundType, i6 as BaseEventMetadata, cV as BlockquoteData, cF as BookingData, bD as Border, cQ as BorderColors, dm as Brand, dD as BreadCrumb, dC as BreadcrumbsInfo, g0 as BulkActionMetadata, gb as BulkAddInfoSectionsToProductsByFilterRequest, gc as BulkAddInfoSectionsToProductsByFilterResponse, ge as BulkAddInfoSectionsToProductsRequest, gg as BulkAddInfoSectionsToProductsResponse, i2 as BulkAddProductsToCategoriesByFilterRequest, gn as BulkAdjustProductVariantsByFilterRequest, bw as BulkAdjustProductVariantsByFilterRequestRoundingStrategy, gs as BulkAdjustProductVariantsByFilterResponse, gV as BulkCreateProductsRequest, gZ as BulkCreateProductsWithInventoryRequest, g9 as BulkDeleteProductsByFilterRequest, ga as BulkDeleteProductsByFilterResponse, g6 as BulkDeleteProductsRequest, g7 as BulkDeleteProductsResponse, h6 as BulkDeleteProductsResponseBulkProductResult, gt as BulkInventoryItemAction, gP as BulkInventoryItemResult, gO as BulkInventoryItemResults, g8 as BulkProductResult, g_ as BulkProductResults, gh as BulkRemoveInfoSectionsFromProductsByFilterRequest, gi as BulkRemoveInfoSectionsFromProductsByFilterResponse, gj as BulkRemoveInfoSectionsFromProductsRequest, gk as BulkRemoveInfoSectionsFromProductsResponse, i3 as BulkRemoveProductsFromCategoriesByFilterRequest, hU as BulkUpdateProductVariantsByFilterRequest, g4 as BulkUpdateProductsByFilterRequest, g5 as BulkUpdateProductsByFilterResponse, g$ as BulkUpdateProductsRequest, h0 as BulkUpdateProductsWithInventoryRequest, gl as BulkUpdateVariantsByFilterRequest, gm as BulkUpdateVariantsByFilterResponse, cU as BulletedListData, bC as ButtonData, gy as CalculateProductInventorPreorderStatusAsyncRequest, gz as CalculateProductInventorPreorderStatusAsyncResponse, cW as CaptionData, gW as CatalogV3BulkProductResult, cP as CellStyle, aN as ChoiceType, dc as ChoicesSettings, bO as CodeBlockData, cL as CollapsibleListData, cy as ColorData, bE as Colors, fy as CommonAggregation, hu as CommonAggregationData, hn as CommonAggregationDateHistogramAggregation, fz as CommonAggregationKindOneOf, hq as CommonAggregationNestedAggregation, hl as CommonAggregationRangeAggregation, hm as CommonAggregationScalarAggregation, bh as CommonAggregationType, hj as CommonAggregationValueAggregation, hk as CommonAggregationValueAggregationOptionsOneOf, gR as CommonBulkActionMetadata, hr as CommonCursorPaging, hs as CommonCursorPagingMetadata, hQ as CommonCursorQuery, hR as CommonCursorQueryPagingMethodOneOf, hc as CommonCursorSearch, hd as CommonCursorSearchPagingMethodOneOf, ht as CommonCursors, f_ as CommonItemMetadata, be as CommonScalarType, fM as CommonSearchDetails, bn as CommonSearchDetailsMode, ba as CommonSortOrder, fx as CommonSorting, dg as ConnectedModifier, dk as ConnectedModifierChoice, dl as ConnectedModifierChoiceValueOneOf, dh as ConnectedModifierModifierSettingsOneOf, da as ConnectedOption, dd as ConnectedOptionChoice, de as ConnectedOptionChoiceValueOneOf, db as ConnectedOptionOptionSettingsOneOf, fV as CountProductsRequest, fW as CountProductsResponse, gA as CreateProductRequest, gB as CreateProductResponse, gE as CreateProductWithInventoryRequest, at as Crop, eX as CursorPaging, eZ as CursorPagingMetadata, fp as CursorQuery, fq as CursorQueryPagingMethodOneOf, eH as CursorSearch, eI as CursorSearchPagingMethodOneOf, e_ as Cursors, es as CustomTag, eS as DateHistogramAggregation, bg as DateHistogramAggregationInterval, fe as DateHistogramResult, fg as DateHistogramResults, hJ as DateHistogramResultsDateHistogramResult, cv as Decoration, cw as DecorationDataOneOf, aE as DecorationType, e7 as DeleteByFilterOperation, e6 as DeleteByIdsOperation, eE as DeleteProductRequest, eF as DeleteProductResponse, fu as DeprecatedSearchProductsWithOffsetRequest, fO as DeprecatedSearchProductsWithOffsetResponse, ct as Design, cN as Dimensions, aI as Direction, aX as DiscountType, bQ as DividerData, fX as DoNotCallBulkCreateProductsRequest, fY as DoNotCallBulkCreateProductsResponse, g1 as DoNotCallBulkUpdateProductsRequest, g3 as DoNotCallBulkUpdateProductsResponse, et as DoNotCallCreateProductRequest, eu as DoNotCallCreateProductResponse, eA as DoNotCallUpdateProductRequest, eB as DoNotCallUpdateProductResponse, e5 as DocumentImage, e4 as DocumentPayload, cZ as DocumentStyle, e2 as DocumentUpdateOperation, ea as DomainEvent, eb as DomainEventBodyOneOf, ev as DuplicateMediaIdAssignedToProduct, cJ as EmbedData, eh as Empty, ec as EntityCreatedEvent, ef as EntityDeletedEvent, ee as EntityUpdatedEvent, aY as Enum, cG as EventData, i7 as EventMetadata, bm as EventType, fo as EventuallyConsistentQueryProductsRequest, fr as EventuallyConsistentQueryProductsResponse, dU as ExtendedFields, er as File, bR as FileData, bS as FileSource, bT as FileSourceDataOneOf, aV as FileType, du as FixedMonetaryAmount, cB as FontSizeData, aF as FontType, di as FreeTextSettings, gd as FulfillerDeleted, c4 as GIF, c3 as GIFData, av as GIFType, bV as GalleryData, b$ as GalleryOptions, i4 as GetAllProductsCategoryRequest, ey as GetProductBySlugRequest, ez as GetProductBySlugResponse, ew as GetProductRequest, ex as GetProductResponse, cm as Gradient, fK as GroupByAggregation, fL as GroupByAggregationKindOneOf, ff as GroupByValueResults, hC as GroupByValueResultsNestedValueAggregationResult, c6 as HTMLData, c7 as HTMLDataDataOneOf, c5 as HeadingData, bJ as Height, ek as IdentificationData, el as IdentificationDataIdOneOf, bX as Image, c8 as ImageData, ca as ImageDataStyles, eN as IncludeMissingValuesOptions, e3 as IndexDocument, dn as InfoSection, aH as InitialExpandedItems, b6 as Interval, gY as InvalidDigitalFileIds, em as InvalidateCache, en as InvalidateCacheGetByOneOf, dv as Inventory, aP as InventoryAvailabilityStatus, gu as InventoryItem, gJ as InventoryItemComposite, gK as InventoryItemCompositeTrackingMethodOneOf, gv as InventoryItemTrackingMethodOneOf, dT as InventoryStatus, bZ as Item, b_ as ItemDataOneOf, gQ as ItemMetadata, c1 as ItemStyle, d7 as Keyword, c0 as Layout, cX as LayoutCellData, ar as LayoutType, an as LineStyle, bL as Link, cz as LinkData, bM as LinkDataOneOf, cb as LinkPreviewData, cc as LinkPreviewDataStyles, cR as ListValue, cd as MapData, ce as MapSettings, ay as MapType, g2 as MaskedProduct, aT as MeasurementUnit, c$ as Media, d5 as MediaItemsInfo, aL as MediaType, cA as MentionData, ej as MessageEnvelope, cY as Metadata, d$ as MinVariantPriceInfo, b3 as MissingValues, b8 as Mode, dj as ModifierChoicesSettings, aO as ModifierRenderType, df as MultipleColors, eV as NestedAggregation, eT as NestedAggregationItem, eU as NestedAggregationItemKindOneOf, fH as NestedAggregationNestedAggregationItem, fI as NestedAggregationNestedAggregationItemKindOneOf, bf as NestedAggregationNestedAggregationType, f2 as NestedAggregationResults, f3 as NestedAggregationResultsResultOneOf, b5 as NestedAggregationType, fb as NestedResultValue, fc as NestedResultValueResultOneOf, fh as NestedResults, hG as NestedResultsNestedResultValue, hH as NestedResultsNestedResultValueResultOneOf, hE as NestedResultsRangeResult, hI as NestedResultsResults, hF as NestedResultsScalarResult, hD as NestedResultsValueResult, f7 as NestedValueAggregationResult, bz as Node, bA as NodeDataOneOf, bB as NodeStyle, ah as NodeType, aK as NullValue, cK as Oembed, ci as Option, dH as OptionChoice, dI as OptionChoiceIds, dJ as OptionChoiceNames, gL as OptionChoiceReferences, cq as OptionDesign, cl as OptionLayout, cT as OrderedListData, as as Orientation, bU as PDFSettings, ep as Page, fP as PagingMetadata, cf as ParagraphData, ch as Permissions, dw as PhysicalProperties, fv as PlatformOffsetSearch, fw as PlatformOffsetSearchPagingMethodOneOf, fN as PlatformPaging, cI as PlaybackOptions, bF as PluginContainerData, aj as PluginContainerDataAlignment, bG as PluginContainerDataWidth, bH as PluginContainerDataWidthDataOneOf, cr as Poll, cg as PollData, cs as PollDataLayout, cp as PollDesign, ck as PollLayout, aC as PollLayoutDirection, aB as PollLayoutType, cj as PollSettings, ax as Position, gw as PreorderInfo, aQ as PreorderStatus, dK as PriceInfo, dN as PricePerUnit, dz as PricePerUnitRange, dA as PricePerUnitRangePricePerUnit, dx as PricePerUnitSettings, dt as PriceRange, gx as Product, dq as ProductCategoriesInfo, dr as ProductCategory, ds as ProductCategoryIdsInfo, gf as ProductIdWithRevision, d0 as ProductMedia, d2 as ProductMediaMediaOneOf, d1 as ProductMediaSetByOneOf, aM as ProductOptionRenderType, aR as ProductPreorderAvailability, aS as ProductType, fR as ProductVariantIds, fU as ProductVariants, gF as ProductWithInventoryTypedPropertiesOneOf, i9 as ProductsQueryResult, fs as QueryProductsRequest, ft as QueryProductsResponse, eQ as RangeAggregation, fA as RangeAggregationRangeBucket, f1 as RangeAggregationResult, eM as RangeBucket, f9 as RangeResult, f5 as RangeResults, hw as RangeResultsRangeAggregationResult, bN as Rel, b9 as RequestedFields, ed as RestoreInfo, fd as Results, fQ as RetrieveVariantsRequest, fT as RetrieveVariantsResponse, dL as RevenueDetails, dp as Ribbon, by as RichContent, bk as RoundingStrategy, eR as ScalarAggregation, fa as ScalarResult, b4 as ScalarType, eW as SearchDetails, bi as SearchDetailsMode, ei as SearchIndexingNotification, eG as SearchProductsRequest, eY as SearchProductsResponse, fl as SearchRelated, fm as SearchRelatedDetails, fk as SearchRelatedProductsRequest, fn as SearchRelatedProductsResponse, dP as SecuredMedia, d6 as SeoSchema, d9 as Settings, a$ as SingleEntityOpsRequestedFields, b2 as SortDirection, b0 as SortOrder, b1 as SortType, eJ as Sorting, aw as Source, bI as Spoiler, cC as SpoilerData, aZ as State, bK as Styles, c9 as StylesBorder, dW as Subscription, dX as SubscriptionCyclesOneOf, dV as SubscriptionDetails, dY as SubscriptionDiscount, dZ as SubscriptionDiscountDiscountOneOf, aW as SubscriptionFrequency, dR as SubscriptionPrice, dS as SubscriptionPricePerUnit, dQ as SubscriptionPricesInfo, cO as TableCellData, cM as TableData, d8 as Tag, al as Target, am as TextAlignment, cu as TextData, c_ as TextNodeStyle, bP as TextStyle, d4 as Thumbnail, c2 as Thumbnails, au as ThumbnailsAlignment, i5 as TreeReference, ak as Type, eq as URI, gq as UnsignedAdjustValue, gr as UnsignedAdjustValueAdjustValueOneOf, eD as UnsupportedFieldMasks, e8 as UpdateByFilterOperation, e0 as UpdateDocumentsEvent, e1 as UpdateDocumentsEventOperationOneOf, e9 as UpdateExistingOperation, gS as UpdateProductRequest, gT as UpdateProductResponse, gU as UpdateProductWithInventoryRequest, bW as V1Media, hW as V3AdjustValue, hX as V3AdjustValueAdjustValueOneOf, h_ as V3BulkAddInfoSectionsToProductsByFilterRequest, h$ as V3BulkAddInfoSectionsToProductsRequest, hV as V3BulkAdjustProductVariantsByFilterRequest, h7 as V3BulkDeleteProductsByFilterRequest, h5 as V3BulkDeleteProductsRequest, fZ as V3BulkProductResult, i0 as V3BulkRemoveInfoSectionsFromProductsByFilterRequest, i1 as V3BulkRemoveInfoSectionsFromProductsRequest, h1 as V3BulkUpdateProductsByFilterRequest, hT as V3CountProductsRequest, h3 as V3DeleteProductRequest, h4 as V3DeleteProductResponse, ha as V3GetProductBySlugRequest, h8 as V3GetProductRequest, h9 as V3GetProductResponse, gM as V3OptionChoiceIds, gN as V3OptionChoiceNames, i8 as V3ProductSearchSpec, bx as V3ProductTypedPropertiesOneOf, hP as V3QueryProductsRequest, hS as V3QueryProductsResponse, hb as V3SearchProductsRequest, hY as V3UnsignedAdjustValue, hZ as V3UnsignedAdjustValueAdjustValueOneOf, gG as V3VariantsInfo, eO as ValueAggregation, fB as ValueAggregationIncludeMissingValuesOptions, bd as ValueAggregationMissingValues, eP as ValueAggregationOptionsOneOf, f0 as ValueAggregationResult, bc as ValueAggregationSortDirection, bb as ValueAggregationSortType, f8 as ValueResult, f4 as ValueResults, hv as ValueResultsValueAggregationResult, dF as Variant, dO as VariantDigitalProperties, gD as VariantNotAlignedWithProduct, dM as VariantPhysicalProperties, d_ as VariantSummary, dG as VariantTypedPropertiesOneOf, gH as VariantWithInventory, gI as VariantWithInventoryTypedPropertiesOneOf, fS as VariantsCursorPaging, dE as VariantsInfo, gC as VariantsNotAlignedWithProduct, bj as VariantsOpsRequestedFields, eC as VariantsRemoved, aJ as VerticalAlignment, bY as Video, cH as VideoData, d3 as VideoResolution, aq as ViewMode, az as ViewRole, aA as VoteRole, a_ as WebhookIdentityType, dB as WeightMeasurementUnitInfo, dy as WeightRange, aU as WeightUnit, ao as Width, ai as WidthType, hf as WixCommonAggregation, hg as WixCommonAggregationKindOneOf, bv as WixCommonAggregationType, gX as WixCommonItemMetadata, bs as WixCommonScalarType, h2 as WixCommonSearchDetails, bo as WixCommonSortOrder, he as WixCommonSorting } from './stores-catalog-v3-product-products-v-3.universal-BxxKSsqd.js';
|
|
4
4
|
|
|
5
|
+
type ProductNonNullablePaths = `physicalProperties.pricePerUnit.quantity` | `physicalProperties.pricePerUnit.measurementUnit` | `physicalProperties.shippingWeightRange.minValue` | `physicalProperties.shippingWeightRange.maxValue` | `physicalProperties.pricePerUnitRange.minValue.value` | `physicalProperties.weightMeasurementUnitInfo.weightMeasurementUnit` | `media.main._id` | `media.main.url` | `media.main.mediaType` | `media.main.thumbnail.url` | `media.main.thumbnail.height` | `media.main.thumbnail.width` | `media.main.uploadId` | `media.itemsInfo.items` | `seoData.tags` | `seoData.tags.${number}.type` | `seoData.tags.${number}.children` | `seoData.tags.${number}.custom` | `seoData.tags.${number}.disabled` | `seoData.settings.preventAutoRedirect` | `seoData.settings.keywords` | `seoData.settings.keywords.${number}.term` | `seoData.settings.keywords.${number}.isMain` | `options` | `options.${number}.optionRenderType` | `modifiers` | `modifiers.${number}.freeTextSettings.minCharCount` | `modifiers.${number}.freeTextSettings.maxCharCount` | `modifiers.${number}.freeTextSettings.title` | `modifiers.${number}.modifierRenderType` | `modifiers.${number}.mandatory` | `infoSections` | `directCategoriesInfo.categories` | `directCategoriesInfo.categories.${number}._id` | `allCategoriesInfo.categories` | `allCategoriesInfo.categories.${number}._id` | `costRange.minValue.amount` | `inventory.availabilityStatus` | `inventory.preorderStatus` | `inventory.preorderAvailability` | `productType` | `breadcrumbsInfo.breadcrumbs` | `breadcrumbsInfo.breadcrumbs.${number}.categoryId` | `breadcrumbsInfo.breadcrumbs.${number}.categoryName` | `breadcrumbsInfo.breadcrumbs.${number}.categorySlug` | `actualPriceRange.minValue.amount` | `compareAtPriceRange.minValue.amount` | `variantsInfo.variants` | `variantsInfo.variants.${number}.physicalProperties.pricePerUnit.settings.quantity` | `variantsInfo.variants.${number}.physicalProperties.pricePerUnit.settings.measurementUnit` | `variantsInfo.variants.${number}.physicalProperties.pricePerUnit.value` | `variantsInfo.variants.${number}.digitalProperties.digitalFile._id` | `variantsInfo.variants.${number}.digitalProperties.digitalFile.fileName` | `variantsInfo.variants.${number}.digitalProperties.digitalFile.fileType` | `variantsInfo.variants.${number}.price.actualPrice.amount` | `variantsInfo.variants.${number}.revenueDetails.profitMargin` | `variantsInfo.variants.${number}.media._id` | `variantsInfo.variants.${number}.media.url` | `variantsInfo.variants.${number}.media.mediaType` | `variantsInfo.variants.${number}.media.thumbnail.url` | `variantsInfo.variants.${number}.media.thumbnail.height` | `variantsInfo.variants.${number}.media.thumbnail.width` | `variantsInfo.variants.${number}.media.uploadId` | `variantsInfo.variants.${number}.inventoryStatus.inStock` | `variantsInfo.variants.${number}.inventoryStatus.preorderEnabled` | `subscriptionDetails.subscriptions` | `subscriptionDetails.subscriptions.${number}.autoRenewal` | `subscriptionDetails.subscriptions.${number}.billingCycles` | `subscriptionDetails.subscriptions.${number}.title` | `subscriptionDetails.subscriptions.${number}.frequency` | `subscriptionDetails.subscriptions.${number}.discount.amountOff` | `subscriptionDetails.subscriptions.${number}.discount.percentOff` | `subscriptionDetails.subscriptions.${number}.discount.type` | `variantSummary.variantCount`;
|
|
5
6
|
declare function createProduct$1(httpClient: HttpClient): CreateProductSignature;
|
|
6
7
|
interface CreateProductSignature {
|
|
7
8
|
/**
|
|
@@ -14,9 +15,9 @@ interface CreateProductSignature {
|
|
|
14
15
|
* If `options` is empty one default variant must be provided with empty `choices` list.
|
|
15
16
|
* @returns Created product.
|
|
16
17
|
*/
|
|
17
|
-
(product: V3Product, options
|
|
18
|
-
__applicationErrorsType?: CreateProductApplicationErrors
|
|
19
|
-
__validationErrorsType?: CreateProductValidationErrors
|
|
18
|
+
(product: NonNullablePaths<V3Product, `modifiers.${number}.choicesSettings.choices` | `name` | `options.${number}.choicesSettings.choices` | `physicalProperties.pricePerUnit.measurementUnit` | `productType` | `subscriptionDetails.subscriptions` | `subscriptionDetails.subscriptions.${number}.discount.type` | `subscriptionDetails.subscriptions.${number}.frequency` | `subscriptionDetails.subscriptions.${number}.title` | `variantsInfo` | `variantsInfo.variants` | `variantsInfo.variants.${number}.digitalProperties.digitalFile` | `variantsInfo.variants.${number}.digitalProperties.digitalFile._id` | `variantsInfo.variants.${number}.physicalProperties.pricePerUnit.settings.measurementUnit` | `variantsInfo.variants.${number}.price` | `variantsInfo.variants.${number}.price.actualPrice`>, options?: CreateProductOptions): Promise<NonNullablePaths<V3Product, ProductNonNullablePaths> & {
|
|
19
|
+
__applicationErrorsType?: CreateProductApplicationErrors;
|
|
20
|
+
__validationErrorsType?: CreateProductValidationErrors;
|
|
20
21
|
}>;
|
|
21
22
|
}
|
|
22
23
|
declare function createProductWithInventory$1(httpClient: HttpClient): CreateProductWithInventorySignature;
|
|
@@ -30,7 +31,9 @@ interface CreateProductWithInventorySignature {
|
|
|
30
31
|
* At least one variant must be provided and each variant must have relevant item in `choices` field for every item in `options`.
|
|
31
32
|
* If `options` is empty one default variant must be provided with empty `choices` list.
|
|
32
33
|
*/
|
|
33
|
-
(product: ProductWithInventory, options
|
|
34
|
+
(product: NonNullablePaths<ProductWithInventory, `modifiers.${number}.choicesSettings.choices` | `name` | `options.${number}.choicesSettings.choices` | `physicalProperties.pricePerUnit.measurementUnit` | `productType` | `subscriptionDetails.subscriptions` | `subscriptionDetails.subscriptions.${number}.discount.type` | `subscriptionDetails.subscriptions.${number}.frequency` | `subscriptionDetails.subscriptions.${number}.title` | `variantsInfo` | `variantsInfo.variants.${number}.digitalProperties.digitalFile` | `variantsInfo.variants.${number}.digitalProperties.digitalFile._id` | `variantsInfo.variants.${number}.physicalProperties.pricePerUnit.settings.measurementUnit` | `variantsInfo.variants.${number}.price` | `variantsInfo.variants.${number}.price.actualPrice`>, options?: CreateProductWithInventoryOptions): Promise<NonNullablePaths<CreateProductWithInventoryResponse, {
|
|
35
|
+
[P in ProductNonNullablePaths]: `product.${P}`;
|
|
36
|
+
}[ProductNonNullablePaths] | `inventoryResults.results` | `inventoryResults.results.${number}.itemMetadata.originalIndex` | `inventoryResults.results.${number}.itemMetadata.success` | `inventoryResults.results.${number}.itemMetadata.error.code` | `inventoryResults.results.${number}.itemMetadata.error.description` | `inventoryResults.results.${number}.item.inStock` | `inventoryResults.results.${number}.item.quantity` | `inventoryResults.results.${number}.item.variantId` | `inventoryResults.results.${number}.item.productId` | `inventoryResults.results.${number}.item.trackQuantity` | `inventoryResults.results.${number}.item.availabilityStatus` | `inventoryResults.bulkActionMetadata.totalSuccesses` | `inventoryResults.bulkActionMetadata.totalFailures` | `inventoryResults.bulkActionMetadata.undetailedFailures`>>;
|
|
34
37
|
}
|
|
35
38
|
declare function updateProduct$1(httpClient: HttpClient): UpdateProductSignature;
|
|
36
39
|
interface UpdateProductSignature {
|
|
@@ -47,9 +50,9 @@ interface UpdateProductSignature {
|
|
|
47
50
|
* @param - Product ID.
|
|
48
51
|
* @returns Updated product.
|
|
49
52
|
*/
|
|
50
|
-
(_id: string, product: UpdateProduct, options
|
|
51
|
-
__applicationErrorsType?: UpdateProductApplicationErrors
|
|
52
|
-
__validationErrorsType?: UpdateProductValidationErrors
|
|
53
|
+
(_id: string, product: NonNullablePaths<UpdateProduct, `modifiers.${number}.choicesSettings.choices` | `options.${number}.choicesSettings.choices` | `physicalProperties.pricePerUnit.measurementUnit` | `revision` | `subscriptionDetails.subscriptions.${number}.discount.type` | `subscriptionDetails.subscriptions.${number}.frequency` | `subscriptionDetails.subscriptions.${number}.title` | `variantsInfo.variants.${number}.digitalProperties.digitalFile` | `variantsInfo.variants.${number}.digitalProperties.digitalFile._id` | `variantsInfo.variants.${number}.physicalProperties.pricePerUnit.settings.measurementUnit` | `variantsInfo.variants.${number}.price` | `variantsInfo.variants.${number}.price.actualPrice`>, options?: UpdateProductOptions): Promise<NonNullablePaths<V3Product, ProductNonNullablePaths> & {
|
|
54
|
+
__applicationErrorsType?: UpdateProductApplicationErrors;
|
|
55
|
+
__validationErrorsType?: UpdateProductValidationErrors;
|
|
53
56
|
}>;
|
|
54
57
|
}
|
|
55
58
|
declare function updateProductWithInventory$1(httpClient: HttpClient): UpdateProductWithInventorySignature;
|
|
@@ -66,7 +69,9 @@ interface UpdateProductWithInventorySignature {
|
|
|
66
69
|
* > + To update existing `variantsInfo.variants`, pass `variantsInfo.variants.id`. If no ID is passed, the variant will be created with a new ID.
|
|
67
70
|
* @param - Product ID.
|
|
68
71
|
*/
|
|
69
|
-
(_id: string, product: UpdateProductWithInventoryProduct, options
|
|
72
|
+
(_id: string, product: NonNullablePaths<UpdateProductWithInventoryProduct, `modifiers.${number}.choicesSettings.choices` | `options.${number}.choicesSettings.choices` | `physicalProperties.pricePerUnit.measurementUnit` | `revision` | `subscriptionDetails.subscriptions.${number}.discount.type` | `subscriptionDetails.subscriptions.${number}.frequency` | `subscriptionDetails.subscriptions.${number}.title` | `variantsInfo.variants.${number}.digitalProperties.digitalFile` | `variantsInfo.variants.${number}.digitalProperties.digitalFile._id` | `variantsInfo.variants.${number}.physicalProperties.pricePerUnit.settings.measurementUnit` | `variantsInfo.variants.${number}.price` | `variantsInfo.variants.${number}.price.actualPrice`>, options?: UpdateProductWithInventoryOptions): Promise<NonNullablePaths<UpdateProductWithInventoryResponse, {
|
|
73
|
+
[P in ProductNonNullablePaths]: `product.${P}`;
|
|
74
|
+
}[ProductNonNullablePaths] | `inventoryResults.results` | `inventoryResults.results.${number}.itemMetadata.originalIndex` | `inventoryResults.results.${number}.itemMetadata.success` | `inventoryResults.results.${number}.itemMetadata.error.code` | `inventoryResults.results.${number}.itemMetadata.error.description` | `inventoryResults.results.${number}.item.inStock` | `inventoryResults.results.${number}.item.quantity` | `inventoryResults.results.${number}.item.variantId` | `inventoryResults.results.${number}.item.productId` | `inventoryResults.results.${number}.item.trackQuantity` | `inventoryResults.results.${number}.item.availabilityStatus` | `inventoryResults.bulkActionMetadata.totalSuccesses` | `inventoryResults.bulkActionMetadata.totalFailures` | `inventoryResults.bulkActionMetadata.undetailedFailures`>>;
|
|
70
75
|
}
|
|
71
76
|
declare function bulkCreateProducts$1(httpClient: HttpClient): BulkCreateProductsSignature;
|
|
72
77
|
interface BulkCreateProductsSignature {
|
|
@@ -83,9 +88,11 @@ interface BulkCreateProductsSignature {
|
|
|
83
88
|
* > + `variantsInfo.variants`: 1000
|
|
84
89
|
* @param - List of products to create.
|
|
85
90
|
*/
|
|
86
|
-
(products: V3Product[], options?: BulkCreateProductsOptions
|
|
87
|
-
|
|
88
|
-
|
|
91
|
+
(products: NonNullablePaths<V3Product, `modifiers.${number}.choicesSettings.choices` | `name` | `options.${number}.choicesSettings.choices` | `physicalProperties.pricePerUnit.measurementUnit` | `productType` | `subscriptionDetails.subscriptions` | `subscriptionDetails.subscriptions.${number}.discount.type` | `subscriptionDetails.subscriptions.${number}.frequency` | `subscriptionDetails.subscriptions.${number}.title` | `variantsInfo` | `variantsInfo.variants` | `variantsInfo.variants.${number}.digitalProperties.digitalFile` | `variantsInfo.variants.${number}.digitalProperties.digitalFile._id` | `variantsInfo.variants.${number}.physicalProperties.pricePerUnit.settings.measurementUnit` | `variantsInfo.variants.${number}.price` | `variantsInfo.variants.${number}.price.actualPrice`>[], options?: BulkCreateProductsOptions): Promise<NonNullablePaths<BulkCreateProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
92
|
+
[P in ProductNonNullablePaths]: `results.${number}.item.${P}`;
|
|
93
|
+
}[ProductNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
|
|
94
|
+
__applicationErrorsType?: BulkCreateProductsApplicationErrors;
|
|
95
|
+
__validationErrorsType?: BulkCreateProductsValidationErrors;
|
|
89
96
|
}>;
|
|
90
97
|
}
|
|
91
98
|
declare function bulkCreateProductsWithInventory$1(httpClient: HttpClient): BulkCreateProductsWithInventorySignature;
|
|
@@ -103,7 +110,9 @@ interface BulkCreateProductsWithInventorySignature {
|
|
|
103
110
|
* > + `variantsInfo.variants`: 1000
|
|
104
111
|
* @param - List of products to create with inventory.
|
|
105
112
|
*/
|
|
106
|
-
(products: ProductWithInventory[], options?: BulkCreateProductsWithInventoryOptions
|
|
113
|
+
(products: NonNullablePaths<ProductWithInventory, `modifiers.${number}.choicesSettings.choices` | `name` | `options.${number}.choicesSettings.choices` | `physicalProperties.pricePerUnit.measurementUnit` | `productType` | `subscriptionDetails.subscriptions` | `subscriptionDetails.subscriptions.${number}.discount.type` | `subscriptionDetails.subscriptions.${number}.frequency` | `subscriptionDetails.subscriptions.${number}.title` | `variantsInfo` | `variantsInfo.variants.${number}.digitalProperties.digitalFile` | `variantsInfo.variants.${number}.digitalProperties.digitalFile._id` | `variantsInfo.variants.${number}.physicalProperties.pricePerUnit.settings.measurementUnit` | `variantsInfo.variants.${number}.price` | `variantsInfo.variants.${number}.price.actualPrice`>[], options?: BulkCreateProductsWithInventoryOptions): Promise<NonNullablePaths<BulkCreateProductsWithInventoryResponse, `productResults.results` | `productResults.results.${number}.itemMetadata.originalIndex` | `productResults.results.${number}.itemMetadata.success` | `productResults.results.${number}.itemMetadata.error.code` | `productResults.results.${number}.itemMetadata.error.description` | {
|
|
114
|
+
[P in ProductNonNullablePaths]: `productResults.results.${number}.item.${P}`;
|
|
115
|
+
}[ProductNonNullablePaths] | `productResults.bulkActionMetadata.totalSuccesses` | `productResults.bulkActionMetadata.totalFailures` | `productResults.bulkActionMetadata.undetailedFailures` | `inventoryResults.results` | `inventoryResults.results.${number}.itemMetadata.originalIndex` | `inventoryResults.results.${number}.itemMetadata.success` | `inventoryResults.results.${number}.itemMetadata.error.code` | `inventoryResults.results.${number}.itemMetadata.error.description` | `inventoryResults.results.${number}.item.inStock` | `inventoryResults.results.${number}.item.quantity` | `inventoryResults.results.${number}.item.variantId` | `inventoryResults.results.${number}.item.productId` | `inventoryResults.results.${number}.item.trackQuantity` | `inventoryResults.results.${number}.item.availabilityStatus` | `inventoryResults.bulkActionMetadata.totalSuccesses` | `inventoryResults.bulkActionMetadata.totalFailures` | `inventoryResults.bulkActionMetadata.undetailedFailures`>>;
|
|
107
116
|
}
|
|
108
117
|
declare function bulkUpdateProducts$1(httpClient: HttpClient): BulkUpdateProductsSignature;
|
|
109
118
|
interface BulkUpdateProductsSignature {
|
|
@@ -120,9 +129,11 @@ interface BulkUpdateProductsSignature {
|
|
|
120
129
|
* > + `variantsInfo.variants`: 1000
|
|
121
130
|
* @param - List of products to update.
|
|
122
131
|
*/
|
|
123
|
-
(products: V3MaskedProduct[], options?: BulkUpdateProductsOptions
|
|
124
|
-
|
|
125
|
-
|
|
132
|
+
(products: NonNullablePaths<V3MaskedProduct, `product` | `product._id` | `product.modifiers.${number}.choicesSettings.choices` | `product.options.${number}.choicesSettings.choices` | `product.physicalProperties.pricePerUnit.measurementUnit` | `product.revision` | `product.subscriptionDetails.subscriptions.${number}.discount.type` | `product.subscriptionDetails.subscriptions.${number}.frequency` | `product.subscriptionDetails.subscriptions.${number}.title` | `product.variantsInfo.variants.${number}.digitalProperties.digitalFile` | `product.variantsInfo.variants.${number}.digitalProperties.digitalFile._id` | `product.variantsInfo.variants.${number}.physicalProperties.pricePerUnit.settings.measurementUnit` | `product.variantsInfo.variants.${number}.price` | `product.variantsInfo.variants.${number}.price.actualPrice`>[], options?: BulkUpdateProductsOptions): Promise<NonNullablePaths<BulkUpdateProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
133
|
+
[P in ProductNonNullablePaths]: `results.${number}.item.${P}`;
|
|
134
|
+
}[ProductNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
|
|
135
|
+
__applicationErrorsType?: BulkUpdateProductsApplicationErrors;
|
|
136
|
+
__validationErrorsType?: BulkUpdateProductsValidationErrors;
|
|
126
137
|
}>;
|
|
127
138
|
}
|
|
128
139
|
declare function bulkUpdateProductsWithInventory$1(httpClient: HttpClient): BulkUpdateProductsWithInventorySignature;
|
|
@@ -140,7 +151,9 @@ interface BulkUpdateProductsWithInventorySignature {
|
|
|
140
151
|
* > + `variantsInfo.variants`: 1000
|
|
141
152
|
* @param - List of products to update.
|
|
142
153
|
*/
|
|
143
|
-
(products: MaskedProductWithInventory[], options?: BulkUpdateProductsWithInventoryOptions
|
|
154
|
+
(products: NonNullablePaths<MaskedProductWithInventory, `product` | `product._id` | `product.modifiers.${number}.choicesSettings.choices` | `product.options.${number}.choicesSettings.choices` | `product.physicalProperties.pricePerUnit.measurementUnit` | `product.revision` | `product.subscriptionDetails.subscriptions.${number}.discount.type` | `product.subscriptionDetails.subscriptions.${number}.frequency` | `product.subscriptionDetails.subscriptions.${number}.title` | `product.variantsInfo.variants.${number}.digitalProperties.digitalFile` | `product.variantsInfo.variants.${number}.digitalProperties.digitalFile._id` | `product.variantsInfo.variants.${number}.physicalProperties.pricePerUnit.settings.measurementUnit` | `product.variantsInfo.variants.${number}.price` | `product.variantsInfo.variants.${number}.price.actualPrice`>[], options?: BulkUpdateProductsWithInventoryOptions): Promise<NonNullablePaths<BulkUpdateProductsWithInventoryResponse, `productResults.results` | `productResults.results.${number}.itemMetadata.originalIndex` | `productResults.results.${number}.itemMetadata.success` | `productResults.results.${number}.itemMetadata.error.code` | `productResults.results.${number}.itemMetadata.error.description` | {
|
|
155
|
+
[P in ProductNonNullablePaths]: `productResults.results.${number}.item.${P}`;
|
|
156
|
+
}[ProductNonNullablePaths] | `productResults.bulkActionMetadata.totalSuccesses` | `productResults.bulkActionMetadata.totalFailures` | `productResults.bulkActionMetadata.undetailedFailures` | `inventoryResults.results` | `inventoryResults.results.${number}.itemMetadata.originalIndex` | `inventoryResults.results.${number}.itemMetadata.success` | `inventoryResults.results.${number}.itemMetadata.error.code` | `inventoryResults.results.${number}.itemMetadata.error.description` | `inventoryResults.results.${number}.item.inStock` | `inventoryResults.results.${number}.item.quantity` | `inventoryResults.results.${number}.item.variantId` | `inventoryResults.results.${number}.item.productId` | `inventoryResults.results.${number}.item.trackQuantity` | `inventoryResults.results.${number}.item.availabilityStatus` | `inventoryResults.bulkActionMetadata.totalSuccesses` | `inventoryResults.bulkActionMetadata.totalFailures` | `inventoryResults.bulkActionMetadata.undetailedFailures`>>;
|
|
144
157
|
}
|
|
145
158
|
declare function bulkUpdateProductsByFilter$1(httpClient: HttpClient): BulkUpdateProductsByFilterSignature;
|
|
146
159
|
interface BulkUpdateProductsByFilterSignature {
|
|
@@ -158,9 +171,9 @@ interface BulkUpdateProductsByFilterSignature {
|
|
|
158
171
|
* >
|
|
159
172
|
* > To update these fields, use [Bulk Update Products](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/bulk-update-products).
|
|
160
173
|
*/
|
|
161
|
-
(options?: BulkUpdateProductsByFilterOptions |
|
|
162
|
-
__applicationErrorsType?: BulkUpdateProductsByFilterApplicationErrors
|
|
163
|
-
__validationErrorsType?: BulkUpdateProductsByFilterValidationErrors
|
|
174
|
+
(options?: NonNullablePaths<BulkUpdateProductsByFilterOptions, `product` | `product.subscriptionDetails.subscriptions.${number}.discount.type` | `product.subscriptionDetails.subscriptions.${number}.frequency` | `product.subscriptionDetails.subscriptions.${number}.title`>): Promise<NonNullablePaths<V3BulkUpdateProductsByFilterResponse, `jobId`> & {
|
|
175
|
+
__applicationErrorsType?: BulkUpdateProductsByFilterApplicationErrors;
|
|
176
|
+
__validationErrorsType?: BulkUpdateProductsByFilterValidationErrors;
|
|
164
177
|
}>;
|
|
165
178
|
}
|
|
166
179
|
declare function deleteProduct$1(httpClient: HttpClient): DeleteProductSignature;
|
|
@@ -177,7 +190,7 @@ interface BulkDeleteProductsSignature {
|
|
|
177
190
|
* Deletes multiple products.
|
|
178
191
|
* @param - IDs of products to delete.
|
|
179
192
|
*/
|
|
180
|
-
(productIds: string[]): Promise<V3BulkDeleteProductsResponse
|
|
193
|
+
(productIds: string[]): Promise<NonNullablePaths<V3BulkDeleteProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
181
194
|
}
|
|
182
195
|
declare function bulkDeleteProductsByFilter$1(httpClient: HttpClient): BulkDeleteProductsByFilterSignature;
|
|
183
196
|
interface BulkDeleteProductsByFilterSignature {
|
|
@@ -185,7 +198,7 @@ interface BulkDeleteProductsByFilterSignature {
|
|
|
185
198
|
* Delete multiple products, given the provided filter.
|
|
186
199
|
* @param - Filter object.
|
|
187
200
|
*/
|
|
188
|
-
(filter: Record<string, any>, options?: BulkDeleteProductsByFilterOptions
|
|
201
|
+
(filter: Record<string, any>, options?: BulkDeleteProductsByFilterOptions): Promise<NonNullablePaths<V3BulkDeleteProductsByFilterResponse, `jobId`>>;
|
|
189
202
|
}
|
|
190
203
|
declare function getProduct$1(httpClient: HttpClient): GetProductSignature;
|
|
191
204
|
interface GetProductSignature {
|
|
@@ -197,7 +210,7 @@ interface GetProductSignature {
|
|
|
197
210
|
* @param - Product ID.
|
|
198
211
|
* @returns Product.
|
|
199
212
|
*/
|
|
200
|
-
(productId: string, options?: GetProductOptions
|
|
213
|
+
(productId: string, options?: GetProductOptions): Promise<NonNullablePaths<V3Product, ProductNonNullablePaths>>;
|
|
201
214
|
}
|
|
202
215
|
declare function getProductBySlug$1(httpClient: HttpClient): GetProductBySlugSignature;
|
|
203
216
|
interface GetProductBySlugSignature {
|
|
@@ -208,7 +221,9 @@ interface GetProductBySlugSignature {
|
|
|
208
221
|
* > To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
209
222
|
* @param - Product slug.
|
|
210
223
|
*/
|
|
211
|
-
(slug: string, options?: GetProductBySlugOptions
|
|
224
|
+
(slug: string, options?: GetProductBySlugOptions): Promise<NonNullablePaths<V3GetProductBySlugResponse, {
|
|
225
|
+
[P in ProductNonNullablePaths]: `product.${P}`;
|
|
226
|
+
}[ProductNonNullablePaths]>>;
|
|
212
227
|
}
|
|
213
228
|
declare function searchProducts$1(httpClient: HttpClient): SearchProductsSignature;
|
|
214
229
|
interface SearchProductsSignature {
|
|
@@ -225,7 +240,9 @@ interface SearchProductsSignature {
|
|
|
225
240
|
* > + To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
226
241
|
* @param - Search options.
|
|
227
242
|
*/
|
|
228
|
-
(search: V3ProductSearch, options?: SearchProductsOptions
|
|
243
|
+
(search: V3ProductSearch, options?: SearchProductsOptions): Promise<NonNullablePaths<V3SearchProductsResponse, {
|
|
244
|
+
[P in ProductNonNullablePaths]: `products.${number}.${P}`;
|
|
245
|
+
}[ProductNonNullablePaths] | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`>>;
|
|
229
246
|
}
|
|
230
247
|
declare function queryProducts$1(httpClient: HttpClient): QueryProductsSignature;
|
|
231
248
|
interface QueryProductsSignature {
|
|
@@ -241,14 +258,14 @@ interface QueryProductsSignature {
|
|
|
241
258
|
* > + This method does not return `variantsInfo`. To retrieve product variants, use the Get Product method.
|
|
242
259
|
* > + To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
243
260
|
*/
|
|
244
|
-
(options?: QueryProductsOptions
|
|
261
|
+
(options?: QueryProductsOptions): ProductsQueryBuilder;
|
|
245
262
|
}
|
|
246
263
|
declare function countProducts$1(httpClient: HttpClient): CountProductsSignature;
|
|
247
264
|
interface CountProductsSignature {
|
|
248
265
|
/**
|
|
249
266
|
* Counts the number of products that match the provided filtering.
|
|
250
267
|
*/
|
|
251
|
-
(options?: CountProductsOptions
|
|
268
|
+
(options?: CountProductsOptions): Promise<NonNullablePaths<V3CountProductsResponse, `count`>>;
|
|
252
269
|
}
|
|
253
270
|
declare function bulkUpdateProductVariantsByFilter$1(httpClient: HttpClient): BulkUpdateProductVariantsByFilterSignature;
|
|
254
271
|
interface BulkUpdateProductVariantsByFilterSignature {
|
|
@@ -263,9 +280,9 @@ interface BulkUpdateProductVariantsByFilterSignature {
|
|
|
263
280
|
* + `physicalOptions`
|
|
264
281
|
* @param - Filter object.
|
|
265
282
|
*/
|
|
266
|
-
(filter: Record<string, any>, options?: BulkUpdateProductVariantsByFilterOptions
|
|
267
|
-
__applicationErrorsType?: BulkUpdateProductVariantsByFilterApplicationErrors
|
|
268
|
-
__validationErrorsType?: BulkUpdateProductVariantsByFilterValidationErrors
|
|
283
|
+
(filter: Record<string, any>, options?: NonNullablePaths<BulkUpdateProductVariantsByFilterOptions, `variant`>): Promise<NonNullablePaths<BulkUpdateProductVariantsByFilterResponse, `jobId`> & {
|
|
284
|
+
__applicationErrorsType?: BulkUpdateProductVariantsByFilterApplicationErrors;
|
|
285
|
+
__validationErrorsType?: BulkUpdateProductVariantsByFilterValidationErrors;
|
|
269
286
|
}>;
|
|
270
287
|
}
|
|
271
288
|
declare function bulkAdjustProductVariantsByFilter$1(httpClient: HttpClient): BulkAdjustProductVariantsByFilterSignature;
|
|
@@ -281,8 +298,8 @@ interface BulkAdjustProductVariantsByFilterSignature {
|
|
|
281
298
|
* + `compareAtPriceDiscount`
|
|
282
299
|
* @param - Filter object.
|
|
283
300
|
*/
|
|
284
|
-
(filter: Record<string, any>, options?: BulkAdjustProductVariantsByFilterOptions
|
|
285
|
-
__applicationErrorsType?: BulkAdjustProductVariantsByFilterApplicationErrors
|
|
301
|
+
(filter: Record<string, any>, options?: BulkAdjustProductVariantsByFilterOptions): Promise<NonNullablePaths<V3BulkAdjustProductVariantsByFilterResponse, `jobId`> & {
|
|
302
|
+
__applicationErrorsType?: BulkAdjustProductVariantsByFilterApplicationErrors;
|
|
286
303
|
}>;
|
|
287
304
|
}
|
|
288
305
|
declare function bulkAddInfoSectionsToProductsByFilter$1(httpClient: HttpClient): BulkAddInfoSectionsToProductsByFilterSignature;
|
|
@@ -291,8 +308,8 @@ interface BulkAddInfoSectionsToProductsByFilterSignature {
|
|
|
291
308
|
* Adds info sections to multiple products, given the provided filter and search expression.
|
|
292
309
|
* @param - Filter object.
|
|
293
310
|
*/
|
|
294
|
-
(filter: Record<string, any>, options?: BulkAddInfoSectionsToProductsByFilterOptions
|
|
295
|
-
__applicationErrorsType?: BulkAddInfoSectionsToProductsByFilterApplicationErrors
|
|
311
|
+
(filter: Record<string, any>, options?: NonNullablePaths<BulkAddInfoSectionsToProductsByFilterOptions, `infoSectionIds`>): Promise<NonNullablePaths<V3BulkAddInfoSectionsToProductsByFilterResponse, `jobId`> & {
|
|
312
|
+
__applicationErrorsType?: BulkAddInfoSectionsToProductsByFilterApplicationErrors;
|
|
296
313
|
}>;
|
|
297
314
|
}
|
|
298
315
|
declare function bulkAddInfoSectionsToProducts$1(httpClient: HttpClient): BulkAddInfoSectionsToProductsSignature;
|
|
@@ -301,8 +318,10 @@ interface BulkAddInfoSectionsToProductsSignature {
|
|
|
301
318
|
* Adds info sections to multiple products.
|
|
302
319
|
* @param - List of product IDs and revisions.
|
|
303
320
|
*/
|
|
304
|
-
(products: V3ProductIdWithRevision[], options?: BulkAddInfoSectionsToProductsOptions
|
|
305
|
-
|
|
321
|
+
(products: V3ProductIdWithRevision[], options?: NonNullablePaths<BulkAddInfoSectionsToProductsOptions, `infoSectionIds`>): Promise<NonNullablePaths<V3BulkAddInfoSectionsToProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
322
|
+
[P in ProductNonNullablePaths]: `results.${number}.item.${P}`;
|
|
323
|
+
}[ProductNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
|
|
324
|
+
__applicationErrorsType?: BulkAddInfoSectionsToProductsApplicationErrors;
|
|
306
325
|
}>;
|
|
307
326
|
}
|
|
308
327
|
declare function bulkRemoveInfoSectionsFromProductsByFilter$1(httpClient: HttpClient): BulkRemoveInfoSectionsFromProductsByFilterSignature;
|
|
@@ -311,7 +330,7 @@ interface BulkRemoveInfoSectionsFromProductsByFilterSignature {
|
|
|
311
330
|
* Removes info sections from multiple products, given the provided filter and search expression.
|
|
312
331
|
* @param - Filter object.
|
|
313
332
|
*/
|
|
314
|
-
(filter: Record<string, any>, options?: BulkRemoveInfoSectionsFromProductsByFilterOptions
|
|
333
|
+
(filter: Record<string, any>, options?: NonNullablePaths<BulkRemoveInfoSectionsFromProductsByFilterOptions, `infoSectionIds`>): Promise<NonNullablePaths<V3BulkRemoveInfoSectionsFromProductsByFilterResponse, `jobId`>>;
|
|
315
334
|
}
|
|
316
335
|
declare function bulkRemoveInfoSectionsFromProducts$1(httpClient: HttpClient): BulkRemoveInfoSectionsFromProductsSignature;
|
|
317
336
|
interface BulkRemoveInfoSectionsFromProductsSignature {
|
|
@@ -319,7 +338,9 @@ interface BulkRemoveInfoSectionsFromProductsSignature {
|
|
|
319
338
|
* Removes info sections from multiple products.
|
|
320
339
|
* @param - List of product IDs and revisions.
|
|
321
340
|
*/
|
|
322
|
-
(products: V3ProductIdWithRevision[], options?: BulkRemoveInfoSectionsFromProductsOptions
|
|
341
|
+
(products: V3ProductIdWithRevision[], options?: NonNullablePaths<BulkRemoveInfoSectionsFromProductsOptions, `infoSectionIds`>): Promise<NonNullablePaths<V3BulkRemoveInfoSectionsFromProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
|
|
342
|
+
[P in ProductNonNullablePaths]: `results.${number}.item.${P}`;
|
|
343
|
+
}[ProductNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
|
|
323
344
|
}
|
|
324
345
|
declare function bulkAddProductsToCategoriesByFilter$1(httpClient: HttpClient): BulkAddProductsToCategoriesByFilterSignature;
|
|
325
346
|
interface BulkAddProductsToCategoriesByFilterSignature {
|
|
@@ -328,7 +349,7 @@ interface BulkAddProductsToCategoriesByFilterSignature {
|
|
|
328
349
|
*
|
|
329
350
|
* Learn more about the [Categories API](https://dev.wix.com/docs/rest/business-management/categories/introduction).
|
|
330
351
|
*/
|
|
331
|
-
(options?: BulkAddProductsToCategoriesByFilterOptions
|
|
352
|
+
(options?: NonNullablePaths<BulkAddProductsToCategoriesByFilterOptions, `categoryIds`>): Promise<NonNullablePaths<BulkAddProductsToCategoriesByFilterResponse, `jobId`>>;
|
|
332
353
|
}
|
|
333
354
|
declare function bulkRemoveProductsFromCategoriesByFilter$1(httpClient: HttpClient): BulkRemoveProductsFromCategoriesByFilterSignature;
|
|
334
355
|
interface BulkRemoveProductsFromCategoriesByFilterSignature {
|
|
@@ -337,14 +358,14 @@ interface BulkRemoveProductsFromCategoriesByFilterSignature {
|
|
|
337
358
|
*
|
|
338
359
|
* Learn more about the [Categories API](https://dev.wix.com/docs/rest/business-management/categories/introduction).
|
|
339
360
|
*/
|
|
340
|
-
(options?: BulkRemoveProductsFromCategoriesByFilterOptions
|
|
361
|
+
(options?: NonNullablePaths<BulkRemoveProductsFromCategoriesByFilterOptions, `categoryIds`>): Promise<NonNullablePaths<BulkRemoveProductsFromCategoriesByFilterResponse, `jobId`>>;
|
|
341
362
|
}
|
|
342
363
|
declare function getAllProductsCategory$1(httpClient: HttpClient): GetAllProductsCategorySignature;
|
|
343
364
|
interface GetAllProductsCategorySignature {
|
|
344
365
|
/**
|
|
345
366
|
* Retrieves the id of "All Products" category which is automatically assigned to all products.
|
|
346
367
|
*/
|
|
347
|
-
(): Promise<GetAllProductsCategoryResponse
|
|
368
|
+
(): Promise<NonNullablePaths<GetAllProductsCategoryResponse, `categoryId` | `treeReference.appNamespace`>>;
|
|
348
369
|
}
|
|
349
370
|
declare const onProductCreated$1: EventDefinition<ProductCreatedEnvelope, "wix.stores.catalog.v3.product_created">;
|
|
350
371
|
declare const onProductDeleted$1: EventDefinition<ProductDeletedEnvelope, "wix.stores.catalog.v3.product_deleted">;
|