@amp-labs/react 2.7.11 → 2.7.13

package/build/index.d.ts

@@ -1,7 +1,8 @@
-import { Config } from '../../generated-sources/api/src';
-import { Connection } from '../../generated-sources/api/src';
 import { default as default_2 } from 'react';
+import { Dispatch } from 'react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { SetStateAction } from 'react';
+import { UseQueryResult } from '@tanstack/react-query';
 
 export declare const AmpersandContext: default_2.Context<null>;
 
@@ -24,9 +25,478 @@ declare interface AmpersandProviderProps {
     children: default_2.ReactNode;
 }
 
-export { Config }
+/**
+ *
+ * @export
+ * @interface Backfill
+ */
+declare interface Backfill {
+    /**
+     *
+     * @type {DefaultPeriod}
+     * @memberof Backfill
+     */
+    defaultPeriod: DefaultPeriod;
+}
+
+/**
+ *
+ * @export
+ * @interface BackfillConfig
+ */
+declare interface BackfillConfig {
+    /**
+     *
+     * @type {DefaultPeriodConfig}
+     * @memberof BackfillConfig
+     */
+    defaultPeriod: DefaultPeriodConfig;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface BaseProxyConfig
+ */
+declare interface BaseProxyConfig {
+    /**
+     *
+     * @type {boolean}
+     * @memberof BaseProxyConfig
+     */
+    enabled?: boolean;
+}
+
+/**
+ *
+ * @export
+ * @interface BaseReadConfigObject
+ */
+declare interface BaseReadConfigObject {
+    /**
+     * The name of the object to read from.
+     * @type {string}
+     * @memberof BaseReadConfigObject
+     */
+    objectName?: string;
+    /**
+     * The schedule for reading the object, in cron syntax.
+     * @type {string}
+     * @memberof BaseReadConfigObject
+     */
+    schedule?: string;
+    /**
+     * The name of the destination that the result should be sent to.
+     * @type {string}
+     * @memberof BaseReadConfigObject
+     */
+    destination?: string;
+    /**
+     * This is a map of field names to booleans indicating whether they should be read. If a field is already included in `selectedFieldMappings`, it does not need to be included here.
+     * @type {{ [key: string]: boolean; }}
+     * @memberof BaseReadConfigObject
+     */
+    selectedFields?: {
+        [key: string]: boolean;
+    };
+    /**
+     * This is a map of field names to their value mappings.
+     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @memberof BaseReadConfigObject
+     */
+    selectedValueMappings?: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    };
+    /**
+     * This is a map of mapToNames to field names. (A mapTo name is the name the builder wants to map a field to when it lands in their destination.)
+     * @type {{ [key: string]: string; }}
+     * @memberof BaseReadConfigObject
+     */
+    selectedFieldMappings?: {
+        [key: string]: string;
+    };
+    /**
+     *
+     * @type {SelectedFieldsAutoConfig}
+     * @memberof BaseReadConfigObject
+     */
+    selectedFieldsAuto?: SelectedFieldsAutoConfig;
+    /**
+     *
+     * @type {BackfillConfig}
+     * @memberof BaseReadConfigObject
+     */
+    backfill?: BackfillConfig;
+}
+
+/**
+ *
+ * @export
+ * @interface BaseWriteConfigObject
+ */
+declare interface BaseWriteConfigObject {
+    /**
+     * The name of the object to write to.
+     * @type {string}
+     * @memberof BaseWriteConfigObject
+     */
+    objectName: string;
+    /**
+     * This is a map of field names to default values. These values will be used when writing to the object.
+     * @type {{ [key: string]: ValueDefault; }}
+     * @memberof BaseWriteConfigObject
+     * @deprecated
+     */
+    selectedValueDefaults?: {
+        [key: string]: ValueDefault;
+    };
+    /**
+     * This is a map of field names to their settings.
+     * @type {{ [key: string]: FieldSetting; }}
+     * @memberof BaseWriteConfigObject
+     */
+    selectedFieldSettings?: {
+        [key: string]: FieldSetting;
+    };
+}
+
+/**
+ *
+ * @export
+ * @interface Config
+ */
+export declare interface Config {
+    /**
+     * The config ID.
+     * @type {string}
+     * @memberof Config
+     */
+    id: string;
+    /**
+     * The ID of the revision that this config is based on.
+     * @type {string}
+     * @memberof Config
+     */
+    revisionId: string;
+    /**
+     * The time the config was created.
+     * @type {Date}
+     * @memberof Config
+     */
+    createTime: Date;
+    /**
+     * The person who created the config, in the format of "consumer:{consumer-id}" or "builder:{builder-id}".
+     * @type {string}
+     * @memberof Config
+     */
+    createdBy: string;
+    /**
+     *
+     * @type {ConfigContent}
+     * @memberof Config
+     */
+    content: ConfigContent;
+}
+
+/**
+ *
+ * @export
+ * @interface ConfigContent
+ */
+declare interface ConfigContent {
+    /**
+     * The SaaS API that we are integrating with.
+     * @type {string}
+     * @memberof ConfigContent
+     */
+    provider: string;
+    /**
+     *
+     * @type {ReadConfig}
+     * @memberof ConfigContent
+     */
+    read?: ReadConfig;
+    /**
+     *
+     * @type {WriteConfig}
+     * @memberof ConfigContent
+     */
+    write?: WriteConfig;
+    /**
+     *
+     * @type {BaseProxyConfig}
+     * @memberof ConfigContent
+     */
+    proxy?: BaseProxyConfig;
+    /**
+     *
+     * @type {SubscribeConfig}
+     * @memberof ConfigContent
+     */
+    subscribe?: SubscribeConfig;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ConfigCreateEvent
+ */
+declare interface ConfigCreateEvent {
+    /**
+     * Conditions to enable create events.
+     * @type {string}
+     * @memberof ConfigCreateEvent
+     */
+    enabled: ConfigCreateEventEnabledEnum;
+}
+
+/**
+ * @export
+ */
+declare const ConfigCreateEventEnabledEnum: {
+    readonly Always: "always";
+};
+
+declare type ConfigCreateEventEnabledEnum = typeof ConfigCreateEventEnabledEnum[keyof typeof ConfigCreateEventEnabledEnum];
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ConfigDeleteEvent
+ */
+declare interface ConfigDeleteEvent {
+    /**
+     * Conditions to enable delete events.
+     * @type {string}
+     * @memberof ConfigDeleteEvent
+     */
+    enabled: ConfigDeleteEventEnabledEnum;
+}
+
+/**
+ * @export
+ */
+declare const ConfigDeleteEventEnabledEnum: {
+    readonly Always: "always";
+};
+
+declare type ConfigDeleteEventEnabledEnum = typeof ConfigDeleteEventEnabledEnum[keyof typeof ConfigDeleteEventEnabledEnum];
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ConfigUpdateEvent
+ */
+declare interface ConfigUpdateEvent {
+    /**
+     * Conditions to enable update events.
+     * @type {string}
+     * @memberof ConfigUpdateEvent
+     */
+    enabled: ConfigUpdateEventEnabledEnum;
+    /**
+     * Whether to watch fields all fields automatically.
+     * @type {string}
+     * @memberof ConfigUpdateEvent
+     */
+    watchFieldsAuto?: ConfigUpdateEventWatchFieldsAutoEnum;
+    /**
+     * The fields that should be watched.
+     * @type {Array<string>}
+     * @memberof ConfigUpdateEvent
+     */
+    requiredWatchFields?: Array<string>;
+}
+
+/**
+ * @export
+ */
+declare const ConfigUpdateEventEnabledEnum: {
+    readonly Always: "always";
+};
+
+declare type ConfigUpdateEventEnabledEnum = typeof ConfigUpdateEventEnabledEnum[keyof typeof ConfigUpdateEventEnabledEnum];
+
+/**
+ * @export
+ */
+declare const ConfigUpdateEventWatchFieldsAutoEnum: {
+    readonly All: "all";
+};
+
+declare type ConfigUpdateEventWatchFieldsAutoEnum = typeof ConfigUpdateEventWatchFieldsAutoEnum[keyof typeof ConfigUpdateEventWatchFieldsAutoEnum];
+
+/**
+ *
+ * @export
+ * @interface Connection
+ */
+export declare interface Connection {
+    /**
+     * The connection ID.
+     * @type {string}
+     * @memberof Connection
+     */
+    id: string;
+    /**
+     * The Ampersand project ID.
+     * @type {string}
+     * @memberof Connection
+     */
+    projectId: string;
+    /**
+     * The SaaS provider that this Connection is for.
+     * @type {string}
+     * @memberof Connection
+     */
+    provider: string;
+    /**
+     *
+     * @type {ProviderApp}
+     * @memberof Connection
+     */
+    providerApp?: ProviderApp;
+    /**
+     *
+     * @type {Group}
+     * @memberof Connection
+     */
+    group: Group;
+    /**
+     *
+     * @type {Consumer}
+     * @memberof Connection
+     */
+    consumer: Consumer;
+    /**
+     * If available, the identifier for the provider workspace (e.g. the Salesforce subdomain)
+     * @type {string}
+     * @memberof Connection
+     */
+    providerWorkspaceRef?: string;
+    /**
+     * If available, the ID that Salesforce/Hubspot uses to identify this user (e.g. Salesforce has IDs in the form of https://login.salesforce.com/id/00D4x0000019CQTEA2/0054x000000orJ4AA)
+     * @type {string}
+     * @memberof Connection
+     */
+    providerConsumerRef?: string;
+    /**
+     * The time the connection was created.
+     * @type {Date}
+     * @memberof Connection
+     */
+    createTime: Date;
+    /**
+     * The time the connection was last updated.
+     * @type {Date}
+     * @memberof Connection
+     */
+    updateTime?: Date;
+    /**
+     * The authentication scheme used for this connection.
+     * @type {string}
+     * @memberof Connection
+     */
+    authScheme: ConnectionAuthSchemeEnum;
+    /**
+     * The status of the connection.
+     * @type {string}
+     * @memberof Connection
+     */
+    status: ConnectionStatusEnum;
+    /**
+     *
+     * @type {Oauth2AuthorizationCodeTokensOnly}
+     * @memberof Connection
+     */
+    oauth2AuthorizationCode?: Oauth2AuthorizationCodeTokensOnly;
+    /**
+     * The API key used while making the connection.
+     * @type {string}
+     * @memberof Connection
+     */
+    apiKey?: string;
+    /**
+     *
+     * @type {{ [key: string]: ProviderMetadataInfo; }}
+     * @memberof Connection
+     */
+    providerMetadata?: {
+        [key: string]: ProviderMetadataInfo;
+    };
+}
+
+/**
+ * @export
+ */
+declare const ConnectionAuthSchemeEnum: {
+    readonly None: "none";
+    readonly ApiKey: "apiKey";
+    readonly Basic: "basic";
+    readonly Oauth2AuthorizationCode: "oauth2/authorizationCode";
+    readonly Oauth2AuthorizationCodePkce: "oauth2/authorizationCodePKCE";
+    readonly Oauth2ClientCredentials: "oauth2/clientCredentials";
+    readonly Oauth2Password: "oauth2/password";
+};
+
+declare type ConnectionAuthSchemeEnum = typeof ConnectionAuthSchemeEnum[keyof typeof ConnectionAuthSchemeEnum];
+
+/**
+ * @export
+ */
+declare const ConnectionStatusEnum: {
+    readonly Created: "created";
+    readonly Working: "working";
+    readonly BadCredentials: "bad_credentials";
+};
 
-export { Connection }
+declare type ConnectionStatusEnum = typeof ConnectionStatusEnum[keyof typeof ConnectionStatusEnum];
 
 export declare function ConnectProvider({ provider, consumerRef, consumerName, groupRef, groupName, redirectUrl, onSuccess, onDisconnectSuccess, onConnectSuccess, }: ConnectProviderProps): JSX_2.Element;
 
@@ -54,6 +524,117 @@ declare interface ConnectProviderProps {
     onDisconnectSuccess?: (connection: Connection) => void;
 }
 
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface Consumer
+ */
+declare interface Consumer {
+    /**
+     * The consumer reference.
+     * @type {string}
+     * @memberof Consumer
+     */
+    consumerRef: string;
+    /**
+     * The name of the consumer.
+     * @type {string}
+     * @memberof Consumer
+     */
+    consumerName: string;
+    /**
+     * The Ampersand project ID.
+     * @type {string}
+     * @memberof Consumer
+     */
+    projectId: string;
+    /**
+     * The time the consumer was created.
+     * @type {Date}
+     * @memberof Consumer
+     */
+    createTime: Date;
+    /**
+     * The time the consumer was last updated.
+     * @type {Date}
+     * @memberof Consumer
+     */
+    updateTime?: Date;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface DefaultPeriod
+ */
+declare interface DefaultPeriod {
+    /**
+     * Number of days in past to backfill from. 0 is no backfill. e.g) if 10, then backfill last 10 days of data. Required if fullHistory is not set.
+     * @type {number}
+     * @memberof DefaultPeriod
+     */
+    days?: number;
+    /**
+     * If true, backfill all history. Required if days is not set.
+     * @type {boolean}
+     * @memberof DefaultPeriod
+     */
+    fullHistory?: boolean;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface DefaultPeriodConfig
+ */
+declare interface DefaultPeriodConfig {
+    /**
+     * Number of days in past to backfill from. 0 is no backfill. e.g) if 10, then backfill last 10 days of data. Required if fullHistory is not set.
+     * @type {number}
+     * @memberof DefaultPeriodConfig
+     */
+    days?: number;
+    /**
+     * If true, backfill all history. Required if days is not set.
+     * @type {boolean}
+     * @memberof DefaultPeriodConfig
+     */
+    fullHistory?: boolean;
+}
+
 /**
  * A map of object names to FieldMappingEntry arrays, with each FieldMappingEntry representing a field.
  */
@@ -85,53 +666,1477 @@ export declare type FieldMappingEntry = {
     fieldName?: string;
 };
 
-export declare function InstallIntegration({ integration, consumerRef, consumerName, groupRef, groupName, onInstallSuccess, onUpdateSuccess, onUninstallSuccess, fieldMapping, }: InstallIntegrationProps): JSX_2.Element;
-
-declare interface InstallIntegrationProps {
+/**
+ *
+ * @export
+ * @interface FieldMetadata
+ */
+declare interface FieldMetadata {
     /**
-     * The name of the integration from amp.yaml
+     * The name of the field from the provider API.
+     * @type {string}
+     * @memberof FieldMetadata
      */
-    integration: string;
+    fieldName: string;
     /**
-     *  The ID that your app uses to identify this end user.
+     * The display name of the field from the provider API.
+     * @type {string}
+     * @memberof FieldMetadata
      */
-    consumerRef: string;
+    displayName: string;
     /**
-     *  The display name that your app uses for this end user.
+     * A normalized field type
+     * @type {string}
+     * @memberof FieldMetadata
      */
-    consumerName?: string;
+    valueType?: FieldMetadataValueTypeEnum;
     /**
-     *  The ID that your app uses to identify the user's company, org, or team.
+     * Raw field type from the provider API.
+     * @type {string}
+     * @memberof FieldMetadata
      */
-    groupRef: string;
+    providerType?: string;
     /**
-     *  The display name that your app uses for this company, org or team.
+     * Whether the field is read-only.
+     * @type {boolean}
+     * @memberof FieldMetadata
      */
-    groupName?: string;
+    readOnly?: boolean;
     /**
-     * Dynamic field mappings that need to be filled out by a consumer.
-     * @experimental
+     * If the valueType is singleSelect or multiSelect, this is a list of possible values
+     * @type {Array<FieldValue>}
+     * @memberof FieldMetadata
      */
-    fieldMapping?: FieldMapping;
-    onInstallSuccess?: (installationId: string, config: Config) => void;
-    onUpdateSuccess?: (installationId: string, config: Config) => void;
-    onUninstallSuccess?: (installationId: string) => void;
+    values?: Array<FieldValue>;
 }
 
-declare interface MappedValue {
-    mappedValue: string;
-    mappedDisplayValue: string;
-}
+/**
+ * @export
+ */
+declare const FieldMetadataValueTypeEnum: {
+    readonly String: "string";
+    readonly Boolean: "boolean";
+    readonly SingleSelect: "singleSelect";
+    readonly MultiSelect: "multiSelect";
+    readonly Date: "date";
+    readonly Datetime: "datetime";
+    readonly Int: "int";
+    readonly Float: "float";
+    readonly Other: "other";
+};
 
-export declare function useAmpersandProvider(): never;
+declare type FieldMetadataValueTypeEnum = typeof FieldMetadataValueTypeEnum[keyof typeof FieldMetadataValueTypeEnum];
 
-export declare const useIsIntegrationInstalled: (integration: string, groupRef: string) => UseIsIntegrationInstalledResult;
+/**
+ *
+ * @export
+ * @interface FieldSetting
+ */
+declare interface FieldSetting {
+    /**
+     *
+     * @type {FieldSettingDefault}
+     * @memberof FieldSetting
+     */
+    _default?: FieldSettingDefault;
+    /**
+     * Whether the default value should be applied when creating a record.
+     * @type {string}
+     * @memberof FieldSetting
+     */
+    writeOnCreate?: FieldSettingWriteOnCreateEnum;
+    /**
+     * Whether the default value should be applied when updating a record.
+     * @type {string}
+     * @memberof FieldSetting
+     */
+    writeOnUpdate?: FieldSettingWriteOnUpdateEnum;
+}
 
-declare interface UseIsIntegrationInstalledResult {
-    isLoading: boolean;
-    isLoaded: boolean;
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Only use one of stringValue, integerValue, booleanValue.
+ * @export
+ * @interface FieldSettingDefault
+ */
+declare interface FieldSettingDefault {
+    /**
+     * The default string value to apply to a field
+     * @type {string}
+     * @memberof FieldSettingDefault
+     */
+    stringValue?: string;
+    /**
+     * The default integer value to apply to a field
+     * @type {number}
+     * @memberof FieldSettingDefault
+     */
+    integerValue?: number;
+    /**
+     * The default boolean value to apply to a field
+     * @type {boolean}
+     * @memberof FieldSettingDefault
+     */
+    booleanValue?: boolean;
+}
+
+/**
+ * @export
+ */
+declare const FieldSettingWriteOnCreateEnum: {
+    readonly Always: "always";
+    readonly Never: "never";
+};
+
+declare type FieldSettingWriteOnCreateEnum = typeof FieldSettingWriteOnCreateEnum[keyof typeof FieldSettingWriteOnCreateEnum];
+
+/**
+ * @export
+ */
+declare const FieldSettingWriteOnUpdateEnum: {
+    readonly Always: "always";
+    readonly Never: "never";
+};
+
+declare type FieldSettingWriteOnUpdateEnum = typeof FieldSettingWriteOnUpdateEnum[keyof typeof FieldSettingWriteOnUpdateEnum];
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Represents a field value
+ * @export
+ * @interface FieldValue
+ */
+declare interface FieldValue {
+    /**
+     * The internal value used by the system
+     * @type {string}
+     * @memberof FieldValue
+     */
+    value: string;
+    /**
+     * The human-readable display value
+     * @type {string}
+     * @memberof FieldValue
+     */
+    displayValue: string;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface Group
+ */
+declare interface Group {
+    /**
+     * The ID of the user group that has access to this installation.
+     * @type {string}
+     * @memberof Group
+     */
+    groupRef: string;
+    /**
+     * The name of the user group that has access to this installation.
+     * @type {string}
+     * @memberof Group
+     */
+    groupName: string;
+    /**
+     * The Ampersand project ID.
+     * @type {string}
+     * @memberof Group
+     */
+    projectId: string;
+    /**
+     * The time the group was created.
+     * @type {Date}
+     * @memberof Group
+     */
+    createTime: Date;
+    /**
+     * The time the group was last updated.
+     * @type {Date}
+     * @memberof Group
+     */
+    updateTime?: Date;
+}
+
+/**
+ *
+ * @export
+ * @interface HydratedIntegration
+ */
+declare interface HydratedIntegration {
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegration
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegration
+     */
+    displayName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegration
+     */
+    provider: string;
+    /**
+     *
+     * @type {HydratedIntegrationRead}
+     * @memberof HydratedIntegration
+     */
+    read?: HydratedIntegrationRead;
+    /**
+     *
+     * @type {HydratedIntegrationWrite}
+     * @memberof HydratedIntegration
+     */
+    write?: HydratedIntegrationWrite;
+    /**
+     *
+     * @type {HydratedIntegrationProxy}
+     * @memberof HydratedIntegration
+     */
+    proxy?: HydratedIntegrationProxy;
+}
+
+/**
+ * @type HydratedIntegrationField
+ *
+ * @export
+ */
+declare type HydratedIntegrationField = HydratedIntegrationFieldExistent | IntegrationFieldMapping;
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface HydratedIntegrationFieldExistent
+ */
+declare interface HydratedIntegrationFieldExistent {
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegrationFieldExistent
+     */
+    fieldName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegrationFieldExistent
+     */
+    displayName: string;
+    /**
+     * The field name to map to in the destination.
+     * @type {string}
+     * @memberof HydratedIntegrationFieldExistent
+     */
+    mapToName?: string;
+    /**
+     * The display name to map to in the destination.
+     * @type {string}
+     * @memberof HydratedIntegrationFieldExistent
+     */
+    mapToDisplayName?: string;
+}
+
+/**
+ *
+ * @export
+ * @interface HydratedIntegrationObject
+ */
+declare interface HydratedIntegrationObject {
+    /**
+     * Error message if there was an issue hydrating this object.
+     * @type {string}
+     * @memberof HydratedIntegrationObject
+     */
+    error?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegrationObject
+     */
+    objectName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegrationObject
+     */
+    displayName: string;
+    /**
+     * An object name to map to.
+     * @type {string}
+     * @memberof HydratedIntegrationObject
+     */
+    mapToName?: string;
+    /**
+     * A display name to map to.
+     * @type {string}
+     * @memberof HydratedIntegrationObject
+     */
+    mapToDisplayName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegrationObject
+     */
+    destination: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegrationObject
+     */
+    schedule: string;
+    /**
+     *
+     * @type {Array<HydratedIntegrationField>}
+     * @memberof HydratedIntegrationObject
+     */
+    requiredFields?: Array<HydratedIntegrationField>;
+    /**
+     *
+     * @type {Array<HydratedIntegrationField>}
+     * @memberof HydratedIntegrationObject
+     */
+    optionalFields?: Array<HydratedIntegrationField>;
+    /**
+     *
+     * @type {OptionalFieldsAutoOption}
+     * @memberof HydratedIntegrationObject
+     */
+    optionalFieldsAuto?: OptionalFieldsAutoOption;
+    /**
+     * This is a list of all fields on the object for a particular SaaS instance, including their display names.
+     * @type {Array<HydratedIntegrationField>}
+     * @memberof HydratedIntegrationObject
+     */
+    allFields?: Array<HydratedIntegrationField>;
+    /**
+     * This is a map of all fields on the object including their metadata (such as display name and type), the keys of the map are the field names.
+     * @type {{ [key: string]: FieldMetadata; }}
+     * @memberof HydratedIntegrationObject
+     */
+    allFieldsMetadata?: {
+        [key: string]: FieldMetadata;
+    };
+    /**
+     *
+     * @type {Backfill}
+     * @memberof HydratedIntegrationObject
+     */
+    backfill?: Backfill;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface HydratedIntegrationProxy
+ */
+declare interface HydratedIntegrationProxy {
+    /**
+     *
+     * @type {boolean}
+     * @memberof HydratedIntegrationProxy
+     */
+    enabled?: boolean;
+}
+
+/**
+ *
+ * @export
+ * @interface HydratedIntegrationRead
+ */
+declare interface HydratedIntegrationRead {
+    /**
+     *
+     * @type {Array<HydratedIntegrationObject>}
+     * @memberof HydratedIntegrationRead
+     */
+    objects?: Array<HydratedIntegrationObject>;
+}
+
+/**
+ *
+ * @export
+ * @interface HydratedIntegrationWrite
+ */
+declare interface HydratedIntegrationWrite {
+    /**
+     *
+     * @type {Array<HydratedIntegrationWriteObject>}
+     * @memberof HydratedIntegrationWrite
+     */
+    objects?: Array<HydratedIntegrationWriteObject>;
+}
+
+/**
+ *
+ * @export
+ * @interface HydratedIntegrationWriteObject
+ */
+declare interface HydratedIntegrationWriteObject {
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegrationWriteObject
+     */
+    objectName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HydratedIntegrationWriteObject
+     */
+    displayName: string;
+    /**
+     *
+     * @type {ValueDefaults}
+     * @memberof HydratedIntegrationWriteObject
+     */
+    valueDefaults?: ValueDefaults;
+}
+
+/**
+ *
+ * @export
+ * @interface HydratedRevision
+ */
+declare interface HydratedRevision {
+    /**
+     * The revision ID.
+     * @type {string}
+     * @memberof HydratedRevision
+     */
+    id: string;
+    /**
+     * The spec version string.
+     * @type {string}
+     * @memberof HydratedRevision
+     */
+    specVersion: string;
+    /**
+     * The time the revision was created.
+     * @type {Date}
+     * @memberof HydratedRevision
+     */
+    createTime: Date;
+    /**
+     *
+     * @type {HydratedIntegration}
+     * @memberof HydratedRevision
+     */
+    content: HydratedIntegration;
+}
+
+/**
+ *
+ * @export
+ * @interface Installation
+ */
+declare interface Installation {
+    /**
+     * The installation ID.
+     * @type {string}
+     * @memberof Installation
+     */
+    id: string;
+    /**
+     * The Ampersand project ID.
+     * @type {string}
+     * @memberof Installation
+     */
+    projectId: string;
+    /**
+     * The integration ID.
+     * @type {string}
+     * @memberof Installation
+     */
+    integrationId: string;
+    /**
+     *
+     * @type {Group}
+     * @memberof Installation
+     */
+    group?: Group;
+    /**
+     * The health status of the installation ("healthy", "unhealthy").
+     * @type {string}
+     * @memberof Installation
+     */
+    healthStatus: string;
+    /**
+     *
+     * @type {Connection}
+     * @memberof Installation
+     */
+    connection: Connection;
+    /**
+     * The time the integration was first installed.
+     * @type {Date}
+     * @memberof Installation
+     */
+    createTime: Date;
+    /**
+     * The person who did the installation, in the format of "consumer:{consumer-id}".
+     * @type {string}
+     * @memberof Installation
+     */
+    createdBy: string;
+    /**
+     * The time the installation was last updated with a new config.
+     * @type {Date}
+     * @memberof Installation
+     */
+    updateTime?: Date;
+    /**
+     *
+     * @type {Config}
+     * @memberof Installation
+     */
+    config: Config;
+}
+
+/**
+ * Bridge type for config content that can be used for both creation and updates.
+ * This type makes all fields optional to match UpdateInstallationConfigContent,
+ * but when used for creation, the provider field should be provided.
+ */
+export declare type InstallationConfigContent = Partial<ConfigContent>;
+
+declare interface InstallationContextValue {
+    integrationNameOrId: string;
+    consumerRef: string;
+    consumerName?: string;
+    groupRef: string;
+    groupName?: string;
+}
+
+export declare function InstallationProvider({ children, integration, consumerRef, consumerName, groupRef, groupName, }: InstallationProviderProps): JSX_2.Element;
+
+declare interface InstallationProviderProps {
+    integration: string;
+    consumerRef: string;
+    consumerName?: string;
+    groupRef: string;
+    groupName?: string;
+    children: React.ReactNode;
+}
+
+export declare function InstallIntegration({ integration, consumerRef, consumerName, groupRef, groupName, onInstallSuccess, onUpdateSuccess, onUninstallSuccess, fieldMapping, }: InstallIntegrationProps): JSX_2.Element;
+
+declare interface InstallIntegrationProps {
+    /**
+     * The name of the integration from amp.yaml
+     */
+    integration: string;
+    /**
+     *  The ID that your app uses to identify this end user.
+     */
+    consumerRef: string;
+    /**
+     *  The display name that your app uses for this end user.
+     */
+    consumerName?: string;
+    /**
+     *  The ID that your app uses to identify the user's company, org, or team.
+     */
+    groupRef: string;
+    /**
+     *  The display name that your app uses for this company, org or team.
+     */
+    groupName?: string;
+    /**
+     * Dynamic field mappings that need to be filled out by a consumer.
+     * @experimental
+     */
+    fieldMapping?: FieldMapping;
+    onInstallSuccess?: (installationId: string, config: Config) => void;
+    onUpdateSuccess?: (installationId: string, config: Config) => void;
+    onUninstallSuccess?: (installationId: string) => void;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface IntegrationFieldMapping
+ */
+declare interface IntegrationFieldMapping {
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationFieldMapping
+     */
+    mapToName: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationFieldMapping
+     */
+    mapToDisplayName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationFieldMapping
+     */
+    _default?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof IntegrationFieldMapping
+     */
+    prompt?: string;
+}
+
+declare interface MappedValue {
+    mappedValue: string;
+    mappedDisplayValue: string;
+}
+
+/**
+ *
+ * @export
+ * @interface Oauth2AuthorizationCodeTokensOnly
+ */
+declare interface Oauth2AuthorizationCodeTokensOnly {
+    /**
+     *
+     * @type {Oauth2AuthorizationCodeTokensOnlyAccessToken}
+     * @memberof Oauth2AuthorizationCodeTokensOnly
+     */
+    accessToken?: Oauth2AuthorizationCodeTokensOnlyAccessToken;
+    /**
+     *
+     * @type {Oauth2AuthorizationCodeTokensOnlyRefreshToken}
+     * @memberof Oauth2AuthorizationCodeTokensOnly
+     */
+    refreshToken?: Oauth2AuthorizationCodeTokensOnlyRefreshToken;
+    /**
+     * The scopes for the tokens.
+     * @type {Array<string>}
+     * @memberof Oauth2AuthorizationCodeTokensOnly
+     */
+    scopes?: Array<string>;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The access token for the connection.
+ * @export
+ * @interface Oauth2AuthorizationCodeTokensOnlyAccessToken
+ */
+declare interface Oauth2AuthorizationCodeTokensOnlyAccessToken {
+    /**
+     *
+     * @type {string}
+     * @memberof Oauth2AuthorizationCodeTokensOnlyAccessToken
+     */
+    token: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof Oauth2AuthorizationCodeTokensOnlyAccessToken
+     */
+    issuedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof Oauth2AuthorizationCodeTokensOnlyAccessToken
+     */
+    expiresAt?: Date;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The refresh token to use for the connection.
+ * @export
+ * @interface Oauth2AuthorizationCodeTokensOnlyRefreshToken
+ */
+declare interface Oauth2AuthorizationCodeTokensOnlyRefreshToken {
+    /**
+     *
+     * @type {string}
+     * @memberof Oauth2AuthorizationCodeTokensOnlyRefreshToken
+     */
+    token: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof Oauth2AuthorizationCodeTokensOnlyRefreshToken
+     */
+    issuedAt?: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof Oauth2AuthorizationCodeTokensOnlyRefreshToken
+     */
+    expiresAt?: Date;
+}
+
+/**
+ *
+ * @export
+ */
+declare const OptionalFieldsAutoOption: {
+    readonly All: "all";
+};
+
+declare type OptionalFieldsAutoOption = typeof OptionalFieldsAutoOption[keyof typeof OptionalFieldsAutoOption];
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ProviderApp
+ */
+declare interface ProviderApp {
+    /**
+     * The provider app ID.
+     * @type {string}
+     * @memberof ProviderApp
+     */
+    id: string;
+    /**
+     * The Ampersand project ID.
+     * @type {string}
+     * @memberof ProviderApp
+     */
+    projectId: string;
+    /**
+     * The ID used by the provider to identify the app (optional).
+     * @type {string}
+     * @memberof ProviderApp
+     */
+    externalRef?: string;
+    /**
+     * The SaaS provider that this app connects to.
+     * @type {string}
+     * @memberof ProviderApp
+     */
+    provider: string;
+    /**
+     * The OAuth client ID for this app.
+     * @type {string}
+     * @memberof ProviderApp
+     */
+    clientId: string;
+    /**
+     * The OAuth scopes for this app.
+     * @type {Array<string>}
+     * @memberof ProviderApp
+     */
+    scopes?: Array<string>;
+    /**
+     * The time the provider app was created.
+     * @type {Date}
+     * @memberof ProviderApp
+     */
+    createTime: Date;
+    /**
+     * The time the provider app was updated.
+     * @type {Date}
+     * @memberof ProviderApp
+     */
+    updateTime?: Date;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ProviderMetadataInfo
+ */
+declare interface ProviderMetadataInfo {
+    /**
+     * The value of the metadata field
+     * @type {string}
+     * @memberof ProviderMetadataInfo
+     */
+    value: string;
+    /**
+     * The source of the metadata field
+     * @type {string}
+     * @memberof ProviderMetadataInfo
+     */
+    source: ProviderMetadataInfoSourceEnum;
+    /**
+     * The human-readable name for the field
+     * @type {string}
+     * @memberof ProviderMetadataInfo
+     */
+    displayName?: string;
+}
+
+/**
+ * @export
+ */
+declare const ProviderMetadataInfoSourceEnum: {
+    readonly Input: "input";
+    readonly Token: "token";
+    readonly Provider: "provider";
+};
+
+declare type ProviderMetadataInfoSourceEnum = typeof ProviderMetadataInfoSourceEnum[keyof typeof ProviderMetadataInfoSourceEnum];
+
+/**
+ *
+ * @export
+ * @interface ReadConfig
+ */
+declare interface ReadConfig {
+    /**
+     *
+     * @type {{ [key: string]: ReadConfigObject; }}
+     * @memberof ReadConfig
+     */
+    objects: {
+        [key: string]: ReadConfigObject;
+    };
+}
+
+/**
+ *
+ * @export
+ * @interface ReadConfigObject
+ */
+declare interface ReadConfigObject {
+    /**
+     * The name of the object to read from.
+     * @type {string}
+     * @memberof ReadConfigObject
+     */
+    objectName: string;
+    /**
+     * The schedule for reading the object, in cron syntax.
+     * @type {string}
+     * @memberof ReadConfigObject
+     */
+    schedule: string;
+    /**
+     * The name of the destination that the result should be sent to.
+     * @type {string}
+     * @memberof ReadConfigObject
+     */
+    destination: string;
+    /**
+     * This is a map of field names to booleans indicating whether they should be read. If a field is already included in `selectedFieldMappings`, it does not need to be included here.
+     * @type {{ [key: string]: boolean; }}
+     * @memberof ReadConfigObject
+     */
+    selectedFields: {
+        [key: string]: boolean;
+    };
+    /**
+     * This is a map of field names to their value mappings.
+     * @type {{ [key: string]: { [key: string]: string; }; }}
+     * @memberof ReadConfigObject
+     */
+    selectedValueMappings?: {
+        [key: string]: {
+            [key: string]: string;
+        };
+    };
+    /**
+     * This is a map of mapToNames to field names. (A mapTo name is the name the builder wants to map a field to when it lands in their destination.)
+     * @type {{ [key: string]: string; }}
+     * @memberof ReadConfigObject
+     */
+    selectedFieldMappings: {
+        [key: string]: string;
+    };
+    /**
+     *
+     * @type {SelectedFieldsAutoConfig}
+     * @memberof ReadConfigObject
+     */
+    selectedFieldsAuto?: SelectedFieldsAutoConfig;
+    /**
+     *
+     * @type {BackfillConfig}
+     * @memberof ReadConfigObject
+     */
+    backfill?: BackfillConfig;
+}
+
+/**
+ * If selectedFieldsAuto is set to all, all fields will be read.
+ * @export
+ */
+declare const SelectedFieldsAutoConfig: {
+    readonly SelectedFieldsAll: "all";
+};
+
+declare type SelectedFieldsAutoConfig = typeof SelectedFieldsAutoConfig[keyof typeof SelectedFieldsAutoConfig];
+
+/**
+ *
+ * @export
+ * @interface SubscribeConfig
+ */
+declare interface SubscribeConfig {
+    /**
+     *
+     * @type {{ [key: string]: SubscribeConfigObject; }}
+     * @memberof SubscribeConfig
+     */
+    objects: {
+        [key: string]: SubscribeConfigObject;
+    };
+}
+
+/**
+ *
+ * @export
+ * @interface SubscribeConfigObject
+ */
+declare interface SubscribeConfigObject {
+    /**
+     * Whether to inherit fields and mappings from the read config.
+     * @type {boolean}
+     * @memberof SubscribeConfigObject
+     */
+    inheritFieldsAndMappings: boolean;
+    /**
+     * The name of the object to subscribe to.
+     * @type {string}
+     * @memberof SubscribeConfigObject
+     */
+    objectName: string;
+    /**
+     * The name of the destination that the result should be sent to.
+     * @type {string}
+     * @memberof SubscribeConfigObject
+     */
+    destination: string;
+    /**
+     *
+     * @type {ConfigCreateEvent}
+     * @memberof SubscribeConfigObject
+     */
+    createEvent?: ConfigCreateEvent;
+    /**
+     *
+     * @type {ConfigUpdateEvent}
+     * @memberof SubscribeConfigObject
+     */
+    updateEvent?: ConfigUpdateEvent;
+    /**
+     *
+     * @type {ConfigDeleteEvent}
+     * @memberof SubscribeConfigObject
+     */
+    deleteEvent?: ConfigDeleteEvent;
+}
+
+export declare function useAmpersandProvider(): never;
+
+export declare function useConfig(): {
+    draft: Partial<ConfigContent>;
+    get: () => Partial<ConfigContent>;
+    reset: () => void;
+    setDraft: Dispatch<SetStateAction<Partial<ConfigContent>>>;
+    readObject: (objectName: string) => {
+        object: BaseReadConfigObject | undefined;
+        getSelectedField: (fieldName: string) => boolean;
+        setSelectedField: (params: {
+            fieldName: string;
+            selected: boolean;
+        }) => void;
+        getFieldMapping: (fieldName: string) => string | undefined;
+        setFieldMapping: (params: {
+            fieldName: string;
+            mapToName: string;
+        }) => void;
+    };
+    writeObject: (objectName: string) => {
+        object: BaseWriteConfigObject | undefined;
+        setEnableWrite: () => void;
+        setDisableWrite: () => void;
+        getWriteObject: () => BaseWriteConfigObject | undefined;
+        getSelectedFieldSettings: (fieldName: string) => FieldSetting | undefined;
+        setSelectedFieldSettings: (params: {
+            fieldName: string;
+            settings: FieldSetting;
+        }) => void;
+        getDefaultValues: (fieldName: string) => FieldSettingDefault | undefined;
+        setDefaultValues: (params: {
+            fieldName: string;
+            value: FieldSettingDefault;
+        }) => void;
+        getWriteOnCreateSetting: (fieldName: string) => FieldSettingWriteOnCreateEnum | undefined;
+        setWriteOnCreateSetting: (params: {
+            fieldName: string;
+            value: FieldSettingWriteOnCreateEnum;
+        }) => void;
+        getWriteOnUpdateSetting: (fieldName: string) => FieldSettingWriteOnUpdateEnum | undefined;
+        setWriteOnUpdateSetting: (params: {
+            fieldName: string;
+            value: FieldSettingWriteOnUpdateEnum;
+        }) => void;
+    };
+};
+
+/**
+ * Connection manager that gives a connection if one is available.
+ * Loading and error states are also returned.
+ */
+export declare const useConnection: () => {
+    connection: Connection | undefined;
+    error: Error | null;
+    isPending: boolean;
+    isFetching: boolean;
+    isError: boolean;
+    isSuccess: boolean;
+};
+
+/**
+ * create installation hook
+ * @returns {Object} An object containing:
+ *   - `createInstallation` (function): A function to create the installation.
+ *   - `isIdle` (boolean): Whether the mutation is idle.
+ *   - `isPending` (boolean): Whether the mutation is pending.
+ *   - `error` (Error | null): The error object, if any.
+ *   - `errorMsg` (string | null): The error message, if any.
+ */
+export declare function useCreateInstallation(): {
+    createInstallation: ({ config, onSuccess, onError, onSettled, }: {
+        config: InstallationConfigContent;
+        onSuccess?: (data: Installation) => void;
+        onError?: (error: Error) => void;
+        onSettled?: () => void;
+    }) => void;
+    isIdle: boolean;
+    isPending: boolean;
+    error: Error | null;
+    errorMsg: string | null;
+};
+
+/**
+ * delete installation hook
+ * @returns {Object} An object containing:
+ *   - `deleteInstallation` (function): A function to delete the installation.
+ *   - `isIdle` (boolean): Whether the mutation is idle.
+ *   - `isPending` (boolean): Whether the mutation is pending.
+ *   - `error` (Error | null): The error object, if any.
+ *   - `errorMsg` (string | null): The error message, if any.
+ */
+export declare function useDeleteInstallation(): {
+    deleteInstallation: ({ onSuccess, onError, onSettled, }: {
+        onSuccess?: () => void;
+        onError?: (error: Error) => void;
+        onSettled?: () => void;
+    }) => void;
+    isIdle: boolean;
+    isPending: boolean;
+    error: Error | null;
+    errorMsg: string | null;
+};
+
+/**
+ * gets hydrated revision using headless hooks to fill in details
+ * @returns
+ */
+export declare const useHydratedRevisionQuery: () => UseQueryResult<HydratedRevision, Error>;
+
+/**
+ * useInstallation hook
+ * @returns {Object} An object containing:
+ *   - `installation` (Installation | undefined): The installation object.
+ *   - `isPending` (boolean): Whether the query is pending.
+ *   - `isFetching` (boolean): Whether the query is fetching.
+ *   - `isError` (boolean): Whether the query is in an error state.
+ *   - `isSuccess` (boolean): Whether the query is in a success state.
+ *   - `error` (Error | null): The error object, if any.
+ *   - `errorMsg` (string | null): The error message, if any.
+ */
+export declare function useInstallation(): {
+    installation: Installation | undefined;
+    isPending: boolean;
+    isFetching: boolean;
+    isError: boolean;
+    isSuccess: boolean;
+    error: Error | null;
+};
+
+export declare function useInstallationProps(): InstallationContextValue;
+
+export declare const useIsIntegrationInstalled: (integration: string, groupRef: string) => UseIsIntegrationInstalledResult;
+
+declare interface UseIsIntegrationInstalledResult {
+    isLoading: boolean;
+    isLoaded: boolean;
     isIntegrationInstalled: boolean | null;
     config?: Config;
 }
 
+/**
+ *  useManifest retrieves data from `amp.yaml` file, plus the customer's SaaS instance.
+ * @returns Manifest object
+ *
+ * if object is not found, returns null for the object, getRequiredFields, getOptionalFields,
+ *  getCustomerFieldsForObject, getCustomerFieldsMetadataForObject
+ *
+ */
+export declare function useManifest(): {
+    isPending: boolean;
+    isFetching: boolean;
+    isError: boolean;
+    isSuccess: boolean;
+    error: Error | null;
+    getReadObject: (objectName: string) => {
+        object: HydratedIntegrationObject | null;
+        getRequiredFields: () => HydratedIntegrationField[] | null;
+        getOptionalFields: () => HydratedIntegrationField[] | null;
+    };
+    getCustomerFieldsForObject: (objectName: string) => HydratedIntegrationField[] | null;
+    getCustomerFieldsMetadataForObject: (objectName: string) => {
+        allFieldsMetaData: {
+            [key: string]: FieldMetadata;
+        } | null;
+        getField: (field: string) => FieldMetadata | null;
+    };
+    data: HydratedRevision | undefined;
+};
+
+/**
+ * update installation hook
+ * @returns {Object} An object containing:
+ *   - `updateInstallation` (function): A function to update the installation.
+ *   - `isIdle` (boolean): Whether the mutation is idle.
+ *   - `isPending` (boolean): Whether the mutation is pending.
+ *   - `error` (Error | null): The error object, if any.
+ *   - `errorMsg` (string | null): The error message, if any.
+ */
+export declare function useUpdateInstallation(): {
+    updateInstallation: ({ config, onSuccess, onError, onSettled, }: {
+        config: InstallationConfigContent;
+        onSuccess?: (data: Installation) => void;
+        onError?: (error: Error) => void;
+        onSettled?: () => void;
+    }) => void;
+    isIdle: boolean;
+    isPending: boolean;
+    error: Error | null;
+    errorMsg: string | null;
+};
+
+/**
+ * @type ValueDefault
+ *
+ * @export
+ */
+declare type ValueDefault = ValueDefaultBoolean | ValueDefaultInteger | ValueDefaultString;
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ValueDefaultBoolean
+ */
+declare interface ValueDefaultBoolean {
+    /**
+     * The value to be used as a default.
+     * @type {boolean}
+     * @memberof ValueDefaultBoolean
+     */
+    value: boolean;
+    /**
+     * Whether the default value should be applied when updating a record.
+     * If set to `always`, the default value will be applied when updating a record.
+     * If set to `never`, the default value will not be applied when updating a record,
+     * only when creating a record.
+     * If unspecified, then `always` is assumed.
+     * @type {string}
+     * @memberof ValueDefaultBoolean
+     */
+    applyOnUpdate?: ValueDefaultBooleanApplyOnUpdateEnum;
+}
+
+/**
+ * @export
+ */
+declare const ValueDefaultBooleanApplyOnUpdateEnum: {
+    readonly Always: "always";
+    readonly Never: "never";
+};
+
+declare type ValueDefaultBooleanApplyOnUpdateEnum = typeof ValueDefaultBooleanApplyOnUpdateEnum[keyof typeof ValueDefaultBooleanApplyOnUpdateEnum];
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ValueDefaultInteger
+ */
+declare interface ValueDefaultInteger {
+    /**
+     * The value to be used as a default.
+     * @type {number}
+     * @memberof ValueDefaultInteger
+     */
+    value: number;
+    /**
+     * Whether the default value should be applied when updating a record.
+     * If set to `always`, the default value will be applied when updating a record.
+     * If set to `never`, the default value will not be applied when updating a record,
+     * only when creating a record.
+     * If unspecified, then `always` is assumed.
+     * @type {string}
+     * @memberof ValueDefaultInteger
+     */
+    applyOnUpdate?: ValueDefaultIntegerApplyOnUpdateEnum;
+}
+
+/**
+ * @export
+ */
+declare const ValueDefaultIntegerApplyOnUpdateEnum: {
+    readonly Always: "always";
+    readonly Never: "never";
+};
+
+declare type ValueDefaultIntegerApplyOnUpdateEnum = typeof ValueDefaultIntegerApplyOnUpdateEnum[keyof typeof ValueDefaultIntegerApplyOnUpdateEnum];
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Configuration to set default write values for object fields.
+ * @export
+ * @interface ValueDefaults
+ */
+declare interface ValueDefaults {
+    /**
+     * If true, users can set default values for any field.
+     * @type {boolean}
+     * @memberof ValueDefaults
+     */
+    allowAnyFields?: boolean;
+}
+
+/**
+ * Ampersand public API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ValueDefaultString
+ */
+declare interface ValueDefaultString {
+    /**
+     * The value to be used as a default.
+     * @type {string}
+     * @memberof ValueDefaultString
+     */
+    value: string;
+    /**
+     * Whether the default value should be applied when updating a record.
+     * If set to `always`, the default value will be applied when updating a record.
+     * If set to `never`, the default value will not be applied when updating a record,
+     * only when creating a record.
+     * If unspecified, then `always` is assumed.
+     * @type {string}
+     * @memberof ValueDefaultString
+     */
+    applyOnUpdate?: ValueDefaultStringApplyOnUpdateEnum;
+}
+
+/**
+ * @export
+ */
+declare const ValueDefaultStringApplyOnUpdateEnum: {
+    readonly Always: "always";
+    readonly Never: "never";
+};
+
+declare type ValueDefaultStringApplyOnUpdateEnum = typeof ValueDefaultStringApplyOnUpdateEnum[keyof typeof ValueDefaultStringApplyOnUpdateEnum];
+
+/**
+ *
+ * @export
+ * @interface WriteConfig
+ */
+declare interface WriteConfig {
+    /**
+     *
+     * @type {{ [key: string]: WriteConfigObject; }}
+     * @memberof WriteConfig
+     */
+    objects?: {
+        [key: string]: WriteConfigObject;
+    };
+}
+
+/**
+ *
+ * @export
+ * @interface WriteConfigObject
+ */
+declare interface WriteConfigObject {
+    /**
+     * The name of the object to write to.
+     * @type {string}
+     * @memberof WriteConfigObject
+     */
+    objectName: string;
+    /**
+     * This is a map of field names to default values. These values will be used when writing to the object.
+     * @type {{ [key: string]: ValueDefault; }}
+     * @memberof WriteConfigObject
+     * @deprecated
+     */
+    selectedValueDefaults?: {
+        [key: string]: ValueDefault;
+    };
+    /**
+     * This is a map of field names to their settings.
+     * @type {{ [key: string]: FieldSetting; }}
+     * @memberof WriteConfigObject
+     */
+    selectedFieldSettings?: {
+        [key: string]: FieldSetting;
+    };
+}
+
 export { }