Type alias PlainClientAPI
Plain
ClientAPI
: { accessToken
: { createPersonalAccessToken
(rawData
: CreatePATProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<AccessTokenProp>; get
(params
: OptionalDefaults<{ tokenId
: string; }>): Promise<AccessTokenProp>; getMany
(params
: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProp>>; getManyForOrganization
(params
: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProp>>; revoke
(params
: OptionalDefaults<{ tokenId
: string; }>): Promise<AccessTokenProp>; }; apiKey
: { create
(params
: OptionalDefaults<GetSpaceParams>, data
: CreateApiKeyProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<ApiKeyProps>; createWithId
(params
: OptionalDefaults<GetSpaceParams & { apiKeyId
: string; }>, data
: CreateApiKeyProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<ApiKeyProps>; delete
(params
: OptionalDefaults<GetSpaceParams & { apiKeyId
: string; }>): Promise<any>; get
(params
: OptionalDefaults<GetSpaceParams & { apiKeyId
: string; }>): Promise<ApiKeyProps>; getMany
(params
: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<ApiKeyProps>>; update
(params
: OptionalDefaults<GetSpaceParams & { apiKeyId
: string; }>, rawData
: ApiKeyProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<ApiKeyProps>; }; appAccessToken
: AppAccessTokenPlainClientAPI; appAction
: AppActionPlainClientAPI; appActionCall
: AppActionCallPlainClientAPI; appBundle
: AppBundlePlainClientAPI; appDefinition
: AppDefinitionPlainClientAPI; appDetails
: AppDetailsPlainClientAPI; appEventSubscription
: AppEventSubscriptionPlainClientAPI; appInstallation
: AppInstallationPlainClientAPI; appKey
: AppKeyPlainClientAPI; appSignedRequest
: AppSignedRequestPlainClientAPI; appSigningSecret
: AppSigningSecretPlainClientAPI; appUpload
: AppUploadPlainClientAPI; asset
: { archive
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { assetId
: string; }>): Promise<AssetProps>; create
(params
: OptionalDefaults<GetSpaceEnvironmentParams>, rawData
: CreateAssetProps): Promise<AssetProps>; createFromFiles
(params
: OptionalDefaults<GetSpaceEnvironmentParams>, data
: Omit<AssetFileProp, "sys">): Promise<AssetProps>; createWithId
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { assetId
: string; }>, rawData
: CreateAssetProps): Promise<AssetProps>; delete
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { assetId
: string; }>): Promise<any>; get
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { assetId
: string; } & QueryParams>, rawData
?: unknown, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<AssetProps>; getMany
(params
: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData
?: unknown, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<CollectionProp<AssetProps>>; getPublished
(params
: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData
?: unknown, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<CollectionProp<AssetProps>>; processForAllLocales
(params
: OptionalDefaults<GetSpaceEnvironmentParams>, asset
: AssetProps, processingOptions
?: AssetProcessingForLocale): Promise<AssetProps>; processForLocale
(params
: OptionalDefaults<GetSpaceEnvironmentParams>, asset
: AssetProps, locale
: string, processingOptions
?: AssetProcessingForLocale): Promise<AssetProps>; publish
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { assetId
: string; }>, rawData
: AssetProps): Promise<AssetProps>; unarchive
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { assetId
: string; }>): Promise<AssetProps>; unpublish
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { assetId
: string; }>): Promise<AssetProps>; update
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { assetId
: string; }>, rawData
: AssetProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<AssetProps>; }; assetKey
: { create
(params
: OptionalDefaults<GetSpaceEnvironmentParams>, data
: CreateAssetKeyProps): Promise<AssetKeyProps>; }; bulkAction
: { get
<T>(params
: GetBulkActionParams): Promise<BulkActionProps<T>>; publish
(params
: GetSpaceEnvironmentParams, payload
: BulkActionPublishPayload): Promise<BulkActionProps<BulkActionPublishPayload>>; unpublish
(params
: GetSpaceEnvironmentParams, payload
: BulkActionUnpublishPayload): Promise<BulkActionProps<BulkActionUnpublishPayload>>; validate
(params
: GetSpaceEnvironmentParams, payload
: BulkActionValidatePayload): Promise<BulkActionProps<BulkActionValidatePayload>>; }; comment
: CommentPlainClientAPI; contentType
: { create
(params
: OptionalDefaults<GetSpaceEnvironmentParams>, rawData
: { description
: undefined | string; displayField
: undefined | string; fields
: ContentFields<KeyValueMap>[]; metadata
: undefined | ContentTypeMetadata; name
: string; }): Promise<ContentTypeProps>; createWithId
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { contentTypeId
: string; }>, rawData
: { description
: undefined | string; displayField
: undefined | string; fields
: ContentFields<KeyValueMap>[]; metadata
: undefined | ContentTypeMetadata; name
: string; }): Promise<ContentTypeProps>; delete
(params
: OptionalDefaults<GetContentTypeParams>): Promise<any>; get
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { contentTypeId
: string; } & QueryParams>): Promise<ContentTypeProps>; getMany
(params
: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>; omitAndDeleteField
(params
: OptionalDefaults<GetContentTypeParams>, contentType
: ContentTypeProps, fieldId
: string): Promise<ContentTypeProps>; publish
(params
: OptionalDefaults<GetContentTypeParams>, rawData
: ContentTypeProps): Promise<ContentTypeProps>; unpublish
(params
: OptionalDefaults<GetContentTypeParams>): Promise<ContentTypeProps>; update
(params
: OptionalDefaults<GetContentTypeParams>, rawData
: ContentTypeProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<ContentTypeProps>; }; editorInterface
: EditorInterfacePlainClientAPI; entry
: { archive
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; }>): Promise<EntryProps<T>>; create
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { contentTypeId
: string; }>, rawData
: CreateEntryProps<T>): Promise<EntryProps<T>>; createWithId
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { contentTypeId
: string; entryId
: string; }>, rawData
: CreateEntryProps<T>): Promise<EntryProps<T>>; delete
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; }>): Promise<any>; get
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; }>, rawData
?: unknown, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<EntryProps<T>>; getMany
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData
?: unknown, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<CollectionProp<EntryProps<T>>>; getPublished
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData
?: unknown, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<CollectionProp<EntryProps<T>>>; patch
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; }>, rawData
: OpPatch[], headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<EntryProps<T>>; publish
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; }>, rawData
: EntryProps<T>): Promise<EntryProps<T>>; references
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; include
?: number; }>): Promise<EntryReferenceProps>; unarchive
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; }>): Promise<EntryProps<T>>; unpublish
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; }>): Promise<EntryProps<T>>; update
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; }>, rawData
: EntryProps<T>, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<EntryProps<T>>; }; environment
: EnvironmentPlainClientAPI; environmentAlias
: EnvironmentAliasPlainClientAPI; environmentTemplate
: { create
(params
: GetOrganizationParams, rawData
: CreateEnvironmentTemplateProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<EnvironmentTemplateProps>; delete
(params
: GetEnvironmentTemplateParams, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<void>; disconnect
(params
: EnvironmentTemplateParams, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<void>; get
(params
: GetOrganizationParams & { environmentTemplateId
: string; } & { query
?: { select
?: string; }; version
?: number; }, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<EnvironmentTemplateProps>; getMany
(params
: GetOrganizationParams & { query
?: BasicCursorPaginationOptions & { select
?: string; }; }, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>; install
(params
: EnvironmentTemplateParams, rawData
: CreateEnvironmentTemplateInstallationProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<EnvironmentTemplateInstallationProps>; update
(params
: GetEnvironmentTemplateParams, rawData
: EnvironmentTemplateProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<EnvironmentTemplateProps>; validate
(params
: EnvironmentTemplateParams & { version
?: number; }, rawData
: ValidateEnvironmentTemplateInstallationProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<EnvironmentTemplateValidationProps<ValidationFinding>>; versionUpdate
(params
: GetOrganizationParams & { environmentTemplateId
: string; } & { version
: number; }, rawData
: { versionDescription
?: string; versionName
?: string; }, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<EnvironmentTemplateProps>; versions
(params
: GetOrganizationParams & { environmentTemplateId
: string; } & { query
?: BasicCursorPaginationOptions & { select
?: string; }; }, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>; }; environmentTemplateInstallation
: { getForEnvironment
(params
: BasicCursorPaginationOptions & EnvironmentTemplateParams & { installationId
?: string; }, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>; getMany
(params
: BasicCursorPaginationOptions & { environmentId
?: string; environmentTemplateId
: string; organizationId
: string; spaceId
?: string; }, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>; }; extension
: ExtensionPlainClientAPI; function
: { getMany
(params
: OptionalDefaults<GetOrganizationParams & { appDefinitionId
: string; } & QueryParams>): Promise<CollectionProp<FunctionProps>>; }; locale
: LocalePlainClientAPI; organization
: OrganizationPlainClientAPI; organizationInvitation
: { create
(params
: OptionalDefaults<{ organizationId
: string; }>, data
: CreateOrganizationInvitationProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<OrganizationInvitationProps>; get
(params
: OptionalDefaults<{ invitationId
: string; organizationId
: string; }>, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<OrganizationInvitationProps>; }; organizationMembership
: { delete
(params
: OptionalDefaults<GetOrganizationMembershipParams>): Promise<any>; get
(params
: OptionalDefaults<GetOrganizationMembershipParams>): Promise<OrganizationMembershipProps>; getMany
(params
: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<OrganizationMembershipProps>>; update
(params
: OptionalDefaults<GetOrganizationMembershipParams>, rawData
: OrganizationMembershipProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<OrganizationMembershipProps>; }; personalAccessToken
: { create
(rawData
: CreatePersonalAccessTokenProps, headers
?: Partial<RawAxiosHeaders & { Accept
: AxiosHeaderValue; Authorization
: AxiosHeaderValue; Content-Encoding
: AxiosHeaderValue; Content-Length
: AxiosHeaderValue; User-Agent
: AxiosHeaderValue; } & { Content-Type
: ContentType; }>): Promise<PersonalAccessTokenProp>; get
(params
: OptionalDefaults<{ tokenId
: string; }>): Promise<PersonalAccessTokenProp>; getMany
(params
: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProp>>; revoke
(params
: OptionalDefaults<{ tokenId
: string; }>): Promise<PersonalAccessTokenProp>; }; previewApiKey
: { get
(params
: OptionalDefaults<GetSpaceParams & { previewApiKeyId
: string; }>): Promise<PreviewApiKeyProps>; getMany
(params
: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<PreviewApiKeyProps>>; }; raw
: { delete
<T>(url
: string, config
?: RawAxiosRequestConfig<any>): Promise<T>; get
<T>(url
: string, config
?: RawAxiosRequestConfig<any>): Promise<T>; getDefaultParams
(): undefined | DefaultParams; http
<T>(url
: string, config
?: RawAxiosRequestConfig<any>): Promise<T>; patch
<T>(url
: string, payload
?: any, config
?: RawAxiosRequestConfig<any>): Promise<T>; post
<T>(url
: string, payload
?: any, config
?: RawAxiosRequestConfig<any>): Promise<T>; put
<T>(url
: string, payload
?: any, config
?: RawAxiosRequestConfig<any>): Promise<T>; }; release
: { archive
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { releaseId
: string; } & { version
: number; }>): Promise<ReleaseProps>; create
(params
: OptionalDefaults<GetSpaceEnvironmentParams>, data
: ReleasePayload): Promise<ReleaseProps>; delete
(params
: OptionalDefaults<GetReleaseParams>): Promise<void>; get
(params
: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>; publish
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { releaseId
: string; } & { version
: number; }>): Promise<ReleaseActionProps<"publish">>; query
(params
: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Record<string, unknown> & { spaceId
?: string; } & { environmentId
?: string; } & { query
?: ReleaseQueryOptions; }): Promise<CursorPaginatedCollectionProp<ReleaseProps>>; unarchive
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { releaseId
: string; } & { version
: number; }>): Promise<ReleaseProps>; unpublish
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { releaseId
: string; } & { version
: number; }>): Promise<ReleaseActionProps<"unpublish">>; update
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { releaseId
: string; } & { version
: number; }>, data
: ReleasePayload): Promise<ReleaseProps>; validate
(params
: OptionalDefaults<GetReleaseParams>, data
?: ReleaseValidatePayload): Promise<ReleaseActionProps<"validate">>; }; releaseAction
: { get
(params
: Omit<GetReleaseParams, keyof DefaultParams> & Record<string, unknown> & { spaceId
?: string; } & { environmentId
?: string; } & { actionId
: string; }): Promise<ReleaseActionProps<any>>; getMany
(params
: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Record<string, unknown> & { spaceId
?: string; } & { environmentId
?: string; } & { query
?: ReleaseActionQueryOptions; }): Promise<CollectionProp<ReleaseActionProps<any>>>; queryForRelease
(params
: Omit<GetReleaseParams, keyof DefaultParams> & Record<string, unknown> & { spaceId
?: string; } & { environmentId
?: string; } & { query
?: ReleaseActionQueryOptions; }): Promise<CollectionProp<ReleaseActionProps<any>>>; }; role
: RolePlainClientAPI; scheduledActions
: { create
(params
: OptionalDefaults<GetSpaceParams>, data
: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>; delete
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { scheduledActionId
: string; }>): Promise<ScheduledActionProps>; get
(params
: Omit<GetSpaceParams, keyof DefaultParams> & Record<string, unknown> & { spaceId
?: string; } & { environmentId
: string; scheduledActionId
: string; }): Promise<ScheduledActionProps>; getMany
(params
: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CursorPaginatedCollectionProp<ScheduledActionProps>>; update
(params
: OptionalDefaults<GetSpaceParams & { scheduledActionId
: string; version
: number; }>, data
: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>; }; snapshot
: { getForContentType
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { contentTypeId
: string; } & { snapshotId
: string; }>): Promise<SnapshotProps<ContentTypeProps>>; getForEntry
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; } & { snapshotId
: string; }>): Promise<SnapshotProps<Omit<EntryProps<T>, "metadata">>>; getManyForContentType
(params
: OptionalDefaults<GetSpaceEnvironmentParams & { contentTypeId
: string; } & QueryParams>): Promise<CollectionProp<SnapshotProps<ContentTypeProps>>>; getManyForEntry
<T>(params
: OptionalDefaults<GetSpaceEnvironmentParams & { entryId
: string; } & QueryParams>): Promise<CollectionProp<SnapshotProps<Omit<EntryProps<T>, "metadata">>>>; }; space
: SpacePlainClientAPI; spaceMember
: SpaceMemberPlainClientAPI; spaceMembership
: SpaceMembershipPlainClientAPI; tag
: TagPlainClientAPI; task
: TaskPlainClientAPI; team
: TeamPlainClientAPI; teamMembership
: TeamMembershipPlainClientAPI; teamSpaceMembership
: TeamSpaceMembershipPlainClientAPI; uiConfig
: UIConfigPlainClientAPI; upload
: UploadPlainClientAPI; usage
: UsagePlainClientAPI; user
: UserPlainClientAPI; userUIConfig
: UserUIConfigPlainClientAPI; webhook
: WebhookPlainClientAPI; workflow
: WorkflowPlainClientAPI; workflowDefinition
: WorkflowDefinitionPlainClientAPI; workflowsChangelog
: WorkflowsChangelogPlainClientAPI; }
Type declaration
-
accessToken: {
createPersonalAccessToken(rawData: CreatePATProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AccessTokenProp>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<AccessTokenProp>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>;
}
-
createPersonalAccessToken:function
- createPersonalAccessToken(rawData: CreatePATProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AccessTokenProp>
-
Parameters
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
get:function
- get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>
-
Parameters
-
params: OptionalDefaults<{
tokenId: string;
}>
-
getMany:function
-
getManyForOrganization:function
-
revoke:function
- revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<AccessTokenProp>
-
Parameters
-
params: OptionalDefaults<{
tokenId: string;
}>
-
apiKey: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
createWithId(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
delete(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<ApiKeyProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<ApiKeyProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, rawData: ApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>;
}
-
create:function
- create(params: OptionalDefaults<GetSpaceParams>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>
-
Parameters
-
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
createWithId:function
- createWithId(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, data: CreateApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>
-
Parameters
-
params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
delete:function
- delete(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>): Promise<any>
-
Returns Promise<any>
-
get:function
-
getMany:function
-
update:function
- update(params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>, rawData: ApiKeyProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ApiKeyProps>
-
Parameters
-
params: OptionalDefaults<GetSpaceParams & {
apiKeyId: string;
}>
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
appAccessToken: AppAccessTokenPlainClientAPI
-
appAction: AppActionPlainClientAPI
-
appActionCall: AppActionCallPlainClientAPI
-
appBundle: AppBundlePlainClientAPI
-
appDefinition: AppDefinitionPlainClientAPI
-
appDetails: AppDetailsPlainClientAPI
-
appEventSubscription: AppEventSubscriptionPlainClientAPI
-
appInstallation: AppInstallationPlainClientAPI
-
appKey: AppKeyPlainClientAPI
-
appSignedRequest: AppSignedRequestPlainClientAPI
-
appSigningSecret: AppSigningSecretPlainClientAPI
-
appUpload: AppUploadPlainClientAPI
-
asset: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: CreateAssetProps): Promise<AssetProps>;
createFromFiles(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: Omit<AssetFileProp, "sys">): Promise<AssetProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: CreateAssetProps): Promise<AssetProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
} & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>;
processForAllLocales(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps): Promise<AssetProps>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>): Promise<AssetProps>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>;
}
-
archive:function
-
create:function
-
createFromFiles:function
-
createWithId:function
-
delete:function
-
get:function
- get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
} & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>
-
Parameters
-
-
Optional
rawData: unknown
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
getMany:function
- getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>
-
Parameters
-
-
Optional
rawData: unknown
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
getPublished:function
- getPublished(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<AssetProps>>
-
Parameters
-
-
Optional
rawData: unknown
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
processForAllLocales:function
-
processForLocale:function
- processForLocale(params: OptionalDefaults<GetSpaceEnvironmentParams>, asset: AssetProps, locale: string, processingOptions?: AssetProcessingForLocale): Promise<AssetProps>
-
Parameters
-
-
-
locale: string
-
Optional
processingOptions: AssetProcessingForLocale
-
publish:function
-
unarchive:function
-
unpublish:function
-
update:function
- update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
assetId: string;
}>, rawData: AssetProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<AssetProps>
-
Parameters
-
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
-
-
get:function
-
publish:function
-
unpublish:function
-
validate:function
-
comment: CommentPlainClientAPI
-
contentType: {
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, rawData: {
description: undefined | string;
displayField: undefined | string;
fields: ContentFields<KeyValueMap>[];
metadata: undefined | ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
createWithId(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: {
description: undefined | string;
displayField: undefined | string;
fields: ContentFields<KeyValueMap>[];
metadata: undefined | ContentTypeMetadata;
name: string;
}): Promise<ContentTypeProps>;
delete(params: OptionalDefaults<GetContentTypeParams>): Promise<any>;
get(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
} & QueryParams>): Promise<ContentTypeProps>;
getMany(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>): Promise<CollectionProp<ContentTypeProps>>;
omitAndDeleteField(params: OptionalDefaults<GetContentTypeParams>, contentType: ContentTypeProps, fieldId: string): Promise<ContentTypeProps>;
publish(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps): Promise<ContentTypeProps>;
unpublish(params: OptionalDefaults<GetContentTypeParams>): Promise<ContentTypeProps>;
update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ContentTypeProps>;
}
-
create:function
-
createWithId:function
-
delete:function
-
get:function
-
getMany:function
-
omitAndDeleteField:function
-
publish:function
-
unpublish:function
-
update:function
- update(params: OptionalDefaults<GetContentTypeParams>, rawData: ContentTypeProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<ContentTypeProps>
-
Parameters
-
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
editorInterface: EditorInterfacePlainClientAPI
-
entry: {
archive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
create<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
createWithId<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
contentTypeId: string;
entryId: string;
}>, rawData: CreateEntryProps<T>): Promise<EntryProps<T>>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<any>;
get<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
getMany<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
getPublished<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>;
patch<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: OpPatch[], headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
publish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>): Promise<EntryProps<T>>;
references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
include?: number;
}>): Promise<EntryReferenceProps>;
unarchive<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
unpublish<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>): Promise<EntryProps<T>>;
update<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>;
}
-
archive:function
-
create:function
-
createWithId:function
-
delete:function
-
get:function
- get<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>
-
Parameters
-
-
Optional
rawData: unknown
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
getMany:function
- getMany<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>
-
Parameters
-
-
Optional
rawData: unknown
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
getPublished:function
- getPublished<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & QueryParams>, rawData?: unknown, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CollectionProp<EntryProps<T>>>
-
Parameters
-
-
Optional
rawData: unknown
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
patch:function
- patch<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: OpPatch[], headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>
-
Parameters
-
-
rawData: OpPatch[]
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
publish:function
-
references:function
- references(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
include?: number;
}>): Promise<EntryReferenceProps>
-
Returns Promise<EntryReferenceProps>
-
unarchive:function
-
unpublish:function
-
update:function
- update<T>(params: OptionalDefaults<GetSpaceEnvironmentParams & {
entryId: string;
}>, rawData: EntryProps<T>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EntryProps<T>>
-
Parameters
-
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
environment: EnvironmentPlainClientAPI
-
environmentAlias: EnvironmentAliasPlainClientAPI
-
environmentTemplate: {
create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
delete(params: GetEnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
disconnect(params: EnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>;
get(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: {
select?: string;
};
version?: number;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
getMany(params: GetOrganizationParams & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateInstallationProps>;
update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
validate(params: EnvironmentTemplateParams & {
version?: number;
}, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateValidationProps<ValidationFinding>>;
versionUpdate(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
version: number;
}, rawData: {
versionDescription?: string;
versionName?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>;
versions(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>;
}
-
create:function
- create(params: GetOrganizationParams, rawData: CreateEnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>
-
Parameters
-
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
delete:function
- delete(params: GetEnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>
-
Parameters
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
Returns Promise<void>
-
disconnect:function
- disconnect(params: EnvironmentTemplateParams, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<void>
-
Parameters
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
Returns Promise<void>
-
get:function
- get(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: {
select?: string;
};
version?: number;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>
-
Parameters
-
params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: {
select?: string;
};
version?: number;
}
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
getMany:function
- getMany(params: GetOrganizationParams & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>
-
Parameters
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
install:function
- install(params: EnvironmentTemplateParams, rawData: CreateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateInstallationProps>
-
Parameters
-
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
update:function
- update(params: GetEnvironmentTemplateParams, rawData: EnvironmentTemplateProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>
-
Parameters
-
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
validate:function
- validate(params: EnvironmentTemplateParams & {
version?: number;
}, rawData: ValidateEnvironmentTemplateInstallationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateValidationProps<ValidationFinding>>
-
Parameters
-
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
versionUpdate:function
- versionUpdate(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
version: number;
}, rawData: {
versionDescription?: string;
versionName?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<EnvironmentTemplateProps>
-
Parameters
-
params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
version: number;
}
-
rawData: {
versionDescription?: string;
versionName?: string;
}
-
Optional
versionDescription?: string
-
Optional
versionName?: string
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
versions:function
- versions(params: GetOrganizationParams & {
environmentTemplateId: string;
} & {
query?: BasicCursorPaginationOptions & {
select?: string;
};
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateProps>>
-
Parameters
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
environmentTemplateInstallation: {
getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
installationId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
getMany(params: BasicCursorPaginationOptions & {
environmentId?: string;
environmentTemplateId: string;
organizationId: string;
spaceId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>;
}
-
getForEnvironment:function
- getForEnvironment(params: BasicCursorPaginationOptions & EnvironmentTemplateParams & {
installationId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>
-
Parameters
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
getMany:function
- getMany(params: BasicCursorPaginationOptions & {
environmentId?: string;
environmentTemplateId: string;
organizationId: string;
spaceId?: string;
}, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<CursorPaginatedCollectionProp<EnvironmentTemplateInstallationProps>>
-
Parameters
-
params: BasicCursorPaginationOptions & {
environmentId?: string;
environmentTemplateId: string;
organizationId: string;
spaceId?: string;
}
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
extension: ExtensionPlainClientAPI
-
-
locale: LocalePlainClientAPI
-
organization: OrganizationPlainClientAPI
-
organizationInvitation: {
create(params: OptionalDefaults<{
organizationId: string;
}>, data: CreateOrganizationInvitationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
get(params: OptionalDefaults<{
invitationId: string;
organizationId: string;
}>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>;
}
-
create:function
- create(params: OptionalDefaults<{
organizationId: string;
}>, data: CreateOrganizationInvitationProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>
-
Parameters
-
params: OptionalDefaults<{
organizationId: string;
}>
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
get:function
- get(params: OptionalDefaults<{
invitationId: string;
organizationId: string;
}>, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationInvitationProps>
-
Parameters
-
params: OptionalDefaults<{
invitationId: string;
organizationId: string;
}>
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
-
delete:function
-
get:function
-
getMany:function
-
update:function
- update(params: OptionalDefaults<GetOrganizationMembershipParams>, rawData: OrganizationMembershipProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<OrganizationMembershipProps>
-
Parameters
-
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
personalAccessToken: {
create(rawData: CreatePersonalAccessTokenProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<PersonalAccessTokenProp>;
get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProp>;
getMany(params: OptionalDefaults<QueryParams>): Promise<CollectionProp<PersonalAccessTokenProp>>;
revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProp>;
}
-
create:function
- create(rawData: CreatePersonalAccessTokenProps, headers?: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>): Promise<PersonalAccessTokenProp>
-
Parameters
-
-
Optional
headers: Partial<RawAxiosHeaders & {
Accept: AxiosHeaderValue;
Authorization: AxiosHeaderValue;
Content-Encoding: AxiosHeaderValue;
Content-Length: AxiosHeaderValue;
User-Agent: AxiosHeaderValue;
} & {
Content-Type: ContentType;
}>
-
get:function
- get(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProp>
-
Parameters
-
params: OptionalDefaults<{
tokenId: string;
}>
-
getMany:function
-
revoke:function
- revoke(params: OptionalDefaults<{
tokenId: string;
}>): Promise<PersonalAccessTokenProp>
-
Parameters
-
params: OptionalDefaults<{
tokenId: string;
}>
-
-
get:function
-
getMany:function
-
raw: {
delete<T>(url: string, config?: RawAxiosRequestConfig<any>): Promise<T>;
get<T>(url: string, config?: RawAxiosRequestConfig<any>): Promise<T>;
getDefaultParams(): undefined | DefaultParams;
http<T>(url: string, config?: RawAxiosRequestConfig<any>): Promise<T>;
patch<T>(url: string, payload?: any, config?: RawAxiosRequestConfig<any>): Promise<T>;
post<T>(url: string, payload?: any, config?: RawAxiosRequestConfig<any>): Promise<T>;
put<T>(url: string, payload?: any, config?: RawAxiosRequestConfig<any>): Promise<T>;
}
-
delete:function
- delete<T>(url: string, config?: RawAxiosRequestConfig<any>): Promise<T>
-
Parameters
-
url: string
-
Optional
config: RawAxiosRequestConfig<any>
Returns Promise<T>
-
get:function
- get<T>(url: string, config?: RawAxiosRequestConfig<any>): Promise<T>
-
Parameters
-
url: string
-
Optional
config: RawAxiosRequestConfig<any>
Returns Promise<T>
-
getDefaultParams:function
- getDefaultParams(): undefined | DefaultParams
-
Returns undefined | DefaultParams
-
http:function
- http<T>(url: string, config?: RawAxiosRequestConfig<any>): Promise<T>
-
Parameters
-
url: string
-
Optional
config: RawAxiosRequestConfig<any>
Returns Promise<T>
-
patch:function
- patch<T>(url: string, payload?: any, config?: RawAxiosRequestConfig<any>): Promise<T>
-
Parameters
-
url: string
-
Optional
payload: any
-
Optional
config: RawAxiosRequestConfig<any>
Returns Promise<T>
-
post:function
- post<T>(url: string, payload?: any, config?: RawAxiosRequestConfig<any>): Promise<T>
-
Parameters
-
url: string
-
Optional
payload: any
-
Optional
config: RawAxiosRequestConfig<any>
Returns Promise<T>
-
put:function
- put<T>(url: string, payload?: any, config?: RawAxiosRequestConfig<any>): Promise<T>
-
Parameters
-
url: string
-
Optional
payload: any
-
Optional
config: RawAxiosRequestConfig<any>
Returns Promise<T>
-
release: {
archive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: ReleasePayload): Promise<ReleaseProps>;
delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>;
get(params: OptionalDefaults<GetReleaseParams>): Promise<ReleaseProps>;
publish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"publish">>;
query(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Record<string, unknown> & {
spaceId?: string;
} & {
environmentId?: string;
} & {
query?: ReleaseQueryOptions;
}): Promise<CursorPaginatedCollectionProp<ReleaseProps>>;
unarchive(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseProps>;
unpublish(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>): Promise<ReleaseActionProps<"unpublish">>;
update(params: OptionalDefaults<GetSpaceEnvironmentParams & {
releaseId: string;
} & {
version: number;
}>, data: ReleasePayload): Promise<ReleaseProps>;
validate(params: OptionalDefaults<GetReleaseParams>, data?: ReleaseValidatePayload): Promise<ReleaseActionProps<"validate">>;
}
-
archive:function
-
create:function
-
delete:function
- delete(params: OptionalDefaults<GetReleaseParams>): Promise<void>
-
Returns Promise<void>
-
get:function
-
publish:function
-
query:function
-
unarchive:function
-
unpublish:function
-
update:function
-
validate:function
- validate(params: OptionalDefaults<GetReleaseParams>, data?: ReleaseValidatePayload): Promise<ReleaseActionProps<"validate">>
-
Parameters
-
-
Optional
data: ReleaseValidatePayload
-
releaseAction: {
get(params: Omit<GetReleaseParams, keyof DefaultParams> & Record<string, unknown> & {
spaceId?: string;
} & {
environmentId?: string;
} & {
actionId: string;
}): Promise<ReleaseActionProps<any>>;
getMany(params: Omit<GetSpaceEnvironmentParams, keyof DefaultParams> & Record<string, unknown> & {
spaceId?: string;
} & {
environmentId?: string;
} & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
queryForRelease(params: Omit<GetReleaseParams, keyof DefaultParams> & Record<string, unknown> & {
spaceId?: string;
} & {
environmentId?: string;
} & {
query?: ReleaseActionQueryOptions;
}): Promise<CollectionProp<ReleaseActionProps<any>>>;
}
-
get:function
- get(params: Omit<GetReleaseParams, keyof DefaultParams> & Record<string, unknown> & {
spaceId?: string;
} & {
environmentId?: string;
} & {
actionId: string;
}): Promise<ReleaseActionProps<any>>
-
Parameters
-
params: Omit<GetReleaseParams, keyof DefaultParams> & Record<string, unknown> & {
spaceId?: string;
} & {
environmentId?: string;
} & {
actionId: string;
}
-
getMany:function
-
queryForRelease:function
-
role: RolePlainClientAPI
-
scheduledActions: {
create(params: OptionalDefaults<GetSpaceParams>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
delete(params: OptionalDefaults<GetSpaceEnvironmentParams & {
scheduledActionId: string;
}>): Promise<ScheduledActionProps>;
get(params: Omit<GetSpaceParams, keyof DefaultParams> & Record<string, unknown> & {
spaceId?: string;
} & {
environmentId: string;
scheduledActionId: string;
}): Promise<ScheduledActionProps>;
getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CursorPaginatedCollectionProp<ScheduledActionProps>>;
update(params: OptionalDefaults<GetSpaceParams & {
scheduledActionId: string;
version: number;
}>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>;
}
-
create:function
-
delete:function
-
get:function
- get(params: Omit<GetSpaceParams, keyof DefaultParams> & Record<string, unknown> & {
spaceId?: string;
} & {
environmentId: string;
scheduledActionId: string;
}): Promise<ScheduledActionProps>
-
Parameters
-
params: Omit<GetSpaceParams, keyof DefaultParams> & Record<string, unknown> & {
spaceId?: string;
} & {
environmentId: string;
scheduledActionId: string;
}
-
getMany:function
-
update:function
- update(params: OptionalDefaults<GetSpaceParams & {
scheduledActionId: string;
version: number;
}>, data: CreateUpdateScheduledActionProps): Promise<ScheduledActionProps>
-
Parameters
-
params: OptionalDefaults<GetSpaceParams & {
scheduledActionId: string;
version: number;
}>
-
data: CreateUpdateScheduledActionProps
-
-
getForContentType:function
-
getForEntry:function
-
getManyForContentType:function
-
getManyForEntry:function
-
space: SpacePlainClientAPI
-
spaceMember: SpaceMemberPlainClientAPI
-
spaceMembership: SpaceMembershipPlainClientAPI
-
tag: TagPlainClientAPI
-
task: TaskPlainClientAPI
-
team: TeamPlainClientAPI
-
teamMembership: TeamMembershipPlainClientAPI
-
teamSpaceMembership: TeamSpaceMembershipPlainClientAPI
-
uiConfig: UIConfigPlainClientAPI
-
upload: UploadPlainClientAPI
-
usage: UsagePlainClientAPI
-
user: UserPlainClientAPI
-
userUIConfig: UserUIConfigPlainClientAPI
-
webhook: WebhookPlainClientAPI
-
workflow: WorkflowPlainClientAPI
-
workflowDefinition: WorkflowDefinitionPlainClientAPI
-
workflowsChangelog: WorkflowsChangelogPlainClientAPI