@emilgroup/accounting-sdk-node 1.0.1-beta.3 → 1.0.1-beta.5

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.
@@ -25,6 +25,7 @@ models/get-financial-account-response-class.ts
25
25
  models/index.ts
26
26
  models/inline-response200.ts
27
27
  models/inline-response503.ts
28
+ models/list-booking-process-response-class.ts
28
29
  models/list-financial-accounts-response-class.ts
29
30
  package.json
30
31
  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/accounting-sdk-node@1.0.1-beta.3 --save
20
+ npm install @emilgroup/accounting-sdk-node@1.0.1-beta.5 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/accounting-sdk-node@1.0.1-beta.3
24
+ yarn add @emilgroup/accounting-sdk-node@1.0.1-beta.5
25
25
  ```
26
26
 
27
27
  And then you can import `FinancialAccountsApi`.
@@ -24,6 +24,8 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
24
24
  import { CreateBookingProcessRequestDto } from '../models';
25
25
  // @ts-ignore
26
26
  import { CreateBookingProcessResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { ListBookingProcessResponseClass } from '../models';
27
29
  // URLSearchParams not necessarily used
28
30
  // @ts-ignore
29
31
  import { URL, URLSearchParams } from 'url';
@@ -35,7 +37,7 @@ const FormData = require('form-data');
35
37
  export const BookingProcessesApiAxiosParamCreator = function (configuration?: Configuration) {
36
38
  return {
37
39
  /**
38
- * This will create an account in the database. The account will be created with the provided name, type, and account number. Optionally, you can provide a parent account ID to create a sub-account.
40
+ * This endpoint creates a new booking process.
39
41
  * @summary Create the booking process
40
42
  * @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto
41
43
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -76,6 +78,82 @@ export const BookingProcessesApiAxiosParamCreator = function (configuration?: Co
76
78
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
77
79
  localVarRequestOptions.data = serializeDataIfNeeded(createBookingProcessRequestDto, localVarRequestOptions, configuration)
78
80
 
81
+ return {
82
+ url: toPathString(localVarUrlObj),
83
+ options: localVarRequestOptions,
84
+ };
85
+ },
86
+ /**
87
+ * Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
88
+ * @summary List Booking processes
89
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
90
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
91
+ * @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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
92
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: code</i>
93
+ * @param {any} [search] To search the list by any field, pass search=xxx to fetch the result.
94
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, updatedAt, createdAt</i>
95
+ * @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.
96
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: code</i>
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ listBookingProcesses: async (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
101
+ const localVarPath = `/accountingservice/v1/booking-processes`;
102
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
103
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
104
+ let baseOptions;
105
+ let baseAccessToken;
106
+ if (configuration) {
107
+ baseOptions = configuration.baseOptions;
108
+ baseAccessToken = configuration.accessToken;
109
+ }
110
+
111
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
112
+ const localVarHeaderParameter = {} as any;
113
+ const localVarQueryParameter = {} as any;
114
+
115
+ // authentication bearer required
116
+ // http bearer authentication required
117
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
118
+
119
+ if (pageSize !== undefined) {
120
+ localVarQueryParameter['pageSize'] = pageSize;
121
+ }
122
+
123
+ if (pageToken !== undefined) {
124
+ localVarQueryParameter['pageToken'] = pageToken;
125
+ }
126
+
127
+ if (filter !== undefined) {
128
+ localVarQueryParameter['filter'] = filter;
129
+ }
130
+
131
+ if (search !== undefined) {
132
+ localVarQueryParameter['search'] = search;
133
+ }
134
+
135
+ if (order !== undefined) {
136
+ localVarQueryParameter['order'] = order;
137
+ }
138
+
139
+ if (expand !== undefined) {
140
+ localVarQueryParameter['expand'] = expand;
141
+ }
142
+
143
+ if (filters !== undefined) {
144
+ localVarQueryParameter['filters'] = filters;
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
+
79
157
  return {
80
158
  url: toPathString(localVarUrlObj),
81
159
  options: localVarRequestOptions,
@@ -92,7 +170,7 @@ export const BookingProcessesApiFp = function(configuration?: Configuration) {
92
170
  const localVarAxiosParamCreator = BookingProcessesApiAxiosParamCreator(configuration)
93
171
  return {
94
172
  /**
95
- * This will create an account in the database. The account will be created with the provided name, type, and account number. Optionally, you can provide a parent account ID to create a sub-account.
173
+ * This endpoint creates a new booking process.
96
174
  * @summary Create the booking process
97
175
  * @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto
98
176
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -103,6 +181,24 @@ export const BookingProcessesApiFp = function(configuration?: Configuration) {
103
181
  const localVarAxiosArgs = await localVarAxiosParamCreator.createBookingProcess(createBookingProcessRequestDto, authorization, options);
104
182
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
105
183
  },
184
+ /**
185
+ * Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
186
+ * @summary List Booking processes
187
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
188
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
189
+ * @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.
190
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
191
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
192
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
193
+ * @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.
194
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ */
198
+ async listBookingProcesses(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBookingProcessResponseClass>> {
199
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listBookingProcesses(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
200
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
201
+ },
106
202
  }
107
203
  };
108
204
 
@@ -114,7 +210,7 @@ export const BookingProcessesApiFactory = function (configuration?: Configuratio
114
210
  const localVarFp = BookingProcessesApiFp(configuration)
115
211
  return {
116
212
  /**
117
- * This will create an account in the database. The account will be created with the provided name, type, and account number. Optionally, you can provide a parent account ID to create a sub-account.
213
+ * This endpoint creates a new booking process.
118
214
  * @summary Create the booking process
119
215
  * @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto
120
216
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -124,6 +220,23 @@ export const BookingProcessesApiFactory = function (configuration?: Configuratio
124
220
  createBookingProcess(createBookingProcessRequestDto: CreateBookingProcessRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBookingProcessResponseClass> {
125
221
  return localVarFp.createBookingProcess(createBookingProcessRequestDto, authorization, options).then((request) => request(axios, basePath));
126
222
  },
223
+ /**
224
+ * Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
225
+ * @summary List Booking processes
226
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
227
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
228
+ * @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.
229
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
230
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
231
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
232
+ * @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.
233
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
234
+ * @param {*} [options] Override http request option.
235
+ * @throws {RequiredError}
236
+ */
237
+ listBookingProcesses(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: any): AxiosPromise<ListBookingProcessResponseClass> {
238
+ return localVarFp.listBookingProcesses(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
239
+ },
127
240
  };
128
241
  };
129
242
 
@@ -148,6 +261,69 @@ export interface BookingProcessesApiCreateBookingProcessRequest {
148
261
  readonly authorization?: string
149
262
  }
150
263
 
264
+ /**
265
+ * Request parameters for listBookingProcesses operation in BookingProcessesApi.
266
+ * @export
267
+ * @interface BookingProcessesApiListBookingProcessesRequest
268
+ */
269
+ export interface BookingProcessesApiListBookingProcessesRequest {
270
+ /**
271
+ * Bearer Token: provided by the login endpoint under the name accessToken.
272
+ * @type {string}
273
+ * @memberof BookingProcessesApiListBookingProcesses
274
+ */
275
+ readonly authorization?: string
276
+
277
+ /**
278
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
279
+ * @type {any}
280
+ * @memberof BookingProcessesApiListBookingProcesses
281
+ */
282
+ readonly pageSize?: any
283
+
284
+ /**
285
+ * 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.
286
+ * @type {any}
287
+ * @memberof BookingProcessesApiListBookingProcesses
288
+ */
289
+ readonly pageToken?: any
290
+
291
+ /**
292
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
293
+ * @type {string}
294
+ * @memberof BookingProcessesApiListBookingProcesses
295
+ */
296
+ readonly filter?: string
297
+
298
+ /**
299
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
300
+ * @type {any}
301
+ * @memberof BookingProcessesApiListBookingProcesses
302
+ */
303
+ readonly search?: any
304
+
305
+ /**
306
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
307
+ * @type {string}
308
+ * @memberof BookingProcessesApiListBookingProcesses
309
+ */
310
+ readonly order?: string
311
+
312
+ /**
313
+ * 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.
314
+ * @type {any}
315
+ * @memberof BookingProcessesApiListBookingProcesses
316
+ */
317
+ readonly expand?: any
318
+
319
+ /**
320
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
321
+ * @type {string}
322
+ * @memberof BookingProcessesApiListBookingProcesses
323
+ */
324
+ readonly filters?: string
325
+ }
326
+
151
327
  /**
152
328
  * BookingProcessesApi - object-oriented interface
153
329
  * @export
@@ -156,7 +332,7 @@ export interface BookingProcessesApiCreateBookingProcessRequest {
156
332
  */
157
333
  export class BookingProcessesApi extends BaseAPI {
158
334
  /**
159
- * This will create an account in the database. The account will be created with the provided name, type, and account number. Optionally, you can provide a parent account ID to create a sub-account.
335
+ * This endpoint creates a new booking process.
160
336
  * @summary Create the booking process
161
337
  * @param {BookingProcessesApiCreateBookingProcessRequest} requestParameters Request parameters.
162
338
  * @param {*} [options] Override http request option.
@@ -166,4 +342,16 @@ export class BookingProcessesApi extends BaseAPI {
166
342
  public createBookingProcess(requestParameters: BookingProcessesApiCreateBookingProcessRequest, options?: AxiosRequestConfig) {
167
343
  return BookingProcessesApiFp(this.configuration).createBookingProcess(requestParameters.createBookingProcessRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
168
344
  }
345
+
346
+ /**
347
+ * Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
348
+ * @summary List Booking processes
349
+ * @param {BookingProcessesApiListBookingProcessesRequest} requestParameters Request parameters.
350
+ * @param {*} [options] Override http request option.
351
+ * @throws {RequiredError}
352
+ * @memberof BookingProcessesApi
353
+ */
354
+ public listBookingProcesses(requestParameters: BookingProcessesApiListBookingProcessesRequest = {}, options?: AxiosRequestConfig) {
355
+ return BookingProcessesApiFp(this.configuration).listBookingProcesses(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
356
+ }
169
357
  }
package/base.ts CHANGED
@@ -41,7 +41,7 @@ export const COLLECTION_FORMATS = {
41
41
 
42
42
  export interface LoginClass {
43
43
  accessToken: string;
44
- permissions: Array<string>;
44
+ permissions: string;
45
45
  }
46
46
 
47
47
  export enum Environment {
@@ -79,7 +79,7 @@ export class BaseAPI {
79
79
  protected configuration: Configuration;
80
80
  private username?: string;
81
81
  private password?: string;
82
- private permissions: Array<string> = [];
82
+ private permissions?: string;
83
83
 
84
84
  constructor(configuration?: Configuration, protected basePath: string = BASE_PATH, protected axios: AxiosInstance = globalAxios) {
85
85
  if (configuration) {
@@ -151,7 +151,7 @@ export class BaseAPI {
151
151
  }
152
152
 
153
153
  getPermissions(): Array<string> {
154
- return this.permissions;
154
+ return this.permissions.split(',');
155
155
  }
156
156
 
157
157
  async authorize(username: string, password: string): Promise<void> {
@@ -14,13 +14,14 @@ import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateBookingProcessRequestDto } from '../models';
16
16
  import { CreateBookingProcessResponseClass } from '../models';
17
+ import { ListBookingProcessResponseClass } from '../models';
17
18
  /**
18
19
  * BookingProcessesApi - axios parameter creator
19
20
  * @export
20
21
  */
21
22
  export declare const BookingProcessesApiAxiosParamCreator: (configuration?: Configuration) => {
22
23
  /**
23
- * This will create an account in the database. The account will be created with the provided name, type, and account number. Optionally, you can provide a parent account ID to create a sub-account.
24
+ * This endpoint creates a new booking process.
24
25
  * @summary Create the booking process
25
26
  * @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto
26
27
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -28,6 +29,21 @@ export declare const BookingProcessesApiAxiosParamCreator: (configuration?: Conf
28
29
  * @throws {RequiredError}
29
30
  */
30
31
  createBookingProcess: (createBookingProcessRequestDto: CreateBookingProcessRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
32
+ /**
33
+ * Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
34
+ * @summary List Booking processes
35
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
36
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
37
+ * @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.
38
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
39
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
40
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
41
+ * @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.
42
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
43
+ * @param {*} [options] Override http request option.
44
+ * @throws {RequiredError}
45
+ */
46
+ listBookingProcesses: (authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
47
  };
32
48
  /**
33
49
  * BookingProcessesApi - functional programming interface
@@ -35,7 +51,7 @@ export declare const BookingProcessesApiAxiosParamCreator: (configuration?: Conf
35
51
  */
36
52
  export declare const BookingProcessesApiFp: (configuration?: Configuration) => {
37
53
  /**
38
- * This will create an account in the database. The account will be created with the provided name, type, and account number. Optionally, you can provide a parent account ID to create a sub-account.
54
+ * This endpoint creates a new booking process.
39
55
  * @summary Create the booking process
40
56
  * @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto
41
57
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -43,6 +59,21 @@ export declare const BookingProcessesApiFp: (configuration?: Configuration) => {
43
59
  * @throws {RequiredError}
44
60
  */
45
61
  createBookingProcess(createBookingProcessRequestDto: CreateBookingProcessRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBookingProcessResponseClass>>;
62
+ /**
63
+ * Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
64
+ * @summary List Booking processes
65
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
66
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
67
+ * @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.
68
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
69
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
70
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
71
+ * @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.
72
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
73
+ * @param {*} [options] Override http request option.
74
+ * @throws {RequiredError}
75
+ */
76
+ listBookingProcesses(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBookingProcessResponseClass>>;
46
77
  };
47
78
  /**
48
79
  * BookingProcessesApi - factory interface
@@ -50,7 +81,7 @@ export declare const BookingProcessesApiFp: (configuration?: Configuration) => {
50
81
  */
51
82
  export declare const BookingProcessesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
52
83
  /**
53
- * This will create an account in the database. The account will be created with the provided name, type, and account number. Optionally, you can provide a parent account ID to create a sub-account.
84
+ * This endpoint creates a new booking process.
54
85
  * @summary Create the booking process
55
86
  * @param {CreateBookingProcessRequestDto} createBookingProcessRequestDto
56
87
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
@@ -58,6 +89,21 @@ export declare const BookingProcessesApiFactory: (configuration?: Configuration,
58
89
  * @throws {RequiredError}
59
90
  */
60
91
  createBookingProcess(createBookingProcessRequestDto: CreateBookingProcessRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBookingProcessResponseClass>;
92
+ /**
93
+ * Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
94
+ * @summary List Booking processes
95
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
96
+ * @param {any} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
97
+ * @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.
98
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
99
+ * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
100
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
101
+ * @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.
102
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ listBookingProcesses(authorization?: string, pageSize?: any, pageToken?: any, filter?: string, search?: any, order?: string, expand?: any, filters?: string, options?: any): AxiosPromise<ListBookingProcessResponseClass>;
61
107
  };
62
108
  /**
63
109
  * Request parameters for createBookingProcess operation in BookingProcessesApi.
@@ -78,6 +124,61 @@ export interface BookingProcessesApiCreateBookingProcessRequest {
78
124
  */
79
125
  readonly authorization?: string;
80
126
  }
127
+ /**
128
+ * Request parameters for listBookingProcesses operation in BookingProcessesApi.
129
+ * @export
130
+ * @interface BookingProcessesApiListBookingProcessesRequest
131
+ */
132
+ export interface BookingProcessesApiListBookingProcessesRequest {
133
+ /**
134
+ * Bearer Token: provided by the login endpoint under the name accessToken.
135
+ * @type {string}
136
+ * @memberof BookingProcessesApiListBookingProcesses
137
+ */
138
+ readonly authorization?: string;
139
+ /**
140
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
141
+ * @type {any}
142
+ * @memberof BookingProcessesApiListBookingProcesses
143
+ */
144
+ readonly pageSize?: any;
145
+ /**
146
+ * 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.
147
+ * @type {any}
148
+ * @memberof BookingProcessesApiListBookingProcesses
149
+ */
150
+ readonly pageToken?: any;
151
+ /**
152
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
153
+ * @type {string}
154
+ * @memberof BookingProcessesApiListBookingProcesses
155
+ */
156
+ readonly filter?: string;
157
+ /**
158
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
159
+ * @type {any}
160
+ * @memberof BookingProcessesApiListBookingProcesses
161
+ */
162
+ readonly search?: any;
163
+ /**
164
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, updatedAt, createdAt&lt;/i&gt;
165
+ * @type {string}
166
+ * @memberof BookingProcessesApiListBookingProcesses
167
+ */
168
+ readonly order?: string;
169
+ /**
170
+ * 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.
171
+ * @type {any}
172
+ * @memberof BookingProcessesApiListBookingProcesses
173
+ */
174
+ readonly expand?: any;
175
+ /**
176
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: code&lt;/i&gt;
177
+ * @type {string}
178
+ * @memberof BookingProcessesApiListBookingProcesses
179
+ */
180
+ readonly filters?: string;
181
+ }
81
182
  /**
82
183
  * BookingProcessesApi - object-oriented interface
83
184
  * @export
@@ -86,7 +187,7 @@ export interface BookingProcessesApiCreateBookingProcessRequest {
86
187
  */
87
188
  export declare class BookingProcessesApi extends BaseAPI {
88
189
  /**
89
- * This will create an account in the database. The account will be created with the provided name, type, and account number. Optionally, you can provide a parent account ID to create a sub-account.
190
+ * This endpoint creates a new booking process.
90
191
  * @summary Create the booking process
91
192
  * @param {BookingProcessesApiCreateBookingProcessRequest} requestParameters Request parameters.
92
193
  * @param {*} [options] Override http request option.
@@ -94,4 +195,13 @@ export declare class BookingProcessesApi extends BaseAPI {
94
195
  * @memberof BookingProcessesApi
95
196
  */
96
197
  createBookingProcess(requestParameters: BookingProcessesApiCreateBookingProcessRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBookingProcessResponseClass, any>>;
198
+ /**
199
+ * Returns a list of Booking processes you have previously created. The Booking processes are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
200
+ * @summary List Booking processes
201
+ * @param {BookingProcessesApiListBookingProcessesRequest} requestParameters Request parameters.
202
+ * @param {*} [options] Override http request option.
203
+ * @throws {RequiredError}
204
+ * @memberof BookingProcessesApi
205
+ */
206
+ listBookingProcesses(requestParameters?: BookingProcessesApiListBookingProcessesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBookingProcessResponseClass, any>>;
97
207
  }