@emilgroup/insurance-sdk-node 1.2.0 → 1.5.0

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

@@ -3,7 +3,7 @@
  * The EMIL InsuranceService API description
  *
  * The version of the OpenAPI document: 1.0
- *
+ * Contact: kontakt@emil.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -16,6 +16,8 @@ import { CreatePolicyRequestDto } from '../models';
 import { CreatePolicyResponseClass } from '../models';
 import { GetPolicyResponseClass } from '../models';
 import { ListPoliciesResponseClass } from '../models';
+import { SuspendPolicyRequestDto } from '../models';
+import { SuspendPolicyResponseClass } from '../models';
 import { TerminatePolicyRequestDto } from '../models';
 import { TerminatePolicyResponseClass } from '../models';
 import { UpdatePolicyRequestDto } from '../models';
@@ -40,29 +42,49 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
      * @summary Retrieve the policy
      * @param {string} code 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 response by.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getPolicy: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Retrieve the policy
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [timesliceDate] This date is used to filter data of the policy, to select the appropriate timeslice.       If no date is specified, the system returns all the timeslices available.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPolicyDataByDate: (code: string, authorization?: string, timesliceDate?: 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.
      * @summary List policies
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {number} [pageSize] Page size
-     * @param {string} [pageToken] Page token
+     * @param {number} [pageSize] Page size.
+     * @param {string} [pageToken] Page token.
      * @param {string} [filter] List filter
-     * @param {string} [search] Search query
-     * @param {string} [order] Ordering criteria
-     * @param {string} [expand] Extra fields to fetch
+     * @param {string} [search] Search query.
+     * @param {string} [order] Ordering criteria.
+     * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listPolicies: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Request to terminate an existing policy by tenant
+     * Request to suspend an existing policy by tenant.
+     * @summary Suspend a policy by tenant
+     * @param {string} policyCode The policy code.
+     * @param {SuspendPolicyRequestDto} suspendPolicyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    suspendPolicy: (policyCode: string, suspendPolicyRequestDto: SuspendPolicyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Request to terminate an existing policy by tenant.
      * @summary Terminate a policy by tenant
-     * @param {string} policyCode The policy code
+     * @param {string} policyCode The policy code.
      * @param {TerminatePolicyRequestDto} terminatePolicyRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
@@ -80,9 +102,9 @@ export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuratio
      */
     updatePolicy: (code: string, updatePolicyRequestDto: UpdatePolicyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Withdraw policy by tenant
+     * Withdraw policy by tenant.
      * @summary Withdraw policy by tenant
-     * @param {string} policyCode The policy code
+     * @param {string} policyCode The policy code.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -108,29 +130,49 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
      * @summary Retrieve the policy
      * @param {string} code 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 response by.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getPolicy(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyResponseClass>>;
+    /**
+     * 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.
+     * @summary Retrieve the policy
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [timesliceDate] This date is used to filter data of the policy, to select the appropriate timeslice.       If no date is specified, the system returns all the timeslices available.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPolicyDataByDate(code: string, authorization?: string, timesliceDate?: 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.
      * @summary List policies
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {number} [pageSize] Page size
-     * @param {string} [pageToken] Page token
+     * @param {number} [pageSize] Page size.
+     * @param {string} [pageToken] Page token.
      * @param {string} [filter] List filter
-     * @param {string} [search] Search query
-     * @param {string} [order] Ordering criteria
-     * @param {string} [expand] Extra fields to fetch
+     * @param {string} [search] Search query.
+     * @param {string} [order] Ordering criteria.
+     * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPoliciesResponseClass>>;
     /**
-     * Request to terminate an existing policy by tenant
+     * Request to suspend an existing policy by tenant.
+     * @summary Suspend a policy by tenant
+     * @param {string} policyCode The policy code.
+     * @param {SuspendPolicyRequestDto} suspendPolicyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    suspendPolicy(policyCode: string, suspendPolicyRequestDto: SuspendPolicyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SuspendPolicyResponseClass>>;
+    /**
+     * Request to terminate an existing policy by tenant.
      * @summary Terminate a policy by tenant
-     * @param {string} policyCode The policy code
+     * @param {string} policyCode The policy code.
      * @param {TerminatePolicyRequestDto} terminatePolicyRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
@@ -148,9 +190,9 @@ export declare const PoliciesApiFp: (configuration?: Configuration) => {
      */
     updatePolicy(code: string, updatePolicyRequestDto: UpdatePolicyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePolicyResponseClass>>;
     /**
-     * Withdraw policy by tenant
+     * Withdraw policy by tenant.
      * @summary Withdraw policy by tenant
-     * @param {string} policyCode The policy code
+     * @param {string} policyCode The policy code.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -176,29 +218,49 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
      * @summary Retrieve the policy
      * @param {string} code 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 response by.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     getPolicy(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetPolicyResponseClass>;
+    /**
+     * 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.
+     * @summary Retrieve the policy
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {string} [timesliceDate] This date is used to filter data of the policy, to select the appropriate timeslice.       If no date is specified, the system returns all the timeslices available.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPolicyDataByDate(code: string, authorization?: string, timesliceDate?: 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.
      * @summary List policies
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
-     * @param {number} [pageSize] Page size
-     * @param {string} [pageToken] Page token
+     * @param {number} [pageSize] Page size.
+     * @param {string} [pageToken] Page token.
      * @param {string} [filter] List filter
-     * @param {string} [search] Search query
-     * @param {string} [order] Ordering criteria
-     * @param {string} [expand] Extra fields to fetch
+     * @param {string} [search] Search query.
+     * @param {string} [order] Ordering criteria.
+     * @param {string} [expand] You can expand policy versions list in this endpoint. By default, versions will be an empty array.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     listPolicies(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListPoliciesResponseClass>;
     /**
-     * Request to terminate an existing policy by tenant
+     * Request to suspend an existing policy by tenant.
+     * @summary Suspend a policy by tenant
+     * @param {string} policyCode The policy code.
+     * @param {SuspendPolicyRequestDto} suspendPolicyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    suspendPolicy(policyCode: string, suspendPolicyRequestDto: SuspendPolicyRequestDto, authorization?: string, options?: any): AxiosPromise<SuspendPolicyResponseClass>;
+    /**
+     * Request to terminate an existing policy by tenant.
      * @summary Terminate a policy by tenant
-     * @param {string} policyCode The policy code
+     * @param {string} policyCode The policy code.
      * @param {TerminatePolicyRequestDto} terminatePolicyRequestDto
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
@@ -216,9 +278,9 @@ export declare const PoliciesApiFactory: (configuration?: Configuration, basePat
      */
     updatePolicy(code: string, updatePolicyRequestDto: UpdatePolicyRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePolicyResponseClass>;
     /**
-     * Withdraw policy by tenant
+     * Withdraw policy by tenant.
      * @summary Withdraw policy by tenant
-     * @param {string} policyCode The policy code
+     * @param {string} policyCode The policy code.
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -263,12 +325,37 @@ export interface PoliciesApiGetPolicyRequest {
      */
     readonly authorization?: string;
     /**
-     * Fields to expand response by
+     * Fields to expand response by.
      * @type {string}
      * @memberof PoliciesApiGetPolicy
      */
     readonly expand?: string;
 }
+/**
+ * Request parameters for getPolicyDataByDate operation in PoliciesApi.
+ * @export
+ * @interface PoliciesApiGetPolicyDataByDateRequest
+ */
+export interface PoliciesApiGetPolicyDataByDateRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PoliciesApiGetPolicyDataByDate
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PoliciesApiGetPolicyDataByDate
+     */
+    readonly authorization?: string;
+    /**
+     * This date is used to filter data of the policy, to select the appropriate timeslice.       If no date is specified, the system returns all the timeslices available.
+     * @type {string}
+     * @memberof PoliciesApiGetPolicyDataByDate
+     */
+    readonly timesliceDate?: string;
+}
 /**
  * Request parameters for listPolicies operation in PoliciesApi.
  * @export
@@ -282,13 +369,13 @@ export interface PoliciesApiListPoliciesRequest {
      */
     readonly authorization?: string;
     /**
-     * Page size
+     * Page size.
      * @type {number}
      * @memberof PoliciesApiListPolicies
      */
     readonly pageSize?: number;
     /**
-     * Page token
+     * Page token.
      * @type {string}
      * @memberof PoliciesApiListPolicies
      */
@@ -300,24 +387,49 @@ export interface PoliciesApiListPoliciesRequest {
      */
     readonly filter?: string;
     /**
-     * Search query
+     * Search query.
      * @type {string}
      * @memberof PoliciesApiListPolicies
      */
     readonly search?: string;
     /**
-     * Ordering criteria
+     * Ordering criteria.
      * @type {string}
      * @memberof PoliciesApiListPolicies
      */
     readonly order?: string;
     /**
-     * Extra fields to fetch
+     * You can expand policy versions list in this endpoint. By default, versions will be an empty array.
      * @type {string}
      * @memberof PoliciesApiListPolicies
      */
     readonly expand?: string;
 }
+/**
+ * Request parameters for suspendPolicy operation in PoliciesApi.
+ * @export
+ * @interface PoliciesApiSuspendPolicyRequest
+ */
+export interface PoliciesApiSuspendPolicyRequest {
+    /**
+     * The policy code.
+     * @type {string}
+     * @memberof PoliciesApiSuspendPolicy
+     */
+    readonly policyCode: string;
+    /**
+     *
+     * @type {SuspendPolicyRequestDto}
+     * @memberof PoliciesApiSuspendPolicy
+     */
+    readonly suspendPolicyRequestDto: SuspendPolicyRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PoliciesApiSuspendPolicy
+     */
+    readonly authorization?: string;
+}
 /**
  * Request parameters for terminatePolicy operation in PoliciesApi.
  * @export
@@ -325,7 +437,7 @@ export interface PoliciesApiListPoliciesRequest {
  */
 export interface PoliciesApiTerminatePolicyRequest {
     /**
-     * The policy code
+     * The policy code.
      * @type {string}
      * @memberof PoliciesApiTerminatePolicy
      */
@@ -375,7 +487,7 @@ export interface PoliciesApiUpdatePolicyRequest {
  */
 export interface PoliciesApiWithdrawPolicyRequest {
     /**
-     * The policy code
+     * The policy code.
      * @type {string}
      * @memberof PoliciesApiWithdrawPolicy
      */
@@ -412,6 +524,15 @@ export declare class PoliciesApi extends BaseAPI {
      * @memberof PoliciesApi
      */
     getPolicy(requestParameters: PoliciesApiGetPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyResponseClass, 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.
+     * @summary Retrieve the policy
+     * @param {PoliciesApiGetPolicyDataByDateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PoliciesApi
+     */
+    getPolicyDataByDate(requestParameters: PoliciesApiGetPolicyDataByDateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyResponseClass, 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.
      * @summary List policies
@@ -422,7 +543,16 @@ export declare class PoliciesApi extends BaseAPI {
      */
     listPolicies(requestParameters?: PoliciesApiListPoliciesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPoliciesResponseClass, any>>;
     /**
-     * Request to terminate an existing policy by tenant
+     * Request to suspend an existing policy by tenant.
+     * @summary Suspend a policy by tenant
+     * @param {PoliciesApiSuspendPolicyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PoliciesApi
+     */
+    suspendPolicy(requestParameters: PoliciesApiSuspendPolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SuspendPolicyResponseClass, any>>;
+    /**
+     * Request to terminate an existing policy by tenant.
      * @summary Terminate a policy by tenant
      * @param {PoliciesApiTerminatePolicyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -440,7 +570,7 @@ export declare class PoliciesApi extends BaseAPI {
      */
     updatePolicy(requestParameters: PoliciesApiUpdatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePolicyResponseClass, any>>;
     /**
-     * Withdraw policy by tenant
+     * Withdraw policy by tenant.
      * @summary Withdraw policy by tenant
      * @param {PoliciesApiWithdrawPolicyRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.