@digital8/lighting-illusions-ts-sdk 0.0.1697 → 0.0.1699
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 +34 -6
- package/README.md +26 -7
- package/dist/apis/ReviewApi.d.ts +139 -0
- package/dist/apis/ReviewApi.js +566 -0
- package/dist/apis/StoreApi.d.ts +1 -28
- package/dist/apis/StoreApi.js +0 -113
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/models/AddressResource.d.ts +2 -2
- package/dist/models/AddressResource.js +4 -4
- package/dist/models/AdminUserLiteResource.d.ts +50 -0
- package/dist/models/AdminUserLiteResource.js +61 -0
- package/dist/models/AdminUserLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/AdminUserLiteResourceArrayResponse.js +50 -0
- package/dist/models/CustomerLiteResource.d.ts +50 -0
- package/dist/models/CustomerLiteResource.js +61 -0
- package/dist/models/CustomerLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/CustomerLiteResourceArrayResponse.js +50 -0
- package/dist/models/IndexReviewRequest.d.ts +110 -0
- package/dist/models/IndexReviewRequest.js +86 -0
- package/dist/models/PaginatedReviewListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedReviewListResourceResponse.js +57 -0
- package/dist/models/PaginatedReviewLiteResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedReviewLiteResourceResponse.js +57 -0
- package/dist/models/PaginatedReviewResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedReviewResourceResponse.js +57 -0
- package/dist/models/ReviewListResource.d.ts +88 -0
- package/dist/models/ReviewListResource.js +83 -0
- package/dist/models/ReviewListResourceArrayResponse.d.ts +33 -0
- package/dist/models/ReviewListResourceArrayResponse.js +50 -0
- package/dist/models/ReviewLiteResource.d.ts +44 -0
- package/dist/models/ReviewLiteResource.js +59 -0
- package/dist/models/ReviewLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/ReviewLiteResourceArrayResponse.js +50 -0
- package/dist/models/ReviewResource.d.ts +120 -0
- package/dist/models/ReviewResource.js +103 -0
- package/dist/models/ReviewResourceArrayResponse.d.ts +33 -0
- package/dist/models/ReviewResourceArrayResponse.js +50 -0
- package/dist/models/StoreFrontendResource.d.ts +1 -1
- package/dist/models/StoreFrontendResource.js +3 -1
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +3 -1
- package/dist/models/StoreResource.d.ts +1 -13
- package/dist/models/StoreResource.js +1 -7
- package/dist/models/StoreReviewRequest.d.ts +74 -0
- package/dist/models/StoreReviewRequest.js +71 -0
- package/dist/models/StoreSpecialDateResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateResource.js +3 -1
- package/dist/models/StoreStoreRequest.d.ts +0 -12
- package/dist/models/StoreStoreRequest.js +0 -4
- package/dist/models/UpdateReviewRequest.d.ts +62 -0
- package/dist/models/UpdateReviewRequest.js +63 -0
- package/dist/models/UpdateStoreRequest.d.ts +0 -12
- package/dist/models/UpdateStoreRequest.js +0 -4
- package/dist/models/index.d.ts +16 -3
- package/dist/models/index.js +16 -3
- package/docs/{SaveMapStoreStockMigrationRequestAssociationsInner.md → AdminUserLiteResource.md} +12 -10
- package/docs/AdminUserLiteResourceArrayResponse.md +34 -0
- package/docs/CustomerLiteResource.md +40 -0
- package/docs/{SaveMapStoreStockMigrationRequest.md → CustomerLiteResourceArrayResponse.md} +6 -6
- package/docs/IndexReviewRequest.md +54 -0
- package/docs/PaginatedReviewListResourceResponse.md +36 -0
- package/docs/PaginatedReviewLiteResourceResponse.md +36 -0
- package/docs/PaginatedReviewResourceResponse.md +36 -0
- package/docs/ReviewApi.md +539 -0
- package/docs/ReviewListResource.md +52 -0
- package/docs/ReviewListResourceArrayResponse.md +34 -0
- package/docs/ReviewLiteResource.md +38 -0
- package/docs/ReviewLiteResourceArrayResponse.md +34 -0
- package/docs/ReviewResource.md +62 -0
- package/docs/{StoreStockType.md → ReviewResourceArrayResponse.md} +6 -4
- package/docs/StoreApi.md +0 -124
- package/docs/StoreResource.md +0 -4
- package/docs/StoreReviewRequest.md +48 -0
- package/docs/StoreSpecialDateResource.md +1 -1
- package/docs/StoreStoreRequest.md +0 -4
- package/docs/UpdateReviewRequest.md +44 -0
- package/docs/UpdateStoreRequest.md +0 -4
- package/package.json +1 -1
- package/src/apis/ReviewApi.ts +444 -0
- package/src/apis/StoreApi.ts +0 -84
- package/src/apis/index.ts +1 -0
- package/src/models/AddressResource.ts +5 -5
- package/src/models/AdminUserLiteResource.ts +92 -0
- package/src/models/AdminUserLiteResourceArrayResponse.ts +73 -0
- package/src/models/CustomerLiteResource.ts +92 -0
- package/src/models/CustomerLiteResourceArrayResponse.ts +73 -0
- package/src/models/IndexReviewRequest.ts +167 -0
- package/src/models/PaginatedReviewListResourceResponse.ts +90 -0
- package/src/models/PaginatedReviewLiteResourceResponse.ts +90 -0
- package/src/models/PaginatedReviewResourceResponse.ts +90 -0
- package/src/models/ReviewListResource.ts +159 -0
- package/src/models/ReviewListResourceArrayResponse.ts +73 -0
- package/src/models/ReviewLiteResource.ts +84 -0
- package/src/models/ReviewLiteResourceArrayResponse.ts +73 -0
- package/src/models/ReviewResource.ts +217 -0
- package/src/models/ReviewResourceArrayResponse.ts +73 -0
- package/src/models/StoreFrontendResource.ts +3 -2
- package/src/models/StoreListResource.ts +3 -2
- package/src/models/StoreResource.ts +2 -19
- package/src/models/StoreReviewRequest.ts +125 -0
- package/src/models/StoreSpecialDateResource.ts +4 -3
- package/src/models/StoreStoreRequest.ts +0 -16
- package/src/models/UpdateReviewRequest.ts +107 -0
- package/src/models/UpdateStoreRequest.ts +0 -16
- package/src/models/index.ts +16 -3
- package/dist/models/SaveMapStoreStockMigrationRequest.d.ts +0 -33
- package/dist/models/SaveMapStoreStockMigrationRequest.js +0 -52
- package/dist/models/SaveMapStoreStockMigrationRequestAssociationsInner.d.ts +0 -52
- package/dist/models/SaveMapStoreStockMigrationRequestAssociationsInner.js +0 -67
- package/dist/models/StoreStockType.d.ts +0 -25
- package/dist/models/StoreStockType.js +0 -51
- package/src/models/SaveMapStoreStockMigrationRequest.ts +0 -74
- package/src/models/SaveMapStoreStockMigrationRequestAssociationsInner.ts +0 -95
- package/src/models/StoreStockType.ts +0 -53
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
|
|
2
|
+
# ReviewListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`reviewerName` | string
|
|
11
|
+
`rating` | number
|
|
12
|
+
`comment` | string
|
|
13
|
+
`replyFromAdmin` | string
|
|
14
|
+
`createdByAdmin` | boolean
|
|
15
|
+
`approvedAt` | Date
|
|
16
|
+
`createdAt` | Date
|
|
17
|
+
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
18
|
+
`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import type { ReviewListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
24
|
+
|
|
25
|
+
// TODO: Update the object below with actual values
|
|
26
|
+
const example = {
|
|
27
|
+
"id": null,
|
|
28
|
+
"reviewerName": null,
|
|
29
|
+
"rating": null,
|
|
30
|
+
"comment": null,
|
|
31
|
+
"replyFromAdmin": null,
|
|
32
|
+
"createdByAdmin": null,
|
|
33
|
+
"approvedAt": null,
|
|
34
|
+
"createdAt": null,
|
|
35
|
+
"site": null,
|
|
36
|
+
"productChild": null,
|
|
37
|
+
} satisfies ReviewListResource
|
|
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 ReviewListResource
|
|
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
|
+
# ReviewListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ReviewListResource>](ReviewListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ReviewListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ReviewListResourceArrayResponse
|
|
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 ReviewListResourceArrayResponse
|
|
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,38 @@
|
|
|
1
|
+
|
|
2
|
+
# ReviewLiteResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`reviewerName` | string
|
|
11
|
+
`rating` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ReviewLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"id": null,
|
|
21
|
+
"reviewerName": null,
|
|
22
|
+
"rating": null,
|
|
23
|
+
} satisfies ReviewLiteResource
|
|
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 ReviewLiteResource
|
|
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
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# ReviewLiteResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ReviewLiteResource>](ReviewLiteResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ReviewLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ReviewLiteResourceArrayResponse
|
|
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 ReviewLiteResourceArrayResponse
|
|
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,62 @@
|
|
|
1
|
+
|
|
2
|
+
# ReviewResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`reviewerName` | string
|
|
11
|
+
`rating` | number
|
|
12
|
+
`comment` | string
|
|
13
|
+
`replyFromAdmin` | string
|
|
14
|
+
`location` | string
|
|
15
|
+
`createdByAdmin` | boolean
|
|
16
|
+
`approvedAt` | Date
|
|
17
|
+
`createdAt` | Date
|
|
18
|
+
`updatedAt` | Date
|
|
19
|
+
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
20
|
+
`productChild` | [ProductChildLiteResource](ProductChildLiteResource.md)
|
|
21
|
+
`customer` | [CustomerLiteResource](CustomerLiteResource.md)
|
|
22
|
+
`admin` | [AdminUserLiteResource](AdminUserLiteResource.md)
|
|
23
|
+
`approver` | [AdminUserLiteResource](AdminUserLiteResource.md)
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import type { ReviewResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
29
|
+
|
|
30
|
+
// TODO: Update the object below with actual values
|
|
31
|
+
const example = {
|
|
32
|
+
"id": null,
|
|
33
|
+
"reviewerName": null,
|
|
34
|
+
"rating": null,
|
|
35
|
+
"comment": null,
|
|
36
|
+
"replyFromAdmin": null,
|
|
37
|
+
"location": null,
|
|
38
|
+
"createdByAdmin": null,
|
|
39
|
+
"approvedAt": null,
|
|
40
|
+
"createdAt": null,
|
|
41
|
+
"updatedAt": null,
|
|
42
|
+
"site": null,
|
|
43
|
+
"productChild": null,
|
|
44
|
+
"customer": null,
|
|
45
|
+
"admin": null,
|
|
46
|
+
"approver": null,
|
|
47
|
+
} satisfies ReviewResource
|
|
48
|
+
|
|
49
|
+
console.log(example)
|
|
50
|
+
|
|
51
|
+
// Convert the instance to a JSON string
|
|
52
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
53
|
+
console.log(exampleJSON)
|
|
54
|
+
|
|
55
|
+
// Parse the JSON string back to an object
|
|
56
|
+
const exampleParsed = JSON.parse(exampleJSON) as ReviewResource
|
|
57
|
+
console.log(exampleParsed)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
61
|
+
|
|
62
|
+
|
|
@@ -1,20 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# ReviewResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`data` | [Array<ReviewResource>](ReviewResource.md)
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
12
13
|
```typescript
|
|
13
|
-
import type {
|
|
14
|
+
import type { ReviewResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
14
15
|
|
|
15
16
|
// TODO: Update the object below with actual values
|
|
16
17
|
const example = {
|
|
17
|
-
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ReviewResourceArrayResponse
|
|
18
20
|
|
|
19
21
|
console.log(example)
|
|
20
22
|
|
|
@@ -23,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
23
25
|
console.log(exampleJSON)
|
|
24
26
|
|
|
25
27
|
// Parse the JSON string back to an object
|
|
26
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as ReviewResourceArrayResponse
|
|
27
29
|
console.log(exampleParsed)
|
|
28
30
|
```
|
|
29
31
|
|
package/docs/StoreApi.md
CHANGED
|
@@ -10,8 +10,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
10
10
|
| [**detachSuppliersStore**](StoreApi.md#detachsuppliersstoreoperation) | **POST** /admin-api/store/{store}/detach-suppliers | Auto-generated: detachSuppliersStore |
|
|
11
11
|
| [**getAllStore**](StoreApi.md#getallstoreoperation) | **POST** /admin-api/store/all | Auto-generated: getAllStore |
|
|
12
12
|
| [**indexStore**](StoreApi.md#indexstoreoperation) | **POST** /admin-api/store/list | Auto-generated: indexStore |
|
|
13
|
-
| [**optionsStoreStockMigration**](StoreApi.md#optionsstorestockmigration) | **GET** /admin-api/store/stock-migration/options | Auto-generated: optionsStoreStockMigration |
|
|
14
|
-
| [**saveMapStoreStockMigration**](StoreApi.md#savemapstorestockmigrationoperation) | **POST** /admin-api/store/stock-migration/save-map | Auto-generated: saveMapStoreStockMigration |
|
|
15
13
|
| [**showStore**](StoreApi.md#showstore) | **GET** /admin-api/store/{store} | Auto-generated: showStore |
|
|
16
14
|
| [**storeStore**](StoreApi.md#storestoreoperation) | **POST** /admin-api/store/create | Auto-generated: storeStore |
|
|
17
15
|
| [**storeStoreSpecialDate**](StoreApi.md#storestorespecialdateoperation) | **POST** /admin-api/store/{store}/special-dates | Auto-generated: storeStoreSpecialDate |
|
|
@@ -419,128 +417,6 @@ No authorization required
|
|
|
419
417
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
420
418
|
|
|
421
419
|
|
|
422
|
-
## optionsStoreStockMigration
|
|
423
|
-
|
|
424
|
-
> GenericResponse optionsStoreStockMigration()
|
|
425
|
-
|
|
426
|
-
Auto-generated: optionsStoreStockMigration
|
|
427
|
-
|
|
428
|
-
### Example
|
|
429
|
-
|
|
430
|
-
```ts
|
|
431
|
-
import {
|
|
432
|
-
Configuration,
|
|
433
|
-
StoreApi,
|
|
434
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
435
|
-
import type { OptionsStoreStockMigrationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
436
|
-
|
|
437
|
-
async function example() {
|
|
438
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
439
|
-
const api = new StoreApi();
|
|
440
|
-
|
|
441
|
-
try {
|
|
442
|
-
const data = await api.optionsStoreStockMigration();
|
|
443
|
-
console.log(data);
|
|
444
|
-
} catch (error) {
|
|
445
|
-
console.error(error);
|
|
446
|
-
}
|
|
447
|
-
}
|
|
448
|
-
|
|
449
|
-
// Run the test
|
|
450
|
-
example().catch(console.error);
|
|
451
|
-
```
|
|
452
|
-
|
|
453
|
-
### Parameters
|
|
454
|
-
|
|
455
|
-
This endpoint does not need any parameter.
|
|
456
|
-
|
|
457
|
-
### Return type
|
|
458
|
-
|
|
459
|
-
[**GenericResponse**](GenericResponse.md)
|
|
460
|
-
|
|
461
|
-
### Authorization
|
|
462
|
-
|
|
463
|
-
No authorization required
|
|
464
|
-
|
|
465
|
-
### HTTP request headers
|
|
466
|
-
|
|
467
|
-
- **Content-Type**: Not defined
|
|
468
|
-
- **Accept**: `application/json`
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
### HTTP response details
|
|
472
|
-
| Status code | Description | Response headers |
|
|
473
|
-
|-------------|-------------|------------------|
|
|
474
|
-
| **200** | \\JsonResponse<array{locations: array<int,array{id: int, name: string, isPrimary: bool}>, stores: array<int,array{id: int, name: string}>, existingMap: array<string,array{store_id: int, type: string}>, existingMapFilePath: string|null}> | - |
|
|
475
|
-
|
|
476
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
## saveMapStoreStockMigration
|
|
480
|
-
|
|
481
|
-
> GenericResponse saveMapStoreStockMigration(saveMapStoreStockMigrationRequest)
|
|
482
|
-
|
|
483
|
-
Auto-generated: saveMapStoreStockMigration
|
|
484
|
-
|
|
485
|
-
### Example
|
|
486
|
-
|
|
487
|
-
```ts
|
|
488
|
-
import {
|
|
489
|
-
Configuration,
|
|
490
|
-
StoreApi,
|
|
491
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
492
|
-
import type { SaveMapStoreStockMigrationOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
493
|
-
|
|
494
|
-
async function example() {
|
|
495
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
496
|
-
const api = new StoreApi();
|
|
497
|
-
|
|
498
|
-
const body = {
|
|
499
|
-
// SaveMapStoreStockMigrationRequest (optional)
|
|
500
|
-
saveMapStoreStockMigrationRequest: ...,
|
|
501
|
-
} satisfies SaveMapStoreStockMigrationOperationRequest;
|
|
502
|
-
|
|
503
|
-
try {
|
|
504
|
-
const data = await api.saveMapStoreStockMigration(body);
|
|
505
|
-
console.log(data);
|
|
506
|
-
} catch (error) {
|
|
507
|
-
console.error(error);
|
|
508
|
-
}
|
|
509
|
-
}
|
|
510
|
-
|
|
511
|
-
// Run the test
|
|
512
|
-
example().catch(console.error);
|
|
513
|
-
```
|
|
514
|
-
|
|
515
|
-
### Parameters
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
| Name | Type | Description | Notes |
|
|
519
|
-
|------------- | ------------- | ------------- | -------------|
|
|
520
|
-
| **saveMapStoreStockMigrationRequest** | [SaveMapStoreStockMigrationRequest](SaveMapStoreStockMigrationRequest.md) | | [Optional] |
|
|
521
|
-
|
|
522
|
-
### Return type
|
|
523
|
-
|
|
524
|
-
[**GenericResponse**](GenericResponse.md)
|
|
525
|
-
|
|
526
|
-
### Authorization
|
|
527
|
-
|
|
528
|
-
No authorization required
|
|
529
|
-
|
|
530
|
-
### HTTP request headers
|
|
531
|
-
|
|
532
|
-
- **Content-Type**: `application/json`
|
|
533
|
-
- **Accept**: `application/json`
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
### HTTP response details
|
|
537
|
-
| Status code | Description | Response headers |
|
|
538
|
-
|-------------|-------------|------------------|
|
|
539
|
-
| **200** | \\JsonResponse<array{message: string, filePath: string, command: string}> | - |
|
|
540
|
-
|
|
541
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
542
|
-
|
|
543
|
-
|
|
544
420
|
## showStore
|
|
545
421
|
|
|
546
422
|
> StoreResource showStore(store)
|
package/docs/StoreResource.md
CHANGED
|
@@ -15,8 +15,6 @@ Name | Type
|
|
|
15
15
|
`tagLine` | string
|
|
16
16
|
`email` | string
|
|
17
17
|
`website` | string
|
|
18
|
-
`netsuiteId` | number
|
|
19
|
-
`displayNetsuiteId` | number
|
|
20
18
|
`openingHours` | string
|
|
21
19
|
`suppliers` | [Array<SupplierLiteResource>](SupplierLiteResource.md)
|
|
22
20
|
`address` | [AddressResource](AddressResource.md)
|
|
@@ -38,8 +36,6 @@ const example = {
|
|
|
38
36
|
"tagLine": null,
|
|
39
37
|
"email": null,
|
|
40
38
|
"website": null,
|
|
41
|
-
"netsuiteId": null,
|
|
42
|
-
"displayNetsuiteId": null,
|
|
43
39
|
"openingHours": null,
|
|
44
40
|
"suppliers": null,
|
|
45
41
|
"address": null,
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
|
|
2
|
+
# StoreReviewRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`productChildId` | number
|
|
10
|
+
`siteId` | number
|
|
11
|
+
`customerId` | number
|
|
12
|
+
`invoiceItemId` | number
|
|
13
|
+
`reviewerName` | string
|
|
14
|
+
`rating` | number
|
|
15
|
+
`comment` | string
|
|
16
|
+
`location` | string
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import type { StoreReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
22
|
+
|
|
23
|
+
// TODO: Update the object below with actual values
|
|
24
|
+
const example = {
|
|
25
|
+
"productChildId": null,
|
|
26
|
+
"siteId": null,
|
|
27
|
+
"customerId": null,
|
|
28
|
+
"invoiceItemId": null,
|
|
29
|
+
"reviewerName": null,
|
|
30
|
+
"rating": null,
|
|
31
|
+
"comment": null,
|
|
32
|
+
"location": null,
|
|
33
|
+
} satisfies StoreReviewRequest
|
|
34
|
+
|
|
35
|
+
console.log(example)
|
|
36
|
+
|
|
37
|
+
// Convert the instance to a JSON string
|
|
38
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
39
|
+
console.log(exampleJSON)
|
|
40
|
+
|
|
41
|
+
// Parse the JSON string back to an object
|
|
42
|
+
const exampleParsed = JSON.parse(exampleJSON) as StoreReviewRequest
|
|
43
|
+
console.log(exampleParsed)
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
47
|
+
|
|
48
|
+
|
|
@@ -15,8 +15,6 @@ Name | Type
|
|
|
15
15
|
`email` | string
|
|
16
16
|
`website` | string
|
|
17
17
|
`openingHours` | Array<string | null>
|
|
18
|
-
`netsuiteId` | number
|
|
19
|
-
`displayNetsuiteId` | number
|
|
20
18
|
`supplierIds` | Array<number>
|
|
21
19
|
`specialDates` | [Array<StoreStoreRequestSpecialDatesInner>](StoreStoreRequestSpecialDatesInner.md)
|
|
22
20
|
`address` | [StoreStoreRequestAddress](StoreStoreRequestAddress.md)
|
|
@@ -37,8 +35,6 @@ const example = {
|
|
|
37
35
|
"email": null,
|
|
38
36
|
"website": null,
|
|
39
37
|
"openingHours": null,
|
|
40
|
-
"netsuiteId": null,
|
|
41
|
-
"displayNetsuiteId": null,
|
|
42
38
|
"supplierIds": null,
|
|
43
39
|
"specialDates": null,
|
|
44
40
|
"address": null,
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
# UpdateReviewRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`reviewerName` | string
|
|
10
|
+
`rating` | number
|
|
11
|
+
`comment` | string
|
|
12
|
+
`replyFromAdmin` | string
|
|
13
|
+
`location` | string
|
|
14
|
+
`approved` | boolean
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { UpdateReviewRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"reviewerName": null,
|
|
24
|
+
"rating": null,
|
|
25
|
+
"comment": null,
|
|
26
|
+
"replyFromAdmin": null,
|
|
27
|
+
"location": null,
|
|
28
|
+
"approved": null,
|
|
29
|
+
} satisfies UpdateReviewRequest
|
|
30
|
+
|
|
31
|
+
console.log(example)
|
|
32
|
+
|
|
33
|
+
// Convert the instance to a JSON string
|
|
34
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
35
|
+
console.log(exampleJSON)
|
|
36
|
+
|
|
37
|
+
// Parse the JSON string back to an object
|
|
38
|
+
const exampleParsed = JSON.parse(exampleJSON) as UpdateReviewRequest
|
|
39
|
+
console.log(exampleParsed)
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
43
|
+
|
|
44
|
+
|
|
@@ -15,8 +15,6 @@ Name | Type
|
|
|
15
15
|
`email` | string
|
|
16
16
|
`website` | string
|
|
17
17
|
`openingHours` | Array<string | null>
|
|
18
|
-
`netsuiteId` | number
|
|
19
|
-
`displayNetsuiteId` | number
|
|
20
18
|
`supplierIds` | Array<number>
|
|
21
19
|
`specialDates` | [Array<UpdateStoreRequestSpecialDatesInner>](UpdateStoreRequestSpecialDatesInner.md)
|
|
22
20
|
`address` | [StoreStoreRequestAddress](StoreStoreRequestAddress.md)
|
|
@@ -37,8 +35,6 @@ const example = {
|
|
|
37
35
|
"email": null,
|
|
38
36
|
"website": null,
|
|
39
37
|
"openingHours": null,
|
|
40
|
-
"netsuiteId": null,
|
|
41
|
-
"displayNetsuiteId": null,
|
|
42
38
|
"supplierIds": null,
|
|
43
39
|
"specialDates": null,
|
|
44
40
|
"address": null,
|