Class BlobElementApi

Hierarchy

BaseAPI
- BlobElementApi

Index

Constructors

Properties

Methods

createBlobTranslation createBlobTranslationRaw downloadFileWorkspace downloadFileWorkspaceRaw request updateUnits updateUnitsRaw uploadFileCreateElement uploadFileCreateElementRaw uploadFileUpdateElement uploadFileUpdateElementRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

createBlobTranslation

createBlobTranslation(requestParameters: CreateBlobTranslationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTTranslationRequestInfo>
Create translation (export) of blob element (document tab) by document id, workspace or version ID, and tab ID.
Parameters
- requestParameters: CreateBlobTranslationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTTranslationRequestInfo>
- Defined in apis/BlobElementApi.ts:187

createBlobTranslationRaw

createBlobTranslationRaw(requestParameters: CreateBlobTranslationRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTTranslationRequestInfo>>
Create translation (export) of blob element (document tab) by document id, workspace or version ID, and tab ID.
Parameters
- requestParameters: CreateBlobTranslationRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTTranslationRequestInfo>>
- Defined in apis/BlobElementApi.ts:134

downloadFileWorkspace

downloadFileWorkspace(requestParameters: DownloadFileWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<Blob>
Retrieve a file from a blob element by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: DownloadFileWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Blob>
- Defined in apis/BlobElementApi.ts:245

downloadFileWorkspaceRaw

downloadFileWorkspaceRaw(requestParameters: DownloadFileWorkspaceRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<Blob>>
Retrieve a file from a blob element by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: DownloadFileWorkspaceRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Blob>>
- Defined in apis/BlobElementApi.ts:195

`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

updateUnits

updateUnits(requestParameters: UpdateUnitsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentElementProcessingInfo>
Update mesh units of a previously imported STL or OBJ file by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UpdateUnitsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentElementProcessingInfo>
- Defined in apis/BlobElementApi.ts:302

updateUnitsRaw

updateUnitsRaw(requestParameters: UpdateUnitsRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentElementProcessingInfo>>
Update mesh units of a previously imported STL or OBJ file by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UpdateUnitsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentElementProcessingInfo>>
- Defined in apis/BlobElementApi.ts:253

uploadFileCreateElement

uploadFileCreateElement(requestParameters: UploadFileCreateElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentElementProcessingInfo>
Upload the file to a new tab by document ID and workspace ID.
Parameters
- requestParameters: UploadFileCreateElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentElementProcessingInfo>
- Defined in apis/BlobElementApi.ts:469

uploadFileCreateElementRaw

uploadFileCreateElementRaw(requestParameters: UploadFileCreateElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentElementProcessingInfo>>
Upload the file to a new tab by document ID and workspace ID.
Parameters
- requestParameters: UploadFileCreateElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentElementProcessingInfo>>
- Defined in apis/BlobElementApi.ts:310

uploadFileUpdateElement

uploadFileUpdateElement(requestParameters: UploadFileUpdateElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTDocumentElementProcessingInfo>
Update a blob element by uploading a file by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UploadFileUpdateElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTDocumentElementProcessingInfo>
- Defined in apis/BlobElementApi.ts:644

uploadFileUpdateElementRaw

uploadFileUpdateElementRaw(requestParameters: UploadFileUpdateElementRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTDocumentElementProcessingInfo>>
Update a blob element by uploading a file by document ID, workspace ID, and tab ID.
Parameters
- requestParameters: UploadFileUpdateElementRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTDocumentElementProcessingInfo>>
- Defined in apis/BlobElementApi.ts:477

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 BlobElementApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns BlobElementApi

Properties

Protected configuration

Methods

createBlobTranslation

Parameters

requestParameters: CreateBlobTranslationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTTranslationRequestInfo>

createBlobTranslationRaw

Parameters

requestParameters: CreateBlobTranslationRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTTranslationRequestInfo>>

downloadFileWorkspace

Parameters

requestParameters: DownloadFileWorkspaceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Blob>

downloadFileWorkspaceRaw

Parameters

requestParameters: DownloadFileWorkspaceRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<Blob>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<Response>

updateUnits

Parameters

requestParameters: UpdateUnitsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTDocumentElementProcessingInfo>

updateUnitsRaw

Parameters

requestParameters: UpdateUnitsRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTDocumentElementProcessingInfo>>

uploadFileCreateElement

Parameters

requestParameters: UploadFileCreateElementRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTDocumentElementProcessingInfo>

uploadFileCreateElementRaw

Parameters

requestParameters: UploadFileCreateElementRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTDocumentElementProcessingInfo>>

uploadFileUpdateElement

Parameters

requestParameters: UploadFileUpdateElementRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTDocumentElementProcessingInfo>

uploadFileUpdateElementRaw

Parameters

requestParameters: UploadFileUpdateElementRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTDocumentElementProcessingInfo>>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

`Protected` configuration

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Protected` request

`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

`Rest` ...middlewares: Middleware[]

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

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