roboto.domain.orgs.org_records

Module Contents

OrgInviteRecord

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

Bases: pydantic.BaseModel

A wire-transmissible representation of an organization invite.

Parameters

data Any

Attributes

OrgInviteRecord.invite_id

invite_id str #

Unique identifier for the invitation.

OrgInviteRecord.invited_by

invited_by roboto.domain.users.UserRecord #

User information for the person who created the invitation.

OrgInviteRecord.org

org OrgRecord #

Organization information for the organization being invited to.

OrgInviteRecord.user_id

user_id str #

User ID of the person who was invited.

OrgRecord

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

Bases: pydantic.BaseModel

A wire-transmissible representation of an organization.

Parameters

data Any

Attributes

OrgRecord.created

created datetime.datetime #

Timestamp when the organization was created.

OrgRecord.created_by

created_by str | None = None #

User ID of the organization creator.

OrgRecord.name

name str #

Human-readable name of the organization.

OrgRecord.org_id

org_id str #

Unique identifier for the organization.

OrgRecord.status

status OrgStatus #

Current operational status of the organization.

OrgRecord.tier

tier OrgTier #

Subscription tier of the organization.

OrgRoleName

class roboto.domain.orgs.org_records.OrgRoleName#

Bases: roboto.compat.StrEnum

Organization role enumeration.

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

Attributes

OrgRoleName.admin

admin = 'admin' #

Administrative role with management permissions for organization resources.

OrgRoleName.owner

owner = 'owner' #

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

OrgRoleName.user

user = 'user' #

Basic user role with read access to organization resources.

OrgStatus

class roboto.domain.orgs.org_records.OrgStatus#

Bases: roboto.compat.StrEnum

Organization status enumeration.

Represents the current operational state of an organization.

Attributes

OrgStatus.Active

Active = 'active' #

Organization is fully operational and ready for use.

OrgStatus.Deprovisioning

Deprovisioning = 'de-provisioning' #

Organization is being deleted and resources are being cleaned up.

OrgStatus.Provisioning

Provisioning = 'provisioning' #

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

OrgTier

class roboto.domain.orgs.org_records.OrgTier#

Bases: roboto.compat.StrEnum

Organization tier enumeration.

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

Attributes

OrgTier.free

free = 'free' #

Free tier with basic features and usage limits.

OrgTier.premium

premium = 'premium' #

Premium tier with advanced features and higher usage limits.

OrgUserRecord

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

Bases: pydantic.BaseModel

A wire-transmissible representation of an organization user.

Parameters

data Any

Attributes

OrgUserRecord.org

org OrgRecord #

Organization information.

OrgUserRecord.roles

roles list[OrgRoleName] #

List of roles the user has within the organization.

OrgUserRecord.user

user roboto.domain.users.UserRecord #

User information for the organization member.