@emilgroup/billing-sdk-node 1.43.0 → 1.43.1-beta.1

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/billing-sdk-node@1.43.0 --save
+npm install @emilgroup/billing-sdk-node@1.43.1-beta.1 --save
 ```
 or 
 ```
-yarn add @emilgroup/billing-sdk-node@1.43.0
+yarn add @emilgroup/billing-sdk-node@1.43.1-beta.1
 ```
 
 And then you can import `InvoicesApi`.

package/api/correction-invoices-api.ts

@@ -35,7 +35,7 @@ const FormData = require('form-data');
 export const CorrectionInvoicesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.
+         * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the correction invoice
          * @param {CreateInvoiceForPolicyRequestDto} createInvoiceForPolicyRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -97,7 +97,7 @@ export const CorrectionInvoicesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = CorrectionInvoicesApiAxiosParamCreator(configuration)
     return {
         /**
-         * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.
+         * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the correction invoice
          * @param {CreateInvoiceForPolicyRequestDto} createInvoiceForPolicyRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -120,7 +120,7 @@ export const CorrectionInvoicesApiFactory = function (configuration?: Configurat
     const localVarFp = CorrectionInvoicesApiFp(configuration)
     return {
         /**
-         * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.
+         * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the correction invoice
          * @param {CreateInvoiceForPolicyRequestDto} createInvoiceForPolicyRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -170,7 +170,7 @@ export interface CorrectionInvoicesApiCreateCorrectionInvoiceRequest {
  */
 export class CorrectionInvoicesApi extends BaseAPI {
     /**
-     * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.
+     * This will create a correction invoice. That will be generated on policy update which affects the price, These invoices usually are positive or negative value. The main purpose of this invoices is to recalculate the customer invoices and be created if any price difference.  **Required Permissions**  \"billing-management.invoices.create\"
      * @summary Create the correction invoice
      * @param {CorrectionInvoicesApiCreateCorrectionInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/api/draft-invoice-api.ts

@@ -33,7 +33,7 @@ const FormData = require('form-data');
 export const DraftInvoiceApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 
+         * undefined  **Required Permissions**  \"billing-management.invoices.create\"
          * @param {CreateDraftInvoiceRequestDto} createDraftInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -79,7 +79,7 @@ export const DraftInvoiceApiAxiosParamCreator = function (configuration?: Config
             };
         },
         /**
-         * 
+         * undefined  **Required Permissions**  \"billing-management.invoices.delete\"
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -119,7 +119,7 @@ export const DraftInvoiceApiAxiosParamCreator = function (configuration?: Config
             };
         },
         /**
-         * 
+         * undefined  **Required Permissions**  \"billing-management.invoices.delete\"
          * @param {object} body 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -175,7 +175,7 @@ export const DraftInvoiceApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = DraftInvoiceApiAxiosParamCreator(configuration)
     return {
         /**
-         * 
+         * undefined  **Required Permissions**  \"billing-management.invoices.create\"
          * @param {CreateDraftInvoiceRequestDto} createDraftInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -186,7 +186,7 @@ export const DraftInvoiceApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * undefined  **Required Permissions**  \"billing-management.invoices.delete\"
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -196,7 +196,7 @@ export const DraftInvoiceApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * undefined  **Required Permissions**  \"billing-management.invoices.delete\"
          * @param {object} body 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -217,7 +217,7 @@ export const DraftInvoiceApiFactory = function (configuration?: Configuration, b
     const localVarFp = DraftInvoiceApiFp(configuration)
     return {
         /**
-         * 
+         * undefined  **Required Permissions**  \"billing-management.invoices.create\"
          * @param {CreateDraftInvoiceRequestDto} createDraftInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -227,7 +227,7 @@ export const DraftInvoiceApiFactory = function (configuration?: Configuration, b
             return localVarFp.createDraftInvoice(createDraftInvoiceRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * undefined  **Required Permissions**  \"billing-management.invoices.delete\"
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -236,7 +236,7 @@ export const DraftInvoiceApiFactory = function (configuration?: Configuration, b
             return localVarFp.deleteAllDraftInvoices(authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * undefined  **Required Permissions**  \"billing-management.invoices.delete\"
          * @param {object} body 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -312,7 +312,7 @@ export interface DraftInvoiceApiDeleteDraftInvoiceRequest {
  */
 export class DraftInvoiceApi extends BaseAPI {
     /**
-     * 
+     * undefined  **Required Permissions**  \"billing-management.invoices.create\"
      * @param {DraftInvoiceApiCreateDraftInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -323,7 +323,7 @@ export class DraftInvoiceApi extends BaseAPI {
     }
 
     /**
-     * 
+     * undefined  **Required Permissions**  \"billing-management.invoices.delete\"
      * @param {DraftInvoiceApiDeleteAllDraftInvoicesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -334,7 +334,7 @@ export class DraftInvoiceApi extends BaseAPI {
     }
 
     /**
-     * 
+     * undefined  **Required Permissions**  \"billing-management.invoices.delete\"
      * @param {DraftInvoiceApiDeleteDraftInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}

package/api/estimated-invoices-api.ts

@@ -43,7 +43,7 @@ const FormData = require('form-data');
 export const EstimatedInvoicesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * This will create a custom estimated invoice.
+         * This will create a custom estimated invoice.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the custom estimated invoice
          * @param {CreateCustomEstimatedInvoiceRequestDto} createCustomEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -90,7 +90,7 @@ export const EstimatedInvoicesApiAxiosParamCreator = function (configuration?: C
             };
         },
         /**
-         * This creates an estimated invoice. It will not be saved in the database.
+         * This creates an estimated invoice. It will not be saved in the database.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the estimated invoice
          * @param {CreateEstimatedInvoiceRequestDto} createEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -137,7 +137,7 @@ export const EstimatedInvoicesApiAxiosParamCreator = function (configuration?: C
             };
         },
         /**
-         * This creates an estimated invoice. It will not be saved in the database.
+         * This creates an estimated invoice. It will not be saved in the database.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the estimated invoice
          * @param {CreateEstimatedInvoiceForIntervalRequestDto} createEstimatedInvoiceForIntervalRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -194,7 +194,7 @@ export const EstimatedInvoicesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = EstimatedInvoicesApiAxiosParamCreator(configuration)
     return {
         /**
-         * This will create a custom estimated invoice.
+         * This will create a custom estimated invoice.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the custom estimated invoice
          * @param {CreateCustomEstimatedInvoiceRequestDto} createCustomEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -206,7 +206,7 @@ export const EstimatedInvoicesApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * This creates an estimated invoice. It will not be saved in the database.
+         * This creates an estimated invoice. It will not be saved in the database.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the estimated invoice
          * @param {CreateEstimatedInvoiceRequestDto} createEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -218,7 +218,7 @@ export const EstimatedInvoicesApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * This creates an estimated invoice. It will not be saved in the database.
+         * This creates an estimated invoice. It will not be saved in the database.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the estimated invoice
          * @param {CreateEstimatedInvoiceForIntervalRequestDto} createEstimatedInvoiceForIntervalRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -240,7 +240,7 @@ export const EstimatedInvoicesApiFactory = function (configuration?: Configurati
     const localVarFp = EstimatedInvoicesApiFp(configuration)
     return {
         /**
-         * This will create a custom estimated invoice.
+         * This will create a custom estimated invoice.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the custom estimated invoice
          * @param {CreateCustomEstimatedInvoiceRequestDto} createCustomEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -251,7 +251,7 @@ export const EstimatedInvoicesApiFactory = function (configuration?: Configurati
             return localVarFp.createCustomEstimatedInvoice(createCustomEstimatedInvoiceRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * This creates an estimated invoice. It will not be saved in the database.
+         * This creates an estimated invoice. It will not be saved in the database.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the estimated invoice
          * @param {CreateEstimatedInvoiceRequestDto} createEstimatedInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -262,7 +262,7 @@ export const EstimatedInvoicesApiFactory = function (configuration?: Configurati
             return localVarFp.createEstimatedInvoice(createEstimatedInvoiceRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * This creates an estimated invoice. It will not be saved in the database.
+         * This creates an estimated invoice. It will not be saved in the database.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the estimated invoice
          * @param {CreateEstimatedInvoiceForIntervalRequestDto} createEstimatedInvoiceForIntervalRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -346,7 +346,7 @@ export interface EstimatedInvoicesApiCreateEstimatedInvoiceFromIntervalRequest {
  */
 export class EstimatedInvoicesApi extends BaseAPI {
     /**
-     * This will create a custom estimated invoice.
+     * This will create a custom estimated invoice.  **Required Permissions**  \"billing-management.invoices.create\"
      * @summary Create the custom estimated invoice
      * @param {EstimatedInvoicesApiCreateCustomEstimatedInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -358,7 +358,7 @@ export class EstimatedInvoicesApi extends BaseAPI {
     }
 
     /**
-     * This creates an estimated invoice. It will not be saved in the database.
+     * This creates an estimated invoice. It will not be saved in the database.  **Required Permissions**  \"billing-management.invoices.create\"
      * @summary Create the estimated invoice
      * @param {EstimatedInvoicesApiCreateEstimatedInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -370,7 +370,7 @@ export class EstimatedInvoicesApi extends BaseAPI {
     }
 
     /**
-     * This creates an estimated invoice. It will not be saved in the database.
+     * This creates an estimated invoice. It will not be saved in the database.  **Required Permissions**  \"billing-management.invoices.create\"
      * @summary Create the estimated invoice
      * @param {EstimatedInvoicesApiCreateEstimatedInvoiceFromIntervalRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/api/initial-invoices-api.ts

@@ -35,7 +35,7 @@ const FormData = require('form-data');
 export const InitialInvoicesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.
+         * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the initial invoice
          * @param {CreateInvoiceForPolicyRequestDto} createInvoiceForPolicyRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -97,7 +97,7 @@ export const InitialInvoicesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = InitialInvoicesApiAxiosParamCreator(configuration)
     return {
         /**
-         * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.
+         * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the initial invoice
          * @param {CreateInvoiceForPolicyRequestDto} createInvoiceForPolicyRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -120,7 +120,7 @@ export const InitialInvoicesApiFactory = function (configuration?: Configuration
     const localVarFp = InitialInvoicesApiFp(configuration)
     return {
         /**
-         * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.
+         * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the initial invoice
          * @param {CreateInvoiceForPolicyRequestDto} createInvoiceForPolicyRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -170,7 +170,7 @@ export interface InitialInvoicesApiCreateInitialInvoiceRequest {
  */
 export class InitialInvoicesApi extends BaseAPI {
     /**
-     * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.
+     * This will create an initial invoice. It will be created once a policy is approved and it will cover a partial until the issuing of the regular invoice.  **Required Permissions**  \"billing-management.invoices.create\"
      * @summary Create the initial invoice
      * @param {InitialInvoicesApiCreateInitialInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/api/invoices-api.ts

@@ -41,7 +41,7 @@ const FormData = require('form-data');
 export const InvoicesApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * This will create invoice for a policy and save it in the DB.
+         * This will create invoice for a policy and save it in the DB.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the invoice
          * @param {CreateInvoiceRequestDto} createInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -93,7 +93,7 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * Gets an invoice.
+         * Gets an invoice.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary Retrieve the invoice
          * @param {string} code 
          * @param {string} expand 
@@ -145,16 +145,16 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * Returns a list of invoices you have previously created.          The invoices are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of invoices you have previously created.          The invoices are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary List invoices
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken=1,     your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
          * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
          * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
          * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       <i>Allowed values: statuses, payments<i>
-         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -221,7 +221,7 @@ export const InvoicesApiAxiosParamCreator = function (configuration?: Configurat
             };
         },
         /**
-         * Returns a list of policies billing dates you have previously created.          The policies billing dates are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of policies billing dates you have previously created.          The policies billing dates are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary List policies billing dates
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
@@ -308,7 +308,7 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = InvoicesApiAxiosParamCreator(configuration)
     return {
         /**
-         * This will create invoice for a policy and save it in the DB.
+         * This will create invoice for a policy and save it in the DB.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the invoice
          * @param {CreateInvoiceRequestDto} createInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -321,7 +321,7 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Gets an invoice.
+         * Gets an invoice.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary Retrieve the invoice
          * @param {string} code 
          * @param {string} expand 
@@ -334,16 +334,16 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Returns a list of invoices you have previously created.          The invoices are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of invoices you have previously created.          The invoices are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary List invoices
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken=1,     your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
          * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
          * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
          * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       <i>Allowed values: statuses, payments<i>
-         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -352,7 +352,7 @@ export const InvoicesApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Returns a list of policies billing dates you have previously created.          The policies billing dates are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of policies billing dates you have previously created.          The policies billing dates are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary List policies billing dates
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
@@ -381,7 +381,7 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
     const localVarFp = InvoicesApiFp(configuration)
     return {
         /**
-         * This will create invoice for a policy and save it in the DB.
+         * This will create invoice for a policy and save it in the DB.  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the invoice
          * @param {CreateInvoiceRequestDto} createInvoiceRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -393,7 +393,7 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
             return localVarFp.createInvoice(createInvoiceRequestDto, authorization, idempotencyKey, options).then((request) => request(axios, basePath));
         },
         /**
-         * Gets an invoice.
+         * Gets an invoice.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary Retrieve the invoice
          * @param {string} code 
          * @param {string} expand 
@@ -405,16 +405,16 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
             return localVarFp.getInvoice(code, expand, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of invoices you have previously created.          The invoices are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of invoices you have previously created.          The invoices are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary List invoices
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
          * @param {any} [pageToken] A cursor for use in pagination.     pageToken is an ID that defines your place in the list.     For instance, if you make a list request and receive 100 objects and pageToken=1,     your subsequent call can include pageToken=2 in order to fetch the next page of the list.
-         * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
+         * @param {string} [filter] Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
          * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
          * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: invoiceNumber, status, netAmount, grossAmount, createdAt, dueDate, id</i>
          * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.<br/>       <br/>       <i>Allowed values: statuses, payments<i>
-         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
+         * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -422,7 +422,7 @@ export const InvoicesApiFactory = function (configuration?: Configuration, baseP
             return localVarFp.listInvoices(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of policies billing dates you have previously created.          The policies billing dates are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of policies billing dates you have previously created.          The policies billing dates are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary List policies billing dates
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
@@ -526,7 +526,7 @@ export interface InvoicesApiListInvoicesRequest {
     readonly pageToken?: any
 
     /**
-     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/>           <br/>           <i>Allowed values: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
      * @type {string}
      * @memberof InvoicesApiListInvoices
      */
@@ -554,7 +554,7 @@ export interface InvoicesApiListInvoicesRequest {
     readonly expand?: string
 
     /**
-     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, policyCode, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.<br/>           <br/>           <i>Allowed values: code, policyCode, invoiceNumber, id, type, accountNumber, status, billingIntervalFrom, billingIntervalTo, createdAt</i>
      * @type {string}
      * @memberof InvoicesApiListInvoices
      */
@@ -632,7 +632,7 @@ export interface InvoicesApiListPoliciesBillingDatesRequest {
  */
 export class InvoicesApi extends BaseAPI {
     /**
-     * This will create invoice for a policy and save it in the DB.
+     * This will create invoice for a policy and save it in the DB.  **Required Permissions**  \"billing-management.invoices.create\"
      * @summary Create the invoice
      * @param {InvoicesApiCreateInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -644,7 +644,7 @@ export class InvoicesApi extends BaseAPI {
     }
 
     /**
-     * Gets an invoice.
+     * Gets an invoice.  **Required Permissions**  \"billing-management.invoices.view\"
      * @summary Retrieve the invoice
      * @param {InvoicesApiGetInvoiceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -656,7 +656,7 @@ export class InvoicesApi extends BaseAPI {
     }
 
     /**
-     * Returns a list of invoices you have previously created.          The invoices are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * Returns a list of invoices you have previously created.          The invoices are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
      * @summary List invoices
      * @param {InvoicesApiListInvoicesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -668,7 +668,7 @@ export class InvoicesApi extends BaseAPI {
     }
 
     /**
-     * Returns a list of policies billing dates you have previously created.          The policies billing dates are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * Returns a list of policies billing dates you have previously created.          The policies billing dates are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
      * @summary List policies billing dates
      * @param {InvoicesApiListPoliciesBillingDatesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/api/policy-billing-api.ts

@@ -39,7 +39,7 @@ const FormData = require('form-data');
 export const PolicyBillingApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * Create a new policy billing
+         * Create a new policy billing  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the Policy Billing
          * @param {CreatePolicyBillingRequestDto} createPolicyBillingRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -86,7 +86,7 @@ export const PolicyBillingApiAxiosParamCreator = function (configuration?: Confi
             };
         },
         /**
-         * Returns a list of policies billings you have previously created.          The policies billings are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of policies billings you have previously created.          The policies billings are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary List policies billings
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
@@ -162,7 +162,7 @@ export const PolicyBillingApiAxiosParamCreator = function (configuration?: Confi
             };
         },
         /**
-         * Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"billing-management.invoices.update\"
          * @summary Update the request message
          * @param {string} code Unique identifier for the object.
          * @param {UpdatePolicyBillingRequestDto} updatePolicyBillingRequestDto 
@@ -223,7 +223,7 @@ export const PolicyBillingApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = PolicyBillingApiAxiosParamCreator(configuration)
     return {
         /**
-         * Create a new policy billing
+         * Create a new policy billing  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the Policy Billing
          * @param {CreatePolicyBillingRequestDto} createPolicyBillingRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -235,7 +235,7 @@ export const PolicyBillingApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Returns a list of policies billings you have previously created.          The policies billings are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of policies billings you have previously created.          The policies billings are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary List policies billings
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
@@ -253,7 +253,7 @@ export const PolicyBillingApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"billing-management.invoices.update\"
          * @summary Update the request message
          * @param {string} code Unique identifier for the object.
          * @param {UpdatePolicyBillingRequestDto} updatePolicyBillingRequestDto 
@@ -276,7 +276,7 @@ export const PolicyBillingApiFactory = function (configuration?: Configuration,
     const localVarFp = PolicyBillingApiFp(configuration)
     return {
         /**
-         * Create a new policy billing
+         * Create a new policy billing  **Required Permissions**  \"billing-management.invoices.create\"
          * @summary Create the Policy Billing
          * @param {CreatePolicyBillingRequestDto} createPolicyBillingRequestDto 
          * @param {string} [authorization] Bearer Token
@@ -287,7 +287,7 @@ export const PolicyBillingApiFactory = function (configuration?: Configuration,
             return localVarFp.createPolicyBilling(createPolicyBillingRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * Returns a list of policies billings you have previously created.          The policies billings are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+         * Returns a list of policies billings you have previously created.          The policies billings are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
          * @summary List policies billings
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
@@ -304,7 +304,7 @@ export const PolicyBillingApiFactory = function (configuration?: Configuration,
             return localVarFp.listPoliciesBillings(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
         },
         /**
-         * Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+         * Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"billing-management.invoices.update\"
          * @summary Update the request message
          * @param {string} code Unique identifier for the object.
          * @param {UpdatePolicyBillingRequestDto} updatePolicyBillingRequestDto 
@@ -438,7 +438,7 @@ export interface PolicyBillingApiUpdatePolicyBillingRequest {
  */
 export class PolicyBillingApi extends BaseAPI {
     /**
-     * Create a new policy billing
+     * Create a new policy billing  **Required Permissions**  \"billing-management.invoices.create\"
      * @summary Create the Policy Billing
      * @param {PolicyBillingApiCreatePolicyBillingRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -450,7 +450,7 @@ export class PolicyBillingApi extends BaseAPI {
     }
 
     /**
-     * Returns a list of policies billings you have previously created.          The policies billings are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.
+     * Returns a list of policies billings you have previously created.          The policies billings are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"billing-management.invoices.view\"
      * @summary List policies billings
      * @param {PolicyBillingApiListPoliciesBillingsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -462,7 +462,7 @@ export class PolicyBillingApi extends BaseAPI {
     }
 
     /**
-     * Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * Updates the specified request message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"billing-management.invoices.update\"
      * @summary Update the request message
      * @param {PolicyBillingApiUpdatePolicyBillingRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.