@digital8/lighting-illusions-ts-sdk 0.0.1697 → 0.0.1698

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 (118) hide show
  1. package/.openapi-generator/FILES +34 -6
  2. package/README.md +26 -7
  3. package/dist/apis/ReviewApi.d.ts +139 -0
  4. package/dist/apis/ReviewApi.js +566 -0
  5. package/dist/apis/StoreApi.d.ts +1 -28
  6. package/dist/apis/StoreApi.js +0 -113
  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 +1 -3
  11. package/dist/models/AddressResource.d.ts +2 -2
  12. package/dist/models/AddressResource.js +4 -4
  13. package/dist/models/AdminUserLiteResource.d.ts +50 -0
  14. package/dist/models/AdminUserLiteResource.js +61 -0
  15. package/dist/models/AdminUserLiteResourceArrayResponse.d.ts +33 -0
  16. package/dist/models/AdminUserLiteResourceArrayResponse.js +50 -0
  17. package/dist/models/CustomerLiteResource.d.ts +50 -0
  18. package/dist/models/CustomerLiteResource.js +61 -0
  19. package/dist/models/CustomerLiteResourceArrayResponse.d.ts +33 -0
  20. package/dist/models/CustomerLiteResourceArrayResponse.js +50 -0
  21. package/dist/models/IndexReviewRequest.d.ts +110 -0
  22. package/dist/models/IndexReviewRequest.js +86 -0
  23. package/dist/models/PaginatedReviewListResourceResponse.d.ts +40 -0
  24. package/dist/models/PaginatedReviewListResourceResponse.js +57 -0
  25. package/dist/models/PaginatedReviewLiteResourceResponse.d.ts +40 -0
  26. package/dist/models/PaginatedReviewLiteResourceResponse.js +57 -0
  27. package/dist/models/PaginatedReviewResourceResponse.d.ts +40 -0
  28. package/dist/models/PaginatedReviewResourceResponse.js +57 -0
  29. package/dist/models/ReviewListResource.d.ts +88 -0
  30. package/dist/models/ReviewListResource.js +83 -0
  31. package/dist/models/ReviewListResourceArrayResponse.d.ts +33 -0
  32. package/dist/models/ReviewListResourceArrayResponse.js +50 -0
  33. package/dist/models/ReviewLiteResource.d.ts +44 -0
  34. package/dist/models/ReviewLiteResource.js +59 -0
  35. package/dist/models/ReviewLiteResourceArrayResponse.d.ts +33 -0
  36. package/dist/models/ReviewLiteResourceArrayResponse.js +50 -0
  37. package/dist/models/ReviewResource.d.ts +120 -0
  38. package/dist/models/ReviewResource.js +103 -0
  39. package/dist/models/ReviewResourceArrayResponse.d.ts +33 -0
  40. package/dist/models/ReviewResourceArrayResponse.js +50 -0
  41. package/dist/models/StoreFrontendResource.d.ts +1 -1
  42. package/dist/models/StoreFrontendResource.js +3 -1
  43. package/dist/models/StoreListResource.d.ts +1 -1
  44. package/dist/models/StoreListResource.js +1 -3
  45. package/dist/models/StoreResource.d.ts +0 -12
  46. package/dist/models/StoreResource.js +0 -4
  47. package/dist/models/StoreReviewRequest.d.ts +74 -0
  48. package/dist/models/StoreReviewRequest.js +71 -0
  49. package/dist/models/StoreSpecialDateResource.d.ts +2 -2
  50. package/dist/models/StoreSpecialDateResource.js +3 -1
  51. package/dist/models/StoreStoreRequest.d.ts +0 -12
  52. package/dist/models/StoreStoreRequest.js +0 -4
  53. package/dist/models/UpdateReviewRequest.d.ts +62 -0
  54. package/dist/models/UpdateReviewRequest.js +63 -0
  55. package/dist/models/UpdateStoreRequest.d.ts +0 -12
  56. package/dist/models/UpdateStoreRequest.js +0 -4
  57. package/dist/models/index.d.ts +16 -3
  58. package/dist/models/index.js +16 -3
  59. package/docs/{SaveMapStoreStockMigrationRequestAssociationsInner.md → AdminUserLiteResource.md} +12 -10
  60. package/docs/AdminUserLiteResourceArrayResponse.md +34 -0
  61. package/docs/CustomerLiteResource.md +40 -0
  62. package/docs/{SaveMapStoreStockMigrationRequest.md → CustomerLiteResourceArrayResponse.md} +6 -6
  63. package/docs/IndexReviewRequest.md +54 -0
  64. package/docs/PaginatedReviewListResourceResponse.md +36 -0
  65. package/docs/PaginatedReviewLiteResourceResponse.md +36 -0
  66. package/docs/PaginatedReviewResourceResponse.md +36 -0
  67. package/docs/ReviewApi.md +539 -0
  68. package/docs/ReviewListResource.md +52 -0
  69. package/docs/ReviewListResourceArrayResponse.md +34 -0
  70. package/docs/ReviewLiteResource.md +38 -0
  71. package/docs/ReviewLiteResourceArrayResponse.md +34 -0
  72. package/docs/ReviewResource.md +62 -0
  73. package/docs/{StoreStockType.md → ReviewResourceArrayResponse.md} +6 -4
  74. package/docs/StoreApi.md +0 -124
  75. package/docs/StoreResource.md +0 -4
  76. package/docs/StoreReviewRequest.md +48 -0
  77. package/docs/StoreSpecialDateResource.md +1 -1
  78. package/docs/StoreStoreRequest.md +0 -4
  79. package/docs/UpdateReviewRequest.md +44 -0
  80. package/docs/UpdateStoreRequest.md +0 -4
  81. package/package.json +1 -1
  82. package/src/apis/ReviewApi.ts +444 -0
  83. package/src/apis/StoreApi.ts +0 -84
  84. package/src/apis/index.ts +1 -0
  85. package/src/models/AddressFrontendResource.ts +2 -3
  86. package/src/models/AddressResource.ts +5 -5
  87. package/src/models/AdminUserLiteResource.ts +92 -0
  88. package/src/models/AdminUserLiteResourceArrayResponse.ts +73 -0
  89. package/src/models/CustomerLiteResource.ts +92 -0
  90. package/src/models/CustomerLiteResourceArrayResponse.ts +73 -0
  91. package/src/models/IndexReviewRequest.ts +167 -0
  92. package/src/models/PaginatedReviewListResourceResponse.ts +90 -0
  93. package/src/models/PaginatedReviewLiteResourceResponse.ts +90 -0
  94. package/src/models/PaginatedReviewResourceResponse.ts +90 -0
  95. package/src/models/ReviewListResource.ts +159 -0
  96. package/src/models/ReviewListResourceArrayResponse.ts +73 -0
  97. package/src/models/ReviewLiteResource.ts +84 -0
  98. package/src/models/ReviewLiteResourceArrayResponse.ts +73 -0
  99. package/src/models/ReviewResource.ts +217 -0
  100. package/src/models/ReviewResourceArrayResponse.ts +73 -0
  101. package/src/models/StoreFrontendResource.ts +3 -2
  102. package/src/models/StoreListResource.ts +2 -3
  103. package/src/models/StoreResource.ts +0 -16
  104. package/src/models/StoreReviewRequest.ts +125 -0
  105. package/src/models/StoreSpecialDateResource.ts +4 -3
  106. package/src/models/StoreStoreRequest.ts +0 -16
  107. package/src/models/UpdateReviewRequest.ts +107 -0
  108. package/src/models/UpdateStoreRequest.ts +0 -16
  109. package/src/models/index.ts +16 -3
  110. package/dist/models/SaveMapStoreStockMigrationRequest.d.ts +0 -33
  111. package/dist/models/SaveMapStoreStockMigrationRequest.js +0 -52
  112. package/dist/models/SaveMapStoreStockMigrationRequestAssociationsInner.d.ts +0 -52
  113. package/dist/models/SaveMapStoreStockMigrationRequestAssociationsInner.js +0 -67
  114. package/dist/models/StoreStockType.d.ts +0 -25
  115. package/dist/models/StoreStockType.js +0 -51
  116. package/src/models/SaveMapStoreStockMigrationRequest.ts +0 -74
  117. package/src/models/SaveMapStoreStockMigrationRequestAssociationsInner.ts +0 -95
  118. package/src/models/StoreStockType.ts +0 -53
@@ -0,0 +1,62 @@
1
+
2
+ # ReviewResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `reviewerName` | string
11
+ `rating` | number
12
+ `comment` | string
13
+ `replyFromAdmin` | string
14
+ `location` | string
15
+ `createdByAdmin` | boolean
16
+ `approvedAt` | Date
17
+ `createdAt` | Date
18
+ `updatedAt` | Date
19
+ `site` | [SiteLiteResource](SiteLiteResource.md)
20
+ `productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
21
+ `customer` | [CustomerLiteResource](CustomerLiteResource.md)
22
+ `admin` | [AdminUserLiteResource](AdminUserLiteResource.md)
23
+ `approver` | [AdminUserLiteResource](AdminUserLiteResource.md)
24
+
25
+ ## Example
26
+
27
+ ```typescript
28
+ import type { ReviewResource } from '@digital8/lighting-illusions-ts-sdk'
29
+
30
+ // TODO: Update the object below with actual values
31
+ const example = {
32
+ "id": null,
33
+ "reviewerName": null,
34
+ "rating": null,
35
+ "comment": null,
36
+ "replyFromAdmin": null,
37
+ "location": null,
38
+ "createdByAdmin": null,
39
+ "approvedAt": null,
40
+ "createdAt": null,
41
+ "updatedAt": null,
42
+ "site": null,
43
+ "productChild": null,
44
+ "customer": null,
45
+ "admin": null,
46
+ "approver": null,
47
+ } satisfies ReviewResource
48
+
49
+ console.log(example)
50
+
51
+ // Convert the instance to a JSON string
52
+ const exampleJSON: string = JSON.stringify(example)
53
+ console.log(exampleJSON)
54
+
55
+ // Parse the JSON string back to an object
56
+ const exampleParsed = JSON.parse(exampleJSON) as ReviewResource
57
+ console.log(exampleParsed)
58
+ ```
59
+
60
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
61
+
62
+
@@ -1,20 +1,22 @@
1
1
 
2
- # StoreStockType
2
+ # ReviewResourceArrayResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
+ `data` | [Array<ReviewResource>](ReviewResource.md)
9
10
 
10
11
  ## Example
11
12
 
12
13
  ```typescript
13
- import type { StoreStockType } from '@digital8/lighting-illusions-ts-sdk'
14
+ import type { ReviewResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
14
15
 
15
16
  // TODO: Update the object below with actual values
16
17
  const example = {
17
- } satisfies StoreStockType
18
+ "data": null,
19
+ } satisfies ReviewResourceArrayResponse
18
20
 
19
21
  console.log(example)
20
22
 
@@ -23,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
23
25
  console.log(exampleJSON)
24
26
 
25
27
  // Parse the JSON string back to an object
26
- const exampleParsed = JSON.parse(exampleJSON) as StoreStockType
28
+ const exampleParsed = JSON.parse(exampleJSON) as ReviewResourceArrayResponse
27
29
  console.log(exampleParsed)
28
30
  ```
29
31
 
package/docs/StoreApi.md CHANGED
@@ -10,8 +10,6 @@ All URIs are relative to *http://localhost/api*
10
10
  | [**detachSuppliersStore**](StoreApi.md#detachsuppliersstoreoperation) | **POST** /admin-api/store/{store}/detach-suppliers | Auto-generated: detachSuppliersStore |
11
11
  | [**getAllStore**](StoreApi.md#getallstoreoperation) | **POST** /admin-api/store/all | Auto-generated: getAllStore |
12
12
  | [**indexStore**](StoreApi.md#indexstoreoperation) | **POST** /admin-api/store/list | Auto-generated: indexStore |
13
- | [**optionsStoreStockMigration**](StoreApi.md#optionsstorestockmigration) | **GET** /admin-api/store/stock-migration/options | Auto-generated: optionsStoreStockMigration |
14
- | [**saveMapStoreStockMigration**](StoreApi.md#savemapstorestockmigrationoperation) | **POST** /admin-api/store/stock-migration/save-map | Auto-generated: saveMapStoreStockMigration |
15
13
  | [**showStore**](StoreApi.md#showstore) | **GET** /admin-api/store/{store} | Auto-generated: showStore |
16
14
  | [**storeStore**](StoreApi.md#storestoreoperation) | **POST** /admin-api/store/create | Auto-generated: storeStore |
17
15
  | [**storeStoreSpecialDate**](StoreApi.md#storestorespecialdateoperation) | **POST** /admin-api/store/{store}/special-dates | Auto-generated: storeStoreSpecialDate |
@@ -419,128 +417,6 @@ No authorization required
419
417
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
420
418
 
421
419
 
422
- ## optionsStoreStockMigration
423
-
424
- > GenericResponse optionsStoreStockMigration()
425
-
426
- Auto-generated: optionsStoreStockMigration
427
-
428
- ### Example
429
-
430
- ```ts
431
- import {
432
- Configuration,
433
- StoreApi,
434
- } from '@digital8/lighting-illusions-ts-sdk';
435
- import type { OptionsStoreStockMigrationRequest } from '@digital8/lighting-illusions-ts-sdk';
436
-
437
- async function example() {
438
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
439
- const api = new StoreApi();
440
-
441
- try {
442
- const data = await api.optionsStoreStockMigration();
443
- console.log(data);
444
- } catch (error) {
445
- console.error(error);
446
- }
447
- }
448
-
449
- // Run the test
450
- example().catch(console.error);
451
- ```
452
-
453
- ### Parameters
454
-
455
- This endpoint does not need any parameter.
456
-
457
- ### Return type
458
-
459
- [**GenericResponse**](GenericResponse.md)
460
-
461
- ### Authorization
462
-
463
- No authorization required
464
-
465
- ### HTTP request headers
466
-
467
- - **Content-Type**: Not defined
468
- - **Accept**: `application/json`
469
-
470
-
471
- ### HTTP response details
472
- | Status code | Description | Response headers |
473
- |-------------|-------------|------------------|
474
- | **200** | \\JsonResponse<array{locations: array<int,array{id: int, name: string, isPrimary: bool}>, stores: array<int,array{id: int, name: string}>, existingMap: array<string,array{store_id: int, type: string}>, existingMapFilePath: string|null}> | - |
475
-
476
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
477
-
478
-
479
- ## saveMapStoreStockMigration
480
-
481
- > GenericResponse saveMapStoreStockMigration(saveMapStoreStockMigrationRequest)
482
-
483
- Auto-generated: saveMapStoreStockMigration
484
-
485
- ### Example
486
-
487
- ```ts
488
- import {
489
- Configuration,
490
- StoreApi,
491
- } from '@digital8/lighting-illusions-ts-sdk';
492
- import type { SaveMapStoreStockMigrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
493
-
494
- async function example() {
495
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
496
- const api = new StoreApi();
497
-
498
- const body = {
499
- // SaveMapStoreStockMigrationRequest (optional)
500
- saveMapStoreStockMigrationRequest: ...,
501
- } satisfies SaveMapStoreStockMigrationOperationRequest;
502
-
503
- try {
504
- const data = await api.saveMapStoreStockMigration(body);
505
- console.log(data);
506
- } catch (error) {
507
- console.error(error);
508
- }
509
- }
510
-
511
- // Run the test
512
- example().catch(console.error);
513
- ```
514
-
515
- ### Parameters
516
-
517
-
518
- | Name | Type | Description | Notes |
519
- |------------- | ------------- | ------------- | -------------|
520
- | **saveMapStoreStockMigrationRequest** | [SaveMapStoreStockMigrationRequest](SaveMapStoreStockMigrationRequest.md) | | [Optional] |
521
-
522
- ### Return type
523
-
524
- [**GenericResponse**](GenericResponse.md)
525
-
526
- ### Authorization
527
-
528
- No authorization required
529
-
530
- ### HTTP request headers
531
-
532
- - **Content-Type**: `application/json`
533
- - **Accept**: `application/json`
534
-
535
-
536
- ### HTTP response details
537
- | Status code | Description | Response headers |
538
- |-------------|-------------|------------------|
539
- | **200** | \\JsonResponse<array{message: string, filePath: string, command: string}> | - |
540
-
541
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
542
-
543
-
544
420
  ## showStore
545
421
 
546
422
  > StoreResource showStore(store)
@@ -15,8 +15,6 @@ Name | Type
15
15
  `tagLine` | string
16
16
  `email` | string
17
17
  `website` | string
18
- `netsuiteId` | number
19
- `displayNetsuiteId` | number
20
18
  `openingHours` | string
21
19
  `suppliers` | [Array<SupplierLiteResource>](SupplierLiteResource.md)
22
20
  `address` | [AddressResource](AddressResource.md)
@@ -38,8 +36,6 @@ const example = {
38
36
  "tagLine": null,
39
37
  "email": null,
40
38
  "website": null,
41
- "netsuiteId": null,
42
- "displayNetsuiteId": null,
43
39
  "openingHours": null,
44
40
  "suppliers": null,
45
41
  "address": null,
@@ -0,0 +1,48 @@
1
+
2
+ # StoreReviewRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `productChildId` | number
10
+ `siteId` | number
11
+ `customerId` | number
12
+ `invoiceItemId` | number
13
+ `reviewerName` | string
14
+ `rating` | number
15
+ `comment` | string
16
+ `location` | string
17
+
18
+ ## Example
19
+
20
+ ```typescript
21
+ import type { StoreReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
22
+
23
+ // TODO: Update the object below with actual values
24
+ const example = {
25
+ "productChildId": null,
26
+ "siteId": null,
27
+ "customerId": null,
28
+ "invoiceItemId": null,
29
+ "reviewerName": null,
30
+ "rating": null,
31
+ "comment": null,
32
+ "location": null,
33
+ } satisfies StoreReviewRequest
34
+
35
+ console.log(example)
36
+
37
+ // Convert the instance to a JSON string
38
+ const exampleJSON: string = JSON.stringify(example)
39
+ console.log(exampleJSON)
40
+
41
+ // Parse the JSON string back to an object
42
+ const exampleParsed = JSON.parse(exampleJSON) as StoreReviewRequest
43
+ console.log(exampleParsed)
44
+ ```
45
+
46
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
47
+
48
+
@@ -9,7 +9,7 @@ Name | Type
9
9
  `id` | number
10
10
  `name` | string
11
11
  `hours` | string
12
- `date` | string
12
+ `date` | object
13
13
  `closed` | boolean
14
14
  `displayStartDate` | string
15
15
  `displayEndDate` | string
@@ -15,8 +15,6 @@ Name | Type
15
15
  `email` | string
16
16
  `website` | string
17
17
  `openingHours` | Array<string | null>
18
- `netsuiteId` | number
19
- `displayNetsuiteId` | number
20
18
  `supplierIds` | Array<number>
21
19
  `specialDates` | [Array<StoreStoreRequestSpecialDatesInner>](StoreStoreRequestSpecialDatesInner.md)
22
20
  `address` | [StoreStoreRequestAddress](StoreStoreRequestAddress.md)
@@ -37,8 +35,6 @@ const example = {
37
35
  "email": null,
38
36
  "website": null,
39
37
  "openingHours": null,
40
- "netsuiteId": null,
41
- "displayNetsuiteId": null,
42
38
  "supplierIds": null,
43
39
  "specialDates": null,
44
40
  "address": null,
@@ -0,0 +1,44 @@
1
+
2
+ # UpdateReviewRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `reviewerName` | string
10
+ `rating` | number
11
+ `comment` | string
12
+ `replyFromAdmin` | string
13
+ `location` | string
14
+ `approved` | boolean
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { UpdateReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "reviewerName": null,
24
+ "rating": null,
25
+ "comment": null,
26
+ "replyFromAdmin": null,
27
+ "location": null,
28
+ "approved": null,
29
+ } satisfies UpdateReviewRequest
30
+
31
+ console.log(example)
32
+
33
+ // Convert the instance to a JSON string
34
+ const exampleJSON: string = JSON.stringify(example)
35
+ console.log(exampleJSON)
36
+
37
+ // Parse the JSON string back to an object
38
+ const exampleParsed = JSON.parse(exampleJSON) as UpdateReviewRequest
39
+ console.log(exampleParsed)
40
+ ```
41
+
42
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
43
+
44
+
@@ -15,8 +15,6 @@ Name | Type
15
15
  `email` | string
16
16
  `website` | string
17
17
  `openingHours` | Array<string | null>
18
- `netsuiteId` | number
19
- `displayNetsuiteId` | number
20
18
  `supplierIds` | Array<number>
21
19
  `specialDates` | [Array<UpdateStoreRequestSpecialDatesInner>](UpdateStoreRequestSpecialDatesInner.md)
22
20
  `address` | [StoreStoreRequestAddress](StoreStoreRequestAddress.md)
@@ -37,8 +35,6 @@ const example = {
37
35
  "email": null,
38
36
  "website": null,
39
37
  "openingHours": null,
40
- "netsuiteId": null,
41
- "displayNetsuiteId": null,
42
38
  "supplierIds": null,
43
39
  "specialDates": null,
44
40
  "address": null,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital8/lighting-illusions-ts-sdk",
3
- "version": "0.0.1697",
3
+ "version": "0.0.1698",
4
4
  "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
5
5
  "author": "OpenAPI-Generator",
6
6
  "repository": {