@digital8/lighting-illusions-ts-sdk 0.0.2289 → 0.0.2291
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 +12 -4
- package/README.md +12 -5
- package/dist/apis/AdminsApi.d.ts +0 -13
- package/dist/apis/AdminsApi.js +0 -56
- package/dist/apis/AuthApi.d.ts +92 -0
- package/dist/apis/AuthApi.js +369 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +1 -3
- package/dist/models/AddressResource.d.ts +1 -1
- package/dist/models/AddressResource.js +1 -3
- package/dist/models/AdminLoginResponseResource.d.ts +39 -0
- package/dist/models/AdminLoginResponseResource.js +56 -0
- package/dist/models/AdminLoginResponseResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminLoginResponseResourceArrayResponse.js +50 -0
- package/dist/models/AdminResource.d.ts +6 -0
- package/dist/models/AdminResource.js +4 -0
- package/dist/models/ForgotPasswordAdminRequest.d.ts +32 -0
- package/dist/models/ForgotPasswordAdminRequest.js +51 -0
- package/dist/models/LoginAdminRequest.d.ts +38 -0
- package/dist/models/LoginAdminRequest.js +55 -0
- package/dist/models/OrderFulfillmentResource.d.ts +2 -2
- package/dist/models/OrderFulfillmentResource.js +2 -6
- package/dist/models/ResetPasswordAdminRequest.d.ts +44 -0
- package/dist/models/ResetPasswordAdminRequest.js +59 -0
- package/dist/models/RoleListResource.d.ts +6 -0
- package/dist/models/RoleListResource.js +4 -0
- package/dist/models/SearchAdminUsersRequest.d.ts +6 -6
- package/dist/models/SearchAdminUsersRequest.js +2 -2
- package/dist/models/SearchAllAdminUsersRequest.d.ts +0 -6
- package/dist/models/SearchAllAdminUsersRequest.js +0 -2
- package/dist/models/SearchAllPermissionsRequest.d.ts +0 -6
- package/dist/models/SearchAllPermissionsRequest.js +0 -2
- package/dist/models/SearchAllRolesRequest.d.ts +0 -6
- package/dist/models/SearchAllRolesRequest.js +0 -2
- package/dist/models/SearchPermissionsRequest.d.ts +0 -6
- package/dist/models/SearchPermissionsRequest.js +0 -2
- package/dist/models/SearchRolesRequest.d.ts +0 -6
- package/dist/models/SearchRolesRequest.js +0 -2
- package/dist/models/StoreFrontendResource.d.ts +1 -1
- package/dist/models/StoreFrontendResource.js +1 -3
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +1 -3
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +3 -1
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +1 -3
- package/dist/models/index.d.ts +5 -2
- package/dist/models/index.js +5 -2
- package/docs/{AdminMeResource.md → AdminLoginResponseResource.md} +8 -16
- package/docs/AdminLoginResponseResourceArrayResponse.md +34 -0
- package/docs/AdminResource.md +2 -0
- package/docs/AdminsApi.md +0 -58
- package/docs/AuthApi.md +322 -0
- package/docs/{AdminMeResourceArrayResponse.md → ForgotPasswordAdminRequest.md} +6 -6
- package/docs/LoginAdminRequest.md +36 -0
- package/docs/ResetPasswordAdminRequest.md +38 -0
- package/docs/RoleListResource.md +2 -0
- package/docs/SearchAdminUsersRequest.md +2 -2
- package/docs/SearchAllAdminUsersRequest.md +0 -2
- package/docs/SearchAllPermissionsRequest.md +0 -2
- package/docs/SearchAllRolesRequest.md +0 -2
- package/docs/SearchPermissionsRequest.md +0 -2
- package/docs/SearchRolesRequest.md +0 -2
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/package.json +1 -1
- package/src/apis/AdminsApi.ts +0 -42
- package/src/apis/AuthApi.ts +258 -0
- package/src/apis/index.ts +1 -0
- package/src/models/AddressFrontendResource.ts +2 -3
- package/src/models/AddressResource.ts +2 -3
- package/src/models/AdminLoginResponseResource.ts +83 -0
- package/src/models/AdminLoginResponseResourceArrayResponse.ts +73 -0
- package/src/models/AdminResource.ts +9 -0
- package/src/models/ForgotPasswordAdminRequest.ts +66 -0
- package/src/models/LoginAdminRequest.ts +75 -0
- package/src/models/OrderFulfillmentResource.ts +4 -6
- package/src/models/ResetPasswordAdminRequest.ts +84 -0
- package/src/models/RoleListResource.ts +9 -0
- package/src/models/SearchAdminUsersRequest.ts +8 -8
- package/src/models/SearchAllAdminUsersRequest.ts +0 -8
- package/src/models/SearchAllPermissionsRequest.ts +0 -8
- package/src/models/SearchAllRolesRequest.ts +0 -8
- package/src/models/SearchPermissionsRequest.ts +0 -8
- package/src/models/SearchRolesRequest.ts +0 -8
- package/src/models/StoreFrontendResource.ts +2 -3
- package/src/models/StoreListResource.ts +2 -3
- package/src/models/StoreResource.ts +3 -2
- package/src/models/StoreSpecialDateFrontendResource.ts +3 -4
- package/src/models/index.ts +5 -2
- package/dist/models/AdminMeResource.d.ts +0 -64
- package/dist/models/AdminMeResource.js +0 -69
- package/dist/models/AdminMeResourceArrayResponse.d.ts +0 -33
- package/dist/models/AdminMeResourceArrayResponse.js +0 -50
- package/src/models/AdminMeResource.ts +0 -124
- package/src/models/AdminMeResourceArrayResponse.ts +0 -73
|
@@ -35,10 +35,10 @@ export interface StoreSpecialDateFrontendResource {
|
|
|
35
35
|
hours: string;
|
|
36
36
|
/**
|
|
37
37
|
*
|
|
38
|
-
* @type {
|
|
38
|
+
* @type {string}
|
|
39
39
|
* @memberof StoreSpecialDateFrontendResource
|
|
40
40
|
*/
|
|
41
|
-
date
|
|
41
|
+
date?: string | null;
|
|
42
42
|
/**
|
|
43
43
|
*
|
|
44
44
|
* @type {boolean}
|
|
@@ -26,8 +26,6 @@ function instanceOfStoreSpecialDateFrontendResource(value) {
|
|
|
26
26
|
return false;
|
|
27
27
|
if (!('hours' in value) || value['hours'] === undefined)
|
|
28
28
|
return false;
|
|
29
|
-
if (!('date' in value) || value['date'] === undefined)
|
|
30
|
-
return false;
|
|
31
29
|
if (!('closed' in value) || value['closed'] === undefined)
|
|
32
30
|
return false;
|
|
33
31
|
if (!('displayStartDate' in value) || value['displayStartDate'] === undefined)
|
|
@@ -47,7 +45,7 @@ function StoreSpecialDateFrontendResourceFromJSONTyped(json, ignoreDiscriminator
|
|
|
47
45
|
'id': json['id'] == null ? undefined : json['id'],
|
|
48
46
|
'name': json['name'],
|
|
49
47
|
'hours': json['hours'],
|
|
50
|
-
'date': json['date'],
|
|
48
|
+
'date': json['date'] == null ? undefined : json['date'],
|
|
51
49
|
'closed': json['closed'],
|
|
52
50
|
'displayStartDate': json['displayStartDate'],
|
|
53
51
|
'displayEndDate': json['displayEndDate'],
|
package/dist/models/index.d.ts
CHANGED
|
@@ -7,8 +7,8 @@ export * from './AdminListResource';
|
|
|
7
7
|
export * from './AdminListResourceArrayResponse';
|
|
8
8
|
export * from './AdminLiteResource';
|
|
9
9
|
export * from './AdminLiteResourceArrayResponse';
|
|
10
|
-
export * from './
|
|
11
|
-
export * from './
|
|
10
|
+
export * from './AdminLoginResponseResource';
|
|
11
|
+
export * from './AdminLoginResponseResourceArrayResponse';
|
|
12
12
|
export * from './AdminNoteResource';
|
|
13
13
|
export * from './AdminNoteResourceArrayResponse';
|
|
14
14
|
export * from './AdminOrderLineItemResource';
|
|
@@ -185,6 +185,7 @@ export * from './ExternalApiLogResource';
|
|
|
185
185
|
export * from './ExternalApiLogResourceArrayResponse';
|
|
186
186
|
export * from './ExternalApiProvider';
|
|
187
187
|
export * from './ExternalApiSyncStatus';
|
|
188
|
+
export * from './ForgotPasswordAdminRequest';
|
|
188
189
|
export * from './FrontendCartResource';
|
|
189
190
|
export * from './FrontendCartResourceArrayResponse';
|
|
190
191
|
export * from './FrontendCartResourceCouponsInner';
|
|
@@ -224,6 +225,7 @@ export * from './LineItemDiscountResourceArrayResponse';
|
|
|
224
225
|
export * from './LineItemListResource';
|
|
225
226
|
export * from './LineItemListResourceArrayResponse';
|
|
226
227
|
export * from './LinkOverlayTemplateToAssetsRequest';
|
|
228
|
+
export * from './LoginAdminRequest';
|
|
227
229
|
export * from './MenuIdRequest';
|
|
228
230
|
export * from './MenuItemHierarchyResource';
|
|
229
231
|
export * from './MenuItemHierarchyResourceArrayResponse';
|
|
@@ -487,6 +489,7 @@ export * from './RedirectFrontendResourceArrayResponse';
|
|
|
487
489
|
export * from './RedirectListResource';
|
|
488
490
|
export * from './RedirectListResourceArrayResponse';
|
|
489
491
|
export * from './RefundTransactionRequest';
|
|
492
|
+
export * from './ResetPasswordAdminRequest';
|
|
490
493
|
export * from './ReviewExportDownloadUrlResource';
|
|
491
494
|
export * from './ReviewExportDownloadUrlResourceArrayResponse';
|
|
492
495
|
export * from './ReviewImportFailureResource';
|
package/dist/models/index.js
CHANGED
|
@@ -25,8 +25,8 @@ __exportStar(require("./AdminListResource"), exports);
|
|
|
25
25
|
__exportStar(require("./AdminListResourceArrayResponse"), exports);
|
|
26
26
|
__exportStar(require("./AdminLiteResource"), exports);
|
|
27
27
|
__exportStar(require("./AdminLiteResourceArrayResponse"), exports);
|
|
28
|
-
__exportStar(require("./
|
|
29
|
-
__exportStar(require("./
|
|
28
|
+
__exportStar(require("./AdminLoginResponseResource"), exports);
|
|
29
|
+
__exportStar(require("./AdminLoginResponseResourceArrayResponse"), exports);
|
|
30
30
|
__exportStar(require("./AdminNoteResource"), exports);
|
|
31
31
|
__exportStar(require("./AdminNoteResourceArrayResponse"), exports);
|
|
32
32
|
__exportStar(require("./AdminOrderLineItemResource"), exports);
|
|
@@ -203,6 +203,7 @@ __exportStar(require("./ExternalApiLogResource"), exports);
|
|
|
203
203
|
__exportStar(require("./ExternalApiLogResourceArrayResponse"), exports);
|
|
204
204
|
__exportStar(require("./ExternalApiProvider"), exports);
|
|
205
205
|
__exportStar(require("./ExternalApiSyncStatus"), exports);
|
|
206
|
+
__exportStar(require("./ForgotPasswordAdminRequest"), exports);
|
|
206
207
|
__exportStar(require("./FrontendCartResource"), exports);
|
|
207
208
|
__exportStar(require("./FrontendCartResourceArrayResponse"), exports);
|
|
208
209
|
__exportStar(require("./FrontendCartResourceCouponsInner"), exports);
|
|
@@ -242,6 +243,7 @@ __exportStar(require("./LineItemDiscountResourceArrayResponse"), exports);
|
|
|
242
243
|
__exportStar(require("./LineItemListResource"), exports);
|
|
243
244
|
__exportStar(require("./LineItemListResourceArrayResponse"), exports);
|
|
244
245
|
__exportStar(require("./LinkOverlayTemplateToAssetsRequest"), exports);
|
|
246
|
+
__exportStar(require("./LoginAdminRequest"), exports);
|
|
245
247
|
__exportStar(require("./MenuIdRequest"), exports);
|
|
246
248
|
__exportStar(require("./MenuItemHierarchyResource"), exports);
|
|
247
249
|
__exportStar(require("./MenuItemHierarchyResourceArrayResponse"), exports);
|
|
@@ -505,6 +507,7 @@ __exportStar(require("./RedirectFrontendResourceArrayResponse"), exports);
|
|
|
505
507
|
__exportStar(require("./RedirectListResource"), exports);
|
|
506
508
|
__exportStar(require("./RedirectListResourceArrayResponse"), exports);
|
|
507
509
|
__exportStar(require("./RefundTransactionRequest"), exports);
|
|
510
|
+
__exportStar(require("./ResetPasswordAdminRequest"), exports);
|
|
508
511
|
__exportStar(require("./ReviewExportDownloadUrlResource"), exports);
|
|
509
512
|
__exportStar(require("./ReviewExportDownloadUrlResourceArrayResponse"), exports);
|
|
510
513
|
__exportStar(require("./ReviewImportFailureResource"), exports);
|
|
@@ -1,32 +1,24 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AdminLoginResponseResource
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
10
|
-
`
|
|
11
|
-
`roles` | [Array<RoleLiteResource>](RoleLiteResource.md)
|
|
12
|
-
`createdAt` | string
|
|
13
|
-
`updatedAt` | string
|
|
14
|
-
`permissions` | Array<string>
|
|
9
|
+
`token` | string
|
|
10
|
+
`admin` | [AdminResource](AdminResource.md)
|
|
15
11
|
|
|
16
12
|
## Example
|
|
17
13
|
|
|
18
14
|
```typescript
|
|
19
|
-
import type {
|
|
15
|
+
import type { AdminLoginResponseResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
20
16
|
|
|
21
17
|
// TODO: Update the object below with actual values
|
|
22
18
|
const example = {
|
|
23
|
-
"
|
|
24
|
-
"
|
|
25
|
-
|
|
26
|
-
"createdAt": null,
|
|
27
|
-
"updatedAt": null,
|
|
28
|
-
"permissions": null,
|
|
29
|
-
} satisfies AdminMeResource
|
|
19
|
+
"token": null,
|
|
20
|
+
"admin": null,
|
|
21
|
+
} satisfies AdminLoginResponseResource
|
|
30
22
|
|
|
31
23
|
console.log(example)
|
|
32
24
|
|
|
@@ -35,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
35
27
|
console.log(exampleJSON)
|
|
36
28
|
|
|
37
29
|
// Parse the JSON string back to an object
|
|
38
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as AdminLoginResponseResource
|
|
39
31
|
console.log(exampleParsed)
|
|
40
32
|
```
|
|
41
33
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# AdminLoginResponseResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<AdminLoginResponseResource>](AdminLoginResponseResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AdminLoginResponseResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies AdminLoginResponseResourceArrayResponse
|
|
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 AdminLoginResponseResourceArrayResponse
|
|
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/AdminResource.md
CHANGED
|
@@ -9,6 +9,7 @@ Name | Type
|
|
|
9
9
|
`id` | number
|
|
10
10
|
`user` | [UserLiteResource](UserLiteResource.md)
|
|
11
11
|
`roles` | [Array<RoleLiteResource>](RoleLiteResource.md)
|
|
12
|
+
`permissions` | object
|
|
12
13
|
`createdAt` | Date
|
|
13
14
|
`updatedAt` | Date
|
|
14
15
|
|
|
@@ -22,6 +23,7 @@ const example = {
|
|
|
22
23
|
"id": null,
|
|
23
24
|
"user": null,
|
|
24
25
|
"roles": null,
|
|
26
|
+
"permissions": null,
|
|
25
27
|
"createdAt": null,
|
|
26
28
|
"updatedAt": null,
|
|
27
29
|
} satisfies AdminResource
|
package/docs/AdminsApi.md
CHANGED
|
@@ -7,7 +7,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
7
7
|
| [**destroyAdminUser**](AdminsApi.md#destroyadminuser) | **DELETE** /admin-api/admins/{admin}/delete | Auto-generated: destroyAdminUser |
|
|
8
8
|
| [**getAllAdminUser**](AdminsApi.md#getalladminuser) | **POST** /admin-api/admins/all | Auto-generated: getAllAdminUser |
|
|
9
9
|
| [**indexAdminUser**](AdminsApi.md#indexadminuser) | **POST** /admin-api/admins/list | Auto-generated: indexAdminUser |
|
|
10
|
-
| [**meAdminUser**](AdminsApi.md#meadminuser) | **GET** /admin-api/admins/me | Auto-generated: meAdminUser |
|
|
11
10
|
| [**showAdminUser**](AdminsApi.md#showadminuser) | **GET** /admin-api/admins/{admin} | Auto-generated: showAdminUser |
|
|
12
11
|
| [**storeAdminUser**](AdminsApi.md#storeadminuser) | **POST** /admin-api/admins/create | Auto-generated: storeAdminUser |
|
|
13
12
|
| [**updateAdminUser**](AdminsApi.md#updateadminuseroperation) | **PUT** /admin-api/admins/{admin}/update | Auto-generated: updateAdminUser |
|
|
@@ -209,63 +208,6 @@ No authorization required
|
|
|
209
208
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
210
209
|
|
|
211
210
|
|
|
212
|
-
## meAdminUser
|
|
213
|
-
|
|
214
|
-
> AdminMeResource meAdminUser()
|
|
215
|
-
|
|
216
|
-
Auto-generated: meAdminUser
|
|
217
|
-
|
|
218
|
-
### Example
|
|
219
|
-
|
|
220
|
-
```ts
|
|
221
|
-
import {
|
|
222
|
-
Configuration,
|
|
223
|
-
AdminsApi,
|
|
224
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
225
|
-
import type { MeAdminUserRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
226
|
-
|
|
227
|
-
async function example() {
|
|
228
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
229
|
-
const api = new AdminsApi();
|
|
230
|
-
|
|
231
|
-
try {
|
|
232
|
-
const data = await api.meAdminUser();
|
|
233
|
-
console.log(data);
|
|
234
|
-
} catch (error) {
|
|
235
|
-
console.error(error);
|
|
236
|
-
}
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
// Run the test
|
|
240
|
-
example().catch(console.error);
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
### Parameters
|
|
244
|
-
|
|
245
|
-
This endpoint does not need any parameter.
|
|
246
|
-
|
|
247
|
-
### Return type
|
|
248
|
-
|
|
249
|
-
[**AdminMeResource**](AdminMeResource.md)
|
|
250
|
-
|
|
251
|
-
### Authorization
|
|
252
|
-
|
|
253
|
-
No authorization required
|
|
254
|
-
|
|
255
|
-
### HTTP request headers
|
|
256
|
-
|
|
257
|
-
- **Content-Type**: Not defined
|
|
258
|
-
- **Accept**: `application/json`
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
### HTTP response details
|
|
262
|
-
| Status code | Description | Response headers |
|
|
263
|
-
|-------------|-------------|------------------|
|
|
264
|
-
| **200** | Successful resource response | - |
|
|
265
|
-
|
|
266
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
267
|
-
|
|
268
|
-
|
|
269
211
|
## showAdminUser
|
|
270
212
|
|
|
271
213
|
> AdminResource showAdminUser(admin)
|
package/docs/AuthApi.md
ADDED
|
@@ -0,0 +1,322 @@
|
|
|
1
|
+
# AuthApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost/api*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**forgotPasswordAdminAuth**](AuthApi.md#forgotpasswordadminauth) | **POST** /admin-api/auth/admin/forgot-password | Auto-generated: forgotPasswordAdminAuth |
|
|
8
|
+
| [**loginAdminAuth**](AuthApi.md#loginadminauth) | **POST** /admin-api/auth/admin/login | Auto-generated: loginAdminAuth |
|
|
9
|
+
| [**logoutAdminAuth**](AuthApi.md#logoutadminauth) | **POST** /admin-api/auth/admin/logout | Auto-generated: logoutAdminAuth |
|
|
10
|
+
| [**meAdminAuth**](AuthApi.md#meadminauth) | **GET** /admin-api/auth/admin/me | Auto-generated: meAdminAuth |
|
|
11
|
+
| [**resetPasswordAdminAuth**](AuthApi.md#resetpasswordadminauth) | **POST** /admin-api/auth/admin/reset-password | Auto-generated: resetPasswordAdminAuth |
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## forgotPasswordAdminAuth
|
|
16
|
+
|
|
17
|
+
> GenericResponse forgotPasswordAdminAuth(forgotPasswordAdminRequest)
|
|
18
|
+
|
|
19
|
+
Auto-generated: forgotPasswordAdminAuth
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
import {
|
|
25
|
+
Configuration,
|
|
26
|
+
AuthApi,
|
|
27
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
28
|
+
import type { ForgotPasswordAdminAuthRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
29
|
+
|
|
30
|
+
async function example() {
|
|
31
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
32
|
+
const api = new AuthApi();
|
|
33
|
+
|
|
34
|
+
const body = {
|
|
35
|
+
// ForgotPasswordAdminRequest (optional)
|
|
36
|
+
forgotPasswordAdminRequest: ...,
|
|
37
|
+
} satisfies ForgotPasswordAdminAuthRequest;
|
|
38
|
+
|
|
39
|
+
try {
|
|
40
|
+
const data = await api.forgotPasswordAdminAuth(body);
|
|
41
|
+
console.log(data);
|
|
42
|
+
} catch (error) {
|
|
43
|
+
console.error(error);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// Run the test
|
|
48
|
+
example().catch(console.error);
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### Parameters
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
| Name | Type | Description | Notes |
|
|
55
|
+
|------------- | ------------- | ------------- | -------------|
|
|
56
|
+
| **forgotPasswordAdminRequest** | [ForgotPasswordAdminRequest](ForgotPasswordAdminRequest.md) | | [Optional] |
|
|
57
|
+
|
|
58
|
+
### Return type
|
|
59
|
+
|
|
60
|
+
[**GenericResponse**](GenericResponse.md)
|
|
61
|
+
|
|
62
|
+
### Authorization
|
|
63
|
+
|
|
64
|
+
No authorization required
|
|
65
|
+
|
|
66
|
+
### HTTP request headers
|
|
67
|
+
|
|
68
|
+
- **Content-Type**: `application/json`
|
|
69
|
+
- **Accept**: `application/json`
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
### HTTP response details
|
|
73
|
+
| Status code | Description | Response headers |
|
|
74
|
+
|-------------|-------------|------------------|
|
|
75
|
+
| **200** | Generic JSON success | - |
|
|
76
|
+
|
|
77
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
## loginAdminAuth
|
|
81
|
+
|
|
82
|
+
> AdminLoginResponseResource loginAdminAuth(loginAdminRequest)
|
|
83
|
+
|
|
84
|
+
Auto-generated: loginAdminAuth
|
|
85
|
+
|
|
86
|
+
### Example
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
import {
|
|
90
|
+
Configuration,
|
|
91
|
+
AuthApi,
|
|
92
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
93
|
+
import type { LoginAdminAuthRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
94
|
+
|
|
95
|
+
async function example() {
|
|
96
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
97
|
+
const api = new AuthApi();
|
|
98
|
+
|
|
99
|
+
const body = {
|
|
100
|
+
// LoginAdminRequest (optional)
|
|
101
|
+
loginAdminRequest: ...,
|
|
102
|
+
} satisfies LoginAdminAuthRequest;
|
|
103
|
+
|
|
104
|
+
try {
|
|
105
|
+
const data = await api.loginAdminAuth(body);
|
|
106
|
+
console.log(data);
|
|
107
|
+
} catch (error) {
|
|
108
|
+
console.error(error);
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
// Run the test
|
|
113
|
+
example().catch(console.error);
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Parameters
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
| Name | Type | Description | Notes |
|
|
120
|
+
|------------- | ------------- | ------------- | -------------|
|
|
121
|
+
| **loginAdminRequest** | [LoginAdminRequest](LoginAdminRequest.md) | | [Optional] |
|
|
122
|
+
|
|
123
|
+
### Return type
|
|
124
|
+
|
|
125
|
+
[**AdminLoginResponseResource**](AdminLoginResponseResource.md)
|
|
126
|
+
|
|
127
|
+
### Authorization
|
|
128
|
+
|
|
129
|
+
No authorization required
|
|
130
|
+
|
|
131
|
+
### HTTP request headers
|
|
132
|
+
|
|
133
|
+
- **Content-Type**: `application/json`
|
|
134
|
+
- **Accept**: `application/json`
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
### HTTP response details
|
|
138
|
+
| Status code | Description | Response headers |
|
|
139
|
+
|-------------|-------------|------------------|
|
|
140
|
+
| **200** | Successful resource response | - |
|
|
141
|
+
|
|
142
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
## logoutAdminAuth
|
|
146
|
+
|
|
147
|
+
> GenericResponse logoutAdminAuth()
|
|
148
|
+
|
|
149
|
+
Auto-generated: logoutAdminAuth
|
|
150
|
+
|
|
151
|
+
### Example
|
|
152
|
+
|
|
153
|
+
```ts
|
|
154
|
+
import {
|
|
155
|
+
Configuration,
|
|
156
|
+
AuthApi,
|
|
157
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
158
|
+
import type { LogoutAdminAuthRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
159
|
+
|
|
160
|
+
async function example() {
|
|
161
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
162
|
+
const api = new AuthApi();
|
|
163
|
+
|
|
164
|
+
try {
|
|
165
|
+
const data = await api.logoutAdminAuth();
|
|
166
|
+
console.log(data);
|
|
167
|
+
} catch (error) {
|
|
168
|
+
console.error(error);
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
// Run the test
|
|
173
|
+
example().catch(console.error);
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
### Parameters
|
|
177
|
+
|
|
178
|
+
This endpoint does not need any parameter.
|
|
179
|
+
|
|
180
|
+
### Return type
|
|
181
|
+
|
|
182
|
+
[**GenericResponse**](GenericResponse.md)
|
|
183
|
+
|
|
184
|
+
### Authorization
|
|
185
|
+
|
|
186
|
+
No authorization required
|
|
187
|
+
|
|
188
|
+
### HTTP request headers
|
|
189
|
+
|
|
190
|
+
- **Content-Type**: Not defined
|
|
191
|
+
- **Accept**: `application/json`
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
### HTTP response details
|
|
195
|
+
| Status code | Description | Response headers |
|
|
196
|
+
|-------------|-------------|------------------|
|
|
197
|
+
| **200** | Generic JSON success | - |
|
|
198
|
+
|
|
199
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
## meAdminAuth
|
|
203
|
+
|
|
204
|
+
> AdminResource meAdminAuth()
|
|
205
|
+
|
|
206
|
+
Auto-generated: meAdminAuth
|
|
207
|
+
|
|
208
|
+
### Example
|
|
209
|
+
|
|
210
|
+
```ts
|
|
211
|
+
import {
|
|
212
|
+
Configuration,
|
|
213
|
+
AuthApi,
|
|
214
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
215
|
+
import type { MeAdminAuthRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
216
|
+
|
|
217
|
+
async function example() {
|
|
218
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
219
|
+
const api = new AuthApi();
|
|
220
|
+
|
|
221
|
+
try {
|
|
222
|
+
const data = await api.meAdminAuth();
|
|
223
|
+
console.log(data);
|
|
224
|
+
} catch (error) {
|
|
225
|
+
console.error(error);
|
|
226
|
+
}
|
|
227
|
+
}
|
|
228
|
+
|
|
229
|
+
// Run the test
|
|
230
|
+
example().catch(console.error);
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
### Parameters
|
|
234
|
+
|
|
235
|
+
This endpoint does not need any parameter.
|
|
236
|
+
|
|
237
|
+
### Return type
|
|
238
|
+
|
|
239
|
+
[**AdminResource**](AdminResource.md)
|
|
240
|
+
|
|
241
|
+
### Authorization
|
|
242
|
+
|
|
243
|
+
No authorization required
|
|
244
|
+
|
|
245
|
+
### HTTP request headers
|
|
246
|
+
|
|
247
|
+
- **Content-Type**: Not defined
|
|
248
|
+
- **Accept**: `application/json`
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
### HTTP response details
|
|
252
|
+
| Status code | Description | Response headers |
|
|
253
|
+
|-------------|-------------|------------------|
|
|
254
|
+
| **200** | Successful resource response | - |
|
|
255
|
+
|
|
256
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
## resetPasswordAdminAuth
|
|
260
|
+
|
|
261
|
+
> GenericResponse resetPasswordAdminAuth(resetPasswordAdminRequest)
|
|
262
|
+
|
|
263
|
+
Auto-generated: resetPasswordAdminAuth
|
|
264
|
+
|
|
265
|
+
### Example
|
|
266
|
+
|
|
267
|
+
```ts
|
|
268
|
+
import {
|
|
269
|
+
Configuration,
|
|
270
|
+
AuthApi,
|
|
271
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
272
|
+
import type { ResetPasswordAdminAuthRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
273
|
+
|
|
274
|
+
async function example() {
|
|
275
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
276
|
+
const api = new AuthApi();
|
|
277
|
+
|
|
278
|
+
const body = {
|
|
279
|
+
// ResetPasswordAdminRequest (optional)
|
|
280
|
+
resetPasswordAdminRequest: ...,
|
|
281
|
+
} satisfies ResetPasswordAdminAuthRequest;
|
|
282
|
+
|
|
283
|
+
try {
|
|
284
|
+
const data = await api.resetPasswordAdminAuth(body);
|
|
285
|
+
console.log(data);
|
|
286
|
+
} catch (error) {
|
|
287
|
+
console.error(error);
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
// Run the test
|
|
292
|
+
example().catch(console.error);
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
### Parameters
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
| Name | Type | Description | Notes |
|
|
299
|
+
|------------- | ------------- | ------------- | -------------|
|
|
300
|
+
| **resetPasswordAdminRequest** | [ResetPasswordAdminRequest](ResetPasswordAdminRequest.md) | | [Optional] |
|
|
301
|
+
|
|
302
|
+
### Return type
|
|
303
|
+
|
|
304
|
+
[**GenericResponse**](GenericResponse.md)
|
|
305
|
+
|
|
306
|
+
### Authorization
|
|
307
|
+
|
|
308
|
+
No authorization required
|
|
309
|
+
|
|
310
|
+
### HTTP request headers
|
|
311
|
+
|
|
312
|
+
- **Content-Type**: `application/json`
|
|
313
|
+
- **Accept**: `application/json`
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
### HTTP response details
|
|
317
|
+
| Status code | Description | Response headers |
|
|
318
|
+
|-------------|-------------|------------------|
|
|
319
|
+
| **200** | Generic JSON success | - |
|
|
320
|
+
|
|
321
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
322
|
+
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# ForgotPasswordAdminRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
9
|
+
`email` | string
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { ForgotPasswordAdminRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
|
-
"
|
|
19
|
-
} satisfies
|
|
18
|
+
"email": null,
|
|
19
|
+
} satisfies ForgotPasswordAdminRequest
|
|
20
20
|
|
|
21
21
|
console.log(example)
|
|
22
22
|
|
|
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
25
|
console.log(exampleJSON)
|
|
26
26
|
|
|
27
27
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as ForgotPasswordAdminRequest
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# LoginAdminRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`email` | string
|
|
10
|
+
`password` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { LoginAdminRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"email": null,
|
|
20
|
+
"password": null,
|
|
21
|
+
} satisfies LoginAdminRequest
|
|
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 LoginAdminRequest
|
|
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
|
+
|