Shared DTOs, error schemas, and API contracts for the platform tier
| Tier | platform |
| Role | unclassified (baselined) |
| Path | crates/platform/dto |
| Edition | 2021 |
| Targets | platform_dto, field_coverage |
| Public items | 302 across 36 modules |
| Tests | 23 |
What it is for
Shared DTOs, error schemas, and API contracts for library crates platform.
This crate defines the stable contracts between frontend and backend:
ApiError- Standardized error responsesListQuery- Pagination, search, filter, sort parametersListResponse- Paginated list responses- Common response wrappers
Capabilities
ApiKeyCreated
API key management DTOs.
| Item |
|---|
pub struct ApiKeyCreated |
ApiKeySummary
API key management DTOs.
| Item |
|---|
pub struct ApiKeySummary |
CreateApiKeyRequest
API key management DTOs.
| Item |
|---|
pub struct CreateApiKeyRequest |
AttachRequest
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub struct AttachRequest |
Attachment
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub struct Attachment |
AttachmentAuditEvent
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub struct AttachmentAuditEvent |
AttachmentListQuery
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub struct AttachmentListQuery |
AttachmentWithAsset
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub struct AttachmentWithAsset |
AuditClass
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub enum AuditClass |
Grant
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub struct Grant |
GrantRequest
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub struct GrantRequest |
GrantSource
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub enum GrantSource |
GranteeType
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub enum GranteeType |
Permission
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub enum Permission |
ReorderRequest
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub struct ReorderRequest |
ReorderResponse
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub struct ReorderResponse |
UpdateSortOrderRequest
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub struct UpdateSortOrderRequest |
Visibility
Asset attachment DTOs for the admin surface.
| Item |
|---|
pub enum Visibility |
AuditLogDetail
Audit log DTOs.
| Item |
|---|
pub struct AuditLogDetail |
AuditLogQuery
Audit log DTOs.
| Item |
|---|
pub struct AuditLogQuery |
AuditLogQuery :: fn default() -> Self |
AuditLogSummary
Audit log DTOs.
| Item |
|---|
pub struct AuditLogSummary |
ChangePasswordRequest
Authentication DTOs.
| Item |
|---|
pub struct ChangePasswordRequest |
Claims
Authentication DTOs.
| Item |
|---|
pub struct Claims |
Claims :: fn is_expired(& self) -> bool |
Claims :: fn remaining_seconds(& self) -> i64 |
LoginRequest
Authentication DTOs.
| Item |
|---|
pub struct LoginRequest |
LoginResponse
Authentication DTOs.
| Item |
|---|
pub struct LoginResponse |
PasswordResetConfirm
Authentication DTOs.
| Item |
|---|
pub struct PasswordResetConfirm |
PasswordResetRequest
Authentication DTOs.
| Item |
|---|
pub struct PasswordResetRequest |
TenantInfo
Authentication DTOs.
| Item |
|---|
pub struct TenantInfo |
UserInfo
Authentication DTOs.
| Item |
|---|
pub struct UserInfo |
UserInfo :: fn has_role(& self, role : & str) -> bool |
UserInfo :: fn has_permission(& self, permission : & str) -> bool |
UserInfo :: fn is_admin(& self) -> bool |
ChessStateDto
Self-play chess-via-email dashboard widget DTO, mirroring
| Item |
|---|
pub struct ChessStateDto |
CmsCreatePageInput
CMS content types for the admin platform.
| Item |
|---|
pub struct CmsCreatePageInput |
CmsTranslationInput
CMS content types for the admin platform.
| Item |
|---|
pub struct CmsTranslationInput |
ContentPage
CMS content types for the admin platform.
| Item |
|---|
pub struct ContentPage |
CreatePageRequest
CMS content types for the admin platform.
| Item |
|---|
pub struct CreatePageRequest |
PageListQuery
CMS content types for the admin platform.
| Item |
|---|
pub struct PageListQuery |
PageListQuery :: fn default() -> Self |
PageStatus
CMS content types for the admin platform.
| Item |
|---|
pub enum PageStatus |
PageStatus :: fn as_str(& self) -> & 'static str |
PageSummary
CMS content types for the admin platform.
| Item |
|---|
pub struct PageSummary |
PublishPageRequest
CMS content types for the admin platform.
| Item |
|---|
pub struct PublishPageRequest |
UpdatePageRequest
CMS content types for the admin platform.
| Item |
|---|
pub struct UpdatePageRequest |
CmsFacetCount
DTOs mirroring application_cms::services::search's real wire shape (Sprint 20
| Item |
|---|
pub struct CmsFacetCount |
CmsSearchHit
DTOs mirroring application_cms::services::search's real wire shape (Sprint 20
| Item |
|---|
pub enum CmsSearchHit |
CmsSearchHit :: fn display_title(& self) -> String |
CmsSearchHit :: fn entity_type(& self) -> & 'static str |
CmsSearchResponse
DTOs mirroring application_cms::services::search's real wire shape (Sprint 20
| Item |
|---|
pub struct CmsSearchResponse |
AddCommentRequest
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct AddCommentRequest |
AddReactionRequest
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct AddReactionRequest |
CommentDetail
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct CommentDetail |
CommentSummary
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct CommentSummary |
CommentsListQuery
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct CommentsListQuery |
CreateThreadRequest
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct CreateThreadRequest |
EditCommentRequest
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct EditCommentRequest |
MentionSummary
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct MentionSummary |
ReactionCount
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct ReactionCount |
ThreadDetail
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct ThreadDetail |
ThreadSummary
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct ThreadSummary |
UpdateThreadStatusRequest
Comments DTOs for threads, comments, mentions, and reactions.
| Item |
|---|
pub struct UpdateThreadStatusRequest |
AddContactNoteRequest
Contact submission + staff-notes DTOs for the admin surface.
| Item |
|---|
pub struct AddContactNoteRequest |
ContactDetail
Contact submission + staff-notes DTOs for the admin surface.
| Item |
|---|
pub struct ContactDetail |
ContactNote
Contact submission + staff-notes DTOs for the admin surface.
| Item |
|---|
pub struct ContactNote |
ContactSubmission
Contact submission + staff-notes DTOs for the admin surface.
| Item |
|---|
pub struct ContactSubmission |
ContactChannelDto
Contact-channel DTOs — sprint 3.83 (application-contact admin router).
| Item |
|---|
pub struct ContactChannelDto |
CreateContactChannelRequest
Contact-channel DTOs — sprint 3.83 (application-contact admin router).
| Item |
|---|
pub struct CreateContactChannelRequest |
UpdateContactChannelRequest
Contact-channel DTOs — sprint 3.83 (application-contact admin router).
| Item |
|---|
pub struct UpdateContactChannelRequest |
CreateOpportunityRequest
CRM pipeline DTOs (Stage/Opportunity), mirroring domain-crm's wire
| Item |
|---|
pub struct CreateOpportunityRequest |
CreateStageRequest
CRM pipeline DTOs (Stage/Opportunity), mirroring domain-crm's wire
| Item |
|---|
pub struct CreateStageRequest |
ItemsResponse
CRM pipeline DTOs (Stage/Opportunity), mirroring domain-crm's wire
| Item |
|---|
pub struct ItemsResponse<T> |
MoneyDto
CRM pipeline DTOs (Stage/Opportunity), mirroring domain-crm's wire
| Item |
|---|
pub struct MoneyDto |
MoveStageRequest
CRM pipeline DTOs (Stage/Opportunity), mirroring domain-crm's wire
| Item |
|---|
pub struct MoveStageRequest |
OpportunityDto
CRM pipeline DTOs (Stage/Opportunity), mirroring domain-crm's wire
| Item |
|---|
pub struct OpportunityDto |
StageDto
CRM pipeline DTOs (Stage/Opportunity), mirroring domain-crm's wire
| Item |
|---|
pub struct StageDto |
DirectoryListQuery
Directory listing types for the admin platform.
| Item |
|---|
pub struct DirectoryListQuery |
DirectoryListingDto
Directory listing types for the admin platform.
| Item |
|---|
pub struct DirectoryListingDto |
DirectoryStats
Directory listing types for the admin platform.
| Item |
|---|
pub struct DirectoryStats |
ListingStatus
Directory listing types for the admin platform.
| Item |
|---|
pub enum ListingStatus |
ListingStatus :: fn as_str(& self) -> & 'static str |
ListingStatus :: fn fmt(& self, f : & mut std::fmt::Formatter <'_>) -> std::fmt::Result |
ListingSummary
Directory listing types for the admin platform.
| Item |
|---|
pub struct ListingSummary |
ListingType
Directory listing types for the admin platform.
| Item |
|---|
pub enum ListingType |
ListingType :: fn as_str(& self) -> & 'static str |
ListingType :: fn fmt(& self, f : & mut std::fmt::Formatter <'_>) -> std::fmt::Result |
TypeCount
Directory listing types for the admin platform.
| Item |
|---|
pub struct TypeCount |
UpdateListingRequest
Directory listing types for the admin platform.
| Item |
|---|
pub struct UpdateListingRequest |
UpdateListingStatusRequest
Directory listing types for the admin platform.
| Item |
|---|
pub struct UpdateListingStatusRequest |
CreateDiscoveryRunRequest
Business-discovery DTOs (sprint 3.69 Phase 1 item 3/4) for admin API
| Item |
|---|
pub struct CreateDiscoveryRunRequest |
DiscoveryCandidateDto
Business-discovery DTOs (sprint 3.69 Phase 1 item 3/4) for admin API
| Item |
|---|
pub struct DiscoveryCandidateDto |
DiscoveryCostEstimate
Business-discovery DTOs (sprint 3.69 Phase 1 item 3/4) for admin API
| Item |
|---|
pub struct DiscoveryCostEstimate |
DiscoveryRunDto
Business-discovery DTOs (sprint 3.69 Phase 1 item 3/4) for admin API
| Item |
|---|
pub struct DiscoveryRunDto |
ImportCandidateRequest
Business-discovery DTOs (sprint 3.69 Phase 1 item 3/4) for admin API
| Item |
|---|
pub struct ImportCandidateRequest |
MarkDuplicateRequest
Business-discovery DTOs (sprint 3.69 Phase 1 item 3/4) for admin API
| Item |
|---|
pub struct MarkDuplicateRequest |
DlpAlertRow
DLP masked-alert viewer DTOs, mirroring application_dlp::repo::CaptureRow's wire
| Item |
|---|
pub struct DlpAlertRow |
ApiError:ApiError
Standardized API error schema.
| Item |
|---|
pub struct ApiError |
ApiError:already
Standardized API error schema.
| Item |
|---|
ApiError :: fn already_exists(resource : impl Into <String>) -> Self |
ApiError:fmt
Standardized API error schema.
| Item |
|---|
ApiError :: fn fmt(& self, f : & mut std::fmt::Formatter <'_>) -> std::fmt::Result |
ApiError:forbidden
Standardized API error schema.
| Item |
|---|
ApiError :: fn forbidden(message : impl Into <String>) -> Self |
ApiError:internal
Standardized API error schema.
| Item |
|---|
ApiError :: fn internal_error() -> Self |
ApiError:invalid
Standardized API error schema.
| Item |
|---|
ApiError :: fn invalid_credentials() -> Self |
ApiError:new
Standardized API error schema.
| Item |
|---|
ApiError :: fn new(code : ErrorCode, message : impl Into <String>) -> Self |
ApiError:not
Standardized API error schema.
| Item |
|---|
ApiError :: fn not_found(resource : impl Into <String>) -> Self |
ApiError:rate
Standardized API error schema.
| Item |
|---|
ApiError :: fn rate_limited() -> Self |
ApiError:unauthenticated
Standardized API error schema.
| Item |
|---|
ApiError :: fn unauthenticated() -> Self |
ApiError:unauthorized
Standardized API error schema.
| Item |
|---|
ApiError :: fn unauthorized() -> Self |
ApiError:validation
Standardized API error schema.
| Item |
|---|
ApiError :: fn validation_failed() -> Self |
ApiError:with
Standardized API error schema.
| Item |
|---|
ApiError :: fn with_details(mut self, details : impl Into <String>) -> Self |
ApiError :: fn with_field_error(mut self, error : FieldError) -> Self |
ApiError :: fn with_field_errors(mut self, errors : Vec <FieldError>) -> Self |
ApiError :: fn with_metadata(mut self, key : impl Into <String>, value : serde_json::Value) -> Self |
ApiError :: fn with_request_id(mut self, request_id : impl Into <String>) -> Self |
ErrorCode
Standardized API error schema.
| Item |
|---|
pub enum ErrorCode |
ErrorCode :: fn http_status(& self) -> u16 |
FieldError
Standardized API error schema.
| Item |
|---|
pub struct FieldError |
FieldError :: fn new(field : impl Into <String>, message : impl Into <String>) -> Self |
FieldError :: fn with_code(mut self, code : impl Into <String>) -> Self |
RecentEmailDto
Recent-emails dashboard widget DTO, mirroring gmail_recent::RecentEmail's
| Item |
|---|
pub struct RecentEmailDto |
RecentEmailsResponse
Recent-emails dashboard widget DTO, mirroring gmail_recent::RecentEmail's
| Item |
|---|
pub struct RecentEmailsResponse |
ChartResponse
Chart-of-accounts DTOs for the staff-ui SPA, mirroring
| Item |
|---|
pub struct ChartResponse |
ChartRowDto
Chart-of-accounts DTOs for the staff-ui SPA, mirroring
| Item |
|---|
pub struct ChartRowDto |
CreateAccountRequest
Chart-of-accounts DTOs for the staff-ui SPA, mirroring
| Item |
|---|
pub struct CreateAccountRequest |
matches (other)
The /api/matches contract — the grid that replaces ghosting.
| Item |
|---|
fn match_page(items : Vec <MatchSummary>, page_info : PageInfo) -> MatchListResponse |
DeclineRequest
The /api/matches contract — the grid that replaces ghosting.
| Item |
|---|
pub struct DeclineRequest |
DeclineResponse
The /api/matches contract — the grid that replaces ghosting.
| Item |
|---|
pub struct DeclineResponse |
MatchListResponse
The /api/matches contract — the grid that replaces ghosting.
| Item |
|---|
pub type MatchListResponse: ListResponse <MatchSummary> |
MatchSummary
The /api/matches contract — the grid that replaces ghosting.
| Item |
|---|
pub struct MatchSummary |
AssetType
Media library types for the admin platform.
| Item |
|---|
pub enum AssetType |
AssetType :: fn from_mime(mime : & str) -> Self |
AssetVisibility
Media library types for the admin platform.
| Item |
|---|
pub enum AssetVisibility |
BulkUploadResponse
Media library types for the admin platform.
| Item |
|---|
pub struct BulkUploadResponse |
ExifDto
Media library types for the admin platform.
| Item |
|---|
pub struct ExifDto |
MediaAsset
Media library types for the admin platform.
| Item |
|---|
pub struct MediaAsset |
MediaListQuery
Media library types for the admin platform.
| Item |
|---|
pub struct MediaListQuery |
MediaListQuery :: fn default() -> Self |
MediaSummary
Media library types for the admin platform.
| Item |
|---|
pub struct MediaSummary |
MediaVariant
Media library types for the admin platform.
| Item |
|---|
pub struct MediaVariant |
PresignedUrlResponse
Media library types for the admin platform.
| Item |
|---|
pub struct PresignedUrlResponse |
UpdateMediaRequest
Media library types for the admin platform.
| Item |
|---|
pub struct UpdateMediaRequest |
UploadError
Media library types for the admin platform.
| Item |
|---|
pub struct UploadError |
UploadResponse
Media library types for the admin platform.
| Item |
|---|
pub struct UploadResponse |
BulkNotificationRequest
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct BulkNotificationRequest |
CreateTemplateRequest
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct CreateTemplateRequest |
MarkReadRequest
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct MarkReadRequest |
NotificationChannel
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub enum NotificationChannel |
NotificationDetail
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct NotificationDetail |
NotificationStats
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct NotificationStats |
NotificationStatus
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub enum NotificationStatus |
NotificationSummary
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct NotificationSummary |
NotificationsListQuery
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct NotificationsListQuery |
PreferenceSummary
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct PreferenceSummary |
PreferenceUpdate
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct PreferenceUpdate |
SendNotificationRequest
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct SendNotificationRequest |
TemplateSummary
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct TemplateSummary |
TypeCount
Directory listing types for the admin platform.
| Item |
|---|
pub struct TypeCount |
UpdatePreferencesRequest
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct UpdatePreferencesRequest |
UserPreferences
Notifications DTOs for notifications, templates, and preferences.
| Item |
|---|
pub struct UserPreferences |
CreateOrganizationRequest
Organization/Parties DTOs for admin API communication.
| Item |
|---|
pub struct CreateOrganizationRequest |
OrganizationDetail
Organization/Parties DTOs for admin API communication.
| Item |
|---|
pub struct OrganizationDetail |
OrganizationSummary
Organization/Parties DTOs for admin API communication.
| Item |
|---|
pub struct OrganizationSummary |
UpdateOrganizationRequest
Organization/Parties DTOs for admin API communication.
| Item |
|---|
pub struct UpdateOrganizationRequest |
FilterCondition
Pagination, search, filter, and sort library crates.
| Item |
|---|
pub struct FilterCondition |
FilterOp
Pagination, search, filter, and sort library crates.
| Item |
|---|
pub enum FilterOp |
ListQuery
Pagination, search, filter, and sort library crates.
| Item |
|---|
pub struct ListQuery |
ListQuery :: fn default() -> Self |
ListQuery :: fn new() -> Self |
ListQuery :: fn with_search(mut self, search : impl Into <String>) -> Self |
ListQuery :: fn with_page(mut self, page : u32) -> Self |
ListQuery :: fn with_page_size(mut self, page_size : u32) -> Self |
ListQuery :: fn with_sort(mut self, field : impl Into <String>, order : SortOrder) -> Self |
ListQuery :: fn with_filter(mut self, field : impl Into <String>, value : impl Into <String>) -> Self |
ListQuery :: fn offset(& self) -> u32 |
ListQuery :: fn limit(& self) -> u32 |
ListResponse
Pagination, search, filter, and sort library crates.
| Item |
|---|
pub struct ListResponse<T> |
ListResponse<T>
Pagination, search, filter, and sort library crates.
| Item |
|---|
ListResponse<T> :: fn new(items : Vec <T>, page_info : PageInfo) -> Self |
ListResponse<T> :: fn from_query(items : Vec <T>, query : & ListQuery, total : u64) -> Self |
ListResponse<T> :: fn empty(query : & ListQuery) -> Self |
ListResponse<T> :: fn map <U, F : FnMut(T) -> U>(self, f : F) -> ListResponse <U> |
PageInfo
Pagination, search, filter, and sort library crates.
| Item |
|---|
pub struct PageInfo |
PageInfo :: fn from_query(query : & ListQuery, total : u64) -> Self |
PageInfo :: fn new(page : u32, page_size : u32, total : u64) -> Self |
SortOrder
Pagination, search, filter, and sort library crates.
| Item |
|---|
pub enum SortOrder |
SortSpec
Pagination, search, filter, and sort library crates.
| Item |
|---|
pub struct SortSpec |
SortSpec :: fn new(field : impl Into <String>) -> Self |
SortSpec :: fn desc(field : impl Into <String>) -> Self |
CreatePartyAddressRequest
Party-address DTOs — sprint 3.93 (application-parties's
| Item |
|---|
pub struct CreatePartyAddressRequest |
PartyAddressDto
Party-address DTOs — sprint 3.93 (application-parties's
| Item |
|---|
pub struct PartyAddressDto |
UpdatePartyAddressRequest
Party-address DTOs — sprint 3.93 (application-parties's
| Item |
|---|
pub struct UpdatePartyAddressRequest |
CreatePersonRequest
Person/Parties DTOs for admin API communication.
| Item |
|---|
pub struct CreatePersonRequest |
PersonDetail
Person/Parties DTOs for admin API communication.
| Item |
|---|
pub struct PersonDetail |
PersonSummary
Person/Parties DTOs for admin API communication.
| Item |
|---|
pub struct PersonSummary |
UpdatePersonRequest
Person/Parties DTOs for admin API communication.
| Item |
|---|
pub struct UpdatePersonRequest |
CreatePostRequest
Blog post DTOs for the admin + public platform surfaces.
| Item |
|---|
pub struct CreatePostRequest |
Post
Blog post DTOs for the admin + public platform surfaces.
| Item |
|---|
pub struct Post |
PostListQuery
Blog post DTOs for the admin + public platform surfaces.
| Item |
|---|
pub struct PostListQuery |
UpdatePostRequest
Blog post DTOs for the admin + public platform surfaces.
| Item |
|---|
pub struct UpdatePostRequest |
Redirect
URL redirect DTOs for the admin platform.
| Item |
|---|
pub struct Redirect |
UpsertRedirectRequest
URL redirect DTOs for the admin platform.
| Item |
|---|
pub struct UpsertRedirectRequest |
CreateRelationshipRequest
Party relationship DTOs for admin API communication.
| Item |
|---|
pub struct CreateRelationshipRequest |
RelationshipDto
Party relationship DTOs for admin API communication.
| Item |
|---|
pub struct RelationshipDto |
UpdateRelationshipRequest
Party relationship DTOs for admin API communication.
| Item |
|---|
pub struct UpdateRelationshipRequest |
CancelReservationRequest
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct CancelReservationRequest |
ConfirmationLookupRequest
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct ConfirmationLookupRequest |
CreateHoldRequest
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct CreateHoldRequest |
CreatePoolRequest
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct CreatePoolRequest |
CreateReservationRequest
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct CreateReservationRequest |
ExtendHoldRequest
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct ExtendHoldRequest |
HoldDetail
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct HoldDetail |
HoldStatus
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub enum HoldStatus |
HoldSummary
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct HoldSummary |
PoolCapacityStats
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct PoolCapacityStats |
PoolDetail
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct PoolDetail |
PoolStatus
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub enum PoolStatus |
PoolSummary
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct PoolSummary |
PoolsListQuery
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct PoolsListQuery |
ReservationDetail
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct ReservationDetail |
ReservationStatus
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub enum ReservationStatus |
ReservationSummary
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct ReservationSummary |
ReservationsListQuery
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct ReservationsListQuery |
UpdatePoolRequest
Reservations DTOs for capacity pools, holds, and reservations.
| Item |
|---|
pub struct UpdatePoolRequest |
ApiResponse
Common response wrappers.
| Item |
|---|
pub enum ApiResponse<T> |
ApiResponse<T>
Common response wrappers.
| Item |
|---|
ApiResponse<T> :: fn success(data : T) -> Self |
ApiResponse<T> :: fn success_with_message(data : T, message : impl Into <String>) -> Self |
ApiResponse<T> :: fn error(error : crate::ApiError) -> Self |
ApiResponse<T> :: fn is_success(& self) -> bool |
ApiResponse<T> :: fn is_error(& self) -> bool |
ApiResponse<T> :: fn data(& self) -> Option <& T> |
ApiResponse<T> :: fn error_ref(& self) -> Option <& crate::ApiError> |
DataResponse
Common response wrappers.
| Item |
|---|
pub struct DataResponse<T> |
DataResponse<T>
Common response wrappers.
| Item |
|---|
DataResponse<T> :: fn new(data : T) -> Self |
DataResponse<T> :: fn with_message(mut self, message : impl Into <String>) -> Self |
DataResponse<T> :: fn with_request_id(mut self, request_id : impl Into <String>) -> Self |
EmptyResponse
Common response wrappers.
| Item |
|---|
pub struct EmptyResponse |
EmptyResponse :: fn ok() -> Self |
EmptyResponse :: fn with_message(message : impl Into <String>) -> Self |
HealthResponse
Common response wrappers.
| Item |
|---|
pub struct HealthResponse |
HealthResponse :: fn healthy(version : impl Into <String>) -> Self |
HealthStatus
Common response wrappers.
| Item |
|---|
pub enum HealthStatus |
Review
Ratings + reviews DTOs for the admin + public platform surfaces.
| Item |
|---|
pub struct Review |
ReviewListQuery
Ratings + reviews DTOs for the admin + public platform surfaces.
| Item |
|---|
pub struct ReviewListQuery |
UpsertReviewRequest
Ratings + reviews DTOs for the admin + public platform surfaces.
| Item |
|---|
pub struct UpsertReviewRequest |
RevisionDetail
Page version DTOs.
| Item |
|---|
pub struct RevisionDetail |
RevisionDiff
Page version DTOs.
| Item |
|---|
pub struct RevisionDiff |
RevisionSummary
Page version DTOs.
| Item |
|---|
pub struct RevisionSummary |
AddAvailabilityRequest
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct AddAvailabilityRequest |
AddExceptionRequest
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct AddExceptionRequest |
AppointmentDetail
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct AppointmentDetail |
AppointmentLookupRequest
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct AppointmentLookupRequest |
AppointmentStatus
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub enum AppointmentStatus |
AppointmentSummary
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct AppointmentSummary |
AppointmentsListQuery
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct AppointmentsListQuery |
AvailabilitySummary
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct AvailabilitySummary |
BookAppointmentRequest
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct BookAppointmentRequest |
CalendarView
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct CalendarView |
CancelAppointmentRequest
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct CancelAppointmentRequest |
CreateScheduleRequest
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct CreateScheduleRequest |
CreateTimeSlotRequest
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct CreateTimeSlotRequest |
ExceptionSummary
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct ExceptionSummary |
ExceptionType
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub enum ExceptionType |
GenerateSlotsRequest
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct GenerateSlotsRequest |
RescheduleAppointmentRequest
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct RescheduleAppointmentRequest |
ScheduleDetail
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct ScheduleDetail |
ScheduleStatus
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub enum ScheduleStatus |
ScheduleSummary
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct ScheduleSummary |
SchedulesListQuery
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct SchedulesListQuery |
TimeSlotDetail
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct TimeSlotDetail |
TimeSlotStatus
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub enum TimeSlotStatus |
TimeSlotSummary
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct TimeSlotSummary |
TimeSlotsListQuery
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct TimeSlotsListQuery |
UpdateScheduleRequest
Scheduling DTOs for schedules, time slots, and appointments.
| Item |
|---|
pub struct UpdateScheduleRequest |
SearchHit
Unified search DTOs.
| Item |
|---|
pub struct SearchHit |
SearchRequest
Unified search DTOs.
| Item |
|---|
pub struct SearchRequest |
SearchResponse
Unified search DTOs.
| Item |
|---|
pub struct SearchResponse |
SettingValue
Site settings DTOs.
| Item |
|---|
pub struct SettingValue |
UpdateSettingsRequest
Site settings DTOs.
| Item |
|---|
pub struct UpdateSettingsRequest |
CategorizeEntityRequest
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct CategorizeEntityRequest |
CategoryDetail
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct CategoryDetail |
CategoryListQuery
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct CategoryListQuery |
CategorySummary
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct CategorySummary |
CreateCategoryRequest
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct CreateCategoryRequest |
CreateTagRequest
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct CreateTagRequest |
CreateVocabularyRequest
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct CreateVocabularyRequest |
TagDetail
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct TagDetail |
TagEntityRequest
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct TagEntityRequest |
TagListQuery
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct TagListQuery |
TagSummary
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct TagSummary |
UpdateCategoryRequest
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct UpdateCategoryRequest |
UpdateTagRequest
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct UpdateTagRequest |
UpdateVocabularyRequest
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct UpdateVocabularyRequest |
VocabularyDetail
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct VocabularyDetail |
VocabularyListQuery
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct VocabularyListQuery |
VocabularySummary
Taxonomy DTOs for categories, tags, and hierarchies.
| Item |
|---|
pub struct VocabularySummary |
CreateUserRequest
User management DTOs.
| Item |
|---|
pub struct CreateUserRequest |
UpdateUserRequest
User management DTOs.
| Item |
|---|
pub struct UpdateUserRequest |
UpdateUserRolesRequest
User management DTOs.
| Item |
|---|
pub struct UpdateUserRolesRequest |
UserDetail
User management DTOs.
| Item |
|---|
pub struct UserDetail |
UserListQuery
User management DTOs.
| Item |
|---|
pub struct UserListQuery |
UserListQuery :: fn default() -> Self |
UserSummary
User management DTOs.
| Item |
|---|
pub struct UserSummary |
How to use it
No examples/ target and no doctest in this crate's rustdoc. The tests listed under Verification are the closest executable usage.
Module structure
platform_dto
api_keysattachmentsaudit_logsauthchess_widgetcmscms_searchcommentscontactcontact_channelcrmdirectorydiscoverydlperrorgmail_recentledgermatchesmedianotificationsorganizationpaginationparty_addresspersonpostsredirectsrelationshipreservationsresponsereviewsrevisionsschedulingsearchsettingstaxonomyusers
_36 modules: past 25 the diagram stops being readable, so the tree above is the complete picture._
Public surface
`api_keys`
| Item | What it is |
|---|---|
pub struct CreateApiKeyRequest | Request to create an API key. |
pub struct ApiKeyCreated | Returned only on create — contains the plaintext key (shown once). |
pub struct ApiKeySummary | API key summary for list/get responses — never contains plaintext key. |
`attachments`
| Item | What it is |
|---|---|
pub enum Visibility | Coarse visibility tier on an attachment (D-S18C.Q1 hybrid model) |
pub enum AuditClass | Audit-class of an attachment (D-S18C.Q6) |
pub enum GranteeType | Grantee type for an attachment access grant. |
pub enum Permission | Permission level on a grant. |
pub enum GrantSource | Provenance of a grant — audit-trail-relevant. |
pub struct Attachment | Raw attachment row — what /api/v1/admin/attachments/:id returns and what's nested inside list endpoints |
pub struct AttachmentWithAsset | Attachment + joined asset metadata — what /api/v1/admin/attachments?entity_type=X&entity_id=Y returns (one row per attachment, with the LEFT JOIN on assets). |
pub struct AttachRequest | Input for POST /api/v1/admin/attachments — attach an asset to a target entity. |
pub struct UpdateSortOrderRequest | Input for PATCH /api/v1/admin/attachments/:id/sort-order. |
pub struct ReorderRequest | Input for POST /api/v1/admin/attachments/reorder — bulk reorder within a target+field |
pub struct AttachmentListQuery | Query string for the list endpoint. |
pub struct ReorderResponse | Response for POST /api/v1/admin/attachments/reorder — confirms how many rows were touched. |
pub struct Grant | An explicit per-grantee access grant on an attachment |
pub struct GrantRequest | Input for POST /api/v1/admin/attachments/:id/grants or the customer-side equivalent. |
pub struct AttachmentAuditEvent | Read-only shape for GET /api/v1/admin/attachments/:id/audit |
`audit_logs`
| Item | What it is |
|---|---|
pub struct AuditLogQuery | Query parameters for listing audit logs. |
AuditLogQuery :: fn default() -> Self | — |
pub struct AuditLogSummary | Audit log summary for list responses. |
pub struct AuditLogDetail | Full audit log detail. |
`auth`
| Item | What it is |
|---|---|
pub struct LoginRequest | Login request. |
pub struct TenantInfo | Tenant info for multi-tenant applications. |
pub struct LoginResponse | Login response. |
pub struct UserInfo | User information returned from auth endpoints |
UserInfo :: fn has_role(& self, role : & str) -> bool | Check if user has the specified role. |
UserInfo :: fn has_permission(& self, permission : & str) -> bool | Check if user has a specific permission. |
UserInfo :: fn is_admin(& self) -> bool | Check if user is an admin. |
pub struct Claims | JWT Claims structure (if using JWT). |
Claims :: fn is_expired(& self) -> bool | Check if claims are expired. |
Claims :: fn remaining_seconds(& self) -> i64 | Get remaining lifetime in seconds. |
pub struct ChangePasswordRequest | Change password request. |
pub struct PasswordResetRequest | Password reset request. |
pub struct PasswordResetConfirm | Password reset confirmation. |
`chess_widget`
| Item | What it is |
|---|---|
pub struct ChessStateDto | Board + status snapshot, exactly as GET /admin/chess/state returns it. |
`cms`
| Item | What it is |
|---|---|
pub enum PageStatus | Content page status. |
PageStatus :: fn as_str(& self) -> & 'static str | — |
pub struct PageSummary | Content page summary for list views. |
pub struct ContentPage | Full content page with all fields. |
pub struct CreatePageRequest | Request to create a new page |
pub struct CmsCreatePageInput | Canonical create-page request for the application-cms admin endpoint (POST /api/v1/admin/pages), Sprint 0.50 |
pub struct CmsTranslationInput | One per-locale translation carried by CmsCreatePageInput |
pub struct UpdatePageRequest | Request to update an existing page. |
pub struct PageListQuery | Query parameters for listing pages. |
PageListQuery :: fn default() -> Self | — |
pub struct PublishPageRequest | Action to publish a page. |
`cms_search`
| Item | What it is |
|---|---|
pub enum CmsSearchHit | One search hit |
CmsSearchHit :: fn display_title(& self) -> String | A display title regardless of entity type, for a uniform list row. |
CmsSearchHit :: fn entity_type(& self) -> & 'static str | The entity type tag, for a badge. |
pub struct CmsFacetCount | — |
pub struct CmsSearchResponse | — |
`comments`
| Item | What it is |
|---|---|
pub struct ThreadSummary | Comment thread summary for list views. |
pub struct ThreadDetail | Full thread details with recent comments. |
pub struct CreateThreadRequest | Request to create a thread. |
pub struct CommentSummary | Comment summary for list views. |
pub struct CommentDetail | Full comment details. |
pub struct AddCommentRequest | Request to add a comment. |
pub struct EditCommentRequest | Request to edit a comment. |
pub struct MentionSummary | Mention summary. |
pub struct ReactionCount | Reaction count for a comment. |
pub struct AddReactionRequest | Request to add a reaction. |
pub struct UpdateThreadStatusRequest | Request to lock/unlock a thread. |
pub struct CommentsListQuery | Comments list query parameters. |
`contact`
| Item | What it is |
|---|---|
pub struct ContactSubmission | A row from the contact_submissions table. |
pub struct ContactNote | A staff note attached to a contact submission. |
pub struct ContactDetail | Detail view — submission + full notes thread. |
pub struct AddContactNoteRequest | Input for POST /api/v1/admin/contact/{id}/notes. |
`contact_channel`
| Item | What it is |
|---|---|
pub struct ContactChannelDto | A contact channel for list/detail views — one shape for both, same rationale as RelationshipDto (few enough fields that a summary projection buys nothing) |
pub struct CreateContactChannelRequest | Request to create a new contact channel |
pub struct UpdateContactChannelRequest | Request to update an existing contact channel |
`crm`
| Item | What it is |
|---|---|
pub struct MoneyDto | Mirrors foundation_money::Money's wire shape (its custom Serialize emits {"amount": ..., "currency": ...}). |
pub struct StageDto | Mirrors domain_crm::Stage. |
pub struct OpportunityDto | Mirrors domain_crm::Opportunity. |
pub struct ItemsResponse<T> | {"items": ...} -- the shape application-crm's list endpoints return (unpaginated; the pipeline/stage list is small per tenant). |
pub struct CreateStageRequest | Request to create a pipeline stage. |
pub struct CreateOpportunityRequest | Request to create an opportunity. |
pub struct MoveStageRequest | Request body for PATCH /crm/opportunities/:id/stage. |
`directory`
| Item | What it is |
|---|---|
pub enum ListingStatus | Directory listing status. |
ListingStatus :: fn as_str(& self) -> & 'static str | — |
ListingStatus :: fn fmt(& self, f : & mut std::fmt::Formatter <'_>) -> std::fmt::Result | — |
pub enum ListingType | Directory listing type. |
ListingType :: fn as_str(& self) -> & 'static str | — |
ListingType :: fn fmt(& self, f : & mut std::fmt::Formatter <'_>) -> std::fmt::Result | — |
pub struct ListingSummary | Summary of a directory listing for list views. |
pub struct DirectoryListingDto | Full directory listing with all fields. |
pub struct UpdateListingStatusRequest | Request to update listing status. |
pub struct UpdateListingRequest | Request to update listing details. |
pub struct DirectoryListQuery | Query parameters for listing directory entries. |
pub struct DirectoryStats | Stats for directory module dashboard widget. |
pub struct TypeCount | Count per listing type. |
`discovery`
| Item | What it is |
|---|---|
pub struct CreateDiscoveryRunRequest | Request to start a discovery run |
pub struct DiscoveryCostEstimate | A dry-run cost estimate — shown to the operator BEFORE a real (billed) search runs |
pub struct DiscoveryRunDto | — |
pub struct DiscoveryCandidateDto | A staged candidate for the review page — "browsable with various options" (operator, sprint-3.69 item 4). |
pub struct ImportCandidateRequest | POST /discovery/candidates/:id/import — creates an Organization from this candidate |
pub struct MarkDuplicateRequest | POST /discovery/candidates/:id/mark-duplicate |
`dlp`
| Item | What it is |
|---|---|
pub struct DlpAlertRow | One masked DLP capture row, exactly as GET /admin/dlp/alerts returns it. |
`error`
| Item | What it is |
|---|---|
pub enum ErrorCode | Error codes for categorizing API errors. |
ErrorCode :: fn http_status(& self) -> u16 | Get the HTTP status code for this error code. |
pub struct FieldError | Field-level validation error. |
FieldError :: fn new(field : impl Into <String>, message : impl Into <String>) -> Self | — |
FieldError :: fn with_code(mut self, code : impl Into <String>) -> Self | — |
pub struct ApiError | Standardized API error response |
ApiError :: fn new(code : ErrorCode, message : impl Into <String>) -> Self | Create a new API error. |
ApiError :: fn with_details(mut self, details : impl Into <String>) -> Self | Add details to the error. |
ApiError :: fn with_field_error(mut self, error : FieldError) -> Self | Add a field error. |
ApiError :: fn with_field_errors(mut self, errors : Vec <FieldError>) -> Self | Add multiple field errors. |
ApiError :: fn with_metadata(mut self, key : impl Into <String>, value : serde_json::Value) -> Self | Add metadata. |
ApiError :: fn with_request_id(mut self, request_id : impl Into <String>) -> Self | Set the request ID. |
ApiError :: fn unauthenticated() -> Self | — |
ApiError :: fn unauthorized() -> Self | — |
ApiError :: fn forbidden(message : impl Into <String>) -> Self | — |
ApiError :: fn not_found(resource : impl Into <String>) -> Self | — |
ApiError :: fn validation_failed() -> Self | — |
ApiError :: fn invalid_credentials() -> Self | — |
ApiError :: fn internal_error() -> Self | — |
ApiError :: fn already_exists(resource : impl Into <String>) -> Self | — |
ApiError :: fn rate_limited() -> Self | — |
ApiError :: fn fmt(& self, f : & mut std::fmt::Formatter <'_>) -> std::fmt::Result | — |
`gmail_recent`
| Item | What it is |
|---|---|
pub struct RecentEmailDto | One recent-email row, exactly as GET /admin/gmail/recent returns it. |
pub struct RecentEmailsResponse | {"emails": ...} -- the shape GET /admin/gmail/recent returns. |
`ledger`
| Item | What it is |
|---|---|
pub struct ChartRowDto | Mirrors application_ledger_accounts's ChartRow response shape (GET /ledger/chart → {"accounts": ChartRowDto, ...}). |
pub struct ChartResponse | {"accounts": ...} -- the shape GET /ledger/chart returns. |
pub struct CreateAccountRequest | Request body for POST /ledger/accounts. |
`matches`
| Item | What it is |
|---|---|
pub struct MatchSummary | One person in the member's grid |
pub type MatchListResponse: ListResponse <MatchSummary> | GET /api/matches — one page of the grid. |
fn match_page(items : Vec <MatchSummary>, page_info : PageInfo) -> MatchListResponse | Build a page of matches. |
pub struct DeclineRequest | POST /api/matches/decline — end or pause conversations with one or more members |
pub struct DeclineResponse | What the server did. |
`media`
| Item | What it is |
|---|---|
pub enum AssetVisibility | Media asset visibility. |
pub enum AssetType | Media asset type. |
AssetType :: fn from_mime(mime : & str) -> Self | Determine asset type from MIME type. |
pub struct MediaSummary | Media asset summary for list views. |
pub struct MediaAsset | Full media asset with all fields. |
pub struct ExifDto | EXIF metadata for an image asset (Sprint 0.27) |
pub struct MediaVariant | Media variant (thumbnail, different size, etc.) |
pub struct UpdateMediaRequest | Request to update media asset metadata. |
pub struct MediaListQuery | Query parameters for listing media assets. |
MediaListQuery :: fn default() -> Self | — |
pub struct UploadResponse | Response after successful media upload. |
pub struct BulkUploadResponse | Response for multiple asset uploads. |
pub struct UploadError | Error for individual upload failure. |
pub struct PresignedUrlResponse | Presigned URL response for direct upload. |
`notifications`
| Item | What it is |
|---|---|
pub enum NotificationChannel | Notification channel types. |
pub enum NotificationStatus | Notification status. |
pub struct NotificationSummary | Notification summary for list views. |
pub struct NotificationDetail | Full notification details. |
pub struct SendNotificationRequest | Request to send a notification. |
pub struct BulkNotificationRequest | Request to send bulk notifications. |
pub struct PreferenceSummary | Notification preference summary. |
pub struct UserPreferences | Full notification preferences for a user. |
pub struct UpdatePreferencesRequest | Request to update notification preferences. |
pub struct PreferenceUpdate | Single preference update. |
pub struct TemplateSummary | Notification template summary. |
pub struct CreateTemplateRequest | Request to create a notification template. |
pub struct NotificationsListQuery | Notifications list query parameters. |
pub struct MarkReadRequest | Mark notifications as read request. |
pub struct NotificationStats | Notification stats. |
pub struct TypeCount | Count by type. |
`organization`
| Item | What it is |
|---|---|
pub struct OrganizationSummary | Organization summary for list views. |
pub struct OrganizationDetail | Full organization details for detail/edit views. |
pub struct CreateOrganizationRequest | Request to create a new organization. |
pub struct UpdateOrganizationRequest | Request to update an existing organization. |
`pagination`
| Item | What it is |
|---|---|
pub enum SortOrder | Sort order direction. |
pub struct SortSpec | Sort specification. |
SortSpec :: fn new(field : impl Into <String>) -> Self | — |
SortSpec :: fn desc(field : impl Into <String>) -> Self | — |
pub enum FilterOp | Filter operator for field-based filtering. |
pub struct FilterCondition | A single filter condition. |
pub struct ListQuery | Standard list query parameters |
ListQuery :: fn default() -> Self | — |
ListQuery :: fn new() -> Self | Create a new list query with defaults. |
ListQuery :: fn with_search(mut self, search : impl Into <String>) -> Self | Set the search query. |
ListQuery :: fn with_page(mut self, page : u32) -> Self | Set the page number. |
ListQuery :: fn with_page_size(mut self, page_size : u32) -> Self | Set the page size. |
ListQuery :: fn with_sort(mut self, field : impl Into <String>, order : SortOrder) -> Self | Add a sort specification. |
ListQuery :: fn with_filter(mut self, field : impl Into <String>, value : impl Into <String>) -> Self | Add a simple filter. |
ListQuery :: fn offset(& self) -> u32 | Calculate offset for database queries. |
ListQuery :: fn limit(& self) -> u32 | Get limit for database queries. |
pub struct PageInfo | Pagination metadata in responses. |
PageInfo :: fn from_query(query : & ListQuery, total : u64) -> Self | Create page info from query and total count. |
PageInfo :: fn new(page : u32, page_size : u32, total : u64) -> Self | Create page info directly. |
pub struct ListResponse<T> | Standard paginated list response. |
ListResponse<T> :: fn new(items : Vec <T>, page_info : PageInfo) -> Self | Create a new list response. |
ListResponse<T> :: fn from_query(items : Vec <T>, query : & ListQuery, total : u64) -> Self | Create from query and total. |
ListResponse<T> :: fn empty(query : & ListQuery) -> Self | Create an empty response. |
ListResponse<T> :: fn map <U, F : FnMut(T) -> U>(self, f : F) -> ListResponse <U> | Map items to a different type. |
`party_address`
| Item | What it is |
|---|---|
pub struct PartyAddressDto | A party address for list/detail views — one shape for both, same rationale as ContactChannelDto (few enough fields that a summary projection buys nothing) |
pub struct CreatePartyAddressRequest | Request to create a new party address |
pub struct UpdatePartyAddressRequest | Request to update an existing party address |
`person`
| Item | What it is |
|---|---|
pub struct PersonSummary | Person summary for list views. |
pub struct PersonDetail | Full person details for detail/edit views. |
pub struct CreatePersonRequest | Request to create a new person. |
pub struct UpdatePersonRequest | Request to update an existing person. |
`posts`
| Item | What it is |
|---|---|
pub struct Post | A blog post (a cms_pages row where page_type='post') |
pub struct CreatePostRequest | Input for create |
pub struct UpdatePostRequest | Input for update — every field optional (PATCH semantics) |
pub struct PostListQuery | Query params for list endpoints |
`redirects`
| Item | What it is |
|---|---|
pub struct Redirect | A URL redirect rule from the cms_redirects table. |
pub struct UpsertRedirectRequest | Input for create + update — same shape per the engine's UpsertRedirectInput. |
`relationship`
| Item | What it is |
|---|---|
pub struct RelationshipDto | A relationship for list/detail views |
pub struct CreateRelationshipRequest | Request to create a new relationship |
pub struct UpdateRelationshipRequest | Request to update an existing relationship. |
`reservations`
| Item | What it is |
|---|---|
pub enum PoolStatus | Pool status. |
pub enum HoldStatus | Hold status. |
pub enum ReservationStatus | Reservation status. |
pub struct PoolSummary | Capacity pool summary for list views. |
pub struct PoolDetail | Full capacity pool details. |
pub struct CreatePoolRequest | Request to create a capacity pool. |
pub struct UpdatePoolRequest | Request to update a capacity pool. |
pub struct HoldSummary | Hold summary for list views. |
pub struct HoldDetail | Full hold details. |
pub struct CreateHoldRequest | Request to create a hold. |
pub struct ExtendHoldRequest | Request to extend a hold. |
pub struct ReservationSummary | Reservation summary for list views. |
pub struct ReservationDetail | Full reservation details. |
pub struct CreateReservationRequest | Request to create a reservation directly. |
pub struct CancelReservationRequest | Request to cancel a reservation. |
pub struct ConfirmationLookupRequest | Reservation lookup by confirmation code. |
pub struct PoolsListQuery | Pools list query parameters. |
pub struct ReservationsListQuery | Reservations list query parameters. |
pub struct PoolCapacityStats | Pool capacity stats. |
`response`
| Item | What it is |
|---|---|
pub enum ApiResponse<T> | Generic API response wrapper |
ApiResponse<T> :: fn success(data : T) -> Self | Create a success response with data. |
ApiResponse<T> :: fn success_with_message(data : T, message : impl Into <String>) -> Self | Create a success response with data and message. |
ApiResponse<T> :: fn error(error : crate::ApiError) -> Self | Create an error response. |
ApiResponse<T> :: fn is_success(& self) -> bool | Check if response is successful. |
ApiResponse<T> :: fn is_error(& self) -> bool | Check if response is an error. |
ApiResponse<T> :: fn data(& self) -> Option <& T> | Get the data if successful. |
ApiResponse<T> :: fn error_ref(& self) -> Option <& crate::ApiError> | Get the error if failed. |
pub struct DataResponse<T> | Simple data response wrapper (no envelope) |
DataResponse<T> :: fn new(data : T) -> Self | — |
DataResponse<T> :: fn with_message(mut self, message : impl Into <String>) -> Self | — |
DataResponse<T> :: fn with_request_id(mut self, request_id : impl Into <String>) -> Self | — |
pub struct EmptyResponse | Empty success response. |
EmptyResponse :: fn ok() -> Self | — |
EmptyResponse :: fn with_message(message : impl Into <String>) -> Self | — |
pub struct HealthResponse | Health check response. |
pub enum HealthStatus | — |
HealthResponse :: fn healthy(version : impl Into <String>) -> Self | — |
`reviews`
| Item | What it is |
|---|---|
pub struct Review | A review row from the reviews table. |
pub struct UpsertReviewRequest | — |
pub struct ReviewListQuery | Query params for list endpoints |
`revisions`
| Item | What it is |
|---|---|
pub struct RevisionSummary | Version summary for list responses. |
pub struct RevisionDetail | Full version detail including page content at that version. |
pub struct RevisionDiff | Diff between two versions. |
`scheduling`
| Item | What it is |
|---|---|
pub enum ScheduleStatus | Schedule status. |
pub enum TimeSlotStatus | Time slot status. |
pub enum AppointmentStatus | Appointment status. |
pub enum ExceptionType | Exception type. |
pub struct ScheduleSummary | Schedule summary for list views. |
pub struct ScheduleDetail | Full schedule details. |
pub struct CreateScheduleRequest | Request to create a schedule. |
pub struct UpdateScheduleRequest | Request to update a schedule. |
pub struct AvailabilitySummary | Availability block summary. |
pub struct AddAvailabilityRequest | Request to add availability. |
pub struct TimeSlotSummary | Time slot summary for list views. |
pub struct TimeSlotDetail | Full time slot details. |
pub struct CreateTimeSlotRequest | Request to create a time slot. |
pub struct GenerateSlotsRequest | Request to generate time slots from availability. |
pub struct AppointmentSummary | Appointment summary for list views. |
pub struct AppointmentDetail | Full appointment details. |
pub struct BookAppointmentRequest | Request to book an appointment. |
pub struct CancelAppointmentRequest | Request to cancel an appointment. |
pub struct RescheduleAppointmentRequest | Request to reschedule an appointment. |
pub struct ExceptionSummary | Schedule exception summary. |
pub struct AddExceptionRequest | Request to add a schedule exception. |
pub struct SchedulesListQuery | Schedules list query parameters. |
pub struct TimeSlotsListQuery | Time slots list query parameters. |
pub struct AppointmentsListQuery | Appointments list query parameters. |
pub struct AppointmentLookupRequest | Appointment lookup by confirmation code. |
pub struct CalendarView | Calendar view data. |
`search`
| Item | What it is |
|---|---|
pub struct SearchRequest | Search request query parameters. |
pub struct SearchResponse | Search response with results, pagination, and facets. |
pub struct SearchHit | A single search result hit. |
`settings`
| Item | What it is |
|---|---|
pub struct SettingValue | A single setting value with metadata. |
pub struct UpdateSettingsRequest | Request to update settings (partial merge). |
`taxonomy`
| Item | What it is |
|---|---|
pub struct CategorySummary | Category summary for list views. |
pub struct CategoryDetail | Full category details. |
pub struct CreateCategoryRequest | Request to create a category. |
pub struct UpdateCategoryRequest | Request to update a category. |
pub struct TagSummary | Tag summary for list views. |
pub struct TagDetail | Full tag details. |
pub struct CreateTagRequest | Request to create a tag. |
pub struct UpdateTagRequest | Request to update a tag. |
pub struct VocabularySummary | Vocabulary summary. |
pub struct VocabularyDetail | Full vocabulary details. |
pub struct CreateVocabularyRequest | Request to create a vocabulary. |
pub struct UpdateVocabularyRequest | Request to update a vocabulary. |
pub struct VocabularyListQuery | Vocabulary list query parameters. |
pub struct CategoryListQuery | Category list query parameters. |
pub struct TagListQuery | Tag list query parameters. |
pub struct TagEntityRequest | Request to tag an entity. |
pub struct CategorizeEntityRequest | Request to categorize an entity. |
`users`
| Item | What it is |
|---|---|
pub struct UserListQuery | Query parameters for listing users. |
UserListQuery :: fn default() -> Self | — |
pub struct CreateUserRequest | Request to create a user. |
pub struct UpdateUserRequest | Request to update a user. |
pub struct UpdateUserRolesRequest | Request to update user roles. |
pub struct UserSummary | User summary for list responses. |
pub struct UserDetail | Full user detail. |
Re-exports. Exported here, defined elsewhere.
| Export | Defined in |
|---|---|
DlpAlertRow | dlp::DlpAlertRow |
{AddContactNoteRequest,ContactDetail,ContactNote,ContactSubmission} | contact::{AddContactNoteRequest,ContactDetail,ContactNote,ContactSubmission} |
{ApiError,ErrorCode,FieldError} | error::{ApiError,ErrorCode,FieldError} |
{ApiKeyCreated,ApiKeySummary,CreateApiKeyRequest} | api_keys::{ApiKeyCreated,ApiKeySummary,CreateApiKeyRequest} |
{ApiResponse,DataResponse,EmptyResponse,HealthResponse} | response::{ApiResponse,DataResponse,EmptyResponse,HealthResponse} |
{AssetType,AssetVisibility,BulkUploadResponse,ExifDto,MediaAsset,MediaListQuery,MediaSummary,MediaVariant,PresignedUrlResponse,UpdateMediaRequest,UploadError,UploadResponse,} | media::{AssetType,AssetVisibility,BulkUploadResponse,ExifDto,MediaAsset,MediaListQuery,MediaSummary,MediaVariant,PresignedUrlResponse,UpdateMediaRequest,UploadError,UploadResponse,} |
{AttachRequest,Attachment,AttachmentAuditEvent,AttachmentListQuery,AttachmentWithAsset,AuditClass,Grant,GrantRequest,GrantSource,GranteeType,Permission,ReorderRequest,ReorderResponse,UpdateSortOrderRequest,Visibility,} | attachments::{AttachRequest,Attachment,AttachmentAuditEvent,AttachmentListQuery,AttachmentWithAsset,AuditClass,Grant,GrantRequest,GrantSource,GranteeType,Permission,ReorderRequest,ReorderResponse,UpdateSortOrderRequest,Visibility,} |
{AuditLogDetail,AuditLogQuery,AuditLogSummary} | audit_logs::{AuditLogDetail,AuditLogQuery,AuditLogSummary} |
{Claims,LoginRequest,LoginResponse,UserInfo} | auth::{Claims,LoginRequest,LoginResponse,UserInfo} |
{CmsCreatePageInput,CmsTranslationInput,ContentPage,CreatePageRequest,PageListQuery,PageStatus,PageSummary,PublishPageRequest,UpdatePageRequest,} | cms::{CmsCreatePageInput,CmsTranslationInput,ContentPage,CreatePageRequest,PageListQuery,PageStatus,PageSummary,PublishPageRequest,UpdatePageRequest,} |
{CmsFacetCount,CmsSearchHit,CmsSearchResponse} | cms_search::{CmsFacetCount,CmsSearchHit,CmsSearchResponse} |
{ContactChannelDto,CreateContactChannelRequest,UpdateContactChannelRequest,} | contact_channel::{ContactChannelDto,CreateContactChannelRequest,UpdateContactChannelRequest,} |
{CreateDiscoveryRunRequest,DiscoveryCandidateDto,DiscoveryCostEstimate,DiscoveryRunDto,ImportCandidateRequest,MarkDuplicateRequest,} | discovery::{CreateDiscoveryRunRequest,DiscoveryCandidateDto,DiscoveryCostEstimate,DiscoveryRunDto,ImportCandidateRequest,MarkDuplicateRequest,} |
{CreateOpportunityRequestasCreateCrmOpportunityRequest,CreateStageRequestasCreateCrmStageRequest,ItemsResponse,MoneyDto,MoveStageRequest,OpportunityDto,StageDto,} | crm::{CreateOpportunityRequestasCreateCrmOpportunityRequest,CreateStageRequestasCreateCrmStageRequest,ItemsResponse,MoneyDto,MoveStageRequest,OpportunityDto,StageDto,} |
{CreateOrganizationRequest,OrganizationDetail,OrganizationSummary,UpdateOrganizationRequest,} | organization::{CreateOrganizationRequest,OrganizationDetail,OrganizationSummary,UpdateOrganizationRequest,} |
{CreatePartyAddressRequest,PartyAddressDto,UpdatePartyAddressRequest} | party_address::{CreatePartyAddressRequest,PartyAddressDto,UpdatePartyAddressRequest} |
{CreatePersonRequest,PersonDetail,PersonSummary,UpdatePersonRequest} | person::{CreatePersonRequest,PersonDetail,PersonSummary,UpdatePersonRequest} |
{CreatePostRequest,Post,PostListQuery,UpdatePostRequest} | posts::{CreatePostRequest,Post,PostListQuery,UpdatePostRequest} |
{CreateRelationshipRequest,RelationshipDto,UpdateRelationshipRequest} | relationship::{CreateRelationshipRequest,RelationshipDto,UpdateRelationshipRequest} |
{CreateUserRequest,UpdateUserRequest,UpdateUserRolesRequest,UserDetail,UserListQuery,UserSummary,} | users::{CreateUserRequest,UpdateUserRequest,UpdateUserRolesRequest,UserDetail,UserListQuery,UserSummary,} |
{DirectoryListQuery,DirectoryListingDto,DirectoryStats,ListingStatus,ListingSummary,ListingType,TypeCount,UpdateListingRequest,UpdateListingStatusRequest,} | directory::{DirectoryListQuery,DirectoryListingDto,DirectoryStats,ListingStatus,ListingSummary,ListingType,TypeCount,UpdateListingRequest,UpdateListingStatusRequest,} |
{ListQuery,ListResponse,PageInfo,SortOrder} | pagination::{ListQuery,ListResponse,PageInfo,SortOrder} |
{Redirect,UpsertRedirectRequest} | redirects::{Redirect,UpsertRedirectRequest} |
{Review,ReviewListQuery,UpsertReviewRequest} | reviews::{Review,ReviewListQuery,UpsertReviewRequest} |
{RevisionDetail,RevisionDiff,RevisionSummary} | revisions::{RevisionDetail,RevisionDiff,RevisionSummary} |
{SearchHit,SearchRequest,SearchResponse} | search::{SearchHit,SearchRequest,SearchResponse} |
{SettingValue,UpdateSettingsRequest} | settings::{SettingValue,UpdateSettingsRequest} |
Boundary
Depends on no other workspace tier.
Shares tier platform with 9 other crates: platform-api, platform-corpus-console, platform-customer-ui, platform-disclosure-lab, platform-html-components, platform-leptos-components, platform-privacy-scan-api, platform-staff-ui, … (9 total).
_What this crate deliberately does NOT own is a judgment. No committed registry records one for it, so none is stated here._
Where it sits
| Tier (ontology) | platform |
| Architectural role (taxonomy) | unclassified (baselined) |
| Location | crates/platform/dto |
| Vocabulary in force (lexicon) | current |
Dependencies
Runtime, from outside the workspace.
| Crate | Requirement | Features | Optional | Only on |
|---|---|---|---|---|
chrono | ^0.4 | serde | no | always |
rust_decimal | ^1 | serde | no | always |
serde | ^1 | derive | no | always |
serde_json | ^1 | — | no | always |
thiserror | ^2 | — | no | always |
uuid | ^1 | v4, serde, js | no | always |
Development, from outside the workspace.
| Crate | Requirement | Features | Optional | Only on |
|---|---|---|---|---|
tokio-test | ^0.4 | — | no | always |
Build. None.
Depended on by. 27 workspace crates.
Signal flow — what reaches this crate, and what it reaches.
flowchart LR consumers["27 consumer crates"] -->|uses| SELF SELF["platform-dto"] classDef self fill:#1f883d,stroke:#1f883d,color:#fff; class SELF self;
Feature flags
No Cargo features are defined: every capability is unconditional, so no consumer can receive a half-wired crate.
Targets
| Kind | Name | Source |
|---|---|---|
| lib | platform_dto | `src/lib.rs` |
| test | field_coverage | `tests/field_coverage.rs` |
Error model
| Error type | Named by |
|---|---|
ApiError | declared, no public signature returns it |
FieldError | declared, no public signature returns it |
UploadError | declared, no public signature returns it |
Operational characteristics
| Property | Evidence |
|---|---|
| async public surface | none detected |
| async runtime | none detected |
| database access | none detected |
| network I/O | none detected |
| unsafe code | none detected |
| environment variables | none detected |
No unsafe block, unsafe fn, unsafe impl or unsafe trait was found by the parser anywhere in this crate's source.
Configuration
No environment variable is read with a literal name anywhere in this crate. A variable whose key is computed at run time cannot be listed here, and is not claimed to be absent.
Related capabilities
27 workspace crates depend on this one: application-agreements, application-ai, application-analytics, application-approvals, application-auth, application-calendar, application-catalog, application-classify, application-cms, application-comments, application-contact, application-core, … (27 total).
Verification
| Kind | Count |
|---|---|
| Unit tests | 17 |
| Integration tests | 6 |
| Examples | 0 |
| Doctests | 0 |
Evidence by module. How often each public module is named by something executable.
| Module | Tests | Examples | Consumers |
|---|---|---|---|
api_keys | 3 | 0 | 9 |
attachments | 15 | 0 | 20 |
audit_logs | 3 | 0 | 3 |
auth | 8 | 0 | 13 |
chess_widget | 1 | 0 | 1 |
cms | 9 | 0 | 16 |
cms_search | 3 | 0 | 2 |
comments | 12 | 0 | 10 |
contact | 4 | 0 | 4 |
contact_channel | 3 | 0 | 6 |
crm | 7 | 0 | 7 |
directory | 9 | 0 | 6 |
discovery | 6 | 0 | 3 |
dlp | 1 | 0 | 1 |
error | 3 | 0 | 33 |
gmail_recent | 2 | 0 | 2 |
ledger | 3 | 0 | 3 |
matches | 5 | 0 | 0 |
media | 12 | 0 | 21 |
notifications | 16 | 0 | 13 |
organization | 4 | 0 | 8 |
pagination | 7 | 0 | 16 |
party_address | 3 | 0 | 6 |
person | 4 | 0 | 8 |
posts | 4 | 0 | 4 |
redirects | 2 | 0 | 3 |
relationship | 3 | 0 | 4 |
reservations | 19 | 0 | 16 |
response | 5 | 0 | 1 |
reviews | 3 | 0 | 5 |
revisions | 3 | 0 | 3 |
scheduling | 26 | 0 | 21 |
search | 3 | 0 | 5 |
settings | 2 | 0 | 2 |
taxonomy | 17 | 0 | 15 |
users | 6 | 0 | 6 |
What the tests establish, by name:
every_writable_party_field_has_an_editor_in_the_staff_ui—tests/field_coverage.rsevery_writable_party_field_is_set_by_its_update_statement—tests/field_coverage.rsorganization_detail_carries_every_organization_column—tests/field_coverage.rsperson_detail_carries_every_person_column—tests/field_coverage.rsupdate_organization_request_can_write_every_organization_column—tests/field_coverage.rsupdate_person_request_can_write_every_person_column—tests/field_coverage.rstest_login_request_serialization—src/auth.rstest_user_info_role_and_permissions—src/auth.rstest_api_error_serialization—src/error.rstest_error_code_http_status—src/error.rsa_decline_request_has_nowhere_to_put_a_members_own_words—src/matches.rsa_match_is_keyed_by_account_and_cannot_carry_a_site_external_id—src/matches.rsa_match_survives_an_empty_profile—src/matches.rsthe_response_reports_endings_and_defers_apart—src/matches.rstest_list_query_defaults—src/pagination.rstest_list_query_offset—src/pagination.rstest_list_response_serialization—src/pagination.rstest_page_info—src/pagination.rsa_pre_sprint_payload_missing_the_six_new_keys_deserializes_to_none—src/person.rslead_fields_round_trip_through_serde_json—src/person.rstest_api_response_error—src/response.rstest_api_response_success—src/response.rstest_health_response—src/response.rs
Documentation coverage
| Measure | Documented | Total |
|---|---|---|
| Public items with rustdoc | 267 | 302 |
Public modules with a //! block | 36 | 36 |
pie showData
title Public items with rustdoc
"Documented" : 267
"No rustdoc detected" : 35
Metrics
| Metric | Value |
|---|---|
| Rust source files | 37 |
| Source lines | 5012 |
| Code lines | 3769 |
| Public API items | 302 |
| Public modules | 36 |
| Tests | 23 |
| Examples | 0 |
| Cargo features | 0 |
| Direct runtime dependencies | 6 |
| Workspace reverse dependencies | 27 |
pie showData
title Public API by kind
"enum" : 25
"function" : 1
"method" : 66
"struct" : 209
"type alias" : 1
pie showData
title Rust source composition
"Code" : 3769
"Blank or comment" : 1243
Generation
Rendered by tools-corpus corpus readme from repository evidence alone, renderer schema 2, lexicon current. No model, network service or database was consulted. Regenerate with tools-corpus corpus readme --write; verify with --check.