@wix/auto_sdk_editor-branches_branches 1.0.38 → 1.0.40

package/build/cjs/index.d.ts

@@ -1,6 +1,6 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
 import { Branch, CreateBranchApplicationErrors, UpdateBranch, UpdateBranchApplicationErrors, DeleteBranchApplicationErrors, SetDefaultBranchResponse, GetDefaultBranchResponse, BulkUpdateBranchTagsOptions, BulkUpdateBranchTagsResponse, BulkUpdateBranchTagsApplicationErrors, BulkUpdateBranchTagsByFilterOptions, BulkUpdateBranchTagsByFilterResponse, BulkUpdateBranchTagsByFilterApplicationErrors, BranchCreatedEnvelope, BranchDeletedEnvelope, BranchUpdatedEnvelope, BranchesQueryBuilder, BranchQuery, typedQueryBranches } from './index.typings.js';
-export { AccountInfo, ActionEvent, ApplicationError, Asset, BaseEventMetadata, BranchQuerySpec, BranchSourceOneOf, BranchesQueryResult, BulkActionMetadata, BulkUpdateBranchTagsByFilterRequest, BulkUpdateBranchTagsRequest, BulkUpdateBranchTagsResult, CommonQueryWithEntityContext, CreateBranchRequest, CreateBranchResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteBranchRequest, DeleteBranchResponse, DeleteContext, DeleteStatus, DeleteStatusWithLiterals, DomainEvent, DomainEventBodyOneOf, EditorType, EditorTypeOptions, EditorTypeOptionsWithLiterals, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetBranchRequest, GetBranchResponse, GetDefaultBranchRequest, HtmlSitePublished, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, Page, PicassoAssigned, PicassoUnassigned, PublicTags, QueryBranchesRequest, QueryBranchesResponse, RestoreInfo, ServiceProvisioned, ServiceRemoved, SetDefaultBranchRequest, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, SourceBranch, SourceTemplate, SourceType, SourceTypeWithLiterals, State, StateWithLiterals, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, TagList, TagsModified, Type, TypeWithLiterals, UpdateBranchRequest, UpdateBranchResponse, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.js';
+export { AccountInfo, ActionEvent, ApplicationError, Asset, BaseEventMetadata, BranchQuerySpec, BranchSourceOneOf, BranchesQueryResult, BulkActionMetadata, BulkUpdateBranchTagsByFilterRequest, BulkUpdateBranchTagsRequest, BulkUpdateBranchTagsResult, CommonQueryWithEntityContext, CreateBranchRequest, CreateBranchResponse, CursorPaging, CursorPagingMetadata, CursorQuery, CursorQueryPagingMethodOneOf, Cursors, DeleteBranchRequest, DeleteBranchResponse, DeleteContext, DeleteStatus, DeleteStatusWithLiterals, DomainEvent, DomainEventBodyOneOf, EditorType, EditorTypeOptions, EditorTypeOptionsWithLiterals, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, ExtendedFields, GetBranchRequest, GetBranchResponse, GetDefaultBranchRequest, HtmlSitePublished, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, Page, PicassoAssigned, PicassoUnassigned, PublicTags, QueryBranchesRequest, QueryBranchesResponse, RestoreInfo, ServiceProvisioned, ServiceRemoved, SetDefaultBranchRequest, SiteCreated, SiteCreatedContext, SiteCreatedContextWithLiterals, SiteDeleted, SiteHardDeleted, SiteMarkedAsTemplate, SiteMarkedAsWixSite, SitePublished, SitePurgedExternally, SiteRenamed, SiteTransferred, SiteUndeleted, SiteUnpublished, SiteUrlChanged, SortOrder, SortOrderWithLiterals, Sorting, SourceBranch, SourceTemplate, SourceType, SourceTypeWithLiterals, State, StateWithLiterals, StudioAssigned, StudioTwoAssigned, StudioTwoUnassigned, StudioUnassigned, TagList, TagsModified, Type, TypeWithLiterals, UpdateBranchRequest, UpdateBranchResponse, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse, UserDomainMediaDisabled, UserDomainMediaEnabled, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.js';
 
 declare function createBranch$1(httpClient: HttpClient): CreateBranchSignature;
 interface CreateBranchSignature {
@@ -75,10 +75,12 @@ interface GetDefaultBranchSignature {
 declare function bulkUpdateBranchTags$1(httpClient: HttpClient): BulkUpdateBranchTagsSignature;
 interface BulkUpdateBranchTagsSignature {
     /**
-     * Updates a list of branches by assigning or unassigning tags.
+     * Updates tags on multiple branches.
      *
-     * To update a single branch's tags, call [Update Branch](https://dev.wix.com/docs/rest/api-reference/wix-editor/branches/update-branch).
-     * @param - List of branch IDs.
+     * Specify which tags to assign and which tags to unassign. A tag that appears in both the list to assign and the list to unassign will be assigned.
+     *
+     * To update a single branch's tags, call [Update Branch](https://dev.wix.com/docs/api-reference/business-management/branches/update-branch).
+     * @param - IDs of the branches to update.
      */
     (branchIds: string[], options?: BulkUpdateBranchTagsOptions): Promise<NonNullablePaths<BulkUpdateBranchTagsResponse, `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?: BulkUpdateBranchTagsApplicationErrors;
@@ -87,10 +89,14 @@ interface BulkUpdateBranchTagsSignature {
 declare function bulkUpdateBranchTagsByFilter$1(httpClient: HttpClient): BulkUpdateBranchTagsByFilterSignature;
 interface BulkUpdateBranchTagsByFilterSignature {
     /**
-     * Updates a list of branches by filter, assigning or unassigning tags.
+     * Asynchronously updates tags on multiple branches that match the provided filter criteria.
+     *
+     * Specify which tags to assign and which tags to unassign. A tag that appears both the list to assign and the list to unassign tags, will be assigned.
+     *
+     * To check the status of the bulk update, pass the returned `jobId` to [Get Async Job](https://dev.wix.com/docs/api-reference/business-management/async-job/get-async-job).
      *
-     * To update a single branch's tags, call [Update Branch](https://dev.wix.com/docs/rest/api-reference/wix-editor/branches/update-branch).
-     * @param - WQL filter to select branches. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more information.
+     * To update a single branch's tags, call [Update Branch](https://dev.wix.com/docs/api-reference/business-management/branches/update-branch).
+     * @param - Filter to select which branches to update. See [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language) for more information.
      */
     (filter: Record<string, any>, options?: BulkUpdateBranchTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateBranchTagsByFilterResponse, `jobId`, 2> & {
         __applicationErrorsType?: BulkUpdateBranchTagsByFilterApplicationErrors;