@managespace/sdk 0.0.90 → 0.0.92

package/src/generated/models/charge-tier.ts

@@ -0,0 +1,101 @@
+/* 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 ChargeTier
+ */
+export interface ChargeTier {
+    /**
+     * Tier number
+     * @type {number}
+     * @memberof ChargeTier
+     */
+    tier: number;
+    /**
+     * Unit that we will being charging the price in this tier
+     * @type {number}
+     * @memberof ChargeTier
+     */
+    startingUnit: number;
+    /**
+     * Unit we will end charging price in this tier
+     * @type {number}
+     * @memberof ChargeTier
+     */
+    endingUnit?: number;
+    /**
+     * Price per unit in this tier
+     * @type {string}
+     * @memberof ChargeTier
+     */
+    price: string;
+    /**
+     * Type of price for tier
+     * @type {string}
+     * @memberof ChargeTier
+     */
+    type: string;
+}
+
+/**
+ * Check if a given object implements the ChargeTier interface.
+ */
+export function instanceOfChargeTier(value: object): value is ChargeTier {
+    if (!('tier' in value) || value['tier'] === undefined) return false;
+    if (!('startingUnit' in value) || value['startingUnit'] === undefined) return false;
+    if (!('price' in value) || value['price'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    return true;
+}
+
+export function ChargeTierFromJSON(json: any): ChargeTier {
+    return ChargeTierFromJSONTyped(json, false);
+}
+
+export function ChargeTierFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChargeTier {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tier': json['tier'],
+        'startingUnit': json['startingUnit'],
+        'endingUnit': json['endingUnit'] == null ? undefined : json['endingUnit'],
+        'price': json['price'],
+        'type': json['type'],
+    };
+}
+
+export function ChargeTierToJSON(json: any): ChargeTier {
+    return ChargeTierToJSONTyped(json, false);
+}
+
+export function ChargeTierToJSONTyped(value?: ChargeTier | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tier': value['tier'],
+        'startingUnit': value['startingUnit'],
+        'endingUnit': value['endingUnit'],
+        'price': value['price'],
+        'type': value['type'],
+    };
+}
+

package/src/generated/models/configuration-setting-response.ts

@@ -66,7 +66,7 @@ export interface ConfigurationSettingResponse {
      */
     site?: SiteResponse | null;
     /**
-     * 
+     * Site ID that this setting is for
      * @type {string}
      * @memberof ConfigurationSettingResponse
      */

package/src/generated/models/create-billing-run.ts

@@ -13,13 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
-import type { BillingRunFilterOptionResponse } from './billing-run-filter-option-response';
+import type { BillingRunFilterOptions } from './billing-run-filter-options';
 import {
-    BillingRunFilterOptionResponseFromJSON,
-    BillingRunFilterOptionResponseFromJSONTyped,
-    BillingRunFilterOptionResponseToJSON,
-    BillingRunFilterOptionResponseToJSONTyped,
-} from './billing-run-filter-option-response';
+    BillingRunFilterOptionsFromJSON,
+    BillingRunFilterOptionsFromJSONTyped,
+    BillingRunFilterOptionsToJSON,
+    BillingRunFilterOptionsToJSONTyped,
+} from './billing-run-filter-options';
 
 /**
  * 
@@ -47,10 +47,10 @@ export interface CreateBillingRun {
     chargeType: string;
     /**
      * Filter options for billing run
-     * @type {BillingRunFilterOptionResponse}
+     * @type {BillingRunFilterOptions}
      * @memberof CreateBillingRun
      */
-    filterOptions?: BillingRunFilterOptionResponse;
+    filterOptions?: BillingRunFilterOptions;
     /**
      * Invoice statues automatically converted from Draft to Posted
      * @type {boolean}
@@ -62,31 +62,31 @@ export interface CreateBillingRun {
      * @type {boolean}
      * @memberof CreateBillingRun
      */
-    sendAfterPost: boolean;
+    sendAfterPost?: boolean;
     /**
      * Billing schedule where value is 0 will be excluded
      * @type {boolean}
      * @memberof CreateBillingRun
      */
-    skipZeroLines: boolean;
+    skipZeroLines?: boolean;
     /**
      * No email sent if total invoice amount and customer account balance equal to zero
      * @type {boolean}
      * @memberof CreateBillingRun
      */
-    doNotEmailIfInvoiceBalanceZero: boolean;
+    doNotEmailIfInvoiceBalanceZero?: boolean;
     /**
      * No email is sent if auto pay is enabled
      * @type {boolean}
      * @memberof CreateBillingRun
      */
-    doNotEmailIfAutoPayIsOnWithPaymentMethod: boolean;
+    doNotEmailIfAutoPayIsOnWithPaymentMethod?: boolean;
     /**
      * No email is sent if total invoice amount equal zero
      * @type {boolean}
      * @memberof CreateBillingRun
      */
-    doNotEmailIfInvoiceAmountZero: boolean;
+    doNotEmailIfInvoiceAmountZero?: boolean;
 }
 
 /**
@@ -97,11 +97,6 @@ export function instanceOfCreateBillingRun(value: object): value is CreateBillin
     if (!('invoiceDate' in value) || value['invoiceDate'] === undefined) return false;
     if (!('chargeType' in value) || value['chargeType'] === undefined) return false;
     if (!('autoPost' in value) || value['autoPost'] === undefined) return false;
-    if (!('sendAfterPost' in value) || value['sendAfterPost'] === undefined) return false;
-    if (!('skipZeroLines' in value) || value['skipZeroLines'] === undefined) return false;
-    if (!('doNotEmailIfInvoiceBalanceZero' in value) || value['doNotEmailIfInvoiceBalanceZero'] === undefined) return false;
-    if (!('doNotEmailIfAutoPayIsOnWithPaymentMethod' in value) || value['doNotEmailIfAutoPayIsOnWithPaymentMethod'] === undefined) return false;
-    if (!('doNotEmailIfInvoiceAmountZero' in value) || value['doNotEmailIfInvoiceAmountZero'] === undefined) return false;
     return true;
 }
 
@@ -118,13 +113,13 @@ export function CreateBillingRunFromJSONTyped(json: any, ignoreDiscriminator: bo
         'targetDate': json['targetDate'],
         'invoiceDate': json['invoiceDate'],
         'chargeType': json['chargeType'],
-        'filterOptions': json['filterOptions'] == null ? undefined : BillingRunFilterOptionResponseFromJSON(json['filterOptions']),
+        'filterOptions': json['filterOptions'] == null ? undefined : BillingRunFilterOptionsFromJSON(json['filterOptions']),
         'autoPost': json['autoPost'],
-        'sendAfterPost': json['sendAfterPost'],
-        'skipZeroLines': json['skipZeroLines'],
-        'doNotEmailIfInvoiceBalanceZero': json['doNotEmailIfInvoiceBalanceZero'],
-        'doNotEmailIfAutoPayIsOnWithPaymentMethod': json['doNotEmailIfAutoPayIsOnWithPaymentMethod'],
-        'doNotEmailIfInvoiceAmountZero': json['doNotEmailIfInvoiceAmountZero'],
+        'sendAfterPost': json['sendAfterPost'] == null ? undefined : json['sendAfterPost'],
+        'skipZeroLines': json['skipZeroLines'] == null ? undefined : json['skipZeroLines'],
+        'doNotEmailIfInvoiceBalanceZero': json['doNotEmailIfInvoiceBalanceZero'] == null ? undefined : json['doNotEmailIfInvoiceBalanceZero'],
+        'doNotEmailIfAutoPayIsOnWithPaymentMethod': json['doNotEmailIfAutoPayIsOnWithPaymentMethod'] == null ? undefined : json['doNotEmailIfAutoPayIsOnWithPaymentMethod'],
+        'doNotEmailIfInvoiceAmountZero': json['doNotEmailIfInvoiceAmountZero'] == null ? undefined : json['doNotEmailIfInvoiceAmountZero'],
     };
 }
 
@@ -142,7 +137,7 @@ export function CreateBillingRunToJSONTyped(value?: CreateBillingRun | null, ign
         'targetDate': value['targetDate'],
         'invoiceDate': value['invoiceDate'],
         'chargeType': value['chargeType'],
-        'filterOptions': BillingRunFilterOptionResponseToJSON(value['filterOptions']),
+        'filterOptions': BillingRunFilterOptionsToJSON(value['filterOptions']),
         'autoPost': value['autoPost'],
         'sendAfterPost': value['sendAfterPost'],
         'skipZeroLines': value['skipZeroLines'],

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

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

package/src/generated/models/create-configuration-setting.ts

@@ -27,6 +27,12 @@ import {
  * @interface CreateConfigurationSetting
  */
 export interface CreateConfigurationSetting {
+    /**
+     * Site ID that this setting is for
+     * @type {string}
+     * @memberof CreateConfigurationSetting
+     */
+    siteId?: string | null;
     /**
      * Name of setting
      * @type {string}
@@ -76,6 +82,7 @@ export function CreateConfigurationSettingFromJSONTyped(json: any, ignoreDiscrim
     }
     return {
         
+        'siteId': json['siteId'] == null ? undefined : json['siteId'],
         'name': json['name'],
         'description': json['description'],
         'type': ConfigurationSettingTypeFromJSON(json['type']),
@@ -94,6 +101,7 @@ export function CreateConfigurationSettingToJSONTyped(value?: CreateConfiguratio
 
     return {
         
+        'siteId': value['siteId'],
         'name': value['name'],
         'description': value['description'],
         'type': ConfigurationSettingTypeToJSON(value['type']),