Class Composites

Hierarchy

HeyApiClient
- Composites

Index

Constructors

Properties

Methods

Constructors

constructor

new Composites(args?: { client?: Client }): Composites
Parameters
- Optionalargs: { client?: Client }
Returns Composites
Inherited from HeyApiClient.constructor
- Defined in substance-3d/src/sdk/sdk.gen.ts:24

Properties

`Protected`client

client: Client

Methods

compose

compose<ThrowOnError extends boolean = false>(
    options?: Options<V1CompositesComposeData, ThrowOnError>,
): RequestResult<
    V1CompositesComposeResponses,
    V1CompositesComposeErrors,
    ThrowOnError,
    "fields",
>
Generate 3D object composite

Generate a 3D Object Composite with the Substance 3D API.
Type Parameters
- ThrowOnError extends boolean = false
Parameters
- Optionaloptions: Options<V1CompositesComposeData, ThrowOnError>
Returns RequestResult<
    V1CompositesComposeResponses,
    V1CompositesComposeErrors,
    ThrowOnError,
    "fields",
>
- Defined in substance-3d/src/sdk/sdk.gen.ts:55