Membrane React - v0.6.0
    Preparing search index...

    Function useIntegration

    • Parameters

      • idOrKey: undefined | string

      Returns {
          accessor: undefined | IntegrationAccessor;
          loading: boolean;
          saving: boolean;
          error: any;
          refresh: () => Promise<
              {
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  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";
                  connection?: {
                      id: 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;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      meta?: Record<string, any>;
                  };
                  spec?: any;
                  authOptions?: {
                      key: string;
                      type: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      title?: string;
                      description?: string;
                      ui?: { schema?: any; helpUri?: string };
                  }[];
                  parametersSchema?: DataSchema;
              },
          >;
          refreshing: boolean;
          create: (
              data: { name?: string; key: string; baseUri: string; logoUri: string },
          ) => Promise<
              | undefined
              | {
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  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";
                  connection?: {
                      id: 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;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      meta?: Record<string, any>;
                  };
                  spec?: any;
                  authOptions?: {
                      key: string;
                      type: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      title?: string;
                      description?: string;
                      ui?: { schema?: any; helpUri?: (...)
                      | (...) };
                  }[];
                  parametersSchema?: DataSchema;
              },
          >;
          patch: (data: Partial<UpdateRequest>) => Promise<void>;
          put: (
              data: {
                  name?: string;
                  key?: string;
                  baseUri?: string;
                  logoUri?: string;
              },
          ) => Promise<void>;
          archive: () => Promise<void>;
          integration:
              | undefined
              | {
                  id: string;
                  key?: string;
                  uuid?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  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";
                  connection?: {
                      id: 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;
                      archivedAt?: string;
                      isDeactivated?: boolean;
                      meta?: Record<string, any>;
                  };
                  spec?: any;
                  authOptions?: {
                      key: string;
                      type: | "proxy"
                      | "integration-app-token"
                      | "membrane-token"
                      | "oauth2"
                      | "oauth1"
                      | "client-credentials";
                      title?: string;
                      description?: string;
                      ui?: { schema?: any; helpUri?: string };
                  }[];
                  parametersSchema?: DataSchema;
              };
      }