@digital8/scope-backend-ts-sdk 0.0.1

package/src/models/GetLicencesRequest.ts

@@ -0,0 +1,86 @@
+/* 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 GetLicencesRequest
+ */
+export interface GetLicencesRequest {
+    /**
+     * 
+     * @type {number}
+     * @memberof GetLicencesRequest
+     */
+    relatedId: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetLicencesRequest
+     */
+    relatedType: GetLicencesRequestRelatedTypeEnum;
+}
+
+
+/**
+ * @export
+ */
+export const GetLicencesRequestRelatedTypeEnum = {
+    User: 'user',
+    ServiceProvider: 'service_provider'
+} as const;
+export type GetLicencesRequestRelatedTypeEnum = typeof GetLicencesRequestRelatedTypeEnum[keyof typeof GetLicencesRequestRelatedTypeEnum];
+
+
+/**
+ * Check if a given object implements the GetLicencesRequest interface.
+ */
+export function instanceOfGetLicencesRequest(value: object): value is GetLicencesRequest {
+    if (!('relatedId' in value) || value['relatedId'] === undefined) return false;
+    if (!('relatedType' in value) || value['relatedType'] === undefined) return false;
+    return true;
+}
+
+export function GetLicencesRequestFromJSON(json: any): GetLicencesRequest {
+    return GetLicencesRequestFromJSONTyped(json, false);
+}
+
+export function GetLicencesRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetLicencesRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'relatedId': json['related_id'],
+        'relatedType': json['related_type'],
+    };
+}
+
+export function GetLicencesRequestToJSON(json: any): GetLicencesRequest {
+    return GetLicencesRequestToJSONTyped(json, false);
+}
+
+export function GetLicencesRequestToJSONTyped(value?: GetLicencesRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+    };
+}
+

package/src/models/GetUsersForTeamsRequest.ts

@@ -0,0 +1,66 @@
+/* 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 GetUsersForTeamsRequest
+ */
+export interface GetUsersForTeamsRequest {
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof GetUsersForTeamsRequest
+     */
+    teamIds: Array<number>;
+}
+
+/**
+ * Check if a given object implements the GetUsersForTeamsRequest interface.
+ */
+export function instanceOfGetUsersForTeamsRequest(value: object): value is GetUsersForTeamsRequest {
+    if (!('teamIds' in value) || value['teamIds'] === undefined) return false;
+    return true;
+}
+
+export function GetUsersForTeamsRequestFromJSON(json: any): GetUsersForTeamsRequest {
+    return GetUsersForTeamsRequestFromJSONTyped(json, false);
+}
+
+export function GetUsersForTeamsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetUsersForTeamsRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'teamIds': json['team_ids'],
+    };
+}
+
+export function GetUsersForTeamsRequestToJSON(json: any): GetUsersForTeamsRequest {
+    return GetUsersForTeamsRequestToJSONTyped(json, false);
+}
+
+export function GetUsersForTeamsRequestToJSONTyped(value?: GetUsersForTeamsRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'team_ids': value['teamIds'],
+    };
+}
+

package/src/models/HeadInvoiceResource.ts

@@ -0,0 +1,341 @@
+/* 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 { QuoteResource } from './QuoteResource';
+import {
+    QuoteResourceFromJSON,
+    QuoteResourceFromJSONTyped,
+    QuoteResourceToJSON,
+    QuoteResourceToJSONTyped,
+} from './QuoteResource';
+import type { BusinessUnitRelationResource } from './BusinessUnitRelationResource';
+import {
+    BusinessUnitRelationResourceFromJSON,
+    BusinessUnitRelationResourceFromJSONTyped,
+    BusinessUnitRelationResourceToJSON,
+    BusinessUnitRelationResourceToJSONTyped,
+} from './BusinessUnitRelationResource';
+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 HeadInvoiceResource
+ */
+export interface HeadInvoiceResource {
+    /**
+     * 
+     * @type {number}
+     * @memberof HeadInvoiceResource
+     */
+    id: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof HeadInvoiceResource
+     */
+    headInvoiceNumber: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HeadInvoiceResource
+     */
+    description: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HeadInvoiceResource
+     */
+    xeroSyncStatus: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof HeadInvoiceResource
+     */
+    includeGst: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof HeadInvoiceResource
+     */
+    dueDate: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HeadInvoiceResource
+     */
+    reference: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof HeadInvoiceResource
+     */
+    createdAt?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof HeadInvoiceResource
+     */
+    status: string;
+    /**
+     * 
+     * @type {BusinessUnitRelationResource}
+     * @memberof HeadInvoiceResource
+     */
+    businessUnit: BusinessUnitRelationResource | null;
+    /**
+     * 
+     * @type {UserRelationResource}
+     * @memberof HeadInvoiceResource
+     */
+    owner: UserRelationResource | null;
+    /**
+     * 
+     * @type {ContactRelationResource}
+     * @memberof HeadInvoiceResource
+     */
+    contact: ContactRelationResource | null;
+    /**
+     * 
+     * @type {QuoteResource}
+     * @memberof HeadInvoiceResource
+     */
+    quote: QuoteResource | null;
+    /**
+     * 
+     * @type {object}
+     * @memberof HeadInvoiceResource
+     */
+    lineItems: object;
+    /**
+     * 
+     * @type {number}
+     * @memberof HeadInvoiceResource
+     */
+    subtotal: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof HeadInvoiceResource
+     */
+    totalCost: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof HeadInvoiceResource
+     */
+    totalGST: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof HeadInvoiceResource
+     */
+    averageMarkup: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof HeadInvoiceResource
+     */
+    totalProfit: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof HeadInvoiceResource
+     */
+    grandTotal: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof HeadInvoiceResource
+     */
+    totalPaid: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof HeadInvoiceResource
+     */
+    contactId: number;
+    /**
+     * 
+     * @type {object}
+     * @memberof HeadInvoiceResource
+     */
+    xeroLogs: object;
+    /**
+     * 
+     * @type {LightJobDetailsResource}
+     * @memberof HeadInvoiceResource
+     */
+    job: LightJobDetailsResource | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof HeadInvoiceResource
+     */
+    xeroId?: string | null;
+    /**
+     * 
+     * @type {AddressResource}
+     * @memberof HeadInvoiceResource
+     */
+    address: AddressResource | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof HeadInvoiceResource
+     */
+    lineItemCount: number;
+}
+
+/**
+ * Check if a given object implements the HeadInvoiceResource interface.
+ */
+export function instanceOfHeadInvoiceResource(value: object): value is HeadInvoiceResource {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('headInvoiceNumber' in value) || value['headInvoiceNumber'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('xeroSyncStatus' in value) || value['xeroSyncStatus'] === undefined) return false;
+    if (!('includeGst' in value) || value['includeGst'] === undefined) return false;
+    if (!('dueDate' in value) || value['dueDate'] === undefined) return false;
+    if (!('reference' in value) || value['reference'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('businessUnit' in value) || value['businessUnit'] === undefined) return false;
+    if (!('owner' in value) || value['owner'] === undefined) return false;
+    if (!('contact' in value) || value['contact'] === undefined) return false;
+    if (!('quote' in value) || value['quote'] === undefined) return false;
+    if (!('lineItems' in value) || value['lineItems'] === 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 (!('totalPaid' in value) || value['totalPaid'] === undefined) return false;
+    if (!('contactId' in value) || value['contactId'] === undefined) return false;
+    if (!('xeroLogs' in value) || value['xeroLogs'] === undefined) return false;
+    if (!('job' in value) || value['job'] === 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 HeadInvoiceResourceFromJSON(json: any): HeadInvoiceResource {
+    return HeadInvoiceResourceFromJSONTyped(json, false);
+}
+
+export function HeadInvoiceResourceFromJSONTyped(json: any, ignoreDiscriminator: boolean): HeadInvoiceResource {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'headInvoiceNumber': json['headInvoiceNumber'],
+        'description': json['description'],
+        'xeroSyncStatus': json['xeroSyncStatus'],
+        'includeGst': json['includeGst'],
+        'dueDate': json['dueDate'],
+        'reference': json['reference'],
+        'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
+        'status': json['status'],
+        'businessUnit': BusinessUnitRelationResourceFromJSON(json['businessUnit']),
+        'owner': UserRelationResourceFromJSON(json['owner']),
+        'contact': ContactRelationResourceFromJSON(json['contact']),
+        'quote': QuoteResourceFromJSON(json['quote']),
+        'lineItems': json['lineItems'],
+        'subtotal': json['subtotal'],
+        'totalCost': json['totalCost'],
+        'totalGST': json['totalGST'],
+        'averageMarkup': json['averageMarkup'],
+        'totalProfit': json['totalProfit'],
+        'grandTotal': json['grandTotal'],
+        'totalPaid': json['totalPaid'],
+        'contactId': json['contactId'],
+        'xeroLogs': json['xeroLogs'],
+        'job': LightJobDetailsResourceFromJSON(json['job']),
+        'xeroId': json['xeroId'] == null ? undefined : json['xeroId'],
+        'address': AddressResourceFromJSON(json['address']),
+        'lineItemCount': json['lineItemCount'],
+    };
+}
+
+export function HeadInvoiceResourceToJSON(json: any): HeadInvoiceResource {
+    return HeadInvoiceResourceToJSONTyped(json, false);
+}
+
+export function HeadInvoiceResourceToJSONTyped(value?: HeadInvoiceResource | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'headInvoiceNumber': value['headInvoiceNumber'],
+        'description': value['description'],
+        'xeroSyncStatus': value['xeroSyncStatus'],
+        'includeGst': value['includeGst'],
+        'dueDate': value['dueDate'],
+        'reference': value['reference'],
+        'createdAt': value['createdAt'],
+        'status': value['status'],
+        'businessUnit': BusinessUnitRelationResourceToJSON(value['businessUnit']),
+        'owner': UserRelationResourceToJSON(value['owner']),
+        'contact': ContactRelationResourceToJSON(value['contact']),
+        'quote': QuoteResourceToJSON(value['quote']),
+        'lineItems': value['lineItems'],
+        'subtotal': value['subtotal'],
+        'totalCost': value['totalCost'],
+        'totalGST': value['totalGST'],
+        'averageMarkup': value['averageMarkup'],
+        'totalProfit': value['totalProfit'],
+        'grandTotal': value['grandTotal'],
+        'totalPaid': value['totalPaid'],
+        'contactId': value['contactId'],
+        'xeroLogs': value['xeroLogs'],
+        'job': LightJobDetailsResourceToJSON(value['job']),
+        'xeroId': value['xeroId'],
+        'address': AddressResourceToJSON(value['address']),
+        'lineItemCount': value['lineItemCount'],
+    };
+}
+

package/src/models/HeadInvoiceResourceArrayResponse.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 { HeadInvoiceResource } from './HeadInvoiceResource';
+import {
+    HeadInvoiceResourceFromJSON,
+    HeadInvoiceResourceFromJSONTyped,
+    HeadInvoiceResourceToJSON,
+    HeadInvoiceResourceToJSONTyped,
+} from './HeadInvoiceResource';
+
+/**
+ * 
+ * @export
+ * @interface HeadInvoiceResourceArrayResponse
+ */
+export interface HeadInvoiceResourceArrayResponse {
+    /**
+     * 
+     * @type {Array<HeadInvoiceResource>}
+     * @memberof HeadInvoiceResourceArrayResponse
+     */
+    data?: Array<HeadInvoiceResource>;
+}
+
+/**
+ * Check if a given object implements the HeadInvoiceResourceArrayResponse interface.
+ */
+export function instanceOfHeadInvoiceResourceArrayResponse(value: object): value is HeadInvoiceResourceArrayResponse {
+    return true;
+}
+
+export function HeadInvoiceResourceArrayResponseFromJSON(json: any): HeadInvoiceResourceArrayResponse {
+    return HeadInvoiceResourceArrayResponseFromJSONTyped(json, false);
+}
+
+export function HeadInvoiceResourceArrayResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): HeadInvoiceResourceArrayResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'data': json['data'] == null ? undefined : ((json['data'] as Array<any>).map(HeadInvoiceResourceFromJSON)),
+    };
+}
+
+export function HeadInvoiceResourceArrayResponseToJSON(json: any): HeadInvoiceResourceArrayResponse {
+    return HeadInvoiceResourceArrayResponseToJSONTyped(json, false);
+}
+
+export function HeadInvoiceResourceArrayResponseToJSONTyped(value?: HeadInvoiceResourceArrayResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data': value['data'] == null ? undefined : ((value['data'] as Array<any>).map(HeadInvoiceResourceToJSON)),
+    };
+}
+

package/src/models/HeadInvoiceStatus.ts

@@ -0,0 +1,57 @@
+/* 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 HeadInvoiceStatus = {
+    Draft: 'draft',
+    Issued: 'issued',
+    Unpaid: 'unpaid',
+    Overdue: 'overdue',
+    Paid: 'paid',
+    Cancelled: 'cancelled'
+} as const;
+export type HeadInvoiceStatus = typeof HeadInvoiceStatus[keyof typeof HeadInvoiceStatus];
+
+
+export function instanceOfHeadInvoiceStatus(value: any): boolean {
+    for (const key in HeadInvoiceStatus) {
+        if (Object.prototype.hasOwnProperty.call(HeadInvoiceStatus, key)) {
+            if (HeadInvoiceStatus[key as keyof typeof HeadInvoiceStatus] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function HeadInvoiceStatusFromJSON(json: any): HeadInvoiceStatus {
+    return HeadInvoiceStatusFromJSONTyped(json, false);
+}
+
+export function HeadInvoiceStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): HeadInvoiceStatus {
+    return json as HeadInvoiceStatus;
+}
+
+export function HeadInvoiceStatusToJSON(value?: HeadInvoiceStatus | null): any {
+    return value as any;
+}
+
+export function HeadInvoiceStatusToJSONTyped(value: any, ignoreDiscriminator: boolean): HeadInvoiceStatus {
+    return value as HeadInvoiceStatus;
+}
+

package/src/models/ImportInventoryRequest.ts

@@ -0,0 +1,66 @@
+/* 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 ImportInventoryRequest
+ */
+export interface ImportInventoryRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof ImportInventoryRequest
+     */
+    file: string;
+}
+
+/**
+ * Check if a given object implements the ImportInventoryRequest interface.
+ */
+export function instanceOfImportInventoryRequest(value: object): value is ImportInventoryRequest {
+    if (!('file' in value) || value['file'] === undefined) return false;
+    return true;
+}
+
+export function ImportInventoryRequestFromJSON(json: any): ImportInventoryRequest {
+    return ImportInventoryRequestFromJSONTyped(json, false);
+}
+
+export function ImportInventoryRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ImportInventoryRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'file': json['file'],
+    };
+}
+
+export function ImportInventoryRequestToJSON(json: any): ImportInventoryRequest {
+    return ImportInventoryRequestToJSONTyped(json, false);
+}
+
+export function ImportInventoryRequestToJSONTyped(value?: ImportInventoryRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'file': value['file'],
+    };
+}
+