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

package/docs/TransactionsApi.md

@@ -0,0 +1,209 @@
+# TransactionsApi
+
+All URIs are relative to *http://localhost/api*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**indexTransaction**](TransactionsApi.md#indextransaction) | **POST** /admin-api/transactions/list | Auto-generated: indexTransaction |
+| [**refundTransaction**](TransactionsApi.md#refundtransactionoperation) | **POST** /admin-api/transactions/{transaction}/refund | Auto-generated: refundTransaction |
+| [**storeTransaction**](TransactionsApi.md#storetransaction) | **POST** /admin-api/transactions/create | Auto-generated: storeTransaction |
+
+
+
+## indexTransaction
+
+> PaginatedTransactionResourceResponse indexTransaction(searchTransactionsRequest)
+
+Auto-generated: indexTransaction
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { IndexTransactionRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new TransactionsApi();
+
+  const body = {
+    // SearchTransactionsRequest (optional)
+    searchTransactionsRequest: ...,
+  } satisfies IndexTransactionRequest;
+
+  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 |
+|------------- | ------------- | ------------- | -------------|
+| **searchTransactionsRequest** | [SearchTransactionsRequest](SearchTransactionsRequest.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
+
+> StoreTransactionResource storeTransaction(createTransactionRequest)
+
+Auto-generated: storeTransaction
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TransactionsApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { StoreTransactionRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new TransactionsApi();
+
+  const body = {
+    // CreateTransactionRequest (optional)
+    createTransactionRequest: ...,
+  } satisfies StoreTransactionRequest;
+
+  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 |
+|------------- | ------------- | ------------- | -------------|
+| **createTransactionRequest** | [CreateTransactionRequest](CreateTransactionRequest.md) |  | [Optional] |
+
+### Return type
+
+[**StoreTransactionResource**](StoreTransactionResource.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/UpdateCartItemRequest.md

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

@@ -0,0 +1,62 @@
+
+# UpdateCartRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`customerId` | number
+`source` | string
+`guestEmail` | string
+`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 { UpdateCartRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "customerId": null,
+  "source": null,
+  "guestEmail": 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 UpdateCartRequest
+
+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 UpdateCartRequest
+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/UpdateCustomerRequest.md

@@ -0,0 +1,42 @@
+
+# UpdateCustomerRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`siteId` | number
+`firstName` | string
+`lastName` | string
+`email` | string
+`phone` | string
+
+## Example
+
+```typescript
+import type { UpdateCustomerRequest } 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 UpdateCustomerRequest
+
+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 UpdateCustomerRequest
+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/UpdateOrderLineItemRequest.md

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

@@ -0,0 +1,58 @@
+
+# UpdateOrderRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`netsuiteId` | string
+`statusId` | number
+`source` | string
+`shippingType` | string
+`shippingSubtotal` | number
+`overrideShipping` | boolean
+`insuranceAmount` | number
+`includeInsurance` | boolean
+`overrideInsurance` | boolean
+`shippingAddressId` | number
+`billingAddressId` | number
+`shippingAddress` | [CreateCartRequestShippingAddress](CreateCartRequestShippingAddress.md)
+`billingAddress` | [CreateCartRequestShippingAddress](CreateCartRequestShippingAddress.md)
+
+## Example
+
+```typescript
+import type { UpdateOrderRequest } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "netsuiteId": null,
+  "statusId": null,
+  "source": null,
+  "shippingType": null,
+  "shippingSubtotal": null,
+  "overrideShipping": null,
+  "insuranceAmount": null,
+  "includeInsurance": null,
+  "overrideInsurance": null,
+  "shippingAddressId": null,
+  "billingAddressId": null,
+  "shippingAddress": null,
+  "billingAddress": null,
+} satisfies UpdateOrderRequest
+
+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 UpdateOrderRequest
+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/UpdateSiteRequest.md

@@ -27,6 +27,7 @@ Name | Type
 `acCouponValue` | number
 `acCouponDiscountType` | string
 `acCouponExpiryDays` | number
+`cartExpiryDays` | number
 `acCouponEnabled` | boolean
 
 ## Example
@@ -57,6 +58,7 @@ const example = {
   "acCouponValue": null,
   "acCouponDiscountType": null,
   "acCouponExpiryDays": null,
+  "cartExpiryDays": null,
   "acCouponEnabled": null,
 } satisfies UpdateSiteRequest
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital8/lighting-illusions-ts-sdk",
-  "version": "0.0.2004",
+  "version": "0.0.2006",
   "description": "OpenAPI client for @digital8/lighting-illusions-ts-sdk",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/AdminApi.ts

@@ -13,11 +13,21 @@
  */
 
 import * as runtime from '../runtime';
+import {
+    type AdminNoteResourceArrayResponse,
+    AdminNoteResourceArrayResponseFromJSON,
+    AdminNoteResourceArrayResponseToJSON,
+} from '../models/AdminNoteResourceArrayResponse';
 import {
     type GenericResponse,
     GenericResponseFromJSON,
     GenericResponseToJSON,
 } from '../models/GenericResponse';
+import {
+    type SearchAdminNotesRequest,
+    SearchAdminNotesRequestFromJSON,
+    SearchAdminNotesRequestToJSON,
+} from '../models/SearchAdminNotesRequest';
 import {
     type SiteIdRequest,
     SiteIdRequestFromJSON,
@@ -36,6 +46,10 @@ export interface GenerateTGNDataFeedAdminRequest {
     siteIdRequest?: SiteIdRequest;
 }
 
+export interface GetAllAdminNoteRequest {
+    searchAdminNotesRequest?: SearchAdminNotesRequest;
+}
+
 /**
  * 
  */
@@ -161,4 +175,44 @@ export class AdminApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getAllAdminNote without sending the request
+     */
+    async getAllAdminNoteRequestOpts(requestParameters: GetAllAdminNoteRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+
+        let urlPath = `/admin-api/admin/notes/all`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SearchAdminNotesRequestToJSON(requestParameters['searchAdminNotesRequest']),
+        };
+    }
+
+    /**
+     * Auto-generated: getAllAdminNote
+     */
+    async getAllAdminNoteRaw(requestParameters: GetAllAdminNoteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminNoteResourceArrayResponse>> {
+        const requestOptions = await this.getAllAdminNoteRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdminNoteResourceArrayResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: getAllAdminNote
+     */
+    async getAllAdminNote(requestParameters: GetAllAdminNoteRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminNoteResourceArrayResponse> {
+        const response = await this.getAllAdminNoteRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }