@wix/auto_sdk_data_collections 1.0.65 → 1.0.67

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

@@ -58,7 +58,7 @@ interface DataCollection {
      * @maxSize 1000
      */
     fields?: Field[];
-    /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
+    /** Permissions required to access and modify collection items, defined by the lowest role needed to perform each action. */
     permissions?: Permissions;
     /**
      * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
@@ -87,7 +87,7 @@ interface DataCollection {
      */
     _updatedDate?: Date | null;
     /**
-     * Levels of permission for accessing and modifying data.
+     * Permissions required to access and modify collection items, defined by the lowest access level required to perform each action.
      * @internal
      */
     dataPermissions?: DataPermissions;
@@ -271,7 +271,6 @@ interface Field extends FieldRangeValidationsOneOf {
     plugins?: FieldPlugin[];
     /**
      * This indicates that this fields is conditional and is not retrieved by default.
-     * To request the field pass `conditional_fields` parameter in data retrieval requests.
      * @readonly
      */
     condition?: FieldCondition;
@@ -778,8 +777,12 @@ interface CategoryFieldOptions {
     isPrimary?: boolean;
 }
 interface FieldCondition {
-    /** @maxLength 100 */
+    /**
+     * If `group_name` is set, this field will not be present in query results. To retrieve this field, pass `group_name` value to `includeFieldGroups` parameter in query operations.
+     * @maxLength 100
+     */
     groupName?: string | null;
+    /** If present, the field may be omitted from the results, if the requester lacks sufficient permissions to access data stored in the field. */
     permission?: PermissionWithLiterals;
 }
 declare enum Permission {
@@ -792,13 +795,29 @@ declare enum Permission {
 type PermissionWithLiterals = Permission | 'ANYONE' | 'RESTRICTED';
 /** Permissions defined by the lowest role needed to perform each action. */
 interface Permissions {
-    /** Lowest role needed to add a collection. */
+    /**
+     * Role required to insert items into the collection.
+     *
+     * Default: `CMS_EDITOR`
+     */
     insert?: RoleWithLiterals;
-    /** Lowest role needed to update a collection. */
+    /**
+     * Role required to update collection items.
+     *
+     * Default: `CMS_EDITOR`
+     */
     update?: RoleWithLiterals;
-    /** Lowest role needed to remove a collection. */
+    /**
+     * Role required to remove items from the collection.
+     *
+     * Default: `CMS_EDITOR`
+     */
     remove?: RoleWithLiterals;
-    /** Lowest role needed to read a collection. */
+    /**
+     * Role required to read collection items.
+     *
+     * Default: `SITE_MEMBER_AUTHOR`
+     */
     read?: RoleWithLiterals;
 }
 declare enum Role {
@@ -990,19 +1009,35 @@ declare enum PagingMode {
 }
 /** @enumType */
 type PagingModeWithLiterals = PagingMode | 'OFFSET' | 'CURSOR';
-/** Data permissions defined by access level for each action. */
+/** Permissions defined by access level for each action. */
 interface DataPermissions {
-    /** Access level for data items read */
+    /**
+     * Access level required to read collection items.
+     *
+     * Default: `SITE_MEMBER_AUTHOR`
+     */
     itemRead?: AccessLevelWithLiterals;
-    /** Access level for data items insert */
+    /**
+     * Access level required to insert items into the collection.
+     *
+     * Default: `CMS_EDITOR`
+     */
     itemInsert?: AccessLevelWithLiterals;
-    /** Access level for data items update */
+    /**
+     * Access level required to update collection items.
+     *
+     * Default: `CMS_EDITOR`
+     */
     itemUpdate?: AccessLevelWithLiterals;
-    /** Access level for data items removal */
+    /**
+     * Access level required to remove items from the collection.
+     *
+     * Default: `CMS_EDITOR`
+     */
     itemRemove?: AccessLevelWithLiterals;
 }
 /**
- * Describes who can perform certain action.
+ * Describes who can perform certain actions.
  * Each level includes all levels below it (except UNDEFINED).
  */
 declare enum AccessLevel {
@@ -2134,7 +2169,7 @@ interface PatchDataCollection {
      * @maxSize 1000
      */
     fields?: Field[];
-    /** Levels of permission for accessing and modifying data, defined by lowest role needed to perform each action. */
+    /** Permissions required to access and modify collection items, defined by the lowest role needed to perform each action. */
     permissions?: Permissions;
     /**
      * Collection's current revision number, which increments each time the collection is updated. For an update operation to succeed, you must specify the latest revision number.
@@ -2163,7 +2198,7 @@ interface PatchDataCollection {
      */
     _updatedDate?: Date | null;
     /**
-     * Levels of permission for accessing and modifying data.
+     * Permissions required to access and modify collection items, defined by the lowest access level required to perform each action.
      * @internal
      */
     dataPermissions?: DataPermissions;