SAMUser

SAM model of the User kind, generated from the Smarter platform’s JSON Schema.

Do not edit: run scripts/generate_sam_models.py. See smarter.models.sam.

class smarter.models.sam.user.SAMDependency(*, kind: str, name: str, **extra_data: Any)

Bases: SAMModel

A resource that depends on the resource that a manifest describes.

kind: str

Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.

Read only.

name: str

Name[String]: The name of the resource that depends on this resource.

Read only.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.user.SAMUserMetadata(*, annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]] = None, description: str | None, name: str, tags: list[str] | None = None, username: str, version: str | None, **extra_data: Any)

Bases: SAMModel

Smarter API User Manifest - Metadata class.

annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]]

The manifest annotations.

Used for storing arbitrary metadata as

key-value pairs. Example: [{‘smarter.sh/test-manifest/project-name’: ‘Scooby dooby do’}]. The key should be a valid url-friendly string. The value accepts multi-line string values (YAML block scalars) and various scalar types including str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.

description: str | None

The description for this resource.

Be brief. Keep it under 255 characters.

name: str

The camelCase name of the manifest resource.

tags: list[str] | None

The tags of the manifest.

Used for generic resource categorization and search. Example: [‘tag1’, ‘tag2’]

username: str

User.metadata.username[str].

Required. The Django username of the user.

version: str | None

The semantic version of the manifest.

Example: 0.1.0

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.user.SAMUserSpecConfig(*, email: str, firstName: str | None = None, isActive: bool, isStaff: bool | None = False, lastName: str | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API User Manifest User.spec.config.

email: str

User.spec.configuration.email[str].

The email address of the User.

firstName: str | None

User.spec.configuration.firstName[str].

Optional. The first name of the User.

isActive: bool

User.spec.configuration.isActive[bool].

Designates whether this User should be treated as active.

isStaff: bool | None

User.spec.configuration.isStaff[bool].

Optional. Designates whether the User has admin permissions.

lastName: str | None

User.spec.configuration.lastName[str].

Optional. The last name of the User.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

class smarter.models.sam.user.SAMUserStatus(*, account_number: str, created: datetime, dependencies: list[SAMDependency] | None = None, modified: datetime, recordLocator: str, username: str, **extra_data: Any)

Bases: SAMModel

Smarter API User Manifest - Status class.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

account_number: str

User.status.account_number: The account owner of this User.

Read only.

created: datetime

The date in which this resource was created.

Read only.

dependencies: list[SAMDependency] | None

Dependencies[List]: The resources that depend on this resource, and that must be deleted, or stop referring to it, before it can be deleted.

Lists only the resources that you can read. Read only.

modified: datetime

The date in which this resource was most recently changed.

Read only.

recordLocator: str

RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.

Read only.

username: str

User.status.account_number: The Smarter user who created this User.

Read only.

class smarter.models.sam.user.SAMUserSpec(*, config: SAMUserSpecConfig, **extra_data: Any)

Bases: SAMModel

Smarter API User Manifest User.spec.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

config: SAMUserSpecConfig

User.spec.config[object].

The configuration for the User.

class smarter.models.sam.user.SAMUser(*, apiVersion: str, kind: str, metadata: SAMUserMetadata, spec: SAMUserSpec, status: SAMUserStatus | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API Manifest - User.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].

apiVersion: str

ApiVersion[String]: Required.

The API version of the AbstractSAMBase.

kind: str

Kind[String]: Required.

The kind of resource described by the manifest.

metadata: SAMUserMetadata

User.metadata[obj]: Required, the User metadata.

spec: SAMUserSpec

User.spec[obj]: Required, the User specification.

status: SAMUserStatus | None

User.status[obj]: Optional, Read-only.

Stateful status information about the User.