USSD logic for rent

USSD_CASE.md

PART 1; is what new tenants interact with when they dial our ussd for the first time. is also what existing tenants interact with when applying to new property unit tenancy.

(*) NEW TENANCY MENU
    [INPUT] PROPERTY UNIT CODE
    [SELECTION] CONFIRMATION
        1) CONTINUE -> send to tenant onboarding and property unit assigning action
        2) BACK -> send to property unit code input
        3) EXIT -> send to session termination
    [INPUT] FULL NAMES -> asked only if the tenant is new!! ignored for already existing tenants!!

PART 2;

is what registered users see when they dial our ussd. is the main interactivity area for what the ussd application offers.

Afternoon {NAME}. Welcome to flexrent services, for inquires call 0718 837 808.
Select item to continue.

(*) INITIALIZATION MENU

    1) UNIT7545 TENANCY -> send to tenancy management menu
    2) NEW TENANCY -> send to new tenancy menu
    3) ACCOUNT MANAGEMENT:

        [INPUT] FULL NAMES
        [SELECTION] GENDER
            1) MALE
            2) FEMALE
        [INPUT] EMAIL ADDRESS
        [INPUT] NATIONAL IDENTIFICATION NUMBER
        [SELECTION] CONFIRMATION
            1) CONTINUE -> send to account updater action
            2) BACK -> send to initialization menu
            3) EXIT -> send to session termination
            
    5) EXIT -> send to session termination

(*) TENANCY MANAGEMENT MENU

    1) BILL MANAGEMENT: (list's a grouping of all the pending bills plus the total tally)
            1) January 2022 KSH 17,700 -> send to bill payment confirmation prompt
            2) December 2021 KSH 15,500 -> send to bill payment confirmation prompt
            3) November 2021 KSH 12,000 -> send to bill payment confirmation prompt
            4) TOTAL KSH 17,700 -> send to bill payment confirmation prompt, but no instalment feature.
            5) BACK -> send to initialization menu
            6) EXIT -> send to session termination

            (*) BILL PAYMENT CONFIRMATION PROMPT
            
                January 2022, bill payment confirmation.
                RENT: KSH 17,000
                WATER: KSH 500
                GARBAGE: KSH 200
                1) FULL PAYMENT -> send to full payment settlement action
                2) INSTALMENT PAYMENT -> send to instalment based payment settlement action, i.e lipa pole pole
                3) BACK -> send to tenancy management menu
                4) EXIT -> send to session termination

    2) UTILITY FEATURES:
        1) PASSCODE
            1) GENERATE NEW PASSCODE
                [INPUT] GUEST TELEPHONE
                [SELECTION] CONFIRMATION
                    1) CONTINUE -> send to gate passcode generation action
                    2) BACK -> send to guest telephone input
                    3) HOME -> send to tenancy management menu
                    4) EXIT -> send to session termination
            2) QUERY PASSCODE STATUS
                [INPUT] TOKEN CODE
                [SELECTION] CONFIRMATION
                    1) BACK -> send to token code input
                    2) HOME -> send to tenancy management menu
                    3) EXIT -> send to session termination

        2) ISSUE
            1) RAISE NEW ISSUE
                [SELECTION] CATEGORY
                    1) GENERAL
                    2) WATER
                    3) SECURITY
                    4) MAINTENANCE
                    5) OTHER
                [INPUT] NARRATIVE
                [SELECTION] CONFIRMATION
                    1) CONTINUE -> send to issue raised action
                    2) BACK -> send to category selection
                    3) HOME -> send to tenancy management menu
                    4) EXIT -> send to session termination
            2) QUERY ISSUE STATUS
                [INPUT] TOKEN CODE
                [SELECTION] CONFIRMATION
                    1) BACK -> send to token code input
                    2) HOME -> send to tenancy management menu
                    3) EXIT -> send to session termination

        3) VACATE
            1) RAISE NEW NOTICE
                [SELECTION] CONFIRMATION
                    1) CONTINUE -> send to raise vacate notice action (if no pending bills exist)
                    2) BACK -> send to guest telephone input
                    3) HOME -> send to tenancy management menu
                    4) EXIT -> send to session termination

            2) QUERY NOTICE STATUS
                [INPUT] TOKEN CODE
                [SELECTION] CONFIRMATION
                    1) BACK -> send to token code input
                    2) HOME -> send to tenancy management menu
                    3) EXIT -> send to session termination

    3) BACK: -> send to initialization menu

    4) EXIT: -> send to session termination