@emilgroup/task-sdk 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@1.0.1-beta.
|
|
20
|
+
npm install @emilgroup/task-sdk@1.0.1-beta.7 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/task-sdk@1.0.1-beta.
|
|
24
|
+
yarn add @emilgroup/task-sdk@1.0.1-beta.7
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `TasksApi`.
|
package/api/tasks-api.ts
CHANGED
|
@@ -186,15 +186,17 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
186
186
|
* Retrieves a list of tasks.
|
|
187
187
|
* @summary List tasks
|
|
188
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
189
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
190
|
+
* @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.
|
|
189
191
|
* @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>
|
|
190
|
-
* @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>
|
|
191
192
|
* @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>
|
|
192
193
|
* @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>
|
|
193
194
|
* @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>
|
|
195
|
+
* @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>
|
|
194
196
|
* @param {*} [options] Override http request option.
|
|
195
197
|
* @throws {RequiredError}
|
|
196
198
|
*/
|
|
197
|
-
listTasks: async (authorization?: string,
|
|
199
|
+
listTasks: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
198
200
|
const localVarPath = `/taskservice/v1/tasks`;
|
|
199
201
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
200
202
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -213,12 +215,16 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
213
215
|
// http bearer authentication required
|
|
214
216
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
215
217
|
|
|
216
|
-
if (
|
|
217
|
-
localVarQueryParameter['
|
|
218
|
+
if (pageSize !== undefined) {
|
|
219
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
218
220
|
}
|
|
219
221
|
|
|
220
|
-
if (
|
|
221
|
-
localVarQueryParameter['
|
|
222
|
+
if (pageToken !== undefined) {
|
|
223
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
if (filter !== undefined) {
|
|
227
|
+
localVarQueryParameter['filter'] = filter;
|
|
222
228
|
}
|
|
223
229
|
|
|
224
230
|
if (search !== undefined) {
|
|
@@ -233,6 +239,10 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
233
239
|
localVarQueryParameter['expand'] = expand;
|
|
234
240
|
}
|
|
235
241
|
|
|
242
|
+
if (filters !== undefined) {
|
|
243
|
+
localVarQueryParameter['filters'] = filters;
|
|
244
|
+
}
|
|
245
|
+
|
|
236
246
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
237
247
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
238
248
|
}
|
|
@@ -350,16 +360,18 @@ export const TasksApiFp = function(configuration?: Configuration) {
|
|
|
350
360
|
* Retrieves a list of tasks.
|
|
351
361
|
* @summary List tasks
|
|
352
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
364
|
+
* @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.
|
|
353
365
|
* @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>
|
|
354
|
-
* @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>
|
|
355
366
|
* @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>
|
|
356
367
|
* @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>
|
|
357
368
|
* @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>
|
|
369
|
+
* @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>
|
|
358
370
|
* @param {*} [options] Override http request option.
|
|
359
371
|
* @throws {RequiredError}
|
|
360
372
|
*/
|
|
361
|
-
async listTasks(authorization?: string,
|
|
362
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization,
|
|
373
|
+
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>> {
|
|
374
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
363
375
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
364
376
|
},
|
|
365
377
|
/**
|
|
@@ -423,16 +435,18 @@ export const TasksApiFactory = function (configuration?: Configuration, basePath
|
|
|
423
435
|
* Retrieves a list of tasks.
|
|
424
436
|
* @summary List tasks
|
|
425
437
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
439
|
+
* @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.
|
|
426
440
|
* @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>
|
|
427
|
-
* @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>
|
|
428
441
|
* @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>
|
|
429
442
|
* @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>
|
|
430
443
|
* @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>
|
|
444
|
+
* @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>
|
|
431
445
|
* @param {*} [options] Override http request option.
|
|
432
446
|
* @throws {RequiredError}
|
|
433
447
|
*/
|
|
434
|
-
listTasks(authorization?: string,
|
|
435
|
-
return localVarFp.listTasks(authorization,
|
|
448
|
+
listTasks(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListTasksResponseClass> {
|
|
449
|
+
return localVarFp.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
436
450
|
},
|
|
437
451
|
/**
|
|
438
452
|
* This will partially update a task by code with the provided fields.
|
|
@@ -533,18 +547,25 @@ export interface TasksApiListTasksRequest {
|
|
|
533
547
|
readonly authorization?: string
|
|
534
548
|
|
|
535
549
|
/**
|
|
536
|
-
*
|
|
550
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
551
|
+
* @type {number}
|
|
552
|
+
* @memberof TasksApiListTasks
|
|
553
|
+
*/
|
|
554
|
+
readonly pageSize?: number
|
|
555
|
+
|
|
556
|
+
/**
|
|
557
|
+
* 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.
|
|
537
558
|
* @type {string}
|
|
538
559
|
* @memberof TasksApiListTasks
|
|
539
560
|
*/
|
|
540
|
-
readonly
|
|
561
|
+
readonly pageToken?: string
|
|
541
562
|
|
|
542
563
|
/**
|
|
543
|
-
*
|
|
564
|
+
* 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>
|
|
544
565
|
* @type {string}
|
|
545
566
|
* @memberof TasksApiListTasks
|
|
546
567
|
*/
|
|
547
|
-
readonly
|
|
568
|
+
readonly filter?: string
|
|
548
569
|
|
|
549
570
|
/**
|
|
550
571
|
* 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>
|
|
@@ -566,6 +587,13 @@ export interface TasksApiListTasksRequest {
|
|
|
566
587
|
* @memberof TasksApiListTasks
|
|
567
588
|
*/
|
|
568
589
|
readonly expand?: string
|
|
590
|
+
|
|
591
|
+
/**
|
|
592
|
+
* 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>
|
|
593
|
+
* @type {string}
|
|
594
|
+
* @memberof TasksApiListTasks
|
|
595
|
+
*/
|
|
596
|
+
readonly filters?: string
|
|
569
597
|
}
|
|
570
598
|
|
|
571
599
|
/**
|
|
@@ -648,7 +676,7 @@ export class TasksApi extends BaseAPI {
|
|
|
648
676
|
* @memberof TasksApi
|
|
649
677
|
*/
|
|
650
678
|
public listTasks(requestParameters: TasksApiListTasksRequest = {}, options?: AxiosRequestConfig) {
|
|
651
|
-
return TasksApiFp(this.configuration).listTasks(requestParameters.authorization, requestParameters.
|
|
679
|
+
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));
|
|
652
680
|
}
|
|
653
681
|
|
|
654
682
|
/**
|
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
|
@@ -247,15 +247,17 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
247
247
|
* Retrieves a list of tasks.
|
|
248
248
|
* @summary List tasks
|
|
249
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
251
|
+
* @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.
|
|
250
252
|
* @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>
|
|
251
|
-
* @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>
|
|
252
253
|
* @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>
|
|
253
254
|
* @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>
|
|
254
255
|
* @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>
|
|
256
|
+
* @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>
|
|
255
257
|
* @param {*} [options] Override http request option.
|
|
256
258
|
* @throws {RequiredError}
|
|
257
259
|
*/
|
|
258
|
-
listTasks: function (authorization,
|
|
260
|
+
listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
259
261
|
if (options === void 0) { options = {}; }
|
|
260
262
|
return __awaiter(_this, void 0, void 0, function () {
|
|
261
263
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -278,12 +280,15 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
278
280
|
// authentication bearer required
|
|
279
281
|
// http bearer authentication required
|
|
280
282
|
_a.sent();
|
|
283
|
+
if (pageSize !== undefined) {
|
|
284
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
285
|
+
}
|
|
286
|
+
if (pageToken !== undefined) {
|
|
287
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
288
|
+
}
|
|
281
289
|
if (filter !== undefined) {
|
|
282
290
|
localVarQueryParameter['filter'] = filter;
|
|
283
291
|
}
|
|
284
|
-
if (filters !== undefined) {
|
|
285
|
-
localVarQueryParameter['filters'] = filters;
|
|
286
|
-
}
|
|
287
292
|
if (search !== undefined) {
|
|
288
293
|
localVarQueryParameter['search'] = search;
|
|
289
294
|
}
|
|
@@ -293,6 +298,9 @@ var TasksApiAxiosParamCreator = function (configuration) {
|
|
|
293
298
|
if (expand !== undefined) {
|
|
294
299
|
localVarQueryParameter['expand'] = expand;
|
|
295
300
|
}
|
|
301
|
+
if (filters !== undefined) {
|
|
302
|
+
localVarQueryParameter['filters'] = filters;
|
|
303
|
+
}
|
|
296
304
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
297
305
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
298
306
|
}
|
|
@@ -438,20 +446,22 @@ var TasksApiFp = function (configuration) {
|
|
|
438
446
|
* Retrieves a list of tasks.
|
|
439
447
|
* @summary List tasks
|
|
440
448
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
449
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
450
|
+
* @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.
|
|
441
451
|
* @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>
|
|
442
|
-
* @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>
|
|
443
452
|
* @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>
|
|
444
453
|
* @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>
|
|
445
454
|
* @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>
|
|
455
|
+
* @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>
|
|
446
456
|
* @param {*} [options] Override http request option.
|
|
447
457
|
* @throws {RequiredError}
|
|
448
458
|
*/
|
|
449
|
-
listTasks: function (authorization,
|
|
459
|
+
listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
450
460
|
return __awaiter(this, void 0, void 0, function () {
|
|
451
461
|
var localVarAxiosArgs;
|
|
452
462
|
return __generator(this, function (_a) {
|
|
453
463
|
switch (_a.label) {
|
|
454
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listTasks(authorization,
|
|
464
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
455
465
|
case 1:
|
|
456
466
|
localVarAxiosArgs = _a.sent();
|
|
457
467
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -529,16 +539,18 @@ var TasksApiFactory = function (configuration, basePath, axios) {
|
|
|
529
539
|
* Retrieves a list of tasks.
|
|
530
540
|
* @summary List tasks
|
|
531
541
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
542
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
543
|
+
* @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.
|
|
532
544
|
* @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>
|
|
533
|
-
* @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>
|
|
534
545
|
* @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>
|
|
535
546
|
* @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>
|
|
536
547
|
* @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>
|
|
548
|
+
* @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>
|
|
537
549
|
* @param {*} [options] Override http request option.
|
|
538
550
|
* @throws {RequiredError}
|
|
539
551
|
*/
|
|
540
|
-
listTasks: function (authorization,
|
|
541
|
-
return localVarFp.listTasks(authorization,
|
|
552
|
+
listTasks: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
553
|
+
return localVarFp.listTasks(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
542
554
|
},
|
|
543
555
|
/**
|
|
544
556
|
* This will partially update a task by code with the provided fields.
|
|
@@ -613,7 +625,7 @@ var TasksApi = /** @class */ (function (_super) {
|
|
|
613
625
|
TasksApi.prototype.listTasks = function (requestParameters, options) {
|
|
614
626
|
var _this = this;
|
|
615
627
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
616
|
-
return (0, exports.TasksApiFp)(this.configuration).listTasks(requestParameters.authorization, requestParameters.
|
|
628
|
+
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); });
|
|
617
629
|
};
|
|
618
630
|
/**
|
|
619
631
|
* This will partially update a task by code with the provided fields.
|