@emilgroup/task-sdk-node 1.0.1-beta.5 → 1.0.1-beta.7
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.
- package/README.md +2 -2
- package/api/tasks-api.ts +45 -17
- package/dist/api/tasks-api.d.ts +28 -10
- package/dist/api/tasks-api.js +24 -12
- package/package.json +1 -1
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/task-sdk-node@1.0.1-beta.
|
|
20
|
+
npm install @emilgroup/task-sdk-node@1.0.1-beta.7 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/task-sdk-node@1.0.1-beta.
|
|
24
|
+
yarn add @emilgroup/task-sdk-node@1.0.1-beta.7
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `TasksApi`.
|
package/api/tasks-api.ts
CHANGED
|
@@ -190,15 +190,17 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
190
190
|
* Retrieves a list of tasks.
|
|
191
191
|
* @summary List tasks
|
|
192
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
193
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
194
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
193
195
|
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
194
|
-
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
195
196
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
196
197
|
* @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, createdAt, updatedAt, assignee, reporter, dueDate</i>
|
|
197
198
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: category, status<i>
|
|
199
|
+
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
198
200
|
* @param {*} [options] Override http request option.
|
|
199
201
|
* @throws {RequiredError}
|
|
200
202
|
*/
|
|
201
|
-
listTasks: async (authorization?: string,
|
|
203
|
+
listTasks: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
202
204
|
const localVarPath = `/taskservice/v1/tasks`;
|
|
203
205
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
204
206
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -217,12 +219,16 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
217
219
|
// http bearer authentication required
|
|
218
220
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
219
221
|
|
|
220
|
-
if (
|
|
221
|
-
localVarQueryParameter['
|
|
222
|
+
if (pageSize !== undefined) {
|
|
223
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
222
224
|
}
|
|
223
225
|
|
|
224
|
-
if (
|
|
225
|
-
localVarQueryParameter['
|
|
226
|
+
if (pageToken !== undefined) {
|
|
227
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
if (filter !== undefined) {
|
|
231
|
+
localVarQueryParameter['filter'] = filter;
|
|
226
232
|
}
|
|
227
233
|
|
|
228
234
|
if (search !== undefined) {
|
|
@@ -237,6 +243,10 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
237
243
|
localVarQueryParameter['expand'] = expand;
|
|
238
244
|
}
|
|
239
245
|
|
|
246
|
+
if (filters !== undefined) {
|
|
247
|
+
localVarQueryParameter['filters'] = filters;
|
|
248
|
+
}
|
|
249
|
+
|
|
240
250
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
241
251
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
242
252
|
}
|
|
@@ -354,16 +364,18 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
354
364
|
* Retrieves a list of tasks.
|
|
355
365
|
* @summary List tasks
|
|
356
366
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
368
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
357
369
|
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
358
|
-
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
359
370
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
360
371
|
* @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, createdAt, updatedAt, assignee, reporter, dueDate</i>
|
|
361
372
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: category, status<i>
|
|
373
|
+
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
362
374
|
* @param {*} [options] Override http request option.
|
|
363
375
|
* @throws {RequiredError}
|
|
364
376
|
*/
|
|
365
|
-
async listTasks(authorization?: string,
|
|
366
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization,
|
|
377
|
+
async listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>> {
|
|
378
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
367
379
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
368
380
|
},
|
|
369
381
|
/**
|
|
@@ -427,16 +439,18 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
427
439
|
* Retrieves a list of tasks.
|
|
428
440
|
* @summary List tasks
|
|
429
441
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
443
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
430
444
|
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
431
|
-
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
432
445
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
433
446
|
* @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, createdAt, updatedAt, assignee, reporter, dueDate</i>
|
|
434
447
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: category, status<i>
|
|
448
|
+
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
435
449
|
* @param {*} [options] Override http request option.
|
|
436
450
|
* @throws {RequiredError}
|
|
437
451
|
*/
|
|
438
|
-
listTasks(authorization?: string,
|
|
439
|
-
return localVarFp.listTasks(authorization,
|
|
452
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass> {
|
|
453
|
+
return localVarFp.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
440
454
|
},
|
|
441
455
|
/**
|
|
442
456
|
* This will partially update a task by code with the provided fields.
|
|
@@ -537,18 +551,25 @@ export interface TasksApiListTasksRequest {
|
|
|
537
551
|
readonly authorization?: string
|
|
538
552
|
|
|
539
553
|
/**
|
|
540
|
-
*
|
|
554
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
555
|
+
* @type {number}
|
|
556
|
+
* @memberof TasksApiListTasks
|
|
557
|
+
*/
|
|
558
|
+
readonly pageSize?: number
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* 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.
|
|
541
562
|
* @type {string}
|
|
542
563
|
* @memberof TasksApiListTasks
|
|
543
564
|
*/
|
|
544
|
-
readonly
|
|
565
|
+
readonly pageToken?: string
|
|
545
566
|
|
|
546
567
|
/**
|
|
547
|
-
*
|
|
568
|
+
* 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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
548
569
|
* @type {string}
|
|
549
570
|
* @memberof TasksApiListTasks
|
|
550
571
|
*/
|
|
551
|
-
readonly
|
|
572
|
+
readonly filter?: string
|
|
552
573
|
|
|
553
574
|
/**
|
|
554
575
|
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
@@ -570,6 +591,13 @@ export interface TasksApiListTasksRequest {
|
|
|
570
591
|
* @memberof TasksApiListTasks
|
|
571
592
|
*/
|
|
572
593
|
readonly expand?: string
|
|
594
|
+
|
|
595
|
+
/**
|
|
596
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
597
|
+
* @type {string}
|
|
598
|
+
* @memberof TasksApiListTasks
|
|
599
|
+
*/
|
|
600
|
+
readonly filters?: string
|
|
573
601
|
}
|
|
574
602
|
|
|
575
603
|
/**
|
|
@@ -652,7 +680,7 @@ export class TasksApi extends BaseAPI {
|
|
|
652
680
|
* @memberof TasksApi
|
|
653
681
|
*/
|
|
654
682
|
public listTasks(requestParameters: TasksApiListTasksRequest = {}, options?: AxiosRequestConfig) {
|
|
655
|
-
return TasksApiFp(this.configuration).listTasks(requestParameters.authorization, requestParameters.
|
|
683
|
+
return TasksApiFp(this.configuration).listTasks(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
656
684
|
}
|
|
657
685
|
|
|
658
686
|
/**
|
package/dist/api/tasks-api.d.ts
CHANGED
|
@@ -55,15 +55,17 @@ export declare const TasksApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
55
55
|
* Retrieves a list of tasks.
|
|
56
56
|
* @summary List tasks
|
|
57
57
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
58
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
59
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
58
60
|
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
59
|
-
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
60
61
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
61
62
|
* @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, createdAt, updatedAt, assignee, reporter, dueDate</i>
|
|
62
63
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: category, status<i>
|
|
64
|
+
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
63
65
|
* @param {*} [options] Override http request option.
|
|
64
66
|
* @throws {RequiredError}
|
|
65
67
|
*/
|
|
66
|
-
listTasks: (authorization?: string,
|
|
68
|
+
listTasks: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
69
|
/**
|
|
68
70
|
* This will partially update a task by code with the provided fields.
|
|
69
71
|
* @summary Update the task
|
|
@@ -112,15 +114,17 @@ export declare const TasksApiFp: (configuration?: Configuration) => {
|
|
|
112
114
|
* Retrieves a list of tasks.
|
|
113
115
|
* @summary List tasks
|
|
114
116
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
117
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
118
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
115
119
|
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
116
|
-
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
117
120
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
118
121
|
* @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, createdAt, updatedAt, assignee, reporter, dueDate</i>
|
|
119
122
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: category, status<i>
|
|
123
|
+
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
120
124
|
* @param {*} [options] Override http request option.
|
|
121
125
|
* @throws {RequiredError}
|
|
122
126
|
*/
|
|
123
|
-
listTasks(authorization?: string,
|
|
127
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTasksResponseClass>>;
|
|
124
128
|
/**
|
|
125
129
|
* This will partially update a task by code with the provided fields.
|
|
126
130
|
* @summary Update the task
|
|
@@ -169,15 +173,17 @@ export declare const TasksApiFactory: (configuration?: Configuration, basePath?:
|
|
|
169
173
|
* Retrieves a list of tasks.
|
|
170
174
|
* @summary List tasks
|
|
171
175
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
176
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
177
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
172
178
|
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
173
|
-
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
174
179
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
175
180
|
* @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, createdAt, updatedAt, assignee, reporter, dueDate</i>
|
|
176
181
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: category, status<i>
|
|
182
|
+
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
177
183
|
* @param {*} [options] Override http request option.
|
|
178
184
|
* @throws {RequiredError}
|
|
179
185
|
*/
|
|
180
|
-
listTasks(authorization?: string,
|
|
186
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass>;
|
|
181
187
|
/**
|
|
182
188
|
* This will partially update a task by code with the provided fields.
|
|
183
189
|
* @summary Update the task
|
|
@@ -265,17 +271,23 @@ export interface TasksApiListTasksRequest {
|
|
|
265
271
|
*/
|
|
266
272
|
readonly authorization?: string;
|
|
267
273
|
/**
|
|
268
|
-
*
|
|
274
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
275
|
+
* @type {number}
|
|
276
|
+
* @memberof TasksApiListTasks
|
|
277
|
+
*/
|
|
278
|
+
readonly pageSize?: number;
|
|
279
|
+
/**
|
|
280
|
+
* 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.
|
|
269
281
|
* @type {string}
|
|
270
282
|
* @memberof TasksApiListTasks
|
|
271
283
|
*/
|
|
272
|
-
readonly
|
|
284
|
+
readonly pageToken?: string;
|
|
273
285
|
/**
|
|
274
|
-
*
|
|
286
|
+
* 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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
275
287
|
* @type {string}
|
|
276
288
|
* @memberof TasksApiListTasks
|
|
277
289
|
*/
|
|
278
|
-
readonly
|
|
290
|
+
readonly filter?: string;
|
|
279
291
|
/**
|
|
280
292
|
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
281
293
|
* @type {string}
|
|
@@ -294,6 +306,12 @@ export interface TasksApiListTasksRequest {
|
|
|
294
306
|
* @memberof TasksApiListTasks
|
|
295
307
|
*/
|
|
296
308
|
readonly expand?: string;
|
|
309
|
+
/**
|
|
310
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
311
|
+
* @type {string}
|
|
312
|
+
* @memberof TasksApiListTasks
|
|
313
|
+
*/
|
|
314
|
+
readonly filters?: string;
|
|
297
315
|
}
|
|
298
316
|
/**
|
|
299
317
|
* Request parameters for patchTask operation in TasksApi.
|
package/dist/api/tasks-api.js
CHANGED
|
@@ -251,15 +251,17 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
251
251
|
* Retrieves a list of tasks.
|
|
252
252
|
* @summary List tasks
|
|
253
253
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
255
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
254
256
|
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
255
|
-
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
256
257
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
257
258
|
* @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, createdAt, updatedAt, assignee, reporter, dueDate</i>
|
|
258
259
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: category, status<i>
|
|
260
|
+
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
259
261
|
* @param {*} [options] Override http request option.
|
|
260
262
|
* @throws {RequiredError}
|
|
261
263
|
*/
|
|
262
|
-
listTasks: function (authorization,
|
|
264
|
+
listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
263
265
|
if (options === void 0) { options = {}; }
|
|
264
266
|
return __awaiter(_this, void 0, void 0, function () {
|
|
265
267
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -282,12 +284,15 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
282
284
|
// authentication bearer required
|
|
283
285
|
// http bearer authentication required
|
|
284
286
|
_a.sent();
|
|
287
|
+
if (pageSize !== undefined) {
|
|
288
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
289
|
+
}
|
|
290
|
+
if (pageToken !== undefined) {
|
|
291
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
292
|
+
}
|
|
285
293
|
if (filter !== undefined) {
|
|
286
294
|
localVarQueryParameter['filter'] = filter;
|
|
287
295
|
}
|
|
288
|
-
if (filters !== undefined) {
|
|
289
|
-
localVarQueryParameter['filters'] = filters;
|
|
290
|
-
}
|
|
291
296
|
if (search !== undefined) {
|
|
292
297
|
localVarQueryParameter['search'] = search;
|
|
293
298
|
}
|
|
@@ -297,6 +302,9 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
297
302
|
if (expand !== undefined) {
|
|
298
303
|
localVarQueryParameter['expand'] = expand;
|
|
299
304
|
}
|
|
305
|
+
if (filters !== undefined) {
|
|
306
|
+
localVarQueryParameter['filters'] = filters;
|
|
307
|
+
}
|
|
300
308
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
301
309
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
302
310
|
}
|
|
@@ -442,20 +450,22 @@ var TasksApiFp = function (configuration) {
|
|
|
442
450
|
* Retrieves a list of tasks.
|
|
443
451
|
* @summary List tasks
|
|
444
452
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
453
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
454
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
445
455
|
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
446
|
-
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
447
456
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
448
457
|
* @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, createdAt, updatedAt, assignee, reporter, dueDate</i>
|
|
449
458
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: category, status<i>
|
|
459
|
+
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
450
460
|
* @param {*} [options] Override http request option.
|
|
451
461
|
* @throws {RequiredError}
|
|
452
462
|
*/
|
|
453
|
-
listTasks: function (authorization,
|
|
463
|
+
listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
454
464
|
return __awaiter(this, void 0, void 0, function () {
|
|
455
465
|
var localVarAxiosArgs;
|
|
456
466
|
return __generator(this, function (_a) {
|
|
457
467
|
switch (_a.label) {
|
|
458
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listTasks(authorization,
|
|
468
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
459
469
|
case 1:
|
|
460
470
|
localVarAxiosArgs = _a.sent();
|
|
461
471
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -533,16 +543,18 @@ var TasksApiFactory = function (configuration, basePath, axios) {
|
|
|
533
543
|
* Retrieves a list of tasks.
|
|
534
544
|
* @summary List tasks
|
|
535
545
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
546
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
547
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
536
548
|
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
537
|
-
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
538
549
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, code, subject, description, assignee, reporter</i>
|
|
539
550
|
* @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, createdAt, updatedAt, assignee, reporter, dueDate</i>
|
|
540
551
|
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: category, status<i>
|
|
552
|
+
* @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: id, code, categoryId, statusId, priority, assignee, reporter, dueDate, createdAt, updatedAt, status.slug, category.slug</i>
|
|
541
553
|
* @param {*} [options] Override http request option.
|
|
542
554
|
* @throws {RequiredError}
|
|
543
555
|
*/
|
|
544
|
-
listTasks: function (authorization,
|
|
545
|
-
return localVarFp.listTasks(authorization,
|
|
556
|
+
listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
557
|
+
return localVarFp.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
546
558
|
},
|
|
547
559
|
/**
|
|
548
560
|
* This will partially update a task by code with the provided fields.
|
|
@@ -617,7 +629,7 @@ var TasksApi = /** @class */ (function (_super) {
|
|
|
617
629
|
TasksApi.prototype.listTasks = function (requestParameters, options) {
|
|
618
630
|
var _this = this;
|
|
619
631
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
620
|
-
return (0, exports.TasksApiFp)(this.configuration).listTasks(requestParameters.authorization, requestParameters.
|
|
632
|
+
return (0, exports.TasksApiFp)(this.configuration).listTasks(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
621
633
|
};
|
|
622
634
|
/**
|
|
623
635
|
* This will partially update a task by code with the provided fields.
|