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

package/docs/SearchOrdersRequest.md

@@ -0,0 +1,64 @@
+
+# SearchOrdersRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`search` | string
+`sortBy` | string
+`sortDirection` | string
+`perPage` | number
+`page` | number
+`siteId` | Array<string>
+`source` | Array<string>
+`statusId` | Array<string>
+`customerId` | Array<string>
+`beforeCreatedAt` | Date
+`afterCreatedAt` | Date
+`beforePlacedAt` | Date
+`afterPlacedAt` | Date
+`relatedId` | number
+`relatedType` | string
+`includesRelations` | boolean
+
+## Example
+
+```typescript
+import type { SearchOrdersRequest } 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,
+  "siteId": null,
+  "source": null,
+  "statusId": null,
+  "customerId": null,
+  "beforeCreatedAt": null,
+  "afterCreatedAt": null,
+  "beforePlacedAt": null,
+  "afterPlacedAt": null,
+  "relatedId": null,
+  "relatedType": null,
+  "includesRelations": null,
+} satisfies SearchOrdersRequest
+
+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 SearchOrdersRequest
+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/SearchTransactionsRequest.md

@@ -0,0 +1,60 @@
+
+# SearchTransactionsRequest
+
+
+## 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 { SearchTransactionsRequest } 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 SearchTransactionsRequest
+
+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 SearchTransactionsRequest
+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/ShippingType.md

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

@@ -6,6 +6,7 @@ All URIs are relative to *http://localhost/api*
 |------------- | ------------- | -------------|
 | [**destroySiteNotification**](SiteApi.md#destroysitenotification) | **DELETE** /admin-api/site/notification/{siteNotification}/delete | Auto-generated: destroySiteNotification |
 | [**getAllSite**](SiteApi.md#getallsite) | **POST** /admin-api/site/all | Auto-generated: getAllSite |
+| [**getPaymentConfigSite**](SiteApi.md#getpaymentconfigsite) | **GET** /admin-api/site/{site}/payment-config | Auto-generated: getPaymentConfigSite |
 | [**indexSite**](SiteApi.md#indexsite) | **POST** /admin-api/site/list | Auto-generated: indexSite |
 | [**indexSiteNotification**](SiteApi.md#indexsitenotification) | **POST** /admin-api/site/notification/list | Auto-generated: indexSiteNotification |
 | [**showSite**](SiteApi.md#showsite) | **GET** /admin-api/site/{site} | Auto-generated: showSite |
@@ -145,6 +146,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)
 
 
+## getPaymentConfigSite
+
+> SitePaymentConfigResource getPaymentConfigSite(site)
+
+Auto-generated: getPaymentConfigSite
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SiteApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { GetPaymentConfigSiteRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new SiteApi();
+
+  const body = {
+    // number | The id of the site
+    site: 56,
+  } satisfies GetPaymentConfigSiteRequest;
+
+  try {
+    const data = await api.getPaymentConfigSite(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **site** | `number` | The id of the site | [Defaults to `undefined`] |
+
+### Return type
+
+[**SitePaymentConfigResource**](SitePaymentConfigResource.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **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)
+
+
 ## indexSite
 
 > PaginatedSiteListResourceResponse indexSite(searchSitesRequest)

package/docs/SitePaymentConfigResource.md

@@ -16,6 +16,7 @@ Name | Type
 `acCouponValue` | number
 `acCouponDiscountType` | string
 `acCouponExpiryDays` | number
+`cartExpiryDays` | number
 `acCouponEnabled` | boolean
 
 ## Example
@@ -35,6 +36,7 @@ const example = {
   "acCouponValue": null,
   "acCouponDiscountType": null,
   "acCouponExpiryDays": null,
+  "cartExpiryDays": null,
   "acCouponEnabled": null,
 } satisfies SitePaymentConfigResource
 

package/docs/StoreSpecialDateFrontendResource.md

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

package/docs/StoreTransactionResource.md

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

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

@@ -0,0 +1,52 @@
+
+# TransactionLiteResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`paymentSource` | string
+`paymentMethod` | string
+`paymentMethodThumbnail` | string
+`type` | string
+`status` | string
+`amount` | number
+`surcharge` | number
+`totalAmount` | number
+`reference` | string
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { TransactionLiteResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "paymentSource": null,
+  "paymentMethod": null,
+  "paymentMethodThumbnail": null,
+  "type": null,
+  "status": null,
+  "amount": null,
+  "surcharge": null,
+  "totalAmount": null,
+  "reference": null,
+  "createdAt": null,
+} satisfies TransactionLiteResource
+
+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 TransactionLiteResource
+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/TransactionLiteResourceArrayResponse.md

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

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

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