Skip to content

Account models

Request and response types for the Account API.

account

Account API models.

Modules:

  • api

    Account API resources for sync and async clients.

  • models

Classes:

AccountError

Bases: BaseModelWithConfig

Attributes:

response instance-attribute

response: bool

AccountPasswordReset

Bases: BaseModelWithConfig

Attributes:

current_password instance-attribute

current_password: str

new_password instance-attribute

new_password: str

AccountPermissionResponse

Bases: BaseModelWithConfig

Attributes:

device instance-attribute

gateway instance-attribute

network_operator instance-attribute

network_operator: PermissionObject

subscriber_admin instance-attribute

subscriber_admin: PermissionObject

sys_admin instance-attribute

sys_admin: PermissionObject

user instance-attribute

AccountResponse

Bases: BaseModelWithConfig

Attributes:

subscriber_info instance-attribute

subscriber_info: SubscriberInfo

user_info instance-attribute

user_info: UserInfo | None

PermissionObject

Bases: BaseModelWithConfig

Attributes:

create class-attribute instance-attribute

create: bool = False

delete class-attribute instance-attribute

delete: bool = False

read class-attribute instance-attribute

read: bool = False

update class-attribute instance-attribute

update: bool = False

SubscriberInfo

Bases: BaseModelWithConfig

Attributes:

address instance-attribute

address: str

address2 instance-attribute

address2: str

city instance-attribute

city: str

country instance-attribute

country: str

id instance-attribute

id: str

name instance-attribute

name: str

postal_code instance-attribute

postal_code: str

state instance-attribute

state: str

UserInfo

Bases: BaseModelWithConfig

Attributes:

email instance-attribute

email: str

first_name instance-attribute

first_name: str

id instance-attribute

id: str

last_name instance-attribute

last_name: str

phone_number instance-attribute

phone_number: str

roles instance-attribute

roles: list[str]

username instance-attribute

username: str

UserInfoPatch

Bases: BaseModelWithConfig

Attributes:

email instance-attribute

email: str

first_name instance-attribute

first_name: str

last_name instance-attribute

last_name: str

phone_number instance-attribute

phone_number: str

UserInfoUpdate

Bases: BaseModelWithConfig

Attributes:

email instance-attribute

email: str

first_name instance-attribute

first_name: str

last_name instance-attribute

last_name: str

phone_number instance-attribute

phone_number: str | None