REST API: все операции

Операции сгруппированы по ресурсам клиента. Имена методов и типов совпадают с экспортами пакета. Для вложенных полей и точных TypeScript-типов используйте подсказки редактора. Ссылки ведут на первичную документацию Kaiten.

cards.iterate, documents.iterate и documentGroups.iterate обеспечивают автоматическую пагинацию соответствующих поисковых операций. Примеры — в руководстве по пагинации и типизированным фильтрам.

users.iterate и tags.iterate перебирают списки с пагинацией через смещение. Примеры — в разделе пользователей и тегов.

Маршруты здесь приведены в версии, указанной в документации Kaiten. REST-клиент использует /api/v1 по умолчанию; apiVersion: "latest" переключает префикс на /api/latest.

auditLogs · automations · boards · cardAllowedUsers · cardBlockerCategories · cardBlockerUsers · cardBlockers · cardChecklistItems · cardChecklists · cardChildren · cardComments · cardExternalLinks · cardFiles · cardMembers · cardServiceDeskExternalRecipients · cardSla · cardTags · cardTimeLogs · cardTypeTreeEntities · cardTypes · cards · checklistItems · checklists · columns · companyUsers · customDirectories · customDirectoryFields · customDirectoryRecords · customProperties · customPropertyCatalogValues · customPropertyCollectiveScoreValues · customPropertyCollectiveVoteValues · customPropertySelectValues · customPropertyTreeEntities · documentGroups · documentSchemas · documents · groupAdmins · groupEntities · groupUsers · groups · iterations · lanes · restrictedAccessCardFiles · restrictedAccessCommentFiles · restrictedAccessCustomPropertyFiles · serviceDeskServices · spaceBoards · spaceTemplateChecklistItems · spaceTemplateChecklist · spaceUsers · spaces · sprints · subcolumn · tags · timesheet · treeEntities · treeEntityRoles · userRoles · users

auditLogs

retrieveAuditLogEvents

client.auditLogs.retrieveAuditLogEvents · GET /api/latest/audit-logs

Retrieve audit log events. Документация Kaiten.

...args: AuditLogsRetrieveAuditLogEventsParams

declare const retrieveAuditLogEvents: (
  query?: AuditLogsRetrieveAuditLogEventsQuery,
  options?: OperationOptions,
) => Promise<AuditLogsRetrieveAuditLogEventsResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`from`	string	Необязательно
`to`	string	Необязательно
`author_id`	integer	Необязательно
`author_uid`	string	Необязательно
`categories`	string	Необязательно
`actions`	string	Необязательно
`id`	string	Необязательно
`limit`	integer	Необязательно
`offset`	integer	Необязательно

Ответ: Массив. Поля: id, app_name, company_uid, author_id, author_uid, author_username, author_remote_address, author, category, action, message, details, created.

automations

createAutomation

client.automations.createAutomation · POST /api/latest/spaces/{space_id}/automations

Create automation. Документация Kaiten.

...args: AutomationsCreateAutomationParams

declare const createAutomation: (
  spaceId: number,
  body: AutomationsCreateAutomationBody,
  options?: OperationOptions,
) => Promise<AutomationsCreateAutomationResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`type`	on_action \| on_date \| on_demand	Обязательно
`name`	string	Необязательно
`trigger`	AutomationTrigger	Необязательно
`conditions`	AutomationConditionGroup	Необязательно
`actions`	array of AutomationAction	Обязательно

Ответ: Объект. Поля: created, updated, id, company_id, space_uid, updater_id, name, status, trigger, actions, conditions, type, sort_order.

deleteAutomation

client.automations.deleteAutomation · DELETE /api/latest/spaces/{space_id}/automations/{automation_uid}

Delete automation. Документация Kaiten.

...args: AutomationsDeleteAutomationParams

declare const deleteAutomation: (
  spaceId: number,
  automationUid: string,
  options?: OperationOptions,
) => Promise<AutomationsDeleteAutomationResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно
`automation_uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: message.

getListOfAutomations

client.automations.getListOfAutomations · GET /api/latest/spaces/{space_id}/automations

Get list of automations. Документация Kaiten.

...args: AutomationsGetListOfAutomationsParams

declare const getListOfAutomations: (
  spaceId: number,
  options?: OperationOptions,
) => Promise<AutomationsGetListOfAutomationsResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: created, updated, id, company_id, space_uid, updater_id, name, status, trigger, actions, conditions, type, sort_order.

updateAutomation

client.automations.updateAutomation · PATCH /api/latest/spaces/{space_id}/automations/{automation_uid}

Update automation. Документация Kaiten.

...args: AutomationsUpdateAutomationParams

declare const updateAutomation: (
  spaceId: number,
  automationUid: string,
  body: AutomationsUpdateAutomationBody,
  options?: OperationOptions,
) => Promise<AutomationsUpdateAutomationResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно
`automation_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`type`	on_action \| on_date \| on_demand	Необязательно
`name`	string	Необязательно
`trigger`	AutomationTrigger	Необязательно
`conditions`	AutomationConditionGroup	Необязательно
`actions`	array of AutomationAction	Необязательно

Ответ: Объект. Поля: created, updated, id, company_id, space_uid, updater_id, name, status, trigger, actions, conditions, type, sort_order.

boards

getBoard

client.boards.getBoard · GET /api/latest/boards/{id}

Get board. Документация Kaiten.

...args: BoardsGetBoardParams

declare const getBoard: (
  boardId: number,
  options?: OperationOptions,
) => Promise<BoardsGetBoardResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, id, title, cell_wip_limits, external_id, default_card_type_id, description, email_key, move_parents_to_done, default_tags, first_image_is_cover, reset_lane_spent_time, backward_moves_enabled, hide_done_policies, hide_done_policies_in_done_column, automove_cards, auto_assign_enabled, card_properties, columns, lanes, cards.

cardAllowedUsers

retrieveUsersList

client.cardAllowedUsers.retrieveUsersList · GET /api/latest/cards/{card_id}/allowed-users

Retrieve users list. Документация Kaiten.

...args: CardAllowedUsersRetrieveUsersListParams

declare const retrieveUsersList: (
  cardId: number,
  query?: CardAllowedUsersRetrieveUsersListQuery,
  options?: OperationOptions,
) => Promise<CardAllowedUsersRetrieveUsersListResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`type`	enum	Необязательно
`search`	string	Необязательно
`orderBy`	string	Необязательно
`role`	integer	Необязательно
`limit`	integer	Необязательно
`offset`	integer	Необязательно

cardBlockerCategories

addBlockerCategory

client.cardBlockerCategories.addBlockerCategory · POST /api/latest/blockers/{blocker_id}/categories

Add blocker category. Документация Kaiten.

...args: CardBlockerCategoriesAddBlockerCategoryParams

declare const addBlockerCategory: (
  blockerId: number,
  name: string,
  options?: OperationOptions,
) => Promise<CardBlockerCategoriesAddBlockerCategoryResponse>;

Параметры пути

Поле	Тип	Обязательность
`blocker_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Обязательно

Ответ: Объект. Поля: uid, name, color.

removeCategory

client.cardBlockerCategories.removeCategory · DELETE /api/latest/blockers/{blocker_id}/categories/{category_uuid}

Remove category. Документация Kaiten.

...args: CardBlockerCategoriesRemoveCategoryParams

declare const removeCategory: (
  blockerId: number,
  categoryUuid: string,
  options?: OperationOptions,
) => Promise<CardBlockerCategoriesRemoveCategoryResponse>;

Параметры пути

Поле	Тип	Обязательность
`blocker_id`	integer	Обязательно
`category_uuid`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: uid.

retrieveListOfCategories

client.cardBlockerCategories.retrieveListOfCategories · GET /api/latest/categories

Retrieve list of categories. Документация Kaiten.

...args: CardBlockerCategoriesRetrieveListOfCategoriesParams

declare const retrieveListOfCategories: (
  options?: OperationOptions,
) => Promise<CardBlockerCategoriesRetrieveListOfCategoriesResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Ответ: Массив. Поля: uid, name, color.

cardBlockerUsers

addUserToTheCardBlocker

client.cardBlockerUsers.addUserToTheCardBlocker · POST /api/latest/blockers/{blocker_id}/users

Add user to the card blocker. Документация Kaiten.

...args: CardBlockerUsersAddUserToTheCardBlockerParams

declare const addUserToTheCardBlocker: (
  blockerId: number,
  userId: number,
  options?: OperationOptions,
) => Promise<CardBlockerUsersAddUserToTheCardBlockerResponse>;

Параметры пути

Поле	Тип	Обязательность
`blocker_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`user_id`	integer	Обязательно

removeUser

client.cardBlockerUsers.removeUser · DELETE /api/latest/blockers/{blocker_id}/users/{user_id}

Remove user. Документация Kaiten.

...args: CardBlockerUsersRemoveUserParams

declare const removeUser: (
  blockerId: number,
  userId: number,
  options?: OperationOptions,
) => Promise<CardBlockerUsersRemoveUserResponse>;

Параметры пути

Поле	Тип	Обязательность
`blocker_id`	integer	Обязательно
`user_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

retrieveBlockersCardsListOnCurrentUser

client.cardBlockerUsers.retrieveBlockersCardsListOnCurrentUser · GET /api/latest/users/current/blockers

Retrieve blockers cards list on current user. Документация Kaiten.

...args: CardBlockerUsersRetrieveBlockersCardsListOnCurrentUserParams

declare const retrieveBlockersCardsListOnCurrentUser: (
  options?: OperationOptions,
) => Promise<CardBlockerUsersRetrieveBlockersCardsListOnCurrentUserResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Ответ: Объект. Поля: blocked_cards, summary.

retrieveListOfUsers

client.cardBlockerUsers.retrieveListOfUsers · GET /api/latest/blockers/{blocker_id}/users

Retrieve list of users. Документация Kaiten.

...args: CardBlockerUsersRetrieveListOfUsersParams

declare const retrieveListOfUsers: (
  blockerId: number,
  options?: OperationOptions,
) => Promise<CardBlockerUsersRetrieveListOfUsersResponse>;

Параметры пути

Поле	Тип	Обязательность
`blocker_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: created, updated, id, full_name, email, username, activated, show_tour, avatar_initials_url, initials, avatar_type, avatar_uploaded_url, lng, timezone, chat_enabled, theme, sd_telegram_id, news_subscription, ui_version, uid, virtual, email_blocked, email_blocked_reason, delete_requested_at, delete_confirmation_sent_at, eula_accepted_at, terms_of_service_accepted_at, privacy_policy_accepted_at, block_uid, user_uid.

cardBlockers

blockCard

client.cardBlockers.blockCard · POST /api/latest/cards/{card_id}/blockers

Block card. Документация Kaiten.

...args: CardBlockersBlockCardParams

declare const blockCard: (
  cardId: number,
  body: CardBlockersBlockCardBody,
  options?: OperationOptions,
) => Promise<CardBlockersBlockCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`reason`	string	Необязательно
`blocker_card_id`	integer	Необязательно

Ответ: Объект. Поля: created, updated, id, reason, card_id, blocker_id, blocker_card_id, blocker_card_title, released, released_by_id, due_date, due_date_time_present, blocked_card, blocker, card.

deleteCardBlockers

client.cardBlockers.deleteCardBlockers · DELETE /api/latest/cards/{card_id}/blockers/{id}

Delete card blockers. Документация Kaiten.

...args: CardBlockersDeleteCardBlockersParams

declare const deleteCardBlockers: (
  cardId: number,
  blockerId: number,
  options?: OperationOptions,
) => Promise<CardBlockersDeleteCardBlockersResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

retrieveCardBlockersList

client.cardBlockers.retrieveCardBlockersList · GET /api/latest/cards/{card_id}/blockers

Retrieve card blockers list. Документация Kaiten.

...args: CardBlockersRetrieveCardBlockersListParams

declare const retrieveCardBlockersList: (
  cardId: number,
  options?: OperationOptions,
) => Promise<CardBlockersRetrieveCardBlockersListResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: created, updated, id, reason, card_id, blocker_id, blocker_card_id, blocker_card_title, released, released_by_id, due_date, due_date_time_present, blocked_card, blocker, card.

updateCardBlockers

client.cardBlockers.updateCardBlockers · PATCH /api/latest/cards/{card_id}/blockers/{id}

Update card blockers. Документация Kaiten.

...args: CardBlockersUpdateCardBlockersParams

declare const updateCardBlockers: (
  cardId: number,
  blockerId: number,
  body: CardBlockersUpdateCardBlockersBody,
  options?: OperationOptions,
) => Promise<CardBlockersUpdateCardBlockersResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`reason`	string	Необязательно
`blocker_card_id`	integer	Необязательно
`due_date`	string \| null	Необязательно
`due_date_time_present`	boolean \| null	Необязательно

cardChecklistItems

addItemToChecklist

client.cardChecklistItems.addItemToChecklist · POST /api/latest/cards/{card_id}/checklists/{checklist_id}/items

Add item to checklist. Документация Kaiten.

...args: CardChecklistItemsAddItemToChecklistParams

declare const addItemToChecklist: (
  cardId: number,
  checklistId: number,
  body: CardChecklistItemsAddItemToChecklistBody,
  options?: OperationOptions,
) => Promise<CardChecklistItemsAddItemToChecklistResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`checklist_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`text`	string	Обязательно
`sort_order`	number	Необязательно
`checked`	boolean	Необязательно
`due_date`	string \| null	Необязательно
`responsible_id`	integer	Необязательно

Ответ: Объект. Поля: created, updated, id, text, sort_order, checked, checklist_id, checker_id, user_id, checked_at, responsible_id, deleted, due_date.

removeChecklistItem

client.cardChecklistItems.removeChecklistItem · DELETE /api/latest/cards/{card_id}/checklists/{checklist_id}/items/{id}

Remove checklist item. Документация Kaiten.

...args: CardChecklistItemsRemoveChecklistItemParams

declare const removeChecklistItem: (
  cardId: number,
  checklistId: number,
  itemId: number,
  options?: OperationOptions,
) => Promise<CardChecklistItemsRemoveChecklistItemResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`checklist_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

updateChecklistItem

client.cardChecklistItems.updateChecklistItem · PATCH /api/latest/cards/{card_id}/checklists/{checklist_id}/items/{id}

Update checklist item. Документация Kaiten.

...args: CardChecklistItemsUpdateChecklistItemParams

declare const updateChecklistItem: (
  cardId: number,
  checklistId: number,
  itemId: number,
  body: CardChecklistItemsUpdateChecklistItemBody,
  options?: OperationOptions,
) => Promise<CardChecklistItemsUpdateChecklistItemResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`checklist_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`text`	string \| null	Необязательно
`sort_order`	number	Необязательно
`checklist_id`	integer	Необязательно
`checked`	boolean	Необязательно
`due_date`	string \| null	Необязательно
`responsible_id`	number \| null	Необязательно

Ответ: Объект. Поля: created, updated, id, text, sort_order, checked, checklist_id, checker_id, user_id, checked_at, responsible_id, deleted, due_date.

cardChecklists

addChecklistToCard

client.cardChecklists.addChecklistToCard · POST /api/latest/cards/{card_id}/checklists

Add checklist to card. Документация Kaiten.

...args: CardChecklistsAddChecklistToCardParams

declare const addChecklistToCard: (
  cardId: number,
  body: CardChecklistsAddChecklistToCardBody,
  options?: OperationOptions,
) => Promise<CardChecklistsAddChecklistToCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`sort_order`	number	Необязательно
`items_source_checklist_id`	integer	Необязательно
`exclude_item_ids`	array of integer	Необязательно
`source_share_id`	integer	Необязательно

Ответ: Объект. Поля: created, updated, id, name, policy_id, card_id, checklist_id, sort_order, deleted, items.

removeChecklistFromCard

client.cardChecklists.removeChecklistFromCard · DELETE /api/latest/cards/{card_id}/checklists/{id}

Remove checklist from card. Документация Kaiten.

...args: CardChecklistsRemoveChecklistFromCardParams

declare const removeChecklistFromCard: (
  cardId: number,
  checklistId: number,
  options?: OperationOptions,
) => Promise<CardChecklistsRemoveChecklistFromCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

retrieveCardChecklist

client.cardChecklists.retrieveCardChecklist · GET /api/latest/cards/{card_id}/checklists/{id}

Retrieve card checklist. Документация Kaiten.

...args: CardChecklistsRetrieveCardChecklistParams

declare const retrieveCardChecklist: (
  cardId: number,
  checklistId: number,
  options?: OperationOptions,
) => Promise<CardChecklistsRetrieveCardChecklistResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, id, uid, fts_version, name, policy_id, items.

updateChecklist

client.cardChecklists.updateChecklist · PATCH /api/latest/cards/{card_id}/checklists/{id}

Update checklist. Документация Kaiten.

...args: CardChecklistsUpdateChecklistParams

declare const updateChecklist: (
  cardId: number,
  checklistId: number,
  body: CardChecklistsUpdateChecklistBody,
  options?: OperationOptions,
) => Promise<CardChecklistsUpdateChecklistResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`sort_order`	number	Необязательно
`card_id`	integer	Необязательно

Ответ: Объект. Поля: created, updated, id, name, policy_id.

cardChildren

addChildren

client.cardChildren.addChildren · POST /api/latest/cards/{card_id}/children

Add children. Документация Kaiten.

...args: CardChildrenAddChildrenParams

declare const addChildren: (
  parentCardId: number,
  childCardId: number,
  options?: OperationOptions,
) => Promise<CardChildrenAddChildrenResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Ответ: Объект. Поля: id, created, updated, archived, title, asap, due_date, sort_order, fifo_order, state, condition, expires_later, parents_count, children_count, children_done, has_blocked_children, goals_total, goals_done, time_spent_sum, time_blocked_sum, children_number_properties_sum, calculated_planned_start, calculated_planned_end, parent_checklist_ids, children_ids, parents_ids, blocking_card, blocked, size, size_unit, size_text, due_date_time_present, board_id, column_id, lane_id, owner_id, type_id, version, updater_id, completed_on_time, completed_at, last_moved_at, lane_changed_at, column_changed_at, first_moved_to_in_progress_at, last_moved_to_done_at, sprint_id, external_id, comments_total, comment_last_added_at, properties, planned_start, planned_end, ignore_planned_dates_recalculation, service_id, sd_new_comment, public, share_settings, share_id, external_user_emails, description_filled, estimate_workload, has_access_to_space, path_data, space_id, type, owner.

removeChildren

client.cardChildren.removeChildren · DELETE /api/latest/cards/{card_id}/children/{id}

Remove children. Документация Kaiten.

...args: CardChildrenRemoveChildrenParams

declare const removeChildren: (
  cardId: number,
  id: number,
  options?: OperationOptions,
) => Promise<CardChildrenRemoveChildrenResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

retrieveCardChildrenList

client.cardChildren.retrieveCardChildrenList · GET /api/latest/cards/{card_id}/children

Retrieve card children list. Документация Kaiten.

...args: CardChildrenRetrieveCardChildrenListParams

declare const retrieveCardChildrenList: (
  cardId: number,
  options?: OperationOptions,
) => Promise<CardChildrenRetrieveCardChildrenListResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: id, created, updated, archived, title, asap, due_date, sort_order, fifo_order, state, condition, expires_later, parents_count, children_count, children_done, has_blocked_children, goals_total, goals_done, time_spent_sum, time_blocked_sum, children_number_properties_sum, calculated_planned_start, calculated_planned_end, parent_checklist_ids, children_ids, parents_ids, blocking_card, blocked, size, size_unit, size_text, due_date_time_present, board_id, column_id, lane_id, owner_id, type_id, version, updater_id, completed_on_time, completed_at, last_moved_at, lane_changed_at, column_changed_at, first_moved_to_in_progress_at, last_moved_to_done_at, sprint_id, external_id, comments_total, comment_last_added_at, properties, planned_start, planned_end, ignore_planned_dates_recalculation, service_id, sd_new_comment, public, share_settings, share_id, external_user_emails, description_filled, estimate_workload, type, owner, board, lane, column, card_id, depends_on_card_id.

cardComments

addComment

client.cardComments.addComment · POST /api/latest/cards/{card_id}/comments

Add comment. Документация Kaiten.

...args: CardCommentsAddCommentParams

declare const addComment: (
  cardId: number,
  body: CardCommentsAddCommentBody | FormData,
  options?: OperationOptions,
) => Promise<CardCommentsAddCommentResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`text`	string	Обязательно
`files[] Deprecated`	array of binary files	Необязательно

Ответ: Объект. Поля: created, updated, id, uid, text, type, edited, card_id, author_id, email_addresses_to, deleted, internal, sd_external_recipients_cc, sd_description, notification_sent, attacments.

removeComment

client.cardComments.removeComment · DELETE /api/latest/cards/{card_id}/comments/{comment_id}

Remove comment. Документация Kaiten.

...args: CardCommentsRemoveCommentParams

declare const removeComment: (
  cardId: number,
  commentId: number,
  options?: OperationOptions,
) => Promise<CardCommentsRemoveCommentResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`comment_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

retrieveCardComments

client.cardComments.retrieveCardComments · GET /api/latest/cards/{card_id}/comments

Retrieve card comments. Документация Kaiten.

...args: CardCommentsRetrieveCardCommentsParams

declare const retrieveCardComments: (
  cardId: number,
  options?: OperationOptions,
) => Promise<CardCommentsRetrieveCardCommentsResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: created, update, id, uid, text, edited, card_id, author_id, email_addresses_to, type, deleted, internal, sd_external_recipients_cc, notification_sent, sent_slack_messages_data, sd_description, author.

updateComment

client.cardComments.updateComment · PATCH /api/latest/cards/{card_id}/comments/{comment_id}

Update comment. Документация Kaiten.

...args: CardCommentsUpdateCommentParams

declare const updateComment: (
  cardId: number,
  commentId: number,
  body: CardCommentsUpdateCommentBody | FormData,
  options?: OperationOptions,
) => Promise<CardCommentsUpdateCommentResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`comment_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`text`	string	Необязательно
`files[] Deprecated`	array of binary files	Необязательно

cardExternalLinks

addExternalLink

client.cardExternalLinks.addExternalLink · POST /api/latest/cards/{card_id}/external-links

Add external link. Документация Kaiten.

...args: CardExternalLinksAddExternalLinkParams

declare const addExternalLink: (
  cardId: number,
  url: string,
  description?: string | null,
  options?: OperationOptions,
) => Promise<CardExternalLinksAddExternalLinkResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`url`	string	Обязательно
`description`	string \| null	Необязательно

Ответ: Объект. Поля: url, updated, created, id, description.

removeExternalLink

client.cardExternalLinks.removeExternalLink · DELETE /api/latest/cards/{card_id}/external-links/{id}

Remove external link. Документация Kaiten.

...args: CardExternalLinksRemoveExternalLinkParams

declare const removeExternalLink: (
  cardId: number,
  id: number,
  options?: OperationOptions,
) => Promise<CardExternalLinksRemoveExternalLinkResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

retrieveCardExternalLinks

client.cardExternalLinks.retrieveCardExternalLinks · GET /api/latest/cards/{card_id}/external-links

Retrieve card external links. Документация Kaiten.

...args: CardExternalLinksRetrieveCardExternalLinksParams

declare const retrieveCardExternalLinks: (
  cardId: number,
  options?: OperationOptions,
) => Promise<CardExternalLinksRetrieveCardExternalLinksResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: url, updated, created, id, description, card_id, external_link_id.

updateExternalLink

client.cardExternalLinks.updateExternalLink · PATCH /api/latest/cards/{card_id}/external-links/{id}

Update external link. Документация Kaiten.

...args: CardExternalLinksUpdateExternalLinkParams

declare const updateExternalLink: (
  cardId: number,
  id: number,
  body: CardExternalLinksUpdateExternalLinkBody,
  options?: OperationOptions,
) => Promise<CardExternalLinksUpdateExternalLinkResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`url`	string	Необязательно
`description`	string \| null	Необязательно

Ответ: Объект. Поля: url, updated, created, id, description.

cardFiles

attachFileToCard

client.cardFiles.attachFileToCard · PUT /api/latest/cards/{card_id}/files

Attach file to card Deprecated. Документация Kaiten. Устаревшая операция.

...args: CardFilesAttachFileToCardParams

declare const attachFileToCard: (
  cardId: number,
  file: Blob,
  options?: FileUploadOptions,
) => Promise<CardFilesAttachFileToCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`file`	binary	Обязательно

Ответ: Объект. Поля: author_id, card_cover, card_id, comment_id, created, deleted, external, id, mh_markup_id, mh_secret, name, size, sort_order, type, updated, url.

detachFileFromCard

client.cardFiles.detachFileFromCard · DELETE /api/latest/cards/{card_id}/files/{id}

Detach file from card. Документация Kaiten.

...args: CardFilesDetachFileFromCardParams

declare const detachFileFromCard: (
  cardId: number,
  fileId: number,
  options?: OperationOptions,
) => Promise<CardFilesDetachFileFromCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

updateFile

client.cardFiles.updateFile · PATCH /api/latest/cards/{card_id}/files/{id}

Update file. Документация Kaiten.

...args: CardFilesUpdateFileParams

declare const updateFile: (
  cardId: number,
  fileId: number,
  cardCover?: boolean,
  options?: OperationOptions,
) => Promise<CardFilesUpdateFileResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`card_cover`	boolean	Необязательно

Ответ: Объект

cardMembers

addMemberToCard

client.cardMembers.addMemberToCard · POST /api/latest/cards/{card_id}/members

Add member to card. Документация Kaiten.

...args: CardMembersAddMemberToCardParams

declare const addMemberToCard: (
  cardId: number,
  userId: number,
  options?: OperationOptions,
) => Promise<CardMembersAddMemberToCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`user_id`	integer	Обязательно

Ответ: Объект. Поля: id, full_name, email, username, avatar_initials_url, avatar_uploaded_url, initials, avatar_type, lng, timezone, theme, updated, type.

removeMemberFromCard

client.cardMembers.removeMemberFromCard · DELETE /api/latest/cards/{card_id}/members/{id}

Remove member from card. Документация Kaiten.

...args: CardMembersRemoveMemberFromCardParams

declare const removeMemberFromCard: (
  cardId: number,
  memberId: number,
  options?: OperationOptions,
) => Promise<CardMembersRemoveMemberFromCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

retrieveListOfCardMembers

client.cardMembers.retrieveListOfCardMembers · GET /api/latest/cards/{card_id}/members

Retrieve list of card members. Документация Kaiten.

...args: CardMembersRetrieveListOfCardMembersParams

declare const retrieveListOfCardMembers: (
  cardId: number,
  options?: OperationOptions,
) => Promise<CardMembersRetrieveListOfCardMembersResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

updateMemberRole

client.cardMembers.updateMemberRole · PATCH /api/latest/cards/{card_id}/members/{id}

Update member role. Документация Kaiten.

...args: CardMembersUpdateMemberRoleParams

declare const updateMemberRole: (
  cardId: number,
  memberId: number,
  type: number,
  options?: OperationOptions,
) => Promise<CardMembersUpdateMemberRoleResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`type`	integer	Обязательно

Ответ: Объект. Поля: created, updated, card_id, user_id, type.

cardServiceDeskExternalRecipients

addNewRecipient

client.cardServiceDeskExternalRecipients.addNewRecipient · POST /api/latest/cards/{card_id}/sd-external-recipients

Add new recipient. Документация Kaiten.

...args: CardServiceDeskExternalRecipientsAddNewRecipientParams

declare const addNewRecipient: (
  cardId: number,
  email: string,
  options?: OperationOptions,
) => Promise<CardServiceDeskExternalRecipientsAddNewRecipientResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`email`	string	Обязательно

Ответ: Объект. Поля: created, updated, card_id, user_id, email, unsubscribed, updater_id.

removeRecipient

client.cardServiceDeskExternalRecipients.removeRecipient · DELETE /api/latest/cards/{card_id}/sd-external-recipients/{email}

Remove recipient. Документация Kaiten.

...args: CardServiceDeskExternalRecipientsRemoveRecipientParams

declare const removeRecipient: (
  cardId: number,
  email: string,
  options?: OperationOptions,
) => Promise<CardServiceDeskExternalRecipientsRemoveRecipientResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`email`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, card_id, user_id, email, unsubscribed, updater_id, company_id.

cardSla

retrieveCardSlaMeasurements

client.cardSla.retrieveCardSlaMeasurements · GET /api/latest/cards/{card_id}/sla-rules-measurements

Retrieve card SLA measurements. Документация Kaiten.

...args: CardSlaRetrieveCardSlaMeasurementsParams

declare const retrieveCardSlaMeasurements: (
  cardId: number,
  options?: OperationOptions,
) => Promise<CardSlaRetrieveCardSlaMeasurementsResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: calendars, rulesTimeData.

cardTags

addTag

client.cardTags.addTag · POST /api/latest/cards/{card_id}/tags

Add tag. Документация Kaiten.

...args: CardTagsAddTagParams

declare const addTag: (
  cardId: number,
  name: string,
  options?: OperationOptions,
) => Promise<CardTagsAddTagResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Обязательно

Ответ: Объект. Поля: created, updated, archived, id, name, company_id, color.

removeTagFromCard

client.cardTags.removeTagFromCard · DELETE /api/latest/cards/{card_id}/tags/{tag_id}

Remove tag from card. Документация Kaiten.

...args: CardTagsRemoveTagFromCardParams

declare const removeTagFromCard: (
  cardId: number,
  tagId: number,
  options?: OperationOptions,
) => Promise<CardTagsRemoveTagFromCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`tag_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

rertrieveListOfTags

client.cardTags.rertrieveListOfTags · GET /api/latest/cards/{card_id}/tags

Rertrieve list of tags. Документация Kaiten.

...args: CardTagsRertrieveListOfTagsParams

declare const rertrieveListOfTags: (
  cardId: number,
  options?: OperationOptions,
) => Promise<CardTagsRertrieveListOfTagsResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: id, name, color, card_id, tag_id.

cardTimeLogs

addTimeLog

client.cardTimeLogs.addTimeLog · POST /api/latest/cards/{card_id}/time-logs

Add time log. Документация Kaiten.

...args: CardTimeLogsAddTimeLogParams

declare const addTimeLog: (
  cardId: number,
  body: CardTimeLogsAddTimeLogBody,
  options?: OperationOptions,
) => Promise<CardTimeLogsAddTimeLogResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`role_id`	integer	Обязательно
`time_spent`	integer	Обязательно
`for_date`	string	Обязательно
`comment`	string	Необязательно

Ответ: Объект. Поля: created, updated, id, card_id, user_id, role_id, author_id, updater_id, time_spent, for_date, comment.

getTimeLogs

client.cardTimeLogs.getTimeLogs · GET /api/latest/cards/{card_id}/time-logs

Get time logs. Документация Kaiten.

...args: CardTimeLogsGetTimeLogsParams

declare const getTimeLogs: (
  cardId: number,
  forDate?: string,
  personal?: boolean,
  options?: OperationOptions,
) => Promise<CardTimeLogsGetTimeLogsResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`for_date`	string	Необязательно
`personal`	boolean	Необязательно

Ответ: Массив. Поля: created, updated, id, card_id, user_id, role_id, author_id, updater_id, time_spent, for_date, comment, role, user, author.

removeTimeLog

client.cardTimeLogs.removeTimeLog · DELETE /api/latest/cards/{card_id}/time-logs/{id}

Remove time log. Документация Kaiten.

...args: CardTimeLogsRemoveTimeLogParams

declare const removeTimeLog: (
  cardId: number,
  timeLogId: number,
  options?: OperationOptions,
) => Promise<CardTimeLogsRemoveTimeLogResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

updateLogRecord

client.cardTimeLogs.updateLogRecord · PATCH /api/latest/cards/{card_id}/time-logs/{id}

Update log record. Документация Kaiten.

...args: CardTimeLogsUpdateLogRecordParams

declare const updateLogRecord: (
  cardId: number,
  timeLogId: number,
  body: CardTimeLogsUpdateLogRecordBody,
  options?: OperationOptions,
) => Promise<CardTimeLogsUpdateLogRecordResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`role_id`	integer	Необязательно
`time_spent`	integer	Необязательно
`for_date`	string	Необязательно
`comment`	string	Необязательно

Ответ: Объект. Поля: created, updated, id, card_id, user_id, role_id, author_id, updater_id, time_spent, for_date, comment.

cardTypeTreeEntities

addTreeEntityToCardType

client.cardTypeTreeEntities.addTreeEntityToCardType · POST /api/latest/card-types/{type_id}/tree-entities

Add tree entity to card type. Документация Kaiten.

...args: CardTypeTreeEntitiesAddTreeEntityToCardTypeParams

declare const addTreeEntityToCardType: (
  typeId: number,
  treeEntityUid: string,
  options?: OperationOptions,
) => Promise<CardTypeTreeEntitiesAddTreeEntityToCardTypeResponse>;

Параметры пути

Поле	Тип	Обязательность
`type_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`tree_entity_uid`	string	Обязательно

Ответ: Объект. Поля: id.

deleteTreeEntityFromCardType

client.cardTypeTreeEntities.deleteTreeEntityFromCardType · DELETE /api/latest/card-types/{type_id}/tree-entities/{uid}

Delete tree entity from card type. Документация Kaiten.

...args: CardTypeTreeEntitiesDeleteTreeEntityFromCardTypeParams

declare const deleteTreeEntityFromCardType: (
  typeId: number,
  uid: string,
  options?: OperationOptions,
) => Promise<void>;

Параметры пути

Поле	Тип	Обязательность
`type_id`	integer	Обязательно
`uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Без тела

getListOfTypeTreeEntities

client.cardTypeTreeEntities.getListOfTypeTreeEntities · GET /api/latest/card-types/{type_id}/tree-entities

Get list of type tree entities. Документация Kaiten.

...args: CardTypeTreeEntitiesGetListOfTypeTreeEntitiesParams

declare const getListOfTypeTreeEntities: (
  typeId: number,
  options?: OperationOptions,
) => Promise<CardTypeTreeEntitiesGetListOfTypeTreeEntitiesResponse>;

Параметры пути

Поле	Тип	Обязательность
`type_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: uid, title, company_id, sort_order, path, parent_entity_uid, entity_type, access, archived, for_everyone_access_role_id, protected.

cardTypes

createNewCardType

client.cardTypes.createNewCardType · POST /api/latest/card-types

Create new card type. Документация Kaiten.

...args: CardTypesCreateNewCardTypeParams

declare const createNewCardType: (
  body: CardTypesCreateNewCardTypeBody,
  options?: OperationOptions,
) => Promise<CardTypesCreateNewCardTypeResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`letter`	string	Обязательно
`name`	string	Обязательно
`color`	integer	Обязательно
`properties`	object	Необязательно
`card_properties`	array of unknown \| unknown	Необязательно
`suggest_fields`	boolean	Необязательно

Ответ: Объект. Поля: company_id, letter, name, color, updated, created, id, description_template, archived, properties, card_properties, suggest_fields.

getCardType

client.cardTypes.getCardType · GET /api/latest/card-types/{id}

Get card type. Документация Kaiten.

...args: CardTypesGetCardTypeParams

declare const getCardType: (
  id: number,
  options?: OperationOptions,
) => Promise<CardTypesGetCardTypeResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: company_id, letter, name, color, updated, created, id, description_template, archived, properties, card_properties, suggest_fields.

getListOfCardTypes

client.cardTypes.getListOfCardTypes · GET /api/latest/card-types

Get list of card types. Документация Kaiten.

...args: CardTypesGetListOfCardTypesParams

declare const getListOfCardTypes: (
  limit?: number,
  offset?: number,
  options?: OperationOptions,
) => Promise<CardTypesGetListOfCardTypesResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`limit`	integer	Необязательно
`offset`	integer	Необязательно

Ответ: Массив. Поля: company_id, letter, name, color, updated, created, id, description_template, archived, properties, card_properties, suggest_fields.

removeCardType

client.cardTypes.removeCardType · DELETE /api/latest/card-types/{id}

Remove card type. Документация Kaiten.

...args: CardTypesRemoveCardTypeParams

declare const removeCardType: (
  id: number,
  replaceTypeId: number,
  options?: OperationOptions,
) => Promise<CardTypesRemoveCardTypeResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`replace_type_id`	number	Обязательно

Ответ: Объект. Поля: company_id, letter, name, color, updated, created, id, description_template, archived, properties, card_properties, suggest_fields.

updateCardType

client.cardTypes.updateCardType · PATCH /api/latest/card-types/{id}

Update card type. Документация Kaiten.

...args: CardTypesUpdateCardTypeParams

declare const updateCardType: (
  id: number,
  body: CardTypesUpdateCardTypeBody,
  options?: OperationOptions,
) => Promise<CardTypesUpdateCardTypeResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`letter`	string	Необязательно
`name`	string	Необязательно
`color`	integer	Необязательно
`properties`	object	Необязательно
`card_properties`	array of unknown \| unknown	Необязательно
`suggest_fields`	boolean	Необязательно

Ответ: Объект. Поля: company_id, letter, name, color, updated, created, id, description_template, archived, properties, card_properties, suggest_fields.

cards

batchUpdateForCards

client.cards.batchUpdateForCards · PATCH /api/latest/cards

Batch update for cards. Документация Kaiten.

...args: CardsBatchUpdateForCardsParams

declare const batchUpdateForCards: (
  body: CardsBatchUpdateForCardsBody,
  options?: OperationOptions,
) => Promise<CardsBatchUpdateForCardsResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`board_id`	integer	Необязательно
`column_id`	integer	Необязательно
`lane_id`	integer	Необязательно
`owner_id`	integer	Необязательно
`type_id`	integer	Необязательно
`condition`	1 \| 2	Необязательно
`attributes`	unknown \| unknown \| unknown \| unknown \| unknown \| unknown	Необязательно
`order_by`	unknown	Необязательно

Ответ: Объект. Поля: id.

createNewCard

client.cards.createNewCard · POST /api/latest/cards

Create new card. Документация Kaiten.

...args: CardsCreateNewCardParams

declare const createNewCard: (
  body: CardsCreateNewCardBody,
  options?: OperationOptions,
) => Promise<CardsCreateNewCardResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	number \| string	Обязательно
`board_id`	integer	Обязательно
`asap`	boolean	Необязательно
`due_date`	string \| null	Необязательно
`due_date_time_present`	boolean	Необязательно
`sort_order`	number	Необязательно
`description`	number \| string \| null	Необязательно
`expires_later`	boolean	Необязательно
`size_text`	number \| string \| null	Необязательно
`column_id`	integer	Необязательно
`lane_id`	integer	Необязательно
`owner_id`	integer	Необязательно
`responsible_id`	integer	Необязательно
`owner_email`	string	Необязательно
`position`	1 \| 2	Необязательно
`type_id`	integer	Необязательно
`service_id`	integer \| null	Необязательно
`external_id`	number \| string \| null	Необязательно
`text_format_type_id`	1 \| 2 \| 3	Необязательно
`properties`	object	Необязательно

Ответ: Объект. Поля: created, updated, archived, id, title, description, asap, due_date, sort_order, fifo_order, state, condition, expires_later, parents_count, children_count, children_done, goals_total, goals_done, time_spent_sum, time_blocked_sum, children_number_properties_sum, parent_checklist_ids, blocking_card, blocked, size, size_unit, size_text, due_date_time_present, board_id, column_id, lane_id, owner_id, type_id, version, updater_id, completed_on_time, completed_at, last_moved_at, lane_changed_at, column_changed_at, first_moved_to_in_progress_at, last_moved_to_done_at, sprint_id, external_id, service_id, comments_total, comment_last_added_at, properties, planned_start, planned_end, ignore_planned_dates_recalculation, counters_recalculated_at, sd_new_comment, public, share_settings, share_id, external_user_emails, description_filled, estimate_workload, owner, type, external_links, files, checklists.

deleteCard

client.cards.deleteCard · DELETE /api/latest/cards/{card_id}

Delete card. Документация Kaiten.

...args: CardsDeleteCardParams

declare const deleteCard: (
  cardId: number,
  options?: OperationOptions,
) => Promise<CardsDeleteCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, archived, id, title, asap, due_date, due_date_time_present, expires_later, sort_order, description, state, condition, blocking_card, blocked, size, size_unit, size_text, board_id, column_id, lane_id, owner_id, type_id, version, updater_id, completed_on_time, completed_at, last_moved_at, lane_changed_at, column_changed_at, first_moved_to_in_progress_at, last_moved_to_done_at, planned_start, planned_end, ignore_planned_dates_recalculation, sprint_id, external_id, service_id, properties, public, share_id, share_settings, external_user_emails, tag_ids, estimate_workload, comments_total, comment_last_added_at, parents_count, children_count, children_done, goals_total, goals_done, time_spent_sum, time_blocked_sum, children_number_properties_sum, calculated_planned_start, calculated_planned_end, description_filled, has_blocked_children, parent_checklist_ids, children_ids, parents_ids, fifo_order, counters_recalculated_at, sd_new_comment, import_id, owner, members.

retrieveCard

client.cards.retrieveCard · GET /api/latest/cards/{card_id}

Retrieve card. Документация Kaiten.

...args: CardsRetrieveCardParams

declare const retrieveCard: (
  cardId: number,
  brokenApi?: boolean,
  options?: OperationOptions,
) => Promise<CardsRetrieveCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`broken_api`	boolean	Необязательно

Ответ: Объект. Поля: created, updated, archived, id, uid, title, asap, due_date, due_date_time_present, expires_later, sort_order, description, state, condition, blocking_card, blocked, size, size_unit, size_text, board_id, column_id, lane_id, owner_id, type_id, version, updater_id, completed_on_time, completed_at, last_moved_at, lane_changed_at, column_changed_at, first_moved_to_in_progress_at, last_moved_to_done_at, planned_start, planned_end, ignore_planned_dates_recalculation, sprint_id, external_id, service_id, properties, public, share_id, share_settings, external_user_emails, tag_ids, estimate_workload, comments_total, comment_last_added_at, parents_count, children_count, children_done, goals_total, goals_done, time_spent_sum, time_blocked_sum, children_number_properties_sum, calculated_planned_start, calculated_planned_end, description_filled, has_blocked_children, parent_checklist_ids, children_ids, parents_ids, fifo_order, counters_recalculated_at, sd_new_comment, import_id, board, lane, column, type, checklists, members, blockers, owner, slas, blocked_at, blocker_id, blocker, block_reason, children, parents, files, tags, external_links, cardRole, email.

retrieveCardBaselines

client.cards.retrieveCardBaselines · GET /api/latest/cards/{card_id}/baselines

Retrieve card baselines. Документация Kaiten.

...args: CardsRetrieveCardBaselinesParams

declare const retrieveCardBaselines: (
  cardId: number,
  options?: OperationOptions,
) => Promise<CardsRetrieveCardBaselinesResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: id, uid, baseline_id, planned_start, planned_end.

retrieveCardList

client.cards.retrieveCardList · GET /api/latest/cards

Параметры со списками через запятую принимают QueryList<T>: строку либо readonly-массив значений соответствующего типа. Примеры — в разделе типизированных фильтров карточек.

Retrieve card list. Документация Kaiten.

...args: CardsRetrieveCardListParams

declare const retrieveCardList: {
  (
    query: CardsRetrieveCardListQuery & {version: 2},
    options?: OperationOptions,
  ): Promise<SearchResponseV2<CardsRetrieveCardListResponse>>;
  (
    query?: Omit<CardsRetrieveCardListQuery, 'version'> & {version?: 1},
    options?: OperationOptions,
  ): Promise<CardsRetrieveCardListResponse>;
  (
    query: CardsRetrieveCardListQuery | undefined,
    options?: OperationOptions,
  ): Promise<
    | CardsRetrieveCardListResponse
    | SearchResponseV2<CardsRetrieveCardListResponse>
  >;
};

При query.version: 2 возвращается SearchResponseV2<...> с полями result и position; без этого параметра возвращается массив.

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`created_before`	string	Необязательно
`created_after`	string	Необязательно
`updated_before`	string	Необязательно
`updated_after`	string	Необязательно
`first_moved_in_progress_after`	string	Необязательно
`first_moved_in_progress_before`	string	Необязательно
`last_moved_to_done_at_after`	string	Необязательно
`last_moved_to_done_at_before`	string	Необязательно
`due_date_after`	string	Необязательно
`due_date_before`	string	Необязательно
`query`	string	Необязательно
`version`	integer	Необязательно
`tag`	string	Необязательно
`tag_ids`	string	Необязательно
`type_ids`	string	Необязательно
`exclude_board_ids`	string	Необязательно
`exclude_lane_ids`	string	Необязательно
`exclude_column_ids`	string	Необязательно
`column_ids`	string	Необязательно
`member_ids`	string	Необязательно
`owner_ids`	string	Необязательно
`responsible_ids`	string	Необязательно
`states`	string	Необязательно
`external_id`	string	Необязательно
`additional_card_fields`	string	Необязательно
`search_fields`	string	Необязательно
`space_id`	integer	Необязательно
`limit`	integer	Необязательно
`offset`	integer	Необязательно
`start_position`	string	Необязательно
`include_search_preview`	boolean	Необязательно
`order_space_id`	integer	Необязательно
`board_id`	integer	Необязательно
`column_id`	integer	Необязательно
`lane_id`	integer	Необязательно
`condition`	integer	Необязательно
`type_id`	integer	Необязательно
`responsible_id`	integer	Необязательно
`owner_id`	integer	Необязательно
`archived`	boolean	Необязательно
`asap`	boolean	Необязательно
`overdue`	boolean	Необязательно
`done_on_time`	boolean	Необязательно
`with_due_date`	boolean	Необязательно
`filter`	string / CardFilter	Необязательно
`order_by`	string	Необязательно
`order_direction`	string	Необязательно
`is_request`	boolean	Необязательно
`exclude_owner_ids`	string	Необязательно
`exclude_card_ids`	string	Необязательно
`organizations_ids`	string	Необязательно
`broken_api`	boolean	Необязательно

Ответ: Массив. Поля: id, uid, created, updated, archived, title, asap, due_date, sort_order, fifo_order, state, condition, expires_later, parents_count, children_count, children_done, has_blocked_children, goals_total, goals_done, time_spent_sum, time_blocked_sum, children_number_properties_sum, calculated_planned_start, calculated_planned_end, parent_checklist_ids, children_ids, parents_ids, blocking_card, blocked, size, size_unit, size_text, due_date_time_present, board_id, column_id, lane_id, owner_id, type_id, version, updater_id, completed_on_time, completed_at, last_moved_at, lane_changed_at, column_changed_at, first_moved_to_in_progress_at, last_moved_to_done_at, sprint_id, external_id, comments_total, comment_last_added_at, properties, planned_start, planned_end, ignore_planned_dates_recalculation, service_id, sd_new_comment, public, share_settings, share_id, external_user_emails, description_filled, estimate_workload, owner, board, members, column, lane, type, path_data.

retrieveCardLocationHistory

client.cards.retrieveCardLocationHistory · GET /api/latest/cards/{card_id}/location-history

Retrieve card location history. Документация Kaiten.

...args: CardsRetrieveCardLocationHistoryParams

declare const retrieveCardLocationHistory: (
  cardId: number,
  options?: OperationOptions,
) => Promise<CardsRetrieveCardLocationHistoryResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: id, card_id, board_id, column_id, subcolumn_id, lane_id, sprint_id, author_id, author, condition, changed.

updateCard

client.cards.updateCard · PATCH /api/latest/cards/{card_id}

Update card. Документация Kaiten.

...args: CardsUpdateCardParams

declare const updateCard: (
  cardId: number,
  body: CardsUpdateCardBody,
  options?: OperationOptions,
) => Promise<CardsUpdateCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	number \| string	Необязательно
`asap`	boolean	Необязательно
`due_date`	string \| null	Необязательно
`due_date_time_present`	boolean	Необязательно
`sort_order`	number	Необязательно
`description`	number \| string \| null	Необязательно
`expires_later`	boolean	Необязательно
`size_text`	number \| string \| null	Необязательно
`board_id`	integer	Необязательно
`column_id`	integer	Необязательно
`lane_id`	integer	Необязательно
`owner_id`	integer	Необязательно
`type_id`	integer	Необязательно
`service_id`	integer \| null	Необязательно
`blocked`	boolean	Необязательно
`condition`	1 \| 2	Необязательно
`external_id`	number \| string \| null	Необязательно
`text_format_type_id`	1 \| 2 \| 3	Необязательно
`sd_new_comment`	boolean	Необязательно
`owner_email`	string	Необязательно
`prev_card_id`	integer	Необязательно
`estimate_workload`	number	Необязательно
`ignore_planned_dates_recalculation`	boolean	Необязательно
`properties`	object	Необязательно

checklistItems

addItemToChecklist

client.checklistItems.addItemToChecklist · POST /api/latest/checklists/{checklist_id}/items

Add item to checklist. Документация Kaiten.

...args: ChecklistItemsAddItemToChecklistParams

declare const addItemToChecklist: (
  checklistId: number,
  body: ChecklistItemsAddItemToChecklistBody,
  options?: OperationOptions,
) => Promise<ChecklistItemsAddItemToChecklistResponse>;

Параметры пути

Поле	Тип	Обязательность
`checklist_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`text`	string	Обязательно
`sort_order`	number	Необязательно
`checked`	boolean	Необязательно
`due_date`	string \| null	Необязательно
`responsible_id`	integer	Необязательно

Ответ: Объект. Поля: created, updated, id, text, sort_order, checked, checklist_id, checker_id, user_id, checked_at, responsible_id, deleted, due_date.

removeChecklistItem

client.checklistItems.removeChecklistItem · DELETE /api/latest/checklists/{checklist_id}/items/{id}

Remove checklist item. Документация Kaiten.

...args: ChecklistItemsRemoveChecklistItemParams

declare const removeChecklistItem: (
  checklistId: number,
  itemId: number,
  options?: OperationOptions,
) => Promise<ChecklistItemsRemoveChecklistItemResponse>;

Параметры пути

Поле	Тип	Обязательность
`checklist_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

updateChecklistItem

client.checklistItems.updateChecklistItem · PATCH /api/latest/checklists/{checklist_id}/items/{id}

Update checklist item. Документация Kaiten.

...args: ChecklistItemsUpdateChecklistItemParams

declare const updateChecklistItem: (
  checklistId: number,
  itemId: number,
  body: ChecklistItemsUpdateChecklistItemBody,
  options?: OperationOptions,
) => Promise<ChecklistItemsUpdateChecklistItemResponse>;

Параметры пути

Поле	Тип	Обязательность
`checklist_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`text`	string \| null	Необязательно
`sort_order`	number	Необязательно
`checklist_id`	integer	Необязательно
`checked`	boolean	Необязательно
`due_date`	string \| null	Необязательно
`responsible_id`	number \| null	Необязательно

Ответ: Объект. Поля: created, updated, id, text, sort_order, checked, checklist_id, checker_id, user_id, checked_at, responsible_id, deleted, due_date.

checklists

retrieveCardsWithChecklist

client.checklists.retrieveCardsWithChecklist · GET /api/latest/checklists/{id}

Retrieve cards with checklist. Документация Kaiten.

...args: ChecklistsRetrieveCardsWithChecklistParams

declare const retrieveCardsWithChecklist: (
  id: number,
  onlySharedCards: boolean,
  options?: OperationOptions,
) => Promise<ChecklistsRetrieveCardsWithChecklistResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`only_shared_cards`	boolean	Обязательно

Ответ: Массив. Поля: created, updated, archived, id, title, asap, due_date, sort_order, description, state, expires_later, parents_count, children_count, children_done, goals_total, goals_done, parent_checklist_ids, parent_link_ids, blocked, size, size_unit, size_text, due_date_time_present, board_id, column_id, lane_id, owner_id, type_id, version, updater_id, completed_on_time, completed_at, project_id, milestone_id, fifo_order, blocking_card, sprint_id, condition, last_moved_at, external_id, lane_changed_at, column_changed_at, first_moved_to_in_progress_at, last_moved_to_done_at, service_id, has_blocked_children, comments_total, comment_last_added_at, children_ids, parents_ids, properties, planned_start, planned_end, ignore_planned_dates_recalculation, counters_recalculated_at, sd_new_comment, public, share_id, share_settings, sd_external_recipients, external_user_emails, time_spent_sum, calculated_planned_start, calculated_planned_end, time_blocked_sum, children_number_properties_sum, description_filled, import_id, tag_ids, has_access_to_space, path_data, space_id.

columns

createNewColumn

client.columns.createNewColumn · POST /api/latest/boards/{board_id}/columns

Create new column. Документация Kaiten.

...args: ColumnsCreateNewColumnParams

declare const createNewColumn: (
  boardId: number,
  body: ColumnsCreateNewColumnBody,
  options?: OperationOptions,
) => Promise<ColumnsCreateNewColumnResponse>;

Параметры пути

Поле	Тип	Обязательность
`board_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`external_id`	number \| string \| null	Необязательно
`title`	string	Обязательно
`sort_order`	number	Необязательно
`type`	1 \| 2 \| 3	Необязательно
`last_moved_warning_after_days`	integer	Необязательно
`last_moved_warning_after_hours`	integer	Необязательно
`last_moved_warning_after_minutes`	integer	Необязательно
`wip_limit`	integer	Необязательно
`wip_limit_type`	1 \| 2	Необязательно
`col_count`	integer	Необязательно
`archive_after_days`	integer	Необязательно
`months_to_hide_cards`	integer \| null	Необязательно
`card_hide_after_days`	integer \| null	Необязательно
`rules`	integer	Необязательно

Ответ: Объект. Поля: created, updated, id, title, sort_order, col_count, wip_limit, type, rules, board_id, column_id, archive_after_days, wip_limit_type, external_id, default_tags, last_moved_warning_after_minutes, last_moved_warning_after_days, last_moved_warning_after_hours, months_to_hide_cards, card_hide_after_days.

getListOfColumns

client.columns.getListOfColumns · GET /api/latest/boards/{board_id}/columns

Get list of columns. Документация Kaiten.

...args: ColumnsGetListOfColumnsParams

declare const getListOfColumns: (
  boardId: number,
  options?: OperationOptions,
) => Promise<ColumnsGetListOfColumnsResponse>;

Параметры пути

Поле	Тип	Обязательность
`board_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: created, updated, id, title, sort_order, col_count, wip_limit, wip_limit_type, type, rules, board_id, column_id, archive_after_days, last_moved_warning_after_minutes, last_moved_warning_after_days, last_moved_warning_after_hours, external_id, default_tags, months_to_hide_cards, card_hide_after_days, pause_sla, subcolumns.

removeColumn

client.columns.removeColumn · DELETE /api/latest/boards/{board_id}/columns/{id}

Remove column. Документация Kaiten.

...args: ColumnsRemoveColumnParams

declare const removeColumn: (
  boardId: number,
  columnId: number,
  force?: boolean,
  options?: OperationOptions,
) => Promise<ColumnsRemoveColumnResponse>;

Параметры пути

Поле	Тип	Обязательность
`board_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`force`	boolean	Необязательно

Ответ: Объект. Поля: id.

updateColumn

client.columns.updateColumn · PATCH /api/latest/boards/{board_id}/columns/{id}

Update column. Документация Kaiten.

...args: ColumnsUpdateColumnParams

declare const updateColumn: (
  boardId: number,
  columnId: number,
  body: ColumnsUpdateColumnBody,
  options?: OperationOptions,
) => Promise<ColumnsUpdateColumnResponse>;

Параметры пути

Поле	Тип	Обязательность
`board_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`external_id`	number \| string \| null	Необязательно
`title`	string	Необязательно
`sort_order`	number	Необязательно
`type`	1 \| 2 \| 3	Необязательно
`wip_limit`	integer \| null	Необязательно
`wip_limit_type`	1 \| 2	Необязательно
`last_moved_warning_after_days`	integer	Необязательно
`last_moved_warning_after_hours`	integer	Необязательно
`last_moved_warning_after_minutes`	integer	Необязательно
`col_count`	integer	Необязательно
`archive_after_days`	integer	Необязательно
`months_to_hide_cards`	integer \| null	Необязательно
`card_hide_after_days`	integer \| null	Необязательно
`rules`	integer	Необязательно
`default_tags`	string \| null	Необязательно
`prev_column_id`	integer \| null	Необязательно
`next_column_id`	integer \| null	Необязательно
`pause_sla`	boolean	Необязательно

companyUsers

getListOfUsers

client.companyUsers.getListOfUsers · GET /api/latest/company/users

Get list of users. Документация Kaiten.

...args: CompanyUsersGetListOfUsersParams

declare const getListOfUsers: (
  query?: CompanyUsersGetListOfUsersQuery,
  options?: OperationOptions,
) => Promise<CompanyUsersGetListOfUsersResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`invitesOnly`	boolean	Необязательно
`withTransferAccessStatus`	boolean	Необязательно
`for_members_section`	boolean	Необязательно
`owner_only`	boolean	Необязательно
`only_paid`	boolean	Необязательно
`only_records_count`	boolean	Необязательно
`only_virtual`	boolean	Необязательно
`offset`	integer	Необязательно
`limit`	integer	Необязательно
`query`	string	Необязательно
`access_type_permissions`	string	Необязательно
`sd_access_type`	string	Необязательно
`take_licence`	string	Необязательно
`temporarily_inactive_status`	string	Необязательно
`group_ids`	array	Необязательно
`permissions`	array	Необязательно

Ответ: Массив. Поля: id, uid, full_name, email, username, avatar_initials_url, avatar_uploaded_url, initials, avatar_type, lng, timezone, theme, created, updated, activated, ui_version, virtual, email_blocked, email_blocked_reason, delete_requested_at, permissions, own_permissions, spaces, groups, company_id, user_id, default_space_id, role, email_frequency, email_settings, slack_id, slack_settings, notification_settings, notification_enabled_channels, slack_private_channel_id, telegram_sd_bot_enabled, invite_last_sent_at, apps_permissions, external, last_request_date, last_request_method, work_time_settings, personal_settings, locked, take_licence.

removeVirtualUser

client.companyUsers.removeVirtualUser · DELETE /api/latest/company/users/{id}

Remove virtual user. Документация Kaiten.

...args: CompanyUsersRemoveVirtualUserParams

declare const removeVirtualUser: (
  userId: number,
  options?: OperationOptions,
) => Promise<CompanyUsersRemoveVirtualUserResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

updateUser

client.companyUsers.updateUser · PATCH /api/latest/company/users/{id}

Update user. Документация Kaiten.

...args: CompanyUsersUpdateUserParams

declare const updateUser: (
  userId: number,
  appsPermissions?: number,
  temporarilyInactive?: boolean,
  options?: OperationOptions,
) => Promise<CompanyUsersUpdateUserResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`apps_permissions`	integer	Необязательно
`temporarily_inactive`	boolean	Необязательно

Ответ: Объект. Поля: id, uid, full_name, email, username, avatar_initials_url, avatar_uploaded_url, initials, avatar_type, lng, timezone, theme, created, updated, activated, ui_version, virtual, email_blocked, email_blocked_reason, delete_requested_at, user_id, company_id, default_space_id, role, permissions, apps_permissions, email_frequency, email_settings, slack_id, slack_private_channel_id, slack_settings, telegram_sd_bot_enabled, external, notification_settings, work_time_settings, invite_last_sent_at, last_request_date, last_request_method, notification_enabled_channels, personal_settings, locked, temporarily_inactive.

customDirectories

createCustomDirectory

client.customDirectories.createCustomDirectory · POST /api/latest/company/custom-directories

Create custom directory. Документация Kaiten. Beta.

...args: CustomDirectoriesCreateCustomDirectoryParams

declare const createCustomDirectory: (
  body: CustomDirectoriesCreateCustomDirectoryBody,
  options?: OperationOptions,
) => Promise<CustomDirectoriesCreateCustomDirectoryResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Обязательно
`description`	null \| string	Необязательно
`multi_select`	boolean	Необязательно
`allow_editing`	boolean	Необязательно
`display_field_index`	integer	Необязательно
`fields`	array of object	Необязательно

Ответ: Объект. Поля: id, name, description, condition, settings, author_uid, company_uid, created, updated, fields.

deleteCustomDirectory

client.customDirectories.deleteCustomDirectory · DELETE /api/latest/company/custom-directories/{directory_id}

Delete custom directory. Документация Kaiten. Beta.

...args: CustomDirectoriesDeleteCustomDirectoryParams

declare const deleteCustomDirectory: (
  directoryId: string,
  options?: OperationOptions,
) => Promise<CustomDirectoriesDeleteCustomDirectoryResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id, name, condition, updated.

getCustomDirectory

client.customDirectories.getCustomDirectory · GET /api/latest/company/custom-directories/{directory_id}

Get custom directory. Документация Kaiten. Beta.

...args: CustomDirectoriesGetCustomDirectoryParams

declare const getCustomDirectory: (
  directoryId: string,
  options?: OperationOptions,
) => Promise<CustomDirectoriesGetCustomDirectoryResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id, name, description, condition, settings, author_uid, company_uid, created, updated, author, fields.

getListOfCustomDirectories

client.customDirectories.getListOfCustomDirectories · GET /api/latest/company/custom-directories

Get list of custom directories. Документация Kaiten. Beta.

...args: CustomDirectoriesGetListOfCustomDirectoriesParams

declare const getListOfCustomDirectories: (
  query?: CustomDirectoriesGetListOfCustomDirectoriesQuery,
  options?: OperationOptions,
) => Promise<CustomDirectoriesGetListOfCustomDirectoriesResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`include_fields`	boolean	Необязательно
`include_author`	boolean	Необязательно
`include_records_count`	boolean	Необязательно
`limit`	number	Необязательно
`offset`	number	Необязательно
`query`	string	Необязательно
`conditions`	array of strings	Необязательно

Ответ: Массив. Поля: id, name, description, condition, settings, records_count, created, updated.

updateCustomDirectory

client.customDirectories.updateCustomDirectory · PATCH /api/latest/company/custom-directories/{directory_id}

Update custom directory. Документация Kaiten. Beta.

...args: CustomDirectoriesUpdateCustomDirectoryParams

declare const updateCustomDirectory: (
  directoryId: string,
  body: CustomDirectoriesUpdateCustomDirectoryBody,
  options?: OperationOptions,
) => Promise<CustomDirectoriesUpdateCustomDirectoryResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`description`	null \| string	Необязательно
`condition`	active \| inactive \| removed	Необязательно
`multi_select`	boolean	Необязательно
`allow_editing`	boolean	Необязательно
`fields`	array of object	Необязательно

Ответ: Объект. Поля: id, name, description, condition, settings, author_uid, company_uid, created, updated, author, fields.

customDirectoryFields

createField

client.customDirectoryFields.createField · POST /api/latest/company/custom-directories/{directory_id}/fields

Create field. Документация Kaiten. Beta.

...args: CustomDirectoryFieldsCreateFieldParams

declare const createField: (
  directoryId: string,
  body: CustomDirectoryFieldsCreateFieldBody,
  options?: OperationOptions,
) => Promise<CustomDirectoryFieldsCreateFieldResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Обязательно
`type`	string \| number \| date \| email \| url \| phone \| checkbox \| select \| user \| catalog \| directory_link \| file	Обязательно
`sort_order`	integer	Необязательно
`required`	boolean	Необязательно
`is_display`	boolean	Необязательно

Ответ: Объект. Поля: id, custom_directory_id, name, type, custom_property_uid, linked_directory_id, reverse_field_id, condition, required, is_display, sort_order, settings, author_uid, company_uid, created, updated.

deleteField

client.customDirectoryFields.deleteField · DELETE /api/latest/company/custom-directories/{directory_id}/fields/{field_id}

Delete field. Документация Kaiten. Beta.

...args: CustomDirectoryFieldsDeleteFieldParams

declare const deleteField: (
  directoryId: string,
  fieldId: string,
  options?: OperationOptions,
) => Promise<CustomDirectoryFieldsDeleteFieldResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно
`field_id`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id, custom_directory_id, name, type, condition, updated.

getField

client.customDirectoryFields.getField · GET /api/latest/company/custom-directories/{directory_id}/fields/{field_id}

Get field. Документация Kaiten. Beta.

...args: CustomDirectoryFieldsGetFieldParams

declare const getField: (
  directoryId: string,
  fieldId: string,
  options?: OperationOptions,
) => Promise<CustomDirectoryFieldsGetFieldResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно
`field_id`	string	Обязательно

Параметры запроса

нет.

getListOfFields

client.customDirectoryFields.getListOfFields · GET /api/latest/company/custom-directories/{directory_id}/fields

Get list of fields. Документация Kaiten. Beta.

...args: CustomDirectoryFieldsGetListOfFieldsParams

declare const getListOfFields: (
  directoryId: string,
  includeAuthor?: boolean,
  conditions?: ('active' | 'inactive' | 'removed')[],
  options?: OperationOptions,
) => Promise<CustomDirectoryFieldsGetListOfFieldsResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`include_author`	boolean	Необязательно
`conditions`	array of strings	Необязательно

Ответ: Массив. Поля: id, custom_directory_id, name, type, required, is_display, sort_order, condition.

updateField

client.customDirectoryFields.updateField · PATCH /api/latest/company/custom-directories/{directory_id}/fields/{field_id}

Update field. Документация Kaiten. Beta.

...args: CustomDirectoryFieldsUpdateFieldParams

declare const updateField: (
  directoryId: string,
  fieldId: string,
  body: CustomDirectoryFieldsUpdateFieldBody,
  options?: OperationOptions,
) => Promise<CustomDirectoryFieldsUpdateFieldResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно
`field_id`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`condition`	active \| inactive \| removed	Необязательно
`sort_order`	integer	Необязательно
`required`	boolean	Необязательно
`is_display`	boolean	Необязательно

customDirectoryRecords

createRecord

client.customDirectoryRecords.createRecord · POST /api/latest/company/custom-directories/{directory_id}/records

Create record. Документация Kaiten. Beta.

...args: CustomDirectoryRecordsCreateRecordParams

declare const createRecord: (
  directoryId: string,
  body: CustomDirectoryRecordsCreateRecordBody,
  responseProfile?: string,
  options?: OperationOptions,
) => Promise<CustomDirectoryRecordsCreateRecordResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`response_profile`	string	Необязательно

Тело запроса

Поле	Тип	Обязательность
`values`	object	Обязательно

Ответ: Объект. Поля: id, custom_directory_id, display_value, condition, author_uid, updater_uid, company_uid, created, updated, author, updater, values.

deleteRecord

client.customDirectoryRecords.deleteRecord · DELETE /api/latest/company/custom-directories/{directory_id}/records/{record_id}

Delete record. Документация Kaiten. Beta.

...args: CustomDirectoryRecordsDeleteRecordParams

declare const deleteRecord: (
  directoryId: string,
  recordId: string,
  options?: OperationOptions,
) => Promise<CustomDirectoryRecordsDeleteRecordResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно
`record_id`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id, custom_directory_id, condition, updated.

getCardsLinkedToRecord

client.customDirectoryRecords.getCardsLinkedToRecord · GET /api/latest/company/custom-directories/{directory_id}/records/{record_id}/cards

Get cards linked to record. Документация Kaiten. Beta.

...args: CustomDirectoryRecordsGetCardsLinkedToRecordParams

declare const getCardsLinkedToRecord: (
  directoryId: string,
  recordId: string,
  query?: CustomDirectoryRecordsGetCardsLinkedToRecordQuery,
  options?: OperationOptions,
) => Promise<CustomDirectoryRecordsGetCardsLinkedToRecordResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно
`record_id`	string	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`limit`	number	Необязательно
`offset`	number	Необязательно
`filter`	string	Необязательно

Ответ: Массив. Поля: id, uid, title.

getListOfRecords

client.customDirectoryRecords.getListOfRecords · GET /api/latest/company/custom-directories/{directory_id}/records

Get list of records. Документация Kaiten. Beta.

...args: CustomDirectoryRecordsGetListOfRecordsParams

declare const getListOfRecords: (
  directoryId: string,
  query?: CustomDirectoryRecordsGetListOfRecordsQuery,
  options?: OperationOptions,
) => Promise<CustomDirectoryRecordsGetListOfRecordsResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`limit`	number	Необязательно
`offset`	number	Необязательно
`query`	string	Необязательно
`profile`	string	Необязательно
`include_values`	boolean	Необязательно
`include_author`	boolean	Необязательно
`conditions`	array of strings	Необязательно
`filters`	object	Необязательно
`filter_operator`	string	Необязательно

Ответ: Массив. Поля: id, custom_directory_id, display_value, condition, created, updated, values.

getRecord

client.customDirectoryRecords.getRecord · GET /api/latest/company/custom-directories/{directory_id}/records/{record_id}

Get record. Документация Kaiten. Beta.

...args: CustomDirectoryRecordsGetRecordParams

declare const getRecord: (
  directoryId: string,
  recordId: string,
  profile?: string,
  options?: OperationOptions,
) => Promise<CustomDirectoryRecordsGetRecordResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно
`record_id`	string	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`profile`	string	Необязательно

Ответ: Объект. Поля: id, custom_directory_id, display_value, condition, author_uid, updater_uid, company_uid, created, updated, author, updater, values.

updateRecord

client.customDirectoryRecords.updateRecord · PATCH /api/latest/company/custom-directories/{directory_id}/records/{record_id}

Update record. Документация Kaiten. Beta.

...args: CustomDirectoryRecordsUpdateRecordParams

declare const updateRecord: (
  directoryId: string,
  recordId: string,
  body: CustomDirectoryRecordsUpdateRecordBody,
  responseProfile?: string,
  options?: OperationOptions,
) => Promise<CustomDirectoryRecordsUpdateRecordResponse>;

Параметры пути

Поле	Тип	Обязательность
`directory_id`	string	Обязательно
`record_id`	string	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`response_profile`	string	Необязательно

Тело запроса

Поле	Тип	Обязательность
`condition`	active \| inactive \| removed	Необязательно
`values`	object	Необязательно

Ответ: Объект. Поля: id, custom_directory_id, display_value, condition, author_uid, updater_uid, company_uid, created, updated, author, updater, values.

customProperties

createNewProperty

client.customProperties.createNewProperty · POST /api/latest/company/custom-properties

Create new property. Документация Kaiten.

...args: CustomPropertiesCreateNewPropertyParams

declare const createNewProperty: (
  body: CustomPropertiesCreateNewPropertyBody,
  options?: OperationOptions,
) => Promise<CustomPropertiesCreateNewPropertyResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`show_on_facade`	boolean	Необязательно
`multiline`	boolean	Необязательно
`vote_variant`	null \| rating \| scale \| emoji_set	Необязательно
`type`	string \| number \| date \| email \| phone \| checkbox \| select \| formula \| url \| collective_score \| vote \| collective_vote \| catalog \| user \| attachment	Необязательно
`values_type`	null \| number \| text	Необязательно
`colorful`	boolean \| null	Необязательно
`multi_select`	boolean \| null	Необязательно
`values_creatable_by_users`	boolean \| null	Необязательно
`data`	unknown \| unknown \| unknown \| unknown \| unknown	Необязательно
`formula`	string	Необязательно
`formula_source_card`	object	Необязательно
`color`	integer \| null	Необязательно
`fields_settings`	object	Необязательно

Ответ: Объект. Поля: name, type, show_on_facade, multiline, fields_settings, author_id, company_id, updated, created, id, condition, colorful, multi_select, values_creatable_by_users, data, values_type, vote_variant, protected, color, external_id.

getListOfProperties

client.customProperties.getListOfProperties · GET /api/latest/company/custom-properties

Get list of properties. Документация Kaiten.

...args: CustomPropertiesGetListOfPropertiesParams

declare const getListOfProperties: (
  query?: CustomPropertiesGetListOfPropertiesQuery,
  options?: OperationOptions,
) => Promise<CustomPropertiesGetListOfPropertiesResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`include_values`	boolean	Необязательно
`include_author`	boolean	Необязательно
`compact`	boolean	Необязательно
`load_by_ids`	boolean	Необязательно
`ids`	array	Необязательно
`offset`	integer	Необязательно
`limit`	integer	Необязательно
`order_by`	string	Необязательно
`order_direction`	string	Необязательно
`query`	string	Необязательно

Ответ: Массив. Поля: created, updated, id, uid, type, name, condition, show_on_facade, multiline, author_id, company_id, colorful, multi_select, values_creatable_by_users, values_type, vote_variant, data, protected, fields_settings, color, external_id.

getProperty

client.customProperties.getProperty · GET /api/latest/company/custom-properties/{id}

Get property. Документация Kaiten.

...args: CustomPropertiesGetPropertyParams

declare const getProperty: (
  propertyId: number,
  options?: OperationOptions,
) => Promise<CustomPropertiesGetPropertyResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, id, uid, type, name, condition, show_on_facade, multiline, author_id, company_id, colorful, multi_select, values_creatable_by_users, values_type, vote_variant, data, protected, fields_settings, color, external_id.

removeProperty

client.customProperties.removeProperty · DELETE /api/latest/company/custom-properties/{id}

Remove property. Документация Kaiten.

...args: CustomPropertiesRemovePropertyParams

declare const removeProperty: (
  propertyId: number,
  options?: OperationOptions,
) => Promise<CustomPropertiesRemovePropertyResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, id, type, name, show_on_facade, author_id, company_id, condition, colorful, multi_select, values_creatable_by_users, data, multiline, values_type, vote_variant, protected, fields_settings, color.

updateProperty

client.customProperties.updateProperty · PATCH /api/latest/company/custom-properties/{id}

Update property. Документация Kaiten.

...args: CustomPropertiesUpdatePropertyParams

declare const updateProperty: (
  propertyId: number,
  body: CustomPropertiesUpdatePropertyBody,
  options?: OperationOptions,
) => Promise<CustomPropertiesUpdatePropertyResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`show_on_facade`	boolean	Необязательно
`multiline`	boolean	Необязательно
`condition`	active \| inactive	Необязательно
`colorful`	boolean \| null	Необязательно
`multi_select`	boolean \| null	Необязательно
`values_creatable_by_users`	boolean \| null	Необязательно
`data`	unknown \| unknown \| unknown \| unknown \| unknown	Необязательно
`color`	integer \| null	Необязательно
`fields_settings`	object \| null	Необязательно
`is_used_as_progress`	boolean	Необязательно

customPropertyCatalogValues

createNewCatalogValue

client.customPropertyCatalogValues.createNewCatalogValue · POST /api/latest/company/custom-properties/{property_id}/catalog-values

Create new catalog value. Документация Kaiten.

...args: CustomPropertyCatalogValuesCreateNewCatalogValueParams

declare const createNewCatalogValue: (
  propertyId: number,
  body: CustomPropertyCatalogValuesCreateNewCatalogValueBody,
  options?: OperationOptions,
) => Promise<CustomPropertyCatalogValuesCreateNewCatalogValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`value`	object	Обязательно

Ответ: Объект. Поля: created, updated, id, custom_property_id, value, name, author_id, updater_id, condition.

getCatalogValue

client.customPropertyCatalogValues.getCatalogValue · GET /api/latest/company/custom-properties/{property_id}/catalog-values/{id}

Get catalog value. Документация Kaiten.

...args: CustomPropertyCatalogValuesGetCatalogValueParams

declare const getCatalogValue: (
  propertyId: number,
  valueId: number,
  options?: OperationOptions,
) => Promise<CustomPropertyCatalogValuesGetCatalogValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, id, custom_property_id, value, name, author_id, updater_id, condition.

getListOfCatalogValues

client.customPropertyCatalogValues.getListOfCatalogValues · GET /api/latest/company/custom-properties/{property_id}/catalog-values

Get list of catalog values. Документация Kaiten.

...args: CustomPropertyCatalogValuesGetListOfCatalogValuesParams

declare const getListOfCatalogValues: (
  propertyId: number,
  query?: CustomPropertyCatalogValuesGetListOfCatalogValuesQuery,
  options?: OperationOptions,
) => Promise<CustomPropertyCatalogValuesGetListOfCatalogValuesResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`query`	string	Необязательно
`conditions`	enum	Необязательно
`limit`	integer	Необязательно
`offset`	integer	Необязательно

Ответ: Массив. Поля: created, updated, id, custom_property_id, value, name, author_id, updater_id, condition.

removeProperty

client.customPropertyCatalogValues.removeProperty · DELETE /api/latest/company/custom-properties/{property_id}/catalog-values/{id}

Remove property. Документация Kaiten.

...args: CustomPropertyCatalogValuesRemovePropertyParams

declare const removeProperty: (
  propertyId: number,
  valueId: number,
  options?: OperationOptions,
) => Promise<CustomPropertyCatalogValuesRemovePropertyResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, id, custom_property_id, value, name, author_id, updater_id, condition.

updateCatalogValue

client.customPropertyCatalogValues.updateCatalogValue · PATCH /api/latest/company/custom-properties/{property_id}/catalog-values/{id}

Update catalog value. Документация Kaiten.

...args: CustomPropertyCatalogValuesUpdateCatalogValueParams

declare const updateCatalogValue: (
  propertyId: number,
  valueId: number,
  body: CustomPropertyCatalogValuesUpdateCatalogValueBody,
  options?: OperationOptions,
) => Promise<CustomPropertyCatalogValuesUpdateCatalogValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`condition`	active \| inactive	Необязательно
`value`	object	Необязательно
`deleted`	boolean	Необязательно

Ответ: Объект. Поля: created, updated, id, custom_property_id, value, name, author_id, updater_id, condition.

customPropertyCollectiveScoreValues

createNewScoreValue

client.customPropertyCollectiveScoreValues.createNewScoreValue · POST /api/latest/cards/{card_id}/custom-properties/{property_id}/collective-score-values

Create new score value. Документация Kaiten.

...args: CustomPropertyCollectiveScoreValuesCreateNewScoreValueParams

declare const createNewScoreValue: (
  cardId: number,
  propertyId: number,
  value: string,
  options?: OperationOptions,
) => Promise<CustomPropertyCollectiveScoreValuesCreateNewScoreValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`property_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`value`	string	Обязательно

Ответ: Объект. Поля: created, updated, id, value, custom_property_id, author_id, updater_id, company_id, card_id.

getListOfScoreValues

client.customPropertyCollectiveScoreValues.getListOfScoreValues · GET /api/latest/cards/{card_id}/custom-properties/{property_id}/collective-score-values

Get list of score values. Документация Kaiten.

...args: CustomPropertyCollectiveScoreValuesGetListOfScoreValuesParams

declare const getListOfScoreValues: (
  cardId: number,
  propertyId: number,
  options?: OperationOptions,
) => Promise<CustomPropertyCollectiveScoreValuesGetListOfScoreValuesResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`property_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: id, custom_property_id, value, card_id, author_id, author.

updateScoreValue

client.customPropertyCollectiveScoreValues.updateScoreValue · PATCH /api/latest/cards/{card_id}/custom-properties/{property_id}/collective-score-values/{id}

Update score value. Документация Kaiten.

...args: CustomPropertyCollectiveScoreValuesUpdateScoreValueParams

declare const updateScoreValue: (
  cardId: number,
  propertyId: number,
  valueId: number,
  value: string | null,
  options?: OperationOptions,
) => Promise<CustomPropertyCollectiveScoreValuesUpdateScoreValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`property_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`value`	string \| null	Необязательно

Ответ: Объект. Поля: created, updated, id, value, custom_property_id, author_id, updater_id, company_id, card_id.

customPropertyCollectiveVoteValues

createNewVoteValue

client.customPropertyCollectiveVoteValues.createNewVoteValue · POST /api/latest/cards/{card_id}/custom-properties/{property_id}/collective-vote-values

Create new vote value. Документация Kaiten.

...args: CustomPropertyCollectiveVoteValuesCreateNewVoteValueParams

declare const createNewVoteValue: (
  cardId: number,
  propertyId: number,
  body: CustomPropertyCollectiveVoteValuesCreateNewVoteValueBody,
  options?: OperationOptions,
) => Promise<CustomPropertyCollectiveVoteValuesCreateNewVoteValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`property_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`emoji_vote`	string	Необязательно
`number_vote`	integer	Необязательно

Ответ: Объект. Поля: created, updated, id, number_vote, emoji_vote, custom_property_id, author_id, company_id, card_id.

getListOfVoteValues

client.customPropertyCollectiveVoteValues.getListOfVoteValues · GET /api/latest/cards/{card_id}/custom-properties/{property_id}/collective-vote-values

Get list of vote values. Документация Kaiten.

...args: CustomPropertyCollectiveVoteValuesGetListOfVoteValuesParams

declare const getListOfVoteValues: (
  cardId: number,
  propertyId: number,
  options?: OperationOptions,
) => Promise<CustomPropertyCollectiveVoteValuesGetListOfVoteValuesResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`property_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: id, custom_property_id, number_vote, emoji_vote, card_id, author_id, author.

removeVoteValue

client.customPropertyCollectiveVoteValues.removeVoteValue · DELETE /api/latest/cards/{card_id}/custom-properties/{property_id}/collective-vote-values/{id}

Remove vote value. Документация Kaiten.

...args: CustomPropertyCollectiveVoteValuesRemoveVoteValueParams

declare const removeVoteValue: (
  cardId: number,
  propertyId: number,
  id: number,
  emojiVote: string,
  options?: OperationOptions,
) => Promise<CustomPropertyCollectiveVoteValuesRemoveVoteValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`property_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`emoji_vote`	string	Необязательно

Ответ: Объект. Поля: id, custom_property_id, number_vote, emoji_vote, card_id, author_id.

updateVoteValue

client.customPropertyCollectiveVoteValues.updateVoteValue · PATCH /api/latest/cards/{card_id}/custom-properties/{property_id}/collective-vote-values/{id}

Update vote value. Документация Kaiten.

...args: CustomPropertyCollectiveVoteValuesUpdateVoteValueParams

declare const updateVoteValue: (
  cardId: number,
  propertyId: number,
  id: number,
  numberVote?: number | null,
  options?: OperationOptions,
) => Promise<CustomPropertyCollectiveVoteValuesUpdateVoteValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_id`	integer	Обязательно
`property_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`number_vote`	number \| null	Необязательно

Ответ: Объект. Поля: created, updated, id, number_vote, emoji_vote, custom_property_id, author_id, company_id, card_id.

customPropertySelectValues

createNewSelectValue

client.customPropertySelectValues.createNewSelectValue · POST /api/latest/company/custom-properties/{property_id}/select-values

Create new select value. Документация Kaiten.

...args: CustomPropertySelectValuesCreateNewSelectValueParams

declare const createNewSelectValue: (
  propertyId: number,
  value: string,
  color?: number | null,
  options?: OperationOptions,
) => Promise<CustomPropertySelectValuesCreateNewSelectValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`value`	string	Обязательно
`color`	integer \| null	Необязательно

Ответ: Объект. Поля: created, updated, id, custom_property_id, value, color, author_id, company_id, sort_order, external_id, condition.

getListOfSelectValues

client.customPropertySelectValues.getListOfSelectValues · GET /api/latest/company/custom-properties/{property_id}/select-values

Get list of select values. Документация Kaiten.

...args: CustomPropertySelectValuesGetListOfSelectValuesParams

declare const getListOfSelectValues: (
  propertyId: number,
  query?: CustomPropertySelectValuesGetListOfSelectValuesQuery,
  options?: OperationOptions,
) => Promise<CustomPropertySelectValuesGetListOfSelectValuesResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`v2_select_search`	boolean	Необязательно
`query`	string	Необязательно
`order_by`	string	Необязательно
`ids`	array	Необязательно
`conditions`	array	Необязательно
`offset`	integer	Необязательно
`limit`	integer	Необязательно

Ответ: Массив. Поля: id, custom_property_id, value, color, sort_order, external_id, updated, condition.

getSelectValue

client.customPropertySelectValues.getSelectValue · GET /api/latest/company/custom-properties/{property_id}/select-values/{id}

Get select value. Документация Kaiten.

...args: CustomPropertySelectValuesGetSelectValueParams

declare const getSelectValue: (
  propertyId: number,
  valueId: number,
  options?: OperationOptions,
) => Promise<CustomPropertySelectValuesGetSelectValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, id, custom_property_id, value, color, author_id, company_id, sort_order, external_id, condition.

removeProperty

client.customPropertySelectValues.removeProperty · DELETE /api/latest/company/custom-properties/{property_id}/select-values/{id}

Remove property. Документация Kaiten.

...args: CustomPropertySelectValuesRemovePropertyParams

declare const removeProperty: (
  propertyId: number,
  valueId: number,
  options?: OperationOptions,
) => Promise<CustomPropertySelectValuesRemovePropertyResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, id, custom_property_id, value, color, author_id, company_id, sort_order, external_id, condition.

updateSelectValue

client.customPropertySelectValues.updateSelectValue · PATCH /api/latest/company/custom-properties/{property_id}/select-values/{id}

Update select value. Документация Kaiten.

...args: CustomPropertySelectValuesUpdateSelectValueParams

declare const updateSelectValue: (
  propertyId: number,
  valueId: number,
  body: CustomPropertySelectValuesUpdateSelectValueBody,
  options?: OperationOptions,
) => Promise<CustomPropertySelectValuesUpdateSelectValueResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`value`	string	Необязательно
`color`	integer \| null	Необязательно
`condition`	active \| inactive	Необязательно
`sort_order`	number	Необязательно
`deleted`	boolean	Необязательно

Ответ: Объект. Поля: created, updated, id, custom_property_id, value, color, author_id, company_id, sort_order, external_id, condition.

customPropertyTreeEntities

addTreeEntityToCustomProperty

client.customPropertyTreeEntities.addTreeEntityToCustomProperty · POST /api/latest/company/custom-properties/{property_id}/tree-entities

Add tree entity to custom property. Документация Kaiten.

...args: CustomPropertyTreeEntitiesAddTreeEntityToCustomPropertyParams

declare const addTreeEntityToCustomProperty: (
  propertyId: number,
  treeEntityUid: string,
  options?: OperationOptions,
) => Promise<CustomPropertyTreeEntitiesAddTreeEntityToCustomPropertyResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`tree_entity_uid`	string	Обязательно

Ответ: Объект. Поля: id.

deleteTreeEntityFromCustomProperty

client.customPropertyTreeEntities.deleteTreeEntityFromCustomProperty · DELETE /api/latest/company/custom-properties/{property_id}/tree-entities/{uid}

Delete tree entity from custom property. Документация Kaiten.

...args: CustomPropertyTreeEntitiesDeleteTreeEntityFromCustomPropertyParams

declare const deleteTreeEntityFromCustomProperty: (
  propertyId: number,
  uid: string,
  options?: OperationOptions,
) => Promise<void>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно
`uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Без тела

getListOfCustomPropertyTreeEntities

client.customPropertyTreeEntities.getListOfCustomPropertyTreeEntities · GET /api/latest/company/custom-properties/{property_id}/tree-entities

Get list of custom property tree entities. Документация Kaiten.

...args: CustomPropertyTreeEntitiesGetListOfCustomPropertyTreeEntitiesParams

declare const getListOfCustomPropertyTreeEntities: (
  propertyId: number,
  options?: OperationOptions,
) => Promise<CustomPropertyTreeEntitiesGetListOfCustomPropertyTreeEntitiesResponse>;

Параметры пути

Поле	Тип	Обязательность
`property_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: uid, title, company_id, sort_order, path, parent_entity_uid, entity_type, access, archived, for_everyone_access_role_id, protected.

documentGroups

createNewDocumentGroup

client.documentGroups.createNewDocumentGroup · POST /api/latest/document-groups

Create new document group. Документация Kaiten.

...args: DocumentGroupsCreateNewDocumentGroupParams

declare const createNewDocumentGroup: (
  body: DocumentGroupsCreateNewDocumentGroupBody,
  options?: OperationOptions,
) => Promise<DocumentGroupsCreateNewDocumentGroupResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string	Обязательно
`parent_entity_uid`	string \| null	Необязательно
`for_everyone_access_role_id`	string \| null	Необязательно
`sort_order`	number	Необязательно
`key`	string \| null	Необязательно

Ответ: Объект. Поля: uid, id, title, created, updated, archived, company_id, author_id, parent_entity_uid, parent_group_id, entity_type, sort_order, access, for_everyone_access_role_id, hostname, redirect_url, key, icon_type, icon_value, icon_color, public, news_feed, hidden_on_public_site, path, index_document_uid, access_record.

removeDocumentGroup

client.documentGroups.removeDocumentGroup · DELETE /api/latest/document-groups/{document_group_uid}

Remove document group. Документация Kaiten.

...args: DocumentGroupsRemoveDocumentGroupParams

declare const removeDocumentGroup: (
  documentGroupUid: string,
  options?: OperationOptions,
) => Promise<DocumentGroupsRemoveDocumentGroupResponse>;

Параметры пути

Поле	Тип	Обязательность
`document_group_uid`	string	Обязательно

Параметры запроса

нет.

retrieveDocumentGroup

client.documentGroups.retrieveDocumentGroup · GET /api/latest/document-groups/{document_group_uid}

Retrieve document group. Документация Kaiten.

...args: DocumentGroupsRetrieveDocumentGroupParams

declare const retrieveDocumentGroup: (
  documentGroupUid: string,
  options?: OperationOptions,
) => Promise<DocumentGroupsRetrieveDocumentGroupResponse>;

Параметры пути

Поле	Тип	Обязательность
`document_group_uid`	string	Обязательно

Параметры запроса

нет.

retrieveListOfDocumentGroups

client.documentGroups.retrieveListOfDocumentGroups · GET /api/latest/document-groups

Retrieve list of document groups. Документация Kaiten.

...args: DocumentGroupsRetrieveListOfDocumentGroupsParams

declare const retrieveListOfDocumentGroups: {
  (
    query: DocumentGroupsRetrieveListOfDocumentGroupsQuery & {version: 2},
    options?: OperationOptions,
  ): Promise<
    SearchResponseV2<DocumentGroupsRetrieveListOfDocumentGroupsResponse>
  >;
  (
    query?: Omit<DocumentGroupsRetrieveListOfDocumentGroupsQuery, 'version'> & {
      version?: 1;
    },
    options?: OperationOptions,
  ): Promise<DocumentGroupsRetrieveListOfDocumentGroupsResponse>;
  (
    query: DocumentGroupsRetrieveListOfDocumentGroupsQuery | undefined,
    options?: OperationOptions,
  ): Promise<
    | DocumentGroupsRetrieveListOfDocumentGroupsResponse
    | SearchResponseV2<DocumentGroupsRetrieveListOfDocumentGroupsResponse>
  >;
};

При query.version: 2 возвращается SearchResponseV2<...> с полями result и position; без этого параметра возвращается массив.

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`query`	string	Необязательно
`offset`	integer	Необязательно
`limit`	integer	Необязательно
`version`	integer	Необязательно
`condition`	integer	Необязательно
`start_position`	string	Необязательно
`role`	integer	Необязательно

Ответ: Массив. Поля: uid, id, title, created, updated, archived, company_id, author_id, parent_entity_uid, parent_group_id, entity_type, sort_order, access, for_everyone_access_role_id, hostname, redirect_url, key, icon_type, icon_value, icon_color, public, news_feed, hidden_on_public_site, path, index_document_uid.

updateDocumentGroup

client.documentGroups.updateDocumentGroup · PATCH /api/latest/document-groups/{document_group_uid}

Update document group. Документация Kaiten.

...args: DocumentGroupsUpdateDocumentGroupParams

declare const updateDocumentGroup: (
  documentGroupUid: string,
  body: DocumentGroupsUpdateDocumentGroupBody,
  options?: OperationOptions,
) => Promise<DocumentGroupsUpdateDocumentGroupResponse>;

Параметры пути

Поле	Тип	Обязательность
`document_group_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string	Необязательно
`parent_entity_uid`	string \| null	Необязательно
`sort_order`	number	Необязательно
`access`	for_everyone \| by_invite	Необязательно
`for_everyone_access_role_id`	string \| null	Необязательно
`hostname`	string \| null	Необязательно
`redirect_url`	string \| null	Необязательно
`key`	string \| null	Необязательно
`icon_type`	material_icon \| null	Необязательно
`icon_value`	string \| null	Необязательно
`icon_color`	integer \| null	Необязательно
`hidden_on_public_site`	boolean	Необязательно
`news_feed`	boolean	Необязательно
`index_document_uid`	string \| null	Необязательно

documentSchemas

getDocumentDataSchema

client.documentSchemas.getDocumentDataSchema · GET /api/latest/document-schemas/{id}

Get document data schema. Документация Kaiten.

...args: DocumentSchemasGetDocumentDataSchemaParams

declare const getDocumentDataSchema: {
  (
    schemaVersion: string,
    format: 'prosemirror',
    options?: OperationOptions,
  ): Promise<DocumentProseMirrorSchema>;
  (
    schemaVersion: string,
    format?: 'draft-06',
    options?: OperationOptions,
  ): Promise<DocumentJsonSchema>;
  (
    schemaVersion: string,
    format: 'draft-06' | 'prosemirror' | undefined,
    options?: OperationOptions,
  ): Promise<DocumentSchemasGetDocumentDataSchemaResponse>;
};

Параметры пути

Поле	Тип	Обязательность
`id`	string	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`format`	draft-06 \| prosemirror	Необязательно

Ответ: Объект. Поля: $schema, $id, title, description, allOf, version, definitions.

documents

createNewDocument

client.documents.createNewDocument · POST /api/latest/documents

Create new document. Документация Kaiten.

...args: DocumentsCreateNewDocumentParams

declare const createNewDocument: (
  body: DocumentsCreateNewDocumentBody,
  options?: OperationOptions,
) => Promise<DocumentsCreateNewDocumentResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string	Необязательно
`sort_order`	number	Обязательно
`parent_entity_uid`	string \| null	Необязательно
`for_everyone_access_role_id`	string	Необязательно
`clone_uid`	string	Необязательно
`clone_version`	number	Необязательно
`key`	string \| null	Необязательно

Ответ: Объект. Поля: uid, id, title, created, updated, archived, company_id, author_id, parent_entity_uid, entity_type, sort_order, access, for_everyone_access_role_id, data, version, published_version, publish_date, public, hidden_on_public_site, settings, key, redirect_url, icon_type, icon_value, icon_color, path, schema_version, notification_period_start, notification_period_end, group_id, access_record.

removeDocument

client.documents.removeDocument · DELETE /api/latest/documents/{document_uid}

Remove document. Документация Kaiten.

...args: DocumentsRemoveDocumentParams

declare const removeDocument: (
  documentUid: string,
  options?: OperationOptions,
) => Promise<DocumentsRemoveDocumentResponse>;

Параметры пути

Поле	Тип	Обязательность
`document_uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: uid, id, title, created, updated, archived, company_id, author_id, parent_entity_uid, entity_type, sort_order, access, for_everyone_access_role_id, version, published_version, publish_date, public, hidden_on_public_site, settings, key, redirect_url, icon_type, icon_value, icon_color, path, schema_version, notification_period_start, notification_period_end, group_id.

retrieveDocument

client.documents.retrieveDocument · GET /api/latest/documents/{document_uid}

Retrieve document. Документация Kaiten.

...args: DocumentsRetrieveDocumentParams

declare const retrieveDocument: (
  documentUid: string,
  options?: OperationOptions,
) => Promise<DocumentsRetrieveDocumentResponse>;

Параметры пути

Поле	Тип	Обязательность
`document_uid`	string	Обязательно

Параметры запроса

нет.

retrieveListOfDocuments

client.documents.retrieveListOfDocuments · GET /api/latest/documents

Retrieve list of documents. Документация Kaiten.

...args: DocumentsRetrieveListOfDocumentsParams

declare const retrieveListOfDocuments: {
  (
    query: DocumentsRetrieveListOfDocumentsQuery & {version: 2},
    options?: OperationOptions,
  ): Promise<SearchResponseV2<DocumentsRetrieveListOfDocumentsResponse>>;
  (
    query?: Omit<DocumentsRetrieveListOfDocumentsQuery, 'version'> & {
      version?: 1;
    },
    options?: OperationOptions,
  ): Promise<DocumentsRetrieveListOfDocumentsResponse>;
  (
    query: DocumentsRetrieveListOfDocumentsQuery | undefined,
    options?: OperationOptions,
  ): Promise<
    | DocumentsRetrieveListOfDocumentsResponse
    | SearchResponseV2<DocumentsRetrieveListOfDocumentsResponse>
  >;
};

При query.version: 2 возвращается SearchResponseV2<...> с полями result и position; без этого параметра возвращается массив.

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`query`	string	Необязательно
`offset`	integer	Необязательно
`limit`	integer	Необязательно
`version`	integer	Необязательно
`condition`	integer	Необязательно
`fields`	string	Необязательно
`start_position`	string	Необязательно
`include_search_preview`	boolean	Необязательно

Ответ: Массив. Поля: uid, id, title, created, updated, archived, company_id, author_id, parent_entity_uid, entity_type, sort_order, access, for_everyone_access_role_id, version, published_version, publish_date, public, hidden_on_public_site, settings, key, redirect_url, icon_type, icon_value, icon_color, path, schema_version, notification_period_start, notification_period_end, group_id.

updateDocument

client.documents.updateDocument · PATCH /api/latest/documents/{document_uid}

Update document. Документация Kaiten.

...args: DocumentsUpdateDocumentParams

declare const updateDocument: (
  documentUid: string,
  body: DocumentsUpdateDocumentBody,
  options?: OperationOptions,
) => Promise<DocumentsUpdateDocumentResponse>;

Параметры пути

Поле	Тип	Обязательность
`document_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string	Необязательно
`sort_order`	number	Необязательно
`publish_date`	string \| null	Необязательно
`data`	object	Необязательно
`access`	for_everyone \| by_invite	Необязательно
`parent_entity_uid`	string \| null	Необязательно
`for_everyone_access_role_id`	string	Необязательно
`public`	boolean	Необязательно
`redirect_url`	string \| null	Необязательно
`hidden_on_public_site`	boolean	Необязательно
`settings`	object	Необязательно
`backup_version`	number	Необязательно
`published_version`	number \| null \| current	Необязательно
`key`	string \| null	Необязательно
`icon_type`	emoji \| material_icon \| null	Необязательно
`icon_value`	string \| null	Необязательно
`icon_color`	integer \| null	Необязательно
`notification_period_start`	string \| null	Необязательно
`notification_period_end`	string \| null	Необязательно
`slug`	string \| null	Необязательно

groupAdmins

addAdminToGroup

client.groupAdmins.addAdminToGroup · POST /api/latest/groups/{group_uid}/admins

Add admin to group. Документация Kaiten. Beta.

...args: GroupAdminsAddAdminToGroupParams

declare const addAdminToGroup: (
  groupUid: string,
  userId: number,
  options?: OperationOptions,
) => Promise<GroupAdminsAddAdminToGroupResponse>;

Параметры пути

Поле	Тип	Обязательность
`group_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`user_id`	integer	Обязательно

getListOfGroupAdmins

client.groupAdmins.getListOfGroupAdmins · GET /api/latest/groups/{group_uid}/admins

Get list of group admins. Документация Kaiten. Beta.

...args: GroupAdminsGetListOfGroupAdminsParams

declare const getListOfGroupAdmins: (
  groupUid: string,
  options?: OperationOptions,
) => Promise<GroupAdminsGetListOfGroupAdminsResponse>;

Параметры пути

Поле	Тип	Обязательность
`group_uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: created, updated, id, uid, full_name, username, email, activated, avatar_initials_url, avatar_uploaded_url, initials, avatar_type, lng, sd_telegram_id, timezone, news_subscription, theme, ui_version, virtual, email_blocked, email_blocked_reason, delete_requested_at, delete_confirmation_sent_at.

removeAdminFromGroup

client.groupAdmins.removeAdminFromGroup · DELETE /api/latest/groups/{group_uid}/admins/{user_id}

Remove admin from group. Документация Kaiten. Beta.

...args: GroupAdminsRemoveAdminFromGroupParams

declare const removeAdminFromGroup: (
  groupUid: string,
  userId: number,
  options?: OperationOptions,
) => Promise<GroupAdminsRemoveAdminFromGroupResponse>;

Параметры пути

Поле	Тип	Обязательность
`group_uid`	string	Обязательно
`user_id`	integer	Обязательно

Параметры запроса

нет.

groupEntities

addEntity

client.groupEntities.addEntity · POST /api/latest/company/groups/{group_uid}/entities

Add entity. Документация Kaiten. Beta.

...args: GroupEntitiesAddEntityParams

declare const addEntity: (
  groupUid: string,
  entityUid: string,
  roleIds: string[],
  options?: OperationOptions,
) => Promise<GroupEntitiesAddEntityResponse>;

Параметры пути

Поле	Тип	Обязательность
`group_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`entity_uid`	string	Обязательно
`role_ids`	array of string	Обязательно

Ответ: Объект. Поля: group_id, entity_uid, role_permissions, access_mod, own_role_ids, own_access_mod, role_ids.

getListOfGroupEntities

client.groupEntities.getListOfGroupEntities · GET /api/latest/company/groups/{group_uid}/entities

Get list of group entities. Документация Kaiten. Beta.

...args: GroupEntitiesGetListOfGroupEntitiesParams

declare const getListOfGroupEntities: (
  groupUid: string,
  options?: OperationOptions,
) => Promise<GroupEntitiesGetListOfGroupEntitiesResponse>;

Параметры пути

Поле	Тип	Обязательность
`group_uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: uid, path, title, entity_type, own_role_ids.

removeEntity

client.groupEntities.removeEntity · DELETE /api/latest/company/groups/{group_uid}/entities/{uid}

Remove entity. Документация Kaiten. Beta.

...args: GroupEntitiesRemoveEntityParams

declare const removeEntity: (
  groupUid: string,
  uid: string,
  options?: OperationOptions,
) => Promise<GroupEntitiesRemoveEntityResponse>;

Параметры пути

Поле	Тип	Обязательность
`group_uid`	string	Обязательно
`uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: group_id, entity_uid, role_permissions, access_mod, role, own_role_ids, own_access_mod, role_ids, own_role.

updateGroupEntity

client.groupEntities.updateGroupEntity · PATCH /api/latest/company/groups/{group_uid}/entities/{uid}

Update group entity. Документация Kaiten. Beta.

...args: GroupEntitiesUpdateGroupEntityParams

declare const updateGroupEntity: (
  groupUid: string,
  uid: string,
  roleIds: string[],
  options?: OperationOptions,
) => Promise<GroupEntitiesUpdateGroupEntityResponse>;

Параметры пути

Поле	Тип	Обязательность
`group_uid`	string	Обязательно
`uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`role_ids`	array of string	Необязательно

Ответ: Объект. Поля: group_id, entity_uid, role_permissions, access_mod, own_role_ids, own_access_mod, role_ids.

groupUsers

addUserToGroup

client.groupUsers.addUserToGroup · POST /api/latest/groups/{group_uid}/users

Add user to group. Документация Kaiten. Beta.

...args: GroupUsersAddUserToGroupParams

declare const addUserToGroup: (
  groupUid: string,
  userId: number,
  requestId?: string,
  operatorComment?: string | null,
  options?: OperationOptions,
) => Promise<GroupUsersAddUserToGroupResponse>;

Параметры пути

Поле	Тип	Обязательность
`group_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`user_id`	integer	Обязательно
`request_id`	string	Необязательно
`operator_comment`	string \| null	Необязательно

getListOfGroupUsers

client.groupUsers.getListOfGroupUsers · GET /api/latest/groups/{group_uid}/users

Get list of group users. Документация Kaiten. Beta.

...args: GroupUsersGetListOfGroupUsersParams

declare const getListOfGroupUsers: (
  groupUid: string,
  options?: OperationOptions,
) => Promise<GroupUsersGetListOfGroupUsersResponse>;

Параметры пути

Поле	Тип	Обязательность
`group_uid`	string	Обязательно

Параметры запроса

нет.

removeUserFromGroup

client.groupUsers.removeUserFromGroup · DELETE /api/latest/groups/{group_uid}/users/{user_id}

Remove user from group. Документация Kaiten. Beta.

...args: GroupUsersRemoveUserFromGroupParams

declare const removeUserFromGroup: (
  groupUid: string,
  userId: number,
  options?: OperationOptions,
) => Promise<GroupUsersRemoveUserFromGroupResponse>;

Параметры пути

Поле	Тип	Обязательность
`group_uid`	string	Обязательно
`user_id`	integer	Обязательно

Параметры запроса

нет.

groups

createGroup

client.groups.createGroup · POST /api/latest/company/groups

Create group. Документация Kaiten. Beta.

...args: GroupsCreateGroupParams

declare const createGroup: (
  name: string,
  permissions?: number,
  addToCardsAndSpacesEnabled?: boolean,
  options?: OperationOptions,
) => Promise<GroupsCreateGroupResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Обязательно
`permissions`	integer	Необязательно
`add_to_cards_and_spaces_enabled`	boolean	Необязательно

Ответ: Объект. Поля: name, permissions, add_to_cards_and_spaces_enabled, updated, created, id, uid.

getGroup

client.groups.getGroup · GET /api/latest/company/groups/{uid}

Get group. Документация Kaiten. Beta.

...args: GroupsGetGroupParams

declare const getGroup: (
  uid: string,
  options?: OperationOptions,
) => Promise<GroupsGetGroupResponse>;

Параметры пути

Поле	Тип	Обязательность
`uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: name, permissions, add_to_cards_and_spaces_enabled, updated, created, id, uid.

getListOfGroups

client.groups.getListOfGroups · GET /api/latest/company/groups

Get list of groups. Документация Kaiten. Beta.

...args: GroupsGetListOfGroupsParams

declare const getListOfGroups: (
  query?: GroupsGetListOfGroupsQuery,
  options?: OperationOptions,
) => Promise<GroupsGetListOfGroupsResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`with_tree_entities`	boolean	Необязательно
`with_users_count`	boolean	Необязательно
`with_sync_group_attribute`	boolean	Необязательно
`condition`	enum	Необязательно
`query`	string	Необязательно
`limit`	integer	Необязательно
`offset`	integer	Необязательно

Ответ: Массив. Поля: name, permissions, add_to_cards_and_spaces_enabled, updated, created, id, uid.

removeGroup

client.groups.removeGroup · DELETE /api/latest/company/groups/{uid}

Remove Group. Документация Kaiten. Beta.

...args: GroupsRemoveGroupParams

declare const removeGroup: (
  uid: string,
  options?: OperationOptions,
) => Promise<GroupsRemoveGroupResponse>;

Параметры пути

Поле	Тип	Обязательность
`uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: name, permissions, add_to_cards_and_spaces_enabled, updated, created, id, uid.

updateGroup

client.groups.updateGroup · PATCH /api/latest/company/groups/{uid}

Update group. Документация Kaiten. Beta.

...args: GroupsUpdateGroupParams

declare const updateGroup: (
  uid: string,
  name?: string,
  permissions?: number,
  addToCardsAndSpacesEnabled?: boolean,
  options?: OperationOptions,
) => Promise<GroupsUpdateGroupResponse>;

Параметры пути

Поле	Тип	Обязательность
`uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`permissions`	integer	Необязательно
`add_to_cards_and_spaces_enabled`	boolean	Необязательно

Ответ: Объект. Поля: name, permissions, add_to_cards_and_spaces_enabled, updated, created, id, uid.

iterations

addCardToIteration

client.iterations.addCardToIteration · POST /api/latest/spaces/{space_uid}/iterations/{iteration_id}/cards

Add card to iteration. Документация Kaiten. Beta.

...args: IterationsAddCardToIterationParams

declare const addCardToIteration: (
  spaceUid: string,
  iterationId: string,
  cardUid: string,
  options?: OperationOptions,
) => Promise<IterationsAddCardToIterationResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`iteration_id`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`card_uid`	string	Обязательно

Ответ: Объект. Поля: iteration_id, card_uid, added_by_uid, removed_at, removed_by_uid, sort_order, created, updated.

createIteration

client.iterations.createIteration · POST /api/latest/spaces/{space_uid}/iterations

Create iteration. Документация Kaiten. Beta.

...args: IterationsCreateIterationParams

declare const createIteration: (
  spaceUid: string,
  body: IterationsCreateIterationBody,
  options?: OperationOptions,
) => Promise<IterationsCreateIterationResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string	Обязательно
`goal`	string \| null	Необязательно
`start_date`	string \| null	Необязательно
`finish_date`	string \| null	Необязательно

Ответ: Объект. Поля: id, space_uid, title, goal, status, creator_uid, updater_uid, start_date, finish_date, actual_finish_date, sort_order, data, created, updated.

deleteIteration

client.iterations.deleteIteration · DELETE /api/latest/spaces/{space_uid}/iterations/{id}

Delete iteration. Документация Kaiten. Beta.

...args: IterationsDeleteIterationParams

declare const deleteIteration: (
  spaceUid: string,
  id: string,
  newIterationId?: string | null,
  options?: OperationOptions,
) => Promise<IterationsDeleteIterationResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`id`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`new_iteration_id`	string \| null	Необязательно

getCardIterationsHistory

client.iterations.getCardIterationsHistory · GET /api/latest/cards/{card_uid}/iterations-history

Get card iterations history. Документация Kaiten. Beta.

...args: IterationsGetCardIterationsHistoryParams

declare const getCardIterationsHistory: (
  cardUid: string,
  withDetails?: boolean,
  options?: OperationOptions,
) => Promise<IterationsGetCardIterationsHistoryResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`with_details`	boolean	Необязательно

Ответ: Массив. Поля: iteration_id, card_uid, added_by_uid, removed_at, removed_by_uid, sort_order, created, updated.

getIteration

client.iterations.getIteration · GET /api/latest/spaces/{space_uid}/iterations/{id}

Get iteration. Документация Kaiten. Beta.

...args: IterationsGetIterationParams

declare const getIteration: (
  spaceUid: string,
  id: string,
  options?: OperationOptions,
) => Promise<IterationsGetIterationResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`id`	string	Обязательно

Параметры запроса

нет.

removeCardFromIteration

client.iterations.removeCardFromIteration · DELETE /api/latest/spaces/{space_uid}/iterations/{iteration_id}/cards/{uid}

Remove card from iteration. Документация Kaiten. Beta.

...args: IterationsRemoveCardFromIterationParams

declare const removeCardFromIteration: (
  spaceUid: string,
  iterationId: string,
  uid: string,
  options?: OperationOptions,
) => Promise<IterationsRemoveCardFromIterationResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`iteration_id`	string	Обязательно
`uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: iteration_id, card_uid, added_by_uid, removed_at, removed_by_uid, sort_order, created, updated.

retrieveCardsInIteration

client.iterations.retrieveCardsInIteration · GET /api/latest/spaces/{space_uid}/iterations/{iteration_id}/cards

Retrieve cards in iteration. Документация Kaiten. Beta.

...args: IterationsRetrieveCardsInIterationParams

declare const retrieveCardsInIteration: (
  spaceUid: string,
  iterationId: string,
  status?: string,
  options?: OperationOptions,
) => Promise<IterationsRetrieveCardsInIterationResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`iteration_id`	string	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`status`	string	Необязательно

Ответ: Массив. Поля: iteration_id, card_uid, card_id, added_by_uid, removed_at, removed_by_uid, sort_order, created, updated.

retrieveListOfIterations

client.iterations.retrieveListOfIterations · GET /api/latest/spaces/{space_uid}/iterations

Retrieve list of iterations. Документация Kaiten. Beta.

...args: IterationsRetrieveListOfIterationsParams

declare const retrieveListOfIterations: (
  spaceUid: string,
  query?: IterationsRetrieveListOfIterationsQuery,
  options?: OperationOptions,
) => Promise<IterationsRetrieveListOfIterationsResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`status`	string	Необязательно
`with_data`	string	Необязательно
`limit`	number	Необязательно
`offset`	number	Необязательно
`order`	string	Необязательно

Ответ: Массив. Поля: id, space_uid, title, goal, status, creator_uid, updater_uid, start_date, finish_date, actual_finish_date, sort_order, data, created, updated.

updateIteration

client.iterations.updateIteration · PATCH /api/latest/spaces/{space_uid}/iterations/{id}

Update iteration. Документация Kaiten. Beta.

...args: IterationsUpdateIterationParams

declare const updateIteration: (
  spaceUid: string,
  id: string,
  body: IterationsUpdateIterationBody,
  options?: OperationOptions,
) => Promise<IterationsUpdateIterationResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`id`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string	Необязательно
`goal`	string \| null	Необязательно
`status`	planned \| active \| closed	Необязательно
`start_date`	string \| null	Необязательно
`finish_date`	string \| null	Необязательно
`actual_finish_date`	string \| null	Необязательно
`new_iteration_id`	string \| null	Необязательно

lanes

createNewLane

client.lanes.createNewLane · POST /api/latest/boards/{board_id}/lanes

Create new lane. Документация Kaiten.

...args: LanesCreateNewLaneParams

declare const createNewLane: (
  boardId: number,
  body: LanesCreateNewLaneBody,
  options?: OperationOptions,
) => Promise<LanesCreateNewLaneResponse>;

Параметры пути

Поле	Тип	Обязательность
`board_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string	Обязательно
`sort_order`	number	Необязательно
`wip_limit`	integer	Необязательно
`wip_limit_type`	1 \| 2	Необязательно
`last_moved_warning_after_days`	integer	Необязательно
`last_moved_warning_after_hours`	integer	Необязательно
`last_moved_warning_after_minutes`	integer	Необязательно
`row_count`	integer	Необязательно

Ответ: Объект. Поля: created, updated, id, title, sort_order, row_count, wip_limit, wip_limit_type, last_moved_warning_after_minutes, last_moved_warning_after_days, last_moved_warning_after_hours, board_id, default_card_type_id, default_tags, external_id, condition.

getListOfLanes

client.lanes.getListOfLanes · GET /api/latest/boards/{board_id}/lanes

Get list of lanes. Документация Kaiten.

...args: LanesGetListOfLanesParams

declare const getListOfLanes: (
  boardId: number,
  condition?: string,
  options?: OperationOptions,
) => Promise<LanesGetListOfLanesResponse>;

Параметры пути

Поле	Тип	Обязательность
`board_id`	integer	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`condition`	enum	Необязательно

Ответ: Массив. Поля: created, updated, id, title, sort_order, row_count, board_id, wip_limit, wip_limit_type, default_tags, last_moved_warning_after_days, external_id, default_card_type_id, last_moved_warning_after_hours, condition, last_moved_warning_after_minutes.

removeLane

client.lanes.removeLane · DELETE /api/latest/boards/{board_id}/lanes/{id}

Remove lane. Документация Kaiten.

...args: LanesRemoveLaneParams

declare const removeLane: (
  boardId: number,
  laneId: number,
  force?: boolean,
  options?: OperationOptions,
) => Promise<LanesRemoveLaneResponse>;

Параметры пути

Поле	Тип	Обязательность
`board_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`force`	boolean	Необязательно

Ответ: Объект. Поля: id.

updateLane

client.lanes.updateLane · PATCH /api/latest/boards/{board_id}/lanes/{id}

Update lane. Документация Kaiten.

...args: LanesUpdateLaneParams

declare const updateLane: (
  boardId: number,
  laneId: number,
  body: LanesUpdateLaneBody,
  options?: OperationOptions,
) => Promise<LanesUpdateLaneResponse>;

Параметры пути

Поле	Тип	Обязательность
`board_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string	Необязательно
`sort_order`	number	Необязательно
`wip_limit`	integer \| null	Необязательно
`wip_limit_type`	1 \| 2	Необязательно
`last_moved_warning_after_days`	integer	Необязательно
`last_moved_warning_after_hours`	integer	Необязательно
`last_moved_warning_after_minutes`	integer	Необязательно
`row_count`	integer	Необязательно
`default_tags`	string \| null	Необязательно
`default_card_type_id`	integer \| null	Необязательно
`condition`	1 \| 2	Необязательно

restrictedAccessCardFiles

attachFileToCard

client.restrictedAccessCardFiles.attachFileToCard · POST /api/latest/cards/{card_uid}/files

Attach file to card. Документация Kaiten.

...args: RestrictedAccessCardFilesAttachFileToCardParams

declare const attachFileToCard: (
  cardUid: string,
  file: Blob,
  options?: FileUploadOptions,
) => Promise<RestrictedAccessCardFilesAttachFileToCardResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`file`	Blob	Обязательно

Ответ: Объект. Поля: id, name, size, mime_type, author_uid, card_uid, company_uid, entity_type, created, updated, card_cover.

deleteCardFile

client.restrictedAccessCardFiles.deleteCardFile · DELETE /api/latest/cards/{card_uid}/files/{id}

Delete card file. Документация Kaiten.

...args: RestrictedAccessCardFilesDeleteCardFileParams

declare const deleteCardFile: (
  cardUid: string,
  fileUid: string,
  options?: OperationOptions,
) => Promise<RestrictedAccessCardFilesDeleteCardFileResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`id`	string (uuid)	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

getCardFile

client.restrictedAccessCardFiles.getCardFile · GET /api/latest/cards/{card_uid}/files/{id}

Get card file. Документация Kaiten.

...args: RestrictedAccessCardFilesGetCardFileParams

declare const getCardFile: {
  (
    cardUid: string,
    fileUid: string,
    redirect: true,
    download?: boolean,
    options?: OperationOptions,
  ): Promise<FileRedirectResponse>;
  (
    cardUid: string,
    fileUid: string,
    redirect?: false,
    download?: boolean,
    options?: OperationOptions,
  ): Promise<RestrictedAccessCardFilesGetCardFileResponse>;
  (
    cardUid: string,
    fileUid: string,
    redirect: boolean | undefined,
    download?: boolean,
    options?: OperationOptions,
  ): Promise<
    RestrictedAccessCardFilesGetCardFileResponse | FileRedirectResponse
  >;
};

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`id`	string (uuid)	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`redirect`	boolean	Необязательно
`download`	boolean	Необязательно

Ответ: Объект. Поля: id, name, size, mime_type, entity_type, created, updated, card_uid, author_uid, card_cover, url.

updateCardFile

client.restrictedAccessCardFiles.updateCardFile · PATCH /api/latest/cards/{card_uid}/files/{id}

Update card file. Документация Kaiten.

...args: RestrictedAccessCardFilesUpdateCardFileParams

declare const updateCardFile: (
  cardUid: string,
  fileUid: string,
  name?: string,
  cardCover?: boolean,
  options?: OperationOptions,
) => Promise<RestrictedAccessCardFilesUpdateCardFileResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`id`	string (uuid)	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`card_cover`	boolean	Необязательно

Ответ: Объект. Поля: id, name, size, mime_type, author_uid, card_uid, company_uid, entity_type, created, updated, card_cover.

restrictedAccessCommentFiles

attachFileToComment

client.restrictedAccessCommentFiles.attachFileToComment · POST /api/latest/cards/{card_uid}/comments/{comment_uid}/files

Attach file to comment. Документация Kaiten.

...args: RestrictedAccessCommentFilesAttachFileToCommentParams

declare const attachFileToComment: (
  cardUid: string,
  commentUid: string,
  file: Blob,
  options?: FileUploadOptions,
) => Promise<RestrictedAccessCommentFilesAttachFileToCommentResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`comment_uid`	string (uuid \| new)	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`file`	Blob	Обязательно

Ответ: Объект. Поля: id, name, size, mime_type, author_uid, card_uid, comment_uid, company_uid, entity_type, created, updated, card_cover.

deleteCommentFile

client.restrictedAccessCommentFiles.deleteCommentFile · DELETE /api/latest/cards/{card_uid}/comments/{comment_uid}/files/{id}

Delete comment file. Документация Kaiten.

...args: RestrictedAccessCommentFilesDeleteCommentFileParams

declare const deleteCommentFile: (
  cardUid: string,
  commentUid: string,
  fileUid: string,
  options?: OperationOptions,
) => Promise<RestrictedAccessCommentFilesDeleteCommentFileResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`comment_uid`	string (uuid \| new)	Обязательно
`id`	string (uuid)	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

getCommentFile

client.restrictedAccessCommentFiles.getCommentFile · GET /api/latest/cards/{card_uid}/comments/{comment_uid}/files/{id}

Get comment file. Документация Kaiten.

...args: RestrictedAccessCommentFilesGetCommentFileParams

declare const getCommentFile: {
  (
    cardUid: string,
    commentUid: string,
    fileUid: string,
    query: RestrictedAccessCommentFilesGetCommentFileQuery & {redirect: true},
    options?: OperationOptions,
  ): Promise<FileRedirectResponse>;
  (
    cardUid: string,
    commentUid: string,
    fileUid: string,
    query?: Omit<
      RestrictedAccessCommentFilesGetCommentFileQuery,
      'redirect'
    > & {redirect?: false},
    options?: OperationOptions,
  ): Promise<RestrictedAccessCommentFilesGetCommentFileResponse>;
  (
    cardUid: string,
    commentUid: string,
    fileUid: string,
    query: RestrictedAccessCommentFilesGetCommentFileQuery | undefined,
    options?: OperationOptions,
  ): Promise<
    RestrictedAccessCommentFilesGetCommentFileResponse | FileRedirectResponse
  >;
};

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`comment_uid`	string (uuid \| new)	Обязательно
`id`	string (uuid)	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`redirect`	boolean	Необязательно
`download`	boolean	Необязательно

Ответ: Объект. Поля: id, name, size, mime_type, entity_type, created, updated, card_uid, comment_uid, author_uid, card_cover, url.

updateCommentFile

client.restrictedAccessCommentFiles.updateCommentFile · PATCH /api/latest/cards/{card_uid}/comments/{comment_uid}/files/{id}

Update comment file. Документация Kaiten.

...args: RestrictedAccessCommentFilesUpdateCommentFileParams

declare const updateCommentFile: (
  cardUid: string,
  commentUid: string,
  fileUid: string,
  body: RestrictedAccessCommentFilesUpdateCommentFileBody,
  options?: OperationOptions,
) => Promise<RestrictedAccessCommentFilesUpdateCommentFileResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`comment_uid`	string (uuid \| new)	Обязательно
`id`	string (uuid)	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`card_cover`	boolean	Необязательно

Ответ: Объект. Поля: id, name, size, mime_type, author_uid, card_uid, comment_uid, company_uid, entity_type, created, updated, card_cover.

restrictedAccessCustomPropertyFiles

attachFileToCustomProperty

client.restrictedAccessCustomPropertyFiles.attachFileToCustomProperty · POST /api/latest/cards/{card_uid}/custom-properties/{property_uid}/files

Attach file to custom property. Документация Kaiten.

...args: RestrictedAccessCustomPropertyFilesAttachFileToCustomPropertyParams

declare const attachFileToCustomProperty: (
  cardUid: string,
  propertyUid: string,
  file: Blob,
  options?: FileUploadOptions,
) => Promise<RestrictedAccessCustomPropertyFilesAttachFileToCustomPropertyResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`property_uid`	string (uuid)	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`file`	Blob	Обязательно

Ответ: Объект. Поля: id, name, size, mime_type, author_uid, card_uid, custom_property_uid, company_uid, entity_type, created, updated, card_cover.

deleteCustomPropertyFile

client.restrictedAccessCustomPropertyFiles.deleteCustomPropertyFile · DELETE /api/latest/cards/{card_uid}/custom-properties/{property_uid}/files/{id}

Delete custom property file. Документация Kaiten.

...args: RestrictedAccessCustomPropertyFilesDeleteCustomPropertyFileParams

declare const deleteCustomPropertyFile: (
  cardUid: string,
  propertyUid: string,
  fileUid: string,
  options?: OperationOptions,
) => Promise<RestrictedAccessCustomPropertyFilesDeleteCustomPropertyFileResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`property_uid`	string (uuid)	Обязательно
`id`	string (uuid)	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

getCustomPropertyFile

client.restrictedAccessCustomPropertyFiles.getCustomPropertyFile · GET /api/latest/cards/{card_uid}/custom-properties/{property_uid}/files/{id}

Get custom property file. Документация Kaiten.

...args: RestrictedAccessCustomPropertyFilesGetCustomPropertyFileParams

declare const getCustomPropertyFile: {
  (
    cardUid: string,
    propertyUid: string,
    fileUid: string,
    query: RestrictedAccessCustomPropertyFilesGetCustomPropertyFileQuery & {
      redirect: true;
    },
    options?: OperationOptions,
  ): Promise<FileRedirectResponse>;
  (
    cardUid: string,
    propertyUid: string,
    fileUid: string,
    query?: Omit<
      RestrictedAccessCustomPropertyFilesGetCustomPropertyFileQuery,
      'redirect'
    > & {redirect?: false},
    options?: OperationOptions,
  ): Promise<RestrictedAccessCustomPropertyFilesGetCustomPropertyFileResponse>;
  (
    cardUid: string,
    propertyUid: string,
    fileUid: string,
    query:
      RestrictedAccessCustomPropertyFilesGetCustomPropertyFileQuery | undefined,
    options?: OperationOptions,
  ): Promise<
    | RestrictedAccessCustomPropertyFilesGetCustomPropertyFileResponse
    | FileRedirectResponse
  >;
};

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`property_uid`	string (uuid)	Обязательно
`id`	string (uuid)	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`redirect`	boolean	Необязательно
`download`	boolean	Необязательно

Ответ: Объект. Поля: id, name, size, mime_type, entity_type, created, updated, card_uid, custom_property_uid, author_uid, card_cover, url.

updateCustomPropertyFile

client.restrictedAccessCustomPropertyFiles.updateCustomPropertyFile · PATCH /api/latest/cards/{card_uid}/custom-properties/{property_uid}/files/{id}

Update custom property file. Документация Kaiten.

...args: RestrictedAccessCustomPropertyFilesUpdateCustomPropertyFileParams

declare const updateCustomPropertyFile: (
  cardUid: string,
  propertyUid: string,
  fileUid: string,
  body: RestrictedAccessCustomPropertyFilesUpdateCustomPropertyFileBody,
  options?: OperationOptions,
) => Promise<RestrictedAccessCustomPropertyFilesUpdateCustomPropertyFileResponse>;

Параметры пути

Поле	Тип	Обязательность
`card_uid`	string (uuid)	Обязательно
`property_uid`	string (uuid)	Обязательно
`id`	string (uuid)	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`card_cover`	boolean	Необязательно

Ответ: Объект. Поля: id, name, size, mime_type, author_uid, card_uid, custom_property_uid, company_uid, entity_type, created, updated, card_cover.

serviceDeskServices

retrieveServicesList

client.serviceDeskServices.retrieveServicesList · GET /api/latest/service-desk/services

Retrieve services list. Документация Kaiten.

...args: ServiceDeskServicesRetrieveServicesListParams

declare const retrieveServicesList: (
  options?: OperationOptions,
) => Promise<ServiceDeskServicesRetrieveServicesListResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Ответ: Массив. Поля: id, name, fields_settings, archived, lng, email_settings, type_id, email_key, board_id, column_id, lane_id, display_status, template_description, settings, allow_to_add_external_recipients, column, board, lane, voteCustomProperty.

spaceBoards

createNewBoard

client.spaceBoards.createNewBoard · POST /api/latest/spaces/{space_id}/boards

Create new board. Документация Kaiten.

...args: SpaceBoardsCreateNewBoardParams

declare const createNewBoard: (
  spaceId: number,
  body: SpaceBoardsCreateNewBoardBody,
  options?: OperationOptions,
) => Promise<SpaceBoardsCreateNewBoardResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string \| number	Обязательно
`columns`	array of object	Необязательно
`lanes`	array of object	Необязательно
`description`	string \| null	Необязательно
`top`	integer	Необязательно
`left`	integer	Необязательно
`default_card_type_id`	integer	Необязательно
`first_image_is_cover`	boolean	Необязательно
`reset_lane_spent_time`	boolean	Необязательно
`automove_cards`	boolean	Необязательно
`backward_moves_enabled`	boolean	Необязательно
`auto_assign_enabled`	boolean	Необязательно
`sort_order`	number	Необязательно
`external_id`	number \| string \| null	Необязательно

getBoard

client.spaceBoards.getBoard · GET /api/latest/spaces/{space_id}/boards/{id}

Get board. Документация Kaiten.

...args: SpaceBoardsGetBoardParams

declare const getBoard: (
  spaceId: number,
  id: number,
  options?: OperationOptions,
) => Promise<SpaceBoardsGetBoardResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, id, title, cell_wip_limits, default_card_type_id, description, external_id, email_key, move_parents_to_done, backward_moves_enabled, default_tags, first_image_is_cover, reset_lane_spent_time, automove_cards, hide_done_policies, hide_done_policies_in_done_column, auto_assign_enabled, card_properties, columns, lanes, cards, space_id, board_id, top, left, sort_order.

getListOfBoards

client.spaceBoards.getListOfBoards · GET /api/latest/spaces/{space_id}/boards

Get list of boards. Документация Kaiten.

...args: SpaceBoardsGetListOfBoardsParams

declare const getListOfBoards: (
  spaceId: number,
  options?: OperationOptions,
) => Promise<SpaceBoardsGetListOfBoardsResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: created, updated, id, title, cell_wip_limits, external_id, default_card_type_id, description, email_key, move_parents_to_done, default_tags, first_image_is_cover, reset_lane_spent_time, backward_moves_enabled, hide_done_policies, hide_done_policies_in_done_column, automove_cards, auto_assign_enabled, card_properties, columns, lanes, space_id, board_id, top, left, sort_order, type.

removeBoard

client.spaceBoards.removeBoard · DELETE /api/latest/spaces/{space_id}/boards/{id}

Remove board. Документация Kaiten.

...args: SpaceBoardsRemoveBoardParams

declare const removeBoard: (
  spaceId: number,
  id: number,
  force?: boolean,
  options?: OperationOptions,
) => Promise<SpaceBoardsRemoveBoardResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`force`	boolean	Необязательно

Ответ: Объект. Поля: id.

updateBoard

client.spaceBoards.updateBoard · PATCH /api/latest/spaces/{space_id}/boards/{id}

Update board. Документация Kaiten.

...args: SpaceBoardsUpdateBoardParams

declare const updateBoard: (
  spaceId: number,
  id: number,
  body: SpaceBoardsUpdateBoardBody,
  options?: OperationOptions,
) => Promise<SpaceBoardsUpdateBoardResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string \| number	Необязательно
`description`	string \| null	Необязательно
`top`	integer	Необязательно
`left`	integer	Необязательно
`type`	1 \| 5	Необязательно
`cell_wip_limits`	array of unknown	Необязательно
`default_card_type_id`	integer	Необязательно
`default_tags`	string \| null	Необязательно
`first_image_is_cover`	boolean	Необязательно
`reset_lane_spent_time`	boolean	Необязательно
`automove_cards`	boolean	Необязательно
`backward_moves_enabled`	boolean	Необязательно
`move_parents_to_done`	boolean	Необязательно
`hide_done_policies`	boolean	Необязательно
`hide_done_policies_in_done_column`	boolean	Необязательно
`sort_order`	number	Необязательно
`external_id`	number \| string \| null	Необязательно
`move_from_space_id`	integer	Необязательно
`auto_assign_enabled`	boolean	Необязательно
`card_properties`	array of object \| null	Необязательно

spaceTemplateChecklistItems

createNewSpaceTemplateChecklistItem

client.spaceTemplateChecklistItems.createNewSpaceTemplateChecklistItem · POST /api/latest/spaces/{space_uid}/template-checklists/{template_checklist_uid}/items

Create new space template checklist item. Документация Kaiten.

...args: SpaceTemplateChecklistItemsCreateNewSpaceTemplateChecklistItemParams

declare const createNewSpaceTemplateChecklistItem: (
  spaceUid: string,
  templateChecklistUid: string,
  text: string,
  sortOrder?: number,
  options?: OperationOptions,
) => Promise<SpaceTemplateChecklistItemsCreateNewSpaceTemplateChecklistItemResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`template_checklist_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`text`	string	Обязательно
`sort_order`	number	Необязательно

Ответ: Объект. Поля: uid, text, sort_order, user_id, created, updated.

removeSpaceTemplateChecklistItem

client.spaceTemplateChecklistItems.removeSpaceTemplateChecklistItem · DELETE /api/latest/spaces/{space_uid}/template-checklists/{template_checklist_uid}/items/{item_uid}

Remove space template checklist item. Документация Kaiten.

...args: SpaceTemplateChecklistItemsRemoveSpaceTemplateChecklistItemParams

declare const removeSpaceTemplateChecklistItem: (
  spaceUid: string,
  templateChecklistUid: string,
  itemUid: string,
  options?: OperationOptions,
) => Promise<SpaceTemplateChecklistItemsRemoveSpaceTemplateChecklistItemResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`template_checklist_uid`	string	Обязательно
`item_uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: uid.

updateSpaceTemplateChecklistItem

client.spaceTemplateChecklistItems.updateSpaceTemplateChecklistItem · PATCH /api/latest/spaces/{space_uid}/template-checklists/{template_checklist_uid}/items/{item_uid}

Update space template checklist item. Документация Kaiten.

...args: SpaceTemplateChecklistItemsUpdateSpaceTemplateChecklistItemParams

declare const updateSpaceTemplateChecklistItem: (
  spaceUid: string,
  templateChecklistUid: string,
  itemUid: string,
  body: SpaceTemplateChecklistItemsUpdateSpaceTemplateChecklistItemBody,
  options?: OperationOptions,
) => Promise<SpaceTemplateChecklistItemsUpdateSpaceTemplateChecklistItemResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`template_checklist_uid`	string	Обязательно
`item_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`text`	string	Необязательно
`sort_order`	number	Необязательно

Ответ: Объект. Поля: uid, text, sort_order, user_id, created, updated.

spaceTemplateChecklist

createNewSpaceTemplateChecklist

client.spaceTemplateChecklist.createNewSpaceTemplateChecklist · POST /api/latest/spaces/{space_uid}/template-checklists

Create new space template checklist. Документация Kaiten.

...args: SpaceTemplateChecklistCreateNewSpaceTemplateChecklistParams

declare const createNewSpaceTemplateChecklist: (
  spaceUid: string,
  name: string,
  sortOrder?: number,
  options?: OperationOptions,
) => Promise<SpaceTemplateChecklistCreateNewSpaceTemplateChecklistResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`sort_order`	number	Необязательно

Ответ: Объект. Поля: uid, name, sort_order, space_uid, created, updated.

getListOfSpaceTemplateChecklists

client.spaceTemplateChecklist.getListOfSpaceTemplateChecklists · GET /api/latest/spaces/{space_uid}/template-checklists

Get list of space template checklists. Документация Kaiten.

...args: SpaceTemplateChecklistGetListOfSpaceTemplateChecklistsParams

declare const getListOfSpaceTemplateChecklists: (
  spaceUid: string,
  options?: OperationOptions,
) => Promise<SpaceTemplateChecklistGetListOfSpaceTemplateChecklistsResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: uid, name, sort_order, space_uid, created, updated, items.

removeSpaceTemplateChecklist

client.spaceTemplateChecklist.removeSpaceTemplateChecklist · DELETE /api/latest/spaces/{space_uid}/template-checklists/{template_checklist_uid}

Remove space template checklist. Документация Kaiten.

...args: SpaceTemplateChecklistRemoveSpaceTemplateChecklistParams

declare const removeSpaceTemplateChecklist: (
  spaceUid: string,
  templateChecklistUid: string,
  options?: OperationOptions,
) => Promise<SpaceTemplateChecklistRemoveSpaceTemplateChecklistResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`template_checklist_uid`	string	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: uid.

updateSpaceTemplateChecklist

client.spaceTemplateChecklist.updateSpaceTemplateChecklist · PATCH /api/latest/spaces/{space_uid}/template-checklists/{template_checklist_uid}

Update space template checklist. Документация Kaiten.

...args: SpaceTemplateChecklistUpdateSpaceTemplateChecklistParams

declare const updateSpaceTemplateChecklist: (
  spaceUid: string,
  templateChecklistUid: string,
  body: SpaceTemplateChecklistUpdateSpaceTemplateChecklistBody,
  options?: OperationOptions,
) => Promise<SpaceTemplateChecklistUpdateSpaceTemplateChecklistResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_uid`	string	Обязательно
`template_checklist_uid`	string	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Необязательно
`sort_order`	number	Необязательно
`space_uid`	string	Необязательно

Ответ: Объект. Поля: uid, name, sort_order, space_uid, created, updated.

spaceUsers

changeUserRoleAndNotificationSettings

client.spaceUsers.changeUserRoleAndNotificationSettings · PATCH /api/latest/spaces/{space_id}/users/{id}

Change user role and notification settings. Документация Kaiten.

...args: SpaceUsersChangeUserRoleAndNotificationSettingsParams

declare const changeUserRoleAndNotificationSettings: (
  spaceId: number,
  id: number,
  body: SpaceUsersChangeUserRoleAndNotificationSettingsBody,
  options?: OperationOptions,
) => Promise<SpaceUsersChangeUserRoleAndNotificationSettingsResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`role_id`	string	Необязательно
`notifications_enabled`	boolean	Необязательно
`space_group_id`	number \| null	Необязательно
`settings`	object	Необязательно

Ответ: Объект. Поля: entity_uid, access_mod, own_role_ids, own_access_mod, own_role, user_id, id.

getListOfUsers

client.spaceUsers.getListOfUsers · GET /api/latest/spaces/{space_id}/users

Get list of users. Документация Kaiten.

...args: SpaceUsersGetListOfUsersParams

declare const getListOfUsers: (
  spaceId: number,
  query?: SpaceUsersGetListOfUsersQuery,
  options?: OperationOptions,
) => Promise<SpaceUsersGetListOfUsersResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`include_inherited_access`	boolean	Необязательно
`inactive`	boolean	Необязательно
`limit`	integer	Необязательно
`last_user_id`	integer	Необязательно

Ответ: Массив. Поля: id, full_name, email, username, avatar_initials_url, avatar_uploaded_url, initials, avatar_type, lng, timezone, theme, created, updated, activated, ui_version, virtual, apps_permissions, temporarily_inactive, access_mod, own_role_ids, own_access_mod, own_role, current.

getUser

client.spaceUsers.getUser · GET /api/latest/spaces/{space_id}/users/{id}

Get user. Документация Kaiten.

...args: SpaceUsersGetUserParams

declare const getUser: (
  spaceId: number,
  id: number,
  options?: OperationOptions,
) => Promise<SpaceUsersGetUserResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

inviteUserToSpace

client.spaceUsers.inviteUserToSpace · POST /api/latest/spaces/{space_id}/users

Invite user to space. Документация Kaiten.

...args: SpaceUsersInviteUserToSpaceParams

declare const inviteUserToSpace: (
  spaceId: number,
  body: SpaceUsersInviteUserToSpaceBody,
  options?: OperationOptions,
) => Promise<SpaceUsersInviteUserToSpaceResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`email`	string	Обязательно
`role_id`	string	Необязательно
`guest`	boolean	Необязательно
`operator_comment`	string	Необязательно
`send_email`	boolean	Необязательно

Ответ: Объект. Поля: user, access_record, message.

removeUserFromSpace

client.spaceUsers.removeUserFromSpace · DELETE /api/latest/spaces/{space_id}/users/{id}

Remove user from space. Документация Kaiten.

...args: SpaceUsersRemoveUserFromSpaceParams

declare const removeUserFromSpace: (
  spaceId: number,
  id: number,
  options?: OperationOptions,
) => Promise<SpaceUsersRemoveUserFromSpaceResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: entity_uid, access_mod, own_role_ids, own_access_mod, own_role, user_id.

spaces

createNewSpace

client.spaces.createNewSpace · POST /api/latest/spaces

Create new space. Документация Kaiten.

...args: SpacesCreateNewSpaceParams

declare const createNewSpace: (
  body: SpacesCreateNewSpaceBody,
  options?: OperationOptions,
) => Promise<SpacesCreateNewSpaceResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string \| number	Обязательно
`external_id`	number \| string \| null	Необязательно
`parent_entity_uid`	string	Необязательно
`for_everyone_access_role_id`	string	Необязательно
`sort_order`	number	Необязательно
`work_calendar_id`	string	Необязательно

Ответ: Объект. Поля: created, updated, archived, uid, access, for_everyone_access_role_id, entity_type, path, sort_order, parent_entity_uid, company_id, id, title, allowed_card_type_ids, hidden_card_type_uids, external_id, settings, users.

removeSpace

client.spaces.removeSpace · DELETE /api/latest/spaces/{space_id}

Remove space. Документация Kaiten.

...args: SpacesRemoveSpaceParams

declare const removeSpace: (
  spaceId: number,
  options?: OperationOptions,
) => Promise<SpacesRemoveSpaceResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: id.

retrieveListOfSpaces

client.spaces.retrieveListOfSpaces · GET /api/latest/spaces

Retrieve list of spaces. Документация Kaiten.

...args: SpacesRetrieveListOfSpacesParams

declare const retrieveListOfSpaces: (
  limit?: number,
  offset?: number,
  options?: OperationOptions,
) => Promise<SpacesRetrieveListOfSpacesResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`limit`	integer	Необязательно
`offset`	integer	Необязательно

Ответ: Массив. Поля: created, updated, archived, uid, access, for_everyone_access_role_id, entity_type, path, sort_order, parent_entity_uid, company_id, id, title, allowed_card_type_ids, hidden_card_type_uids, external_id, settings, boards, user_id, entity_uid, access_mod.

retrieveSpace

client.spaces.retrieveSpace · GET /api/latest/spaces/{space_id}

Retrieve space. Документация Kaiten.

...args: SpacesRetrieveSpaceParams

declare const retrieveSpace: (
  spaceId: number,
  options?: OperationOptions,
) => Promise<SpacesRetrieveSpaceResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: created, updated, archived, uid, for_everyone_access_role_id, access, entity_type, path, sort_order, parent_entity_uid, company_id, id, title, allowed_card_type_ids, hidden_card_type_uids, external_id, settings.

updateSpace

client.spaces.updateSpace · PATCH /api/latest/spaces/{space_id}

Update space. Документация Kaiten.

...args: SpacesUpdateSpaceParams

declare const updateSpace: (
  spaceId: number,
  body: SpacesUpdateSpaceBody,
  options?: OperationOptions,
) => Promise<SpacesUpdateSpaceResponse>;

Параметры пути

Поле	Тип	Обязательность
`space_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`title`	string \| number	Необязательно
`external_id`	number \| string \| null	Необязательно
`hidden_card_type_uids`	array of string	Необязательно
`settings`	object	Необязательно
`access`	for_everyone \| by_invite	Необязательно
`parent_entity_uid`	string \| null	Необязательно
`sort_order`	number	Необязательно

sprints

getSprintSummary

client.sprints.getSprintSummary · GET /api/latest/sprints/{id}

Get sprint summary. Документация Kaiten.

...args: SprintsGetSprintSummaryParams

declare const getSprintSummary: (
  id: number,
  excludeDeletedCards?: boolean,
  options?: OperationOptions,
) => Promise<SprintsGetSprintSummaryResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

Поле	Тип	Обязательность
`exclude_deleted_cards`	boolean	Необязательно

Ответ: Объект. Поля: created, updated, archived, id, uid, board_id, title, goal, active, committed, children_committed, velocity, velocity_details, children_velocity, children_velocity_details, creator_id, updater_id, start_date, finish_date, actual_finish_date, cards, cardUpdates, customProperties.

getSprintsList

client.sprints.getSprintsList · GET /api/latest/sprints

Get sprints list. Документация Kaiten.

...args: SprintsGetSprintsListParams

declare const getSprintsList: (
  active?: boolean,
  limit?: number,
  offset?: number,
  options?: OperationOptions,
) => Promise<SprintsGetSprintsListResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`active`	boolean	Необязательно
`limit`	integer	Необязательно
`offset`	integer	Необязательно

Ответ: Массив. Поля: id, uid, board_id, title, goal, active, committed, children_committed, velocity, velocity_details, children_velocity, children_velocity_details, creator_id, updater_id, start_date, finish_date, actual_finish_date, created, updated, archived.

subcolumn

createNewSubcolumn

client.subcolumn.createNewSubcolumn · POST /api/latest/columns/{column_id}/subcolumns

Create new subcolumn. Документация Kaiten.

...args: SubcolumnCreateNewSubcolumnParams

declare const createNewSubcolumn: (
  columnId: number,
  body: SubcolumnCreateNewSubcolumnBody,
  options?: OperationOptions,
) => Promise<SubcolumnCreateNewSubcolumnResponse>;

Параметры пути

Поле	Тип	Обязательность
`column_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`external_id`	number \| string \| null	Необязательно
`title`	string	Обязательно
`sort_order`	number	Необязательно
`type`	1 \| 2 \| 3	Необязательно
`archive_after_days`	integer	Необязательно
`months_to_hide_cards`	integer \| null	Необязательно
`card_hide_after_days`	integer \| null	Необязательно
`col_count`	integer	Необязательно
`rules`	integer	Необязательно
`last_moved_warning_after_minutes`	integer	Необязательно
`last_moved_warning_after_hours`	integer	Необязательно
`last_moved_warning_after_days`	integer	Необязательно

Ответ: Объект. Поля: created, updated, id, title, sort_order, col_count, wip_limit, wip_limit_type, type, rules, board_id, column_id, archive_after_days, last_moved_warning_after_minutes, last_moved_warning_after_days, last_moved_warning_after_hours, external_id, default_tags, months_to_hide_cards, card_hide_after_days.

getListOfSubcolumns

client.subcolumn.getListOfSubcolumns · GET /api/latest/columns/{column_id}/subcolumns

Get list of subcolumns. Документация Kaiten.

...args: SubcolumnGetListOfSubcolumnsParams

declare const getListOfSubcolumns: (
  columnId: number,
  options?: OperationOptions,
) => Promise<SubcolumnGetListOfSubcolumnsResponse>;

Параметры пути

Поле	Тип	Обязательность
`column_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Массив. Поля: created, updated, id, title, sort_order, col_count, wip_limit, type, rules, board_id, column_id, archive_after_days, wip_limit_type, external_id, default_tags, last_moved_warning_after_days, months_to_hide_cards, card_hide_after_days, last_moved_warning_after_hours, last_moved_warning_after_minutes.

removeSubcolumn

client.subcolumn.removeSubcolumn · DELETE /api/latest/columns/{column_id}/subcolumns/{id}

Remove subcolumn. Документация Kaiten.

...args: SubcolumnRemoveSubcolumnParams

declare const removeSubcolumn: (
  columnId: number,
  subcolumnId: number,
  force?: boolean,
  options?: OperationOptions,
) => Promise<SubcolumnRemoveSubcolumnResponse>;

Параметры пути

Поле	Тип	Обязательность
`column_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`force`	boolean	Необязательно

Ответ: Объект. Поля: id.

updateSubcolumn

client.subcolumn.updateSubcolumn · PATCH /api/latest/columns/{column_id}/subcolumns/{id}

Update subcolumn. Документация Kaiten.

...args: SubcolumnUpdateSubcolumnParams

declare const updateSubcolumn: (
  columnId: number,
  subcolumnId: number,
  body: SubcolumnUpdateSubcolumnBody,
  options?: OperationOptions,
) => Promise<SubcolumnUpdateSubcolumnResponse>;

Параметры пути

Поле	Тип	Обязательность
`column_id`	integer	Обязательно
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`external_id`	number \| string \| null	Необязательно
`title`	string	Необязательно
`sort_order`	number	Необязательно
`type`	1 \| 2 \| 3	Необязательно
`archive_after_days`	integer	Необязательно
`months_to_hide_cards`	integer \| null	Необязательно
`card_hide_after_days`	integer \| null	Необязательно
`col_count`	integer	Необязательно
`rules`	integer	Необязательно
`default_tags`	string \| null	Необязательно
`last_moved_warning_after_minutes`	integer	Необязательно
`last_moved_warning_after_hours`	integer	Необязательно
`last_moved_warning_after_days`	integer	Необязательно
`prev_column_id`	integer \| null	Необязательно
`next_column_id`	integer \| null	Необязательно
`pause_sla`	boolean	Необязательно

timesheet

getList

client.timesheet.getList · GET /api/latest/time-logs

Клиент принимает восемь фильтров ID со списками через запятую как строки или readonly-массивы чисел (QueryList<number>).

Get list. Документация Kaiten.

...args: TimesheetGetListParams

declare const getList: (
  query: TimesheetGetListQuery,
  options?: OperationOptions,
) => Promise<TimesheetGetListResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`from`	string	Обязательно
`to`	string	Обязательно
`tag_ids`	string	Необязательно
`user_ids`	string	Необязательно
`group_ids`	string	Необязательно
`space_ids`	string	Необязательно
`board_ids`	string	Необязательно
`column_ids`	string	Необязательно
`card_ids`	string	Необязательно
`visible_column_ids`	string	Необязательно
`limit`	integer	Необязательно
`offset`	integer	Необязательно
`condition`	integer	Необязательно
`group_by`	integer	Необязательно
`time_precision`	integer	Необязательно
`time_unit`	integer	Необязательно
`with_daily_distribution`	integer	Необязательно
`only_general_sum`	integer	Необязательно

Ответ: Массив. Поля: created, updated, id, card_id, user_id, role_id, author_id, updater_id, time_spent, for_date, comment, card, user, role.

treeEntities

getListOfEntities

client.treeEntities.getListOfEntities · GET /api/latest/tree-entities

Get list of entities. Документация Kaiten. Beta.

...args: TreeEntitiesGetListOfEntitiesParams

declare const getListOfEntities: (
  query?: TreeEntitiesGetListOfEntitiesQuery,
  options?: OperationOptions,
) => Promise<TreeEntitiesGetListOfEntitiesResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`limit`	number	Необязательно
`offset`	number	Необязательно
`parent_entity_uid`	string	Необязательно
`levels_count`	number	Необязательно

Ответ: Массив. Поля: id, uid, title, external_id, company_id, sort_order, path, parent_entity_uid, entity_type, access, archived, for_everyone_access_role_id.

treeEntityRoles

getListOfTreeEntityRoles

client.treeEntityRoles.getListOfTreeEntityRoles · GET /api/latest/tree-entity-roles

Get list of tree entity roles. Документация Kaiten. Beta.

...args: TreeEntityRolesGetListOfTreeEntityRolesParams

declare const getListOfTreeEntityRoles: (
  options?: OperationOptions,
) => Promise<TreeEntityRolesGetListOfTreeEntityRolesResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Ответ: Массив. Поля: id, name, permissions, sort_order, new_permissions_default_value, updated, created.

userRoles

createUserRole

client.userRoles.createUserRole · POST /api/latest/user-roles

Create user role. Документация Kaiten.

...args: UserRolesCreateUserRoleParams

declare const createUserRole: (
  name: string,
  options?: OperationOptions,
) => Promise<UserRolesCreateUserRoleResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Обязательно

Ответ: Объект. Поля: name, company_id, updated, created, id, uid.

getListOfUserRoles

client.userRoles.getListOfUserRoles · GET /api/latest/user-roles

Get list of user roles. Документация Kaiten.

...args: UserRolesGetListOfUserRolesParams

declare const getListOfUserRoles: (
  options?: OperationOptions,
) => Promise<UserRolesGetListOfUserRolesResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Ответ: Массив. Поля: created, updated, id, uid, name, company_id.

getUserRole

client.userRoles.getUserRole · GET /api/latest/user-roles/{role_id}

Get user role. Документация Kaiten.

...args: UserRolesGetUserRoleParams

declare const getUserRole: (
  roleId: number,
  options?: OperationOptions,
) => Promise<UserRolesGetUserRoleResponse>;

Параметры пути

Поле	Тип	Обязательность
`role_id`	integer	Обязательно

Параметры запроса

нет.

Ответ: Объект. Поля: name, company_id, updated, created, id, uid.

removeUserRole

client.userRoles.removeUserRole · DELETE /api/latest/user-roles/{role_id}

Remove user role. Документация Kaiten.

...args: UserRolesRemoveUserRoleParams

declare const removeUserRole: (
  roleId: number,
  replaceRoleId: number,
  options?: OperationOptions,
) => Promise<UserRolesRemoveUserRoleResponse>;

Параметры пути

Поле	Тип	Обязательность
`role_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`replace_role_id`	integer	Обязательно

Ответ: Объект. Поля: name, company_id, updated, created, id, uid.

updateUserRole

client.userRoles.updateUserRole · PATCH /api/latest/user-roles/{role_id}

Update user role. Документация Kaiten.

...args: UserRolesUpdateUserRoleParams

declare const updateUserRole: (
  roleId: number,
  name: string,
  options?: OperationOptions,
) => Promise<UserRolesUpdateUserRoleResponse>;

Параметры пути

Поле	Тип	Обязательность
`role_id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`name`	string	Обязательно

Ответ: Объект. Поля: name, company_id, updated, created, id, uid.

users

retrieveCurrentUser

client.users.retrieveCurrentUser · GET /api/latest/users/current

Retrieve current user. Документация Kaiten.

...args: UsersRetrieveCurrentUserParams

declare const retrieveCurrentUser: (
  options?: OperationOptions,
) => Promise<UsersRetrieveCurrentUserResponse>;

Параметры пути

нет.

Параметры запроса

нет.

Ответ: Объект. Поля: id, full_name, email, username, avatar_initials_url, avatar_uploaded_url, initials, avatar_type, lng, timezone, theme, created, updated, activated, ui_version, company_id, telegram_id, telegram_settings, user_id, default_space_id, permissions, role, email_frequency, email_settings, slack_id, slack_settings, notification_settings, notification_enabled_channels, slack_private_channel_id, telegram_sd_bot_enabled, invite_last_sent_at, apps_permissions, external, last_request_date, last_request_method, has_password.

retrieveListOfUsers

client.users.retrieveListOfUsers · GET /api/latest/users

Клиент принимает ids как строку или readonly-массив чисел (QueryList<number>).

Retrieve list of users. Документация Kaiten.

...args: UsersRetrieveListOfUsersParams

declare const retrieveListOfUsers: (
  query?: UsersRetrieveListOfUsersQuery,
  options?: OperationOptions,
) => Promise<UsersRetrieveListOfUsersResponse>;

Параметры пути

нет.

Параметры запроса

Поле	Тип	Обязательность
`type`	string	Необязательно
`query`	string	Необязательно
`access_type_permissions`	string	Необязательно
`ids`	string	Необязательно
`limit`	integer	Необязательно
`offset`	integer	Необязательно
`include_inactive`	boolean	Необязательно
`exclude_directly_added_members_by_entity_uid`	string	Необязательно
`exclude_members_by_entity_uid`	string	Необязательно

Ответ: Массив. Поля: id, full_name, email, username, avatar_initials_url, avatar_uploaded_url, initials, avatar_type, lng, timezone, theme, created, updated, activated, ui_version, company_id, user_id, default_space_id, permissions, role, email_frequency, email_settings, slack_id, slack_settings, notification_settings, notification_enabled_channels, slack_private_channel_id, telegram_sd_bot_enabled, invite_last_sent_at, apps_permissions, external, last_request_date, last_request_method.

updateUser

client.users.updateUser · PATCH /api/latest/users/{id}

Update user. Документация Kaiten.

...args: UsersUpdateUserParams

declare const updateUser: (
  userId: number,
  body: UsersUpdateUserBody,
  options?: OperationOptions,
) => Promise<UsersUpdateUserResponse>;

Параметры пути

Поле	Тип	Обязательность
`id`	integer	Обязательно

Параметры запроса

нет.

Тело запроса

Поле	Тип	Обязательность
`username`	string	Необязательно
`full_name`	string	Необязательно
`initials`	string	Необязательно
`avatar_type`	1 \| 2 \| 3	Необязательно
`password`	string	Необязательно
`old_password`	string \| null	Необязательно
`lng`	string	Необязательно
`default_space_id`	integer \| null	Необязательно
`theme`	light \| dark \| auto	Необязательно
`email_frequency`	1 \| 2	Необязательно
`timezone`	string	Необязательно
`subject_by`	1 \| 2	Необязательно
`email_settings`	object	Необязательно
`telegram_settings`	object	Необязательно
`slack_settings`	object	Необязательно
`notification_enabled_channels`	array of inner \| mobile_app \| email \| slack \| telegram	Необязательно
`notification_settings`	object	Необязательно
`ui_version`	1 \| 2	Необязательно

Ответ: Объект. Поля: created, updated, id, full_name, username, email, activated, show_tour, avatar_initials_url, avatar_uploaded_url, initials, avatar_type, lng, sd_telegram_id, timezone, news_subscription, theme, ui_version, default_space_id, email_frequency, email_settings, work_time_settings, telegram_id, telegram_settings, has_password.

REST API: все операции ​

auditLogs ​

retrieveAuditLogEvents ​

automations ​

createAutomation ​

deleteAutomation ​

getListOfAutomations ​

updateAutomation ​

boards ​

getBoard ​

cardAllowedUsers ​

retrieveUsersList ​

cardBlockerCategories ​

addBlockerCategory ​

removeCategory ​

retrieveListOfCategories ​

cardBlockerUsers ​

addUserToTheCardBlocker ​

removeUser ​

retrieveBlockersCardsListOnCurrentUser ​

retrieveListOfUsers ​

cardBlockers ​

blockCard ​

deleteCardBlockers ​

retrieveCardBlockersList ​

updateCardBlockers ​

cardChecklistItems ​

addItemToChecklist ​

removeChecklistItem ​

updateChecklistItem ​

cardChecklists ​

addChecklistToCard ​

removeChecklistFromCard ​

retrieveCardChecklist ​

updateChecklist ​

cardChildren ​

addChildren ​

removeChildren ​

retrieveCardChildrenList ​

cardComments ​

addComment ​

removeComment ​

retrieveCardComments ​

updateComment ​

cardExternalLinks ​

addExternalLink ​

removeExternalLink ​

retrieveCardExternalLinks ​

updateExternalLink ​

cardFiles ​

attachFileToCard ​

detachFileFromCard ​

updateFile ​

cardMembers ​

addMemberToCard ​

removeMemberFromCard ​

retrieveListOfCardMembers ​

updateMemberRole ​

cardServiceDeskExternalRecipients ​

addNewRecipient ​

removeRecipient ​

cardSla ​

retrieveCardSlaMeasurements ​

cardTags ​

addTag ​

removeTagFromCard ​

rertrieveListOfTags ​

cardTimeLogs ​

addTimeLog ​

getTimeLogs ​

removeTimeLog ​

updateLogRecord ​

cardTypeTreeEntities ​

addTreeEntityToCardType ​

deleteTreeEntityFromCardType ​

getListOfTypeTreeEntities ​

cardTypes ​

createNewCardType ​

getCardType ​

getListOfCardTypes ​

REST API: все операции

auditLogs

retrieveAuditLogEvents

automations

createAutomation

deleteAutomation

getListOfAutomations

updateAutomation

boards

getBoard

cardAllowedUsers

retrieveUsersList

cardBlockerCategories

addBlockerCategory

removeCategory

retrieveListOfCategories

cardBlockerUsers

addUserToTheCardBlocker

removeUser

retrieveBlockersCardsListOnCurrentUser

retrieveListOfUsers

cardBlockers

blockCard

deleteCardBlockers

retrieveCardBlockersList

updateCardBlockers

cardChecklistItems

addItemToChecklist

removeChecklistItem

updateChecklistItem

cardChecklists

addChecklistToCard

removeChecklistFromCard

retrieveCardChecklist

updateChecklist

cardChildren

addChildren

removeChildren

retrieveCardChildrenList

cardComments

addComment

removeComment

retrieveCardComments

updateComment

cardExternalLinks

addExternalLink

removeExternalLink

retrieveCardExternalLinks

updateExternalLink

cardFiles

attachFileToCard

detachFileFromCard

updateFile

cardMembers

addMemberToCard

removeMemberFromCard

retrieveListOfCardMembers

updateMemberRole

cardServiceDeskExternalRecipients

addNewRecipient

removeRecipient

cardSla

retrieveCardSlaMeasurements

cardTags

addTag

removeTagFromCard

rertrieveListOfTags

cardTimeLogs

addTimeLog

getTimeLogs

removeTimeLog

updateLogRecord

cardTypeTreeEntities

addTreeEntityToCardType

deleteTreeEntityFromCardType

getListOfTypeTreeEntities

cardTypes

createNewCardType

getCardType

getListOfCardTypes