@emilgroup/insurance-sdk-node 1.49.1 → 1.49.2-beta.0

package/dist/api/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 { CreatePartnerRoleRequestDto } from '../models';
+import { CreatePartnerRoleResponseClass } from '../models';
+import { DeleteResponseClass } from '../models';
+import { GetPartnerRoleResponseClass } from '../models';
+import { ListPartnerRolesResponseClass } from '../models';
+import { UpdatePartnerRoleRequestDto } from '../models';
+import { UpdatePartnerRoleResponseClass } from '../models';
+/**
+ * PartnerRolesApi - axios parameter creator
+ * @export
+ */
+export declare const PartnerRolesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a partner role.
+     * @summary Create the partner role
+     * @param {CreatePartnerRoleRequestDto} createPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerRole: (createPartnerRoleRequestDto: CreatePartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Permanently deletes the partner role. Supply the unique code that was returned when you created the partner role and this will delete it.
+     * @summary Delete the 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}
+     */
+    deletePartnerRole: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the partner role that was previously created. Supply the unique partner role code        that was returned when you created it and Emil Api will return the corresponding partner role information.
+     * @summary Retrieve the 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}
+     */
+    getPartnerRole: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of partner roles you have previously created.        The partner roles are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List 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 {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: name, productSlug&lt;/i&gt;
+     * @param {string} [search] Search query.
+     * @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: id, name, productSlug, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] This entity has no expand parameters
+     * @param {string} [filters]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerRole: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the specified partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerRoleRequestDto} updatePartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerRole: (code: string, updatePartnerRoleRequestDto: UpdatePartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PartnerRolesApi - functional programming interface
+ * @export
+ */
+export declare const PartnerRolesApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a partner role.
+     * @summary Create the partner role
+     * @param {CreatePartnerRoleRequestDto} createPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerRole(createPartnerRoleRequestDto: CreatePartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePartnerRoleResponseClass>>;
+    /**
+     * Permanently deletes the partner role. Supply the unique code that was returned when you created the partner role and this will delete it.
+     * @summary Delete the 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}
+     */
+    deletePartnerRole(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteResponseClass>>;
+    /**
+     * Retrieves the details of the partner role that was previously created. Supply the unique partner role code        that was returned when you created it and Emil Api will return the corresponding partner role information.
+     * @summary Retrieve the 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}
+     */
+    getPartnerRole(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPartnerRoleResponseClass>>;
+    /**
+     * Returns a list of partner roles you have previously created.        The partner roles are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List 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 {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: name, productSlug&lt;/i&gt;
+     * @param {string} [search] Search query.
+     * @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: id, name, productSlug, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] This entity has no expand parameters
+     * @param {string} [filters]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerRole(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListPartnerRolesResponseClass>>;
+    /**
+     * Updates the specified partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerRoleRequestDto} updatePartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerRole(code: string, updatePartnerRoleRequestDto: UpdatePartnerRoleRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdatePartnerRoleResponseClass>>;
+};
+/**
+ * PartnerRolesApi - factory interface
+ * @export
+ */
+export declare const PartnerRolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a partner role.
+     * @summary Create the partner role
+     * @param {CreatePartnerRoleRequestDto} createPartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createPartnerRole(createPartnerRoleRequestDto: CreatePartnerRoleRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePartnerRoleResponseClass>;
+    /**
+     * Permanently deletes the partner role. Supply the unique code that was returned when you created the partner role and this will delete it.
+     * @summary Delete the 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}
+     */
+    deletePartnerRole(code: string, authorization?: string, options?: any): AxiosPromise<DeleteResponseClass>;
+    /**
+     * Retrieves the details of the partner role that was previously created. Supply the unique partner role code        that was returned when you created it and Emil Api will return the corresponding partner role information.
+     * @summary Retrieve the 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}
+     */
+    getPartnerRole(code: string, authorization?: string, options?: any): AxiosPromise<GetPartnerRoleResponseClass>;
+    /**
+     * Returns a list of partner roles you have previously created.        The partner roles are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List 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 {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: name, productSlug&lt;/i&gt;
+     * @param {string} [search] Search query.
+     * @param {string} [order] Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: id, name, productSlug, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] This entity has no expand parameters
+     * @param {string} [filters]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPartnerRole(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListPartnerRolesResponseClass>;
+    /**
+     * Updates the specified partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner role
+     * @param {string} code Unique identifier for the object.
+     * @param {UpdatePartnerRoleRequestDto} updatePartnerRoleRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePartnerRole(code: string, updatePartnerRoleRequestDto: UpdatePartnerRoleRequestDto, authorization?: string, options?: any): AxiosPromise<UpdatePartnerRoleResponseClass>;
+};
+/**
+ * Request parameters for createPartnerRole operation in PartnerRolesApi.
+ * @export
+ * @interface PartnerRolesApiCreatePartnerRoleRequest
+ */
+export interface PartnerRolesApiCreatePartnerRoleRequest {
+    /**
+     *
+     * @type {CreatePartnerRoleRequestDto}
+     * @memberof PartnerRolesApiCreatePartnerRole
+     */
+    readonly createPartnerRoleRequestDto: CreatePartnerRoleRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRolesApiCreatePartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deletePartnerRole operation in PartnerRolesApi.
+ * @export
+ * @interface PartnerRolesApiDeletePartnerRoleRequest
+ */
+export interface PartnerRolesApiDeletePartnerRoleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerRolesApiDeletePartnerRole
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRolesApiDeletePartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPartnerRole operation in PartnerRolesApi.
+ * @export
+ * @interface PartnerRolesApiGetPartnerRoleRequest
+ */
+export interface PartnerRolesApiGetPartnerRoleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerRolesApiGetPartnerRole
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRolesApiGetPartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listPartnerRole operation in PartnerRolesApi.
+ * @export
+ * @interface PartnerRolesApiListPartnerRoleRequest
+ */
+export interface PartnerRolesApiListPartnerRoleRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRolesApiListPartnerRole
+     */
+    readonly authorization?: string;
+    /**
+     * Page size.
+     * @type {number}
+     * @memberof PartnerRolesApiListPartnerRole
+     */
+    readonly pageSize?: number;
+    /**
+     * Page token.
+     * @type {string}
+     * @memberof PartnerRolesApiListPartnerRole
+     */
+    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: name, productSlug&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerRolesApiListPartnerRole
+     */
+    readonly filter?: string;
+    /**
+     * Search query.
+     * @type {string}
+     * @memberof PartnerRolesApiListPartnerRole
+     */
+    readonly search?: string;
+    /**
+     * Order allowing you to specify the desired order of entities retrieved from the server.&lt;br/&gt;     &lt;br/&gt;     &lt;i&gt;Allowed values: id, name, productSlug, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof PartnerRolesApiListPartnerRole
+     */
+    readonly order?: string;
+    /**
+     * This entity has no expand parameters
+     * @type {string}
+     * @memberof PartnerRolesApiListPartnerRole
+     */
+    readonly expand?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartnerRolesApiListPartnerRole
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updatePartnerRole operation in PartnerRolesApi.
+ * @export
+ * @interface PartnerRolesApiUpdatePartnerRoleRequest
+ */
+export interface PartnerRolesApiUpdatePartnerRoleRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof PartnerRolesApiUpdatePartnerRole
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdatePartnerRoleRequestDto}
+     * @memberof PartnerRolesApiUpdatePartnerRole
+     */
+    readonly updatePartnerRoleRequestDto: UpdatePartnerRoleRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof PartnerRolesApiUpdatePartnerRole
+     */
+    readonly authorization?: string;
+}
+/**
+ * PartnerRolesApi - object-oriented interface
+ * @export
+ * @class PartnerRolesApi
+ * @extends {BaseAPI}
+ */
+export declare class PartnerRolesApi extends BaseAPI {
+    /**
+     * This will create a partner role.
+     * @summary Create the partner role
+     * @param {PartnerRolesApiCreatePartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRolesApi
+     */
+    createPartnerRole(requestParameters: PartnerRolesApiCreatePartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePartnerRoleResponseClass, any>>;
+    /**
+     * Permanently deletes the partner role. Supply the unique code that was returned when you created the partner role and this will delete it.
+     * @summary Delete the partner role
+     * @param {PartnerRolesApiDeletePartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRolesApi
+     */
+    deletePartnerRole(requestParameters: PartnerRolesApiDeletePartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteResponseClass, any>>;
+    /**
+     * Retrieves the details of the partner role that was previously created. Supply the unique partner role code        that was returned when you created it and Emil Api will return the corresponding partner role information.
+     * @summary Retrieve the partner role
+     * @param {PartnerRolesApiGetPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRolesApi
+     */
+    getPartnerRole(requestParameters: PartnerRolesApiGetPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPartnerRoleResponseClass, any>>;
+    /**
+     * Returns a list of partner roles you have previously created.        The partner roles are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.
+     * @summary List partner roles
+     * @param {PartnerRolesApiListPartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRolesApi
+     */
+    listPartnerRole(requestParameters?: PartnerRolesApiListPartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListPartnerRolesResponseClass, any>>;
+    /**
+     * Updates the specified partner role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+     * @summary Update the partner role
+     * @param {PartnerRolesApiUpdatePartnerRoleRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartnerRolesApi
+     */
+    updatePartnerRole(requestParameters: PartnerRolesApiUpdatePartnerRoleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdatePartnerRoleResponseClass, any>>;
+}