@wix/auto_sdk_editor-branches_branches 1.0.47 → 1.0.49

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

@@ -199,39 +199,33 @@ interface QueryBranchesRequest {
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
     /**
-     * Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"}}`.
-     *
-     * Filterable fields:
+     * Cursor paging options.
      *
-     * - `type`,
-     * - `name`,
-     * - `updatedDate`,
-     * - `createdDate`,
-     * - `lastPublishDate`,
-     * - `sourceBranchProperties.branchId`,
-     * - `sourceBranchProperties.branchRevision`
+     * Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
      *
-     * All operators are valid.
+     * Learn more about [filtering](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters).
      */
     filter?: Record<string, any> | null;
     /**
-     * Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`.
-     *
-     * Sortable fields:
+     * Sort object.
      *
-     * - `updatedDate`,
-     * - `createdDate`,
-     * - `lastPublishDate`
+     * Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#sorting).
      * @maxSize 5
      */
     sort?: Sorting[];
 }
 /** @oneof */
 interface CursorQueryPagingMethodOneOf {
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging).
+     */
     cursorPaging?: CursorPaging;
 }
 interface Sorting {
@@ -1225,6 +1219,8 @@ interface BranchCreatedEnvelope {
 }
 /**
  * Triggered when a branch is created.
+ * @permissionScope Manage SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.MANAGE-SEO
  * @permissionScope Manage Site Branches
  * @permissionScopeId SCOPE.DC-DOCUMENT-MANAGEMENT.MANAGE-BRANCHES
  * @permissionId EDITOR.BRANCH_READ
@@ -1239,6 +1235,8 @@ interface BranchDeletedEnvelope {
 }
 /**
  * Triggered when a branch is deleted.
+ * @permissionScope Manage SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.MANAGE-SEO
  * @permissionScope Manage Site Branches
  * @permissionScopeId SCOPE.DC-DOCUMENT-MANAGEMENT.MANAGE-BRANCHES
  * @permissionId EDITOR.BRANCH_READ
@@ -1255,6 +1253,8 @@ interface BranchUpdatedEnvelope {
 }
 /**
  * Triggered when a branch is updated.
+ * @permissionScope Manage SEO Settings
+ * @permissionScopeId SCOPE.PROMOTE.MANAGE-SEO
  * @permissionScope Manage Site Branches
  * @permissionScopeId SCOPE.DC-DOCUMENT-MANAGEMENT.MANAGE-BRANCHES
  * @permissionId EDITOR.BRANCH_READ
@@ -1496,7 +1496,9 @@ interface BranchQuerySpec extends QuerySpec {
 type CommonQueryWithEntityContext = Query<Branch, BranchQuerySpec>;
 type BranchQuery = {
     /**
-    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    Cursor paging options.
+  
+    Learn more about [cursor paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#cursor-paging).
     */
     cursorPaging?: {
         /**
@@ -1514,29 +1516,15 @@ type BranchQuery = {
         cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
     };
     /**
-    Filter object in the following format: `"filter" : { "fieldName1": "value1", "fieldName2":{"$operator":"value2"}}`.
-  
-    Filterable fields:
+    Filter object.
   
-    - `type`,
-    - `name`,
-    - `updatedDate`,
-    - `createdDate`,
-    - `lastPublishDate`,
-    - `sourceBranchProperties.branchId`,
-    - `sourceBranchProperties.branchRevision`
-  
-    All operators are valid.
+    Learn more about [filtering](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#filters).
     */
     filter?: CommonQueryWithEntityContext['filter'] | null;
     /**
-    Sort object in the following format: `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`.
-  
-    Sortable fields:
+    Sort object.
   
-    - `updatedDate`,
-    - `createdDate`,
-    - `lastPublishDate`
+    Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language#sorting).
     @maxSize: 5
     */
     sort?: {
@@ -1552,9 +1540,11 @@ type BranchQuery = {
     }[];
 };
 declare const utils: {
-    QueryBuilder: () => _wix_sdk_types.QueryBuilder<Branch, BranchQuerySpec, BranchQuery>;
-    Filter: _wix_sdk_types.FilterFactory<Branch, BranchQuerySpec>;
-    Sort: _wix_sdk_types.SortFactory<BranchQuerySpec>;
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<Branch, BranchQuerySpec, BranchQuery>;
+        Filter: _wix_sdk_types.FilterFactory<Branch, BranchQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<BranchQuerySpec>;
+    };
 };
 /**
  * Sets the specified branch as the default.

package/build/cjs/index.typings.js

@@ -650,7 +650,9 @@ async function typedQueryBranches(query) {
   }
 }
 var utils = {
-  ...(0, import_query_builder_utils.createQueryUtils)()
+  query: {
+    ...(0, import_query_builder_utils.createQueryUtils)()
+  }
 };
 async function setDefaultBranch2(branchId) {
   const { httpClient, sideEffects } = arguments[1];