Function RoleApiAxiosParamCreator

RoleApi - axios parameter creator

Export

  • RoleApiAxiosParamCreator(configuration?): {
        roleControllerCreate: ((roleCreateInputDTO?: RoleCreateInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        roleControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        roleControllerGetPermissions: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        roleControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        roleControllerSearch: ((roleSearchInputDTO?: RoleSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        roleControllerUpdate: ((id: string, roleUpdateInputDTO?: RoleUpdateInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        roleControllerCreate: ((roleCreateInputDTO?: RoleCreateInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        roleControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        roleControllerGetPermissions: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        roleControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        roleControllerSearch: ((roleSearchInputDTO?: RoleSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        roleControllerUpdate: ((id: string, roleUpdateInputDTO?: RoleUpdateInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • roleControllerCreate: ((roleCreateInputDTO?: RoleCreateInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_ROLES

      Summary

      Create

      Throws

        • (roleCreateInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalroleCreateInputDTO: RoleCreateInputDTO

            RoleCreateInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • roleControllerGetOne: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_ROLES

      Summary

      Get one

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • roleControllerGetPermissions: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Get permissions

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • roleControllerRemove: ((id: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_ROLES

      Summary

      Remove

      Throws

        • (id, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • roleControllerSearch: ((roleSearchInputDTO?: RoleSearchInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: READ_ROLES

      Summary

      Search

      Throws

        • (roleSearchInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalroleSearchInputDTO: RoleSearchInputDTO

            RoleSearchInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • roleControllerUpdate: ((id: string, roleUpdateInputDTO?: RoleUpdateInputDTO, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Required permissions: MANAGE_ROLES

      Summary

      Update

      Throws

        • (id, roleUpdateInputDTO?, options?): Promise<RequestArgs>

        • Parameters

          • id: string
          • OptionalroleUpdateInputDTO: RoleUpdateInputDTO

            RoleUpdateInputDTO

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility