@datocms/cma-client 6.4.0 → 6.7.0

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

@@ -65,7 +65,7 @@ export default class Item extends BaseResource {
     }, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<RawApiTypes.ItemInstancesTargetSchema<NoInfer<D>, false>['data'][0]>;
     rawListPagedIterator<D extends ItemTypeDefinition = ItemTypeDefinition>(queryParams?: Utils.OmitFromKnownKeys<RawApiTypes.ItemInstancesHrefSchema<D>, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<RawApiTypes.ItemInstancesTargetSchema<NoInfer<D>, true>['data'][0]>;
     /**
-     * Validates an existing record field
+     * Validate an existing record
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_existing
      *
@@ -76,7 +76,7 @@ export default class Item extends BaseResource {
      */
     validateExisting<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string | ApiTypes.ItemData, body: ApiTypes.ItemValidateExistingSchema<NoInfer<D>>): Promise<void>;
     /**
-     * Validates an existing record field
+     * Validate an existing record
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_existing
      *
@@ -87,7 +87,7 @@ export default class Item extends BaseResource {
      */
     rawValidateExisting<D extends ItemTypeDefinition = ItemTypeDefinition>(itemId: string, body: RawApiTypes.ItemValidateExistingSchema<NoInfer<D>>): Promise<void>;
     /**
-     * Validates a record field
+     * Validate a new record
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_new
      *
@@ -98,7 +98,7 @@ export default class Item extends BaseResource {
      */
     validateNew<D extends ItemTypeDefinition = ItemTypeDefinition>(body: ApiTypes.ItemValidateNewSchema<NoInfer<D>>): Promise<void>;
     /**
-     * Validates a record field
+     * Validate a new record
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item/validate_new
      *

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

@@ -47,7 +47,7 @@ export default class ItemType extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    list(): Promise<ApiTypes.ItemTypeInstancesTargetSchema>;
+    list(queryParams?: ApiTypes.ItemTypeInstancesHrefSchema): Promise<ApiTypes.ItemTypeInstancesTargetSchema>;
     /**
      * List all models/block models
      *
@@ -56,7 +56,7 @@ export default class ItemType extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawList(): Promise<RawApiTypes.ItemTypeInstancesTargetSchema>;
+    rawList(queryParams?: RawApiTypes.ItemTypeInstancesHrefSchema): Promise<RawApiTypes.ItemTypeInstancesTargetSchema>;
     /**
      * Retrieve a model/block model
      *
@@ -65,7 +65,7 @@ export default class ItemType extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    find(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.ItemType>;
+    find(itemTypeId: string | ApiTypes.ItemTypeData, queryParams?: ApiTypes.ItemTypeSelfHrefSchema): Promise<ApiTypes.ItemType>;
     /**
      * Retrieve a model/block model
      *
@@ -74,7 +74,7 @@ export default class ItemType extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawFind(itemTypeId: string): Promise<RawApiTypes.ItemTypeSelfTargetSchema>;
+    rawFind(itemTypeId: string, queryParams?: RawApiTypes.ItemTypeSelfHrefSchema): Promise<RawApiTypes.ItemTypeSelfTargetSchema>;
     /**
      * Duplicate model/block model
      *
@@ -119,7 +119,7 @@ export default class ItemType extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    referencing(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.ItemTypeReferencingTargetSchema>;
+    referencing(itemTypeId: string | ApiTypes.ItemTypeData, queryParams?: ApiTypes.ItemTypeReferencingHrefSchema): Promise<ApiTypes.ItemTypeReferencingTargetSchema>;
     /**
      * List models referencing another model/block
      *
@@ -128,7 +128,7 @@ export default class ItemType extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawReferencing(itemTypeId: string): Promise<RawApiTypes.ItemTypeReferencingTargetSchema>;
+    rawReferencing(itemTypeId: string, queryParams?: RawApiTypes.ItemTypeReferencingHrefSchema): Promise<RawApiTypes.ItemTypeReferencingTargetSchema>;
     /**
      * Reorders a set of fields and fieldsets within the model
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "6.4.0",
+  "version": "6.7.0",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",

package/resources.json

@@ -1074,6 +1074,7 @@
         "comment": "List all models/block models",
         "urlPlaceholders": [],
         "optionalRequestBody": false,
+        "queryParamsType": "ItemTypeInstancesHrefSchema",
         "queryParamsRequired": false,
         "responseType": "ItemTypeInstancesTargetSchema",
         "name": "list",
@@ -1101,6 +1102,7 @@
           "relType": "ItemTypeData"
         },
         "optionalRequestBody": false,
+        "queryParamsType": "ItemTypeSelfHrefSchema",
         "queryParamsRequired": false,
         "responseType": "ItemTypeSelfTargetSchema",
         "name": "find",
@@ -1183,6 +1185,7 @@
           "relType": "ItemTypeData"
         },
         "optionalRequestBody": false,
+        "queryParamsType": "ItemTypeReferencingHrefSchema",
         "queryParamsRequired": false,
         "responseType": "ItemTypeReferencingTargetSchema",
         "name": "referencing",
@@ -1334,6 +1337,7 @@
           }
         ],
         "optionalRequestBody": false,
+        "queryParamsType": "FieldInstancesHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldInstancesTargetSchema",
         "name": "list",
@@ -1356,6 +1360,7 @@
           }
         ],
         "optionalRequestBody": false,
+        "queryParamsType": "FieldReferencingHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldReferencingTargetSchema",
         "name": "referencing",
@@ -1378,6 +1383,7 @@
           }
         ],
         "optionalRequestBody": false,
+        "queryParamsType": "FieldRelatedHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldRelatedTargetSchema",
         "deprecated": "This API call is to be considered private and might change without notice",
@@ -1406,6 +1412,7 @@
           "relType": "FieldData"
         },
         "optionalRequestBody": false,
+        "queryParamsType": "FieldSelfHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldSelfTargetSchema",
         "name": "find",
@@ -1563,6 +1570,7 @@
           }
         ],
         "optionalRequestBody": false,
+        "queryParamsType": "FieldsetInstancesHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldsetInstancesTargetSchema",
         "name": "list",
@@ -1590,6 +1598,7 @@
           "relType": "FieldsetData"
         },
         "optionalRequestBody": false,
+        "queryParamsType": "FieldsetSelfHrefSchema",
         "queryParamsRequired": false,
         "responseType": "FieldsetSelfTargetSchema",
         "name": "find",
@@ -2272,7 +2281,7 @@
         "rel": "validate_existing",
         "urlTemplate": "/items/${itemId}/validate",
         "method": "POST",
-        "comment": "Validates an existing record field",
+        "comment": "Validate an existing record",
         "urlPlaceholders": [
           {
             "variableName": "itemId",
@@ -2306,7 +2315,7 @@
         "rel": "validate_new",
         "urlTemplate": "/items/validate",
         "method": "POST",
-        "comment": "Validates a record field",
+        "comment": "Validate a new record",
         "urlPlaceholders": [],
         "requestBodyType": "ItemValidateNewSchema",
         "optionalRequestBody": false,

package/src/generated/ApiTypes.ts

@@ -297,6 +297,13 @@ export type AccountIdentity = string;
  * via the `definition` "type".
  */
 export type AccountType = 'account';
+/**
+ * Attributes and relationships to return for each `account` that this endpoint returns.
+ *
+ * This interface was referenced by `Account`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type AccountSparseFieldset = string;
 /**
  * ID of organization
  *
@@ -312,6 +319,13 @@ export type OrganizationIdentity = string;
  * via the `definition` "type".
  */
 export type OrganizationType = 'organization';
+/**
+ * Attributes and relationships to return for each `organization` that this endpoint returns.
+ *
+ * This interface was referenced by `Organization`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type OrganizationSparseFieldset = string;
 /**
  * This interface was referenced by `User`'s JSON-Schema
  * via the `me.hrefSchema` link.
@@ -602,6 +616,13 @@ export type FieldsetIdentity = string;
  * via the `definition` "type".
  */
 export type WorkflowType = 'workflow';
+/**
+ * Attributes and relationships to return for each `item_type` that this endpoint returns.
+ *
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type ItemTypeSparseFieldset = string;
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `create.hrefSchema` link.
@@ -626,6 +647,42 @@ export type ItemTypeCreateHrefSchema = {
  * via the `instances.targetSchema` link.
  */
 export type ItemTypeInstancesTargetSchema = ItemType[];
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type ItemTypeInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type ItemTypeSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * Attributes and relationships to return for each `field` that this endpoint returns.
+ *
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type FieldSparseFieldset = string;
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `destroy.hrefSchema` link.
@@ -642,6 +699,20 @@ export type ItemTypeDestroyHrefSchema = {
  * via the `referencing.targetSchema` link.
  */
 export type ItemTypeReferencingTargetSchema = ItemType[];
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `referencing.hrefSchema` link.
+ */
+export type ItemTypeReferencingHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `reorder_fields_and_fieldsets.schema` link.
@@ -670,21 +741,112 @@ export type ItemTypeReorderFieldsAndFieldsetsSchema = (
  * via the `instances.targetSchema` link.
  */
 export type FieldInstancesTargetSchema = Field[];
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type FieldInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `Field`'s JSON-Schema
  * via the `referencing.targetSchema` link.
  */
 export type FieldReferencingTargetSchema = Field[];
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `referencing.hrefSchema` link.
+ */
+export type FieldReferencingHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `Field`'s JSON-Schema
  * via the `related.targetSchema` link.
  */
 export type FieldRelatedTargetSchema = Field[];
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `related.hrefSchema` link.
+ */
+export type FieldRelatedHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type FieldSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * Attributes and relationships to return for each `fieldset` that this endpoint returns.
+ *
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type FieldsetSparseFieldset = string;
 /**
  * This interface was referenced by `Fieldset`'s JSON-Schema
  * via the `instances.targetSchema` link.
  */
 export type FieldsetInstancesTargetSchema = Fieldset[];
+/**
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type FieldsetInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    fieldset?: FieldsetSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type FieldsetSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    fieldset?: FieldsetSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `reorder_fields_and_fieldsets.jobSchema` link.
@@ -2046,6 +2208,13 @@ export type SiteIdentity = string;
  * via the `definition` "type".
  */
 export type SiteType = 'site';
+/**
+ * Attributes and relationships to return for each `site` that this endpoint returns.
+ *
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type SiteSparseFieldset = string;
 /**
  * This interface was referenced by `Site`'s JSON-Schema
  * via the `self.hrefSchema` link.
@@ -2055,6 +2224,18 @@ export type SiteSelfHrefSchema = {
    * Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`.
    */
   include?: string;
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    site?: SiteSparseFieldset;
+    item_type?: ItemTypeSparseFieldset;
+    field?: FieldSparseFieldset;
+    fieldset?: FieldsetSparseFieldset;
+    account?: AccountSparseFieldset;
+    organization?: OrganizationSparseFieldset;
+    [k: string]: unknown;
+  };
   [k: string]: unknown;
 };
 /**

package/src/generated/Client.ts

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

package/src/generated/RawApiTypes.ts

@@ -264,6 +264,13 @@ export type AccountType = 'account';
  * via the `definition` "id".
  */
 export type AccountIdentity = string;
+/**
+ * Attributes and relationships to return for each `account` that this endpoint returns.
+ *
+ * This interface was referenced by `Account`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type AccountSparseFieldset = string;
 /**
  * This interface was referenced by `Organization`'s JSON-Schema
  * via the `definition` "type".
@@ -279,6 +286,13 @@ export type OrganizationType = 'organization';
  * via the `definition` "id".
  */
 export type OrganizationIdentity = string;
+/**
+ * Attributes and relationships to return for each `organization` that this endpoint returns.
+ *
+ * This interface was referenced by `Organization`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type OrganizationSparseFieldset = string;
 /**
  * This interface was referenced by `User`'s JSON-Schema
  * via the `me.hrefSchema` link.
@@ -495,6 +509,13 @@ export type FieldsetIdentity = string;
  * via the `definition` "type".
  */
 export type WorkflowType = 'workflow';
+/**
+ * Attributes and relationships to return for each `item_type` that this endpoint returns.
+ *
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type ItemTypeSparseFieldset = string;
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `create.hrefSchema` link.
@@ -514,6 +535,42 @@ export type ItemTypeCreateHrefSchema = {
   schema_menu_item_id?: string;
   [k: string]: unknown;
 };
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type ItemTypeInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type ItemTypeSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * Attributes and relationships to return for each `field` that this endpoint returns.
+ *
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type FieldSparseFieldset = string;
 /**
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `destroy.hrefSchema` link.
@@ -525,6 +582,111 @@ export type ItemTypeDestroyHrefSchema = {
   skip_menu_items_deletion?: boolean;
   [k: string]: unknown;
 };
+/**
+ * This interface was referenced by `ItemType`'s JSON-Schema
+ * via the `referencing.hrefSchema` link.
+ */
+export type ItemTypeReferencingHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    item_type?: ItemTypeSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type FieldInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `referencing.hrefSchema` link.
+ */
+export type FieldReferencingHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `related.hrefSchema` link.
+ */
+export type FieldRelatedHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Field`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type FieldSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    field?: FieldSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * Attributes and relationships to return for each `fieldset` that this endpoint returns.
+ *
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type FieldsetSparseFieldset = string;
+/**
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type FieldsetInstancesHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    fieldset?: FieldsetSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
+/**
+ * This interface was referenced by `Fieldset`'s JSON-Schema
+ * via the `self.hrefSchema` link.
+ */
+export type FieldsetSelfHrefSchema = {
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    fieldset?: FieldsetSparseFieldset;
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `Session`'s JSON-Schema
  * via the `definition` "type".
@@ -1656,6 +1818,13 @@ export type SiteType = 'site';
  * via the `definition` "id".
  */
 export type SiteIdentity = string;
+/**
+ * Attributes and relationships to return for each `site` that this endpoint returns.
+ *
+ * This interface was referenced by `Site`'s JSON-Schema
+ * via the `definition` "sparse_fieldset".
+ */
+export type SiteSparseFieldset = string;
 /**
  * This interface was referenced by `Site`'s JSON-Schema
  * via the `self.hrefSchema` link.
@@ -1665,6 +1834,18 @@ export type SiteSelfHrefSchema = {
    * Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`.
    */
   include?: string;
+  /**
+   * Sparse fieldsets: for each entity type, the attributes and the relationships to return, separated by commas. Each entity declares its attributes and its relationships in its own schema.
+   */
+  fields?: {
+    site?: SiteSparseFieldset;
+    item_type?: ItemTypeSparseFieldset;
+    field?: FieldSparseFieldset;
+    fieldset?: FieldsetSparseFieldset;
+    account?: AccountSparseFieldset;
+    organization?: OrganizationSparseFieldset;
+    [k: string]: unknown;
+  };
   [k: string]: unknown;
 };
 /**