@datocms/cma-client 3.3.4 → 3.3.7

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

@@ -662,7 +662,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.
@@ -916,7 +915,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;
 };
@@ -985,7 +983,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;
 };
@@ -1123,7 +1120,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
@@ -1271,8 +1267,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;
 };
 /**
@@ -1561,7 +1604,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;
 };
@@ -1612,7 +1654,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;
 };
@@ -4628,7 +4669,7 @@ export type JobData = {
  *     // 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": []
  *   },
  * }
@@ -4668,7 +4709,7 @@ export type JobData = {
  * {
  *   "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
@@ -5369,9 +5410,10 @@ export type JobData = {
  *
  * 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>
  *
@@ -5402,6 +5444,10 @@ export type JobData = {
  *
  * 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>
@@ -5421,9 +5467,10 @@ export type JobData = {
  *
  * 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>
  *
@@ -5491,6 +5538,28 @@ export type JobData = {
  *
  * </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".
@@ -8059,12 +8128,19 @@ export type Webhook = {
      * 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
      */
@@ -8073,6 +8149,10 @@ export type Webhook = {
      * 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;
 };
 export type WebhookCreateTargetSchema = Webhook;
 export type WebhookUpdateTargetSchema = Webhook;
@@ -8123,12 +8203,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
      */
@@ -8137,6 +8224,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;
 };
 /**
  * This interface was referenced by `Webhook`'s JSON-Schema
@@ -8160,12 +8251,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
      */
@@ -8186,6 +8284,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;
 };
 /**
  * This interface was referenced by `Webhook`'s JSON-Schema
@@ -8210,12 +8312,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
      */
@@ -8236,6 +8345,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;
 };
 /**
  * Represents a log entry in the webhooks activity list.
@@ -8249,13 +8362,13 @@ export type WebhookCall = {
     /**
      * 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;
     /**
@@ -8281,13 +8394,30 @@ export type WebhookCall = {
      */
     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';
     webhook: WebhookData;
 };
+export type WebhookCallSelfTargetSchema = WebhookCall;
 /**
  * JSON API data
  *
@@ -8308,13 +8438,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;
     /**
@@ -8340,11 +8470,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

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

@@ -40,6 +40,24 @@ export default class WebhookCall extends BaseResource {
      * @throws {TimeoutError}
      */
     rawListPagedIterator(queryParams?: Utils.OmitFromKnownKeys<SchemaTypes.WebhookCallInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.WebhookCall, void, unknown>;
+    /**
+     * Retrieve a webhook call
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    find(webhookCallId: string | SimpleSchemaTypes.WebhookCallData): Promise<SimpleSchemaTypes.WebhookCall>;
+    /**
+     * Retrieve a webhook call
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawFind(webhookCallId: string): Promise<SchemaTypes.WebhookCallSelfTargetSchema>;
     /**
      * Re-send the webhook call
      *

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@datocms/cma-client",
-  "version": "3.3.4",
+  "version": "3.3.7",
   "description": "JS client for DatoCMS REST Content Management API",
-  "keywords": ["datocms", "client"],
+  "keywords": [
+    "datocms",
+    "client"
+  ],
   "author": "Stefano Verna <s.verna@datocms.com>",
   "homepage": "https://github.com/datocms/js-rest-api-clients/tree/main/packages/cma-client#readme",
   "license": "MIT",
@@ -14,7 +17,11 @@
     "lib": "dist",
     "test": "__tests__"
   },
-  "files": ["dist", "src", "resources.json"],
+  "files": [
+    "dist",
+    "src",
+    "resources.json"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -30,12 +37,12 @@
     "url": "https://github.com/datocms/js-rest-api-clients/issues"
   },
   "dependencies": {
-    "@datocms/rest-client-utils": "^3.3.4",
+    "@datocms/rest-client-utils": "^3.3.5",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^3.3.4",
+    "@datocms/dashboard-client": "^3.3.7",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "0fa5f212739ec6f27a717a1450f18deb12a2a482"
+  "gitHead": "97f5a4a4c7c505305e90115907d2db971bacc2ce"
 }

package/resources.json

@@ -3008,7 +3008,8 @@
             "http_basic_password",
             "enabled",
             "payload_api_version",
-            "nested_items_in_payload"
+            "nested_items_in_payload",
+            "auto_retry"
           ],
           "relationships": []
         },
@@ -3051,7 +3052,8 @@
             "http_basic_password",
             "enabled",
             "payload_api_version",
-            "nested_items_in_payload"
+            "nested_items_in_payload",
+            "auto_retry"
           ],
           "relationships": []
         },
@@ -3150,6 +3152,31 @@
         "name": "list",
         "rawName": "rawList"
       },
+      {
+        "returnsCollection": false,
+        "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook-call/self",
+        "rel": "self",
+        "urlTemplate": "/webhook_calls/${webhookCallId}",
+        "method": "GET",
+        "comment": "Retrieve a webhook call",
+        "urlPlaceholders": [
+          {
+            "variableName": "webhookCallId",
+            "isEntityId": true,
+            "relType": "WebhookCallData"
+          }
+        ],
+        "entityIdPlaceholder": {
+          "variableName": "webhookCallId",
+          "isEntityId": true,
+          "relType": "WebhookCallData"
+        },
+        "optionalRequestBody": false,
+        "queryParamsRequired": false,
+        "responseType": "WebhookCallSelfTargetSchema",
+        "name": "find",
+        "rawName": "rawFind"
+      },
       {
         "returnsCollection": false,
         "docUrl": "https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook",

package/src/generated/Client.ts

@@ -145,7 +145,7 @@ export class Client {
       ...this.config,
       ...options,
       logFn: this.config.logFn || console.log,
-      userAgent: '@datocms/cma-client v3.3.4',
+      userAgent: '@datocms/cma-client v3.3.7',
       baseUrl: this.baseUrl,
       preCallStack: new Error().stack,
       extraHeaders: {