@foxnose/sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,716 @@
+/**
+ * Immutable view of the outbound request used when applying auth.
+ */
+interface RequestData {
+    method: string;
+    url: string;
+    path: string;
+    body: Uint8Array;
+}
+/**
+ * Interface implemented by every authentication strategy.
+ */
+interface AuthStrategy {
+    buildHeaders(request: RequestData): Record<string, string>;
+}
+/**
+ * Provides access tokens for JWT auth.
+ */
+interface TokenProvider {
+    getToken(): string;
+}
+
+/**
+ * Placeholder auth strategy when no credentials are required.
+ */
+declare class AnonymousAuth implements AuthStrategy {
+    buildHeaders(_request: RequestData): Record<string, string>;
+}
+
+/**
+ * Simple token provider that always returns the same token.
+ */
+declare class StaticTokenProvider implements TokenProvider {
+    private readonly token;
+    constructor(token: string);
+    getToken(): string;
+}
+/**
+ * Adds `Authorization: Bearer` headers using a token provider.
+ */
+declare class JWTAuth implements AuthStrategy {
+    private readonly provider;
+    private readonly scheme;
+    constructor(provider: TokenProvider, options?: {
+        scheme?: string;
+    });
+    buildHeaders(_request: RequestData): Record<string, string>;
+    /**
+     * Convenience constructor for scripts with manual token management.
+     */
+    static fromStaticToken(token: string, options?: {
+        scheme?: string;
+    }): JWTAuth;
+}
+
+type Clock = () => Date;
+/**
+ * Implements the `Secure <public>:<signature>` header used by both APIs.
+ *
+ * The signature uses ECDSA P-256 over `<path>|<sha256(body)>|<timestamp>`.
+ */
+declare class SecureKeyAuth implements AuthStrategy {
+    private readonly publicKey;
+    private readonly privateKeyPem;
+    private readonly clock;
+    constructor(publicKey: string, privateKey: string, options?: {
+        clock?: Clock;
+    });
+    buildHeaders(request: RequestData): Record<string, string>;
+}
+
+/**
+ * Adds `Authorization: Simple` headers for development usage.
+ */
+declare class SimpleKeyAuth implements AuthStrategy {
+    private readonly publicKey;
+    private readonly secretKey;
+    constructor(publicKey: string, secretKey: string);
+    buildHeaders(_request: RequestData): Record<string, string>;
+}
+
+/**
+ * Controls HTTP retry behavior for idempotent requests.
+ */
+interface RetryConfig {
+    /** Total number of attempts (original request + retries). */
+    attempts: number;
+    /** Multiplier for exponential backoff delays. */
+    backoffFactor: number;
+    /** Response statuses that should be retried. */
+    statusCodes: readonly number[];
+    /** HTTP methods that are eligible for retrying. */
+    methods: readonly string[];
+}
+declare const DEFAULT_RETRY_CONFIG: Readonly<RetryConfig>;
+declare const SDK_VERSION = "0.1.0";
+declare const DEFAULT_USER_AGENT = "foxnose-sdk-js/0.1.0";
+/**
+ * General transport-level configuration shared by all clients.
+ */
+interface FoxnoseConfig {
+    /** Root URL (including scheme) for the API. */
+    baseUrl: string;
+    /** Request timeout in milliseconds. */
+    timeout: number;
+    /** Headers applied to every request (lower priority than per-call headers). */
+    defaultHeaders?: Record<string, string>;
+    /** User agent string reported to the API. */
+    userAgent: string;
+}
+/**
+ * Creates a validated FoxnoseConfig with defaults applied.
+ */
+declare function createConfig(options: {
+    baseUrl: string;
+    timeout?: number;
+    defaultHeaders?: Record<string, string>;
+    userAgent?: string;
+}): FoxnoseConfig;
+
+/**
+ * Base class for all SDK errors.
+ */
+declare class FoxnoseError extends Error {
+    constructor(message: string);
+}
+/**
+ * Raised when the API responds with an error status (4xx/5xx).
+ */
+declare class FoxnoseAPIError extends FoxnoseError {
+    readonly statusCode: number;
+    readonly errorCode?: string;
+    readonly detail?: unknown;
+    readonly responseHeaders?: Record<string, string>;
+    readonly responseBody?: unknown;
+    constructor(options: {
+        message: string;
+        statusCode: number;
+        errorCode?: string;
+        detail?: unknown;
+        responseHeaders?: Record<string, string>;
+        responseBody?: unknown;
+    });
+}
+/**
+ * Raised when authentication headers cannot be generated.
+ */
+declare class FoxnoseAuthError extends FoxnoseError {
+    constructor(message: string);
+}
+/**
+ * Raised when the HTTP layer fails before receiving a response.
+ */
+declare class FoxnoseTransportError extends FoxnoseError {
+    constructor(message: string);
+}
+
+/**
+ * Shared HTTP transport with retry logic built on native `fetch`.
+ */
+declare class HttpTransport {
+    private readonly config;
+    private readonly auth;
+    private readonly retry;
+    constructor(options: {
+        config: FoxnoseConfig;
+        auth?: AuthStrategy;
+        retryConfig?: RetryConfig;
+    });
+    request(method: string, path: string, options?: {
+        params?: Record<string, any>;
+        jsonBody?: any;
+        content?: Uint8Array;
+        headers?: Record<string, string>;
+        parseJson?: boolean;
+    }): Promise<any>;
+    close(): void;
+    private buildUrl;
+    private buildRequest;
+    private buildSigningPath;
+    private shouldRetry;
+    private computeDelay;
+    private maybeDecodeResponse;
+    private sendWithRetries;
+    private handleTransportError;
+    private raiseAPIError;
+    private sleep;
+}
+
+interface PaginatedResponse<T> {
+    count: number;
+    next: string | null;
+    previous: string | null;
+    results: T[];
+}
+interface ResourceSummary {
+    key: string;
+    folder: string;
+    content_type: string;
+    created_at: string;
+    vectors_size: number;
+    name?: string | null;
+    component?: string | null;
+    resource_owner?: string | null;
+    current_revision?: string | null;
+    external_id?: string | null;
+}
+interface RevisionSummary {
+    key: string;
+    resource: string;
+    schema_version: string;
+    number: number;
+    size: number;
+    created_at: string;
+    status: string;
+    is_valid: boolean | null;
+    published_at: string | null;
+    unpublished_at: string | null;
+}
+type ResourceList = PaginatedResponse<ResourceSummary>;
+type RevisionList = PaginatedResponse<RevisionSummary>;
+interface FolderSummary {
+    key: string;
+    name: string;
+    alias: string;
+    folder_type: string;
+    content_type: string;
+    strict_reference: boolean;
+    created_at: string;
+    parent?: string | null;
+    mode?: string | null;
+    path?: string | null;
+    auto_remove_revisions?: number | null;
+    auto_remove_schema_versions?: number | null;
+    embedding_model?: string | null;
+    embedding_dimension?: number | null;
+}
+type FolderList = PaginatedResponse<FolderSummary>;
+interface ComponentSummary {
+    key: string;
+    name: string;
+    description?: string | null;
+    environment: string;
+    content_type: string;
+    created_at: string;
+    current_version?: string | null;
+}
+type ComponentList = PaginatedResponse<ComponentSummary>;
+interface SchemaVersionSummary {
+    key: string;
+    name: string;
+    description: string | null;
+    version_number: number | null;
+    created_at: string;
+    published_at: string | null;
+    archived_at: string | null;
+    json_schema?: Record<string, any> | null;
+}
+interface FieldSummary {
+    key: string;
+    name: string;
+    description: string | null;
+    path: string;
+    parent: string | null;
+    type: string;
+    meta: Record<string, any>;
+    json_schema?: Record<string, any> | null;
+    required: boolean;
+    nullable: boolean;
+    multiple?: boolean | null;
+    localizable?: boolean | null;
+    searchable?: boolean | null;
+    private: boolean;
+    vectorizable?: boolean | null;
+    [extra: string]: any;
+}
+type SchemaVersionList = PaginatedResponse<SchemaVersionSummary>;
+type FieldList = PaginatedResponse<FieldSummary>;
+interface RegionInfo {
+    location: string;
+    name: string;
+    code: string;
+}
+interface ProjectSummary {
+    key: string;
+    name: string;
+    organization: string;
+    region: RegionInfo | string;
+    environments: Array<Record<string, any>>;
+    gdpr?: boolean | null;
+    created_at?: string | null;
+    [extra: string]: any;
+}
+type ProjectList = PaginatedResponse<ProjectSummary>;
+interface UserReference {
+    key: string;
+    email: string;
+    first_name: string;
+    last_name: string;
+    full_name: string;
+}
+interface EnvironmentSummary {
+    key: string;
+    name: string;
+    project: string;
+    host: string;
+    is_enabled: boolean;
+    created_at: string;
+    protection_level?: string | null;
+    protection_level_display?: string | null;
+    protected_by_user?: UserReference | null;
+    protected_at?: string | null;
+    protection_reason?: string | null;
+}
+type EnvironmentList = EnvironmentSummary[];
+interface LocaleSummary {
+    name: string;
+    code: string;
+    environment: string;
+    is_default: boolean;
+    created_at: string;
+}
+type LocaleList = LocaleSummary[];
+interface ManagementAPIKeySummary {
+    key: string;
+    description?: string | null;
+    public_key: string;
+    secret_key: string;
+    role?: string | null;
+    environment: string;
+    created_at: string;
+}
+type ManagementAPIKeyList = PaginatedResponse<ManagementAPIKeySummary>;
+interface FluxAPIKeySummary {
+    key: string;
+    description?: string | null;
+    public_key: string;
+    secret_key: string;
+    role?: string | null;
+    environment: string;
+    created_at: string;
+}
+type FluxAPIKeyList = PaginatedResponse<FluxAPIKeySummary>;
+interface ManagementRoleSummary {
+    key: string;
+    name: string;
+    description?: string | null;
+    full_access: boolean;
+    environment: string;
+    created_at: string;
+}
+type ManagementRoleList = PaginatedResponse<ManagementRoleSummary>;
+interface RolePermission {
+    content_type: string;
+    actions: string[];
+    all_objects: boolean;
+    objects?: string[] | null;
+}
+interface RolePermissionObject {
+    content_type: string;
+    object_key: string;
+}
+interface FluxRoleSummary {
+    key: string;
+    name: string;
+    description?: string | null;
+    environment: string;
+    created_at: string;
+}
+type FluxRoleList = PaginatedResponse<FluxRoleSummary>;
+interface APIInfo {
+    key: string;
+    name: string;
+    prefix: string;
+    description?: string | null;
+    environment: string;
+    version?: string | null;
+    is_auth_required: boolean;
+    created_at: string;
+    path?: string | null;
+}
+type APIList = PaginatedResponse<APIInfo>;
+interface APIFolderSummary {
+    folder: string;
+    api?: string | null;
+    path?: string | null;
+    allowed_methods?: string[] | null;
+    created_at?: string | null;
+}
+type APIFolderList = PaginatedResponse<APIFolderSummary>;
+interface OrganizationOwner {
+    key: string;
+    email: string;
+    first_name: string;
+    last_name: string;
+    full_name: string;
+}
+interface OrganizationSummary {
+    key: string;
+    name: string;
+    owner: OrganizationOwner;
+    tax_num: string;
+    city: string;
+    province: string;
+    address: string;
+    country_iso: string | null;
+    zip_code: string;
+    legal_name: string;
+    created_at: string;
+    block_dt?: string | null;
+    block_reason?: string | null;
+    is_blocked: boolean;
+}
+type OrganizationList = OrganizationSummary[];
+interface PlanLimits {
+    units_included?: string | null;
+    projects?: number | null;
+    environments?: number | null;
+    folders?: number | null;
+    resources?: number | null;
+    users?: number | null;
+    components?: number | null;
+    allow_negative?: boolean | null;
+    negative_limit?: number | null;
+    unit_cost?: number | null;
+    api_keys_max_count?: number | null;
+    roles_max_count?: number | null;
+    locales_max_count?: number | null;
+    schemas_max_count?: number | null;
+    schemas_fields_max_count?: number | null;
+    flux_api_max_count?: number | null;
+    max_component_inheritance_depth?: number | null;
+}
+interface PlanDetails {
+    code: string;
+    name: string;
+    price: number;
+    from?: string | null;
+    to?: string | null;
+    transferred?: string | null;
+    limits: PlanLimits;
+}
+interface OrganizationPlanStatus {
+    active_plan: PlanDetails;
+    next_plan: PlanDetails;
+}
+interface UnitsUsage {
+    remained?: string | number | null;
+    unit_cost?: number | null;
+    allow_negative: boolean;
+    negative_limit?: string | null;
+}
+interface StorageUsage {
+    data_storage: number;
+    vector_storage: number;
+}
+interface UsageMetric {
+    max: number | null;
+    current: number;
+}
+interface UsageBreakdown {
+    projects: UsageMetric;
+    environments: UsageMetric;
+    folders: UsageMetric;
+    resources: UsageMetric;
+    users: UsageMetric;
+    components: UsageMetric;
+}
+interface CurrentUsage {
+    api_requests: number;
+    embedding_tokens: Record<string, any>;
+}
+interface OrganizationUsage {
+    units: UnitsUsage;
+    storage: StorageUsage;
+    usage: UsageBreakdown;
+    current_usage: CurrentUsage;
+}
+interface BatchUpsertItem {
+    external_id: string;
+    payload: Record<string, any>;
+    component?: string | null;
+}
+interface BatchItemError {
+    index: number;
+    external_id: string;
+    error: Error;
+}
+interface BatchUpsertResult {
+    succeeded: ResourceSummary[];
+    failed: BatchItemError[];
+}
+type FolderRef = string | FolderSummary;
+type ResourceRef = string | ResourceSummary;
+type RevisionRef = string | RevisionSummary;
+type ComponentRef = string | ComponentSummary;
+type SchemaVersionRef = string | SchemaVersionSummary;
+type OrgRef = string | OrganizationSummary;
+type ProjectRef = string | ProjectSummary;
+type EnvironmentRef = string | EnvironmentSummary;
+type ManagementRoleRef = string | ManagementRoleSummary;
+type FluxRoleRef = string | FluxRoleSummary;
+type ManagementAPIKeyRef = string | ManagementAPIKeySummary;
+type FluxAPIKeyRef = string | FluxAPIKeySummary;
+type APIRef = string | APIInfo;
+/**
+ * Extract a string key from a value that is either a string or
+ * an object with a `key` attribute.
+ */
+declare function resolveKey(value: string | {
+    key: string;
+}): string;
+
+interface ManagementClientOptions {
+    baseUrl?: string;
+    environmentKey: string;
+    auth: AuthStrategy;
+    timeout?: number;
+    retryConfig?: RetryConfig;
+    defaultHeaders?: Record<string, string>;
+}
+/**
+ * Client for the FoxNose Management API.
+ *
+ * All methods are async and return parsed response objects.
+ */
+declare class ManagementClient {
+    readonly environmentKey: string;
+    private readonly transport;
+    private readonly paths;
+    constructor(options: ManagementClientOptions);
+    /**
+     * Low-level escape hatch for calling arbitrary endpoints.
+     */
+    request(method: string, path: string, options?: {
+        params?: Record<string, any>;
+        jsonBody?: any;
+        headers?: Record<string, string>;
+        parseJson?: boolean;
+    }): Promise<any>;
+    close(): void;
+    listOrganizations(): Promise<OrganizationList>;
+    getOrganization(orgKey: OrgRef): Promise<OrganizationSummary>;
+    updateOrganization(orgKey: OrgRef, payload: Record<string, any>): Promise<OrganizationSummary>;
+    listRegions(): Promise<RegionInfo[]>;
+    getAvailablePlans(): Promise<OrganizationPlanStatus>;
+    getOrganizationPlan(orgKey: OrgRef): Promise<OrganizationPlanStatus>;
+    setOrganizationPlan(orgKey: OrgRef, planCode: string): Promise<OrganizationPlanStatus>;
+    getOrganizationUsage(orgKey: OrgRef): Promise<OrganizationUsage>;
+    listManagementApiKeys(params?: Record<string, any>): Promise<ManagementAPIKeyList>;
+    createManagementApiKey(payload: Record<string, any>): Promise<ManagementAPIKeySummary>;
+    getManagementApiKey(key: ManagementAPIKeyRef): Promise<ManagementAPIKeySummary>;
+    updateManagementApiKey(key: ManagementAPIKeyRef, payload: Record<string, any>): Promise<ManagementAPIKeySummary>;
+    deleteManagementApiKey(key: ManagementAPIKeyRef): Promise<void>;
+    listFluxApiKeys(params?: Record<string, any>): Promise<FluxAPIKeyList>;
+    createFluxApiKey(payload: Record<string, any>): Promise<FluxAPIKeySummary>;
+    getFluxApiKey(key: FluxAPIKeyRef): Promise<FluxAPIKeySummary>;
+    updateFluxApiKey(key: FluxAPIKeyRef, payload: Record<string, any>): Promise<FluxAPIKeySummary>;
+    deleteFluxApiKey(key: FluxAPIKeyRef): Promise<void>;
+    listApis(params?: Record<string, any>): Promise<APIList>;
+    createApi(payload: Record<string, any>): Promise<APIInfo>;
+    getApi(apiKey: APIRef): Promise<APIInfo>;
+    updateApi(apiKey: APIRef, payload: Record<string, any>): Promise<APIInfo>;
+    deleteApi(apiKey: APIRef): Promise<void>;
+    listApiFolders(apiKey: APIRef, params?: Record<string, any>): Promise<APIFolderList>;
+    addApiFolder(apiKey: APIRef, folderKey: FolderRef, options?: {
+        allowedMethods?: string[];
+    }): Promise<APIFolderSummary>;
+    getApiFolder(apiKey: APIRef, folderKey: FolderRef): Promise<APIFolderSummary>;
+    updateApiFolder(apiKey: APIRef, folderKey: FolderRef, options?: {
+        allowedMethods?: string[];
+    }): Promise<APIFolderSummary>;
+    removeApiFolder(apiKey: APIRef, folderKey: FolderRef): Promise<void>;
+    listManagementRoles(params?: Record<string, any>): Promise<ManagementRoleList>;
+    createManagementRole(payload: Record<string, any>): Promise<ManagementRoleSummary>;
+    getManagementRole(roleKey: ManagementRoleRef): Promise<ManagementRoleSummary>;
+    updateManagementRole(roleKey: ManagementRoleRef, payload: Record<string, any>): Promise<ManagementRoleSummary>;
+    deleteManagementRole(roleKey: ManagementRoleRef): Promise<void>;
+    listManagementRolePermissions(roleKey: ManagementRoleRef): Promise<RolePermission[]>;
+    upsertManagementRolePermission(roleKey: ManagementRoleRef, payload: Record<string, any>): Promise<RolePermission>;
+    deleteManagementRolePermission(roleKey: ManagementRoleRef, contentType: string): Promise<void>;
+    replaceManagementRolePermissions(roleKey: ManagementRoleRef, permissions: Array<Record<string, any>>): Promise<RolePermission[]>;
+    listManagementPermissionObjects(roleKey: ManagementRoleRef, contentType: string): Promise<RolePermissionObject[]>;
+    addManagementPermissionObject(roleKey: ManagementRoleRef, payload: Record<string, any>): Promise<RolePermissionObject>;
+    deleteManagementPermissionObject(roleKey: ManagementRoleRef, payload: Record<string, any>): Promise<void>;
+    listFluxRoles(params?: Record<string, any>): Promise<FluxRoleList>;
+    createFluxRole(payload: Record<string, any>): Promise<FluxRoleSummary>;
+    getFluxRole(roleKey: FluxRoleRef): Promise<FluxRoleSummary>;
+    updateFluxRole(roleKey: FluxRoleRef, payload: Record<string, any>): Promise<FluxRoleSummary>;
+    deleteFluxRole(roleKey: FluxRoleRef): Promise<void>;
+    listFluxRolePermissions(roleKey: FluxRoleRef): Promise<RolePermission[]>;
+    upsertFluxRolePermission(roleKey: FluxRoleRef, payload: Record<string, any>): Promise<RolePermission>;
+    deleteFluxRolePermission(roleKey: FluxRoleRef, contentType: string): Promise<void>;
+    replaceFluxRolePermissions(roleKey: FluxRoleRef, permissions: Array<Record<string, any>>): Promise<RolePermission[]>;
+    listFluxPermissionObjects(roleKey: FluxRoleRef, contentType: string): Promise<RolePermissionObject[]>;
+    addFluxPermissionObject(roleKey: FluxRoleRef, payload: Record<string, any>): Promise<RolePermissionObject>;
+    deleteFluxPermissionObject(roleKey: FluxRoleRef, payload: Record<string, any>): Promise<void>;
+    listFolders(params?: Record<string, any>): Promise<FolderList>;
+    getFolder(folderKey: FolderRef): Promise<FolderSummary>;
+    getFolderByPath(path: string): Promise<FolderSummary>;
+    listFolderTree(options?: {
+        key?: string;
+        mode?: string;
+    }): Promise<FolderList>;
+    createFolder(payload: Record<string, any>): Promise<FolderSummary>;
+    updateFolder(folderKey: FolderRef, payload: Record<string, any>): Promise<FolderSummary>;
+    deleteFolder(folderKey: FolderRef): Promise<void>;
+    listFolderVersions(folderKey: FolderRef, params?: Record<string, any>): Promise<SchemaVersionList>;
+    createFolderVersion(folderKey: FolderRef, payload: Record<string, any>, options?: {
+        copyFrom?: SchemaVersionRef;
+    }): Promise<SchemaVersionSummary>;
+    getFolderVersion(folderKey: FolderRef, versionKey: SchemaVersionRef, options?: {
+        includeSchema?: boolean;
+    }): Promise<SchemaVersionSummary>;
+    updateFolderVersion(folderKey: FolderRef, versionKey: SchemaVersionRef, payload: Record<string, any>): Promise<SchemaVersionSummary>;
+    deleteFolderVersion(folderKey: FolderRef, versionKey: SchemaVersionRef): Promise<void>;
+    publishFolderVersion(folderKey: FolderRef, versionKey: SchemaVersionRef): Promise<SchemaVersionSummary>;
+    listFolderFields(folderKey: FolderRef, versionKey: SchemaVersionRef, params?: Record<string, any>): Promise<FieldList>;
+    createFolderField(folderKey: FolderRef, versionKey: SchemaVersionRef, payload: Record<string, any>): Promise<FieldSummary>;
+    getFolderField(folderKey: FolderRef, versionKey: SchemaVersionRef, fieldPath: string): Promise<FieldSummary>;
+    updateFolderField(folderKey: FolderRef, versionKey: SchemaVersionRef, fieldPath: string, payload: Record<string, any>): Promise<FieldSummary>;
+    deleteFolderField(folderKey: FolderRef, versionKey: SchemaVersionRef, fieldPath: string): Promise<void>;
+    listComponents(params?: Record<string, any>): Promise<ComponentList>;
+    getComponent(componentKey: ComponentRef): Promise<ComponentSummary>;
+    createComponent(payload: Record<string, any>): Promise<ComponentSummary>;
+    updateComponent(componentKey: ComponentRef, payload: Record<string, any>): Promise<ComponentSummary>;
+    deleteComponent(componentKey: ComponentRef): Promise<void>;
+    listComponentVersions(componentKey: ComponentRef, params?: Record<string, any>): Promise<SchemaVersionList>;
+    createComponentVersion(componentKey: ComponentRef, payload: Record<string, any>, options?: {
+        copyFrom?: SchemaVersionRef;
+    }): Promise<SchemaVersionSummary>;
+    getComponentVersion(componentKey: ComponentRef, versionKey: SchemaVersionRef, options?: {
+        includeSchema?: boolean;
+    }): Promise<SchemaVersionSummary>;
+    publishComponentVersion(componentKey: ComponentRef, versionKey: SchemaVersionRef): Promise<SchemaVersionSummary>;
+    updateComponentVersion(componentKey: ComponentRef, versionKey: SchemaVersionRef, payload: Record<string, any>): Promise<SchemaVersionSummary>;
+    deleteComponentVersion(componentKey: ComponentRef, versionKey: SchemaVersionRef): Promise<void>;
+    listComponentFields(componentKey: ComponentRef, versionKey: SchemaVersionRef, params?: Record<string, any>): Promise<FieldList>;
+    createComponentField(componentKey: ComponentRef, versionKey: SchemaVersionRef, payload: Record<string, any>): Promise<FieldSummary>;
+    getComponentField(componentKey: ComponentRef, versionKey: SchemaVersionRef, fieldPath: string): Promise<FieldSummary>;
+    updateComponentField(componentKey: ComponentRef, versionKey: SchemaVersionRef, fieldPath: string, payload: Record<string, any>): Promise<FieldSummary>;
+    deleteComponentField(componentKey: ComponentRef, versionKey: SchemaVersionRef, fieldPath: string): Promise<void>;
+    listResources(folderKey: FolderRef, params?: Record<string, any>): Promise<ResourceList>;
+    getResource(folderKey: FolderRef, resourceKey: ResourceRef): Promise<ResourceSummary>;
+    createResource(folderKey: FolderRef, payload: Record<string, any>, options?: {
+        component?: ComponentRef;
+        externalId?: string;
+    }): Promise<ResourceSummary>;
+    upsertResource(folderKey: FolderRef, payload: Record<string, any>, options: {
+        externalId: string;
+        component?: ComponentRef;
+    }): Promise<ResourceSummary>;
+    batchUpsertResources(folderKey: FolderRef, items: BatchUpsertItem[], options?: {
+        maxConcurrency?: number;
+        failFast?: boolean;
+        onProgress?: (completed: number, total: number) => void;
+    }): Promise<BatchUpsertResult>;
+    updateResource(folderKey: FolderRef, resourceKey: ResourceRef, payload: Record<string, any>): Promise<ResourceSummary>;
+    deleteResource(folderKey: FolderRef, resourceKey: ResourceRef): Promise<void>;
+    getResourceData(folderKey: FolderRef, resourceKey: ResourceRef): Promise<Record<string, any>>;
+    listRevisions(folderKey: FolderRef, resourceKey: ResourceRef, params?: Record<string, any>): Promise<RevisionList>;
+    createRevision(folderKey: FolderRef, resourceKey: ResourceRef, payload: Record<string, any>): Promise<RevisionSummary>;
+    getRevision(folderKey: FolderRef, resourceKey: ResourceRef, revisionKey: RevisionRef): Promise<RevisionSummary>;
+    updateRevision(folderKey: FolderRef, resourceKey: ResourceRef, revisionKey: RevisionRef, payload: Record<string, any>): Promise<RevisionSummary>;
+    deleteRevision(folderKey: FolderRef, resourceKey: ResourceRef, revisionKey: RevisionRef): Promise<void>;
+    publishRevision(folderKey: FolderRef, resourceKey: ResourceRef, revisionKey: RevisionRef, payload?: Record<string, any>): Promise<RevisionSummary>;
+    validateRevision(folderKey: FolderRef, resourceKey: ResourceRef, revisionKey: RevisionRef): Promise<Record<string, any>>;
+    getRevisionData(folderKey: FolderRef, resourceKey: ResourceRef, revisionKey: RevisionRef): Promise<Record<string, any>>;
+    listLocales(): Promise<LocaleList>;
+    createLocale(payload: Record<string, any>): Promise<LocaleSummary>;
+    getLocale(code: string): Promise<LocaleSummary>;
+    updateLocale(code: string, payload: Record<string, any>): Promise<LocaleSummary>;
+    deleteLocale(code: string): Promise<void>;
+    listProjects(orgKey: OrgRef, params?: Record<string, any>): Promise<ProjectList>;
+    getProject(orgKey: OrgRef, projectKey: ProjectRef): Promise<ProjectSummary>;
+    createProject(orgKey: OrgRef, payload: Record<string, any>): Promise<ProjectSummary>;
+    updateProject(orgKey: OrgRef, projectKey: ProjectRef, payload: Record<string, any>): Promise<ProjectSummary>;
+    deleteProject(orgKey: OrgRef, projectKey: ProjectRef): Promise<void>;
+    listEnvironments(orgKey: OrgRef, projectKey: ProjectRef): Promise<EnvironmentList>;
+    getEnvironment(orgKey: OrgRef, projectKey: ProjectRef, envKey: EnvironmentRef): Promise<EnvironmentSummary>;
+    createEnvironment(orgKey: OrgRef, projectKey: ProjectRef, payload: Record<string, any>): Promise<EnvironmentSummary>;
+    updateEnvironment(orgKey: OrgRef, projectKey: ProjectRef, envKey: EnvironmentRef, payload: Record<string, any>): Promise<EnvironmentSummary>;
+    deleteEnvironment(orgKey: OrgRef, projectKey: ProjectRef, envKey: EnvironmentRef): Promise<void>;
+    toggleEnvironment(orgKey: OrgRef, projectKey: ProjectRef, envKey: EnvironmentRef, isEnabled: boolean): Promise<void>;
+    updateEnvironmentProtection(orgKey: OrgRef, projectKey: ProjectRef, envKey: EnvironmentRef, options: {
+        protectionLevel: string;
+        protectionReason?: string;
+    }): Promise<EnvironmentSummary>;
+    clearEnvironmentProtection(orgKey: OrgRef, projectKey: ProjectRef, envKey: EnvironmentRef): Promise<EnvironmentSummary>;
+}
+
+interface FluxClientOptions {
+    baseUrl: string;
+    apiPrefix: string;
+    auth: AuthStrategy;
+    timeout?: number;
+    retryConfig?: RetryConfig;
+    defaultHeaders?: Record<string, string>;
+}
+/**
+ * Client for FoxNose Flux delivery APIs.
+ *
+ * All methods are async and return parsed JSON responses.
+ */
+declare class FluxClient {
+    readonly apiPrefix: string;
+    private readonly transport;
+    constructor(options: FluxClientOptions);
+    private buildPath;
+    listResources<T = any>(folderPath: string, params?: Record<string, any>): Promise<T>;
+    getResource<T = any>(folderPath: string, resourceKey: string, params?: Record<string, any>): Promise<T>;
+    search<T = any>(folderPath: string, body: Record<string, any>): Promise<T>;
+    close(): void;
+}
+
+export { type APIFolderList, type APIFolderSummary, type APIInfo, type APIList, type APIRef, AnonymousAuth, type AuthStrategy, type BatchItemError, type BatchUpsertItem, type BatchUpsertResult, type ComponentList, type ComponentRef, type ComponentSummary, type CurrentUsage, DEFAULT_RETRY_CONFIG, DEFAULT_USER_AGENT, type EnvironmentList, type EnvironmentRef, type EnvironmentSummary, type FieldList, type FieldSummary, type FluxAPIKeyList, type FluxAPIKeyRef, type FluxAPIKeySummary, FluxClient, type FluxClientOptions, type FluxRoleList, type FluxRoleRef, type FluxRoleSummary, type FolderList, type FolderRef, type FolderSummary, FoxnoseAPIError, FoxnoseAuthError, type FoxnoseConfig, FoxnoseError, FoxnoseTransportError, HttpTransport, JWTAuth, type LocaleList, type LocaleSummary, type ManagementAPIKeyList, type ManagementAPIKeyRef, type ManagementAPIKeySummary, ManagementClient, type ManagementClientOptions, type ManagementRoleList, type ManagementRoleRef, type ManagementRoleSummary, type OrgRef, type OrganizationList, type OrganizationOwner, type OrganizationPlanStatus, type OrganizationSummary, type OrganizationUsage, type PaginatedResponse, type PlanDetails, type PlanLimits, type ProjectList, type ProjectRef, type ProjectSummary, type RegionInfo, type RequestData, type ResourceList, type ResourceRef, type ResourceSummary, type RetryConfig, type RevisionList, type RevisionRef, type RevisionSummary, type RolePermission, type RolePermissionObject, SDK_VERSION, type SchemaVersionList, type SchemaVersionRef, type SchemaVersionSummary, SecureKeyAuth, SimpleKeyAuth, StaticTokenProvider, type StorageUsage, type TokenProvider, type UnitsUsage, type UsageBreakdown, type UsageMetric, type UserReference, SDK_VERSION as VERSION, createConfig, resolveKey };