@digital8/laravel-auth-template-ts-sdk 0.0.7 → 0.0.8
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 +31 -2
- package/.openapi-generator/VERSION +1 -1
- package/README.md +121 -28
- package/dist/apis/{AuthApi.d.ts → GeneralApi.d.ts} +47 -2
- package/dist/apis/{AuthApi.js → GeneralApi.js} +200 -16
- package/dist/apis/index.d.ts +1 -2
- package/dist/apis/index.js +1 -2
- package/dist/models/AssetFileForUploadResource.d.ts +50 -0
- package/dist/models/AssetFileForUploadResource.js +63 -0
- package/dist/models/AssetFileForUploadResourceArrayResponse.d.ts +33 -0
- package/dist/models/AssetFileForUploadResourceArrayResponse.js +50 -0
- package/dist/models/AssetLiteResource.d.ts +38 -0
- package/dist/models/AssetLiteResource.js +55 -0
- package/dist/models/AssetLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/AssetLiteResourceArrayResponse.js +50 -0
- package/dist/models/AssetResource.d.ts +68 -0
- package/dist/models/AssetResource.js +75 -0
- package/dist/models/AssetResourceArrayResponse.d.ts +33 -0
- package/dist/models/AssetResourceArrayResponse.js +50 -0
- package/dist/models/IndexUserRequest.d.ts +28 -4
- package/dist/models/IndexUserRequest.js +25 -6
- package/dist/models/StoreAssetFileRequest.d.ts +38 -0
- package/dist/models/StoreAssetFileRequest.js +55 -0
- package/dist/models/UpdateUserRequest.d.ts +13 -1
- package/dist/models/UpdateUserRequest.js +12 -0
- package/dist/models/UserAuthTokenResourceArrayResponse.d.ts +33 -0
- package/dist/models/UserAuthTokenResourceArrayResponse.js +50 -0
- package/dist/models/UserResource.d.ts +7 -0
- package/dist/models/UserResource.js +7 -3
- package/dist/models/UserResourceArrayResponse.d.ts +33 -0
- package/dist/models/UserResourceArrayResponse.js +50 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/docs/AssetFileForUploadResource.md +40 -0
- package/docs/AssetFileForUploadResourceArrayResponse.md +34 -0
- package/docs/AssetLiteResource.md +36 -0
- package/docs/AssetLiteResourceArrayResponse.md +34 -0
- package/docs/AssetResource.md +46 -0
- package/docs/AssetResourceArrayResponse.md +34 -0
- package/docs/GeneralApi.md +597 -0
- package/docs/GenericResponse.md +34 -0
- package/docs/IndexUserRequest.md +42 -0
- package/docs/LoginAuthRequest.md +36 -0
- package/docs/PaginatedUserResourceResponse.md +36 -0
- package/docs/PagingMetadata.md +46 -0
- package/docs/ResetPasswordAuthRequest.md +38 -0
- package/docs/SendForgotPasswordLinkAuthRequest.md +34 -0
- package/docs/StoreAssetFileRequest.md +36 -0
- package/docs/StoreUserRequest.md +40 -0
- package/docs/UpdateUserRequest.md +50 -0
- package/docs/UserAuthTokenResource.md +36 -0
- package/docs/UserAuthTokenResourceArrayResponse.md +34 -0
- package/docs/UserResource.md +50 -0
- package/docs/UserResourceArrayResponse.md +34 -0
- package/package.json +2 -2
- package/src/apis/{AuthApi.ts → GeneralApi.ts} +174 -1
- package/src/apis/index.ts +1 -2
- package/src/models/AssetFileForUploadResource.ts +93 -0
- package/src/models/AssetFileForUploadResourceArrayResponse.ts +73 -0
- package/src/models/AssetLiteResource.ts +75 -0
- package/src/models/AssetLiteResourceArrayResponse.ts +73 -0
- package/src/models/AssetResource.ts +120 -0
- package/src/models/AssetResourceArrayResponse.ts +73 -0
- package/src/models/IndexUserRequest.ts +40 -10
- package/src/models/StoreAssetFileRequest.ts +75 -0
- package/src/models/UpdateUserRequest.ts +16 -1
- package/src/models/UserAuthTokenResourceArrayResponse.ts +73 -0
- package/src/models/UserResource.ts +19 -2
- package/src/models/UserResourceArrayResponse.ts +73 -0
- package/src/models/index.ts +9 -0
- package/dist/apis/UsersApi.d.ts +0 -52
- package/dist/apis/UsersApi.js +0 -219
- package/src/apis/UsersApi.ts +0 -164
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedUserResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<UserResource>](UserResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedUserResourceResponse } from '@digital8/laravel-auth-template-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"data": null,
|
|
20
|
+
"meta": null,
|
|
21
|
+
} satisfies PaginatedUserResourceResponse
|
|
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 PaginatedUserResourceResponse
|
|
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,46 @@
|
|
|
1
|
+
|
|
2
|
+
# PagingMetadata
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`currentPage` | number
|
|
10
|
+
`from` | number
|
|
11
|
+
`lastPage` | number
|
|
12
|
+
`path` | number
|
|
13
|
+
`perPage` | number
|
|
14
|
+
`to` | number
|
|
15
|
+
`total` | number
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import type { PagingMetadata } from '@digital8/laravel-auth-template-ts-sdk'
|
|
21
|
+
|
|
22
|
+
// TODO: Update the object below with actual values
|
|
23
|
+
const example = {
|
|
24
|
+
"currentPage": null,
|
|
25
|
+
"from": null,
|
|
26
|
+
"lastPage": null,
|
|
27
|
+
"path": null,
|
|
28
|
+
"perPage": null,
|
|
29
|
+
"to": null,
|
|
30
|
+
"total": null,
|
|
31
|
+
} satisfies PagingMetadata
|
|
32
|
+
|
|
33
|
+
console.log(example)
|
|
34
|
+
|
|
35
|
+
// Convert the instance to a JSON string
|
|
36
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
37
|
+
console.log(exampleJSON)
|
|
38
|
+
|
|
39
|
+
// Parse the JSON string back to an object
|
|
40
|
+
const exampleParsed = JSON.parse(exampleJSON) as PagingMetadata
|
|
41
|
+
console.log(exampleParsed)
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
45
|
+
|
|
46
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# ResetPasswordAuthRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`email` | string
|
|
10
|
+
`password` | string
|
|
11
|
+
`token` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ResetPasswordAuthRequest } from '@digital8/laravel-auth-template-ts-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"email": null,
|
|
21
|
+
"password": null,
|
|
22
|
+
"token": null,
|
|
23
|
+
} satisfies ResetPasswordAuthRequest
|
|
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 ResetPasswordAuthRequest
|
|
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
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# SendForgotPasswordLinkAuthRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`email` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { SendForgotPasswordLinkAuthRequest } from '@digital8/laravel-auth-template-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"email": null,
|
|
19
|
+
} satisfies SendForgotPasswordLinkAuthRequest
|
|
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 SendForgotPasswordLinkAuthRequest
|
|
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
|
+
# StoreAssetFileRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`fileName` | string
|
|
10
|
+
`fileType` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { StoreAssetFileRequest } from '@digital8/laravel-auth-template-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"fileName": null,
|
|
20
|
+
"fileType": null,
|
|
21
|
+
} satisfies StoreAssetFileRequest
|
|
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 StoreAssetFileRequest
|
|
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,40 @@
|
|
|
1
|
+
|
|
2
|
+
# StoreUserRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`firstName` | string
|
|
10
|
+
`lastName` | string
|
|
11
|
+
`email` | string
|
|
12
|
+
`mobile` | number
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { StoreUserRequest } from '@digital8/laravel-auth-template-ts-sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"firstName": null,
|
|
22
|
+
"lastName": null,
|
|
23
|
+
"email": null,
|
|
24
|
+
"mobile": null,
|
|
25
|
+
} satisfies StoreUserRequest
|
|
26
|
+
|
|
27
|
+
console.log(example)
|
|
28
|
+
|
|
29
|
+
// Convert the instance to a JSON string
|
|
30
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
31
|
+
console.log(exampleJSON)
|
|
32
|
+
|
|
33
|
+
// Parse the JSON string back to an object
|
|
34
|
+
const exampleParsed = JSON.parse(exampleJSON) as StoreUserRequest
|
|
35
|
+
console.log(exampleParsed)
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
39
|
+
|
|
40
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
|
|
2
|
+
# UpdateUserRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`firstName` | string
|
|
10
|
+
`lastName` | string
|
|
11
|
+
`email` | string
|
|
12
|
+
`mobile` | number
|
|
13
|
+
`password` | string
|
|
14
|
+
`role` | string
|
|
15
|
+
`teamIds` | Array<number>
|
|
16
|
+
`businessUnitIds` | Array<number>
|
|
17
|
+
`type` | string
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { UpdateUserRequest } from '@digital8/laravel-auth-template-ts-sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"firstName": null,
|
|
27
|
+
"lastName": null,
|
|
28
|
+
"email": null,
|
|
29
|
+
"mobile": null,
|
|
30
|
+
"password": null,
|
|
31
|
+
"role": null,
|
|
32
|
+
"teamIds": null,
|
|
33
|
+
"businessUnitIds": null,
|
|
34
|
+
"type": null,
|
|
35
|
+
} satisfies UpdateUserRequest
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as UpdateUserRequest
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
49
|
+
|
|
50
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# UserAuthTokenResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`user` | [UserResource](UserResource.md)
|
|
10
|
+
`token` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { UserAuthTokenResource } from '@digital8/laravel-auth-template-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"user": null,
|
|
20
|
+
"token": null,
|
|
21
|
+
} satisfies UserAuthTokenResource
|
|
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 UserAuthTokenResource
|
|
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,34 @@
|
|
|
1
|
+
|
|
2
|
+
# UserAuthTokenResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<UserAuthTokenResource>](UserAuthTokenResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { UserAuthTokenResourceArrayResponse } from '@digital8/laravel-auth-template-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies UserAuthTokenResourceArrayResponse
|
|
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 UserAuthTokenResourceArrayResponse
|
|
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,50 @@
|
|
|
1
|
+
|
|
2
|
+
# UserResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`firstName` | string
|
|
11
|
+
`lastName` | string
|
|
12
|
+
`fullName` | string
|
|
13
|
+
`email` | string
|
|
14
|
+
`mobile` | string
|
|
15
|
+
`assets` | [Array<AssetLiteResource>](AssetLiteResource.md)
|
|
16
|
+
`createdAt` | Date
|
|
17
|
+
`updatedAt` | Date
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { UserResource } from '@digital8/laravel-auth-template-ts-sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"id": null,
|
|
27
|
+
"firstName": null,
|
|
28
|
+
"lastName": null,
|
|
29
|
+
"fullName": null,
|
|
30
|
+
"email": null,
|
|
31
|
+
"mobile": null,
|
|
32
|
+
"assets": null,
|
|
33
|
+
"createdAt": null,
|
|
34
|
+
"updatedAt": null,
|
|
35
|
+
} satisfies UserResource
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as UserResource
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
49
|
+
|
|
50
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# UserResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<UserResource>](UserResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { UserResourceArrayResponse } from '@digital8/laravel-auth-template-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies UserResourceArrayResponse
|
|
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 UserResourceArrayResponse
|
|
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
|
+
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@digital8/laravel-auth-template-ts-sdk",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.8",
|
|
4
4
|
"description": "OpenAPI client for @digital8/laravel-auth-template-ts-sdk",
|
|
5
5
|
"author": "OpenAPI-Generator",
|
|
6
6
|
"repository": {
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
|
|
9
9
|
},
|
|
10
10
|
"main": "./dist/index.js",
|
|
11
|
-
"
|
|
11
|
+
"types": "./dist/index.d.ts",
|
|
12
12
|
"scripts": {
|
|
13
13
|
"build": "tsc",
|
|
14
14
|
"prepare": "npm run build"
|
|
@@ -15,31 +15,54 @@
|
|
|
15
15
|
|
|
16
16
|
import * as runtime from '../runtime';
|
|
17
17
|
import type {
|
|
18
|
+
AssetFileForUploadResource,
|
|
18
19
|
GenericResponse,
|
|
20
|
+
IndexUserRequest,
|
|
19
21
|
LoginAuthRequest,
|
|
22
|
+
PaginatedUserResourceResponse,
|
|
20
23
|
ResetPasswordAuthRequest,
|
|
21
24
|
SendForgotPasswordLinkAuthRequest,
|
|
25
|
+
StoreAssetFileRequest,
|
|
22
26
|
StoreUserRequest,
|
|
27
|
+
UpdateUserRequest,
|
|
23
28
|
UserAuthTokenResource,
|
|
24
29
|
UserResource,
|
|
25
30
|
} from '../models/index';
|
|
26
31
|
import {
|
|
32
|
+
AssetFileForUploadResourceFromJSON,
|
|
33
|
+
AssetFileForUploadResourceToJSON,
|
|
27
34
|
GenericResponseFromJSON,
|
|
28
35
|
GenericResponseToJSON,
|
|
36
|
+
IndexUserRequestFromJSON,
|
|
37
|
+
IndexUserRequestToJSON,
|
|
29
38
|
LoginAuthRequestFromJSON,
|
|
30
39
|
LoginAuthRequestToJSON,
|
|
40
|
+
PaginatedUserResourceResponseFromJSON,
|
|
41
|
+
PaginatedUserResourceResponseToJSON,
|
|
31
42
|
ResetPasswordAuthRequestFromJSON,
|
|
32
43
|
ResetPasswordAuthRequestToJSON,
|
|
33
44
|
SendForgotPasswordLinkAuthRequestFromJSON,
|
|
34
45
|
SendForgotPasswordLinkAuthRequestToJSON,
|
|
46
|
+
StoreAssetFileRequestFromJSON,
|
|
47
|
+
StoreAssetFileRequestToJSON,
|
|
35
48
|
StoreUserRequestFromJSON,
|
|
36
49
|
StoreUserRequestToJSON,
|
|
50
|
+
UpdateUserRequestFromJSON,
|
|
51
|
+
UpdateUserRequestToJSON,
|
|
37
52
|
UserAuthTokenResourceFromJSON,
|
|
38
53
|
UserAuthTokenResourceToJSON,
|
|
39
54
|
UserResourceFromJSON,
|
|
40
55
|
UserResourceToJSON,
|
|
41
56
|
} from '../models/index';
|
|
42
57
|
|
|
58
|
+
export interface DestroyUserRequest {
|
|
59
|
+
user: number;
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export interface IndexUserOperationRequest {
|
|
63
|
+
indexUserRequest?: IndexUserRequest;
|
|
64
|
+
}
|
|
65
|
+
|
|
43
66
|
export interface LoginAuthOperationRequest {
|
|
44
67
|
loginAuthRequest?: LoginAuthRequest;
|
|
45
68
|
}
|
|
@@ -52,14 +75,92 @@ export interface SendForgotPasswordLinkAuthOperationRequest {
|
|
|
52
75
|
sendForgotPasswordLinkAuthRequest?: SendForgotPasswordLinkAuthRequest;
|
|
53
76
|
}
|
|
54
77
|
|
|
78
|
+
export interface StoreAssetFileOperationRequest {
|
|
79
|
+
storeAssetFileRequest?: StoreAssetFileRequest;
|
|
80
|
+
}
|
|
81
|
+
|
|
55
82
|
export interface StoreUserOperationRequest {
|
|
56
83
|
storeUserRequest?: StoreUserRequest;
|
|
57
84
|
}
|
|
58
85
|
|
|
86
|
+
export interface UpdateUserOperationRequest {
|
|
87
|
+
user: number;
|
|
88
|
+
updateUserRequest?: UpdateUserRequest;
|
|
89
|
+
}
|
|
90
|
+
|
|
59
91
|
/**
|
|
60
92
|
*
|
|
61
93
|
*/
|
|
62
|
-
export class
|
|
94
|
+
export class GeneralApi extends runtime.BaseAPI {
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* Auto-generated: destroyUser
|
|
98
|
+
*/
|
|
99
|
+
async destroyUserRaw(requestParameters: DestroyUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
|
|
100
|
+
if (requestParameters['user'] == null) {
|
|
101
|
+
throw new runtime.RequiredError(
|
|
102
|
+
'user',
|
|
103
|
+
'Required parameter "user" was null or undefined when calling destroyUser().'
|
|
104
|
+
);
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
const queryParameters: any = {};
|
|
108
|
+
|
|
109
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
let urlPath = `/api/users/{user}/delete`;
|
|
113
|
+
urlPath = urlPath.replace(`{${"user"}}`, encodeURIComponent(String(requestParameters['user'])));
|
|
114
|
+
|
|
115
|
+
const response = await this.request({
|
|
116
|
+
path: urlPath,
|
|
117
|
+
method: 'POST',
|
|
118
|
+
headers: headerParameters,
|
|
119
|
+
query: queryParameters,
|
|
120
|
+
}, initOverrides);
|
|
121
|
+
|
|
122
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Auto-generated: destroyUser
|
|
127
|
+
*/
|
|
128
|
+
async destroyUser(requestParameters: DestroyUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
|
|
129
|
+
const response = await this.destroyUserRaw(requestParameters, initOverrides);
|
|
130
|
+
return await response.value();
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* Auto-generated: indexUser
|
|
135
|
+
*/
|
|
136
|
+
async indexUserRaw(requestParameters: IndexUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedUserResourceResponse>> {
|
|
137
|
+
const queryParameters: any = {};
|
|
138
|
+
|
|
139
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
140
|
+
|
|
141
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
let urlPath = `/api/users/search`;
|
|
145
|
+
|
|
146
|
+
const response = await this.request({
|
|
147
|
+
path: urlPath,
|
|
148
|
+
method: 'POST',
|
|
149
|
+
headers: headerParameters,
|
|
150
|
+
query: queryParameters,
|
|
151
|
+
body: IndexUserRequestToJSON(requestParameters['indexUserRequest']),
|
|
152
|
+
}, initOverrides);
|
|
153
|
+
|
|
154
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedUserResourceResponseFromJSON(jsonValue));
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* Auto-generated: indexUser
|
|
159
|
+
*/
|
|
160
|
+
async indexUser(requestParameters: IndexUserOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedUserResourceResponse> {
|
|
161
|
+
const response = await this.indexUserRaw(requestParameters, initOverrides);
|
|
162
|
+
return await response.value();
|
|
163
|
+
}
|
|
63
164
|
|
|
64
165
|
/**
|
|
65
166
|
* Auto-generated: loginAuth
|
|
@@ -186,6 +287,38 @@ export class AuthApi extends runtime.BaseAPI {
|
|
|
186
287
|
return await response.value();
|
|
187
288
|
}
|
|
188
289
|
|
|
290
|
+
/**
|
|
291
|
+
* Auto-generated: storeAssetFile
|
|
292
|
+
*/
|
|
293
|
+
async storeAssetFileRaw(requestParameters: StoreAssetFileOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AssetFileForUploadResource>> {
|
|
294
|
+
const queryParameters: any = {};
|
|
295
|
+
|
|
296
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
297
|
+
|
|
298
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
let urlPath = `/api/assets/file`;
|
|
302
|
+
|
|
303
|
+
const response = await this.request({
|
|
304
|
+
path: urlPath,
|
|
305
|
+
method: 'POST',
|
|
306
|
+
headers: headerParameters,
|
|
307
|
+
query: queryParameters,
|
|
308
|
+
body: StoreAssetFileRequestToJSON(requestParameters['storeAssetFileRequest']),
|
|
309
|
+
}, initOverrides);
|
|
310
|
+
|
|
311
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => AssetFileForUploadResourceFromJSON(jsonValue));
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
/**
|
|
315
|
+
* Auto-generated: storeAssetFile
|
|
316
|
+
*/
|
|
317
|
+
async storeAssetFile(requestParameters: StoreAssetFileOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AssetFileForUploadResource> {
|
|
318
|
+
const response = await this.storeAssetFileRaw(requestParameters, initOverrides);
|
|
319
|
+
return await response.value();
|
|
320
|
+
}
|
|
321
|
+
|
|
189
322
|
/**
|
|
190
323
|
* Auto-generated: storeUser
|
|
191
324
|
*/
|
|
@@ -218,4 +351,44 @@ export class AuthApi extends runtime.BaseAPI {
|
|
|
218
351
|
return await response.value();
|
|
219
352
|
}
|
|
220
353
|
|
|
354
|
+
/**
|
|
355
|
+
* Auto-generated: updateUser
|
|
356
|
+
*/
|
|
357
|
+
async updateUserRaw(requestParameters: UpdateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserResource>> {
|
|
358
|
+
if (requestParameters['user'] == null) {
|
|
359
|
+
throw new runtime.RequiredError(
|
|
360
|
+
'user',
|
|
361
|
+
'Required parameter "user" was null or undefined when calling updateUser().'
|
|
362
|
+
);
|
|
363
|
+
}
|
|
364
|
+
|
|
365
|
+
const queryParameters: any = {};
|
|
366
|
+
|
|
367
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
368
|
+
|
|
369
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
let urlPath = `/api/users/{user}/update`;
|
|
373
|
+
urlPath = urlPath.replace(`{${"user"}}`, encodeURIComponent(String(requestParameters['user'])));
|
|
374
|
+
|
|
375
|
+
const response = await this.request({
|
|
376
|
+
path: urlPath,
|
|
377
|
+
method: 'POST',
|
|
378
|
+
headers: headerParameters,
|
|
379
|
+
query: queryParameters,
|
|
380
|
+
body: UpdateUserRequestToJSON(requestParameters['updateUserRequest']),
|
|
381
|
+
}, initOverrides);
|
|
382
|
+
|
|
383
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => UserResourceFromJSON(jsonValue));
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
* Auto-generated: updateUser
|
|
388
|
+
*/
|
|
389
|
+
async updateUser(requestParameters: UpdateUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserResource> {
|
|
390
|
+
const response = await this.updateUserRaw(requestParameters, initOverrides);
|
|
391
|
+
return await response.value();
|
|
392
|
+
}
|
|
393
|
+
|
|
221
394
|
}
|
package/src/apis/index.ts
CHANGED