@knowledge-stack/ksapi 1.87.1 → 1.88.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 (92) hide show
  1. package/.openapi-generator/FILES +18 -0
  2. package/README.md +16 -2
  3. package/dist/apis/AuthApi.d.ts +218 -13
  4. package/dist/apis/AuthApi.js +224 -6
  5. package/dist/esm/apis/AuthApi.d.ts +218 -13
  6. package/dist/esm/apis/AuthApi.js +225 -7
  7. package/dist/esm/models/ChangePhoneNumberRequest.d.ts +53 -0
  8. package/dist/esm/models/ChangePhoneNumberRequest.js +48 -0
  9. package/dist/esm/models/CreatePhonePasswordUserRequest.d.ts +71 -0
  10. package/dist/esm/models/CreatePhonePasswordUserRequest.js +60 -0
  11. package/dist/esm/models/FeaturesResponse.d.ts +6 -0
  12. package/dist/esm/models/FeaturesResponse.js +4 -0
  13. package/dist/esm/models/PasswordResetTokenResponse.d.ts +47 -0
  14. package/dist/esm/models/PasswordResetTokenResponse.js +44 -0
  15. package/dist/esm/models/PasswordResetWithTokenRequest.d.ts +2 -2
  16. package/dist/esm/models/PasswordResetWithTokenRequest.js +3 -3
  17. package/dist/esm/models/PhoneValidationResponse.d.ts +47 -0
  18. package/dist/esm/models/PhoneValidationResponse.js +44 -0
  19. package/dist/esm/models/PhoneVerificationRequest.d.ts +47 -0
  20. package/dist/esm/models/PhoneVerificationRequest.js +44 -0
  21. package/dist/esm/models/RequestPhoneChangeRequest.d.ts +47 -0
  22. package/dist/esm/models/RequestPhoneChangeRequest.js +44 -0
  23. package/dist/esm/models/ResponseSendPwResetEmail.d.ts +53 -0
  24. package/dist/esm/models/ResponseSendPwResetEmail.js +48 -0
  25. package/dist/esm/models/SendPasswordResetRequest.d.ts +67 -0
  26. package/dist/esm/models/SendPasswordResetRequest.js +53 -0
  27. package/dist/esm/models/SignInRequest.d.ts +3 -3
  28. package/dist/esm/models/SignInRequest.js +3 -3
  29. package/dist/esm/models/UserResponse.d.ts +6 -0
  30. package/dist/esm/models/UserResponse.js +2 -0
  31. package/dist/esm/models/ValidateResetCodeRequest.d.ts +53 -0
  32. package/dist/esm/models/ValidateResetCodeRequest.js +48 -0
  33. package/dist/esm/models/index.d.ts +9 -0
  34. package/dist/esm/models/index.js +9 -0
  35. package/dist/models/ChangePhoneNumberRequest.d.ts +53 -0
  36. package/dist/models/ChangePhoneNumberRequest.js +56 -0
  37. package/dist/models/CreatePhonePasswordUserRequest.d.ts +71 -0
  38. package/dist/models/CreatePhonePasswordUserRequest.js +68 -0
  39. package/dist/models/FeaturesResponse.d.ts +6 -0
  40. package/dist/models/FeaturesResponse.js +4 -0
  41. package/dist/models/PasswordResetTokenResponse.d.ts +47 -0
  42. package/dist/models/PasswordResetTokenResponse.js +52 -0
  43. package/dist/models/PasswordResetWithTokenRequest.d.ts +2 -2
  44. package/dist/models/PasswordResetWithTokenRequest.js +3 -3
  45. package/dist/models/PhoneValidationResponse.d.ts +47 -0
  46. package/dist/models/PhoneValidationResponse.js +52 -0
  47. package/dist/models/PhoneVerificationRequest.d.ts +47 -0
  48. package/dist/models/PhoneVerificationRequest.js +52 -0
  49. package/dist/models/RequestPhoneChangeRequest.d.ts +47 -0
  50. package/dist/models/RequestPhoneChangeRequest.js +52 -0
  51. package/dist/models/ResponseSendPwResetEmail.d.ts +53 -0
  52. package/dist/models/ResponseSendPwResetEmail.js +56 -0
  53. package/dist/models/SendPasswordResetRequest.d.ts +67 -0
  54. package/dist/models/SendPasswordResetRequest.js +61 -0
  55. package/dist/models/SignInRequest.d.ts +3 -3
  56. package/dist/models/SignInRequest.js +3 -3
  57. package/dist/models/UserResponse.d.ts +6 -0
  58. package/dist/models/UserResponse.js +2 -0
  59. package/dist/models/ValidateResetCodeRequest.d.ts +53 -0
  60. package/dist/models/ValidateResetCodeRequest.js +56 -0
  61. package/dist/models/index.d.ts +9 -0
  62. package/dist/models/index.js +9 -0
  63. package/docs/AuthApi.md +365 -6
  64. package/docs/ChangePhoneNumberRequest.md +37 -0
  65. package/docs/CreatePhonePasswordUserRequest.md +43 -0
  66. package/docs/FeaturesResponse.md +2 -0
  67. package/docs/PasswordResetTokenResponse.md +34 -0
  68. package/docs/PasswordResetWithTokenRequest.md +2 -2
  69. package/docs/PhoneValidationResponse.md +34 -0
  70. package/docs/PhoneVerificationRequest.md +34 -0
  71. package/docs/RequestPhoneChangeRequest.md +34 -0
  72. package/docs/ResponseSendPwResetEmail.md +36 -0
  73. package/docs/SendPasswordResetRequest.md +38 -0
  74. package/docs/SignInRequest.md +3 -2
  75. package/docs/UserResponse.md +2 -0
  76. package/docs/ValidateResetCodeRequest.md +36 -0
  77. package/package.json +1 -1
  78. package/src/apis/AuthApi.ts +452 -17
  79. package/src/models/ChangePhoneNumberRequest.ts +92 -0
  80. package/src/models/CreatePhonePasswordUserRequest.ts +120 -0
  81. package/src/models/FeaturesResponse.ts +9 -0
  82. package/src/models/PasswordResetTokenResponse.ts +83 -0
  83. package/src/models/PasswordResetWithTokenRequest.ts +5 -5
  84. package/src/models/PhoneValidationResponse.ts +83 -0
  85. package/src/models/PhoneVerificationRequest.ts +83 -0
  86. package/src/models/RequestPhoneChangeRequest.ts +83 -0
  87. package/src/models/ResponseSendPwResetEmail.ts +107 -0
  88. package/src/models/SendPasswordResetRequest.ts +109 -0
  89. package/src/models/SignInRequest.ts +6 -6
  90. package/src/models/UserResponse.ts +8 -0
  91. package/src/models/ValidateResetCodeRequest.ts +92 -0
  92. package/src/models/index.ts +9 -0
@@ -0,0 +1,107 @@
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 { PhoneValidationResponse } from './PhoneValidationResponse';
17
+ import {
18
+ PhoneValidationResponseFromJSON,
19
+ PhoneValidationResponseFromJSONTyped,
20
+ PhoneValidationResponseToJSON,
21
+ PhoneValidationResponseToJSONTyped,
22
+ } from './PhoneValidationResponse';
23
+ import type { EmailSentResponse } from './EmailSentResponse';
24
+ import {
25
+ EmailSentResponseFromJSON,
26
+ EmailSentResponseFromJSONTyped,
27
+ EmailSentResponseToJSON,
28
+ EmailSentResponseToJSONTyped,
29
+ } from './EmailSentResponse';
30
+
31
+ /**
32
+ *
33
+ * @export
34
+ * @interface ResponseSendPwResetEmail
35
+ */
36
+ export interface ResponseSendPwResetEmail {
37
+ /**
38
+ *
39
+ * @type {string}
40
+ * @memberof ResponseSendPwResetEmail
41
+ */
42
+ emailId: string;
43
+ /**
44
+ *
45
+ * @type {string}
46
+ * @memberof ResponseSendPwResetEmail
47
+ */
48
+ phoneValidationId: string;
49
+ }
50
+ export const ResponseSendPwResetEmailPropertyValidationAttributesMap: {
51
+ [property: string]: {
52
+ maxLength?: number,
53
+ minLength?: number,
54
+ pattern?: string,
55
+ maximum?: number,
56
+ exclusiveMaximum?: boolean,
57
+ minimum?: number,
58
+ exclusiveMinimum?: boolean,
59
+ multipleOf?: number,
60
+ maxItems?: number,
61
+ minItems?: number,
62
+ uniqueItems?: boolean
63
+ }
64
+ } = {
65
+ }
66
+
67
+
68
+ /**
69
+ * Check if a given object implements the ResponseSendPwResetEmail interface.
70
+ */
71
+ export function instanceOfResponseSendPwResetEmail(value: object): value is ResponseSendPwResetEmail {
72
+ if (!('emailId' in value) || value['emailId'] === undefined) return false;
73
+ if (!('phoneValidationId' in value) || value['phoneValidationId'] === undefined) return false;
74
+ return true;
75
+ }
76
+
77
+ export function ResponseSendPwResetEmailFromJSON(json: any): ResponseSendPwResetEmail {
78
+ return ResponseSendPwResetEmailFromJSONTyped(json, false);
79
+ }
80
+
81
+ export function ResponseSendPwResetEmailFromJSONTyped(json: any, ignoreDiscriminator: boolean): ResponseSendPwResetEmail {
82
+ if (json == null) {
83
+ return json;
84
+ }
85
+ return {
86
+
87
+ 'emailId': json['email_id'],
88
+ 'phoneValidationId': json['phone_validation_id'],
89
+ };
90
+ }
91
+
92
+ export function ResponseSendPwResetEmailToJSON(json: any): ResponseSendPwResetEmail {
93
+ return ResponseSendPwResetEmailToJSONTyped(json, false);
94
+ }
95
+
96
+ export function ResponseSendPwResetEmailToJSONTyped(value?: ResponseSendPwResetEmail | null, ignoreDiscriminator: boolean = false): any {
97
+ if (value == null) {
98
+ return value;
99
+ }
100
+
101
+ return {
102
+
103
+ 'email_id': value['emailId'],
104
+ 'phone_validation_id': value['phoneValidationId'],
105
+ };
106
+ }
107
+
@@ -0,0 +1,109 @@
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
+ *
18
+ * @export
19
+ * @interface SendPasswordResetRequest
20
+ */
21
+ export interface SendPasswordResetRequest {
22
+ /**
23
+ * Delivery channel for the password-reset code/link.
24
+ * @type {SendPasswordResetRequestMethodEnum}
25
+ * @memberof SendPasswordResetRequest
26
+ */
27
+ method?: SendPasswordResetRequestMethodEnum;
28
+ /**
29
+ * Email address
30
+ * @type {string}
31
+ * @memberof SendPasswordResetRequest
32
+ */
33
+ email?: string | null;
34
+ /**
35
+ * Subscriber number as a string of digits, no country code (e.g. '13800138000').
36
+ * @type {string}
37
+ * @memberof SendPasswordResetRequest
38
+ */
39
+ phoneNumber?: string | null;
40
+ }
41
+
42
+
43
+ /**
44
+ * @export
45
+ */
46
+ export const SendPasswordResetRequestMethodEnum = {
47
+ Email: 'EMAIL',
48
+ Sms: 'SMS'
49
+ } as const;
50
+ export type SendPasswordResetRequestMethodEnum = typeof SendPasswordResetRequestMethodEnum[keyof typeof SendPasswordResetRequestMethodEnum];
51
+
52
+ export const SendPasswordResetRequestPropertyValidationAttributesMap: {
53
+ [property: string]: {
54
+ maxLength?: number,
55
+ minLength?: number,
56
+ pattern?: string,
57
+ maximum?: number,
58
+ exclusiveMaximum?: boolean,
59
+ minimum?: number,
60
+ exclusiveMinimum?: boolean,
61
+ multipleOf?: number,
62
+ maxItems?: number,
63
+ minItems?: number,
64
+ uniqueItems?: boolean
65
+ }
66
+ } = {
67
+ }
68
+
69
+
70
+ /**
71
+ * Check if a given object implements the SendPasswordResetRequest interface.
72
+ */
73
+ export function instanceOfSendPasswordResetRequest(value: object): value is SendPasswordResetRequest {
74
+ return true;
75
+ }
76
+
77
+ export function SendPasswordResetRequestFromJSON(json: any): SendPasswordResetRequest {
78
+ return SendPasswordResetRequestFromJSONTyped(json, false);
79
+ }
80
+
81
+ export function SendPasswordResetRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SendPasswordResetRequest {
82
+ if (json == null) {
83
+ return json;
84
+ }
85
+ return {
86
+
87
+ 'method': json['method'] == null ? undefined : json['method'],
88
+ 'email': json['email'] == null ? undefined : json['email'],
89
+ 'phoneNumber': json['phone_number'] == null ? undefined : json['phone_number'],
90
+ };
91
+ }
92
+
93
+ export function SendPasswordResetRequestToJSON(json: any): SendPasswordResetRequest {
94
+ return SendPasswordResetRequestToJSONTyped(json, false);
95
+ }
96
+
97
+ export function SendPasswordResetRequestToJSONTyped(value?: SendPasswordResetRequest | null, ignoreDiscriminator: boolean = false): any {
98
+ if (value == null) {
99
+ return value;
100
+ }
101
+
102
+ return {
103
+
104
+ 'method': value['method'],
105
+ 'email': value['email'],
106
+ 'phone_number': value['phoneNumber'],
107
+ };
108
+ }
109
+
@@ -14,17 +14,17 @@
14
14
 
15
15
  import { mapValues } from '../runtime';
16
16
  /**
17
- *
17
+ * Unified signin — ``username`` matches either email or phone.
18
18
  * @export
19
19
  * @interface SignInRequest
20
20
  */
21
21
  export interface SignInRequest {
22
22
  /**
23
- *
23
+ * Email address or phone number (digit string). The system looks the user up by either field.
24
24
  * @type {string}
25
25
  * @memberof SignInRequest
26
26
  */
27
- email: string;
27
+ username: string;
28
28
  /**
29
29
  *
30
30
  * @type {string}
@@ -60,7 +60,7 @@ export const SignInRequestPropertyValidationAttributesMap: {
60
60
  * Check if a given object implements the SignInRequest interface.
61
61
  */
62
62
  export function instanceOfSignInRequest(value: object): value is SignInRequest {
63
- if (!('email' in value) || value['email'] === undefined) return false;
63
+ if (!('username' in value) || value['username'] === undefined) return false;
64
64
  if (!('password' in value) || value['password'] === undefined) return false;
65
65
  return true;
66
66
  }
@@ -75,7 +75,7 @@ export function SignInRequestFromJSONTyped(json: any, ignoreDiscriminator: boole
75
75
  }
76
76
  return {
77
77
 
78
- 'email': json['email'],
78
+ 'username': json['username'],
79
79
  'password': json['password'],
80
80
  'tenantId': json['tenant_id'] == null ? undefined : json['tenant_id'],
81
81
  };
@@ -92,7 +92,7 @@ export function SignInRequestToJSONTyped(value?: SignInRequest | null, ignoreDis
92
92
 
93
93
  return {
94
94
 
95
- 'email': value['email'],
95
+ 'username': value['username'],
96
96
  'password': value['password'],
97
97
  'tenant_id': value['tenantId'],
98
98
  };
@@ -46,6 +46,12 @@ export interface UserResponse {
46
46
  * @memberof UserResponse
47
47
  */
48
48
  email: string | null;
49
+ /**
50
+ * Subscriber number as a string of digits (no country code). Returned as a string to avoid JS Number precision issues.
51
+ * @type {string}
52
+ * @memberof UserResponse
53
+ */
54
+ phoneNumber?: string | null;
49
55
  /**
50
56
  * First name of the user
51
57
  * @type {string}
@@ -142,6 +148,7 @@ export function UserResponseFromJSONTyped(json: any, ignoreDiscriminator: boolea
142
148
 
143
149
  'id': json['id'],
144
150
  'email': json['email'],
151
+ 'phoneNumber': json['phone_number'] == null ? undefined : json['phone_number'],
145
152
  'firstName': json['first_name'],
146
153
  'lastName': json['last_name'],
147
154
  'idpType': IdpTypeFromJSON(json['idp_type']),
@@ -166,6 +173,7 @@ export function UserResponseToJSONTyped(value?: UserResponse | null, ignoreDiscr
166
173
 
167
174
  'id': value['id'],
168
175
  'email': value['email'],
176
+ 'phone_number': value['phoneNumber'],
169
177
  'first_name': value['firstName'],
170
178
  'last_name': value['lastName'],
171
179
  'idp_type': IdpTypeToJSON(value['idpType']),
@@ -0,0 +1,92 @@
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
+ *
18
+ * @export
19
+ * @interface ValidateResetCodeRequest
20
+ */
21
+ export interface ValidateResetCodeRequest {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof ValidateResetCodeRequest
26
+ */
27
+ phoneValidationId: string;
28
+ /**
29
+ *
30
+ * @type {string}
31
+ * @memberof ValidateResetCodeRequest
32
+ */
33
+ code: string;
34
+ }
35
+ export const ValidateResetCodeRequestPropertyValidationAttributesMap: {
36
+ [property: string]: {
37
+ maxLength?: number,
38
+ minLength?: number,
39
+ pattern?: string,
40
+ maximum?: number,
41
+ exclusiveMaximum?: boolean,
42
+ minimum?: number,
43
+ exclusiveMinimum?: boolean,
44
+ multipleOf?: number,
45
+ maxItems?: number,
46
+ minItems?: number,
47
+ uniqueItems?: boolean
48
+ }
49
+ } = {
50
+ }
51
+
52
+
53
+ /**
54
+ * Check if a given object implements the ValidateResetCodeRequest interface.
55
+ */
56
+ export function instanceOfValidateResetCodeRequest(value: object): value is ValidateResetCodeRequest {
57
+ if (!('phoneValidationId' in value) || value['phoneValidationId'] === undefined) return false;
58
+ if (!('code' in value) || value['code'] === undefined) return false;
59
+ return true;
60
+ }
61
+
62
+ export function ValidateResetCodeRequestFromJSON(json: any): ValidateResetCodeRequest {
63
+ return ValidateResetCodeRequestFromJSONTyped(json, false);
64
+ }
65
+
66
+ export function ValidateResetCodeRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ValidateResetCodeRequest {
67
+ if (json == null) {
68
+ return json;
69
+ }
70
+ return {
71
+
72
+ 'phoneValidationId': json['phone_validation_id'],
73
+ 'code': json['code'],
74
+ };
75
+ }
76
+
77
+ export function ValidateResetCodeRequestToJSON(json: any): ValidateResetCodeRequest {
78
+ return ValidateResetCodeRequestToJSONTyped(json, false);
79
+ }
80
+
81
+ export function ValidateResetCodeRequestToJSONTyped(value?: ValidateResetCodeRequest | null, ignoreDiscriminator: boolean = false): any {
82
+ if (value == null) {
83
+ return value;
84
+ }
85
+
86
+ return {
87
+
88
+ 'phone_validation_id': value['phoneValidationId'],
89
+ 'code': value['code'],
90
+ };
91
+ }
92
+
@@ -12,6 +12,7 @@ export * from './AskRequest';
12
12
  export * from './AskResponse';
13
13
  export * from './BrandingLogoType';
14
14
  export * from './BulkTagRequest';
15
+ export * from './ChangePhoneNumberRequest';
15
16
  export * from './ChangeSubscriptionRequest';
16
17
  export * from './CheckpointDetails';
17
18
  export * from './ChunkBulkResponse';
@@ -36,6 +37,7 @@ export * from './CreateGroupPermissionRequest';
36
37
  export * from './CreateGroupRequest';
37
38
  export * from './CreatePasswordUserRequest';
38
39
  export * from './CreatePermissionRequest';
40
+ export * from './CreatePhonePasswordUserRequest';
39
41
  export * from './CreateSectionRequest';
40
42
  export * from './CreateTagRequest';
41
43
  export * from './CreateThreadMessageRequest';
@@ -124,6 +126,7 @@ export * from './PaginatedResponseWorkflowRunResponse';
124
126
  export * from './PaginatedResponseWorkflowSummaryResponse';
125
127
  export * from './PartType';
126
128
  export * from './PasswordResetRequest';
129
+ export * from './PasswordResetTokenResponse';
127
130
  export * from './PasswordResetWithTokenRequest';
128
131
  export * from './PathOrder';
129
132
  export * from './PathPartAncestorItem';
@@ -133,14 +136,18 @@ export * from './PathPartResponse';
133
136
  export * from './PathPartTagsResponse';
134
137
  export * from './PermissionCapability';
135
138
  export * from './PermissionResponse';
139
+ export * from './PhoneValidationResponse';
140
+ export * from './PhoneVerificationRequest';
136
141
  export * from './PipelineState';
137
142
  export * from './PipelineStatus';
138
143
  export * from './Polygon';
139
144
  export * from './PolygonReference';
140
145
  export * from './ReferenceType';
141
146
  export * from './RejectFileRequest';
147
+ export * from './RequestPhoneChangeRequest';
142
148
  export * from './ResolvedReferenceInput';
143
149
  export * from './ResolvedReferenceOutput';
150
+ export * from './ResponseSendPwResetEmail';
144
151
  export * from './RootResponse';
145
152
  export * from './SSOInitiateResponse';
146
153
  export * from './ScoredChunkResponse';
@@ -154,6 +161,7 @@ export * from './SectionResponse';
154
161
  export * from './SectionSystemMetadata';
155
162
  export * from './SelfHostedRunnerConfig';
156
163
  export * from './SelfHostedRunnerConfigResponse';
164
+ export * from './SendPasswordResetRequest';
157
165
  export * from './SignInRequest';
158
166
  export * from './StepInput';
159
167
  export * from './StepKind';
@@ -198,6 +206,7 @@ export * from './UsageMetric';
198
206
  export * from './UserMessageRequest';
199
207
  export * from './UserMessageResponse';
200
208
  export * from './UserResponse';
209
+ export * from './ValidateResetCodeRequest';
201
210
  export * from './ValidationError';
202
211
  export * from './VersionChunkIdsResponse';
203
212
  export * from './WorkflowActionResponse';