asana 3.0.2 → 3.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. package/.github/workflows/publish.yaml +78 -38
  2. package/.swagger-codegen/VERSION +1 -1
  3. package/README.md +140 -29
  4. package/codegen/templates/README.mustache +129 -26
  5. package/codegen/templates/api.mustache +17 -15
  6. package/dist/ApiClient.js +6 -7
  7. package/dist/api/AllocationsApi.js +307 -0
  8. package/dist/api/AttachmentsApi.js +22 -95
  9. package/dist/api/AuditLogAPIApi.js +10 -14
  10. package/dist/api/BatchAPIApi.js +10 -14
  11. package/dist/api/CustomFieldSettingsApi.js +16 -23
  12. package/dist/api/CustomFieldsApi.js +38 -203
  13. package/dist/api/EventsApi.js +12 -16
  14. package/dist/api/GoalRelationshipsApi.js +26 -122
  15. package/dist/api/GoalsApi.js +48 -239
  16. package/dist/api/JobsApi.js +8 -32
  17. package/dist/api/MembershipsApi.js +73 -99
  18. package/dist/api/OrganizationExportsApi.js +12 -59
  19. package/dist/api/PortfolioMembershipsApi.js +20 -50
  20. package/dist/api/PortfoliosApi.js +56 -293
  21. package/dist/api/ProjectBriefsApi.js +20 -113
  22. package/dist/api/ProjectMembershipsApi.js +14 -41
  23. package/dist/api/ProjectStatusesApi.js +22 -95
  24. package/dist/api/ProjectTemplatesApi.js +28 -104
  25. package/dist/api/ProjectsApi.js +88 -446
  26. package/dist/api/RulesApi.js +8 -32
  27. package/dist/api/SectionsApi.js +34 -176
  28. package/dist/api/StatusUpdatesApi.js +22 -95
  29. package/dist/api/StoriesApi.js +26 -122
  30. package/dist/api/TagsApi.js +42 -167
  31. package/dist/api/TaskTemplatesApi.js +63 -72
  32. package/dist/api/TasksApi.js +173 -544
  33. package/dist/api/TeamMembershipsApi.js +26 -59
  34. package/dist/api/TeamsApi.js +36 -158
  35. package/dist/api/TimePeriodsApi.js +14 -41
  36. package/dist/api/TimeTrackingEntriesApi.js +26 -122
  37. package/dist/api/TypeaheadApi.js +12 -16
  38. package/dist/api/UserTaskListsApi.js +12 -59
  39. package/dist/api/UsersApi.js +32 -68
  40. package/dist/api/WebhooksApi.js +26 -122
  41. package/dist/api/WorkspaceMembershipsApi.js +20 -50
  42. package/dist/api/WorkspacesApi.js +26 -122
  43. package/dist/index.js +7 -0
  44. package/package.json +1 -1
  45. package/src/ApiClient.js +4 -4
  46. package/src/api/AllocationsApi.js +365 -0
  47. package/src/api/AttachmentsApi.js +42 -134
  48. package/src/api/AuditLogAPIApi.js +15 -17
  49. package/src/api/BatchAPIApi.js +15 -17
  50. package/src/api/CustomFieldSettingsApi.js +28 -32
  51. package/src/api/CustomFieldsApi.js +78 -290
  52. package/src/api/EventsApi.js +17 -19
  53. package/src/api/GoalRelationshipsApi.js +51 -173
  54. package/src/api/GoalsApi.js +100 -344
  55. package/src/api/JobsApi.js +11 -41
  56. package/src/api/MembershipsApi.js +105 -138
  57. package/src/api/OrganizationExportsApi.js +20 -80
  58. package/src/api/PortfolioMembershipsApi.js +37 -71
  59. package/src/api/PortfoliosApi.js +118 -422
  60. package/src/api/ProjectBriefsApi.js +38 -158
  61. package/src/api/ProjectMembershipsApi.js +24 -56
  62. package/src/api/ProjectStatusesApi.js +42 -134
  63. package/src/api/ProjectTemplatesApi.js +55 -149
  64. package/src/api/ProjectsApi.js +189 -647
  65. package/src/api/RulesApi.js +11 -41
  66. package/src/api/SectionsApi.js +69 -251
  67. package/src/api/StatusUpdatesApi.js +42 -134
  68. package/src/api/StoriesApi.js +51 -173
  69. package/src/api/TagsApi.js +86 -242
  70. package/src/api/TaskTemplatesApi.js +86 -95
  71. package/src/api/TasksApi.js +330 -799
  72. package/src/api/TeamMembershipsApi.js +50 -86
  73. package/src/api/TeamsApi.js +73 -227
  74. package/src/api/TimePeriodsApi.js +24 -56
  75. package/src/api/TimeTrackingEntriesApi.js +51 -173
  76. package/src/api/TypeaheadApi.js +17 -19
  77. package/src/api/UserTaskListsApi.js +20 -80
  78. package/src/api/UsersApi.js +63 -101
  79. package/src/api/WebhooksApi.js +51 -173
  80. package/src/api/WorkspaceMembershipsApi.js +37 -71
  81. package/src/api/WorkspacesApi.js +51 -173
  82. package/src/index.js +9 -2
@@ -7,7 +7,7 @@
7
7
  * NOTE: This class is auto generated by the swagger code generator program.
8
8
  * https://github.com/swagger-api/swagger-codegen.git
9
9
  *
10
- * Swagger Codegen version: 3.0.52
10
+ * Swagger Codegen version: 3.0.54
11
11
  *
12
12
  * Do not edit the class manually.
13
13
  *
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
18
18
  /**
19
19
  * TimePeriods service.
20
20
  * @module api/TimePeriodsApi
21
- * @version 3.0.2
21
+ * @version 3.0.4
22
22
  */
23
23
  export class TimePeriodsApi {
24
24
 
@@ -71,36 +71,11 @@ export class TimePeriodsApi {
71
71
  let accepts = ['application/json; charset=UTF-8'];
72
72
  let returnType = 'Blob';
73
73
 
74
- // Check if RETURN_COLLECTION is set and return a collection object if it is
75
- if (this.apiClient.RETURN_COLLECTION && false) {
76
- return Collection.fromApiClient(
77
- this.apiClient.callApi(
78
- '/time_periods/{time_period_gid}', 'GET',
79
- pathParams, queryParams, headerParams, formParams, postBody,
80
- authNames, contentTypes, accepts, returnType
81
- ),
82
- this.apiClient,
83
- {
84
- 'path': '/time_periods/{time_period_gid}',
85
- 'httpMethod': 'GET',
86
- 'pathParams': pathParams,
87
- 'queryParams': queryParams,
88
- 'headerParams': headerParams,
89
- 'formParams': formParams,
90
- 'bodyParam': postBody,
91
- 'authNames': authNames,
92
- 'contentTypes': contentTypes,
93
- 'accepts': accepts,
94
- 'returnType': returnType
95
- }
96
- )
97
- } else {
98
- return this.apiClient.callApi(
99
- '/time_periods/{time_period_gid}', 'GET',
100
- pathParams, queryParams, headerParams, formParams, postBody,
101
- authNames, contentTypes, accepts, returnType
102
- );
103
- }
74
+ return this.apiClient.callApi(
75
+ '/time_periods/{time_period_gid}', 'GET',
76
+ pathParams, queryParams, headerParams, formParams, postBody,
77
+ authNames, contentTypes, accepts, returnType
78
+ );
104
79
  }
105
80
 
106
81
  /**
@@ -113,15 +88,10 @@ export class TimePeriodsApi {
113
88
  */
114
89
  getTimePeriod(time_period_gid, opts) {
115
90
 
116
- // Check if RETURN_COLLECTION is set and return a collection object if it is
117
- if (this.apiClient.RETURN_COLLECTION && false) {
118
- return this.getTimePeriodWithHttpInfo(time_period_gid, opts)
119
- } else {
120
- return this.getTimePeriodWithHttpInfo(time_period_gid, opts)
121
- .then(function(response_and_data) {
122
- return response_and_data.data;
123
- });
124
- }
91
+ return this.getTimePeriodWithHttpInfo(time_period_gid, opts)
92
+ .then(function(response_and_data) {
93
+ return response_and_data.data;
94
+ });
125
95
  }
126
96
 
127
97
 
@@ -164,9 +134,8 @@ export class TimePeriodsApi {
164
134
  let contentTypes = [];
165
135
  let accepts = ['application/json; charset=UTF-8'];
166
136
  let returnType = 'Blob';
167
-
168
137
  // Check if RETURN_COLLECTION is set and return a collection object if it is
169
- if (this.apiClient.RETURN_COLLECTION && true) {
138
+ if (this.apiClient.RETURN_COLLECTION) {
170
139
  return Collection.fromApiClient(
171
140
  this.apiClient.callApi(
172
141
  '/time_periods', 'GET',
@@ -188,13 +157,13 @@ export class TimePeriodsApi {
188
157
  'returnType': returnType
189
158
  }
190
159
  )
191
- } else {
192
- return this.apiClient.callApi(
193
- '/time_periods', 'GET',
194
- pathParams, queryParams, headerParams, formParams, postBody,
195
- authNames, contentTypes, accepts, returnType
196
- );
197
160
  }
161
+
162
+ return this.apiClient.callApi(
163
+ '/time_periods', 'GET',
164
+ pathParams, queryParams, headerParams, formParams, postBody,
165
+ authNames, contentTypes, accepts, returnType
166
+ );
198
167
  }
199
168
 
200
169
  /**
@@ -210,16 +179,15 @@ export class TimePeriodsApi {
210
179
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TimePeriodResponseArray}
211
180
  */
212
181
  getTimePeriods(workspace, opts) {
213
-
214
182
  // Check if RETURN_COLLECTION is set and return a collection object if it is
215
- if (this.apiClient.RETURN_COLLECTION && true) {
216
- return this.getTimePeriodsWithHttpInfo(workspace, opts)
217
- } else {
183
+ if (this.apiClient.RETURN_COLLECTION) {
218
184
  return this.getTimePeriodsWithHttpInfo(workspace, opts)
219
- .then(function(response_and_data) {
220
- return response_and_data.data;
221
- });
222
185
  }
186
+
187
+ return this.getTimePeriodsWithHttpInfo(workspace, opts)
188
+ .then(function(response_and_data) {
189
+ return response_and_data.data;
190
+ });
223
191
  }
224
192
 
225
193
  }
@@ -7,7 +7,7 @@
7
7
  * NOTE: This class is auto generated by the swagger code generator program.
8
8
  * https://github.com/swagger-api/swagger-codegen.git
9
9
  *
10
- * Swagger Codegen version: 3.0.52
10
+ * Swagger Codegen version: 3.0.54
11
11
  *
12
12
  * Do not edit the class manually.
13
13
  *
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
18
18
  /**
19
19
  * TimeTrackingEntries service.
20
20
  * @module api/TimeTrackingEntriesApi
21
- * @version 3.0.2
21
+ * @version 3.0.4
22
22
  */
23
23
  export class TimeTrackingEntriesApi {
24
24
 
@@ -76,36 +76,11 @@ export class TimeTrackingEntriesApi {
76
76
  let accepts = ['application/json; charset=UTF-8'];
77
77
  let returnType = 'Blob';
78
78
 
79
- // Check if RETURN_COLLECTION is set and return a collection object if it is
80
- if (this.apiClient.RETURN_COLLECTION && false) {
81
- return Collection.fromApiClient(
82
- this.apiClient.callApi(
83
- '/tasks/{task_gid}/time_tracking_entries', 'POST',
84
- pathParams, queryParams, headerParams, formParams, postBody,
85
- authNames, contentTypes, accepts, returnType
86
- ),
87
- this.apiClient,
88
- {
89
- 'path': '/tasks/{task_gid}/time_tracking_entries',
90
- 'httpMethod': 'POST',
91
- 'pathParams': pathParams,
92
- 'queryParams': queryParams,
93
- 'headerParams': headerParams,
94
- 'formParams': formParams,
95
- 'bodyParam': postBody,
96
- 'authNames': authNames,
97
- 'contentTypes': contentTypes,
98
- 'accepts': accepts,
99
- 'returnType': returnType
100
- }
101
- )
102
- } else {
103
- return this.apiClient.callApi(
104
- '/tasks/{task_gid}/time_tracking_entries', 'POST',
105
- pathParams, queryParams, headerParams, formParams, postBody,
106
- authNames, contentTypes, accepts, returnType
107
- );
108
- }
79
+ return this.apiClient.callApi(
80
+ '/tasks/{task_gid}/time_tracking_entries', 'POST',
81
+ pathParams, queryParams, headerParams, formParams, postBody,
82
+ authNames, contentTypes, accepts, returnType
83
+ );
109
84
  }
110
85
 
111
86
  /**
@@ -119,15 +94,10 @@ export class TimeTrackingEntriesApi {
119
94
  */
120
95
  createTimeTrackingEntry(body, task_gid, opts) {
121
96
 
122
- // Check if RETURN_COLLECTION is set and return a collection object if it is
123
- if (this.apiClient.RETURN_COLLECTION && false) {
124
- return this.createTimeTrackingEntryWithHttpInfo(body, task_gid, opts)
125
- } else {
126
- return this.createTimeTrackingEntryWithHttpInfo(body, task_gid, opts)
127
- .then(function(response_and_data) {
128
- return response_and_data.data;
129
- });
130
- }
97
+ return this.createTimeTrackingEntryWithHttpInfo(body, task_gid, opts)
98
+ .then(function(response_and_data) {
99
+ return response_and_data.data;
100
+ });
131
101
  }
132
102
 
133
103
 
@@ -162,36 +132,11 @@ export class TimeTrackingEntriesApi {
162
132
  let accepts = ['application/json; charset=UTF-8'];
163
133
  let returnType = 'Blob';
164
134
 
165
- // Check if RETURN_COLLECTION is set and return a collection object if it is
166
- if (this.apiClient.RETURN_COLLECTION && false) {
167
- return Collection.fromApiClient(
168
- this.apiClient.callApi(
169
- '/time_tracking_entries/{time_tracking_entry_gid}', 'DELETE',
170
- pathParams, queryParams, headerParams, formParams, postBody,
171
- authNames, contentTypes, accepts, returnType
172
- ),
173
- this.apiClient,
174
- {
175
- 'path': '/time_tracking_entries/{time_tracking_entry_gid}',
176
- 'httpMethod': 'DELETE',
177
- 'pathParams': pathParams,
178
- 'queryParams': queryParams,
179
- 'headerParams': headerParams,
180
- 'formParams': formParams,
181
- 'bodyParam': postBody,
182
- 'authNames': authNames,
183
- 'contentTypes': contentTypes,
184
- 'accepts': accepts,
185
- 'returnType': returnType
186
- }
187
- )
188
- } else {
189
- return this.apiClient.callApi(
190
- '/time_tracking_entries/{time_tracking_entry_gid}', 'DELETE',
191
- pathParams, queryParams, headerParams, formParams, postBody,
192
- authNames, contentTypes, accepts, returnType
193
- );
194
- }
135
+ return this.apiClient.callApi(
136
+ '/time_tracking_entries/{time_tracking_entry_gid}', 'DELETE',
137
+ pathParams, queryParams, headerParams, formParams, postBody,
138
+ authNames, contentTypes, accepts, returnType
139
+ );
195
140
  }
196
141
 
197
142
  /**
@@ -202,15 +147,10 @@ export class TimeTrackingEntriesApi {
202
147
  */
203
148
  deleteTimeTrackingEntry(time_tracking_entry_gid) {
204
149
 
205
- // Check if RETURN_COLLECTION is set and return a collection object if it is
206
- if (this.apiClient.RETURN_COLLECTION && false) {
207
- return this.deleteTimeTrackingEntryWithHttpInfo(time_tracking_entry_gid)
208
- } else {
209
- return this.deleteTimeTrackingEntryWithHttpInfo(time_tracking_entry_gid)
210
- .then(function(response_and_data) {
211
- return response_and_data.data;
212
- });
213
- }
150
+ return this.deleteTimeTrackingEntryWithHttpInfo(time_tracking_entry_gid)
151
+ .then(function(response_and_data) {
152
+ return response_and_data.data;
153
+ });
214
154
  }
215
155
 
216
156
 
@@ -250,9 +190,8 @@ export class TimeTrackingEntriesApi {
250
190
  let contentTypes = [];
251
191
  let accepts = ['application/json; charset=UTF-8'];
252
192
  let returnType = 'Blob';
253
-
254
193
  // Check if RETURN_COLLECTION is set and return a collection object if it is
255
- if (this.apiClient.RETURN_COLLECTION && true) {
194
+ if (this.apiClient.RETURN_COLLECTION) {
256
195
  return Collection.fromApiClient(
257
196
  this.apiClient.callApi(
258
197
  '/tasks/{task_gid}/time_tracking_entries', 'GET',
@@ -274,13 +213,13 @@ export class TimeTrackingEntriesApi {
274
213
  'returnType': returnType
275
214
  }
276
215
  )
277
- } else {
278
- return this.apiClient.callApi(
279
- '/tasks/{task_gid}/time_tracking_entries', 'GET',
280
- pathParams, queryParams, headerParams, formParams, postBody,
281
- authNames, contentTypes, accepts, returnType
282
- );
283
216
  }
217
+
218
+ return this.apiClient.callApi(
219
+ '/tasks/{task_gid}/time_tracking_entries', 'GET',
220
+ pathParams, queryParams, headerParams, formParams, postBody,
221
+ authNames, contentTypes, accepts, returnType
222
+ );
284
223
  }
285
224
 
286
225
  /**
@@ -294,16 +233,15 @@ export class TimeTrackingEntriesApi {
294
233
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/TimeTrackingEntryCompactArray}
295
234
  */
296
235
  getTimeTrackingEntriesForTask(task_gid, opts) {
297
-
298
236
  // Check if RETURN_COLLECTION is set and return a collection object if it is
299
- if (this.apiClient.RETURN_COLLECTION && true) {
237
+ if (this.apiClient.RETURN_COLLECTION) {
300
238
  return this.getTimeTrackingEntriesForTaskWithHttpInfo(task_gid, opts)
301
- } else {
302
- return this.getTimeTrackingEntriesForTaskWithHttpInfo(task_gid, opts)
303
- .then(function(response_and_data) {
304
- return response_and_data.data;
305
- });
306
239
  }
240
+
241
+ return this.getTimeTrackingEntriesForTaskWithHttpInfo(task_gid, opts)
242
+ .then(function(response_and_data) {
243
+ return response_and_data.data;
244
+ });
307
245
  }
308
246
 
309
247
 
@@ -342,36 +280,11 @@ export class TimeTrackingEntriesApi {
342
280
  let accepts = ['application/json; charset=UTF-8'];
343
281
  let returnType = 'Blob';
344
282
 
345
- // Check if RETURN_COLLECTION is set and return a collection object if it is
346
- if (this.apiClient.RETURN_COLLECTION && false) {
347
- return Collection.fromApiClient(
348
- this.apiClient.callApi(
349
- '/time_tracking_entries/{time_tracking_entry_gid}', 'GET',
350
- pathParams, queryParams, headerParams, formParams, postBody,
351
- authNames, contentTypes, accepts, returnType
352
- ),
353
- this.apiClient,
354
- {
355
- 'path': '/time_tracking_entries/{time_tracking_entry_gid}',
356
- 'httpMethod': 'GET',
357
- 'pathParams': pathParams,
358
- 'queryParams': queryParams,
359
- 'headerParams': headerParams,
360
- 'formParams': formParams,
361
- 'bodyParam': postBody,
362
- 'authNames': authNames,
363
- 'contentTypes': contentTypes,
364
- 'accepts': accepts,
365
- 'returnType': returnType
366
- }
367
- )
368
- } else {
369
- return this.apiClient.callApi(
370
- '/time_tracking_entries/{time_tracking_entry_gid}', 'GET',
371
- pathParams, queryParams, headerParams, formParams, postBody,
372
- authNames, contentTypes, accepts, returnType
373
- );
374
- }
283
+ return this.apiClient.callApi(
284
+ '/time_tracking_entries/{time_tracking_entry_gid}', 'GET',
285
+ pathParams, queryParams, headerParams, formParams, postBody,
286
+ authNames, contentTypes, accepts, returnType
287
+ );
375
288
  }
376
289
 
377
290
  /**
@@ -384,15 +297,10 @@ export class TimeTrackingEntriesApi {
384
297
  */
385
298
  getTimeTrackingEntry(time_tracking_entry_gid, opts) {
386
299
 
387
- // Check if RETURN_COLLECTION is set and return a collection object if it is
388
- if (this.apiClient.RETURN_COLLECTION && false) {
389
- return this.getTimeTrackingEntryWithHttpInfo(time_tracking_entry_gid, opts)
390
- } else {
391
- return this.getTimeTrackingEntryWithHttpInfo(time_tracking_entry_gid, opts)
392
- .then(function(response_and_data) {
393
- return response_and_data.data;
394
- });
395
- }
300
+ return this.getTimeTrackingEntryWithHttpInfo(time_tracking_entry_gid, opts)
301
+ .then(function(response_and_data) {
302
+ return response_and_data.data;
303
+ });
396
304
  }
397
305
 
398
306
 
@@ -436,36 +344,11 @@ export class TimeTrackingEntriesApi {
436
344
  let accepts = ['application/json; charset=UTF-8'];
437
345
  let returnType = 'Blob';
438
346
 
439
- // Check if RETURN_COLLECTION is set and return a collection object if it is
440
- if (this.apiClient.RETURN_COLLECTION && false) {
441
- return Collection.fromApiClient(
442
- this.apiClient.callApi(
443
- '/time_tracking_entries/{time_tracking_entry_gid}', 'PUT',
444
- pathParams, queryParams, headerParams, formParams, postBody,
445
- authNames, contentTypes, accepts, returnType
446
- ),
447
- this.apiClient,
448
- {
449
- 'path': '/time_tracking_entries/{time_tracking_entry_gid}',
450
- 'httpMethod': 'PUT',
451
- 'pathParams': pathParams,
452
- 'queryParams': queryParams,
453
- 'headerParams': headerParams,
454
- 'formParams': formParams,
455
- 'bodyParam': postBody,
456
- 'authNames': authNames,
457
- 'contentTypes': contentTypes,
458
- 'accepts': accepts,
459
- 'returnType': returnType
460
- }
461
- )
462
- } else {
463
- return this.apiClient.callApi(
464
- '/time_tracking_entries/{time_tracking_entry_gid}', 'PUT',
465
- pathParams, queryParams, headerParams, formParams, postBody,
466
- authNames, contentTypes, accepts, returnType
467
- );
468
- }
347
+ return this.apiClient.callApi(
348
+ '/time_tracking_entries/{time_tracking_entry_gid}', 'PUT',
349
+ pathParams, queryParams, headerParams, formParams, postBody,
350
+ authNames, contentTypes, accepts, returnType
351
+ );
469
352
  }
470
353
 
471
354
  /**
@@ -479,15 +362,10 @@ export class TimeTrackingEntriesApi {
479
362
  */
480
363
  updateTimeTrackingEntry(body, time_tracking_entry_gid, opts) {
481
364
 
482
- // Check if RETURN_COLLECTION is set and return a collection object if it is
483
- if (this.apiClient.RETURN_COLLECTION && false) {
484
- return this.updateTimeTrackingEntryWithHttpInfo(body, time_tracking_entry_gid, opts)
485
- } else {
486
- return this.updateTimeTrackingEntryWithHttpInfo(body, time_tracking_entry_gid, opts)
487
- .then(function(response_and_data) {
488
- return response_and_data.data;
489
- });
490
- }
365
+ return this.updateTimeTrackingEntryWithHttpInfo(body, time_tracking_entry_gid, opts)
366
+ .then(function(response_and_data) {
367
+ return response_and_data.data;
368
+ });
491
369
  }
492
370
 
493
371
  }
@@ -7,7 +7,7 @@
7
7
  * NOTE: This class is auto generated by the swagger code generator program.
8
8
  * https://github.com/swagger-api/swagger-codegen.git
9
9
  *
10
- * Swagger Codegen version: 3.0.52
10
+ * Swagger Codegen version: 3.0.54
11
11
  *
12
12
  * Do not edit the class manually.
13
13
  *
@@ -18,7 +18,7 @@ var Collection = require('../utils/collection');
18
18
  /**
19
19
  * Typeahead service.
20
20
  * @module api/TypeaheadApi
21
- * @version 3.0.2
21
+ * @version 3.0.4
22
22
  */
23
23
  export class TypeaheadApi {
24
24
 
@@ -40,7 +40,7 @@ export class TypeaheadApi {
40
40
  * Get objects via typeahead
41
41
  * Retrieves objects in the workspace based via an auto-completion/typeahead search algorithm. This feature is meant to provide results quickly, so do not rely on this API to provide extremely accurate search results. The result set is limited to a single page of results with a maximum size, so you won’t be able to fetch large numbers of results. The typeahead search API provides search for objects from a single workspace. This endpoint should be used to query for objects when creating an auto-completion/typeahead search feature. This API is meant to provide results quickly and should not be relied upon for accurate or exhaustive search results. The results sets are limited in size and cannot be paginated. Queries return a compact representation of each object which is typically the gid and name fields. Interested in a specific set of fields or all of the fields?! Of course you are. Use field selectors to manipulate what data is included in a response. Resources with type `user` are returned in order of most contacted to least contacted. This is determined by task assignments, adding the user to projects, and adding the user as a follower to tasks, messages, etc. Resources with type `project` are returned in order of recency. This is determined when the user visits the project, is added to the project, and completes tasks in the project. Resources with type `task` are returned with priority placed on tasks the user is following, but no guarantee on the order of those tasks. Resources with type `project_template` are returned with priority placed on favorited project templates. Leaving the `query` string empty or omitted will give you results, still following the resource ordering above. This could be used to list users or projects that are relevant for the requesting user's api token.
42
42
  * @param {String} workspace_gid Globally unique identifier for the workspace or organization.
43
- * @param {module:model/String} resource_type The type of values the typeahead should return. You can choose from one of the following: `custom_field`, `project`, `project_template`, `portfolio`, `tag`, `task`, and `user`. Note that unlike in the names of endpoints, the types listed here are in singular form (e.g. `task`). Using multiple types is not yet supported.
43
+ * @param {module:model/String} resource_type The type of values the typeahead should return. You can choose from one of the following: `custom_field`, `goal`, `project`, `project_template`, `portfolio`, `tag`, `task`, `team`, and `user`. Note that unlike in the names of endpoints, the types listed here are in singular form (e.g. `task`). Using multiple types is not yet supported.
44
44
  * @param {Object} opts Optional parameters
45
45
  * @param {module:model/String} opts.type *Deprecated: new integrations should prefer the resource_type field.* (default to <.>)
46
46
  * @param {String} opts.query The string that will be used to search for relevant objects. If an empty string is passed in, the API will return results.
@@ -79,9 +79,8 @@ export class TypeaheadApi {
79
79
  let contentTypes = [];
80
80
  let accepts = ['application/json; charset=UTF-8'];
81
81
  let returnType = 'Blob';
82
-
83
82
  // Check if RETURN_COLLECTION is set and return a collection object if it is
84
- if (this.apiClient.RETURN_COLLECTION && true) {
83
+ if (this.apiClient.RETURN_COLLECTION) {
85
84
  return Collection.fromApiClient(
86
85
  this.apiClient.callApi(
87
86
  '/workspaces/{workspace_gid}/typeahead', 'GET',
@@ -103,20 +102,20 @@ export class TypeaheadApi {
103
102
  'returnType': returnType
104
103
  }
105
104
  )
106
- } else {
107
- return this.apiClient.callApi(
108
- '/workspaces/{workspace_gid}/typeahead', 'GET',
109
- pathParams, queryParams, headerParams, formParams, postBody,
110
- authNames, contentTypes, accepts, returnType
111
- );
112
105
  }
106
+
107
+ return this.apiClient.callApi(
108
+ '/workspaces/{workspace_gid}/typeahead', 'GET',
109
+ pathParams, queryParams, headerParams, formParams, postBody,
110
+ authNames, contentTypes, accepts, returnType
111
+ );
113
112
  }
114
113
 
115
114
  /**
116
115
  * Get objects via typeahead
117
116
  * Retrieves objects in the workspace based via an auto-completion/typeahead search algorithm. This feature is meant to provide results quickly, so do not rely on this API to provide extremely accurate search results. The result set is limited to a single page of results with a maximum size, so you won’t be able to fetch large numbers of results. The typeahead search API provides search for objects from a single workspace. This endpoint should be used to query for objects when creating an auto-completion/typeahead search feature. This API is meant to provide results quickly and should not be relied upon for accurate or exhaustive search results. The results sets are limited in size and cannot be paginated. Queries return a compact representation of each object which is typically the gid and name fields. Interested in a specific set of fields or all of the fields?! Of course you are. Use field selectors to manipulate what data is included in a response. Resources with type &#x60;user&#x60; are returned in order of most contacted to least contacted. This is determined by task assignments, adding the user to projects, and adding the user as a follower to tasks, messages, etc. Resources with type &#x60;project&#x60; are returned in order of recency. This is determined when the user visits the project, is added to the project, and completes tasks in the project. Resources with type &#x60;task&#x60; are returned with priority placed on tasks the user is following, but no guarantee on the order of those tasks. Resources with type &#x60;project_template&#x60; are returned with priority placed on favorited project templates. Leaving the &#x60;query&#x60; string empty or omitted will give you results, still following the resource ordering above. This could be used to list users or projects that are relevant for the requesting user&#x27;s api token.
118
117
  * @param {<&vendorExtensions.x-jsdoc-type>} workspace_gid Globally unique identifier for the workspace or organization.
119
- * @param {<&vendorExtensions.x-jsdoc-type>} resource_type The type of values the typeahead should return. You can choose from one of the following: &#x60;custom_field&#x60;, &#x60;project&#x60;, &#x60;project_template&#x60;, &#x60;portfolio&#x60;, &#x60;tag&#x60;, &#x60;task&#x60;, and &#x60;user&#x60;. Note that unlike in the names of endpoints, the types listed here are in singular form (e.g. &#x60;task&#x60;). Using multiple types is not yet supported.
118
+ * @param {<&vendorExtensions.x-jsdoc-type>} resource_type The type of values the typeahead should return. You can choose from one of the following: &#x60;custom_field&#x60;, &#x60;goal&#x60;, &#x60;project&#x60;, &#x60;project_template&#x60;, &#x60;portfolio&#x60;, &#x60;tag&#x60;, &#x60;task&#x60;, &#x60;team&#x60;, and &#x60;user&#x60;. Note that unlike in the names of endpoints, the types listed here are in singular form (e.g. &#x60;task&#x60;). Using multiple types is not yet supported.
120
119
  * @param {Object} opts Optional parameters
121
120
  * @param {module:model/String} opts.type *Deprecated: new integrations should prefer the resource_type field.* (default to <.>)
122
121
  * @param {String} opts.query The string that will be used to search for relevant objects. If an empty string is passed in, the API will return results.
@@ -125,16 +124,15 @@ export class TypeaheadApi {
125
124
  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AsanaNamedResourceArray}
126
125
  */
127
126
  typeaheadForWorkspace(workspace_gid, resource_type, opts) {
128
-
129
127
  // Check if RETURN_COLLECTION is set and return a collection object if it is
130
- if (this.apiClient.RETURN_COLLECTION && true) {
128
+ if (this.apiClient.RETURN_COLLECTION) {
131
129
  return this.typeaheadForWorkspaceWithHttpInfo(workspace_gid, resource_type, opts)
132
- } else {
133
- return this.typeaheadForWorkspaceWithHttpInfo(workspace_gid, resource_type, opts)
134
- .then(function(response_and_data) {
135
- return response_and_data.data;
136
- });
137
130
  }
131
+
132
+ return this.typeaheadForWorkspaceWithHttpInfo(workspace_gid, resource_type, opts)
133
+ .then(function(response_and_data) {
134
+ return response_and_data.data;
135
+ });
138
136
  }
139
137
 
140
138
  }