@datocms/cma-client 5.1.15 → 5.1.17

package/dist/types/utilities/itemInstancesHrefSchema.d.ts

@@ -0,0 +1,256 @@
+export type StringMatchesFilter = {
+    /** Pattern to match against */
+    pattern: string;
+    /** Whether the match should be case sensitive */
+    case_sensitive?: boolean;
+    /** Whether to treat the pattern as a regular expression */
+    regexp?: boolean;
+};
+export type LatLonNearFilter = {
+    /** Latitude coordinate */
+    latitude: number;
+    /** Longitude coordinate */
+    longitude: number;
+    /** Radius in meters */
+    radius: number;
+};
+export type BooleanHrefFilter = {
+    /** Search for records with an exact match */
+    eq?: boolean;
+};
+export type IntegerHrefFilter = {
+    /** Filter records with a value that's strictly greater than the one specified */
+    gt?: number;
+    /** Filter records with a value that's less than the one specified */
+    lt?: number;
+    /** Filter records with a value that's greater than or equal to the one specified */
+    gte?: number;
+    /** Filter records with a value that's less or equal than the one specified */
+    lte?: number;
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+    /** Search for records with an exact match */
+    eq?: number;
+    /** Exclude records with an exact match */
+    neq?: number;
+};
+export type FloatHrefFilter = {
+    /** Filter records with a value that's strictly greater than the one specified */
+    gt?: number;
+    /** Filter records with a value that's less than the one specified */
+    lt?: number;
+    /** Filter records with a value that's greater than or equal to the one specified */
+    gte?: number;
+    /** Filter records with a value that's less or equal than the one specified */
+    lte?: number;
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+    /** Search for records with an exact match */
+    eq?: number;
+    /** Exclude records with an exact match */
+    neq?: number;
+};
+export type DateHrefFilter = {
+    /** Filter records with a value that's strictly greater than the one specified */
+    gt?: string;
+    /** Filter records with a value that's less than the one specified */
+    lt?: string;
+    /** Filter records with a value that's greater than or equal to the one specified */
+    gte?: string;
+    /** Filter records with a value that's less or equal than the one specified */
+    lte?: string;
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+    /** Search for records with an exact match */
+    eq?: string;
+    /** Exclude records with an exact match */
+    neq?: string;
+};
+export type ColorHrefFilter = {
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type StringHrefFilter = {
+    /** Filter records based on a regular expression */
+    matches?: StringMatchesFilter;
+    /** Exclude records based on a regular expression */
+    not_matches?: StringMatchesFilter;
+    /** Filter records with the specified field set as blank (null or empty string) */
+    is_blank?: boolean;
+    /** Filter records with the specified field present (neither null, nor empty string) */
+    is_present?: boolean;
+    /** Search for records with an exact match */
+    eq?: string;
+    /** Exclude records with an exact match */
+    neq?: string;
+    /** Filter records that equal one of the specified values */
+    in?: string[];
+    /** Filter records that do not equal one of the specified values */
+    not_in?: string[];
+    /** @deprecated Use is_present instead. Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type DateTimeHrefFilter = {
+    /** Filter records with a value that's strictly greater than the one specified. Seconds and milliseconds are truncated from the argument. */
+    gt?: string;
+    /** Filter records with a value that's less than the one specified. Seconds and milliseconds are truncated from the argument. */
+    lt?: string;
+    /** Filter records with a value that's greater than or equal to than the one specified. Seconds and milliseconds are truncated from the argument. */
+    gte?: string;
+    /** Filter records with a value that's less or equal than the one specified. Seconds and milliseconds are truncated from the argument. */
+    lte?: string;
+    /** Filter records with a value that's within the specified minute range. Seconds and milliseconds are truncated from the argument. */
+    eq?: string;
+    /** Filter records with a value that's outside the specified minute range. Seconds and milliseconds are truncated from the argument. */
+    neq?: string;
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type JsonHrefFilter = {
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type LatLonHrefFilter = {
+    /** Filter records within the specified radius in meters */
+    near?: LatLonNearFilter;
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type SlugHrefFilter = {
+    /** Search for records with an exact match */
+    eq?: string;
+    /** Exclude records with an exact match */
+    neq?: string;
+    /** Filter records that have one of the specified slugs */
+    in?: string[];
+    /** Filter records that do not have one of the specified slugs */
+    not_in?: string[];
+};
+export type VideoHrefFilter = {
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type SeoHrefFilter = {
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type FileHrefFilter = {
+    /** Search for records with an exact match. The specified value must be an Upload ID */
+    eq?: string;
+    /** Exclude records with an exact match. The specified value must be an Upload ID */
+    neq?: string;
+    /** Filter records that have one of the specified uploads */
+    in?: string[];
+    /** Filter records that do not have one of the specified uploads */
+    not_in?: string[];
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type GalleryHrefFilter = {
+    /** Search for records with an exact match. The specified values must be Upload IDs */
+    eq?: string[];
+    /** Filter records that have all of the specified uploads. The specified values must be Upload IDs */
+    all_in?: string[];
+    /** Filter records that have one of the specified uploads. The specified values must be Upload IDs */
+    any_in?: string[];
+    /** Filter records that do not have any of the specified uploads. The specified values must be Upload IDs */
+    not_in?: string[];
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type LinkHrefFilter = {
+    /** Search for records with an exact match. The specified value must be a Record ID */
+    eq?: string;
+    /** Exclude records with an exact match. The specified value must be a Record ID */
+    neq?: string;
+    /** Filter records linked to one of the specified records */
+    in?: string[];
+    /** Filter records not linked to one of the specified records */
+    not_in?: string[];
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type LinksHrefFilter = {
+    /** Search for records with an exact match. The specified values must be Record IDs */
+    eq?: string[];
+    /** Filter records linked to all of the specified records. The specified values must be Record IDs */
+    all_in?: string[];
+    /** Filter records linked to at least one of the specified records. The specified values must be Record IDs */
+    any_in?: string[];
+    /** Filter records not linked to any of the specified records. The specified values must be Record IDs */
+    not_in?: string[];
+    /** Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type RichTextHrefFilter = Record<string, never>;
+export type StructuredTextHrefFilter = {
+    /** Filter records based on a regular expression */
+    matches?: StringMatchesFilter;
+    /** Exclude records based on a regular expression */
+    not_matches?: StringMatchesFilter;
+};
+export type SingleBlockHrefFilter = Record<string, never>;
+export type TextHrefFilter = {
+    /** Filter records based on a regular expression */
+    matches?: StringMatchesFilter;
+    /** Exclude records based on a regular expression */
+    not_matches?: StringMatchesFilter;
+    /** Filter records with the specified field set as blank (null or empty string) */
+    is_blank?: boolean;
+    /** Filter records with the specified field present (neither null, nor empty string) */
+    is_present?: boolean;
+    /** @deprecated Use is_present instead. Filter records with the specified field defined (i.e. with any value) or not */
+    exists?: boolean;
+};
+export type StatusFilter = {
+    /** Search the record with the specified status */
+    eq?: 'draft' | 'updated' | 'published';
+    /** Exclude the record with the specified status */
+    neq?: 'draft' | 'updated' | 'published';
+    /** Search records with the specified statuses */
+    in?: ('draft' | 'updated' | 'published')[];
+    /** Search records without the specified statuses */
+    notIn?: ('draft' | 'updated' | 'published')[];
+};
+export type ItemIdFilter = {
+    /** Search the record with the specified ID */
+    eq?: string;
+    /** Exclude the record with the specified ID */
+    neq?: string;
+    /** Search records with the specified IDs */
+    in?: string[];
+    /** Search records that do not have the specified IDs */
+    notIn?: string[];
+};
+export type ParentIdFilter = {
+    /** Filter records children of the specified record. Value must be a Record ID */
+    eq?: string;
+    /** Filter records with a parent record or not */
+    exists?: boolean;
+};
+export type PositionFilter = {
+    /** Filter records with a value that's strictly greater than the one specified */
+    gt?: number;
+    /** Filter records with a value that's less than the one specified */
+    lt?: number;
+    /** Filter records with a value that's greater than or equal to the one specified */
+    gte?: number;
+    /** Filter records with a value that's less or equal than the one specified */
+    lte?: number;
+    /** Search for records with an exact match */
+    eq?: number;
+    /** Exclude records with an exact match */
+    neq?: number;
+};
+export type ItemMetaFilter = {
+    _created_at?: DateTimeHrefFilter;
+    _first_published_at?: DateTimeHrefFilter;
+    _is_valid?: BooleanHrefFilter;
+    _publication_scheduled_at?: DateTimeHrefFilter;
+    _published_at?: DateTimeHrefFilter;
+    _status?: StatusFilter;
+    _unpublishing_scheduled_at?: DateTimeHrefFilter;
+    _updated_at?: DateTimeHrefFilter;
+    id?: ItemIdFilter;
+};
+export type ItemMetaOrderBy = '_created_at_ASC' | '_created_at_DESC' | 'id_ASC' | 'id_DESC' | '_first_published_at_ASC' | '_first_published_at_DESC' | '_publication_scheduled_at_ASC' | '_publication_scheduled_at_DESC' | '_unpublishing_scheduled_at_ASC' | '_unpublishing_scheduled_at_DESC' | '_published_at_ASC' | '_published_at_DESC' | '_status_ASC' | '_status_DESC' | '_updated_at_ASC' | '_updated_at_DESC' | '_is_valid_ASC' | '_is_valid_DESC';

package/dist/types/utilities/normalizedFieldValues.d.ts

@@ -14,8 +14,8 @@ export type LocalizedFieldValue<T = unknown, L extends string = string> = Partia
  * This function handles both full Schema field objects and simplified Schema field objects
  * by checking the appropriate property based on the object structure.
  *
- * @param field - The DatoCMS field definition (either full or simple schema)
  * @returns true if the field is localized, false otherwise
+ * @param field - The DatoCMS field definition (either full or simple schema)
  */
 export declare function isLocalized(field: RawApiTypes.Field | ApiTypes.Field): boolean;
 export declare function isLocalizedFieldValue<T = unknown, L extends string = string>(value: unknown): value is LocalizedFieldValue<T, L>;
@@ -37,11 +37,11 @@ export type NormalizedFieldValueEntry<T = unknown, L extends string = string> =
  * This function normalizes the handling of field values by converting them into a consistent
  * array format, regardless of whether the field is localized or not.
  *
- * @param field - The DatoCMS field definition that determines localization behavior
  * @param value - The field value to convert (either a localized object or direct value)
+ * @param field - The DatoCMS field definition that determines localization behavior
  * @returns Array of entries where each entry contains a locale (string for localized, undefined for non-localized) and the corresponding value
  */
-export declare function toNormalizedFieldValueEntries<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>): NormalizedFieldValueEntry<T, L>[];
+export declare function toNormalizedFieldValueEntries<T = unknown, L extends string = string>(value: T | LocalizedFieldValue<T, L>, field: RawApiTypes.Field | ApiTypes.Field): NormalizedFieldValueEntry<T, L>[];
 /**
  * Converts an array of possibly localized entries back into the appropriate field value format.
  *
@@ -49,118 +49,118 @@ export declare function toNormalizedFieldValueEntries<T = unknown, L extends str
  * array of entries and converts them back to either a localized object or a direct value,
  * depending on the field's localization setting.
  *
- * @param field - The DatoCMS field definition that determines the output format
  * @param entries - Array of entries to convert back to field value format
+ * @param field - The DatoCMS field definition that determines the output format
  * @returns Either a localized object (for localized fields) or the direct value (for non-localized fields)
  */
-export declare function fromNormalizedFieldValueEntries<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, entries: NormalizedFieldValueEntry<T, L>[]): T | LocalizedFieldValue<T, L>;
+export declare function fromNormalizedFieldValueEntries<T = unknown, L extends string = string>(entries: NormalizedFieldValueEntry<T, L>[], field: RawApiTypes.Field | ApiTypes.Field): T | LocalizedFieldValue<T, L>;
 /**
  * Maps field values using a provided mapping function.
  * For localized fields, applies the mapping function to each locale value.
  * For non-localized fields, applies the mapping function directly to the value.
  *
  * @template T - The type that the mapping function returns
+ * @param localizedOrNonLocalizedFieldValue - The field value (either localized object or direct value)
  * @param field - The DatoCMS field definition
- * @param value - The field value (either localized object or direct value)
  * @param mapFn - The function to apply to each locale value or the direct value
  * @returns The mapped value with the same structure as the input
  */
-export declare function mapNormalizedFieldValues<TInput = unknown, TOutput = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: TInput | LocalizedFieldValue<TInput, L>, mapFn: (locale: L | undefined, localeValue: TInput) => TOutput): TOutput | LocalizedFieldValue<TOutput, L>;
+export declare function mapNormalizedFieldValues<TInput = unknown, TOutput = unknown, L extends string = string>(localizedOrNonLocalizedFieldValue: TInput | LocalizedFieldValue<TInput, L>, field: RawApiTypes.Field | ApiTypes.Field, mapFn: (locale: L | undefined, localeValue: TInput) => TOutput): TOutput | LocalizedFieldValue<TOutput, L>;
 /**
  * Maps field values using a provided mapping function (async version).
  * For localized fields, applies the mapping function to each locale value.
  * For non-localized fields, applies the mapping function directly to the value.
  *
  * @template T - The type that the mapping function returns
+ * @param localizedOrNonLocalizedFieldValue - The field value (either localized object or direct value)
  * @param field - The DatoCMS field definition
- * @param value - The field value (either localized object or direct value)
  * @param mapFn - The function to apply to each locale value or the direct value
  * @returns The mapped value with the same structure as the input
  */
-export declare function mapNormalizedFieldValuesAsync<TInput = unknown, TOutput = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: TInput | LocalizedFieldValue<TInput, L>, mapFn: (locale: L | undefined, localeValue: TInput) => Promise<TOutput>): Promise<TOutput | LocalizedFieldValue<TOutput, L>>;
+export declare function mapNormalizedFieldValuesAsync<TInput = unknown, TOutput = unknown, L extends string = string>(localizedOrNonLocalizedFieldValue: TInput | LocalizedFieldValue<TInput, L>, field: RawApiTypes.Field | ApiTypes.Field, mapFn: (locale: L | undefined, localeValue: TInput) => Promise<TOutput>): Promise<TOutput | LocalizedFieldValue<TOutput, L>>;
 /**
  * Filters field values using a provided filter function.
  * For localized fields, filters each locale value.
  * For non-localized fields, returns the value if the filter passes, otherwise undefined.
  *
+ * @param localizedOrNonLocalizedFieldValue - The field value (either localized object or direct value)
  * @param field - The DatoCMS field definition
- * @param value - The field value (either localized object or direct value)
  * @param filterFn - The function to test each locale value or the direct value
  * @returns The filtered value with the same structure as the input
  */
-export declare function filterNormalizedFieldValues<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, filterFn: (locale: L | undefined, localeValue: T) => boolean): T | LocalizedFieldValue<T, L> | undefined;
+export declare function filterNormalizedFieldValues<T = unknown, L extends string = string>(localizedOrNonLocalizedFieldValue: T | LocalizedFieldValue<T, L>, field: RawApiTypes.Field | ApiTypes.Field, filterFn: (locale: L | undefined, localeValue: T) => boolean): T | LocalizedFieldValue<T, L> | undefined;
 /**
  * Filters field values using a provided filter function (async version).
  * For localized fields, filters each locale value.
  * For non-localized fields, returns the value if the filter passes, otherwise undefined.
  *
+ * @param localizedOrNonLocalizedFieldValue - The field value (either localized object or direct value)
  * @param field - The DatoCMS field definition
- * @param value - The field value (either localized object or direct value)
  * @param filterFn - The function to test each locale value or the direct value
  * @returns The filtered value with the same structure as the input
  */
-export declare function filterNormalizedFieldValuesAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, filterFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<T | LocalizedFieldValue<T, L> | undefined>;
+export declare function filterNormalizedFieldValuesAsync<T = unknown, L extends string = string>(localizedOrNonLocalizedFieldValue: T | LocalizedFieldValue<T, L>, field: RawApiTypes.Field | ApiTypes.Field, filterFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<T | LocalizedFieldValue<T, L> | undefined>;
 /**
  * Tests whether at least one field value passes the test implemented by the provided function.
  * For localized fields, tests each locale value.
  * For non-localized fields, tests the direct value.
  *
+ * @param localizedOrNonLocalizedFieldValue - The field value (either localized object or direct value)
  * @param field - The DatoCMS field definition
- * @param value - The field value (either localized object or direct value)
  * @param testFn - The function to test each locale value or the direct value
  * @returns true if at least one value passes the test, false otherwise
  */
-export declare function someNormalizedFieldValues<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => boolean): boolean;
+export declare function someNormalizedFieldValues<T = unknown, L extends string = string>(localizedOrNonLocalizedFieldValue: T | LocalizedFieldValue<T, L>, field: RawApiTypes.Field | ApiTypes.Field, testFn: (locale: L | undefined, localeValue: T) => boolean): boolean;
 /**
  * Tests whether at least one field value passes the test implemented by the provided function (async version).
  * For localized fields, tests each locale value.
  * For non-localized fields, tests the direct value.
  *
+ * @param localizedOrNonLocalizedFieldValue - The field value (either localized object or direct value)
  * @param field - The DatoCMS field definition
- * @param value - The field value (either localized object or direct value)
  * @param testFn - The function to test each locale value or the direct value
  * @returns true if at least one value passes the test, false otherwise
  */
-export declare function someNormalizedFieldValuesAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<boolean>;
+export declare function someNormalizedFieldValuesAsync<T = unknown, L extends string = string>(localizedOrNonLocalizedFieldValue: T | LocalizedFieldValue<T, L>, field: RawApiTypes.Field | ApiTypes.Field, testFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<boolean>;
 /**
  * Tests whether all field values pass the test implemented by the provided function.
  * For localized fields, tests each locale value.
  * For non-localized fields, tests the direct value.
  *
+ * @param localizedOrNonLocalizedFieldValue - The field value (either localized object or direct value)
  * @param field - The DatoCMS field definition
- * @param value - The field value (either localized object or direct value)
  * @param testFn - The function to test each locale value or the direct value
  * @returns true if all values pass the test, false otherwise
  */
-export declare function everyNormalizedFieldValue<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => boolean): boolean;
+export declare function everyNormalizedFieldValue<T = unknown, L extends string = string>(localizedOrNonLocalizedFieldValue: T | LocalizedFieldValue<T, L>, field: RawApiTypes.Field | ApiTypes.Field, testFn: (locale: L | undefined, localeValue: T) => boolean): boolean;
 /**
  * Tests whether all field values pass the test implemented by the provided function (async version).
  * For localized fields, tests each locale value.
  * For non-localized fields, tests the direct value.
  *
+ * @param localizedOrNonLocalizedFieldValue - The field value (either localized object or direct value)
  * @param field - The DatoCMS field definition
- * @param value - The field value (either localized object or direct value)
  * @param testFn - The function to test each locale value or the direct value
  * @returns true if all values pass the test, false otherwise
  */
-export declare function everyNormalizedFieldValueAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<boolean>;
+export declare function everyNormalizedFieldValueAsync<T = unknown, L extends string = string>(localizedOrNonLocalizedFieldValue: T | LocalizedFieldValue<T, L>, field: RawApiTypes.Field | ApiTypes.Field, testFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<boolean>;
 /**
  * Visits each field value with the provided function.
  * For localized fields, visits each locale value.
  * For non-localized fields, visits the direct value.
  *
- * @param field - The DatoCMS field definition
  * @param value - The field value (either localized object or direct value)
+ * @param field - The DatoCMS field definition
  * @param visitFn - The function to call for each locale value or the direct value
  */
-export declare function visitNormalizedFieldValues<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, visitFn: (locale: L | undefined, localeValue: T) => void): void;
+export declare function visitNormalizedFieldValues<T = unknown, L extends string = string>(value: T | LocalizedFieldValue<T, L>, field: RawApiTypes.Field | ApiTypes.Field, visitFn: (locale: L | undefined, localeValue: T) => void): void;
 /**
  * Visits each field value with the provided function (async version).
  * For localized fields, visits each locale value.
  * For non-localized fields, visits the direct value.
  *
+ * @param localizedOrNonLocalizedFieldValue - The field value (either localized object or direct value)
  * @param field - The DatoCMS field definition
- * @param value - The field value (either localized object or direct value)
  * @param visitFn - The function to call for each locale value or the direct value
  */
-export declare function visitNormalizedFieldValuesAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, visitFn: (locale: L | undefined, localeValue: T) => Promise<void>): Promise<void>;
+export declare function visitNormalizedFieldValuesAsync<T = unknown, L extends string = string>(localizedOrNonLocalizedFieldValue: T | LocalizedFieldValue<T, L>, field: RawApiTypes.Field | ApiTypes.Field, visitFn: (locale: L | undefined, localeValue: T) => Promise<void>): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "5.1.15",
+  "version": "5.1.17",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -45,5 +45,5 @@
     "@datocms/dashboard-client": "^5.1.13",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "e7e829e9d0b769c0cc309b02332516a853f18bb3"
+  "gitHead": "b6e72b9fe9351c2dab803e48bd1d2418e9a19f35"
 }

package/src/generated/ApiTypes.ts

@@ -9,6 +9,8 @@ import type {
   ToItemAttributes,
   ToItemAttributesInNestedResponse,
   ToItemAttributesInRequest,
+  ToItemHrefSchemaField,
+  ToItemHrefSchemaOrderBy,
 } from '../utilities/itemDefinition';
 
 export type Field = GenericFieldAttributes<FieldStableShell>;
@@ -853,7 +855,9 @@ export type ItemInstancesTargetSchema<
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `instances.hrefSchema` link.
  */
-export type ItemInstancesHrefSchema = {
+export type ItemInstancesHrefSchema<
+  D extends ItemTypeDefinition = ItemTypeDefinition,
+> = {
   /**
    * For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
    */
@@ -877,9 +881,7 @@ export type ItemInstancesHrefSchema = {
     /**
      * Same as [GraphQL API records filters](/docs/content-delivery-api/filtering-records): you must use square brackets to indicate nesting levels. E.g. if you wanna [filter by parent record](/docs/content-delivery-api/filtering-records#parent) in a tree of records, you must use `filter[fields][parent][eq]=<ID_VALUE>`. Use snake_case for fields names. If `locale` is defined, search within that locale. Otherwise environment's main locale will be used.
      */
-    fields?: {
-      [k: string]: unknown;
-    };
+    fields?: ToItemHrefSchemaField<D>;
     /**
      * When set, only valid records are included in the results.
      */
@@ -906,7 +908,7 @@ export type ItemInstancesHrefSchema = {
   /**
    * 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.
    */
-  order_by?: string;
+  order_by?: ToItemHrefSchemaOrderBy<D>;
   /**
    * Whether you want the currently published versions (`published`, default) of your records, or the latest available (`current`)
    */

package/src/generated/Client.ts

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

package/src/generated/RawApiTypes.ts

@@ -9,6 +9,8 @@ import type {
   ToItemAttributes,
   ToItemAttributesInNestedResponse,
   ToItemAttributesInRequest,
+  ToItemHrefSchemaField,
+  ToItemHrefSchemaOrderBy,
 } from '../utilities/itemDefinition';
 
 export type Field = FieldStableShell;
@@ -665,7 +667,9 @@ export type BuildEventInstancesHrefSchema = {
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `instances.hrefSchema` link.
  */
-export type ItemInstancesHrefSchema = {
+export type ItemInstancesHrefSchema<
+  D extends ItemTypeDefinition = ItemTypeDefinition,
+> = {
   /**
    * For Modular Content, Structured Text and Single Block fields. If set, returns full payload for nested blocks instead of IDs
    */
@@ -689,9 +693,7 @@ export type ItemInstancesHrefSchema = {
     /**
      * Same as [GraphQL API records filters](/docs/content-delivery-api/filtering-records): you must use square brackets to indicate nesting levels. E.g. if you wanna [filter by parent record](/docs/content-delivery-api/filtering-records#parent) in a tree of records, you must use `filter[fields][parent][eq]=<ID_VALUE>`. Use snake_case for fields names. If `locale` is defined, search within that locale. Otherwise environment's main locale will be used.
      */
-    fields?: {
-      [k: string]: unknown;
-    };
+    fields?: ToItemHrefSchemaField<D>;
     /**
      * When set, only valid records are included in the results.
      */
@@ -718,7 +720,7 @@ export type ItemInstancesHrefSchema = {
   /**
    * 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.
    */
-  order_by?: string;
+  order_by?: ToItemHrefSchemaOrderBy<D>;
   /**
    * Whether you want the currently published versions (`published`, default) of your records, or the latest available (`current`)
    */

package/src/generated/resources/Item.ts

@@ -18,10 +18,10 @@ export default class Item extends BaseResource {
    * @throws {TimeoutError}
    */
   list<D extends ItemTypeDefinition = ItemTypeDefinition>(
-    queryParams: ApiTypes.ItemInstancesHrefSchema & { nested: true },
+    queryParams: ApiTypes.ItemInstancesHrefSchema<D> & { nested: true },
   ): Promise<ApiTypes.ItemInstancesTargetSchema<NoInfer<D>, true>>;
   list<D extends ItemTypeDefinition = ItemTypeDefinition>(
-    queryParams?: ApiTypes.ItemInstancesHrefSchema & {
+    queryParams?: ApiTypes.ItemInstancesHrefSchema<D> & {
       nested?: false | undefined;
     },
   ): Promise<ApiTypes.ItemInstancesTargetSchema<NoInfer<D>, false>>;
@@ -34,7 +34,7 @@ export default class Item extends BaseResource {
    * @throws {TimeoutError}
    */
   list<D extends ItemTypeDefinition = ItemTypeDefinition>(
-    queryParams?: ApiTypes.ItemInstancesHrefSchema,
+    queryParams?: ApiTypes.ItemInstancesHrefSchema<D>,
   ) {
     return this.rawList<D>(queryParams).then((body) =>
       Utils.deserializeResponseBody(body),
@@ -50,15 +50,15 @@ export default class Item extends BaseResource {
    * @throws {TimeoutError}
    */
   rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(
-    queryParams: RawApiTypes.ItemInstancesHrefSchema & { nested: true },
+    queryParams: RawApiTypes.ItemInstancesHrefSchema<D> & { nested: true },
   ): Promise<RawApiTypes.ItemInstancesTargetSchema<NoInfer<D>, true>>;
   rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(
-    queryParams?: RawApiTypes.ItemInstancesHrefSchema & {
+    queryParams?: RawApiTypes.ItemInstancesHrefSchema<D> & {
       nested?: false | undefined;
     },
   ): Promise<RawApiTypes.ItemInstancesTargetSchema<NoInfer<D>, false>>;
   rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(
-    queryParams?: RawApiTypes.ItemInstancesHrefSchema,
+    queryParams?: RawApiTypes.ItemInstancesHrefSchema<D>,
   ): Promise<RawApiTypes.ItemInstancesTargetSchema<NoInfer<D>, true>>;
   /**
    * List all records
@@ -69,7 +69,7 @@ export default class Item extends BaseResource {
    * @throws {TimeoutError}
    */
   rawList<D extends ItemTypeDefinition = ItemTypeDefinition>(
-    queryParams?: RawApiTypes.ItemInstancesHrefSchema,
+    queryParams?: RawApiTypes.ItemInstancesHrefSchema<D>,
   ) {
     return this.client
       .request({
@@ -92,7 +92,7 @@ export default class Item extends BaseResource {
    */
   async *listPagedIterator<D extends ItemTypeDefinition = ItemTypeDefinition>(
     queryParams?: Utils.OmitFromKnownKeys<
-      ApiTypes.ItemInstancesHrefSchema,
+      ApiTypes.ItemInstancesHrefSchema<D>,
       'page'
     >,
     iteratorOptions?: Utils.IteratorOptions,
@@ -117,7 +117,7 @@ export default class Item extends BaseResource {
    */
   rawListPagedIterator<D extends ItemTypeDefinition = ItemTypeDefinition>(
     queryParams?: Utils.OmitFromKnownKeys<
-      RawApiTypes.ItemInstancesHrefSchema,
+      RawApiTypes.ItemInstancesHrefSchema<D>,
       'page'
     >,
     iteratorOptions?: Utils.IteratorOptions,
@@ -131,7 +131,7 @@ export default class Item extends BaseResource {
         defaultLimit: 30,
         maxLimit: 500,
       },
-      (page: RawApiTypes.ItemInstancesHrefSchema['page']) =>
+      (page: RawApiTypes.ItemInstancesHrefSchema<D>['page']) =>
         this.rawList<D>({ ...queryParams, page }),
       iteratorOptions,
       true,