@managespace/sdk 0.1.72 → 0.1.74

package/src/generated/models/create-pricing-rule-criteria-custom.ts

@@ -0,0 +1,129 @@
+/* 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 CreatePricingRuleCriteriaCustom
+ */
+export interface CreatePricingRuleCriteriaCustom {
+    /**
+     * Minimum asset area occupancy percent for the rate change to be applied
+     * @type {string}
+     * @memberof CreatePricingRuleCriteriaCustom
+     */
+    minimumAreaOccupancyPercent?: string | null;
+    /**
+     * Minimum asset type occupancy percent for the rate change to be applied
+     * @type {string}
+     * @memberof CreatePricingRuleCriteriaCustom
+     */
+    minimumTypeOccupancyPercent?: string | null;
+    /**
+     * Minimum site occupancy percent for the rate change to be applied
+     * @type {string}
+     * @memberof CreatePricingRuleCriteriaCustom
+     */
+    minimumSiteOccupancyPercent?: string | null;
+    /**
+     * Minimum number of days since the last rate change was applied
+     * @type {number}
+     * @memberof CreatePricingRuleCriteriaCustom
+     */
+    rateChangeInterval?: number | null;
+    /**
+     * Minimum number of days since the customer moved in
+     * @type {number}
+     * @memberof CreatePricingRuleCriteriaCustom
+     */
+    daysSinceMoveIn?: number | null;
+    /**
+     * Whether to exclude commercial customers from the rate change or not
+     * @type {boolean}
+     * @memberof CreatePricingRuleCriteriaCustom
+     */
+    excludeCommercial?: boolean;
+    /**
+     * Whether to exclude rates higher than the standard product rate from the rate change or not
+     * @type {boolean}
+     * @memberof CreatePricingRuleCriteriaCustom
+     */
+    excludeRatesHigherThanStandard?: boolean;
+    /**
+     * Whether to exclude rates that have a permanent discount applied or not
+     * @type {boolean}
+     * @memberof CreatePricingRuleCriteriaCustom
+     */
+    excludePermanentDiscounts?: boolean;
+    /**
+     * Minimum number of units in the area and type for the rate change to be applied
+     * @type {number}
+     * @memberof CreatePricingRuleCriteriaCustom
+     */
+    minimumUnitCount?: number | null;
+}
+
+/**
+ * Check if a given object implements the CreatePricingRuleCriteriaCustom interface.
+ */
+export function instanceOfCreatePricingRuleCriteriaCustom(value: object): value is CreatePricingRuleCriteriaCustom {
+    return true;
+}
+
+export function CreatePricingRuleCriteriaCustomFromJSON(json: any): CreatePricingRuleCriteriaCustom {
+    return CreatePricingRuleCriteriaCustomFromJSONTyped(json, false);
+}
+
+export function CreatePricingRuleCriteriaCustomFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePricingRuleCriteriaCustom {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'minimumAreaOccupancyPercent': json['minimumAreaOccupancyPercent'] == null ? undefined : json['minimumAreaOccupancyPercent'],
+        'minimumTypeOccupancyPercent': json['minimumTypeOccupancyPercent'] == null ? undefined : json['minimumTypeOccupancyPercent'],
+        'minimumSiteOccupancyPercent': json['minimumSiteOccupancyPercent'] == null ? undefined : json['minimumSiteOccupancyPercent'],
+        'rateChangeInterval': json['rateChangeInterval'] == null ? undefined : json['rateChangeInterval'],
+        'daysSinceMoveIn': json['daysSinceMoveIn'] == null ? undefined : json['daysSinceMoveIn'],
+        'excludeCommercial': json['excludeCommercial'] == null ? undefined : json['excludeCommercial'],
+        'excludeRatesHigherThanStandard': json['excludeRatesHigherThanStandard'] == null ? undefined : json['excludeRatesHigherThanStandard'],
+        'excludePermanentDiscounts': json['excludePermanentDiscounts'] == null ? undefined : json['excludePermanentDiscounts'],
+        'minimumUnitCount': json['minimumUnitCount'] == null ? undefined : json['minimumUnitCount'],
+    };
+}
+
+export function CreatePricingRuleCriteriaCustomToJSON(json: any): CreatePricingRuleCriteriaCustom {
+    return CreatePricingRuleCriteriaCustomToJSONTyped(json, false);
+}
+
+export function CreatePricingRuleCriteriaCustomToJSONTyped(value?: CreatePricingRuleCriteriaCustom | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'minimumAreaOccupancyPercent': value['minimumAreaOccupancyPercent'],
+        'minimumTypeOccupancyPercent': value['minimumTypeOccupancyPercent'],
+        'minimumSiteOccupancyPercent': value['minimumSiteOccupancyPercent'],
+        'rateChangeInterval': value['rateChangeInterval'],
+        'daysSinceMoveIn': value['daysSinceMoveIn'],
+        'excludeCommercial': value['excludeCommercial'],
+        'excludeRatesHigherThanStandard': value['excludeRatesHigherThanStandard'],
+        'excludePermanentDiscounts': value['excludePermanentDiscounts'],
+        'minimumUnitCount': value['minimumUnitCount'],
+    };
+}
+

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

@@ -0,0 +1,129 @@
+/* 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 CreatePricingRuleCriteria
+ */
+export interface CreatePricingRuleCriteria {
+    /**
+     * Minimum asset area occupancy percent for the rate change to be applied
+     * @type {string}
+     * @memberof CreatePricingRuleCriteria
+     */
+    minimumAreaOccupancyPercent?: string | null;
+    /**
+     * Minimum asset type occupancy percent for the rate change to be applied
+     * @type {string}
+     * @memberof CreatePricingRuleCriteria
+     */
+    minimumTypeOccupancyPercent?: string | null;
+    /**
+     * Minimum number of units in the area and type for the rate change to be applied
+     * @type {number}
+     * @memberof CreatePricingRuleCriteria
+     */
+    minimumUnitCount?: number | null;
+    /**
+     * Minimum site occupancy percent for the rate change to be applied
+     * @type {string}
+     * @memberof CreatePricingRuleCriteria
+     */
+    minimumSiteOccupancyPercent?: string | null;
+    /**
+     * Minimum number of days since the last rate change was applied
+     * @type {number}
+     * @memberof CreatePricingRuleCriteria
+     */
+    rateChangeInterval?: number | null;
+    /**
+     * Minimum number of days since the customer moved in
+     * @type {number}
+     * @memberof CreatePricingRuleCriteria
+     */
+    daysSinceMoveIn?: number | null;
+    /**
+     * Whether to exclude commercial customers from the rate change or not
+     * @type {boolean}
+     * @memberof CreatePricingRuleCriteria
+     */
+    excludeCommercial?: boolean;
+    /**
+     * Whether to exclude rates higher than the standard product rate from the rate change or not
+     * @type {boolean}
+     * @memberof CreatePricingRuleCriteria
+     */
+    excludeRatesHigherThanStandard?: boolean;
+    /**
+     * Whether to exclude rates that have a permanent discount applied or not
+     * @type {boolean}
+     * @memberof CreatePricingRuleCriteria
+     */
+    excludePermanentDiscounts?: boolean;
+}
+
+/**
+ * Check if a given object implements the CreatePricingRuleCriteria interface.
+ */
+export function instanceOfCreatePricingRuleCriteria(value: object): value is CreatePricingRuleCriteria {
+    return true;
+}
+
+export function CreatePricingRuleCriteriaFromJSON(json: any): CreatePricingRuleCriteria {
+    return CreatePricingRuleCriteriaFromJSONTyped(json, false);
+}
+
+export function CreatePricingRuleCriteriaFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePricingRuleCriteria {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'minimumAreaOccupancyPercent': json['minimumAreaOccupancyPercent'] == null ? undefined : json['minimumAreaOccupancyPercent'],
+        'minimumTypeOccupancyPercent': json['minimumTypeOccupancyPercent'] == null ? undefined : json['minimumTypeOccupancyPercent'],
+        'minimumUnitCount': json['minimumUnitCount'] == null ? undefined : json['minimumUnitCount'],
+        'minimumSiteOccupancyPercent': json['minimumSiteOccupancyPercent'] == null ? undefined : json['minimumSiteOccupancyPercent'],
+        'rateChangeInterval': json['rateChangeInterval'] == null ? undefined : json['rateChangeInterval'],
+        'daysSinceMoveIn': json['daysSinceMoveIn'] == null ? undefined : json['daysSinceMoveIn'],
+        'excludeCommercial': json['excludeCommercial'] == null ? undefined : json['excludeCommercial'],
+        'excludeRatesHigherThanStandard': json['excludeRatesHigherThanStandard'] == null ? undefined : json['excludeRatesHigherThanStandard'],
+        'excludePermanentDiscounts': json['excludePermanentDiscounts'] == null ? undefined : json['excludePermanentDiscounts'],
+    };
+}
+
+export function CreatePricingRuleCriteriaToJSON(json: any): CreatePricingRuleCriteria {
+    return CreatePricingRuleCriteriaToJSONTyped(json, false);
+}
+
+export function CreatePricingRuleCriteriaToJSONTyped(value?: CreatePricingRuleCriteria | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'minimumAreaOccupancyPercent': value['minimumAreaOccupancyPercent'],
+        'minimumTypeOccupancyPercent': value['minimumTypeOccupancyPercent'],
+        'minimumUnitCount': value['minimumUnitCount'],
+        'minimumSiteOccupancyPercent': value['minimumSiteOccupancyPercent'],
+        'rateChangeInterval': value['rateChangeInterval'],
+        'daysSinceMoveIn': value['daysSinceMoveIn'],
+        'excludeCommercial': value['excludeCommercial'],
+        'excludeRatesHigherThanStandard': value['excludeRatesHigherThanStandard'],
+        'excludePermanentDiscounts': value['excludePermanentDiscounts'],
+    };
+}
+

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

@@ -0,0 +1,169 @@
+/* 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 { CreatePricingRuleCriteriaCustom } from './create-pricing-rule-criteria-custom';
+import {
+    CreatePricingRuleCriteriaCustomFromJSON,
+    CreatePricingRuleCriteriaCustomFromJSONTyped,
+    CreatePricingRuleCriteriaCustomToJSON,
+    CreatePricingRuleCriteriaCustomToJSONTyped,
+} from './create-pricing-rule-criteria-custom';
+import type { CreatePricingRuleLegend } from './create-pricing-rule-legend';
+import {
+    CreatePricingRuleLegendFromJSON,
+    CreatePricingRuleLegendFromJSONTyped,
+    CreatePricingRuleLegendToJSON,
+    CreatePricingRuleLegendToJSONTyped,
+} from './create-pricing-rule-legend';
+
+/**
+ * 
+ * @export
+ * @interface CreatePricingRuleCustom
+ */
+export interface CreatePricingRuleCustom {
+    /**
+     * Name of the rule
+     * @type {string}
+     * @memberof CreatePricingRuleCustom
+     */
+    name: string;
+    /**
+     * Set rates to the standard rate
+     * @type {boolean}
+     * @memberof CreatePricingRuleCustom
+     */
+    useStandardRate?: boolean | null;
+    /**
+     * Set rates to x% more than the current rate
+     * @type {string}
+     * @memberof CreatePricingRuleCustom
+     */
+    changePercent?: string | null;
+    /**
+     * Set rates to x more than the current rate
+     * @type {string}
+     * @memberof CreatePricingRuleCustom
+     */
+    changeFixed?: string | null;
+    /**
+     * Minimum rate change to apply
+     * @type {string}
+     * @memberof CreatePricingRuleCustom
+     */
+    minimumChange?: string | null;
+    /**
+     * Maximum rate change to apply
+     * @type {string}
+     * @memberof CreatePricingRuleCustom
+     */
+    maximumChange?: string | null;
+    /**
+     * Round rates to the nearest x
+     * @type {string}
+     * @memberof CreatePricingRuleCustom
+     */
+    roundToNearest?: string | null;
+    /**
+     * Prevent rates from going above the standard rate
+     * @type {boolean}
+     * @memberof CreatePricingRuleCustom
+     */
+    capAtStandardRate?: boolean;
+    /**
+     * Number of days to send a notice to the customer before the rate applies
+     * @type {number}
+     * @memberof CreatePricingRuleCustom
+     */
+    noticeDays?: number;
+    /**
+     * List of site IDs
+     * @type {Array<string>}
+     * @memberof CreatePricingRuleCustom
+     */
+    siteIds?: Array<string> | null;
+    /**
+     * 
+     * @type {CreatePricingRuleLegend}
+     * @memberof CreatePricingRuleCustom
+     */
+    legend?: CreatePricingRuleLegend | null;
+    /**
+     * 
+     * @type {CreatePricingRuleCriteriaCustom}
+     * @memberof CreatePricingRuleCustom
+     */
+    criteria?: CreatePricingRuleCriteriaCustom | null;
+}
+
+/**
+ * Check if a given object implements the CreatePricingRuleCustom interface.
+ */
+export function instanceOfCreatePricingRuleCustom(value: object): value is CreatePricingRuleCustom {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function CreatePricingRuleCustomFromJSON(json: any): CreatePricingRuleCustom {
+    return CreatePricingRuleCustomFromJSONTyped(json, false);
+}
+
+export function CreatePricingRuleCustomFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePricingRuleCustom {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'useStandardRate': json['useStandardRate'] == null ? undefined : json['useStandardRate'],
+        'changePercent': json['changePercent'] == null ? undefined : json['changePercent'],
+        'changeFixed': json['changeFixed'] == null ? undefined : json['changeFixed'],
+        'minimumChange': json['minimumChange'] == null ? undefined : json['minimumChange'],
+        'maximumChange': json['maximumChange'] == null ? undefined : json['maximumChange'],
+        'roundToNearest': json['roundToNearest'] == null ? undefined : json['roundToNearest'],
+        'capAtStandardRate': json['capAtStandardRate'] == null ? undefined : json['capAtStandardRate'],
+        'noticeDays': json['noticeDays'] == null ? undefined : json['noticeDays'],
+        'siteIds': json['siteIds'] == null ? undefined : json['siteIds'],
+        'legend': json['legend'] == null ? undefined : CreatePricingRuleLegendFromJSON(json['legend']),
+        'criteria': json['criteria'] == null ? undefined : CreatePricingRuleCriteriaCustomFromJSON(json['criteria']),
+    };
+}
+
+export function CreatePricingRuleCustomToJSON(json: any): CreatePricingRuleCustom {
+    return CreatePricingRuleCustomToJSONTyped(json, false);
+}
+
+export function CreatePricingRuleCustomToJSONTyped(value?: CreatePricingRuleCustom | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'useStandardRate': value['useStandardRate'],
+        'changePercent': value['changePercent'],
+        'changeFixed': value['changeFixed'],
+        'minimumChange': value['minimumChange'],
+        'maximumChange': value['maximumChange'],
+        'roundToNearest': value['roundToNearest'],
+        'capAtStandardRate': value['capAtStandardRate'],
+        'noticeDays': value['noticeDays'],
+        'siteIds': value['siteIds'],
+        'legend': CreatePricingRuleLegendToJSON(value['legend']),
+        'criteria': CreatePricingRuleCriteriaCustomToJSON(value['criteria']),
+    };
+}
+

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

@@ -0,0 +1,153 @@
+/* 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 CreatePricingRuleLegend
+ */
+export interface CreatePricingRuleLegend {
+    /**
+     * Suggested rates are more than x% of the subscription rate
+     * @type {string}
+     * @memberof CreatePricingRuleLegend
+     */
+    moreThanPercent?: string | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof CreatePricingRuleLegend
+     */
+    moreThanPercentColour?: string | null;
+    /**
+     * Suggested rates are more than x of the subscription rate
+     * @type {string}
+     * @memberof CreatePricingRuleLegend
+     */
+    moreThanFixed?: string | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof CreatePricingRuleLegend
+     */
+    moreThanFixedColour?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreatePricingRuleLegend
+     */
+    rateChangeInterval?: number | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof CreatePricingRuleLegend
+     */
+    rateChangeIntervalColour?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof CreatePricingRuleLegend
+     */
+    daysSinceMoveIn?: number | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof CreatePricingRuleLegend
+     */
+    daysSinceMoveInColour?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePricingRuleLegend
+     */
+    moreThanStandardPercent?: string | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof CreatePricingRuleLegend
+     */
+    moreThanStandardPercentColour?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreatePricingRuleLegend
+     */
+    lessThanStandardPercent?: string | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof CreatePricingRuleLegend
+     */
+    lessThanStandardPercentColour?: string | null;
+}
+
+/**
+ * Check if a given object implements the CreatePricingRuleLegend interface.
+ */
+export function instanceOfCreatePricingRuleLegend(value: object): value is CreatePricingRuleLegend {
+    return true;
+}
+
+export function CreatePricingRuleLegendFromJSON(json: any): CreatePricingRuleLegend {
+    return CreatePricingRuleLegendFromJSONTyped(json, false);
+}
+
+export function CreatePricingRuleLegendFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePricingRuleLegend {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'moreThanPercent': json['moreThanPercent'] == null ? undefined : json['moreThanPercent'],
+        'moreThanPercentColour': json['moreThanPercentColour'] == null ? undefined : json['moreThanPercentColour'],
+        'moreThanFixed': json['moreThanFixed'] == null ? undefined : json['moreThanFixed'],
+        'moreThanFixedColour': json['moreThanFixedColour'] == null ? undefined : json['moreThanFixedColour'],
+        'rateChangeInterval': json['rateChangeInterval'] == null ? undefined : json['rateChangeInterval'],
+        'rateChangeIntervalColour': json['rateChangeIntervalColour'] == null ? undefined : json['rateChangeIntervalColour'],
+        'daysSinceMoveIn': json['daysSinceMoveIn'] == null ? undefined : json['daysSinceMoveIn'],
+        'daysSinceMoveInColour': json['daysSinceMoveInColour'] == null ? undefined : json['daysSinceMoveInColour'],
+        'moreThanStandardPercent': json['moreThanStandardPercent'] == null ? undefined : json['moreThanStandardPercent'],
+        'moreThanStandardPercentColour': json['moreThanStandardPercentColour'] == null ? undefined : json['moreThanStandardPercentColour'],
+        'lessThanStandardPercent': json['lessThanStandardPercent'] == null ? undefined : json['lessThanStandardPercent'],
+        'lessThanStandardPercentColour': json['lessThanStandardPercentColour'] == null ? undefined : json['lessThanStandardPercentColour'],
+    };
+}
+
+export function CreatePricingRuleLegendToJSON(json: any): CreatePricingRuleLegend {
+    return CreatePricingRuleLegendToJSONTyped(json, false);
+}
+
+export function CreatePricingRuleLegendToJSONTyped(value?: CreatePricingRuleLegend | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'moreThanPercent': value['moreThanPercent'],
+        'moreThanPercentColour': value['moreThanPercentColour'],
+        'moreThanFixed': value['moreThanFixed'],
+        'moreThanFixedColour': value['moreThanFixedColour'],
+        'rateChangeInterval': value['rateChangeInterval'],
+        'rateChangeIntervalColour': value['rateChangeIntervalColour'],
+        'daysSinceMoveIn': value['daysSinceMoveIn'],
+        'daysSinceMoveInColour': value['daysSinceMoveInColour'],
+        'moreThanStandardPercent': value['moreThanStandardPercent'],
+        'moreThanStandardPercentColour': value['moreThanStandardPercentColour'],
+        'lessThanStandardPercent': value['lessThanStandardPercent'],
+        'lessThanStandardPercentColour': value['lessThanStandardPercentColour'],
+    };
+}
+