@lendi/integrations-transform 1.0.7 → 1.1.1

package/lib/schemas/public-application-event.json

@@ -0,0 +1,224 @@
+{
+  "$schema": "http://json-schema.org/schema#",
+  "_comment.definitions": "****** Definitions of objects used in applications *****",
+  "definitions": {
+    "id": {
+      "description": "uuid of application",
+      "type": "string"
+    },
+    "brokerPrimaryPurpose": {
+      "description": "Additional data point for broker to capture primary purpose, other than the preliminary primary purpose associated with current user journey for new purchase or refinance",
+      "enum": [
+        "COMMERCIAL",
+        "CONSTRUCTION",
+        "CONSTRUCTION_AND_PURCHASE",
+        "CONSTRUCTION_AND_REFINANCE",
+        "INTERNAL_REFINANCE",
+        "NEW_PURCHASE",
+        "PRE_APPROVAL",
+        "PURCHASE",
+        "PURCHASE_AND_REFINANCE",
+        "REFINANCE",
+        "SLR",
+        "TOP_UP",
+        "VARIATION"
+      ]
+    },
+    "customerId": {
+      "description": "Id of the customer",
+      "type": "string"
+    },
+    "name": {
+      "description": "Nickname of application a customer can assign.",
+      "type": "string"
+    },
+    "clonedFromApplicationId": {
+      "description": "Cloned Application UUID.",
+      "type": "string",
+      "maxLength": 255
+    },
+    "hidden": {
+      "description": "Identifies whether the application is hidden to customer or not.",
+      "type": "boolean"
+    },
+    "applicationMeta": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "The metadata of the application",
+      "properties": {
+        "actionedBy": {
+          "description": "uuid of user who made the action (create/update/delete)",
+          "type": "string"
+        },
+        "actionedByRole": {
+          "description": "role of the user that made the action",
+          "enum": ["team", "customer"]
+        },
+        "actionedOn": {
+          "description": "date of action (create/update/delete)",
+          "type": "string"
+        }
+      }
+    },
+    "eligibleForFHOG": {
+      "description": "First Home Owner Grant",
+      "enum": ["YES", "NO", "NOT_SURE"]
+    },
+    "paymentType": {
+      "enum": ["INTEREST_ONLY", "PRINCIPAL_AND_INTEREST", "STILL_DECIDING"]
+    },
+    "desiredFeatures": {
+      "type": "array",
+      "items": {
+        "enum": ["MOBILE_APP", "MAJOR_LENDER", "FIXED_RATE", "OFFSET_OR_REDRAW"]
+      }
+    },
+    "purchaseReason": {
+      "enum": ["LOAN_APPROVAL", "LOAN_ELIGIBILITY", "LOAN_AFFORDABILITY"]
+    },
+    "purchaseSituation": {
+      "enum": ["CONTRACTS_EXCHANGED", "OFFER_MADE", "BUYING_SOON", "EXPLORING_OPTIONS"]
+    },
+    "hasSelfEmploymentProof": {
+      "type": "boolean"
+    },
+    "totalMonthlyExpenses": {
+      "type": "number"
+    },
+    "numberOfDependants": {
+      "type": "number"
+    },
+    "contributions": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": ["DEPOSIT"]
+          },
+          "amount": {
+            "type": "number"
+          }
+        }
+      }
+    },
+    "refinancingReasons": {
+      "type": "array",
+      "items": {
+        "enum": ["CONSOLIDATE_CASHOUT", "FASTER_PAYOFF", "DECREASE_REPAYMENTS", "CONSTRUCTION"]
+      }
+    },
+    "payload": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/id"
+        },
+        "meta": {
+          "$ref": "#/definitions/applicationMeta"
+        },
+        "brokerPrimaryPurpose": {
+          "$ref": "#/definitions/brokerPrimaryPurpose"
+        },
+        "customerId": {
+          "$ref": "#/definitions/customerId"
+        },
+        "name": {
+          "$ref": "#/definitions/name"
+        },
+        "clonedFromApplicationId": {
+          "$ref": "#/definitions/clonedFromApplicationId"
+        },
+        "hidden": {
+          "$ref": "#/definitions/hidden"
+        },
+        "brand": {
+          "enum": ["lendi", "domain", "domain variation", "lendi variation"]
+        },
+        "preliminary": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "purchaseReason": {
+              "$ref": "#/definitions/purchaseReason"
+            },
+            "purchaseSituation": {
+              "$ref": "#/definitions/purchaseSituation"
+            },
+            "isSellingExistingProperty": {
+              "type": "boolean"
+            },
+            "hasConstructionWithin6Months": {
+              "type": "boolean"
+            },
+            "primaryPurpose": {
+              "type": "string",
+              "enum": ["NEW_PURCHASE", "REFINANCE"]
+            },
+            "refinancingReasons": {
+              "$ref": "#/definitions/refinancingReasons"
+            },
+            "consolidateAmount": {
+              "type": "number"
+            },
+            "cashoutAmount": {
+              "type": "number"
+            },
+            "urgency": {
+              "enum": ["NOT_URGENT", "URGENT"]
+            },
+            "eligibleForFHOG": {
+              "$ref": "#/definitions/eligibleForFHOG"
+            },
+            "paymentType": {
+              "$ref": "#/definitions/paymentType"
+            },
+            "desiredFeatures": {
+              "$ref": "#/definitions/desiredFeatures"
+            },
+            "hasSelfEmploymentProof": {
+              "$ref": "#/definitions/hasSelfEmploymentProof"
+            },
+            "totalMonthlyExpenses": {
+              "$ref": "#/definitions/totalMonthlyExpenses"
+            },
+            "numberOfDependants": {
+              "$ref": "#/definitions/numberOfDependants"
+            },
+            "contributions": {
+              "$ref": "#/definitions/contributions"
+            }
+          }
+        }
+      },
+      "required": ["id", "preliminary"]
+    }
+  },
+  "_comment": "****** Our main object that uses all the refs above *******",
+  "type": "object",
+  "title": "application",
+  "description": "main object",
+  "oneOf": [
+    {
+      "_comment": "Creating or updating an application depends on the client sending the latest state",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "version": {
+          "type": "string",
+          "description": "schema version"
+        },
+        "type": {
+          "type": "string",
+          "enum": ["CreateApplication", "UpdateApplication", "MigrateApplication"]
+        },
+        "payload": {
+          "$ref": "#/definitions/payload"
+        }
+      },
+      "required": ["version", "type", "payload"]
+    }
+  ]
+}