| 1 | import type { RawAxiosRequestHeaders } from 'axios';
|
| 2 | import type { GetSpaceEnvironmentParams, CollectionProp } from '../../common-types';
|
| 3 | import type { OptionalDefaults } from '../wrappers/wrap';
|
| 4 | import type { WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions } from '../../entities/workflows-changelog-entry';
|
| 5 | export type WorkflowsChangelogPlainClientAPI = {
|
| 6 | /**
|
| 7 | * Query records in the Workflows Changelog with certain filters
|
| 8 | * @param params entity IDs to identify the Space/Environment, query options to identify the entry for which the Workflow was executed, and optional filtering and pagination parameters
|
| 9 | * @returns an object containing the array of Workflow Changelogs
|
| 10 | * @throws if the request fails, or the Space/Environment is not found
|
| 11 | * @example
|
| 12 | * ```javascript
|
| 13 | * const records = await client.workflowsChangelog.getMany({
|
| 14 | * spaceId: '<space_id>',
|
| 15 | * environmentId: '<environment_id>',
|
| 16 | * query: {
|
| 17 | * 'entity.sys.linkType': 'entry',
|
| 18 | * 'entity.sys.id': '<entry_id>',
|
| 19 | * }
|
| 20 | * });
|
| 21 | * ```
|
| 22 | */
|
| 23 | getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & {
|
| 24 | query: WorkflowsChangelogQueryOptions;
|
| 25 | }>, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<WorkflowsChangelogEntryProps>>;
|
| 26 | };
|