@digital8/lighting-illusions-ts-sdk 0.0.2140 → 0.0.2141

package/docs/FrontendOrderResource.md

@@ -0,0 +1,80 @@
+
+# FrontendOrderResource
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`cartId` | number
+`siteId` | number
+`placedAt` | Date
+`source` | string
+`paymentToken` | string
+`accessToken` | object
+`shippingType` | string
+`customer` | [CustomerListResource](CustomerListResource.md)
+`status` | object
+`shippingAddress` | [AddressResource](AddressResource.md)
+`billingAddress` | [AddressResource](AddressResource.md)
+`lineItems` | [Array<FrontendLineItemResource>](FrontendLineItemResource.md)
+`coupons` | [Array<CartCouponLiteResource>](CartCouponLiteResource.md)
+`subtotal` | number
+`promotionalDiscount` | number
+`couponSubtotalDiscount` | number
+`couponShippingDiscount` | number
+`shipping` | number
+`transitInsurance` | number
+`gst` | number
+`grandTotal` | number
+`amountPaid` | number
+`amountDue` | number
+
+## Example
+
+```typescript
+import type { FrontendOrderResource } from '@digital8/lighting-illusions-ts-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "cartId": null,
+  "siteId": null,
+  "placedAt": null,
+  "source": null,
+  "paymentToken": null,
+  "accessToken": null,
+  "shippingType": null,
+  "customer": null,
+  "status": null,
+  "shippingAddress": null,
+  "billingAddress": null,
+  "lineItems": null,
+  "coupons": null,
+  "subtotal": null,
+  "promotionalDiscount": null,
+  "couponSubtotalDiscount": null,
+  "couponShippingDiscount": null,
+  "shipping": null,
+  "transitInsurance": null,
+  "gst": null,
+  "grandTotal": null,
+  "amountPaid": null,
+  "amountDue": null,
+} satisfies FrontendOrderResource
+
+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 FrontendOrderResource
+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/FrontendOrderResourceArrayResponse.md

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

@@ -17,8 +17,7 @@ Name | Type
 `customer` | [CustomerListResource](CustomerListResource.md)
 `status` | [OrderStatusLiteResource](OrderStatusLiteResource.md)
 `lineItems` | [Array<LineItemListResource>](LineItemListResource.md)
-`latestTransaction` | [TransactionLiteResource](TransactionLiteResource.md)
-`transactionsCount` | number
+`transactions` | [Array<TransactionLiteResource>](TransactionLiteResource.md)
 
 ## Example
 
@@ -38,8 +37,7 @@ const example = {
   "customer": null,
   "status": null,
   "lineItems": null,
-  "latestTransaction": null,
-  "transactionsCount": null,
+  "transactions": null,
 } satisfies OrderListResource
 
 console.log(example)

package/docs/OrdersApi.md

@@ -12,6 +12,7 @@ All URIs are relative to *http://localhost/api*
 | [**detachItemOrder**](OrdersApi.md#detachitemorder) | **DELETE** /admin-api/orders/{order}/line-items/{lineItem}/detach | Auto-generated: detachItemOrder |
 | [**getAllOrder**](OrdersApi.md#getallorder) | **POST** /admin-api/orders/all | Auto-generated: getAllOrder |
 | [**indexOrder**](OrdersApi.md#indexorder) | **POST** /admin-api/orders/list | Auto-generated: indexOrder |
+| [**pdfOrder**](OrdersApi.md#pdforder) | **POST** /admin-api/orders/{order}/pdf | Auto-generated: pdfOrder |
 | [**sendPaymentLinkOrder**](OrdersApi.md#sendpaymentlinkorder) | **POST** /admin-api/orders/{order}/send-payment-link | Auto-generated: sendPaymentLinkOrder |
 | [**showOrder**](OrdersApi.md#showorder) | **GET** /admin-api/orders/{order} | Auto-generated: showOrder |
 | [**statusesAllOrder**](OrdersApi.md#statusesallorder) | **POST** /admin-api/orders/statuses/all | Auto-generated: statusesAllOrder |
@@ -552,6 +553,71 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## pdfOrder
+
+> GenericResponse pdfOrder(order)
+
+Auto-generated: pdfOrder
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OrdersApi,
+} from '@digital8/lighting-illusions-ts-sdk';
+import type { PdfOrderRequest } from '@digital8/lighting-illusions-ts-sdk';
+
+async function example() {
+  console.log("🚀 Testing @digital8/lighting-illusions-ts-sdk SDK...");
+  const api = new OrdersApi();
+
+  const body = {
+    // number | The id of the order
+    order: 56,
+  } satisfies PdfOrderRequest;
+
+  try {
+    const data = await api.pdfOrder(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **order** | `number` | The id of the order | [Defaults to `undefined`] |
+
+### Return type
+
+[**GenericResponse**](GenericResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | \\Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## sendPaymentLinkOrder
 
 > AdminOrderResource sendPaymentLinkOrder(order)

package/docs/ProductChildFrontendResource.md

@@ -13,7 +13,7 @@ Name | Type
 `variations` | number
 `thumbnail` | [AssetLiteResource](AssetLiteResource.md)
 `supplier` | [SupplierFrontendResource](SupplierFrontendResource.md)
-`siteDetails` | object
+`siteDetails` | [ProductChildSiteDetailFrontendResource](ProductChildSiteDetailFrontendResource.md)
 
 ## Example
 

package/docs/ProductChildLineItemLiteResource.md

@@ -12,6 +12,9 @@ Name | Type
 `model` | string
 `modelNumber` | string
 `name` | string
+`parentName` | string
+`variantName` | string
+`slug` | string
 `stock` | number
 `salePrice` | number
 `thumbnail` | [AssetLiteResource](AssetLiteResource.md)
@@ -30,6 +33,9 @@ const example = {
   "model": null,
   "modelNumber": null,
   "name": null,
+  "parentName": null,
+  "variantName": null,
+  "slug": null,
   "stock": null,
   "salePrice": null,
   "thumbnail": null,

package/docs/ProductChildListResource.md

@@ -17,7 +17,7 @@ Name | Type
 `quantity` | string
 `netsuiteId` | number
 `thumbnail` | [AssetLiteResource](AssetLiteResource.md)
-`siteDetails` | object
+`siteDetails` | [Array<ProductChildSiteDetailLiteResource>](ProductChildSiteDetailLiteResource.md)
 
 ## Example
 

package/docs/ProductChildOverlayRelationResource.md

@@ -16,7 +16,7 @@ Name | Type
 `displayInSocialFeed` | boolean
 `netsuiteId` | number
 `thumbnail` | [AssetLiteResource](AssetLiteResource.md)
-`siteDetails` | object
+`siteDetails` | [Array<ProductChildSiteDetailLiteResource>](ProductChildSiteDetailLiteResource.md)
 `numberAttached` | number
 
 ## Example

package/docs/SearchAllProductChildrenRequest.md

@@ -24,7 +24,6 @@ Name | Type
 `enabledSitesId` | Array<string>
 `siteDetailsSeoHasSeoTitle` | Array<string>
 `siteDetailsSeoHasSeoDescription` | Array<string>
-`siteId` | number
 
 ## Example
 
@@ -51,7 +50,6 @@ const example = {
   "enabledSitesId": null,
   "siteDetailsSeoHasSeoTitle": null,
   "siteDetailsSeoHasSeoDescription": null,
-  "siteId": null,
 } satisfies SearchAllProductChildrenRequest
 
 console.log(example)

package/docs/SearchProductChildrenRequest.md

@@ -26,7 +26,6 @@ Name | Type
 `relatedId` | number
 `relatedType` | string
 `includesRelations` | boolean
-`siteId` | number
 
 ## Example
 
@@ -55,7 +54,6 @@ const example = {
   "relatedId": null,
   "relatedType": null,
   "includesRelations": null,
-  "siteId": null,
 } satisfies SearchProductChildrenRequest
 
 console.log(example)

package/docs/StoreSpecialDateFrontendResource.md

@@ -9,7 +9,7 @@ Name | Type
 `id` | number
 `name` | string
 `hours` | string
-`date` | string
+`date` | object
 `closed` | boolean
 `displayStartDate` | object
 `displayEndDate` | object

package/package.json

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

package/src/apis/OrdersApi.ts

@@ -120,6 +120,10 @@ export interface IndexOrderRequest {
     searchOrdersRequest?: SearchOrdersRequest;
 }
 
+export interface PdfOrderRequest {
+    order: number;
+}
+
 export interface SendPaymentLinkOrderRequest {
     order: number;
 }
@@ -506,6 +510,51 @@ export class OrdersApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for pdfOrder without sending the request
+     */
+    async pdfOrderRequestOpts(requestParameters: PdfOrderRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['order'] == null) {
+            throw new runtime.RequiredError(
+                'order',
+                'Required parameter "order" was null or undefined when calling pdfOrder().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/orders/{order}/pdf`;
+        urlPath = urlPath.replace('{order}', encodeURIComponent(String(requestParameters['order'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Auto-generated: pdfOrder
+     */
+    async pdfOrderRaw(requestParameters: PdfOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        const requestOptions = await this.pdfOrderRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: pdfOrder
+     */
+    async pdfOrder(requestParameters: PdfOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.pdfOrderRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for sendPaymentLinkOrder without sending the request
      */

package/src/models/AddressFrontendResource.ts

@@ -24,7 +24,7 @@ export interface AddressFrontendResource {
      * @type {string}
      * @memberof AddressFrontendResource
      */
-    company: string;
+    company?: string | null;
     /**
      * 
      * @type {string}
@@ -73,7 +73,6 @@ export interface AddressFrontendResource {
  * Check if a given object implements the AddressFrontendResource interface.
  */
 export function instanceOfAddressFrontendResource(value: object): value is AddressFrontendResource {
-    if (!('company' in value) || value['company'] === undefined) return false;
     if (!('line1' in value) || value['line1'] === undefined) return false;
     if (!('postcode' in value) || value['postcode'] === undefined) return false;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
@@ -93,7 +92,7 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
-        'company': json['company'],
+        'company': json['company'] == null ? undefined : json['company'],
         'line1': json['line1'],
         'line2': json['line2'] == null ? undefined : json['line2'],
         'postcode': json['postcode'],

package/src/models/AddressResource.ts

@@ -60,7 +60,7 @@ export interface AddressResource {
      * @type {string}
      * @memberof AddressResource
      */
-    line2?: string | null;
+    line2: string;
     /**
      * 
      * @type {string}
@@ -100,6 +100,7 @@ export function instanceOfAddressResource(value: object): value is AddressResour
     if (!('addresseeName' in value) || value['addresseeName'] === undefined) return false;
     if (!('company' in value) || value['company'] === 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;
@@ -124,7 +125,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         'addresseeName': json['addresseeName'],
         'company': json['company'],
         'line1': json['line1'],
-        'line2': json['line2'] == null ? undefined : json['line2'],
+        'line2': json['line2'],
         'postcode': json['postcode'],
         'suburb': json['suburb'],
         'country': json['country'],

package/src/models/AdminOrderLineItemResource.ts

@@ -13,13 +13,6 @@
  */
 
 import { mapValues } from '../runtime';
-import type { LabelLiteResource } from './LabelLiteResource';
-import {
-    LabelLiteResourceFromJSON,
-    LabelLiteResourceFromJSONTyped,
-    LabelLiteResourceToJSON,
-    LabelLiteResourceToJSONTyped,
-} from './LabelLiteResource';
 import type { ProductChildLineItemLiteResource } from './ProductChildLineItemLiteResource';
 import {
     ProductChildLineItemLiteResourceFromJSON,
@@ -57,13 +50,7 @@ export interface AdminOrderLineItemResource {
      * @type {number}
      * @memberof AdminOrderLineItemResource
      */
-    labelId: number;
-    /**
-     * 
-     * @type {LabelLiteResource}
-     * @memberof AdminOrderLineItemResource
-     */
-    label: LabelLiteResource | null;
+    labelId?: number | null;
     /**
      * 
      * @type {number}
@@ -139,8 +126,6 @@ export function instanceOfAdminOrderLineItemResource(value: object): value is Ad
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('quantity' in value) || value['quantity'] === undefined) return false;
     if (!('productPrice' in value) || value['productPrice'] === undefined) return false;
-    if (!('labelId' in value) || value['labelId'] === undefined) return false;
-    if (!('label' in value) || value['label'] === undefined) return false;
     if (!('productDiscount' in value) || value['productDiscount'] === undefined) return false;
     if (!('totalDiscount' in value) || value['totalDiscount'] === undefined) return false;
     if (!('lineSubtotal' in value) || value['lineSubtotal'] === undefined) return false;
@@ -168,8 +153,7 @@ export function AdminOrderLineItemResourceFromJSONTyped(json: any, ignoreDiscrim
         'id': json['id'],
         'quantity': json['quantity'],
         'productPrice': json['productPrice'],
-        'labelId': json['labelId'],
-        'label': LabelLiteResourceFromJSON(json['label']),
+        'labelId': json['labelId'] == null ? undefined : json['labelId'],
         'productDiscount': json['productDiscount'],
         'totalDiscount': json['totalDiscount'],
         'lineSubtotal': json['lineSubtotal'],
@@ -199,7 +183,6 @@ export function AdminOrderLineItemResourceToJSONTyped(value?: AdminOrderLineItem
         'quantity': value['quantity'],
         'productPrice': value['productPrice'],
         'labelId': value['labelId'],
-        'label': LabelLiteResourceToJSON(value['label']),
         'productDiscount': value['productDiscount'],
         'totalDiscount': value['totalDiscount'],
         'lineSubtotal': value['lineSubtotal'],

package/src/models/CartCouponLiteResource.ts

@@ -0,0 +1,102 @@
+/* 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 CartCouponLiteResource
+ */
+export interface CartCouponLiteResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof CartCouponLiteResource
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CartCouponLiteResource
+     */
+    code: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CartCouponLiteResource
+     */
+    name: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof CartCouponLiteResource
+     */
+    discount: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CartCouponLiteResource
+     */
+    appliesTo: string;
+}
+
+/**
+ * Check if a given object implements the CartCouponLiteResource interface.
+ */
+export function instanceOfCartCouponLiteResource(value: object): value is CartCouponLiteResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('discount' in value) || value['discount'] === undefined) return false;
+    if (!('appliesTo' in value) || value['appliesTo'] === undefined) return false;
+    return true;
+}
+
+export function CartCouponLiteResourceFromJSON(json: any): CartCouponLiteResource {
+    return CartCouponLiteResourceFromJSONTyped(json, false);
+}
+
+export function CartCouponLiteResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): CartCouponLiteResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'code': json['code'],
+        'name': json['name'],
+        'discount': json['discount'],
+        'appliesTo': json['appliesTo'],
+    };
+}
+
+export function CartCouponLiteResourceToJSON(json: any): CartCouponLiteResource {
+    return CartCouponLiteResourceToJSONTyped(json, false);
+}
+
+export function CartCouponLiteResourceToJSONTyped(value?: CartCouponLiteResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'code': value['code'],
+        'name': value['name'],
+        'discount': value['discount'],
+        'appliesTo': value['appliesTo'],
+    };
+}
+

package/src/models/CartCouponLiteResourceArrayResponse.ts

@@ -0,0 +1,73 @@
+/* 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 { CartCouponLiteResource } from './CartCouponLiteResource';
+import {
+    CartCouponLiteResourceFromJSON,
+    CartCouponLiteResourceFromJSONTyped,
+    CartCouponLiteResourceToJSON,
+    CartCouponLiteResourceToJSONTyped,
+} from './CartCouponLiteResource';
+
+/**
+ * 
+ * @export
+ * @interface CartCouponLiteResourceArrayResponse
+ */
+export interface CartCouponLiteResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<CartCouponLiteResource>}
+     * @memberof CartCouponLiteResourceArrayResponse
+     */
+    data?: Array<CartCouponLiteResource>;
+}
+
+/**
+ * Check if a given object implements the CartCouponLiteResourceArrayResponse interface.
+ */
+export function instanceOfCartCouponLiteResourceArrayResponse(value: object): value is CartCouponLiteResourceArrayResponse {
+    return true;
+}
+
+export function CartCouponLiteResourceArrayResponseFromJSON(json: any): CartCouponLiteResourceArrayResponse {
+    return CartCouponLiteResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function CartCouponLiteResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CartCouponLiteResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(CartCouponLiteResourceFromJSON)),
+    };
+}
+
+export function CartCouponLiteResourceArrayResponseToJSON(json: any): CartCouponLiteResourceArrayResponse {
+    return CartCouponLiteResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function CartCouponLiteResourceArrayResponseToJSONTyped(value?: CartCouponLiteResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(CartCouponLiteResourceToJSON)),
+    };
+}
+