@managespace/sdk 0.0.69 → 0.0.71

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

@@ -20,6 +20,13 @@ import {
     TransactionPostingEntriesToJSON,
     TransactionPostingEntriesToJSONTyped,
 } from './transaction-posting-entries';
+import type { ChargeTier } from './charge-tier';
+import {
+    ChargeTierFromJSON,
+    ChargeTierFromJSONTyped,
+    ChargeTierToJSON,
+    ChargeTierToJSONTyped,
+} from './charge-tier';
 
 /**
  * 
@@ -27,12 +34,6 @@ import {
  * @interface ChargeResponse
  */
 export interface ChargeResponse {
-    /**
-     * Charge ID
-     * @type {string}
-     * @memberof ChargeResponse
-     */
-    id: string;
     /**
      * Product ID
      * @type {string}
@@ -58,17 +59,29 @@ export interface ChargeResponse {
      */
     type: string;
     /**
-     * Line Number
-     * @type {number}
+     * timing of one-time charge, to process at start of contract or termination
+     * @type {string}
      * @memberof ChargeResponse
      */
-    lineNumber: number;
+    timing: string;
     /**
-     * Time of charges 
+     * For one-time charges, date charge goes into effect; for custom billing period, provide Billing Period Name
      * @type {string}
      * @memberof ChargeResponse
      */
-    chargeTiming: string;
+    effectiveDate: string;
+    /**
+     * Defines trigger date after which the one-time charges should be processed
+     * @type {string}
+     * @memberof ChargeResponse
+     */
+    billingDate: string;
+    /**
+     * Date can drive bililng and/or revenue recognition upon completion of task
+     * @type {string}
+     * @memberof ChargeResponse
+     */
+    completionDate: string;
     /**
      * How charge is priced
      * @type {string}
@@ -81,6 +94,12 @@ export interface ChargeResponse {
      * @memberof ChargeResponse
      */
     listPrice: string;
+    /**
+     * Time of charges 
+     * @type {string}
+     * @memberof ChargeResponse
+     */
+    chargeTiming: string;
     /**
      * List price base of charge
      * @type {string}
@@ -94,23 +113,59 @@ export interface ChargeResponse {
      */
     billingPeriod: string;
     /**
-     * Determine boundary of Charge period
+     * Which day of the month or week Charge is invoiced
      * @type {string}
      * @memberof ChargeResponse
      */
-    billingPeriodStartAlignment: string;
+    billingDay: string;
     /**
-     * Which day of the month or week Charge is invoiced
+     * Determine boundary of Charge period
      * @type {string}
      * @memberof ChargeResponse
      */
-    billingDay: string;
+    billingPeriodStartAlignment: string;
     /**
      * Charge for partial periods
      * @type {boolean}
      * @memberof ChargeResponse
      */
     proratePartialPeriods: boolean;
+    /**
+     * Number of periods/units to charge
+     * @type {number}
+     * @memberof ChargeResponse
+     */
+    prepaymentPeriods: number;
+    /**
+     * If there is a number of prepayment units you request
+     * @type {number}
+     * @memberof ChargeResponse
+     */
+    prepaymentAmount: number;
+    /**
+     * For usage charges, unit of measure for charge
+     * @type {string}
+     * @memberof ChargeResponse
+     */
+    unitOfMeasure: string;
+    /**
+     * Number of units included in plan for usage based charges (can be float)
+     * @type {number}
+     * @memberof ChargeResponse
+     */
+    includedUnits: number;
+    /**
+     * Unused prepayment units remaining for charge
+     * @type {number}
+     * @memberof ChargeResponse
+     */
+    unusedPrepaymentUnits: number;
+    /**
+     * For tiered/volume pricing, each tier will represent price of specific units in given range
+     * @type {Array<ChargeTier>}
+     * @memberof ChargeResponse
+     */
+    tiers: Array<ChargeTier>;
     /**
      * Determines proration logic
      * @type {boolean}
@@ -118,11 +173,47 @@ export interface ChargeResponse {
      */
     backchargeCurrentPeriod: boolean;
     /**
-     * Number of periods/units to charge
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof ChargeResponse
+     */
+    customFields: object;
+    /**
+     * Ability to bill your customers for a present number of units
+     * @type {boolean}
+     * @memberof ChargeResponse
+     */
+    prepaidUnitsEnable: boolean;
+    /**
+     * Ability to automatically refill number of prepaid units
+     * @type {boolean}
+     * @memberof ChargeResponse
+     */
+    autoRefillPrepaymentUnits: boolean;
+    /**
+     * Refill quantity
      * @type {number}
      * @memberof ChargeResponse
      */
-    prepaymentPeriods: number;
+    refillQty: number;
+    /**
+     * Prepayment refill period
+     * @type {string}
+     * @memberof ChargeResponse
+     */
+    refillPrepaidUnitsFor: string;
+    /**
+     * Remaining balance of prepaid units
+     * @type {string}
+     * @memberof ChargeResponse
+     */
+    prepaidUnitsExpiry: string;
+    /**
+     * Remaining balance of prepaid units to be refunded
+     * @type {boolean}
+     * @memberof ChargeResponse
+     */
+    refundUnitsOnCancel: boolean;
     /**
      * 
      * @type {boolean}
@@ -141,12 +232,6 @@ export interface ChargeResponse {
      * @memberof ChargeResponse
      */
     recognitionStartDate: string;
-    /**
-     * Date when revenue recognition will begin
-     * @type {string}
-     * @memberof ChargeResponse
-     */
-    recognitionEndDate: string;
     /**
      * Transaction type
      * @type {Array<TransactionPostingEntries>}
@@ -154,39 +239,59 @@ export interface ChargeResponse {
      */
     transactionPostingEntries: Array<TransactionPostingEntries>;
     /**
-     * Custom fields on the invoice
-     * @type {object}
+     * Charge ID
+     * @type {string}
      * @memberof ChargeResponse
      */
-    customFields: object;
+    id: string;
+    /**
+     * For one-time charges, date when customer will be billed
+     * @type {string}
+     * @memberof ChargeResponse
+     */
+    chargeBillingDate: string;
 }
 
 /**
  * Check if a given object implements the ChargeResponse interface.
  */
 export function instanceOfChargeResponse(value: object): value is ChargeResponse {
-    if (!('id' in value) || value['id'] === undefined) return false;
     if (!('productId' in value) || value['productId'] === undefined) return false;
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('description' in value) || value['description'] === undefined) return false;
     if (!('type' in value) || value['type'] === undefined) return false;
-    if (!('lineNumber' in value) || value['lineNumber'] === undefined) return false;
-    if (!('chargeTiming' in value) || value['chargeTiming'] === undefined) return false;
+    if (!('timing' in value) || value['timing'] === undefined) return false;
+    if (!('effectiveDate' in value) || value['effectiveDate'] === undefined) return false;
+    if (!('billingDate' in value) || value['billingDate'] === undefined) return false;
+    if (!('completionDate' in value) || value['completionDate'] === undefined) return false;
     if (!('pricingModel' in value) || value['pricingModel'] === undefined) return false;
     if (!('listPrice' in value) || value['listPrice'] === undefined) return false;
+    if (!('chargeTiming' in value) || value['chargeTiming'] === undefined) return false;
     if (!('listPriceBase' in value) || value['listPriceBase'] === undefined) return false;
     if (!('billingPeriod' in value) || value['billingPeriod'] === undefined) return false;
-    if (!('billingPeriodStartAlignment' in value) || value['billingPeriodStartAlignment'] === undefined) return false;
     if (!('billingDay' in value) || value['billingDay'] === undefined) return false;
+    if (!('billingPeriodStartAlignment' in value) || value['billingPeriodStartAlignment'] === undefined) return false;
     if (!('proratePartialPeriods' in value) || value['proratePartialPeriods'] === undefined) return false;
-    if (!('backchargeCurrentPeriod' in value) || value['backchargeCurrentPeriod'] === undefined) return false;
     if (!('prepaymentPeriods' in value) || value['prepaymentPeriods'] === undefined) return false;
+    if (!('prepaymentAmount' in value) || value['prepaymentAmount'] === undefined) return false;
+    if (!('unitOfMeasure' in value) || value['unitOfMeasure'] === undefined) return false;
+    if (!('includedUnits' in value) || value['includedUnits'] === undefined) return false;
+    if (!('unusedPrepaymentUnits' in value) || value['unusedPrepaymentUnits'] === undefined) return false;
+    if (!('tiers' in value) || value['tiers'] === undefined) return false;
+    if (!('backchargeCurrentPeriod' in value) || value['backchargeCurrentPeriod'] === undefined) return false;
+    if (!('customFields' in value) || value['customFields'] === undefined) return false;
+    if (!('prepaidUnitsEnable' in value) || value['prepaidUnitsEnable'] === undefined) return false;
+    if (!('autoRefillPrepaymentUnits' in value) || value['autoRefillPrepaymentUnits'] === undefined) return false;
+    if (!('refillQty' in value) || value['refillQty'] === undefined) return false;
+    if (!('refillPrepaidUnitsFor' in value) || value['refillPrepaidUnitsFor'] === undefined) return false;
+    if (!('prepaidUnitsExpiry' in value) || value['prepaidUnitsExpiry'] === undefined) return false;
+    if (!('refundUnitsOnCancel' in value) || value['refundUnitsOnCancel'] === undefined) return false;
     if (!('defaultFromProduct' in value) || value['defaultFromProduct'] === undefined) return false;
     if (!('revenueRuleId' in value) || value['revenueRuleId'] === undefined) return false;
     if (!('recognitionStartDate' in value) || value['recognitionStartDate'] === undefined) return false;
-    if (!('recognitionEndDate' in value) || value['recognitionEndDate'] === undefined) return false;
     if (!('transactionPostingEntries' in value) || value['transactionPostingEntries'] === undefined) return false;
-    if (!('customFields' in value) || value['customFields'] === undefined) return false;
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('chargeBillingDate' in value) || value['chargeBillingDate'] === undefined) return false;
     return true;
 }
 
@@ -200,28 +305,42 @@ export function ChargeResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
     }
     return {
         
-        'id': json['id'],
         'productId': json['productId'],
         'name': json['name'],
         'description': json['description'],
         'type': json['type'],
-        'lineNumber': json['lineNumber'],
-        'chargeTiming': json['chargeTiming'],
+        'timing': json['timing'],
+        'effectiveDate': json['effectiveDate'],
+        'billingDate': json['billingDate'],
+        'completionDate': json['completionDate'],
         'pricingModel': json['pricingModel'],
         'listPrice': json['listPrice'],
+        'chargeTiming': json['chargeTiming'],
         'listPriceBase': json['listPriceBase'],
         'billingPeriod': json['billingPeriod'],
-        'billingPeriodStartAlignment': json['billingPeriodStartAlignment'],
         'billingDay': json['billingDay'],
+        'billingPeriodStartAlignment': json['billingPeriodStartAlignment'],
         'proratePartialPeriods': json['proratePartialPeriods'],
-        'backchargeCurrentPeriod': json['backchargeCurrentPeriod'],
         'prepaymentPeriods': json['prepaymentPeriods'],
+        'prepaymentAmount': json['prepaymentAmount'],
+        'unitOfMeasure': json['unitOfMeasure'],
+        'includedUnits': json['includedUnits'],
+        'unusedPrepaymentUnits': json['unusedPrepaymentUnits'],
+        'tiers': ((json['tiers'] as Array<any>).map(ChargeTierFromJSON)),
+        'backchargeCurrentPeriod': json['backchargeCurrentPeriod'],
+        'customFields': json['customFields'],
+        'prepaidUnitsEnable': json['prepaidUnitsEnable'],
+        'autoRefillPrepaymentUnits': json['autoRefillPrepaymentUnits'],
+        'refillQty': json['refillQty'],
+        'refillPrepaidUnitsFor': json['refillPrepaidUnitsFor'],
+        'prepaidUnitsExpiry': json['prepaidUnitsExpiry'],
+        'refundUnitsOnCancel': json['refundUnitsOnCancel'],
         'defaultFromProduct': json['defaultFromProduct'],
         'revenueRuleId': json['revenueRuleId'],
         'recognitionStartDate': json['recognitionStartDate'],
-        'recognitionEndDate': json['recognitionEndDate'],
         'transactionPostingEntries': ((json['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesFromJSON)),
-        'customFields': json['customFields'],
+        'id': json['id'],
+        'chargeBillingDate': json['chargeBillingDate'],
     };
 }
 
@@ -236,28 +355,42 @@ export function ChargeResponseToJSONTyped(value?: ChargeResponse | null, ignoreD
 
     return {
         
-        'id': value['id'],
         'productId': value['productId'],
         'name': value['name'],
         'description': value['description'],
         'type': value['type'],
-        'lineNumber': value['lineNumber'],
-        'chargeTiming': value['chargeTiming'],
+        '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'],
-        'billingPeriodStartAlignment': value['billingPeriodStartAlignment'],
         'billingDay': value['billingDay'],
+        'billingPeriodStartAlignment': value['billingPeriodStartAlignment'],
         'proratePartialPeriods': value['proratePartialPeriods'],
-        'backchargeCurrentPeriod': value['backchargeCurrentPeriod'],
         'prepaymentPeriods': value['prepaymentPeriods'],
+        'prepaymentAmount': value['prepaymentAmount'],
+        'unitOfMeasure': value['unitOfMeasure'],
+        'includedUnits': value['includedUnits'],
+        'unusedPrepaymentUnits': value['unusedPrepaymentUnits'],
+        'tiers': ((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'],
-        'recognitionEndDate': value['recognitionEndDate'],
         'transactionPostingEntries': ((value['transactionPostingEntries'] as Array<any>).map(TransactionPostingEntriesToJSON)),
-        'customFields': value['customFields'],
+        'id': value['id'],
+        'chargeBillingDate': value['chargeBillingDate'],
     };
 }
 

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