@digital8/lighting-illusions-ts-sdk 0.0.1362 → 0.0.1364
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 -72
- package/README.md +45 -54
- package/dist/apis/AttributeApi.d.ts +1 -16
- package/dist/apis/AttributeApi.js +0 -58
- package/dist/apis/StoreApi.d.ts +190 -0
- package/dist/apis/StoreApi.js +744 -0
- package/dist/apis/SupplierApi.d.ts +33 -1
- package/dist/apis/SupplierApi.js +122 -0
- package/dist/apis/index.d.ts +1 -1
- package/dist/apis/index.js +1 -1
- package/dist/models/AddressFrontendResource.d.ts +74 -0
- package/dist/models/AddressFrontendResource.js +77 -0
- package/dist/models/AddressFrontendResourceArrayResponse.d.ts +33 -0
- package/dist/models/AddressFrontendResourceArrayResponse.js +50 -0
- package/dist/models/AddressResource.d.ts +80 -0
- package/dist/models/AddressResource.js +79 -0
- package/dist/models/AddressResourceArrayResponse.d.ts +33 -0
- package/dist/models/AddressResourceArrayResponse.js +50 -0
- package/dist/models/AttachDocumentablesDocumentRequestDocumentablesInner.d.ts +1 -2
- package/dist/models/AttachDocumentablesDocumentRequestDocumentablesInner.js +1 -2
- package/dist/models/AttachStoresSupplierRequest.d.ts +32 -0
- package/dist/models/AttachStoresSupplierRequest.js +51 -0
- package/dist/models/AttachSuppliersStoreRequest.d.ts +32 -0
- package/dist/models/AttachSuppliersStoreRequest.js +51 -0
- package/dist/models/DetachDocumentablesDocumentRequestDocumentablesInner.d.ts +1 -2
- package/dist/models/DetachDocumentablesDocumentRequestDocumentablesInner.js +1 -2
- package/dist/models/DetachStoresSupplierRequest.d.ts +32 -0
- package/dist/models/DetachStoresSupplierRequest.js +51 -0
- package/dist/models/DetachSuppliersStoreRequest.d.ts +32 -0
- package/dist/models/DetachSuppliersStoreRequest.js +51 -0
- package/dist/models/GetAllDocumentRequest.d.ts +1 -2
- package/dist/models/GetAllDocumentRequest.js +1 -2
- package/dist/models/GetAllProductChildRequest.d.ts +0 -1
- package/dist/models/GetAllProductChildRequest.js +0 -1
- package/dist/models/GetAllStoreRequest.d.ts +93 -0
- package/dist/models/GetAllStoreRequest.js +81 -0
- package/dist/models/IndexAttributeRequest.d.ts +0 -2
- package/dist/models/IndexAttributeRequest.js +1 -3
- package/dist/models/IndexDocumentRequest.d.ts +1 -2
- package/dist/models/IndexDocumentRequest.js +1 -2
- package/dist/models/IndexProductChildRequest.d.ts +0 -1
- package/dist/models/IndexProductChildRequest.js +0 -1
- package/dist/models/IndexStoreRequest.d.ts +105 -0
- package/dist/models/{IndexProductRangeRequest.js → IndexStoreRequest.js} +21 -22
- package/dist/models/ModelAttributeResource.d.ts +0 -6
- package/dist/models/ModelAttributeResource.js +0 -2
- package/dist/models/PaginatedStoreListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedStoreListResourceResponse.js +57 -0
- package/dist/models/ProductSearchResultResource.d.ts +1 -1
- package/dist/models/ProductSearchResultResource.js +3 -3
- package/dist/models/StoreAssetForAssetableRequest.d.ts +0 -2
- package/dist/models/StoreAssetForAssetableRequest.js +1 -3
- package/dist/models/StoreFrontendResource.d.ts +98 -0
- package/dist/models/StoreFrontendResource.js +89 -0
- package/dist/models/StoreFrontendResourceArrayResponse.d.ts +33 -0
- package/dist/models/StoreFrontendResourceArrayResponse.js +50 -0
- package/dist/models/StoreListResource.d.ts +81 -0
- package/dist/models/StoreListResource.js +80 -0
- package/dist/models/StoreListResourceArrayResponse.d.ts +33 -0
- package/dist/models/StoreListResourceArrayResponse.js +50 -0
- package/dist/models/StoreLiteResource.d.ts +45 -0
- package/dist/models/StoreLiteResource.js +58 -0
- package/dist/models/StoreLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/StoreLiteResourceArrayResponse.js +50 -0
- package/dist/models/StoreResource.d.ts +102 -0
- package/dist/models/StoreResource.js +95 -0
- package/dist/models/StoreResourceArrayResponse.d.ts +33 -0
- package/dist/models/StoreResourceArrayResponse.js +50 -0
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +56 -0
- package/dist/models/StoreSpecialDateFrontendResource.js +65 -0
- package/dist/models/StoreSpecialDateFrontendResourceArrayResponse.d.ts +33 -0
- package/dist/models/StoreSpecialDateFrontendResourceArrayResponse.js +50 -0
- package/dist/models/StoreSpecialDateResource.d.ts +56 -0
- package/dist/models/StoreSpecialDateResource.js +65 -0
- package/dist/models/StoreSpecialDateResourceArrayResponse.d.ts +33 -0
- package/dist/models/StoreSpecialDateResourceArrayResponse.js +50 -0
- package/dist/models/StoreStoreRequest.d.ts +94 -0
- package/dist/models/StoreStoreRequest.js +85 -0
- package/dist/models/StoreStoreRequestAddress.d.ts +68 -0
- package/dist/models/StoreStoreRequestAddress.js +73 -0
- package/dist/models/StoreStoreRequestSpecialDatesInner.d.ts +50 -0
- package/dist/models/StoreStoreRequestSpecialDatesInner.js +57 -0
- package/dist/models/StoreStoreSpecialDateRequest.d.ts +50 -0
- package/dist/models/StoreStoreSpecialDateRequest.js +57 -0
- package/dist/models/UpdateProductTypeRequest.d.ts +9 -9
- package/dist/models/UpdateProductTypeRequest.js +9 -9
- package/dist/models/UpdateProductTypeRequestPerformanceValuesInner.d.ts +38 -0
- package/dist/models/UpdateProductTypeRequestPerformanceValuesInner.js +51 -0
- package/dist/models/UpdateStoreRequest.d.ts +94 -0
- package/dist/models/UpdateStoreRequest.js +85 -0
- package/dist/models/UpdateStoreRequestSpecialDatesInner.d.ts +56 -0
- package/dist/models/UpdateStoreRequestSpecialDatesInner.js +57 -0
- package/dist/models/index.d.ts +30 -35
- package/dist/models/index.js +30 -35
- package/docs/AddressFrontendResource.md +48 -0
- package/docs/{AttachAccessoriesProductRangeRequest.md → AddressFrontendResourceArrayResponse.md} +6 -6
- package/docs/AddressResource.md +50 -0
- package/docs/{ProductRangeResourceArrayResponse.md → AddressResourceArrayResponse.md} +5 -5
- package/docs/{DetachAttributesProductRangeRequest.md → AttachStoresSupplierRequest.md} +6 -6
- package/docs/AttachSuppliersStoreRequest.md +34 -0
- package/docs/AttributeApi.md +0 -66
- package/docs/{DetachAccessoriesProductRangeRequest.md → DetachStoresSupplierRequest.md} +6 -6
- package/docs/DetachSuppliersStoreRequest.md +34 -0
- package/docs/{GetAllProductRangeRequest.md → GetAllStoreRequest.md} +8 -10
- package/docs/{IndexModelAttributeRequest.md → IndexStoreRequest.md} +8 -10
- package/docs/ModelAttributeResource.md +0 -2
- package/docs/{PaginatedProductRangeResourceResponse.md → PaginatedStoreListResourceResponse.md} +5 -5
- package/docs/ProductSearchResultResource.md +2 -2
- package/docs/StoreApi.md +755 -0
- package/docs/StoreFrontendResource.md +56 -0
- package/docs/{DetachDocumentsProductRangeRequest.md → StoreFrontendResourceArrayResponse.md} +6 -6
- package/docs/{StoreProductRangeRequest.md → StoreListResource.md} +20 -10
- package/docs/StoreListResourceArrayResponse.md +34 -0
- package/docs/{ProductRangeLiteResource.md → StoreLiteResource.md} +6 -4
- package/docs/StoreLiteResourceArrayResponse.md +34 -0
- package/docs/StoreResource.md +56 -0
- package/docs/StoreResourceArrayResponse.md +34 -0
- package/docs/{ProductRangeFrontendListResource.md → StoreSpecialDateFrontendResource.md} +10 -12
- package/docs/{ProductRangeFrontendListResourceArrayResponse.md → StoreSpecialDateFrontendResourceArrayResponse.md} +5 -5
- package/docs/{ProductRangeSiteDetailLiteResource.md → StoreSpecialDateResource.md} +12 -8
- package/docs/{ProductRangeLiteResourceArrayResponse.md → StoreSpecialDateResourceArrayResponse.md} +5 -5
- package/docs/StoreStoreRequest.md +54 -0
- package/docs/{AttachAttributesProductRangeRequestAttributesInner.md → StoreStoreRequestAddress.md} +18 -8
- package/docs/{AttachDocumentsProductRangeRequest.md → StoreStoreRequestSpecialDatesInner.md} +12 -6
- package/docs/StoreStoreSpecialDateRequest.md +40 -0
- package/docs/SupplierApi.md +138 -0
- package/docs/UpdateProductTypeRequest.md +4 -4
- package/docs/{UpdateProductRangeRequestAttributesInner.md → UpdateProductTypeRequestPerformanceValuesInner.md} +4 -4
- package/docs/UpdateStoreRequest.md +54 -0
- package/docs/{AttachAttributesProductRangeRequest.md → UpdateStoreRequestSpecialDatesInner.md} +14 -6
- package/package.json +1 -1
- package/src/apis/AttributeApi.ts +0 -50
- package/src/apis/StoreApi.ts +625 -0
- package/src/apis/SupplierApi.ts +112 -0
- package/src/apis/index.ts +1 -1
- package/src/models/AddressFrontendResource.ts +128 -0
- package/src/models/AddressFrontendResourceArrayResponse.ts +73 -0
- package/src/models/AddressResource.ts +136 -0
- package/src/models/AddressResourceArrayResponse.ts +73 -0
- package/src/models/AttachDocumentablesDocumentRequestDocumentablesInner.ts +1 -2
- package/src/models/AttachStoresSupplierRequest.ts +66 -0
- package/src/models/AttachSuppliersStoreRequest.ts +66 -0
- package/src/models/DetachDocumentablesDocumentRequestDocumentablesInner.ts +1 -2
- package/src/models/DetachStoresSupplierRequest.ts +66 -0
- package/src/models/DetachSuppliersStoreRequest.ts +66 -0
- package/src/models/GetAllDocumentRequest.ts +1 -2
- package/src/models/GetAllProductChildRequest.ts +0 -1
- package/src/models/GetAllStoreRequest.ts +144 -0
- package/src/models/IndexAttributeRequest.ts +1 -3
- package/src/models/IndexDocumentRequest.ts +1 -2
- package/src/models/IndexProductChildRequest.ts +0 -1
- package/src/models/IndexStoreRequest.ts +160 -0
- package/src/models/ModelAttributeResource.ts +0 -8
- package/src/models/PaginatedStoreListResourceResponse.ts +90 -0
- package/src/models/ProductSearchResultResource.ts +4 -4
- package/src/models/StoreAssetForAssetableRequest.ts +1 -3
- package/src/models/StoreFrontendResource.ts +162 -0
- package/src/models/StoreFrontendResourceArrayResponse.ts +73 -0
- package/src/models/StoreListResource.ts +144 -0
- package/src/models/StoreListResourceArrayResponse.ts +73 -0
- package/src/models/StoreLiteResource.ts +91 -0
- package/src/models/StoreLiteResourceArrayResponse.ts +73 -0
- package/src/models/StoreResource.ts +192 -0
- package/src/models/StoreResourceArrayResponse.ts +73 -0
- package/src/models/StoreSpecialDateFrontendResource.ts +101 -0
- package/src/models/StoreSpecialDateFrontendResourceArrayResponse.ts +73 -0
- package/src/models/StoreSpecialDateResource.ts +101 -0
- package/src/models/StoreSpecialDateResourceArrayResponse.ts +73 -0
- package/src/models/StoreStoreRequest.ts +167 -0
- package/src/models/StoreStoreRequestAddress.ts +119 -0
- package/src/models/StoreStoreRequestSpecialDatesInner.ts +90 -0
- package/src/models/StoreStoreSpecialDateRequest.ts +90 -0
- package/src/models/UpdateProductTypeRequest.ts +22 -22
- package/src/models/UpdateProductTypeRequestPerformanceValuesInner.ts +73 -0
- package/src/models/UpdateStoreRequest.ts +167 -0
- package/src/models/UpdateStoreRequestSpecialDatesInner.ts +97 -0
- package/src/models/index.ts +30 -35
- package/dist/apis/ProductRangeApi.d.ts +0 -269
- package/dist/apis/ProductRangeApi.js +0 -1043
- package/dist/models/AttachAccessoriesProductRangeRequest.d.ts +0 -32
- package/dist/models/AttachAccessoriesProductRangeRequest.js +0 -51
- package/dist/models/AttachAttributesProductRangeRequest.d.ts +0 -33
- package/dist/models/AttachAttributesProductRangeRequest.js +0 -52
- package/dist/models/AttachAttributesProductRangeRequestAttributesInner.d.ts +0 -38
- package/dist/models/AttachAttributesProductRangeRequestAttributesInner.js +0 -53
- package/dist/models/AttachDocumentsProductRangeRequest.d.ts +0 -33
- package/dist/models/AttachDocumentsProductRangeRequest.js +0 -52
- package/dist/models/DetachAccessoriesProductRangeRequest.d.ts +0 -32
- package/dist/models/DetachAccessoriesProductRangeRequest.js +0 -51
- package/dist/models/DetachAttributesProductRangeRequest.d.ts +0 -32
- package/dist/models/DetachAttributesProductRangeRequest.js +0 -51
- package/dist/models/DetachDocumentsProductRangeRequest.d.ts +0 -32
- package/dist/models/DetachDocumentsProductRangeRequest.js +0 -51
- package/dist/models/GetAllProductRangeRequest.d.ts +0 -98
- package/dist/models/GetAllProductRangeRequest.js +0 -82
- package/dist/models/IndexModelAttributeRequest.d.ts +0 -118
- package/dist/models/IndexModelAttributeRequest.js +0 -93
- package/dist/models/IndexProductRangeRequest.d.ts +0 -110
- package/dist/models/ModelAttributeListResource.d.ts +0 -64
- package/dist/models/ModelAttributeListResource.js +0 -71
- package/dist/models/ModelAttributeListResourceArrayResponse.d.ts +0 -33
- package/dist/models/ModelAttributeListResourceArrayResponse.js +0 -50
- package/dist/models/PaginatedModelAttributeListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedModelAttributeListResourceResponse.js +0 -57
- package/dist/models/PaginatedProductRangeFrontendListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedProductRangeFrontendListResourceResponse.js +0 -57
- package/dist/models/PaginatedProductRangeListResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedProductRangeListResourceResponse.js +0 -57
- package/dist/models/PaginatedProductRangeLiteResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedProductRangeLiteResourceResponse.js +0 -57
- package/dist/models/PaginatedProductRangeResourceResponse.d.ts +0 -40
- package/dist/models/PaginatedProductRangeResourceResponse.js +0 -57
- package/dist/models/ProductRangeFrontendListResource.d.ts +0 -62
- package/dist/models/ProductRangeFrontendListResource.js +0 -71
- package/dist/models/ProductRangeFrontendListResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductRangeFrontendListResourceArrayResponse.js +0 -50
- package/dist/models/ProductRangeFrontendResource.d.ts +0 -118
- package/dist/models/ProductRangeFrontendResource.js +0 -109
- package/dist/models/ProductRangeFrontendResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductRangeFrontendResourceArrayResponse.js +0 -50
- package/dist/models/ProductRangeListResource.d.ts +0 -66
- package/dist/models/ProductRangeListResource.js +0 -75
- package/dist/models/ProductRangeListResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductRangeListResourceArrayResponse.js +0 -50
- package/dist/models/ProductRangeLiteResource.d.ts +0 -38
- package/dist/models/ProductRangeLiteResource.js +0 -55
- package/dist/models/ProductRangeLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductRangeLiteResourceArrayResponse.js +0 -50
- package/dist/models/ProductRangeResource.d.ts +0 -89
- package/dist/models/ProductRangeResource.js +0 -86
- package/dist/models/ProductRangeResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductRangeResourceArrayResponse.js +0 -50
- package/dist/models/ProductRangeSiteDetailLiteResource.d.ts +0 -44
- package/dist/models/ProductRangeSiteDetailLiteResource.js +0 -59
- package/dist/models/ProductRangeSiteDetailLiteResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductRangeSiteDetailLiteResourceArrayResponse.js +0 -50
- package/dist/models/ProductRangeSiteDetailResource.d.ts +0 -101
- package/dist/models/ProductRangeSiteDetailResource.js +0 -98
- package/dist/models/ProductRangeSiteDetailResourceArrayResponse.d.ts +0 -33
- package/dist/models/ProductRangeSiteDetailResourceArrayResponse.js +0 -50
- package/dist/models/StoreProductRangeRequest.d.ts +0 -52
- package/dist/models/StoreProductRangeRequest.js +0 -59
- package/dist/models/StoreProductRangeRequestSitesInner.d.ts +0 -92
- package/dist/models/StoreProductRangeRequestSitesInner.js +0 -75
- package/dist/models/UpdateProductRangeRequest.d.ts +0 -59
- package/dist/models/UpdateProductRangeRequest.js +0 -62
- package/dist/models/UpdateProductRangeRequestAttributesInner.d.ts +0 -38
- package/dist/models/UpdateProductRangeRequestAttributesInner.js +0 -51
- package/docs/IndexProductRangeRequest.md +0 -54
- package/docs/ModelAttributeListResource.md +0 -44
- package/docs/ModelAttributeListResourceArrayResponse.md +0 -34
- package/docs/PaginatedModelAttributeListResourceResponse.md +0 -36
- package/docs/PaginatedProductRangeFrontendListResourceResponse.md +0 -36
- package/docs/PaginatedProductRangeListResourceResponse.md +0 -36
- package/docs/PaginatedProductRangeLiteResourceResponse.md +0 -36
- package/docs/ProductRangeApi.md +0 -1097
- package/docs/ProductRangeFrontendResource.md +0 -62
- package/docs/ProductRangeFrontendResourceArrayResponse.md +0 -34
- package/docs/ProductRangeListResource.md +0 -44
- package/docs/ProductRangeListResourceArrayResponse.md +0 -34
- package/docs/ProductRangeResource.md +0 -52
- package/docs/ProductRangeSiteDetailLiteResourceArrayResponse.md +0 -34
- package/docs/ProductRangeSiteDetailResource.md +0 -56
- package/docs/ProductRangeSiteDetailResourceArrayResponse.md +0 -34
- package/docs/StoreProductRangeRequestSitesInner.md +0 -54
- package/docs/UpdateProductRangeRequest.md +0 -42
- package/src/apis/ProductRangeApi.ts +0 -888
- package/src/models/AttachAccessoriesProductRangeRequest.ts +0 -66
- package/src/models/AttachAttributesProductRangeRequest.ts +0 -74
- package/src/models/AttachAttributesProductRangeRequestAttributesInner.ts +0 -74
- package/src/models/AttachDocumentsProductRangeRequest.ts +0 -74
- package/src/models/DetachAccessoriesProductRangeRequest.ts +0 -66
- package/src/models/DetachAttributesProductRangeRequest.ts +0 -66
- package/src/models/DetachDocumentsProductRangeRequest.ts +0 -66
- package/src/models/GetAllProductRangeRequest.ts +0 -151
- package/src/models/IndexModelAttributeRequest.ts +0 -176
- package/src/models/IndexProductRangeRequest.ts +0 -167
- package/src/models/ModelAttributeListResource.ts +0 -125
- package/src/models/ModelAttributeListResourceArrayResponse.ts +0 -73
- package/src/models/PaginatedModelAttributeListResourceResponse.ts +0 -90
- package/src/models/PaginatedProductRangeFrontendListResourceResponse.ts +0 -90
- package/src/models/PaginatedProductRangeListResourceResponse.ts +0 -90
- package/src/models/PaginatedProductRangeLiteResourceResponse.ts +0 -90
- package/src/models/PaginatedProductRangeResourceResponse.ts +0 -90
- package/src/models/ProductRangeFrontendListResource.ts +0 -111
- package/src/models/ProductRangeFrontendListResourceArrayResponse.ts +0 -73
- package/src/models/ProductRangeFrontendResource.ts +0 -207
- package/src/models/ProductRangeFrontendResourceArrayResponse.ts +0 -73
- package/src/models/ProductRangeListResource.ts +0 -140
- package/src/models/ProductRangeListResourceArrayResponse.ts +0 -73
- package/src/models/ProductRangeLiteResource.ts +0 -75
- package/src/models/ProductRangeLiteResourceArrayResponse.ts +0 -73
- package/src/models/ProductRangeResource.ts +0 -167
- package/src/models/ProductRangeResourceArrayResponse.ts +0 -73
- package/src/models/ProductRangeSiteDetailLiteResource.ts +0 -84
- package/src/models/ProductRangeSiteDetailLiteResourceArrayResponse.ts +0 -73
- package/src/models/ProductRangeSiteDetailResource.ts +0 -187
- package/src/models/ProductRangeSiteDetailResourceArrayResponse.ts +0 -73
- package/src/models/StoreProductRangeRequest.ts +0 -105
- package/src/models/StoreProductRangeRequestSitesInner.ts +0 -148
- package/src/models/UpdateProductRangeRequest.ts +0 -120
- package/src/models/UpdateProductRangeRequestAttributesInner.ts +0 -73
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
|
|
2
|
+
# AddressResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`company` | string
|
|
11
|
+
`line1` | string
|
|
12
|
+
`line2` | string
|
|
13
|
+
`postcode` | string
|
|
14
|
+
`suburb` | string
|
|
15
|
+
`country` | string
|
|
16
|
+
`state` | string
|
|
17
|
+
`fullAddress` | string
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { AddressResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"id": null,
|
|
27
|
+
"company": null,
|
|
28
|
+
"line1": null,
|
|
29
|
+
"line2": null,
|
|
30
|
+
"postcode": null,
|
|
31
|
+
"suburb": null,
|
|
32
|
+
"country": null,
|
|
33
|
+
"state": null,
|
|
34
|
+
"fullAddress": null,
|
|
35
|
+
} satisfies AddressResource
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as AddressResource
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
49
|
+
|
|
50
|
+
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AddressResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<AddressResource>](AddressResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { AddressResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
18
|
"data": null,
|
|
19
|
-
} satisfies
|
|
19
|
+
} satisfies AddressResourceArrayResponse
|
|
20
20
|
|
|
21
21
|
console.log(example)
|
|
22
22
|
|
|
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
25
|
console.log(exampleJSON)
|
|
26
26
|
|
|
27
27
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as AddressResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AttachStoresSupplierRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
9
|
+
`storeIds` | Array<number>
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { AttachStoresSupplierRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
|
-
"
|
|
19
|
-
} satisfies
|
|
18
|
+
"storeIds": null,
|
|
19
|
+
} satisfies AttachStoresSupplierRequest
|
|
20
20
|
|
|
21
21
|
console.log(example)
|
|
22
22
|
|
|
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
25
|
console.log(exampleJSON)
|
|
26
26
|
|
|
27
27
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as AttachStoresSupplierRequest
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# AttachSuppliersStoreRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`supplierIds` | Array<number>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { AttachSuppliersStoreRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"supplierIds": null,
|
|
19
|
+
} satisfies AttachSuppliersStoreRequest
|
|
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 AttachSuppliersStoreRequest
|
|
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/AttributeApi.md
CHANGED
|
@@ -12,7 +12,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
12
12
|
| [**getAllAttributeValue**](AttributeApi.md#getallattributevalueoperation) | **POST** /admin-api/attribute/value/all | Auto-generated: getAllAttributeValue |
|
|
13
13
|
| [**indexAttribute**](AttributeApi.md#indexattributeoperation) | **POST** /admin-api/attribute/list | Auto-generated: indexAttribute |
|
|
14
14
|
| [**indexAttributeValue**](AttributeApi.md#indexattributevalueoperation) | **POST** /admin-api/attribute/value/list | Auto-generated: indexAttributeValue |
|
|
15
|
-
| [**indexModelAttribute**](AttributeApi.md#indexmodelattributeoperation) | **POST** /admin-api/attribute/model-attribute/list | Auto-generated: indexModelAttribute |
|
|
16
15
|
| [**showAttribute**](AttributeApi.md#showattribute) | **GET** /admin-api/attribute/{attribute} | Auto-generated: showAttribute |
|
|
17
16
|
| [**storeAttribute**](AttributeApi.md#storeattributeoperation) | **POST** /admin-api/attribute/create | Auto-generated: storeAttribute |
|
|
18
17
|
| [**storeAttributeValue**](AttributeApi.md#storeattributevalueoperation) | **POST** /admin-api/attribute/value/create | Auto-generated: storeAttributeValue |
|
|
@@ -553,71 +552,6 @@ No authorization required
|
|
|
553
552
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
554
553
|
|
|
555
554
|
|
|
556
|
-
## indexModelAttribute
|
|
557
|
-
|
|
558
|
-
> PaginatedModelAttributeListResourceResponse indexModelAttribute(indexModelAttributeRequest)
|
|
559
|
-
|
|
560
|
-
Auto-generated: indexModelAttribute
|
|
561
|
-
|
|
562
|
-
### Example
|
|
563
|
-
|
|
564
|
-
```ts
|
|
565
|
-
import {
|
|
566
|
-
Configuration,
|
|
567
|
-
AttributeApi,
|
|
568
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
569
|
-
import type { IndexModelAttributeOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
570
|
-
|
|
571
|
-
async function example() {
|
|
572
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
573
|
-
const api = new AttributeApi();
|
|
574
|
-
|
|
575
|
-
const body = {
|
|
576
|
-
// IndexModelAttributeRequest (optional)
|
|
577
|
-
indexModelAttributeRequest: ...,
|
|
578
|
-
} satisfies IndexModelAttributeOperationRequest;
|
|
579
|
-
|
|
580
|
-
try {
|
|
581
|
-
const data = await api.indexModelAttribute(body);
|
|
582
|
-
console.log(data);
|
|
583
|
-
} catch (error) {
|
|
584
|
-
console.error(error);
|
|
585
|
-
}
|
|
586
|
-
}
|
|
587
|
-
|
|
588
|
-
// Run the test
|
|
589
|
-
example().catch(console.error);
|
|
590
|
-
```
|
|
591
|
-
|
|
592
|
-
### Parameters
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
| Name | Type | Description | Notes |
|
|
596
|
-
|------------- | ------------- | ------------- | -------------|
|
|
597
|
-
| **indexModelAttributeRequest** | [IndexModelAttributeRequest](IndexModelAttributeRequest.md) | | [Optional] |
|
|
598
|
-
|
|
599
|
-
### Return type
|
|
600
|
-
|
|
601
|
-
[**PaginatedModelAttributeListResourceResponse**](PaginatedModelAttributeListResourceResponse.md)
|
|
602
|
-
|
|
603
|
-
### Authorization
|
|
604
|
-
|
|
605
|
-
No authorization required
|
|
606
|
-
|
|
607
|
-
### HTTP request headers
|
|
608
|
-
|
|
609
|
-
- **Content-Type**: `application/json`
|
|
610
|
-
- **Accept**: `application/json`
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
### HTTP response details
|
|
614
|
-
| Status code | Description | Response headers |
|
|
615
|
-
|-------------|-------------|------------------|
|
|
616
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\ModelAttributeListResource[]>> | - |
|
|
617
|
-
|
|
618
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
619
|
-
|
|
620
|
-
|
|
621
555
|
## showAttribute
|
|
622
556
|
|
|
623
557
|
> AttributeResource showAttribute(attribute)
|
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# DetachStoresSupplierRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`
|
|
9
|
+
`storeIds` | Array<number>
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { DetachStoresSupplierRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
|
-
"
|
|
19
|
-
} satisfies
|
|
18
|
+
"storeIds": null,
|
|
19
|
+
} satisfies DetachStoresSupplierRequest
|
|
20
20
|
|
|
21
21
|
console.log(example)
|
|
22
22
|
|
|
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
25
25
|
console.log(exampleJSON)
|
|
26
26
|
|
|
27
27
|
// Parse the JSON string back to an object
|
|
28
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as DetachStoresSupplierRequest
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# DetachSuppliersStoreRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`supplierIds` | Array<number>
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { DetachSuppliersStoreRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"supplierIds": null,
|
|
19
|
+
} satisfies DetachSuppliersStoreRequest
|
|
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 DetachSuppliersStoreRequest
|
|
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
|
+
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# GetAllStoreRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -12,14 +12,13 @@ Name | Type
|
|
|
12
12
|
`relatedId` | number
|
|
13
13
|
`relatedType` | string
|
|
14
14
|
`includesRelations` | boolean
|
|
15
|
-
`
|
|
16
|
-
`
|
|
17
|
-
`siteDetailsCategoriesId` | Array<string>
|
|
15
|
+
`siteId` | Array<string>
|
|
16
|
+
`suppliersId` | Array<string>
|
|
18
17
|
|
|
19
18
|
## Example
|
|
20
19
|
|
|
21
20
|
```typescript
|
|
22
|
-
import type {
|
|
21
|
+
import type { GetAllStoreRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
23
22
|
|
|
24
23
|
// TODO: Update the object below with actual values
|
|
25
24
|
const example = {
|
|
@@ -29,10 +28,9 @@ const example = {
|
|
|
29
28
|
"relatedId": null,
|
|
30
29
|
"relatedType": null,
|
|
31
30
|
"includesRelations": null,
|
|
32
|
-
"
|
|
33
|
-
"
|
|
34
|
-
|
|
35
|
-
} satisfies GetAllProductRangeRequest
|
|
31
|
+
"siteId": null,
|
|
32
|
+
"suppliersId": null,
|
|
33
|
+
} satisfies GetAllStoreRequest
|
|
36
34
|
|
|
37
35
|
console.log(example)
|
|
38
36
|
|
|
@@ -41,7 +39,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
41
39
|
console.log(exampleJSON)
|
|
42
40
|
|
|
43
41
|
// Parse the JSON string back to an object
|
|
44
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
42
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetAllStoreRequest
|
|
45
43
|
console.log(exampleParsed)
|
|
46
44
|
```
|
|
47
45
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# IndexStoreRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -11,9 +11,8 @@ Name | Type
|
|
|
11
11
|
`sortDirection` | string
|
|
12
12
|
`perPage` | number
|
|
13
13
|
`page` | number
|
|
14
|
-
`
|
|
15
|
-
`
|
|
16
|
-
`attributeId` | Array<string>
|
|
14
|
+
`siteId` | Array<string>
|
|
15
|
+
`suppliersId` | Array<string>
|
|
17
16
|
`relatedId` | number
|
|
18
17
|
`relatedType` | string
|
|
19
18
|
`includesRelations` | boolean
|
|
@@ -21,7 +20,7 @@ Name | Type
|
|
|
21
20
|
## Example
|
|
22
21
|
|
|
23
22
|
```typescript
|
|
24
|
-
import type {
|
|
23
|
+
import type { IndexStoreRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
25
24
|
|
|
26
25
|
// TODO: Update the object below with actual values
|
|
27
26
|
const example = {
|
|
@@ -30,13 +29,12 @@ const example = {
|
|
|
30
29
|
"sortDirection": null,
|
|
31
30
|
"perPage": null,
|
|
32
31
|
"page": null,
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
"attributeId": null,
|
|
32
|
+
"siteId": null,
|
|
33
|
+
"suppliersId": null,
|
|
36
34
|
"relatedId": null,
|
|
37
35
|
"relatedType": null,
|
|
38
36
|
"includesRelations": null,
|
|
39
|
-
} satisfies
|
|
37
|
+
} satisfies IndexStoreRequest
|
|
40
38
|
|
|
41
39
|
console.log(example)
|
|
42
40
|
|
|
@@ -45,7 +43,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
45
43
|
console.log(exampleJSON)
|
|
46
44
|
|
|
47
45
|
// Parse the JSON string back to an object
|
|
48
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
46
|
+
const exampleParsed = JSON.parse(exampleJSON) as IndexStoreRequest
|
|
49
47
|
console.log(exampleParsed)
|
|
50
48
|
```
|
|
51
49
|
|
|
@@ -7,7 +7,6 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`order` | string
|
|
11
10
|
`value` | string
|
|
12
11
|
`attribute` | [AttributeLiteResource](AttributeLiteResource.md)
|
|
13
12
|
`attributeValues` | [Array<AttributeValueResource>](AttributeValueResource.md)
|
|
@@ -20,7 +19,6 @@ import type { ModelAttributeResource } from '@digital8/lighting-illusions-ts-sdk
|
|
|
20
19
|
// TODO: Update the object below with actual values
|
|
21
20
|
const example = {
|
|
22
21
|
"id": null,
|
|
23
|
-
"order": null,
|
|
24
22
|
"value": null,
|
|
25
23
|
"attribute": null,
|
|
26
24
|
"attributeValues": null,
|
package/docs/{PaginatedProductRangeResourceResponse.md → PaginatedStoreListResourceResponse.md}
RENAMED
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# PaginatedStoreListResourceResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<StoreListResource>](StoreListResource.md)
|
|
10
10
|
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import type {
|
|
15
|
+
import type { PaginatedStoreListResourceResponse } 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
|
|
21
|
+
} satisfies PaginatedStoreListResourceResponse
|
|
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
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedStoreListResourceResponse
|
|
31
31
|
console.log(exampleParsed)
|
|
32
32
|
```
|
|
33
33
|
|
|
@@ -15,7 +15,7 @@ Name | Type
|
|
|
15
15
|
`salePrice` | number
|
|
16
16
|
`thumbnail` | string
|
|
17
17
|
`averageRating` | string
|
|
18
|
-
`
|
|
18
|
+
`label` | Array<number>
|
|
19
19
|
`supplierName` | string
|
|
20
20
|
`supplierLogo` | string
|
|
21
21
|
`supplierId` | number
|
|
@@ -40,7 +40,7 @@ const example = {
|
|
|
40
40
|
"salePrice": null,
|
|
41
41
|
"thumbnail": null,
|
|
42
42
|
"averageRating": null,
|
|
43
|
-
"
|
|
43
|
+
"label": null,
|
|
44
44
|
"supplierName": null,
|
|
45
45
|
"supplierLogo": null,
|
|
46
46
|
"supplierId": null,
|