roboto.domain.orgs.org_records

Module Contents

class roboto.domain.orgs.org_records.OrgInviteRecord(/, **data)

Bases: pydantic.BaseModel

A wire-transmissible representation of an organization invite.

Parameters:

data (Any)

invite_id: str

Unique identifier for the invitation.

invited_by: roboto.domain.users.UserRecord

User information for the person who created the invitation.

org: OrgRecord

Organization information for the organization being invited to.

user_id: str

User ID of the person who was invited.

class roboto.domain.orgs.org_records.OrgRecord(/, **data)

Bases: pydantic.BaseModel

A wire-transmissible representation of an organization.

Parameters:

data (Any)

created: datetime.datetime

Timestamp when the organization was created.

created_by: str | None = None

User ID of the organization creator.

name: str

Human-readable name of the organization.

org_id: str

Unique identifier for the organization.

status: OrgStatus

Current operational status of the organization.

tier: OrgTier

Subscription tier of the organization.

class roboto.domain.orgs.org_records.OrgRoleName

Bases: str, enum.Enum

Organization role enumeration.

Defines the different permission levels users can have within an organization.

admin = 'admin'

Administrative role with management permissions for organization resources.

owner = 'owner'

Owner role with full control over the organization including billing and deletion.

user = 'user'

Basic user role with read access to organization resources.

class roboto.domain.orgs.org_records.OrgStatus

Bases: str, enum.Enum

Organization status enumeration.

Represents the current operational state of an organization.

Active = 'active'

Organization is fully operational and ready for use.

Deprovisioning = 'de-provisioning'

Organization is being deleted and resources are being cleaned up.

Provisioning = 'provisioning'

Organization is being set up and is not yet ready for use.

class roboto.domain.orgs.org_records.OrgTier

Bases: str, enum.Enum

Organization tier enumeration.

See our pricing page for details on different organization tiers and their associated features and limits.

free = 'free'

Free tier with basic features and usage limits.

premium = 'premium'

Premium tier with advanced features and higher usage limits.

class roboto.domain.orgs.org_records.OrgUserRecord(/, **data)

Bases: pydantic.BaseModel

A wire-transmissible representation of an organization user.

Parameters:

data (Any)

org: OrgRecord

Organization information.

roles: list[OrgRoleName]

List of roles the user has within the organization.

user: roboto.domain.users.UserRecord

User information for the organization member.