API class
Core3D API client
Signature:
declare class API
Remarks
Wraps a typed API client available for arbitrary API and provides a few convenience methods for common operations.
Constructors
Constructor |
Modifiers |
Description |
---|---|---|
API constructor. |
Properties
Property |
Modifiers |
Type |
Description |
---|---|---|---|
|
{ me: { read: ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/auth/me', 'GET'>>; }; } |
Auth API operations. | |
|
Core3DClient | ||
| |||
|
{ create: (data: Parameters<Core3DClient['/designs']['POST']>['0']['body']) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/designs', 'POST'>>>; read: (identity: string) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/designs/{identity}', 'GET'>>>; } |
Design API operations. | |
|
{ create: (data: Parameters<Core3DClient['/generations']['POST']>['0']['body']) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/generations', 'POST'>>>; read: (identity: string) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/generations/{identity}', 'GET'>>>; } |
Generation API operations. | |
|
{ read: (identity: string) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/materials/{identity}', 'GET'>>>; } |
Material API operations. | |
|
{ links: { list: (identity: string, options?: Partial<Parameters<Core3DClient['/models/{identity}/links']['GET']>[0]>) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/models/{identity}/links', 'GET'>>>; read: (source: string, target: string) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/models/{identity}/links/{target}', 'GET'>>>; }; read: (identity: string) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/models/{identity}', 'GET'>>>; } |
Model API operations. | |
|
Convenience method to resolve resources by URI. | ||
|
{ materials: { textures: { read: (identity: string, filename: string, options?: { query?: Parameters<Core3DClient['/static/materials/{identity}/textures/{filename}']['GET']>['0']['params']['query']; responseType?: 'arrayBuffer' | 'blob'; }) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/static/materials/{identity}/textures/{filename}', 'GET'>>>; }; }; } |
Static API operations. | |
|
{ create: (data: Parameters<Core3DClient['/uploads']['POST']>['0']['body']) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/uploads', 'POST'>>>; read: (identity: string) => ReturnType<ReturnType<typeof wrapOpenApiMethod<Core3DClient, '/uploads/{identity}', 'GET'>>>; } |
Upload API operations. | |
|
(uri: string, options?: { attempts?: number; }) => Promise<any> |
Convenience method to wait for an async API resource. |