@digital8/lighting-illusions-ts-sdk 0.0.1911 → 0.0.1913

package/docs/PaginatedTransactionResourceResponse.md

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

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

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

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

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