Refactor, calling out deprecated v0 to v1

Author: ParkerVR

model/contracts.smithy

@@ -29,6 +29,21 @@ enum ContractVariableType {
     INTERNAL_CITATION = "internal_citation"
 }
 
+structure EqSection {
+  @documentation("deprecation path (v0.5)")
+  terms: TermsList
+
+  //v1 version
+  eqModeData: EQModeData
+}
+
+structure IqSection {
+  @documentation("deprecation path (v0.5)")
+  qa_sections: QASectionsList
+
+  // v1 version
+
+}
 
 // Contract operations
 @http(method: "POST", uri: "/getContract")
@@ -58,12 +73,15 @@ structure GetContractOutput {
     @required
     type: ContractType
 
-    @required
+    @documentation("deprecation path (v0)")
     terms: TermsList
 
-    @required
+    @documentation("deprecation path (v0)")
     qa_sections: String
 
+    eq_section: EqSection
+    iq_section: IqSection
+
     @required
     isOwner: Boolean
 
@@ -452,34 +470,90 @@ structure QA {
 }
 
 // Special Contract Structures (only the stable ones)
+enum EqCardKey {
+  MONEY_RECEIVED = "moneyYouReceive"
+  OWNERSHIP = "whatYouOwn"
+  RESPONSIBILITES = "whatYoureResponsibleFor"
+  DURATION = "howLongThisDealLasts"
+  LEGAL = "risksCostsLegalStuff"
+}
+
+// TODO Gwyn fill out these card structures
+structure EqMoneyCard {
+    majorNumber: String,
+}
+
+structure EqOwnershipCard {
+}
+
+structure EqResponsibilitesCard {
+}
+
+structure EqDurationCard {
+    durationText: String,
+    endDate: String,
+}
+
+structure EqLegalCard {
+}
+
+union EqCardUniqueData {
+  MONEY_RECEIVED: EqMoneyCard
+  OWNERSHIP: EqOwnershipCard
+  RESPONSIBILITES: EqResponsibilitesCard 
+  DURATION: EqDurationCard
+  LEGAL: EqLegalCard
+  EMPTY: EmptyStructure
+}
 
 // EQMode data structure - matches the eqmode field in seniSpecialData
 map EQModeData {
-    key: String      // Section key (e.g., "moneyYouReceive", "whatYouOwn")
+    key: EqCardKey
     value: EQModeCard
 }
 
+enum EqCardType {
+  @documentation("v0")
+  A = "A"
+  
+  @documentation("v1")
+  B = "B"
+}
+
 // Individual EQMode card
 structure EQModeCard {
     @required
-    id: String
+    id: EqCardKey
 
     @required
     title: String
 
     @required
-    type: String
+    type: EqCardType
+
+    @required
+    cardUniqueData: EqCardUniqueData
 
+    @documentation("Deprecated, use subTitle Instead")
     eqTitle: String
+    subTitle: String
+
+    @documentation("Deprecated, this should be in the in a custom subtype")
     totalAdvance: String
-    audioSrc: String
+
+    @documentation("Deprecated, this should be in the in a custom subtype")
     items: EQModeItemList
-}
 
+    @documentation("Deprecated, use the ttsSrcUrl")
+    audioSrc: String
+
+    ttsSrcUrl: Url
+}
+@documentation("Deprecated")
 list EQModeItemList {
     member: EQModeItem
 }
-
+@documentation("Deprecated")
 structure EQModeItem {
     title: String
     value: String
@@ -544,6 +618,7 @@ structure GlossarizedTerm {
     section: String
 }
 
+// Deprecated. Currently, used for SpecialContract only. Use alternative for real contract.
 @http(method: "POST", uri: "/getTTSURLs")
 operation GetTTSURLs {
     input: GetTTSURLsInput
@@ -555,19 +630,22 @@ operation GetTTSURLs {
     ]
 }
 
+// Deprecated. Currently, used for SpecialContract only. Use alternative for real contract.
 structure GetTTSURLsInput {
     @required
     contractId: ContractId
 }
 
+// Deprecated. Currently, used for SpecialContract only. Use alternative for real contract.
 structure GetTTSURLsOutput {
     @required
     contractId: ContractId
 
     @required
-    tts_presigned_urls: TTSPresignedUrlMap
+    ttsSrcUrl: TTSPresignedUrlMap
 }
 
+// Deprecated. Currently, used for SpecialContract only. Use alternative for real contract.
 // Map of audio source IDs to presigned URLs
 map TTSPresignedUrlMap {
     key: String   // AudioSrcId

model/util.smithy

@@ -4,6 +4,10 @@ namespace equaliq
 
 // Shared types used across operations - keep these in main file for reference
 
+structure EmptyStructure {
+    // Empty structure - avoid using, but useful in data migrations or making union workable
+}
+
 // Common patterns
 @mixin
 @pattern("^[A-Za-z0-9-]+$")
@@ -12,6 +16,8 @@ string UuidLikeMixin
 @pattern("^[\\w-\\.]+@[\\w-\\.]+\\.+[\\w-]{1,63}$")
 string Email
 
+string Url // Putting a regex on this is a nightmare, so leaving it open for now
+
 // Generics
 list StringList {
     member: String

python/api_model/types/models.py

@@ -278,6 +278,10 @@ class ContractVariable(BaseModel):
     definitionCitation: Optional[str] = None
 
 
+class EqSection(BaseModel):
+    terms: Optional[List[Term]] = None
+
+
 class ExposeTypesResponseContent(BaseModel):
     QASectionsList: Optional[List[QASection]] = None
     ContractVariable_1: Optional[ContractVariable] = Field(
@@ -288,17 +292,6 @@ class ExposeTypesResponseContent(BaseModel):
     )
 
 
-class GetContractResponseContent(BaseModel):
-    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
-    name: str
-    type: ContractType
-    terms: List[Term]
-    qa_sections: str
-    isOwner: bool
-    ownerId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
-    sharedWith: List[SharedWithItem]
-
-
 class GetProfileResponseContent(BaseModel):
     userId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     profile: UserProfile
@@ -313,6 +306,10 @@ class GetUploadURLResponseContent(BaseModel):
     url_info: PresignedPostData
 
 
+class IqSection(BaseModel):
+    qa_sections: Optional[List[QASection]] = None
+
+
 class ListContractsResponseContent(BaseModel):
     owned: List[ContractSummaryItem]
     shared: List[ContractSummaryItem]
@@ -330,3 +327,16 @@ class ShareContractResponseContent(BaseModel):
     added: Optional[List[AddedItem]] = None
     removed: Optional[List[RemovedItem]] = None
     invalidRemoves: Optional[List[InvalidRemove]] = None
+
+
+class GetContractResponseContent(BaseModel):
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
+    name: str
+    type: ContractType
+    terms: Optional[List[Term]] = None
+    qa_sections: Optional[str] = None
+    eq_section: Optional[EqSection] = None
+    iq_section: Optional[IqSection] = None
+    isOwner: bool
+    ownerId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
+    sharedWith: List[SharedWithItem]

typescript/src/index.ts

@@ -16,6 +16,7 @@ export type ContractSummaryItem = ExtractSchema<'ContractSummaryItem'>
 export type ContractVariable = ExtractSchema<'ContractVariable'>
 export type DeleteContractRequestContent = ExtractSchema<'DeleteContractRequestContent'>
 export type DeleteContractResponseContent = ExtractSchema<'DeleteContractResponseContent'>
+export type EqSection = ExtractSchema<'EqSection'>
 export type ExposeTypesResponseContent = ExtractSchema<'ExposeTypesResponseContent'>
 export type FixedTermValue = ExtractSchema<'FixedTermValue'>
 export type FixedValueTermInference = ExtractSchema<'FixedValueTermInference'>
@@ -34,6 +35,7 @@ export type GetTTSURLsResponseContent = ExtractSchema<'GetTTSURLsResponseContent
 export type GetUploadURLRequestContent = ExtractSchema<'GetUploadURLRequestContent'>
 export type GetUploadURLResponseContent = ExtractSchema<'GetUploadURLResponseContent'>
 export type InternalServerErrorResponseContent = ExtractSchema<'InternalServerErrorResponseContent'>
+export type IqSection = ExtractSchema<'IqSection'>
 export type ListContractsResponseContent = ExtractSchema<'ListContractsResponseContent'>
 export type ListSpecialContractsResponseContent = ExtractSchema<'ListSpecialContractsResponseContent'>
 export type PingResponseContent = ExtractSchema<'PingResponseContent'>

typescript/src/models.ts

@@ -308,6 +308,9 @@ export interface components {
         DeleteContractResponseContent: {
             success: boolean;
         };
+        EqSection: {
+            terms?: components["schemas"]["Term"][];
+        };
         ExposeTypesResponseContent: {
             QASectionsList?: components["schemas"]["QASection"][];
             ContractVariable?: components["schemas"]["ContractVariable"];
@@ -338,8 +341,10 @@ export interface components {
             contractId: string;
             name: string;
             type: components["schemas"]["ContractType"];
-            terms: components["schemas"]["Term"][];
-            qa_sections: string;
+            terms?: components["schemas"]["Term"][];
+            qa_sections?: string;
+            eq_section?: components["schemas"]["EqSection"];
+            iq_section?: components["schemas"]["IqSection"];
             isOwner: boolean;
             ownerId: string;
             sharedWith: string[];
@@ -386,6 +391,9 @@ export interface components {
         InternalServerErrorResponseContent: {
             message: string;
         };
+        IqSection: {
+            qa_sections?: components["schemas"]["QASection"][];
+        };
         ListContractsResponseContent: {
             owned: components["schemas"]["ContractSummaryItem"][];
             shared: components["schemas"]["ContractSummaryItem"][];