@digital8/lighting-illusions-ts-sdk 0.0.2725 → 0.0.2726

package/src/apis/TransactionsApi.ts

@@ -16,6 +16,7 @@
 import * as runtime from '../runtime';
 import type {
   CreateTransactionRequest,
+  GenericResponse,
   PaginatedTransactionListResourceResponse,
   RefundTransactionRequest,
   SearchTransactionsRequest,
@@ -25,6 +26,8 @@ import type {
 import {
     CreateTransactionRequestFromJSON,
     CreateTransactionRequestToJSON,
+    GenericResponseFromJSON,
+    GenericResponseToJSON,
     PaginatedTransactionListResourceResponseFromJSON,
     PaginatedTransactionListResourceResponseToJSON,
     RefundTransactionRequestFromJSON,
@@ -37,6 +40,10 @@ import {
     TransactionResourceToJSON,
 } from '../models/index';
 
+export interface DestroyTransactionRequest {
+    transaction: number;
+}
+
 export interface IndexTransactionRequest {
     searchTransactionsRequest?: SearchTransactionsRequest;
 }
@@ -55,6 +62,43 @@ export interface StoreTransactionRequest {
  */
 export class TransactionsApi extends runtime.BaseAPI {
 
+    /**
+     * Auto-generated: destroyTransaction
+     */
+    async destroyTransactionRaw(requestParameters: DestroyTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GenericResponse>> {
+        if (requestParameters['transaction'] == null) {
+            throw new runtime.RequiredError(
+                'transaction',
+                'Required parameter "transaction" was null or undefined when calling destroyTransaction().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/admin-api/transactions/{transaction}/delete`;
+        urlPath = urlPath.replace(`{${"transaction"}}`, encodeURIComponent(String(requestParameters['transaction'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GenericResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Auto-generated: destroyTransaction
+     */
+    async destroyTransaction(requestParameters: DestroyTransactionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GenericResponse> {
+        const response = await this.destroyTransactionRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Auto-generated: indexTransaction
      */

package/src/apis/index.ts

@@ -35,6 +35,7 @@ export * from './ReviewApi';
 export * from './RolesApi';
 export * from './SiteApi';
 export * from './StoreApi';
+export * from './StoreCreditsApi';
 export * from './SupplierApi';
 export * from './TagApi';
 export * from './TransactionsApi';

package/src/models/AddressFrontendResource.ts

@@ -54,7 +54,7 @@ export interface AddressFrontendResource {
      * @type {string}
      * @memberof AddressFrontendResource
      */
-    line2: string;
+    line2?: string | null;
     /**
      * 
      * @type {string}
@@ -94,7 +94,6 @@ export function instanceOfAddressFrontendResource(value: object): value is Addre
     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;
@@ -118,7 +117,7 @@ export function AddressFrontendResourceFromJSONTyped(json: any, ignoreDiscrimina
         '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/CreateTransactionRequest.ts

@@ -80,7 +80,8 @@ export const CreateTransactionRequestPaymentMethodEnum = {
     AmericanExpress: 'american_express',
     GooglePay: 'google_pay',
     PayPal: 'pay_pal',
-    ApplePay: 'apple_pay'
+    ApplePay: 'apple_pay',
+    StoreCredit: 'store_credit'
 } as const;
 export type CreateTransactionRequestPaymentMethodEnum = typeof CreateTransactionRequestPaymentMethodEnum[keyof typeof CreateTransactionRequestPaymentMethodEnum];
 

package/src/models/FrontendCartResource.ts

@@ -186,6 +186,24 @@ export interface FrontendCartResource {
      * @memberof FrontendCartResource
      */
     grandTotal: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof FrontendCartResource
+     */
+    storeCredits: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof FrontendCartResource
+     */
+    storeCreditTotal: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof FrontendCartResource
+     */
+    amountDue: number;
 }
 
 /**
@@ -211,6 +229,9 @@ export function instanceOfFrontendCartResource(value: object): value is Frontend
     if (!('transitInsuranceQuote' in value) || value['transitInsuranceQuote'] === undefined) return false;
     if (!('gst' in value) || value['gst'] === undefined) return false;
     if (!('grandTotal' in value) || value['grandTotal'] === undefined) return false;
+    if (!('storeCredits' in value) || value['storeCredits'] === undefined) return false;
+    if (!('storeCreditTotal' in value) || value['storeCreditTotal'] === undefined) return false;
+    if (!('amountDue' in value) || value['amountDue'] === undefined) return false;
     return true;
 }
 
@@ -247,6 +268,9 @@ export function FrontendCartResourceFromJSONTyped(json: any, ignoreDiscriminator
         'transitInsuranceQuote': json['transitInsuranceQuote'],
         'gst': json['gst'],
         'grandTotal': json['grandTotal'],
+        'storeCredits': json['storeCredits'],
+        'storeCreditTotal': json['storeCreditTotal'],
+        'amountDue': json['amountDue'],
     };
 }
 
@@ -284,6 +308,9 @@ export function FrontendCartResourceToJSONTyped(value?: FrontendCartResource | n
         'transitInsuranceQuote': value['transitInsuranceQuote'],
         'gst': value['gst'],
         'grandTotal': value['grandTotal'],
+        'storeCredits': value['storeCredits'],
+        'storeCreditTotal': value['storeCreditTotal'],
+        'amountDue': value['amountDue'],
     };
 }
 

package/src/models/OrderFulfillmentResource.ts

@@ -50,7 +50,7 @@ export interface OrderFulfillmentResource {
      * @type {string}
      * @memberof OrderFulfillmentResource
      */
-    trackingNumber?: string | null;
+    trackingNumber: string;
     /**
      * 
      * @type {string}
@@ -62,7 +62,7 @@ export interface OrderFulfillmentResource {
      * @type {string}
      * @memberof OrderFulfillmentResource
      */
-    trackingCompany: string;
+    trackingCompany?: string | null;
     /**
      * 
      * @type {string}
@@ -102,8 +102,8 @@ export function instanceOfOrderFulfillmentResource(value: object): value is Orde
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('orderId' in value) || value['orderId'] === undefined) 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) return false;
     if (!('orderFulfillmentLineItems' in value) || value['orderFulfillmentLineItems'] === undefined) return false;
@@ -123,9 +123,9 @@ export function OrderFulfillmentResourceFromJSONTyped(json: any, ignoreDiscrimin
         'id': json['id'],
         'orderId': json['orderId'],
         'dateShipped': (new Date(json['dateShipped'])),
-        'trackingNumber': json['trackingNumber'] == null ? undefined : json['trackingNumber'],
+        'trackingNumber': 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/src/models/PaginatedStoreCreditListResourceResponse.ts

@@ -0,0 +1,90 @@
+/* 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 { StoreCreditListResource } from './StoreCreditListResource';
+import {
+    StoreCreditListResourceFromJSON,
+    StoreCreditListResourceFromJSONTyped,
+    StoreCreditListResourceToJSON,
+    StoreCreditListResourceToJSONTyped,
+} from './StoreCreditListResource';
+import type { PagingMetadata } from './PagingMetadata';
+import {
+    PagingMetadataFromJSON,
+    PagingMetadataFromJSONTyped,
+    PagingMetadataToJSON,
+    PagingMetadataToJSONTyped,
+} from './PagingMetadata';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedStoreCreditListResourceResponse
+ */
+export interface PaginatedStoreCreditListResourceResponse {
+    /**
+     * 
+     * @type {Array<StoreCreditListResource>}
+     * @memberof PaginatedStoreCreditListResourceResponse
+     */
+    data: Array<StoreCreditListResource>;
+    /**
+     * 
+     * @type {PagingMetadata}
+     * @memberof PaginatedStoreCreditListResourceResponse
+     */
+    meta: PagingMetadata;
+}
+
+/**
+ * Check if a given object implements the PaginatedStoreCreditListResourceResponse interface.
+ */
+export function instanceOfPaginatedStoreCreditListResourceResponse(value: object): value is PaginatedStoreCreditListResourceResponse {
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('meta' in value) || value['meta'] === undefined) return false;
+    return true;
+}
+
+export function PaginatedStoreCreditListResourceResponseFromJSON(json: any): PaginatedStoreCreditListResourceResponse {
+    return PaginatedStoreCreditListResourceResponseFromJSONTyped(json, false);
+}
+
+export function PaginatedStoreCreditListResourceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedStoreCreditListResourceResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': ((json['data'] as Array<any>).map(StoreCreditListResourceFromJSON)),
+        'meta': PagingMetadataFromJSON(json['meta']),
+    };
+}
+
+export function PaginatedStoreCreditListResourceResponseToJSON(json: any): PaginatedStoreCreditListResourceResponse {
+    return PaginatedStoreCreditListResourceResponseToJSONTyped(json, false);
+}
+
+export function PaginatedStoreCreditListResourceResponseToJSONTyped(value?: PaginatedStoreCreditListResourceResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': ((value['data'] as Array<any>).map(StoreCreditListResourceToJSON)),
+        'meta': PagingMetadataToJSON(value['meta']),
+    };
+}
+

package/src/models/PaymentMethod.ts

@@ -24,7 +24,8 @@ export const PaymentMethod = {
     AmericanExpress: 'american_express',
     GooglePay: 'google_pay',
     PayPal: 'pay_pal',
-    ApplePay: 'apple_pay'
+    ApplePay: 'apple_pay',
+    StoreCredit: 'store_credit'
 } as const;
 export type PaymentMethod = typeof PaymentMethod[keyof typeof PaymentMethod];
 

package/src/models/PaymentTotalsResource.ts

@@ -79,6 +79,18 @@ export interface PaymentTotalsResource {
      * @memberof PaymentTotalsResource
      */
     amountDue: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PaymentTotalsResource
+     */
+    storeCredits: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof PaymentTotalsResource
+     */
+    storeCreditTotal: number;
     /**
      * 
      * @type {Array<object>}
@@ -143,6 +155,8 @@ export function instanceOfPaymentTotalsResource(value: object): value is Payment
     if (!('amountPaid' in value) || value['amountPaid'] === undefined) return false;
     if (!('surchargePaid' in value) || value['surchargePaid'] === undefined) return false;
     if (!('amountDue' in value) || value['amountDue'] === undefined) return false;
+    if (!('storeCredits' in value) || value['storeCredits'] === undefined) return false;
+    if (!('storeCreditTotal' in value) || value['storeCreditTotal'] === undefined) return false;
     if (!('appliedCoupons' in value) || value['appliedCoupons'] === undefined) return false;
     if (!('noOfItems' in value) || value['noOfItems'] === undefined) return false;
     if (!('lineItems' in value) || value['lineItems'] === undefined) return false;
@@ -173,6 +187,8 @@ export function PaymentTotalsResourceFromJSONTyped(json: any, ignoreDiscriminato
         'amountPaid': json['amountPaid'],
         'surchargePaid': json['surchargePaid'],
         'amountDue': json['amountDue'],
+        'storeCredits': json['storeCredits'],
+        'storeCreditTotal': json['storeCreditTotal'],
         'appliedCoupons': json['appliedCoupons'],
         'noOfItems': json['noOfItems'],
         'lineItems': json['lineItems'],
@@ -205,6 +221,8 @@ export function PaymentTotalsResourceToJSONTyped(value?: PaymentTotalsResource |
         'amountPaid': value['amountPaid'],
         'surchargePaid': value['surchargePaid'],
         'amountDue': value['amountDue'],
+        'storeCredits': value['storeCredits'],
+        'storeCreditTotal': value['storeCreditTotal'],
         'appliedCoupons': value['appliedCoupons'],
         'noOfItems': value['noOfItems'],
         'lineItems': value['lineItems'],

package/src/models/SearchStoreCreditsRequest.ts

@@ -0,0 +1,161 @@
+/* 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 SearchStoreCreditsRequest
+ */
+export interface SearchStoreCreditsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof SearchStoreCreditsRequest
+     */
+    search?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof SearchStoreCreditsRequest
+     */
+    sortBy?: SearchStoreCreditsRequestSortByEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof SearchStoreCreditsRequest
+     */
+    sortDirection?: SearchStoreCreditsRequestSortDirectionEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof SearchStoreCreditsRequest
+     */
+    perPage?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof SearchStoreCreditsRequest
+     */
+    page?: number;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof SearchStoreCreditsRequest
+     */
+    siteId?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof SearchStoreCreditsRequest
+     */
+    customerId?: Array<string>;
+    /**
+     * 
+     * @type {number}
+     * @memberof SearchStoreCreditsRequest
+     */
+    relatedId?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof SearchStoreCreditsRequest
+     */
+    relatedType?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof SearchStoreCreditsRequest
+     */
+    includesRelations?: boolean;
+}
+
+
+/**
+ * @export
+ */
+export const SearchStoreCreditsRequestSortByEnum = {
+    Id: 'id',
+    Code: 'code',
+    ExpiryDate: 'expiry_date',
+    OriginalAmount: 'original_amount',
+    AmountRemaining: 'amount_remaining',
+    CreatedAt: 'created_at'
+} as const;
+export type SearchStoreCreditsRequestSortByEnum = typeof SearchStoreCreditsRequestSortByEnum[keyof typeof SearchStoreCreditsRequestSortByEnum];
+
+/**
+ * @export
+ */
+export const SearchStoreCreditsRequestSortDirectionEnum = {
+    Asc: 'asc',
+    Desc: 'desc'
+} as const;
+export type SearchStoreCreditsRequestSortDirectionEnum = typeof SearchStoreCreditsRequestSortDirectionEnum[keyof typeof SearchStoreCreditsRequestSortDirectionEnum];
+
+
+/**
+ * Check if a given object implements the SearchStoreCreditsRequest interface.
+ */
+export function instanceOfSearchStoreCreditsRequest(value: object): value is SearchStoreCreditsRequest {
+    return true;
+}
+
+export function SearchStoreCreditsRequestFromJSON(json: any): SearchStoreCreditsRequest {
+    return SearchStoreCreditsRequestFromJSONTyped(json, false);
+}
+
+export function SearchStoreCreditsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SearchStoreCreditsRequest {
+    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'],
+        'siteId': json['site_id'] == null ? undefined : json['site_id'],
+        'customerId': json['customer_id'] == null ? undefined : json['customer_id'],
+        '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 SearchStoreCreditsRequestToJSON(json: any): SearchStoreCreditsRequest {
+    return SearchStoreCreditsRequestToJSONTyped(json, false);
+}
+
+export function SearchStoreCreditsRequestToJSONTyped(value?: SearchStoreCreditsRequest | 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'],
+        'site_id': value['siteId'],
+        'customer_id': value['customerId'],
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+        'includes_relations': value['includesRelations'],
+    };
+}
+

package/src/models/StoreCreditListResource.ts

@@ -0,0 +1,143 @@
+/* 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 StoreCreditListResource
+ */
+export interface StoreCreditListResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof StoreCreditListResource
+     */
+    id: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StoreCreditListResource
+     */
+    siteId: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StoreCreditListResource
+     */
+    customerId?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof StoreCreditListResource
+     */
+    code: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof StoreCreditListResource
+     */
+    recipientEmail: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof StoreCreditListResource
+     */
+    expiryDate?: Date | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof StoreCreditListResource
+     */
+    originalAmount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof StoreCreditListResource
+     */
+    amountRemaining: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof StoreCreditListResource
+     */
+    netsuiteId?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof StoreCreditListResource
+     */
+    createdAt?: Date | null;
+}
+
+/**
+ * Check if a given object implements the StoreCreditListResource interface.
+ */
+export function instanceOfStoreCreditListResource(value: object): value is StoreCreditListResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('siteId' in value) || value['siteId'] === undefined) return false;
+    if (!('code' in value) || value['code'] === undefined) return false;
+    if (!('recipientEmail' in value) || value['recipientEmail'] === undefined) return false;
+    if (!('originalAmount' in value) || value['originalAmount'] === undefined) return false;
+    if (!('amountRemaining' in value) || value['amountRemaining'] === undefined) return false;
+    return true;
+}
+
+export function StoreCreditListResourceFromJSON(json: any): StoreCreditListResource {
+    return StoreCreditListResourceFromJSONTyped(json, false);
+}
+
+export function StoreCreditListResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): StoreCreditListResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'siteId': json['siteId'],
+        'customerId': json['customerId'] == null ? undefined : json['customerId'],
+        'code': json['code'],
+        'recipientEmail': json['recipientEmail'],
+        'expiryDate': json['expiryDate'] == null ? undefined : (new Date(json['expiryDate'])),
+        'originalAmount': json['originalAmount'],
+        'amountRemaining': json['amountRemaining'],
+        'netsuiteId': json['netsuiteId'] == null ? undefined : json['netsuiteId'],
+        'createdAt': json['createdAt'] == null ? undefined : (new Date(json['createdAt'])),
+    };
+}
+
+export function StoreCreditListResourceToJSON(json: any): StoreCreditListResource {
+    return StoreCreditListResourceToJSONTyped(json, false);
+}
+
+export function StoreCreditListResourceToJSONTyped(value?: StoreCreditListResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'siteId': value['siteId'],
+        'customerId': value['customerId'],
+        'code': value['code'],
+        'recipientEmail': value['recipientEmail'],
+        'expiryDate': value['expiryDate'] === null ? null : ((value['expiryDate'] as any)?.toISOString()),
+        'originalAmount': value['originalAmount'],
+        'amountRemaining': value['amountRemaining'],
+        'netsuiteId': value['netsuiteId'],
+        'createdAt': value['createdAt'] === null ? null : ((value['createdAt'] as any)?.toISOString()),
+    };
+}
+