@emilgroup/public-api-sdk-node 1.21.0 → 1.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +3 -0
- package/README.md +2 -2
- package/api/documents-api.ts +114 -0
- package/api/products-api.ts +120 -0
- package/models/calculate-product-fields-request-dto.ts +37 -0
- package/models/calculate-product-fields-response-class.ts +31 -0
- package/models/create-estimated-invoice-response-class.ts +8 -1
- package/models/create-lead-request-dto.ts +7 -7
- package/models/document-class.ts +6 -0
- package/models/index.ts +3 -0
- package/models/inline-response200.ts +6 -6
- package/models/inline-response503.ts +6 -6
- package/models/lead-account-class.ts +1 -1
- package/models/policy-object-request-dto.ts +1 -1
- package/{dist/models/policy-object-request-dto.d.ts → models/policy-object-response-class.ts} +16 -16
- package/models/product-document-class.ts +7 -7
- package/models/update-lead-request-dto.ts +5 -5
- package/package.json +2 -2
- package/dist/api/address-completions-validations-api.d.ts +0 -215
- package/dist/api/address-completions-validations-api.js +0 -373
- package/dist/api/default-api.d.ts +0 -66
- package/dist/api/default-api.js +0 -200
- package/dist/api/documents-api.d.ts +0 -475
- package/dist/api/documents-api.js +0 -757
- package/dist/api/leads-api.d.ts +0 -441
- package/dist/api/leads-api.js +0 -791
- package/dist/api/notifications-api.d.ts +0 -211
- package/dist/api/notifications-api.js +0 -414
- package/dist/api/payments-setup-api.d.ts +0 -228
- package/dist/api/payments-setup-api.js +0 -426
- package/dist/api/products-api.d.ts +0 -497
- package/dist/api/products-api.js +0 -827
- package/dist/api.d.ts +0 -18
- package/dist/api.js +0 -36
- package/dist/base.d.ts +0 -78
- package/dist/base.js +0 -394
- package/dist/common.d.ts +0 -92
- package/dist/common.js +0 -277
- package/dist/configuration.d.ts +0 -90
- package/dist/configuration.js +0 -44
- package/dist/index.d.ts +0 -15
- package/dist/index.js +0 -36
- package/dist/models/address-completion-item-class.d.ts +0 -49
- package/dist/models/address-completion-item-class.js +0 -15
- package/dist/models/address-completion-response-class.d.ts +0 -25
- package/dist/models/address-completion-response-class.js +0 -15
- package/dist/models/address-field-score-class.d.ts +0 -48
- package/dist/models/address-field-score-class.js +0 -15
- package/dist/models/complete-braintree-payment-setup-request-dto.d.ts +0 -48
- package/dist/models/complete-braintree-payment-setup-request-dto.js +0 -15
- package/dist/models/complete-email-verification-dto.d.ts +0 -30
- package/dist/models/complete-email-verification-dto.js +0 -15
- package/dist/models/complete-email-verification-response-class.d.ts +0 -24
- package/dist/models/complete-email-verification-response-class.js +0 -15
- package/dist/models/complete-payment-setup-request-dto.d.ts +0 -32
- package/dist/models/complete-payment-setup-request-dto.js +0 -15
- package/dist/models/complete-payment-setup-response-class.d.ts +0 -25
- package/dist/models/complete-payment-setup-response-class.js +0 -15
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +0 -60
- package/dist/models/complete-stripe-payment-setup-request-dto.js +0 -15
- package/dist/models/create-account-request-dto.d.ts +0 -132
- package/dist/models/create-account-request-dto.js +0 -31
- package/dist/models/create-bank-account-request-dto.d.ts +0 -30
- package/dist/models/create-bank-account-request-dto.js +0 -15
- package/dist/models/create-custom-application-request-dto.d.ts +0 -35
- package/dist/models/create-custom-application-request-dto.js +0 -20
- package/dist/models/create-custom-application-response-class.d.ts +0 -24
- package/dist/models/create-custom-application-response-class.js +0 -15
- package/dist/models/create-document-request-dto.d.ts +0 -132
- package/dist/models/create-document-request-dto.js +0 -43
- package/dist/models/create-estimated-invoice-request-dto.d.ts +0 -55
- package/dist/models/create-estimated-invoice-request-dto.js +0 -20
- package/dist/models/create-estimated-invoice-response-class.d.ts +0 -31
- package/dist/models/create-estimated-invoice-response-class.js +0 -15
- package/dist/models/create-lead-async-response-class.d.ts +0 -24
- package/dist/models/create-lead-async-response-class.js +0 -15
- package/dist/models/create-lead-request-dto.d.ts +0 -108
- package/dist/models/create-lead-request-dto.js +0 -15
- package/dist/models/create-lead-response-class.d.ts +0 -25
- package/dist/models/create-lead-response-class.js +0 -15
- package/dist/models/create-payment-method-request-dto.d.ts +0 -36
- package/dist/models/create-payment-method-request-dto.js +0 -20
- package/dist/models/create-presigned-post-request-dto.d.ts +0 -128
- package/dist/models/create-presigned-post-request-dto.js +0 -52
- package/dist/models/create-presigned-post-response-class.d.ts +0 -30
- package/dist/models/create-presigned-post-response-class.js +0 -15
- package/dist/models/document-class.d.ts +0 -138
- package/dist/models/document-class.js +0 -49
- package/dist/models/get-custom-css-response-class.d.ts +0 -24
- package/dist/models/get-custom-css-response-class.js +0 -15
- package/dist/models/get-lead-response-class.d.ts +0 -25
- package/dist/models/get-lead-response-class.js +0 -15
- package/dist/models/get-product-document-download-url-response-class.d.ts +0 -24
- package/dist/models/get-product-document-download-url-response-class.js +0 -15
- package/dist/models/get-public-psp-settings-response-class.d.ts +0 -30
- package/dist/models/get-public-psp-settings-response-class.js +0 -15
- package/dist/models/index.d.ts +0 -69
- package/dist/models/index.js +0 -85
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +0 -30
- package/dist/models/initiate-braintree-payment-setup-request-dto.js +0 -15
- package/dist/models/initiate-braintree-payment-setup-response-class.d.ts +0 -24
- package/dist/models/initiate-braintree-payment-setup-response-class.js +0 -15
- package/dist/models/initiate-email-verification-dto.d.ts +0 -30
- package/dist/models/initiate-email-verification-dto.js +0 -15
- package/dist/models/initiate-email-verification-response-class.d.ts +0 -24
- package/dist/models/initiate-email-verification-response-class.js +0 -15
- package/dist/models/initiate-lead-response-class.d.ts +0 -24
- package/dist/models/initiate-lead-response-class.js +0 -15
- package/dist/models/initiate-payment-setup-request-dto.d.ts +0 -32
- package/dist/models/initiate-payment-setup-request-dto.js +0 -15
- package/dist/models/initiate-payment-setup-response-class.d.ts +0 -32
- package/dist/models/initiate-payment-setup-response-class.js +0 -15
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +0 -30
- package/dist/models/initiate-stripe-payment-setup-request-dto.js +0 -15
- package/dist/models/initiate-stripe-payment-setup-response-class.d.ts +0 -30
- package/dist/models/initiate-stripe-payment-setup-response-class.js +0 -15
- package/dist/models/inline-response200.d.ts +0 -54
- package/dist/models/inline-response200.js +0 -15
- package/dist/models/inline-response503.d.ts +0 -54
- package/dist/models/inline-response503.js +0 -15
- package/dist/models/insured-object-class.d.ts +0 -85
- package/dist/models/insured-object-class.js +0 -15
- package/dist/models/insured-object-type-class.d.ts +0 -48
- package/dist/models/insured-object-type-class.js +0 -15
- package/dist/models/invoice-class.d.ts +0 -134
- package/dist/models/invoice-class.js +0 -15
- package/dist/models/invoice-item-class.d.ts +0 -120
- package/dist/models/invoice-item-class.js +0 -15
- package/dist/models/invoice-status-class.d.ts +0 -42
- package/dist/models/invoice-status-class.js +0 -15
- package/dist/models/lead-account-class.d.ts +0 -109
- package/dist/models/lead-account-class.js +0 -22
- package/dist/models/lead-bank-account-class.d.ts +0 -30
- package/dist/models/lead-bank-account-class.js +0 -15
- package/dist/models/lead-class.d.ts +0 -109
- package/dist/models/lead-class.js +0 -15
- package/dist/models/lead-policy-class.d.ts +0 -43
- package/dist/models/lead-policy-class.js +0 -15
- package/dist/models/lead-policy-object-class.d.ts +0 -36
- package/dist/models/lead-policy-object-class.js +0 -15
- package/dist/models/list-documents-response-class.d.ts +0 -31
- package/dist/models/list-documents-response-class.js +0 -15
- package/dist/models/list-product-documents-response-class.d.ts +0 -31
- package/dist/models/list-product-documents-response-class.js +0 -15
- package/dist/models/list-products-response-class.d.ts +0 -31
- package/dist/models/list-products-response-class.js +0 -15
- package/dist/models/payment-method-class.d.ts +0 -60
- package/dist/models/payment-method-class.js +0 -15
- package/dist/models/policy-object-request-dto.js +0 -15
- package/dist/models/premium-override-dto.d.ts +0 -55
- package/dist/models/premium-override-dto.js +0 -27
- package/dist/models/premium-override-request-dto.d.ts +0 -25
- package/dist/models/premium-override-request-dto.js +0 -15
- package/dist/models/product-class.d.ts +0 -80
- package/dist/models/product-class.js +0 -15
- package/dist/models/product-document-class.d.ts +0 -111
- package/dist/models/product-document-class.js +0 -36
- package/dist/models/product-factor-for-version-class.d.ts +0 -60
- package/dist/models/product-factor-for-version-class.js +0 -15
- package/dist/models/product-field-class.d.ts +0 -132
- package/dist/models/product-field-class.js +0 -15
- package/dist/models/product-version-class.d.ts +0 -61
- package/dist/models/product-version-class.js +0 -22
- package/dist/models/send-notification-request-dto.d.ts +0 -36
- package/dist/models/send-notification-request-dto.js +0 -15
- package/dist/models/send-notification-response-class.d.ts +0 -24
- package/dist/models/send-notification-response-class.js +0 -15
- package/dist/models/sepa-dto.d.ts +0 -30
- package/dist/models/sepa-dto.js +0 -15
- package/dist/models/structured-address-class.d.ts +0 -54
- package/dist/models/structured-address-class.js +0 -15
- package/dist/models/suggested-address-details-class.d.ts +0 -90
- package/dist/models/suggested-address-details-class.js +0 -15
- package/dist/models/update-lead-request-dto.d.ts +0 -95
- package/dist/models/update-lead-request-dto.js +0 -15
- package/dist/models/update-lead-response-class.d.ts +0 -25
- package/dist/models/update-lead-response-class.js +0 -15
- package/dist/models/uploaded-document-dto.d.ts +0 -24
- package/dist/models/uploaded-document-dto.js +0 -15
- package/dist/models/validate-address-response-class.d.ts +0 -50
- package/dist/models/validate-address-response-class.js +0 -15
|
@@ -74,12 +74,6 @@ export interface ProductDocumentClass {
|
|
|
74
74
|
* @memberof ProductDocumentClass
|
|
75
75
|
*/
|
|
76
76
|
'productSlug': string;
|
|
77
|
-
/**
|
|
78
|
-
* Time at which the object was created.
|
|
79
|
-
* @type {string}
|
|
80
|
-
* @memberof ProductDocumentClass
|
|
81
|
-
*/
|
|
82
|
-
'createdAt': string;
|
|
83
77
|
/**
|
|
84
78
|
* A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
|
|
85
79
|
* @type {string}
|
|
@@ -87,11 +81,17 @@ export interface ProductDocumentClass {
|
|
|
87
81
|
*/
|
|
88
82
|
'slug': string;
|
|
89
83
|
/**
|
|
90
|
-
*
|
|
84
|
+
* Version number of the document, incremented each time the document is updated.
|
|
91
85
|
* @type {number}
|
|
92
86
|
* @memberof ProductDocumentClass
|
|
93
87
|
*/
|
|
94
88
|
'versionNumber': number;
|
|
89
|
+
/**
|
|
90
|
+
* Time at which the object was created.
|
|
91
|
+
* @type {string}
|
|
92
|
+
* @memberof ProductDocumentClass
|
|
93
|
+
*/
|
|
94
|
+
'createdAt': string;
|
|
95
95
|
}
|
|
96
96
|
|
|
97
97
|
export const ProductDocumentClassContentTypeEnum = {
|
|
@@ -62,25 +62,25 @@ export interface UpdateLeadRequestDto {
|
|
|
62
62
|
*/
|
|
63
63
|
'policyObjects'?: Array<PolicyObjectRequestDto>;
|
|
64
64
|
/**
|
|
65
|
-
* Bank account details, to be used for direct debit payments,
|
|
65
|
+
* Bank account details, to be used for direct debit payments, the created bank account will be attached to the lead for later use, such as paying claims. The bank account content will be validated if the \'validate\' flag is set to true.
|
|
66
66
|
* @type {CreateBankAccountRequestDto}
|
|
67
67
|
* @memberof UpdateLeadRequestDto
|
|
68
68
|
*/
|
|
69
69
|
'bankAccount'?: CreateBankAccountRequestDto;
|
|
70
70
|
/**
|
|
71
|
-
* Optional custom data for the lead.
|
|
71
|
+
* Optional custom data for the lead. This field is useful for edge cases where the lead requires additional data for the risk carrier, such as creating an application in the risk carrier platform or performing a premium calculation. The custom data should include three main entities: \'data\', \'provider\', and \'productCode\'. The \'data\' entity contains information used in the risk carrier platform, the \'provider\' field contains the name of the provider (usually the risk carrier\'s name), the provider must be supported in EMIL, The \'productCode\' field contains the product code in EMIL
|
|
72
72
|
* @type {object}
|
|
73
73
|
* @memberof UpdateLeadRequestDto
|
|
74
74
|
*/
|
|
75
75
|
'customData'?: object;
|
|
76
76
|
/**
|
|
77
|
-
* Used to pass pre-uploaded documents to the lead.
|
|
77
|
+
* Used to pass pre-uploaded documents to the lead. By providing the codes of the uploaded documents, they will be attached to the lead. The uploaded document content will be validated if the \'validate\' flag is set to true.
|
|
78
78
|
* @type {UploadedDocumentDto}
|
|
79
79
|
* @memberof UpdateLeadRequestDto
|
|
80
80
|
*/
|
|
81
81
|
'uploadedDocument'?: UploadedDocumentDto;
|
|
82
82
|
/**
|
|
83
|
-
* Lead status. Default values are \"created\", \"approved\" and \"declined\".
|
|
83
|
+
* Lead status. Default values are \"created\", \"approved\" and \"declined\". However, those can be extended using /lead-statuses endpoint from insuranceservice.
|
|
84
84
|
* @type {string}
|
|
85
85
|
* @memberof UpdateLeadRequestDto
|
|
86
86
|
*/
|
|
@@ -92,7 +92,7 @@ export interface UpdateLeadRequestDto {
|
|
|
92
92
|
*/
|
|
93
93
|
'paymentMethod'?: CreatePaymentMethodRequestDto;
|
|
94
94
|
/**
|
|
95
|
-
* The validation indicator, with a default value of true, serves as a toggle.
|
|
95
|
+
* The validation indicator, with a default value of true, serves as a toggle. When set to false, it allows the bypassing of validation—a useful option for saving leads for later processing. This feature provides flexibility by enabling users to choose whether to enforce validation checks during the current stage or defer them for a subsequent time.
|
|
96
96
|
* @type {boolean}
|
|
97
97
|
* @memberof UpdateLeadRequestDto
|
|
98
98
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@emilgroup/public-api-sdk-node",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.26.0",
|
|
4
4
|
"description": "OpenAPI client for @emilgroup/public-api-sdk-node",
|
|
5
5
|
"author": "OpenAPI-Generator Contributors",
|
|
6
6
|
"keywords": [
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"url": "^0.11.0"
|
|
24
24
|
},
|
|
25
25
|
"devDependencies": {
|
|
26
|
-
|
|
26
|
+
"@types/node": "^12.11.5",
|
|
27
27
|
"typescript": "^4.0"
|
|
28
28
|
}
|
|
29
29
|
}
|
|
@@ -1,215 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Emil PublicAPI
|
|
3
|
-
* The Emil Public API description
|
|
4
|
-
*
|
|
5
|
-
* The version of the OpenAPI document: 1.0
|
|
6
|
-
* Contact: kontakt@emil.de
|
|
7
|
-
*
|
|
8
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
-
* https://openapi-generator.tech
|
|
10
|
-
* Do not edit the class manually.
|
|
11
|
-
*/
|
|
12
|
-
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
|
-
import { Configuration } from '../configuration';
|
|
14
|
-
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
-
import { AddressCompletionResponseClass } from '../models';
|
|
16
|
-
import { ValidateAddressResponseClass } from '../models';
|
|
17
|
-
/**
|
|
18
|
-
* AddressCompletionsValidationsApi - axios parameter creator
|
|
19
|
-
* @export
|
|
20
|
-
*/
|
|
21
|
-
export declare const AddressCompletionsValidationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
-
/**
|
|
23
|
-
* This will return a list of address completions based on the provided partial address.
|
|
24
|
-
* @summary Retrieve the address
|
|
25
|
-
* @param {string} partialAddress Partial address for completion
|
|
26
|
-
* @param {string} [authorization] Bearer Token
|
|
27
|
-
* @param {'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia'} [country] This property can be used to filter addresses by country
|
|
28
|
-
* @param {number} [limit] The number of results to fetch
|
|
29
|
-
* @param {*} [options] Override http request option.
|
|
30
|
-
* @throws {RequiredError}
|
|
31
|
-
*/
|
|
32
|
-
listAddressCompletions: (partialAddress: string, authorization?: string, country?: 'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia', limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
|
-
/**
|
|
34
|
-
* This will return a response whether the provided address is valid or not.
|
|
35
|
-
* @summary Retrieve the Address validation
|
|
36
|
-
* @param {string} city The city of the address
|
|
37
|
-
* @param {string} country The country of the address
|
|
38
|
-
* @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
|
|
39
|
-
* @param {string} street The street of the address
|
|
40
|
-
* @param {string} houseNumber The house number of the address
|
|
41
|
-
* @param {string} [authorization] Bearer Token
|
|
42
|
-
* @param {string} [completeAddress] The complete address to validate
|
|
43
|
-
* @param {*} [options] Override http request option.
|
|
44
|
-
* @throws {RequiredError}
|
|
45
|
-
*/
|
|
46
|
-
validateAddress: (city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
|
-
};
|
|
48
|
-
/**
|
|
49
|
-
* AddressCompletionsValidationsApi - functional programming interface
|
|
50
|
-
* @export
|
|
51
|
-
*/
|
|
52
|
-
export declare const AddressCompletionsValidationsApiFp: (configuration?: Configuration) => {
|
|
53
|
-
/**
|
|
54
|
-
* This will return a list of address completions based on the provided partial address.
|
|
55
|
-
* @summary Retrieve the address
|
|
56
|
-
* @param {string} partialAddress Partial address for completion
|
|
57
|
-
* @param {string} [authorization] Bearer Token
|
|
58
|
-
* @param {'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia'} [country] This property can be used to filter addresses by country
|
|
59
|
-
* @param {number} [limit] The number of results to fetch
|
|
60
|
-
* @param {*} [options] Override http request option.
|
|
61
|
-
* @throws {RequiredError}
|
|
62
|
-
*/
|
|
63
|
-
listAddressCompletions(partialAddress: string, authorization?: string, country?: 'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia', limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddressCompletionResponseClass>>;
|
|
64
|
-
/**
|
|
65
|
-
* This will return a response whether the provided address is valid or not.
|
|
66
|
-
* @summary Retrieve the Address validation
|
|
67
|
-
* @param {string} city The city of the address
|
|
68
|
-
* @param {string} country The country of the address
|
|
69
|
-
* @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
|
|
70
|
-
* @param {string} street The street of the address
|
|
71
|
-
* @param {string} houseNumber The house number of the address
|
|
72
|
-
* @param {string} [authorization] Bearer Token
|
|
73
|
-
* @param {string} [completeAddress] The complete address to validate
|
|
74
|
-
* @param {*} [options] Override http request option.
|
|
75
|
-
* @throws {RequiredError}
|
|
76
|
-
*/
|
|
77
|
-
validateAddress(city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValidateAddressResponseClass>>;
|
|
78
|
-
};
|
|
79
|
-
/**
|
|
80
|
-
* AddressCompletionsValidationsApi - factory interface
|
|
81
|
-
* @export
|
|
82
|
-
*/
|
|
83
|
-
export declare const AddressCompletionsValidationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
84
|
-
/**
|
|
85
|
-
* This will return a list of address completions based on the provided partial address.
|
|
86
|
-
* @summary Retrieve the address
|
|
87
|
-
* @param {string} partialAddress Partial address for completion
|
|
88
|
-
* @param {string} [authorization] Bearer Token
|
|
89
|
-
* @param {'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia'} [country] This property can be used to filter addresses by country
|
|
90
|
-
* @param {number} [limit] The number of results to fetch
|
|
91
|
-
* @param {*} [options] Override http request option.
|
|
92
|
-
* @throws {RequiredError}
|
|
93
|
-
*/
|
|
94
|
-
listAddressCompletions(partialAddress: string, authorization?: string, country?: 'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia', limit?: number, options?: any): AxiosPromise<AddressCompletionResponseClass>;
|
|
95
|
-
/**
|
|
96
|
-
* This will return a response whether the provided address is valid or not.
|
|
97
|
-
* @summary Retrieve the Address validation
|
|
98
|
-
* @param {string} city The city of the address
|
|
99
|
-
* @param {string} country The country of the address
|
|
100
|
-
* @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
|
|
101
|
-
* @param {string} street The street of the address
|
|
102
|
-
* @param {string} houseNumber The house number of the address
|
|
103
|
-
* @param {string} [authorization] Bearer Token
|
|
104
|
-
* @param {string} [completeAddress] The complete address to validate
|
|
105
|
-
* @param {*} [options] Override http request option.
|
|
106
|
-
* @throws {RequiredError}
|
|
107
|
-
*/
|
|
108
|
-
validateAddress(city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: any): AxiosPromise<ValidateAddressResponseClass>;
|
|
109
|
-
};
|
|
110
|
-
/**
|
|
111
|
-
* Request parameters for listAddressCompletions operation in AddressCompletionsValidationsApi.
|
|
112
|
-
* @export
|
|
113
|
-
* @interface AddressCompletionsValidationsApiListAddressCompletionsRequest
|
|
114
|
-
*/
|
|
115
|
-
export interface AddressCompletionsValidationsApiListAddressCompletionsRequest {
|
|
116
|
-
/**
|
|
117
|
-
* Partial address for completion
|
|
118
|
-
* @type {string}
|
|
119
|
-
* @memberof AddressCompletionsValidationsApiListAddressCompletions
|
|
120
|
-
*/
|
|
121
|
-
readonly partialAddress: string;
|
|
122
|
-
/**
|
|
123
|
-
* Bearer Token
|
|
124
|
-
* @type {string}
|
|
125
|
-
* @memberof AddressCompletionsValidationsApiListAddressCompletions
|
|
126
|
-
*/
|
|
127
|
-
readonly authorization?: string;
|
|
128
|
-
/**
|
|
129
|
-
* This property can be used to filter addresses by country
|
|
130
|
-
* @type {'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia'}
|
|
131
|
-
* @memberof AddressCompletionsValidationsApiListAddressCompletions
|
|
132
|
-
*/
|
|
133
|
-
readonly country?: 'Germany' | 'Spain' | 'Austria' | 'Switzerland' | 'UnitedStates' | 'Italy' | 'Norway' | 'CzechRepublic' | 'Australia';
|
|
134
|
-
/**
|
|
135
|
-
* The number of results to fetch
|
|
136
|
-
* @type {number}
|
|
137
|
-
* @memberof AddressCompletionsValidationsApiListAddressCompletions
|
|
138
|
-
*/
|
|
139
|
-
readonly limit?: number;
|
|
140
|
-
}
|
|
141
|
-
/**
|
|
142
|
-
* Request parameters for validateAddress operation in AddressCompletionsValidationsApi.
|
|
143
|
-
* @export
|
|
144
|
-
* @interface AddressCompletionsValidationsApiValidateAddressRequest
|
|
145
|
-
*/
|
|
146
|
-
export interface AddressCompletionsValidationsApiValidateAddressRequest {
|
|
147
|
-
/**
|
|
148
|
-
* The city of the address
|
|
149
|
-
* @type {string}
|
|
150
|
-
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
151
|
-
*/
|
|
152
|
-
readonly city: string;
|
|
153
|
-
/**
|
|
154
|
-
* The country of the address
|
|
155
|
-
* @type {string}
|
|
156
|
-
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
157
|
-
*/
|
|
158
|
-
readonly country: string;
|
|
159
|
-
/**
|
|
160
|
-
* The postal code of the address. Must be a number and between 4 and 10 characters long
|
|
161
|
-
* @type {string}
|
|
162
|
-
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
163
|
-
*/
|
|
164
|
-
readonly postalCode: string;
|
|
165
|
-
/**
|
|
166
|
-
* The street of the address
|
|
167
|
-
* @type {string}
|
|
168
|
-
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
169
|
-
*/
|
|
170
|
-
readonly street: string;
|
|
171
|
-
/**
|
|
172
|
-
* The house number of the address
|
|
173
|
-
* @type {string}
|
|
174
|
-
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
175
|
-
*/
|
|
176
|
-
readonly houseNumber: string;
|
|
177
|
-
/**
|
|
178
|
-
* Bearer Token
|
|
179
|
-
* @type {string}
|
|
180
|
-
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
181
|
-
*/
|
|
182
|
-
readonly authorization?: string;
|
|
183
|
-
/**
|
|
184
|
-
* The complete address to validate
|
|
185
|
-
* @type {string}
|
|
186
|
-
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
187
|
-
*/
|
|
188
|
-
readonly completeAddress?: string;
|
|
189
|
-
}
|
|
190
|
-
/**
|
|
191
|
-
* AddressCompletionsValidationsApi - object-oriented interface
|
|
192
|
-
* @export
|
|
193
|
-
* @class AddressCompletionsValidationsApi
|
|
194
|
-
* @extends {BaseAPI}
|
|
195
|
-
*/
|
|
196
|
-
export declare class AddressCompletionsValidationsApi extends BaseAPI {
|
|
197
|
-
/**
|
|
198
|
-
* This will return a list of address completions based on the provided partial address.
|
|
199
|
-
* @summary Retrieve the address
|
|
200
|
-
* @param {AddressCompletionsValidationsApiListAddressCompletionsRequest} requestParameters Request parameters.
|
|
201
|
-
* @param {*} [options] Override http request option.
|
|
202
|
-
* @throws {RequiredError}
|
|
203
|
-
* @memberof AddressCompletionsValidationsApi
|
|
204
|
-
*/
|
|
205
|
-
listAddressCompletions(requestParameters: AddressCompletionsValidationsApiListAddressCompletionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AddressCompletionResponseClass, any>>;
|
|
206
|
-
/**
|
|
207
|
-
* This will return a response whether the provided address is valid or not.
|
|
208
|
-
* @summary Retrieve the Address validation
|
|
209
|
-
* @param {AddressCompletionsValidationsApiValidateAddressRequest} requestParameters Request parameters.
|
|
210
|
-
* @param {*} [options] Override http request option.
|
|
211
|
-
* @throws {RequiredError}
|
|
212
|
-
* @memberof AddressCompletionsValidationsApi
|
|
213
|
-
*/
|
|
214
|
-
validateAddress(requestParameters: AddressCompletionsValidationsApiValidateAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ValidateAddressResponseClass, any>>;
|
|
215
|
-
}
|