cribl-control-plane 0.0.21 → 0.0.23

package/docs/sdks/workers/README.md

@@ -0,0 +1,236 @@
+# Workers
+(*workers*)
+
+## Overview
+
+Actions related to Workers
+
+### Available Operations
+
+* [getSummaryWorkers](#getsummaryworkers) - get worker and edge nodes count
+* [getWorkers](#getworkers) - get worker and edge nodes
+* [updateWorkersRestart](#updateworkersrestart) - restarts worker nodes
+
+## getSummaryWorkers
+
+get worker and edge nodes count
+
+### Example Usage
+
+```typescript
+import { CriblControlPlane } from "cribl-control-plane";
+
+const criblControlPlane = new CriblControlPlane({
+  serverURL: "https://api.example.com",
+  security: {
+    bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await criblControlPlane.workers.getSummaryWorkers();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CriblControlPlaneCore } from "cribl-control-plane/core.js";
+import { workersGetSummaryWorkers } from "cribl-control-plane/funcs/workersGetSummaryWorkers.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 workersGetSummaryWorkers(criblControlPlane);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("workersGetSummaryWorkers failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetSummaryWorkersRequest](../../models/operations/getsummaryworkersrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.GetSummaryWorkersResponse](../../models/operations/getsummaryworkersresponse.md)\>**
+
+### Errors
+
+| Error Type                           | Status Code                          | Content Type                         |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| errors.ErrorT                        | 500                                  | application/json                     |
+| errors.CriblControlPlaneDefaultError | 4XX, 5XX                             | \*/\*                                |
+
+## getWorkers
+
+get worker and edge nodes
+
+### Example Usage
+
+```typescript
+import { CriblControlPlane } from "cribl-control-plane";
+
+const criblControlPlane = new CriblControlPlane({
+  serverURL: "https://api.example.com",
+  security: {
+    bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await criblControlPlane.workers.getWorkers();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CriblControlPlaneCore } from "cribl-control-plane/core.js";
+import { workersGetWorkers } from "cribl-control-plane/funcs/workersGetWorkers.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 workersGetWorkers(criblControlPlane);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("workersGetWorkers failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.GetWorkersRequest](../../models/operations/getworkersrequest.md)                                                                                                   | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.GetWorkersResponse](../../models/operations/getworkersresponse.md)\>**
+
+### Errors
+
+| Error Type                           | Status Code                          | Content Type                         |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| errors.ErrorT                        | 500                                  | application/json                     |
+| errors.CriblControlPlaneDefaultError | 4XX, 5XX                             | \*/\*                                |
+
+## updateWorkersRestart
+
+restarts worker nodes
+
+### Example Usage
+
+```typescript
+import { CriblControlPlane } from "cribl-control-plane";
+
+const criblControlPlane = new CriblControlPlane({
+  serverURL: "https://api.example.com",
+  security: {
+    bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "",
+  },
+});
+
+async function run() {
+  const result = await criblControlPlane.workers.updateWorkersRestart();
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CriblControlPlaneCore } from "cribl-control-plane/core.js";
+import { workersUpdateWorkersRestart } from "cribl-control-plane/funcs/workersUpdateWorkersRestart.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 workersUpdateWorkersRestart(criblControlPlane);
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("workersUpdateWorkersRestart failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[operations.UpdateWorkersRestartResponse](../../models/operations/updateworkersrestartresponse.md)\>**
+
+### Errors
+
+| Error Type                           | Status Code                          | Content Type                         |
+| ------------------------------------ | ------------------------------------ | ------------------------------------ |
+| errors.ErrorT                        | 500                                  | application/json                     |
+| errors.CriblControlPlaneDefaultError | 4XX, 5XX                             | \*/\*                                |

package/examples/{sourcesListSource.example.ts → lakeCreateCriblLakeDatasetByLakeId.example.ts}

@@ -8,7 +8,7 @@ dotenv.config();
  * Example usage of the cribl-control-plane SDK
  *
  * To run this example from the examples directory:
- * npm run build && npx tsx sourcesListSource.ts
+ * npm run build && npx tsx lakeCreateCriblLakeDatasetByLakeId.ts
  */
 
 import { CriblControlPlane } from "cribl-control-plane";
@@ -21,7 +21,12 @@ const criblControlPlane = new CriblControlPlane({
 });
 
 async function main() {
-  const result = await criblControlPlane.listSource();
+  const result = await criblControlPlane.createCriblLakeDatasetByLakeId({
+    lakeId: "<id>",
+    criblLakeDataset: {
+      id: "<id>",
+    },
+  });
 
   console.log(result);
 }

package/examples/package-lock.json

@@ -18,7 +18,7 @@
     },
     "..": {
       "name": "cribl-control-plane",
-      "version": "0.0.21",
+      "version": "0.0.23",
       "devDependencies": {
         "@eslint/js": "^9.19.0",
         "@types/node": "^18.19.3",

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "cribl-control-plane",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cribl-control-plane",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {

package/src/__tests__/distributed.test.ts

@@ -0,0 +1,23 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { CriblControlPlane } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Distributed Get Summary", async () => {
+  const testHttpClient = createTestHTTPClient("getSummary");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.distributed.getSummary();
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});

package/src/__tests__/groups.test.ts

@@ -0,0 +1,122 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { CriblControlPlane } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Groups Get Groups Config Version By Id", async () => {
+  const testHttpClient = createTestHTTPClient("getGroupsConfigVersionById");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.groups.getGroupsConfigVersionById({
+    id: "<id>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Groups Create Products Groups By Product", async () => {
+  const testHttpClient = createTestHTTPClient("createProductsGroupsByProduct");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.groups.createProductsGroupsByProduct({
+    product: "stream",
+    configGroup: {
+      configVersion: "<value>",
+      id: "<id>",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Groups Get Products Groups By Product", async () => {
+  const testHttpClient = createTestHTTPClient("getProductsGroupsByProduct");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.groups.getProductsGroupsByProduct({
+    product: "stream",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Groups Update Groups Deploy By Id", async () => {
+  const testHttpClient = createTestHTTPClient("updateGroupsDeployById");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.groups.updateGroupsDeployById({
+    id: "<id>",
+    deployRequest: {
+      version: "<value>",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Groups Get Groups By Id", async () => {
+  const testHttpClient = createTestHTTPClient("getGroupsById");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.groups.getGroupsById({
+    id: "<id>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Groups Get Groups Acl By Id", async () => {
+  const testHttpClient = createTestHTTPClient("getGroupsAclById");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.groups.getGroupsAclById({
+    id: "<id>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});

package/src/__tests__/lake.test.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { CriblControlPlane } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Lake Create Cribl Lake Dataset By Lake Id", async () => {
+  const testHttpClient = createTestHTTPClient("createCriblLakeDatasetByLakeId");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.lake.createCriblLakeDatasetByLakeId({
+    lakeId: "<id>",
+    criblLakeDataset: {
+      id: "<id>",
+    },
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Lake Get Cribl Lake Dataset By Lake Id", async () => {
+  const testHttpClient = createTestHTTPClient("getCriblLakeDatasetByLakeId");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.lake.getCriblLakeDatasetByLakeId({
+    lakeId: "<id>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});

package/src/__tests__/packs.test.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { CriblControlPlane } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Packs Create Packs", async () => {
+  const testHttpClient = createTestHTTPClient("createPacks");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.packs.createPacks({
+    id: "<id>",
+    source: "<value>",
+  });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Packs Get Packs", async () => {
+  const testHttpClient = createTestHTTPClient("getPacks");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.packs.getPacks();
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Packs Update Packs", async () => {
+  const testHttpClient = createTestHTTPClient("updatePacks");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.packs.updatePacks();
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});

package/src/__tests__/teams.test.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { CriblControlPlane } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Teams Get Products Groups Acl Teams By Product And Id", async () => {
+  const testHttpClient = createTestHTTPClient(
+    "getProductsGroupsAclTeamsByProductAndId",
+  );
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.teams
+    .getProductsGroupsAclTeamsByProductAndId({
+      product: "stream",
+      id: "<id>",
+    });
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});

package/src/__tests__/workers.test.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { expect, test } from "vitest";
+import { CriblControlPlane } from "../index.js";
+import { createTestHTTPClient } from "./testclient.js";
+
+test("Workers Get Summary Workers", async () => {
+  const testHttpClient = createTestHTTPClient("getSummaryWorkers");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.workers.getSummaryWorkers();
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Workers Get Workers", async () => {
+  const testHttpClient = createTestHTTPClient("getWorkers");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.workers.getWorkers();
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});
+
+test("Workers Update Workers Restart", async () => {
+  const testHttpClient = createTestHTTPClient("updateWorkersRestart");
+
+  const criblControlPlane = new CriblControlPlane({
+    serverURL: process.env["TEST_SERVER_URL"] ?? "http://localhost:18080",
+    httpClient: testHttpClient,
+    security: {
+      bearerAuth: process.env["CRIBLCONTROLPLANE_BEARER_AUTH"] ?? "value",
+    },
+  });
+
+  const result = await criblControlPlane.workers.updateWorkersRestart();
+  expect(result).toBeDefined();
+  expect(result).toEqual({});
+});