@knowledge-stack/ksapi 2.15.0 → 3.0.0

package/dist/esm/apis/AdminWorkflowsApi.js

@@ -32,18 +32,18 @@ export class AdminWorkflowsApi extends runtime.BaseAPI {
     getAdminWorkflowByHourRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
-            if (requestParameters['since'] != null) {
-                queryParameters['since'] = requestParameters['since'].toISOString();
-            }
-            if (requestParameters['until'] != null) {
-                queryParameters['until'] = requestParameters['until'].toISOString();
-            }
             if (requestParameters['timezone'] != null) {
                 queryParameters['timezone'] = requestParameters['timezone'];
             }
             if (requestParameters['definitionId'] != null) {
                 queryParameters['definition_id'] = requestParameters['definitionId'];
             }
+            if (requestParameters['since'] != null) {
+                queryParameters['since'] = requestParameters['since'].toISOString();
+            }
+            if (requestParameters['until'] != null) {
+                queryParameters['until'] = requestParameters['until'].toISOString();
+            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -88,15 +88,15 @@ export class AdminWorkflowsApi extends runtime.BaseAPI {
     getAdminWorkflowLeaderboardRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
+            if (requestParameters['limit'] != null) {
+                queryParameters['limit'] = requestParameters['limit'];
+            }
             if (requestParameters['since'] != null) {
                 queryParameters['since'] = requestParameters['since'].toISOString();
             }
             if (requestParameters['until'] != null) {
                 queryParameters['until'] = requestParameters['until'].toISOString();
             }
-            if (requestParameters['limit'] != null) {
-                queryParameters['limit'] = requestParameters['limit'];
-            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -191,15 +191,15 @@ export class AdminWorkflowsApi extends runtime.BaseAPI {
     getAdminWorkflowSummaryRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
+            if (requestParameters['definitionId'] != null) {
+                queryParameters['definition_id'] = requestParameters['definitionId'];
+            }
             if (requestParameters['since'] != null) {
                 queryParameters['since'] = requestParameters['since'].toISOString();
             }
             if (requestParameters['until'] != null) {
                 queryParameters['until'] = requestParameters['until'].toISOString();
             }
-            if (requestParameters['definitionId'] != null) {
-                queryParameters['definition_id'] = requestParameters['definitionId'];
-            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;
@@ -244,6 +244,12 @@ export class AdminWorkflowsApi extends runtime.BaseAPI {
     getAdminWorkflowTimeseriesRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
+            if (requestParameters['timezone'] != null) {
+                queryParameters['timezone'] = requestParameters['timezone'];
+            }
+            if (requestParameters['definitionId'] != null) {
+                queryParameters['definition_id'] = requestParameters['definitionId'];
+            }
             if (requestParameters['since'] != null) {
                 queryParameters['since'] = requestParameters['since'].toISOString();
             }
@@ -253,12 +259,6 @@ export class AdminWorkflowsApi extends runtime.BaseAPI {
             if (requestParameters['bucket'] != null) {
                 queryParameters['bucket'] = requestParameters['bucket'];
             }
-            if (requestParameters['timezone'] != null) {
-                queryParameters['timezone'] = requestParameters['timezone'];
-            }
-            if (requestParameters['definitionId'] != null) {
-                queryParameters['definition_id'] = requestParameters['definitionId'];
-            }
             const headerParameters = {};
             if (this.configuration && this.configuration.accessToken) {
                 const token = this.configuration.accessToken;

package/dist/esm/apis/DocumentVersionsApi.d.ts

@@ -51,7 +51,7 @@ export interface ListDocumentVersionsRequest {
     documentId: string;
     sortBy?: DocumentVersionOrder;
     sortDir?: SortDirection;
-    uploaderTenantUserId?: string | null;
+    uploaderUserId?: string | null;
     limit?: number;
     offset?: number;
     createdAfter?: Date | null;
@@ -281,7 +281,7 @@ export interface DocumentVersionsApiInterface {
      * @param {string} documentId Document ID to list versions for
      * @param {DocumentVersionOrder} [sortBy] Field to sort versions by (default: VERSION)
      * @param {SortDirection} [sortDir] Sort direction; overrides the field\'s natural default
-     * @param {string} [uploaderTenantUserId] Filter to versions created by this user
+     * @param {string} [uploaderUserId] Filter to versions created by this user
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
@@ -298,7 +298,7 @@ export interface DocumentVersionsApiInterface {
      * @param {string} documentId Document ID to list versions for
      * @param {DocumentVersionOrder} [sortBy] Field to sort versions by (default: VERSION)
      * @param {SortDirection} [sortDir] Sort direction; overrides the field\'s natural default
-     * @param {string} [uploaderTenantUserId] Filter to versions created by this user
+     * @param {string} [uploaderUserId] Filter to versions created by this user
      * @param {number} [limit] Number of items per page
      * @param {number} [offset] Number of items to skip
      * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)

package/dist/esm/apis/DocumentVersionsApi.js

@@ -521,8 +521,8 @@ export class DocumentVersionsApi extends runtime.BaseAPI {
             if (requestParameters['sortDir'] != null) {
                 queryParameters['sort_dir'] = requestParameters['sortDir'];
             }
-            if (requestParameters['uploaderTenantUserId'] != null) {
-                queryParameters['uploader_tenant_user_id'] = requestParameters['uploaderTenantUserId'];
+            if (requestParameters['uploaderUserId'] != null) {
+                queryParameters['uploader_user_id'] = requestParameters['uploaderUserId'];
             }
             if (requestParameters['limit'] != null) {
                 queryParameters['limit'] = requestParameters['limit'];

package/docs/AdminKbApi.md

@@ -77,7 +77,7 @@ This endpoint does not need any parameter.
 
 ## getAdminKbTimeseries
 
-> KbTimeseriesResponse getAdminKbTimeseries(metric, since, until, bucket, timezone)
+> KbTimeseriesResponse getAdminKbTimeseries(metric, timezone, since, until, bucket)
 
 Get Admin Kb Timeseries Handler
 
@@ -105,14 +105,14 @@ async function example() {
   const body = {
     // KbMetric | Which KB metric to bucket.
     metric: ...,
-    // Date | Window start. (optional)
+    // string | IANA tz override; defaults to tenant setting. (optional)
+    timezone: timezone_example,
+    // Date | Window start (inclusive). Defaults to 7 days ago. (optional)
     since: 2013-10-20T19:20:30+01:00,
-    // Date | Window end. (optional)
+    // Date | Window end (inclusive). (optional)
     until: 2013-10-20T19:20:30+01:00,
     // TimeBucket | Bucket size. (optional)
     bucket: ...,
-    // string | IANA tz override; defaults to tenant setting. (optional)
-    timezone: timezone_example,
   } satisfies GetAdminKbTimeseriesRequest;
 
   try {
@@ -133,10 +133,10 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **metric** | `KbMetric` | Which KB metric to bucket. | [Defaults to `undefined`] [Enum: document_uploads, ingestion_completed, ingestion_failed, message, search] |
-| **since** | `Date` | Window start. | [Optional] [Defaults to `undefined`] |
-| **until** | `Date` | Window end. | [Optional] [Defaults to `undefined`] |
-| **bucket** | `TimeBucket` | Bucket size. | [Optional] [Defaults to `undefined`] [Enum: hour, day, week, month] |
 | **timezone** | `string` | IANA tz override; defaults to tenant setting. | [Optional] [Defaults to `undefined`] |
+| **since** | `Date` | Window start (inclusive). Defaults to 7 days ago. | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Window end (inclusive). | [Optional] [Defaults to `undefined`] |
+| **bucket** | `TimeBucket` | Bucket size. | [Optional] [Defaults to `undefined`] [Enum: hour, day, week, month] |
 
 ### Return type
 

package/docs/AdminWorkflowsApi.md

@@ -14,7 +14,7 @@ All URIs are relative to *http://localhost:8000*
 
 ## getAdminWorkflowByHour
 
-> HourHistogramResponse getAdminWorkflowByHour(since, until, timezone, definitionId)
+> HourHistogramResponse getAdminWorkflowByHour(timezone, definitionId, since, until)
 
 Get Admin Workflow By Hour Handler
 
@@ -40,14 +40,14 @@ async function example() {
   const api = new AdminWorkflowsApi(config);
 
   const body = {
-    // Date | Window start. (optional)
-    since: 2013-10-20T19:20:30+01:00,
-    // Date | Window end. (optional)
-    until: 2013-10-20T19:20:30+01:00,
     // string | IANA tz override; defaults to tenant setting. (optional)
     timezone: timezone_example,
     // string | Scope to one workflow. (optional)
     definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Date | Window start (inclusive). Defaults to 7 days ago. (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Window end (inclusive). (optional)
+    until: 2013-10-20T19:20:30+01:00,
   } satisfies GetAdminWorkflowByHourRequest;
 
   try {
@@ -67,10 +67,10 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **since** | `Date` | Window start. | [Optional] [Defaults to `undefined`] |
-| **until** | `Date` | Window end. | [Optional] [Defaults to `undefined`] |
 | **timezone** | `string` | IANA tz override; defaults to tenant setting. | [Optional] [Defaults to `undefined`] |
 | **definitionId** | `string` | Scope to one workflow. | [Optional] [Defaults to `undefined`] |
+| **since** | `Date` | Window start (inclusive). Defaults to 7 days ago. | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Window end (inclusive). | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -98,7 +98,7 @@ example().catch(console.error);
 
 ## getAdminWorkflowLeaderboard
 
-> WorkflowLeaderboardResponse getAdminWorkflowLeaderboard(since, until, limit)
+> WorkflowLeaderboardResponse getAdminWorkflowLeaderboard(limit, since, until)
 
 Get Admin Workflow Leaderboard Handler
 
@@ -124,12 +124,12 @@ async function example() {
   const api = new AdminWorkflowsApi(config);
 
   const body = {
-    // Date | Window start. (optional)
-    since: 2013-10-20T19:20:30+01:00,
-    // Date | Window end. (optional)
-    until: 2013-10-20T19:20:30+01:00,
     // number | Top-N per leaderboard. (optional)
     limit: 56,
+    // Date | Window start (inclusive). Defaults to 7 days ago. (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Window end (inclusive). (optional)
+    until: 2013-10-20T19:20:30+01:00,
   } satisfies GetAdminWorkflowLeaderboardRequest;
 
   try {
@@ -149,9 +149,9 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **since** | `Date` | Window start. | [Optional] [Defaults to `undefined`] |
-| **until** | `Date` | Window end. | [Optional] [Defaults to `undefined`] |
 | **limit** | `number` | Top-N per leaderboard. | [Optional] [Defaults to `10`] |
+| **since** | `Date` | Window start (inclusive). Defaults to 7 days ago. | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Window end (inclusive). | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -205,9 +205,9 @@ async function example() {
   const api = new AdminWorkflowsApi(config);
 
   const body = {
-    // Date | Window start. (optional)
+    // Date | Window start (inclusive). Defaults to 7 days ago. (optional)
     since: 2013-10-20T19:20:30+01:00,
-    // Date | Window end. (optional)
+    // Date | Window end (inclusive). (optional)
     until: 2013-10-20T19:20:30+01:00,
   } satisfies GetAdminWorkflowOutputStatsRequest;
 
@@ -228,8 +228,8 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **since** | `Date` | Window start. | [Optional] [Defaults to `undefined`] |
-| **until** | `Date` | Window end. | [Optional] [Defaults to `undefined`] |
+| **since** | `Date` | Window start (inclusive). Defaults to 7 days ago. | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Window end (inclusive). | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -257,7 +257,7 @@ example().catch(console.error);
 
 ## getAdminWorkflowSummary
 
-> WorkflowRunSummaryResponse getAdminWorkflowSummary(since, until, definitionId)
+> WorkflowRunSummaryResponse getAdminWorkflowSummary(definitionId, since, until)
 
 Get Admin Workflow Summary Handler
 
@@ -283,12 +283,12 @@ async function example() {
   const api = new AdminWorkflowsApi(config);
 
   const body = {
+    // string | Scope all numbers to one workflow. (optional)
+    definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // Date | Window start (inclusive). Defaults to 7 days ago. (optional)
     since: 2013-10-20T19:20:30+01:00,
     // Date | Window end (inclusive). (optional)
     until: 2013-10-20T19:20:30+01:00,
-    // string | Scope all numbers to one workflow. (optional)
-    definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
   } satisfies GetAdminWorkflowSummaryRequest;
 
   try {
@@ -308,9 +308,9 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **definitionId** | `string` | Scope all numbers to one workflow. | [Optional] [Defaults to `undefined`] |
 | **since** | `Date` | Window start (inclusive). Defaults to 7 days ago. | [Optional] [Defaults to `undefined`] |
 | **until** | `Date` | Window end (inclusive). | [Optional] [Defaults to `undefined`] |
-| **definitionId** | `string` | Scope all numbers to one workflow. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -338,7 +338,7 @@ example().catch(console.error);
 
 ## getAdminWorkflowTimeseries
 
-> RunTimeseriesResponse getAdminWorkflowTimeseries(since, until, bucket, timezone, definitionId)
+> RunTimeseriesResponse getAdminWorkflowTimeseries(timezone, definitionId, since, until, bucket)
 
 Get Admin Workflow Timeseries Handler
 
@@ -364,16 +364,16 @@ async function example() {
   const api = new AdminWorkflowsApi(config);
 
   const body = {
-    // Date | Window start. (optional)
-    since: 2013-10-20T19:20:30+01:00,
-    // Date | Window end. (optional)
-    until: 2013-10-20T19:20:30+01:00,
-    // TimeBucket | Bucket size. (optional)
-    bucket: ...,
     // string | IANA tz override; defaults to tenant setting. (optional)
     timezone: timezone_example,
     // string | Scope to one workflow. (optional)
     definitionId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Date | Window start (inclusive). Defaults to 7 days ago. (optional)
+    since: 2013-10-20T19:20:30+01:00,
+    // Date | Window end (inclusive). (optional)
+    until: 2013-10-20T19:20:30+01:00,
+    // TimeBucket | Bucket size. (optional)
+    bucket: ...,
   } satisfies GetAdminWorkflowTimeseriesRequest;
 
   try {
@@ -393,11 +393,11 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **since** | `Date` | Window start. | [Optional] [Defaults to `undefined`] |
-| **until** | `Date` | Window end. | [Optional] [Defaults to `undefined`] |
-| **bucket** | `TimeBucket` | Bucket size. | [Optional] [Defaults to `undefined`] [Enum: hour, day, week, month] |
 | **timezone** | `string` | IANA tz override; defaults to tenant setting. | [Optional] [Defaults to `undefined`] |
 | **definitionId** | `string` | Scope to one workflow. | [Optional] [Defaults to `undefined`] |
+| **since** | `Date` | Window start (inclusive). Defaults to 7 days ago. | [Optional] [Defaults to `undefined`] |
+| **until** | `Date` | Window end (inclusive). | [Optional] [Defaults to `undefined`] |
+| **bucket** | `TimeBucket` | Bucket size. | [Optional] [Defaults to `undefined`] [Enum: hour, day, week, month] |
 
 ### Return type
 

package/docs/DocumentVersionsApi.md

@@ -720,7 +720,7 @@ example().catch(console.error);
 
 ## listDocumentVersions
 
-> PaginatedResponseDocumentVersionResponse listDocumentVersions(documentId, sortBy, sortDir, uploaderTenantUserId, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
+> PaginatedResponseDocumentVersionResponse listDocumentVersions(documentId, sortBy, sortDir, uploaderUserId, limit, offset, createdAfter, createdBefore, updatedAfter, updatedBefore)
 
 List Document Versions Handler
 
@@ -753,7 +753,7 @@ async function example() {
     // SortDirection | Sort direction; overrides the field\'s natural default (optional)
     sortDir: ...,
     // string | Filter to versions created by this user (optional)
-    uploaderTenantUserId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    uploaderUserId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
     // number | Number of items per page (optional)
     limit: 56,
     // number | Number of items to skip (optional)
@@ -788,7 +788,7 @@ example().catch(console.error);
 | **documentId** | `string` | Document ID to list versions for | [Defaults to `undefined`] |
 | **sortBy** | `DocumentVersionOrder` | Field to sort versions by (default: VERSION) | [Optional] [Defaults to `undefined`] [Enum: VERSION, CREATED_AT] |
 | **sortDir** | `SortDirection` | Sort direction; overrides the field\'s natural default | [Optional] [Defaults to `undefined`] [Enum: ASC, DESC] |
-| **uploaderTenantUserId** | `string` | Filter to versions created by this user | [Optional] [Defaults to `undefined`] |
+| **uploaderUserId** | `string` | Filter to versions created by this user | [Optional] [Defaults to `undefined`] |
 | **limit** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
 | **offset** | `number` | Number of items to skip | [Optional] [Defaults to `0`] |
 | **createdAfter** | `Date` | Only items created at or after this timestamp (inclusive) | [Optional] [Defaults to `undefined`] |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "2.15.0",
+  "version": "3.0.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AdminKbApi.ts

@@ -39,10 +39,10 @@ import {
 
 export interface GetAdminKbTimeseriesRequest {
     metric: KbMetric;
+    timezone?: string | null;
     since?: Date | null;
     until?: Date | null;
     bucket?: TimeBucket;
-    timezone?: string | null;
 }
 
 /**
@@ -77,10 +77,10 @@ export interface AdminKbApiInterface {
     /**
      * Creates request options for getAdminKbTimeseries without sending the request
      * @param {KbMetric} metric Which KB metric to bucket.
-     * @param {Date} [since] Window start.
-     * @param {Date} [until] Window end.
-     * @param {TimeBucket} [bucket] Bucket size.
      * @param {string} [timezone] IANA tz override; defaults to tenant setting.
+     * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
+     * @param {Date} [until] Window end (inclusive).
+     * @param {TimeBucket} [bucket] Bucket size.
      * @throws {RequiredError}
      * @memberof AdminKbApiInterface
      */
@@ -90,10 +90,10 @@ export interface AdminKbApiInterface {
      * A knowledge-base metric bucketed over time, in the resolved timezone.
      * @summary Get Admin Kb Timeseries Handler
      * @param {KbMetric} metric Which KB metric to bucket.
-     * @param {Date} [since] Window start.
-     * @param {Date} [until] Window end.
-     * @param {TimeBucket} [bucket] Bucket size.
      * @param {string} [timezone] IANA tz override; defaults to tenant setting.
+     * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
+     * @param {Date} [until] Window end (inclusive).
+     * @param {TimeBucket} [bucket] Bucket size.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AdminKbApiInterface
@@ -177,6 +177,10 @@ export class AdminKbApi extends runtime.BaseAPI implements AdminKbApiInterface {
             queryParameters['metric'] = requestParameters['metric'];
         }
 
+        if (requestParameters['timezone'] != null) {
+            queryParameters['timezone'] = requestParameters['timezone'];
+        }
+
         if (requestParameters['since'] != null) {
             queryParameters['since'] = (requestParameters['since'] as any).toISOString();
         }
@@ -189,10 +193,6 @@ export class AdminKbApi extends runtime.BaseAPI implements AdminKbApiInterface {
             queryParameters['bucket'] = requestParameters['bucket'];
         }
 
-        if (requestParameters['timezone'] != null) {
-            queryParameters['timezone'] = requestParameters['timezone'];
-        }
-
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {