Merge pull request #1 from Equal-IQ/contract-signature-logic

Contract signature logic

Author: ParkerVR

model/equaliq.smithy

@@ -23,6 +23,10 @@ service EqualIQ {
         UpdateProfile
         Ping
         ExposeTypes
+        SignContract
+        GetContractSignatures
+        UpdateSignatureStatus
+        DeleteContractSignature
     ]
 
 }
@@ -72,6 +76,28 @@ enum AccountType {
     PUBLISHER = "publisher"
 }
 
+enum SignatureStatus {
+    SIGNED = "signed"
+    DECLINED = "declined"
+    PENDING = "pending"
+}
+
+enum SignContractResult {
+    SUCCESS 
+    FAILURE
+}
+
+enum SignatureStatus {
+    SIGNED = "signed"
+    DECLINED = "declined"
+    PENDING = "pending"
+}
+
+enum SignContractResult {
+    SUCCESS 
+    FAILURE
+}
+
 // Contract operations
 @http(method: "POST", uri: "/getContract")
 operation GetContract {
@@ -565,3 +591,110 @@ structure InternalServerError {
     @required
     message: String
 }
+
+@idempotent
+@http(method: "POST", uri: "/sign")
+operation SignContract {
+    input: SignContractInput
+    output: SignContractOutput
+    errors: [
+        AuthenticationError,
+        ValidationError,
+        ResourceNotFoundError,
+        InternalServerError
+    ]
+}
+
+structure SignContractInput {
+    @required
+    contractId: String
+    @required
+    status: SignatureStatus
+}
+
+structure SignContractOutput {
+    @required
+    result: SignContractResult
+    message: String
+}
+
+
+@http(method: "POST", uri: "/getContractSignatures")
+operation GetContractSignatures {
+    input: GetContractSignaturesInput
+    output: GetContractSignaturesOutput
+    errors: [
+        AuthenticationError,
+        ResourceNotFoundError,
+        InternalServerError
+    ]
+}
+
+structure GetContractSignaturesInput {
+    @required
+    contractId: String
+}
+
+list SignatureList {
+    member: ContractSignature
+}
+
+structure ContractSignature {
+    userId: String
+    status: SignatureStatus
+    timestamp: Timestamp
+}
+
+structure GetContractSignaturesOutput {
+    contractId: String
+    signatures: SignatureList
+}
+
+@http(method: "POST", uri: "/updateSignatureStatus")
+operation UpdateSignatureStatus {
+    input: UpdateSignatureStatusInput
+    output: UpdateSignatureStatusOutput
+    errors: [
+        AuthenticationError,
+        ValidationError,
+        ResourceNotFoundError,
+        InternalServerError
+    ]
+}
+structure UpdateSignatureStatusInput {
+    @required
+    contractId: ContractId
+    @required
+    status: SignatureStatus
+}
+
+structure UpdateSignatureStatusOutput {
+    @required
+    result: SignContractResult
+    @required
+    message: String
+}
+
+
+@idempotent
+@http(method: "POST", uri: "/deleteContractSignature")
+operation DeleteContractSignature {
+    input: DeleteContractSignatureInput
+    output: DeleteContractSignatureOutput
+    errors: [
+        AuthenticationError,
+        ResourceNotFoundError,
+        InternalServerError
+    ]
+}
+
+structure DeleteContractSignatureInput {
+    @required
+    contractId: String
+}
+
+structure DeleteContractSignatureOutput {
+    result: SignContractResult
+    message: String
+}
+

package-lock.json

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  api.json
-#   timestamp: 2025-05-25T00:20:39+00:00
+#   timestamp: 2025-05-26T18:04:34+00:00
 
 from __future__ import annotations
 
@@ -66,6 +66,10 @@ class FixedValueTermInference(BaseModel):
     subterms: Optional[List[FixedTermValue]] = None
 
 
+class DeleteContractSignatureRequestContent(BaseModel):
+    contractId: str
+
+
 class GetContractReadURLRequestContent(BaseModel):
     contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
 
@@ -78,6 +82,10 @@ class GetContractRequestContent(BaseModel):
     contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
 
 
+class GetContractSignaturesRequestContent(BaseModel):
+    contractId: str
+
+
 class GetProfilePictureRequestContent(BaseModel):
     userId: Optional[str] = Field(None, pattern='^[A-Za-z0-9-]+$')
 
@@ -145,6 +153,17 @@ class Term(BaseModel):
     fixedValues: Optional[FixedValueTermInference] = None
 
 
+class SignContractResult(Enum):
+    SUCCESS = 'SUCCESS'
+    FAILURE = 'FAILURE'
+
+
+class SignatureStatus(Enum):
+    signed = 'signed'
+    declined = 'declined'
+    pending = 'pending'
+
+
 class UpdateContractRequestContent(BaseModel):
     contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     name: str
@@ -170,6 +189,16 @@ class UpdateProfileResponseContent(BaseModel):
     updatedFields: Optional[List[str]] = None
 
 
+class UpdateSignatureStatusRequestContent(BaseModel):
+    contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
+    status: SignatureStatus
+
+
+class UpdateSignatureStatusResponseContent(BaseModel):
+    result: SignContractResult
+    message: str
+
+
 class UploadProfilePictureRequestContent(BaseModel):
     image: Optional[str] = None
     userId: Optional[str] = Field(None, pattern='^[A-Za-z0-9-]+$')
@@ -194,6 +223,12 @@ class ValidationErrorResponseContent(BaseModel):
     message: str
 
 
+class ContractSignature(BaseModel):
+    userId: Optional[str] = None
+    status: Optional[SignatureStatus] = None
+    timestamp: Optional[float] = None
+
+
 class ContractSummaryItem(BaseModel):
     contractId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     name: str
@@ -222,6 +257,16 @@ 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
+
+
 class GetProfileResponseContent(BaseModel):
     userId: str = Field(..., pattern='^[A-Za-z0-9-]+$')
     profile: UserProfile
@@ -243,3 +288,24 @@ class ShareContractResponseContent(BaseModel):
     added: Optional[List[str]] = None
     removed: Optional[List[str]] = None
     invalidRemoves: Optional[List[str]] = None
+
+
+class SignContractRequestContent(BaseModel):
+    contractId: str
+    status: SignatureStatus
+
+
+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]

python/api_model/types/models.py

@@ -13,6 +13,7 @@ type ExtractSchema<K extends SchemaNames> = components['schemas'][K];
 
 export type AccountType = ExtractSchema<'AccountType'>
 export type AuthenticationErrorResponseContent = ExtractSchema<'AuthenticationErrorResponseContent'>
+export type ContractSignature = ExtractSchema<'ContractSignature'>
 export type ContractStatus = ExtractSchema<'ContractStatus'>
 export type ContractSummaryItem = ExtractSchema<'ContractSummaryItem'>
 export type ContractType = ExtractSchema<'ContractType'>
@@ -21,10 +22,14 @@ export type DeleteContractResponseContent = ExtractSchema<'DeleteContractRespons
 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'>
 export type GetContractResponseContent = ExtractSchema<'GetContractResponseContent'>
+export type GetContractSignaturesRequestContent = ExtractSchema<'GetContractSignaturesRequestContent'>
+export type GetContractSignaturesResponseContent = ExtractSchema<'GetContractSignaturesResponseContent'>
 export type GetProfilePictureRequestContent = ExtractSchema<'GetProfilePictureRequestContent'>
 export type GetProfilePictureResponseContent = ExtractSchema<'GetProfilePictureResponseContent'>
 export type GetProfileRequestContent = ExtractSchema<'GetProfileRequestContent'>
@@ -43,10 +48,16 @@ export type ShareContractRequestContent = ExtractSchema<'ShareContractRequestCon
 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 UpdateContractRequestContent = ExtractSchema<'UpdateContractRequestContent'>
 export type UpdateContractResponseContent = ExtractSchema<'UpdateContractResponseContent'>
 export type UpdateProfileRequestContent = ExtractSchema<'UpdateProfileRequestContent'>
 export type UpdateProfileResponseContent = ExtractSchema<'UpdateProfileResponseContent'>
+export type UpdateSignatureStatusRequestContent = ExtractSchema<'UpdateSignatureStatusRequestContent'>
+export type UpdateSignatureStatusResponseContent = ExtractSchema<'UpdateSignatureStatusResponseContent'>
 export type UploadProfilePictureRequestContent = ExtractSchema<'UploadProfilePictureRequestContent'>
 export type UploadProfilePictureResponseContent = ExtractSchema<'UploadProfilePictureResponseContent'>
 export type UserProfile = ExtractSchema<'UserProfile'>