@scenario-labs/sdk 0.1.2

package/src/resources/assets.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './assets/index';

package/src/resources/collections/assets.ts

@@ -0,0 +1,163 @@
+// 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 Assets extends APIResource {
+  /**
+   * Add assets to a specific collection
+   */
+  add(collectionID: string, body: AssetAddParams, options?: RequestOptions): APIPromise<AssetAddResponse> {
+    return this._client.put(path`/collections/${collectionID}/assets`, { body, ...options });
+  }
+
+  /**
+   * Remove assets from a specific collection
+   */
+  remove(
+    collectionID: string,
+    body: AssetRemoveParams,
+    options?: RequestOptions,
+  ): APIPromise<AssetRemoveResponse> {
+    return this._client.delete(path`/collections/${collectionID}/assets`, { body, ...options });
+  }
+}
+
+export interface AssetAddResponse {
+  collection: AssetAddResponse.Collection;
+}
+
+export namespace AssetAddResponse {
+  export interface Collection {
+    /**
+     * The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+     */
+    id: string;
+
+    assetCount: number;
+
+    /**
+     * The collection creation date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    itemCount: number;
+
+    modelCount: number;
+
+    /**
+     * The collection name
+     */
+    name: string;
+
+    /**
+     * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    ownerId: string;
+
+    /**
+     * The collection last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    thumbnail?: Collection.Thumbnail;
+  }
+
+  export namespace Collection {
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    export interface Thumbnail {
+      assetId: string;
+
+      url: string;
+    }
+  }
+}
+
+export interface AssetRemoveResponse {
+  collection: AssetRemoveResponse.Collection;
+}
+
+export namespace AssetRemoveResponse {
+  export interface Collection {
+    /**
+     * The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+     */
+    id: string;
+
+    assetCount: number;
+
+    /**
+     * The collection creation date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    itemCount: number;
+
+    modelCount: number;
+
+    /**
+     * The collection name
+     */
+    name: string;
+
+    /**
+     * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    ownerId: string;
+
+    /**
+     * The collection last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    thumbnail?: Collection.Thumbnail;
+  }
+
+  export namespace Collection {
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    export interface Thumbnail {
+      assetId: string;
+
+      url: string;
+    }
+  }
+}
+
+export interface AssetAddParams {
+  /**
+   * The ids of the assets to add to the collection. (Max 49 at once)
+   */
+  assetIds: Array<string>;
+}
+
+export interface AssetRemoveParams {
+  /**
+   * The ids of the assets to remove from the collection. (Max 49 at once)
+   */
+  assetIds: Array<string>;
+}
+
+export declare namespace Assets {
+  export {
+    type AssetAddResponse as AssetAddResponse,
+    type AssetRemoveResponse as AssetRemoveResponse,
+    type AssetAddParams as AssetAddParams,
+    type AssetRemoveParams as AssetRemoveParams,
+  };
+}

package/src/resources/collections/collections.ts

@@ -0,0 +1,357 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as AssetsAPI from './assets';
+import { AssetAddParams, AssetAddResponse, AssetRemoveParams, AssetRemoveResponse, Assets } from './assets';
+import * as ModelsAPI from './models';
+import { ModelAddParams, ModelAddResponse, ModelRemoveParams, ModelRemoveResponse, Models } from './models';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Collections extends APIResource {
+  assets: AssetsAPI.Assets = new AssetsAPI.Assets(this._client);
+  models: ModelsAPI.Models = new ModelsAPI.Models(this._client);
+
+  /**
+   * Create a new collection
+   */
+  create(body: CollectionCreateParams, options?: RequestOptions): APIPromise<CollectionCreateResponse> {
+    return this._client.post('/collections', { body, ...options });
+  }
+
+  /**
+   * Get the details of a collection
+   */
+  retrieve(collectionID: string, options?: RequestOptions): APIPromise<CollectionRetrieveResponse> {
+    return this._client.get(path`/collections/${collectionID}`, options);
+  }
+
+  /**
+   * Update the name and/or thumbnail of a Collection
+   */
+  update(
+    collectionID: string,
+    body: CollectionUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<CollectionUpdateResponse> {
+    return this._client.put(path`/collections/${collectionID}`, { body, ...options });
+  }
+
+  /**
+   * List collections of a team
+   */
+  list(
+    query: CollectionListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CollectionListResponse> {
+    return this._client.get('/collections', { query, ...options });
+  }
+
+  /**
+   * Delete a collection
+   */
+  delete(collectionID: string, options?: RequestOptions): APIPromise<unknown> {
+    return this._client.delete(path`/collections/${collectionID}`, options);
+  }
+}
+
+export interface CollectionCreateResponse {
+  collection: CollectionCreateResponse.Collection;
+}
+
+export namespace CollectionCreateResponse {
+  export interface Collection {
+    /**
+     * The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+     */
+    id: string;
+
+    assetCount: number;
+
+    /**
+     * The collection creation date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    itemCount: number;
+
+    modelCount: number;
+
+    /**
+     * The collection name
+     */
+    name: string;
+
+    /**
+     * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    ownerId: string;
+
+    /**
+     * The collection last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    thumbnail?: Collection.Thumbnail;
+  }
+
+  export namespace Collection {
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    export interface Thumbnail {
+      assetId: string;
+
+      url: string;
+    }
+  }
+}
+
+export interface CollectionRetrieveResponse {
+  collection: CollectionRetrieveResponse.Collection;
+}
+
+export namespace CollectionRetrieveResponse {
+  export interface Collection {
+    /**
+     * The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+     */
+    id: string;
+
+    assetCount: number;
+
+    /**
+     * The collection creation date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    itemCount: number;
+
+    modelCount: number;
+
+    /**
+     * The collection name
+     */
+    name: string;
+
+    /**
+     * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    ownerId: string;
+
+    /**
+     * The collection last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    thumbnail?: Collection.Thumbnail;
+  }
+
+  export namespace Collection {
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    export interface Thumbnail {
+      assetId: string;
+
+      url: string;
+    }
+  }
+}
+
+export interface CollectionUpdateResponse {
+  collection: CollectionUpdateResponse.Collection;
+}
+
+export namespace CollectionUpdateResponse {
+  export interface Collection {
+    /**
+     * The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+     */
+    id: string;
+
+    assetCount: number;
+
+    /**
+     * The collection creation date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    itemCount: number;
+
+    modelCount: number;
+
+    /**
+     * The collection name
+     */
+    name: string;
+
+    /**
+     * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    ownerId: string;
+
+    /**
+     * The collection last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    thumbnail?: Collection.Thumbnail;
+  }
+
+  export namespace Collection {
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    export interface Thumbnail {
+      assetId: string;
+
+      url: string;
+    }
+  }
+}
+
+export interface CollectionListResponse {
+  collections: Array<CollectionListResponse.Collection>;
+
+  /**
+   * A token to query the next page of collections
+   */
+  nextPaginationToken?: string;
+}
+
+export namespace CollectionListResponse {
+  export interface Collection {
+    /**
+     * The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+     */
+    id: string;
+
+    assetCount: number;
+
+    /**
+     * The collection creation date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    itemCount: number;
+
+    modelCount: number;
+
+    /**
+     * The collection name
+     */
+    name: string;
+
+    /**
+     * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    ownerId: string;
+
+    /**
+     * The collection last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    thumbnail?: Collection.Thumbnail;
+  }
+
+  export namespace Collection {
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    export interface Thumbnail {
+      assetId: string;
+
+      url: string;
+    }
+  }
+}
+
+export type CollectionDeleteResponse = unknown;
+
+export interface CollectionCreateParams {
+  /**
+   * The name of the collection.
+   */
+  name: string;
+}
+
+export interface CollectionUpdateParams {
+  /**
+   * The new name for the Collection
+   */
+  name?: string;
+
+  /**
+   * The AssetId of the image you want to use as a thumbnail for the collection. Set
+   * to null to unset the thumbnail.
+   */
+  thumbnail?: string;
+}
+
+export interface CollectionListParams {
+  /**
+   * The number of items to return in the response. The default value is 10, 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;
+}
+
+Collections.Assets = Assets;
+Collections.Models = Models;
+
+export declare namespace Collections {
+  export {
+    type CollectionCreateResponse as CollectionCreateResponse,
+    type CollectionRetrieveResponse as CollectionRetrieveResponse,
+    type CollectionUpdateResponse as CollectionUpdateResponse,
+    type CollectionListResponse as CollectionListResponse,
+    type CollectionDeleteResponse as CollectionDeleteResponse,
+    type CollectionCreateParams as CollectionCreateParams,
+    type CollectionUpdateParams as CollectionUpdateParams,
+    type CollectionListParams as CollectionListParams,
+  };
+
+  export {
+    Assets as Assets,
+    type AssetAddResponse as AssetAddResponse,
+    type AssetRemoveResponse as AssetRemoveResponse,
+    type AssetAddParams as AssetAddParams,
+    type AssetRemoveParams as AssetRemoveParams,
+  };
+
+  export {
+    Models as Models,
+    type ModelAddResponse as ModelAddResponse,
+    type ModelRemoveResponse as ModelRemoveResponse,
+    type ModelAddParams as ModelAddParams,
+    type ModelRemoveParams as ModelRemoveParams,
+  };
+}

package/src/resources/collections/index.ts

@@ -0,0 +1,27 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Assets,
+  type AssetAddResponse,
+  type AssetRemoveResponse,
+  type AssetAddParams,
+  type AssetRemoveParams,
+} from './assets';
+export {
+  Collections,
+  type CollectionCreateResponse,
+  type CollectionRetrieveResponse,
+  type CollectionUpdateResponse,
+  type CollectionListResponse,
+  type CollectionDeleteResponse,
+  type CollectionCreateParams,
+  type CollectionUpdateParams,
+  type CollectionListParams,
+} from './collections';
+export {
+  Models,
+  type ModelAddResponse,
+  type ModelRemoveResponse,
+  type ModelAddParams,
+  type ModelRemoveParams,
+} from './models';

package/src/resources/collections/models.ts

@@ -0,0 +1,163 @@
+// 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 Models extends APIResource {
+  /**
+   * Add models to a specific collection
+   */
+  add(collectionID: string, body: ModelAddParams, options?: RequestOptions): APIPromise<ModelAddResponse> {
+    return this._client.put(path`/collections/${collectionID}/models`, { body, ...options });
+  }
+
+  /**
+   * Remove models from a specific collection
+   */
+  remove(
+    collectionID: string,
+    body: ModelRemoveParams,
+    options?: RequestOptions,
+  ): APIPromise<ModelRemoveResponse> {
+    return this._client.delete(path`/collections/${collectionID}/models`, { body, ...options });
+  }
+}
+
+export interface ModelAddResponse {
+  collection: ModelAddResponse.Collection;
+}
+
+export namespace ModelAddResponse {
+  export interface Collection {
+    /**
+     * The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+     */
+    id: string;
+
+    assetCount: number;
+
+    /**
+     * The collection creation date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    itemCount: number;
+
+    modelCount: number;
+
+    /**
+     * The collection name
+     */
+    name: string;
+
+    /**
+     * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    ownerId: string;
+
+    /**
+     * The collection last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    thumbnail?: Collection.Thumbnail;
+  }
+
+  export namespace Collection {
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    export interface Thumbnail {
+      assetId: string;
+
+      url: string;
+    }
+  }
+}
+
+export interface ModelRemoveResponse {
+  collection: ModelRemoveResponse.Collection;
+}
+
+export namespace ModelRemoveResponse {
+  export interface Collection {
+    /**
+     * The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+     */
+    id: string;
+
+    assetCount: number;
+
+    /**
+     * The collection creation date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    itemCount: number;
+
+    modelCount: number;
+
+    /**
+     * The collection name
+     */
+    name: string;
+
+    /**
+     * The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    ownerId: string;
+
+    /**
+     * The collection last update date as an ISO string (example:
+     * "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    thumbnail?: Collection.Thumbnail;
+  }
+
+  export namespace Collection {
+    /**
+     * The thumbnail for the collection (if any)
+     */
+    export interface Thumbnail {
+      assetId: string;
+
+      url: string;
+    }
+  }
+}
+
+export interface ModelAddParams {
+  /**
+   * The ids of the models to add to the collection. (Max 49 at once)
+   */
+  modelIds: Array<string>;
+}
+
+export interface ModelRemoveParams {
+  /**
+   * The ids of the models to remove from the collection. (Max 49 at once)
+   */
+  modelIds: Array<string>;
+}
+
+export declare namespace Models {
+  export {
+    type ModelAddResponse as ModelAddResponse,
+    type ModelRemoveResponse as ModelRemoveResponse,
+    type ModelAddParams as ModelAddParams,
+    type ModelRemoveParams as ModelRemoveParams,
+  };
+}

package/src/resources/collections.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './collections/index';