@knowledge-stack/ksapi 1.87.1 → 1.88.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.
- package/.openapi-generator/FILES +18 -0
- package/README.md +16 -2
- package/dist/apis/AuthApi.d.ts +218 -13
- package/dist/apis/AuthApi.js +224 -6
- package/dist/esm/apis/AuthApi.d.ts +218 -13
- package/dist/esm/apis/AuthApi.js +225 -7
- package/dist/esm/models/ChangePhoneNumberRequest.d.ts +53 -0
- package/dist/esm/models/ChangePhoneNumberRequest.js +48 -0
- package/dist/esm/models/CreatePhonePasswordUserRequest.d.ts +71 -0
- package/dist/esm/models/CreatePhonePasswordUserRequest.js +60 -0
- package/dist/esm/models/FeaturesResponse.d.ts +6 -0
- package/dist/esm/models/FeaturesResponse.js +4 -0
- package/dist/esm/models/PasswordResetTokenResponse.d.ts +47 -0
- package/dist/esm/models/PasswordResetTokenResponse.js +44 -0
- package/dist/esm/models/PasswordResetWithTokenRequest.d.ts +2 -2
- package/dist/esm/models/PasswordResetWithTokenRequest.js +3 -3
- package/dist/esm/models/PhoneValidationResponse.d.ts +47 -0
- package/dist/esm/models/PhoneValidationResponse.js +44 -0
- package/dist/esm/models/PhoneVerificationRequest.d.ts +47 -0
- package/dist/esm/models/PhoneVerificationRequest.js +44 -0
- package/dist/esm/models/RequestPhoneChangeRequest.d.ts +47 -0
- package/dist/esm/models/RequestPhoneChangeRequest.js +44 -0
- package/dist/esm/models/ResponseSendPwResetEmail.d.ts +53 -0
- package/dist/esm/models/ResponseSendPwResetEmail.js +48 -0
- package/dist/esm/models/SendPasswordResetRequest.d.ts +67 -0
- package/dist/esm/models/SendPasswordResetRequest.js +53 -0
- package/dist/esm/models/SignInRequest.d.ts +3 -3
- package/dist/esm/models/SignInRequest.js +3 -3
- package/dist/esm/models/UserResponse.d.ts +6 -0
- package/dist/esm/models/UserResponse.js +2 -0
- package/dist/esm/models/ValidateResetCodeRequest.d.ts +53 -0
- package/dist/esm/models/ValidateResetCodeRequest.js +48 -0
- package/dist/esm/models/index.d.ts +9 -0
- package/dist/esm/models/index.js +9 -0
- package/dist/models/ChangePhoneNumberRequest.d.ts +53 -0
- package/dist/models/ChangePhoneNumberRequest.js +56 -0
- package/dist/models/CreatePhonePasswordUserRequest.d.ts +71 -0
- package/dist/models/CreatePhonePasswordUserRequest.js +68 -0
- package/dist/models/FeaturesResponse.d.ts +6 -0
- package/dist/models/FeaturesResponse.js +4 -0
- package/dist/models/PasswordResetTokenResponse.d.ts +47 -0
- package/dist/models/PasswordResetTokenResponse.js +52 -0
- package/dist/models/PasswordResetWithTokenRequest.d.ts +2 -2
- package/dist/models/PasswordResetWithTokenRequest.js +3 -3
- package/dist/models/PhoneValidationResponse.d.ts +47 -0
- package/dist/models/PhoneValidationResponse.js +52 -0
- package/dist/models/PhoneVerificationRequest.d.ts +47 -0
- package/dist/models/PhoneVerificationRequest.js +52 -0
- package/dist/models/RequestPhoneChangeRequest.d.ts +47 -0
- package/dist/models/RequestPhoneChangeRequest.js +52 -0
- package/dist/models/ResponseSendPwResetEmail.d.ts +53 -0
- package/dist/models/ResponseSendPwResetEmail.js +56 -0
- package/dist/models/SendPasswordResetRequest.d.ts +67 -0
- package/dist/models/SendPasswordResetRequest.js +61 -0
- package/dist/models/SignInRequest.d.ts +3 -3
- package/dist/models/SignInRequest.js +3 -3
- package/dist/models/UserResponse.d.ts +6 -0
- package/dist/models/UserResponse.js +2 -0
- package/dist/models/ValidateResetCodeRequest.d.ts +53 -0
- package/dist/models/ValidateResetCodeRequest.js +56 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/docs/AuthApi.md +365 -6
- package/docs/ChangePhoneNumberRequest.md +37 -0
- package/docs/CreatePhonePasswordUserRequest.md +43 -0
- package/docs/FeaturesResponse.md +2 -0
- package/docs/PasswordResetTokenResponse.md +34 -0
- package/docs/PasswordResetWithTokenRequest.md +2 -2
- package/docs/PhoneValidationResponse.md +34 -0
- package/docs/PhoneVerificationRequest.md +34 -0
- package/docs/RequestPhoneChangeRequest.md +34 -0
- package/docs/ResponseSendPwResetEmail.md +36 -0
- package/docs/SendPasswordResetRequest.md +38 -0
- package/docs/SignInRequest.md +3 -2
- package/docs/UserResponse.md +2 -0
- package/docs/ValidateResetCodeRequest.md +36 -0
- package/package.json +1 -1
- package/src/apis/AuthApi.ts +452 -17
- package/src/models/ChangePhoneNumberRequest.ts +92 -0
- package/src/models/CreatePhonePasswordUserRequest.ts +120 -0
- package/src/models/FeaturesResponse.ts +9 -0
- package/src/models/PasswordResetTokenResponse.ts +83 -0
- package/src/models/PasswordResetWithTokenRequest.ts +5 -5
- package/src/models/PhoneValidationResponse.ts +83 -0
- package/src/models/PhoneVerificationRequest.ts +83 -0
- package/src/models/RequestPhoneChangeRequest.ts +83 -0
- package/src/models/ResponseSendPwResetEmail.ts +107 -0
- package/src/models/SendPasswordResetRequest.ts +109 -0
- package/src/models/SignInRequest.ts +6 -6
- package/src/models/UserResponse.ts +8 -0
- package/src/models/ValidateResetCodeRequest.ts +92 -0
- package/src/models/index.ts +9 -0
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
9
|
+
`passwordResetToken` | string
|
|
10
10
|
`newPassword` | string
|
|
11
11
|
|
|
12
12
|
## Example
|
|
@@ -16,7 +16,7 @@ import type { PasswordResetWithTokenRequest } from '@knowledge-stack/ksapi'
|
|
|
16
16
|
|
|
17
17
|
// TODO: Update the object below with actual values
|
|
18
18
|
const example = {
|
|
19
|
-
"
|
|
19
|
+
"passwordResetToken": null,
|
|
20
20
|
"newPassword": null,
|
|
21
21
|
} satisfies PasswordResetWithTokenRequest
|
|
22
22
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# PhoneValidationResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`phoneValidationId` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { PhoneValidationResponse } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"phoneValidationId": null,
|
|
19
|
+
} satisfies PhoneValidationResponse
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as PhoneValidationResponse
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# PhoneVerificationRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`phoneNumber` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { PhoneVerificationRequest } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"phoneNumber": null,
|
|
19
|
+
} satisfies PhoneVerificationRequest
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as PhoneVerificationRequest
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# RequestPhoneChangeRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`phoneNumber` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { RequestPhoneChangeRequest } from '@knowledge-stack/ksapi'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"phoneNumber": null,
|
|
19
|
+
} satisfies RequestPhoneChangeRequest
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as RequestPhoneChangeRequest
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# ResponseSendPwResetEmail
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`emailId` | string
|
|
10
|
+
`phoneValidationId` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { ResponseSendPwResetEmail } from '@knowledge-stack/ksapi'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"emailId": null,
|
|
20
|
+
"phoneValidationId": null,
|
|
21
|
+
} satisfies ResponseSendPwResetEmail
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as ResponseSendPwResetEmail
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# SendPasswordResetRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`method` | string
|
|
10
|
+
`email` | string
|
|
11
|
+
`phoneNumber` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { SendPasswordResetRequest } from '@knowledge-stack/ksapi'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"method": null,
|
|
21
|
+
"email": null,
|
|
22
|
+
"phoneNumber": null,
|
|
23
|
+
} satisfies SendPasswordResetRequest
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as SendPasswordResetRequest
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
package/docs/SignInRequest.md
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
|
|
2
2
|
# SignInRequest
|
|
3
3
|
|
|
4
|
+
Unified signin — ``username`` matches either email or phone.
|
|
4
5
|
|
|
5
6
|
## Properties
|
|
6
7
|
|
|
7
8
|
Name | Type
|
|
8
9
|
------------ | -------------
|
|
9
|
-
`
|
|
10
|
+
`username` | string
|
|
10
11
|
`password` | string
|
|
11
12
|
`tenantId` | string
|
|
12
13
|
|
|
@@ -17,7 +18,7 @@ import type { SignInRequest } from '@knowledge-stack/ksapi'
|
|
|
17
18
|
|
|
18
19
|
// TODO: Update the object below with actual values
|
|
19
20
|
const example = {
|
|
20
|
-
"
|
|
21
|
+
"username": null,
|
|
21
22
|
"password": null,
|
|
22
23
|
"tenantId": null,
|
|
23
24
|
} satisfies SignInRequest
|
package/docs/UserResponse.md
CHANGED
|
@@ -8,6 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | string
|
|
10
10
|
`email` | string
|
|
11
|
+
`phoneNumber` | string
|
|
11
12
|
`firstName` | string
|
|
12
13
|
`lastName` | string
|
|
13
14
|
`idpType` | [IdpType](IdpType.md)
|
|
@@ -26,6 +27,7 @@ import type { UserResponse } from '@knowledge-stack/ksapi'
|
|
|
26
27
|
const example = {
|
|
27
28
|
"id": null,
|
|
28
29
|
"email": null,
|
|
30
|
+
"phoneNumber": null,
|
|
29
31
|
"firstName": null,
|
|
30
32
|
"lastName": null,
|
|
31
33
|
"idpType": null,
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# ValidateResetCodeRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`phoneValidationId` | string
|
|
10
|
+
`code` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { ValidateResetCodeRequest } from '@knowledge-stack/ksapi'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"phoneValidationId": null,
|
|
20
|
+
"code": null,
|
|
21
|
+
} satisfies ValidateResetCodeRequest
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as ValidateResetCodeRequest
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|