@digital8/scope-backend-ts-sdk 0.0.1

package/src/models/PurchaseOrderResource.ts

@@ -0,0 +1,238 @@
+/* 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 { ServiceProviderResource } from './ServiceProviderResource';
+import {
+    ServiceProviderResourceFromJSON,
+    ServiceProviderResourceFromJSONTyped,
+    ServiceProviderResourceToJSON,
+    ServiceProviderResourceToJSONTyped,
+} from './ServiceProviderResource';
+import type { LightJobDetailsResource } from './LightJobDetailsResource';
+import {
+    LightJobDetailsResourceFromJSON,
+    LightJobDetailsResourceFromJSONTyped,
+    LightJobDetailsResourceToJSON,
+    LightJobDetailsResourceToJSONTyped,
+} from './LightJobDetailsResource';
+import type { AddressResource } from './AddressResource';
+import {
+    AddressResourceFromJSON,
+    AddressResourceFromJSONTyped,
+    AddressResourceToJSON,
+    AddressResourceToJSONTyped,
+} from './AddressResource';
+import type { UserRelationResource } from './UserRelationResource';
+import {
+    UserRelationResourceFromJSON,
+    UserRelationResourceFromJSONTyped,
+    UserRelationResourceToJSON,
+    UserRelationResourceToJSONTyped,
+} from './UserRelationResource';
+
+/**
+ * 
+ * @export
+ * @interface PurchaseOrderResource
+ */
+export interface PurchaseOrderResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof PurchaseOrderResource
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof PurchaseOrderResource
+     */
+    purchaseOrderNumber: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PurchaseOrderResource
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PurchaseOrderResource
+     */
+    status: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof PurchaseOrderResource
+     */
+    lineItems: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof PurchaseOrderResource
+     */
+    startDate: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PurchaseOrderResource
+     */
+    completionDate: string;
+    /**
+     * 
+     * @type {LightJobDetailsResource}
+     * @memberof PurchaseOrderResource
+     */
+    job: LightJobDetailsResource | null;
+    /**
+     * 
+     * @type {ServiceProviderResource}
+     * @memberof PurchaseOrderResource
+     */
+    serviceProvider: ServiceProviderResource | null;
+    /**
+     * 
+     * @type {UserRelationResource}
+     * @memberof PurchaseOrderResource
+     */
+    owner: UserRelationResource | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PurchaseOrderResource
+     */
+    includeGst: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof PurchaseOrderResource
+     */
+    gstAmount?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PurchaseOrderResource
+     */
+    grandTotal: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PurchaseOrderResource
+     */
+    totalCost: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof PurchaseOrderResource
+     */
+    totalGST: number;
+    /**
+     * 
+     * @type {AddressResource}
+     * @memberof PurchaseOrderResource
+     */
+    address: AddressResource | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PurchaseOrderResource
+     */
+    lineItemCount: number;
+}
+
+/**
+ * Check if a given object implements the PurchaseOrderResource interface.
+ */
+export function instanceOfPurchaseOrderResource(value: object): value is PurchaseOrderResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('purchaseOrderNumber' in value) || value['purchaseOrderNumber'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('lineItems' in value) || value['lineItems'] === undefined) return false;
+    if (!('startDate' in value) || value['startDate'] === undefined) return false;
+    if (!('completionDate' in value) || value['completionDate'] === undefined) return false;
+    if (!('job' in value) || value['job'] === undefined) return false;
+    if (!('serviceProvider' in value) || value['serviceProvider'] === undefined) return false;
+    if (!('owner' in value) || value['owner'] === undefined) return false;
+    if (!('includeGst' in value) || value['includeGst'] === undefined) return false;
+    if (!('grandTotal' in value) || value['grandTotal'] === undefined) return false;
+    if (!('totalCost' in value) || value['totalCost'] === undefined) return false;
+    if (!('totalGST' in value) || value['totalGST'] === undefined) return false;
+    if (!('address' in value) || value['address'] === undefined) return false;
+    if (!('lineItemCount' in value) || value['lineItemCount'] === undefined) return false;
+    return true;
+}
+
+export function PurchaseOrderResourceFromJSON(json: any): PurchaseOrderResource {
+    return PurchaseOrderResourceFromJSONTyped(json, false);
+}
+
+export function PurchaseOrderResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): PurchaseOrderResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'purchaseOrderNumber': json['purchaseOrderNumber'],
+        'description': json['description'],
+        'status': json['status'],
+        'lineItems': json['lineItems'],
+        'startDate': json['startDate'],
+        'completionDate': json['completionDate'],
+        'job': LightJobDetailsResourceFromJSON(json['job']),
+        'serviceProvider': ServiceProviderResourceFromJSON(json['serviceProvider']),
+        'owner': UserRelationResourceFromJSON(json['owner']),
+        'includeGst': json['includeGst'],
+        'gstAmount': json['gstAmount'] == null ? undefined : json['gstAmount'],
+        'grandTotal': json['grandTotal'],
+        'totalCost': json['totalCost'],
+        'totalGST': json['totalGST'],
+        'address': AddressResourceFromJSON(json['address']),
+        'lineItemCount': json['lineItemCount'],
+    };
+}
+
+export function PurchaseOrderResourceToJSON(json: any): PurchaseOrderResource {
+    return PurchaseOrderResourceToJSONTyped(json, false);
+}
+
+export function PurchaseOrderResourceToJSONTyped(value?: PurchaseOrderResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'purchaseOrderNumber': value['purchaseOrderNumber'],
+        'description': value['description'],
+        'status': value['status'],
+        'lineItems': value['lineItems'],
+        'startDate': value['startDate'],
+        'completionDate': value['completionDate'],
+        'job': LightJobDetailsResourceToJSON(value['job']),
+        'serviceProvider': ServiceProviderResourceToJSON(value['serviceProvider']),
+        'owner': UserRelationResourceToJSON(value['owner']),
+        'includeGst': value['includeGst'],
+        'gstAmount': value['gstAmount'],
+        'grandTotal': value['grandTotal'],
+        'totalCost': value['totalCost'],
+        'totalGST': value['totalGST'],
+        'address': AddressResourceToJSON(value['address']),
+        'lineItemCount': value['lineItemCount'],
+    };
+}
+

package/src/models/PurchaseOrderResourceArrayResponse.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 { PurchaseOrderResource } from './PurchaseOrderResource';
+import {
+    PurchaseOrderResourceFromJSON,
+    PurchaseOrderResourceFromJSONTyped,
+    PurchaseOrderResourceToJSON,
+    PurchaseOrderResourceToJSONTyped,
+} from './PurchaseOrderResource';
+
+/**
+ * 
+ * @export
+ * @interface PurchaseOrderResourceArrayResponse
+ */
+export interface PurchaseOrderResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<PurchaseOrderResource>}
+     * @memberof PurchaseOrderResourceArrayResponse
+     */
+    data?: Array<PurchaseOrderResource>;
+}
+
+/**
+ * Check if a given object implements the PurchaseOrderResourceArrayResponse interface.
+ */
+export function instanceOfPurchaseOrderResourceArrayResponse(value: object): value is PurchaseOrderResourceArrayResponse {
+    return true;
+}
+
+export function PurchaseOrderResourceArrayResponseFromJSON(json: any): PurchaseOrderResourceArrayResponse {
+    return PurchaseOrderResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function PurchaseOrderResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): PurchaseOrderResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(PurchaseOrderResourceFromJSON)),
+    };
+}
+
+export function PurchaseOrderResourceArrayResponseToJSON(json: any): PurchaseOrderResourceArrayResponse {
+    return PurchaseOrderResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function PurchaseOrderResourceArrayResponseToJSONTyped(value?: PurchaseOrderResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(PurchaseOrderResourceToJSON)),
+    };
+}
+

package/src/models/PurchaseOrderStatus.ts

@@ -0,0 +1,55 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const PurchaseOrderStatus = {
+    Draft: 'draft',
+    Created: 'created',
+    Approved: 'approved',
+    Billed: 'billed'
+} as const;
+export type PurchaseOrderStatus = typeof PurchaseOrderStatus[keyof typeof PurchaseOrderStatus];
+
+
+export function instanceOfPurchaseOrderStatus(value: any): boolean {
+    for (const key in PurchaseOrderStatus) {
+        if (Object.prototype.hasOwnProperty.call(PurchaseOrderStatus, key)) {
+            if (PurchaseOrderStatus[key as keyof typeof PurchaseOrderStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function PurchaseOrderStatusFromJSON(json: any): PurchaseOrderStatus {
+    return PurchaseOrderStatusFromJSONTyped(json, false);
+}
+
+export function PurchaseOrderStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): PurchaseOrderStatus {
+    return json as PurchaseOrderStatus;
+}
+
+export function PurchaseOrderStatusToJSON(value?: PurchaseOrderStatus | null): any {
+    return value as any;
+}
+
+export function PurchaseOrderStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): PurchaseOrderStatus {
+    return value as PurchaseOrderStatus;
+}
+

package/src/models/QuoteResource.ts

@@ -0,0 +1,336 @@
+/* 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 { ContactRelationResource } from './ContactRelationResource';
+import {
+    ContactRelationResourceFromJSON,
+    ContactRelationResourceFromJSONTyped,
+    ContactRelationResourceToJSON,
+    ContactRelationResourceToJSONTyped,
+} from './ContactRelationResource';
+import type { LightJobDetailsResource } from './LightJobDetailsResource';
+import {
+    LightJobDetailsResourceFromJSON,
+    LightJobDetailsResourceFromJSONTyped,
+    LightJobDetailsResourceToJSON,
+    LightJobDetailsResourceToJSONTyped,
+} from './LightJobDetailsResource';
+import type { AddressResource } from './AddressResource';
+import {
+    AddressResourceFromJSON,
+    AddressResourceFromJSONTyped,
+    AddressResourceToJSON,
+    AddressResourceToJSONTyped,
+} from './AddressResource';
+import type { UserRelationResource } from './UserRelationResource';
+import {
+    UserRelationResourceFromJSON,
+    UserRelationResourceFromJSONTyped,
+    UserRelationResourceToJSON,
+    UserRelationResourceToJSONTyped,
+} from './UserRelationResource';
+
+/**
+ * 
+ * @export
+ * @interface QuoteResource
+ */
+export interface QuoteResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof QuoteResource
+     */
+    quoteNumber: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof QuoteResource
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof QuoteResource
+     */
+    status: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof QuoteResource
+     */
+    isVariation: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof QuoteResource
+     */
+    createdAt?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof QuoteResource
+     */
+    updatedAt?: string | null;
+    /**
+     * 
+     * @type {object}
+     * @memberof QuoteResource
+     */
+    lineItems: object;
+    /**
+     * 
+     * @type {LightJobDetailsResource}
+     * @memberof QuoteResource
+     */
+    job: LightJobDetailsResource | null;
+    /**
+     * 
+     * @type {UserRelationResource}
+     * @memberof QuoteResource
+     */
+    owner: UserRelationResource | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    subtotal: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    totalCost: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    totalGST: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    averageMarkup: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    totalProfit: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    grandTotal: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    contactId: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    jobId: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof QuoteResource
+     */
+    quoteDate: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof QuoteResource
+     */
+    expiryDate: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof QuoteResource
+     */
+    reference: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof QuoteResource
+     */
+    reviews: object;
+    /**
+     * 
+     * @type {AddressResource}
+     * @memberof QuoteResource
+     */
+    address: AddressResource | null;
+    /**
+     * 
+     * @type {QuoteResource}
+     * @memberof QuoteResource
+     */
+    originalQuote: QuoteResource | null;
+    /**
+     * 
+     * @type {object}
+     * @memberof QuoteResource
+     */
+    variations: object;
+    /**
+     * 
+     * @type {ContactRelationResource}
+     * @memberof QuoteResource
+     */
+    contact: ContactRelationResource | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    lineItemCount: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof QuoteResource
+     */
+    businessUnitId: number;
+}
+
+/**
+ * Check if a given object implements the QuoteResource interface.
+ */
+export function instanceOfQuoteResource(value: object): value is QuoteResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('quoteNumber' in value) || value['quoteNumber'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('isVariation' in value) || value['isVariation'] === undefined) return false;
+    if (!('lineItems' in value) || value['lineItems'] === undefined) return false;
+    if (!('job' in value) || value['job'] === undefined) return false;
+    if (!('owner' in value) || value['owner'] === undefined) return false;
+    if (!('subtotal' in value) || value['subtotal'] === undefined) return false;
+    if (!('totalCost' in value) || value['totalCost'] === undefined) return false;
+    if (!('totalGST' in value) || value['totalGST'] === undefined) return false;
+    if (!('averageMarkup' in value) || value['averageMarkup'] === undefined) return false;
+    if (!('totalProfit' in value) || value['totalProfit'] === undefined) return false;
+    if (!('grandTotal' in value) || value['grandTotal'] === undefined) return false;
+    if (!('contactId' in value) || value['contactId'] === undefined) return false;
+    if (!('jobId' in value) || value['jobId'] === undefined) return false;
+    if (!('quoteDate' in value) || value['quoteDate'] === undefined) return false;
+    if (!('expiryDate' in value) || value['expiryDate'] === undefined) return false;
+    if (!('reference' in value) || value['reference'] === undefined) return false;
+    if (!('reviews' in value) || value['reviews'] === undefined) return false;
+    if (!('address' in value) || value['address'] === undefined) return false;
+    if (!('originalQuote' in value) || value['originalQuote'] === undefined) return false;
+    if (!('variations' in value) || value['variations'] === undefined) return false;
+    if (!('contact' in value) || value['contact'] === undefined) return false;
+    if (!('lineItemCount' in value) || value['lineItemCount'] === undefined) return false;
+    if (!('businessUnitId' in value) || value['businessUnitId'] === undefined) return false;
+    return true;
+}
+
+export function QuoteResourceFromJSON(json: any): QuoteResource {
+    return QuoteResourceFromJSONTyped(json, false);
+}
+
+export function QuoteResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): QuoteResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'quoteNumber': json['quoteNumber'],
+        'description': json['description'],
+        'status': json['status'],
+        'isVariation': json['isVariation'],
+        'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
+        'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
+        'lineItems': json['lineItems'],
+        'job': LightJobDetailsResourceFromJSON(json['job']),
+        'owner': UserRelationResourceFromJSON(json['owner']),
+        'subtotal': json['subtotal'],
+        'totalCost': json['totalCost'],
+        'totalGST': json['totalGST'],
+        'averageMarkup': json['averageMarkup'],
+        'totalProfit': json['totalProfit'],
+        'grandTotal': json['grandTotal'],
+        'contactId': json['contactId'],
+        'jobId': json['jobId'],
+        'quoteDate': json['quoteDate'],
+        'expiryDate': json['expiryDate'],
+        'reference': json['reference'],
+        'reviews': json['reviews'],
+        'address': AddressResourceFromJSON(json['address']),
+        'originalQuote': QuoteResourceFromJSON(json['originalQuote']),
+        'variations': json['variations'],
+        'contact': ContactRelationResourceFromJSON(json['contact']),
+        'lineItemCount': json['lineItemCount'],
+        'businessUnitId': json['businessUnitId'],
+    };
+}
+
+export function QuoteResourceToJSON(json: any): QuoteResource {
+    return QuoteResourceToJSONTyped(json, false);
+}
+
+export function QuoteResourceToJSONTyped(value?: QuoteResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'quoteNumber': value['quoteNumber'],
+        'description': value['description'],
+        'status': value['status'],
+        'isVariation': value['isVariation'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+        'lineItems': value['lineItems'],
+        'job': LightJobDetailsResourceToJSON(value['job']),
+        'owner': UserRelationResourceToJSON(value['owner']),
+        'subtotal': value['subtotal'],
+        'totalCost': value['totalCost'],
+        'totalGST': value['totalGST'],
+        'averageMarkup': value['averageMarkup'],
+        'totalProfit': value['totalProfit'],
+        'grandTotal': value['grandTotal'],
+        'contactId': value['contactId'],
+        'jobId': value['jobId'],
+        'quoteDate': value['quoteDate'],
+        'expiryDate': value['expiryDate'],
+        'reference': value['reference'],
+        'reviews': value['reviews'],
+        'address': AddressResourceToJSON(value['address']),
+        'originalQuote': QuoteResourceToJSON(value['originalQuote']),
+        'variations': value['variations'],
+        'contact': ContactRelationResourceToJSON(value['contact']),
+        'lineItemCount': value['lineItemCount'],
+        'businessUnitId': value['businessUnitId'],
+    };
+}
+