Merge pull request #422 from basiqio/DX-805-data-enrich

DX-805 Data Enrichments Tags

.github/CODEOWNERS

@@ -1,4 +1,4 @@
 # This is a CODEOWNERS file
 # It defines individuals or teams that are responsible for code in this repository.
 
-*       @adam-atawneh @kambasiq @basiq-brad @basiq-esther
+*       @adam-atawneh @kambasiq @basiq-brad @basiq-esther @basiq-ash @basiq-jon

data.yml

@@ -3065,6 +3065,7 @@ components:
           - The `expense` tag_name is used with the value `rent` (e.g., "expense:rent").
           - The `loan` tag_name is used with the value `loan repayment` (e.g., "loan:loan repayment").
           - The `mortgage` tag_name could include values like `afg home loans`, `aims`, `amo group`, `athena`, `aussie`, `bluestone`, `clickloans`, `emoney`, `express reverse mortgage`, `firstmac`, `fox symes`, `freedom lend`, `freedom loans`, `funding`, `heartland reverse mortgages`, `homeloans`, `homestar`, `homestart`, `household capital`, `illawarra home loans`, `keystart`, `la trobe financial`, `liberty financial`, `loans`, `mortgage house`, `mortgage offset`, `mortgageport`, `mortgage repayment`, `onetwo`, `online home loans`, `pacific mortgage group`, `pepper money`, `qantas money`, `reduce home loans`, `resi`, `resimac`, `sucasa`, `switzer home loans`, `ticToc`, `unloan`, `vmg`, `well money` (e.g., "mortgage:afg home loans").
+        example: "conduct:dishonour"
       description: |
         This field contains an array of strings, each representing a specific tag for the transaction. The format of each string should be `tag_name:tag_value`, where `tag_name` defines the type of transaction (e.g., `card`, `income`, `mortgage`), and `tag_value` provides additional details (e.g., "card:4615"). The tags help classify and identify transactions based on various criteria.
     

enrich.yml

@@ -295,7 +295,159 @@ components:
             tags:
               type: array
               items:
-               type: string
+                type: string
+                description: |
+                  This array contains tags that are formatted as `tag_name:tag_value`. Each `tag_name` corresponds to a specific category of transaction information, and the `tag_value` provides a detailed classification within that category.
+                  - For example, the `card` tag_name will have a 4-digit number as tag_value (e.g., "card:4615").
+                  - The `conduct` tag_name can have values like `card`, `overdrawn`, `cheque`, `atm`, `currency`, `late`, `admin`, `dishonour`, `interest` (e.g., "conduct:cheque").
+                  - The `governmentPayment` tag_name might have values such as `centrelink`, `centrelinkCarers`, `crisisSupport`, `education`, `familyAllowance`, `jobseekerPymt`, `medicare`, `newstart`, `pension`, `rentalAssistance`, `vetAffairs`, `youthAllowance` (e.g., "governmentPayment:centrelink").
+                  - The `income` tag_name could include values like `childSupport`, `insurance`, `investment`, `rent`, `salary`, `superannuation` (e.g., "income:salary").
+                  - The `liability` tag_name could include values like `afterpay`, `arl collect pty ltd`, `australian recoveries`, `axess`, `azora`, `baycorp`, `beforepay`, `brighte`, `bundll`, `cash converters`, `cash direct`, `cashngo`, `cash stop`, `cash train`, `ccc`, `cfmg pty ltd`, `charter mercantile`, `cigno`, `collectau`, `collection house`, `complete credit solutions`, `credit collection services`, `credit corp`, `creditline`, `deferit`, `dun and bradstreet`, `earnd`, `edstart`, `finance one`, `fundo`, `fupay`, `gem visa`, `humm`, `indebted`, `klarna`, `latitude`, `laybuy`, `limepay`, `lion finance`, `money3`, `moneyloop`, `mypaynow`, `nimble`, `nine25`, `openpay`, `panthera`, `payitlater`, `payright`, `pioneer credit`, `plenti`, `probe`, `q card`, `quickapay`, `spotmenow`, `sunshine loans`, `tapmypay`, `wagetap`, `wallet wizard`, `zip pay` (e.g., "liability:afterpay").
+                  - The `third-party` tag_name might include values like `apple pay`, `google`, `paypal`, `sp`, `sq` (e.g., "third-party:paypal").
+                  - The `creditCard` tag_name is used with the value `creditCard` (e.g., "creditCard:creditCard").
+                  - The `expense` tag_name is used with the value `rent` (e.g., "expense:rent").
+                  - The `loan` tag_name is used with the value `loan repayment` (e.g., "loan:loan repayment").
+                  - The `mortgage` tag_name could include values like `afg home loans`, `aims`, `amo group`, `athena`, `aussie`, `bluestone`, `clickloans`, `emoney`, `express reverse mortgage`, `firstmac`, `fox symes`, `freedom lend`, `freedom loans`, `funding`, `heartland reverse mortgages`, `homeloans`, `homestar`, `homestart`, `household capital`, `illawarra home loans`, `keystart`, `la trobe financial`, `liberty financial`, `loans`, `mortgage house`, `mortgage offset`, `mortgageport`, `mortgage repayment`, `onetwo`, `online home loans`, `pacific mortgage group`, `pepper money`, `qantas money`, `reduce home loans`, `resi`, `resimac`, `sucasa`, `switzer home loans`, `ticToc`, `unloan`, `vmg`, `well money` (e.g., "mortgage:afg home loans").
+              description: |
+                This field contains an array of strings, each representing a specific tag for the transaction. The format of each string should be `tag_name:tag_value`, where `tag_name` defines the type of transaction (e.g., `card`, `income`, `mortgage`), and `tag_value` provides additional details (e.g., "card:4615"). The tags help classify and identify transactions based on various criteria.
+            
+                      - card:4615
+                      - conduct:card
+                      - conduct:overdrawn
+                      - conduct:cheque
+                      - conduct:atm
+                      - conduct:currency
+                      - conduct:late
+                      - conduct:admin
+                      - conduct:dishonour
+                      - conduct:interest
+                      - governmentPayment:centrelink
+                      - governmentPayment:centrelinkCarers
+                      - governmentPayment:crisisSupport
+                      - governmentPayment:education
+                      - governmentPayment:familyAllowance
+                      - governmentPayment:jobseekerPymt
+                      - governmentPayment:medicare
+                      - governmentPayment:newstart
+                      - governmentPayment:pension
+                      - governmentPayment:rentalAssistance
+                      - governmentPayment:vetAffairs
+                      - governmentPayment:youthAllowance
+                      - income:childSupport
+                      - income:insurance
+                      - income:investment
+                      - income:rent
+                      - income:salary
+                      - income:superannuation
+                      - liability:afterpay
+                      - liability:arl collect pty ltd
+                      - liability:australian recoveries
+                      - liability:axess
+                      - liability:azora
+                      - liability:baycorp
+                      - liability:beforepay
+                      - liability:brighte
+                      - liability:bundll
+                      - liability:cash converters
+                      - liability:cash direct
+                      - liability:cashngo
+                      - liability:cash stop
+                      - liability:cash train
+                      - liability:ccc
+                      - liability:cfmg pty ltd
+                      - liability:charter mercantile
+                      - liability:cigno
+                      - liability:collectau
+                      - liability:collection house
+                      - liability:complete credit solutions
+                      - liability:credit collection services
+                      - liability:credit corp
+                      - liability:creditline
+                      - liability:deferit
+                      - liability:dun and bradstreet
+                      - liability:earnd
+                      - liability:edstart
+                      - liability:finance one
+                      - liability:fundo
+                      - liability:fupay
+                      - liability:gem visa
+                      - liability:humm
+                      - liability:indebted
+                      - liability:klarna
+                      - liability:latitude
+                      - liability:laybuy
+                      - liability:limepay
+                      - liability:lion finance
+                      - liability:money3
+                      - liability:moneyloop
+                      - liability:mypaynow
+                      - liability:nimble
+                      - liability:nine25
+                      - liability:openpay
+                      - liability:panthera
+                      - liability:payitlater
+                      - liability:payright
+                      - liability:pioneer credit
+                      - liability:plenti
+                      - liability:probe
+                      - liability:q card
+                      - liability:quickapay
+                      - liability:spotmenow
+                      - liability:sunshine loans
+                      - liability:tapmypay
+                      - liability:wagetap
+                      - liability:wallet wizard
+                      - liability:zip pay
+                      - third-party:apple pay
+                      - third-party:google
+                      - third-party:paypal
+                      - third-party:sp
+                      - third-party:sq
+                      - creditCard:creditCard
+                      - expense:rent
+                      - loan:loan repayment
+                      - mortgage:afg home loans
+                      - mortgage:aims
+                      - mortgage:amo group
+                      - mortgage:athena
+                      - mortgage:aussie
+                      - mortgage:bluestone
+                      - mortgage:clickloans
+                      - mortgage:emoney
+                      - mortgage:express reverse mortgage
+                      - mortgage:firstmac
+                      - mortgage:fox symes
+                      - mortgage:freedom lend
+                      - mortgage:freedom loans
+                      - mortgage:funding
+                      - mortgage:heartland reverse mortgages
+                      - mortgage:homeloans
+                      - mortgage:homestar
+                      - mortgage:homestart
+                      - mortgage:household capital
+                      - mortgage:illawarra home loans
+                      - mortgage:keystart
+                      - mortgage:la trobe financial
+                      - mortgage:liberty financial
+                      - mortgage:loans
+                      - mortgage:mortgage house
+                      - mortgage:mortgage offset
+                      - mortgage:mortgageport
+                      - mortgage:mortgage repayment
+                      - mortgage:onetwo
+                      - mortgage:online home loans
+                      - mortgage:pacific mortgage group
+                      - mortgage:pepper money
+                      - mortgage:qantas money
+                      - mortgage:reduce home loans
+                      - mortgage:resi
+                      - mortgage:resimac
+                      - mortgage:sucasa
+                      - mortgage:switzer home loans
+                      - mortgage:ticToc
+                      - mortgage:unloan
+                      - mortgage:vmg
+                      - mortgage:well money
         links:
           type: object
           properties: