getTTSURLs, plus strongly-typed SpecialContract

Author: gwen-f

model/equaliq.smithy

@@ -14,6 +14,7 @@ service EqualIQ {
         ListContracts
         GetSpecialContract
         ListSpecialContracts
+        GetTTSURLs
         GetUploadURL
         UpdateContract
         DeleteContract
@@ -168,28 +169,63 @@ structure GetSpecialContractInput {
 
 structure GetSpecialContractOutput {
     @required
-    contractId: ContractId
+    contract: SpecialContractData
+}
 
+structure SpecialContractData {
     @required
-    name: String
+    id: ContractId
 
     @required
-    type: ContractType
+    type: String
 
-    @required
-    eqmode: Document
+    format: String
+    tts_directory_uuid: String
+    
+    // These fields may change, so keeping as Document for flexibility
+    parties: Document
+    financials: Document
+    ownership: Document
+    obligations: Document
+    duration: Document
+    risks: Document
 
+    // These are stable structures
     @required
-    sections: Document
+    eqmode: EQModeData
 
     @required
-    isOwner: Boolean
+    sections: SpecialContractSectionsList
+}
+
+@http(method: "POST", uri: "/getTTSURLs")
+operation GetTTSURLs {
+    input: GetTTSURLsInput
+    output: GetTTSURLsOutput
+    errors: [
+        AuthenticationError
+        ResourceNotFoundError
+        InternalServerError
+    ]
+}
 
+structure GetTTSURLsInput {
     @required
-    ownerId: UserId
+    contractId: ContractId
+}
 
+structure GetTTSURLsOutput {
     @required
-    sharedWith: UserIdList
+    contractId: ContractId
+    
+    @required
+    tts_presigned_urls: TTSPresignedUrlMap
+}
+
+// Map of audio source IDs to presigned URLs
+map TTSPresignedUrlMap {
+    key: String   // AudioSrcId
+    value: String // Presigned S3 URL
 }
 
 list QASectionsList {
@@ -630,6 +666,99 @@ structure FixedTermValue {
 }
 
 
+// Special Contract Structures (only the stable ones)
+
+// EQMode data structure - matches the eqmode field in seniSpecialData
+map EQModeData {
+    key: String      // Section key (e.g., "moneyYouReceive", "whatYouOwn")
+    value: EQModeCard
+}
+
+// Individual EQMode card
+structure EQModeCard {
+    @required
+    id: String
+    
+    @required
+    title: String
+    
+    @required
+    type: String
+    
+    eqTitle: String
+    totalAdvance: String
+    audioSrc: String
+    items: EQModeItemList
+}
+
+list EQModeItemList {
+    member: EQModeItem
+}
+
+structure EQModeItem {
+    title: String
+    value: String
+}
+
+// Sections structure - matches the sections field in seniSpecialData
+list SpecialContractSectionsList {
+    member: SpecialContractSection
+}
+
+structure SpecialContractSection {
+    @required
+    id: String
+    
+    @required
+    name: String
+    
+    @required
+    title: String
+    
+    @required
+    questions: SpecialContractQuestionList
+}
+
+list SpecialContractQuestionList {
+    member: SpecialContractQuestion
+}
+
+structure SpecialContractQuestion {
+    @required
+    question: String
+    
+    @required
+    perspective: QuestionPerspective
+    
+    @required
+    glossarizedTerm: GlossarizedTerm
+    
+    @required
+    audioSrc: QuestionAudioSrc
+}
+
+// Supporting structures for questions
+structure QuestionPerspective {
+    consultant: String
+    company: String
+}
+
+structure QuestionAudioSrc {
+    consultant: String
+    company: String
+}
+
+structure GlossarizedTerm {
+    @required
+    name: String
+    
+    @required
+    definition: String
+    
+    @required
+    section: String
+}
+
 // Common structures
 document Document
 

python/api_model/types/models.py

@@ -5,7 +5,7 @@
 from __future__ import annotations
 
 from enum import Enum
-from typing import Any, List, Optional
+from typing import Any, Dict, List, Optional
 
 from pydantic import BaseModel, Field, RootModel
 
@@ -59,6 +59,11 @@ class DeleteContractSignatureRequestContent(BaseModel):
     contractId: str
 
 
+class EQModeItem(BaseModel):
+    title: Optional[str] = None
+    value: Optional[str] = None
+
+
 class FixedTermValue(BaseModel):
     unit: str
     value: str
@@ -112,6 +117,12 @@ class GetUploadURLRequestContent(BaseModel):
     name: str
 
 
+class GlossarizedTerm(BaseModel):
+    name: str
+    definition: str
+    section: str
+
+
 class InternalServerErrorResponseContent(BaseModel):
     message: str
 
@@ -139,6 +150,16 @@ class QASection(BaseModel):
     qa: List[QA]
 
 
+class QuestionAudioSrc(BaseModel):
+    consultant: Optional[str] = None
+    company: Optional[str] = None
+
+
+class QuestionPerspective(BaseModel):
+    consultant: Optional[str] = None
+    company: Optional[str] = None
+
+
 class ResourceNotFoundErrorResponseContent(BaseModel):
     message: str
 
@@ -166,6 +187,24 @@ class SignatureStatus(Enum):
     pending = 'pending'
 
 
+class SpecialContractQuestion(BaseModel):
+    question: str
+    perspective: QuestionPerspective
+    glossarizedTerm: GlossarizedTerm
+    audioSrc: QuestionAudioSrc
+
+
+class SpecialContractSection(BaseModel):
+    id: str
+    name: str
+    title: str
+    questions: List[SpecialContractQuestion]
+
+
+class TTSPresignedUrlMap(RootModel[Optional[Dict[str, str]]]):
+    root: Optional[Dict[str, str]] = None
+
+
 class Term(BaseModel):
     name: str
     definition: str
@@ -257,6 +296,20 @@ class DeleteContractSignatureResponseContent(BaseModel):
     message: Optional[str] = None
 
 
+class EQModeCard(BaseModel):
+    id: str
+    title: str
+    type: str
+    eqTitle: Optional[str] = None
+    totalAdvance: Optional[str] = None
+    audioSrc: Optional[str] = None
+    items: Optional[List[EQModeItem]] = None
+
+
+class EQModeData(RootModel[Optional[Dict[str, EQModeCard]]]):
+    root: Optional[Dict[str, EQModeCard]] = None
+
+
 class ExposeTypesResponseContent(BaseModel):
     QASectionsList: Optional[List[QASection]] = None
 
@@ -282,6 +335,11 @@ class GetProfileResponseContent(BaseModel):
     profile: UserProfile
 
 
+class GetTTSURLsResponseContent(BaseModel):
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
+    tts_presigned_urls: TTSPresignedUrlMap
+
+
 class GetUploadURLResponseContent(BaseModel):
     url_info: PresignedPostData
 
@@ -313,3 +371,22 @@ class SignContractRequestContent(BaseModel):
 class SignContractResponseContent(BaseModel):
     result: SignContractResult
     message: Optional[str] = None
+
+
+class SpecialContractData(BaseModel):
+    id: str = Field(..., pattern='^[A-Za-z0-9-]+$')
+    type: str
+    format: Optional[str] = None
+    tts_directory_uuid: Optional[str] = None
+    parties: Optional[Any] = None
+    financials: Optional[Any] = None
+    ownership: Optional[Any] = None
+    obligations: Optional[Any] = None
+    duration: Optional[Any] = None
+    risks: Optional[Any] = None
+    eqmode: EQModeData
+    sections: List[SpecialContractSection]
+
+
+class GetSpecialContractResponseContent(BaseModel):
+    contract: SpecialContractData

typescript/src/index.ts

@@ -18,6 +18,9 @@ export type DeleteContractRequestContent = ExtractSchema<'DeleteContractRequestC
 export type DeleteContractResponseContent = ExtractSchema<'DeleteContractResponseContent'>
 export type DeleteContractSignatureRequestContent = ExtractSchema<'DeleteContractSignatureRequestContent'>
 export type DeleteContractSignatureResponseContent = ExtractSchema<'DeleteContractSignatureResponseContent'>
+export type EQModeCard = ExtractSchema<'EQModeCard'>
+export type EQModeData = ExtractSchema<'EQModeData'>
+export type EQModeItem = ExtractSchema<'EQModeItem'>
 export type ExposeTypesResponseContent = ExtractSchema<'ExposeTypesResponseContent'>
 export type FixedTermValue = ExtractSchema<'FixedTermValue'>
 export type FixedValueTermInference = ExtractSchema<'FixedValueTermInference'>
@@ -33,10 +36,11 @@ export type GetProfileRequestContent = ExtractSchema<'GetProfileRequestContent'>
 export type GetProfileResponseContent = ExtractSchema<'GetProfileResponseContent'>
 export type GetSpecialContractRequestContent = ExtractSchema<'GetSpecialContractRequestContent'>
 export type GetSpecialContractResponseContent = ExtractSchema<'GetSpecialContractResponseContent'>
-export type GetTextToSpeechRequestContent = ExtractSchema<'GetTextToSpeechRequestContent'>
-export type GetTextToSpeechResponseContent = ExtractSchema<'GetTextToSpeechResponseContent'>
+export type GetTTSURLsRequestContent = ExtractSchema<'GetTTSURLsRequestContent'>
+export type GetTTSURLsResponseContent = ExtractSchema<'GetTTSURLsResponseContent'>
 export type GetUploadURLRequestContent = ExtractSchema<'GetUploadURLRequestContent'>
 export type GetUploadURLResponseContent = ExtractSchema<'GetUploadURLResponseContent'>
+export type GlossarizedTerm = ExtractSchema<'GlossarizedTerm'>
 export type InternalServerErrorResponseContent = ExtractSchema<'InternalServerErrorResponseContent'>
 export type ListContractsResponseContent = ExtractSchema<'ListContractsResponseContent'>
 export type ListSpecialContractsResponseContent = ExtractSchema<'ListSpecialContractsResponseContent'>
@@ -45,12 +49,18 @@ export type PresignedPostData = ExtractSchema<'PresignedPostData'>
 export type ProcessingIncompleteErrorResponseContent = ExtractSchema<'ProcessingIncompleteErrorResponseContent'>
 export type QA = ExtractSchema<'QA'>
 export type QASection = ExtractSchema<'QASection'>
+export type QuestionAudioSrc = ExtractSchema<'QuestionAudioSrc'>
+export type QuestionPerspective = ExtractSchema<'QuestionPerspective'>
 export type ResourceNotFoundErrorResponseContent = ExtractSchema<'ResourceNotFoundErrorResponseContent'>
 export type ShareContractRequestContent = ExtractSchema<'ShareContractRequestContent'>
 export type ShareContractResponseContent = ExtractSchema<'ShareContractResponseContent'>
 export type SharedUserDetails = ExtractSchema<'SharedUserDetails'>
 export type SignContractRequestContent = ExtractSchema<'SignContractRequestContent'>
 export type SignContractResponseContent = ExtractSchema<'SignContractResponseContent'>
+export type SpecialContractData = ExtractSchema<'SpecialContractData'>
+export type SpecialContractQuestion = ExtractSchema<'SpecialContractQuestion'>
+export type SpecialContractSection = ExtractSchema<'SpecialContractSection'>
+export type TTSPresignedUrlMap = ExtractSchema<'TTSPresignedUrlMap'>
 export type Term = ExtractSchema<'Term'>
 export type UpdateContractRequestContent = ExtractSchema<'UpdateContractRequestContent'>
 export type UpdateContractResponseContent = ExtractSchema<'UpdateContractResponseContent'>