vayu-ts 0.2.4 → 0.2.6

package/dist/openapi-v2/types/PromiseAPI.js

@@ -28,90 +28,102 @@ class PromiseCustomersApi {
         this.api = new ObservableAPI_2.ObservableCustomersApi(configuration, requestFactory, responseProcessor);
     }
     /**
-     * @param aPICreateCustomerPayload
+     * Create a new customer.
+     * @param aPICreateCustomerPayload - The details of the customer to create.
      */
     createCustomerWithHttpInfo(aPICreateCustomerPayload, _options) {
         const result = this.api.createCustomerWithHttpInfo(aPICreateCustomerPayload, _options);
         return result.toPromise();
     }
     /**
-     * @param aPICreateCustomerPayload
+     * Create a new customer.
+     * @param aPICreateCustomerPayload - The details of the customer to create.
      */
     createCustomer(aPICreateCustomerPayload, _options) {
         const result = this.api.createCustomer(aPICreateCustomerPayload, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Delete a customer by ID.
+     * @param id - The ID of the customer to delete.
      */
     deleteCustomerWithHttpInfo(id, _options) {
         const result = this.api.deleteCustomerWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Delete a customer by ID.
+     * @param id - The ID of the customer to delete.
      */
     deleteCustomer(id, _options) {
         const result = this.api.deleteCustomer(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Get a single customer by ID.
+     * @param id - The ID of the customer to fetch.
      */
     getCustomerWithHttpInfo(id, _options) {
         const result = this.api.getCustomerWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Get a single customer by ID.
+     * @param id - The ID of the customer to fetch.
      */
     getCustomer(id, _options) {
         const result = this.api.getCustomer(id, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIQueryPayloadAPICustomer
+     * Query customers based on filters and pagination.
+     * @param aPIQueryPayloadAPICustomer - The query filters and pagination options.
      */
     queryCustomersWithHttpInfo(aPIQueryPayloadAPICustomer, _options) {
         const result = this.api.queryCustomersWithHttpInfo(aPIQueryPayloadAPICustomer, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIQueryPayloadAPICustomer
+     * Query customers based on filters and pagination.
+     * @param aPIQueryPayloadAPICustomer - The query filters and pagination options.
      */
     queryCustomers(aPIQueryPayloadAPICustomer, _options) {
         const result = this.api.queryCustomers(aPIQueryPayloadAPICustomer, _options);
         return result.toPromise();
     }
     /**
-     * @param body
-     * @param id
-     * @param productId
+     * Revise a customer\'s product.
+     * @param body - The details of the revision to apply.
+     * @param id - The ID of the customer to revise.
+     * @param productId - The ID of the product to revise.
      */
     updateACustomersProductWithHttpInfo(body, id, productId, _options) {
         const result = this.api.updateACustomersProductWithHttpInfo(body, id, productId, _options);
         return result.toPromise();
     }
     /**
-     * @param body
-     * @param id
-     * @param productId
+     * Revise a customer\'s product.
+     * @param body - The details of the revision to apply.
+     * @param id - The ID of the customer to revise.
+     * @param productId - The ID of the product to revise.
      */
     updateACustomersProduct(body, id, productId, _options) {
         const result = this.api.updateACustomersProduct(body, id, productId, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIUpdateCustomerPayload
-     * @param id
+     * Update an existing customer.
+     * @param aPIUpdateCustomerPayload - The updated details of the customer.
+     * @param id - The ID of the customer to update.
      */
     updateCustomerWithHttpInfo(aPIUpdateCustomerPayload, id, _options) {
         const result = this.api.updateCustomerWithHttpInfo(aPIUpdateCustomerPayload, id, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIUpdateCustomerPayload
-     * @param id
+     * Update an existing customer.
+     * @param aPIUpdateCustomerPayload - The updated details of the customer.
+     * @param id - The ID of the customer to update.
      */
     updateCustomer(aPIUpdateCustomerPayload, id, _options) {
         const result = this.api.updateCustomer(aPIUpdateCustomerPayload, id, _options);
@@ -125,42 +137,48 @@ class PromiseEntitlementsApi {
         this.api = new ObservableAPI_3.ObservableEntitlementsApi(configuration, requestFactory, responseProcessor);
     }
     /**
-     * @param id
+     * Delete an entitlement by ID.
+     * @param id - The ID of the entitlement to delete.
      */
     deleteEntitlementWithHttpInfo(id, _options) {
         const result = this.api.deleteEntitlementWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Delete an entitlement by ID.
+     * @param id - The ID of the entitlement to delete.
      */
     deleteEntitlement(id, _options) {
         const result = this.api.deleteEntitlement(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Get a single entitlement by ID.
+     * @param id - The ID of the entitlement to fetch.
      */
     getEntitlementWithHttpInfo(id, _options) {
         const result = this.api.getEntitlementWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Get a single entitlement by ID.
+     * @param id - The ID of the entitlement to fetch.
      */
     getEntitlement(id, _options) {
         const result = this.api.getEntitlement(id, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIQueryPayloadAPIEntitlement
+     * Query entitlements based on filters and pagination.
+     * @param aPIQueryPayloadAPIEntitlement - The query filters and pagination options.
      */
     queryEntitlementsWithHttpInfo(aPIQueryPayloadAPIEntitlement, _options) {
         const result = this.api.queryEntitlementsWithHttpInfo(aPIQueryPayloadAPIEntitlement, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIQueryPayloadAPIEntitlement
+     * Query entitlements based on filters and pagination.
+     * @param aPIQueryPayloadAPIEntitlement - The query filters and pagination options.
      */
     queryEntitlements(aPIQueryPayloadAPIEntitlement, _options) {
         const result = this.api.queryEntitlements(aPIQueryPayloadAPIEntitlement, _options);
@@ -174,56 +192,64 @@ class PromiseEventsApi {
         this.api = new ObservableAPI_4.ObservableEventsApi(configuration, requestFactory, responseProcessor);
     }
     /**
-     * @param id
+     * Delete an event by ID.
+     * @param id - The ID of the event to delete.
      */
     deleteEventWithHttpInfo(id, _options) {
         const result = this.api.deleteEventWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Delete an event by ID.
+     * @param id - The ID of the event to delete.
      */
     deleteEvent(id, _options) {
         const result = this.api.deleteEvent(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Get a single event by ID.
+     * @param id - The ID of the event to fetch.
      */
     getEventWithHttpInfo(id, _options) {
         const result = this.api.getEventWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Get a single event by ID.
+     * @param id - The ID of the event to fetch.
      */
     getEvent(id, _options) {
         const result = this.api.getEvent(id, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIIngestEventPayload
+     * Ingest events to the system
+     * @param aPIIngestEventPayload - The events to ingest
      */
     ingestEventToTheSystemWithHttpInfo(aPIIngestEventPayload, _options) {
         const result = this.api.ingestEventToTheSystemWithHttpInfo(aPIIngestEventPayload, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIIngestEventPayload
+     * Ingest events to the system
+     * @param aPIIngestEventPayload - The events to ingest
      */
     ingestEventToTheSystem(aPIIngestEventPayload, _options) {
         const result = this.api.ingestEventToTheSystem(aPIIngestEventPayload, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIQueryPayloadAPIEvent
+     * Query events based on filters and pagination.
+     * @param aPIQueryPayloadAPIEvent - The query filters and pagination options.
      */
     queryEventsWithHttpInfo(aPIQueryPayloadAPIEvent, _options) {
         const result = this.api.queryEventsWithHttpInfo(aPIQueryPayloadAPIEvent, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIQueryPayloadAPIEvent
+     * Query events based on filters and pagination.
+     * @param aPIQueryPayloadAPIEvent - The query filters and pagination options.
      */
     queryEvents(aPIQueryPayloadAPIEvent, _options) {
         const result = this.api.queryEvents(aPIQueryPayloadAPIEvent, _options);
@@ -237,86 +263,98 @@ class PromiseInvoicesApi {
         this.api = new ObservableAPI_5.ObservableInvoicesApi(configuration, requestFactory, responseProcessor);
     }
     /**
-     * @param id
+     * Calculate the total of an invoice.
+     * @param id - The ID of the invoice to calculate.
      */
     calculateInvoiceWithHttpInfo(id, _options) {
         const result = this.api.calculateInvoiceWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Calculate the total of an invoice.
+     * @param id - The ID of the invoice to calculate.
      */
     calculateInvoice(id, _options) {
         const result = this.api.calculateInvoice(id, _options);
         return result.toPromise();
     }
     /**
-     * @param aPICreateInvoicePayload
+     * Create a new invoice.
+     * @param aPICreateInvoicePayload - The details of the invoice to create.
      */
     createInvoiceWithHttpInfo(aPICreateInvoicePayload, _options) {
         const result = this.api.createInvoiceWithHttpInfo(aPICreateInvoicePayload, _options);
         return result.toPromise();
     }
     /**
-     * @param aPICreateInvoicePayload
+     * Create a new invoice.
+     * @param aPICreateInvoicePayload - The details of the invoice to create.
      */
     createInvoice(aPICreateInvoicePayload, _options) {
         const result = this.api.createInvoice(aPICreateInvoicePayload, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Delete an invoice by ID.
+     * @param id - The ID of the invoice to delete.
      */
     deleteInvoiceWithHttpInfo(id, _options) {
         const result = this.api.deleteInvoiceWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Delete an invoice by ID.
+     * @param id - The ID of the invoice to delete.
      */
     deleteInvoice(id, _options) {
         const result = this.api.deleteInvoice(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Get a single invoice by ID.
+     * @param id - The ID of the invoice to fetch.
      */
     getInvoiceWithHttpInfo(id, _options) {
         const result = this.api.getInvoiceWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Get a single invoice by ID.
+     * @param id - The ID of the invoice to fetch.
      */
     getInvoice(id, _options) {
         const result = this.api.getInvoice(id, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIQueryPayloadAPIInvoice
+     * Query invoices based on filters and pagination.
+     * @param aPIQueryPayloadAPIInvoice - The query filters and pagination options.
      */
     queryInvoicesWithHttpInfo(aPIQueryPayloadAPIInvoice, _options) {
         const result = this.api.queryInvoicesWithHttpInfo(aPIQueryPayloadAPIInvoice, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIQueryPayloadAPIInvoice
+     * Query invoices based on filters and pagination.
+     * @param aPIQueryPayloadAPIInvoice - The query filters and pagination options.
      */
     queryInvoices(aPIQueryPayloadAPIInvoice, _options) {
         const result = this.api.queryInvoices(aPIQueryPayloadAPIInvoice, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIUpdateInvoicePayload
-     * @param id
+     * Update an existing invoice.
+     * @param aPIUpdateInvoicePayload - The updated details of the invoice.
+     * @param id - The ID of the invoice to update.
      */
     updateInvoiceWithHttpInfo(aPIUpdateInvoicePayload, id, _options) {
         const result = this.api.updateInvoiceWithHttpInfo(aPIUpdateInvoicePayload, id, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIUpdateInvoicePayload
-     * @param id
+     * Update an existing invoice.
+     * @param aPIUpdateInvoicePayload - The updated details of the invoice.
+     * @param id - The ID of the invoice to update.
      */
     updateInvoice(aPIUpdateInvoicePayload, id, _options) {
         const result = this.api.updateInvoice(aPIUpdateInvoicePayload, id, _options);
@@ -330,72 +368,82 @@ class PromiseProductsApi {
         this.api = new ObservableAPI_6.ObservableProductsApi(configuration, requestFactory, responseProcessor);
     }
     /**
-     * @param aPICreateProductPayload
+     * Create a new product.
+     * @param aPICreateProductPayload - The details of the product to create.
      */
     createProductWithHttpInfo(aPICreateProductPayload, _options) {
         const result = this.api.createProductWithHttpInfo(aPICreateProductPayload, _options);
         return result.toPromise();
     }
     /**
-     * @param aPICreateProductPayload
+     * Create a new product.
+     * @param aPICreateProductPayload - The details of the product to create.
      */
     createProduct(aPICreateProductPayload, _options) {
         const result = this.api.createProduct(aPICreateProductPayload, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Delete a product by ID.
+     * @param id - The ID of the product to delete.
      */
     deleteProductWithHttpInfo(id, _options) {
         const result = this.api.deleteProductWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Delete a product by ID.
+     * @param id - The ID of the product to delete.
      */
     deleteProduct(id, _options) {
         const result = this.api.deleteProduct(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Get a single product by ID.
+     * @param id - The ID of the product to fetch.
      */
     getProductWithHttpInfo(id, _options) {
         const result = this.api.getProductWithHttpInfo(id, _options);
         return result.toPromise();
     }
     /**
-     * @param id
+     * Get a single product by ID.
+     * @param id - The ID of the product to fetch.
      */
     getProduct(id, _options) {
         const result = this.api.getProduct(id, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIQueryPayloadAPIProduct
+     * Query products based on filters and pagination.
+     * @param aPIQueryPayloadAPIProduct - The query filters and pagination details.
      */
     queryProductsWithHttpInfo(aPIQueryPayloadAPIProduct, _options) {
         const result = this.api.queryProductsWithHttpInfo(aPIQueryPayloadAPIProduct, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIQueryPayloadAPIProduct
+     * Query products based on filters and pagination.
+     * @param aPIQueryPayloadAPIProduct - The query filters and pagination details.
      */
     queryProducts(aPIQueryPayloadAPIProduct, _options) {
         const result = this.api.queryProducts(aPIQueryPayloadAPIProduct, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIUpdateProductPayload
-     * @param id
+     * Update an existing product.
+     * @param aPIUpdateProductPayload - The updated details of the product.
+     * @param id - The ID of the product to update.
      */
     updateProductWithHttpInfo(aPIUpdateProductPayload, id, _options) {
         const result = this.api.updateProductWithHttpInfo(aPIUpdateProductPayload, id, _options);
         return result.toPromise();
     }
     /**
-     * @param aPIUpdateProductPayload
-     * @param id
+     * Update an existing product.
+     * @param aPIUpdateProductPayload - The updated details of the product.
+     * @param id - The ID of the product to update.
      */
     updateProduct(aPIUpdateProductPayload, id, _options) {
         const result = this.api.updateProduct(aPIUpdateProductPayload, id, _options);

package/dist/sdk-v2/clients/index.d.ts

@@ -2,3 +2,4 @@ export * from './CustomersClient';
 export * from './EventsClient';
 export * from './InvoicesClient';
 export * from './ProductsClient';
+export * from './EntitlementsClient';

package/dist/sdk-v2/clients/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./CustomersClient"), exports);
 __exportStar(require("./EventsClient"), exports);
 __exportStar(require("./InvoicesClient"), exports);
 __exportStar(require("./ProductsClient"), exports);
+__exportStar(require("./EntitlementsClient"), exports);

package/dist/sdk-v2/index.d.ts

@@ -1,4 +1,4 @@
-import { CustomersClient, EventsClient, InvoicesClient, ProductsClient } from './clients';
+import { CustomersClient, EntitlementsClient, EventsClient, InvoicesClient, ProductsClient } from './clients';
 export declare class Vayu {
     private configurationManager;
     constructor(apiKey: string, _baseUrl?: string);
@@ -7,5 +7,6 @@ export declare class Vayu {
     get customers(): CustomersClient;
     get products(): ProductsClient;
     get invoices(): InvoicesClient;
+    get entitlements(): EntitlementsClient;
 }
 export * from './types';

package/dist/sdk-v2/index.js

@@ -48,6 +48,9 @@ class Vayu {
     get invoices() {
         return new clients_1.InvoicesClient();
     }
+    get entitlements() {
+        return new clients_1.EntitlementsClient();
+    }
 }
 exports.Vayu = Vayu;
 __exportStar(require("./types"), exports);

package/dist/sdk-v2/types/index.d.ts

@@ -2,5 +2,6 @@ export * from './Customers';
 export * from './Events';
 export * from './Invoices';
 export * from './Products';
-export { AggregationMethods, CriterionOperators, } from '../../openapi-v2';
+export * from './Entitlements';
+export { AggregationMethods, CriterionOperators, PricingCadence, } from '../../openapi-v2';
 export type { Aggregation, Criterion, Condition, CriterionValue, Pricing, PricingTiersInner as PricingTiers, } from '../../openapi-v2';

package/dist/sdk-v2/types/index.js

@@ -14,11 +14,13 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CriterionOperators = exports.AggregationMethods = void 0;
+exports.PricingCadence = exports.CriterionOperators = exports.AggregationMethods = void 0;
 __exportStar(require("./Customers"), exports);
 __exportStar(require("./Events"), exports);
 __exportStar(require("./Invoices"), exports);
 __exportStar(require("./Products"), exports);
+__exportStar(require("./Entitlements"), exports);
 var openapi_v2_1 = require("../../openapi-v2");
 Object.defineProperty(exports, "AggregationMethods", { enumerable: true, get: function () { return openapi_v2_1.AggregationMethods; } });
 Object.defineProperty(exports, "CriterionOperators", { enumerable: true, get: function () { return openapi_v2_1.CriterionOperators; } });
+Object.defineProperty(exports, "PricingCadence", { enumerable: true, get: function () { return openapi_v2_1.PricingCadence; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vayu-ts",
-  "version": "0.2.4",
+  "version": "0.2.6",
   "description": "Simple and easy to use typescript package for utilizing vayu billing system",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",

package/dist/openapi-v2/models/Event.d.ts

@@ -1,54 +0,0 @@
-/**
- * 24k
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * OpenAPI spec version: 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.
- */
-export declare class Event {
-    /**
-    * A class representation of the BSON ObjectId type.
-    */
-    'id': string;
-    'createdAt': Date;
-    'updatedAt': Date;
-    'name': string;
-    'timestamp': number;
-    /**
-    * Construct a type with a set of properties K of type T
-    */
-    'metadata': {
-        [key: string]: any;
-    };
-    /**
-    * A class representation of the BSON ObjectId type.
-    */
-    'accountId': string;
-    /**
-    * A class representation of the BSON ObjectId type.
-    */
-    'customerId': string;
-    /**
-    * A class representation of the BSON ObjectId type.
-    */
-    'productId': string;
-    'ref': string;
-    static readonly discriminator: 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-v2/models/Event.js

@@ -1,85 +0,0 @@
-"use strict";
-/**
- * 24k
- * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
- *
- * OpenAPI spec version: 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Event = void 0;
-class Event {
-    static getAttributeTypeMap() {
-        return Event.attributeTypeMap;
-    }
-    constructor() {
-    }
-}
-exports.Event = Event;
-Event.discriminator = undefined;
-Event.attributeTypeMap = [
-    {
-        "name": "id",
-        "baseName": "_id",
-        "type": "string",
-        "format": ""
-    },
-    {
-        "name": "createdAt",
-        "baseName": "createdAt",
-        "type": "Date",
-        "format": "date-time"
-    },
-    {
-        "name": "updatedAt",
-        "baseName": "updatedAt",
-        "type": "Date",
-        "format": "date-time"
-    },
-    {
-        "name": "name",
-        "baseName": "name",
-        "type": "string",
-        "format": ""
-    },
-    {
-        "name": "timestamp",
-        "baseName": "timestamp",
-        "type": "number",
-        "format": "double"
-    },
-    {
-        "name": "metadata",
-        "baseName": "metadata",
-        "type": "{ [key: string]: any; }",
-        "format": ""
-    },
-    {
-        "name": "accountId",
-        "baseName": "accountId",
-        "type": "string",
-        "format": ""
-    },
-    {
-        "name": "customerId",
-        "baseName": "customerId",
-        "type": "string",
-        "format": ""
-    },
-    {
-        "name": "productId",
-        "baseName": "productId",
-        "type": "string",
-        "format": ""
-    },
-    {
-        "name": "ref",
-        "baseName": "ref",
-        "type": "string",
-        "format": ""
-    }
-];