@managespace/sdk 0.1.4 → 0.1.5-1.paul.dev

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

@@ -0,0 +1,155 @@
+/* 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 CreatePaymentMethod
+ */
+export interface CreatePaymentMethod {
+    /**
+     * Customers payment gateway id
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    customerPaymentGatewayId?: string;
+    /**
+     * Payment type
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    paymentType: string;
+    /**
+     * Type of card
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    type?: string;
+    /**
+     * Credit card or bank account number
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    accountNumber: string;
+    /**
+     * Routing number for bank accounts
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    routingNumber?: string;
+    /**
+     * Name on card or account
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    accountHolderName?: string;
+    /**
+     * Type of acccount owner
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    accountHolderType?: string;
+    /**
+     * Country of the account holder
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    country?: string;
+    /**
+     * Credit card expiration date
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    expiry?: string;
+    /**
+     * Account status for bank accounts
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    status?: string;
+    /**
+     * Enable defaule payment method
+     * @type {boolean}
+     * @memberof CreatePaymentMethod
+     */
+    _default?: boolean;
+    /**
+     * CVC, security code for payment method
+     * @type {string}
+     * @memberof CreatePaymentMethod
+     */
+    cvc?: string;
+}
+
+/**
+ * Check if a given object implements the CreatePaymentMethod interface.
+ */
+export function instanceOfCreatePaymentMethod(value: object): value is CreatePaymentMethod {
+    if (!('paymentType' in value) || value['paymentType'] === undefined) return false;
+    if (!('accountNumber' in value) || value['accountNumber'] === undefined) return false;
+    return true;
+}
+
+export function CreatePaymentMethodFromJSON(json: any): CreatePaymentMethod {
+    return CreatePaymentMethodFromJSONTyped(json, false);
+}
+
+export function CreatePaymentMethodFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreatePaymentMethod {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'customerPaymentGatewayId': json['customerPaymentGatewayId'] == null ? undefined : json['customerPaymentGatewayId'],
+        'paymentType': json['paymentType'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'accountNumber': json['accountNumber'],
+        'routingNumber': json['routingNumber'] == null ? undefined : json['routingNumber'],
+        'accountHolderName': json['accountHolderName'] == null ? undefined : json['accountHolderName'],
+        'accountHolderType': json['accountHolderType'] == null ? undefined : json['accountHolderType'],
+        'country': json['country'] == null ? undefined : json['country'],
+        'expiry': json['expiry'] == null ? undefined : json['expiry'],
+        'status': json['status'] == null ? undefined : json['status'],
+        '_default': json['default'] == null ? undefined : json['default'],
+        'cvc': json['cvc'] == null ? undefined : json['cvc'],
+    };
+}
+
+export function CreatePaymentMethodToJSON(json: any): CreatePaymentMethod {
+    return CreatePaymentMethodToJSONTyped(json, false);
+}
+
+export function CreatePaymentMethodToJSONTyped(value?: CreatePaymentMethod | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'customerPaymentGatewayId': value['customerPaymentGatewayId'],
+        'paymentType': value['paymentType'],
+        'type': value['type'],
+        'accountNumber': value['accountNumber'],
+        'routingNumber': value['routingNumber'],
+        'accountHolderName': value['accountHolderName'],
+        'accountHolderType': value['accountHolderType'],
+        'country': value['country'],
+        'expiry': value['expiry'],
+        'status': value['status'],
+        'default': value['_default'],
+        'cvc': value['cvc'],
+    };
+}
+

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

@@ -57,7 +57,7 @@ export interface CreatePayment {
      * @type {string}
      * @memberof CreatePayment
      */
-    status: string;
+    status?: string;
     /**
      * Total amount of payment
      * @type {string}
@@ -171,7 +171,7 @@ export interface CreatePayment {
      * @type {string}
      * @memberof CreatePayment
      */
-    glAccount: string;
+    glAccount?: string;
     /**
      * Number of retry attempts made
      * @type {number}
@@ -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,7 +224,7 @@ 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'],
@@ -245,7 +243,7 @@ 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'],

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-product-custom.ts

@@ -52,11 +52,17 @@ export interface CreateProductCustom {
      */
     taxable?: boolean;
     /**
-     * Indicated whether it is the default product or not
+     * Indicates whether it is the default product or not
      * @type {boolean}
      * @memberof CreateProductCustom
      */
     isDefault?: boolean;
+    /**
+     * Indicates whether it is related to rent or not
+     * @type {boolean}
+     * @memberof CreateProductCustom
+     */
+    rentRelated: boolean;
     /**
      * Description of product
      * @type {string}
@@ -112,6 +118,7 @@ export interface CreateProductCustom {
  */
 export function instanceOfCreateProductCustom(value: object): value is CreateProductCustom {
     if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('rentRelated' in value) || value['rentRelated'] === undefined) return false;
     if (!('price' in value) || value['price'] === undefined) return false;
     if (!('revenueRuleId' in value) || value['revenueRuleId'] === undefined) return false;
     if (!('recognitionStartDate' in value) || value['recognitionStartDate'] === undefined) return false;
@@ -134,6 +141,7 @@ export function CreateProductCustomFromJSONTyped(json: any, ignoreDiscriminator:
         'status': json['status'] == null ? undefined : json['status'],
         'taxable': json['taxable'] == null ? undefined : json['taxable'],
         'isDefault': json['isDefault'] == null ? undefined : json['isDefault'],
+        'rentRelated': json['rentRelated'],
         'description': json['description'] == null ? undefined : json['description'],
         'price': json['price'],
         'revenueRuleId': json['revenueRuleId'],
@@ -161,6 +169,7 @@ export function CreateProductCustomToJSONTyped(value?: CreateProductCustom | nul
         'status': value['status'],
         'taxable': value['taxable'],
         'isDefault': value['isDefault'],
+        'rentRelated': value['rentRelated'],
         'description': value['description'],
         'price': value['price'],
         'revenueRuleId': value['revenueRuleId'],

package/src/generated/models/create-product-tax-group.ts

@@ -0,0 +1,82 @@
+/* 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 CreateProductTaxGroup
+ */
+export interface CreateProductTaxGroup {
+    /**
+     * name of tax group
+     * @type {string}
+     * @memberof CreateProductTaxGroup
+     */
+    name: string;
+    /**
+     * Note for tax group
+     * @type {string}
+     * @memberof CreateProductTaxGroup
+     */
+    notes?: string;
+    /**
+     * Status of tax group
+     * @type {string}
+     * @memberof CreateProductTaxGroup
+     */
+    status?: string;
+}
+
+/**
+ * Check if a given object implements the CreateProductTaxGroup interface.
+ */
+export function instanceOfCreateProductTaxGroup(value: object): value is CreateProductTaxGroup {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function CreateProductTaxGroupFromJSON(json: any): CreateProductTaxGroup {
+    return CreateProductTaxGroupFromJSONTyped(json, false);
+}
+
+export function CreateProductTaxGroupFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateProductTaxGroup {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+        'status': json['status'] == null ? undefined : json['status'],
+    };
+}
+
+export function CreateProductTaxGroupToJSON(json: any): CreateProductTaxGroup {
+    return CreateProductTaxGroupToJSONTyped(json, false);
+}
+
+export function CreateProductTaxGroupToJSONTyped(value?: CreateProductTaxGroup | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'notes': value['notes'],
+        'status': value['status'],
+    };
+}
+