@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
@@ -1,22 +1,22 @@
1
1
 
2
- # SaveMapStoreStockMigrationRequest
2
+ # CustomerLiteResourceArrayResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `associations` | [Array<SaveMapStoreStockMigrationRequestAssociationsInner>](SaveMapStoreStockMigrationRequestAssociationsInner.md)
9
+ `data` | [Array<CustomerLiteResource>](CustomerLiteResource.md)
10
10
 
11
11
  ## Example
12
12
 
13
13
  ```typescript
14
- import type { SaveMapStoreStockMigrationRequest } from '@digital8/lighting-illusions-ts-sdk'
14
+ import type { CustomerLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
15
 
16
16
  // TODO: Update the object below with actual values
17
17
  const example = {
18
- "associations": null,
19
- } satisfies SaveMapStoreStockMigrationRequest
18
+ "data": null,
19
+ } satisfies CustomerLiteResourceArrayResponse
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 SaveMapStoreStockMigrationRequest
28
+ const exampleParsed = JSON.parse(exampleJSON) as CustomerLiteResourceArrayResponse
29
29
  console.log(exampleParsed)
30
30
  ```
31
31
 
@@ -0,0 +1,54 @@
1
+
2
+ # IndexReviewRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `search` | string
10
+ `sortBy` | string
11
+ `sortDirection` | string
12
+ `perPage` | number
13
+ `page` | number
14
+ `siteId` | Array<string>
15
+ `createdByAdmin` | Array<string>
16
+ `hasApprovedAt` | Array<string>
17
+ `relatedId` | number
18
+ `relatedType` | string
19
+ `includesRelations` | boolean
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import type { IndexReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
25
+
26
+ // TODO: Update the object below with actual values
27
+ const example = {
28
+ "search": null,
29
+ "sortBy": null,
30
+ "sortDirection": null,
31
+ "perPage": null,
32
+ "page": null,
33
+ "siteId": null,
34
+ "createdByAdmin": null,
35
+ "hasApprovedAt": null,
36
+ "relatedId": null,
37
+ "relatedType": null,
38
+ "includesRelations": null,
39
+ } satisfies IndexReviewRequest
40
+
41
+ console.log(example)
42
+
43
+ // Convert the instance to a JSON string
44
+ const exampleJSON: string = JSON.stringify(example)
45
+ console.log(exampleJSON)
46
+
47
+ // Parse the JSON string back to an object
48
+ const exampleParsed = JSON.parse(exampleJSON) as IndexReviewRequest
49
+ console.log(exampleParsed)
50
+ ```
51
+
52
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
53
+
54
+
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedReviewListResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ReviewListResource>](ReviewListResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedReviewListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "data": null,
20
+ "meta": null,
21
+ } satisfies PaginatedReviewListResourceResponse
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 PaginatedReviewListResourceResponse
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,36 @@
1
+
2
+ # PaginatedReviewLiteResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ReviewLiteResource>](ReviewLiteResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedReviewLiteResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "data": null,
20
+ "meta": null,
21
+ } satisfies PaginatedReviewLiteResourceResponse
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 PaginatedReviewLiteResourceResponse
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,36 @@
1
+
2
+ # PaginatedReviewResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ReviewResource>](ReviewResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedReviewResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "data": null,
20
+ "meta": null,
21
+ } satisfies PaginatedReviewResourceResponse
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 PaginatedReviewResourceResponse
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
+