@emilgroup/public-api-sdk-node 1.8.0 → 1.10.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.
Files changed (45) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/README.md +2 -2
  3. package/api/address-completions-validations-api.ts +352 -0
  4. package/api/documents-api.ts +189 -14
  5. package/api.ts +2 -0
  6. package/dist/api/address-completions-validations-api.d.ts +197 -0
  7. package/dist/api/address-completions-validations-api.js +361 -0
  8. package/dist/api/documents-api.d.ts +111 -10
  9. package/dist/api/documents-api.js +131 -8
  10. package/dist/api.d.ts +1 -0
  11. package/dist/api.js +1 -0
  12. package/dist/models/address-completion-item-class.d.ts +49 -0
  13. package/dist/models/address-completion-item-class.js +15 -0
  14. package/dist/models/address-completion-response-class.d.ts +25 -0
  15. package/dist/models/address-completion-response-class.js +15 -0
  16. package/dist/models/address-field-score-class.d.ts +48 -0
  17. package/dist/models/address-field-score-class.js +15 -0
  18. package/dist/models/create-lead-request-dto.d.ts +12 -12
  19. package/dist/models/index.d.ts +8 -0
  20. package/dist/models/index.js +8 -0
  21. package/dist/models/insured-object-class.d.ts +7 -7
  22. package/dist/models/lead-class.d.ts +6 -0
  23. package/dist/models/list-product-documents-response-class.d.ts +31 -0
  24. package/dist/models/list-product-documents-response-class.js +15 -0
  25. package/dist/models/product-document-class.d.ts +91 -0
  26. package/dist/models/product-document-class.js +28 -0
  27. package/dist/models/structured-address-class.d.ts +54 -0
  28. package/dist/models/structured-address-class.js +15 -0
  29. package/dist/models/suggested-address-details-class.d.ts +90 -0
  30. package/dist/models/suggested-address-details-class.js +15 -0
  31. package/dist/models/validate-address-response-class.d.ts +50 -0
  32. package/dist/models/validate-address-response-class.js +15 -0
  33. package/models/address-completion-item-class.ts +55 -0
  34. package/models/address-completion-response-class.ts +31 -0
  35. package/models/address-field-score-class.ts +54 -0
  36. package/models/create-lead-request-dto.ts +12 -12
  37. package/models/index.ts +8 -0
  38. package/models/insured-object-class.ts +7 -7
  39. package/models/lead-class.ts +6 -0
  40. package/models/list-product-documents-response-class.ts +37 -0
  41. package/models/product-document-class.ts +100 -0
  42. package/models/structured-address-class.ts +60 -0
  43. package/models/suggested-address-details-class.ts +96 -0
  44. package/models/validate-address-response-class.ts +56 -0
  45. package/package.json +1 -1
@@ -24,6 +24,8 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
24
24
  import { CreateDocumentRequestDto } from '../models';
25
25
  // @ts-ignore
26
26
  import { ListDocumentsResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { ListProductDocumentsResponseClass } from '../models';
27
29
  // URLSearchParams not necessarily used
28
30
  // @ts-ignore
29
31
  import { URL, URLSearchParams } from 'url';
@@ -129,6 +131,75 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
129
131
  /**
130
132
  * 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
133
  * @summary List documents
134
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
135
+ * @param {string} [authorization] Bearer Token
136
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
137
+ * @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.
138
+ * @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.
139
+ * @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.
140
+ * @param {*} [options] Override http request option.
141
+ * @throws {RequiredError}
142
+ */
143
+ listDocuments: async (filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
144
+ // verify required parameter 'filter' is not null or undefined
145
+ assertParamExists('listDocuments', 'filter', filter)
146
+ const localVarPath = `/publicapi/v1/documents`;
147
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
148
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
149
+ let baseOptions;
150
+ let baseAccessToken;
151
+ if (configuration) {
152
+ baseOptions = configuration.baseOptions;
153
+ baseAccessToken = configuration.accessToken;
154
+ }
155
+
156
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
157
+ const localVarHeaderParameter = {} as any;
158
+ const localVarQueryParameter = {} as any;
159
+
160
+ // authentication bearer required
161
+ // http bearer authentication required
162
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
163
+
164
+ if (pageSize !== undefined) {
165
+ localVarQueryParameter['pageSize'] = pageSize;
166
+ }
167
+
168
+ if (pageToken !== undefined) {
169
+ localVarQueryParameter['pageToken'] = pageToken;
170
+ }
171
+
172
+ if (filter !== undefined) {
173
+ localVarQueryParameter['filter'] = filter;
174
+ }
175
+
176
+ if (order !== undefined) {
177
+ localVarQueryParameter['order'] = order;
178
+ }
179
+
180
+ if (expand !== undefined) {
181
+ localVarQueryParameter['expand'] = expand;
182
+ }
183
+
184
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
185
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
186
+ }
187
+
188
+
189
+
190
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
191
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
192
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
193
+
194
+ return {
195
+ url: toPathString(localVarUrlObj),
196
+ options: localVarRequestOptions,
197
+ };
198
+ },
199
+ /**
200
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
201
+ * @summary List product documents
202
+ * @param {string} productCode
132
203
  * @param {string} [authorization] Bearer Token
133
204
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
134
205
  * @param {any} [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.
@@ -139,8 +210,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
139
210
  * @param {*} [options] Override http request option.
140
211
  * @throws {RequiredError}
141
212
  */
142
- listDocuments: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
143
- const localVarPath = `/publicapi/v1/documents`;
213
+ listProductDocuments: async (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
214
+ // verify required parameter 'productCode' is not null or undefined
215
+ assertParamExists('listProductDocuments', 'productCode', productCode)
216
+ const localVarPath = `/publicapi/v1/documents/{productCode}`
217
+ .replace(`{${"productCode"}}`, encodeURIComponent(String(productCode)));
144
218
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
145
219
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
146
220
  let baseOptions;
@@ -234,6 +308,23 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
234
308
  /**
235
309
  * 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
310
  * @summary List documents
311
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
312
+ * @param {string} [authorization] Bearer Token
313
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
314
+ * @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.
315
+ * @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.
316
+ * @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.
317
+ * @param {*} [options] Override http request option.
318
+ * @throws {RequiredError}
319
+ */
320
+ async listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>> {
321
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options);
322
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
323
+ },
324
+ /**
325
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
326
+ * @summary List product documents
327
+ * @param {string} productCode
237
328
  * @param {string} [authorization] Bearer Token
238
329
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
239
330
  * @param {any} [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.
@@ -244,8 +335,8 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
244
335
  * @param {*} [options] Override http request option.
245
336
  * @throws {RequiredError}
246
337
  */
247
- async listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>> {
248
- const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options);
338
+ async listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListProductDocumentsResponseClass>> {
339
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options);
249
340
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
250
341
  },
251
342
  }
@@ -283,6 +374,22 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
283
374
  /**
284
375
  * 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
376
  * @summary List documents
377
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
378
+ * @param {string} [authorization] Bearer Token
379
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
380
+ * @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.
381
+ * @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.
382
+ * @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.
383
+ * @param {*} [options] Override http request option.
384
+ * @throws {RequiredError}
385
+ */
386
+ listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocumentsResponseClass> {
387
+ return localVarFp.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options).then((request) => request(axios, basePath));
388
+ },
389
+ /**
390
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
391
+ * @summary List product documents
392
+ * @param {string} productCode
286
393
  * @param {string} [authorization] Bearer Token
287
394
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
288
395
  * @param {any} [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.
@@ -293,8 +400,8 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
293
400
  * @param {*} [options] Override http request option.
294
401
  * @throws {RequiredError}
295
402
  */
296
- listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListDocumentsResponseClass> {
297
- return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
403
+ listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
404
+ return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
298
405
  },
299
406
  };
300
407
  };
@@ -347,6 +454,13 @@ export interface DocumentsApiDownloadDocumentRequest {
347
454
  * @interface DocumentsApiListDocumentsRequest
348
455
  */
349
456
  export interface DocumentsApiListDocumentsRequest {
457
+ /**
458
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
459
+ * @type {string}
460
+ * @memberof DocumentsApiListDocuments
461
+ */
462
+ readonly filter: string
463
+
350
464
  /**
351
465
  * Bearer Token
352
466
  * @type {string}
@@ -356,43 +470,92 @@ export interface DocumentsApiListDocumentsRequest {
356
470
 
357
471
  /**
358
472
  * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
359
- * @type {any}
473
+ * @type {number}
474
+ * @memberof DocumentsApiListDocuments
475
+ */
476
+ readonly pageSize?: number
477
+
478
+ /**
479
+ * 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.
480
+ * @type {string}
481
+ * @memberof DocumentsApiListDocuments
482
+ */
483
+ readonly pageToken?: string
484
+
485
+ /**
486
+ * 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.
487
+ * @type {string}
488
+ * @memberof DocumentsApiListDocuments
489
+ */
490
+ readonly order?: string
491
+
492
+ /**
493
+ * 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.
494
+ * @type {string}
360
495
  * @memberof DocumentsApiListDocuments
361
496
  */
497
+ readonly expand?: string
498
+ }
499
+
500
+ /**
501
+ * Request parameters for listProductDocuments operation in DocumentsApi.
502
+ * @export
503
+ * @interface DocumentsApiListProductDocumentsRequest
504
+ */
505
+ export interface DocumentsApiListProductDocumentsRequest {
506
+ /**
507
+ *
508
+ * @type {string}
509
+ * @memberof DocumentsApiListProductDocuments
510
+ */
511
+ readonly productCode: string
512
+
513
+ /**
514
+ * Bearer Token
515
+ * @type {string}
516
+ * @memberof DocumentsApiListProductDocuments
517
+ */
518
+ readonly authorization?: string
519
+
520
+ /**
521
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
522
+ * @type {any}
523
+ * @memberof DocumentsApiListProductDocuments
524
+ */
362
525
  readonly pageSize?: any
363
526
 
364
527
  /**
365
528
  * 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.
366
529
  * @type {any}
367
- * @memberof DocumentsApiListDocuments
530
+ * @memberof DocumentsApiListProductDocuments
368
531
  */
369
532
  readonly pageToken?: any
370
533
 
371
534
  /**
372
535
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
373
536
  * @type {any}
374
- * @memberof DocumentsApiListDocuments
537
+ * @memberof DocumentsApiListProductDocuments
375
538
  */
376
539
  readonly filter?: any
377
540
 
378
541
  /**
379
542
  * Search the list by any field. For instance, if you want to search by code add code&#x3D;xxx in order to fetch the result.
380
543
  * @type {any}
381
- * @memberof DocumentsApiListDocuments
544
+ * @memberof DocumentsApiListProductDocuments
382
545
  */
383
546
  readonly search?: any
384
547
 
385
548
  /**
386
549
  * 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
550
  * @type {any}
388
- * @memberof DocumentsApiListDocuments
551
+ * @memberof DocumentsApiListProductDocuments
389
552
  */
390
553
  readonly order?: any
391
554
 
392
555
  /**
393
556
  * 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
557
  * @type {any}
395
- * @memberof DocumentsApiListDocuments
558
+ * @memberof DocumentsApiListProductDocuments
396
559
  */
397
560
  readonly expand?: any
398
561
  }
@@ -436,7 +599,19 @@ export class DocumentsApi extends BaseAPI {
436
599
  * @throws {RequiredError}
437
600
  * @memberof DocumentsApi
438
601
  */
439
- public listDocuments(requestParameters: DocumentsApiListDocumentsRequest = {}, options?: AxiosRequestConfig) {
440
- return DocumentsApiFp(this.configuration).listDocuments(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
602
+ public listDocuments(requestParameters: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig) {
603
+ 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));
604
+ }
605
+
606
+ /**
607
+ * Returns a list of product documents you have previously created. The product documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
608
+ * @summary List product documents
609
+ * @param {DocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
610
+ * @param {*} [options] Override http request option.
611
+ * @throws {RequiredError}
612
+ * @memberof DocumentsApi
613
+ */
614
+ public listProductDocuments(requestParameters: DocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig) {
615
+ return DocumentsApiFp(this.configuration).listProductDocuments(requestParameters.productCode, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
441
616
  }
442
617
  }
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';
@@ -0,0 +1,197 @@
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
26
+ * @param {string} [authorization] Bearer Token
27
+ * @param {*} [options] Override http request option.
28
+ * @throws {RequiredError}
29
+ */
30
+ listAddressCompletions: (partialAddress: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
+ /**
32
+ * This will return a response whether the provided address is valid or not.
33
+ * @summary Retrieve the Address validation
34
+ * @param {string} city The city of the address
35
+ * @param {string} country The country of the address
36
+ * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
37
+ * @param {string} street The street of the address
38
+ * @param {string} houseNumber The house number of the address
39
+ * @param {string} [authorization] Bearer Token
40
+ * @param {string} [completeAddress] The complete address to validate
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ validateAddress: (city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
+ };
46
+ /**
47
+ * AddressCompletionsValidationsApi - functional programming interface
48
+ * @export
49
+ */
50
+ export declare const AddressCompletionsValidationsApiFp: (configuration?: Configuration) => {
51
+ /**
52
+ * This will return a list of address completions based on the provided partial address.
53
+ * @summary Retrieve the address
54
+ * @param {string} partialAddress
55
+ * @param {string} [authorization] Bearer Token
56
+ * @param {*} [options] Override http request option.
57
+ * @throws {RequiredError}
58
+ */
59
+ listAddressCompletions(partialAddress: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddressCompletionResponseClass>>;
60
+ /**
61
+ * This will return a response whether the provided address is valid or not.
62
+ * @summary Retrieve the Address validation
63
+ * @param {string} city The city of the address
64
+ * @param {string} country The country of the address
65
+ * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
66
+ * @param {string} street The street of the address
67
+ * @param {string} houseNumber The house number of the address
68
+ * @param {string} [authorization] Bearer Token
69
+ * @param {string} [completeAddress] The complete address to validate
70
+ * @param {*} [options] Override http request option.
71
+ * @throws {RequiredError}
72
+ */
73
+ validateAddress(city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ValidateAddressResponseClass>>;
74
+ };
75
+ /**
76
+ * AddressCompletionsValidationsApi - factory interface
77
+ * @export
78
+ */
79
+ export declare const AddressCompletionsValidationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
80
+ /**
81
+ * This will return a list of address completions based on the provided partial address.
82
+ * @summary Retrieve the address
83
+ * @param {string} partialAddress
84
+ * @param {string} [authorization] Bearer Token
85
+ * @param {*} [options] Override http request option.
86
+ * @throws {RequiredError}
87
+ */
88
+ listAddressCompletions(partialAddress: string, authorization?: string, options?: any): AxiosPromise<AddressCompletionResponseClass>;
89
+ /**
90
+ * This will return a response whether the provided address is valid or not.
91
+ * @summary Retrieve the Address validation
92
+ * @param {string} city The city of the address
93
+ * @param {string} country The country of the address
94
+ * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
95
+ * @param {string} street The street of the address
96
+ * @param {string} houseNumber The house number of the address
97
+ * @param {string} [authorization] Bearer Token
98
+ * @param {string} [completeAddress] The complete address to validate
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ validateAddress(city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: any): AxiosPromise<ValidateAddressResponseClass>;
103
+ };
104
+ /**
105
+ * Request parameters for listAddressCompletions operation in AddressCompletionsValidationsApi.
106
+ * @export
107
+ * @interface AddressCompletionsValidationsApiListAddressCompletionsRequest
108
+ */
109
+ export interface AddressCompletionsValidationsApiListAddressCompletionsRequest {
110
+ /**
111
+ *
112
+ * @type {string}
113
+ * @memberof AddressCompletionsValidationsApiListAddressCompletions
114
+ */
115
+ readonly partialAddress: string;
116
+ /**
117
+ * Bearer Token
118
+ * @type {string}
119
+ * @memberof AddressCompletionsValidationsApiListAddressCompletions
120
+ */
121
+ readonly authorization?: string;
122
+ }
123
+ /**
124
+ * Request parameters for validateAddress operation in AddressCompletionsValidationsApi.
125
+ * @export
126
+ * @interface AddressCompletionsValidationsApiValidateAddressRequest
127
+ */
128
+ export interface AddressCompletionsValidationsApiValidateAddressRequest {
129
+ /**
130
+ * The city of the address
131
+ * @type {string}
132
+ * @memberof AddressCompletionsValidationsApiValidateAddress
133
+ */
134
+ readonly city: string;
135
+ /**
136
+ * The country of the address
137
+ * @type {string}
138
+ * @memberof AddressCompletionsValidationsApiValidateAddress
139
+ */
140
+ readonly country: string;
141
+ /**
142
+ * The postal code of the address. Must be a number and between 4 and 10 characters long
143
+ * @type {string}
144
+ * @memberof AddressCompletionsValidationsApiValidateAddress
145
+ */
146
+ readonly postalCode: string;
147
+ /**
148
+ * The street of the address
149
+ * @type {string}
150
+ * @memberof AddressCompletionsValidationsApiValidateAddress
151
+ */
152
+ readonly street: string;
153
+ /**
154
+ * The house number of the address
155
+ * @type {string}
156
+ * @memberof AddressCompletionsValidationsApiValidateAddress
157
+ */
158
+ readonly houseNumber: string;
159
+ /**
160
+ * Bearer Token
161
+ * @type {string}
162
+ * @memberof AddressCompletionsValidationsApiValidateAddress
163
+ */
164
+ readonly authorization?: string;
165
+ /**
166
+ * The complete address to validate
167
+ * @type {string}
168
+ * @memberof AddressCompletionsValidationsApiValidateAddress
169
+ */
170
+ readonly completeAddress?: string;
171
+ }
172
+ /**
173
+ * AddressCompletionsValidationsApi - object-oriented interface
174
+ * @export
175
+ * @class AddressCompletionsValidationsApi
176
+ * @extends {BaseAPI}
177
+ */
178
+ export declare class AddressCompletionsValidationsApi extends BaseAPI {
179
+ /**
180
+ * This will return a list of address completions based on the provided partial address.
181
+ * @summary Retrieve the address
182
+ * @param {AddressCompletionsValidationsApiListAddressCompletionsRequest} requestParameters Request parameters.
183
+ * @param {*} [options] Override http request option.
184
+ * @throws {RequiredError}
185
+ * @memberof AddressCompletionsValidationsApi
186
+ */
187
+ listAddressCompletions(requestParameters: AddressCompletionsValidationsApiListAddressCompletionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AddressCompletionResponseClass, any>>;
188
+ /**
189
+ * This will return a response whether the provided address is valid or not.
190
+ * @summary Retrieve the Address validation
191
+ * @param {AddressCompletionsValidationsApiValidateAddressRequest} requestParameters Request parameters.
192
+ * @param {*} [options] Override http request option.
193
+ * @throws {RequiredError}
194
+ * @memberof AddressCompletionsValidationsApi
195
+ */
196
+ validateAddress(requestParameters: AddressCompletionsValidationsApiValidateAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ValidateAddressResponseClass, any>>;
197
+ }