@digital8/lighting-illusions-ts-sdk 0.0.2004 → 0.0.2005

package/docs/CreateCartRequest.md

@@ -0,0 +1,70 @@
+
+# CreateCartRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`customerId` | number
+`siteId` | number
+`sessionToken` | string
+`paymentToken` | string
+`guestEmail` | string
+`source` | string
+`items` | [Array<CreateCartRequestItemsInner>](CreateCartRequestItemsInner.md)
+`customer` | [CreateCartRequestCustomer](CreateCartRequestCustomer.md)
+`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,
+  "sessionToken": null,
+  "paymentToken": null,
+  "guestEmail": null,
+  "source": null,
+  "items": null,
+  "customer": 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/CreateCartRequestCustomer.md

@@ -0,0 +1,40 @@
+
+# CreateCartRequestCustomer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
+
+## Example
+
+```typescript
+import type { CreateCartRequestCustomer } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
+} satisfies CreateCartRequestCustomer
+
+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 CreateCartRequestCustomer
+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

@@ -0,0 +1,42 @@
+
+# CreateCustomerRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`siteId` | number
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
+
+## Example
+
+```typescript
+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,
+  "email": null,
+  "phone": null,
+} satisfies CreateCustomerRequest
+
+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 CreateCustomerRequest
+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/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,46 @@
+
+# CreateTransactionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cartId` | number
+`orderId` | number
+`amount` | number
+`surcharge` | number
+`paymentMethod` | 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,
+  "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

@@ -0,0 +1,46 @@
+
+# CustomerListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
+
+## Example
+
+```typescript
+import type { CustomerListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
+  "site": null,
+  "addresses": null,
+} satisfies CustomerListResource
+
+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 CustomerListResource
+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/CustomerListResourceArrayResponse.md

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

@@ -0,0 +1,46 @@
+
+# CustomerResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
+`site` | [SiteLiteResource](SiteLiteResource.md)
+`addresses` | [Array<LiAddressResource>](LiAddressResource.md)
+
+## Example
+
+```typescript
+import type { CustomerResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "firstName": null,
+  "lastName": null,
+  "email": null,
+  "phone": null,
+  "site": null,
+  "addresses": null,
+} satisfies CustomerResource
+
+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 CustomerResource
+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/CustomerResourceArrayResponse.md

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