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

package/dist/models/PaymentSource.js

@@ -26,7 +26,8 @@ exports.PaymentSourceToJSONTyped = PaymentSourceToJSONTyped;
 exports.PaymentSource = {
     Checkout: 'checkout',
     ExpressCheckout: 'express_checkout',
-    AdminPortal: 'admin_portal'
+    AdminPortal: 'admin_portal',
+    PaymentLink: 'payment_link'
 };
 function instanceOfPaymentSource(value) {
     for (var key in exports.PaymentSource) {

package/dist/models/ProductChildFrontendResource.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { SupplierFrontendResource } from './SupplierFrontendResource';
+import type { ProductChildSiteDetailFrontendResource } from './ProductChildSiteDetailFrontendResource';
 import type { AssetLiteResource } from './AssetLiteResource';
 /**
  *
@@ -61,10 +62,10 @@ export interface ProductChildFrontendResource {
     supplier: SupplierFrontendResource | null;
     /**
      *
-     * @type {object}
+     * @type {ProductChildSiteDetailFrontendResource}
      * @memberof ProductChildFrontendResource
      */
-    siteDetails: object;
+    siteDetails: ProductChildSiteDetailFrontendResource | null;
 }
 /**
  * Check if a given object implements the ProductChildFrontendResource interface.

package/dist/models/ProductChildFrontendResource.js

@@ -19,6 +19,7 @@ exports.ProductChildFrontendResourceFromJSONTyped = ProductChildFrontendResource
 exports.ProductChildFrontendResourceToJSON = ProductChildFrontendResourceToJSON;
 exports.ProductChildFrontendResourceToJSONTyped = ProductChildFrontendResourceToJSONTyped;
 var SupplierFrontendResource_1 = require("./SupplierFrontendResource");
+var ProductChildSiteDetailFrontendResource_1 = require("./ProductChildSiteDetailFrontendResource");
 var AssetLiteResource_1 = require("./AssetLiteResource");
 /**
  * Check if a given object implements the ProductChildFrontendResource interface.
@@ -57,7 +58,7 @@ function ProductChildFrontendResourceFromJSONTyped(json, ignoreDiscriminator) {
         'variations': json['variations'],
         'thumbnail': (0, AssetLiteResource_1.AssetLiteResourceFromJSON)(json['thumbnail']),
         'supplier': (0, SupplierFrontendResource_1.SupplierFrontendResourceFromJSON)(json['supplier']),
-        'siteDetails': json['siteDetails'],
+        'siteDetails': (0, ProductChildSiteDetailFrontendResource_1.ProductChildSiteDetailFrontendResourceFromJSON)(json['siteDetails']),
     };
 }
 function ProductChildFrontendResourceToJSON(json) {
@@ -76,6 +77,6 @@ function ProductChildFrontendResourceToJSONTyped(value, ignoreDiscriminator) {
         'variations': value['variations'],
         'thumbnail': (0, AssetLiteResource_1.AssetLiteResourceToJSON)(value['thumbnail']),
         'supplier': (0, SupplierFrontendResource_1.SupplierFrontendResourceToJSON)(value['supplier']),
-        'siteDetails': value['siteDetails'],
+        'siteDetails': (0, ProductChildSiteDetailFrontendResource_1.ProductChildSiteDetailFrontendResourceToJSON)(value['siteDetails']),
     };
 }

package/dist/models/StoreListResource.d.ts

@@ -57,7 +57,7 @@ export interface StoreListResource {
      * @type {string}
      * @memberof StoreListResource
      */
-    tagLine?: string | null;
+    tagLine: string;
     /**
      *
      * @type {string}
@@ -69,7 +69,7 @@ export interface StoreListResource {
      * @type {string}
      * @memberof StoreListResource
      */
-    website: string;
+    website?: string | null;
     /**
      *
      * @type {number}

package/dist/models/StoreListResource.js

@@ -33,9 +33,9 @@ function instanceOfStoreListResource(value) {
         return false;
     if (!('latitude' in value) || value['latitude'] === undefined)
         return false;
-    if (!('email' in value) || value['email'] === undefined)
+    if (!('tagLine' in value) || value['tagLine'] === undefined)
         return false;
-    if (!('website' in value) || value['website'] === undefined)
+    if (!('email' in value) || value['email'] === undefined)
         return false;
     if (!('netsuiteId' in value) || value['netsuiteId'] === undefined)
         return false;
@@ -57,9 +57,9 @@ function StoreListResourceFromJSONTyped(json, ignoreDiscriminator) {
         'phone': json['phone'],
         'longitude': json['longitude'],
         'latitude': json['latitude'],
-        'tagLine': json['tagLine'] == null ? undefined : json['tagLine'],
+        'tagLine': json['tagLine'],
         'email': json['email'],
-        'website': json['website'],
+        'website': json['website'] == null ? undefined : json['website'],
         'netsuiteId': json['netsuiteId'],
         'displayNetsuiteId': json['displayNetsuiteId'],
         'openingHours': json['openingHours'] == null ? undefined : json['openingHours'],

package/dist/models/StoreResource.d.ts

@@ -60,7 +60,7 @@ export interface StoreResource {
      * @type {string}
      * @memberof StoreResource
      */
-    tagLine: string;
+    tagLine?: string | null;
     /**
      *
      * @type {string}

package/dist/models/StoreResource.js

@@ -36,8 +36,6 @@ function instanceOfStoreResource(value) {
         return false;
     if (!('latitude' in value) || value['latitude'] === undefined)
         return false;
-    if (!('tagLine' in value) || value['tagLine'] === undefined)
-        return false;
     if (!('email' in value) || value['email'] === undefined)
         return false;
     if (!('website' in value) || value['website'] === undefined)
@@ -68,7 +66,7 @@ function StoreResourceFromJSONTyped(json, ignoreDiscriminator) {
         'phone': json['phone'],
         'longitude': json['longitude'],
         'latitude': json['latitude'],
-        'tagLine': json['tagLine'],
+        'tagLine': json['tagLine'] == null ? undefined : json['tagLine'],
         'email': json['email'],
         'website': json['website'],
         'netsuiteId': json['netsuiteId'],

package/dist/models/StoreSpecialDateFrontendResource.d.ts

@@ -35,10 +35,10 @@ export interface StoreSpecialDateFrontendResource {
     hours: string;
     /**
      *
-     * @type {string}
+     * @type {object}
      * @memberof StoreSpecialDateFrontendResource
      */
-    date?: string | null;
+    date: object;
     /**
      *
      * @type {boolean}

package/dist/models/StoreSpecialDateFrontendResource.js

@@ -26,6 +26,8 @@ function instanceOfStoreSpecialDateFrontendResource(value) {
         return false;
     if (!('hours' in value) || value['hours'] === undefined)
         return false;
+    if (!('date' in value) || value['date'] === undefined)
+        return false;
     if (!('closed' in value) || value['closed'] === undefined)
         return false;
     if (!('displayStartDate' in value) || value['displayStartDate'] === undefined)
@@ -45,7 +47,7 @@ function StoreSpecialDateFrontendResourceFromJSONTyped(json, ignoreDiscriminator
         'id': json['id'] == null ? undefined : json['id'],
         'name': json['name'],
         'hours': json['hours'],
-        'date': json['date'] == null ? undefined : json['date'],
+        'date': json['date'],
         'closed': json['closed'],
         'displayStartDate': json['displayStartDate'],
         'displayEndDate': json['displayEndDate'],

package/dist/models/index.d.ts

@@ -175,6 +175,8 @@ export * from './FrontendComponentResource';
 export * from './FrontendComponentResourceArrayResponse';
 export * from './FrontendLineItemResource';
 export * from './FrontendLineItemResourceArrayResponse';
+export * from './FrontendOrderResource';
+export * from './FrontendOrderResourceArrayResponse';
 export * from './GenericResponse';
 export * from './GetUniqueEndpointsRequest';
 export * from './GlobalSearchCategoryResource';

package/dist/models/index.js

@@ -193,6 +193,8 @@ __exportStar(require("./FrontendComponentResource"), exports);
 __exportStar(require("./FrontendComponentResourceArrayResponse"), exports);
 __exportStar(require("./FrontendLineItemResource"), exports);
 __exportStar(require("./FrontendLineItemResourceArrayResponse"), exports);
+__exportStar(require("./FrontendOrderResource"), exports);
+__exportStar(require("./FrontendOrderResourceArrayResponse"), exports);
 __exportStar(require("./GenericResponse"), exports);
 __exportStar(require("./GetUniqueEndpointsRequest"), exports);
 __exportStar(require("./GlobalSearchCategoryResource"), exports);

package/docs/FrontendCartResource.md

@@ -10,6 +10,7 @@ Name | Type
 `lifecycleStatus` | string
 `siteId` | number
 `sessionToken` | string
+`guestEmail` | string
 `customer` | [CustomerListResource](CustomerListResource.md)
 `shippingType` | string
 `shippingAddress` | [AddressResource](AddressResource.md)
@@ -36,6 +37,7 @@ const example = {
   "lifecycleStatus": null,
   "siteId": null,
   "sessionToken": null,
+  "guestEmail": null,
   "customer": null,
   "shippingType": null,
   "shippingAddress": null,

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/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/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.2139",
+  "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}
@@ -36,7 +36,7 @@ export interface AddressFrontendResource {
      * @type {string}
      * @memberof AddressFrontendResource
      */
-    line2: string;
+    line2?: string | null;
     /**
      * 
      * @type {string}
@@ -73,9 +73,7 @@ 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 (!('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;
@@ -94,9 +92,9 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
-        'company': json['company'],
+        'company': json['company'] == null ? undefined : json['company'],
         'line1': json['line1'],
-        'line2': json['line2'],
+        'line2': json['line2'] == null ? undefined : json['line2'],
         'postcode': json['postcode'],
         'suburb': json['suburb'],
         'country': json['country'],

package/src/models/AddressResource.ts

@@ -48,7 +48,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,7 +98,9 @@ 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 (!('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,9 +123,9 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         'type': json['type'] == null ? undefined : json['type'],
         'sourceAddressId': json['sourceAddressId'] == null ? undefined : json['sourceAddressId'],
         'addresseeName': json['addresseeName'],
-        'company': json['company'] == null ? undefined : json['company'],
+        '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/FrontendCartResource.ts

@@ -72,6 +72,12 @@ export interface FrontendCartResource {
      * @memberof FrontendCartResource
      */
     sessionToken?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FrontendCartResource
+     */
+    guestEmail?: string | null;
     /**
      * 
      * @type {CustomerListResource}
@@ -195,6 +201,7 @@ export function FrontendCartResourceFromJSONTyped(json: any, ignoreDiscriminator
         'lifecycleStatus': json['lifecycleStatus'],
         'siteId': json['siteId'],
         'sessionToken': json['sessionToken'] == null ? undefined : json['sessionToken'],
+        'guestEmail': json['guestEmail'] == null ? undefined : json['guestEmail'],
         'customer': CustomerListResourceFromJSON(json['customer']),
         'shippingType': json['shippingType'],
         'shippingAddress': AddressResourceFromJSON(json['shippingAddress']),
@@ -227,6 +234,7 @@ export function FrontendCartResourceToJSONTyped(value?: FrontendCartResource | n
         'lifecycleStatus': value['lifecycleStatus'],
         'siteId': value['siteId'],
         'sessionToken': value['sessionToken'],
+        'guestEmail': value['guestEmail'],
         'customer': CustomerListResourceToJSON(value['customer']),
         'shippingType': value['shippingType'],
         'shippingAddress': AddressResourceToJSON(value['shippingAddress']),