Membrane SDK - v0.9.1
    Preparing search index...

    Function createOrUpdateConnection

    • Creates or updates a connection if connectionId is provided. Creates or updates a default connection for the integration if integrationId is provided.

      Parameters

      • Optionaloptions: {
            authOptionKey?: string;
            name?: string;
            parameters?: any;
            connectorParameters?: any;
            integrationId?: string;
            connectionId?: string;
            connectorSpec?: ConnectorSpec;
            allowMultipleConnections?: boolean;
            token: string;
            apiUri: string;
            redirectUri?: string;
        }

      Returns Promise<
          | undefined
          | {
              user?: {
                  id: string;
                  name: string;
                  meta?: Record<string, any>;
                  internalId: string;
                  fields?: Record<string, any>;
                  credentials?: any;
                  lastActiveAt?: string;
                  isTest?: boolean;
                  isBillable?: boolean;
                  createdAt?: string;
                  archivedAt?: string;
              };
              integration?: {
                  logoUri: string;
                  connectorId?: string;
                  connectorVersion?: string;
                  oAuthCallbackUri?: string;
                  parameters?: any;
                  archivedAt?: string;
                  hasMissingParameters?: boolean;
                  hasDocumentation?: boolean;
                  hasOperations?: boolean;
                  operationsCount?: number;
                  hasData?: boolean;
                  dataCollectionsCount?: number;
                  hasEvents?: boolean;
                  eventsCount?: number;
                  hasGlobalWebhooks?: boolean;
                  hasUdm?: boolean;
                  isTest?: boolean;
                  appUuid?: string;
                  isDeactivated?: boolean;
                  authType?: | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials";
                  id: string;
                  uuid?: string;
                  key?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
              };
              name: string;
              userId: string;
              isTest?: boolean;
              disconnected?: boolean;
              isDefunct?: boolean;
              state?: CONFIGURATION_ERROR
              | SETUP_FAILED
              | READY;
              error?: ErrorDataSchema;
              integrationId: string;
              authOptionKey?: string;
              createdAt: string;
              updatedAt: string;
              lastActiveAt?: string;
              nextCredentialsRefreshAt?: string;
              nextRetryTimestamp?: string;
              retryAttempts?: number;
              archivedAt?: string;
              isDeactivated?: boolean;
              meta?: Record<string, any>;
              id: string;
          },
      >

    Settings

    Member Visibility