@managespace/sdk 0.1.64 → 0.1.66

package/src/generated/models/pending-rate-change.ts

@@ -0,0 +1,286 @@
+/* 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 { PendingRateChangeError } from './pending-rate-change-error';
+import {
+    PendingRateChangeErrorFromJSON,
+    PendingRateChangeErrorFromJSONTyped,
+    PendingRateChangeErrorToJSON,
+    PendingRateChangeErrorToJSONTyped,
+} from './pending-rate-change-error';
+import type { PricingRule } from './pricing-rule';
+import {
+    PricingRuleFromJSON,
+    PricingRuleFromJSONTyped,
+    PricingRuleToJSON,
+    PricingRuleToJSONTyped,
+} from './pricing-rule';
+
+/**
+ * 
+ * @export
+ * @interface PendingRateChange
+ */
+export interface PendingRateChange {
+    /**
+     * Pending Rate Change ID
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    id: string;
+    /**
+     * ID of the pricing rule that created this change
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    ruleId: string;
+    /**
+     * ID of the customer
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    customerId: string;
+    /**
+     * ID of the unit if applicable
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    unitId: string | null;
+    /**
+     * ID of the subscription
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    subscriptionId: string | null;
+    /**
+     * Name of the customer
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    customerName: string;
+    /**
+     * Unit number if applicable
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    unitNumber: string | null;
+    /**
+     * Current rate
+     * @type {number}
+     * @memberof PendingRateChange
+     */
+    currentRate: number;
+    /**
+     * New rate after change
+     * @type {number}
+     * @memberof PendingRateChange
+     */
+    newRate: number;
+    /**
+     * Date when change takes effect
+     * @type {Date}
+     * @memberof PendingRateChange
+     */
+    effectiveDate: Date;
+    /**
+     * Whether this change was manually overridden
+     * @type {boolean}
+     * @memberof PendingRateChange
+     */
+    isOverridden: boolean;
+    /**
+     * Status of the change
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    status: string;
+    /**
+     * Name of the rule that created this change
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    ruleName: string;
+    /**
+     * Site ID
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    siteId: string;
+    /**
+     * Organization ID
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    orgId: string;
+    /**
+     * When the record was created
+     * @type {Date}
+     * @memberof PendingRateChange
+     */
+    createdAt: Date;
+    /**
+     * When the record was last updated
+     * @type {Date}
+     * @memberof PendingRateChange
+     */
+    updatedAt: Date | null;
+    /**
+     * When the change was applied
+     * @type {Date}
+     * @memberof PendingRateChange
+     */
+    appliedAt: Date | null;
+    /**
+     * When the change was cancelled
+     * @type {Date}
+     * @memberof PendingRateChange
+     */
+    cancelledAt: Date | null;
+    /**
+     * ID of the change
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    chargeId: string | null;
+    /**
+     * Name of the charge
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    chargeName: string | null;
+    /**
+     * Product name
+     * @type {string}
+     * @memberof PendingRateChange
+     */
+    productName: string | null;
+    /**
+     * Description of the charge
+     * @type {PricingRule}
+     * @memberof PendingRateChange
+     */
+    rule?: PricingRule;
+    /**
+     * List of errors produced during pending rate change workflow
+     * @type {Array<PendingRateChangeError>}
+     * @memberof PendingRateChange
+     */
+    errors?: Array<PendingRateChangeError>;
+}
+
+/**
+ * Check if a given object implements the PendingRateChange interface.
+ */
+export function instanceOfPendingRateChange(value: object): value is PendingRateChange {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('ruleId' in value) || value['ruleId'] === undefined) return false;
+    if (!('customerId' in value) || value['customerId'] === undefined) return false;
+    if (!('unitId' in value) || value['unitId'] === undefined) return false;
+    if (!('subscriptionId' in value) || value['subscriptionId'] === undefined) return false;
+    if (!('customerName' in value) || value['customerName'] === undefined) return false;
+    if (!('unitNumber' in value) || value['unitNumber'] === undefined) return false;
+    if (!('currentRate' in value) || value['currentRate'] === undefined) return false;
+    if (!('newRate' in value) || value['newRate'] === undefined) return false;
+    if (!('effectiveDate' in value) || value['effectiveDate'] === undefined) return false;
+    if (!('isOverridden' in value) || value['isOverridden'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('ruleName' in value) || value['ruleName'] === undefined) return false;
+    if (!('siteId' in value) || value['siteId'] === undefined) return false;
+    if (!('orgId' in value) || value['orgId'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('appliedAt' in value) || value['appliedAt'] === undefined) return false;
+    if (!('cancelledAt' in value) || value['cancelledAt'] === undefined) return false;
+    if (!('chargeId' in value) || value['chargeId'] === undefined) return false;
+    if (!('chargeName' in value) || value['chargeName'] === undefined) return false;
+    if (!('productName' in value) || value['productName'] === undefined) return false;
+    return true;
+}
+
+export function PendingRateChangeFromJSON(json: any): PendingRateChange {
+    return PendingRateChangeFromJSONTyped(json, false);
+}
+
+export function PendingRateChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): PendingRateChange {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'ruleId': json['ruleId'],
+        'customerId': json['customerId'],
+        'unitId': json['unitId'],
+        'subscriptionId': json['subscriptionId'],
+        'customerName': json['customerName'],
+        'unitNumber': json['unitNumber'],
+        'currentRate': json['currentRate'],
+        'newRate': json['newRate'],
+        'effectiveDate': (new Date(json['effectiveDate'])),
+        'isOverridden': json['isOverridden'],
+        'status': json['status'],
+        'ruleName': json['ruleName'],
+        'siteId': json['siteId'],
+        'orgId': json['orgId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (json['updatedAt'] == null ? null : new Date(json['updatedAt'])),
+        'appliedAt': (json['appliedAt'] == null ? null : new Date(json['appliedAt'])),
+        'cancelledAt': (json['cancelledAt'] == null ? null : new Date(json['cancelledAt'])),
+        'chargeId': json['chargeId'],
+        'chargeName': json['chargeName'],
+        'productName': json['productName'],
+        'rule': json['rule'] == null ? undefined : PricingRuleFromJSON(json['rule']),
+        'errors': json['errors'] == null ? undefined : ((json['errors'] as Array<any>).map(PendingRateChangeErrorFromJSON)),
+    };
+}
+
+export function PendingRateChangeToJSON(json: any): PendingRateChange {
+    return PendingRateChangeToJSONTyped(json, false);
+}
+
+export function PendingRateChangeToJSONTyped(value?: PendingRateChange | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'ruleId': value['ruleId'],
+        'customerId': value['customerId'],
+        'unitId': value['unitId'],
+        'subscriptionId': value['subscriptionId'],
+        'customerName': value['customerName'],
+        'unitNumber': value['unitNumber'],
+        'currentRate': value['currentRate'],
+        'newRate': value['newRate'],
+        'effectiveDate': ((value['effectiveDate']).toISOString()),
+        'isOverridden': value['isOverridden'],
+        'status': value['status'],
+        'ruleName': value['ruleName'],
+        'siteId': value['siteId'],
+        'orgId': value['orgId'],
+        'createdAt': ((value['createdAt']).toISOString()),
+        'updatedAt': (value['updatedAt'] == null ? null : (value['updatedAt'] as any).toISOString()),
+        'appliedAt': (value['appliedAt'] == null ? null : (value['appliedAt'] as any).toISOString()),
+        'cancelledAt': (value['cancelledAt'] == null ? null : (value['cancelledAt'] as any).toISOString()),
+        'chargeId': value['chargeId'],
+        'chargeName': value['chargeName'],
+        'productName': value['productName'],
+        'rule': PricingRuleToJSON(value['rule']),
+        'errors': value['errors'] == null ? undefined : ((value['errors'] as Array<any>).map(PendingRateChangeErrorToJSON)),
+    };
+}
+

package/src/generated/models/pricing-rule.ts

@@ -0,0 +1,190 @@
+/* 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 { PendingRateChange } from './pending-rate-change';
+import {
+    PendingRateChangeFromJSON,
+    PendingRateChangeFromJSONTyped,
+    PendingRateChangeToJSON,
+    PendingRateChangeToJSONTyped,
+} from './pending-rate-change';
+
+/**
+ * 
+ * @export
+ * @interface PricingRule
+ */
+export interface PricingRule {
+    /**
+     * Pricing Rule ID
+     * @type {string}
+     * @memberof PricingRule
+     */
+    id: string;
+    /**
+     * Name of the rule
+     * @type {string}
+     * @memberof PricingRule
+     */
+    name: string;
+    /**
+     * Date when the rule takes effect
+     * @type {Date}
+     * @memberof PricingRule
+     */
+    effectiveDate: Date;
+    /**
+     * Type of change (percentage or fixed)
+     * @type {string}
+     * @memberof PricingRule
+     */
+    changeType: string;
+    /**
+     * Amount of change (percentage or fixed amount)
+     * @type {number}
+     * @memberof PricingRule
+     */
+    changeAmount: number;
+    /**
+     * Criteria for selecting tenants
+     * @type {object}
+     * @memberof PricingRule
+     */
+    selectionCriteria: object | null;
+    /**
+     * Status of the rule
+     * @type {string}
+     * @memberof PricingRule
+     */
+    status: string;
+    /**
+     * Site ID
+     * @type {string}
+     * @memberof PricingRule
+     */
+    siteId: string;
+    /**
+     * Organization ID
+     * @type {string}
+     * @memberof PricingRule
+     */
+    orgId: string;
+    /**
+     * When the record was created
+     * @type {Date}
+     * @memberof PricingRule
+     */
+    createdAt: Date;
+    /**
+     * When the record was last updated
+     * @type {Date}
+     * @memberof PricingRule
+     */
+    updatedAt: Date | null;
+    /**
+     * 
+     * @type {Array<PendingRateChange>}
+     * @memberof PricingRule
+     */
+    pendingChanges?: Array<PendingRateChange>;
+    /**
+     * Type of application for the rule
+     * @type {string}
+     * @memberof PricingRule
+     */
+    applicationType: string | null;
+    /**
+     * Delayed date before rule is applied
+     * @type {number}
+     * @memberof PricingRule
+     */
+    billingCyclesDelay: number | null;
+}
+
+/**
+ * Check if a given object implements the PricingRule interface.
+ */
+export function instanceOfPricingRule(value: object): value is PricingRule {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('effectiveDate' in value) || value['effectiveDate'] === undefined) return false;
+    if (!('changeType' in value) || value['changeType'] === undefined) return false;
+    if (!('changeAmount' in value) || value['changeAmount'] === undefined) return false;
+    if (!('selectionCriteria' in value) || value['selectionCriteria'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('siteId' in value) || value['siteId'] === undefined) return false;
+    if (!('orgId' in value) || value['orgId'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('applicationType' in value) || value['applicationType'] === undefined) return false;
+    if (!('billingCyclesDelay' in value) || value['billingCyclesDelay'] === undefined) return false;
+    return true;
+}
+
+export function PricingRuleFromJSON(json: any): PricingRule {
+    return PricingRuleFromJSONTyped(json, false);
+}
+
+export function PricingRuleFromJSONTyped(json: any, ignoreDiscriminator: boolean): PricingRule {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'effectiveDate': (new Date(json['effectiveDate'])),
+        'changeType': json['changeType'],
+        'changeAmount': json['changeAmount'],
+        'selectionCriteria': json['selectionCriteria'],
+        'status': json['status'],
+        'siteId': json['siteId'],
+        'orgId': json['orgId'],
+        'createdAt': (new Date(json['createdAt'])),
+        'updatedAt': (json['updatedAt'] == null ? null : new Date(json['updatedAt'])),
+        'pendingChanges': json['pendingChanges'] == null ? undefined : ((json['pendingChanges'] as Array<any>).map(PendingRateChangeFromJSON)),
+        'applicationType': json['applicationType'],
+        'billingCyclesDelay': json['billingCyclesDelay'],
+    };
+}
+
+export function PricingRuleToJSON(json: any): PricingRule {
+    return PricingRuleToJSONTyped(json, false);
+}
+
+export function PricingRuleToJSONTyped(value?: PricingRule | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'effectiveDate': ((value['effectiveDate']).toISOString()),
+        'changeType': value['changeType'],
+        'changeAmount': value['changeAmount'],
+        'selectionCriteria': value['selectionCriteria'],
+        'status': value['status'],
+        'siteId': value['siteId'],
+        'orgId': value['orgId'],
+        'createdAt': ((value['createdAt']).toISOString()),
+        'updatedAt': (value['updatedAt'] == null ? null : (value['updatedAt'] as any).toISOString()),
+        'pendingChanges': value['pendingChanges'] == null ? undefined : ((value['pendingChanges'] as Array<any>).map(PendingRateChangeToJSON)),
+        'applicationType': value['applicationType'],
+        'billingCyclesDelay': value['billingCyclesDelay'],
+    };
+}
+

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

@@ -51,6 +51,12 @@ export interface ProductCustom {
      * @memberof ProductCustom
      */
     taxable?: boolean;
+    /**
+     * Indicates whether it is a merchandise product or not
+     * @type {boolean}
+     * @memberof ProductCustom
+     */
+    isMerchandise?: boolean;
     /**
      * Indicates whether it is the default product or not
      * @type {boolean}
@@ -147,6 +153,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'],
+        'isMerchandise': json['isMerchandise'] == null ? undefined : json['isMerchandise'],
         'isDefault': json['isDefault'] == null ? undefined : json['isDefault'],
         'rentRelated': json['rentRelated'],
         'description': json['description'] == null ? undefined : json['description'],
@@ -176,6 +183,7 @@ export function ProductCustomToJSONTyped(value?: ProductCustom | null, ignoreDis
         'sku': value['sku'],
         'status': value['status'],
         'taxable': value['taxable'],
+        'isMerchandise': value['isMerchandise'],
         'isDefault': value['isDefault'],
         'rentRelated': value['rentRelated'],
         'description': value['description'],

package/src/generated/models/rate-change-detail-dto.ts

@@ -0,0 +1,138 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface RateChangeDetailDto
+ */
+export interface RateChangeDetailDto {
+    /**
+     * Subscription ID
+     * @type {string}
+     * @memberof RateChangeDetailDto
+     */
+    subscriptionId: string;
+    /**
+     * Charge ID
+     * @type {string}
+     * @memberof RateChangeDetailDto
+     */
+    chargeId: string;
+    /**
+     * Charge name/description
+     * @type {string}
+     * @memberof RateChangeDetailDto
+     */
+    description: string;
+    /**
+     * Product name
+     * @type {string}
+     * @memberof RateChangeDetailDto
+     */
+    productName: string;
+    /**
+     * Current rate before the change
+     * @type {number}
+     * @memberof RateChangeDetailDto
+     */
+    currentRate: number;
+    /**
+     * New rate after the change
+     * @type {number}
+     * @memberof RateChangeDetailDto
+     */
+    newRate: number;
+    /**
+     * Percentage change between current and new rate
+     * @type {number}
+     * @memberof RateChangeDetailDto
+     */
+    percentageChange: number;
+    /**
+     * Date when the rate change will take effect
+     * @type {string}
+     * @memberof RateChangeDetailDto
+     */
+    effectiveDate: string;
+    /**
+     * Whether this is an exclusion from standard rule
+     * @type {boolean}
+     * @memberof RateChangeDetailDto
+     */
+    isExclusion: boolean;
+}
+
+/**
+ * Check if a given object implements the RateChangeDetailDto interface.
+ */
+export function instanceOfRateChangeDetailDto(value: object): value is RateChangeDetailDto {
+    if (!('subscriptionId' in value) || value['subscriptionId'] === undefined) return false;
+    if (!('chargeId' in value) || value['chargeId'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('productName' in value) || value['productName'] === undefined) return false;
+    if (!('currentRate' in value) || value['currentRate'] === undefined) return false;
+    if (!('newRate' in value) || value['newRate'] === undefined) return false;
+    if (!('percentageChange' in value) || value['percentageChange'] === undefined) return false;
+    if (!('effectiveDate' in value) || value['effectiveDate'] === undefined) return false;
+    if (!('isExclusion' in value) || value['isExclusion'] === undefined) return false;
+    return true;
+}
+
+export function RateChangeDetailDtoFromJSON(json: any): RateChangeDetailDto {
+    return RateChangeDetailDtoFromJSONTyped(json, false);
+}
+
+export function RateChangeDetailDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): RateChangeDetailDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'subscriptionId': json['subscriptionId'],
+        'chargeId': json['chargeId'],
+        'description': json['description'],
+        'productName': json['productName'],
+        'currentRate': json['currentRate'],
+        'newRate': json['newRate'],
+        'percentageChange': json['percentageChange'],
+        'effectiveDate': json['effectiveDate'],
+        'isExclusion': json['isExclusion'],
+    };
+}
+
+export function RateChangeDetailDtoToJSON(json: any): RateChangeDetailDto {
+    return RateChangeDetailDtoToJSONTyped(json, false);
+}
+
+export function RateChangeDetailDtoToJSONTyped(value?: RateChangeDetailDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'subscriptionId': value['subscriptionId'],
+        'chargeId': value['chargeId'],
+        'description': value['description'],
+        'productName': value['productName'],
+        'currentRate': value['currentRate'],
+        'newRate': value['newRate'],
+        'percentageChange': value['percentageChange'],
+        'effectiveDate': value['effectiveDate'],
+        'isExclusion': value['isExclusion'],
+    };
+}
+