Type Alias AutomationConnectionsAPI

type AutomationConnectionsAPI = {
    changeOwnerAutomationConnection: typeof automationConnections.changeOwnerAutomationConnection;
    changeSpaceAutomationConnection: typeof automationConnections.changeSpaceAutomationConnection;
    checkAutomationConnection: typeof automationConnections.checkAutomationConnection;
    clearCache: typeof automationConnections.clearCache;
    createAutomationConnection: typeof automationConnections.createAutomationConnection;
    deleteAutomationConnection: typeof automationConnections.deleteAutomationConnection;
    getAutomationConnection: typeof automationConnections.getAutomationConnection;
    getAutomationConnections: typeof automationConnections.getAutomationConnections;
    updateAutomationConnection: typeof automationConnections.updateAutomationConnection;
}
Index

Properties

changeOwnerAutomationConnection changeSpaceAutomationConnection checkAutomationConnection clearCache createAutomationConnection deleteAutomationConnection getAutomationConnection getAutomationConnections updateAutomationConnection

Properties

changeOwnerAutomationConnection: typeof automationConnections.changeOwnerAutomationConnection

Changes the owner of an automation connection by specifying a new owner.

The unique identifier for the automation connection.

Param: body

an object with the body content

ChangeOwnerAutomationConnectionHttpError

changeSpaceAutomationConnection: typeof automationConnections.changeSpaceAutomationConnection

Changes the space of an automation connection by specifying a new space.

The unique identifier for the automation connection.

Param: body

an object with the body content

ChangeSpaceAutomationConnectionHttpError

checkAutomationConnection: typeof automationConnections.checkAutomationConnection

Tries to validate and checks the connection status of an automation connection.

The unique identifier for the automation connection.

CheckAutomationConnectionHttpError

clearCache: typeof automationConnections.clearCache

Clears the cache for automation-connections api requests.

createAutomationConnection: typeof automationConnections.createAutomationConnection

Creates a new connection object from an automation connector.

Param: body

an object with the body content

CreateAutomationConnectionHttpError

deleteAutomationConnection: typeof automationConnections.deleteAutomationConnection

Deletes the specified automation connection.

The unique identifier for the automation connection.

an object with query parameters

DeleteAutomationConnectionHttpError

getAutomationConnection: typeof automationConnections.getAutomationConnection

Returns details about the specified automation connection.

The unique identifier for the automation connection.

GetAutomationConnectionHttpError

getAutomationConnections: typeof automationConnections.getAutomationConnections

Retrieves a list of automation connections the requesting user has access to.

an object with query parameters

GetAutomationConnectionsHttpError

updateAutomationConnection: typeof automationConnections.updateAutomationConnection

Updates the specified properties of an automation connection.

The unique identifier for the automation connection.

Param: body

an object with the body content

UpdateAutomationConnectionHttpError

Settings

Member Visibility

On This Page

Properties