@digital8/lighting-illusions-ts-sdk 0.0.1931 → 0.0.1933

package/docs/RefundTransactionRequest.md

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

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

@@ -1,74 +0,0 @@
-
-# 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
-`extendedDate` | 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,
-  "extendedDate": 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

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

@@ -1,74 +0,0 @@
-
-# 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
-`extendedDate` | 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,
-  "extendedDate": 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/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#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/src/apis/TransactionsApi.ts

@@ -1,193 +0,0 @@
-/* tslint:disable */
-/* eslint-disable */
-/**
- * My API
- * API documentation for my Laravel app
- *
- * The version of the OpenAPI document: 1.0.0
- * 
- *
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
- * https://openapi-generator.tech
- * Do not edit the class manually.
- */
-
-import * as runtime from '../runtime';
-import {
-    type GenericResponse,
-    GenericResponseFromJSON,
-    GenericResponseToJSON,
-} from '../models/GenericResponse';
-import {
-    type IndexTransactionRequest,
-    IndexTransactionRequestFromJSON,
-    IndexTransactionRequestToJSON,
-} from '../models/IndexTransactionRequest';
-import {
-    type PaginatedTransactionListResourceResponse,
-    PaginatedTransactionListResourceResponseFromJSON,
-    PaginatedTransactionListResourceResponseToJSON,
-} from '../models/PaginatedTransactionListResourceResponse';
-import {
-    type RefundTransactionRequest,
-    RefundTransactionRequestFromJSON,
-    RefundTransactionRequestToJSON,
-} from '../models/RefundTransactionRequest';
-import {
-    type StoreTransactionRequest,
-    StoreTransactionRequestFromJSON,
-    StoreTransactionRequestToJSON,
-} from '../models/StoreTransactionRequest';
-import {
-    type TransactionResource,
-    TransactionResourceFromJSON,
-    TransactionResourceToJSON,
-} from '../models/TransactionResource';
-
-export interface IndexTransactionOperationRequest {
-    indexTransactionRequest?: IndexTransactionRequest;
-}
-
-export interface RefundTransactionOperationRequest {
-    transaction: number;
-    refundTransactionRequest?: RefundTransactionRequest;
-}
-
-export interface StoreTransactionOperationRequest {
-    storeTransactionRequest?: StoreTransactionRequest;
-}
-
-/**
- * 
- */
-export class TransactionsApi extends runtime.BaseAPI {
-
-    /**
-     * Creates request options for indexTransaction without sending the request
-     */
-    async indexTransactionRequestOpts(requestParameters: IndexTransactionOperationRequest): Promise<runtime.RequestOpts> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/transactions/list`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: IndexTransactionRequestToJSON(requestParameters['indexTransactionRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: indexTransaction
-     */
-    async indexTransactionRaw(requestParameters: IndexTransactionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedTransactionListResourceResponse>> {
-        const requestOptions = await this.indexTransactionRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedTransactionListResourceResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: indexTransaction
-     */
-    async indexTransaction(requestParameters: IndexTransactionOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTransactionListResourceResponse> {
-        const response = await this.indexTransactionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for refundTransaction without sending the request
-     */
-    async refundTransactionRequestOpts(requestParameters: RefundTransactionOperationRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['transaction'] == null) {
-            throw new runtime.RequiredError(
-                'transaction',
-                'Required parameter "transaction" was null or undefined when calling refundTransaction().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/transactions/{transaction}/refund`;
-        urlPath = urlPath.replace('{transaction}', encodeURIComponent(String(requestParameters['transaction'])));
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: RefundTransactionRequestToJSON(requestParameters['refundTransactionRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: refundTransaction
-     */
-    async refundTransactionRaw(requestParameters: RefundTransactionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionResource>> {
-        const requestOptions = await this.refundTransactionRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => TransactionResourceFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: refundTransaction
-     */
-    async refundTransaction(requestParameters: RefundTransactionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionResource> {
-        const response = await this.refundTransactionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for storeTransaction without sending the request
-     */
-    async storeTransactionRequestOpts(requestParameters: StoreTransactionOperationRequest): Promise<runtime.RequestOpts> {
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-
-        let urlPath = `/admin-api/transactions/create`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: StoreTransactionRequestToJSON(requestParameters['storeTransactionRequest']),
-        };
-    }
-
-    /**
-     * Auto-generated: storeTransaction
-     */
-    async storeTransactionRaw(requestParameters: StoreTransactionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
-        const requestOptions = await this.storeTransactionRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: storeTransaction
-     */
-    async storeTransaction(requestParameters: StoreTransactionOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
-        const response = await this.storeTransactionRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}