cribl-control-plane 0.0.57 → 0.0.59

package/README.md

@@ -1,9 +1,18 @@
 # cribl-control-plane-sdk-typescript
-<!-- Start Summary [summary] -->
-## Summary
 
-Cribl API Reference: This API Reference lists available REST endpoints, along with their supported operations for accessing, creating, updating, or deleting resources. See our complementary product documentation at [docs.cribl.io](http://docs.cribl.io).
-<!-- End Summary [summary] -->
+The Cribl TypeScript SDK for the control plane provides operational control over Cribl resources and helps streamline the process of integrating with Cribl.
+
+In addition to the usage examples in this repository, you can adapt the [code examples for common use cases](https://docs.cribl.io/cribl-as-code/code-examples) in the Cribl documentation to use TypeScript instead of Python.
+
+Complementary API reference documentation is available at https://docs.cribl.io/cribl-as-code/api-reference. Product documentation is available at https://docs.cribl.io.
+
+> [!IMPORTANT]
+> **Preview Feature**
+> The Cribl SDKs are Preview features that are still being developed. We do not recommend using them in a production environment, because the features might not be fully tested or optimized for performance, and related documentation could be incomplete.
+>
+> Please continue to submit feedback through normal Cribl support channels, but assistance might be limited while the features remain in Preview.
+
+<!-- No Summary [summary] -->
 
 <!-- Start Table of Contents [toc] -->
 ## Table of Contents

package/dist/commonjs/lib/config.d.ts

@@ -35,8 +35,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "4.14.0-837595d5";
-    readonly sdkVersion: "0.0.57";
+    readonly sdkVersion: "0.0.59";
     readonly genVersion: "2.721.0";
-    readonly userAgent: "speakeasy-sdk/typescript 0.0.57 2.721.0 4.14.0-837595d5 cribl-control-plane";
+    readonly userAgent: "speakeasy-sdk/typescript 0.0.59 2.721.0 4.14.0-837595d5 cribl-control-plane";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/commonjs/lib/config.js

@@ -28,8 +28,8 @@ function serverURLFromOptions(options) {
 exports.SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "4.14.0-837595d5",
-    sdkVersion: "0.0.57",
+    sdkVersion: "0.0.59",
     genVersion: "2.721.0",
-    userAgent: "speakeasy-sdk/typescript 0.0.57 2.721.0 4.14.0-837595d5 cribl-control-plane",
+    userAgent: "speakeasy-sdk/typescript 0.0.59 2.721.0 4.14.0-837595d5 cribl-control-plane",
 };
 //# sourceMappingURL=config.js.map

package/dist/esm/lib/config.d.ts

@@ -35,8 +35,8 @@ export declare function serverURLFromOptions(options: SDKOptions): URL | null;
 export declare const SDK_METADATA: {
     readonly language: "typescript";
     readonly openapiDocVersion: "4.14.0-837595d5";
-    readonly sdkVersion: "0.0.57";
+    readonly sdkVersion: "0.0.59";
     readonly genVersion: "2.721.0";
-    readonly userAgent: "speakeasy-sdk/typescript 0.0.57 2.721.0 4.14.0-837595d5 cribl-control-plane";
+    readonly userAgent: "speakeasy-sdk/typescript 0.0.59 2.721.0 4.14.0-837595d5 cribl-control-plane";
 };
 //# sourceMappingURL=config.d.ts.map

package/dist/esm/lib/config.js

@@ -24,8 +24,8 @@ export function serverURLFromOptions(options) {
 export const SDK_METADATA = {
     language: "typescript",
     openapiDocVersion: "4.14.0-837595d5",
-    sdkVersion: "0.0.57",
+    sdkVersion: "0.0.59",
     genVersion: "2.721.0",
-    userAgent: "speakeasy-sdk/typescript 0.0.57 2.721.0 4.14.0-837595d5 cribl-control-plane",
+    userAgent: "speakeasy-sdk/typescript 0.0.59 2.721.0 4.14.0-837595d5 cribl-control-plane",
 };
 //# sourceMappingURL=config.js.map

package/examples/example-cloud-auth.ts

@@ -12,8 +12,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/api/#criblcloud. Your Client ID 
- * and Secret are sensitive information and should be kept private.
+ * 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.
  * 
  * NOTE: This example is for Cribl.Cloud deployments only. It does not require 
  * .env file configuration.

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/api/#criblcloud. Your Client ID 
- * and Secret are sensitive information and should be kept private.
+ * 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.
  * 
  * NOTE: This example is for Cribl.Cloud deployments only. It does not require 
  * .env file configuration.

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

@@ -19,8 +19,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/api/#criblcloud. Your Client ID 
- * and Secret are sensitive information and should be kept private.
+ * 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.
  * 
  * NOTE: This example is for Cribl.Cloud deployments only. It does not require 
  * .env file configuration.

package/examples/package-lock.json

@@ -19,7 +19,7 @@
     },
     "..": {
       "name": "cribl-control-plane",
-      "version": "0.0.57",
+      "version": "0.0.59",
       "dependencies": {
         "zod": "^3.20.0"
       },

package/jsr.json

@@ -2,7 +2,7 @@
 
 {
   "name": "cribl-control-plane",
-  "version": "0.0.57",
+  "version": "0.0.59",
   "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.57",
+  "version": "0.0.59",
   "author": "Speakeasy",
   "type": "module",
   "tshy": {

package/src/lib/config.ts

@@ -62,8 +62,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "4.14.0-837595d5",
-  sdkVersion: "0.0.57",
+  sdkVersion: "0.0.59",
   genVersion: "2.721.0",
   userAgent:
-    "speakeasy-sdk/typescript 0.0.57 2.721.0 4.14.0-837595d5 cribl-control-plane",
+    "speakeasy-sdk/typescript 0.0.59 2.721.0 4.14.0-837595d5 cribl-control-plane",
 } as const;