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

package/src/generated/models/create-payment-refund.ts

@@ -30,7 +30,7 @@ export interface CreatePaymentRefund {
      * @type {string}
      * @memberof CreatePaymentRefund
      */
-    amountApplied: string;
+    refundAmount: string;
 }
 
 /**
@@ -38,7 +38,7 @@ export interface CreatePaymentRefund {
  */
 export function instanceOfCreatePaymentRefund(value: object): value is CreatePaymentRefund {
     if (!('id' in value) || value['id'] === undefined) return false;
-    if (!('amountApplied' in value) || value['amountApplied'] === undefined) return false;
+    if (!('refundAmount' in value) || value['refundAmount'] === undefined) return false;
     return true;
 }
 
@@ -53,7 +53,7 @@ export function CreatePaymentRefundFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'id': json['id'],
-        'amountApplied': json['amountApplied'],
+        'refundAmount': json['refundAmount'],
     };
 }
 
@@ -69,7 +69,7 @@ export function CreatePaymentRefundToJSONTyped(value?: CreatePaymentRefund | nul
     return {
         
         'id': value['id'],
-        'amountApplied': value['amountApplied'],
+        'refundAmount': value['refundAmount'],
     };
 }
 

package/src/generated/models/create-payment.ts

@@ -57,19 +57,13 @@ export interface CreatePayment {
      * @type {string}
      * @memberof CreatePayment
      */
-    status: string;
+    status?: string;
     /**
      * Total amount of payment
      * @type {string}
      * @memberof CreatePayment
      */
     paymentAmount: string;
-    /**
-     * Transaction Fee
-     * @type {string}
-     * @memberof CreatePayment
-     */
-    feeAmount?: string;
     /**
      * Amount of payment applied to invoices
      * @type {string}
@@ -171,7 +165,7 @@ export interface CreatePayment {
      * @type {string}
      * @memberof CreatePayment
      */
-    glAccount: string;
+    glAccount?: string;
     /**
      * Number of retry attempts made
      * @type {number}
@@ -196,6 +190,12 @@ export interface CreatePayment {
      * @memberof CreatePayment
      */
     assetId?: string;
+    /**
+     * Order Id to apply payment to
+     * @type {string}
+     * @memberof CreatePayment
+     */
+    orderId?: string;
 }
 
 /**
@@ -204,12 +204,10 @@ export interface CreatePayment {
 export function instanceOfCreatePayment(value: object): value is CreatePayment {
     if (!('customerId' in value) || value['customerId'] === undefined) return false;
     if (!('paymentDate' in value) || value['paymentDate'] === undefined) return false;
-    if (!('status' in value) || value['status'] === undefined) return false;
     if (!('paymentAmount' in value) || value['paymentAmount'] === undefined) return false;
     if (!('paymentType' in value) || value['paymentType'] === undefined) return false;
     if (!('currency' in value) || value['currency'] === undefined) return false;
     if (!('autoApply' in value) || value['autoApply'] === undefined) return false;
-    if (!('glAccount' in value) || value['glAccount'] === undefined) return false;
     return true;
 }
 
@@ -226,9 +224,8 @@ export function CreatePaymentFromJSONTyped(json: any, ignoreDiscriminator: boole
         'customerId': json['customerId'],
         'paymentDate': json['paymentDate'],
         'notes': json['notes'] == null ? undefined : json['notes'],
-        'status': json['status'],
+        'status': json['status'] == null ? undefined : json['status'],
         'paymentAmount': json['paymentAmount'],
-        'feeAmount': json['feeAmount'] == null ? undefined : json['feeAmount'],
         'appliedAmount': json['appliedAmount'] == null ? undefined : json['appliedAmount'],
         'unappliedAmount': json['unappliedAmount'] == null ? undefined : json['unappliedAmount'],
         'refundedAmount': json['refundedAmount'] == null ? undefined : json['refundedAmount'],
@@ -245,11 +242,12 @@ export function CreatePaymentFromJSONTyped(json: any, ignoreDiscriminator: boole
         'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
         'invoices': json['invoices'] == null ? undefined : ((json['invoices'] as Array<any>).map(CreatePaymentInvoiceFromJSON)),
         'refunds': json['refunds'] == null ? undefined : ((json['refunds'] as Array<any>).map(CreatePaymentRefundFromJSON)),
-        'glAccount': json['glAccount'],
+        'glAccount': json['glAccount'] == null ? undefined : json['glAccount'],
         'retriedAttempts': json['retriedAttempts'] == null ? undefined : json['retriedAttempts'],
         'gatewayName': json['gatewayName'] == null ? undefined : json['gatewayName'],
         'emailStatus': json['emailStatus'] == null ? undefined : json['emailStatus'],
         'assetId': json['assetId'] == null ? undefined : json['assetId'],
+        'orderId': json['orderId'] == null ? undefined : json['orderId'],
     };
 }
 
@@ -269,7 +267,6 @@ export function CreatePaymentToJSONTyped(value?: CreatePayment | null, ignoreDis
         'notes': value['notes'],
         'status': value['status'],
         'paymentAmount': value['paymentAmount'],
-        'feeAmount': value['feeAmount'],
         'appliedAmount': value['appliedAmount'],
         'unappliedAmount': value['unappliedAmount'],
         'refundedAmount': value['refundedAmount'],
@@ -291,6 +288,7 @@ export function CreatePaymentToJSONTyped(value?: CreatePayment | null, ignoreDis
         'gatewayName': value['gatewayName'],
         'emailStatus': value['emailStatus'],
         'assetId': value['assetId'],
+        'orderId': value['orderId'],
     };
 }
 

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

@@ -13,6 +13,21 @@
  */
 
 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
@@ -26,29 +41,209 @@ export interface CreatePlanCharge {
      */
     productId: string;
     /**
-     * Charge name
+     * Name of charge
      * @type {string}
      * @memberof CreatePlanCharge
      */
     name: string;
+    /**
+     * Description of charge
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    description?: string;
     /**
      * Type of charge
      * @type {string}
      * @memberof CreatePlanCharge
      */
-    type: string;
+    type?: string;
+    /**
+     * timing of one-time charge, to process at start of contract or termination
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    timing?: string;
     /**
-     * Original unit price of Charge
+     * For one-time charges, date charge goes into effect; for custom billing period, provide Billing Period Name
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    effectiveDate?: string;
+    /**
+     * Defines trigger date after which the one-time charges should be processed
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    billingDate?: string;
+    /**
+     * Date can drive bililng and/or revenue recognition upon completion of task
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    completionDate?: string;
+    /**
+     * How charge is priced
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    pricingModel?: string;
+    /**
+     * Original unit price of charge
      * @type {string}
      * @memberof CreatePlanCharge
      */
     listPrice?: string;
     /**
-     * Billing period for recurring and usage based Charges
+     * For recurring charges, time of charges 
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    chargeTiming?: string;
+    /**
+     * List price base of charge
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    listPriceBase?: string;
+    /**
+     * Billing period
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    billingPeriod?: string;
+    /**
+     * Which day of the month or week Charge is invoiced
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    billingDay?: string;
+    /**
+     * Determine boundary of Charge period
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    billingPeriodStartAlignment?: string;
+    /**
+     * Charge for partial periods
+     * @type {boolean}
+     * @memberof CreatePlanCharge
+     */
+    proratePartialPeriods?: boolean;
+    /**
+     * Number of periods/units to charge
+     * @type {number}
+     * @memberof CreatePlanCharge
+     */
+    prepaymentPeriods?: number;
+    /**
+     * If there is a number of prepayment units you request
+     * @type {number}
+     * @memberof CreatePlanCharge
+     */
+    prepaymentAmount?: number;
+    /**
+     * For usage charges, unit of measure for charge
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    unitOfMeasure?: string;
+    /**
+     * Number of units included in plan for usage based charges (can be float)
+     * @type {number}
+     * @memberof CreatePlanCharge
+     */
+    includedUnits?: number;
+    /**
+     * Unused prepayment units remaining for charge
+     * @type {number}
+     * @memberof CreatePlanCharge
+     */
+    unusedPrepaymentUnits?: number;
+    /**
+     * For tiered/volume pricing, each tier will represent price of specific units in given range
+     * @type {Array<ChargeTier>}
+     * @memberof CreatePlanCharge
+     */
+    tiers?: Array<ChargeTier>;
+    /**
+     * Determines proration logic
+     * @type {boolean}
+     * @memberof CreatePlanCharge
+     */
+    backchargeCurrentPeriod?: boolean;
+    /**
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof CreatePlanCharge
+     */
+    customFields?: object;
+    /**
+     * Ability to bill your customers for a present number of units
+     * @type {boolean}
+     * @memberof CreatePlanCharge
+     */
+    prepaidUnitsEnable?: boolean;
+    /**
+     * Ability to automatically refill number of prepaid units
+     * @type {boolean}
+     * @memberof CreatePlanCharge
+     */
+    autoRefillPrepaymentUnits?: boolean;
+    /**
+     * Refill quantity
+     * @type {number}
+     * @memberof CreatePlanCharge
+     */
+    refillQty?: number;
+    /**
+     * Prepayment refill period
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    refillPrepaidUnitsFor?: string;
+    /**
+     * Remaining balance of prepaid units
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    prepaidUnitsExpiry?: string;
+    /**
+     * Remaining balance of prepaid units to be refunded
+     * @type {boolean}
+     * @memberof CreatePlanCharge
+     */
+    refundUnitsOnCancel?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CreatePlanCharge
+     */
+    defaultFromProduct?: boolean;
+    /**
+     * Revenue Rule ID
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    revenueRuleId?: string;
+    /**
+     * Date when revenue recognition will begin
+     * @type {string}
+     * @memberof CreatePlanCharge
+     */
+    recognitionStartDate?: string;
+    /**
+     * Transaction type
+     * @type {Array<TransactionPostingEntries>}
+     * @memberof CreatePlanCharge
+     */
+    transactionPostingEntries?: Array<TransactionPostingEntries>;
+    /**
+     * Charge ID
      * @type {string}
      * @memberof CreatePlanCharge
      */
-    billingPeriod: string;
+    id?: string;
 }
 
 /**
@@ -57,8 +252,6 @@ export interface CreatePlanCharge {
 export function instanceOfCreatePlanCharge(value: object): value is CreatePlanCharge {
     if (!('productId' in value) || value['productId'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
-    if (!('type' in value) || value['type'] === undefined) return false;
-    if (!('billingPeriod' in value) || value['billingPeriod'] === undefined) return false;
     return true;
 }
 
@@ -74,9 +267,39 @@ export function CreatePlanChargeFromJSONTyped(json: any, ignoreDiscriminator: bo
         
         'productId': json['productId'],
         'name': json['name'],
-        'type': json['type'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'timing': json['timing'] == null ? undefined : json['timing'],
+        'effectiveDate': json['effectiveDate'] == null ? undefined : json['effectiveDate'],
+        'billingDate': json['billingDate'] == null ? undefined : json['billingDate'],
+        'completionDate': json['completionDate'] == null ? undefined : json['completionDate'],
+        'pricingModel': json['pricingModel'] == null ? undefined : json['pricingModel'],
         'listPrice': json['listPrice'] == null ? undefined : json['listPrice'],
-        'billingPeriod': json['billingPeriod'],
+        'chargeTiming': json['chargeTiming'] == null ? undefined : json['chargeTiming'],
+        'listPriceBase': json['listPriceBase'] == null ? undefined : json['listPriceBase'],
+        'billingPeriod': json['billingPeriod'] == null ? undefined : json['billingPeriod'],
+        'billingDay': json['billingDay'] == null ? undefined : json['billingDay'],
+        'billingPeriodStartAlignment': json['billingPeriodStartAlignment'] == null ? undefined : json['billingPeriodStartAlignment'],
+        'proratePartialPeriods': json['proratePartialPeriods'] == null ? undefined : json['proratePartialPeriods'],
+        'prepaymentPeriods': json['prepaymentPeriods'] == null ? undefined : json['prepaymentPeriods'],
+        'prepaymentAmount': json['prepaymentAmount'] == null ? undefined : json['prepaymentAmount'],
+        'unitOfMeasure': json['unitOfMeasure'] == null ? undefined : json['unitOfMeasure'],
+        'includedUnits': json['includedUnits'] == null ? undefined : json['includedUnits'],
+        'unusedPrepaymentUnits': json['unusedPrepaymentUnits'] == null ? undefined : json['unusedPrepaymentUnits'],
+        'tiers': json['tiers'] == null ? undefined : ((json['tiers'] as Array<any>).map(ChargeTierFromJSON)),
+        'backchargeCurrentPeriod': json['backchargeCurrentPeriod'] == null ? undefined : json['backchargeCurrentPeriod'],
+        'customFields': json['customFields'] == null ? undefined : json['customFields'],
+        'prepaidUnitsEnable': json['prepaidUnitsEnable'] == null ? undefined : json['prepaidUnitsEnable'],
+        'autoRefillPrepaymentUnits': json['autoRefillPrepaymentUnits'] == null ? undefined : json['autoRefillPrepaymentUnits'],
+        'refillQty': json['refillQty'] == null ? undefined : json['refillQty'],
+        'refillPrepaidUnitsFor': json['refillPrepaidUnitsFor'] == null ? undefined : json['refillPrepaidUnitsFor'],
+        'prepaidUnitsExpiry': json['prepaidUnitsExpiry'] == null ? undefined : json['prepaidUnitsExpiry'],
+        'refundUnitsOnCancel': json['refundUnitsOnCancel'] == null ? undefined : json['refundUnitsOnCancel'],
+        'defaultFromProduct': json['defaultFromProduct'] == null ? undefined : json['defaultFromProduct'],
+        'revenueRuleId': json['revenueRuleId'] == null ? undefined : json['revenueRuleId'],
+        'recognitionStartDate': json['recognitionStartDate'] == null ? undefined : json['recognitionStartDate'],
+        'transactionPostingEntries': json['transactionPostingEntries'] == null ? undefined : ((json['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
+        'id': json['id'] == null ? undefined : json['id'],
     };
 }
 
@@ -93,9 +316,39 @@ export function CreatePlanChargeToJSONTyped(value?: CreatePlanCharge | null, ign
         
         'productId': value['productId'],
         'name': value['name'],
+        'description': value['description'],
         'type': value['type'],
+        'timing': value['timing'],
+        'effectiveDate': value['effectiveDate'],
+        'billingDate': value['billingDate'],
+        'completionDate': value['completionDate'],
+        'pricingModel': value['pricingModel'],
         'listPrice': value['listPrice'],
+        'chargeTiming': value['chargeTiming'],
+        'listPriceBase': value['listPriceBase'],
         'billingPeriod': value['billingPeriod'],
+        'billingDay': value['billingDay'],
+        'billingPeriodStartAlignment': value['billingPeriodStartAlignment'],
+        'proratePartialPeriods': value['proratePartialPeriods'],
+        'prepaymentPeriods': value['prepaymentPeriods'],
+        'prepaymentAmount': value['prepaymentAmount'],
+        'unitOfMeasure': value['unitOfMeasure'],
+        'includedUnits': value['includedUnits'],
+        'unusedPrepaymentUnits': value['unusedPrepaymentUnits'],
+        'tiers': value['tiers'] == null ? undefined : ((value['tiers'] as Array<any>).map(ChargeTierToJSON)),
+        'backchargeCurrentPeriod': value['backchargeCurrentPeriod'],
+        'customFields': value['customFields'],
+        'prepaidUnitsEnable': value['prepaidUnitsEnable'],
+        'autoRefillPrepaymentUnits': value['autoRefillPrepaymentUnits'],
+        'refillQty': value['refillQty'],
+        'refillPrepaidUnitsFor': value['refillPrepaidUnitsFor'],
+        'prepaidUnitsExpiry': value['prepaidUnitsExpiry'],
+        'refundUnitsOnCancel': value['refundUnitsOnCancel'],
+        'defaultFromProduct': value['defaultFromProduct'],
+        'revenueRuleId': value['revenueRuleId'],
+        'recognitionStartDate': value['recognitionStartDate'],
+        'transactionPostingEntries': value['transactionPostingEntries'] == null ? undefined : ((value['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesToJSON)),
+        'id': value['id'],
     };
 }
 

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'],
+    };
+}
+