@swit-api/api-client

Index

Interfaces

ApiClientConfig

Type Aliases

Variables

Type Aliases

AddChannelParam

AddChannelParam: { description?: string; is_prev_chat_visible?: boolean; is_private?: boolean; name: string; workspace_id: string }

Type declaration

optionaldescription?: string
The description on the purpose of the channel.
optionalis_prev_chat_visible?: boolean
Whether to disclose previous messages to new members.
optionalis_private?: boolean
Whether to keep the channel private.
name: string
The name of the channel.
workspace_id: string
The ID of the workspace where to create the channel.

AddChannelResponse

AddChannelResponse: { channel?: ChannelResponse }

An object wrapping a Swit resource.

Type declaration

optionalchannel?: ChannelResponse

AddChannelUserInviteParam

AddChannelUserInviteParam: { id: string; user_ids: string[] }

Type declaration

id: string
The ID of the channel to invite the users to.
user_ids: string[]
The IDs of the users to invite.

AddCompanyUserListParam

AddCompanyUserListParam: { new_users: AddCompanyUserParam[]; role: number }

Type declaration

new_users: AddCompanyUserParam[]
The properties of new guests.
role: number
The role of the user.

AddCompanyUserParam

AddCompanyUserParam: { language?: AddCompanyUserParam.language; msg?: string; tel?: string; timezone?: string; user_email: string; user_name: string }

Type declaration

optionallanguage?: AddCompanyUserParam.language
The language setting of the user.
optionalmsg?: string
The status message of the user.
optionaltel?: string
The telephone number of the user.
optionaltimezone?: string
The timezone of the user.
user_email: string
The email of the user.
user_name: string
The name of the user.

AddCompanyWorkspaceInviteParam

AddCompanyWorkspaceInviteParam: { id: string; user_id?: string; user_ids?: string[] }

Type declaration

id: string
The ID of the workspace to invite the user to.
optionaluser_id?: string
The ID of the user to invite to the workspace. (If values are provided for both "user_id" and "user_ids", then "user_ids" will take precedence.)
optionaluser_ids?: string[]
IDs of users to invite to the workspace. (If values are provided for both "user_id" and "user_ids", then "user_ids" will take precedence.)

AddCompanyWorkspaceInviteResponse

AddCompanyWorkspaceInviteResponse: Record<string, any>

An object wrapping a Swit resource.

AddCustomFieldParam

AddCustomFieldParam: { custom_field_elements?: CustomFieldOptionElement[]; description?: string; edit_role: AddCustomFieldParam.edit_role; enabled: boolean; field_name: string; field_type: AddCustomFieldParam.field_type }

Type declaration

optionalcustom_field_elements?: CustomFieldOptionElement[]
Array of selections if the field type is dropdown (field_type=OPTION).
optionaldescription?: string
The placeholder for the custom field if the field type is text (field_type=STRING) or URL (field_type=URL).
edit_role: AddCustomFieldParam.edit_role
Who can update the field's value:
- ADMIN: The organization's admins can update the field's value for each member.
- MEMBER: Each member can update the field's value for their own profile.
enabled: boolean
Whether to display the field on user profiles. Up to five fields can be set to be displayed.
field_name: string
The name of the custom field.
field_type: AddCustomFieldParam.field_type
Type of the custom field: STRING, URL, or OPTION (dropdown).

AddCustomFieldResponse

AddCustomFieldResponse: { custom_field?: CustomField }

An object wrapping a Swit resource.

Type declaration

optionalcustom_field?: CustomField

AddIdeaReactionParam

AddIdeaReactionParam: { idea_id: string; reaction_name: string }

Type declaration

idea_id: string
The ID of idea to react to.
reaction_name: string
The alias of the reaction emoji surrounded by a preceding and a trailing ':' symbol. Get the whole list of available emojis and their aliases from https://github.com/github/gemoji/blob/master/db/emoji.json.

AddIdeaReactionResponse

AddIdeaReactionResponse: Record<string, any>

An object wrapping a Swit resource.

AddMessageReactionParam

AddMessageReactionParam: { message_id: string; reaction_name: string }

Type declaration

message_id: string
The ID of the message to react to.
reaction_name: string
The alias of the reaction emoji surrounded by a preceding and a trailing ':' symbol. Get the whole list of available emojis and their aliases from https://github.com/github/gemoji/blob/master/db/emoji.json.

AddMessageReactionResponse

AddMessageReactionResponse: Record<string, any>

An object wrapping a Swit resource.

AddProjectBucketParam

AddProjectBucketParam: { name: string; project_id: string }

Type declaration

name: string
The title of the bucket.
project_id: string
The ID of the project where to add the bucket.

AddProjectBucketResponse

AddProjectBucketResponse: { bucket?: BucketResponse }

An object wrapping a Swit resource.

Type declaration

optionalbucket?: BucketResponse

AddProjectParam

AddProjectParam: { description?: string; is_private?: boolean; name: string; workspace_id: string }

Type declaration

optionaldescription?: string
Description on the purpose of the project.
optionalis_private?: boolean
Whether to keep the project private.
name: string
The name of the project.
workspace_id: string
The ID of the workspace where to create the project.

AddProjectResponse

AddProjectResponse: { project: ProjectResponse }

An object wrapping a Swit resource.

Type declaration

project: ProjectResponse

AddTaskAssigneeParam

AddTaskAssigneeParam: { task_id: string; user_id?: string; user_ids?: string[] }

Type declaration

task_id: string
The ID of the task.
optionaluser_id?: string
The user ID of the assignee. If both user_id and user_ids parameters are entered, priority is applied based on the value of the user_id parameter.(user_id랑 user_ids에 모두 값이 들어가 있으면, user_ids 기준으로 적용됨)
optionaluser_ids?: string[]
User IDs of assignees. If both user_id and user_ids parameters are entered, priority is applied based on the value of the user_id parameter. (user_id랑 user_ids에 모두 값이 들어가 있으면, user_ids 기준으로 적용됨)

AddTaskAssigneeResponse

AddTaskAssigneeResponse: { assignee_id?: string; assignee_ids?: string[] }

An object wrapping a Swit resource.

Type declaration

optionalassignee_id?: string
The user ID of the assignee.
optionalassignee_ids?: string[]
User IDs of assignees.

AddTaskCheckListParam

AddTaskCheckListParam: { content: string; task_id: string }

Type declaration

content: string
The content of the checklist item.
task_id: string
The ID of the task where to add the checklist item.

AddTaskCheckListResponse

AddTaskCheckListResponse: { taskChecklist?: TaskChecklistResponse }

An object wrapping a Swit resource.

Type declaration

optionaltaskChecklist?: TaskChecklistResponse

AddTaskCommentParam

AddTaskCommentParam: { assets?: ExternalAssetInfo[]; body_type?: AddTaskCommentParam.body_type; content: string; external_asset_type?: AddTaskCommentParam.external_asset_type; task_id: string }

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the task.
optionalbody_type?: AddTaskCommentParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
content: string
The content of the comment.
optionalexternal_asset_type?: AddTaskCommentParam.external_asset_type
The storage type of the attached file.
- google_drive: Google Drive files.
- gcp_storage: All other types of files.
task_id: string
The ID of the task to comment on.

AddTaskCommentResponse

AddTaskCommentResponse: { taskComment?: TaskCommentResponse }

An object wrapping a Swit resource.

Type declaration

optionaltaskComment?: TaskCommentResponse

AddTaskFollowParam

AddTaskFollowParam: { task_id: string; user_id?: string; user_ids?: string[] }

Type declaration

task_id: string
The ID of the task.
optionaluser_id?: string
The user ID of the collaborator. If both user_id and user_ids parameters are entered, priority is applied based on the value of the user_id parameter.(user_id랑 user_ids에 모두 값이 들어가 있으면, user_ids 기준으로 적용됨)
optionaluser_ids?: string[]
User IDs of collaborators. If both user_id and user_ids parameters are entered, priority is applied based on the value of the user_id parameter. (user_id랑 user_ids에 모두 값이 들어가 있으면, user_ids 기준으로 적용됨)

AddTaskFollowResponse

AddTaskFollowResponse: { follower_id?: string[] }

An object wrapping a Swit resource.

Type declaration

optionalfollower_id?: string[]
The user IDa of the collaborator.

AddTaskParam

AddTaskParam: { assets?: ExternalAssetInfo[]; assign?: string; body_type?: AddTaskParam.body_type; bucket_id?: string; color?: AddTaskParam.color; content?: string; create_type?: string; end_date?: string; external_asset_type?: AddTaskParam.external_asset_type; follow?: string; priority?: string; project_id: string; start_date?: string; step?: string; tag?: string; title: string; workspace_id?: string }

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the task.
optionalassign?: string
The user ID of the member to whom to assign the task.
optionalbody_type?: AddTaskParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
optionalbucket_id?: string
The ID of the bucket the task is in.
optionalcolor?: AddTaskParam.color
Color assigned to the task.
optionalcontent?: string
The content of the task.
optionalcreate_type?: string
Where the task is created from.
- B: Backlog
- M: My tasks
- C: Bucket
- ALL: Assignee & status
- A: Assignee
- S: Status
optionalend_date?: string
Date by which the task will end. Use the YYYY-MM-DD format.
optionalexternal_asset_type?: AddTaskParam.external_asset_type
The storage type of the attached file.
- google_drive: Google Drive files.
- gcp_storage: All other types of files.
optionalfollow?: string
The ID(s) of the member(s) to collaborate in the task.
optionalpriority?: string
Priority to set for the task.
project_id: string
The ID of the project where to post the task.
optionalstart_date?: string
Date on which the task starts. Use the YYYY-MM-DD format.
optionalstep?: string
Deprecated. Update the status using api/task.status.update instead.

Status of the task:
- ToDo: Set the task's status to "To Do".
- Doing: Set the task's status to "Doing".
- Done: Set the task's status to "Done".
If not passed, the status is set to Backlog by default.
optionalreadonlytag?: string
The tag associated with the task.
title: string
The title of the task.
optionalworkspace_id?: string
The ID of the workspace that includes the target project. Only required when mytask is passed to the project_id parameter (for a Personal task).

AddTaskResponse

AddTaskResponse: { task?: TaskResponse }

An object wrapping a Swit resource.

Type declaration

optionaltask?: TaskResponse

AppendAssetTaskParam

AppendAssetTaskParam: { assets?: ExternalAssetInfo[]; external_asset_type?: AppendAssetTaskParam.external_asset_type; id: string; workspace_id?: string }

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the task.
optionalexternal_asset_type?: AppendAssetTaskParam.external_asset_type
The storage type of the attached file.
- google_drive: Google Drive files.
- gcp_storage: All other types of files.
id: string
The ID of the task.
optionalworkspace_id?: string
The ID of the workspace.

ApprovalCategoryListResponse

ApprovalCategoryListResponse: { categories?: GetApprovalCategoryListResponse[]; offset?: string }

An object wrapping a Swit resource.

Type declaration

optionalcategories?: GetApprovalCategoryListResponse[]
Details of each request template retrieved.
optionaloffset?: string
Offset string that indicates the last entry returned.

ApprovalListResponse

ApprovalListResponse: { approvals?: GetApprovalListResponse[]; offset?: string }

An object wrapping a Swit resource.

Type declaration

optionalapprovals?: GetApprovalListResponse[]
Details of each request retrieved.
optionaloffset?: string
Offset string that indicates the last entry returned.

Approver

Approver: { action_date?: string; approver_status?: number; approver_user_id?: string; step?: number }

Type declaration

optionalaction_date?: string
The date and time at which the approver approved or declined the request at this level.
optionalapprover_status?: number
The approver's status.
- 1: Being requested for approval
- 2: Approved the request.
- 3: Declined the request.
- 4: The request was processed at this level by another approver.
optionalapprover_user_id?: string
The user ID of the approver.
optionalstep?: number
The level of approval.

Approvers

Approvers: { approver_ids?: string[]; step?: number; step_condition?: number }

Type declaration

optionalapprover_ids?: string[]
The user IDs of the approvers.
optionalstep?: number
The level of approval.
optionalstep_condition?: number
- 0: Any approver can approver to pass the current approval level.
- 1: Every approver must approve to pass the current approval level.

Asset

Asset: { approval_asset_id?: string; approval_cont_id?: string; approval_id?: string; created?: string; file_desc?: string; file_mime?: string; file_name?: string; file_path?: string; file_size?: number; image_x?: number; image_y?: number; thumbnail?: string; user_id?: string }

Type declaration

optionalapproval_asset_id?: string
The ID of the file.
optionalapproval_cont_id?: string
The ID of the content of the request.
optionalapproval_id?: string
The ID of the request to which this file is attached.
optionalcreated?: string
The date and time at which the file was uploaded.
optionalfile_desc?: string
Description on the file.
optionalfile_mime?: string
MIME type of the file.
optionalfile_name?: string
The name of the file.
optionalfile_path?: string
The URL path of the file.
optionalfile_size?: number
The size of the file in bytes.
optionalimage_x?: number
The image's width.
optionalimage_y?: number
The image's height.
optionalthumbnail?: string
The Thumbnail URL of the file.
optionaluser_id?: string
The ID of the user who uploaded the file.

Attachments

Attachments: { attachment_type?: custom | chat | task | mail | calendar | og; values?: Record<string, any>[] }[]

List of data attachments to the message.

Refer to the AttachmentView section for more details.

When making a request with this property, only attachment_type=custom is allowed.

BucketResponse

BucketResponse: { created?: string; id?: string; name?: string; project_id?: string }

An object wrapping a Swit resource.

Type declaration

optionalcreated?: string
The date and time at which the bucket was created.
optionalid?: string
The ID of the bucket.
optionalname?: string
The title of the bucket.
optionalproject_id?: string
The ID of the project where to add the bucket.

ChannelResponse

ChannelResponse: { created?: string; description?: string; host_id?: string; id?: string; is_archived?: boolean; is_member?: boolean; is_prev_chat_visible?: boolean; is_private?: boolean; is_starred?: boolean; name?: string; type?: string }

An object wrapping a Swit resource.

Type declaration

optionalcreated?: string
The date and time at which the channel was created.
optionaldescription?: string
Description on the purpose of the channel.
optionalhost_id?: string
The ID of the host of the channel.
optionalid?: string
The ID of the channel.
optionalis_archived?: boolean
Whether the channel is archived.
optionalis_member?: boolean
Whether the user joined the channel.
optionalis_prev_chat_visible?: boolean
Whether the channel discloses previous messages to new members.
optionalis_private?: boolean
Whether the channel is private.
optionalis_starred?: boolean
Whether the channel is starred by the user.
optionalname?: string
The name of the channel.
optionaltype?: string
Type of the channel.
- dfl: The channel is the default chat room joined by all workspace members.
- gen: The channel is an additionally created group chat.

ChannelUserResponse

ChannelUserResponse: { id?: string; name?: string }

Type declaration

optionalid?: string
The user ID of the member.
optionalname?: string
The display name of the member.

Comment

Comment: { assets?: ExternalAssetInfo[]; comment_id?: string; content?: string; created?: string; user_id?: string; user_name?: string }

The properties for a comment.

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the comment.
optionalcomment_id?: string
The ID of the comment.
optionalcontent?: string
The content of the comment.
optionalcreated?: string
The date and time at which the comment was posted.
optionaluser_id?: string
The ID of the user who posted the comment.
optionaluser_name?: string
The display name of the user who posted the comment.

Contents: { attachments?: Attachments; body_blockskit?: Record<string, any>; body_text?: string; child_cnt?: number; contents_id?: string; contents_type?: string; created?: string; is_bookmark?: boolean; is_delete?: boolean; is_pin?: boolean; modified?: string; offset?: string; parent_id?: string; properties?: { client_id?: string; is_outcome?: boolean }; reactions?: ReactionInfo[]; room_id?: string; share_data?: Record<string, any>; user_id?: string }

An object wrapping a Swit resource.

Type declaration

optionalattachments?: Attachments
optionalbody_blockskit?: Record<string, any>
An object representing the content of the post in rich text.
optionalbody_text?: string
The content of the post in plaintext.
optionalchild_cnt?: number
The number of the comments added to the post.
optionalcontents_id?: string
The ID of the post.
optionalcontents_type?: string
The type of the post.
- chat: Message or chat message
- cmt: Comment
- system: System message
optionalcreated?: string
The date and time at which the post was created.
optionalis_bookmark?: boolean
Whether or not the post is bookmarked.
optionalis_delete?: boolean
Whether or not the post has been deleted.
optionalis_pin?: boolean
Whether or not the post is pinned.
optionalmodified?: string
The date and time at which the request was last edited.
optionaloffset?: string
The ID of the entry last returned by the previous call.
optionalparent_id?: string
When the current post is a comment on another post, this parameter indicates the main post's ID.
optionalproperties?: { client_id?: string; is_outcome?: boolean }
The client information.
- optionalclient_id?: string
  The ID of the client.
- optionalis_outcome?: boolean
  Whether the message is an announcement.
optionalreactions?: ReactionInfo[]
Emoji reactions that have been added to the post.
optionalroom_id?: string
The ID of the chat that contains the post.
optionalshare_data?: Record<string, any>
5_274_bfd'
optionaluser_id?: string
The ID of the user who created the post.

CreateApprovalParam

CreateApprovalParam: { approval_category_id?: string; approvers?: Approvers[]; body_type?: CreateApprovalParam.body_type; contents: string; html_content?: string; is_public?: number; referrer_teams?: string[]; referrers?: string[]; submit_on_create?: boolean; title: string }

Type declaration

optionalapproval_category_id?: string
The ID of the template used.
optionalapprovers?: Approvers[]
Approvers for each level.
optionalbody_type?: CreateApprovalParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
contents: string
The content of the request. If body_type=json_string is passed, it must be a string converted from a JSON object representing a rich-formatted text (We’ll add guidelines on how to construct a rich-text object soon).
optionalhtml_content?: string
HTML content that will be attached to the request. Note that only the inline style attribute is allowed for each individual element and the <style> tag is not supported here.
optionalis_public?: number
To whom this request is to be circulated after approved.
- 0: None
- 1: The submitter's teams
- 2: The approvers' teams
- 3: Both the submitter's & approvers' teams
optionalreferrer_teams?: string[]
The IDs of the recipient teams.
optionalreferrers?: string[]
The user IDs who're CC'd to the request.
optionalsubmit_on_create?: boolean
Determines whether to submit the approval request. If true, submit the request; if false, save as a draft.
title: string
The title of the request.

CreateApprovalResponse

CreateApprovalResponse: { action_user_id?: string; approval_category_id?: string; approval_category_name?: string; approval_cont_id?: string; approval_id?: string; approval_status?: number; approval_url?: string; approve_condition?: number; asset_data?: Asset[]; body_blockskit?: string; body_text?: string; cmp_id?: string; completed_step?: number; created?: string; doc_id?: string; html_content?: string; is_bookmarked?: number; is_html_editable?: number; is_public?: number; modified?: string; referrer_teams?: string[]; referrers?: Referrer[]; req_user_id?: string; requested?: string; step_approvers?: StepListOfApprovers[]; step_count?: number; substitute?: Substitute[]; title?: string }

An object wrapping a Swit resource.

Type declaration

optionalaction_user_id?: string
The approver who approved or rejected the request.
optionalapproval_category_id?: string
The ID of the template used.
optionalapproval_category_name?: string
The name of the template used.
optionalapproval_cont_id?: string
The ID of the content of a request.
optionalapproval_id?: string
The ID of the request.
optionalapproval_status?: number
Status of the request.
- 0: Drafted
- 1: Waiting for approval
- 2: Approved
- 3: Declined
optionalapproval_url?: string
URL of the request.
optionalapprove_condition?: number
The condition for the request to be processed to the next level.
- 0: Any approver can approve
- 1: Every approver must approve
optionalasset_data?: Asset[]
List of data attachments to the request.
optionalbody_blockskit?: string
An object representing the content of the post in rich text.
optionalbody_text?: string
The content of the post in plaintext.
optionalcmp_id?: string
The ID of the organization.
optionalcompleted_step?: number
The highest level of approval that has been processed so far.
optionalcreated?: string
The date and time at which the request was created.
optionaldoc_id?: string
Request ID displayed to users. It's used for display purposes while approval_id is for programming use.
optionalhtml_content?: string
HTML content attached to the request.
optionalis_bookmarked?: number
Whether or not the request is bookmarked by the user.
optionalis_html_editable?: number
5_278_bfg'
optionalis_public?: number
To whom this request is to be circulated after approved.
- 0: None
- 1: The submitter's teams
- 2: The approvers' teams
- 3: Both the submitter's & approvers' teams
optionalmodified?: string
The date and time at which the request was last edited.
optionalreferrer_teams?: string[]
The IDs of the recipient teams.
optionalreferrers?: Referrer[]
Users who're CC'd to the request.
optionalreq_user_id?: string
The ID of the user who created the request.
optionalrequested?: string
The date and time at which the request was submitted.
optionalstep_approvers?: StepListOfApprovers[]
Approvers for each level.
optionalstep_count?: number
The total number of approval levels.
optionalsubstitute?: Substitute[]
Proxy approval status.
optionaltitle?: string
The title of the request.

CreateContentsParam

CreateContentsParam: { assets?: string[]; body?: string; body_type?: CreateContentsParam.body_type; parent_id?: string; room_id: string }

Type declaration

optionalassets?: string[]
The ID of the attachment to include in the post.
optionalbody?: string
The content of the post. If body_type=json_string is passed, it must be a string converted from a JSON object representing a rich-formatted text (We'll add guidelines on how to construct a rich-text object soon).
optionalbody_type?: CreateContentsParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
optionalparent_id?: string
Pass the main post's ID if you're to add a comment to a main post.
room_id: string
The ID of the chat where to create the post.

CreateContentsResponse

CreateContentsResponse: { contents?: Contents }

An object wrapping a Swit resource.

Type declaration

optionalcontents?: Contents

CreateIdeaCommentParam

CreateIdeaCommentParam: { assets?: ExternalAssetInfo; body_type?: CreateIdeaCommentParam.body_type; content: string; external_asset_type?: CreateIdeaCommentParam.external_asset_type; idea_id: string }

Type declaration

optionalassets?: ExternalAssetInfo
File attachments to the idea comment.
optionalbody_type?: CreateIdeaCommentParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
content: string
The content of the comment.
optionalexternal_asset_type?: CreateIdeaCommentParam.external_asset_type
The storage type of the attached file.
- google_drive: Google Drive files.
- gcp_storage: All other types of files.
idea_id: string
The ID of the idea to comment on.

CreateIdeaCommentResponse

CreateIdeaCommentResponse: { comment?: Comment }

An object wrapping a Swit resource.

Type declaration

optionalcomment?: Comment

CreateIdeaParam

CreateIdeaParam: { assets?: ExternalAssetInfo; body_type?: CreateIdeaParam.body_type; channel_id: string; content: string; external_asset_type?: CreateIdeaParam.external_asset_type }

Type declaration

optionalassets?: ExternalAssetInfo
File attachments to the idea.
optionalbody_type?: CreateIdeaParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
channel_id: string
The ID of the channel where to create the idea.
content: string
The content of the idea.
optionalexternal_asset_type?: CreateIdeaParam.external_asset_type
The storage type of the attached file.
- google_drive: Google Drive files.
- gcp_storage: All other types of files.

CreateIdeaResponse

CreateIdeaResponse: { idea?: Idea }

An object wrapping a Swit resource.

Type declaration

optionalidea?: Idea

CreateMessageCommentParam

CreateMessageCommentParam: { assets?: ExternalAssetInfo; body_type?: CreateMessageCommentParam.body_type; content: string; external_asset_type?: CreateMessageCommentParam.external_asset_type; message_id: string }

Type declaration

optionalassets?: ExternalAssetInfo
File attachments to the message comment.
optionalbody_type?: CreateMessageCommentParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
content: string
The content of the comment.
optionalexternal_asset_type?: CreateMessageCommentParam.external_asset_type
The storage type of the attached file.
- google_drive: Google Drive files.
- gcp_storage: All other types of files.
message_id: string
The ID of the message to comment on.

CreateMessageCommentResponse

CreateMessageCommentResponse: { comment?: Comment }

An object wrapping a Swit resource.

Type declaration

optionalcomment?: Comment

CreateMessageFromMailResponse

CreateMessageFromMailResponse: { message?: { channel_id?: string; created?: string; message_id?: string } }

An object wrapping a Swit resource.

Type declaration

optionalmessage?: { channel_id?: string; created?: string; message_id?: string }
The properties of a message.
- optionalchannel_id?: string
  The ID of the channel the email was shared.
- optionalcreated?: string
  The date and time at which the email was shared.
- optionalmessage_id?: string
  The ID of the message.

CreateMessageParam

CreateMessageParam: { assets?: ExternalAssetInfo[]; attachments?: Attachments; body_type?: CreateMessageParam.body_type; channel_id: string; content: string; external_asset_type?: CreateMessageParam.external_asset_type }

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the message.
optionalattachments?: Attachments
optionalbody_type?: CreateMessageParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
channel_id: string
The ID of the channel where to create the message.
content: string
The content of the message.
optionalexternal_asset_type?: CreateMessageParam.external_asset_type
The storage type of the attached file.
- google_drive: Google Drive files.
- gcp_storage: All other types of files.

CreateMessageResponse

CreateMessageResponse: { message?: Message }

An object wrapping a Swit resource.

Type declaration

optionalmessage?: Message

CreateRoomParam

CreateRoomParam: { invite_users: string[] }

Type declaration

invite_users: string[]
The members to invite to the chat.

CreateRoomResponse

CreateRoomResponse: { room?: Room }

An object wrapping a Swit resource.

Type declaration

optionalroom?: Room

CustomField

CustomField: { cmp_id?: string; created?: string; custom_field_id?: string; custom_field_options?: CustomFieldOption[]; description?: string; edit_role?: CustomField.edit_role; enabled?: boolean; field_domain?: any; field_name?: string; field_type?: CustomField.field_type; modified?: string }

The properties of a custom field.

Type declaration

optionalcmp_id?: string
The ID of the organization.
optionalcreated?: string
The date and time at which the custom field was created.
optionalcustom_field_id?: string
The ID of the custom field.
optionalcustom_field_options?: CustomFieldOption[]
Array of selections if the field type is dropdown (field_type=OPTION).
optionaldescription?: string
The placeholder for the custom field if the field type is text (field_type=STRING) or URL (field_type=URL).
optionaledit_role?: CustomField.edit_role
Who can update the field's value:
- ADMIN: The organization's admins can update the field's value for each member.
- MEMBER: Each member can update the field's value for their own profile.
optionalenabled?: boolean
Whether the field is set to be displayed on user profiles.
optionalfield_domain?: any
The type of custom fields used.
optionalfield_name?: string
The name of the custom field.
optionalfield_type?: CustomField.field_type
The type of the custom field: STRING, URL, or OPTION (dropdown).
optionalmodified?: string
The date and time at which the custom field was last updated.

CustomFieldIds

CustomFieldIds: { custom_field_id?: string; custom_field_user_data_id?: string }

Type declaration

optionalcustom_field_id?: string
The ID of the custom field.
optionalcustom_field_user_data_id?: string
The ID of the user updated with the selected custom field.

CustomFieldOption

CustomFieldOption: { created?: string; custom_field_id?: string; custom_field_option_id?: string; modified?: string; option_name?: string }

Type declaration

optionalcreated?: string
The date and time at which the dropdown selection was created.
optionalcustom_field_id?: string
The ID of the dropdown field that contains this selection.
optionalcustom_field_option_id?: string
The ID of the dropdown selection.
optionalmodified?: string
The date and time at which the dropdown selection was created.
optionaloption_name?: string
The name of the dropdown selection.

CustomFieldOptionElement

CustomFieldOptionElement: { option_name: CustomFieldOptionElement.option_name }

Type declaration

option_name: CustomFieldOptionElement.option_name
The name of the dropdown selection.

CustomFieldUserData

CustomFieldUserData: { created?: string; custom_field_id?: string; custom_field_user_data_id?: string; data_value?: string; enabled?: boolean; modified?: string; user_id?: string }

An object wrapping a Swit resource.

Type declaration

optionalcreated?: string
The date and time at which the custom field's value was initially assigned for the user.
optionalcustom_field_id?: string
The ID of the custom field.
optionalcustom_field_user_data_id?: string
The ID of the custom field data assigned for the user. Once created, it will remain unchanged even if the value is updated later.
optionaldata_value?: string
The custom field value assigned for the user.
optionalenabled?: boolean
Whether the custom field is used for this user.
optionalmodified?: string
The date and time at which the custom field value was last updated.
optionaluser_id?: string
The ID of the user.

CustomFieldUserDataElement

CustomFieldUserDataElement: { custom_field_id: string; data_value?: string; enabled?: boolean }

Type declaration

custom_field_id: string
The ID of the target custom field.
optionaldata_value?: string
The value of the custom field to assign for the user.
optionalenabled?: boolean
Whether to user the custom field for the user.

DelChannelUserParam

DelChannelUserParam: { ch_id: string; user_ids: string[] }

Type declaration

ch_id: string
The ID of the channel to remove the users from.
user_ids: string[]
The IDs of the users to remove.

DelCompanyUserResponse

DelCompanyUserResponse: Record<string, any>

An object wrapping a Swit resource.

DelIdeaCommentParam

DelIdeaCommentParam: { id: string }

Type declaration

id: string
The ID of the comment.

DelIdeaParam

DelIdeaParam: { id: string }

Type declaration

id: string
The ID of the idea.

DelIdeaReactionParam

DelIdeaReactionParam: { idea_id: string; reaction_name: string }

Type declaration

idea_id: string
The ID of the idea to remove the reaction emoji from.
reaction_name: string
The alias of the reaction emoji surrounded by a preceding and a trailing ':' symbol. Get the whole list of available emojis and their aliases from https://github.com/github/gemoji/blob/master/db/emoji.json.

DelMessageReactionParam

DelMessageReactionParam: { message_id: string; reaction_name: string }

Type declaration

message_id: string
The ID of the message to remove the reaction emoji from.
reaction_name: string
The alias of the reaction emoji surrounded by a preceding and a trailing ':' symbol. Get the whole list of available emojis and their aliases from https://github.com/github/gemoji/blob/master/db/emoji.json.

DelTaskAssigneeParam

DelTaskAssigneeParam: { task_id: string; user_id: string }

Type declaration

task_id: string
The ID of the task.
user_id: string
The ID of the member.

DelTaskCheckListParam

DelTaskCheckListParam: { id: string }

Type declaration

id: string
The ID of the checklist.

DelTaskCommentParam

DelTaskCommentParam: { assets?: ExternalAssetInfo[]; id?: string }

An object wrapping a Swit resource.

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the task.
optionalid?: string
The ID of the comment.

DelTaskFollowParam

DelTaskFollowParam: { task_id: string; user_id: string }

Type declaration

task_id: string
The ID of the task.
user_id: string
The user ID of the collaborator.

DelTaskParam

DelTaskParam: { id: string }

Type declaration

id: string
The ID of the task.

DeleteContentsParam

DeleteContentsParam: { contents_id: string; room_id: string }

Type declaration

contents_id: string
The ID of the post to delete.
room_id: string
The ID of the chat that contains the post.

DeleteContentsResponse

DeleteContentsResponse: { contents_id?: string }

An object wrapping a Swit resource.

Type declaration

optionalcontents_id?: string
The ID of the post.

DeleteCustomFieldParam

DeleteCustomFieldParam: { custom_field_id: string }

Type declaration

custom_field_id: string
The ID of the custom field to delete.

DeleteCustomFieldResponse

DeleteCustomFieldResponse: { custom_field_id?: string }

An object wrapping a Swit resource.

Type declaration

optionalcustom_field_id?: string
The ID of the deleted custom field.

DeleteMessageCommentParam

DeleteMessageCommentParam: { id: string }

Type declaration

id: string
The ID of the comment.

DeleteMessageParam

DeleteMessageParam: { id: string }

Type declaration

id: string
The ID of the message.

Emoji

Emoji: { created?: string; emoji_id?: string; name?: string; path?: string; user_id?: string; ws_id?: string }

The properties of a custom emoji.

Type declaration

optionalcreated?: string
The date and time at which the custom emoji was created.
optionalemoji_id?: string
The ID of the custom emoji.
optionalname?: string
The name of the custom emoji.
optionalpath?: string
The image path of the custom emoji. This path is relative to https://files.swit.io.
optionaluser_id?: string
The ID of the user who created the custom emoji.
optionalws_id?: string
The ID of The workspace where the custom emoji was created.

ExternalAssetInfo

ExternalAssetInfo: { file_desc?: string; file_mime?: string; file_name?: string; file_path?: string; file_size?: number; thumbnail?: string }

Type declaration

optionalfile_desc?: string
The description of the file.
optionalfile_mime?: string
The MIME type of the file.
optionalfile_name?: string
The name of the file.
optionalfile_path?: string
The URL path of the file.
optionalfile_size?: number
The size of the file in bytes.
optionalthumbnail?: string
The Thumbnail URL of the file.

GetApprovalCategoryInfoResponse

GetApprovalCategoryInfoResponse: { approval_category_id?: string; approval_category_name?: string; body_type?: GetApprovalCategoryInfoResponse.body_type; cmp_id?: string; contents?: string; created?: string; is_public?: number; referrer_teams?: string[]; referrers?: string[]; req_user_id?: string; step_approvers?: Approvers[]; title?: string }

An object wrapping a Swit resource.

Type declaration

optionalapproval_category_id?: string
The ID of the template.
optionalapproval_category_name?: string
The name of the template.
optionalbody_type?: GetApprovalCategoryInfoResponse.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
optionalcmp_id?: string
The ID of the organization.
optionalcontents?: string
Content of the request. If body_type=json_string is passed, it must be a string converted from a JSON object representing a rich-formatted text (We’ll add guidelines on how to construct a rich-text object soon).
optionalcreated?: string
The date and time at which the template was created.
optionalis_public?: number
To whom this request is to be circulated after approved.
- 0: None
- 1: The submitter's teams
- 2: The approvers' teams
- 3: Both the submitter's & approvers' teams
optionalreferrer_teams?: string[]
The IDs of the recipient teams.
optionalreferrers?: string[]
The user IDs who're CC'd to the request.
optionalreq_user_id?: string
The ID of the user who created the request.
optionalstep_approvers?: Approvers[]
Approvers for each level.
optionaltitle?: string
The title of the request.

GetApprovalCategoryListResponse

GetApprovalCategoryListResponse: { approval_category_id?: string; approval_category_name?: string; cmp_id?: string; created?: string; req_user_id?: string }

Type declaration

optionalapproval_category_id?: string
The ID of the template used.
optionalapproval_category_name?: string
The name of the template used.
optionalcmp_id?: string
The ID of the organization.
optionalcreated?: string
The date and time at which the request was created.
optionalreq_user_id?: string
The ID of the user who created the request.

GetApprovalListResponse

GetApprovalListResponse: { approval_category_id?: string; approval_category_name?: string; approval_id?: string; approval_status?: number; comment_count?: number; created?: string; doc_id?: string; is_bookmarked?: number; is_public?: number; req_user_id?: string; requested?: string; step_approvers?: StepListOfApprovers[]; title?: string }

Type declaration

optionalapproval_category_id?: string
The ID of the template used.
optionalapproval_category_name?: string
The name of the template used.
optionalapproval_id?: string
The ID of the request.
optionalapproval_status?: number
Status of the request.
- 0: Drafted
- 1: Waiting for approval
- 2: Approved
- 3: Declined
optionalcomment_count?: number
The number of comments added.
optionalcreated?: string
The date and time at which the request was created.
optionaldoc_id?: string
Request ID displayed to users. It's used for display purposes while approval_id is for programming use.
optionalis_bookmarked?: number
Whether or not the request is bookmarked by the user.
optionalis_public?: number
To whom this request is to be circulated after approved.
- 0: None
- 1: The submitter's teams
- 2: The approvers' teams
- 3: Both the submitter's & approvers' teams
optionalreq_user_id?: string
The ID of the user who created the request.
optionalrequested?: string
The date and time at which the request was submitted.
optionalstep_approvers?: StepListOfApprovers[]
Approvers for each level.
optionaltitle?: string
The title of the request.

GetChannelListResponse

GetChannelListResponse: { channels?: ChannelResponse[]; offset?: string }

An object wrapping a Swit resource.

Type declaration

optionalchannels?: ChannelResponse[]
Details of each channel retrieved.
optionaloffset?: string
Offset string that indicates the last entry returned.

GetChannelResponse

GetChannelResponse: { channel?: ChannelResponse }

An object wrapping a Swit resource.

Type declaration

optionalchannel?: ChannelResponse

GetChannelUserListResponse

GetChannelUserListResponse: { offset?: string; users?: ChannelUserResponse[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionalusers?: ChannelUserResponse[]
The information of users retrieved.

GetContentsListResponse

GetContentsListResponse: { contents?: Contents[]; offset?: string }

An object wrapping a Swit resource.

Type declaration

optionalcontents?: Contents[]
Details of each post retrieved.
optionaloffset?: string
Offset string that indicates the last entry returned.

GetContentsResponse

GetContentsResponse: { contents?: Contents }

An object wrapping a Swit resource.

Type declaration

optionalcontents?: Contents

GetCustomFieldListResponse

GetCustomFieldListResponse: { custom_fields?: CustomField[] }

An object wrapping a Swit resource.

Type declaration

optionalcustom_fields?: CustomField[]
Details of each custom field retrieved.

GetIdeaCommentListResponse

GetIdeaCommentListResponse: { comments?: Comment[]; offset?: string }

An object wrapping a Swit resource.

Type declaration

optionalcomments?: Comment[]
Details of each comment retrieved.
optionaloffset?: string
Offset string that indicates the last entry returned.

GetIdeaListResponse

GetIdeaListResponse: { ideas?: Idea[]; offset?: string }

An object wrapping a Swit resource.

Type declaration

optionalideas?: Idea[]
Details of each post retrieved.
optionaloffset?: string
Offset string that indicates the last entry returned.

GetIdeaResponse

GetIdeaResponse: { idea?: Idea }

An object wrapping a Swit resource.

Type declaration

optionalidea?: Idea

GetMessageCommentListResponse

GetMessageCommentListResponse: { comments?: Comment[]; offset?: string }

An object wrapping a Swit resource.

Type declaration

optionalcomments?: Comment[]
Details of each comment retrieved.
optionaloffset?: string
Offset string that indicates the last entry returned.

GetMessageListResponse

GetMessageListResponse: { messages?: Message[]; offset?: string }

An object wrapping a Swit resource.

Type declaration

optionalmessages?: Message[]
Details of each message retrieved.
optionaloffset?: string
Offset string that indicates the last entry returned.

GetOrganizationResponse

GetOrganizationResponse: { color?: string; id?: string; name?: string; photo?: string; subdomain?: string }

An object wrapping a Swit resource.

Type declaration

optionalcolor?: string
The background color of the fallback avatar of the organization.
optionalid?: string
The ID of the organization.
optionalname?: string
The name of the organization.
optionalphoto?: string
The URL path of the organization profile image, relative to https://files.swit.io.
optionalsubdomain?: string
The subdomain associated with the organization.

GetOrganizationUserResponse

GetOrganizationUserResponse: { bg_color?: string; created?: string; email?: string; is_active?: boolean; language?: GetOrganizationUserResponse.language; last_activity?: string; mode?: string; msg?: string; photo?: string; role?: number; status?: GetOrganizationUserResponse.status; team?: TeamUser[]; tel?: string; timezone?: string; timezone_auto_flag?: GetOrganizationUserResponse.timezone_auto_flag; user_id?: string; user_name?: string }

An object wrapping a Swit resource.

Type declaration

optionalbg_color?: string
The background color of the fallback avatar of the user.
optionalcreated?: string
The date and time at which the user's account was created.
optionalemail?: string
The email address of the user.
optionalis_active?: boolean
Whether the user's account is active.
optionallanguage?: GetOrganizationUserResponse.language
The language setting of the user.
optionallast_activity?: string
The date and time of the user's last activity.
optionalmode?: string
The mode of the user.
optionalmsg?: string
The status message of the user.
optionalphoto?: string
The user's profile image link.
optionalrole?: number
The role of the user.
- 10: The master of the organization.
- 20: An admin of the organization.
- 30: A member of the organization.
- 40: A guest.
optionalstatus?: GetOrganizationUserResponse.status
The status of the user.
optionalteam?: TeamUser[]
The teams the user is in.
optionaltel?: string
The telephone number of the user.
optionaltimezone?: string
The timezone of the user.
optionaltimezone_auto_flag?: GetOrganizationUserResponse.timezone_auto_flag
Whether to make the timezone setting automatically based on the user location or follow the user setting. 1 means checked the 'Set automatically based on your location' checkbox, and 2 means the checkbox is not checked.
optionaluser_id?: string
The ID of the user.
optionaluser_name?: string
The name of the user.

GetProjectBucketInfoResponse

GetProjectBucketInfoResponse: { bucket?: BucketResponse }

An object wrapping a Swit resource.

Type declaration

optionalbucket?: BucketResponse

GetProjectBucketListResponse

GetProjectBucketListResponse: { buckets?: BucketResponse[]; offset?: string }

An object wrapping a Swit resource.

Type declaration

optionalbuckets?: BucketResponse[]
Details of each bucket retrieved.
optionaloffset?: string
Offset string that indicates the last entry returned.

GetProjectInfoResponse

GetProjectInfoResponse: { project: ProjectResponse }

An object wrapping a Swit resource.

Type declaration

project: ProjectResponse

GetProjectListResponse

GetProjectListResponse: { offset?: string; projects?: ProjectResponse[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionalprojects?: ProjectResponse[]
Details of each project retrieved.

GetProjectTagListResponse

GetProjectTagListResponse: { offset?: string; projectTags?: ProjectTagResponse[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionalprojectTags?: ProjectTagResponse[]
Details of each tag retrieved.

GetProjectUserListResponse

GetProjectUserListResponse: { offset?: string; users?: ProjectUserResponse[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionalusers?: ProjectUserResponse[]
User information of each member retrieved.

GetRoomListResponse

GetRoomListResponse: { offset?: string; rooms?: Room[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionalrooms?: Room[]
Details of each chat retrieved.

GetRoomResponse

GetRoomResponse: { room?: Room }

An object wrapping a Swit resource.

Type declaration

optionalroom?: Room

GetTaskCheckListListResponse

GetTaskCheckListListResponse: { offset?: string; taskChecklists?: TaskChecklistResponse[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionaltaskChecklists?: TaskChecklistResponse[]
Details of each checklist item retrieved.

GetTaskCheckListResponse

GetTaskCheckListResponse: { taskChecklist?: TaskChecklistResponse }

An object wrapping a Swit resource.

Type declaration

optionaltaskChecklist?: TaskChecklistResponse

GetTaskCommentResponse

GetTaskCommentResponse: { content?: string; taskComments?: TaskCommentResponse[] }

An object wrapping a Swit resource.

Type declaration

optionalcontent?: string
Offset string that indicates the last entry returned.
optionaltaskComments?: TaskCommentResponse[]
Details of each comment retrieved.

GetTaskInfoResponse

GetTaskInfoResponse: { task?: TaskResponse }

An object wrapping a Swit resource.

Type declaration

optionaltask?: TaskResponse

GetTaskListByColumnResponse

GetTaskListByColumnResponse: { offset?: string; tasks?: TaskResponse[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionaltasks?: TaskResponse[]
Details of each task retrieved.

GetTaskListMineResponse

GetTaskListMineResponse: { offset?: string; tasks?: TaskResponse[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionaltasks?: TaskResponse[]
Details of each task retrieved.

GetTaskListProjectResponse

GetTaskListProjectResponse: { offset?: string; tasks?: TaskResponse[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionaltasks?: TaskResponse[]
Details of each task retrieved.

GetUserCustomFieldListResponse

GetUserCustomFieldListResponse: { joined_custom_fields?: JoinedCustomField[] }

An object wrapping a Swit resource.

Type declaration

optionaljoined_custom_fields?: JoinedCustomField[]
Details of each custom field assigned for the user.

GetUserInfoResponse

GetUserInfoResponse: { user?: UserResponse }

An object wrapping a Swit resource.

Type declaration

optionaluser?: UserResponse

GetUserTeamListResponse

GetUserTeamListResponse: { team?: Team[] }

An object wrapping a Swit resource.

Type declaration

optionalteam?: Team[]
The properties of a team.

GetWorkspaceInfoResponse

GetWorkspaceInfoResponse: { workspace?: WorkspaceResponse }

An object wrapping a Swit resource.

Type declaration

optionalworkspace?: WorkspaceResponse

GetWorkspaceListResponse

GetWorkspaceListResponse: { offset?: string; workspaces?: WorkspaceResponse[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionalworkspaces?: WorkspaceResponse[]
Workspaces retrieved.

GetWorkspaceUserListResponse

GetWorkspaceUserListResponse: { offset?: string; user?: WorkspaceUserResponse[] }

An object wrapping a Swit resource.

Type declaration

optionaloffset?: string
Offset string that indicates the last entry returned.
optionaluser?: WorkspaceUserResponse[]
User information of each member retrieved.

Idea

Idea: { assets?: ExternalAssetInfo[]; channel_id?: string; comment_count?: number; content?: string; created?: string; idea_id?: string; user_id?: string; user_name?: string }

The properties of an idea.

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the idea.
optionalchannel_id?: string
The ID of the channel.
optionalcomment_count?: number
The number of comments added.
optionalcontent?: string
The content of the idea.
optionalcreated?: string
The date and time at which the idea was created.
optionalidea_id?: string
The ID of the idea.
optionaluser_id?: string
The ID of the user who created the idea.
optionaluser_name?: string
The display name of the user who created the idea.

InviteRoomParam

InviteRoomParam: { invite_users: string[]; room_id: string }

Type declaration

invite_users: string[]
The IDs of the users to invite.
room_id: string
The ID of the chat.

InviteRoomResponse

InviteRoomResponse: { room?: Room }

An object wrapping a Swit resource.

Type declaration

optionalroom?: Room

JoinedCustomField

JoinedCustomField: { custom_field?: CustomField; custom_field_user_data?: CustomFieldUserData }

Type declaration

optionalcustom_field?: CustomField
optionalcustom_field_user_data?: CustomFieldUserData

LeaveRoomParam

LeaveRoomParam: { room_id: string }

Type declaration

room_id: string
The ID of the chat.

LeaveRoomResponse

LeaveRoomResponse: { room_id?: string }

An object wrapping a Swit resource.

Type declaration

optionalroom_id?: string
The ID of the chat.

Message

Message: { assets?: ExternalAssetInfo[]; attachments?: Attachments; channel_id?: string; comment_count?: number; content?: string; created?: string; message_id?: string; user_id?: string; user_name?: string }

The properties of a message.

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the message.
optionalattachments?: Attachments
optionalchannel_id?: string
The ID of the channel.
optionalcomment_count?: number
The number of comments added.
optionalcontent?: string
The content of the message.
optionalcreated?: string
The date and time at which the message was created.
optionalmessage_id?: string
The ID of the message.
optionaluser_id?: string
The ID of the user who created the message.
optionaluser_name?: string
The display name of the user who created the message.

MoveTaskParam

MoveTaskParam: { assign?: boolean; follow?: boolean; id: string; target_bucket_id?: string; target_project_id: string }

Type declaration

optionalassign?: boolean
Whether to include the assignee.
optionalfollow?: boolean
Whether to include the collaborators.
id: string
The ID of the task to move.
optionaltarget_bucket_id?: string
The ID of the destination bucket.
target_project_id: string
The ID of the destination project.

MoveTaskResponse

MoveTaskResponse: { task?: TaskResponse }

An object wrapping a Swit resource.

Type declaration

optionaltask?: TaskResponse

OpenAPIConfig

OpenAPIConfig: { BASE: string; CREDENTIALS: include | omit | same-origin; ENCODE_PATH?: (path: string) => string; HEADERS?: Headers | Resolver<Headers>; PASSWORD?: string | Resolver<string>; TOKEN?: string | Resolver<string>; USERNAME?: string | Resolver<string>; VERSION: string; WITH_CREDENTIALS: boolean }

Type declaration

BASE: string
CREDENTIALS: include | omit | same-origin
optionalENCODE_PATH?: (path: string) => string
- - (path: string): string
  - Parameters
    - path: string
    Returns string
optionalHEADERS?: Headers | Resolver<Headers>
optionalPASSWORD?: string | Resolver<string>
optionalTOKEN?: string | Resolver<string>
optionalUSERNAME?: string | Resolver<string>
VERSION: string
WITH_CREDENTIALS: boolean

ProjectResponse

ProjectResponse: { created?: string; description?: string; host_id?: string; id?: string; is_archived?: boolean; is_member?: boolean; is_private?: boolean; is_starred?: boolean; name?: string }

An object wrapping a Swit resource.

Type declaration

optionalcreated?: string
The date and time at which the project was created.
optionaldescription?: string
Description on the purpose of the project.
optionalhost_id?: string
The user ID of the host of the project.
optionalid?: string
The ID of the project.
optionalis_archived?: boolean
Whether the project is archived.
optionalis_member?: boolean
Whether the user joined the project.
optionalis_private?: boolean
Whether the project is private.
optionalis_starred?: boolean
Whether the project is starred by the user.
optionalname?: string
The name of the project.

ProjectTagResponse

ProjectTagResponse: { created?: string; tag_data?: string; tag_id?: string }

Type declaration

optionalcreated?: string
The date and time at which the tag was created.
optionaltag_data?: string
The content of the tag.
optionaltag_id?: string
The ID of the tag.

ProjectUserResponse

ProjectUserResponse: { id?: string; name?: string }

Type declaration

optionalid?: string
The user ID of the member.
optionalname?: string
The display name of the member.

PutChannelParam

PutChannelParam: { description?: string; id: string; is_prev_chat_visible?: boolean; name?: string; update_fields?: string[] }

Type declaration

optionaldescription?: string
The description or purpose of the channel.
id: string
The ID of the channel.
optionalis_prev_chat_visible?: boolean
Whether to disclose previous messages to new members.
optionalname?: string
The name of the channel.
optionalupdate_fields?: string[]
The fields to update. If this parameter is omitted or assigned an empty value, all fields will be updated. Fields without provided values will be set to empty or default values.

PutChannelResponse

PutChannelResponse: { channel?: ChannelResponse }

An object wrapping a Swit resource.

Type declaration

optionalchannel?: ChannelResponse

PutProjectBucketParam

PutProjectBucketParam: { id: string; name: string }

Type declaration

id: string
The ID of the bucket to update.
name: string
New title for the bucket.

PutProjectBucketResponse

PutProjectBucketResponse: { bucket?: BucketResponse }

An object wrapping a Swit resource.

Type declaration

optionalbucket?: BucketResponse

PutProjectParam

PutProjectParam: { description?: string; id: string; name?: string; update_fields?: string[] }

Type declaration

optionaldescription?: string
Description on the purpose of the project.
id: string
The ID of the project.
optionalname?: string
The name of the project.
optionalupdate_fields?: string[]
The fields to update. If this parameter is omitted or assigned an empty value, all fields will be updated. Fields without provided values will be set to empty or default values.

PutProjectResponse

PutProjectResponse: { project: ProjectResponse }

An object wrapping a Swit resource.

Type declaration

project: ProjectResponse

PutTaskCheckListParam

PutTaskCheckListParam: { content?: string; id: string; is_complete?: boolean; update_fields?: string[] }

Type declaration

optionalcontent?: string
The content of the checklist item.
id: string
The ID of the checklist item.
optionalis_complete?: boolean
Whether the checklist item is complete.
optionalupdate_fields?: string[]
The fields to update. If this parameter is omitted or assigned an empty value, all fields will be updated. Fields without provided values will be set to empty or default values.

PutTaskCheckListResponse

PutTaskCheckListResponse: { taskChecklist?: TaskChecklistResponse }

An object wrapping a Swit resource.

Type declaration

optionaltaskChecklist?: TaskChecklistResponse

PutTaskCommentParam

PutTaskCommentParam: { assets?: ExternalAssetInfo[]; body_type?: PutTaskCommentParam.body_type; content: string; external_asset_type?: PutTaskCommentParam.external_asset_type; id: string }

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the task.
optionalbody_type?: PutTaskCommentParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
content: string
The content of the comment.
optionalexternal_asset_type?: PutTaskCommentParam.external_asset_type
The storage type of the attached file.
- google_drive: Google Drive files.
- gcp_storage: All other types of files.
id: string
The ID of the comment to edit.

PutTaskCommentResponse

PutTaskCommentResponse: { taskComment?: TaskCommentResponse }

An object wrapping a Swit resource.

Type declaration

optionaltaskComment?: TaskCommentResponse

PutTaskParam

PutTaskParam: { assets?: ExternalAssetInfo[]; assign?: string; body_type?: PutTaskParam.body_type; bucket_id?: string; color?: PutTaskParam.color; content?: string; end_date?: string; external_asset_type?: PutTaskParam.external_asset_type; follow?: string; id: string; priority?: string; start_date?: string; step?: string; tag?: string; title?: string }

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the task.
optionalreadonlyassign?: string
The user ID of the member to whom to assign the task.
optionalbody_type?: PutTaskParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
optionalbucket_id?: string
The ID of the bucket the task is in.
optionalcolor?: PutTaskParam.color
Color assigned to the task.
optionalcontent?: string
The content of the task.
optionalend_date?: string
Date by which the task will end. Use the YYYY-MM-DD format.
optionalexternal_asset_type?: PutTaskParam.external_asset_type
The storage type of the attached file.
- google_drive: Google Drive files.
- gcp_storage: All other types of files.
optionalreadonlyfollow?: string
The ID of the collabolators.
id: string
The ID of the task.
optionalpriority?: string
Priority to set for the task.
optionalstart_date?: string
Date on which the task starts. Use the YYYY-MM-DD format.
optionalstep?: string
Status of the task:
- ToDo: Set the task's status to "To Do".
- Doing: Set the task's status to "Doing".
- Done: Set the task's status to "Done".
optionalreadonlytag?: string
The tag of the task.
optionaltitle?: string
The title of the task.

PutTaskResponse

PutTaskResponse: { task?: TaskResponse }

An object wrapping a Swit resource.

Type declaration

optionaltask?: TaskResponse

PutWorkspaceParam

PutWorkspaceParam: { id: string; name: string }

Type declaration

id: string
The ID of the workspace to update.
name: string
The name of the workspace.

PutWorkspaceResponse

PutWorkspaceResponse: { workspace?: WorkspaceResponse }

An object wrapping a Swit resource.

Type declaration

optionalworkspace?: WorkspaceResponse

ReactionInfo

ReactionInfo: { count?: number; users?: string[]; value?: string }

Type declaration

optionalcount?: number
The number of reactions using the emoji.
optionalusers?: string[]
The people who reacted using the emoji.
optionalvalue?: string
The name of the emoji.

Referrer

Referrer: { referrer_user_id?: string; register_type?: number }

Type declaration

optionalreferrer_user_id?: string
The user ID CC'd to the request.
optionalregister_type?: number
How the user was CC'd.
- 0: Automatically added as a CC recipient because somebody else is acting as a proxy approver for this user.
- 1: The submitter added this user as a CC recipient.

Room

Room: { contents?: Contents; created?: string; direct_user_id?: string; is_hidden?: boolean; is_starred?: boolean; last_read?: string; member_count?: number; members?: string[]; push_type?: string; room_id?: string; room_name?: string; room_type?: string; status?: string; unread_count?: number }

The properties of a chat.

Type declaration

optionalcontents?: Contents
optionalcreated?: string
The date and time at which the chat was created.
optionaldirect_user_id?: string
ID of the other user in the 1:1 chat. Only used when the response contains room_type=direct message.
optionalis_hidden?: boolean
Whether or not the chat is hidden by the user.
optionalis_starred?: boolean
Whether or not the post is starred.
optionallast_read?: string
The date and time at which the user last read the content in the chat.
optionalmember_count?: number
The number of the members of the chat.
optionalmembers?: string[]
The IDs of the users who are in the chat.
optionalpush_type?: string
The push notification preference set for this chat.
- everything: Receive push notifications for all relevant events.
- mentions: Receive push notifications for mentions relevant to the user.
- nothing: Do not receive push notifications.
optionalroom_id?: string
The ID of the chat.
optionalroom_name?: string
The name of the chat visible to the user.
optionalroom_type?: string
The type of the chat.
- group message: Group chat
- direct message: 1:1 chat
optionalstatus?: string
Whether or not the chat is active.
optionalunread_count?: number
The number of the messages the user has not read.

StatusCustom

StatusCustom: { color_label?: string; status_attribute?: string; status_id?: string; status_name?: string }

A custom status.

Type declaration

optionalcolor_label?: string
The color label associated with the status.
optionalstatus_attribute?: string
The attribute associated with the status:
- NOT_STARTED: The task is in the Backlog.
- DONE: The task is in the "Done" status.
- IN_PROGRESS: The task is in any other status.
optionalstatus_id?: string
The ID of the status.
optionalstatus_name?: string
The name of the status.

StepListOfApprovers

StepListOfApprovers: { approvers?: Approver[]; step?: number; step_condition?: number; step_status?: number }

Type declaration

optionalapprovers?: Approver[]
List of approvers at this level.
optionalstep?: number
The level of approval.
optionalstep_condition?: number
- 0: Any approver can approver to pass the current approval level.
- 1: Every approver must approve to pass the current approval level.
optionalstep_status?: number
Approval status at this level.
- 1: Waiting for approval
- 2: Approved
- 3: Declined

Substitute

Substitute: { substitute_user_id?: string; target_user_id?: string }

Type declaration

optionalsubstitute_user_id?: string
The ID of the user who're designated as the proxy approver.
optionaltarget_user_id?: string
The ID of the user who designated the proxy approver.

TaskChecklistResponse

TaskChecklistResponse: { content?: string; created?: string; id?: string; is_complete?: boolean; task_id?: string; user_id?: string }

An object wrapping a Swit resource.

Type declaration

optionalcontent?: string
The content of the checklist item.
optionalcreated?: string
The date and time at which the checklist item was created.
optionalid?: string
The ID of the checklist item.
optionalis_complete?: boolean
Whether the checklist item is complete.
optionaltask_id?: string
The ID of the task.
optionaluser_id?: string
The ID of the user who added the checklist item.

TaskCommentResponse

TaskCommentResponse: { assets?: ExternalAssetInfo[]; content?: string; created?: string; id?: string; rich_text?: boolean; task_id?: string; user_id?: string; user_name?: string }

An object wrapping a Swit resource.

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the task.
optionalcontent?: string
The content of the comment.
optionalcreated?: string
The date and time at which the comment was posted.
optionalid?: string
The ID of the comment.
optionalrich_text?: boolean
Whether or not allows the user to customize the way text looks.
optionaltask_id?: string
The ID of the task.
optionaluser_id?: string
The ID of the user who posted the comment.
optionaluser_name?: string
The display name of the user who posted the comment.

TaskResponse

TaskResponse: { assets?: ExternalAssetInfo[]; assign?: string; assignees?: string[]; bucket_id?: string; color?: TaskResponse.color; comment_count?: number; content?: string; end_date?: string; follow?: string[]; id?: string; isTime?: boolean; parent_id?: string; priority?: string; project_id?: string; rich_text?: boolean; start_date?: string; status?: string; status_custom?: StatusCustom; subtask_count?: string; title?: string; user_id?: string }

An object wrapping a Swit resource.

Type declaration

optionalassets?: ExternalAssetInfo[]
File attachments to the task.
optionalassign?: string
Deprecated. Use assignees instead.

The user ID of the assignee of the task. If not assigned, it returns unassign.
optionalassignees?: string[]
The user IDs of the assignees of the task.
optionalbucket_id?: string
The ID of the bucket under which the task is placed.
optionalcolor?: TaskResponse.color
The color assigned to the task.
optionalcomment_count?: number
The number of comments added.
optionalcontent?: string
The content of the task.
optionalend_date?: string
Date scheduled to finish the task.
optionalfollow?: string[]
The user IDs of the collaborators on the task.
optionalid?: string
The ID of the task.
optionalisTime?: boolean
Whether the start or due time, including the specific time of day, is set for the task.
optionalparent_id?: string
The ID of the parent task.
optionalpriority?: string
Priority set for the task.
optionalproject_id?: string
The ID of the project that contains the task.
optionalrich_text?: boolean
Whether or not allows the user to customize the way text looks.
optionalstart_date?: string
Date scheduled to start the task.
optionalstatus?: string
Deprecated. Use status_custom instead.

Current status of the task:
- ToDo: The task is in the "To Do" status.
- Doing: The task is in the "Doing" status.
- Done: The task is in the "Done" status.
- null: The task is in the "Backlog" status.
optionalstatus_custom?: StatusCustom
optionalsubtask_count?: string
The number of subtasks the given task has.
optionaltitle?: string
The title of the task.
optionaluser_id?: string
The ID of the user who created the task.

Team

Team: { depth?: number; member_cnt?: number; parent_id?: string; reference?: string; team_id?: string; team_name?: string; users?: string[] }

Type declaration

optionaldepth?: number
The depth of the team.
optionalmember_cnt?: number
The count of members.
optionalparent_id?: string
The ID of the parent team.
optionalreference?: string
Custom text to be used as a reference. This is useful to store information from another source.
optionalteam_id?: string
The ID of the team.
optionalteam_name?: string
The name of the team.
optionalusers?: string[]
The list of members in the team.

TeamCreateResponse

TeamCreateResponse: { depth?: number; id?: string; name?: string; parent_id?: string; reference?: string }

An object wrapping a Swit resource.

Type declaration

optionaldepth?: number
The depth of the team.
optionalid?: string
The ID of the team.
optionalname?: string
The name of the team.
optionalparent_id?: string
The ID of the parent team.
optionalreference?: string
Custom text to be used as a reference. This is useful to store information from another source.

TeamDeleteResponse

TeamDeleteResponse: { data?: any }

Type declaration

optionaldata?: any
Upon successful deletion of the team, the data field will be null, indicating that the operation completed successfully without any specific data to return.

TeamSortParam

TeamSortParam: { parent_id?: string; team_ids?: string[] }

Type declaration

optionalparent_id?: string
The ID of the parent team.
optionalteam_ids?: string[]
The IDs of the teams. A list of all subteams belonging to the parent team, in order listed.

TeamUpdateResponse

TeamUpdateResponse: { depth?: number; id?: string; name?: string; parent_id?: string; reference?: string }

An object wrapping a Swit resource.

Type declaration

optionaldepth?: number
The depth of the team.
optionalid?: string
The ID of the team.
optionalname?: string
The name of the team.
optionalparent_id?: string
The ID of the parent team.
optionalreference?: string
Custom text to be used as a reference. This is useful to store information from another source.

TeamUser

TeamUser: { created?: string; main_dept_yn?: TeamUser.main_dept_yn; team_id?: string; team_name?: string }

Type declaration

optionalcreated?: string
The date and time the team was created.
optionalmain_dept_yn?: TeamUser.main_dept_yn
Whether the team is the user's primary team or not.
optionalteam_id?: string
The ID of the team.
optionalteam_name?: string
The name of the team.

TeamUserCreateResponse

TeamUserCreateResponse: { data?: any }

An object wrapping a Swit resource.

Type declaration

optionaldata?: any
Upon successful addition of any of the users passed, the data field will be null, indicating that the operation completed successfully without any specific data to return.

TeamUserDeleteResponse

TeamUserDeleteResponse: { data?: any }

An object wrapping a Swit resource.

Type declaration

optionaldata?: any
Upon successful deletion of any of the users passed, the data field will be null, , indicating that the operation completed successfully without any specific data to return.

UpdateChannelArchiveParam

UpdateChannelArchiveParam: { archive?: boolean; id: string }

Type declaration

optionalarchive?: boolean
Whether to archive (true) or unarchive (false) the channel.
id: string
The ID of the channel to archive or unarchive.

UpdateContentsParam

UpdateContentsParam: { body?: string; body_type?: UpdateContentsParam.body_type; contents_id: string; room_id: string }

Type declaration

optionalbody?: string
The content of the post. If body_type=json_string is passed, it must be a string converted from a JSON object representing a rich-formatted text (We'll add guidelines on how to construct a rich-text object soon).
optionalbody_type?: UpdateContentsParam.body_type
Whether or not to use rich styles.
- plain: The content value will be parsed as plaintext.
- json_string: The content value will be parsed as an object representing a rich-formatted text.
contents_id: string
The ID of the post.
room_id: string
The ID of the chat that contains the post.

UpdateContentsResponse

UpdateContentsResponse: { contents?: Contents }

An object wrapping a Swit resource.

Type declaration

optionalcontents?: Contents

UpdateCustomFieldParam

UpdateCustomFieldParam: { custom_field_id: string; edit_role?: UpdateCustomFieldParam.edit_role; enabled?: boolean }

Type declaration

custom_field_id: string
The ID of the custom field to update.
optionaledit_role?: UpdateCustomFieldParam.edit_role
Who can update the field's value on individual members' user profiles.
- ADMIN: Admins can update the field's value on any member's profile.
- MEMBER: Members can update the field's value on their own profile.
optionalenabled?: boolean
Whether to display the field on user profiles. Up to five fields can be set to be displayed.

UpdateCustomFieldResponse

UpdateCustomFieldResponse: { custom_field?: CustomField }

An object wrapping a Swit resource.

Type declaration

optionalcustom_field?: CustomField

UpdateProjectArchiveParam

UpdateProjectArchiveParam: { archive?: boolean; id: string }

Type declaration

optionalarchive?: boolean
Whether to archive (true) or unarchive (false) the project.
id: string
The ID of the project to archive or unarchive.

UpdateRoomParam

UpdateRoomParam: { name: string; room_id: string }

Type declaration

name: string
The name of the chat that will be visible to the user.
room_id: string
The ID of the chat.

UpdateRoomResponse

UpdateRoomResponse: { room?: Room }

An object wrapping a Swit resource.

Type declaration

optionalroom?: Room

UpdateUserCustomFieldParam

UpdateUserCustomFieldParam: { custom_field_user_data_elements: CustomFieldUserDataElement[]; update_fields?: (data_value | enabled)[]; user_id: string }

Type declaration

custom_field_user_data_elements: CustomFieldUserDataElement[]
Array of custom field objects to update for the selected user.
optionalupdate_fields?: (data_value | enabled)[]
The fields to update. If this parameter is omitted or assigned an empty value, all fields will be updated. Fields without provided values will be set to empty or default values.
user_id: string
The ID of the user to update with the selected custom fields.

UpdateUserCustomFieldResponse

UpdateUserCustomFieldResponse: { custom_field_ids?: CustomFieldIds[] }

An object wrapping a Swit resource.

Type declaration

optionalcustom_field_ids?: CustomFieldIds[]
Array of the custom fields updated for the user.

UserPresenceSyncStatusResponse

UserPresenceSyncStatusResponse: { app_id?: string; is_presence_sync_on?: boolean }

An object wrapping a Swit resource.

Type declaration

optionalapp_id?: string
The ID of the app that issued the access token passed.
optionalis_presence_sync_on?: boolean
Whether or not the app is allowed to update the presence sync of the authorizing user.

UserResponse

UserResponse: { cmp_id?: string; color?: string; department?: string; id?: string; language?: UserResponse.language; name?: string; photo?: string; status?: number; status_msg?: string; tel?: string; timezone?: string; user_email?: string }

An object wrapping a Swit resource.

Type declaration

optionalcmp_id?: string
The ID of the organization the user is in.
optionalcolor?: string
The background color of the fallback avatar of the user.
optionaldepartment?: string
Previously used in the Free/Standard plans to describe the department the user is in.
optionalid?: string
The ID of the user. This is used for the API to identify the user.
optionallanguage?: UserResponse.language
The language setting of the user.
optionalname?: string
The username registered.
optionalphoto?: string
The URL path of the profile image, relative to https://files.swit.io.
optionalstatus?: number
Whether the user's membership is active.
- 0: Inactive
- 1: Active
optionalstatus_msg?: string
The status message the user has left.
optionaltel?: string
The phone number of the user.
optionaltimezone?: string
The timezone setting of the user.
optionaluser_email?: string
The email address of the user.

WorkspaceGroup

WorkspaceGroup: { created?: string; description?: string; grp_name?: string; guser_id?: string; status?: WorkspaceGroup.status; user_count?: number; ws_id?: string }

The properties of a group in a workspace.

Type declaration

optionalcreated?: string
The date and time at which the group was created.
optionaldescription?: string
The description of the group.
optionalgrp_name?: string
The name of the group.
optionalguser_id?: string
The ID of the group.
optionalstatus?: WorkspaceGroup.status
The status of the group.
- act: Active channel.
- leave: Deleted channel.
optionaluser_count?: number
The number of group members.
optionalws_id?: string
The ID of the workspace where the group belongs.

WorkspaceResponse

WorkspaceResponse: { admin_ids?: string[]; color?: string; created?: string; domain?: string; id?: string; master_id?: string; name?: string; photo?: string }

An object wrapping a Swit resource.

Type declaration

optionaladmin_ids?: string[]
The user IDs of the workspace administrators.
optionalcolor?: string
The background color of the fallback avatar of the workspace.
optionalcreated?: string
The date and time at which the workspace was created.
optionaldomain?: string
The domain name of the workspace.
optionalid?: string
The ID of the workspace.
optionalmaster_id?: string
The user ID of the workspace master.
optionalname?: string
The name of the workspace.
optionalphoto?: string
The URL path of the profile image, relative to https://files.swit.io.

WorkspaceUserResponse

WorkspaceUserResponse: { color?: string; department?: string; group?: WsGroup[]; is_admin?: boolean; is_master?: boolean; joined?: string; name?: string; photo?: string; status?: string; status_msg?: string; tel?: string; user_email?: string; user_id?: string }

Type declaration

optionalcolor?: string
The background color of the fallback avatar of the user.
optionaldepartment?: string
The department name of the user.
optionalgroup?: WsGroup[]
The groups the user belongs to.
optionalis_admin?: boolean
Whether the user is an administrator of the workspace.
optionalis_master?: boolean
Whether the user is the master of the workspace.
optionaljoined?: string
The date and time at which the user joined the workspace.
optionalname?: string
The display name of the user.
optionalphoto?: string
The URL path of the profile image, relative to https://files.swit.io.
optionalstatus?: string
Whether the user is active or inactive in the workspace.
optionalstatus_msg?: string
The status message the user has left.
optionaltel?: string
The phone number of the user.
optionalreadonlyuser_email?: string
The email address of the user.
optionaluser_id?: string
The ID of the user.

WsGroup

WsGroup: { description?: string; grp_name?: string; guser_id?: string; ws_id?: string }

Type declaration

optionaldescription?: string
The description of the group.
optionalgrp_name?: string
The name of the group.
optionalguser_id?: string
The ID of the group.
optionalws_id?: string
The ID of the workspace where the group belongs.

Variables

constAUTHORIZE_URL

AUTHORIZE_URL: https://openapi.swit.io/oauth/authorize = ...

constBASE_URL

BASE_URL: https://openapi.swit.io = ...

constOAUTH_TOKEN_URL

OAUTH_TOKEN_URL: https://openapi.swit.io/oauth/token = ...

constOAUTH_URL

OAUTH_URL: https://openapi.swit.io/oauth = ...

constOPEN_API_V1_URL

OPEN_API_V1_URL: https://openapi.swit.io/v1 = ...

constOpenAPI

OpenAPI: OpenAPIConfig = ...

constWEB_HOOK_URL

WEB_HOOK_URL: https://hook.swit.io = 'https://hook.swit.io'

Index

Classes

Interfaces

Namespaces

Type Aliases

Variables

Type Aliases

AddChannelParam

Type declaration

optionaldescription?: string

optionalis_prev_chat_visible?: boolean

optionalis_private?: boolean

name: string

workspace_id: string

AddChannelResponse

Type declaration

optionalchannel?: ChannelResponse

AddChannelUserInviteParam

Type declaration

id: string

user_ids: string[]

AddCompanyUserListParam

Type declaration

new_users: AddCompanyUserParam[]

role: number

AddCompanyUserParam

Type declaration

optionallanguage?: AddCompanyUserParam.language

optionalmsg?: string

optionaltel?: string

optionaltimezone?: string

user_email: string

user_name: string

AddCompanyWorkspaceInviteParam

Type declaration

id: string

optionaluser_id?: string

optionaluser_ids?: string[]

AddCompanyWorkspaceInviteResponse

AddCustomFieldParam

Type declaration

optionalcustom_field_elements?: CustomFieldOptionElement[]

optionaldescription?: string

edit_role: AddCustomFieldParam.edit_role

enabled: boolean

field_name: string

field_type: AddCustomFieldParam.field_type

AddCustomFieldResponse

Type declaration

optionalcustom_field?: CustomField

AddIdeaReactionParam

Type declaration

idea_id: string

reaction_name: string

AddIdeaReactionResponse

AddMessageReactionParam

Type declaration

message_id: string

reaction_name: string

AddMessageReactionResponse

AddProjectBucketParam

Type declaration

name: string

project_id: string

AddProjectBucketResponse

Type declaration

optionalbucket?: BucketResponse

AddProjectParam

Type declaration

optionaldescription?: string

optionalis_private?: boolean

name: string

workspace_id: string

AddProjectResponse

Type declaration

project: ProjectResponse

AddTaskAssigneeParam

Type declaration

task_id: string

optionaluser_id?: string