@emilgroup/public-api-sdk 1.6.0 → 1.7.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 (37) hide show
  1. package/.openapi-generator/FILES +7 -0
  2. package/README.md +2 -2
  3. package/api/address-completions-validations-api.ts +348 -0
  4. package/api/documents-api.ts +39 -51
  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 +33 -42
  9. package/dist/api/documents-api.js +23 -28
  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 +6 -0
  20. package/dist/models/index.js +6 -0
  21. package/dist/models/insured-object-class.d.ts +7 -7
  22. package/dist/models/structured-address-class.d.ts +54 -0
  23. package/dist/models/structured-address-class.js +15 -0
  24. package/dist/models/suggested-address-details-class.d.ts +90 -0
  25. package/dist/models/suggested-address-details-class.js +15 -0
  26. package/dist/models/validate-address-response-class.d.ts +50 -0
  27. package/dist/models/validate-address-response-class.js +15 -0
  28. package/models/address-completion-item-class.ts +55 -0
  29. package/models/address-completion-response-class.ts +31 -0
  30. package/models/address-field-score-class.ts +54 -0
  31. package/models/create-lead-request-dto.ts +12 -12
  32. package/models/index.ts +6 -0
  33. package/models/insured-object-class.ts +7 -7
  34. package/models/structured-address-class.ts +60 -0
  35. package/models/suggested-address-details-class.ts +96 -0
  36. package/models/validate-address-response-class.ts +56 -0
  37. package/package.json +1 -1
@@ -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@1.6.0 --save
20
+ npm install @emilgroup/public-api-sdk@1.7.0 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/public-api-sdk@1.6.0
24
+ yarn add @emilgroup/public-api-sdk@1.7.0
25
25
  ```
26
26
 
27
27
  And then you can import `PublicApi`.
@@ -0,0 +1,348 @@
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
+ /**
28
+ * AddressCompletionsValidationsApi - axios parameter creator
29
+ * @export
30
+ */
31
+ export const AddressCompletionsValidationsApiAxiosParamCreator = function (configuration?: Configuration) {
32
+ return {
33
+ /**
34
+ * This will return a list of address completions based on the provided partial address.
35
+ * @summary Retrieve the address
36
+ * @param {string} partialAddress
37
+ * @param {string} [authorization] Bearer Token
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ listAddressCompletions: async (partialAddress: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
42
+ // verify required parameter 'partialAddress' is not null or undefined
43
+ assertParamExists('listAddressCompletions', 'partialAddress', partialAddress)
44
+ const localVarPath = `/publicapi/v1/addresses/completions`;
45
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ let baseAccessToken;
49
+ if (configuration) {
50
+ baseOptions = configuration.baseOptions;
51
+ baseAccessToken = configuration.accessToken;
52
+ }
53
+
54
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
55
+ const localVarHeaderParameter = {} as any;
56
+ const localVarQueryParameter = {} as any;
57
+
58
+ // authentication bearer required
59
+ // http bearer authentication required
60
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
61
+
62
+ if (partialAddress !== undefined) {
63
+ localVarQueryParameter['partialAddress'] = partialAddress;
64
+ }
65
+
66
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
67
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
68
+ }
69
+
70
+
71
+
72
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
73
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
74
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
75
+
76
+ return {
77
+ url: toPathString(localVarUrlObj),
78
+ options: localVarRequestOptions,
79
+ };
80
+ },
81
+ /**
82
+ * This will return a response whether the provided address is valid or not.
83
+ * @summary Retrieve the Address validation
84
+ * @param {string} city The city of the address
85
+ * @param {string} country The country of the address
86
+ * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
87
+ * @param {string} street The street of the address
88
+ * @param {string} houseNumber The house number of the address
89
+ * @param {string} [authorization] Bearer Token
90
+ * @param {string} [completeAddress] The complete address to validate
91
+ * @param {*} [options] Override http request option.
92
+ * @throws {RequiredError}
93
+ */
94
+ validateAddress: async (city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
95
+ // verify required parameter 'city' is not null or undefined
96
+ assertParamExists('validateAddress', 'city', city)
97
+ // verify required parameter 'country' is not null or undefined
98
+ assertParamExists('validateAddress', 'country', country)
99
+ // verify required parameter 'postalCode' is not null or undefined
100
+ assertParamExists('validateAddress', 'postalCode', postalCode)
101
+ // verify required parameter 'street' is not null or undefined
102
+ assertParamExists('validateAddress', 'street', street)
103
+ // verify required parameter 'houseNumber' is not null or undefined
104
+ assertParamExists('validateAddress', 'houseNumber', houseNumber)
105
+ const localVarPath = `/publicapi/v1/addresses/validation`;
106
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
107
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
108
+ let baseOptions;
109
+ let baseAccessToken;
110
+ if (configuration) {
111
+ baseOptions = configuration.baseOptions;
112
+ baseAccessToken = configuration.accessToken;
113
+ }
114
+
115
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
116
+ const localVarHeaderParameter = {} as any;
117
+ const localVarQueryParameter = {} as any;
118
+
119
+ // authentication bearer required
120
+ // http bearer authentication required
121
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
122
+
123
+ if (completeAddress !== undefined) {
124
+ localVarQueryParameter['completeAddress'] = completeAddress;
125
+ }
126
+
127
+ if (city !== undefined) {
128
+ localVarQueryParameter['city'] = city;
129
+ }
130
+
131
+ if (country !== undefined) {
132
+ localVarQueryParameter['country'] = country;
133
+ }
134
+
135
+ if (postalCode !== undefined) {
136
+ localVarQueryParameter['postalCode'] = postalCode;
137
+ }
138
+
139
+ if (street !== undefined) {
140
+ localVarQueryParameter['street'] = street;
141
+ }
142
+
143
+ if (houseNumber !== undefined) {
144
+ localVarQueryParameter['houseNumber'] = houseNumber;
145
+ }
146
+
147
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
148
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
149
+ }
150
+
151
+
152
+
153
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
154
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
155
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
156
+
157
+ return {
158
+ url: toPathString(localVarUrlObj),
159
+ options: localVarRequestOptions,
160
+ };
161
+ },
162
+ }
163
+ };
164
+
165
+ /**
166
+ * AddressCompletionsValidationsApi - functional programming interface
167
+ * @export
168
+ */
169
+ export const AddressCompletionsValidationsApiFp = function(configuration?: Configuration) {
170
+ const localVarAxiosParamCreator = AddressCompletionsValidationsApiAxiosParamCreator(configuration)
171
+ return {
172
+ /**
173
+ * This will return a list of address completions based on the provided partial address.
174
+ * @summary Retrieve the address
175
+ * @param {string} partialAddress
176
+ * @param {string} [authorization] Bearer Token
177
+ * @param {*} [options] Override http request option.
178
+ * @throws {RequiredError}
179
+ */
180
+ async listAddressCompletions(partialAddress: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AddressCompletionResponseClass>> {
181
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listAddressCompletions(partialAddress, authorization, options);
182
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
183
+ },
184
+ /**
185
+ * This will return a response whether the provided address is valid or not.
186
+ * @summary Retrieve the Address validation
187
+ * @param {string} city The city of the address
188
+ * @param {string} country The country of the address
189
+ * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
190
+ * @param {string} street The street of the address
191
+ * @param {string} houseNumber The house number of the address
192
+ * @param {string} [authorization] Bearer Token
193
+ * @param {string} [completeAddress] The complete address to validate
194
+ * @param {*} [options] Override http request option.
195
+ * @throws {RequiredError}
196
+ */
197
+ 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>> {
198
+ const localVarAxiosArgs = await localVarAxiosParamCreator.validateAddress(city, country, postalCode, street, houseNumber, authorization, completeAddress, options);
199
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
200
+ },
201
+ }
202
+ };
203
+
204
+ /**
205
+ * AddressCompletionsValidationsApi - factory interface
206
+ * @export
207
+ */
208
+ export const AddressCompletionsValidationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
209
+ const localVarFp = AddressCompletionsValidationsApiFp(configuration)
210
+ return {
211
+ /**
212
+ * This will return a list of address completions based on the provided partial address.
213
+ * @summary Retrieve the address
214
+ * @param {string} partialAddress
215
+ * @param {string} [authorization] Bearer Token
216
+ * @param {*} [options] Override http request option.
217
+ * @throws {RequiredError}
218
+ */
219
+ listAddressCompletions(partialAddress: string, authorization?: string, options?: any): AxiosPromise<AddressCompletionResponseClass> {
220
+ return localVarFp.listAddressCompletions(partialAddress, authorization, options).then((request) => request(axios, basePath));
221
+ },
222
+ /**
223
+ * This will return a response whether the provided address is valid or not.
224
+ * @summary Retrieve the Address validation
225
+ * @param {string} city The city of the address
226
+ * @param {string} country The country of the address
227
+ * @param {string} postalCode The postal code of the address. Must be a number and between 4 and 10 characters long
228
+ * @param {string} street The street of the address
229
+ * @param {string} houseNumber The house number of the address
230
+ * @param {string} [authorization] Bearer Token
231
+ * @param {string} [completeAddress] The complete address to validate
232
+ * @param {*} [options] Override http request option.
233
+ * @throws {RequiredError}
234
+ */
235
+ validateAddress(city: string, country: string, postalCode: string, street: string, houseNumber: string, authorization?: string, completeAddress?: string, options?: any): AxiosPromise<ValidateAddressResponseClass> {
236
+ return localVarFp.validateAddress(city, country, postalCode, street, houseNumber, authorization, completeAddress, options).then((request) => request(axios, basePath));
237
+ },
238
+ };
239
+ };
240
+
241
+ /**
242
+ * Request parameters for listAddressCompletions operation in AddressCompletionsValidationsApi.
243
+ * @export
244
+ * @interface AddressCompletionsValidationsApiListAddressCompletionsRequest
245
+ */
246
+ export interface AddressCompletionsValidationsApiListAddressCompletionsRequest {
247
+ /**
248
+ *
249
+ * @type {string}
250
+ * @memberof AddressCompletionsValidationsApiListAddressCompletions
251
+ */
252
+ readonly partialAddress: string
253
+
254
+ /**
255
+ * Bearer Token
256
+ * @type {string}
257
+ * @memberof AddressCompletionsValidationsApiListAddressCompletions
258
+ */
259
+ readonly authorization?: string
260
+ }
261
+
262
+ /**
263
+ * Request parameters for validateAddress operation in AddressCompletionsValidationsApi.
264
+ * @export
265
+ * @interface AddressCompletionsValidationsApiValidateAddressRequest
266
+ */
267
+ export interface AddressCompletionsValidationsApiValidateAddressRequest {
268
+ /**
269
+ * The city of the address
270
+ * @type {string}
271
+ * @memberof AddressCompletionsValidationsApiValidateAddress
272
+ */
273
+ readonly city: string
274
+
275
+ /**
276
+ * The country of the address
277
+ * @type {string}
278
+ * @memberof AddressCompletionsValidationsApiValidateAddress
279
+ */
280
+ readonly country: string
281
+
282
+ /**
283
+ * The postal code of the address. Must be a number and between 4 and 10 characters long
284
+ * @type {string}
285
+ * @memberof AddressCompletionsValidationsApiValidateAddress
286
+ */
287
+ readonly postalCode: string
288
+
289
+ /**
290
+ * The street of the address
291
+ * @type {string}
292
+ * @memberof AddressCompletionsValidationsApiValidateAddress
293
+ */
294
+ readonly street: string
295
+
296
+ /**
297
+ * The house number of the address
298
+ * @type {string}
299
+ * @memberof AddressCompletionsValidationsApiValidateAddress
300
+ */
301
+ readonly houseNumber: string
302
+
303
+ /**
304
+ * Bearer Token
305
+ * @type {string}
306
+ * @memberof AddressCompletionsValidationsApiValidateAddress
307
+ */
308
+ readonly authorization?: string
309
+
310
+ /**
311
+ * The complete address to validate
312
+ * @type {string}
313
+ * @memberof AddressCompletionsValidationsApiValidateAddress
314
+ */
315
+ readonly completeAddress?: string
316
+ }
317
+
318
+ /**
319
+ * AddressCompletionsValidationsApi - object-oriented interface
320
+ * @export
321
+ * @class AddressCompletionsValidationsApi
322
+ * @extends {BaseAPI}
323
+ */
324
+ export class AddressCompletionsValidationsApi extends BaseAPI {
325
+ /**
326
+ * This will return a list of address completions based on the provided partial address.
327
+ * @summary Retrieve the address
328
+ * @param {AddressCompletionsValidationsApiListAddressCompletionsRequest} requestParameters Request parameters.
329
+ * @param {*} [options] Override http request option.
330
+ * @throws {RequiredError}
331
+ * @memberof AddressCompletionsValidationsApi
332
+ */
333
+ public listAddressCompletions(requestParameters: AddressCompletionsValidationsApiListAddressCompletionsRequest, options?: AxiosRequestConfig) {
334
+ return AddressCompletionsValidationsApiFp(this.configuration).listAddressCompletions(requestParameters.partialAddress, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
335
+ }
336
+
337
+ /**
338
+ * This will return a response whether the provided address is valid or not.
339
+ * @summary Retrieve the Address validation
340
+ * @param {AddressCompletionsValidationsApiValidateAddressRequest} requestParameters Request parameters.
341
+ * @param {*} [options] Override http request option.
342
+ * @throws {RequiredError}
343
+ * @memberof AddressCompletionsValidationsApi
344
+ */
345
+ public validateAddress(requestParameters: AddressCompletionsValidationsApiValidateAddressRequest, options?: AxiosRequestConfig) {
346
+ 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));
347
+ }
348
+ }
@@ -125,17 +125,18 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
125
125
  /**
126
126
  * 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
127
  * @summary List documents
128
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
128
129
  * @param {string} [authorization] Bearer Token
129
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
130
- * @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.
131
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
132
- * @param {any} [search] 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.
133
- * @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.
134
- * @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.
130
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
131
+ * @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.
132
+ * @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.
133
+ * @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.
135
134
  * @param {*} [options] Override http request option.
136
135
  * @throws {RequiredError}
137
136
  */
138
- listDocuments: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
137
+ listDocuments: async (filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
138
+ // verify required parameter 'filter' is not null or undefined
139
+ assertParamExists('listDocuments', 'filter', filter)
139
140
  const localVarPath = `/publicapi/v1/documents`;
140
141
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
141
142
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -166,10 +167,6 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
166
167
  localVarQueryParameter['filter'] = filter;
167
168
  }
168
169
 
169
- if (search !== undefined) {
170
- localVarQueryParameter['search'] = search;
171
- }
172
-
173
170
  if (order !== undefined) {
174
171
  localVarQueryParameter['order'] = order;
175
172
  }
@@ -230,18 +227,17 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
230
227
  /**
231
228
  * 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
229
  * @summary List documents
230
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
233
231
  * @param {string} [authorization] Bearer Token
234
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
235
- * @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.
236
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
237
- * @param {any} [search] 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.
238
- * @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.
239
- * @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.
232
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
233
+ * @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.
234
+ * @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.
235
+ * @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.
240
236
  * @param {*} [options] Override http request option.
241
237
  * @throws {RequiredError}
242
238
  */
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);
239
+ async listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>> {
240
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options);
245
241
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
246
242
  },
247
243
  }
@@ -279,18 +275,17 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
279
275
  /**
280
276
  * 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
277
  * @summary List documents
278
+ * @param {string} filter Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
282
279
  * @param {string} [authorization] Bearer Token
283
- * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
284
- * @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.
285
- * @param {any} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
286
- * @param {any} [search] 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.
287
- * @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.
288
- * @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.
280
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
281
+ * @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.
282
+ * @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.
283
+ * @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.
289
284
  * @param {*} [options] Override http request option.
290
285
  * @throws {RequiredError}
291
286
  */
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));
287
+ listDocuments(filter: string, authorization?: string, pageSize?: number, pageToken?: string, order?: string, expand?: string, options?: any): AxiosPromise<ListDocumentsResponseClass> {
288
+ return localVarFp.listDocuments(filter, authorization, pageSize, pageToken, order, expand, options).then((request) => request(axios, basePath));
294
289
  },
295
290
  };
296
291
  };
@@ -344,53 +339,46 @@ export interface DocumentsApiDownloadDocumentRequest {
344
339
  */
345
340
  export interface DocumentsApiListDocumentsRequest {
346
341
  /**
347
- * Bearer Token
342
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
348
343
  * @type {string}
349
344
  * @memberof DocumentsApiListDocuments
350
345
  */
351
- readonly authorization?: string
352
-
353
- /**
354
- * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
355
- * @type {any}
356
- * @memberof DocumentsApiListDocuments
357
- */
358
- readonly pageSize?: any
346
+ readonly filter: string
359
347
 
360
348
  /**
361
- * 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
- * @type {any}
349
+ * Bearer Token
350
+ * @type {string}
363
351
  * @memberof DocumentsApiListDocuments
364
352
  */
365
- readonly pageToken?: any
353
+ readonly authorization?: string
366
354
 
367
355
  /**
368
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
369
- * @type {any}
356
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
357
+ * @type {number}
370
358
  * @memberof DocumentsApiListDocuments
371
359
  */
372
- readonly filter?: any
360
+ readonly pageSize?: number
373
361
 
374
362
  /**
375
- * 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
- * @type {any}
363
+ * 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.
364
+ * @type {string}
377
365
  * @memberof DocumentsApiListDocuments
378
366
  */
379
- readonly search?: any
367
+ readonly pageToken?: string
380
368
 
381
369
  /**
382
370
  * 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
- * @type {any}
371
+ * @type {string}
384
372
  * @memberof DocumentsApiListDocuments
385
373
  */
386
- readonly order?: any
374
+ readonly order?: string
387
375
 
388
376
  /**
389
377
  * 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
- * @type {any}
378
+ * @type {string}
391
379
  * @memberof DocumentsApiListDocuments
392
380
  */
393
- readonly expand?: any
381
+ readonly expand?: string
394
382
  }
395
383
 
396
384
  /**
@@ -432,7 +420,7 @@ export class DocumentsApi extends BaseAPI {
432
420
  * @throws {RequiredError}
433
421
  * @memberof DocumentsApi
434
422
  */
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));
423
+ public listDocuments(requestParameters: DocumentsApiListDocumentsRequest, options?: AxiosRequestConfig) {
424
+ 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));
437
425
  }
438
426
  }
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';