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, PersonalAccessTokenProp } from '../entities/personal-access-token'; import type { AccessTokenProp, 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'; export type PlainClientAPI = { raw: { getDefaultParams(): DefaultParams | undefined; get(url: string, config?: RawAxiosRequestConfig): Promise; post(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise; patch(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise; put(url: string, payload?: any, config?: RawAxiosRequestConfig): Promise; delete(url: string, config?: RawAxiosRequestConfig): Promise; http(url: string, config?: RawAxiosRequestConfig): Promise; }; appAction: AppActionPlainClientAPI; appActionCall: AppActionCallPlainClientAPI; appBundle: AppBundlePlainClientAPI; appDetails: AppDetailsPlainClientAPI; appEventSubscription: AppEventSubscriptionPlainClientAPI; appKey: AppKeyPlainClientAPI; appSignedRequest: AppSignedRequestPlainClientAPI; appSigningSecret: AppSigningSecretPlainClientAPI; appAccessToken: AppAccessTokenPlainClientAPI; function: { getMany(params: OptionalDefaults): Promise>; }; editorInterface: EditorInterfacePlainClientAPI; space: SpacePlainClientAPI; environment: EnvironmentPlainClientAPI; environmentAlias: EnvironmentAliasPlainClientAPI; environmentTemplate: { get(params: GetEnvironmentTemplateParams & { version?: number; query?: { select?: string; }; }, headers?: RawAxiosRequestHeaders): Promise; getMany(params: GetOrganizationParams & { query?: BasicCursorPaginationOptions & { select?: string; }; }, headers?: RawAxiosRequestHeaders): Promise>; create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: RawAxiosRequestHeaders): Promise; versionUpdate(params: GetEnvironmentTemplateParams & { version: number; }, rawData: { versionName?: string; versionDescription?: string; }, headers?: RawAxiosRequestHeaders): Promise; update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: RawAxiosRequestHeaders): Promise; delete(params: GetEnvironmentTemplateParams, headers?: RawAxiosRequestHeaders): Promise; versions(params: GetEnvironmentTemplateParams & { query?: BasicCursorPaginationOptions & { select?: string; }; }, headers?: RawAxiosRequestHeaders): Promise>; validate(params: EnvironmentTemplateParams & { version?: number; }, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: RawAxiosRequestHeaders): Promise; install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: RawAxiosRequestHeaders): Promise; disconnect(params: EnvironmentTemplateParams, headers?: RawAxiosRequestHeaders): Promise; }; environmentTemplateInstallation: { getMany(params: BasicCursorPaginationOptions & { environmentId?: string; environmentTemplateId: string; organizationId: string; spaceId?: string; }, headers?: RawAxiosRequestHeaders): Promise>; getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & { installationId?: string; }, headers?: RawAxiosRequestHeaders): Promise>; }; bulkAction: { get(params: GetBulkActionParams): Promise>; publish(params: GetSpaceEnvironmentParams, payload: BulkActionPublishPayload): Promise>; unpublish(params: GetSpaceEnvironmentParams, payload: BulkActionUnpublishPayload): Promise>; validate(params: GetSpaceEnvironmentParams, payload: BulkActionValidatePayload): Promise>; }; comment: CommentPlainClientAPI; concept: ConceptPlainClientAPI; conceptScheme: ConceptSchemePlainClientAPI; contentType: { get(params: OptionalDefaults): Promise; getMany(params: OptionalDefaults): Promise>; update(params: OptionalDefaults, rawData: ContentTypeProps, headers?: RawAxiosRequestHeaders): Promise; delete(params: OptionalDefaults): Promise; publish(params: OptionalDefaults, rawData: ContentTypeProps): Promise; unpublish(params: OptionalDefaults): Promise; create(params: OptionalDefaults, rawData: CreateContentTypeProps): Promise; createWithId(params: OptionalDefaults, rawData: CreateContentTypeProps): Promise; omitAndDeleteField(params: OptionalDefaults, contentType: ContentTypeProps, fieldId: string): Promise; }; user: UserPlainClientAPI; entry: { getPublished(params: OptionalDefaults, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise>>; getMany(params: OptionalDefaults, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise>>; get(params: OptionalDefaults, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise>; update(params: OptionalDefaults, rawData: EntryProps, headers?: RawAxiosRequestHeaders): Promise>; patch(params: OptionalDefaults, rawData: OpPatch[], headers?: RawAxiosRequestHeaders): Promise>; delete(params: OptionalDefaults): Promise; publish(params: OptionalDefaults, rawData: EntryProps): Promise>; unpublish(params: OptionalDefaults): Promise>; archive(params: OptionalDefaults): Promise>; unarchive(params: OptionalDefaults): Promise>; create(params: OptionalDefaults, rawData: CreateEntryProps): Promise>; createWithId(params: OptionalDefaults, rawData: CreateEntryProps): Promise>; references(params: OptionalDefaults): Promise; }; asset: { getPublished(params: OptionalDefaults, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise>; getMany(params: OptionalDefaults, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise>; get(params: OptionalDefaults, rawData?: unknown, headers?: RawAxiosRequestHeaders): Promise; update(params: OptionalDefaults, rawData: AssetProps, headers?: RawAxiosRequestHeaders): Promise; delete(params: OptionalDefaults): Promise; publish(params: OptionalDefaults, rawData: AssetProps): Promise; unpublish(params: OptionalDefaults): Promise; archive(params: OptionalDefaults): Promise; unarchive(params: OptionalDefaults): Promise; create(params: OptionalDefaults, rawData: CreateAssetProps): Promise; createWithId(params: OptionalDefaults, rawData: CreateAssetProps): Promise; createFromFiles(params: OptionalDefaults, data: Omit): Promise; processForAllLocales(params: OptionalDefaults, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise; processForLocale(params: OptionalDefaults, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise; }; appUpload: AppUploadPlainClientAPI; assetKey: { create(params: OptionalDefaults, data: CreateAssetKeyProps): Promise; }; upload: UploadPlainClientAPI; locale: LocalePlainClientAPI; personalAccessToken: { get(params: OptionalDefaults<{ tokenId: string; }>): Promise; getMany(params: OptionalDefaults): Promise>; create(rawData: CreatePersonalAccessTokenProps, headers?: RawAxiosRequestHeaders): Promise; revoke(params: OptionalDefaults<{ tokenId: string; }>): Promise; }; accessToken: { get(params: OptionalDefaults<{ tokenId: string; }>): Promise; getMany(params: OptionalDefaults): Promise>; createPersonalAccessToken(rawData: CreatePATProps, headers?: RawAxiosRequestHeaders): Promise; revoke(params: OptionalDefaults<{ tokenId: string; }>): Promise; getManyForOrganization(params: OptionalDefaults): Promise>; }; usage: UsagePlainClientAPI; release: { archive(params: OptionalDefaults): Promise; get(params: OptionalDefaults): Promise; query(params: OptionalDefaults & { query?: ReleaseQueryOptions; }): Promise>; create(params: OptionalDefaults, data: ReleasePayload): Promise; update(params: OptionalDefaults, data: ReleasePayload): Promise; delete(params: OptionalDefaults): Promise; publish(params: OptionalDefaults): Promise>; unarchive(params: OptionalDefaults): Promise; unpublish(params: OptionalDefaults): Promise>; validate(params: OptionalDefaults, data?: ReleaseValidatePayload): Promise>; }; releaseAction: { get(params: OptionalDefaults & { actionId: string; }): Promise; getMany(params: OptionalDefaults & { query?: ReleaseActionQueryOptions; }): Promise>; queryForRelease(params: OptionalDefaults & { query?: ReleaseActionQueryOptions; }): Promise>; }; role: RolePlainClientAPI; scheduledActions: { get(params: OptionalDefaults & { scheduledActionId: string; environmentId: string; }): Promise; getMany(params: OptionalDefaults): Promise>; create(params: OptionalDefaults, data: CreateUpdateScheduledActionProps): Promise; delete(params: OptionalDefaults): Promise; update(params: OptionalDefaults, data: CreateUpdateScheduledActionProps): Promise; }; previewApiKey: { get(params: OptionalDefaults): Promise; getMany(params: OptionalDefaults): Promise>; }; apiKey: { get(params: OptionalDefaults): Promise; getMany(params: OptionalDefaults): Promise>; create(params: OptionalDefaults, data: CreateApiKeyProps, headers?: RawAxiosRequestHeaders): Promise; createWithId(params: OptionalDefaults, data: CreateApiKeyProps, headers?: RawAxiosRequestHeaders): Promise; update(params: OptionalDefaults, rawData: ApiKeyProps, headers?: RawAxiosRequestHeaders): Promise; delete(params: OptionalDefaults): Promise; }; appDefinition: AppDefinitionPlainClientAPI; appInstallation: AppInstallationPlainClientAPI; resourceProvider: ResourceProviderPlainClientAPI; extension: ExtensionPlainClientAPI; webhook: WebhookPlainClientAPI; snapshot: { getManyForEntry(params: OptionalDefaults): Promise, 'metadata'>>>>; getForEntry(params: OptionalDefaults): Promise, 'metadata'>>>; getManyForContentType(params: OptionalDefaults): Promise>>; getForContentType(params: OptionalDefaults): Promise>; }; tag: TagPlainClientAPI; organization: OrganizationPlainClientAPI; organizationInvitation: { get(params: OptionalDefaults<{ organizationId: string; invitationId: string; }>, headers?: RawAxiosRequestHeaders): Promise; create(params: OptionalDefaults<{ organizationId: string; }>, data: CreateOrganizationInvitationProps, headers?: RawAxiosRequestHeaders): Promise; }; organizationMembership: { get(params: OptionalDefaults): Promise; getMany(params: OptionalDefaults): Promise>; update(params: OptionalDefaults, rawData: OrganizationMembershipProps, headers?: RawAxiosRequestHeaders): Promise; delete(params: OptionalDefaults): Promise; }; spaceMember: SpaceMemberPlainClientAPI; spaceMembership: SpaceMembershipPlainClientAPI; task: TaskPlainClientAPI; team: TeamPlainClientAPI; teamMembership: TeamMembershipPlainClientAPI; teamSpaceMembership: TeamSpaceMembershipPlainClientAPI; uiConfig: UIConfigPlainClientAPI; userUIConfig: UserUIConfigPlainClientAPI; workflowDefinition: WorkflowDefinitionPlainClientAPI; workflow: WorkflowPlainClientAPI; workflowsChangelog: WorkflowsChangelogPlainClientAPI; };