@datocms/cma-client 3.3.4 → 3.3.7

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

@@ -562,7 +562,6 @@ export type ItemInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 30, maximum is 500)
          */
         limit?: number;
-        [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>_(ASC|DESC)`, where `<field_name>` can be either the API key of a model's field, or one of the following meta columns: `id`, `_updated_at`, `_created_at`, `_status`, `_published_at`, `_first_published_at`, `_publication_scheduled_at`, `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable models). You can pass multiple comma separated rules.
@@ -685,7 +684,6 @@ export type ItemVersionInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 15, maximum is 50)
          */
         limit?: number;
-        [k: string]: unknown;
     };
     [k: string]: unknown;
 };
@@ -838,7 +836,6 @@ export type UploadInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 30, maximum is 500)
          */
         limit?: number;
-        [k: string]: unknown;
     };
     [k: string]: unknown;
 };
@@ -941,7 +938,6 @@ export type SearchResultInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 20, maximum is 100)
          */
         limit?: number;
-        [k: string]: unknown;
     };
     /**
      * Attributes to filter search results
@@ -1064,8 +1060,55 @@ export type WebhookCallInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 30, maximum is 500)
          */
         limit?: number;
-        [k: string]: unknown;
     };
+    /**
+     * Attributes to filter
+     */
+    filter?: {
+        /**
+         * IDs to fetch, comma separated
+         */
+        ids?: string;
+        fields?: {
+            webhook_id?: {
+                eq?: string;
+            };
+            entity_type?: {
+                /**
+                 * The subject of webhook triggering
+                 */
+                eq?: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
+            };
+            event_type?: {
+                /**
+                 * The event that triggers the webhook call
+                 */
+                eq?: 'create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate';
+            };
+            status?: {
+                /**
+                 * The current status
+                 */
+                eq?: 'pending' | 'success' | 'failed' | 'rescheduled';
+            };
+            last_sent_at?: {
+                gt?: string;
+                lt?: string;
+            };
+            next_retry_at?: {
+                gt?: string;
+                lt?: string;
+            };
+            created_at?: {
+                gt?: string;
+                lt?: string;
+            };
+        };
+    };
+    /**
+     * Fields used to order results
+     */
+    order_by?: 'webhook_id_asc' | 'webhook_id_desc' | 'created_at_asc' | 'created_at_desc' | 'last_sent_at_asc' | 'last_sent_at_desc' | 'next_retry_at_asc' | 'next_retry_at_desc';
     [k: string]: unknown;
 };
 /**
@@ -1281,7 +1324,6 @@ export type UploadTagInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 50, maximum is 500)
          */
         limit?: number;
-        [k: string]: unknown;
     };
     [k: string]: unknown;
 };
@@ -1327,7 +1369,6 @@ export type UploadSmartTagInstancesHrefSchema = {
          * The maximum number of entities to return (defaults to 50, maximum is 500)
          */
         limit?: number;
-        [k: string]: unknown;
     };
     [k: string]: unknown;
 };
@@ -4161,7 +4202,7 @@ export type ItemTypeDestroyJobSchema = {
  *     // single_line is a DatoCMS built-in editor that you can use with single-line string fields
  *     "editor": "single_line",
  *     // each built-in editor has specific settings
- *     "parameters": { "heading": true },
+ *     "parameters": { "heading": true, "placeholder": "My blog post title" },
  *     "addons": []
  *   },
  * }
@@ -4201,7 +4242,7 @@ export type ItemTypeDestroyJobSchema = {
  * {
  *   "appearance": {
  *     "editor": "single_line",
- *     "parameters": { "heading": true },
+ *     "parameters": { "heading": true, "placeholder": "My blog post title" },
  *     "addons": [
  *       {
  *         // "2138" is a the ID of a plugin exposing a manual addon editor
@@ -4902,9 +4943,10 @@ export type ItemTypeDestroyJobSchema = {
  *
  * Simple textual input for _Single-line string_ fields.
  *
- * | Parameter | Type      | Required | Description                                                                      |
- * | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
- * | `heading` | `Boolean` | ✅        | Indicates if the field should be shown bigger, as a field representing a heading |
+ * | Parameter | Type      | Required | Description                                                                                    |
+ * | ------------- | --------- | -------- | ------------------------------------------------------------------------------------------ |
+ * | `heading`     | `Boolean` | ✅       | Indicates if the field should be shown bigger, as a field representing a heading           |
+ * | `placeholder` | `String`  |          | A placeholder that will be shown in the editor's input to provide editors with an example. |
  *
  * </details>
  *
@@ -4935,6 +4977,10 @@ export type ItemTypeDestroyJobSchema = {
  *
  * Basic textarea editor for _Multiple-paragraph text_ fields.
  *
+ * | Parameter     | Type     | Required | Description                                                                                |
+ * | ------------- | -------- | -------- | ------------------------------------------------------------------------------------------ |
+ * | `placeholder` | `String` |          | A placeholder that will be shown in the editor's input to provide editors with an example. |
+ *
  * </details>
  *
  * <details>
@@ -4954,9 +5000,10 @@ export type ItemTypeDestroyJobSchema = {
  *
  * Built-in editor for _Slug_ fields.
  *
- * | Parameter    | Type     | Required | Description                                                                            |
- * | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- |
- * | `url_prefix` | `String` |          | A prefix that will be shown in the editor's form to give some context to your editors. |
+ * | Parameter     | Type     | Required | Description                                                                                |
+ * | ------------- | -------- | -------- | ------------------------------------------------------------------------------------------ |
+ * | `url_prefix`  | `String` |          | A prefix that will be shown in the editor's form to give some context to your editors.     |
+ * | `placeholder` | `String` |          | A placeholder that will be shown in the editor's input to provide editors with an example. |
  *
  * </details>
  *
@@ -5024,6 +5071,28 @@ export type ItemTypeDestroyJobSchema = {
  *
  * </details>
  *
+ * <details>
+ * <summary><code>integer</code></summary>
+ *
+ * Built-in editor for _Integer_ fields.
+ *
+ * | Parameter     | Type     | Required | Description                                                                                |
+ * | ------------- | -------- | -------- | ------------------------------------------------------------------------------------------ |
+ * | `placeholder` | `String` |          | A placeholder that will be shown in the editor's input to provide editors with an example. |
+ *
+ * </details>
+ *
+ * <details>
+ * <summary><code>float</code></summary>
+ *
+ * Built-in editor for _Float_ fields.
+ *
+ * | Parameter     | Type     | Required | Description                                                                                |
+ * | ------------- | -------- | -------- | ------------------------------------------------------------------------------------------ |
+ * | `placeholder` | `String` |          | A placeholder that will be shown in the editor's input to provide editors with an example. |
+ *
+ * </details>
+ *
  *
  * This interface was referenced by `DatoApi`'s JSON-Schema
  * via the `definition` "field".
@@ -8208,12 +8277,19 @@ export type WebhookAttributes = {
      * Additional headers that will be sent
      */
     headers: {
-        [k: string]: unknown;
+        [k: string]: string;
     };
-    /**
-     * All the events you will be notified for
-     */
-    events: unknown[];
+    events: {
+        /**
+         * The subject of webhook triggering
+         */
+        entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
+        event_types: ('create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate')[];
+        filters?: {
+            entity_type: 'item_type' | 'item' | 'build_trigger' | 'environment' | 'environment_type';
+            entity_ids: [string, ...string[]];
+        }[] | null;
+    }[];
     /**
      * Specifies which API version to use when serializing entities in the webhook payload
      */
@@ -8222,6 +8298,10 @@ export type WebhookAttributes = {
      * Whether the you want records present in the payload to show blocks expanded or not
      */
     nested_items_in_payload: boolean;
+    /**
+     * If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
+     */
+    auto_retry: boolean;
 };
 /**
  * JSON API data
@@ -8257,12 +8337,19 @@ export type WebhookCreateSchema = {
              * Additional headers that will be sent
              */
             headers: {
-                [k: string]: unknown;
+                [k: string]: string;
             };
-            /**
-             * All the events you will be notified for
-             */
-            events: unknown[];
+            events: {
+                /**
+                 * The subject of webhook triggering
+                 */
+                entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
+                event_types: ('create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate')[];
+                filters?: {
+                    entity_type: 'item_type' | 'item' | 'build_trigger' | 'environment' | 'environment_type';
+                    entity_ids: [string, ...string[]];
+                }[] | null;
+            }[];
             /**
              * HTTP Basic Authorization username
              */
@@ -8283,6 +8370,10 @@ export type WebhookCreateSchema = {
              * Whether the you want records present in the payload to show blocks expanded or not
              */
             nested_items_in_payload?: boolean;
+            /**
+             * If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
+             */
+            auto_retry?: boolean;
         };
     };
 };
@@ -8318,12 +8409,19 @@ export type WebhookUpdateSchema = {
              * Additional headers that will be sent
              */
             headers?: {
-                [k: string]: unknown;
+                [k: string]: string;
             };
-            /**
-             * All the events you will be notified for
-             */
-            events?: unknown[];
+            events?: {
+                /**
+                 * The subject of webhook triggering
+                 */
+                entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
+                event_types: ('create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate')[];
+                filters?: {
+                    entity_type: 'item_type' | 'item' | 'build_trigger' | 'environment' | 'environment_type';
+                    entity_ids: [string, ...string[]];
+                }[] | null;
+            }[];
             /**
              * HTTP Basic Authorization username
              */
@@ -8344,6 +8442,10 @@ export type WebhookUpdateSchema = {
              * Whether the you want records present in the payload to show blocks expanded or not
              */
             nested_items_in_payload?: boolean;
+            /**
+             * If enabled, the system will attempt to retry the call several times when the webhook operation fails due to timeouts or errors.
+             */
+            auto_retry?: boolean;
         };
     };
 };
@@ -8397,13 +8499,13 @@ export type WebhookCallAttributes = {
     /**
      * The subject of webhook triggering
      */
-    entity_type: 'item' | 'item_type' | 'upload';
+    entity_type: 'item_type' | 'item' | 'upload' | 'build_trigger' | 'environment' | 'maintenance_mode' | 'sso_user' | 'cda_cache_tags';
     /**
      * The event that triggers the webhook call
      */
-    event_type: 'create' | 'update' | 'delete' | 'publish' | 'unpublish';
+    event_type: 'create' | 'update' | 'delete' | 'publish' | 'unpublish' | 'promote' | 'deploy_started' | 'deploy_succeeded' | 'deploy_failed' | 'change' | 'invalidate';
     /**
-     * The moment the call occurred
+     * The moment the event was created
      */
     created_at: string;
     /**
@@ -8429,11 +8531,27 @@ export type WebhookCallAttributes = {
      */
     response_headers: {
         [k: string]: unknown;
-    };
+    } | null;
     /**
      * The body of the response
      */
     response_payload: string | null;
+    /**
+     * The number of retries attempted so far
+     */
+    attempted_auto_retries_count: number;
+    /**
+     * The last moment the call occurred
+     */
+    last_sent_at: string;
+    /**
+     * The date when the next retry attempt is scheduled to run. If no retry attempt is scheduled, it is set to null
+     */
+    next_retry_at: string | null;
+    /**
+     * The current status
+     */
+    status: 'pending' | 'success' | 'failed' | 'rescheduled';
 };
 /**
  * JSON API links
@@ -8468,6 +8586,15 @@ export type WebhookCallInstancesTargetSchema = {
     meta: {
         total_count: number;
     };
+    included: Webhook[];
+};
+/**
+ * This interface was referenced by `WebhookCall`'s JSON-Schema
+ * via the `self.targetSchema` link.
+ */
+export type WebhookCallSelfTargetSchema = {
+    data: WebhookCall;
+    included: Webhook[];
 };
 /**
  * Configuration for different build triggers. You can have different staging and production environments in order to test your site before final deploy