@emilgroup/numbergenerator-sdk-node 1.0.1-beta.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 (52) hide show
  1. package/.openapi-generator/FILES +22 -0
  2. package/.openapi-generator/VERSION +1 -0
  3. package/.openapi-generator-ignore +23 -0
  4. package/README.md +84 -0
  5. package/api/default-api.ts +124 -0
  6. package/api/numbers-api.ts +768 -0
  7. package/api.ts +33 -0
  8. package/base.ts +328 -0
  9. package/common.ts +199 -0
  10. package/configuration.ts +118 -0
  11. package/dist/api/default-api.d.ts +66 -0
  12. package/dist/api/default-api.js +200 -0
  13. package/dist/api/numbers-api.d.ts +428 -0
  14. package/dist/api/numbers-api.js +729 -0
  15. package/dist/api.d.ts +13 -0
  16. package/dist/api.js +31 -0
  17. package/dist/base.d.ts +88 -0
  18. package/dist/base.js +434 -0
  19. package/dist/common.d.ts +92 -0
  20. package/dist/common.js +277 -0
  21. package/dist/configuration.d.ts +96 -0
  22. package/dist/configuration.js +52 -0
  23. package/dist/index.d.ts +15 -0
  24. package/dist/index.js +36 -0
  25. package/dist/models/create-number-response-class.d.ts +25 -0
  26. package/dist/models/create-number-response-class.js +15 -0
  27. package/dist/models/entity-number-class.d.ts +66 -0
  28. package/dist/models/entity-number-class.js +21 -0
  29. package/dist/models/get-number-response-class.d.ts +25 -0
  30. package/dist/models/get-number-response-class.js +15 -0
  31. package/dist/models/index.d.ts +7 -0
  32. package/dist/models/index.js +23 -0
  33. package/dist/models/inline-response200.d.ts +54 -0
  34. package/dist/models/inline-response200.js +15 -0
  35. package/dist/models/inline-response503.d.ts +54 -0
  36. package/dist/models/inline-response503.js +15 -0
  37. package/dist/models/list-numbers-response-class.d.ts +31 -0
  38. package/dist/models/list-numbers-response-class.js +15 -0
  39. package/dist/models/update-number-response-class.d.ts +25 -0
  40. package/dist/models/update-number-response-class.js +15 -0
  41. package/git_push.sh +57 -0
  42. package/index.ts +19 -0
  43. package/models/create-number-response-class.ts +31 -0
  44. package/models/entity-number-class.ts +75 -0
  45. package/models/get-number-response-class.ts +31 -0
  46. package/models/index.ts +7 -0
  47. package/models/inline-response200.ts +48 -0
  48. package/models/inline-response503.ts +48 -0
  49. package/models/list-numbers-response-class.ts +37 -0
  50. package/models/update-number-response-class.ts +31 -0
  51. package/package.json +29 -0
  52. package/tsconfig.json +23 -0
@@ -0,0 +1,768 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL Number Generator Service
5
+ * The EMIL Number Generator Service API is a robust tool designed to generate unique and structured entity numbers like policies, accounts, invoices, and other entities. This API streamlines the process of creating distinct identifiers for various business objects.
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 { CreateNumberResponseClass } from '../models';
25
+ // @ts-ignore
26
+ import { GetNumberResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { ListNumbersResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { UpdateNumberResponseClass } from '../models';
31
+ // URLSearchParams not necessarily used
32
+ // @ts-ignore
33
+ import { URL, URLSearchParams } from 'url';
34
+ const FormData = require('form-data');
35
+ /**
36
+ * NumbersApi - axios parameter creator
37
+ * @export
38
+ */
39
+ export const NumbersApiAxiosParamCreator = function (configuration?: Configuration) {
40
+ return {
41
+ /**
42
+ * This will create an entity number in the database. Entity number is a way to generate unique numbers for your entities. You can create as many numbers as you want.
43
+ * @summary Create the number
44
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
45
+ * @param {*} [options] Override http request option.
46
+ * @throws {RequiredError}
47
+ */
48
+ createNumber: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
49
+ const localVarPath = `/numbergenerator/v1/numbers`;
50
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
51
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
52
+ let baseOptions;
53
+ let baseAccessToken;
54
+ if (configuration) {
55
+ baseOptions = configuration.baseOptions;
56
+ baseAccessToken = configuration.accessToken;
57
+ }
58
+
59
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
60
+ const localVarHeaderParameter = {} as any;
61
+ const localVarQueryParameter = {} as any;
62
+
63
+ // authentication bearer required
64
+ // http bearer authentication required
65
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
66
+
67
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
68
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
69
+ }
70
+
71
+
72
+
73
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
74
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
75
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
76
+
77
+ return {
78
+ url: toPathString(localVarUrlObj),
79
+ options: localVarRequestOptions,
80
+ };
81
+ },
82
+ /**
83
+ * Retrieves the details of the number that was previously created. Supply the unique number code that was returned when you created it and Emil Api will return the corresponding number information.
84
+ * @summary Retrieve the number
85
+ * @param {string} code Unique identifier for the object.
86
+ * @param {string} expand
87
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
88
+ * @param {*} [options] Override http request option.
89
+ * @throws {RequiredError}
90
+ */
91
+ getNumber: async (code: string, expand: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
92
+ // verify required parameter 'code' is not null or undefined
93
+ assertParamExists('getNumber', 'code', code)
94
+ // verify required parameter 'expand' is not null or undefined
95
+ assertParamExists('getNumber', 'expand', expand)
96
+ const localVarPath = `/numbergenerator/v1/numbers/{code}`
97
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
98
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
99
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
100
+ let baseOptions;
101
+ let baseAccessToken;
102
+ if (configuration) {
103
+ baseOptions = configuration.baseOptions;
104
+ baseAccessToken = configuration.accessToken;
105
+ }
106
+
107
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
108
+ const localVarHeaderParameter = {} as any;
109
+ const localVarQueryParameter = {} as any;
110
+
111
+ // authentication bearer required
112
+ // http bearer authentication required
113
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
114
+
115
+ if (expand !== undefined) {
116
+ localVarQueryParameter['expand'] = expand;
117
+ }
118
+
119
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
120
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
121
+ }
122
+
123
+
124
+
125
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
126
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
127
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
128
+
129
+ return {
130
+ url: toPathString(localVarUrlObj),
131
+ options: localVarRequestOptions,
132
+ };
133
+ },
134
+ /**
135
+ * Returns a list of Numbers you have previously created. The Numbers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
136
+ * @summary List Numbers
137
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
138
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
139
+ * @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.
140
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
141
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
142
+ * @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.
143
+ * @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.
144
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ listNumbers: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
149
+ const localVarPath = `/numbergenerator/v1/numbers`;
150
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
151
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
152
+ let baseOptions;
153
+ let baseAccessToken;
154
+ if (configuration) {
155
+ baseOptions = configuration.baseOptions;
156
+ baseAccessToken = configuration.accessToken;
157
+ }
158
+
159
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
160
+ const localVarHeaderParameter = {} as any;
161
+ const localVarQueryParameter = {} as any;
162
+
163
+ // authentication bearer required
164
+ // http bearer authentication required
165
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
166
+
167
+ if (pageSize !== undefined) {
168
+ localVarQueryParameter['pageSize'] = pageSize;
169
+ }
170
+
171
+ if (pageToken !== undefined) {
172
+ localVarQueryParameter['pageToken'] = pageToken;
173
+ }
174
+
175
+ if (filter !== undefined) {
176
+ localVarQueryParameter['filter'] = filter;
177
+ }
178
+
179
+ if (search !== undefined) {
180
+ localVarQueryParameter['search'] = search;
181
+ }
182
+
183
+ if (order !== undefined) {
184
+ localVarQueryParameter['order'] = order;
185
+ }
186
+
187
+ if (expand !== undefined) {
188
+ localVarQueryParameter['expand'] = expand;
189
+ }
190
+
191
+ if (filters !== undefined) {
192
+ localVarQueryParameter['filters'] = filters;
193
+ }
194
+
195
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
196
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
197
+ }
198
+
199
+
200
+
201
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
202
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
203
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
204
+
205
+ return {
206
+ url: toPathString(localVarUrlObj),
207
+ options: localVarRequestOptions,
208
+ };
209
+ },
210
+ /**
211
+ * The endpoint performs a lookup based on an entity number to retrieve a unique string.
212
+ * @summary Lookup entity number
213
+ * @param {object} body
214
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
215
+ * @param {*} [options] Override http request option.
216
+ * @throws {RequiredError}
217
+ */
218
+ lookupNumber: async (body: object, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
219
+ // verify required parameter 'body' is not null or undefined
220
+ assertParamExists('lookupNumber', 'body', body)
221
+ const localVarPath = `/numbergenerator/v1/numbers/lookup`;
222
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
223
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
224
+ let baseOptions;
225
+ let baseAccessToken;
226
+ if (configuration) {
227
+ baseOptions = configuration.baseOptions;
228
+ baseAccessToken = configuration.accessToken;
229
+ }
230
+
231
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
232
+ const localVarHeaderParameter = {} as any;
233
+ const localVarQueryParameter = {} as any;
234
+
235
+ // authentication bearer required
236
+ // http bearer authentication required
237
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
238
+
239
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
240
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
241
+ }
242
+
243
+
244
+
245
+ localVarHeaderParameter['Content-Type'] = 'application/json';
246
+
247
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
248
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
249
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
250
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
251
+
252
+ return {
253
+ url: toPathString(localVarUrlObj),
254
+ options: localVarRequestOptions,
255
+ };
256
+ },
257
+ /**
258
+ * This endpoint facilitates the resetting of an entity number useful for sequence type numbers.
259
+ * @summary Reset entity number
260
+ * @param {object} body
261
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
262
+ * @param {*} [options] Override http request option.
263
+ * @throws {RequiredError}
264
+ */
265
+ resetNumber: async (body: object, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
266
+ // verify required parameter 'body' is not null or undefined
267
+ assertParamExists('resetNumber', 'body', body)
268
+ const localVarPath = `/numbergenerator/v1/numbers/reset`;
269
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
270
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
271
+ let baseOptions;
272
+ let baseAccessToken;
273
+ if (configuration) {
274
+ baseOptions = configuration.baseOptions;
275
+ baseAccessToken = configuration.accessToken;
276
+ }
277
+
278
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
279
+ const localVarHeaderParameter = {} as any;
280
+ const localVarQueryParameter = {} as any;
281
+
282
+ // authentication bearer required
283
+ // http bearer authentication required
284
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
285
+
286
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
287
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
288
+ }
289
+
290
+
291
+
292
+ localVarHeaderParameter['Content-Type'] = 'application/json';
293
+
294
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
295
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
296
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
297
+ localVarRequestOptions.data = serializeDataIfNeeded(body, localVarRequestOptions, configuration)
298
+
299
+ return {
300
+ url: toPathString(localVarUrlObj),
301
+ options: localVarRequestOptions,
302
+ };
303
+ },
304
+ /**
305
+ * This will update an entity number in the database.
306
+ * @summary Update the number
307
+ * @param {string} code Unique identifier for the object.
308
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
309
+ * @param {*} [options] Override http request option.
310
+ * @throws {RequiredError}
311
+ */
312
+ updateNumber: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
313
+ // verify required parameter 'code' is not null or undefined
314
+ assertParamExists('updateNumber', 'code', code)
315
+ const localVarPath = `/numbergenerator/v1/numbers/{code}`
316
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
317
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
318
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
319
+ let baseOptions;
320
+ let baseAccessToken;
321
+ if (configuration) {
322
+ baseOptions = configuration.baseOptions;
323
+ baseAccessToken = configuration.accessToken;
324
+ }
325
+
326
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
327
+ const localVarHeaderParameter = {} as any;
328
+ const localVarQueryParameter = {} as any;
329
+
330
+ // authentication bearer required
331
+ // http bearer authentication required
332
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
333
+
334
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
335
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
336
+ }
337
+
338
+
339
+
340
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
341
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
342
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
343
+
344
+ return {
345
+ url: toPathString(localVarUrlObj),
346
+ options: localVarRequestOptions,
347
+ };
348
+ },
349
+ }
350
+ };
351
+
352
+ /**
353
+ * NumbersApi - functional programming interface
354
+ * @export
355
+ */
356
+ export const NumbersApiFp = function(configuration?: Configuration) {
357
+ const localVarAxiosParamCreator = NumbersApiAxiosParamCreator(configuration)
358
+ return {
359
+ /**
360
+ * This will create an entity number in the database. Entity number is a way to generate unique numbers for your entities. You can create as many numbers as you want.
361
+ * @summary Create the number
362
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
363
+ * @param {*} [options] Override http request option.
364
+ * @throws {RequiredError}
365
+ */
366
+ async createNumber(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateNumberResponseClass>> {
367
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createNumber(authorization, options);
368
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
369
+ },
370
+ /**
371
+ * Retrieves the details of the number that was previously created. Supply the unique number code that was returned when you created it and Emil Api will return the corresponding number information.
372
+ * @summary Retrieve the number
373
+ * @param {string} code Unique identifier for the object.
374
+ * @param {string} expand
375
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
376
+ * @param {*} [options] Override http request option.
377
+ * @throws {RequiredError}
378
+ */
379
+ async getNumber(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetNumberResponseClass>> {
380
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getNumber(code, expand, authorization, options);
381
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
382
+ },
383
+ /**
384
+ * Returns a list of Numbers you have previously created. The Numbers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
385
+ * @summary List Numbers
386
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
387
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
388
+ * @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.
389
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
390
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
391
+ * @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.
392
+ * @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.
393
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
394
+ * @param {*} [options] Override http request option.
395
+ * @throws {RequiredError}
396
+ */
397
+ async listNumbers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNumbersResponseClass>> {
398
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listNumbers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
399
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
400
+ },
401
+ /**
402
+ * The endpoint performs a lookup based on an entity number to retrieve a unique string.
403
+ * @summary Lookup entity number
404
+ * @param {object} body
405
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
406
+ * @param {*} [options] Override http request option.
407
+ * @throws {RequiredError}
408
+ */
409
+ async lookupNumber(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
410
+ const localVarAxiosArgs = await localVarAxiosParamCreator.lookupNumber(body, authorization, options);
411
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
412
+ },
413
+ /**
414
+ * This endpoint facilitates the resetting of an entity number useful for sequence type numbers.
415
+ * @summary Reset entity number
416
+ * @param {object} body
417
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
418
+ * @param {*} [options] Override http request option.
419
+ * @throws {RequiredError}
420
+ */
421
+ async resetNumber(body: object, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
422
+ const localVarAxiosArgs = await localVarAxiosParamCreator.resetNumber(body, authorization, options);
423
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
424
+ },
425
+ /**
426
+ * This will update an entity number in the database.
427
+ * @summary Update the number
428
+ * @param {string} code Unique identifier for the object.
429
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
430
+ * @param {*} [options] Override http request option.
431
+ * @throws {RequiredError}
432
+ */
433
+ async updateNumber(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateNumberResponseClass>> {
434
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateNumber(code, authorization, options);
435
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
436
+ },
437
+ }
438
+ };
439
+
440
+ /**
441
+ * NumbersApi - factory interface
442
+ * @export
443
+ */
444
+ export const NumbersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
445
+ const localVarFp = NumbersApiFp(configuration)
446
+ return {
447
+ /**
448
+ * This will create an entity number in the database. Entity number is a way to generate unique numbers for your entities. You can create as many numbers as you want.
449
+ * @summary Create the number
450
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
451
+ * @param {*} [options] Override http request option.
452
+ * @throws {RequiredError}
453
+ */
454
+ createNumber(authorization?: string, options?: any): AxiosPromise<CreateNumberResponseClass> {
455
+ return localVarFp.createNumber(authorization, options).then((request) => request(axios, basePath));
456
+ },
457
+ /**
458
+ * Retrieves the details of the number that was previously created. Supply the unique number code that was returned when you created it and Emil Api will return the corresponding number information.
459
+ * @summary Retrieve the number
460
+ * @param {string} code Unique identifier for the object.
461
+ * @param {string} expand
462
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
463
+ * @param {*} [options] Override http request option.
464
+ * @throws {RequiredError}
465
+ */
466
+ getNumber(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetNumberResponseClass> {
467
+ return localVarFp.getNumber(code, expand, authorization, options).then((request) => request(axios, basePath));
468
+ },
469
+ /**
470
+ * Returns a list of Numbers you have previously created. The Numbers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
471
+ * @summary List Numbers
472
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
473
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
474
+ * @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.
475
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
476
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
477
+ * @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.
478
+ * @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.
479
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
480
+ * @param {*} [options] Override http request option.
481
+ * @throws {RequiredError}
482
+ */
483
+ listNumbers(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListNumbersResponseClass> {
484
+ return localVarFp.listNumbers(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
485
+ },
486
+ /**
487
+ * The endpoint performs a lookup based on an entity number to retrieve a unique string.
488
+ * @summary Lookup entity number
489
+ * @param {object} body
490
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
491
+ * @param {*} [options] Override http request option.
492
+ * @throws {RequiredError}
493
+ */
494
+ lookupNumber(body: object, authorization?: string, options?: any): AxiosPromise<void> {
495
+ return localVarFp.lookupNumber(body, authorization, options).then((request) => request(axios, basePath));
496
+ },
497
+ /**
498
+ * This endpoint facilitates the resetting of an entity number useful for sequence type numbers.
499
+ * @summary Reset entity number
500
+ * @param {object} body
501
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
502
+ * @param {*} [options] Override http request option.
503
+ * @throws {RequiredError}
504
+ */
505
+ resetNumber(body: object, authorization?: string, options?: any): AxiosPromise<void> {
506
+ return localVarFp.resetNumber(body, authorization, options).then((request) => request(axios, basePath));
507
+ },
508
+ /**
509
+ * This will update an entity number in the database.
510
+ * @summary Update the number
511
+ * @param {string} code Unique identifier for the object.
512
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
513
+ * @param {*} [options] Override http request option.
514
+ * @throws {RequiredError}
515
+ */
516
+ updateNumber(code: string, authorization?: string, options?: any): AxiosPromise<UpdateNumberResponseClass> {
517
+ return localVarFp.updateNumber(code, authorization, options).then((request) => request(axios, basePath));
518
+ },
519
+ };
520
+ };
521
+
522
+ /**
523
+ * Request parameters for createNumber operation in NumbersApi.
524
+ * @export
525
+ * @interface NumbersApiCreateNumberRequest
526
+ */
527
+ export interface NumbersApiCreateNumberRequest {
528
+ /**
529
+ * Bearer Token: provided by the login endpoint under the name accessToken.
530
+ * @type {string}
531
+ * @memberof NumbersApiCreateNumber
532
+ */
533
+ readonly authorization?: string
534
+ }
535
+
536
+ /**
537
+ * Request parameters for getNumber operation in NumbersApi.
538
+ * @export
539
+ * @interface NumbersApiGetNumberRequest
540
+ */
541
+ export interface NumbersApiGetNumberRequest {
542
+ /**
543
+ * Unique identifier for the object.
544
+ * @type {string}
545
+ * @memberof NumbersApiGetNumber
546
+ */
547
+ readonly code: string
548
+
549
+ /**
550
+ *
551
+ * @type {string}
552
+ * @memberof NumbersApiGetNumber
553
+ */
554
+ readonly expand: string
555
+
556
+ /**
557
+ * Bearer Token: provided by the login endpoint under the name accessToken.
558
+ * @type {string}
559
+ * @memberof NumbersApiGetNumber
560
+ */
561
+ readonly authorization?: string
562
+ }
563
+
564
+ /**
565
+ * Request parameters for listNumbers operation in NumbersApi.
566
+ * @export
567
+ * @interface NumbersApiListNumbersRequest
568
+ */
569
+ export interface NumbersApiListNumbersRequest {
570
+ /**
571
+ * Bearer Token: provided by the login endpoint under the name accessToken.
572
+ * @type {string}
573
+ * @memberof NumbersApiListNumbers
574
+ */
575
+ readonly authorization?: string
576
+
577
+ /**
578
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
579
+ * @type {number}
580
+ * @memberof NumbersApiListNumbers
581
+ */
582
+ readonly pageSize?: number
583
+
584
+ /**
585
+ * 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.
586
+ * @type {string}
587
+ * @memberof NumbersApiListNumbers
588
+ */
589
+ readonly pageToken?: string
590
+
591
+ /**
592
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
593
+ * @type {string}
594
+ * @memberof NumbersApiListNumbers
595
+ */
596
+ readonly filter?: string
597
+
598
+ /**
599
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
600
+ * @type {string}
601
+ * @memberof NumbersApiListNumbers
602
+ */
603
+ readonly search?: string
604
+
605
+ /**
606
+ * 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.
607
+ * @type {string}
608
+ * @memberof NumbersApiListNumbers
609
+ */
610
+ readonly order?: string
611
+
612
+ /**
613
+ * 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.
614
+ * @type {string}
615
+ * @memberof NumbersApiListNumbers
616
+ */
617
+ readonly expand?: string
618
+
619
+ /**
620
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
621
+ * @type {string}
622
+ * @memberof NumbersApiListNumbers
623
+ */
624
+ readonly filters?: string
625
+ }
626
+
627
+ /**
628
+ * Request parameters for lookupNumber operation in NumbersApi.
629
+ * @export
630
+ * @interface NumbersApiLookupNumberRequest
631
+ */
632
+ export interface NumbersApiLookupNumberRequest {
633
+ /**
634
+ *
635
+ * @type {object}
636
+ * @memberof NumbersApiLookupNumber
637
+ */
638
+ readonly body: object
639
+
640
+ /**
641
+ * Bearer Token: provided by the login endpoint under the name accessToken.
642
+ * @type {string}
643
+ * @memberof NumbersApiLookupNumber
644
+ */
645
+ readonly authorization?: string
646
+ }
647
+
648
+ /**
649
+ * Request parameters for resetNumber operation in NumbersApi.
650
+ * @export
651
+ * @interface NumbersApiResetNumberRequest
652
+ */
653
+ export interface NumbersApiResetNumberRequest {
654
+ /**
655
+ *
656
+ * @type {object}
657
+ * @memberof NumbersApiResetNumber
658
+ */
659
+ readonly body: object
660
+
661
+ /**
662
+ * Bearer Token: provided by the login endpoint under the name accessToken.
663
+ * @type {string}
664
+ * @memberof NumbersApiResetNumber
665
+ */
666
+ readonly authorization?: string
667
+ }
668
+
669
+ /**
670
+ * Request parameters for updateNumber operation in NumbersApi.
671
+ * @export
672
+ * @interface NumbersApiUpdateNumberRequest
673
+ */
674
+ export interface NumbersApiUpdateNumberRequest {
675
+ /**
676
+ * Unique identifier for the object.
677
+ * @type {string}
678
+ * @memberof NumbersApiUpdateNumber
679
+ */
680
+ readonly code: string
681
+
682
+ /**
683
+ * Bearer Token: provided by the login endpoint under the name accessToken.
684
+ * @type {string}
685
+ * @memberof NumbersApiUpdateNumber
686
+ */
687
+ readonly authorization?: string
688
+ }
689
+
690
+ /**
691
+ * NumbersApi - object-oriented interface
692
+ * @export
693
+ * @class NumbersApi
694
+ * @extends {BaseAPI}
695
+ */
696
+ export class NumbersApi extends BaseAPI {
697
+ /**
698
+ * This will create an entity number in the database. Entity number is a way to generate unique numbers for your entities. You can create as many numbers as you want.
699
+ * @summary Create the number
700
+ * @param {NumbersApiCreateNumberRequest} requestParameters Request parameters.
701
+ * @param {*} [options] Override http request option.
702
+ * @throws {RequiredError}
703
+ * @memberof NumbersApi
704
+ */
705
+ public createNumber(requestParameters: NumbersApiCreateNumberRequest = {}, options?: AxiosRequestConfig) {
706
+ return NumbersApiFp(this.configuration).createNumber(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
707
+ }
708
+
709
+ /**
710
+ * Retrieves the details of the number that was previously created. Supply the unique number code that was returned when you created it and Emil Api will return the corresponding number information.
711
+ * @summary Retrieve the number
712
+ * @param {NumbersApiGetNumberRequest} requestParameters Request parameters.
713
+ * @param {*} [options] Override http request option.
714
+ * @throws {RequiredError}
715
+ * @memberof NumbersApi
716
+ */
717
+ public getNumber(requestParameters: NumbersApiGetNumberRequest, options?: AxiosRequestConfig) {
718
+ return NumbersApiFp(this.configuration).getNumber(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
719
+ }
720
+
721
+ /**
722
+ * Returns a list of Numbers you have previously created. The Numbers are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
723
+ * @summary List Numbers
724
+ * @param {NumbersApiListNumbersRequest} requestParameters Request parameters.
725
+ * @param {*} [options] Override http request option.
726
+ * @throws {RequiredError}
727
+ * @memberof NumbersApi
728
+ */
729
+ public listNumbers(requestParameters: NumbersApiListNumbersRequest = {}, options?: AxiosRequestConfig) {
730
+ return NumbersApiFp(this.configuration).listNumbers(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
731
+ }
732
+
733
+ /**
734
+ * The endpoint performs a lookup based on an entity number to retrieve a unique string.
735
+ * @summary Lookup entity number
736
+ * @param {NumbersApiLookupNumberRequest} requestParameters Request parameters.
737
+ * @param {*} [options] Override http request option.
738
+ * @throws {RequiredError}
739
+ * @memberof NumbersApi
740
+ */
741
+ public lookupNumber(requestParameters: NumbersApiLookupNumberRequest, options?: AxiosRequestConfig) {
742
+ return NumbersApiFp(this.configuration).lookupNumber(requestParameters.body, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
743
+ }
744
+
745
+ /**
746
+ * This endpoint facilitates the resetting of an entity number useful for sequence type numbers.
747
+ * @summary Reset entity number
748
+ * @param {NumbersApiResetNumberRequest} requestParameters Request parameters.
749
+ * @param {*} [options] Override http request option.
750
+ * @throws {RequiredError}
751
+ * @memberof NumbersApi
752
+ */
753
+ public resetNumber(requestParameters: NumbersApiResetNumberRequest, options?: AxiosRequestConfig) {
754
+ return NumbersApiFp(this.configuration).resetNumber(requestParameters.body, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
755
+ }
756
+
757
+ /**
758
+ * This will update an entity number in the database.
759
+ * @summary Update the number
760
+ * @param {NumbersApiUpdateNumberRequest} requestParameters Request parameters.
761
+ * @param {*} [options] Override http request option.
762
+ * @throws {RequiredError}
763
+ * @memberof NumbersApi
764
+ */
765
+ public updateNumber(requestParameters: NumbersApiUpdateNumberRequest, options?: AxiosRequestConfig) {
766
+ return NumbersApiFp(this.configuration).updateNumber(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
767
+ }
768
+ }