@digital8/lighting-illusions-ts-sdk 0.0.1893 → 0.0.1895

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 (125) hide show
  1. package/.openapi-generator/FILES +48 -0
  2. package/README.md +33 -2
  3. package/dist/apis/ReviewApi.d.ts +139 -0
  4. package/dist/apis/ReviewApi.js +566 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +1 -0
  7. package/dist/models/AddressFrontendResource.d.ts +1 -1
  8. package/dist/models/AddressFrontendResource.js +1 -3
  9. package/dist/models/AdminUserLiteResource.d.ts +50 -0
  10. package/dist/models/AdminUserLiteResource.js +61 -0
  11. package/dist/models/AdminUserLiteResourceArrayResponse.d.ts +33 -0
  12. package/dist/models/AdminUserLiteResourceArrayResponse.js +50 -0
  13. package/dist/models/CustomerLiteResource.d.ts +50 -0
  14. package/dist/models/CustomerLiteResource.js +61 -0
  15. package/dist/models/CustomerLiteResourceArrayResponse.d.ts +33 -0
  16. package/dist/models/CustomerLiteResourceArrayResponse.js +50 -0
  17. package/dist/models/CustomerReviewableItemFrontendResource.d.ts +44 -0
  18. package/dist/models/CustomerReviewableItemFrontendResource.js +59 -0
  19. package/dist/models/CustomerReviewableItemFrontendResourceArrayResponse.d.ts +33 -0
  20. package/dist/models/CustomerReviewableItemFrontendResourceArrayResponse.js +50 -0
  21. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  22. package/dist/models/ExternalApiLogResource.js +1 -3
  23. package/dist/models/IndexReviewRequest.d.ts +110 -0
  24. package/dist/models/IndexReviewRequest.js +86 -0
  25. package/dist/models/PaginatedCustomerReviewableItemFrontendResourceResponse.d.ts +40 -0
  26. package/dist/models/PaginatedCustomerReviewableItemFrontendResourceResponse.js +57 -0
  27. package/dist/models/PaginatedReviewListResourceResponse.d.ts +40 -0
  28. package/dist/models/PaginatedReviewListResourceResponse.js +57 -0
  29. package/dist/models/PaginatedReviewLiteResourceResponse.d.ts +40 -0
  30. package/dist/models/PaginatedReviewLiteResourceResponse.js +57 -0
  31. package/dist/models/PaginatedReviewResourceResponse.d.ts +40 -0
  32. package/dist/models/PaginatedReviewResourceResponse.js +57 -0
  33. package/dist/models/ProductChildListResource.d.ts +6 -0
  34. package/dist/models/ProductChildListResource.js +4 -0
  35. package/dist/models/ProductChildLiteResource.d.ts +6 -0
  36. package/dist/models/ProductChildLiteResource.js +4 -0
  37. package/dist/models/ProductReviewsResource.d.ts +63 -0
  38. package/dist/models/ProductReviewsResource.js +70 -0
  39. package/dist/models/ProductReviewsResourceArrayResponse.d.ts +33 -0
  40. package/dist/models/ProductReviewsResourceArrayResponse.js +50 -0
  41. package/dist/models/ReviewListResource.d.ts +94 -0
  42. package/dist/models/ReviewListResource.js +87 -0
  43. package/dist/models/ReviewListResourceArrayResponse.d.ts +33 -0
  44. package/dist/models/ReviewListResourceArrayResponse.js +50 -0
  45. package/dist/models/ReviewLiteResource.d.ts +44 -0
  46. package/dist/models/ReviewLiteResource.js +59 -0
  47. package/dist/models/ReviewLiteResourceArrayResponse.d.ts +33 -0
  48. package/dist/models/ReviewLiteResourceArrayResponse.js +50 -0
  49. package/dist/models/ReviewPublicResource.d.ts +68 -0
  50. package/dist/models/ReviewPublicResource.js +73 -0
  51. package/dist/models/ReviewPublicResourceArrayResponse.d.ts +33 -0
  52. package/dist/models/ReviewPublicResourceArrayResponse.js +50 -0
  53. package/dist/models/ReviewResource.d.ts +126 -0
  54. package/dist/models/ReviewResource.js +107 -0
  55. package/dist/models/ReviewResourceArrayResponse.d.ts +33 -0
  56. package/dist/models/ReviewResourceArrayResponse.js +50 -0
  57. package/dist/models/StoreListResource.d.ts +1 -1
  58. package/dist/models/StoreListResource.js +3 -1
  59. package/dist/models/StoreResource.d.ts +1 -1
  60. package/dist/models/StoreResource.js +1 -3
  61. package/dist/models/StoreReviewRequest.d.ts +80 -0
  62. package/dist/models/StoreReviewRequest.js +79 -0
  63. package/dist/models/UpdateReviewRequest.d.ts +68 -0
  64. package/dist/models/UpdateReviewRequest.js +71 -0
  65. package/dist/models/index.d.ts +23 -0
  66. package/dist/models/index.js +23 -0
  67. package/docs/AdminUserLiteResource.md +40 -0
  68. package/docs/AdminUserLiteResourceArrayResponse.md +34 -0
  69. package/docs/CustomerLiteResource.md +40 -0
  70. package/docs/CustomerLiteResourceArrayResponse.md +34 -0
  71. package/docs/CustomerReviewableItemFrontendResource.md +38 -0
  72. package/docs/CustomerReviewableItemFrontendResourceArrayResponse.md +34 -0
  73. package/docs/IndexReviewRequest.md +54 -0
  74. package/docs/PaginatedCustomerReviewableItemFrontendResourceResponse.md +36 -0
  75. package/docs/PaginatedReviewListResourceResponse.md +36 -0
  76. package/docs/PaginatedReviewLiteResourceResponse.md +36 -0
  77. package/docs/PaginatedReviewResourceResponse.md +36 -0
  78. package/docs/ProductChildListResource.md +2 -0
  79. package/docs/ProductChildLiteResource.md +2 -0
  80. package/docs/ProductReviewsResource.md +44 -0
  81. package/docs/ProductReviewsResourceArrayResponse.md +34 -0
  82. package/docs/ReviewApi.md +539 -0
  83. package/docs/ReviewListResource.md +54 -0
  84. package/docs/ReviewListResourceArrayResponse.md +34 -0
  85. package/docs/ReviewLiteResource.md +38 -0
  86. package/docs/ReviewLiteResourceArrayResponse.md +34 -0
  87. package/docs/ReviewPublicResource.md +46 -0
  88. package/docs/ReviewPublicResourceArrayResponse.md +34 -0
  89. package/docs/ReviewResource.md +64 -0
  90. package/docs/ReviewResourceArrayResponse.md +34 -0
  91. package/docs/StoreReviewRequest.md +50 -0
  92. package/docs/UpdateReviewRequest.md +46 -0
  93. package/package.json +1 -1
  94. package/src/apis/ReviewApi.ts +444 -0
  95. package/src/apis/index.ts +1 -0
  96. package/src/models/AddressFrontendResource.ts +2 -3
  97. package/src/models/AdminUserLiteResource.ts +92 -0
  98. package/src/models/AdminUserLiteResourceArrayResponse.ts +73 -0
  99. package/src/models/CustomerLiteResource.ts +92 -0
  100. package/src/models/CustomerLiteResourceArrayResponse.ts +73 -0
  101. package/src/models/CustomerReviewableItemFrontendResource.ts +84 -0
  102. package/src/models/CustomerReviewableItemFrontendResourceArrayResponse.ts +73 -0
  103. package/src/models/ExternalApiLogResource.ts +2 -3
  104. package/src/models/IndexReviewRequest.ts +167 -0
  105. package/src/models/PaginatedCustomerReviewableItemFrontendResourceResponse.ts +90 -0
  106. package/src/models/PaginatedReviewListResourceResponse.ts +90 -0
  107. package/src/models/PaginatedReviewLiteResourceResponse.ts +90 -0
  108. package/src/models/PaginatedReviewResourceResponse.ts +90 -0
  109. package/src/models/ProductChildListResource.ts +9 -0
  110. package/src/models/ProductChildLiteResource.ts +9 -0
  111. package/src/models/ProductReviewsResource.ts +118 -0
  112. package/src/models/ProductReviewsResourceArrayResponse.ts +73 -0
  113. package/src/models/ReviewListResource.ts +168 -0
  114. package/src/models/ReviewListResourceArrayResponse.ts +73 -0
  115. package/src/models/ReviewLiteResource.ts +84 -0
  116. package/src/models/ReviewLiteResourceArrayResponse.ts +73 -0
  117. package/src/models/ReviewPublicResource.ts +119 -0
  118. package/src/models/ReviewPublicResourceArrayResponse.ts +73 -0
  119. package/src/models/ReviewResource.ts +226 -0
  120. package/src/models/ReviewResourceArrayResponse.ts +73 -0
  121. package/src/models/StoreListResource.ts +3 -2
  122. package/src/models/StoreResource.ts +2 -3
  123. package/src/models/StoreReviewRequest.ts +136 -0
  124. package/src/models/UpdateReviewRequest.ts +118 -0
  125. package/src/models/index.ts +23 -0
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedCustomerReviewableItemFrontendResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<CustomerReviewableItemFrontendResource>](CustomerReviewableItemFrontendResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedCustomerReviewableItemFrontendResourceResponse } 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 PaginatedCustomerReviewableItemFrontendResourceResponse
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 PaginatedCustomerReviewableItemFrontendResourceResponse
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
+ # 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
+
@@ -10,6 +10,7 @@ Name | Type
10
10
  `parentId` | string
11
11
  `sku` | number
12
12
  `name` | string
13
+ `fullName` | string
13
14
  `model` | string
14
15
  `stock` | number
15
16
  `isDisabled` | string
@@ -30,6 +31,7 @@ const example = {
30
31
  "parentId": null,
31
32
  "sku": null,
32
33
  "name": null,
34
+ "fullName": null,
33
35
  "model": null,
34
36
  "stock": null,
35
37
  "isDisabled": null,
@@ -9,6 +9,7 @@ Name | Type
9
9
  `id` | number
10
10
  `parentName` | string
11
11
  `name` | string
12
+ `fullName` | string
12
13
  `modelNumber` | string
13
14
  `sku` | number
14
15
  `stock` | number
@@ -25,6 +26,7 @@ const example = {
25
26
  "id": null,
26
27
  "parentName": null,
27
28
  "name": null,
29
+ "fullName": null,
28
30
  "modelNumber": null,
29
31
  "sku": null,
30
32
  "stock": null,
@@ -0,0 +1,44 @@
1
+
2
+ # ProductReviewsResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `reviews` | [Array<ReviewPublicResource>](ReviewPublicResource.md)
10
+ `totalReview` | number
11
+ `averageRating` | number
12
+ `stats` | Array<object>
13
+ `myReview` | string
14
+ `canReview` | boolean
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { ProductReviewsResource } from '@digital8/lighting-illusions-ts-sdk'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "reviews": null,
24
+ "totalReview": null,
25
+ "averageRating": null,
26
+ "stats": null,
27
+ "myReview": null,
28
+ "canReview": null,
29
+ } satisfies ProductReviewsResource
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 ProductReviewsResource
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
+
@@ -0,0 +1,34 @@
1
+
2
+ # ProductReviewsResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductReviewsResource>](ProductReviewsResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { ProductReviewsResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies ProductReviewsResourceArrayResponse
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 ProductReviewsResourceArrayResponse
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
+