@datocms/cma-client 5.2.0-alpha.3 → 5.2.0-alpha.5

package/dist/types/generated/resources/ItemType.d.ts

@@ -4,7 +4,7 @@ import type * as RawApiTypes from '../RawApiTypes';
 export default class ItemType extends BaseResource {
     static readonly TYPE: "item_type";
     /**
-     * Create a new model
+     * Create a new model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/create
      *
@@ -13,7 +13,7 @@ export default class ItemType extends BaseResource {
      */
     create(body: ApiTypes.ItemTypeCreateSchema, queryParams?: ApiTypes.ItemTypeCreateHrefSchema): Promise<ApiTypes.ItemType>;
     /**
-     * Create a new model
+     * Create a new model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/create
      *
@@ -22,7 +22,7 @@ export default class ItemType extends BaseResource {
      */
     rawCreate(body: RawApiTypes.ItemTypeCreateSchema, queryParams?: RawApiTypes.ItemTypeCreateHrefSchema): Promise<RawApiTypes.ItemTypeCreateTargetSchema>;
     /**
-     * Update a model
+     * Update a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/update
      *
@@ -31,7 +31,7 @@ export default class ItemType extends BaseResource {
      */
     update(itemTypeId: string | ApiTypes.ItemTypeData, body: ApiTypes.ItemTypeUpdateSchema): Promise<ApiTypes.ItemType>;
     /**
-     * Update a model
+     * Update a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/update
      *
@@ -40,7 +40,7 @@ export default class ItemType extends BaseResource {
      */
     rawUpdate(itemTypeId: string, body: RawApiTypes.ItemTypeUpdateSchema): Promise<RawApiTypes.ItemTypeUpdateJobSchema>;
     /**
-     * List all models
+     * List all models/block models
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/instances
      *
@@ -49,7 +49,7 @@ export default class ItemType extends BaseResource {
      */
     list(): Promise<ApiTypes.ItemTypeInstancesTargetSchema>;
     /**
-     * List all models
+     * List all models/block models
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/instances
      *
@@ -58,7 +58,7 @@ export default class ItemType extends BaseResource {
      */
     rawList(): Promise<RawApiTypes.ItemTypeInstancesTargetSchema>;
     /**
-     * Retrieve a model
+     * Retrieve a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/self
      *
@@ -67,7 +67,7 @@ export default class ItemType extends BaseResource {
      */
     find(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.ItemType>;
     /**
-     * Retrieve a model
+     * Retrieve a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/self
      *
@@ -76,7 +76,7 @@ export default class ItemType extends BaseResource {
      */
     rawFind(itemTypeId: string): Promise<RawApiTypes.ItemTypeSelfTargetSchema>;
     /**
-     * Duplicate model
+     * Duplicate model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate
      *
@@ -85,7 +85,7 @@ export default class ItemType extends BaseResource {
      */
     duplicate(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.ItemType>;
     /**
-     * Duplicate model
+     * Duplicate model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate
      *
@@ -94,7 +94,7 @@ export default class ItemType extends BaseResource {
      */
     rawDuplicate(itemTypeId: string): Promise<RawApiTypes.ItemTypeDuplicateTargetSchema>;
     /**
-     * Delete a model
+     * Delete a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/destroy
      *
@@ -103,7 +103,7 @@ export default class ItemType extends BaseResource {
      */
     destroy(itemTypeId: string | ApiTypes.ItemTypeData, queryParams?: ApiTypes.ItemTypeDestroyHrefSchema): Promise<ApiTypes.ItemType>;
     /**
-     * Delete a model
+     * Delete a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/destroy
      *

package/dist/types/generated/resources/SearchIndex.d.ts

@@ -0,0 +1,132 @@
+import BaseResource from '../../BaseResource';
+import type * as ApiTypes from '../ApiTypes';
+import type * as RawApiTypes from '../RawApiTypes';
+export default class SearchIndex extends BaseResource {
+    static readonly TYPE: "search_index";
+    /**
+     * List all search indexes for a site
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    list(): Promise<ApiTypes.SearchIndexInstancesTargetSchema>;
+    /**
+     * List all search indexes for a site
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawList(): Promise<RawApiTypes.SearchIndexInstancesTargetSchema>;
+    /**
+     * Retrieve a search index
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    find(searchIndexId: string | ApiTypes.SearchIndexData): Promise<ApiTypes.SearchIndex>;
+    /**
+     * Retrieve a search index
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawFind(searchIndexId: string): Promise<RawApiTypes.SearchIndexSelfTargetSchema>;
+    /**
+     * Create a search index
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    create(body: ApiTypes.SearchIndexCreateSchema): Promise<ApiTypes.SearchIndex>;
+    /**
+     * Create a search index
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawCreate(body: RawApiTypes.SearchIndexCreateSchema): Promise<RawApiTypes.SearchIndexCreateTargetSchema>;
+    /**
+     * Update a search index
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    update(searchIndexId: string | ApiTypes.SearchIndexData, body: ApiTypes.SearchIndexUpdateSchema): Promise<ApiTypes.SearchIndex>;
+    /**
+     * Update a search index
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawUpdate(searchIndexId: string, body: RawApiTypes.SearchIndexUpdateSchema): Promise<RawApiTypes.SearchIndexUpdateTargetSchema>;
+    /**
+     * Trigger the indexing process
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    trigger(searchIndexId: string | ApiTypes.SearchIndexData): Promise<void>;
+    /**
+     * Trigger the indexing process
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawTrigger(searchIndexId: string): Promise<void>;
+    /**
+     * Abort a the current indexing process and mark it as failed
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    abort(searchIndexId: string | ApiTypes.SearchIndexData): Promise<void>;
+    /**
+     * Abort a the current indexing process and mark it as failed
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawAbort(searchIndexId: string): Promise<void>;
+    /**
+     * Delete a search index
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    destroy(searchIndexId: string | ApiTypes.SearchIndexData): Promise<ApiTypes.SearchIndex>;
+    /**
+     * Delete a search index
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawDestroy(searchIndexId: string): Promise<RawApiTypes.SearchIndexDestroyTargetSchema>;
+}

package/dist/types/generated/resources/SearchIndexEvent.d.ts

@@ -0,0 +1,61 @@
+import * as Utils from '@datocms/rest-client-utils';
+import BaseResource from '../../BaseResource';
+import type * as ApiTypes from '../ApiTypes';
+import type * as RawApiTypes from '../RawApiTypes';
+export default class SearchIndexEvent extends BaseResource {
+    static readonly TYPE: "search_index_event";
+    /**
+     * List all search indexing events
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    list(queryParams?: ApiTypes.SearchIndexEventInstancesHrefSchema): Promise<ApiTypes.SearchIndexEventInstancesTargetSchema>;
+    /**
+     * List all search indexing events
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawList(queryParams?: RawApiTypes.SearchIndexEventInstancesHrefSchema): Promise<RawApiTypes.SearchIndexEventInstancesTargetSchema>;
+    /**
+     * Async iterator to auto-paginate over elements returned by list()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    listPagedIterator(queryParams?: Utils.OmitFromKnownKeys<ApiTypes.SearchIndexEventInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<ApiTypes.SearchIndexEvent, void, unknown>;
+    /**
+     * Async iterator to auto-paginate over elements returned by rawList()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawListPagedIterator(queryParams?: Utils.OmitFromKnownKeys<RawApiTypes.SearchIndexEventInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<RawApiTypes.SearchIndexEvent, void, unknown>;
+    /**
+     * Retrieve a search indexing event
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    find(searchIndexEventId: string | ApiTypes.SearchIndexEventData): Promise<ApiTypes.SearchIndexEvent>;
+    /**
+     * Retrieve a search indexing event
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index_event/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawFind(searchIndexEventId: string): Promise<RawApiTypes.SearchIndexEventSelfTargetSchema>;
+}

package/dist/types/generated/resources/index.d.ts

@@ -15,7 +15,7 @@ export { default as JobResult } from './JobResult';
 export { default as SubscriptionLimit } from './SubscriptionLimit';
 export { default as SubscriptionFeature } from './SubscriptionFeature';
 export { default as BuildEvent } from './BuildEvent';
-export { default as SiteSearchSourceEvent } from './SiteSearchSourceEvent';
+export { default as SearchIndexEvent } from './SearchIndexEvent';
 export { default as Item } from './Item';
 export { default as ItemVersion } from './ItemVersion';
 export { default as Upload } from './Upload';
@@ -29,7 +29,7 @@ export { default as MaintenanceMode } from './MaintenanceMode';
 export { default as Webhook } from './Webhook';
 export { default as WebhookCall } from './WebhookCall';
 export { default as BuildTrigger } from './BuildTrigger';
-export { default as SiteSearchSource } from './SiteSearchSource';
+export { default as SearchIndex } from './SearchIndex';
 export { default as ItemTypeFilter } from './ItemTypeFilter';
 export { default as UploadFilter } from './UploadFilter';
 export { default as SiteInvitation } from './SiteInvitation';

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

@@ -194,7 +194,7 @@ export declare class SchemaRepository {
      * @param itemType - The item type to get fields for
      * @returns Promise that resolves to an array of fields
      */
-    getRawItemTypeFields(itemType: RawApiTypes.ItemType): Promise<RawApiTypes.Field[]>;
+    getRawItemTypeFields(itemType: ApiTypes.ItemType | RawApiTypes.ItemType): Promise<RawApiTypes.Field[]>;
     /**
      * Gets all fieldsets for a given item type.
      * Fieldsets are cached after the first request for performance.
@@ -208,7 +208,7 @@ export declare class SchemaRepository {
      * @param itemType - The item type to get fieldsets for
      * @returns Promise that resolves to an array of fieldsets
      */
-    getRawItemTypeFieldsets(itemType: RawApiTypes.ItemType): Promise<RawApiTypes.Fieldset[]>;
+    getRawItemTypeFieldsets(itemType: ApiTypes.ItemType | RawApiTypes.ItemType): Promise<RawApiTypes.Fieldset[]>;
     /**
      * Loads and caches all plugins from the DatoCMS API.
      * This method is called lazily and caches the result for subsequent calls.
@@ -285,5 +285,45 @@ export declare class SchemaRepository {
      * @returns Promise that resolves to array of models that embed these blocks
      */
     getModelsEmbeddingBlocks(blocks: Array<ApiTypes.ItemType | RawApiTypes.ItemType>): Promise<Array<ApiTypes.ItemType>>;
+    /**
+     * Gets all block models that are directly or indirectly nested within the given item types.
+     * This method recursively traverses the schema to find all blocks that are nested
+     * within the provided item types, either directly through block fields or indirectly through
+     * other nested block models.
+     *
+     * @param itemTypes - Array of item types to find nested blocks for
+     * @returns Promise that resolves to array of all block models nested in these item types
+     */
+    getRawNestedBlocks(itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>): Promise<Array<RawApiTypes.ItemType>>;
+    /**
+     * Gets all block models that are directly or indirectly nested within the given item types.
+     * This method recursively traverses the schema to find all blocks that are nested
+     * within the provided item types, either directly through block fields or indirectly through
+     * other nested block models.
+     *
+     * @param itemTypes - Array of item types to find nested blocks for
+     * @returns Promise that resolves to array of all block models nested in these item types
+     */
+    getNestedBlocks(itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>): Promise<Array<ApiTypes.ItemType>>;
+    /**
+     * Gets all models that are directly or indirectly nested/referenced within the given item types.
+     * This method recursively traverses the schema to find all models that are referenced
+     * by the provided item types through link fields, either directly or indirectly through
+     * other referenced blocks.
+     *
+     * @param itemTypes - Array of item types to find nested models for
+     * @returns Promise that resolves to array of all models nested in these item types
+     */
+    getRawNestedModels(itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>): Promise<Array<RawApiTypes.ItemType>>;
+    /**
+     * Gets all models that are directly or indirectly nested/referenced within the given item types.
+     * This method recursively traverses the schema to find all models that are referenced
+     * by the provided item types through link fields, either directly or indirectly through
+     * other referenced blocks.
+     *
+     * @param itemTypes - Array of item types to find nested models for
+     * @returns Promise that resolves to array of all models nested in these item types
+     */
+    getNestedModels(itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>): Promise<Array<ApiTypes.ItemType>>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "5.2.0-alpha.3",
+  "version": "5.2.0-alpha.5",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -42,8 +42,8 @@
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^5.2.0-alpha.3",
+    "@datocms/dashboard-client": "^5.2.0-alpha.5",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "cbaad3363bbe1fa53160b9b03d76ac594fd3c798"
+  "gitHead": "9f4282b559889e0e27011246d4ebe42d9c0f8cb8"
 }