@emilgroup/public-api-sdk 1.6.0 → 1.8.0

package/.openapi-generator/FILES

@@ -3,6 +3,7 @@
 .openapi-generator-ignore
 README.md
 api.ts
+api/address-completions-validations-api.ts
 api/documents-api.ts
 api/leads-api.ts
 api/notifications-api.ts
@@ -13,6 +14,9 @@ common.ts
 configuration.ts
 git_push.sh
 index.ts
+models/address-completion-item-class.ts
+models/address-completion-response-class.ts
+models/address-field-score-class.ts
 models/complete-braintree-payment-setup-request-dto.ts
 models/complete-payment-setup-request-dto.ts
 models/complete-payment-setup-response-class.ts
@@ -49,19 +53,24 @@ models/lead-class.ts
 models/lead-policy-class.ts
 models/lead-policy-object-class.ts
 models/list-documents-response-class.ts
+models/list-product-documents-response-class.ts
 models/list-products-response-class.ts
 models/payment-method-class.ts
 models/policy-object-request-dto.ts
 models/premium-override-dto.ts
 models/premium-override-request-dto.ts
 models/product-class.ts
+models/product-document-class.ts
 models/product-factor-class.ts
 models/product-field-class.ts
 models/product-version-class.ts
 models/send-notification-request-dto.ts
 models/send-notification-response-class.ts
+models/structured-address-class.ts
+models/suggested-address-details-class.ts
 models/update-lead-request-dto.ts
 models/update-lead-response-class.ts
 models/uploaded-document-dto.ts
+models/validate-address-response-class.ts
 package.json
 tsconfig.json

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/public-api-sdk@1.6.0 --save
+npm install @emilgroup/public-api-sdk@1.8.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/public-api-sdk@1.6.0
+yarn add @emilgroup/public-api-sdk@1.8.0
 ```
 
 And then you can import `PublicApi`.

package/api/address-completions-validations-api.ts

@@ -0,0 +1,348 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Emil PublicAPI
+ * The Emil Public 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 globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { AddressCompletionResponseClass } from '../models';
+// @ts-ignore
+import { ValidateAddressResponseClass } from '../models';
+/**
+ * AddressCompletionsValidationsApi - axios parameter creator
+ * @export
+ */
+export const AddressCompletionsValidationsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * This will return a list of address completions based on the provided partial address.
+         * @summary Retrieve the address
+         * @param {string} partialAddress 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listAddressCompletions: async (partialAddress: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'partialAddress' is not null or undefined
+            assertParamExists('listAddressCompletions', 'partialAddress', partialAddress)
+            const localVarPath = `/publicapi/v1/addresses/completions`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (partialAddress !== undefined) {
+                localVarQueryParameter['partialAddress'] = partialAddress;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * This will return a response whether the provided address is valid or not.
+         * @summary Retrieve the Address validation
+         * @param {string} city The city of the address
+         * @param {string} country The country of the address
+         * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
+         * @param {string} street The street of the address
+         * @param {string} houseNumber The house number of the address
+         * @param {string} [authorization] Bearer Token
+         * @param {string} [completeAddress] The complete address to validate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        validateAddress: async (city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'city' is not null or undefined
+            assertParamExists('validateAddress', 'city', city)
+            // verify required parameter 'country' is not null or undefined
+            assertParamExists('validateAddress', 'country', country)
+            // verify required parameter 'postalCode' is not null or undefined
+            assertParamExists('validateAddress', 'postalCode', postalCode)
+            // verify required parameter 'street' is not null or undefined
+            assertParamExists('validateAddress', 'street', street)
+            // verify required parameter 'houseNumber' is not null or undefined
+            assertParamExists('validateAddress', 'houseNumber', houseNumber)
+            const localVarPath = `/publicapi/v1/addresses/validation`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (completeAddress !== undefined) {
+                localVarQueryParameter['completeAddress'] = completeAddress;
+            }
+
+            if (city !== undefined) {
+                localVarQueryParameter['city'] = city;
+            }
+
+            if (country !== undefined) {
+                localVarQueryParameter['country'] = country;
+            }
+
+            if (postalCode !== undefined) {
+                localVarQueryParameter['postalCode'] = postalCode;
+            }
+
+            if (street !== undefined) {
+                localVarQueryParameter['street'] = street;
+            }
+
+            if (houseNumber !== undefined) {
+                localVarQueryParameter['houseNumber'] = houseNumber;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * AddressCompletionsValidationsApi - functional programming interface
+ * @export
+ */
+export const AddressCompletionsValidationsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = AddressCompletionsValidationsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * This will return a list of address completions based on the provided partial address.
+         * @summary Retrieve the address
+         * @param {string} partialAddress 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listAddressCompletions(partialAddress: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddressCompletionResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listAddressCompletions(partialAddress, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * This will return a response whether the provided address is valid or not.
+         * @summary Retrieve the Address validation
+         * @param {string} city The city of the address
+         * @param {string} country The country of the address
+         * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
+         * @param {string} street The street of the address
+         * @param {string} houseNumber The house number of the address
+         * @param {string} [authorization] Bearer Token
+         * @param {string} [completeAddress] The complete address to validate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async validateAddress(city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValidateAddressResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.validateAddress(city, country, postalCode, street, houseNumber, authorization, completeAddress, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * AddressCompletionsValidationsApi - factory interface
+ * @export
+ */
+export const AddressCompletionsValidationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = AddressCompletionsValidationsApiFp(configuration)
+    return {
+        /**
+         * This will return a list of address completions based on the provided partial address.
+         * @summary Retrieve the address
+         * @param {string} partialAddress 
+         * @param {string} [authorization] Bearer Token
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listAddressCompletions(partialAddress: string, authorization?: string, options?: any): AxiosPromise<AddressCompletionResponseClass> {
+            return localVarFp.listAddressCompletions(partialAddress, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * This will return a response whether the provided address is valid or not.
+         * @summary Retrieve the Address validation
+         * @param {string} city The city of the address
+         * @param {string} country The country of the address
+         * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
+         * @param {string} street The street of the address
+         * @param {string} houseNumber The house number of the address
+         * @param {string} [authorization] Bearer Token
+         * @param {string} [completeAddress] The complete address to validate
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        validateAddress(city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: any): AxiosPromise<ValidateAddressResponseClass> {
+            return localVarFp.validateAddress(city, country, postalCode, street, houseNumber, authorization, completeAddress, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for listAddressCompletions operation in AddressCompletionsValidationsApi.
+ * @export
+ * @interface AddressCompletionsValidationsApiListAddressCompletionsRequest
+ */
+export interface AddressCompletionsValidationsApiListAddressCompletionsRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof AddressCompletionsValidationsApiListAddressCompletions
+     */
+    readonly partialAddress: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof AddressCompletionsValidationsApiListAddressCompletions
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for validateAddress operation in AddressCompletionsValidationsApi.
+ * @export
+ * @interface AddressCompletionsValidationsApiValidateAddressRequest
+ */
+export interface AddressCompletionsValidationsApiValidateAddressRequest {
+    /**
+     * The city of the address
+     * @type {string}
+     * @memberof AddressCompletionsValidationsApiValidateAddress
+     */
+    readonly city: string
+
+    /**
+     * The country of the address
+     * @type {string}
+     * @memberof AddressCompletionsValidationsApiValidateAddress
+     */
+    readonly country: string
+
+    /**
+     * The postal code of the address. Must be a number and between 4 and 10 characters long
+     * @type {string}
+     * @memberof AddressCompletionsValidationsApiValidateAddress
+     */
+    readonly postalCode: string
+
+    /**
+     * The street of the address
+     * @type {string}
+     * @memberof AddressCompletionsValidationsApiValidateAddress
+     */
+    readonly street: string
+
+    /**
+     * The house number of the address
+     * @type {string}
+     * @memberof AddressCompletionsValidationsApiValidateAddress
+     */
+    readonly houseNumber: string
+
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof AddressCompletionsValidationsApiValidateAddress
+     */
+    readonly authorization?: string
+
+    /**
+     * The complete address to validate
+     * @type {string}
+     * @memberof AddressCompletionsValidationsApiValidateAddress
+     */
+    readonly completeAddress?: string
+}
+
+/**
+ * AddressCompletionsValidationsApi - object-oriented interface
+ * @export
+ * @class AddressCompletionsValidationsApi
+ * @extends {BaseAPI}
+ */
+export class AddressCompletionsValidationsApi extends BaseAPI {
+    /**
+     * This will return a list of address completions based on the provided partial address.
+     * @summary Retrieve the address
+     * @param {AddressCompletionsValidationsApiListAddressCompletionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AddressCompletionsValidationsApi
+     */
+    public listAddressCompletions(requestParameters: AddressCompletionsValidationsApiListAddressCompletionsRequest, options?: AxiosRequestConfig) {
+        return AddressCompletionsValidationsApiFp(this.configuration).listAddressCompletions(requestParameters.partialAddress, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * This will return a response whether the provided address is valid or not.
+     * @summary Retrieve the Address validation
+     * @param {AddressCompletionsValidationsApiValidateAddressRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AddressCompletionsValidationsApi
+     */
+    public validateAddress(requestParameters: AddressCompletionsValidationsApiValidateAddressRequest, options?: AxiosRequestConfig) {
+        return AddressCompletionsValidationsApiFp(this.configuration).validateAddress(requestParameters.city, requestParameters.country, requestParameters.postalCode, requestParameters.street, requestParameters.houseNumber, requestParameters.authorization, requestParameters.completeAddress, options).then((request) => request(this.axios, this.basePath));
+    }
+}