@emilgroup/insurance-sdk-node 1.0.0

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

@@ -0,0 +1,329 @@
+/**
+ * EMIL InsuranceService
+ * The EMIL InsuranceService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreatePolicyRequestDto } from '../models';
+import { CreatePolicyResponseClass } from '../models';
+import { GetPolicyResponseClass } from '../models';
+import { ListPoliciesResponseClass } from '../models';
+import { UpdatePolicyRequestDto } from '../models';
+import { UpdatePolicyResponseClass } from '../models';
+/**
+ * PoliciesApi - axios parameter creator
+ * @export
+ */
+export declare const PoliciesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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.
+     * @summary Create the policy
+     * @param {CreatePolicyRequestDto} createPolicyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPolicy: (createPolicyRequestDto: CreatePolicyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPolicy: (code: string, authorization?: 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.
+     * @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 {string} [filter] List filter
+     * @param {string} [search] Search query
+     * @param {string} [order] Ordering criteria
+     * @param {string} [expand] Extra fields to fetch
+     * @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>;
+    /**
+     * Updates the specified policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the policy
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePolicyRequestDto} updatePolicyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePolicy: (code: string, updatePolicyRequestDto: UpdatePolicyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PoliciesApi - functional programming interface
+ * @export
+ */
+export declare const PoliciesApiFp: (configuration?: Configuration) => {
+    /**
+     * 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.
+     * @summary Create the policy
+     * @param {CreatePolicyRequestDto} createPolicyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPolicy(createPolicyRequestDto: CreatePolicyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePolicyResponseClass>>;
+    /**
+     * 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.
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPolicy(code: string, authorization?: 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.
+     * @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 {string} [filter] List filter
+     * @param {string} [search] Search query
+     * @param {string} [order] Ordering criteria
+     * @param {string} [expand] Extra fields to fetch
+     * @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>>;
+    /**
+     * Updates the specified policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the policy
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePolicyRequestDto} updatePolicyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePolicy(code: string, updatePolicyRequestDto: UpdatePolicyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePolicyResponseClass>>;
+};
+/**
+ * PoliciesApi - factory interface
+ * @export
+ */
+export declare const PoliciesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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.
+     * @summary Create the policy
+     * @param {CreatePolicyRequestDto} createPolicyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPolicy(createPolicyRequestDto: CreatePolicyRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePolicyResponseClass>;
+    /**
+     * 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.
+     * @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 {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPolicy(code: string, authorization?: 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.
+     * @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 {string} [filter] List filter
+     * @param {string} [search] Search query
+     * @param {string} [order] Ordering criteria
+     * @param {string} [expand] Extra fields to fetch
+     * @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>;
+    /**
+     * Updates the specified policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the policy
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePolicyRequestDto} updatePolicyRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePolicy(code: string, updatePolicyRequestDto: UpdatePolicyRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePolicyResponseClass>;
+};
+/**
+ * Request parameters for createPolicy operation in PoliciesApi.
+ * @export
+ * @interface PoliciesApiCreatePolicyRequest
+ */
+export interface PoliciesApiCreatePolicyRequest {
+    /**
+     *
+     * @type {CreatePolicyRequestDto}
+     * @memberof PoliciesApiCreatePolicy
+     */
+    readonly createPolicyRequestDto: CreatePolicyRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PoliciesApiCreatePolicy
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPolicy operation in PoliciesApi.
+ * @export
+ * @interface PoliciesApiGetPolicyRequest
+ */
+export interface PoliciesApiGetPolicyRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PoliciesApiGetPolicy
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PoliciesApiGetPolicy
+     */
+    readonly authorization?: string;
+    /**
+     * Fields to expand response by
+     * @type {string}
+     * @memberof PoliciesApiGetPolicy
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listPolicies operation in PoliciesApi.
+ * @export
+ * @interface PoliciesApiListPoliciesRequest
+ */
+export interface PoliciesApiListPoliciesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PoliciesApiListPolicies
+     */
+    readonly authorization?: string;
+    /**
+     * Page size
+     * @type {number}
+     * @memberof PoliciesApiListPolicies
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token
+     * @type {string}
+     * @memberof PoliciesApiListPolicies
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {string}
+     * @memberof PoliciesApiListPolicies
+     */
+    readonly filter?: string;
+    /**
+     * Search query
+     * @type {string}
+     * @memberof PoliciesApiListPolicies
+     */
+    readonly search?: string;
+    /**
+     * Ordering criteria
+     * @type {string}
+     * @memberof PoliciesApiListPolicies
+     */
+    readonly order?: string;
+    /**
+     * Extra fields to fetch
+     * @type {string}
+     * @memberof PoliciesApiListPolicies
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for updatePolicy operation in PoliciesApi.
+ * @export
+ * @interface PoliciesApiUpdatePolicyRequest
+ */
+export interface PoliciesApiUpdatePolicyRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PoliciesApiUpdatePolicy
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdatePolicyRequestDto}
+     * @memberof PoliciesApiUpdatePolicy
+     */
+    readonly updatePolicyRequestDto: UpdatePolicyRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PoliciesApiUpdatePolicy
+     */
+    readonly authorization?: string;
+}
+/**
+ * PoliciesApi - object-oriented interface
+ * @export
+ * @class PoliciesApi
+ * @extends {BaseAPI}
+ */
+export declare class PoliciesApi extends BaseAPI {
+    /**
+     * 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.
+     * @summary Create the policy
+     * @param {PoliciesApiCreatePolicyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PoliciesApi
+     */
+    createPolicy(requestParameters: PoliciesApiCreatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyResponseClass, 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.
+     * @summary Retrieve the policy
+     * @param {PoliciesApiGetPolicyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PoliciesApi
+     */
+    getPolicy(requestParameters: PoliciesApiGetPolicyRequest, 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
+     * @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>>;
+    /**
+     * Updates the specified policy by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the policy
+     * @param {PoliciesApiUpdatePolicyRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PoliciesApi
+     */
+    updatePolicy(requestParameters: PoliciesApiUpdatePolicyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePolicyResponseClass, any>>;
+}