@wix/auto_sdk_editor-branches_branches 1.0.19 → 1.0.21

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

@@ -5,9 +5,9 @@ import { NonNullablePaths } from '@wix/sdk-types';
  * Read more about branches in this [article](https://support.wix.com/en/article/about-test-sites).
  */
 interface Branch extends BranchSourceOneOf {
-    /** Source branch properties. Use when source_type = SOURCE_BRANCH. */
+    /** Source branch properties. Use when `sourceType` = `SOURCE_BRANCH`. */
     sourceBranchProperties?: SourceBranch;
-    /** Source template properties. Use when source_type = SOURCE_TEMPLATE. */
+    /** Source template properties. Use when `sourceType` = `SOURCE_TEMPLATE`. */
     sourceTemplateProperties?: SourceTemplate;
     /**
      * Branch ID.
@@ -29,7 +29,7 @@ interface Branch extends BranchSourceOneOf {
      * @maxLength 50
      */
     name?: string | null;
-    /** Source type. Must be aligned with the corresponding source properties in the oneof below. */
+    /** Source type. Must be aligned with the corresponding source properties below. */
     sourceType?: SourceTypeWithLiterals;
     /**
      * Date and time the branch was last published, if relevant.
@@ -37,12 +37,12 @@ interface Branch extends BranchSourceOneOf {
      */
     lastPublishDate?: string | null;
     /**
-     * Editor type.
+     * Wix editor type.
      * @readonly
      */
     editorType?: EditorType;
     /**
-     * Default branch
+     * Whether this branch is the default.
      * @readonly
      */
     default?: boolean | null;
@@ -64,19 +64,19 @@ interface Branch extends BranchSourceOneOf {
 }
 /** @oneof */
 interface BranchSourceOneOf {
-    /** Source branch properties. Use when source_type = SOURCE_BRANCH. */
+    /** Source branch properties. Use when `sourceType` = `SOURCE_BRANCH`. */
     sourceBranchProperties?: SourceBranch;
-    /** Source template properties. Use when source_type = SOURCE_TEMPLATE. */
+    /** Source template properties. Use when `sourceType` = `SOURCE_TEMPLATE`. */
     sourceTemplateProperties?: SourceTemplate;
 }
 declare enum Type {
     /** Unknown branch type. */
     UNKNOWN_TYPE = "UNKNOWN_TYPE",
-    /** A branch created by a Wix user, that can be accessed for editing and publishing via the editor UI. */
+    /** A branch created by a Wix user, that can be accessed for editing and publishing in the editor UI. */
     USER = "USER",
-    /** A branch created for technical purposes, unrelated to the Wix user. For internal use, can't be accessed via the editor UI. */
+    /** A branch created for technical purposes, unrelated to the Wix user. For internal use, can't be accessed in the editor UI. */
     TECHNICAL = "TECHNICAL",
-    /** The original branch of the site, created when the site is created. Can be accessed for editing and publishing in the editor. */
+    /** The original branch of the site, created when the site is created. Can be accessed for editing and publishing in the editor UI. */
     ORIGINAL_BRANCH = "ORIGINAL_BRANCH"
 }
 /** @enumType */
@@ -84,23 +84,23 @@ type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'USER' | 'TECHNICAL' | 'ORIGINAL
 declare enum SourceType {
     /** Unknown source type. Do not use - will cause ILLEGAL_SOURCE_TYPE error. */
     UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
-    /** This branch's source was a branch. Must be used with source_branch_properties. */
+    /** This branch's source was a branch. Must be used with `sourceBranchProperties`. */
     SOURCE_BRANCH = "SOURCE_BRANCH",
-    /** This branch's source was a template. Must be used with source_template_properties. For internal use. */
+    /** This branch's source was a template. Must be used with `sourceTemplateProperties`. For internal use. */
     SOURCE_TEMPLATE = "SOURCE_TEMPLATE"
 }
 /** @enumType */
 type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'SOURCE_BRANCH' | 'SOURCE_TEMPLATE';
 interface EditorType {
-    /** Editor type */
+    /** Wix editor types. */
     editorTypeOptions?: EditorTypeOptionsWithLiterals;
 }
 declare enum EditorTypeOptions {
-    /** Unknown editor type */
+    /** Unknown editor type. Not supported. */
     UNKNOWN_EDITOR_TYPE = "UNKNOWN_EDITOR_TYPE",
-    /** STUDIO */
+    /** Wix Studio Editor. */
     STUDIO = "STUDIO",
-    /** CLASSIC */
+    /** Wix's Classic Editor. */
     CLASSIC = "CLASSIC"
 }
 /** @enumType */
@@ -111,7 +111,7 @@ interface SourceBranch {
      * @format GUID
      */
     branchId?: string;
-    /** Source branch revision. */
+    /** Revision number, which increments by 1 each time the branch is updated. To prevent conflicting changes, the current revision must be passed when updating the branch. */
     branchRevision?: string | null;
 }
 interface SourceTemplate {
@@ -169,7 +169,7 @@ interface DeleteBranchRequest {
 interface DeleteBranchResponse {
 }
 interface QueryBranchesRequest {
-    /** WQL expression. */
+    /** Query options. */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
@@ -180,13 +180,13 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
      *
      * Filterable fields:
      *
-     * `type`
-     * `name`
-     * `updatedDate`
-     * `createdDate`
-     * `lastPublishDate`
-     * `sourceBranchProperties.branchId`
-     * `sourceBranchProperties.branchRevision`
+     * - `type`,
+     * - `name`,
+     * - `updatedDate`,
+     * - `createdDate`,
+     * - `lastPublishDate`,
+     * - `sourceBranchProperties.branchId`,
+     * - `sourceBranchProperties.branchRevision`
      *
      * All operators are valid.
      */
@@ -196,9 +196,9 @@ interface CursorQuery extends CursorQueryPagingMethodOneOf {
      *
      * Sortable fields:
      *
-     * `updatedDate`
-     * `createdDate`
-     * `lastPublishDate`
+     * - `updatedDate`,
+     * - `createdDate`,
+     * - `lastPublishDate`
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -241,7 +241,7 @@ interface CursorPaging {
 interface QueryBranchesResponse {
     /** List of branches. */
     branches?: Branch[];
-    /** Paging metadata */
+    /** Metadata of the paginated results. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -783,7 +783,7 @@ interface PicassoUnassigned {
 }
 interface SetDefaultBranchRequest {
     /**
-     * Branch Id.
+     * Branch ID.
      * @format GUID
      */
     branchId: string;
@@ -1022,52 +1022,54 @@ interface BranchCreatedEnvelope {
     entity: Branch;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Site Branches
+/**
+ * Triggered when a branch is created.
+ * @permissionScope Manage Site Branches
  * @permissionScopeId SCOPE.DC-DOCUMENT-MANAGEMENT.MANAGE-BRANCHES
  * @permissionId EDITOR.BRANCH_READ
  * @webhook
  * @eventType wix.editor.branches.v1.branch_created
  * @slug created
- * @documentationMaturity preview
  */
 declare function onBranchCreated(handler: (event: BranchCreatedEnvelope) => void | Promise<void>): void;
 interface BranchDeletedEnvelope {
     entity: Branch;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Site Branches
+/**
+ * Triggered when a branch is deleted.
+ * @permissionScope Manage Site Branches
  * @permissionScopeId SCOPE.DC-DOCUMENT-MANAGEMENT.MANAGE-BRANCHES
  * @permissionId EDITOR.BRANCH_READ
  * @webhook
  * @eventType wix.editor.branches.v1.branch_deleted
  * @slug deleted
- * @documentationMaturity preview
  */
 declare function onBranchDeleted(handler: (event: BranchDeletedEnvelope) => void | Promise<void>): void;
 interface BranchUpdatedEnvelope {
     entity: Branch;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Site Branches
+/**
+ * Triggered when a branch is updated.
+ * @permissionScope Manage Site Branches
  * @permissionScopeId SCOPE.DC-DOCUMENT-MANAGEMENT.MANAGE-BRANCHES
  * @permissionId EDITOR.BRANCH_READ
  * @webhook
  * @eventType wix.editor.branches.v1.branch_updated
  * @slug updated
- * @documentationMaturity preview
  */
 declare function onBranchUpdated(handler: (event: BranchUpdatedEnvelope) => void | Promise<void>): void;
 /**
  * Creates a branch.
  * If a source branch is not provided, the branch will include a blank website.
  *
- * *Important:** The `source_type` field must be aligned with the corresponding source properties:
- * - When `source_type` is `SOURCE_BRANCH`, you must provide `source_branch_properties`
- * - When `source_type` is `SOURCE_TEMPLATE`, you must provide `source_template_properties`
- * - Using `UNKNOWN_SOURCE_TYPE` or mismatched properties will result in `ILLEGAL_SOURCE_TYPE` error
+ * > **Important:** The `sourceType` field must be aligned with the corresponding source properties:
+ * - When `sourceType` is `SOURCE_BRANCH`, you must provide `source_branch_properties`.
+ * - When `sourceType` is `SOURCE_TEMPLATE`, you must provide `source_template_properties`.
+ * - Using `UNKNOWN_SOURCE_TYPE` or mismatched properties will result in an `ILLEGAL_SOURCE_TYPE` error.
  * @param branch - Branch to be created.
  * @public
- * @documentationMaturity preview
  * @requiredField branch
  * @permissionId EDITOR.BRANCH_CREATE
  * @applicableIdentity APP
@@ -1081,7 +1083,6 @@ declare function createBranch(branch: Branch): Promise<NonNullablePaths<Branch,
  * Retrieves a branch.
  * @param branchId - ID of branch to retrieve.
  * @public
- * @documentationMaturity preview
  * @requiredField branchId
  * @permissionId EDITOR.BRANCH_READ
  * @applicableIdentity APP
@@ -1092,10 +1093,9 @@ declare function getBranch(branchId: string): Promise<NonNullablePaths<Branch, `
 /**
  * Updates a branch.
  *
- * `ORIGINAL_BRANCH` types can't be updated.
+ * Note that `ORIGINAL_BRANCH` types can't be updated.
  * @param _id - Branch ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField branch
  * @requiredField branch.revision
@@ -1108,9 +1108,9 @@ declare function updateBranch(_id: string, branch: NonNullablePaths<UpdateBranch
     __applicationErrorsType?: UpdateBranchApplicationErrors;
 }>;
 interface UpdateBranch {
-    /** Source branch properties. Use when source_type = SOURCE_BRANCH. */
+    /** Source branch properties. Use when `sourceType` = `SOURCE_BRANCH`. */
     sourceBranchProperties?: SourceBranch;
-    /** Source template properties. Use when source_type = SOURCE_TEMPLATE. */
+    /** Source template properties. Use when `sourceType` = `SOURCE_TEMPLATE`. */
     sourceTemplateProperties?: SourceTemplate;
     /**
      * Branch ID.
@@ -1132,7 +1132,7 @@ interface UpdateBranch {
      * @maxLength 50
      */
     name?: string | null;
-    /** Source type. Must be aligned with the corresponding source properties in the oneof below. */
+    /** Source type. Must be aligned with the corresponding source properties below. */
     sourceType?: SourceTypeWithLiterals;
     /**
      * Date and time the branch was last published, if relevant.
@@ -1140,12 +1140,12 @@ interface UpdateBranch {
      */
     lastPublishDate?: string | null;
     /**
-     * Editor type.
+     * Wix editor type.
      * @readonly
      */
     editorType?: EditorType;
     /**
-     * Default branch
+     * Whether this branch is the default.
      * @readonly
      */
     default?: boolean | null;
@@ -1169,7 +1169,6 @@ interface UpdateBranch {
  * Permanently deletes a branch.
  * @param branchId - ID of branch to delete.
  * @public
- * @documentationMaturity preview
  * @requiredField branchId
  * @permissionId EDITOR.BRANCH_DELETE
  * @applicableIdentity APP
@@ -1181,7 +1180,6 @@ declare function deleteBranch(branchId: string): Promise<void & {
 /**
  * Retrieves a list of branches, given the specified [paging, filtering, and sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language).
  * @public
- * @documentationMaturity preview
  * @permissionId EDITOR.BRANCH_READ
  * @applicableIdentity APP
  * @fqn wix.editor.branches.v1.BranchesService.QueryBranches
@@ -1203,72 +1201,52 @@ interface BranchesQueryResult extends QueryCursorResult {
 interface BranchesQueryBuilder {
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     eq: (propertyName: 'sourceBranchProperties.branchId' | 'sourceBranchProperties.branchRevision' | 'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ne: (propertyName: 'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     ge: (propertyName: 'name' | 'lastPublishDate' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     gt: (propertyName: 'name' | 'lastPublishDate' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     le: (propertyName: 'name' | 'lastPublishDate' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `value`.
      * @param value - Value to compare against.
-     * @documentationMaturity preview
      */
     lt: (propertyName: 'name' | 'lastPublishDate' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `string`.
      * @param string - String to compare against. Case-insensitive.
-     * @documentationMaturity preview
      */
     startsWith: (propertyName: 'name', value: string) => BranchesQueryBuilder;
     /** @param propertyName - Property whose value is compared with `values`.
      * @param values - List of values to compare against.
-     * @documentationMaturity preview
      */
     hasSome: (propertyName: 'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate', value: any[]) => BranchesQueryBuilder;
-    /** @documentationMaturity preview */
     in: (propertyName: 'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate', value: any) => BranchesQueryBuilder;
-    /** @documentationMaturity preview */
     exists: (propertyName: 'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate', value: boolean) => BranchesQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     ascending: (...propertyNames: Array<'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate'>) => BranchesQueryBuilder;
-    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
-     * @documentationMaturity preview
-     */
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
     descending: (...propertyNames: Array<'type' | 'name' | 'lastPublishDate' | 'editorType' | 'editorType.editorTypeOptions' | '_createdDate' | '_updatedDate'>) => BranchesQueryBuilder;
-    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
-     * @documentationMaturity preview
-     */
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
     limit: (limit: number) => BranchesQueryBuilder;
-    /** @param cursor - A pointer to specific record
-     * @documentationMaturity preview
-     */
+    /** @param cursor - A pointer to specific record */
     skipTo: (cursor: string) => BranchesQueryBuilder;
-    /** @documentationMaturity preview */
     find: () => Promise<BranchesQueryResult>;
 }
 /**
  * Sets the specified branch as the default.
- * @param branchId - Branch Id.
+ * @param branchId - Branch ID.
  * @public
- * @documentationMaturity preview
  * @requiredField branchId
  * @permissionId EDITOR.SET_DEFAULT_BRANCH
  * @applicableIdentity APP
@@ -1278,7 +1256,6 @@ declare function setDefaultBranch(branchId: string): Promise<NonNullablePaths<Se
 /**
  * Retrieves the default branch.
  * @public
- * @documentationMaturity preview
  * @permissionId EDITOR.BRANCH_READ
  * @applicableIdentity APP
  * @fqn wix.editor.branches.v1.BranchesService.GetDefaultBranch