@digital8/lighting-illusions-ts-sdk 0.0.2162 → 0.0.2163
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 +4 -0
- package/README.md +5 -2
- package/dist/apis/OrdersApi.d.ts +15 -0
- package/dist/apis/OrdersApi.js +59 -0
- package/dist/models/AddressFrontendResource.d.ts +2 -2
- package/dist/models/AddressFrontendResource.js +6 -2
- package/dist/models/AddressResource.d.ts +2 -2
- package/dist/models/AddressResource.js +4 -4
- package/dist/models/FrontendCartResource.d.ts +6 -0
- package/dist/models/FrontendCartResource.js +2 -0
- package/dist/models/FrontendOrderResource.d.ts +174 -0
- package/dist/models/FrontendOrderResource.js +141 -0
- package/dist/models/FrontendOrderResourceArrayResponse.d.ts +33 -0
- package/dist/models/FrontendOrderResourceArrayResponse.js +50 -0
- package/dist/models/OrderFulfillmentResource.d.ts +1 -1
- package/dist/models/OrderFulfillmentResource.js +1 -3
- package/dist/models/PaymentSource.d.ts +1 -0
- package/dist/models/PaymentSource.js +2 -1
- package/dist/models/ProductChildFrontendResource.d.ts +3 -2
- package/dist/models/ProductChildFrontendResource.js +3 -2
- package/dist/models/StoreFrontendResource.d.ts +1 -1
- package/dist/models/StoreFrontendResource.js +1 -3
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +3 -1
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +3 -1
- package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateFrontendResource.js +3 -1
- package/dist/models/StoreSpecialDateResource.d.ts +2 -2
- package/dist/models/StoreSpecialDateResource.js +1 -3
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/docs/FrontendCartResource.md +2 -0
- package/docs/FrontendOrderResource.md +80 -0
- package/docs/FrontendOrderResourceArrayResponse.md +34 -0
- package/docs/OrdersApi.md +66 -0
- package/docs/ProductChildFrontendResource.md +1 -1
- package/docs/StoreSpecialDateFrontendResource.md +1 -1
- package/docs/StoreSpecialDateResource.md +1 -1
- package/package.json +1 -1
- package/src/apis/OrdersApi.ts +49 -0
- package/src/models/AddressFrontendResource.ts +6 -4
- package/src/models/AddressResource.ts +5 -5
- package/src/models/FrontendCartResource.ts +8 -0
- package/src/models/FrontendOrderResource.ts +299 -0
- package/src/models/FrontendOrderResourceArrayResponse.ts +73 -0
- package/src/models/OrderFulfillmentResource.ts +2 -3
- package/src/models/PaymentSource.ts +2 -1
- package/src/models/ProductChildFrontendResource.ts +11 -4
- package/src/models/StoreFrontendResource.ts +2 -3
- package/src/models/StoreListResource.ts +3 -2
- package/src/models/StoreResource.ts +3 -2
- package/src/models/StoreSpecialDateFrontendResource.ts +4 -3
- package/src/models/StoreSpecialDateResource.ts +3 -4
- package/src/models/index.ts +2 -0
|
@@ -29,8 +29,6 @@ function instanceOfOrderFulfillmentResource(value) {
|
|
|
29
29
|
return false;
|
|
30
30
|
if (!('dateShipped' in value) || value['dateShipped'] === undefined)
|
|
31
31
|
return false;
|
|
32
|
-
if (!('trackingCompany' in value) || value['trackingCompany'] === undefined)
|
|
33
|
-
return false;
|
|
34
32
|
if (!('docnum' in value) || value['docnum'] === undefined)
|
|
35
33
|
return false;
|
|
36
34
|
if (!('netsuiteId' in value) || value['netsuiteId'] === undefined)
|
|
@@ -52,7 +50,7 @@ function OrderFulfillmentResourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
52
50
|
'dateShipped': (new Date(json['dateShipped'])),
|
|
53
51
|
'trackingNumber': json['trackingNumber'] == null ? undefined : json['trackingNumber'],
|
|
54
52
|
'trackingUrl': json['trackingUrl'] == null ? undefined : json['trackingUrl'],
|
|
55
|
-
'trackingCompany': json['trackingCompany'],
|
|
53
|
+
'trackingCompany': json['trackingCompany'] == null ? undefined : json['trackingCompany'],
|
|
56
54
|
'docnum': json['docnum'],
|
|
57
55
|
'netsuiteId': json['netsuiteId'],
|
|
58
56
|
'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
|
|
@@ -17,6 +17,7 @@ export declare const PaymentSource: {
|
|
|
17
17
|
readonly Checkout: "checkout";
|
|
18
18
|
readonly ExpressCheckout: "express_checkout";
|
|
19
19
|
readonly AdminPortal: "admin_portal";
|
|
20
|
+
readonly PaymentLink: "payment_link";
|
|
20
21
|
};
|
|
21
22
|
export type PaymentSource = typeof PaymentSource[keyof typeof PaymentSource];
|
|
22
23
|
export declare function instanceOfPaymentSource(value: any): boolean;
|
|
@@ -26,7 +26,8 @@ exports.PaymentSourceToJSONTyped = PaymentSourceToJSONTyped;
|
|
|
26
26
|
exports.PaymentSource = {
|
|
27
27
|
Checkout: 'checkout',
|
|
28
28
|
ExpressCheckout: 'express_checkout',
|
|
29
|
-
AdminPortal: 'admin_portal'
|
|
29
|
+
AdminPortal: 'admin_portal',
|
|
30
|
+
PaymentLink: 'payment_link'
|
|
30
31
|
};
|
|
31
32
|
function instanceOfPaymentSource(value) {
|
|
32
33
|
for (var key in exports.PaymentSource) {
|
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import type { SupplierFrontendResource } from './SupplierFrontendResource';
|
|
13
|
+
import type { ProductChildSiteDetailFrontendResource } from './ProductChildSiteDetailFrontendResource';
|
|
13
14
|
import type { AssetLiteResource } from './AssetLiteResource';
|
|
14
15
|
/**
|
|
15
16
|
*
|
|
@@ -61,10 +62,10 @@ export interface ProductChildFrontendResource {
|
|
|
61
62
|
supplier: SupplierFrontendResource | null;
|
|
62
63
|
/**
|
|
63
64
|
*
|
|
64
|
-
* @type {
|
|
65
|
+
* @type {ProductChildSiteDetailFrontendResource}
|
|
65
66
|
* @memberof ProductChildFrontendResource
|
|
66
67
|
*/
|
|
67
|
-
siteDetails:
|
|
68
|
+
siteDetails: ProductChildSiteDetailFrontendResource | null;
|
|
68
69
|
}
|
|
69
70
|
/**
|
|
70
71
|
* Check if a given object implements the ProductChildFrontendResource interface.
|
|
@@ -19,6 +19,7 @@ exports.ProductChildFrontendResourceFromJSONTyped = ProductChildFrontendResource
|
|
|
19
19
|
exports.ProductChildFrontendResourceToJSON = ProductChildFrontendResourceToJSON;
|
|
20
20
|
exports.ProductChildFrontendResourceToJSONTyped = ProductChildFrontendResourceToJSONTyped;
|
|
21
21
|
var SupplierFrontendResource_1 = require("./SupplierFrontendResource");
|
|
22
|
+
var ProductChildSiteDetailFrontendResource_1 = require("./ProductChildSiteDetailFrontendResource");
|
|
22
23
|
var AssetLiteResource_1 = require("./AssetLiteResource");
|
|
23
24
|
/**
|
|
24
25
|
* Check if a given object implements the ProductChildFrontendResource interface.
|
|
@@ -57,7 +58,7 @@ function ProductChildFrontendResourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
57
58
|
'variations': json['variations'],
|
|
58
59
|
'thumbnail': (0, AssetLiteResource_1.AssetLiteResourceFromJSON)(json['thumbnail']),
|
|
59
60
|
'supplier': (0, SupplierFrontendResource_1.SupplierFrontendResourceFromJSON)(json['supplier']),
|
|
60
|
-
'siteDetails': json['siteDetails'],
|
|
61
|
+
'siteDetails': (0, ProductChildSiteDetailFrontendResource_1.ProductChildSiteDetailFrontendResourceFromJSON)(json['siteDetails']),
|
|
61
62
|
};
|
|
62
63
|
}
|
|
63
64
|
function ProductChildFrontendResourceToJSON(json) {
|
|
@@ -76,6 +77,6 @@ function ProductChildFrontendResourceToJSONTyped(value, ignoreDiscriminator) {
|
|
|
76
77
|
'variations': value['variations'],
|
|
77
78
|
'thumbnail': (0, AssetLiteResource_1.AssetLiteResourceToJSON)(value['thumbnail']),
|
|
78
79
|
'supplier': (0, SupplierFrontendResource_1.SupplierFrontendResourceToJSON)(value['supplier']),
|
|
79
|
-
'siteDetails': value['siteDetails'],
|
|
80
|
+
'siteDetails': (0, ProductChildSiteDetailFrontendResource_1.ProductChildSiteDetailFrontendResourceToJSON)(value['siteDetails']),
|
|
80
81
|
};
|
|
81
82
|
}
|
|
@@ -28,8 +28,6 @@ function instanceOfStoreFrontendResource(value) {
|
|
|
28
28
|
return false;
|
|
29
29
|
if (!('email' in value) || value['email'] === undefined)
|
|
30
30
|
return false;
|
|
31
|
-
if (!('website' in value) || value['website'] === undefined)
|
|
32
|
-
return false;
|
|
33
31
|
if (!('phone' in value) || value['phone'] === undefined)
|
|
34
32
|
return false;
|
|
35
33
|
if (!('latitude' in value) || value['latitude'] === undefined)
|
|
@@ -56,7 +54,7 @@ function StoreFrontendResourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
56
54
|
'siteId': json['siteId'],
|
|
57
55
|
'name': json['name'],
|
|
58
56
|
'email': json['email'],
|
|
59
|
-
'website': json['website'],
|
|
57
|
+
'website': json['website'] == null ? undefined : json['website'],
|
|
60
58
|
'phone': json['phone'],
|
|
61
59
|
'address': json['address'] == null ? undefined : json['address'],
|
|
62
60
|
'latitude': json['latitude'],
|
|
@@ -37,6 +37,8 @@ function instanceOfStoreListResource(value) {
|
|
|
37
37
|
return false;
|
|
38
38
|
if (!('email' in value) || value['email'] === undefined)
|
|
39
39
|
return false;
|
|
40
|
+
if (!('website' in value) || value['website'] === undefined)
|
|
41
|
+
return false;
|
|
40
42
|
if (!('netsuiteId' in value) || value['netsuiteId'] === undefined)
|
|
41
43
|
return false;
|
|
42
44
|
if (!('displayNetsuiteId' in value) || value['displayNetsuiteId'] === undefined)
|
|
@@ -59,7 +61,7 @@ function StoreListResourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
59
61
|
'latitude': json['latitude'],
|
|
60
62
|
'tagLine': json['tagLine'],
|
|
61
63
|
'email': json['email'],
|
|
62
|
-
'website': json['website']
|
|
64
|
+
'website': json['website'],
|
|
63
65
|
'netsuiteId': json['netsuiteId'],
|
|
64
66
|
'displayNetsuiteId': json['displayNetsuiteId'],
|
|
65
67
|
'openingHours': json['openingHours'] == null ? undefined : json['openingHours'],
|
|
@@ -36,6 +36,8 @@ function instanceOfStoreResource(value) {
|
|
|
36
36
|
return false;
|
|
37
37
|
if (!('latitude' in value) || value['latitude'] === undefined)
|
|
38
38
|
return false;
|
|
39
|
+
if (!('tagLine' in value) || value['tagLine'] === undefined)
|
|
40
|
+
return false;
|
|
39
41
|
if (!('email' in value) || value['email'] === undefined)
|
|
40
42
|
return false;
|
|
41
43
|
if (!('website' in value) || value['website'] === undefined)
|
|
@@ -66,7 +68,7 @@ function StoreResourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
66
68
|
'phone': json['phone'],
|
|
67
69
|
'longitude': json['longitude'],
|
|
68
70
|
'latitude': json['latitude'],
|
|
69
|
-
'tagLine': json['tagLine']
|
|
71
|
+
'tagLine': json['tagLine'],
|
|
70
72
|
'email': json['email'],
|
|
71
73
|
'website': json['website'],
|
|
72
74
|
'netsuiteId': json['netsuiteId'],
|
|
@@ -35,10 +35,10 @@ export interface StoreSpecialDateFrontendResource {
|
|
|
35
35
|
hours: string;
|
|
36
36
|
/**
|
|
37
37
|
*
|
|
38
|
-
* @type {
|
|
38
|
+
* @type {object}
|
|
39
39
|
* @memberof StoreSpecialDateFrontendResource
|
|
40
40
|
*/
|
|
41
|
-
date
|
|
41
|
+
date: object;
|
|
42
42
|
/**
|
|
43
43
|
*
|
|
44
44
|
* @type {boolean}
|
|
@@ -26,6 +26,8 @@ function instanceOfStoreSpecialDateFrontendResource(value) {
|
|
|
26
26
|
return false;
|
|
27
27
|
if (!('hours' in value) || value['hours'] === undefined)
|
|
28
28
|
return false;
|
|
29
|
+
if (!('date' in value) || value['date'] === undefined)
|
|
30
|
+
return false;
|
|
29
31
|
if (!('closed' in value) || value['closed'] === undefined)
|
|
30
32
|
return false;
|
|
31
33
|
if (!('displayStartDate' in value) || value['displayStartDate'] === undefined)
|
|
@@ -45,7 +47,7 @@ function StoreSpecialDateFrontendResourceFromJSONTyped(json, ignoreDiscriminator
|
|
|
45
47
|
'id': json['id'] == null ? undefined : json['id'],
|
|
46
48
|
'name': json['name'],
|
|
47
49
|
'hours': json['hours'],
|
|
48
|
-
'date': json['date']
|
|
50
|
+
'date': json['date'],
|
|
49
51
|
'closed': json['closed'],
|
|
50
52
|
'displayStartDate': json['displayStartDate'],
|
|
51
53
|
'displayEndDate': json['displayEndDate'],
|
|
@@ -26,8 +26,6 @@ function instanceOfStoreSpecialDateResource(value) {
|
|
|
26
26
|
return false;
|
|
27
27
|
if (!('hours' in value) || value['hours'] === undefined)
|
|
28
28
|
return false;
|
|
29
|
-
if (!('date' in value) || value['date'] === undefined)
|
|
30
|
-
return false;
|
|
31
29
|
if (!('closed' in value) || value['closed'] === undefined)
|
|
32
30
|
return false;
|
|
33
31
|
if (!('displayStartDate' in value) || value['displayStartDate'] === undefined)
|
|
@@ -47,7 +45,7 @@ function StoreSpecialDateResourceFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
47
45
|
'id': json['id'] == null ? undefined : json['id'],
|
|
48
46
|
'name': json['name'],
|
|
49
47
|
'hours': json['hours'],
|
|
50
|
-
'date': json['date'],
|
|
48
|
+
'date': json['date'] == null ? undefined : json['date'],
|
|
51
49
|
'closed': json['closed'],
|
|
52
50
|
'displayStartDate': json['displayStartDate'],
|
|
53
51
|
'displayEndDate': json['displayEndDate'],
|
package/dist/models/index.d.ts
CHANGED
|
@@ -175,6 +175,8 @@ export * from './FrontendComponentResource';
|
|
|
175
175
|
export * from './FrontendComponentResourceArrayResponse';
|
|
176
176
|
export * from './FrontendLineItemResource';
|
|
177
177
|
export * from './FrontendLineItemResourceArrayResponse';
|
|
178
|
+
export * from './FrontendOrderResource';
|
|
179
|
+
export * from './FrontendOrderResourceArrayResponse';
|
|
178
180
|
export * from './GenericResponse';
|
|
179
181
|
export * from './GetUniqueEndpointsRequest';
|
|
180
182
|
export * from './GlobalSearchCategoryResource';
|
package/dist/models/index.js
CHANGED
|
@@ -193,6 +193,8 @@ __exportStar(require("./FrontendComponentResource"), exports);
|
|
|
193
193
|
__exportStar(require("./FrontendComponentResourceArrayResponse"), exports);
|
|
194
194
|
__exportStar(require("./FrontendLineItemResource"), exports);
|
|
195
195
|
__exportStar(require("./FrontendLineItemResourceArrayResponse"), exports);
|
|
196
|
+
__exportStar(require("./FrontendOrderResource"), exports);
|
|
197
|
+
__exportStar(require("./FrontendOrderResourceArrayResponse"), exports);
|
|
196
198
|
__exportStar(require("./GenericResponse"), exports);
|
|
197
199
|
__exportStar(require("./GetUniqueEndpointsRequest"), exports);
|
|
198
200
|
__exportStar(require("./GlobalSearchCategoryResource"), exports);
|
|
@@ -10,6 +10,7 @@ Name | Type
|
|
|
10
10
|
`lifecycleStatus` | string
|
|
11
11
|
`siteId` | number
|
|
12
12
|
`sessionToken` | string
|
|
13
|
+
`guestEmail` | string
|
|
13
14
|
`customer` | [CustomerListResource](CustomerListResource.md)
|
|
14
15
|
`shippingType` | string
|
|
15
16
|
`shippingAddress` | [AddressResource](AddressResource.md)
|
|
@@ -36,6 +37,7 @@ const example = {
|
|
|
36
37
|
"lifecycleStatus": null,
|
|
37
38
|
"siteId": null,
|
|
38
39
|
"sessionToken": null,
|
|
40
|
+
"guestEmail": null,
|
|
39
41
|
"customer": null,
|
|
40
42
|
"shippingType": null,
|
|
41
43
|
"shippingAddress": null,
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
|
|
2
|
+
# FrontendOrderResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`cartId` | number
|
|
11
|
+
`siteId` | number
|
|
12
|
+
`placedAt` | Date
|
|
13
|
+
`source` | string
|
|
14
|
+
`paymentToken` | string
|
|
15
|
+
`accessToken` | object
|
|
16
|
+
`shippingType` | string
|
|
17
|
+
`customer` | [CustomerListResource](CustomerListResource.md)
|
|
18
|
+
`status` | object
|
|
19
|
+
`shippingAddress` | [AddressResource](AddressResource.md)
|
|
20
|
+
`billingAddress` | [AddressResource](AddressResource.md)
|
|
21
|
+
`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
|
|
22
|
+
`coupons` | [Array<CartCouponLiteResource>](CartCouponLiteResource.md)
|
|
23
|
+
`subtotal` | number
|
|
24
|
+
`promotionalDiscount` | number
|
|
25
|
+
`couponSubtotalDiscount` | number
|
|
26
|
+
`couponShippingDiscount` | number
|
|
27
|
+
`shipping` | number
|
|
28
|
+
`transitInsurance` | number
|
|
29
|
+
`gst` | number
|
|
30
|
+
`grandTotal` | number
|
|
31
|
+
`amountPaid` | number
|
|
32
|
+
`amountDue` | number
|
|
33
|
+
|
|
34
|
+
## Example
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
import type { FrontendOrderResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
38
|
+
|
|
39
|
+
// TODO: Update the object below with actual values
|
|
40
|
+
const example = {
|
|
41
|
+
"id": null,
|
|
42
|
+
"cartId": null,
|
|
43
|
+
"siteId": null,
|
|
44
|
+
"placedAt": null,
|
|
45
|
+
"source": null,
|
|
46
|
+
"paymentToken": null,
|
|
47
|
+
"accessToken": null,
|
|
48
|
+
"shippingType": null,
|
|
49
|
+
"customer": null,
|
|
50
|
+
"status": null,
|
|
51
|
+
"shippingAddress": null,
|
|
52
|
+
"billingAddress": null,
|
|
53
|
+
"lineItems": null,
|
|
54
|
+
"coupons": null,
|
|
55
|
+
"subtotal": null,
|
|
56
|
+
"promotionalDiscount": null,
|
|
57
|
+
"couponSubtotalDiscount": null,
|
|
58
|
+
"couponShippingDiscount": null,
|
|
59
|
+
"shipping": null,
|
|
60
|
+
"transitInsurance": null,
|
|
61
|
+
"gst": null,
|
|
62
|
+
"grandTotal": null,
|
|
63
|
+
"amountPaid": null,
|
|
64
|
+
"amountDue": null,
|
|
65
|
+
} satisfies FrontendOrderResource
|
|
66
|
+
|
|
67
|
+
console.log(example)
|
|
68
|
+
|
|
69
|
+
// Convert the instance to a JSON string
|
|
70
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
71
|
+
console.log(exampleJSON)
|
|
72
|
+
|
|
73
|
+
// Parse the JSON string back to an object
|
|
74
|
+
const exampleParsed = JSON.parse(exampleJSON) as FrontendOrderResource
|
|
75
|
+
console.log(exampleParsed)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
79
|
+
|
|
80
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# FrontendOrderResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<FrontendOrderResource>](FrontendOrderResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { FrontendOrderResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies FrontendOrderResourceArrayResponse
|
|
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 FrontendOrderResourceArrayResponse
|
|
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/OrdersApi.md
CHANGED
|
@@ -12,6 +12,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
12
12
|
| [**detachItemOrder**](OrdersApi.md#detachitemorder) | **DELETE** /admin-api/orders/{order}/line-items/{lineItem}/detach | Auto-generated: detachItemOrder |
|
|
13
13
|
| [**getAllOrder**](OrdersApi.md#getallorder) | **POST** /admin-api/orders/all | Auto-generated: getAllOrder |
|
|
14
14
|
| [**indexOrder**](OrdersApi.md#indexorder) | **POST** /admin-api/orders/list | Auto-generated: indexOrder |
|
|
15
|
+
| [**pdfOrder**](OrdersApi.md#pdforder) | **POST** /admin-api/orders/{order}/pdf | Auto-generated: pdfOrder |
|
|
15
16
|
| [**sendPaymentLinkOrder**](OrdersApi.md#sendpaymentlinkorder) | **POST** /admin-api/orders/{order}/send-payment-link | Auto-generated: sendPaymentLinkOrder |
|
|
16
17
|
| [**showOrder**](OrdersApi.md#showorder) | **GET** /admin-api/orders/{order} | Auto-generated: showOrder |
|
|
17
18
|
| [**statusesAllOrder**](OrdersApi.md#statusesallorder) | **POST** /admin-api/orders/statuses/all | Auto-generated: statusesAllOrder |
|
|
@@ -552,6 +553,71 @@ No authorization required
|
|
|
552
553
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
553
554
|
|
|
554
555
|
|
|
556
|
+
## pdfOrder
|
|
557
|
+
|
|
558
|
+
> GenericResponse pdfOrder(order)
|
|
559
|
+
|
|
560
|
+
Auto-generated: pdfOrder
|
|
561
|
+
|
|
562
|
+
### Example
|
|
563
|
+
|
|
564
|
+
```ts
|
|
565
|
+
import {
|
|
566
|
+
Configuration,
|
|
567
|
+
OrdersApi,
|
|
568
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
569
|
+
import type { PdfOrderRequest } 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 OrdersApi();
|
|
574
|
+
|
|
575
|
+
const body = {
|
|
576
|
+
// number | The id of the order
|
|
577
|
+
order: 56,
|
|
578
|
+
} satisfies PdfOrderRequest;
|
|
579
|
+
|
|
580
|
+
try {
|
|
581
|
+
const data = await api.pdfOrder(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
|
+
| **order** | `number` | The id of the order | [Defaults to `undefined`] |
|
|
598
|
+
|
|
599
|
+
### Return type
|
|
600
|
+
|
|
601
|
+
[**GenericResponse**](GenericResponse.md)
|
|
602
|
+
|
|
603
|
+
### Authorization
|
|
604
|
+
|
|
605
|
+
No authorization required
|
|
606
|
+
|
|
607
|
+
### HTTP request headers
|
|
608
|
+
|
|
609
|
+
- **Content-Type**: Not defined
|
|
610
|
+
- **Accept**: `application/json`
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
### HTTP response details
|
|
614
|
+
| Status code | Description | Response headers |
|
|
615
|
+
|-------------|-------------|------------------|
|
|
616
|
+
| **200** | \\Response | - |
|
|
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
|
+
|
|
555
621
|
## sendPaymentLinkOrder
|
|
556
622
|
|
|
557
623
|
> AdminOrderResource sendPaymentLinkOrder(order)
|
|
@@ -13,7 +13,7 @@ Name | Type
|
|
|
13
13
|
`variations` | number
|
|
14
14
|
`thumbnail` | [AssetLiteResource](AssetLiteResource.md)
|
|
15
15
|
`supplier` | [SupplierFrontendResource](SupplierFrontendResource.md)
|
|
16
|
-
`siteDetails` |
|
|
16
|
+
`siteDetails` | [ProductChildSiteDetailFrontendResource](ProductChildSiteDetailFrontendResource.md)
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
package/package.json
CHANGED
package/src/apis/OrdersApi.ts
CHANGED
|
@@ -120,6 +120,10 @@ export interface IndexOrderRequest {
|
|
|
120
120
|
searchOrdersRequest?: SearchOrdersRequest;
|
|
121
121
|
}
|
|
122
122
|
|
|
123
|
+
export interface PdfOrderRequest {
|
|
124
|
+
order: number;
|
|
125
|
+
}
|
|
126
|
+
|
|
123
127
|
export interface SendPaymentLinkOrderRequest {
|
|
124
128
|
order: number;
|
|
125
129
|
}
|
|
@@ -506,6 +510,51 @@ export class OrdersApi extends runtime.BaseAPI {
|
|
|
506
510
|
return await response.value();
|
|
507
511
|
}
|
|
508
512
|
|
|
513
|
+
/**
|
|
514
|
+
* Creates request options for pdfOrder without sending the request
|
|
515
|
+
*/
|
|
516
|
+
async pdfOrderRequestOpts(requestParameters: PdfOrderRequest): Promise<runtime.RequestOpts> {
|
|
517
|
+
if (requestParameters['order'] == null) {
|
|
518
|
+
throw new runtime.RequiredError(
|
|
519
|
+
'order',
|
|
520
|
+
'Required parameter "order" was null or undefined when calling pdfOrder().'
|
|
521
|
+
);
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
const queryParameters: any = {};
|
|
525
|
+
|
|
526
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
let urlPath = `/admin-api/orders/{order}/pdf`;
|
|
530
|
+
urlPath = urlPath.replace('{order}', encodeURIComponent(String(requestParameters['order'])));
|
|
531
|
+
|
|
532
|
+
return {
|
|
533
|
+
path: urlPath,
|
|
534
|
+
method: 'POST',
|
|
535
|
+
headers: headerParameters,
|
|
536
|
+
query: queryParameters,
|
|
537
|
+
};
|
|
538
|
+
}
|
|
539
|
+
|
|
540
|
+
/**
|
|
541
|
+
* Auto-generated: pdfOrder
|
|
542
|
+
*/
|
|
543
|
+
async pdfOrderRaw(requestParameters: PdfOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
|
|
544
|
+
const requestOptions = await this.pdfOrderRequestOpts(requestParameters);
|
|
545
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
546
|
+
|
|
547
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
|
|
548
|
+
}
|
|
549
|
+
|
|
550
|
+
/**
|
|
551
|
+
* Auto-generated: pdfOrder
|
|
552
|
+
*/
|
|
553
|
+
async pdfOrder(requestParameters: PdfOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
|
|
554
|
+
const response = await this.pdfOrderRaw(requestParameters, initOverrides);
|
|
555
|
+
return await response.value();
|
|
556
|
+
}
|
|
557
|
+
|
|
509
558
|
/**
|
|
510
559
|
* Creates request options for sendPaymentLinkOrder without sending the request
|
|
511
560
|
*/
|
|
@@ -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}
|
|
@@ -36,7 +36,7 @@ export interface AddressFrontendResource {
|
|
|
36
36
|
* @type {string}
|
|
37
37
|
* @memberof AddressFrontendResource
|
|
38
38
|
*/
|
|
39
|
-
line2
|
|
39
|
+
line2: string;
|
|
40
40
|
/**
|
|
41
41
|
*
|
|
42
42
|
* @type {string}
|
|
@@ -73,7 +73,9 @@ 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;
|
|
78
|
+
if (!('line2' in value) || value['line2'] === undefined) return false;
|
|
77
79
|
if (!('postcode' in value) || value['postcode'] === undefined) return false;
|
|
78
80
|
if (!('suburb' in value) || value['suburb'] === undefined) return false;
|
|
79
81
|
if (!('country' in value) || value['country'] === undefined) return false;
|
|
@@ -92,9 +94,9 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
|
|
|
92
94
|
}
|
|
93
95
|
return {
|
|
94
96
|
|
|
95
|
-
'company': json['company']
|
|
97
|
+
'company': json['company'],
|
|
96
98
|
'line1': json['line1'],
|
|
97
|
-
'line2': json['line2']
|
|
99
|
+
'line2': json['line2'],
|
|
98
100
|
'postcode': json['postcode'],
|
|
99
101
|
'suburb': json['suburb'],
|
|
100
102
|
'country': json['country'],
|
|
@@ -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}
|
|
@@ -60,7 +60,7 @@ export interface AddressResource {
|
|
|
60
60
|
* @type {string}
|
|
61
61
|
* @memberof AddressResource
|
|
62
62
|
*/
|
|
63
|
-
line2
|
|
63
|
+
line2?: string | null;
|
|
64
64
|
/**
|
|
65
65
|
*
|
|
66
66
|
* @type {string}
|
|
@@ -98,8 +98,8 @@ 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
|
-
if (!('line2' in value) || value['line2'] === undefined) return false;
|
|
103
103
|
if (!('postcode' in value) || value['postcode'] === undefined) return false;
|
|
104
104
|
if (!('suburb' in value) || value['suburb'] === undefined) return false;
|
|
105
105
|
if (!('country' in value) || value['country'] === undefined) return false;
|
|
@@ -122,9 +122,9 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
|
|
|
122
122
|
'type': json['type'] == null ? undefined : json['type'],
|
|
123
123
|
'sourceAddressId': json['sourceAddressId'] == null ? undefined : json['sourceAddressId'],
|
|
124
124
|
'addresseeName': json['addresseeName'],
|
|
125
|
-
'company': json['company']
|
|
125
|
+
'company': json['company'],
|
|
126
126
|
'line1': json['line1'],
|
|
127
|
-
'line2': json['line2'],
|
|
127
|
+
'line2': json['line2'] == null ? undefined : json['line2'],
|
|
128
128
|
'postcode': json['postcode'],
|
|
129
129
|
'suburb': json['suburb'],
|
|
130
130
|
'country': json['country'],
|