Class SketchApi

Hierarchy

BaseAPI
- SketchApi

Index

Constructors

Properties

Methods

getSketchBoundingBoxes getSketchBoundingBoxesRaw getSketchInfo getSketchInfoRaw getTessellatedEntities getTessellatedEntitiesRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

getSketchBoundingBoxes

getSketchBoundingBoxes(requestParameters: GetSketchBoundingBoxesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<BTBoundingBoxInfo>
Retrieve sketch bounding boxes by document ID, workspace or version or microversion ID, tab ID, and sketch ID.
Parameters
- requestParameters: GetSketchBoundingBoxesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<BTBoundingBoxInfo>
- Defined in apis/SketchApi.ts:123

getSketchBoundingBoxesRaw

getSketchBoundingBoxesRaw(requestParameters: GetSketchBoundingBoxesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<BTBoundingBoxInfo>>
Retrieve sketch bounding boxes by document ID, workspace or version or microversion ID, tab ID, and sketch ID.
Parameters
- requestParameters: GetSketchBoundingBoxesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<BTBoundingBoxInfo>>
- Defined in apis/SketchApi.ts:69

getSketchInfo

getSketchInfo(requestParameters: GetSketchInfoRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Retrieve sketches by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetSketchInfoRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/SketchApi.ts:197

getSketchInfoRaw

getSketchInfoRaw(requestParameters: GetSketchInfoRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Retrieve sketches by document ID, workspace or version or microversion ID, and tab ID.
Parameters
- requestParameters: GetSketchInfoRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/SketchApi.ts:131

getTessellatedEntities

getTessellatedEntities(requestParameters: GetTessellatedEntitiesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<object>
Retrieve tessellated entities of sketches by document ID, workspace or version or microversion ID, tab ID, and sketch ID.
Parameters
- requestParameters: GetTessellatedEntitiesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in apis/SketchApi.ts:271

getTessellatedEntitiesRaw

getTessellatedEntitiesRaw(requestParameters: GetTessellatedEntitiesRequest, initOverrides?: RequestInit | InitOverrideFunction): Promise<ApiResponse<object>>
Retrieve tessellated entities of sketches by document ID, workspace or version or microversion ID, tab ID, and sketch ID.
Parameters
- requestParameters: GetTessellatedEntitiesRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in apis/SketchApi.ts:205

`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 SketchApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = DefaultConfig

Returns SketchApi

Properties

Protected configuration

Methods

getSketchBoundingBoxes

Parameters

requestParameters: GetSketchBoundingBoxesRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<BTBoundingBoxInfo>

getSketchBoundingBoxesRaw

Parameters

requestParameters: GetSketchBoundingBoxesRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<BTBoundingBoxInfo>>

getSketchInfo

Parameters

requestParameters: GetSketchInfoRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

getSketchInfoRaw

Parameters

requestParameters: GetSketchInfoRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

getTessellatedEntities

Parameters

requestParameters: GetTessellatedEntitiesRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<object>

getTessellatedEntitiesRaw

Parameters

requestParameters: GetTessellatedEntitiesRequest

Optional initOverrides: RequestInit | InitOverrideFunction

Returns Promise<ApiResponse<object>>

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>)[]

Returns T

withPreMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

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

Returns T

Settings

Member Visibility

Theme

`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

`Protected` request

`Optional` initOverrides: RequestInit | InitOverrideFunction

`Rest` ...middlewares: Middleware[]

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

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