@knowledge-stack/ksapi 1.91.0 → 1.93.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 (38) hide show
  1. package/.openapi-generator/FILES +2 -0
  2. package/README.md +4 -2
  3. package/dist/apis/WorkflowRunsApi.d.ts +44 -0
  4. package/dist/apis/WorkflowRunsApi.js +44 -0
  5. package/dist/esm/apis/WorkflowRunsApi.d.ts +44 -0
  6. package/dist/esm/apis/WorkflowRunsApi.js +44 -0
  7. package/dist/esm/models/DisplayNameFormat.d.ts +26 -0
  8. package/dist/esm/models/DisplayNameFormat.js +44 -0
  9. package/dist/esm/models/TenantSettingsResponse.d.ts +7 -0
  10. package/dist/esm/models/TenantSettingsResponse.js +5 -0
  11. package/dist/esm/models/TenantSettingsUpdate.d.ts +7 -0
  12. package/dist/esm/models/TenantSettingsUpdate.js +3 -0
  13. package/dist/esm/models/TenantUserResponse.d.ts +12 -0
  14. package/dist/esm/models/TenantUserResponse.js +4 -0
  15. package/dist/esm/models/index.d.ts +1 -0
  16. package/dist/esm/models/index.js +1 -0
  17. package/dist/models/DisplayNameFormat.d.ts +26 -0
  18. package/dist/models/DisplayNameFormat.js +52 -0
  19. package/dist/models/TenantSettingsResponse.d.ts +7 -0
  20. package/dist/models/TenantSettingsResponse.js +5 -0
  21. package/dist/models/TenantSettingsUpdate.d.ts +7 -0
  22. package/dist/models/TenantSettingsUpdate.js +3 -0
  23. package/dist/models/TenantUserResponse.d.ts +12 -0
  24. package/dist/models/TenantUserResponse.js +4 -0
  25. package/dist/models/index.d.ts +1 -0
  26. package/dist/models/index.js +1 -0
  27. package/docs/DisplayNameFormat.md +33 -0
  28. package/docs/TenantSettingsResponse.md +2 -0
  29. package/docs/TenantSettingsUpdate.md +2 -0
  30. package/docs/TenantUserResponse.md +4 -0
  31. package/docs/WorkflowRunsApi.md +75 -0
  32. package/package.json +1 -1
  33. package/src/apis/WorkflowRunsApi.ts +85 -0
  34. package/src/models/DisplayNameFormat.ts +54 -0
  35. package/src/models/TenantSettingsResponse.ts +16 -0
  36. package/src/models/TenantSettingsUpdate.ts +15 -0
  37. package/src/models/TenantUserResponse.ts +16 -0
  38. package/src/models/index.ts +1 -0
@@ -53,6 +53,7 @@ docs/CreateThreadRequest.md
53
53
  docs/CreateWorkflowDefinitionRequest.md
54
54
  docs/DefaultApi.md
55
55
  docs/DirectorySyncResponse.md
56
+ docs/DisplayNameFormat.md
56
57
  docs/DissolveSectionResponse.md
57
58
  docs/DocumentCheckoutApi.md
58
59
  docs/DocumentCheckoutResponse.md
@@ -336,6 +337,7 @@ src/models/CreateThreadMessageRequest.ts
336
337
  src/models/CreateThreadRequest.ts
337
338
  src/models/CreateWorkflowDefinitionRequest.ts
338
339
  src/models/DirectorySyncResponse.ts
340
+ src/models/DisplayNameFormat.ts
339
341
  src/models/DissolveSectionResponse.ts
340
342
  src/models/DocumentCheckoutResponse.ts
341
343
  src/models/DocumentOrigin.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @knowledge-stack/ksapi@1.91.0
1
+ # @knowledge-stack/ksapi@1.93.0
2
2
 
3
3
  A TypeScript SDK client for the localhost API.
4
4
 
@@ -211,6 +211,7 @@ All URIs are relative to *http://localhost:8000*
211
211
  *WorkflowRunsApi* | [**cloneWorkflowRun**](docs/WorkflowRunsApi.md#cloneworkflowrunoperation) | **POST** /v1/workflow-runs/{run_id}/clone | Clone Workflow Run Handler
212
212
  *WorkflowRunsApi* | [**deleteWorkflowRun**](docs/WorkflowRunsApi.md#deleteworkflowrun) | **DELETE** /v1/workflow-runs/{run_id} | Delete Workflow Run Handler
213
213
  *WorkflowRunsApi* | [**getWorkflowRun**](docs/WorkflowRunsApi.md#getworkflowrun) | **GET** /v1/workflow-runs/{run_id} | Get Workflow Run Handler
214
+ *WorkflowRunsApi* | [**retryWorkflowRun**](docs/WorkflowRunsApi.md#retryworkflowrun) | **POST** /v1/workflow-runs/{run_id}/retry | Retry Workflow Run Handler
214
215
  *WorkflowRunsApi* | [**setWorkflowRunApproval**](docs/WorkflowRunsApi.md#setworkflowrunapprovaloperation) | **POST** /v1/workflow-runs/{run_id}/approval | Set Workflow Run Approval Handler
215
216
  *WorkflowRunsApi* | [**startWorkflowRun**](docs/WorkflowRunsApi.md#startworkflowrun) | **POST** /v1/workflow-runs/{run_id}/start | Start Workflow Run Handler
216
217
  *WorkflowRunsApi* | [**stopWorkflowRun**](docs/WorkflowRunsApi.md#stopworkflowrun) | **POST** /v1/workflow-runs/{run_id}/stop | Stop Workflow Run Handler
@@ -270,6 +271,7 @@ All URIs are relative to *http://localhost:8000*
270
271
  - [CreateThreadRequest](docs/CreateThreadRequest.md)
271
272
  - [CreateWorkflowDefinitionRequest](docs/CreateWorkflowDefinitionRequest.md)
272
273
  - [DirectorySyncResponse](docs/DirectorySyncResponse.md)
274
+ - [DisplayNameFormat](docs/DisplayNameFormat.md)
273
275
  - [DissolveSectionResponse](docs/DissolveSectionResponse.md)
274
276
  - [DocumentCheckoutResponse](docs/DocumentCheckoutResponse.md)
275
277
  - [DocumentOrigin](docs/DocumentOrigin.md)
@@ -466,7 +468,7 @@ and is automatically generated by the
466
468
  [OpenAPI Generator](https://openapi-generator.tech) project:
467
469
 
468
470
  - API version: `0.1.0`
469
- - Package version: `1.91.0`
471
+ - Package version: `1.93.0`
470
472
  - Generator version: `7.21.0`
471
473
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
472
474
 
@@ -27,6 +27,11 @@ export interface GetWorkflowRunRequest {
27
27
  authorization?: string | null;
28
28
  ksUat?: string | null;
29
29
  }
30
+ export interface RetryWorkflowRunRequest {
31
+ runId: string;
32
+ authorization?: string | null;
33
+ ksUat?: string | null;
34
+ }
30
35
  export interface SetWorkflowRunApprovalOperationRequest {
31
36
  runId: string;
32
37
  setWorkflowRunApprovalRequest: SetWorkflowRunApprovalRequest;
@@ -137,6 +142,31 @@ export interface WorkflowRunsApiInterface {
137
142
  * Get Workflow Run Handler
138
143
  */
139
144
  getWorkflowRun(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
145
+ /**
146
+ * Creates request options for retryWorkflowRun without sending the request
147
+ * @param {string} runId
148
+ * @param {string} [authorization]
149
+ * @param {string} [ksUat]
150
+ * @throws {RequiredError}
151
+ * @memberof WorkflowRunsApiInterface
152
+ */
153
+ retryWorkflowRunRequestOpts(requestParameters: RetryWorkflowRunRequest): Promise<runtime.RequestOpts>;
154
+ /**
155
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
156
+ * @summary Retry Workflow Run Handler
157
+ * @param {string} runId
158
+ * @param {string} [authorization]
159
+ * @param {string} [ksUat]
160
+ * @param {*} [options] Override http request option.
161
+ * @throws {RequiredError}
162
+ * @memberof WorkflowRunsApiInterface
163
+ */
164
+ retryWorkflowRunRaw(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
165
+ /**
166
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
167
+ * Retry Workflow Run Handler
168
+ */
169
+ retryWorkflowRun(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
140
170
  /**
141
171
  * Creates request options for setWorkflowRunApproval without sending the request
142
172
  * @param {string} runId
@@ -311,6 +341,20 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
311
341
  * Get Workflow Run Handler
312
342
  */
313
343
  getWorkflowRun(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
344
+ /**
345
+ * Creates request options for retryWorkflowRun without sending the request
346
+ */
347
+ retryWorkflowRunRequestOpts(requestParameters: RetryWorkflowRunRequest): Promise<runtime.RequestOpts>;
348
+ /**
349
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
350
+ * Retry Workflow Run Handler
351
+ */
352
+ retryWorkflowRunRaw(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
353
+ /**
354
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
355
+ * Retry Workflow Run Handler
356
+ */
357
+ retryWorkflowRun(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
314
358
  /**
315
359
  * Creates request options for setWorkflowRunApproval without sending the request
316
360
  */
@@ -194,6 +194,50 @@ class WorkflowRunsApi extends runtime.BaseAPI {
194
194
  return yield response.value();
195
195
  });
196
196
  }
197
+ /**
198
+ * Creates request options for retryWorkflowRun without sending the request
199
+ */
200
+ retryWorkflowRunRequestOpts(requestParameters) {
201
+ return __awaiter(this, void 0, void 0, function* () {
202
+ if (requestParameters['runId'] == null) {
203
+ throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling retryWorkflowRun().');
204
+ }
205
+ const queryParameters = {};
206
+ const headerParameters = {};
207
+ if (requestParameters['authorization'] != null) {
208
+ headerParameters['authorization'] = String(requestParameters['authorization']);
209
+ }
210
+ let urlPath = `/v1/workflow-runs/{run_id}/retry`;
211
+ urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
212
+ return {
213
+ path: urlPath,
214
+ method: 'POST',
215
+ headers: headerParameters,
216
+ query: queryParameters,
217
+ };
218
+ });
219
+ }
220
+ /**
221
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
222
+ * Retry Workflow Run Handler
223
+ */
224
+ retryWorkflowRunRaw(requestParameters, initOverrides) {
225
+ return __awaiter(this, void 0, void 0, function* () {
226
+ const requestOptions = yield this.retryWorkflowRunRequestOpts(requestParameters);
227
+ const response = yield this.request(requestOptions, initOverrides);
228
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowRunResponseFromJSON)(jsonValue));
229
+ });
230
+ }
231
+ /**
232
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
233
+ * Retry Workflow Run Handler
234
+ */
235
+ retryWorkflowRun(requestParameters, initOverrides) {
236
+ return __awaiter(this, void 0, void 0, function* () {
237
+ const response = yield this.retryWorkflowRunRaw(requestParameters, initOverrides);
238
+ return yield response.value();
239
+ });
240
+ }
197
241
  /**
198
242
  * Creates request options for setWorkflowRunApproval without sending the request
199
243
  */
@@ -27,6 +27,11 @@ export interface GetWorkflowRunRequest {
27
27
  authorization?: string | null;
28
28
  ksUat?: string | null;
29
29
  }
30
+ export interface RetryWorkflowRunRequest {
31
+ runId: string;
32
+ authorization?: string | null;
33
+ ksUat?: string | null;
34
+ }
30
35
  export interface SetWorkflowRunApprovalOperationRequest {
31
36
  runId: string;
32
37
  setWorkflowRunApprovalRequest: SetWorkflowRunApprovalRequest;
@@ -137,6 +142,31 @@ export interface WorkflowRunsApiInterface {
137
142
  * Get Workflow Run Handler
138
143
  */
139
144
  getWorkflowRun(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
145
+ /**
146
+ * Creates request options for retryWorkflowRun without sending the request
147
+ * @param {string} runId
148
+ * @param {string} [authorization]
149
+ * @param {string} [ksUat]
150
+ * @throws {RequiredError}
151
+ * @memberof WorkflowRunsApiInterface
152
+ */
153
+ retryWorkflowRunRequestOpts(requestParameters: RetryWorkflowRunRequest): Promise<runtime.RequestOpts>;
154
+ /**
155
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
156
+ * @summary Retry Workflow Run Handler
157
+ * @param {string} runId
158
+ * @param {string} [authorization]
159
+ * @param {string} [ksUat]
160
+ * @param {*} [options] Override http request option.
161
+ * @throws {RequiredError}
162
+ * @memberof WorkflowRunsApiInterface
163
+ */
164
+ retryWorkflowRunRaw(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
165
+ /**
166
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
167
+ * Retry Workflow Run Handler
168
+ */
169
+ retryWorkflowRun(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
140
170
  /**
141
171
  * Creates request options for setWorkflowRunApproval without sending the request
142
172
  * @param {string} runId
@@ -311,6 +341,20 @@ export declare class WorkflowRunsApi extends runtime.BaseAPI implements Workflow
311
341
  * Get Workflow Run Handler
312
342
  */
313
343
  getWorkflowRun(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
344
+ /**
345
+ * Creates request options for retryWorkflowRun without sending the request
346
+ */
347
+ retryWorkflowRunRequestOpts(requestParameters: RetryWorkflowRunRequest): Promise<runtime.RequestOpts>;
348
+ /**
349
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
350
+ * Retry Workflow Run Handler
351
+ */
352
+ retryWorkflowRunRaw(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
353
+ /**
354
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
355
+ * Retry Workflow Run Handler
356
+ */
357
+ retryWorkflowRun(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
314
358
  /**
315
359
  * Creates request options for setWorkflowRunApproval without sending the request
316
360
  */
@@ -158,6 +158,50 @@ export class WorkflowRunsApi extends runtime.BaseAPI {
158
158
  return yield response.value();
159
159
  });
160
160
  }
161
+ /**
162
+ * Creates request options for retryWorkflowRun without sending the request
163
+ */
164
+ retryWorkflowRunRequestOpts(requestParameters) {
165
+ return __awaiter(this, void 0, void 0, function* () {
166
+ if (requestParameters['runId'] == null) {
167
+ throw new runtime.RequiredError('runId', 'Required parameter "runId" was null or undefined when calling retryWorkflowRun().');
168
+ }
169
+ const queryParameters = {};
170
+ const headerParameters = {};
171
+ if (requestParameters['authorization'] != null) {
172
+ headerParameters['authorization'] = String(requestParameters['authorization']);
173
+ }
174
+ let urlPath = `/v1/workflow-runs/{run_id}/retry`;
175
+ urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
176
+ return {
177
+ path: urlPath,
178
+ method: 'POST',
179
+ headers: headerParameters,
180
+ query: queryParameters,
181
+ };
182
+ });
183
+ }
184
+ /**
185
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
186
+ * Retry Workflow Run Handler
187
+ */
188
+ retryWorkflowRunRaw(requestParameters, initOverrides) {
189
+ return __awaiter(this, void 0, void 0, function* () {
190
+ const requestOptions = yield this.retryWorkflowRunRequestOpts(requestParameters);
191
+ const response = yield this.request(requestOptions, initOverrides);
192
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowRunResponseFromJSON(jsonValue));
193
+ });
194
+ }
195
+ /**
196
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
197
+ * Retry Workflow Run Handler
198
+ */
199
+ retryWorkflowRun(requestParameters, initOverrides) {
200
+ return __awaiter(this, void 0, void 0, function* () {
201
+ const response = yield this.retryWorkflowRunRaw(requestParameters, initOverrides);
202
+ return yield response.value();
203
+ });
204
+ }
161
205
  /**
162
206
  * Creates request options for setWorkflowRunApproval without sending the request
163
207
  */
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * How member names are rendered in the UI.
14
+ * @export
15
+ */
16
+ export declare const DisplayNameFormat: {
17
+ readonly Firstname: "firstname";
18
+ readonly Lastname: "lastname";
19
+ readonly FirstLast: "first_last";
20
+ };
21
+ export type DisplayNameFormat = typeof DisplayNameFormat[keyof typeof DisplayNameFormat];
22
+ export declare function instanceOfDisplayNameFormat(value: any): boolean;
23
+ export declare function DisplayNameFormatFromJSON(json: any): DisplayNameFormat;
24
+ export declare function DisplayNameFormatFromJSONTyped(json: any, ignoreDiscriminator: boolean): DisplayNameFormat;
25
+ export declare function DisplayNameFormatToJSON(value?: DisplayNameFormat | null): any;
26
+ export declare function DisplayNameFormatToJSONTyped(value: any, ignoreDiscriminator: boolean): DisplayNameFormat;
@@ -0,0 +1,44 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management
6
+ *
7
+ * The version of the OpenAPI document: 0.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ /**
15
+ * How member names are rendered in the UI.
16
+ * @export
17
+ */
18
+ export const DisplayNameFormat = {
19
+ Firstname: 'firstname',
20
+ Lastname: 'lastname',
21
+ FirstLast: 'first_last'
22
+ };
23
+ export function instanceOfDisplayNameFormat(value) {
24
+ for (const key in DisplayNameFormat) {
25
+ if (Object.prototype.hasOwnProperty.call(DisplayNameFormat, key)) {
26
+ if (DisplayNameFormat[key] === value) {
27
+ return true;
28
+ }
29
+ }
30
+ }
31
+ return false;
32
+ }
33
+ export function DisplayNameFormatFromJSON(json) {
34
+ return DisplayNameFormatFromJSONTyped(json, false);
35
+ }
36
+ export function DisplayNameFormatFromJSONTyped(json, ignoreDiscriminator) {
37
+ return json;
38
+ }
39
+ export function DisplayNameFormatToJSON(value) {
40
+ return value;
41
+ }
42
+ export function DisplayNameFormatToJSONTyped(value, ignoreDiscriminator) {
43
+ return value;
44
+ }
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { SupportedLanguage } from './SupportedLanguage';
13
+ import type { DisplayNameFormat } from './DisplayNameFormat';
13
14
  import type { InviteLinkSettingsResponse } from './InviteLinkSettingsResponse';
14
15
  /**
15
16
  * Tenant settings as exposed via API (no internal S3 URIs).
@@ -41,6 +42,12 @@ export interface TenantSettingsResponse {
41
42
  * @memberof TenantSettingsResponse
42
43
  */
43
44
  timezone: string;
45
+ /**
46
+ *
47
+ * @type {DisplayNameFormat}
48
+ * @memberof TenantSettingsResponse
49
+ */
50
+ displayName: DisplayNameFormat;
44
51
  /**
45
52
  *
46
53
  * @type {InviteLinkSettingsResponse}
@@ -12,6 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { SupportedLanguageFromJSON, SupportedLanguageToJSON, } from './SupportedLanguage';
15
+ import { DisplayNameFormatFromJSON, DisplayNameFormatToJSON, } from './DisplayNameFormat';
15
16
  import { InviteLinkSettingsResponseFromJSON, InviteLinkSettingsResponseToJSON, } from './InviteLinkSettingsResponse';
16
17
  export const TenantSettingsResponsePropertyValidationAttributesMap = {};
17
18
  /**
@@ -24,6 +25,8 @@ export function instanceOfTenantSettingsResponse(value) {
24
25
  return false;
25
26
  if (!('timezone' in value) || value['timezone'] === undefined)
26
27
  return false;
28
+ if (!('displayName' in value) || value['displayName'] === undefined)
29
+ return false;
27
30
  if (!('inviteLink' in value) || value['inviteLink'] === undefined)
28
31
  return false;
29
32
  return true;
@@ -40,6 +43,7 @@ export function TenantSettingsResponseFromJSONTyped(json, ignoreDiscriminator) {
40
43
  'description': json['description'],
41
44
  'industry': json['industry'] == null ? undefined : json['industry'],
42
45
  'timezone': json['timezone'],
46
+ 'displayName': DisplayNameFormatFromJSON(json['display_name']),
43
47
  'inviteLink': InviteLinkSettingsResponseFromJSON(json['invite_link']),
44
48
  };
45
49
  }
@@ -55,6 +59,7 @@ export function TenantSettingsResponseToJSONTyped(value, ignoreDiscriminator = f
55
59
  'description': value['description'],
56
60
  'industry': value['industry'],
57
61
  'timezone': value['timezone'],
62
+ 'display_name': DisplayNameFormatToJSON(value['displayName']),
58
63
  'invite_link': InviteLinkSettingsResponseToJSON(value['inviteLink']),
59
64
  };
60
65
  }
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { SupportedLanguage } from './SupportedLanguage';
13
+ import type { DisplayNameFormat } from './DisplayNameFormat';
13
14
  import type { InviteLinkSettingsRequest } from './InviteLinkSettingsRequest';
14
15
  /**
15
16
  * Partial tenant settings update.
@@ -41,6 +42,12 @@ export interface TenantSettingsUpdate {
41
42
  * @memberof TenantSettingsUpdate
42
43
  */
43
44
  timezone?: string | null;
45
+ /**
46
+ *
47
+ * @type {DisplayNameFormat}
48
+ * @memberof TenantSettingsUpdate
49
+ */
50
+ displayName?: DisplayNameFormat;
44
51
  /**
45
52
  * Custom brand name for logo
46
53
  * @type {string}
@@ -12,6 +12,7 @@
12
12
  * Do not edit the class manually.
13
13
  */
14
14
  import { SupportedLanguageFromJSON, SupportedLanguageToJSON, } from './SupportedLanguage';
15
+ import { DisplayNameFormatFromJSON, DisplayNameFormatToJSON, } from './DisplayNameFormat';
15
16
  import { InviteLinkSettingsRequestFromJSON, InviteLinkSettingsRequestToJSON, } from './InviteLinkSettingsRequest';
16
17
  export const TenantSettingsUpdatePropertyValidationAttributesMap = {
17
18
  description: {
@@ -39,6 +40,7 @@ export function TenantSettingsUpdateFromJSONTyped(json, ignoreDiscriminator) {
39
40
  'description': json['description'] == null ? undefined : json['description'],
40
41
  'industry': json['industry'] == null ? undefined : json['industry'],
41
42
  'timezone': json['timezone'] == null ? undefined : json['timezone'],
43
+ 'displayName': json['display_name'] == null ? undefined : DisplayNameFormatFromJSON(json['display_name']),
42
44
  'brandName': json['brand_name'] == null ? undefined : json['brand_name'],
43
45
  'brandColor': json['brand_color'] == null ? undefined : json['brand_color'],
44
46
  'themeOverrides': json['theme_overrides'] == null ? undefined : json['theme_overrides'],
@@ -57,6 +59,7 @@ export function TenantSettingsUpdateToJSONTyped(value, ignoreDiscriminator = fal
57
59
  'description': value['description'],
58
60
  'industry': value['industry'],
59
61
  'timezone': value['timezone'],
62
+ 'display_name': DisplayNameFormatToJSON(value['displayName']),
60
63
  'brand_name': value['brandName'],
61
64
  'brand_color': value['brandColor'],
62
65
  'theme_overrides': value['themeOverrides'],
@@ -46,6 +46,18 @@ export interface TenantUserResponse {
46
46
  * @memberof TenantUserResponse
47
47
  */
48
48
  role: TenantUserRole;
49
+ /**
50
+ * User's department
51
+ * @type {string}
52
+ * @memberof TenantUserResponse
53
+ */
54
+ department?: string | null;
55
+ /**
56
+ * User's job title
57
+ * @type {string}
58
+ * @memberof TenantUserResponse
59
+ */
60
+ jobTitle?: string | null;
49
61
  /**
50
62
  * Soft-deletion timestamp. NULL = active.
51
63
  * @type {Date}
@@ -42,6 +42,8 @@ export function TenantUserResponseFromJSONTyped(json, ignoreDiscriminator) {
42
42
  'firstName': json['first_name'] == null ? undefined : json['first_name'],
43
43
  'lastName': json['last_name'] == null ? undefined : json['last_name'],
44
44
  'role': TenantUserRoleFromJSON(json['role']),
45
+ 'department': json['department'] == null ? undefined : json['department'],
46
+ 'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
45
47
  'deactivatedOn': json['deactivated_on'] == null ? undefined : (new Date(json['deactivated_on'])),
46
48
  'isTenantIdpManaged': json['is_tenant_idp_managed'],
47
49
  'createdAt': (new Date(json['created_at'])),
@@ -61,6 +63,8 @@ export function TenantUserResponseToJSONTyped(value, ignoreDiscriminator = false
61
63
  'first_name': value['firstName'],
62
64
  'last_name': value['lastName'],
63
65
  'role': TenantUserRoleToJSON(value['role']),
66
+ 'department': value['department'],
67
+ 'job_title': value['jobTitle'],
64
68
  'deactivated_on': value['deactivatedOn'] == null ? value['deactivatedOn'] : value['deactivatedOn'].toISOString(),
65
69
  'is_tenant_idp_managed': value['isTenantIdpManaged'],
66
70
  'created_at': value['createdAt'].toISOString(),
@@ -43,6 +43,7 @@ export * from './CreateThreadMessageRequest';
43
43
  export * from './CreateThreadRequest';
44
44
  export * from './CreateWorkflowDefinitionRequest';
45
45
  export * from './DirectorySyncResponse';
46
+ export * from './DisplayNameFormat';
46
47
  export * from './DissolveSectionResponse';
47
48
  export * from './DocumentCheckoutResponse';
48
49
  export * from './DocumentOrigin';
@@ -45,6 +45,7 @@ export * from './CreateThreadMessageRequest';
45
45
  export * from './CreateThreadRequest';
46
46
  export * from './CreateWorkflowDefinitionRequest';
47
47
  export * from './DirectorySyncResponse';
48
+ export * from './DisplayNameFormat';
48
49
  export * from './DissolveSectionResponse';
49
50
  export * from './DocumentCheckoutResponse';
50
51
  export * from './DocumentOrigin';
@@ -0,0 +1,26 @@
1
+ /**
2
+ * Knowledge Stack API
3
+ * Knowledge Stack backend API for authentication and knowledge management
4
+ *
5
+ * The version of the OpenAPI document: 0.1.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * How member names are rendered in the UI.
14
+ * @export
15
+ */
16
+ export declare const DisplayNameFormat: {
17
+ readonly Firstname: "firstname";
18
+ readonly Lastname: "lastname";
19
+ readonly FirstLast: "first_last";
20
+ };
21
+ export type DisplayNameFormat = typeof DisplayNameFormat[keyof typeof DisplayNameFormat];
22
+ export declare function instanceOfDisplayNameFormat(value: any): boolean;
23
+ export declare function DisplayNameFormatFromJSON(json: any): DisplayNameFormat;
24
+ export declare function DisplayNameFormatFromJSONTyped(json: any, ignoreDiscriminator: boolean): DisplayNameFormat;
25
+ export declare function DisplayNameFormatToJSON(value?: DisplayNameFormat | null): any;
26
+ export declare function DisplayNameFormatToJSONTyped(value: any, ignoreDiscriminator: boolean): DisplayNameFormat;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * Knowledge Stack API
6
+ * Knowledge Stack backend API for authentication and knowledge management
7
+ *
8
+ * The version of the OpenAPI document: 0.1.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.DisplayNameFormat = void 0;
17
+ exports.instanceOfDisplayNameFormat = instanceOfDisplayNameFormat;
18
+ exports.DisplayNameFormatFromJSON = DisplayNameFormatFromJSON;
19
+ exports.DisplayNameFormatFromJSONTyped = DisplayNameFormatFromJSONTyped;
20
+ exports.DisplayNameFormatToJSON = DisplayNameFormatToJSON;
21
+ exports.DisplayNameFormatToJSONTyped = DisplayNameFormatToJSONTyped;
22
+ /**
23
+ * How member names are rendered in the UI.
24
+ * @export
25
+ */
26
+ exports.DisplayNameFormat = {
27
+ Firstname: 'firstname',
28
+ Lastname: 'lastname',
29
+ FirstLast: 'first_last'
30
+ };
31
+ function instanceOfDisplayNameFormat(value) {
32
+ for (const key in exports.DisplayNameFormat) {
33
+ if (Object.prototype.hasOwnProperty.call(exports.DisplayNameFormat, key)) {
34
+ if (exports.DisplayNameFormat[key] === value) {
35
+ return true;
36
+ }
37
+ }
38
+ }
39
+ return false;
40
+ }
41
+ function DisplayNameFormatFromJSON(json) {
42
+ return DisplayNameFormatFromJSONTyped(json, false);
43
+ }
44
+ function DisplayNameFormatFromJSONTyped(json, ignoreDiscriminator) {
45
+ return json;
46
+ }
47
+ function DisplayNameFormatToJSON(value) {
48
+ return value;
49
+ }
50
+ function DisplayNameFormatToJSONTyped(value, ignoreDiscriminator) {
51
+ return value;
52
+ }
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { SupportedLanguage } from './SupportedLanguage';
13
+ import type { DisplayNameFormat } from './DisplayNameFormat';
13
14
  import type { InviteLinkSettingsResponse } from './InviteLinkSettingsResponse';
14
15
  /**
15
16
  * Tenant settings as exposed via API (no internal S3 URIs).
@@ -41,6 +42,12 @@ export interface TenantSettingsResponse {
41
42
  * @memberof TenantSettingsResponse
42
43
  */
43
44
  timezone: string;
45
+ /**
46
+ *
47
+ * @type {DisplayNameFormat}
48
+ * @memberof TenantSettingsResponse
49
+ */
50
+ displayName: DisplayNameFormat;
44
51
  /**
45
52
  *
46
53
  * @type {InviteLinkSettingsResponse}
@@ -20,6 +20,7 @@ exports.TenantSettingsResponseFromJSONTyped = TenantSettingsResponseFromJSONType
20
20
  exports.TenantSettingsResponseToJSON = TenantSettingsResponseToJSON;
21
21
  exports.TenantSettingsResponseToJSONTyped = TenantSettingsResponseToJSONTyped;
22
22
  const SupportedLanguage_1 = require("./SupportedLanguage");
23
+ const DisplayNameFormat_1 = require("./DisplayNameFormat");
23
24
  const InviteLinkSettingsResponse_1 = require("./InviteLinkSettingsResponse");
24
25
  exports.TenantSettingsResponsePropertyValidationAttributesMap = {};
25
26
  /**
@@ -32,6 +33,8 @@ function instanceOfTenantSettingsResponse(value) {
32
33
  return false;
33
34
  if (!('timezone' in value) || value['timezone'] === undefined)
34
35
  return false;
36
+ if (!('displayName' in value) || value['displayName'] === undefined)
37
+ return false;
35
38
  if (!('inviteLink' in value) || value['inviteLink'] === undefined)
36
39
  return false;
37
40
  return true;
@@ -48,6 +51,7 @@ function TenantSettingsResponseFromJSONTyped(json, ignoreDiscriminator) {
48
51
  'description': json['description'],
49
52
  'industry': json['industry'] == null ? undefined : json['industry'],
50
53
  'timezone': json['timezone'],
54
+ 'displayName': (0, DisplayNameFormat_1.DisplayNameFormatFromJSON)(json['display_name']),
51
55
  'inviteLink': (0, InviteLinkSettingsResponse_1.InviteLinkSettingsResponseFromJSON)(json['invite_link']),
52
56
  };
53
57
  }
@@ -63,6 +67,7 @@ function TenantSettingsResponseToJSONTyped(value, ignoreDiscriminator = false) {
63
67
  'description': value['description'],
64
68
  'industry': value['industry'],
65
69
  'timezone': value['timezone'],
70
+ 'display_name': (0, DisplayNameFormat_1.DisplayNameFormatToJSON)(value['displayName']),
66
71
  'invite_link': (0, InviteLinkSettingsResponse_1.InviteLinkSettingsResponseToJSON)(value['inviteLink']),
67
72
  };
68
73
  }
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import type { SupportedLanguage } from './SupportedLanguage';
13
+ import type { DisplayNameFormat } from './DisplayNameFormat';
13
14
  import type { InviteLinkSettingsRequest } from './InviteLinkSettingsRequest';
14
15
  /**
15
16
  * Partial tenant settings update.
@@ -41,6 +42,12 @@ export interface TenantSettingsUpdate {
41
42
  * @memberof TenantSettingsUpdate
42
43
  */
43
44
  timezone?: string | null;
45
+ /**
46
+ *
47
+ * @type {DisplayNameFormat}
48
+ * @memberof TenantSettingsUpdate
49
+ */
50
+ displayName?: DisplayNameFormat;
44
51
  /**
45
52
  * Custom brand name for logo
46
53
  * @type {string}
@@ -20,6 +20,7 @@ exports.TenantSettingsUpdateFromJSONTyped = TenantSettingsUpdateFromJSONTyped;
20
20
  exports.TenantSettingsUpdateToJSON = TenantSettingsUpdateToJSON;
21
21
  exports.TenantSettingsUpdateToJSONTyped = TenantSettingsUpdateToJSONTyped;
22
22
  const SupportedLanguage_1 = require("./SupportedLanguage");
23
+ const DisplayNameFormat_1 = require("./DisplayNameFormat");
23
24
  const InviteLinkSettingsRequest_1 = require("./InviteLinkSettingsRequest");
24
25
  exports.TenantSettingsUpdatePropertyValidationAttributesMap = {
25
26
  description: {
@@ -47,6 +48,7 @@ function TenantSettingsUpdateFromJSONTyped(json, ignoreDiscriminator) {
47
48
  'description': json['description'] == null ? undefined : json['description'],
48
49
  'industry': json['industry'] == null ? undefined : json['industry'],
49
50
  'timezone': json['timezone'] == null ? undefined : json['timezone'],
51
+ 'displayName': json['display_name'] == null ? undefined : (0, DisplayNameFormat_1.DisplayNameFormatFromJSON)(json['display_name']),
50
52
  'brandName': json['brand_name'] == null ? undefined : json['brand_name'],
51
53
  'brandColor': json['brand_color'] == null ? undefined : json['brand_color'],
52
54
  'themeOverrides': json['theme_overrides'] == null ? undefined : json['theme_overrides'],
@@ -65,6 +67,7 @@ function TenantSettingsUpdateToJSONTyped(value, ignoreDiscriminator = false) {
65
67
  'description': value['description'],
66
68
  'industry': value['industry'],
67
69
  'timezone': value['timezone'],
70
+ 'display_name': (0, DisplayNameFormat_1.DisplayNameFormatToJSON)(value['displayName']),
68
71
  'brand_name': value['brandName'],
69
72
  'brand_color': value['brandColor'],
70
73
  'theme_overrides': value['themeOverrides'],
@@ -46,6 +46,18 @@ export interface TenantUserResponse {
46
46
  * @memberof TenantUserResponse
47
47
  */
48
48
  role: TenantUserRole;
49
+ /**
50
+ * User's department
51
+ * @type {string}
52
+ * @memberof TenantUserResponse
53
+ */
54
+ department?: string | null;
55
+ /**
56
+ * User's job title
57
+ * @type {string}
58
+ * @memberof TenantUserResponse
59
+ */
60
+ jobTitle?: string | null;
49
61
  /**
50
62
  * Soft-deletion timestamp. NULL = active.
51
63
  * @type {Date}
@@ -50,6 +50,8 @@ function TenantUserResponseFromJSONTyped(json, ignoreDiscriminator) {
50
50
  'firstName': json['first_name'] == null ? undefined : json['first_name'],
51
51
  'lastName': json['last_name'] == null ? undefined : json['last_name'],
52
52
  'role': (0, TenantUserRole_1.TenantUserRoleFromJSON)(json['role']),
53
+ 'department': json['department'] == null ? undefined : json['department'],
54
+ 'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
53
55
  'deactivatedOn': json['deactivated_on'] == null ? undefined : (new Date(json['deactivated_on'])),
54
56
  'isTenantIdpManaged': json['is_tenant_idp_managed'],
55
57
  'createdAt': (new Date(json['created_at'])),
@@ -69,6 +71,8 @@ function TenantUserResponseToJSONTyped(value, ignoreDiscriminator = false) {
69
71
  'first_name': value['firstName'],
70
72
  'last_name': value['lastName'],
71
73
  'role': (0, TenantUserRole_1.TenantUserRoleToJSON)(value['role']),
74
+ 'department': value['department'],
75
+ 'job_title': value['jobTitle'],
72
76
  'deactivated_on': value['deactivatedOn'] == null ? value['deactivatedOn'] : value['deactivatedOn'].toISOString(),
73
77
  'is_tenant_idp_managed': value['isTenantIdpManaged'],
74
78
  'created_at': value['createdAt'].toISOString(),
@@ -43,6 +43,7 @@ export * from './CreateThreadMessageRequest';
43
43
  export * from './CreateThreadRequest';
44
44
  export * from './CreateWorkflowDefinitionRequest';
45
45
  export * from './DirectorySyncResponse';
46
+ export * from './DisplayNameFormat';
46
47
  export * from './DissolveSectionResponse';
47
48
  export * from './DocumentCheckoutResponse';
48
49
  export * from './DocumentOrigin';
@@ -61,6 +61,7 @@ __exportStar(require("./CreateThreadMessageRequest"), exports);
61
61
  __exportStar(require("./CreateThreadRequest"), exports);
62
62
  __exportStar(require("./CreateWorkflowDefinitionRequest"), exports);
63
63
  __exportStar(require("./DirectorySyncResponse"), exports);
64
+ __exportStar(require("./DisplayNameFormat"), exports);
64
65
  __exportStar(require("./DissolveSectionResponse"), exports);
65
66
  __exportStar(require("./DocumentCheckoutResponse"), exports);
66
67
  __exportStar(require("./DocumentOrigin"), exports);
@@ -0,0 +1,33 @@
1
+
2
+ # DisplayNameFormat
3
+
4
+ How member names are rendered in the UI.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { DisplayNameFormat } from '@knowledge-stack/ksapi'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ } satisfies DisplayNameFormat
19
+
20
+ console.log(example)
21
+
22
+ // Convert the instance to a JSON string
23
+ const exampleJSON: string = JSON.stringify(example)
24
+ console.log(exampleJSON)
25
+
26
+ // Parse the JSON string back to an object
27
+ const exampleParsed = JSON.parse(exampleJSON) as DisplayNameFormat
28
+ console.log(exampleParsed)
29
+ ```
30
+
31
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
32
+
33
+
@@ -11,6 +11,7 @@ Name | Type
11
11
  `description` | string
12
12
  `industry` | string
13
13
  `timezone` | string
14
+ `displayName` | [DisplayNameFormat](DisplayNameFormat.md)
14
15
  `inviteLink` | [InviteLinkSettingsResponse](InviteLinkSettingsResponse.md)
15
16
 
16
17
  ## Example
@@ -24,6 +25,7 @@ const example = {
24
25
  "description": null,
25
26
  "industry": null,
26
27
  "timezone": null,
28
+ "displayName": null,
27
29
  "inviteLink": null,
28
30
  } satisfies TenantSettingsResponse
29
31
 
@@ -11,6 +11,7 @@ Name | Type
11
11
  `description` | string
12
12
  `industry` | string
13
13
  `timezone` | string
14
+ `displayName` | [DisplayNameFormat](DisplayNameFormat.md)
14
15
  `brandName` | string
15
16
  `brandColor` | string
16
17
  `themeOverrides` | { [key: string]: string; }
@@ -27,6 +28,7 @@ const example = {
27
28
  "description": null,
28
29
  "industry": null,
29
30
  "timezone": null,
31
+ "displayName": null,
30
32
  "brandName": null,
31
33
  "brandColor": null,
32
34
  "themeOverrides": null,
@@ -12,6 +12,8 @@ Name | Type
12
12
  `firstName` | string
13
13
  `lastName` | string
14
14
  `role` | [TenantUserRole](TenantUserRole.md)
15
+ `department` | string
16
+ `jobTitle` | string
15
17
  `deactivatedOn` | Date
16
18
  `isTenantIdpManaged` | boolean
17
19
  `createdAt` | Date
@@ -29,6 +31,8 @@ const example = {
29
31
  "firstName": null,
30
32
  "lastName": null,
31
33
  "role": null,
34
+ "department": null,
35
+ "jobTitle": null,
32
36
  "deactivatedOn": null,
33
37
  "isTenantIdpManaged": null,
34
38
  "createdAt": null,
@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost:8000*
7
7
  | [**cloneWorkflowRun**](WorkflowRunsApi.md#cloneworkflowrunoperation) | **POST** /v1/workflow-runs/{run_id}/clone | Clone Workflow Run Handler |
8
8
  | [**deleteWorkflowRun**](WorkflowRunsApi.md#deleteworkflowrun) | **DELETE** /v1/workflow-runs/{run_id} | Delete Workflow Run Handler |
9
9
  | [**getWorkflowRun**](WorkflowRunsApi.md#getworkflowrun) | **GET** /v1/workflow-runs/{run_id} | Get Workflow Run Handler |
10
+ | [**retryWorkflowRun**](WorkflowRunsApi.md#retryworkflowrun) | **POST** /v1/workflow-runs/{run_id}/retry | Retry Workflow Run Handler |
10
11
  | [**setWorkflowRunApproval**](WorkflowRunsApi.md#setworkflowrunapprovaloperation) | **POST** /v1/workflow-runs/{run_id}/approval | Set Workflow Run Approval Handler |
11
12
  | [**startWorkflowRun**](WorkflowRunsApi.md#startworkflowrun) | **POST** /v1/workflow-runs/{run_id}/start | Start Workflow Run Handler |
12
13
  | [**stopWorkflowRun**](WorkflowRunsApi.md#stopworkflowrun) | **POST** /v1/workflow-runs/{run_id}/stop | Stop Workflow Run Handler |
@@ -236,6 +237,80 @@ No authorization required
236
237
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
237
238
 
238
239
 
240
+ ## retryWorkflowRun
241
+
242
+ > WorkflowRunResponse retryWorkflowRun(runId, authorization, ksUat)
243
+
244
+ Retry Workflow Run Handler
245
+
246
+ Re-run a FAILED run (including a user-stopped one) in place. Flips &#x60;&#x60;FAILED -&gt; IN_PROGRESS&#x60;&#x60; against the run\&#39;s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
247
+
248
+ ### Example
249
+
250
+ ```ts
251
+ import {
252
+ Configuration,
253
+ WorkflowRunsApi,
254
+ } from '@knowledge-stack/ksapi';
255
+ import type { RetryWorkflowRunRequest } from '@knowledge-stack/ksapi';
256
+
257
+ async function example() {
258
+ console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
259
+ const api = new WorkflowRunsApi();
260
+
261
+ const body = {
262
+ // string
263
+ runId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
264
+ // string (optional)
265
+ authorization: authorization_example,
266
+ // string (optional)
267
+ ksUat: ksUat_example,
268
+ } satisfies RetryWorkflowRunRequest;
269
+
270
+ try {
271
+ const data = await api.retryWorkflowRun(body);
272
+ console.log(data);
273
+ } catch (error) {
274
+ console.error(error);
275
+ }
276
+ }
277
+
278
+ // Run the test
279
+ example().catch(console.error);
280
+ ```
281
+
282
+ ### Parameters
283
+
284
+
285
+ | Name | Type | Description | Notes |
286
+ |------------- | ------------- | ------------- | -------------|
287
+ | **runId** | `string` | | [Defaults to `undefined`] |
288
+ | **authorization** | `string` | | [Optional] [Defaults to `undefined`] |
289
+ | **ksUat** | `string` | | [Optional] [Defaults to `undefined`] |
290
+
291
+ ### Return type
292
+
293
+ [**WorkflowRunResponse**](WorkflowRunResponse.md)
294
+
295
+ ### Authorization
296
+
297
+ No authorization required
298
+
299
+ ### HTTP request headers
300
+
301
+ - **Content-Type**: Not defined
302
+ - **Accept**: `application/json`
303
+
304
+
305
+ ### HTTP response details
306
+ | Status code | Description | Response headers |
307
+ |-------------|-------------|------------------|
308
+ | **202** | Successful Response | - |
309
+ | **422** | Validation Error | - |
310
+
311
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
312
+
313
+
239
314
  ## setWorkflowRunApproval
240
315
 
241
316
  > WorkflowRunResponse setWorkflowRunApproval(runId, setWorkflowRunApprovalRequest, authorization, ksUat)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowledge-stack/ksapi",
3
- "version": "1.91.0",
3
+ "version": "1.93.0",
4
4
  "description": "OpenAPI client for @knowledge-stack/ksapi",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -59,6 +59,12 @@ export interface GetWorkflowRunRequest {
59
59
  ksUat?: string | null;
60
60
  }
61
61
 
62
+ export interface RetryWorkflowRunRequest {
63
+ runId: string;
64
+ authorization?: string | null;
65
+ ksUat?: string | null;
66
+ }
67
+
62
68
  export interface SetWorkflowRunApprovalOperationRequest {
63
69
  runId: string;
64
70
  setWorkflowRunApprovalRequest: SetWorkflowRunApprovalRequest;
@@ -183,6 +189,34 @@ export interface WorkflowRunsApiInterface {
183
189
  */
184
190
  getWorkflowRun(requestParameters: GetWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
185
191
 
192
+ /**
193
+ * Creates request options for retryWorkflowRun without sending the request
194
+ * @param {string} runId
195
+ * @param {string} [authorization]
196
+ * @param {string} [ksUat]
197
+ * @throws {RequiredError}
198
+ * @memberof WorkflowRunsApiInterface
199
+ */
200
+ retryWorkflowRunRequestOpts(requestParameters: RetryWorkflowRunRequest): Promise<runtime.RequestOpts>;
201
+
202
+ /**
203
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
204
+ * @summary Retry Workflow Run Handler
205
+ * @param {string} runId
206
+ * @param {string} [authorization]
207
+ * @param {string} [ksUat]
208
+ * @param {*} [options] Override http request option.
209
+ * @throws {RequiredError}
210
+ * @memberof WorkflowRunsApiInterface
211
+ */
212
+ retryWorkflowRunRaw(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>>;
213
+
214
+ /**
215
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
216
+ * Retry Workflow Run Handler
217
+ */
218
+ retryWorkflowRun(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse>;
219
+
186
220
  /**
187
221
  * Creates request options for setWorkflowRunApproval without sending the request
188
222
  * @param {string} runId
@@ -494,6 +528,57 @@ export class WorkflowRunsApi extends runtime.BaseAPI implements WorkflowRunsApiI
494
528
  return await response.value();
495
529
  }
496
530
 
531
+ /**
532
+ * Creates request options for retryWorkflowRun without sending the request
533
+ */
534
+ async retryWorkflowRunRequestOpts(requestParameters: RetryWorkflowRunRequest): Promise<runtime.RequestOpts> {
535
+ if (requestParameters['runId'] == null) {
536
+ throw new runtime.RequiredError(
537
+ 'runId',
538
+ 'Required parameter "runId" was null or undefined when calling retryWorkflowRun().'
539
+ );
540
+ }
541
+
542
+ const queryParameters: any = {};
543
+
544
+ const headerParameters: runtime.HTTPHeaders = {};
545
+
546
+ if (requestParameters['authorization'] != null) {
547
+ headerParameters['authorization'] = String(requestParameters['authorization']);
548
+ }
549
+
550
+
551
+ let urlPath = `/v1/workflow-runs/{run_id}/retry`;
552
+ urlPath = urlPath.replace(`{${"run_id"}}`, encodeURIComponent(String(requestParameters['runId'])));
553
+
554
+ return {
555
+ path: urlPath,
556
+ method: 'POST',
557
+ headers: headerParameters,
558
+ query: queryParameters,
559
+ };
560
+ }
561
+
562
+ /**
563
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
564
+ * Retry Workflow Run Handler
565
+ */
566
+ async retryWorkflowRunRaw(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowRunResponse>> {
567
+ const requestOptions = await this.retryWorkflowRunRequestOpts(requestParameters);
568
+ const response = await this.request(requestOptions, initOverrides);
569
+
570
+ return new runtime.JSONApiResponse(response, (jsonValue) => WorkflowRunResponseFromJSON(jsonValue));
571
+ }
572
+
573
+ /**
574
+ * Re-run a FAILED run (including a user-stopped one) in place. Flips ``FAILED -> IN_PROGRESS`` against the run\'s existing snapshot and re-dispatches the agent. 409 if the run is not FAILED (NOT_STARTED/PENDING use Start; COMPLETED is cloned) or was never started. Triggerer or OWNER/ADMIN only.
575
+ * Retry Workflow Run Handler
576
+ */
577
+ async retryWorkflowRun(requestParameters: RetryWorkflowRunRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowRunResponse> {
578
+ const response = await this.retryWorkflowRunRaw(requestParameters, initOverrides);
579
+ return await response.value();
580
+ }
581
+
497
582
  /**
498
583
  * Creates request options for setWorkflowRunApproval without sending the request
499
584
  */
@@ -0,0 +1,54 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Knowledge Stack API
5
+ * Knowledge Stack backend API for authentication and knowledge management
6
+ *
7
+ * The version of the OpenAPI document: 0.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ /**
17
+ * How member names are rendered in the UI.
18
+ * @export
19
+ */
20
+ export const DisplayNameFormat = {
21
+ Firstname: 'firstname',
22
+ Lastname: 'lastname',
23
+ FirstLast: 'first_last'
24
+ } as const;
25
+ export type DisplayNameFormat = typeof DisplayNameFormat[keyof typeof DisplayNameFormat];
26
+
27
+
28
+ export function instanceOfDisplayNameFormat(value: any): boolean {
29
+ for (const key in DisplayNameFormat) {
30
+ if (Object.prototype.hasOwnProperty.call(DisplayNameFormat, key)) {
31
+ if (DisplayNameFormat[key as keyof typeof DisplayNameFormat] === value) {
32
+ return true;
33
+ }
34
+ }
35
+ }
36
+ return false;
37
+ }
38
+
39
+ export function DisplayNameFormatFromJSON(json: any): DisplayNameFormat {
40
+ return DisplayNameFormatFromJSONTyped(json, false);
41
+ }
42
+
43
+ export function DisplayNameFormatFromJSONTyped(json: any, ignoreDiscriminator: boolean): DisplayNameFormat {
44
+ return json as DisplayNameFormat;
45
+ }
46
+
47
+ export function DisplayNameFormatToJSON(value?: DisplayNameFormat | null): any {
48
+ return value as any;
49
+ }
50
+
51
+ export function DisplayNameFormatToJSONTyped(value: any, ignoreDiscriminator: boolean): DisplayNameFormat {
52
+ return value as DisplayNameFormat;
53
+ }
54
+
@@ -20,6 +20,13 @@ import {
20
20
  SupportedLanguageToJSON,
21
21
  SupportedLanguageToJSONTyped,
22
22
  } from './SupportedLanguage';
23
+ import type { DisplayNameFormat } from './DisplayNameFormat';
24
+ import {
25
+ DisplayNameFormatFromJSON,
26
+ DisplayNameFormatFromJSONTyped,
27
+ DisplayNameFormatToJSON,
28
+ DisplayNameFormatToJSONTyped,
29
+ } from './DisplayNameFormat';
23
30
  import type { InviteLinkSettingsResponse } from './InviteLinkSettingsResponse';
24
31
  import {
25
32
  InviteLinkSettingsResponseFromJSON,
@@ -58,6 +65,12 @@ export interface TenantSettingsResponse {
58
65
  * @memberof TenantSettingsResponse
59
66
  */
60
67
  timezone: string;
68
+ /**
69
+ *
70
+ * @type {DisplayNameFormat}
71
+ * @memberof TenantSettingsResponse
72
+ */
73
+ displayName: DisplayNameFormat;
61
74
  /**
62
75
  *
63
76
  * @type {InviteLinkSettingsResponse}
@@ -92,6 +105,7 @@ export function instanceOfTenantSettingsResponse(value: object): value is Tenant
92
105
  if (!('language' in value) || value['language'] === undefined) return false;
93
106
  if (!('description' in value) || value['description'] === undefined) return false;
94
107
  if (!('timezone' in value) || value['timezone'] === undefined) return false;
108
+ if (!('displayName' in value) || value['displayName'] === undefined) return false;
95
109
  if (!('inviteLink' in value) || value['inviteLink'] === undefined) return false;
96
110
  return true;
97
111
  }
@@ -110,6 +124,7 @@ export function TenantSettingsResponseFromJSONTyped(json: any, ignoreDiscriminat
110
124
  'description': json['description'],
111
125
  'industry': json['industry'] == null ? undefined : json['industry'],
112
126
  'timezone': json['timezone'],
127
+ 'displayName': DisplayNameFormatFromJSON(json['display_name']),
113
128
  'inviteLink': InviteLinkSettingsResponseFromJSON(json['invite_link']),
114
129
  };
115
130
  }
@@ -129,6 +144,7 @@ export function TenantSettingsResponseToJSONTyped(value?: TenantSettingsResponse
129
144
  'description': value['description'],
130
145
  'industry': value['industry'],
131
146
  'timezone': value['timezone'],
147
+ 'display_name': DisplayNameFormatToJSON(value['displayName']),
132
148
  'invite_link': InviteLinkSettingsResponseToJSON(value['inviteLink']),
133
149
  };
134
150
  }
@@ -20,6 +20,13 @@ import {
20
20
  SupportedLanguageToJSON,
21
21
  SupportedLanguageToJSONTyped,
22
22
  } from './SupportedLanguage';
23
+ import type { DisplayNameFormat } from './DisplayNameFormat';
24
+ import {
25
+ DisplayNameFormatFromJSON,
26
+ DisplayNameFormatFromJSONTyped,
27
+ DisplayNameFormatToJSON,
28
+ DisplayNameFormatToJSONTyped,
29
+ } from './DisplayNameFormat';
23
30
  import type { InviteLinkSettingsRequest } from './InviteLinkSettingsRequest';
24
31
  import {
25
32
  InviteLinkSettingsRequestFromJSON,
@@ -58,6 +65,12 @@ export interface TenantSettingsUpdate {
58
65
  * @memberof TenantSettingsUpdate
59
66
  */
60
67
  timezone?: string | null;
68
+ /**
69
+ *
70
+ * @type {DisplayNameFormat}
71
+ * @memberof TenantSettingsUpdate
72
+ */
73
+ displayName?: DisplayNameFormat;
61
74
  /**
62
75
  * Custom brand name for logo
63
76
  * @type {string}
@@ -130,6 +143,7 @@ export function TenantSettingsUpdateFromJSONTyped(json: any, ignoreDiscriminator
130
143
  'description': json['description'] == null ? undefined : json['description'],
131
144
  'industry': json['industry'] == null ? undefined : json['industry'],
132
145
  'timezone': json['timezone'] == null ? undefined : json['timezone'],
146
+ 'displayName': json['display_name'] == null ? undefined : DisplayNameFormatFromJSON(json['display_name']),
133
147
  'brandName': json['brand_name'] == null ? undefined : json['brand_name'],
134
148
  'brandColor': json['brand_color'] == null ? undefined : json['brand_color'],
135
149
  'themeOverrides': json['theme_overrides'] == null ? undefined : json['theme_overrides'],
@@ -152,6 +166,7 @@ export function TenantSettingsUpdateToJSONTyped(value?: TenantSettingsUpdate | n
152
166
  'description': value['description'],
153
167
  'industry': value['industry'],
154
168
  'timezone': value['timezone'],
169
+ 'display_name': DisplayNameFormatToJSON(value['displayName']),
155
170
  'brand_name': value['brandName'],
156
171
  'brand_color': value['brandColor'],
157
172
  'theme_overrides': value['themeOverrides'],
@@ -57,6 +57,18 @@ export interface TenantUserResponse {
57
57
  * @memberof TenantUserResponse
58
58
  */
59
59
  role: TenantUserRole;
60
+ /**
61
+ * User's department
62
+ * @type {string}
63
+ * @memberof TenantUserResponse
64
+ */
65
+ department?: string | null;
66
+ /**
67
+ * User's job title
68
+ * @type {string}
69
+ * @memberof TenantUserResponse
70
+ */
71
+ jobTitle?: string | null;
60
72
  /**
61
73
  * Soft-deletion timestamp. NULL = active.
62
74
  * @type {Date}
@@ -129,6 +141,8 @@ export function TenantUserResponseFromJSONTyped(json: any, ignoreDiscriminator:
129
141
  'firstName': json['first_name'] == null ? undefined : json['first_name'],
130
142
  'lastName': json['last_name'] == null ? undefined : json['last_name'],
131
143
  'role': TenantUserRoleFromJSON(json['role']),
144
+ 'department': json['department'] == null ? undefined : json['department'],
145
+ 'jobTitle': json['job_title'] == null ? undefined : json['job_title'],
132
146
  'deactivatedOn': json['deactivated_on'] == null ? undefined : (new Date(json['deactivated_on'])),
133
147
  'isTenantIdpManaged': json['is_tenant_idp_managed'],
134
148
  'createdAt': (new Date(json['created_at'])),
@@ -152,6 +166,8 @@ export function TenantUserResponseToJSONTyped(value?: TenantUserResponse | null,
152
166
  'first_name': value['firstName'],
153
167
  'last_name': value['lastName'],
154
168
  'role': TenantUserRoleToJSON(value['role']),
169
+ 'department': value['department'],
170
+ 'job_title': value['jobTitle'],
155
171
  'deactivated_on': value['deactivatedOn'] == null ? value['deactivatedOn'] : value['deactivatedOn'].toISOString(),
156
172
  'is_tenant_idp_managed': value['isTenantIdpManaged'],
157
173
  'created_at': value['createdAt'].toISOString(),
@@ -45,6 +45,7 @@ export * from './CreateThreadMessageRequest';
45
45
  export * from './CreateThreadRequest';
46
46
  export * from './CreateWorkflowDefinitionRequest';
47
47
  export * from './DirectorySyncResponse';
48
+ export * from './DisplayNameFormat';
48
49
  export * from './DissolveSectionResponse';
49
50
  export * from './DocumentCheckoutResponse';
50
51
  export * from './DocumentOrigin';