Function RoleApiFactory

Returns {
    roleControllerCreate(
        roleCreateInputDTO?: RoleCreateInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RoleOutputDTOAPI>;
    roleControllerGetOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RoleOutputDTOAPI>;
    roleControllerGetPermissions(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PermissionOutputDTOAPI>;
    roleControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>;
    roleControllerSearch(
        roleSearchInputDTO?: RoleSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RoleOutputArrayDTOAPI>;
    roleControllerUpdate(
        id: string,
        roleUpdateInputDTO?: RoleUpdateInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RoleOutputDTOAPI>;
}

• roleControllerCreate: function

  • roleControllerCreate(
        roleCreateInputDTO?: RoleCreateInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RoleOutputDTOAPI>

    Required permissions: MANAGE_ROLES
    OperationId: RoleControllerCreate

    Parameters

    • OptionalroleCreateInputDTO: RoleCreateInputDTO

      RoleCreateInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RoleOutputDTOAPI>

    Throws

• roleControllerGetOne: function

  • roleControllerGetOne(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RoleOutputDTOAPI>

    Required permissions: READ_ROLES
    OperationId: RoleControllerGetOne

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RoleOutputDTOAPI>

    Throws

• roleControllerGetPermissions: function

  • roleControllerGetPermissions(
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PermissionOutputDTOAPI>

    
    OperationId: RoleControllerGetPermissions

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PermissionOutputDTOAPI>

    Throws

• roleControllerRemove: function

  • roleControllerRemove(
        id: string,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<APIOutput>

    Required permissions: MANAGE_ROLES
    OperationId: RoleControllerRemove

    Parameters

    • id: string
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<APIOutput>

    Throws

• roleControllerSearch: function

  • roleControllerSearch(
        roleSearchInputDTO?: RoleSearchInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RoleOutputArrayDTOAPI>

    Required permissions: READ_ROLES
    OperationId: RoleControllerSearch

    Parameters

    • OptionalroleSearchInputDTO: RoleSearchInputDTO

      RoleSearchInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RoleOutputArrayDTOAPI>

    Throws

• roleControllerUpdate: function

  • roleControllerUpdate(
        id: string,
        roleUpdateInputDTO?: RoleUpdateInputDTO,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<RoleOutputDTOAPI>

    Required permissions: MANAGE_ROLES
    OperationId: RoleControllerUpdate

    Parameters

    • id: string
    • OptionalroleUpdateInputDTO: RoleUpdateInputDTO

      RoleUpdateInputDTO

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<RoleOutputDTOAPI>

    Throws