@lendi/integrations-transform 1.0.7 → 1.1.1

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

@@ -0,0 +1,234 @@
+{
+  "definitions": {
+    "id": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "meta": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "The metadata of the alieo",
+      "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"]
+        }
+      },
+      "required": ["actionedBy", "actionedByRole"]
+    },
+    "percentOwned": {
+      "type": "object",
+      "properties": {
+        "proportions": {
+          "enum": ["EQUAL", "SPECIFIED", "NOT_SPECIFIED"],
+          "description": "Indicate whether ownership proportions are equal, specified individually for each one or not specified."
+        },
+        "owners": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/applicantOwnership"
+          }
+        }
+      },
+      "required": ["owners"]
+    },
+    "liabilityType": {
+      "description": "LEASE_OR_HIRE_FINANCE is deprecated.",
+      "enum": [
+        "CAR_LOAN",
+        "CREDIT_CARD",
+        "HELP_HECS_DEBT",
+        "HOME_LOAN",
+        "LEASE_OR_HIRE_FINANCE",
+        "LEASE",
+        "HIRE_PURCHASE",
+        "LINE_OF_CREDIT",
+        "OTHER",
+        "OVERDRAFT",
+        "PERSONAL_LOAN",
+        "SHORT_TERM_FINANCE",
+        "STORE_CARD",
+        "TAX_DEBT"
+      ]
+    },
+    "outstandingBalance": {
+      "type": "number"
+    },
+    "financialInstitution": {
+      "type": "string"
+    },
+    "repaymentAmount": {
+      "type": "number"
+    },
+    "repaymentFrequency": {
+      "enum": ["FORTNIGHTLY", "MONTHLY", "WEEKLY", "YEARLY"]
+    },
+    "repaymentTypeDetails": {
+      "enum": ["INTEREST_ONLY", "PRINCIPAL_AND_INTEREST"]
+    },
+    "remainingTermDuration": {
+      "type": "number"
+    },
+    "description": {
+      "type": "string",
+      "description": "Description of the entity."
+    },
+    "interestOnlyDuration": {
+      "type": "number"
+    },
+    "annualInterestRate": {
+      "type": "number"
+    },
+    "clearingFromThisLoan": {
+      "type": "boolean"
+    },
+    "clearingFromOtherSource": {
+      "enum": ["PAYING_OUT", "REDUCING"]
+    },
+    "creditLimit": {
+      "type": "number"
+    },
+    "newLimit": {
+      "type": "number"
+    },
+    "originalBalance": {
+      "type": "number"
+    },
+    "applicationId": {
+      "type": "string"
+    },
+    "balloonRepaymentAmount": {
+      "type": "number"
+    },
+    "interestOnlyRemainingTerm": {
+      "type": "number"
+    },
+    "interestType": {
+      "type": "string",
+      "enum": ["FIXED_RATE", "VARIABLE"]
+    },
+    "applicantOwnership": {
+      "type": "object",
+      "properties": {
+        "applicantId": {
+          "type": "string",
+          "description": "The applicant Identifier"
+        },
+        "customerId": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "percent": {
+          "type": "number",
+          "description": "how much percent for the corresponding applicant",
+          "examples": [0.5]
+        }
+      },
+      "required": ["percent", "applicantId"]
+    },
+    "liability": {
+      "type": "object",
+      "properties": {
+        "percentOwned": {
+          "$ref": "#/definitions/percentOwned"
+        },
+        "type": {
+          "$ref": "#/definitions/liabilityType"
+        },
+        "outstandingBalance": {
+          "$ref": "#/definitions/outstandingBalance"
+        },
+        "financialInstitution": {
+          "$ref": "#/definitions/financialInstitution"
+        },
+        "repaymentAmount": {
+          "$ref": "#/definitions/repaymentAmount"
+        },
+        "repaymentFrequency": {
+          "$ref": "#/definitions/repaymentFrequency"
+        },
+        "repaymentTypeDetails": {
+          "$ref": "#/definitions/repaymentTypeDetails"
+        },
+        "remainingTermDuration": {
+          "$ref": "#/definitions/remainingTermDuration"
+        },
+        "interestOnlyDuration": {
+          "$ref": "#/definitions/interestOnlyDuration"
+        },
+        "annualInterestRate": {
+          "$ref": "#/definitions/annualInterestRate"
+        },
+        "clearingFromThisLoan": {
+          "$ref": "#/definitions/clearingFromThisLoan"
+        },
+        "clearingFromOtherSource": {
+          "$ref": "#/definitions/clearingFromOtherSource"
+        },
+        "creditLimit": {
+          "$ref": "#/definitions/creditLimit"
+        },
+        "newLimit": {
+          "$ref": "#/definitions/newLimit"
+        },
+        "originalBalance": {
+          "$ref": "#/definitions/originalBalance"
+        },
+        "balloonRepaymentAmount": {
+          "$ref": "#/definitions/balloonRepaymentAmount"
+        },
+        "interestOnlyRemainingTerm": {
+          "$ref": "#/definitions/interestOnlyRemainingTerm"
+        },
+        "interestType": {
+          "$ref": "#/definitions/interestType"
+        },
+        "description": {
+          "$ref": "#/definitions/description"
+        }
+      },
+      "required": ["outstandingBalance", "percentOwned", "type"]
+    },
+    "LiabilityPayload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of liability"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/applicationId"
+        },
+        "liability": {
+          "$ref": "#/definitions/liability"
+        }
+      },
+      "required": ["id", "applicationId", "liability"],
+      "description": "create / update liability payload"
+    }
+  },
+  "type": "object",
+  "title": "The liability event schema",
+  "description": "The liability event schema",
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "schema version"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["LiabilityCreated", "LiabilityUpdated"]
+    },
+    "payload": {
+      "$ref": "#/definitions/LiabilityPayload"
+    }
+  },
+  "required": ["version", "payload", "type"]
+}

package/lib/schemas/public-required-document-event.json

@@ -0,0 +1,98 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Required Document",
+  "description": "The Required Document event schema",
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "schema version"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["RequiredDocumentCreated", "RequiredDocumentUpdated"]
+    },
+    "payload": {
+      "$ref": "#/definitions/payload"
+    }
+  },
+  "required": ["version", "type", "payload"],
+  "additionalProperties": true,
+  "definitions": {
+    "payload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "description": "Required Document ID",
+          "type": "string"
+        },
+        "createdAt": {
+          "description": "Created at ISO date time",
+          "type": "string",
+          "format": "date-time"
+        },
+        "applicationId": {
+          "description": "Application ID",
+          "type": "string"
+        },
+        "applicantId": {
+          "description": "Application ID",
+          "type": "string"
+        },
+        "status": {
+          "description": "Status",
+          "type": "string",
+          "enum": [
+            "pending_upload",
+            "pending_verification",
+            "failed_verification",
+            "expired",
+            "not_required",
+            "verified"
+          ]
+        },
+        "eConsent": {
+          "type": "object",
+          "properties": {
+            "hasConsented": {
+              "type": "boolean",
+              "description": "eConsent"
+            },
+            "consentedAt": {
+              "description": "Consented at ISO date time",
+              "type": "string",
+              "format": "date-time"
+            }
+          },
+          "required": ["hasConsented"]
+        },
+        "identification": {
+          "type": "object",
+          "properties": {
+            "gender": {
+              "description": "Gender (can be null if migrated from SF as they do not have this field)",
+              "type": ["string", "null"],
+              "enum": ["MALE", "FEMALE", null]
+            },
+            "idNumber": {
+              "description": "ID Number",
+              "type": "string"
+            },
+            "idType": {
+              "description": "ID Type",
+              "type": "string",
+              "enum": ["australian_driver_license", "national_id_card", "passport"]
+            },
+            "idTitle": {
+              "description": "ID Title (can be null if migrated from SF as they do not have this field)",
+              "type": ["string", "null"],
+              "enum": ["DR", "MISS", "MR", "MRS", "MS", "OTHER", "UNKNOWN", null]
+            }
+          },
+          "required": ["idNumber", "idType"]
+        }
+      },
+      "required": ["id", "applicationId", "applicantId"]
+    }
+  }
+}