Kaiten Client

Контракты интеграций ​

Здесь перечислены экспорты за пределами REST и SCIM. Полные структуры доступны в TypeScript-объявлениях пакета.

Исходящие вебхуки ​

@2chevskii/kaiten-client/webhooks · KaitenWebhookEvent

СобытиеТипДокументация
block:addBlockAddWebhookEventKaiten
block:updateBlockUpdateWebhookEventKaiten
board:addBoardAddWebhookEventKaiten
board:updateBoardUpdateWebhookEventKaiten
card_member:addCardMemberAddWebhookEventKaiten
card_member:removeCardMemberRemoveWebhookEventKaiten
card_member:updateCardMemberUpdateWebhookEventKaiten
card:addCardAddWebhookEventKaiten
card:updateCardUpdateWebhookEventKaiten
comment:addCommentAddWebhookEventKaiten
comment:removeCommentRemoveWebhookEventKaiten
comment:updateCommentUpdateWebhookEventKaiten
file:addFileAddWebhookEventKaiten
file:removeFileRemoveWebhookEventKaiten
file:updateFileUpdateWebhookEventKaiten
space:updateSpaceUpdateWebhookEventKaiten
tag:addTagAddWebhookEventKaiten
tag:removeTagRemoveWebhookEventKaiten
tag:updateTagUpdateWebhookEventKaiten
card_time_log:addTimelogAddWebhookEventKaiten
card_time_log:removeTimelogRemoveWebhookEventKaiten
card_time_log:updateTimelogUpdateWebhookEventKaiten

Файлы импорта ​

@2chevskii/kaiten-client/imports · ImportEntityName · ImportColor

ФайлТип записиДокументация
boardsImportBoardsRecordKaiten
card-timersImportCardTimersRecordKaiten
cardsImportCardsRecordKaiten
columnsImportColumnsRecordKaiten
columns-mappingImportColumnsMappingRecordKaiten
commentsImportCommentsRecordKaiten
custom-fieldsImportCustomFieldsRecordKaiten
document-filesImportDocumentFilesRecordKaiten
documentsImportDocumentsRecordKaiten
filesImportFilesRecordKaiten
foldersImportFoldersRecordKaiten
meta-dataImportMetaDataRecordKaiten
properties-mappingImportPropertiesMappingRecordKaiten
spacesImportSpacesRecordKaiten
usersImportUsersRecordKaiten

Метаданные пользователя ​

@2chevskii/kaiten-client/metadata экспортирует UserMetadataRequest, UserMetadataResponse, UserMetadataPropertyValue и UserMetadataHandler. См. руководство.

Аддоны ​

@2chevskii/kaiten-client/addons экспортирует объявления браузерного SDK: KaitenAddonSdk, AddonCapabilities, AddonContext, AddonPlatformApiClient, AddonPopupOptions, AddonDialogOptions и связанные типы. @2chevskii/kaiten-client/addon-oauth экспортирует AddonOAuthClient, AddonOAuthOptions, AddonTokenKey и AddonTokenResponse; методы getToken и refreshToken описаны в руководстве.