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

package/dist/types/generated/SchemaTypes.d.ts

@@ -551,15 +551,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;
@@ -674,15 +674,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;
@@ -827,15 +827,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;
@@ -915,15 +915,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;
@@ -1038,15 +1038,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;
@@ -1199,21 +1199,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".
@@ -1270,15 +1255,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;
@@ -1316,21 +1301,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.
@@ -8214,7 +8214,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;
     /**
@@ -9596,7 +9596,6 @@ export type DailyUsage = {
     type: DailyUsageType;
     id: DailyUsageIdentity;
     attributes: DailyUsageAttributes;
-    relationships?: DailyUsageRelationships;
 };
 /**
  * JSON API attributes
@@ -9621,10 +9620,6 @@ export type DailyUsageAttributes = {
      * Content delivery API traffic
      */
     cda_traffic_bytes: number;
-    /**
-     * Content management API traffic
-     */
-    cma_traffic_bytes: number;
     /**
      * Uploads requests traffic
      */
@@ -9633,34 +9628,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;
 };
 /**
  * JSON API data
@@ -10065,6 +10032,16 @@ 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/dist/types/generated/SimpleSchemaTypes.d.ts

@@ -651,15 +651,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;
@@ -905,15 +905,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;
@@ -974,15 +974,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;
@@ -1092,15 +1092,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;
@@ -1240,15 +1240,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;
@@ -1468,21 +1468,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.
@@ -1549,15 +1534,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;
@@ -1600,21 +1585,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.
@@ -8101,7 +8101,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;
     /**
@@ -8160,7 +8160,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;
     /**
@@ -9347,10 +9347,6 @@ export type DailyUsage = {
      * Content delivery API traffic
      */
     cda_traffic_bytes: number;
-    /**
-     * Content management API traffic
-     */
-    cma_traffic_bytes: number;
     /**
      * Uploads requests traffic
      */
@@ -9359,21 +9355,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;
 };
 /**
  * JSON API data
@@ -9408,10 +9389,6 @@ export type DailyUsageAttributes = {
      * Content delivery API traffic
      */
     cda_traffic_bytes: number;
-    /**
-     * Content management API traffic
-     */
-    cma_traffic_bytes: number;
     /**
      * Uploads requests traffic
      */
@@ -9420,19 +9397,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;
 };
 /**
  * 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.
@@ -9783,6 +9747,16 @@ 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/dist/types/generated/resources/AccessToken.d.ts

@@ -1,6 +1,6 @@
 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";
     /**

package/dist/types/generated/resources/AuditLogEvent.d.ts

@@ -1,6 +1,6 @@
 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";
     /**

package/dist/types/generated/resources/BuildEvent.d.ts

@@ -1,6 +1,6 @@
 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";
     /**

package/dist/types/generated/resources/BuildTrigger.d.ts

@@ -1,6 +1,6 @@
 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";
     /**

package/dist/types/generated/resources/DailyUsage.d.ts

@@ -1,6 +1,6 @@
 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";
     /**

package/dist/types/generated/resources/EditingSession.d.ts

@@ -1,6 +1,6 @@
 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";
     /**

package/dist/types/generated/resources/EmojiSuggestions.d.ts

@@ -1,6 +1,6 @@
 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";
     /**

package/dist/types/generated/resources/Environment.d.ts

@@ -1,6 +1,6 @@
 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";
     /**

package/dist/types/generated/resources/Field.d.ts

@@ -1,6 +1,6 @@
 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";
     /**

package/dist/types/generated/resources/Fieldset.d.ts

@@ -1,6 +1,6 @@
 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";
     /**

package/dist/types/generated/resources/Item.d.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";
     /**
@@ -30,7 +30,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    listPagedIterator(queryParams?: SimpleSchemaTypes.ItemInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.Item, void, unknown>;
+    listPagedIterator(queryParams?: Utils.OmitFromKnownKeys<SimpleSchemaTypes.ItemInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.Item, void, unknown>;
     /**
      * Async iterator to auto-paginate over elements returned by rawList()
      *
@@ -39,7 +39,7 @@ export default class Item extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawListPagedIterator(queryParams?: SchemaTypes.ItemInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.Item, void, unknown>;
+    rawListPagedIterator(queryParams?: Utils.OmitFromKnownKeys<SchemaTypes.ItemInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.Item, void, unknown>;
     /**
      * Validates an existing record field
      *

package/dist/types/generated/resources/ItemType.d.ts

@@ -1,6 +1,6 @@
 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 ItemType extends BaseResource {
     static readonly TYPE: "item_type";
     /**

package/dist/types/generated/resources/ItemTypeFilter.d.ts

@@ -1,6 +1,6 @@
 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 ItemTypeFilter extends BaseResource {
     static readonly TYPE: "item_type_filter";
     /**