Function HookApiAxiosParamCreator

HookApi - axios parameter creator

Export

  • HookApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        hookControllerCreate: (
            hookCreateDTO?: HookCreateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerGetExecutions: (
            id: string,
            success?: any,
            eventSearchInputDTO?: EventSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerGetOne: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerRemove: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerSearch: (
            hookSearchInputDTO?: HookSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerTrigger: (
            hookTriggerDTO?: HookTriggerDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerUpdate: (
            id: string,
            hookUpdateDTO?: HookUpdateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    Returns {
        hookControllerCreate: (
            hookCreateDTO?: HookCreateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerGetExecutions: (
            id: string,
            success?: any,
            eventSearchInputDTO?: EventSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerGetOne: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerRemove: (
            id: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerSearch: (
            hookSearchInputDTO?: HookSearchInputDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerTrigger: (
            hookTriggerDTO?: HookTriggerDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        hookControllerUpdate: (
            id: string,
            hookUpdateDTO?: HookUpdateDTO,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • hookControllerCreate: (
          hookCreateDTO?: HookCreateDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Required permissions: MANAGE_MODULES
      OperationId: HookControllerCreate

      Throws

    • hookControllerGetExecutions: (
          id: string,
          success?: any,
          eventSearchInputDTO?: EventSearchInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Required permissions: READ_MODULES
      OperationId: HookControllerGetExecutions

      Throws

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

      Required permissions: READ_MODULES
      OperationId: HookControllerGetOne

      Throws

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

      Required permissions: MANAGE_MODULES
      OperationId: HookControllerRemove

      Throws

    • hookControllerSearch: (
          hookSearchInputDTO?: HookSearchInputDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Required permissions: READ_MODULES
      OperationId: HookControllerSearch

      Throws

    • hookControllerTrigger: (
          hookTriggerDTO?: HookTriggerDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Trigger a hook. This is used for testing purposes, the event will not actually be created but the hook-logic will be executed. You can pass any data you want, but it must validate against the corresponding event metadata. Eg to trigger the chat-message event, you must pass an object with a message property Required permissions: MANAGE_MODULES
      OperationId: HookControllerTrigger

      Throws

    • hookControllerUpdate: (
          id: string,
          hookUpdateDTO?: HookUpdateDTO,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      Required permissions: MANAGE_MODULES
      OperationId: HookControllerUpdate

      Throws

Settings

Member Visibility