Class DefinitionsApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getById getByIdWithHttpInfo getPage getPageWithHttpInfo update updateWithHttpInfo

Constructors

constructor

new DefinitionsApi(configuration, requestFactory?, responseProcessor?): DefinitionsApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: DefinitionsApiRequestFactory
- OptionalresponseProcessor: DefinitionsApiResponseProcessor
Returns DefinitionsApi
- Defined in codegen/automation/actions/types/PromiseAPI.ts:78

Methods

archiveWithHttpInfo

archiveWithHttpInfo(definitionId, appId, _options?): Promise<HttpInfo<void>>
Archive an extension definition
Parameters
- definitionId: string
- appId: number
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:91

create

create(appId, publicActionDefinitionEgg, _options?): Promise<PublicActionDefinition>
Create a new extension definition
Parameters
- appId: number
- publicActionDefinitionEgg: PublicActionDefinitionEgg
- Optional_options: Configuration
Returns Promise<PublicActionDefinition>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:121

createWithHttpInfo

createWithHttpInfo(appId, publicActionDefinitionEgg, _options?): Promise<HttpInfo<PublicActionDefinition>>
Create a new extension definition
Parameters
- appId: number
- publicActionDefinitionEgg: PublicActionDefinitionEgg
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicActionDefinition>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:111

getById

getById(definitionId, appId, archived?, _options?): Promise<PublicActionDefinition>
Get extension definition by Id
Parameters
- definitionId: string
- appId: number
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: Configuration
Returns Promise<PublicActionDefinition>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:143

getByIdWithHttpInfo

getByIdWithHttpInfo(definitionId, appId, archived?, _options?): Promise<HttpInfo<PublicActionDefinition>>
Get extension definition by Id
Parameters
- definitionId: string
- appId: number
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicActionDefinition>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:132

getPage

getPage(appId, limit?, after?, archived?, _options?): Promise<CollectionResponsePublicActionDefinitionForwardPaging>
Get paged extension definitions
Parameters
- appId: number
- Optionallimit: number
  The maximum number of results to display per page.
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: Configuration
Returns Promise<CollectionResponsePublicActionDefinitionForwardPaging>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:167

getPageWithHttpInfo

getPageWithHttpInfo(appId, limit?, after?, archived?, _options?): Promise<HttpInfo<CollectionResponsePublicActionDefinitionForwardPaging>>
Get paged extension definitions
Parameters
- appId: number
- Optionallimit: number
  The maximum number of results to display per page.
- Optionalafter: string
  The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
- Optionalarchived: boolean
  Whether to return only results that have been archived.
- Optional_options: Configuration
Returns Promise<HttpInfo<CollectionResponsePublicActionDefinitionForwardPaging>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:155

update

update(definitionId, appId, publicActionDefinitionPatch, _options?): Promise<PublicActionDefinition>
Patch an existing extension definition
Parameters
- definitionId: string
- appId: number
- publicActionDefinitionPatch: PublicActionDefinitionPatch
- Optional_options: Configuration
Returns Promise<PublicActionDefinition>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:189

updateWithHttpInfo

updateWithHttpInfo(definitionId, appId, publicActionDefinitionPatch, _options?): Promise<HttpInfo<PublicActionDefinition>>
Patch an existing extension definition
Parameters
- definitionId: string
- appId: number
- publicActionDefinitionPatch: PublicActionDefinitionPatch
- Optional_options: Configuration
Returns Promise<HttpInfo<PublicActionDefinition>>
- Defined in codegen/automation/actions/types/PromiseAPI.ts:178

Class DefinitionsApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DefinitionsApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<PublicActionDefinition>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicActionDefinition>>

getById

Parameters

Returns Promise<PublicActionDefinition>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicActionDefinition>>

getPage

Parameters

Returns Promise<CollectionResponsePublicActionDefinitionForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponsePublicActionDefinitionForwardPaging>>

update

Parameters

Returns Promise<PublicActionDefinition>

updateWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicActionDefinition>>

Settings

On This Page