User Models

Users models for ABConnect API.

class ABConnect.api.models.users.CreateUserModel(**data)[source]

Bases: ActiveModel

CreateUserModel model

login: str

contact_id: int

full_name: str

email: str

email_confirmed: Optional[bool]

password: str

lockout_date_utc: Optional[datetime]

lockout_enabled: Optional[bool]

company_id: Optional[str]

role: str

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ABConnect.api.models.users.PocUser(**data)[source]

Bases: ABConnectBaseModel

POC User model for GET /users/pocusers response.

Simple model containing just id and name.

id: Optional[int]

name: Optional[str]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ABConnect.api.models.users.UserInfo(**data)[source]

Bases: IdentifiedModel

UserInfo model

login: Optional[str]

full_name: Optional[str]

contact_id: Optional[int]

contact_display_id: Optional[str]

contact_company_name: Optional[str]

contact_company_id: Optional[str]

contact_company_display_id: Optional[str]

email: Optional[str]

email_confirmed: Optional[bool]

contact_phone: Optional[str]

contact_email: Optional[str]

password: Optional[str]

lockout_date_utc: Optional[datetime]

lockout_enabled: Optional[bool]

role: Optional[str]

is_active: Optional[bool]

legacy_id: Optional[str]

additional_user_companies: Optional[List[str]]

additional_user_companies_names: Optional[List[str]]

crm_contact_id: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ABConnect.api.models.users.Users(**data)[source]

Bases: TimestampedModel

Users model

row_id: Optional[int]

total_rows: Optional[int]

user_name: Optional[str]

password: Optional[str]

user_expiration_date: Optional[datetime]

dashboard_user_id: Optional[str]

company_id: Optional[str]

has_access: Optional[bool]

is_active: Optional[bool]

dashboard_id: Optional[str]

results: Optional[str]

role_id: Optional[str]

user_company_id: Optional[str]

company_type: Optional[str]

corporate_company_id: Optional[str]

usersystem_log_id: Optional[int]

ip_address: Optional[str]

user_id: Optional[str]

login_time: Optional[datetime]

logout_time: Optional[datetime]

create_by: Optional[str]

company_name: Optional[str]

company_code: Optional[str]

name: Optional[str]

from_date: Optional[datetime]

to_date: Optional[datetime]

sorting_direction: Optional[str]

sorting_by: Optional[str]

page_size: Optional[int]

page_number: Optional[int]

country_name: Optional[str]

pricing_to_use: Optional[str]

parent_company_id: Optional[str]

crm_contact_id: Optional[int]

model_config: ClassVar[ConfigDict] = {'extra': 'forbid', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_assignment': True, 'validate_by_alias': True, 'validate_by_name': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].