@managespace/sdk 0.1.10 → 0.1.11-5.paul.dev

package/src/generated/models/credit.ts

@@ -0,0 +1,205 @@
+/* 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 { CreateCreditInvoice } from './create-credit-invoice';
+import {
+    CreateCreditInvoiceFromJSON,
+    CreateCreditInvoiceFromJSONTyped,
+    CreateCreditInvoiceToJSON,
+    CreateCreditInvoiceToJSONTyped,
+} from './create-credit-invoice';
+
+/**
+ * 
+ * @export
+ * @interface Credit
+ */
+export interface Credit {
+    /**
+     * Customer ID
+     * @type {string}
+     * @memberof Credit
+     */
+    customerId: string;
+    /**
+     * Date of the credit
+     * @type {string}
+     * @memberof Credit
+     */
+    creditDate: string;
+    /**
+     * Amount of credit
+     * @type {string}
+     * @memberof Credit
+     */
+    creditAmount: string;
+    /**
+     * Notes about the credit
+     * @type {string}
+     * @memberof Credit
+     */
+    notes?: string;
+    /**
+     * Amount applied to invoices
+     * @type {string}
+     * @memberof Credit
+     */
+    appliedAmount?: string;
+    /**
+     * Unapplied credit amount
+     * @type {string}
+     * @memberof Credit
+     */
+    unappliedAmount?: string;
+    /**
+     * Currency code
+     * @type {string}
+     * @memberof Credit
+     */
+    currency?: string;
+    /**
+     * Automatically apply credit to most recent invoice
+     * @type {boolean}
+     * @memberof Credit
+     */
+    autoApply?: boolean;
+    /**
+     * Subscription ID (custom field)
+     * @type {string}
+     * @memberof Credit
+     */
+    subscriptionId?: string;
+    /**
+     * List of invoices to apply credit to
+     * @type {Array<CreateCreditInvoice>}
+     * @memberof Credit
+     */
+    invoices?: Array<CreateCreditInvoice>;
+    /**
+     * Credit ID
+     * @type {string}
+     * @memberof Credit
+     */
+    id: string;
+    /**
+     * Status of the credit
+     * @type {string}
+     * @memberof Credit
+     */
+    status?: string;
+    /**
+     * Reference number for the credit
+     * @type {string}
+     * @memberof Credit
+     */
+    referenceNumber?: string;
+    /**
+     * User who created the credit
+     * @type {string}
+     * @memberof Credit
+     */
+    createdBy?: string;
+    /**
+     * User who last updated the credit
+     * @type {string}
+     * @memberof Credit
+     */
+    updatedBy?: string;
+    /**
+     * Date the credit was created
+     * @type {string}
+     * @memberof Credit
+     */
+    createdDate?: string;
+    /**
+     * Date the credit was last updated
+     * @type {string}
+     * @memberof Credit
+     */
+    updatedDate?: string;
+}
+
+/**
+ * Check if a given object implements the Credit interface.
+ */
+export function instanceOfCredit(value: object): value is Credit {
+    if (!('customerId' in value) || value['customerId'] === undefined) return false;
+    if (!('creditDate' in value) || value['creditDate'] === undefined) return false;
+    if (!('creditAmount' in value) || value['creditAmount'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    return true;
+}
+
+export function CreditFromJSON(json: any): Credit {
+    return CreditFromJSONTyped(json, false);
+}
+
+export function CreditFromJSONTyped(json: any, ignoreDiscriminator: boolean): Credit {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'customerId': json['customerId'],
+        'creditDate': json['creditDate'],
+        'creditAmount': json['creditAmount'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+        'appliedAmount': json['appliedAmount'] == null ? undefined : json['appliedAmount'],
+        'unappliedAmount': json['unappliedAmount'] == null ? undefined : json['unappliedAmount'],
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        'autoApply': json['autoApply'] == null ? undefined : json['autoApply'],
+        'subscriptionId': json['subscriptionId'] == null ? undefined : json['subscriptionId'],
+        'invoices': json['invoices'] == null ? undefined : ((json['invoices'] as Array<any>).map(CreateCreditInvoiceFromJSON)),
+        'id': json['id'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'referenceNumber': json['referenceNumber'] == null ? undefined : json['referenceNumber'],
+        'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
+        'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
+        'createdDate': json['createdDate'] == null ? undefined : json['createdDate'],
+        'updatedDate': json['updatedDate'] == null ? undefined : json['updatedDate'],
+    };
+}
+
+export function CreditToJSON(json: any): Credit {
+    return CreditToJSONTyped(json, false);
+}
+
+export function CreditToJSONTyped(value?: Credit | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'customerId': value['customerId'],
+        'creditDate': value['creditDate'],
+        'creditAmount': value['creditAmount'],
+        'notes': value['notes'],
+        'appliedAmount': value['appliedAmount'],
+        'unappliedAmount': value['unappliedAmount'],
+        'currency': value['currency'],
+        'autoApply': value['autoApply'],
+        'subscriptionId': value['subscriptionId'],
+        'invoices': value['invoices'] == null ? undefined : ((value['invoices'] as Array<any>).map(CreateCreditInvoiceToJSON)),
+        'id': value['id'],
+        'status': value['status'],
+        'referenceNumber': value['referenceNumber'],
+        'createdBy': value['createdBy'],
+        'updatedBy': value['updatedBy'],
+        'createdDate': value['createdDate'],
+        'updatedDate': value['updatedDate'],
+    };
+}
+

package/src/generated/models/{create-checklist.ts → custom-create-checklist.ts}

@@ -20,101 +20,107 @@ import {
     ChecklistRecurrenceFrequencyToJSON,
     ChecklistRecurrenceFrequencyToJSONTyped,
 } from './checklist-recurrence-frequency';
+import type { CreateTaskDefinition } from './create-task-definition';
+import {
+    CreateTaskDefinitionFromJSON,
+    CreateTaskDefinitionFromJSONTyped,
+    CreateTaskDefinitionToJSON,
+    CreateTaskDefinitionToJSONTyped,
+} from './create-task-definition';
 
 /**
  * 
  * @export
- * @interface CreateChecklist
+ * @interface CustomCreateChecklist
  */
-export interface CreateChecklist {
+export interface CustomCreateChecklist {
     /**
      * Name of checklist
      * @type {string}
-     * @memberof CreateChecklist
+     * @memberof CustomCreateChecklist
      */
     name: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof CreateChecklist
-     */
-    assignedToUserId: string;
     /**
      * 
      * @type {ChecklistRecurrenceFrequency}
-     * @memberof CreateChecklist
+     * @memberof CustomCreateChecklist
      */
     recurrence: ChecklistRecurrenceFrequency;
     /**
      * Interval of frequency (1st of the month)
      * @type {number}
-     * @memberof CreateChecklist
+     * @memberof CustomCreateChecklist
      */
     interval: number;
     /**
      * Which day to repeat checklist
      * @type {string}
-     * @memberof CreateChecklist
+     * @memberof CustomCreateChecklist
      */
     byDay?: string | null;
     /**
-     * Which month to repeat checklsit
+     * Which month to repeat checklist
      * @type {number}
-     * @memberof CreateChecklist
+     * @memberof CustomCreateChecklist
      */
     byMonth?: number | null;
     /**
      * Which day of the month to repeat checklist
      * @type {number}
-     * @memberof CreateChecklist
+     * @memberof CustomCreateChecklist
      */
     byMonthDay?: number | null;
     /**
      * What day the checklist started
      * @type {Date}
-     * @memberof CreateChecklist
+     * @memberof CustomCreateChecklist
      */
     startDate: Date;
     /**
-     * When to
+     * When to repeat the checklist
      * @type {Date}
-     * @memberof CreateChecklist
+     * @memberof CustomCreateChecklist
      */
     executeBy?: Date | null;
     /**
-     * 
+     * Task Definitions
+     * @type {Array<CreateTaskDefinition>}
+     * @memberof CustomCreateChecklist
+     */
+    taskDefinitions: Array<CreateTaskDefinition>;
+    /**
+     * User ID to assign entire checklist to
      * @type {string}
-     * @memberof CreateChecklist
+     * @memberof CustomCreateChecklist
      */
-    taskTemplateId?: string | null;
+    assignToUserId?: string;
 }
 
 
 
 /**
- * Check if a given object implements the CreateChecklist interface.
+ * Check if a given object implements the CustomCreateChecklist interface.
  */
-export function instanceOfCreateChecklist(value: object): value is CreateChecklist {
+export function instanceOfCustomCreateChecklist(value: object): value is CustomCreateChecklist {
     if (!('name' in value) || value['name'] === undefined) return false;
-    if (!('assignedToUserId' in value) || value['assignedToUserId'] === undefined) return false;
     if (!('recurrence' in value) || value['recurrence'] === undefined) return false;
     if (!('interval' in value) || value['interval'] === undefined) return false;
     if (!('startDate' in value) || value['startDate'] === undefined) return false;
+    if (!('taskDefinitions' in value) || value['taskDefinitions'] === undefined) return false;
     return true;
 }
 
-export function CreateChecklistFromJSON(json: any): CreateChecklist {
-    return CreateChecklistFromJSONTyped(json, false);
+export function CustomCreateChecklistFromJSON(json: any): CustomCreateChecklist {
+    return CustomCreateChecklistFromJSONTyped(json, false);
 }
 
-export function CreateChecklistFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateChecklist {
+export function CustomCreateChecklistFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomCreateChecklist {
     if (json == null) {
         return json;
     }
     return {
         
         'name': json['name'],
-        'assignedToUserId': json['assignedToUserId'],
         'recurrence': ChecklistRecurrenceFrequencyFromJSON(json['recurrence']),
         'interval': json['interval'],
         'byDay': json['byDay'] == null ? undefined : json['byDay'],
@@ -122,15 +128,16 @@ export function CreateChecklistFromJSONTyped(json: any, ignoreDiscriminator: boo
         'byMonthDay': json['byMonthDay'] == null ? undefined : json['byMonthDay'],
         'startDate': (new Date(json['startDate'])),
         'executeBy': json['executeBy'] == null ? undefined : (new Date(json['executeBy'])),
-        'taskTemplateId': json['taskTemplateId'] == null ? undefined : json['taskTemplateId'],
+        'taskDefinitions': ((json['taskDefinitions'] as Array<any>).map(CreateTaskDefinitionFromJSON)),
+        'assignToUserId': json['assignToUserId'] == null ? undefined : json['assignToUserId'],
     };
 }
 
-export function CreateChecklistToJSON(json: any): CreateChecklist {
-    return CreateChecklistToJSONTyped(json, false);
+export function CustomCreateChecklistToJSON(json: any): CustomCreateChecklist {
+    return CustomCreateChecklistToJSONTyped(json, false);
 }
 
-export function CreateChecklistToJSONTyped(value?: CreateChecklist | null, ignoreDiscriminator: boolean = false): any {
+export function CustomCreateChecklistToJSONTyped(value?: CustomCreateChecklist | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
@@ -138,7 +145,6 @@ export function CreateChecklistToJSONTyped(value?: CreateChecklist | null, ignor
     return {
         
         'name': value['name'],
-        'assignedToUserId': value['assignedToUserId'],
         'recurrence': ChecklistRecurrenceFrequencyToJSON(value['recurrence']),
         'interval': value['interval'],
         'byDay': value['byDay'],
@@ -146,7 +152,8 @@ export function CreateChecklistToJSONTyped(value?: CreateChecklist | null, ignor
         'byMonthDay': value['byMonthDay'],
         'startDate': ((value['startDate']).toISOString()),
         'executeBy': value['executeBy'] == null ? undefined : ((value['executeBy'] as any).toISOString()),
-        'taskTemplateId': value['taskTemplateId'],
+        'taskDefinitions': ((value['taskDefinitions'] as Array<any>).map(CreateTaskDefinitionToJSON)),
+        'assignToUserId': value['assignToUserId'],
     };
 }
 

package/src/generated/models/custom-create-customer.ts

@@ -40,23 +40,47 @@ export interface CustomCreateCustomer {
      */
     description?: string | null;
     /**
-     * A URL to a customers avatar
+     * Site ID the customer was created on
      * @type {string}
      * @memberof CustomCreateCustomer
      */
-    avatarUrl?: string | null;
+    creationSiteId?: string | null;
     /**
-     * Balance
-     * @type {number}
+     * A URL to a customers avatar
+     * @type {string}
      * @memberof CustomCreateCustomer
      */
-    balance?: number;
+    avatarUrl?: string | null;
     /**
      * Any relevant metadata for the customer
      * @type {object}
      * @memberof CustomCreateCustomer
      */
     metadata: object;
+    /**
+     * Customer status ID
+     * @type {string}
+     * @memberof CustomCreateCustomer
+     */
+    customerStatusId: string;
+    /**
+     * Customer source
+     * @type {string}
+     * @memberof CustomCreateCustomer
+     */
+    customerSource?: string | null;
+    /**
+     * Whether the customer is set to have a follow-up
+     * @type {boolean}
+     * @memberof CustomCreateCustomer
+     */
+    followUp?: boolean;
+    /**
+     * Whether the customer is a company or an individual
+     * @type {boolean}
+     * @memberof CustomCreateCustomer
+     */
+    commercial?: boolean;
     /**
      * Contact information.
      * @type {Array<CustomCreateContact>}
@@ -149,6 +173,7 @@ export interface CustomCreateCustomer {
 export function instanceOfCustomCreateCustomer(value: object): value is CustomCreateCustomer {
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('metadata' in value) || value['metadata'] === undefined) return false;
+    if (!('customerStatusId' in value) || value['customerStatusId'] === undefined) return false;
     if (!('contacts' in value) || value['contacts'] === undefined) return false;
     return true;
 }
@@ -165,9 +190,13 @@ export function CustomCreateCustomerFromJSONTyped(json: any, ignoreDiscriminator
         
         'name': json['name'],
         'description': json['description'] == null ? undefined : json['description'],
+        'creationSiteId': json['creationSiteId'] == null ? undefined : json['creationSiteId'],
         'avatarUrl': json['avatarUrl'] == null ? undefined : json['avatarUrl'],
-        'balance': json['balance'] == null ? undefined : json['balance'],
         'metadata': json['metadata'],
+        'customerStatusId': json['customerStatusId'],
+        'customerSource': json['customerSource'] == null ? undefined : json['customerSource'],
+        'followUp': json['followUp'] == null ? undefined : json['followUp'],
+        'commercial': json['commercial'] == null ? undefined : json['commercial'],
         'contacts': ((json['contacts'] as Array<any>).map(CustomCreateContactFromJSON)),
         'autoPay': json['autoPay'] == null ? undefined : json['autoPay'],
         'billingCycleDay': json['billingCycleDay'] == null ? undefined : json['billingCycleDay'],
@@ -198,9 +227,13 @@ export function CustomCreateCustomerToJSONTyped(value?: CustomCreateCustomer | n
         
         'name': value['name'],
         'description': value['description'],
+        'creationSiteId': value['creationSiteId'],
         'avatarUrl': value['avatarUrl'],
-        'balance': value['balance'],
         'metadata': value['metadata'],
+        'customerStatusId': value['customerStatusId'],
+        'customerSource': value['customerSource'],
+        'followUp': value['followUp'],
+        'commercial': value['commercial'],
         'contacts': ((value['contacts'] as Array<any>).map(CustomCreateContactToJSON)),
         'autoPay': value['autoPay'],
         'billingCycleDay': value['billingCycleDay'],

package/src/generated/models/custom-create-user.ts

@@ -75,6 +75,12 @@ export interface CustomCreateUser {
      * @memberof CustomCreateUser
      */
     sites?: Array<string>;
+    /**
+     * The ID of the site the user is currently active on.
+     * @type {string}
+     * @memberof CustomCreateUser
+     */
+    activeSiteId?: string;
 }
 
 /**
@@ -107,6 +113,7 @@ export function CustomCreateUserFromJSONTyped(json: any, ignoreDiscriminator: bo
         'mobileNumber': json['mobileNumber'] == null ? undefined : json['mobileNumber'],
         'roles': ((json['roles'] as Array<any>).map(RolesFromJSON)),
         'sites': json['sites'] == null ? undefined : json['sites'],
+        'activeSiteId': json['activeSiteId'] == null ? undefined : json['activeSiteId'],
     };
 }
 
@@ -129,6 +136,7 @@ export function CustomCreateUserToJSONTyped(value?: CustomCreateUser | null, ign
         'mobileNumber': value['mobileNumber'],
         'roles': ((value['roles'] as Array<any>).map(RolesToJSON)),
         'sites': value['sites'],
+        'activeSiteId': value['activeSiteId'],
     };
 }
 

package/src/generated/models/custom-update-contact.ts

@@ -0,0 +1,129 @@
+/* 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 { UpdateAddress } from './update-address';
+import {
+    UpdateAddressFromJSON,
+    UpdateAddressFromJSONTyped,
+    UpdateAddressToJSON,
+    UpdateAddressToJSONTyped,
+} from './update-address';
+
+/**
+ * 
+ * @export
+ * @interface CustomUpdateContact
+ */
+export interface CustomUpdateContact {
+    /**
+     * First name
+     * @type {string}
+     * @memberof CustomUpdateContact
+     */
+    firstName?: string;
+    /**
+     * Initial of middle name
+     * @type {string}
+     * @memberof CustomUpdateContact
+     */
+    middleInitial?: string | null;
+    /**
+     * Last name
+     * @type {string}
+     * @memberof CustomUpdateContact
+     */
+    lastName?: string;
+    /**
+     * Display name
+     * @type {string}
+     * @memberof CustomUpdateContact
+     */
+    displayName?: string;
+    /**
+     * Contact email address
+     * @type {string}
+     * @memberof CustomUpdateContact
+     */
+    email?: string;
+    /**
+     * Phone number
+     * @type {string}
+     * @memberof CustomUpdateContact
+     */
+    phoneNumber?: string | null;
+    /**
+     * Contact mobile number
+     * @type {string}
+     * @memberof CustomUpdateContact
+     */
+    mobileNumber?: string;
+    /**
+     * Contact address.
+     * @type {UpdateAddress}
+     * @memberof CustomUpdateContact
+     */
+    address?: UpdateAddress;
+}
+
+/**
+ * Check if a given object implements the CustomUpdateContact interface.
+ */
+export function instanceOfCustomUpdateContact(value: object): value is CustomUpdateContact {
+    return true;
+}
+
+export function CustomUpdateContactFromJSON(json: any): CustomUpdateContact {
+    return CustomUpdateContactFromJSONTyped(json, false);
+}
+
+export function CustomUpdateContactFromJSONTyped(json: any, ignoreDiscriminator: boolean): CustomUpdateContact {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'firstName': json['firstName'] == null ? undefined : json['firstName'],
+        'middleInitial': json['middleInitial'] == null ? undefined : json['middleInitial'],
+        'lastName': json['lastName'] == null ? undefined : json['lastName'],
+        'displayName': json['displayName'] == null ? undefined : json['displayName'],
+        'email': json['email'] == null ? undefined : json['email'],
+        'phoneNumber': json['phoneNumber'] == null ? undefined : json['phoneNumber'],
+        'mobileNumber': json['mobileNumber'] == null ? undefined : json['mobileNumber'],
+        'address': json['address'] == null ? undefined : UpdateAddressFromJSON(json['address']),
+    };
+}
+
+export function CustomUpdateContactToJSON(json: any): CustomUpdateContact {
+    return CustomUpdateContactToJSONTyped(json, false);
+}
+
+export function CustomUpdateContactToJSONTyped(value?: CustomUpdateContact | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'firstName': value['firstName'],
+        'middleInitial': value['middleInitial'],
+        'lastName': value['lastName'],
+        'displayName': value['displayName'],
+        'email': value['email'],
+        'phoneNumber': value['phoneNumber'],
+        'mobileNumber': value['mobileNumber'],
+        'address': UpdateAddressToJSON(value['address']),
+    };
+}
+