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