@managespace/sdk 0.1.10 → 0.1.11-5.paul.dev

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

@@ -0,0 +1,255 @@
+/* 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 { User } from './user';
+import {
+    UserFromJSON,
+    UserFromJSONTyped,
+    UserToJSON,
+    UserToJSONTyped,
+} from './user';
+import type { Org } from './org';
+import {
+    OrgFromJSON,
+    OrgFromJSONTyped,
+    OrgToJSON,
+    OrgToJSONTyped,
+} from './org';
+import type { PricingRule } from './pricing-rule';
+import {
+    PricingRuleFromJSON,
+    PricingRuleFromJSONTyped,
+    PricingRuleToJSON,
+    PricingRuleToJSONTyped,
+} from './pricing-rule';
+
+/**
+ * 
+ * @export
+ * @interface PricingRuleCriteria
+ */
+export interface PricingRuleCriteria {
+    /**
+     * Rate change criteria ID
+     * @type {string}
+     * @memberof PricingRuleCriteria
+     */
+    id: string;
+    /**
+     * 
+     * @type {Org}
+     * @memberof PricingRuleCriteria
+     */
+    org?: Org;
+    /**
+     * 
+     * @type {string}
+     * @memberof PricingRuleCriteria
+     */
+    orgId: string;
+    /**
+     * Minimum asset area occupancy percent for the rate change to be applied
+     * @type {string}
+     * @memberof PricingRuleCriteria
+     */
+    minimumAreaOccupancyPercent: string | null;
+    /**
+     * Minimum asset type occupancy percent for the rate change to be applied
+     * @type {string}
+     * @memberof PricingRuleCriteria
+     */
+    minimumTypeOccupancyPercent: string | null;
+    /**
+     * Minimum number of units in the area and type for the rate change to be applied
+     * @type {number}
+     * @memberof PricingRuleCriteria
+     */
+    minimumUnitCount: number | null;
+    /**
+     * Minimum site occupancy percent for the rate change to be applied
+     * @type {string}
+     * @memberof PricingRuleCriteria
+     */
+    minimumSiteOccupancyPercent: string | null;
+    /**
+     * Minimum number of days since the last rate change was applied
+     * @type {number}
+     * @memberof PricingRuleCriteria
+     */
+    rateChangeInterval: number | null;
+    /**
+     * Minimum number of days since the customer moved in
+     * @type {number}
+     * @memberof PricingRuleCriteria
+     */
+    daysSinceMoveIn: number | null;
+    /**
+     * Whether to exclude commercial customers from the rate change or not
+     * @type {boolean}
+     * @memberof PricingRuleCriteria
+     */
+    excludeCommercial: boolean;
+    /**
+     * Whether to exclude rates higher than the standard product rate from the rate change or not
+     * @type {boolean}
+     * @memberof PricingRuleCriteria
+     */
+    excludeRatesHigherThanStandard: boolean;
+    /**
+     * Whether to exclude rates that have a permanent discount applied or not
+     * @type {boolean}
+     * @memberof PricingRuleCriteria
+     */
+    excludePermanentDiscounts: boolean;
+    /**
+     * Who created the note
+     * @type {User}
+     * @memberof PricingRuleCriteria
+     */
+    createdBy?: User;
+    /**
+     * 
+     * @type {string}
+     * @memberof PricingRuleCriteria
+     */
+    createdById: string;
+    /**
+     * When the note was created
+     * @type {Date}
+     * @memberof PricingRuleCriteria
+     */
+    createdAt: Date | null;
+    /**
+     * Who updated the note
+     * @type {User}
+     * @memberof PricingRuleCriteria
+     */
+    updatedBy?: User | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PricingRuleCriteria
+     */
+    updatedById: string | null;
+    /**
+     * When the note was last updated
+     * @type {Date}
+     * @memberof PricingRuleCriteria
+     */
+    updatedAt: Date | null;
+    /**
+     * 
+     * @type {PricingRule}
+     * @memberof PricingRuleCriteria
+     */
+    pricingRule?: PricingRule;
+    /**
+     * 
+     * @type {string}
+     * @memberof PricingRuleCriteria
+     */
+    pricingRuleId: string;
+}
+
+/**
+ * Check if a given object implements the PricingRuleCriteria interface.
+ */
+export function instanceOfPricingRuleCriteria(value: object): value is PricingRuleCriteria {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('orgId' in value) || value['orgId'] === undefined) return false;
+    if (!('minimumAreaOccupancyPercent' in value) || value['minimumAreaOccupancyPercent'] === undefined) return false;
+    if (!('minimumTypeOccupancyPercent' in value) || value['minimumTypeOccupancyPercent'] === undefined) return false;
+    if (!('minimumUnitCount' in value) || value['minimumUnitCount'] === undefined) return false;
+    if (!('minimumSiteOccupancyPercent' in value) || value['minimumSiteOccupancyPercent'] === undefined) return false;
+    if (!('rateChangeInterval' in value) || value['rateChangeInterval'] === undefined) return false;
+    if (!('daysSinceMoveIn' in value) || value['daysSinceMoveIn'] === undefined) return false;
+    if (!('excludeCommercial' in value) || value['excludeCommercial'] === undefined) return false;
+    if (!('excludeRatesHigherThanStandard' in value) || value['excludeRatesHigherThanStandard'] === undefined) return false;
+    if (!('excludePermanentDiscounts' in value) || value['excludePermanentDiscounts'] === undefined) return false;
+    if (!('createdById' in value) || value['createdById'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedById' in value) || value['updatedById'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('pricingRuleId' in value) || value['pricingRuleId'] === undefined) return false;
+    return true;
+}
+
+export function PricingRuleCriteriaFromJSON(json: any): PricingRuleCriteria {
+    return PricingRuleCriteriaFromJSONTyped(json, false);
+}
+
+export function PricingRuleCriteriaFromJSONTyped(json: any, ignoreDiscriminator: boolean): PricingRuleCriteria {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'org': json['org'] == null ? undefined : OrgFromJSON(json['org']),
+        'orgId': json['orgId'],
+        'minimumAreaOccupancyPercent': json['minimumAreaOccupancyPercent'],
+        'minimumTypeOccupancyPercent': json['minimumTypeOccupancyPercent'],
+        'minimumUnitCount': json['minimumUnitCount'],
+        'minimumSiteOccupancyPercent': json['minimumSiteOccupancyPercent'],
+        'rateChangeInterval': json['rateChangeInterval'],
+        'daysSinceMoveIn': json['daysSinceMoveIn'],
+        'excludeCommercial': json['excludeCommercial'],
+        'excludeRatesHigherThanStandard': json['excludeRatesHigherThanStandard'],
+        'excludePermanentDiscounts': json['excludePermanentDiscounts'],
+        'createdBy': json['createdBy'] == null ? undefined : UserFromJSON(json['createdBy']),
+        'createdById': json['createdById'],
+        'createdAt': (json['createdAt'] == null ? null : new Date(json['createdAt'])),
+        'updatedBy': json['updatedBy'] == null ? undefined : UserFromJSON(json['updatedBy']),
+        'updatedById': json['updatedById'],
+        'updatedAt': (json['updatedAt'] == null ? null : new Date(json['updatedAt'])),
+        'pricingRule': json['pricingRule'] == null ? undefined : PricingRuleFromJSON(json['pricingRule']),
+        'pricingRuleId': json['pricingRuleId'],
+    };
+}
+
+export function PricingRuleCriteriaToJSON(json: any): PricingRuleCriteria {
+    return PricingRuleCriteriaToJSONTyped(json, false);
+}
+
+export function PricingRuleCriteriaToJSONTyped(value?: PricingRuleCriteria | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'org': OrgToJSON(value['org']),
+        'orgId': value['orgId'],
+        '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'],
+        'createdBy': UserToJSON(value['createdBy']),
+        'createdById': value['createdById'],
+        'createdAt': (value['createdAt'] == null ? null : (value['createdAt'] as any).toISOString()),
+        'updatedBy': UserToJSON(value['updatedBy']),
+        'updatedById': value['updatedById'],
+        'updatedAt': (value['updatedAt'] == null ? null : (value['updatedAt'] as any).toISOString()),
+        'pricingRule': PricingRuleToJSON(value['pricingRule']),
+        'pricingRuleId': value['pricingRuleId'],
+    };
+}
+

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

@@ -0,0 +1,282 @@
+/* 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 { User } from './user';
+import {
+    UserFromJSON,
+    UserFromJSONTyped,
+    UserToJSON,
+    UserToJSONTyped,
+} from './user';
+import type { Org } from './org';
+import {
+    OrgFromJSON,
+    OrgFromJSONTyped,
+    OrgToJSON,
+    OrgToJSONTyped,
+} from './org';
+import type { PricingRule } from './pricing-rule';
+import {
+    PricingRuleFromJSON,
+    PricingRuleFromJSONTyped,
+    PricingRuleToJSON,
+    PricingRuleToJSONTyped,
+} from './pricing-rule';
+
+/**
+ * 
+ * @export
+ * @interface PricingRuleLegend
+ */
+export interface PricingRuleLegend {
+    /**
+     * Rate change legend ID
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    id: string;
+    /**
+     * 
+     * @type {Org}
+     * @memberof PricingRuleLegend
+     */
+    org?: Org;
+    /**
+     * 
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    orgId: string;
+    /**
+     * Suggested rates are more than x% of the subscription rate
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    moreThanPercent: string | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    moreThanPercentColour: string | null;
+    /**
+     * Suggested rates are more than x of the subscription rate
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    moreThanFixed: string | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    moreThanFixedColour: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PricingRuleLegend
+     */
+    rateChangeInterval: number | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    rateChangeIntervalColour: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof PricingRuleLegend
+     */
+    daysSinceMoveIn: number | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    daysSinceMoveInColour: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    moreThanStandardPercent: string | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    moreThanStandardPercentColour: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    lessThanStandardPercent: string | null;
+    /**
+     * Hex colour code for the legend
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    lessThanStandardPercentColour: string | null;
+    /**
+     * Who created the note
+     * @type {User}
+     * @memberof PricingRuleLegend
+     */
+    createdBy?: User;
+    /**
+     * 
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    createdById: string;
+    /**
+     * When the note was created
+     * @type {Date}
+     * @memberof PricingRuleLegend
+     */
+    createdAt: Date | null;
+    /**
+     * Who updated the note
+     * @type {User}
+     * @memberof PricingRuleLegend
+     */
+    updatedBy?: User | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    updatedById: string | null;
+    /**
+     * When the note was last updated
+     * @type {Date}
+     * @memberof PricingRuleLegend
+     */
+    updatedAt: Date | null;
+    /**
+     * 
+     * @type {PricingRule}
+     * @memberof PricingRuleLegend
+     */
+    pricingRule?: PricingRule;
+    /**
+     * 
+     * @type {string}
+     * @memberof PricingRuleLegend
+     */
+    pricingRuleId: string;
+}
+
+/**
+ * Check if a given object implements the PricingRuleLegend interface.
+ */
+export function instanceOfPricingRuleLegend(value: object): value is PricingRuleLegend {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('orgId' in value) || value['orgId'] === undefined) return false;
+    if (!('moreThanPercent' in value) || value['moreThanPercent'] === undefined) return false;
+    if (!('moreThanPercentColour' in value) || value['moreThanPercentColour'] === undefined) return false;
+    if (!('moreThanFixed' in value) || value['moreThanFixed'] === undefined) return false;
+    if (!('moreThanFixedColour' in value) || value['moreThanFixedColour'] === undefined) return false;
+    if (!('rateChangeInterval' in value) || value['rateChangeInterval'] === undefined) return false;
+    if (!('rateChangeIntervalColour' in value) || value['rateChangeIntervalColour'] === undefined) return false;
+    if (!('daysSinceMoveIn' in value) || value['daysSinceMoveIn'] === undefined) return false;
+    if (!('daysSinceMoveInColour' in value) || value['daysSinceMoveInColour'] === undefined) return false;
+    if (!('moreThanStandardPercent' in value) || value['moreThanStandardPercent'] === undefined) return false;
+    if (!('moreThanStandardPercentColour' in value) || value['moreThanStandardPercentColour'] === undefined) return false;
+    if (!('lessThanStandardPercent' in value) || value['lessThanStandardPercent'] === undefined) return false;
+    if (!('lessThanStandardPercentColour' in value) || value['lessThanStandardPercentColour'] === undefined) return false;
+    if (!('createdById' in value) || value['createdById'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedById' in value) || value['updatedById'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('pricingRuleId' in value) || value['pricingRuleId'] === undefined) return false;
+    return true;
+}
+
+export function PricingRuleLegendFromJSON(json: any): PricingRuleLegend {
+    return PricingRuleLegendFromJSONTyped(json, false);
+}
+
+export function PricingRuleLegendFromJSONTyped(json: any, ignoreDiscriminator: boolean): PricingRuleLegend {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'org': json['org'] == null ? undefined : OrgFromJSON(json['org']),
+        'orgId': json['orgId'],
+        'moreThanPercent': json['moreThanPercent'],
+        'moreThanPercentColour': json['moreThanPercentColour'],
+        'moreThanFixed': json['moreThanFixed'],
+        'moreThanFixedColour': json['moreThanFixedColour'],
+        'rateChangeInterval': json['rateChangeInterval'],
+        'rateChangeIntervalColour': json['rateChangeIntervalColour'],
+        'daysSinceMoveIn': json['daysSinceMoveIn'],
+        'daysSinceMoveInColour': json['daysSinceMoveInColour'],
+        'moreThanStandardPercent': json['moreThanStandardPercent'],
+        'moreThanStandardPercentColour': json['moreThanStandardPercentColour'],
+        'lessThanStandardPercent': json['lessThanStandardPercent'],
+        'lessThanStandardPercentColour': json['lessThanStandardPercentColour'],
+        'createdBy': json['createdBy'] == null ? undefined : UserFromJSON(json['createdBy']),
+        'createdById': json['createdById'],
+        'createdAt': (json['createdAt'] == null ? null : new Date(json['createdAt'])),
+        'updatedBy': json['updatedBy'] == null ? undefined : UserFromJSON(json['updatedBy']),
+        'updatedById': json['updatedById'],
+        'updatedAt': (json['updatedAt'] == null ? null : new Date(json['updatedAt'])),
+        'pricingRule': json['pricingRule'] == null ? undefined : PricingRuleFromJSON(json['pricingRule']),
+        'pricingRuleId': json['pricingRuleId'],
+    };
+}
+
+export function PricingRuleLegendToJSON(json: any): PricingRuleLegend {
+    return PricingRuleLegendToJSONTyped(json, false);
+}
+
+export function PricingRuleLegendToJSONTyped(value?: PricingRuleLegend | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'org': OrgToJSON(value['org']),
+        'orgId': value['orgId'],
+        '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'],
+        'createdBy': UserToJSON(value['createdBy']),
+        'createdById': value['createdById'],
+        'createdAt': (value['createdAt'] == null ? null : (value['createdAt'] as any).toISOString()),
+        'updatedBy': UserToJSON(value['updatedBy']),
+        'updatedById': value['updatedById'],
+        'updatedAt': (value['updatedAt'] == null ? null : (value['updatedAt'] as any).toISOString()),
+        'pricingRule': PricingRuleToJSON(value['pricingRule']),
+        'pricingRuleId': value['pricingRuleId'],
+    };
+}
+