roboto.domain.orgs.org_operations

Module Contents

class roboto.domain.orgs.org_operations.BindEmailDomainRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to bind an email domain to an organization.

Parameters:

data (Any)

email_domain: str

Email domain to bind (e.g., “example.com”).

class roboto.domain.orgs.org_operations.CreateOrgRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to create an organization.

Parameters:

data (Any)

bind_email_domain: bool = False

Whether to automatically bind the creator’s email domain to this organization.

data_region: roboto.regionalization.RobotoRegion

AWS region where the organization’s data will be stored.

name: str

Unique name for the organization.

class roboto.domain.orgs.org_operations.InviteUserRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to invite a user to an organization.

Parameters:

data (Any)

invited_user_id: str

Unique identifier for the user to invite.

class roboto.domain.orgs.org_operations.ModifyRoleForUserRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to modify the role for a user in an organization.

Deprecated since version Use: UpdateOrgUserRequest instead.

Parameters:

data (Any)

role_name: roboto.domain.orgs.org_records.OrgRoleName

Role to assign to the user.

user_id: str

Unique identifier for the user.

class roboto.domain.orgs.org_operations.OrgRecordUpdates(/, **data)

Bases: pydantic.BaseModel

Payload containing organization field updates.

Parameters:

data (Any)

name: str | None = None

Updated name for the organization.

status: roboto.domain.orgs.org_records.OrgStatus | None = None

Updated status for the organization.

class roboto.domain.orgs.org_operations.RemoveUserFromOrgRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to remove a user from an organization.

Parameters:

data (Any)

user_id: str

Unique identifier for the user to remove.

class roboto.domain.orgs.org_operations.UpdateOrgRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to update an organization.

Parameters:

data (Any)

updates: OrgRecordUpdates

Organization field updates to apply.

class roboto.domain.orgs.org_operations.UpdateOrgUserRequest(/, **data)

Bases: pydantic.BaseModel

Request payload to update an organization user’s roles.

Parameters:

data (Any)

add_roles: list[roboto.domain.orgs.org_records.OrgRoleName] | None = None

Roles to add to the user.

check_some_updates_present()

Return type:

UpdateOrgUserRequest

remove_roles: list[roboto.domain.orgs.org_records.OrgRoleName] | None = None

Roles to remove from the user.