@managespace/sdk 0.0.124 → 0.0.125

package/src/generated/models/update-subscription-charge.ts

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