@digital8/laravel-auth-template-ts-sdk 0.0.8 → 0.0.10

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 (27) hide show
  1. package/.openapi-generator/FILES +0 -21
  2. package/.openapi-generator/VERSION +1 -1
  3. package/README.md +28 -121
  4. package/dist/models/UserResource.js +3 -2
  5. package/package.json +2 -2
  6. package/src/models/UserResource.ts +2 -2
  7. package/docs/AssetFileForUploadResource.md +0 -40
  8. package/docs/AssetFileForUploadResourceArrayResponse.md +0 -34
  9. package/docs/AssetLiteResource.md +0 -36
  10. package/docs/AssetLiteResourceArrayResponse.md +0 -34
  11. package/docs/AssetResource.md +0 -46
  12. package/docs/AssetResourceArrayResponse.md +0 -34
  13. package/docs/GeneralApi.md +0 -597
  14. package/docs/GenericResponse.md +0 -34
  15. package/docs/IndexUserRequest.md +0 -42
  16. package/docs/LoginAuthRequest.md +0 -36
  17. package/docs/PaginatedUserResourceResponse.md +0 -36
  18. package/docs/PagingMetadata.md +0 -46
  19. package/docs/ResetPasswordAuthRequest.md +0 -38
  20. package/docs/SendForgotPasswordLinkAuthRequest.md +0 -34
  21. package/docs/StoreAssetFileRequest.md +0 -36
  22. package/docs/StoreUserRequest.md +0 -40
  23. package/docs/UpdateUserRequest.md +0 -50
  24. package/docs/UserAuthTokenResource.md +0 -36
  25. package/docs/UserAuthTokenResourceArrayResponse.md +0 -34
  26. package/docs/UserResource.md +0 -50
  27. package/docs/UserResourceArrayResponse.md +0 -34
package/docs/PaginatedUserResourceResponse.md DELETED
@@ -1,36 +0,0 @@
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
-
package/docs/PagingMetadata.md DELETED
@@ -1,46 +0,0 @@
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
-
package/docs/ResetPasswordAuthRequest.md DELETED
@@ -1,38 +0,0 @@
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
-
package/docs/SendForgotPasswordLinkAuthRequest.md DELETED
@@ -1,34 +0,0 @@
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
-
package/docs/StoreAssetFileRequest.md DELETED
@@ -1,36 +0,0 @@
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
-
package/docs/StoreUserRequest.md DELETED
@@ -1,40 +0,0 @@
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
-
package/docs/UpdateUserRequest.md DELETED
@@ -1,50 +0,0 @@
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
-
package/docs/UserAuthTokenResource.md DELETED
@@ -1,36 +0,0 @@
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
-
package/docs/UserAuthTokenResourceArrayResponse.md DELETED
@@ -1,34 +0,0 @@
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
-
package/docs/UserResource.md DELETED
@@ -1,50 +0,0 @@
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
-
package/docs/UserResourceArrayResponse.md DELETED
@@ -1,34 +0,0 @@
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
-