Function useDataSourceInstanceCollection

Parameters

• dataSourceInstance: {
      id: string;
      key?: string;
      uuid?: string;
      description?: string;
      meta?: Record<string, any>;
      name: string;
      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
      createdAt?: string;
      updatedAt?: string;
      archivedAt?: string;
      isDeactivated?: boolean;
      userId: string;
      revision: string;
      dataSourceRevision?: string;
      dataSourceId?: string;
      universalDataSourceId?: string;
      udm?: string;
      connectionId: string;
      integrationId: string;
      instanceKey?: string;
      collectionKey?: string;
      collectionParameters?: any;
      defaultCollectionKey?: string;
      defaultCollectionParameters?: any;
      collectionSpec?: {
          type: "collection";
          key?: string;
          name: string;
          parametersSchema?: DataSchema;
          fieldsSchema?: DataSchema;
          list?: {
              apiRequests?: { path: unknown; method: unknown }[];
              filterFields?: string[];
          };
          search?: { apiRequests?: { path: unknown; method: unknown }[] };
          match?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
          };
          findById?: { apiRequests?: { path: unknown; method: unknown }[] };
          create?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
              requiredFields?: string[];
              excludedFields?: string[];
          };
          update?: {
              apiRequests?: { path: unknown; method: unknown }[];
              fields?: string[];
              excludedFields?: string[];
          };
          delete?: { apiRequests?: { path: unknown; method: unknown }[] };
          events?: {
              created?: {
                  type: "push" | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              updated?: {
                  type: "push"
                  | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              deleted?: {
                  type: "push"
                  | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
              all?: { type: "push"
              | "pull"; isFullScan?: boolean; isIdOnly?: boolean };
              [key: string]: {
                  type: "push" | "pull";
                  isFullScan?: boolean;
                  isIdOnly?: boolean;
              };
          };
          customFields?: boolean;
          udm?: Record<
              string,
              {
                  fields?: string[];
                  extract?: Record<string, any>;
                  parse?: Record<string, any>;
              },
          >;
          find?: {
              apiRequests?: { path: unknown; method: unknown }[];
              queryFields?: string[];
          };
      };
      isCustomized?: boolean;
      errors?: ErrorDataSchema[];
      pullUpdatesIntervalSeconds?: number;
      fullSyncIntervalSeconds?: number;
      path?: string;
      defaultPath?: string;
      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;
      };
      dataSource?: {
          id: string;
          key?: string;
          description?: string;
          uuid?: string;
          meta?: Record<string, any>;
          integrationId?: string;
          universalDataSourceId?: string;
          udm?: string;
          pullUpdatesIntervalSeconds?: number;
          fullSyncIntervalSeconds?: number;
          collectionKey?: string;
          collectionParameters?: any;
          defaultPath?: string;
          name: string;
          state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
          errors?: ErrorDataSchema[];
          revision?: string;
          createdAt?: string;
          updatedAt?: string;
          archivedAt?: string;
          isDeactivated?: boolean;
          isCustomized?: boolean;
          universalDataSourceRevision?: string;
      };
      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>;
      };
      integration?: {
          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";
      };
  }