Type alias AgreementDTO

AgreementDTO: {
    agreementId: string;
    appSessionId?: string;
    approvedDate?: string;
    approvedSignature?: string;
    committedSignature?: string;
    demand: {
        constraints: string;
        properties: Record<string, any>;
    } & {
        demandId: string;
        requestorId: string;
        timestamp: string;
    };
    offer: {
        constraints: string;
        properties: Record<string, any>;
    } & {
        offerId: string;
        providerId: string;
        timestamp: string;
    };
    proposedSignature?: string;
    state: "Proposal" | "Pending" | "Cancelled" | "Rejected" | "Approved" | "Expired" | "Terminated";
    timestamp: string;
    validTo: string;
}

Type declaration

  • agreementId: string
  • Optional appSessionId?: string

    A correlation/session identifier used for querying events related to an action where this appSessionId has been specified.

  • Optional approvedDate?: string

    Agreement approval timestamp

  • Optional approvedSignature?: string
  • Optional committedSignature?: string
  • demand: {
        constraints: string;
        properties: Record<string, any>;
    } & {
        demandId: string;
        requestorId: string;
        timestamp: string;
    }
  • offer: {
        constraints: string;
        properties: Record<string, any>;
    } & {
        offerId: string;
        providerId: string;
        timestamp: string;
    }
  • Optional proposedSignature?: string
  • state: "Proposal" | "Pending" | "Cancelled" | "Rejected" | "Approved" | "Expired" | "Terminated"
    • Proposal - newly created by a Requestor (draft based on Proposal)
    • Pending - confirmed by a Requestor and send to Provider for approval
    • Cancelled by a Requestor
    • Rejected by a Provider
    • Approved by both sides
    • Expired - not approved, rejected nor cancelled within validity period
    • Terminated - finished after approval.
  • timestamp: string
  • validTo: string

    End of validity period.

    Agreement needs to be approved, rejected or cancelled before this date; otherwise will expire.