User

Smarter API User Manifest Constants

Smarter API Manifest - User.metadata

class smarter.apps.account.manifest.models.user.metadata.SAMUserMetadata(*, name: str, description: str | None, version: str | None, tags: List[str] | None = <factory>, annotations: List[dict[str, str | int | float | bool | ~datetime.date | ~datetime.datetime | ~decimal.Decimal | ~uuid.UUID | bytes | list | dict]] | None=<factory>, username: str)[source]

Bases: AbstractSAMMetadataBase

Smarter API User Manifest - Metadata class.

class_identifier: ClassVar[str] = 'User.metadata'
model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'from_attributes': True, 'frozen': True}

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

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Return type:

None

Parameters:
  • self – The BaseModel instance.

  • context – The context.

username: str

Smarter API Manifest - User.spec

class smarter.apps.account.manifest.models.user.spec.SAMUserSpec(*, config: SAMUserSpecConfig)[source]

Bases: AbstractSAMSpecBase

Smarter API User Manifest User.spec

class_identifier: ClassVar[str] = 'User.spec'
config: SAMUserSpecConfig
model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'from_attributes': True, 'frozen': True}

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

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Return type:

None

Parameters:
  • self – The BaseModel instance.

  • context – The context.

class smarter.apps.account.manifest.models.user.spec.SAMUserSpecConfig(*, firstName: str | None = None, lastName: str | None = None, email: str, isStaff: bool | None = False, isActive: bool)[source]

Bases: AbstractSAMSpecBase

Smarter API User Manifest User.spec.config

class_identifier: ClassVar[str] = 'User.spec.configuration'
email: str
firstName: str | None
isActive: bool
isStaff: bool | None
lastName: str | None
model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'from_attributes': True, 'frozen': True}

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

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Return type:

None

Parameters:
  • self – The BaseModel instance.

  • context – The context.

Smarter API Manifest - User.status

class smarter.apps.account.manifest.models.user.status.SAMUserStatus(*, recordLocator: str, created: datetime, modified: datetime, account_number: str, username: str)[source]

Bases: AbstractSAMStatusBase

Smarter API User Manifest - Status class.

account_number: str
class_identifier: ClassVar[str] = 'User.status'
model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'from_attributes': True, 'frozen': True}

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

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Return type:

None

Parameters:
  • self – The BaseModel instance.

  • context – The context.

username: str

Smarter API User Manifest

class smarter.apps.account.manifest.models.user.model.SAMUser(*, apiVersion: str, kind: str, metadata: SAMUserMetadata, spec: SAMUserSpec, status: SAMUserStatus | None = None)[source]

Bases: AbstractSAMBase

Smarter API Manifest - User

class_identifier: ClassVar[str] = 'User'
metadata: SAMUserMetadata
model_config: ClassVar[ConfigDict] = {'arbitrary_types_allowed': True, 'from_attributes': True, 'frozen': True}

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

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Return type:

None

Parameters:
  • self – The BaseModel instance.

  • context – The context.

spec: SAMUserSpec
status: SAMUserStatus | None