Class.QuoteApi

Trados User Interface Extensibility v0.1.13 / QuoteApi

Class: QuoteApi

Extends

• BaseAPI

Constructors

new QuoteApi()

new QuoteApi(configuration): QuoteApi

Parameters

• configuration: Configuration= DefaultConfig

Returns

QuoteApi

Inherited from

runtime.BaseAPI.constructor

Source

lc-public-api/runtime.ts:97

Methods

downloadQuoteReport()

downloadQuoteReport(requestParameters, initOverrides?): Promise<Blob>

Downloads a quote report generated by the asynchronous export operation. If the exportId query parameter is not provided, the last generated export quote will be downloaded. Download Exported Quote Report

Parameters

• requestParameters: DownloadQuoteReportRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<Blob>

Source

lc-public-api/apis/QuoteApi.ts:111

---

downloadQuoteReportRaw()

downloadQuoteReportRaw(requestParameters, initOverrides?): Promise<ApiResponse<Blob>>

Downloads a quote report generated by the asynchronous export operation. If the exportId query parameter is not provided, the last generated export quote will be downloaded. Download Exported Quote Report

Parameters

• requestParameters: DownloadQuoteReportRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<Blob>>

Source

lc-public-api/apis/QuoteApi.ts:55

---

exportQuoteReport()

exportQuoteReport(requestParameters, initOverrides?): Promise<ExportQuoteReportResponse>

Generates an asynchronous quote export operation for the project in either PDF or Excel format. Use the polling endpoint to check when the export is completed.
Export Quote Report

Parameters

• requestParameters: ExportQuoteReportRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ExportQuoteReportResponse>

Source

lc-public-api/apis/QuoteApi.ts:176

---

exportQuoteReportRaw()

exportQuoteReportRaw(requestParameters, initOverrides?): Promise<ApiResponse<ExportQuoteReportResponse>>

Generates an asynchronous quote export operation for the project in either PDF or Excel format. Use the polling endpoint to check when the export is completed.
Export Quote Report

Parameters

• requestParameters: ExportQuoteReportRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<ExportQuoteReportResponse>>

Source

lc-public-api/apis/QuoteApi.ts:120

---

pollQuoteReportExport()

pollQuoteReportExport(requestParameters, initOverrides?): Promise<PollQuoteReportExport200Response>

Polls a quote report via an export operation. The quote report can be downloaded once the status is "completed". The recommended polling interval is 20 seconds. If polling does not return a success status in 20 minutes, it should be abandoned and a new export should be retried. If the exportId query parameter is not provided, the polling action will return the status for the last generated export. Poll Quote Report Export

Parameters

• requestParameters: PollQuoteReportExportRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<PollQuoteReportExport200Response>

Source

lc-public-api/apis/QuoteApi.ts:241

---

pollQuoteReportExportRaw()

pollQuoteReportExportRaw(requestParameters, initOverrides?): Promise<ApiResponse<PollQuoteReportExport200Response>>

Polls a quote report via an export operation. The quote report can be downloaded once the status is "completed". The recommended polling interval is 20 seconds. If polling does not return a success status in 20 minutes, it should be abandoned and a new export should be retried. If the exportId query parameter is not provided, the polling action will return the status for the last generated export. Poll Quote Report Export

Parameters

• requestParameters: PollQuoteReportExportRequest

• initOverrides?: RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<PollQuoteReportExport200Response>>

Source

lc-public-api/apis/QuoteApi.ts:185

---

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