@managespace/sdk 0.1.113 → 0.1.115

package/src/generated/models/billing-schedule.ts

@@ -0,0 +1,252 @@
+/* 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 { KeyMetrics } from './key-metrics';
+import {
+    KeyMetricsFromJSON,
+    KeyMetricsFromJSONTyped,
+    KeyMetricsToJSON,
+    KeyMetricsToJSONTyped,
+} from './key-metrics';
+import type { ScheduleLine } from './schedule-line';
+import {
+    ScheduleLineFromJSON,
+    ScheduleLineFromJSONTyped,
+    ScheduleLineToJSON,
+    ScheduleLineToJSONTyped,
+} from './schedule-line';
+
+/**
+ * 
+ * @export
+ * @interface BillingSchedule
+ */
+export interface BillingSchedule {
+    /**
+     * Billing Schedule ID
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    id: string;
+    /**
+     * Billing Schedule UUID
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    uuid: string;
+    /**
+     * Customer ID
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    customerId: string;
+    /**
+     * Customer Name
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    customerName: string;
+    /**
+     * Subscription ID
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    subscriptionId: string;
+    /**
+     * Product ID
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    productId: string;
+    /**
+     * Product Name
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    productName: string;
+    /**
+     * Charge ID
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    chargeId: string;
+    /**
+     * Charge Name
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    chargeName: string;
+    /**
+     * Charge Type
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    chargeType: string;
+    /**
+     * Charge Timing
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    chargeTiming: string;
+    /**
+     * The first billing date for this charge
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    startDate: string;
+    /**
+     * The last billing date for this charge
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    endDate: string;
+    /**
+     * Key metrics for the billing schedule
+     * @type {KeyMetrics}
+     * @memberof BillingSchedule
+     */
+    keyMetrics: KeyMetrics;
+    /**
+     * The currency for the billing schedule
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    currency: string;
+    /**
+     * When the billing schedule was created
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    createdAt: string;
+    /**
+     * When the billing schedule was last updated
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    updatedAt: string;
+    /**
+     * The email of the user who created the billing schedule
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    createdBy: string;
+    /**
+     * The email of the user who last updated the billing schedule
+     * @type {string}
+     * @memberof BillingSchedule
+     */
+    updatedBy: string;
+    /**
+     * The schedule lines for the billing schedule
+     * @type {Array<ScheduleLine>}
+     * @memberof BillingSchedule
+     */
+    scheduleLines: Array<ScheduleLine>;
+}
+
+/**
+ * Check if a given object implements the BillingSchedule interface.
+ */
+export function instanceOfBillingSchedule(value: object): value is BillingSchedule {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('uuid' in value) || value['uuid'] === undefined) return false;
+    if (!('customerId' in value) || value['customerId'] === undefined) return false;
+    if (!('customerName' in value) || value['customerName'] === undefined) return false;
+    if (!('subscriptionId' in value) || value['subscriptionId'] === undefined) return false;
+    if (!('productId' in value) || value['productId'] === undefined) return false;
+    if (!('productName' in value) || value['productName'] === undefined) return false;
+    if (!('chargeId' in value) || value['chargeId'] === undefined) return false;
+    if (!('chargeName' in value) || value['chargeName'] === undefined) return false;
+    if (!('chargeType' in value) || value['chargeType'] === undefined) return false;
+    if (!('chargeTiming' in value) || value['chargeTiming'] === undefined) return false;
+    if (!('startDate' in value) || value['startDate'] === undefined) return false;
+    if (!('endDate' in value) || value['endDate'] === undefined) return false;
+    if (!('keyMetrics' in value) || value['keyMetrics'] === undefined) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('updatedBy' in value) || value['updatedBy'] === undefined) return false;
+    if (!('scheduleLines' in value) || value['scheduleLines'] === undefined) return false;
+    return true;
+}
+
+export function BillingScheduleFromJSON(json: any): BillingSchedule {
+    return BillingScheduleFromJSONTyped(json, false);
+}
+
+export function BillingScheduleFromJSONTyped(json: any, ignoreDiscriminator: boolean): BillingSchedule {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'uuid': json['uuid'],
+        'customerId': json['customerId'],
+        'customerName': json['customerName'],
+        'subscriptionId': json['subscriptionId'],
+        'productId': json['productId'],
+        'productName': json['productName'],
+        'chargeId': json['chargeId'],
+        'chargeName': json['chargeName'],
+        'chargeType': json['chargeType'],
+        'chargeTiming': json['chargeTiming'],
+        'startDate': json['startDate'],
+        'endDate': json['endDate'],
+        'keyMetrics': KeyMetricsFromJSON(json['keyMetrics']),
+        'currency': json['currency'],
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+        'createdBy': json['createdBy'],
+        'updatedBy': json['updatedBy'],
+        'scheduleLines': ((json['scheduleLines'] as Array<any>).map(ScheduleLineFromJSON)),
+    };
+}
+
+export function BillingScheduleToJSON(json: any): BillingSchedule {
+    return BillingScheduleToJSONTyped(json, false);
+}
+
+export function BillingScheduleToJSONTyped(value?: BillingSchedule | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'uuid': value['uuid'],
+        'customerId': value['customerId'],
+        'customerName': value['customerName'],
+        'subscriptionId': value['subscriptionId'],
+        'productId': value['productId'],
+        'productName': value['productName'],
+        'chargeId': value['chargeId'],
+        'chargeName': value['chargeName'],
+        'chargeType': value['chargeType'],
+        'chargeTiming': value['chargeTiming'],
+        'startDate': value['startDate'],
+        'endDate': value['endDate'],
+        'keyMetrics': KeyMetricsToJSON(value['keyMetrics']),
+        'currency': value['currency'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+        'createdBy': value['createdBy'],
+        'updatedBy': value['updatedBy'],
+        'scheduleLines': ((value['scheduleLines'] as Array<any>).map(ScheduleLineToJSON)),
+    };
+}
+

package/src/generated/models/index.ts

@@ -15,6 +15,7 @@ export * from './base-pagination-query';
 export * from './billing-run';
 export * from './billing-run-filter-condition';
 export * from './billing-run-filter-options';
+export * from './billing-schedule';
 export * from './calendar';
 export * from './calendar-events';
 export * from './cancel-asset-reservations';
@@ -156,6 +157,7 @@ export * from './insured-roll-report-filters';
 export * from './intent';
 export * from './invoice';
 export * from './invoice-contact';
+export * from './key-metrics';
 export * from './lease-status';
 export * from './line-item';
 export * from './link-plugin';
@@ -218,6 +220,7 @@ export * from './roles1';
 export * from './roles2';
 export * from './roles3';
 export * from './roles4';
+export * from './schedule-line';
 export * from './send-email';
 export * from './send-sms';
 export * from './separate-assets-custom';

package/src/generated/models/key-metrics.ts

@@ -0,0 +1,93 @@
+/* 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 KeyMetrics
+ */
+export interface KeyMetrics {
+    /**
+     * Monthly Recurring Revenue
+     * @type {string}
+     * @memberof KeyMetrics
+     */
+    monthlyRecurringRevenue: string;
+    /**
+     * Annual Contract Revenue
+     * @type {string}
+     * @memberof KeyMetrics
+     */
+    annualContractRevenue: string;
+    /**
+     * Total Contract Revenue
+     * @type {string}
+     * @memberof KeyMetrics
+     */
+    totalContractRevenue: string;
+    /**
+     * Amount Invoiced
+     * @type {string}
+     * @memberof KeyMetrics
+     */
+    amountInvoiced: string;
+}
+
+/**
+ * Check if a given object implements the KeyMetrics interface.
+ */
+export function instanceOfKeyMetrics(value: object): value is KeyMetrics {
+    if (!('monthlyRecurringRevenue' in value) || value['monthlyRecurringRevenue'] === undefined) return false;
+    if (!('annualContractRevenue' in value) || value['annualContractRevenue'] === undefined) return false;
+    if (!('totalContractRevenue' in value) || value['totalContractRevenue'] === undefined) return false;
+    if (!('amountInvoiced' in value) || value['amountInvoiced'] === undefined) return false;
+    return true;
+}
+
+export function KeyMetricsFromJSON(json: any): KeyMetrics {
+    return KeyMetricsFromJSONTyped(json, false);
+}
+
+export function KeyMetricsFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeyMetrics {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'monthlyRecurringRevenue': json['monthlyRecurringRevenue'],
+        'annualContractRevenue': json['annualContractRevenue'],
+        'totalContractRevenue': json['totalContractRevenue'],
+        'amountInvoiced': json['amountInvoiced'],
+    };
+}
+
+export function KeyMetricsToJSON(json: any): KeyMetrics {
+    return KeyMetricsToJSONTyped(json, false);
+}
+
+export function KeyMetricsToJSONTyped(value?: KeyMetrics | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'monthlyRecurringRevenue': value['monthlyRecurringRevenue'],
+        'annualContractRevenue': value['annualContractRevenue'],
+        'totalContractRevenue': value['totalContractRevenue'],
+        'amountInvoiced': value['amountInvoiced'],
+    };
+}
+

package/src/generated/models/schedule-line.ts

@@ -0,0 +1,237 @@
+/* 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 ScheduleLine
+ */
+export interface ScheduleLine {
+    /**
+     * Schedule Line ID
+     * @type {number}
+     * @memberof ScheduleLine
+     */
+    id: number;
+    /**
+     * Schedule Line UID
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    uid: string;
+    /**
+     * Line Type
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    lineType: string;
+    /**
+     * Charge Ready Date
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    chargeReadyDate: string;
+    /**
+     * Start Date
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    startDate: string;
+    /**
+     * End Date
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    endDate: string;
+    /**
+     * Unit Price
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    unitPrice: string;
+    /**
+     * List Price
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    listPrice: string;
+    /**
+     * List Price Base
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    listPriceBase: string;
+    /**
+     * Quantity
+     * @type {number}
+     * @memberof ScheduleLine
+     */
+    quantity: number;
+    /**
+     * Discount
+     * @type {number}
+     * @memberof ScheduleLine
+     */
+    discount: number;
+    /**
+     * Amount
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    amount: string;
+    /**
+     * Remaining Included Units
+     * @type {number}
+     * @memberof ScheduleLine
+     */
+    remainingIncludedUnits: number;
+    /**
+     * Total Included Units
+     * @type {number}
+     * @memberof ScheduleLine
+     */
+    totalIncludedUnits: number;
+    /**
+     * Invoiced
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    invoiced: string;
+    /**
+     * When the billing schedule was created
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    createdAt: string;
+    /**
+     * When the billing schedule was last updated
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    updatedAt: string;
+    /**
+     * The email of the user who created the billing schedule
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    createdBy: string;
+    /**
+     * The email of the user who last updated the billing schedule
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    updatedBy: string;
+    /**
+     * The description of the billing schedule line
+     * @type {string}
+     * @memberof ScheduleLine
+     */
+    description: string;
+}
+
+/**
+ * Check if a given object implements the ScheduleLine interface.
+ */
+export function instanceOfScheduleLine(value: object): value is ScheduleLine {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('uid' in value) || value['uid'] === undefined) return false;
+    if (!('lineType' in value) || value['lineType'] === undefined) return false;
+    if (!('chargeReadyDate' in value) || value['chargeReadyDate'] === undefined) return false;
+    if (!('startDate' in value) || value['startDate'] === undefined) return false;
+    if (!('endDate' in value) || value['endDate'] === undefined) return false;
+    if (!('unitPrice' in value) || value['unitPrice'] === undefined) return false;
+    if (!('listPrice' in value) || value['listPrice'] === undefined) return false;
+    if (!('listPriceBase' in value) || value['listPriceBase'] === undefined) return false;
+    if (!('quantity' in value) || value['quantity'] === undefined) return false;
+    if (!('discount' in value) || value['discount'] === undefined) return false;
+    if (!('amount' in value) || value['amount'] === undefined) return false;
+    if (!('remainingIncludedUnits' in value) || value['remainingIncludedUnits'] === undefined) return false;
+    if (!('totalIncludedUnits' in value) || value['totalIncludedUnits'] === undefined) return false;
+    if (!('invoiced' in value) || value['invoiced'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('updatedBy' in value) || value['updatedBy'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    return true;
+}
+
+export function ScheduleLineFromJSON(json: any): ScheduleLine {
+    return ScheduleLineFromJSONTyped(json, false);
+}
+
+export function ScheduleLineFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScheduleLine {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'uid': json['uid'],
+        'lineType': json['lineType'],
+        'chargeReadyDate': json['chargeReadyDate'],
+        'startDate': json['startDate'],
+        'endDate': json['endDate'],
+        'unitPrice': json['unitPrice'],
+        'listPrice': json['listPrice'],
+        'listPriceBase': json['listPriceBase'],
+        'quantity': json['quantity'],
+        'discount': json['discount'],
+        'amount': json['amount'],
+        'remainingIncludedUnits': json['remainingIncludedUnits'],
+        'totalIncludedUnits': json['totalIncludedUnits'],
+        'invoiced': json['invoiced'],
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+        'createdBy': json['createdBy'],
+        'updatedBy': json['updatedBy'],
+        'description': json['description'],
+    };
+}
+
+export function ScheduleLineToJSON(json: any): ScheduleLine {
+    return ScheduleLineToJSONTyped(json, false);
+}
+
+export function ScheduleLineToJSONTyped(value?: ScheduleLine | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'uid': value['uid'],
+        'lineType': value['lineType'],
+        'chargeReadyDate': value['chargeReadyDate'],
+        'startDate': value['startDate'],
+        'endDate': value['endDate'],
+        'unitPrice': value['unitPrice'],
+        'listPrice': value['listPrice'],
+        'listPriceBase': value['listPriceBase'],
+        'quantity': value['quantity'],
+        'discount': value['discount'],
+        'amount': value['amount'],
+        'remainingIncludedUnits': value['remainingIncludedUnits'],
+        'totalIncludedUnits': value['totalIncludedUnits'],
+        'invoiced': value['invoiced'],
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+        'createdBy': value['createdBy'],
+        'updatedBy': value['updatedBy'],
+        'description': value['description'],
+    };
+}
+

package/src/generated/models/subscription-preview.ts

@@ -310,12 +310,6 @@ export interface SubscriptionPreview {
      * @memberof SubscriptionPreview
      */
     updatedBy?: string;
-    /**
-     * Date customer initiated move-out
-     * @type {string}
-     * @memberof SubscriptionPreview
-     */
-    moveOutDate?: string;
     /**
      * Subscription Current Invoice line items
      * @type {SubscriptionInvoice}
@@ -423,7 +417,6 @@ export function SubscriptionPreviewFromJSONTyped(json: any, ignoreDiscriminator:
         'createdBy': json['createdBy'],
         'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
         'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
-        'moveOutDate': json['moveOutDate'] == null ? undefined : json['moveOutDate'],
         'currentInvoice': json['currentInvoice'] == null ? undefined : SubscriptionInvoiceFromJSON(json['currentInvoice']),
         'nextInvoice': json['nextInvoice'] == null ? undefined : SubscriptionInvoiceFromJSON(json['nextInvoice']),
         'priorInvoice': json['priorInvoice'] == null ? undefined : SubscriptionInvoiceFromJSON(json['priorInvoice']),
@@ -488,7 +481,6 @@ export function SubscriptionPreviewToJSONTyped(value?: SubscriptionPreview | nul
         'createdBy': value['createdBy'],
         'updatedAt': value['updatedAt'],
         'updatedBy': value['updatedBy'],
-        'moveOutDate': value['moveOutDate'],
         'currentInvoice': SubscriptionInvoiceToJSON(value['currentInvoice']),
         'nextInvoice': SubscriptionInvoiceToJSON(value['nextInvoice']),
         'priorInvoice': SubscriptionInvoiceToJSON(value['priorInvoice']),

package/src/generated/models/subscription.ts

@@ -303,12 +303,6 @@ export interface Subscription {
      * @memberof Subscription
      */
     updatedBy?: string;
-    /**
-     * Date customer initiated move-out
-     * @type {string}
-     * @memberof Subscription
-     */
-    moveOutDate?: string;
 }
 
 /**
@@ -392,7 +386,6 @@ export function SubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'createdBy': json['createdBy'],
         'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
         'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
-        'moveOutDate': json['moveOutDate'] == null ? undefined : json['moveOutDate'],
     };
 }
 
@@ -453,7 +446,6 @@ export function SubscriptionToJSONTyped(value?: Subscription | null, ignoreDiscr
         'createdBy': value['createdBy'],
         'updatedAt': value['updatedAt'],
         'updatedBy': value['updatedBy'],
-        'moveOutDate': value['moveOutDate'],
     };
 }