@pairsystems/goodmem-client 1.0.3 → 1.0.5

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 (40) hide show
  1. package/README.md +205 -15
  2. package/dist/api/AdministrationApi.js +158 -0
  3. package/dist/api/LLMsApi.js +263 -0
  4. package/dist/api/MemoriesApi.js +53 -6
  5. package/dist/api/SystemApi.js +39 -5
  6. package/dist/index.js +175 -0
  7. package/dist/model/ActiveLicenseMetadata.js +140 -0
  8. package/dist/model/AdminDrainRequest.js +105 -0
  9. package/dist/model/AdminDrainResponse.js +132 -0
  10. package/dist/model/AdminPurgeJobsRequest.js +117 -0
  11. package/dist/model/AdminPurgeJobsResponse.js +138 -0
  12. package/dist/model/AdminReloadLicenseResponse.js +115 -0
  13. package/dist/model/ApiKeyAuth.js +131 -0
  14. package/dist/model/BackgroundJobAttempt.js +242 -0
  15. package/dist/model/BackgroundJobSummary.js +215 -0
  16. package/dist/model/BatchMemoryRetrievalRequest.js +9 -0
  17. package/dist/model/CreateLLMResponse.js +146 -0
  18. package/dist/model/CredentialKind.js +63 -0
  19. package/dist/model/EmbedderCreationRequest.js +11 -12
  20. package/dist/model/EndpointAuthentication.js +149 -0
  21. package/dist/model/GcpAdcAuth.js +104 -0
  22. package/dist/model/LLMCapabilities.js +132 -0
  23. package/dist/model/LLMCreationRequest.js +317 -0
  24. package/dist/model/LLMProviderType.js +83 -0
  25. package/dist/model/LLMResponse.js +366 -0
  26. package/dist/model/LLMSamplingParams.js +145 -0
  27. package/dist/model/LLMUpdateRequest.js +275 -0
  28. package/dist/model/ListLLMsResponse.js +132 -0
  29. package/dist/model/Memory.js +36 -0
  30. package/dist/model/PostProcessor.js +4 -4
  31. package/dist/model/ProcessingHistory.js +126 -0
  32. package/dist/model/ProviderType.js +15 -0
  33. package/dist/model/RerankerCreationRequest.js +7 -6
  34. package/dist/model/SecretReference.js +101 -0
  35. package/dist/model/SpaceKey.js +13 -0
  36. package/dist/model/SystemInfoResponse.js +192 -0
  37. package/dist/model/UpdateEmbedderRequest.js +7 -6
  38. package/dist/model/UpdateRerankerRequest.js +7 -6
  39. package/dist/streaming.js +246 -43
  40. package/package.json +2 -1
package/README.md CHANGED
@@ -6,7 +6,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
6
6
 
7
7
  - API version:
8
8
  - Package version: 1.0.0
9
- - Generator version: 7.16.0-SNAPSHOT
9
+ - Generator version: 7.18.0-SNAPSHOT
10
10
  - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
11
11
 
12
12
  ## Installation
@@ -101,16 +101,20 @@ Please follow the [installation](#installation) instruction and execute the foll
101
101
  ```javascript
102
102
  var GoodMemClient = require('@pairsystems/goodmem-client');
103
103
 
104
+ // Configure the API client
105
+ var defaultClient = GoodMemClient.ApiClient.instance;
106
+ defaultClient.basePath = "http://localhost:8080"; // Use your server URL
107
+
108
+ // Configure API key authentication: X-API-Key header
109
+ defaultClient.defaultHeaders = {
110
+ "X-API-Key": "your-api-key-here",
111
+ "Content-Type": "application/json",
112
+ "Accept": "application/json"
113
+ };
114
+
104
115
 
105
116
  var api = new GoodMemClient.APIKeysApi()
106
- var createApiKeyRequest = {
107
- "labels": {
108
- "environment": "development",
109
- "service": "chat-ui"
110
- },
111
- "expiresAt": 1735689600000
112
- }
113
- ; // {CreateApiKeyRequest} API key configuration
117
+ var createApiKeyRequest = {"labels":{"environment":"development","service":"chat-ui"},"expiresAt":"1735689600000"}; // {CreateApiKeyRequest} API key configuration
114
118
  api.createApiKey(createApiKeyRequest).then(function(data) {
115
119
  console.log('API called successfully. Returned data: ' + data);
116
120
  }, function(error) {
@@ -120,6 +124,159 @@ api.createApiKey(createApiKeyRequest).then(function(data) {
120
124
 
121
125
  ```
122
126
 
127
+
128
+
129
+ ## Streaming Memory Retrieval
130
+
131
+ The GoodMem JavaScript client provides a `StreamingClient` class for real-time streaming memory retrieval. This is the **recommended approach** for memory retrieval operations.
132
+
133
+ ### Supported Formats
134
+
135
+ The StreamingClient supports two streaming formats:
136
+
137
+ - **NDJSON** (`application/x-ndjson`) - Newline-delimited JSON (default, recommended)
138
+ - **SSE** (`text/event-stream`) - Server-Sent Events
139
+
140
+ ### Basic Streaming with ChatPostProcessor
141
+
142
+ Use `retrieveMemoryStreamChat()` for streaming with automatic ChatPostProcessor configuration:
143
+
144
+ ```javascript
145
+ const GoodMemClient = require('@pairsystems/goodmem-client');
146
+ const { StreamingClient } = GoodMemClient;
147
+
148
+ // Configure client
149
+ const defaultClient = GoodMemClient.ApiClient.instance;
150
+ defaultClient.basePath = 'http://localhost:8080';
151
+ defaultClient.defaultHeaders = {
152
+ 'X-API-Key': 'your-api-key'
153
+ };
154
+
155
+ // Create streaming client
156
+ const streamingClient = new StreamingClient(defaultClient);
157
+
158
+ // Create abort controller
159
+ const controller = new AbortController();
160
+
161
+ // Stream with ChatPostProcessor (NDJSON format)
162
+ streamingClient.retrieveMemoryStreamChat(
163
+ controller.signal,
164
+ 'your search query',
165
+ ['space-uuid'],
166
+ 10, // requested size
167
+ true, // fetch memory
168
+ false, // fetch memory content
169
+ 'ndjson', // format (ndjson or sse)
170
+ 'llm-uuid', // LLM ID
171
+ 'reranker-uuid', // reranker ID
172
+ 0.5, // relevance threshold
173
+ 0.3, // LLM temperature
174
+ 10, // max results
175
+ true // chronological resort
176
+ ).then(async (stream) => {
177
+ for await (const event of stream) {
178
+ if (event.abstractReply) {
179
+ console.log('Abstract:', event.abstractReply.text);
180
+ } else if (event.retrievedItem && event.retrievedItem.memory) {
181
+ console.log('Memory:', event.retrievedItem.memory);
182
+ }
183
+ }
184
+ }).catch(error => {
185
+ console.error('Streaming error:', error);
186
+ });
187
+ ```
188
+
189
+ ### Advanced Streaming with Custom Post-Processor
190
+
191
+ Use `retrieveMemoryStreamAdvanced()` for custom post-processor configuration:
192
+
193
+ ```javascript
194
+ // Create advanced request
195
+ const request = {
196
+ message: 'your search query',
197
+ spaceIds: ['space-uuid'],
198
+ requestedSize: 10,
199
+ fetchMemory: true,
200
+ fetchMemoryContent: false,
201
+ format: 'ndjson', // or 'sse'
202
+ postProcessorName: 'com.goodmem.retrieval.postprocess.ChatPostProcessorFactory',
203
+ postProcessorConfig: {
204
+ llm_id: 'llm-uuid',
205
+ reranker_id: 'reranker-uuid',
206
+ relevance_threshold: 0.5,
207
+ llm_temp: 0.3,
208
+ max_results: 10,
209
+ chronological_resort: true
210
+ }
211
+ };
212
+
213
+ // Execute advanced streaming
214
+ streamingClient.retrieveMemoryStreamAdvanced(controller.signal, request)
215
+ .then(async (stream) => {
216
+ for await (const event of stream) {
217
+ if (event.abstractReply) {
218
+ console.log('Abstract:', event.abstractReply.text);
219
+ } else if (event.retrievedItem) {
220
+ console.log('Retrieved:', event.retrievedItem);
221
+ }
222
+ }
223
+ }).catch(error => {
224
+ console.error('Streaming error:', error);
225
+ });
226
+ ```
227
+
228
+ ### Choosing Between NDJSON and SSE
229
+
230
+ - **NDJSON** (recommended): Simpler parsing, better for most use cases
231
+ - **SSE**: Standard browser EventSource API compatible, useful for web applications
232
+
233
+
234
+ ## Authentication
235
+
236
+ Configure API key authentication by setting the X-API-Key header:
237
+
238
+ ```javascript
239
+ var GoodMemClient = require("@pairsystems/goodmem-client");
240
+
241
+ // Configure the API client
242
+ var defaultClient = GoodMemClient.ApiClient.instance;
243
+ defaultClient.basePath = "http://localhost:8080"; // Use your server URL
244
+
245
+ // Configure API key authentication
246
+ defaultClient.defaultHeaders = {
247
+ "X-API-Key": "your-api-key-here",
248
+ "Content-Type": "application/json",
249
+ "Accept": "application/json"
250
+ };
251
+
252
+ // Create API instances
253
+ var apiKeysApi = new GoodMemClient.APIKeysApi();
254
+ var spacesApi = new GoodMemClient.SpacesApi();
255
+ ```
256
+
257
+ ### Getting an API Key
258
+
259
+ You can create an API key using the APIKeysApi:
260
+
261
+ ```javascript
262
+ var createRequest = {
263
+ labels: {
264
+ "environment": "development",
265
+ "service": "your-app-name"
266
+ }
267
+ };
268
+
269
+ apiKeysApi.createApiKey(createRequest).then(function(response) {
270
+ console.log("API Key created successfully:");
271
+ console.log("Key ID:", response.apiKeyMetadata.apiKeyId);
272
+ console.log("Raw API Key:", response.rawApiKey);
273
+ console.log("Key Prefix:", response.apiKeyMetadata.keyPrefix);
274
+ }, function(error) {
275
+ console.error("Error creating API key:", error);
276
+ });
277
+ ```
278
+
279
+
123
280
  ## Documentation for API Endpoints
124
281
 
125
282
  All URIs are relative to *http://localhost*
@@ -130,20 +287,29 @@ Class | Method | HTTP request | Description
130
287
  *GoodMemClient.APIKeysApi* | [**deleteApiKey**](docs/APIKeysApi.md#deleteApiKey) | **DELETE** /v1/apikeys/{id} | Delete an API key
131
288
  *GoodMemClient.APIKeysApi* | [**listApiKeys**](docs/APIKeysApi.md#listApiKeys) | **GET** /v1/apikeys | List API keys
132
289
  *GoodMemClient.APIKeysApi* | [**updateApiKey**](docs/APIKeysApi.md#updateApiKey) | **PUT** /v1/apikeys/{id} | Update an API key
290
+ *GoodMemClient.AdministrationApi* | [**drainServer**](docs/AdministrationApi.md#drainServer) | **POST** /v1/admin:drain | Request the server to enter drain mode
291
+ *GoodMemClient.AdministrationApi* | [**purgeBackgroundJobs**](docs/AdministrationApi.md#purgeBackgroundJobs) | **POST** /v1/admin/background-jobs:purge | Purge completed background jobs
292
+ *GoodMemClient.AdministrationApi* | [**reloadLicense**](docs/AdministrationApi.md#reloadLicense) | **POST** /v1/admin/license:reload | Reload the active license from disk
133
293
  *GoodMemClient.EmbeddersApi* | [**createEmbedder**](docs/EmbeddersApi.md#createEmbedder) | **POST** /v1/embedders | Create a new embedder
134
294
  *GoodMemClient.EmbeddersApi* | [**deleteEmbedder**](docs/EmbeddersApi.md#deleteEmbedder) | **DELETE** /v1/embedders/{id} | Delete an embedder
135
295
  *GoodMemClient.EmbeddersApi* | [**getEmbedder**](docs/EmbeddersApi.md#getEmbedder) | **GET** /v1/embedders/{id} | Get an embedder by ID
136
296
  *GoodMemClient.EmbeddersApi* | [**listEmbedders**](docs/EmbeddersApi.md#listEmbedders) | **GET** /v1/embedders | List embedders
137
297
  *GoodMemClient.EmbeddersApi* | [**updateEmbedder**](docs/EmbeddersApi.md#updateEmbedder) | **PUT** /v1/embedders/{id} | Update an embedder
138
- *GoodMemClient.MemoriesApi* | [**batchCreateMemory**](docs/MemoriesApi.md#batchCreateMemory) | **POST** /v1/memories/batch | Create multiple memories in a batch
139
- *GoodMemClient.MemoriesApi* | [**batchDeleteMemory**](docs/MemoriesApi.md#batchDeleteMemory) | **POST** /v1/memories/batch/delete | Delete multiple memories by ID
140
- *GoodMemClient.MemoriesApi* | [**batchGetMemory**](docs/MemoriesApi.md#batchGetMemory) | **POST** /v1/memories/batch/get | Get multiple memories by ID
298
+ *GoodMemClient.LLMsApi* | [**createLLM**](docs/LLMsApi.md#createLLM) | **POST** /v1/llms | Create a new LLM
299
+ *GoodMemClient.LLMsApi* | [**deleteLLM**](docs/LLMsApi.md#deleteLLM) | **DELETE** /v1/llms/{id} | Delete an LLM
300
+ *GoodMemClient.LLMsApi* | [**getLLM**](docs/LLMsApi.md#getLLM) | **GET** /v1/llms/{id} | Get an LLM by ID
301
+ *GoodMemClient.LLMsApi* | [**listLLMs**](docs/LLMsApi.md#listLLMs) | **GET** /v1/llms | List LLMs
302
+ *GoodMemClient.LLMsApi* | [**updateLLM**](docs/LLMsApi.md#updateLLM) | **PUT** /v1/llms/{id} | Update an LLM
303
+ *GoodMemClient.MemoriesApi* | [**batchCreateMemory**](docs/MemoriesApi.md#batchCreateMemory) | **POST** /v1/memories:batchCreate | Create multiple memories in a batch
304
+ *GoodMemClient.MemoriesApi* | [**batchDeleteMemory**](docs/MemoriesApi.md#batchDeleteMemory) | **POST** /v1/memories:batchDelete | Delete multiple memories by ID
305
+ *GoodMemClient.MemoriesApi* | [**batchGetMemory**](docs/MemoriesApi.md#batchGetMemory) | **POST** /v1/memories:batchGet | Get multiple memories by ID
141
306
  *GoodMemClient.MemoriesApi* | [**createMemory**](docs/MemoriesApi.md#createMemory) | **POST** /v1/memories | Create a new memory
142
307
  *GoodMemClient.MemoriesApi* | [**deleteMemory**](docs/MemoriesApi.md#deleteMemory) | **DELETE** /v1/memories/{id} | Delete a memory
143
308
  *GoodMemClient.MemoriesApi* | [**getMemory**](docs/MemoriesApi.md#getMemory) | **GET** /v1/memories/{id} | Get a memory by ID
309
+ *GoodMemClient.MemoriesApi* | [**getMemoryContent**](docs/MemoriesApi.md#getMemoryContent) | **GET** /v1/memories/{id}/content | Download memory content
144
310
  *GoodMemClient.MemoriesApi* | [**listMemories**](docs/MemoriesApi.md#listMemories) | **GET** /v1/spaces/{spaceId}/memories | List memories in a space
145
- *GoodMemClient.MemoriesApi* | [**retrieveMemory**](docs/MemoriesApi.md#retrieveMemory) | **GET** /v1/memories/retrieve | Stream semantic memory retrieval
146
- *GoodMemClient.MemoriesApi* | [**retrieveMemoryAdvanced**](docs/MemoriesApi.md#retrieveMemoryAdvanced) | **POST** /v1/memories/retrieve | Advanced semantic memory retrieval with JSON
311
+ *GoodMemClient.MemoriesApi* | [**retrieveMemory**](docs/MemoriesApi.md#retrieveMemory) | **GET** /v1/memories:retrieve | Stream semantic memory retrieval
312
+ *GoodMemClient.MemoriesApi* | [**retrieveMemoryAdvanced**](docs/MemoriesApi.md#retrieveMemoryAdvanced) | **POST** /v1/memories:retrieve | Advanced semantic memory retrieval with JSON
147
313
  *GoodMemClient.RerankersApi* | [**createReranker**](docs/RerankersApi.md#createReranker) | **POST** /v1/rerankers | Create a new reranker
148
314
  *GoodMemClient.RerankersApi* | [**deleteReranker**](docs/RerankersApi.md#deleteReranker) | **DELETE** /v1/rerankers/{id} | Delete a reranker
149
315
  *GoodMemClient.RerankersApi* | [**getReranker**](docs/RerankersApi.md#getReranker) | **GET** /v1/rerankers/{id} | Get a reranker by ID
@@ -154,6 +320,7 @@ Class | Method | HTTP request | Description
154
320
  *GoodMemClient.SpacesApi* | [**getSpace**](docs/SpacesApi.md#getSpace) | **GET** /v1/spaces/{id} | Get a space by ID
155
321
  *GoodMemClient.SpacesApi* | [**listSpaces**](docs/SpacesApi.md#listSpaces) | **GET** /v1/spaces | List spaces
156
322
  *GoodMemClient.SpacesApi* | [**updateSpace**](docs/SpacesApi.md#updateSpace) | **PUT** /v1/spaces/{id} | Update a space
323
+ *GoodMemClient.SystemApi* | [**getSystemInfo**](docs/SystemApi.md#getSystemInfo) | **GET** /v1/system/info | Retrieve server build metadata
157
324
  *GoodMemClient.SystemApi* | [**initializeSystem**](docs/SystemApi.md#initializeSystem) | **POST** /v1/system/init | Initialize the system
158
325
  *GoodMemClient.UsersApi* | [**getCurrentUser**](docs/UsersApi.md#getCurrentUser) | **GET** /v1/users/me | Get current user profile
159
326
  *GoodMemClient.UsersApi* | [**getUser**](docs/UsersApi.md#getUser) | **GET** /v1/users/{id} | Get a user by ID
@@ -163,7 +330,16 @@ Class | Method | HTTP request | Description
163
330
  ## Documentation for Models
164
331
 
165
332
  - [GoodMemClient.AbstractReply](docs/AbstractReply.md)
333
+ - [GoodMemClient.ActiveLicenseMetadata](docs/ActiveLicenseMetadata.md)
334
+ - [GoodMemClient.AdminDrainRequest](docs/AdminDrainRequest.md)
335
+ - [GoodMemClient.AdminDrainResponse](docs/AdminDrainResponse.md)
336
+ - [GoodMemClient.AdminPurgeJobsRequest](docs/AdminPurgeJobsRequest.md)
337
+ - [GoodMemClient.AdminPurgeJobsResponse](docs/AdminPurgeJobsResponse.md)
338
+ - [GoodMemClient.AdminReloadLicenseResponse](docs/AdminReloadLicenseResponse.md)
339
+ - [GoodMemClient.ApiKeyAuth](docs/ApiKeyAuth.md)
166
340
  - [GoodMemClient.ApiKeyResponse](docs/ApiKeyResponse.md)
341
+ - [GoodMemClient.BackgroundJobAttempt](docs/BackgroundJobAttempt.md)
342
+ - [GoodMemClient.BackgroundJobSummary](docs/BackgroundJobSummary.md)
167
343
  - [GoodMemClient.BatchMemoryCreationRequest](docs/BatchMemoryCreationRequest.md)
168
344
  - [GoodMemClient.BatchMemoryDeletionRequest](docs/BatchMemoryDeletionRequest.md)
169
345
  - [GoodMemClient.BatchMemoryRetrievalRequest](docs/BatchMemoryRetrievalRequest.md)
@@ -173,14 +349,25 @@ Class | Method | HTTP request | Description
173
349
  - [GoodMemClient.ContextItem](docs/ContextItem.md)
174
350
  - [GoodMemClient.CreateApiKeyRequest](docs/CreateApiKeyRequest.md)
175
351
  - [GoodMemClient.CreateApiKeyResponse](docs/CreateApiKeyResponse.md)
352
+ - [GoodMemClient.CreateLLMResponse](docs/CreateLLMResponse.md)
353
+ - [GoodMemClient.CredentialKind](docs/CredentialKind.md)
176
354
  - [GoodMemClient.DistributionType](docs/DistributionType.md)
177
355
  - [GoodMemClient.EmbedderCreationRequest](docs/EmbedderCreationRequest.md)
178
356
  - [GoodMemClient.EmbedderResponse](docs/EmbedderResponse.md)
179
357
  - [GoodMemClient.EmbedderWeight](docs/EmbedderWeight.md)
358
+ - [GoodMemClient.EndpointAuthentication](docs/EndpointAuthentication.md)
359
+ - [GoodMemClient.GcpAdcAuth](docs/GcpAdcAuth.md)
180
360
  - [GoodMemClient.GoodMemStatus](docs/GoodMemStatus.md)
361
+ - [GoodMemClient.LLMCapabilities](docs/LLMCapabilities.md)
362
+ - [GoodMemClient.LLMCreationRequest](docs/LLMCreationRequest.md)
363
+ - [GoodMemClient.LLMProviderType](docs/LLMProviderType.md)
364
+ - [GoodMemClient.LLMResponse](docs/LLMResponse.md)
365
+ - [GoodMemClient.LLMSamplingParams](docs/LLMSamplingParams.md)
366
+ - [GoodMemClient.LLMUpdateRequest](docs/LLMUpdateRequest.md)
181
367
  - [GoodMemClient.LengthMeasurement](docs/LengthMeasurement.md)
182
368
  - [GoodMemClient.ListApiKeysResponse](docs/ListApiKeysResponse.md)
183
369
  - [GoodMemClient.ListEmbeddersResponse](docs/ListEmbeddersResponse.md)
370
+ - [GoodMemClient.ListLLMsResponse](docs/ListLLMsResponse.md)
184
371
  - [GoodMemClient.ListRerankersResponse](docs/ListRerankersResponse.md)
185
372
  - [GoodMemClient.ListSpacesResponse](docs/ListSpacesResponse.md)
186
373
  - [GoodMemClient.Memory](docs/Memory.md)
@@ -189,6 +376,7 @@ Class | Method | HTTP request | Description
189
376
  - [GoodMemClient.MemoryListResponse](docs/MemoryListResponse.md)
190
377
  - [GoodMemClient.Modality](docs/Modality.md)
191
378
  - [GoodMemClient.PostProcessor](docs/PostProcessor.md)
379
+ - [GoodMemClient.ProcessingHistory](docs/ProcessingHistory.md)
192
380
  - [GoodMemClient.ProviderType](docs/ProviderType.md)
193
381
  - [GoodMemClient.RecursiveChunkingConfiguration](docs/RecursiveChunkingConfiguration.md)
194
382
  - [GoodMemClient.RerankerCreationRequest](docs/RerankerCreationRequest.md)
@@ -197,6 +385,7 @@ Class | Method | HTTP request | Description
197
385
  - [GoodMemClient.RetrieveMemoryEvent](docs/RetrieveMemoryEvent.md)
198
386
  - [GoodMemClient.RetrieveMemoryRequest](docs/RetrieveMemoryRequest.md)
199
387
  - [GoodMemClient.RetrievedItem](docs/RetrievedItem.md)
388
+ - [GoodMemClient.SecretReference](docs/SecretReference.md)
200
389
  - [GoodMemClient.SentenceChunkingConfiguration](docs/SentenceChunkingConfiguration.md)
201
390
  - [GoodMemClient.SeparatorKeepStrategy](docs/SeparatorKeepStrategy.md)
202
391
  - [GoodMemClient.Space](docs/Space.md)
@@ -204,6 +393,7 @@ Class | Method | HTTP request | Description
204
393
  - [GoodMemClient.SpaceEmbedder](docs/SpaceEmbedder.md)
205
394
  - [GoodMemClient.SpaceEmbedderConfig](docs/SpaceEmbedderConfig.md)
206
395
  - [GoodMemClient.SpaceKey](docs/SpaceKey.md)
396
+ - [GoodMemClient.SystemInfoResponse](docs/SystemInfoResponse.md)
207
397
  - [GoodMemClient.SystemInitResponse](docs/SystemInitResponse.md)
208
398
  - [GoodMemClient.UpdateApiKeyRequest](docs/UpdateApiKeyRequest.md)
209
399
  - [GoodMemClient.UpdateEmbedderRequest](docs/UpdateEmbedderRequest.md)
@@ -214,5 +404,5 @@ Class | Method | HTTP request | Description
214
404
 
215
405
  ## Documentation for Authorization
216
406
 
217
- Endpoints do not require authorization.
407
+ Authentication required - see configuration below.
218
408
 
@@ -0,0 +1,158 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _ApiClient = _interopRequireDefault(require("../ApiClient"));
8
+ var _AdminDrainRequest = _interopRequireDefault(require("../model/AdminDrainRequest"));
9
+ var _AdminDrainResponse = _interopRequireDefault(require("../model/AdminDrainResponse"));
10
+ var _AdminPurgeJobsRequest = _interopRequireDefault(require("../model/AdminPurgeJobsRequest"));
11
+ var _AdminPurgeJobsResponse = _interopRequireDefault(require("../model/AdminPurgeJobsResponse"));
12
+ var _AdminReloadLicenseResponse = _interopRequireDefault(require("../model/AdminReloadLicenseResponse"));
13
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
14
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
15
+ function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
16
+ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
17
+ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
18
+ function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
19
+ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
20
+ *
21
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
22
+ *
23
+ * The version of the OpenAPI document:
24
+ *
25
+ *
26
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
27
+ * https://openapi-generator.tech
28
+ * Do not edit the class manually.
29
+ *
30
+ */
31
+ /**
32
+ * Administration service.
33
+ * @module api/AdministrationApi
34
+ * @version 1.0.0
35
+ */
36
+ var AdministrationApi = exports["default"] = /*#__PURE__*/function () {
37
+ /**
38
+ * Constructs a new AdministrationApi.
39
+ * @alias module:api/AdministrationApi
40
+ * @class
41
+ * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
42
+ * default to {@link module:ApiClient#instance} if unspecified.
43
+ */
44
+ function AdministrationApi(apiClient) {
45
+ _classCallCheck(this, AdministrationApi);
46
+ this.apiClient = apiClient || _ApiClient["default"].instance;
47
+ }
48
+
49
+ /**
50
+ * Request the server to enter drain mode
51
+ * Initiates drain mode and optionally waits for the server to quiesce.
52
+ * @param {Object} opts Optional parameters
53
+ * @param {module:model/AdminDrainRequest} [adminDrainRequest]
54
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminDrainResponse} and HTTP response
55
+ */
56
+ return _createClass(AdministrationApi, [{
57
+ key: "drainServerWithHttpInfo",
58
+ value: function drainServerWithHttpInfo(opts) {
59
+ opts = opts || {};
60
+ var postBody = opts['adminDrainRequest'];
61
+ var pathParams = {};
62
+ var queryParams = {};
63
+ var headerParams = {};
64
+ var formParams = {};
65
+ var authNames = [];
66
+ var contentTypes = ['application/json'];
67
+ var accepts = ['application/json'];
68
+ var returnType = _AdminDrainResponse["default"];
69
+ return this.apiClient.callApi('/v1/admin:drain', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
70
+ }
71
+
72
+ /**
73
+ * Request the server to enter drain mode
74
+ * Initiates drain mode and optionally waits for the server to quiesce.
75
+ * @param {Object} opts Optional parameters
76
+ * @param {module:model/AdminDrainRequest} opts.adminDrainRequest
77
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminDrainResponse}
78
+ */
79
+ }, {
80
+ key: "drainServer",
81
+ value: function drainServer(opts) {
82
+ return this.drainServerWithHttpInfo(opts).then(function (response_and_data) {
83
+ return response_and_data.data;
84
+ });
85
+ }
86
+
87
+ /**
88
+ * Purge completed background jobs
89
+ * Deletes terminal background jobs older than a retention cutoff.
90
+ * @param {Object} opts Optional parameters
91
+ * @param {module:model/AdminPurgeJobsRequest} [adminPurgeJobsRequest]
92
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminPurgeJobsResponse} and HTTP response
93
+ */
94
+ }, {
95
+ key: "purgeBackgroundJobsWithHttpInfo",
96
+ value: function purgeBackgroundJobsWithHttpInfo(opts) {
97
+ opts = opts || {};
98
+ var postBody = opts['adminPurgeJobsRequest'];
99
+ var pathParams = {};
100
+ var queryParams = {};
101
+ var headerParams = {};
102
+ var formParams = {};
103
+ var authNames = [];
104
+ var contentTypes = ['application/json'];
105
+ var accepts = ['application/json'];
106
+ var returnType = _AdminPurgeJobsResponse["default"];
107
+ return this.apiClient.callApi('/v1/admin/background-jobs:purge', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
108
+ }
109
+
110
+ /**
111
+ * Purge completed background jobs
112
+ * Deletes terminal background jobs older than a retention cutoff.
113
+ * @param {Object} opts Optional parameters
114
+ * @param {module:model/AdminPurgeJobsRequest} opts.adminPurgeJobsRequest
115
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminPurgeJobsResponse}
116
+ */
117
+ }, {
118
+ key: "purgeBackgroundJobs",
119
+ value: function purgeBackgroundJobs(opts) {
120
+ return this.purgeBackgroundJobsWithHttpInfo(opts).then(function (response_and_data) {
121
+ return response_and_data.data;
122
+ });
123
+ }
124
+
125
+ /**
126
+ * Reload the active license from disk
127
+ * Triggers the server to reload its license file from the configured directory and returns metadata about the currently active license.
128
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/AdminReloadLicenseResponse} and HTTP response
129
+ */
130
+ }, {
131
+ key: "reloadLicenseWithHttpInfo",
132
+ value: function reloadLicenseWithHttpInfo() {
133
+ var postBody = null;
134
+ var pathParams = {};
135
+ var queryParams = {};
136
+ var headerParams = {};
137
+ var formParams = {};
138
+ var authNames = [];
139
+ var contentTypes = [];
140
+ var accepts = ['application/json'];
141
+ var returnType = _AdminReloadLicenseResponse["default"];
142
+ return this.apiClient.callApi('/v1/admin/license:reload', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
143
+ }
144
+
145
+ /**
146
+ * Reload the active license from disk
147
+ * Triggers the server to reload its license file from the configured directory and returns metadata about the currently active license.
148
+ * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AdminReloadLicenseResponse}
149
+ */
150
+ }, {
151
+ key: "reloadLicense",
152
+ value: function reloadLicense() {
153
+ return this.reloadLicenseWithHttpInfo().then(function (response_and_data) {
154
+ return response_and_data.data;
155
+ });
156
+ }
157
+ }]);
158
+ }();