import { AxiosRequestConfig } from 'axios' ; import { OpPatch } from 'json-patch' ; import { Stream } from 'stream' ; import { AppBundleProps , CreateAppBundleProps } from './entities/app-bundle' ; import { ApiKeyProps , CreateApiKeyProps } from './entities/api-key' ; import { AppDefinitionProps , CreateAppDefinitionProps } from './entities/app-definition' ; import { AppInstallationProps , CreateAppInstallationProps } from './entities/app-installation' ; import { AssetFileProp , AssetProcessingForLocale , AssetProps , CreateAssetProps , } from './entities/asset' ; import { ContentTypeProps , CreateContentTypeProps } from './entities/content-type' ; import { CreateCommentParams , CreateCommentProps , DeleteCommentParams , CommentProps , UpdateCommentParams , UpdateCommentProps , } from './entities/comment' ; import { EditorInterfaceProps } from './entities/editor-interface' ; import { CreateEntryProps , EntryProps , EntryReferenceProps } from './entities/entry' ; import { CreateEnvironmentProps , EnvironmentProps } from './entities/environment' ; import { CreateEnvironmentAliasProps , EnvironmentAliasProps } from './entities/environment-alias' ; import { CreateLocaleProps , LocaleProps } from './entities/locale' ; import { OrganizationProp } from './entities/organization' ; import { CreateOrganizationInvitationProps , OrganizationInvitationProps , } from './entities/organization-invitation' ; import { OrganizationMembershipProps } from './entities/organization-membership' ; import { CreatePersonalAccessTokenProps , PersonalAccessTokenProp , } from './entities/personal-access-token' ; import { PreviewApiKeyProps } from './entities/preview-api-key' ; import { CreateRoleProps , RoleProps } from './entities/role' ; import { ScheduledActionProps } from './entities/scheduled-action' ; import { SnapshotProps } from './entities/snapshot' ; import { SpaceProps } from './entities/space' ; import { SpaceMemberProps } from './entities/space-member' ; import { CreateSpaceMembershipProps , SpaceMembershipProps } from './entities/space-membership' ; import { CreateTagProps , DeleteTagParams , TagProps , UpdateTagProps } from './entities/tag' ; import { CreateTeamProps , TeamProps } from './entities/team' ; import { CreateTeamMembershipProps , TeamMembershipProps } from './entities/team-membership' ; import { CreateTeamSpaceMembershipProps , TeamSpaceMembershipProps , } from './entities/team-space-membership' ; import { CreateExtensionProps , ExtensionProps } from './entities/extension' ; import { UsageProps } from './entities/usage' ; import { UserProps } from './entities/user' ; import { CreateWebhooksProps , WebhookCallDetailsProps , WebhookCallOverviewProps , WebhookHealthProps , WebhookProps , } from './entities/webhook' ; import { AssetKeyProps , CreateAssetKeyProps } from './entities/asset-key' ; import { AppUploadProps } from './entities/app-upload' ; import { AppDetailsProps , CreateAppDetailsProps } from './entities/app-details' ; import { AppSignedRequestProps , CreateAppSignedRequestProps } from './entities/app-signed-request' ; import { AppSigningSecretProps , CreateAppSigningSecretProps } from './entities/app-signing-secret' ; import { BulkActionProps , BulkActionPublishPayload , BulkActionUnpublishPayload , BulkActionValidatePayload , } from './entities/bulk-action' ; import { ReleasePayload , ReleaseProps , ReleaseQueryOptions , ReleaseValidatePayload , } from './entities/release' ; import { ReleaseAction , ReleaseActionProps , ReleaseActionQueryOptions , } from './entities/release-action' ; import { CreateTaskParams , CreateTaskProps , DeleteTaskParams , TaskProps , UpdateTaskParams , UpdateTaskProps , } from './entities/task' ; import { CreateWorkflowDefinitionParams , CreateWorkflowDefinitionProps , DeleteWorkflowDefinitionParams , WorkflowDefinitionProps , WorkflowDefinitionQueryOptions , } from './entities/workflow-definition' ; export interface DefaultElements < TPlainObject extends object = object > { toPlainObject ( ) : TPlainObject ; } /**
 * Link is a reference object to another entity that can be resolved using tools such as contentful-resolve
 */ export interface Link < T extends string > { sys : { type : 'Link' ; linkType : T ; id : string ; } ; } export interface VersionedLink < T extends string > { sys : { type : 'Link' ; linkType : T ; id : string ; version : number ; } ; } export interface BaseCollection < T > { sys : { type : 'Array' ; } ; items : T [ ] ; } /** String will be in ISO8601 datetime format e.g. 2013-06-26T13:57:24Z */ export type ISO8601Timestamp = string ; export interface PaginationQueryOptions { skip ? : number ; limit ? : number ; order ? : string ; } export interface QueryOptions extends PaginationQueryOptions { content_type ? : string ; include ? : number ; select ? : string ; links_to_entry ? : string ; [ key ] : any ; } export interface BasicMetaSysProps { type : string ; id : string ; version : number ; createdBy ? : SysLink ; createdAt : string ; updatedBy ? : SysLink ; updatedAt : string ; } export interface MetaSysProps extends BasicMetaSysProps { space ? : SysLink ; status ? : SysLink ; publishedVersion ? : number ; archivedVersion ? : number ; archivedBy ? : SysLink ; archivedAt ? : string ; deletedVersion ? : number ; deletedBy ? : SysLink ; deletedAt ? : string ; } export interface EntityMetaSysProps extends MetaSysProps { space : SysLink ; contentType : SysLink ; environment : SysLink ; publishedBy ? : Link < 'User' > | Link < 'AppDefinition' > ; publishedAt ? : string ; firstPublishedAt ? : string ; publishedCounter ? : number ; locale ? : string ; } export interface MetaLinkProps { type : string ; linkType : string ; id : string ; } export interface MetadataProps { tags : Link < 'Tag' > [ ] ; } export interface SysLink { sys : MetaLinkProps ; } export interface CollectionProp < TObj > { sys : { type : 'Array' ; } ; total : number ; skip : number ; limit : number ; items : TObj [ ] ; } export interface CursorPaginatedCollectionProp < TObj > extends Omit < CollectionProp < TObj > , 'total' | 'skip' > { pages ? : BasicCursorPaginationOptions ; } export interface Collection < T , TPlain > extends CollectionProp < T > , DefaultElements < CollectionProp < TPlain > > { } export interface CursorPaginatedCollection < T , TPlain > extends CursorPaginatedCollectionProp < T > , DefaultElements < CursorPaginatedCollectionProp < TPlain > > { } export interface QueryOptions extends BasicQueryOptions { content_type ? : string ; include ? : number ; select ? : string ; } export interface BasicQueryOptions { skip ? : number ; limit ? : number ; [ key ] : any ; } export interface BasicCursorPaginationOptions { prev ? : string ; next ? : string ; } export type KeyValueMap = Record < string , any > ; private type MRInternal < UA extends boolean > = { ( opts ) : MRReturn < 'Http' , 'get' > ; ( opts ) : MRReturn < 'Http' , 'patch' > ; ( opts ) : MRReturn < 'Http' , 'post' > ; ( opts ) : MRReturn < 'Http' , 'put' > ; ( opts ) : MRReturn < 'Http' , 'delete' > ; ( opts ) : MRReturn < 'Http' , 'request' > ; ( opts ) : MRReturn < 'AppBundle' , 'get' > ; ( opts ) : MRReturn < 'AppBundle' , 'getMany' > ; ( opts ) : MRReturn < 'AppBundle' , 'delete' > ; ( opts ) : MRReturn < 'AppBundle' , 'create' > ; ( opts ) : MRReturn < 'ApiKey' , 'get' > ; ( opts ) : MRReturn < 'ApiKey' , 'getMany' > ; ( opts ) : MRReturn < 'ApiKey' , 'create' > ; ( opts ) : MRReturn < 'ApiKey' , 'createWithId' > ; ( opts ) : MRReturn < 'ApiKey' , 'update' > ; ( opts ) : MRReturn < 'ApiKey' , 'delete' > ; ( opts ) : MRReturn < 'AppDefinition' , 'get' > ; ( opts ) : MRReturn < 'AppDefinition' , 'getMany' > ; ( opts ) : MRReturn < 'AppDefinition' , 'create' > ; ( opts ) : MRReturn < 'AppDefinition' , 'update' > ; ( opts ) : MRReturn < 'AppDefinition' , 'delete' > ; ( opts ) : MRReturn < 'AppInstallation' , 'get' > ; ( opts ) : MRReturn < 'AppInstallation' , 'getMany' > ; ( opts ) : MRReturn < 'AppInstallation' , 'upsert' > ; ( opts ) : MRReturn < 'AppInstallation' , 'delete' > ; ( opts ) : MRReturn < 'Asset' , 'getMany' > ; ( opts ) : MRReturn < 'Asset' , 'get' > ; ( opts ) : MRReturn < 'Asset' , 'update' > ; ( opts ) : MRReturn < 'Asset' , 'delete' > ; ( opts ) : MRReturn < 'Asset' , 'publish' > ; ( opts ) : MRReturn < 'Asset' , 'unpublish' > ; ( opts ) : MRReturn < 'Asset' , 'archive' > ; ( opts ) : MRReturn < 'Asset' , 'unarchive' > ; ( opts ) : MRReturn < 'Asset' , 'create' > ; ( opts ) : MRReturn < 'Asset' , 'createWithId' > ; ( opts ) : MRReturn < 'Asset' , 'createFromFiles' > ; ( opts ) : MRReturn < 'Asset' , 'processForAllLocales' > ; ( opts ) : MRReturn < 'Asset' , 'processForLocale' > ; ( opts ) : MRReturn < 'AppUpload' , 'get' > ; ( opts ) : MRReturn < 'AppUpload' , 'delete' > ; ( opts ) : MRReturn < 'AppUpload' , 'create' > ; ( opts ) : MRReturn < 'AppDetails' , 'upsert' > ; ( opts ) : MRReturn < 'AppDetails' , 'get' > ; ( opts ) : MRReturn < 'AppDetails' , 'delete' > ; ( opts ) : MRReturn < 'AppSignedRequest' , 'create' > ; ( opts ) : MRReturn < 'AppSigningSecret' , 'upsert' > ; ( opts ) : MRReturn < 'AppSigningSecret' , 'get' > ; ( opts ) : MRReturn < 'AppSigningSecret' , 'delete' > ; ( opts ) : MRReturn < 'AssetKey' , 'create' > ; ( opts ) : MRReturn < 'BulkAction' , 'get' > ; ( opts ) : MRReturn < 'BulkAction' , 'publish' > ; ( opts ) : MRReturn < 'BulkAction' , 'unpublish' > ; ( opts ) : MRReturn < 'BulkAction' , 'validate' > ; ( opts ) : MRReturn < 'Comment' , 'get' > ; ( opts ) : MRReturn < 'Comment' , 'getAll' > ; ( opts ) : MRReturn < 'Comment' , 'create' > ; ( opts ) : MRReturn < 'Comment' , 'update' > ; ( opts ) : MRReturn < 'Comment' , 'delete' > ; ( opts ) : MRReturn < 'ContentType' , 'get' > ; ( opts ) : MRReturn < 'ContentType' , 'getMany' > ; ( opts ) : MRReturn < 'ContentType' , 'update' > ; ( opts ) : MRReturn < 'ContentType' , 'create' > ; ( opts ) : MRReturn < 'ContentType' , 'createWithId' > ; ( opts ) : MRReturn < 'ContentType' , 'delete' > ; ( opts ) : MRReturn < 'ContentType' , 'publish' > ; ( opts ) : MRReturn < 'ContentType' , 'unpublish' > ; ( opts ) : MRReturn < 'EditorInterface' , 'get' > ; ( opts ) : MRReturn < 'EditorInterface' , 'getMany' > ; ( opts ) : MRReturn < 'EditorInterface' , 'update' > ; ( opts ) : MRReturn < 'Environment' , 'get' > ; ( opts ) : MRReturn < 'Environment' , 'getMany' > ; ( opts ) : MRReturn < 'Environment' , 'create' > ; ( opts ) : MRReturn < 'Environment' , 'createWithId' > ; ( opts ) : MRReturn < 'Environment' , 'update' > ; ( opts ) : MRReturn < 'Environment' , 'delete' > ; ( opts ) : MRReturn < 'EnvironmentAlias' , 'get' > ; ( opts ) : MRReturn < 'EnvironmentAlias' , 'getMany' > ; ( opts ) : MRReturn < 'EnvironmentAlias' , 'createWithId' > ; ( opts ) : MRReturn < 'EnvironmentAlias' , 'update' > ; ( opts ) : MRReturn < 'EnvironmentAlias' , 'delete' > ; ( opts ) : MRReturn < 'Entry' , 'getMany' > ; ( opts ) : MRReturn < 'Entry' , 'get' > ; ( opts ) : MRReturn < 'Entry' , 'patch' > ; ( opts ) : MRReturn < 'Entry' , 'update' > ; ( opts ) : MRReturn < 'Entry' , 'delete' > ; ( opts ) : MRReturn < 'Entry' , 'publish' > ; ( opts ) : MRReturn < 'Entry' , 'unpublish' > ; ( opts ) : MRReturn < 'Entry' , 'archive' > ; ( opts ) : MRReturn < 'Entry' , 'unarchive' > ; ( opts ) : MRReturn < 'Entry' , 'create' > ; ( opts ) : MRReturn < 'Entry' , 'createWithId' > ; ( opts ) : MRReturn < 'Entry' , 'references' > ; ( opts ) : MRReturn < 'Extension' , 'get' > ; ( opts ) : MRReturn < 'Extension' , 'getMany' > ; ( opts ) : MRReturn < 'Extension' , 'create' > ; ( opts ) : MRReturn < 'Extension' , 'createWithId' > ; ( opts ) : MRReturn < 'Extension' , 'update' > ; ( opts ) : MRReturn < 'Extension' , 'delete' > ; ( opts ) : MRReturn < 'Locale' , 'get' > ; ( opts ) : MRReturn < 'Locale' , 'getMany' > ; ( opts ) : MRReturn < 'Locale' , 'delete' > ; ( opts ) : MRReturn < 'Locale' , 'update' > ; ( opts ) : MRReturn < 'Locale' , 'create' > ; ( opts ) : MRReturn < 'Organization' , 'getMany' > ; ( opts ) : MRReturn < 'Organization' , 'get' > ; ( opts ) : MRReturn < 'OrganizationInvitation' , 'get' > ; ( opts ) : MRReturn < 'OrganizationInvitation' , 'create' > ; ( opts ) : MRReturn < 'OrganizationMembership' , 'get' > ; ( opts ) : MRReturn < 'OrganizationMembership' , 'getMany' > ; ( opts ) : MRReturn < 'OrganizationMembership' , 'update' > ; ( opts ) : MRReturn < 'OrganizationMembership' , 'delete' > ; ( opts ) : MRReturn < 'PersonalAccessToken' , 'get' > ; ( opts ) : MRReturn < 'PersonalAccessToken' , 'getMany' > ; ( opts ) : MRReturn < 'PersonalAccessToken' , 'create' > ; ( opts ) : MRReturn < 'PersonalAccessToken' , 'revoke' > ; ( opts ) : MRReturn < 'PreviewApiKey' , 'get' > ; ( opts ) : MRReturn < 'PreviewApiKey' , 'getMany' > ; ( opts ) : MRReturn < 'Release' , 'get' > ; ( opts ) : MRReturn < 'Release' , 'query' > ; ( opts ) : MRReturn < 'Release' , 'create' > ; ( opts ) : MRReturn < 'Release' , 'update' > ; ( opts ) : MRReturn < 'Release' , 'delete' > ; ( opts ) : MRReturn < 'Release' , 'publish' > ; ( opts ) : MRReturn < 'Release' , 'unpublish' > ; ( opts ) : MRReturn < 'Release' , 'validate' > ; ( opts ) : MRReturn < 'ReleaseAction' , 'get' > ; ( opts ) : MRReturn < 'ReleaseAction' , 'queryForRelease' > ; ( opts ) : MRReturn < 'Role' , 'get' > ; ( opts ) : MRReturn < 'Role' , 'getMany' > ; ( opts ) : MRReturn < 'Role' , 'create' > ; ( opts ) : MRReturn < 'Role' , 'createWithId' > ; ( opts ) : MRReturn < 'Role' , 'update' > ; ( opts ) : MRReturn < 'Role' , 'delete' > ; ( opts ) : MRReturn < 'ScheduledAction' , 'get' > ; ( opts ) : MRReturn < 'ScheduledAction' , 'getMany' > ; ( opts ) : MRReturn < 'ScheduledAction' , 'create' > ; ( opts ) : MRReturn < 'ScheduledAction' , 'update' > ; ( opts ) : MRReturn < 'ScheduledAction' , 'delete' > ; ( opts ) : MRReturn < 'Snapshot' , 'getManyForEntry' > ; ( opts ) : MRReturn < 'Snapshot' , 'getForEntry' > ; ( opts ) : MRReturn < 'Snapshot' , 'getManyForContentType' > ; ( opts ) : MRReturn < 'Snapshot' , 'getForContentType' > ; ( opts ) : MRReturn < 'Space' , 'get' > ; ( opts ) : MRReturn < 'Space' , 'getMany' > ; ( opts ) : MRReturn < 'Space' , 'create' > ; ( opts ) : MRReturn < 'Space' , 'update' > ; ( opts ) : MRReturn < 'Space' , 'delete' > ; ( opts ) : MRReturn < 'SpaceMember' , 'get' > ; ( opts ) : MRReturn < 'SpaceMember' , 'getMany' > ; ( opts ) : MRReturn < 'SpaceMembership' , 'get' > ; ( opts ) : MRReturn < 'SpaceMembership' , 'getMany' > ; ( opts ) : MRReturn < 'SpaceMembership' , 'getForOrganization' > ; ( opts ) : MRReturn < 'SpaceMembership' , 'getManyForOrganization' > ; ( opts ) : MRReturn < 'SpaceMembership' , 'create' > ; ( opts ) : MRReturn < 'SpaceMembership' , 'createWithId' > ; ( opts ) : MRReturn < 'SpaceMembership' , 'update' > ; ( opts ) : MRReturn < 'SpaceMembership' , 'delete' > ; ( opts ) : MRReturn < 'Tag' , 'get' > ; ( opts ) : MRReturn < 'Tag' , 'getMany' > ; ( opts ) : MRReturn < 'Tag' , 'createWithId' > ; ( opts ) : MRReturn < 'Tag' , 'update' > ; ( opts ) : MRReturn < 'Tag' , 'delete' > ; ( opts ) : MRReturn < 'Task' , 'get' > ; ( opts ) : MRReturn < 'Task' , 'getAll' > ; ( opts ) : MRReturn < 'Task' , 'create' > ; ( opts ) : MRReturn < 'Task' , 'update' > ; ( opts ) : MRReturn < 'Task' , 'delete' > ; ( opts ) : MRReturn < 'Team' , 'get' > ; ( opts ) : MRReturn < 'Team' , 'getMany' > ; ( opts ) : MRReturn < 'Team' , 'getManyForSpace' > ; ( opts ) : MRReturn < 'Team' , 'create' > ; ( opts ) : MRReturn < 'Team' , 'update' > ; ( opts ) : MRReturn < 'Team' , 'delete' > ; ( opts ) : MRReturn < 'TeamMembership' , 'get' > ; ( opts ) : MRReturn < 'TeamMembership' , 'getManyForOrganization' > ; ( opts ) : MRReturn < 'TeamMembership' , 'getManyForTeam' > ; ( opts ) : MRReturn < 'TeamMembership' , 'create' > ; ( opts ) : MRReturn < 'TeamMembership' , 'update' > ; ( opts ) : MRReturn < 'TeamMembership' , 'delete' > ; ( opts ) : MRReturn < 'TeamSpaceMembership' , 'get' > ; ( opts ) : MRReturn < 'TeamSpaceMembership' , 'getMany' > ; ( opts ) : MRReturn < 'TeamSpaceMembership' , 'getForOrganization' > ; ( opts ) : MRReturn < 'TeamSpaceMembership' , 'getManyForOrganization' > ; ( opts ) : MRReturn < 'TeamSpaceMembership' , 'create' > ; ( opts ) : MRReturn < 'TeamSpaceMembership' , 'update' > ; ( opts ) : MRReturn < 'TeamSpaceMembership' , 'delete' > ; ( opts ) : MRReturn < 'Entry' , 'get' > ; ( opts ) : MRReturn < 'Entry' , 'create' > ; ( opts ) : MRReturn < 'Entry' , 'delete' > ; ( opts ) : MRReturn < 'Usage' , 'getManyForSpace' > ; ( opts ) : MRReturn < 'Usage' , 'getManyForOrganization' > ; ( opts ) : MRReturn < 'User' , 'getManyForSpace' > ; ( opts ) : MRReturn < 'User' , 'getForSpace' > ; ( opts ) : MRReturn < 'User' , 'getCurrent' > ; ( opts ) : MRReturn < 'User' , 'getForOrganization' > ; ( opts ) : MRReturn < 'User' , 'getManyForOrganization' > ; ( opts ) : MRReturn < 'Webhook' , 'get' > ; ( opts ) : MRReturn < 'Webhook' , 'getMany' > ; ( opts ) : MRReturn < 'Webhook' , 'getCallDetails' > ; ( opts ) : MRReturn < 'Webhook' , 'getHealthStatus' > ; ( opts ) : MRReturn < 'Webhook' , 'getManyCallDetails' > ; ( opts ) : MRReturn < 'Webhook' , 'create' > ; ( opts ) : MRReturn < 'Webhook' , 'createWithId' > ; ( opts ) : MRReturn < 'Webhook' , 'update' > ; ( opts ) : MRReturn < 'Webhook' , 'delete' > ; ( opts ) : MRReturn < 'WorkflowDefinition' , 'get' > ; ( opts ) : MRReturn < 'WorkflowDefinition' , 'getMany' > ; ( opts ) : MRReturn < 'WorkflowDefinition' , 'create' > ; ( opts ) : MRReturn < 'WorkflowDefinition' , 'update' > ; ( opts ) : MRReturn < 'WorkflowDefinition' , 'delete' > ; } ; private export type MakeRequestWithUserAgent = MRInternal < true > ; private export type MakeRequest = MRInternal < false > ; export interface Adapter { makeRequest : MakeRequestWithUserAgent ; } private export type MRActions = { Http : { get : { params : { url : string ; config ? : AxiosRequestConfig ; } ; return : any ; } ; patch : { params : { url : string ; config ? : AxiosRequestConfig ; } ; payload : any ; return : any ; } ; post : { params : { url : string ; config ? : AxiosRequestConfig ; } ; payload : any ; return : any ; } ; put : { params : { url : string ; config ? : AxiosRequestConfig ; } ; payload : any ; return : any ; } ; delete : { params : { url : string ; config ? : AxiosRequestConfig ; } ; return : any ; } ; request : { params : { url : string ; config ? : AxiosRequestConfig ; } ; return : any ; } ; } ; AppBundle : { get : { params : GetAppBundleParams ; return : AppBundleProps ; } ; getMany : { params : GetAppDefinitionParams & QueryParams ; return : CollectionProp < AppBundleProps > ; } ; delete : { params : GetAppBundleParams ; return : void ; } ; create : { params : GetAppDefinitionParams ; payload : CreateAppBundleProps ; return : AppBundleProps ; } ; } ; ApiKey : { get : { params : GetSpaceParams & { apiKeyId : string ; } ; return : ApiKeyProps ; } ; getMany : { params : GetSpaceParams & QueryParams ; return : CollectionProp < ApiKeyProps > ; } ; create : { params : GetSpaceParams ; payload : CreateApiKeyProps ; headers ? : Record < string , unknown > ; return : ApiKeyProps ; } ; createWithId : { params : GetSpaceParams & { apiKeyId : string ; } ; payload : CreateApiKeyProps ; headers ? : Record < string , unknown > ; return : ApiKeyProps ; } ; update : { params : GetSpaceParams & { apiKeyId : string ; } ; payload : ApiKeyProps ; headers ? : Record < string , unknown > ; return : ApiKeyProps ; } ; delete : { params : GetSpaceParams & { apiKeyId : string ; } ; return : any ; } ; } ; AppDefinition : { get : { params : GetOrganizationParams & { appDefinitionId : string ; } ; return : AppDefinitionProps ; } ; getMany : { params : GetOrganizationParams & QueryParams ; return : CollectionProp < AppDefinitionProps > ; } ; create : { params : GetOrganizationParams ; payload : CreateAppDefinitionProps ; return : AppDefinitionProps ; } ; update : { params : GetAppDefinitionParams ; payload : AppDefinitionProps ; headers ? : Record < string , unknown > ; return : AppDefinitionProps ; } ; delete : { params : GetAppDefinitionParams ; return : any ; } ; } ; AppInstallation : { get : { params : GetAppInstallationParams ; return : AppInstallationProps ; } ; getMany : { params : GetSpaceEnvironmentParams & PaginationQueryParams ; return : CollectionProp < AppInstallationProps > ; } ; upsert : { params : GetAppInstallationParams ; payload : CreateAppInstallationProps ; headers ? : Record < string , unknown > ; return : AppInstallationProps ; } ; delete : { params : GetAppInstallationParams ; return : any ; } ; } ; AppUpload : { get : { params : GetAppUploadParams ; return : AppUploadProps ; } ; delete : { params : GetAppUploadParams ; return : void ; } ; create : { params : GetOrganizationParams ; payload : { file : string | ArrayBuffer | Stream ; } ; return : AppUploadProps ; } ; } ; AppDetails : { upsert : { params : GetAppDefinitionParams ; payload : CreateAppDetailsProps ; return : AppDetailsProps ; } ; get : { params : GetAppDefinitionParams ; return : AppDetailsProps ; } ; delete : { params : GetAppDefinitionParams ; return : void ; } ; } ; AppSignedRequest : { create : { params : GetAppInstallationParams ; payload : CreateAppSignedRequestProps ; return : AppSignedRequestProps ; } ; } ; AppSigningSecret : { upsert : { params : GetAppDefinitionParams ; payload : CreateAppSigningSecretProps ; return : AppSigningSecretProps ; } ; get : { params : GetAppDefinitionParams ; return : AppSigningSecretProps ; } ; delete : { params : GetAppDefinitionParams ; return : void ; } ; } ; Asset : { getMany : { params : GetSpaceEnvironmentParams & QueryParams ; return : CollectionProp < AssetProps > ; } ; get : { params : GetSpaceEnvironmentParams & { assetId : string ; } & QueryParams ; return : AssetProps ; } ; update : { params : GetSpaceEnvironmentParams & { assetId : string ; } ; payload : AssetProps ; headers ? : Record < string , unknown > ; return : AssetProps ; } ; delete : { params : GetSpaceEnvironmentParams & { assetId : string ; } ; return : any ; } ; publish : { params : GetSpaceEnvironmentParams & { assetId : string ; } ; payload : AssetProps ; return : AssetProps ; } ; unpublish : { params : GetSpaceEnvironmentParams & { assetId : string ; } ; return : AssetProps ; } ; archive : { params : GetSpaceEnvironmentParams & { assetId : string ; } ; return : AssetProps ; } ; unarchive : { params : GetSpaceEnvironmentParams & { assetId : string ; } ; return : AssetProps ; } ; create : { params : GetSpaceEnvironmentParams ; payload : CreateAssetProps ; return : AssetProps ; } ; createWithId : { params : GetSpaceEnvironmentParams & { assetId : string ; } ; payload : CreateAssetProps ; return : AssetProps ; } ; createFromFiles : { params : GetSpaceEnvironmentParams ; payload : Omit < AssetFileProp , 'sys' > ; return : AssetProps ; } ; processForAllLocales : { params : GetSpaceEnvironmentParams & { asset : AssetProps ; options ? : AssetProcessingForLocale ; } ; return : AssetProps ; } ; processForLocale : { params : GetSpaceEnvironmentParams & { asset : AssetProps ; locale : string ; options ? : AssetProcessingForLocale ; } ; return : AssetProps ; } ; } ; AssetKey : { create : { params : GetSpaceEnvironmentParams ; payload : CreateAssetKeyProps ; return : AssetKeyProps ; } ; } ; BulkAction : { get : { params : GetBulkActionParams ; return : BulkActionProps ; } ; publish : { params : GetSpaceEnvironmentParams ; payload : BulkActionPublishPayload ; return : BulkActionProps < BulkActionPublishPayload > ; } ; unpublish : { params : GetSpaceEnvironmentParams ; payload : BulkActionUnpublishPayload ; return : BulkActionProps < BulkActionUnpublishPayload > ; } ; validate : { params : GetSpaceEnvironmentParams ; payload : BulkActionValidatePayload ; return : BulkActionProps < BulkActionValidatePayload > ; } ; } ; Comment : { get : { params : GetCommentParams ; return : CommentProps ; } ; getAll : { params : GetEntryParams ; return : CollectionProp < CommentProps > ; } ; create : { params : CreateCommentParams ; payload : CreateCommentProps ; return : CommentProps ; } ; update : { params : UpdateCommentParams ; payload : UpdateCommentProps ; headers ? : Record < string , unknown > ; return : CommentProps ; } ; delete : { params : DeleteCommentParams ; return : void ; } ; } ; ContentType : { get : { params : GetContentTypeParams & QueryParams ; return : ContentTypeProps ; } ; getMany : { params : GetSpaceEnvironmentParams & QueryParams ; return : CollectionProp < ContentTypeProps > ; } ; create : { params : GetSpaceEnvironmentParams ; payload : CreateContentTypeProps ; return : ContentTypeProps ; } ; createWithId : { params : GetContentTypeParams ; payload : CreateContentTypeProps ; return : ContentTypeProps ; } ; update : { params : GetContentTypeParams ; payload : ContentTypeProps ; headers ? : Record < string , unknown > ; return : ContentTypeProps ; } ; delete : { params : GetContentTypeParams ; return : any ; } ; publish : { params : GetContentTypeParams ; payload : ContentTypeProps ; return : ContentTypeProps ; } ; unpublish : { params : GetContentTypeParams ; return : ContentTypeProps ; } ; } ; EditorInterface : { get : { params : GetEditorInterfaceParams ; return : EditorInterfaceProps ; } ; getMany : { params : GetSpaceEnvironmentParams & QueryParams ; return : CollectionProp < EditorInterfaceProps > ; } ; update : { params : GetEditorInterfaceParams ; payload : EditorInterfaceProps ; headers ? : Record < string , unknown > ; return : EditorInterfaceProps ; } ; } ; Environment : { get : { params : GetSpaceEnvironmentParams ; return : EnvironmentProps ; } ; getMany : { params : GetSpaceParams & PaginationQueryParams ; return : CollectionProp < EnvironmentProps > ; } ; create : { params : GetSpaceParams ; payload : Partial < Pick < EnvironmentProps , 'name' > > ; headers ? : Record < string , unknown > ; return : EnvironmentProps ; } ; createWithId : { params : GetSpaceEnvironmentParams & { sourceEnvironmentId ? : string ; } ; payload : CreateEnvironmentProps ; headers ? : Record < string , unknown > ; return : EnvironmentProps ; } ; update : { params : GetSpaceEnvironmentParams ; payload : EnvironmentProps ; headers ? : Record < string , unknown > ; return : EnvironmentProps ; } ; delete : { params : GetSpaceEnvironmentParams ; return : any ; } ; } ; EnvironmentAlias : { get : { params : GetSpaceEnvAliasParams ; return : EnvironmentAliasProps ; } ; getMany : { params : GetSpaceParams & PaginationQueryParams ; return : CollectionProp < EnvironmentAliasProps > ; } ; createWithId : { params : GetSpaceEnvAliasParams ; payload : CreateEnvironmentAliasProps ; headers ? : Record < string , unknown > ; return : EnvironmentAliasProps ; } ; update : { params : GetSpaceEnvAliasParams ; payload : EnvironmentAliasProps ; headers ? : Record < string , unknown > ; return : EnvironmentAliasProps ; } ; delete : { params : GetSpaceEnvAliasParams ; return : any ; } ; } ; Entry : { getMany : { params : GetSpaceEnvironmentParams & QueryParams ; return : CollectionProp < EntryProps < any > > ; } ; get : { params : GetSpaceEnvironmentParams & { entryId : string ; } & QueryParams ; return : EntryProps < any > ; } ; patch : { params : GetSpaceEnvironmentParams & { entryId : string ; version : number ; } ; payload : OpPatch [ ] ; headers ? : Record < string , unknown > ; return : EntryProps < any > ; } ; update : { params : GetSpaceEnvironmentParams & { entryId : string ; } ; payload : EntryProps < any > ; headers ? : Record < string , unknown > ; return : EntryProps < any > ; } ; delete : { params : GetSpaceEnvironmentParams & { entryId : string ; } ; return : any ; } ; publish : { params : GetSpaceEnvironmentParams & { entryId : string ; } ; payload : EntryProps < any > ; return : EntryProps < any > ; } ; unpublish : { params : GetSpaceEnvironmentParams & { entryId : string ; } ; return : EntryProps < any > ; } ; archive : { params : GetSpaceEnvironmentParams & { entryId : string ; } ; return : EntryProps < any > ; } ; unarchive : { params : GetSpaceEnvironmentParams & { entryId : string ; } ; return : EntryProps < any > ; } ; create : { params : GetSpaceEnvironmentParams & { contentTypeId : string ; } ; payload : CreateEntryProps < any > ; return : EntryProps < any > ; } ; createWithId : { params : GetSpaceEnvironmentParams & { entryId : string ; contentTypeId : string ; } ; payload : CreateEntryProps < any > ; return : EntryProps < any > ; } ; references : { params : GetSpaceEnvironmentParams & { entryId : string ; deprecated maxDepth ? : number ; include ? : number ; } ; return : EntryReferenceProps ; } ; } ; Extension : { get : { params : GetExtensionParams & QueryParams ; return : ExtensionProps ; } ; getMany : { params : GetSpaceEnvironmentParams & QueryParams ; return : CollectionProp < ExtensionProps > ; } ; create : { params : GetSpaceEnvironmentParams ; payload : CreateExtensionProps ; headers ? : Record < string , unknown > ; return : ExtensionProps ; } ; createWithId : { params : GetExtensionParams ; payload : CreateExtensionProps ; headers ? : Record < string , unknown > ; return : ExtensionProps ; } ; update : { params : GetExtensionParams ; payload : ExtensionProps ; headers ? : Record < string , unknown > ; return : ExtensionProps ; } ; delete : { params : GetExtensionParams ; return : any ; } ; } ; Locale : { get : { params : GetSpaceEnvironmentParams & { localeId : string ; } ; return : LocaleProps ; } ; getMany : { params : GetSpaceEnvironmentParams & QueryParams ; return : CollectionProp < LocaleProps > ; } ; delete : { params : GetSpaceEnvironmentParams & { localeId : string ; } ; return : any ; } ; update : { params : GetSpaceEnvironmentParams & { localeId : string ; } ; payload : LocaleProps ; headers ? : Record < string , unknown > ; return : LocaleProps ; } ; create : { params : GetSpaceEnvironmentParams ; payload : CreateLocaleProps ; headers ? : Record < string , unknown > ; return : LocaleProps ; } ; } ; Organization : { getMany : { params : PaginationQueryParams ; return : CollectionProp < OrganizationProp > ; } ; get : { params : GetOrganizationParams ; return : OrganizationProp ; } ; } ; OrganizationInvitation : { get : { params : { organizationId : string ; invitationId : string ; } ; headers ? : Record < string , unknown > ; return : OrganizationInvitationProps ; } ; create : { params : { organizationId : string ; } ; payload : CreateOrganizationInvitationProps ; headers ? : Record < string , unknown > ; return : OrganizationInvitationProps ; } ; } ; OrganizationMembership : { get : { params : GetOrganizationMembershipProps ; return : OrganizationMembershipProps ; } ; getMany : { params : GetOrganizationParams & QueryParams ; return : CollectionProp < OrganizationMembershipProps > ; } ; update : { params : GetOrganizationMembershipProps ; payload : OrganizationMembershipProps ; headers ? : Record < string , unknown > ; return : OrganizationMembershipProps ; } ; delete : { params : GetOrganizationMembershipProps ; return : any ; } ; } ; PersonalAccessToken : { get : { params : { tokenId : string ; } ; return : PersonalAccessTokenProp ; } ; getMany : { params : QueryParams ; return : CollectionProp < PersonalAccessTokenProp > ; } ; create : { params : { } ; payload : CreatePersonalAccessTokenProps ; headers ? : Record < string , unknown > ; return : PersonalAccessTokenProp ; } ; revoke : { params : { tokenId : string ; } ; return : PersonalAccessTokenProp ; } ; } ; PreviewApiKey : { get : { params : GetSpaceParams & { previewApiKeyId : string ; } ; return : PreviewApiKeyProps ; } ; getMany : { params : GetSpaceParams & QueryParams ; return : CollectionProp < PreviewApiKeyProps > ; } ; } ; Release : { get : { params : GetReleaseParams ; return : ReleaseProps ; } ; query : { params : GetSpaceEnvironmentParams & { query ? : ReleaseQueryOptions ; } ; return : CollectionProp < ReleaseProps > ; } ; create : { params : GetSpaceEnvironmentParams ; payload : ReleasePayload ; return : ReleaseProps ; } ; update : { params : GetReleaseParams & { version : number ; } ; payload : ReleasePayload ; return : ReleaseProps ; } ; delete : { params : GetReleaseParams ; return : void ; } ; publish : { params : GetReleaseParams & { version : number ; } ; return : ReleaseActionProps < 'publish' > ; } ; unpublish : { params : GetReleaseParams & { version : number ; } ; return : ReleaseActionProps < 'unpublish' > ; } ; validate : { params : GetReleaseParams ; payload ? : ReleaseValidatePayload ; return : ReleaseActionProps < 'validate' > ; } ; } ; ReleaseAction : { get : { params : GetReleaseParams & { actionId : string ; } ; return : ReleaseAction ; } ; queryForRelease : { params : GetReleaseParams & { query ? : ReleaseActionQueryOptions ; } ; return : Collection < ReleaseAction , ReleaseActionProps > ; } ; } ; Role : { get : { params : GetSpaceParams & { roleId : string ; } ; return : RoleProps ; } ; getMany : { params : GetSpaceParams & QueryParams ; return : CollectionProp < RoleProps > ; } ; create : { params : GetSpaceParams ; payload : CreateRoleProps ; headers ? : Record < string , unknown > ; return : RoleProps ; } ; createWithId : { params : GetSpaceParams & { roleId : string ; } ; payload : CreateRoleProps ; headers ? : Record < string , unknown > ; return : RoleProps ; } ; update : { params : GetSpaceParams & { roleId : string ; } ; payload : RoleProps ; headers ? : Record < string , unknown > ; return : RoleProps ; } ; delete : { params : GetSpaceParams & { roleId : string ; } ; return : any ; } ; } ; ScheduledAction : { get : { params : GetSpaceParams & { scheduledActionId : string ; environmentId : string ; } ; return : ScheduledActionProps ; } ; getMany : { params : GetSpaceParams & QueryParams ; return : CollectionProp < ScheduledActionProps > ; } ; create : { params : GetSpaceParams ; payload : Omit < ScheduledActionProps , 'sys' > ; return : ScheduledActionProps ; } ; update : { params : GetSpaceParams & { scheduledActionId : string ; version : number ; } ; payload : Omit < ScheduledActionProps , 'sys' > ; return : ScheduledActionProps ; } ; delete : { params : GetSpaceEnvironmentParams & { scheduledActionId : string ; } ; return : any ; } ; } ; Snapshot : { getManyForEntry : { params : GetSnapshotForEntryParams & QueryParams ; return : CollectionProp < SnapshotProps < EntryProps < any > > > ; } ; getForEntry : { params : GetSnapshotForEntryParams & { snapshotId : string ; } ; return : SnapshotProps < EntryProps < any > > ; } ; getManyForContentType : { params : GetSnapshotForContentTypeParams & QueryParams ; return : CollectionProp < SnapshotProps < ContentTypeProps > > ; } ; getForContentType : { params : GetSnapshotForContentTypeParams & { snapshotId : string ; } ; return : SnapshotProps < ContentTypeProps > ; } ; } ; Space : { get : { params : GetSpaceParams ; return : SpaceProps ; } ; getMany : { params : QueryParams ; return : CollectionProp < SpaceProps > ; } ; create : { params : { organizationId ? : string ; } ; payload : Omit < SpaceProps , 'sys' > ; headers ? : Record < string , unknown > ; return : any ; } ; update : { params : GetSpaceParams ; payload : SpaceProps ; headers ? : Record < string , unknown > ; return : SpaceProps ; } ; delete : { params : GetSpaceParams ; return : void ; } ; } ; SpaceMember : { get : { params : GetSpaceParams & { spaceMemberId : string ; } ; return : SpaceMemberProps ; } ; getMany : { params : GetSpaceParams & QueryParams ; return : CollectionProp < SpaceMemberProps > ; } ; } ; SpaceMembership : { get : { params : GetSpaceMembershipProps ; return : SpaceMembershipProps ; } ; getMany : { params : GetSpaceParams & QueryParams ; return : CollectionProp < SpaceMembershipProps > ; } ; getForOrganization : { params : GetOrganizationParams & { spaceMembershipId : string ; } ; return : SpaceMembershipProps ; } ; getManyForOrganization : { params : GetOrganizationParams & QueryParams ; return : CollectionProp < SpaceMembershipProps > ; } ; create : { params : GetSpaceParams ; payload : CreateSpaceMembershipProps ; headers ? : Record < string , unknown > ; return : SpaceMembershipProps ; } ; createWithId : { params : GetSpaceMembershipProps ; payload : CreateSpaceMembershipProps ; headers ? : Record < string , unknown > ; return : SpaceMembershipProps ; } ; update : { params : GetSpaceMembershipProps ; payload : SpaceMembershipProps ; headers ? : Record < string , unknown > ; return : SpaceMembershipProps ; } ; delete : { params : GetSpaceMembershipProps ; return : any ; } ; } ; Tag : { get : { params : GetTagParams ; return : TagProps ; } ; getMany : { params : GetSpaceEnvironmentParams & QueryParams ; return : CollectionProp < TagProps > ; } ; createWithId : { params : GetTagParams ; payload : CreateTagProps ; return : TagProps ; } ; update : { params : GetTagParams ; payload : UpdateTagProps ; headers ? : Record < string , unknown > ; return : TagProps ; } ; delete : { params : DeleteTagParams ; return : any ; } ; } ; Task : { get : { params : GetTaskParams ; return : TaskProps ; } ; getAll : { params : GetEntryParams ; return : CollectionProp < TaskProps > ; } ; create : { params : CreateTaskParams ; payload : CreateTaskProps ; return : TaskProps ; } ; update : { params : UpdateTaskParams ; payload : UpdateTaskProps ; headers ? : Record < string , unknown > ; return : TaskProps ; } ; delete : { params : DeleteTaskParams ; return : void ; } ; } ; Team : { get : { params : GetTeamParams ; return : TeamProps ; } ; getMany : { params : GetOrganizationParams & QueryParams ; return : CollectionProp < TeamProps > ; } ; getManyForSpace : { params : GetSpaceParams & QueryParams ; return : CollectionProp < TeamProps > ; } ; create : { params : GetOrganizationParams ; payload : CreateTeamProps ; headers ? : Record < string , unknown > ; return : any ; } ; update : { params : GetTeamParams ; payload : TeamProps ; headers ? : Record < string , unknown > ; return : TeamProps ; } ; delete : { params : GetTeamParams ; return : any ; } ; } ; TeamMembership : { get : { params : GetTeamMembershipParams ; return : TeamMembershipProps ; } ; getManyForOrganization : { params : GetOrganizationParams & QueryParams ; return : CollectionProp < TeamMembershipProps > ; } ; getManyForTeam : { params : GetTeamParams & QueryParams ; return : CollectionProp < TeamMembershipProps > ; } ; create : { params : GetTeamParams ; payload : CreateTeamMembershipProps ; headers ? : Record < string , unknown > ; return : TeamMembershipProps ; } ; update : { params : GetTeamMembershipParams ; payload : TeamMembershipProps ; headers ? : Record < string , unknown > ; return : TeamMembershipProps ; } ; delete : { params : GetTeamMembershipParams ; return : any ; } ; } ; TeamSpaceMembership : { get : { params : GetTeamSpaceMembershipParams ; return : TeamSpaceMembershipProps ; } ; getMany : { params : GetSpaceParams & QueryParams ; return : CollectionProp < TeamSpaceMembershipProps > ; } ; getForOrganization : { params : GetOrganizationParams & { teamSpaceMembershipId : string ; } ; return : TeamSpaceMembershipProps ; } ; getManyForOrganization : { params : GetOrganizationParams & QueryParams & { teamId ? : string ; } ; return : CollectionProp < TeamSpaceMembershipProps > ; } ; create : { params : GetSpaceParams & { teamId : string ; } ; payload : CreateTeamSpaceMembershipProps ; headers ? : Record < string , unknown > ; return : TeamSpaceMembershipProps ; } ; update : { params : GetTeamSpaceMembershipParams ; payload : TeamSpaceMembershipProps ; headers ? : Record < string , unknown > ; return : TeamSpaceMembershipProps ; } ; delete : { params : GetTeamSpaceMembershipParams ; return : any ; } ; } ; Upload : { get : { params : GetSpaceParams & { uploadId : string ; } ; return : any ; } ; create : { params : GetSpaceParams ; payload : { file : string | ArrayBuffer | Stream ; } ; return : any ; } ; delete : { params : GetSpaceParams & { uploadId : string ; } ; return : any ; } ; } ; Usage : { getManyForSpace : { params : { organizationId : string ; } & QueryParams ; return : CollectionProp < UsageProps > ; } ; getManyForOrganization : { params : { organizationId : string ; } & QueryParams ; return : CollectionProp < UsageProps > ; } ; } ; User : { getManyForSpace : { params : GetSpaceParams & QueryParams ; return : CollectionProp < UserProps > ; } ; getForSpace : { params : GetSpaceParams & { userId : string ; } ; return : UserProps ; } ; getCurrent : { params ? : QueryParams ; return : any ; } ; getForOrganization : { params : GetOrganizationParams & { userId : string ; } ; return : UserProps ; } ; getManyForOrganization : { params : GetOrganizationParams & QueryParams ; return : CollectionProp < UserProps > ; } ; } ; Webhook : { get : { params : GetWebhookParams ; return : WebhookProps ; } ; getMany : { params : GetSpaceParams & QueryParams ; return : CollectionProp < WebhookProps > ; } ; getCallDetails : { params : GetWebhookCallDetailsUrl ; return : WebhookCallDetailsProps ; } ; getHealthStatus : { params : GetWebhookParams ; return : WebhookHealthProps ; } ; getManyCallDetails : { params : GetWebhookParams & QueryParams ; return : CollectionProp < WebhookCallOverviewProps > ; } ; create : { params : GetSpaceParams ; payload : CreateWebhooksProps ; headers ? : Record < string , unknown > ; return : WebhookProps ; } ; createWithId : { params : GetWebhookParams ; payload : CreateWebhooksProps ; headers ? : Record < string , unknown > ; return : WebhookProps ; } ; update : { params : GetWebhookParams ; payload : WebhookProps ; return : WebhookProps ; } ; delete : { params : GetWebhookParams ; return : void ; } ; } ; WorkflowDefinition : { get : { params : GetWorkflowDefinitionParams ; headers ? : Record < string , unknown > ; return : WorkflowDefinitionProps ; } ; getMany : { params : GetSpaceEnvironmentParams & { query ? : WorkflowDefinitionQueryOptions ; } ; headers ? : Record < string , unknown > ; return : CollectionProp < WorkflowDefinitionProps > ; } ; create : { params : CreateWorkflowDefinitionParams ; payload : CreateWorkflowDefinitionProps ; headers ? : Record < string , unknown > ; return : WorkflowDefinitionProps ; } ; update : { params : GetWorkflowDefinitionParams ; payload : WorkflowDefinitionProps ; headers ? : Record < string , unknown > ; return : WorkflowDefinitionProps ; } ; delete : { params : DeleteWorkflowDefinitionParams ; headers ? : Record < string , unknown > ; return : void ; } ; } ; } ; private export type MROpts < ET extends keyof MRActions , Action extends keyof MRActions [ ET ] , UA extends boolean = false > = { entityType : ET ; action : Action ; } & ( UA extends true ? { userAgent : string ; } : { } ) & ( 'params' extends keyof MRActions [ ET ] [ Action ] ? undefined extends MRActions [ ET ] [ Action ] [ 'params' ] ? { params ? : MRActions [ ET ] [ Action ] [ 'params' ] ; } : { params : MRActions [ ET ] [ Action ] [ 'params' ] ; } : { } ) & ( 'payload' extends keyof MRActions [ ET ] [ Action ] ? undefined extends MRActions [ ET ] [ Action ] [ 'payload' ] ? { payload ? : MRActions [ ET ] [ Action ] [ 'payload' ] ; } : { payload : MRActions [ ET ] [ Action ] [ 'payload' ] ; } : { } ) & ( 'headers' extends keyof MRActions [ ET ] [ Action ] ? undefined extends MRActions [ ET ] [ Action ] [ 'headers' ] ? { headers ? : MRActions [ ET ] [ Action ] [ 'headers' ] ; } : { headers : MRActions [ ET ] [ Action ] [ 'headers' ] ; } : { } ) ; private export type MRReturn < ET extends keyof MRActions , Action extends keyof MRActions [ ET ] > = 'return' extends keyof MRActions [ ET ] [ Action ] ? Promise < MRActions [ ET ] [ Action ] [ 'return' ] > : never ; /** Base interface for all Payload interfaces. Used as part of the MakeRequestOptions to simplify payload definitions. */ export interface MakeRequestPayload { } export interface MakeRequestOptions { entityType : keyof MRActions ; action : string ; params ? : Record < string , unknown > ; payload ? : Record < string , unknown > | OpPatch [ ] | MakeRequestPayload ; headers ? : Record < string , unknown > ; userAgent : string ; } export type GetAppBundleParams = GetAppDefinitionParams & { appBundleId : string ; } ; export type GetAppDefinitionParams = GetOrganizationParams & { appDefinitionId : string ; } ; export type GetAppInstallationParams = GetSpaceEnvironmentParams & { appDefinitionId : string ; } ; export type GetBulkActionParams = GetSpaceEnvironmentParams & { bulkActionId : string ; } ; export type GetCommentParams = GetEntryParams & { commentId : string ; } ; export type GetContentTypeParams = GetSpaceEnvironmentParams & { contentTypeId : string ; } ; export type GetEditorInterfaceParams = GetSpaceEnvironmentParams & { contentTypeId : string ; } ; export type GetEntryParams = GetSpaceEnvironmentParams & { entryId : string ; } ; export type GetExtensionParams = GetSpaceEnvironmentParams & { extensionId : string ; } ; export type GetOrganizationParams = { organizationId : string ; } ; export type GetReleaseParams = GetSpaceEnvironmentParams & { releaseId : string ; } ; export type GetSnapshotForContentTypeParams = GetSpaceEnvironmentParams & { contentTypeId : string ; } ; export type GetSnapshotForEntryParams = GetSpaceEnvironmentParams & { entryId : string ; } ; export type GetSpaceEnvAliasParams = GetSpaceParams & { environmentAliasId : string ; } ; export type GetSpaceEnvironmentParams = { spaceId : string ; environmentId : string ; } ; export type GetSpaceMembershipProps = GetSpaceParams & { spaceMembershipId : string ; } ; export type GetSpaceParams = { spaceId : string ; } ; export type GetTagParams = GetSpaceEnvironmentParams & { tagId : string ; } ; export type GetTaskParams = GetEntryParams & { taskId : string ; } ; export type GetTeamMembershipParams = GetTeamParams & { teamMembershipId : string ; } ; export type GetTeamParams = { organizationId : string ; teamId : string ; } ; export type GetTeamSpaceMembershipParams = GetSpaceParams & { teamSpaceMembershipId : string ; } ; export type GetWebhookCallDetailsUrl = GetWebhookParams & { callId : string ; } ; export type GetWebhookParams = GetSpaceParams & { webhookDefinitionId : string ; } ; export type GetOrganizationMembershipProps = GetOrganizationParams & { organizationMembershipId : string ; } ; export type GetAppUploadParams = GetOrganizationParams & { appUploadId : string ; } ; export type GetWorkflowDefinitionParams = GetSpaceEnvironmentParams & { workflowDefinitionId : string ; } ; export type QueryParams = { query ? : QueryOptions ; } ; export type PaginationQueryParams = { query ? : PaginationQueryOptions ; } ;