@digital8/lighting-illusions-ts-sdk 0.0.2215 → 0.0.2216

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 (60) hide show
  1. package/.openapi-generator/FILES +12 -0
  2. package/README.md +12 -3
  3. package/dist/apis/AdminsApi.d.ts +0 -12
  4. package/dist/apis/AdminsApi.js +0 -55
  5. package/dist/apis/AuthApi.d.ts +92 -0
  6. package/dist/apis/AuthApi.js +369 -0
  7. package/dist/apis/index.d.ts +1 -0
  8. package/dist/apis/index.js +1 -0
  9. package/dist/models/AddressFrontendResource.d.ts +1 -1
  10. package/dist/models/AddressFrontendResource.js +3 -1
  11. package/dist/models/AddressResource.d.ts +1 -1
  12. package/dist/models/AddressResource.js +1 -3
  13. package/dist/models/AdminLoginResponseResource.d.ts +39 -0
  14. package/dist/models/AdminLoginResponseResource.js +56 -0
  15. package/dist/models/AdminLoginResponseResourceArrayResponse.d.ts +33 -0
  16. package/dist/models/AdminLoginResponseResourceArrayResponse.js +50 -0
  17. package/dist/models/AdminResource.d.ts +6 -0
  18. package/dist/models/AdminResource.js +4 -0
  19. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  20. package/dist/models/ExternalApiLogResource.js +3 -1
  21. package/dist/models/ForgotPasswordAdminRequest.d.ts +32 -0
  22. package/dist/models/ForgotPasswordAdminRequest.js +51 -0
  23. package/dist/models/LoginAdminRequest.d.ts +38 -0
  24. package/dist/models/LoginAdminRequest.js +55 -0
  25. package/dist/models/OrderFulfillmentResource.d.ts +2 -2
  26. package/dist/models/OrderFulfillmentResource.js +4 -4
  27. package/dist/models/ResetPasswordAdminRequest.d.ts +44 -0
  28. package/dist/models/ResetPasswordAdminRequest.js +59 -0
  29. package/dist/models/StoreListResource.d.ts +1 -1
  30. package/dist/models/StoreListResource.js +3 -1
  31. package/dist/models/StoreSpecialDateResource.d.ts +2 -2
  32. package/dist/models/StoreSpecialDateResource.js +1 -3
  33. package/dist/models/index.d.ts +5 -0
  34. package/dist/models/index.js +5 -0
  35. package/docs/AdminLoginResponseResource.md +36 -0
  36. package/docs/AdminLoginResponseResourceArrayResponse.md +34 -0
  37. package/docs/AdminResource.md +2 -0
  38. package/docs/AdminsApi.md +0 -58
  39. package/docs/AuthApi.md +322 -0
  40. package/docs/ForgotPasswordAdminRequest.md +34 -0
  41. package/docs/LoginAdminRequest.md +36 -0
  42. package/docs/ResetPasswordAdminRequest.md +38 -0
  43. package/docs/StoreSpecialDateResource.md +1 -1
  44. package/package.json +1 -1
  45. package/src/apis/AdminsApi.ts +0 -37
  46. package/src/apis/AuthApi.ts +258 -0
  47. package/src/apis/index.ts +1 -0
  48. package/src/models/AddressFrontendResource.ts +3 -2
  49. package/src/models/AddressResource.ts +2 -3
  50. package/src/models/AdminLoginResponseResource.ts +83 -0
  51. package/src/models/AdminLoginResponseResourceArrayResponse.ts +73 -0
  52. package/src/models/AdminResource.ts +9 -0
  53. package/src/models/ExternalApiLogResource.ts +3 -2
  54. package/src/models/ForgotPasswordAdminRequest.ts +66 -0
  55. package/src/models/LoginAdminRequest.ts +75 -0
  56. package/src/models/OrderFulfillmentResource.ts +5 -5
  57. package/src/models/ResetPasswordAdminRequest.ts +84 -0
  58. package/src/models/StoreListResource.ts +3 -2
  59. package/src/models/StoreSpecialDateResource.ts +3 -4
  60. package/src/models/index.ts +5 -0
@@ -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
+
@@ -0,0 +1,34 @@
1
+
2
+ # ForgotPasswordAdminRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `email` | string
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { ForgotPasswordAdminRequest } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "email": null,
19
+ } satisfies ForgotPasswordAdminRequest
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 ForgotPasswordAdminRequest
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
+ # 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
+
@@ -0,0 +1,38 @@
1
+
2
+ # ResetPasswordAdminRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `email` | string
10
+ `token` | string
11
+ `password` | string
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { ResetPasswordAdminRequest } from '@digital8/lighting-illusions-ts-sdk'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "email": null,
21
+ "token": null,
22
+ "password": null,
23
+ } satisfies ResetPasswordAdminRequest
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 ResetPasswordAdminRequest
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
+
@@ -9,7 +9,7 @@ Name | Type
9
9
  `id` | number
10
10
  `name` | string
11
11
  `hours` | string
12
- `date` | object
12
+ `date` | string
13
13
  `closed` | boolean
14
14
  `displayStartDate` | string
15
15
  `displayEndDate` | string
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital8/lighting-illusions-ts-sdk",
3
- "version": "0.0.2215",
3
+ "version": "0.0.2216",
4
4
  "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {
@@ -209,43 +209,6 @@ export class AdminsApi extends runtime.BaseAPI {
209
209
  return await response.value();
210
210
  }
211
211
 
212
- /**
213
- * Creates request options for meAdminUser without sending the request
214
- */
215
- async meAdminUserRequestOpts(): Promise<runtime.RequestOpts> {
216
- const queryParameters: any = {};
217
-
218
- const headerParameters: runtime.HTTPHeaders = {};
219
-
220
-
221
- let urlPath = `/admin-api/admins/me`;
222
-
223
- return {
224
- path: urlPath,
225
- method: 'GET',
226
- headers: headerParameters,
227
- query: queryParameters,
228
- };
229
- }
230
-
231
- /**
232
- * Auto-generated: meAdminUser
233
- */
234
- async meAdminUserRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminResource>> {
235
- const requestOptions = await this.meAdminUserRequestOpts();
236
- const response = await this.request(requestOptions, initOverrides);
237
-
238
- return new runtime.JSONApiResponse(response, (jsonValue) => AdminResourceFromJSON(jsonValue));
239
- }
240
-
241
- /**
242
- * Auto-generated: meAdminUser
243
- */
244
- async meAdminUser(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminResource> {
245
- const response = await this.meAdminUserRaw(initOverrides);
246
- return await response.value();
247
- }
248
-
249
212
  /**
250
213
  * Creates request options for showAdminUser without sending the request
251
214
  */