@digital8/lighting-illusions-ts-sdk 0.0.1936 → 0.0.1938

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.
Files changed (93) hide show
  1. package/.openapi-generator/FILES +8 -2
  2. package/README.md +8 -3
  3. package/dist/apis/OrdersApi.d.ts +37 -2
  4. package/dist/apis/OrdersApi.js +126 -1
  5. package/dist/models/AddressFrontendResource.d.ts +1 -1
  6. package/dist/models/AddressFrontendResource.js +3 -1
  7. package/dist/models/AddressResource.d.ts +1 -7
  8. package/dist/models/AddressResource.js +3 -5
  9. package/dist/models/AdminOrderResource.d.ts +12 -0
  10. package/dist/models/AdminOrderResource.js +8 -0
  11. package/dist/models/AttachCouponOrderRequest.d.ts +32 -0
  12. package/dist/models/AttachCouponOrderRequest.js +51 -0
  13. package/dist/models/CartListResource.d.ts +6 -0
  14. package/dist/models/CartListResource.js +4 -0
  15. package/dist/models/CartResource.d.ts +6 -0
  16. package/dist/models/CartResource.js +4 -0
  17. package/dist/models/DetachCouponOrderRequest.d.ts +32 -0
  18. package/dist/models/DetachCouponOrderRequest.js +51 -0
  19. package/dist/models/GetAllOrderRequest.d.ts +1 -0
  20. package/dist/models/GetAllOrderRequest.js +2 -1
  21. package/dist/models/IndexOrderRequest.d.ts +1 -0
  22. package/dist/models/IndexOrderRequest.js +2 -1
  23. package/dist/models/OrderListResource.d.ts +18 -0
  24. package/dist/models/OrderListResource.js +10 -0
  25. package/dist/models/OrderStatusWithCountResource.d.ts +50 -0
  26. package/dist/models/OrderStatusWithCountResource.js +63 -0
  27. package/dist/models/OrderStatusWithCountResourceArrayResponse.d.ts +33 -0
  28. package/dist/models/OrderStatusWithCountResourceArrayResponse.js +50 -0
  29. package/dist/models/StoreCartRequest.d.ts +6 -0
  30. package/dist/models/StoreCartRequest.js +2 -0
  31. package/dist/models/StoreCartRequestShippingAddress.d.ts +0 -6
  32. package/dist/models/StoreCartRequestShippingAddress.js +0 -2
  33. package/dist/models/StoreListResource.d.ts +2 -2
  34. package/dist/models/StoreListResource.js +4 -4
  35. package/dist/models/StoreResource.d.ts +1 -1
  36. package/dist/models/StoreResource.js +1 -3
  37. package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
  38. package/dist/models/StoreSpecialDateFrontendResource.js +3 -1
  39. package/dist/models/StoreSpecialDateResource.d.ts +2 -2
  40. package/dist/models/StoreSpecialDateResource.js +1 -3
  41. package/dist/models/UpdateCartRequest.d.ts +6 -0
  42. package/dist/models/UpdateCartRequest.js +2 -0
  43. package/dist/models/UpdateOrderRequest.d.ts +9 -3
  44. package/dist/models/UpdateOrderRequest.js +5 -3
  45. package/dist/models/UpdateOrderRequestBillingAddress.d.ts +1 -7
  46. package/dist/models/UpdateOrderRequestBillingAddress.js +3 -5
  47. package/dist/models/index.d.ts +4 -1
  48. package/dist/models/index.js +4 -1
  49. package/docs/AddressResource.md +0 -2
  50. package/docs/AdminOrderResource.md +4 -0
  51. package/docs/AttachCouponOrderRequest.md +34 -0
  52. package/docs/CartListResource.md +2 -0
  53. package/docs/CartResource.md +2 -0
  54. package/docs/DetachCouponOrderRequest.md +34 -0
  55. package/docs/OrderListResource.md +6 -0
  56. package/docs/OrderStatusWithCountResource.md +40 -0
  57. package/docs/OrderStatusWithCountResourceArrayResponse.md +34 -0
  58. package/docs/OrdersApi.md +141 -3
  59. package/docs/StoreCartRequest.md +2 -0
  60. package/docs/StoreCartRequestShippingAddress.md +0 -2
  61. package/docs/StoreSpecialDateFrontendResource.md +1 -1
  62. package/docs/StoreSpecialDateResource.md +1 -1
  63. package/docs/UpdateCartRequest.md +2 -0
  64. package/docs/UpdateOrderRequest.md +3 -1
  65. package/docs/UpdateOrderRequestBillingAddress.md +2 -4
  66. package/package.json +1 -1
  67. package/src/apis/OrdersApi.ts +124 -3
  68. package/src/models/AddressFrontendResource.ts +3 -2
  69. package/src/models/AddressResource.ts +3 -11
  70. package/src/models/AdminOrderResource.ts +18 -0
  71. package/src/models/AttachCouponOrderRequest.ts +66 -0
  72. package/src/models/CartListResource.ts +9 -0
  73. package/src/models/CartResource.ts +9 -0
  74. package/src/models/DetachCouponOrderRequest.ts +66 -0
  75. package/src/models/GetAllOrderRequest.ts +2 -1
  76. package/src/models/IndexOrderRequest.ts +2 -1
  77. package/src/models/OrderListResource.ts +26 -0
  78. package/src/models/OrderStatusWithCountResource.ts +93 -0
  79. package/src/models/OrderStatusWithCountResourceArrayResponse.ts +73 -0
  80. package/src/models/StoreCartRequest.ts +8 -0
  81. package/src/models/StoreCartRequestShippingAddress.ts +0 -8
  82. package/src/models/StoreListResource.ts +5 -5
  83. package/src/models/StoreResource.ts +2 -3
  84. package/src/models/StoreSpecialDateFrontendResource.ts +4 -3
  85. package/src/models/StoreSpecialDateResource.ts +3 -4
  86. package/src/models/UpdateCartRequest.ts +8 -0
  87. package/src/models/UpdateOrderRequest.ts +18 -10
  88. package/src/models/UpdateOrderRequestBillingAddress.ts +4 -12
  89. package/src/models/index.ts +4 -1
  90. package/dist/models/UpdateOrderRequestShippingAddress.d.ts +0 -80
  91. package/dist/models/UpdateOrderRequestShippingAddress.js +0 -67
  92. package/docs/UpdateOrderRequestShippingAddress.md +0 -50
  93. package/src/models/UpdateOrderRequestShippingAddress.ts +0 -130
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { UpdateOrderRequestShippingAddress } from './UpdateOrderRequestShippingAddress';
12
+ import type { StoreCartRequestShippingAddress } from './StoreCartRequestShippingAddress';
13
13
  import type { UpdateOrderRequestBillingAddress } from './UpdateOrderRequestBillingAddress';
14
14
  /**
15
15
  *
@@ -59,6 +59,12 @@ export interface UpdateOrderRequest {
59
59
  * @memberof UpdateOrderRequest
60
60
  */
61
61
  insuranceAmount?: number | null;
62
+ /**
63
+ *
64
+ * @type {boolean}
65
+ * @memberof UpdateOrderRequest
66
+ */
67
+ includeInsurance?: boolean;
62
68
  /**
63
69
  *
64
70
  * @type {boolean}
@@ -67,10 +73,10 @@ export interface UpdateOrderRequest {
67
73
  overrideInsurance?: boolean;
68
74
  /**
69
75
  *
70
- * @type {UpdateOrderRequestShippingAddress}
76
+ * @type {StoreCartRequestShippingAddress}
71
77
  * @memberof UpdateOrderRequest
72
78
  */
73
- shippingAddress?: UpdateOrderRequestShippingAddress;
79
+ shippingAddress?: StoreCartRequestShippingAddress;
74
80
  /**
75
81
  *
76
82
  * @type {UpdateOrderRequestBillingAddress}
@@ -19,7 +19,7 @@ exports.UpdateOrderRequestFromJSON = UpdateOrderRequestFromJSON;
19
19
  exports.UpdateOrderRequestFromJSONTyped = UpdateOrderRequestFromJSONTyped;
20
20
  exports.UpdateOrderRequestToJSON = UpdateOrderRequestToJSON;
21
21
  exports.UpdateOrderRequestToJSONTyped = UpdateOrderRequestToJSONTyped;
22
- var UpdateOrderRequestShippingAddress_1 = require("./UpdateOrderRequestShippingAddress");
22
+ var StoreCartRequestShippingAddress_1 = require("./StoreCartRequestShippingAddress");
23
23
  var UpdateOrderRequestBillingAddress_1 = require("./UpdateOrderRequestBillingAddress");
24
24
  /**
25
25
  * @export
@@ -71,8 +71,9 @@ function UpdateOrderRequestFromJSONTyped(json, ignoreDiscriminator) {
71
71
  'shippingSubtotal': json['shipping_subtotal'] == null ? undefined : json['shipping_subtotal'],
72
72
  'overrideShipping': json['override_shipping'] == null ? undefined : json['override_shipping'],
73
73
  'insuranceAmount': json['insurance_amount'] == null ? undefined : json['insurance_amount'],
74
+ 'includeInsurance': json['include_insurance'] == null ? undefined : json['include_insurance'],
74
75
  'overrideInsurance': json['override_insurance'] == null ? undefined : json['override_insurance'],
75
- 'shippingAddress': json['shipping_address'] == null ? undefined : (0, UpdateOrderRequestShippingAddress_1.UpdateOrderRequestShippingAddressFromJSON)(json['shipping_address']),
76
+ 'shippingAddress': json['shipping_address'] == null ? undefined : (0, StoreCartRequestShippingAddress_1.StoreCartRequestShippingAddressFromJSON)(json['shipping_address']),
76
77
  'billingAddress': (0, UpdateOrderRequestBillingAddress_1.UpdateOrderRequestBillingAddressFromJSON)(json['billing_address']),
77
78
  };
78
79
  }
@@ -92,8 +93,9 @@ function UpdateOrderRequestToJSONTyped(value, ignoreDiscriminator) {
92
93
  'shipping_subtotal': value['shippingSubtotal'],
93
94
  'override_shipping': value['overrideShipping'],
94
95
  'insurance_amount': value['insuranceAmount'],
96
+ 'include_insurance': value['includeInsurance'],
95
97
  'override_insurance': value['overrideInsurance'],
96
- 'shipping_address': (0, UpdateOrderRequestShippingAddress_1.UpdateOrderRequestShippingAddressToJSON)(value['shippingAddress']),
98
+ 'shipping_address': (0, StoreCartRequestShippingAddress_1.StoreCartRequestShippingAddressToJSON)(value['shippingAddress']),
97
99
  'billing_address': (0, UpdateOrderRequestBillingAddress_1.UpdateOrderRequestBillingAddressToJSON)(value['billingAddress']),
98
100
  };
99
101
  }
@@ -20,13 +20,7 @@ export interface UpdateOrderRequestBillingAddress {
20
20
  * @type {string}
21
21
  * @memberof UpdateOrderRequestBillingAddress
22
22
  */
23
- adresseeName: string;
24
- /**
25
- *
26
- * @type {string}
27
- * @memberof UpdateOrderRequestBillingAddress
28
- */
29
- addressee?: string | null;
23
+ addresseeName: string;
30
24
  /**
31
25
  *
32
26
  * @type {string}
@@ -22,7 +22,7 @@ exports.UpdateOrderRequestBillingAddressToJSONTyped = UpdateOrderRequestBillingA
22
22
  * Check if a given object implements the UpdateOrderRequestBillingAddress interface.
23
23
  */
24
24
  function instanceOfUpdateOrderRequestBillingAddress(value) {
25
- if (!('adresseeName' in value) || value['adresseeName'] === undefined)
25
+ if (!('addresseeName' in value) || value['addresseeName'] === undefined)
26
26
  return false;
27
27
  return true;
28
28
  }
@@ -34,8 +34,7 @@ function UpdateOrderRequestBillingAddressFromJSONTyped(json, ignoreDiscriminator
34
34
  return json;
35
35
  }
36
36
  return {
37
- 'adresseeName': json['adressee_name'],
38
- 'addressee': json['addressee'] == null ? undefined : json['addressee'],
37
+ 'addresseeName': json['addressee_name'],
39
38
  'company': json['company'] == null ? undefined : json['company'],
40
39
  'line1': json['line_1'] == null ? undefined : json['line_1'],
41
40
  'line2': json['line_2'] == null ? undefined : json['line_2'],
@@ -54,8 +53,7 @@ function UpdateOrderRequestBillingAddressToJSONTyped(value, ignoreDiscriminator)
54
53
  return value;
55
54
  }
56
55
  return {
57
- 'adressee_name': value['adresseeName'],
58
- 'addressee': value['addressee'],
56
+ 'addressee_name': value['addresseeName'],
59
57
  'company': value['company'],
60
58
  'line_1': value['line1'],
61
59
  'line_2': value['line2'],
@@ -22,6 +22,7 @@ export * from './AttachAttributeProductTypeRequest';
22
22
  export * from './AttachAttributesProductRangeRequest';
23
23
  export * from './AttachAttributesProductRangeRequestAttributesInner';
24
24
  export * from './AttachCouponCartRequest';
25
+ export * from './AttachCouponOrderRequest';
25
26
  export * from './AttachDocumentablesDocumentRequest';
26
27
  export * from './AttachDocumentablesDocumentRequestDocumentablesInner';
27
28
  export * from './AttachDocumentsProductChildRequest';
@@ -80,6 +81,7 @@ export * from './DetachAccessoriesProductRangeRequest';
80
81
  export * from './DetachAssetableOverlayTemplateRequest';
81
82
  export * from './DetachAttributesProductRangeRequest';
82
83
  export * from './DetachCouponCartRequest';
84
+ export * from './DetachCouponOrderRequest';
83
85
  export * from './DetachDocumentablesDocumentRequest';
84
86
  export * from './DetachDocumentablesDocumentRequestDocumentablesInner';
85
87
  export * from './DetachDocumentsProductChildRequest';
@@ -201,6 +203,8 @@ export * from './OrderListResource';
201
203
  export * from './OrderListResourceArrayResponse';
202
204
  export * from './OrderLiteResource';
203
205
  export * from './OrderLiteResourceArrayResponse';
206
+ export * from './OrderStatusWithCountResource';
207
+ export * from './OrderStatusWithCountResourceArrayResponse';
204
208
  export * from './OverlayTemplateAssetFrontendResource';
205
209
  export * from './OverlayTemplateAssetFrontendResourceArrayResponse';
206
210
  export * from './OverlayTemplateAssetPosition';
@@ -474,7 +478,6 @@ export * from './UpdateMenuRequestMenuItemOrderInner';
474
478
  export * from './UpdateModelAttributeRequest';
475
479
  export * from './UpdateOrderRequest';
476
480
  export * from './UpdateOrderRequestBillingAddress';
477
- export * from './UpdateOrderRequestShippingAddress';
478
481
  export * from './UpdateOverlayTemplateAssetRequest';
479
482
  export * from './UpdateOverlayTemplateRequest';
480
483
  export * from './UpdateProductCategoryRequest';
@@ -40,6 +40,7 @@ __exportStar(require("./AttachAttributeProductTypeRequest"), exports);
40
40
  __exportStar(require("./AttachAttributesProductRangeRequest"), exports);
41
41
  __exportStar(require("./AttachAttributesProductRangeRequestAttributesInner"), exports);
42
42
  __exportStar(require("./AttachCouponCartRequest"), exports);
43
+ __exportStar(require("./AttachCouponOrderRequest"), exports);
43
44
  __exportStar(require("./AttachDocumentablesDocumentRequest"), exports);
44
45
  __exportStar(require("./AttachDocumentablesDocumentRequestDocumentablesInner"), exports);
45
46
  __exportStar(require("./AttachDocumentsProductChildRequest"), exports);
@@ -98,6 +99,7 @@ __exportStar(require("./DetachAccessoriesProductRangeRequest"), exports);
98
99
  __exportStar(require("./DetachAssetableOverlayTemplateRequest"), exports);
99
100
  __exportStar(require("./DetachAttributesProductRangeRequest"), exports);
100
101
  __exportStar(require("./DetachCouponCartRequest"), exports);
102
+ __exportStar(require("./DetachCouponOrderRequest"), exports);
101
103
  __exportStar(require("./DetachDocumentablesDocumentRequest"), exports);
102
104
  __exportStar(require("./DetachDocumentablesDocumentRequestDocumentablesInner"), exports);
103
105
  __exportStar(require("./DetachDocumentsProductChildRequest"), exports);
@@ -219,6 +221,8 @@ __exportStar(require("./OrderListResource"), exports);
219
221
  __exportStar(require("./OrderListResourceArrayResponse"), exports);
220
222
  __exportStar(require("./OrderLiteResource"), exports);
221
223
  __exportStar(require("./OrderLiteResourceArrayResponse"), exports);
224
+ __exportStar(require("./OrderStatusWithCountResource"), exports);
225
+ __exportStar(require("./OrderStatusWithCountResourceArrayResponse"), exports);
222
226
  __exportStar(require("./OverlayTemplateAssetFrontendResource"), exports);
223
227
  __exportStar(require("./OverlayTemplateAssetFrontendResourceArrayResponse"), exports);
224
228
  __exportStar(require("./OverlayTemplateAssetPosition"), exports);
@@ -492,7 +496,6 @@ __exportStar(require("./UpdateMenuRequestMenuItemOrderInner"), exports);
492
496
  __exportStar(require("./UpdateModelAttributeRequest"), exports);
493
497
  __exportStar(require("./UpdateOrderRequest"), exports);
494
498
  __exportStar(require("./UpdateOrderRequestBillingAddress"), exports);
495
- __exportStar(require("./UpdateOrderRequestShippingAddress"), exports);
496
499
  __exportStar(require("./UpdateOverlayTemplateAssetRequest"), exports);
497
500
  __exportStar(require("./UpdateOverlayTemplateRequest"), exports);
498
501
  __exportStar(require("./UpdateProductCategoryRequest"), exports);
@@ -10,7 +10,6 @@ Name | Type
10
10
  `sourceAddressId` | number
11
11
  `addresseeName` | string
12
12
  `company` | string
13
- `addressee` | string
14
13
  `line1` | string
15
14
  `line2` | string
16
15
  `postcode` | string
@@ -30,7 +29,6 @@ const example = {
30
29
  "sourceAddressId": null,
31
30
  "addresseeName": null,
32
31
  "company": null,
33
- "addressee": null,
34
32
  "line1": null,
35
33
  "line2": null,
36
34
  "postcode": null,
@@ -17,10 +17,12 @@ Name | Type
17
17
  `shippingSubtotal` | number
18
18
  `overrideShipping` | boolean
19
19
  `insuranceAmount` | number
20
+ `includeInsurance` | boolean
20
21
  `overrideInsurance` | boolean
21
22
  `useAsBillingAddress` | boolean
22
23
  `netsuiteId` | string
23
24
  `isNetsuiteLocked` | boolean
25
+ `isDisabled` | boolean
24
26
  `omnisendId` | string
25
27
  `subtotal` | number
26
28
  `productDiscountAmount` | number
@@ -64,10 +66,12 @@ const example = {
64
66
  "shippingSubtotal": null,
65
67
  "overrideShipping": null,
66
68
  "insuranceAmount": null,
69
+ "includeInsurance": null,
67
70
  "overrideInsurance": null,
68
71
  "useAsBillingAddress": null,
69
72
  "netsuiteId": null,
70
73
  "isNetsuiteLocked": null,
74
+ "isDisabled": null,
71
75
  "omnisendId": null,
72
76
  "subtotal": null,
73
77
  "productDiscountAmount": null,
@@ -0,0 +1,34 @@
1
+
2
+ # AttachCouponOrderRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `couponCode` | string
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { AttachCouponOrderRequest } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "couponCode": null,
19
+ } satisfies AttachCouponOrderRequest
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 AttachCouponOrderRequest
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
+
@@ -13,6 +13,7 @@ Name | Type
13
13
  `shippingSubtotal` | number
14
14
  `overrideShipping` | boolean
15
15
  `insuranceAmount` | number
16
+ `includeInsurance` | boolean
16
17
  `overrideInsurance` | boolean
17
18
  `useAsBillingAddress` | boolean
18
19
  `expiryDate` | Date
@@ -38,6 +39,7 @@ const example = {
38
39
  "shippingSubtotal": null,
39
40
  "overrideShipping": null,
40
41
  "insuranceAmount": null,
42
+ "includeInsurance": null,
41
43
  "overrideInsurance": null,
42
44
  "useAsBillingAddress": null,
43
45
  "expiryDate": null,
@@ -19,6 +19,7 @@ Name | Type
19
19
  `shippingSubtotal` | number
20
20
  `overrideShipping` | boolean
21
21
  `insuranceSubtotal` | string
22
+ `includeInsurance` | boolean
22
23
  `overrideInsurance` | boolean
23
24
  `useAsBillingAddress` | boolean
24
25
  `admin` | object
@@ -60,6 +61,7 @@ const example = {
60
61
  "shippingSubtotal": null,
61
62
  "overrideShipping": null,
62
63
  "insuranceSubtotal": null,
64
+ "includeInsurance": null,
63
65
  "overrideInsurance": null,
64
66
  "useAsBillingAddress": null,
65
67
  "admin": null,
@@ -0,0 +1,34 @@
1
+
2
+ # DetachCouponOrderRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `couponId` | number
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { DetachCouponOrderRequest } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "couponId": null,
19
+ } satisfies DetachCouponOrderRequest
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 DetachCouponOrderRequest
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
+
@@ -11,6 +11,9 @@ Name | Type
11
11
  `placedAt` | Date
12
12
  `createdAt` | Date
13
13
  `updatedAt` | Date
14
+ `source` | string
15
+ `netsuiteId` | string
16
+ `isNetsuiteLocked` | boolean
14
17
  `subtotal` | number
15
18
  `finalTotalAmount` | number
16
19
  `cartStatusContext` | object
@@ -31,6 +34,9 @@ const example = {
31
34
  "placedAt": null,
32
35
  "createdAt": null,
33
36
  "updatedAt": null,
37
+ "source": null,
38
+ "netsuiteId": null,
39
+ "isNetsuiteLocked": null,
34
40
  "subtotal": null,
35
41
  "finalTotalAmount": null,
36
42
  "cartStatusContext": null,
@@ -0,0 +1,40 @@
1
+
2
+ # OrderStatusWithCountResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `name` | string
11
+ `isOrderNetsuiteSyncable` | boolean
12
+ `ordersCount` | number
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { OrderStatusWithCountResource } from '@digital8/lighting-illusions-ts-sdk'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "id": null,
22
+ "name": null,
23
+ "isOrderNetsuiteSyncable": null,
24
+ "ordersCount": null,
25
+ } satisfies OrderStatusWithCountResource
26
+
27
+ console.log(example)
28
+
29
+ // Convert the instance to a JSON string
30
+ const exampleJSON: string = JSON.stringify(example)
31
+ console.log(exampleJSON)
32
+
33
+ // Parse the JSON string back to an object
34
+ const exampleParsed = JSON.parse(exampleJSON) as OrderStatusWithCountResource
35
+ console.log(exampleParsed)
36
+ ```
37
+
38
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
39
+
40
+
@@ -0,0 +1,34 @@
1
+
2
+ # OrderStatusWithCountResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<OrderStatusWithCountResource>](OrderStatusWithCountResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { OrderStatusWithCountResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies OrderStatusWithCountResourceArrayResponse
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 OrderStatusWithCountResourceArrayResponse
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
@@ -4,8 +4,10 @@ All URIs are relative to *http://localhost/api*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  |------------- | ------------- | -------------|
7
+ | [**attachCouponOrder**](OrdersApi.md#attachcouponorderoperation) | **POST** /admin-api/orders/{order}/coupon/attach | Auto-generated: attachCouponOrder |
7
8
  | [**attachItemOrder**](OrdersApi.md#attachitemorderoperation) | **POST** /admin-api/orders/{order}/line-items/attach | Auto-generated: attachItemOrder |
8
9
  | [**destroyOrder**](OrdersApi.md#destroyorder) | **DELETE** /admin-api/orders/{order}/delete | Auto-generated: destroyOrder |
10
+ | [**detachCouponOrder**](OrdersApi.md#detachcouponorderoperation) | **DELETE** /admin-api/orders/{order}/coupon/detach | Auto-generated: detachCouponOrder |
9
11
  | [**detachItemOrder**](OrdersApi.md#detachitemorder) | **DELETE** /admin-api/orders/{order}/line-items/{lineItem}/detach | Auto-generated: detachItemOrder |
10
12
  | [**getAllOrder**](OrdersApi.md#getallorderoperation) | **POST** /admin-api/orders/all | Auto-generated: getAllOrder |
11
13
  | [**indexOrder**](OrdersApi.md#indexorderoperation) | **POST** /admin-api/orders/list | Auto-generated: indexOrder |
@@ -17,6 +19,74 @@ All URIs are relative to *http://localhost/api*
17
19
 
18
20
 
19
21
 
22
+ ## attachCouponOrder
23
+
24
+ > AdminOrderResource attachCouponOrder(order, attachCouponOrderRequest)
25
+
26
+ Auto-generated: attachCouponOrder
27
+
28
+ ### Example
29
+
30
+ ```ts
31
+ import {
32
+ Configuration,
33
+ OrdersApi,
34
+ } from '@digital8/lighting-illusions-ts-sdk';
35
+ import type { AttachCouponOrderOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
36
+
37
+ async function example() {
38
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
39
+ const api = new OrdersApi();
40
+
41
+ const body = {
42
+ // number | The id of the order
43
+ order: 56,
44
+ // AttachCouponOrderRequest (optional)
45
+ attachCouponOrderRequest: ...,
46
+ } satisfies AttachCouponOrderOperationRequest;
47
+
48
+ try {
49
+ const data = await api.attachCouponOrder(body);
50
+ console.log(data);
51
+ } catch (error) {
52
+ console.error(error);
53
+ }
54
+ }
55
+
56
+ // Run the test
57
+ example().catch(console.error);
58
+ ```
59
+
60
+ ### Parameters
61
+
62
+
63
+ | Name | Type | Description | Notes |
64
+ |------------- | ------------- | ------------- | -------------|
65
+ | **order** | `number` | The id of the order | [Defaults to `undefined`] |
66
+ | **attachCouponOrderRequest** | [AttachCouponOrderRequest](AttachCouponOrderRequest.md) | | [Optional] |
67
+
68
+ ### Return type
69
+
70
+ [**AdminOrderResource**](AdminOrderResource.md)
71
+
72
+ ### Authorization
73
+
74
+ No authorization required
75
+
76
+ ### HTTP request headers
77
+
78
+ - **Content-Type**: `application/json`
79
+ - **Accept**: `application/json`
80
+
81
+
82
+ ### HTTP response details
83
+ | Status code | Description | Response headers |
84
+ |-------------|-------------|------------------|
85
+ | **200** | Successful resource response | - |
86
+
87
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
88
+
89
+
20
90
  ## attachItemOrder
21
91
 
22
92
  > GenericResponse attachItemOrder(order, attachItemOrderRequest)
@@ -150,6 +220,74 @@ No authorization required
150
220
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
151
221
 
152
222
 
223
+ ## detachCouponOrder
224
+
225
+ > AdminOrderResource detachCouponOrder(order, detachCouponOrderRequest)
226
+
227
+ Auto-generated: detachCouponOrder
228
+
229
+ ### Example
230
+
231
+ ```ts
232
+ import {
233
+ Configuration,
234
+ OrdersApi,
235
+ } from '@digital8/lighting-illusions-ts-sdk';
236
+ import type { DetachCouponOrderOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
237
+
238
+ async function example() {
239
+ console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
240
+ const api = new OrdersApi();
241
+
242
+ const body = {
243
+ // number | The id of the order
244
+ order: 56,
245
+ // DetachCouponOrderRequest (optional)
246
+ detachCouponOrderRequest: ...,
247
+ } satisfies DetachCouponOrderOperationRequest;
248
+
249
+ try {
250
+ const data = await api.detachCouponOrder(body);
251
+ console.log(data);
252
+ } catch (error) {
253
+ console.error(error);
254
+ }
255
+ }
256
+
257
+ // Run the test
258
+ example().catch(console.error);
259
+ ```
260
+
261
+ ### Parameters
262
+
263
+
264
+ | Name | Type | Description | Notes |
265
+ |------------- | ------------- | ------------- | -------------|
266
+ | **order** | `number` | The id of the order | [Defaults to `undefined`] |
267
+ | **detachCouponOrderRequest** | [DetachCouponOrderRequest](DetachCouponOrderRequest.md) | | [Optional] |
268
+
269
+ ### Return type
270
+
271
+ [**AdminOrderResource**](AdminOrderResource.md)
272
+
273
+ ### Authorization
274
+
275
+ No authorization required
276
+
277
+ ### HTTP request headers
278
+
279
+ - **Content-Type**: `application/json`
280
+ - **Accept**: `application/json`
281
+
282
+
283
+ ### HTTP response details
284
+ | Status code | Description | Response headers |
285
+ |-------------|-------------|------------------|
286
+ | **200** | Successful resource response | - |
287
+
288
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
289
+
290
+
153
291
  ## detachItemOrder
154
292
 
155
293
  > GenericResponse detachItemOrder(order, lineItem)
@@ -480,7 +618,7 @@ No authorization required
480
618
 
481
619
  ## statusesAllOrder
482
620
 
483
- > GenericResponse statusesAllOrder()
621
+ > OrderStatusWithCountResourceArrayResponse statusesAllOrder()
484
622
 
485
623
  Auto-generated: statusesAllOrder
486
624
 
@@ -515,7 +653,7 @@ This endpoint does not need any parameter.
515
653
 
516
654
  ### Return type
517
655
 
518
- [**GenericResponse**](GenericResponse.md)
656
+ [**OrderStatusWithCountResourceArrayResponse**](OrderStatusWithCountResourceArrayResponse.md)
519
657
 
520
658
  ### Authorization
521
659
 
@@ -530,7 +668,7 @@ No authorization required
530
668
  ### HTTP response details
531
669
  | Status code | Description | Response headers |
532
670
  |-------------|-------------|------------------|
533
- | **200** | Generic JSON success | - |
671
+ | **200** | Successful resource response | - |
534
672
 
535
673
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
536
674
 
@@ -18,6 +18,7 @@ Name | Type
18
18
  `shippingSubtotal` | number
19
19
  `overrideShipping` | boolean
20
20
  `insuranceAmount` | number
21
+ `includeInsurance` | boolean
21
22
  `overrideInsurance` | boolean
22
23
  `useAsBillingAddress` | boolean
23
24
  `shippingAddressId` | number
@@ -44,6 +45,7 @@ const example = {
44
45
  "shippingSubtotal": null,
45
46
  "overrideShipping": null,
46
47
  "insuranceAmount": null,
48
+ "includeInsurance": null,
47
49
  "overrideInsurance": null,
48
50
  "useAsBillingAddress": null,
49
51
  "shippingAddressId": null,
@@ -8,7 +8,6 @@ Name | Type
8
8
  ------------ | -------------
9
9
  `addresseeName` | string
10
10
  `company` | string
11
- `addressee` | string
12
11
  `line1` | string
13
12
  `line2` | string
14
13
  `suburb` | string
@@ -25,7 +24,6 @@ import type { StoreCartRequestShippingAddress } from '@digital8/lighting-illusio
25
24
  const example = {
26
25
  "addresseeName": null,
27
26
  "company": null,
28
- "addressee": null,
29
27
  "line1": null,
30
28
  "line2": null,
31
29
  "suburb": null,
@@ -9,7 +9,7 @@ Name | Type
9
9
  `id` | number
10
10
  `name` | string
11
11
  `hours` | string
12
- `date` | string
12
+ `date` | object
13
13
  `closed` | boolean
14
14
  `displayStartDate` | object
15
15
  `displayEndDate` | object
@@ -9,7 +9,7 @@ Name | Type
9
9
  `id` | number
10
10
  `name` | string
11
11
  `hours` | string
12
- `date` | object
12
+ `date` | string
13
13
  `closed` | boolean
14
14
  `displayStartDate` | string
15
15
  `displayEndDate` | string
@@ -14,6 +14,7 @@ Name | Type
14
14
  `shippingSubtotal` | number
15
15
  `overrideShipping` | boolean
16
16
  `insuranceAmount` | number
17
+ `includeInsurance` | boolean
17
18
  `overrideInsurance` | boolean
18
19
  `useAsBillingAddress` | boolean
19
20
  `shippingAddressId` | number
@@ -36,6 +37,7 @@ const example = {
36
37
  "shippingSubtotal": null,
37
38
  "overrideShipping": null,
38
39
  "insuranceAmount": null,
40
+ "includeInsurance": null,
39
41
  "overrideInsurance": null,
40
42
  "useAsBillingAddress": null,
41
43
  "shippingAddressId": null,