@wix/auto_sdk_suppliers-hub_suppliers 1.0.13 → 1.0.14

package/build/cjs/index.d.ts

@@ -1,11 +1,126 @@
-import { MaybeContext, BuildRESTFunction, HttpClient } from '@wix/sdk-types';
-import { SuppliersQueryBuilder, SupplierQuery, typedQuerySuppliers } from './index.typings.js';
-export { AccountInfo, ActionEvent, ApplicationError, BulkActionMetadata, BulkCreateSuppliersOptions, BulkCreateSuppliersRequest, BulkCreateSuppliersResponse, BulkDeleteSuppliersRequest, BulkDeleteSuppliersResponse, BulkDeleteSuppliersResponseBulkSupplierResult, BulkSupplierResult, BulkUpdateSupplierTagsApplicationErrors, BulkUpdateSupplierTagsByFilterApplicationErrors, BulkUpdateSupplierTagsByFilterOptions, BulkUpdateSupplierTagsByFilterRequest, BulkUpdateSupplierTagsByFilterResponse, BulkUpdateSupplierTagsOptions, BulkUpdateSupplierTagsRequest, BulkUpdateSupplierTagsResponse, BulkUpdateSupplierTagsResult, BulkUpdateSuppliersOptions, BulkUpdateSuppliersRequest, BulkUpdateSuppliersResponse, BulkUpdateSuppliersResponseBulkSupplierResult, CommonQueryWithEntityContext, CreateSupplierRequest, CreateSupplierResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteSupplierRequest, DeleteSupplierResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetSupplierRequest, GetSupplierResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, Location, MaskedSupplier, MessageEnvelope, QuerySuppliersRequest, QuerySuppliersResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, Supplier, SupplierQuerySpec, SupplierType, SupplierTypeWithLiterals, SuppliersQueryResult, TagList, Tags, TagsModified, UpdateSupplier, UpdateSupplierRequest, UpdateSupplierResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
+import { HttpClient, NonNullablePaths, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { Supplier, UpdateSupplier, BulkCreateSuppliersOptions, BulkCreateSuppliersResponse, MaskedSupplier, BulkUpdateSuppliersOptions, BulkUpdateSuppliersResponse, BulkDeleteSuppliersResponse, BulkUpdateSupplierTagsOptions, BulkUpdateSupplierTagsResponse, BulkUpdateSupplierTagsApplicationErrors, BulkUpdateSupplierTagsByFilterOptions, BulkUpdateSupplierTagsByFilterResponse, BulkUpdateSupplierTagsByFilterApplicationErrors, SuppliersQueryBuilder, SupplierQuery, typedQuerySuppliers } from './index.typings.js';
+export { AccountInfo, ActionEvent, ApplicationError, BulkActionMetadata, BulkCreateSuppliersRequest, BulkDeleteSuppliersRequest, BulkDeleteSuppliersResponseBulkSupplierResult, BulkSupplierResult, BulkUpdateSupplierTagsByFilterRequest, BulkUpdateSupplierTagsRequest, BulkUpdateSupplierTagsResult, BulkUpdateSuppliersRequest, BulkUpdateSuppliersResponseBulkSupplierResult, CommonQueryWithEntityContext, CreateSupplierRequest, CreateSupplierResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteSupplierRequest, DeleteSupplierResponse, DomainEvent, DomainEventBodyOneOf, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, GetSupplierRequest, GetSupplierResponse, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, Location, MessageEnvelope, QuerySuppliersRequest, QuerySuppliersResponse, RestoreInfo, SortOrder, SortOrderWithLiterals, Sorting, SupplierQuerySpec, SupplierType, SupplierTypeWithLiterals, SuppliersQueryResult, TagList, Tags, TagsModified, UpdateSupplierRequest, UpdateSupplierResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, utils } from './index.typings.js';
+
+declare function createSupplier$1(httpClient: HttpClient): CreateSupplierSignature;
+interface CreateSupplierSignature {
+    /**
+     * Creates a supplier profile.
+     *
+     * The supplier's `appId` is automatically set to the ID of the calling application. Use this endpoint when onboarding new suppliers to your marketplace provider's network.
+     * @param - Supplier to be created.
+     * @returns The created Supplier.
+     */
+    (supplier: NonNullablePaths<Supplier, `location` | `name` | `types`, 2>): Promise<NonNullablePaths<Supplier, `verified` | `types` | `tags.privateTags.tagIds`, 4>>;
+}
+declare function getSupplier$1(httpClient: HttpClient): GetSupplierSignature;
+interface GetSupplierSignature {
+    /**
+     * Retrieves a supplier by ID, returning complete supplier information including current revision number for update operations.
+     * @param - ID of the Supplier to retrieve.
+     * @returns The requested Supplier.
+     */
+    (supplierId: string): Promise<NonNullablePaths<Supplier, `verified` | `types` | `tags.privateTags.tagIds`, 4>>;
+}
+declare function updateSupplier$1(httpClient: HttpClient): UpdateSupplierSignature;
+interface UpdateSupplierSignature {
+    /**
+     * Updates a supplier.
+     *
+     * Each time the supplier is updated, `revision` increments by 1. The current `revision` must be passed when updating the supplier. This ensures you're working with the latest supplier information and prevents conflicting changes. If the revision is outdated, the request fails and you must fetch the current supplier state before retrying.
+     *
+     * When updating rating information, update both `rating` and `reviewCount` together to maintain consistency.
+     * @param - Supplier ID.
+     * @returns Updated supplier with incremented revision number.
+     */
+    (_id: string, supplier: NonNullablePaths<UpdateSupplier, `revision`, 2>): Promise<NonNullablePaths<Supplier, `verified` | `types` | `tags.privateTags.tagIds`, 4>>;
+}
+declare function deleteSupplier$1(httpClient: HttpClient): DeleteSupplierSignature;
+interface DeleteSupplierSignature {
+    /**
+     * Permanently deletes a supplier from the marketplace. This action cannot be undone. Use this endpoint when removing suppliers that are no longer active in your network.
+     * @param - Id of the Supplier to delete.
+     */
+    (supplierId: string): Promise<void>;
+}
+declare function bulkCreateSuppliers$1(httpClient: HttpClient): BulkCreateSuppliersSignature;
+interface BulkCreateSuppliersSignature {
+    /**
+     * Creates multiple suppliers in a single synchronous request.
+     *
+     * Supports up to 100 suppliers per request. Set `returnEntity` to `true` to receive the created suppliers with their assigned IDs and revision numbers. Use this endpoint when importing suppliers from external sources or onboarding multiple suppliers simultaneously.
+     *
+     * Each supplier in the request is processed independently. The response includes metadata indicating success or failure for each supplier.
+     * @param - List of suppliers to create.
+     */
+    (suppliers: NonNullablePaths<Supplier, `location` | `name` | `types`, 2>[], options?: BulkCreateSuppliersOptions): Promise<NonNullablePaths<BulkCreateSuppliersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.verified` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function bulkUpdateSuppliers$1(httpClient: HttpClient): BulkUpdateSuppliersSignature;
+interface BulkUpdateSuppliersSignature {
+    /**
+     * Updates multiple suppliers in a single synchronous request.
+     *
+     * Supports up to 100 suppliers per request. Each supplier must include its current revision number to prevent conflicting changes. Set `returnEntity` to `true` to receive the updated suppliers in the response.
+     *
+     * To update more than 100 suppliers, split them into multiple batches and make separate requests. When updating rating information, update both `rating` and `reviewCount` together to maintain consistency.
+     * @param - List of suppliers to update. Each must include current revision number.
+     */
+    (suppliers: NonNullablePaths<MaskedSupplier, `supplier._id` | `supplier.revision`, 3>[], options?: BulkUpdateSuppliersOptions): Promise<NonNullablePaths<BulkUpdateSuppliersResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `results.${number}.item.verified` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`, 6>>;
+}
+declare function bulkDeleteSuppliers$1(httpClient: HttpClient): BulkDeleteSuppliersSignature;
+interface BulkDeleteSuppliersSignature {
+    /**
+     * Permanently deletes multiple suppliers in a single synchronous request. This action cannot be undone.
+     *
+     * Supports up to 100 suppliers per request. To delete more than 100 suppliers, split the supplier IDs into multiple batches and make separate requests.
+     *
+     * Each supplier deletion is processed independently. The response includes metadata indicating success or failure for each supplier.
+     * @param - Supplier ids to be deleted
+     */
+    (supplierIds: string[]): Promise<NonNullablePaths<BulkDeleteSuppliersResponse, `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 bulkUpdateSupplierTags$1(httpClient: HttpClient): BulkUpdateSupplierTagsSignature;
+interface BulkUpdateSupplierTagsSignature {
+    /**
+     * Updates tags on multiple suppliers specified by supplier IDs in a single synchronous request.
+     *
+     * Supports up to 100 suppliers per request. You can assign new tags, unassign existing tags, or both in a single operation. If a tag appears in both `assignTags` and `unassignTags` lists, it will be assigned. Assignment takes precedence.
+     *
+     * Use this endpoint to organize suppliers with public tags for categorization visible to site members, or private tags for internal management requiring additional permissions.
+     * @param - List of supplier IDs to update tags for.
+     */
+    (supplierIds: string[], options?: BulkUpdateSupplierTagsOptions): Promise<NonNullablePaths<BulkUpdateSupplierTagsResponse, `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?: BulkUpdateSupplierTagsApplicationErrors;
+    }>;
+}
+declare function bulkUpdateSupplierTagsByFilter$1(httpClient: HttpClient): BulkUpdateSupplierTagsByFilterSignature;
+interface BulkUpdateSupplierTagsByFilterSignature {
+    /**
+     * Updates tags on multiple suppliers matching filter criteria in a single asynchronous request.
+     *
+     * Use this endpoint for large-scale tag operations across many suppliers based on conditions such as location, verification status, or rating. An empty filter updates all suppliers. The operation returns a job ID for tracking completion status.
+     *
+     * If a tag appears in both `assignTags` and `unassignTags` lists, it will be assigned. Assignment takes precedence. This endpoint has no supplier limit, unlike the synchronous tag update endpoint which is limited to 100 suppliers.
+     * @param - Filter criteria to select which suppliers to update. An empty filter matches all suppliers. See supported filters in the API documentation.
+     */
+    (filter: Record<string, any>, options?: BulkUpdateSupplierTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateSupplierTagsByFilterResponse, `jobId`, 2> & {
+        __applicationErrorsType?: BulkUpdateSupplierTagsByFilterApplicationErrors;
+    }>;
+}
 
 declare function customQuerySuppliers(httpClient: HttpClient): {
     (): SuppliersQueryBuilder;
     (query: SupplierQuery): ReturnType<typeof typedQuerySuppliers>;
 };
+declare const createSupplier: MaybeContext<BuildRESTFunction<typeof createSupplier$1> & typeof createSupplier$1>;
+declare const getSupplier: MaybeContext<BuildRESTFunction<typeof getSupplier$1> & typeof getSupplier$1>;
+declare const updateSupplier: MaybeContext<BuildRESTFunction<typeof updateSupplier$1> & typeof updateSupplier$1>;
+declare const deleteSupplier: MaybeContext<BuildRESTFunction<typeof deleteSupplier$1> & typeof deleteSupplier$1>;
+declare const bulkCreateSuppliers: MaybeContext<BuildRESTFunction<typeof bulkCreateSuppliers$1> & typeof bulkCreateSuppliers$1>;
+declare const bulkUpdateSuppliers: MaybeContext<BuildRESTFunction<typeof bulkUpdateSuppliers$1> & typeof bulkUpdateSuppliers$1>;
+declare const bulkDeleteSuppliers: MaybeContext<BuildRESTFunction<typeof bulkDeleteSuppliers$1> & typeof bulkDeleteSuppliers$1>;
+declare const bulkUpdateSupplierTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateSupplierTags$1> & typeof bulkUpdateSupplierTags$1>;
+declare const bulkUpdateSupplierTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateSupplierTagsByFilter$1> & typeof bulkUpdateSupplierTagsByFilter$1>;
 declare const querySuppliers: MaybeContext<BuildRESTFunction<typeof customQuerySuppliers> & typeof customQuerySuppliers>;
 
-export { SupplierQuery, SuppliersQueryBuilder, querySuppliers };
+export { BulkCreateSuppliersOptions, BulkCreateSuppliersResponse, BulkDeleteSuppliersResponse, BulkUpdateSupplierTagsApplicationErrors, BulkUpdateSupplierTagsByFilterApplicationErrors, BulkUpdateSupplierTagsByFilterOptions, BulkUpdateSupplierTagsByFilterResponse, BulkUpdateSupplierTagsOptions, BulkUpdateSupplierTagsResponse, BulkUpdateSuppliersOptions, BulkUpdateSuppliersResponse, MaskedSupplier, Supplier, SupplierQuery, SuppliersQueryBuilder, UpdateSupplier, bulkCreateSuppliers, bulkDeleteSuppliers, bulkUpdateSupplierTags, bulkUpdateSupplierTagsByFilter, bulkUpdateSuppliers, createSupplier, deleteSupplier, getSupplier, querySuppliers, updateSupplier };

package/build/cjs/index.js

@@ -585,7 +585,9 @@ async function typedQuerySuppliers(query) {
   }
 }
 var utils = {
-  ...(0, import_query_builder_utils.createQueryUtils)()
+  query: {
+    ...(0, import_query_builder_utils.createQueryUtils)()
+  }
 };
 async function bulkCreateSuppliers2(suppliers, options) {
   const { httpClient, sideEffects } = arguments[2];