""" Options:
Date: 2026-09-10 05:44:49
Version: 8.22
Tip: To override a DTO option, remove "#" prefix before updating
BaseUrl: https://data.regent-college.edu

#GlobalNamespace: 
#AddServiceStackTypes: True
#AddResponseStatus: False
#AddImplicitVersion: 
#AddDescriptionAsComments: True
IncludeTypes: FinancialAidAllocationReviewRequest.*
#ExcludeTypes: 
#DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum
#DataClass: 
#DataClassJson: 
"""

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationCandidateResponse:
    application_uuid: Optional[str] = None
    uuid: Optional[str] = None
    regent_id: int = 0
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    application_start_term: Optional[str] = None
    current_status: Optional[str] = None
    submitted_date: Optional[datetime.datetime] = None
    eligibility_tier: Optional[str] = None
    award_target: Decimal = decimal.Decimal(0)
    committed_amount: Decimal = decimal.Decimal(0)
    unmet_amount: Decimal = decimal.Decimal(0)
    proposed_amount: Decimal = decimal.Decimal(0)
    incomplete_reason: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationCycleResponse:
    application_start_term: Optional[str] = None
    is_fallback_released: bool = False
    fallback_release_date: Optional[datetime.datetime] = None
    fallback_released_by: Optional[str] = None
    primary_candidates: Optional[List[FinancialAidAllocationCandidateResponse]] = None
    fallback_candidates: Optional[List[FinancialAidAllocationCandidateResponse]] = None
    manual_review_candidates: Optional[List[FinancialAidAllocationCandidateResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationProposalResponse:
    application_uuid: Optional[str] = None
    regent_id: int = 0
    student_name: Optional[str] = None
    application_start_term: Optional[str] = None
    eligibility_tier: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationAwardResponse:
    award_code: Optional[str] = None
    award_description: Optional[str] = None
    budget_amount: Decimal = decimal.Decimal(0)
    planned_or_offered_amount: Decimal = decimal.Decimal(0)
    accepted_or_issued_amount: Decimal = decimal.Decimal(0)
    committed_amount: Decimal = decimal.Decimal(0)
    reclaimable_amount: Decimal = decimal.Decimal(0)
    proposed_amount: Decimal = decimal.Decimal(0)
    projected_remaining_amount: Decimal = decimal.Decimal(0)
    must_award_whole_budget: bool = False
    requires_manual_review: bool = False
    manual_review_note: Optional[str] = None
    required_recipient_count: Optional[int] = None
    requires_equal_shares: bool = False
    application_cycles: Optional[List[FinancialAidAllocationCycleResponse]] = None
    proposals: Optional[List[FinancialAidAllocationProposalResponse]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationConflictResponse:
    award_code: Optional[str] = None
    award_description: Optional[str] = None
    application_start_term: Optional[str] = None
    fallback_application_uuid: Optional[str] = None
    fallback_student_name: Optional[str] = None
    fallback_status: Optional[str] = None
    reclaimable_amount: Decimal = decimal.Decimal(0)
    primary_application_uuid: Optional[str] = None
    primary_student_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationReviewResponse:
    response_status: Optional[ResponseStatus] = None
    reporting_term: Optional[str] = None
    budget_amount: Decimal = decimal.Decimal(0)
    committed_amount: Decimal = decimal.Decimal(0)
    proposed_amount: Decimal = decimal.Decimal(0)
    projected_unused_amount: Decimal = decimal.Decimal(0)
    actionable_unmet_amount: Decimal = decimal.Decimal(0)
    awards: Optional[List[FinancialAidAllocationAwardResponse]] = None
    incomplete_candidates: Optional[List[FinancialAidAllocationCandidateResponse]] = None
    conflicts: Optional[List[FinancialAidAllocationConflictResponse]] = None


# @Route("/Finance/FinancialAid/AllocationReview/{reporting_term}", "POST")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FinancialAidAllocationReviewRequest(IReturn[FinancialAidAllocationReviewResponse]):
    reporting_term: Optional[str] = None
    authorizing_uuid: Optional[str] = None