@digital8/lighting-illusions-ts-sdk 0.0.473 → 0.0.475
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 +78 -10
- package/README.md +59 -20
- package/dist/apis/AttributeApi.d.ts +33 -33
- package/dist/apis/AttributeApi.js +92 -92
- package/dist/apis/OverlayTemplateApi.d.ts +39 -39
- package/dist/apis/OverlayTemplateApi.js +110 -110
- package/dist/apis/ProductApi.d.ts +78 -17
- package/dist/apis/ProductApi.js +271 -24
- package/dist/apis/ProductTypeApi.d.ts +33 -33
- package/dist/apis/ProductTypeApi.js +89 -89
- 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 +27 -27
- package/dist/apis/TagApi.js +81 -81
- package/dist/models/AssetLiteResource.d.ts +6 -0
- package/dist/models/AssetLiteResource.js +4 -0
- package/dist/models/AttachAccessoriesProductChildRequest.d.ts +32 -0
- package/dist/models/AttachAccessoriesProductChildRequest.js +51 -0
- package/dist/models/AttachAssetsOverlayTemplateRequest.d.ts +32 -0
- package/dist/models/AttachAssetsOverlayTemplateRequest.js +51 -0
- package/dist/models/AttachAttributeProductTypeRequest.d.ts +48 -0
- package/dist/models/AttachAttributeProductTypeRequest.js +65 -0
- package/dist/models/AttachProductTypeAttributeRequest.d.ts +48 -0
- package/dist/models/AttachProductTypeAttributeRequest.js +65 -0
- 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/DescriptionResource.d.ts +44 -0
- package/dist/models/DescriptionResource.js +59 -0
- package/dist/models/DescriptionResourceArrayResponse.d.ts +33 -0
- package/dist/models/DescriptionResourceArrayResponse.js +50 -0
- package/dist/models/DetachAssetableOverlayTemplateRequest.d.ts +51 -0
- package/dist/models/DetachAssetableOverlayTemplateRequest.js +64 -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 +45 -0
- package/dist/models/OverlayTemplateListResource.js +60 -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 +63 -0
- package/dist/models/ProductChildListResource.js +72 -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 +44 -0
- package/dist/models/ProductTypeListResource.js +59 -0
- package/dist/models/ProductTypeListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ProductTypeListResourceArrayResponse.js +50 -0
- package/dist/models/SEOResource.d.ts +2 -20
- package/dist/models/SEOResource.js +8 -20
- 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 +87 -0
- package/dist/models/SiteNotificationListResource.js +84 -0
- package/dist/models/SiteNotificationListResourceArrayResponse.d.ts +33 -0
- package/dist/models/SiteNotificationListResourceArrayResponse.js +50 -0
- package/dist/models/StoreProductChildRequestSitesInner.d.ts +3 -15
- package/dist/models/StoreProductChildRequestSitesInner.js +7 -9
- package/dist/models/StoreSupplierRequest.d.ts +7 -0
- package/dist/models/StoreSupplierRequest.js +5 -0
- package/dist/models/StoreSupplierRequestDescriptionsInner.d.ts +44 -0
- package/dist/models/StoreSupplierRequestDescriptionsInner.js +55 -0
- package/dist/models/StoreSupplierRequestSeoInner.d.ts +2 -20
- package/dist/models/StoreSupplierRequestSeoInner.js +4 -10
- package/dist/models/StoreTagRequest.d.ts +3 -9
- package/dist/models/StoreTagRequest.js +6 -8
- package/dist/models/SupplierFrontendResource.d.ts +7 -0
- package/dist/models/SupplierFrontendResource.js +5 -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/SupplierResource.d.ts +7 -0
- package/dist/models/SupplierResource.js +5 -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/TagResource.d.ts +7 -0
- package/dist/models/TagResource.js +5 -0
- package/dist/models/UpdateSupplierRequest.d.ts +7 -0
- package/dist/models/UpdateSupplierRequest.js +5 -0
- package/dist/models/UpdateTagRequest.d.ts +3 -9
- package/dist/models/UpdateTagRequest.js +6 -8
- package/dist/models/index.d.ts +39 -5
- package/dist/models/index.js +39 -5
- package/docs/AssetLiteResource.md +2 -0
- package/docs/{LinkProductChildrenTagRequest.md → AttachAccessoriesProductChildRequest.md} +4 -4
- package/docs/{LinkAssetsOverlayTemplateRequest.md → AttachAssetsOverlayTemplateRequest.md} +4 -4
- package/docs/{LinkAttributeProductTypeRequest.md → AttachAttributeProductTypeRequest.md} +4 -4
- package/docs/{LinkProductTypeAttributeRequest.md → AttachProductTypeAttributeRequest.md} +4 -4
- package/docs/AttributeApi.md +117 -117
- package/docs/AttributeListResource.md +42 -0
- package/docs/AttributeListResourceArrayResponse.md +34 -0
- package/docs/DescriptionResource.md +38 -0
- package/docs/DescriptionResourceArrayResponse.md +34 -0
- package/docs/{UnlinkAssetableOverlayTemplateRequest.md → DetachAssetableOverlayTemplateRequest.md} +6 -4
- 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 +115 -115
- package/docs/OverlayTemplateListResource.md +38 -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 +377 -29
- package/docs/ProductChildListResource.md +44 -0
- package/docs/ProductChildListResourceArrayResponse.md +34 -0
- package/docs/ProductListResource.md +36 -0
- package/docs/ProductListResourceArrayResponse.md +34 -0
- package/docs/ProductTypeApi.md +94 -94
- package/docs/ProductTypeListResource.md +38 -0
- package/docs/ProductTypeListResourceArrayResponse.md +34 -0
- package/docs/SEOResource.md +4 -10
- package/docs/SiteApi.md +6 -6
- package/docs/SiteListResource.md +40 -0
- package/docs/SiteListResourceArrayResponse.md +34 -0
- package/docs/SiteNotificationListResource.md +52 -0
- package/docs/SiteNotificationListResourceArrayResponse.md +34 -0
- package/docs/StoreProductChildRequestSitesInner.md +4 -8
- package/docs/StoreSupplierRequest.md +2 -0
- package/docs/StoreSupplierRequestDescriptionsInner.md +38 -0
- package/docs/StoreSupplierRequestSeoInner.md +4 -10
- package/docs/StoreTagRequest.md +6 -8
- package/docs/SupplierApi.md +3 -3
- package/docs/SupplierFrontendResource.md +2 -0
- package/docs/SupplierListResource.md +42 -0
- package/docs/SupplierListResourceArrayResponse.md +34 -0
- package/docs/SupplierResource.md +2 -0
- package/docs/TagApi.md +84 -84
- package/docs/TagListResource.md +42 -0
- package/docs/TagListResourceArrayResponse.md +34 -0
- package/docs/TagResource.md +2 -0
- package/docs/UpdateSupplierRequest.md +2 -0
- package/docs/UpdateTagRequest.md +6 -8
- package/package.json +1 -1
- package/src/apis/AttributeApi.ts +108 -108
- package/src/apis/OverlayTemplateApi.ts +141 -141
- package/src/apis/ProductApi.ts +282 -32
- package/src/apis/ProductTypeApi.ts +104 -104
- package/src/apis/SiteApi.ts +12 -12
- package/src/apis/SupplierApi.ts +6 -6
- package/src/apis/TagApi.ts +94 -94
- package/src/models/AssetLiteResource.ts +9 -0
- package/src/models/AttachAccessoriesProductChildRequest.ts +66 -0
- package/src/models/AttachAssetsOverlayTemplateRequest.ts +66 -0
- package/src/models/AttachAttributeProductTypeRequest.ts +88 -0
- package/src/models/AttachProductTypeAttributeRequest.ts +88 -0
- package/src/models/AttributeListResource.ts +102 -0
- package/src/models/AttributeListResourceArrayResponse.ts +73 -0
- package/src/models/DescriptionResource.ts +84 -0
- package/src/models/DescriptionResourceArrayResponse.ts +73 -0
- package/src/models/DetachAssetableOverlayTemplateRequest.ts +93 -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 +92 -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 +119 -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 +84 -0
- package/src/models/ProductTypeListResourceArrayResponse.ts +73 -0
- package/src/models/SEOResource.ts +10 -37
- package/src/models/SiteListResource.ts +93 -0
- package/src/models/SiteListResourceArrayResponse.ts +73 -0
- package/src/models/SiteNotificationListResource.ts +153 -0
- package/src/models/SiteNotificationListResourceArrayResponse.ts +73 -0
- package/src/models/StoreProductChildRequestSitesInner.ts +9 -24
- package/src/models/StoreSupplierRequest.ts +16 -0
- package/src/models/StoreSupplierRequestDescriptionsInner.ts +82 -0
- package/src/models/StoreSupplierRequestSeoInner.ts +6 -30
- package/src/models/StoreTagRequest.ts +9 -17
- package/src/models/SupplierFrontendResource.ts +16 -0
- package/src/models/SupplierListResource.ts +110 -0
- package/src/models/SupplierListResourceArrayResponse.ts +73 -0
- package/src/models/SupplierResource.ts +16 -0
- package/src/models/TagListResource.ts +110 -0
- package/src/models/TagListResourceArrayResponse.ts +73 -0
- package/src/models/TagResource.ts +16 -0
- package/src/models/UpdateSupplierRequest.ts +16 -0
- package/src/models/UpdateTagRequest.ts +9 -17
- package/src/models/index.ts +39 -5
- package/dist/models/LinkAssetsOverlayTemplateRequest.d.ts +0 -32
- package/dist/models/LinkAssetsOverlayTemplateRequest.js +0 -51
- package/dist/models/LinkAttributeProductTypeRequest.d.ts +0 -48
- package/dist/models/LinkAttributeProductTypeRequest.js +0 -65
- package/dist/models/LinkProductChildrenTagRequest.d.ts +0 -32
- package/dist/models/LinkProductChildrenTagRequest.js +0 -51
- package/dist/models/LinkProductTypeAttributeRequest.d.ts +0 -48
- package/dist/models/LinkProductTypeAttributeRequest.js +0 -65
- package/dist/models/UnlinkAssetableOverlayTemplateRequest.d.ts +0 -45
- package/dist/models/UnlinkAssetableOverlayTemplateRequest.js +0 -62
- package/src/models/LinkAssetsOverlayTemplateRequest.ts +0 -66
- package/src/models/LinkAttributeProductTypeRequest.ts +0 -88
- package/src/models/LinkProductChildrenTagRequest.ts +0 -66
- package/src/models/LinkProductTypeAttributeRequest.ts +0 -88
- package/src/models/UnlinkAssetableOverlayTemplateRequest.ts +0 -85
|
@@ -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,52 @@
|
|
|
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
|
+
`startDate` | string
|
|
14
|
+
`endDate` | string
|
|
15
|
+
`text` | string
|
|
16
|
+
`textColour` | string
|
|
17
|
+
`backgroundColour` | string
|
|
18
|
+
`sites` | [SiteLiteResource](SiteLiteResource.md)
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { SiteNotificationListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"id": null,
|
|
28
|
+
"heading": null,
|
|
29
|
+
"type": null,
|
|
30
|
+
"isActive": null,
|
|
31
|
+
"startDate": null,
|
|
32
|
+
"endDate": null,
|
|
33
|
+
"text": null,
|
|
34
|
+
"textColour": null,
|
|
35
|
+
"backgroundColour": null,
|
|
36
|
+
"sites": null,
|
|
37
|
+
} satisfies SiteNotificationListResource
|
|
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 SiteNotificationListResource
|
|
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,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
|
+
|
|
@@ -14,10 +14,8 @@ Name | Type
|
|
|
14
14
|
`salePrice` | number
|
|
15
15
|
`slug` | string
|
|
16
16
|
`documents` | Array<number>
|
|
17
|
-
`
|
|
18
|
-
`
|
|
19
|
-
`footerDescription` | string
|
|
20
|
-
`pageDescription` | string
|
|
17
|
+
`seoTitle` | string
|
|
18
|
+
`seoDescription` | string
|
|
21
19
|
|
|
22
20
|
## Example
|
|
23
21
|
|
|
@@ -34,10 +32,8 @@ const example = {
|
|
|
34
32
|
"salePrice": null,
|
|
35
33
|
"slug": null,
|
|
36
34
|
"documents": null,
|
|
37
|
-
"
|
|
38
|
-
"
|
|
39
|
-
"footerDescription": null,
|
|
40
|
-
"pageDescription": null,
|
|
35
|
+
"seoTitle": null,
|
|
36
|
+
"seoDescription": null,
|
|
41
37
|
} satisfies StoreProductChildRequestSitesInner
|
|
42
38
|
|
|
43
39
|
console.log(example)
|
|
@@ -13,6 +13,7 @@ Name | Type
|
|
|
13
13
|
`altText` | string
|
|
14
14
|
`mimeType` | string
|
|
15
15
|
`assetFileId` | number
|
|
16
|
+
`descriptions` | [Array<StoreSupplierRequestDescriptionsInner>](StoreSupplierRequestDescriptionsInner.md)
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -28,6 +29,7 @@ const example = {
|
|
|
28
29
|
"altText": null,
|
|
29
30
|
"mimeType": null,
|
|
30
31
|
"assetFileId": null,
|
|
32
|
+
"descriptions": null,
|
|
31
33
|
} satisfies StoreSupplierRequest
|
|
32
34
|
|
|
33
35
|
console.log(example)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# StoreSupplierRequestDescriptionsInner
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`headerDescription` | string
|
|
10
|
+
`footerDescription` | string
|
|
11
|
+
`siteId` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { StoreSupplierRequestDescriptionsInner } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"headerDescription": null,
|
|
21
|
+
"footerDescription": null,
|
|
22
|
+
"siteId": null,
|
|
23
|
+
} satisfies StoreSupplierRequestDescriptionsInner
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as StoreSupplierRequestDescriptionsInner
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -6,11 +6,8 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
10
|
-
`
|
|
11
|
-
`keywords` | string
|
|
12
|
-
`footerDescription` | string
|
|
13
|
-
`pageDescription` | string
|
|
9
|
+
`seoTitle` | string
|
|
10
|
+
`seoDescription` | string
|
|
14
11
|
`siteId` | number
|
|
15
12
|
|
|
16
13
|
## Example
|
|
@@ -20,11 +17,8 @@ import type { StoreSupplierRequestSeoInner } from '@digital8/lighting-illusions-
|
|
|
20
17
|
|
|
21
18
|
// TODO: Update the object below with actual values
|
|
22
19
|
const example = {
|
|
23
|
-
"
|
|
24
|
-
"
|
|
25
|
-
"keywords": null,
|
|
26
|
-
"footerDescription": null,
|
|
27
|
-
"pageDescription": null,
|
|
20
|
+
"seoTitle": null,
|
|
21
|
+
"seoDescription": null,
|
|
28
22
|
"siteId": null,
|
|
29
23
|
} satisfies StoreSupplierRequestSeoInner
|
|
30
24
|
|
package/docs/StoreTagRequest.md
CHANGED
|
@@ -10,11 +10,10 @@ Name | Type
|
|
|
10
10
|
`slug` | string
|
|
11
11
|
`siteId` | number
|
|
12
12
|
`type` | string
|
|
13
|
-
`
|
|
14
|
-
`
|
|
15
|
-
`
|
|
13
|
+
`seoTitle` | string
|
|
14
|
+
`seoDescription` | string
|
|
15
|
+
`headerDescription` | string
|
|
16
16
|
`footerDescription` | string
|
|
17
|
-
`pageDescription` | string
|
|
18
17
|
|
|
19
18
|
## Example
|
|
20
19
|
|
|
@@ -27,11 +26,10 @@ const example = {
|
|
|
27
26
|
"slug": null,
|
|
28
27
|
"siteId": null,
|
|
29
28
|
"type": null,
|
|
30
|
-
"
|
|
31
|
-
"
|
|
32
|
-
"
|
|
29
|
+
"seoTitle": null,
|
|
30
|
+
"seoDescription": null,
|
|
31
|
+
"headerDescription": null,
|
|
33
32
|
"footerDescription": null,
|
|
34
|
-
"pageDescription": null,
|
|
35
33
|
} satisfies StoreTagRequest
|
|
36
34
|
|
|
37
35
|
console.log(example)
|
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
|
|
|
@@ -12,6 +12,7 @@ Name | Type
|
|
|
12
12
|
`thumbnail` | [AssetResource](AssetResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
14
|
`seo` | [SEOResource](SEOResource.md)
|
|
15
|
+
`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -26,6 +27,7 @@ const example = {
|
|
|
26
27
|
"thumbnail": null,
|
|
27
28
|
"supplierEta": null,
|
|
28
29
|
"seo": null,
|
|
30
|
+
"descriptions": null,
|
|
29
31
|
} satisfies SupplierFrontendResource
|
|
30
32
|
|
|
31
33
|
console.log(example)
|
|
@@ -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/SupplierResource.md
CHANGED
|
@@ -12,6 +12,7 @@ Name | Type
|
|
|
12
12
|
`thumbnail` | [AssetResource](AssetResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
14
|
`seo` | [Array<SEOResource>](SEOResource.md)
|
|
15
|
+
`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
@@ -26,6 +27,7 @@ const example = {
|
|
|
26
27
|
"thumbnail": null,
|
|
27
28
|
"supplierEta": null,
|
|
28
29
|
"seo": null,
|
|
30
|
+
"descriptions": null,
|
|
29
31
|
} satisfies SupplierResource
|
|
30
32
|
|
|
31
33
|
console.log(example)
|