@hydradb/sdk 2.0.1 → 2.1.1

package/dist/api/resources/connectors/client/Client.d.ts

@@ -0,0 +1,240 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as HydraDB from "../../../index.js";
+export declare namespace ConnectorsClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+export declare class ConnectorsClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ConnectorsClient.Options>;
+    constructor(options?: ConnectorsClient.Options);
+    /**
+     * List a provider's resources directly from supplied credentials, before creating a connector.
+     *
+     * @param {HydraDB.HandlerDiscoverPreviewReq} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.BadRequestError}
+     * @throws {@link HydraDB.BadGatewayError}
+     *
+     * @example
+     *     await client.connectors.discoverPreview({
+     *         credentials: {
+     *             "api_token": "xoxb-..."
+     *         },
+     *         provider: "slack"
+     *     })
+     */
+    discoverPreview(request: HydraDB.HandlerDiscoverPreviewReq, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __discoverPreview;
+    /**
+     * List all connectors for the authenticated org, optionally filtered by provider.
+     *
+     * @param {HydraDB.ListConnectorsRequest} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.InternalServerError}
+     *
+     * @example
+     *     await client.connectors.list({
+     *         provider: "slack"
+     *     })
+     */
+    list(request?: HydraDB.ListConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __list;
+    /**
+     * Create a connector for a provider and store its credentials.
+     *
+     * @param {HydraDB.HandlerConnectorCreateReq} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.BadRequestError}
+     * @throws {@link HydraDB.InternalServerError}
+     * @throws {@link HydraDB.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.connectors.create({
+     *         provider: "slack"
+     *     })
+     */
+    create(request: HydraDB.HandlerConnectorCreateReq, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<HydraDB.ConnectorsConnector>;
+    private __create;
+    /**
+     * Fetch a single connector by ID.
+     *
+     * @param {HydraDB.GetConnectorsRequest} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.NotFoundError}
+     * @throws {@link HydraDB.InternalServerError}
+     *
+     * @example
+     *     await client.connectors.get({
+     *         id: "HydraDoc1234"
+     *     })
+     */
+    get(request: HydraDB.GetConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<HydraDB.ConnectorsConnector>;
+    private __get;
+    /**
+     * Delete a connector, its resources, and stored credentials.
+     *
+     * @param {HydraDB.DeleteConnectorsRequest} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.NotFoundError}
+     * @throws {@link HydraDB.InternalServerError}
+     *
+     * @example
+     *     await client.connectors.delete({
+     *         id: "HydraDoc1234"
+     *     })
+     */
+    delete(request: HydraDB.DeleteConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __delete;
+    /**
+     * Save the selected resources for a connector and trigger initial sync/backfill.
+     *
+     * @param {HydraDB.HandlerConfigureReq} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.BadRequestError}
+     * @throws {@link HydraDB.NotFoundError}
+     * @throws {@link HydraDB.InternalServerError}
+     *
+     * @example
+     *     await client.connectors.configure({
+     *         id: "HydraDoc1234",
+     *         resources: [{
+     *                 additionalMetadata: {
+     *                     "author": "ada",
+     *                     "doc_version": 3
+     *                 },
+     *                 collection: "team_docs",
+     *                 database: "acme_corp",
+     *                 metadata: {
+     *                     "department": "finance",
+     *                     "priority": 7
+     *                 },
+     *                 name: "general",
+     *                 resourceId: "C0123456789",
+     *                 resourceType: "channel",
+     *                 subTenantId: "sub_tenant_4567",
+     *                 tenantId: "tenant_1234"
+     *             }]
+     *     })
+     */
+    configure(request: HydraDB.HandlerConfigureReq, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __configure;
+    /**
+     * Internal-service endpoint (X-Cortex-Secret) used by the MOVEIT refresh loop to persist a rotated refresh_token for OAuth-bundle connectors. Providers that rotate the refresh token on each exchange invalidate the previously stored one, so the new token must be written back or the next sync fails with invalid_grant. Only refresh_token is merged onto the current stored credential bundle and re-encrypted under the connector's identity context; credentials are never returned.
+     *
+     * @param {HydraDB.PatchConnectorsIdCredentialsRequest} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.BadRequestError}
+     * @throws {@link HydraDB.ForbiddenError}
+     * @throws {@link HydraDB.NotFoundError}
+     * @throws {@link HydraDB.InternalServerError}
+     * @throws {@link HydraDB.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.connectors.rotateAConnectorsStoredOAuthRefreshToken({
+     *         id: "HydraDoc1234",
+     *         body: {
+     *             "key": "value"
+     *         }
+     *     })
+     */
+    rotateAConnectorsStoredOAuthRefreshToken(request: HydraDB.PatchConnectorsIdCredentialsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __rotateAConnectorsStoredOAuthRefreshToken;
+    /**
+     * List a connected provider's resources using the connector's stored credentials.
+     *
+     * @param {HydraDB.DiscoverConnectorsRequest} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.BadRequestError}
+     * @throws {@link HydraDB.NotFoundError}
+     * @throws {@link HydraDB.InternalServerError}
+     * @throws {@link HydraDB.BadGatewayError}
+     *
+     * @example
+     *     await client.connectors.discover({
+     *         id: "HydraDoc1234"
+     *     })
+     */
+    discover(request: HydraDB.DiscoverConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __discover;
+    /**
+     * List the configured resources for a connector.
+     *
+     * @param {HydraDB.ListResourcesConnectorsRequest} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.NotFoundError}
+     * @throws {@link HydraDB.InternalServerError}
+     *
+     * @example
+     *     await client.connectors.listResources({
+     *         id: "HydraDoc1234"
+     *     })
+     */
+    listResources(request: HydraDB.ListResourcesConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __listResources;
+    /**
+     * Add a resource mapping to a connector.
+     *
+     * @param {HydraDB.HandlerResourceCreateReq} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.BadRequestError}
+     * @throws {@link HydraDB.NotFoundError}
+     * @throws {@link HydraDB.InternalServerError}
+     *
+     * @example
+     *     await client.connectors.createResource({
+     *         id: "HydraDoc1234",
+     *         resourceId: "C0123456789"
+     *     })
+     */
+    createResource(request: HydraDB.HandlerResourceCreateReq, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<HydraDB.ConnectorsResource>;
+    private __createResource;
+    /**
+     * Remove a resource mapping from a connector.
+     *
+     * @param {HydraDB.DeleteResourceConnectorsRequest} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.BadRequestError}
+     * @throws {@link HydraDB.NotFoundError}
+     * @throws {@link HydraDB.InternalServerError}
+     *
+     * @example
+     *     await client.connectors.deleteResource({
+     *         id: "HydraDoc1234",
+     *         resourceId: "C0123456789"
+     *     })
+     */
+    deleteResource(request: HydraDB.DeleteResourceConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __deleteResource;
+    /**
+     * Start a manual sync workflow for a connector.
+     *
+     * @param {HydraDB.SyncConnectorsRequest} request
+     * @param {ConnectorsClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link HydraDB.NotFoundError}
+     * @throws {@link HydraDB.ConflictError}
+     * @throws {@link HydraDB.InternalServerError}
+     * @throws {@link HydraDB.ServiceUnavailableError}
+     *
+     * @example
+     *     await client.connectors.sync({
+     *         id: "HydraDoc1234"
+     *     })
+     */
+    sync(request: HydraDB.SyncConnectorsRequest, requestOptions?: ConnectorsClient.RequestOptions): core.HttpResponsePromise<Record<string, unknown>>;
+    private __sync;
+}