@datocms/cma-client 3.4.4 → 4.0.0

package/src/generated/SchemaTypes.ts

@@ -540,6 +540,69 @@ export type BuildEventIdentity = string;
  * via the `definition` "type".
  */
 export type BuildTriggerType = 'build_trigger';
+/**
+ * This interface was referenced by `BuildEvent`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type BuildEventInstancesHrefSchema = {
+  /**
+   * Parameters to control offset-based pagination
+   */
+  page?: {
+    /**
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
+     */
+    offset?: number;
+    /**
+     * The maximum number of entities to return (defaults to 30, maximum is 500)
+     */
+    limit?: number;
+  };
+  /**
+   * Attributes to filter
+   */
+  filter?: {
+    /**
+     * IDs to fetch, comma separated
+     */
+    ids?: string;
+    fields?: {
+      build_trigger_id?: {
+        eq?: string;
+      };
+      event_type?: {
+        /**
+         * The type of activity
+         */
+        eq?:
+          | 'request_success'
+          | 'request_failure'
+          | 'response_success'
+          | 'response_failure'
+          | 'request_aborted'
+          | 'response_unprocessable'
+          | 'indexing_started'
+          | 'indexing_success'
+          | 'indexing_failure';
+      };
+      created_at?: {
+        gt?: string;
+        lt?: string;
+      };
+    };
+  };
+  /**
+   * Fields used to order results
+   */
+  order_by?:
+    | 'build_trigger_id_asc'
+    | 'build_trigger_id_desc'
+    | 'created_at_asc'
+    | 'created_at_desc'
+    | 'event_type_asc'
+    | 'event_type_desc';
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `instances.hrefSchema` link.
@@ -4442,13 +4505,25 @@ export type ItemTypeRelationships = {
     data: FieldsetData[];
   };
   /**
-   * The field to use as display title
+   * The field to use as presentation title
+   */
+  presentation_title_field: {
+    data: FieldData | null;
+  };
+  /**
+   * The field to use as presentation image
+   */
+  presentation_image_field: {
+    data: FieldData | null;
+  };
+  /**
+   * The field to use as fallback title for SEO purposes
    */
   title_field: {
     data: FieldData | null;
   };
   /**
-   * The field to use as preview image
+   * The field to use as fallback image for SEO purposes
    */
   image_preview_field: {
     data: FieldData | null;
@@ -4616,13 +4691,25 @@ export type ItemTypeCreateSchema = {
         data: FieldData | null;
       };
       /**
-       * The field to use as display title
+       * The field to use as presentation title
+       */
+      presentation_title_field?: {
+        data: FieldData | null;
+      };
+      /**
+       * The field to use as presentation image
+       */
+      presentation_image_field?: {
+        data: FieldData | null;
+      };
+      /**
+       * The field to use as fallback title for SEO purposes
        */
       title_field?: {
         data: FieldData | null;
       };
       /**
-       * The field to use as preview image
+       * The field to use as fallback image for SEO purposes
        */
       image_preview_field?: {
         data: FieldData | null;
@@ -4742,13 +4829,25 @@ export type ItemTypeUpdateSchema = {
         data: FieldData | null;
       };
       /**
-       * The field to use as display title
+       * The field to use as presentation title
+       */
+      presentation_title_field?: {
+        data: FieldData | null;
+      };
+      /**
+       * The field to use as presentation image
+       */
+      presentation_image_field?: {
+        data: FieldData | null;
+      };
+      /**
+       * The field to use as fallback title for SEO purposes
        */
       title_field?: {
         data: FieldData | null;
       };
       /**
-       * The field to use as preview image
+       * The field to use as fallback image for SEO purposes
        */
       image_preview_field?: {
         data: FieldData | null;
@@ -7122,6 +7221,9 @@ export type BuildEventData = {
  */
 export type BuildEventInstancesTargetSchema = {
   data: BuildEvent[];
+  meta: {
+    total_count: number;
+  };
 };
 
 /**

package/src/generated/SimpleSchemaTypes.ts

@@ -722,6 +722,69 @@ export type BuildTriggerType = 'build_trigger';
  * via the `instances.targetSchema` link.
  */
 export type BuildEventInstancesTargetSchema = BuildEvent[];
+/**
+ * This interface was referenced by `BuildEvent`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type BuildEventInstancesHrefSchema = {
+  /**
+   * Parameters to control offset-based pagination
+   */
+  page?: {
+    /**
+     * The (zero-based) offset of the first entity returned in the collection (defaults to 0)
+     */
+    offset?: number;
+    /**
+     * The maximum number of entities to return (defaults to 30, maximum is 500)
+     */
+    limit?: number;
+  };
+  /**
+   * Attributes to filter
+   */
+  filter?: {
+    /**
+     * IDs to fetch, comma separated
+     */
+    ids?: string;
+    fields?: {
+      build_trigger_id?: {
+        eq?: string;
+      };
+      event_type?: {
+        /**
+         * The type of activity
+         */
+        eq?:
+          | 'request_success'
+          | 'request_failure'
+          | 'response_success'
+          | 'response_failure'
+          | 'request_aborted'
+          | 'response_unprocessable'
+          | 'indexing_started'
+          | 'indexing_success'
+          | 'indexing_failure';
+      };
+      created_at?: {
+        gt?: string;
+        lt?: string;
+      };
+    };
+  };
+  /**
+   * Fields used to order results
+   */
+  order_by?:
+    | 'build_trigger_id_asc'
+    | 'build_trigger_id_desc'
+    | 'created_at_asc'
+    | 'created_at_desc'
+    | 'event_type_asc'
+    | 'event_type_desc';
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `instances.targetSchema` link.
@@ -4873,6 +4936,8 @@ export type ItemType = {
   singleton_item: ItemData | null;
   fields: FieldData[];
   fieldsets: FieldsetData[];
+  presentation_title_field: FieldData | null;
+  presentation_image_field: FieldData | null;
   title_field: FieldData | null;
   image_preview_field: FieldData | null;
   excerpt_field: FieldData | null;
@@ -5030,6 +5095,8 @@ export type ItemTypeRelationships = {
   singleton_item: ItemData | null;
   fields: FieldData[];
   fieldsets: FieldsetData[];
+  presentation_title_field: FieldData | null;
+  presentation_image_field: FieldData | null;
   title_field: FieldData | null;
   image_preview_field: FieldData | null;
   excerpt_field: FieldData | null;
@@ -5110,6 +5177,8 @@ export type ItemTypeCreateSchema = {
    */
   inverse_relationships_enabled?: boolean;
   ordering_field?: FieldData | null;
+  presentation_title_field?: FieldData | null;
+  presentation_image_field?: FieldData | null;
   title_field?: FieldData | null;
   image_preview_field?: FieldData | null;
   excerpt_field?: FieldData | null;
@@ -5193,6 +5262,8 @@ export type ItemTypeUpdateSchema = {
    */
   inverse_relationships_enabled?: boolean;
   ordering_field?: FieldData | null;
+  presentation_title_field?: FieldData | null;
+  presentation_image_field?: FieldData | null;
   title_field?: FieldData | null;
   image_preview_field?: FieldData | null;
   excerpt_field?: FieldData | null;

package/src/generated/resources/BuildEvent.ts

@@ -14,8 +14,8 @@ export default class BuildEvent extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  list() {
-    return this.rawList().then((body) =>
+  list(queryParams?: SimpleSchemaTypes.BuildEventInstancesHrefSchema) {
+    return this.rawList(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.BuildEventInstancesTargetSchema>(
         body,
       ),
@@ -30,13 +30,71 @@ export default class BuildEvent extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  rawList(): Promise<SchemaTypes.BuildEventInstancesTargetSchema> {
+  rawList(
+    queryParams?: SchemaTypes.BuildEventInstancesHrefSchema,
+  ): Promise<SchemaTypes.BuildEventInstancesTargetSchema> {
     return this.client.request<SchemaTypes.BuildEventInstancesTargetSchema>({
       method: 'GET',
       url: '/build-events',
+      queryParams,
     });
   }
 
+  /**
+   * Async iterator to auto-paginate over elements returned by list()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  async *listPagedIterator(
+    queryParams?: Utils.OmitFromKnownKeys<
+      SimpleSchemaTypes.BuildEventInstancesHrefSchema,
+      'page'
+    >,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    for await (const element of this.rawListPagedIterator(
+      queryParams,
+      iteratorOptions,
+    )) {
+      yield Utils.deserializeJsonEntity<
+        SimpleSchemaTypes.BuildEventInstancesTargetSchema[0]
+      >(element);
+    }
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by rawList()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
+   *
+   * @throws {ApiError}
+   * @throws {TimeoutError}
+   */
+  rawListPagedIterator(
+    queryParams?: Utils.OmitFromKnownKeys<
+      SchemaTypes.BuildEventInstancesHrefSchema,
+      'page'
+    >,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    Utils.warnOnPageQueryParam(queryParams);
+
+    return Utils.rawPageIterator<
+      SchemaTypes.BuildEventInstancesTargetSchema['data'][0]
+    >(
+      {
+        defaultLimit: 30,
+        maxLimit: 500,
+      },
+      (page: SchemaTypes.BuildEventInstancesHrefSchema['page']) =>
+        this.rawList({ ...queryParams, page }),
+      iteratorOptions,
+    );
+  }
+
   /**
    * Retrieve a deploy event
    *

package/src/generated/resources/ItemType.ts

@@ -40,6 +40,8 @@ export default class ItemType extends BaseResource {
         ],
         relationships: [
           'ordering_field',
+          'presentation_title_field',
+          'presentation_image_field',
           'title_field',
           'image_preview_field',
           'excerpt_field',
@@ -111,6 +113,8 @@ export default class ItemType extends BaseResource {
         ],
         relationships: [
           'ordering_field',
+          'presentation_title_field',
+          'presentation_image_field',
           'title_field',
           'image_preview_field',
           'excerpt_field',