@wix/auto_sdk_editor-branches_branches 1.0.32 → 1.0.34

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, BranchCreatedEnvelope, BranchDeletedEnvelope, BranchUpdatedEnvelope, BranchesQueryBuilder, BranchQuery, typedQueryBranches } from './index.typings.js';
-export { ActionEvent, Asset, BaseEventMetadata, BranchQuerySpec, BranchSourceOneOf, BranchesQueryResult, 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, MessageEnvelope, MetaSiteSpecialEvent, MetaSiteSpecialEventPayloadOneOf, Namespace, NamespaceChanged, NamespaceWithLiterals, OdeditorAssigned, OdeditorUnassigned, Page, PicassoAssigned, PicassoUnassigned, 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, Type, TypeWithLiterals, UpdateBranchRequest, UpdateBranchResponse, UpdateExtendedFieldsRequest, UpdateExtendedFieldsResponse, WebhookIdentityType, WebhookIdentityTypeWithLiterals, WixelAssigned, WixelUnassigned } from './index.typings.js';
+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 { 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';
 
 declare function createBranch$1(httpClient: HttpClient): CreateBranchSignature;
 interface CreateBranchSignature {
@@ -17,7 +17,7 @@ interface CreateBranchSignature {
      * @param - Branch to be created.
      * @returns Created branch.
      */
-    (branch: Branch): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`, 3> & {
+    (branch: Branch): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions` | `tags.tags.tagIds`, 4> & {
         __applicationErrorsType?: CreateBranchApplicationErrors;
     }>;
 }
@@ -28,7 +28,7 @@ interface GetBranchSignature {
      * @param - ID of branch to retrieve.
      * @returns Requested branch.
      */
-    (branchId: string): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`, 3>>;
+    (branchId: string): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions` | `tags.tags.tagIds`, 4>>;
 }
 declare function updateBranch$1(httpClient: HttpClient): UpdateBranchSignature;
 interface UpdateBranchSignature {
@@ -39,7 +39,7 @@ interface UpdateBranchSignature {
      * @param - Branch ID.
      * @returns Updated branch.
      */
-    (_id: string, branch: NonNullablePaths<UpdateBranch, `revision`, 2>): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions`, 3> & {
+    (_id: string, branch: NonNullablePaths<UpdateBranch, `revision`, 2>): Promise<NonNullablePaths<Branch, `sourceBranchProperties.branchId` | `sourceTemplateProperties.templateId` | `type` | `sourceType` | `editorType.editorTypeOptions` | `tags.tags.tagIds`, 4> & {
         __applicationErrorsType?: UpdateBranchApplicationErrors;
     }>;
 }
@@ -59,14 +59,28 @@ interface SetDefaultBranchSignature {
      * Sets the specified branch as the default.
      * @param - Branch ID.
      */
-    (branchId: string): Promise<NonNullablePaths<SetDefaultBranchResponse, `branch.sourceBranchProperties.branchId` | `branch.sourceTemplateProperties.templateId` | `branch.type` | `branch.sourceType` | `branch.editorType.editorTypeOptions`, 4>>;
+    (branchId: string): Promise<NonNullablePaths<SetDefaultBranchResponse, `branch.sourceBranchProperties.branchId` | `branch.sourceTemplateProperties.templateId` | `branch.type` | `branch.sourceType` | `branch.editorType.editorTypeOptions` | `branch.tags.tags.tagIds`, 5>>;
 }
 declare function getDefaultBranch$1(httpClient: HttpClient): GetDefaultBranchSignature;
 interface GetDefaultBranchSignature {
     /**
      * Retrieves the default branch.
      */
-    (): Promise<NonNullablePaths<GetDefaultBranchResponse, `branch.sourceBranchProperties.branchId` | `branch.sourceTemplateProperties.templateId` | `branch.type` | `branch.sourceType` | `branch.editorType.editorTypeOptions`, 4>>;
+    (): Promise<NonNullablePaths<GetDefaultBranchResponse, `branch.sourceBranchProperties.branchId` | `branch.sourceTemplateProperties.templateId` | `branch.type` | `branch.sourceType` | `branch.editorType.editorTypeOptions` | `branch.tags.tags.tagIds`, 5>>;
+}
+declare function bulkUpdateBranchTags$1(httpClient: HttpClient): BulkUpdateBranchTagsSignature;
+interface BulkUpdateBranchTagsSignature {
+    /** @param - List of branch IDs. */
+    (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;
+    }>;
+}
+declare function bulkUpdateBranchTagsByFilter$1(httpClient: HttpClient): BulkUpdateBranchTagsByFilterSignature;
+interface BulkUpdateBranchTagsByFilterSignature {
+    /** @param - WQL filter to select branches. */
+    (filter: Record<string, any>, options?: BulkUpdateBranchTagsByFilterOptions): Promise<NonNullablePaths<BulkUpdateBranchTagsByFilterResponse, `jobId`, 2> & {
+        __applicationErrorsType?: BulkUpdateBranchTagsByFilterApplicationErrors;
+    }>;
 }
 declare const onBranchCreated$1: EventDefinition<BranchCreatedEnvelope, "wix.editor.branches.v1.branch_created">;
 declare const onBranchDeleted$1: EventDefinition<BranchDeletedEnvelope, "wix.editor.branches.v1.branch_deleted">;
@@ -82,6 +96,8 @@ declare const updateBranch: MaybeContext<BuildRESTFunction<typeof updateBranch$1
 declare const deleteBranch: MaybeContext<BuildRESTFunction<typeof deleteBranch$1> & typeof deleteBranch$1>;
 declare const setDefaultBranch: MaybeContext<BuildRESTFunction<typeof setDefaultBranch$1> & typeof setDefaultBranch$1>;
 declare const getDefaultBranch: MaybeContext<BuildRESTFunction<typeof getDefaultBranch$1> & typeof getDefaultBranch$1>;
+declare const bulkUpdateBranchTags: MaybeContext<BuildRESTFunction<typeof bulkUpdateBranchTags$1> & typeof bulkUpdateBranchTags$1>;
+declare const bulkUpdateBranchTagsByFilter: MaybeContext<BuildRESTFunction<typeof bulkUpdateBranchTagsByFilter$1> & typeof bulkUpdateBranchTagsByFilter$1>;
 declare const queryBranches: MaybeContext<BuildRESTFunction<typeof customQueryBranches> & typeof customQueryBranches>;
 /**
  * Triggered when a branch is created.
@@ -96,4 +112,4 @@ declare const onBranchDeleted: BuildEventDefinition<typeof onBranchDeleted$1> &
  */
 declare const onBranchUpdated: BuildEventDefinition<typeof onBranchUpdated$1> & typeof onBranchUpdated$1;
 
-export { Branch, BranchCreatedEnvelope, BranchDeletedEnvelope, BranchQuery, BranchUpdatedEnvelope, BranchesQueryBuilder, CreateBranchApplicationErrors, DeleteBranchApplicationErrors, GetDefaultBranchResponse, SetDefaultBranchResponse, UpdateBranch, UpdateBranchApplicationErrors, createBranch, deleteBranch, getBranch, getDefaultBranch, onBranchCreated, onBranchDeleted, onBranchUpdated, queryBranches, setDefaultBranch, updateBranch };
+export { Branch, BranchCreatedEnvelope, BranchDeletedEnvelope, BranchQuery, BranchUpdatedEnvelope, BranchesQueryBuilder, BulkUpdateBranchTagsApplicationErrors, BulkUpdateBranchTagsByFilterApplicationErrors, BulkUpdateBranchTagsByFilterOptions, BulkUpdateBranchTagsByFilterResponse, BulkUpdateBranchTagsOptions, BulkUpdateBranchTagsResponse, CreateBranchApplicationErrors, DeleteBranchApplicationErrors, GetDefaultBranchResponse, SetDefaultBranchResponse, UpdateBranch, UpdateBranchApplicationErrors, bulkUpdateBranchTags, bulkUpdateBranchTagsByFilter, createBranch, deleteBranch, getBranch, getDefaultBranch, onBranchCreated, onBranchDeleted, onBranchUpdated, queryBranches, setDefaultBranch, updateBranch };

package/build/cjs/index.js

@@ -29,6 +29,8 @@ __export(index_exports, {
   State: () => State,
   Type: () => Type,
   WebhookIdentityType: () => WebhookIdentityType,
+  bulkUpdateBranchTags: () => bulkUpdateBranchTags4,
+  bulkUpdateBranchTagsByFilter: () => bulkUpdateBranchTagsByFilter4,
   createBranch: () => createBranch4,
   deleteBranch: () => deleteBranch4,
   getBranch: () => getBranch4,
@@ -88,6 +90,10 @@ function resolveWixEditorBranchesV1BranchesServiceUrl(opts) {
       {
         srcPath: "/editor/branches/v1/branches",
         destPath: "/v1/branches"
+      },
+      {
+        srcPath: "/editor/branches/v1/bulk/branches",
+        destPath: "/v1/bulk/branches"
       }
     ],
     "*.dev.wix-code.com": [
@@ -346,6 +352,48 @@ function getDefaultBranch(payload) {
   }
   return __getDefaultBranch;
 }
+function bulkUpdateBranchTags(payload) {
+  function __bulkUpdateBranchTags({ host }) {
+    const metadata = {
+      entityFqdn: "wix.editor.branches.v1.branch",
+      method: "POST",
+      methodFqn: "wix.editor.branches.v1.BranchesService.BulkUpdateBranchTags",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixEditorBranchesV1BranchesServiceUrl({
+        protoPath: "/v1/bulk/branches/update-tags",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __bulkUpdateBranchTags;
+}
+function bulkUpdateBranchTagsByFilter(payload) {
+  function __bulkUpdateBranchTagsByFilter({ host }) {
+    const metadata = {
+      entityFqdn: "wix.editor.branches.v1.branch",
+      method: "POST",
+      methodFqn: "wix.editor.branches.v1.BranchesService.BulkUpdateBranchTagsByFilter",
+      packageName: PACKAGE_NAME,
+      migrationOptions: {
+        optInTransformResponse: true
+      },
+      url: resolveWixEditorBranchesV1BranchesServiceUrl({
+        protoPath: "/v1/bulk/branches/update-tags-by-filter",
+        data: payload,
+        host
+      }),
+      data: payload
+    };
+    return metadata;
+  }
+  return __bulkUpdateBranchTagsByFilter;
+}
 
 // src/editor-branches-v1-branch-branches.universal.ts
 var import_transform_paths2 = require("@wix/sdk-runtime/transformations/transform-paths");
@@ -648,6 +696,68 @@ async function getDefaultBranch2() {
     throw transformedError;
   }
 }
+async function bulkUpdateBranchTags2(branchIds, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    branchIds,
+    assignTags: options?.assignTags,
+    unassignTags: options?.unassignTags
+  });
+  const reqOpts = bulkUpdateBranchTags(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          branchIds: "$[0]",
+          assignTags: "$[1].assignTags",
+          unassignTags: "$[1].unassignTags"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["branchIds", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
+async function bulkUpdateBranchTagsByFilter2(filter, options) {
+  const { httpClient, sideEffects } = arguments[2];
+  const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({
+    filter,
+    assignTags: options?.assignTags,
+    unassignTags: options?.unassignTags
+  });
+  const reqOpts = bulkUpdateBranchTagsByFilter(payload);
+  sideEffects?.onSiteCall?.();
+  try {
+    const result = await httpClient.request(reqOpts);
+    sideEffects?.onSuccess?.(result);
+    return (0, import_rename_all_nested_keys.renameKeysFromRESTResponseToSDKResponse)(result.data);
+  } catch (err) {
+    const transformedError = (0, import_transform_error.transformError)(
+      err,
+      {
+        spreadPathsToArguments: {},
+        explicitPathsToArguments: {
+          filter: "$[0]",
+          assignTags: "$[1].assignTags",
+          unassignTags: "$[1].unassignTags"
+        },
+        singleArgumentUnchanged: false
+      },
+      ["filter", "options"]
+    );
+    sideEffects?.onError?.(err);
+    throw transformedError;
+  }
+}
 
 // src/editor-branches-v1-branch-branches.public.ts
 function createBranch3(httpClient) {
@@ -705,6 +815,22 @@ function getDefaultBranch3(httpClient) {
     { httpClient }
   );
 }
+function bulkUpdateBranchTags3(httpClient) {
+  return (branchIds, options) => bulkUpdateBranchTags2(
+    branchIds,
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
+function bulkUpdateBranchTagsByFilter3(httpClient) {
+  return (filter, options) => bulkUpdateBranchTagsByFilter2(
+    filter,
+    options,
+    // @ts-ignore
+    { httpClient }
+  );
+}
 var onBranchCreated = (0, import_sdk_types.EventDefinition)(
   "wix.editor.branches.v1.branch_created",
   true,
@@ -777,6 +903,8 @@ var updateBranch4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(u
 var deleteBranch4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(deleteBranch3);
 var setDefaultBranch4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(setDefaultBranch3);
 var getDefaultBranch4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(getDefaultBranch3);
+var bulkUpdateBranchTags4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkUpdateBranchTags3);
+var bulkUpdateBranchTagsByFilter4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(bulkUpdateBranchTagsByFilter3);
 var queryBranches4 = /* @__PURE__ */ (0, import_rest_modules3.createRESTModule)(customQueryBranches);
 var onBranchCreated2 = (0, import_event_definition_modules.createEventModule)(onBranchCreated);
 var onBranchDeleted2 = (0, import_event_definition_modules.createEventModule)(onBranchDeleted);
@@ -792,6 +920,8 @@ var onBranchUpdated2 = (0, import_event_definition_modules.createEventModule)(on
   State,
   Type,
   WebhookIdentityType,
+  bulkUpdateBranchTags,
+  bulkUpdateBranchTagsByFilter,
   createBranch,
   deleteBranch,
   getBranch,