@digital8/lighting-illusions-ts-sdk 0.0.1395 → 0.0.1397
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 +56 -0
- package/README.md +41 -2
- package/dist/apis/StoreApi.d.ts +173 -0
- package/dist/apis/StoreApi.js +679 -0
- package/dist/apis/SupplierApi.d.ts +33 -1
- package/dist/apis/SupplierApi.js +122 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/models/AddressFrontendResource.d.ts +74 -0
- package/dist/models/AddressFrontendResource.js +79 -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/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/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/ExternalApiLogResource.d.ts +1 -1
- package/dist/models/ExternalApiLogResource.js +1 -3
- package/dist/models/GetAllStoreRequest.d.ts +93 -0
- package/dist/models/GetAllStoreRequest.js +81 -0
- package/dist/models/IndexStoreRequest.d.ts +105 -0
- package/dist/models/IndexStoreRequest.js +85 -0
- 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 -1
- package/dist/models/StoreAssetForAssetableRequest.js +1 -2
- 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 +78 -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 +100 -0
- package/dist/models/StoreResource.js +93 -0
- package/dist/models/StoreResourceArrayResponse.d.ts +33 -0
- package/dist/models/StoreResourceArrayResponse.js +50 -0
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +68 -0
- package/dist/models/StoreSpecialDateFrontendResource.js +73 -0
- package/dist/models/StoreSpecialDateFrontendResourceArrayResponse.d.ts +33 -0
- package/dist/models/StoreSpecialDateFrontendResourceArrayResponse.js +50 -0
- package/dist/models/StoreSpecialDateResource.d.ts +68 -0
- package/dist/models/StoreSpecialDateResource.js +73 -0
- package/dist/models/StoreSpecialDateResourceArrayResponse.d.ts +33 -0
- package/dist/models/StoreSpecialDateResourceArrayResponse.js +50 -0
- package/dist/models/StoreStoreRequest.d.ts +177 -0
- package/dist/models/StoreStoreRequest.js +124 -0
- package/dist/models/StoreStoreRequestSpecialDatesInner.d.ts +62 -0
- package/dist/models/StoreStoreRequestSpecialDatesInner.js +61 -0
- package/dist/models/StoreStoreSpecialDateRequest.d.ts +62 -0
- package/dist/models/StoreStoreSpecialDateRequest.js +61 -0
- package/dist/models/UpdateStoreRequest.d.ts +164 -0
- package/dist/models/UpdateStoreRequest.js +119 -0
- package/dist/models/index.d.ts +27 -0
- package/dist/models/index.js +27 -0
- package/docs/AddressFrontendResource.md +48 -0
- package/docs/AddressFrontendResourceArrayResponse.md +34 -0
- package/docs/AddressResource.md +50 -0
- package/docs/AddressResourceArrayResponse.md +34 -0
- package/docs/AttachStoresSupplierRequest.md +34 -0
- package/docs/AttachSuppliersStoreRequest.md +34 -0
- package/docs/DetachStoresSupplierRequest.md +34 -0
- package/docs/DetachSuppliersStoreRequest.md +34 -0
- package/docs/GetAllStoreRequest.md +48 -0
- package/docs/IndexStoreRequest.md +52 -0
- package/docs/PaginatedStoreListResourceResponse.md +36 -0
- package/docs/ProductSearchResultResource.md +2 -2
- package/docs/StoreApi.md +683 -0
- package/docs/StoreFrontendResource.md +56 -0
- package/docs/StoreFrontendResourceArrayResponse.md +34 -0
- package/docs/StoreListResource.md +50 -0
- package/docs/StoreListResourceArrayResponse.md +34 -0
- package/docs/StoreLiteResource.md +38 -0
- package/docs/StoreLiteResourceArrayResponse.md +34 -0
- package/docs/StoreResource.md +56 -0
- package/docs/StoreResourceArrayResponse.md +34 -0
- package/docs/StoreSpecialDateFrontendResource.md +46 -0
- package/docs/StoreSpecialDateFrontendResourceArrayResponse.md +34 -0
- package/docs/StoreSpecialDateResource.md +46 -0
- package/docs/StoreSpecialDateResourceArrayResponse.md +34 -0
- package/docs/StoreStoreRequest.md +82 -0
- package/docs/StoreStoreRequestSpecialDatesInner.md +44 -0
- package/docs/StoreStoreSpecialDateRequest.md +44 -0
- package/docs/SupplierApi.md +138 -0
- package/docs/UpdateStoreRequest.md +78 -0
- package/package.json +1 -1
- package/src/apis/StoreApi.ts +563 -0
- package/src/apis/SupplierApi.ts +112 -0
- package/src/apis/index.ts +1 -0
- package/src/models/AddressFrontendResource.ts +129 -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/AttachStoresSupplierRequest.ts +66 -0
- package/src/models/AttachSuppliersStoreRequest.ts +66 -0
- package/src/models/DetachStoresSupplierRequest.ts +66 -0
- package/src/models/DetachSuppliersStoreRequest.ts +66 -0
- package/src/models/ExternalApiLogResource.ts +2 -3
- package/src/models/GetAllStoreRequest.ts +144 -0
- package/src/models/IndexStoreRequest.ts +160 -0
- package/src/models/PaginatedStoreListResourceResponse.ts +90 -0
- package/src/models/ProductSearchResultResource.ts +4 -4
- package/src/models/StoreAssetForAssetableRequest.ts +1 -2
- package/src/models/StoreFrontendResource.ts +162 -0
- package/src/models/StoreFrontendResourceArrayResponse.ts +73 -0
- package/src/models/StoreListResource.ts +143 -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 +178 -0
- package/src/models/StoreResourceArrayResponse.ts +73 -0
- package/src/models/StoreSpecialDateFrontendResource.ts +119 -0
- package/src/models/StoreSpecialDateFrontendResourceArrayResponse.ts +73 -0
- package/src/models/StoreSpecialDateResource.ts +119 -0
- package/src/models/StoreSpecialDateResourceArrayResponse.ts +73 -0
- package/src/models/StoreStoreRequest.ts +278 -0
- package/src/models/StoreStoreRequestSpecialDatesInner.ts +106 -0
- package/src/models/StoreStoreSpecialDateRequest.ts +106 -0
- package/src/models/UpdateStoreRequest.ts +254 -0
- package/src/models/index.ts +27 -0
package/docs/SupplierApi.md
CHANGED
|
@@ -4,7 +4,9 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
| [**attachStoresSupplier**](SupplierApi.md#attachstoressupplieroperation) | **POST** /admin-api/supplier/{supplier}/attach-stores | Auto-generated: attachStoresSupplier |
|
|
7
8
|
| [**destroySupplier**](SupplierApi.md#destroysupplier) | **DELETE** /admin-api/supplier/{supplier}/delete | Auto-generated: destroySupplier |
|
|
9
|
+
| [**detachStoresSupplier**](SupplierApi.md#detachstoressupplieroperation) | **POST** /admin-api/supplier/{supplier}/detach-stores | Auto-generated: detachStoresSupplier |
|
|
8
10
|
| [**exportSupplier**](SupplierApi.md#exportsupplier) | **POST** /admin-api/supplier/export | Auto-generated: exportSupplier |
|
|
9
11
|
| [**getAllSupplier**](SupplierApi.md#getallsupplieroperation) | **POST** /admin-api/supplier/all | Auto-generated: getAllSupplier |
|
|
10
12
|
| [**importSupplier**](SupplierApi.md#importsupplier) | **POST** /admin-api/supplier/import | Auto-generated: importSupplier |
|
|
@@ -15,6 +17,74 @@ All URIs are relative to *http://localhost/api*
|
|
|
15
17
|
|
|
16
18
|
|
|
17
19
|
|
|
20
|
+
## attachStoresSupplier
|
|
21
|
+
|
|
22
|
+
> SupplierResource attachStoresSupplier(supplier, attachStoresSupplierRequest)
|
|
23
|
+
|
|
24
|
+
Auto-generated: attachStoresSupplier
|
|
25
|
+
|
|
26
|
+
### Example
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
import {
|
|
30
|
+
Configuration,
|
|
31
|
+
SupplierApi,
|
|
32
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
33
|
+
import type { AttachStoresSupplierOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
34
|
+
|
|
35
|
+
async function example() {
|
|
36
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
37
|
+
const api = new SupplierApi();
|
|
38
|
+
|
|
39
|
+
const body = {
|
|
40
|
+
// number | The id of the supplier
|
|
41
|
+
supplier: 56,
|
|
42
|
+
// AttachStoresSupplierRequest (optional)
|
|
43
|
+
attachStoresSupplierRequest: ...,
|
|
44
|
+
} satisfies AttachStoresSupplierOperationRequest;
|
|
45
|
+
|
|
46
|
+
try {
|
|
47
|
+
const data = await api.attachStoresSupplier(body);
|
|
48
|
+
console.log(data);
|
|
49
|
+
} catch (error) {
|
|
50
|
+
console.error(error);
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
// Run the test
|
|
55
|
+
example().catch(console.error);
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Parameters
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
| Name | Type | Description | Notes |
|
|
62
|
+
|------------- | ------------- | ------------- | -------------|
|
|
63
|
+
| **supplier** | `number` | The id of the supplier | [Defaults to `undefined`] |
|
|
64
|
+
| **attachStoresSupplierRequest** | [AttachStoresSupplierRequest](AttachStoresSupplierRequest.md) | | [Optional] |
|
|
65
|
+
|
|
66
|
+
### Return type
|
|
67
|
+
|
|
68
|
+
[**SupplierResource**](SupplierResource.md)
|
|
69
|
+
|
|
70
|
+
### Authorization
|
|
71
|
+
|
|
72
|
+
No authorization required
|
|
73
|
+
|
|
74
|
+
### HTTP request headers
|
|
75
|
+
|
|
76
|
+
- **Content-Type**: `application/json`
|
|
77
|
+
- **Accept**: `application/json`
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
### HTTP response details
|
|
81
|
+
| Status code | Description | Response headers |
|
|
82
|
+
|-------------|-------------|------------------|
|
|
83
|
+
| **200** | Successful resource response | - |
|
|
84
|
+
|
|
85
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
86
|
+
|
|
87
|
+
|
|
18
88
|
## destroySupplier
|
|
19
89
|
|
|
20
90
|
> GenericResponse destroySupplier(supplier)
|
|
@@ -80,6 +150,74 @@ No authorization required
|
|
|
80
150
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
81
151
|
|
|
82
152
|
|
|
153
|
+
## detachStoresSupplier
|
|
154
|
+
|
|
155
|
+
> SupplierResource detachStoresSupplier(supplier, detachStoresSupplierRequest)
|
|
156
|
+
|
|
157
|
+
Auto-generated: detachStoresSupplier
|
|
158
|
+
|
|
159
|
+
### Example
|
|
160
|
+
|
|
161
|
+
```ts
|
|
162
|
+
import {
|
|
163
|
+
Configuration,
|
|
164
|
+
SupplierApi,
|
|
165
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
166
|
+
import type { DetachStoresSupplierOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
167
|
+
|
|
168
|
+
async function example() {
|
|
169
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
170
|
+
const api = new SupplierApi();
|
|
171
|
+
|
|
172
|
+
const body = {
|
|
173
|
+
// number | The id of the supplier
|
|
174
|
+
supplier: 56,
|
|
175
|
+
// DetachStoresSupplierRequest (optional)
|
|
176
|
+
detachStoresSupplierRequest: ...,
|
|
177
|
+
} satisfies DetachStoresSupplierOperationRequest;
|
|
178
|
+
|
|
179
|
+
try {
|
|
180
|
+
const data = await api.detachStoresSupplier(body);
|
|
181
|
+
console.log(data);
|
|
182
|
+
} catch (error) {
|
|
183
|
+
console.error(error);
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
// Run the test
|
|
188
|
+
example().catch(console.error);
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
### Parameters
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
| Name | Type | Description | Notes |
|
|
195
|
+
|------------- | ------------- | ------------- | -------------|
|
|
196
|
+
| **supplier** | `number` | The id of the supplier | [Defaults to `undefined`] |
|
|
197
|
+
| **detachStoresSupplierRequest** | [DetachStoresSupplierRequest](DetachStoresSupplierRequest.md) | | [Optional] |
|
|
198
|
+
|
|
199
|
+
### Return type
|
|
200
|
+
|
|
201
|
+
[**SupplierResource**](SupplierResource.md)
|
|
202
|
+
|
|
203
|
+
### Authorization
|
|
204
|
+
|
|
205
|
+
No authorization required
|
|
206
|
+
|
|
207
|
+
### HTTP request headers
|
|
208
|
+
|
|
209
|
+
- **Content-Type**: `application/json`
|
|
210
|
+
- **Accept**: `application/json`
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
### HTTP response details
|
|
214
|
+
| Status code | Description | Response headers |
|
|
215
|
+
|-------------|-------------|------------------|
|
|
216
|
+
| **200** | Successful resource response | - |
|
|
217
|
+
|
|
218
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
219
|
+
|
|
220
|
+
|
|
83
221
|
## exportSupplier
|
|
84
222
|
|
|
85
223
|
> Blob exportSupplier(indexSupplierRequest)
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
|
|
2
|
+
# UpdateStoreRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`siteId` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`phone` | string
|
|
12
|
+
`longitude` | number
|
|
13
|
+
`latitude` | number
|
|
14
|
+
`tagLine` | string
|
|
15
|
+
`email` | string
|
|
16
|
+
`openingHours` | Array<string>
|
|
17
|
+
`openingHours0` | string
|
|
18
|
+
`openingHours1` | string
|
|
19
|
+
`openingHours2` | string
|
|
20
|
+
`openingHours3` | string
|
|
21
|
+
`openingHours4` | string
|
|
22
|
+
`openingHours5` | string
|
|
23
|
+
`openingHours6` | string
|
|
24
|
+
`address` | Array<string>
|
|
25
|
+
`addressCompany` | string
|
|
26
|
+
`addressLine1` | string
|
|
27
|
+
`addressLine2` | string
|
|
28
|
+
`addressPostcode` | string
|
|
29
|
+
`addressSuburb` | string
|
|
30
|
+
`addressCountry` | string
|
|
31
|
+
`addressState` | string
|
|
32
|
+
|
|
33
|
+
## Example
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
import type { UpdateStoreRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
37
|
+
|
|
38
|
+
// TODO: Update the object below with actual values
|
|
39
|
+
const example = {
|
|
40
|
+
"siteId": null,
|
|
41
|
+
"name": null,
|
|
42
|
+
"phone": null,
|
|
43
|
+
"longitude": null,
|
|
44
|
+
"latitude": null,
|
|
45
|
+
"tagLine": null,
|
|
46
|
+
"email": null,
|
|
47
|
+
"openingHours": null,
|
|
48
|
+
"openingHours0": null,
|
|
49
|
+
"openingHours1": null,
|
|
50
|
+
"openingHours2": null,
|
|
51
|
+
"openingHours3": null,
|
|
52
|
+
"openingHours4": null,
|
|
53
|
+
"openingHours5": null,
|
|
54
|
+
"openingHours6": null,
|
|
55
|
+
"address": null,
|
|
56
|
+
"addressCompany": null,
|
|
57
|
+
"addressLine1": null,
|
|
58
|
+
"addressLine2": null,
|
|
59
|
+
"addressPostcode": null,
|
|
60
|
+
"addressSuburb": null,
|
|
61
|
+
"addressCountry": null,
|
|
62
|
+
"addressState": null,
|
|
63
|
+
} satisfies UpdateStoreRequest
|
|
64
|
+
|
|
65
|
+
console.log(example)
|
|
66
|
+
|
|
67
|
+
// Convert the instance to a JSON string
|
|
68
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
69
|
+
console.log(exampleJSON)
|
|
70
|
+
|
|
71
|
+
// Parse the JSON string back to an object
|
|
72
|
+
const exampleParsed = JSON.parse(exampleJSON) as UpdateStoreRequest
|
|
73
|
+
console.log(exampleParsed)
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
77
|
+
|
|
78
|
+
|