# Brief

## Delete

`teams.brief.delete(strteam_id)  -> BriefDeleteResponse`

**delete** `/teams/{teamId}/brief`

Delete the team's Quality Gate brief

### Parameters

- `team_id: str`

### Returns

- `class BriefDeleteResponse: …`

  - `deleted: bool`

### Example

```python
import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
brief = client.teams.brief.delete(
    "teamId",
)
print(brief.deleted)
```

#### Response

```json
{
  "deleted": true
}
```

## Retrieve

`teams.brief.retrieve(strteam_id)  -> BriefRetrieveResponse`

**get** `/teams/{teamId}/brief`

Get the team's Quality Gate brief

### Parameters

- `team_id: str`

### Returns

- `class BriefRetrieveResponse: …`

  - `brief: Brief`

    A brand-style / project-rules / campaign-context brief stored at one scope.

    - `id: str`

      Stable identifier derived from level + scopeId

    - `body: str`

      Free-text brief: brand style, rules, campaign context

    - `created_at: str`

      ISO-8601 creation timestamp

    - `created_by: str`

      User id that last wrote the brief

    - `enabled: bool`

      Whether the brief is applied during verification

    - `level: Literal["project", "team"]`

      Scope this brief applies to: team or project

      - `"project"`

      - `"team"`

    - `reference_asset_ids: List[str]`

      Reference assets the verifier compares the image against

    - `scope_id: str`

      The id of the team or project that owns this brief

    - `updated_at: str`

      ISO-8601 last-update timestamp

    - `sensitivity: Optional[Literal["high", "low", "medium"]]`

      Threshold strictness applied when verifying against this scope

      - `"high"`

      - `"low"`

      - `"medium"`

### Example

```python
import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
brief = client.teams.brief.retrieve(
    "teamId",
)
print(brief.brief)
```

#### Response

```json
{
  "brief": {
    "id": "id",
    "body": "body",
    "createdAt": "createdAt",
    "createdBy": "createdBy",
    "enabled": true,
    "level": "project",
    "referenceAssetIds": [
      "string"
    ],
    "scopeId": "scopeId",
    "updatedAt": "updatedAt",
    "sensitivity": "high"
  }
}
```

## Update

`teams.brief.update(strteam_id, BriefUpdateParams**kwargs)  -> BriefUpdateResponse`

**put** `/teams/{teamId}/brief`

Create or update the team's Quality Gate brief

### Parameters

- `team_id: str`

- `body: str`

  Free-text brief content

- `enabled: Optional[bool]`

  Whether the brief is applied during verification (default true)

- `reference_asset_ids: Optional[Sequence[str]]`

  Reference assets the verifier compares against (max 10). Send [] to clear.

- `sensitivity: Optional[Literal["high", "low", "medium"]]`

  Threshold strictness stored for this scope: low, medium, or high. Applied
  to verifications unless the verify call passes its own sensitivity.

  - `"high"`

  - `"low"`

  - `"medium"`

### Returns

- `class BriefUpdateResponse: …`

  - `brief: Brief`

    A brand-style / project-rules / campaign-context brief stored at one scope.

    - `id: str`

      Stable identifier derived from level + scopeId

    - `body: str`

      Free-text brief: brand style, rules, campaign context

    - `created_at: str`

      ISO-8601 creation timestamp

    - `created_by: str`

      User id that last wrote the brief

    - `enabled: bool`

      Whether the brief is applied during verification

    - `level: Literal["project", "team"]`

      Scope this brief applies to: team or project

      - `"project"`

      - `"team"`

    - `reference_asset_ids: List[str]`

      Reference assets the verifier compares the image against

    - `scope_id: str`

      The id of the team or project that owns this brief

    - `updated_at: str`

      ISO-8601 last-update timestamp

    - `sensitivity: Optional[Literal["high", "low", "medium"]]`

      Threshold strictness applied when verifying against this scope

      - `"high"`

      - `"low"`

      - `"medium"`

### Example

```python
import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
brief = client.teams.brief.update(
    team_id="teamId",
    body="x",
)
print(brief.brief)
```

#### Response

```json
{
  "brief": {
    "id": "id",
    "body": "body",
    "createdAt": "createdAt",
    "createdBy": "createdBy",
    "enabled": true,
    "level": "project",
    "referenceAssetIds": [
      "string"
    ],
    "scopeId": "scopeId",
    "updatedAt": "updatedAt",
    "sensitivity": "high"
  }
}
```

## Domain Types

### Brief Delete Response

- `class BriefDeleteResponse: …`

  - `deleted: bool`

### Brief Retrieve Response

- `class BriefRetrieveResponse: …`

  - `brief: Brief`

    A brand-style / project-rules / campaign-context brief stored at one scope.

    - `id: str`

      Stable identifier derived from level + scopeId

    - `body: str`

      Free-text brief: brand style, rules, campaign context

    - `created_at: str`

      ISO-8601 creation timestamp

    - `created_by: str`

      User id that last wrote the brief

    - `enabled: bool`

      Whether the brief is applied during verification

    - `level: Literal["project", "team"]`

      Scope this brief applies to: team or project

      - `"project"`

      - `"team"`

    - `reference_asset_ids: List[str]`

      Reference assets the verifier compares the image against

    - `scope_id: str`

      The id of the team or project that owns this brief

    - `updated_at: str`

      ISO-8601 last-update timestamp

    - `sensitivity: Optional[Literal["high", "low", "medium"]]`

      Threshold strictness applied when verifying against this scope

      - `"high"`

      - `"low"`

      - `"medium"`

### Brief Update Response

- `class BriefUpdateResponse: …`

  - `brief: Brief`

    A brand-style / project-rules / campaign-context brief stored at one scope.

    - `id: str`

      Stable identifier derived from level + scopeId

    - `body: str`

      Free-text brief: brand style, rules, campaign context

    - `created_at: str`

      ISO-8601 creation timestamp

    - `created_by: str`

      User id that last wrote the brief

    - `enabled: bool`

      Whether the brief is applied during verification

    - `level: Literal["project", "team"]`

      Scope this brief applies to: team or project

      - `"project"`

      - `"team"`

    - `reference_asset_ids: List[str]`

      Reference assets the verifier compares the image against

    - `scope_id: str`

      The id of the team or project that owns this brief

    - `updated_at: str`

      ISO-8601 last-update timestamp

    - `sensitivity: Optional[Literal["high", "low", "medium"]]`

      Threshold strictness applied when verifying against this scope

      - `"high"`

      - `"low"`

      - `"medium"`