@emilgroup/insurance-sdk-node 1.48.1-beta.2 → 1.49.0

package/dist/api/policy-partner-roles-api.d.ts

@@ -0,0 +1,385 @@
+/**
+ * EMIL InsuranceService
+ * 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
+ * Do not edit the class manually.
+ */
+import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+import { RequestArgs, BaseAPI } from '../base';
+import { CreatePolicyPartnerRoleRequestDto } from '../models';
+import { CreatePolicyPartnerRoleResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetPolicyPartnerRoleResponseClass } from '../models';
+import { ListPolicyPartnerRolesResponseClass } from '../models';
+import { UpdatePolicyPartnerRoleRequestDto } from '../models';
+import { UpdatePolicyPartnerRoleResponseClass } from '../models';
+/**
+ * PolicyPartnerRolesApi - axios parameter creator
+ * @export
+ */
+export declare const PolicyPartnerRolesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a policy partner role.
+     * @summary Create the policy partner role
+     * @param {CreatePolicyPartnerRoleRequestDto} createPolicyPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPolicyPartnerRole: (createPolicyPartnerRoleRequestDto: CreatePolicyPartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the policy partner role. Supply the unique code that was returned when you created the policy partner role and this will delete it.
+     * @summary Delete the policy partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePolicyPartnerRole: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the policy partner role that was previously created. Supply the unique policy partner role code that was returned when you created it and Emil Api will return the corresponding policy partner role information.
+     * @summary Retrieve the policy partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPolicyPartnerRole: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of policy partner roles you have previously created. The policy partner roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List policy partner roles
+     * @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 {'name' | 'productSlug'} [filter] List filter
+     * @param {'name' | 'productSlug'} [search] Search query.
+     * @param {'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt'} [order] Ordering criteria.
+     * @param {number} [expand] This entity has no expand parameters
+     * @param {string} [filters]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPolicyPartnerRole: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'name' | 'productSlug', search?: 'name' | 'productSlug', order?: 'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt', expand?: number, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified policy partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the policy partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePolicyPartnerRoleRequestDto} updatePolicyPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePolicyPartnerRole: (code: string, updatePolicyPartnerRoleRequestDto: UpdatePolicyPartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PolicyPartnerRolesApi - functional programming interface
+ * @export
+ */
+export declare const PolicyPartnerRolesApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a policy partner role.
+     * @summary Create the policy partner role
+     * @param {CreatePolicyPartnerRoleRequestDto} createPolicyPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPolicyPartnerRole(createPolicyPartnerRoleRequestDto: CreatePolicyPartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePolicyPartnerRoleResponseClass>>;
+    /**
+     * Permanently deletes the policy partner role. Supply the unique code that was returned when you created the policy partner role and this will delete it.
+     * @summary Delete the policy partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePolicyPartnerRole(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the policy partner role that was previously created. Supply the unique policy partner role code that was returned when you created it and Emil Api will return the corresponding policy partner role information.
+     * @summary Retrieve the policy partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPolicyPartnerRole(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPolicyPartnerRoleResponseClass>>;
+    /**
+     * Returns a list of policy partner roles you have previously created. The policy partner roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List policy partner roles
+     * @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 {'name' | 'productSlug'} [filter] List filter
+     * @param {'name' | 'productSlug'} [search] Search query.
+     * @param {'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt'} [order] Ordering criteria.
+     * @param {number} [expand] This entity has no expand parameters
+     * @param {string} [filters]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPolicyPartnerRole(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'name' | 'productSlug', search?: 'name' | 'productSlug', order?: 'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt', expand?: number, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPolicyPartnerRolesResponseClass>>;
+    /**
+     * Updates the specified policy partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the policy partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePolicyPartnerRoleRequestDto} updatePolicyPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePolicyPartnerRole(code: string, updatePolicyPartnerRoleRequestDto: UpdatePolicyPartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePolicyPartnerRoleResponseClass>>;
+};
+/**
+ * PolicyPartnerRolesApi - factory interface
+ * @export
+ */
+export declare const PolicyPartnerRolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a policy partner role.
+     * @summary Create the policy partner role
+     * @param {CreatePolicyPartnerRoleRequestDto} createPolicyPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPolicyPartnerRole(createPolicyPartnerRoleRequestDto: CreatePolicyPartnerRoleRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePolicyPartnerRoleResponseClass>;
+    /**
+     * Permanently deletes the policy partner role. Supply the unique code that was returned when you created the policy partner role and this will delete it.
+     * @summary Delete the policy partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deletePolicyPartnerRole(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the policy partner role that was previously created. Supply the unique policy partner role code that was returned when you created it and Emil Api will return the corresponding policy partner role information.
+     * @summary Retrieve the policy partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPolicyPartnerRole(code: string, authorization?: string, options?: any): AxiosPromise<GetPolicyPartnerRoleResponseClass>;
+    /**
+     * Returns a list of policy partner roles you have previously created. The policy partner roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List policy partner roles
+     * @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 {'name' | 'productSlug'} [filter] List filter
+     * @param {'name' | 'productSlug'} [search] Search query.
+     * @param {'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt'} [order] Ordering criteria.
+     * @param {number} [expand] This entity has no expand parameters
+     * @param {string} [filters]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPolicyPartnerRole(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'name' | 'productSlug', search?: 'name' | 'productSlug', order?: 'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt', expand?: number, filters?: string, options?: any): AxiosPromise<ListPolicyPartnerRolesResponseClass>;
+    /**
+     * Updates the specified policy partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the policy partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePolicyPartnerRoleRequestDto} updatePolicyPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePolicyPartnerRole(code: string, updatePolicyPartnerRoleRequestDto: UpdatePolicyPartnerRoleRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePolicyPartnerRoleResponseClass>;
+};
+/**
+ * Request parameters for createPolicyPartnerRole operation in PolicyPartnerRolesApi.
+ * @export
+ * @interface PolicyPartnerRolesApiCreatePolicyPartnerRoleRequest
+ */
+export interface PolicyPartnerRolesApiCreatePolicyPartnerRoleRequest {
+    /**
+     *
+     * @type {CreatePolicyPartnerRoleRequestDto}
+     * @memberof PolicyPartnerRolesApiCreatePolicyPartnerRole
+     */
+    readonly createPolicyPartnerRoleRequestDto: CreatePolicyPartnerRoleRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PolicyPartnerRolesApiCreatePolicyPartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deletePolicyPartnerRole operation in PolicyPartnerRolesApi.
+ * @export
+ * @interface PolicyPartnerRolesApiDeletePolicyPartnerRoleRequest
+ */
+export interface PolicyPartnerRolesApiDeletePolicyPartnerRoleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PolicyPartnerRolesApiDeletePolicyPartnerRole
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PolicyPartnerRolesApiDeletePolicyPartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPolicyPartnerRole operation in PolicyPartnerRolesApi.
+ * @export
+ * @interface PolicyPartnerRolesApiGetPolicyPartnerRoleRequest
+ */
+export interface PolicyPartnerRolesApiGetPolicyPartnerRoleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PolicyPartnerRolesApiGetPolicyPartnerRole
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PolicyPartnerRolesApiGetPolicyPartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listPolicyPartnerRole operation in PolicyPartnerRolesApi.
+ * @export
+ * @interface PolicyPartnerRolesApiListPolicyPartnerRoleRequest
+ */
+export interface PolicyPartnerRolesApiListPolicyPartnerRoleRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PolicyPartnerRolesApiListPolicyPartnerRole
+     */
+    readonly authorization?: string;
+    /**
+     * Page size.
+     * @type {number}
+     * @memberof PolicyPartnerRolesApiListPolicyPartnerRole
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token.
+     * @type {string}
+     * @memberof PolicyPartnerRolesApiListPolicyPartnerRole
+     */
+    readonly pageToken?: string;
+    /**
+     * List filter
+     * @type {'name' | 'productSlug'}
+     * @memberof PolicyPartnerRolesApiListPolicyPartnerRole
+     */
+    readonly filter?: 'name' | 'productSlug';
+    /**
+     * Search query.
+     * @type {'name' | 'productSlug'}
+     * @memberof PolicyPartnerRolesApiListPolicyPartnerRole
+     */
+    readonly search?: 'name' | 'productSlug';
+    /**
+     * Ordering criteria.
+     * @type {'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt'}
+     * @memberof PolicyPartnerRolesApiListPolicyPartnerRole
+     */
+    readonly order?: 'id' | 'name' | 'productSlug' | 'createdAt' | 'updatedAt';
+    /**
+     * This entity has no expand parameters
+     * @type {number}
+     * @memberof PolicyPartnerRolesApiListPolicyPartnerRole
+     */
+    readonly expand?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PolicyPartnerRolesApiListPolicyPartnerRole
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updatePolicyPartnerRole operation in PolicyPartnerRolesApi.
+ * @export
+ * @interface PolicyPartnerRolesApiUpdatePolicyPartnerRoleRequest
+ */
+export interface PolicyPartnerRolesApiUpdatePolicyPartnerRoleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PolicyPartnerRolesApiUpdatePolicyPartnerRole
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdatePolicyPartnerRoleRequestDto}
+     * @memberof PolicyPartnerRolesApiUpdatePolicyPartnerRole
+     */
+    readonly updatePolicyPartnerRoleRequestDto: UpdatePolicyPartnerRoleRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PolicyPartnerRolesApiUpdatePolicyPartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * PolicyPartnerRolesApi - object-oriented interface
+ * @export
+ * @class PolicyPartnerRolesApi
+ * @extends {BaseAPI}
+ */
+export declare class PolicyPartnerRolesApi extends BaseAPI {
+    /**
+     * This will create a policy partner role.
+     * @summary Create the policy partner role
+     * @param {PolicyPartnerRolesApiCreatePolicyPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PolicyPartnerRolesApi
+     */
+    createPolicyPartnerRole(requestParameters: PolicyPartnerRolesApiCreatePolicyPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePolicyPartnerRoleResponseClass, any>>;
+    /**
+     * Permanently deletes the policy partner role. Supply the unique code that was returned when you created the policy partner role and this will delete it.
+     * @summary Delete the policy partner role
+     * @param {PolicyPartnerRolesApiDeletePolicyPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PolicyPartnerRolesApi
+     */
+    deletePolicyPartnerRole(requestParameters: PolicyPartnerRolesApiDeletePolicyPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the policy partner role that was previously created. Supply the unique policy partner role code that was returned when you created it and Emil Api will return the corresponding policy partner role information.
+     * @summary Retrieve the policy partner role
+     * @param {PolicyPartnerRolesApiGetPolicyPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PolicyPartnerRolesApi
+     */
+    getPolicyPartnerRole(requestParameters: PolicyPartnerRolesApiGetPolicyPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPolicyPartnerRoleResponseClass, any>>;
+    /**
+     * Returns a list of policy partner roles you have previously created. The policy partner roles are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List policy partner roles
+     * @param {PolicyPartnerRolesApiListPolicyPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PolicyPartnerRolesApi
+     */
+    listPolicyPartnerRole(requestParameters?: PolicyPartnerRolesApiListPolicyPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPolicyPartnerRolesResponseClass, any>>;
+    /**
+     * Updates the specified policy partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the policy partner role
+     * @param {PolicyPartnerRolesApiUpdatePolicyPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PolicyPartnerRolesApi
+     */
+    updatePolicyPartnerRole(requestParameters: PolicyPartnerRolesApiUpdatePolicyPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePolicyPartnerRoleResponseClass, any>>;
+}