@wix/auto_sdk_stores_product-groups-v-3 1.0.0

package/build/internal/cjs/index.d.ts

@@ -0,0 +1,162 @@
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { P as ProductGroup, C as CreateProductGroupOptions, U as UpdateProductGroup, a as UpdateProductGroupOptions, G as GetProductGroupOptions, b as ProductGroupSearch, S as SearchProductGroupsOptions, c as SearchProductGroupsResponse, B as BulkCreateProductGroupsOptions, d as BulkCreateProductGroupsResponse, M as MaskedProductGroup, e as BulkUpdateProductGroupsOptions, f as BulkUpdateProductGroupsResponse, A as AssignProductsToProductGroupOptions, g as AssignProductsToProductGroupResponse, h as UnassignProductsFromProductGroupOptions, i as UnassignProductsFromProductGroupResponse, j as BulkDeleteProductGroupsResponse, k as BulkUpdateProductGroupTagsOptions, l as BulkUpdateProductGroupTagsResponse, m as BulkUpdateProductGroupTagsApplicationErrors, n as BulkUpdateProductGroupTagsByFilterOptions, o as BulkUpdateProductGroupTagsByFilterResponse, p as BulkUpdateProductGroupTagsByFilterApplicationErrors, q as ProductGroupQuery, Q as QueryProductGroupsOptions, t as typedQueryProductGroups, r as ProductGroupsQueryBuilder } from './stores-catalog-v3-product-group-product-groups-v-3.universal-4XnTTWRs.js';
+export { be as AccountInfo, b8 as ActionEvent, ah as Aggregation, au as AggregationData, ai as AggregationKindOneOf, aN as AggregationResults, aO as AggregationResultsResultOneOf, aB as AggregationResultsScalarResult, J as AggregationType, bw as AggregationTypeWithLiterals, aR as ApplicationError, aW as AssignProductsToProductGroupRequest, u as AvailabilityStatus, bk as AvailabilityStatusWithLiterals, aT as BulkActionMetadata, aP as BulkCreateProductGroupsRequest, a_ as BulkDeleteProductGroupsRequest, a$ as BulkDeleteProductGroupsResponseBulkProductGroupResult, aS as BulkProductGroupResult, ba as BulkUpdateProductGroupTagsByFilterRequest, b0 as BulkUpdateProductGroupTagsRequest, b1 as BulkUpdateProductGroupTagsResult, aU as BulkUpdateProductGroupsRequest, aV as BulkUpdateProductGroupsResponseBulkProductGroupResult, s as ChoiceType, bj as ChoiceTypeWithLiterals, bz as CommonQueryWithEntityContext, bA as CommonSearchWithEntityContext, _ as CreateProductGroupRequest, $ as CreateProductGroupResponse, aa as CursorPaging, ac as CursorPagingMetadata, a7 as CursorQuery, a8 as CursorQueryPagingMethodOneOf, af as CursorSearch, ag as CursorSearchPagingMethodOneOf, ad as Cursors, x as CustomizationRenderType, bn as CustomizationRenderTypeWithLiterals, w as CustomizationType, bm as CustomizationTypeWithLiterals, ap as DateHistogramAggregation, aJ as DateHistogramResult, aL as DateHistogramResults, a2 as DeleteProductGroupRequest, a3 as DeleteProductGroupResponse, b2 as DomainEvent, b3 as DomainEventBodyOneOf, b9 as Empty, b4 as EntityCreatedEvent, b7 as EntityDeletedEvent, b6 as EntityUpdatedEvent, V as ExtendedFields, a4 as GetProductGroupRequest, a5 as GetProductGroupResponse, aK as GroupByValueResults, T as GroupingCustomization, bc as IdentificationData, bd as IdentificationDataIdOneOf, ak as IncludeMissingValuesOptions, I as Interval, bv as IntervalWithLiterals, aQ as ItemMetadata, v as MembershipStatus, bl as MembershipStatusWithLiterals, bb as MessageEnvelope, F as MissingValues, bs as MissingValuesWithLiterals, K as Mode, bx as ModeWithLiterals, as as NestedAggregation, aq as NestedAggregationItem, ar as NestedAggregationItemKindOneOf, ax as NestedAggregationResults, ay as NestedAggregationResultsResultOneOf, N as NestedAggregationType, bu as NestedAggregationTypeWithLiterals, aG as NestedResultValue, aH as NestedResultValueResultOneOf, aM as NestedResults, aC as NestedValueAggregationResult, aX as ProductAssignmentResult, O as ProductChoice, R as ProductChoiceValueOneOf, L as ProductGroupMember, bg as ProductGroupQuerySpec, y as ProductGroupRequestedFields, bo as ProductGroupRequestedFieldsWithLiterals, bh as ProductGroupSearchSpec, Z as ProductGroupTagsModified, bf as ProductGroupsQueryResult, aZ as ProductUnassignmentResult, a6 as QueryProductGroupsRequest, ab as QueryProductGroupsResponse, an as RangeAggregation, aw as RangeAggregationResult, aj as RangeBucket, aE as RangeResult, aA as RangeResults, b5 as RestoreInfo, aI as Results, ao as ScalarAggregation, aF as ScalarResult, H as ScalarType, bt as ScalarTypeWithLiterals, at as SearchDetails, ae as SearchProductGroupsRequest, E as SortDirection, br as SortDirectionWithLiterals, z as SortOrder, bp as SortOrderWithLiterals, D as SortType, bq as SortTypeWithLiterals, a9 as Sorting, Y as TagList, X as Tags, aY as UnassignProductsFromProductGroupRequest, a0 as UpdateProductGroupRequest, a1 as UpdateProductGroupResponse, al as ValueAggregation, am as ValueAggregationOptionsOneOf, av as ValueAggregationResult, aD as ValueResult, az as ValueResults, W as WebhookIdentityType, by as WebhookIdentityTypeWithLiterals, bi as utils } from './stores-catalog-v3-product-group-product-groups-v-3.universal-4XnTTWRs.js';
+
+/** @internal */
+declare function createProductGroup$1(httpClient: HttpClient): CreateProductGroupSignature;
+interface CreateProductGroupSignature {
+    /**
+     * Creates a new product group.
+     * @param - The product group to create.
+     * @returns The created product group.
+     */
+    (productGroup: NonNullablePaths<ProductGroup, `groupingCustomizationId` | `name`, 2>, options?: CreateProductGroupOptions): Promise<NonNullablePaths<ProductGroup, `choiceOrder` | `members` | `members.${number}.productId` | `members.${number}.choice.colorCode` | `members.${number}.choice._id` | `members.${number}.choice.choiceType` | `members.${number}.choice.name` | `members.${number}.inventoryAvailabilityStatus` | `members.${number}.status` | `groupingCustomization.name` | `groupingCustomization.customizationType` | `groupingCustomization.customizationRenderType` | `tags.privateTags.tagIds`, 5>>;
+}
+/** @internal */
+declare function updateProductGroup$1(httpClient: HttpClient): UpdateProductGroupSignature;
+interface UpdateProductGroupSignature {
+    /**
+     * Updates a product group.
+     * Each time the product group is updated, `revision` increments by 1.
+     * The current `revision` must be passed when updating the product group.
+     * This ensures you're working with the latest product group and prevents unintended overwrites.
+     * @param - Product group ID.
+     * @returns The updated product group.
+     */
+    (_id: string, productGroup: NonNullablePaths<UpdateProductGroup, `revision`, 2>, options?: UpdateProductGroupOptions): Promise<NonNullablePaths<ProductGroup, `choiceOrder` | `members` | `members.${number}.productId` | `members.${number}.choice.colorCode` | `members.${number}.choice._id` | `members.${number}.choice.choiceType` | `members.${number}.choice.name` | `members.${number}.inventoryAvailabilityStatus` | `members.${number}.status` | `groupingCustomization.name` | `groupingCustomization.customizationType` | `groupingCustomization.customizationRenderType` | `tags.privateTags.tagIds`, 5>>;
+}
+/** @internal */
+declare function deleteProductGroup$1(httpClient: HttpClient): DeleteProductGroupSignature;
+interface DeleteProductGroupSignature {
+    /**
+     * Deletes a product group.
+     * @param - ID of the product group to delete.
+     */
+    (productGroupId: string): Promise<void>;
+}
+/** @internal */
+declare function getProductGroup$1(httpClient: HttpClient): GetProductGroupSignature;
+interface GetProductGroupSignature {
+    /**
+     * Retrieves a product group by ID.
+     * Without `read_non_visible` permission, members with status `HIDDEN` or `OUT_OF_SYNC` are filtered out.
+     * @param - ID of the product group to retrieve.
+     * @returns The requested product group.
+     */
+    (productGroupId: string, options?: GetProductGroupOptions): Promise<NonNullablePaths<ProductGroup, `choiceOrder` | `members` | `members.${number}.productId` | `members.${number}.choice.colorCode` | `members.${number}.choice._id` | `members.${number}.choice.choiceType` | `members.${number}.choice.name` | `members.${number}.inventoryAvailabilityStatus` | `members.${number}.status` | `groupingCustomization.name` | `groupingCustomization.customizationType` | `groupingCustomization.customizationRenderType` | `tags.privateTags.tagIds`, 5>>;
+}
+/** @internal */
+declare function searchProductGroups$1(httpClient: HttpClient): SearchProductGroupsSignature;
+interface SearchProductGroupsSignature {
+    /**
+     * Searches product groups using [WQL - Wix Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) with full-text search support.
+     * Without `read_non_visible` permission, members with status `HIDDEN` or `OUT_OF_SYNC` are filtered out.
+     * @param - WQL search — filter, free-text search, sort, and cursor-based paging.
+     */
+    (search: ProductGroupSearch, options?: SearchProductGroupsOptions): Promise<NonNullablePaths<SearchProductGroupsResponse, `productGroups` | `productGroups.${number}.groupingCustomization.name` | `productGroups.${number}.groupingCustomization.customizationType` | `productGroups.${number}.groupingCustomization.customizationRenderType` | `aggregationData.results` | `aggregationData.results.${number}.scalar.type` | `aggregationData.results.${number}.scalar.value` | `aggregationData.results.${number}.name` | `aggregationData.results.${number}.type` | `aggregationData.results.${number}.fieldPath` | `fields`, 6>>;
+}
+/** @internal */
+declare function bulkCreateProductGroups$1(httpClient: HttpClient): BulkCreateProductGroupsSignature;
+interface BulkCreateProductGroupsSignature {
+    /**
+     * Creates multiple product groups in a single request.
+     * @param - List of product groups to create.
+     */
+    (productGroups: NonNullablePaths<ProductGroup, `groupingCustomizationId` | `name`, 2>[], options?: BulkCreateProductGroupsOptions): Promise<NonNullablePaths<BulkCreateProductGroupsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.groupingCustomization.name` | `results.${number}.item.groupingCustomization.customizationType` | `results.${number}.item.groupingCustomization.customizationRenderType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures` | `fields`, 6>>;
+}
+/** @internal */
+declare function bulkUpdateProductGroups$1(httpClient: HttpClient): BulkUpdateProductGroupsSignature;
+interface BulkUpdateProductGroupsSignature {
+    /**
+     * Updates multiple product groups in a single request.
+     * Each item carries its own `field_mask` to allow partial updates per item.
+     * The current `revision` must be passed for each product group to prevent conflicting changes.
+     * @param - List of product groups to update, each with its own field mask.
+     */
+    (productGroups: NonNullablePaths<MaskedProductGroup, `productGroup._id` | `productGroup.revision`, 3>[], options?: BulkUpdateProductGroupsOptions): Promise<NonNullablePaths<BulkUpdateProductGroupsResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.groupingCustomization.name` | `results.${number}.item.groupingCustomization.customizationType` | `results.${number}.item.groupingCustomization.customizationRenderType` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+/** @internal */
+declare function assignProductsToProductGroup$1(httpClient: HttpClient): AssignProductsToProductGroupSignature;
+interface AssignProductsToProductGroupSignature {
+    /**
+     * Assigns multiple products to a product group in a single request.
+     * @param - ID of the product group to assign products to.
+     */
+    (productGroupId: string, options: NonNullablePaths<AssignProductsToProductGroupOptions, `productIds`, 2>): Promise<NonNullablePaths<AssignProductsToProductGroupResponse, `results` | `results.${number}.productId` | `results.${number}.success` | `results.${number}.error.code` | `results.${number}.error.description`, 5>>;
+}
+/** @internal */
+declare function unassignProductsFromProductGroup$1(httpClient: HttpClient): UnassignProductsFromProductGroupSignature;
+interface UnassignProductsFromProductGroupSignature {
+    /**
+     * Removes multiple products from a product group in a single request.
+     * @param - ID of the product group to unassign products from.
+     */
+    (productGroupId: string, options: NonNullablePaths<UnassignProductsFromProductGroupOptions, `productIds`, 2>): Promise<NonNullablePaths<UnassignProductsFromProductGroupResponse, `results` | `results.${number}.productId` | `results.${number}.success` | `results.${number}.error.code` | `results.${number}.error.description`, 5>>;
+}
+/** @internal */
+declare function bulkDeleteProductGroups$1(httpClient: HttpClient): BulkDeleteProductGroupsSignature;
+interface BulkDeleteProductGroupsSignature {
+    /**
+     * Deletes multiple product groups in a single request.
+     * @param - IDs of the product groups to delete.
+     */
+    (productGroupIds: string[]): Promise<NonNullablePaths<BulkDeleteProductGroupsResponse, `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>>;
+}
+/** @internal */
+declare function bulkUpdateProductGroupTags$1(httpClient: HttpClient): BulkUpdateProductGroupTagsSignature;
+interface BulkUpdateProductGroupTagsSignature {
+    /**
+     * Synchronously update tags on multiple product groups, by list of product group IDs.
+     * A tag that appears both in the list of assign and unassign tags, will be assigned.
+     * @param - List of product group IDs whose tags will be updated.
+     */
+    (productGroupIds: string[], options?: BulkUpdateProductGroupTagsOptions): Promise<NonNullablePaths<BulkUpdateProductGroupTagsResponse, `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?: BulkUpdateProductGroupTagsApplicationErrors;
+    }>;
+}
+/** @internal */
+declare function bulkUpdateProductGroupTagsByFilter$1(httpClient: HttpClient): BulkUpdateProductGroupTagsByFilterSignature;
+interface BulkUpdateProductGroupTagsByFilterSignature {
+    /**
+     * Asynchronously update tags on multiple product groups, by provided filter.
+     * An empty filter will update all product groups.
+     * A tag that appears both in the list of assign and unassign tags, will be assigned.
+     * @param - Filter object. Supported fields for filtering: `id`, `handle`.
+     * Pass an empty object `{}` to target all product groups.
+     */
+    (filter: Record<string, any>, options?: BulkUpdateProductGroupTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateProductGroupTagsByFilterResponse, `jobId`, 2> & {
+        __applicationErrorsType?: BulkUpdateProductGroupTagsByFilterApplicationErrors;
+    }>;
+}
+
+declare function customQueryProductGroups(httpClient: HttpClient): {
+    (query: ProductGroupQuery, options?: QueryProductGroupsOptions): ReturnType<typeof typedQueryProductGroups>;
+    (options?: QueryProductGroupsOptions): ProductGroupsQueryBuilder;
+};
+/** @internal */
+declare const createProductGroup: MaybeContext<BuildRESTFunction<typeof createProductGroup$1> & typeof createProductGroup$1>;
+/** @internal */
+declare const updateProductGroup: MaybeContext<BuildRESTFunction<typeof updateProductGroup$1> & typeof updateProductGroup$1>;
+/** @internal */
+declare const deleteProductGroup: MaybeContext<BuildRESTFunction<typeof deleteProductGroup$1> & typeof deleteProductGroup$1>;
+/** @internal */
+declare const getProductGroup: MaybeContext<BuildRESTFunction<typeof getProductGroup$1> & typeof getProductGroup$1>;
+/** @internal */
+declare const searchProductGroups: MaybeContext<BuildRESTFunction<typeof searchProductGroups$1> & typeof searchProductGroups$1>;
+/** @internal */
+declare const bulkCreateProductGroups: MaybeContext<BuildRESTFunction<typeof bulkCreateProductGroups$1> & typeof bulkCreateProductGroups$1>;
+/** @internal */
+declare const bulkUpdateProductGroups: MaybeContext<BuildRESTFunction<typeof bulkUpdateProductGroups$1> & typeof bulkUpdateProductGroups$1>;
+/** @internal */
+declare const assignProductsToProductGroup: MaybeContext<BuildRESTFunction<typeof assignProductsToProductGroup$1> & typeof assignProductsToProductGroup$1>;
+/** @internal */
+declare const unassignProductsFromProductGroup: MaybeContext<BuildRESTFunction<typeof unassignProductsFromProductGroup$1> & typeof unassignProductsFromProductGroup$1>;
+/** @internal */
+declare const bulkDeleteProductGroups: MaybeContext<BuildRESTFunction<typeof bulkDeleteProductGroups$1> & typeof bulkDeleteProductGroups$1>;
+/** @internal */
+declare const bulkUpdateProductGroupTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateProductGroupTags$1> & typeof bulkUpdateProductGroupTags$1>;
+/** @internal */
+declare const bulkUpdateProductGroupTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateProductGroupTagsByFilter$1> & typeof bulkUpdateProductGroupTagsByFilter$1>;
+declare const queryProductGroups: MaybeContext<BuildRESTFunction<typeof customQueryProductGroups> & typeof customQueryProductGroups>;
+
+export { AssignProductsToProductGroupOptions, AssignProductsToProductGroupResponse, BulkCreateProductGroupsOptions, BulkCreateProductGroupsResponse, BulkDeleteProductGroupsResponse, BulkUpdateProductGroupTagsApplicationErrors, BulkUpdateProductGroupTagsByFilterApplicationErrors, BulkUpdateProductGroupTagsByFilterOptions, BulkUpdateProductGroupTagsByFilterResponse, BulkUpdateProductGroupTagsOptions, BulkUpdateProductGroupTagsResponse, BulkUpdateProductGroupsOptions, BulkUpdateProductGroupsResponse, CreateProductGroupOptions, GetProductGroupOptions, MaskedProductGroup, ProductGroup, ProductGroupQuery, ProductGroupSearch, ProductGroupsQueryBuilder, QueryProductGroupsOptions, SearchProductGroupsOptions, SearchProductGroupsResponse, UnassignProductsFromProductGroupOptions, UnassignProductsFromProductGroupResponse, UpdateProductGroup, UpdateProductGroupOptions, assignProductsToProductGroup, bulkCreateProductGroups, bulkDeleteProductGroups, bulkUpdateProductGroupTags, bulkUpdateProductGroupTagsByFilter, bulkUpdateProductGroups, createProductGroup, deleteProductGroup, getProductGroup, queryProductGroups, searchProductGroups, unassignProductsFromProductGroup, updateProductGroup };