@musallam/ffs-substance-3d-client 1.0.0

package/dist/sdk.d.mts

@@ -0,0 +1,2556 @@
+import { n as Options$2, t as ky } from "./index-IOhsyoSY.mjs";
+
+//#region packages/substance-3d/src/sdk/core/auth.gen.d.ts
+type AuthToken = string | undefined;
+interface Auth {
+  /**
+   * Which part of the request do we use to send the auth?
+   *
+   * @default 'header'
+   */
+  in?: 'header' | 'query' | 'cookie';
+  /**
+   * Header or query parameter name.
+   *
+   * @default 'Authorization'
+   */
+  name?: string;
+  scheme?: 'basic' | 'bearer';
+  type: 'apiKey' | 'http';
+}
+//#endregion
+//#region packages/substance-3d/src/sdk/core/pathSerializer.gen.d.ts
+interface SerializerOptions<T> {
+  /**
+   * @default true
+   */
+  explode: boolean;
+  style: T;
+}
+type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
+type ObjectStyle = 'form' | 'deepObject';
+//#endregion
+//#region packages/substance-3d/src/sdk/core/bodySerializer.gen.d.ts
+type QuerySerializer = (query: Record<string, unknown>) => string;
+type BodySerializer = (body: unknown) => unknown;
+type QuerySerializerOptionsObject = {
+  allowReserved?: boolean;
+  array?: Partial<SerializerOptions<ArrayStyle>>;
+  object?: Partial<SerializerOptions<ObjectStyle>>;
+};
+type QuerySerializerOptions = QuerySerializerOptionsObject & {
+  /**
+   * Per-parameter serialization overrides. When provided, these settings
+   * override the global array/object settings for specific parameter names.
+   */
+  parameters?: Record<string, QuerySerializerOptionsObject>;
+};
+//#endregion
+//#region packages/substance-3d/src/sdk/core/types.gen.d.ts
+type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
+type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
+  /**
+   * Returns the final request URL.
+   */
+  buildUrl: BuildUrlFn;
+  getConfig: () => Config;
+  request: RequestFn;
+  setConfig: (config: Config) => Config;
+} & { [K in HttpMethod]: MethodFn } & ([SseFn] extends [never] ? {
+  sse?: never;
+} : {
+  sse: { [K in HttpMethod]: SseFn };
+});
+interface Config$1 {
+  /**
+   * Auth token or a function returning auth token. The resolved value will be
+   * added to the request payload as defined by its `security` array.
+   */
+  auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+  /**
+   * A function for serializing request body parameter. By default,
+   * {@link JSON.stringify()} will be used.
+   */
+  bodySerializer?: BodySerializer | null;
+  /**
+   * An object containing any HTTP headers that you want to pre-populate your
+   * `Headers` object with.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+   */
+  headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
+  /**
+   * The request method.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+   */
+  method?: Uppercase<HttpMethod>;
+  /**
+   * A function for serializing request query parameters. By default, arrays
+   * will be exploded in form style, objects will be exploded in deepObject
+   * style, and reserved characters are percent-encoded.
+   *
+   * This method will have no effect if the native `paramsSerializer()` Axios
+   * API function is used.
+   *
+   * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+   */
+  querySerializer?: QuerySerializer | QuerySerializerOptions;
+  /**
+   * A function validating request data. This is useful if you want to ensure
+   * the request conforms to the desired shape, so it can be safely sent to
+   * the server.
+   */
+  requestValidator?: (data: unknown) => Promise<unknown>;
+  /**
+   * A function transforming response data before it's returned. This is useful
+   * for post-processing data, e.g. converting ISO strings into Date objects.
+   */
+  responseTransformer?: (data: unknown) => Promise<unknown>;
+  /**
+   * A function validating response data. This is useful if you want to ensure
+   * the response conforms to the desired shape, so it can be safely passed to
+   * the transformers and returned to the user.
+   */
+  responseValidator?: (data: unknown) => Promise<unknown>;
+}
+//#endregion
+//#region packages/substance-3d/src/sdk/core/serverSentEvents.gen.d.ts
+type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
+  /**
+   * Fetch API implementation. You can use this option to provide a custom
+   * fetch instance.
+   *
+   * @default globalThis.fetch
+   */
+  fetch?: typeof fetch;
+  /**
+   * Implementing clients can call request interceptors inside this hook.
+   */
+  onRequest?: (url: string, init: RequestInit) => Promise<Request>;
+  /**
+   * Callback invoked when a network or parsing error occurs during streaming.
+   *
+   * This option applies only if the endpoint returns a stream of events.
+   *
+   * @param error The error that occurred.
+   */
+  onSseError?: (error: unknown) => void;
+  /**
+   * Callback invoked when an event is streamed from the server.
+   *
+   * This option applies only if the endpoint returns a stream of events.
+   *
+   * @param event Event streamed from the server.
+   * @returns Nothing (void).
+   */
+  onSseEvent?: (event: StreamEvent<TData>) => void;
+  serializedBody?: RequestInit['body'];
+  /**
+   * Default retry delay in milliseconds.
+   *
+   * This option applies only if the endpoint returns a stream of events.
+   *
+   * @default 3000
+   */
+  sseDefaultRetryDelay?: number;
+  /**
+   * Maximum number of retry attempts before giving up.
+   */
+  sseMaxRetryAttempts?: number;
+  /**
+   * Maximum retry delay in milliseconds.
+   *
+   * Applies only when exponential backoff is used.
+   *
+   * This option applies only if the endpoint returns a stream of events.
+   *
+   * @default 30000
+   */
+  sseMaxRetryDelay?: number;
+  /**
+   * Optional sleep function for retry backoff.
+   *
+   * Defaults to using `setTimeout`.
+   */
+  sseSleepFn?: (ms: number) => Promise<void>;
+  url: string;
+};
+interface StreamEvent<TData = unknown> {
+  data: TData;
+  event?: string;
+  id?: string;
+  retry?: number;
+}
+type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
+  stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
+};
+//#endregion
+//#region packages/substance-3d/src/sdk/client/utils.gen.d.ts
+type ErrInterceptor<Err, Res, Req, Options> = (error: Err, response: Res, request: Req, options: Options) => Err | Promise<Err>;
+type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
+type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
+declare class Interceptors<Interceptor> {
+  fns: Array<Interceptor | null>;
+  clear(): void;
+  eject(id: number | Interceptor): void;
+  exists(id: number | Interceptor): boolean;
+  getInterceptorIndex(id: number | Interceptor): number;
+  update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
+  use(fn: Interceptor): number;
+}
+interface Middleware<Req, Res, Err, Options> {
+  error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
+  request: Interceptors<ReqInterceptor<Req, Options>>;
+  response: Interceptors<ResInterceptor<Res, Req, Options>>;
+}
+//#endregion
+//#region packages/substance-3d/src/sdk/client/types.gen.d.ts
+type ResponseStyle = 'data' | 'fields';
+interface RetryOptions {
+  /**
+   * Maximum number of retry attempts
+   *
+   * @default 2
+   */
+  limit?: number;
+  /**
+   * HTTP methods to retry
+   *
+   * @default ['get', 'put', 'head', 'delete', 'options', 'trace']
+   */
+  methods?: Array<'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace'>;
+  /**
+   * HTTP status codes to retry
+   *
+   * @default [408, 413, 429, 500, 502, 503, 504]
+   */
+  statusCodes?: number[];
+}
+interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<Options$2, 'body' | 'headers' | 'method' | 'prefixUrl' | 'retry' | 'throwHttpErrors'>, Config$1 {
+  /**
+   * Base URL for all requests made by this client.
+   */
+  baseUrl?: T['baseUrl'];
+  /**
+   * Ky instance to use. You can use this option to provide a custom
+   * ky instance.
+   */
+  ky?: typeof ky;
+  /**
+   * Additional ky-specific options that will be passed directly to ky.
+   * This allows you to use any ky option not explicitly exposed in the config.
+   */
+  kyOptions?: Omit<Options$2, 'method' | 'prefixUrl'>;
+  /**
+   * Return the response data parsed in a specified format. By default, `auto`
+   * will infer the appropriate method from the `Content-Type` response header.
+   * You can override this behavior with any of the {@link Body} methods.
+   * Select `stream` if you don't want to parse response data at all.
+   *
+   * @default 'auto'
+   */
+  parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
+  /**
+   * Should we return only data or multiple fields (data, error, response, etc.)?
+   *
+   * @default 'fields'
+   */
+  responseStyle?: ResponseStyle;
+  /**
+   * Retry configuration
+   */
+  retry?: RetryOptions;
+  /**
+   * Throw an error instead of returning it in the response?
+   *
+   * @default false
+   */
+  throwOnError?: T['throwOnError'];
+  /**
+   * Request timeout in milliseconds
+   *
+   * @default 10000
+   */
+  timeout?: number;
+}
+interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
+  responseStyle: TResponseStyle;
+  throwOnError: ThrowOnError;
+}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
+  /**
+   * Any body that you want to add to your request.
+   *
+   * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
+   */
+  body?: unknown;
+  path?: Record<string, unknown>;
+  query?: Record<string, unknown>;
+  /**
+   * Security mechanism(s) to use for the request.
+   */
+  security?: ReadonlyArray<Auth>;
+  url: Url;
+}
+interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
+  serializedBody?: string;
+}
+type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
+  data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+  request: Request;
+  response: Response;
+}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
+  data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+  error: undefined;
+} | {
+  data: undefined;
+  error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
+}) & {
+  request: Request;
+  response: Response;
+}>;
+interface ClientOptions$1 {
+  baseUrl?: string;
+  responseStyle?: ResponseStyle;
+  throwOnError?: boolean;
+}
+type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type SseFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData, TError>>;
+type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type BuildUrlFn = <TData extends {
+  body?: unknown;
+  path?: Record<string, unknown>;
+  query?: Record<string, unknown>;
+  url: string;
+}>(options: TData & Options$1<TData>) => string;
+type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
+  interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
+};
+interface TDataShape {
+  body?: unknown;
+  headers?: unknown;
+  path?: unknown;
+  query?: unknown;
+  url: string;
+}
+type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
+type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
+//#endregion
+//#region packages/substance-3d/src/sdk/types.gen.d.ts
+type ClientOptions = {
+  baseUrl: 'https://s3d.adobe.io' | (string & {});
+};
+/**
+ * The error within the error response.
+ */
+type FfapierrorsFfapiError = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * Associated error code.
+   */
+  error_code: string;
+  /**
+   * Optional list of individual error details.
+   */
+  error_details?: Array<unknown>;
+  /**
+   * Error message.
+   */
+  message?: string;
+};
+type FfapierrorsFfapiErrorDetail = {
+  /**
+   * Error code.
+   */
+  error_code: string;
+  /**
+   * Additional context for the error.
+   */
+  error_context?: unknown;
+  /**
+   * Where the error occurred, indicated in dot notation (e.g., body.items[3].tags or path.thing-id).
+   */
+  loc: string;
+  /**
+   * Error message text.
+   */
+  msg: string;
+};
+type RestBaseMountedSource = {
+  /**
+   * Fetch content from a Frame.io folder. ⚠️ All sources are exclusive.
+   *
+   * @deprecated
+   */
+  'frame.io'?: RestBaseSourceFrameIo;
+  /**
+   * Where to mount the content of the source in the virtual job working directory.
+   */
+  mountPoint?: string;
+  /**
+   * Fetch content from a next.frame.io folder. ⚠️ All sources are exclusive.
+   */
+  'next.frame.io'?: RestBaseSourceFrameIov4;
+  /**
+   * Read content from an existing space (can be another job's output, or uploaded manually with the space API). ⚠️ All sources are exclusive.'
+   */
+  space?: RestBaseSourceSpace;
+  /**
+   * Fetch content from a URL. ⚠️ All sources are exclusive.
+   */
+  url?: RestBaseSourceUrl;
+};
+type RestBaseSourceFrameIo = {
+  accessToken: string;
+  folderId: string;
+};
+type RestBaseSourceFrameIov4 = {
+  accessToken: string;
+  accountId: string;
+  folderId: string;
+};
+type RestBaseSourceSpace = {
+  /**
+   * A space ID.
+   */
+  id: string;
+};
+type RestBaseSourceUrl = {
+  /**
+   * Filename override. If unset, the service will try to detect the filename from the content disposition header, then the URL itself.
+   */
+  filename?: string;
+  /**
+   * URL to fetch content from.
+   */
+  url: string;
+};
+type RestBaseSpace = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * time at which the space will be deleted
+   */
+  expiry: string;
+  /**
+   * List of all files contained in Space, ordered by name.
+   */
+  files: Array<RestBaseSpaceFile> | null;
+  /**
+   * Unique identifier of this Space.
+   */
+  id: string;
+  /**
+   * URL to the full description of this Space.
+   */
+  url: string;
+  /**
+   * URL to fetch the whole space as an archive (usually a ZIP file).
+   */
+  archiveUrl?: unknown;
+};
+type RestBaseSpaceFile = {
+  name: string;
+  size: number;
+  url: string;
+};
+type Restv1ComposeSceneRequest = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * Name of an existing camera in the source 3D scene. The camera has to be defined in the scene.
+   */
+  cameraName?: string | null;
+  /**
+   * Class of content to generate.
+   */
+  contentClass?: 'art' | 'photo';
+  /**
+   * Enable the auto-generated ground plane under the hero asset. This is useful if the 3D scene contains only a hero asset, without additional elements.
+   */
+  enableGroundPlane?: boolean;
+  /**
+   * Optional environment settings used for all variations. If omitted, an environment will be generated based on the background. If set, the `lightingSeeds` parameter will be ignored.
+   */
+  environment?: TypesComposeEnvironment;
+  /**
+   * Exposure, in EV (0=neutral).
+   */
+  environmentExposure?: number;
+  /**
+   * Name of an existing 'hero asset' in the source 3D scene. The asset has to be defined in the scene.
+   */
+  heroAsset: string;
+  /**
+   * Optional seeds to be used to generate the lighting for the scene. The first seed will be used with the first seed of the background, the second one with the second seed of the background and so on. Background seeds must be defined and the number of lighting seeds should equal the number of background seeds. If not set, random seeds will be used. You will be able to retrieve the seeds used for the generation in the output details of the job.
+   */
+  lightingSeeds?: Array<number>;
+  /**
+   * Model version to be used to generate the background image with Adobe Firefly.
+   */
+  modelVersion?: 'image3_fast' | 'image4_standard' | 'image4_ultra';
+  /**
+   * The number of variations to generate. `numVariations` will default to the number of seeds, or to 1 if `seeds` is not specified.
+   */
+  numVariations?: number;
+  /**
+   * Prompt to be used to generate the background image with Adobe Firefly.
+   */
+  prompt: string;
+  scene?: TypesComposeSceneSceneDetails;
+  /**
+   * The path of the scene file in `sources`. If value is null, the first found scene file will be used.
+   */
+  sceneFile?: string;
+  /**
+   * Optional seed value to be used to generate the background image with Adobe Firefly. A seed ensures consistent background image generation. If `seed` is not set, a random seed will be used. Retrieve the seed used for the generation in the output details of the job. If specified with `numVariations`, the number of seeds must be the equal to `numVariations`.
+   */
+  seeds?: Array<number>;
+  /**
+   * The size of the image generations. The supported dimensions for image generations are:
+   * | Dimensions | Description |
+   * | -----------| ----- |
+   * | { "width": 2048, "height": 2048} | Square (1:1) |
+   * | { "width": 2304, "height": 1792 } | Landscape (4:3) |
+   * | { "width": 1792, "height": 2304 } | Portrait (3:4) |
+   * | { "width": 2688, "height": 1536 } | Widescreen (16:9) |
+   * | { "width": 1344, "height": 768 } |(7:4) |
+   * |{ "width": 1152, "height": 896 } |(9:7) |
+   * |{ "width": 896, "height": 1152 } |(7:9) |
+   * | { "width": 1024, "height": 1024} | Square (1:1) |
+   */
+  size?: TypesOutputSize;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+  /**
+   * Optional 'style image' to be used to generate the background. The style image has to be present in `sources`.
+   */
+  styleImage?: string;
+};
+type Restv1BetaComposeOutput = {
+  backgroundImage: Restv1BetaComposeOutputImage;
+  image: Restv1BetaComposeOutputImage;
+  lightingSeed: number;
+  maskImage: Restv1BetaComposeOutputImage;
+  seed: number;
+};
+type Restv1BetaComposeOutputImage = {
+  url: string;
+};
+type Restv1BetaComposeSceneJobResult = {
+  outputSpace?: RestBaseSpace;
+  outputs: Array<Restv1BetaComposeOutput> | null;
+  promptHasBlockedArtists: boolean;
+  promptHasDeniedWords: boolean;
+  warnings: Array<TypesWarning> | null;
+};
+type Restv1BetaComposeSceneRequest = {
+  /**
+   * A URL to the JSON Schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * Name of an existing camera in the source 3D scene (the camera has to be defined in the scene). This is exclusive with 'scene.camera'.
+   */
+  cameraName?: string | null;
+  /**
+   * Class of content to generate ('photo' or 'art'). If omitted, defaults to 'photo'.
+   */
+  contentClass?: 'art' | 'photo';
+  /**
+   * Allow to enable the auto-generated ground plane under the hero asset. Useful if the 3D scene contains only a hero asset without additional elements. Disabled by default.
+   */
+  enableGroundPlane?: boolean;
+  /**
+   * Optional environment settings used for all variations. If omitted, an environment will be generated based on the background. If set, the `lightingSeeds` parameter will be ignored.
+   */
+  environment?: TypesComposeEnvironment;
+  /**
+   * Exposure, in EV (0=neutral).
+   */
+  environmentExposure?: number;
+  /**
+   * Name of an existing 'hero asset' in the source 3D scene (the asset has to be defined in the scene).
+   */
+  heroAsset: string;
+  /**
+   * Optional seeds to be used to generate the lighting for the scene. The first seed will be used with the first seed of the background, the second one with the second seed of the background and so on. Background seeds must be defined and the number of lighting seeds should equal the number of background seeds. If not set, random seeds will be used. You will be able to retrieve the seeds used for the generation in the output details of the job.
+   */
+  lightingSeeds?: Array<number>;
+  /**
+   * Model version to be used to generate the background image with Adobe Firefly. If omitted, defaults to 'image3_fast'.
+   */
+  modelVersion?: 'image3_fast' | 'image4_standard' | 'image4_ultra';
+  /**
+   * The number of variations to generate. `numVariations` will default to the number of seeds, or to 1 if `seeds` is not specified.
+   */
+  numVariations?: number;
+  /**
+   * Prompt to be used to generate the background image with Adobe Firefly.
+   */
+  prompt: string;
+  scene?: TypesComposeSceneSceneDetails;
+  /**
+   * The path of the scene file in `sources`. If value is null, the first found scene file will be used.
+   */
+  sceneFile?: string;
+  /**
+   * Optional seed to be used to generate the background image with Adobe Firefly. Seed ensures consistent background image generation. If `seed` is not set, a random seed will be used. You will be able to retrieve the seed used for the generation in the output details of the job. If specified alongside `numVariations`, the number of seeds must be equal to `numVariations`.
+   */
+  seeds?: Array<number>;
+  /**
+   * The size of the requested generations. The supported dimensions for image generations are:
+   * | Dimensions | Description |
+   * | -----------| ----- |
+   * | { "width": 2048, "height": 2048} | Square (1:1) |
+   * | { "width": 2304, "height": 1792 } | Landscape (4:3) |
+   * | { "width": 1792, "height": 2304 } | Portrait (3:4) |
+   * | { "width": 2688, "height": 1536 } | Widescreen (16:9) |
+   */
+  size?: TypesOutputSize;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+  /**
+   * Optional 'style image' to be used to generate the background (the style image has to be present in sources)
+   */
+  styleImage?: string;
+};
+type Restv1BetaComposeSceneResponse = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaComposeSceneJobResult;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for job result in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaCreateSceneJobResult = {
+  outputSpace?: RestBaseSpace;
+  /**
+   * URL for the created scene.
+   */
+  sceneUrl: string;
+};
+type Restv1BetaCreateSceneRequest = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * Encoding output format.
+   */
+  encoding: 'glb' | 'gltf' | 'fbx' | 'usdz' | 'usda' | 'usdc' | 'obj';
+  /**
+   * Output filename.
+   */
+  fileBaseName: string;
+  scene: TypesSceneDescription;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+};
+type Restv1BetaCreateSceneResponse = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaCreateSceneJobResult;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaModelConvertJobResult = {
+  outputSpace?: RestBaseSpace;
+};
+type Restv1BetaModelConvertRequest = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * Output format.
+   */
+  format: 'glb' | 'gltf' | 'fbx' | 'usdz' | 'usda' | 'usdc' | 'obj';
+  /**
+   * Conversion usually takes the first file that's considered a valid 3D model. Define this entry point to disambiguate when there are multiple options.
+   */
+  modelEntrypoint?: string;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+};
+type Restv1BetaModelConvertResponse = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaModelConvertJobResult;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaRenderModelRequest = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * Options related to auto-framing.
+   */
+  autoFraming?: TypesAutoFramingOptions;
+  /**
+   * Options related to the background.
+   */
+  background?: TypesBackgroundOptions;
+  /**
+   * If set, this camera is used to perform the render. The camera has to be defined in the scene.
+   */
+  cameraName?: string;
+  /**
+   * Request additional outputs from the renderer.
+   */
+  extraOutputs?: TypesRenderExtraOutputs;
+  /**
+   * Options related to the ground plane.
+   */
+  groundPlane?: TypesGroundPlaneOptions;
+  /**
+   * Define rendering scene primitives.
+   */
+  scene: TypesSimpleSceneDescription;
+  /**
+   * Options related to the render size.
+   */
+  size?: TypesSizeOptions;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+};
+type Restv1BetaRenderModelResponse = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaRenderSceneJobResult;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaRenderModelTurntableRequest = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * Auto-framing related options.
+   */
+  autoFraming?: TypesAutoFramingOptions;
+  /**
+   * Background related options.
+   */
+  background?: TypesBackgroundOptions;
+  /**
+   * If set, this camera is used to perform the render. The camera has to be defined in the scene.
+   */
+  cameraName?: string;
+  /**
+   * Whether to export individual frames along with the turntable product.
+   */
+  exportFrames?: boolean;
+  framerate?: number;
+  /**
+   * Ground plane related options.
+   */
+  groundPlane?: TypesGroundPlaneOptions;
+  /**
+   * Set the rotation mode. Options are `rotate_camera` (camera rotates around model), `rotate_model` (model rotates), or `rotate_environment` (environment rotates).
+   */
+  mode?: 'rotate_camera' | 'rotate_model' | 'rotate_environment';
+  /**
+   * Define rendering scene primitives.
+   */
+  scene: TypesSimpleSceneDescription;
+  seconds?: number;
+  /**
+   * Render size related options.
+   */
+  size?: TypesSizeOptions;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+  /**
+   * Set to true to use a very fast rendering technique but with less accurate lighting.
+   */
+  useRasterizer?: boolean;
+};
+type Restv1BetaRenderModelTurntableResponse = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaRenderSceneTurntableJobResult;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaRenderSceneJobResult = {
+  /**
+   * List of URLs to the rendered frames. The rendered frames are ordered by frame number.
+   */
+  framesUrls?: Array<string> | null;
+  materialIds?: TypesIdsMapData;
+  materialMasks?: Array<TypesMaskNameToFileBinding>;
+  objectIds?: TypesIdsMapData;
+  objectMasks?: Array<TypesMaskNameToFileBinding>;
+  outputSpace?: RestBaseSpace;
+  /**
+   * URL to the rendered scene.
+   */
+  renderUrl: string;
+  warnings: Array<TypesWarning> | null;
+};
+type Restv1BetaRenderSceneRequest = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * Auto-framing related options.
+   */
+  autoFraming?: TypesAutoFramingOptions;
+  /**
+   * Background related options.
+   */
+  background?: TypesBackgroundOptions;
+  /**
+   * If set, this camera is used to perform the render. The camera has to be defined in the scene.
+   */
+  cameraName?: string;
+  /**
+   * Request additional outputs from the renderer.
+   */
+  extraOutputs?: TypesRenderExtraOutputs;
+  /**
+   * Options related to the ground plane.
+   */
+  groundPlane?: TypesGroundPlaneOptions;
+  /**
+   * Define rendering scene primitives.
+   */
+  scene: TypesSceneDescription;
+  /**
+   * Render size related options.
+   */
+  size?: TypesSizeOptions;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+};
+type Restv1BetaRenderSceneResponse = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaRenderSceneJobResult;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaRenderSceneTurntableJobResult = {
+  /**
+   * List of URLs to the rendered frames. The rendered frames are ordered by frame number.
+   */
+  framesUrls?: Array<string> | null;
+  outputSpace?: RestBaseSpace;
+  /**
+   * URL to the rendered scene.
+   */
+  renderUrl: string;
+  warnings: Array<TypesWarning> | null;
+};
+type Restv1BetaSceneDescJobResult = {
+  stats: TypesSceneStatsInfo;
+};
+type Restv1BetaSceneDescRequest = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * Path to the scene file in `sources`. If the value is `null`, the first found scene file will be used.
+   */
+  sceneFile?: string;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+};
+type Restv1BetaSceneDescResponse = {
+  /**
+   * A URL to the JSON schema for this object.
+   */
+  readonly $schema?: string;
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaSceneDescJobResult;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type TypesAutoFramingOptions = {
+  algorithm?: 'auto' | 'bounding_cylinder' | 'frustum_fit';
+  /**
+   * A value of 1 indicates tight framing. Less than 1 is a zoom-out. Greater than 1 is a zoom-in.
+   */
+  zoomFactor?: number;
+};
+type TypesAzimuthAltitude = {
+  /**
+   * Altitude, in degrees, from -90 to 90 degrees.
+   */
+  altitude: number;
+  /**
+   * Rotation around the vertical axis, in degrees.
+   */
+  azimuth: number;
+  /**
+   * Look at point coordinates.
+   */
+  lookAt: [number, number, number] | null;
+  /**
+   * Distance to the `lookAt` point.
+   */
+  radius: number;
+};
+type TypesBackgroundOptions = {
+  /**
+   * RGBA background color. Has an effect only if `showEnvironment` is `false`. Each component has to be in the [0,1] range.
+   */
+  backgroundColor?: [number, number, number, number] | null;
+  /**
+   * Path to a background image. If set, will be used as the background.
+   */
+  backgroundImage?: string;
+  /**
+   * Show the environment map as the background.
+   */
+  showEnvironment?: boolean;
+};
+type TypesCameraStats = {
+  aspectRatio: number;
+  fStop: number;
+  focalLength: number;
+  focusDistance: number;
+  horizontalAperture: number;
+  horizontalApertureOffset: number;
+  name: string;
+  projection: string;
+  verticalAperture: number;
+  verticalApertureOffset: number;
+};
+type TypesComposeEnvironment = {
+  /**
+   * Path of environment file in `sources`. If value is null, the environment file will be generated.
+   */
+  file: string;
+  /**
+   * Controls the orientation of the environment map.
+   */
+  rotation?: TypesRotation;
+};
+type TypesComposeSceneCustomModel = {
+  /**
+   * ID of the custom model to be used for the generation.
+   */
+  customModelId: string | null;
+  /**
+   * Token to be used to access the custom model.
+   */
+  customModelToken: string | null;
+};
+type TypesComposeSceneSceneDetails = {
+  /**
+   * Custom camera, exclusive with 'cameraName'.
+   */
+  camera?: TypesSceneCamera;
+};
+type TypesExportMasksOptions = {
+  /**
+   * The list of masks to be exported, accepts glob expressions. If empty, all masks will be exported.
+   */
+  selection?: Array<string> | null;
+};
+type TypesFormatOptions = {
+  /**
+   * USD format options.
+   */
+  usd: TypesUsdOptions;
+};
+type TypesGroundPlaneOptions = {
+  /**
+   * Automatically position the scene on the ground plane. Moves the scene along the vertical axis.
+   */
+  autoGroundScene?: boolean;
+  /**
+   * Enable/disable the ground plane.
+   */
+  enable?: boolean;
+  /**
+   * Enable/disable reflections onto the ground plane.
+   */
+  reflections?: boolean;
+  /**
+   * Controls the opacity of the reflections. Useful for compositing purposes.
+   */
+  reflectionsOpacity?: number;
+  /**
+   * Controls the roughness of the reflections. Useful for compositing purposes.
+   */
+  reflectionsRoughness?: number;
+  /**
+   * Controls whether the ground plane catches shadows or not.
+   */
+  shadows?: boolean;
+  /**
+   * Controls the opacity of cast shadows. Only has effect if shadows are enabled.
+   */
+  shadowsOpacity?: number;
+};
+type TypesIdsMapData = {
+  /**
+   * The Ids map file name.
+   */
+  fileName: string;
+  /**
+   * List of name to color bindings.
+   */
+  ids: Array<TypesNameToColorBinding> | null;
+};
+type TypesMaskNameToFileBinding = {
+  /**
+   * The file name.
+   */
+  fileName: string;
+  /**
+   * The name in the 3D scene.
+   */
+  name: string;
+};
+type TypesMaterial = {
+  /**
+   * The PBR material definition.
+   */
+  sbs?: TypesSbsMaterial;
+  /**
+   * The solid color material definition.
+   */
+  solidColor?: TypesSolidColorMaterial;
+};
+type TypesMaterialAssign = {
+  /**
+   * The material definition.
+   */
+  material: TypesMaterial;
+  /**
+   * Desired material name, it will be sanitized to make a valid USD prim name.
+   */
+  materialName: string;
+  /**
+   * List of nodes under which geometric primitives will have this material assigned. Each entry can be a full node name or a glob expression.
+   */
+  nodeList: Array<string> | null;
+  /**
+   * Set to true to assign this material by default to all geometric primitives.
+   */
+  assignByDefault?: unknown;
+  /**
+   * List of nodes to exclude from default assignment.
+   */
+  excludeFromDefault?: unknown;
+};
+type TypesMaterialOverride = {
+  /**
+   * RGB float color value, for example white is [1.0,1.0,1.0].
+   */
+  absorptionColorFactor?: [number, number, number];
+  absorptionColorTexture?: string;
+  absorptionDistanceFactor?: number;
+  absorptionDistanceTexture?: string;
+  /**
+   * RGB float color value, for example white is [1.0,1.0,1.0].
+   */
+  baseColorFactor?: [number, number, number];
+  baseColorTexture?: string;
+  /**
+   * RGB float color value, for example white is [1.0,1.0,1.0].
+   */
+  coatColorFactor?: [number, number, number];
+  coatColorTexture?: string;
+  coatOpacityFactor?: number;
+  coatOpacityTexture?: string;
+  coatRoughnessFactor?: number;
+  coatRoughnessTexture?: string;
+  materialName: string;
+  metallicFactor?: number;
+  metallicTexture?: string;
+  normalFactor?: [number, number, number];
+  normalTexture?: string;
+  opacityFactor?: number;
+  opacityTexture?: string;
+  pbrMaterial?: TypesSbsMaterial;
+  roughnessFactor?: number;
+  roughnessTexture?: string;
+  translucencyFactor?: number;
+  translucencyTexture?: string;
+  volumeThicknessFactor?: number;
+  volumeThicknessTexture?: string;
+};
+type TypesNameToColorBinding = {
+  /**
+   * Corresponding color in the ID map.
+   */
+  color: string;
+  /**
+   * Name in 3D scene.
+   */
+  name: string;
+};
+type TypesOutputSize = {
+  height: number;
+  width: number;
+};
+type TypesRenderExtraOutputs = {
+  /**
+   * Export an image with one color per material.
+   */
+  exportMaterialIds?: boolean;
+  /**
+   * Export one mask per material.
+   */
+  exportMaterialMasks?: TypesExportMasksOptions;
+  /**
+   * Export an image with one color per object.
+   */
+  exportObjectIds?: boolean;
+  /**
+   * Export one mask per object.
+   */
+  exportObjectMasks?: TypesExportMasksOptions;
+};
+type TypesRotation = {
+  /**
+   * Euler angles in degrees.
+   */
+  euler?: [number, number, number];
+  /**
+   * In W,X,Y,Z order.
+   */
+  quaternion?: [number, number, number, number];
+};
+type TypesSbsMaterial = {
+  /**
+   * Select a preset to be used for the substance material rendering.
+   */
+  preset?: string;
+  /**
+   * Substance material render resolution. This should be a power of two.
+   */
+  resolution?: 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096;
+  /**
+   * Texture space rotation.
+   */
+  rotation?: number;
+  /**
+   * Path to a substance material; if not set, the first substance 3D material found in sources will be used.
+   */
+  sbsar?: string;
+  /**
+   * Texture space scale.
+   */
+  scale?: [number, number];
+  /**
+   * Texture space translation.
+   */
+  translation?: [number, number];
+};
+type TypesSceneBaseFile = {
+  /**
+   * Path to the scene file in `sources`.
+   */
+  file: string;
+  /**
+   * Define root node for models in scene graph. If not found, the node which is parent of all models in the scene will be used. If this node doesn't exist, a new node will be created under global root.
+   */
+  modelsRootNodeName?: string;
+};
+type TypesSceneCamera = {
+  /**
+   * Camera focal length, in mm.
+   */
+  focal?: number;
+  /**
+   * Camera sensor width, in mm.
+   */
+  sensorWidth?: number;
+  /**
+   * Controls the position and angle of the camera.
+   */
+  transform?: TypesTransform;
+};
+type TypesSceneDescription = {
+  /**
+   * Define a scene from a file. If value is `null`, an empty scene will be created.
+   */
+  baseFile?: TypesSceneBaseFile;
+  /**
+   * Define a new camera for the scene.
+   */
+  camera?: TypesSceneCamera;
+  /**
+   * Define the environment for the scene. Override the previous existing environment.
+   */
+  environment?: TypesSceneEnvironment;
+  /**
+   * Assign new materials to geometric primitives.
+   */
+  materials?: Array<TypesMaterialAssign> | null;
+  /**
+   * Length of a scene unit, in meters. Defaults to `baseFile` meters per unit if any, or 0.01 (centimeters) otherwise.
+   */
+  metersPerUnit?: number;
+  /**
+   * Define additional models for the scene.
+   */
+  models?: TypesSceneModels;
+};
+type TypesSceneEnvironment = {
+  /**
+   * Exposure, in EV (0=neutral).
+   */
+  exposure?: number;
+  /**
+   * Path to the environment file in `sources`. If the value is `null`, the first found environment file will be used.
+   */
+  file?: string;
+  /**
+   * A scene may contain 3D lights, like area lights or spot lights. By default, all those lights are removed when a new environment is set. Set this option to `true` to preserve the scene 3D lights.
+   */
+  preserveLights?: boolean;
+  /**
+   * Controls the orientation of the environment map.
+   */
+  rotation?: TypesRotation;
+};
+type TypesSceneModel = {
+  /**
+   * Node name in scene graph which used as parent for the model. If anchor is not found, a node with the anchor name will be generated under models root node. And If value is `null`, a node will be generated under models root node.
+   */
+  anchorName?: string;
+  /**
+   * Path to the model file in `sources`. If the value is `null`, the first found model file will be used.
+   */
+  file?: string;
+  /**
+   * Define options specific for the model file format.
+   */
+  formatOptions?: TypesFormatOptions;
+  /**
+   * Define material overrides.
+   */
+  materialOverrides?: Array<TypesMaterialOverride> | null;
+  /**
+   * Transform applied on the anchor node. Overrides the previous value, if it exists.
+   */
+  transform?: TypesTransform;
+};
+type TypesSceneModels = {
+  /**
+   * List of model import definitions.
+   */
+  imports?: Array<TypesSceneModel> | null;
+  /**
+   * Global transformation applied on the models root node defined in the scene. Overrides the previous value, if it exists.
+   */
+  modelsRootNodeTransform?: TypesTransform;
+};
+type TypesSceneStatsBoundingBox = {
+  max: Array<number> | null;
+  min: Array<number> | null;
+};
+type TypesSceneStatsInfo = {
+  cameraNames: Array<string> | null;
+  materialNames: Array<string> | null;
+  metersPerSceneUnit: number;
+  nodesHierarchy: TypesSceneStatsNode;
+  numEquivalentTriangles: number;
+  numExtraPolygons: number;
+  numFaces: number;
+  numLines: number;
+  numMeshes: number;
+  numPoints: number;
+  numQuads: number;
+  numSubMeshes: number;
+  numTextures: number;
+  numTriangles: number;
+  numVertices: number;
+  sceneUpAxis: string;
+};
+type TypesSceneStatsNode = {
+  assignedMaterialName?: string;
+  cameraStats?: TypesCameraStats;
+  children?: Array<TypesSceneStatsNode> | null;
+  name: string;
+  type: string;
+  variants?: Array<TypesSceneStatsNodeVariant> | null;
+  worldSpaceBoundingBox?: TypesSceneStatsBoundingBox;
+};
+type TypesSceneStatsNodeVariant = {
+  currentValue: string;
+  name: string;
+  values: Array<string> | null;
+};
+type TypesShadowCatchingMaterial = {
+  reflectionOpacity: number;
+  roughness: number;
+  shadowOpacity: number;
+};
+type TypesSimpleSceneDescription = {
+  /**
+   * Define a new camera for the scene.
+   */
+  camera?: TypesSceneCamera;
+  /**
+   * Define the environment for the scene. Override the previous existing environment.
+   */
+  environment?: TypesSceneEnvironment;
+  /**
+   * Define options specific for the model file format.
+   */
+  formatOptions?: TypesFormatOptions;
+  /**
+   * Define material overrides.
+   */
+  materialOverrides?: Array<TypesMaterialOverride> | null;
+  /**
+   * Assign new materials to geometric primitives.
+   */
+  materials?: Array<TypesMaterialAssign> | null;
+  /**
+   * Length of a scene unit, in meters. Defaults to 0.01 (centimeters).
+   */
+  metersPerUnit?: number;
+  /**
+   * Path to the model file in `sources`. If the value is `null`, the first found model file will be used.
+   */
+  modelFile?: string;
+  /**
+   * Transform applied on the model.
+   */
+  modelTransform?: TypesTransform;
+};
+type TypesSizeOptions = {
+  /**
+   * Render height.
+   */
+  height: number;
+  /**
+   * Render width.
+   */
+  width: number;
+};
+type TypesSolidColorMaterial = {
+  /**
+   * RGB color of the solid material, each component has to be in the [0,1] range.
+   */
+  color: [number, number, number] | null;
+  /**
+   * Metallic factor of the solid material, has to be in the [0,1] range.
+   */
+  metallicFactor?: number;
+  /**
+   * Roughness factor of the solid material, has to be in the [0,1] range.
+   */
+  roughnessFactor?: number;
+};
+type TypesTrs = {
+  rotation: TypesRotation;
+  scale: [number, number, number] | null;
+  translation: [number, number, number] | null;
+};
+type TypesTransform = {
+  /**
+   * Transform is defined by azimuth, altitude and radius terms. If set, do not set `matrix` or `trs`.
+   */
+  azimuthAltitude?: TypesAzimuthAltitude;
+  /**
+   * Transform is defined as a matrix. If set, do not set `trs` or `azimuthAltitude`.
+   */
+  matrix?: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number];
+  /**
+   * Transform is defined by translation, rotation and scale terms. If set, do not set `matrix` or `azimuthAltitude`.
+   */
+  trs?: TypesTrs;
+};
+type TypesUsdOptions = {
+  /**
+   * List of USD variants definition applied on USD primitives.
+   */
+  variants: Array<TypesUsdVariant> | null;
+};
+type TypesUsdVariant = {
+  primName: string;
+  variant: string;
+  variantSet: string;
+};
+type TypesWarning = {
+  context: string;
+  message: string;
+};
+/**
+ * The error within the error response.
+ */
+type FfapierrorsFfapiErrorWritable = {
+  /**
+   * Associated error code.
+   */
+  error_code: string;
+  /**
+   * Optional list of individual error details.
+   */
+  error_details?: Array<unknown>;
+  /**
+   * Error message.
+   */
+  message?: string;
+};
+type RestBaseSpaceWritable = {
+  /**
+   * time at which the space will be deleted
+   */
+  expiry: string;
+  /**
+   * List of all files contained in Space, ordered by name.
+   */
+  files: Array<RestBaseSpaceFile> | null;
+  /**
+   * Unique identifier of this Space.
+   */
+  id: string;
+  /**
+   * URL to the full description of this Space.
+   */
+  url: string;
+  /**
+   * URL to fetch the whole space as an archive (usually a ZIP file).
+   */
+  archiveUrl?: unknown;
+};
+type Restv1ComposeSceneRequestWritable = {
+  /**
+   * Name of an existing camera in the source 3D scene. The camera has to be defined in the scene.
+   */
+  cameraName?: string | null;
+  /**
+   * Class of content to generate.
+   */
+  contentClass?: 'art' | 'photo';
+  /**
+   * Enable the auto-generated ground plane under the hero asset. This is useful if the 3D scene contains only a hero asset, without additional elements.
+   */
+  enableGroundPlane?: boolean;
+  /**
+   * Optional environment settings used for all variations. If omitted, an environment will be generated based on the background. If set, the `lightingSeeds` parameter will be ignored.
+   */
+  environment?: TypesComposeEnvironment;
+  /**
+   * Exposure, in EV (0=neutral).
+   */
+  environmentExposure?: number;
+  /**
+   * Name of an existing 'hero asset' in the source 3D scene. The asset has to be defined in the scene.
+   */
+  heroAsset: string;
+  /**
+   * Optional seeds to be used to generate the lighting for the scene. The first seed will be used with the first seed of the background, the second one with the second seed of the background and so on. Background seeds must be defined and the number of lighting seeds should equal the number of background seeds. If not set, random seeds will be used. You will be able to retrieve the seeds used for the generation in the output details of the job.
+   */
+  lightingSeeds?: Array<number>;
+  /**
+   * Model version to be used to generate the background image with Adobe Firefly.
+   */
+  modelVersion?: 'image3_fast' | 'image4_standard' | 'image4_ultra';
+  /**
+   * The number of variations to generate. `numVariations` will default to the number of seeds, or to 1 if `seeds` is not specified.
+   */
+  numVariations?: number;
+  /**
+   * Prompt to be used to generate the background image with Adobe Firefly.
+   */
+  prompt: string;
+  scene?: TypesComposeSceneSceneDetails;
+  /**
+   * The path of the scene file in `sources`. If value is null, the first found scene file will be used.
+   */
+  sceneFile?: string;
+  /**
+   * Optional seed value to be used to generate the background image with Adobe Firefly. A seed ensures consistent background image generation. If `seed` is not set, a random seed will be used. Retrieve the seed used for the generation in the output details of the job. If specified with `numVariations`, the number of seeds must be the equal to `numVariations`.
+   */
+  seeds?: Array<number>;
+  /**
+   * The size of the image generations. The supported dimensions for image generations are:
+   * | Dimensions | Description |
+   * | -----------| ----- |
+   * | { "width": 2048, "height": 2048} | Square (1:1) |
+   * | { "width": 2304, "height": 1792 } | Landscape (4:3) |
+   * | { "width": 1792, "height": 2304 } | Portrait (3:4) |
+   * | { "width": 2688, "height": 1536 } | Widescreen (16:9) |
+   * | { "width": 1344, "height": 768 } |(7:4) |
+   * |{ "width": 1152, "height": 896 } |(9:7) |
+   * |{ "width": 896, "height": 1152 } |(7:9) |
+   * | { "width": 1024, "height": 1024} | Square (1:1) |
+   */
+  size?: TypesOutputSize;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+  /**
+   * Optional 'style image' to be used to generate the background. The style image has to be present in `sources`.
+   */
+  styleImage?: string;
+};
+type Restv1BetaComposeSceneJobResultWritable = {
+  outputSpace?: RestBaseSpaceWritable;
+  outputs: Array<Restv1BetaComposeOutput> | null;
+  promptHasBlockedArtists: boolean;
+  promptHasDeniedWords: boolean;
+  warnings: Array<TypesWarning> | null;
+};
+type Restv1BetaComposeSceneRequestWritable = {
+  /**
+   * Name of an existing camera in the source 3D scene (the camera has to be defined in the scene). This is exclusive with 'scene.camera'.
+   */
+  cameraName?: string | null;
+  /**
+   * Class of content to generate ('photo' or 'art'). If omitted, defaults to 'photo'.
+   */
+  contentClass?: 'art' | 'photo';
+  /**
+   * Allow to enable the auto-generated ground plane under the hero asset. Useful if the 3D scene contains only a hero asset without additional elements. Disabled by default.
+   */
+  enableGroundPlane?: boolean;
+  /**
+   * Optional environment settings used for all variations. If omitted, an environment will be generated based on the background. If set, the `lightingSeeds` parameter will be ignored.
+   */
+  environment?: TypesComposeEnvironment;
+  /**
+   * Exposure, in EV (0=neutral).
+   */
+  environmentExposure?: number;
+  /**
+   * Name of an existing 'hero asset' in the source 3D scene (the asset has to be defined in the scene).
+   */
+  heroAsset: string;
+  /**
+   * Optional seeds to be used to generate the lighting for the scene. The first seed will be used with the first seed of the background, the second one with the second seed of the background and so on. Background seeds must be defined and the number of lighting seeds should equal the number of background seeds. If not set, random seeds will be used. You will be able to retrieve the seeds used for the generation in the output details of the job.
+   */
+  lightingSeeds?: Array<number>;
+  /**
+   * Model version to be used to generate the background image with Adobe Firefly. If omitted, defaults to 'image3_fast'.
+   */
+  modelVersion?: 'image3_fast' | 'image4_standard' | 'image4_ultra';
+  /**
+   * The number of variations to generate. `numVariations` will default to the number of seeds, or to 1 if `seeds` is not specified.
+   */
+  numVariations?: number;
+  /**
+   * Prompt to be used to generate the background image with Adobe Firefly.
+   */
+  prompt: string;
+  scene?: TypesComposeSceneSceneDetails;
+  /**
+   * The path of the scene file in `sources`. If value is null, the first found scene file will be used.
+   */
+  sceneFile?: string;
+  /**
+   * Optional seed to be used to generate the background image with Adobe Firefly. Seed ensures consistent background image generation. If `seed` is not set, a random seed will be used. You will be able to retrieve the seed used for the generation in the output details of the job. If specified alongside `numVariations`, the number of seeds must be equal to `numVariations`.
+   */
+  seeds?: Array<number>;
+  /**
+   * The size of the requested generations. The supported dimensions for image generations are:
+   * | Dimensions | Description |
+   * | -----------| ----- |
+   * | { "width": 2048, "height": 2048} | Square (1:1) |
+   * | { "width": 2304, "height": 1792 } | Landscape (4:3) |
+   * | { "width": 1792, "height": 2304 } | Portrait (3:4) |
+   * | { "width": 2688, "height": 1536 } | Widescreen (16:9) |
+   */
+  size?: TypesOutputSize;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+  /**
+   * Optional 'style image' to be used to generate the background (the style image has to be present in sources)
+   */
+  styleImage?: string;
+};
+type Restv1BetaComposeSceneResponseWritable = {
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaComposeSceneJobResultWritable;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for job result in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaCreateSceneJobResultWritable = {
+  outputSpace?: RestBaseSpaceWritable;
+  /**
+   * URL for the created scene.
+   */
+  sceneUrl: string;
+};
+type Restv1BetaCreateSceneRequestWritable = {
+  /**
+   * Encoding output format.
+   */
+  encoding: 'glb' | 'gltf' | 'fbx' | 'usdz' | 'usda' | 'usdc' | 'obj';
+  /**
+   * Output filename.
+   */
+  fileBaseName: string;
+  scene: TypesSceneDescription;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+};
+type Restv1BetaCreateSceneResponseWritable = {
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaCreateSceneJobResultWritable;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaModelConvertJobResultWritable = {
+  outputSpace?: RestBaseSpaceWritable;
+};
+type Restv1BetaModelConvertRequestWritable = {
+  /**
+   * Output format.
+   */
+  format: 'glb' | 'gltf' | 'fbx' | 'usdz' | 'usda' | 'usdc' | 'obj';
+  /**
+   * Conversion usually takes the first file that's considered a valid 3D model. Define this entry point to disambiguate when there are multiple options.
+   */
+  modelEntrypoint?: string;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+};
+type Restv1BetaModelConvertResponseWritable = {
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaModelConvertJobResultWritable;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaRenderModelRequestWritable = {
+  /**
+   * Options related to auto-framing.
+   */
+  autoFraming?: TypesAutoFramingOptions;
+  /**
+   * Options related to the background.
+   */
+  background?: TypesBackgroundOptions;
+  /**
+   * If set, this camera is used to perform the render. The camera has to be defined in the scene.
+   */
+  cameraName?: string;
+  /**
+   * Request additional outputs from the renderer.
+   */
+  extraOutputs?: TypesRenderExtraOutputs;
+  /**
+   * Options related to the ground plane.
+   */
+  groundPlane?: TypesGroundPlaneOptions;
+  /**
+   * Define rendering scene primitives.
+   */
+  scene: TypesSimpleSceneDescription;
+  /**
+   * Options related to the render size.
+   */
+  size?: TypesSizeOptions;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+};
+type Restv1BetaRenderModelResponseWritable = {
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaRenderSceneJobResultWritable;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaRenderModelTurntableRequestWritable = {
+  /**
+   * Auto-framing related options.
+   */
+  autoFraming?: TypesAutoFramingOptions;
+  /**
+   * Background related options.
+   */
+  background?: TypesBackgroundOptions;
+  /**
+   * If set, this camera is used to perform the render. The camera has to be defined in the scene.
+   */
+  cameraName?: string;
+  /**
+   * Whether to export individual frames along with the turntable product.
+   */
+  exportFrames?: boolean;
+  framerate?: number;
+  /**
+   * Ground plane related options.
+   */
+  groundPlane?: TypesGroundPlaneOptions;
+  /**
+   * Set the rotation mode. Options are `rotate_camera` (camera rotates around model), `rotate_model` (model rotates), or `rotate_environment` (environment rotates).
+   */
+  mode?: 'rotate_camera' | 'rotate_model' | 'rotate_environment';
+  /**
+   * Define rendering scene primitives.
+   */
+  scene: TypesSimpleSceneDescription;
+  seconds?: number;
+  /**
+   * Render size related options.
+   */
+  size?: TypesSizeOptions;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+  /**
+   * Set to true to use a very fast rendering technique but with less accurate lighting.
+   */
+  useRasterizer?: boolean;
+};
+type Restv1BetaRenderModelTurntableResponseWritable = {
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaRenderSceneTurntableJobResultWritable;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaRenderSceneJobResultWritable = {
+  /**
+   * List of URLs to the rendered frames. The rendered frames are ordered by frame number.
+   */
+  framesUrls?: Array<string> | null;
+  materialIds?: TypesIdsMapData;
+  materialMasks?: Array<TypesMaskNameToFileBinding>;
+  objectIds?: TypesIdsMapData;
+  objectMasks?: Array<TypesMaskNameToFileBinding>;
+  outputSpace?: RestBaseSpaceWritable;
+  /**
+   * URL to the rendered scene.
+   */
+  renderUrl: string;
+  warnings: Array<TypesWarning> | null;
+};
+type Restv1BetaRenderSceneRequestWritable = {
+  /**
+   * Auto-framing related options.
+   */
+  autoFraming?: TypesAutoFramingOptions;
+  /**
+   * Background related options.
+   */
+  background?: TypesBackgroundOptions;
+  /**
+   * If set, this camera is used to perform the render. The camera has to be defined in the scene.
+   */
+  cameraName?: string;
+  /**
+   * Request additional outputs from the renderer.
+   */
+  extraOutputs?: TypesRenderExtraOutputs;
+  /**
+   * Options related to the ground plane.
+   */
+  groundPlane?: TypesGroundPlaneOptions;
+  /**
+   * Define rendering scene primitives.
+   */
+  scene: TypesSceneDescription;
+  /**
+   * Render size related options.
+   */
+  size?: TypesSizeOptions;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+};
+type Restv1BetaRenderSceneResponseWritable = {
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaRenderSceneJobResultWritable;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type Restv1BetaRenderSceneTurntableJobResultWritable = {
+  /**
+   * List of URLs to the rendered frames. The rendered frames are ordered by frame number.
+   */
+  framesUrls?: Array<string> | null;
+  outputSpace?: RestBaseSpaceWritable;
+  /**
+   * URL to the rendered scene.
+   */
+  renderUrl: string;
+  warnings: Array<TypesWarning> | null;
+};
+type Restv1BetaSceneDescRequestWritable = {
+  /**
+   * Path to the scene file in `sources`. If the value is `null`, the first found scene file will be used.
+   */
+  sceneFile?: string;
+  /**
+   * List of sources to aggregate and run the job against.
+   */
+  sources: Array<RestBaseMountedSource> | null;
+};
+type Restv1BetaSceneDescResponseWritable = {
+  /**
+   * URL to report a bug about this job.
+   */
+  bugReportUrl: string;
+  /**
+   * Potential error that happened during the job processing.
+   */
+  error?: string;
+  /**
+   * Unique identifier of the job.
+   */
+  id: string;
+  /**
+   * Result when the job is successfully finished.
+   */
+  result?: Restv1BetaSceneDescJobResult;
+  /**
+   * Status of the job. Can be `not_started`, `running`, `succeeded`, or `failed`.
+   */
+  status: string;
+  /**
+   * URL to fetch/poll for the job result, in case the job is not finished yet.
+   */
+  url: string;
+};
+type V1CompositesComposeData = {
+  body?: Restv1ComposeSceneRequestWritable;
+  path?: never;
+  query?: {
+    /**
+     * Blocking mode (acts like a synchronous API call). Wait for the result before returning. ⚠️ Some operations are long, please be sure to configure your client timeout settings accordingly.
+     */
+    wait?: boolean;
+  };
+  url: '/v1/composites/compose';
+};
+type V1CompositesComposeErrors = {
+  /**
+   * Bad Request
+   */
+  400: FfapierrorsFfapiError;
+  /**
+   * Forbidden
+   */
+  403: FfapierrorsFfapiError;
+  /**
+   * Request Timeout
+   */
+  408: FfapierrorsFfapiError;
+  /**
+   * Unsupported Media Type
+   */
+  415: FfapierrorsFfapiError;
+  /**
+   * Unprocessable Entity
+   */
+  422: FfapierrorsFfapiError;
+  /**
+   * Too Many Requests
+   */
+  429: FfapierrorsFfapiError;
+  /**
+   * Internal Server Error
+   */
+  500: FfapierrorsFfapiError;
+};
+type V1CompositesComposeError = V1CompositesComposeErrors[keyof V1CompositesComposeErrors];
+type V1CompositesComposeResponses = {
+  /**
+   * Accepted
+   */
+  202: Restv1BetaComposeSceneResponse;
+};
+type V1CompositesComposeResponse = V1CompositesComposeResponses[keyof V1CompositesComposeResponses];
+type V1ScenesAssembleData = {
+  body?: Restv1BetaCreateSceneRequestWritable;
+  path?: never;
+  query?: {
+    /**
+     * Blocking mode (acts like a synchronous API call). Wait for the result before returning. ⚠️ Some operations are long, please be sure to configure your client timeout settings accordingly.
+     */
+    wait?: boolean;
+  };
+  url: '/v1/scenes/assemble';
+};
+type V1ScenesAssembleErrors = {
+  /**
+   * Bad Request
+   */
+  400: FfapierrorsFfapiError;
+  /**
+   * Forbidden
+   */
+  403: FfapierrorsFfapiError;
+  /**
+   * Request Timeout
+   */
+  408: FfapierrorsFfapiError;
+  /**
+   * Unsupported Media Type
+   */
+  415: FfapierrorsFfapiError;
+  /**
+   * Unprocessable Entity
+   */
+  422: FfapierrorsFfapiError;
+  /**
+   * Too Many Requests
+   */
+  429: FfapierrorsFfapiError;
+  /**
+   * Internal Server Error
+   */
+  500: FfapierrorsFfapiError;
+};
+type V1ScenesAssembleError = V1ScenesAssembleErrors[keyof V1ScenesAssembleErrors];
+type V1ScenesAssembleResponses = {
+  /**
+   * Accepted
+   */
+  202: Restv1BetaCreateSceneResponse;
+};
+type V1ScenesAssembleResponse = V1ScenesAssembleResponses[keyof V1ScenesAssembleResponses];
+type V1ScenesConvertData = {
+  body?: Restv1BetaModelConvertRequestWritable;
+  path?: never;
+  query?: {
+    /**
+     * Blocking mode (acts like a synchronous API call). Wait for the result before returning. ⚠️ Some operations are long, please be sure to configure your client timeout settings accordingly.
+     */
+    wait?: boolean;
+  };
+  url: '/v1/scenes/convert';
+};
+type V1ScenesConvertErrors = {
+  /**
+   * Bad Request
+   */
+  400: FfapierrorsFfapiError;
+  /**
+   * Forbidden
+   */
+  403: FfapierrorsFfapiError;
+  /**
+   * Request Timeout
+   */
+  408: FfapierrorsFfapiError;
+  /**
+   * Unsupported Media Type
+   */
+  415: FfapierrorsFfapiError;
+  /**
+   * Unprocessable Entity
+   */
+  422: FfapierrorsFfapiError;
+  /**
+   * Too Many Requests
+   */
+  429: FfapierrorsFfapiError;
+  /**
+   * Internal Server Error
+   */
+  500: FfapierrorsFfapiError;
+};
+type V1ScenesConvertError = V1ScenesConvertErrors[keyof V1ScenesConvertErrors];
+type V1ScenesConvertResponses = {
+  /**
+   * Accepted
+   */
+  202: Restv1BetaModelConvertResponse;
+};
+type V1ScenesConvertResponse = V1ScenesConvertResponses[keyof V1ScenesConvertResponses];
+type V1ScenesDescribeData = {
+  body?: Restv1BetaSceneDescRequestWritable;
+  path?: never;
+  query?: {
+    /**
+     * Blocking mode (acts like a synchronous API call). Wait for the result before returning. ⚠️ Some operations are long, please be sure to configure your client timeout settings accordingly.
+     */
+    wait?: boolean;
+  };
+  url: '/v1/scenes/describe';
+};
+type V1ScenesDescribeErrors = {
+  /**
+   * Bad Request
+   */
+  400: FfapierrorsFfapiError;
+  /**
+   * Forbidden
+   */
+  403: FfapierrorsFfapiError;
+  /**
+   * Request Timeout
+   */
+  408: FfapierrorsFfapiError;
+  /**
+   * Unsupported Media Type
+   */
+  415: FfapierrorsFfapiError;
+  /**
+   * Unprocessable Entity
+   */
+  422: FfapierrorsFfapiError;
+  /**
+   * Too Many Requests
+   */
+  429: FfapierrorsFfapiError;
+  /**
+   * Internal Server Error
+   */
+  500: FfapierrorsFfapiError;
+};
+type V1ScenesDescribeError = V1ScenesDescribeErrors[keyof V1ScenesDescribeErrors];
+type V1ScenesDescribeResponses = {
+  /**
+   * Accepted
+   */
+  202: Restv1BetaSceneDescResponse;
+};
+type V1ScenesDescribeResponse = V1ScenesDescribeResponses[keyof V1ScenesDescribeResponses];
+type V1ScenesRenderData = {
+  body?: Restv1BetaRenderSceneRequestWritable;
+  path?: never;
+  query?: {
+    /**
+     * Blocking mode (acts like a synchronous API call). Wait for the result before returning. ⚠️ Some operations are long, please be sure to configure your client timeout settings accordingly.
+     */
+    wait?: boolean;
+  };
+  url: '/v1/scenes/render';
+};
+type V1ScenesRenderErrors = {
+  /**
+   * Bad Request
+   */
+  400: FfapierrorsFfapiError;
+  /**
+   * Forbidden
+   */
+  403: FfapierrorsFfapiError;
+  /**
+   * Request Timeout
+   */
+  408: FfapierrorsFfapiError;
+  /**
+   * Unsupported Media Type
+   */
+  415: FfapierrorsFfapiError;
+  /**
+   * Unprocessable Entity
+   */
+  422: FfapierrorsFfapiError;
+  /**
+   * Too Many Requests
+   */
+  429: FfapierrorsFfapiError;
+  /**
+   * Internal Server Error
+   */
+  500: FfapierrorsFfapiError;
+};
+type V1ScenesRenderError = V1ScenesRenderErrors[keyof V1ScenesRenderErrors];
+type V1ScenesRenderResponses = {
+  /**
+   * Accepted
+   */
+  202: Restv1BetaRenderSceneResponse;
+};
+type V1ScenesRenderResponse = V1ScenesRenderResponses[keyof V1ScenesRenderResponses];
+type V1ScenesRenderBasicData = {
+  body?: Restv1BetaRenderModelRequestWritable;
+  path?: never;
+  query?: {
+    /**
+     * Blocking mode (acts like a synchronous API call). Wait for the result before returning. ⚠️ Some operations are long, please be sure to configure your client timeout settings accordingly.
+     */
+    wait?: boolean;
+  };
+  url: '/v1/scenes/render-basic';
+};
+type V1ScenesRenderBasicErrors = {
+  /**
+   * Bad Request
+   */
+  400: FfapierrorsFfapiError;
+  /**
+   * Forbidden
+   */
+  403: FfapierrorsFfapiError;
+  /**
+   * Request Timeout
+   */
+  408: FfapierrorsFfapiError;
+  /**
+   * Unsupported Media Type
+   */
+  415: FfapierrorsFfapiError;
+  /**
+   * Unprocessable Entity
+   */
+  422: FfapierrorsFfapiError;
+  /**
+   * Too Many Requests
+   */
+  429: FfapierrorsFfapiError;
+  /**
+   * Internal Server Error
+   */
+  500: FfapierrorsFfapiError;
+};
+type V1ScenesRenderBasicError = V1ScenesRenderBasicErrors[keyof V1ScenesRenderBasicErrors];
+type V1ScenesRenderBasicResponses = {
+  /**
+   * Accepted
+   */
+  202: Restv1BetaRenderModelResponse;
+};
+type V1ScenesRenderBasicResponse = V1ScenesRenderBasicResponses[keyof V1ScenesRenderBasicResponses];
+type CreateSpaceV1Data = {
+  body: {
+    /**
+     * Filename of the file being uploaded.
+     */
+    filename?: Blob | File;
+    /**
+     * General purpose name for multipart form value.
+     */
+    name?: string;
+  };
+  path?: never;
+  query?: never;
+  url: '/v1/spaces';
+};
+type CreateSpaceV1Errors = {
+  /**
+   * Forbidden
+   */
+  403: FfapierrorsFfapiError;
+  /**
+   * Request Timeout
+   */
+  408: FfapierrorsFfapiError;
+  /**
+   * Request Entity Too Large
+   */
+  413: FfapierrorsFfapiError;
+  /**
+   * Unprocessable Entity
+   */
+  422: FfapierrorsFfapiError;
+  /**
+   * Too Many Requests
+   */
+  429: FfapierrorsFfapiError;
+  /**
+   * Internal Server Error
+   */
+  500: FfapierrorsFfapiError;
+};
+type CreateSpaceV1Error = CreateSpaceV1Errors[keyof CreateSpaceV1Errors];
+type CreateSpaceV1Responses = {
+  /**
+   * Created
+   */
+  201: RestBaseSpace;
+};
+type CreateSpaceV1Response = CreateSpaceV1Responses[keyof CreateSpaceV1Responses];
+//#endregion
+//#region packages/substance-3d/src/sdk/sdk.gen.d.ts
+type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
+  /**
+   * You can provide a client instance returned by `createClient()` instead of
+   * individual options. This might be also useful if you want to implement a
+   * custom client.
+   */
+  client?: Client;
+  /**
+   * You can pass arbitrary values through the `meta` object. This can be
+   * used to access values that aren't defined as part of the SDK function.
+   */
+  meta?: Record<string, unknown>;
+};
+declare class HeyApiClient {
+  protected client: Client;
+  constructor(args?: {
+    client?: Client;
+  });
+}
+declare class HeyApiRegistry<T> {
+  private readonly defaultKey;
+  private readonly instances;
+  get(key?: string): T;
+  set(value: T, key?: string): void;
+}
+declare class Composites extends HeyApiClient {
+  /**
+   * Generate 3D object composite
+   *
+   * Generate a 3D Object Composite with the Substance 3D API.
+   */
+  compose<ThrowOnError extends boolean = false>(options?: Options<V1CompositesComposeData, ThrowOnError>): RequestResult<V1CompositesComposeResponses, V1CompositesComposeErrors, ThrowOnError, "fields">;
+}
+declare class Scenes extends HeyApiClient {
+  /**
+   * Create 3D scene
+   *
+   * Assemble a 3D scene with the Substance 3D API.
+   */
+  assemble<ThrowOnError extends boolean = false>(options?: Options<V1ScenesAssembleData, ThrowOnError>): RequestResult<V1ScenesAssembleResponses, V1ScenesAssembleErrors, ThrowOnError, "fields">;
+  /**
+   * Convert 3D files
+   *
+   * Convert a 3D file into another 3D format with the Substance 3D API.
+   */
+  convert<ThrowOnError extends boolean = false>(options?: Options<V1ScenesConvertData, ThrowOnError>): RequestResult<V1ScenesConvertResponses, V1ScenesConvertErrors, ThrowOnError, "fields">;
+  /**
+   * Describe 3D scene
+   *
+   * Describe a 3D scene.
+   */
+  describe<ThrowOnError extends boolean = false>(options?: Options<V1ScenesDescribeData, ThrowOnError>): RequestResult<V1ScenesDescribeResponses, V1ScenesDescribeErrors, ThrowOnError, "fields">;
+  /**
+   * Render 3D object
+   *
+   * Render a 3D object with the Substance 3D API.
+   */
+  render<ThrowOnError extends boolean = false>(options?: Options<V1ScenesRenderData, ThrowOnError>): RequestResult<V1ScenesRenderResponses, V1ScenesRenderErrors, ThrowOnError, "fields">;
+  /**
+   * Render 3D object (basic version)
+   *
+   * Render a 3D object (basic version) with the Substance 3D API.
+   */
+  renderBasic<ThrowOnError extends boolean = false>(options?: Options<V1ScenesRenderBasicData, ThrowOnError>): RequestResult<V1ScenesRenderBasicResponses, V1ScenesRenderBasicErrors, ThrowOnError, "fields">;
+}
+declare class V1 extends HeyApiClient {
+  private _composites?;
+  get composites(): Composites;
+  private _scenes?;
+  get scenes(): Scenes;
+}
+declare class Substance3Dsdk extends HeyApiClient {
+  static readonly __registry: HeyApiRegistry<Substance3Dsdk>;
+  constructor(args?: {
+    client?: Client;
+    key?: string;
+  });
+  /**
+   * Create Space
+   *
+   * Create a Space from 3D files.
+   */
+  createSpaceV1<ThrowOnError extends boolean = false>(options: Options<CreateSpaceV1Data, ThrowOnError>): RequestResult<CreateSpaceV1Responses, CreateSpaceV1Errors, ThrowOnError, "fields">;
+  private _v1?;
+  get v1(): V1;
+}
+//#endregion
+export { type ClientOptions, Composites, type CreateSpaceV1Data, type CreateSpaceV1Error, type CreateSpaceV1Errors, type CreateSpaceV1Response, type CreateSpaceV1Responses, type FfapierrorsFfapiError, type FfapierrorsFfapiErrorDetail, type FfapierrorsFfapiErrorWritable, type Options, type RestBaseMountedSource, type RestBaseSourceFrameIo, type RestBaseSourceFrameIov4, type RestBaseSourceSpace, type RestBaseSourceUrl, type RestBaseSpace, type RestBaseSpaceFile, type RestBaseSpaceWritable, type Restv1BetaComposeOutput, type Restv1BetaComposeOutputImage, type Restv1BetaComposeSceneJobResult, type Restv1BetaComposeSceneJobResultWritable, type Restv1BetaComposeSceneRequest, type Restv1BetaComposeSceneRequestWritable, type Restv1BetaComposeSceneResponse, type Restv1BetaComposeSceneResponseWritable, type Restv1BetaCreateSceneJobResult, type Restv1BetaCreateSceneJobResultWritable, type Restv1BetaCreateSceneRequest, type Restv1BetaCreateSceneRequestWritable, type Restv1BetaCreateSceneResponse, type Restv1BetaCreateSceneResponseWritable, type Restv1BetaModelConvertJobResult, type Restv1BetaModelConvertJobResultWritable, type Restv1BetaModelConvertRequest, type Restv1BetaModelConvertRequestWritable, type Restv1BetaModelConvertResponse, type Restv1BetaModelConvertResponseWritable, type Restv1BetaRenderModelRequest, type Restv1BetaRenderModelRequestWritable, type Restv1BetaRenderModelResponse, type Restv1BetaRenderModelResponseWritable, type Restv1BetaRenderModelTurntableRequest, type Restv1BetaRenderModelTurntableRequestWritable, type Restv1BetaRenderModelTurntableResponse, type Restv1BetaRenderModelTurntableResponseWritable, type Restv1BetaRenderSceneJobResult, type Restv1BetaRenderSceneJobResultWritable, type Restv1BetaRenderSceneRequest, type Restv1BetaRenderSceneRequestWritable, type Restv1BetaRenderSceneResponse, type Restv1BetaRenderSceneResponseWritable, type Restv1BetaRenderSceneTurntableJobResult, type Restv1BetaRenderSceneTurntableJobResultWritable, type Restv1BetaSceneDescJobResult, type Restv1BetaSceneDescRequest, type Restv1BetaSceneDescRequestWritable, type Restv1BetaSceneDescResponse, type Restv1BetaSceneDescResponseWritable, type Restv1ComposeSceneRequest, type Restv1ComposeSceneRequestWritable, Scenes, Substance3Dsdk, type TypesAutoFramingOptions, type TypesAzimuthAltitude, type TypesBackgroundOptions, type TypesCameraStats, type TypesComposeEnvironment, type TypesComposeSceneCustomModel, type TypesComposeSceneSceneDetails, type TypesExportMasksOptions, type TypesFormatOptions, type TypesGroundPlaneOptions, type TypesIdsMapData, type TypesMaskNameToFileBinding, type TypesMaterial, type TypesMaterialAssign, type TypesMaterialOverride, type TypesNameToColorBinding, type TypesOutputSize, type TypesRenderExtraOutputs, type TypesRotation, type TypesSbsMaterial, type TypesSceneBaseFile, type TypesSceneCamera, type TypesSceneDescription, type TypesSceneEnvironment, type TypesSceneModel, type TypesSceneModels, type TypesSceneStatsBoundingBox, type TypesSceneStatsInfo, type TypesSceneStatsNode, type TypesSceneStatsNodeVariant, type TypesShadowCatchingMaterial, type TypesSimpleSceneDescription, type TypesSizeOptions, type TypesSolidColorMaterial, type TypesTransform, type TypesTrs, type TypesUsdOptions, type TypesUsdVariant, type TypesWarning, V1, type V1CompositesComposeData, type V1CompositesComposeError, type V1CompositesComposeErrors, type V1CompositesComposeResponse, type V1CompositesComposeResponses, type V1ScenesAssembleData, type V1ScenesAssembleError, type V1ScenesAssembleErrors, type V1ScenesAssembleResponse, type V1ScenesAssembleResponses, type V1ScenesConvertData, type V1ScenesConvertError, type V1ScenesConvertErrors, type V1ScenesConvertResponse, type V1ScenesConvertResponses, type V1ScenesDescribeData, type V1ScenesDescribeError, type V1ScenesDescribeErrors, type V1ScenesDescribeResponse, type V1ScenesDescribeResponses, type V1ScenesRenderBasicData, type V1ScenesRenderBasicError, type V1ScenesRenderBasicErrors, type V1ScenesRenderBasicResponse, type V1ScenesRenderBasicResponses, type V1ScenesRenderData, type V1ScenesRenderError, type V1ScenesRenderErrors, type V1ScenesRenderResponse, type V1ScenesRenderResponses };
+//# sourceMappingURL=sdk.d.mts.map