# Models

## Add

`client.collections.models.add(stringcollectionID, ModelAddParamsbody, RequestOptionsoptions?): ModelAddResponse`

**put** `/collections/{collectionId}/models`

Add models to a specific collection

### Parameters

- `collectionID: string`

- `body: ModelAddParams`

  - `modelIds: Array<string>`

    The ids of the models to add to the collection. (Max 49 at once)

### Returns

- `ModelAddResponse`

  - `collection: Collection`

    - `id: string`

      The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")

    - `assetCount: number`

    - `createdAt: string`

      The collection creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")

    - `itemCount: number`

    - `modelCount: number`

    - `name: string`

      The collection name

    - `ownerId: string`

      The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")

    - `updatedAt: string`

      The collection last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")

    - `thumbnail?: Thumbnail`

      The thumbnail for the collection (if any)

      - `assetId: string`

      - `url: string`

### Example

```typescript
import Scenario from '@scenario-labs/sdk';

const client = new Scenario({
  apiKey: process.env['SCENARIO_SDK_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SCENARIO_SDK_API_SECRET'], // This is the default and can be omitted
});

const response = await client.collections.models.add('collectionId', { modelIds: ['string'] });

console.log(response.collection);
```

#### Response

```json
{
  "collection": {
    "id": "id",
    "assetCount": 0,
    "createdAt": "createdAt",
    "itemCount": 0,
    "modelCount": 0,
    "name": "name",
    "ownerId": "ownerId",
    "updatedAt": "updatedAt",
    "thumbnail": {
      "assetId": "assetId",
      "url": "url"
    }
  }
}
```

## Remove

`client.collections.models.remove(stringcollectionID, ModelRemoveParamsbody, RequestOptionsoptions?): ModelRemoveResponse`

**delete** `/collections/{collectionId}/models`

Remove models from a specific collection

### Parameters

- `collectionID: string`

- `body: ModelRemoveParams`

  - `modelIds: Array<string>`

    The ids of the models to remove from the collection. (Max 49 at once)

### Returns

- `ModelRemoveResponse`

  - `collection: Collection`

    - `id: string`

      The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")

    - `assetCount: number`

    - `createdAt: string`

      The collection creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")

    - `itemCount: number`

    - `modelCount: number`

    - `name: string`

      The collection name

    - `ownerId: string`

      The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")

    - `updatedAt: string`

      The collection last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")

    - `thumbnail?: Thumbnail`

      The thumbnail for the collection (if any)

      - `assetId: string`

      - `url: string`

### Example

```typescript
import Scenario from '@scenario-labs/sdk';

const client = new Scenario({
  apiKey: process.env['SCENARIO_SDK_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SCENARIO_SDK_API_SECRET'], // This is the default and can be omitted
});

const model = await client.collections.models.remove('collectionId', { modelIds: ['string'] });

console.log(model.collection);
```

#### Response

```json
{
  "collection": {
    "id": "id",
    "assetCount": 0,
    "createdAt": "createdAt",
    "itemCount": 0,
    "modelCount": 0,
    "name": "name",
    "ownerId": "ownerId",
    "updatedAt": "updatedAt",
    "thumbnail": {
      "assetId": "assetId",
      "url": "url"
    }
  }
}
```

## Domain Types

### Model Add Response

- `ModelAddResponse`

  - `collection: Collection`

    - `id: string`

      The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")

    - `assetCount: number`

    - `createdAt: string`

      The collection creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")

    - `itemCount: number`

    - `modelCount: number`

    - `name: string`

      The collection name

    - `ownerId: string`

      The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")

    - `updatedAt: string`

      The collection last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")

    - `thumbnail?: Thumbnail`

      The thumbnail for the collection (if any)

      - `assetId: string`

      - `url: string`

### Model Remove Response

- `ModelRemoveResponse`

  - `collection: Collection`

    - `id: string`

      The collection ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")

    - `assetCount: number`

    - `createdAt: string`

      The collection creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")

    - `itemCount: number`

    - `modelCount: number`

    - `name: string`

      The collection name

    - `ownerId: string`

      The owner ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")

    - `updatedAt: string`

      The collection last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")

    - `thumbnail?: Thumbnail`

      The thumbnail for the collection (if any)

      - `assetId: string`

      - `url: string`