@scenario-labs/sdk 0.1.2

package/resources/usages.d.ts

@@ -0,0 +1,760 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Usages extends APIResource {
+    /**
+     * Provide usage data for the given filters. Such as consumed compute units, number
+     * of assets generated, etc. Maximum time range with custom startDate and endDate
+     * is 120 days. Granularity is calculated based on the time range.
+     */
+    list(query?: UsageListParams | null | undefined, options?: RequestOptions): APIPromise<UsageListResponse>;
+}
+export interface UsageListResponse {
+    activity?: Array<UsageListResponse.Activity>;
+    consumption?: Array<UsageListResponse.Consumption>;
+    entities?: UsageListResponse.Entities;
+    modelUsages?: Array<UsageListResponse.ModelUsage>;
+    usages?: Array<UsageListResponse.Usage>;
+}
+export declare namespace UsageListResponse {
+    /**
+     * Activity entries listed in the activities results order by time DESC Default
+     * limit of 100 entries. If you have 100 entries in your result, you can use the
+     * activityOffset parameter to get the next page of results. We recommend you to
+     * make the same request with type=activity only (to avoid reload everything) And
+     * apply the activityOffset=100 to get the next page of results. Contains basic
+     * infos about each relevant actions
+     */
+    interface Activity {
+        /**
+         * The action name
+         */
+        action: 'asset' | 'asset-privacy' | 'background-removal' | 'captioning' | 'collection' | 'collection-assets' | 'collection-models' | 'controlnet' | 'controlnet-img2img' | 'controlnet-inpaint' | 'controlnet-ip-adapter' | 'controlnet-texture' | 'copy-asset' | 'copy-model' | 'creative-unit-cost' | 'creative-unit-discount' | 'custom' | 'delete-asset' | 'delete-collection' | 'delete-collection-assets' | 'delete-collection-models' | 'delete-inference-image' | 'delete-model' | 'delete-model-preset' | 'delete-oscu-auto-refill' | 'delete-project-member' | 'delete-subscription' | 'delete-team-api-key' | 'delete-team-invitations' | 'delete-team-member' | 'delete-training-images' | 'describe-style' | 'detection' | 'download-assets' | 'download-model' | 'embed' | 'generative-fill' | 'image-prompt-editing' | 'images-generation' | 'img2img' | 'img2img-ip-adapter' | 'img2img-texture' | 'inference' | 'inpaint' | 'inpaint-ip-adapter' | 'model' | 'model-preset' | 'models-training' | 'oscu' | 'patch' | 'pixelate' | 'project' | 'project-member' | 'reframe' | 'repaint' | 'restyle' | 'segmentation' | 'skybox-base-360' | 'skybox-upscale-360' | 'start-train' | 'subscription' | 'subscription-seats' | 'tag-asset' | 'tag-model' | 'team-api-key' | 'team-member' | 'texture' | 'train-succeeded' | 'training-images-to-model' | 'transfer-model' | 'txt2img' | 'txt2img-ip-adapter' | 'update-asset' | 'update-collection' | 'update-model' | 'update-model-description' | 'update-model-examples' | 'update-oscu-auto-refill' | 'update-project' | 'update-subscription' | 'update-team' | 'update-team-member' | 'upscale' | 'vectorization';
+        /**
+         * The additional data of the action
+         */
+        data: Activity.Data;
+        /**
+         * The projectId of the project for this action
+         */
+        projectId: string;
+        /**
+         * The UTC ISO date of the point
+         */
+        time: string;
+        /**
+         * The unique identifier of the user for this action
+         */
+        userId: string;
+        /**
+         * The Compute Units cost for this action
+         */
+        creativeUnitsCost?: number;
+    }
+    namespace Activity {
+        /**
+         * The additional data of the action
+         */
+        interface Data {
+            /**
+             * The asset for this action
+             */
+            assetId?: string;
+            /**
+             * The collection for this action
+             */
+            collectionId?: string;
+            /**
+             * Whether the action is an API key action
+             */
+            isApiKey?: boolean;
+            /**
+             * The job for this action
+             */
+            jobId?: string;
+            /**
+             * The model for this action
+             */
+            modelId?: string;
+        }
+    }
+    /**
+     * Consumption entries sorted in descending order by consumption value.
+     *
+     * There is no limit on the number of entries
+     */
+    interface Consumption {
+        /**
+         * The unique identifier of the user
+         */
+        userId: string;
+        /**
+         * The Compute Units consumption for the user
+         */
+        value: number;
+    }
+    interface Entities {
+        assets?: Array<Entities.Asset>;
+        collections?: Array<Entities.Collection>;
+        jobs?: Array<Entities.Job>;
+        models?: Array<Entities.Model>;
+        users?: Array<Entities.User>;
+    }
+    namespace Entities {
+        interface Asset {
+            /**
+             * The asset ID
+             */
+            id: string;
+            /**
+             * The kind of the asset
+             */
+            kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+            /**
+             * Partial metadata of the asset
+             */
+            metadata: Asset.Metadata;
+            /**
+             * The properties of the asset
+             */
+            properties: Asset.Properties;
+            /**
+             * The source of the asset
+             */
+            source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video2img' | 'video2video';
+        }
+        namespace Asset {
+            /**
+             * Partial metadata of the asset
+             */
+            interface Metadata {
+                /**
+                 * The type of the asset
+                 */
+                type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video2img' | 'video2video';
+            }
+            /**
+             * The properties of the asset
+             */
+            interface Properties {
+                size: number;
+                /**
+                 * Number of animation frames if animations exist
+                 */
+                animationFrameCount?: number;
+                /**
+                 * Bitrate of the media in bits per second
+                 */
+                bitrate?: number;
+                /**
+                 * Number of bones if skeleton exists
+                 */
+                boneCount?: number;
+                /**
+                 * Number of channels of the audio
+                 */
+                channels?: number;
+                /**
+                 * Classification of the audio
+                 */
+                classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
+                /**
+                 * Codec name of the media
+                 */
+                codecName?: string;
+                /**
+                 * Description of the audio
+                 */
+                description?: string;
+                /**
+                 * Bounding box dimensions [width, height, depth]
+                 */
+                dimensions?: Array<unknown>;
+                /**
+                 * Duration of the media in seconds
+                 */
+                duration?: number;
+                /**
+                 * Number of faces/triangles in the mesh
+                 */
+                faceCount?: number;
+                /**
+                 * Format of the mesh file (e.g. 'glb', etc.)
+                 */
+                format?: string;
+                /**
+                 * Frame rate of the video in frames per second
+                 */
+                frameRate?: number;
+                /**
+                 * Whether the mesh has animations
+                 */
+                hasAnimations?: boolean;
+                /**
+                 * Whether the mesh has normal vectors
+                 */
+                hasNormals?: boolean;
+                /**
+                 * Whether the mesh has bones/skeleton
+                 */
+                hasSkeleton?: boolean;
+                /**
+                 * Whether the mesh has UV coordinates
+                 */
+                hasUVs?: boolean;
+                height?: number;
+                /**
+                 * Number of frames in the video
+                 */
+                nbFrames?: number;
+                /**
+                 * Sample rate of the media in Hz
+                 */
+                sampleRate?: number;
+                /**
+                 * Transcription of the audio
+                 */
+                transcription?: Properties.Transcription;
+                /**
+                 * Number of vertices in the mesh
+                 */
+                vertexCount?: number;
+                width?: number;
+            }
+            namespace Properties {
+                /**
+                 * Transcription of the audio
+                 */
+                interface Transcription {
+                    text: string;
+                }
+            }
+        }
+        interface Collection {
+            /**
+             * The collection ID
+             */
+            id: string;
+            /**
+             * The name of the collection
+             */
+            name: string;
+        }
+        interface Job {
+            /**
+             * The job ID
+             */
+            id: string;
+            /**
+             * The job type
+             */
+            jobType: 'assets-download' | 'canvas-export' | 'caption' | 'caption-llava' | 'custom' | 'describe-style' | 'detection' | 'embed' | 'flux' | 'flux-model-training' | 'generate-prompt' | 'image-generation' | 'image-prompt-editing' | 'inference' | 'mesh-preview-rendering' | 'model-download' | 'model-import' | 'model-training' | 'openai-image-generation' | 'patch-image' | 'pixelate' | 'reframe' | 'remove-background' | 'repaint' | 'restyle' | 'segment' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-upscale-360' | 'texture' | 'translate' | 'upload' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'vectorize' | 'workflow';
+            /**
+             * The metadata of the job
+             */
+            metadata: Job.Metadata;
+            /**
+             * The status of the job
+             */
+            status: 'canceled' | 'failure' | 'finalizing' | 'in-progress' | 'pending' | 'queued' | 'success' | 'warming-up';
+        }
+        namespace Job {
+            /**
+             * The metadata of the job
+             */
+            interface Metadata {
+                /**
+                 * List of produced assets for this job
+                 */
+                assetIds?: Array<string>;
+                /**
+                 * The flow of the job. Only available for workflow jobs.
+                 */
+                flow?: Array<Metadata.Flow>;
+                /**
+                 * The inputs for the job
+                 */
+                input?: unknown;
+                /**
+                 * The output of the job
+                 */
+                output?: unknown;
+                /**
+                 * The workflow ID of the job if job is part of a workflow.
+                 */
+                workflowId?: string;
+                /**
+                 * The workflow job ID of the job if job is part of a workflow job.
+                 */
+                workflowJobId?: string;
+            }
+            namespace Metadata {
+                interface Flow {
+                    /**
+                     * The id of the node.
+                     */
+                    id: string;
+                    /**
+                     * The status of the node. Only available for WorkflowJob nodes.
+                     */
+                    status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+                    /**
+                     * The type of the job for the node.
+                     */
+                    type: 'custom-model' | 'generate-prompt' | 'logic' | 'remove-background' | 'transform' | 'user-approval' | 'workflow';
+                    /**
+                     * List of produced assets for this node.
+                     */
+                    assets?: Array<Flow.Asset>;
+                    /**
+                     * The nodes that this node depends on. Only available for nodes that have
+                     * dependencies. Mainly used for user approval nodes.
+                     */
+                    dependsOn?: Array<string>;
+                    /**
+                     * The inputs of the node.
+                     */
+                    inputs?: Array<Flow.Input>;
+                    /**
+                     * If the flow is part of a WorkflowJob, this is the jobId for the node. jobId is
+                     * only available for nodes started. A node "Pending" for a running workflow job is
+                     * not started.
+                     */
+                    jobId?: string;
+                    /**
+                     * The logic of the node. Only available for logic nodes.
+                     */
+                    logic?: Flow.Logic;
+                    /**
+                     * The type of the logic for the node. Only available for logic nodes.
+                     */
+                    logicType?: 'if-else';
+                    /**
+                     * The model id for the node. Mainly used for custom model tasks.
+                     */
+                    modelId?: string;
+                    /**
+                     * The workflow id for the node. Mainly used for workflow tasks.
+                     */
+                    workflowId?: string;
+                }
+                namespace Flow {
+                    interface Asset {
+                        assetId: string;
+                        url: string;
+                    }
+                    /**
+                     * This is used to run the flow.
+                     */
+                    interface Input {
+                        /**
+                         * The name that must be user to call the model through the API
+                         */
+                        name: string;
+                        /**
+                         * The data type of the input
+                         */
+                        type: 'boolean' | 'file' | 'file_array' | 'inputs_array' | 'model' | 'model_array' | 'number' | 'number_array' | 'string' | 'string_array';
+                        /**
+                         * The allowed values for the input. For \`string\` or \`number\` types, creates a
+                         * single-select dropdown. For \`string_array\` type, creates a multi-select
+                         * dropdown.
+                         */
+                        allowedValues?: Array<unknown>;
+                        /**
+                         * Specifies the background behavior for the input. Only available for \`file\` and
+                         * \`file_array\` input types with kind \`image\`.
+                         */
+                        backgroundBehavior?: 'opaque' | 'transparent';
+                        /**
+                         * Whether the input is a color or not. Only available for \`string\` input type.
+                         */
+                        color?: boolean;
+                        /**
+                         * Whether this input affects the model's cost calculation
+                         */
+                        costImpact?: boolean;
+                        /**
+                         * Help text displayed in the UI to provide additional information about the input
+                         */
+                        description?: string;
+                        /**
+                         * Used to visually group inputs together in the UI. Inputs with the same group
+                         * value appear consecutively in the UI.
+                         */
+                        group?: string;
+                        /**
+                         * Hint text displayed in the UI as a tooltip to guide the user
+                         */
+                        hint?: string;
+                        /**
+                         * The list of inputs which form an object within a container array. All inputs are
+                         * the same as the current object. This is only available for type inputs_array
+                         * inputs.
+                         */
+                        inputs?: Array<unknown>;
+                        /**
+                         * The asset kind of the input. Only taken into account for \`file\` and
+                         * \`file_array\` input types.
+                         */
+                        kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+                        /**
+                         * The label displayed in the UI for this input
+                         */
+                        label?: string;
+                        /**
+                         * The name of the file input field to use as the mask source
+                         */
+                        maskFrom?: string;
+                        /**
+                         * The maximum allowed value. Only available for \`number\` and \`array\` input
+                         * types.
+                         */
+                        max?: number;
+                        /**
+                         * The maximum allowed length for \`string\` inputs. Also applies to each item in
+                         * \`string_array\`.
+                         */
+                        maxLength?: number;
+                        /**
+                         * The minimum allowed value. Only available for \`number\` and array input types.
+                         */
+                        min?: number;
+                        /**
+                         * The minimum allowed length for string inputs. Also applies to each item in
+                         * \`string_array\`.
+                         */
+                        minLength?: number;
+                        /**
+                         * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
+                         * available for \`model_array\` input type.
+                         */
+                        modelTypes?: Array<'custom' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux1.1-pro' | 'gpt-image-1' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora'>;
+                        /**
+                         * Whether this input represents a parent asset to assign to the produced assets.
+                         * Only available for \`file\` and \`file_array\` input types.
+                         *
+                         * For \`file_array\`, the parent asset is the first item in the array.
+                         */
+                        parent?: boolean;
+                        /**
+                         * Placeholder text for the input. Only available for 'string' input type.
+                         */
+                        placeholder?: string;
+                        /**
+                         * Whether the input is a prompt. When true, displays as a text area with prompt
+                         * spark feature. Only available for \`string\` input type.
+                         */
+                        prompt?: boolean;
+                        /**
+                         * Whether the input is used with prompt spark. Only available for \`string\` input
+                         * type.
+                         */
+                        promptSpark?: boolean;
+                        /**
+                         * The reference to another input or output of the same workflow. Must have at
+                         * least one of node or conditional.
+                         */
+                        ref?: Input.Ref;
+                        /**
+                         * Set of rules that describes when this input is required:
+                         *
+                         * - \`always\`: Input is always required
+                         * - \`ifNotDefined\`: Input is required when another specified input is not
+                         *   defined
+                         * - \`ifDefined\`: Input is required when another specified input is defined
+                         * - \`conditionalValues\`: Input is required when another input has a specific
+                         *   value
+                         *
+                         * By default, the input is not required.
+                         */
+                        required?: Input.Required;
+                        /**
+                         * The step increment for numeric inputs. Only available for \`number\` input type.
+                         */
+                        step?: number;
+                    }
+                    namespace Input {
+                        /**
+                         * The reference to another input or output of the same workflow. Must have at
+                         * least one of node or conditional.
+                         */
+                        interface Ref {
+                            /**
+                             * The conditional nodes to reference. If the conditional nodes are successful, the
+                             * node will be successful. If the conditional nodes are skipped, the node will be
+                             * skipped. Contains an array of node ids used to check the status of the nodes.
+                             */
+                            conditional?: Array<string>;
+                            /**
+                             * This is the desired node output value if ref is an if/else node.
+                             */
+                            equal?: string;
+                            /**
+                             * The name of the input or output to reference. If the type is 'workflow', the
+                             * name is the name of the input of the workflow is required If the type is 'node',
+                             * the name is not mandatory, except if you want all outputs of the node. To get
+                             * all outputs of a node, you can use the name 'all'.
+                             */
+                            name?: string;
+                            /**
+                             * The node id or 'workflow' if the source is a workflow input.
+                             */
+                            node?: string;
+                        }
+                        /**
+                         * Set of rules that describes when this input is required:
+                         *
+                         * - \`always\`: Input is always required
+                         * - \`ifNotDefined\`: Input is required when another specified input is not
+                         *   defined
+                         * - \`ifDefined\`: Input is required when another specified input is defined
+                         * - \`conditionalValues\`: Input is required when another input has a specific
+                         *   value
+                         *
+                         * By default, the input is not required.
+                         */
+                        interface Required {
+                            /**
+                             * Whether the input is always required
+                             */
+                            always?: boolean;
+                            /**
+                             * Makes this input required when another input has a specific value:
+                             *
+                             * - Key: name of the input to check
+                             * - Value: operation and allowed values that trigger the requirement
+                             */
+                            conditionalValues?: unknown;
+                            /**
+                             * Makes this input required when another input is defined:
+                             *
+                             * - Key: name of the input that must be defined
+                             * - Value: message to display when this input is required
+                             */
+                            ifDefined?: unknown;
+                            /**
+                             * Makes this input required when another input is not defined:
+                             *
+                             * - Key: name of the input that must be undefined
+                             * - Value: message to display when this input is required
+                             */
+                            ifNotDefined?: unknown;
+                        }
+                    }
+                    /**
+                     * The logic of the node. Only available for logic nodes.
+                     */
+                    interface Logic {
+                        /**
+                         * The cases of the logic. Only available for if/else nodes.
+                         */
+                        cases?: Array<Logic.Case>;
+                        /**
+                         * The default case of the logic. Contains the id/output of the node to execute if
+                         * no case is matched. Only available for if/else nodes.
+                         */
+                        default?: string;
+                        /**
+                         * The transform of the logic. Only available for transform nodes.
+                         */
+                        transform?: string;
+                    }
+                    namespace Logic {
+                        interface Case {
+                            condition: string;
+                            value: string;
+                        }
+                    }
+                }
+            }
+        }
+        interface Model {
+            /**
+             * The model ID
+             */
+            id: string;
+            /**
+             * The name of the model
+             */
+            name: string;
+            /**
+             * The short description of the model
+             */
+            shortDescription?: string;
+        }
+        interface User {
+            /**
+             * The user ID
+             */
+            id: string;
+            /**
+             * Whether the user is an API key
+             */
+            isApiKey: boolean;
+            /**
+             * The API key ID
+             *
+             * Will be available:
+             *
+             * - if the user is an API key
+             */
+            apiKeyId?: string;
+            /**
+             * The API key status
+             *
+             * Will be available:
+             *
+             * - if the user is an API key
+             */
+            apiKeyStatus?: 'active' | 'deleted' | 'inactive';
+            /**
+             * The user avatar
+             *
+             * Will be available:
+             *
+             * - if the user hasn't left the Scenario platform
+             * - if the user isn't an API key
+             */
+            avatar?: User.Avatar;
+            /**
+             * The email of the user
+             *
+             * Will be available:
+             *
+             * - if the user hasn't left the Scenario platform
+             * - if the user isn't an API key
+             */
+            email?: string;
+            /**
+             * The full name of the user
+             *
+             * Will be available:
+             *
+             * - if the user hasn't left the Scenario platform
+             * - if the user isn't an API key
+             */
+            fullName?: string;
+        }
+        namespace User {
+            /**
+             * The user avatar
+             *
+             * Will be available:
+             *
+             * - if the user hasn't left the Scenario platform
+             * - if the user isn't an API key
+             */
+            interface Avatar {
+                /**
+                 * ID of the asset used as thumbnail if provided, otherwise undefined
+                 */
+                assetId?: string;
+                /**
+                 * Signed URL of the assetId or free url if assetId is undefined
+                 */
+                url?: string;
+            }
+        }
+    }
+    interface ModelUsage {
+        modelId: string;
+        /**
+         * The data points
+         */
+        points: Array<ModelUsage.Point>;
+    }
+    namespace ModelUsage {
+        interface Point {
+            /**
+             * Cost for model usage
+             */
+            cost: number;
+            /**
+             * The discount for model usage
+             */
+            discount: number;
+            /**
+             * Number of jobs for the model usage
+             */
+            jobs: number;
+            /**
+             * The UTC ISO date of the point
+             */
+            time: string;
+        }
+    }
+    interface Usage {
+        /**
+         * Granularity for points (example: "1d", "1h", "1m", "15m")
+         */
+        granularity: '15m' | '1d' | '1h' | '1m' | '30m' | '5m' | '7d';
+        /**
+         * The usage data points
+         */
+        points: Array<Usage.Point>;
+        /**
+         * Name of the usage points (example: "images-generation", "generators-training",
+         * "background-removal", "upscale", ...)
+         */
+        usageName: 'background-removal' | 'captioning' | 'creative-unit-cost' | 'creative-unit-discount' | 'custom' | 'detection' | 'image-prompt-editing' | 'images-generation' | 'models-training' | 'patch' | 'pixelate' | 'repaint' | 'restyle' | 'segmentation' | 'skybox-base-360' | 'skybox-upscale-360' | 'texture' | 'upscale' | 'vectorization';
+    }
+    namespace Usage {
+        interface Point {
+            /**
+             * The UTC ISO date of the point
+             */
+            time: string;
+            /**
+             * Value of the point
+             */
+            value: string;
+        }
+    }
+}
+export interface UsageListParams {
+    /**
+     * The offset for the activity data. Default is 0. If bad offset or empty, 0 will
+     * be returned. Must be a positive integer.
+     */
+    activityOffset?: string;
+    /**
+     * The end date of the usage in ISO 8601 format. If not provided, use default
+     * timeRange. If provided, startDate is required.
+     */
+    endDate?: string;
+    /**
+     * The project ids for filtering the usage data. If not provided, use all projects.
+     * Can be one or more comma separated values.
+     */
+    projectIds?: string;
+    /**
+     * The start date of the usage in ISO 8601 format. If not provided, use default
+     * timeRange. If provided, endDate is required.
+     */
+    startDate?: string;
+    /**
+     * The time range of the usage. If not provided, use default timeRange. If
+     * startDate and endDate provided, timeRange is ignored.
+     */
+    timeRange?: string;
+    /**
+     * The type of the usage data. Can be one or more comma separated values. Default
+     * is all types. If bad type or empty, all types will be returned.
+     */
+    type?: string;
+    /**
+     * The unique identifier of the user for the usage. If not provided, returns all
+     * usages for the team.
+     */
+    userId?: string;
+    /**
+     * The unique identifiers of the users for filtering the usage data. If not
+     * provided, use all users. Can be one or more comma separated values.
+     */
+    userIds?: string;
+}
+export declare namespace Usages {
+    export { type UsageListResponse as UsageListResponse, type UsageListParams as UsageListParams };
+}
+//# sourceMappingURL=usages.d.ts.map