@lendi/integrations-transform 1.0.7 → 1.1.1

package/lib/schemas/public-delete-applicant-event.json

@@ -0,0 +1,66 @@
+{
+  "definitions": {
+    "Payload": {
+      "type": "object",
+      "oneOf": [
+        {
+          "$ref": "#/definitions/DeleteApplicantDefinition"
+        }
+      ]
+    },
+    "id": {
+      "type": "string"
+    },
+    "applicantMeta": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "The metadata of the applicant",
+      "properties": {
+        "actionedBy": {
+          "description": "uuid of user who made the action (delete)",
+          "type": "string"
+        },
+        "actionedByRole": {
+          "description": "role of the user that made the action",
+          "enum": ["team", "customer"]
+        }
+      },
+      "required": ["actionedBy", "actionedByRole"]
+    },
+    "DeleteApplicantDefinition": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of application"
+        },
+        "meta": {
+          "$ref": "#/definitions/applicantMeta"
+        }
+      },
+      "required": ["id", "applicationId"]
+    }
+  },
+  "type": "object",
+  "title": "The applicant delete event schema",
+  "description": "Delete.",
+  "additionalProperties": false,
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "schema version"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["DeleteApplicant"]
+    },
+    "payload": {
+      "$ref": "#/definitions/Payload"
+    }
+  },
+  "required": ["version", "payload", "type"]
+}

package/lib/schemas/public-delete-asset-event.json

@@ -0,0 +1,53 @@
+{
+  "type": "object",
+  "definitions": {
+    "applicationId": {
+      "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"]
+    },
+    "deletePayloadDefinition": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/applicationId"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "required": ["id", "applicationId"]
+    }
+  },
+  "properties": {
+    "version": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["AssetDeleted"]
+    },
+    "payload": {
+      "$ref": "#/definitions/deletePayloadDefinition"
+    }
+  },
+  "required": ["type", "version", "payload"]
+}

package/lib/schemas/public-delete-income-event.json

@@ -0,0 +1,55 @@
+{
+  "definitions": {
+    "applicationId": {
+      "type": "string"
+    },
+    "deleteEntityDefinition": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/applicationId"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        }
+      },
+      "required": ["id", "applicationId"]
+    },
+    "deleteIncomeDefinition": {
+      "$ref": "#/definitions/deleteEntityDefinition"
+    },
+    "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"]
+    }
+  },
+  "type": "object",
+  "required": ["type", "version", "payload"],
+  "properties": {
+    "type": {
+      "type": "string",
+      "enum": ["IncomeDeleted"]
+    },
+    "version": {
+      "type": "string"
+    },
+    "payload": {
+      "$ref": "#/definitions/deleteIncomeDefinition"
+    }
+  }
+}

package/lib/schemas/public-employment-delete-event.json

@@ -0,0 +1,31 @@
+{
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["EmploymentDeleted"]
+    },
+    "payload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uuid"
+        },
+        "applicantId": {
+          "type": "string",
+          "description": "uuid of applicant"
+        },
+        "applicationId": {
+          "type": "string",
+          "description": "uuid of application"
+        }
+      },
+      "required": ["id", "applicationId"]
+    }
+  },
+  "required": ["version", "type", "payload"]
+}

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

@@ -0,0 +1,302 @@
+{
+  "definitions": {
+    "payload": {
+      "type": "object",
+      "$ref": "#/definitions/CreateEmploymentDefinition"
+    },
+    "PrivateOrPublic": {
+      "type": "string",
+      "enum": ["PRIVATE", "PUBLIC"]
+    },
+    "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"]
+    },
+    "applicationId": {
+      "type": "string"
+    },
+    "employmentBasis": {
+      "type": "string",
+      "enum": ["FULL_TIME", "PART_TIME", "CASUAL", "CONTRACTOR", "MATERNITY_LEAVE"]
+    },
+    "businessName": {
+      "type": "string",
+      "description": "Name of business",
+      "example": "Lendi"
+    },
+    "abn": {
+      "type": "number",
+      "description": "ABN of business",
+      "exampled": 18611161856
+    },
+    "abnVerified": {
+      "type": "boolean",
+      "example": true
+    },
+    "companyType": {
+      "type": "string",
+      "enum": ["PRIVATE", "PUBLIC"]
+    },
+    "australianStates": {
+      "type": "string",
+      "enum": ["QLD", "NSW", "VIC", "WA", "SA", "TAS", "ACT", "NT"]
+    },
+    "employerAddress": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "postcode": {
+          "type": "string"
+        },
+        "state": {
+          "$ref": "#/definitions/australianStates"
+        },
+        "city": {
+          "type": "string",
+          "example": "Miranda"
+        },
+        "country": {
+          "type": "string",
+          "example": "Australia"
+        },
+        "formatted": {
+          "type": "string",
+          "example": "8 Clarence st, Miranda, NSW, Australia"
+        },
+        "standard": {
+          "$ref": "#/definitions/addressStandard"
+        }
+      }
+    },
+    "businessStructure": {
+      "type": "string",
+      "enum": ["SOLE_TRADER", "PARTNERSHIP", "COMPANY", "TRUST"]
+    },
+    "onProbation": {
+      "type": "boolean",
+      "example": false
+    },
+    "startDate": {
+      "type": "string",
+      "format": "date",
+      "example": "2018-07-17"
+    },
+    "endDate": {
+      "type": ["string", "null"],
+      "format": "date",
+      "example": "2018-07-17"
+    },
+    "maternityLeaveReturnDate": {
+      "type": "string",
+      "format": "date",
+      "description": "Date returning from maternity leave",
+      "example": "2020-07-17"
+    },
+    "role": {
+      "type": "object",
+      "additionalProperties": false,
+      "description": "ANZSCO role. Complete list can be found as anzsco property here https://bitbucket.org/lendi-dev/lists/src/master/src/services/occupations/occupations.ts. Official reference: http://anzsco.ozhome.info/anzsco-complete-occupation-list.",
+      "properties": {
+        "anzsco": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "code": {
+              "type": "number",
+              "example": 111312
+            },
+            "category": {
+              "type": "string",
+              "example": "MANAGERS"
+            },
+            "occupation": {
+              "type": "string",
+              "example": "Member of Parliament"
+            }
+          }
+        },
+        "asco": {
+          "type": "object",
+          "additionalProperties": false,
+          "description": "ASCO role. Complete list can be found as asco property here https://bitbucket.org/lendi-dev/lists/src/master/src/services/occupations/occupations.ts. Official reference: http://anzsco.ozhome.info/anzsco-complete-occupation-list.",
+          "properties": {
+            "code": {
+              "type": "string",
+              "example": "1111-11"
+            },
+            "category": {
+              "type": "string",
+              "example": "MANAGERS AND ADMINISTRATORS"
+            },
+            "occupation": {
+              "type": "string",
+              "example": "Parliamentarian or Councillor"
+            }
+          }
+        }
+      }
+    },
+    "foreignEmployed": {
+      "type": "boolean",
+      "example": false
+    },
+    "maternityLeaveReturnBasis": {
+      "type": "string",
+      "description": "Employment basis after returning from maternity leave.",
+      "enum": ["FULL_TIME", "PART_TIME", "CASUAL", "CONTRACTOR"]
+    },
+    "type": {
+      "type": "string",
+      "enum": ["PRIMARY", "SECONDARY", "PREVIOUS"]
+    },
+    "employmentType": {
+      "type": "string",
+      "enum": ["EMPLOYEE", "SELF_EMPLOYED", "NOT_WORKING"]
+    },
+    "addressStandard": {
+      "type": "object",
+      "description": "The address standard",
+      "properties": {
+        "buildingName": {
+          "description": "The building name",
+          "type": "string"
+        },
+        "level": {
+          "description": "The level of the unit/apartment",
+          "type": "string"
+        },
+        "lotSection": {
+          "description": "The lot number",
+          "type": "string"
+        },
+        "streetName": {
+          "description": "The street name",
+          "type": "string"
+        },
+        "streetNumber": {
+          "description": "The street number",
+          "type": "string"
+        },
+        "streetType": {
+          "description": "The type of the street i.e. road",
+          "type": "string"
+        },
+        "unit": {
+          "description": "The unit number",
+          "type": "string"
+        }
+      }
+    },
+    "CreateEmploymentDefinition": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of employment"
+        },
+        "applicantId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of applicant"
+        },
+        "clientId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of client"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/id",
+          "description": "uuid of application"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "type": {
+          "$ref": "#/definitions/type"
+        },
+        "employmentType": {
+          "$ref": "#/definitions/employmentType"
+        },
+        "employmentBasis": {
+          "$ref": "#/definitions/employmentBasis"
+        },
+        "businessName": {
+          "$ref": "#/definitions/businessName"
+        },
+        "abn": {
+          "$ref": "#/definitions/abn"
+        },
+        "abnVerified": {
+          "$ref": "#/definitions/abnVerified"
+        },
+        "companyType": {
+          "$ref": "#/definitions/companyType"
+        },
+        "employerAddress": {
+          "$ref": "#/definitions/employerAddress"
+        },
+        "businessStructure": {
+          "$ref": "#/definitions/businessStructure"
+        },
+        "onProbation": {
+          "$ref": "#/definitions/onProbation"
+        },
+        "foreignEmployed": {
+          "$ref": "#/definitions/foreignEmployed"
+        },
+        "startDate": {
+          "$ref": "#/definitions/startDate"
+        },
+        "endDate": {
+          "$ref": "#/definitions/endDate"
+        },
+        "role": {
+          "$ref": "#/definitions/role"
+        },
+        "maternityLeaveReturnDate": {
+          "$ref": "#/definitions/maternityLeaveReturnDate"
+        },
+        "maternityLeaveReturnBasis": {
+          "$ref": "#/definitions/maternityLeaveReturnBasis"
+        },
+        "privateOrPublic": {
+          "$ref": "#/definitions/PrivateOrPublic"
+        }
+      },
+      "required": ["id", "applicantId", "applicationId", "type"],
+      "description": "create employment payload"
+    }
+  },
+  "type": "object",
+  "title": "The employment event schema",
+  "description": "Create or update",
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "schema version"
+    },
+    "payload": {
+      "$ref": "#/definitions/payload"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["EmploymentCreated", "EmploymentUpdated"]
+    }
+  },
+  "required": ["version", "payload", "type"]
+}

package/lib/schemas/public-expense-delete-event.json

@@ -0,0 +1,41 @@
+{
+  "type": "object",
+  "properties": {
+    "version": {
+      "type": "string"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["ExpenseDeleted"]
+    },
+    "payload": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "applicationId": {
+          "type": "string"
+        },
+        "applicantId": {
+          "type": "string",
+          "description": "uuid of applicant"
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "actionedBy": {
+              "type": "string"
+            },
+            "actionedByRole": {
+              "type": "string"
+            }
+          },
+          "required": ["actionedBy", "actionedByRole"]
+        }
+      },
+      "required": ["id", "applicationId", "applicantId"]
+    }
+  },
+  "required": ["version", "type", "payload"]
+}

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

@@ -0,0 +1,132 @@
+{
+  "definitions": {
+    "payload": {
+      "type": "object",
+      "$ref": "#/definitions/ExpenseDefinition"
+    },
+    "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"]
+        }
+      }
+    },
+    "applicationId": {
+      "$ref": "#/definitions/id",
+      "description": "uuid of application"
+    },
+    "Amount": {
+      "type": "number",
+      "example": 100000
+    },
+    "Frequency": {
+      "type": "string",
+      "enum": ["FORTNIGHTLY", "MONTHLY", "QUARTERLY", "WEEKLY", "YEARLY"]
+    },
+    "Comments": {
+      "type": "string"
+    },
+    "ExpenseDefinition": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/Uuid",
+          "description": "uuid of Expense"
+        },
+        "meta": {
+          "$ref": "#/definitions/meta"
+        },
+        "applicationId": {
+          "$ref": "#/definitions/applicationId"
+        },
+        "applicantId": {
+          "$ref": "#/definitions/Uuid"
+        },
+        "expenses": {
+          "$ref": "#/definitions/Expense"
+        }
+      },
+      "required": ["id", "applicationId", "applicantId", "expenses"]
+    },
+    "Expense": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "LIVING_EXPENSES_ESTIMATE",
+              "GROCERIES",
+              "CHILDCARE",
+              "CHILD_AND_SPOUSAL_MAINTENANCE",
+              "PRIMARY_SECONDARY_EDUCATION",
+              "HIGHER_VOCATIONAL_TRAINING_EDUCATION",
+              "PRIVATE_SCHOOLING_AND_TUITION",
+              "CLOTHING_AND_PERSONAL_CARE",
+              "RECREATION_AND_ENTERTAINMENT",
+              "TELEPHONE_INTERNET_PAY_TV_AND_MEDIA_STREAMING_SUBSCRIPTIONS",
+              "PET_CARE",
+              "TRANSPORT",
+              "BODY_CORPORATE_FEES_STRATA_FEES_AND_LAND_TAX",
+              "PRIMARY_RESIDENCE_RUNNING_COSTS",
+              "INVESTMENT_PROPERTY_RUNNING_COSTS",
+              "SECONDARY_RESIDENCE_RUNNING_COSTS",
+              "INSURANCE",
+              "LIFE_INSURANCE",
+              "HEALTH_INSURANCE",
+              "MEDICAL_AND_HEALTH",
+              "RENT",
+              "BOARD",
+              "OTHER"
+            ]
+          },
+          "amount": {
+            "$ref": "#/definitions/Amount"
+          },
+          "frequency": {
+            "$ref": "#/definitions/Frequency"
+          },
+          "comments": {
+            "$ref": "#/definitions/Comments"
+          }
+        },
+        "required": ["frequency", "type"]
+      }
+    },
+    "Uuid": {
+      "type": "string",
+      "format": "uuid",
+      "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
+    }
+  },
+  "type": "object",
+  "title": "The Expense event schema",
+  "description": "Create, update or delete",
+  "properties": {
+    "version": {
+      "type": "string",
+      "description": "schema version"
+    },
+    "type": {
+      "type": "string",
+      "enum": ["ExpenseCreated", "ExpenseUpdated"]
+    },
+    "payload": {
+      "$ref": "#/definitions/payload"
+    }
+  },
+  "required": ["version", "payload", "type"]
+}