@digital8/lighting-illusions-ts-sdk 0.0.1904 → 0.0.1905

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 (317) hide show
  1. package/.openapi-generator/FILES +2 -94
  2. package/README.md +3 -62
  3. package/dist/apis/index.d.ts +0 -2
  4. package/dist/apis/index.js +0 -2
  5. package/dist/models/AddressFrontendResource.d.ts +2 -2
  6. package/dist/models/AddressFrontendResource.js +4 -4
  7. package/dist/models/AddressResource.d.ts +1 -7
  8. package/dist/models/AddressResource.js +1 -5
  9. package/dist/models/AssetFrontendResource.d.ts +12 -0
  10. package/dist/models/AssetFrontendResource.js +6 -0
  11. package/dist/models/AssetLiteResource.d.ts +14 -2
  12. package/dist/models/AssetLiteResource.js +6 -0
  13. package/dist/models/AssetResource.d.ts +14 -2
  14. package/dist/models/AssetResource.js +6 -0
  15. package/dist/models/AssetWithOverlayLinkResource.d.ts +14 -2
  16. package/dist/models/AssetWithOverlayLinkResource.js +6 -0
  17. package/dist/models/ExternalApiLogResource.d.ts +1 -1
  18. package/dist/models/ExternalApiLogResource.js +1 -3
  19. package/dist/models/ExternalApiSyncStatus.d.ts +1 -0
  20. package/dist/models/ExternalApiSyncStatus.js +2 -1
  21. package/dist/models/MenuPosition.d.ts +0 -1
  22. package/dist/models/MenuPosition.js +1 -2
  23. package/dist/models/ProductChildSiteDetailLiteResource.d.ts +0 -7
  24. package/dist/models/ProductChildSiteDetailLiteResource.js +0 -5
  25. package/dist/models/SitePaymentConfigResource.d.ts +0 -6
  26. package/dist/models/SitePaymentConfigResource.js +0 -4
  27. package/dist/models/StoreAssetForAssetableRequest.d.ts +14 -2
  28. package/dist/models/StoreAssetForAssetableRequest.js +6 -6
  29. package/dist/models/StoreFrontendResource.d.ts +1 -1
  30. package/dist/models/StoreFrontendResource.js +1 -3
  31. package/dist/models/StoreListResource.d.ts +13 -1
  32. package/dist/models/StoreListResource.js +15 -5
  33. package/dist/models/StoreMenuRequest.d.ts +0 -1
  34. package/dist/models/StoreMenuRequest.js +1 -2
  35. package/dist/models/StoreOverlayTemplateAssetRequest.d.ts +14 -2
  36. package/dist/models/StoreOverlayTemplateAssetRequest.js +6 -6
  37. package/dist/models/StoreProductCategoryRequest.d.ts +12 -0
  38. package/dist/models/StoreProductCategoryRequest.js +4 -0
  39. package/dist/models/StoreProductChildRequestAssetsInner.d.ts +14 -2
  40. package/dist/models/StoreProductChildRequestAssetsInner.js +6 -6
  41. package/dist/models/StoreResource.d.ts +12 -0
  42. package/dist/models/StoreResource.js +14 -6
  43. package/dist/models/StoreSpecialDateFrontendResource.d.ts +2 -2
  44. package/dist/models/StoreSpecialDateFrontendResource.js +3 -1
  45. package/dist/models/StoreSpecialDateResource.d.ts +2 -2
  46. package/dist/models/StoreSpecialDateResource.js +7 -5
  47. package/dist/models/StoreStockType.d.ts +25 -0
  48. package/dist/models/StoreStockType.js +51 -0
  49. package/dist/models/StoreStoreRequest.d.ts +12 -0
  50. package/dist/models/StoreStoreRequest.js +4 -0
  51. package/dist/models/StoreSupplierRequest.d.ts +14 -2
  52. package/dist/models/StoreSupplierRequest.js +6 -6
  53. package/dist/models/UpdateAssetForAssetableRequest.d.ts +12 -0
  54. package/dist/models/UpdateAssetForAssetableRequest.js +4 -0
  55. package/dist/models/UpdateMenuRequest.d.ts +0 -1
  56. package/dist/models/UpdateMenuRequest.js +1 -2
  57. package/dist/models/UpdateOverlayTemplateAssetRequest.d.ts +14 -2
  58. package/dist/models/UpdateOverlayTemplateAssetRequest.js +6 -6
  59. package/dist/models/UpdateProductCategoryRequest.d.ts +12 -0
  60. package/dist/models/UpdateProductCategoryRequest.js +4 -0
  61. package/dist/models/UpdateProductChildRequestAssetsInner.d.ts +14 -2
  62. package/dist/models/UpdateProductChildRequestAssetsInner.js +6 -6
  63. package/dist/models/UpdateSiteRequest.d.ts +0 -6
  64. package/dist/models/UpdateSiteRequest.js +0 -4
  65. package/dist/models/UpdateStoreRequest.d.ts +12 -0
  66. package/dist/models/UpdateStoreRequest.js +4 -0
  67. package/dist/models/UpdateSupplierRequest.d.ts +14 -2
  68. package/dist/models/UpdateSupplierRequest.js +6 -6
  69. package/dist/models/index.d.ts +1 -45
  70. package/dist/models/index.js +1 -45
  71. package/docs/AddressResource.md +0 -2
  72. package/docs/AssetFrontendResource.md +4 -0
  73. package/docs/AssetLiteResource.md +5 -1
  74. package/docs/AssetResource.md +5 -1
  75. package/docs/AssetWithOverlayLinkResource.md +5 -1
  76. package/docs/ProductChildSiteDetailLiteResource.md +0 -2
  77. package/docs/SitePaymentConfigResource.md +0 -2
  78. package/docs/StoreAssetForAssetableRequest.md +4 -0
  79. package/docs/StoreListResource.md +4 -0
  80. package/docs/StoreOverlayTemplateAssetRequest.md +4 -0
  81. package/docs/StoreProductCategoryRequest.md +4 -0
  82. package/docs/StoreProductChildRequestAssetsInner.md +4 -0
  83. package/docs/StoreResource.md +4 -0
  84. package/docs/StoreSpecialDateFrontendResource.md +1 -1
  85. package/docs/StoreSpecialDateResource.md +1 -1
  86. package/docs/{AddressType.md → StoreStockType.md} +4 -4
  87. package/docs/StoreStoreRequest.md +4 -0
  88. package/docs/StoreSupplierRequest.md +4 -0
  89. package/docs/UpdateAssetForAssetableRequest.md +4 -0
  90. package/docs/UpdateOverlayTemplateAssetRequest.md +4 -0
  91. package/docs/UpdateProductCategoryRequest.md +4 -0
  92. package/docs/UpdateProductChildRequestAssetsInner.md +4 -0
  93. package/docs/UpdateSiteRequest.md +0 -2
  94. package/docs/UpdateStoreRequest.md +4 -0
  95. package/docs/UpdateSupplierRequest.md +4 -0
  96. package/package.json +1 -1
  97. package/src/apis/index.ts +0 -2
  98. package/src/models/AddressFrontendResource.ts +5 -5
  99. package/src/models/AddressResource.ts +2 -11
  100. package/src/models/AssetFrontendResource.ts +17 -0
  101. package/src/models/AssetLiteResource.ts +19 -2
  102. package/src/models/AssetResource.ts +19 -2
  103. package/src/models/AssetWithOverlayLinkResource.ts +19 -2
  104. package/src/models/ExternalApiLogResource.ts +2 -3
  105. package/src/models/ExternalApiSyncStatus.ts +2 -1
  106. package/src/models/MenuPosition.ts +1 -2
  107. package/src/models/ProductChildSiteDetailLiteResource.ts +0 -16
  108. package/src/models/SitePaymentConfigResource.ts +0 -9
  109. package/src/models/StoreAssetForAssetableRequest.ts +20 -6
  110. package/src/models/StoreFrontendResource.ts +2 -3
  111. package/src/models/StoreListResource.ts +25 -6
  112. package/src/models/StoreMenuRequest.ts +1 -2
  113. package/src/models/StoreOverlayTemplateAssetRequest.ts +20 -6
  114. package/src/models/StoreProductCategoryRequest.ts +16 -0
  115. package/src/models/StoreProductChildRequestAssetsInner.ts +20 -6
  116. package/src/models/StoreResource.ts +24 -6
  117. package/src/models/StoreSpecialDateFrontendResource.ts +4 -3
  118. package/src/models/StoreSpecialDateResource.ts +8 -7
  119. package/src/models/StoreStockType.ts +53 -0
  120. package/src/models/StoreStoreRequest.ts +16 -0
  121. package/src/models/StoreSupplierRequest.ts +20 -6
  122. package/src/models/UpdateAssetForAssetableRequest.ts +16 -0
  123. package/src/models/UpdateMenuRequest.ts +1 -2
  124. package/src/models/UpdateOverlayTemplateAssetRequest.ts +20 -6
  125. package/src/models/UpdateProductCategoryRequest.ts +16 -0
  126. package/src/models/UpdateProductChildRequestAssetsInner.ts +20 -6
  127. package/src/models/UpdateSiteRequest.ts +0 -9
  128. package/src/models/UpdateStoreRequest.ts +16 -0
  129. package/src/models/UpdateSupplierRequest.ts +20 -6
  130. package/src/models/index.ts +1 -45
  131. package/dist/apis/CartsApi.d.ts +0 -190
  132. package/dist/apis/CartsApi.js +0 -745
  133. package/dist/apis/CustomersApi.d.ts +0 -79
  134. package/dist/apis/CustomersApi.js +0 -316
  135. package/dist/models/AddressType.d.ts +0 -25
  136. package/dist/models/AddressType.js +0 -51
  137. package/dist/models/AttachCouponCartRequest.d.ts +0 -32
  138. package/dist/models/AttachCouponCartRequest.js +0 -51
  139. package/dist/models/AttachItemCartRequest.d.ts +0 -44
  140. package/dist/models/AttachItemCartRequest.js +0 -57
  141. package/dist/models/CartCouponLiteResource.d.ts +0 -44
  142. package/dist/models/CartCouponLiteResource.js +0 -59
  143. package/dist/models/CartCouponLiteResourceArrayResponse.d.ts +0 -33
  144. package/dist/models/CartCouponLiteResourceArrayResponse.js +0 -50
  145. package/dist/models/CartCouponResource.d.ts +0 -50
  146. package/dist/models/CartCouponResource.js +0 -63
  147. package/dist/models/CartCouponResourceArrayResponse.d.ts +0 -33
  148. package/dist/models/CartCouponResourceArrayResponse.js +0 -50
  149. package/dist/models/CartListResource.d.ts +0 -149
  150. package/dist/models/CartListResource.js +0 -112
  151. package/dist/models/CartListResourceArrayResponse.d.ts +0 -33
  152. package/dist/models/CartListResourceArrayResponse.js +0 -50
  153. package/dist/models/CartOrderSource.d.ts +0 -29
  154. package/dist/models/CartOrderSource.js +0 -55
  155. package/dist/models/CartResource.d.ts +0 -241
  156. package/dist/models/CartResource.js +0 -172
  157. package/dist/models/CartResourceArrayResponse.d.ts +0 -33
  158. package/dist/models/CartResourceArrayResponse.js +0 -50
  159. package/dist/models/CartStatus.d.ts +0 -26
  160. package/dist/models/CartStatus.js +0 -52
  161. package/dist/models/CustomerListResource.d.ts +0 -76
  162. package/dist/models/CustomerListResource.js +0 -77
  163. package/dist/models/CustomerListResourceArrayResponse.d.ts +0 -33
  164. package/dist/models/CustomerListResourceArrayResponse.js +0 -50
  165. package/dist/models/CustomerResource.d.ts +0 -76
  166. package/dist/models/CustomerResource.js +0 -77
  167. package/dist/models/CustomerResourceArrayResponse.d.ts +0 -33
  168. package/dist/models/CustomerResourceArrayResponse.js +0 -50
  169. package/dist/models/DetachCouponCartRequest.d.ts +0 -32
  170. package/dist/models/DetachCouponCartRequest.js +0 -51
  171. package/dist/models/DiscountType.d.ts +0 -26
  172. package/dist/models/DiscountType.js +0 -52
  173. package/dist/models/DiscountValueType.d.ts +0 -25
  174. package/dist/models/DiscountValueType.js +0 -51
  175. package/dist/models/FrontendCartResource.d.ts +0 -138
  176. package/dist/models/FrontendCartResource.js +0 -119
  177. package/dist/models/FrontendCartResourceArrayResponse.d.ts +0 -33
  178. package/dist/models/FrontendCartResourceArrayResponse.js +0 -50
  179. package/dist/models/FrontendLineItemResource.d.ts +0 -63
  180. package/dist/models/FrontendLineItemResource.js +0 -70
  181. package/dist/models/FrontendLineItemResourceArrayResponse.d.ts +0 -33
  182. package/dist/models/FrontendLineItemResourceArrayResponse.js +0 -50
  183. package/dist/models/IndexCartRequest.d.ts +0 -154
  184. package/dist/models/IndexCartRequest.js +0 -105
  185. package/dist/models/IndexCustomerRequest.d.ts +0 -99
  186. package/dist/models/IndexCustomerRequest.js +0 -83
  187. package/dist/models/LiAddressResource.d.ts +0 -86
  188. package/dist/models/LiAddressResource.js +0 -83
  189. package/dist/models/LiAddressResourceArrayResponse.d.ts +0 -33
  190. package/dist/models/LiAddressResourceArrayResponse.js +0 -50
  191. package/dist/models/LineItemDiscountResource.d.ts +0 -50
  192. package/dist/models/LineItemDiscountResource.js +0 -63
  193. package/dist/models/LineItemDiscountResourceArrayResponse.d.ts +0 -33
  194. package/dist/models/LineItemDiscountResourceArrayResponse.js +0 -50
  195. package/dist/models/LineItemListResource.d.ts +0 -76
  196. package/dist/models/LineItemListResource.js +0 -81
  197. package/dist/models/LineItemListResourceArrayResponse.d.ts +0 -33
  198. package/dist/models/LineItemListResourceArrayResponse.js +0 -50
  199. package/dist/models/PaginatedCartListResourceResponse.d.ts +0 -40
  200. package/dist/models/PaginatedCartListResourceResponse.js +0 -57
  201. package/dist/models/PaginatedCustomerListResourceResponse.d.ts +0 -40
  202. package/dist/models/PaginatedCustomerListResourceResponse.js +0 -57
  203. package/dist/models/ProductChildCartLiteResource.d.ts +0 -76
  204. package/dist/models/ProductChildCartLiteResource.js +0 -81
  205. package/dist/models/ProductChildCartLiteResourceArrayResponse.d.ts +0 -33
  206. package/dist/models/ProductChildCartLiteResourceArrayResponse.js +0 -50
  207. package/dist/models/ShippingType.d.ts +0 -28
  208. package/dist/models/ShippingType.js +0 -54
  209. package/dist/models/StoreCartRequest.d.ts +0 -160
  210. package/dist/models/StoreCartRequest.js +0 -112
  211. package/dist/models/StoreCartRequestCustomer.d.ts +0 -50
  212. package/dist/models/StoreCartRequestCustomer.js +0 -55
  213. package/dist/models/StoreCartRequestItemsInner.d.ts +0 -44
  214. package/dist/models/StoreCartRequestItemsInner.js +0 -57
  215. package/dist/models/StoreCartRequestShippingAddress.d.ts +0 -68
  216. package/dist/models/StoreCartRequestShippingAddress.js +0 -61
  217. package/dist/models/StoreCustomerRequest.d.ts +0 -56
  218. package/dist/models/StoreCustomerRequest.js +0 -65
  219. package/dist/models/UpdateCartRequest.d.ts +0 -135
  220. package/dist/models/UpdateCartRequest.js +0 -99
  221. package/dist/models/UpdateCustomerRequest.d.ts +0 -56
  222. package/dist/models/UpdateCustomerRequest.js +0 -63
  223. package/dist/models/UpdateItemCartRequest.d.ts +0 -38
  224. package/dist/models/UpdateItemCartRequest.js +0 -53
  225. package/docs/AttachCouponCartRequest.md +0 -34
  226. package/docs/AttachItemCartRequest.md +0 -38
  227. package/docs/CartCouponLiteResource.md +0 -38
  228. package/docs/CartCouponLiteResourceArrayResponse.md +0 -34
  229. package/docs/CartCouponResource.md +0 -40
  230. package/docs/CartCouponResourceArrayResponse.md +0 -34
  231. package/docs/CartListResource.md +0 -72
  232. package/docs/CartListResourceArrayResponse.md +0 -34
  233. package/docs/CartOrderSource.md +0 -32
  234. package/docs/CartResource.md +0 -102
  235. package/docs/CartResourceArrayResponse.md +0 -34
  236. package/docs/CartStatus.md +0 -32
  237. package/docs/CartsApi.md +0 -755
  238. package/docs/CustomerListResource.md +0 -48
  239. package/docs/CustomerListResourceArrayResponse.md +0 -34
  240. package/docs/CustomerResource.md +0 -48
  241. package/docs/CustomerResourceArrayResponse.md +0 -34
  242. package/docs/CustomersApi.md +0 -275
  243. package/docs/DetachCouponCartRequest.md +0 -34
  244. package/docs/DiscountType.md +0 -32
  245. package/docs/DiscountValueType.md +0 -32
  246. package/docs/FrontendCartResource.md +0 -68
  247. package/docs/FrontendCartResourceArrayResponse.md +0 -34
  248. package/docs/FrontendLineItemResource.md +0 -44
  249. package/docs/FrontendLineItemResourceArrayResponse.md +0 -34
  250. package/docs/IndexCartRequest.md +0 -66
  251. package/docs/IndexCustomerRequest.md +0 -50
  252. package/docs/LiAddressResource.md +0 -52
  253. package/docs/LiAddressResourceArrayResponse.md +0 -34
  254. package/docs/LineItemDiscountResource.md +0 -40
  255. package/docs/LineItemDiscountResourceArrayResponse.md +0 -34
  256. package/docs/LineItemListResource.md +0 -48
  257. package/docs/LineItemListResourceArrayResponse.md +0 -34
  258. package/docs/PaginatedCartListResourceResponse.md +0 -36
  259. package/docs/PaginatedCustomerListResourceResponse.md +0 -36
  260. package/docs/ProductChildCartLiteResource.md +0 -48
  261. package/docs/ProductChildCartLiteResourceArrayResponse.md +0 -34
  262. package/docs/ShippingType.md +0 -32
  263. package/docs/StoreCartRequest.md +0 -68
  264. package/docs/StoreCartRequestCustomer.md +0 -40
  265. package/docs/StoreCartRequestItemsInner.md +0 -38
  266. package/docs/StoreCartRequestShippingAddress.md +0 -46
  267. package/docs/StoreCustomerRequest.md +0 -42
  268. package/docs/UpdateCartRequest.md +0 -60
  269. package/docs/UpdateCustomerRequest.md +0 -42
  270. package/docs/UpdateItemCartRequest.md +0 -36
  271. package/src/apis/CartsApi.ts +0 -624
  272. package/src/apis/CustomersApi.ts +0 -232
  273. package/src/models/AddressType.ts +0 -53
  274. package/src/models/AttachCouponCartRequest.ts +0 -66
  275. package/src/models/AttachItemCartRequest.ts +0 -83
  276. package/src/models/CartCouponLiteResource.ts +0 -84
  277. package/src/models/CartCouponLiteResourceArrayResponse.ts +0 -73
  278. package/src/models/CartCouponResource.ts +0 -93
  279. package/src/models/CartCouponResourceArrayResponse.ts +0 -73
  280. package/src/models/CartListResource.ts +0 -250
  281. package/src/models/CartListResourceArrayResponse.ts +0 -73
  282. package/src/models/CartOrderSource.ts +0 -57
  283. package/src/models/CartResource.ts +0 -398
  284. package/src/models/CartResourceArrayResponse.ts +0 -73
  285. package/src/models/CartStatus.ts +0 -54
  286. package/src/models/CustomerListResource.ts +0 -142
  287. package/src/models/CustomerListResourceArrayResponse.ts +0 -73
  288. package/src/models/CustomerResource.ts +0 -142
  289. package/src/models/CustomerResourceArrayResponse.ts +0 -73
  290. package/src/models/DetachCouponCartRequest.ts +0 -66
  291. package/src/models/DiscountType.ts +0 -54
  292. package/src/models/DiscountValueType.ts +0 -53
  293. package/src/models/FrontendCartResource.ts +0 -246
  294. package/src/models/FrontendCartResourceArrayResponse.ts +0 -73
  295. package/src/models/FrontendLineItemResource.ts +0 -118
  296. package/src/models/FrontendLineItemResourceArrayResponse.ts +0 -73
  297. package/src/models/IndexCartRequest.ts +0 -224
  298. package/src/models/IndexCustomerRequest.ts +0 -152
  299. package/src/models/LiAddressResource.ts +0 -145
  300. package/src/models/LiAddressResourceArrayResponse.ts +0 -73
  301. package/src/models/LineItemDiscountResource.ts +0 -93
  302. package/src/models/LineItemDiscountResourceArrayResponse.ts +0 -73
  303. package/src/models/LineItemListResource.ts +0 -144
  304. package/src/models/LineItemListResourceArrayResponse.ts +0 -73
  305. package/src/models/PaginatedCartListResourceResponse.ts +0 -90
  306. package/src/models/PaginatedCustomerListResourceResponse.ts +0 -90
  307. package/src/models/ProductChildCartLiteResource.ts +0 -144
  308. package/src/models/ProductChildCartLiteResourceArrayResponse.ts +0 -73
  309. package/src/models/ShippingType.ts +0 -56
  310. package/src/models/StoreCartRequest.ts +0 -252
  311. package/src/models/StoreCartRequestCustomer.ts +0 -89
  312. package/src/models/StoreCartRequestItemsInner.ts +0 -83
  313. package/src/models/StoreCartRequestShippingAddress.ts +0 -113
  314. package/src/models/StoreCustomerRequest.ts +0 -101
  315. package/src/models/UpdateCartRequest.ts +0 -211
  316. package/src/models/UpdateCustomerRequest.ts +0 -100
  317. package/src/models/UpdateItemCartRequest.ts +0 -74
@@ -1,48 +0,0 @@
1
-
2
- # CustomerListResource
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `id` | number
10
- `firstName` | string
11
- `lastName` | string
12
- `email` | string
13
- `phone` | string
14
- `siteId` | string
15
- `site` | [SiteLiteResource](SiteLiteResource.md)
16
- `addresses` | [Array<LiAddressResource>](LiAddressResource.md)
17
-
18
- ## Example
19
-
20
- ```typescript
21
- import type { CustomerListResource } from '@digital8/lighting-illusions-ts-sdk'
22
-
23
- // TODO: Update the object below with actual values
24
- const example = {
25
- "id": null,
26
- "firstName": null,
27
- "lastName": null,
28
- "email": null,
29
- "phone": null,
30
- "siteId": null,
31
- "site": null,
32
- "addresses": null,
33
- } satisfies CustomerListResource
34
-
35
- console.log(example)
36
-
37
- // Convert the instance to a JSON string
38
- const exampleJSON: string = JSON.stringify(example)
39
- console.log(exampleJSON)
40
-
41
- // Parse the JSON string back to an object
42
- const exampleParsed = JSON.parse(exampleJSON) as CustomerListResource
43
- console.log(exampleParsed)
44
- ```
45
-
46
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
47
-
48
-
@@ -1,34 +0,0 @@
1
-
2
- # CustomerListResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<CustomerListResource>](CustomerListResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { CustomerListResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies CustomerListResourceArrayResponse
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 CustomerListResourceArrayResponse
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
-
@@ -1,48 +0,0 @@
1
-
2
- # CustomerResource
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `id` | number
10
- `firstName` | string
11
- `lastName` | string
12
- `email` | string
13
- `phone` | string
14
- `siteId` | string
15
- `site` | [SiteLiteResource](SiteLiteResource.md)
16
- `addresses` | [Array<LiAddressResource>](LiAddressResource.md)
17
-
18
- ## Example
19
-
20
- ```typescript
21
- import type { CustomerResource } from '@digital8/lighting-illusions-ts-sdk'
22
-
23
- // TODO: Update the object below with actual values
24
- const example = {
25
- "id": null,
26
- "firstName": null,
27
- "lastName": null,
28
- "email": null,
29
- "phone": null,
30
- "siteId": null,
31
- "site": null,
32
- "addresses": null,
33
- } satisfies CustomerResource
34
-
35
- console.log(example)
36
-
37
- // Convert the instance to a JSON string
38
- const exampleJSON: string = JSON.stringify(example)
39
- console.log(exampleJSON)
40
-
41
- // Parse the JSON string back to an object
42
- const exampleParsed = JSON.parse(exampleJSON) as CustomerResource
43
- console.log(exampleParsed)
44
- ```
45
-
46
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
47
-
48
-
@@ -1,34 +0,0 @@
1
-
2
- # CustomerResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<CustomerResource>](CustomerResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { CustomerResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies CustomerResourceArrayResponse
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 CustomerResourceArrayResponse
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
-
@@ -1,275 +0,0 @@
1
- # CustomersApi
2
-
3
- All URIs are relative to *http://localhost/api*
4
-
5
- | Method | HTTP request | Description |
6
- |------------- | ------------- | -------------|
7
- | [**indexCustomer**](CustomersApi.md#indexcustomeroperation) | **POST** /admin-api/customers/list | Auto-generated: indexCustomer |
8
- | [**showCustomer**](CustomersApi.md#showcustomer) | **GET** /admin-api/customers/{customer} | Auto-generated: showCustomer |
9
- | [**storeCustomer**](CustomersApi.md#storecustomeroperation) | **POST** /admin-api/customers/create | Auto-generated: storeCustomer |
10
- | [**updateCustomer**](CustomersApi.md#updatecustomeroperation) | **PUT** /admin-api/customers/{customer}/update | Auto-generated: updateCustomer |
11
-
12
-
13
-
14
- ## indexCustomer
15
-
16
- > PaginatedCustomerListResourceResponse indexCustomer(indexCustomerRequest)
17
-
18
- Auto-generated: indexCustomer
19
-
20
- ### Example
21
-
22
- ```ts
23
- import {
24
- Configuration,
25
- CustomersApi,
26
- } from '@digital8/lighting-illusions-ts-sdk';
27
- import type { IndexCustomerOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
28
-
29
- async function example() {
30
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
31
- const api = new CustomersApi();
32
-
33
- const body = {
34
- // IndexCustomerRequest (optional)
35
- indexCustomerRequest: ...,
36
- } satisfies IndexCustomerOperationRequest;
37
-
38
- try {
39
- const data = await api.indexCustomer(body);
40
- console.log(data);
41
- } catch (error) {
42
- console.error(error);
43
- }
44
- }
45
-
46
- // Run the test
47
- example().catch(console.error);
48
- ```
49
-
50
- ### Parameters
51
-
52
-
53
- | Name | Type | Description | Notes |
54
- |------------- | ------------- | ------------- | -------------|
55
- | **indexCustomerRequest** | [IndexCustomerRequest](IndexCustomerRequest.md) | | [Optional] |
56
-
57
- ### Return type
58
-
59
- [**PaginatedCustomerListResourceResponse**](PaginatedCustomerListResourceResponse.md)
60
-
61
- ### Authorization
62
-
63
- No authorization required
64
-
65
- ### HTTP request headers
66
-
67
- - **Content-Type**: `application/json`
68
- - **Accept**: `application/json`
69
-
70
-
71
- ### HTTP response details
72
- | Status code | Description | Response headers |
73
- |-------------|-------------|------------------|
74
- | **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\CustomerListResource[]>> | - |
75
-
76
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
77
-
78
-
79
- ## showCustomer
80
-
81
- > CustomerResource showCustomer(customer)
82
-
83
- Auto-generated: showCustomer
84
-
85
- ### Example
86
-
87
- ```ts
88
- import {
89
- Configuration,
90
- CustomersApi,
91
- } from '@digital8/lighting-illusions-ts-sdk';
92
- import type { ShowCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
93
-
94
- async function example() {
95
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
96
- const api = new CustomersApi();
97
-
98
- const body = {
99
- // number | The id of the customer
100
- customer: 56,
101
- } satisfies ShowCustomerRequest;
102
-
103
- try {
104
- const data = await api.showCustomer(body);
105
- console.log(data);
106
- } catch (error) {
107
- console.error(error);
108
- }
109
- }
110
-
111
- // Run the test
112
- example().catch(console.error);
113
- ```
114
-
115
- ### Parameters
116
-
117
-
118
- | Name | Type | Description | Notes |
119
- |------------- | ------------- | ------------- | -------------|
120
- | **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
121
-
122
- ### Return type
123
-
124
- [**CustomerResource**](CustomerResource.md)
125
-
126
- ### Authorization
127
-
128
- No authorization required
129
-
130
- ### HTTP request headers
131
-
132
- - **Content-Type**: Not defined
133
- - **Accept**: `application/json`
134
-
135
-
136
- ### HTTP response details
137
- | Status code | Description | Response headers |
138
- |-------------|-------------|------------------|
139
- | **200** | Successful resource response | - |
140
-
141
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
142
-
143
-
144
- ## storeCustomer
145
-
146
- > CustomerResource storeCustomer(storeCustomerRequest)
147
-
148
- Auto-generated: storeCustomer
149
-
150
- ### Example
151
-
152
- ```ts
153
- import {
154
- Configuration,
155
- CustomersApi,
156
- } from '@digital8/lighting-illusions-ts-sdk';
157
- import type { StoreCustomerOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
158
-
159
- async function example() {
160
- console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
161
- const api = new CustomersApi();
162
-
163
- const body = {
164
- // StoreCustomerRequest (optional)
165
- storeCustomerRequest: ...,
166
- } satisfies StoreCustomerOperationRequest;
167
-
168
- try {
169
- const data = await api.storeCustomer(body);
170
- console.log(data);
171
- } catch (error) {
172
- console.error(error);
173
- }
174
- }
175
-
176
- // Run the test
177
- example().catch(console.error);
178
- ```
179
-
180
- ### Parameters
181
-
182
-
183
- | Name | Type | Description | Notes |
184
- |------------- | ------------- | ------------- | -------------|
185
- | **storeCustomerRequest** | [StoreCustomerRequest](StoreCustomerRequest.md) | | [Optional] |
186
-
187
- ### Return type
188
-
189
- [**CustomerResource**](CustomerResource.md)
190
-
191
- ### Authorization
192
-
193
- No authorization required
194
-
195
- ### HTTP request headers
196
-
197
- - **Content-Type**: `application/json`
198
- - **Accept**: `application/json`
199
-
200
-
201
- ### HTTP response details
202
- | Status code | Description | Response headers |
203
- |-------------|-------------|------------------|
204
- | **200** | Successful resource response | - |
205
-
206
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
207
-
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,34 +0,0 @@
1
-
2
- # DetachCouponCartRequest
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `couponIds` | Array<number>
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { DetachCouponCartRequest } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "couponIds": null,
19
- } satisfies DetachCouponCartRequest
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 DetachCouponCartRequest
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
-
@@ -1,32 +0,0 @@
1
-
2
- # DiscountType
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import type { DiscountType } from '@digital8/lighting-illusions-ts-sdk'
14
-
15
- // TODO: Update the object below with actual values
16
- const example = {
17
- } satisfies DiscountType
18
-
19
- console.log(example)
20
-
21
- // Convert the instance to a JSON string
22
- const exampleJSON: string = JSON.stringify(example)
23
- console.log(exampleJSON)
24
-
25
- // Parse the JSON string back to an object
26
- const exampleParsed = JSON.parse(exampleJSON) as DiscountType
27
- console.log(exampleParsed)
28
- ```
29
-
30
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
31
-
32
-
@@ -1,32 +0,0 @@
1
-
2
- # DiscountValueType
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import type { DiscountValueType } from '@digital8/lighting-illusions-ts-sdk'
14
-
15
- // TODO: Update the object below with actual values
16
- const example = {
17
- } satisfies DiscountValueType
18
-
19
- console.log(example)
20
-
21
- // Convert the instance to a JSON string
22
- const exampleJSON: string = JSON.stringify(example)
23
- console.log(exampleJSON)
24
-
25
- // Parse the JSON string back to an object
26
- const exampleParsed = JSON.parse(exampleJSON) as DiscountValueType
27
- console.log(exampleParsed)
28
- ```
29
-
30
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
31
-
32
-
@@ -1,68 +0,0 @@
1
-
2
- # FrontendCartResource
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `id` | number
10
- `lifecycleStatus` | string
11
- `siteId` | number
12
- `sessionToken` | string
13
- `customer` | [CustomerListResource](CustomerListResource.md)
14
- `shippingType` | string
15
- `shippingAddress` | [AddressResource](AddressResource.md)
16
- `billingAddress` | [AddressResource](AddressResource.md)
17
- `lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
18
- `coupons` | [Array<CartCouponLiteResource>](CartCouponLiteResource.md)
19
- `subtotal` | number
20
- `promotionalDiscount` | number
21
- `couponSubtotalDiscount` | number
22
- `couponShippingDiscount` | number
23
- `shipping` | number
24
- `transitInsurance` | number
25
- `gst` | number
26
- `grandTotal` | number
27
-
28
- ## Example
29
-
30
- ```typescript
31
- import type { FrontendCartResource } from '@digital8/lighting-illusions-ts-sdk'
32
-
33
- // TODO: Update the object below with actual values
34
- const example = {
35
- "id": null,
36
- "lifecycleStatus": null,
37
- "siteId": null,
38
- "sessionToken": null,
39
- "customer": null,
40
- "shippingType": null,
41
- "shippingAddress": null,
42
- "billingAddress": null,
43
- "lineItems": null,
44
- "coupons": null,
45
- "subtotal": null,
46
- "promotionalDiscount": null,
47
- "couponSubtotalDiscount": null,
48
- "couponShippingDiscount": null,
49
- "shipping": null,
50
- "transitInsurance": null,
51
- "gst": null,
52
- "grandTotal": null,
53
- } satisfies FrontendCartResource
54
-
55
- console.log(example)
56
-
57
- // Convert the instance to a JSON string
58
- const exampleJSON: string = JSON.stringify(example)
59
- console.log(exampleJSON)
60
-
61
- // Parse the JSON string back to an object
62
- const exampleParsed = JSON.parse(exampleJSON) as FrontendCartResource
63
- console.log(exampleParsed)
64
- ```
65
-
66
- [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
67
-
68
-
@@ -1,34 +0,0 @@
1
-
2
- # FrontendCartResourceArrayResponse
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `data` | [Array<FrontendCartResource>](FrontendCartResource.md)
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import type { FrontendCartResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
15
-
16
- // TODO: Update the object below with actual values
17
- const example = {
18
- "data": null,
19
- } satisfies FrontendCartResourceArrayResponse
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 FrontendCartResourceArrayResponse
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
-
@@ -1,44 +0,0 @@
1
-
2
- # FrontendLineItemResource
3
-
4
-
5
- ## Properties
6
-
7
- Name | Type
8
- ------------ | -------------
9
- `id` | number
10
- `quantity` | number
11
- `productPrice` | number
12
- `subtotalAmount` | number
13
- `totalAmount` | number
14
- `productChild` | [ProductChildCartLiteResource](ProductChildCartLiteResource.md)
15
-
16
- ## Example
17
-
18
- ```typescript
19
- import type { FrontendLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
20
-
21
- // TODO: Update the object below with actual values
22
- const example = {
23
- "id": null,
24
- "quantity": null,
25
- "productPrice": null,
26
- "subtotalAmount": null,
27
- "totalAmount": null,
28
- "productChild": null,
29
- } satisfies FrontendLineItemResource
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 FrontendLineItemResource
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
-