Class FunctionsApi

Index

Constructors

Methods

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

Constructors

constructor

new FunctionsApi(configuration, requestFactory?, responseProcessor?): FunctionsApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: FunctionsApiRequestFactory
- OptionalresponseProcessor: FunctionsApiResponseProcessor
Returns FunctionsApi
- Defined in codegen/automation/actions/types/PromiseAPI.ts:205

Methods

archiveByFunctionType

archiveByFunctionType(definitionId, functionType, appId, _options?): Promise<void>
Delete a function for a definition
Parameters
- definitionId: string
- functionType:
      | "PRE_ACTION_EXECUTION"
      | "PRE_FETCH_OPTIONS"
      | "POST_FETCH_OPTIONS"
      | "POST_ACTION_EXECUTION"
- appId: number
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:254

archiveByFunctionTypeWithHttpInfo

archiveByFunctionTypeWithHttpInfo(definitionId, functionType, appId, _options?): Promise<HttpInfo<void>>
Delete a function for a definition
Parameters
- definitionId: string
- functionType:
      | "PRE_ACTION_EXECUTION"
      | "PRE_FETCH_OPTIONS"
      | "POST_FETCH_OPTIONS"
      | "POST_ACTION_EXECUTION"
- appId: number
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:243

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: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:220

createOrReplace

createOrReplace(definitionId, functionType, functionId, appId, body, _options?): Promise<PublicActionFunctionIdentifier>
Insert 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
- body: string
- Optional_options: Configuration
Returns Promise<PublicActionFunctionIdentifier>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:280

createOrReplaceByFunctionType

createOrReplaceByFunctionType(definitionId, functionType, appId, body, _options?): Promise<PublicActionFunctionIdentifier>
Insert a function for a definition
Parameters
- definitionId: string
- functionType:
      | "PRE_ACTION_EXECUTION"
      | "PRE_FETCH_OPTIONS"
      | "POST_FETCH_OPTIONS"
      | "POST_ACTION_EXECUTION"
- appId: number
- body: string
- Optional_options: Configuration
Returns Promise<PublicActionFunctionIdentifier>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:304

createOrReplaceByFunctionTypeWithHttpInfo

createOrReplaceByFunctionTypeWithHttpInfo(definitionId, functionType, appId, body, _options?): Promise<HttpInfo<PublicActionFunctionIdentifier>>
Insert a function for a definition
Parameters
- definitionId: string
- functionType:
      | "PRE_ACTION_EXECUTION"
      | "PRE_FETCH_OPTIONS"
      | "POST_FETCH_OPTIONS"
      | "POST_ACTION_EXECUTION"
- appId: number
- body: string
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicActionFunctionIdentifier>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:292

createOrReplaceWithHttpInfo

createOrReplaceWithHttpInfo(definitionId, functionType, functionId, appId, body, _options?): Promise<HttpInfo<PublicActionFunctionIdentifier>>
Insert 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
- body: string
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicActionFunctionIdentifier>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:267

getByFunctionType

getByFunctionType(definitionId, functionType, appId, _options?): Promise<PublicActionFunction>
Get all functions by a type for a given definition
Parameters
- definitionId: string
- functionType:
      | "PRE_ACTION_EXECUTION"
      | "PRE_FETCH_OPTIONS"
      | "POST_FETCH_OPTIONS"
      | "POST_ACTION_EXECUTION"
- appId: number
- Optional_options: Configuration
Returns Promise<PublicActionFunction>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:326

getByFunctionTypeWithHttpInfo

getByFunctionTypeWithHttpInfo(definitionId, functionType, appId, _options?): Promise<HttpInfo<PublicActionFunction>>
Get all functions by a type for a given definition
Parameters
- definitionId: string
- functionType:
      | "PRE_ACTION_EXECUTION"
      | "PRE_FETCH_OPTIONS"
      | "POST_FETCH_OPTIONS"
      | "POST_ACTION_EXECUTION"
- appId: number
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicActionFunction>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:315

getById

getById(definitionId, functionType, functionId, appId, _options?): Promise<PublicActionFunction>
Get a function for a given definition
Parameters
- definitionId: string
- functionType:
      | "PRE_ACTION_EXECUTION"
      | "PRE_FETCH_OPTIONS"
      | "POST_FETCH_OPTIONS"
      | "POST_ACTION_EXECUTION"
- functionId: string
- appId: number
- Optional_options: Configuration
Returns Promise<PublicActionFunction>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:350

getByIdWithHttpInfo

getByIdWithHttpInfo(definitionId, functionType, functionId, appId, _options?): Promise<HttpInfo<PublicActionFunction>>
Get a function for a given definition
Parameters
- definitionId: string
- functionType:
      | "PRE_ACTION_EXECUTION"
      | "PRE_FETCH_OPTIONS"
      | "POST_FETCH_OPTIONS"
      | "POST_ACTION_EXECUTION"
- functionId: string
- appId: number
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicActionFunction>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:338

getPage

getPage(definitionId, appId, _options?): Promise<CollectionResponsePublicActionFunctionIdentifierNoPaging>
Get all functions for a given definition
Parameters
- definitionId: string
- appId: number
- Optional_options: Configuration
Returns Promise<CollectionResponsePublicActionFunctionIdentifierNoPaging>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:370

getPageWithHttpInfo

getPageWithHttpInfo(definitionId, appId, _options?): Promise<HttpInfo<CollectionResponsePublicActionFunctionIdentifierNoPaging>>
Get all functions for a given definition
Parameters
- definitionId: string
- appId: number
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponsePublicActionFunctionIdentifierNoPaging>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:360

Class FunctionsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns FunctionsApi

Methods

archive

Parameters

Returns Promise<void>

archiveByFunctionType

Parameters

Returns Promise<void>

archiveByFunctionTypeWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

createOrReplace

Parameters

Returns Promise<PublicActionFunctionIdentifier>

createOrReplaceByFunctionType

Parameters

Returns Promise<PublicActionFunctionIdentifier>

createOrReplaceByFunctionTypeWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicActionFunctionIdentifier>>

createOrReplaceWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicActionFunctionIdentifier>>

getByFunctionType

Parameters

Returns Promise<PublicActionFunction>

getByFunctionTypeWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicActionFunction>>

getById

Parameters

Returns Promise<PublicActionFunction>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicActionFunction>>

getPage

Parameters

Returns Promise<CollectionResponsePublicActionFunctionIdentifierNoPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponsePublicActionFunctionIdentifierNoPaging>>

Settings

On This Page