@scenario-labs/sdk 0.1.2

package/src/resources/tags.ts

@@ -0,0 +1,69 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Tags extends APIResource {
+  /**
+   * List all tags in use for the given `projectId`
+   */
+  list(query: TagListParams | null | undefined = {}, options?: RequestOptions): APIPromise<TagListResponse> {
+    return this._client.get('/tags', { query, ...options });
+  }
+}
+
+export interface TagListResponse {
+  tags: Array<TagListResponse.Tag>;
+
+  /**
+   * A token to query the next page of tags
+   */
+  nextPaginationToken?: string;
+}
+
+export namespace TagListResponse {
+  export interface Tag {
+    /**
+     * The tag creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * The number of items that have this tag
+     */
+    itemCount: number;
+
+    /**
+     * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    ownerId: string;
+
+    /**
+     * The tag name
+     */
+    tagName: string;
+
+    /**
+     * The tag last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+  }
+}
+
+export interface TagListParams {
+  /**
+   * The number of items to return in the response. The default value is 50, maximum
+   * value is 100, minimum value is 1
+   */
+  pageSize?: string;
+
+  /**
+   * A token you received in a previous request to query the next page of items
+   */
+  paginationToken?: string;
+}
+
+export declare namespace Tags {
+  export { type TagListResponse as TagListResponse, type TagListParams as TagListParams };
+}

package/src/resources/uploads.ts

@@ -0,0 +1,369 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Uploads extends APIResource {
+  /**
+   * Create a temporary upload URL for a file. Support multipart uploads. Return a
+   * list of URLs for each part of the file.
+   */
+  create(body: UploadCreateParams, options?: RequestOptions): APIPromise<UploadCreateResponse> {
+    return this._client.post('/uploads', { body, ...options });
+  }
+
+  /**
+   * Get the details of an existing upload
+   */
+  retrieve(uploadID: string, options?: RequestOptions): APIPromise<UploadRetrieveResponse> {
+    return this._client.get(path`/uploads/${uploadID}`, options);
+  }
+
+  /**
+   * Trigger an action on upload
+   */
+  triggerAction(
+    uploadID: string,
+    body: UploadTriggerActionParams,
+    options?: RequestOptions,
+  ): APIPromise<UploadTriggerActionResponse> {
+    return this._client.post(path`/uploads/${uploadID}/action`, { body, ...options });
+  }
+}
+
+export interface UploadCreateResponse {
+  upload: UploadCreateResponse.Upload;
+}
+
+export namespace UploadCreateResponse {
+  export interface Upload {
+    id: string;
+
+    authorId: string;
+
+    createdAt: string;
+
+    fileName: string;
+
+    /**
+     * The kind of the file once validated (example: "model")
+     */
+    kind: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'video';
+
+    ownerId: string;
+
+    source: 'civitai' | 'huggingface' | 'multipart' | 'other' | 'url';
+
+    status: 'complete' | 'failed' | 'imported' | 'pending' | 'validated' | 'validating';
+
+    updatedAt: string;
+
+    assetOptions?: Upload.AssetOptions;
+
+    config?: unknown;
+
+    contentType?: string;
+
+    entityId?: string;
+
+    errorMessage?: string;
+
+    fileSize?: number;
+
+    jobId?: string;
+
+    originalFileName?: string;
+
+    parts?: Array<Upload.Part>;
+
+    partsCount?: number;
+
+    provider?: 'civitai' | 'huggingface' | 'other';
+
+    url?: string;
+  }
+
+  export namespace Upload {
+    export interface AssetOptions {
+      /**
+       * The collection ids to add the asset to.
+       */
+      collectionIds?: Array<string>;
+
+      /**
+       * Specify if the asset should be hidden from the user.
+       */
+      hide?: boolean;
+
+      /**
+       * The parentId of the asset.
+       */
+      parentId?: string;
+    }
+
+    export interface Part {
+      expires: string;
+
+      number: number;
+
+      url: string;
+    }
+  }
+}
+
+export interface UploadRetrieveResponse {
+  upload: UploadRetrieveResponse.Upload;
+}
+
+export namespace UploadRetrieveResponse {
+  export interface Upload {
+    id: string;
+
+    authorId: string;
+
+    createdAt: string;
+
+    fileName: string;
+
+    /**
+     * The kind of the file once validated (example: "model")
+     */
+    kind: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'video';
+
+    ownerId: string;
+
+    source: 'civitai' | 'huggingface' | 'multipart' | 'other' | 'url';
+
+    status: 'complete' | 'failed' | 'imported' | 'pending' | 'validated' | 'validating';
+
+    updatedAt: string;
+
+    assetOptions?: Upload.AssetOptions;
+
+    config?: unknown;
+
+    contentType?: string;
+
+    entityId?: string;
+
+    errorMessage?: string;
+
+    fileSize?: number;
+
+    jobId?: string;
+
+    originalFileName?: string;
+
+    parts?: Array<Upload.Part>;
+
+    partsCount?: number;
+
+    provider?: 'civitai' | 'huggingface' | 'other';
+
+    url?: string;
+  }
+
+  export namespace Upload {
+    export interface AssetOptions {
+      /**
+       * The collection ids to add the asset to.
+       */
+      collectionIds?: Array<string>;
+
+      /**
+       * Specify if the asset should be hidden from the user.
+       */
+      hide?: boolean;
+
+      /**
+       * The parentId of the asset.
+       */
+      parentId?: string;
+    }
+
+    export interface Part {
+      expires: string;
+
+      number: number;
+
+      url: string;
+    }
+  }
+}
+
+export interface UploadTriggerActionResponse {
+  upload: UploadTriggerActionResponse.Upload;
+}
+
+export namespace UploadTriggerActionResponse {
+  export interface Upload {
+    id: string;
+
+    authorId: string;
+
+    createdAt: string;
+
+    fileName: string;
+
+    /**
+     * The kind of the file once validated (example: "model")
+     */
+    kind: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'video';
+
+    ownerId: string;
+
+    source: 'civitai' | 'huggingface' | 'multipart' | 'other' | 'url';
+
+    status: 'complete' | 'failed' | 'imported' | 'pending' | 'validated' | 'validating';
+
+    updatedAt: string;
+
+    assetOptions?: Upload.AssetOptions;
+
+    config?: unknown;
+
+    contentType?: string;
+
+    entityId?: string;
+
+    errorMessage?: string;
+
+    fileSize?: number;
+
+    jobId?: string;
+
+    originalFileName?: string;
+
+    parts?: Array<Upload.Part>;
+
+    partsCount?: number;
+
+    provider?: 'civitai' | 'huggingface' | 'other';
+
+    url?: string;
+  }
+
+  export namespace Upload {
+    export interface AssetOptions {
+      /**
+       * The collection ids to add the asset to.
+       */
+      collectionIds?: Array<string>;
+
+      /**
+       * Specify if the asset should be hidden from the user.
+       */
+      hide?: boolean;
+
+      /**
+       * The parentId of the asset.
+       */
+      parentId?: string;
+    }
+
+    export interface Part {
+      expires: string;
+
+      number: number;
+
+      url: string;
+    }
+  }
+}
+
+export interface UploadCreateParams {
+  /**
+   * Asset extra options. Only available for kinds which produce an asset. (Not
+   * available for model kind)
+   */
+  assetOptions?: UploadCreateParams.AssetOptions;
+
+  /**
+   * The civitai.com url of the model (example:
+   * "https://civitai.com/models/370194/translucent-subsurface-scattering-test?modelVersionId=413566").
+   */
+  civitaiModelUrl?: string;
+
+  /**
+   * Required for multipart upload. The MIME type of the file (example: "image/jpeg")
+   */
+  contentType?: string;
+
+  /**
+   * Required for multipart upload. The original file name of the image (example:
+   * "low-res-image.jpg"). It will be ignored if assetId is provided.
+   */
+  fileName?: string;
+
+  /**
+   * Required for multipart upload. The size of the file in bytes
+   */
+  fileSize?: number;
+
+  /**
+   * The huggingface.co modelName (example:
+   * "stabilityai/stable-diffusion-xl-base-1.0"). No need to setup other fields if
+   * you setup huggingFaceModelName
+   */
+  huggingFaceModelName?: string;
+
+  /**
+   * Required for multipart upload and url. The purpose of the file once validated
+   * (example: "model")
+   */
+  kind?: '3d' | 'asset' | 'audio' | 'avatar' | 'image' | 'model' | 'video';
+
+  /**
+   * Required for multipart upload. The number of parts the file will be uploaded in
+   */
+  parts?: number;
+
+  /**
+   * The url where to download the file. If you setup url you MUST setup kind as
+   * well.
+   */
+  url?: string;
+}
+
+export namespace UploadCreateParams {
+  /**
+   * Asset extra options. Only available for kinds which produce an asset. (Not
+   * available for model kind)
+   */
+  export interface AssetOptions {
+    /**
+     * The collection ids to add the asset to.
+     */
+    collectionIds?: Array<string>;
+
+    /**
+     * Specify if the asset should be hidden from the user.
+     */
+    hide?: boolean;
+
+    /**
+     * The parentId of the asset.
+     */
+    parentId?: string;
+  }
+}
+
+export interface UploadTriggerActionParams {
+  /**
+   * The action to perform on an upload, currently only "upload-complete" is
+   * supported
+   */
+  action: 'complete';
+}
+
+export declare namespace Uploads {
+  export {
+    type UploadCreateResponse as UploadCreateResponse,
+    type UploadRetrieveResponse as UploadRetrieveResponse,
+    type UploadTriggerActionResponse as UploadTriggerActionResponse,
+    type UploadCreateParams as UploadCreateParams,
+    type UploadTriggerActionParams as UploadTriggerActionParams,
+  };
+}