@managespace/sdk 0.1.50 → 0.1.52-melissa.dev

package/src/generated/models/customer-status.ts

@@ -0,0 +1,170 @@
+// @ts-nocheck
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * 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 { Customer } from './customer';
+import {
+    CustomerFromJSON,
+    CustomerFromJSONTyped,
+    CustomerToJSON,
+    CustomerToJSONTyped,
+} from './customer';
+import type { Org } from './org';
+import {
+    OrgFromJSON,
+    OrgFromJSONTyped,
+    OrgToJSON,
+    OrgToJSONTyped,
+} from './org';
+
+/**
+ * 
+ * @export
+ * @interface CustomerStatus
+ */
+export interface CustomerStatus {
+    /**
+     * Status ID
+     * @type {string}
+     * @memberof CustomerStatus
+     */
+    id: string;
+    /**
+     * User-defined status name
+     * @type {string}
+     * @memberof CustomerStatus
+     */
+    name: string;
+    /**
+     * Order in the status sequence
+     * @type {number}
+     * @memberof CustomerStatus
+     */
+    sequence: number;
+    /**
+     * Internal status categorisation
+     * @type {string}
+     * @memberof CustomerStatus
+     */
+    knownStatus: string | null;
+    /**
+     * Description of the status
+     * @type {string}
+     * @memberof CustomerStatus
+     */
+    description: string | null;
+    /**
+     * Colour for UI representation
+     * @type {string}
+     * @memberof CustomerStatus
+     */
+    colour: string | null;
+    /**
+     * 
+     * @type {Org}
+     * @memberof CustomerStatus
+     */
+    org?: Org;
+    /**
+     * 
+     * @type {string}
+     * @memberof CustomerStatus
+     */
+    orgId: string;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CustomerStatus
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CustomerStatus
+     */
+    updatedAt: Date | null;
+    /**
+     * 
+     * @type {Array<Customer>}
+     * @memberof CustomerStatus
+     */
+    customers?: Array<Customer>;
+}
+
+/**
+ * Check if a given object implements the CustomerStatus interface.
+ */
+export function instanceOfCustomerStatus(value: object): value is CustomerStatus {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('sequence' in value) || value['sequence'] === undefined) return false;
+    if (!('knownStatus' in value) || value['knownStatus'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('colour' in value) || value['colour'] === undefined) return false;
+    if (!('orgId' in value) || value['orgId'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function CustomerStatusFromJSON(json: any): CustomerStatus {
+    return CustomerStatusFromJSONTyped(json, false);
+}
+
+export function CustomerStatusFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomerStatus {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'sequence': json['sequence'],
+        'knownStatus': json['knownStatus'],
+        'description': json['description'],
+        'colour': json['colour'],
+        'org': json['org'] == null ? undefined : OrgFromJSON(json['org']),
+        'orgId': json['orgId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (json['updatedAt'] == null ? null : new Date(json['updatedAt'])),
+        'customers': json['customers'] == null ? undefined : ((json['customers'] as Array<any>).map(CustomerFromJSON)),
+    };
+}
+
+export function CustomerStatusToJSON(json: any): CustomerStatus {
+    return CustomerStatusToJSONTyped(json, false);
+}
+
+export function CustomerStatusToJSONTyped(value?: CustomerStatus | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'sequence': value['sequence'],
+        'knownStatus': value['knownStatus'],
+        'description': value['description'],
+        'colour': value['colour'],
+        'org': OrgToJSON(value['org']),
+        'orgId': value['orgId'],
+        'createdAt': ((value['createdAt']).toISOString()),
+        'updatedAt': (value['updatedAt'] == null ? null : (value['updatedAt'] as any).toISOString()),
+        'customers': value['customers'] == null ? undefined : ((value['customers'] as Array<any>).map(CustomerToJSON)),
+    };
+}
+

package/src/generated/models/customer.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /* tslint:disable */
 /* eslint-disable */
 /**
@@ -20,6 +21,13 @@ import {
     TaskInstanceToJSON,
     TaskInstanceToJSONTyped,
 } from './task-instance';
+import type { User } from './user';
+import {
+    UserFromJSON,
+    UserFromJSONTyped,
+    UserToJSON,
+    UserToJSONTyped,
+} from './user';
 import type { UploadedDocument } from './uploaded-document';
 import {
     UploadedDocumentFromJSON,
@@ -34,6 +42,20 @@ import {
     OrgToJSON,
     OrgToJSONTyped,
 } from './org';
+import type { AssetReservation } from './asset-reservation';
+import {
+    AssetReservationFromJSON,
+    AssetReservationFromJSONTyped,
+    AssetReservationToJSON,
+    AssetReservationToJSONTyped,
+} from './asset-reservation';
+import type { CustomerStatus } from './customer-status';
+import {
+    CustomerStatusFromJSON,
+    CustomerStatusFromJSONTyped,
+    CustomerStatusToJSON,
+    CustomerStatusToJSONTyped,
+} from './customer-status';
 import type { Note } from './note';
 import {
     NoteFromJSON,
@@ -41,6 +63,13 @@ import {
     NoteToJSON,
     NoteToJSONTyped,
 } from './note';
+import type { RateChange } from './rate-change';
+import {
+    RateChangeFromJSON,
+    RateChangeFromJSONTyped,
+    RateChangeToJSON,
+    RateChangeToJSONTyped,
+} from './rate-change';
 import type { Communication } from './communication';
 import {
     CommunicationFromJSON,
@@ -80,6 +109,30 @@ export interface Customer {
      * @memberof Customer
      */
     description: string | null;
+    /**
+     * Who created the customer
+     * @type {User}
+     * @memberof Customer
+     */
+    createdBy?: User;
+    /**
+     * 
+     * @type {string}
+     * @memberof Customer
+     */
+    createdById: string;
+    /**
+     * Who updated the customer
+     * @type {User}
+     * @memberof Customer
+     */
+    updatedBy?: User | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof Customer
+     */
+    updatedById: string | null;
     /**
      * When the record was created
      * @type {Date}
@@ -92,6 +145,12 @@ export interface Customer {
      * @memberof Customer
      */
     updatedAt: Date | null;
+    /**
+     * Site ID the customer was created on
+     * @type {string}
+     * @memberof Customer
+     */
+    creationSiteId: string | null;
     /**
      * 
      * @type {Org}
@@ -121,19 +180,13 @@ export interface Customer {
      * @type {string}
      * @memberof Customer
      */
-    externalId: string | null;
+    msExternalId: string | null;
     /**
      * A URL to a customers avatar
      * @type {string}
      * @memberof Customer
      */
     avatarUrl: string | null;
-    /**
-     * Balance
-     * @type {number}
-     * @memberof Customer
-     */
-    balance: number;
     /**
      * Any relevant metadata for the customer
      * @type {object}
@@ -158,6 +211,66 @@ export interface Customer {
      * @memberof Customer
      */
     assignedTasks?: Array<TaskInstance>;
+    /**
+     * 
+     * @type {CustomerStatus}
+     * @memberof Customer
+     */
+    customerStatus?: CustomerStatus;
+    /**
+     * Customer status ID
+     * @type {string}
+     * @memberof Customer
+     */
+    customerStatusId: string;
+    /**
+     * Customer source
+     * @type {string}
+     * @memberof Customer
+     */
+    customerSource: string | null;
+    /**
+     * Whether the customer is set to have a follow-up
+     * @type {boolean}
+     * @memberof Customer
+     */
+    followUp: boolean;
+    /**
+     * Whether the customer is a company or an individual
+     * @type {boolean}
+     * @memberof Customer
+     */
+    commercial: boolean;
+    /**
+     * Whether the customer has auto-pay enabled
+     * @type {boolean}
+     * @memberof Customer
+     */
+    autoPay: boolean;
+    /**
+     * Whether ACH/bank transfer payments are enabled
+     * @type {boolean}
+     * @memberof Customer
+     */
+    achEnabled: boolean;
+    /**
+     * Whether credit card payments are enabled
+     * @type {boolean}
+     * @memberof Customer
+     */
+    creditEnabled: boolean;
+    /**
+     * 
+     * @type {Array<RateChange>}
+     * @memberof Customer
+     */
+    rateChanges?: Array<RateChange>;
+    /**
+     * 
+     * @type {Array<AssetReservation>}
+     * @memberof Customer
+     */
+    assetReservations?: Array<AssetReservation>;
 }
 
 /**
@@ -167,13 +280,22 @@ export function instanceOfCustomer(value: object): value is Customer {
     if (!('id' in value) || value['id'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('createdById' in value) || value['createdById'] === undefined) return false;
+    if (!('updatedById' in value) || value['updatedById'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('creationSiteId' in value) || value['creationSiteId'] === undefined) return false;
     if (!('orgId' in value) || value['orgId'] === undefined) return false;
-    if (!('externalId' in value) || value['externalId'] === undefined) return false;
+    if (!('msExternalId' in value) || value['msExternalId'] === undefined) return false;
     if (!('avatarUrl' in value) || value['avatarUrl'] === undefined) return false;
-    if (!('balance' in value) || value['balance'] === undefined) return false;
     if (!('metadata' in value) || value['metadata'] === undefined) return false;
+    if (!('customerStatusId' in value) || value['customerStatusId'] === undefined) return false;
+    if (!('customerSource' in value) || value['customerSource'] === undefined) return false;
+    if (!('followUp' in value) || value['followUp'] === undefined) return false;
+    if (!('commercial' in value) || value['commercial'] === undefined) return false;
+    if (!('autoPay' in value) || value['autoPay'] === undefined) return false;
+    if (!('achEnabled' in value) || value['achEnabled'] === undefined) return false;
+    if (!('creditEnabled' in value) || value['creditEnabled'] === undefined) return false;
     return true;
 }
 
@@ -190,19 +312,33 @@ export function CustomerFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'id': json['id'],
         'name': json['name'],
         'description': json['description'],
+        'createdBy': json['createdBy'] == null ? undefined : UserFromJSON(json['createdBy']),
+        'createdById': json['createdById'],
+        'updatedBy': json['updatedBy'] == null ? undefined : UserFromJSON(json['updatedBy']),
+        'updatedById': json['updatedById'],
         'createdAt': (new Date(json['createdAt'])),
         'updatedAt': (json['updatedAt'] == null ? null : new Date(json['updatedAt'])),
+        'creationSiteId': json['creationSiteId'],
         'org': json['org'] == null ? undefined : OrgFromJSON(json['org']),
         'orgId': json['orgId'],
         'contacts': json['contacts'] == null ? undefined : ((json['contacts'] as Array<any>).map(ContactFromJSON)),
         'note': json['note'] == null ? undefined : ((json['note'] as Array<any>).map(NoteFromJSON)),
-        'externalId': json['externalId'],
+        'msExternalId': json['msExternalId'],
         'avatarUrl': json['avatarUrl'],
-        'balance': json['balance'],
         'metadata': json['metadata'],
         'communications': json['communications'] == null ? undefined : ((json['communications'] as Array<any>).map(CommunicationFromJSON)),
         'documents': json['documents'] == null ? undefined : ((json['documents'] as Array<any>).map(UploadedDocumentFromJSON)),
         'assignedTasks': json['assignedTasks'] == null ? undefined : ((json['assignedTasks'] as Array<any>).map(TaskInstanceFromJSON)),
+        'customerStatus': json['customerStatus'] == null ? undefined : CustomerStatusFromJSON(json['customerStatus']),
+        'customerStatusId': json['customerStatusId'],
+        'customerSource': json['customerSource'],
+        'followUp': json['followUp'],
+        'commercial': json['commercial'],
+        'autoPay': json['autoPay'],
+        'achEnabled': json['achEnabled'],
+        'creditEnabled': json['creditEnabled'],
+        'rateChanges': json['rateChanges'] == null ? undefined : ((json['rateChanges'] as Array<any>).map(RateChangeFromJSON)),
+        'assetReservations': json['assetReservations'] == null ? undefined : ((json['assetReservations'] as Array<any>).map(AssetReservationFromJSON)),
     };
 }
 
@@ -220,19 +356,33 @@ export function CustomerToJSONTyped(value?: Customer | null, ignoreDiscriminator
         'id': value['id'],
         'name': value['name'],
         'description': value['description'],
+        'createdBy': UserToJSON(value['createdBy']),
+        'createdById': value['createdById'],
+        'updatedBy': UserToJSON(value['updatedBy']),
+        'updatedById': value['updatedById'],
         'createdAt': ((value['createdAt']).toISOString()),
         'updatedAt': (value['updatedAt'] == null ? null : (value['updatedAt'] as any).toISOString()),
+        'creationSiteId': value['creationSiteId'],
         'org': OrgToJSON(value['org']),
         'orgId': value['orgId'],
         'contacts': value['contacts'] == null ? undefined : ((value['contacts'] as Array<any>).map(ContactToJSON)),
         'note': value['note'] == null ? undefined : ((value['note'] as Array<any>).map(NoteToJSON)),
-        'externalId': value['externalId'],
+        'msExternalId': value['msExternalId'],
         'avatarUrl': value['avatarUrl'],
-        'balance': value['balance'],
         'metadata': value['metadata'],
         'communications': value['communications'] == null ? undefined : ((value['communications'] as Array<any>).map(CommunicationToJSON)),
         'documents': value['documents'] == null ? undefined : ((value['documents'] as Array<any>).map(UploadedDocumentToJSON)),
         'assignedTasks': value['assignedTasks'] == null ? undefined : ((value['assignedTasks'] as Array<any>).map(TaskInstanceToJSON)),
+        'customerStatus': CustomerStatusToJSON(value['customerStatus']),
+        'customerStatusId': value['customerStatusId'],
+        'customerSource': value['customerSource'],
+        'followUp': value['followUp'],
+        'commercial': value['commercial'],
+        'autoPay': value['autoPay'],
+        'achEnabled': value['achEnabled'],
+        'creditEnabled': value['creditEnabled'],
+        'rateChanges': value['rateChanges'] == null ? undefined : ((value['rateChanges'] as Array<any>).map(RateChangeToJSON)),
+        'assetReservations': value['assetReservations'] == null ? undefined : ((value['assetReservations'] as Array<any>).map(AssetReservationToJSON)),
     };
 }
 

package/src/generated/models/daily-deposits-report-filters.ts

@@ -0,0 +1,84 @@
+// @ts-nocheck
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * 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 DailyDepositsReportFilters
+ */
+export interface DailyDepositsReportFilters {
+    /**
+     * Site ID to filter the report
+     * @type {string}
+     * @memberof DailyDepositsReportFilters
+     */
+    siteId?: string;
+    /**
+     * Start date for the report
+     * @type {Date}
+     * @memberof DailyDepositsReportFilters
+     */
+    startDate: Date;
+    /**
+     * End date for the report
+     * @type {Date}
+     * @memberof DailyDepositsReportFilters
+     */
+    endDate: Date;
+}
+
+/**
+ * Check if a given object implements the DailyDepositsReportFilters interface.
+ */
+export function instanceOfDailyDepositsReportFilters(value: object): value is DailyDepositsReportFilters {
+    if (!('startDate' in value) || value['startDate'] === undefined) return false;
+    if (!('endDate' in value) || value['endDate'] === undefined) return false;
+    return true;
+}
+
+export function DailyDepositsReportFiltersFromJSON(json: any): DailyDepositsReportFilters {
+    return DailyDepositsReportFiltersFromJSONTyped(json, false);
+}
+
+export function DailyDepositsReportFiltersFromJSONTyped(json: any, ignoreDiscriminator: boolean): DailyDepositsReportFilters {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'siteId': json['siteId'] == null ? undefined : json['siteId'],
+        'startDate': (new Date(json['startDate'])),
+        'endDate': (new Date(json['endDate'])),
+    };
+}
+
+export function DailyDepositsReportFiltersToJSON(json: any): DailyDepositsReportFilters {
+    return DailyDepositsReportFiltersToJSONTyped(json, false);
+}
+
+export function DailyDepositsReportFiltersToJSONTyped(value?: DailyDepositsReportFilters | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'siteId': value['siteId'],
+        'startDate': ((value['startDate']).toISOString().substring(0,10)),
+        'endDate': ((value['endDate']).toISOString().substring(0,10)),
+    };
+}
+

package/src/generated/models/document-complete.ts

@@ -1,3 +1,4 @@
+// @ts-nocheck
 /* tslint:disable */
 /* eslint-disable */
 /**
@@ -49,12 +50,36 @@ export interface DocumentComplete {
      * @memberof DocumentComplete
      */
     userId?: string;
+    /**
+     * Email address of the signer.
+     * @type {string}
+     * @memberof DocumentComplete
+     */
+    signerEmail?: string;
+    /**
+     * Name of the signer.
+     * @type {string}
+     * @memberof DocumentComplete
+     */
+    signerName?: string;
+    /**
+     * Role of the signer (e.g. operator, tenant).
+     * @type {string}
+     * @memberof DocumentComplete
+     */
+    signerRole?: string;
     /**
      * Whether all signatures have been gathered or not.
      * @type {boolean}
      * @memberof DocumentComplete
      */
     allSignaturesGathered: boolean;
+    /**
+     * Arbitrary metadata to store with the document.
+     * @type {object}
+     * @memberof DocumentComplete
+     */
+    metadata?: object;
     /**
      * Downloadable URL of the document.
      * @type {string}
@@ -87,7 +112,11 @@ export function DocumentCompleteFromJSONTyped(json: any, ignoreDiscriminator: bo
         'customerId': json['customerId'] == null ? undefined : json['customerId'],
         'contactId': json['contactId'] == null ? undefined : json['contactId'],
         'userId': json['userId'] == null ? undefined : json['userId'],
+        'signerEmail': json['signerEmail'] == null ? undefined : json['signerEmail'],
+        'signerName': json['signerName'] == null ? undefined : json['signerName'],
+        'signerRole': json['signerRole'] == null ? undefined : json['signerRole'],
         'allSignaturesGathered': json['allSignaturesGathered'],
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
         'fileUrl': json['fileUrl'],
     };
 }
@@ -108,7 +137,11 @@ export function DocumentCompleteToJSONTyped(value?: DocumentComplete | null, ign
         'customerId': value['customerId'],
         'contactId': value['contactId'],
         'userId': value['userId'],
+        'signerEmail': value['signerEmail'],
+        'signerName': value['signerName'],
+        'signerRole': value['signerRole'],
         'allSignaturesGathered': value['allSignaturesGathered'],
+        'metadata': value['metadata'],
         'fileUrl': value['fileUrl'],
     };
 }

package/src/generated/models/document-created.ts

@@ -0,0 +1,101 @@
+// @ts-nocheck
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * ManageSpace API
+ * ManageSpace API Documentation
+ *
+ * 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 { EmbedConfig } from './embed-config';
+import {
+    EmbedConfigFromJSON,
+    EmbedConfigFromJSONTyped,
+    EmbedConfigToJSON,
+    EmbedConfigToJSONTyped,
+} from './embed-config';
+
+/**
+ * 
+ * @export
+ * @interface DocumentCreated
+ */
+export interface DocumentCreated {
+    /**
+     * The success status of the operation.
+     * @type {boolean}
+     * @memberof DocumentCreated
+     */
+    success: boolean;
+    /**
+     * Provider-agnostic embed configuration for rendering the signing UI.
+     * @type {EmbedConfig}
+     * @memberof DocumentCreated
+     */
+    embedConfig?: EmbedConfig;
+    /**
+     * Per-signer embed configurations keyed by role (e.g. operator, tenant).
+     * @type {{ [key: string]: EmbedConfig; }}
+     * @memberof DocumentCreated
+     */
+    signerEmbedConfigs: { [key: string]: EmbedConfig; };
+    /**
+     * External document identifier from the signing provider.
+     * @type {string}
+     * @memberof DocumentCreated
+     */
+    documentId: string;
+}
+
+/**
+ * Check if a given object implements the DocumentCreated interface.
+ */
+export function instanceOfDocumentCreated(value: object): value is DocumentCreated {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('signerEmbedConfigs' in value) || value['signerEmbedConfigs'] === undefined) return false;
+    if (!('documentId' in value) || value['documentId'] === undefined) return false;
+    return true;
+}
+
+export function DocumentCreatedFromJSON(json: any): DocumentCreated {
+    return DocumentCreatedFromJSONTyped(json, false);
+}
+
+export function DocumentCreatedFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentCreated {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'embedConfig': json['embedConfig'] == null ? undefined : EmbedConfigFromJSON(json['embedConfig']),
+        'signerEmbedConfigs': (mapValues(json['signerEmbedConfigs'], EmbedConfigFromJSON)),
+        'documentId': json['documentId'],
+    };
+}
+
+export function DocumentCreatedToJSON(json: any): DocumentCreated {
+    return DocumentCreatedToJSONTyped(json, false);
+}
+
+export function DocumentCreatedToJSONTyped(value?: DocumentCreated | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'embedConfig': EmbedConfigToJSON(value['embedConfig']),
+        'signerEmbedConfigs': (mapValues(value['signerEmbedConfigs'], EmbedConfigToJSON)),
+        'documentId': value['documentId'],
+    };
+}
+