cribl-control-plane 0.0.48 → 0.0.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/README.md +10 -10
  2. package/dist/commonjs/funcs/pipelinesCreate.d.ts +1 -1
  3. package/dist/commonjs/funcs/pipelinesCreate.js +1 -1
  4. package/dist/commonjs/funcs/pipelinesDelete.d.ts +1 -1
  5. package/dist/commonjs/funcs/pipelinesDelete.js +1 -1
  6. package/dist/commonjs/funcs/pipelinesGet.d.ts +2 -2
  7. package/dist/commonjs/funcs/pipelinesGet.js +2 -2
  8. package/dist/commonjs/funcs/pipelinesList.d.ts +1 -1
  9. package/dist/commonjs/funcs/pipelinesList.js +1 -1
  10. package/dist/commonjs/funcs/pipelinesUpdate.d.ts +1 -1
  11. package/dist/commonjs/funcs/pipelinesUpdate.js +1 -1
  12. package/dist/commonjs/funcs/routesAppend.d.ts +2 -2
  13. package/dist/commonjs/funcs/routesAppend.js +2 -2
  14. package/dist/commonjs/funcs/routesGet.d.ts +2 -2
  15. package/dist/commonjs/funcs/routesGet.js +2 -2
  16. package/dist/commonjs/funcs/routesList.d.ts +2 -2
  17. package/dist/commonjs/funcs/routesList.js +2 -2
  18. package/dist/commonjs/funcs/routesUpdate.d.ts +2 -2
  19. package/dist/commonjs/funcs/routesUpdate.js +2 -2
  20. package/dist/commonjs/lib/config.d.ts +3 -3
  21. package/dist/commonjs/lib/config.js +3 -3
  22. package/dist/commonjs/models/operations/createroutesappendbyid.d.ts +1 -1
  23. package/dist/commonjs/models/operations/createversionrevert.d.ts +1 -1
  24. package/dist/commonjs/models/operations/deletepipelinebyid.d.ts +1 -1
  25. package/dist/commonjs/models/operations/getpipelinebyid.d.ts +1 -1
  26. package/dist/commonjs/models/operations/getroutesbyid.d.ts +1 -1
  27. package/dist/commonjs/models/operations/updatepipelinebyid.d.ts +3 -3
  28. package/dist/commonjs/models/operations/updateroutesbyid.d.ts +1 -1
  29. package/dist/commonjs/models/outputgooglechronicle.d.ts +1 -1
  30. package/dist/commonjs/sdk/pipelines.d.ts +6 -6
  31. package/dist/commonjs/sdk/pipelines.js +6 -6
  32. package/dist/commonjs/sdk/routes.d.ts +8 -8
  33. package/dist/commonjs/sdk/routes.js +8 -8
  34. package/dist/esm/funcs/pipelinesCreate.d.ts +1 -1
  35. package/dist/esm/funcs/pipelinesCreate.js +1 -1
  36. package/dist/esm/funcs/pipelinesDelete.d.ts +1 -1
  37. package/dist/esm/funcs/pipelinesDelete.js +1 -1
  38. package/dist/esm/funcs/pipelinesGet.d.ts +2 -2
  39. package/dist/esm/funcs/pipelinesGet.js +2 -2
  40. package/dist/esm/funcs/pipelinesList.d.ts +1 -1
  41. package/dist/esm/funcs/pipelinesList.js +1 -1
  42. package/dist/esm/funcs/pipelinesUpdate.d.ts +1 -1
  43. package/dist/esm/funcs/pipelinesUpdate.js +1 -1
  44. package/dist/esm/funcs/routesAppend.d.ts +2 -2
  45. package/dist/esm/funcs/routesAppend.js +2 -2
  46. package/dist/esm/funcs/routesGet.d.ts +2 -2
  47. package/dist/esm/funcs/routesGet.js +2 -2
  48. package/dist/esm/funcs/routesList.d.ts +2 -2
  49. package/dist/esm/funcs/routesList.js +2 -2
  50. package/dist/esm/funcs/routesUpdate.d.ts +2 -2
  51. package/dist/esm/funcs/routesUpdate.js +2 -2
  52. package/dist/esm/lib/config.d.ts +3 -3
  53. package/dist/esm/lib/config.js +3 -3
  54. package/dist/esm/models/operations/createroutesappendbyid.d.ts +1 -1
  55. package/dist/esm/models/operations/createversionrevert.d.ts +1 -1
  56. package/dist/esm/models/operations/deletepipelinebyid.d.ts +1 -1
  57. package/dist/esm/models/operations/getpipelinebyid.d.ts +1 -1
  58. package/dist/esm/models/operations/getroutesbyid.d.ts +1 -1
  59. package/dist/esm/models/operations/updatepipelinebyid.d.ts +3 -3
  60. package/dist/esm/models/operations/updateroutesbyid.d.ts +1 -1
  61. package/dist/esm/models/outputgooglechronicle.d.ts +1 -1
  62. package/dist/esm/sdk/pipelines.d.ts +6 -6
  63. package/dist/esm/sdk/pipelines.js +6 -6
  64. package/dist/esm/sdk/routes.d.ts +8 -8
  65. package/dist/esm/sdk/routes.js +8 -8
  66. package/docs/sdks/pipelines/README.md +6 -6
  67. package/docs/sdks/routes/README.md +8 -8
  68. package/examples/auth.ts +162 -0
  69. package/examples/example-edge.ts +150 -0
  70. package/examples/example-packs.ts +138 -0
  71. package/examples/example-stream.ts +149 -0
  72. package/examples/package-lock.json +1 -1
  73. package/jsr.json +1 -1
  74. package/package.json +1 -1
  75. package/src/funcs/pipelinesCreate.ts +1 -1
  76. package/src/funcs/pipelinesDelete.ts +1 -1
  77. package/src/funcs/pipelinesGet.ts +2 -2
  78. package/src/funcs/pipelinesList.ts +1 -1
  79. package/src/funcs/pipelinesUpdate.ts +1 -1
  80. package/src/funcs/routesAppend.ts +2 -2
  81. package/src/funcs/routesGet.ts +2 -2
  82. package/src/funcs/routesList.ts +2 -2
  83. package/src/funcs/routesUpdate.ts +2 -2
  84. package/src/lib/config.ts +3 -3
  85. package/src/models/operations/createroutesappendbyid.ts +1 -1
  86. package/src/models/operations/createversionrevert.ts +1 -1
  87. package/src/models/operations/deletepipelinebyid.ts +1 -1
  88. package/src/models/operations/getpipelinebyid.ts +1 -1
  89. package/src/models/operations/getroutesbyid.ts +1 -1
  90. package/src/models/operations/updatepipelinebyid.ts +3 -3
  91. package/src/models/operations/updateroutesbyid.ts +1 -1
  92. package/src/models/outputgooglechronicle.ts +1 -1
  93. package/src/sdk/pipelines.ts +6 -6
  94. package/src/sdk/routes.ts +8 -8
package/README.md CHANGED
@@ -310,16 +310,16 @@ run();
310
310
 
311
311
  * [list](docs/sdks/pipelines/README.md#list) - List all Pipelines
312
312
  * [create](docs/sdks/pipelines/README.md#create) - Create a Pipeline
313
- * [get](docs/sdks/pipelines/README.md#get) - Retrieve a Pipeline
313
+ * [get](docs/sdks/pipelines/README.md#get) - Get a Pipeline
314
314
  * [update](docs/sdks/pipelines/README.md#update) - Update a Pipeline
315
315
  * [delete](docs/sdks/pipelines/README.md#delete) - Delete a Pipeline
316
316
 
317
317
  ### [routes](docs/sdks/routes/README.md)
318
318
 
319
- * [list](docs/sdks/routes/README.md#list) - Get a list of Routes objects
320
- * [get](docs/sdks/routes/README.md#get) - Get Routes by ID
321
- * [update](docs/sdks/routes/README.md#update) - Update Routes
322
- * [append](docs/sdks/routes/README.md#append) - Append Routes to the end of the Routing table
319
+ * [list](docs/sdks/routes/README.md#list) - List all Routes
320
+ * [get](docs/sdks/routes/README.md#get) - Get a Routing table
321
+ * [update](docs/sdks/routes/README.md#update) - Update a Route
322
+ * [append](docs/sdks/routes/README.md#append) - Append a Route to the end of the Routing table
323
323
 
324
324
  ### [sources](docs/sdks/sources/README.md)
325
325
 
@@ -418,13 +418,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
418
418
  - [`packsUpdate`](docs/sdks/packs/README.md#update) - Upgrade a Pack
419
419
  - [`pipelinesCreate`](docs/sdks/pipelines/README.md#create) - Create a Pipeline
420
420
  - [`pipelinesDelete`](docs/sdks/pipelines/README.md#delete) - Delete a Pipeline
421
- - [`pipelinesGet`](docs/sdks/pipelines/README.md#get) - Retrieve a Pipeline
421
+ - [`pipelinesGet`](docs/sdks/pipelines/README.md#get) - Get a Pipeline
422
422
  - [`pipelinesList`](docs/sdks/pipelines/README.md#list) - List all Pipelines
423
423
  - [`pipelinesUpdate`](docs/sdks/pipelines/README.md#update) - Update a Pipeline
424
- - [`routesAppend`](docs/sdks/routes/README.md#append) - Append Routes to the end of the Routing table
425
- - [`routesGet`](docs/sdks/routes/README.md#get) - Get Routes by ID
426
- - [`routesList`](docs/sdks/routes/README.md#list) - Get a list of Routes objects
427
- - [`routesUpdate`](docs/sdks/routes/README.md#update) - Update Routes
424
+ - [`routesAppend`](docs/sdks/routes/README.md#append) - Append a Route to the end of the Routing table
425
+ - [`routesGet`](docs/sdks/routes/README.md#get) - Get a Routing table
426
+ - [`routesList`](docs/sdks/routes/README.md#list) - List all Routes
427
+ - [`routesUpdate`](docs/sdks/routes/README.md#update) - Update a Route
428
428
  - [`sourcesCreate`](docs/sdks/sources/README.md#create) - Create a Source
429
429
  - [`sourcesDelete`](docs/sdks/sources/README.md#delete) - Delete a Source
430
430
  - [`sourcesGet`](docs/sdks/sources/README.md#get) - Get a Source
@@ -13,7 +13,7 @@ import { Result } from "../types/fp.js";
13
13
  * Create a Pipeline
14
14
  *
15
15
  * @remarks
16
- * Create a Pipeline
16
+ * Create a new Pipeline.
17
17
  */
18
18
  export declare function pipelinesCreate(client: CriblControlPlaneCore, request: models.Pipeline, options?: RequestOptions): APIPromise<Result<operations.CreatePipelineResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
19
19
  //# sourceMappingURL=pipelinesCreate.d.ts.map
@@ -51,7 +51,7 @@ const async_js_1 = require("../types/async.js");
51
51
  * Create a Pipeline
52
52
  *
53
53
  * @remarks
54
- * Create a Pipeline
54
+ * Create a new Pipeline.
55
55
  */
56
56
  function pipelinesCreate(client, request, options) {
57
57
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Delete a Pipeline
13
13
  *
14
14
  * @remarks
15
- * Delete a Pipeline
15
+ * Delete the specified Pipeline.
16
16
  */
17
17
  export declare function pipelinesDelete(client: CriblControlPlaneCore, request: operations.DeletePipelineByIdRequest, options?: RequestOptions): APIPromise<Result<operations.DeletePipelineByIdResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=pipelinesDelete.d.ts.map
@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.js");
50
50
  * Delete a Pipeline
51
51
  *
52
52
  * @remarks
53
- * Delete a Pipeline
53
+ * Delete the specified Pipeline.
54
54
  */
55
55
  function pipelinesDelete(client, request, options) {
56
56
  return new async_js_1.APIPromise($do(client, request, options));
@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
9
9
  import { APIPromise } from "../types/async.js";
10
10
  import { Result } from "../types/fp.js";
11
11
  /**
12
- * Retrieve a Pipeline
12
+ * Get a Pipeline
13
13
  *
14
14
  * @remarks
15
- * Retrieve a Pipeline
15
+ * Get the specified Pipeline.
16
16
  */
17
17
  export declare function pipelinesGet(client: CriblControlPlaneCore, request: operations.GetPipelineByIdRequest, options?: RequestOptions): APIPromise<Result<operations.GetPipelineByIdResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=pipelinesGet.d.ts.map
@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Retrieve a Pipeline
50
+ * Get a Pipeline
51
51
  *
52
52
  * @remarks
53
- * Retrieve a Pipeline
53
+ * Get the specified Pipeline.
54
54
  */
55
55
  function pipelinesGet(client, request, options) {
56
56
  return new async_js_1.APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * List all Pipelines
13
13
  *
14
14
  * @remarks
15
- * List all Pipelines
15
+ * Get a list of all Pipelines.
16
16
  */
17
17
  export declare function pipelinesList(client: CriblControlPlaneCore, options?: RequestOptions): APIPromise<Result<operations.ListPipelineResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=pipelinesList.d.ts.map
@@ -48,7 +48,7 @@ const async_js_1 = require("../types/async.js");
48
48
  * List all Pipelines
49
49
  *
50
50
  * @remarks
51
- * List all Pipelines
51
+ * Get a list of all Pipelines.
52
52
  */
53
53
  function pipelinesList(client, options) {
54
54
  return new async_js_1.APIPromise($do(client, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Update a Pipeline
13
13
  *
14
14
  * @remarks
15
- * Update a Pipeline
15
+ * Update the specified Pipeline.</br></br>Provide a complete representation of the Pipeline that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Pipeline might not function as expected.
16
16
  */
17
17
  export declare function pipelinesUpdate(client: CriblControlPlaneCore, request: operations.UpdatePipelineByIdRequest, options?: RequestOptions): APIPromise<Result<operations.UpdatePipelineByIdResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=pipelinesUpdate.d.ts.map
@@ -50,7 +50,7 @@ const async_js_1 = require("../types/async.js");
50
50
  * Update a Pipeline
51
51
  *
52
52
  * @remarks
53
- * Update a Pipeline
53
+ * Update the specified Pipeline.</br></br>Provide a complete representation of the Pipeline that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Pipeline might not function as expected.
54
54
  */
55
55
  function pipelinesUpdate(client, request, options) {
56
56
  return new async_js_1.APIPromise($do(client, request, options));
@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
9
9
  import { APIPromise } from "../types/async.js";
10
10
  import { Result } from "../types/fp.js";
11
11
  /**
12
- * Append Routes to the end of the Routing table
12
+ * Append a Route to the end of the Routing table
13
13
  *
14
14
  * @remarks
15
- * Appends routes to the end of the routing table
15
+ * Append a Route to the end of the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to append, in the request body. Cribl removes any omitted Routes and fields in the Routing table when appending the Route.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
16
16
  */
17
17
  export declare function routesAppend(client: CriblControlPlaneCore, request: operations.CreateRoutesAppendByIdRequest, options?: RequestOptions): APIPromise<Result<operations.CreateRoutesAppendByIdResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=routesAppend.d.ts.map
@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Append Routes to the end of the Routing table
50
+ * Append a Route to the end of the Routing table
51
51
  *
52
52
  * @remarks
53
- * Appends routes to the end of the routing table
53
+ * Append a Route to the end of the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to append, in the request body. Cribl removes any omitted Routes and fields in the Routing table when appending the Route.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
54
54
  */
55
55
  function routesAppend(client, request, options) {
56
56
  return new async_js_1.APIPromise($do(client, request, options));
@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
9
9
  import { APIPromise } from "../types/async.js";
10
10
  import { Result } from "../types/fp.js";
11
11
  /**
12
- * Get Routes by ID
12
+ * Get a Routing table
13
13
  *
14
14
  * @remarks
15
- * Get Routes by ID
15
+ * Get the specified Routing table.
16
16
  */
17
17
  export declare function routesGet(client: CriblControlPlaneCore, request: operations.GetRoutesByIdRequest, options?: RequestOptions): APIPromise<Result<operations.GetRoutesByIdResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=routesGet.d.ts.map
@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Get Routes by ID
50
+ * Get a Routing table
51
51
  *
52
52
  * @remarks
53
- * Get Routes by ID
53
+ * Get the specified Routing table.
54
54
  */
55
55
  function routesGet(client, request, options) {
56
56
  return new async_js_1.APIPromise($do(client, request, options));
@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
9
9
  import { APIPromise } from "../types/async.js";
10
10
  import { Result } from "../types/fp.js";
11
11
  /**
12
- * Get a list of Routes objects
12
+ * List all Routes
13
13
  *
14
14
  * @remarks
15
- * Get a list of Routes objects
15
+ * Get a list of all Routes.
16
16
  */
17
17
  export declare function routesList(client: CriblControlPlaneCore, options?: RequestOptions): APIPromise<Result<operations.ListRoutesResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=routesList.d.ts.map
@@ -45,10 +45,10 @@ const errors = __importStar(require("../models/errors/index.js"));
45
45
  const operations = __importStar(require("../models/operations/index.js"));
46
46
  const async_js_1 = require("../types/async.js");
47
47
  /**
48
- * Get a list of Routes objects
48
+ * List all Routes
49
49
  *
50
50
  * @remarks
51
- * Get a list of Routes objects
51
+ * Get a list of all Routes.
52
52
  */
53
53
  function routesList(client, options) {
54
54
  return new async_js_1.APIPromise($do(client, options));
@@ -9,10 +9,10 @@ import * as operations from "../models/operations/index.js";
9
9
  import { APIPromise } from "../types/async.js";
10
10
  import { Result } from "../types/fp.js";
11
11
  /**
12
- * Update Routes
12
+ * Update a Route
13
13
  *
14
14
  * @remarks
15
- * Update Routes
15
+ * Update a Route in the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to update, in the request body. This endpoint does not support partial updates. Cribl removes any omitted Routes and fields when updating.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
16
16
  */
17
17
  export declare function routesUpdate(client: CriblControlPlaneCore, request: operations.UpdateRoutesByIdRequest, options?: RequestOptions): APIPromise<Result<operations.UpdateRoutesByIdResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=routesUpdate.d.ts.map
@@ -47,10 +47,10 @@ const errors = __importStar(require("../models/errors/index.js"));
47
47
  const operations = __importStar(require("../models/operations/index.js"));
48
48
  const async_js_1 = require("../types/async.js");
49
49
  /**
50
- * Update Routes
50
+ * Update a Route
51
51
  *
52
52
  * @remarks
53
- * Update Routes
53
+ * Update a Route in the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to update, in the request body. This endpoint does not support partial updates. Cribl removes any omitted Routes and fields when updating.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
54
54
  */
55
55
  function routesUpdate(client, request, options) {
56
56
  return new async_js_1.APIPromise($do(client, request, options));
@@ -34,9 +34,9 @@ export type SDKOptions = {
34
34
  export declare function serverURLFromOptions(options: SDKOptions): URL | null;
35
35
  export declare const SDK_METADATA: {
36
36
  readonly language: "typescript";
37
- readonly openapiDocVersion: "4.14.0-alpha.1756909436543-ef8097da";
38
- readonly sdkVersion: "0.0.48";
37
+ readonly openapiDocVersion: "4.14.0-alpha.1757000684650-0bcbd7ed";
38
+ readonly sdkVersion: "0.0.49";
39
39
  readonly genVersion: "2.686.7";
40
- readonly userAgent: "speakeasy-sdk/typescript 0.0.48 2.686.7 4.14.0-alpha.1756909436543-ef8097da cribl-control-plane";
40
+ readonly userAgent: "speakeasy-sdk/typescript 0.0.49 2.686.7 4.14.0-alpha.1757000684650-0bcbd7ed cribl-control-plane";
41
41
  };
42
42
  //# sourceMappingURL=config.d.ts.map
@@ -27,9 +27,9 @@ function serverURLFromOptions(options) {
27
27
  }
28
28
  exports.SDK_METADATA = {
29
29
  language: "typescript",
30
- openapiDocVersion: "4.14.0-alpha.1756909436543-ef8097da",
31
- sdkVersion: "0.0.48",
30
+ openapiDocVersion: "4.14.0-alpha.1757000684650-0bcbd7ed",
31
+ sdkVersion: "0.0.49",
32
32
  genVersion: "2.686.7",
33
- userAgent: "speakeasy-sdk/typescript 0.0.48 2.686.7 4.14.0-alpha.1756909436543-ef8097da cribl-control-plane",
33
+ userAgent: "speakeasy-sdk/typescript 0.0.49 2.686.7 4.14.0-alpha.1757000684650-0bcbd7ed cribl-control-plane",
34
34
  };
35
35
  //# sourceMappingURL=config.js.map
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
4
  import * as models from "../index.js";
5
5
  export type CreateRoutesAppendByIdRequest = {
6
6
  /**
7
- * the route table to be appended to - currently default is the only supported value
7
+ * The <code>id</code> of the Routing table to append the Route to. The supported value is <code>default</code>.
8
8
  */
9
9
  id: string;
10
10
  /**
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
4
  import * as models from "../index.js";
5
5
  export type CreateVersionRevertRequest = {
6
6
  /**
7
- * Group ID
7
+ * The <code>id</code> of the Worker Group or Edge Fleet to revert the commit for. Required in Distributed deployments. Omit in Single-instance deployments.
8
8
  */
9
9
  groupId?: string | undefined;
10
10
  /**
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
4
  import * as models from "../index.js";
5
5
  export type DeletePipelineByIdRequest = {
6
6
  /**
7
- * Unique ID to DELETE
7
+ * The <code>id</code> of the Pipeline to delete.
8
8
  */
9
9
  id: string;
10
10
  };
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
4
  import * as models from "../index.js";
5
5
  export type GetPipelineByIdRequest = {
6
6
  /**
7
- * Unique ID to GET
7
+ * The <code>id</code> of the Pipeline to get.
8
8
  */
9
9
  id: string;
10
10
  };
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
4
  import * as models from "../index.js";
5
5
  export type GetRoutesByIdRequest = {
6
6
  /**
7
- * Unique ID to GET
7
+ * The <code>id</code> of the Routing table to get. The supported value is <code>default</code>.
8
8
  */
9
9
  id: string;
10
10
  };
@@ -4,16 +4,16 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
4
  import * as models from "../index.js";
5
5
  export type UpdatePipelineByIdRequest = {
6
6
  /**
7
- * Unique ID to PATCH
7
+ * The <code>id</code> of the Pipeline to update.
8
8
  */
9
9
  id: string;
10
10
  /**
11
- * Pipeline object to be updated
11
+ * Pipeline object
12
12
  */
13
13
  pipeline: models.Pipeline;
14
14
  };
15
15
  /**
16
- * a list of any objects
16
+ * a list of Pipeline objects
17
17
  */
18
18
  export type UpdatePipelineByIdResponse = {
19
19
  /**
@@ -4,7 +4,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
4
4
  import * as models from "../index.js";
5
5
  export type UpdateRoutesByIdRequest = {
6
6
  /**
7
- * Unique ID to PATCH
7
+ * The <code>id</code> of the Routing table that contains the Route to update. The supported value is <code>default</code>.
8
8
  */
9
9
  id: string;
10
10
  /**
@@ -235,7 +235,7 @@ export type OutputGoogleChronicle = {
235
235
  */
236
236
  logTextField?: string | undefined;
237
237
  /**
238
- * Unique identifier (UUID) corresponding to a particular SecOps instance. Provided by your SecOps representative.
238
+ * A unique identifier (UUID) for your Google SecOps instance. This is provided by your Google representative and is required for API V2 authentication.
239
239
  */
240
240
  customerId?: string | undefined;
241
241
  /**
@@ -6,35 +6,35 @@ export declare class Pipelines extends ClientSDK {
6
6
  * List all Pipelines
7
7
  *
8
8
  * @remarks
9
- * List all Pipelines
9
+ * Get a list of all Pipelines.
10
10
  */
11
11
  list(options?: RequestOptions): Promise<operations.ListPipelineResponse>;
12
12
  /**
13
13
  * Create a Pipeline
14
14
  *
15
15
  * @remarks
16
- * Create a Pipeline
16
+ * Create a new Pipeline.
17
17
  */
18
18
  create(request: models.Pipeline, options?: RequestOptions): Promise<operations.CreatePipelineResponse>;
19
19
  /**
20
- * Retrieve a Pipeline
20
+ * Get a Pipeline
21
21
  *
22
22
  * @remarks
23
- * Retrieve a Pipeline
23
+ * Get the specified Pipeline.
24
24
  */
25
25
  get(request: operations.GetPipelineByIdRequest, options?: RequestOptions): Promise<operations.GetPipelineByIdResponse>;
26
26
  /**
27
27
  * Update a Pipeline
28
28
  *
29
29
  * @remarks
30
- * Update a Pipeline
30
+ * Update the specified Pipeline.</br></br>Provide a complete representation of the Pipeline that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Pipeline might not function as expected.
31
31
  */
32
32
  update(request: operations.UpdatePipelineByIdRequest, options?: RequestOptions): Promise<operations.UpdatePipelineByIdResponse>;
33
33
  /**
34
34
  * Delete a Pipeline
35
35
  *
36
36
  * @remarks
37
- * Delete a Pipeline
37
+ * Delete the specified Pipeline.
38
38
  */
39
39
  delete(request: operations.DeletePipelineByIdRequest, options?: RequestOptions): Promise<operations.DeletePipelineByIdResponse>;
40
40
  }
@@ -16,7 +16,7 @@ class Pipelines extends sdks_js_1.ClientSDK {
16
16
  * List all Pipelines
17
17
  *
18
18
  * @remarks
19
- * List all Pipelines
19
+ * Get a list of all Pipelines.
20
20
  */
21
21
  async list(options) {
22
22
  return (0, fp_js_1.unwrapAsync)((0, pipelinesList_js_1.pipelinesList)(this, options));
@@ -25,16 +25,16 @@ class Pipelines extends sdks_js_1.ClientSDK {
25
25
  * Create a Pipeline
26
26
  *
27
27
  * @remarks
28
- * Create a Pipeline
28
+ * Create a new Pipeline.
29
29
  */
30
30
  async create(request, options) {
31
31
  return (0, fp_js_1.unwrapAsync)((0, pipelinesCreate_js_1.pipelinesCreate)(this, request, options));
32
32
  }
33
33
  /**
34
- * Retrieve a Pipeline
34
+ * Get a Pipeline
35
35
  *
36
36
  * @remarks
37
- * Retrieve a Pipeline
37
+ * Get the specified Pipeline.
38
38
  */
39
39
  async get(request, options) {
40
40
  return (0, fp_js_1.unwrapAsync)((0, pipelinesGet_js_1.pipelinesGet)(this, request, options));
@@ -43,7 +43,7 @@ class Pipelines extends sdks_js_1.ClientSDK {
43
43
  * Update a Pipeline
44
44
  *
45
45
  * @remarks
46
- * Update a Pipeline
46
+ * Update the specified Pipeline.</br></br>Provide a complete representation of the Pipeline that you want to update in the request body. This endpoint does not support partial updates. Cribl removes any omitted fields when updating the Pipeline.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the updated Pipeline might not function as expected.
47
47
  */
48
48
  async update(request, options) {
49
49
  return (0, fp_js_1.unwrapAsync)((0, pipelinesUpdate_js_1.pipelinesUpdate)(this, request, options));
@@ -52,7 +52,7 @@ class Pipelines extends sdks_js_1.ClientSDK {
52
52
  * Delete a Pipeline
53
53
  *
54
54
  * @remarks
55
- * Delete a Pipeline
55
+ * Delete the specified Pipeline.
56
56
  */
57
57
  async delete(request, options) {
58
58
  return (0, fp_js_1.unwrapAsync)((0, pipelinesDelete_js_1.pipelinesDelete)(this, request, options));
@@ -2,31 +2,31 @@ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
2
2
  import * as operations from "../models/operations/index.js";
3
3
  export declare class Routes extends ClientSDK {
4
4
  /**
5
- * Get a list of Routes objects
5
+ * List all Routes
6
6
  *
7
7
  * @remarks
8
- * Get a list of Routes objects
8
+ * Get a list of all Routes.
9
9
  */
10
10
  list(options?: RequestOptions): Promise<operations.ListRoutesResponse>;
11
11
  /**
12
- * Get Routes by ID
12
+ * Get a Routing table
13
13
  *
14
14
  * @remarks
15
- * Get Routes by ID
15
+ * Get the specified Routing table.
16
16
  */
17
17
  get(request: operations.GetRoutesByIdRequest, options?: RequestOptions): Promise<operations.GetRoutesByIdResponse>;
18
18
  /**
19
- * Update Routes
19
+ * Update a Route
20
20
  *
21
21
  * @remarks
22
- * Update Routes
22
+ * Update a Route in the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to update, in the request body. This endpoint does not support partial updates. Cribl removes any omitted Routes and fields when updating.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
23
23
  */
24
24
  update(request: operations.UpdateRoutesByIdRequest, options?: RequestOptions): Promise<operations.UpdateRoutesByIdResponse>;
25
25
  /**
26
- * Append Routes to the end of the Routing table
26
+ * Append a Route to the end of the Routing table
27
27
  *
28
28
  * @remarks
29
- * Appends routes to the end of the routing table
29
+ * Append a Route to the end of the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to append, in the request body. Cribl removes any omitted Routes and fields in the Routing table when appending the Route.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
30
30
  */
31
31
  append(request: operations.CreateRoutesAppendByIdRequest, options?: RequestOptions): Promise<operations.CreateRoutesAppendByIdResponse>;
32
32
  }
@@ -12,37 +12,37 @@ const sdks_js_1 = require("../lib/sdks.js");
12
12
  const fp_js_1 = require("../types/fp.js");
13
13
  class Routes extends sdks_js_1.ClientSDK {
14
14
  /**
15
- * Get a list of Routes objects
15
+ * List all Routes
16
16
  *
17
17
  * @remarks
18
- * Get a list of Routes objects
18
+ * Get a list of all Routes.
19
19
  */
20
20
  async list(options) {
21
21
  return (0, fp_js_1.unwrapAsync)((0, routesList_js_1.routesList)(this, options));
22
22
  }
23
23
  /**
24
- * Get Routes by ID
24
+ * Get a Routing table
25
25
  *
26
26
  * @remarks
27
- * Get Routes by ID
27
+ * Get the specified Routing table.
28
28
  */
29
29
  async get(request, options) {
30
30
  return (0, fp_js_1.unwrapAsync)((0, routesGet_js_1.routesGet)(this, request, options));
31
31
  }
32
32
  /**
33
- * Update Routes
33
+ * Update a Route
34
34
  *
35
35
  * @remarks
36
- * Update Routes
36
+ * Update a Route in the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to update, in the request body. This endpoint does not support partial updates. Cribl removes any omitted Routes and fields when updating.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
37
37
  */
38
38
  async update(request, options) {
39
39
  return (0, fp_js_1.unwrapAsync)((0, routesUpdate_js_1.routesUpdate)(this, request, options));
40
40
  }
41
41
  /**
42
- * Append Routes to the end of the Routing table
42
+ * Append a Route to the end of the Routing table
43
43
  *
44
44
  * @remarks
45
- * Appends routes to the end of the routing table
45
+ * Append a Route to the end of the specified Routing table.</br></br>Provide a complete representation of the Routing table, including the Route that you want to append, in the request body. Cribl removes any omitted Routes and fields in the Routing table when appending the Route.</br></br>Confirm that the configuration in your request body is correct before sending the request. If the configuration is incorrect, the Routing table might not function as expected.
46
46
  */
47
47
  async append(request, options) {
48
48
  return (0, fp_js_1.unwrapAsync)((0, routesAppend_js_1.routesAppend)(this, request, options));
@@ -13,7 +13,7 @@ import { Result } from "../types/fp.js";
13
13
  * Create a Pipeline
14
14
  *
15
15
  * @remarks
16
- * Create a Pipeline
16
+ * Create a new Pipeline.
17
17
  */
18
18
  export declare function pipelinesCreate(client: CriblControlPlaneCore, request: models.Pipeline, options?: RequestOptions): APIPromise<Result<operations.CreatePipelineResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
19
19
  //# sourceMappingURL=pipelinesCreate.d.ts.map
@@ -15,7 +15,7 @@ import { APIPromise } from "../types/async.js";
15
15
  * Create a Pipeline
16
16
  *
17
17
  * @remarks
18
- * Create a Pipeline
18
+ * Create a new Pipeline.
19
19
  */
20
20
  export function pipelinesCreate(client, request, options) {
21
21
  return new APIPromise($do(client, request, options));
@@ -12,7 +12,7 @@ import { Result } from "../types/fp.js";
12
12
  * Delete a Pipeline
13
13
  *
14
14
  * @remarks
15
- * Delete a Pipeline
15
+ * Delete the specified Pipeline.
16
16
  */
17
17
  export declare function pipelinesDelete(client: CriblControlPlaneCore, request: operations.DeletePipelineByIdRequest, options?: RequestOptions): APIPromise<Result<operations.DeletePipelineByIdResponse, errors.ErrorT | CriblControlPlaneError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
18
18
  //# sourceMappingURL=pipelinesDelete.d.ts.map
@@ -14,7 +14,7 @@ import { APIPromise } from "../types/async.js";
14
14
  * Delete a Pipeline
15
15
  *
16
16
  * @remarks
17
- * Delete a Pipeline
17
+ * Delete the specified Pipeline.
18
18
  */
19
19
  export function pipelinesDelete(client, request, options) {
20
20
  return new APIPromise($do(client, request, options));