@aui.io/aui-client 3.1.1 → 3.2.0

package/dist/cjs/api/resources/agentVersions/client/Client.js

@@ -50,10 +50,13 @@ const environments = __importStar(require("../../../../environments.js"));
 const errors = __importStar(require("../../../../errors/index.js"));
 const Apollo = __importStar(require("../../../index.js"));
 class AgentVersions {
-    constructor(_options = {}) {
+    constructor(_options) {
         this._options = _options;
     }
     /**
+     * List an agent's versions, newest first. Filter by status, tag, label,
+     * or version number; set ``exclude_revisions`` to see only base versions.
+     *
      * @param {string} agentId
      * @param {Apollo.ListVersionsRequest} request
      * @param {AgentVersions.RequestOptions} requestOptions - Request-specific configuration.
@@ -76,7 +79,7 @@ class AgentVersions {
     }
     __listVersions(agentId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
             const { filters, "page[size]": pageSize, "page[after]": pageAfter, "page[before]": pageBefore, sort_by: sortBy, sort_order: sortOrder, } = request;
             const _queryParams = {};
             _queryParams.filters = filters;
@@ -95,16 +98,19 @@ class AgentVersions {
             if (sortOrder != null) {
                 _queryParams.sort_order = sortOrder;
             }
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -152,6 +158,10 @@ class AgentVersions {
         });
     }
     /**
+     * Create a new draft version — empty, from a template, or cloned from an
+     * existing version (``source`` selects which). Drafts stay editable until
+     * published.
+     *
      * @param {string} agentId
      * @param {Apollo.AgentVersionCreateRequest} request
      * @param {AgentVersions.RequestOptions} requestOptions - Request-specific configuration.
@@ -174,20 +184,23 @@ class AgentVersions {
     }
     __createVersion(agentId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -235,6 +248,9 @@ class AgentVersions {
         });
     }
     /**
+     * Update a version's metadata: label, tags, and notes. The configuration
+     * itself changes through push, never here.
+     *
      * @param {string} agentId
      * @param {string} versionId
      * @param {Apollo.AgentVersionUpdateRequest} request
@@ -256,20 +272,23 @@ class AgentVersions {
     }
     __updateVersion(agentId_1, versionId_1) {
         return __awaiter(this, arguments, void 0, function* (agentId, versionId, request = {}, requestOptions) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions/${core.url.encodePathParam(versionId)}`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions/${core.url.encodePathParam(versionId)}`),
                 method: "PATCH",
                 headers: _headers,
                 contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -317,6 +336,10 @@ class AgentVersions {
         });
     }
     /**
+     * Make this version the agent's live version. Publishing a draft freezes
+     * it first; publishing an already-published version re-activates it — the
+     * same call handles shipping, switching, and rolling back.
+     *
      * @param {string} agentId
      * @param {string} versionId
      * @param {AgentVersions.RequestOptions} requestOptions - Request-specific configuration.
@@ -337,17 +360,20 @@ class AgentVersions {
     }
     __publishVersion(agentId, versionId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions/${core.url.encodePathParam(versionId)}/publish`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions/${core.url.encodePathParam(versionId)}/publish`),
                 method: "POST",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -395,6 +421,9 @@ class AgentVersions {
         });
     }
     /**
+     * Archive a version to retire it from everyday use. The agent's live
+     * version can't be archived — publish another version first.
+     *
      * @param {string} agentId
      * @param {string} versionId
      * @param {AgentVersions.RequestOptions} requestOptions - Request-specific configuration.
@@ -415,17 +444,20 @@ class AgentVersions {
     }
     __archiveVersion(agentId, versionId, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions/${core.url.encodePathParam(versionId)}/archive`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions/${core.url.encodePathParam(versionId)}/archive`),
                 method: "POST",
                 headers: _headers,
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -473,6 +505,9 @@ class AgentVersions {
         });
     }
     /**
+     * Upload a configuration bundle to a version, committing a new revision.
+     * The response carries the new revision's tag and content digest.
+     *
      * @param {string} agentId
      * @param {string} versionId
      * @param {Apollo.AgentVersionPushRequest} request
@@ -499,20 +534,23 @@ class AgentVersions {
     }
     __pushVersion(agentId, versionId, request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions/${core.url.encodePathParam(versionId)}/push`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions/${core.url.encodePathParam(versionId)}/push`),
                 method: "POST",
                 headers: _headers,
                 contentType: "application/json",
                 queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
                 requestType: "json",
                 body: request,
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -560,6 +598,9 @@ class AgentVersions {
         });
     }
     /**
+     * Download a version's configuration bundle — the current revision, or a
+     * specific one via ``version_tag``.
+     *
      * @param {string} agentId
      * @param {string} versionId
      * @param {Apollo.PullVersionRequest} request
@@ -583,22 +624,25 @@ class AgentVersions {
     }
     __pullVersion(agentId_1, versionId_1) {
         return __awaiter(this, arguments, void 0, function* (agentId, versionId, request = {}, requestOptions) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
             const { version_tag: versionTag } = request;
             const _queryParams = {};
             if (versionTag != null) {
                 _queryParams.version_tag = versionTag;
             }
-            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _headers = (0, headers_js_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({
+                Authorization: yield this._getAuthorizationHeader(),
+                "x-organization-api-key": (_b = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.organizationApiKey) !== null && _b !== void 0 ? _b : (_c = this._options) === null || _c === void 0 ? void 0 : _c.organizationApiKey,
+            }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
-                url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions/${core.url.encodePathParam(versionId)}/pull`),
+                url: core.url.join((_d = (yield core.Supplier.get(this._options.baseUrl))) !== null && _d !== void 0 ? _d : ((_e = (yield core.Supplier.get(this._options.environment))) !== null && _e !== void 0 ? _e : environments.ApolloEnvironment.Gcp).base, `management/v1/agents/${core.url.encodePathParam(agentId)}/versions/${core.url.encodePathParam(versionId)}/pull`),
                 method: "GET",
                 headers: _headers,
                 queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
-                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
-                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                timeoutMs: ((_h = (_f = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _f !== void 0 ? _f : (_g = this._options) === null || _g === void 0 ? void 0 : _g.timeoutInSeconds) !== null && _h !== void 0 ? _h : 60) * 1000,
+                maxRetries: (_j = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _j !== void 0 ? _j : (_k = this._options) === null || _k === void 0 ? void 0 : _k.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
-                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                fetchFn: (_l = this._options) === null || _l === void 0 ? void 0 : _l.fetch,
                 logging: this._options.logging,
             });
             if (_response.ok) {
@@ -645,5 +689,14 @@ class AgentVersions {
             }
         });
     }
+    _getAuthorizationHeader() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bearer = yield core.Supplier.get(this._options.token);
+            if (bearer != null) {
+                return `Bearer ${bearer}`;
+            }
+            return undefined;
+        });
+    }
 }
 exports.AgentVersions = AgentVersions;

package/dist/cjs/api/resources/agentVersions/client/requests/AgentVersionPushRequest.d.ts

@@ -10,7 +10,7 @@
 export interface AgentVersionPushRequest {
     caller: AgentVersionPushRequest.Caller;
     commit_message?: string;
-    /** Versioned agent-settings bundle. Must include 'schema_version' and 'general_settings'. */
+    /** Versioned agent configuration bundle. Must include 'schema_version' and 'general_settings'. */
     bundle: Record<string, unknown>;
 }
 export declare namespace AgentVersionPushRequest {

package/dist/cjs/api/resources/agents/client/Client.d.ts

@@ -9,8 +9,10 @@ export declare namespace Agents {
 }
 export declare class Agents {
     protected readonly _options: Agents.Options;
-    constructor(_options?: Agents.Options);
+    constructor(_options: Agents.Options);
     /**
+     * List the project's agents, optionally filtered by name.
+     *
      * @param {string} projectId
      * @param {Apollo.ListAgentsRequest} request
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
@@ -28,11 +30,14 @@ export declare class Agents {
      *         filters: {}
      *     })
      */
-    listAgents(projectId: string, request: Apollo.ListAgentsRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Apollo.ExternalPageExternalAgent>;
+    listAgents(projectId: string, request: Apollo.ListAgentsRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Apollo.PageAgent>;
     private __listAgents;
     /**
+     * Create an agent in the project. New agents start without a live version
+     * — create and publish a version to make the agent answer.
+     *
      * @param {string} projectId
-     * @param {Apollo.ExternalAgentCreateRequest} request
+     * @param {Apollo.AgentCreateRequest} request
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Apollo.BadRequestError}
@@ -48,9 +53,11 @@ export declare class Agents {
      *         name: "name"
      *     })
      */
-    createAgent(projectId: string, request: Apollo.ExternalAgentCreateRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Apollo.ExternalAgentCreateResponse>;
+    createAgent(projectId: string, request: Apollo.AgentCreateRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Apollo.AgentCreateResponse>;
     private __createAgent;
     /**
+     * Fetch one agent, including which version is currently live.
+     *
      * @param {string} agentId
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -65,9 +72,11 @@ export declare class Agents {
      * @example
      *     await client.agents.getAgent("agentId")
      */
-    getAgent(agentId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Apollo.ExternalAgent>;
+    getAgent(agentId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Apollo.Agent>;
     private __getAgent;
     /**
+     * Delete an agent and all of its versions. This cannot be undone.
+     *
      * @param {string} agentId
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
@@ -85,8 +94,11 @@ export declare class Agents {
     deleteAgent(agentId: string, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<void>;
     private __deleteAgent;
     /**
+     * Rename an agent. To change which version is live, publish a version
+     * instead.
+     *
      * @param {string} agentId
-     * @param {Apollo.ExternalAgentUpdateRequest} request
+     * @param {Apollo.AgentUpdateRequest} request
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Apollo.BadRequestError}
@@ -100,9 +112,11 @@ export declare class Agents {
      * @example
      *     await client.agents.updateAgent("agentId")
      */
-    updateAgent(agentId: string, request?: Apollo.ExternalAgentUpdateRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Apollo.ExternalAgentUpdateResponse>;
+    updateAgent(agentId: string, request?: Apollo.AgentUpdateRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Apollo.AgentUpdateResponse>;
     private __updateAgent;
     /**
+     * Usage metrics for one agent, optionally bounded by a date range.
+     *
      * @param {string} agentId
      * @param {Apollo.GetAgentUsageRequest} request
      * @param {Agents.RequestOptions} requestOptions - Request-specific configuration.
@@ -123,4 +137,5 @@ export declare class Agents {
      */
     getAgentUsage(agentId: string, request?: Apollo.GetAgentUsageRequest, requestOptions?: Agents.RequestOptions): core.HttpResponsePromise<Apollo.UsageResponse>;
     private __getAgentUsage;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
 }