@digital8/lighting-illusions-ts-sdk 0.0.2056 → 0.0.2057

package/docs/CartsApi.md

@@ -21,7 +21,7 @@ All URIs are relative to *http://localhost/api*
 
 ## attachCouponCart
 
-> CartResource attachCouponCart(cart, attachCouponRequest)
+> CartResource attachCouponCart(cart, attachCartCouponRequest)
 
 Auto-generated: attachCouponCart
 
@@ -41,8 +41,8 @@ async function example() {
   const body = {
     // number | The id of the cart
     cart: 56,
-    // AttachCouponRequest (optional)
-    attachCouponRequest: ...,
+    // AttachCartCouponRequest (optional)
+    attachCartCouponRequest: ...,
   } satisfies AttachCouponCartRequest;
 
   try {
@@ -63,7 +63,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-| **attachCouponRequest** | [AttachCouponRequest](AttachCouponRequest.md) |  | [Optional] |
+| **attachCartCouponRequest** | [AttachCartCouponRequest](AttachCartCouponRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -89,7 +89,7 @@ No authorization required
 
 ## attachItemCart
 
-> CartResource attachItemCart(cart, attachLineItemRequest)
+> CartResource attachItemCart(cart, attachCartItemRequest)
 
 Auto-generated: attachItemCart
 
@@ -109,8 +109,8 @@ async function example() {
   const body = {
     // number | The id of the cart
     cart: 56,
-    // AttachLineItemRequest (optional)
-    attachLineItemRequest: ...,
+    // AttachCartItemRequest (optional)
+    attachCartItemRequest: ...,
   } satisfies AttachItemCartRequest;
 
   try {
@@ -131,7 +131,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-| **attachLineItemRequest** | [AttachLineItemRequest](AttachLineItemRequest.md) |  | [Optional] |
+| **attachCartItemRequest** | [AttachCartItemRequest](AttachCartItemRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -222,7 +222,7 @@ No authorization required
 
 ## detachCouponCart
 
-> CartResource detachCouponCart(cart, detachCouponRequest)
+> CartResource detachCouponCart(cart, detachCartCouponRequest)
 
 Auto-generated: detachCouponCart
 
@@ -242,8 +242,8 @@ async function example() {
   const body = {
     // number | The id of the cart
     cart: 56,
-    // DetachCouponRequest (optional)
-    detachCouponRequest: ...,
+    // DetachCartCouponRequest (optional)
+    detachCartCouponRequest: ...,
   } satisfies DetachCouponCartRequest;
 
   try {
@@ -264,7 +264,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
-| **detachCouponRequest** | [DetachCouponRequest](DetachCouponRequest.md) |  | [Optional] |
+| **detachCartCouponRequest** | [DetachCartCouponRequest](DetachCartCouponRequest.md) |  | [Optional] |
 
 ### Return type
 
@@ -751,7 +751,7 @@ No authorization required
 
 ## updateItemCart
 
-> CartResource updateItemCart(cart, lineItem, updateLineItemRequest)
+> CartResource updateItemCart(cart, lineItem, updateCartItemRequest)
 
 Auto-generated: updateItemCart
 
@@ -773,8 +773,8 @@ async function example() {
     cart: 56,
     // number | The id of the lineItem
     lineItem: 56,
-    // UpdateLineItemRequest (optional)
-    updateLineItemRequest: ...,
+    // UpdateCartItemRequest (optional)
+    updateCartItemRequest: ...,
   } satisfies UpdateItemCartRequest;
 
   try {
@@ -796,7 +796,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **cart** | `number` | The id of the cart | [Defaults to `undefined`] |
 | **lineItem** | `number` | The id of the lineItem | [Defaults to `undefined`] |
-| **updateLineItemRequest** | [UpdateLineItemRequest](UpdateLineItemRequest.md) |  | [Optional] |
+| **updateCartItemRequest** | [UpdateCartItemRequest](UpdateCartItemRequest.md) |  | [Optional] |
 
 ### Return type
 

package/docs/CreateTransactionRequest.md

@@ -11,7 +11,6 @@ Name | Type
 `amount` | number
 `surcharge` | number
 `paymentMethod` | string
-`description` | string
 `nonce` | string
 `deviceData` | string
 
@@ -27,7 +26,6 @@ const example = {
   "amount": null,
   "surcharge": null,
   "paymentMethod": null,
-  "description": null,
   "nonce": null,
   "deviceData": null,
 } satisfies CreateTransactionRequest

package/docs/CustomerListResource.md

@@ -12,6 +12,7 @@ Name | Type
 `email` | string
 `phone` | string
 `site` | [SiteLiteResource](SiteLiteResource.md)
+`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
 
 ## Example
 
@@ -26,6 +27,7 @@ const example = {
   "email": null,
   "phone": null,
   "site": null,
+  "addresses": null,
 } satisfies CustomerListResource
 
 console.log(example)

package/docs/CustomersApi.md

@@ -7,6 +7,7 @@ All URIs are relative to *http://localhost/api*
 | [**indexCustomer**](CustomersApi.md#indexcustomer) | **POST** /admin-api/customers/list | Auto-generated: indexCustomer |
 | [**showCustomer**](CustomersApi.md#showcustomer) | **GET** /admin-api/customers/{customer} | Auto-generated: showCustomer |
 | [**storeCustomer**](CustomersApi.md#storecustomer) | **POST** /admin-api/customers/create | Auto-generated: storeCustomer |
+| [**updateCustomer**](CustomersApi.md#updatecustomeroperation) | **PUT** /admin-api/customers/{customer}/update | Auto-generated: updateCustomer |
 
 
 
@@ -204,3 +205,71 @@ No authorization required
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## updateCustomer
+
+> CustomerResource updateCustomer(customer, updateCustomerRequest)
+
+Auto-generated: updateCustomer
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CustomersApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { UpdateCustomerOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new CustomersApi();
+
+  const body = {
+    // number | The id of the customer
+    customer: 56,
+    // UpdateCustomerRequest (optional)
+    updateCustomerRequest: ...,
+  } satisfies UpdateCustomerOperationRequest;
+
+  try {
+    const data = await api.updateCustomer(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **customer** | `number` | The id of the customer | [Defaults to `undefined`] |
+| **updateCustomerRequest** | [UpdateCustomerRequest](UpdateCustomerRequest.md) |  | [Optional] |
+
+### Return type
+
+[**CustomerResource**](CustomerResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful resource response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/{DetachCouponRequest.md → DetachCartCouponRequest.md}

@@ -1,5 +1,5 @@
 
-# DetachCouponRequest
+# DetachCartCouponRequest
 
 
 ## Properties
@@ -11,12 +11,12 @@ Name | Type
 ## Example
 
 ```typescript
-import type { DetachCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
+import type { DetachCartCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "couponIds": null,
-} satisfies DetachCouponRequest
+} satisfies DetachCartCouponRequest
 
 console.log(example)
 
@@ -25,7 +25,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as DetachCouponRequest
+const exampleParsed = JSON.parse(exampleJSON) as DetachCartCouponRequest
 console.log(exampleParsed)
 ```
 

package/docs/DetachOrderCouponRequest.md

@@ -0,0 +1,34 @@
+
+# DetachOrderCouponRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`couponId` | number
+
+## Example
+
+```typescript
+import type { DetachOrderCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "couponId": null,
+} satisfies DetachOrderCouponRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as DetachOrderCouponRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FrontendCartResource.md

@@ -0,0 +1,70 @@
+
+# FrontendCartResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`lifecycleStatus` | string
+`siteId` | number
+`sessionToken` | string
+`guestEmail` | string
+`customer` | [CustomerListResource](CustomerListResource.md)
+`shippingType` | string
+`shippingAddress` | [AddressResource](AddressResource.md)
+`billingAddress` | [AddressResource](AddressResource.md)
+`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
+`coupons` | [Array<FrontendCartResourceCouponsInner>](FrontendCartResourceCouponsInner.md)
+`subtotal` | number
+`promotionalDiscount` | number
+`couponSubtotalDiscount` | number
+`couponShippingDiscount` | number
+`shipping` | number
+`transitInsurance` | number
+`gst` | number
+`grandTotal` | number
+
+## Example
+
+```typescript
+import type { FrontendCartResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "lifecycleStatus": null,
+  "siteId": null,
+  "sessionToken": null,
+  "guestEmail": null,
+  "customer": null,
+  "shippingType": null,
+  "shippingAddress": null,
+  "billingAddress": null,
+  "lineItems": null,
+  "coupons": null,
+  "subtotal": null,
+  "promotionalDiscount": null,
+  "couponSubtotalDiscount": null,
+  "couponShippingDiscount": null,
+  "shipping": null,
+  "transitInsurance": null,
+  "gst": null,
+  "grandTotal": null,
+} satisfies FrontendCartResource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FrontendCartResource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FrontendCartResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# FrontendCartResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<FrontendCartResource>](FrontendCartResource.md)
+
+## Example
+
+```typescript
+import type { FrontendCartResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies FrontendCartResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FrontendCartResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FrontendCartResourceCouponsInner.md

@@ -0,0 +1,42 @@
+
+# FrontendCartResourceCouponsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`code` | string
+`name` | string
+`discount` | number
+`appliesTo` | string
+
+## Example
+
+```typescript
+import type { FrontendCartResourceCouponsInner } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "code": null,
+  "name": null,
+  "discount": null,
+  "appliesTo": null,
+} satisfies FrontendCartResourceCouponsInner
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FrontendCartResourceCouponsInner
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FrontendLineItemResource.md

@@ -0,0 +1,50 @@
+
+# FrontendLineItemResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`quantity` | number
+`productPrice` | number
+`subtotalAmount` | number
+`totalAmount` | number
+`promotionalSaving` | number
+`isAvailable` | boolean
+`isInStock` | boolean
+`productChild` | [ProductChildLineItemLiteResource](ProductChildLineItemLiteResource.md)
+
+## Example
+
+```typescript
+import type { FrontendLineItemResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "quantity": null,
+  "productPrice": null,
+  "subtotalAmount": null,
+  "totalAmount": null,
+  "promotionalSaving": null,
+  "isAvailable": null,
+  "isInStock": null,
+  "productChild": null,
+} satisfies FrontendLineItemResource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FrontendLineItemResource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FrontendLineItemResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# FrontendLineItemResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
+
+## Example
+
+```typescript
+import type { FrontendLineItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies FrontendLineItemResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FrontendLineItemResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FrontendOrderResource.md

@@ -0,0 +1,80 @@
+
+# FrontendOrderResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`cartId` | number
+`siteId` | number
+`placedAt` | Date
+`source` | string
+`paymentToken` | string
+`accessToken` | string
+`shippingType` | string
+`customer` | [CustomerListResource](CustomerListResource.md)
+`status` | object
+`shippingAddress` | [AddressResource](AddressResource.md)
+`billingAddress` | [AddressResource](AddressResource.md)
+`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
+`coupons` | [Array<CartCouponLiteResource>](CartCouponLiteResource.md)
+`subtotal` | number
+`promotionalDiscount` | number
+`couponSubtotalDiscount` | number
+`couponShippingDiscount` | number
+`shipping` | number
+`transitInsurance` | number
+`gst` | number
+`grandTotal` | number
+`amountPaid` | number
+`amountDue` | number
+
+## Example
+
+```typescript
+import type { FrontendOrderResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "cartId": null,
+  "siteId": null,
+  "placedAt": null,
+  "source": null,
+  "paymentToken": null,
+  "accessToken": null,
+  "shippingType": null,
+  "customer": null,
+  "status": null,
+  "shippingAddress": null,
+  "billingAddress": null,
+  "lineItems": null,
+  "coupons": null,
+  "subtotal": null,
+  "promotionalDiscount": null,
+  "couponSubtotalDiscount": null,
+  "couponShippingDiscount": null,
+  "shipping": null,
+  "transitInsurance": null,
+  "gst": null,
+  "grandTotal": null,
+  "amountPaid": null,
+  "amountDue": null,
+} satisfies FrontendOrderResource
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FrontendOrderResource
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FrontendOrderResourceArrayResponse.md

@@ -0,0 +1,34 @@
+
+# FrontendOrderResourceArrayResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<FrontendOrderResource>](FrontendOrderResource.md)
+
+## Example
+
+```typescript
+import type { FrontendOrderResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+} satisfies FrontendOrderResourceArrayResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FrontendOrderResourceArrayResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+