Untitled

openapi: 3.0.3
info:
    title: savingEnvelopesMobile
    description: |
        Tracking events related to user actions within Saving Envelopes feature on mobile.
        E.g. createEnvelopeButtonSelected, envelopeSaveButtonSelected, envelopesSetupSelected
    version: 1.0.0
    x-event-category: savingEnvelopesMobile

paths: {}

components:
    schemas:
        createEnvelopeTriggered:
            description: |
                This event is tracked when the user selects the button to create an envelope from various screens.
            type: object
            x-relevant-platform:
                - mobile
            x-relevant-segment:
                - retail
            required:
                - actionType
                - trigger
                - buttonName
            properties:
                actionType:
                    type: string
                    enum:
                        - createEnvelope
                    description: |
                        Indicates the user has initiated the action to create an envelope.
                    example: createEnvelope
                trigger:
                    type: string
                    enum:
                        - tutorialScreen
                        - functionScreen
                        - transferScreen
                    description: |
                        Specifies the screen from which the envelope creation was initiated.
                        - 'tutorialScreen' indicates the user triggered this from the initial creation screen(tutorial).
                        - 'functionScreen' indicates it was triggered from the function screen.
                        - 'transferScreen' indicates it was triggered from the transfer screen, typically after user has add money to existing envelope.
                    example: tutorialScreen
                buttonName:
                    type: string
                    description: |
                        Specifies the name of the button that triggered the envelope creation.
                        - 'createAnEnvelope' on the tutorial screen.
                        - 'newEnvelope' on the function screen.
                        - 'createANewEnvelope' on the transfer screen.
                    example: createAnEnvelope
        createEnvelopeConfirmed:
            description: |
                This event is triggered when the user starts creating an envelope.
            type: object
            x-relevant-platform:
                - mobile
            x-relevant-segment:
                - retail
            required:
                - actionType
            properties:
                actionType:
                    type: string
                    enum:
                        - create
                        - close
                    description: |
                        Indicates if the user creates envelope or has closed Set up screen without creating an envelope.
        setupEnvelopeSelected:
            description: |
                User has successfully created an envelope and can finish the process by selecting DONE or s/he can add the money to the envelope.
            type: object
            x-relevant-platform:
                - mobile
            x-relevant-segment:
                - retail
            required:
                - actionType
            properties:
                actionType:
                    type: string
                    enum:
                        - skipForNow
                        - addMoney
                    description: |
                        Indicates if the user has add money to the envelope or close setting up page without adding money changes.
                    example: skipForNow
        categorySelected:
            description: |
                User has selected a category while setting up an envelope.
            type: object
            x-relevant-platform:
                - mobile
            x-relevant-segment:
                - retail
            properties:
                categoryType:
                    type: string
                    description: User can choose between 8 categories.
                    enum:
                        - living
                        - mobility
                        - financialPlans
                        - vacation
                        - education
                        - shopping
                        - family
                        - other
                    example: living
        targetDateConfirmed:
            description: |
                This event is triggered when the user defines a target date using the interval dropdown on the creation screen.
            type: object
            x-relevant-platform:
                - mobile
            x-relevant-segment:
                - retail
            required:
                - deadline
            properties:
                deadline:
                    type: string
                    format: date
                    description: The deadline set by the user via the  interval dropdown.
                    example: '2023-06-15'
        targetDateChanged:
            description: User can edit or remove due date.
            type: object
            x-relevant-platform:
                - mobile
            x-relevant-segment:
                - retail
            properties:
                actionType:
                    type: string
                    enum:
                        - editDueDate
                        - removeDueDate
                    description: User has possibility to edit target date or remove it completely.
                    example: editDueDate
                trigger:
                    type: string
                    enum:
                        - creationScreen
                        - editScreen
                    description: |
                        Defines from where the user has triggered edition or deleting the due date. CreationScreen when triggered from Creation screen, editScreen when triggered from Edit Screen.
                    example: editScreen
        transferMoneyConfirmed:
            description: User will be able to transfer money from savings account to envelope and envelope to savings account.
            type: object
            x-relevant-platform:
                - mobile
            x-relevant-segment:
                - retail
            properties:
                operationType:
                    type: string
                    enum:
                        - addMoney
                        - withdrawMoney
                        - createQrCode
                    description: Type of operation.
                    example: addMoney
        envelopesTabSelected:
            description: User has selected an envelopes tab.
            type: object
            x-relevant-platform:
                - mobile
            x-relevant-segment:
                - retail
        deleteEnvelopeConfirmed:
            description: User has closed the goal successfully.
            type: object
            x-relevant-platform:
                - mobile
            x-relevant-segment:
                - retail
        editEnvelopedConfirmed:
            description: After an envelope is created, user can edit envelope name, category, target amount and target date.
            type: object
            x-relevant-platform:
                - mobile
            x-relevant-segment:
                - retail