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

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
-
-> 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/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 PaginatedTransactionResourceResponse,
-    PaginatedTransactionResourceResponseFromJSON,
-    PaginatedTransactionResourceResponseToJSON,
-} from '../models/PaginatedTransactionResourceResponse';
-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<PaginatedTransactionResourceResponse>> {
-        const requestOptions = await this.indexTransactionRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedTransactionResourceResponseFromJSON(jsonValue));
-    }
-
-    /**
-     * Auto-generated: indexTransaction
-     */
-    async indexTransaction(requestParameters: IndexTransactionOperationRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedTransactionResourceResponse> {
-        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();
-    }
-
-}

package/src/models/IndexTransactionRequest.ts

@@ -1,190 +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 { mapValues } from '../runtime';
-/**
- * 
- * @export
- * @interface IndexTransactionRequest
- */
-export interface IndexTransactionRequest {
-    /**
-     * 
-     * @type {string}
-     * @memberof IndexTransactionRequest
-     */
-    search?: string | null;
-    /**
-     * 
-     * @type {IndexTransactionRequestSortByEnum}
-     * @memberof IndexTransactionRequest
-     */
-    sortBy?: IndexTransactionRequestSortByEnum;
-    /**
-     * 
-     * @type {IndexTransactionRequestSortDirectionEnum}
-     * @memberof IndexTransactionRequest
-     */
-    sortDirection?: IndexTransactionRequestSortDirectionEnum;
-    /**
-     * 
-     * @type {number}
-     * @memberof IndexTransactionRequest
-     */
-    perPage?: number;
-    /**
-     * 
-     * @type {number}
-     * @memberof IndexTransactionRequest
-     */
-    page?: number;
-    /**
-     * 
-     * @type {Array<string>}
-     * @memberof IndexTransactionRequest
-     */
-    paymentSource?: Array<string>;
-    /**
-     * 
-     * @type {Array<string>}
-     * @memberof IndexTransactionRequest
-     */
-    type?: Array<string>;
-    /**
-     * 
-     * @type {Array<string>}
-     * @memberof IndexTransactionRequest
-     */
-    paymentMethod?: Array<string>;
-    /**
-     * 
-     * @type {Array<string>}
-     * @memberof IndexTransactionRequest
-     */
-    status?: Array<string>;
-    /**
-     * 
-     * @type {Date}
-     * @memberof IndexTransactionRequest
-     */
-    beforeCreatedAt?: Date;
-    /**
-     * 
-     * @type {Date}
-     * @memberof IndexTransactionRequest
-     */
-    afterCreatedAt?: Date;
-    /**
-     * 
-     * @type {number}
-     * @memberof IndexTransactionRequest
-     */
-    relatedId?: number;
-    /**
-     * 
-     * @type {string}
-     * @memberof IndexTransactionRequest
-     */
-    relatedType?: string;
-    /**
-     * 
-     * @type {boolean}
-     * @memberof IndexTransactionRequest
-     */
-    includesRelations?: boolean;
-}
-
-
-/**
- * @export
- */
-export const IndexTransactionRequestSortByEnum = {
-    Id: 'id',
-    CreatedAt: 'created_at',
-    TotalAmount: 'total_amount'
-} as const;
-export type IndexTransactionRequestSortByEnum = typeof IndexTransactionRequestSortByEnum[keyof typeof IndexTransactionRequestSortByEnum];
-
-/**
- * @export
- */
-export const IndexTransactionRequestSortDirectionEnum = {
-    Asc: 'asc',
-    Desc: 'desc'
-} as const;
-export type IndexTransactionRequestSortDirectionEnum = typeof IndexTransactionRequestSortDirectionEnum[keyof typeof IndexTransactionRequestSortDirectionEnum];
-
-
-/**
- * Check if a given object implements the IndexTransactionRequest interface.
- */
-export function instanceOfIndexTransactionRequest(value: object): value is IndexTransactionRequest {
-    return true;
-}
-
-export function IndexTransactionRequestFromJSON(json: any): IndexTransactionRequest {
-    return IndexTransactionRequestFromJSONTyped(json, false);
-}
-
-export function IndexTransactionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): IndexTransactionRequest {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'search': json['search'] == null ? undefined : json['search'],
-        'sortBy': json['sortBy'] == null ? undefined : json['sortBy'],
-        'sortDirection': json['sortDirection'] == null ? undefined : json['sortDirection'],
-        'perPage': json['per_page'] == null ? undefined : json['per_page'],
-        'page': json['page'] == null ? undefined : json['page'],
-        'paymentSource': json['payment_source'] == null ? undefined : json['payment_source'],
-        'type': json['type'] == null ? undefined : json['type'],
-        'paymentMethod': json['payment_method'] == null ? undefined : json['payment_method'],
-        'status': json['status'] == null ? undefined : json['status'],
-        'beforeCreatedAt': json['before_created_at'] == null ? undefined : (new Date(json['before_created_at'])),
-        'afterCreatedAt': json['after_created_at'] == null ? undefined : (new Date(json['after_created_at'])),
-        'relatedId': json['related_id'] == null ? undefined : json['related_id'],
-        'relatedType': json['related_type'] == null ? undefined : json['related_type'],
-        'includesRelations': json['includes_relations'] == null ? undefined : json['includes_relations'],
-    };
-}
-
-export function IndexTransactionRequestToJSON(json: any): IndexTransactionRequest {
-    return IndexTransactionRequestToJSONTyped(json, false);
-}
-
-export function IndexTransactionRequestToJSONTyped(value?: IndexTransactionRequest | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'search': value['search'],
-        'sortBy': value['sortBy'],
-        'sortDirection': value['sortDirection'],
-        'per_page': value['perPage'],
-        'page': value['page'],
-        'payment_source': value['paymentSource'],
-        'type': value['type'],
-        'payment_method': value['paymentMethod'],
-        'status': value['status'],
-        'before_created_at': value['beforeCreatedAt'] == null ? value['beforeCreatedAt'] : value['beforeCreatedAt'].toISOString(),
-        'after_created_at': value['afterCreatedAt'] == null ? value['afterCreatedAt'] : value['afterCreatedAt'].toISOString(),
-        'related_id': value['relatedId'],
-        'related_type': value['relatedType'],
-        'includes_relations': value['includesRelations'],
-    };
-}
-

package/src/models/PaginatedTransactionResourceResponse.ts

@@ -1,90 +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 { mapValues } from '../runtime';
-import type { PagingMetadata } from './PagingMetadata';
-import {
-    PagingMetadataFromJSON,
-    PagingMetadataFromJSONTyped,
-    PagingMetadataToJSON,
-    PagingMetadataToJSONTyped,
-} from './PagingMetadata';
-import type { TransactionResource } from './TransactionResource';
-import {
-    TransactionResourceFromJSON,
-    TransactionResourceFromJSONTyped,
-    TransactionResourceToJSON,
-    TransactionResourceToJSONTyped,
-} from './TransactionResource';
-
-/**
- * 
- * @export
- * @interface PaginatedTransactionResourceResponse
- */
-export interface PaginatedTransactionResourceResponse {
-    /**
-     * 
-     * @type {Array<TransactionResource>}
-     * @memberof PaginatedTransactionResourceResponse
-     */
-    data: Array<TransactionResource>;
-    /**
-     * 
-     * @type {PagingMetadata}
-     * @memberof PaginatedTransactionResourceResponse
-     */
-    meta: PagingMetadata;
-}
-
-/**
- * Check if a given object implements the PaginatedTransactionResourceResponse interface.
- */
-export function instanceOfPaginatedTransactionResourceResponse(value: object): value is PaginatedTransactionResourceResponse {
-    if (!('data' in value) || value['data'] === undefined) return false;
-    if (!('meta' in value) || value['meta'] === undefined) return false;
-    return true;
-}
-
-export function PaginatedTransactionResourceResponseFromJSON(json: any): PaginatedTransactionResourceResponse {
-    return PaginatedTransactionResourceResponseFromJSONTyped(json, false);
-}
-
-export function PaginatedTransactionResourceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedTransactionResourceResponse {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'data': ((json['data'] as Array<any>).map(TransactionResourceFromJSON)),
-        'meta': PagingMetadataFromJSON(json['meta']),
-    };
-}
-
-export function PaginatedTransactionResourceResponseToJSON(json: any): PaginatedTransactionResourceResponse {
-    return PaginatedTransactionResourceResponseToJSONTyped(json, false);
-}
-
-export function PaginatedTransactionResourceResponseToJSONTyped(value?: PaginatedTransactionResourceResponse | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'data': ((value['data'] as Array<any>).map(TransactionResourceToJSON)),
-        'meta': PagingMetadataToJSON(value['meta']),
-    };
-}
-