datocms-plugin-sdk 0.3.3 → 0.3.8

package/dist/types/SiteApiSchema.d.ts

@@ -283,8 +283,8 @@ export declare type SubscriptionLimitType = 'subscription_limit';
 /**
  * ID of limit
  *
- * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the `definition`
- * "identity".
+ * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
+ * `definition` "identity".
  *
  * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the `definition` "id".
  */
@@ -292,7 +292,8 @@ export declare type SubscriptionLimitIdentity = string;
 /**
  * JSON API type field
  *
- * This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the `definition` "type".
+ * This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
+ * `definition` "type".
  */
 export declare type SubscriptionFeatureType = 'subscription_feature';
 /**
@@ -334,8 +335,8 @@ export declare type ItemInstancesHrefSchema = {
     /** Attributes to filter records */
     filter?: {
         /**
-         * Record (or block record) IDs to fetch, comma separated. If you use this filter, you
-         * *must not* use `filter[type]` or `filter[fields]`
+         * Record (or block record) IDs to fetch, comma separated. If you use this filter,
+         * you *must not* use `filter[type]` or `filter[fields]`
          */
         ids?: string;
         /**
@@ -374,9 +375,9 @@ export declare type ItemInstancesHrefSchema = {
         [k: string]: unknown;
     };
     /**
-     * Fields used to order results. You *must* specify also `filter[type]` with one element
-     * only to be able use this option. Format: `<field_name>_<DIRECTION(ASC|DESC)>`. You
-     * can pass multiple comma separated rules
+     * Fields used to order results. You *must* specify also `filter[type]` with one
+     * element only to be able use this option. Format:
+     * `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
      */
     order_by?: string;
     /**
@@ -389,8 +390,8 @@ export declare type ItemInstancesHrefSchema = {
 /** This interface was referenced by `Item`'s JSON-Schema via the `references.hrefSchema` link. */
 export declare type ItemReferencesHrefSchema = {
     /**
-     * For Modular Content fields and Structured Text fields, return full payload for nested
-     * blocks instead of IDs
+     * For Modular Content fields and Structured Text fields, return full payload for
+     * nested blocks instead of IDs
      */
     nested?: 'true';
     /**
@@ -511,7 +512,10 @@ export declare type UploadInstancesHrefSchema = {
     };
     [k: string]: unknown;
 };
-/** This interface was referenced by `Upload`'s JSON-Schema via the `batch_add_tags.hrefSchema` link. */
+/**
+ * This interface was referenced by `Upload`'s JSON-Schema via the
+ * `batch_add_tags.hrefSchema` link.
+ */
 export declare type UploadBatchAddTagsHrefSchema = {
     /** IDs to tag, comma separated */
     'filter[ids]'?: string;
@@ -526,8 +530,8 @@ export declare type UploadBatchDestroyHrefSchema = {
 /** This interface was referenced by `Upload`'s JSON-Schema via the `references.hrefSchema` link. */
 export declare type UploadReferencesHrefSchema = {
     /**
-     * For Modular Content fields and Structured Text fields, return full payload for nested
-     * blocks instead of IDs
+     * For Modular Content fields and Structured Text fields, return full payload for
+     * nested blocks instead of IDs
      */
     nested?: string;
     /**
@@ -580,7 +584,8 @@ export declare type ScheduledUnpublishingType = 'scheduled_unpublishing';
  * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
  * `definition` "identity".
  *
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the `definition` "id".
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
+ * `definition` "id".
  */
 export declare type ScheduledUnpublishingIdentity = string;
 /**
@@ -629,7 +634,8 @@ export declare type MaintenanceModeType = 'maintenance_mode';
 /**
  * ID of maintenance_mode
  *
- * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition` "identity".
+ * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition`
+ * "identity".
  *
  * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition` "id".
  */
@@ -962,7 +968,10 @@ export interface RoleAttributes {
         on_creator?: 'anyone' | 'self' | 'role' | null;
         /** Permitted content scope */
         localization_scope?: 'all' | 'localized' | 'not_localized' | null;
-        /** Permitted localized content in this locale. Required when `localization_scope` is `localized` */
+        /**
+         * Permitted localized content in this locale. Required when `localization_scope` is
+         * `localized`
+         */
         locale?: string | null;
     }[];
     /** Prohibited actions on a model (or all) for a role */
@@ -978,7 +987,10 @@ export interface RoleAttributes {
         on_creator?: 'anyone' | 'self' | 'role' | null;
         /** Permitted content scope */
         localization_scope?: 'all' | 'localized' | 'not_localized' | null;
-        /** Permitted localized content in this locale. Required when `localization_scope` is `localized` */
+        /**
+         * Permitted localized content in this locale. Required when `localization_scope` is
+         * `localized`
+         */
         locale?: string | null;
     }[];
     /** Allowed actions on a model (or all) for a role */
@@ -990,7 +1002,10 @@ export interface RoleAttributes {
         on_creator?: 'anyone' | 'self' | 'role' | null;
         /** Permitted content scope */
         localization_scope?: 'all' | 'localized' | 'not_localized' | null;
-        /** Permitted localized content in this locale. Required when `localization_scope` is `localized` */
+        /**
+         * Permitted localized content in this locale. Required when `localization_scope` is
+         * `localized`
+         */
         locale?: string | null;
     }[];
     /** Prohibited actions on a model (or all) for a role */
@@ -1002,7 +1017,10 @@ export interface RoleAttributes {
         on_creator?: 'anyone' | 'self' | 'role' | null;
         /** Permitted content scope */
         localization_scope?: 'all' | 'localized' | 'not_localized' | null;
-        /** Permitted localized content in this locale. Required when `localization_scope` is `localized` */
+        /**
+         * Permitted localized content in this locale. Required when `localization_scope` is
+         * `localized`
+         */
         locale?: string | null;
     }[];
     /** Allowed build triggers for a role */
@@ -1092,8 +1110,8 @@ export interface RoleMeta {
             /** Permitted content scope */
             localization_scope?: 'all' | 'localized' | 'not_localized' | null;
             /**
-             * Permitted localized content in this locale. Required when `localization_scope` is
-             * `localized`
+             * Permitted localized content in this locale. Required when `localization_scope`
+             * is `localized`
              */
             locale?: string | null;
         }[];
@@ -1111,8 +1129,8 @@ export interface RoleMeta {
             /** Permitted content scope */
             localization_scope?: 'all' | 'localized' | 'not_localized' | null;
             /**
-             * Permitted localized content in this locale. Required when `localization_scope` is
-             * `localized`
+             * Permitted localized content in this locale. Required when `localization_scope`
+             * is `localized`
              */
             locale?: string | null;
         }[];
@@ -1126,8 +1144,8 @@ export interface RoleMeta {
             /** Permitted content scope */
             localization_scope?: 'all' | 'localized' | 'not_localized' | null;
             /**
-             * Permitted localized content in this locale. Required when `localization_scope` is
-             * `localized`
+             * Permitted localized content in this locale. Required when `localization_scope`
+             * is `localized`
              */
             locale?: string | null;
         }[];
@@ -1141,8 +1159,8 @@ export interface RoleMeta {
             /** Permitted content scope */
             localization_scope?: 'all' | 'localized' | 'not_localized' | null;
             /**
-             * Permitted localized content in this locale. Required when `localization_scope` is
-             * `localized`
+             * Permitted localized content in this locale. Required when `localization_scope`
+             * is `localized`
              */
             locale?: string | null;
         }[];
@@ -1440,9 +1458,9 @@ export interface RoleDestroyTargetSchema {
     data: Role;
 }
 /**
- * A DatoCMS administrative area can be accessed by multiple people. Every collaborator is
- * linked to a specific Role, which describes what actions it will be able to perform once
- * logged in.
+ * A DatoCMS administrative area can be accessed by multiple people. Every collaborator
+ * is linked to a specific Role, which describes what actions it will be able to perform
+ * once logged in.
  *
  * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "user".
  */
@@ -1638,7 +1656,8 @@ export interface AuditLogEvent {
 /**
  * JSON API attributes
  *
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `definition` "attributes".
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `definition`
+ * "attributes".
  */
 export interface AuditLogEventAttributes {
     /** The actual action performed */
@@ -1716,8 +1735,8 @@ export interface AuditLogEventQuerySchema {
             /** An SQL-like expression to filter the events */
             filter?: string;
             /**
-             * Set this value to get remaining results, if a meta.next_token was returned in the
-             * previous query response
+             * Set this value to get remaining results, if a meta.next_token was returned in
+             * the previous query response
              */
             next_token?: string;
             /**
@@ -1728,7 +1747,10 @@ export interface AuditLogEventQuerySchema {
         };
     };
 }
-/** This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `query.targetSchema` link. */
+/**
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
+ * `query.targetSchema` link.
+ */
 export interface AuditLogEventQueryTargetSchema {
     data: AuditLogEvent[];
     meta: {
@@ -1779,7 +1801,8 @@ export interface AccountData {
 /**
  * Stores the information regarding the current plan for the project.
  *
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "site_plan".
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
+ * "site_plan".
  */
 export interface SitePlan {
     type: SitePlanType;
@@ -1932,7 +1955,8 @@ export interface SitePlanData {
  * In DatoCMS you can organize the different Models present in your administrative area
  * reordering and grouping them, so that their purpose will be more clear to the final editor.
  *
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "menu_item".
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
+ * "menu_item".
  */
 export interface MenuItem {
     type: MenuItemType;
@@ -2072,7 +2096,8 @@ export interface MenuItemDestroyTargetSchema {
  * passes through the concept of Models, which are much like database tables. For
  * backward-compatibility reasons, the API refers to models as "item types".
  *
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "item_type".
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
+ * "item_type".
  */
 export interface ModelBlock {
     type: ItemTypeType;
@@ -2121,7 +2146,8 @@ export interface ItemTypeAttributes {
 /**
  * JSON API links
  *
- * This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition` "relationships".
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition`
+ * "relationships".
  */
 export interface ItemTypeRelationships {
     /** The item instance related to this item type */
@@ -2331,8 +2357,8 @@ export interface ItemTypeDestroyJobSchema {
 }
 /**
  * Each Model consists of a set of fields. Using the database metaphore, fields are like
- * table columns, and when creating them you need to specify their type (`string`, `file`,
- * `float`, etc.) and any required validation.
+ * table columns, and when creating them you need to specify their type (`string`,
+ * `file`, `float`, etc.) and any required validation.
  *
  * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "field".
  */
@@ -2380,8 +2406,8 @@ export interface FieldAttributes {
     /** Field appearance details, plugin configuration and field add-ons */
     appearance: {
         /**
-         * A valid editor can be a DatoCMS default field editor type (ie. `"single_line"`), or
-         * a plugin ID offering a custom field editor
+         * A valid editor can be a DatoCMS default field editor type (ie. `"single_line"`),
+         * or a plugin ID offering a custom field editor
          */
         editor: string;
         /** The specific field extension to use for the field (only if the editor is a modern plugin) */
@@ -2463,7 +2489,10 @@ export interface FieldCreateSchema {
                  * `"single_line"`), or a plugin ID offering a custom field editor
                  */
                 editor: string;
-                /** The specific field extension to use for the field (only if the editor is a modern plugin) */
+                /**
+                 * The specific field extension to use for the field (only if the editor is a
+                 * modern plugin)
+                 */
                 field_extension?: string;
                 /** The editor plugin's parameters */
                 parameters: {
@@ -2553,7 +2582,10 @@ export interface FieldUpdateSchema {
                  * `"single_line"`), or a plugin ID offering a custom field editor
                  */
                 editor: string;
-                /** The specific field extension to use for the field (only if the editor is a modern plugin) */
+                /**
+                 * The specific field extension to use for the field (only if the editor is a
+                 * modern plugin)
+                 */
                 field_extension?: string;
                 /** The editor plugin's parameters */
                 parameters: {
@@ -2925,7 +2957,10 @@ export interface AccessTokenSelfTargetSchema {
 export interface AccessTokenRegenerateTokenTargetSchema {
     data: AccessToken;
 }
-/** This interface was referenced by `AccessToken`'s JSON-Schema via the `destroy.targetSchema` link. */
+/**
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
+ * `destroy.targetSchema` link.
+ */
 export interface AccessTokenDestroyTargetSchema {
     data: AccessToken;
 }
@@ -2965,7 +3000,7 @@ export interface PluginAttributes {
         [k: string]: unknown;
     };
     /** Permissions granted to this plugin */
-    permissions: 'currentAccessToken'[];
+    permissions: 'currentUserAccessToken'[];
     /** The type of field extension a legacy plugin implements */
     plugin_type: 'field_editor' | 'sidebar' | 'field_addon' | null;
     /** On which types of field in which a legacy plugin can be used */
@@ -3010,8 +3045,11 @@ export interface PluginCreateSchema {
             description?: string;
             /** The entry point URL of the plugin. Only to be passed if package name key is not specified. */
             url?: string;
-            /** Permissions granted to this plugin. Only to be passed if package name key is not specified. */
-            permissions?: 'currentAccessToken'[];
+            /**
+             * Permissions granted to this plugin. Only to be passed if package name key is not
+             * specified.
+             */
+            permissions?: 'currentUserAccessToken'[];
             /**
              * The type of field extension this legacy plugin implements. Only to be passed if
              * package name key is not specified.
@@ -3132,8 +3170,8 @@ export interface SubscriptionLimit {
 /**
  * JSON API attributes
  *
- * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the `definition`
- * "attributes".
+ * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
+ * `definition` "attributes".
  */
 export interface SubscriptionLimitAttributes {
     /** The codename for the limit */
@@ -3192,7 +3230,8 @@ export interface SubscriptionFeatureAttributes {
 /**
  * JSON API data
  *
- * This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the `definition` "data".
+ * This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
+ * `definition` "data".
  */
 export interface SubscriptionFeatureData {
     type: SubscriptionFeatureType;
@@ -3235,7 +3274,8 @@ export interface BuildEventAttributes {
 /**
  * JSON API links
  *
- * This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition` "relationships".
+ * This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition`
+ * "relationships".
  */
 export interface BuildEventRelationships {
     /** Source build trigger */
@@ -3582,7 +3622,10 @@ export interface ItemBulkUnpublishSchema {
         };
     };
 }
-/** This interface was referenced by `Item`'s JSON-Schema via the `bulk_unpublish.targetSchema` link. */
+/**
+ * This interface was referenced by `Item`'s JSON-Schema via the
+ * `bulk_unpublish.targetSchema` link.
+ */
 export interface ItemBulkUnpublishTargetSchema {
     data: Job;
 }
@@ -3724,7 +3767,10 @@ export interface ItemVersionData {
     type: ItemVersionType;
     id: ItemVersionIdentity;
 }
-/** This interface was referenced by `ItemVersion`'s JSON-Schema via the `restore.targetSchema` link. */
+/**
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
+ * `restore.targetSchema` link.
+ */
 export interface ItemVersionRestoreTargetSchema {
     data: Job;
 }
@@ -4100,7 +4146,10 @@ export interface UploadBulkDestroySchema {
         };
     };
 }
-/** This interface was referenced by `Upload`'s JSON-Schema via the `bulk_destroy.targetSchema` link. */
+/**
+ * This interface was referenced by `Upload`'s JSON-Schema via the
+ * `bulk_destroy.targetSchema` link.
+ */
 export interface UploadBulkDestroyTargetSchema {
     data: Job;
 }
@@ -4113,9 +4162,9 @@ export interface UploadBulkDestroyJobSchema {
     };
 }
 /**
- * To upload a file in DatoCMS, first you need to obtain an upload permission through this
- * API endpoint. The response will contain the S3 URL where you will be able to upload the
- * file with a direct PUT request.
+ * To upload a file in DatoCMS, first you need to obtain an upload permission through
+ * this API endpoint. The response will contain the S3 URL where you will be able to
+ * upload the file with a direct PUT request.
  *
  * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
  * "upload_request".
@@ -4128,7 +4177,8 @@ export interface UploadRequest {
 /**
  * JSON API attributes
  *
- * This interface was referenced by `UploadRequest`'s JSON-Schema via the `definition` "attributes".
+ * This interface was referenced by `UploadRequest`'s JSON-Schema via the `definition`
+ * "attributes".
  */
 export interface UploadRequestAttributes {
     /** The URL to use to upload the file with a direct PUT request */
@@ -4348,10 +4398,10 @@ export interface SearchResultInstancesTargetSchema {
  * once your content has been published**. You can think of environments like code
  * branches: great for testing, development and pre-production environments.
  *
- * By default, every project has one environment, called **primary environment**, which is
- * meant to be used for the regular editorial workflow. Additionally, multiple **sandbox
- * environments** can be created by developers to safely test/experiment new changes in
- * the content.
+ * By default, every project has one environment, called **primary environment**, which
+ * is meant to be used for the regular editorial workflow. Additionally, multiple
+ * **sandbox environments** can be created by developers to safely test/experiment new
+ * changes in the content.
  *
  * Sandbox environments start out as **exact copies of one of the existing environments**
  * (ie. the primary one). The process of creating a new sandbox starting off from an
@@ -4368,9 +4418,9 @@ export interface SearchResultInstancesTargetSchema {
  * - Global SEO settings
  * - The content navigation bar
  *
- * When making changes to any of the aforementioned entities in any environment, including
- * the primary environment, **the data in all other environments isn’t affected** and
- * stays the same.
+ * When making changes to any of the aforementioned entities in any environment,
+ * including the primary environment, **the data in all other environments isn’t
+ * affected** and stays the same.
  *
  * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
  * "environment".
@@ -4420,7 +4470,10 @@ export interface EnvironmentForkTargetSchema {
 export interface EnvironmentForkJobSchema {
     data: Environment;
 }
-/** This interface was referenced by `Environment`'s JSON-Schema via the `promote.targetSchema` link. */
+/**
+ * This interface was referenced by `Environment`'s JSON-Schema via the
+ * `promote.targetSchema` link.
+ */
 export interface EnvironmentPromoteTargetSchema {
     data: Environment;
 }
@@ -4435,7 +4488,10 @@ export interface EnvironmentInstancesTargetSchema {
 export interface EnvironmentSelfTargetSchema {
     data: Environment;
 }
-/** This interface was referenced by `Environment`'s JSON-Schema via the `destroy.targetSchema` link. */
+/**
+ * This interface was referenced by `Environment`'s JSON-Schema via the
+ * `destroy.targetSchema` link.
+ */
 export interface EnvironmentDestroyTargetSchema {
     data: Job | Environment;
 }
@@ -4769,7 +4825,10 @@ export interface BuildTriggerCreateSchema {
         };
     };
 }
-/** This interface was referenced by `BuildTrigger`'s JSON-Schema via the `create.targetSchema` link. */
+/**
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema via the
+ * `create.targetSchema` link.
+ */
 export interface BuildTriggerCreateTargetSchema {
     data: BuildTrigger;
 }
@@ -4796,7 +4855,10 @@ export interface BuildTriggerUpdateSchema {
         };
     };
 }
-/** This interface was referenced by `BuildTrigger`'s JSON-Schema via the `update.targetSchema` link. */
+/**
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema via the
+ * `update.targetSchema` link.
+ */
 export interface BuildTriggerUpdateTargetSchema {
     data: BuildTrigger;
 }
@@ -4912,7 +4974,10 @@ export interface ItemTypeFilterUpdateTargetSchema {
 export interface ItemTypeFilterInstancesTargetSchema {
     data: ItemTypeFilter[];
 }
-/** This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the `self.targetSchema` link. */
+/**
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
+ * `self.targetSchema` link.
+ */
 export interface ItemTypeFilterSelfTargetSchema {
     data: ItemTypeFilter;
 }
@@ -4975,7 +5040,10 @@ export interface UploadFilterCreateSchema {
         };
     };
 }
-/** This interface was referenced by `UploadFilter`'s JSON-Schema via the `create.targetSchema` link. */
+/**
+ * This interface was referenced by `UploadFilter`'s JSON-Schema via the
+ * `create.targetSchema` link.
+ */
 export interface UploadFilterCreateTargetSchema {
     data: UploadFilter;
 }
@@ -4997,7 +5065,10 @@ export interface UploadFilterUpdateSchema {
         };
     };
 }
-/** This interface was referenced by `UploadFilter`'s JSON-Schema via the `update.targetSchema` link. */
+/**
+ * This interface was referenced by `UploadFilter`'s JSON-Schema via the
+ * `update.targetSchema` link.
+ */
 export interface UploadFilterUpdateTargetSchema {
     data: UploadFilter;
 }
@@ -5021,8 +5092,8 @@ export interface UploadFilterDestroyTargetSchema {
 }
 /**
  * A DatoCMS administrative area can be accessed by multiple people. Every invitation is
- * linked to a specific Role, which describes what actions it will be able to perform once
- * the user will register.
+ * linked to a specific Role, which describes what actions it will be able to perform
+ * once the user will register.
  *
  * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
  * "site_invitation".
@@ -5114,7 +5185,10 @@ export interface SiteInvitationUpdateTargetSchema {
 export interface SiteInvitationInstancesTargetSchema {
     data: SiteInvitation[];
 }
-/** This interface was referenced by `SiteInvitation`'s JSON-Schema via the `self.targetSchema` link. */
+/**
+ * This interface was referenced by `SiteInvitation`'s JSON-Schema via the
+ * `self.targetSchema` link.
+ */
 export interface SiteInvitationSelfTargetSchema {
     data: SiteInvitation;
 }
@@ -5241,7 +5315,8 @@ export interface EditingSessionDestroyTargetSchema {
  * A Single Sign-On group exists when a DatoCMS project is connected to an Identity
  * Provider. These groups can be used to link DatoCMS roles to the Identity Provider's groups.
  *
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "sso_group".
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
+ * "sso_group".
  */
 export interface SsoGroup {
     type: SsoGroupType;
@@ -5282,7 +5357,10 @@ export interface SsoGroupRelationships {
 export interface SsoGroupInstancesTargetSchema {
     data: SsoGroup[];
 }
-/** This interface was referenced by `SsoGroup`'s JSON-Schema via the `copy_roles.targetSchema` link. */
+/**
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
+ * `copy_roles.targetSchema` link.
+ */
 export interface SsoGroupCopyRolesTargetSchema {
     data: SsoGroup;
 }
@@ -5446,7 +5524,10 @@ export interface WhiteLabelSettingsData {
 export interface WhiteLabelSettingsSelfTargetSchema {
     data: WhiteLabelSettings;
 }
-/** This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the `update.schema` link. */
+/**
+ * This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
+ * `update.schema` link.
+ */
 export interface WhiteLabelSettingsUpdateSchema {
     data: {
         type: WhiteLabelSettingsType;
@@ -5594,9 +5675,9 @@ export interface DailyUsageInstancesTargetSchema {
 }
 /**
  * You can use counters to analyze your project's data consumption over a period of time.
- * Counters are especially useful if your project is exceeding its API calls/traffic quota
- * limits, to better understand where and how requests are originating. Counters are
- * updated every minute, so you can debug in real-time the results of your changes.
+ * Counters are especially useful if your project is exceeding its API calls/traffic
+ * quota limits, to better understand where and how requests are originating. Counters
+ * are updated every minute, so you can debug in real-time the results of your changes.
  *
  * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
  * "usage_counter".
@@ -5661,7 +5742,10 @@ export interface UploadTagData {
     type: UploadTagType;
     id: UploadTagIdentity;
 }
-/** This interface was referenced by `UploadTag`'s JSON-Schema via the `instances.targetSchema` link. */
+/**
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
+ * `instances.targetSchema` link.
+ */
 export interface UploadTagInstancesTargetSchema {
     data: UploadTag[];
 }

package/dist/types/connect.d.ts

@@ -1,7 +1,11 @@
 import { Field, ModelBlock } from './SiteApiSchema';
 import { ContentAreaSidebarItem, FieldExtensionOverride, InitPropertiesAndMethods, ItemFormSidebarPanel, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods, RenderSidebarPanePropertiesAndMethods, SettingsAreaSidebarItemGroup } from './types';
 export declare type SizingUtilities = {
-    /** Listens for DOM changes and automatically calls `setHeight` when it detects a change */
+    /**
+     * Listens for DOM changes and automatically calls `setHeight` when it detects a change.
+     * If you're using `datocms-react-ui` package, the `<Canvas />` component already takes
+     * care of calling this method for you.
+     */
     startAutoResizer: () => void;
     /** Stops resizing the iframe automatically */
     stopAutoResizer: () => void;

package/dist/types/types.d.ts

@@ -307,9 +307,9 @@ export declare type CommonProperties = {
     currentRole: Role;
     /**
      * The access token to perform API calls on behalf of the current user. Only available
-     * if `currentAccessToken` permission is granted
+     * if `currentUserAccessToken` additional permission is granted
      */
-    currentAccessToken: string | undefined;
+    currentUserAccessToken: string | undefined;
     /** The current plugin */
     plugin: Plugin;
     /** UI preferences of the current user (right now, only the preferred locale is available) */
@@ -438,7 +438,7 @@ export declare type UpdateParametersMethods = {
      *     });
      *
      *     await ctx.updateFieldAppearance(field.id, operations);
-     *     await ctx.notice(`Successfully edited field ${field.attributes.api_key}`);
+     *     ctx.notice(`Successfully edited field ${field.attributes.api_key}`);
      *   }
      */
     updateFieldAppearance: (fieldId: string, changes: FieldAppearanceChange[]) => Promise<void>;
@@ -450,9 +450,9 @@ export declare type LoadDataMethods = {
      * will also be available in the the `fields` property.
      *
      * @example
-     *   const fieldId = prompt('Please insert a field ID:');
+     *   const itemTypeId = prompt('Please insert a model ID:');
      *
-     *   const fields = await ctx.loadItemTypeFields(fieldId);
+     *   const fields = await ctx.loadItemTypeFields(itemTypeId);
      *
      *   ctx.notice(
      *     `Success! ${fields.map((field) => field.attributes.api_key).join(', ')}`,