vayu-ts 0.2.5 → 0.2.6

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

@@ -45,7 +45,8 @@ class ObservableCustomersApi {
         this.responseProcessor = responseProcessor || new CustomersApi_1.CustomersApiResponseProcessor();
     }
     /**
-     * @param aPICreateCustomerPayload
+     * Create a new customer.
+     * @param aPICreateCustomerPayload - The details of the customer to create.
      */
     createCustomerWithHttpInfo(aPICreateCustomerPayload, _options) {
         const requestContextPromise = this.requestFactory.createCustomer(aPICreateCustomerPayload, _options);
@@ -64,13 +65,15 @@ class ObservableCustomersApi {
         }));
     }
     /**
-     * @param aPICreateCustomerPayload
+     * Create a new customer.
+     * @param aPICreateCustomerPayload - The details of the customer to create.
      */
     createCustomer(aPICreateCustomerPayload, _options) {
         return this.createCustomerWithHttpInfo(aPICreateCustomerPayload, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param id
+     * Delete a customer by ID.
+     * @param id - The ID of the customer to delete.
      */
     deleteCustomerWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.deleteCustomer(id, _options);
@@ -89,13 +92,15 @@ class ObservableCustomersApi {
         }));
     }
     /**
-     * @param id
+     * Delete a customer by ID.
+     * @param id - The ID of the customer to delete.
      */
     deleteCustomer(id, _options) {
         return this.deleteCustomerWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param id
+     * Get a single customer by ID.
+     * @param id - The ID of the customer to fetch.
      */
     getCustomerWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.getCustomer(id, _options);
@@ -114,13 +119,15 @@ class ObservableCustomersApi {
         }));
     }
     /**
-     * @param id
+     * Get a single customer by ID.
+     * @param id - The ID of the customer to fetch.
      */
     getCustomer(id, _options) {
         return this.getCustomerWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param aPIQueryPayloadAPICustomer
+     * Query customers based on filters and pagination.
+     * @param aPIQueryPayloadAPICustomer - The query filters and pagination options.
      */
     queryCustomersWithHttpInfo(aPIQueryPayloadAPICustomer, _options) {
         const requestContextPromise = this.requestFactory.queryCustomers(aPIQueryPayloadAPICustomer, _options);
@@ -139,15 +146,17 @@ class ObservableCustomersApi {
         }));
     }
     /**
-     * @param aPIQueryPayloadAPICustomer
+     * Query customers based on filters and pagination.
+     * @param aPIQueryPayloadAPICustomer - The query filters and pagination options.
      */
     queryCustomers(aPIQueryPayloadAPICustomer, _options) {
         return this.queryCustomersWithHttpInfo(aPIQueryPayloadAPICustomer, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @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 requestContextPromise = this.requestFactory.updateACustomersProduct(body, id, productId, _options);
@@ -166,16 +175,18 @@ class ObservableCustomersApi {
         }));
     }
     /**
-     * @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) {
         return this.updateACustomersProductWithHttpInfo(body, id, productId, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @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 requestContextPromise = this.requestFactory.updateCustomer(aPIUpdateCustomerPayload, id, _options);
@@ -194,8 +205,9 @@ class ObservableCustomersApi {
         }));
     }
     /**
-     * @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) {
         return this.updateCustomerWithHttpInfo(aPIUpdateCustomerPayload, id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
@@ -210,7 +222,8 @@ class ObservableEntitlementsApi {
         this.responseProcessor = responseProcessor || new EntitlementsApi_1.EntitlementsApiResponseProcessor();
     }
     /**
-     * @param id
+     * Delete an entitlement by ID.
+     * @param id - The ID of the entitlement to delete.
      */
     deleteEntitlementWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.deleteEntitlement(id, _options);
@@ -229,13 +242,15 @@ class ObservableEntitlementsApi {
         }));
     }
     /**
-     * @param id
+     * Delete an entitlement by ID.
+     * @param id - The ID of the entitlement to delete.
      */
     deleteEntitlement(id, _options) {
         return this.deleteEntitlementWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param id
+     * Get a single entitlement by ID.
+     * @param id - The ID of the entitlement to fetch.
      */
     getEntitlementWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.getEntitlement(id, _options);
@@ -254,13 +269,15 @@ class ObservableEntitlementsApi {
         }));
     }
     /**
-     * @param id
+     * Get a single entitlement by ID.
+     * @param id - The ID of the entitlement to fetch.
      */
     getEntitlement(id, _options) {
         return this.getEntitlementWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param aPIQueryPayloadAPIEntitlement
+     * Query entitlements based on filters and pagination.
+     * @param aPIQueryPayloadAPIEntitlement - The query filters and pagination options.
      */
     queryEntitlementsWithHttpInfo(aPIQueryPayloadAPIEntitlement, _options) {
         const requestContextPromise = this.requestFactory.queryEntitlements(aPIQueryPayloadAPIEntitlement, _options);
@@ -279,7 +296,8 @@ class ObservableEntitlementsApi {
         }));
     }
     /**
-     * @param aPIQueryPayloadAPIEntitlement
+     * Query entitlements based on filters and pagination.
+     * @param aPIQueryPayloadAPIEntitlement - The query filters and pagination options.
      */
     queryEntitlements(aPIQueryPayloadAPIEntitlement, _options) {
         return this.queryEntitlementsWithHttpInfo(aPIQueryPayloadAPIEntitlement, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
@@ -294,7 +312,8 @@ class ObservableEventsApi {
         this.responseProcessor = responseProcessor || new EventsApi_1.EventsApiResponseProcessor();
     }
     /**
-     * @param id
+     * Delete an event by ID.
+     * @param id - The ID of the event to delete.
      */
     deleteEventWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.deleteEvent(id, _options);
@@ -313,13 +332,15 @@ class ObservableEventsApi {
         }));
     }
     /**
-     * @param id
+     * Delete an event by ID.
+     * @param id - The ID of the event to delete.
      */
     deleteEvent(id, _options) {
         return this.deleteEventWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param id
+     * Get a single event by ID.
+     * @param id - The ID of the event to fetch.
      */
     getEventWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.getEvent(id, _options);
@@ -338,13 +359,15 @@ class ObservableEventsApi {
         }));
     }
     /**
-     * @param id
+     * Get a single event by ID.
+     * @param id - The ID of the event to fetch.
      */
     getEvent(id, _options) {
         return this.getEventWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param aPIIngestEventPayload
+     * Ingest events to the system
+     * @param aPIIngestEventPayload - The events to ingest
      */
     ingestEventToTheSystemWithHttpInfo(aPIIngestEventPayload, _options) {
         const requestContextPromise = this.requestFactory.ingestEventToTheSystem(aPIIngestEventPayload, _options);
@@ -363,13 +386,15 @@ class ObservableEventsApi {
         }));
     }
     /**
-     * @param aPIIngestEventPayload
+     * Ingest events to the system
+     * @param aPIIngestEventPayload - The events to ingest
      */
     ingestEventToTheSystem(aPIIngestEventPayload, _options) {
         return this.ingestEventToTheSystemWithHttpInfo(aPIIngestEventPayload, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param aPIQueryPayloadAPIEvent
+     * Query events based on filters and pagination.
+     * @param aPIQueryPayloadAPIEvent - The query filters and pagination options.
      */
     queryEventsWithHttpInfo(aPIQueryPayloadAPIEvent, _options) {
         const requestContextPromise = this.requestFactory.queryEvents(aPIQueryPayloadAPIEvent, _options);
@@ -388,7 +413,8 @@ class ObservableEventsApi {
         }));
     }
     /**
-     * @param aPIQueryPayloadAPIEvent
+     * Query events based on filters and pagination.
+     * @param aPIQueryPayloadAPIEvent - The query filters and pagination options.
      */
     queryEvents(aPIQueryPayloadAPIEvent, _options) {
         return this.queryEventsWithHttpInfo(aPIQueryPayloadAPIEvent, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
@@ -403,7 +429,8 @@ class ObservableInvoicesApi {
         this.responseProcessor = responseProcessor || new InvoicesApi_1.InvoicesApiResponseProcessor();
     }
     /**
-     * @param id
+     * Calculate the total of an invoice.
+     * @param id - The ID of the invoice to calculate.
      */
     calculateInvoiceWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.calculateInvoice(id, _options);
@@ -422,13 +449,15 @@ class ObservableInvoicesApi {
         }));
     }
     /**
-     * @param id
+     * Calculate the total of an invoice.
+     * @param id - The ID of the invoice to calculate.
      */
     calculateInvoice(id, _options) {
         return this.calculateInvoiceWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param aPICreateInvoicePayload
+     * Create a new invoice.
+     * @param aPICreateInvoicePayload - The details of the invoice to create.
      */
     createInvoiceWithHttpInfo(aPICreateInvoicePayload, _options) {
         const requestContextPromise = this.requestFactory.createInvoice(aPICreateInvoicePayload, _options);
@@ -447,13 +476,15 @@ class ObservableInvoicesApi {
         }));
     }
     /**
-     * @param aPICreateInvoicePayload
+     * Create a new invoice.
+     * @param aPICreateInvoicePayload - The details of the invoice to create.
      */
     createInvoice(aPICreateInvoicePayload, _options) {
         return this.createInvoiceWithHttpInfo(aPICreateInvoicePayload, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param id
+     * Delete an invoice by ID.
+     * @param id - The ID of the invoice to delete.
      */
     deleteInvoiceWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.deleteInvoice(id, _options);
@@ -472,13 +503,15 @@ class ObservableInvoicesApi {
         }));
     }
     /**
-     * @param id
+     * Delete an invoice by ID.
+     * @param id - The ID of the invoice to delete.
      */
     deleteInvoice(id, _options) {
         return this.deleteInvoiceWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param id
+     * Get a single invoice by ID.
+     * @param id - The ID of the invoice to fetch.
      */
     getInvoiceWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.getInvoice(id, _options);
@@ -497,13 +530,15 @@ class ObservableInvoicesApi {
         }));
     }
     /**
-     * @param id
+     * Get a single invoice by ID.
+     * @param id - The ID of the invoice to fetch.
      */
     getInvoice(id, _options) {
         return this.getInvoiceWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param aPIQueryPayloadAPIInvoice
+     * Query invoices based on filters and pagination.
+     * @param aPIQueryPayloadAPIInvoice - The query filters and pagination options.
      */
     queryInvoicesWithHttpInfo(aPIQueryPayloadAPIInvoice, _options) {
         const requestContextPromise = this.requestFactory.queryInvoices(aPIQueryPayloadAPIInvoice, _options);
@@ -522,14 +557,16 @@ class ObservableInvoicesApi {
         }));
     }
     /**
-     * @param aPIQueryPayloadAPIInvoice
+     * Query invoices based on filters and pagination.
+     * @param aPIQueryPayloadAPIInvoice - The query filters and pagination options.
      */
     queryInvoices(aPIQueryPayloadAPIInvoice, _options) {
         return this.queryInvoicesWithHttpInfo(aPIQueryPayloadAPIInvoice, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @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 requestContextPromise = this.requestFactory.updateInvoice(aPIUpdateInvoicePayload, id, _options);
@@ -548,8 +585,9 @@ class ObservableInvoicesApi {
         }));
     }
     /**
-     * @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) {
         return this.updateInvoiceWithHttpInfo(aPIUpdateInvoicePayload, id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
@@ -564,7 +602,8 @@ class ObservableProductsApi {
         this.responseProcessor = responseProcessor || new ProductsApi_1.ProductsApiResponseProcessor();
     }
     /**
-     * @param aPICreateProductPayload
+     * Create a new product.
+     * @param aPICreateProductPayload - The details of the product to create.
      */
     createProductWithHttpInfo(aPICreateProductPayload, _options) {
         const requestContextPromise = this.requestFactory.createProduct(aPICreateProductPayload, _options);
@@ -583,13 +622,15 @@ class ObservableProductsApi {
         }));
     }
     /**
-     * @param aPICreateProductPayload
+     * Create a new product.
+     * @param aPICreateProductPayload - The details of the product to create.
      */
     createProduct(aPICreateProductPayload, _options) {
         return this.createProductWithHttpInfo(aPICreateProductPayload, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param id
+     * Delete a product by ID.
+     * @param id - The ID of the product to delete.
      */
     deleteProductWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.deleteProduct(id, _options);
@@ -608,13 +649,15 @@ class ObservableProductsApi {
         }));
     }
     /**
-     * @param id
+     * Delete a product by ID.
+     * @param id - The ID of the product to delete.
      */
     deleteProduct(id, _options) {
         return this.deleteProductWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param id
+     * Get a single product by ID.
+     * @param id - The ID of the product to fetch.
      */
     getProductWithHttpInfo(id, _options) {
         const requestContextPromise = this.requestFactory.getProduct(id, _options);
@@ -633,13 +676,15 @@ class ObservableProductsApi {
         }));
     }
     /**
-     * @param id
+     * Get a single product by ID.
+     * @param id - The ID of the product to fetch.
      */
     getProduct(id, _options) {
         return this.getProductWithHttpInfo(id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @param aPIQueryPayloadAPIProduct
+     * Query products based on filters and pagination.
+     * @param aPIQueryPayloadAPIProduct - The query filters and pagination details.
      */
     queryProductsWithHttpInfo(aPIQueryPayloadAPIProduct, _options) {
         const requestContextPromise = this.requestFactory.queryProducts(aPIQueryPayloadAPIProduct, _options);
@@ -658,14 +703,16 @@ class ObservableProductsApi {
         }));
     }
     /**
-     * @param aPIQueryPayloadAPIProduct
+     * Query products based on filters and pagination.
+     * @param aPIQueryPayloadAPIProduct - The query filters and pagination details.
      */
     queryProducts(aPIQueryPayloadAPIProduct, _options) {
         return this.queryProductsWithHttpInfo(aPIQueryPayloadAPIProduct, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));
     }
     /**
-     * @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 requestContextPromise = this.requestFactory.updateProduct(aPIUpdateProductPayload, id, _options);
@@ -684,8 +731,9 @@ class ObservableProductsApi {
         }));
     }
     /**
-     * @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) {
         return this.updateProductWithHttpInfo(aPIUpdateProductPayload, id, _options).pipe((0, rxjsStub_2.map)((apiResponse) => apiResponse.data));