@digital8/lighting-illusions-ts-sdk 0.0.2294 → 0.0.2295

package/docs/TransactionLiteResource.md

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

@@ -1,34 +0,0 @@
-
-# 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

@@ -1,66 +0,0 @@
-
-# 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

@@ -1,34 +0,0 @@
-
-# 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

@@ -1,32 +0,0 @@
-
-# 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

@@ -1,209 +0,0 @@
-# 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
-
-> PaginatedTransactionListResourceResponse 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
-
-[**PaginatedTransactionListResourceResponse**](PaginatedTransactionListResourceResponse.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<\\TransactionListResource[]>> |  -  |
-
-[[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/UpdateCartRequest.md

@@ -1,66 +0,0 @@
-
-# UpdateCartRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`token` | string
-`sessionToken` | string
-`paymentToken` | string
-`customerId` | number
-`source` | string
-`guestEmail` | string
-`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 = {
-  "token": null,
-  "sessionToken": null,
-  "paymentToken": null,
-  "customerId": null,
-  "source": null,
-  "guestEmail": 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/UpdateLineItemRequest.md

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

@@ -1,60 +0,0 @@
-
-# UpdateOrderRequest
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`netsuiteId` | string
-`statusId` | number
-`source` | string
-`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 { 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,
-  "useAsBillingAddress": 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)
-
-