@managespace/sdk 0.0.81 → 0.0.83

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-document.ts

@@ -13,21 +13,6 @@
  */
 
 import { mapValues } from '../runtime';
-import type { DocumentSigner } from './document-signer';
-import {
-    DocumentSignerFromJSON,
-    DocumentSignerFromJSONTyped,
-    DocumentSignerToJSON,
-    DocumentSignerToJSONTyped,
-} from './document-signer';
-import type { DocumentField } from './document-field';
-import {
-    DocumentFieldFromJSON,
-    DocumentFieldFromJSONTyped,
-    DocumentFieldToJSON,
-    DocumentFieldToJSONTyped,
-} from './document-field';
-
 /**
  * 
  * @export
@@ -35,30 +20,18 @@ import {
  */
 export interface CreateDocument {
     /**
-     * The ID of the template to create a document from.
-     * @type {string}
-     * @memberof CreateDocument
-     */
-    templateId: string;
-    /**
-     * The signers of the template
-     * @type {Array<DocumentSigner>}
-     * @memberof CreateDocument
-     */
-    signers?: Array<DocumentSigner>;
-    /**
-     * The fields of the template
-     * @type {Array<DocumentField>}
+     * The data to be passed to the document.
+     * @type {object}
      * @memberof CreateDocument
      */
-    fields?: Array<DocumentField>;
+    data: object;
 }
 
 /**
  * Check if a given object implements the CreateDocument interface.
  */
 export function instanceOfCreateDocument(value: object): value is CreateDocument {
-    if (!('templateId' in value) || value['templateId'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
     return true;
 }
 
@@ -72,9 +45,7 @@ export function CreateDocumentFromJSONTyped(json: any, ignoreDiscriminator: bool
     }
     return {
         
-        'templateId': json['templateId'],
-        'signers': json['signers'] == null ? undefined : ((json['signers'] as Array<any>).map(DocumentSignerFromJSON)),
-        'fields': json['fields'] == null ? undefined : ((json['fields'] as Array<any>).map(DocumentFieldFromJSON)),
+        'data': json['data'],
     };
 }
 
@@ -89,9 +60,7 @@ export function CreateDocumentToJSONTyped(value?: CreateDocument | null, ignoreD
 
     return {
         
-        'templateId': value['templateId'],
-        'signers': value['signers'] == null ? undefined : ((value['signers'] as Array<any>).map(DocumentSignerToJSON)),
-        'fields': value['fields'] == null ? undefined : ((value['fields'] as Array<any>).map(DocumentFieldToJSON)),
+        'data': value['data'],
     };
 }
 

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

@@ -0,0 +1,216 @@
+/* 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 { OrderLineItem } from './order-line-item';
+import {
+    OrderLineItemFromJSON,
+    OrderLineItemFromJSONTyped,
+    OrderLineItemToJSON,
+    OrderLineItemToJSONTyped,
+} from './order-line-item';
+
+/**
+ * 
+ * @export
+ * @interface CreateOrder
+ */
+export interface CreateOrder {
+    /**
+     * If order status is invoiced, associated invoice id
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    invoiceId?: string;
+    /**
+     * Date order was placed
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    orderDate: string;
+    /**
+     * Customer ID associated with order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    customerId: string;
+    /**
+     * Order status
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    status: string;
+    /**
+     *  Total amount of order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    orderAmount: string;
+    /**
+     * Enable to create separate invoice for this order
+     * @type {boolean}
+     * @memberof CreateOrder
+     */
+    separateInvoice: boolean;
+    /**
+     * Currency of the order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    currency: string;
+    /**
+     * Billing contact ID
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    billContactId?: string;
+    /**
+     * Shipping contact ID
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    shippingContactId?: string;
+    /**
+     * Payment terms to calculate due date of invoice
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    paymentTerms?: string;
+    /**
+     * Misceallaneous notes on order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    notes?: string;
+    /**
+     * Coupon code applied to order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    couponCode?: string;
+    /**
+     * Invoice line items
+     * @type {Array<OrderLineItem>}
+     * @memberof CreateOrder
+     */
+    lineItems: Array<OrderLineItem>;
+    /**
+     * The date the order was created
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    createdAt?: string;
+    /**
+     * The date the order was updated
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    updatedAt?: string;
+    /**
+     * Who created the order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    createdBy?: string;
+    /**
+     * Who updated the order
+     * @type {string}
+     * @memberof CreateOrder
+     */
+    updatedBy?: string;
+    /**
+     * Custom fields on the invoice
+     * @type {object}
+     * @memberof CreateOrder
+     */
+    customFields?: object;
+}
+
+/**
+ * Check if a given object implements the CreateOrder interface.
+ */
+export function instanceOfCreateOrder(value: object): value is CreateOrder {
+    if (!('orderDate' in value) || value['orderDate'] === undefined) return false;
+    if (!('customerId' in value) || value['customerId'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('orderAmount' in value) || value['orderAmount'] === undefined) return false;
+    if (!('separateInvoice' in value) || value['separateInvoice'] === undefined) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    if (!('lineItems' in value) || value['lineItems'] === undefined) return false;
+    return true;
+}
+
+export function CreateOrderFromJSON(json: any): CreateOrder {
+    return CreateOrderFromJSONTyped(json, false);
+}
+
+export function CreateOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateOrder {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'invoiceId': json['invoiceId'] == null ? undefined : json['invoiceId'],
+        'orderDate': json['orderDate'],
+        'customerId': json['customerId'],
+        'status': json['status'],
+        'orderAmount': json['orderAmount'],
+        'separateInvoice': json['separateInvoice'],
+        'currency': json['currency'],
+        'billContactId': json['billContactId'] == null ? undefined : json['billContactId'],
+        'shippingContactId': json['shippingContactId'] == null ? undefined : json['shippingContactId'],
+        'paymentTerms': json['paymentTerms'] == null ? undefined : json['paymentTerms'],
+        'notes': json['notes'] == null ? undefined : json['notes'],
+        'couponCode': json['couponCode'] == null ? undefined : json['couponCode'],
+        'lineItems': ((json['lineItems'] as Array<any>).map(OrderLineItemFromJSON)),
+        'createdAt': json['createdAt'] == null ? undefined : json['createdAt'],
+        'updatedAt': json['updatedAt'] == null ? undefined : json['updatedAt'],
+        'createdBy': json['createdBy'] == null ? undefined : json['createdBy'],
+        'updatedBy': json['updatedBy'] == null ? undefined : json['updatedBy'],
+        'customFields': json['customFields'] == null ? undefined : json['customFields'],
+    };
+}
+
+export function CreateOrderToJSON(json: any): CreateOrder {
+    return CreateOrderToJSONTyped(json, false);
+}
+
+export function CreateOrderToJSONTyped(value?: CreateOrder | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'invoiceId': value['invoiceId'],
+        'orderDate': value['orderDate'],
+        'customerId': value['customerId'],
+        'status': value['status'],
+        'orderAmount': value['orderAmount'],
+        'separateInvoice': value['separateInvoice'],
+        'currency': value['currency'],
+        'billContactId': value['billContactId'],
+        'shippingContactId': value['shippingContactId'],
+        'paymentTerms': value['paymentTerms'],
+        'notes': value['notes'],
+        'couponCode': value['couponCode'],
+        'lineItems': ((value['lineItems'] as Array<any>).map(OrderLineItemToJSON)),
+        'createdAt': value['createdAt'],
+        'updatedAt': value['updatedAt'],
+        'createdBy': value['createdBy'],
+        'updatedBy': value['updatedBy'],
+        'customFields': value['customFields'],
+    };
+}
+