@datocms/cma-client
Version:
JS client for DatoCMS REST Content Management API
62 lines (61 loc) • 2.51 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 BuildEvent extends BaseResource {
static readonly TYPE: "build_event";
/**
* List all deploy events
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
list(queryParams?: ApiTypes.BuildEventInstancesHrefSchema): Promise<ApiTypes.BuildEventInstancesTargetSchema>;
/**
* List all deploy events
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawList(queryParams?: RawApiTypes.BuildEventInstancesHrefSchema): Promise<RawApiTypes.BuildEventInstancesTargetSchema>;
/**
* Async iterator to auto-paginate over elements returned by list()
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
listPagedIterator(queryParams?: Utils.OmitFromKnownKeys<ApiTypes.BuildEventInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<ApiTypes.BuildEvent, void, unknown>;
/**
* Async iterator to auto-paginate over elements returned by rawList()
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawListPagedIterator(queryParams?: Utils.OmitFromKnownKeys<RawApiTypes.BuildEventInstancesHrefSchema, 'page'>, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<RawApiTypes.BuildEvent, void, unknown>;
/**
* Retrieve a deploy event
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/self
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
find(buildEventId: string | ApiTypes.BuildEventData): Promise<ApiTypes.BuildEvent>;
/**
* Retrieve a deploy event
*
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/self
*
* @throws {ApiError}
* @throws {TimeoutError}
*/
rawFind(buildEventId: string): Promise<RawApiTypes.BuildEventSelfTargetSchema>;
}