@datocms/cma-client 3.1.7-alpha.2 → 3.1.8

package/src/generated/SchemaTypes.ts

@@ -553,15 +553,15 @@ export type ItemInstancesHrefSchema = {
    */
   locale?: string;
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first record to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of records to fetch (defaults to 30, maximum is 500)
+     * The maximum number of entities to return (defaults to 30, maximum is 500)
      */
     limit?: number;
     [k: string]: unknown;
@@ -676,15 +676,15 @@ export type ItemVersionInstancesHrefSchema = {
    */
   nested?: boolean;
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first element to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of elements to fetch  (defaults to 15, maximum is 50)
+     * The maximum number of entities to return (defaults to 15, maximum is 50)
      */
     limit?: number;
     [k: string]: unknown;
@@ -829,15 +829,15 @@ export type UploadInstancesHrefSchema = {
    */
   order_by?: string;
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first upload to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of uplads to fetch (defaults to 30, maximum is 500)
+     * The maximum number of entities to return (defaults to 30, maximum is 500)
      */
     limit?: number;
     [k: string]: unknown;
@@ -917,15 +917,15 @@ export type SearchResultIdentity = string;
  */
 export type SearchResultInstancesHrefSchema = {
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first element to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of elements to fetch (defaults to 20, maximum is 100)
+     * The maximum number of entities to return (defaults to 20, maximum is 100)
      */
     limit?: number;
     [k: string]: unknown;
@@ -1040,15 +1040,15 @@ export type WebhookCallIdentity = string;
  */
 export type WebhookCallInstancesHrefSchema = {
   /**
-   * Params to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first element to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of elements to fetch (defaults to 30, maximum is 500)
+     * The maximum number of entities to return (defaults to 30, maximum is 500)
      */
     limit?: number;
     [k: string]: unknown;
@@ -1201,21 +1201,6 @@ export type DailyUsageType = 'daily_usage';
  * via the `definition` "id".
  */
 export type DailyUsageIdentity = string;
-/**
- * This interface was referenced by `Site`'s JSON-Schema
- * via the `definition` "type".
- */
-export type SiteType = 'site';
-/**
- * ID of site
- *
- * This interface was referenced by `Site`'s JSON-Schema
- * via the `definition` "identity".
- *
- * This interface was referenced by `Site`'s JSON-Schema
- * via the `definition` "id".
- */
-export type SiteIdentity = string;
 /**
  * This interface was referenced by `UsageCounter`'s JSON-Schema
  * via the `definition` "type".
@@ -1291,15 +1276,15 @@ export type UploadTagInstancesHrefSchema = {
     [k: string]: unknown;
   };
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first tag to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of tags to fetch (defaults to 50, maximum is 500)
+     * The maximum number of entities to return (defaults to 50, maximum is 500)
      */
     limit?: number;
     [k: string]: unknown;
@@ -1337,21 +1322,36 @@ export type UploadSmartTagInstancesHrefSchema = {
     [k: string]: unknown;
   };
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first tag to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of tags to fetch (defaults to 50, maximum is 500)
+     * The maximum number of entities to return (defaults to 50, maximum is 500)
      */
     limit?: number;
     [k: string]: unknown;
   };
   [k: string]: unknown;
 };
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type SiteType = 'site';
+/**
+ * ID of site
+ *
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type SiteIdentity = string;
 /**
  * This interface was referenced by `Site`'s JSON-Schema
  * via the `self.hrefSchema` link.
@@ -8846,7 +8846,7 @@ export type WebhookCallAttributes = {
     [k: string]: unknown;
   };
   /**
-   * The body of the request
+   * The webhook's request payload is encoded as a string. Use `JSON.parse()` to parse it.
    */
   request_payload: string;
   /**
@@ -10337,7 +10337,6 @@ export type DailyUsage = {
   type: DailyUsageType;
   id: DailyUsageIdentity;
   attributes: DailyUsageAttributes;
-  relationships?: DailyUsageRelationships;
 };
 
 /**
@@ -10363,10 +10362,6 @@ export type DailyUsageAttributes = {
    * Content delivery API traffic
    */
   cda_traffic_bytes: number;
-  /**
-   * Content management API traffic
-   */
-  cma_traffic_bytes: number;
   /**
    * Uploads requests traffic
    */
@@ -10375,36 +10370,6 @@ export type DailyUsageAttributes = {
    * Video streaming seconds
    */
   mux_delivered_seconds: number;
-  /**
-   * Video encoding seconds
-   */
-  mux_encoded_seconds: number;
-};
-
-/**
- * JSON API links
- *
- * This interface was referenced by `DailyUsage`'s JSON-Schema
- * via the `definition` "relationships".
- */
-export type DailyUsageRelationships = {
-  /**
-   * Site that generate the usage
-   */
-  site?: {
-    data: SiteData;
-  };
-};
-
-/**
- * JSON API data
- *
- * This interface was referenced by `Site`'s JSON-Schema
- * via the `definition` "data".
- */
-export type SiteData = {
-  type: SiteType;
-  id: SiteIdentity;
 };
 
 /**
@@ -10830,6 +10795,17 @@ export type SiteMeta = {
   custom_upload_storage_settings?: boolean;
 };
 
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type SiteData = {
+  type: SiteType;
+  id: SiteIdentity;
+};
+
 /**
  * This interface was referenced by `Site`'s JSON-Schema
  * via the `self.targetSchema` link.

package/src/generated/SimpleSchemaTypes.ts

@@ -653,15 +653,15 @@ export type ItemInstancesHrefSchema = {
    */
   locale?: string;
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first record to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of records to fetch (defaults to 30, maximum is 500)
+     * The maximum number of entities to return (defaults to 30, maximum is 500)
      */
     limit?: number;
     [k: string]: unknown;
@@ -907,15 +907,15 @@ export type ItemVersionInstancesHrefSchema = {
    */
   nested?: boolean;
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first element to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of elements to fetch  (defaults to 15, maximum is 50)
+     * The maximum number of entities to return (defaults to 15, maximum is 50)
      */
     limit?: number;
     [k: string]: unknown;
@@ -976,15 +976,15 @@ export type UploadInstancesHrefSchema = {
    */
   order_by?: string;
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first upload to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of uplads to fetch (defaults to 30, maximum is 500)
+     * The maximum number of entities to return (defaults to 30, maximum is 500)
      */
     limit?: number;
     [k: string]: unknown;
@@ -1094,15 +1094,15 @@ export type SearchResultInstancesTargetSchema = SearchResult[];
  */
 export type SearchResultInstancesHrefSchema = {
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first element to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of elements to fetch (defaults to 20, maximum is 100)
+     * The maximum number of entities to return (defaults to 20, maximum is 100)
      */
     limit?: number;
     [k: string]: unknown;
@@ -1242,15 +1242,15 @@ export type WebhookCallInstancesTargetSchema = WebhookCall[];
  */
 export type WebhookCallInstancesHrefSchema = {
   /**
-   * Params to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first element to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of elements to fetch (defaults to 30, maximum is 500)
+     * The maximum number of entities to return (defaults to 30, maximum is 500)
      */
     limit?: number;
     [k: string]: unknown;
@@ -1476,21 +1476,6 @@ export type DailyUsageIdentity = string;
  * via the `definition` "type".
  */
 export type DailyUsageType = 'daily_usage';
-/**
- * This interface was referenced by `Site`'s JSON-Schema
- * via the `definition` "type".
- */
-export type SiteType = 'site';
-/**
- * ID of site
- *
- * This interface was referenced by `Site`'s JSON-Schema
- * via the `definition` "identity".
- *
- * This interface was referenced by `Site`'s JSON-Schema
- * via the `definition` "id".
- */
-export type SiteIdentity = string;
 /**
  * This interface was referenced by `DailyUsage`'s JSON-Schema
  * via the `instances.targetSchema` link.
@@ -1576,15 +1561,15 @@ export type UploadTagInstancesHrefSchema = {
     [k: string]: unknown;
   };
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first tag to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of tags to fetch (defaults to 50, maximum is 500)
+     * The maximum number of entities to return (defaults to 50, maximum is 500)
      */
     limit?: number;
     [k: string]: unknown;
@@ -1627,21 +1612,36 @@ export type UploadSmartTagInstancesHrefSchema = {
     [k: string]: unknown;
   };
   /**
-   * Attributes to manage results pagination
+   * Parameters to control offset-based pagination
    */
   page?: {
     /**
-     * Index of first tag to fetch (defaults to 0)
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
      */
     offset?: number;
     /**
-     * Number of tags to fetch (defaults to 50, maximum is 500)
+     * The maximum number of entities to return (defaults to 50, maximum is 500)
      */
     limit?: number;
     [k: string]: unknown;
   };
   [k: string]: unknown;
 };
+/**
+ * ID of site
+ *
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "identity".
+ *
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "id".
+ */
+export type SiteIdentity = string;
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "type".
+ */
+export type SiteType = 'site';
 /**
  * This interface was referenced by `Site`'s JSON-Schema
  * via the `self.hrefSchema` link.
@@ -8687,7 +8687,7 @@ export type WebhookCall = {
     [k: string]: unknown;
   };
   /**
-   * The body of the request
+   * The webhook's request payload is encoded as a string. Use `JSON.parse()` to parse it.
    */
   request_payload: string;
   /**
@@ -8748,7 +8748,7 @@ export type WebhookCallAttributes = {
     [k: string]: unknown;
   };
   /**
-   * The body of the request
+   * The webhook's request payload is encoded as a string. Use `JSON.parse()` to parse it.
    */
   request_payload: string;
   /**
@@ -9983,10 +9983,6 @@ export type DailyUsage = {
    * Content delivery API traffic
    */
   cda_traffic_bytes: number;
-  /**
-   * Content management API traffic
-   */
-  cma_traffic_bytes: number;
   /**
    * Uploads requests traffic
    */
@@ -9995,22 +9991,6 @@ export type DailyUsage = {
    * Video streaming seconds
    */
   mux_delivered_seconds: number;
-  /**
-   * Video encoding seconds
-   */
-  mux_encoded_seconds: number;
-  site?: SiteData;
-};
-
-/**
- * JSON API data
- *
- * This interface was referenced by `Site`'s JSON-Schema
- * via the `definition` "data".
- */
-export type SiteData = {
-  type: SiteType;
-  id: SiteIdentity;
 };
 
 /**
@@ -10047,10 +10027,6 @@ export type DailyUsageAttributes = {
    * Content delivery API traffic
    */
   cda_traffic_bytes: number;
-  /**
-   * Content management API traffic
-   */
-  cma_traffic_bytes: number;
   /**
    * Uploads requests traffic
    */
@@ -10059,20 +10035,6 @@ export type DailyUsageAttributes = {
    * Video streaming seconds
    */
   mux_delivered_seconds: number;
-  /**
-   * Video encoding seconds
-   */
-  mux_encoded_seconds: number;
-};
-
-/**
- * JSON API links
- *
- * This interface was referenced by `DailyUsage`'s JSON-Schema
- * via the `definition` "relationships".
- */
-export type DailyUsageRelationships = {
-  site?: SiteData;
 };
 
 /**
@@ -10433,6 +10395,17 @@ export type SiteMeta = {
   custom_upload_storage_settings?: boolean;
 };
 
+/**
+ * JSON API data
+ *
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "data".
+ */
+export type SiteData = {
+  type: SiteType;
+  id: SiteIdentity;
+};
+
 /**
  * JSON API attributes
  *

package/src/generated/resources/AccessToken.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class AccessToken extends BaseResource {
   static readonly TYPE = 'access_token' as const;

package/src/generated/resources/AuditLogEvent.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class AuditLogEvent extends BaseResource {
   static readonly TYPE = 'audit_log_event' as const;

package/src/generated/resources/BuildEvent.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class BuildEvent extends BaseResource {
   static readonly TYPE = 'build_event' as const;

package/src/generated/resources/BuildTrigger.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class BuildTrigger extends BaseResource {
   static readonly TYPE = 'build_trigger' as const;

package/src/generated/resources/DailyUsage.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class DailyUsage extends BaseResource {
   static readonly TYPE = 'daily_usage' as const;

package/src/generated/resources/EditingSession.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class EditingSession extends BaseResource {
   static readonly TYPE = 'editing_session' as const;

package/src/generated/resources/EmojiSuggestions.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class EmojiSuggestions extends BaseResource {
   static readonly TYPE = 'emoji_suggestions' as const;

package/src/generated/resources/Environment.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class Environment extends BaseResource {
   static readonly TYPE = 'environment' as const;

package/src/generated/resources/Field.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class Field extends BaseResource {
   static readonly TYPE = 'field' as const;

package/src/generated/resources/Fieldset.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class Fieldset extends BaseResource {
   static readonly TYPE = 'fieldset' as const;

package/src/generated/resources/Item.ts

@@ -1,7 +1,7 @@
 import * as Utils from '@datocms/rest-client-utils';
 import BaseResource from '../../BaseResource';
-import * as SchemaTypes from '../SchemaTypes';
-import * as SimpleSchemaTypes from '../SimpleSchemaTypes';
+import type * as SchemaTypes from '../SchemaTypes';
+import type * as SimpleSchemaTypes from '../SimpleSchemaTypes';
 
 export default class Item extends BaseResource {
   static readonly TYPE = 'item' as const;
@@ -49,7 +49,10 @@ export default class Item extends BaseResource {
    * @throws {TimeoutError}
    */
   async *listPagedIterator(
-    queryParams?: SimpleSchemaTypes.ItemInstancesHrefSchema,
+    queryParams?: Utils.OmitFromKnownKeys<
+      SimpleSchemaTypes.ItemInstancesHrefSchema,
+      'page'
+    >,
     iteratorOptions?: Utils.IteratorOptions,
   ) {
     for await (const element of this.rawListPagedIterator(
@@ -71,9 +74,14 @@ export default class Item extends BaseResource {
    * @throws {TimeoutError}
    */
   rawListPagedIterator(
-    queryParams?: SchemaTypes.ItemInstancesHrefSchema,
+    queryParams?: Utils.OmitFromKnownKeys<
+      SchemaTypes.ItemInstancesHrefSchema,
+      'page'
+    >,
     iteratorOptions?: Utils.IteratorOptions,
   ) {
+    Utils.warnOnPageQueryParam(queryParams);
+
     return Utils.rawPageIterator<
       SchemaTypes.ItemInstancesTargetSchema['data'][0]
     >(