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

    Function useAppDataSchemaInstance

    • Parameters

      Returns {
          appDataSchemaInstance:
              | 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;
                  isDeactivated?: boolean;
                  appId: string;
                  userId: string;
                  appDataSchemaId: string;
                  appDataSchemaRevision: string;
                  instanceKey?: string;
                  schema?: any;
                  error?: ErrorDataSchema;
                  archivedAt?: 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;
                  };
                  appDataSchema?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      errors?: ErrorDataSchema[];
                      createdAt?: string;
                      updatedAt?: string;
                      isDeactivated?: boolean;
                      schema: any;
                      code?: string;
                      archivedAt?: string;
                      revision?: string;
                  };
              };
          accessor: undefined
          | AppDataSchemaInstanceAccessor;
          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;
                  isDeactivated?: boolean;
                  appId: string;
                  userId: string;
                  appDataSchemaId: string;
                  appDataSchemaRevision: string;
                  instanceKey?: string;
                  schema?: any;
                  error?: ErrorDataSchema;
                  archivedAt?: 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;
                  };
                  appDataSchema?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      errors?: ErrorDataSchema[];
                      createdAt?: string;
                      updatedAt?: string;
                      isDeactivated?: boolean;
                      schema: any;
                      code?: string;
                      archivedAt?: string;
                      revision?: string;
                  };
              },
          >;
          setup: () => Promise<void>;
          loading: boolean;
          saving: boolean;
          error: any;
          refreshing: boolean;
          create: (
              data: CreateAppDataSchemaInstanceRequest,
          ) => 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;
                  isDeactivated?: boolean;
                  appId: string;
                  userId: string;
                  appDataSchemaId: string;
                  appDataSchemaRevision: string;
                  instanceKey?: string;
                  schema?: any;
                  error?: ErrorDataSchema;
                  archivedAt?: 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;
                  };
                  appDataSchema?: {
                      id: string;
                      key?: string;
                      uuid?: string;
                      description?: string;
                      meta?: Record<string, any>;
                      name: string;
                      state?: CONFIGURATION_ERROR | SETUP_FAILED | READY;
                      errors?: ErrorDataSchema[];
                      createdAt?: string;
                      updatedAt?: string;
                      isDeactivated?: boolean;
                      schema: any;
                      code?: string;
                      archivedAt?: string;
                      revision?: string;
                  };
              },
          >;
          patch: (data: Partial<UpdateRequest>) => Promise<void>;
          put: (data: UpdateAppDataSchemaInstanceRequest) => Promise<void>;
          archive: () => Promise<void>;
      }