@datocms/cma-client 1.0.1 → 1.1.2

package/src/generated/SchemaTypes.ts

@@ -520,7 +520,7 @@ export type ItemInstancesHrefSchema = {
     [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>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
+   * 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;
   /**
@@ -830,25 +830,41 @@ export type SearchResultIdentity = string;
  */
 export type SearchResultInstancesHrefSchema = {
   /**
-   * The query string to search
-   */
-  q: string;
-  /**
-   * The build trigger ID on which the search will be performed
-   */
-  build_trigger_id?: string;
-  /**
-   * Restrict the search on one locale
-   */
-  locale?: string;
-  /**
-   * Maximum number of results to return (defaults to 20, maximum is 100)
+   * Attributes to manage results pagination
    */
-  limit?: number;
+  page?: {
+    /**
+     * Index of first element to fetch (defaults to 0)
+     */
+    offset?: number;
+    /**
+     * Number of elements to fetch (defaults to 20, maximum is 100)
+     */
+    limit?: number;
+    [k: string]: unknown;
+  };
   /**
-   * Number of records to offset for the search
+   * Attributes to filter search results
    */
-  offset?: string;
+  filter: {
+    /**
+     * When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
+     */
+    fuzzy?: string;
+    /**
+     * Text to search
+     */
+    query: string;
+    /**
+     * The build trigger ID on which the search will be performed. Required if more than one build trigger is present in a project
+     */
+    build_trigger_id?: string;
+    /**
+     * Restrict the search on pages in a specific locale
+     */
+    locale?: string;
+    [k: string]: unknown;
+  };
   [k: string]: unknown;
 };
 /**
@@ -3179,6 +3195,10 @@ export type SitePlanAttributes = {
    * Whether or not use a static IP when sending webhooks
    */
   static_webhooks_ip: boolean;
+  /**
+   * Maximum size in bytes for a single file upload
+   */
+  maximum_single_upload_bytes: number;
   /**
    * Available extra packets
    */
@@ -6089,6 +6109,14 @@ export type ItemMeta = {
    * Whether the current record is valid or not
    */
   is_valid: boolean;
+  /**
+   * Whether the current version of the record is valid or not
+   */
+  is_current_version_valid: null | boolean;
+  /**
+   * Whether the published version of record is valid or not
+   */
+  is_published_version_valid: null | boolean;
   /**
    * The ID of the current record version
    */
@@ -6210,6 +6238,14 @@ export type ItemCreateSchema = {
        * Whether the current record is valid or not
        */
       is_valid?: boolean;
+      /**
+       * Whether the current version of the record is valid or not
+       */
+      is_current_version_valid?: null | boolean;
+      /**
+       * Whether the published version of the record is valid or not
+       */
+      is_published_version_valid?: null | boolean;
       /**
        * The ID of the current record version
        */
@@ -6306,6 +6342,14 @@ export type ItemUpdateSchema = {
        * The ID of the current record version (for optimistic locking, see the example)
        */
       current_version?: string;
+      /**
+       * Whether the current version of the record is valid or not
+       */
+      is_current_version_valid?: null | boolean;
+      /**
+       * Whether the published version of record is valid or not
+       */
+      is_published_version_valid?: null | boolean;
       /**
        * The new stage to move the record to
        */
@@ -7551,11 +7595,11 @@ export type SearchResult = {
  */
 export type SearchResultAttributes = {
   /**
-   * Page title
+   * Title of the page
    */
   title: string;
   /**
-   * First lines of body
+   * First 200 characters of page body, unformatted
    */
   body_excerpt: string;
   /**
@@ -7563,7 +7607,7 @@ export type SearchResultAttributes = {
    */
   url: string;
   /**
-   * Score
+   * Search score
    */
   score: number;
   highlight: {
@@ -7589,7 +7633,7 @@ export type SearchResultData = {
  */
 export type SearchResultInstancesTargetSchema = {
   data: SearchResult[];
-  meta?: {
+  meta: {
     total_count: number;
   };
 };
@@ -8326,7 +8370,7 @@ export type ItemTypeFilterAttributes = {
    */
   name: string;
   /**
-   * The actual filter
+   * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
    */
   filter: {
     [k: string]: unknown;
@@ -8376,7 +8420,7 @@ export type ItemTypeFilterCreateSchema = {
        */
       name: string;
       /**
-       * The actual filter
+       * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
        */
       filter: {
         [k: string]: unknown;
@@ -8426,7 +8470,7 @@ export type ItemTypeFilterUpdateSchema = {
        */
       shared?: boolean;
       /**
-       * The actual filter
+       * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
        */
       filter: {
         [k: string]: unknown;
@@ -9298,6 +9342,7 @@ export type PublicInfoAttributes = {
   extras: null | {
     blocks_depth: number;
     blocks_per_item: number;
+    maximum_single_upload_bytes: number;
     [k: string]: unknown;
   };
 };
@@ -9382,7 +9427,7 @@ export type DailyUsageData = {
  * via the `instances.targetSchema` link.
  */
 export type DailyUsageInstancesTargetSchema = {
-  data: DailyUsage;
+  data: DailyUsage[];
 };
 
 /**

package/src/generated/SimpleSchemaTypes.ts

@@ -615,7 +615,7 @@ export type ItemInstancesHrefSchema = {
     [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>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
+   * 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;
   /**
@@ -1010,25 +1010,41 @@ export type SearchResultInstancesTargetSchema = SearchResult[];
  */
 export type SearchResultInstancesHrefSchema = {
   /**
-   * The query string to search
-   */
-  q: string;
-  /**
-   * The build trigger ID on which the search will be performed
-   */
-  build_trigger_id?: string;
-  /**
-   * Restrict the search on one locale
-   */
-  locale?: string;
-  /**
-   * Maximum number of results to return (defaults to 20, maximum is 100)
+   * Attributes to manage results pagination
    */
-  limit?: number;
+  page?: {
+    /**
+     * Index of first element to fetch (defaults to 0)
+     */
+    offset?: number;
+    /**
+     * Number of elements to fetch (defaults to 20, maximum is 100)
+     */
+    limit?: number;
+    [k: string]: unknown;
+  };
   /**
-   * Number of records to offset for the search
+   * Attributes to filter search results
    */
-  offset?: string;
+  filter: {
+    /**
+     * When any value is passed, it enables the fuzzy search: the Levenshtein Edit Distance is used to match more results.
+     */
+    fuzzy?: string;
+    /**
+     * Text to search
+     */
+    query: string;
+    /**
+     * The build trigger ID on which the search will be performed. Required if more than one build trigger is present in a project
+     */
+    build_trigger_id?: string;
+    /**
+     * Restrict the search on pages in a specific locale
+     */
+    locale?: string;
+    [k: string]: unknown;
+  };
   [k: string]: unknown;
 };
 /**
@@ -1348,6 +1364,11 @@ export type DailyUsageIdentity = string;
  * via the `definition` "type".
  */
 export type DailyUsageType = 'daily_usage';
+/**
+ * This interface was referenced by `DailyUsage`'s JSON-Schema
+ * via the `instances.targetSchema` link.
+ */
+export type DailyUsageInstancesTargetSchema = DailyUsage[];
 /**
  * Name of the counter
  *
@@ -3568,6 +3589,10 @@ export type SitePlan = {
    * Whether or not use a static IP when sending webhooks
    */
   static_webhooks_ip: boolean;
+  /**
+   * Maximum size in bytes for a single file upload
+   */
+  maximum_single_upload_bytes: number;
   /**
    * Available extra packets
    */
@@ -3790,6 +3815,10 @@ export type SitePlanAttributes = {
    * Whether or not use a static IP when sending webhooks
    */
   static_webhooks_ip: boolean;
+  /**
+   * Maximum size in bytes for a single file upload
+   */
+  maximum_single_upload_bytes: number;
   /**
    * Available extra packets
    */
@@ -6501,6 +6530,14 @@ export type ItemMeta = {
    * Whether the current record is valid or not
    */
   is_valid: boolean;
+  /**
+   * Whether the current version of the record is valid or not
+   */
+  is_current_version_valid: null | boolean;
+  /**
+   * Whether the published version of record is valid or not
+   */
+  is_published_version_valid: null | boolean;
   /**
    * The ID of the current record version
    */
@@ -6593,6 +6630,14 @@ export type ItemCreateSchema = {
      * Whether the current record is valid or not
      */
     is_valid?: boolean;
+    /**
+     * Whether the current version of the record is valid or not
+     */
+    is_current_version_valid?: null | boolean;
+    /**
+     * Whether the published version of the record is valid or not
+     */
+    is_published_version_valid?: null | boolean;
     /**
      * The ID of the current record version
      */
@@ -6650,6 +6695,14 @@ export type ItemUpdateSchema = {
      * The ID of the current record version (for optimistic locking, see the example)
      */
     current_version?: string;
+    /**
+     * Whether the current version of the record is valid or not
+     */
+    is_current_version_valid?: null | boolean;
+    /**
+     * Whether the published version of record is valid or not
+     */
+    is_published_version_valid?: null | boolean;
     /**
      * The new stage to move the record to
      */
@@ -7498,11 +7551,11 @@ export type SearchResult = {
   id: SearchResultIdentity;
   type: SearchResultType;
   /**
-   * Page title
+   * Title of the page
    */
   title: string;
   /**
-   * First lines of body
+   * First 200 characters of page body, unformatted
    */
   body_excerpt: string;
   /**
@@ -7510,7 +7563,7 @@ export type SearchResult = {
    */
   url: string;
   /**
-   * Score
+   * Search score
    */
   score: number;
   highlight: {
@@ -7538,11 +7591,11 @@ export type SearchResultData = {
  */
 export type SearchResultAttributes = {
   /**
-   * Page title
+   * Title of the page
    */
   title: string;
   /**
-   * First lines of body
+   * First 200 characters of page body, unformatted
    */
   body_excerpt: string;
   /**
@@ -7550,7 +7603,7 @@ export type SearchResultAttributes = {
    */
   url: string;
   /**
-   * Score
+   * Search score
    */
   score: number;
   highlight: {
@@ -8226,7 +8279,7 @@ export type ItemTypeFilter = {
    */
   name: string;
   /**
-   * The actual filter
+   * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
    */
   filter: {
     [k: string]: unknown;
@@ -8264,7 +8317,7 @@ export type ItemTypeFilterAttributes = {
    */
   name: string;
   /**
-   * The actual filter
+   * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
    */
   filter: {
     [k: string]: unknown;
@@ -8296,7 +8349,7 @@ export type ItemTypeFilterCreateSchema = {
    */
   name: string;
   /**
-   * The actual filter
+   * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
    */
   filter: {
     [k: string]: unknown;
@@ -8324,7 +8377,7 @@ export type ItemTypeFilterUpdateSchema = {
    */
   shared?: boolean;
   /**
-   * The actual filter
+   * The actual filter. It follows the form of the `filter` query parameter of the [List all records](https://www.datocms.com/docs/content-management-api/resources/item/instances) endpoint.
    */
   filter: {
     [k: string]: unknown;
@@ -8897,6 +8950,7 @@ export type PublicInfo = {
   extras: null | {
     blocks_depth: number;
     blocks_per_item: number;
+    maximum_single_upload_bytes: number;
     [k: string]: unknown;
   };
 };
@@ -8979,6 +9033,7 @@ export type PublicInfoAttributes = {
   extras: null | {
     blocks_depth: number;
     blocks_per_item: number;
+    maximum_single_upload_bytes: number;
     [k: string]: unknown;
   };
 };
@@ -9017,7 +9072,7 @@ export type DailyUsage = {
    */
   mux_delivered_seconds: number;
 };
-export type DailyUsageInstancesTargetSchema = DailyUsage;
+
 /**
  * JSON API data
  *

package/src/generated/resources/Item.ts

@@ -69,7 +69,8 @@ export default class Item extends BaseResource {
         defaultLimit: 30,
         maxLimit: 500,
       },
-      (page) => this.rawList({ ...queryParams, page }),
+      (page: SchemaTypes.ItemInstancesHrefSchema['page']) =>
+        this.rawList({ ...queryParams, page }),
       iteratorOptions,
     );
   }
@@ -341,7 +342,7 @@ export default class Item extends BaseResource {
    *
    * @deprecated This API call is to be considered private and might change without notice
    */
-  batchDestroy(queryParams?: SimpleSchemaTypes.ItemBatchDestroyHrefSchema) {
+  batchDestroy(queryParams: SimpleSchemaTypes.ItemBatchDestroyHrefSchema) {
     return this.rawBatchDestroy(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.ItemBatchDestroyJobSchema>(
         body,
@@ -357,7 +358,7 @@ export default class Item extends BaseResource {
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawBatchDestroy(
-    queryParams?: SchemaTypes.ItemBatchDestroyHrefSchema,
+    queryParams: SchemaTypes.ItemBatchDestroyHrefSchema,
   ): Promise<SchemaTypes.ItemBatchDestroyJobSchema> {
     return this.client.request<SchemaTypes.ItemBatchDestroyJobSchema>({
       method: 'DELETE',
@@ -373,7 +374,7 @@ export default class Item extends BaseResource {
    *
    * @deprecated This API call is to be considered private and might change without notice
    */
-  batchPublish(queryParams?: SimpleSchemaTypes.ItemBatchPublishHrefSchema) {
+  batchPublish(queryParams: SimpleSchemaTypes.ItemBatchPublishHrefSchema) {
     return this.rawBatchPublish(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.ItemBatchPublishJobSchema>(
         body,
@@ -389,7 +390,7 @@ export default class Item extends BaseResource {
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawBatchPublish(
-    queryParams?: SchemaTypes.ItemBatchPublishHrefSchema,
+    queryParams: SchemaTypes.ItemBatchPublishHrefSchema,
   ): Promise<SchemaTypes.ItemBatchPublishJobSchema> {
     return this.client.request<SchemaTypes.ItemBatchPublishJobSchema>({
       method: 'PUT',
@@ -405,7 +406,7 @@ export default class Item extends BaseResource {
    *
    * @deprecated This API call is to be considered private and might change without notice
    */
-  batchUnpublish(queryParams?: SimpleSchemaTypes.ItemBatchUnpublishHrefSchema) {
+  batchUnpublish(queryParams: SimpleSchemaTypes.ItemBatchUnpublishHrefSchema) {
     return this.rawBatchUnpublish(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.ItemBatchUnpublishJobSchema>(
         body,
@@ -421,7 +422,7 @@ export default class Item extends BaseResource {
    * @deprecated This API call is to be considered private and might change without notice
    */
   rawBatchUnpublish(
-    queryParams?: SchemaTypes.ItemBatchUnpublishHrefSchema,
+    queryParams: SchemaTypes.ItemBatchUnpublishHrefSchema,
   ): Promise<SchemaTypes.ItemBatchUnpublishJobSchema> {
     return this.client.request<SchemaTypes.ItemBatchUnpublishJobSchema>({
       method: 'PUT',

package/src/generated/resources/ItemVersion.ts

@@ -103,7 +103,8 @@ export default class ItemVersion extends BaseResource {
         defaultLimit: 15,
         maxLimit: 50,
       },
-      (page) => this.rawList(itemId, { ...queryParams, page }),
+      (page: SchemaTypes.ItemVersionInstancesHrefSchema['page']) =>
+        this.rawList(itemId, { ...queryParams, page }),
       iteratorOptions,
     );
   }

package/src/generated/resources/SearchResult.ts

@@ -11,7 +11,7 @@ export default class SearchResult extends BaseResource {
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
    */
-  list(queryParams?: SimpleSchemaTypes.SearchResultInstancesHrefSchema) {
+  list(queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema) {
     return this.rawList(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.SearchResultInstancesTargetSchema>(
         body,
@@ -25,7 +25,7 @@ export default class SearchResult extends BaseResource {
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
    */
   rawList(
-    queryParams?: SchemaTypes.SearchResultInstancesHrefSchema,
+    queryParams: SchemaTypes.SearchResultInstancesHrefSchema,
   ): Promise<SchemaTypes.SearchResultInstancesTargetSchema> {
     return this.client.request<SchemaTypes.SearchResultInstancesTargetSchema>({
       method: 'GET',
@@ -33,4 +33,45 @@ export default class SearchResult extends BaseResource {
       queryParams,
     });
   }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by list()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
+   */
+  async *listPagedIterator(
+    queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    for await (const element of this.rawListPagedIterator(
+      queryParams,
+      iteratorOptions,
+    )) {
+      yield Utils.deserializeJsonEntity<
+        SimpleSchemaTypes.SearchResultInstancesTargetSchema[0]
+      >(element);
+    }
+  }
+
+  /**
+   * Async iterator to auto-paginate over elements returned by rawList()
+   *
+   * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
+   */
+  rawListPagedIterator(
+    queryParams: SchemaTypes.SearchResultInstancesHrefSchema,
+    iteratorOptions?: Utils.IteratorOptions,
+  ) {
+    return Utils.rawPageIterator<
+      SchemaTypes.SearchResultInstancesTargetSchema['data'][0]
+    >(
+      {
+        defaultLimit: 20,
+        maxLimit: 100,
+      },
+      (page: SchemaTypes.SearchResultInstancesHrefSchema['page']) =>
+        this.rawList({ ...queryParams, page }),
+      iteratorOptions,
+    );
+  }
 }

package/src/generated/resources/Upload.ts

@@ -110,7 +110,8 @@ export default class Upload extends BaseResource {
         defaultLimit: 30,
         maxLimit: 500,
       },
-      (page) => this.rawList({ ...queryParams, page }),
+      (page: SchemaTypes.UploadInstancesHrefSchema['page']) =>
+        this.rawList({ ...queryParams, page }),
       iteratorOptions,
     );
   }

package/src/generated/resources/UploadSmartTag.ts

@@ -71,7 +71,8 @@ export default class UploadSmartTag extends BaseResource {
         defaultLimit: 50,
         maxLimit: 500,
       },
-      (page) => this.rawList({ ...queryParams, page }),
+      (page: SchemaTypes.UploadSmartTagInstancesHrefSchema['page']) =>
+        this.rawList({ ...queryParams, page }),
       iteratorOptions,
     );
   }

package/src/generated/resources/UploadTag.ts

@@ -69,7 +69,8 @@ export default class UploadTag extends BaseResource {
         defaultLimit: 50,
         maxLimit: 500,
       },
-      (page) => this.rawList({ ...queryParams, page }),
+      (page: SchemaTypes.UploadTagInstancesHrefSchema['page']) =>
+        this.rawList({ ...queryParams, page }),
       iteratorOptions,
     );
   }

package/src/generated/resources/WebhookCall.ts

@@ -69,7 +69,8 @@ export default class WebhookCall extends BaseResource {
         defaultLimit: 30,
         maxLimit: 500,
       },
-      (page) => this.rawList({ ...queryParams, page }),
+      (page: SchemaTypes.WebhookCallInstancesHrefSchema['page']) =>
+        this.rawList({ ...queryParams, page }),
       iteratorOptions,
     );
   }