Interface: operations

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

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:3816

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:4149

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:3779

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:3853

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:3890

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:3927

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:3964

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:4001

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:4038

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:4075

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:4112

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:4186

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:4223

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:4260

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:4297

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:4334

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:4371

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:4408

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:4445

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:4482

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:2989

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:3541

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:3058

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:3610

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:3127

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:3679

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:3472

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:3748

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:3196

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:3265

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:3334

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:3403

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:2783

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:2763

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:2689

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:2951

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:3503

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:3020

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:3572

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:3089

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:3641

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:3434

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:3710

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:3158

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

admin_list_telegram_links_api_admin_telegram_links_get: object

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

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:3296

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:3365

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:2816

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:2836

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:2858

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:2022

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:2190

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

responses.200.content.application/json.deep_link?

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:2248

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; } | null

Union Members

Type Literal

{ message?: string | null; }

message?

optional message?: string | null

Message

---

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:2505

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:2588

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

delete_link_api_telegram_link_delete: object

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

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:2920

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

get_link_api_telegram_link_get: object

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

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:2312

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:2281

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:1945

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:1978

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:2000

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:2062

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:2042

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:1859

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:2880

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:2440

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:2535

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:2228

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:2150

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:2095

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:1881

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:2343

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:2409

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:2378

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:2471

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:2555

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

---

reset_data_api_testing_data_delete

reset_data_api_testing_data_delete: object

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

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:2617

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:2654

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:1912

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:2115

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