Function RoleApiFp

RoleApi - functional programming interface

Export

  • RoleApiFp(
        configuration?: Configuration,
    ): {
        roleControllerCreate(
            roleCreateInputDTO?: RoleCreateInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputDTOAPI>,
        >;
        roleControllerGetOne(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputDTOAPI>,
        >;
        roleControllerGetPermissions(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PermissionOutputDTOAPI>,
        >;
        roleControllerRemove(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>,
        >;
        roleControllerSearch(
            roleSearchInputDTO?: RoleSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputArrayDTOAPI>,
        >;
        roleControllerUpdate(
            id: string,
            roleUpdateInputDTO?: RoleUpdateInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputDTOAPI>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

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

    • roleControllerCreate:function
      • roleControllerCreate(
            roleCreateInputDTO?: RoleCreateInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputDTOAPI>,
        >

      • Required permissions: MANAGE_ROLES
        OperationId: RoleControllerCreate

        Parameters

        • OptionalroleCreateInputDTO: RoleCreateInputDTO

          RoleCreateInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputDTOAPI>,
        >

        Throws

    • roleControllerGetOne:function
      • roleControllerGetOne(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputDTOAPI>,
        >

      • Required permissions: READ_ROLES
        OperationId: RoleControllerGetOne

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputDTOAPI>,
        >

        Throws

    • roleControllerGetPermissions:function
      • roleControllerGetPermissions(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PermissionOutputDTOAPI>,
        >


      • OperationId: RoleControllerGetPermissions

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PermissionOutputDTOAPI>,
        >

        Throws

    • roleControllerRemove:function
      • roleControllerRemove(
            id: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>,
        >

      • Required permissions: MANAGE_ROLES
        OperationId: RoleControllerRemove

        Parameters

        • id: string
        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<APIOutput>>

        Throws

    • roleControllerSearch:function
      • roleControllerSearch(
            roleSearchInputDTO?: RoleSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputArrayDTOAPI>,
        >

      • Required permissions: READ_ROLES
        OperationId: RoleControllerSearch

        Parameters

        • OptionalroleSearchInputDTO: RoleSearchInputDTO

          RoleSearchInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputArrayDTOAPI>,
        >

        Throws

    • roleControllerUpdate:function
      • roleControllerUpdate(
            id: string,
            roleUpdateInputDTO?: RoleUpdateInputDTO,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputDTOAPI>,
        >

      • Required permissions: MANAGE_ROLES
        OperationId: RoleControllerUpdate

        Parameters

        • id: string
        • OptionalroleUpdateInputDTO: RoleUpdateInputDTO

          RoleUpdateInputDTO

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<RoleOutputDTOAPI>,
        >

        Throws

Settings

Member Visibility