@datocms/cma-client 1.0.1 → 1.1.0

package/src/generated/SimpleSchemaTypes.ts

@@ -1010,25 +1010,37 @@ 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: {
+    /**
+     * 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;
 };
 /**
@@ -3568,6 +3580,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 +3806,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
    */
@@ -7498,11 +7518,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 +7530,7 @@ export type SearchResult = {
    */
   url: string;
   /**
-   * Score
+   * Search score
    */
   score: number;
   highlight: {
@@ -7538,11 +7558,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 +7570,7 @@ export type SearchResultAttributes = {
    */
   url: string;
   /**
-   * Score
+   * Search score
    */
   score: number;
   highlight: {
@@ -8897,6 +8917,7 @@ export type PublicInfo = {
   extras: null | {
     blocks_depth: number;
     blocks_per_item: number;
+    maximum_single_upload_bytes: number;
     [k: string]: unknown;
   };
 };
@@ -8979,6 +9000,7 @@ export type PublicInfoAttributes = {
   extras: null | {
     blocks_depth: number;
     blocks_per_item: number;
+    maximum_single_upload_bytes: number;
     [k: string]: unknown;
   };
 };

package/src/generated/resources/Item.ts

@@ -341,7 +341,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 +357,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 +373,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 +389,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 +405,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 +421,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/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,44 @@ 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) => this.rawList({ ...queryParams, page }),
+      iteratorOptions,
+    );
+  }
 }