@managespace/sdk 0.0.118 → 0.1.0

package/src/generated/models/subscription-plan-response.ts

@@ -0,0 +1,425 @@
+/* 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 { TransactionPostingEntries } from './transaction-posting-entries';
+import {
+    TransactionPostingEntriesFromJSON,
+    TransactionPostingEntriesFromJSONTyped,
+    TransactionPostingEntriesToJSON,
+    TransactionPostingEntriesToJSONTyped,
+} from './transaction-posting-entries';
+
+/**
+ * 
+ * @export
+ * @interface SubscriptionPlanResponse
+ */
+export interface SubscriptionPlanResponse {
+    /**
+     * Product ID
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    externalProductId: string;
+    /**
+     * Name of product
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    productName: string;
+    /**
+     * Plan ID
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    externalPlanId: string;
+    /**
+     * Name of plan
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    planName: string;
+    /**
+     * Unique subscription line id
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    subscriptionLineId: string;
+    /**
+     * Charge ID
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    externalChargeId: string;
+    /**
+     * Name of charge
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    chargeName: string;
+    /**
+     * How charge will be priced
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    pricingModel: string;
+    /**
+     * Original unit price of Charge
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    listPrice: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    listPriceBase: string;
+    /**
+     * How charge will be priced
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    priceBase: string;
+    /**
+     * Quantity of item included
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    quantity: number;
+    /**
+     * Number of units included in plan
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    includedUnits: number;
+    /**
+     * Discount applied to product
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    discount: number;
+    /**
+     * Effective price of product
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    effectivePrice: string;
+    /**
+     * Type of charge
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    chargeType: string;
+    /**
+     * Billing period for recurring and usage based Charges
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    billingPeriod: string;
+    /**
+     * Unit of measure
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    unitOfMeasure: string;
+    /**
+     * start date of current period
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    currentPeriodStartDate: string;
+    /**
+     * end date of current period
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    currentPeriodEndDate: string;
+    /**
+     * Unique billing schedule id
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    billingScheduleId: string;
+    /**
+     * Unique revenue schedule id
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    revenueScheduleId: string;
+    /**
+     * For recurrign charges, when the charge is billed
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    chargeTiming: string;
+    /**
+     * Determine boundary of Charge period
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    billingPeriodStartAlignment: string;
+    /**
+     * Which day of the month or week Charge is invoiced
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    billingDay: string;
+    /**
+     * Charge for partial periods
+     * @type {boolean}
+     * @memberof SubscriptionPlanResponse
+     */
+    proratePartialPeriods: boolean;
+    /**
+     * Determines proration logic
+     * @type {boolean}
+     * @memberof SubscriptionPlanResponse
+     */
+    backchargeCurrentPeriod: boolean;
+    /**
+     * Number of periods/units to charge
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    prepaymentPeriods: number;
+    /**
+     * Contracted MRR per charge
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    cmrr: string;
+    /**
+     * MRR calculated based on % discount
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    discountedCmrr: string;
+    /**
+     * Charge start date
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    chargeStartDate: string;
+    /**
+     * Charge end date
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    chargeEndDate: string;
+    /**
+     * Date subscription contract will start
+     * @type {number}
+     * @memberof SubscriptionPlanResponse
+     */
+    renewalIncrementPercent: number;
+    /**
+     * Override automatic renewal increment percent
+     * @type {boolean}
+     * @memberof SubscriptionPlanResponse
+     */
+    overrideRenewalIncrementPercent: boolean;
+    /**
+     * Accounting information can be overridden
+     * @type {boolean}
+     * @memberof SubscriptionPlanResponse
+     */
+    defaultFromPlan: boolean;
+    /**
+     * Revenue rule ID
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    revenueRuleId: string;
+    /**
+     * Date when revenue recognition will begin
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    recognitionStartDate: string;
+    /**
+     * Date when revenue recognition will begin
+     * @type {string}
+     * @memberof SubscriptionPlanResponse
+     */
+    recognitionEndDate: string;
+    /**
+     * Transaction type
+     * @type {Array<TransactionPostingEntries>}
+     * @memberof SubscriptionPlanResponse
+     */
+    transactionPostingEntries: Array<TransactionPostingEntries>;
+    /**
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof SubscriptionPlanResponse
+     */
+    customFields: object;
+}
+
+/**
+ * Check if a given object implements the SubscriptionPlanResponse interface.
+ */
+export function instanceOfSubscriptionPlanResponse(value: object): value is SubscriptionPlanResponse {
+    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;
+}
+
+export function SubscriptionPlanResponseFromJSON(json: any): SubscriptionPlanResponse {
+    return SubscriptionPlanResponseFromJSONTyped(json, false);
+}
+
+export function SubscriptionPlanResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPlanResponse {
+    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'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
+        'customFields': json['customFields'],
+    };
+}
+
+export function SubscriptionPlanResponseToJSON(json: any): SubscriptionPlanResponse {
+    return SubscriptionPlanResponseToJSONTyped(json, false);
+}
+
+export function SubscriptionPlanResponseToJSONTyped(value?: SubscriptionPlanResponse | null, ignoreDiscriminator: boolean = false): any {
+    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'] as Array<any>).map(TransactionPostingEntriesToJSON)),
+        'customFields': value['customFields'],
+    };
+}
+