mavenagi 1.2.25 → 1.2.26

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 (34) hide show
  1. package/Client.js +2 -2
  2. package/api/resources/knowledge/client/Client.d.ts +19 -0
  3. package/api/resources/knowledge/client/Client.js +93 -0
  4. package/api/resources/knowledge/types/CancelKnowledgeBaseVersionRequest.d.ts +5 -0
  5. package/api/resources/knowledge/types/CancelKnowledgeBaseVersionRequest.js +3 -0
  6. package/api/resources/knowledge/types/index.d.ts +1 -0
  7. package/api/resources/knowledge/types/index.js +1 -0
  8. package/api/resources/triggers/types/EventTriggerBase.d.ts +2 -0
  9. package/dist/Client.js +2 -2
  10. package/dist/api/resources/knowledge/client/Client.d.ts +19 -0
  11. package/dist/api/resources/knowledge/client/Client.js +93 -0
  12. package/dist/api/resources/knowledge/types/CancelKnowledgeBaseVersionRequest.d.ts +5 -0
  13. package/dist/api/resources/knowledge/types/CancelKnowledgeBaseVersionRequest.js +3 -0
  14. package/dist/api/resources/knowledge/types/index.d.ts +1 -0
  15. package/dist/api/resources/knowledge/types/index.js +1 -0
  16. package/dist/api/resources/triggers/types/EventTriggerBase.d.ts +2 -0
  17. package/dist/serialization/resources/knowledge/types/CancelKnowledgeBaseVersionRequest.d.ts +10 -0
  18. package/dist/serialization/resources/knowledge/types/CancelKnowledgeBaseVersionRequest.js +42 -0
  19. package/dist/serialization/resources/knowledge/types/index.d.ts +1 -0
  20. package/dist/serialization/resources/knowledge/types/index.js +1 -0
  21. package/dist/serialization/resources/triggers/types/EventTriggerBase.d.ts +1 -0
  22. package/dist/serialization/resources/triggers/types/EventTriggerBase.js +1 -0
  23. package/dist/version.d.ts +1 -1
  24. package/dist/version.js +1 -1
  25. package/package.json +1 -1
  26. package/reference.md +74 -0
  27. package/serialization/resources/knowledge/types/CancelKnowledgeBaseVersionRequest.d.ts +10 -0
  28. package/serialization/resources/knowledge/types/CancelKnowledgeBaseVersionRequest.js +42 -0
  29. package/serialization/resources/knowledge/types/index.d.ts +1 -0
  30. package/serialization/resources/knowledge/types/index.js +1 -0
  31. package/serialization/resources/triggers/types/EventTriggerBase.d.ts +1 -0
  32. package/serialization/resources/triggers/types/EventTriggerBase.js +1 -0
  33. package/version.d.ts +1 -1
  34. package/version.js +1 -1
package/Client.js CHANGED
@@ -62,8 +62,8 @@ class MavenAGIClient {
62
62
  "X-Agent-Id": _options === null || _options === void 0 ? void 0 : _options.agentId,
63
63
  "X-Fern-Language": "JavaScript",
64
64
  "X-Fern-SDK-Name": "mavenagi",
65
- "X-Fern-SDK-Version": "1.2.25",
66
- "User-Agent": "mavenagi/1.2.25",
65
+ "X-Fern-SDK-Version": "1.2.26",
66
+ "User-Agent": "mavenagi/1.2.26",
67
67
  "X-Fern-Runtime": core.RUNTIME.type,
68
68
  "X-Fern-Runtime-Version": core.RUNTIME.version,
69
69
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -82,6 +82,25 @@ export declare class Knowledge {
82
82
  */
83
83
  refreshKnowledgeBase(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBaseRefreshRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<void>;
84
84
  private __refreshKnowledgeBase;
85
+ /**
86
+ * in-progress knowledge base version.
87
+ *
88
+ * If the knowledge base has a version that is currently being ingested,
89
+ * this will cancel the ingestion workflow and set the version status to FAILED.
90
+ *
91
+ * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to cancel ingestion for. All other entity ID fields are inferred from the request.
92
+ * @param {MavenAGI.CancelKnowledgeBaseVersionRequest} request
93
+ * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
94
+ *
95
+ * @throws {@link MavenAGI.NotFoundError}
96
+ * @throws {@link MavenAGI.BadRequestError}
97
+ * @throws {@link MavenAGI.ServerError}
98
+ *
99
+ * @example
100
+ * await client.knowledge.cancelKnowledgeBaseVersion("knowledgeBaseReferenceId", {})
101
+ */
102
+ cancelKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.CancelKnowledgeBaseVersionRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<void>;
103
+ private __cancelKnowledgeBaseVersion;
85
104
  /**
86
105
  * Update mutable knowledge base fields
87
106
  *
@@ -440,6 +440,99 @@ class Knowledge {
440
440
  }
441
441
  });
442
442
  }
443
+ /**
444
+ * in-progress knowledge base version.
445
+ *
446
+ * If the knowledge base has a version that is currently being ingested,
447
+ * this will cancel the ingestion workflow and set the version status to FAILED.
448
+ *
449
+ * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to cancel ingestion for. All other entity ID fields are inferred from the request.
450
+ * @param {MavenAGI.CancelKnowledgeBaseVersionRequest} request
451
+ * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
452
+ *
453
+ * @throws {@link MavenAGI.NotFoundError}
454
+ * @throws {@link MavenAGI.BadRequestError}
455
+ * @throws {@link MavenAGI.ServerError}
456
+ *
457
+ * @example
458
+ * await client.knowledge.cancelKnowledgeBaseVersion("knowledgeBaseReferenceId", {})
459
+ */
460
+ cancelKnowledgeBaseVersion(knowledgeBaseReferenceId, request, requestOptions) {
461
+ return core.HttpResponsePromise.fromPromise(this.__cancelKnowledgeBaseVersion(knowledgeBaseReferenceId, request, requestOptions));
462
+ }
463
+ __cancelKnowledgeBaseVersion(knowledgeBaseReferenceId, request, requestOptions) {
464
+ return __awaiter(this, void 0, void 0, function* () {
465
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
466
+ const _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
467
+ Authorization: yield this._getAuthorizationHeader(),
468
+ "X-Organization-Id": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationId,
469
+ "X-Agent-Id": (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.agentId,
470
+ }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
471
+ const _response = yield ((_f = this._options.fetcher) !== null && _f !== void 0 ? _f : core.fetcher)({
472
+ url: core.url.join((_h = (_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${core.url.encodePathParam(knowledgeBaseReferenceId)}/cancel`),
473
+ method: "POST",
474
+ headers: _headers,
475
+ contentType: "application/json",
476
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
477
+ requestType: "json",
478
+ body: serializers.CancelKnowledgeBaseVersionRequest.jsonOrThrow(request, {
479
+ unrecognizedObjectKeys: "strip",
480
+ }),
481
+ timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
482
+ maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
483
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
484
+ });
485
+ if (_response.ok) {
486
+ return { data: undefined, rawResponse: _response.rawResponse };
487
+ }
488
+ if (_response.error.reason === "status-code") {
489
+ switch (_response.error.statusCode) {
490
+ case 404:
491
+ throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
492
+ unrecognizedObjectKeys: "passthrough",
493
+ allowUnrecognizedUnionMembers: true,
494
+ allowUnrecognizedEnumValues: true,
495
+ breadcrumbsPrefix: ["response"],
496
+ }), _response.rawResponse);
497
+ case 400:
498
+ throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
499
+ unrecognizedObjectKeys: "passthrough",
500
+ allowUnrecognizedUnionMembers: true,
501
+ allowUnrecognizedEnumValues: true,
502
+ breadcrumbsPrefix: ["response"],
503
+ }), _response.rawResponse);
504
+ case 500:
505
+ throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
506
+ unrecognizedObjectKeys: "passthrough",
507
+ allowUnrecognizedUnionMembers: true,
508
+ allowUnrecognizedEnumValues: true,
509
+ breadcrumbsPrefix: ["response"],
510
+ }), _response.rawResponse);
511
+ default:
512
+ throw new errors.MavenAGIError({
513
+ statusCode: _response.error.statusCode,
514
+ body: _response.error.body,
515
+ rawResponse: _response.rawResponse,
516
+ });
517
+ }
518
+ }
519
+ switch (_response.error.reason) {
520
+ case "non-json":
521
+ throw new errors.MavenAGIError({
522
+ statusCode: _response.error.statusCode,
523
+ body: _response.error.rawBody,
524
+ rawResponse: _response.rawResponse,
525
+ });
526
+ case "timeout":
527
+ throw new errors.MavenAGITimeoutError("Timeout exceeded when calling POST /v1/knowledge/{knowledgeBaseReferenceId}/cancel.");
528
+ case "unknown":
529
+ throw new errors.MavenAGIError({
530
+ message: _response.error.errorMessage,
531
+ rawResponse: _response.rawResponse,
532
+ });
533
+ }
534
+ });
535
+ }
443
536
  /**
444
537
  * Update mutable knowledge base fields
445
538
  *
@@ -0,0 +1,5 @@
1
+ import type * as MavenAGI from "../../../index";
2
+ export interface CancelKnowledgeBaseVersionRequest {
3
+ /** ID that uniquely identifies which knowledge base version to cancel. If not provided will use the most recent version of the knowledge base. */
4
+ versionId?: MavenAGI.EntityIdWithoutAgent;
5
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,4 +1,5 @@
1
1
  export * from "./BaseKnowledgeDocument";
2
+ export * from "./CancelKnowledgeBaseVersionRequest";
2
3
  export * from "./FinalizeKnowledgeBaseVersionRequest";
3
4
  export * from "./KnowledgeBaseField";
4
5
  export * from "./KnowledgeBaseFilter";
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BaseKnowledgeDocument"), exports);
18
+ __exportStar(require("./CancelKnowledgeBaseVersionRequest"), exports);
18
19
  __exportStar(require("./FinalizeKnowledgeBaseVersionRequest"), exports);
19
20
  __exportStar(require("./KnowledgeBaseField"), exports);
20
21
  __exportStar(require("./KnowledgeBaseFilter"), exports);
@@ -1,5 +1,7 @@
1
1
  import type * as MavenAGI from "../../../index";
2
2
  export interface EventTriggerBase {
3
+ /** The name of the trigger, displayed to end users. If not set, a name is derived from the app ID and trigger type. */
4
+ name?: string;
3
5
  /** The description of what the event trigger does, shown in the Maven Dashboard */
4
6
  description: string;
5
7
  /**
package/dist/Client.js CHANGED
@@ -62,8 +62,8 @@ class MavenAGIClient {
62
62
  "X-Agent-Id": _options === null || _options === void 0 ? void 0 : _options.agentId,
63
63
  "X-Fern-Language": "JavaScript",
64
64
  "X-Fern-SDK-Name": "mavenagi",
65
- "X-Fern-SDK-Version": "1.2.25",
66
- "User-Agent": "mavenagi/1.2.25",
65
+ "X-Fern-SDK-Version": "1.2.26",
66
+ "User-Agent": "mavenagi/1.2.26",
67
67
  "X-Fern-Runtime": core.RUNTIME.type,
68
68
  "X-Fern-Runtime-Version": core.RUNTIME.version,
69
69
  }, _options === null || _options === void 0 ? void 0 : _options.headers) });
@@ -82,6 +82,25 @@ export declare class Knowledge {
82
82
  */
83
83
  refreshKnowledgeBase(knowledgeBaseReferenceId: string, request: MavenAGI.KnowledgeBaseRefreshRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<void>;
84
84
  private __refreshKnowledgeBase;
85
+ /**
86
+ * in-progress knowledge base version.
87
+ *
88
+ * If the knowledge base has a version that is currently being ingested,
89
+ * this will cancel the ingestion workflow and set the version status to FAILED.
90
+ *
91
+ * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to cancel ingestion for. All other entity ID fields are inferred from the request.
92
+ * @param {MavenAGI.CancelKnowledgeBaseVersionRequest} request
93
+ * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
94
+ *
95
+ * @throws {@link MavenAGI.NotFoundError}
96
+ * @throws {@link MavenAGI.BadRequestError}
97
+ * @throws {@link MavenAGI.ServerError}
98
+ *
99
+ * @example
100
+ * await client.knowledge.cancelKnowledgeBaseVersion("knowledgeBaseReferenceId", {})
101
+ */
102
+ cancelKnowledgeBaseVersion(knowledgeBaseReferenceId: string, request: MavenAGI.CancelKnowledgeBaseVersionRequest, requestOptions?: Knowledge.RequestOptions): core.HttpResponsePromise<void>;
103
+ private __cancelKnowledgeBaseVersion;
85
104
  /**
86
105
  * Update mutable knowledge base fields
87
106
  *
@@ -440,6 +440,99 @@ class Knowledge {
440
440
  }
441
441
  });
442
442
  }
443
+ /**
444
+ * in-progress knowledge base version.
445
+ *
446
+ * If the knowledge base has a version that is currently being ingested,
447
+ * this will cancel the ingestion workflow and set the version status to FAILED.
448
+ *
449
+ * @param {string} knowledgeBaseReferenceId - The reference ID of the knowledge base to cancel ingestion for. All other entity ID fields are inferred from the request.
450
+ * @param {MavenAGI.CancelKnowledgeBaseVersionRequest} request
451
+ * @param {Knowledge.RequestOptions} requestOptions - Request-specific configuration.
452
+ *
453
+ * @throws {@link MavenAGI.NotFoundError}
454
+ * @throws {@link MavenAGI.BadRequestError}
455
+ * @throws {@link MavenAGI.ServerError}
456
+ *
457
+ * @example
458
+ * await client.knowledge.cancelKnowledgeBaseVersion("knowledgeBaseReferenceId", {})
459
+ */
460
+ cancelKnowledgeBaseVersion(knowledgeBaseReferenceId, request, requestOptions) {
461
+ return core.HttpResponsePromise.fromPromise(this.__cancelKnowledgeBaseVersion(knowledgeBaseReferenceId, request, requestOptions));
462
+ }
463
+ __cancelKnowledgeBaseVersion(knowledgeBaseReferenceId, request, requestOptions) {
464
+ return __awaiter(this, void 0, void 0, function* () {
465
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
466
+ const _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({
467
+ Authorization: yield this._getAuthorizationHeader(),
468
+ "X-Organization-Id": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationId) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationId,
469
+ "X-Agent-Id": (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.agentId) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.agentId,
470
+ }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
471
+ const _response = yield ((_f = this._options.fetcher) !== null && _f !== void 0 ? _f : core.fetcher)({
472
+ url: core.url.join((_h = (_g = (yield core.Supplier.get(this._options.baseUrl))) !== null && _g !== void 0 ? _g : (yield core.Supplier.get(this._options.environment))) !== null && _h !== void 0 ? _h : environments.MavenAGIEnvironment.Production, `/v1/knowledge/${core.url.encodePathParam(knowledgeBaseReferenceId)}/cancel`),
473
+ method: "POST",
474
+ headers: _headers,
475
+ contentType: "application/json",
476
+ queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
477
+ requestType: "json",
478
+ body: serializers.CancelKnowledgeBaseVersionRequest.jsonOrThrow(request, {
479
+ unrecognizedObjectKeys: "strip",
480
+ }),
481
+ timeoutMs: ((_l = (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.timeoutInSeconds) !== null && _l !== void 0 ? _l : 60) * 1000,
482
+ maxRetries: (_m = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _m !== void 0 ? _m : (_o = this._options) === null || _o === void 0 ? void 0 : _o.maxRetries,
483
+ abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
484
+ });
485
+ if (_response.ok) {
486
+ return { data: undefined, rawResponse: _response.rawResponse };
487
+ }
488
+ if (_response.error.reason === "status-code") {
489
+ switch (_response.error.statusCode) {
490
+ case 404:
491
+ throw new MavenAGI.NotFoundError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
492
+ unrecognizedObjectKeys: "passthrough",
493
+ allowUnrecognizedUnionMembers: true,
494
+ allowUnrecognizedEnumValues: true,
495
+ breadcrumbsPrefix: ["response"],
496
+ }), _response.rawResponse);
497
+ case 400:
498
+ throw new MavenAGI.BadRequestError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
499
+ unrecognizedObjectKeys: "passthrough",
500
+ allowUnrecognizedUnionMembers: true,
501
+ allowUnrecognizedEnumValues: true,
502
+ breadcrumbsPrefix: ["response"],
503
+ }), _response.rawResponse);
504
+ case 500:
505
+ throw new MavenAGI.ServerError(serializers.ErrorMessage.parseOrThrow(_response.error.body, {
506
+ unrecognizedObjectKeys: "passthrough",
507
+ allowUnrecognizedUnionMembers: true,
508
+ allowUnrecognizedEnumValues: true,
509
+ breadcrumbsPrefix: ["response"],
510
+ }), _response.rawResponse);
511
+ default:
512
+ throw new errors.MavenAGIError({
513
+ statusCode: _response.error.statusCode,
514
+ body: _response.error.body,
515
+ rawResponse: _response.rawResponse,
516
+ });
517
+ }
518
+ }
519
+ switch (_response.error.reason) {
520
+ case "non-json":
521
+ throw new errors.MavenAGIError({
522
+ statusCode: _response.error.statusCode,
523
+ body: _response.error.rawBody,
524
+ rawResponse: _response.rawResponse,
525
+ });
526
+ case "timeout":
527
+ throw new errors.MavenAGITimeoutError("Timeout exceeded when calling POST /v1/knowledge/{knowledgeBaseReferenceId}/cancel.");
528
+ case "unknown":
529
+ throw new errors.MavenAGIError({
530
+ message: _response.error.errorMessage,
531
+ rawResponse: _response.rawResponse,
532
+ });
533
+ }
534
+ });
535
+ }
443
536
  /**
444
537
  * Update mutable knowledge base fields
445
538
  *
@@ -0,0 +1,5 @@
1
+ import type * as MavenAGI from "../../../index";
2
+ export interface CancelKnowledgeBaseVersionRequest {
3
+ /** ID that uniquely identifies which knowledge base version to cancel. If not provided will use the most recent version of the knowledge base. */
4
+ versionId?: MavenAGI.EntityIdWithoutAgent;
5
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,4 +1,5 @@
1
1
  export * from "./BaseKnowledgeDocument";
2
+ export * from "./CancelKnowledgeBaseVersionRequest";
2
3
  export * from "./FinalizeKnowledgeBaseVersionRequest";
3
4
  export * from "./KnowledgeBaseField";
4
5
  export * from "./KnowledgeBaseFilter";
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BaseKnowledgeDocument"), exports);
18
+ __exportStar(require("./CancelKnowledgeBaseVersionRequest"), exports);
18
19
  __exportStar(require("./FinalizeKnowledgeBaseVersionRequest"), exports);
19
20
  __exportStar(require("./KnowledgeBaseField"), exports);
20
21
  __exportStar(require("./KnowledgeBaseFilter"), exports);
@@ -1,5 +1,7 @@
1
1
  import type * as MavenAGI from "../../../index";
2
2
  export interface EventTriggerBase {
3
+ /** The name of the trigger, displayed to end users. If not set, a name is derived from the app ID and trigger type. */
4
+ name?: string;
3
5
  /** The description of what the event trigger does, shown in the Maven Dashboard */
4
6
  description: string;
5
7
  /**
@@ -0,0 +1,10 @@
1
+ import type * as MavenAGI from "../../../../api/index";
2
+ import * as core from "../../../../core";
3
+ import type * as serializers from "../../../index";
4
+ import { EntityIdWithoutAgent } from "../../commons/types/EntityIdWithoutAgent";
5
+ export declare const CancelKnowledgeBaseVersionRequest: core.serialization.ObjectSchema<serializers.CancelKnowledgeBaseVersionRequest.Raw, MavenAGI.CancelKnowledgeBaseVersionRequest>;
6
+ export declare namespace CancelKnowledgeBaseVersionRequest {
7
+ interface Raw {
8
+ versionId?: EntityIdWithoutAgent.Raw | null;
9
+ }
10
+ }
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.CancelKnowledgeBaseVersionRequest = void 0;
38
+ const core = __importStar(require("../../../../core"));
39
+ const EntityIdWithoutAgent_1 = require("../../commons/types/EntityIdWithoutAgent");
40
+ exports.CancelKnowledgeBaseVersionRequest = core.serialization.object({
41
+ versionId: EntityIdWithoutAgent_1.EntityIdWithoutAgent.optional(),
42
+ });
@@ -1,4 +1,5 @@
1
1
  export * from "./BaseKnowledgeDocument";
2
+ export * from "./CancelKnowledgeBaseVersionRequest";
2
3
  export * from "./FinalizeKnowledgeBaseVersionRequest";
3
4
  export * from "./KnowledgeBaseField";
4
5
  export * from "./KnowledgeBaseFilter";
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BaseKnowledgeDocument"), exports);
18
+ __exportStar(require("./CancelKnowledgeBaseVersionRequest"), exports);
18
19
  __exportStar(require("./FinalizeKnowledgeBaseVersionRequest"), exports);
19
20
  __exportStar(require("./KnowledgeBaseField"), exports);
20
21
  __exportStar(require("./KnowledgeBaseFilter"), exports);
@@ -5,6 +5,7 @@ import { EventTriggerType } from "../../commons/types/EventTriggerType";
5
5
  export declare const EventTriggerBase: core.serialization.ObjectSchema<serializers.EventTriggerBase.Raw, MavenAGI.EventTriggerBase>;
6
6
  export declare namespace EventTriggerBase {
7
7
  interface Raw {
8
+ name?: string | null;
8
9
  description: string;
9
10
  type: EventTriggerType.Raw;
10
11
  }
@@ -38,6 +38,7 @@ exports.EventTriggerBase = void 0;
38
38
  const core = __importStar(require("../../../../core"));
39
39
  const EventTriggerType_1 = require("../../commons/types/EventTriggerType");
40
40
  exports.EventTriggerBase = core.serialization.object({
41
+ name: core.serialization.string().optional(),
41
42
  description: core.serialization.string(),
42
43
  type: EventTriggerType_1.EventTriggerType,
43
44
  });
package/dist/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.25";
1
+ export declare const SDK_VERSION = "1.2.26";
package/dist/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.2.25";
4
+ exports.SDK_VERSION = "1.2.26";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mavenagi",
3
- "version": "1.2.25",
3
+ "version": "1.2.26",
4
4
  "private": false,
5
5
  "repository": "github:mavenagi/mavenagi-node",
6
6
  "main": "./index.js",
package/reference.md CHANGED
@@ -4304,6 +4304,80 @@ await client.knowledge.refreshKnowledgeBase("help-center", {
4304
4304
  </dl>
4305
4305
 
4306
4306
 
4307
+ </dd>
4308
+ </dl>
4309
+ </details>
4310
+
4311
+ <details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">cancelKnowledgeBaseVersion</a>(knowledgeBaseReferenceId, { ...params }) -> void</code></summary>
4312
+ <dl>
4313
+ <dd>
4314
+
4315
+ #### 📝 Description
4316
+
4317
+ <dl>
4318
+ <dd>
4319
+
4320
+ <dl>
4321
+ <dd>
4322
+
4323
+ in-progress knowledge base version.
4324
+
4325
+ If the knowledge base has a version that is currently being ingested,
4326
+ this will cancel the ingestion workflow and set the version status to FAILED.
4327
+ </dd>
4328
+ </dl>
4329
+ </dd>
4330
+ </dl>
4331
+
4332
+ #### 🔌 Usage
4333
+
4334
+ <dl>
4335
+ <dd>
4336
+
4337
+ <dl>
4338
+ <dd>
4339
+
4340
+ ```typescript
4341
+ await client.knowledge.cancelKnowledgeBaseVersion("knowledgeBaseReferenceId", {});
4342
+
4343
+ ```
4344
+ </dd>
4345
+ </dl>
4346
+ </dd>
4347
+ </dl>
4348
+
4349
+ #### ⚙️ Parameters
4350
+
4351
+ <dl>
4352
+ <dd>
4353
+
4354
+ <dl>
4355
+ <dd>
4356
+
4357
+ **knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to cancel ingestion for. All other entity ID fields are inferred from the request.
4358
+
4359
+ </dd>
4360
+ </dl>
4361
+
4362
+ <dl>
4363
+ <dd>
4364
+
4365
+ **request:** `MavenAGI.CancelKnowledgeBaseVersionRequest`
4366
+
4367
+ </dd>
4368
+ </dl>
4369
+
4370
+ <dl>
4371
+ <dd>
4372
+
4373
+ **requestOptions:** `Knowledge.RequestOptions`
4374
+
4375
+ </dd>
4376
+ </dl>
4377
+ </dd>
4378
+ </dl>
4379
+
4380
+
4307
4381
  </dd>
4308
4382
  </dl>
4309
4383
  </details>
@@ -0,0 +1,10 @@
1
+ import type * as MavenAGI from "../../../../api/index";
2
+ import * as core from "../../../../core";
3
+ import type * as serializers from "../../../index";
4
+ import { EntityIdWithoutAgent } from "../../commons/types/EntityIdWithoutAgent";
5
+ export declare const CancelKnowledgeBaseVersionRequest: core.serialization.ObjectSchema<serializers.CancelKnowledgeBaseVersionRequest.Raw, MavenAGI.CancelKnowledgeBaseVersionRequest>;
6
+ export declare namespace CancelKnowledgeBaseVersionRequest {
7
+ interface Raw {
8
+ versionId?: EntityIdWithoutAgent.Raw | null;
9
+ }
10
+ }
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
+ if (k2 === undefined) k2 = k;
5
+ var desc = Object.getOwnPropertyDescriptor(m, k);
6
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
+ desc = { enumerable: true, get: function() { return m[k]; } };
8
+ }
9
+ Object.defineProperty(o, k2, desc);
10
+ }) : (function(o, m, k, k2) {
11
+ if (k2 === undefined) k2 = k;
12
+ o[k2] = m[k];
13
+ }));
14
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
16
+ }) : function(o, v) {
17
+ o["default"] = v;
18
+ });
19
+ var __importStar = (this && this.__importStar) || (function () {
20
+ var ownKeys = function(o) {
21
+ ownKeys = Object.getOwnPropertyNames || function (o) {
22
+ var ar = [];
23
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
+ return ar;
25
+ };
26
+ return ownKeys(o);
27
+ };
28
+ return function (mod) {
29
+ if (mod && mod.__esModule) return mod;
30
+ var result = {};
31
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
+ __setModuleDefault(result, mod);
33
+ return result;
34
+ };
35
+ })();
36
+ Object.defineProperty(exports, "__esModule", { value: true });
37
+ exports.CancelKnowledgeBaseVersionRequest = void 0;
38
+ const core = __importStar(require("../../../../core"));
39
+ const EntityIdWithoutAgent_1 = require("../../commons/types/EntityIdWithoutAgent");
40
+ exports.CancelKnowledgeBaseVersionRequest = core.serialization.object({
41
+ versionId: EntityIdWithoutAgent_1.EntityIdWithoutAgent.optional(),
42
+ });
@@ -1,4 +1,5 @@
1
1
  export * from "./BaseKnowledgeDocument";
2
+ export * from "./CancelKnowledgeBaseVersionRequest";
2
3
  export * from "./FinalizeKnowledgeBaseVersionRequest";
3
4
  export * from "./KnowledgeBaseField";
4
5
  export * from "./KnowledgeBaseFilter";
@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  __exportStar(require("./BaseKnowledgeDocument"), exports);
18
+ __exportStar(require("./CancelKnowledgeBaseVersionRequest"), exports);
18
19
  __exportStar(require("./FinalizeKnowledgeBaseVersionRequest"), exports);
19
20
  __exportStar(require("./KnowledgeBaseField"), exports);
20
21
  __exportStar(require("./KnowledgeBaseFilter"), exports);
@@ -5,6 +5,7 @@ import { EventTriggerType } from "../../commons/types/EventTriggerType";
5
5
  export declare const EventTriggerBase: core.serialization.ObjectSchema<serializers.EventTriggerBase.Raw, MavenAGI.EventTriggerBase>;
6
6
  export declare namespace EventTriggerBase {
7
7
  interface Raw {
8
+ name?: string | null;
8
9
  description: string;
9
10
  type: EventTriggerType.Raw;
10
11
  }
@@ -38,6 +38,7 @@ exports.EventTriggerBase = void 0;
38
38
  const core = __importStar(require("../../../../core"));
39
39
  const EventTriggerType_1 = require("../../commons/types/EventTriggerType");
40
40
  exports.EventTriggerBase = core.serialization.object({
41
+ name: core.serialization.string().optional(),
41
42
  description: core.serialization.string(),
42
43
  type: EventTriggerType_1.EventTriggerType,
43
44
  });
package/version.d.ts CHANGED
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "1.2.25";
1
+ export declare const SDK_VERSION = "1.2.26";
package/version.js CHANGED
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SDK_VERSION = void 0;
4
- exports.SDK_VERSION = "1.2.25";
4
+ exports.SDK_VERSION = "1.2.26";