New schema

datocms · Jul 3, 2024 · 297ae0c · 297ae0c
1 parent 0fa5f21
commit 297ae0c
Show file tree

Hide file tree

Showing 12 changed files with 139 additions and 67 deletions.
diff --git a/packages/cma-client-browser/package.json b/packages/cma-client-browser/package.json
@@ -2,10 +2,7 @@
   "name": "@datocms/cma-client-browser",
   "version": "3.3.4",
   "description": "Browser client for DatoCMS REST Content Management API",
-  "keywords": [
-    "datocms",
-    "client"
-  ],
+  "keywords": ["datocms", "client"],
   "author": "Stefano Verna <[email protected]>",
   "homepage": "https://github.com/datocms/js-rest-api-clients/tree/main/packages/cma-client-browser#readme",
   "license": "MIT",
@@ -16,10 +13,7 @@
     "lib": "dist",
     "test": "__tests__"
   },
-  "files": [
-    "dist",
-    "src"
-  ],
+  "files": ["dist", "src"],
   "publishConfig": {
     "access": "public"
   },

diff --git a/packages/cma-client-node/package.json b/packages/cma-client-node/package.json
@@ -2,10 +2,7 @@
   "name": "@datocms/cma-client-node",
   "version": "3.3.4",
   "description": "NodeJS client for DatoCMS REST Content Management API",
-  "keywords": [
-    "datocms",
-    "client"
-  ],
+  "keywords": ["datocms", "client"],
   "author": "Stefano Verna <[email protected]>",
   "homepage": "https://github.com/datocms/js-rest-api-clients/tree/main/packages/cma-client-node#readme",
   "license": "MIT",
@@ -16,10 +13,7 @@
     "lib": "dist",
     "test": "__tests__"
   },
-  "files": [
-    "dist",
-    "src"
-  ],
+  "files": ["dist", "src"],
   "publishConfig": {
     "access": "public"
   },

diff --git a/packages/cma-client/package.json b/packages/cma-client/package.json
@@ -2,10 +2,7 @@
   "name": "@datocms/cma-client",
   "version": "3.3.4",
   "description": "JS client for DatoCMS REST Content Management API",
-  "keywords": [
-    "datocms",
-    "client"
-  ],
+  "keywords": ["datocms", "client"],
   "author": "Stefano Verna <[email protected]>",
   "homepage": "https://github.com/datocms/js-rest-api-clients/tree/main/packages/cma-client#readme",
   "license": "MIT",
@@ -17,11 +14,7 @@
     "lib": "dist",
     "test": "__tests__"
   },
-  "files": [
-    "dist",
-    "src",
-    "resources.json"
-  ],
+  "files": ["dist", "src", "resources.json"],
   "publishConfig": {
     "access": "public"
   },

diff --git a/packages/cma-client/src/generated/SchemaTypes.ts b/packages/cma-client/src/generated/SchemaTypes.ts
@@ -4439,7 +4439,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": []
  *   },
  * }
@@ -4479,7 +4479,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
@@ -5180,9 +5180,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>
  *
@@ -5213,6 +5214,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>
@@ -5232,9 +5237,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>
  *
@@ -5302,6 +5308,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".

diff --git a/packages/cma-client/src/generated/SimpleSchemaTypes.ts b/packages/cma-client/src/generated/SimpleSchemaTypes.ts
@@ -4904,7 +4904,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": []
  *   },
  * }
@@ -4944,7 +4944,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
@@ -5645,9 +5645,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>
  *
@@ -5678,6 +5679,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>
@@ -5697,9 +5702,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>
  *
@@ -5767,6 +5773,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".

diff --git a/packages/dashboard-client/package.json b/packages/dashboard-client/package.json
@@ -2,10 +2,7 @@
   "name": "@datocms/dashboard-client",
   "version": "3.3.4",
   "description": "JS client for DatoCMS REST Content Management API",
-  "keywords": [
-    "datocms",
-    "client"
-  ],
+  "keywords": ["datocms", "client"],
   "author": "Stefano Verna <[email protected]>",
   "homepage": "https://github.com/datocms/js-rest-api-clients/tree/main/packages/cma-client#readme",
   "license": "MIT",
@@ -17,11 +14,7 @@
     "lib": "dist",
     "test": "__tests__"
   },
-  "files": [
-    "dist",
-    "src",
-    "resources.json"
-  ],
+  "files": ["dist", "src", "resources.json"],
   "publishConfig": {
     "access": "public"
   },

diff --git a/packages/dashboard-client/resources.json b/packages/dashboard-client/resources.json
@@ -284,6 +284,7 @@
           ],
           "relationships": []
         },
+        "queryParamsType": "SiteCreateHrefSchema",
         "queryParamsRequired": false,
         "responseType": "SiteCreateJobSchema",
         "name": "create",
@@ -381,6 +382,7 @@
           ],
           "relationships": ["plan", "billing_profile"]
         },
+        "queryParamsType": "SiteDuplicateHrefSchema",
         "queryParamsRequired": false,
         "responseType": "SiteDuplicateJobSchema",
         "rawName": "rawDuplicate"

diff --git a/packages/dashboard-client/src/generated/SchemaTypes.ts b/packages/dashboard-client/src/generated/SchemaTypes.ts
@@ -237,6 +237,17 @@ export type SiteInstancesHrefSchema = {
   include?: string;
   [k: string]: unknown;
 };
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `create.hrefSchema` link.
+ */
+export type SiteCreateHrefSchema = {
+  /**
+   * Confirm the creation of the project starting from a public template project, even if the copy of videos require significant use of Video Encoding resources
+   */
+  confirm_mux_encoding_consumption?: string;
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `PerSitePricingBillingProfile`'s JSON-Schema
  * via the `definition` "type".
@@ -253,6 +264,17 @@ export type PerSitePricingBillingProfileType =
  * via the `definition` "id".
  */
 export type PerSitePricingBillingProfileIdentity = string;
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `duplicate.hrefSchema` link.
+ */
+export type SiteDuplicateHrefSchema = {
+  /**
+   * Confirm the operation, even if the copy of videos contained in the project requires significant use of Video Encoding resources
+   */
+  confirm_mux_encoding_consumption?: string;
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `Account`'s JSON-Schema
  * via the `self.hrefSchema` link.

diff --git a/packages/dashboard-client/src/generated/SimpleSchemaTypes.ts b/packages/dashboard-client/src/generated/SimpleSchemaTypes.ts
@@ -294,6 +294,17 @@ export type SiteInstancesHrefSchema = {
  * via the `create.targetSchema` link.
  */
 export type SiteCreateTargetSchema = Site | Job;
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `create.hrefSchema` link.
+ */
+export type SiteCreateHrefSchema = {
+  /**
+   * Confirm the creation of the project starting from a public template project, even if the copy of videos require significant use of Video Encoding resources
+   */
+  confirm_mux_encoding_consumption?: string;
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `Site`'s JSON-Schema
  * via the `destroy.targetSchema` link.
@@ -315,6 +326,17 @@ export type PerSitePricingBillingProfileType =
  * via the `definition` "id".
  */
 export type PerSitePricingBillingProfileIdentity = string;
+/**
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `duplicate.hrefSchema` link.
+ */
+export type SiteDuplicateHrefSchema = {
+  /**
+   * Confirm the operation, even if the copy of videos contained in the project requires significant use of Video Encoding resources
+   */
+  confirm_mux_encoding_consumption?: string;
+  [k: string]: unknown;
+};
 /**
  * ID of next_invoice_estimate
  *