@emilgroup/commission-sdk-node 1.0.0-beta.9 → 2.1.0

package/dist/api/commission-candidates-api.d.ts

@@ -0,0 +1,393 @@
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService 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 { CreateCommissionCandidateRequestDto } from '../models';
+import { CreateCommissionCandidateResponseClass } from '../models';
+import { GetCommissionCandidateResponseClass } from '../models';
+import { ListCommissionCandidatesResponseClass } from '../models';
+import { UpdateCommissionCandidateRequestDto } from '../models';
+import { UpdateCommissionCandidateResponseClass } from '../models';
+/**
+ * CommissionCandidatesApi - axios parameter creator
+ * @export
+ */
+export declare const CommissionCandidatesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create commission candidate.
+     * @summary Create the commission candidate
+     * @param {CreateCommissionCandidateRequestDto} createCommissionCandidateRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionCandidate: (createCommissionCandidateRequestDto: CreateCommissionCandidateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will delete commission candidate.
+     * @summary Delete the commission candidate
+     * @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}
+     */
+    deleteCommissionCandidate: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will get commission candidate.
+     * @summary Retrieve the commission candidate
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionCandidate: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves a list of commission candidates.
+     * @summary List commission candidates
+     * @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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, policyCode, invoiceCode&lt;/i&gt;
+     * @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: createdAt, updatedAt, policyRenewalDate&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;
+     * @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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionCandidates: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This will update commission candidate.
+     * @summary Update the commission candidate
+     * @param {string} code
+     * @param {UpdateCommissionCandidateRequestDto} updateCommissionCandidateRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionCandidate: (code: string, updateCommissionCandidateRequestDto: UpdateCommissionCandidateRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CommissionCandidatesApi - functional programming interface
+ * @export
+ */
+export declare const CommissionCandidatesApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create commission candidate.
+     * @summary Create the commission candidate
+     * @param {CreateCommissionCandidateRequestDto} createCommissionCandidateRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionCandidate(createCommissionCandidateRequestDto: CreateCommissionCandidateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCommissionCandidateResponseClass>>;
+    /**
+     * This will delete commission candidate.
+     * @summary Delete the commission candidate
+     * @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}
+     */
+    deleteCommissionCandidate(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * This will get commission candidate.
+     * @summary Retrieve the commission candidate
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionCandidate(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionCandidateResponseClass>>;
+    /**
+     * Retrieves a list of commission candidates.
+     * @summary List commission candidates
+     * @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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, policyCode, invoiceCode&lt;/i&gt;
+     * @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: createdAt, updatedAt, policyRenewalDate&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;
+     * @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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionCandidates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionCandidatesResponseClass>>;
+    /**
+     * This will update commission candidate.
+     * @summary Update the commission candidate
+     * @param {string} code
+     * @param {UpdateCommissionCandidateRequestDto} updateCommissionCandidateRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionCandidate(code: string, updateCommissionCandidateRequestDto: UpdateCommissionCandidateRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCommissionCandidateResponseClass>>;
+};
+/**
+ * CommissionCandidatesApi - factory interface
+ * @export
+ */
+export declare const CommissionCandidatesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create commission candidate.
+     * @summary Create the commission candidate
+     * @param {CreateCommissionCandidateRequestDto} createCommissionCandidateRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createCommissionCandidate(createCommissionCandidateRequestDto: CreateCommissionCandidateRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCommissionCandidateResponseClass>;
+    /**
+     * This will delete commission candidate.
+     * @summary Delete the commission candidate
+     * @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}
+     */
+    deleteCommissionCandidate(code: string, authorization?: string, options?: any): AxiosPromise<void>;
+    /**
+     * This will get commission candidate.
+     * @summary Retrieve the commission candidate
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCommissionCandidate(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionCandidateResponseClass>;
+    /**
+     * Retrieves a list of commission candidates.
+     * @summary List commission candidates
+     * @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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, policyCode, invoiceCode&lt;/i&gt;
+     * @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: createdAt, updatedAt, policyRenewalDate&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;
+     * @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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCommissionCandidates(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionCandidatesResponseClass>;
+    /**
+     * This will update commission candidate.
+     * @summary Update the commission candidate
+     * @param {string} code
+     * @param {UpdateCommissionCandidateRequestDto} updateCommissionCandidateRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateCommissionCandidate(code: string, updateCommissionCandidateRequestDto: UpdateCommissionCandidateRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateCommissionCandidateResponseClass>;
+};
+/**
+ * Request parameters for createCommissionCandidate operation in CommissionCandidatesApi.
+ * @export
+ * @interface CommissionCandidatesApiCreateCommissionCandidateRequest
+ */
+export interface CommissionCandidatesApiCreateCommissionCandidateRequest {
+    /**
+     *
+     * @type {CreateCommissionCandidateRequestDto}
+     * @memberof CommissionCandidatesApiCreateCommissionCandidate
+     */
+    readonly createCommissionCandidateRequestDto: CreateCommissionCandidateRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionCandidatesApiCreateCommissionCandidate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteCommissionCandidate operation in CommissionCandidatesApi.
+ * @export
+ * @interface CommissionCandidatesApiDeleteCommissionCandidateRequest
+ */
+export interface CommissionCandidatesApiDeleteCommissionCandidateRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionCandidatesApiDeleteCommissionCandidate
+     */
+    readonly code: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionCandidatesApiDeleteCommissionCandidate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCommissionCandidate operation in CommissionCandidatesApi.
+ * @export
+ * @interface CommissionCandidatesApiGetCommissionCandidateRequest
+ */
+export interface CommissionCandidatesApiGetCommissionCandidateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionCandidatesApiGetCommissionCandidate
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionCandidatesApiGetCommissionCandidate
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionCandidatesApiGetCommissionCandidate
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listCommissionCandidates operation in CommissionCandidatesApi.
+ * @export
+ * @interface CommissionCandidatesApiListCommissionCandidatesRequest
+ */
+export interface CommissionCandidatesApiListCommissionCandidatesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionCandidatesApiListCommissionCandidates
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof CommissionCandidatesApiListCommissionCandidates
+     */
+    readonly pageSize?: number;
+    /**
+     * 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.
+     * @type {string}
+     * @memberof CommissionCandidatesApiListCommissionCandidates
+     */
+    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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionCandidatesApiListCommissionCandidates
+     */
+    readonly filter?: string;
+    /**
+     * Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, policyCode, invoiceCode&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionCandidatesApiListCommissionCandidates
+     */
+    readonly search?: string;
+    /**
+     * 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: createdAt, updatedAt, policyRenewalDate&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionCandidatesApiListCommissionCandidates
+     */
+    readonly order?: string;
+    /**
+     * 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;
+     * @type {string}
+     * @memberof CommissionCandidatesApiListCommissionCandidates
+     */
+    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, policyCode, invoiceCode, commissionCode, candidateType, status, policyRenewalDate, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CommissionCandidatesApiListCommissionCandidates
+     */
+    readonly filters?: string;
+}
+/**
+ * Request parameters for updateCommissionCandidate operation in CommissionCandidatesApi.
+ * @export
+ * @interface CommissionCandidatesApiUpdateCommissionCandidateRequest
+ */
+export interface CommissionCandidatesApiUpdateCommissionCandidateRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof CommissionCandidatesApiUpdateCommissionCandidate
+     */
+    readonly code: string;
+    /**
+     *
+     * @type {UpdateCommissionCandidateRequestDto}
+     * @memberof CommissionCandidatesApiUpdateCommissionCandidate
+     */
+    readonly updateCommissionCandidateRequestDto: UpdateCommissionCandidateRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof CommissionCandidatesApiUpdateCommissionCandidate
+     */
+    readonly authorization?: string;
+}
+/**
+ * CommissionCandidatesApi - object-oriented interface
+ * @export
+ * @class CommissionCandidatesApi
+ * @extends {BaseAPI}
+ */
+export declare class CommissionCandidatesApi extends BaseAPI {
+    /**
+     * This will create commission candidate.
+     * @summary Create the commission candidate
+     * @param {CommissionCandidatesApiCreateCommissionCandidateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionCandidatesApi
+     */
+    createCommissionCandidate(requestParameters: CommissionCandidatesApiCreateCommissionCandidateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCommissionCandidateResponseClass, any, {}>>;
+    /**
+     * This will delete commission candidate.
+     * @summary Delete the commission candidate
+     * @param {CommissionCandidatesApiDeleteCommissionCandidateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionCandidatesApi
+     */
+    deleteCommissionCandidate(requestParameters: CommissionCandidatesApiDeleteCommissionCandidateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * This will get commission candidate.
+     * @summary Retrieve the commission candidate
+     * @param {CommissionCandidatesApiGetCommissionCandidateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionCandidatesApi
+     */
+    getCommissionCandidate(requestParameters: CommissionCandidatesApiGetCommissionCandidateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionCandidateResponseClass, any, {}>>;
+    /**
+     * Retrieves a list of commission candidates.
+     * @summary List commission candidates
+     * @param {CommissionCandidatesApiListCommissionCandidatesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionCandidatesApi
+     */
+    listCommissionCandidates(requestParameters?: CommissionCandidatesApiListCommissionCandidatesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionCandidatesResponseClass, any, {}>>;
+    /**
+     * This will update commission candidate.
+     * @summary Update the commission candidate
+     * @param {CommissionCandidatesApiUpdateCommissionCandidateRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CommissionCandidatesApi
+     */
+    updateCommissionCandidate(requestParameters: CommissionCandidatesApiUpdateCommissionCandidateRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateCommissionCandidateResponseClass, any, {}>>;
+}