cribl-control-plane 0.9.0-beta.2 → 0.9.0-rc.2

package/FUNCTIONS.md

@@ -20,32 +20,24 @@ specific category of applications.
 
 ```typescript
 import { CriblControlPlaneCore } from "cribl-control-plane/core.js";
-import { databaseConnectionsCreate } from "cribl-control-plane/funcs/databaseConnectionsCreate.js";
+import { authTokensGet } from "cribl-control-plane/funcs/authTokensGet.js";
 
 // Use `CriblControlPlaneCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const criblControlPlane = new CriblControlPlaneCore({
   serverURL: "https://api.example.com",
-  security: {
-    bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "",
-  },
 });
 
 async function run() {
-  const res = await databaseConnectionsCreate(criblControlPlane, {
-    authType: "connectionString",
-    connectionString: "mysql://admin:password123@mysql.example.com:3306/production?ssl=true",
-    connectionTimeout: 10000,
-    databaseType: "mysql",
-    description: "Production MySQL database for customer data",
-    id: "mysql-prod-db",
-    tags: "production,mysql,customer-data",
+  const res = await authTokensGet(criblControlPlane, {
+    password: "6j50J9421x29IhO",
+    username: "Lilly_Weissnat",
   });
   if (res.ok) {
     const { value: result } = res;
     console.log(result);
   } else {
-    console.log("databaseConnectionsCreate failed:", res.error);
+    console.log("authTokensGet failed:", res.error);
   }
 }
 

package/README.md

@@ -20,6 +20,7 @@ Complementary API reference documentation is available at [https://docs.cribl.io
 * [cribl-control-plane-sdk-typescript](#cribl-control-plane-sdk-typescript)
   * [SDK Installation](#sdk-installation)
   * [Requirements](#requirements)
+  * [Base URL and scoped clients](#base-url-and-scoped-clients)
   * [SDK Example Usage](#sdk-example-usage)
   * [Authentication](#authentication)
   * [Available Resources and Operations](#available-resources-and-operations)
@@ -73,15 +74,35 @@ yarn add cribl-control-plane
 For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 <!-- End Requirements [requirements] -->
 
+## Base URL and scoped clients
+
+Pass **`serverURL`** as the workspace or leader **origin** (for example `https://<workspace>-<org>.cribl.cloud` or `https://your-leader.example.com`). If the URL path does not already include `/api/v1`, the SDK appends it once when the client is constructed. The constant **`CRIBL_CONTROL_PLANE_API_PREFIX`** (`"/api/v1"`) is exported from `cribl-control-plane` if you need it for custom URL building.
+
+Operations that target a **worker group**, **Edge fleet**, or **worker node** live under `/api/v1/m/{groupId}` or `/api/v1/w/{nodeId}`. Instead of repeating `serverURL` on every call, use **`scoped()`**:
+
+```typescript
+const cribl = new CriblControlPlane({ serverURL, security });
+const wg = cribl.scoped({ group: "my-worker-group" });
+await wg.sources.create(/* … */);
+```
+
+`scoped()` returns a new **`CriblControlPlane`** with the same security, hooks, and HTTP client; only request URLs gain the extra path segments. The type **`ClientRequestScope`** is exported from `cribl-control-plane`:
+
+| Shape | Request path prefix (after `/api/v1`) |
+| ----- | -------------------------------------- |
+| `{ group: string }` | `/m/{group}/` |
+| `{ node: string }` | `/w/{node}/` |
+
+Use the **unscoped** client for leader-level APIs (for example `groups.create`, `groups.deploy`, `health.get`). For paths that include a **pack** segment (`/m/{group}/p/{packId}/`), pass a full base URL in **`serverURL`** on that call (or build it with **`CRIBL_CONTROL_PLANE_API_PREFIX`**). You can use **`serverURL`** in per-request options anytime you need to override the base for a single call.
+
 ## SDK Example Usage
 
 ### Example
 
 ```typescript
 import { CriblControlPlane } from "cribl-control-plane";
-import { CaptureLevel } from "cribl-control-plane/models";
 
-const criblControlPlane = new CriblControlPlane({
+const cribl = new CriblControlPlane({
   serverURL: "https://api.example.com",
   security: {
     bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "",
@@ -90,38 +111,34 @@ const criblControlPlane = new CriblControlPlane({
 
 async function run() {
   // Check server health
-  const health = await criblControlPlane.health.get();
+  await cribl.health.get();
 
   const workerGroupId = "my-worker-group";
-  const groupUrl = `https://api.example.com/m/${workerGroupId}`;
-  
+  // Group-scoped client: requests go under /api/v1/m/{workerGroupId}/
+  const wg = cribl.scoped({ group: workerGroupId });
+
   // Create a TCP JSON Source
-  const source = await criblControlPlane.sources.create({
+  const source = await wg.sources.create({
     id: "my-tcp-json",
     type: "tcpjson",
     host: "0.0.0.0",
     port: 9020,
     authType: "manual",
     authToken: "your-auth-token",
-  }, {
-    serverURL: groupUrl,
   });
 
   // Create a Filesystem Destination
-  const destination = await criblControlPlane.destinations.create({
+  const destination = await wg.destinations.create({
     id: "my-fs-destination",
     type: "filesystem",
     destPath: "/tmp/my-output",
-  }, {
-    serverURL: groupUrl,
   });
 
   // Create a Pipeline
-  const pipeline = await criblControlPlane.pipelines.create({
+  const pipeline = await wg.pipelines.create({
     id: "my-pipeline",
     conf: {
       asyncFuncTimeout: 1000,
-      output: "default",
       functions: [{
         filter: "true",
         conf: {
@@ -132,14 +149,10 @@ async function run() {
         final: true,
       }],
     },
-  }, {
-    serverURL: groupUrl,
   });
 
   // Add Route to Routing table
-  const routesListResponse = await criblControlPlane.routes.list({
-    serverURL: groupUrl,
-  });
+  const routesListResponse = await wg.routes.list();
   const routes = routesListResponse.items?.[0];
   if (routes && routes.id) {
     routes.routes = [{
@@ -152,42 +165,26 @@ async function run() {
       description: "My new route",
       additionalProperties: {},
     }, ...routes.routes];
-    await criblControlPlane.routes.update({
+    await wg.routes.update({
       id: routes.id,
-      routesInput: routes,
-    }, {
-      serverURL: groupUrl,
+      routes,
     });
   }
 
   // Commit configuration changes
-  const commitResponse = await criblControlPlane.versions.commits.create({
-    groupId: workerGroupId,
-    gitCommitParams: {
-      message: "Initial configuration",
-      effective: true,
-      files: ["."],
-    },
+  const commitResponse = await wg.versions.commits.create({
+    message: "Initial configuration",
+    effective: true,
+    files: ["."],
   });
   const version = commitResponse.items?.[0]?.commit;
 
   // Deploy configuration changes
-  await criblControlPlane.groups.deploy({
+  await cribl.groups.deploy({
     product: "stream",
     id: workerGroupId,
     deployRequest: { version },
   });
-
-  // Capture live events from the Pipeline
-  const captureStream = await criblControlPlane.system.captures.create({
-    duration: 30,
-    filter: "__inputId=='tcpjson:my-tcp-json'",
-    level: CaptureLevel.BeforeRoutes,
-    maxEvents: 100,
-  });
-  for await (const event of captureStream) {
-    console.log(event);
-  }
 }
 
 run();
@@ -197,12 +194,14 @@ run();
 > [!NOTE]
 > Additional examples demonstrating various SDK features and use cases can be found in the [`examples`](./examples) directory.
 
-<!-- No SDK Example Usage [usage] -->
+<!-- No End SDK Example Usage [usage] -->
 
 ## Authentication
 
 Except for the `health.get` and `auth.tokens.get` methods, all Cribl SDK requests require you to authenticate with a Bearer token. You must include a valid Bearer token in the configuration when initializing your SDK client. The Bearer token verifies your identity and ensures secure access to the requested resources. The SDK automatically manages the `Authorization` header for subsequent requests once properly authenticated.
 
+Initialize **`serverURL`** with your workspace or leader origin (you do not need to append `/api/v1` yourself). See [Base URL and scoped clients](#base-url-and-scoped-clients).
+
 For information about Bearer token expiration, see [Token Management](https://docs.cribl.io/cribl-as-code/sdks-auth/#sdks-token-mgmt) in the Cribl as Code documentation.
 
 **Authentication happens once during SDK initialization**. After you initialize the SDK client with authentication as shown in the [authentication examples](#authentication-examples), the SDK automatically handles authentication for all subsequent API calls. You do not need to include authentication parameters in individual API requests. The [SDK Example Usage](#sdk-example-usage) section shows how to initialize the SDK and make API calls, but if you've properly initialized your client as shown in the authentication examples, you only need to make the API method calls themselves without re-initializing.
@@ -242,18 +241,19 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl-control-pl
 
 ### [Collectors](docs/sdks/collectors/README.md)
 
-* [create](docs/sdks/collectors/README.md#create) - Create a Collector
 * [list](docs/sdks/collectors/README.md#list) - List all Collectors
-* [delete](docs/sdks/collectors/README.md#delete) - Delete a Collector
+* [create](docs/sdks/collectors/README.md#create) - Create a Collector
 * [get](docs/sdks/collectors/README.md#get) - Get a Collector
 * [update](docs/sdks/collectors/README.md#update) - Update a Collector
+* [delete](docs/sdks/collectors/README.md#delete) - Delete a Collector
 
 ### [DatabaseConnections](docs/sdks/databaseconnections/README.md)
 
+* [list](docs/sdks/databaseconnections/README.md#list) - List Database Connections
 * [create](docs/sdks/databaseconnections/README.md#create) - Create Database Connection
-* [delete](docs/sdks/databaseconnections/README.md#delete) - Delete a Database Connection
 * [get](docs/sdks/databaseconnections/README.md#get) - Get a Database Connection
 * [update](docs/sdks/databaseconnections/README.md#update) - Update a Database Connection
+* [delete](docs/sdks/databaseconnections/README.md#delete) - Delete a Database Connection
 
 ### [Destinations](docs/sdks/destinations/README.md)
 
@@ -275,13 +275,13 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl-control-pl
 
 #### [Destinations.Statuses](docs/sdks/destinationsstatuses/README.md)
 
-* [get](docs/sdks/destinationsstatuses/README.md#get) - Get the status of a Destination
 * [list](docs/sdks/destinationsstatuses/README.md#list) - List the status of all Destinations
+* [get](docs/sdks/destinationsstatuses/README.md#get) - Get the status of a Destination
 
 ### [Functions](docs/sdks/functions/README.md)
 
-* [get](docs/sdks/functions/README.md#get) - Get a Function
 * [list](docs/sdks/functions/README.md#list) - List all Functions
+* [get](docs/sdks/functions/README.md#get) - Get a Function
 
 ### [Groups](docs/sdks/groups/README.md)
 
@@ -310,17 +310,17 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl-control-pl
 
 ### [Lakes.Datasets](docs/sdks/datasets/README.md)
 
-* [create](docs/sdks/datasets/README.md#create) - Create a Lake Dataset (Cribl.Cloud only)
 * [list](docs/sdks/datasets/README.md#list) - List all Lake Datasets (Cribl.Cloud only)
-* [delete](docs/sdks/datasets/README.md#delete) - Delete a Lake Dataset (Cribl.Cloud only)
+* [create](docs/sdks/datasets/README.md#create) - Create a Lake Dataset (Cribl.Cloud only)
 * [get](docs/sdks/datasets/README.md#get) - Get a Lake Dataset (Cribl.Cloud only)
 * [update](docs/sdks/datasets/README.md#update) - Update a Lake Dataset (Cribl.Cloud only)
+* [delete](docs/sdks/datasets/README.md#delete) - Delete a Lake Dataset (Cribl.Cloud only)
 
 ### [Nodes](docs/sdks/nodes/README.md)
 
 * [count](docs/sdks/nodes/README.md#count) - Get a count of Worker, Edge, or Outpost Nodes
-* [get](docs/sdks/nodes/README.md#get) - Get detailed metadata for a Worker, Edge, or Outpost Node
 * [list](docs/sdks/nodes/README.md#list) - Get detailed metadata for Worker, Edge, or Outpost Nodes
+* [get](docs/sdks/nodes/README.md#get) - Get detailed metadata for a Worker, Edge, or Outpost Node
 * [restart](docs/sdks/nodes/README.md#restart) - Restart Worker, Edge, or Outpost Nodes
 
 #### [Nodes.Summaries](docs/sdks/summaries/README.md)
@@ -332,9 +332,9 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl-control-pl
 * [install](docs/sdks/packs/README.md#install) - Install a Pack
 * [list](docs/sdks/packs/README.md#list) - List all Packs
 * [upload](docs/sdks/packs/README.md#upload) - Upload a Pack file
-* [delete](docs/sdks/packs/README.md#delete) - Uninstall a Pack
 * [get](docs/sdks/packs/README.md#get) - Get a Pack
 * [update](docs/sdks/packs/README.md#update) - Upgrade a Pack
+* [delete](docs/sdks/packs/README.md#delete) - Uninstall a Pack
 
 #### [Packs.Destinations](docs/sdks/packsdestinations/README.md)
 
@@ -356,22 +356,22 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl-control-pl
 
 ##### [Packs.Destinations.Statuses](docs/sdks/packsdestinationsstatuses/README.md)
 
-* [get](docs/sdks/packsdestinationsstatuses/README.md#get) - Get the status of a Destination within a Pack
 * [list](docs/sdks/packsdestinationsstatuses/README.md#list) - List the status of all Destinations within a Pack
+* [get](docs/sdks/packsdestinationsstatuses/README.md#get) - Get the status of a Destination within a Pack
 
 #### [Packs.Pipelines](docs/sdks/packspipelines/README.md)
 
-* [create](docs/sdks/packspipelines/README.md#create) - Create a Pipeline within a Pack
 * [list](docs/sdks/packspipelines/README.md#list) - List all Pipelines within a Pack
-* [delete](docs/sdks/packspipelines/README.md#delete) - Delete a Pipeline within a Pack
+* [create](docs/sdks/packspipelines/README.md#create) - Create a Pipeline within a Pack
 * [get](docs/sdks/packspipelines/README.md#get) - Get a Pipeline within a Pack
 * [update](docs/sdks/packspipelines/README.md#update) - Update a Pipeline within a Pack
+* [delete](docs/sdks/packspipelines/README.md#delete) - Delete a Pipeline within a Pack
 
 #### [Packs.Routes](docs/sdks/packsroutes/README.md)
 
+* [list](docs/sdks/packsroutes/README.md#list) - List all Routes within a Pack
 * [get](docs/sdks/packsroutes/README.md#get) - Get a Routing table within a Pack
 * [update](docs/sdks/packsroutes/README.md#update) - Update a Route within a Pack
-* [list](docs/sdks/packsroutes/README.md#list) - List all Routes within a Pack
 * [append](docs/sdks/packsroutes/README.md#append) - Add a Route to the end of the Routing table within a Pack
 
 #### [Packs.Sources](docs/sdks/packssources/README.md)
@@ -394,22 +394,22 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl-control-pl
 
 ##### [Packs.Sources.Statuses](docs/sdks/packssourcesstatuses/README.md)
 
-* [get](docs/sdks/packssourcesstatuses/README.md#get) - Get the status of a Source within a Pack
 * [list](docs/sdks/packssourcesstatuses/README.md#list) - List the status of all Sources within a Pack
+* [get](docs/sdks/packssourcesstatuses/README.md#get) - Get the status of a Source within a Pack
 
 ### [Pipelines](docs/sdks/pipelines/README.md)
 
-* [create](docs/sdks/pipelines/README.md#create) - Create a Pipeline
 * [list](docs/sdks/pipelines/README.md#list) - List all Pipelines
+* [create](docs/sdks/pipelines/README.md#create) - Create a Pipeline
 * [delete](docs/sdks/pipelines/README.md#delete) - Delete a Pipeline
 * [get](docs/sdks/pipelines/README.md#get) - Get a Pipeline
 * [update](docs/sdks/pipelines/README.md#update) - Update a Pipeline
 
 ### [Routes](docs/sdks/routes/README.md)
 
+* [list](docs/sdks/routes/README.md#list) - List all Routes
 * [get](docs/sdks/routes/README.md#get) - Get a Routing table
 * [update](docs/sdks/routes/README.md#update) - Update a Route
-* [list](docs/sdks/routes/README.md#list) - List all Routes
 * [append](docs/sdks/routes/README.md#append) - Add a Route to the end of the Routing table
 
 ### [Sources](docs/sdks/sources/README.md)
@@ -427,17 +427,17 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl-control-pl
 
 #### [Sources.Pq](docs/sdks/sourcespq/README.md)
 
-* [clear](docs/sdks/sourcespq/README.md#clear) - Clear the persistent queue for a Source
 * [get](docs/sdks/sourcespq/README.md#get) - Get information about the latest job to clear the persistent queue for a Source
+* [clear](docs/sdks/sourcespq/README.md#clear) - Clear the persistent queue for a Source
 
 #### [Sources.Statuses](docs/sdks/sourcesstatuses/README.md)
 
-* [get](docs/sdks/sourcesstatuses/README.md#get) - Get the status of a Source
 * [list](docs/sdks/sourcesstatuses/README.md#list) - List the status of all Sources
+* [get](docs/sdks/sourcesstatuses/README.md#get) - Get the status of a Source
 
 ### [System.Captures](docs/sdks/captures/README.md)
 
-* [create](docs/sdks/captures/README.md#create) - Capture live incoming data
+* [create](docs/sdks/captures/README.md#create) - Capture live data
 
 ### [System.Settings](docs/sdks/settings/README.md)
 
@@ -445,7 +445,7 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl-control-pl
 
 #### [System.Settings.Cribl](docs/sdks/cribl/README.md)
 
-* [list](docs/sdks/cribl/README.md#list) - Get Cribl system settings
+* [list](docs/sdks/cribl/README.md#list) - Get system settings
 * [update](docs/sdks/cribl/README.md#update) - Update system settings
 
 ### [Versions.Branches](docs/sdks/branches/README.md)
@@ -455,9 +455,9 @@ The [On-Prem Authentication Example](https://github.com/criblio/cribl-control-pl
 
 ### [Versions.Commits](docs/sdks/commits/README.md)
 
+* [list](docs/sdks/commits/README.md#list) - List the commit history
 * [create](docs/sdks/commits/README.md#create) - Create a new commit for pending changes to the Cribl configuration
 * [diff](docs/sdks/commits/README.md#diff) - Get the diff for a commit
-* [list](docs/sdks/commits/README.md#list) - List the commit history
 * [push](docs/sdks/commits/README.md#push) - Push local commits to the remote repository
 * [revert](docs/sdks/commits/README.md#revert) - Revert a commit in the local repository
 * [get](docs/sdks/commits/README.md#get) - Get the diff and log message for a commit
@@ -503,6 +503,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`databaseConnectionsCreate`](docs/sdks/databaseconnections/README.md#create) - Create Database Connection
 - [`databaseConnectionsDelete`](docs/sdks/databaseconnections/README.md#delete) - Delete a Database Connection
 - [`databaseConnectionsGet`](docs/sdks/databaseconnections/README.md#get) - Get a Database Connection
+- [`databaseConnectionsList`](docs/sdks/databaseconnections/README.md#list) - List Database Connections
 - [`databaseConnectionsUpdate`](docs/sdks/databaseconnections/README.md#update) - Update a Database Connection
 - [`destinationsCreate`](docs/sdks/destinations/README.md#create) - Create a Destination
 - [`destinationsDelete`](docs/sdks/destinations/README.md#delete) - Delete a Destination
@@ -594,8 +595,8 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`sourcesStatusesGet`](docs/sdks/sourcesstatuses/README.md#get) - Get the status of a Source
 - [`sourcesStatusesList`](docs/sdks/sourcesstatuses/README.md#list) - List the status of all Sources
 - [`sourcesUpdate`](docs/sdks/sources/README.md#update) - Update a Source
-- [`systemCapturesCreate`](docs/sdks/captures/README.md#create) - Capture live incoming data
-- [`systemSettingsCriblList`](docs/sdks/cribl/README.md#list) - Get Cribl system settings
+- [`systemCapturesCreate`](docs/sdks/captures/README.md#create) - Capture live data
+- [`systemSettingsCriblList`](docs/sdks/cribl/README.md#list) - Get system settings
 - [`systemSettingsCriblUpdate`](docs/sdks/cribl/README.md#update) - Update system settings
 - [`systemSettingsRestart`](docs/sdks/settings/README.md#restart) - Restart the Cribl server
 - [`versionsBranchesGet`](docs/sdks/branches/README.md#get) - Get the name of the Git branch that the Cribl configuration is checked out to
@@ -678,7 +679,11 @@ const criblControlPlane = new CriblControlPlane({
 });
 
 async function run() {
-  const result = await criblControlPlane.sources.statuses.list();
+  const result = await criblControlPlane.packs.sources.statuses.list({
+    metrics: true,
+    type: false,
+    pack: "<value>",
+  });
 
   for await (const page of result) {
     console.log(page);

package/dist/commonjs/funcs/authTokensGet.d.ts

@@ -13,7 +13,7 @@ import { Result } from "../types/fp.js";
  * Log in and fetch an authentication token
  *
  * @remarks
- * This endpoint is unavailable on Cribl.Cloud.Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
+ * This endpoint is unavailable on Cribl.Cloud. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
  */
 export declare function authTokensGet(client: CriblControlPlaneCore, request: models.LoginInfo, options?: RequestOptions): APIPromise<Result<operations.CreateAuthLoginResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=authTokensGet.d.ts.map

package/dist/commonjs/funcs/authTokensGet.js

@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
  * Log in and fetch an authentication token
  *
  * @remarks
- * This endpoint is unavailable on Cribl.Cloud.Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
+ * This endpoint is unavailable on Cribl.Cloud. Instead, follow the instructions at https://docs.cribl.io/stream/api-tutorials/#criblcloud to get an Auth token for Cribl.Cloud.
  */
 function authTokensGet(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/collectorsUpdate.d.ts

@@ -13,7 +13,7 @@ import { Result } from "../types/fp.js";
  * Update a Collector
  *
  * @remarks
- * Update the specified Collector.<br><br>Provide a complete representation of the Collector that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Collector.<br><br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Collector might not function as expected.
+ * Update the specified Collector.<br/><br/>Provide a complete representation of the Collector that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Collector.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Collector might not function as expected.
  */
 export declare function collectorsUpdate(client: CriblControlPlaneCore, request: operations.UpdateSavedJobByIdRequest, options?: RequestOptions): APIPromise<Result<models.CountedSavedJobResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=collectorsUpdate.d.ts.map

package/dist/commonjs/funcs/collectorsUpdate.js

@@ -52,7 +52,7 @@ const async_js_1 = require("../types/async.js");
  * Update a Collector
  *
  * @remarks
- * Update the specified Collector.<br><br>Provide a complete representation of the Collector that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Collector.<br><br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Collector might not function as expected.
+ * Update the specified Collector.<br/><br/>Provide a complete representation of the Collector that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Collector.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Collector might not function as expected.
  */
 function collectorsUpdate(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));

package/dist/commonjs/funcs/databaseConnectionsList.d.ts

@@ -0,0 +1,19 @@
+import { CriblControlPlaneCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { CriblControlPlaneError } from "../models/errors/criblcontrolplaneerror.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as models from "../models/index.js";
+import * as operations from "../models/operations/index.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * List Database Connections
+ *
+ * @remarks
+ * Get a list of all Database Connections.
+ */
+export declare function databaseConnectionsList(client: CriblControlPlaneCore, request?: operations.GetDatabaseConnectionConfigRequest | undefined, options?: RequestOptions): APIPromise<Result<models.CountedDatabaseConnectionConfig, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
+//# sourceMappingURL=databaseConnectionsList.d.ts.map

package/dist/commonjs/funcs/databaseConnectionsList.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"databaseConnectionsList.d.ts","sourceRoot":"","sources":["../../../src/funcs/databaseConnectionsList.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAMnD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,sBAAsB,EAAE,MAAM,4CAA4C,CAAC;AACpF,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,qBAAqB,EAC7B,OAAO,CAAC,EAAE,UAAU,CAAC,kCAAkC,GAAG,SAAS,EACnE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,+BAA+B,EACpC,MAAM,CAAC,MAAM,GACb,sBAAsB,GACtB,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}

package/dist/commonjs/funcs/databaseConnectionsList.js

@@ -0,0 +1,133 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.databaseConnectionsList = databaseConnectionsList;
+const encodings_js_1 = require("../lib/encodings.js");
+const http_js_1 = require("../lib/http.js");
+const M = __importStar(require("../lib/matchers.js"));
+const primitives_js_1 = require("../lib/primitives.js");
+const schemas_js_1 = require("../lib/schemas.js");
+const security_js_1 = require("../lib/security.js");
+const url_js_1 = require("../lib/url.js");
+const errors = __importStar(require("../models/errors/index.js"));
+const models = __importStar(require("../models/index.js"));
+const operations = __importStar(require("../models/operations/index.js"));
+const async_js_1 = require("../types/async.js");
+/**
+ * List Database Connections
+ *
+ * @remarks
+ * Get a list of all Database Connections.
+ */
+function databaseConnectionsList(client, request, options) {
+    return new async_js_1.APIPromise($do(client, request, options));
+}
+async function $do(client, request, options) {
+    const parsed = (0, schemas_js_1.safeParse)(request, (value) => operations.GetDatabaseConnectionConfigRequest$outboundSchema.optional()
+        .parse(value), "Input validation failed");
+    if (!parsed.ok) {
+        return [parsed, { status: "invalid" }];
+    }
+    const payload = parsed.value;
+    const body = null;
+    const path = (0, url_js_1.pathToFunc)("/lib/database-connections")();
+    const query = (0, encodings_js_1.encodeFormQuery)({
+        "databaseType": payload?.databaseType,
+    });
+    const headers = new Headers((0, primitives_js_1.compactMap)({
+        Accept: "application/json",
+    }));
+    const securityInput = await (0, security_js_1.extractSecurity)(client._options.security);
+    const requestSecurity = (0, security_js_1.resolveGlobalSecurity)(securityInput);
+    const context = {
+        options: client._options,
+        baseURL: options?.serverURL ?? client._baseURL ?? "",
+        operationID: "getDatabaseConnectionConfig",
+        oAuth2Scopes: [],
+        resolvedSecurity: requestSecurity,
+        securitySource: client._options.security,
+        retryConfig: options?.retries
+            || client._options.retryConfig
+            || {
+                strategy: "backoff",
+                backoff: {
+                    initialInterval: 500,
+                    maxInterval: 60000,
+                    exponent: 1.5,
+                    maxElapsedTime: 3600000,
+                },
+                retryConnectionErrors: true,
+            }
+            || { strategy: "none" },
+        retryCodes: options?.retryCodes || ["429"],
+    };
+    const requestRes = client._createRequest(context, {
+        security: requestSecurity,
+        method: "GET",
+        baseURL: options?.serverURL,
+        path: path,
+        headers: headers,
+        query: query,
+        body: body,
+        userAgent: client._options.userAgent,
+        timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+    }, options);
+    if (!requestRes.ok) {
+        return [requestRes, { status: "invalid" }];
+    }
+    const req = requestRes.value;
+    const doResult = await client._do(req, {
+        context,
+        isErrorStatusCode: (statusCode) => (0, http_js_1.matchStatusCode)({ status: statusCode }, ["4XX", "5XX"]),
+        retryConfig: context.retryConfig,
+        retryCodes: context.retryCodes,
+    });
+    if (!doResult.ok) {
+        return [doResult, { status: "request-error", request: req }];
+    }
+    const response = doResult.value;
+    const responseFields = {
+        HttpMeta: { Response: response, Request: req },
+    };
+    const [result] = await M.match(M.json(200, models.CountedDatabaseConnectionConfig$inboundSchema), M.jsonErr(500, errors.ErrorT$inboundSchema), M.fail([401, "4XX"]), M.fail("5XX"))(response, req, { extraFields: responseFields });
+    if (!result.ok) {
+        return [result, { status: "complete", request: req, response }];
+    }
+    return [result, { status: "complete", request: req, response }];
+}
+//# sourceMappingURL=databaseConnectionsList.js.map

package/dist/commonjs/funcs/databaseConnectionsList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"databaseConnectionsList.js","sourceRoot":"","sources":["../../../src/funcs/databaseConnectionsList.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGH,sDAAsD;AACtD,4CAAiD;AACjD,MAAY,CAAC,+CAA2B;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAS3C,MAAY,MAAM,sDAAkC;AAGpD,MAAY,MAAM,+CAA2B;AAC7C,MAAY,UAAU,0DAAsC;AAC5D,gDAAwD;AAGxD;;;;;GAKG;AACH,iCACE,MAA6B,EAC7B,OAAmE,EACnE,OAAwB,EAcxB;IACA,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,OAAO,EACP,OAAO,CACR,CAAC,CAAC;AAAA,CACJ;AAED,KAAK,UAAU,GAAG,CAChB,MAA6B,EAC7B,OAAmE,EACnE,OAAwB,EAiBxB;IACA,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,OAAO,EACP,CAAC,KAAK,EAAE,EAAE,CACR,UAAU,CAAC,iDAAiD,CAAC,QAAQ,EAAE;SACpE,KAAK,CAAC,KAAK,CAAC,EACjB,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,2BAA2B,CAAC,EAAE,CAAC;IAEvD,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,cAAc,EAAE,OAAO,EAAE,YAAY;KACtC,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,aAAa,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,6BAA6B;QAC1C,YAAY,EAAE,EAAE;QAEhB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ;QACxC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B;gBACD,QAAQ,EAAE,SAAS;gBACnB,OAAO,EAAE;oBACP,eAAe,EAAE,GAAG;oBACpB,WAAW,EAAE,KAAK;oBAClB,QAAQ,EAAE,GAAG;oBACb,cAAc,EAAE,OAAO;iBACxB;gBACD,qBAAqB,EAAE,IAAI;aAC5B;eACE,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,CAAC;KAC3C,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,iBAAiB,EAAE,CAAC,UAAkB,EAAE,EAAE,CACxC,IAAA,yBAAe,EAAC,EAAE,MAAM,EAAE,UAAU,EAAc,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAY5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,6CAA6C,CAAC,EACjE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,oBAAoB,CAAC,EAC3C,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,EACpB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAAA,CACjE"}

package/dist/commonjs/funcs/databaseConnectionsUpdate.d.ts

@@ -13,7 +13,7 @@ import { Result } from "../types/fp.js";
  * Update a Database Connection
  *
  * @remarks
- * Update the specified Database Connection.</br></br>Provide a complete representation of the Database Connection that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Database Connection.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Database Connection might not function as expected.
+ * Update the specified Database Connection.<br/><br/>Provide a complete representation of the Database Connection that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Database Connection.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Database Connection might not function as expected.
  */
 export declare function databaseConnectionsUpdate(client: CriblControlPlaneCore, request: operations.UpdateDatabaseConnectionConfigByIdRequest, options?: RequestOptions): APIPromise<Result<models.CountedDatabaseConnectionConfig, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
 //# sourceMappingURL=databaseConnectionsUpdate.d.ts.map

package/dist/commonjs/funcs/databaseConnectionsUpdate.js

@@ -52,7 +52,7 @@ const async_js_1 = require("../types/async.js");
  * Update a Database Connection
  *
  * @remarks
- * Update the specified Database Connection.</br></br>Provide a complete representation of the Database Connection that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Database Connection.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Database Connection might not function as expected.
+ * Update the specified Database Connection.<br/><br/>Provide a complete representation of the Database Connection that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Database Connection.<br/><br/>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Database Connection might not function as expected.
  */
 function databaseConnectionsUpdate(client, request, options) {
     return new async_js_1.APIPromise($do(client, request, options));