@managespace/sdk 0.1.4 → 0.1.6

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

@@ -0,0 +1,317 @@
+/**
+ * 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 {
+    /**
+     * Status of subscription contract
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    status?: string;
+    /**
+     * 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;
+    /**
+     * Cancel as of option
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    cancellationType?: string;
+    /**
+     * 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;
+    /**
+     * Coupon Code
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    couponCode?: 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;
+    /**
+     * Length of time Subscription Contract will be renewed for
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    renewalTerm?: string;
+    /**
+     * Date Subscription Contract will start
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    currentTermStartDate?: string;
+    /**
+     * Date subscription contract will end
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    currentTermEndDate?: string;
+    /**
+     * Date subscription contract was terminated
+     * @type {number}
+     * @memberof SubscriptionPreview
+     */
+    renewalIncrementPercent?: number;
+    /**
+     * Asset ID
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    assetId?: string;
+    /**
+     * Id of billing contact
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    billContactId?: string;
+    /**
+     * Id of shipping contact
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    shippingContactId?: string;
+    /**
+     * Date record was created
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    updatedAt?: string;
+    /**
+     * Date record was created
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    createdAt?: 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;
+    /**
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof SubscriptionPreview
+     */
+    customFields?: object;
+    /**
+     * Total contract value of the subsctiption contract
+     * @type {number}
+     * @memberof SubscriptionPreview
+     */
+    tcv?: number;
+    /**
+     * Set to defer start date
+     * @type {boolean}
+     * @memberof SubscriptionPreview
+     */
+    deferStartDate?: boolean;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * Id of billing contact sf
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    billContactSfId: string;
+    /**
+     * Id of shipping contact sf
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    shippingContactSfId: string;
+    /**
+     * Site ID
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    siteId: string;
+    /**
+     * External id associated with subscription
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    externalId: string;
+    /**
+     * Charges associated the subscription
+     * @type {Array<SubscriptionCharge>}
+     * @memberof SubscriptionPreview
+     */
+    charges: Array<SubscriptionCharge>;
+    /**
+     * 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,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;;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,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACnC;;;;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,CAkBzF;AAED,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,GAAG,GAAG,mBAAmB,CAE1E;AAED,wBAAgB,gCAAgC,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,mBAAmB,CAuD7G;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,CAwD5H"}

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

@@ -0,0 +1,177 @@
+"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.SubscriptionPreviewToJSONTyped = exports.SubscriptionPreviewToJSON = exports.SubscriptionPreviewFromJSONTyped = exports.SubscriptionPreviewFromJSON = exports.instanceOfSubscriptionPreview = void 0;
+const subscription_charge_1 = require("./subscription-charge");
+const subscription_invoice_1 = require("./subscription-invoice");
+/**
+ * Check if a given object implements the SubscriptionPreview interface.
+ */
+function instanceOfSubscriptionPreview(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('externalCustomerId' in value) || value['externalCustomerId'] === undefined)
+        return false;
+    if (!('customerName' in value) || value['customerName'] === undefined)
+        return false;
+    if (!('externalBillContactId' in value) || value['externalBillContactId'] === undefined)
+        return false;
+    if (!('externalShippingContactId' in value) || value['externalShippingContactId'] === undefined)
+        return false;
+    if (!('pauseEffectiveDate' in value) || value['pauseEffectiveDate'] === undefined)
+        return false;
+    if (!('resumeEffectiveDate' in value) || value['resumeEffectiveDate'] === undefined)
+        return false;
+    if (!('extendOnResume' in value) || value['extendOnResume'] === undefined)
+        return false;
+    if (!('billContactSfId' in value) || value['billContactSfId'] === undefined)
+        return false;
+    if (!('shippingContactSfId' in value) || value['shippingContactSfId'] === undefined)
+        return false;
+    if (!('siteId' in value) || value['siteId'] === undefined)
+        return false;
+    if (!('externalId' in value) || value['externalId'] === undefined)
+        return false;
+    if (!('charges' in value) || value['charges'] === undefined)
+        return false;
+    if (!('currentInvoice' in value) || value['currentInvoice'] === undefined)
+        return false;
+    if (!('nextInvoice' in value) || value['nextInvoice'] === undefined)
+        return false;
+    if (!('estimatedTax' in value) || value['estimatedTax'] === undefined)
+        return false;
+    return true;
+}
+exports.instanceOfSubscriptionPreview = instanceOfSubscriptionPreview;
+function SubscriptionPreviewFromJSON(json) {
+    return SubscriptionPreviewFromJSONTyped(json, false);
+}
+exports.SubscriptionPreviewFromJSON = SubscriptionPreviewFromJSON;
+function SubscriptionPreviewFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'status': json['status'] == null ? undefined : json['status'],
+        'billingStartDate': json['billingStartDate'] == null ? undefined : json['billingStartDate'],
+        'serviceStartDate': json['serviceStartDate'] == null ? undefined : json['serviceStartDate'],
+        'orderPlacedAt': json['orderPlacedAt'] == null ? undefined : json['orderPlacedAt'],
+        'contractEffectiveDate': json['contractEffectiveDate'] == null ? undefined : json['contractEffectiveDate'],
+        'cancellationDate': json['cancellationDate'] == null ? undefined : json['cancellationDate'],
+        'cancellationType': json['cancellationType'] == null ? undefined : json['cancellationType'],
+        'autoRenew': json['autoRenew'] == null ? undefined : json['autoRenew'],
+        'currency': json['currency'] == null ? undefined : json['currency'],
+        'paymentTerms': json['paymentTerms'] == null ? undefined : json['paymentTerms'],
+        'cmrr': json['cmrr'] == null ? undefined : json['cmrr'],
+        'discountedCmrr': json['discountedCmrr'] == null ? undefined : json['discountedCmrr'],
+        'separateInvoice': json['separateInvoice'] == null ? undefined : json['separateInvoice'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+        'couponCode': json['couponCode'] == null ? undefined : json['couponCode'],
+        'version': json['version'] == null ? undefined : json['version'],
+        'versionType': json['versionType'] == null ? undefined : json['versionType'],
+        'contractTerm': json['contractTerm'] == null ? undefined : json['contractTerm'],
+        'renewalTerm': json['renewalTerm'] == null ? undefined : json['renewalTerm'],
+        'currentTermStartDate': json['currentTermStartDate'] == null ? undefined : json['currentTermStartDate'],
+        'currentTermEndDate': json['currentTermEndDate'] == null ? undefined : json['currentTermEndDate'],
+        'renewalIncrementPercent': json['renewalIncrementPercent'] == null ? undefined : json['renewalIncrementPercent'],
+        'assetId': json['assetId'] == null ? undefined : json['assetId'],
+        'billContactId': json['billContactId'] == null ? undefined : json['billContactId'],
+        'shippingContactId': json['shippingContactId'] == null ? undefined : json['shippingContactId'],
+        'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
+        'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
+        'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
+        'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
+        'customFields': json['customFields'] == null ? undefined : json['customFields'],
+        'tcv': json['tcv'] == null ? undefined : json['tcv'],
+        'deferStartDate': json['deferStartDate'] == null ? undefined : json['deferStartDate'],
+        'id': json['id'],
+        'externalCustomerId': json['externalCustomerId'],
+        'customerName': json['customerName'],
+        'externalBillContactId': json['externalBillContactId'],
+        'externalShippingContactId': json['externalShippingContactId'],
+        'pauseEffectiveDate': json['pauseEffectiveDate'],
+        'resumeEffectiveDate': json['resumeEffectiveDate'],
+        'extendOnResume': json['extendOnResume'],
+        'billContactSfId': json['billContactSfId'],
+        'shippingContactSfId': json['shippingContactSfId'],
+        'siteId': json['siteId'],
+        'externalId': json['externalId'],
+        'charges': (json['charges'].map(subscription_charge_1.SubscriptionChargeFromJSON)),
+        'currentInvoice': (0, subscription_invoice_1.SubscriptionInvoiceFromJSON)(json['currentInvoice']),
+        'nextInvoice': (0, subscription_invoice_1.SubscriptionInvoiceFromJSON)(json['nextInvoice']),
+        'estimatedTax': json['estimatedTax'],
+    };
+}
+exports.SubscriptionPreviewFromJSONTyped = SubscriptionPreviewFromJSONTyped;
+function SubscriptionPreviewToJSON(json) {
+    return SubscriptionPreviewToJSONTyped(json, false);
+}
+exports.SubscriptionPreviewToJSON = SubscriptionPreviewToJSON;
+function SubscriptionPreviewToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'status': value['status'],
+        'billingStartDate': value['billingStartDate'],
+        'serviceStartDate': value['serviceStartDate'],
+        'orderPlacedAt': value['orderPlacedAt'],
+        'contractEffectiveDate': value['contractEffectiveDate'],
+        'cancellationDate': value['cancellationDate'],
+        'cancellationType': value['cancellationType'],
+        'autoRenew': value['autoRenew'],
+        'currency': value['currency'],
+        'paymentTerms': value['paymentTerms'],
+        'cmrr': value['cmrr'],
+        'discountedCmrr': value['discountedCmrr'],
+        'separateInvoice': value['separateInvoice'],
+        'notes': value['notes'],
+        'couponCode': value['couponCode'],
+        'version': value['version'],
+        'versionType': value['versionType'],
+        'contractTerm': value['contractTerm'],
+        'renewalTerm': value['renewalTerm'],
+        'currentTermStartDate': value['currentTermStartDate'],
+        'currentTermEndDate': value['currentTermEndDate'],
+        'renewalIncrementPercent': value['renewalIncrementPercent'],
+        'assetId': value['assetId'],
+        'billContactId': value['billContactId'],
+        'shippingContactId': value['shippingContactId'],
+        'updatedAt': value['updatedAt'],
+        'createdAt': value['createdAt'],
+        'createdBy': value['createdBy'],
+        'updatedBy': value['updatedBy'],
+        'customFields': value['customFields'],
+        'tcv': value['tcv'],
+        'deferStartDate': value['deferStartDate'],
+        'id': value['id'],
+        'externalCustomerId': value['externalCustomerId'],
+        'customerName': value['customerName'],
+        'externalBillContactId': value['externalBillContactId'],
+        'externalShippingContactId': value['externalShippingContactId'],
+        'pauseEffectiveDate': value['pauseEffectiveDate'],
+        'resumeEffectiveDate': value['resumeEffectiveDate'],
+        'extendOnResume': value['extendOnResume'],
+        'billContactSfId': value['billContactSfId'],
+        'shippingContactSfId': value['shippingContactSfId'],
+        'siteId': value['siteId'],
+        'externalId': value['externalId'],
+        'charges': (value['charges'].map(subscription_charge_1.SubscriptionChargeToJSON)),
+        'currentInvoice': (0, subscription_invoice_1.SubscriptionInvoiceToJSON)(value['currentInvoice']),
+        'nextInvoice': (0, subscription_invoice_1.SubscriptionInvoiceToJSON)(value['nextInvoice']),
+        'estimatedTax': value['estimatedTax'],
+    };
+}
+exports.SubscriptionPreviewToJSONTyped = SubscriptionPreviewToJSONTyped;