SAMAccount

SAM model of the Account 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.account.SAMAccountMetadata(*, accountNumber: str | None = None, 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, version: str | None, **extra_data: Any)

Bases: SAMModel

Smarter API Account Manifest - Metadata class.

accountNumber: str | None

Account.metadata.accountNumber[str].

Your preassigned 12-digit account number for your Smarter Account in the format ‘####-####-####’. Read only.

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’]

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.account.SAMAccountSpecConfig(*, address1: str | None = None, address2: str | None = None, city: str | None = None, companyName: str, country: str | None = 'US', currency: str | None = 'USD', language: str | None = 'en-US', phoneNumber: str | None = None, postalCode: str | None = None, state: str | None = None, timezone: str | None = 'America/New_York', **extra_data: Any)

Bases: SAMModel

Smarter API Account Manifest Account.spec.config.

address1: str | None

Account.spec.configuration.address1[str].

The primary address for the Account.

address2: str | None

Account.spec.configuration.address2[str].

Optional. The secondary address for the Account.

city: str | None

Account.spec.configuration.city[str].

The city for the Account.

companyName: str

Account.spec.configuration.companyName[str].

The legal entity of your Smarter Account for invoicing and legal correspondence.

country: str | None

Account.spec.configuration.country[str].

The ISO 3166 country code for the Account. Default: USA.

currency: str | None

Account.spec.configuration.currency[str].

The primary ISO 4217 currency for the Account. Default: USD.

language: str | None

Account.spec.configuration.language[str].

The primary BCP 47 language tag for the Account. Default: en-US.

phoneNumber: str | None

Account.spec.configuration.phoneNumber[str].

The primary phone number for the Account.

postalCode: str | None

Account.spec.configuration.postalCode[str].

The postal code for the Account.

state: str | None

Account.spec.configuration.state[str].

The state for the Account.

timezone: str | None

Account.spec.configuration.timezone[str].

The primary IANA timezone for the Account. Default: America/New_York.

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.account.SAMDependency(*, kind: str, name: str, **extra_data: Any)

Bases: SAMModel

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

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].

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.

class smarter.models.sam.account.SAMAccountSpec(*, config: SAMAccountSpecConfig, **extra_data: Any)

Bases: SAMModel

Smarter API Account Manifest Account.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: SAMAccountSpecConfig

Account.spec.config[object].

The configuration for the Account.

class smarter.models.sam.account.SAMAccountStatus(*, adminAccount: str, created: datetime, dependencies: list[SAMDependency] | None = None, modified: datetime, recordLocator: str, **extra_data: Any)

Bases: SAMModel

Smarter API Account 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].

adminAccount: str

Account.status.adminAccount: The designated Smarter admin user for this Account.

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.

class smarter.models.sam.account.SAMAccount(*, apiVersion: str, kind: str, metadata: SAMAccountMetadata, spec: SAMAccountSpec, status: SAMAccountStatus | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API Manifest - Account.

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: SAMAccountMetadata

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

spec: SAMAccountSpec

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

status: SAMAccountStatus | None

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

Stateful status information about the Account.