contentful-management
Version:
Client for Contentful's Content Management API
375 lines (374 loc) • 24.2 kB
TypeScript
import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
import type { OpPatch } from 'json-patch';
import type { BasicCursorPaginationOptions, CollectionProp, CursorPaginatedCollectionProp, EnvironmentTemplateParams, GetAppDefinitionParams, GetBulkActionParams, GetContentTypeParams, GetEnvironmentTemplateParams, GetOrganizationMembershipParams, GetOrganizationParams, GetReleaseParams, GetSnapshotForContentTypeParams, GetSnapshotForEntryParams, GetSpaceEnvironmentParams, GetSpaceParams, KeyValueMap, QueryParams } from '../common-types';
import type { ApiKeyProps, CreateApiKeyProps } from '../entities/api-key';
import type { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from '../entities/asset';
import type { ContentTypeProps, CreateContentTypeProps } from '../entities/content-type';
import type { CreateEntryProps, EntryProps, EntryReferenceProps } from '../entities/entry';
import type { CreateOrganizationInvitationProps, OrganizationInvitationProps } from '../entities/organization-invitation';
import type { OrganizationMembershipProps } from '../entities/organization-membership';
import type { CreatePersonalAccessTokenProps, PersonalAccessTokenProps } from '../entities/personal-access-token';
import type { AccessTokenProps, CreatePersonalAccessTokenProps as CreatePATProps } from '../entities/access-token';
import type { PreviewApiKeyProps } from '../entities/preview-api-key';
import type { CreateUpdateScheduledActionProps, ScheduledActionProps } from '../entities/scheduled-action';
import type { SnapshotProps } from '../entities/snapshot';
import type { DefaultParams, OptionalDefaults } from './wrappers/wrap';
import type { AssetKeyProps, CreateAssetKeyProps } from '../entities/asset-key';
import type { FunctionProps } from '../entities/function';
import type { BulkActionPayload, BulkActionProps, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from '../entities/bulk-action';
import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from '../entities/release';
import type { ReleaseActionProps, ReleaseActionQueryOptions } from '../entities/release-action';
import type { CreateEnvironmentTemplateProps, EnvironmentTemplateProps } from '../entities/environment-template';
import type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateInstallationProps, EnvironmentTemplateValidationProps, ValidateEnvironmentTemplateInstallationProps } from '../entities/environment-template-installation';
import type { AppActionPlainClientAPI } from './entities/app-action';
import type { AppActionCallPlainClientAPI } from './entities/app-action-call';
import type { EditorInterfacePlainClientAPI } from './entities/editor-interface';
import type { UIConfigPlainClientAPI } from './entities/ui-config';
import type { UserUIConfigPlainClientAPI } from './entities/user-ui-config';
import type { AppDefinitionPlainClientAPI } from './entities/app-definition';
import type { AppUploadPlainClientAPI } from './entities/app-upload';
import type { AppBundlePlainClientAPI } from './entities/app-bundle';
import type { AppDetailsPlainClientAPI } from './entities/app-details';
import type { AppInstallationPlainClientAPI } from './entities/app-installation';
import type { WebhookPlainClientAPI } from './entities/webhook';
import type { AppSignedRequestPlainClientAPI } from './entities/app-signed-request';
import type { AppSigningSecretPlainClientAPI } from './entities/app-signing-secret';
import type { ExtensionPlainClientAPI } from './entities/extension';
import type { AppEventSubscriptionPlainClientAPI } from './entities/app-event-subscription';
import type { AppKeyPlainClientAPI } from './entities/app-key';
import type { UserPlainClientAPI } from './entities/user';
import type { UploadPlainClientAPI } from './entities/upload';
import type { OrganizationPlainClientAPI } from './entities/organization';
import type { LocalePlainClientAPI } from './entities/locale';
import type { SpacePlainClientAPI } from './entities/space';
import type { SpaceMembershipPlainClientAPI } from './entities/space-membership';
import type { SpaceMemberPlainClientAPI } from './entities/space-member';
import type { EnvironmentPlainClientAPI } from './entities/environment';
import type { EnvironmentAliasPlainClientAPI } from './entities/environment-alias';
import type { CommentPlainClientAPI } from './entities/comment';
import type { TaskPlainClientAPI } from './entities/task';
import type { WorkflowPlainClientAPI } from './entities/workflow';
import type { WorkflowsChangelogPlainClientAPI } from './entities/workflows-changelog';
import type { WorkflowDefinitionPlainClientAPI } from './entities/workflow-definition';
import type { RolePlainClientAPI } from './entities/role';
import type { TagPlainClientAPI } from './entities/tag';
import type { UsagePlainClientAPI } from './entities/usage';
import type { TeamSpaceMembershipPlainClientAPI } from './entities/team-space-membership';
import type { TeamPlainClientAPI } from './entities/team';
import type { TeamMembershipPlainClientAPI } from './entities/team-membership';
import type { AppAccessTokenPlainClientAPI } from './entities/app-access-token';
import type { ConceptPlainClientAPI } from './entities/concept';
import type { ConceptSchemePlainClientAPI } from './entities/concept-scheme';
import type { ResourceProviderPlainClientAPI } from './entities/resource-provider';
import type { ResourceTypePlainClientAPI } from './entities/resource-type';
import type { ResourcePlainAPI } from './entities/resource';
export type PlainClientAPI = {
raw: {
getDefaultParams(): DefaultParams | undefined;
get<T = unknown>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
post<T = unknown>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
patch<T = unknown>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
put<T = unknown>(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise<T>;
delete<T = unknown>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
http<T = unknown>(url: string, config?: RawAxiosRequestConfig): Promise<T>;
};
appAction: AppActionPlainClientAPI;
appActionCall: AppActionCallPlainClientAPI;
appBundle: AppBundlePlainClientAPI;
appDetails: AppDetailsPlainClientAPI;
appEventSubscription: AppEventSubscriptionPlainClientAPI;
appKey: AppKeyPlainClientAPI;
appSignedRequest: AppSignedRequestPlainClientAPI;
appSigningSecret: AppSigningSecretPlainClientAPI;
appAccessToken: AppAccessTokenPlainClientAPI;
function: {
getMany(params: OptionalDefaults<GetAppDefinitionParams & QueryParams>): Promise<CollectionProp<FunctionProps>>;
};
editorInterface: EditorInterfacePlainClientAPI;
space: SpacePlainClientAPI;
environment: EnvironmentPlainClientAPI;
environmentAlias: EnvironmentAliasPlainClientAPI;
environmentTemplate: {
get(params: GetEnvironmentTemplateParams & {
version?: number;
query?: {
select?: string;
};
}, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateProps>;
getMany(params: GetOrganizationParams & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateProps>;
versionUpdate(params: GetEnvironmentTemplateParams & {
version: number;
}, rawData: {
versionName?: string;
versionDescription?: string;
}, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateProps>;
update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateProps>;
delete(params: GetEnvironmentTemplateParams, headers?: RawAxiosRequestHeaders): Promise<void>;
versions(params: GetEnvironmentTemplateParams & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
validate(params: EnvironmentTemplateParams & {
version?: number;
}, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateValidationProps>;
install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: RawAxiosRequestHeaders): Promise<EnvironmentTemplateInstallationProps>;
disconnect(params: EnvironmentTemplateParams, headers?: RawAxiosRequestHeaders): Promise<void>;
};
environmentTemplateInstallation: {
getMany(params: BasicCursorPaginationOptions & {
environmentId?: string;
environmentTemplateId: string;
organizationId: string;
spaceId?: string;
}, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
installationId?: string;
}, headers?: RawAxiosRequestHeaders): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
};
bulkAction: {
get<T extends BulkActionPayload = any>(params: GetBulkActionParams): Promise<BulkActionProps<T>>;
publish(params: GetSpaceEnvironmentParams, payload: BulkActionPublishPayload): Promise<BulkActionProps<BulkActionPublishPayload>>;
unpublish(params: GetSpaceEnvironmentParams, payload: BulkActionUnpublishPayload): Promise<BulkActionProps<BulkActionUnpublishPayload>>;
validate(params: GetSpaceEnvironmentParams, payload: BulkActionValidatePayload): Promise<BulkActionProps<BulkActionValidatePayload>>;
};
comment: CommentPlainClientAPI;
concept: ConceptPlainClientAPI;
conceptScheme: ConceptSchemePlainClientAPI;
contentType: {
get(params: OptionalDefaults<GetContentTypeParams & QueryParams>): Promise<ContentTypeProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>;
update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: RawAxiosRequestHeaders): Promise<ContentTypeProps>;
delete(params: OptionalDefaults<GetContentTypeParams>): Promise<any>;
publish(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps): Promise<ContentTypeProps>;
unpublish(params: OptionalDefaults<GetContentTypeParams>): Promise<ContentTypeProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateContentTypeProps): Promise<ContentTypeProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: CreateContentTypeProps): Promise<ContentTypeProps>;
omitAndDeleteField(params: OptionalDefaults<GetContentTypeParams>, contentType: ContentTypeProps, fieldId: string): Promise<ContentTypeProps>;
};
user: UserPlainClientAPI;
entry: {
getPublished<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
getMany<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<EntryProps<T>>>;
get<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
update<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>, headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
patch<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise<EntryProps<T>>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<any>;
publish<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>): Promise<EntryProps<T>>;
unpublish<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
archive<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
unarchive<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
create<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
createWithId<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
contentTypeId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
include?: number;
}>): Promise<EntryReferenceProps>;
};
asset: {
getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<CollectionProp<AssetProps>>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
} & QueryParams>, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise<AssetProps>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps, headers?: RawAxiosRequestHeaders): Promise<AssetProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<any>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps): Promise<AssetProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: CreateAssetProps): Promise<AssetProps>;
createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, 'sys'>): Promise<AssetProps>;
processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
};
appUpload: AppUploadPlainClientAPI;
assetKey: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: CreateAssetKeyProps): Promise<AssetKeyProps>;
};
upload: UploadPlainClientAPI;
locale: LocalePlainClientAPI;
personalAccessToken: {
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProps>>;
create(rawData: CreatePersonalAccessTokenProps, headers?: RawAxiosRequestHeaders): Promise<PersonalAccessTokenProps>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProps>;
};
accessToken: {
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProps>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProps>>;
createPersonalAccessToken(rawData: CreatePATProps, headers?: RawAxiosRequestHeaders): Promise<AccessTokenProps>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProps>;
getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProps>>;
};
usage: UsagePlainClientAPI;
release: {
archive(params: OptionalDefaults<GetReleaseParams & {
version: number;
}>): Promise<ReleaseProps>;
get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
query(params: OptionalDefaults<GetSpaceEnvironmentParams> & {
query?: ReleaseQueryOptions;
}): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
update(params: OptionalDefaults<GetReleaseParams & {
version: number;
}>, data: ReleasePayload): Promise<ReleaseProps>;
delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
publish(params: OptionalDefaults<GetReleaseParams & {
version: number;
}>): Promise<ReleaseActionProps<'publish'>>;
unarchive(params: OptionalDefaults<GetReleaseParams & {
version: number;
}>): Promise<ReleaseProps>;
unpublish(params: OptionalDefaults<GetReleaseParams & {
version: number;
}>): Promise<ReleaseActionProps<'unpublish'>>;
validate(params: OptionalDefaults<GetReleaseParams>, data?: ReleaseValidatePayload): Promise<ReleaseActionProps<'validate'>>;
};
releaseAction: {
get(params: OptionalDefaults<GetReleaseParams> & {
actionId: string;
}): Promise<ReleaseActionProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps>>;
queryForRelease(params: OptionalDefaults<GetReleaseParams> & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps>>;
};
resource: ResourcePlainAPI;
resourceProvider: ResourceProviderPlainClientAPI;
resourceType: ResourceTypePlainClientAPI;
role: RolePlainClientAPI;
scheduledActions: {
get(params: OptionalDefaults<GetSpaceParams> & {
scheduledActionId: string;
environmentId: string;
}): Promise<ScheduledActionProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CursorPaginatedCollectionProp<ScheduledActionProps>>;
create(params: OptionalDefaults<GetSpaceParams>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
scheduledActionId: string;
}>): Promise<ScheduledActionProps>;
update(params: OptionalDefaults<GetSpaceParams & {
scheduledActionId: string;
version: number;
}>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
};
previewApiKey: {
get(params: OptionalDefaults<GetSpaceParams & {
previewApiKeyId: string;
}>): Promise<PreviewApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<PreviewApiKeyProps>>;
};
apiKey: {
get(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<ApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<ApiKeyProps>>;
create(params: OptionalDefaults<GetSpaceParams>, data: CreateApiKeyProps, headers?: RawAxiosRequestHeaders): Promise<ApiKeyProps>;
createWithId(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, data: CreateApiKeyProps, headers?: RawAxiosRequestHeaders): Promise<ApiKeyProps>;
update(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, rawData: ApiKeyProps, headers?: RawAxiosRequestHeaders): Promise<ApiKeyProps>;
delete(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<any>;
};
appDefinition: AppDefinitionPlainClientAPI;
appInstallation: AppInstallationPlainClientAPI;
extension: ExtensionPlainClientAPI;
webhook: WebhookPlainClientAPI;
snapshot: {
getManyForEntry<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSnapshotForEntryParams & QueryParams>): Promise<CollectionProp<SnapshotProps<Omit<EntryProps<T>, 'metadata'>>>>;
getForEntry<T extends KeyValueMap = KeyValueMap>(params: OptionalDefaults<GetSnapshotForEntryParams & {
snapshotId: string;
}>): Promise<SnapshotProps<Omit<EntryProps<T>, 'metadata'>>>;
getManyForContentType(params: OptionalDefaults<GetSnapshotForContentTypeParams & QueryParams>): Promise<CollectionProp<SnapshotProps<ContentTypeProps>>>;
getForContentType(params: OptionalDefaults<GetSnapshotForContentTypeParams & {
snapshotId: string;
}>): Promise<SnapshotProps<ContentTypeProps>>;
};
tag: TagPlainClientAPI;
organization: OrganizationPlainClientAPI;
organizationInvitation: {
get(params: OptionalDefaults<{
organizationId: string;
invitationId: string;
}>, headers?: RawAxiosRequestHeaders): Promise<OrganizationInvitationProps>;
create(params: OptionalDefaults<{
organizationId: string;
}>, data: CreateOrganizationInvitationProps, headers?: RawAxiosRequestHeaders): Promise<OrganizationInvitationProps>;
};
organizationMembership: {
get(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<OrganizationMembershipProps>;
getMany(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<OrganizationMembershipProps>>;
update(params: OptionalDefaults<GetOrganizationMembershipParams>, rawData: OrganizationMembershipProps, headers?: RawAxiosRequestHeaders): Promise<OrganizationMembershipProps>;
delete(params: OptionalDefaults<GetOrganizationMembershipParams>): Promise<any>;
};
spaceMember: SpaceMemberPlainClientAPI;
spaceMembership: SpaceMembershipPlainClientAPI;
task: TaskPlainClientAPI;
team: TeamPlainClientAPI;
teamMembership: TeamMembershipPlainClientAPI;
teamSpaceMembership: TeamSpaceMembershipPlainClientAPI;
uiConfig: UIConfigPlainClientAPI;
userUIConfig: UserUIConfigPlainClientAPI;
workflowDefinition: WorkflowDefinitionPlainClientAPI;
workflow: WorkflowPlainClientAPI;
workflowsChangelog: WorkflowsChangelogPlainClientAPI;
};