@digital8/lighting-illusions-ts-sdk 0.0.1902 → 0.0.1903

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 (128) hide show
  1. package/.openapi-generator/FILES +38 -0
  2. package/README.md +32 -2
  3. package/dist/apis/AdminApi.d.ts +16 -1
  4. package/dist/apis/AdminApi.js +58 -0
  5. package/dist/apis/CartsApi.d.ts +16 -1
  6. package/dist/apis/CartsApi.js +59 -0
  7. package/dist/apis/OrdersApi.d.ts +170 -0
  8. package/dist/apis/OrdersApi.js +678 -0
  9. package/dist/apis/index.d.ts +1 -0
  10. package/dist/apis/index.js +1 -0
  11. package/dist/models/AddressFrontendResource.d.ts +2 -2
  12. package/dist/models/AddressFrontendResource.js +4 -4
  13. package/dist/models/AddressResource.d.ts +3 -3
  14. package/dist/models/AddressResource.js +6 -4
  15. package/dist/models/AdminNoteResource.d.ts +68 -0
  16. package/dist/models/AdminNoteResource.js +71 -0
  17. package/dist/models/AdminNoteResourceArrayResponse.d.ts +33 -0
  18. package/dist/models/AdminNoteResourceArrayResponse.js +50 -0
  19. package/dist/models/AdminOrderResource.d.ts +262 -0
  20. package/dist/models/AdminOrderResource.js +187 -0
  21. package/dist/models/AdminOrderResourceArrayResponse.d.ts +33 -0
  22. package/dist/models/AdminOrderResourceArrayResponse.js +50 -0
  23. package/dist/models/AttachItemOrderRequest.d.ts +44 -0
  24. package/dist/models/AttachItemOrderRequest.js +57 -0
  25. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  26. package/dist/models/ExternalApiLogResource.js +3 -1
  27. package/dist/models/GetAllAdminNoteRequest.d.ts +102 -0
  28. package/dist/models/GetAllAdminNoteRequest.js +82 -0
  29. package/dist/models/GetAllOrderRequest.d.ts +104 -0
  30. package/dist/models/GetAllOrderRequest.js +84 -0
  31. package/dist/models/IndexOrderRequest.d.ts +140 -0
  32. package/dist/models/IndexOrderRequest.js +96 -0
  33. package/dist/models/LineItemListResource.d.ts +6 -0
  34. package/dist/models/LineItemListResource.js +2 -0
  35. package/dist/models/OrderListResource.d.ts +101 -0
  36. package/dist/models/OrderListResource.js +90 -0
  37. package/dist/models/OrderListResourceArrayResponse.d.ts +33 -0
  38. package/dist/models/OrderListResourceArrayResponse.js +50 -0
  39. package/dist/models/OrderLiteResource.d.ts +62 -0
  40. package/dist/models/OrderLiteResource.js +67 -0
  41. package/dist/models/OrderLiteResourceArrayResponse.d.ts +33 -0
  42. package/dist/models/OrderLiteResourceArrayResponse.js +50 -0
  43. package/dist/models/PaginatedAdminNoteResourceResponse.d.ts +40 -0
  44. package/dist/models/PaginatedAdminNoteResourceResponse.js +57 -0
  45. package/dist/models/PaginatedOrderListResourceResponse.d.ts +40 -0
  46. package/dist/models/PaginatedOrderListResourceResponse.js +57 -0
  47. package/dist/models/ProductChildCartLiteResource.d.ts +18 -0
  48. package/dist/models/ProductChildCartLiteResource.js +12 -0
  49. package/dist/models/StoreCartRequestShippingAddress.d.ts +2 -2
  50. package/dist/models/StoreCartRequestShippingAddress.js +2 -2
  51. package/dist/models/StoreFrontendResource.d.ts +1 -1
  52. package/dist/models/StoreFrontendResource.js +3 -1
  53. package/dist/models/StoreListResource.d.ts +1 -1
  54. package/dist/models/StoreListResource.js +3 -1
  55. package/dist/models/StoreResource.d.ts +2 -2
  56. package/dist/models/StoreResource.js +2 -6
  57. package/dist/models/StoreStoreRequestAddress.d.ts +0 -6
  58. package/dist/models/StoreStoreRequestAddress.js +0 -2
  59. package/dist/models/UpdateItemOrderRequest.d.ts +38 -0
  60. package/dist/models/UpdateItemOrderRequest.js +53 -0
  61. package/dist/models/UpdateOrderRequest.d.ts +111 -0
  62. package/dist/models/UpdateOrderRequest.js +99 -0
  63. package/dist/models/UpdateOrderRequestBillingAddress.d.ts +80 -0
  64. package/dist/models/UpdateOrderRequestBillingAddress.js +67 -0
  65. package/dist/models/UpdateOrderRequestShippingAddress.d.ts +80 -0
  66. package/dist/models/UpdateOrderRequestShippingAddress.js +67 -0
  67. package/dist/models/index.d.ts +18 -0
  68. package/dist/models/index.js +18 -0
  69. package/docs/AddressResource.md +2 -2
  70. package/docs/AdminApi.md +66 -0
  71. package/docs/AdminNoteResource.md +46 -0
  72. package/docs/AdminNoteResourceArrayResponse.md +34 -0
  73. package/docs/AdminOrderResource.md +110 -0
  74. package/docs/AdminOrderResourceArrayResponse.md +34 -0
  75. package/docs/AttachItemOrderRequest.md +38 -0
  76. package/docs/CartsApi.md +66 -0
  77. package/docs/GetAllAdminNoteRequest.md +52 -0
  78. package/docs/GetAllOrderRequest.md +52 -0
  79. package/docs/IndexOrderRequest.md +64 -0
  80. package/docs/LineItemListResource.md +2 -0
  81. package/docs/OrderListResource.md +56 -0
  82. package/docs/OrderListResourceArrayResponse.md +34 -0
  83. package/docs/OrderLiteResource.md +44 -0
  84. package/docs/OrderLiteResourceArrayResponse.md +34 -0
  85. package/docs/OrdersApi.md +675 -0
  86. package/docs/PaginatedAdminNoteResourceResponse.md +36 -0
  87. package/docs/PaginatedOrderListResourceResponse.md +36 -0
  88. package/docs/ProductChildCartLiteResource.md +6 -0
  89. package/docs/StoreCartRequestShippingAddress.md +2 -2
  90. package/docs/StoreStoreRequestAddress.md +0 -2
  91. package/docs/UpdateItemOrderRequest.md +36 -0
  92. package/docs/UpdateOrderRequest.md +52 -0
  93. package/docs/UpdateOrderRequestBillingAddress.md +50 -0
  94. package/docs/UpdateOrderRequestShippingAddress.md +50 -0
  95. package/package.json +1 -1
  96. package/src/apis/AdminApi.ts +50 -0
  97. package/src/apis/CartsApi.ts +52 -0
  98. package/src/apis/OrdersApi.ts +552 -0
  99. package/src/apis/index.ts +1 -0
  100. package/src/models/AddressFrontendResource.ts +5 -5
  101. package/src/models/AddressResource.ts +8 -7
  102. package/src/models/AdminNoteResource.ts +118 -0
  103. package/src/models/AdminNoteResourceArrayResponse.ts +73 -0
  104. package/src/models/AdminOrderResource.ts +414 -0
  105. package/src/models/AdminOrderResourceArrayResponse.ts +73 -0
  106. package/src/models/AttachItemOrderRequest.ts +83 -0
  107. package/src/models/ExternalApiLogResource.ts +3 -2
  108. package/src/models/GetAllAdminNoteRequest.ts +157 -0
  109. package/src/models/GetAllOrderRequest.ts +159 -0
  110. package/src/models/IndexOrderRequest.ts +207 -0
  111. package/src/models/LineItemListResource.ts +8 -0
  112. package/src/models/OrderListResource.ts +183 -0
  113. package/src/models/OrderListResourceArrayResponse.ts +73 -0
  114. package/src/models/OrderLiteResource.ts +109 -0
  115. package/src/models/OrderLiteResourceArrayResponse.ts +73 -0
  116. package/src/models/PaginatedAdminNoteResourceResponse.ts +90 -0
  117. package/src/models/PaginatedOrderListResourceResponse.ts +90 -0
  118. package/src/models/ProductChildCartLiteResource.ts +27 -0
  119. package/src/models/StoreCartRequestShippingAddress.ts +4 -4
  120. package/src/models/StoreFrontendResource.ts +3 -2
  121. package/src/models/StoreListResource.ts +3 -2
  122. package/src/models/StoreResource.ts +4 -6
  123. package/src/models/StoreStoreRequestAddress.ts +0 -8
  124. package/src/models/UpdateItemOrderRequest.ts +74 -0
  125. package/src/models/UpdateOrderRequest.ts +183 -0
  126. package/src/models/UpdateOrderRequestBillingAddress.ts +130 -0
  127. package/src/models/UpdateOrderRequestShippingAddress.ts +130 -0
  128. package/src/models/index.ts +18 -0
@@ -0,0 +1,52 @@
1
+
2
+ # GetAllOrderRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `search` | string
10
+ `sortBy` | string
11
+ `sortDirection` | string
12
+ `relatedId` | number
13
+ `relatedType` | string
14
+ `includesRelations` | boolean
15
+ `siteId` | Array<string>
16
+ `source` | Array<string>
17
+ `statusId` | Array<string>
18
+ `customerId` | Array<string>
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import type { GetAllOrderRequest } from '@digital8/lighting-illusions-ts-sdk'
24
+
25
+ // TODO: Update the object below with actual values
26
+ const example = {
27
+ "search": null,
28
+ "sortBy": null,
29
+ "sortDirection": null,
30
+ "relatedId": null,
31
+ "relatedType": null,
32
+ "includesRelations": null,
33
+ "siteId": null,
34
+ "source": null,
35
+ "statusId": null,
36
+ "customerId": null,
37
+ } satisfies GetAllOrderRequest
38
+
39
+ console.log(example)
40
+
41
+ // Convert the instance to a JSON string
42
+ const exampleJSON: string = JSON.stringify(example)
43
+ console.log(exampleJSON)
44
+
45
+ // Parse the JSON string back to an object
46
+ const exampleParsed = JSON.parse(exampleJSON) as GetAllOrderRequest
47
+ console.log(exampleParsed)
48
+ ```
49
+
50
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
51
+
52
+
@@ -0,0 +1,64 @@
1
+
2
+ # IndexOrderRequest
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `search` | string
10
+ `sortBy` | string
11
+ `sortDirection` | string
12
+ `perPage` | number
13
+ `page` | number
14
+ `siteId` | Array<string>
15
+ `source` | Array<string>
16
+ `statusId` | Array<string>
17
+ `customerId` | Array<string>
18
+ `beforeCreatedAt` | Date
19
+ `afterCreatedAt` | Date
20
+ `beforePlacedAt` | Date
21
+ `afterPlacedAt` | Date
22
+ `relatedId` | number
23
+ `relatedType` | string
24
+ `includesRelations` | boolean
25
+
26
+ ## Example
27
+
28
+ ```typescript
29
+ import type { IndexOrderRequest } from '@digital8/lighting-illusions-ts-sdk'
30
+
31
+ // TODO: Update the object below with actual values
32
+ const example = {
33
+ "search": null,
34
+ "sortBy": null,
35
+ "sortDirection": null,
36
+ "perPage": null,
37
+ "page": null,
38
+ "siteId": null,
39
+ "source": null,
40
+ "statusId": null,
41
+ "customerId": null,
42
+ "beforeCreatedAt": null,
43
+ "afterCreatedAt": null,
44
+ "beforePlacedAt": null,
45
+ "afterPlacedAt": null,
46
+ "relatedId": null,
47
+ "relatedType": null,
48
+ "includesRelations": null,
49
+ } satisfies IndexOrderRequest
50
+
51
+ console.log(example)
52
+
53
+ // Convert the instance to a JSON string
54
+ const exampleJSON: string = JSON.stringify(example)
55
+ console.log(exampleJSON)
56
+
57
+ // Parse the JSON string back to an object
58
+ const exampleParsed = JSON.parse(exampleJSON) as IndexOrderRequest
59
+ console.log(exampleParsed)
60
+ ```
61
+
62
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
63
+
64
+
@@ -9,6 +9,7 @@ Name | Type
9
9
  `id` | number
10
10
  `quantity` | number
11
11
  `productPrice` | number
12
+ `labelId` | number
12
13
  `productDiscount` | number
13
14
  `totalDiscount` | number
14
15
  `lineSubtotal` | number
@@ -25,6 +26,7 @@ const example = {
25
26
  "id": null,
26
27
  "quantity": null,
27
28
  "productPrice": null,
29
+ "labelId": null,
28
30
  "productDiscount": null,
29
31
  "totalDiscount": null,
30
32
  "lineSubtotal": null,
@@ -0,0 +1,56 @@
1
+
2
+ # OrderListResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `cartId` | number
11
+ `placedAt` | Date
12
+ `createdAt` | Date
13
+ `updatedAt` | Date
14
+ `subtotal` | number
15
+ `finalTotalAmount` | number
16
+ `cartStatusContext` | object
17
+ `site` | [SiteLiteResource](SiteLiteResource.md)
18
+ `customer` | [CustomerListResource](CustomerListResource.md)
19
+ `status` | Array<number>
20
+ `lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
21
+
22
+ ## Example
23
+
24
+ ```typescript
25
+ import type { OrderListResource } from '@digital8/lighting-illusions-ts-sdk'
26
+
27
+ // TODO: Update the object below with actual values
28
+ const example = {
29
+ "id": null,
30
+ "cartId": null,
31
+ "placedAt": null,
32
+ "createdAt": null,
33
+ "updatedAt": null,
34
+ "subtotal": null,
35
+ "finalTotalAmount": null,
36
+ "cartStatusContext": null,
37
+ "site": null,
38
+ "customer": null,
39
+ "status": null,
40
+ "lineItems": null,
41
+ } satisfies OrderListResource
42
+
43
+ console.log(example)
44
+
45
+ // Convert the instance to a JSON string
46
+ const exampleJSON: string = JSON.stringify(example)
47
+ console.log(exampleJSON)
48
+
49
+ // Parse the JSON string back to an object
50
+ const exampleParsed = JSON.parse(exampleJSON) as OrderListResource
51
+ console.log(exampleParsed)
52
+ ```
53
+
54
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
55
+
56
+
@@ -0,0 +1,34 @@
1
+
2
+ # OrderListResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<OrderListResource>](OrderListResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { OrderListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies OrderListResourceArrayResponse
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 OrderListResourceArrayResponse
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
+
@@ -0,0 +1,44 @@
1
+
2
+ # OrderLiteResource
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `id` | number
10
+ `placedAt` | Date
11
+ `finalTotalAmount` | number
12
+ `customerId` | number
13
+ `siteId` | number
14
+ `statusId` | number
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { OrderLiteResource } from '@digital8/lighting-illusions-ts-sdk'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "id": null,
24
+ "placedAt": null,
25
+ "finalTotalAmount": null,
26
+ "customerId": null,
27
+ "siteId": null,
28
+ "statusId": null,
29
+ } satisfies OrderLiteResource
30
+
31
+ console.log(example)
32
+
33
+ // Convert the instance to a JSON string
34
+ const exampleJSON: string = JSON.stringify(example)
35
+ console.log(exampleJSON)
36
+
37
+ // Parse the JSON string back to an object
38
+ const exampleParsed = JSON.parse(exampleJSON) as OrderLiteResource
39
+ console.log(exampleParsed)
40
+ ```
41
+
42
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
43
+
44
+
@@ -0,0 +1,34 @@
1
+
2
+ # OrderLiteResourceArrayResponse
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `data` | [Array<OrderLiteResource>](OrderLiteResource.md)
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { OrderLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "data": null,
19
+ } satisfies OrderLiteResourceArrayResponse
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 OrderLiteResourceArrayResponse
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
+