Class FunctionsApi

Constructors

constructor

Methods

archive archiveByFunctionType archiveByFunctionTypeWithHttpInfo archiveWithHttpInfo createOrReplace createOrReplaceByFunctionType createOrReplaceByFunctionTypeWithHttpInfo createOrReplaceWithHttpInfo getByFunctionType getByFunctionTypeWithHttpInfo getById getByIdWithHttpInfo getPage getPageWithHttpInfo

Constructors

constructor

Methods

archive

  • archive(definitionId, functionType, functionId, appId, _options?): Promise<void>

  • Archive a function for a definition

    Parameters

    • definitionId: string
    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"
    • functionId: string
    • appId: number
    • Optional_options: PromiseConfigurationOptions

    Returns Promise<void>

archiveByFunctionType

  • archiveByFunctionType(definitionId, functionType, appId, _options?): Promise<void>

  • Delete a function within a given definition. Delete a function for a definition

    Parameters

    • definitionId: string

      The ID of the definition.

    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"

      The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`.

    • appId: number

      The ID of the app.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<void>

archiveByFunctionTypeWithHttpInfo

  • archiveByFunctionTypeWithHttpInfo(definitionId, functionType, appId, _options?): Promise<HttpInfo<void>>

  • Delete a function within a given definition. Delete a function for a definition

    Parameters

    • definitionId: string

      The ID of the definition.

    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"

      The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`.

    • appId: number

      The ID of the app.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<void>>

archiveWithHttpInfo

  • archiveWithHttpInfo(definitionId, functionType, functionId, appId, _options?): Promise<HttpInfo<void>>

  • Archive a function for a definition

    Parameters

    • definitionId: string
    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"
    • functionId: string
    • appId: number
    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<void>>

createOrReplace

  • createOrReplace(definitionId, functionType, functionId, appId, body, _options?): Promise<PublicActionFunctionIdentifier>

  • Update a function for a given definition by ID. Update a function for a definition

    Parameters

    • definitionId: string

      The ID of the definition.

    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"

      The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`.

    • functionId: string

      The ID of the function.

    • appId: number

      The ID of the app.

    • body: string
    • Optional_options: PromiseConfigurationOptions

    Returns Promise<PublicActionFunctionIdentifier>

createOrReplaceByFunctionType

  • createOrReplaceByFunctionType(definitionId, functionType, appId, body, _options?): Promise<PublicActionFunctionIdentifier>

  • Add a function for a given definition. Insert a function for a definition

    Parameters

    • definitionId: string

      The ID of the definition.

    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"

      The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`.

    • appId: number

      The ID of the app.

    • body: string
    • Optional_options: PromiseConfigurationOptions

    Returns Promise<PublicActionFunctionIdentifier>

createOrReplaceByFunctionTypeWithHttpInfo

createOrReplaceWithHttpInfo

  • createOrReplaceWithHttpInfo(definitionId, functionType, functionId, appId, body, _options?): Promise<HttpInfo<PublicActionFunctionIdentifier>>

  • Update a function for a given definition by ID. Update a function for a definition

    Parameters

    • definitionId: string

      The ID of the definition.

    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"

      The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`.

    • functionId: string

      The ID of the function.

    • appId: number

      The ID of the app.

    • body: string
    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<PublicActionFunctionIdentifier>>

getByFunctionType

  • getByFunctionType(definitionId, functionType, appId, _options?): Promise<PublicActionFunction>

  • Retrieve functions by a type for a given definition

    Parameters

    • definitionId: string

      The ID of the definition.

    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"

      The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`.

    • appId: number

      The ID of the app.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<PublicActionFunction>

getByFunctionTypeWithHttpInfo

  • getByFunctionTypeWithHttpInfo(definitionId, functionType, appId, _options?): Promise<HttpInfo<PublicActionFunction>>

  • Retrieve functions by a type for a given definition

    Parameters

    • definitionId: string

      The ID of the definition.

    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"

      The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`.

    • appId: number

      The ID of the app.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<PublicActionFunction>>

getById

  • getById(definitionId, functionType, functionId, appId, _options?): Promise<PublicActionFunction>

  • Retrieve a specific function from a given definition. Retrieve a function from a given definition

    Parameters

    • definitionId: string

      The ID of the definition.

    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"

      The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`.

    • functionId: string

      The ID of the function.

    • appId: number

      The ID of the app.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<PublicActionFunction>

getByIdWithHttpInfo

  • getByIdWithHttpInfo(definitionId, functionType, functionId, appId, _options?): Promise<HttpInfo<PublicActionFunction>>

  • Retrieve a specific function from a given definition. Retrieve a function from a given definition

    Parameters

    • definitionId: string

      The ID of the definition.

    • functionType:
          | "PRE_ACTION_EXECUTION"
          | "PRE_FETCH_OPTIONS"
          | "POST_FETCH_OPTIONS"
          | "POST_ACTION_EXECUTION"

      The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`.

    • functionId: string

      The ID of the function.

    • appId: number

      The ID of the app.

    • Optional_options: PromiseConfigurationOptions

    Returns Promise<HttpInfo<PublicActionFunction>>

getPage

getPageWithHttpInfo

Settings

Member Visibility

On This Page

Constructors
Methods