Source code for q2_sdk.hq.db.user_role

from argparse import _SubParsersAction
from functools import partial
from typing import List

from q2_sdk.core.dynamic_imports import (
    api_ExecuteStoredProcedure as ExecuteStoredProcedure,
)
from q2_sdk.hq.table_row import TableRow

from .db_object import DbObject


[docs] class UserRoleRow(TableRow): UserRoleID: int CustomerID: int Description: str PolicyID: int DeletedDate: str Enabled: bool ExtendedDescription: str IsTemplate: bool IsOpenBanking: bool
[docs] class UserRole(DbObject): GET_BY_NAME_KEY = "Description" NAME = "UserRole" REPRESENTATION_ROW_CLASS = UserRoleRow
[docs] def add_arguments(self, parser: _SubParsersAction): subparser = parser.add_parser("get_user_roles_by_customer") subparser.set_defaults(parser="get_by_customer_id") subparser.set_defaults( func=partial(self.get_by_customer_id, serialize_for_cli=True) ) subparser.add_argument("customer_id", help="Q2_Customer.CustomerID")
[docs] async def get_by_customer_id( self, customer_id: int, include_deleted=False, serialize_for_cli=False ) -> List[UserRoleRow]: parameters = [ ExecuteStoredProcedure.SqlParam( ExecuteStoredProcedure.DataType.Int, "customer_id", customer_id ) ] if include_deleted: parameters.append( ExecuteStoredProcedure.SqlParam( ExecuteStoredProcedure.DataType.Bit, "include_deleted", include_deleted, ) ) response = await self.call_hq( "sdk_GetUserRoles", ExecuteStoredProcedure.SqlParameters(parameters) ) if serialize_for_cli: columns = ["UserRoleID", "Description"] response = self.serialize_for_cli(response, columns) return response