ProjectService

Index

Constructors

• constructor

Properties

• httpRequest

Methods

• postApiProjectUserInvite
• projectCreate
• projectInfo
• projectList
• projectTagList
• projectUpdate
• projectUpdateProjectArchive
• projectUserList
• taskStatusList

Constructors

constructor

• new ProjectService(httpRequest: BaseHttpRequest): ProjectService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns ProjectService

Properties

publicreadonlyhttpRequest

httpRequest: BaseHttpRequest

Methods

publicpostApiProjectUserInvite

• postApiProjectUserInvite(__namedParameters: { requestBody?: { project_id?: string; user_ids?: string[] } }): CancelablePromise<void>

• Invite users to a project Invites users to a project.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody?: { project_id?: string; user_ids?: string[] } }

  Returns CancelablePromise<void>

  void

publicprojectCreate

• projectCreate(__namedParameters: { requestBody: AddProjectParam }): CancelablePromise<{ data?: AddProjectResponse }>

• Create a project Creates a project in a workspace.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: AddProjectParam }

  Returns CancelablePromise<{ data?: AddProjectResponse }>

  any Successfully created the project.

publicprojectInfo

• projectInfo(__namedParameters: { id: string }): CancelablePromise<{ data?: GetProjectInfoResponse }>

• Get a project's information Bot-compatible Retrieves information about a project.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { id: string }

  Returns CancelablePromise<{ data?: GetProjectInfoResponse }>

  any Successfully retrieved the project's information.

publicprojectList

• projectList(__namedParameters: { activity?: string; disclosure?: string; limit?: number; name?: string; offset?: string; page?: number; workspaceId: string }): CancelablePromise<{ data?: GetProjectListResponse }>

• List out projects Lists out a given number of projects from a workspace. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { activity?: string; disclosure?: string; limit?: number; name?: string; offset?: string; page?: number; workspaceId: string }

  Returns CancelablePromise<{ data?: GetProjectListResponse }>

  any Successfully retrieved the projects.

publicprojectTagList

• projectTagList(__namedParameters: { id: string; limit?: number; offset?: string }): CancelablePromise<{ data?: GetProjectTagListResponse }>

• List out task tags Bot-compatible Lists out all task tags used in a project.

  Assigned to tasks of a project, tags facilitate filtering or searching those tasks for viewing convenience. This method enumerates all tags assigned at least once to any task of the target project.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { id: string; limit?: number; offset?: string }

  Returns CancelablePromise<{ data?: GetProjectTagListResponse }>

  any Successfully retrieved the tags from the project.

publicprojectUpdate

• projectUpdate(__namedParameters: { requestBody: PutProjectParam }): CancelablePromise<{ data?: PutProjectResponse }>

• Update a project Updates an existing project in a workspace.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: PutProjectParam }

  Returns CancelablePromise<{ data?: PutProjectResponse }>

  any Successfully updated the project.

publicprojectUpdateProjectArchive

• projectUpdateProjectArchive(__namedParameters: { requestBody: UpdateProjectArchiveParam }): CancelablePromise<void>

• Archive/unarchive a project Updates a project's archiving status.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { requestBody: UpdateProjectArchiveParam }

  Returns CancelablePromise<void>

  void

publicprojectUserList

• projectUserList(__namedParameters: { limit?: number; offset?: string; page?: number; projectId: string }): CancelablePromise<{ data?: GetProjectUserListResponse }>

• List out project members Bot-compatible Lists out a given number of members belonging to a project. This method uses the Swit API's pagination scheme.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { limit?: number; offset?: string; page?: number; projectId: string }

  Returns CancelablePromise<{ data?: GetProjectUserListResponse }>

  any Successfully retrieved the members.

publictaskStatusList

• taskStatusList(__namedParameters: { projectId: string }): CancelablePromise<{ data?: { status_list?: StatusCustom[] } }>

• List out statuses in a project Lists out the list of statuses in a given project.

  @throws

  ApiError

  ---

  Parameters

  • __namedParameters: { projectId: string }

  Returns CancelablePromise<{ data?: { status_list?: StatusCustom[] } }>

  any Successfully retrieved the list of statuses in a project.