@digital8/lighting-illusions-ts-sdk 0.0.2349 → 0.0.2351
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 +14 -4
- package/README.md +9 -4
- package/dist/apis/ProductClassApi.d.ts +34 -0
- package/dist/apis/ProductClassApi.js +139 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/models/AddressFrontendResource.d.ts +1 -1
- package/dist/models/AddressFrontendResource.js +3 -1
- package/dist/models/AddressResource.d.ts +1 -1
- package/dist/models/AddressResource.js +3 -1
- package/dist/models/AdminOrderResource.d.ts +2 -3
- package/dist/models/AdminOrderResource.js +2 -3
- package/dist/models/AppliedCouponResource.d.ts +50 -0
- package/dist/models/{CartCouponResource.js → AppliedCouponResource.js} +13 -13
- package/dist/models/AppliedCouponResourceArrayResponse.d.ts +33 -0
- package/dist/models/AppliedCouponResourceArrayResponse.js +50 -0
- package/dist/models/CartListResource.d.ts +6 -0
- package/dist/models/CartListResource.js +4 -0
- package/dist/models/CategoryAutomationFieldType.d.ts +2 -0
- package/dist/models/CategoryAutomationFieldType.js +3 -1
- package/dist/models/CreatePageComponentRequest.d.ts +4 -4
- package/dist/models/CreatePageComponentRequest.js +4 -4
- package/dist/models/CreateProductCategoryRequestAutomationRulesInner.d.ts +2 -0
- package/dist/models/CreateProductCategoryRequestAutomationRulesInner.js +3 -1
- package/dist/models/CreateSupplierRequest.d.ts +6 -0
- package/dist/models/CreateSupplierRequest.js +2 -0
- package/dist/models/FrontendCartResource.d.ts +18 -0
- package/dist/models/FrontendCartResource.js +12 -0
- package/dist/models/FrontendOrderResource.d.ts +3 -3
- package/dist/models/FrontendOrderResource.js +3 -3
- package/dist/models/OrderFulfillmentResource.d.ts +3 -3
- package/dist/models/OrderFulfillmentResource.js +4 -6
- package/dist/models/OrderStatusWithCountResource.d.ts +12 -0
- package/dist/models/OrderStatusWithCountResource.js +8 -0
- package/dist/models/PaginatedProductClassLiteResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedProductClassLiteResourceResponse.js +57 -0
- package/dist/models/ProductClassLiteResource.d.ts +44 -0
- package/dist/models/ProductClassLiteResource.js +57 -0
- package/dist/models/ProductClassLiteResourceArrayResponse.d.ts +33 -0
- package/dist/models/ProductClassLiteResourceArrayResponse.js +50 -0
- package/dist/models/ProductClassResource.d.ts +2 -2
- package/dist/models/SearchAllOrdersRequest.d.ts +6 -0
- package/dist/models/SearchAllOrdersRequest.js +2 -0
- package/dist/models/SearchAllProductClassesRequest.d.ts +78 -0
- package/dist/models/SearchAllProductClassesRequest.js +74 -0
- package/dist/models/SearchOrdersRequest.d.ts +6 -0
- package/dist/models/SearchOrdersRequest.js +2 -0
- package/dist/models/StoreFrontendResource.d.ts +1 -1
- package/dist/models/StoreFrontendResource.js +3 -1
- package/dist/models/StoreResource.d.ts +2 -2
- package/dist/models/StoreResource.js +6 -2
- package/dist/models/SupplierFrontendResource.d.ts +6 -0
- package/dist/models/SupplierFrontendResource.js +4 -0
- package/dist/models/SupplierResource.d.ts +6 -0
- package/dist/models/SupplierResource.js +4 -0
- package/dist/models/UpdatePageComponentRequest.d.ts +4 -4
- package/dist/models/UpdatePageComponentRequest.js +4 -4
- package/dist/models/UpdateSupplierRequest.d.ts +6 -0
- package/dist/models/UpdateSupplierRequest.js +2 -0
- package/dist/models/index.d.ts +6 -2
- package/dist/models/index.js +6 -2
- package/docs/AdminOrderResource.md +1 -1
- package/docs/{CartCouponResource.md → AppliedCouponResource.md} +4 -4
- package/docs/{CartCouponResourceArrayResponse.md → AppliedCouponResourceArrayResponse.md} +5 -5
- package/docs/CartListResource.md +2 -0
- package/docs/CreatePageComponentRequest.md +2 -2
- package/docs/CreateSupplierRequest.md +2 -0
- package/docs/FrontendCartResource.md +6 -0
- package/docs/FrontendOrderResource.md +1 -1
- package/docs/OrderStatusWithCountResource.md +4 -0
- package/docs/PaginatedProductClassLiteResourceResponse.md +36 -0
- package/docs/ProductClassApi.md +74 -0
- package/docs/ProductClassLiteResource.md +38 -0
- package/docs/ProductClassLiteResourceArrayResponse.md +34 -0
- package/docs/ProductClassResource.md +1 -1
- package/docs/SearchAllOrdersRequest.md +2 -0
- package/docs/SearchAllProductClassesRequest.md +44 -0
- package/docs/SearchOrdersRequest.md +2 -0
- package/docs/SupplierFrontendResource.md +2 -0
- package/docs/SupplierResource.md +2 -0
- package/docs/UpdatePageComponentRequest.md +2 -2
- package/docs/UpdateSupplierRequest.md +2 -0
- package/package.json +1 -1
- package/src/apis/ProductClassApi.ts +76 -0
- package/src/apis/index.ts +1 -0
- package/src/models/AddressFrontendResource.ts +3 -2
- package/src/models/AddressResource.ts +3 -2
- package/src/models/AdminOrderResource.ts +4 -11
- package/src/models/{CartCouponResource.ts → AppliedCouponResource.ts} +14 -14
- package/src/models/AppliedCouponResourceArrayResponse.ts +73 -0
- package/src/models/CartListResource.ts +9 -0
- package/src/models/CategoryAutomationFieldType.ts +3 -1
- package/src/models/CreatePageComponentRequest.ts +8 -8
- package/src/models/CreateProductCategoryRequestAutomationRulesInner.ts +3 -1
- package/src/models/CreateSupplierRequest.ts +8 -0
- package/src/models/FrontendCartResource.ts +27 -0
- package/src/models/FrontendOrderResource.ts +11 -11
- package/src/models/OrderFulfillmentResource.ts +7 -8
- package/src/models/OrderStatusWithCountResource.ts +18 -0
- package/src/models/PaginatedProductClassLiteResourceResponse.ts +90 -0
- package/src/models/ProductClassLiteResource.ts +83 -0
- package/src/models/ProductClassLiteResourceArrayResponse.ts +73 -0
- package/src/models/ProductClassResource.ts +2 -2
- package/src/models/SearchAllOrdersRequest.ts +8 -0
- package/src/models/SearchAllProductClassesRequest.ts +125 -0
- package/src/models/SearchOrdersRequest.ts +8 -0
- package/src/models/StoreFrontendResource.ts +3 -2
- package/src/models/StoreResource.ts +6 -4
- package/src/models/SupplierFrontendResource.ts +9 -0
- package/src/models/SupplierResource.ts +9 -0
- package/src/models/UpdatePageComponentRequest.ts +8 -8
- package/src/models/UpdateSupplierRequest.ts +8 -0
- package/src/models/index.ts +6 -2
- package/dist/models/CartCouponResource.d.ts +0 -50
- package/dist/models/CartCouponResourceArrayResponse.d.ts +0 -33
- package/dist/models/CartCouponResourceArrayResponse.js +0 -50
- package/src/models/CartCouponResourceArrayResponse.ts +0 -73
|
@@ -1,22 +1,22 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AppliedCouponResourceArrayResponse
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
-
`data` | [Array<
|
|
9
|
+
`data` | [Array<AppliedCouponResource>](AppliedCouponResource.md)
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { AppliedCouponResourceArrayResponse } 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 AppliedCouponResourceArrayResponse
|
|
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 AppliedCouponResourceArrayResponse
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
package/docs/CartListResource.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`source` | string
|
|
12
12
|
`checkoutCompletedAt` | Date
|
|
13
13
|
`createdAt` | Date
|
|
14
|
+
`expiryDate` | Date
|
|
14
15
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
15
16
|
`customer` | [CustomerListResource](CustomerListResource.md)
|
|
16
17
|
`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
|
|
@@ -29,6 +30,7 @@ const example = {
|
|
|
29
30
|
"source": null,
|
|
30
31
|
"checkoutCompletedAt": null,
|
|
31
32
|
"createdAt": null,
|
|
33
|
+
"expiryDate": null,
|
|
32
34
|
"site": null,
|
|
33
35
|
"customer": null,
|
|
34
36
|
"lineItems": null,
|
|
@@ -11,8 +11,8 @@ Name | Type
|
|
|
11
11
|
`type` | string
|
|
12
12
|
`disabled` | boolean
|
|
13
13
|
`order` | number
|
|
14
|
-
`startDate` |
|
|
15
|
-
`endDate` |
|
|
14
|
+
`startDate` | string
|
|
15
|
+
`endDate` | string
|
|
16
16
|
`componentData` | object
|
|
17
17
|
`relations` | [Array<CreatePageComponentRequestRelationsInner>](CreatePageComponentRequestRelationsInner.md)
|
|
18
18
|
|
|
@@ -9,6 +9,7 @@ Name | Type
|
|
|
9
9
|
`name` | string
|
|
10
10
|
`slug` | string
|
|
11
11
|
`supplierEta` | number
|
|
12
|
+
`productEnquiriesOnly` | boolean
|
|
12
13
|
`seo` | [Array<CreateBlogCategoryRequestSeoInner>](CreateBlogCategoryRequestSeoInner.md)
|
|
13
14
|
`altText` | string
|
|
14
15
|
`mimeType` | string
|
|
@@ -27,6 +28,7 @@ const example = {
|
|
|
27
28
|
"name": null,
|
|
28
29
|
"slug": null,
|
|
29
30
|
"supplierEta": null,
|
|
31
|
+
"productEnquiriesOnly": null,
|
|
30
32
|
"seo": null,
|
|
31
33
|
"altText": null,
|
|
32
34
|
"mimeType": null,
|
|
@@ -18,11 +18,14 @@ Name | Type
|
|
|
18
18
|
`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
19
19
|
`coupons` | [Array<FrontendCartResourceCouponsInner>](FrontendCartResourceCouponsInner.md)
|
|
20
20
|
`subtotal` | number
|
|
21
|
+
`subtotalAfterDiscounts` | number
|
|
21
22
|
`promotionalDiscount` | number
|
|
22
23
|
`couponSubtotalDiscount` | number
|
|
23
24
|
`couponShippingDiscount` | number
|
|
24
25
|
`shipping` | number
|
|
25
26
|
`transitInsurance` | number
|
|
27
|
+
`deliveryShippingQuote` | number
|
|
28
|
+
`transitInsuranceQuote` | number
|
|
26
29
|
`gst` | number
|
|
27
30
|
`grandTotal` | number
|
|
28
31
|
|
|
@@ -45,11 +48,14 @@ const example = {
|
|
|
45
48
|
"lineItems": null,
|
|
46
49
|
"coupons": null,
|
|
47
50
|
"subtotal": null,
|
|
51
|
+
"subtotalAfterDiscounts": null,
|
|
48
52
|
"promotionalDiscount": null,
|
|
49
53
|
"couponSubtotalDiscount": null,
|
|
50
54
|
"couponShippingDiscount": null,
|
|
51
55
|
"shipping": null,
|
|
52
56
|
"transitInsurance": null,
|
|
57
|
+
"deliveryShippingQuote": null,
|
|
58
|
+
"transitInsuranceQuote": null,
|
|
53
59
|
"gst": null,
|
|
54
60
|
"grandTotal": null,
|
|
55
61
|
} satisfies FrontendCartResource
|
|
@@ -19,7 +19,7 @@ Name | Type
|
|
|
19
19
|
`shippingAddress` | [AddressResource](AddressResource.md)
|
|
20
20
|
`billingAddress` | [AddressResource](AddressResource.md)
|
|
21
21
|
`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
22
|
-
`coupons` | [Array<
|
|
22
|
+
`coupons` | [Array<FrontendCartResourceCouponsInner>](FrontendCartResourceCouponsInner.md)
|
|
23
23
|
`subtotal` | number
|
|
24
24
|
`promotionalDiscount` | number
|
|
25
25
|
`couponSubtotalDiscount` | number
|
|
@@ -8,6 +8,8 @@ Name | Type
|
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
10
|
`name` | string
|
|
11
|
+
`shortName` | string
|
|
12
|
+
`displayOrder` | number
|
|
11
13
|
`isOrderNetsuiteSyncable` | boolean
|
|
12
14
|
`ordersCount` | number
|
|
13
15
|
|
|
@@ -20,6 +22,8 @@ import type { OrderStatusWithCountResource } from '@digital8/lighting-illusions-
|
|
|
20
22
|
const example = {
|
|
21
23
|
"id": null,
|
|
22
24
|
"name": null,
|
|
25
|
+
"shortName": null,
|
|
26
|
+
"displayOrder": null,
|
|
23
27
|
"isOrderNetsuiteSyncable": null,
|
|
24
28
|
"ordersCount": null,
|
|
25
29
|
} satisfies OrderStatusWithCountResource
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedProductClassLiteResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ProductClassLiteResource>](ProductClassLiteResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedProductClassLiteResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"data": null,
|
|
20
|
+
"meta": null,
|
|
21
|
+
} satisfies PaginatedProductClassLiteResourceResponse
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as PaginatedProductClassLiteResourceResponse
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# ProductClassApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost/api*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**getAllProductClass**](ProductClassApi.md#getallproductclass) | **POST** /admin-api/product-class/all | Auto-generated: getAllProductClass |
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
## getAllProductClass
|
|
12
|
+
|
|
13
|
+
> ProductClassLiteResourceArrayResponse getAllProductClass(searchAllProductClassesRequest)
|
|
14
|
+
|
|
15
|
+
Auto-generated: getAllProductClass
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
import {
|
|
21
|
+
Configuration,
|
|
22
|
+
ProductClassApi,
|
|
23
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
24
|
+
import type { GetAllProductClassRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
25
|
+
|
|
26
|
+
async function example() {
|
|
27
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
28
|
+
const api = new ProductClassApi();
|
|
29
|
+
|
|
30
|
+
const body = {
|
|
31
|
+
// SearchAllProductClassesRequest (optional)
|
|
32
|
+
searchAllProductClassesRequest: ...,
|
|
33
|
+
} satisfies GetAllProductClassRequest;
|
|
34
|
+
|
|
35
|
+
try {
|
|
36
|
+
const data = await api.getAllProductClass(body);
|
|
37
|
+
console.log(data);
|
|
38
|
+
} catch (error) {
|
|
39
|
+
console.error(error);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
// Run the test
|
|
44
|
+
example().catch(console.error);
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
| Name | Type | Description | Notes |
|
|
51
|
+
|------------- | ------------- | ------------- | -------------|
|
|
52
|
+
| **searchAllProductClassesRequest** | [SearchAllProductClassesRequest](SearchAllProductClassesRequest.md) | | [Optional] |
|
|
53
|
+
|
|
54
|
+
### Return type
|
|
55
|
+
|
|
56
|
+
[**ProductClassLiteResourceArrayResponse**](ProductClassLiteResourceArrayResponse.md)
|
|
57
|
+
|
|
58
|
+
### Authorization
|
|
59
|
+
|
|
60
|
+
No authorization required
|
|
61
|
+
|
|
62
|
+
### HTTP request headers
|
|
63
|
+
|
|
64
|
+
- **Content-Type**: `application/json`
|
|
65
|
+
- **Accept**: `application/json`
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
### HTTP response details
|
|
69
|
+
| Status code | Description | Response headers |
|
|
70
|
+
|-------------|-------------|------------------|
|
|
71
|
+
| **200** | Successful resource response | - |
|
|
72
|
+
|
|
73
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
74
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# ProductClassLiteResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`name` | string
|
|
11
|
+
`pathString` | string
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ProductClassLiteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"id": null,
|
|
21
|
+
"name": null,
|
|
22
|
+
"pathString": null,
|
|
23
|
+
} satisfies ProductClassLiteResource
|
|
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 ProductClassLiteResource
|
|
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
|
+
# ProductClassLiteResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<ProductClassLiteResource>](ProductClassLiteResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { ProductClassLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies ProductClassLiteResourceArrayResponse
|
|
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 ProductClassLiteResourceArrayResponse
|
|
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
|
+
|
|
@@ -16,6 +16,7 @@ Name | Type
|
|
|
16
16
|
`source` | Array<string>
|
|
17
17
|
`statusId` | Array<string>
|
|
18
18
|
`customerId` | Array<string>
|
|
19
|
+
`lineItemsLabelId` | Array<string>
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -34,6 +35,7 @@ const example = {
|
|
|
34
35
|
"source": null,
|
|
35
36
|
"statusId": null,
|
|
36
37
|
"customerId": null,
|
|
38
|
+
"lineItemsLabelId": null,
|
|
37
39
|
} satisfies SearchAllOrdersRequest
|
|
38
40
|
|
|
39
41
|
console.log(example)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
|
|
2
|
+
# SearchAllProductClassesRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`search` | string
|
|
10
|
+
`sortBy` | string
|
|
11
|
+
`sortDirection` | string
|
|
12
|
+
`relatedId` | number
|
|
13
|
+
`relatedType` | string
|
|
14
|
+
`includesRelations` | boolean
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { SearchAllProductClassesRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"search": null,
|
|
24
|
+
"sortBy": null,
|
|
25
|
+
"sortDirection": null,
|
|
26
|
+
"relatedId": null,
|
|
27
|
+
"relatedType": null,
|
|
28
|
+
"includesRelations": null,
|
|
29
|
+
} satisfies SearchAllProductClassesRequest
|
|
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 SearchAllProductClassesRequest
|
|
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,6 +15,7 @@ Name | Type
|
|
|
15
15
|
`source` | Array<string>
|
|
16
16
|
`statusId` | Array<string>
|
|
17
17
|
`customerId` | Array<string>
|
|
18
|
+
`lineItemsLabelId` | Array<string>
|
|
18
19
|
`beforeCreatedAt` | Date
|
|
19
20
|
`afterCreatedAt` | Date
|
|
20
21
|
`beforePlacedAt` | Date
|
|
@@ -42,6 +43,7 @@ const example = {
|
|
|
42
43
|
"source": null,
|
|
43
44
|
"statusId": null,
|
|
44
45
|
"customerId": null,
|
|
46
|
+
"lineItemsLabelId": null,
|
|
45
47
|
"beforeCreatedAt": null,
|
|
46
48
|
"afterCreatedAt": null,
|
|
47
49
|
"beforePlacedAt": null,
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`slug` | string
|
|
12
12
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
|
+
`productEnquiriesOnly` | boolean
|
|
14
15
|
`seo` | object
|
|
15
16
|
`description` | [DescriptionResource](DescriptionResource.md)
|
|
16
17
|
|
|
@@ -26,6 +27,7 @@ const example = {
|
|
|
26
27
|
"slug": null,
|
|
27
28
|
"thumbnail": null,
|
|
28
29
|
"supplierEta": null,
|
|
30
|
+
"productEnquiriesOnly": null,
|
|
29
31
|
"seo": null,
|
|
30
32
|
"description": null,
|
|
31
33
|
} satisfies SupplierFrontendResource
|
package/docs/SupplierResource.md
CHANGED
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`slug` | string
|
|
12
12
|
`thumbnail` | [AssetResource](AssetResource.md)
|
|
13
13
|
`supplierEta` | number
|
|
14
|
+
`productEnquiriesOnly` | boolean
|
|
14
15
|
`seo` | [Array<SEOResource>](SEOResource.md)
|
|
15
16
|
`descriptions` | [Array<DescriptionResource>](DescriptionResource.md)
|
|
16
17
|
|
|
@@ -26,6 +27,7 @@ const example = {
|
|
|
26
27
|
"slug": null,
|
|
27
28
|
"thumbnail": null,
|
|
28
29
|
"supplierEta": null,
|
|
30
|
+
"productEnquiriesOnly": null,
|
|
29
31
|
"seo": null,
|
|
30
32
|
"descriptions": null,
|
|
31
33
|
} satisfies SupplierResource
|
|
@@ -9,8 +9,8 @@ Name | Type
|
|
|
9
9
|
`type` | string
|
|
10
10
|
`disabled` | boolean
|
|
11
11
|
`order` | number
|
|
12
|
-
`startDate` |
|
|
13
|
-
`endDate` |
|
|
12
|
+
`startDate` | string
|
|
13
|
+
`endDate` | string
|
|
14
14
|
`componentData` | object
|
|
15
15
|
`relations` | [Array<CreatePageComponentRequestRelationsInner>](CreatePageComponentRequestRelationsInner.md)
|
|
16
16
|
|
|
@@ -9,6 +9,7 @@ Name | Type
|
|
|
9
9
|
`name` | string
|
|
10
10
|
`slug` | string
|
|
11
11
|
`supplierEta` | number
|
|
12
|
+
`productEnquiriesOnly` | boolean
|
|
12
13
|
`seo` | [Array<CreateBlogCategoryRequestSeoInner>](CreateBlogCategoryRequestSeoInner.md)
|
|
13
14
|
`altText` | string
|
|
14
15
|
`mimeType` | string
|
|
@@ -27,6 +28,7 @@ const example = {
|
|
|
27
28
|
"name": null,
|
|
28
29
|
"slug": null,
|
|
29
30
|
"supplierEta": null,
|
|
31
|
+
"productEnquiriesOnly": null,
|
|
30
32
|
"seo": null,
|
|
31
33
|
"altText": null,
|
|
32
34
|
"mimeType": null,
|
package/package.json
CHANGED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* My API
|
|
5
|
+
* API documentation for my Laravel app
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import * as runtime from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
type ProductClassLiteResourceArrayResponse,
|
|
18
|
+
ProductClassLiteResourceArrayResponseFromJSON,
|
|
19
|
+
ProductClassLiteResourceArrayResponseToJSON,
|
|
20
|
+
} from '../models/ProductClassLiteResourceArrayResponse';
|
|
21
|
+
import {
|
|
22
|
+
type SearchAllProductClassesRequest,
|
|
23
|
+
SearchAllProductClassesRequestFromJSON,
|
|
24
|
+
SearchAllProductClassesRequestToJSON,
|
|
25
|
+
} from '../models/SearchAllProductClassesRequest';
|
|
26
|
+
|
|
27
|
+
export interface GetAllProductClassRequest {
|
|
28
|
+
searchAllProductClassesRequest?: SearchAllProductClassesRequest;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
*/
|
|
34
|
+
export class ProductClassApi extends runtime.BaseAPI {
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Creates request options for getAllProductClass without sending the request
|
|
38
|
+
*/
|
|
39
|
+
async getAllProductClassRequestOpts(requestParameters: GetAllProductClassRequest): Promise<runtime.RequestOpts> {
|
|
40
|
+
const queryParameters: any = {};
|
|
41
|
+
|
|
42
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
43
|
+
|
|
44
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
let urlPath = `/admin-api/product-class/all`;
|
|
48
|
+
|
|
49
|
+
return {
|
|
50
|
+
path: urlPath,
|
|
51
|
+
method: 'POST',
|
|
52
|
+
headers: headerParameters,
|
|
53
|
+
query: queryParameters,
|
|
54
|
+
body: SearchAllProductClassesRequestToJSON(requestParameters['searchAllProductClassesRequest']),
|
|
55
|
+
};
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Auto-generated: getAllProductClass
|
|
60
|
+
*/
|
|
61
|
+
async getAllProductClassRaw(requestParameters: GetAllProductClassRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductClassLiteResourceArrayResponse>> {
|
|
62
|
+
const requestOptions = await this.getAllProductClassRequestOpts(requestParameters);
|
|
63
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
64
|
+
|
|
65
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ProductClassLiteResourceArrayResponseFromJSON(jsonValue));
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Auto-generated: getAllProductClass
|
|
70
|
+
*/
|
|
71
|
+
async getAllProductClass(requestParameters: GetAllProductClassRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductClassLiteResourceArrayResponse> {
|
|
72
|
+
const response = await this.getAllProductClassRaw(requestParameters, initOverrides);
|
|
73
|
+
return await response.value();
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
}
|
package/src/apis/index.ts
CHANGED
|
@@ -21,6 +21,7 @@ export * from './PageApi';
|
|
|
21
21
|
export * from './PageComponentApi';
|
|
22
22
|
export * from './ProductApi';
|
|
23
23
|
export * from './ProductCategoryApi';
|
|
24
|
+
export * from './ProductClassApi';
|
|
24
25
|
export * from './ProductRangeApi';
|
|
25
26
|
export * from './ProductRegistrationApi';
|
|
26
27
|
export * from './ProductTypeApi';
|
|
@@ -24,7 +24,7 @@ export interface AddressFrontendResource {
|
|
|
24
24
|
* @type {string}
|
|
25
25
|
* @memberof AddressFrontendResource
|
|
26
26
|
*/
|
|
27
|
-
company
|
|
27
|
+
company: string;
|
|
28
28
|
/**
|
|
29
29
|
*
|
|
30
30
|
* @type {string}
|
|
@@ -73,6 +73,7 @@ export interface AddressFrontendResource {
|
|
|
73
73
|
* Check if a given object implements the AddressFrontendResource interface.
|
|
74
74
|
*/
|
|
75
75
|
export function instanceOfAddressFrontendResource(value: object): value is AddressFrontendResource {
|
|
76
|
+
if (!('company' in value) || value['company'] === undefined) return false;
|
|
76
77
|
if (!('line1' in value) || value['line1'] === undefined) return false;
|
|
77
78
|
if (!('postcode' in value) || value['postcode'] === undefined) return false;
|
|
78
79
|
if (!('suburb' in value) || value['suburb'] === undefined) return false;
|
|
@@ -92,7 +93,7 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
|
|
|
92
93
|
}
|
|
93
94
|
return {
|
|
94
95
|
|
|
95
|
-
'company': json['company']
|
|
96
|
+
'company': json['company'],
|
|
96
97
|
'line1': json['line1'],
|
|
97
98
|
'line2': json['line2'] == null ? undefined : json['line2'],
|
|
98
99
|
'postcode': json['postcode'],
|
|
@@ -48,7 +48,7 @@ export interface AddressResource {
|
|
|
48
48
|
* @type {string}
|
|
49
49
|
* @memberof AddressResource
|
|
50
50
|
*/
|
|
51
|
-
company
|
|
51
|
+
company: string;
|
|
52
52
|
/**
|
|
53
53
|
*
|
|
54
54
|
* @type {string}
|
|
@@ -98,6 +98,7 @@ export interface AddressResource {
|
|
|
98
98
|
*/
|
|
99
99
|
export function instanceOfAddressResource(value: object): value is AddressResource {
|
|
100
100
|
if (!('addresseeName' in value) || value['addresseeName'] === undefined) return false;
|
|
101
|
+
if (!('company' in value) || value['company'] === undefined) return false;
|
|
101
102
|
if (!('line1' in value) || value['line1'] === undefined) return false;
|
|
102
103
|
if (!('postcode' in value) || value['postcode'] === undefined) return false;
|
|
103
104
|
if (!('suburb' in value) || value['suburb'] === undefined) return false;
|
|
@@ -121,7 +122,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
|
|
|
121
122
|
'type': json['type'] == null ? undefined : json['type'],
|
|
122
123
|
'sourceAddressId': json['sourceAddressId'] == null ? undefined : json['sourceAddressId'],
|
|
123
124
|
'addresseeName': json['addresseeName'],
|
|
124
|
-
'company': json['company']
|
|
125
|
+
'company': json['company'],
|
|
125
126
|
'line1': json['line1'],
|
|
126
127
|
'line2': json['line2'] == null ? undefined : json['line2'],
|
|
127
128
|
'postcode': json['postcode'],
|
|
@@ -55,13 +55,6 @@ import {
|
|
|
55
55
|
OrderStatusLiteResourceToJSON,
|
|
56
56
|
OrderStatusLiteResourceToJSONTyped,
|
|
57
57
|
} from './OrderStatusLiteResource';
|
|
58
|
-
import type { CartCouponResource } from './CartCouponResource';
|
|
59
|
-
import {
|
|
60
|
-
CartCouponResourceFromJSON,
|
|
61
|
-
CartCouponResourceFromJSONTyped,
|
|
62
|
-
CartCouponResourceToJSON,
|
|
63
|
-
CartCouponResourceToJSONTyped,
|
|
64
|
-
} from './CartCouponResource';
|
|
65
58
|
import type { CustomerResource } from './CustomerResource';
|
|
66
59
|
import {
|
|
67
60
|
CustomerResourceFromJSON,
|
|
@@ -327,10 +320,10 @@ export interface AdminOrderResource {
|
|
|
327
320
|
lineItems: Array<AdminOrderLineItemResource> | null;
|
|
328
321
|
/**
|
|
329
322
|
*
|
|
330
|
-
* @type {
|
|
323
|
+
* @type {object}
|
|
331
324
|
* @memberof AdminOrderResource
|
|
332
325
|
*/
|
|
333
|
-
coupons:
|
|
326
|
+
coupons: object;
|
|
334
327
|
/**
|
|
335
328
|
*
|
|
336
329
|
* @type {Array<DiscountResource>}
|
|
@@ -457,7 +450,7 @@ export function AdminOrderResourceFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
457
450
|
'admin': LiAdminUserLiteResourceFromJSON(json['admin']),
|
|
458
451
|
'status': OrderStatusLiteResourceFromJSON(json['status']),
|
|
459
452
|
'lineItems': (json['lineItems'] == null ? null : (json['lineItems'] as Array<any>).map(AdminOrderLineItemResourceFromJSON)),
|
|
460
|
-
'coupons':
|
|
453
|
+
'coupons': json['coupons'],
|
|
461
454
|
'discounts': (json['discounts'] == null ? null : (json['discounts'] as Array<any>).map(DiscountResourceFromJSON)),
|
|
462
455
|
'transactions': (json['transactions'] == null ? null : (json['transactions'] as Array<any>).map(TransactionLiteResourceFromJSON)),
|
|
463
456
|
'shippingAddress': AddressResourceFromJSON(json['shippingAddress']),
|
|
@@ -515,7 +508,7 @@ export function AdminOrderResourceToJSONTyped(value?: AdminOrderResource | null,
|
|
|
515
508
|
'admin': LiAdminUserLiteResourceToJSON(value['admin']),
|
|
516
509
|
'status': OrderStatusLiteResourceToJSON(value['status']),
|
|
517
510
|
'lineItems': (value['lineItems'] == null ? null : (value['lineItems'] as Array<any>).map(AdminOrderLineItemResourceToJSON)),
|
|
518
|
-
'coupons':
|
|
511
|
+
'coupons': value['coupons'],
|
|
519
512
|
'discounts': (value['discounts'] == null ? null : (value['discounts'] as Array<any>).map(DiscountResourceToJSON)),
|
|
520
513
|
'transactions': (value['transactions'] == null ? null : (value['transactions'] as Array<any>).map(TransactionLiteResourceToJSON)),
|
|
521
514
|
'shippingAddress': AddressResourceToJSON(value['shippingAddress']),
|