@scenario-labs/sdk 0.1.2

package/resources/models/description.d.ts

@@ -0,0 +1,490 @@
+import { APIResource } from "../../core/resource.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
+export declare class Description extends APIResource {
+    /**
+     * Get the description of the given `modelId`
+     */
+    retrieve(modelID: string, query?: DescriptionRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<DescriptionRetrieveResponse>;
+    /**
+     * Update the markdown description of the given `modelId`
+     */
+    update(modelID: string, params: DescriptionUpdateParams, options?: RequestOptions): APIPromise<DescriptionUpdateResponse>;
+}
+export interface DescriptionRetrieveResponse {
+    description: DescriptionRetrieveResponse.Description;
+}
+export declare namespace DescriptionRetrieveResponse {
+    interface Description {
+        /**
+         * The list of assets referenced by the Markdown `{asset}` tag in the description.
+         */
+        assets: Array<Description.Asset>;
+        /**
+         * The list of models referenced by the Markdown `{model}` tag in the description.
+         */
+        models: Array<Description.Model>;
+        /**
+         * The markdown description of the model (ex: `# My model`). We allow the
+         * `{asset:<assetId>}` and `{model:<modelId>}` tags.
+         */
+        value: string;
+    }
+    namespace Description {
+        interface Asset {
+            /**
+             * The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+             */
+            id: string;
+            /**
+             * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+             */
+            authorId: string;
+            /**
+             * The kind of asset
+             */
+            kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+            /**
+             * The mime type of the asset (example: "image/png")
+             */
+            mimeType: string;
+            /**
+             * The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
+             * "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
+             */
+            ownerId: string;
+            /**
+             * The privacy of the asset
+             */
+            privacy: 'private' | 'public' | 'unlisted';
+            /**
+             * The properties of the asset, content may depend on the kind of asset returned
+             */
+            properties: Asset.Properties;
+            /**
+             * 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';
+            /**
+             * Signed URL to get the asset content
+             */
+            url: string;
+            /**
+             * The original file url.
+             *
+             * Contains the url of the original file. without any conversion. Only available
+             * for some specific video, audio and threeD assets. Is only specified if the given
+             * asset data has been replaced with a new file during the creation of the asset.
+             */
+            originalFileUrl?: string;
+            /**
+             * The asset's preview.
+             *
+             * Contains the assetId and the url of the preview.
+             */
+            preview?: Asset.Preview;
+            /**
+             * The asset's thumbnail.
+             *
+             * Contains the assetId and the url of the thumbnail.
+             */
+            thumbnail?: Asset.Thumbnail;
+        }
+        namespace Asset {
+            /**
+             * The properties of the asset, content may depend on the kind of asset returned
+             */
+            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;
+                }
+            }
+            /**
+             * The asset's preview.
+             *
+             * Contains the assetId and the url of the preview.
+             */
+            interface Preview {
+                assetId: string;
+                url: string;
+            }
+            /**
+             * The asset's thumbnail.
+             *
+             * Contains the assetId and the url of the thumbnail.
+             */
+            interface Thumbnail {
+                assetId: string;
+                url: string;
+            }
+        }
+        interface Model {
+            /**
+             * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+             */
+            id: string;
+            /**
+             * The privacy of the model (default: private)
+             */
+            privacy: 'private' | 'public' | 'unlisted';
+            /**
+             * The model type (example: "flux.1-lora")
+             */
+            type: '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';
+            /**
+             * The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
+             */
+            authorId?: string;
+            /**
+             * The model name (example: "Cinematic Realism")
+             */
+            name?: string;
+            /**
+             * The owner ID (example: "team_VFhihHKMRZyDDnZAJwLb2Q")
+             */
+            ownerId?: string;
+            /**
+             * The model short description (example: "This model generates highly detailed
+             * cinematic scenes.")
+             */
+            shortDescription?: string;
+        }
+    }
+}
+export interface DescriptionUpdateResponse {
+    description: DescriptionUpdateResponse.Description;
+}
+export declare namespace DescriptionUpdateResponse {
+    interface Description {
+        /**
+         * The list of assets referenced by the Markdown `{asset}` tag in the description.
+         */
+        assets: Array<Description.Asset>;
+        /**
+         * The list of models referenced by the Markdown `{model}` tag in the description.
+         */
+        models: Array<Description.Model>;
+        /**
+         * The markdown description of the model (ex: `# My model`). We allow the
+         * `{asset:<assetId>}` and `{model:<modelId>}` tags.
+         */
+        value: string;
+    }
+    namespace Description {
+        interface Asset {
+            /**
+             * The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+             */
+            id: string;
+            /**
+             * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+             */
+            authorId: string;
+            /**
+             * The kind of asset
+             */
+            kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+            /**
+             * The mime type of the asset (example: "image/png")
+             */
+            mimeType: string;
+            /**
+             * The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
+             * "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
+             */
+            ownerId: string;
+            /**
+             * The privacy of the asset
+             */
+            privacy: 'private' | 'public' | 'unlisted';
+            /**
+             * The properties of the asset, content may depend on the kind of asset returned
+             */
+            properties: Asset.Properties;
+            /**
+             * 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';
+            /**
+             * Signed URL to get the asset content
+             */
+            url: string;
+            /**
+             * The original file url.
+             *
+             * Contains the url of the original file. without any conversion. Only available
+             * for some specific video, audio and threeD assets. Is only specified if the given
+             * asset data has been replaced with a new file during the creation of the asset.
+             */
+            originalFileUrl?: string;
+            /**
+             * The asset's preview.
+             *
+             * Contains the assetId and the url of the preview.
+             */
+            preview?: Asset.Preview;
+            /**
+             * The asset's thumbnail.
+             *
+             * Contains the assetId and the url of the thumbnail.
+             */
+            thumbnail?: Asset.Thumbnail;
+        }
+        namespace Asset {
+            /**
+             * The properties of the asset, content may depend on the kind of asset returned
+             */
+            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;
+                }
+            }
+            /**
+             * The asset's preview.
+             *
+             * Contains the assetId and the url of the preview.
+             */
+            interface Preview {
+                assetId: string;
+                url: string;
+            }
+            /**
+             * The asset's thumbnail.
+             *
+             * Contains the assetId and the url of the thumbnail.
+             */
+            interface Thumbnail {
+                assetId: string;
+                url: string;
+            }
+        }
+        interface Model {
+            /**
+             * The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
+             */
+            id: string;
+            /**
+             * The privacy of the model (default: private)
+             */
+            privacy: 'private' | 'public' | 'unlisted';
+            /**
+             * The model type (example: "flux.1-lora")
+             */
+            type: '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';
+            /**
+             * The author user ID (example: "user_VFhihHKMRZyDDnZAJwLb2Q")
+             */
+            authorId?: string;
+            /**
+             * The model name (example: "Cinematic Realism")
+             */
+            name?: string;
+            /**
+             * The owner ID (example: "team_VFhihHKMRZyDDnZAJwLb2Q")
+             */
+            ownerId?: string;
+            /**
+             * The model short description (example: "This model generates highly detailed
+             * cinematic scenes.")
+             */
+            shortDescription?: string;
+        }
+    }
+}
+export interface DescriptionRetrieveParams {
+    /**
+     * If set to true, returns the original asset without transformation
+     */
+    originalAssets?: string;
+}
+export interface DescriptionUpdateParams {
+    /**
+     * Body param: The markdown description of the model (ex: `# My model`). Set to
+     * `null` to delete the description.
+     */
+    description: string;
+    /**
+     * Query param: If set to true, returns the original asset without transformation
+     */
+    originalAssets?: string;
+}
+export declare namespace Description {
+    export { type DescriptionRetrieveResponse as DescriptionRetrieveResponse, type DescriptionUpdateResponse as DescriptionUpdateResponse, type DescriptionRetrieveParams as DescriptionRetrieveParams, type DescriptionUpdateParams as DescriptionUpdateParams, };
+}
+//# sourceMappingURL=description.d.ts.map

package/resources/models/description.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"description.d.ts","sourceRoot":"","sources":["../../src/resources/models/description.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,QAAQ,CACN,OAAO,EAAE,MAAM,EACf,KAAK,GAAE,yBAAyB,GAAG,IAAI,GAAG,SAAc,EACxD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,2BAA2B,CAAC;IAI1C;;OAEG;IACH,MAAM,CACJ,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAQzC;AAED,MAAM,WAAW,2BAA2B;IAC1C,WAAW,EAAE,2BAA2B,CAAC,WAAW,CAAC;CACtD;AAED,yBAAiB,2BAA2B,CAAC;IAC3C,UAAiB,WAAW;QAC1B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAEjC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAEjC;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,WAAW,CAAC;QAC3B,UAAiB,KAAK;YACpB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,IAAI,EAAE,IAAI,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,OAAO,CAAC;YAE7E;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,OAAO,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAC;YAE3C;;eAEG;YACH,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;YAE7B;;eAEG;YACH,MAAM,EACF,OAAO,GACP,eAAe,GACf,YAAY,GACZ,mBAAmB,GACnB,qBAAqB,GACrB,gBAAgB,GAChB,mBAAmB,GACnB,sBAAsB,GACtB,aAAa,GACb,oBAAoB,GACpB,QAAQ,GACR,gBAAgB,GAChB,eAAe,GACf,WAAW,GACX,iBAAiB,GACjB,sBAAsB,GACtB,QAAQ,GACR,SAAS,GACT,WAAW,GACX,uBAAuB,GACvB,2BAA2B,GAC3B,kCAAkC,GAClC,6CAA6C,GAC7C,kCAAkC,GAClC,iCAAiC,GACjC,+BAA+B,GAC/B,eAAe,GACf,0BAA0B,GAC1B,uBAAuB,GACvB,oBAAoB,GACpB,+BAA+B,GAC/B,qBAAqB,GACrB,6BAA6B,GAC7B,eAAe,GACf,0BAA0B,GAC1B,uBAAuB,GACvB,OAAO,GACP,cAAc,GACd,SAAS,GACT,SAAS,GACT,SAAS,GACT,oBAAoB,GACpB,mBAAmB,GACnB,WAAW,GACX,iBAAiB,GACjB,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,YAAY,GACZ,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,oBAAoB,GACpB,QAAQ,GACR,WAAW,GACX,SAAS,GACT,WAAW,GACX,SAAS,GACT,UAAU,GACV,aAAa,GACb,gBAAgB,GAChB,iBAAiB,GACjB,gBAAgB,GAChB,SAAS,GACT,gBAAgB,GAChB,iBAAiB,GACjB,eAAe,GACf,eAAe,GACf,WAAW,GACX,aAAa,CAAC;YAElB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;;;;;eAMG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;;;eAIG;YACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC;YAExB;;;;eAIG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;SAC7B;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,UAAU;gBACzB,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;gBAE7B;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,cAAc,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;gBAEtG;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;gBAE5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,aAAa,CAAC,EAAE,OAAO,CAAC;gBAExB;;mBAEG;gBACH,UAAU,CAAC,EAAE,OAAO,CAAC;gBAErB;;mBAEG;gBACH,WAAW,CAAC,EAAE,OAAO,CAAC;gBAEtB;;mBAEG;gBACH,MAAM,CAAC,EAAE,OAAO,CAAC;gBAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;gBAEpB;;mBAEG;gBACH,aAAa,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC;gBAEzC;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;YAED,UAAiB,UAAU,CAAC;gBAC1B;;mBAEG;gBACH,UAAiB,aAAa;oBAC5B,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;YAED;;;;eAIG;YACH,UAAiB,OAAO;gBACtB,OAAO,EAAE,MAAM,CAAC;gBAEhB,GAAG,EAAE,MAAM,CAAC;aACb;YAED;;;;eAIG;YACH,UAAiB,SAAS;gBACxB,OAAO,EAAE,MAAM,CAAC;gBAEhB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;QAED,UAAiB,KAAK;YACpB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,OAAO,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAC;YAE3C;;eAEG;YACH,IAAI,EACA,QAAQ,GACR,QAAQ,GACR,oBAAoB,GACpB,oBAAoB,GACpB,qBAAqB,GACrB,iBAAiB,GACjB,kBAAkB,GAClB,aAAa,GACb,YAAY,GACZ,oBAAoB,GACpB,aAAa,GACb,aAAa,GACb,QAAQ,GACR,oBAAoB,GACpB,aAAa,GACb,OAAO,GACP,mBAAmB,GACnB,YAAY,CAAC;YAEjB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;;eAGG;YACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,yBAAyB,CAAC,WAAW,CAAC;CACpD;AAED,yBAAiB,yBAAyB,CAAC;IACzC,UAAiB,WAAW;QAC1B;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAEjC;;WAEG;QACH,MAAM,EAAE,KAAK,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAEjC;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,WAAW,CAAC;QAC3B,UAAiB,KAAK;YACpB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,IAAI,EAAE,IAAI,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,GAAG,WAAW,GAAG,MAAM,GAAG,OAAO,CAAC;YAE7E;;eAEG;YACH,QAAQ,EAAE,MAAM,CAAC;YAEjB;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,OAAO,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAC;YAE3C;;eAEG;YACH,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;YAE7B;;eAEG;YACH,MAAM,EACF,OAAO,GACP,eAAe,GACf,YAAY,GACZ,mBAAmB,GACnB,qBAAqB,GACrB,gBAAgB,GAChB,mBAAmB,GACnB,sBAAsB,GACtB,aAAa,GACb,oBAAoB,GACpB,QAAQ,GACR,gBAAgB,GAChB,eAAe,GACf,WAAW,GACX,iBAAiB,GACjB,sBAAsB,GACtB,QAAQ,GACR,SAAS,GACT,WAAW,GACX,uBAAuB,GACvB,2BAA2B,GAC3B,kCAAkC,GAClC,6CAA6C,GAC7C,kCAAkC,GAClC,iCAAiC,GACjC,+BAA+B,GAC/B,eAAe,GACf,0BAA0B,GAC1B,uBAAuB,GACvB,oBAAoB,GACpB,+BAA+B,GAC/B,qBAAqB,GACrB,6BAA6B,GAC7B,eAAe,GACf,0BAA0B,GAC1B,uBAAuB,GACvB,OAAO,GACP,cAAc,GACd,SAAS,GACT,SAAS,GACT,SAAS,GACT,oBAAoB,GACpB,mBAAmB,GACnB,WAAW,GACX,iBAAiB,GACjB,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,YAAY,GACZ,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,oBAAoB,GACpB,QAAQ,GACR,WAAW,GACX,SAAS,GACT,WAAW,GACX,SAAS,GACT,UAAU,GACV,aAAa,GACb,gBAAgB,GAChB,iBAAiB,GACjB,gBAAgB,GAChB,SAAS,GACT,gBAAgB,GAChB,iBAAiB,GACjB,eAAe,GACf,eAAe,GACf,WAAW,GACX,aAAa,CAAC;YAElB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;YAEZ;;;;;;eAMG;YACH,eAAe,CAAC,EAAE,MAAM,CAAC;YAEzB;;;;eAIG;YACH,OAAO,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC;YAExB;;;;eAIG;YACH,SAAS,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;SAC7B;QAED,UAAiB,KAAK,CAAC;YACrB;;eAEG;YACH,UAAiB,UAAU;gBACzB,IAAI,EAAE,MAAM,CAAC;gBAEb;;mBAEG;gBACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;gBAE7B;;mBAEG;gBACH,OAAO,CAAC,EAAE,MAAM,CAAC;gBAEjB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,cAAc,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;gBAEtG;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,UAAU,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;gBAE5B;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,aAAa,CAAC,EAAE,OAAO,CAAC;gBAExB;;mBAEG;gBACH,UAAU,CAAC,EAAE,OAAO,CAAC;gBAErB;;mBAEG;gBACH,WAAW,CAAC,EAAE,OAAO,CAAC;gBAEtB;;mBAEG;gBACH,MAAM,CAAC,EAAE,OAAO,CAAC;gBAEjB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAEhB;;mBAEG;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAElB;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;gBAEpB;;mBAEG;gBACH,aAAa,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC;gBAEzC;;mBAEG;gBACH,WAAW,CAAC,EAAE,MAAM,CAAC;gBAErB,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB;YAED,UAAiB,UAAU,CAAC;gBAC1B;;mBAEG;gBACH,UAAiB,aAAa;oBAC5B,IAAI,EAAE,MAAM,CAAC;iBACd;aACF;YAED;;;;eAIG;YACH,UAAiB,OAAO;gBACtB,OAAO,EAAE,MAAM,CAAC;gBAEhB,GAAG,EAAE,MAAM,CAAC;aACb;YAED;;;;eAIG;YACH,UAAiB,SAAS;gBACxB,OAAO,EAAE,MAAM,CAAC;gBAEhB,GAAG,EAAE,MAAM,CAAC;aACb;SACF;QAED,UAAiB,KAAK;YACpB;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,OAAO,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,CAAC;YAE3C;;eAEG;YACH,IAAI,EACA,QAAQ,GACR,QAAQ,GACR,oBAAoB,GACpB,oBAAoB,GACpB,qBAAqB,GACrB,iBAAiB,GACjB,kBAAkB,GAClB,aAAa,GACb,YAAY,GACZ,oBAAoB,GACpB,aAAa,GACb,aAAa,GACb,QAAQ,GACR,oBAAoB,GACpB,aAAa,GACb,OAAO,GACP,mBAAmB,GACnB,YAAY,CAAC;YAEjB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;YAElB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;;eAGG;YACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;SAC3B;KACF;CACF;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/models/description.js

@@ -0,0 +1,27 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Description = void 0;
+const resource_1 = require("../../core/resource.js");
+const path_1 = require("../../internal/utils/path.js");
+class Description extends resource_1.APIResource {
+    /**
+     * Get the description of the given `modelId`
+     */
+    retrieve(modelID, query = {}, options) {
+        return this._client.get((0, path_1.path) `/models/${modelID}/description`, { query, ...options });
+    }
+    /**
+     * Update the markdown description of the given `modelId`
+     */
+    update(modelID, params, options) {
+        const { originalAssets, ...body } = params;
+        return this._client.put((0, path_1.path) `/models/${modelID}/description`, {
+            query: { originalAssets },
+            body,
+            ...options,
+        });
+    }
+}
+exports.Description = Description;
+//# sourceMappingURL=description.js.map

package/resources/models/description.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"description.js","sourceRoot":"","sources":["../../src/resources/models/description.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;OAEG;IACH,QAAQ,CACN,OAAe,EACf,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,OAAe,EACf,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,WAAW,OAAO,cAAc,EAAE;YAC5D,KAAK,EAAE,EAAE,cAAc,EAAE;YACzB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA3BD,kCA2BC"}

package/resources/models/description.mjs

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../core/resource.mjs";
+import { path } from "../../internal/utils/path.mjs";
+export class Description extends APIResource {
+    /**
+     * Get the description of the given `modelId`
+     */
+    retrieve(modelID, query = {}, options) {
+        return this._client.get(path `/models/${modelID}/description`, { query, ...options });
+    }
+    /**
+     * Update the markdown description of the given `modelId`
+     */
+    update(modelID, params, options) {
+        const { originalAssets, ...body } = params;
+        return this._client.put(path `/models/${modelID}/description`, {
+            query: { originalAssets },
+            body,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=description.mjs.map

package/resources/models/description.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"description.mjs","sourceRoot":"","sources":["../../src/resources/models/description.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;OAEG;IACH,QAAQ,CACN,OAAe,EACf,QAAsD,EAAE,EACxD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,cAAc,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,MAAM,CACJ,OAAe,EACf,MAA+B,EAC/B,OAAwB;QAExB,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,WAAW,OAAO,cAAc,EAAE;YAC5D,KAAK,EAAE,EAAE,cAAc,EAAE;YACzB,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}