Skip to main content

Interface: operations

Defined in: packages/api-client/src/generated/api.ts:1895

Properties​

admin_action_collection_jobs_cancel_api_admin_jobs_actions_cancel_post​

admin_action_collection_jobs_cancel_api_admin_jobs_actions_cancel_post: object

Defined in: packages/api-client/src/generated/api.ts:3897

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_collection_sessions_revoke_api_admin_sessions_actions_revoke_post​

admin_action_collection_sessions_revoke_api_admin_sessions_actions_revoke_post: object

Defined in: packages/api-client/src/generated/api.ts:4230

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_global_credentials_delete_api_admin_global_credentials__item_id__actions_delete_post​

admin_action_item_global_credentials_delete_api_admin_global_credentials__item_id__actions_delete_post: object

Defined in: packages/api-client/src/generated/api.ts:3860

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_jobs_cancel_api_admin_jobs__item_id__actions_cancel_post​

admin_action_item_jobs_cancel_api_admin_jobs__item_id__actions_cancel_post: object

Defined in: packages/api-client/src/generated/api.ts:3934

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_jobs_retry_api_admin_jobs__item_id__actions_retry_post​

admin_action_item_jobs_retry_api_admin_jobs__item_id__actions_retry_post: object

Defined in: packages/api-client/src/generated/api.ts:3971

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_oauth_identities_delete_api_admin_oauth_identities__item_id__actions_delete_post​

admin_action_item_oauth_identities_delete_api_admin_oauth_identities__item_id__actions_delete_post: object

Defined in: packages/api-client/src/generated/api.ts:4008

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_projects_archive_api_admin_projects__item_id__actions_archive_post​

admin_action_item_projects_archive_api_admin_projects__item_id__actions_archive_post: object

Defined in: packages/api-client/src/generated/api.ts:4045

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_projects_delete_api_admin_projects__item_id__actions_delete_post​

admin_action_item_projects_delete_api_admin_projects__item_id__actions_delete_post: object

Defined in: packages/api-client/src/generated/api.ts:4082

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_projects_edit_state_api_admin_projects__item_id__actions_edit_state_post​

admin_action_item_projects_edit_state_api_admin_projects__item_id__actions_edit_state_post: object

Defined in: packages/api-client/src/generated/api.ts:4119

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_projects_trigger_tick_api_admin_projects__item_id__actions_trigger_tick_post​

admin_action_item_projects_trigger_tick_api_admin_projects__item_id__actions_trigger_tick_post: object

Defined in: packages/api-client/src/generated/api.ts:4156

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_projects_unarchive_api_admin_projects__item_id__actions_unarchive_post​

admin_action_item_projects_unarchive_api_admin_projects__item_id__actions_unarchive_post: object

Defined in: packages/api-client/src/generated/api.ts:4193

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_sessions_revoke_api_admin_sessions__item_id__actions_revoke_post​

admin_action_item_sessions_revoke_api_admin_sessions__item_id__actions_revoke_post: object

Defined in: packages/api-client/src/generated/api.ts:4267

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_telegram_links_unlink_api_admin_telegram_links__item_id__actions_unlink_post​

admin_action_item_telegram_links_unlink_api_admin_telegram_links__item_id__actions_unlink_post: object

Defined in: packages/api-client/src/generated/api.ts:4304

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_users_change_role_api_admin_users__item_id__actions_change_role_post​

admin_action_item_users_change_role_api_admin_users__item_id__actions_change_role_post: object

Defined in: packages/api-client/src/generated/api.ts:4341

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_users_delete_api_admin_users__item_id__actions_delete_post​

admin_action_item_users_delete_api_admin_users__item_id__actions_delete_post: object

Defined in: packages/api-client/src/generated/api.ts:4378

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_users_delete_preview_api_admin_users__item_id__actions_delete_preview_post​

admin_action_item_users_delete_preview_api_admin_users__item_id__actions_delete_preview_post: object

Defined in: packages/api-client/src/generated/api.ts:4415

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_users_grant_admin_api_admin_users__item_id__actions_grant_admin_post​

admin_action_item_users_grant_admin_api_admin_users__item_id__actions_grant_admin_post: object

Defined in: packages/api-client/src/generated/api.ts:4452

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_users_revoke_admin_api_admin_users__item_id__actions_revoke_admin_post​

admin_action_item_users_revoke_admin_api_admin_users__item_id__actions_revoke_admin_post: object

Defined in: packages/api-client/src/generated/api.ts:4489

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_users_revoke_sessions_api_admin_users__item_id__actions_revoke_sessions_post​

admin_action_item_users_revoke_sessions_api_admin_users__item_id__actions_revoke_sessions_post: object

Defined in: packages/api-client/src/generated/api.ts:4526

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_action_item_users_update_name_api_admin_users__item_id__actions_update_name_post​

admin_action_item_users_update_name_api_admin_users__item_id__actions_update_name_post: object

Defined in: packages/api-client/src/generated/api.ts:4563

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: {[key: string]: unknown; } | null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_admin_grants_api_admin_admin_grants__item_id__get​

admin_get_admin_grants_api_admin_admin_grants__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3070

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_audit_log_api_admin_audit_log__item_id__get​

admin_get_audit_log_api_admin_audit_log__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3622

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_global_credentials_api_admin_global_credentials__item_id__get​

admin_get_global_credentials_api_admin_global_credentials__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3139

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_jobs_api_admin_jobs__item_id__get​

admin_get_jobs_api_admin_jobs__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3691

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_oauth_identities_api_admin_oauth_identities__item_id__get​

admin_get_oauth_identities_api_admin_oauth_identities__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3208

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_outbound_messages_api_admin_outbound_messages__item_id__get​

admin_get_outbound_messages_api_admin_outbound_messages__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3760

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_projects_api_admin_projects__item_id__get​

admin_get_projects_api_admin_projects__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3553

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_runtime_correlations_api_admin_runtime_correlations__item_id__get​

admin_get_runtime_correlations_api_admin_runtime_correlations__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3829

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_sessions_api_admin_sessions__item_id__get​

admin_get_sessions_api_admin_sessions__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3277

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_telegram_links_api_admin_telegram_links__item_id__get​

admin_get_telegram_links_api_admin_telegram_links__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3346

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_users_api_admin_users__item_id__get​

admin_get_users_api_admin_users__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3415

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_get_workspaces_api_admin_workspaces__item_id__get​

admin_get_workspaces_api_admin_workspaces__item_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3484

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.item_id​

item_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_google_callback_api_admin_auth_google_callback_get​

admin_google_callback_api_admin_auth_google_callback_get: object

Defined in: packages/api-client/src/generated/api.ts:2864

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.code?​

optional code?: string | null

parameters.query.error?​

optional error?: string | null

parameters.query.state?​

optional state?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_google_login_api_admin_auth_google_login_get​

admin_google_login_api_admin_auth_google_login_get: object

Defined in: packages/api-client/src/generated/api.ts:2844

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_grant_api_testing_admin_grant_post​

admin_grant_api_testing_admin_grant_post: object

Defined in: packages/api-client/src/generated/api.ts:2770

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: object

parameters.header.X-Bloom-Test-Login-Password?​

optional X-Bloom-Test-Login-Password?: string | null

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody​

requestBody: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: object

requestBody.content.application/json.email​

email: string

Email

requestBody.content.application/json.role​

role: "viewer" | "operator" | "superadmin"

Default​
viewer

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: string

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_admin_grants_api_admin_admin_grants_get​

admin_list_admin_grants_api_admin_admin_grants_get: object

Defined in: packages/api-client/src/generated/api.ts:3032

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_audit_log_api_admin_audit_log_get​

admin_list_audit_log_api_admin_audit_log_get: object

Defined in: packages/api-client/src/generated/api.ts:3584

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_global_credentials_api_admin_global_credentials_get​

admin_list_global_credentials_api_admin_global_credentials_get: object

Defined in: packages/api-client/src/generated/api.ts:3101

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_jobs_api_admin_jobs_get​

admin_list_jobs_api_admin_jobs_get: object

Defined in: packages/api-client/src/generated/api.ts:3653

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_oauth_identities_api_admin_oauth_identities_get​

admin_list_oauth_identities_api_admin_oauth_identities_get: object

Defined in: packages/api-client/src/generated/api.ts:3170

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_outbound_messages_api_admin_outbound_messages_get​

admin_list_outbound_messages_api_admin_outbound_messages_get: object

Defined in: packages/api-client/src/generated/api.ts:3722

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_projects_api_admin_projects_get​

admin_list_projects_api_admin_projects_get: object

Defined in: packages/api-client/src/generated/api.ts:3515

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_runtime_correlations_api_admin_runtime_correlations_get​

admin_list_runtime_correlations_api_admin_runtime_correlations_get: object

Defined in: packages/api-client/src/generated/api.ts:3791

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_sessions_api_admin_sessions_get​

admin_list_sessions_api_admin_sessions_get: object

Defined in: packages/api-client/src/generated/api.ts:3239

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_telegram_links_api_admin_telegram_links_get: object

Defined in: packages/api-client/src/generated/api.ts:3308

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_users_api_admin_users_get​

admin_list_users_api_admin_users_get: object

Defined in: packages/api-client/src/generated/api.ts:3377

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_list_workspaces_api_admin_workspaces_get​

admin_list_workspaces_api_admin_workspaces_get: object

Defined in: packages/api-client/src/generated/api.ts:3446

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.filter?​

optional filter?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.order?​

optional order?: "asc" | "desc"

parameters.query.q?​

optional q?: string | null

parameters.query.sort?​

optional sort?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_logout_api_admin_auth_logout_post​

admin_logout_api_admin_auth_logout_post: object

Defined in: packages/api-client/src/generated/api.ts:2897

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_me_api_admin_me_get​

admin_me_api_admin_me_get: object

Defined in: packages/api-client/src/generated/api.ts:2917

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

admin_overview_api_admin_overview_get​

admin_overview_api_admin_overview_get: object

Defined in: packages/api-client/src/generated/api.ts:2939

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

auth_config_api_auth_config_get​

auth_config_api_auth_config_get: object

Defined in: packages/api-client/src/generated/api.ts:2059

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

responses.200.content.application/json.adminUrl​

adminUrl: string | null

Adminurl

Description​

The admin dashboard origin, when this deployment has one (BLOOM_ADMIN_DASHBOARD_URL).

responses.200.content.application/json.google​

google: boolean

Google

responses.200.content.application/json.testLogin​

testLogin: boolean

Testlogin

responses.200.content.application/json.testLoginRequiresPassword​

testLoginRequiresPassword: boolean

Testloginrequirespassword

Description​

Test-login demands the per-PR shared password (hardened previews, #346 follow-up).

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

create_link_api_telegram_link_post​

create_link_api_telegram_link_post: object

Defined in: packages/api-client/src/generated/api.ts:2227

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

responses.200.content.application/json.code​

code: string

Code

optional deep_link?: string | null

Deep Link

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

create_project_api_projects_post​

create_project_api_projects_post: object

Defined in: packages/api-client/src/generated/api.ts:2285

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: { message?: string | null; repo?: string | null; } | null

Union Members​
Type Literal​

{ message?: string | null; repo?: string | null; }

message?​

optional message?: string | null

Message

repo?​

optional repo?: string | null

Repo

Description​

An optional owner/name slug naming the EXISTING repository to adopt as the project target (M44 #867, TS-forward). Absent, null, or blank means the greenfield default; a value that is not an owner/name pair, or that resolves to a repo Bloom cannot access, is a 422.

null

responses​

responses: object

responses.201​

201: object

Description​

Successful Response

responses.201.content​

content: object

responses.201.content.application/json​

application/json: object

responses.201.content.application/json.blocked?​

optional blocked?: string[]

Blocked

responses.201.content.application/json.issues_closed​

issues_closed: number

Issues Closed

Default​
0
responses.201.content.application/json.issues_open​

issues_open: number

Issues Open

Default​
0
responses.201.content.application/json.last_checked_at?​

optional last_checked_at?: string | null

Last Checked At

responses.201.content.application/json.live_status_available​

live_status_available: boolean

Live Status Available

Default​
true
responses.201.content.application/json.live_url?​

optional live_url?: string | null

Live Url

responses.201.content.application/json.milestones_closed​

milestones_closed: number

Milestones Closed

Default​
0
responses.201.content.application/json.milestones_open​

milestones_open: number

Milestones Open

Default​
0
responses.201.content.application/json.needs_attention?​

optional needs_attention?: string[]

Needs Attention

responses.201.content.application/json.next_check_at?​

optional next_check_at?: string | null

Next Check At

responses.201.content.application/json.phase​

phase: string

Phase

responses.201.content.application/json.prd_revision​

prd_revision: number

Prd Revision

Default​
0
responses.201.content.application/json.prd_status​

prd_status: string

Prd Status

Default​
draft
responses.201.content.application/json.pull_requests_open​

pull_requests_open: number

Pull Requests Open

Default​
0
responses.201.content.application/json.repo_url?​

optional repo_url?: string | null

Repo Url

responses.201.content.application/json.thread_id​

thread_id: string

Thread Id

responses.201.content.application/json.title​

title: string

Title

responses.201.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

delete_credential_api_projects__thread_id__credentials__name__delete​

delete_credential_api_projects__thread_id__credentials__name__delete: object

Defined in: packages/api-client/src/generated/api.ts:2586

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.name​

name: string

parameters.path.thread_id​

thread_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.204​

204: object

Description​

Successful Response

responses.204.content?​

optional content?: undefined

responses.204.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

delete_global_credential_api_credentials__name__delete​

delete_global_credential_api_credentials__name__delete: object

Defined in: packages/api-client/src/generated/api.ts:2669

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.name​

name: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.204​

204: object

Description​

Successful Response

responses.204.content?​

optional content?: undefined

responses.204.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

delete_link_api_telegram_link_delete: object

Defined in: packages/api-client/src/generated/api.ts:2247

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.204​

204: object

Description​

Successful Response

responses.204.content?​

optional content?: undefined

responses.204.headers​

headers: object

Index Signature​

[name: string]: unknown

get_audit_entry_api_admin_audit_log__entry_id__get​

get_audit_entry_api_admin_audit_log__entry_id__get: object

Defined in: packages/api-client/src/generated/api.ts:3001

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.entry_id​

entry_id: number

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

get_link_api_telegram_link_get: object

Defined in: packages/api-client/src/generated/api.ts:2207

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

responses.200.content.application/json.linked​

linked: boolean

Linked

responses.200.content.application/json.telegram_user_id?​

optional telegram_user_id?: number | null

Telegram User Id

responses.200.content.application/json.verified​

verified: boolean

Verified

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

get_messages_api_projects__thread_id__messages_get​

get_messages_api_projects__thread_id__messages_get: object

Defined in: packages/api-client/src/generated/api.ts:2393

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.thread_id​

thread_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object[]

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

get_project_api_projects__thread_id__get​

get_project_api_projects__thread_id__get: object

Defined in: packages/api-client/src/generated/api.ts:2318

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.thread_id​

thread_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

responses.200.content.application/json.children?​

optional children?: object[]

Children

responses.200.content.application/json.graph​

graph: object

responses.200.content.application/json.graph.edges?​

optional edges?: object[]

Edges

responses.200.content.application/json.graph.nodes?​

optional nodes?: object[]

Nodes

responses.200.content.application/json.milestones?​

optional milestones?: object[]

Milestones

responses.200.content.application/json.overview​

overview: object

responses.200.content.application/json.overview.blocked?​

optional blocked?: string[]

Blocked

responses.200.content.application/json.overview.issues_closed​

issues_closed: number

Issues Closed

Default​
0
responses.200.content.application/json.overview.issues_open​

issues_open: number

Issues Open

Default​
0
responses.200.content.application/json.overview.last_checked_at?​

optional last_checked_at?: string | null

Last Checked At

responses.200.content.application/json.overview.live_status_available​

live_status_available: boolean

Live Status Available

Default​
true
responses.200.content.application/json.overview.live_url?​

optional live_url?: string | null

Live Url

responses.200.content.application/json.overview.milestones_closed​

milestones_closed: number

Milestones Closed

Default​
0
responses.200.content.application/json.overview.milestones_open​

milestones_open: number

Milestones Open

Default​
0
responses.200.content.application/json.overview.needs_attention?​

optional needs_attention?: string[]

Needs Attention

responses.200.content.application/json.overview.next_check_at?​

optional next_check_at?: string | null

Next Check At

responses.200.content.application/json.overview.phase​

phase: string

Phase

responses.200.content.application/json.overview.prd_revision​

prd_revision: number

Prd Revision

Default​
0
responses.200.content.application/json.overview.prd_status​

prd_status: string

Prd Status

Default​
draft
responses.200.content.application/json.overview.pull_requests_open​

pull_requests_open: number

Pull Requests Open

Default​
0
responses.200.content.application/json.overview.repo_url?​

optional repo_url?: string | null

Repo Url

responses.200.content.application/json.overview.thread_id​

thread_id: string

Thread Id

responses.200.content.application/json.overview.title​

title: string

Title

responses.200.content.application/json.specialist_reviews?​

optional specialist_reviews?: object[]

Specialist Reviews

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

github_app_setup_webhooks_github_setup_get​

github_app_setup_webhooks_github_setup_get: object

Defined in: packages/api-client/src/generated/api.ts:1982

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query​

query: object

parameters.query.installation_id​

installation_id: number

parameters.query.setup_action?​

optional setup_action?: string | null

parameters.query.state?​

optional state?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.text/html​

text/html: string

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

github_webhook_webhooks_github_post​

github_webhook_webhooks_github_post: object

Defined in: packages/api-client/src/generated/api.ts:2015

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

gitlab_webhook_webhooks_gitlab_post​

gitlab_webhook_webhooks_gitlab_post: object

Defined in: packages/api-client/src/generated/api.ts:2037

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

google_callback_api_auth_google_callback_get​

google_callback_api_auth_google_callback_get: object

Defined in: packages/api-client/src/generated/api.ts:2099

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.code?​

optional code?: string | null

parameters.query.error?​

optional error?: string | null

parameters.query.state?​

optional state?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

google_login_api_auth_google_login_get​

google_login_api_auth_google_login_get: object

Defined in: packages/api-client/src/generated/api.ts:2079

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

health_health_get​

health_health_get: object

Defined in: packages/api-client/src/generated/api.ts:1896

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

list_audit_log_api_admin_audit_log_get​

list_audit_log_api_admin_audit_log_get: object

Defined in: packages/api-client/src/generated/api.ts:2961

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: object

parameters.query.action?​

optional action?: string | null

parameters.query.actor_id?​

optional actor_id?: string | null

parameters.query.limit?​

optional limit?: number

parameters.query.offset?​

optional offset?: number

parameters.query.outcome?​

optional outcome?: "error" | "ok" | "denied" | null

parameters.query.resource?​

optional resource?: string | null

parameters.query.since?​

optional since?: string | null

parameters.query.until?​

optional until?: string | null

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

list_credentials_api_projects__thread_id__credentials_get​

list_credentials_api_projects__thread_id__credentials_get: object

Defined in: packages/api-client/src/generated/api.ts:2521

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.thread_id​

thread_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

responses.200.content.application/json.configured​

configured: boolean

Configured

responses.200.content.application/json.credentials​

credentials: object[]

Credentials

responses.200.content.application/json.required​

required: string[]

Required

responses.200.content.application/json.suggested_names​

suggested_names: string[]

Suggested Names

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

list_global_credentials_api_credentials_get​

list_global_credentials_api_credentials_get: object

Defined in: packages/api-client/src/generated/api.ts:2616

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

responses.200.content.application/json.configured​

configured: boolean

Configured

responses.200.content.application/json.credentials​

credentials: object[]

Credentials

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

list_projects_api_projects_get​

list_projects_api_projects_get: object

Defined in: packages/api-client/src/generated/api.ts:2265

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object[]

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

logout_api_auth_logout_post​

logout_api_auth_logout_post: object

Defined in: packages/api-client/src/generated/api.ts:2187

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

me_api_auth_me_get​

me_api_auth_me_get: object

Defined in: packages/api-client/src/generated/api.ts:2132

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

responses.200.content.application/json.email​

email: string

Email

responses.200.content.application/json.id​

id: string

Id

responses.200.content.application/json.isAdmin​

isAdmin: boolean

Isadmin

Description​

Server-derived capability boolean (an admin grant exists); it grants nothing itself.

responses.200.content.application/json.name​

name: string | null

Name

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

metrics_metrics_get​

metrics_metrics_get: object

Defined in: packages/api-client/src/generated/api.ts:1918

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: object

parameters.header.authorization?​

optional authorization?: string | null

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

post_message_api_projects__thread_id__messages_post​

post_message_api_projects__thread_id__messages_post: object

Defined in: packages/api-client/src/generated/api.ts:2424

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.thread_id​

thread_id: string

parameters.query?​

optional query?: undefined

requestBody​

requestBody: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: object

requestBody.content.application/json.message​

message: string

Message

responses​

responses: object

responses.201​

201: object

Description​

Successful Response

responses.201.content​

content: object

responses.201.content.application/json​

application/json: object[]

responses.201.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

project_events_api_projects__thread_id__events_get​

project_events_api_projects__thread_id__events_get: object

Defined in: packages/api-client/src/generated/api.ts:2490

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.thread_id​

thread_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

project_timeline_api_projects__thread_id__timeline_get​

project_timeline_api_projects__thread_id__timeline_get: object

Defined in: packages/api-client/src/generated/api.ts:2459

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.thread_id​

thread_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object[]

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

put_credential_api_projects__thread_id__credentials__name__put​

put_credential_api_projects__thread_id__credentials__name__put: object

Defined in: packages/api-client/src/generated/api.ts:2552

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.name​

name: string

parameters.path.thread_id​

thread_id: string

parameters.query?​

optional query?: undefined

requestBody​

requestBody: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: object

requestBody.content.application/json.value​

value: string

Value

responses​

responses: object

responses.204​

204: object

Description​

Successful Response

responses.204.content?​

optional content?: undefined

responses.204.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

put_global_credential_api_credentials__name__put​

put_global_credential_api_credentials__name__put: object

Defined in: packages/api-client/src/generated/api.ts:2636

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.name​

name: string

parameters.query?​

optional query?: undefined

requestBody​

requestBody: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: object

requestBody.content.application/json.value​

value: string

Value

responses​

responses: object

responses.204​

204: object

Description​

Successful Response

responses.204.content?​

optional content?: undefined

responses.204.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

rename_project_api_projects__thread_id__patch​

rename_project_api_projects__thread_id__patch: object

Defined in: packages/api-client/src/generated/api.ts:2349

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: undefined

parameters.path​

path: object

parameters.path.thread_id​

thread_id: string

parameters.query?​

optional query?: undefined

requestBody​

requestBody: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: object

requestBody.content.application/json.name​

name: string

Name

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

responses.200.content.application/json.children?​

optional children?: object[]

Children

responses.200.content.application/json.graph​

graph: object

responses.200.content.application/json.graph.edges?​

optional edges?: object[]

Edges

responses.200.content.application/json.graph.nodes?​

optional nodes?: object[]

Nodes

responses.200.content.application/json.milestones?​

optional milestones?: object[]

Milestones

responses.200.content.application/json.overview​

overview: object

responses.200.content.application/json.overview.blocked?​

optional blocked?: string[]

Blocked

responses.200.content.application/json.overview.issues_closed​

issues_closed: number

Issues Closed

Default​
0
responses.200.content.application/json.overview.issues_open​

issues_open: number

Issues Open

Default​
0
responses.200.content.application/json.overview.last_checked_at?​

optional last_checked_at?: string | null

Last Checked At

responses.200.content.application/json.overview.live_status_available​

live_status_available: boolean

Live Status Available

Default​
true
responses.200.content.application/json.overview.live_url?​

optional live_url?: string | null

Live Url

responses.200.content.application/json.overview.milestones_closed​

milestones_closed: number

Milestones Closed

Default​
0
responses.200.content.application/json.overview.milestones_open​

milestones_open: number

Milestones Open

Default​
0
responses.200.content.application/json.overview.needs_attention?​

optional needs_attention?: string[]

Needs Attention

responses.200.content.application/json.overview.next_check_at?​

optional next_check_at?: string | null

Next Check At

responses.200.content.application/json.overview.phase​

phase: string

Phase

responses.200.content.application/json.overview.prd_revision​

prd_revision: number

Prd Revision

Default​
0
responses.200.content.application/json.overview.prd_status​

prd_status: string

Prd Status

Default​
draft
responses.200.content.application/json.overview.pull_requests_open​

pull_requests_open: number

Pull Requests Open

Default​
0
responses.200.content.application/json.overview.repo_url?​

optional repo_url?: string | null

Repo Url

responses.200.content.application/json.overview.thread_id​

thread_id: string

Thread Id

responses.200.content.application/json.overview.title​

title: string

Title

responses.200.content.application/json.specialist_reviews?​

optional specialist_reviews?: object[]

Specialist Reviews

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.409​

409: object

Description​

The project cannot be renamed: it is archived or deleted (a machine-readable detail token, project_archived or project_deleted), or a concurrent orchestrator turn won the compare-and-swap (the reload-and-retry sentence).

responses.409.content​

content: object

responses.409.content.application/json​

application/json: object

responses.409.content.application/json.detail​

detail: string

Detail

Description​

A machine-readable conflict token: project_archived or project_deleted when the project is retired (the web maps each to a sentence), or the compare-and-swap message "the project changed since it was read; reload and retry" when a concurrent orchestrator turn won the race.

responses.409.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

reset_data_api_testing_data_delete​

reset_data_api_testing_data_delete: object

Defined in: packages/api-client/src/generated/api.ts:2807

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: object

parameters.header.X-Bloom-Test-Login-Password?​

optional X-Bloom-Test-Login-Password?: string | null

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: { chat_ids?: number[]; } | null

Union Members​
Type Literal​

{ chat_ids?: number[]; }

chat_ids?​

optional chat_ids?: number[]

Chat Ids

null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: number

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

seed_project_api_testing_project_post​

seed_project_api_testing_project_post: object

Defined in: packages/api-client/src/generated/api.ts:2698

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: object

parameters.header.X-Bloom-Test-Login-Password?​

optional X-Bloom-Test-Login-Password?: string | null

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody​

requestBody: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: object

requestBody.content.application/json.chat_id​

chat_id: number

Chat Id

requestBody.content.application/json.emit?​

optional emit?: { data?: {[key: string]: unknown; }; type: string; } | null

Union Members​
Type Literal​

{ data?: {[key: string]: unknown; }; type: string; }

data?​

optional data?: object

Data

Index Signature​

[key: string]: unknown

type​

type: string

Type

null

requestBody.content.application/json.state?​

optional state?: {[key: string]: unknown; } | null

State

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: string

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

subscriber_count_api_testing_project__thread_id__subscribers_get​

subscriber_count_api_testing_project__thread_id__subscribers_get: object

Defined in: packages/api-client/src/generated/api.ts:2735

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: object

parameters.header.X-Bloom-Test-Login-Password?​

optional X-Bloom-Test-Login-Password?: string | null

parameters.path​

path: object

parameters.path.thread_id​

thread_id: string

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: number

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

telegram_webhook_webhooks_telegram_post​

telegram_webhook_webhooks_telegram_post: object

Defined in: packages/api-client/src/generated/api.ts:1949

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: object

parameters.header.X-Telegram-Bot-Api-Secret-Token?​

optional X-Telegram-Bot-Api-Secret-Token?: string | null

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: undefined

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

Index Signature​

[key: string]: unknown

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown

test_login_api_auth_test_login_post​

test_login_api_auth_test_login_post: object

Defined in: packages/api-client/src/generated/api.ts:2152

parameters​

parameters: object

parameters.cookie?​

optional cookie?: undefined

parameters.header?​

optional header?: object

parameters.header.X-Bloom-Test-Login-Password?​

optional X-Bloom-Test-Login-Password?: string | null

parameters.path?​

optional path?: undefined

parameters.query?​

optional query?: undefined

requestBody?​

optional requestBody?: object

requestBody.content​

content: object

requestBody.content.application/json​

application/json: { email?: string | null; name?: string | null; } | null

Union Members​
Type Literal​

{ email?: string | null; name?: string | null; }

email?​

optional email?: string | null

Email

name?​

optional name?: string | null

Name

null

responses​

responses: object

responses.200​

200: object

Description​

Successful Response

responses.200.content​

content: object

responses.200.content.application/json​

application/json: object

responses.200.content.application/json.email​

email: string

Email

responses.200.content.application/json.id​

id: string

Id

responses.200.content.application/json.isAdmin​

isAdmin: boolean

Isadmin

Description​

Server-derived capability boolean (an admin grant exists); it grants nothing itself.

responses.200.content.application/json.name​

name: string | null

Name

responses.200.headers​

headers: object

Index Signature​

[name: string]: unknown

responses.422​

422: object

Description​

Validation Error

responses.422.content​

content: object

responses.422.content.application/json​

application/json: object

responses.422.content.application/json.detail?​

optional detail?: object[]

Detail

responses.422.headers​

headers: object

Index Signature​

[name: string]: unknown