@digital8/lighting-illusions-ts-sdk 0.0.2049 → 0.0.2050
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 +8 -18
- package/README.md +8 -14
- package/dist/apis/CartsApi.d.ts +8 -8
- package/dist/apis/CartsApi.js +8 -8
- package/dist/apis/CustomersApi.d.ts +0 -17
- package/dist/apis/CustomersApi.js +0 -62
- package/dist/apis/OrdersApi.d.ts +8 -8
- package/dist/apis/OrdersApi.js +10 -10
- package/dist/models/AddressFrontendResource.d.ts +2 -2
- package/dist/models/AddressFrontendResource.js +6 -2
- package/dist/models/AddressResource.d.ts +1 -1
- package/dist/models/AddressResource.js +1 -3
- package/dist/models/AdminOrderResource.d.ts +1 -13
- package/dist/models/AdminOrderResource.js +3 -11
- package/dist/models/AttachCouponRequest.d.ts +32 -0
- package/dist/models/AttachCouponRequest.js +51 -0
- package/dist/models/AttachLineItemRequest.d.ts +44 -0
- package/dist/models/{AttachCartItemRequest.js → AttachLineItemRequest.js} +13 -13
- package/dist/models/CartListResource.d.ts +0 -48
- package/dist/models/CartListResource.js +0 -26
- package/dist/models/CartResource.d.ts +2 -2
- package/dist/models/CartResource.js +2 -2
- package/dist/models/DetachCouponRequest.d.ts +32 -0
- package/dist/models/DetachCouponRequest.js +51 -0
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +1 -3
- package/dist/models/UpdateLineItemRequest.d.ts +38 -0
- package/dist/models/{UpdateCartItemRequest.js → UpdateLineItemRequest.js} +13 -13
- package/dist/models/index.d.ts +4 -9
- package/dist/models/index.js +4 -9
- package/docs/AdminOrderResource.md +2 -6
- package/docs/{AttachCartCouponRequest.md → AttachCouponRequest.md} +4 -4
- package/docs/{AttachCartItemRequest.md → AttachLineItemRequest.md} +4 -4
- package/docs/CartListResource.md +0 -16
- package/docs/CartResource.md +2 -2
- package/docs/CartsApi.md +16 -16
- package/docs/CustomersApi.md +0 -69
- package/docs/{DetachCartCouponRequest.md → DetachCouponRequest.md} +4 -4
- package/docs/OrdersApi.md +18 -18
- package/docs/{UpdateCartItemRequest.md → UpdateLineItemRequest.md} +4 -4
- package/package.json +1 -1
- package/src/apis/CartsApi.ts +25 -25
- package/src/apis/CustomersApi.ts +0 -58
- package/src/apis/OrdersApi.ts +26 -26
- package/src/models/AddressFrontendResource.ts +6 -4
- package/src/models/AddressResource.ts +2 -3
- package/src/models/AdminOrderResource.ts +4 -22
- package/src/models/AttachCouponRequest.ts +66 -0
- package/src/models/{AttachCartItemRequest.ts → AttachLineItemRequest.ts} +13 -13
- package/src/models/CartListResource.ts +0 -69
- package/src/models/CartResource.ts +4 -4
- package/src/models/DetachCouponRequest.ts +66 -0
- package/src/models/StoreResource.ts +2 -3
- package/src/models/{UpdateCartItemRequest.ts → UpdateLineItemRequest.ts} +12 -12
- package/src/models/index.ts +4 -9
- package/dist/models/AttachCartCouponRequest.d.ts +0 -32
- package/dist/models/AttachCartCouponRequest.js +0 -51
- package/dist/models/AttachCartItemRequest.d.ts +0 -44
- package/dist/models/AttachOrderCouponRequest.d.ts +0 -32
- package/dist/models/AttachOrderCouponRequest.js +0 -51
- package/dist/models/AttachOrderLineItemRequest.d.ts +0 -44
- package/dist/models/AttachOrderLineItemRequest.js +0 -57
- package/dist/models/DetachCartCouponRequest.d.ts +0 -32
- package/dist/models/DetachCartCouponRequest.js +0 -51
- package/dist/models/DetachOrderCouponRequest.d.ts +0 -32
- package/dist/models/DetachOrderCouponRequest.js +0 -51
- package/dist/models/UpdateCartItemRequest.d.ts +0 -38
- package/dist/models/UpdateCustomerRequest.d.ts +0 -56
- package/dist/models/UpdateCustomerRequest.js +0 -63
- package/dist/models/UpdateOrderLineItemRequest.d.ts +0 -38
- package/dist/models/UpdateOrderLineItemRequest.js +0 -53
- package/docs/AttachOrderCouponRequest.md +0 -34
- package/docs/AttachOrderLineItemRequest.md +0 -38
- package/docs/DetachOrderCouponRequest.md +0 -34
- package/docs/UpdateCustomerRequest.md +0 -42
- package/docs/UpdateOrderLineItemRequest.md +0 -36
- package/src/models/AttachCartCouponRequest.ts +0 -66
- package/src/models/AttachOrderCouponRequest.ts +0 -66
- package/src/models/AttachOrderLineItemRequest.ts +0 -83
- package/src/models/DetachCartCouponRequest.ts +0 -66
- package/src/models/DetachOrderCouponRequest.ts +0 -66
- package/src/models/UpdateCustomerRequest.ts +0 -100
- package/src/models/UpdateOrderLineItemRequest.ts +0 -74
package/dist/models/index.js
CHANGED
|
@@ -39,15 +39,13 @@ __exportStar(require("./AssetWithOverlayLinkResource"), exports);
|
|
|
39
39
|
__exportStar(require("./AssetWithOverlayLinkResourceArrayResponse"), exports);
|
|
40
40
|
__exportStar(require("./AttachAttributesToProductRangeRequest"), exports);
|
|
41
41
|
__exportStar(require("./AttachAttributesToProductRangeRequestAttributesInner"), exports);
|
|
42
|
-
__exportStar(require("./
|
|
43
|
-
__exportStar(require("./AttachCartItemRequest"), exports);
|
|
42
|
+
__exportStar(require("./AttachCouponRequest"), exports);
|
|
44
43
|
__exportStar(require("./AttachDocumentablesToDocumentRequest"), exports);
|
|
45
44
|
__exportStar(require("./AttachDocumentablesToDocumentRequestDocumentablesInner"), exports);
|
|
46
45
|
__exportStar(require("./AttachDocumentsToProductChildRequest"), exports);
|
|
47
46
|
__exportStar(require("./AttachDocumentsToProductChildRequestDocumentsInner"), exports);
|
|
48
47
|
__exportStar(require("./AttachDocumentsToProductRangeRequest"), exports);
|
|
49
|
-
__exportStar(require("./
|
|
50
|
-
__exportStar(require("./AttachOrderLineItemRequest"), exports);
|
|
48
|
+
__exportStar(require("./AttachLineItemRequest"), exports);
|
|
51
49
|
__exportStar(require("./AttachProductChildrenRequest"), exports);
|
|
52
50
|
__exportStar(require("./AttachProductChildrenToProductRangeRequest"), exports);
|
|
53
51
|
__exportStar(require("./AttachProductsToProductCategoryRequest"), exports);
|
|
@@ -155,12 +153,11 @@ __exportStar(require("./DeleteAttributeValueRequest"), exports);
|
|
|
155
153
|
__exportStar(require("./DescriptionResource"), exports);
|
|
156
154
|
__exportStar(require("./DescriptionResourceArrayResponse"), exports);
|
|
157
155
|
__exportStar(require("./DetachAttributesFromProductRangeRequest"), exports);
|
|
158
|
-
__exportStar(require("./
|
|
156
|
+
__exportStar(require("./DetachCouponRequest"), exports);
|
|
159
157
|
__exportStar(require("./DetachDocumentablesFromDocumentRequest"), exports);
|
|
160
158
|
__exportStar(require("./DetachDocumentablesFromDocumentRequestDocumentablesInner"), exports);
|
|
161
159
|
__exportStar(require("./DetachDocumentsFromProductChildRequest"), exports);
|
|
162
160
|
__exportStar(require("./DetachDocumentsFromProductRangeRequest"), exports);
|
|
163
|
-
__exportStar(require("./DetachOrderCouponRequest"), exports);
|
|
164
161
|
__exportStar(require("./DetachProductChildrenFromProductRangeRequest"), exports);
|
|
165
162
|
__exportStar(require("./DetachProductsFromProductCategoryRequest"), exports);
|
|
166
163
|
__exportStar(require("./DetachStoresFromSupplierRequest"), exports);
|
|
@@ -597,17 +594,15 @@ __exportStar(require("./UpdateAttributeProductTypeRequest"), exports);
|
|
|
597
594
|
__exportStar(require("./UpdateAttributeRequest"), exports);
|
|
598
595
|
__exportStar(require("./UpdateAttributeValueRequest"), exports);
|
|
599
596
|
__exportStar(require("./UpdateBlogCategoryRequest"), exports);
|
|
600
|
-
__exportStar(require("./UpdateCartItemRequest"), exports);
|
|
601
597
|
__exportStar(require("./UpdateCartRequest"), exports);
|
|
602
|
-
__exportStar(require("./UpdateCustomerRequest"), exports);
|
|
603
598
|
__exportStar(require("./UpdateDefinitionRequest"), exports);
|
|
604
599
|
__exportStar(require("./UpdateDocumentRequest"), exports);
|
|
605
600
|
__exportStar(require("./UpdateLabelRequest"), exports);
|
|
601
|
+
__exportStar(require("./UpdateLineItemRequest"), exports);
|
|
606
602
|
__exportStar(require("./UpdateMenuItemRequest"), exports);
|
|
607
603
|
__exportStar(require("./UpdateMenuRequest"), exports);
|
|
608
604
|
__exportStar(require("./UpdateMenuRequestMenuItemOrderInner"), exports);
|
|
609
605
|
__exportStar(require("./UpdateModelAttributeRequest"), exports);
|
|
610
|
-
__exportStar(require("./UpdateOrderLineItemRequest"), exports);
|
|
611
606
|
__exportStar(require("./UpdateOrderRequest"), exports);
|
|
612
607
|
__exportStar(require("./UpdateOverlayTemplateAssetRequest"), exports);
|
|
613
608
|
__exportStar(require("./UpdateOverlayTemplateRequest"), exports);
|
|
@@ -16,7 +16,7 @@ Name | Type
|
|
|
16
16
|
`shippingType` | string
|
|
17
17
|
`shippingSubtotal` | number
|
|
18
18
|
`overrideShipping` | boolean
|
|
19
|
-
`
|
|
19
|
+
`lockedInsuranceAmount` | number
|
|
20
20
|
`includeInsurance` | boolean
|
|
21
21
|
`overrideInsurance` | boolean
|
|
22
22
|
`useAsBillingAddress` | boolean
|
|
@@ -36,8 +36,6 @@ Name | Type
|
|
|
36
36
|
`grandTotal` | number
|
|
37
37
|
`totalPaid` | number
|
|
38
38
|
`totalOutstanding` | number
|
|
39
|
-
`discountPreview` | number
|
|
40
|
-
`shippingEstimate` | number
|
|
41
39
|
`insuranceEstimate` | number
|
|
42
40
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
43
41
|
`customer` | [CustomerResource](CustomerResource.md)
|
|
@@ -68,7 +66,7 @@ const example = {
|
|
|
68
66
|
"shippingType": null,
|
|
69
67
|
"shippingSubtotal": null,
|
|
70
68
|
"overrideShipping": null,
|
|
71
|
-
"
|
|
69
|
+
"lockedInsuranceAmount": null,
|
|
72
70
|
"includeInsurance": null,
|
|
73
71
|
"overrideInsurance": null,
|
|
74
72
|
"useAsBillingAddress": null,
|
|
@@ -88,8 +86,6 @@ const example = {
|
|
|
88
86
|
"grandTotal": null,
|
|
89
87
|
"totalPaid": null,
|
|
90
88
|
"totalOutstanding": null,
|
|
91
|
-
"discountPreview": null,
|
|
92
|
-
"shippingEstimate": null,
|
|
93
89
|
"insuranceEstimate": null,
|
|
94
90
|
"site": null,
|
|
95
91
|
"customer": null,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AttachCouponRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -11,12 +11,12 @@ Name | Type
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { AttachCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
18
|
"couponCode": null,
|
|
19
|
-
} satisfies
|
|
19
|
+
} satisfies AttachCouponRequest
|
|
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 AttachCouponRequest
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# AttachLineItemRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -13,14 +13,14 @@ Name | Type
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import type {
|
|
16
|
+
import type { AttachLineItemRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
17
17
|
|
|
18
18
|
// TODO: Update the object below with actual values
|
|
19
19
|
const example = {
|
|
20
20
|
"productChildId": null,
|
|
21
21
|
"quantity": null,
|
|
22
22
|
"productPrice": null,
|
|
23
|
-
} satisfies
|
|
23
|
+
} satisfies AttachLineItemRequest
|
|
24
24
|
|
|
25
25
|
console.log(example)
|
|
26
26
|
|
|
@@ -29,7 +29,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
29
29
|
console.log(exampleJSON)
|
|
30
30
|
|
|
31
31
|
// Parse the JSON string back to an object
|
|
32
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as AttachLineItemRequest
|
|
33
33
|
console.log(exampleParsed)
|
|
34
34
|
```
|
|
35
35
|
|
package/docs/CartListResource.md
CHANGED
|
@@ -9,14 +9,6 @@ Name | Type
|
|
|
9
9
|
`id` | number
|
|
10
10
|
`guestEmail` | string
|
|
11
11
|
`source` | string
|
|
12
|
-
`shippingType` | string
|
|
13
|
-
`shippingSubtotal` | number
|
|
14
|
-
`overrideShipping` | boolean
|
|
15
|
-
`insuranceAmount` | number
|
|
16
|
-
`includeInsurance` | boolean
|
|
17
|
-
`overrideInsurance` | boolean
|
|
18
|
-
`useAsBillingAddress` | boolean
|
|
19
|
-
`expiryDate` | Date
|
|
20
12
|
`checkoutCompletedAt` | Date
|
|
21
13
|
`createdAt` | Date
|
|
22
14
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
@@ -35,14 +27,6 @@ const example = {
|
|
|
35
27
|
"id": null,
|
|
36
28
|
"guestEmail": null,
|
|
37
29
|
"source": null,
|
|
38
|
-
"shippingType": null,
|
|
39
|
-
"shippingSubtotal": null,
|
|
40
|
-
"overrideShipping": null,
|
|
41
|
-
"insuranceAmount": null,
|
|
42
|
-
"includeInsurance": null,
|
|
43
|
-
"overrideInsurance": null,
|
|
44
|
-
"useAsBillingAddress": null,
|
|
45
|
-
"expiryDate": null,
|
|
46
30
|
"checkoutCompletedAt": null,
|
|
47
31
|
"createdAt": null,
|
|
48
32
|
"site": null,
|
package/docs/CartResource.md
CHANGED
|
@@ -18,7 +18,7 @@ Name | Type
|
|
|
18
18
|
`shippingType` | string
|
|
19
19
|
`shippingSubtotal` | number
|
|
20
20
|
`overrideShipping` | boolean
|
|
21
|
-
`
|
|
21
|
+
`lockedInsuranceAmount` | string
|
|
22
22
|
`includeInsurance` | boolean
|
|
23
23
|
`overrideInsurance` | boolean
|
|
24
24
|
`useAsBillingAddress` | boolean
|
|
@@ -60,7 +60,7 @@ const example = {
|
|
|
60
60
|
"shippingType": null,
|
|
61
61
|
"shippingSubtotal": null,
|
|
62
62
|
"overrideShipping": null,
|
|
63
|
-
"
|
|
63
|
+
"lockedInsuranceAmount": null,
|
|
64
64
|
"includeInsurance": null,
|
|
65
65
|
"overrideInsurance": null,
|
|
66
66
|
"useAsBillingAddress": null,
|
package/docs/CartsApi.md
CHANGED
|
@@ -21,7 +21,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
21
21
|
|
|
22
22
|
## attachCouponCart
|
|
23
23
|
|
|
24
|
-
> CartResource attachCouponCart(cart,
|
|
24
|
+
> CartResource attachCouponCart(cart, attachCouponRequest)
|
|
25
25
|
|
|
26
26
|
Auto-generated: attachCouponCart
|
|
27
27
|
|
|
@@ -41,8 +41,8 @@ async function example() {
|
|
|
41
41
|
const body = {
|
|
42
42
|
// number | The id of the cart
|
|
43
43
|
cart: 56,
|
|
44
|
-
//
|
|
45
|
-
|
|
44
|
+
// AttachCouponRequest (optional)
|
|
45
|
+
attachCouponRequest: ...,
|
|
46
46
|
} satisfies AttachCouponCartRequest;
|
|
47
47
|
|
|
48
48
|
try {
|
|
@@ -63,7 +63,7 @@ example().catch(console.error);
|
|
|
63
63
|
| Name | Type | Description | Notes |
|
|
64
64
|
|------------- | ------------- | ------------- | -------------|
|
|
65
65
|
| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
|
|
66
|
-
| **
|
|
66
|
+
| **attachCouponRequest** | [AttachCouponRequest](AttachCouponRequest.md) | | [Optional] |
|
|
67
67
|
|
|
68
68
|
### Return type
|
|
69
69
|
|
|
@@ -89,7 +89,7 @@ No authorization required
|
|
|
89
89
|
|
|
90
90
|
## attachItemCart
|
|
91
91
|
|
|
92
|
-
> CartResource attachItemCart(cart,
|
|
92
|
+
> CartResource attachItemCart(cart, attachLineItemRequest)
|
|
93
93
|
|
|
94
94
|
Auto-generated: attachItemCart
|
|
95
95
|
|
|
@@ -109,8 +109,8 @@ async function example() {
|
|
|
109
109
|
const body = {
|
|
110
110
|
// number | The id of the cart
|
|
111
111
|
cart: 56,
|
|
112
|
-
//
|
|
113
|
-
|
|
112
|
+
// AttachLineItemRequest (optional)
|
|
113
|
+
attachLineItemRequest: ...,
|
|
114
114
|
} satisfies AttachItemCartRequest;
|
|
115
115
|
|
|
116
116
|
try {
|
|
@@ -131,7 +131,7 @@ example().catch(console.error);
|
|
|
131
131
|
| Name | Type | Description | Notes |
|
|
132
132
|
|------------- | ------------- | ------------- | -------------|
|
|
133
133
|
| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
|
|
134
|
-
| **
|
|
134
|
+
| **attachLineItemRequest** | [AttachLineItemRequest](AttachLineItemRequest.md) | | [Optional] |
|
|
135
135
|
|
|
136
136
|
### Return type
|
|
137
137
|
|
|
@@ -222,7 +222,7 @@ No authorization required
|
|
|
222
222
|
|
|
223
223
|
## detachCouponCart
|
|
224
224
|
|
|
225
|
-
> CartResource detachCouponCart(cart,
|
|
225
|
+
> CartResource detachCouponCart(cart, detachCouponRequest)
|
|
226
226
|
|
|
227
227
|
Auto-generated: detachCouponCart
|
|
228
228
|
|
|
@@ -242,8 +242,8 @@ async function example() {
|
|
|
242
242
|
const body = {
|
|
243
243
|
// number | The id of the cart
|
|
244
244
|
cart: 56,
|
|
245
|
-
//
|
|
246
|
-
|
|
245
|
+
// DetachCouponRequest (optional)
|
|
246
|
+
detachCouponRequest: ...,
|
|
247
247
|
} satisfies DetachCouponCartRequest;
|
|
248
248
|
|
|
249
249
|
try {
|
|
@@ -264,7 +264,7 @@ example().catch(console.error);
|
|
|
264
264
|
| Name | Type | Description | Notes |
|
|
265
265
|
|------------- | ------------- | ------------- | -------------|
|
|
266
266
|
| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
|
|
267
|
-
| **
|
|
267
|
+
| **detachCouponRequest** | [DetachCouponRequest](DetachCouponRequest.md) | | [Optional] |
|
|
268
268
|
|
|
269
269
|
### Return type
|
|
270
270
|
|
|
@@ -751,7 +751,7 @@ No authorization required
|
|
|
751
751
|
|
|
752
752
|
## updateItemCart
|
|
753
753
|
|
|
754
|
-
> CartResource updateItemCart(cart, lineItem,
|
|
754
|
+
> CartResource updateItemCart(cart, lineItem, updateLineItemRequest)
|
|
755
755
|
|
|
756
756
|
Auto-generated: updateItemCart
|
|
757
757
|
|
|
@@ -773,8 +773,8 @@ async function example() {
|
|
|
773
773
|
cart: 56,
|
|
774
774
|
// number | The id of the lineItem
|
|
775
775
|
lineItem: 56,
|
|
776
|
-
//
|
|
777
|
-
|
|
776
|
+
// UpdateLineItemRequest (optional)
|
|
777
|
+
updateLineItemRequest: ...,
|
|
778
778
|
} satisfies UpdateItemCartRequest;
|
|
779
779
|
|
|
780
780
|
try {
|
|
@@ -796,7 +796,7 @@ example().catch(console.error);
|
|
|
796
796
|
|------------- | ------------- | ------------- | -------------|
|
|
797
797
|
| **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
|
|
798
798
|
| **lineItem** | `number` | The id of the lineItem | [Defaults to `undefined`] |
|
|
799
|
-
| **
|
|
799
|
+
| **updateLineItemRequest** | [UpdateLineItemRequest](UpdateLineItemRequest.md) | | [Optional] |
|
|
800
800
|
|
|
801
801
|
### Return type
|
|
802
802
|
|
package/docs/CustomersApi.md
CHANGED
|
@@ -7,7 +7,6 @@ All URIs are relative to *http://localhost/api*
|
|
|
7
7
|
| [**indexCustomer**](CustomersApi.md#indexcustomer) | **POST** /admin-api/customers/list | Auto-generated: indexCustomer |
|
|
8
8
|
| [**showCustomer**](CustomersApi.md#showcustomer) | **GET** /admin-api/customers/{customer} | Auto-generated: showCustomer |
|
|
9
9
|
| [**storeCustomer**](CustomersApi.md#storecustomer) | **POST** /admin-api/customers/create | Auto-generated: storeCustomer |
|
|
10
|
-
| [**updateCustomer**](CustomersApi.md#updatecustomeroperation) | **PUT** /admin-api/customers/{customer}/update | Auto-generated: updateCustomer |
|
|
11
10
|
|
|
12
11
|
|
|
13
12
|
|
|
@@ -205,71 +204,3 @@ No authorization required
|
|
|
205
204
|
|
|
206
205
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
207
206
|
|
|
208
|
-
|
|
209
|
-
## updateCustomer
|
|
210
|
-
|
|
211
|
-
> CustomerResource updateCustomer(customer, updateCustomerRequest)
|
|
212
|
-
|
|
213
|
-
Auto-generated: updateCustomer
|
|
214
|
-
|
|
215
|
-
### Example
|
|
216
|
-
|
|
217
|
-
```ts
|
|
218
|
-
import {
|
|
219
|
-
Configuration,
|
|
220
|
-
CustomersApi,
|
|
221
|
-
} from '@digital8/lighting-illusions-ts-sdk';
|
|
222
|
-
import type { UpdateCustomerOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
223
|
-
|
|
224
|
-
async function example() {
|
|
225
|
-
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
226
|
-
const api = new CustomersApi();
|
|
227
|
-
|
|
228
|
-
const body = {
|
|
229
|
-
// number | The id of the customer
|
|
230
|
-
customer: 56,
|
|
231
|
-
// UpdateCustomerRequest (optional)
|
|
232
|
-
updateCustomerRequest: ...,
|
|
233
|
-
} satisfies UpdateCustomerOperationRequest;
|
|
234
|
-
|
|
235
|
-
try {
|
|
236
|
-
const data = await api.updateCustomer(body);
|
|
237
|
-
console.log(data);
|
|
238
|
-
} catch (error) {
|
|
239
|
-
console.error(error);
|
|
240
|
-
}
|
|
241
|
-
}
|
|
242
|
-
|
|
243
|
-
// Run the test
|
|
244
|
-
example().catch(console.error);
|
|
245
|
-
```
|
|
246
|
-
|
|
247
|
-
### Parameters
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
| Name | Type | Description | Notes |
|
|
251
|
-
|------------- | ------------- | ------------- | -------------|
|
|
252
|
-
| **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
|
|
253
|
-
| **updateCustomerRequest** | [UpdateCustomerRequest](UpdateCustomerRequest.md) | | [Optional] |
|
|
254
|
-
|
|
255
|
-
### Return type
|
|
256
|
-
|
|
257
|
-
[**CustomerResource**](CustomerResource.md)
|
|
258
|
-
|
|
259
|
-
### Authorization
|
|
260
|
-
|
|
261
|
-
No authorization required
|
|
262
|
-
|
|
263
|
-
### HTTP request headers
|
|
264
|
-
|
|
265
|
-
- **Content-Type**: `application/json`
|
|
266
|
-
- **Accept**: `application/json`
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
### HTTP response details
|
|
270
|
-
| Status code | Description | Response headers |
|
|
271
|
-
|-------------|-------------|------------------|
|
|
272
|
-
| **200** | Successful resource response | - |
|
|
273
|
-
|
|
274
|
-
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
275
|
-
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# DetachCouponRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -11,12 +11,12 @@ Name | Type
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import type {
|
|
14
|
+
import type { DetachCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
15
|
|
|
16
16
|
// TODO: Update the object below with actual values
|
|
17
17
|
const example = {
|
|
18
18
|
"couponIds": null,
|
|
19
|
-
} satisfies
|
|
19
|
+
} satisfies DetachCouponRequest
|
|
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 DetachCouponRequest
|
|
29
29
|
console.log(exampleParsed)
|
|
30
30
|
```
|
|
31
31
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -4,10 +4,10 @@ All URIs are relative to *http://localhost/api*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**attachCouponOrder**](OrdersApi.md#attachcouponorder) | **POST** /admin-api/orders/{order}/
|
|
7
|
+
| [**attachCouponOrder**](OrdersApi.md#attachcouponorder) | **POST** /admin-api/orders/{order}/coupons/attach | Auto-generated: attachCouponOrder |
|
|
8
8
|
| [**attachItemOrder**](OrdersApi.md#attachitemorder) | **POST** /admin-api/orders/{order}/line-items/attach | Auto-generated: attachItemOrder |
|
|
9
9
|
| [**destroyOrder**](OrdersApi.md#destroyorder) | **DELETE** /admin-api/orders/{order}/delete | Auto-generated: destroyOrder |
|
|
10
|
-
| [**detachCouponOrder**](OrdersApi.md#detachcouponorder) | **DELETE** /admin-api/orders/{order}/
|
|
10
|
+
| [**detachCouponOrder**](OrdersApi.md#detachcouponorder) | **DELETE** /admin-api/orders/{order}/coupons/detach | Auto-generated: detachCouponOrder |
|
|
11
11
|
| [**detachItemOrder**](OrdersApi.md#detachitemorder) | **DELETE** /admin-api/orders/{order}/line-items/{lineItem}/detach | Auto-generated: detachItemOrder |
|
|
12
12
|
| [**getAllOrder**](OrdersApi.md#getallorder) | **POST** /admin-api/orders/all | Auto-generated: getAllOrder |
|
|
13
13
|
| [**indexOrder**](OrdersApi.md#indexorder) | **POST** /admin-api/orders/list | Auto-generated: indexOrder |
|
|
@@ -21,7 +21,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
21
21
|
|
|
22
22
|
## attachCouponOrder
|
|
23
23
|
|
|
24
|
-
> AdminOrderResource attachCouponOrder(order,
|
|
24
|
+
> AdminOrderResource attachCouponOrder(order, attachCouponRequest)
|
|
25
25
|
|
|
26
26
|
Auto-generated: attachCouponOrder
|
|
27
27
|
|
|
@@ -41,8 +41,8 @@ async function example() {
|
|
|
41
41
|
const body = {
|
|
42
42
|
// number | The id of the order
|
|
43
43
|
order: 56,
|
|
44
|
-
//
|
|
45
|
-
|
|
44
|
+
// AttachCouponRequest (optional)
|
|
45
|
+
attachCouponRequest: ...,
|
|
46
46
|
} satisfies AttachCouponOrderRequest;
|
|
47
47
|
|
|
48
48
|
try {
|
|
@@ -63,7 +63,7 @@ example().catch(console.error);
|
|
|
63
63
|
| Name | Type | Description | Notes |
|
|
64
64
|
|------------- | ------------- | ------------- | -------------|
|
|
65
65
|
| **order** | `number` | The id of the order | [Defaults to `undefined`] |
|
|
66
|
-
| **
|
|
66
|
+
| **attachCouponRequest** | [AttachCouponRequest](AttachCouponRequest.md) | | [Optional] |
|
|
67
67
|
|
|
68
68
|
### Return type
|
|
69
69
|
|
|
@@ -89,7 +89,7 @@ No authorization required
|
|
|
89
89
|
|
|
90
90
|
## attachItemOrder
|
|
91
91
|
|
|
92
|
-
> AdminOrderResource attachItemOrder(order,
|
|
92
|
+
> AdminOrderResource attachItemOrder(order, attachLineItemRequest)
|
|
93
93
|
|
|
94
94
|
Auto-generated: attachItemOrder
|
|
95
95
|
|
|
@@ -109,8 +109,8 @@ async function example() {
|
|
|
109
109
|
const body = {
|
|
110
110
|
// number | The id of the order
|
|
111
111
|
order: 56,
|
|
112
|
-
//
|
|
113
|
-
|
|
112
|
+
// AttachLineItemRequest (optional)
|
|
113
|
+
attachLineItemRequest: ...,
|
|
114
114
|
} satisfies AttachItemOrderRequest;
|
|
115
115
|
|
|
116
116
|
try {
|
|
@@ -131,7 +131,7 @@ example().catch(console.error);
|
|
|
131
131
|
| Name | Type | Description | Notes |
|
|
132
132
|
|------------- | ------------- | ------------- | -------------|
|
|
133
133
|
| **order** | `number` | The id of the order | [Defaults to `undefined`] |
|
|
134
|
-
| **
|
|
134
|
+
| **attachLineItemRequest** | [AttachLineItemRequest](AttachLineItemRequest.md) | | [Optional] |
|
|
135
135
|
|
|
136
136
|
### Return type
|
|
137
137
|
|
|
@@ -222,7 +222,7 @@ No authorization required
|
|
|
222
222
|
|
|
223
223
|
## detachCouponOrder
|
|
224
224
|
|
|
225
|
-
> AdminOrderResource detachCouponOrder(order,
|
|
225
|
+
> AdminOrderResource detachCouponOrder(order, detachCouponRequest)
|
|
226
226
|
|
|
227
227
|
Auto-generated: detachCouponOrder
|
|
228
228
|
|
|
@@ -242,8 +242,8 @@ async function example() {
|
|
|
242
242
|
const body = {
|
|
243
243
|
// number | The id of the order
|
|
244
244
|
order: 56,
|
|
245
|
-
//
|
|
246
|
-
|
|
245
|
+
// DetachCouponRequest (optional)
|
|
246
|
+
detachCouponRequest: ...,
|
|
247
247
|
} satisfies DetachCouponOrderRequest;
|
|
248
248
|
|
|
249
249
|
try {
|
|
@@ -264,7 +264,7 @@ example().catch(console.error);
|
|
|
264
264
|
| Name | Type | Description | Notes |
|
|
265
265
|
|------------- | ------------- | ------------- | -------------|
|
|
266
266
|
| **order** | `number` | The id of the order | [Defaults to `undefined`] |
|
|
267
|
-
| **
|
|
267
|
+
| **detachCouponRequest** | [DetachCouponRequest](DetachCouponRequest.md) | | [Optional] |
|
|
268
268
|
|
|
269
269
|
### Return type
|
|
270
270
|
|
|
@@ -675,7 +675,7 @@ No authorization required
|
|
|
675
675
|
|
|
676
676
|
## updateItemOrder
|
|
677
677
|
|
|
678
|
-
> AdminOrderResource updateItemOrder(order, lineItem,
|
|
678
|
+
> AdminOrderResource updateItemOrder(order, lineItem, updateLineItemRequest)
|
|
679
679
|
|
|
680
680
|
Auto-generated: updateItemOrder
|
|
681
681
|
|
|
@@ -697,8 +697,8 @@ async function example() {
|
|
|
697
697
|
order: 56,
|
|
698
698
|
// number | The id of the lineItem
|
|
699
699
|
lineItem: 56,
|
|
700
|
-
//
|
|
701
|
-
|
|
700
|
+
// UpdateLineItemRequest (optional)
|
|
701
|
+
updateLineItemRequest: ...,
|
|
702
702
|
} satisfies UpdateItemOrderRequest;
|
|
703
703
|
|
|
704
704
|
try {
|
|
@@ -720,7 +720,7 @@ example().catch(console.error);
|
|
|
720
720
|
|------------- | ------------- | ------------- | -------------|
|
|
721
721
|
| **order** | `number` | The id of the order | [Defaults to `undefined`] |
|
|
722
722
|
| **lineItem** | `number` | The id of the lineItem | [Defaults to `undefined`] |
|
|
723
|
-
| **
|
|
723
|
+
| **updateLineItemRequest** | [UpdateLineItemRequest](UpdateLineItemRequest.md) | | [Optional] |
|
|
724
724
|
|
|
725
725
|
### Return type
|
|
726
726
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
|
|
2
|
-
#
|
|
2
|
+
# UpdateLineItemRequest
|
|
3
3
|
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
@@ -12,13 +12,13 @@ Name | Type
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import type {
|
|
15
|
+
import type { UpdateLineItemRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
16
|
|
|
17
17
|
// TODO: Update the object below with actual values
|
|
18
18
|
const example = {
|
|
19
19
|
"quantity": null,
|
|
20
20
|
"productPrice": null,
|
|
21
|
-
} satisfies
|
|
21
|
+
} satisfies UpdateLineItemRequest
|
|
22
22
|
|
|
23
23
|
console.log(example)
|
|
24
24
|
|
|
@@ -27,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
|
|
|
27
27
|
console.log(exampleJSON)
|
|
28
28
|
|
|
29
29
|
// Parse the JSON string back to an object
|
|
30
|
-
const exampleParsed = JSON.parse(exampleJSON) as
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as UpdateLineItemRequest
|
|
31
31
|
console.log(exampleParsed)
|
|
32
32
|
```
|
|
33
33
|
|