@digital8/lighting-illusions-ts-sdk 0.0.530 → 0.0.532

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 (136) hide show
  1. package/.openapi-generator/FILES +42 -24
  2. package/README.md +30 -14
  3. package/dist/apis/ProductCategoryApi.d.ts +105 -0
  4. package/dist/apis/ProductCategoryApi.js +445 -0
  5. package/dist/apis/index.d.ts +1 -0
  6. package/dist/apis/index.js +1 -0
  7. package/dist/models/CategoryAutomationComparisonType.d.ts +29 -0
  8. package/dist/models/CategoryAutomationComparisonType.js +55 -0
  9. package/dist/models/CategoryAutomationConditionType.d.ts +25 -0
  10. package/dist/models/CategoryAutomationConditionType.js +51 -0
  11. package/dist/models/CategoryAutomationFieldType.d.ts +30 -0
  12. package/dist/models/CategoryAutomationFieldType.js +56 -0
  13. package/dist/models/CategoryAutomationRuleResource.d.ts +68 -0
  14. package/dist/models/CategoryAutomationRuleResource.js +67 -0
  15. package/dist/models/CategoryAutomationRuleResourceArrayResponse.d.ts +33 -0
  16. package/dist/models/CategoryAutomationRuleResourceArrayResponse.js +50 -0
  17. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  18. package/dist/models/ExternalApiLogResource.js +3 -1
  19. package/dist/models/GetAllProductCategoryRequest.d.ts +115 -0
  20. package/dist/models/GetAllProductCategoryRequest.js +94 -0
  21. package/dist/models/IndexProductCategoryRequest.d.ts +127 -0
  22. package/dist/models/IndexProductCategoryRequest.js +98 -0
  23. package/dist/models/PaginatedProductCategoryListResourceResponse.d.ts +40 -0
  24. package/dist/models/PaginatedProductCategoryListResourceResponse.js +57 -0
  25. package/dist/models/PaginatedProductCategoryResourceResponse.d.ts +40 -0
  26. package/dist/models/PaginatedProductCategoryResourceResponse.js +57 -0
  27. package/dist/models/ProductCategoryHierarchyResource.d.ts +62 -0
  28. package/dist/models/ProductCategoryHierarchyResource.js +69 -0
  29. package/dist/models/ProductCategoryHierarchyResourceArrayResponse.d.ts +33 -0
  30. package/dist/models/ProductCategoryHierarchyResourceArrayResponse.js +50 -0
  31. package/dist/models/ProductCategoryListResource.d.ts +75 -0
  32. package/dist/models/ProductCategoryListResource.js +78 -0
  33. package/dist/models/ProductCategoryListResourceArrayResponse.d.ts +33 -0
  34. package/dist/models/ProductCategoryListResourceArrayResponse.js +50 -0
  35. package/dist/models/ProductCategoryLiteResource.d.ts +38 -0
  36. package/dist/models/ProductCategoryLiteResource.js +53 -0
  37. package/dist/models/ProductCategoryLiteResourceArrayResponse.d.ts +33 -0
  38. package/dist/models/ProductCategoryLiteResourceArrayResponse.js +50 -0
  39. package/dist/models/ProductCategoryResource.d.ts +107 -0
  40. package/dist/models/ProductCategoryResource.js +96 -0
  41. package/dist/models/ProductCategoryResourceArrayResponse.d.ts +33 -0
  42. package/dist/models/ProductCategoryResourceArrayResponse.js +50 -0
  43. package/dist/models/StoreProductCategoryRequest.d.ts +105 -0
  44. package/dist/models/StoreProductCategoryRequest.js +86 -0
  45. package/dist/models/StoreProductCategoryRequestAutomationRulesInner.d.ts +62 -0
  46. package/dist/models/StoreProductCategoryRequestAutomationRulesInner.js +63 -0
  47. package/dist/models/UpdateProductCategoryRequest.d.ts +105 -0
  48. package/dist/models/UpdateProductCategoryRequest.js +74 -0
  49. package/dist/models/index.d.ts +20 -12
  50. package/dist/models/index.js +20 -12
  51. package/docs/{ProductSortBy.md → CategoryAutomationComparisonType.md} +4 -4
  52. package/docs/{ProductStatus.md → CategoryAutomationConditionType.md} +4 -4
  53. package/docs/{ProductRating.md → CategoryAutomationFieldType.md} +4 -4
  54. package/docs/CategoryAutomationRuleResource.md +46 -0
  55. package/docs/CategoryAutomationRuleResourceArrayResponse.md +34 -0
  56. package/docs/GetAllProductCategoryRequest.md +52 -0
  57. package/docs/IndexProductCategoryRequest.md +56 -0
  58. package/docs/{PaginatedProductSearchResultResourceResponse.md → PaginatedProductCategoryListResourceResponse.md} +5 -5
  59. package/docs/PaginatedProductCategoryResourceResponse.md +36 -0
  60. package/docs/ProductCategoryApi.md +534 -0
  61. package/docs/{ProductAggregationResource.md → ProductCategoryHierarchyResource.md} +16 -12
  62. package/docs/ProductCategoryHierarchyResourceArrayResponse.md +34 -0
  63. package/docs/ProductCategoryListResource.md +48 -0
  64. package/docs/{ProductSearchResultResourceArrayResponse.md → ProductCategoryListResourceArrayResponse.md} +5 -5
  65. package/docs/ProductCategoryLiteResource.md +36 -0
  66. package/docs/{ProductSearchResponseResourceArrayResponse.md → ProductCategoryLiteResourceArrayResponse.md} +5 -5
  67. package/docs/ProductCategoryResource.md +58 -0
  68. package/docs/{ProductAggregationResourceArrayResponse.md → ProductCategoryResourceArrayResponse.md} +5 -5
  69. package/docs/StoreProductCategoryRequest.md +58 -0
  70. package/docs/StoreProductCategoryRequestAutomationRulesInner.md +44 -0
  71. package/docs/UpdateProductCategoryRequest.md +58 -0
  72. package/package.json +1 -1
  73. package/src/apis/ProductCategoryApi.ts +363 -0
  74. package/src/apis/index.ts +1 -0
  75. package/src/models/CategoryAutomationComparisonType.ts +57 -0
  76. package/src/models/CategoryAutomationConditionType.ts +53 -0
  77. package/src/models/CategoryAutomationFieldType.ts +58 -0
  78. package/src/models/CategoryAutomationRuleResource.ts +116 -0
  79. package/src/models/CategoryAutomationRuleResourceArrayResponse.ts +73 -0
  80. package/src/models/ExternalApiLogResource.ts +3 -2
  81. package/src/models/GetAllProductCategoryRequest.ts +171 -0
  82. package/src/models/IndexProductCategoryRequest.ts +187 -0
  83. package/src/models/PaginatedProductCategoryListResourceResponse.ts +90 -0
  84. package/src/models/PaginatedProductCategoryResourceResponse.ts +90 -0
  85. package/src/models/ProductCategoryHierarchyResource.ts +110 -0
  86. package/src/models/ProductCategoryHierarchyResourceArrayResponse.ts +73 -0
  87. package/src/models/ProductCategoryListResource.ts +136 -0
  88. package/src/models/ProductCategoryListResourceArrayResponse.ts +73 -0
  89. package/src/models/ProductCategoryLiteResource.ts +74 -0
  90. package/src/models/ProductCategoryLiteResourceArrayResponse.ts +73 -0
  91. package/src/models/ProductCategoryResource.ts +193 -0
  92. package/src/models/ProductCategoryResourceArrayResponse.ts +73 -0
  93. package/src/models/StoreProductCategoryRequest.ts +175 -0
  94. package/src/models/StoreProductCategoryRequestAutomationRulesInner.ts +107 -0
  95. package/src/models/UpdateProductCategoryRequest.ts +169 -0
  96. package/src/models/index.ts +20 -12
  97. package/dist/models/PaginatedProductSearchResultResourceResponse.d.ts +0 -40
  98. package/dist/models/PaginatedProductSearchResultResourceResponse.js +0 -57
  99. package/dist/models/ProductAggregationResource.d.ts +0 -50
  100. package/dist/models/ProductAggregationResource.js +0 -63
  101. package/dist/models/ProductAggregationResourceArrayResponse.d.ts +0 -33
  102. package/dist/models/ProductAggregationResourceArrayResponse.js +0 -50
  103. package/dist/models/ProductRating.d.ts +0 -26
  104. package/dist/models/ProductRating.js +0 -52
  105. package/dist/models/ProductSearchResponseResource.d.ts +0 -54
  106. package/dist/models/ProductSearchResponseResource.js +0 -67
  107. package/dist/models/ProductSearchResponseResourceArrayResponse.d.ts +0 -33
  108. package/dist/models/ProductSearchResponseResourceArrayResponse.js +0 -50
  109. package/dist/models/ProductSearchResponseResourceMeta.d.ts +0 -50
  110. package/dist/models/ProductSearchResponseResourceMeta.js +0 -63
  111. package/dist/models/ProductSearchResponseResourcePriceInfo.d.ts +0 -50
  112. package/dist/models/ProductSearchResponseResourcePriceInfo.js +0 -63
  113. package/dist/models/ProductSearchResultResource.d.ts +0 -116
  114. package/dist/models/ProductSearchResultResource.js +0 -105
  115. package/dist/models/ProductSearchResultResourceArrayResponse.d.ts +0 -33
  116. package/dist/models/ProductSearchResultResourceArrayResponse.js +0 -50
  117. package/dist/models/ProductSortBy.d.ts +0 -32
  118. package/dist/models/ProductSortBy.js +0 -58
  119. package/dist/models/ProductStatus.d.ts +0 -24
  120. package/dist/models/ProductStatus.js +0 -50
  121. package/docs/ProductSearchResponseResource.md +0 -40
  122. package/docs/ProductSearchResponseResourceMeta.md +0 -40
  123. package/docs/ProductSearchResponseResourcePriceInfo.md +0 -40
  124. package/docs/ProductSearchResultResource.md +0 -62
  125. package/src/models/PaginatedProductSearchResultResourceResponse.ts +0 -90
  126. package/src/models/ProductAggregationResource.ts +0 -93
  127. package/src/models/ProductAggregationResourceArrayResponse.ts +0 -73
  128. package/src/models/ProductRating.ts +0 -54
  129. package/src/models/ProductSearchResponseResource.ts +0 -122
  130. package/src/models/ProductSearchResponseResourceArrayResponse.ts +0 -73
  131. package/src/models/ProductSearchResponseResourceMeta.ts +0 -93
  132. package/src/models/ProductSearchResponseResourcePriceInfo.ts +0 -93
  133. package/src/models/ProductSearchResultResource.ts +0 -191
  134. package/src/models/ProductSearchResultResourceArrayResponse.ts +0 -73
  135. package/src/models/ProductSortBy.ts +0 -60
  136. package/src/models/ProductStatus.ts +0 -52
@@ -1,5 +1,5 @@
1
1
 
2
- # ProductRating
2
+ # CategoryAutomationFieldType
3
3
 
4
4
 
5
5
  ## Properties
@@ -10,11 +10,11 @@ Name | Type
10
10
  ## Example
11
11
 
12
12
  ```typescript
13
- import type { ProductRating } from '@digital8/lighting-illusions-ts-sdk'
13
+ import type { CategoryAutomationFieldType } from '@digital8/lighting-illusions-ts-sdk'
14
14
 
15
15
  // TODO: Update the object below with actual values
16
16
  const example = {
17
- } satisfies ProductRating
17
+ } satisfies CategoryAutomationFieldType
18
18
 
19
19
  console.log(example)
20
20
 
@@ -23,7 +23,7 @@ const exampleJSON: string = JSON.stringify(example)
23
23
  console.log(exampleJSON)
24
24
 
25
25
  // Parse the JSON string back to an object
26
- const exampleParsed = JSON.parse(exampleJSON) as ProductRating
26
+ const exampleParsed = JSON.parse(exampleJSON) as CategoryAutomationFieldType
27
27
  console.log(exampleParsed)
28
28
  ```
29
29
 
@@ -0,0 +1,46 @@
1
+
2
+ # CategoryAutomationRuleResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `fieldType` | object
11
+ `comparisonType` | object
12
+ `groupId` | string
13
+ `relatedId` | string
14
+ `value` | string
15
+ `valueId` | string
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import type { CategoryAutomationRuleResource } from '@digital8/lighting-illusions-ts-sdk'
21
+
22
+ // TODO: Update the object below with actual values
23
+ const example = {
24
+ "id": null,
25
+ "fieldType": null,
26
+ "comparisonType": null,
27
+ "groupId": null,
28
+ "relatedId": null,
29
+ "value": null,
30
+ "valueId": null,
31
+ } satisfies CategoryAutomationRuleResource
32
+
33
+ console.log(example)
34
+
35
+ // Convert the instance to a JSON string
36
+ const exampleJSON: string = JSON.stringify(example)
37
+ console.log(exampleJSON)
38
+
39
+ // Parse the JSON string back to an object
40
+ const exampleParsed = JSON.parse(exampleJSON) as CategoryAutomationRuleResource
41
+ console.log(exampleParsed)
42
+ ```
43
+
44
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
45
+
46
+
@@ -0,0 +1,34 @@
1
+
2
+ # CategoryAutomationRuleResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<CategoryAutomationRuleResource>](CategoryAutomationRuleResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { CategoryAutomationRuleResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies CategoryAutomationRuleResourceArrayResponse
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 CategoryAutomationRuleResourceArrayResponse
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,52 @@
1
+
2
+ # GetAllProductCategoryRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `search` | string
10
+ `sortBy` | string
11
+ `sortDirection` | string
12
+ `relatedId` | number
13
+ `relatedType` | string
14
+ `includesRelations` | boolean
15
+ `siteId` | Array<string>
16
+ `parentId` | Array<string>
17
+ `isDisabled` | Array<string>
18
+ `isAutomated` | Array<string>
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import type { GetAllProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk'
24
+
25
+ // TODO: Update the object below with actual values
26
+ const example = {
27
+ "search": null,
28
+ "sortBy": null,
29
+ "sortDirection": null,
30
+ "relatedId": null,
31
+ "relatedType": null,
32
+ "includesRelations": null,
33
+ "siteId": null,
34
+ "parentId": null,
35
+ "isDisabled": null,
36
+ "isAutomated": null,
37
+ } satisfies GetAllProductCategoryRequest
38
+
39
+ console.log(example)
40
+
41
+ // Convert the instance to a JSON string
42
+ const exampleJSON: string = JSON.stringify(example)
43
+ console.log(exampleJSON)
44
+
45
+ // Parse the JSON string back to an object
46
+ const exampleParsed = JSON.parse(exampleJSON) as GetAllProductCategoryRequest
47
+ console.log(exampleParsed)
48
+ ```
49
+
50
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
51
+
52
+
@@ -0,0 +1,56 @@
1
+
2
+ # IndexProductCategoryRequest
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
+ `parentId` | Array<string>
16
+ `isDisabled` | Array<string>
17
+ `isAutomated` | Array<string>
18
+ `relatedId` | number
19
+ `relatedType` | string
20
+ `includesRelations` | boolean
21
+
22
+ ## Example
23
+
24
+ ```typescript
25
+ import type { IndexProductCategoryRequest } from '@digital8/lighting-illusions-ts-sdk'
26
+
27
+ // TODO: Update the object below with actual values
28
+ const example = {
29
+ "search": null,
30
+ "sortBy": null,
31
+ "sortDirection": null,
32
+ "perPage": null,
33
+ "page": null,
34
+ "siteId": null,
35
+ "parentId": null,
36
+ "isDisabled": null,
37
+ "isAutomated": null,
38
+ "relatedId": null,
39
+ "relatedType": null,
40
+ "includesRelations": null,
41
+ } satisfies IndexProductCategoryRequest
42
+
43
+ console.log(example)
44
+
45
+ // Convert the instance to a JSON string
46
+ const exampleJSON: string = JSON.stringify(example)
47
+ console.log(exampleJSON)
48
+
49
+ // Parse the JSON string back to an object
50
+ const exampleParsed = JSON.parse(exampleJSON) as IndexProductCategoryRequest
51
+ console.log(exampleParsed)
52
+ ```
53
+
54
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
55
+
56
+
@@ -1,24 +1,24 @@
1
1
 
2
- # PaginatedProductSearchResultResourceResponse
2
+ # PaginatedProductCategoryListResourceResponse
3
3
 
4
4
 
5
5
  ## Properties
6
6
 
7
7
  Name | Type
8
8
  ------------ | -------------
9
- `data` | [Array<ProductSearchResultResource>](ProductSearchResultResource.md)
9
+ `data` | [Array<ProductCategoryListResource>](ProductCategoryListResource.md)
10
10
  `meta` | [PagingMetadata](PagingMetadata.md)
11
11
 
12
12
  ## Example
13
13
 
14
14
  ```typescript
15
- import type { PaginatedProductSearchResultResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+ import type { PaginatedProductCategoryListResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
16
16
 
17
17
  // TODO: Update the object below with actual values
18
18
  const example = {
19
19
  "data": null,
20
20
  "meta": null,
21
- } satisfies PaginatedProductSearchResultResourceResponse
21
+ } satisfies PaginatedProductCategoryListResourceResponse
22
22
 
23
23
  console.log(example)
24
24
 
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
27
27
  console.log(exampleJSON)
28
28
 
29
29
  // Parse the JSON string back to an object
30
- const exampleParsed = JSON.parse(exampleJSON) as PaginatedProductSearchResultResourceResponse
30
+ const exampleParsed = JSON.parse(exampleJSON) as PaginatedProductCategoryListResourceResponse
31
31
  console.log(exampleParsed)
32
32
  ```
33
33
 
@@ -0,0 +1,36 @@
1
+
2
+ # PaginatedProductCategoryResourceResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<ProductCategoryResource>](ProductCategoryResource.md)
10
+ `meta` | [PagingMetadata](PagingMetadata.md)
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { PaginatedProductCategoryResourceResponse } 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 PaginatedProductCategoryResourceResponse
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 PaginatedProductCategoryResourceResponse
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
+