@wix/auto_sdk_suppliers-hub_products 1.0.0

package/build/cjs/index.d.ts

@@ -0,0 +1,175 @@
+import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { P as Product, U as UpdateProduct, B as BulkCreateProductsOptions, a as BulkCreateProductsResponse, M as MaskedProduct, b as BulkUpdateProductsOptions, c as BulkUpdateProductsResponse, d as BulkDeleteProductsResponse, e as ProductSearch, S as SearchProductsResponse, f as BulkUpdateProductTagsOptions, g as BulkUpdateProductTagsResponse, h as BulkUpdateProductTagsApplicationErrors, i as BulkUpdateProductTagsByFilterOptions, j as BulkUpdateProductTagsByFilterResponse, k as BulkUpdateProductTagsByFilterApplicationErrors, Q as QueryCategoriesOptions, l as QueryCategoriesResponse, m as ProductCreatedEnvelope, n as ProductDeletedEnvelope, o as ProductTagsModifiedEnvelope, p as ProductUpdatedEnvelope, q as ProductsQueryBuilder, r as ProductQuery, t as typedQueryProducts } from './suppliershub-marketplace-product-v1-product-products.universal-DInaBID7.js';
+export { bG as AccountInfo, bJ as AccountInfoMetadata, bB as ActionEvent, aI as Aggregation, aV as AggregationData, aJ as AggregationKindOneOf, bc as AggregationResults, bd as AggregationResultsResultOneOf, b0 as AggregationResultsScalarResult, F as AggregationType, c1 as AggregationTypeWithLiterals, aq as ApplicationError, bH as BaseEventMetadata, bn as Breadcrumb, as as BulkActionMetadata, bu as BulkAddProductToStoreResult, br as BulkAddProductsToStoreRequest, bt as BulkAddProductsToStoreResponse, ao as BulkCreateProductsRequest, av as BulkDeleteProductsRequest, aw as BulkDeleteProductsResponseBulkProductResult, ar as BulkProductResult, bg as BulkUpdateProductTagsByFilterRequest, be as BulkUpdateProductTagsRequest, bf as BulkUpdateProductTagsResult, at as BulkUpdateProductsRequest, au as BulkUpdateProductsResponseBulkProductResult, bm as Category, u as CategoryNamespace, bS as CategoryNamespaceWithLiterals, Y as ColorOption, aB as CommonCursorPaging, aD as CommonCursorPagingMetadata, ay as CommonCursorQuery, az as CommonCursorQueryPagingMethodOneOf, aE as CommonCursors, c5 as CommonQueryWithEntityContext, c6 as CommonSearchWithEntityContext, x as CommonSortOrder, bW as CommonSortOrderWithLiterals, aA as CommonSorting, a1 as Countries, C as CountrySelections, bQ as CountrySelectionsWithLiterals, ag as CreateProductRequest, ah as CreateProductResponse, bl as CursorPaging, bp as CursorPagingMetadata, bi as CursorQuery, bj as CursorQueryPagingMethodOneOf, aG as CursorSearch, aH as CursorSearchPagingMethodOneOf, bq as Cursors, aQ as DateHistogramAggregation, b8 as DateHistogramResult, ba as DateHistogramResults, am as DeleteProductRequest, an as DeleteProductResponse, bv as DomainEvent, bw as DomainEventBodyOneOf, bC as Empty, bx as EntityCreatedEvent, bA as EntityDeletedEvent, bz as EntityUpdatedEvent, bI as EventMetadata, L as FocalPoint, ai as GetProductRequest, aj as GetProductResponse, b9 as GroupByValueResults, bE as IdentificationData, bF as IdentificationDataIdOneOf, aL as IncludeMissingValuesOptions, E as Interval, c0 as IntervalWithLiterals, a2 as Inventory, I as InventoryTier, bR as InventoryTierWithLiterals, ap as ItemMetadata, aa as Measurement, w as MeasurementUnit, bU as MeasurementUnitWithLiterals, ab as MeasurementValueOneOf, ac as MeasurementValueRange, K as Media, bD as MessageEnvelope, A as MissingValues, bZ as MissingValuesWithLiterals, G as Mode, c2 as ModeWithLiterals, aT as NestedAggregation, aR as NestedAggregationItem, aS as NestedAggregationItemKindOneOf, aY as NestedAggregationResults, aZ as NestedAggregationResultsResultOneOf, N as NestedAggregationType, b$ as NestedAggregationTypeWithLiterals, b5 as NestedResultValue, b6 as NestedResultValueResultOneOf, bb as NestedResults, b1 as NestedValueAggregationResult, V as OptionValue, X as OptionValueValueOneOf, bo as ParentCategory, a5 as PriceTier, a7 as PrintOnDemandOptions, v as PrintTechnology, bT as PrintTechnologyWithLiterals, a3 as ProductCategory, O as ProductOption, bL as ProductQuerySpec, bs as ProductReference, bM as ProductSearchSpec, s as ProductType, bO as ProductTypeWithLiterals, bK as ProductsQueryResult, J as ProviderInfo, bh as QueryCategoriesRequest, ax as QueryProductsRequest, aC as QueryProductsResponse, aO as RangeAggregation, aX as RangeAggregationResult, aK as RangeBucket, b3 as RangeResult, a$ as RangeResults, R as RequestedField, bV as RequestedFieldWithLiterals, by as RestoreInfo, b7 as Results, aP as ScalarAggregation, b4 as ScalarResult, D as ScalarType, b_ as ScalarTypeWithLiterals, aU as SearchDetails, aF as SearchProductsRequest, $ as ShippingDestination, a0 as ShippingDestinationCountriesOptionsOneOf, a8 as SizeGuide, z as SortDirection, bY as SortDirectionWithLiterals, H as SortOrder, c3 as SortOrderWithLiterals, y as SortType, bX as SortTypeWithLiterals, bk as Sorting, a9 as Specification, a6 as SupplierInfo, ae as TagList, ad as Tags, af as TagsModified, Z as TimeInterval, T as TimeUnit, bP as TimeUnitWithLiterals, _ as TimeValue, ak as UpdateProductRequest, al as UpdateProductResponse, aM as ValueAggregation, aN as ValueAggregationOptionsOneOf, aW as ValueAggregationResult, b2 as ValueResult, a_ as ValueResults, W as WebhookIdentityType, c4 as WebhookIdentityTypeWithLiterals, a4 as WholesaleOptions, bN as utils } from './suppliershub-marketplace-product-v1-product-products.universal-DInaBID7.js';
+
+declare function createProduct$1(httpClient: HttpClient): CreateProductSignature;
+interface CreateProductSignature {
+    /**
+     * Creates a product in the Marketplace.
+     *
+     * Products must include all required fields for the specified types.
+     * The first image in `media.items` becomes the main image.
+     * @param - Product to create. Must include all required fields for the specified product types.
+     * @returns Created product with assigned ID and read-only fields populated.
+     */
+    (product: NonNullablePaths<Product, `directCategories.${number}._id` | `directCategories.${number}.namespace` | `media` | `minimumPrice` | `name` | `options.${number}.name` | `options.${number}.values` | `providerInfo` | `providerInfo.productId` | `shippingDestinations.${number}.minimumShippingCost` | `types` | `wholesaleOptions.priceTiers.${number}.countFrom` | `wholesaleOptions.priceTiers.${number}.priceFrom`, 5>): Promise<NonNullablePaths<Product, `media.items` | `types` | `options` | `options.${number}.name` | `orderProcessingTime.min.value` | `orderProcessingTime.min.unit` | `shippingDestinations` | `shippingDestinations.${number}.countrySelections` | `shippingDestinations.${number}.minimumShippingCost` | `directCategories` | `directCategories.${number}._id` | `directCategories.${number}.namespace` | `allCategories` | `wholesaleOptions.priceTiers` | `wholesaleOptions.priceTiers.${number}.priceFrom` | `supplierInfo.verified` | `printOnDemandOptions.printTechnologies` | `sizeGuides` | `sizeGuides.${number}.measurementUnit` | `tags.privateTags.tagIds`, 5>>;
+}
+declare function getProduct$1(httpClient: HttpClient): GetProductSignature;
+interface GetProductSignature {
+    /**
+     * Retrieves a product by ID.
+     * @param - Product ID.
+     * @returns Retrieved product.
+     */
+    (productId: string): Promise<NonNullablePaths<Product, `media.items` | `types` | `options` | `options.${number}.name` | `orderProcessingTime.min.value` | `orderProcessingTime.min.unit` | `shippingDestinations` | `shippingDestinations.${number}.countrySelections` | `shippingDestinations.${number}.minimumShippingCost` | `directCategories` | `directCategories.${number}._id` | `directCategories.${number}.namespace` | `allCategories` | `wholesaleOptions.priceTiers` | `wholesaleOptions.priceTiers.${number}.priceFrom` | `supplierInfo.verified` | `printOnDemandOptions.printTechnologies` | `sizeGuides` | `sizeGuides.${number}.measurementUnit` | `tags.privateTags.tagIds`, 5>>;
+}
+declare function updateProduct$1(httpClient: HttpClient): UpdateProductSignature;
+interface UpdateProductSignature {
+    /**
+     * Updates a product. Supports partial updates.
+     *
+     * Provider info fields (`providerInfo.productId` and `providerInfo.productCreatedDate`) are immutable and cannot be
+     * changed after creation.
+     * @param - Product ID.
+     * @returns Updated product.
+     */
+    (_id: string, product: NonNullablePaths<UpdateProduct, `directCategories.${number}._id` | `directCategories.${number}.namespace`, 4>): Promise<NonNullablePaths<Product, `media.items` | `types` | `options` | `options.${number}.name` | `orderProcessingTime.min.value` | `orderProcessingTime.min.unit` | `shippingDestinations` | `shippingDestinations.${number}.countrySelections` | `shippingDestinations.${number}.minimumShippingCost` | `directCategories` | `directCategories.${number}._id` | `directCategories.${number}.namespace` | `allCategories` | `wholesaleOptions.priceTiers` | `wholesaleOptions.priceTiers.${number}.priceFrom` | `supplierInfo.verified` | `printOnDemandOptions.printTechnologies` | `sizeGuides` | `sizeGuides.${number}.measurementUnit` | `tags.privateTags.tagIds`, 5>>;
+}
+declare function deleteProduct$1(httpClient: HttpClient): DeleteProductSignature;
+interface DeleteProductSignature {
+    /**
+     * Deletes a product permanently from the Marketplace.
+     *
+     * This action cannot be undone. The product will no longer be available for store owners to add to their stores.
+     * @param - Product ID.
+     */
+    (productId: string): Promise<void>;
+}
+declare function bulkCreateProducts$1(httpClient: HttpClient): BulkCreateProductsSignature;
+interface BulkCreateProductsSignature {
+    /**
+     * Creates multiple products in a single request.
+     *
+     * Supports partial success - some products may be created successfully while others fail.
+     * Each result includes an `itemMetadata` object indicating success or failure with error details.
+     *
+     * When handling failures, distinguish between validation errors which shouldn't be retried,
+     * and transient errors which can be retried. Only retry failed items, not the entire batch.
+     * @param - Products to create. Each must include all required fields for the specified product types.
+     */
+    (products: NonNullablePaths<Product, `directCategories.${number}._id` | `directCategories.${number}.namespace` | `media` | `minimumPrice` | `name` | `options.${number}.name` | `options.${number}.values` | `providerInfo` | `providerInfo.productId` | `shippingDestinations.${number}.minimumShippingCost` | `types` | `wholesaleOptions.priceTiers.${number}.countFrom` | `wholesaleOptions.priceTiers.${number}.priceFrom`, 5>[], options?: BulkCreateProductsOptions): Promise<NonNullablePaths<BulkCreateProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.supplierInfo.verified` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function bulkUpdateProducts$1(httpClient: HttpClient): BulkUpdateProductsSignature;
+interface BulkUpdateProductsSignature {
+    /**
+     * Updates multiple products in a single request.
+     *
+     * Supports partial success and partial field updates. Each result includes an `itemMetadata` object indicating success or failure with error details.
+     *
+     * When handling failures, distinguish between validation errors which shouldn't be retried,
+     * and transient errors which can be retried. Only retry failed items, not the entire batch.
+     * @param - Products to update. Each can be partial based on its field mask.
+     */
+    (products: NonNullablePaths<MaskedProduct, `product._id` | `product.directCategories.${number}._id` | `product.directCategories.${number}.namespace`, 5>[], options?: BulkUpdateProductsOptions): Promise<NonNullablePaths<BulkUpdateProductsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.supplierInfo.verified` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function bulkDeleteProducts$1(httpClient: HttpClient): BulkDeleteProductsSignature;
+interface BulkDeleteProductsSignature {
+    /**
+     * Deletes multiple products permanently in a single request. Supports partial success.
+     *
+     * Each result includes an `itemMetadata` object indicating success or failure with error details.
+     * When handling failures, distinguish between validation errors which shouldn't be retried,
+     * and transient errors which can be retried. Only retry failed items, not the entire batch.
+     * @param - Product IDs to delete.
+     */
+    (productIds: string[]): Promise<NonNullablePaths<BulkDeleteProductsResponse, `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`, 6>>;
+}
+declare function searchProducts$1(httpClient: HttpClient): SearchProductsSignature;
+interface SearchProductsSignature {
+    /**
+     * Retrieves a list of products, given the provided filtering, search expression, sorting, and cursor paging.
+     *
+     * Provides eventually consistent results optimized for product discovery and browsing.
+     * Search supports full-text queries, filters, sorting, and aggregations for faceted search.
+     *
+     * Use Search Products for user-facing product catalogs and discovery features.
+     * For real-time accuracy in operational tasks, use [Query Products](https://dev.wix.com/docs/api-reference/business-solutions/suppliers-hub/products/query-products) instead.
+     * @param - Search parameters including filter, sort, full-text search, and aggregations.
+     */
+    (search: ProductSearch): Promise<NonNullablePaths<SearchProductsResponse, `products` | `products.${number}.orderProcessingTime.min.value` | `products.${number}.orderProcessingTime.min.unit` | `products.${number}.supplierInfo.verified` | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath`, 6>>;
+}
+declare function bulkUpdateProductTags$1(httpClient: HttpClient): BulkUpdateProductTagsSignature;
+interface BulkUpdateProductTagsSignature {
+    /**
+     * Updates tags on multiple products by product IDs.
+     *
+     * A tag that appears both in the list of assign and unassign tags, will be assigned
+     * @param - Product IDs to update tags for.
+     */
+    (productIds: string[], options?: BulkUpdateProductTagsOptions): Promise<NonNullablePaths<BulkUpdateProductTagsResponse, `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`, 6> & {
+        __applicationErrorsType?: BulkUpdateProductTagsApplicationErrors;
+    }>;
+}
+declare function bulkUpdateProductTagsByFilter$1(httpClient: HttpClient): BulkUpdateProductTagsByFilterSignature;
+interface BulkUpdateProductTagsByFilterSignature {
+    /**
+     * Updates tags on multiple products matching a filter.
+     *
+     * This operation runs asynchronously because it can potentially affect thousands of products.
+     * The response includes a `jobId` for tracking the operation's progress.
+     *
+     * An empty filter updates all products. If a tag appears in both assign and unassign lists, it will be assigned.
+     * @param - Filter to select products for tag updates. Empty filter updates all products.
+     */
+    (filter: Record<string, any>, options?: BulkUpdateProductTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateProductTagsByFilterResponse, `jobId`, 2> & {
+        __applicationErrorsType?: BulkUpdateProductTagsByFilterApplicationErrors;
+    }>;
+}
+declare function queryCategories$1(httpClient: HttpClient): QueryCategoriesSignature;
+interface QueryCategoriesSignature {
+    /**
+     * Queries categories using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+     *
+     * Supports filtering, sorting, and pagination.
+     */
+    (options?: NonNullablePaths<QueryCategoriesOptions, `namespace`, 2>): Promise<NonNullablePaths<QueryCategoriesResponse, `categories` | `categories.${number}.itemCount`, 4>>;
+}
+declare const onProductCreated$1: EventDefinition<ProductCreatedEnvelope, "wix.suppliershub.marketplace_product.v1.product_created">;
+declare const onProductDeleted$1: EventDefinition<ProductDeletedEnvelope, "wix.suppliershub.marketplace_product.v1.product_deleted">;
+declare const onProductTagsModified$1: EventDefinition<ProductTagsModifiedEnvelope, "wix.suppliershub.marketplace_product.v1.product_tags_modified">;
+declare const onProductUpdated$1: EventDefinition<ProductUpdatedEnvelope, "wix.suppliershub.marketplace_product.v1.product_updated">;
+
+declare function customQueryProducts(httpClient: HttpClient): {
+    (): ProductsQueryBuilder;
+    (query: ProductQuery): ReturnType<typeof typedQueryProducts>;
+};
+declare const createProduct: MaybeContext<BuildRESTFunction<typeof createProduct$1> & typeof createProduct$1>;
+declare const getProduct: MaybeContext<BuildRESTFunction<typeof getProduct$1> & typeof getProduct$1>;
+declare const updateProduct: MaybeContext<BuildRESTFunction<typeof updateProduct$1> & typeof updateProduct$1>;
+declare const deleteProduct: MaybeContext<BuildRESTFunction<typeof deleteProduct$1> & typeof deleteProduct$1>;
+declare const bulkCreateProducts: MaybeContext<BuildRESTFunction<typeof bulkCreateProducts$1> & typeof bulkCreateProducts$1>;
+declare const bulkUpdateProducts: MaybeContext<BuildRESTFunction<typeof bulkUpdateProducts$1> & typeof bulkUpdateProducts$1>;
+declare const bulkDeleteProducts: MaybeContext<BuildRESTFunction<typeof bulkDeleteProducts$1> & typeof bulkDeleteProducts$1>;
+declare const searchProducts: MaybeContext<BuildRESTFunction<typeof searchProducts$1> & typeof searchProducts$1>;
+declare const bulkUpdateProductTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateProductTags$1> & typeof bulkUpdateProductTags$1>;
+declare const bulkUpdateProductTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateProductTagsByFilter$1> & typeof bulkUpdateProductTagsByFilter$1>;
+declare const queryCategories: MaybeContext<BuildRESTFunction<typeof queryCategories$1> & typeof queryCategories$1>;
+declare const queryProducts: MaybeContext<BuildRESTFunction<typeof customQueryProducts> & typeof customQueryProducts>;
+/**
+ * Triggered when a product is created.
+ */
+declare const onProductCreated: BuildEventDefinition<typeof onProductCreated$1> & typeof onProductCreated$1;
+/**
+ * Triggered when a product is deleted.
+ */
+declare const onProductDeleted: BuildEventDefinition<typeof onProductDeleted$1> & typeof onProductDeleted$1;
+/**
+ * Triggered when product tags are modified.
+ */
+declare const onProductTagsModified: BuildEventDefinition<typeof onProductTagsModified$1> & typeof onProductTagsModified$1;
+/**
+ * Triggered when a product is updated.
+ */
+declare const onProductUpdated: BuildEventDefinition<typeof onProductUpdated$1> & typeof onProductUpdated$1;
+
+export { BulkCreateProductsOptions, BulkCreateProductsResponse, BulkDeleteProductsResponse, BulkUpdateProductTagsApplicationErrors, BulkUpdateProductTagsByFilterApplicationErrors, BulkUpdateProductTagsByFilterOptions, BulkUpdateProductTagsByFilterResponse, BulkUpdateProductTagsOptions, BulkUpdateProductTagsResponse, BulkUpdateProductsOptions, BulkUpdateProductsResponse, MaskedProduct, Product, ProductCreatedEnvelope, ProductDeletedEnvelope, ProductQuery, ProductSearch, ProductTagsModifiedEnvelope, ProductUpdatedEnvelope, ProductsQueryBuilder, QueryCategoriesOptions, QueryCategoriesResponse, SearchProductsResponse, UpdateProduct, bulkCreateProducts, bulkDeleteProducts, bulkUpdateProductTags, bulkUpdateProductTagsByFilter, bulkUpdateProducts, createProduct, deleteProduct, getProduct, onProductCreated, onProductDeleted, onProductTagsModified, onProductUpdated, queryCategories, queryProducts, searchProducts, updateProduct };