@datocms/cma-client
Version:
JS client for DatoCMS REST Content Management API
62 lines (61 loc) • 2.68 kB
TypeScript
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>;
}