@datocms/cma-client 1.0.0 → 1.1.1

package/src/generated/SchemaTypes.ts

@@ -830,25 +830,37 @@ 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: {
+    /**
+     * 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;
 };
 /**
@@ -3175,6 +3187,14 @@ export type SitePlanAttributes = {
    * Whether translator roles are enabled or not
    */
   translator_roles: boolean;
+  /**
+   * 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
    */
@@ -4310,7 +4330,7 @@ export type ItemTypeDestroyJobSchema = {
  * | Parameter         | Type                                      | Required | Description                    |
  * | ----------------- | ----------------------------------------- | -------- | ------------------------------ |
  * | `extensions`      | `Array<String>`                           |          | Set of allowed file extensions |
- * | `predefined_list` | one of `"image"`, `"video"`, `"document"` |          | Allowed file type              |
+ * | `predefined_list` | one of `"image"`, `"transformable_image"`, `"video"`, `"document"` |          | Allowed file type              |
  *
  * Only one of the parameters must be specified.
  *
@@ -7547,11 +7567,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;
   /**
@@ -7559,7 +7579,7 @@ export type SearchResultAttributes = {
    */
   url: string;
   /**
-   * Score
+   * Search score
    */
   score: number;
   highlight: {
@@ -7585,7 +7605,7 @@ export type SearchResultData = {
  */
 export type SearchResultInstancesTargetSchema = {
   data: SearchResult[];
-  meta?: {
+  meta: {
     total_count: number;
   };
 };
@@ -9294,6 +9314,7 @@ export type PublicInfoAttributes = {
   extras: null | {
     blocks_depth: number;
     blocks_per_item: number;
+    maximum_single_upload_bytes: number;
     [k: string]: unknown;
   };
 };
@@ -9378,7 +9399,7 @@ export type DailyUsageData = {
  * via the `instances.targetSchema` link.
  */
 export type DailyUsageInstancesTargetSchema = {
-  data: DailyUsage;
+  data: DailyUsage[];
 };
 
 /**
@@ -9610,10 +9631,6 @@ export type SiteAttributes = {
    * Specifies the last time when a change of data occurred
    */
   last_data_change_at: null | string;
-  /**
-   * Frontend website url
-   */
-  frontend_url: string | null;
   /**
    * Specifies whether all users of this site need to authenticate using two-factor authentication
    */
@@ -9707,48 +9724,12 @@ export type SiteRelationships = {
   account: {
     data: AccountData;
   };
-  build_triggers?: {
-    /**
-     * The list of build trigger
-     */
-    data: BuildTriggerData[];
-  };
-  menu_items: {
-    /**
-     * The list of site menu items
-     */
-    data: MenuItemData[];
-  };
-  sso_users: {
-    /**
-     * The list of site SSO users
-     */
-    data: SsoUserData[];
-  };
-  users: {
-    /**
-     * The list of site users
-     */
-    data: UserData[];
-  };
   item_types: {
     /**
-     * The list of site item types
+     * The list item types for the site
      */
     data: ItemTypeData[];
   };
-  sso_default_role?: {
-    /**
-     * Specifies the default role for newly created identity providers users
-     */
-    data: RoleData[];
-  };
-  roles: {
-    /**
-     * The list of site roles
-     */
-    data: RoleData[];
-  };
 };
 
 /**
@@ -9781,18 +9762,7 @@ export type SiteData = {
  */
 export type SiteSelfTargetSchema = {
   data: Site;
-  included?: (
-    | MenuItem
-    | User
-    | ItemType
-    | Role
-    | Field
-    | Upload
-    | SsoUser
-    | Fieldset
-    | Item
-    | Account
-  )[];
+  included?: (ItemType | Field | Upload | Fieldset | Item | Account)[];
 };
 
 /**

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;
 };
 /**
@@ -1348,6 +1360,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
  *
@@ -3564,6 +3581,14 @@ export type SitePlan = {
    * Whether translator roles are enabled or not
    */
   translator_roles: boolean;
+  /**
+   * 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
    */
@@ -3782,6 +3807,14 @@ export type SitePlanAttributes = {
    * Whether translator roles are enabled or not
    */
   translator_roles: boolean;
+  /**
+   * 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
    */
@@ -4826,7 +4859,7 @@ export type JobData = {
  * | Parameter         | Type                                      | Required | Description                    |
  * | ----------------- | ----------------------------------------- | -------- | ------------------------------ |
  * | `extensions`      | `Array<String>`                           |          | Set of allowed file extensions |
- * | `predefined_list` | one of `"image"`, `"video"`, `"document"` |          | Allowed file type              |
+ * | `predefined_list` | one of `"image"`, `"transformable_image"`, `"video"`, `"document"` |          | Allowed file type              |
  *
  * Only one of the parameters must be specified.
  *
@@ -7490,11 +7523,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;
   /**
@@ -7502,7 +7535,7 @@ export type SearchResult = {
    */
   url: string;
   /**
-   * Score
+   * Search score
    */
   score: number;
   highlight: {
@@ -7530,11 +7563,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;
   /**
@@ -7542,7 +7575,7 @@ export type SearchResultAttributes = {
    */
   url: string;
   /**
-   * Score
+   * Search score
    */
   score: number;
   highlight: {
@@ -8889,6 +8922,7 @@ export type PublicInfo = {
   extras: null | {
     blocks_depth: number;
     blocks_per_item: number;
+    maximum_single_upload_bytes: number;
     [k: string]: unknown;
   };
 };
@@ -8971,6 +9005,7 @@ export type PublicInfoAttributes = {
   extras: null | {
     blocks_depth: number;
     blocks_per_item: number;
+    maximum_single_upload_bytes: number;
     [k: string]: unknown;
   };
 };
@@ -9009,7 +9044,7 @@ export type DailyUsage = {
    */
   mux_delivered_seconds: number;
 };
-export type DailyUsageInstancesTargetSchema = DailyUsage;
+
 /**
  * JSON API data
  *
@@ -9244,10 +9279,6 @@ export type Site = {
    * Specifies the last time when a change of data occurred
    */
   last_data_change_at: null | string;
-  /**
-   * Frontend website url
-   */
-  frontend_url: string | null;
   /**
    * Specifies whether all users of this site need to authenticate using two-factor authentication
    */
@@ -9331,33 +9362,9 @@ export type Site = {
   } | null;
   account: AccountData;
   /**
-   * The list of build trigger
-   */
-  build_triggers?: BuildTriggerData[];
-  /**
-   * The list of site menu items
-   */
-  menu_items: MenuItemData[];
-  /**
-   * The list of site SSO users
-   */
-  sso_users: SsoUserData[];
-  /**
-   * The list of site users
-   */
-  users: UserData[];
-  /**
-   * The list of site item types
+   * The list item types for the site
    */
   item_types: ItemTypeData[];
-  /**
-   * Specifies the default role for newly created identity providers users
-   */
-  sso_default_role?: RoleData[];
-  /**
-   * The list of site roles
-   */
-  roles: RoleData[];
   meta: SiteMeta;
 };
 export type SiteSelfTargetSchema = Site;
@@ -9434,10 +9441,6 @@ export type SiteAttributes = {
    * Specifies the last time when a change of data occurred
    */
   last_data_change_at: null | string;
-  /**
-   * Frontend website url
-   */
-  frontend_url: string | null;
   /**
    * Specifies whether all users of this site need to authenticate using two-factor authentication
    */
@@ -9530,33 +9533,9 @@ export type SiteAttributes = {
 export type SiteRelationships = {
   account: AccountData;
   /**
-   * The list of build trigger
-   */
-  build_triggers?: BuildTriggerData[];
-  /**
-   * The list of site menu items
-   */
-  menu_items: MenuItemData[];
-  /**
-   * The list of site SSO users
-   */
-  sso_users: SsoUserData[];
-  /**
-   * The list of site users
-   */
-  users: UserData[];
-  /**
-   * The list of site item types
+   * The list item types for the site
    */
   item_types: ItemTypeData[];
-  /**
-   * Specifies the default role for newly created identity providers users
-   */
-  sso_default_role?: RoleData[];
-  /**
-   * The list of site roles
-   */
-  roles: RoleData[];
 };
 
 /**

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,
     );
   }