@managespace/sdk 0.0.70 → 0.0.71

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

@@ -0,0 +1,378 @@
+/* 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;
+    /**
+     * 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 (!('description' in value) || value['description'] === undefined) return false;
+    if (!('type' in value) || value['type'] === 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 (!('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 (!('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 (!('transactionPostingEntries' in value) || value['transactionPostingEntries'] === 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'],
+        'type': json['type'],
+        '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'],
+        'billingDay': json['billingDay'],
+        'billingPeriodStartAlignment': json['billingPeriodStartAlignment'],
+        'proratePartialPeriods': json['proratePartialPeriods'],
+        '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'],
+        'transactionPostingEntries': ((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'] 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'] as Array<any>).map(TransactionPostingEntriesToJSON)),
+    };
+}
+

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

@@ -0,0 +1,227 @@
+/* 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 (!('invoiceId' in value) || value['invoiceId'] === undefined) return false;
+    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 (!('billContactId' in value) || value['billContactId'] === undefined) return false;
+    if (!('shippingContactId' in value) || value['shippingContactId'] === undefined) return false;
+    if (!('paymentTerms' in value) || value['paymentTerms'] === undefined) return false;
+    if (!('notes' in value) || value['notes'] === undefined) return false;
+    if (!('couponCode' in value) || value['couponCode'] === undefined) return false;
+    if (!('lineItems' in value) || value['lineItems'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    if (!('createdBy' in value) || value['createdBy'] === undefined) return false;
+    if (!('updatedBy' in value) || value['updatedBy'] === undefined) return false;
+    if (!('customFields' in value) || value['customFields'] === 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'],
+        'orderDate': json['orderDate'],
+        'customerId': json['customerId'],
+        'status': json['status'],
+        'orderAmount': json['orderAmount'],
+        'separateInvoice': json['separateInvoice'],
+        'currency': json['currency'],
+        'billContactId': json['billContactId'],
+        'shippingContactId': json['shippingContactId'],
+        'paymentTerms': json['paymentTerms'],
+        'notes': json['notes'],
+        'couponCode': json['couponCode'],
+        'lineItems': ((json['lineItems'] as Array<any>).map(OrderLineItemFromJSON)),
+        'createdAt': json['createdAt'],
+        'updatedAt': json['updatedAt'],
+        'createdBy': json['createdBy'],
+        'updatedBy': json['updatedBy'],
+        'customFields': 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'],
+    };
+}
+

package/src/generated/models/get-orders200-response.ts

@@ -0,0 +1,89 @@
+/* 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 { PageMeta } from './page-meta';
+import {
+    PageMetaFromJSON,
+    PageMetaFromJSONTyped,
+    PageMetaToJSON,
+    PageMetaToJSONTyped,
+} from './page-meta';
+import type { OrderResponse } from './order-response';
+import {
+    OrderResponseFromJSON,
+    OrderResponseFromJSONTyped,
+    OrderResponseToJSON,
+    OrderResponseToJSONTyped,
+} from './order-response';
+
+/**
+ * 
+ * @export
+ * @interface GetOrders200Response
+ */
+export interface GetOrders200Response {
+    /**
+     * The pagination metadata
+     * @type {PageMeta}
+     * @memberof GetOrders200Response
+     */
+    pageMeta: PageMeta;
+    /**
+     * 
+     * @type {Array<OrderResponse>}
+     * @memberof GetOrders200Response
+     */
+    results?: Array<OrderResponse>;
+}
+
+/**
+ * Check if a given object implements the GetOrders200Response interface.
+ */
+export function instanceOfGetOrders200Response(value: object): value is GetOrders200Response {
+    if (!('pageMeta' in value) || value['pageMeta'] === undefined) return false;
+    return true;
+}
+
+export function GetOrders200ResponseFromJSON(json: any): GetOrders200Response {
+    return GetOrders200ResponseFromJSONTyped(json, false);
+}
+
+export function GetOrders200ResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetOrders200Response {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'pageMeta': PageMetaFromJSON(json['pageMeta']),
+        'results': json['results'] == null ? undefined : ((json['results'] as Array<any>).map(OrderResponseFromJSON)),
+    };
+}
+
+export function GetOrders200ResponseToJSON(json: any): GetOrders200Response {
+    return GetOrders200ResponseToJSONTyped(json, false);
+}
+
+export function GetOrders200ResponseToJSONTyped(value?: GetOrders200Response | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'pageMeta': PageMetaToJSON(value['pageMeta']),
+        'results': value['results'] == null ? undefined : ((value['results'] as Array<any>).map(OrderResponseToJSON)),
+    };
+}
+