Skip to content

Class.ProjectApi

Jump to bottom
Octavian Condre edited this page Jul 25, 2024 · 2 revisions

Trados User Interface Extensibility v0.1.13 / ProjectApi

Class: ProjectApi

Extends

  • BaseAPI

Constructors

new ProjectApi()

new ProjectApi(configuration): ProjectApi

Parameters

• configuration: Configuration= DefaultConfig

Returns

ProjectApi

Inherited from

runtime.BaseAPI.constructor

Source

lc-public-api/runtime.ts:97

Methods

cancelProjectFile()

cancelProjectFile(requestParameters, initOverrides?): Promise<void>

Cancels a project file. Cancel Project File

Parameters

• requestParameters: CancelProjectFileRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<void>

Source

lc-public-api/apis/ProjectApi.ts:186

cancelProjectFileRaw()

cancelProjectFileRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Cancels a project file. Cancel Project File

Parameters

• requestParameters: CancelProjectFileRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

lc-public-api/apis/ProjectApi.ts:131

completeProject()

completeProject(requestParameters, initOverrides?): Promise<void>

Marks a project as "completed". Complete Project

Parameters

• requestParameters: CompleteProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<void>

Source

lc-public-api/apis/ProjectApi.ts:242

completeProjectRaw()

completeProjectRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Marks a project as "completed". Complete Project

Parameters

• requestParameters: CompleteProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

lc-public-api/apis/ProjectApi.ts:194

createProject()

createProject(requestParameters, initOverrides?): Promise<Project>

Creates a new project. When creating a project using a project template that supports multiple source languages, you must supply the languageDirections. Consider the file and project size limit when creating projects. The values from a selected project template will take precedence over the individual resources when creating a new project. Create Project

Parameters

• requestParameters: CreateProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<Project>

Source

lc-public-api/apis/ProjectApi.ts:305

createProjectRaw()

createProjectRaw(requestParameters, initOverrides?): Promise<ApiResponse<Project>>

Creates a new project. When creating a project using a project template that supports multiple source languages, you must supply the languageDirections. Consider the file and project size limit when creating projects. The values from a selected project template will take precedence over the individual resources when creating a new project. Create Project

Parameters

• requestParameters: CreateProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<Project>>

Source

lc-public-api/apis/ProjectApi.ts:250

deleteProject()

deleteProject(requestParameters, initOverrides?): Promise<void>

Deletes a project. Delete Project

Parameters

• requestParameters: DeleteProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<void>

Source

lc-public-api/apis/ProjectApi.ts:362

deleteProjectRaw()

deleteProjectRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Deletes a project. Delete Project

Parameters

• requestParameters: DeleteProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

lc-public-api/apis/ProjectApi.ts:314

getProject()

getProject(requestParameters, initOverrides?): Promise<Project>

Retrieves a project by identifier. Get Project

Parameters

• requestParameters: GetProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<Project>

Source

lc-public-api/apis/ProjectApi.ts:422

getProjectConfiguration()

getProjectConfiguration(requestParameters, initOverrides?): Promise<ProjectConfiguration>

Get the configuration settings of an existing project. Get Project Configuration

Parameters

• requestParameters: GetProjectConfigurationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ProjectConfiguration>

Source

lc-public-api/apis/ProjectApi.ts:483

getProjectConfigurationRaw()

getProjectConfigurationRaw(requestParameters, initOverrides?): Promise<ApiResponse<ProjectConfiguration>>

Get the configuration settings of an existing project. Get Project Configuration

Parameters

• requestParameters: GetProjectConfigurationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ProjectConfiguration>>

Source

lc-public-api/apis/ProjectApi.ts:431

getProjectRaw()

getProjectRaw(requestParameters, initOverrides?): Promise<ApiResponse<Project>>

Retrieves a project by identifier. Get Project

Parameters

• requestParameters: GetProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<Project>>

Source

lc-public-api/apis/ProjectApi.ts:370

listProjectTasks()

listProjectTasks(requestParameters, initOverrides?): Promise<ListTasksResponse>

Lists the tasks of a specific project. List Project's Tasks

Parameters

• requestParameters: ListProjectTasksRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ListTasksResponse>

Source

lc-public-api/apis/ProjectApi.ts:564

listProjectTasksRaw()

listProjectTasksRaw(requestParameters, initOverrides?): Promise<ApiResponse<ListTasksResponse>>

Lists the tasks of a specific project. List Project's Tasks

Parameters

• requestParameters: ListProjectTasksRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ListTasksResponse>>

Source

lc-public-api/apis/ProjectApi.ts:492

listProjects()

listProjects(requestParameters, initOverrides?): Promise<ListProjectsResponse>

Retrieves a list of all the projects in the account. List Projects

Parameters

• requestParameters: ListProjectsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ListProjectsResponse>

Source

lc-public-api/apis/ProjectApi.ts:658

listProjectsRaw()

listProjectsRaw(requestParameters, initOverrides?): Promise<ApiResponse<ListProjectsResponse>>

Retrieves a list of all the projects in the account. List Projects

Parameters

• requestParameters: ListProjectsRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ListProjectsResponse>>

Source

lc-public-api/apis/ProjectApi.ts:573

startProject()

startProject(requestParameters, initOverrides?): Promise<void>

Starts a project. Translatable files should be uploaded before starting the project. If the action is executed on an already started project, the new translatable files should be uploaded first. Start Project

Parameters

• requestParameters: StartProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<void>

Source

lc-public-api/apis/ProjectApi.ts:715

startProjectRaw()

startProjectRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Starts a project. Translatable files should be uploaded before starting the project. If the action is executed on an already started project, the new translatable files should be uploaded first. Start Project

Parameters

• requestParameters: StartProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

lc-public-api/apis/ProjectApi.ts:667

updateCustomField()

updateCustomField(requestParameters, initOverrides?): Promise<void>

Allows updating individual custom fields on a project. Update Custom Field

Parameters

• requestParameters: UpdateCustomFieldRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<void>

Source

lc-public-api/apis/ProjectApi.ts:759

updateCustomFieldRaw()

updateCustomFieldRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Allows updating individual custom fields on a project. Update Custom Field

Parameters

• requestParameters: UpdateCustomFieldRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

lc-public-api/apis/ProjectApi.ts:723

updateProject()

updateProject(requestParameters, initOverrides?): Promise<void>

Updates the project in terms of: name, description, due date, quote, and project resources. Observe the rules of JSON Merge Patch Semantics. Project rescheduling (updating dueBy) is permitted only if: * there is no Customer Quote Approval task in the associated flow * at least one Customer Quote Approval was closed(in case multiple project batches) Update Project

Parameters

• requestParameters: UpdateProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<void>

Source

lc-public-api/apis/ProjectApi.ts:825

updateProjectConfiguration()

updateProjectConfiguration(requestParameters, initOverrides?): Promise<void>

Updates the configuration settings for an existing project. Update Project Configuration

Parameters

• requestParameters: UpdateProjectConfigurationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<void>

Source

lc-public-api/apis/ProjectApi.ts:884

updateProjectConfigurationRaw()

updateProjectConfigurationRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Updates the configuration settings for an existing project. Update Project Configuration

Parameters

• requestParameters: UpdateProjectConfigurationRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

lc-public-api/apis/ProjectApi.ts:833

updateProjectRaw()

updateProjectRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

Updates the project in terms of: name, description, due date, quote, and project resources. Observe the rules of JSON Merge Patch Semantics. Project rescheduling (updating dueBy) is permitted only if: * there is no Customer Quote Approval task in the associated flow * at least one Customer Quote Approval was closed(in case multiple project batches) Update Project

Parameters

• requestParameters: UpdateProjectRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<void>>

Source

lc-public-api/apis/ProjectApi.ts:767

withMiddleware()

withMiddleware<T>(this, ...middlewares): T

Type parameters

• T extends BaseAPI<T>

Parameters

• this: T

• ...middlewares: Middleware[]

Returns

T

Inherited from

runtime.BaseAPI.withMiddleware

Source

lc-public-api/runtime.ts:101

withPostMiddleware()

withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

• T extends BaseAPI<T>

Parameters

• this: T

• ...postMiddlewares: (undefined | (context) => Promise<void | Response>)[]

Returns

T

Inherited from

runtime.BaseAPI.withPostMiddleware

Source

lc-public-api/runtime.ts:112

withPreMiddleware()

withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

• T extends BaseAPI<T>

Parameters

• this: T

• ...preMiddlewares: (undefined | (context) => Promise<void | FetchParams>)[]

Returns

T

Inherited from

runtime.BaseAPI.withPreMiddleware

Source

lc-public-api/runtime.ts:107

API

Classes

Interfaces

Type Aliases

Variables

Functions

Clone this wiki locally