vayu-ts 0.2.4 → 0.2.6

package/dist/openapi-v2/types/PromiseAPI.d.ts

@@ -44,57 +44,69 @@ export declare class PromiseCustomersApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: CustomersApiRequestFactory, responseProcessor?: CustomersApiResponseProcessor);
     /**
-     * @param aPICreateCustomerPayload
+     * Create a new customer.
+     * @param aPICreateCustomerPayload - The details of the customer to create.
      */
     createCustomerWithHttpInfo(aPICreateCustomerPayload: APICreateCustomerPayload, _options?: Configuration): Promise<HttpInfo<APICustomer>>;
     /**
-     * @param aPICreateCustomerPayload
+     * Create a new customer.
+     * @param aPICreateCustomerPayload - The details of the customer to create.
      */
     createCustomer(aPICreateCustomerPayload: APICreateCustomerPayload, _options?: Configuration): Promise<APICustomer>;
     /**
-     * @param id
+     * Delete a customer by ID.
+     * @param id - The ID of the customer to delete.
      */
     deleteCustomerWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<void>>;
     /**
-     * @param id
+     * Delete a customer by ID.
+     * @param id - The ID of the customer to delete.
      */
     deleteCustomer(id: string, _options?: Configuration): Promise<void>;
     /**
-     * @param id
+     * Get a single customer by ID.
+     * @param id - The ID of the customer to fetch.
      */
     getCustomerWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<APICustomer>>;
     /**
-     * @param id
+     * Get a single customer by ID.
+     * @param id - The ID of the customer to fetch.
      */
     getCustomer(id: string, _options?: Configuration): Promise<APICustomer>;
     /**
-     * @param aPIQueryPayloadAPICustomer
+     * Query customers based on filters and pagination.
+     * @param aPIQueryPayloadAPICustomer - The query filters and pagination options.
      */
     queryCustomersWithHttpInfo(aPIQueryPayloadAPICustomer: APIQueryPayloadAPICustomer, _options?: Configuration): Promise<HttpInfo<QueryResultAPICustomer>>;
     /**
-     * @param aPIQueryPayloadAPICustomer
+     * Query customers based on filters and pagination.
+     * @param aPIQueryPayloadAPICustomer - The query filters and pagination options.
      */
     queryCustomers(aPIQueryPayloadAPICustomer: APIQueryPayloadAPICustomer, _options?: Configuration): Promise<QueryResultAPICustomer>;
     /**
-     * @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: ReviseEntitlementPayload, id: string, productId: string, _options?: Configuration): Promise<HttpInfo<APIEntitlement>>;
     /**
-     * @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: ReviseEntitlementPayload, id: string, productId: string, _options?: Configuration): Promise<APIEntitlement>;
     /**
-     * @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: APIUpdateCustomerPayload, id: string, _options?: Configuration): Promise<HttpInfo<APICustomer>>;
     /**
-     * @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: APIUpdateCustomerPayload, id: string, _options?: Configuration): Promise<APICustomer>;
 }
@@ -103,27 +115,33 @@ export declare class PromiseEntitlementsApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: EntitlementsApiRequestFactory, responseProcessor?: EntitlementsApiResponseProcessor);
     /**
-     * @param id
+     * Delete an entitlement by ID.
+     * @param id - The ID of the entitlement to delete.
      */
     deleteEntitlementWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<void>>;
     /**
-     * @param id
+     * Delete an entitlement by ID.
+     * @param id - The ID of the entitlement to delete.
      */
     deleteEntitlement(id: string, _options?: Configuration): Promise<void>;
     /**
-     * @param id
+     * Get a single entitlement by ID.
+     * @param id - The ID of the entitlement to fetch.
      */
     getEntitlementWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<APIEntitlement>>;
     /**
-     * @param id
+     * Get a single entitlement by ID.
+     * @param id - The ID of the entitlement to fetch.
      */
     getEntitlement(id: string, _options?: Configuration): Promise<APIEntitlement>;
     /**
-     * @param aPIQueryPayloadAPIEntitlement
+     * Query entitlements based on filters and pagination.
+     * @param aPIQueryPayloadAPIEntitlement - The query filters and pagination options.
      */
     queryEntitlementsWithHttpInfo(aPIQueryPayloadAPIEntitlement: APIQueryPayloadAPIEntitlement, _options?: Configuration): Promise<HttpInfo<QueryResultAPIEntitlement>>;
     /**
-     * @param aPIQueryPayloadAPIEntitlement
+     * Query entitlements based on filters and pagination.
+     * @param aPIQueryPayloadAPIEntitlement - The query filters and pagination options.
      */
     queryEntitlements(aPIQueryPayloadAPIEntitlement: APIQueryPayloadAPIEntitlement, _options?: Configuration): Promise<QueryResultAPIEntitlement>;
 }
@@ -132,35 +150,43 @@ export declare class PromiseEventsApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: EventsApiRequestFactory, responseProcessor?: EventsApiResponseProcessor);
     /**
-     * @param id
+     * Delete an event by ID.
+     * @param id - The ID of the event to delete.
      */
     deleteEventWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<void>>;
     /**
-     * @param id
+     * Delete an event by ID.
+     * @param id - The ID of the event to delete.
      */
     deleteEvent(id: string, _options?: Configuration): Promise<void>;
     /**
-     * @param id
+     * Get a single event by ID.
+     * @param id - The ID of the event to fetch.
      */
     getEventWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<APIEvent>>;
     /**
-     * @param id
+     * Get a single event by ID.
+     * @param id - The ID of the event to fetch.
      */
     getEvent(id: string, _options?: Configuration): Promise<APIEvent>;
     /**
-     * @param aPIIngestEventPayload
+     * Ingest events to the system
+     * @param aPIIngestEventPayload - The events to ingest
      */
     ingestEventToTheSystemWithHttpInfo(aPIIngestEventPayload: Array<APIIngestEventPayload>, _options?: Configuration): Promise<HttpInfo<IngestEventToTheSystem201Response>>;
     /**
-     * @param aPIIngestEventPayload
+     * Ingest events to the system
+     * @param aPIIngestEventPayload - The events to ingest
      */
     ingestEventToTheSystem(aPIIngestEventPayload: Array<APIIngestEventPayload>, _options?: Configuration): Promise<IngestEventToTheSystem201Response>;
     /**
-     * @param aPIQueryPayloadAPIEvent
+     * Query events based on filters and pagination.
+     * @param aPIQueryPayloadAPIEvent - The query filters and pagination options.
      */
     queryEventsWithHttpInfo(aPIQueryPayloadAPIEvent: APIQueryPayloadAPIEvent, _options?: Configuration): Promise<HttpInfo<QueryResultAPIEvent>>;
     /**
-     * @param aPIQueryPayloadAPIEvent
+     * Query events based on filters and pagination.
+     * @param aPIQueryPayloadAPIEvent - The query filters and pagination options.
      */
     queryEvents(aPIQueryPayloadAPIEvent: APIQueryPayloadAPIEvent, _options?: Configuration): Promise<QueryResultAPIEvent>;
 }
@@ -169,53 +195,65 @@ export declare class PromiseInvoicesApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: InvoicesApiRequestFactory, responseProcessor?: InvoicesApiResponseProcessor);
     /**
-     * @param id
+     * Calculate the total of an invoice.
+     * @param id - The ID of the invoice to calculate.
      */
     calculateInvoiceWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<APIInvoice>>;
     /**
-     * @param id
+     * Calculate the total of an invoice.
+     * @param id - The ID of the invoice to calculate.
      */
     calculateInvoice(id: string, _options?: Configuration): Promise<APIInvoice>;
     /**
-     * @param aPICreateInvoicePayload
+     * Create a new invoice.
+     * @param aPICreateInvoicePayload - The details of the invoice to create.
      */
     createInvoiceWithHttpInfo(aPICreateInvoicePayload: APICreateInvoicePayload, _options?: Configuration): Promise<HttpInfo<APIInvoice>>;
     /**
-     * @param aPICreateInvoicePayload
+     * Create a new invoice.
+     * @param aPICreateInvoicePayload - The details of the invoice to create.
      */
     createInvoice(aPICreateInvoicePayload: APICreateInvoicePayload, _options?: Configuration): Promise<APIInvoice>;
     /**
-     * @param id
+     * Delete an invoice by ID.
+     * @param id - The ID of the invoice to delete.
      */
     deleteInvoiceWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<void>>;
     /**
-     * @param id
+     * Delete an invoice by ID.
+     * @param id - The ID of the invoice to delete.
      */
     deleteInvoice(id: string, _options?: Configuration): Promise<void>;
     /**
-     * @param id
+     * Get a single invoice by ID.
+     * @param id - The ID of the invoice to fetch.
      */
     getInvoiceWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<APIInvoice>>;
     /**
-     * @param id
+     * Get a single invoice by ID.
+     * @param id - The ID of the invoice to fetch.
      */
     getInvoice(id: string, _options?: Configuration): Promise<APIInvoice>;
     /**
-     * @param aPIQueryPayloadAPIInvoice
+     * Query invoices based on filters and pagination.
+     * @param aPIQueryPayloadAPIInvoice - The query filters and pagination options.
      */
     queryInvoicesWithHttpInfo(aPIQueryPayloadAPIInvoice: APIQueryPayloadAPIInvoice, _options?: Configuration): Promise<HttpInfo<QueryResultAPIInvoice>>;
     /**
-     * @param aPIQueryPayloadAPIInvoice
+     * Query invoices based on filters and pagination.
+     * @param aPIQueryPayloadAPIInvoice - The query filters and pagination options.
      */
     queryInvoices(aPIQueryPayloadAPIInvoice: APIQueryPayloadAPIInvoice, _options?: Configuration): Promise<QueryResultAPIInvoice>;
     /**
-     * @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: APIUpdateInvoicePayload, id: string, _options?: Configuration): Promise<HttpInfo<APIInvoice>>;
     /**
-     * @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: APIUpdateInvoicePayload, id: string, _options?: Configuration): Promise<APIInvoice>;
 }
@@ -224,45 +262,55 @@ export declare class PromiseProductsApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: ProductsApiRequestFactory, responseProcessor?: ProductsApiResponseProcessor);
     /**
-     * @param aPICreateProductPayload
+     * Create a new product.
+     * @param aPICreateProductPayload - The details of the product to create.
      */
     createProductWithHttpInfo(aPICreateProductPayload: APICreateProductPayload, _options?: Configuration): Promise<HttpInfo<APIProduct>>;
     /**
-     * @param aPICreateProductPayload
+     * Create a new product.
+     * @param aPICreateProductPayload - The details of the product to create.
      */
     createProduct(aPICreateProductPayload: APICreateProductPayload, _options?: Configuration): Promise<APIProduct>;
     /**
-     * @param id
+     * Delete a product by ID.
+     * @param id - The ID of the product to delete.
      */
     deleteProductWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<void>>;
     /**
-     * @param id
+     * Delete a product by ID.
+     * @param id - The ID of the product to delete.
      */
     deleteProduct(id: string, _options?: Configuration): Promise<void>;
     /**
-     * @param id
+     * Get a single product by ID.
+     * @param id - The ID of the product to fetch.
      */
     getProductWithHttpInfo(id: string, _options?: Configuration): Promise<HttpInfo<APIProduct>>;
     /**
-     * @param id
+     * Get a single product by ID.
+     * @param id - The ID of the product to fetch.
      */
     getProduct(id: string, _options?: Configuration): Promise<APIProduct>;
     /**
-     * @param aPIQueryPayloadAPIProduct
+     * Query products based on filters and pagination.
+     * @param aPIQueryPayloadAPIProduct - The query filters and pagination details.
      */
     queryProductsWithHttpInfo(aPIQueryPayloadAPIProduct: APIQueryPayloadAPIProduct, _options?: Configuration): Promise<HttpInfo<QueryResultAPIProduct>>;
     /**
-     * @param aPIQueryPayloadAPIProduct
+     * Query products based on filters and pagination.
+     * @param aPIQueryPayloadAPIProduct - The query filters and pagination details.
      */
     queryProducts(aPIQueryPayloadAPIProduct: APIQueryPayloadAPIProduct, _options?: Configuration): Promise<QueryResultAPIProduct>;
     /**
-     * @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: APIUpdateProductPayload, id: string, _options?: Configuration): Promise<HttpInfo<APIProduct>>;
     /**
-     * @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: APIUpdateProductPayload, id: string, _options?: Configuration): Promise<APIProduct>;
 }