@knowledge-stack/ksapi 2.15.0 → 3.0.0

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 (20) hide show
  1. package/README.md +2 -2
  2. package/dist/apis/AdminKbApi.d.ts +7 -7
  3. package/dist/apis/AdminKbApi.js +3 -3
  4. package/dist/apis/AdminWorkflowsApi.d.ts +26 -26
  5. package/dist/apis/AdminWorkflowsApi.js +18 -18
  6. package/dist/apis/DocumentVersionsApi.d.ts +3 -3
  7. package/dist/apis/DocumentVersionsApi.js +2 -2
  8. package/dist/esm/apis/AdminKbApi.d.ts +7 -7
  9. package/dist/esm/apis/AdminKbApi.js +3 -3
  10. package/dist/esm/apis/AdminWorkflowsApi.d.ts +26 -26
  11. package/dist/esm/apis/AdminWorkflowsApi.js +18 -18
  12. package/dist/esm/apis/DocumentVersionsApi.d.ts +3 -3
  13. package/dist/esm/apis/DocumentVersionsApi.js +2 -2
  14. package/docs/AdminKbApi.md +8 -8
  15. package/docs/AdminWorkflowsApi.md +32 -32
  16. package/docs/DocumentVersionsApi.md +3 -3
  17. package/package.json +1 -1
  18. package/src/apis/AdminKbApi.ts +11 -11
  19. package/src/apis/AdminWorkflowsApi.ts +50 -50
  20. package/src/apis/DocumentVersionsApi.ts +5 -5
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@2.15.0
1
+ # @knowledge-stack/ksapi@3.0.0
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -727,7 +727,7 @@ and is automatically generated by the
727
727
  [OpenAPI Generator](https://openapi-generator.tech) project:
728
728
 
729
729
  - API version: `0.1.0`
730
- - Package version: `2.15.0`
730
+ - Package version: `3.0.0`
731
731
  - Generator version: `7.21.0`
732
732
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
733
733
 
package/dist/apis/AdminKbApi.d.ts CHANGED
@@ -13,10 +13,10 @@ import * as runtime from '../runtime';
13
13
  import type { KbMetric, KbSummaryResponse, KbTimeseriesResponse, TimeBucket } from '../models/index';
14
14
  export interface GetAdminKbTimeseriesRequest {
15
15
  metric: KbMetric;
16
+ timezone?: string | null;
16
17
  since?: Date | null;
17
18
  until?: Date | null;
18
19
  bucket?: TimeBucket;
19
- timezone?: string | null;
20
20
  }
21
21
  /**
22
22
  * AdminKbApi - interface
@@ -47,10 +47,10 @@ export interface AdminKbApiInterface {
47
47
  /**
48
48
  * Creates request options for getAdminKbTimeseries without sending the request
49
49
  * @param {KbMetric} metric Which KB metric to bucket.
50
- * @param {Date} [since] Window start.
51
- * @param {Date} [until] Window end.
52
- * @param {TimeBucket} [bucket] Bucket size.
53
50
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
51
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
52
+ * @param {Date} [until] Window end (inclusive).
53
+ * @param {TimeBucket} [bucket] Bucket size.
54
54
  * @throws {RequiredError}
55
55
  * @memberof AdminKbApiInterface
56
56
  */
@@ -59,10 +59,10 @@ export interface AdminKbApiInterface {
59
59
  * A knowledge-base metric bucketed over time, in the resolved timezone.
60
60
  * @summary Get Admin Kb Timeseries Handler
61
61
  * @param {KbMetric} metric Which KB metric to bucket.
62
- * @param {Date} [since] Window start.
63
- * @param {Date} [until] Window end.
64
- * @param {TimeBucket} [bucket] Bucket size.
65
62
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
63
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
64
+ * @param {Date} [until] Window end (inclusive).
65
+ * @param {TimeBucket} [bucket] Bucket size.
66
66
  * @param {*} [options] Override http request option.
67
67
  * @throws {RequiredError}
68
68
  * @memberof AdminKbApiInterface
package/dist/apis/AdminKbApi.js CHANGED
@@ -118,6 +118,9 @@ class AdminKbApi extends runtime.BaseAPI {
118
118
  if (requestParameters['metric'] != null) {
119
119
  queryParameters['metric'] = requestParameters['metric'];
120
120
  }
121
+ if (requestParameters['timezone'] != null) {
122
+ queryParameters['timezone'] = requestParameters['timezone'];
123
+ }
121
124
  if (requestParameters['since'] != null) {
122
125
  queryParameters['since'] = requestParameters['since'].toISOString();
123
126
  }
@@ -127,9 +130,6 @@ class AdminKbApi extends runtime.BaseAPI {
127
130
  if (requestParameters['bucket'] != null) {
128
131
  queryParameters['bucket'] = requestParameters['bucket'];
129
132
  }
130
- if (requestParameters['timezone'] != null) {
131
- queryParameters['timezone'] = requestParameters['timezone'];
132
- }
133
133
  const headerParameters = {};
134
134
  if (this.configuration && this.configuration.accessToken) {
135
135
  const token = this.configuration.accessToken;
package/dist/apis/AdminWorkflowsApi.d.ts CHANGED
@@ -12,31 +12,31 @@
12
12
  import * as runtime from '../runtime';
13
13
  import type { HourHistogramResponse, RunTimeseriesResponse, TimeBucket, WorkflowLeaderboardResponse, WorkflowOutputStatsResponse, WorkflowRunSummaryResponse } from '../models/index';
14
14
  export interface GetAdminWorkflowByHourRequest {
15
- since?: Date | null;
16
- until?: Date | null;
17
15
  timezone?: string | null;
18
16
  definitionId?: string | null;
17
+ since?: Date | null;
18
+ until?: Date | null;
19
19
  }
20
20
  export interface GetAdminWorkflowLeaderboardRequest {
21
+ limit?: number;
21
22
  since?: Date | null;
22
23
  until?: Date | null;
23
- limit?: number;
24
24
  }
25
25
  export interface GetAdminWorkflowOutputStatsRequest {
26
26
  since?: Date | null;
27
27
  until?: Date | null;
28
28
  }
29
29
  export interface GetAdminWorkflowSummaryRequest {
30
+ definitionId?: string | null;
30
31
  since?: Date | null;
31
32
  until?: Date | null;
32
- definitionId?: string | null;
33
33
  }
34
34
  export interface GetAdminWorkflowTimeseriesRequest {
35
+ timezone?: string | null;
36
+ definitionId?: string | null;
35
37
  since?: Date | null;
36
38
  until?: Date | null;
37
39
  bucket?: TimeBucket;
38
- timezone?: string | null;
39
- definitionId?: string | null;
40
40
  }
41
41
  /**
42
42
  * AdminWorkflowsApi - interface
@@ -47,10 +47,10 @@ export interface GetAdminWorkflowTimeseriesRequest {
47
47
  export interface AdminWorkflowsApiInterface {
48
48
  /**
49
49
  * Creates request options for getAdminWorkflowByHour without sending the request
50
- * @param {Date} [since] Window start.
51
- * @param {Date} [until] Window end.
52
50
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
53
51
  * @param {string} [definitionId] Scope to one workflow.
52
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
53
+ * @param {Date} [until] Window end (inclusive).
54
54
  * @throws {RequiredError}
55
55
  * @memberof AdminWorkflowsApiInterface
56
56
  */
@@ -58,10 +58,10 @@ export interface AdminWorkflowsApiInterface {
58
58
  /**
59
59
  * Runs per hour-of-day (0-23) in the resolved timezone.
60
60
  * @summary Get Admin Workflow By Hour Handler
61
- * @param {Date} [since] Window start.
62
- * @param {Date} [until] Window end.
63
61
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
64
62
  * @param {string} [definitionId] Scope to one workflow.
63
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
64
+ * @param {Date} [until] Window end (inclusive).
65
65
  * @param {*} [options] Override http request option.
66
66
  * @throws {RequiredError}
67
67
  * @memberof AdminWorkflowsApiInterface
@@ -74,9 +74,9 @@ export interface AdminWorkflowsApiInterface {
74
74
  getAdminWorkflowByHour(requestParameters: GetAdminWorkflowByHourRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HourHistogramResponse>;
75
75
  /**
76
76
  * Creates request options for getAdminWorkflowLeaderboard without sending the request
77
- * @param {Date} [since] Window start.
78
- * @param {Date} [until] Window end.
79
77
  * @param {number} [limit] Top-N per leaderboard.
78
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
79
+ * @param {Date} [until] Window end (inclusive).
80
80
  * @throws {RequiredError}
81
81
  * @memberof AdminWorkflowsApiInterface
82
82
  */
@@ -84,9 +84,9 @@ export interface AdminWorkflowsApiInterface {
84
84
  /**
85
85
  * Top workflows and top run owners by run count.
86
86
  * @summary Get Admin Workflow Leaderboard Handler
87
- * @param {Date} [since] Window start.
88
- * @param {Date} [until] Window end.
89
87
  * @param {number} [limit] Top-N per leaderboard.
88
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
89
+ * @param {Date} [until] Window end (inclusive).
90
90
  * @param {*} [options] Override http request option.
91
91
  * @throws {RequiredError}
92
92
  * @memberof AdminWorkflowsApiInterface
@@ -99,8 +99,8 @@ export interface AdminWorkflowsApiInterface {
99
99
  getAdminWorkflowLeaderboard(requestParameters: GetAdminWorkflowLeaderboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowLeaderboardResponse>;
100
100
  /**
101
101
  * Creates request options for getAdminWorkflowOutputStats without sending the request
102
- * @param {Date} [since] Window start.
103
- * @param {Date} [until] Window end.
102
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
103
+ * @param {Date} [until] Window end (inclusive).
104
104
  * @throws {RequiredError}
105
105
  * @memberof AdminWorkflowsApiInterface
106
106
  */
@@ -108,8 +108,8 @@ export interface AdminWorkflowsApiInterface {
108
108
  /**
109
109
  * Average output DOCUMENTs generated per workflow definition (completed runs).
110
110
  * @summary Get Admin Workflow Output Stats Handler
111
- * @param {Date} [since] Window start.
112
- * @param {Date} [until] Window end.
111
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
112
+ * @param {Date} [until] Window end (inclusive).
113
113
  * @param {*} [options] Override http request option.
114
114
  * @throws {RequiredError}
115
115
  * @memberof AdminWorkflowsApiInterface
@@ -122,9 +122,9 @@ export interface AdminWorkflowsApiInterface {
122
122
  getAdminWorkflowOutputStats(requestParameters: GetAdminWorkflowOutputStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowOutputStatsResponse>;
123
123
  /**
124
124
  * Creates request options for getAdminWorkflowSummary without sending the request
125
+ * @param {string} [definitionId] Scope all numbers to one workflow.
125
126
  * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
126
127
  * @param {Date} [until] Window end (inclusive).
127
- * @param {string} [definitionId] Scope all numbers to one workflow.
128
128
  * @throws {RequiredError}
129
129
  * @memberof AdminWorkflowsApiInterface
130
130
  */
@@ -132,9 +132,9 @@ export interface AdminWorkflowsApiInterface {
132
132
  /**
133
133
  * Tenant-wide run health: counts, failure rate, durations, approval backlog.
134
134
  * @summary Get Admin Workflow Summary Handler
135
+ * @param {string} [definitionId] Scope all numbers to one workflow.
135
136
  * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
136
137
  * @param {Date} [until] Window end (inclusive).
137
- * @param {string} [definitionId] Scope all numbers to one workflow.
138
138
  * @param {*} [options] Override http request option.
139
139
  * @throws {RequiredError}
140
140
  * @memberof AdminWorkflowsApiInterface
@@ -147,11 +147,11 @@ export interface AdminWorkflowsApiInterface {
147
147
  getAdminWorkflowSummary(requestParameters: GetAdminWorkflowSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunSummaryResponse>;
148
148
  /**
149
149
  * Creates request options for getAdminWorkflowTimeseries without sending the request
150
- * @param {Date} [since] Window start.
151
- * @param {Date} [until] Window end.
152
- * @param {TimeBucket} [bucket] Bucket size.
153
150
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
154
151
  * @param {string} [definitionId] Scope to one workflow.
152
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
153
+ * @param {Date} [until] Window end (inclusive).
154
+ * @param {TimeBucket} [bucket] Bucket size.
155
155
  * @throws {RequiredError}
156
156
  * @memberof AdminWorkflowsApiInterface
157
157
  */
@@ -159,11 +159,11 @@ export interface AdminWorkflowsApiInterface {
159
159
  /**
160
160
  * Run counts bucketed over time, in the resolved timezone.
161
161
  * @summary Get Admin Workflow Timeseries Handler
162
- * @param {Date} [since] Window start.
163
- * @param {Date} [until] Window end.
164
- * @param {TimeBucket} [bucket] Bucket size.
165
162
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
166
163
  * @param {string} [definitionId] Scope to one workflow.
164
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
165
+ * @param {Date} [until] Window end (inclusive).
166
+ * @param {TimeBucket} [bucket] Bucket size.
167
167
  * @param {*} [options] Override http request option.
168
168
  * @throws {RequiredError}
169
169
  * @memberof AdminWorkflowsApiInterface
package/dist/apis/AdminWorkflowsApi.js CHANGED
@@ -68,18 +68,18 @@ class AdminWorkflowsApi extends runtime.BaseAPI {
68
68
  getAdminWorkflowByHourRequestOpts(requestParameters) {
69
69
  return __awaiter(this, void 0, void 0, function* () {
70
70
  const queryParameters = {};
71
- if (requestParameters['since'] != null) {
72
- queryParameters['since'] = requestParameters['since'].toISOString();
73
- }
74
- if (requestParameters['until'] != null) {
75
- queryParameters['until'] = requestParameters['until'].toISOString();
76
- }
77
71
  if (requestParameters['timezone'] != null) {
78
72
  queryParameters['timezone'] = requestParameters['timezone'];
79
73
  }
80
74
  if (requestParameters['definitionId'] != null) {
81
75
  queryParameters['definition_id'] = requestParameters['definitionId'];
82
76
  }
77
+ if (requestParameters['since'] != null) {
78
+ queryParameters['since'] = requestParameters['since'].toISOString();
79
+ }
80
+ if (requestParameters['until'] != null) {
81
+ queryParameters['until'] = requestParameters['until'].toISOString();
82
+ }
83
83
  const headerParameters = {};
84
84
  if (this.configuration && this.configuration.accessToken) {
85
85
  const token = this.configuration.accessToken;
@@ -124,15 +124,15 @@ class AdminWorkflowsApi extends runtime.BaseAPI {
124
124
  getAdminWorkflowLeaderboardRequestOpts(requestParameters) {
125
125
  return __awaiter(this, void 0, void 0, function* () {
126
126
  const queryParameters = {};
127
+ if (requestParameters['limit'] != null) {
128
+ queryParameters['limit'] = requestParameters['limit'];
129
+ }
127
130
  if (requestParameters['since'] != null) {
128
131
  queryParameters['since'] = requestParameters['since'].toISOString();
129
132
  }
130
133
  if (requestParameters['until'] != null) {
131
134
  queryParameters['until'] = requestParameters['until'].toISOString();
132
135
  }
133
- if (requestParameters['limit'] != null) {
134
- queryParameters['limit'] = requestParameters['limit'];
135
- }
136
136
  const headerParameters = {};
137
137
  if (this.configuration && this.configuration.accessToken) {
138
138
  const token = this.configuration.accessToken;
@@ -227,15 +227,15 @@ class AdminWorkflowsApi extends runtime.BaseAPI {
227
227
  getAdminWorkflowSummaryRequestOpts(requestParameters) {
228
228
  return __awaiter(this, void 0, void 0, function* () {
229
229
  const queryParameters = {};
230
+ if (requestParameters['definitionId'] != null) {
231
+ queryParameters['definition_id'] = requestParameters['definitionId'];
232
+ }
230
233
  if (requestParameters['since'] != null) {
231
234
  queryParameters['since'] = requestParameters['since'].toISOString();
232
235
  }
233
236
  if (requestParameters['until'] != null) {
234
237
  queryParameters['until'] = requestParameters['until'].toISOString();
235
238
  }
236
- if (requestParameters['definitionId'] != null) {
237
- queryParameters['definition_id'] = requestParameters['definitionId'];
238
- }
239
239
  const headerParameters = {};
240
240
  if (this.configuration && this.configuration.accessToken) {
241
241
  const token = this.configuration.accessToken;
@@ -280,6 +280,12 @@ class AdminWorkflowsApi extends runtime.BaseAPI {
280
280
  getAdminWorkflowTimeseriesRequestOpts(requestParameters) {
281
281
  return __awaiter(this, void 0, void 0, function* () {
282
282
  const queryParameters = {};
283
+ if (requestParameters['timezone'] != null) {
284
+ queryParameters['timezone'] = requestParameters['timezone'];
285
+ }
286
+ if (requestParameters['definitionId'] != null) {
287
+ queryParameters['definition_id'] = requestParameters['definitionId'];
288
+ }
283
289
  if (requestParameters['since'] != null) {
284
290
  queryParameters['since'] = requestParameters['since'].toISOString();
285
291
  }
@@ -289,12 +295,6 @@ class AdminWorkflowsApi extends runtime.BaseAPI {
289
295
  if (requestParameters['bucket'] != null) {
290
296
  queryParameters['bucket'] = requestParameters['bucket'];
291
297
  }
292
- if (requestParameters['timezone'] != null) {
293
- queryParameters['timezone'] = requestParameters['timezone'];
294
- }
295
- if (requestParameters['definitionId'] != null) {
296
- queryParameters['definition_id'] = requestParameters['definitionId'];
297
- }
298
298
  const headerParameters = {};
299
299
  if (this.configuration && this.configuration.accessToken) {
300
300
  const token = this.configuration.accessToken;
package/dist/apis/DocumentVersionsApi.d.ts CHANGED
@@ -51,7 +51,7 @@ export interface ListDocumentVersionsRequest {
51
51
  documentId: string;
52
52
  sortBy?: DocumentVersionOrder;
53
53
  sortDir?: SortDirection;
54
- uploaderTenantUserId?: string | null;
54
+ uploaderUserId?: string | null;
55
55
  limit?: number;
56
56
  offset?: number;
57
57
  createdAfter?: Date | null;
@@ -281,7 +281,7 @@ export interface DocumentVersionsApiInterface {
281
281
  * @param {string} documentId Document ID to list versions for
282
282
  * @param {DocumentVersionOrder} [sortBy] Field to sort versions by (default: VERSION)
283
283
  * @param {SortDirection} [sortDir] Sort direction; overrides the field\&#39;s natural default
284
- * @param {string} [uploaderTenantUserId] Filter to versions created by this user
284
+ * @param {string} [uploaderUserId] Filter to versions created by this user
285
285
  * @param {number} [limit] Number of items per page
286
286
  * @param {number} [offset] Number of items to skip
287
287
  * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
@@ -298,7 +298,7 @@ export interface DocumentVersionsApiInterface {
298
298
  * @param {string} documentId Document ID to list versions for
299
299
  * @param {DocumentVersionOrder} [sortBy] Field to sort versions by (default: VERSION)
300
300
  * @param {SortDirection} [sortDir] Sort direction; overrides the field\&#39;s natural default
301
- * @param {string} [uploaderTenantUserId] Filter to versions created by this user
301
+ * @param {string} [uploaderUserId] Filter to versions created by this user
302
302
  * @param {number} [limit] Number of items per page
303
303
  * @param {number} [offset] Number of items to skip
304
304
  * @param {Date} [createdAfter] Only items created at or after this timestamp (inclusive)
package/dist/apis/DocumentVersionsApi.js CHANGED
@@ -557,8 +557,8 @@ class DocumentVersionsApi extends runtime.BaseAPI {
557
557
  if (requestParameters['sortDir'] != null) {
558
558
  queryParameters['sort_dir'] = requestParameters['sortDir'];
559
559
  }
560
- if (requestParameters['uploaderTenantUserId'] != null) {
561
- queryParameters['uploader_tenant_user_id'] = requestParameters['uploaderTenantUserId'];
560
+ if (requestParameters['uploaderUserId'] != null) {
561
+ queryParameters['uploader_user_id'] = requestParameters['uploaderUserId'];
562
562
  }
563
563
  if (requestParameters['limit'] != null) {
564
564
  queryParameters['limit'] = requestParameters['limit'];
package/dist/esm/apis/AdminKbApi.d.ts CHANGED
@@ -13,10 +13,10 @@ import * as runtime from '../runtime';
13
13
  import type { KbMetric, KbSummaryResponse, KbTimeseriesResponse, TimeBucket } from '../models/index';
14
14
  export interface GetAdminKbTimeseriesRequest {
15
15
  metric: KbMetric;
16
+ timezone?: string | null;
16
17
  since?: Date | null;
17
18
  until?: Date | null;
18
19
  bucket?: TimeBucket;
19
- timezone?: string | null;
20
20
  }
21
21
  /**
22
22
  * AdminKbApi - interface
@@ -47,10 +47,10 @@ export interface AdminKbApiInterface {
47
47
  /**
48
48
  * Creates request options for getAdminKbTimeseries without sending the request
49
49
  * @param {KbMetric} metric Which KB metric to bucket.
50
- * @param {Date} [since] Window start.
51
- * @param {Date} [until] Window end.
52
- * @param {TimeBucket} [bucket] Bucket size.
53
50
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
51
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
52
+ * @param {Date} [until] Window end (inclusive).
53
+ * @param {TimeBucket} [bucket] Bucket size.
54
54
  * @throws {RequiredError}
55
55
  * @memberof AdminKbApiInterface
56
56
  */
@@ -59,10 +59,10 @@ export interface AdminKbApiInterface {
59
59
  * A knowledge-base metric bucketed over time, in the resolved timezone.
60
60
  * @summary Get Admin Kb Timeseries Handler
61
61
  * @param {KbMetric} metric Which KB metric to bucket.
62
- * @param {Date} [since] Window start.
63
- * @param {Date} [until] Window end.
64
- * @param {TimeBucket} [bucket] Bucket size.
65
62
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
63
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
64
+ * @param {Date} [until] Window end (inclusive).
65
+ * @param {TimeBucket} [bucket] Bucket size.
66
66
  * @param {*} [options] Override http request option.
67
67
  * @throws {RequiredError}
68
68
  * @memberof AdminKbApiInterface
package/dist/esm/apis/AdminKbApi.js CHANGED
@@ -82,6 +82,9 @@ export class AdminKbApi extends runtime.BaseAPI {
82
82
  if (requestParameters['metric'] != null) {
83
83
  queryParameters['metric'] = requestParameters['metric'];
84
84
  }
85
+ if (requestParameters['timezone'] != null) {
86
+ queryParameters['timezone'] = requestParameters['timezone'];
87
+ }
85
88
  if (requestParameters['since'] != null) {
86
89
  queryParameters['since'] = requestParameters['since'].toISOString();
87
90
  }
@@ -91,9 +94,6 @@ export class AdminKbApi extends runtime.BaseAPI {
91
94
  if (requestParameters['bucket'] != null) {
92
95
  queryParameters['bucket'] = requestParameters['bucket'];
93
96
  }
94
- if (requestParameters['timezone'] != null) {
95
- queryParameters['timezone'] = requestParameters['timezone'];
96
- }
97
97
  const headerParameters = {};
98
98
  if (this.configuration && this.configuration.accessToken) {
99
99
  const token = this.configuration.accessToken;
package/dist/esm/apis/AdminWorkflowsApi.d.ts CHANGED
@@ -12,31 +12,31 @@
12
12
  import * as runtime from '../runtime';
13
13
  import type { HourHistogramResponse, RunTimeseriesResponse, TimeBucket, WorkflowLeaderboardResponse, WorkflowOutputStatsResponse, WorkflowRunSummaryResponse } from '../models/index';
14
14
  export interface GetAdminWorkflowByHourRequest {
15
- since?: Date | null;
16
- until?: Date | null;
17
15
  timezone?: string | null;
18
16
  definitionId?: string | null;
17
+ since?: Date | null;
18
+ until?: Date | null;
19
19
  }
20
20
  export interface GetAdminWorkflowLeaderboardRequest {
21
+ limit?: number;
21
22
  since?: Date | null;
22
23
  until?: Date | null;
23
- limit?: number;
24
24
  }
25
25
  export interface GetAdminWorkflowOutputStatsRequest {
26
26
  since?: Date | null;
27
27
  until?: Date | null;
28
28
  }
29
29
  export interface GetAdminWorkflowSummaryRequest {
30
+ definitionId?: string | null;
30
31
  since?: Date | null;
31
32
  until?: Date | null;
32
- definitionId?: string | null;
33
33
  }
34
34
  export interface GetAdminWorkflowTimeseriesRequest {
35
+ timezone?: string | null;
36
+ definitionId?: string | null;
35
37
  since?: Date | null;
36
38
  until?: Date | null;
37
39
  bucket?: TimeBucket;
38
- timezone?: string | null;
39
- definitionId?: string | null;
40
40
  }
41
41
  /**
42
42
  * AdminWorkflowsApi - interface
@@ -47,10 +47,10 @@ export interface GetAdminWorkflowTimeseriesRequest {
47
47
  export interface AdminWorkflowsApiInterface {
48
48
  /**
49
49
  * Creates request options for getAdminWorkflowByHour without sending the request
50
- * @param {Date} [since] Window start.
51
- * @param {Date} [until] Window end.
52
50
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
53
51
  * @param {string} [definitionId] Scope to one workflow.
52
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
53
+ * @param {Date} [until] Window end (inclusive).
54
54
  * @throws {RequiredError}
55
55
  * @memberof AdminWorkflowsApiInterface
56
56
  */
@@ -58,10 +58,10 @@ export interface AdminWorkflowsApiInterface {
58
58
  /**
59
59
  * Runs per hour-of-day (0-23) in the resolved timezone.
60
60
  * @summary Get Admin Workflow By Hour Handler
61
- * @param {Date} [since] Window start.
62
- * @param {Date} [until] Window end.
63
61
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
64
62
  * @param {string} [definitionId] Scope to one workflow.
63
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
64
+ * @param {Date} [until] Window end (inclusive).
65
65
  * @param {*} [options] Override http request option.
66
66
  * @throws {RequiredError}
67
67
  * @memberof AdminWorkflowsApiInterface
@@ -74,9 +74,9 @@ export interface AdminWorkflowsApiInterface {
74
74
  getAdminWorkflowByHour(requestParameters: GetAdminWorkflowByHourRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HourHistogramResponse>;
75
75
  /**
76
76
  * Creates request options for getAdminWorkflowLeaderboard without sending the request
77
- * @param {Date} [since] Window start.
78
- * @param {Date} [until] Window end.
79
77
  * @param {number} [limit] Top-N per leaderboard.
78
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
79
+ * @param {Date} [until] Window end (inclusive).
80
80
  * @throws {RequiredError}
81
81
  * @memberof AdminWorkflowsApiInterface
82
82
  */
@@ -84,9 +84,9 @@ export interface AdminWorkflowsApiInterface {
84
84
  /**
85
85
  * Top workflows and top run owners by run count.
86
86
  * @summary Get Admin Workflow Leaderboard Handler
87
- * @param {Date} [since] Window start.
88
- * @param {Date} [until] Window end.
89
87
  * @param {number} [limit] Top-N per leaderboard.
88
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
89
+ * @param {Date} [until] Window end (inclusive).
90
90
  * @param {*} [options] Override http request option.
91
91
  * @throws {RequiredError}
92
92
  * @memberof AdminWorkflowsApiInterface
@@ -99,8 +99,8 @@ export interface AdminWorkflowsApiInterface {
99
99
  getAdminWorkflowLeaderboard(requestParameters: GetAdminWorkflowLeaderboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowLeaderboardResponse>;
100
100
  /**
101
101
  * Creates request options for getAdminWorkflowOutputStats without sending the request
102
- * @param {Date} [since] Window start.
103
- * @param {Date} [until] Window end.
102
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
103
+ * @param {Date} [until] Window end (inclusive).
104
104
  * @throws {RequiredError}
105
105
  * @memberof AdminWorkflowsApiInterface
106
106
  */
@@ -108,8 +108,8 @@ export interface AdminWorkflowsApiInterface {
108
108
  /**
109
109
  * Average output DOCUMENTs generated per workflow definition (completed runs).
110
110
  * @summary Get Admin Workflow Output Stats Handler
111
- * @param {Date} [since] Window start.
112
- * @param {Date} [until] Window end.
111
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
112
+ * @param {Date} [until] Window end (inclusive).
113
113
  * @param {*} [options] Override http request option.
114
114
  * @throws {RequiredError}
115
115
  * @memberof AdminWorkflowsApiInterface
@@ -122,9 +122,9 @@ export interface AdminWorkflowsApiInterface {
122
122
  getAdminWorkflowOutputStats(requestParameters: GetAdminWorkflowOutputStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowOutputStatsResponse>;
123
123
  /**
124
124
  * Creates request options for getAdminWorkflowSummary without sending the request
125
+ * @param {string} [definitionId] Scope all numbers to one workflow.
125
126
  * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
126
127
  * @param {Date} [until] Window end (inclusive).
127
- * @param {string} [definitionId] Scope all numbers to one workflow.
128
128
  * @throws {RequiredError}
129
129
  * @memberof AdminWorkflowsApiInterface
130
130
  */
@@ -132,9 +132,9 @@ export interface AdminWorkflowsApiInterface {
132
132
  /**
133
133
  * Tenant-wide run health: counts, failure rate, durations, approval backlog.
134
134
  * @summary Get Admin Workflow Summary Handler
135
+ * @param {string} [definitionId] Scope all numbers to one workflow.
135
136
  * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
136
137
  * @param {Date} [until] Window end (inclusive).
137
- * @param {string} [definitionId] Scope all numbers to one workflow.
138
138
  * @param {*} [options] Override http request option.
139
139
  * @throws {RequiredError}
140
140
  * @memberof AdminWorkflowsApiInterface
@@ -147,11 +147,11 @@ export interface AdminWorkflowsApiInterface {
147
147
  getAdminWorkflowSummary(requestParameters: GetAdminWorkflowSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunSummaryResponse>;
148
148
  /**
149
149
  * Creates request options for getAdminWorkflowTimeseries without sending the request
150
- * @param {Date} [since] Window start.
151
- * @param {Date} [until] Window end.
152
- * @param {TimeBucket} [bucket] Bucket size.
153
150
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
154
151
  * @param {string} [definitionId] Scope to one workflow.
152
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
153
+ * @param {Date} [until] Window end (inclusive).
154
+ * @param {TimeBucket} [bucket] Bucket size.
155
155
  * @throws {RequiredError}
156
156
  * @memberof AdminWorkflowsApiInterface
157
157
  */
@@ -159,11 +159,11 @@ export interface AdminWorkflowsApiInterface {
159
159
  /**
160
160
  * Run counts bucketed over time, in the resolved timezone.
161
161
  * @summary Get Admin Workflow Timeseries Handler
162
- * @param {Date} [since] Window start.
163
- * @param {Date} [until] Window end.
164
- * @param {TimeBucket} [bucket] Bucket size.
165
162
  * @param {string} [timezone] IANA tz override; defaults to tenant setting.
166
163
  * @param {string} [definitionId] Scope to one workflow.
164
+ * @param {Date} [since] Window start (inclusive). Defaults to 7 days ago.
165
+ * @param {Date} [until] Window end (inclusive).
166
+ * @param {TimeBucket} [bucket] Bucket size.
167
167
  * @param {*} [options] Override http request option.
168
168
  * @throws {RequiredError}
169
169
  * @memberof AdminWorkflowsApiInterface