Subsections of configuration

Connector Functions

This is a base object that contains all you can do about ConnectorFunctions.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
Reference InternalOpenGateAPI ❌ to the API object.

create()

Create a new Connector Function

Retorna

Tip

Tipo: Promise

delete()

Deletes the selected connector function

Retorna

Tip

Tipo: Promise

update()

Updates a connector function

Retorna

Tip

Tipo: Promise

withChannel(channel)

Set the channel attribute

Parámetros

Nombre Tipo Opcional Descripción
channel string ❌ required field

Retorna

Tip

Tipo: ConnectorFunctions

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌

Retorna

Tip

Tipo: ConnectorFunctions

withIdentifier(identifier)

Set the identifier attribute

Parámetros

Nombre Tipo Opcional Descripción
identifier string ❌ required field

Retorna

Tip

Tipo: ConnectorFunctions

withJavascript(javascript)

Set the javascript attribute

Parámetros

Nombre Tipo Opcional Descripción
javascript string ❌

Retorna

Tip

Tipo: ConnectorFunctions

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: ConnectorFunctions

withNorthCriterias(criterias)

Set the north criterias attribute

Parámetros

Nombre Tipo Opcional Descripción
criterias array ❌

Retorna

Tip

Tipo: ConnectorFunctions

withOperationalStatus(operationalStatus)

Set the operational status attribute

Parámetros

Nombre Tipo Opcional Descripción
operationalStatus boolean ❌

Retorna

Tip

Tipo: ConnectorFunctions

withOperationName(operationName)

Set the operation name attribute

Parámetros

Nombre Tipo Opcional Descripción
operationName string ❌ required field

Retorna

Tip

Tipo: ConnectorFunctions

withOrganization(organization)

Set the organization attribute

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ required field

Retorna

Tip

Tipo: ConnectorFunctions

withPayloadType(payloadType)

Set the payload type attribute

Parámetros

Nombre Tipo Opcional Descripción
payloadType string ❌

Retorna

Tip

Tipo: ConnectorFunctions

withSouthCriterias(criterias)

Set the south criterias attribute

Parámetros

Nombre Tipo Opcional Descripción
criterias array ❌

Retorna

Tip

Tipo: ConnectorFunctions

withType(type)

Set the type attribute

Parámetros

Nombre Tipo Opcional Descripción
type string ❌

Retorna

Tip

Tipo: ConnectorFunctions

Connector Functions Finder

This class allow make get request to ConnectorFunctions resource into Opengate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByOrganizationAndChannel(organization, channel)

Performs a get that returns connectors functions related

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ organization
channel string ❌ channel.

Retorna

Tip

Tipo: Promise

findByOrganizationAndChannelAndName(organization, channel, name)

Performs a get that returns connectors functions related

Parámetros

Nombre Tipo Opcional Descripción
organization string ❌ organization
channel string ❌ channel.
name string ❌ Connector function name

Retorna

Tip

Tipo: Promise

Connector Functions Helper

This class allow make get request to RuleConfigurationsHelper resource into Opengate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

getDocJavascriptFunctions()

Performs a get that returns documentation of javascript functions from rules service

Retorna

Tip

Tipo: Promise

getDocPrivateJavascriptFunctions()

Performs a get that returns documentation private of javascript functions from rules service

Retorna

Tip

Tipo: Promise