@managespace/sdk 0.0.134 → 0.0.136

package/dist/generated/models/subscription-plan.js

@@ -0,0 +1,208 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionPlanToJSONTyped = exports.SubscriptionPlanToJSON = exports.SubscriptionPlanFromJSONTyped = exports.SubscriptionPlanFromJSON = exports.instanceOfSubscriptionPlan = void 0;
+const transaction_posting_entries_1 = require("./transaction-posting-entries");
+/**
+ * Check if a given object implements the SubscriptionPlan interface.
+ */
+function instanceOfSubscriptionPlan(value) {
+    if (!('externalProductId' in value) || value['externalProductId'] === undefined)
+        return false;
+    if (!('productName' in value) || value['productName'] === undefined)
+        return false;
+    if (!('externalPlanId' in value) || value['externalPlanId'] === undefined)
+        return false;
+    if (!('planName' in value) || value['planName'] === undefined)
+        return false;
+    if (!('subscriptionLineId' in value) || value['subscriptionLineId'] === undefined)
+        return false;
+    if (!('externalChargeId' in value) || value['externalChargeId'] === undefined)
+        return false;
+    if (!('chargeName' in value) || value['chargeName'] === undefined)
+        return false;
+    if (!('pricingModel' in value) || value['pricingModel'] === undefined)
+        return false;
+    if (!('listPrice' in value) || value['listPrice'] === undefined)
+        return false;
+    if (!('listPriceBase' in value) || value['listPriceBase'] === undefined)
+        return false;
+    if (!('priceBase' in value) || value['priceBase'] === undefined)
+        return false;
+    if (!('quantity' in value) || value['quantity'] === undefined)
+        return false;
+    if (!('includedUnits' in value) || value['includedUnits'] === undefined)
+        return false;
+    if (!('discount' in value) || value['discount'] === undefined)
+        return false;
+    if (!('effectivePrice' in value) || value['effectivePrice'] === undefined)
+        return false;
+    if (!('chargeType' in value) || value['chargeType'] === undefined)
+        return false;
+    if (!('billingPeriod' in value) || value['billingPeriod'] === undefined)
+        return false;
+    if (!('unitOfMeasure' in value) || value['unitOfMeasure'] === undefined)
+        return false;
+    if (!('currentPeriodStartDate' in value) || value['currentPeriodStartDate'] === undefined)
+        return false;
+    if (!('currentPeriodEndDate' in value) || value['currentPeriodEndDate'] === undefined)
+        return false;
+    if (!('billingScheduleId' in value) || value['billingScheduleId'] === undefined)
+        return false;
+    if (!('revenueScheduleId' in value) || value['revenueScheduleId'] === undefined)
+        return false;
+    if (!('chargeTiming' in value) || value['chargeTiming'] === undefined)
+        return false;
+    if (!('billingPeriodStartAlignment' in value) || value['billingPeriodStartAlignment'] === undefined)
+        return false;
+    if (!('billingDay' in value) || value['billingDay'] === undefined)
+        return false;
+    if (!('proratePartialPeriods' in value) || value['proratePartialPeriods'] === undefined)
+        return false;
+    if (!('backchargeCurrentPeriod' in value) || value['backchargeCurrentPeriod'] === undefined)
+        return false;
+    if (!('prepaymentPeriods' in value) || value['prepaymentPeriods'] === undefined)
+        return false;
+    if (!('cmrr' in value) || value['cmrr'] === undefined)
+        return false;
+    if (!('discountedCmrr' in value) || value['discountedCmrr'] === undefined)
+        return false;
+    if (!('chargeStartDate' in value) || value['chargeStartDate'] === undefined)
+        return false;
+    if (!('chargeEndDate' in value) || value['chargeEndDate'] === undefined)
+        return false;
+    if (!('renewalIncrementPercent' in value) || value['renewalIncrementPercent'] === undefined)
+        return false;
+    if (!('overrideRenewalIncrementPercent' in value) || value['overrideRenewalIncrementPercent'] === undefined)
+        return false;
+    if (!('defaultFromPlan' in value) || value['defaultFromPlan'] === undefined)
+        return false;
+    if (!('revenueRuleId' in value) || value['revenueRuleId'] === undefined)
+        return false;
+    if (!('recognitionStartDate' in value) || value['recognitionStartDate'] === undefined)
+        return false;
+    if (!('recognitionEndDate' in value) || value['recognitionEndDate'] === undefined)
+        return false;
+    if (!('transactionPostingEntries' in value) || value['transactionPostingEntries'] === undefined)
+        return false;
+    if (!('customFields' in value) || value['customFields'] === undefined)
+        return false;
+    return true;
+}
+exports.instanceOfSubscriptionPlan = instanceOfSubscriptionPlan;
+function SubscriptionPlanFromJSON(json) {
+    return SubscriptionPlanFromJSONTyped(json, false);
+}
+exports.SubscriptionPlanFromJSON = SubscriptionPlanFromJSON;
+function SubscriptionPlanFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'externalProductId': json['externalProductId'],
+        'productName': json['productName'],
+        'externalPlanId': json['externalPlanId'],
+        'planName': json['planName'],
+        'subscriptionLineId': json['subscriptionLineId'],
+        'externalChargeId': json['externalChargeId'],
+        'chargeName': json['chargeName'],
+        'pricingModel': json['pricingModel'],
+        'listPrice': json['listPrice'],
+        'listPriceBase': json['listPriceBase'],
+        'priceBase': json['priceBase'],
+        'quantity': json['quantity'],
+        'includedUnits': json['includedUnits'],
+        'discount': json['discount'],
+        'effectivePrice': json['effectivePrice'],
+        'chargeType': json['chargeType'],
+        'billingPeriod': json['billingPeriod'],
+        'unitOfMeasure': json['unitOfMeasure'],
+        'currentPeriodStartDate': json['currentPeriodStartDate'],
+        'currentPeriodEndDate': json['currentPeriodEndDate'],
+        'billingScheduleId': json['billingScheduleId'],
+        'revenueScheduleId': json['revenueScheduleId'],
+        'chargeTiming': json['chargeTiming'],
+        'billingPeriodStartAlignment': json['billingPeriodStartAlignment'],
+        'billingDay': json['billingDay'],
+        'proratePartialPeriods': json['proratePartialPeriods'],
+        'backchargeCurrentPeriod': json['backchargeCurrentPeriod'],
+        'prepaymentPeriods': json['prepaymentPeriods'],
+        'cmrr': json['cmrr'],
+        'discountedCmrr': json['discountedCmrr'],
+        'chargeStartDate': json['chargeStartDate'],
+        'chargeEndDate': json['chargeEndDate'],
+        'renewalIncrementPercent': json['renewalIncrementPercent'],
+        'overrideRenewalIncrementPercent': json['overrideRenewalIncrementPercent'],
+        'defaultFromPlan': json['defaultFromPlan'],
+        'revenueRuleId': json['revenueRuleId'],
+        'recognitionStartDate': json['recognitionStartDate'],
+        'recognitionEndDate': json['recognitionEndDate'],
+        'transactionPostingEntries': (json['transactionPostingEntries'].map(transaction_posting_entries_1.TransactionPostingEntriesFromJSON)),
+        'customFields': json['customFields'],
+    };
+}
+exports.SubscriptionPlanFromJSONTyped = SubscriptionPlanFromJSONTyped;
+function SubscriptionPlanToJSON(json) {
+    return SubscriptionPlanToJSONTyped(json, false);
+}
+exports.SubscriptionPlanToJSON = SubscriptionPlanToJSON;
+function SubscriptionPlanToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'externalProductId': value['externalProductId'],
+        'productName': value['productName'],
+        'externalPlanId': value['externalPlanId'],
+        'planName': value['planName'],
+        'subscriptionLineId': value['subscriptionLineId'],
+        'externalChargeId': value['externalChargeId'],
+        'chargeName': value['chargeName'],
+        'pricingModel': value['pricingModel'],
+        'listPrice': value['listPrice'],
+        'listPriceBase': value['listPriceBase'],
+        'priceBase': value['priceBase'],
+        'quantity': value['quantity'],
+        'includedUnits': value['includedUnits'],
+        'discount': value['discount'],
+        'effectivePrice': value['effectivePrice'],
+        'chargeType': value['chargeType'],
+        'billingPeriod': value['billingPeriod'],
+        'unitOfMeasure': value['unitOfMeasure'],
+        'currentPeriodStartDate': value['currentPeriodStartDate'],
+        'currentPeriodEndDate': value['currentPeriodEndDate'],
+        'billingScheduleId': value['billingScheduleId'],
+        'revenueScheduleId': value['revenueScheduleId'],
+        'chargeTiming': value['chargeTiming'],
+        'billingPeriodStartAlignment': value['billingPeriodStartAlignment'],
+        'billingDay': value['billingDay'],
+        'proratePartialPeriods': value['proratePartialPeriods'],
+        'backchargeCurrentPeriod': value['backchargeCurrentPeriod'],
+        'prepaymentPeriods': value['prepaymentPeriods'],
+        'cmrr': value['cmrr'],
+        'discountedCmrr': value['discountedCmrr'],
+        'chargeStartDate': value['chargeStartDate'],
+        'chargeEndDate': value['chargeEndDate'],
+        'renewalIncrementPercent': value['renewalIncrementPercent'],
+        'overrideRenewalIncrementPercent': value['overrideRenewalIncrementPercent'],
+        'defaultFromPlan': value['defaultFromPlan'],
+        'revenueRuleId': value['revenueRuleId'],
+        'recognitionStartDate': value['recognitionStartDate'],
+        'recognitionEndDate': value['recognitionEndDate'],
+        'transactionPostingEntries': (value['transactionPostingEntries'].map(transaction_posting_entries_1.TransactionPostingEntriesToJSON)),
+        'customFields': value['customFields'],
+    };
+}
+exports.SubscriptionPlanToJSONTyped = SubscriptionPlanToJSONTyped;

package/dist/generated/models/subscription-preview.d.ts

@@ -0,0 +1,275 @@
+/**
+ * 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 type { SubscriptionCharge } from './subscription-charge';
+import type { SubscriptionInvoice } from './subscription-invoice';
+/**
+ *
+ * @export
+ * @interface SubscriptionPreview
+ */
+export interface SubscriptionPreview {
+    /**
+     * Subscription ID
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    id: string;
+    /**
+     * Customer ID
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    externalCustomerId: string;
+    /**
+     * Customer name
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    customerName: string;
+    /**
+     * Id of billing contact
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    externalBillContactId: string;
+    /**
+     * Id of shipping contact
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    externalShippingContactId: string;
+    /**
+     * Status of subscription contract
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    status: string;
+    /**
+     * Set to defer start date
+     * @type {boolean}
+     * @memberof SubscriptionPreview
+     */
+    deferStartDate: boolean;
+    /**
+     * Billing start date for subscription contract
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    billingStartDate: string;
+    /**
+     * Service start date for subscription contract
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    serviceStartDate: string;
+    /**
+     * Date order was placed
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    orderPlacedAt: string;
+    /**
+     * Date subscription contract was signed and activated
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    contractEffectiveDate: string;
+    /**
+     * Date subscription contract was terminated
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    cancellationDate: string;
+    /**
+     * Date subscription contract to pause
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    pauseEffectiveDate: string;
+    /**
+     * Date subscription contract to resume
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    resumeEffectiveDate: string;
+    /**
+     * Set to extend contract on resume
+     * @type {boolean}
+     * @memberof SubscriptionPreview
+     */
+    extendOnResume: boolean;
+    /**
+     * auto-renew subscription contract
+     * @type {boolean}
+     * @memberof SubscriptionPreview
+     */
+    autoRenew: boolean;
+    /**
+     * currency
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    currency: string;
+    /**
+     * Calculate due date of invoice
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    paymentTerms: string;
+    /**
+     * Contracted MRR per charge
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    cmrr: string;
+    /**
+     * MRR calculated based on % discount
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    discountedCmrr: string;
+    /**
+     * separate invoice generated
+     * @type {boolean}
+     * @memberof SubscriptionPreview
+     */
+    separateInvoice: boolean;
+    /**
+     * Miscellaneous notes
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    notes: string;
+    /**
+     * Version of subscription contract
+     * @type {number}
+     * @memberof SubscriptionPreview
+     */
+    version: number;
+    /**
+     * Subscription contract version type
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    versionType: string;
+    /**
+     * Term of contract in months
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    contractTerm: string;
+    /**
+     * Date subscription contract will start
+     * @type {number}
+     * @memberof SubscriptionPreview
+     */
+    renewalIncrementPercent: number;
+    /**
+     * Total contract value of the subsctiption contract
+     * @type {number}
+     * @memberof SubscriptionPreview
+     */
+    tcv: number;
+    /**
+     * Subscription charge details
+     * @type {Array<SubscriptionCharge>}
+     * @memberof SubscriptionPreview
+     */
+    charges: Array<SubscriptionCharge>;
+    /**
+     * Date record was created
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    createdAt: string;
+    /**
+     * Date record was created
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    updatedAt: string;
+    /**
+     * Email of user who created record
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    createdBy: string;
+    /**
+     * Email of user who last modifed record
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    updatedBy: string;
+    /**
+     * Id of billing contact sf
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    billContactSfId: string;
+    /**
+     * Id of shipping contact sf
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    shippingContactSfId: string;
+    /**
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof SubscriptionPreview
+     */
+    customFields: object;
+    /**
+     * Asset ID
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    assetId?: string;
+    /**
+     * Site ID
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    siteId: string;
+    /**
+     * External id associated with subscription
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    externalId: string;
+    /**
+     * Subscription Current Invoice line items
+     * @type {SubscriptionInvoice}
+     * @memberof SubscriptionPreview
+     */
+    currentInvoice: SubscriptionInvoice;
+    /**
+     * Subscription Next Invoice line items
+     * @type {SubscriptionInvoice}
+     * @memberof SubscriptionPreview
+     */
+    nextInvoice: SubscriptionInvoice;
+    /**
+     * Estimated tax amount
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    estimatedTax: string;
+}
+/**
+ * Check if a given object implements the SubscriptionPreview interface.
+ */
+export declare function instanceOfSubscriptionPreview(value: object): value is SubscriptionPreview;
+export declare function SubscriptionPreviewFromJSON(json: any): SubscriptionPreview;
+export declare function SubscriptionPreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPreview;
+export declare function SubscriptionPreviewToJSON(json: any): SubscriptionPreview;
+export declare function SubscriptionPreviewToJSONTyped(value?: SubscriptionPreview | null, ignoreDiscriminator?: boolean): any;
+//# sourceMappingURL=subscription-preview.d.ts.map

package/dist/generated/models/subscription-preview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription-preview.d.ts","sourceRoot":"","sources":["../../../src/generated/models/subscription-preview.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAOhE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAQlE;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAClC;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,qBAAqB,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACnC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,cAAc,EAAE,mBAAmB,CAAC;IACpC;;;;OAIG;IACH,WAAW,EAAE,mBAAmB,CAAC;IACjC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,mBAAmB,CA0CzF;AAED,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,GAAG,GAAG,mBAAmB,CAE1E;AAED,wBAAgB,gCAAgC,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,mBAAmB,CAgD7G;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,GAAG,GAAG,mBAAmB,CAExE;AAED,wBAAgB,8BAA8B,CAAC,KAAK,CAAC,EAAE,mBAAmB,GAAG,IAAI,EAAE,mBAAmB,GAAE,OAAe,GAAG,GAAG,CAiD5H"}