vayu-ts 0.2.5 → 0.2.7

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

@@ -1,5 +1,5 @@
 import { HttpInfo } from '../http/http';
-import { Configuration } from '../configuration';
+import { Configuration, ConfigurationOptions } from '../configuration';
 import { Observable } from '../rxjsStub';
 import { APICreateCustomerPayload } from '../models/APICreateCustomerPayload';
 import { APICreateInvoicePayload } from '../models/APICreateInvoicePayload';
@@ -36,11 +36,11 @@ export declare class ObservableAuthenticationApi {
     /**
      * @param loginRequest
      */
-    loginWithHttpInfo(loginRequest: LoginRequest, _options?: Configuration): Observable<HttpInfo<Login200Response>>;
+    loginWithHttpInfo(loginRequest: LoginRequest, _options?: ConfigurationOptions): Observable<HttpInfo<Login200Response>>;
     /**
      * @param loginRequest
      */
-    login(loginRequest: LoginRequest, _options?: Configuration): Observable<Login200Response>;
+    login(loginRequest: LoginRequest, _options?: ConfigurationOptions): Observable<Login200Response>;
 }
 import { CustomersApiRequestFactory, CustomersApiResponseProcessor } from "../apis/CustomersApi";
 export declare class ObservableCustomersApi {
@@ -49,59 +49,71 @@ export declare class ObservableCustomersApi {
     private configuration;
     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): Observable<HttpInfo<APICustomer>>;
+    createCustomerWithHttpInfo(aPICreateCustomerPayload: APICreateCustomerPayload, _options?: ConfigurationOptions): Observable<HttpInfo<APICustomer>>;
     /**
-     * @param aPICreateCustomerPayload
+     * Create a new customer.
+     * @param aPICreateCustomerPayload - The details of the customer to create.
      */
-    createCustomer(aPICreateCustomerPayload: APICreateCustomerPayload, _options?: Configuration): Observable<APICustomer>;
+    createCustomer(aPICreateCustomerPayload: APICreateCustomerPayload, _options?: ConfigurationOptions): Observable<APICustomer>;
     /**
-     * @param id
+     * Delete a customer by ID.
+     * @param id - The ID of the customer to delete.
      */
-    deleteCustomerWithHttpInfo(id: string, _options?: Configuration): Observable<HttpInfo<void>>;
+    deleteCustomerWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<void>>;
     /**
-     * @param id
+     * Delete a customer by ID.
+     * @param id - The ID of the customer to delete.
      */
-    deleteCustomer(id: string, _options?: Configuration): Observable<void>;
+    deleteCustomer(id: string, _options?: ConfigurationOptions): Observable<void>;
     /**
-     * @param id
+     * Get a single customer by ID.
+     * @param id - The ID of the customer to fetch.
      */
-    getCustomerWithHttpInfo(id: string, _options?: Configuration): Observable<HttpInfo<APICustomer>>;
+    getCustomerWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<APICustomer>>;
     /**
-     * @param id
+     * Get a single customer by ID.
+     * @param id - The ID of the customer to fetch.
      */
-    getCustomer(id: string, _options?: Configuration): Observable<APICustomer>;
+    getCustomer(id: string, _options?: ConfigurationOptions): Observable<APICustomer>;
     /**
-     * @param aPIQueryPayloadAPICustomer
+     * Query customers based on filters and pagination.
+     * @param aPIQueryPayloadAPICustomer - The query filters and pagination options.
      */
-    queryCustomersWithHttpInfo(aPIQueryPayloadAPICustomer: APIQueryPayloadAPICustomer, _options?: Configuration): Observable<HttpInfo<QueryResultAPICustomer>>;
+    queryCustomersWithHttpInfo(aPIQueryPayloadAPICustomer: APIQueryPayloadAPICustomer, _options?: ConfigurationOptions): Observable<HttpInfo<QueryResultAPICustomer>>;
     /**
-     * @param aPIQueryPayloadAPICustomer
+     * Query customers based on filters and pagination.
+     * @param aPIQueryPayloadAPICustomer - The query filters and pagination options.
      */
-    queryCustomers(aPIQueryPayloadAPICustomer: APIQueryPayloadAPICustomer, _options?: Configuration): Observable<QueryResultAPICustomer>;
+    queryCustomers(aPIQueryPayloadAPICustomer: APIQueryPayloadAPICustomer, _options?: ConfigurationOptions): Observable<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): Observable<HttpInfo<APIEntitlement>>;
+    updateACustomersProductWithHttpInfo(body: ReviseEntitlementPayload, id: string, productId: string, _options?: ConfigurationOptions): Observable<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): Observable<APIEntitlement>;
+    updateACustomersProduct(body: ReviseEntitlementPayload, id: string, productId: string, _options?: ConfigurationOptions): Observable<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): Observable<HttpInfo<APICustomer>>;
+    updateCustomerWithHttpInfo(aPIUpdateCustomerPayload: APIUpdateCustomerPayload, id: string, _options?: ConfigurationOptions): Observable<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): Observable<APICustomer>;
+    updateCustomer(aPIUpdateCustomerPayload: APIUpdateCustomerPayload, id: string, _options?: ConfigurationOptions): Observable<APICustomer>;
 }
 import { EntitlementsApiRequestFactory, EntitlementsApiResponseProcessor } from "../apis/EntitlementsApi";
 export declare class ObservableEntitlementsApi {
@@ -110,29 +122,35 @@ export declare class ObservableEntitlementsApi {
     private configuration;
     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): Observable<HttpInfo<void>>;
+    deleteEntitlementWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<void>>;
     /**
-     * @param id
+     * Delete an entitlement by ID.
+     * @param id - The ID of the entitlement to delete.
      */
-    deleteEntitlement(id: string, _options?: Configuration): Observable<void>;
+    deleteEntitlement(id: string, _options?: ConfigurationOptions): Observable<void>;
     /**
-     * @param id
+     * Get a single entitlement by ID.
+     * @param id - The ID of the entitlement to fetch.
      */
-    getEntitlementWithHttpInfo(id: string, _options?: Configuration): Observable<HttpInfo<APIEntitlement>>;
+    getEntitlementWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<APIEntitlement>>;
     /**
-     * @param id
+     * Get a single entitlement by ID.
+     * @param id - The ID of the entitlement to fetch.
      */
-    getEntitlement(id: string, _options?: Configuration): Observable<APIEntitlement>;
+    getEntitlement(id: string, _options?: ConfigurationOptions): Observable<APIEntitlement>;
     /**
-     * @param aPIQueryPayloadAPIEntitlement
+     * Query entitlements based on filters and pagination.
+     * @param aPIQueryPayloadAPIEntitlement - The query filters and pagination options.
      */
-    queryEntitlementsWithHttpInfo(aPIQueryPayloadAPIEntitlement: APIQueryPayloadAPIEntitlement, _options?: Configuration): Observable<HttpInfo<QueryResultAPIEntitlement>>;
+    queryEntitlementsWithHttpInfo(aPIQueryPayloadAPIEntitlement: APIQueryPayloadAPIEntitlement, _options?: ConfigurationOptions): Observable<HttpInfo<QueryResultAPIEntitlement>>;
     /**
-     * @param aPIQueryPayloadAPIEntitlement
+     * Query entitlements based on filters and pagination.
+     * @param aPIQueryPayloadAPIEntitlement - The query filters and pagination options.
      */
-    queryEntitlements(aPIQueryPayloadAPIEntitlement: APIQueryPayloadAPIEntitlement, _options?: Configuration): Observable<QueryResultAPIEntitlement>;
+    queryEntitlements(aPIQueryPayloadAPIEntitlement: APIQueryPayloadAPIEntitlement, _options?: ConfigurationOptions): Observable<QueryResultAPIEntitlement>;
 }
 import { EventsApiRequestFactory, EventsApiResponseProcessor } from "../apis/EventsApi";
 export declare class ObservableEventsApi {
@@ -141,37 +159,45 @@ export declare class ObservableEventsApi {
     private configuration;
     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): Observable<HttpInfo<void>>;
+    deleteEventWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<void>>;
     /**
-     * @param id
+     * Delete an event by ID.
+     * @param id - The ID of the event to delete.
      */
-    deleteEvent(id: string, _options?: Configuration): Observable<void>;
+    deleteEvent(id: string, _options?: ConfigurationOptions): Observable<void>;
     /**
-     * @param id
+     * Get a single event by ID.
+     * @param id - The ID of the event to fetch.
      */
-    getEventWithHttpInfo(id: string, _options?: Configuration): Observable<HttpInfo<APIEvent>>;
+    getEventWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<APIEvent>>;
     /**
-     * @param id
+     * Get a single event by ID.
+     * @param id - The ID of the event to fetch.
      */
-    getEvent(id: string, _options?: Configuration): Observable<APIEvent>;
+    getEvent(id: string, _options?: ConfigurationOptions): Observable<APIEvent>;
     /**
-     * @param aPIIngestEventPayload
+     * Ingest events to the system
+     * @param aPIIngestEventPayload - The events to ingest
      */
-    ingestEventToTheSystemWithHttpInfo(aPIIngestEventPayload: Array<APIIngestEventPayload>, _options?: Configuration): Observable<HttpInfo<IngestEventToTheSystem201Response>>;
+    ingestEventToTheSystemWithHttpInfo(aPIIngestEventPayload: Array<APIIngestEventPayload>, _options?: ConfigurationOptions): Observable<HttpInfo<IngestEventToTheSystem201Response>>;
     /**
-     * @param aPIIngestEventPayload
+     * Ingest events to the system
+     * @param aPIIngestEventPayload - The events to ingest
      */
-    ingestEventToTheSystem(aPIIngestEventPayload: Array<APIIngestEventPayload>, _options?: Configuration): Observable<IngestEventToTheSystem201Response>;
+    ingestEventToTheSystem(aPIIngestEventPayload: Array<APIIngestEventPayload>, _options?: ConfigurationOptions): Observable<IngestEventToTheSystem201Response>;
     /**
-     * @param aPIQueryPayloadAPIEvent
+     * Query events based on filters and pagination.
+     * @param aPIQueryPayloadAPIEvent - The query filters and pagination options.
      */
-    queryEventsWithHttpInfo(aPIQueryPayloadAPIEvent: APIQueryPayloadAPIEvent, _options?: Configuration): Observable<HttpInfo<QueryResultAPIEvent>>;
+    queryEventsWithHttpInfo(aPIQueryPayloadAPIEvent: APIQueryPayloadAPIEvent, _options?: ConfigurationOptions): Observable<HttpInfo<QueryResultAPIEvent>>;
     /**
-     * @param aPIQueryPayloadAPIEvent
+     * Query events based on filters and pagination.
+     * @param aPIQueryPayloadAPIEvent - The query filters and pagination options.
      */
-    queryEvents(aPIQueryPayloadAPIEvent: APIQueryPayloadAPIEvent, _options?: Configuration): Observable<QueryResultAPIEvent>;
+    queryEvents(aPIQueryPayloadAPIEvent: APIQueryPayloadAPIEvent, _options?: ConfigurationOptions): Observable<QueryResultAPIEvent>;
 }
 import { InvoicesApiRequestFactory, InvoicesApiResponseProcessor } from "../apis/InvoicesApi";
 export declare class ObservableInvoicesApi {
@@ -180,55 +206,67 @@ export declare class ObservableInvoicesApi {
     private configuration;
     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): Observable<HttpInfo<APIInvoice>>;
+    calculateInvoiceWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<APIInvoice>>;
     /**
-     * @param id
+     * Calculate the total of an invoice.
+     * @param id - The ID of the invoice to calculate.
      */
-    calculateInvoice(id: string, _options?: Configuration): Observable<APIInvoice>;
+    calculateInvoice(id: string, _options?: ConfigurationOptions): Observable<APIInvoice>;
     /**
-     * @param aPICreateInvoicePayload
+     * Create a new invoice.
+     * @param aPICreateInvoicePayload - The details of the invoice to create.
      */
-    createInvoiceWithHttpInfo(aPICreateInvoicePayload: APICreateInvoicePayload, _options?: Configuration): Observable<HttpInfo<APIInvoice>>;
+    createInvoiceWithHttpInfo(aPICreateInvoicePayload: APICreateInvoicePayload, _options?: ConfigurationOptions): Observable<HttpInfo<APIInvoice>>;
     /**
-     * @param aPICreateInvoicePayload
+     * Create a new invoice.
+     * @param aPICreateInvoicePayload - The details of the invoice to create.
      */
-    createInvoice(aPICreateInvoicePayload: APICreateInvoicePayload, _options?: Configuration): Observable<APIInvoice>;
+    createInvoice(aPICreateInvoicePayload: APICreateInvoicePayload, _options?: ConfigurationOptions): Observable<APIInvoice>;
     /**
-     * @param id
+     * Delete an invoice by ID.
+     * @param id - The ID of the invoice to delete.
      */
-    deleteInvoiceWithHttpInfo(id: string, _options?: Configuration): Observable<HttpInfo<void>>;
+    deleteInvoiceWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<void>>;
     /**
-     * @param id
+     * Delete an invoice by ID.
+     * @param id - The ID of the invoice to delete.
      */
-    deleteInvoice(id: string, _options?: Configuration): Observable<void>;
+    deleteInvoice(id: string, _options?: ConfigurationOptions): Observable<void>;
     /**
-     * @param id
+     * Get a single invoice by ID.
+     * @param id - The ID of the invoice to fetch.
      */
-    getInvoiceWithHttpInfo(id: string, _options?: Configuration): Observable<HttpInfo<APIInvoice>>;
+    getInvoiceWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<APIInvoice>>;
     /**
-     * @param id
+     * Get a single invoice by ID.
+     * @param id - The ID of the invoice to fetch.
      */
-    getInvoice(id: string, _options?: Configuration): Observable<APIInvoice>;
+    getInvoice(id: string, _options?: ConfigurationOptions): Observable<APIInvoice>;
     /**
-     * @param aPIQueryPayloadAPIInvoice
+     * Query invoices based on filters and pagination.
+     * @param aPIQueryPayloadAPIInvoice - The query filters and pagination options.
      */
-    queryInvoicesWithHttpInfo(aPIQueryPayloadAPIInvoice: APIQueryPayloadAPIInvoice, _options?: Configuration): Observable<HttpInfo<QueryResultAPIInvoice>>;
+    queryInvoicesWithHttpInfo(aPIQueryPayloadAPIInvoice: APIQueryPayloadAPIInvoice, _options?: ConfigurationOptions): Observable<HttpInfo<QueryResultAPIInvoice>>;
     /**
-     * @param aPIQueryPayloadAPIInvoice
+     * Query invoices based on filters and pagination.
+     * @param aPIQueryPayloadAPIInvoice - The query filters and pagination options.
      */
-    queryInvoices(aPIQueryPayloadAPIInvoice: APIQueryPayloadAPIInvoice, _options?: Configuration): Observable<QueryResultAPIInvoice>;
+    queryInvoices(aPIQueryPayloadAPIInvoice: APIQueryPayloadAPIInvoice, _options?: ConfigurationOptions): Observable<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): Observable<HttpInfo<APIInvoice>>;
+    updateInvoiceWithHttpInfo(aPIUpdateInvoicePayload: APIUpdateInvoicePayload, id: string, _options?: ConfigurationOptions): Observable<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): Observable<APIInvoice>;
+    updateInvoice(aPIUpdateInvoicePayload: APIUpdateInvoicePayload, id: string, _options?: ConfigurationOptions): Observable<APIInvoice>;
 }
 import { ProductsApiRequestFactory, ProductsApiResponseProcessor } from "../apis/ProductsApi";
 export declare class ObservableProductsApi {
@@ -237,45 +275,55 @@ export declare class ObservableProductsApi {
     private configuration;
     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): Observable<HttpInfo<APIProduct>>;
+    createProductWithHttpInfo(aPICreateProductPayload: APICreateProductPayload, _options?: ConfigurationOptions): Observable<HttpInfo<APIProduct>>;
     /**
-     * @param aPICreateProductPayload
+     * Create a new product.
+     * @param aPICreateProductPayload - The details of the product to create.
      */
-    createProduct(aPICreateProductPayload: APICreateProductPayload, _options?: Configuration): Observable<APIProduct>;
+    createProduct(aPICreateProductPayload: APICreateProductPayload, _options?: ConfigurationOptions): Observable<APIProduct>;
     /**
-     * @param id
+     * Delete a product by ID.
+     * @param id - The ID of the product to delete.
      */
-    deleteProductWithHttpInfo(id: string, _options?: Configuration): Observable<HttpInfo<void>>;
+    deleteProductWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<void>>;
     /**
-     * @param id
+     * Delete a product by ID.
+     * @param id - The ID of the product to delete.
      */
-    deleteProduct(id: string, _options?: Configuration): Observable<void>;
+    deleteProduct(id: string, _options?: ConfigurationOptions): Observable<void>;
     /**
-     * @param id
+     * Get a single product by ID.
+     * @param id - The ID of the product to fetch.
      */
-    getProductWithHttpInfo(id: string, _options?: Configuration): Observable<HttpInfo<APIProduct>>;
+    getProductWithHttpInfo(id: string, _options?: ConfigurationOptions): Observable<HttpInfo<APIProduct>>;
     /**
-     * @param id
+     * Get a single product by ID.
+     * @param id - The ID of the product to fetch.
      */
-    getProduct(id: string, _options?: Configuration): Observable<APIProduct>;
+    getProduct(id: string, _options?: ConfigurationOptions): Observable<APIProduct>;
     /**
-     * @param aPIQueryPayloadAPIProduct
+     * Query products based on filters and pagination.
+     * @param aPIQueryPayloadAPIProduct - The query filters and pagination details.
      */
-    queryProductsWithHttpInfo(aPIQueryPayloadAPIProduct: APIQueryPayloadAPIProduct, _options?: Configuration): Observable<HttpInfo<QueryResultAPIProduct>>;
+    queryProductsWithHttpInfo(aPIQueryPayloadAPIProduct: APIQueryPayloadAPIProduct, _options?: ConfigurationOptions): Observable<HttpInfo<QueryResultAPIProduct>>;
     /**
-     * @param aPIQueryPayloadAPIProduct
+     * Query products based on filters and pagination.
+     * @param aPIQueryPayloadAPIProduct - The query filters and pagination details.
      */
-    queryProducts(aPIQueryPayloadAPIProduct: APIQueryPayloadAPIProduct, _options?: Configuration): Observable<QueryResultAPIProduct>;
+    queryProducts(aPIQueryPayloadAPIProduct: APIQueryPayloadAPIProduct, _options?: ConfigurationOptions): Observable<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): Observable<HttpInfo<APIProduct>>;
+    updateProductWithHttpInfo(aPIUpdateProductPayload: APIUpdateProductPayload, id: string, _options?: ConfigurationOptions): Observable<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): Observable<APIProduct>;
+    updateProduct(aPIUpdateProductPayload: APIUpdateProductPayload, id: string, _options?: ConfigurationOptions): Observable<APIProduct>;
 }