vayu-ts 0.2.15 → 0.3.7

package/dist/openapi/models/ProductGroup.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ProductGroupCommitment } from '../models/ProductGroupCommitment';
+import { ProductGroupProductsInner } from '../models/ProductGroupProductsInner';
+export declare class ProductGroup {
+    /**
+    * The display name of the product
+    */
+    'displayName': string;
+    /**
+    * The description of the product
+    */
+    'description'?: string | null;
+    /**
+    * The id of the product in NetSuite ERP
+    */
+    'productErpId'?: string | null;
+    /**
+    * The class of the product in NetSuite ERP
+    */
+    'nsClass'?: string | null;
+    /**
+    * The id of the class of the product in NetSuite ERP
+    */
+    'nsClassId'?: string | null;
+    /**
+    * The products that the product group is associated with
+    */
+    'products': Array<ProductGroupProductsInner>;
+    /**
+    * The base amount for the customer to pay even if the amount based on usage is lower
+    */
+    'baseAmount'?: number | null;
+    'commitment'?: ProductGroupCommitment | null;
+    /**
+    * Whether the invoicing period should be calendar aligned. If not provided, it will default to false. ONE_TIME and COMMERCIAL_TERMS pricing models cannot be calendar aligned.
+    */
+    'isCalendarAligned'?: boolean;
+    static readonly discriminator: string | undefined;
+    static readonly mapping: {
+        [index: string]: string;
+    } | undefined;
+    static readonly attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }[];
+    constructor();
+}

package/dist/openapi/models/ProductGroup.js

@@ -0,0 +1,80 @@
+"use strict";
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductGroup = void 0;
+class ProductGroup {
+    static getAttributeTypeMap() {
+        return ProductGroup.attributeTypeMap;
+    }
+    constructor() {
+    }
+}
+exports.ProductGroup = ProductGroup;
+ProductGroup.discriminator = undefined;
+ProductGroup.mapping = undefined;
+ProductGroup.attributeTypeMap = [
+    {
+        "name": "displayName",
+        "baseName": "displayName",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "description",
+        "baseName": "description",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "productErpId",
+        "baseName": "productErpId",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "nsClass",
+        "baseName": "nsClass",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "nsClassId",
+        "baseName": "nsClassId",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "products",
+        "baseName": "products",
+        "type": "Array<ProductGroupProductsInner>",
+        "format": ""
+    },
+    {
+        "name": "baseAmount",
+        "baseName": "baseAmount",
+        "type": "number",
+        "format": ""
+    },
+    {
+        "name": "commitment",
+        "baseName": "commitment",
+        "type": "ProductGroupCommitment",
+        "format": ""
+    },
+    {
+        "name": "isCalendarAligned",
+        "baseName": "isCalendarAligned",
+        "type": "boolean",
+        "format": ""
+    }
+];

package/dist/openapi/models/ProductGroupCommitment.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ExternalOverageStrategy } from '../models/ExternalOverageStrategy';
+import { ProductGroupProductsInnerCommitmentScheduling } from '../models/ProductGroupProductsInnerCommitmentScheduling';
+/**
+* The commitment of the product group. units are aggregated for all products in the group
+*/
+export declare class ProductGroupCommitment {
+    /**
+    * Units to commit the customer for
+    */
+    'units': number;
+    /**
+    * Price to charge the customer for the committed units
+    */
+    'price'?: number | null;
+    /**
+    * The type of commitment. UNITS means the commitment amount is in units, PRICE means it is a monetary value. Defaults to UNITS.
+    */
+    'type'?: ProductGroupCommitmentTypeEnum;
+    'scheduling'?: ProductGroupProductsInnerCommitmentScheduling | null;
+    'overageStrategy'?: ExternalOverageStrategy | null;
+    static readonly discriminator: string | undefined;
+    static readonly mapping: {
+        [index: string]: string;
+    } | undefined;
+    static readonly attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }[];
+    constructor();
+}
+export declare enum ProductGroupCommitmentTypeEnum {
+    Price = "PRICE",
+    Units = "UNITS"
+}

package/dist/openapi/models/ProductGroupCommitment.js

@@ -0,0 +1,64 @@
+"use strict";
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductGroupCommitmentTypeEnum = exports.ProductGroupCommitment = void 0;
+/**
+* The commitment of the product group. units are aggregated for all products in the group
+*/
+class ProductGroupCommitment {
+    static getAttributeTypeMap() {
+        return ProductGroupCommitment.attributeTypeMap;
+    }
+    constructor() {
+    }
+}
+exports.ProductGroupCommitment = ProductGroupCommitment;
+ProductGroupCommitment.discriminator = undefined;
+ProductGroupCommitment.mapping = undefined;
+ProductGroupCommitment.attributeTypeMap = [
+    {
+        "name": "units",
+        "baseName": "units",
+        "type": "number",
+        "format": ""
+    },
+    {
+        "name": "price",
+        "baseName": "price",
+        "type": "number",
+        "format": ""
+    },
+    {
+        "name": "type",
+        "baseName": "type",
+        "type": "ProductGroupCommitmentTypeEnum",
+        "format": ""
+    },
+    {
+        "name": "scheduling",
+        "baseName": "scheduling",
+        "type": "ProductGroupProductsInnerCommitmentScheduling",
+        "format": ""
+    },
+    {
+        "name": "overageStrategy",
+        "baseName": "overageStrategy",
+        "type": "ExternalOverageStrategy",
+        "format": ""
+    }
+];
+var ProductGroupCommitmentTypeEnum;
+(function (ProductGroupCommitmentTypeEnum) {
+    ProductGroupCommitmentTypeEnum["Price"] = "PRICE";
+    ProductGroupCommitmentTypeEnum["Units"] = "UNITS";
+})(ProductGroupCommitmentTypeEnum = exports.ProductGroupCommitmentTypeEnum || (exports.ProductGroupCommitmentTypeEnum = {}));

package/dist/openapi/models/ProductGroupProductsInner.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { PaymentTerm } from '../models/PaymentTerm';
+import { ProductCloudProviderSettings } from '../models/ProductCloudProviderSettings';
+import { ProductGroupProductsInnerCommitment } from '../models/ProductGroupProductsInnerCommitment';
+import { ProductGroupProductsInnerPricing } from '../models/ProductGroupProductsInnerPricing';
+import { ProductGroupProductsInnerScheduling } from '../models/ProductGroupProductsInnerScheduling';
+export declare class ProductGroupProductsInner {
+    /**
+    * The display name of the product
+    */
+    'displayName': string;
+    /**
+    * The description of the product
+    */
+    'description'?: string | null;
+    'scheduling': ProductGroupProductsInnerScheduling;
+    'pricing': ProductGroupProductsInnerPricing;
+    /**
+    * The id of the a product from the catalog to connect the contract product to
+    */
+    'catalogProductId'?: string | null;
+    /**
+    * The id of the product in NetSuite ERP
+    */
+    'productErpId'?: string | null;
+    /**
+    * The class of the product in NetSuite ERP
+    */
+    'nsClass'?: string | null;
+    /**
+    * The id of the class of the product in NetSuite ERP
+    */
+    'nsClassId'?: string | null;
+    'commitment'?: ProductGroupProductsInnerCommitment | null;
+    'paymentTerm'?: PaymentTerm | null;
+    /**
+    * Whether the invoicing period should be calendar aligned. If not provided, it will default to false. ONE_TIME and COMMERCIAL_TERMS pricing models cannot be calendar aligned. This field is ignored if the product is part of a ProductGroup.
+    */
+    'isCalendarAligned'?: boolean;
+    'cloudProviderSettings'?: ProductCloudProviderSettings | null;
+    static readonly discriminator: string | undefined;
+    static readonly mapping: {
+        [index: string]: string;
+    } | undefined;
+    static readonly attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }[];
+    constructor();
+}

package/dist/openapi/models/ProductGroupProductsInner.js

@@ -0,0 +1,98 @@
+"use strict";
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductGroupProductsInner = void 0;
+class ProductGroupProductsInner {
+    static getAttributeTypeMap() {
+        return ProductGroupProductsInner.attributeTypeMap;
+    }
+    constructor() {
+    }
+}
+exports.ProductGroupProductsInner = ProductGroupProductsInner;
+ProductGroupProductsInner.discriminator = undefined;
+ProductGroupProductsInner.mapping = undefined;
+ProductGroupProductsInner.attributeTypeMap = [
+    {
+        "name": "displayName",
+        "baseName": "displayName",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "description",
+        "baseName": "description",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "scheduling",
+        "baseName": "scheduling",
+        "type": "ProductGroupProductsInnerScheduling",
+        "format": ""
+    },
+    {
+        "name": "pricing",
+        "baseName": "pricing",
+        "type": "ProductGroupProductsInnerPricing",
+        "format": ""
+    },
+    {
+        "name": "catalogProductId",
+        "baseName": "catalogProductId",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "productErpId",
+        "baseName": "productErpId",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "nsClass",
+        "baseName": "nsClass",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "nsClassId",
+        "baseName": "nsClassId",
+        "type": "string",
+        "format": ""
+    },
+    {
+        "name": "commitment",
+        "baseName": "commitment",
+        "type": "ProductGroupProductsInnerCommitment",
+        "format": ""
+    },
+    {
+        "name": "paymentTerm",
+        "baseName": "paymentTerm",
+        "type": "PaymentTerm",
+        "format": ""
+    },
+    {
+        "name": "isCalendarAligned",
+        "baseName": "isCalendarAligned",
+        "type": "boolean",
+        "format": ""
+    },
+    {
+        "name": "cloudProviderSettings",
+        "baseName": "cloudProviderSettings",
+        "type": "ProductCloudProviderSettings",
+        "format": ""
+    }
+];

package/dist/openapi/models/ProductGroupProductsInnerCommitment.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ExternalOverageStrategy } from '../models/ExternalOverageStrategy';
+import { ProductGroupProductsInnerCommitmentScheduling } from '../models/ProductGroupProductsInnerCommitmentScheduling';
+/**
+* The commitment of the product
+*/
+export declare class ProductGroupProductsInnerCommitment {
+    /**
+    * Units to commit the customer for
+    */
+    'units': number;
+    /**
+    * Price to charge the customer for the committed units
+    */
+    'price'?: number | null;
+    /**
+    * The type of commitment. UNITS means the commitment amount is in units, PRICE means it is a monetary value. Defaults to UNITS.
+    */
+    'type'?: ProductGroupProductsInnerCommitmentTypeEnum;
+    'scheduling'?: ProductGroupProductsInnerCommitmentScheduling | null;
+    'overageStrategy'?: ExternalOverageStrategy | null;
+    static readonly discriminator: string | undefined;
+    static readonly mapping: {
+        [index: string]: string;
+    } | undefined;
+    static readonly attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }[];
+    constructor();
+}
+export declare enum ProductGroupProductsInnerCommitmentTypeEnum {
+    Price = "PRICE",
+    Units = "UNITS"
+}

package/dist/openapi/models/ProductGroupProductsInnerCommitment.js

@@ -0,0 +1,64 @@
+"use strict";
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductGroupProductsInnerCommitmentTypeEnum = exports.ProductGroupProductsInnerCommitment = void 0;
+/**
+* The commitment of the product
+*/
+class ProductGroupProductsInnerCommitment {
+    static getAttributeTypeMap() {
+        return ProductGroupProductsInnerCommitment.attributeTypeMap;
+    }
+    constructor() {
+    }
+}
+exports.ProductGroupProductsInnerCommitment = ProductGroupProductsInnerCommitment;
+ProductGroupProductsInnerCommitment.discriminator = undefined;
+ProductGroupProductsInnerCommitment.mapping = undefined;
+ProductGroupProductsInnerCommitment.attributeTypeMap = [
+    {
+        "name": "units",
+        "baseName": "units",
+        "type": "number",
+        "format": ""
+    },
+    {
+        "name": "price",
+        "baseName": "price",
+        "type": "number",
+        "format": ""
+    },
+    {
+        "name": "type",
+        "baseName": "type",
+        "type": "ProductGroupProductsInnerCommitmentTypeEnum",
+        "format": ""
+    },
+    {
+        "name": "scheduling",
+        "baseName": "scheduling",
+        "type": "ProductGroupProductsInnerCommitmentScheduling",
+        "format": ""
+    },
+    {
+        "name": "overageStrategy",
+        "baseName": "overageStrategy",
+        "type": "ExternalOverageStrategy",
+        "format": ""
+    }
+];
+var ProductGroupProductsInnerCommitmentTypeEnum;
+(function (ProductGroupProductsInnerCommitmentTypeEnum) {
+    ProductGroupProductsInnerCommitmentTypeEnum["Price"] = "PRICE";
+    ProductGroupProductsInnerCommitmentTypeEnum["Units"] = "UNITS";
+})(ProductGroupProductsInnerCommitmentTypeEnum = exports.ProductGroupProductsInnerCommitmentTypeEnum || (exports.ProductGroupProductsInnerCommitmentTypeEnum = {}));

package/dist/openapi/models/ProductGroupProductsInnerCommitmentScheduling.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { ProductGroupProductsInnerCommitmentSchedulingDuration } from '../models/ProductGroupProductsInnerCommitmentSchedulingDuration';
+/**
+* Scheduling for recurring commitment. Duration unit must be MONTH or YEAR.
+*/
+export declare class ProductGroupProductsInnerCommitmentScheduling {
+    /**
+    * The day of the month for the commitment scheduling
+    */
+    'billingDay'?: number;
+    'duration': ProductGroupProductsInnerCommitmentSchedulingDuration;
+    static readonly discriminator: string | undefined;
+    static readonly mapping: {
+        [index: string]: string;
+    } | undefined;
+    static readonly attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }[];
+    constructor();
+}

package/dist/openapi/models/ProductGroupProductsInnerCommitmentScheduling.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProductGroupProductsInnerCommitmentScheduling = void 0;
+/**
+* Scheduling for recurring commitment. Duration unit must be MONTH or YEAR.
+*/
+class ProductGroupProductsInnerCommitmentScheduling {
+    static getAttributeTypeMap() {
+        return ProductGroupProductsInnerCommitmentScheduling.attributeTypeMap;
+    }
+    constructor() {
+    }
+}
+exports.ProductGroupProductsInnerCommitmentScheduling = ProductGroupProductsInnerCommitmentScheduling;
+ProductGroupProductsInnerCommitmentScheduling.discriminator = undefined;
+ProductGroupProductsInnerCommitmentScheduling.mapping = undefined;
+ProductGroupProductsInnerCommitmentScheduling.attributeTypeMap = [
+    {
+        "name": "billingDay",
+        "baseName": "billingDay",
+        "type": "number",
+        "format": ""
+    },
+    {
+        "name": "duration",
+        "baseName": "duration",
+        "type": "ProductGroupProductsInnerCommitmentSchedulingDuration",
+        "format": ""
+    }
+];

package/dist/openapi/models/ProductGroupProductsInnerCommitmentSchedulingDuration.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Vayu API
+ * The Vayu API is a RESTful API that allows you to submit events for processing and storage & manage billing related entities.           The API is secured using the Bearer Authentication scheme with JWT tokens.           To obtain a JWT token, please contact Vayu at team@withvayu.com
+ *
+ * OpenAPI spec version: 1.0.0
+ * Contact: dev@withvayu.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+* The duration of the commitment scheduling cycle. Unit must be MONTH or YEAR.
+*/
+export declare class ProductGroupProductsInnerCommitmentSchedulingDuration {
+    'unit': ProductGroupProductsInnerCommitmentSchedulingDurationUnitEnum;
+    'value': number;
+    static readonly discriminator: string | undefined;
+    static readonly mapping: {
+        [index: string]: string;
+    } | undefined;
+    static readonly attributeTypeMap: Array<{
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }>;
+    static getAttributeTypeMap(): {
+        name: string;
+        baseName: string;
+        type: string;
+        format: string;
+    }[];
+    constructor();
+}
+export declare enum ProductGroupProductsInnerCommitmentSchedulingDurationUnitEnum {
+    Day = "DAY",
+    Week = "WEEK",
+    Month = "MONTH",
+    Year = "YEAR"
+}