types

@prismatic-io/spectral"types"

Index#

Interfaces#

Type aliases#

Variables#

Type aliases#

ActionLoggerFunction#

Ƭ ActionLoggerFunction: function

Type declaration:#

▸ (...args: unknown[]): void

Parameters:

NameType
...argsunknown[]

ActionPerformFunction#

Ƭ ActionPerformFunction: function

Definition of the function to perform when an Action is invoked.

Type declaration:#

▸ (context: ActionContext, params: ActionInputParameters): Promise‹PerformReturn

Parameters:

NameType
contextActionContext
paramsActionInputParameters

AuthorizationMethod#

Ƭ AuthorizationMethod: typeof authorizationMethods[number]


ConfigurationVariablesCollection#

Ƭ ConfigurationVariablesCollection: Record‹string, string›


Credential#

Ƭ Credential: BasicCredential | ApiKeyCredential | ApiKeySecretCredential | PrivateKeyCredential | OAuth2Credential


InputFieldCollection#

Ƭ InputFieldCollection: "valuelist" | "keyvaluelist"

InputField collection enumeration


InputFieldDefinition#

Ƭ InputFieldDefinition: DefaultInputFieldDefinition | CodeInputFieldDefinition


InputFieldModelFunction#

Ƭ InputFieldModelFunction: function

Definition of the function that returns an array of choices.

Type declaration:#

▸ (): Promise‹InputFieldChoice[]›


InputFieldType#

Ƭ InputFieldType: "string" | "text" | "password" | "boolean" | "code" | "data" | "conditional"

InputField type enumeration.


OAuth2AuthorizationMethod#

Ƭ OAuth2AuthorizationMethod: typeof oauth2AuthorizationMethods[number]


PerformReturn#

Ƭ PerformReturn: PerformDataStructureReturn | PerformBranchingDataStructureReturn | PerformDataReturn | PerformBranchingDataReturn | void

Required return type of all action perform functions

Variables#

Const AvailableAuthorizationMethods#

AvailableAuthorizationMethods: AuthorizationMethod[] = [ ...authorizationMethods, ]


Const AvailableOAuth2AuthorizationMethods#

AvailableOAuth2AuthorizationMethods: OAuth2AuthorizationMethod[] = [ ...oauth2AuthorizationMethods, ]


Const authorizationMethods#

authorizationMethods: ["basic", "api_key", "api_key_secret", "private_key", "oauth2", "oauth2_client_credentials"] = [ "basic", "api_key", "api_key_secret", "private_key", "oauth2", "oauth2_client_credentials", ] as const


Const oauth2AuthorizationMethods#

oauth2AuthorizationMethods: ["oauth2", "oauth2_client_credentials"] = [ "oauth2", "oauth2_client_credentials", ] as const