Account

Smarter API Account Manifest Constants

Smarter API Manifest - Account.metadata

class smarter.apps.account.manifest.models.account.metadata.SAMAccountMetadata(*, 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>, accountNumber: str | None = None)[source]

Bases: AbstractSAMMetadataBase

Smarter API Account Manifest - Metadata class.

accountNumber: str | None
class_identifier: ClassVar[str] = 'Account.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.

Smarter API Manifest - Plugin.spec

class smarter.apps.account.manifest.models.account.spec.SAMAccountSpec(*, config: SAMAccountSpecConfig)[source]

Bases: AbstractSAMSpecBase

Smarter API Account Manifest Account.spec

class_identifier: ClassVar[str] = 'Account.spec'
config: SAMAccountSpecConfig
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.account.spec.SAMAccountSpecConfig(*, companyName: str, phoneNumber: str | None = None, address1: str | None = None, address2: str | None = None, city: str | None = None, state: str | None = None, postalCode: str | None = None, country: str = 'US', language: str = 'en-US', timezone: str = 'America/New_York', currency: str = 'USD')[source]

Bases: AbstractSAMSpecBase

Smarter API Account Manifest Account.spec.config

address1: str | None
address2: str | None
city: str | None
class_identifier: ClassVar[str] = 'Account.spec.configuration'
companyName: str
country: str
currency: str
language: str
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.

phoneNumber: str | None
postalCode: str | None
state: str | None
timezone: str
classmethod validate_country(v)[source]
classmethod validate_currency(v)[source]
classmethod validate_language(v)[source]
classmethod validate_timezone(v)[source]

Smarter API Manifest - Account.status

class smarter.apps.account.manifest.models.account.status.SAMAccountStatus(*, recordLocator: str, created: datetime, modified: datetime, adminAccount: str)[source]

Bases: AbstractSAMStatusBase

Smarter API Account Manifest - Status class.

adminAccount: str
class_identifier: ClassVar[str] = 'Account.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.

Smarter API Account Manifest

class smarter.apps.account.manifest.models.account.model.SAMAccount(*, apiVersion: str, kind: str, metadata: SAMAccountMetadata, spec: SAMAccountSpec, status: SAMAccountStatus | None = None)[source]

Bases: AbstractSAMBase

Smarter API Manifest - Account

class_identifier: ClassVar[str] = 'Account'
metadata: SAMAccountMetadata
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: SAMAccountSpec
status: SAMAccountStatus | None