@musallam/ffs-firefly-client 1.0.0 → 2.0.0

package/dist/flat.d.cts

@@ -1,4 +1,4 @@
-import { n as Options$2, t as ky } from "./index-B2PznWi7.cjs";
+import ky, { Options as Options$1 } from "ky";
 
 //#region packages/firefly/src/flat/core/auth.gen.d.ts
 type AuthToken = string | undefined;
@@ -187,6 +187,7 @@ type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> =
 };
 //#endregion
 //#region packages/firefly/src/flat/client/utils.gen.d.ts
+declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Headers;
 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>;
@@ -204,6 +205,7 @@ interface Middleware<Req, Res, Err, Options> {
   request: Interceptors<ReqInterceptor<Req, Options>>;
   response: Interceptors<ResInterceptor<Res, Req, Options>>;
 }
+declare const createConfig: <T extends ClientOptions$1 = ClientOptions$1>(override?: Config<Omit<ClientOptions$1, keyof T> & T>) => Config<Omit<ClientOptions$1, keyof T> & T>;
 //#endregion
 //#region packages/firefly/src/flat/client/types.gen.d.ts
 type ResponseStyle = 'data' | 'fields';
@@ -227,7 +229,7 @@ interface RetryOptions {
    */
   statusCodes?: number[];
 }
-interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<Options$2, 'body' | 'headers' | 'method' | 'prefixUrl' | 'retry' | 'throwHttpErrors'>, Config$1 {
+interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<Options$1, 'body' | 'headers' | 'method' | 'prefixUrl' | 'retry' | 'throwHttpErrors'>, Config$1 {
   /**
    * Base URL for all requests made by this client.
    */
@@ -241,7 +243,7 @@ interface Config<T extends ClientOptions$1 = ClientOptions$1> extends Omit<Optio
    * 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'>;
+  kyOptions?: Omit<Options$1, '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.
@@ -322,7 +324,7 @@ type BuildUrlFn = <TData extends {
   path?: Record<string, unknown>;
   query?: Record<string, unknown>;
   url: string;
-}>(options: TData & Options$1<TData>) => string;
+}>(options: TData & Options$2<TData>) => string;
 type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
   interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
 };
@@ -334,7 +336,10 @@ interface TDataShape {
   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'>);
+type Options$2<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/firefly/src/flat/client/client.gen.d.ts
+declare const createClient: (config?: Config) => Client;
 //#endregion
 //#region packages/firefly/src/flat/types.gen.d.ts
 type ClientOptions = {
@@ -372,6 +377,10 @@ type ApiError = {
    */
   validation_errors?: Array<ValidationErrorMessage>;
 };
+/**
+ * AspectRatio
+ */
+type AspectRatio = '1:1' | '4:3' | '3:4' | '16:9' | '9:16';
 /**
  * ApiErrorGeneric
  *
@@ -535,8 +544,19 @@ type ValidationErrorDetail = {
     [key: string]: unknown;
   };
 };
+/**
+ * ValidationErrorCode422
+ *
+ * Error code for HTTP 422 responses (request validation only).
+ */
+type ValidationErrorCode422 = 'validation_error' | 'cai_assertion_violation_error';
+/**
+ * ValidationErrorResponse
+ *
+ * Error response body for HTTP 422 (validation failures).
+ */
 type ValidationErrorResponse = {
-  error_code?: string;
+  error_code: ValidationErrorCode422;
   /**
    * Human-readable error description.
    */
@@ -546,6 +566,24 @@ type ValidationErrorResponse = {
    */
   validation_errors?: Array<ValidationErrorDetail>;
 };
+/**
+ * ContentPolicyErrorCode451
+ *
+ * Error code for HTTP 451 responses (content policy, legal, or safety).
+ */
+type ContentPolicyErrorCode451 = 'legal_error' | 'prompt_unsafe' | 'prompt_entity_denied' | 'image_unsafe' | 'video_unsafe' | 'reference_image_unsafe_error' | 'input_media_unsafe';
+/**
+ * ContentPolicyErrorResponse
+ *
+ * Error response body for HTTP 451 (content policy, legal, or safety).
+ */
+type ContentPolicyErrorResponse = {
+  error_code: ContentPolicyErrorCode451;
+  /**
+   * Human-readable error description.
+   */
+  message?: string;
+};
 /**
  * JobOutput
  *
@@ -619,7 +657,10 @@ type JobSucceededPayload = {
    * The job ID.
    */
   jobId: string;
-  result: JobResult;
+  /**
+   * The result of the completed job. The schema depends on the async operation (for example generation, composite, or upscale).
+   */
+  result: JobResult | CreativeUpsamplerResponse;
 };
 /**
  * PublicBinary-Output
@@ -682,6 +723,34 @@ type AsyncApiErrorV3 = {
    */
   validation_errors?: Array<ValidationErrorMessage>;
 };
+/**
+ * AsyncTaskLink
+ */
+type AsyncTaskLink = {
+  /**
+   * Href
+   */
+  href: string;
+};
+/**
+ * AsyncTaskLinkType
+ */
+type AsyncTaskLinkType = 'cancel' | 'result';
+/**
+ * AsyncTaskResponse
+ *
+ * Response type for async requests.
+ */
+type AsyncTaskResponse = {
+  /**
+   * Links
+   */
+  links: { [key in AsyncTaskLinkType]?: AsyncTaskLink };
+  /**
+   * Progress
+   */
+  progress?: number;
+};
 /**
  * AsyncTaskResponseV3
  */
@@ -714,10 +783,101 @@ type AsyncTaskResponseV3 = {
  */
 type BaseInputImageV3 = {
   /**
-   * Source image that Firefly expands, fills or uses to generate similar images.
+   * Source image that Firefly expands, fills, uses to generate similar images, or upscales (beta).
    */
   source: PublicBinaryInputV3;
 };
+/**
+ * CreativeUpscaleAcceptResponseV3
+ *
+ * Response for async upscale requests (beta). Use links.result.href to poll for status and links.cancel.href to cancel.
+ */
+type CreativeUpscaleAcceptResponseV3 = {
+  /**
+   * Links to cancel and to fetch the job status or result.
+   */
+  links: {
+    [key: string]: CreativeUpscaleTaskLink;
+  };
+  /**
+   * Progress percentage when available (for example when polling status).
+   */
+  progress?: number;
+};
+/**
+ * CreativeUpscaleTaskLink
+ */
+type CreativeUpscaleTaskLink = {
+  /**
+   * URL for the cancel or result endpoint.
+   */
+  href: string;
+};
+/**
+ * CreativeUpsamplerRequestV3
+ *
+ * Request body for upscaling an image (beta). Provide the input image via uploadId from storage or a presigned URL. Seeds are required for reproducible results.
+ */
+type CreativeUpsamplerRequestV3 = {
+  /**
+   * The input image for the upsampler (source uploadId or url).
+   */
+  image: BaseInputImageV3;
+  /**
+   * The seed for each variation. Provide one seed per output (1–4 seeds).
+   */
+  seeds: Array<number>;
+  /**
+   * The upscale factor (2, 3, 4, or 6). Output dimensions are input dimensions multiplied by this factor.
+   */
+  upscaleFactor?: UpsampleFactor;
+};
+/**
+ * CreativeUpsamplerResponse
+ *
+ * Upscale result (beta). Each item in outputs is a storage reference for an upscaled image.
+ */
+type CreativeUpsamplerResponse = {
+  /**
+   * The list of upscaled images (storage items).
+   */
+  outputs: Array<UpscaleBinaryOutput>;
+  /**
+   * The version of the upscale feature.
+   */
+  version: string;
+};
+/**
+ * Supported upscale factors. Output size equals input size multiplied by this factor.
+ */
+type UpsampleFactor = 2 | 3 | 4 | 6;
+/**
+ * UpscaleBinaryOutput
+ *
+ * Reference to output binary (for example an upscaled image). Use id in subsequent API calls or the presigned URL to download.
+ */
+type UpscaleBinaryOutput = {
+  /**
+   * The internal ID for a storage item.
+   */
+  id?: string;
+  /**
+   * URL to download the file. Expires in one hour.
+   */
+  presignedUrl?: string;
+  /**
+   * Optional ID of the file in ACP. Must be an ACP File asset ID.
+   */
+  creativeCloudFileId?: string;
+  /**
+   * Optional ID of the component in ACP. Must be an ACP Component asset ID.
+   */
+  creativeCloudComponentId?: string;
+  /**
+   * Optional name for the item (for example for lookup in multipart responses).
+   */
+  name?: string;
+};
 /**
  * BaseInputMaskV3
  */
@@ -915,6 +1075,10 @@ type FillImageResponseV3 = {
    */
   size: Size;
 };
+/**
+ * FireflyModelId
+ */
+type FireflyModelId = 'firefly_image';
 /**
  * Generating images from prompt
  */
@@ -968,6 +1132,98 @@ type GenerateImagesRequestV3 = {
    */
   visualIntensity?: number;
 };
+/**
+ * ImageGenerateRequestV3
+ */
+type ImageGenerateRequestV3 = {
+  /**
+   * The prompt
+   *
+   * The prompt used to generate the image. The longer the prompt, the better.
+   */
+  prompt: string;
+  /**
+   * The aspect ratio of the requested generations. This controls the size of the generated image.
+   */
+  aspectRatio?: AspectRatio;
+  /**
+   * The specific model to use for image generation. Available options: 'firefly_image' for Firefly Image model.
+   */
+  modelId?: FireflyModelId;
+  /**
+   * Additional model-specific parameters for controlling the generation process.
+   */
+  modelSpecificPayload?: ModelSpecificPayloadV3;
+  /**
+   * The number of variations
+   *
+   * The number of image variations to generate. Greater than 1 is not supported. Only one image per variation is allowed. For multiple variations, send separate requests.
+   */
+  numVariations?: number;
+  /**
+   * Reference blobs
+   *
+   * List of reference blobs that will be used as additional input for the generation process. Only one reference image is supported. [Pre-signed URLs can be used from supported domains](https://developer.adobe.com/firefly-services/docs/firefly-api/getting-started/usage-notes/#image-api-usage).
+   */
+  referenceBlobs?: Array<ReferenceBlobV3>;
+  /**
+   * The seeds for the generations
+   *
+   * The seed value to vary the image generation. Only one seed per variation is allowed. If specified alongside with numVariations, the number of seeds must be equal to numVariations.
+   */
+  seeds?: Array<number>;
+};
+/**
+ * ModelSpecificPayloadV3
+ *
+ * Model-specific payload parameters for V3 generation workflows.
+ */
+type ModelSpecificPayloadV3 = {
+  /**
+   * The locale code used for image generations
+   *
+   * The locale code (following RFC 5646 format, e.g., 'en-US') will be used to generate content that is more relevant for user's country and language.
+   */
+  localeCode?: string;
+};
+/**
+ * ReferenceBlobV3
+ *
+ * Reference blob for V3 API. Style Guide compliant: The 'source' property specifies the input location, and other properties like 'usage' are peers of 'source'.
+ */
+type ReferenceBlobV3 = {
+  /**
+   * The source location of the reference image.
+   */
+  source: ReferenceBlobSourceV3;
+  /**
+   * The usage of the reference blob. Available options: 'general' for general reference.
+   */
+  usage?: ReferenceBlobUsageV3;
+};
+/**
+ * ReferenceBlobSourceV3
+ *
+ * Source specification for a reference blob input asset. Input images must meet these requirements: file size must be 10 MB or less; image area must be between 512×512 and 2048×2048 pixels (inclusive); aspect ratio must be between 1:5 and 5:1 (inclusive).
+ */
+type ReferenceBlobSourceV3 = {
+  /**
+   * Upload ID
+   *
+   * The ID of an asset previously uploaded to the Firefly Upload Image API.
+   */
+  uploadId?: string;
+  /**
+   * URL
+   *
+   * URL of the reference image. Presigned URLs are not supported for Image5; images must be uploaded to Adobe storage.
+   */
+  url?: string;
+};
+/**
+ * ReferenceBlobUsageV3
+ */
+type ReferenceBlobUsageV3 = 'general';
 /**
  * Generating images from prompt
  */
@@ -1698,7 +1954,7 @@ type GenerateImagesV3AsyncErrors = {
   /**
    * Unprocessable Entity
    */
-  422: ApiError;
+  422: ValidationErrorResponse;
   /**
    * Too Many Requests
    */
@@ -1716,6 +1972,88 @@ type GenerateImagesV3AsyncResponses = {
   202: AsyncAcceptResponseV3;
 };
 type GenerateImagesV3AsyncResponse = GenerateImagesV3AsyncResponses[keyof GenerateImagesV3AsyncResponses];
+type FireflyImageV5GenerateAsyncV4Data = {
+  body: ImageGenerateRequestV3;
+  headers: {
+    /**
+     * The model version to use for image generation.
+     */
+    'x-model-version': 'image5';
+  };
+  path?: never;
+  query?: never;
+  url: '/v4/images/generate-async';
+};
+type FireflyImageV5GenerateAsyncV4Errors = {
+  /**
+   * Bad Request
+   */
+  400: ApiError;
+  /**
+   * Unauthorized
+   */
+  401: ApiError;
+  /**
+   * Forbidden
+   */
+  403: ApiError;
+  /**
+   * Requested Resource Was Not Found
+   */
+  404: ApiError;
+  /**
+   * Request Timeout
+   */
+  408: ApiError;
+  /**
+   * Conflict
+   */
+  409: ApiError;
+  /**
+   * Gone
+   */
+  410: ApiError;
+  /**
+   * Unsupported Media Type
+   */
+  415: ApiError;
+  /**
+   * Unprocessable Entity
+   */
+  422: ValidationErrorResponse;
+  /**
+   * Too Many Requests
+   */
+  429: ApiError;
+  /**
+   * Unavailable For Legal Reasons
+   */
+  451: ContentPolicyErrorResponse;
+  /**
+   * Client Closed Request
+   */
+  499: ApiError;
+  /**
+   * Internal Server Error
+   */
+  500: ApiError;
+  /**
+   * Not Implemented
+   */
+  501: ApiError;
+  /**
+   * Service Unavailable
+   */
+  503: ApiError;
+};
+type FireflyImageV5GenerateAsyncV4Error = FireflyImageV5GenerateAsyncV4Errors[keyof FireflyImageV5GenerateAsyncV4Errors];
+type FireflyImageV5GenerateAsyncV4Responses = {
+  /**
+   * Success
+   */
+  200: AsyncTaskResponse;
+};
+type FireflyImageV5GenerateAsyncV4Response = FireflyImageV5GenerateAsyncV4Responses[keyof FireflyImageV5GenerateAsyncV4Responses];
 type GenerateSimilarImagesV3AsyncData = {
   body: GenerateSimilarImagesRequestV3;
   headers?: {
@@ -1752,7 +2090,7 @@ type GenerateSimilarImagesV3AsyncErrors = {
   /**
    * Unprocessable Entity
    */
-  422: ApiError;
+  422: ValidationErrorResponse;
   /**
    * Too Many Requests
    */
@@ -1800,7 +2138,7 @@ type ExpandImagesV3AsyncErrors = {
   /**
    * Unprocessable Entity
    */
-  422: ApiError;
+  422: ValidationErrorResponse;
   /**
    * Too Many Requests
    */
@@ -1848,7 +2186,7 @@ type FillImagesV3AsyncErrors = {
   /**
    * Unprocessable Entity
    */
-  422: ApiError;
+  422: ValidationErrorResponse;
   /**
    * Too Many Requests
    */
@@ -1892,7 +2230,7 @@ type GenerateObjectCompositeV3AsyncErrors = {
   /**
    * Unprocessable Entity
    */
-  422: ApiError;
+  422: ValidationErrorResponse;
   /**
    * Too Many Requests
    */
@@ -1926,7 +2264,7 @@ type PreciseCompositeErrors = {
   /**
    * Bad Request
    */
-  400: ValidationErrorResponse;
+  400: ApiErrorGeneric;
   /**
    * Unauthorized
    */
@@ -1935,10 +2273,18 @@ type PreciseCompositeErrors = {
    * Forbidden
    */
   403: ApiErrorGeneric;
+  /**
+   * Unprocessable Entity
+   */
+  422: ValidationErrorResponse;
   /**
    * Too Many Requests
    */
   429: ApiErrorGeneric;
+  /**
+   * Unavailable For Legal Reasons
+   */
+  451: ContentPolicyErrorResponse;
   /**
    * Internal Server Error
    */
@@ -1972,7 +2318,7 @@ type AdaptiveCompositeErrors = {
   /**
    * Bad Request
    */
-  400: ValidationErrorResponse;
+  400: ApiErrorGeneric;
   /**
    * Unauthorized
    */
@@ -1981,10 +2327,18 @@ type AdaptiveCompositeErrors = {
    * Forbidden
    */
   403: ApiErrorGeneric;
+  /**
+   * Unprocessable Entity
+   */
+  422: ValidationErrorResponse;
   /**
    * Too Many Requests
    */
   429: ApiErrorGeneric;
+  /**
+   * Unavailable For Legal Reasons
+   */
+  451: ContentPolicyErrorResponse;
   /**
    * Internal Server Error
    */
@@ -2002,6 +2356,60 @@ type AdaptiveCompositeResponses = {
   202: AsyncJobResponse;
 };
 type AdaptiveCompositeResponse = AdaptiveCompositeResponses[keyof AdaptiveCompositeResponses];
+type CreativeUpsamplerV3AsyncData = {
+  body: CreativeUpsamplerRequestV3;
+  headers?: {
+    /**
+     * Model version for the upscale operation. Use creative_upsampler_v1.
+     */
+    'x-model-version'?: string;
+  };
+  path?: never;
+  query?: never;
+  url: '/v3/images/upscale';
+};
+type CreativeUpsamplerV3AsyncErrors = {
+  /**
+   * Bad Request
+   */
+  400: ValidationErrorResponse;
+  /**
+   * Unauthorized
+   */
+  401: ApiErrorGeneric;
+  /**
+   * Forbidden
+   */
+  403: ApiErrorGeneric;
+  /**
+   * Requested Resource Was Not Found
+   */
+  404: ApiErrorGeneric;
+  /**
+   * Input Validation Error
+   */
+  422: ValidationErrorResponse;
+  /**
+   * Too Many Requests
+   */
+  429: ApiErrorGeneric;
+  /**
+   * Internal Server Error
+   */
+  500: ApiErrorGeneric;
+  /**
+   * Service Unavailable
+   */
+  503: ApiErrorGeneric;
+};
+type CreativeUpsamplerV3AsyncError = CreativeUpsamplerV3AsyncErrors[keyof CreativeUpsamplerV3AsyncErrors];
+type CreativeUpsamplerV3AsyncResponses = {
+  /**
+   * Accepted
+   */
+  202: CreativeUpscaleAcceptResponseV3;
+};
+type CreativeUpsamplerV3AsyncResponse = CreativeUpsamplerV3AsyncResponses[keyof CreativeUpsamplerV3AsyncResponses];
 type GenerateVideoV3Data = {
   /**
    * The request body for the video generation.
@@ -2037,7 +2445,7 @@ type GenerateVideoV3Errors = {
   /**
    * Unprocessable Entity
    */
-  422: ApiError;
+  422: ValidationErrorResponse;
   /**
    * Too Many Requests
    */
@@ -2124,7 +2532,7 @@ type GetCustomModelsResponses = {
 type GetCustomModelsResponse = GetCustomModelsResponses[keyof GetCustomModelsResponses];
 type StorageImageV2Data = {
   /**
-   * The PNG/JPEG/WEBP image to be stored (binary data). The maximum file size supported for uploading an image is 15MB.
+   * The PNG, JPEG, WEBP, TIFF, or JXL image to be stored (binary data). The maximum file size supported for uploading an image is 15MB.
    */
   body: Blob | File;
   path?: never;
@@ -2151,7 +2559,7 @@ type StorageImageV2Errors = {
   /**
    * Unavailable for Legal Reasons
    */
-  451: ErrorBody;
+  451: ContentPolicyErrorResponse;
   /**
    * Internal Server Error
    */
@@ -2171,7 +2579,7 @@ type JobResultV3Data = {
     /**
      * Job ID
      *
-     * The job ID to retrieve status for.
+     * The job ID or URN returned in async response links.
      */
     jobId: string;
   };
@@ -2194,7 +2602,7 @@ type JobResultV3Errors = {
   /**
    * Unprocessable Entity
    */
-  422: ApiErrorGeneric;
+  422: ValidationErrorResponse;
   /**
    * Too Many Requests
    */
@@ -2222,7 +2630,7 @@ type CancelJobV4Data = {
     /**
      * Job ID
      *
-     * The job ID to cancel.
+     * The job ID or URN returned in async response links.
      */
     jobId: string;
   };
@@ -2272,7 +2680,7 @@ type CancelJobV4Responses = {
 };
 //#endregion
 //#region packages/firefly/src/flat/sdk.gen.d.ts
-type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$1<TData, ThrowOnError> & {
+type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options$2<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
@@ -2291,6 +2699,12 @@ type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean
  * Generate images based on a text prompt. You may also include a reference image and Firefly will try to mimic the characteristics, such as color scheme, lighting, layout of objects in the image, etc.
  */
 declare const generateImagesV3Async: <ThrowOnError extends boolean = false>(options: Options<GenerateImagesV3AsyncData, ThrowOnError>) => RequestResult<GenerateImagesV3AsyncResponses, GenerateImagesV3AsyncErrors, ThrowOnError, "fields">;
+/**
+ * Generate images with Image5
+ *
+ * Generate images asynchronously using Firefly's Image5 model.
+ */
+declare const fireflyImageV5GenerateAsyncV4: <ThrowOnError extends boolean = false>(options: Options<FireflyImageV5GenerateAsyncV4Data, ThrowOnError>) => RequestResult<FireflyImageV5GenerateAsyncV4Responses, FireflyImageV5GenerateAsyncV4Errors, ThrowOnError, "fields">;
 /**
  * Generate similar images
  *
@@ -2327,6 +2741,12 @@ declare const preciseComposite: <ThrowOnError extends boolean = false>(options:
  * Submits an asynchronous adaptive composite generation job using the adaptive composite pipeline.
  */
 declare const adaptiveComposite: <ThrowOnError extends boolean = false>(options: Options<AdaptiveCompositeData, ThrowOnError>) => RequestResult<AdaptiveCompositeResponses, AdaptiveCompositeErrors, ThrowOnError, "fields">;
+/**
+ * Upscale image (beta)
+ *
+ * Upscales an image asynchronously using the creative upsampler (beta). Provide the input image via an upload ID from the storage API or a presigned URL. The response includes links to check status and retrieve the result. Poll the status URL until the job completes, then fetch the result for the upscaled image(s).
+ */
+declare const creativeUpsamplerV3Async: <ThrowOnError extends boolean = false>(options: Options<CreativeUpsamplerV3AsyncData, ThrowOnError>) => RequestResult<CreativeUpsamplerV3AsyncResponses, CreativeUpsamplerV3AsyncErrors, ThrowOnError, "fields">;
 /**
  * Generate video
  *
@@ -2342,13 +2762,13 @@ declare const getCustomModels: <ThrowOnError extends boolean = false>(options: O
 /**
  * Upload image
  *
- * Upload source image or mask for image-to-image operations, such as fill, expand. This API returns an identifier that is used to refer to uploaded content. The uploaded assets will be valid for 7 days from the date you upload them.
+ * Upload source image or mask for image-to-image operations, such as fill, expand, or upscale (beta). This API returns an identifier that is used to refer to uploaded content. The uploaded assets will be valid for 7 days from the date you upload them.
  */
 declare const storageImageV2: <ThrowOnError extends boolean = false>(options: Options<StorageImageV2Data, ThrowOnError>) => RequestResult<StorageImageV2Responses, StorageImageV2Errors, ThrowOnError, "fields">;
 /**
  * Get job status
  *
- * Get the status of an asynchronous job.
+ * Get the status of an asynchronous job (including upscale jobs). When the job has completed successfully, the result reflects the operation type (for example generation, composite, or upscale).
  */
 declare const jobResultV3: <ThrowOnError extends boolean = false>(options: Options<JobResultV3Data, ThrowOnError>) => RequestResult<JobResultV3Responses, JobResultV3Errors, ThrowOnError, "fields">;
 /**
@@ -2358,5 +2778,8 @@ declare const jobResultV3: <ThrowOnError extends boolean = false>(options: Optio
  */
 declare const cancelJobV4: <ThrowOnError extends boolean = false>(options: Options<CancelJobV4Data, ThrowOnError>) => RequestResult<CancelJobV4Responses, CancelJobV4Errors, ThrowOnError, "fields">;
 //#endregion
-export { type AdaptiveCompositeData, type AdaptiveCompositeError, type AdaptiveCompositeErrors, type AdaptiveCompositeRequest, type AdaptiveCompositeResponse, type AdaptiveCompositeResponses, type AdaptiveObjectInput, type AlignmentHorizontal, type AlignmentVertical, type ApiError, type ApiErrorGeneric, type AsyncAcceptResponseV3, type AsyncApiErrorV3, type AsyncJobResponse, type AsyncResponseV3, type AsyncResult, type AsyncTaskResponseV3, type BackgroundInput, type BaseInputImageV3, type BaseInputMaskV3, type BaseModel, type BodyExpandImagesV3Async, type BodyFillImagesV3Async, type BodyGenerateImagesV3Async, type BodyGenerateObjectCompositeV3Async, type BodyGenerateSimilarImagesV3Async, type CameraMotion, type CancelJobV4Data, type CancelJobV4Error, type CancelJobV4Errors, type CancelJobV4Responses, type ClientOptions, type ClinetoSize, type ColligoAsyncCancelErrorCodeV3, type ColligoErrorCodeAsyncV3, type ColliogAsyncStatusErrorCodeV3, type ContentClassV3, type CustomModelFf3pInfo, type CustomModelsFf3pInfo, type ErrorBody, type ErrorResponse, type ExpandImageRequestV3, type ExpandImageResponseV3, type ExpandImagesV3AsyncData, type ExpandImagesV3AsyncError, type ExpandImagesV3AsyncErrors, type ExpandImagesV3AsyncResponse, type ExpandImagesV3AsyncResponses, type FillImageRequestV3, type FillImageResponseV3, type FillImagesV3AsyncData, type FillImagesV3AsyncError, type FillImagesV3AsyncErrors, type FillImagesV3AsyncResponse, type FillImagesV3AsyncResponses, type GenerateImagesRequestV3, type GenerateImagesResponseV3, type GenerateImagesV3AsyncData, type GenerateImagesV3AsyncError, type GenerateImagesV3AsyncErrors, type GenerateImagesV3AsyncResponse, type GenerateImagesV3AsyncResponses, type GenerateObjectCompositeRequestV3, type GenerateObjectCompositeResponseV3, type GenerateObjectCompositeV3AsyncData, type GenerateObjectCompositeV3AsyncError, type GenerateObjectCompositeV3AsyncErrors, type GenerateObjectCompositeV3AsyncResponse, type GenerateObjectCompositeV3AsyncResponses, type GenerateSimilarImagesRequestV3, type GenerateSimilarImagesResponseV3, type GenerateSimilarImagesV3AsyncData, type GenerateSimilarImagesV3AsyncError, type GenerateSimilarImagesV3AsyncErrors, type GenerateSimilarImagesV3AsyncResponse, type GenerateSimilarImagesV3AsyncResponses, type GenerateVideoRequestV3, type GenerateVideoV3Data, type GenerateVideoV3Error, type GenerateVideoV3Errors, type GenerateVideoV3Response, type GenerateVideoV3Responses, type GetCustomModelsData, type GetCustomModelsError, type GetCustomModelsErrors, type GetCustomModelsResponse, type GetCustomModelsResponses, type HttpValidationError, type ImageConditionV3, type ImageRef, type ImageSource, type InputImageV3, type InputImageVideoV3, type InputMaskV3, type JobOutput, type JobPollPayload, type JobResponse, type JobResult, type JobResultV3Data, type JobResultV3Error, type JobResultV3Errors, type JobResultV3Response, type JobResultV3Responses, type JobSucceededPayload, type Link, type Links, type ObjectInput, type Options, type OutputImageV3, type OutputSpec, type PageSpec, type Placement, type PlacementAlignment, type PlacementInset, type PlacementStart, type PreciseCompositeData, type PreciseCompositeError, type PreciseCompositeErrors, type PreciseCompositeRequest, type PreciseCompositeResponse, type PreciseCompositeResponses, type PublicBinaryInputV3, type PublicBinaryOutput, type PublicBinaryOutputV3, type ShotAngle, type ShotSize, type Size, type StorageImage, type StorageImageResponse, type StorageImageV2Data, type StorageImageV2Error, type StorageImageV2Errors, type StorageImageV2Response, type StorageImageV2Responses, type StructureImageReferenceV3, type StructureReferenceV3, type StylesImageReferenceV3, type StylesV3, type ValidationError, type ValidationErrorDetail, type ValidationErrorMessage, type ValidationErrorResponse, type VideoOutput, type VideoPromptStyle, type VideoResult, type VideoSettingsV3, adaptiveComposite, cancelJobV4, expandImagesV3Async, fillImagesV3Async, generateImagesV3Async, generateObjectCompositeV3Async, generateSimilarImagesV3Async, generateVideoV3, getCustomModels, jobResultV3, preciseComposite, storageImageV2 };
+//#region packages/firefly/src/flat/client.gen.d.ts
+declare const client: Client;
+//#endregion
+export { type AdaptiveCompositeData, type AdaptiveCompositeError, type AdaptiveCompositeErrors, type AdaptiveCompositeRequest, type AdaptiveCompositeResponse, type AdaptiveCompositeResponses, type AdaptiveObjectInput, type AlignmentHorizontal, type AlignmentVertical, type ApiError, type ApiErrorGeneric, type AspectRatio, type AsyncAcceptResponseV3, type AsyncApiErrorV3, type AsyncJobResponse, type AsyncResponseV3, type AsyncResult, type AsyncTaskLink, type AsyncTaskLinkType, type AsyncTaskResponse, type AsyncTaskResponseV3, type BackgroundInput, type BaseInputImageV3, type BaseInputMaskV3, type BaseModel, type BodyExpandImagesV3Async, type BodyFillImagesV3Async, type BodyGenerateImagesV3Async, type BodyGenerateObjectCompositeV3Async, type BodyGenerateSimilarImagesV3Async, type CameraMotion, type CancelJobV4Data, type CancelJobV4Error, type CancelJobV4Errors, type CancelJobV4Responses, type ClientOptions, type ClinetoSize, type ColligoAsyncCancelErrorCodeV3, type ColligoErrorCodeAsyncV3, type ColliogAsyncStatusErrorCodeV3, type ContentClassV3, type ContentPolicyErrorCode451, type ContentPolicyErrorResponse, type CreativeUpsamplerRequestV3, type CreativeUpsamplerResponse, type CreativeUpsamplerV3AsyncData, type CreativeUpsamplerV3AsyncError, type CreativeUpsamplerV3AsyncErrors, type CreativeUpsamplerV3AsyncResponse, type CreativeUpsamplerV3AsyncResponses, type CreativeUpscaleAcceptResponseV3, type CreativeUpscaleTaskLink, type CustomModelFf3pInfo, type CustomModelsFf3pInfo, type ErrorBody, type ErrorResponse, type ExpandImageRequestV3, type ExpandImageResponseV3, type ExpandImagesV3AsyncData, type ExpandImagesV3AsyncError, type ExpandImagesV3AsyncErrors, type ExpandImagesV3AsyncResponse, type ExpandImagesV3AsyncResponses, type FillImageRequestV3, type FillImageResponseV3, type FillImagesV3AsyncData, type FillImagesV3AsyncError, type FillImagesV3AsyncErrors, type FillImagesV3AsyncResponse, type FillImagesV3AsyncResponses, type FireflyImageV5GenerateAsyncV4Data, type FireflyImageV5GenerateAsyncV4Error, type FireflyImageV5GenerateAsyncV4Errors, type FireflyImageV5GenerateAsyncV4Response, type FireflyImageV5GenerateAsyncV4Responses, type FireflyModelId, type GenerateImagesRequestV3, type GenerateImagesResponseV3, type GenerateImagesV3AsyncData, type GenerateImagesV3AsyncError, type GenerateImagesV3AsyncErrors, type GenerateImagesV3AsyncResponse, type GenerateImagesV3AsyncResponses, type GenerateObjectCompositeRequestV3, type GenerateObjectCompositeResponseV3, type GenerateObjectCompositeV3AsyncData, type GenerateObjectCompositeV3AsyncError, type GenerateObjectCompositeV3AsyncErrors, type GenerateObjectCompositeV3AsyncResponse, type GenerateObjectCompositeV3AsyncResponses, type GenerateSimilarImagesRequestV3, type GenerateSimilarImagesResponseV3, type GenerateSimilarImagesV3AsyncData, type GenerateSimilarImagesV3AsyncError, type GenerateSimilarImagesV3AsyncErrors, type GenerateSimilarImagesV3AsyncResponse, type GenerateSimilarImagesV3AsyncResponses, type GenerateVideoRequestV3, type GenerateVideoV3Data, type GenerateVideoV3Error, type GenerateVideoV3Errors, type GenerateVideoV3Response, type GenerateVideoV3Responses, type GetCustomModelsData, type GetCustomModelsError, type GetCustomModelsErrors, type GetCustomModelsResponse, type GetCustomModelsResponses, type HttpValidationError, type ImageConditionV3, type ImageGenerateRequestV3, type ImageRef, type ImageSource, type InputImageV3, type InputImageVideoV3, type InputMaskV3, type JobOutput, type JobPollPayload, type JobResponse, type JobResult, type JobResultV3Data, type JobResultV3Error, type JobResultV3Errors, type JobResultV3Response, type JobResultV3Responses, type JobSucceededPayload, type Link, type Links, type ModelSpecificPayloadV3, type ObjectInput, type Options, type OutputImageV3, type OutputSpec, type PageSpec, type Placement, type PlacementAlignment, type PlacementInset, type PlacementStart, type PreciseCompositeData, type PreciseCompositeError, type PreciseCompositeErrors, type PreciseCompositeRequest, type PreciseCompositeResponse, type PreciseCompositeResponses, type PublicBinaryInputV3, type PublicBinaryOutput, type PublicBinaryOutputV3, type ReferenceBlobSourceV3, type ReferenceBlobUsageV3, type ReferenceBlobV3, type ShotAngle, type ShotSize, type Size, type StorageImage, type StorageImageResponse, type StorageImageV2Data, type StorageImageV2Error, type StorageImageV2Errors, type StorageImageV2Response, type StorageImageV2Responses, type StructureImageReferenceV3, type StructureReferenceV3, type StylesImageReferenceV3, type StylesV3, type UpsampleFactor, type UpscaleBinaryOutput, type ValidationError, type ValidationErrorCode422, type ValidationErrorDetail, type ValidationErrorMessage, type ValidationErrorResponse, type VideoOutput, type VideoPromptStyle, type VideoResult, type VideoSettingsV3, adaptiveComposite, cancelJobV4, client, createClient, createConfig, creativeUpsamplerV3Async, expandImagesV3Async, fillImagesV3Async, fireflyImageV5GenerateAsyncV4, generateImagesV3Async, generateObjectCompositeV3Async, generateSimilarImagesV3Async, generateVideoV3, getCustomModels, jobResultV3, mergeHeaders, preciseComposite, storageImageV2 };
 //# sourceMappingURL=flat.d.cts.map