Interface AutomationConnectionsAPI

interface AutomationConnectionsAPI {
    changeOwnerAutomationConnection: (
        id: string,
        body: AutomationConnectionChangeOwnerObject,
        options?: ApiCallOptions,
    ) => Promise<ChangeOwnerAutomationConnectionHttpResponse>;
    changeSpaceAutomationConnection: (
        id: string,
        body: AutomationConnectionChangeSpaceObject,
        options?: ApiCallOptions,
    ) => Promise<ChangeSpaceAutomationConnectionHttpResponse>;
    checkAutomationConnection: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<CheckAutomationConnectionHttpResponse>;
    clearCache: () => void;
    createAutomationConnection: (
        body: AutomationConnectionCreationObject,
        options?: ApiCallOptions,
    ) => Promise<CreateAutomationConnectionHttpResponse>;
    deleteAutomationConnection: (
        id: string,
        query: { forced?: boolean },
        options?: ApiCallOptions,
    ) => Promise<DeleteAutomationConnectionHttpResponse>;
    getAutomationConnection: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetAutomationConnectionHttpResponse>;
    getAutomationConnections: (
        query: {
            filter?: string;
            limit?: number;
            listAll?: boolean;
            sort?:
                | "id"
                | "name"
                | "-name"
                | "+name"
                | "+createdAt"
                | "-createdAt"
                | "+updatedAt"
                | "-updatedAt"
                | "createdAt"
                | "updatedAt"
                | "+id"
                | "-id";
        },
        options?: ApiCallOptions,
    ) => Promise<GetAutomationConnectionsHttpResponse>;
    updateAutomationConnection: (
        id: string,
        body: AutomationConnectionPutRequestObject,
        options?: ApiCallOptions,
    ) => Promise<UpdateAutomationConnectionHttpResponse>;
}
Index

Properties

changeOwnerAutomationConnection changeSpaceAutomationConnection checkAutomationConnection clearCache createAutomationConnection deleteAutomationConnection getAutomationConnection getAutomationConnections updateAutomationConnection

Properties

changeOwnerAutomationConnection: (
    id: string,
    body: AutomationConnectionChangeOwnerObject,
    options?: ApiCallOptions,
) => Promise<ChangeOwnerAutomationConnectionHttpResponse>

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

Type declaration

The unique identifier for the automation connection.

Param: body

an object with the body content

ChangeOwnerAutomationConnectionHttpError

changeSpaceAutomationConnection: (
    id: string,
    body: AutomationConnectionChangeSpaceObject,
    options?: ApiCallOptions,
) => Promise<ChangeSpaceAutomationConnectionHttpResponse>

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

Type declaration

The unique identifier for the automation connection.

Param: body

an object with the body content

ChangeSpaceAutomationConnectionHttpError

checkAutomationConnection: (
    id: string,
    options?: ApiCallOptions,
) => Promise<CheckAutomationConnectionHttpResponse>

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

Type declaration

The unique identifier for the automation connection.

CheckAutomationConnectionHttpError

clearCache: () => void

Clears the cache for automation-connections api requests.

Type declaration

    • (): void

    • Clears the cache for automation-connections api requests.

      Returns void

createAutomationConnection: (
    body: AutomationConnectionCreationObject,
    options?: ApiCallOptions,
) => Promise<CreateAutomationConnectionHttpResponse>

Creates a new connection object from an automation connector.

Type declaration

Param: body

an object with the body content

CreateAutomationConnectionHttpError

deleteAutomationConnection: (
    id: string,
    query: { forced?: boolean },
    options?: ApiCallOptions,
) => Promise<DeleteAutomationConnectionHttpResponse>

Deletes the specified automation connection.

Type declaration

    • (
          id: string,
          query: { forced?: boolean },
          options?: ApiCallOptions,
      ): Promise<DeleteAutomationConnectionHttpResponse>

    • Deletes the specified automation connection.

      Parameters

      • id: string

        The unique identifier for the automation connection.

      • query: { forced?: boolean }

        an object with query parameters

        • Optionalforced?: boolean

          When true, the automation connection will be deleted regardless of its usage by any automations.

      • Optionaloptions: ApiCallOptions

      Returns Promise<DeleteAutomationConnectionHttpResponse>

      DeleteAutomationConnectionHttpError

The unique identifier for the automation connection.

an object with query parameters

DeleteAutomationConnectionHttpError

getAutomationConnection: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetAutomationConnectionHttpResponse>

Returns details about the specified automation connection.

Type declaration

The unique identifier for the automation connection.

GetAutomationConnectionHttpError

getAutomationConnections: (
    query: {
        filter?: string;
        limit?: number;
        listAll?: boolean;
        sort?:
            | "id"
            | "name"
            | "-name"
            | "+name"
            | "+createdAt"
            | "-createdAt"
            | "+updatedAt"
            | "-updatedAt"
            | "createdAt"
            | "updatedAt"
            | "+id"
            | "-id";
    },
    options?: ApiCallOptions,
) => Promise<GetAutomationConnectionsHttpResponse>

Retrieves a list of automation connections

Type declaration

    • (
          query: {
              filter?: string;
              limit?: number;
              listAll?: boolean;
              sort?:
                  | "id"
                  | "name"
                  | "-name"
                  | "+name"
                  | "+createdAt"
                  | "-createdAt"
                  | "+updatedAt"
                  | "-updatedAt"
                  | "createdAt"
                  | "updatedAt"
                  | "+id"
                  | "-id";
          },
          options?: ApiCallOptions,
      ): Promise<GetAutomationConnectionsHttpResponse>

    • Retrieves a list of automation connections

      Parameters

      • query: {
            filter?: string;
            limit?: number;
            listAll?: boolean;
            sort?:
                | "id"
                | "name"
                | "-name"
                | "+name"
                | "+createdAt"
                | "-createdAt"
                | "+updatedAt"
                | "-updatedAt"
                | "createdAt"
                | "updatedAt"
                | "+id"
                | "-id";
        }

        an object with query parameters

        • Optionalfilter?: string

          Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId.

        • Optionallimit?: number

          The number of automation connections to retrieve.

        • OptionallistAll?: boolean

          When true, list all connections. Restricted to tenant admins and analytics admins.

        • Optionalsort?:
              | "id"
              | "name"
              | "-name"
              | "+name"
              | "+createdAt"
              | "-createdAt"
              | "+updatedAt"
              | "-updatedAt"
              | "createdAt"
              | "updatedAt"
              | "+id"
              | "-id"

          The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order)

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetAutomationConnectionsHttpResponse>

      GetAutomationConnectionsHttpError

an object with query parameters

GetAutomationConnectionsHttpError

updateAutomationConnection: (
    id: string,
    body: AutomationConnectionPutRequestObject,
    options?: ApiCallOptions,
) => Promise<UpdateAutomationConnectionHttpResponse>

Updates the specified properties of an automation connection.

Type declaration

The unique identifier for the automation connection.

Param: body

an object with the body content

UpdateAutomationConnectionHttpError

Settings

Member Visibility

On This Page

Properties