TTS API endpoints

Author: gwen-f

model/equaliq.smithy

@@ -27,6 +27,7 @@ service EqualIQ {
         GetContractSignatures
         UpdateSignatureStatus
         DeleteContractSignature
+        GetTextToSpeech
     ]
 
 }
@@ -698,3 +699,22 @@ structure DeleteContractSignatureOutput {
     message: String
 }
 
+@idempotent
+@http(method: "POST", uri: "/getTextToSpeech")
+operation GetTextToSpeech {
+    input: GetTextToSpeechInput
+    output: GetTextToSpeechOutput
+    errors: [
+        AuthenticationError,
+        ResourceNotFoundError,
+        InternalServerError
+    ]
+}
+structure GetTextToSpeechInput {
+    @required
+    text: String
+}
+structure GetTextToSpeechOutput {
+    @required
+    audioUrl: String
+}

python/api_model/types/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  api.json
-#   timestamp: 2025-05-26T18:04:34+00:00
+#   timestamp: 2025-06-09T23:34:37+00:00
 
 from __future__ import annotations
 
@@ -53,6 +53,10 @@ class DeleteContractResponseContent(BaseModel):
     success: bool
 
 
+class DeleteContractSignatureRequestContent(BaseModel):
+    contractId: str
+
+
 class FixedTermValue(BaseModel):
     unit: str
     value: str
@@ -66,10 +70,6 @@ class FixedValueTermInference(BaseModel):
     subterms: Optional[List[FixedTermValue]] = None
 
 
-class DeleteContractSignatureRequestContent(BaseModel):
-    contractId: str
-
-
 class GetContractReadURLRequestContent(BaseModel):
     contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
 
@@ -98,6 +98,14 @@ class GetProfileRequestContent(BaseModel):
     userId: Optional[str] = Field(None, pattern='^[A-Za-z0-9-]+$')
 
 
+class GetTextToSpeechRequestContent(BaseModel):
+    text: str
+
+
+class GetTextToSpeechResponseContent(BaseModel):
+    audioUrl: str
+
+
 class GetUploadURLRequestContent(BaseModel):
     name: str
 
@@ -145,14 +153,6 @@ class SharedUserDetails(BaseModel):
     sharedTime: float
 
 
-class Term(BaseModel):
-    name: str
-    definition: str
-    unitType: str
-    citation: Optional[str] = None
-    fixedValues: Optional[FixedValueTermInference] = None
-
-
 class SignContractResult(Enum):
     SUCCESS = 'SUCCESS'
     FAILURE = 'FAILURE'
@@ -164,6 +164,14 @@ class SignatureStatus(Enum):
     pending = 'pending'
 
 
+class Term(BaseModel):
+    name: str
+    definition: str
+    unitType: str
+    citation: Optional[str] = None
+    fixedValues: Optional[FixedValueTermInference] = None
+
+
 class UpdateContractRequestContent(BaseModel):
     contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     name: str
@@ -242,6 +250,11 @@ class ContractSummaryItem(BaseModel):
     sharedEmails: Optional[List[str]] = None
 
 
+class DeleteContractSignatureResponseContent(BaseModel):
+    result: Optional[SignContractResult] = None
+    message: Optional[str] = None
+
+
 class ExposeTypesResponseContent(BaseModel):
     QASectionsList: Optional[List[QASection]] = None
 
@@ -257,11 +270,6 @@ class GetContractResponseContent(BaseModel):
     sharedWith: List[SharedWithItem]
 
 
-class DeleteContractSignatureResponseContent(BaseModel):
-    result: Optional[SignContractResult] = None
-    message: Optional[str] = None
-
-
 class GetContractSignaturesResponseContent(BaseModel):
     contractId: Optional[str] = None
     signatures: Optional[List[ContractSignature]] = None
@@ -298,14 +306,3 @@ class SignContractRequestContent(BaseModel):
 class SignContractResponseContent(BaseModel):
     result: SignContractResult
     message: Optional[str] = None
-
-
-class GetContractResponseContent(BaseModel):
-    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
-    name: str
-    type: ContractType
-    terms: Any
-    iq_qa: QASections
-    isOwner: bool
-    ownerId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
-    sharedWith: List[SharedWithItem]

typescript/src/index.ts

@@ -19,11 +19,11 @@ export type ContractSummaryItem = ExtractSchema<'ContractSummaryItem'>
 export type ContractType = ExtractSchema<'ContractType'>
 export type DeleteContractRequestContent = ExtractSchema<'DeleteContractRequestContent'>
 export type DeleteContractResponseContent = ExtractSchema<'DeleteContractResponseContent'>
+export type DeleteContractSignatureRequestContent = ExtractSchema<'DeleteContractSignatureRequestContent'>
+export type DeleteContractSignatureResponseContent = ExtractSchema<'DeleteContractSignatureResponseContent'>
 export type ExposeTypesResponseContent = ExtractSchema<'ExposeTypesResponseContent'>
 export type FixedTermValue = ExtractSchema<'FixedTermValue'>
 export type FixedValueTermInference = ExtractSchema<'FixedValueTermInference'>
-export type DeleteContractSignatureRequestContent = ExtractSchema<'DeleteContractSignatureRequestContent'>
-export type DeleteContractSignatureResponseContent = ExtractSchema<'DeleteContractSignatureResponseContent'>
 export type GetContractReadURLRequestContent = ExtractSchema<'GetContractReadURLRequestContent'>
 export type GetContractReadURLResponseContent = ExtractSchema<'GetContractReadURLResponseContent'>
 export type GetContractRequestContent = ExtractSchema<'GetContractRequestContent'>
@@ -34,6 +34,8 @@ export type GetProfilePictureRequestContent = ExtractSchema<'GetProfilePictureRe
 export type GetProfilePictureResponseContent = ExtractSchema<'GetProfilePictureResponseContent'>
 export type GetProfileRequestContent = ExtractSchema<'GetProfileRequestContent'>
 export type GetProfileResponseContent = ExtractSchema<'GetProfileResponseContent'>
+export type GetTextToSpeechRequestContent = ExtractSchema<'GetTextToSpeechRequestContent'>
+export type GetTextToSpeechResponseContent = ExtractSchema<'GetTextToSpeechResponseContent'>
 export type GetUploadURLRequestContent = ExtractSchema<'GetUploadURLRequestContent'>
 export type GetUploadURLResponseContent = ExtractSchema<'GetUploadURLResponseContent'>
 export type InternalServerErrorResponseContent = ExtractSchema<'InternalServerErrorResponseContent'>
@@ -47,11 +49,11 @@ export type ResourceNotFoundErrorResponseContent = ExtractSchema<'ResourceNotFou
 export type ShareContractRequestContent = ExtractSchema<'ShareContractRequestContent'>
 export type ShareContractResponseContent = ExtractSchema<'ShareContractResponseContent'>
 export type SharedUserDetails = ExtractSchema<'SharedUserDetails'>
-export type Term = ExtractSchema<'Term'>
 export type SignContractRequestContent = ExtractSchema<'SignContractRequestContent'>
 export type SignContractResponseContent = ExtractSchema<'SignContractResponseContent'>
 export type SignContractResult = ExtractSchema<'SignContractResult'>
 export type SignatureStatus = ExtractSchema<'SignatureStatus'>
+export type Term = ExtractSchema<'Term'>
 export type UpdateContractRequestContent = ExtractSchema<'UpdateContractRequestContent'>
 export type UpdateContractResponseContent = ExtractSchema<'UpdateContractResponseContent'>
 export type UpdateProfileRequestContent = ExtractSchema<'UpdateProfileRequestContent'>

typescript/src/models.ts

@@ -116,6 +116,22 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/getTextToSpeech": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["GetTextToSpeech"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/listContracts": {
         parameters: {
             query?: never;
@@ -314,6 +330,13 @@ export interface components {
         DeleteContractResponseContent: {
             success: boolean;
         };
+        DeleteContractSignatureRequestContent: {
+            contractId: string;
+        };
+        DeleteContractSignatureResponseContent: {
+            result?: components["schemas"]["SignContractResult"];
+            message?: string;
+        };
         ExposeTypesResponseContent: {
             QASectionsList?: components["schemas"]["QASection"][];
         };
@@ -329,13 +352,6 @@ export interface components {
             primary: components["schemas"]["FixedTermValue"];
             subterms?: components["schemas"]["FixedTermValue"][];
         };
-        DeleteContractSignatureRequestContent: {
-            contractId: string;
-        };
-        DeleteContractSignatureResponseContent: {
-            result?: components["schemas"]["SignContractResult"];
-            message?: string;
-        };
         GetContractReadURLRequestContent: {
             contractId: string;
         };
@@ -375,6 +391,12 @@ export interface components {
             userId: string;
             profile: components["schemas"]["UserProfile"];
         };
+        GetTextToSpeechRequestContent: {
+            text: string;
+        };
+        GetTextToSpeechResponseContent: {
+            audioUrl: string;
+        };
         GetUploadURLRequestContent: {
             name: string;
         };
@@ -428,13 +450,6 @@ export interface components {
             /** Format: double */
             sharedTime: number;
         };
-        Term: {
-            name: string;
-            definition: string;
-            unitType: string;
-            citation?: string;
-            fixedValues?: components["schemas"]["FixedValueTermInference"];
-        };
         SignContractRequestContent: {
             contractId: string;
             status: components["schemas"]["SignatureStatus"];
@@ -444,9 +459,16 @@ export interface components {
             message?: string;
         };
         /** @enum {string} */
-        SignContractResult: "SUCCESS" | "FAILURE";
+        SignContractResult: SignContractResult;
         /** @enum {string} */
-        SignatureStatus: "signed" | "declined" | "pending";
+        SignatureStatus: SignatureStatus;
+        Term: {
+            name: string;
+            definition: string;
+            unitType: string;
+            citation?: string;
+            fixedValues?: components["schemas"]["FixedValueTermInference"];
+        };
         UpdateContractRequestContent: {
             contractId: string;
             name: string;
@@ -799,6 +821,48 @@ export interface operations {
             };
         };
     };
+    GetTextToSpeech: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["GetTextToSpeechRequestContent"];
+            };
+        };
+        responses: {
+            /** @description GetTextToSpeech 200 response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetTextToSpeechResponseContent"];
+                };
+            };
+            /** @description ResourceNotFoundError 400 response */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ResourceNotFoundErrorResponseContent"];
+                };
+            };
+            /** @description InternalServerError 500 response */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InternalServerErrorResponseContent"];
+                };
+            };
+        };
+    };
     ListContracts: {
         parameters: {
             query?: never;
@@ -1192,3 +1256,12 @@ export enum ContractType {
     producer = "producer",
     tbd = "tbd"
 }
+export enum SignContractResult {
+    SUCCESS = "SUCCESS",
+    FAILURE = "FAILURE"
+}
+export enum SignatureStatus {
+    signed = "signed",
+    declined = "declined",
+    pending = "pending"
+}