@emilgroup/insurance-sdk-node 1.104.1-beta.11 → 1.104.1-beta.111

package/dist/api/policies-api.d.ts

@@ -50,7 +50,7 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
      */
     activatePolicy: (policyCode: string, activatePolicyRequestDto: ActivatePolicyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * This will create a draft policy in the database.  **Required Permissions**  \"policy-management.policies.create\"
+     * Creates a draft version of the policy update, without affecting the current version.       This adds a new version to the existing policy — it does not create a new policy. The draft is       returned with `isDraft: true` and `isCurrent: false`; the current version is unchanged until       the draft is approved via `PATCH .../draft` with `revisionStatus: APPROVED`.  **Required Permissions**  \"policy-management.policies.create\"
      * @summary Create the draft-policy
      * @param {string} policyCode Unique identifier for the object.
      * @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
@@ -78,11 +78,11 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
      */
     deleteDraftPolicy: (policyCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Retrieves the details of the draft-policy that was previously created. Supply the unique draft-policy code      that was returned when you created it and Emil Api will return the corresponding draft-policy information.  **Required Permissions**  \"policy-management.policies.view\"
+     * Retrieves the draft version of the policy, if one exists. The returned version has       `isDraft: true` and `isCurrent: false` — it is never the current/live version. Returns a       404 if no draft exists (e.g. after it has been approved or rejected).  **Required Permissions**  \"policy-management.policies.view\"
      * @summary Retrieve the draft-policy
      * @param {string} policyCode Unique identifier for the object.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} [expand] Fields to expand response by.
+     * @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for       example, \&quot;premiumItems\&quot; expands the draft premium items relation.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: version, timelines, premiums, premiumItems, premiumFormulas&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -109,16 +109,16 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
      */
     getPolicyDataByDate: (code: string, authorization?: string, timesliceDate?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of policies you have previously created.         The policies are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"policy-management.policies.view\"
+     * Returns a list of policies you have previously created.         The policies are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.<br/>         <br/>         <b>Notes on filtering:</b><br/>         - The `partnerCode` filter matches any policy that has ever had a link to that partner —         past, current, or future-dated — not only currently-assigned ones. There is currently no         separate filter to match only the currently-active link.<br/>         - An unrecognized filter field name is silently ignored: the request returns 200 with the         unfiltered (or partially filtered, if combined with valid fields) result set rather than         an error.  **Required Permissions**  \"policy-management.policies.view\"
      * @summary List policies
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @param {string} [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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
-     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
+     * @param {string} [search] Free-text search across the policy\&#39;s key fields: policy codes and numbers, holder, status,     product, account and lead codes, start date, and insured-object data (policyObjects.data).     Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance.      To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;holder:Müller or     search&#x3D;policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated     and case-sensitive.
      * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId&lt;/i&gt;
      * @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.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks&lt;i&gt;
-     * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -155,7 +155,7 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
      */
     listPolicyVersions: (policyCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Updates the specified draft-policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"policy-management.policies.update\"
+     * Updates the draft version, or changes its lifecycle state via `revisionStatus`       (see that field\'s description for what each value does — most notably, `APPROVED` promotes       the draft to the current policy version and `REJECTED` deletes it).  **Required Permissions**  \"policy-management.policies.update\"
      * @summary Update the draft-policy
      * @param {string} policyCode Unique identifier for the object.
      * @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
@@ -241,7 +241,7 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
      */
     activatePolicy(policyCode: string, activatePolicyRequestDto: ActivatePolicyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActivatePolicyResponseClass>>;
     /**
-     * This will create a draft policy in the database.  **Required Permissions**  \"policy-management.policies.create\"
+     * Creates a draft version of the policy update, without affecting the current version.       This adds a new version to the existing policy — it does not create a new policy. The draft is       returned with `isDraft: true` and `isCurrent: false`; the current version is unchanged until       the draft is approved via `PATCH .../draft` with `revisionStatus: APPROVED`.  **Required Permissions**  \"policy-management.policies.create\"
      * @summary Create the draft-policy
      * @param {string} policyCode Unique identifier for the object.
      * @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
@@ -269,11 +269,11 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
      */
     deleteDraftPolicy(policyCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
     /**
-     * Retrieves the details of the draft-policy that was previously created. Supply the unique draft-policy code      that was returned when you created it and Emil Api will return the corresponding draft-policy information.  **Required Permissions**  \"policy-management.policies.view\"
+     * Retrieves the draft version of the policy, if one exists. The returned version has       `isDraft: true` and `isCurrent: false` — it is never the current/live version. Returns a       404 if no draft exists (e.g. after it has been approved or rejected).  **Required Permissions**  \"policy-management.policies.view\"
      * @summary Retrieve the draft-policy
      * @param {string} policyCode Unique identifier for the object.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} [expand] Fields to expand response by.
+     * @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for       example, \&quot;premiumItems\&quot; expands the draft premium items relation.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: version, timelines, premiums, premiumItems, premiumFormulas&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -300,16 +300,16 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
      */
     getPolicyDataByDate(code: string, authorization?: string, timesliceDate?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyResponseClass>>;
     /**
-     * Returns a list of policies you have previously created.         The policies are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"policy-management.policies.view\"
+     * Returns a list of policies you have previously created.         The policies are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.<br/>         <br/>         <b>Notes on filtering:</b><br/>         - The `partnerCode` filter matches any policy that has ever had a link to that partner —         past, current, or future-dated — not only currently-assigned ones. There is currently no         separate filter to match only the currently-active link.<br/>         - An unrecognized filter field name is silently ignored: the request returns 200 with the         unfiltered (or partially filtered, if combined with valid fields) result set rather than         an error.  **Required Permissions**  \"policy-management.policies.view\"
      * @summary List policies
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @param {string} [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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
-     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
+     * @param {string} [search] Free-text search across the policy\&#39;s key fields: policy codes and numbers, holder, status,     product, account and lead codes, start date, and insured-object data (policyObjects.data).     Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance.      To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;holder:Müller or     search&#x3D;policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated     and case-sensitive.
      * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId&lt;/i&gt;
      * @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.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks&lt;i&gt;
-     * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -346,7 +346,7 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
      */
     listPolicyVersions(policyCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPolicyVersionResponseClass>>;
     /**
-     * Updates the specified draft-policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"policy-management.policies.update\"
+     * Updates the draft version, or changes its lifecycle state via `revisionStatus`       (see that field\'s description for what each value does — most notably, `APPROVED` promotes       the draft to the current policy version and `REJECTED` deletes it).  **Required Permissions**  \"policy-management.policies.update\"
      * @summary Update the draft-policy
      * @param {string} policyCode Unique identifier for the object.
      * @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
@@ -432,7 +432,7 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
      */
     activatePolicy(policyCode: string, activatePolicyRequestDto: ActivatePolicyRequestDto, authorization?: string, options?: any): AxiosPromise<ActivatePolicyResponseClass>;
     /**
-     * This will create a draft policy in the database.  **Required Permissions**  \"policy-management.policies.create\"
+     * Creates a draft version of the policy update, without affecting the current version.       This adds a new version to the existing policy — it does not create a new policy. The draft is       returned with `isDraft: true` and `isCurrent: false`; the current version is unchanged until       the draft is approved via `PATCH .../draft` with `revisionStatus: APPROVED`.  **Required Permissions**  \"policy-management.policies.create\"
      * @summary Create the draft-policy
      * @param {string} policyCode Unique identifier for the object.
      * @param {CreateDraftPolicyRequestDto} createDraftPolicyRequestDto
@@ -460,11 +460,11 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
      */
     deleteDraftPolicy(policyCode: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
     /**
-     * Retrieves the details of the draft-policy that was previously created. Supply the unique draft-policy code      that was returned when you created it and Emil Api will return the corresponding draft-policy information.  **Required Permissions**  \"policy-management.policies.view\"
+     * Retrieves the draft version of the policy, if one exists. The returned version has       `isDraft: true` and `isCurrent: false` — it is never the current/live version. Returns a       404 if no draft exists (e.g. after it has been approved or rejected).  **Required Permissions**  \"policy-management.policies.view\"
      * @summary Retrieve the draft-policy
      * @param {string} policyCode Unique identifier for the object.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {string} [expand] Fields to expand response by.
+     * @param {string} [expand] Fields to expand in the draft response. Pass the unprefixed relation name; for       example, \&quot;premiumItems\&quot; expands the draft premium items relation.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: version, timelines, premiums, premiumItems, premiumFormulas&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -491,16 +491,16 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
      */
     getPolicyDataByDate(code: string, authorization?: string, timesliceDate?: string, expand?: string, options?: any): AxiosPromise<GetPolicyResponseClass>;
     /**
-     * Returns a list of policies you have previously created.         The policies are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"policy-management.policies.view\"
+     * Returns a list of policies you have previously created.         The policies are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.<br/>         <br/>         <b>Notes on filtering:</b><br/>         - The `partnerCode` filter matches any policy that has ever had a link to that partner —         past, current, or future-dated — not only currently-assigned ones. There is currently no         separate filter to match only the currently-active link.<br/>         - An unrecognized filter field name is silently ignored: the request returns 200 with the         unfiltered (or partially filtered, if combined with valid fields) result set rather than         an error.  **Required Permissions**  \"policy-management.policies.view\"
      * @summary List policies
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @param {string} [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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
-     * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {string} [filter] Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
+     * @param {string} [search] Free-text search across the policy\&#39;s key fields: policy codes and numbers, holder, status,     product, account and lead codes, start date, and insured-object data (policyObjects.data).     Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance.      To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;holder:Müller or     search&#x3D;policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated     and case-sensitive.
      * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, policyNumber, createdAt, updatedAt, policyStartDate, productVersionId, productId&lt;/i&gt;
      * @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.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: versions, product, timelines, premiums, premiumItems, premiumFormulas, currentVersion, currentTimelines, currentPremiums, currentPremiumItems, currentPremiumFormulas, partnerLinks&lt;i&gt;
-     * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -537,7 +537,7 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
      */
     listPolicyVersions(policyCode: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPolicyVersionResponseClass>;
     /**
-     * Updates the specified draft-policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"policy-management.policies.update\"
+     * Updates the draft version, or changes its lifecycle state via `revisionStatus`       (see that field\'s description for what each value does — most notably, `APPROVED` promotes       the draft to the current policy version and `REJECTED` deletes it).  **Required Permissions**  \"policy-management.policies.update\"
      * @summary Update the draft-policy
      * @param {string} policyCode Unique identifier for the object.
      * @param {PatchDraftPolicyRequestDto} patchDraftPolicyRequestDto
@@ -714,7 +714,7 @@ export interface PoliciesApiGetDraftPolicyRequest {
      */
     readonly authorization?: string;
     /**
-     * Fields to expand response by.
+     * Fields to expand in the draft response. Pass the unprefixed relation name; for       example, \&quot;premiumItems\&quot; expands the draft premium items relation.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: version, timelines, premiums, premiumItems, premiumFormulas&lt;/i&gt;
      * @type {string}
      * @memberof PoliciesApiGetDraftPolicy
      */
@@ -801,13 +801,13 @@ export interface PoliciesApiListPoliciesRequest {
      */
     readonly pageToken?: string;
     /**
-     * Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
+     * Filter the response by one or multiple fields.             In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;             &lt;br/&gt;             &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
      * @type {string}
      * @memberof PoliciesApiListPolicies
      */
     readonly filter?: string;
     /**
-     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * Free-text search across the policy\&#39;s key fields: policy codes and numbers, holder, status,     product, account and lead codes, start date, and insured-object data (policyObjects.data).     Matching is case- and accent-insensitive (mueller finds Müller), tolerates typos, and ranks results by relevance.      To search a single field, pass search&#x3D;path:value — e.g. search&#x3D;holder:Müller or     search&#x3D;policyObjects.data.postalCode:10115. The value matches exactly or as a prefix; paths are dot-separated     and case-sensitive.
      * @type {string}
      * @memberof PoliciesApiListPolicies
      */
@@ -825,7 +825,7 @@ export interface PoliciesApiListPoliciesRequest {
      */
     readonly expand?: string;
     /**
-     * Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode&lt;/i&gt;
+     * Filters the response by one or multiple fields.           Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, leadCode, policyNumber, holder, policyStartDate, productSlug, productVersionId, productId, accountCode, productName, status, statuses, createdAt, policyData, partnerCode, partnerLinks.partnerCode&lt;/i&gt;
      * @type {string}
      * @memberof PoliciesApiListPolicies
      */
@@ -1137,16 +1137,16 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    activatePolicy(requestParameters: PoliciesApiActivatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivatePolicyResponseClass, any, {}>>;
+    activatePolicy(requestParameters: PoliciesApiActivatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ActivatePolicyResponseClass, any, {}, any>>;
     /**
-     * This will create a draft policy in the database.  **Required Permissions**  \"policy-management.policies.create\"
+     * Creates a draft version of the policy update, without affecting the current version.       This adds a new version to the existing policy — it does not create a new policy. The draft is       returned with `isDraft: true` and `isCurrent: false`; the current version is unchanged until       the draft is approved via `PATCH .../draft` with `revisionStatus: APPROVED`.  **Required Permissions**  \"policy-management.policies.create\"
      * @summary Create the draft-policy
      * @param {PoliciesApiCreateDraftPolicyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    createDraftPolicy(requestParameters: PoliciesApiCreateDraftPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyResponseClass, any, {}>>;
+    createDraftPolicy(requestParameters: PoliciesApiCreateDraftPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyResponseClass, any, {}, any>>;
     /**
      * This will create a policy in the database. Policy creation is usually part     of a complex workflow that starts with lead creation. Creating directly a policy without prior knowledge     might result in an unusable policy. Look into lead creation for more information.  **Required Permissions**  \"policy-management.policies.create\"
      * @summary Create the policy
@@ -1155,7 +1155,7 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    createPolicy(requestParameters: PoliciesApiCreatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyResponseClass, any, {}>>;
+    createPolicy(requestParameters: PoliciesApiCreatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyResponseClass, any, {}, any>>;
     /**
      * Permanently deletes the draft-policy. Supply the unique code that was returned when you created the draft-policy and this will delete it.  **Required Permissions**  \"policy-management.policies.delete\"
      * @summary Delete the draft-policy
@@ -1164,16 +1164,16 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    deleteDraftPolicy(requestParameters: PoliciesApiDeleteDraftPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}>>;
+    deleteDraftPolicy(requestParameters: PoliciesApiDeleteDraftPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any, {}, any>>;
     /**
-     * Retrieves the details of the draft-policy that was previously created. Supply the unique draft-policy code      that was returned when you created it and Emil Api will return the corresponding draft-policy information.  **Required Permissions**  \"policy-management.policies.view\"
+     * Retrieves the draft version of the policy, if one exists. The returned version has       `isDraft: true` and `isCurrent: false` — it is never the current/live version. Returns a       404 if no draft exists (e.g. after it has been approved or rejected).  **Required Permissions**  \"policy-management.policies.view\"
      * @summary Retrieve the draft-policy
      * @param {PoliciesApiGetDraftPolicyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    getDraftPolicy(requestParameters: PoliciesApiGetDraftPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyResponseClass, any, {}>>;
+    getDraftPolicy(requestParameters: PoliciesApiGetDraftPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyResponseClass, any, {}, any>>;
     /**
      * Retrieves the details of the policy that was previously created. Supply the unique policy code      that was returned when you created it and Emil Api will return the corresponding policy information.  **Required Permissions**  \"policy-management.policies.view\"
      * @summary Retrieve the policy
@@ -1182,7 +1182,7 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    getPolicy(requestParameters: PoliciesApiGetPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyResponseClass, any, {}>>;
+    getPolicy(requestParameters: PoliciesApiGetPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyResponseClass, any, {}, any>>;
     /**
      * This endpoint will return the current version of the policy. It is possible to filter the       response by a specific date and the system will return the valid data that was (or will be) at the       provided date.  **Required Permissions**  \"policy-management.policies.view\"
      * @summary Retrieve current policy version
@@ -1191,16 +1191,16 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    getPolicyDataByDate(requestParameters: PoliciesApiGetPolicyDataByDateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyResponseClass, any, {}>>;
+    getPolicyDataByDate(requestParameters: PoliciesApiGetPolicyDataByDateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyResponseClass, any, {}, any>>;
     /**
-     * Returns a list of policies you have previously created.         The policies are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"policy-management.policies.view\"
+     * Returns a list of policies you have previously created.         The policies are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.<br/>         <br/>         <b>Notes on filtering:</b><br/>         - The `partnerCode` filter matches any policy that has ever had a link to that partner —         past, current, or future-dated — not only currently-assigned ones. There is currently no         separate filter to match only the currently-active link.<br/>         - An unrecognized filter field name is silently ignored: the request returns 200 with the         unfiltered (or partially filtered, if combined with valid fields) result set rather than         an error.  **Required Permissions**  \"policy-management.policies.view\"
      * @summary List policies
      * @param {PoliciesApiListPoliciesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    listPolicies(requestParameters?: PoliciesApiListPoliciesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPoliciesResponseClass, any, {}>>;
+    listPolicies(requestParameters?: PoliciesApiListPoliciesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPoliciesResponseClass, any, {}, any>>;
     /**
      * Returns a list of policy objects you have previously created.         The policy objects are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"policy-management.policies.view\"
      * @summary List policy objects
@@ -1209,7 +1209,7 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    listPolicyObjects(requestParameters?: PoliciesApiListPolicyObjectsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPolicyObjectsResponseClass, any, {}>>;
+    listPolicyObjects(requestParameters?: PoliciesApiListPolicyObjectsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPolicyObjectsResponseClass, any, {}, any>>;
     /**
      * Returns a list of policy versions you have previously created.         The policy versions are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"policy-management.policies.view\"
      * @summary List policy versions
@@ -1218,16 +1218,16 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    listPolicyVersions(requestParameters: PoliciesApiListPolicyVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPolicyVersionResponseClass, any, {}>>;
+    listPolicyVersions(requestParameters: PoliciesApiListPolicyVersionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPolicyVersionResponseClass, any, {}, any>>;
     /**
-     * Updates the specified draft-policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"policy-management.policies.update\"
+     * Updates the draft version, or changes its lifecycle state via `revisionStatus`       (see that field\'s description for what each value does — most notably, `APPROVED` promotes       the draft to the current policy version and `REJECTED` deletes it).  **Required Permissions**  \"policy-management.policies.update\"
      * @summary Update the draft-policy
      * @param {PoliciesApiPatchDraftPolicyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    patchDraftPolicy(requestParameters: PoliciesApiPatchDraftPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchPolicyResponseClass, any, {}>>;
+    patchDraftPolicy(requestParameters: PoliciesApiPatchDraftPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchPolicyResponseClass, any, {}, any>>;
     /**
      * Updates the specified policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"policy-management.policies.update\"
      * @summary Update the policy
@@ -1236,7 +1236,7 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    patchPolicy(requestParameters: PoliciesApiPatchPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchPolicyResponseClass, any, {}>>;
+    patchPolicy(requestParameters: PoliciesApiPatchPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PatchPolicyResponseClass, any, {}, any>>;
     /**
      * Request to restore an existing policy version by versionId.  **Required Permissions**  \"policy-management.policies.update\"
      * @summary Restore a policy version by versionId
@@ -1245,7 +1245,7 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    restorePolicyVersion(requestParameters: PoliciesApiRestorePolicyVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestorePolicyVersionResponseClass, any, {}>>;
+    restorePolicyVersion(requestParameters: PoliciesApiRestorePolicyVersionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestorePolicyVersionResponseClass, any, {}, any>>;
     /**
      * Request to suspend an existing policy by tenant.  **Required Permissions**  \"policy-management.policies.update\"
      * @summary Suspend a policy by tenant
@@ -1254,7 +1254,7 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    suspendPolicy(requestParameters: PoliciesApiSuspendPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuspendPolicyResponseClass, any, {}>>;
+    suspendPolicy(requestParameters: PoliciesApiSuspendPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuspendPolicyResponseClass, any, {}, any>>;
     /**
      * Request to terminate an existing policy by tenant.  **Required Permissions**  \"policy-management.policies.update\"
      * @summary Terminate a policy by tenant
@@ -1263,7 +1263,7 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    terminatePolicy(requestParameters: PoliciesApiTerminatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminatePolicyResponseClass, any, {}>>;
+    terminatePolicy(requestParameters: PoliciesApiTerminatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminatePolicyResponseClass, any, {}, any>>;
     /**
      * Updates the specified policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.  **Required Permissions**  \"policy-management.policies.update\"
      * @summary Update the policy
@@ -1272,7 +1272,7 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    updatePolicy(requestParameters: PoliciesApiUpdatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePolicyResponseClass, any, {}>>;
+    updatePolicy(requestParameters: PoliciesApiUpdatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePolicyResponseClass, any, {}, any>>;
     /**
      * Withdraw policy by tenant.  **Required Permissions**  \"policy-management.policies.update\"
      * @summary Withdraw policy by tenant
@@ -1281,5 +1281,5 @@ export declare class PoliciesApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof PoliciesApi
      */
-    withdrawPolicy(requestParameters: PoliciesApiWithdrawPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WithdrawPolicyResponseClass, any, {}>>;
+    withdrawPolicy(requestParameters: PoliciesApiWithdrawPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WithdrawPolicyResponseClass, any, {}, any>>;
 }