@digital8/lighting-illusions-ts-sdk 0.0.1947 → 0.0.1949

package/docs/StoreListResource.md

@@ -15,8 +15,6 @@ Name | Type
 `tagLine` | string
 `email` | string
 `website` | string
-`netsuiteId` | number
-`displayNetsuiteId` | number
 `openingHours` | string
 
 ## Example
@@ -35,8 +33,6 @@ const example = {
   "tagLine": null,
   "email": null,
   "website": null,
-  "netsuiteId": null,
-  "displayNetsuiteId": null,
   "openingHours": null,
 } satisfies StoreListResource
 

package/docs/StoreOverlayTemplateAssetRequest.md

@@ -14,8 +14,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 
 ## Example
 
@@ -32,8 +30,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
 } satisfies StoreOverlayTemplateAssetRequest
 
 console.log(example)

package/docs/StoreProductCategoryRequest.md

@@ -19,8 +19,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 `seo` | [Array<StoreProductCategoryRequestSeoInner>](StoreProductCategoryRequestSeoInner.md)
 `descriptions` | [Array<StoreProductCategoryRequestDescriptionsInner>](StoreProductCategoryRequestDescriptionsInner.md)
 
@@ -44,8 +42,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "seo": null,
   "descriptions": null,
 } satisfies StoreProductCategoryRequest

package/docs/StoreProductChildRequestAssetsInner.md

@@ -9,8 +9,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 `isLifestyleImage` | boolean
 `index` | number
 `overlayTemplateIds` | Array<number>
@@ -25,8 +23,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "isLifestyleImage": null,
   "index": null,
   "overlayTemplateIds": null,

package/docs/StoreResource.md

@@ -15,8 +15,6 @@ Name | Type
 `tagLine` | string
 `email` | string
 `website` | string
-`netsuiteId` | number
-`displayNetsuiteId` | number
 `openingHours` | string
 `suppliers` | [Array<SupplierLiteResource>](SupplierLiteResource.md)
 `address` | [AddressResource](AddressResource.md)
@@ -38,8 +36,6 @@ const example = {
   "tagLine": null,
   "email": null,
   "website": null,
-  "netsuiteId": null,
-  "displayNetsuiteId": null,
   "openingHours": null,
   "suppliers": null,
   "address": null,

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/StoreStoreRequest.md

@@ -15,8 +15,6 @@ Name | Type
 `email` | string
 `website` | string
 `openingHours` | Array<string | null>
-`netsuiteId` | number
-`displayNetsuiteId` | number
 `supplierIds` | Array<number>
 `specialDates` | [Array<StoreStoreRequestSpecialDatesInner>](StoreStoreRequestSpecialDatesInner.md)
 `address` | [StoreStoreRequestAddress](StoreStoreRequestAddress.md)
@@ -37,8 +35,6 @@ const example = {
   "email": null,
   "website": null,
   "openingHours": null,
-  "netsuiteId": null,
-  "displayNetsuiteId": null,
   "supplierIds": null,
   "specialDates": null,
   "address": null,

package/docs/StoreStoreRequestAddress.md

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

package/docs/StoreSupplierRequest.md

@@ -13,8 +13,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 `descriptions` | [Array<StoreProductCategoryRequestDescriptionsInner>](StoreProductCategoryRequestDescriptionsInner.md)
 
 ## Example
@@ -31,8 +29,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "descriptions": null,
 } satisfies StoreSupplierRequest
 

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/TransactionLiteResource.md

@@ -0,0 +1,48 @@
+
+# TransactionLiteResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`paymentMethod` | 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 = {
+  "paymentMethod": 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,64 @@
+
+# TransactionResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`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 = {
+  "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)
+
+

package/docs/TransactionsApi.md

@@ -0,0 +1,209 @@
+# TransactionsApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**indexTransaction**](TransactionsApi.md#indextransactionoperation) | **POST** /admin-api/transactions/list | Auto-generated: indexTransaction |
+| [**refundTransaction**](TransactionsApi.md#refundtransactionoperation) | **POST** /admin-api/transactions/{transaction}/refund | Auto-generated: refundTransaction |
+| [**storeTransaction**](TransactionsApi.md#storetransactionoperation) | **POST** /admin-api/transactions/create | Auto-generated: storeTransaction |
+
+
+
+## indexTransaction
+
+> PaginatedTransactionResourceResponse indexTransaction(indexTransactionRequest)
+
+Auto-generated: indexTransaction
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexTransactionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new TransactionsApi();
+
+  const body = {
+    // IndexTransactionRequest (optional)
+    indexTransactionRequest: ...,
+  } satisfies IndexTransactionOperationRequest;
+
+  try {
+    const data = await api.indexTransaction(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **indexTransactionRequest** | [IndexTransactionRequest](IndexTransactionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**PaginatedTransactionResourceResponse**](PaginatedTransactionResourceResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated response \\JsonResponse<\\ResourcePaginator<\\TransactionResource[]>> |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## refundTransaction
+
+> TransactionResource refundTransaction(transaction, refundTransactionRequest)
+
+Auto-generated: refundTransaction
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { RefundTransactionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new TransactionsApi();
+
+  const body = {
+    // number | The id of the transaction
+    transaction: 56,
+    // RefundTransactionRequest (optional)
+    refundTransactionRequest: ...,
+  } satisfies RefundTransactionOperationRequest;
+
+  try {
+    const data = await api.refundTransaction(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **transaction** | `number` | The id of the transaction | [Defaults to `undefined`] |
+| **refundTransactionRequest** | [RefundTransactionRequest](RefundTransactionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**TransactionResource**](TransactionResource.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)
+
+
+## storeTransaction
+
+> GenericResponse storeTransaction(storeTransactionRequest)
+
+Auto-generated: storeTransaction
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreTransactionOperationRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new TransactionsApi();
+
+  const body = {
+    // StoreTransactionRequest (optional)
+    storeTransactionRequest: ...,
+  } satisfies StoreTransactionOperationRequest;
+
+  try {
+    const data = await api.storeTransaction(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **storeTransactionRequest** | [StoreTransactionRequest](StoreTransactionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\JsonResponse<array{transaction: \\TransactionResource|null, order_id: int|null}> |  -  |
+
+[[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/UpdateAssetForAssetableRequest.md

@@ -9,8 +9,6 @@ Name | Type
 `altText` | string
 `mimeType` | string
 `fileId` | number
-`isExternal` | boolean
-`externalUrl` | string
 `isLifestyleImage` | boolean
 `index` | number
 `overlayTemplateIds` | Array<number>
@@ -25,8 +23,6 @@ const example = {
   "altText": null,
   "mimeType": null,
   "fileId": null,
-  "isExternal": null,
-  "externalUrl": null,
   "isLifestyleImage": null,
   "index": null,
   "overlayTemplateIds": null,