@lendi/act-credit-decisions-transform 2.0.0

package/lib/types/events/funding-position.d.ts

@@ -0,0 +1,116 @@
+/**
+ * The Funding Position object in Salesforce
+ */
+export interface FundingPosition {
+    payload: PayloadClass;
+    type: Type;
+    /**
+     * schema version
+     */
+    version: string;
+}
+export interface PayloadClass {
+    /**
+     * Application ID
+     */
+    applicationId: string;
+    /**
+     * Amount of Borrower Contributions
+     */
+    borrowerContributions: number | null;
+    /**
+     * Calculated LVR from related Application. Opportunity.Calculated_LVR__c field in Salesforce
+     */
+    calculatedLvr: number | null;
+    /**
+     * Client legal fees
+     */
+    clientLegalFees: number | null;
+    /**
+     * First home owner grants
+     */
+    firstHomeOwnerConcessionsAndGrants: number | null;
+    fundingPositionDetails?: FundingPositionDetail[];
+    /**
+     * Amount of Funds Requested
+     */
+    fundsRequested: number | null;
+    /**
+     * Amount of Funds Required
+     */
+    fundsRequired: number | null;
+    /**
+     * Funding Position ID
+     */
+    id: string;
+    /**
+     * Lender setup fees
+     */
+    lenderSetupFees: number | null;
+    /**
+     * Lenders Mortgage Insurance
+     */
+    lendersMortgageInsurance: number | null;
+    /**
+     * Max Loan Asset
+     */
+    loanMaxAsset: number | null;
+    /**
+     * Max Loan Product
+     */
+    loanMaxProduct: number | null;
+    /**
+     * Net Surplus
+     */
+    netSurplus: number | null;
+    /**
+     * Other sundries
+     */
+    otherSundries: number | null;
+}
+/**
+ * Details on a Funding Position object in Salesforce that represent assets or liabilities.
+ * Eg. fees, debt, purchases
+ */
+export interface FundingPositionDetail {
+    /**
+     * Amount of the detail
+     */
+    amount: number | null;
+    /**
+     * Category of the detail
+     */
+    category: Category | null;
+    /**
+     * Detail type
+     */
+    detailType?: DetailType;
+}
+export declare enum Category {
+    BorrowerContribution = "Borrower Contribution",
+    Debt = "Debt",
+    EquityRelease = "Equity Release",
+    Fee = "Fee",
+    Other = "Other",
+    Purchase = "Purchase"
+}
+/**
+ * Detail type
+ */
+export declare enum DetailType {
+    Deposit = "Deposit",
+    DischargeCosts = "Discharge Costs",
+    EquityRelease = "Equity Release",
+    HomeLoanToRepay = "Home Loan to Repay",
+    OtherDebtsToRepay = "Other Debts to Repay",
+    PotentialAccruedInterest = "Potential Accrued Interest",
+    PurchasePrice = "Purchase Price",
+    PurchaseStampDuty = "Purchase Stamp Duty",
+    RegistrationFee = "Registration Fee",
+    TransferFee = "Transfer Fee"
+}
+export declare enum Type {
+    FundingPositionCreated = "FundingPositionCreated",
+    FundingPositionMigrated = "FundingPositionMigrated",
+    FundingPositionUpdated = "FundingPositionUpdated"
+}

package/lib/types/events/funding-position.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Type = exports.DetailType = exports.Category = void 0;
+var Category;
+(function (Category) {
+    Category["BorrowerContribution"] = "Borrower Contribution";
+    Category["Debt"] = "Debt";
+    Category["EquityRelease"] = "Equity Release";
+    Category["Fee"] = "Fee";
+    Category["Other"] = "Other";
+    Category["Purchase"] = "Purchase";
+})(Category = exports.Category || (exports.Category = {}));
+/**
+ * Detail type
+ */
+var DetailType;
+(function (DetailType) {
+    DetailType["Deposit"] = "Deposit";
+    DetailType["DischargeCosts"] = "Discharge Costs";
+    DetailType["EquityRelease"] = "Equity Release";
+    DetailType["HomeLoanToRepay"] = "Home Loan to Repay";
+    DetailType["OtherDebtsToRepay"] = "Other Debts to Repay";
+    DetailType["PotentialAccruedInterest"] = "Potential Accrued Interest";
+    DetailType["PurchasePrice"] = "Purchase Price";
+    DetailType["PurchaseStampDuty"] = "Purchase Stamp Duty";
+    DetailType["RegistrationFee"] = "Registration Fee";
+    DetailType["TransferFee"] = "Transfer Fee";
+})(DetailType = exports.DetailType || (exports.DetailType = {}));
+var Type;
+(function (Type) {
+    Type["FundingPositionCreated"] = "FundingPositionCreated";
+    Type["FundingPositionMigrated"] = "FundingPositionMigrated";
+    Type["FundingPositionUpdated"] = "FundingPositionUpdated";
+})(Type = exports.Type || (exports.Type = {}));

package/lib/types/events/income-delete.d.ts

@@ -0,0 +1,33 @@
+export interface IncomeDelete {
+    payload: DeleteEntityDefinition;
+    type: Type;
+    version: string;
+}
+export interface DeleteEntityDefinition {
+    applicationId: string;
+    id: string;
+    meta?: Meta;
+}
+/**
+ * The metadata of the alieo
+ */
+export interface Meta {
+    /**
+     * uuid of user who made the action (create/update/delete)
+     */
+    actionedBy: string;
+    /**
+     * role of the user that made the action
+     */
+    actionedByRole: ActionedByRole;
+}
+/**
+ * role of the user that made the action
+ */
+export declare enum ActionedByRole {
+    Customer = "customer",
+    Team = "team"
+}
+export declare enum Type {
+    IncomeDeleted = "IncomeDeleted"
+}

package/lib/types/events/income-delete.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Type = exports.ActionedByRole = void 0;
+/**
+ * role of the user that made the action
+ */
+var ActionedByRole;
+(function (ActionedByRole) {
+    ActionedByRole["Customer"] = "customer";
+    ActionedByRole["Team"] = "team";
+})(ActionedByRole = exports.ActionedByRole || (exports.ActionedByRole = {}));
+var Type;
+(function (Type) {
+    Type["IncomeDeleted"] = "IncomeDeleted";
+})(Type = exports.Type || (exports.Type = {}));

package/lib/types/events/liability-delete.d.ts

@@ -0,0 +1,17 @@
+export interface LiabilityDelete {
+    payload: Payload;
+    type: Type;
+    version: string;
+}
+export interface Payload {
+    applicationId: string;
+    id: string;
+    meta?: Meta;
+}
+export interface Meta {
+    actionedBy: string;
+    actionedByRole: string;
+}
+export declare enum Type {
+    LiabilityDeleted = "LiabilityDeleted"
+}

package/lib/types/events/liability-delete.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Type = void 0;
+var Type;
+(function (Type) {
+    Type["LiabilityDeleted"] = "LiabilityDeleted";
+})(Type = exports.Type || (exports.Type = {}));

package/lib/types/events/opportunity.d.ts

@@ -0,0 +1,102 @@
+/**
+ * The Opportunity object in Salesforce
+ */
+export interface Opportunity {
+    payload: PayloadObject;
+    type: Type;
+    /**
+     * schema version
+     */
+    version: string;
+}
+export interface PayloadObject {
+    areYouAFirstHomeBuyer?: null | string;
+    /**
+     * Brand of an Opportunity, taken from Record Type in Salesforce
+     */
+    brand?: Brand;
+    /**
+     * From Funnel
+     */
+    cashoutAmount?: number | null;
+    customerId?: null | string;
+    /**
+     * From Funnel
+     */
+    deposit?: number | null;
+    /**
+     * From funnel, ISO 8601 string date format
+     */
+    expectedSettlementDate?: null | string;
+    /**
+     * From Funnel
+     */
+    factorsInChoosingALender?: null | string;
+    /**
+     * The unique identifier of the Opportunity
+     */
+    id: string;
+    /**
+     * When checked the Application is hidden from view
+     */
+    isHidden?: boolean;
+    loanAmount?: number | null;
+    name?: null | string;
+    preferredRepaymentMethod?: null | string;
+    /**
+     * Opportunity Stage Name
+     */
+    stage: Stage;
+    /**
+     * Opportunity status. Can be null when this field is empty/not set on new and closed
+     * opportunities
+     */
+    status?: null | string;
+    transactionType?: string;
+    userId: null | string;
+    /**
+     * From Funnel
+     */
+    whyAreYouRefinancing?: null | string;
+}
+/**
+ * Brand of an Opportunity, taken from Record Type in Salesforce
+ */
+export declare enum Brand {
+    Domain = "domain",
+    DomainVariation = "domain variation",
+    Lendi = "lendi",
+    LendiVariation = "lendi variation"
+}
+/**
+ * Opportunity Stage Name
+ */
+export declare enum Stage {
+    ApplicationTaken = "Application Taken",
+    Appointed = "Appointed",
+    Approval = "Approval",
+    Approved = "Approved",
+    AtRisk = "At Risk",
+    CLFutureContactDate = "CL Future Contact Date",
+    ClosedLost = "Closed Lost",
+    ClosedWon = "Closed Won",
+    ClosedWonPolicyActive = "Closed Won - Policy Active",
+    ClosedWonSigned = "Closed Won - Signed",
+    ConfirmedAppointment = "Confirmed Appointment",
+    InApplication = "In Application",
+    InAssessment = "In Assessment",
+    LoanDocument = "Loan Document",
+    PostContact = "Post-Contact",
+    PostSettlement = "Post-Settlement",
+    PreContact = "Pre-Contact",
+    Qualification = "Qualification",
+    Quote = "Quote",
+    Settled = "Settled",
+    Settlement = "Settlement",
+    Submitted = "Submitted"
+}
+export declare enum Type {
+    OpportunityCreated = "OpportunityCreated",
+    OpportunityMigrated = "OpportunityMigrated",
+    OpportunityUpdated = "OpportunityUpdated"
+}

package/lib/types/events/opportunity.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Type = exports.Stage = exports.Brand = void 0;
+/**
+ * Brand of an Opportunity, taken from Record Type in Salesforce
+ */
+var Brand;
+(function (Brand) {
+    Brand["Domain"] = "domain";
+    Brand["DomainVariation"] = "domain variation";
+    Brand["Lendi"] = "lendi";
+    Brand["LendiVariation"] = "lendi variation";
+})(Brand = exports.Brand || (exports.Brand = {}));
+/**
+ * Opportunity Stage Name
+ */
+var Stage;
+(function (Stage) {
+    Stage["ApplicationTaken"] = "Application Taken";
+    Stage["Appointed"] = "Appointed";
+    Stage["Approval"] = "Approval";
+    Stage["Approved"] = "Approved";
+    Stage["AtRisk"] = "At Risk";
+    Stage["CLFutureContactDate"] = "CL Future Contact Date";
+    Stage["ClosedLost"] = "Closed Lost";
+    Stage["ClosedWon"] = "Closed Won";
+    Stage["ClosedWonPolicyActive"] = "Closed Won - Policy Active";
+    Stage["ClosedWonSigned"] = "Closed Won - Signed";
+    Stage["ConfirmedAppointment"] = "Confirmed Appointment";
+    Stage["InApplication"] = "In Application";
+    Stage["InAssessment"] = "In Assessment";
+    Stage["LoanDocument"] = "Loan Document";
+    Stage["PostContact"] = "Post-Contact";
+    Stage["PostSettlement"] = "Post-Settlement";
+    Stage["PreContact"] = "Pre-Contact";
+    Stage["Qualification"] = "Qualification";
+    Stage["Quote"] = "Quote";
+    Stage["Settled"] = "Settled";
+    Stage["Settlement"] = "Settlement";
+    Stage["Submitted"] = "Submitted";
+})(Stage = exports.Stage || (exports.Stage = {}));
+var Type;
+(function (Type) {
+    Type["OpportunityCreated"] = "OpportunityCreated";
+    Type["OpportunityMigrated"] = "OpportunityMigrated";
+    Type["OpportunityUpdated"] = "OpportunityUpdated";
+})(Type = exports.Type || (exports.Type = {}));