Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FilterCyclesApi

FilterCyclesApi - object-oriented interface

export

Hierarchy

Index

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance

Protected basePath

basePath: string

Protected configuration

configuration: Configuration | undefined

Methods

createFilterCycle

  • summary

    Create a filter cycle

    throws

    {RequiredError}

    memberof

    FilterCyclesApi

    Parameters

    Returns Promise<AxiosResponse<FilterCycle, any>>

deleteFilterCycle

  • deleteFilterCycle(id: string, options?: any): Promise<AxiosResponse<FilterCycle, any>>
  • summary

    Delete a filter cycle

    throws

    {RequiredError}

    memberof

    FilterCyclesApi

    Parameters

    • id: string
    • Optional options: any

    Returns Promise<AxiosResponse<FilterCycle, any>>

disableAllInCycle

  • disableAllInCycle(id: string, options?: any): Promise<AxiosResponse<void, any>>
  • summary

    Disable all report tasks in a cycle

    throws

    {RequiredError}

    memberof

    FilterCyclesApi

    Parameters

    • id: string
    • Optional options: any

    Returns Promise<AxiosResponse<void, any>>

enableAllInCycle

  • enableAllInCycle(id: string, options?: any): Promise<AxiosResponse<void, any>>
  • summary

    Enable all report tasks in a cycle

    throws

    {RequiredError}

    memberof

    FilterCyclesApi

    Parameters

    • id: string
    • Optional options: any

    Returns Promise<AxiosResponse<void, any>>

getFilterCycle

  • getFilterCycle(id: string, options?: any): Promise<AxiosResponse<FilterCycle, any>>
  • summary

    Get a filter cycle

    throws

    {RequiredError}

    memberof

    FilterCyclesApi

    Parameters

    • id: string
    • Optional options: any

    Returns Promise<AxiosResponse<FilterCycle, any>>

getFilterCycles

  • getFilterCycles(templateId: string, options?: any): Promise<AxiosResponse<FilterCycle[], any>>
  • summary

    List filter cycles

    throws

    {RequiredError}

    memberof

    FilterCyclesApi

    Parameters

    • templateId: string
    • Optional options: any

    Returns Promise<AxiosResponse<FilterCycle[], any>>

updateFilterCycle

  • updateFilterCycle(id: string, filterCycle: FilterCycle, options?: any): Promise<AxiosResponse<FilterCycle, any>>
  • summary

    Update a filter cycle

    throws

    {RequiredError}

    memberof

    FilterCyclesApi

    Parameters

    • id: string
    • filterCycle: FilterCycle
    • Optional options: any

    Returns Promise<AxiosResponse<FilterCycle, any>>

Generated using TypeDoc