@managespace/sdk 0.1.4 → 0.1.6

package/src/generated/models/subscription.ts

@@ -28,221 +28,257 @@ import {
  */
 export interface Subscription {
     /**
-     * Subscription ID
+     * Status of subscription contract
      * @type {string}
      * @memberof Subscription
      */
-    id: string;
+    status?: string;
     /**
-     * Customer ID
+     * Billing start date for subscription contract
      * @type {string}
      * @memberof Subscription
      */
-    externalCustomerId: string;
+    billingStartDate?: string;
     /**
-     * Customer name
+     * Service start date for subscription contract
      * @type {string}
      * @memberof Subscription
      */
-    customerName: string;
+    serviceStartDate?: string;
     /**
-     * Id of billing contact
+     * Date order was placed
      * @type {string}
      * @memberof Subscription
      */
-    externalBillContactId: string;
+    orderPlacedAt?: string;
     /**
-     * Id of shipping contact
+     * Date subscription contract was signed and activated
      * @type {string}
      * @memberof Subscription
      */
-    externalShippingContactId: string;
+    contractEffectiveDate?: string;
     /**
-     * Status of subscription contract
+     * Date subscription contract was terminated
      * @type {string}
      * @memberof Subscription
      */
-    status: string;
+    cancellationDate?: string;
     /**
-     * Set to defer start date
+     * Cancel as of option
+     * @type {string}
+     * @memberof Subscription
+     */
+    cancellationType?: string;
+    /**
+     * auto-renew subscription contract
      * @type {boolean}
      * @memberof Subscription
      */
-    deferStartDate: boolean;
+    autoRenew?: boolean;
     /**
-     * Billing start date for subscription contract
+     * currency
      * @type {string}
      * @memberof Subscription
      */
-    billingStartDate: string;
+    currency?: string;
     /**
-     * Service start date for subscription contract
+     * Calculate due date of invoice
      * @type {string}
      * @memberof Subscription
      */
-    serviceStartDate: string;
+    paymentTerms?: string;
     /**
-     * Date order was placed
+     * Contracted MRR per charge
      * @type {string}
      * @memberof Subscription
      */
-    orderPlacedAt: string;
+    cmrr?: string;
     /**
-     * Date subscription contract was signed and activated
+     * MRR calculated based on % discount
      * @type {string}
      * @memberof Subscription
      */
-    contractEffectiveDate: string;
+    discountedCmrr?: string;
     /**
-     * Date subscription contract was terminated
+     * separate invoice generated
+     * @type {boolean}
+     * @memberof Subscription
+     */
+    separateInvoice?: boolean;
+    /**
+     * Miscellaneous notes
      * @type {string}
      * @memberof Subscription
      */
-    cancellationDate: string;
+    notes?: string;
     /**
-     * Date subscription contract to pause
+     * Coupon Code
      * @type {string}
      * @memberof Subscription
      */
-    pauseEffectiveDate: string;
+    couponCode?: string;
     /**
-     * Date subscription contract to resume
+     * Version of subscription contract
+     * @type {number}
+     * @memberof Subscription
+     */
+    version?: number;
+    /**
+     * Subscription contract version type
      * @type {string}
      * @memberof Subscription
      */
-    resumeEffectiveDate: string;
+    versionType?: string;
     /**
-     * Set to extend contract on resume
-     * @type {boolean}
+     * Term of contract in months
+     * @type {string}
      * @memberof Subscription
      */
-    extendOnResume: boolean;
+    contractTerm?: string;
     /**
-     * auto-renew subscription contract
-     * @type {boolean}
+     * Length of time Subscription Contract will be renewed for
+     * @type {string}
      * @memberof Subscription
      */
-    autoRenew: boolean;
+    renewalTerm?: string;
     /**
-     * currency
+     * Date Subscription Contract will start
      * @type {string}
      * @memberof Subscription
      */
-    currency: string;
+    currentTermStartDate?: string;
     /**
-     * Calculate due date of invoice
+     * Date subscription contract will end
      * @type {string}
      * @memberof Subscription
      */
-    paymentTerms: string;
+    currentTermEndDate?: string;
     /**
-     * Contracted MRR per charge
+     * Date subscription contract was terminated
+     * @type {number}
+     * @memberof Subscription
+     */
+    renewalIncrementPercent?: number;
+    /**
+     * Asset ID
      * @type {string}
      * @memberof Subscription
      */
-    cmrr: string;
+    assetId?: string;
     /**
-     * MRR calculated based on % discount
+     * Id of billing contact
      * @type {string}
      * @memberof Subscription
      */
-    discountedCmrr: string;
+    billContactId?: string;
     /**
-     * separate invoice generated
-     * @type {boolean}
+     * Id of shipping contact
+     * @type {string}
      * @memberof Subscription
      */
-    separateInvoice: boolean;
+    shippingContactId?: string;
     /**
-     * Miscellaneous notes
+     * Date record was created
      * @type {string}
      * @memberof Subscription
      */
-    notes: string;
+    updatedAt?: string;
     /**
-     * Version of subscription contract
-     * @type {number}
+     * Date record was created
+     * @type {string}
      * @memberof Subscription
      */
-    version: number;
+    createdAt?: string;
     /**
-     * Subscription contract version type
+     * Email of user who created record
      * @type {string}
      * @memberof Subscription
      */
-    versionType: string;
+    createdBy?: string;
     /**
-     * Term of contract in months
+     * Email of user who last modifed record
      * @type {string}
      * @memberof Subscription
      */
-    contractTerm: string;
+    updatedBy?: string;
     /**
-     * Date subscription contract will start
-     * @type {number}
+     * Custom fields on the invoice
+     * @type {object}
      * @memberof Subscription
      */
-    renewalIncrementPercent: number;
+    customFields?: object;
     /**
      * Total contract value of the subsctiption contract
      * @type {number}
      * @memberof Subscription
      */
-    tcv: number;
+    tcv?: number;
     /**
-     * Subscription charge details
-     * @type {Array<SubscriptionCharge>}
+     * Set to defer start date
+     * @type {boolean}
      * @memberof Subscription
      */
-    charges: Array<SubscriptionCharge>;
+    deferStartDate?: boolean;
     /**
-     * Date record was created
+     * Subscription ID
      * @type {string}
      * @memberof Subscription
      */
-    createdAt: string;
+    id: string;
     /**
-     * Date record was created
+     * Customer ID
      * @type {string}
      * @memberof Subscription
      */
-    updatedAt: string;
+    externalCustomerId: string;
     /**
-     * Email of user who created record
+     * Customer name
      * @type {string}
      * @memberof Subscription
      */
-    createdBy: string;
+    customerName: string;
     /**
-     * Email of user who last modifed record
+     * Id of billing contact
      * @type {string}
      * @memberof Subscription
      */
-    updatedBy: string;
+    externalBillContactId: string;
     /**
-     * Id of billing contact sf
+     * Id of shipping contact
      * @type {string}
      * @memberof Subscription
      */
-    billContactSfId: string;
+    externalShippingContactId: string;
     /**
-     * Id of shipping contact sf
+     * Date subscription contract to pause
      * @type {string}
      * @memberof Subscription
      */
-    shippingContactSfId: string;
+    pauseEffectiveDate: string;
     /**
-     * Custom fields on the invoice
-     * @type {object}
+     * Date subscription contract to resume
+     * @type {string}
      * @memberof Subscription
      */
-    customFields: object;
+    resumeEffectiveDate: string;
     /**
-     * Asset ID
+     * Set to extend contract on resume
+     * @type {boolean}
+     * @memberof Subscription
+     */
+    extendOnResume: boolean;
+    /**
+     * Id of billing contact sf
      * @type {string}
      * @memberof Subscription
      */
-    assetId?: string;
+    billContactSfId: string;
+    /**
+     * Id of shipping contact sf
+     * @type {string}
+     * @memberof Subscription
+     */
+    shippingContactSfId: string;
     /**
      * Site ID
      * @type {string}
@@ -255,6 +291,12 @@ export interface Subscription {
      * @memberof Subscription
      */
     externalId: string;
+    /**
+     * Charges associated the subscription
+     * @type {Array<SubscriptionCharge>}
+     * @memberof Subscription
+     */
+    charges: Array<SubscriptionCharge>;
 }
 
 /**
@@ -266,38 +308,14 @@ export function instanceOfSubscription(value: object): value is Subscription {
     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 (!('status' in value) || value['status'] === undefined) return false;
-    if (!('deferStartDate' in value) || value['deferStartDate'] === undefined) return false;
-    if (!('billingStartDate' in value) || value['billingStartDate'] === undefined) return false;
-    if (!('serviceStartDate' in value) || value['serviceStartDate'] === undefined) return false;
-    if (!('orderPlacedAt' in value) || value['orderPlacedAt'] === undefined) return false;
-    if (!('contractEffectiveDate' in value) || value['contractEffectiveDate'] === undefined) return false;
-    if (!('cancellationDate' in value) || value['cancellationDate'] === 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 (!('autoRenew' in value) || value['autoRenew'] === undefined) return false;
-    if (!('currency' in value) || value['currency'] === undefined) return false;
-    if (!('paymentTerms' in value) || value['paymentTerms'] === undefined) return false;
-    if (!('cmrr' in value) || value['cmrr'] === undefined) return false;
-    if (!('discountedCmrr' in value) || value['discountedCmrr'] === undefined) return false;
-    if (!('separateInvoice' in value) || value['separateInvoice'] === undefined) return false;
-    if (!('notes' in value) || value['notes'] === undefined) return false;
-    if (!('version' in value) || value['version'] === undefined) return false;
-    if (!('versionType' in value) || value['versionType'] === undefined) return false;
-    if (!('contractTerm' in value) || value['contractTerm'] === undefined) return false;
-    if (!('renewalIncrementPercent' in value) || value['renewalIncrementPercent'] === undefined) return false;
-    if (!('tcv' in value) || value['tcv'] === undefined) return false;
-    if (!('charges' in value) || value['charges'] === 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 (!('billContactSfId' in value) || value['billContactSfId'] === undefined) return false;
     if (!('shippingContactSfId' in value) || value['shippingContactSfId'] === undefined) return false;
-    if (!('customFields' in value) || value['customFields'] === 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;
     return true;
 }
 
@@ -311,44 +329,51 @@ export function SubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolea
     }
     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'],
-        'status': json['status'],
-        'deferStartDate': json['deferStartDate'],
-        'billingStartDate': json['billingStartDate'],
-        'serviceStartDate': json['serviceStartDate'],
-        'orderPlacedAt': json['orderPlacedAt'],
-        'contractEffectiveDate': json['contractEffectiveDate'],
-        'cancellationDate': json['cancellationDate'],
         'pauseEffectiveDate': json['pauseEffectiveDate'],
         'resumeEffectiveDate': json['resumeEffectiveDate'],
         'extendOnResume': json['extendOnResume'],
-        'autoRenew': json['autoRenew'],
-        'currency': json['currency'],
-        'paymentTerms': json['paymentTerms'],
-        'cmrr': json['cmrr'],
-        'discountedCmrr': json['discountedCmrr'],
-        'separateInvoice': json['separateInvoice'],
-        'notes': json['notes'],
-        'version': json['version'],
-        'versionType': json['versionType'],
-        'contractTerm': json['contractTerm'],
-        'renewalIncrementPercent': json['renewalIncrementPercent'],
-        'tcv': json['tcv'],
-        'charges': ((json['charges'] as Array<any>).map(SubscriptionChargeFromJSON)),
-        'createdAt': json['createdAt'],
-        'updatedAt': json['updatedAt'],
-        'createdBy': json['createdBy'],
-        'updatedBy': json['updatedBy'],
         'billContactSfId': json['billContactSfId'],
         'shippingContactSfId': json['shippingContactSfId'],
-        'customFields': json['customFields'],
-        'assetId': json['assetId'] == null ? undefined : json['assetId'],
         'siteId': json['siteId'],
         'externalId': json['externalId'],
+        'charges': ((json['charges'] as Array<any>).map(SubscriptionChargeFromJSON)),
     };
 }
 
@@ -363,21 +388,13 @@ export function SubscriptionToJSONTyped(value?: Subscription | null, ignoreDiscr
 
     return {
         
-        'id': value['id'],
-        'externalCustomerId': value['externalCustomerId'],
-        'customerName': value['customerName'],
-        'externalBillContactId': value['externalBillContactId'],
-        'externalShippingContactId': value['externalShippingContactId'],
         'status': value['status'],
-        'deferStartDate': value['deferStartDate'],
         'billingStartDate': value['billingStartDate'],
         'serviceStartDate': value['serviceStartDate'],
         'orderPlacedAt': value['orderPlacedAt'],
         'contractEffectiveDate': value['contractEffectiveDate'],
         'cancellationDate': value['cancellationDate'],
-        'pauseEffectiveDate': value['pauseEffectiveDate'],
-        'resumeEffectiveDate': value['resumeEffectiveDate'],
-        'extendOnResume': value['extendOnResume'],
+        'cancellationType': value['cancellationType'],
         'autoRenew': value['autoRenew'],
         'currency': value['currency'],
         'paymentTerms': value['paymentTerms'],
@@ -385,22 +402,37 @@ export function SubscriptionToJSONTyped(value?: Subscription | null, ignoreDiscr
         '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'],
-        'tcv': value['tcv'],
-        'charges': ((value['charges'] as Array<any>).map(SubscriptionChargeToJSON)),
-        'createdAt': value['createdAt'],
+        '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'],
-        'customFields': value['customFields'],
-        'assetId': value['assetId'],
         'siteId': value['siteId'],
         'externalId': value['externalId'],
+        'charges': ((value['charges'] as Array<any>).map(SubscriptionChargeToJSON)),
     };
 }