@managespace/sdk 0.0.113 → 0.0.115

package/package.deploy.json

@@ -0,0 +1,33 @@
+{
+    "name": "@managespace/sdk",
+    "version": "0.0.106",
+    "scripts": {
+        "dev": "tsc -w --preserveWatchOutput",
+        "build": "tsc",
+        "lint:check": "eslint .",
+        "lint:fix": "eslint --fix .",
+        "upload": "tsc && npm publish"
+    },
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        },
+        "./*": {
+            "types": "./dist/index.d.ts",
+            "default": "./dist/index.js"
+        }
+    },
+    "dependencies": {
+        "tslib": "^2.4.0",
+        "zod": "^3.23.8"
+    },
+    "devDependencies": {
+        "@types/node": "^12",
+        "typescript": "^4.0",
+        "@repo/eslint-config": "*",
+        "@repo/typescript-config": "*"
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@managespace/sdk",
-    "version": "0.0.113",
+    "version": "0.0.115",
     "scripts": {
         "dev": "tsc -w --preserveWatchOutput",
         "build": "tsc",
@@ -30,4 +30,4 @@
         "@repo/eslint-config": "*",
         "@repo/typescript-config": "*"
     }
-}
+}

package/src/extensibility/functions/project/billing.ts

@@ -161,7 +161,11 @@ export namespace Billing {
 
     export class GetPlans implements ExtPlugin {
         responseType!: PlanCustom[];
-        payload!: BasePaginationQuery & { name?: string; active?: boolean };
+        payload!: BasePaginationQuery & {
+            name?: string;
+            active?: boolean;
+            isDefault?: boolean;
+        };
     }
 
     export class GetPlan implements ExtPlugin {
@@ -174,7 +178,11 @@ export namespace Billing {
             ProductCustom,
             'org' | 'orgId' | 'site' | 'siteId'
         >[];
-        payload!: BasePaginationQuery & { active?: boolean; name?: string };
+        payload!: BasePaginationQuery & {
+            active?: boolean;
+            name?: string;
+            isDefault?: boolean;
+        };
     }
 
     export class GetProduct implements ExtPlugin {

package/src/generated/apis/default-api.ts

@@ -840,6 +840,7 @@ export interface GetPlansRequest {
     name?: string;
     customerId?: string;
     active?: string;
+    isDefault?: string;
 }
 
 export interface GetPluginsRequest {
@@ -863,6 +864,7 @@ export interface GetProductsRequest {
     limit?: number;
     active?: string;
     name?: string;
+    isDefault?: string;
 }
 
 export interface GetRevenueRuleRequest {
@@ -4817,6 +4819,10 @@ export class DefaultApi extends runtime.BaseAPI {
             queryParameters['active'] = requestParameters['active'];
         }
 
+        if (requestParameters['isDefault'] != null) {
+            queryParameters['isDefault'] = requestParameters['isDefault'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {
@@ -4978,6 +4984,10 @@ export class DefaultApi extends runtime.BaseAPI {
             queryParameters['name'] = requestParameters['name'];
         }
 
+        if (requestParameters['isDefault'] != null) {
+            queryParameters['isDefault'] = requestParameters['isDefault'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {

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

@@ -51,6 +51,12 @@ export interface CreateProductCustom {
      * @memberof CreateProductCustom
      */
     taxable?: boolean;
+    /**
+     * Indicated whether it is the default product or not
+     * @type {boolean}
+     * @memberof CreateProductCustom
+     */
+    isDefault?: boolean;
     /**
      * Description of product
      * @type {string}
@@ -121,6 +127,7 @@ export function CreateProductCustomFromJSONTyped(json: any, ignoreDiscriminator:
         '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'],
@@ -146,6 +153,7 @@ export function CreateProductCustomToJSONTyped(value?: CreateProductCustom | nul
         'sku': value['sku'],
         'status': value['status'],
         'taxable': value['taxable'],
+        'isDefault': value['isDefault'],
         'description': value['description'],
         'price': value['price'],
         'revenueRuleId': value['revenueRuleId'],

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

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

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

@@ -51,6 +51,12 @@ export interface CustomCreatePlan {
      * @memberof CustomCreatePlan
      */
     status?: string;
+    /**
+     * Indicated whether it is the default product or not
+     * @type {boolean}
+     * @memberof CustomCreatePlan
+     */
+    isDefault?: boolean;
 }
 
 /**
@@ -76,6 +82,7 @@ export function CustomCreatePlanFromJSONTyped(json: any, ignoreDiscriminator: bo
         'description': json['description'] == null ? undefined : json['description'],
         'charges': ((json['charges'] as Array<any>).map(CreatePlanChargeFromJSON)),
         'status': json['status'] == null ? undefined : json['status'],
+        'isDefault': json['isDefault'] == null ? undefined : json['isDefault'],
     };
 }
 
@@ -94,6 +101,7 @@ export function CustomCreatePlanToJSONTyped(value?: CustomCreatePlan | null, ign
         'description': value['description'],
         'charges': ((value['charges'] as Array<any>).map(CreatePlanChargeToJSON)),
         'status': value['status'],
+        'isDefault': value['isDefault'],
     };
 }
 

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}
@@ -128,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'],
@@ -154,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'],