@digital8/lighting-illusions-ts-sdk 0.0.1938 → 0.0.1940

package/docs/IndexTransactionRequest.md

@@ -0,0 +1,60 @@
+
+# IndexTransactionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`paymentSource` | Array<string>
+`type` | Array<string>
+`paymentMethod` | Array<string>
+`status` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { IndexTransactionRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "search": null,
+  "sortBy": null,
+  "sortDirection": null,
+  "perPage": null,
+  "page": null,
+  "paymentSource": null,
+  "type": null,
+  "paymentMethod": null,
+  "status": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies IndexTransactionRequest
+
+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 IndexTransactionRequest
+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/PaginatedTransactionListResourceResponse.md

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

@@ -1,22 +1,24 @@
 
-# FrontendLineItemResourceArrayResponse
+# PaginatedTransactionResourceResponse
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`data` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
+`data` | [Array<TransactionResource>](TransactionResource.md)
+`meta` | [PagingMetadata](PagingMetadata.md)
 
 ## Example
 
 ```typescript
-import type { FrontendLineItemResourceArrayResponse } from '@digital8/lighting-illusions-ts-sdk'
+import type { PaginatedTransactionResourceResponse } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "data": null,
-} satisfies FrontendLineItemResourceArrayResponse
+  "meta": null,
+} satisfies PaginatedTransactionResourceResponse
 
 console.log(example)
 
@@ -25,7 +27,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as FrontendLineItemResourceArrayResponse
+const exampleParsed = JSON.parse(exampleJSON) as PaginatedTransactionResourceResponse
 console.log(exampleParsed)
 ```
 

package/docs/{CartCouponLiteResource.md → PaymentMethod.md}

@@ -1,26 +1,20 @@
 
-# CartCouponLiteResource
+# PaymentMethod
 
 
 ## Properties
 
 Name | Type
 ------------ | -------------
-`id` | number
-`code` | string
-`name` | string
 
 ## Example
 
 ```typescript
-import type { CartCouponLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+import type { PaymentMethod } from '@digital8/lighting-illusions-ts-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
-  "code": null,
-  "name": null,
-} satisfies CartCouponLiteResource
+} satisfies PaymentMethod
 
 console.log(example)
 
@@ -29,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 CartCouponLiteResource
+const exampleParsed = JSON.parse(exampleJSON) as PaymentMethod
 console.log(exampleParsed)
 ```
 

package/docs/{CartCouponLiteResourceArrayResponse.md → PaymentSource.md}

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

package/docs/PaymentStatus.md

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

@@ -12,7 +12,6 @@ Name | Type
 `model` | string
 `modelNumber` | string
 `name` | string
-`slug` | string
 `stock` | number
 `salePrice` | number
 `thumbnail` | [AssetLiteResource](AssetLiteResource.md)
@@ -31,7 +30,6 @@ const example = {
   "model": null,
   "modelNumber": null,
   "name": null,
-  "slug": null,
   "stock": null,
   "salePrice": null,
   "thumbnail": null,

package/docs/RefundTransactionRequest.md

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

@@ -18,7 +18,6 @@ Name | Type
 `shippingSubtotal` | number
 `overrideShipping` | boolean
 `insuranceAmount` | number
-`includeInsurance` | boolean
 `overrideInsurance` | boolean
 `useAsBillingAddress` | boolean
 `shippingAddressId` | number
@@ -45,7 +44,6 @@ const example = {
   "shippingSubtotal": null,
   "overrideShipping": null,
   "insuranceAmount": null,
-  "includeInsurance": null,
   "overrideInsurance": null,
   "useAsBillingAddress": null,
   "shippingAddressId": null,

package/docs/StoreCartRequestShippingAddress.md

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `addresseeName` | string
 `company` | string
+`addressee` | string
 `line1` | string
 `line2` | string
 `suburb` | string
@@ -24,6 +25,7 @@ import type { StoreCartRequestShippingAddress } from '@digital8/lighting-illusio
 const example = {
   "addresseeName": null,
   "company": null,
+  "addressee": null,
   "line1": null,
   "line2": null,
   "suburb": null,

package/docs/StoreSpecialDateFrontendResource.md

@@ -9,7 +9,7 @@ Name | Type
 `id` | number
 `name` | string
 `hours` | string
-`date` | object
+`date` | string
 `closed` | boolean
 `displayStartDate` | object
 `displayEndDate` | object

package/docs/StoreSpecialDateResource.md

@@ -9,7 +9,7 @@ Name | Type
 `id` | number
 `name` | string
 `hours` | string
-`date` | string
+`date` | object
 `closed` | boolean
 `displayStartDate` | string
 `displayEndDate` | string

package/docs/StoreTransactionRequest.md

@@ -0,0 +1,46 @@
+
+# StoreTransactionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`cartId` | number
+`orderId` | number
+`amount` | number
+`surcharge` | number
+`paymentMethod` | string
+`nonce` | string
+`deviceData` | string
+
+## Example
+
+```typescript
+import type { StoreTransactionRequest } 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 StoreTransactionRequest
+
+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 StoreTransactionRequest
+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/TransactionListResource.md

@@ -0,0 +1,74 @@
+
+# TransactionListResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`orderId` | number
+`cartId` | number
+`adminId` | number
+`paymentSource` | string
+`paymentMethod` | string
+`type` | string
+`status` | string
+`amount` | number
+`surcharge` | number
+`totalAmount` | number
+`refundedAmount` | number
+`unrefundedAmount` | number
+`reference` | string
+`description` | string
+`extendedData` | string
+`riskScore` | string
+`fraudDecision` | string
+`refundedTransactionId` | number
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { TransactionListResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "orderId": null,
+  "cartId": null,
+  "adminId": null,
+  "paymentSource": null,
+  "paymentMethod": null,
+  "type": null,
+  "status": null,
+  "amount": null,
+  "surcharge": null,
+  "totalAmount": null,
+  "refundedAmount": null,
+  "unrefundedAmount": null,
+  "reference": null,
+  "description": null,
+  "extendedData": null,
+  "riskScore": null,
+  "fraudDecision": null,
+  "refundedTransactionId": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies TransactionListResource
+
+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 TransactionListResource
+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 → TransactionListResourceArrayResponse.md}

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

package/docs/TransactionResource.md

@@ -0,0 +1,74 @@
+
+# TransactionResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`orderId` | number
+`cartId` | number
+`adminId` | number
+`paymentSource` | string
+`paymentMethod` | string
+`type` | string
+`status` | string
+`amount` | number
+`surcharge` | number
+`totalAmount` | number
+`refundedAmount` | number
+`unrefundedAmount` | number
+`reference` | string
+`description` | string
+`extendedData` | string
+`riskScore` | string
+`fraudDecision` | string
+`refundedTransactionId` | number
+`createdAt` | Date
+`updatedAt` | Date
+
+## Example
+
+```typescript
+import type { TransactionResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "orderId": null,
+  "cartId": null,
+  "adminId": null,
+  "paymentSource": null,
+  "paymentMethod": null,
+  "type": null,
+  "status": null,
+  "amount": null,
+  "surcharge": null,
+  "totalAmount": null,
+  "refundedAmount": null,
+  "unrefundedAmount": null,
+  "reference": null,
+  "description": null,
+  "extendedData": null,
+  "riskScore": null,
+  "fraudDecision": null,
+  "refundedTransactionId": null,
+  "createdAt": null,
+  "updatedAt": null,
+} satisfies TransactionResource
+
+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 TransactionResource
+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 → TransactionResourceArrayResponse.md}

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

package/docs/TransactionType.md

@@ -0,0 +1,32 @@
+
+# TransactionType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { TransactionType } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies TransactionType
+
+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 TransactionType
+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)
+
+