@digital8/lighting-illusions-ts-sdk 0.0.2031 → 0.0.2033
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 -0
- package/README.md +7 -2
- package/dist/apis/ProductApi.d.ts +16 -0
- package/dist/apis/ProductApi.js +59 -0
- package/dist/apis/TransactionsApi.d.ts +3 -3
- package/dist/apis/TransactionsApi.js +2 -2
- package/dist/models/AddressFrontendResource.d.ts +2 -2
- package/dist/models/AddressFrontendResource.js +4 -4
- package/dist/models/AddressResource.d.ts +7 -1
- package/dist/models/AddressResource.js +5 -1
- package/dist/models/AdminNoteResource.d.ts +0 -12
- package/dist/models/AdminNoteResource.js +0 -8
- package/dist/models/AdminOrderResource.d.ts +3 -3
- package/dist/models/AdminOrderResource.js +3 -3
- package/dist/models/CartResource.d.ts +3 -3
- package/dist/models/CartResource.js +3 -3
- package/dist/models/CreateTransactionRequest.d.ts +6 -0
- package/dist/models/CreateTransactionRequest.js +2 -0
- package/dist/models/CustomerListResource.d.ts +0 -7
- package/dist/models/CustomerListResource.js +0 -5
- package/dist/models/PaginatedTransactionListResourceResponse.d.ts +40 -0
- package/dist/models/PaginatedTransactionListResourceResponse.js +57 -0
- package/dist/models/SkuSearchProductChildRequest.d.ts +38 -0
- package/dist/models/SkuSearchProductChildRequest.js +55 -0
- package/dist/models/StoreFrontendResource.d.ts +2 -2
- package/dist/models/StoreFrontendResource.js +4 -4
- package/dist/models/StoreListResource.d.ts +1 -1
- package/dist/models/StoreListResource.js +1 -3
- package/dist/models/StoreResource.d.ts +1 -1
- package/dist/models/StoreResource.js +3 -1
- package/dist/models/TransactionListResource.d.ts +116 -0
- package/dist/models/TransactionListResource.js +97 -0
- package/dist/models/TransactionListResourceArrayResponse.d.ts +33 -0
- package/dist/models/TransactionListResourceArrayResponse.js +50 -0
- package/dist/models/TransactionLiteResource.d.ts +12 -0
- package/dist/models/TransactionLiteResource.js +4 -0
- package/dist/models/UpdateOrderRequest.d.ts +6 -0
- package/dist/models/UpdateOrderRequest.js +2 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/docs/AddressResource.md +2 -0
- package/docs/AdminNoteResource.md +0 -4
- package/docs/AdminOrderResource.md +1 -1
- package/docs/CartResource.md +1 -1
- package/docs/CreateTransactionRequest.md +2 -0
- package/docs/CustomerListResource.md +0 -2
- package/docs/PaginatedTransactionListResourceResponse.md +36 -0
- package/docs/ProductApi.md +66 -0
- package/docs/SkuSearchProductChildRequest.md +36 -0
- package/docs/TransactionListResource.md +62 -0
- package/docs/TransactionListResourceArrayResponse.md +34 -0
- package/docs/TransactionLiteResource.md +4 -0
- package/docs/TransactionsApi.md +3 -3
- package/docs/UpdateOrderRequest.md +2 -0
- package/package.json +1 -1
- package/src/apis/ProductApi.ts +49 -0
- package/src/apis/TransactionsApi.ts +7 -7
- package/src/models/AddressFrontendResource.ts +5 -5
- package/src/models/AddressResource.ts +11 -2
- package/src/models/AdminNoteResource.ts +0 -18
- package/src/models/AdminOrderResource.ts +11 -11
- package/src/models/CartResource.ts +11 -11
- package/src/models/CreateTransactionRequest.ts +8 -0
- package/src/models/CustomerListResource.ts +0 -16
- package/src/models/PaginatedTransactionListResourceResponse.ts +90 -0
- package/src/models/SkuSearchProductChildRequest.ts +75 -0
- package/src/models/StoreFrontendResource.ts +5 -5
- package/src/models/StoreListResource.ts +2 -3
- package/src/models/StoreResource.ts +3 -2
- package/src/models/TransactionListResource.ts +187 -0
- package/src/models/TransactionListResourceArrayResponse.ts +73 -0
- package/src/models/TransactionLiteResource.ts +16 -0
- package/src/models/UpdateOrderRequest.ts +8 -0
- package/src/models/index.ts +4 -0
package/dist/models/index.js
CHANGED
|
@@ -345,6 +345,7 @@ __exportStar(require("./PaginatedSupplierResourceResponse"), exports);
|
|
|
345
345
|
__exportStar(require("./PaginatedTagListResourceResponse"), exports);
|
|
346
346
|
__exportStar(require("./PaginatedTagLiteResourceResponse"), exports);
|
|
347
347
|
__exportStar(require("./PaginatedTagResourceResponse"), exports);
|
|
348
|
+
__exportStar(require("./PaginatedTransactionListResourceResponse"), exports);
|
|
348
349
|
__exportStar(require("./PaginatedTransactionResourceResponse"), exports);
|
|
349
350
|
__exportStar(require("./PagingMetadata"), exports);
|
|
350
351
|
__exportStar(require("./PaymentMethod"), exports);
|
|
@@ -546,6 +547,7 @@ __exportStar(require("./SitePaymentConfigResource"), exports);
|
|
|
546
547
|
__exportStar(require("./SitePaymentConfigResourceArrayResponse"), exports);
|
|
547
548
|
__exportStar(require("./SiteResource"), exports);
|
|
548
549
|
__exportStar(require("./SiteResourceArrayResponse"), exports);
|
|
550
|
+
__exportStar(require("./SkuSearchProductChildRequest"), exports);
|
|
549
551
|
__exportStar(require("./StoreFrontendResource"), exports);
|
|
550
552
|
__exportStar(require("./StoreFrontendResourceArrayResponse"), exports);
|
|
551
553
|
__exportStar(require("./StoreListResource"), exports);
|
|
@@ -580,6 +582,8 @@ __exportStar(require("./TagResource"), exports);
|
|
|
580
582
|
__exportStar(require("./TagResourceArrayResponse"), exports);
|
|
581
583
|
__exportStar(require("./TagType"), exports);
|
|
582
584
|
__exportStar(require("./Thumbnail"), exports);
|
|
585
|
+
__exportStar(require("./TransactionListResource"), exports);
|
|
586
|
+
__exportStar(require("./TransactionListResourceArrayResponse"), exports);
|
|
583
587
|
__exportStar(require("./TransactionLiteResource"), exports);
|
|
584
588
|
__exportStar(require("./TransactionLiteResourceArrayResponse"), exports);
|
|
585
589
|
__exportStar(require("./TransactionResource"), exports);
|
package/docs/AddressResource.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
+
`type` | string
|
|
10
11
|
`sourceAddressId` | number
|
|
11
12
|
`addresseeName` | string
|
|
12
13
|
`company` | string
|
|
@@ -26,6 +27,7 @@ import type { AddressResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
|
26
27
|
// TODO: Update the object below with actual values
|
|
27
28
|
const example = {
|
|
28
29
|
"id": null,
|
|
30
|
+
"type": null,
|
|
29
31
|
"sourceAddressId": null,
|
|
30
32
|
"addresseeName": null,
|
|
31
33
|
"company": null,
|
|
@@ -7,8 +7,6 @@
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
9
|
`id` | number
|
|
10
|
-
`orderId` | number
|
|
11
|
-
`adminId` | number
|
|
12
10
|
`note` | string
|
|
13
11
|
`createdAt` | Date
|
|
14
12
|
`updatedAt` | Date
|
|
@@ -22,8 +20,6 @@ import type { AdminNoteResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
|
22
20
|
// TODO: Update the object below with actual values
|
|
23
21
|
const example = {
|
|
24
22
|
"id": null,
|
|
25
|
-
"orderId": null,
|
|
26
|
-
"adminId": null,
|
|
27
23
|
"note": null,
|
|
28
24
|
"createdAt": null,
|
|
29
25
|
"updatedAt": null,
|
|
@@ -40,7 +40,7 @@ Name | Type
|
|
|
40
40
|
`shippingEstimate` | number
|
|
41
41
|
`insuranceEstimate` | number
|
|
42
42
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
43
|
-
`customer` | [
|
|
43
|
+
`customer` | [CustomerResource](CustomerResource.md)
|
|
44
44
|
`admin` | [LiAdminUserLiteResource](LiAdminUserLiteResource.md)
|
|
45
45
|
`status` | [OrderStatusLiteResource](OrderStatusLiteResource.md)
|
|
46
46
|
`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
|
package/docs/CartResource.md
CHANGED
|
@@ -24,7 +24,7 @@ Name | Type
|
|
|
24
24
|
`useAsBillingAddress` | boolean
|
|
25
25
|
`admin` | [LiAdminUserLiteResource](LiAdminUserLiteResource.md)
|
|
26
26
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
27
|
-
`customer` | [
|
|
27
|
+
`customer` | [CustomerResource](CustomerResource.md)
|
|
28
28
|
`lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
|
|
29
29
|
`coupons` | object
|
|
30
30
|
`shippingAddress` | [AddressResource](AddressResource.md)
|
|
@@ -11,6 +11,7 @@ Name | Type
|
|
|
11
11
|
`amount` | number
|
|
12
12
|
`surcharge` | number
|
|
13
13
|
`paymentMethod` | string
|
|
14
|
+
`description` | string
|
|
14
15
|
`nonce` | string
|
|
15
16
|
`deviceData` | string
|
|
16
17
|
|
|
@@ -26,6 +27,7 @@ const example = {
|
|
|
26
27
|
"amount": null,
|
|
27
28
|
"surcharge": null,
|
|
28
29
|
"paymentMethod": null,
|
|
30
|
+
"description": null,
|
|
29
31
|
"nonce": null,
|
|
30
32
|
"deviceData": null,
|
|
31
33
|
} satisfies CreateTransactionRequest
|
|
@@ -12,7 +12,6 @@ Name | Type
|
|
|
12
12
|
`email` | string
|
|
13
13
|
`phone` | string
|
|
14
14
|
`site` | [SiteLiteResource](SiteLiteResource.md)
|
|
15
|
-
`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
|
|
16
15
|
|
|
17
16
|
## Example
|
|
18
17
|
|
|
@@ -27,7 +26,6 @@ const example = {
|
|
|
27
26
|
"email": null,
|
|
28
27
|
"phone": null,
|
|
29
28
|
"site": null,
|
|
30
|
-
"addresses": null,
|
|
31
29
|
} satisfies CustomerListResource
|
|
32
30
|
|
|
33
31
|
console.log(example)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# PaginatedTransactionListResourceResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<TransactionListResource>](TransactionListResource.md)
|
|
10
|
+
`meta` | [PagingMetadata](PagingMetadata.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { PaginatedTransactionListResourceResponse } 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 PaginatedTransactionListResourceResponse
|
|
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 PaginatedTransactionListResourceResponse
|
|
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
|
+
|
package/docs/ProductApi.md
CHANGED
|
@@ -22,6 +22,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
22
22
|
| [**showAttributesProductChild**](ProductApi.md#showattributesproductchild) | **POST** /admin-api/product/children/{productChild}/attributes | Auto-generated: showAttributesProductChild |
|
|
23
23
|
| [**showProduct**](ProductApi.md#showproduct) | **GET** /admin-api/product/parent/{product} | Auto-generated: showProduct |
|
|
24
24
|
| [**showProductChild**](ProductApi.md#showproductchild) | **GET** /admin-api/product/children/{productChild} | Auto-generated: showProductChild |
|
|
25
|
+
| [**skuSearchProductChild**](ProductApi.md#skusearchproductchildoperation) | **POST** /admin-api/product/children/sku-search | Auto-generated: skuSearchProductChild |
|
|
25
26
|
| [**storeProduct**](ProductApi.md#storeproduct) | **POST** /admin-api/product/parent/create | Auto-generated: storeProduct |
|
|
26
27
|
| [**storeProductChild**](ProductApi.md#storeproductchild) | **POST** /admin-api/product/children/create | Auto-generated: storeProductChild |
|
|
27
28
|
| [**updateProduct**](ProductApi.md#updateproductoperation) | **PUT** /admin-api/product/parent/{product}/update | Auto-generated: updateProduct |
|
|
@@ -1229,6 +1230,71 @@ No authorization required
|
|
|
1229
1230
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1230
1231
|
|
|
1231
1232
|
|
|
1233
|
+
## skuSearchProductChild
|
|
1234
|
+
|
|
1235
|
+
> ProductChildResource skuSearchProductChild(skuSearchProductChildRequest)
|
|
1236
|
+
|
|
1237
|
+
Auto-generated: skuSearchProductChild
|
|
1238
|
+
|
|
1239
|
+
### Example
|
|
1240
|
+
|
|
1241
|
+
```ts
|
|
1242
|
+
import {
|
|
1243
|
+
Configuration,
|
|
1244
|
+
ProductApi,
|
|
1245
|
+
} from '@digital8/lighting-illusions-ts-sdk';
|
|
1246
|
+
import type { SkuSearchProductChildOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
|
|
1247
|
+
|
|
1248
|
+
async function example() {
|
|
1249
|
+
console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
|
|
1250
|
+
const api = new ProductApi();
|
|
1251
|
+
|
|
1252
|
+
const body = {
|
|
1253
|
+
// SkuSearchProductChildRequest (optional)
|
|
1254
|
+
skuSearchProductChildRequest: ...,
|
|
1255
|
+
} satisfies SkuSearchProductChildOperationRequest;
|
|
1256
|
+
|
|
1257
|
+
try {
|
|
1258
|
+
const data = await api.skuSearchProductChild(body);
|
|
1259
|
+
console.log(data);
|
|
1260
|
+
} catch (error) {
|
|
1261
|
+
console.error(error);
|
|
1262
|
+
}
|
|
1263
|
+
}
|
|
1264
|
+
|
|
1265
|
+
// Run the test
|
|
1266
|
+
example().catch(console.error);
|
|
1267
|
+
```
|
|
1268
|
+
|
|
1269
|
+
### Parameters
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
| Name | Type | Description | Notes |
|
|
1273
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1274
|
+
| **skuSearchProductChildRequest** | [SkuSearchProductChildRequest](SkuSearchProductChildRequest.md) | | [Optional] |
|
|
1275
|
+
|
|
1276
|
+
### Return type
|
|
1277
|
+
|
|
1278
|
+
[**ProductChildResource**](ProductChildResource.md)
|
|
1279
|
+
|
|
1280
|
+
### Authorization
|
|
1281
|
+
|
|
1282
|
+
No authorization required
|
|
1283
|
+
|
|
1284
|
+
### HTTP request headers
|
|
1285
|
+
|
|
1286
|
+
- **Content-Type**: `application/json`
|
|
1287
|
+
- **Accept**: `application/json`
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
### HTTP response details
|
|
1291
|
+
| Status code | Description | Response headers |
|
|
1292
|
+
|-------------|-------------|------------------|
|
|
1293
|
+
| **200** | Successful resource response | - |
|
|
1294
|
+
|
|
1295
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1296
|
+
|
|
1297
|
+
|
|
1232
1298
|
## storeProduct
|
|
1233
1299
|
|
|
1234
1300
|
> ProductResource storeProduct(createProductRequest)
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# SkuSearchProductChildRequest
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`sku` | string
|
|
10
|
+
`siteId` | number
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { SkuSearchProductChildRequest } from '@digital8/lighting-illusions-ts-sdk'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"sku": null,
|
|
20
|
+
"siteId": null,
|
|
21
|
+
} satisfies SkuSearchProductChildRequest
|
|
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 SkuSearchProductChildRequest
|
|
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,62 @@
|
|
|
1
|
+
|
|
2
|
+
# TransactionListResource
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`id` | number
|
|
10
|
+
`paymentSource` | string
|
|
11
|
+
`paymentMethod` | string
|
|
12
|
+
`type` | string
|
|
13
|
+
`status` | string
|
|
14
|
+
`totalAmount` | number
|
|
15
|
+
`surcharge` | number
|
|
16
|
+
`refundedAmount` | number
|
|
17
|
+
`unrefundedAmount` | number
|
|
18
|
+
`reference` | string
|
|
19
|
+
`description` | string
|
|
20
|
+
`extendedData` | string
|
|
21
|
+
`riskScore` | string
|
|
22
|
+
`fraudDecision` | string
|
|
23
|
+
`createdAt` | Date
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
import type { TransactionListResource } from '@digital8/lighting-illusions-ts-sdk'
|
|
29
|
+
|
|
30
|
+
// TODO: Update the object below with actual values
|
|
31
|
+
const example = {
|
|
32
|
+
"id": null,
|
|
33
|
+
"paymentSource": null,
|
|
34
|
+
"paymentMethod": null,
|
|
35
|
+
"type": null,
|
|
36
|
+
"status": null,
|
|
37
|
+
"totalAmount": null,
|
|
38
|
+
"surcharge": null,
|
|
39
|
+
"refundedAmount": null,
|
|
40
|
+
"unrefundedAmount": null,
|
|
41
|
+
"reference": null,
|
|
42
|
+
"description": null,
|
|
43
|
+
"extendedData": null,
|
|
44
|
+
"riskScore": null,
|
|
45
|
+
"fraudDecision": null,
|
|
46
|
+
"createdAt": null,
|
|
47
|
+
} satisfies TransactionListResource
|
|
48
|
+
|
|
49
|
+
console.log(example)
|
|
50
|
+
|
|
51
|
+
// Convert the instance to a JSON string
|
|
52
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
53
|
+
console.log(exampleJSON)
|
|
54
|
+
|
|
55
|
+
// Parse the JSON string back to an object
|
|
56
|
+
const exampleParsed = JSON.parse(exampleJSON) as TransactionListResource
|
|
57
|
+
console.log(exampleParsed)
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
61
|
+
|
|
62
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# TransactionListResourceArrayResponse
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`data` | [Array<TransactionListResource>](TransactionListResource.md)
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { TransactionListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"data": null,
|
|
19
|
+
} satisfies TransactionListResourceArrayResponse
|
|
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 TransactionListResourceArrayResponse
|
|
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
|
+
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
Name | Type
|
|
8
8
|
------------ | -------------
|
|
9
|
+
`id` | number
|
|
9
10
|
`paymentSource` | string
|
|
10
11
|
`paymentMethod` | string
|
|
11
12
|
`paymentMethodThumbnail` | string
|
|
@@ -15,6 +16,7 @@ Name | Type
|
|
|
15
16
|
`surcharge` | number
|
|
16
17
|
`totalAmount` | number
|
|
17
18
|
`reference` | string
|
|
19
|
+
`description` | string
|
|
18
20
|
`createdAt` | Date
|
|
19
21
|
|
|
20
22
|
## Example
|
|
@@ -24,6 +26,7 @@ import type { TransactionLiteResource } from '@digital8/lighting-illusions-ts-sd
|
|
|
24
26
|
|
|
25
27
|
// TODO: Update the object below with actual values
|
|
26
28
|
const example = {
|
|
29
|
+
"id": null,
|
|
27
30
|
"paymentSource": null,
|
|
28
31
|
"paymentMethod": null,
|
|
29
32
|
"paymentMethodThumbnail": null,
|
|
@@ -33,6 +36,7 @@ const example = {
|
|
|
33
36
|
"surcharge": null,
|
|
34
37
|
"totalAmount": null,
|
|
35
38
|
"reference": null,
|
|
39
|
+
"description": null,
|
|
36
40
|
"createdAt": null,
|
|
37
41
|
} satisfies TransactionLiteResource
|
|
38
42
|
|
package/docs/TransactionsApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *http://localhost/api*
|
|
|
12
12
|
|
|
13
13
|
## indexTransaction
|
|
14
14
|
|
|
15
|
-
>
|
|
15
|
+
> PaginatedTransactionListResourceResponse indexTransaction(searchTransactionsRequest)
|
|
16
16
|
|
|
17
17
|
Auto-generated: indexTransaction
|
|
18
18
|
|
|
@@ -55,7 +55,7 @@ example().catch(console.error);
|
|
|
55
55
|
|
|
56
56
|
### Return type
|
|
57
57
|
|
|
58
|
-
[**
|
|
58
|
+
[**PaginatedTransactionListResourceResponse**](PaginatedTransactionListResourceResponse.md)
|
|
59
59
|
|
|
60
60
|
### Authorization
|
|
61
61
|
|
|
@@ -70,7 +70,7 @@ No authorization required
|
|
|
70
70
|
### HTTP response details
|
|
71
71
|
| Status code | Description | Response headers |
|
|
72
72
|
|-------------|-------------|------------------|
|
|
73
|
-
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\
|
|
73
|
+
| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\TransactionListResource[]>> | - |
|
|
74
74
|
|
|
75
75
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
76
76
|
|
|
@@ -15,6 +15,7 @@ Name | Type
|
|
|
15
15
|
`insuranceAmount` | number
|
|
16
16
|
`includeInsurance` | boolean
|
|
17
17
|
`overrideInsurance` | boolean
|
|
18
|
+
`useAsBillingAddress` | boolean
|
|
18
19
|
`shippingAddressId` | number
|
|
19
20
|
`billingAddressId` | number
|
|
20
21
|
`shippingAddress` | [CreateCartRequestShippingAddress](CreateCartRequestShippingAddress.md)
|
|
@@ -36,6 +37,7 @@ const example = {
|
|
|
36
37
|
"insuranceAmount": null,
|
|
37
38
|
"includeInsurance": null,
|
|
38
39
|
"overrideInsurance": null,
|
|
40
|
+
"useAsBillingAddress": null,
|
|
39
41
|
"shippingAddressId": null,
|
|
40
42
|
"billingAddressId": null,
|
|
41
43
|
"shippingAddress": null,
|
package/package.json
CHANGED
package/src/apis/ProductApi.ts
CHANGED
|
@@ -118,6 +118,11 @@ import {
|
|
|
118
118
|
ShowProductChildAssetsRequestFromJSON,
|
|
119
119
|
ShowProductChildAssetsRequestToJSON,
|
|
120
120
|
} from '../models/ShowProductChildAssetsRequest';
|
|
121
|
+
import {
|
|
122
|
+
type SkuSearchProductChildRequest,
|
|
123
|
+
SkuSearchProductChildRequestFromJSON,
|
|
124
|
+
SkuSearchProductChildRequestToJSON,
|
|
125
|
+
} from '../models/SkuSearchProductChildRequest';
|
|
121
126
|
import {
|
|
122
127
|
type UpdateProductChildRequest,
|
|
123
128
|
UpdateProductChildRequestFromJSON,
|
|
@@ -211,6 +216,10 @@ export interface ShowProductChildRequest {
|
|
|
211
216
|
productChild: number;
|
|
212
217
|
}
|
|
213
218
|
|
|
219
|
+
export interface SkuSearchProductChildOperationRequest {
|
|
220
|
+
skuSearchProductChildRequest?: SkuSearchProductChildRequest;
|
|
221
|
+
}
|
|
222
|
+
|
|
214
223
|
export interface StoreProductRequest {
|
|
215
224
|
createProductRequest?: CreateProductRequest;
|
|
216
225
|
}
|
|
@@ -1064,6 +1073,46 @@ export class ProductApi extends runtime.BaseAPI {
|
|
|
1064
1073
|
return await response.value();
|
|
1065
1074
|
}
|
|
1066
1075
|
|
|
1076
|
+
/**
|
|
1077
|
+
* Creates request options for skuSearchProductChild without sending the request
|
|
1078
|
+
*/
|
|
1079
|
+
async skuSearchProductChildRequestOpts(requestParameters: SkuSearchProductChildOperationRequest): Promise<runtime.RequestOpts> {
|
|
1080
|
+
const queryParameters: any = {};
|
|
1081
|
+
|
|
1082
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1083
|
+
|
|
1084
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
let urlPath = `/admin-api/product/children/sku-search`;
|
|
1088
|
+
|
|
1089
|
+
return {
|
|
1090
|
+
path: urlPath,
|
|
1091
|
+
method: 'POST',
|
|
1092
|
+
headers: headerParameters,
|
|
1093
|
+
query: queryParameters,
|
|
1094
|
+
body: SkuSearchProductChildRequestToJSON(requestParameters['skuSearchProductChildRequest']),
|
|
1095
|
+
};
|
|
1096
|
+
}
|
|
1097
|
+
|
|
1098
|
+
/**
|
|
1099
|
+
* Auto-generated: skuSearchProductChild
|
|
1100
|
+
*/
|
|
1101
|
+
async skuSearchProductChildRaw(requestParameters: SkuSearchProductChildOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProductChildResource>> {
|
|
1102
|
+
const requestOptions = await this.skuSearchProductChildRequestOpts(requestParameters);
|
|
1103
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1104
|
+
|
|
1105
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ProductChildResourceFromJSON(jsonValue));
|
|
1106
|
+
}
|
|
1107
|
+
|
|
1108
|
+
/**
|
|
1109
|
+
* Auto-generated: skuSearchProductChild
|
|
1110
|
+
*/
|
|
1111
|
+
async skuSearchProductChild(requestParameters: SkuSearchProductChildOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProductChildResource> {
|
|
1112
|
+
const response = await this.skuSearchProductChildRaw(requestParameters, initOverrides);
|
|
1113
|
+
return await response.value();
|
|
1114
|
+
}
|
|
1115
|
+
|
|
1067
1116
|
/**
|
|
1068
1117
|
* Creates request options for storeProduct without sending the request
|
|
1069
1118
|
*/
|
|
@@ -19,10 +19,10 @@ import {
|
|
|
19
19
|
CreateTransactionRequestToJSON,
|
|
20
20
|
} from '../models/CreateTransactionRequest';
|
|
21
21
|
import {
|
|
22
|
-
type
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
} from '../models/
|
|
22
|
+
type PaginatedTransactionListResourceResponse,
|
|
23
|
+
PaginatedTransactionListResourceResponseFromJSON,
|
|
24
|
+
PaginatedTransactionListResourceResponseToJSON,
|
|
25
|
+
} from '../models/PaginatedTransactionListResourceResponse';
|
|
26
26
|
import {
|
|
27
27
|
type RefundTransactionRequest,
|
|
28
28
|
RefundTransactionRequestFromJSON,
|
|
@@ -87,17 +87,17 @@ export class TransactionsApi extends runtime.BaseAPI {
|
|
|
87
87
|
/**
|
|
88
88
|
* Auto-generated: indexTransaction
|
|
89
89
|
*/
|
|
90
|
-
async indexTransactionRaw(requestParameters: IndexTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
90
|
+
async indexTransactionRaw(requestParameters: IndexTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedTransactionListResourceResponse>> {
|
|
91
91
|
const requestOptions = await this.indexTransactionRequestOpts(requestParameters);
|
|
92
92
|
const response = await this.request(requestOptions, initOverrides);
|
|
93
93
|
|
|
94
|
-
return new runtime.JSONApiResponse(response, (jsonValue) =>
|
|
94
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedTransactionListResourceResponseFromJSON(jsonValue));
|
|
95
95
|
}
|
|
96
96
|
|
|
97
97
|
/**
|
|
98
98
|
* Auto-generated: indexTransaction
|
|
99
99
|
*/
|
|
100
|
-
async indexTransaction(requestParameters: IndexTransactionRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
100
|
+
async indexTransaction(requestParameters: IndexTransactionRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTransactionListResourceResponse> {
|
|
101
101
|
const response = await this.indexTransactionRaw(requestParameters, initOverrides);
|
|
102
102
|
return await response.value();
|
|
103
103
|
}
|
|
@@ -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 | null;
|
|
40
40
|
/**
|
|
41
41
|
*
|
|
42
42
|
* @type {string}
|
|
@@ -73,8 +73,8 @@ 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
|
-
if (!('line2' in value) || value['line2'] === undefined) return false;
|
|
78
78
|
if (!('postcode' in value) || value['postcode'] === undefined) return false;
|
|
79
79
|
if (!('suburb' in value) || value['suburb'] === undefined) return false;
|
|
80
80
|
if (!('country' in value) || value['country'] === undefined) return false;
|
|
@@ -93,9 +93,9 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
|
|
|
93
93
|
}
|
|
94
94
|
return {
|
|
95
95
|
|
|
96
|
-
'company': json['company']
|
|
96
|
+
'company': json['company'],
|
|
97
97
|
'line1': json['line1'],
|
|
98
|
-
'line2': json['line2'],
|
|
98
|
+
'line2': json['line2'] == null ? undefined : json['line2'],
|
|
99
99
|
'postcode': json['postcode'],
|
|
100
100
|
'suburb': json['suburb'],
|
|
101
101
|
'country': json['country'],
|
|
@@ -25,6 +25,12 @@ export interface AddressResource {
|
|
|
25
25
|
* @memberof AddressResource
|
|
26
26
|
*/
|
|
27
27
|
id?: number | null;
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AddressResource
|
|
32
|
+
*/
|
|
33
|
+
type?: string | null;
|
|
28
34
|
/**
|
|
29
35
|
*
|
|
30
36
|
* @type {number}
|
|
@@ -42,7 +48,7 @@ export interface AddressResource {
|
|
|
42
48
|
* @type {string}
|
|
43
49
|
* @memberof AddressResource
|
|
44
50
|
*/
|
|
45
|
-
company
|
|
51
|
+
company: string;
|
|
46
52
|
/**
|
|
47
53
|
*
|
|
48
54
|
* @type {string}
|
|
@@ -92,6 +98,7 @@ export interface AddressResource {
|
|
|
92
98
|
*/
|
|
93
99
|
export function instanceOfAddressResource(value: object): value is AddressResource {
|
|
94
100
|
if (!('addresseeName' in value) || value['addresseeName'] === undefined) return false;
|
|
101
|
+
if (!('company' in value) || value['company'] === undefined) return false;
|
|
95
102
|
if (!('line1' in value) || value['line1'] === undefined) return false;
|
|
96
103
|
if (!('postcode' in value) || value['postcode'] === undefined) return false;
|
|
97
104
|
if (!('suburb' in value) || value['suburb'] === undefined) return false;
|
|
@@ -112,9 +119,10 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
|
|
|
112
119
|
return {
|
|
113
120
|
|
|
114
121
|
'id': json['id'] == null ? undefined : json['id'],
|
|
122
|
+
'type': json['type'] == null ? undefined : json['type'],
|
|
115
123
|
'sourceAddressId': json['sourceAddressId'] == null ? undefined : json['sourceAddressId'],
|
|
116
124
|
'addresseeName': json['addresseeName'],
|
|
117
|
-
'company': json['company']
|
|
125
|
+
'company': json['company'],
|
|
118
126
|
'line1': json['line1'],
|
|
119
127
|
'line2': json['line2'] == null ? undefined : json['line2'],
|
|
120
128
|
'postcode': json['postcode'],
|
|
@@ -137,6 +145,7 @@ export function AddressResourceToJSONTyped(value?: AddressResource | null, ignor
|
|
|
137
145
|
return {
|
|
138
146
|
|
|
139
147
|
'id': value['id'],
|
|
148
|
+
'type': value['type'],
|
|
140
149
|
'sourceAddressId': value['sourceAddressId'],
|
|
141
150
|
'addresseeName': value['addresseeName'],
|
|
142
151
|
'company': value['company'],
|