@digital8/scope-backend-ts-sdk 0.0.1

package/src/models/CreateLineItemCategoryRequest.ts

@@ -0,0 +1,105 @@
+/* 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 CreateLineItemCategoryRequest
+ */
+export interface CreateLineItemCategoryRequest {
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateLineItemCategoryRequest
+     */
+    relatedId: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateLineItemCategoryRequest
+     */
+    relatedType: CreateLineItemCategoryRequestRelatedTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateLineItemCategoryRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateLineItemCategoryRequest
+     */
+    dimensions?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const CreateLineItemCategoryRequestRelatedTypeEnum = {
+    Quote: 'quote',
+    PurchaseOrder: 'purchase_order',
+    HeadInvoice: 'head_invoice',
+    TradeInvoice: 'trade_invoice'
+} as const;
+export type CreateLineItemCategoryRequestRelatedTypeEnum = typeof CreateLineItemCategoryRequestRelatedTypeEnum[keyof typeof CreateLineItemCategoryRequestRelatedTypeEnum];
+
+
+/**
+ * Check if a given object implements the CreateLineItemCategoryRequest interface.
+ */
+export function instanceOfCreateLineItemCategoryRequest(value: object): value is CreateLineItemCategoryRequest {
+    if (!('relatedId' in value) || value['relatedId'] === undefined) return false;
+    if (!('relatedType' in value) || value['relatedType'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function CreateLineItemCategoryRequestFromJSON(json: any): CreateLineItemCategoryRequest {
+    return CreateLineItemCategoryRequestFromJSONTyped(json, false);
+}
+
+export function CreateLineItemCategoryRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateLineItemCategoryRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'relatedId': json['related_id'],
+        'relatedType': json['related_type'],
+        'name': json['name'],
+        'dimensions': json['dimensions'] == null ? undefined : json['dimensions'],
+    };
+}
+
+export function CreateLineItemCategoryRequestToJSON(json: any): CreateLineItemCategoryRequest {
+    return CreateLineItemCategoryRequestToJSONTyped(json, false);
+}
+
+export function CreateLineItemCategoryRequestToJSONTyped(value?: CreateLineItemCategoryRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+        'name': value['name'],
+        'dimensions': value['dimensions'],
+    };
+}
+

package/src/models/CreateLineItemRequest.ts

@@ -0,0 +1,160 @@
+/* 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 CreateLineItemRequest
+ */
+export interface CreateLineItemRequest {
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateLineItemRequest
+     */
+    relatedId: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateLineItemRequest
+     */
+    relatedType: CreateLineItemRequestRelatedTypeEnum;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateLineItemRequest
+     */
+    categoryId: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateLineItemRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateLineItemRequest
+     */
+    quantity?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateLineItemRequest
+     */
+    cost?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateLineItemRequest
+     */
+    measurement?: CreateLineItemRequestMeasurementEnum | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateLineItemRequest
+     */
+    trade?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateLineItemRequest
+     */
+    accountCodeId?: string;
+}
+
+
+/**
+ * @export
+ */
+export const CreateLineItemRequestRelatedTypeEnum = {
+    Quote: 'quote',
+    TradeInvoice: 'trade_invoice',
+    HeadInvoice: 'head_invoice',
+    PurchaseOrder: 'purchase_order'
+} as const;
+export type CreateLineItemRequestRelatedTypeEnum = typeof CreateLineItemRequestRelatedTypeEnum[keyof typeof CreateLineItemRequestRelatedTypeEnum];
+
+/**
+ * @export
+ */
+export const CreateLineItemRequestMeasurementEnum = {
+    Lm: 'lm',
+    M2: 'm2',
+    M3: 'm3',
+    Hours: 'hours',
+    Item: 'item',
+    Fee: 'fee',
+    No: 'no'
+} as const;
+export type CreateLineItemRequestMeasurementEnum = typeof CreateLineItemRequestMeasurementEnum[keyof typeof CreateLineItemRequestMeasurementEnum];
+
+
+/**
+ * Check if a given object implements the CreateLineItemRequest interface.
+ */
+export function instanceOfCreateLineItemRequest(value: object): value is CreateLineItemRequest {
+    if (!('relatedId' in value) || value['relatedId'] === undefined) return false;
+    if (!('relatedType' in value) || value['relatedType'] === undefined) return false;
+    if (!('categoryId' in value) || value['categoryId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function CreateLineItemRequestFromJSON(json: any): CreateLineItemRequest {
+    return CreateLineItemRequestFromJSONTyped(json, false);
+}
+
+export function CreateLineItemRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateLineItemRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'relatedId': json['related_id'],
+        'relatedType': json['related_type'],
+        'categoryId': json['category_id'],
+        'name': json['name'],
+        'quantity': json['quantity'] == null ? undefined : json['quantity'],
+        'cost': json['cost'] == null ? undefined : json['cost'],
+        'measurement': json['measurement'] == null ? undefined : json['measurement'],
+        'trade': json['trade'] == null ? undefined : json['trade'],
+        'accountCodeId': json['account_code_id'] == null ? undefined : json['account_code_id'],
+    };
+}
+
+export function CreateLineItemRequestToJSON(json: any): CreateLineItemRequest {
+    return CreateLineItemRequestToJSONTyped(json, false);
+}
+
+export function CreateLineItemRequestToJSONTyped(value?: CreateLineItemRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+        'category_id': value['categoryId'],
+        'name': value['name'],
+        'quantity': value['quantity'],
+        'cost': value['cost'],
+        'measurement': value['measurement'],
+        'trade': value['trade'],
+        'account_code_id': value['accountCodeId'],
+    };
+}
+

package/src/models/CreateNoteRequest.ts

@@ -0,0 +1,95 @@
+/* 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 CreateNoteRequest
+ */
+export interface CreateNoteRequest {
+    /**
+     * 
+     * @type {number}
+     * @memberof CreateNoteRequest
+     */
+    relatedId: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateNoteRequest
+     */
+    relatedType: CreateNoteRequestRelatedTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateNoteRequest
+     */
+    note?: string | null;
+}
+
+
+/**
+ * @export
+ */
+export const CreateNoteRequestRelatedTypeEnum = {
+    Contact: 'contact',
+    ServiceProvider: 'service_provider',
+    Quote: 'quote'
+} as const;
+export type CreateNoteRequestRelatedTypeEnum = typeof CreateNoteRequestRelatedTypeEnum[keyof typeof CreateNoteRequestRelatedTypeEnum];
+
+
+/**
+ * Check if a given object implements the CreateNoteRequest interface.
+ */
+export function instanceOfCreateNoteRequest(value: object): value is CreateNoteRequest {
+    if (!('relatedId' in value) || value['relatedId'] === undefined) return false;
+    if (!('relatedType' in value) || value['relatedType'] === undefined) return false;
+    return true;
+}
+
+export function CreateNoteRequestFromJSON(json: any): CreateNoteRequest {
+    return CreateNoteRequestFromJSONTyped(json, false);
+}
+
+export function CreateNoteRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateNoteRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'relatedId': json['related_id'],
+        'relatedType': json['related_type'],
+        'note': json['note'] == null ? undefined : json['note'],
+    };
+}
+
+export function CreateNoteRequestToJSON(json: any): CreateNoteRequest {
+    return CreateNoteRequestToJSONTyped(json, false);
+}
+
+export function CreateNoteRequestToJSONTyped(value?: CreateNoteRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'related_id': value['relatedId'],
+        'related_type': value['relatedType'],
+        'note': value['note'],
+    };
+}
+

package/src/models/CreatePaymentRequest.ts

@@ -0,0 +1,110 @@
+/* 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 CreatePaymentRequest
+ */
+export interface CreatePaymentRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePaymentRequest
+     */
+    businessUnitId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePaymentRequest
+     */
+    headInvoiceId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePaymentRequest
+     */
+    accountCodeId: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreatePaymentRequest
+     */
+    amount: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePaymentRequest
+     */
+    description?: string | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CreatePaymentRequest
+     */
+    paymentDate: Date;
+}
+
+/**
+ * Check if a given object implements the CreatePaymentRequest interface.
+ */
+export function instanceOfCreatePaymentRequest(value: object): value is CreatePaymentRequest {
+    if (!('businessUnitId' in value) || value['businessUnitId'] === undefined) return false;
+    if (!('headInvoiceId' in value) || value['headInvoiceId'] === undefined) return false;
+    if (!('accountCodeId' in value) || value['accountCodeId'] === undefined) return false;
+    if (!('amount' in value) || value['amount'] === undefined) return false;
+    if (!('paymentDate' in value) || value['paymentDate'] === undefined) return false;
+    return true;
+}
+
+export function CreatePaymentRequestFromJSON(json: any): CreatePaymentRequest {
+    return CreatePaymentRequestFromJSONTyped(json, false);
+}
+
+export function CreatePaymentRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePaymentRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'businessUnitId': json['business_unit_id'],
+        'headInvoiceId': json['head_invoice_id'],
+        'accountCodeId': json['account_code_id'],
+        'amount': json['amount'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'paymentDate': (new Date(json['payment_date'])),
+    };
+}
+
+export function CreatePaymentRequestToJSON(json: any): CreatePaymentRequest {
+    return CreatePaymentRequestToJSONTyped(json, false);
+}
+
+export function CreatePaymentRequestToJSONTyped(value?: CreatePaymentRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'business_unit_id': value['businessUnitId'],
+        'head_invoice_id': value['headInvoiceId'],
+        'account_code_id': value['accountCodeId'],
+        'amount': value['amount'],
+        'description': value['description'],
+        'payment_date': ((value['paymentDate']).toISOString()),
+    };
+}
+

package/src/models/CreatePurchaseOrderRequest.ts

@@ -0,0 +1,153 @@
+/* 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 { CreatePurchaseOrderRequestLineItemsInner } from './CreatePurchaseOrderRequestLineItemsInner';
+import {
+    CreatePurchaseOrderRequestLineItemsInnerFromJSON,
+    CreatePurchaseOrderRequestLineItemsInnerFromJSONTyped,
+    CreatePurchaseOrderRequestLineItemsInnerToJSON,
+    CreatePurchaseOrderRequestLineItemsInnerToJSONTyped,
+} from './CreatePurchaseOrderRequestLineItemsInner';
+
+/**
+ * 
+ * @export
+ * @interface CreatePurchaseOrderRequest
+ */
+export interface CreatePurchaseOrderRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePurchaseOrderRequest
+     */
+    description?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePurchaseOrderRequest
+     */
+    status: CreatePurchaseOrderRequestStatusEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePurchaseOrderRequest
+     */
+    businessUnitId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePurchaseOrderRequest
+     */
+    jobId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePurchaseOrderRequest
+     */
+    serviceProviderId?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CreatePurchaseOrderRequest
+     */
+    includeGst?: boolean;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CreatePurchaseOrderRequest
+     */
+    startDate?: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CreatePurchaseOrderRequest
+     */
+    completionDate?: Date | null;
+    /**
+     * 
+     * @type {Array<CreatePurchaseOrderRequestLineItemsInner>}
+     * @memberof CreatePurchaseOrderRequest
+     */
+    lineItems?: Array<CreatePurchaseOrderRequestLineItemsInner>;
+}
+
+
+/**
+ * @export
+ */
+export const CreatePurchaseOrderRequestStatusEnum = {
+    Draft: 'draft',
+    Created: 'created',
+    Approved: 'approved',
+    Billed: 'billed'
+} as const;
+export type CreatePurchaseOrderRequestStatusEnum = typeof CreatePurchaseOrderRequestStatusEnum[keyof typeof CreatePurchaseOrderRequestStatusEnum];
+
+
+/**
+ * Check if a given object implements the CreatePurchaseOrderRequest interface.
+ */
+export function instanceOfCreatePurchaseOrderRequest(value: object): value is CreatePurchaseOrderRequest {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('businessUnitId' in value) || value['businessUnitId'] === undefined) return false;
+    if (!('jobId' in value) || value['jobId'] === undefined) return false;
+    return true;
+}
+
+export function CreatePurchaseOrderRequestFromJSON(json: any): CreatePurchaseOrderRequest {
+    return CreatePurchaseOrderRequestFromJSONTyped(json, false);
+}
+
+export function CreatePurchaseOrderRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePurchaseOrderRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'description': json['description'] == null ? undefined : json['description'],
+        'status': json['status'],
+        'businessUnitId': json['business_unit_id'],
+        'jobId': json['job_id'],
+        'serviceProviderId': json['service_provider_id'] == null ? undefined : json['service_provider_id'],
+        'includeGst': json['include_gst'] == null ? undefined : json['include_gst'],
+        'startDate': json['start_date'] == null ? undefined : (new Date(json['start_date'])),
+        'completionDate': json['completion_date'] == null ? undefined : (new Date(json['completion_date'])),
+        'lineItems': json['line_items'] == null ? undefined : ((json['line_items'] as Array<any>).map(CreatePurchaseOrderRequestLineItemsInnerFromJSON)),
+    };
+}
+
+export function CreatePurchaseOrderRequestToJSON(json: any): CreatePurchaseOrderRequest {
+    return CreatePurchaseOrderRequestToJSONTyped(json, false);
+}
+
+export function CreatePurchaseOrderRequestToJSONTyped(value?: CreatePurchaseOrderRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'description': value['description'],
+        'status': value['status'],
+        'business_unit_id': value['businessUnitId'],
+        'job_id': value['jobId'],
+        'service_provider_id': value['serviceProviderId'],
+        'include_gst': value['includeGst'],
+        'start_date': value['startDate'] === null ? null : ((value['startDate'] as any)?.toISOString()),
+        'completion_date': value['completionDate'] === null ? null : ((value['completionDate'] as any)?.toISOString()),
+        'line_items': value['lineItems'] == null ? undefined : ((value['lineItems'] as Array<any>).map(CreatePurchaseOrderRequestLineItemsInnerToJSON)),
+    };
+}
+