@managespace/sdk 0.0.118 → 0.0.119

package/dist/generated/models/create-subscription-charge.d.ts

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

package/dist/generated/models/create-subscription-charge.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-subscription-charge.d.ts","sourceRoot":"","sources":["../../../src/generated/models/create-subscription-charge.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAO/E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAQhD;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACrC;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IACrC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAC;IAC1C;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IAC1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;;;OAIG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7D;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,wBAAgB,kCAAkC,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,IAAI,wBAAwB,CAOnG;AAED,wBAAgB,gCAAgC,CAAC,IAAI,EAAE,GAAG,GAAG,wBAAwB,CAEpF;AAED,wBAAgB,qCAAqC,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,wBAAwB,CAmDvH;AAED,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,GAAG,GAAG,wBAAwB,CAElF;AAED,wBAAgB,mCAAmC,CAAC,KAAK,CAAC,EAAE,wBAAwB,GAAG,IAAI,EAAE,mBAAmB,GAAE,OAAe,GAAG,GAAG,CAoDtI"}

package/dist/generated/models/create-subscription-charge.js

@@ -0,0 +1,147 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateSubscriptionChargeToJSONTyped = exports.CreateSubscriptionChargeToJSON = exports.CreateSubscriptionChargeFromJSONTyped = exports.CreateSubscriptionChargeFromJSON = exports.instanceOfCreateSubscriptionCharge = void 0;
+const transaction_posting_entries_1 = require("./transaction-posting-entries");
+const charge_tier_1 = require("./charge-tier");
+/**
+ * Check if a given object implements the CreateSubscriptionCharge interface.
+ */
+function instanceOfCreateSubscriptionCharge(value) {
+    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;
+    return true;
+}
+exports.instanceOfCreateSubscriptionCharge = instanceOfCreateSubscriptionCharge;
+function CreateSubscriptionChargeFromJSON(json) {
+    return CreateSubscriptionChargeFromJSONTyped(json, false);
+}
+exports.CreateSubscriptionChargeFromJSON = CreateSubscriptionChargeFromJSON;
+function CreateSubscriptionChargeFromJSONTyped(json, ignoreDiscriminator) {
+    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'].map(charge_tier_1.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'].map(transaction_posting_entries_1.TransactionPostingEntriesFromJSON)),
+        'assetId': json['assetId'],
+    };
+}
+exports.CreateSubscriptionChargeFromJSONTyped = CreateSubscriptionChargeFromJSONTyped;
+function CreateSubscriptionChargeToJSON(json) {
+    return CreateSubscriptionChargeToJSONTyped(json, false);
+}
+exports.CreateSubscriptionChargeToJSON = CreateSubscriptionChargeToJSON;
+function CreateSubscriptionChargeToJSONTyped(value, ignoreDiscriminator = false) {
+    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'].map(charge_tier_1.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'].map(transaction_posting_entries_1.TransactionPostingEntriesToJSON)),
+        'assetId': value['assetId'],
+    };
+}
+exports.CreateSubscriptionChargeToJSONTyped = CreateSubscriptionChargeToJSONTyped;