Skip to content

Common Schemas & Enums

Auto-generated from source — always in sync with the backend.

common

Common models shared across HCP MAPI resources.

DirectoryUsage

HCP returns mixed casing (Balanced or BALANCED).

IpAddressList

HCP wraps IP lists in {"ipAddress": [...]}.

IpSettings

IP address allow/deny configuration.

HCP MAPI returns addresses wrapped as {"ipAddress": [...]}. We normalize to flat list[str] so the frontend receives plain arrays.

to_hcp_dict()

Serialize with HCP's {"ipAddress": [...]} wrapper for POST.

PermissionList

A list of permissions.

RoleList

A list of roles.

TagList

A list of tags.

NamespacePermission

Data access permissions for a single namespace.

DataAccessPermissions

Data access permissions across namespaces.

VersioningSettings

Versioning configuration for a namespace.

ListQueryParams

Combined query parameters for list operations.

to_query(**extra)

Build query dict from non-None fields, plus any extra params.

ChargebackParams

Query parameters for chargeback reports.

StatusResponse

Standard response for mutation operations.

TokenResponse

OAuth2 token response.

PermissionsResponse

Namespace or tenant permissions from MAPI.

dump_for_hcp(model)

Serialize a Pydantic model for POST to HCP MAPI.

Re-wraps any ipSettings field into HCP's {"ipAddress": [...]} format.