@squadbase/connectors 0.0.13 → 0.0.14

package/dist/sdk.d.ts

@@ -34,7 +34,7 @@ interface KintoneConnectorSdk {
  * @param params - Resolved parameter values keyed by parameter slug
  *                 ("base-url", "username", "password")
  */
-declare function createClient$1(params: Record<string, string>): KintoneConnectorSdk;
+declare function createClient$5(params: Record<string, string>): KintoneConnectorSdk;
 
 interface OpenAIConnectorSdk {
     apiKey: string;
@@ -44,6 +44,346 @@ interface OpenAIConnectorSdk {
  *
  * @param params - Resolved parameter values keyed by parameter slug ("api-key")
  */
-declare function createClient(params: Record<string, string>): OpenAIConnectorSdk;
+declare function createClient$4(params: Record<string, string>): OpenAIConnectorSdk;
 
-export { type KintoneConnectorSdk, type OpenAIConnectorSdk, createClient$1 as kintone, createClient as openai };
+/** Shape returned by the Airtable API for a single record. */
+interface AirtableRecord {
+    id: string;
+    createdTime: string;
+    fields: Record<string, unknown>;
+}
+interface AirtableConnectorSdk {
+    /**
+     * Send an authenticated request to the Airtable REST API.
+     * Interface matches `fetch` — only auth headers and base URL are added automatically.
+     *
+     * The placeholder `{baseId}` in the path is automatically replaced with the
+     * configured Base ID.
+     *
+     * @param path - API path (e.g., "/{baseId}/TableName")
+     * @param init - Standard RequestInit (same as fetch)
+     * @returns Standard Response (same as fetch)
+     */
+    request(path: string, init?: RequestInit): Promise<Response>;
+    /**
+     * List records in a table.
+     *
+     * @see https://airtable.com/developers/web/api/list-records
+     */
+    listRecords(tableIdOrName: string, options?: {
+        fields?: string[];
+        filterByFormula?: string;
+        maxRecords?: number;
+        sort?: {
+            field: string;
+            direction?: "asc" | "desc";
+        }[];
+        pageSize?: number;
+        view?: string;
+        offset?: string;
+    }): Promise<{
+        records: AirtableRecord[];
+        offset?: string;
+    }>;
+    /**
+     * Get a single record by ID.
+     *
+     * @see https://airtable.com/developers/web/api/get-record
+     */
+    getRecord(tableIdOrName: string, recordId: string): Promise<AirtableRecord>;
+    /**
+     * Create one or more records (max 10 per request).
+     *
+     * @see https://airtable.com/developers/web/api/create-records
+     */
+    createRecords(tableIdOrName: string, records: {
+        fields: Record<string, unknown>;
+    }[], options?: {
+        typecast?: boolean;
+    }): Promise<{
+        records: AirtableRecord[];
+    }>;
+    /**
+     * Update one or more records via PATCH (partial update, max 10 per request).
+     *
+     * @see https://airtable.com/developers/web/api/update-multiple-records
+     */
+    updateRecords(tableIdOrName: string, records: {
+        id: string;
+        fields: Record<string, unknown>;
+    }[], options?: {
+        typecast?: boolean;
+    }): Promise<{
+        records: AirtableRecord[];
+    }>;
+    /**
+     * List tables in the base (Meta API).
+     *
+     * @see https://airtable.com/developers/web/api/get-base-schema
+     */
+    listTables(): Promise<{
+        tables: Record<string, unknown>[];
+    }>;
+}
+/**
+ * Create an Airtable client from resolved connection parameters.
+ *
+ * @param params - Resolved parameter values keyed by parameter slug
+ *                 ("base-id", "api-key")
+ */
+declare function createClient$3(params: Record<string, string>): AirtableConnectorSdk;
+
+interface GoogleAnalyticsConnectorSdk {
+    /**
+     * Send an authenticated request to the Google Analytics Data API.
+     * Interface matches `fetch` — only auth headers and base URL are added automatically.
+     *
+     * Base URL: https://analyticsdata.googleapis.com/v1beta/
+     * Occurrences of `{propertyId}` in the path are auto-replaced with the configured property ID.
+     *
+     * @param path - API path (e.g., "properties/{propertyId}:runReport")
+     * @param init - Standard RequestInit (same as fetch)
+     * @returns Standard Response (same as fetch)
+     */
+    request(path: string, init?: RequestInit): Promise<Response>;
+    /**
+     * Run a GA4 report.
+     *
+     * @see https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runReport
+     */
+    runReport(request: {
+        dateRanges: {
+            startDate: string;
+            endDate: string;
+        }[];
+        dimensions?: {
+            name: string;
+        }[];
+        metrics: {
+            name: string;
+        }[];
+        limit?: number;
+        offset?: number;
+        dimensionFilter?: Record<string, unknown>;
+        metricFilter?: Record<string, unknown>;
+        orderBys?: Record<string, unknown>[];
+    }): Promise<{
+        rows: {
+            dimensionValues: {
+                value: string;
+            }[];
+            metricValues: {
+                value: string;
+            }[];
+        }[];
+        rowCount: number;
+    }>;
+    /**
+     * Get available dimensions and metrics for a property.
+     *
+     * @see https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/getMetadata
+     */
+    getMetadata(): Promise<{
+        name: string;
+        dimensions: {
+            apiName: string;
+            uiName: string;
+            description: string;
+            [key: string]: unknown;
+        }[];
+        metrics: {
+            apiName: string;
+            uiName: string;
+            description: string;
+            type: string;
+            [key: string]: unknown;
+        }[];
+    }>;
+    /**
+     * Run a realtime report.
+     *
+     * @see https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties/runRealtimeReport
+     */
+    runRealtimeReport(request: {
+        dimensions?: {
+            name: string;
+        }[];
+        metrics: {
+            name: string;
+        }[];
+        limit?: number;
+        dimensionFilter?: Record<string, unknown>;
+        metricFilter?: Record<string, unknown>;
+        minuteRanges?: {
+            startMinutesAgo?: number;
+            endMinutesAgo?: number;
+            name?: string;
+        }[];
+    }): Promise<{
+        rows: {
+            dimensionValues: {
+                value: string;
+            }[];
+            metricValues: {
+                value: string;
+            }[];
+        }[];
+        rowCount: number;
+    }>;
+}
+/**
+ * Create a Google Analytics client from resolved connection parameters.
+ *
+ * @param params - Resolved parameter values keyed by parameter slug
+ *                 ("service-account-key-json-base64", "property-id")
+ */
+declare function createClient$2(params: Record<string, string>): GoogleAnalyticsConnectorSdk;
+
+interface WixStoreConnectorSdk {
+    /**
+     * Send an authenticated request to the Wix REST API.
+     * Interface matches `fetch` — only auth headers and base URL are added automatically.
+     *
+     * @param path - API path (e.g., "/stores/v1/products/query")
+     * @param init - Standard RequestInit (same as fetch)
+     * @returns Standard Response (same as fetch)
+     */
+    request(path: string, init?: RequestInit): Promise<Response>;
+    /**
+     * Query products via POST /stores/v1/products/query.
+     */
+    queryProducts(options?: {
+        filter?: Record<string, unknown>;
+        sort?: Record<string, unknown>;
+        paging?: {
+            limit?: number;
+            offset?: number;
+        };
+    }): Promise<{
+        products: Record<string, unknown>[];
+        totalResults: number;
+    }>;
+    /**
+     * Get a single product by ID via GET /stores/v1/products/{productId}.
+     */
+    getProduct(productId: string): Promise<{
+        product: Record<string, unknown>;
+    }>;
+    /**
+     * Search orders via POST /ecom/v1/orders/search (eCommerce Orders V1).
+     * Uses cursor-based pagination.
+     */
+    queryOrders(options?: {
+        filter?: Record<string, unknown>;
+        sort?: Record<string, unknown>;
+        cursorPaging?: {
+            limit?: number;
+            cursor?: string;
+        };
+    }): Promise<{
+        orders: Record<string, unknown>[];
+        pagingMetadata?: {
+            cursors?: {
+                next?: string;
+                prev?: string;
+            };
+        };
+    }>;
+    /**
+     * Get a single order by ID via GET /ecom/v1/orders/{orderId}.
+     */
+    getOrder(orderId: string): Promise<{
+        order: Record<string, unknown>;
+    }>;
+    /**
+     * Query collections via POST /stores/v1/collections/query.
+     */
+    queryCollections(options?: {
+        filter?: Record<string, unknown>;
+        sort?: Record<string, unknown>;
+        paging?: {
+            limit?: number;
+            offset?: number;
+        };
+    }): Promise<{
+        collections: Record<string, unknown>[];
+    }>;
+    /**
+     * Query inventory items via POST /stores/v2/inventoryItems/query.
+     */
+    queryInventory(options?: {
+        filter?: Record<string, unknown>;
+        paging?: {
+            limit?: number;
+            offset?: number;
+        };
+    }): Promise<{
+        inventoryItems: Record<string, unknown>[];
+        totalResults: number;
+    }>;
+}
+/**
+ * Create a Wix Store client from resolved connection parameters.
+ *
+ * @param params - Resolved parameter values keyed by parameter slug
+ *                 ("account-id", "site-id", "api-key")
+ */
+declare function createClient$1(params: Record<string, string>): WixStoreConnectorSdk;
+
+interface DbtConnectorSdk {
+    /**
+     * Send an authenticated request to the dbt Cloud API.
+     * Interface matches `fetch` — only auth headers and base URL are added automatically.
+     * Any `{environmentId}` placeholder in the path is replaced with the production environment ID.
+     *
+     * @param path - API path (e.g., "/api/v2/accounts/...")
+     * @param init - Standard RequestInit (same as fetch)
+     * @returns Standard Response (same as fetch)
+     */
+    request(path: string, init?: RequestInit): Promise<Response>;
+    /**
+     * Execute a raw GraphQL query against the dbt Cloud Discovery API.
+     * The `environmentId` variable is auto-injected.
+     *
+     * @param graphqlQuery - GraphQL query string
+     * @param variables - Additional GraphQL variables (environmentId is merged automatically)
+     */
+    query(graphqlQuery: string, variables?: Record<string, unknown>): Promise<Record<string, unknown>>;
+    /**
+     * List models in the production environment.
+     */
+    getModels(options?: {
+        limit?: number;
+    }): Promise<Record<string, unknown>[]>;
+    /**
+     * Get a specific model by its uniqueId, including catalog columns.
+     */
+    getModelByUniqueId(uniqueId: string): Promise<Record<string, unknown> | null>;
+    /**
+     * List sources in the production environment, including freshness info.
+     */
+    getSources(options?: {
+        limit?: number;
+    }): Promise<Record<string, unknown>[]>;
+    /**
+     * List tests and their results in the production environment.
+     */
+    getTests(options?: {
+        limit?: number;
+    }): Promise<Record<string, unknown>[]>;
+    /**
+     * List metrics defined in the project (from definition state).
+     */
+    getMetrics(options?: {
+        limit?: number;
+    }): Promise<Record<string, unknown>[]>;
+}
+/**
+ * Create a dbt Cloud client from resolved connection parameters.
+ *
+ * @param params - Resolved parameter values keyed by parameter slug
+ *                 ("host", "account-id", "prod-env-id", "token")
+ */
+declare function createClient(params: Record<string, string>): DbtConnectorSdk;
+
+export { type AirtableConnectorSdk, type DbtConnectorSdk, type GoogleAnalyticsConnectorSdk, type KintoneConnectorSdk, type OpenAIConnectorSdk, type WixStoreConnectorSdk, createClient$3 as airtable, createClient as dbt, createClient$2 as googleAnalytics, createClient$5 as kintone, createClient$4 as openai, createClient$1 as wixStore };