cribl-control-plane 0.4.0 → 0.5.0-alpha.1

package/dist/esm/models/runnablejobscheduledsearch.d.ts

@@ -32,24 +32,24 @@ export type RunnableJobScheduledSearchRunSettings = {
     /**
      * Reschedule tasks that failed with non-fatal errors
      */
-    rescheduleDroppedTasks?: boolean | undefined;
+    rescheduleDroppedTasks: boolean;
     /**
      * Maximum number of times a task can be rescheduled
      */
-    maxTaskReschedule?: number | undefined;
+    maxTaskReschedule: number;
     /**
      * Level at which to set task logging
      */
-    logLevel?: RunnableJobScheduledSearchLogLevel | undefined;
+    logLevel: RunnableJobScheduledSearchLogLevel;
     /**
      * Maximum time the job is allowed to run. Time unit defaults to seconds if not specified (examples: 30, 45s, 15m). Enter 0 for unlimited time.
      */
-    jobTimeout?: string | undefined;
+    jobTimeout: string;
     /**
      * Job run mode. Preview will either return up to N matching results, or will run until capture time T is reached. Discovery will gather the list of files to turn into streaming tasks, without running the data collection job. Full Run will run the collection job.
      */
-    mode?: string | undefined;
-    timeRangeType?: string | undefined;
+    mode: string;
+    timeRangeType: string;
     /**
      * Earliest time to collect data for the selected timezone
      */
@@ -63,7 +63,7 @@ export type RunnableJobScheduledSearchRunSettings = {
     /**
      * A filter for tokens in the provided collect path and/or the events being collected
      */
-    expression?: string | undefined;
+    expression: string;
     /**
      * Limits the bundle size for small tasks. For example,
      *
@@ -71,7 +71,7 @@ export type RunnableJobScheduledSearchRunSettings = {
      *
      *         if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
      */
-    minTaskSize?: string | undefined;
+    minTaskSize: string;
     /**
      * Limits the bundle size for files above the lower task bundle size. For example, if your upper bundle size is 10MB,
      *
@@ -79,7 +79,7 @@ export type RunnableJobScheduledSearchRunSettings = {
      *
      *         you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
      */
-    maxTaskSize?: string | undefined;
+    maxTaskSize: string;
 };
 /**
  * Configuration for a scheduled job
@@ -92,19 +92,19 @@ export type RunnableJobScheduledSearchSchedule = {
     /**
      * Skippable jobs can be delayed, up to their next run time, if the system is hitting concurrency limits
      */
-    skippable?: boolean | undefined;
+    skippable: boolean;
     /**
      * If Stream Leader (or single instance) restarts, run all missed jobs according to their original schedules
      */
-    resumeMissed?: boolean | undefined;
+    resumeMissed: boolean;
     /**
      * A cron schedule on which to run this job
      */
-    cronSchedule?: string | undefined;
+    cronSchedule: string;
     /**
      * The maximum number of instances of this scheduled job that may be running at any time
      */
-    maxConcurrentRuns?: number | undefined;
+    maxConcurrentRuns: number;
     run?: RunnableJobScheduledSearchRunSettings | undefined;
 };
 export type RunnableJobScheduledSearch = {
@@ -117,11 +117,11 @@ export type RunnableJobScheduledSearch = {
     /**
      * Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector.
      */
-    ttl?: string | undefined;
+    ttl: string;
     /**
      * When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live.
      */
-    ignoreGroupJobsLimit?: boolean | undefined;
+    ignoreGroupJobsLimit: boolean;
     /**
      * List of fields to remove from Discover results. Wildcards (for example, aws*) are allowed. This is useful when discovery returns sensitive fields that should not be exposed in the Jobs user interface.
      */
@@ -129,7 +129,7 @@ export type RunnableJobScheduledSearch = {
     /**
      * Resume the ad hoc job if a failure condition causes Stream to restart during job execution
      */
-    resumeOnBoot?: boolean | undefined;
+    resumeOnBoot: boolean;
     /**
      * Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere.
      */

package/dist/esm/models/runnablejobscheduledsearch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"runnablejobscheduledsearch.d.ts","sourceRoot":"","sources":["../../../src/models/runnablejobscheduledsearch.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,eAAO,MAAM,iCAAiC;;;;CAIpC,CAAC;AACX,MAAM,MAAM,iCAAiC,GAAG,QAAQ,CACtD,OAAO,iCAAiC,CACzC,CAAC;AAEF,eAAO,MAAM,8BAA8B;;CAEjC,CAAC;AACX,MAAM,MAAM,8BAA8B,GAAG,UAAU,CACrD,OAAO,8BAA8B,CACtC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;CAMrC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,UAAU,CACzD,OAAO,kCAAkC,CAC1C,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,EAAE,CAAC;AAEvD,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAC;IAClD;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC7C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,EAAE,kCAAkC,GAAG,SAAS,CAAC;IAC1D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,iBAAiB,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IACpC,WAAW,CAAC,EAAE,qCAAqC,GAAG,SAAS,CAAC;IAChE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAChC;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,GAAG,CAAC,EAAE,qCAAqC,GAAG,SAAS,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,EAAE,iCAAiC,CAAC;IACxC;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC3C;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACnC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,kCAAkC,GAAG,SAAS,CAAC;IAC1D;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+CAA+C,EAAE,CAAC,CAAC,OAAO,CACrE,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,OAAO,CACqD,CAAC;AAE/D,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,aAAa,CACxE,OAAO,8BAA8B,CACS,CAAC;AAEjD,gBAAgB;AAChB,eAAO,MAAM,gDAAgD,EAAE,CAAC,CAAC,aAAa,CAC5E,OAAO,kCAAkC,CACS,CAAC;AAErD,gBAAgB;AAChB,eAAO,MAAM,mDAAmD,EAAE,CAAC,CAAC,OAAO,CACzE,qCAAqC,EACrC,CAAC,CAAC,UAAU,EACZ,OAAO,CACO,CAAC;AAEjB,wBAAgB,6CAA6C,CAC3D,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qCAAqC,EAAE,kBAAkB,CAAC,CAO5E;AAED,gBAAgB;AAChB,eAAO,MAAM,mDAAmD,EAAE,CAAC,CAAC,OAAO,CACzE,qCAAqC,EACrC,CAAC,CAAC,UAAU,EACZ,OAAO,CAiBP,CAAC;AAEH,wBAAgB,6CAA6C,CAC3D,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qCAAqC,EAAE,kBAAkB,CAAC,CAO5E;AAED,gBAAgB;AAChB,eAAO,MAAM,gDAAgD,EAAE,CAAC,CAAC,OAAO,CACtE,kCAAkC,EAClC,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,wBAAgB,0CAA0C,CACxD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kCAAkC,EAAE,kBAAkB,CAAC,CAOzE;AAED,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,0BAA0B,EAAE,kBAAkB,CAAC,CAMjE"}
+{"version":3,"file":"runnablejobscheduledsearch.d.ts","sourceRoot":"","sources":["../../../src/models/runnablejobscheduledsearch.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,QAAQ,CAAC;AAG5B,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,eAAO,MAAM,iCAAiC;;;;CAIpC,CAAC;AACX,MAAM,MAAM,iCAAiC,GAAG,QAAQ,CACtD,OAAO,iCAAiC,CACzC,CAAC;AAEF,eAAO,MAAM,8BAA8B;;CAEjC,CAAC;AACX,MAAM,MAAM,8BAA8B,GAAG,UAAU,CACrD,OAAO,8BAA8B,CACtC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,kCAAkC;;;;;;CAMrC,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG,UAAU,CACzD,OAAO,kCAAkC,CAC1C,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,EAAE,CAAC;AAEvD,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,CAAC,EAAE,8BAA8B,GAAG,SAAS,CAAC;IAClD;;OAEG;IACH,sBAAsB,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,kCAAkC,CAAC;IAC7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,iBAAiB,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IACpC,WAAW,CAAC,EAAE,qCAAqC,GAAG,SAAS,CAAC;IAChE;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B,GAAG,CAAC,EAAE,qCAAqC,GAAG,SAAS,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,IAAI,EAAE,iCAAiC,CAAC;IACxC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACzC;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC;;OAEG;IACH,QAAQ,CAAC,EAAE,kCAAkC,GAAG,SAAS,CAAC;IAC1D;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;IACvC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,+CAA+C,EAAE,CAAC,CAAC,OAAO,CACrE,iCAAiC,EACjC,CAAC,CAAC,UAAU,EACZ,OAAO,CACqD,CAAC;AAE/D,gBAAgB;AAChB,eAAO,MAAM,4CAA4C,EAAE,CAAC,CAAC,aAAa,CACxE,OAAO,8BAA8B,CACS,CAAC;AAEjD,gBAAgB;AAChB,eAAO,MAAM,gDAAgD,EAAE,CAAC,CAAC,aAAa,CAC5E,OAAO,kCAAkC,CACS,CAAC;AAErD,gBAAgB;AAChB,eAAO,MAAM,mDAAmD,EAAE,CAAC,CAAC,OAAO,CACzE,qCAAqC,EACrC,CAAC,CAAC,UAAU,EACZ,OAAO,CACO,CAAC;AAEjB,wBAAgB,6CAA6C,CAC3D,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qCAAqC,EAAE,kBAAkB,CAAC,CAO5E;AAED,gBAAgB;AAChB,eAAO,MAAM,mDAAmD,EAAE,CAAC,CAAC,OAAO,CACzE,qCAAqC,EACrC,CAAC,CAAC,UAAU,EACZ,OAAO,CAiBP,CAAC;AAEH,wBAAgB,6CAA6C,CAC3D,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,qCAAqC,EAAE,kBAAkB,CAAC,CAO5E;AAED,gBAAgB;AAChB,eAAO,MAAM,gDAAgD,EAAE,CAAC,CAAC,OAAO,CACtE,kCAAkC,EAClC,CAAC,CAAC,UAAU,EACZ,OAAO,CASP,CAAC;AAEH,wBAAgB,0CAA0C,CACxD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kCAAkC,EAAE,kBAAkB,CAAC,CAOzE;AAED,gBAAgB;AAChB,eAAO,MAAM,wCAAwC,EAAE,CAAC,CAAC,OAAO,CAC9D,0BAA0B,EAC1B,CAAC,CAAC,UAAU,EACZ,OAAO,CAcP,CAAC;AAEH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,0BAA0B,EAAE,kBAAkB,CAAC,CAMjE"}

package/examples/example-cloud-auth.ts

@@ -1,30 +1,30 @@
 /**
- * Cribl.Cloud and Hybrid Authentication Example
+ * Cribl.Cloud Authentication Example
  * 
- * This example demonstrates how to configure authentication on Cribl.Cloud
- * and in hybrid deployments using OAuth2 credentials.
+ * This example demonstrates the Cribl.Cloud authentication process using 
+ * OAuth2 credentials.
  * 
- * 1. Create an SDK client with OAuth2 client credentials using the 
- * clientOauth security scheme.
+ * 1. Create an SDK client with OAuth2 client credentials.
  * 2. Automatically handle token exchange and refresh.
- * 3. Validate the connection by listing all git branches.
+ * 3. Validate the connection by checking the server health status and listing 
+ * all git branches.
  * 
  * Prerequisites: Replace the placeholder values for ORG_ID, CLIENT_ID, 
  * CLIENT_SECRET, and WORKSPACE_NAME with your Organization ID, Client ID and 
- * Secret, and Workspace name. To get your Client ID and Secret, follow the 
- * steps at https://docs.cribl.io/cribl-as-code/sdks-auth/#sdks-auth-cloud. 
- * Your Client ID and Secret are sensitive information and should be kept private.
+ * Secret, and Workspace name. To get your CLIENT_ID and CLIENT_SECRET values, 
+ * follow the steps at https://docs.cribl.io/api/#criblcloud. Your Client ID 
+ * and Secret are sensitive information and should be kept private.
  * 
- * NOTE: This example is for Cribl.Cloud and hybrid deployments only. 
- * It does not require .env file configuration.
+ * NOTE: This example is for Cribl.Cloud deployments only. It does not require 
+ * .env file configuration.
  */
 
 import { CriblControlPlane } from "../dist/esm";
 
-// Cribl.Cloud and hybrid configuration: Replace the placeholder values
+// Cribl.Cloud configuration: Replace the placeholder values
+const ORG_ID = "your-org-id"; // Replace with your Organization ID
 const CLIENT_ID = "your-client-id"; // Replace with your OAuth2 Client ID
 const CLIENT_SECRET = "your-client-secret"; // Replace with your OAuth2 Client Secret
-const ORG_ID = "your-org-id"; // Replace with your Organization ID
 const WORKSPACE_NAME = "main"; // Replace with your Workspace name
 
 const baseUrl = `https://${WORKSPACE_NAME}-${ORG_ID}.cribl.cloud/api/v1`;

package/examples/example-cloud-search-packs-lake.ts

@@ -11,8 +11,8 @@
  * Prerequisites: Replace the placeholder values for ORG_ID, CLIENT_ID, 
  * CLIENT_SECRET, and WORKSPACE_NAME with your Organization ID, Client ID and 
  * Secret, and Workspace name. To get your CLIENT_ID and CLIENT_SECRET values, 
- * follow the steps at https://docs.cribl.io/cribl-as-code/authentication/#cloud-auth. 
- * Your Client ID and Secret are sensitive information and should be kept private.
+ * follow the steps at https://docs.cribl.io/api/#criblcloud. Your Client ID 
+ * and Secret are sensitive information and should be kept private.
  * 
  * NOTE: This example is for Cribl.Cloud deployments only. It does not require 
  * .env file configuration.

package/examples/example-cloud-worker-group.ts

@@ -19,14 +19,14 @@
  * Prerequisites: Replace the placeholder values for ORG_ID, CLIENT_ID, 
  * CLIENT_SECRET, and WORKSPACE_NAME with your Organization ID, Client ID and 
  * Secret, and Workspace name. To get your CLIENT_ID and CLIENT_SECRET values, 
- * follow the steps at https://docs.cribl.io/cribl-as-code/authentication/#cloud-auth. 
- * Your Client ID and Secret are sensitive information and should be kept private.
+ * follow the steps at https://docs.cribl.io/api/#criblcloud. Your Client ID 
+ * and Secret are sensitive information and should be kept private.
  * 
  * NOTE: This example is for Cribl.Cloud deployments only. It does not require 
  * .env file configuration.
  */
 
-import { ConfigGroup, GroupCreateRequest } from "../dist/esm/models";
+import { ConfigGroup } from "../dist/esm/models";
 import { AuthCloud } from "./auth";
 
 const ORG_ID = 'your-org-id';
@@ -68,7 +68,7 @@ async function main() {
   }
 
   // Create the Worker Group
-  await cribl.groups.create({ product: "stream", groupCreateRequest: group as GroupCreateRequest });
+  await cribl.groups.create({ product: "stream", groupCreateRequest: group });
   console.log(`✅ Worker Group created: ${group.id}`);
 
   // Scale and provision the Worker Group

package/examples/example-edge.ts

@@ -40,7 +40,6 @@ const AWS_REGION = "us-east-2"; // Replace with your S3 bucket region
 
 import {
   ConfigGroup,
-  GroupCreateRequest,
   InputSyslog,
   OutputS3,
   Pipeline,
@@ -122,7 +121,7 @@ async function main() {
   }
 
   // Create Fleet
-  await cribl.groups.create({ product: "edge", groupCreateRequest: myFleet as GroupCreateRequest });
+  await cribl.groups.create({ product: "edge", groupCreateRequest: myFleet });
   console.log(`✅ Fleet created: ${myFleet.id}`);
 
   // Create Syslog Source

package/examples/example-onprem-auth.ts

@@ -1,13 +1,13 @@
 /**
  * On-Prem Authentication Example
  * 
- * This example demonstrates how to configure authentication for an on-prem 
- * Cribl instance using username and password credentials.
+ * This example demonstrates the authentication process for an on-prem Cribl 
+ * instance using username and password credentials.
  * 
- * 1. Create an SDK client with username and password credentials using the 
- * bearerAuth security scheme.
- * 2. Automatically handle token exchange and refresh using a callback function.
- * 3. Validate the connection by listing all git branches.
+ * 1. Authenticate with your username and password to obtain a Bearer token.
+ * 2. Create an SDK client that uses the Bearer token for API calls.
+ * 3. Validate the connection by checking the server health status and listing 
+ * all git branches.
  * 
  * Prerequisites: Replace the placeholder values for ONPREM_SERVER_URL 
  * ONPREM_USERNAME, and ONPREM_PASSWORD with your server URL and credentials. 
@@ -21,69 +21,32 @@ import { CriblControlPlane } from "../dist/esm";
 
 // On-prem configuration: Replace the placeholder values
 const ONPREM_SERVER_URL: string = "http://localhost:9000";  // Replace with your server URL
-const ONPREM_USERNAME: string = "admin"; // Replace with your username
-const ONPREM_PASSWORD: string = "admin"; // Replace with your password
+const ONPREM_USERNAME: string = "admin" // Replace with your username
+const ONPREM_PASSWORD: string = "admin" // Replace with your password
 
 const BASE_URL: string = `${ONPREM_SERVER_URL}/api/v1`;
 
-// Token cache
-let _cachedToken: string | null = null;
-let _tokenExpiresAt: Date | null = null;
-
-function _getJwtExp(token: string): Date {
-  const payloadB64 = token.split(".")[1];
-  const padding = "=".repeat((4 - (payloadB64.length % 4)) % 4);
-  const payload = JSON.parse(atob(payloadB64 + padding));
-  const exp = payload.exp;
-  if (exp === undefined) {
-    throw new Error("Token missing 'exp' field");
-  }
-  return new Date(exp * 1000);
-}
-
 async function main() {
-  // Create client for retrieving Bearer token
-  const client = new CriblControlPlane({ serverURL: BASE_URL });
-
-  const callback = async () => {
-    // Check cache
-    const now = new Date();
-    if (
-      _cachedToken &&
-      _tokenExpiresAt &&
-      now.getTime() + 3000 < _tokenExpiresAt.getTime()
-    ) {
-      return { bearerAuth: _cachedToken };
-    }
-
-    // Retrieve Bearer token initially and refresh automatically when it expires
-    const response = await client.auth.tokens.get({
-      username: ONPREM_USERNAME,
-      password: ONPREM_PASSWORD,
-    });
-    const token = response.token;
-    _tokenExpiresAt = _getJwtExp(token);
-    _cachedToken = token;
-    return { bearerAuth: token };
-  };
+  // Retrieve Bearer token for authentication
+  let client = new CriblControlPlane({ serverURL: BASE_URL });
+  const { token } = await client.auth.tokens.get({
+    username: ONPREM_USERNAME,
+    password: ONPREM_PASSWORD,
+  });
+  console.log(`✅ Authenticated with on-prem server. Token: ${token}`);
 
   // Create authenticated SDK client
-  const authenticatedClient = new CriblControlPlane({
-    serverURL: BASE_URL,
-    security: callback,
-  });
-  console.log(`✅ Authenticated SDK client created for on-prem server`);
+  client = new CriblControlPlane({ serverURL: BASE_URL, security: { bearerAuth: token }});
+  console.log(`✅ Cribl SDK client created for on-prem server`);
 
   // Validate connection and list all git branches
-  const response = await authenticatedClient.versions.branches.list();
-  const branches = response.items?.map((branch: any) => branch.id).join("\n\t");
+  const response = await client.versions.branches.list();
+  const branches = response.items?.map(branch => branch.id).join("\n\t");
   console.log(`✅ Client works! Your list of branches:\n\t${branches}`);
 }
 
 main().catch((error) => {
-  if (error.statusCode === 401) {
-    console.log("⚠️ Authentication failed! Check your USERNAME and PASSWORD.");
-  } else if (error.statusCode === 429) {
+  if (error.statusCode === 429) {
     console.log("⚠️ Uh oh, you've reached the rate limit! Try again in a few seconds.");
   } else {
     console.error("❌ Something went wrong: ", error);

package/examples/example-stream.ts

@@ -28,7 +28,6 @@
 
 import {
   ConfigGroup,
-  GroupCreateRequest,
   InputTcpjson,
   OutputFilesystem,
   Pipeline,
@@ -108,7 +107,7 @@ async function main() {
   }
 
   // Create Worker Group
-  await cribl.groups.create({ product: "stream", groupCreateRequest: myWorkerGroup as GroupCreateRequest });
+  await cribl.groups.create({ product: "stream", groupCreateRequest: myWorkerGroup });
   console.log(`✅ Worker Group created: ${myWorkerGroup.id}`);
 
   // Create TCP JSON Source

package/examples/example-worker-group-replication.ts

@@ -22,7 +22,6 @@
  * - API Bearer token with Permissions that include creating Worker Groups.
  */
 
-import { GroupCreateRequest } from "../dist/esm/models";
 import { createCriblClient, CriblControlPlane } from './auth';
 
 /**
@@ -101,7 +100,7 @@ async function replicateWorkerGroup(client: CriblControlPlane, sourceId: string)
         id: replicaId,
         name: replicaName,
         description: `Replica of '${sourceId}'`
-      } as GroupCreateRequest
+      }
     };
 
     // Create the replica Worker Group by copying the configuration of the source Worker Group

package/examples/package-lock.json

@@ -19,7 +19,7 @@
     },
     "..": {
       "name": "cribl-control-plane",
-      "version": "0.4.0",
+      "version": "0.5.0-alpha.1",
       "dependencies": {
         "zod": "^3.25.0 || ^4.0.0"
       },

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "cribl-control-plane",
-  "version": "0.4.0",
+  "version": "0.5.0-alpha.1",
   "exports": {
     ".": "./src/index.ts",    
     "./models/errors": "./src/models/errors/index.ts",    

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cribl-control-plane",
-  "version": "0.4.0",
+  "version": "0.5.0-alpha.1",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {

package/src/lib/config.ts

@@ -61,9 +61,9 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "4.15.1-1b453caa",
-  sdkVersion: "0.4.0",
-  genVersion: "2.778.0",
+  openapiDocVersion: "4.15.1-alpha.1765407756960-5c02a009",
+  sdkVersion: "0.5.0-alpha.1",
+  genVersion: "2.791.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.4.0 2.778.0 4.15.1-1b453caa cribl-control-plane",
+    "speakeasy-sdk/typescript 0.5.0-alpha.1 2.791.1 4.15.1-alpha.1765407756960-5c02a009 cribl-control-plane",
 } as const;

package/src/models/runnablejobcollection.ts

@@ -49,24 +49,24 @@ export type RunnableJobCollectionRunSettings = {
   /**
    * Reschedule tasks that failed with non-fatal errors
    */
-  rescheduleDroppedTasks?: boolean | undefined;
+  rescheduleDroppedTasks: boolean;
   /**
    * Maximum number of times a task can be rescheduled
    */
-  maxTaskReschedule?: number | undefined;
+  maxTaskReschedule: number;
   /**
    * Level at which to set task logging
    */
-  logLevel?: RunnableJobCollectionScheduleLogLevel | undefined;
+  logLevel: RunnableJobCollectionScheduleLogLevel;
   /**
    * Maximum time the job is allowed to run. Time unit defaults to seconds if not specified (examples: 30, 45s, 15m). Enter 0 for unlimited time.
    */
-  jobTimeout?: string | undefined;
+  jobTimeout: string;
   /**
    * Job run mode. Preview will either return up to N matching results, or will run until capture time T is reached. Discovery will gather the list of files to turn into streaming tasks, without running the data collection job. Full Run will run the collection job.
    */
-  mode?: string | undefined;
-  timeRangeType?: string | undefined;
+  mode: string;
+  timeRangeType: string;
   /**
    * Earliest time to collect data for the selected timezone
    */
@@ -80,7 +80,7 @@ export type RunnableJobCollectionRunSettings = {
   /**
    * A filter for tokens in the provided collect path and/or the events being collected
    */
-  expression?: string | undefined;
+  expression: string;
   /**
    * Limits the bundle size for small tasks. For example,
    *
@@ -88,7 +88,7 @@ export type RunnableJobCollectionRunSettings = {
    *
    *         if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
    */
-  minTaskSize?: string | undefined;
+  minTaskSize: string;
   /**
    * Limits the bundle size for files above the lower task bundle size. For example, if your upper bundle size is 10MB,
    *
@@ -96,7 +96,7 @@ export type RunnableJobCollectionRunSettings = {
    *
    *         you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
    */
-  maxTaskSize?: string | undefined;
+  maxTaskSize: string;
 };
 
 /**
@@ -110,19 +110,19 @@ export type RunnableJobCollectionSchedule = {
   /**
    * Skippable jobs can be delayed, up to their next run time, if the system is hitting concurrency limits
    */
-  skippable?: boolean | undefined;
+  skippable: boolean;
   /**
    * If Stream Leader (or single instance) restarts, run all missed jobs according to their original schedules
    */
-  resumeMissed?: boolean | undefined;
+  resumeMissed: boolean;
   /**
    * A cron schedule on which to run this job
    */
-  cronSchedule?: string | undefined;
+  cronSchedule: string;
   /**
    * The maximum number of instances of this scheduled job that may be running at any time
    */
-  maxConcurrentRuns?: number | undefined;
+  maxConcurrentRuns: number;
   run?: RunnableJobCollectionRunSettings | undefined;
 };
 
@@ -137,7 +137,7 @@ export type Collector = {
   /**
    * Delete any files collected (where applicable)
    */
-  destructive?: boolean | undefined;
+  destructive: boolean;
   /**
    * Character encoding to use when parsing ingested data. When not set, @{product} will default to UTF-8 but may incorrectly interpret multi-byte characters.
    */
@@ -150,7 +150,7 @@ export const InputType = {
 export type InputType = OpenEnum<typeof InputType>;
 
 export type RunnableJobCollectionPreprocess = {
-  disabled?: boolean | undefined;
+  disabled: boolean;
   /**
    * Command to feed the data through (via stdin) and process its output (stdout)
    */
@@ -170,7 +170,7 @@ export type RunnableJobCollectionMetadatum = {
 };
 
 export type RunnableJobCollectionInput = {
-  type?: InputType | undefined;
+  type: InputType;
   /**
    * A list of event-breaking rulesets that will be applied, in order, to the input data stream
    */
@@ -178,16 +178,16 @@ export type RunnableJobCollectionInput = {
   /**
    * How long (in milliseconds) the Event Breaker will wait for new data to be sent to a specific channel before flushing the data stream out, as is, to the Pipelines
    */
-  staleChannelFlushMs?: number | undefined;
+  staleChannelFlushMs: number;
   /**
    * Send events to normal routing and event processing. Disable to select a specific Pipeline/Destination combination.
    */
-  sendToRoutes?: boolean | undefined;
+  sendToRoutes: boolean;
   preprocess?: RunnableJobCollectionPreprocess | undefined;
   /**
    * Rate (in bytes per second) to throttle while writing to an output. Accepts values with multiple-byte units, such as KB, MB, and GB. (Example: 42 MB) Default value of 0 specifies no throttling.
    */
-  throttleRatePerSec?: string | undefined;
+  throttleRatePerSec: string;
   /**
    * Fields to add to events from this input
    */
@@ -266,36 +266,36 @@ export type CaptureSettings = {
   /**
    * Amount of time to keep capture open, in seconds
    */
-  duration?: number | undefined;
+  duration: number;
   /**
    * Maximum number of events to capture
    */
-  maxEvents?: number | undefined;
-  level?: WhereToCapture | undefined;
+  maxEvents: number;
+  level: WhereToCapture;
 };
 
 export type RunnableJobCollectionRun = {
   /**
    * Reschedule tasks that failed with non-fatal errors
    */
-  rescheduleDroppedTasks?: boolean | undefined;
+  rescheduleDroppedTasks: boolean;
   /**
    * Maximum number of times a task can be rescheduled
    */
-  maxTaskReschedule?: number | undefined;
+  maxTaskReschedule: number;
   /**
    * Level at which to set task logging
    */
-  logLevel?: RunnableJobCollectionLogLevel | undefined;
+  logLevel: RunnableJobCollectionLogLevel;
   /**
    * Maximum time the job is allowed to run. Time unit defaults to seconds if not specified (examples: 30, 45s, 15m). Enter 0 for unlimited time.
    */
-  jobTimeout?: string | undefined;
+  jobTimeout: string;
   /**
    * Job run mode. Preview will either return up to N matching results, or will run until capture time T is reached. Discovery will gather the list of files to turn into streaming tasks, without running the data collection job. Full Run will run the collection job.
    */
-  mode?: RunnableJobCollectionMode | undefined;
-  timeRangeType?: TimeRange | undefined;
+  mode: RunnableJobCollectionMode;
+  timeRangeType: TimeRange;
   /**
    * Earliest time to collect data for the selected timezone
    */
@@ -307,12 +307,12 @@ export type RunnableJobCollectionRun = {
   /**
    * Timezone to use for Earliest and Latest times
    */
-  timestampTimezone?: string | undefined;
+  timestampTimezone: string;
   timeWarning?: RunnableJobCollectionTimeWarning | undefined;
   /**
    * A filter for tokens in the provided collect path and/or the events being collected
    */
-  expression?: string | undefined;
+  expression: string;
   /**
    * Limits the bundle size for small tasks. For example,
    *
@@ -320,7 +320,7 @@ export type RunnableJobCollectionRun = {
    *
    *         if your lower bundle size is 1MB, you can bundle up to five 200KB files into one task.
    */
-  minTaskSize?: string | undefined;
+  minTaskSize: string;
   /**
    * Limits the bundle size for files above the lower task bundle size. For example, if your upper bundle size is 10MB,
    *
@@ -328,11 +328,11 @@ export type RunnableJobCollectionRun = {
    *
    *         you can bundle up to five 2MB files into one task. Files greater than this size will be assigned to individual tasks.
    */
-  maxTaskSize?: string | undefined;
+  maxTaskSize: string;
   /**
    * Send discover results to Routes
    */
-  discoverToRoutes?: boolean | undefined;
+  discoverToRoutes: boolean;
   capture?: CaptureSettings | undefined;
 };
 
@@ -346,11 +346,11 @@ export type RunnableJobCollection = {
   /**
    * Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector.
    */
-  ttl?: string | undefined;
+  ttl: string;
   /**
    * When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live.
    */
-  ignoreGroupJobsLimit?: boolean | undefined;
+  ignoreGroupJobsLimit: boolean;
   /**
    * List of fields to remove from Discover results. Wildcards (for example, aws*) are allowed. This is useful when discovery returns sensitive fields that should not be exposed in the Jobs user interface.
    */
@@ -358,7 +358,7 @@ export type RunnableJobCollection = {
   /**
    * Resume the ad hoc job if a failure condition causes Stream to restart during job execution
    */
-  resumeOnBoot?: boolean | undefined;
+  resumeOnBoot: boolean;
   /**
    * Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere.
    */
@@ -374,7 +374,7 @@ export type RunnableJobCollection = {
   /**
    * If enabled, tasks are created and run by the same Worker Node
    */
-  workerAffinity?: boolean | undefined;
+  workerAffinity: boolean;
   collector: Collector;
   input?: RunnableJobCollectionInput | undefined;
   run: RunnableJobCollectionRun;