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

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

@@ -111,6 +111,24 @@ export default class ItemType extends BaseResource {
      * @throws {TimeoutError}
      */
     rawDestroy(itemTypeId: string, queryParams?: RawApiTypes.ItemTypeDestroyHrefSchema): Promise<RawApiTypes.ItemTypeDestroyJobSchema>;
+    /**
+     * List models referencing another model/block
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/referencing
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    referencing(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.ItemTypeReferencingTargetSchema>;
+    /**
+     * List models referencing another model/block
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/referencing
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawReferencing(itemTypeId: string): Promise<RawApiTypes.ItemTypeReferencingTargetSchema>;
     /**
      * Reorders a set of fields and fieldsets within the model
      *

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

@@ -68,7 +68,7 @@ export default class ItemVersion extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    find(itemVersionId: string | ApiTypes.ItemVersionData): Promise<ApiTypes.ItemVersion>;
+    find(itemVersionId: string | ApiTypes.ItemVersionData, queryParams?: ApiTypes.ItemVersionSelfHrefSchema): Promise<ApiTypes.ItemVersion>;
     /**
      * Retrieve a record version
      *
@@ -77,5 +77,5 @@ export default class ItemVersion extends BaseResource {
      * @throws {ApiError}
      * @throws {TimeoutError}
      */
-    rawFind(itemVersionId: string): Promise<RawApiTypes.ItemVersionSelfTargetSchema>;
+    rawFind(itemVersionId: string, queryParams?: RawApiTypes.ItemVersionSelfHrefSchema): Promise<RawApiTypes.ItemVersionSelfTargetSchema>;
 }

package/dist/types/generated/resources/SiteSearchSource.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 SiteSearchSource extends BaseResource {
+    static readonly TYPE: "site_search_source";
+    /**
+     * List all site search sources for a site
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    list(): Promise<ApiTypes.SiteSearchSourceInstancesTargetSchema>;
+    /**
+     * List all site search sources for a site
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawList(): Promise<RawApiTypes.SiteSearchSourceInstancesTargetSchema>;
+    /**
+     * Retrieve a site search source
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    find(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData): Promise<ApiTypes.SiteSearchSource>;
+    /**
+     * Retrieve a site search source
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawFind(siteSearchSourceId: string): Promise<RawApiTypes.SiteSearchSourceSelfTargetSchema>;
+    /**
+     * Create site search source
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    create(body: ApiTypes.SiteSearchSourceCreateSchema): Promise<ApiTypes.SiteSearchSource>;
+    /**
+     * Create site search source
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/create
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawCreate(body: RawApiTypes.SiteSearchSourceCreateSchema): Promise<RawApiTypes.SiteSearchSourceCreateTargetSchema>;
+    /**
+     * Update site search source
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    update(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData, body: ApiTypes.SiteSearchSourceUpdateSchema): Promise<ApiTypes.SiteSearchSource>;
+    /**
+     * Update site search source
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/update
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawUpdate(siteSearchSourceId: string, body: RawApiTypes.SiteSearchSourceUpdateSchema): Promise<RawApiTypes.SiteSearchSourceUpdateTargetSchema>;
+    /**
+     * Trigger a site search indexing
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/trigger
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    trigger(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData): Promise<void>;
+    /**
+     * Trigger a site search indexing
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/trigger
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawTrigger(siteSearchSourceId: string): Promise<void>;
+    /**
+     * Abort a site search spidering and mark it as failed
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/abort
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    abort(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData): Promise<void>;
+    /**
+     * Abort a site search spidering and mark it as failed
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/abort
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawAbort(siteSearchSourceId: string): Promise<void>;
+    /**
+     * Delete a site search source
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    destroy(siteSearchSourceId: string | ApiTypes.SiteSearchSourceData): Promise<ApiTypes.SiteSearchSource>;
+    /**
+     * Delete a site search source
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source/destroy
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawDestroy(siteSearchSourceId: string): Promise<RawApiTypes.SiteSearchSourceDestroyTargetSchema>;
+}

package/dist/types/generated/resources/SiteSearchSourceEvent.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 SiteSearchSourceEvent extends BaseResource {
+    static readonly TYPE: "site_search_source_event";
+    /**
+     * List all site search indexing events
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    list(queryParams?: ApiTypes.SiteSearchSourceEventInstancesHrefSchema): Promise<ApiTypes.SiteSearchSourceEventInstancesTargetSchema>;
+    /**
+     * List all site search indexing events
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawList(queryParams?: RawApiTypes.SiteSearchSourceEventInstancesHrefSchema): Promise<RawApiTypes.SiteSearchSourceEventInstancesTargetSchema>;
+    /**
+     * Async iterator to auto-paginate over elements returned by list()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    listPagedIterator(queryParams?: Utils.OmitFromKnownKeys<ApiTypes.SiteSearchSourceEventInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<ApiTypes.SiteSearchSourceEvent, void, unknown>;
+    /**
+     * Async iterator to auto-paginate over elements returned by rawList()
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/instances
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawListPagedIterator(queryParams?: Utils.OmitFromKnownKeys<RawApiTypes.SiteSearchSourceEventInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<RawApiTypes.SiteSearchSourceEvent, void, unknown>;
+    /**
+     * Retrieve a site search indexing event
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    find(siteSearchSourceEventId: string | ApiTypes.SiteSearchSourceEventData): Promise<ApiTypes.SiteSearchSourceEvent>;
+    /**
+     * Retrieve a site search indexing event
+     *
+     * Read more: https://www.datocms.com/docs/content-management-api/resources/site-search_source_event/self
+     *
+     * @throws {ApiError}
+     * @throws {TimeoutError}
+     */
+    rawFind(siteSearchSourceEventId: string): Promise<RawApiTypes.SiteSearchSourceEventSelfTargetSchema>;
+}

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

@@ -15,6 +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 Item } from './Item';
 export { default as ItemVersion } from './ItemVersion';
 export { default as Upload } from './Upload';
@@ -28,6 +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 ItemTypeFilter } from './ItemTypeFilter';
 export { default as UploadFilter } from './UploadFilter';
 export { default as SiteInvitation } from './SiteInvitation';

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

@@ -2,13 +2,20 @@ import type { NewBlockInRequest } from '../fieldTypes';
 import type * as ApiTypes from '../generated/ApiTypes';
 import type { ItemTypeDefinition, ToItemAttributesInRequest } from './itemDefinition';
 type NoInfer<T> = [T][T extends any ? 0 : never];
-type UpdateOrCreateBlockRecordSchema<D extends ItemTypeDefinition = ItemTypeDefinition> = {
-    id?: ApiTypes.ItemIdentity;
+type CreateBlockRecordSchema<D extends ItemTypeDefinition = ItemTypeDefinition> = {
     type?: ApiTypes.ItemType1;
     item_type: ApiTypes.ItemTypeData<D>;
     meta?: ApiTypes.ItemUpdateSchema['meta'];
     creator?: ApiTypes.ItemUpdateSchema['creator'];
     __itemTypeId?: D['itemTypeId'];
 } & ToItemAttributesInRequest<D>;
-export declare function buildBlockRecord<D extends ItemTypeDefinition = ItemTypeDefinition>(body: UpdateOrCreateBlockRecordSchema<NoInfer<D>>): NewBlockInRequest<NoInfer<D>>;
+type UpdateBlockRecordSchema<D extends ItemTypeDefinition = ItemTypeDefinition> = {
+    id: ApiTypes.ItemIdentity;
+    type?: ApiTypes.ItemType1;
+    item_type?: ApiTypes.ItemTypeData<D>;
+    meta?: ApiTypes.ItemUpdateSchema['meta'];
+    creator?: ApiTypes.ItemUpdateSchema['creator'];
+    __itemTypeId?: D['itemTypeId'];
+} & ToItemAttributesInRequest<D>;
+export declare function buildBlockRecord<D extends ItemTypeDefinition = ItemTypeDefinition>(body: CreateBlockRecordSchema<NoInfer<D>> | UpdateBlockRecordSchema<NoInfer<D>>): NewBlockInRequest<NoInfer<D>>;
 export {};

package/package.json

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