Class TranslationApi

Hierarchy

BaseAPI
- TranslationApi

Index

Constructors

Properties

Methods

createTranslation createTranslationRaw deleteTranslation deleteTranslationRaw getAllTranslatorFormats getAllTranslatorFormatsRaw getDocumentTranslations getDocumentTranslationsRaw getTranslation getTranslationRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new TranslationApi(configuration?: Configuration): TranslationApi
Parameters
- configuration: Configuration = DefaultConfig
Returns TranslationApi
Inherited from BaseAPI.constructor
- Defined in runtime.ts:96

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

createTranslation

createTranslation(requestParameters: CreateTranslationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTTranslationRequestInfo>
Upload foreign data (for example, an X_T file) into Onshape, and then translate the data to generate a part, Part Studio, Assembly, or subassembly.
Parameters
- requestParameters: CreateTranslationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTTranslationRequestInfo>
- Defined in apis/TranslationApi.ts:239

createTranslationRaw

createTranslationRaw(requestParameters: CreateTranslationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTTranslationRequestInfo>>
Upload foreign data (for example, an X_T file) into Onshape, and then translate the data to generate a part, Part Studio, Assembly, or subassembly.
Parameters
- requestParameters: CreateTranslationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTTranslationRequestInfo>>
- Defined in apis/TranslationApi.ts:84

deleteTranslation

deleteTranslation(requestParameters: DeleteTranslationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Delete translation status entry.
Parameters
- requestParameters: DeleteTranslationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/TranslationApi.ts:277

deleteTranslationRaw

deleteTranslationRaw(requestParameters: DeleteTranslationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Delete translation status entry.
Parameters
- requestParameters: DeleteTranslationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/TranslationApi.ts:247

getAllTranslatorFormats

getAllTranslatorFormats(initOverrides?: RequestInit | InitOverrideFunction): Promise<BTModelFormatFullInfo[]>
Retrieve a list of translation formats that can work for this translation. Some are valid only as an input format and cannot be used as an output format.
Parameters
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTModelFormatFullInfo[]>
- Defined in apis/TranslationApi.ts:306

getAllTranslatorFormatsRaw

getAllTranslatorFormatsRaw(initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTModelFormatFullInfo[]>>
Retrieve a list of translation formats that can work for this translation. Some are valid only as an input format and cannot be used as an output format.
Parameters
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTModelFormatFullInfo[]>>
- Defined in apis/TranslationApi.ts:285

getDocumentTranslations

getDocumentTranslations(requestParameters: GetDocumentTranslationsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTListResponseBTTranslationRequestInfo>
Request an array of translations that were made against this document.
Parameters
- requestParameters: GetDocumentTranslationsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTListResponseBTTranslationRequestInfo>
- Defined in apis/TranslationApi.ts:352

getDocumentTranslationsRaw

getDocumentTranslationsRaw(requestParameters: GetDocumentTranslationsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTListResponseBTTranslationRequestInfo>>
Request an array of translations that were made against this document.
Parameters
- requestParameters: GetDocumentTranslationsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTListResponseBTTranslationRequestInfo>>
- Defined in apis/TranslationApi.ts:314

getTranslation

getTranslation(requestParameters: GetTranslationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTTranslationRequestInfo>
Request information on an in-progress or completed translation.
Parameters
- requestParameters: GetTranslationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTTranslationRequestInfo>
- Defined in apis/TranslationApi.ts:390

getTranslationRaw

getTranslationRaw(requestParameters: GetTranslationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTTranslationRequestInfo>>
Request information on an in-progress or completed translation.
Parameters
- requestParameters: GetTranslationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTTranslationRequestInfo>>
- Defined in apis/TranslationApi.ts:360

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in runtime.ts:116

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in runtime.ts:100

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in runtime.ts:111

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in runtime.ts:106

Class TranslationApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns TranslationApi

Properties

Protected configuration

Methods

createTranslation

Parameters

requestParameters: CreateTranslationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTTranslationRequestInfo>

createTranslationRaw

Parameters

requestParameters: CreateTranslationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTTranslationRequestInfo>>

deleteTranslation

Parameters

requestParameters: DeleteTranslationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

deleteTranslationRaw

Parameters

requestParameters: DeleteTranslationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

getAllTranslatorFormats

Parameters

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTModelFormatFullInfo[]>

getAllTranslatorFormatsRaw

Parameters

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTModelFormatFullInfo[]>>

getDocumentTranslations

Parameters

requestParameters: GetDocumentTranslationsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTListResponseBTTranslationRequestInfo>

getDocumentTranslationsRaw

Parameters

requestParameters: GetDocumentTranslationsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTListResponseBTTranslationRequestInfo>>

getTranslation

Parameters

requestParameters: GetTranslationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTTranslationRequestInfo>

getTranslationRaw

Parameters

requestParameters: GetTranslationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTTranslationRequestInfo>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Protected` configuration

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]