@managespace/sdk 0.0.119 → 0.0.120

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

@@ -1,438 +0,0 @@
-/* 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';
-import type { ChargeTier } from './charge-tier';
-import {
-    ChargeTierFromJSON,
-    ChargeTierFromJSONTyped,
-    ChargeTierToJSON,
-    ChargeTierToJSONTyped,
-} from './charge-tier';
-
-/**
- * 
- * @export
- * @interface SubscriptionPlan
- */
-export interface SubscriptionPlan {
-    /**
-     * Product ID
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    productId: string;
-    /**
-     * Name of product
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    productName?: string;
-    /**
-     * Plan ID
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    planId: string;
-    /**
-     * Name of plan
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    planName?: string;
-    /**
-     * Charge ID
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    chargeId: string;
-    /**
-     * Name of charge
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    chargeName: string;
-    /**
-     * How charge will be priced
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    pricingModel?: string;
-    /**
-     * Original unit price of Charge
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    listPrice?: string;
-    /**
-     * How charge will be priced
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    priceBase?: string;
-    /**
-     * Quantity of item included
-     * @type {number}
-     * @memberof SubscriptionPlan
-     */
-    quantity?: number;
-    /**
-     * Number of units included in plan
-     * @type {number}
-     * @memberof SubscriptionPlan
-     */
-    includedUnits?: number;
-    /**
-     * Discount applied to product
-     * @type {number}
-     * @memberof SubscriptionPlan
-     */
-    discount?: number;
-    /**
-     * Effective price of product
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    effectivePrice?: string;
-    /**
-     * Type of charge
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    chargeType?: string;
-    /**
-     * Billing period for recurring and usage based Charges
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    billingPeriod?: string;
-    /**
-     * For recurrign charges, when the charge is billed
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    chargeTiming?: string;
-    /**
-     * Determine boundary of Charge period
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    billingPeriodStartAlignment?: string;
-    /**
-     * Which day of the month or week Charge is invoiced
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    billingDay?: string;
-    /**
-     * Charge for partial periods
-     * @type {boolean}
-     * @memberof SubscriptionPlan
-     */
-    proratePartialPeriods?: boolean;
-    /**
-     * Number of periods/units to charge
-     * @type {number}
-     * @memberof SubscriptionPlan
-     */
-    prepaymentPeriods?: number;
-    /**
-     * For usage charges, number of prepayment units
-     * @type {number}
-     * @memberof SubscriptionPlan
-     */
-    prepaymentAmount?: number;
-    /**
-     * For one time charges, when billing will happen
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    chargeBillingDate?: string;
-    /**
-     * For one time charges, display completion date if chosen as charge effective date
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    completionDate?: string;
-    /**
-     * Unique subscription line id
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    subscriptionLineId?: string;
-    /**
-     * start date of current period
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    currentPeriodStartDate?: string;
-    /**
-     * end date of current period
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    currentPeriodEndDate?: string;
-    /**
-     * Unique billing schedule id
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    billingScheduleId?: string;
-    /**
-     * Charge end date
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    chargeEndDate?: string;
-    /**
-     * Date subscription contract will start
-     * @type {number}
-     * @memberof SubscriptionPlan
-     */
-    renewalIncrementPercent?: number;
-    /**
-     * Override automatic renewal increment percent
-     * @type {boolean}
-     * @memberof SubscriptionPlan
-     */
-    overrideRenewalIncrementPercent?: boolean;
-    /**
-     * Charge start date
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    chargeStartDate?: string;
-    /**
-     * Unit of measure
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    unitOfMeasure?: string;
-    /**
-     * Unique revenue schedule id
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    revenueScheduleId?: string;
-    /**
-     * Determines proration logic
-     * @type {boolean}
-     * @memberof SubscriptionPlan
-     */
-    backchargeCurrentPeriod?: boolean;
-    /**
-     * For tiered/volume pricing, each tier will represent price of specific units in given range
-     * @type {Array<ChargeTier>}
-     * @memberof SubscriptionPlan
-     */
-    tiers?: Array<ChargeTier>;
-    /**
-     * Last charge date
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    lastChargeDate?: string;
-    /**
-     * Accounting information can be overridden
-     * @type {boolean}
-     * @memberof SubscriptionPlan
-     */
-    defaultFromPlan?: boolean;
-    /**
-     * Contracted MRR per charge
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    cmrr?: string;
-    /**
-     * Revenue rule ID
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    revenueRuleId?: string;
-    /**
-     * Date when revenue recognition will begin
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    recognitionStartDate?: string;
-    /**
-     * Date to customize revenue recognition Start
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    customRecognitionStartDate?: string;
-    /**
-     * For one-time charge, date to customize revenue recognition End
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    customRecognitionEndDate?: string;
-    /**
-     * Transaction type
-     * @type {Array<TransactionPostingEntries>}
-     * @memberof SubscriptionPlan
-     */
-    transactionPostingEntries?: Array<TransactionPostingEntries>;
-    /**
-     * Asset ID
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    assetId: string;
-    /**
-     * MRR calculated based on % discount
-     * @type {string}
-     * @memberof SubscriptionPlan
-     */
-    discountedCmrr: string;
-}
-
-/**
- * Check if a given object implements the SubscriptionPlan interface.
- */
-export function instanceOfSubscriptionPlan(value: object): value is SubscriptionPlan {
-    if (!('productId' in value) || value['productId'] === undefined) return false;
-    if (!('planId' in value) || value['planId'] === undefined) return false;
-    if (!('chargeId' in value) || value['chargeId'] === undefined) return false;
-    if (!('chargeName' in value) || value['chargeName'] === undefined) return false;
-    if (!('assetId' in value) || value['assetId'] === undefined) return false;
-    if (!('discountedCmrr' in value) || value['discountedCmrr'] === undefined) return false;
-    return true;
-}
-
-export function SubscriptionPlanFromJSON(json: any): SubscriptionPlan {
-    return SubscriptionPlanFromJSONTyped(json, false);
-}
-
-export function SubscriptionPlanFromJSONTyped(json: any, ignoreDiscriminator: boolean): SubscriptionPlan {
-    if (json == null) {
-        return json;
-    }
-    return {
-        
-        'productId': json['productId'],
-        'productName': json['productName'] == null ? undefined : json['productName'],
-        'planId': json['planId'],
-        'planName': json['planName'] == null ? undefined : json['planName'],
-        'chargeId': json['chargeId'],
-        'chargeName': json['chargeName'],
-        'pricingModel': json['pricingModel'] == null ? undefined : json['pricingModel'],
-        'listPrice': json['listPrice'] == null ? undefined : json['listPrice'],
-        'priceBase': json['priceBase'] == null ? undefined : json['priceBase'],
-        'quantity': json['quantity'] == null ? undefined : json['quantity'],
-        'includedUnits': json['includedUnits'] == null ? undefined : json['includedUnits'],
-        'discount': json['discount'] == null ? undefined : json['discount'],
-        'effectivePrice': json['effectivePrice'] == null ? undefined : json['effectivePrice'],
-        'chargeType': json['chargeType'] == null ? undefined : json['chargeType'],
-        'billingPeriod': json['billingPeriod'] == null ? undefined : json['billingPeriod'],
-        'chargeTiming': json['chargeTiming'] == null ? undefined : json['chargeTiming'],
-        'billingPeriodStartAlignment': json['billingPeriodStartAlignment'] == null ? undefined : json['billingPeriodStartAlignment'],
-        'billingDay': json['billingDay'] == null ? undefined : json['billingDay'],
-        'proratePartialPeriods': json['proratePartialPeriods'] == null ? undefined : json['proratePartialPeriods'],
-        'prepaymentPeriods': json['prepaymentPeriods'] == null ? undefined : json['prepaymentPeriods'],
-        'prepaymentAmount': json['prepaymentAmount'] == null ? undefined : json['prepaymentAmount'],
-        'chargeBillingDate': json['chargeBillingDate'] == null ? undefined : json['chargeBillingDate'],
-        'completionDate': json['completionDate'] == null ? undefined : json['completionDate'],
-        'subscriptionLineId': json['subscriptionLineId'] == null ? undefined : json['subscriptionLineId'],
-        'currentPeriodStartDate': json['currentPeriodStartDate'] == null ? undefined : json['currentPeriodStartDate'],
-        'currentPeriodEndDate': json['currentPeriodEndDate'] == null ? undefined : json['currentPeriodEndDate'],
-        'billingScheduleId': json['billingScheduleId'] == null ? undefined : json['billingScheduleId'],
-        'chargeEndDate': json['chargeEndDate'] == null ? undefined : json['chargeEndDate'],
-        'renewalIncrementPercent': json['renewalIncrementPercent'] == null ? undefined : json['renewalIncrementPercent'],
-        'overrideRenewalIncrementPercent': json['overrideRenewalIncrementPercent'] == null ? undefined : json['overrideRenewalIncrementPercent'],
-        'chargeStartDate': json['chargeStartDate'] == null ? undefined : json['chargeStartDate'],
-        'unitOfMeasure': json['unitOfMeasure'] == null ? undefined : json['unitOfMeasure'],
-        'revenueScheduleId': json['revenueScheduleId'] == null ? undefined : json['revenueScheduleId'],
-        'backchargeCurrentPeriod': json['backchargeCurrentPeriod'] == null ? undefined : json['backchargeCurrentPeriod'],
-        'tiers': json['tiers'] == null ? undefined : ((json['tiers'] as Array<any>).map(ChargeTierFromJSON)),
-        'lastChargeDate': json['lastChargeDate'] == null ? undefined : json['lastChargeDate'],
-        'defaultFromPlan': json['defaultFromPlan'] == null ? undefined : json['defaultFromPlan'],
-        'cmrr': json['cmrr'] == null ? undefined : json['cmrr'],
-        'revenueRuleId': json['revenueRuleId'] == null ? undefined : json['revenueRuleId'],
-        'recognitionStartDate': json['recognitionStartDate'] == null ? undefined : json['recognitionStartDate'],
-        'customRecognitionStartDate': json['customRecognitionStartDate'] == null ? undefined : json['customRecognitionStartDate'],
-        'customRecognitionEndDate': json['customRecognitionEndDate'] == null ? undefined : json['customRecognitionEndDate'],
-        'transactionPostingEntries': json['transactionPostingEntries'] == null ? undefined : ((json['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
-        'assetId': json['assetId'],
-        'discountedCmrr': json['discountedCmrr'],
-    };
-}
-
-export function SubscriptionPlanToJSON(json: any): SubscriptionPlan {
-    return SubscriptionPlanToJSONTyped(json, false);
-}
-
-export function SubscriptionPlanToJSONTyped(value?: SubscriptionPlan | null, ignoreDiscriminator: boolean = false): any {
-    if (value == null) {
-        return value;
-    }
-
-    return {
-        
-        'productId': value['productId'],
-        'productName': value['productName'],
-        'planId': value['planId'],
-        'planName': value['planName'],
-        'chargeId': value['chargeId'],
-        'chargeName': value['chargeName'],
-        'pricingModel': value['pricingModel'],
-        'listPrice': value['listPrice'],
-        'priceBase': value['priceBase'],
-        'quantity': value['quantity'],
-        'includedUnits': value['includedUnits'],
-        'discount': value['discount'],
-        'effectivePrice': value['effectivePrice'],
-        'chargeType': value['chargeType'],
-        'billingPeriod': value['billingPeriod'],
-        'chargeTiming': value['chargeTiming'],
-        'billingPeriodStartAlignment': value['billingPeriodStartAlignment'],
-        'billingDay': value['billingDay'],
-        'proratePartialPeriods': value['proratePartialPeriods'],
-        'prepaymentPeriods': value['prepaymentPeriods'],
-        'prepaymentAmount': value['prepaymentAmount'],
-        'chargeBillingDate': value['chargeBillingDate'],
-        'completionDate': value['completionDate'],
-        'subscriptionLineId': value['subscriptionLineId'],
-        'currentPeriodStartDate': value['currentPeriodStartDate'],
-        'currentPeriodEndDate': value['currentPeriodEndDate'],
-        'billingScheduleId': value['billingScheduleId'],
-        'chargeEndDate': value['chargeEndDate'],
-        'renewalIncrementPercent': value['renewalIncrementPercent'],
-        'overrideRenewalIncrementPercent': value['overrideRenewalIncrementPercent'],
-        'chargeStartDate': value['chargeStartDate'],
-        'unitOfMeasure': value['unitOfMeasure'],
-        'revenueScheduleId': value['revenueScheduleId'],
-        'backchargeCurrentPeriod': value['backchargeCurrentPeriod'],
-        'tiers': value['tiers'] == null ? undefined : ((value['tiers'] as Array<any>).map(ChargeTierToJSON)),
-        'lastChargeDate': value['lastChargeDate'],
-        'defaultFromPlan': value['defaultFromPlan'],
-        'cmrr': value['cmrr'],
-        'revenueRuleId': value['revenueRuleId'],
-        'recognitionStartDate': value['recognitionStartDate'],
-        'customRecognitionStartDate': value['customRecognitionStartDate'],
-        'customRecognitionEndDate': value['customRecognitionEndDate'],
-        'transactionPostingEntries': value['transactionPostingEntries'] == null ? undefined : ((value['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesToJSON)),
-        'assetId': value['assetId'],
-        'discountedCmrr': value['discountedCmrr'],
-    };
-}
-