@emilgroup/public-api-sdk 1.6.0 → 1.8.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 +348 -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 +357 -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
  /**
28
30
  * DocumentsApi - axios parameter creator
29
31
  * @export
@@ -125,6 +127,75 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
125
127
  /**
126
128
  * 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.
127
129
  * @summary List documents
130
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
131
+ * @param {string} [authorization] Bearer Token
132
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
133
+ * @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.
134
+ * @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.
135
+ * @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.
136
+ * @param {*} [options] Override http request option.
137
+ * @throws {RequiredError}
138
+ */
139
+ listDocuments: async (filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
140
+ // verify required parameter 'filter' is not null or undefined
141
+ assertParamExists('listDocuments', 'filter', filter)
142
+ const localVarPath = `/publicapi/v1/documents`;
143
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
144
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
145
+ let baseOptions;
146
+ let baseAccessToken;
147
+ if (configuration) {
148
+ baseOptions = configuration.baseOptions;
149
+ baseAccessToken = configuration.accessToken;
150
+ }
151
+
152
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
153
+ const localVarHeaderParameter = {} as any;
154
+ const localVarQueryParameter = {} as any;
155
+
156
+ // authentication bearer required
157
+ // http bearer authentication required
158
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
159
+
160
+ if (pageSize !== undefined) {
161
+ localVarQueryParameter['pageSize'] = pageSize;
162
+ }
163
+
164
+ if (pageToken !== undefined) {
165
+ localVarQueryParameter['pageToken'] = pageToken;
166
+ }
167
+
168
+ if (filter !== undefined) {
169
+ localVarQueryParameter['filter'] = filter;
170
+ }
171
+
172
+ if (order !== undefined) {
173
+ localVarQueryParameter['order'] = order;
174
+ }
175
+
176
+ if (expand !== undefined) {
177
+ localVarQueryParameter['expand'] = expand;
178
+ }
179
+
180
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
181
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
182
+ }
183
+
184
+
185
+
186
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
187
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
188
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
189
+
190
+ return {
191
+ url: toPathString(localVarUrlObj),
192
+ options: localVarRequestOptions,
193
+ };
194
+ },
195
+ /**
196
+ * 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.
197
+ * @summary List product documents
198
+ * @param {string} productCode
128
199
  * @param {string} [authorization] Bearer Token
129
200
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
130
201
  * @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.
@@ -135,8 +206,11 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
135
206
  * @param {*} [options] Override http request option.
136
207
  * @throws {RequiredError}
137
208
  */
138
- listDocuments: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
139
- const localVarPath = `/publicapi/v1/documents`;
209
+ listProductDocuments: async (productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
210
+ // verify required parameter 'productCode' is not null or undefined
211
+ assertParamExists('listProductDocuments', 'productCode', productCode)
212
+ const localVarPath = `/publicapi/v1/documents/{productCode}`
213
+ .replace(`{${"productCode"}}`, encodeURIComponent(String(productCode)));
140
214
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
141
215
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
142
216
  let baseOptions;
@@ -230,6 +304,23 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
230
304
  /**
231
305
  * 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.
232
306
  * @summary List documents
307
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
308
+ * @param {string} [authorization] Bearer Token
309
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
310
+ * @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.
311
+ * @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.
312
+ * @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.
313
+ * @param {*} [options] Override http request option.
314
+ * @throws {RequiredError}
315
+ */
316
+ async listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>> {
317
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options);
318
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
319
+ },
320
+ /**
321
+ * 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.
322
+ * @summary List product documents
323
+ * @param {string} productCode
233
324
  * @param {string} [authorization] Bearer Token
234
325
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
235
326
  * @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.
@@ -240,8 +331,8 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
240
331
  * @param {*} [options] Override http request option.
241
332
  * @throws {RequiredError}
242
333
  */
243
- 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>> {
244
- const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options);
334
+ 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>> {
335
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options);
245
336
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
246
337
  },
247
338
  }
@@ -279,6 +370,22 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
279
370
  /**
280
371
  * 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.
281
372
  * @summary List documents
373
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
374
+ * @param {string} [authorization] Bearer Token
375
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
376
+ * @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.
377
+ * @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.
378
+ * @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.
379
+ * @param {*} [options] Override http request option.
380
+ * @throws {RequiredError}
381
+ */
382
+ listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocumentsResponseClass> {
383
+ return localVarFp.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options).then((request) => request(axios, basePath));
384
+ },
385
+ /**
386
+ * 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.
387
+ * @summary List product documents
388
+ * @param {string} productCode
282
389
  * @param {string} [authorization] Bearer Token
283
390
  * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
284
391
  * @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.
@@ -289,8 +396,8 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
289
396
  * @param {*} [options] Override http request option.
290
397
  * @throws {RequiredError}
291
398
  */
292
- listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListDocumentsResponseClass> {
293
- return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
399
+ listProductDocuments(productCode: string, authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListProductDocumentsResponseClass> {
400
+ return localVarFp.listProductDocuments(productCode, authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
294
401
  },
295
402
  };
296
403
  };
@@ -343,6 +450,13 @@ export interface DocumentsApiDownloadDocumentRequest {
343
450
  * @interface DocumentsApiListDocumentsRequest
344
451
  */
345
452
  export interface DocumentsApiListDocumentsRequest {
453
+ /**
454
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
455
+ * @type {string}
456
+ * @memberof DocumentsApiListDocuments
457
+ */
458
+ readonly filter: string
459
+
346
460
  /**
347
461
  * Bearer Token
348
462
  * @type {string}
@@ -352,43 +466,92 @@ export interface DocumentsApiListDocumentsRequest {
352
466
 
353
467
  /**
354
468
  * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
355
- * @type {any}
469
+ * @type {number}
470
+ * @memberof DocumentsApiListDocuments
471
+ */
472
+ readonly pageSize?: number
473
+
474
+ /**
475
+ * 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.
476
+ * @type {string}
477
+ * @memberof DocumentsApiListDocuments
478
+ */
479
+ readonly pageToken?: string
480
+
481
+ /**
482
+ * 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.
483
+ * @type {string}
484
+ * @memberof DocumentsApiListDocuments
485
+ */
486
+ readonly order?: string
487
+
488
+ /**
489
+ * 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.
490
+ * @type {string}
356
491
  * @memberof DocumentsApiListDocuments
357
492
  */
493
+ readonly expand?: string
494
+ }
495
+
496
+ /**
497
+ * Request parameters for listProductDocuments operation in DocumentsApi.
498
+ * @export
499
+ * @interface DocumentsApiListProductDocumentsRequest
500
+ */
501
+ export interface DocumentsApiListProductDocumentsRequest {
502
+ /**
503
+ *
504
+ * @type {string}
505
+ * @memberof DocumentsApiListProductDocuments
506
+ */
507
+ readonly productCode: string
508
+
509
+ /**
510
+ * Bearer Token
511
+ * @type {string}
512
+ * @memberof DocumentsApiListProductDocuments
513
+ */
514
+ readonly authorization?: string
515
+
516
+ /**
517
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
518
+ * @type {any}
519
+ * @memberof DocumentsApiListProductDocuments
520
+ */
358
521
  readonly pageSize?: any
359
522
 
360
523
  /**
361
524
  * 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.
362
525
  * @type {any}
363
- * @memberof DocumentsApiListDocuments
526
+ * @memberof DocumentsApiListProductDocuments
364
527
  */
365
528
  readonly pageToken?: any
366
529
 
367
530
  /**
368
531
  * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
369
532
  * @type {any}
370
- * @memberof DocumentsApiListDocuments
533
+ * @memberof DocumentsApiListProductDocuments
371
534
  */
372
535
  readonly filter?: any
373
536
 
374
537
  /**
375
538
  * 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.
376
539
  * @type {any}
377
- * @memberof DocumentsApiListDocuments
540
+ * @memberof DocumentsApiListProductDocuments
378
541
  */
379
542
  readonly search?: any
380
543
 
381
544
  /**
382
545
  * 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.
383
546
  * @type {any}
384
- * @memberof DocumentsApiListDocuments
547
+ * @memberof DocumentsApiListProductDocuments
385
548
  */
386
549
  readonly order?: any
387
550
 
388
551
  /**
389
552
  * 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.
390
553
  * @type {any}
391
- * @memberof DocumentsApiListDocuments
554
+ * @memberof DocumentsApiListProductDocuments
392
555
  */
393
556
  readonly expand?: any
394
557
  }
@@ -432,7 +595,19 @@ export class DocumentsApi extends BaseAPI {
432
595
  * @throws {RequiredError}
433
596
  * @memberof DocumentsApi
434
597
  */
435
- public listDocuments(requestParameters: DocumentsApiListDocumentsRequest = {}, options?: AxiosRequestConfig) {
436
- 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));
598
+ public listDocuments(requestParameters: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig) {
599
+ 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));
600
+ }
601
+
602
+ /**
603
+ * 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.
604
+ * @summary List product documents
605
+ * @param {DocumentsApiListProductDocumentsRequest} requestParameters Request parameters.
606
+ * @param {*} [options] Override http request option.
607
+ * @throws {RequiredError}
608
+ * @memberof DocumentsApi
609
+ */
610
+ public listProductDocuments(requestParameters: DocumentsApiListProductDocumentsRequest, options?: AxiosRequestConfig) {
611
+ 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));
437
612
  }
438
613
  }
package/api.ts CHANGED
@@ -20,6 +20,7 @@ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResp
20
20
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
+ import { AddressCompletionsValidationsApi } from './api';
23
24
  import { DocumentsApi } from './api';
24
25
  import { LeadsApi } from './api';
25
26
  import { NotificationsApi } from './api';
@@ -27,6 +28,7 @@ import { PaymentsSetupApi } from './api';
27
28
  import { ProductsApi } from './api';
28
29
 
29
30
 
31
+ export * from './api/address-completions-validations-api';
30
32
  export * from './api/documents-api';
31
33
  export * from './api/leads-api';
32
34
  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
+ }