contentful-management
Version:
Client for Contentful's Content Management API
1,021 lines • 92.5 kB
TypeScript
import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios';
import type { OpPatch } from 'json-patch';
import type { Stream } from 'stream';
import type { AppActionProps, CreateAppActionProps } from './entities/app-action';
import type { AppActionCallProps, AppActionCallResponse, CreateAppActionCallProps } from './entities/app-action-call';
import type { AppBundleProps, CreateAppBundleProps } from './entities/app-bundle';
import type { ApiKeyProps, CreateApiKeyProps } from './entities/api-key';
import type { AppDefinitionProps, CreateAppDefinitionProps } from './entities/app-definition';
import type { AppInstallationProps, CreateAppInstallationProps } from './entities/app-installation';
import type { AssetFileProp, AssetProcessingForLocale, AssetProps, CreateAssetProps } from './entities/asset';
import type { ContentTypeProps, CreateContentTypeProps } from './entities/content-type';
import type { CommentProps, CreateCommentParams, CreateCommentProps, DeleteCommentParams, GetCommentParentEntityParams, GetManyCommentsParams, PlainTextBodyFormat, RichTextBodyFormat, RichTextCommentBodyPayload, RichTextCommentProps, UpdateCommentParams, UpdateCommentProps } from './entities/comment';
import type { EditorInterfaceProps } from './entities/editor-interface';
import type { CreateEntryProps, EntryProps, EntryReferenceProps } from './entities/entry';
import type { CreateEnvironmentProps, EnvironmentProps } from './entities/environment';
import type { CreateEnvironmentAliasProps, EnvironmentAliasProps } from './entities/environment-alias';
import type { CreateLocaleProps, LocaleProps } from './entities/locale';
import type { AppInstallationsForOrganizationProps } from './entities/app-definition';
import type { OrganizationProps } from './entities/organization';
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 { CreateRoleProps, RoleProps } from './entities/role';
import type { ScheduledActionProps } from './entities/scheduled-action';
import type { SnapshotProps } from './entities/snapshot';
import type { SpaceProps } from './entities/space';
import type { SpaceMemberProps } from './entities/space-member';
import type { CreateSpaceMembershipProps, SpaceMembershipProps } from './entities/space-membership';
import type { CreateTagProps, DeleteTagParams, TagProps, UpdateTagProps } from './entities/tag';
import type { CreateTeamProps, TeamProps } from './entities/team';
import type { CreateTeamMembershipProps, TeamMembershipProps } from './entities/team-membership';
import type { CreateTeamSpaceMembershipProps, TeamSpaceMembershipProps } from './entities/team-space-membership';
import type { CreateExtensionProps, ExtensionProps } from './entities/extension';
import type { UsageProps } from './entities/usage';
import type { UserProps } from './entities/user';
import type { CreateWebhooksProps, UpsertWebhookSigningSecretPayload, WebhookCallDetailsProps, WebhookCallOverviewProps, WebhookHealthProps, WebhookProps, WebhookRetryPolicyPayload, WebhookRetryPolicyProps, WebhookSigningSecretProps } from './entities/webhook';
import type { AssetKeyProps, CreateAssetKeyProps } from './entities/asset-key';
import type { AppUploadProps } from './entities/app-upload';
import type { AppDetailsProps, CreateAppDetailsProps } from './entities/app-details';
import type { AppSignedRequestProps, CreateAppSignedRequestProps } from './entities/app-signed-request';
import type { AppSigningSecretProps, CreateAppSigningSecretProps } from './entities/app-signing-secret';
import type { BulkActionProps, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from './entities/bulk-action';
import type { ReleasePayload, ReleaseProps, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
import type { ReleaseAction, ReleaseActionProps, ReleaseActionQueryOptions } from './entities/release-action';
import type { CreateTaskParams, CreateTaskProps, DeleteTaskParams, TaskProps, UpdateTaskParams, UpdateTaskProps } from './entities/task';
import type { CreateWorkflowDefinitionParams, CreateWorkflowDefinitionProps, DeleteWorkflowDefinitionParams, WorkflowDefinitionProps, WorkflowDefinitionQueryOptions } from './entities/workflow-definition';
import type { CompleteWorkflowParams, CreateWorkflowParams, CreateWorkflowProps, DeleteWorkflowParams, WorkflowProps, WorkflowQueryOptions } from './entities/workflow';
import type { WorkflowsChangelogEntryProps, WorkflowsChangelogQueryOptions } from './entities/workflows-changelog-entry';
import type { UIConfigProps } from './entities/ui-config';
import type { UserUIConfigProps } from './entities/user-ui-config';
import type { CreateEnvironmentTemplateProps, EnvironmentTemplateProps } from './entities/environment-template';
import type { CreateEnvironmentTemplateInstallationProps, EnvironmentTemplateInstallationProps, EnvironmentTemplateValidationProps, ValidateEnvironmentTemplateInstallationProps } from './entities/environment-template-installation';
import type { FunctionProps } from './entities/function';
import type { AppEventSubscriptionProps, CreateAppEventSubscriptionProps } from './entities/app-event-subscription';
import type { AppKeyProps, CreateAppKeyProps } from './entities/app-key';
import type { AppAccessTokenProps, CreateAppAccessTokenProps } from './entities/app-access-token';
import type { ConceptProps, CreateConceptProps } from './entities/concept';
import type { ConceptSchemeProps, CreateConceptSchemeProps } from './entities/concept-scheme';
import type { ResourceProviderProps, UpsertResourceProviderProps } from './entities/resource-provider';
import type { ResourceTypeProps, SpaceEnvResourceTypeProps, UpsertResourceTypeProps } from './entities/resource-type';
import type { ResourceProps, ResourceQueryOptions } from './entities/resource';
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;
};
}
/**
* ResourceLink is a reference object to another entity outside of the current space/environment
*/
export interface ResourceLink<T extends string> {
sys: {
type: 'ResourceLink';
linkType: T;
urn: 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: string]: any;
}
export interface SpaceQueryOptions extends PaginationQueryOptions {
spaceId?: string;
}
export interface BasicMetaSysProps {
type: string;
id: string;
version: number;
createdBy?: SysLink;
createdAt: string;
updatedBy?: SysLink;
updatedAt: string;
}
export interface MetaSysProps extends BasicMetaSysProps {
space?: SysLink;
publishedVersion?: number;
archivedVersion?: number;
archivedBy?: SysLink;
archivedAt?: string;
deletedVersion?: number;
deletedBy?: SysLink;
deletedAt?: string;
}
export interface EntityMetaSysProps extends MetaSysProps {
space: SysLink;
status?: SysLink;
environment: SysLink;
publishedBy?: Link<'User'> | Link<'AppDefinition'>;
publishedAt?: string;
firstPublishedAt?: string;
publishedCounter?: number;
locale?: string;
}
export interface EntryMetaSysProps extends EntityMetaSysProps {
contentType: SysLink;
automationTags: Link<'Tag'>[];
}
export interface MetaLinkProps {
type: string;
linkType: string;
id: string;
}
export interface MetadataProps {
tags: Link<'Tag'>[];
concepts?: Link<'TaxonomyConcept'>[];
}
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?: {
next?: string;
prev?: string;
};
}
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: string]: any;
}
export interface BasicCursorPaginationOptions extends Omit<BasicQueryOptions, 'skip'> {
pageNext?: string;
pagePrev?: string;
}
export type KeyValueMap = Record<string, any>;
/**
* @private
*/
type MRInternal<UA extends boolean> = {
(opts: MROpts<'Http', 'get', UA>): MRReturn<'Http', 'get'>;
(opts: MROpts<'Http', 'patch', UA>): MRReturn<'Http', 'patch'>;
(opts: MROpts<'Http', 'post', UA>): MRReturn<'Http', 'post'>;
(opts: MROpts<'Http', 'put', UA>): MRReturn<'Http', 'put'>;
(opts: MROpts<'Http', 'delete', UA>): MRReturn<'Http', 'delete'>;
(opts: MROpts<'Http', 'request', UA>): MRReturn<'Http', 'request'>;
(opts: MROpts<'AppAction', 'get', UA>): MRReturn<'AppAction', 'get'>;
(opts: MROpts<'AppAction', 'getMany', UA>): MRReturn<'AppAction', 'getMany'>;
(opts: MROpts<'AppAction', 'delete', UA>): MRReturn<'AppAction', 'delete'>;
(opts: MROpts<'AppAction', 'create', UA>): MRReturn<'AppAction', 'create'>;
(opts: MROpts<'AppAction', 'update', UA>): MRReturn<'AppAction', 'update'>;
(opts: MROpts<'AppActionCall', 'create', UA>): MRReturn<'AppActionCall', 'create'>;
(opts: MROpts<'AppActionCall', 'createWithResponse', UA>): MRReturn<'AppActionCall', 'createWithResponse'>;
(opts: MROpts<'AppActionCall', 'getCallDetails', UA>): MRReturn<'AppActionCall', 'getCallDetails'>;
(opts: MROpts<'AppBundle', 'get', UA>): MRReturn<'AppBundle', 'get'>;
(opts: MROpts<'AppBundle', 'getMany', UA>): MRReturn<'AppBundle', 'getMany'>;
(opts: MROpts<'AppBundle', 'delete', UA>): MRReturn<'AppBundle', 'delete'>;
(opts: MROpts<'AppBundle', 'create', UA>): MRReturn<'AppBundle', 'create'>;
(opts: MROpts<'ApiKey', 'get', UA>): MRReturn<'ApiKey', 'get'>;
(opts: MROpts<'ApiKey', 'getMany', UA>): MRReturn<'ApiKey', 'getMany'>;
(opts: MROpts<'ApiKey', 'create', UA>): MRReturn<'ApiKey', 'create'>;
(opts: MROpts<'ApiKey', 'createWithId', UA>): MRReturn<'ApiKey', 'createWithId'>;
(opts: MROpts<'ApiKey', 'update', UA>): MRReturn<'ApiKey', 'update'>;
(opts: MROpts<'ApiKey', 'delete', UA>): MRReturn<'ApiKey', 'delete'>;
(opts: MROpts<'AppDefinition', 'get', UA>): MRReturn<'AppDefinition', 'get'>;
(opts: MROpts<'AppDefinition', 'getMany', UA>): MRReturn<'AppDefinition', 'getMany'>;
(opts: MROpts<'AppDefinition', 'create', UA>): MRReturn<'AppDefinition', 'create'>;
(opts: MROpts<'AppDefinition', 'update', UA>): MRReturn<'AppDefinition', 'update'>;
(opts: MROpts<'AppDefinition', 'delete', UA>): MRReturn<'AppDefinition', 'delete'>;
(opts: MROpts<'AppDefinition', 'getInstallationsForOrg', UA>): MRReturn<'AppDefinition', 'getInstallationsForOrg'>;
(opts: MROpts<'AppInstallation', 'get', UA>): MRReturn<'AppInstallation', 'get'>;
(opts: MROpts<'AppInstallation', 'getMany', UA>): MRReturn<'AppInstallation', 'getMany'>;
(opts: MROpts<'AppInstallation', 'upsert', UA>): MRReturn<'AppInstallation', 'upsert'>;
(opts: MROpts<'AppInstallation', 'delete', UA>): MRReturn<'AppInstallation', 'delete'>;
(opts: MROpts<'AppInstallation', 'getForOrganization', UA>): MRReturn<'AppInstallation', 'getForOrganization'>;
(opts: MROpts<'Asset', 'getMany', UA>): MRReturn<'Asset', 'getMany'>;
(opts: MROpts<'Asset', 'getPublished', UA>): MRReturn<'Asset', 'getPublished'>;
(opts: MROpts<'Asset', 'get', UA>): MRReturn<'Asset', 'get'>;
(opts: MROpts<'Asset', 'update', UA>): MRReturn<'Asset', 'update'>;
(opts: MROpts<'Asset', 'delete', UA>): MRReturn<'Asset', 'delete'>;
(opts: MROpts<'Asset', 'publish', UA>): MRReturn<'Asset', 'publish'>;
(opts: MROpts<'Asset', 'unpublish', UA>): MRReturn<'Asset', 'unpublish'>;
(opts: MROpts<'Asset', 'archive', UA>): MRReturn<'Asset', 'archive'>;
(opts: MROpts<'Asset', 'unarchive', UA>): MRReturn<'Asset', 'unarchive'>;
(opts: MROpts<'Asset', 'create', UA>): MRReturn<'Asset', 'create'>;
(opts: MROpts<'Asset', 'createWithId', UA>): MRReturn<'Asset', 'createWithId'>;
(opts: MROpts<'Asset', 'createFromFiles', UA>): MRReturn<'Asset', 'createFromFiles'>;
(opts: MROpts<'Asset', 'processForAllLocales', UA>): MRReturn<'Asset', 'processForAllLocales'>;
(opts: MROpts<'Asset', 'processForLocale', UA>): MRReturn<'Asset', 'processForLocale'>;
(opts: MROpts<'AppUpload', 'get', UA>): MRReturn<'AppUpload', 'get'>;
(opts: MROpts<'AppUpload', 'delete', UA>): MRReturn<'AppUpload', 'delete'>;
(opts: MROpts<'AppUpload', 'create', UA>): MRReturn<'AppUpload', 'create'>;
(opts: MROpts<'AppDetails', 'upsert', UA>): MRReturn<'AppDetails', 'upsert'>;
(opts: MROpts<'AppDetails', 'get', UA>): MRReturn<'AppDetails', 'get'>;
(opts: MROpts<'AppDetails', 'delete', UA>): MRReturn<'AppDetails', 'delete'>;
(opts: MROpts<'AppSignedRequest', 'create', UA>): MRReturn<'AppSignedRequest', 'create'>;
(opts: MROpts<'AppSigningSecret', 'upsert', UA>): MRReturn<'AppSigningSecret', 'upsert'>;
(opts: MROpts<'AppSigningSecret', 'get', UA>): MRReturn<'AppSigningSecret', 'get'>;
(opts: MROpts<'AppSigningSecret', 'delete', UA>): MRReturn<'AppSigningSecret', 'delete'>;
(opts: MROpts<'AppEventSubscription', 'upsert', UA>): MRReturn<'AppEventSubscription', 'upsert'>;
(opts: MROpts<'AppEventSubscription', 'get', UA>): MRReturn<'AppEventSubscription', 'get'>;
(opts: MROpts<'AppEventSubscription', 'delete', UA>): MRReturn<'AppEventSubscription', 'delete'>;
(opts: MROpts<'AppKey', 'get', UA>): MRReturn<'AppKey', 'get'>;
(opts: MROpts<'AppKey', 'getMany', UA>): MRReturn<'AppKey', 'getMany'>;
(opts: MROpts<'AppKey', 'create', UA>): MRReturn<'AppKey', 'create'>;
(opts: MROpts<'AppKey', 'delete', UA>): MRReturn<'AppKey', 'delete'>;
(opts: MROpts<'AppAccessToken', 'create', UA>): MRReturn<'AppAccessToken', 'create'>;
(opts: MROpts<'AssetKey', 'create', UA>): MRReturn<'AssetKey', 'create'>;
(opts: MROpts<'BulkAction', 'get', UA>): MRReturn<'BulkAction', 'get'>;
(opts: MROpts<'BulkAction', 'publish', UA>): MRReturn<'BulkAction', 'publish'>;
(opts: MROpts<'BulkAction', 'unpublish', UA>): MRReturn<'BulkAction', 'unpublish'>;
(opts: MROpts<'BulkAction', 'validate', UA>): MRReturn<'BulkAction', 'validate'>;
(opts: MROpts<'Comment', 'get', UA>): MRReturn<'Comment', 'get'>;
(opts: MROpts<'Comment', 'getMany', UA>): MRReturn<'Comment', 'getMany'>;
(opts: MROpts<'Comment', 'getAll', UA>): MRReturn<'Comment', 'getAll'>;
(opts: MROpts<'Comment', 'create', UA>): MRReturn<'Comment', 'create'>;
(opts: MROpts<'Comment', 'update', UA>): MRReturn<'Comment', 'update'>;
(opts: MROpts<'Comment', 'delete', UA>): MRReturn<'Comment', 'delete'>;
(opts: MROpts<'Concept', 'get', UA>): MRReturn<'Concept', 'get'>;
(opts: MROpts<'Concept', 'getMany', UA>): MRReturn<'Concept', 'getMany'>;
(opts: MROpts<'Concept', 'getTotal', UA>): MRReturn<'Concept', 'getTotal'>;
(opts: MROpts<'Concept', 'getDescendants', UA>): MRReturn<'Concept', 'getDescendants'>;
(opts: MROpts<'Concept', 'create', UA>): MRReturn<'Concept', 'create'>;
(opts: MROpts<'Concept', 'update', UA>): MRReturn<'Concept', 'update'>;
(opts: MROpts<'Concept', 'delete', UA>): MRReturn<'Concept', 'delete'>;
(opts: MROpts<'ConceptScheme', 'get', UA>): MRReturn<'ConceptScheme', 'get'>;
(opts: MROpts<'ConceptScheme', 'getMany', UA>): MRReturn<'ConceptScheme', 'getMany'>;
(opts: MROpts<'ConceptScheme', 'getTotal', UA>): MRReturn<'ConceptScheme', 'getTotal'>;
(opts: MROpts<'ConceptScheme', 'create', UA>): MRReturn<'ConceptScheme', 'create'>;
(opts: MROpts<'ConceptScheme', 'update', UA>): MRReturn<'ConceptScheme', 'update'>;
(opts: MROpts<'ConceptScheme', 'delete', UA>): MRReturn<'ConceptScheme', 'delete'>;
(opts: MROpts<'ContentType', 'get', UA>): MRReturn<'ContentType', 'get'>;
(opts: MROpts<'ContentType', 'getMany', UA>): MRReturn<'ContentType', 'getMany'>;
(opts: MROpts<'ContentType', 'update', UA>): MRReturn<'ContentType', 'update'>;
(opts: MROpts<'ContentType', 'create', UA>): MRReturn<'ContentType', 'create'>;
(opts: MROpts<'ContentType', 'createWithId', UA>): MRReturn<'ContentType', 'createWithId'>;
(opts: MROpts<'ContentType', 'delete', UA>): MRReturn<'ContentType', 'delete'>;
(opts: MROpts<'ContentType', 'publish', UA>): MRReturn<'ContentType', 'publish'>;
(opts: MROpts<'ContentType', 'unpublish', UA>): MRReturn<'ContentType', 'unpublish'>;
(opts: MROpts<'EditorInterface', 'get', UA>): MRReturn<'EditorInterface', 'get'>;
(opts: MROpts<'EditorInterface', 'getMany', UA>): MRReturn<'EditorInterface', 'getMany'>;
(opts: MROpts<'EditorInterface', 'update', UA>): MRReturn<'EditorInterface', 'update'>;
(opts: MROpts<'Environment', 'get', UA>): MRReturn<'Environment', 'get'>;
(opts: MROpts<'Environment', 'getMany', UA>): MRReturn<'Environment', 'getMany'>;
(opts: MROpts<'Environment', 'create', UA>): MRReturn<'Environment', 'create'>;
(opts: MROpts<'Environment', 'createWithId', UA>): MRReturn<'Environment', 'createWithId'>;
(opts: MROpts<'Environment', 'update', UA>): MRReturn<'Environment', 'update'>;
(opts: MROpts<'Environment', 'delete', UA>): MRReturn<'Environment', 'delete'>;
(opts: MROpts<'EnvironmentAlias', 'get', UA>): MRReturn<'EnvironmentAlias', 'get'>;
(opts: MROpts<'EnvironmentAlias', 'getMany', UA>): MRReturn<'EnvironmentAlias', 'getMany'>;
(opts: MROpts<'EnvironmentAlias', 'createWithId', UA>): MRReturn<'EnvironmentAlias', 'createWithId'>;
(opts: MROpts<'EnvironmentAlias', 'update', UA>): MRReturn<'EnvironmentAlias', 'update'>;
(opts: MROpts<'EnvironmentAlias', 'delete', UA>): MRReturn<'EnvironmentAlias', 'delete'>;
(opts: MROpts<'EnvironmentTemplate', 'get', UA>): MRReturn<'EnvironmentTemplate', 'get'>;
(opts: MROpts<'EnvironmentTemplate', 'getMany', UA>): MRReturn<'EnvironmentTemplate', 'getMany'>;
(opts: MROpts<'EnvironmentTemplate', 'create', UA>): MRReturn<'EnvironmentTemplate', 'create'>;
(opts: MROpts<'EnvironmentTemplate', 'update', UA>): MRReturn<'EnvironmentTemplate', 'update'>;
(opts: MROpts<'EnvironmentTemplate', 'delete', UA>): MRReturn<'EnvironmentTemplate', 'delete'>;
(opts: MROpts<'EnvironmentTemplate', 'versions', UA>): MRReturn<'EnvironmentTemplate', 'versions'>;
(opts: MROpts<'EnvironmentTemplate', 'versionUpdate', UA>): MRReturn<'EnvironmentTemplate', 'versionUpdate'>;
(opts: MROpts<'EnvironmentTemplate', 'validate', UA>): MRReturn<'EnvironmentTemplate', 'validate'>;
(opts: MROpts<'EnvironmentTemplate', 'install', UA>): MRReturn<'EnvironmentTemplate', 'install'>;
(opts: MROpts<'EnvironmentTemplate', 'disconnect', UA>): MRReturn<'EnvironmentTemplate', 'disconnect'>;
(opts: MROpts<'EnvironmentTemplateInstallation', 'getMany', UA>): MRReturn<'EnvironmentTemplateInstallation', 'getMany'>;
(opts: MROpts<'EnvironmentTemplateInstallation', 'getForEnvironment', UA>): MRReturn<'EnvironmentTemplateInstallation', 'getForEnvironment'>;
(opts: MROpts<'Entry', 'getMany', UA>): MRReturn<'Entry', 'getMany'>;
(opts: MROpts<'Entry', 'getPublished', UA>): MRReturn<'Entry', 'getPublished'>;
(opts: MROpts<'Entry', 'get', UA>): MRReturn<'Entry', 'get'>;
(opts: MROpts<'Entry', 'patch', UA>): MRReturn<'Entry', 'patch'>;
(opts: MROpts<'Entry', 'update', UA>): MRReturn<'Entry', 'update'>;
(opts: MROpts<'Entry', 'delete', UA>): MRReturn<'Entry', 'delete'>;
(opts: MROpts<'Entry', 'publish', UA>): MRReturn<'Entry', 'publish'>;
(opts: MROpts<'Entry', 'unpublish', UA>): MRReturn<'Entry', 'unpublish'>;
(opts: MROpts<'Entry', 'archive', UA>): MRReturn<'Entry', 'archive'>;
(opts: MROpts<'Entry', 'unarchive', UA>): MRReturn<'Entry', 'unarchive'>;
(opts: MROpts<'Entry', 'create', UA>): MRReturn<'Entry', 'create'>;
(opts: MROpts<'Entry', 'createWithId', UA>): MRReturn<'Entry', 'createWithId'>;
(opts: MROpts<'Entry', 'references', UA>): MRReturn<'Entry', 'references'>;
(opts: MROpts<'Extension', 'get', UA>): MRReturn<'Extension', 'get'>;
(opts: MROpts<'Extension', 'getMany', UA>): MRReturn<'Extension', 'getMany'>;
(opts: MROpts<'Extension', 'create', UA>): MRReturn<'Extension', 'create'>;
(opts: MROpts<'Extension', 'createWithId', UA>): MRReturn<'Extension', 'createWithId'>;
(opts: MROpts<'Extension', 'update', UA>): MRReturn<'Extension', 'update'>;
(opts: MROpts<'Extension', 'delete', UA>): MRReturn<'Extension', 'delete'>;
(opts: MROpts<'Locale', 'get', UA>): MRReturn<'Locale', 'get'>;
(opts: MROpts<'Locale', 'getMany', UA>): MRReturn<'Locale', 'getMany'>;
(opts: MROpts<'Locale', 'delete', UA>): MRReturn<'Locale', 'delete'>;
(opts: MROpts<'Locale', 'update', UA>): MRReturn<'Locale', 'update'>;
(opts: MROpts<'Locale', 'create', UA>): MRReturn<'Locale', 'create'>;
(opts: MROpts<'Organization', 'getMany', UA>): MRReturn<'Organization', 'getMany'>;
(opts: MROpts<'Organization', 'get', UA>): MRReturn<'Organization', 'get'>;
(opts: MROpts<'OrganizationInvitation', 'get', UA>): MRReturn<'OrganizationInvitation', 'get'>;
(opts: MROpts<'OrganizationInvitation', 'create', UA>): MRReturn<'OrganizationInvitation', 'create'>;
(opts: MROpts<'OrganizationMembership', 'get', UA>): MRReturn<'OrganizationMembership', 'get'>;
(opts: MROpts<'OrganizationMembership', 'getMany', UA>): MRReturn<'OrganizationMembership', 'getMany'>;
(opts: MROpts<'OrganizationMembership', 'update', UA>): MRReturn<'OrganizationMembership', 'update'>;
(opts: MROpts<'OrganizationMembership', 'delete', UA>): MRReturn<'OrganizationMembership', 'delete'>;
(opts: MROpts<'PersonalAccessToken', 'get', UA>): MRReturn<'PersonalAccessToken', 'get'>;
(opts: MROpts<'PersonalAccessToken', 'getMany', UA>): MRReturn<'PersonalAccessToken', 'getMany'>;
(opts: MROpts<'PersonalAccessToken', 'create', UA>): MRReturn<'PersonalAccessToken', 'create'>;
(opts: MROpts<'PersonalAccessToken', 'revoke', UA>): MRReturn<'PersonalAccessToken', 'revoke'>;
(opts: MROpts<'AccessToken', 'get', UA>): MRReturn<'AccessToken', 'get'>;
(opts: MROpts<'AccessToken', 'getMany', UA>): MRReturn<'AccessToken', 'getMany'>;
(opts: MROpts<'AccessToken', 'createPersonalAccessToken', UA>): MRReturn<'AccessToken', 'createPersonalAccessToken'>;
(opts: MROpts<'AccessToken', 'revoke', UA>): MRReturn<'AccessToken', 'revoke'>;
(opts: MROpts<'AccessToken', 'getManyForOrganization', UA>): MRReturn<'AccessToken', 'getManyForOrganization'>;
(opts: MROpts<'PreviewApiKey', 'get', UA>): MRReturn<'PreviewApiKey', 'get'>;
(opts: MROpts<'PreviewApiKey', 'getMany', UA>): MRReturn<'PreviewApiKey', 'getMany'>;
(opts: MROpts<'Release', 'archive', UA>): MRReturn<'Release', 'archive'>;
(opts: MROpts<'Release', 'get', UA>): MRReturn<'Release', 'get'>;
(opts: MROpts<'Release', 'query', UA>): MRReturn<'Release', 'query'>;
(opts: MROpts<'Release', 'create', UA>): MRReturn<'Release', 'create'>;
(opts: MROpts<'Release', 'update', UA>): MRReturn<'Release', 'update'>;
(opts: MROpts<'Release', 'delete', UA>): MRReturn<'Release', 'delete'>;
(opts: MROpts<'Release', 'publish', UA>): MRReturn<'Release', 'publish'>;
(opts: MROpts<'Release', 'unpublish', UA>): MRReturn<'Release', 'unpublish'>;
(opts: MROpts<'Release', 'unarchive', UA>): MRReturn<'Release', 'unarchive'>;
(opts: MROpts<'Release', 'validate', UA>): MRReturn<'Release', 'validate'>;
(opts: MROpts<'ReleaseAction', 'get', UA>): MRReturn<'ReleaseAction', 'get'>;
(opts: MROpts<'ReleaseAction', 'getMany', UA>): MRReturn<'ReleaseAction', 'getMany'>;
(opts: MROpts<'ReleaseAction', 'queryForRelease', UA>): MRReturn<'ReleaseAction', 'queryForRelease'>;
(opts: MROpts<'Resource', 'getMany', UA>): MRReturn<'Resource', 'getMany'>;
(opts: MROpts<'ResourceProvider', 'get', UA>): MRReturn<'ResourceProvider', 'get'>;
(opts: MROpts<'ResourceProvider', 'upsert', UA>): MRReturn<'ResourceProvider', 'upsert'>;
(opts: MROpts<'ResourceProvider', 'delete', UA>): MRReturn<'ResourceProvider', 'delete'>;
(opts: MROpts<'ResourceType', 'get', UA>): MRReturn<'ResourceType', 'get'>;
(opts: MROpts<'ResourceType', 'upsert', UA>): MRReturn<'ResourceType', 'upsert'>;
(opts: MROpts<'ResourceType', 'delete', UA>): MRReturn<'ResourceType', 'delete'>;
(opts: MROpts<'ResourceType', 'getForEnvironment', UA>): MRReturn<'ResourceType', 'getForEnvironment'>;
(opts: MROpts<'ResourceType', 'getMany', UA>): MRReturn<'ResourceType', 'getMany'>;
(opts: MROpts<'Role', 'get', UA>): MRReturn<'Role', 'get'>;
(opts: MROpts<'Role', 'getMany', UA>): MRReturn<'Role', 'getMany'>;
(opts: MROpts<'Role', 'getManyForOrganization', UA>): MRReturn<'Role', 'getManyForOrganization'>;
(opts: MROpts<'Role', 'create', UA>): MRReturn<'Role', 'create'>;
(opts: MROpts<'Role', 'createWithId', UA>): MRReturn<'Role', 'createWithId'>;
(opts: MROpts<'Role', 'update', UA>): MRReturn<'Role', 'update'>;
(opts: MROpts<'Role', 'delete', UA>): MRReturn<'Role', 'delete'>;
(opts: MROpts<'ScheduledAction', 'get', UA>): MRReturn<'ScheduledAction', 'get'>;
(opts: MROpts<'ScheduledAction', 'getMany', UA>): MRReturn<'ScheduledAction', 'getMany'>;
(opts: MROpts<'ScheduledAction', 'create', UA>): MRReturn<'ScheduledAction', 'create'>;
(opts: MROpts<'ScheduledAction', 'update', UA>): MRReturn<'ScheduledAction', 'update'>;
(opts: MROpts<'ScheduledAction', 'delete', UA>): MRReturn<'ScheduledAction', 'delete'>;
(opts: MROpts<'Snapshot', 'getManyForEntry', UA>): MRReturn<'Snapshot', 'getManyForEntry'>;
(opts: MROpts<'Snapshot', 'getForEntry', UA>): MRReturn<'Snapshot', 'getForEntry'>;
(opts: MROpts<'Snapshot', 'getManyForContentType', UA>): MRReturn<'Snapshot', 'getManyForContentType'>;
(opts: MROpts<'Snapshot', 'getForContentType', UA>): MRReturn<'Snapshot', 'getForContentType'>;
(opts: MROpts<'Space', 'get', UA>): MRReturn<'Space', 'get'>;
(opts: MROpts<'Space', 'getMany', UA>): MRReturn<'Space', 'getMany'>;
(opts: MROpts<'Space', 'getManyForOrganization', UA>): MRReturn<'Space', 'getManyForOrganization'>;
(opts: MROpts<'Space', 'create', UA>): MRReturn<'Space', 'create'>;
(opts: MROpts<'Space', 'update', UA>): MRReturn<'Space', 'update'>;
(opts: MROpts<'Space', 'delete', UA>): MRReturn<'Space', 'delete'>;
(opts: MROpts<'SpaceMember', 'get', UA>): MRReturn<'SpaceMember', 'get'>;
(opts: MROpts<'SpaceMember', 'getMany', UA>): MRReturn<'SpaceMember', 'getMany'>;
(opts: MROpts<'SpaceMembership', 'get', UA>): MRReturn<'SpaceMembership', 'get'>;
(opts: MROpts<'SpaceMembership', 'getMany', UA>): MRReturn<'SpaceMembership', 'getMany'>;
(opts: MROpts<'SpaceMembership', 'getForOrganization', UA>): MRReturn<'SpaceMembership', 'getForOrganization'>;
(opts: MROpts<'SpaceMembership', 'getManyForOrganization', UA>): MRReturn<'SpaceMembership', 'getManyForOrganization'>;
(opts: MROpts<'SpaceMembership', 'create', UA>): MRReturn<'SpaceMembership', 'create'>;
(opts: MROpts<'SpaceMembership', 'createWithId', UA>): MRReturn<'SpaceMembership', 'createWithId'>;
(opts: MROpts<'SpaceMembership', 'update', UA>): MRReturn<'SpaceMembership', 'update'>;
(opts: MROpts<'SpaceMembership', 'delete', UA>): MRReturn<'SpaceMembership', 'delete'>;
(opts: MROpts<'Tag', 'get', UA>): MRReturn<'Tag', 'get'>;
(opts: MROpts<'Tag', 'getMany', UA>): MRReturn<'Tag', 'getMany'>;
(opts: MROpts<'Tag', 'createWithId', UA>): MRReturn<'Tag', 'createWithId'>;
(opts: MROpts<'Tag', 'update', UA>): MRReturn<'Tag', 'update'>;
(opts: MROpts<'Tag', 'delete', UA>): MRReturn<'Tag', 'delete'>;
(opts: MROpts<'Task', 'get', UA>): MRReturn<'Task', 'get'>;
(opts: MROpts<'Task', 'getMany', UA>): MRReturn<'Task', 'getMany'>;
(opts: MROpts<'Task', 'getAll', UA>): MRReturn<'Task', 'getAll'>;
(opts: MROpts<'Task', 'create', UA>): MRReturn<'Task', 'create'>;
(opts: MROpts<'Task', 'update', UA>): MRReturn<'Task', 'update'>;
(opts: MROpts<'Task', 'delete', UA>): MRReturn<'Task', 'delete'>;
(opts: MROpts<'Team', 'get', UA>): MRReturn<'Team', 'get'>;
(opts: MROpts<'Team', 'getMany', UA>): MRReturn<'Team', 'getMany'>;
(opts: MROpts<'Team', 'getManyForSpace', UA>): MRReturn<'Team', 'getManyForSpace'>;
(opts: MROpts<'Team', 'create', UA>): MRReturn<'Team', 'create'>;
(opts: MROpts<'Team', 'update', UA>): MRReturn<'Team', 'update'>;
(opts: MROpts<'Team', 'delete', UA>): MRReturn<'Team', 'delete'>;
(opts: MROpts<'TeamMembership', 'get', UA>): MRReturn<'TeamMembership', 'get'>;
(opts: MROpts<'TeamMembership', 'getManyForOrganization', UA>): MRReturn<'TeamMembership', 'getManyForOrganization'>;
(opts: MROpts<'TeamMembership', 'getManyForTeam', UA>): MRReturn<'TeamMembership', 'getManyForTeam'>;
(opts: MROpts<'TeamMembership', 'create', UA>): MRReturn<'TeamMembership', 'create'>;
(opts: MROpts<'TeamMembership', 'update', UA>): MRReturn<'TeamMembership', 'update'>;
(opts: MROpts<'TeamMembership', 'delete', UA>): MRReturn<'TeamMembership', 'delete'>;
(opts: MROpts<'TeamSpaceMembership', 'get', UA>): MRReturn<'TeamSpaceMembership', 'get'>;
(opts: MROpts<'TeamSpaceMembership', 'getMany', UA>): MRReturn<'TeamSpaceMembership', 'getMany'>;
(opts: MROpts<'TeamSpaceMembership', 'getForOrganization', UA>): MRReturn<'TeamSpaceMembership', 'getForOrganization'>;
(opts: MROpts<'TeamSpaceMembership', 'getManyForOrganization', UA>): MRReturn<'TeamSpaceMembership', 'getManyForOrganization'>;
(opts: MROpts<'TeamSpaceMembership', 'create', UA>): MRReturn<'TeamSpaceMembership', 'create'>;
(opts: MROpts<'TeamSpaceMembership', 'update', UA>): MRReturn<'TeamSpaceMembership', 'update'>;
(opts: MROpts<'TeamSpaceMembership', 'delete', UA>): MRReturn<'TeamSpaceMembership', 'delete'>;
(opts: MROpts<'UIConfig', 'get', UA>): MRReturn<'UIConfig', 'get'>;
(opts: MROpts<'UIConfig', 'update', UA>): MRReturn<'UIConfig', 'update'>;
(opts: MROpts<'Upload', 'get', UA>): MRReturn<'Entry', 'get'>;
(opts: MROpts<'Upload', 'create', UA>): MRReturn<'Entry', 'create'>;
(opts: MROpts<'Upload', 'delete', UA>): MRReturn<'Entry', 'delete'>;
(opts: MROpts<'Usage', 'getManyForSpace', UA>): MRReturn<'Usage', 'getManyForSpace'>;
(opts: MROpts<'Usage', 'getManyForOrganization', UA>): MRReturn<'Usage', 'getManyForOrganization'>;
(opts: MROpts<'User', 'getManyForSpace', UA>): MRReturn<'User', 'getManyForSpace'>;
(opts: MROpts<'User', 'getForSpace', UA>): MRReturn<'User', 'getForSpace'>;
(opts: MROpts<'User', 'getCurrent', UA>): MRReturn<'User', 'getCurrent'>;
(opts: MROpts<'User', 'getForOrganization', UA>): MRReturn<'User', 'getForOrganization'>;
(opts: MROpts<'User', 'getManyForOrganization', UA>): MRReturn<'User', 'getManyForOrganization'>;
(opts: MROpts<'UserUIConfig', 'get', UA>): MRReturn<'UserUIConfig', 'update'>;
(opts: MROpts<'UserUIConfig', 'update', UA>): MRReturn<'UserUIConfig', 'update'>;
(opts: MROpts<'Webhook', 'get', UA>): MRReturn<'Webhook', 'get'>;
(opts: MROpts<'Webhook', 'getMany', UA>): MRReturn<'Webhook', 'getMany'>;
(opts: MROpts<'Webhook', 'getCallDetails', UA>): MRReturn<'Webhook', 'getCallDetails'>;
(opts: MROpts<'Webhook', 'getHealthStatus', UA>): MRReturn<'Webhook', 'getHealthStatus'>;
(opts: MROpts<'Webhook', 'getManyCallDetails', UA>): MRReturn<'Webhook', 'getManyCallDetails'>;
(opts: MROpts<'Webhook', 'getSigningSecret', UA>): MRReturn<'Webhook', 'getSigningSecret'>;
(opts: MROpts<'Webhook', 'getRetryPolicy', UA>): MRReturn<'Webhook', 'getRetryPolicy'>;
(opts: MROpts<'Webhook', 'create', UA>): MRReturn<'Webhook', 'create'>;
(opts: MROpts<'Webhook', 'createWithId', UA>): MRReturn<'Webhook', 'createWithId'>;
(opts: MROpts<'Webhook', 'update', UA>): MRReturn<'Webhook', 'update'>;
(opts: MROpts<'Webhook', 'upsertSigningSecret', UA>): MRReturn<'Webhook', 'upsertSigningSecret'>;
(opts: MROpts<'Webhook', 'upsertRetryPolicy', UA>): MRReturn<'Webhook', 'upsertRetryPolicy'>;
(opts: MROpts<'Webhook', 'delete', UA>): MRReturn<'Webhook', 'delete'>;
(opts: MROpts<'Webhook', 'deleteSigningSecret', UA>): MRReturn<'Webhook', 'deleteSigningSecret'>;
(opts: MROpts<'Webhook', 'deleteRetryPolicy', UA>): MRReturn<'Webhook', 'deleteRetryPolicy'>;
(opts: MROpts<'WorkflowDefinition', 'get', UA>): MRReturn<'WorkflowDefinition', 'get'>;
(opts: MROpts<'WorkflowDefinition', 'getMany', UA>): MRReturn<'WorkflowDefinition', 'getMany'>;
(opts: MROpts<'WorkflowDefinition', 'create', UA>): MRReturn<'WorkflowDefinition', 'create'>;
(opts: MROpts<'WorkflowDefinition', 'update', UA>): MRReturn<'WorkflowDefinition', 'update'>;
(opts: MROpts<'WorkflowDefinition', 'delete', UA>): MRReturn<'WorkflowDefinition', 'delete'>;
(opts: MROpts<'Workflow', 'getMany', UA>): MRReturn<'Workflow', 'getMany'>;
(opts: MROpts<'Workflow', 'create', UA>): MRReturn<'Workflow', 'create'>;
(opts: MROpts<'Workflow', 'update', UA>): MRReturn<'Workflow', 'update'>;
(opts: MROpts<'Workflow', 'delete', UA>): MRReturn<'Workflow', 'delete'>;
(opts: MROpts<'Workflow', 'complete', UA>): MRReturn<'Workflow', 'complete'>;
(opts: MROpts<'WorkflowsChangelog', 'getMany', UA>): MRReturn<'WorkflowsChangelog', 'getMany'>;
};
/**
* @private
*/
export type MakeRequestWithUserAgent = MRInternal<true>;
/**
* @private
*/
export type MakeRequest = MRInternal<false>;
/**
* @private
*/
type Without<T, U> = {
[P in Exclude<keyof T, keyof U>]?: never;
};
/**
* @private
*/
export type XOR<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
export interface Adapter {
makeRequest: MakeRequestWithUserAgent;
}
/**
* @private
*/
export type MRActions = {
Resource: {
getMany: {
params: GetResourceParams & {
query?: ResourceQueryOptions;
};
headers?: RawAxiosRequestHeaders;
return: CursorPaginatedCollectionProp<ResourceProps>;
};
};
ResourceProvider: {
get: {
params: GetResourceProviderParams;
return: ResourceProviderProps;
};
upsert: {
params: GetResourceProviderParams;
payload: UpsertResourceProviderProps;
headers?: RawAxiosRequestHeaders;
return: ResourceProviderProps;
};
delete: {
params: GetResourceProviderParams;
return: any;
};
};
ResourceType: {
get: {
params: GetResourceTypeParams;
return: ResourceTypeProps;
};
getMany: {
params: Omit<GetResourceTypeParams, 'resourceTypeId'>;
return: CollectionProp<ResourceTypeProps>;
};
upsert: {
params: GetResourceTypeParams;
payload: UpsertResourceTypeProps;
headers?: RawAxiosRequestHeaders;
return: ResourceTypeProps;
};
delete: {
params: GetResourceTypeParams;
return: any;
};
getForEnvironment: {
params: GetSpaceEnvironmentParams & {
query?: BasicCursorPaginationOptions;
};
return: CursorPaginatedCollectionProp<SpaceEnvResourceTypeProps>;
};
};
Http: {
get: {
params: {
url: string;
config?: RawAxiosRequestConfig;
};
return: any;
};
patch: {
params: {
url: string;
config?: RawAxiosRequestConfig;
};
payload: any;
return: any;
};
post: {
params: {
url: string;
config?: RawAxiosRequestConfig;
};
payload: any;
return: any;
};
put: {
params: {
url: string;
config?: RawAxiosRequestConfig;
};
payload: any;
return: any;
};
delete: {
params: {
url: string;
config?: RawAxiosRequestConfig;
};
return: any;
};
request: {
params: {
url: string;
config?: RawAxiosRequestConfig;
};
return: any;
};
};
AppAction: {
get: {
params: GetAppActionParams;
return: AppActionProps;
};
getMany: {
params: GetAppDefinitionParams & QueryParams;
return: CollectionProp<AppActionProps>;
};
getManyForEnvironment: {
params: GetAppActionsForEnvParams & QueryParams;
return: CollectionProp<AppActionProps>;
};
delete: {
params: GetAppActionParams;
return: void;
};
create: {
params: GetAppDefinitionParams;
payload: CreateAppActionProps;
return: AppActionProps;
};
update: {
params: GetAppActionParams;
payload: CreateAppActionProps;
return: AppActionProps;
};
};
AppActionCall: {
create: {
params: GetAppActionCallParams;
payload: CreateAppActionCallProps;
return: AppActionCallProps;
};
getCallDetails: {
params: GetAppActionCallDetailsParams;
return: AppActionCallResponse;
};
createWithResponse: {
params: GetAppActionCallParams;
payload: CreateAppActionCallProps;
return: AppActionCallResponse;
};
};
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?: RawAxiosRequestHeaders;
return: ApiKeyProps;
};
createWithId: {
params: GetSpaceParams & {
apiKeyId: string;
};
payload: CreateApiKeyProps;
headers?: RawAxiosRequestHeaders;
return: ApiKeyProps;
};
update: {
params: GetSpaceParams & {
apiKeyId: string;
};
payload: ApiKeyProps;
headers?: RawAxiosRequestHeaders;
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?: RawAxiosRequestHeaders;
return: AppDefinitionProps;
};
delete: {
params: GetAppDefinitionParams;
return: any;
};
getInstallationsForOrg: {
params: GetOrganizationParams & {
appDefinitionId: string;
} & SpaceQueryParams;
return: AppInstallationsForOrganizationProps;
};
};
AppInstallation: {
get: {
params: GetAppInstallationParams;
return: AppInstallationProps;
};
getMany: {
params: GetSpaceEnvironmentParams & PaginationQueryParams;
return: CollectionProp<AppInstallationProps>;
};
upsert: {
params: GetAppInstallationParams & {
acceptAllTerms?: boolean;
};
payload: CreateAppInstallationProps;
headers?: RawAxiosRequestHeaders;
return: AppInstallationProps;
};
delete: {
params: GetAppInstallationParams;
return: any;
};
getForOrganization: {
params: GetOrganizationParams & {
appDefinitionId: string;
spaceId?: string;
};
return: AppInstallationsForOrganizationProps;
};
};
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;
};
};
AppEventSubscription: {
upsert: {
params: GetAppDefinitionParams;
payload: CreateAppEventSubscriptionProps;
return: AppEventSubscriptionProps;
};
get: {
params: GetAppDefinitionParams;
return: AppEventSubscriptionProps;
};
delete: {
params: GetAppDefinitionParams;
return: void;
};
};
AppKey: {
create: {
params: GetAppDefinitionParams;
payload: CreateAppKeyProps;
return: AppKeyProps;
};
get: {
params: GetAppDefinitionParams & {
fingerprint: string;
};
return: AppKeyProps;
};
getMany: {
params: GetAppDefinitionParams & QueryParams;
return: CollectionProp<AppKeyProps>;
};
delete: {
params: GetAppDefinitionParams & {
fingerprint: string;
};
return: void;
};
};
AppAccessToken: {
create: {
params: GetAppInstallationParams;
payload: CreateAppAccessTokenProps;
return: AppAccessTokenProps;
};
};
Asset: {
getPublished: {
params: GetSpaceEnvironmentParams & QueryParams;
headers?: RawAxiosRequestHeaders;
return: CollectionProp<AssetProps>;
};
getMany: {
params: GetSpaceEnvironmentParams & QueryParams;
headers?: RawAxiosRequestHeaders;
return: CollectionProp<AssetProps>;
};
get: {
params: GetSpaceEnvironmentParams & {
assetId: string;
} & QueryParams;
headers?: RawAxiosRequestHeaders;
return: AssetProps;
};
update: {
params: GetSpaceEnvironmentParams & {
assetId: string;
};
payload: AssetProps;
headers?: RawAxiosRequestHeaders;
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 & {
uploadTimeout?: number;
};
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 & PlainTextBodyFormat;
return: CommentProps;
} | {
params: GetCommentParams & RichTextBodyFormat;
return: RichTextCommentProps;
};
getMany: {
params: GetManyCommentsParams & PlainTextBodyFormat & QueryParams;
return: CollectionProp<CommentProps>;
} | {
params: GetManyCommentsParams & QueryParams & RichTextBodyFormat;
return: CollectionProp<RichTextCommentProps>;
};
getAll: {
params: GetManyCommentsParams & QueryParams & PlainTextBodyFormat;
return: CollectionProp<CommentProps>;
} | {
params: GetManyCommentsParams & QueryParams & RichTextBodyFormat;
return: CollectionProp<RichTextCom