@managespace/sdk 0.1.4 → 0.1.5-0.paul.dev

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

@@ -0,0 +1,482 @@
+/* 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 { SubscriptionCharge } from './subscription-charge';
+import {
+    SubscriptionChargeFromJSON,
+    SubscriptionChargeFromJSONTyped,
+    SubscriptionChargeToJSON,
+    SubscriptionChargeToJSONTyped,
+} from './subscription-charge';
+import type { SubscriptionInvoice } from './subscription-invoice';
+import {
+    SubscriptionInvoiceFromJSON,
+    SubscriptionInvoiceFromJSONTyped,
+    SubscriptionInvoiceToJSON,
+    SubscriptionInvoiceToJSONTyped,
+} 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;
+    /**
+     * The date the subscription is paid until.
+     * @type {Date}
+     * @memberof SubscriptionPreview
+     */
+    paidThroughDate?: Date;
+    /**
+     * Id of billing contact
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    billContactId?: string;
+    /**
+     * Id of shipping contact
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    shippingContactId?: 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>;
+    /**
+     * Date record was created
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    createdAt: string;
+    /**
+     * Email of user who created record
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    createdBy: string;
+    /**
+     * Date record was created
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    updatedAt?: string;
+    /**
+     * Email of user who last modifed record
+     * @type {string}
+     * @memberof SubscriptionPreview
+     */
+    updatedBy?: 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 function instanceOfSubscriptionPreview(value: object): value is SubscriptionPreview {
+    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 (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === 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;
+}
+
+export function SubscriptionPreviewFromJSON(json: any): SubscriptionPreview {
+    return SubscriptionPreviewFromJSONTyped(json, false);
+}
+
+export function SubscriptionPreviewFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPreview {
+    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'],
+        'paidThroughDate': json['paidThroughDate'] == null ? undefined : (new Date(json['paidThroughDate'])),
+        'billContactId': json['billContactId'] == null ? undefined : json['billContactId'],
+        'shippingContactId': json['shippingContactId'] == null ? undefined : json['shippingContactId'],
+        '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'] as Array<any>).map(SubscriptionChargeFromJSON)),
+        'createdAt': json['createdAt'],
+        'createdBy': json['createdBy'],
+        'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
+        'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
+        'currentInvoice': SubscriptionInvoiceFromJSON(json['currentInvoice']),
+        'nextInvoice': SubscriptionInvoiceFromJSON(json['nextInvoice']),
+        'estimatedTax': json['estimatedTax'],
+    };
+}
+
+export function SubscriptionPreviewToJSON(json: any): SubscriptionPreview {
+    return SubscriptionPreviewToJSONTyped(json, false);
+}
+
+export function SubscriptionPreviewToJSONTyped(value?: SubscriptionPreview | null, ignoreDiscriminator: boolean = false): any {
+    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'],
+        'paidThroughDate': value['paidThroughDate'] == null ? undefined : ((value['paidThroughDate']).toISOString()),
+        'billContactId': value['billContactId'],
+        'shippingContactId': value['shippingContactId'],
+        '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'] as Array<any>).map(SubscriptionChargeToJSON)),
+        'createdAt': value['createdAt'],
+        'createdBy': value['createdBy'],
+        'updatedAt': value['updatedAt'],
+        'updatedBy': value['updatedBy'],
+        'currentInvoice': SubscriptionInvoiceToJSON(value['currentInvoice']),
+        'nextInvoice': SubscriptionInvoiceToJSON(value['nextInvoice']),
+        'estimatedTax': value['estimatedTax'],
+    };
+}
+