@digital8/lighting-illusions-ts-sdk 0.0.2175 → 0.0.2177

package/docs/CreateCartRequest.md

@@ -0,0 +1,72 @@
+
+# CreateCartRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`customerId` | number
+`siteId` | number
+`token` | string
+`sessionToken` | string
+`paymentToken` | string
+`guestEmail` | string
+`source` | string
+`items` | [Array<CreateCartRequestItemsInner>](CreateCartRequestItemsInner.md)
+`couponCodes` | Array<string>
+`shippingType` | string
+`shippingSubtotal` | number
+`overrideShipping` | boolean
+`insuranceAmount` | number
+`includeInsurance` | boolean
+`overrideInsurance` | boolean
+`useAsBillingAddress` | boolean
+`shippingAddressId` | number
+`billingAddressId` | number
+`shippingAddress` | [CreateCartRequestShippingAddress](CreateCartRequestShippingAddress.md)
+`billingAddress` | [CreateCartRequestShippingAddress](CreateCartRequestShippingAddress.md)
+
+## Example
+
+```typescript
+import type { CreateCartRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "customerId": null,
+  "siteId": null,
+  "token": null,
+  "sessionToken": null,
+  "paymentToken": null,
+  "guestEmail": null,
+  "source": null,
+  "items": null,
+  "couponCodes": null,
+  "shippingType": null,
+  "shippingSubtotal": null,
+  "overrideShipping": null,
+  "insuranceAmount": null,
+  "includeInsurance": null,
+  "overrideInsurance": null,
+  "useAsBillingAddress": null,
+  "shippingAddressId": null,
+  "billingAddressId": null,
+  "shippingAddress": null,
+  "billingAddress": null,
+} satisfies CreateCartRequest
+
+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 CreateCartRequest
+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/CreateCartRequestItemsInner.md

@@ -0,0 +1,38 @@
+
+# CreateCartRequestItemsInner
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`productChildId` | number
+`quantity` | number
+`productPrice` | number
+
+## Example
+
+```typescript
+import type { CreateCartRequestItemsInner } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "productChildId": null,
+  "quantity": null,
+  "productPrice": null,
+} satisfies CreateCartRequestItemsInner
+
+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 CreateCartRequestItemsInner
+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/CreateCartRequestShippingAddress.md

@@ -0,0 +1,48 @@
+
+# CreateCartRequestShippingAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`addresseeName` | string
+`company` | string
+`line1` | string
+`line2` | string
+`suburb` | string
+`state` | string
+`postcode` | string
+`country` | string
+
+## Example
+
+```typescript
+import type { CreateCartRequestShippingAddress } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "addresseeName": null,
+  "company": null,
+  "line1": null,
+  "line2": null,
+  "suburb": null,
+  "state": null,
+  "postcode": null,
+  "country": null,
+} satisfies CreateCartRequestShippingAddress
+
+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 CreateCartRequestShippingAddress
+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/CreateCustomerRequest.md

@@ -6,13 +6,11 @@
 
 Name | Type
 ------------ | -------------
+`siteId` | number
 `firstName` | string
 `lastName` | string
-`phone` | string
-`password` | string
 `email` | string
-`siteId` | number
-`subscribedToNewsletter` | boolean
+`phone` | string
 
 ## Example
 
@@ -21,13 +19,11 @@ import type { CreateCustomerRequest } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
+  "siteId": null,
   "firstName": null,
   "lastName": null,
-  "phone": null,
-  "password": null,
   "email": null,
-  "siteId": null,
-  "subscribedToNewsletter": null,
+  "phone": null,
 } satisfies CreateCustomerRequest
 
 console.log(example)

package/docs/CreateStoreRequestAddress.md

@@ -6,6 +6,7 @@
 
 Name | Type
 ------------ | -------------
+`addresseeName` | string
 `company` | string
 `line1` | string
 `line2` | string
@@ -21,6 +22,7 @@ import type { CreateStoreRequestAddress } from '@digital8/lighting-illusions-ts-
 
 // TODO: Update the object below with actual values
 const example = {
+  "addresseeName": null,
   "company": null,
   "line1": null,
   "line2": null,

package/docs/CreateTransactionRequest.md

@@ -0,0 +1,48 @@
+
+# CreateTransactionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cartId` | number
+`orderId` | number
+`amount` | number
+`surcharge` | number
+`paymentMethod` | string
+`description` | string
+`nonce` | string
+`deviceData` | string
+
+## Example
+
+```typescript
+import type { CreateTransactionRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "cartId": null,
+  "orderId": null,
+  "amount": null,
+  "surcharge": null,
+  "paymentMethod": null,
+  "description": null,
+  "nonce": null,
+  "deviceData": null,
+} satisfies CreateTransactionRequest
+
+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 CreateTransactionRequest
+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/CustomerListResource.md

@@ -7,13 +7,11 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`user` | [UserLiteResource](UserLiteResource.md)
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
 `site` | [SiteLiteResource](SiteLiteResource.md)
-`type` | string
-`signUpType` | string
-`subscribedToNewsletter` | boolean
-`netsuiteId` | object
-`createdAt` | Date
 
 ## Example
 
@@ -23,13 +21,11 @@ import type { CustomerListResource } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "user": null,
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
   "site": null,
-  "type": null,
-  "signUpType": null,
-  "subscribedToNewsletter": null,
-  "netsuiteId": null,
-  "createdAt": null,
 } satisfies CustomerListResource
 
 console.log(example)

package/docs/CustomerResource.md

@@ -7,15 +7,12 @@
 Name | Type
 ------------ | -------------
 `id` | number
-`user` | [UserLiteResource](UserLiteResource.md)
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
 `site` | [SiteLiteResource](SiteLiteResource.md)
-`type` | string
-`signUpType` | string
-`socialId` | string
-`subscribedToNewsletter` | boolean
-`netsuiteId` | object
-`createdAt` | Date
-`updatedAt` | Date
+`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
 
 ## Example
 
@@ -25,15 +22,12 @@ import type { CustomerResource } from '@digital8/lighting-illusions-ts-sdk'
 // TODO: Update the object below with actual values
 const example = {
   "id": null,
-  "user": null,
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
   "site": null,
-  "type": null,
-  "signUpType": null,
-  "socialId": null,
-  "subscribedToNewsletter": null,
-  "netsuiteId": null,
-  "createdAt": null,
-  "updatedAt": null,
+  "addresses": null,
 } satisfies CustomerResource
 
 console.log(example)

package/docs/CustomersApi.md

@@ -4,145 +4,12 @@ All URIs are relative to *http://localhost/api*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**destroyCustomer**](CustomersApi.md#destroycustomer) | **DELETE** /admin-api/customers/{customer}/delete | Auto-generated: destroyCustomer |
-| [**getAllCustomer**](CustomersApi.md#getallcustomer) | **POST** /admin-api/customers/all | Auto-generated: getAllCustomer |
 | [**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 |
 
 
 
-## destroyCustomer
-
-> GenericResponse destroyCustomer(customer)
-
-Auto-generated: destroyCustomer
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CustomersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { DestroyCustomerRequest } 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,
-  } satisfies DestroyCustomerRequest;
-
-  try {
-    const data = await api.destroyCustomer(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`] |
-
-### Return type
-
-[**GenericResponse**](GenericResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | \\JsonResponse |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## getAllCustomer
-
-> CustomerLiteResourceArrayResponse getAllCustomer(searchAllCustomersRequest)
-
-Auto-generated: getAllCustomer
-
-### Example
-
-```ts
-import {
-  Configuration,
-  CustomersApi,
-} from '@digital8/lighting-illusions-ts-sdk';
-import type { GetAllCustomerRequest } from '@digital8/lighting-illusions-ts-sdk';
-
-async function example() {
-  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
-  const api = new CustomersApi();
-
-  const body = {
-    // SearchAllCustomersRequest (optional)
-    searchAllCustomersRequest: ...,
-  } satisfies GetAllCustomerRequest;
-
-  try {
-    const data = await api.getAllCustomer(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **searchAllCustomersRequest** | [SearchAllCustomersRequest](SearchAllCustomersRequest.md) |  | [Optional] |
-
-### Return type
-
-[**CustomerLiteResourceArrayResponse**](CustomerLiteResourceArrayResponse.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)
-
-
 ## indexCustomer
 
 > PaginatedCustomerListResourceResponse indexCustomer(searchCustomersRequest)
@@ -337,71 +204,3 @@ 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

@@ -0,0 +1,34 @@
+
+# DetachCouponRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`couponIds` | Array<number>
+
+## Example
+
+```typescript
+import type { DetachCouponRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "couponIds": null,
+} satisfies DetachCouponRequest
+
+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 DetachCouponRequest
+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/DiscountResource.md

@@ -0,0 +1,46 @@
+
+# DiscountResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`discountType` | string
+`discountValueType` | string
+`discountValue` | number
+`itemId` | number
+`name` | string
+`couponCode` | string
+
+## Example
+
+```typescript
+import type { DiscountResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "discountType": null,
+  "discountValueType": null,
+  "discountValue": null,
+  "itemId": null,
+  "name": null,
+  "couponCode": null,
+} satisfies DiscountResource
+
+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 DiscountResource
+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/{UserLiteResourceArrayResponse.md → DiscountResourceArrayResponse.md}

@@ -1,22 +1,22 @@
 
-# UserLiteResourceArrayResponse
+# DiscountResourceArrayResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<UserLiteResource>](UserLiteResource.md)
+`data` | [Array<DiscountResource>](DiscountResource.md)
 
 ## Example
 
 ```typescript
-import type { UserLiteResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { DiscountResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies UserLiteResourceArrayResponse
+} satisfies DiscountResourceArrayResponse
 
 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 UserLiteResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as DiscountResourceArrayResponse
 console.log(exampleParsed)
 ```
 

package/docs/{CustomerType.md → DiscountType.md}

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