@digital8/lighting-illusions-ts-sdk 0.0.1024 → 0.0.1026

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 (170) hide show
  1. package/.openapi-generator/FILES +64 -0
  2. package/README.md +50 -2
  3. package/dist/apis/AttributeApi.d.ts +16 -1
  4. package/dist/apis/AttributeApi.js +58 -0
  5. package/dist/apis/ProductRangeApi.d.ts +269 -0
  6. package/dist/apis/ProductRangeApi.js +1043 -0
  7. package/dist/apis/index.d.ts +1 -0
  8. package/dist/apis/index.js +1 -0
  9. package/dist/models/AttachAccessoriesProductRangeRequest.d.ts +32 -0
  10. package/dist/models/AttachAccessoriesProductRangeRequest.js +51 -0
  11. package/dist/models/AttachAttributesProductRangeRequest.d.ts +32 -0
  12. package/dist/models/AttachAttributesProductRangeRequest.js +51 -0
  13. package/dist/models/AttachDocumentablesDocumentRequestDocumentablesInner.d.ts +1 -0
  14. package/dist/models/AttachDocumentablesDocumentRequestDocumentablesInner.js +1 -0
  15. package/dist/models/AttachDocumentsProductRangeRequest.d.ts +33 -0
  16. package/dist/models/AttachDocumentsProductRangeRequest.js +52 -0
  17. package/dist/models/DetachAccessoriesProductRangeRequest.d.ts +32 -0
  18. package/dist/models/DetachAccessoriesProductRangeRequest.js +51 -0
  19. package/dist/models/DetachAttributesProductRangeRequest.d.ts +32 -0
  20. package/dist/models/DetachAttributesProductRangeRequest.js +51 -0
  21. package/dist/models/DetachDocumentablesDocumentRequestDocumentablesInner.d.ts +1 -0
  22. package/dist/models/DetachDocumentablesDocumentRequestDocumentablesInner.js +1 -0
  23. package/dist/models/DetachDocumentsProductRangeRequest.d.ts +32 -0
  24. package/dist/models/DetachDocumentsProductRangeRequest.js +51 -0
  25. package/dist/models/GetAllDocumentRequest.d.ts +1 -0
  26. package/dist/models/GetAllDocumentRequest.js +1 -0
  27. package/dist/models/GetAllProductChildRequest.d.ts +1 -0
  28. package/dist/models/GetAllProductChildRequest.js +1 -0
  29. package/dist/models/GetAllProductRangeRequest.d.ts +98 -0
  30. package/dist/models/GetAllProductRangeRequest.js +82 -0
  31. package/dist/models/IndexAttributeRequest.d.ts +2 -0
  32. package/dist/models/IndexAttributeRequest.js +3 -1
  33. package/dist/models/IndexDocumentRequest.d.ts +1 -0
  34. package/dist/models/IndexDocumentRequest.js +1 -0
  35. package/dist/models/IndexModelAttributeRequest.d.ts +118 -0
  36. package/dist/models/IndexModelAttributeRequest.js +93 -0
  37. package/dist/models/IndexProductChildRequest.d.ts +1 -0
  38. package/dist/models/IndexProductChildRequest.js +1 -0
  39. package/dist/models/IndexProductRangeRequest.d.ts +110 -0
  40. package/dist/models/IndexProductRangeRequest.js +86 -0
  41. package/dist/models/ModelAttributeListResource.d.ts +52 -0
  42. package/dist/models/ModelAttributeListResource.js +65 -0
  43. package/dist/models/ModelAttributeListResourceArrayResponse.d.ts +33 -0
  44. package/dist/models/ModelAttributeListResourceArrayResponse.js +50 -0
  45. package/dist/models/PaginatedModelAttributeListResourceResponse.d.ts +40 -0
  46. package/dist/models/PaginatedModelAttributeListResourceResponse.js +57 -0
  47. package/dist/models/PaginatedProductRangeFrontendListResourceResponse.d.ts +40 -0
  48. package/dist/models/PaginatedProductRangeFrontendListResourceResponse.js +57 -0
  49. package/dist/models/PaginatedProductRangeListResourceResponse.d.ts +40 -0
  50. package/dist/models/PaginatedProductRangeListResourceResponse.js +57 -0
  51. package/dist/models/PaginatedProductRangeLiteResourceResponse.d.ts +40 -0
  52. package/dist/models/PaginatedProductRangeLiteResourceResponse.js +57 -0
  53. package/dist/models/PaginatedProductRangeResourceResponse.d.ts +40 -0
  54. package/dist/models/PaginatedProductRangeResourceResponse.js +57 -0
  55. package/dist/models/ProductChildListResource.d.ts +0 -6
  56. package/dist/models/ProductChildListResource.js +0 -4
  57. package/dist/models/ProductChildSiteDetailResource.d.ts +0 -6
  58. package/dist/models/ProductChildSiteDetailResource.js +0 -4
  59. package/dist/models/ProductRangeFrontendListResource.d.ts +62 -0
  60. package/dist/models/ProductRangeFrontendListResource.js +71 -0
  61. package/dist/models/ProductRangeFrontendListResourceArrayResponse.d.ts +33 -0
  62. package/dist/models/ProductRangeFrontendListResourceArrayResponse.js +50 -0
  63. package/dist/models/ProductRangeFrontendResource.d.ts +118 -0
  64. package/dist/models/ProductRangeFrontendResource.js +109 -0
  65. package/dist/models/ProductRangeFrontendResourceArrayResponse.d.ts +33 -0
  66. package/dist/models/ProductRangeFrontendResourceArrayResponse.js +50 -0
  67. package/dist/models/ProductRangeListResource.d.ts +52 -0
  68. package/dist/models/ProductRangeListResource.js +65 -0
  69. package/dist/models/ProductRangeListResourceArrayResponse.d.ts +33 -0
  70. package/dist/models/ProductRangeListResourceArrayResponse.js +50 -0
  71. package/dist/models/ProductRangeLiteResource.d.ts +38 -0
  72. package/dist/models/ProductRangeLiteResource.js +55 -0
  73. package/dist/models/ProductRangeLiteResourceArrayResponse.d.ts +33 -0
  74. package/dist/models/ProductRangeLiteResourceArrayResponse.js +50 -0
  75. package/dist/models/ProductRangeResource.d.ts +83 -0
  76. package/dist/models/ProductRangeResource.js +82 -0
  77. package/dist/models/ProductRangeResourceArrayResponse.d.ts +33 -0
  78. package/dist/models/ProductRangeResourceArrayResponse.js +50 -0
  79. package/dist/models/ProductRangeSiteDetailResource.d.ts +94 -0
  80. package/dist/models/ProductRangeSiteDetailResource.js +93 -0
  81. package/dist/models/ProductRangeSiteDetailResourceArrayResponse.d.ts +33 -0
  82. package/dist/models/ProductRangeSiteDetailResourceArrayResponse.js +50 -0
  83. package/dist/models/StoreProductRangeRequest.d.ts +52 -0
  84. package/dist/models/StoreProductRangeRequest.js +59 -0
  85. package/dist/models/StoreProductRangeRequestSitesInner.d.ts +92 -0
  86. package/dist/models/StoreProductRangeRequestSitesInner.js +75 -0
  87. package/dist/models/UpdateProductRangeRequest.d.ts +52 -0
  88. package/dist/models/UpdateProductRangeRequest.js +59 -0
  89. package/dist/models/index.d.ts +31 -0
  90. package/dist/models/index.js +31 -0
  91. package/docs/AttachAccessoriesProductRangeRequest.md +34 -0
  92. package/docs/AttachAttributesProductRangeRequest.md +34 -0
  93. package/docs/AttachDocumentsProductRangeRequest.md +34 -0
  94. package/docs/AttributeApi.md +66 -0
  95. package/docs/DetachAccessoriesProductRangeRequest.md +34 -0
  96. package/docs/DetachAttributesProductRangeRequest.md +34 -0
  97. package/docs/DetachDocumentsProductRangeRequest.md +34 -0
  98. package/docs/GetAllProductRangeRequest.md +50 -0
  99. package/docs/IndexModelAttributeRequest.md +54 -0
  100. package/docs/IndexProductRangeRequest.md +54 -0
  101. package/docs/ModelAttributeListResource.md +40 -0
  102. package/docs/ModelAttributeListResourceArrayResponse.md +34 -0
  103. package/docs/PaginatedModelAttributeListResourceResponse.md +36 -0
  104. package/docs/PaginatedProductRangeFrontendListResourceResponse.md +36 -0
  105. package/docs/PaginatedProductRangeListResourceResponse.md +36 -0
  106. package/docs/PaginatedProductRangeLiteResourceResponse.md +36 -0
  107. package/docs/PaginatedProductRangeResourceResponse.md +36 -0
  108. package/docs/ProductChildListResource.md +0 -2
  109. package/docs/ProductChildSiteDetailResource.md +0 -2
  110. package/docs/ProductRangeApi.md +1097 -0
  111. package/docs/ProductRangeFrontendListResource.md +44 -0
  112. package/docs/ProductRangeFrontendListResourceArrayResponse.md +34 -0
  113. package/docs/ProductRangeFrontendResource.md +62 -0
  114. package/docs/ProductRangeFrontendResourceArrayResponse.md +34 -0
  115. package/docs/ProductRangeListResource.md +40 -0
  116. package/docs/ProductRangeListResourceArrayResponse.md +34 -0
  117. package/docs/ProductRangeLiteResource.md +36 -0
  118. package/docs/ProductRangeLiteResourceArrayResponse.md +34 -0
  119. package/docs/ProductRangeResource.md +50 -0
  120. package/docs/ProductRangeResourceArrayResponse.md +34 -0
  121. package/docs/ProductRangeSiteDetailResource.md +54 -0
  122. package/docs/ProductRangeSiteDetailResourceArrayResponse.md +34 -0
  123. package/docs/StoreProductRangeRequest.md +40 -0
  124. package/docs/StoreProductRangeRequestSitesInner.md +54 -0
  125. package/docs/UpdateProductRangeRequest.md +40 -0
  126. package/package.json +1 -1
  127. package/src/apis/AttributeApi.ts +50 -0
  128. package/src/apis/ProductRangeApi.ts +888 -0
  129. package/src/apis/index.ts +1 -0
  130. package/src/models/AttachAccessoriesProductRangeRequest.ts +66 -0
  131. package/src/models/AttachAttributesProductRangeRequest.ts +66 -0
  132. package/src/models/AttachDocumentablesDocumentRequestDocumentablesInner.ts +1 -0
  133. package/src/models/AttachDocumentsProductRangeRequest.ts +74 -0
  134. package/src/models/DetachAccessoriesProductRangeRequest.ts +66 -0
  135. package/src/models/DetachAttributesProductRangeRequest.ts +66 -0
  136. package/src/models/DetachDocumentablesDocumentRequestDocumentablesInner.ts +1 -0
  137. package/src/models/DetachDocumentsProductRangeRequest.ts +66 -0
  138. package/src/models/GetAllDocumentRequest.ts +1 -0
  139. package/src/models/GetAllProductChildRequest.ts +1 -0
  140. package/src/models/GetAllProductRangeRequest.ts +151 -0
  141. package/src/models/IndexAttributeRequest.ts +3 -1
  142. package/src/models/IndexDocumentRequest.ts +1 -0
  143. package/src/models/IndexModelAttributeRequest.ts +176 -0
  144. package/src/models/IndexProductChildRequest.ts +1 -0
  145. package/src/models/IndexProductRangeRequest.ts +167 -0
  146. package/src/models/ModelAttributeListResource.ts +108 -0
  147. package/src/models/ModelAttributeListResourceArrayResponse.ts +73 -0
  148. package/src/models/PaginatedModelAttributeListResourceResponse.ts +90 -0
  149. package/src/models/PaginatedProductRangeFrontendListResourceResponse.ts +90 -0
  150. package/src/models/PaginatedProductRangeListResourceResponse.ts +90 -0
  151. package/src/models/PaginatedProductRangeLiteResourceResponse.ts +90 -0
  152. package/src/models/PaginatedProductRangeResourceResponse.ts +90 -0
  153. package/src/models/ProductChildListResource.ts +0 -9
  154. package/src/models/ProductChildSiteDetailResource.ts +0 -9
  155. package/src/models/ProductRangeFrontendListResource.ts +111 -0
  156. package/src/models/ProductRangeFrontendListResourceArrayResponse.ts +73 -0
  157. package/src/models/ProductRangeFrontendResource.ts +207 -0
  158. package/src/models/ProductRangeFrontendResourceArrayResponse.ts +73 -0
  159. package/src/models/ProductRangeListResource.ts +108 -0
  160. package/src/models/ProductRangeListResourceArrayResponse.ts +73 -0
  161. package/src/models/ProductRangeLiteResource.ts +75 -0
  162. package/src/models/ProductRangeLiteResourceArrayResponse.ts +73 -0
  163. package/src/models/ProductRangeResource.ts +158 -0
  164. package/src/models/ProductRangeResourceArrayResponse.ts +73 -0
  165. package/src/models/ProductRangeSiteDetailResource.ts +171 -0
  166. package/src/models/ProductRangeSiteDetailResourceArrayResponse.ts +73 -0
  167. package/src/models/StoreProductRangeRequest.ts +105 -0
  168. package/src/models/StoreProductRangeRequestSitesInner.ts +148 -0
  169. package/src/models/UpdateProductRangeRequest.ts +105 -0
  170. package/src/models/index.ts +31 -0
@@ -0,0 +1,40 @@
1
+
2
+ # ModelAttributeListResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `value` | string
11
+ `attribute` | [AttributeLiteResource](AttributeLiteResource.md)
12
+ `attributeValues` | [Array<AttributeValueResource>](AttributeValueResource.md)
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { ModelAttributeListResource } from '@digital8/lighting-illusions-ts-sdk'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "id": null,
22
+ "value": null,
23
+ "attribute": null,
24
+ "attributeValues": null,
25
+ } satisfies ModelAttributeListResource
26
+
27
+ console.log(example)
28
+
29
+ // Convert the instance to a JSON string
30
+ const exampleJSON: string = JSON.stringify(example)
31
+ console.log(exampleJSON)
32
+
33
+ // Parse the JSON string back to an object
34
+ const exampleParsed = JSON.parse(exampleJSON) as ModelAttributeListResource
35
+ console.log(exampleParsed)
36
+ ```
37
+
38
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
+
40
+
@@ -0,0 +1,34 @@
1
+
2
+ # ModelAttributeListResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ModelAttributeListResource>](ModelAttributeListResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { ModelAttributeListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies ModelAttributeListResourceArrayResponse
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 ModelAttributeListResourceArrayResponse
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
+ # PaginatedModelAttributeListResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ModelAttributeListResource>](ModelAttributeListResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedModelAttributeListResourceResponse } 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 PaginatedModelAttributeListResourceResponse
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 PaginatedModelAttributeListResourceResponse
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
+ # PaginatedProductRangeFrontendListResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRangeFrontendListResource>](ProductRangeFrontendListResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductRangeFrontendListResourceResponse } 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 PaginatedProductRangeFrontendListResourceResponse
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 PaginatedProductRangeFrontendListResourceResponse
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
+ # PaginatedProductRangeListResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRangeListResource>](ProductRangeListResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductRangeListResourceResponse } 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 PaginatedProductRangeListResourceResponse
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 PaginatedProductRangeListResourceResponse
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
+ # PaginatedProductRangeLiteResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRangeLiteResource>](ProductRangeLiteResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductRangeLiteResourceResponse } 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 PaginatedProductRangeLiteResourceResponse
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 PaginatedProductRangeLiteResourceResponse
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
+ # PaginatedProductRangeResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductRangeResource>](ProductRangeResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductRangeResourceResponse } 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 PaginatedProductRangeResourceResponse
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 PaginatedProductRangeResourceResponse
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
+
@@ -13,7 +13,6 @@ Name | Type
13
13
  `model` | string
14
14
  `stock` | number
15
15
  `isDisabled` | string
16
- `displayInSocialFeed` | boolean
17
16
  `netsuiteId` | number
18
17
  `thumbnail` | [AssetLiteResource](AssetLiteResource.md)
19
18
  `siteDetails` | [Array<ProductChildSiteDetailLiteResource>](ProductChildSiteDetailLiteResource.md)
@@ -32,7 +31,6 @@ const example = {
32
31
  "model": null,
33
32
  "stock": null,
34
33
  "isDisabled": null,
35
- "displayInSocialFeed": null,
36
34
  "netsuiteId": null,
37
35
  "thumbnail": null,
38
36
  "siteDetails": null,
@@ -18,7 +18,6 @@ Name | Type
18
18
  `rrpPrice` | number
19
19
  `salePrice` | number
20
20
  `isDisabled` | boolean
21
- `displayInTgnFeed` | boolean
22
21
  `seo` | [SEOResource](SEOResource.md)
23
22
  `omnisendId` | string
24
23
  `omnisendSyncStatus` | string
@@ -42,7 +41,6 @@ const example = {
42
41
  "rrpPrice": null,
43
42
  "salePrice": null,
44
43
  "isDisabled": null,
45
- "displayInTgnFeed": null,
46
44
  "seo": null,
47
45
  "omnisendId": null,
48
46
  "omnisendSyncStatus": null,