@digital8/lighting-illusions-ts-sdk 0.0.2164 → 0.0.2165

package/dist/models/OrderFulfillmentResource.d.ts

@@ -39,7 +39,7 @@ export interface OrderFulfillmentResource {
      * @type {string}
      * @memberof OrderFulfillmentResource
      */
-    trackingNumber: string;
+    trackingNumber?: string | null;
     /**
      *
      * @type {string}
@@ -51,7 +51,7 @@ export interface OrderFulfillmentResource {
      * @type {string}
      * @memberof OrderFulfillmentResource
      */
-    trackingCompany: string;
+    trackingCompany?: string | null;
     /**
      *
      * @type {string}

package/dist/models/OrderFulfillmentResource.js

@@ -29,12 +29,8 @@ function instanceOfOrderFulfillmentResource(value) {
         return false;
     if (!('dateShipped' in value) || value['dateShipped'] === undefined)
         return false;
-    if (!('trackingNumber' in value) || value['trackingNumber'] === undefined)
-        return false;
     if (!('trackingUrl' in value) || value['trackingUrl'] === undefined)
         return false;
-    if (!('trackingCompany' in value) || value['trackingCompany'] === undefined)
-        return false;
     if (!('docnum' in value) || value['docnum'] === undefined)
         return false;
     if (!('netsuiteId' in value) || value['netsuiteId'] === undefined)
@@ -54,9 +50,9 @@ function OrderFulfillmentResourceFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'orderId': json['orderId'],
         'dateShipped': (new Date(json['dateShipped'])),
-        'trackingNumber': json['trackingNumber'],
+        'trackingNumber': json['trackingNumber'] == null ? undefined : json['trackingNumber'],
         'trackingUrl': json['trackingUrl'],
-        'trackingCompany': json['trackingCompany'],
+        'trackingCompany': json['trackingCompany'] == null ? undefined : json['trackingCompany'],
         'docnum': json['docnum'],
         'netsuiteId': json['netsuiteId'],
         'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),

package/dist/models/PaymentSource.d.ts

@@ -17,6 +17,7 @@ export declare const PaymentSource: {
     readonly Checkout: "checkout";
     readonly ExpressCheckout: "express_checkout";
     readonly AdminPortal: "admin_portal";
+    readonly PaymentLink: "payment_link";
 };
 export type PaymentSource = typeof PaymentSource[keyof typeof PaymentSource];
 export declare function instanceOfPaymentSource(value: any): boolean;

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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digital8/lighting-illusions-ts-sdk",
-  "version": "0.0.2164",
+  "version": "0.0.2165",
   "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 | null;
+    company: string;
     /**
      * 
      * @type {string}
@@ -73,6 +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 (!('postcode' in value) || value['postcode'] === undefined) return false;
     if (!('suburb' in value) || value['suburb'] === undefined) return false;
@@ -92,7 +93,7 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
     }
     return {
         
-        'company': json['company'] == null ? undefined : json['company'],
+        'company': 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;
+    line2?: string | null;
     /**
      * 
      * @type {string}
@@ -100,7 +100,6 @@ 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;
@@ -125,7 +124,7 @@ export function AddressResourceFromJSONTyped(json: any, ignoreDiscriminator: boo
         'addresseeName': json['addresseeName'],
         'company': 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/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']),

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']),