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

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/docs/UpdateOrderRequestBillingAddress.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `addresseeName` | string
+`addressee` | string
 `company` | string
 `line1` | string
 `line2` | string
@@ -23,6 +24,7 @@ import type { UpdateOrderRequestBillingAddress } from '@digital8/lighting-illusi
 // TODO: Update the object below with actual values
 const example = {
   "addresseeName": null,
+  "addressee": null,
   "company": null,
   "line1": null,
   "line2": null,

package/docs/UpdateOrderRequestShippingAddress.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `addresseeName` | string
+`addressee` | string
 `company` | string
 `line1` | string
 `line2` | string
@@ -23,6 +24,7 @@ import type { UpdateOrderRequestShippingAddress } from '@digital8/lighting-illus
 // TODO: Update the object below with actual values
 const example = {
   "addresseeName": null,
+  "addressee": null,
   "company": null,
   "line1": null,
   "line2": null,

package/package.json

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

package/src/apis/TransactionsApi.ts

@@ -0,0 +1,193 @@
+/* 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();
+    }
+
+}

package/src/apis/index.ts

@@ -24,3 +24,4 @@ export * from './SiteApi';
 export * from './StoreApi';
 export * from './SupplierApi';
 export * from './TagApi';
+export * from './TransactionsApi';

package/src/models/AddressResource.ts

@@ -42,7 +42,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    company?: string | null;
+    company: string;
     /**
      * 
      * @type {string}
@@ -60,7 +60,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    line2?: string | null;
+    line2: string;
     /**
      * 
      * @type {string}
@@ -98,8 +98,10 @@ export interface AddressResource {
  */
 export function instanceOfAddressResource(value: object): value is AddressResource {
     if (!('addresseeName' in value) || value['addresseeName'] === undefined) return false;
+    if (!('company' in value) || value['company'] === undefined) return false;
     if (!('addressee' in value) || value['addressee'] === undefined) return false;
     if (!('line1' in value) || value['line1'] === undefined) return false;
+    if (!('line2' in value) || value['line2'] === undefined) return false;
     if (!('postcode' in value) || value['postcode'] === undefined) return false;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
     if (!('country' in value) || value['country'] === undefined) return false;
@@ -121,10 +123,10 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         'id': json['id'] == null ? undefined : json['id'],
         'sourceAddressId': json['source_address_id'] == null ? undefined : json['source_address_id'],
         'addresseeName': json['addressee_name'],
-        'company': json['company'] == null ? undefined : json['company'],
+        'company': json['company'],
         'addressee': json['addressee'],
         'line1': json['line_1'],
-        'line2': json['line_2'] == null ? undefined : json['line_2'],
+        'line2': json['line_2'],
         'postcode': json['postcode'],
         'suburb': json['suburb'],
         'country': json['country'],

package/src/models/ExternalApiLogResource.ts

@@ -74,7 +74,7 @@ export interface ExternalApiLogResource {
      * @type {string}
      * @memberof ExternalApiLogResource
      */
-    requestPayload?: string | null;
+    requestPayload: string;
     /**
      * 
      * @type {string}
@@ -106,6 +106,7 @@ export function instanceOfExternalApiLogResource(value: object): value is Extern
     if (!('exteranlApiLoggableId' in value) || value['exteranlApiLoggableId'] === undefined) return false;
     if (!('endpoint' in value) || value['endpoint'] === undefined) return false;
     if (!('responseCode' in value) || value['responseCode'] === undefined) return false;
+    if (!('requestPayload' in value) || value['requestPayload'] === undefined) return false;
     if (!('responsePayload' in value) || value['responsePayload'] === undefined) return false;
     if (!('site' in value) || value['site'] === undefined) return false;
     return true;
@@ -128,7 +129,7 @@ export function ExternalApiLogResourceFromJSONTyped(json: any, ignoreDiscriminat
         'exteranlApiLoggableId': json['exteranlApiLoggableId'],
         'endpoint': json['endpoint'],
         'responseCode': json['responseCode'],
-        'requestPayload': json['requestPayload'] == null ? undefined : json['requestPayload'],
+        'requestPayload': json['requestPayload'],
         'responsePayload': json['responsePayload'],
         'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
         'site': SiteLiteResourceFromJSON(json['site']),