@emilgroup/public-api-sdk-node 1.8.0 → 1.9.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 +7 -0
- package/README.md +2 -2
- package/api/address-completions-validations-api.ts +352 -0
- package/api/documents-api.ts +39 -51
- package/api.ts +2 -0
- package/dist/api/address-completions-validations-api.d.ts +197 -0
- package/dist/api/address-completions-validations-api.js +361 -0
- package/dist/api/documents-api.d.ts +33 -42
- package/dist/api/documents-api.js +23 -28
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/address-completion-item-class.d.ts +49 -0
- package/dist/models/address-completion-item-class.js +15 -0
- package/dist/models/address-completion-response-class.d.ts +25 -0
- package/dist/models/address-completion-response-class.js +15 -0
- package/dist/models/address-field-score-class.d.ts +48 -0
- package/dist/models/address-field-score-class.js +15 -0
- package/dist/models/create-lead-request-dto.d.ts +12 -12
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/dist/models/insured-object-class.d.ts +7 -7
- package/dist/models/structured-address-class.d.ts +54 -0
- package/dist/models/structured-address-class.js +15 -0
- package/dist/models/suggested-address-details-class.d.ts +90 -0
- package/dist/models/suggested-address-details-class.js +15 -0
- package/dist/models/validate-address-response-class.d.ts +50 -0
- package/dist/models/validate-address-response-class.js +15 -0
- package/models/address-completion-item-class.ts +55 -0
- package/models/address-completion-response-class.ts +31 -0
- package/models/address-field-score-class.ts +54 -0
- package/models/create-lead-request-dto.ts +12 -12
- package/models/index.ts +6 -0
- package/models/insured-object-class.ts +7 -7
- package/models/structured-address-class.ts +60 -0
- package/models/suggested-address-details-class.ts +96 -0
- package/models/validate-address-response-class.ts +56 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
.openapi-generator-ignore
|
|
4
4
|
README.md
|
|
5
5
|
api.ts
|
|
6
|
+
api/address-completions-validations-api.ts
|
|
6
7
|
api/documents-api.ts
|
|
7
8
|
api/leads-api.ts
|
|
8
9
|
api/notifications-api.ts
|
|
@@ -13,6 +14,9 @@ common.ts
|
|
|
13
14
|
configuration.ts
|
|
14
15
|
git_push.sh
|
|
15
16
|
index.ts
|
|
17
|
+
models/address-completion-item-class.ts
|
|
18
|
+
models/address-completion-response-class.ts
|
|
19
|
+
models/address-field-score-class.ts
|
|
16
20
|
models/complete-braintree-payment-setup-request-dto.ts
|
|
17
21
|
models/complete-payment-setup-request-dto.ts
|
|
18
22
|
models/complete-payment-setup-response-class.ts
|
|
@@ -60,8 +64,11 @@ models/product-field-class.ts
|
|
|
60
64
|
models/product-version-class.ts
|
|
61
65
|
models/send-notification-request-dto.ts
|
|
62
66
|
models/send-notification-response-class.ts
|
|
67
|
+
models/structured-address-class.ts
|
|
68
|
+
models/suggested-address-details-class.ts
|
|
63
69
|
models/update-lead-request-dto.ts
|
|
64
70
|
models/update-lead-response-class.ts
|
|
65
71
|
models/uploaded-document-dto.ts
|
|
72
|
+
models/validate-address-response-class.ts
|
|
66
73
|
package.json
|
|
67
74
|
tsconfig.json
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/public-api-sdk-node@1.
|
|
20
|
+
npm install @emilgroup/public-api-sdk-node@1.9.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/public-api-sdk-node@1.
|
|
24
|
+
yarn add @emilgroup/public-api-sdk-node@1.9.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PublicApi`.
|
|
@@ -0,0 +1,352 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Emil PublicAPI
|
|
5
|
+
* The Emil Public API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
17
|
+
import { Configuration } from '../configuration';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { AddressCompletionResponseClass } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { ValidateAddressResponseClass } from '../models';
|
|
27
|
+
// URLSearchParams not necessarily used
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
import { URL, URLSearchParams } from 'url';
|
|
30
|
+
const FormData = require('form-data');
|
|
31
|
+
/**
|
|
32
|
+
* AddressCompletionsValidationsApi - axios parameter creator
|
|
33
|
+
* @export
|
|
34
|
+
*/
|
|
35
|
+
export const AddressCompletionsValidationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
|
+
return {
|
|
37
|
+
/**
|
|
38
|
+
* This will return a list of address completions based on the provided partial address.
|
|
39
|
+
* @summary Retrieve the address
|
|
40
|
+
* @param {string} partialAddress
|
|
41
|
+
* @param {string} [authorization] Bearer Token
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
listAddressCompletions: async (partialAddress: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
46
|
+
// verify required parameter 'partialAddress' is not null or undefined
|
|
47
|
+
assertParamExists('listAddressCompletions', 'partialAddress', partialAddress)
|
|
48
|
+
const localVarPath = `/publicapi/v1/addresses/completions`;
|
|
49
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
51
|
+
let baseOptions;
|
|
52
|
+
let baseAccessToken;
|
|
53
|
+
if (configuration) {
|
|
54
|
+
baseOptions = configuration.baseOptions;
|
|
55
|
+
baseAccessToken = configuration.accessToken;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
59
|
+
const localVarHeaderParameter = {} as any;
|
|
60
|
+
const localVarQueryParameter = {} as any;
|
|
61
|
+
|
|
62
|
+
// authentication bearer required
|
|
63
|
+
// http bearer authentication required
|
|
64
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
65
|
+
|
|
66
|
+
if (partialAddress !== undefined) {
|
|
67
|
+
localVarQueryParameter['partialAddress'] = partialAddress;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
71
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
77
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
78
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
79
|
+
|
|
80
|
+
return {
|
|
81
|
+
url: toPathString(localVarUrlObj),
|
|
82
|
+
options: localVarRequestOptions,
|
|
83
|
+
};
|
|
84
|
+
},
|
|
85
|
+
/**
|
|
86
|
+
* This will return a response whether the provided address is valid or not.
|
|
87
|
+
* @summary Retrieve the Address validation
|
|
88
|
+
* @param {string} city The city of the address
|
|
89
|
+
* @param {string} country The country of the address
|
|
90
|
+
* @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
|
|
91
|
+
* @param {string} street The street of the address
|
|
92
|
+
* @param {string} houseNumber The house number of the address
|
|
93
|
+
* @param {string} [authorization] Bearer Token
|
|
94
|
+
* @param {string} [completeAddress] The complete address to validate
|
|
95
|
+
* @param {*} [options] Override http request option.
|
|
96
|
+
* @throws {RequiredError}
|
|
97
|
+
*/
|
|
98
|
+
validateAddress: async (city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
99
|
+
// verify required parameter 'city' is not null or undefined
|
|
100
|
+
assertParamExists('validateAddress', 'city', city)
|
|
101
|
+
// verify required parameter 'country' is not null or undefined
|
|
102
|
+
assertParamExists('validateAddress', 'country', country)
|
|
103
|
+
// verify required parameter 'postalCode' is not null or undefined
|
|
104
|
+
assertParamExists('validateAddress', 'postalCode', postalCode)
|
|
105
|
+
// verify required parameter 'street' is not null or undefined
|
|
106
|
+
assertParamExists('validateAddress', 'street', street)
|
|
107
|
+
// verify required parameter 'houseNumber' is not null or undefined
|
|
108
|
+
assertParamExists('validateAddress', 'houseNumber', houseNumber)
|
|
109
|
+
const localVarPath = `/publicapi/v1/addresses/validation`;
|
|
110
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
111
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
112
|
+
let baseOptions;
|
|
113
|
+
let baseAccessToken;
|
|
114
|
+
if (configuration) {
|
|
115
|
+
baseOptions = configuration.baseOptions;
|
|
116
|
+
baseAccessToken = configuration.accessToken;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
120
|
+
const localVarHeaderParameter = {} as any;
|
|
121
|
+
const localVarQueryParameter = {} as any;
|
|
122
|
+
|
|
123
|
+
// authentication bearer required
|
|
124
|
+
// http bearer authentication required
|
|
125
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
126
|
+
|
|
127
|
+
if (completeAddress !== undefined) {
|
|
128
|
+
localVarQueryParameter['completeAddress'] = completeAddress;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
if (city !== undefined) {
|
|
132
|
+
localVarQueryParameter['city'] = city;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
if (country !== undefined) {
|
|
136
|
+
localVarQueryParameter['country'] = country;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
if (postalCode !== undefined) {
|
|
140
|
+
localVarQueryParameter['postalCode'] = postalCode;
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
if (street !== undefined) {
|
|
144
|
+
localVarQueryParameter['street'] = street;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
if (houseNumber !== undefined) {
|
|
148
|
+
localVarQueryParameter['houseNumber'] = houseNumber;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
152
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
158
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
159
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
160
|
+
|
|
161
|
+
return {
|
|
162
|
+
url: toPathString(localVarUrlObj),
|
|
163
|
+
options: localVarRequestOptions,
|
|
164
|
+
};
|
|
165
|
+
},
|
|
166
|
+
}
|
|
167
|
+
};
|
|
168
|
+
|
|
169
|
+
/**
|
|
170
|
+
* AddressCompletionsValidationsApi - functional programming interface
|
|
171
|
+
* @export
|
|
172
|
+
*/
|
|
173
|
+
export const AddressCompletionsValidationsApiFp = function(configuration?: Configuration) {
|
|
174
|
+
const localVarAxiosParamCreator = AddressCompletionsValidationsApiAxiosParamCreator(configuration)
|
|
175
|
+
return {
|
|
176
|
+
/**
|
|
177
|
+
* This will return a list of address completions based on the provided partial address.
|
|
178
|
+
* @summary Retrieve the address
|
|
179
|
+
* @param {string} partialAddress
|
|
180
|
+
* @param {string} [authorization] Bearer Token
|
|
181
|
+
* @param {*} [options] Override http request option.
|
|
182
|
+
* @throws {RequiredError}
|
|
183
|
+
*/
|
|
184
|
+
async listAddressCompletions(partialAddress: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddressCompletionResponseClass>> {
|
|
185
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listAddressCompletions(partialAddress, authorization, options);
|
|
186
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
187
|
+
},
|
|
188
|
+
/**
|
|
189
|
+
* This will return a response whether the provided address is valid or not.
|
|
190
|
+
* @summary Retrieve the Address validation
|
|
191
|
+
* @param {string} city The city of the address
|
|
192
|
+
* @param {string} country The country of the address
|
|
193
|
+
* @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
|
|
194
|
+
* @param {string} street The street of the address
|
|
195
|
+
* @param {string} houseNumber The house number of the address
|
|
196
|
+
* @param {string} [authorization] Bearer Token
|
|
197
|
+
* @param {string} [completeAddress] The complete address to validate
|
|
198
|
+
* @param {*} [options] Override http request option.
|
|
199
|
+
* @throws {RequiredError}
|
|
200
|
+
*/
|
|
201
|
+
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>> {
|
|
202
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.validateAddress(city, country, postalCode, street, houseNumber, authorization, completeAddress, options);
|
|
203
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
204
|
+
},
|
|
205
|
+
}
|
|
206
|
+
};
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* AddressCompletionsValidationsApi - factory interface
|
|
210
|
+
* @export
|
|
211
|
+
*/
|
|
212
|
+
export const AddressCompletionsValidationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
213
|
+
const localVarFp = AddressCompletionsValidationsApiFp(configuration)
|
|
214
|
+
return {
|
|
215
|
+
/**
|
|
216
|
+
* This will return a list of address completions based on the provided partial address.
|
|
217
|
+
* @summary Retrieve the address
|
|
218
|
+
* @param {string} partialAddress
|
|
219
|
+
* @param {string} [authorization] Bearer Token
|
|
220
|
+
* @param {*} [options] Override http request option.
|
|
221
|
+
* @throws {RequiredError}
|
|
222
|
+
*/
|
|
223
|
+
listAddressCompletions(partialAddress: string, authorization?: string, options?: any): AxiosPromise<AddressCompletionResponseClass> {
|
|
224
|
+
return localVarFp.listAddressCompletions(partialAddress, authorization, options).then((request) => request(axios, basePath));
|
|
225
|
+
},
|
|
226
|
+
/**
|
|
227
|
+
* This will return a response whether the provided address is valid or not.
|
|
228
|
+
* @summary Retrieve the Address validation
|
|
229
|
+
* @param {string} city The city of the address
|
|
230
|
+
* @param {string} country The country of the address
|
|
231
|
+
* @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
|
|
232
|
+
* @param {string} street The street of the address
|
|
233
|
+
* @param {string} houseNumber The house number of the address
|
|
234
|
+
* @param {string} [authorization] Bearer Token
|
|
235
|
+
* @param {string} [completeAddress] The complete address to validate
|
|
236
|
+
* @param {*} [options] Override http request option.
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
*/
|
|
239
|
+
validateAddress(city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: any): AxiosPromise<ValidateAddressResponseClass> {
|
|
240
|
+
return localVarFp.validateAddress(city, country, postalCode, street, houseNumber, authorization, completeAddress, options).then((request) => request(axios, basePath));
|
|
241
|
+
},
|
|
242
|
+
};
|
|
243
|
+
};
|
|
244
|
+
|
|
245
|
+
/**
|
|
246
|
+
* Request parameters for listAddressCompletions operation in AddressCompletionsValidationsApi.
|
|
247
|
+
* @export
|
|
248
|
+
* @interface AddressCompletionsValidationsApiListAddressCompletionsRequest
|
|
249
|
+
*/
|
|
250
|
+
export interface AddressCompletionsValidationsApiListAddressCompletionsRequest {
|
|
251
|
+
/**
|
|
252
|
+
*
|
|
253
|
+
* @type {string}
|
|
254
|
+
* @memberof AddressCompletionsValidationsApiListAddressCompletions
|
|
255
|
+
*/
|
|
256
|
+
readonly partialAddress: string
|
|
257
|
+
|
|
258
|
+
/**
|
|
259
|
+
* Bearer Token
|
|
260
|
+
* @type {string}
|
|
261
|
+
* @memberof AddressCompletionsValidationsApiListAddressCompletions
|
|
262
|
+
*/
|
|
263
|
+
readonly authorization?: string
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
/**
|
|
267
|
+
* Request parameters for validateAddress operation in AddressCompletionsValidationsApi.
|
|
268
|
+
* @export
|
|
269
|
+
* @interface AddressCompletionsValidationsApiValidateAddressRequest
|
|
270
|
+
*/
|
|
271
|
+
export interface AddressCompletionsValidationsApiValidateAddressRequest {
|
|
272
|
+
/**
|
|
273
|
+
* The city of the address
|
|
274
|
+
* @type {string}
|
|
275
|
+
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
276
|
+
*/
|
|
277
|
+
readonly city: string
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
* The country of the address
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
283
|
+
*/
|
|
284
|
+
readonly country: string
|
|
285
|
+
|
|
286
|
+
/**
|
|
287
|
+
* The postal code of the address. Must be a number and between 4 and 10 characters long
|
|
288
|
+
* @type {string}
|
|
289
|
+
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
290
|
+
*/
|
|
291
|
+
readonly postalCode: string
|
|
292
|
+
|
|
293
|
+
/**
|
|
294
|
+
* The street of the address
|
|
295
|
+
* @type {string}
|
|
296
|
+
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
297
|
+
*/
|
|
298
|
+
readonly street: string
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* The house number of the address
|
|
302
|
+
* @type {string}
|
|
303
|
+
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
304
|
+
*/
|
|
305
|
+
readonly houseNumber: string
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* Bearer Token
|
|
309
|
+
* @type {string}
|
|
310
|
+
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
311
|
+
*/
|
|
312
|
+
readonly authorization?: string
|
|
313
|
+
|
|
314
|
+
/**
|
|
315
|
+
* The complete address to validate
|
|
316
|
+
* @type {string}
|
|
317
|
+
* @memberof AddressCompletionsValidationsApiValidateAddress
|
|
318
|
+
*/
|
|
319
|
+
readonly completeAddress?: string
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* AddressCompletionsValidationsApi - object-oriented interface
|
|
324
|
+
* @export
|
|
325
|
+
* @class AddressCompletionsValidationsApi
|
|
326
|
+
* @extends {BaseAPI}
|
|
327
|
+
*/
|
|
328
|
+
export class AddressCompletionsValidationsApi extends BaseAPI {
|
|
329
|
+
/**
|
|
330
|
+
* This will return a list of address completions based on the provided partial address.
|
|
331
|
+
* @summary Retrieve the address
|
|
332
|
+
* @param {AddressCompletionsValidationsApiListAddressCompletionsRequest} requestParameters Request parameters.
|
|
333
|
+
* @param {*} [options] Override http request option.
|
|
334
|
+
* @throws {RequiredError}
|
|
335
|
+
* @memberof AddressCompletionsValidationsApi
|
|
336
|
+
*/
|
|
337
|
+
public listAddressCompletions(requestParameters: AddressCompletionsValidationsApiListAddressCompletionsRequest, options?: AxiosRequestConfig) {
|
|
338
|
+
return AddressCompletionsValidationsApiFp(this.configuration).listAddressCompletions(requestParameters.partialAddress, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
339
|
+
}
|
|
340
|
+
|
|
341
|
+
/**
|
|
342
|
+
* This will return a response whether the provided address is valid or not.
|
|
343
|
+
* @summary Retrieve the Address validation
|
|
344
|
+
* @param {AddressCompletionsValidationsApiValidateAddressRequest} requestParameters Request parameters.
|
|
345
|
+
* @param {*} [options] Override http request option.
|
|
346
|
+
* @throws {RequiredError}
|
|
347
|
+
* @memberof AddressCompletionsValidationsApi
|
|
348
|
+
*/
|
|
349
|
+
public validateAddress(requestParameters: AddressCompletionsValidationsApiValidateAddressRequest, options?: AxiosRequestConfig) {
|
|
350
|
+
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));
|
|
351
|
+
}
|
|
352
|
+
}
|
package/api/documents-api.ts
CHANGED
|
@@ -129,17 +129,18 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
129
129
|
/**
|
|
130
130
|
* Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
131
131
|
* @summary List documents
|
|
132
|
+
* @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
132
133
|
* @param {string} [authorization] Bearer Token
|
|
133
|
-
* @param {
|
|
134
|
-
* @param {
|
|
135
|
-
* @param {
|
|
136
|
-
* @param {
|
|
137
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
138
|
-
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
134
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
135
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
136
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
137
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
139
138
|
* @param {*} [options] Override http request option.
|
|
140
139
|
* @throws {RequiredError}
|
|
141
140
|
*/
|
|
142
|
-
listDocuments: async (authorization?: string, pageSize?:
|
|
141
|
+
listDocuments: async (filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
142
|
+
// verify required parameter 'filter' is not null or undefined
|
|
143
|
+
assertParamExists('listDocuments', 'filter', filter)
|
|
143
144
|
const localVarPath = `/publicapi/v1/documents`;
|
|
144
145
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
145
146
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -170,10 +171,6 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
170
171
|
localVarQueryParameter['filter'] = filter;
|
|
171
172
|
}
|
|
172
173
|
|
|
173
|
-
if (search !== undefined) {
|
|
174
|
-
localVarQueryParameter['search'] = search;
|
|
175
|
-
}
|
|
176
|
-
|
|
177
174
|
if (order !== undefined) {
|
|
178
175
|
localVarQueryParameter['order'] = order;
|
|
179
176
|
}
|
|
@@ -234,18 +231,17 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
234
231
|
/**
|
|
235
232
|
* Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
236
233
|
* @summary List documents
|
|
234
|
+
* @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
237
235
|
* @param {string} [authorization] Bearer Token
|
|
238
|
-
* @param {
|
|
239
|
-
* @param {
|
|
240
|
-
* @param {
|
|
241
|
-
* @param {
|
|
242
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
243
|
-
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
236
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
237
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
238
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
239
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
244
240
|
* @param {*} [options] Override http request option.
|
|
245
241
|
* @throws {RequiredError}
|
|
246
242
|
*/
|
|
247
|
-
async listDocuments(authorization?: string, pageSize?:
|
|
248
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(authorization, pageSize, pageToken,
|
|
243
|
+
async listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>> {
|
|
244
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options);
|
|
249
245
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
250
246
|
},
|
|
251
247
|
}
|
|
@@ -283,18 +279,17 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
283
279
|
/**
|
|
284
280
|
* Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
|
|
285
281
|
* @summary List documents
|
|
282
|
+
* @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
286
283
|
* @param {string} [authorization] Bearer Token
|
|
287
|
-
* @param {
|
|
288
|
-
* @param {
|
|
289
|
-
* @param {
|
|
290
|
-
* @param {
|
|
291
|
-
* @param {any} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
292
|
-
* @param {any} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
284
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
285
|
+
* @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
286
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
287
|
+
* @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
293
288
|
* @param {*} [options] Override http request option.
|
|
294
289
|
* @throws {RequiredError}
|
|
295
290
|
*/
|
|
296
|
-
listDocuments(authorization?: string, pageSize?:
|
|
297
|
-
return localVarFp.listDocuments(authorization, pageSize, pageToken,
|
|
291
|
+
listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocumentsResponseClass> {
|
|
292
|
+
return localVarFp.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options).then((request) => request(axios, basePath));
|
|
298
293
|
},
|
|
299
294
|
};
|
|
300
295
|
};
|
|
@@ -348,53 +343,46 @@ export interface DocumentsApiDownloadDocumentRequest {
|
|
|
348
343
|
*/
|
|
349
344
|
export interface DocumentsApiListDocumentsRequest {
|
|
350
345
|
/**
|
|
351
|
-
*
|
|
346
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
352
347
|
* @type {string}
|
|
353
348
|
* @memberof DocumentsApiListDocuments
|
|
354
349
|
*/
|
|
355
|
-
readonly
|
|
356
|
-
|
|
357
|
-
/**
|
|
358
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
359
|
-
* @type {any}
|
|
360
|
-
* @memberof DocumentsApiListDocuments
|
|
361
|
-
*/
|
|
362
|
-
readonly pageSize?: any
|
|
350
|
+
readonly filter: string
|
|
363
351
|
|
|
364
352
|
/**
|
|
365
|
-
*
|
|
366
|
-
* @type {
|
|
353
|
+
* Bearer Token
|
|
354
|
+
* @type {string}
|
|
367
355
|
* @memberof DocumentsApiListDocuments
|
|
368
356
|
*/
|
|
369
|
-
readonly
|
|
357
|
+
readonly authorization?: string
|
|
370
358
|
|
|
371
359
|
/**
|
|
372
|
-
*
|
|
373
|
-
* @type {
|
|
360
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
361
|
+
* @type {number}
|
|
374
362
|
* @memberof DocumentsApiListDocuments
|
|
375
363
|
*/
|
|
376
|
-
readonly
|
|
364
|
+
readonly pageSize?: number
|
|
377
365
|
|
|
378
366
|
/**
|
|
379
|
-
*
|
|
380
|
-
* @type {
|
|
367
|
+
* 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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
368
|
+
* @type {string}
|
|
381
369
|
* @memberof DocumentsApiListDocuments
|
|
382
370
|
*/
|
|
383
|
-
readonly
|
|
371
|
+
readonly pageToken?: string
|
|
384
372
|
|
|
385
373
|
/**
|
|
386
374
|
* The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
387
|
-
* @type {
|
|
375
|
+
* @type {string}
|
|
388
376
|
* @memberof DocumentsApiListDocuments
|
|
389
377
|
*/
|
|
390
|
-
readonly order?:
|
|
378
|
+
readonly order?: string
|
|
391
379
|
|
|
392
380
|
/**
|
|
393
381
|
* Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
|
|
394
|
-
* @type {
|
|
382
|
+
* @type {string}
|
|
395
383
|
* @memberof DocumentsApiListDocuments
|
|
396
384
|
*/
|
|
397
|
-
readonly expand?:
|
|
385
|
+
readonly expand?: string
|
|
398
386
|
}
|
|
399
387
|
|
|
400
388
|
/**
|
|
@@ -436,7 +424,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
436
424
|
* @throws {RequiredError}
|
|
437
425
|
* @memberof DocumentsApi
|
|
438
426
|
*/
|
|
439
|
-
public listDocuments(requestParameters: DocumentsApiListDocumentsRequest
|
|
440
|
-
return DocumentsApiFp(this.configuration).listDocuments(requestParameters.
|
|
427
|
+
public listDocuments(requestParameters: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig) {
|
|
428
|
+
return DocumentsApiFp(this.configuration).listDocuments(requestParameters.filter, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
441
429
|
}
|
|
442
430
|
}
|
package/api.ts
CHANGED
|
@@ -24,6 +24,7 @@ import FormData from 'form-data'
|
|
|
24
24
|
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
27
|
+
import { AddressCompletionsValidationsApi } from './api';
|
|
27
28
|
import { DocumentsApi } from './api';
|
|
28
29
|
import { LeadsApi } from './api';
|
|
29
30
|
import { NotificationsApi } from './api';
|
|
@@ -31,6 +32,7 @@ import { PaymentsSetupApi } from './api';
|
|
|
31
32
|
import { ProductsApi } from './api';
|
|
32
33
|
|
|
33
34
|
|
|
35
|
+
export * from './api/address-completions-validations-api';
|
|
34
36
|
export * from './api/documents-api';
|
|
35
37
|
export * from './api/leads-api';
|
|
36
38
|
export * from './api/notifications-api';
|