@knowledge-stack/ksapi 1.26.0 → 1.27.1

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 +6 -0
  2. package/README.md +6 -2
  3. package/dist/apis/InvitesApi.d.ts +5 -5
  4. package/dist/apis/InvitesApi.js +1 -6
  5. package/dist/apis/ThreadsApi.d.ts +45 -1
  6. package/dist/apis/ThreadsApi.js +46 -0
  7. package/dist/esm/apis/InvitesApi.d.ts +5 -5
  8. package/dist/esm/apis/InvitesApi.js +2 -7
  9. package/dist/esm/apis/ThreadsApi.d.ts +45 -1
  10. package/dist/esm/apis/ThreadsApi.js +47 -1
  11. package/dist/esm/models/AcceptInviteResponse.d.ts +54 -0
  12. package/dist/esm/models/AcceptInviteResponse.js +49 -0
  13. package/dist/esm/models/UserMessageRequest.d.ts +47 -0
  14. package/dist/esm/models/UserMessageRequest.js +42 -0
  15. package/dist/esm/models/UserMessageResponse.d.ts +47 -0
  16. package/dist/esm/models/UserMessageResponse.js +44 -0
  17. package/dist/esm/models/index.d.ts +3 -0
  18. package/dist/esm/models/index.js +3 -0
  19. package/dist/models/AcceptInviteResponse.d.ts +54 -0
  20. package/dist/models/AcceptInviteResponse.js +57 -0
  21. package/dist/models/UserMessageRequest.d.ts +47 -0
  22. package/dist/models/UserMessageRequest.js +50 -0
  23. package/dist/models/UserMessageResponse.d.ts +47 -0
  24. package/dist/models/UserMessageResponse.js +52 -0
  25. package/dist/models/index.d.ts +3 -0
  26. package/dist/models/index.js +3 -0
  27. package/docs/AcceptInviteResponse.md +37 -0
  28. package/docs/InvitesApi.md +2 -2
  29. package/docs/ThreadsApi.md +75 -0
  30. package/docs/UserMessageRequest.md +35 -0
  31. package/docs/UserMessageResponse.md +35 -0
  32. package/package.json +1 -1
  33. package/src/apis/InvitesApi.ts +8 -9
  34. package/src/apis/ThreadsApi.ts +97 -0
  35. package/src/models/AcceptInviteResponse.ts +102 -0
  36. package/src/models/UserMessageRequest.ts +82 -0
  37. package/src/models/UserMessageResponse.ts +83 -0
  38. package/src/models/index.ts +3 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowledge-stack/ksapi",
3
- "version": "1.26.0",
3
+ "version": "1.27.1",
4
4
  "description": "OpenAPI client for @knowledge-stack/ksapi",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -15,6 +15,7 @@
15
15
 
16
16
  import * as runtime from '../runtime';
17
17
  import type {
18
+ AcceptInviteResponse,
18
19
  HTTPValidationError,
19
20
  InviteResponse,
20
21
  InviteStatus,
@@ -22,6 +23,8 @@ import type {
22
23
  PaginatedResponseInviteResponse,
23
24
  } from '../models/index';
24
25
  import {
26
+ AcceptInviteResponseFromJSON,
27
+ AcceptInviteResponseToJSON,
25
28
  HTTPValidationErrorFromJSON,
26
29
  HTTPValidationErrorToJSON,
27
30
  InviteResponseFromJSON,
@@ -82,13 +85,13 @@ export interface InvitesApiInterface {
82
85
  * @throws {RequiredError}
83
86
  * @memberof InvitesApiInterface
84
87
  */
85
- acceptInviteRaw(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>>;
88
+ acceptInviteRaw(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AcceptInviteResponse>>;
86
89
 
87
90
  /**
88
91
  * Update an invite to accepted status and create tenant user.
89
92
  * Accept Invite
90
93
  */
91
- acceptInvite(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any>;
94
+ acceptInvite(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AcceptInviteResponse>;
92
95
 
93
96
  /**
94
97
  * Creates request options for createInvite without sending the request
@@ -212,22 +215,18 @@ export class InvitesApi extends runtime.BaseAPI implements InvitesApiInterface {
212
215
  * Update an invite to accepted status and create tenant user.
213
216
  * Accept Invite
214
217
  */
215
- async acceptInviteRaw(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<any>> {
218
+ async acceptInviteRaw(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AcceptInviteResponse>> {
216
219
  const requestOptions = await this.acceptInviteRequestOpts(requestParameters);
217
220
  const response = await this.request(requestOptions, initOverrides);
218
221
 
219
- if (this.isJsonMime(response.headers.get('content-type'))) {
220
- return new runtime.JSONApiResponse<any>(response);
221
- } else {
222
- return new runtime.TextApiResponse(response) as any;
223
- }
222
+ return new runtime.JSONApiResponse(response, (jsonValue) => AcceptInviteResponseFromJSON(jsonValue));
224
223
  }
225
224
 
226
225
  /**
227
226
  * Update an invite to accepted status and create tenant user.
228
227
  * Accept Invite
229
228
  */
230
- async acceptInvite(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<any> {
229
+ async acceptInvite(requestParameters: AcceptInviteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AcceptInviteResponse> {
231
230
  const response = await this.acceptInviteRaw(requestParameters, initOverrides);
232
231
  return await response.value();
233
232
  }
@@ -20,6 +20,8 @@ import type {
20
20
  PaginatedResponseThreadResponse,
21
21
  ThreadResponse,
22
22
  UpdateThreadRequest,
23
+ UserMessageRequest,
24
+ UserMessageResponse,
23
25
  } from '../models/index';
24
26
  import {
25
27
  CreateThreadRequestFromJSON,
@@ -32,6 +34,10 @@ import {
32
34
  ThreadResponseToJSON,
33
35
  UpdateThreadRequestFromJSON,
34
36
  UpdateThreadRequestToJSON,
37
+ UserMessageRequestFromJSON,
38
+ UserMessageRequestToJSON,
39
+ UserMessageResponseFromJSON,
40
+ UserMessageResponseToJSON,
35
41
  } from '../models/index';
36
42
 
37
43
  export interface CreateThreadOperationRequest {
@@ -56,6 +62,12 @@ export interface ListThreadsRequest {
56
62
  ksUat?: string | null;
57
63
  }
58
64
 
65
+ export interface SendUserMessageRequest {
66
+ threadId: string;
67
+ userMessageRequest: UserMessageRequest;
68
+ ksUat?: string | null;
69
+ }
70
+
59
71
  export interface StreamThreadRequest {
60
72
  threadId: string;
61
73
  lastMessageId?: string | null;
@@ -184,6 +196,34 @@ export interface ThreadsApiInterface {
184
196
  */
185
197
  listThreads(requestParameters: ListThreadsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedResponseThreadResponse>;
186
198
 
199
+ /**
200
+ * Creates request options for sendUserMessage without sending the request
201
+ * @param {string} threadId
202
+ * @param {UserMessageRequest} userMessageRequest
203
+ * @param {string} [ksUat]
204
+ * @throws {RequiredError}
205
+ * @memberof ThreadsApiInterface
206
+ */
207
+ sendUserMessageRequestOpts(requestParameters: SendUserMessageRequest): Promise<runtime.RequestOpts>;
208
+
209
+ /**
210
+ * Send a user message and trigger agent generation. Returns immediately with a workflow_id. Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
211
+ * @summary Send User Message Handler
212
+ * @param {string} threadId
213
+ * @param {UserMessageRequest} userMessageRequest
214
+ * @param {string} [ksUat]
215
+ * @param {*} [options] Override http request option.
216
+ * @throws {RequiredError}
217
+ * @memberof ThreadsApiInterface
218
+ */
219
+ sendUserMessageRaw(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserMessageResponse>>;
220
+
221
+ /**
222
+ * Send a user message and trigger agent generation. Returns immediately with a workflow_id. Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
223
+ * Send User Message Handler
224
+ */
225
+ sendUserMessage(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserMessageResponse>;
226
+
187
227
  /**
188
228
  * Creates request options for streamThread without sending the request
189
229
  * @param {string} threadId
@@ -442,6 +482,63 @@ export class ThreadsApi extends runtime.BaseAPI implements ThreadsApiInterface {
442
482
  return await response.value();
443
483
  }
444
484
 
485
+ /**
486
+ * Creates request options for sendUserMessage without sending the request
487
+ */
488
+ async sendUserMessageRequestOpts(requestParameters: SendUserMessageRequest): Promise<runtime.RequestOpts> {
489
+ if (requestParameters['threadId'] == null) {
490
+ throw new runtime.RequiredError(
491
+ 'threadId',
492
+ 'Required parameter "threadId" was null or undefined when calling sendUserMessage().'
493
+ );
494
+ }
495
+
496
+ if (requestParameters['userMessageRequest'] == null) {
497
+ throw new runtime.RequiredError(
498
+ 'userMessageRequest',
499
+ 'Required parameter "userMessageRequest" was null or undefined when calling sendUserMessage().'
500
+ );
501
+ }
502
+
503
+ const queryParameters: any = {};
504
+
505
+ const headerParameters: runtime.HTTPHeaders = {};
506
+
507
+ headerParameters['Content-Type'] = 'application/json';
508
+
509
+
510
+ let urlPath = `/v1/threads/{thread_id}/user_message`;
511
+ urlPath = urlPath.replace(`{${"thread_id"}}`, encodeURIComponent(String(requestParameters['threadId'])));
512
+
513
+ return {
514
+ path: urlPath,
515
+ method: 'POST',
516
+ headers: headerParameters,
517
+ query: queryParameters,
518
+ body: UserMessageRequestToJSON(requestParameters['userMessageRequest']),
519
+ };
520
+ }
521
+
522
+ /**
523
+ * Send a user message and trigger agent generation. Returns immediately with a workflow_id. Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
524
+ * Send User Message Handler
525
+ */
526
+ async sendUserMessageRaw(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserMessageResponse>> {
527
+ const requestOptions = await this.sendUserMessageRequestOpts(requestParameters);
528
+ const response = await this.request(requestOptions, initOverrides);
529
+
530
+ return new runtime.JSONApiResponse(response, (jsonValue) => UserMessageResponseFromJSON(jsonValue));
531
+ }
532
+
533
+ /**
534
+ * Send a user message and trigger agent generation. Returns immediately with a workflow_id. Connect to GET /{thread_id}/stream (SSE) before or after calling this endpoint to receive the streamed output.
535
+ * Send User Message Handler
536
+ */
537
+ async sendUserMessage(requestParameters: SendUserMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserMessageResponse> {
538
+ const response = await this.sendUserMessageRaw(requestParameters, initOverrides);
539
+ return await response.value();
540
+ }
541
+
445
542
  /**
446
543
  * Creates request options for streamThread without sending the request
447
544
  */
@@ -0,0 +1,102 @@
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
+ import { mapValues } from '../runtime';
16
+ import type { TenantUserRole } from './TenantUserRole';
17
+ import {
18
+ TenantUserRoleFromJSON,
19
+ TenantUserRoleFromJSONTyped,
20
+ TenantUserRoleToJSON,
21
+ TenantUserRoleToJSONTyped,
22
+ } from './TenantUserRole';
23
+
24
+ /**
25
+ * Response returned after accepting an invite.
26
+ * @export
27
+ * @interface AcceptInviteResponse
28
+ */
29
+ export interface AcceptInviteResponse {
30
+ /**
31
+ *
32
+ * @type {string}
33
+ * @memberof AcceptInviteResponse
34
+ */
35
+ tenantId: string;
36
+ /**
37
+ *
38
+ * @type {TenantUserRole}
39
+ * @memberof AcceptInviteResponse
40
+ */
41
+ role: TenantUserRole;
42
+ }
43
+
44
+
45
+
46
+ /**
47
+ * Check if a given object implements the AcceptInviteResponse interface.
48
+ */
49
+ export function instanceOfAcceptInviteResponse(value: object): value is AcceptInviteResponse {
50
+ if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
51
+ if (!('role' in value) || value['role'] === undefined) return false;
52
+ return true;
53
+ }
54
+
55
+ export function AcceptInviteResponseFromJSON(json: any): AcceptInviteResponse {
56
+ return AcceptInviteResponseFromJSONTyped(json, false);
57
+ }
58
+
59
+ export function AcceptInviteResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AcceptInviteResponse {
60
+ if (json == null) {
61
+ return json;
62
+ }
63
+ return {
64
+
65
+ 'tenantId': json['tenant_id'],
66
+ 'role': TenantUserRoleFromJSON(json['role']),
67
+ };
68
+ }
69
+
70
+ export function AcceptInviteResponseToJSON(json: any): AcceptInviteResponse {
71
+ return AcceptInviteResponseToJSONTyped(json, false);
72
+ }
73
+
74
+ export function AcceptInviteResponseToJSONTyped(value?: AcceptInviteResponse | null, ignoreDiscriminator: boolean = false): any {
75
+ if (value == null) {
76
+ return value;
77
+ }
78
+
79
+ return {
80
+
81
+ 'tenant_id': value['tenantId'],
82
+ 'role': TenantUserRoleToJSON(value['role']),
83
+ };
84
+ }
85
+
86
+ export const AcceptInviteResponsePropertyValidationAttributesMap: {
87
+ [property: string]: {
88
+ maxLength?: number,
89
+ minLength?: number,
90
+ pattern?: string,
91
+ maximum?: number,
92
+ exclusiveMaximum?: boolean,
93
+ minimum?: number,
94
+ exclusiveMinimum?: boolean,
95
+ multipleOf?: number,
96
+ maxItems?: number,
97
+ minItems?: number,
98
+ uniqueItems?: boolean
99
+ }
100
+ } = {
101
+ }
102
+
@@ -0,0 +1,82 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * Request to send a user message and trigger agent generation.
18
+ * @export
19
+ * @interface UserMessageRequest
20
+ */
21
+ export interface UserMessageRequest {
22
+ /**
23
+ * User input text. Mock agent dev controls may be embedded here (e.g. /mock duration=5 wps=3 scenario=tool_call_once).
24
+ * @type {string}
25
+ * @memberof UserMessageRequest
26
+ */
27
+ inputText?: string;
28
+ }
29
+
30
+ /**
31
+ * Check if a given object implements the UserMessageRequest interface.
32
+ */
33
+ export function instanceOfUserMessageRequest(value: object): value is UserMessageRequest {
34
+ return true;
35
+ }
36
+
37
+ export function UserMessageRequestFromJSON(json: any): UserMessageRequest {
38
+ return UserMessageRequestFromJSONTyped(json, false);
39
+ }
40
+
41
+ export function UserMessageRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserMessageRequest {
42
+ if (json == null) {
43
+ return json;
44
+ }
45
+ return {
46
+
47
+ 'inputText': json['input_text'] == null ? undefined : json['input_text'],
48
+ };
49
+ }
50
+
51
+ export function UserMessageRequestToJSON(json: any): UserMessageRequest {
52
+ return UserMessageRequestToJSONTyped(json, false);
53
+ }
54
+
55
+ export function UserMessageRequestToJSONTyped(value?: UserMessageRequest | null, ignoreDiscriminator: boolean = false): any {
56
+ if (value == null) {
57
+ return value;
58
+ }
59
+
60
+ return {
61
+
62
+ 'input_text': value['inputText'],
63
+ };
64
+ }
65
+
66
+ export const UserMessageRequestPropertyValidationAttributesMap: {
67
+ [property: string]: {
68
+ maxLength?: number,
69
+ minLength?: number,
70
+ pattern?: string,
71
+ maximum?: number,
72
+ exclusiveMaximum?: boolean,
73
+ minimum?: number,
74
+ exclusiveMinimum?: boolean,
75
+ multipleOf?: number,
76
+ maxItems?: number,
77
+ minItems?: number,
78
+ uniqueItems?: boolean
79
+ }
80
+ } = {
81
+ }
82
+
@@ -0,0 +1,83 @@
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
+ import { mapValues } from '../runtime';
16
+ /**
17
+ * 202 response from POST /{thread_id}/user_message.
18
+ * @export
19
+ * @interface UserMessageResponse
20
+ */
21
+ export interface UserMessageResponse {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof UserMessageResponse
26
+ */
27
+ workflowId: string;
28
+ }
29
+
30
+ /**
31
+ * Check if a given object implements the UserMessageResponse interface.
32
+ */
33
+ export function instanceOfUserMessageResponse(value: object): value is UserMessageResponse {
34
+ if (!('workflowId' in value) || value['workflowId'] === undefined) return false;
35
+ return true;
36
+ }
37
+
38
+ export function UserMessageResponseFromJSON(json: any): UserMessageResponse {
39
+ return UserMessageResponseFromJSONTyped(json, false);
40
+ }
41
+
42
+ export function UserMessageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): UserMessageResponse {
43
+ if (json == null) {
44
+ return json;
45
+ }
46
+ return {
47
+
48
+ 'workflowId': json['workflow_id'],
49
+ };
50
+ }
51
+
52
+ export function UserMessageResponseToJSON(json: any): UserMessageResponse {
53
+ return UserMessageResponseToJSONTyped(json, false);
54
+ }
55
+
56
+ export function UserMessageResponseToJSONTyped(value?: UserMessageResponse | null, ignoreDiscriminator: boolean = false): any {
57
+ if (value == null) {
58
+ return value;
59
+ }
60
+
61
+ return {
62
+
63
+ 'workflow_id': value['workflowId'],
64
+ };
65
+ }
66
+
67
+ export const UserMessageResponsePropertyValidationAttributesMap: {
68
+ [property: string]: {
69
+ maxLength?: number,
70
+ minLength?: number,
71
+ pattern?: string,
72
+ maximum?: number,
73
+ exclusiveMaximum?: boolean,
74
+ minimum?: number,
75
+ exclusiveMinimum?: boolean,
76
+ multipleOf?: number,
77
+ maxItems?: number,
78
+ minItems?: number,
79
+ uniqueItems?: boolean
80
+ }
81
+ } = {
82
+ }
83
+
@@ -1,5 +1,6 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
+ export * from './AcceptInviteResponse';
3
4
  export * from './BulkTagRequest';
4
5
  export * from './ChunkBulkResponse';
5
6
  export * from './ChunkContentItem';
@@ -96,6 +97,8 @@ export * from './UpdateTagRequest';
96
97
  export * from './UpdateTenantRequest';
97
98
  export * from './UpdateThreadRequest';
98
99
  export * from './UpdateUserRequest';
100
+ export * from './UserMessageRequest';
101
+ export * from './UserMessageResponse';
99
102
  export * from './UserResponse';
100
103
  export * from './ValidationError';
101
104
  export * from './VersionChunkIdsResponse';