feat(payouts): Add user roles for payouts

[srujanchikke]

Type of Change

• Bugfix
• New feature
• Enhancement
• Refactoring
• Dependency updates
• Documentation
• CI/CD

Description

This PR introduces user roles for Payouts. PayoutRead and PayoutWrite are added as permission under payout persmissions. This permission are added to list(get/post), retrieval and filter api's for payouts.

Additional Changes

• This PR modifies the API contract
• This PR modifies the database schema
• This PR modifies application configuration/environment variables

Motivation and Context

User permissions are used while user accessing the payout data via dashboard. PayoutRead and PayoutWrite are added as permission under payout persmissions. This permission are added to list(get/post), retrieval and filter api's of payouts.

How did you test it?

1. User with org_admin, internal_admin, merchant_admin, merchant_operator will have PayoutRead and PayourWrite. All other user roles will have only PayoutRead. This below curl will get information of user role permissions.

curl --location --request GET '{{base_url}}/user/permission_info' \
--header 'Authorization: {{user_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "[email protected]"
}'

2. View all permissions from below curl

curl --location --request GET '{{base_url}}/user/role/list' \
--header 'Authorization: {{user_token}}'

Response :

[
    {
        "role_id": "merchant_view_only",
        "permissions": [
            "PayoutRead",
            "CustomerRead",
            "MerchantConnectorAccountRead",
            "MandateRead",
            "PaymentRead",
            "SurchargeDecisionManagerRead",
            "Analytics",
            "DisputeRead",
            "MerchantAccountRead",
            "RoutingRead",
            "UsersRead",
            "RefundRead",
            "ThreeDsDecisionManagerRead"
        ],
        "role_name": "view_only",
        "role_scope": "organization"
    },
    {
        "role_id": "merchant_iam_admin",
        "permissions": [
            "UsersWrite",
            "Analytics",
            "UsersRead",
            "PaymentRead",
            "MerchantAccountRead",
            "MandateRead",
            "DisputeRead",
            "PayoutRead",
            "RefundRead",
            "CustomerRead"
        ],
        "role_name": "iam",
        "role_scope": "organization"
    },
    {
        "role_id": "merchant_developer",
        "permissions": [
            "RefundRead",
            "PayoutRead",
            "MerchantAccountWrite",
            "ApiKeyWrite",
            "PaymentRead",
            "MerchantConnectorAccountRead",
            "UsersRead",
            "MandateRead",
            "DisputeRead",
            "MerchantAccountRead",
            "CustomerRead",
            "ApiKeyRead",
            "Analytics",
            "WebhookEventRead"
        ],
        "role_name": "developer",
        "role_scope": "organization"
    },
    {
        "role_id": "merchant_customer_support",
        "permissions": [
            "MandateRead",
            "PaymentRead",
            "DisputeRead",
            "PayoutRead",
            "MerchantAccountRead",
            "Analytics",
            "RefundRead",
            "CustomerRead",
            "UsersRead"
        ],
        "role_name": "customer_support",
        "role_scope": "organization"
    },
    {
        "role_id": "merchant_admin",
        "permissions": [
            "PayoutRead",
            "MandateWrite",
            "RoutingRead",
            "PayoutWrite",
            "RefundWrite",
            "MerchantConnectorAccountWrite",
            "SurchargeDecisionManagerRead",
            "DisputeRead",
            "RoutingWrite",
            "SurchargeDecisionManagerWrite",
            "Analytics",
            "ThreeDsDecisionManagerWrite",
            "MerchantAccountRead",
            "UsersRead",
            "MerchantConnectorAccountRead",
            "UsersWrite",
            "MandateRead",
            "MerchantAccountWrite",
            "ApiKeyRead",
            "ApiKeyWrite",
            "RefundRead",
            "WebhookEventRead",
            "PaymentWrite",
            "PaymentRead",
            "CustomerRead",
            "DisputeWrite",
            "ThreeDsDecisionManagerRead",
            "CustomerWrite"
        ],
        "role_name": "admin",
        "role_scope": "organization"
    },
    {
        "role_id": "merchant_operator",
        "permissions": [
            "RoutingRead",
            "PayoutWrite",
            "MerchantAccountRead",
            "SurchargeDecisionManagerRead",
            "PaymentWrite",
            "CustomerWrite",
            "MandateWrite",
            "DisputeWrite",
            "RefundWrite",
            "DisputeRead",
            "CustomerRead",
            "MerchantConnectorAccountRead",
            "ThreeDsDecisionManagerRead",
            "UsersRead",
            "PaymentRead",
            "MandateRead",
            "PayoutRead",
            "RefundRead",
            "Analytics"
        ],
        "role_name": "operator",
        "role_scope": "organization"
    }
]

Checklist

• I formatted the code cargo +nightly fmt --all
• I addressed lints thrown by cargo clippy
• I reviewed the submitted code
• I added unit tests for my changes where possible
• I added a CHANGELOG entry if applicable

[kashif-m]

Consumption of these roles look good in the retrieve + list + filter APIs.

[ThisIsMani]

If there are no APIs using this permission, this can be removed.

[srujanchikke]

It will be used for generating reports, we don't have any APIs for it now, but we will in the future.