add demo endpoints

Author: gwen-f

model/equaliq.smithy

@@ -12,6 +12,8 @@ service EqualIQ {
     operations: [
         GetContract
         ListContracts
+        GetDemoContract
+        ListDemoContracts
         GetUploadURL
         UpdateContract
         DeleteContract
@@ -190,6 +192,70 @@ structure ListContractsOutput {
     shared: ContractSummaryList
 }
 
+@http(method: "POST", uri: "/getDemoContract")
+operation GetDemoContract {
+    input: GetDemoContractInput
+    output: GetDemoContractOutput
+    errors: [
+        AuthenticationError
+        ResourceNotFoundError
+        InternalServerError
+    ]
+}
+
+structure GetDemoContractInput {
+    @required
+    contractId: ContractId
+}
+
+structure GetDemoContractOutput {
+    @required
+    contractId: ContractId
+
+    @required
+    name: String
+
+    @required
+    type: ContractType
+
+    @required
+    terms: TermsList
+
+    @required
+    qa_sections: String
+
+    @required
+    isOwner: Boolean
+
+    @required
+    ownerId: UserId
+
+    @required
+    sharedWith: UserIdList
+}
+
+@http(method: "POST", uri: "/listDemoContracts")
+operation ListDemoContracts {
+    input: ListDemoContractsInput
+    output: ListDemoContractsOutput
+    errors: [
+        AuthenticationError
+        InternalServerError
+    ]
+}
+
+structure ListDemoContractsInput {
+    // Empty input - authentication handled via Bearer token
+}
+
+structure ListDemoContractsOutput {
+    @required
+    owned: ContractSummaryList
+
+    @required
+    shared: ContractSummaryList
+}
+
 list ContractSummaryList {
     member: ContractSummaryItem
 }

python/api_model/types/models.py

@@ -87,6 +87,10 @@ class GetContractSignaturesRequestContent(BaseModel):
     contractId: str
 
 
+class GetDemoContractRequestContent(BaseModel):
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
+
+
 class GetProfilePictureRequestContent(BaseModel):
     userId: Optional[str] = Field(None, pattern='^[A-Za-z0-9-]+$')
 
@@ -276,6 +280,17 @@ class GetContractSignaturesResponseContent(BaseModel):
     signatures: Optional[List[ContractSignature]] = None
 
 
+class GetDemoContractResponseContent(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
@@ -290,6 +305,11 @@ class ListContractsResponseContent(BaseModel):
     shared: List[ContractSummaryItem]
 
 
+class ListDemoContractsResponseContent(BaseModel):
+    owned: List[ContractSummaryItem]
+    shared: List[ContractSummaryItem]
+
+
 class ShareContractResponseContent(BaseModel):
     success: bool
     contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')

typescript/src/index.ts

@@ -27,6 +27,8 @@ export type GetContractRequestContent = ExtractSchema<'GetContractRequestContent
 export type GetContractResponseContent = ExtractSchema<'GetContractResponseContent'>
 export type GetContractSignaturesRequestContent = ExtractSchema<'GetContractSignaturesRequestContent'>
 export type GetContractSignaturesResponseContent = ExtractSchema<'GetContractSignaturesResponseContent'>
+export type GetDemoContractRequestContent = ExtractSchema<'GetDemoContractRequestContent'>
+export type GetDemoContractResponseContent = ExtractSchema<'GetDemoContractResponseContent'>
 export type GetProfilePictureRequestContent = ExtractSchema<'GetProfilePictureRequestContent'>
 export type GetProfilePictureResponseContent = ExtractSchema<'GetProfilePictureResponseContent'>
 export type GetProfileRequestContent = ExtractSchema<'GetProfileRequestContent'>
@@ -37,6 +39,7 @@ export type GetUploadURLRequestContent = ExtractSchema<'GetUploadURLRequestConte
 export type GetUploadURLResponseContent = ExtractSchema<'GetUploadURLResponseContent'>
 export type InternalServerErrorResponseContent = ExtractSchema<'InternalServerErrorResponseContent'>
 export type ListContractsResponseContent = ExtractSchema<'ListContractsResponseContent'>
+export type ListDemoContractsResponseContent = ExtractSchema<'ListDemoContractsResponseContent'>
 export type PingResponseContent = ExtractSchema<'PingResponseContent'>
 export type PresignedPostData = ExtractSchema<'PresignedPostData'>
 export type ProcessingIncompleteErrorResponseContent = ExtractSchema<'ProcessingIncompleteErrorResponseContent'>

typescript/src/models.ts

@@ -84,6 +84,22 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/getDemoContract": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["GetDemoContract"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/getProfile": {
         parameters: {
             query?: never;
@@ -148,6 +164,22 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/listDemoContracts": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["ListDemoContracts"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/notARealEndpoint": {
         parameters: {
             query?: never;
@@ -378,6 +410,19 @@ export interface components {
             contractId?: string;
             signatures?: components["schemas"]["ContractSignature"][];
         };
+        GetDemoContractRequestContent: {
+            contractId: string;
+        };
+        GetDemoContractResponseContent: {
+            contractId: string;
+            name: string;
+            type: components["schemas"]["ContractType"];
+            terms: components["schemas"]["Term"][];
+            qa_sections: string;
+            isOwner: boolean;
+            ownerId: string;
+            sharedWith: string[];
+        };
         GetProfilePictureRequestContent: {
             userId?: string;
         };
@@ -410,6 +455,10 @@ export interface components {
             owned: components["schemas"]["ContractSummaryItem"][];
             shared: components["schemas"]["ContractSummaryItem"][];
         };
+        ListDemoContractsResponseContent: {
+            owned: components["schemas"]["ContractSummaryItem"][];
+            shared: components["schemas"]["ContractSummaryItem"][];
+        };
         PingResponseContent: {
             message: string;
         };
@@ -737,6 +786,48 @@ export interface operations {
             };
         };
     };
+    GetDemoContract: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["GetDemoContractRequestContent"];
+            };
+        };
+        responses: {
+            /** @description GetDemoContract 200 response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetDemoContractResponseContent"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
     GetProfile: {
         parameters: {
             query?: never;
@@ -901,6 +992,44 @@ export interface operations {
             };
         };
     };
+    ListDemoContracts: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description ListDemoContracts 200 response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ListDemoContractsResponseContent"];
+                };
+            };
+            /** @description AuthenticationError 400 response */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AuthenticationErrorResponseContent"];
+                };
+            };
+            /** @description InternalServerError 500 response */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["InternalServerErrorResponseContent"];
+                };
+            };
+        };
+    };
     ExposeTypes: {
         parameters: {
             query?: never;