@digital8/lighting-illusions-ts-sdk 0.0.463 → 0.0.464
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.
- package/.openapi-generator/FILES +62 -0
- package/README.md +34 -4
- package/dist/apis/AttributeApi.d.ts +3 -3
- package/dist/apis/AttributeApi.js +1 -1
- package/dist/apis/OverlayTemplateApi.d.ts +3 -3
- package/dist/apis/OverlayTemplateApi.js +1 -1
- package/dist/apis/ProductApi.d.ts +12 -23
- package/dist/apis/ProductApi.js +15 -60
- package/dist/apis/ProductTypeApi.d.ts +3 -3
- package/dist/apis/ProductTypeApi.js +1 -1
- package/dist/apis/SiteApi.d.ts +5 -5
- package/dist/apis/SiteApi.js +2 -2
- package/dist/apis/SupplierApi.d.ts +3 -3
- package/dist/apis/SupplierApi.js +1 -1
- package/dist/apis/TagApi.d.ts +3 -3
- package/dist/apis/TagApi.js +1 -1
- package/dist/models/AttributeListResource.d.ts +56 -0
- package/dist/models/AttributeListResource.js +67 -0
- package/dist/models/AttributeListResourceArrayResponse.d.ts +33 -0
- package/dist/models/AttributeListResourceArrayResponse.js +50 -0
- package/dist/models/ExternalApiLogListResource.d.ts +56 -0
- package/dist/models/ExternalApiLogListResource.js +63 -0
- package/dist/models/ExternalApiLogListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ExternalApiLogListResourceArrayResponse.js +50 -0
- package/dist/models/GetAllAttributeRequest.d.ts +15 -9
- package/dist/models/GetAllAttributeRequest.js +6 -4
- package/dist/models/GetAllOverlayTemplateRequest.d.ts +12 -6
- package/dist/models/GetAllOverlayTemplateRequest.js +4 -2
- package/dist/models/GetAllProductChildRequest.d.ts +6 -0
- package/dist/models/GetAllProductChildRequest.js +2 -0
- package/dist/models/GetAllProductRequest.d.ts +36 -0
- package/dist/models/GetAllProductRequest.js +12 -0
- package/dist/models/GetAllProductTypeRequest.d.ts +6 -0
- package/dist/models/GetAllProductTypeRequest.js +2 -0
- package/dist/models/GetAllSupplierRequest.d.ts +6 -0
- package/dist/models/GetAllSupplierRequest.js +2 -0
- package/dist/models/IndexAttributeRequest.d.ts +25 -0
- package/dist/models/IndexAttributeRequest.js +13 -1
- package/dist/models/IndexExternalApiLogRequest.d.ts +21 -3
- package/dist/models/IndexExternalApiLogRequest.js +10 -4
- package/dist/models/IndexOverlayTemplateRequest.d.ts +25 -0
- package/dist/models/IndexOverlayTemplateRequest.js +13 -1
- package/dist/models/IndexProductChildRequest.d.ts +6 -0
- package/dist/models/IndexProductChildRequest.js +2 -0
- package/dist/models/IndexProductRequest.d.ts +130 -0
- package/dist/models/IndexProductRequest.js +97 -0
- package/dist/models/IndexProductTypeRequest.d.ts +25 -0
- package/dist/models/IndexProductTypeRequest.js +13 -1
- package/dist/models/IndexSiteNotificationRequest.d.ts +18 -0
- package/dist/models/IndexSiteNotificationRequest.js +6 -0
- package/dist/models/IndexSiteRequest.d.ts +18 -0
- package/dist/models/IndexSiteRequest.js +6 -0
- package/dist/models/IndexSupplierRequest.d.ts +25 -0
- package/dist/models/IndexSupplierRequest.js +13 -1
- package/dist/models/IndexTagRequest.d.ts +25 -0
- package/dist/models/IndexTagRequest.js +13 -1
- package/dist/models/OverlayTemplateListResource.d.ts +38 -0
- package/dist/models/OverlayTemplateListResource.js +55 -0
- package/dist/models/OverlayTemplateListResourceArrayResponse.d.ts +33 -0
- package/dist/models/OverlayTemplateListResourceArrayResponse.js +50 -0
- package/dist/models/PaginatedAttributeListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedAttributeListResourceResponse.js +57 -0
- package/dist/models/PaginatedExternalApiLogListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedExternalApiLogListResourceResponse.js +57 -0
- package/dist/models/PaginatedOverlayTemplateListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedOverlayTemplateListResourceResponse.js +57 -0
- package/dist/models/PaginatedProductChildListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedProductChildListResourceResponse.js +57 -0
- package/dist/models/PaginatedProductListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedProductListResourceResponse.js +57 -0
- package/dist/models/PaginatedProductTypeListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedProductTypeListResourceResponse.js +57 -0
- package/dist/models/PaginatedSiteListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedSiteListResourceResponse.js +57 -0
- package/dist/models/PaginatedSiteNotificationListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedSiteNotificationListResourceResponse.js +57 -0
- package/dist/models/PaginatedSupplierListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedSupplierListResourceResponse.js +57 -0
- package/dist/models/PaginatedTagListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedTagListResourceResponse.js +57 -0
- package/dist/models/ProductChildListResource.d.ts +51 -0
- package/dist/models/ProductChildListResource.js +64 -0
- package/dist/models/ProductChildListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ProductChildListResourceArrayResponse.js +50 -0
- package/dist/models/ProductListResource.d.ts +38 -0
- package/dist/models/ProductListResource.js +55 -0
- package/dist/models/ProductListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ProductListResourceArrayResponse.js +50 -0
- package/dist/models/ProductTypeListResource.d.ts +38 -0
- package/dist/models/ProductTypeListResource.js +55 -0
- package/dist/models/ProductTypeListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ProductTypeListResourceArrayResponse.js +50 -0
- package/dist/models/SiteListResource.d.ts +50 -0
- package/dist/models/SiteListResource.js +63 -0
- package/dist/models/SiteListResourceArrayResponse.d.ts +33 -0
- package/dist/models/SiteListResourceArrayResponse.js +50 -0
- package/dist/models/SiteNotificationListResource.d.ts +50 -0
- package/dist/models/SiteNotificationListResource.js +59 -0
- package/dist/models/SiteNotificationListResourceArrayResponse.d.ts +33 -0
- package/dist/models/SiteNotificationListResourceArrayResponse.js +50 -0
- package/dist/models/SupplierListResource.d.ts +57 -0
- package/dist/models/SupplierListResource.js +68 -0
- package/dist/models/SupplierListResourceArrayResponse.d.ts +33 -0
- package/dist/models/SupplierListResourceArrayResponse.js +50 -0
- package/dist/models/TagListResource.d.ts +57 -0
- package/dist/models/TagListResource.js +68 -0
- package/dist/models/TagListResourceArrayResponse.d.ts +33 -0
- package/dist/models/TagListResourceArrayResponse.js +50 -0
- package/dist/models/UnlinkAssetableOverlayTemplateRequest.d.ts +6 -0
- package/dist/models/UnlinkAssetableOverlayTemplateRequest.js +2 -0
- package/dist/models/index.d.ts +31 -0
- package/dist/models/index.js +31 -0
- package/docs/AttributeApi.md +3 -3
- package/docs/AttributeListResource.md +42 -0
- package/docs/AttributeListResourceArrayResponse.md +34 -0
- package/docs/ExternalApiLogListResource.md +42 -0
- package/docs/ExternalApiLogListResourceArrayResponse.md +34 -0
- package/docs/GetAllAttributeRequest.md +6 -4
- package/docs/GetAllOverlayTemplateRequest.md +4 -2
- package/docs/GetAllProductChildRequest.md +2 -0
- package/docs/GetAllProductRequest.md +12 -0
- package/docs/GetAllProductTypeRequest.md +2 -0
- package/docs/GetAllSupplierRequest.md +2 -0
- package/docs/IndexAttributeRequest.md +6 -0
- package/docs/IndexExternalApiLogRequest.md +10 -4
- package/docs/IndexOverlayTemplateRequest.md +6 -0
- package/docs/IndexProductChildRequest.md +2 -0
- package/docs/IndexProductRequest.md +58 -0
- package/docs/IndexProductTypeRequest.md +6 -0
- package/docs/IndexSiteNotificationRequest.md +6 -0
- package/docs/IndexSiteRequest.md +6 -0
- package/docs/IndexSupplierRequest.md +6 -0
- package/docs/IndexTagRequest.md +6 -0
- package/docs/OverlayTemplateApi.md +3 -3
- package/docs/OverlayTemplateListResource.md +36 -0
- package/docs/OverlayTemplateListResourceArrayResponse.md +34 -0
- package/docs/PaginatedAttributeListResourceResponse.md +36 -0
- package/docs/PaginatedExternalApiLogListResourceResponse.md +36 -0
- package/docs/PaginatedOverlayTemplateListResourceResponse.md +36 -0
- package/docs/PaginatedProductChildListResourceResponse.md +36 -0
- package/docs/PaginatedProductListResourceResponse.md +36 -0
- package/docs/PaginatedProductTypeListResourceResponse.md +36 -0
- package/docs/PaginatedSiteListResourceResponse.md +36 -0
- package/docs/PaginatedSiteNotificationListResourceResponse.md +36 -0
- package/docs/PaginatedSupplierListResourceResponse.md +36 -0
- package/docs/PaginatedTagListResourceResponse.md +36 -0
- package/docs/ProductApi.md +20 -86
- package/docs/ProductChildListResource.md +40 -0
- package/docs/ProductChildListResourceArrayResponse.md +34 -0
- package/docs/ProductListResource.md +36 -0
- package/docs/ProductListResourceArrayResponse.md +34 -0
- package/docs/ProductTypeApi.md +3 -3
- package/docs/ProductTypeListResource.md +36 -0
- package/docs/ProductTypeListResourceArrayResponse.md +34 -0
- package/docs/SiteApi.md +6 -6
- package/docs/SiteListResource.md +40 -0
- package/docs/SiteListResourceArrayResponse.md +34 -0
- package/docs/SiteNotificationListResource.md +40 -0
- package/docs/SiteNotificationListResourceArrayResponse.md +34 -0
- package/docs/SupplierApi.md +3 -3
- package/docs/SupplierListResource.md +42 -0
- package/docs/SupplierListResourceArrayResponse.md +34 -0
- package/docs/TagApi.md +3 -3
- package/docs/TagListResource.md +42 -0
- package/docs/TagListResourceArrayResponse.md +34 -0
- package/docs/UnlinkAssetableOverlayTemplateRequest.md +2 -0
- package/package.json +1 -1
- package/src/apis/AttributeApi.ts +6 -6
- package/src/apis/OverlayTemplateApi.ts +6 -6
- package/src/apis/ProductApi.ts +27 -60
- package/src/apis/ProductTypeApi.ts +6 -6
- package/src/apis/SiteApi.ts +12 -12
- package/src/apis/SupplierApi.ts +6 -6
- package/src/apis/TagApi.ts +6 -6
- package/src/models/AttributeListResource.ts +102 -0
- package/src/models/AttributeListResourceArrayResponse.ts +73 -0
- package/src/models/ExternalApiLogListResource.ts +100 -0
- package/src/models/ExternalApiLogListResourceArrayResponse.ts +73 -0
- package/src/models/GetAllAttributeRequest.ts +21 -13
- package/src/models/GetAllOverlayTemplateRequest.ts +16 -8
- package/src/models/GetAllProductChildRequest.ts +8 -0
- package/src/models/GetAllProductRequest.ts +48 -0
- package/src/models/GetAllProductTypeRequest.ts +8 -0
- package/src/models/GetAllSupplierRequest.ts +8 -0
- package/src/models/IndexAttributeRequest.ts +32 -0
- package/src/models/IndexExternalApiLogRequest.ts +31 -7
- package/src/models/IndexOverlayTemplateRequest.ts +32 -0
- package/src/models/IndexProductChildRequest.ts +8 -0
- package/src/models/IndexProductRequest.ts +192 -0
- package/src/models/IndexProductTypeRequest.ts +32 -0
- package/src/models/IndexSiteNotificationRequest.ts +24 -0
- package/src/models/IndexSiteRequest.ts +24 -0
- package/src/models/IndexSupplierRequest.ts +32 -0
- package/src/models/IndexTagRequest.ts +32 -0
- package/src/models/OverlayTemplateListResource.ts +75 -0
- package/src/models/OverlayTemplateListResourceArrayResponse.ts +73 -0
- package/src/models/PaginatedAttributeListResourceResponse.ts +90 -0
- package/src/models/PaginatedExternalApiLogListResourceResponse.ts +90 -0
- package/src/models/PaginatedOverlayTemplateListResourceResponse.ts +90 -0
- package/src/models/PaginatedProductChildListResourceResponse.ts +90 -0
- package/src/models/PaginatedProductListResourceResponse.ts +90 -0
- package/src/models/PaginatedProductTypeListResourceResponse.ts +90 -0
- package/src/models/PaginatedSiteListResourceResponse.ts +90 -0
- package/src/models/PaginatedSiteNotificationListResourceResponse.ts +90 -0
- package/src/models/PaginatedSupplierListResourceResponse.ts +90 -0
- package/src/models/PaginatedTagListResourceResponse.ts +90 -0
- package/src/models/ProductChildListResource.ts +101 -0
- package/src/models/ProductChildListResourceArrayResponse.ts +73 -0
- package/src/models/ProductListResource.ts +75 -0
- package/src/models/ProductListResourceArrayResponse.ts +73 -0
- package/src/models/ProductTypeListResource.ts +75 -0
- package/src/models/ProductTypeListResourceArrayResponse.ts +73 -0
- package/src/models/SiteListResource.ts +93 -0
- package/src/models/SiteListResourceArrayResponse.ts +73 -0
- package/src/models/SiteNotificationListResource.ts +91 -0
- package/src/models/SiteNotificationListResourceArrayResponse.ts +73 -0
- package/src/models/SupplierListResource.ts +110 -0
- package/src/models/SupplierListResourceArrayResponse.ts +73 -0
- package/src/models/TagListResource.ts +110 -0
- package/src/models/TagListResourceArrayResponse.ts +73 -0
- package/src/models/UnlinkAssetableOverlayTemplateRequest.ts +8 -0
- package/src/models/index.ts +31 -0
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# ProductChildListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`sku` | number
|
|
11
|
+
`name` | string
|
|
12
|
+
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { ProductChildListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"id": null,
|
|
22
|
+
"sku": null,
|
|
23
|
+
"name": null,
|
|
24
|
+
"thumbnail": null,
|
|
25
|
+
} satisfies ProductChildListResource
|
|
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 ProductChildListResource
|
|
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
|
+
# ProductChildListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ProductChildListResource>](ProductChildListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ProductChildListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ProductChildListResourceArrayResponse
|
|
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 ProductChildListResourceArrayResponse
|
|
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
|
+
# ProductListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { ProductListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"id": null,
|
|
20
|
+
"name": null,
|
|
21
|
+
} satisfies ProductListResource
|
|
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 ProductListResource
|
|
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,34 @@
|
|
|
1
|
+
|
|
2
|
+
# ProductListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ProductListResource>](ProductListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ProductListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ProductListResourceArrayResponse
|
|
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 ProductListResourceArrayResponse
|
|
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
|
+
|
package/docs/ProductTypeApi.md
CHANGED
|
@@ -148,7 +148,7 @@ No authorization required
|
|
|
148
148
|
|
|
149
149
|
## indexProductType
|
|
150
150
|
|
|
151
|
-
>
|
|
151
|
+
> PaginatedProductTypeListResourceResponse indexProductType(indexProductTypeRequest)
|
|
152
152
|
|
|
153
153
|
Auto-generated: indexProductType
|
|
154
154
|
|
|
@@ -191,7 +191,7 @@ example().catch(console.error);
|
|
|
191
191
|
|
|
192
192
|
### Return type
|
|
193
193
|
|
|
194
|
-
[**
|
|
194
|
+
[**PaginatedProductTypeListResourceResponse**](PaginatedProductTypeListResourceResponse.md)
|
|
195
195
|
|
|
196
196
|
### Authorization
|
|
197
197
|
|
|
@@ -206,7 +206,7 @@ No authorization required
|
|
|
206
206
|
### HTTP response details
|
|
207
207
|
| Status code | Description | Response headers |
|
|
208
208
|
|-------------|-------------|------------------|
|
|
209
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\
|
|
209
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ProductTypeListResource[]>> | - |
|
|
210
210
|
|
|
211
211
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
212
212
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# ProductTypeListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { ProductTypeListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"id": null,
|
|
20
|
+
"name": null,
|
|
21
|
+
} satisfies ProductTypeListResource
|
|
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 ProductTypeListResource
|
|
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,34 @@
|
|
|
1
|
+
|
|
2
|
+
# ProductTypeListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ProductTypeListResource>](ProductTypeListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ProductTypeListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ProductTypeListResourceArrayResponse
|
|
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 ProductTypeListResourceArrayResponse
|
|
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
|
+
|
package/docs/SiteApi.md
CHANGED
|
@@ -147,7 +147,7 @@ No authorization required
|
|
|
147
147
|
|
|
148
148
|
## indexSite
|
|
149
149
|
|
|
150
|
-
>
|
|
150
|
+
> PaginatedSiteListResourceResponse indexSite(indexSiteRequest)
|
|
151
151
|
|
|
152
152
|
Auto-generated: indexSite
|
|
153
153
|
|
|
@@ -190,7 +190,7 @@ example().catch(console.error);
|
|
|
190
190
|
|
|
191
191
|
### Return type
|
|
192
192
|
|
|
193
|
-
[**
|
|
193
|
+
[**PaginatedSiteListResourceResponse**](PaginatedSiteListResourceResponse.md)
|
|
194
194
|
|
|
195
195
|
### Authorization
|
|
196
196
|
|
|
@@ -205,14 +205,14 @@ No authorization required
|
|
|
205
205
|
### HTTP response details
|
|
206
206
|
| Status code | Description | Response headers |
|
|
207
207
|
|-------------|-------------|------------------|
|
|
208
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\
|
|
208
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\SiteListResource[]>> | - |
|
|
209
209
|
|
|
210
210
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
## indexSiteNotification
|
|
214
214
|
|
|
215
|
-
>
|
|
215
|
+
> PaginatedSiteNotificationListResourceResponse indexSiteNotification(indexSiteNotificationRequest)
|
|
216
216
|
|
|
217
217
|
Auto-generated: indexSiteNotification
|
|
218
218
|
|
|
@@ -255,7 +255,7 @@ example().catch(console.error);
|
|
|
255
255
|
|
|
256
256
|
### Return type
|
|
257
257
|
|
|
258
|
-
[**
|
|
258
|
+
[**PaginatedSiteNotificationListResourceResponse**](PaginatedSiteNotificationListResourceResponse.md)
|
|
259
259
|
|
|
260
260
|
### Authorization
|
|
261
261
|
|
|
@@ -270,7 +270,7 @@ No authorization required
|
|
|
270
270
|
### HTTP response details
|
|
271
271
|
| Status code | Description | Response headers |
|
|
272
272
|
|-------------|-------------|------------------|
|
|
273
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\
|
|
273
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\SiteNotificationListResource[]>> | - |
|
|
274
274
|
|
|
275
275
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
276
276
|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
|
|
2
|
+
# SiteListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`abbreviation` | string
|
|
12
|
+
`domain` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { SiteListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"id": null,
|
|
22
|
+
"name": null,
|
|
23
|
+
"abbreviation": null,
|
|
24
|
+
"domain": null,
|
|
25
|
+
} satisfies SiteListResource
|
|
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 SiteListResource
|
|
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
|
+
# SiteListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<SiteListResource>](SiteListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { SiteListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies SiteListResourceArrayResponse
|
|
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 SiteListResourceArrayResponse
|
|
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,40 @@
|
|
|
1
|
+
|
|
2
|
+
# SiteNotificationListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`heading` | string
|
|
11
|
+
`type` | string
|
|
12
|
+
`isActive` | boolean
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { SiteNotificationListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"id": null,
|
|
22
|
+
"heading": null,
|
|
23
|
+
"type": null,
|
|
24
|
+
"isActive": null,
|
|
25
|
+
} satisfies SiteNotificationListResource
|
|
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 SiteNotificationListResource
|
|
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
|
+
# SiteNotificationListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<SiteNotificationListResource>](SiteNotificationListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { SiteNotificationListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies SiteNotificationListResourceArrayResponse
|
|
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 SiteNotificationListResourceArrayResponse
|
|
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
|
+
|
package/docs/SupplierApi.md
CHANGED
|
@@ -277,7 +277,7 @@ No authorization required
|
|
|
277
277
|
|
|
278
278
|
## indexSupplier
|
|
279
279
|
|
|
280
|
-
>
|
|
280
|
+
> PaginatedSupplierListResourceResponse indexSupplier(indexSupplierRequest)
|
|
281
281
|
|
|
282
282
|
Auto-generated: indexSupplier
|
|
283
283
|
|
|
@@ -320,7 +320,7 @@ example().catch(console.error);
|
|
|
320
320
|
|
|
321
321
|
### Return type
|
|
322
322
|
|
|
323
|
-
[**
|
|
323
|
+
[**PaginatedSupplierListResourceResponse**](PaginatedSupplierListResourceResponse.md)
|
|
324
324
|
|
|
325
325
|
### Authorization
|
|
326
326
|
|
|
@@ -335,7 +335,7 @@ No authorization required
|
|
|
335
335
|
### HTTP response details
|
|
336
336
|
| Status code | Description | Response headers |
|
|
337
337
|
|-------------|-------------|------------------|
|
|
338
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\
|
|
338
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\SupplierListResource[]>> | - |
|
|
339
339
|
|
|
340
340
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
341
341
|
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
|
|
2
|
+
# SupplierListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`slug` | string
|
|
12
|
+
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
13
|
+
`supplierEta` | number
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { SupplierListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"id": null,
|
|
23
|
+
"name": null,
|
|
24
|
+
"slug": null,
|
|
25
|
+
"thumbnail": null,
|
|
26
|
+
"supplierEta": null,
|
|
27
|
+
} satisfies SupplierListResource
|
|
28
|
+
|
|
29
|
+
console.log(example)
|
|
30
|
+
|
|
31
|
+
// Convert the instance to a JSON string
|
|
32
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
33
|
+
console.log(exampleJSON)
|
|
34
|
+
|
|
35
|
+
// Parse the JSON string back to an object
|
|
36
|
+
const exampleParsed = JSON.parse(exampleJSON) as SupplierListResource
|
|
37
|
+
console.log(exampleParsed)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
41
|
+
|
|
42
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# SupplierListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<SupplierListResource>](SupplierListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { SupplierListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies SupplierListResourceArrayResponse
|
|
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 SupplierListResourceArrayResponse
|
|
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
|
+
|
package/docs/TagApi.md
CHANGED
|
@@ -147,7 +147,7 @@ No authorization required
|
|
|
147
147
|
|
|
148
148
|
## indexTag
|
|
149
149
|
|
|
150
|
-
>
|
|
150
|
+
> PaginatedTagListResourceResponse indexTag(indexTagRequest)
|
|
151
151
|
|
|
152
152
|
Auto-generated: indexTag
|
|
153
153
|
|
|
@@ -190,7 +190,7 @@ example().catch(console.error);
|
|
|
190
190
|
|
|
191
191
|
### Return type
|
|
192
192
|
|
|
193
|
-
[**
|
|
193
|
+
[**PaginatedTagListResourceResponse**](PaginatedTagListResourceResponse.md)
|
|
194
194
|
|
|
195
195
|
### Authorization
|
|
196
196
|
|
|
@@ -205,7 +205,7 @@ No authorization required
|
|
|
205
205
|
### HTTP response details
|
|
206
206
|
| Status code | Description | Response headers |
|
|
207
207
|
|-------------|-------------|------------------|
|
|
208
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\
|
|
208
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\TagListResource[]>> | - |
|
|
209
209
|
|
|
210
210
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
211
211
|
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
|
|
2
|
+
# TagListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`slug` | string
|
|
12
|
+
`type` | string
|
|
13
|
+
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { TagListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"id": null,
|
|
23
|
+
"name": null,
|
|
24
|
+
"slug": null,
|
|
25
|
+
"type": null,
|
|
26
|
+
"site": null,
|
|
27
|
+
} satisfies TagListResource
|
|
28
|
+
|
|
29
|
+
console.log(example)
|
|
30
|
+
|
|
31
|
+
// Convert the instance to a JSON string
|
|
32
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
33
|
+
console.log(exampleJSON)
|
|
34
|
+
|
|
35
|
+
// Parse the JSON string back to an object
|
|
36
|
+
const exampleParsed = JSON.parse(exampleJSON) as TagListResource
|
|
37
|
+
console.log(exampleParsed)
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
41
|
+
|
|
42
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# TagListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<TagListResource>](TagListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { TagListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies TagListResourceArrayResponse
|
|
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 TagListResourceArrayResponse
|
|
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
|
+
|
|
@@ -8,6 +8,7 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`relatedId` | number
|
|
10
10
|
`relatedType` | string
|
|
11
|
+
`includesRelations` | boolean
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -18,6 +19,7 @@ import type { UnlinkAssetableOverlayTemplateRequest } from '@digital8/lighting-i
|
|
|
18
19
|
const example = {
|
|
19
20
|
"relatedId": null,
|
|
20
21
|
"relatedType": null,
|
|
22
|
+
"includesRelations": null,
|
|
21
23
|
} satisfies UnlinkAssetableOverlayTemplateRequest
|
|
22
24
|
|
|
23
25
|
console.log(example)
|