@managespace/sdk 0.0.118 → 0.0.120

package/src/generated/models/index.ts

@@ -51,7 +51,7 @@ export * from './create-revenue-rule';
 export * from './create-site-custom';
 export * from './create-smart-bar-prompt';
 export * from './create-subscription';
-export * from './create-subscription-plan';
+export * from './create-subscription-charge';
 export * from './create-task';
 export * from './create-task-template';
 export * from './create-template';
@@ -162,7 +162,7 @@ export * from './statement';
 export * from './step-data';
 export * from './sub-total';
 export * from './subscription';
-export * from './subscription-plan';
+export * from './subscription-charge';
 export * from './success';
 export * from './task';
 export * from './task-completion-status';

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

@@ -45,6 +45,12 @@ export interface PlanCustom {
      * @memberof PlanCustom
      */
     status?: string;
+    /**
+     * Indicated whether it is the default product or not
+     * @type {boolean}
+     * @memberof PlanCustom
+     */
+    isDefault?: boolean;
     /**
      * Plan ID
      * @type {string}
@@ -82,6 +88,7 @@ export function PlanCustomFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'name': json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'status': json['status'] == null ? undefined : json['status'],
+        'isDefault': json['isDefault'] == null ? undefined : json['isDefault'],
         'id': json['id'],
         'charges': ((json['charges'] as Array<any>).map(ChargeFromJSON)),
     };
@@ -101,6 +108,7 @@ export function PlanCustomToJSONTyped(value?: PlanCustom | null, ignoreDiscrimin
         'name': value['name'],
         'description': value['description'],
         'status': value['status'],
+        'isDefault': value['isDefault'],
         'id': value['id'],
         'charges': ((value['charges'] as Array<any>).map(ChargeToJSON)),
     };

package/src/generated/models/product-custom.ts

@@ -51,6 +51,12 @@ export interface ProductCustom {
      * @memberof ProductCustom
      */
     taxable?: boolean;
+    /**
+     * Indicated whether it is the default product or not
+     * @type {boolean}
+     * @memberof ProductCustom
+     */
+    isDefault?: boolean;
     /**
      * Description of product
      * @type {string}
@@ -93,12 +99,6 @@ export interface ProductCustom {
      * @memberof ProductCustom
      */
     incomeAccount?: string;
-    /**
-     * Select which tax group to be used
-     * @type {string}
-     * @memberof ProductCustom
-     */
-    productTaxGroupName?: string;
     /**
      * Product ID
      * @type {string}
@@ -134,6 +134,7 @@ export function ProductCustomFromJSONTyped(json: any, ignoreDiscriminator: boole
         'sku': json['sku'] == null ? undefined : json['sku'],
         'status': json['status'] == null ? undefined : json['status'],
         'taxable': json['taxable'] == null ? undefined : json['taxable'],
+        'isDefault': json['isDefault'] == null ? undefined : json['isDefault'],
         'description': json['description'] == null ? undefined : json['description'],
         'price': json['price'],
         'revenueRuleId': json['revenueRuleId'],
@@ -141,7 +142,6 @@ export function ProductCustomFromJSONTyped(json: any, ignoreDiscriminator: boole
         'transactionPostingEntries': ((json['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
         'customFields': json['customFields'] == null ? undefined : json['customFields'],
         'incomeAccount': json['incomeAccount'] == null ? undefined : json['incomeAccount'],
-        'productTaxGroupName': json['productTaxGroupName'] == null ? undefined : json['productTaxGroupName'],
         'id': json['id'],
     };
 }
@@ -161,6 +161,7 @@ export function ProductCustomToJSONTyped(value?: ProductCustom | null, ignoreDis
         'sku': value['sku'],
         'status': value['status'],
         'taxable': value['taxable'],
+        'isDefault': value['isDefault'],
         'description': value['description'],
         'price': value['price'],
         'revenueRuleId': value['revenueRuleId'],
@@ -168,7 +169,6 @@ export function ProductCustomToJSONTyped(value?: ProductCustom | null, ignoreDis
         'transactionPostingEntries': ((value['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesToJSON)),
         'customFields': value['customFields'],
         'incomeAccount': value['incomeAccount'],
-        'productTaxGroupName': value['productTaxGroupName'],
         'id': value['id'],
     };
 }

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

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

package/src/generated/models/subscription.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { SubscriptionPlan } from './subscription-plan';
+import type { SubscriptionCharge } from './subscription-charge';
 import {
-    SubscriptionPlanFromJSON,
-    SubscriptionPlanFromJSONTyped,
-    SubscriptionPlanToJSON,
-    SubscriptionPlanToJSONTyped,
-} from './subscription-plan';
+    SubscriptionChargeFromJSON,
+    SubscriptionChargeFromJSONTyped,
+    SubscriptionChargeToJSON,
+    SubscriptionChargeToJSONTyped,
+} from './subscription-charge';
 
 /**
  * 
@@ -190,11 +190,11 @@ export interface Subscription {
      */
     tcv: number;
     /**
-     * Subscription plan details
-     * @type {Array<SubscriptionPlan>}
+     * Subscription charge details
+     * @type {Array<SubscriptionCharge>}
      * @memberof Subscription
      */
-    plans: Array<SubscriptionPlan>;
+    charges: Array<SubscriptionCharge>;
     /**
      * Date record was created
      * @type {string}
@@ -288,7 +288,7 @@ export function instanceOfSubscription(value: object): value is Subscription {
     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 (!('plans' in value) || value['plans'] === 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;
@@ -338,7 +338,7 @@ export function SubscriptionFromJSONTyped(json: any, ignoreDiscriminator: boolea
         'contractTerm': json['contractTerm'],
         'renewalIncrementPercent': json['renewalIncrementPercent'],
         'tcv': json['tcv'],
-        'plans': ((json['plans'] as Array<any>).map(SubscriptionPlanFromJSON)),
+        'charges': ((json['charges'] as Array<any>).map(SubscriptionChargeFromJSON)),
         'createdAt': json['createdAt'],
         'updatedAt': json['updatedAt'],
         'createdBy': json['createdBy'],
@@ -390,7 +390,7 @@ export function SubscriptionToJSONTyped(value?: Subscription | null, ignoreDiscr
         'contractTerm': value['contractTerm'],
         'renewalIncrementPercent': value['renewalIncrementPercent'],
         'tcv': value['tcv'],
-        'plans': ((value['plans'] as Array<any>).map(SubscriptionPlanToJSON)),
+        'charges': ((value['charges'] as Array<any>).map(SubscriptionChargeToJSON)),
         'createdAt': value['createdAt'],
         'updatedAt': value['updatedAt'],
         'createdBy': value['createdBy'],

package/.turbo/turbo-build.log

@@ -1,2 +0,0 @@
-
-$ tsc