@teemill/projects 1.37.0 → 1.38.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/README.md +115 -2
  2. package/api.ts +25 -1
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +1 -1
  6. package/dist/api.d.ts +25 -1
  7. package/dist/api.js +1 -1
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +1 -1
  14. package/dist/esm/api.d.ts +25 -1
  15. package/dist/esm/api.js +1 -1
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +1 -1
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/ApiError.md +22 -0
  27. package/docs/Auth.md +24 -0
  28. package/docs/AuthResponse.md +20 -0
  29. package/docs/Bookmark.md +36 -0
  30. package/docs/BookmarkData.md +22 -0
  31. package/docs/BookmarkRoute.md +20 -0
  32. package/docs/BookmarkRouteRoute.md +24 -0
  33. package/docs/BookmarkTab.md +24 -0
  34. package/docs/BookmarkTabs.md +20 -0
  35. package/docs/BookmarkUrl.md +20 -0
  36. package/docs/Bookmarks.md +20 -0
  37. package/docs/CreateBookmarkRequest.md +30 -0
  38. package/docs/CreateInviteRequest.md +22 -0
  39. package/docs/CreateProjectRequest.md +26 -0
  40. package/docs/CreateTaskRequest.md +22 -0
  41. package/docs/ExportTasks202Response.md +20 -0
  42. package/docs/Icon.md +24 -0
  43. package/docs/InstallTemplateRequest.md +20 -0
  44. package/docs/Integration.md +26 -0
  45. package/docs/IntegrationsResponse.md +20 -0
  46. package/docs/LegacyProjectLogo.md +22 -0
  47. package/docs/ListTasksResponse.md +20 -0
  48. package/docs/NullableIcon.md +24 -0
  49. package/docs/Project.md +36 -0
  50. package/docs/ProjectCurrency.md +22 -0
  51. package/docs/ProjectInvite.md +30 -0
  52. package/docs/ProjectInvites.md +22 -0
  53. package/docs/ProjectLogo.md +22 -0
  54. package/docs/ProjectManager.md +24 -0
  55. package/docs/ProjectPlatform.md +22 -0
  56. package/docs/ProjectUser.md +34 -0
  57. package/docs/ProjectUserAvatar.md +20 -0
  58. package/docs/ProjectUsers.md +22 -0
  59. package/docs/ProjectsApi.md +2023 -0
  60. package/docs/ProjectsResponse.md +20 -0
  61. package/docs/Task.md +40 -0
  62. package/docs/TaskStatus.md +14 -0
  63. package/docs/TaskSummary.md +34 -0
  64. package/docs/Template.md +28 -0
  65. package/docs/TemplateCode.md +16 -0
  66. package/docs/TemplatesResponse.md +20 -0
  67. package/docs/UpdateBookmarkRequest.md +34 -0
  68. package/docs/UpdateBookmarkTabsRequest.md +20 -0
  69. package/docs/UpdateBookmarkTabsRequestTabsInner.md +24 -0
  70. package/docs/UpdateIntegrationRequest.md +20 -0
  71. package/docs/UpdateProjectRequest.md +22 -0
  72. package/docs/UpdateTaskRequest.md +32 -0
  73. package/index.ts +1 -1
  74. package/package.json +1 -1
@@ -0,0 +1,2023 @@
1
+ # ProjectsApi
2
+
3
+ All URIs are relative to *https://localhost:8080*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**createAuth**](#createauth) | **POST** /v1/projects/{project}/auth | Create auth token|
8
+ |[**createBookmark**](#createbookmark) | **POST** /v1/projects/{project}/bookmarks | Create bookmark|
9
+ |[**createInvite**](#createinvite) | **POST** /v1/projects/{project}/invites | Creates an invite|
10
+ |[**createProject**](#createproject) | **POST** /v1/projects | Create project|
11
+ |[**createTask**](#createtask) | **POST** /v1/projects/{project}/tasks | Create Task|
12
+ |[**deleteAuth**](#deleteauth) | **DELETE** /v1/projects/{project}/auth/{auth} | Delete auth token|
13
+ |[**deleteBookmark**](#deletebookmark) | **DELETE** /v1/projects/{project}/bookmarks/{id} | Delete bookmark|
14
+ |[**deleteInvite**](#deleteinvite) | **DELETE** /v1/projects/{project}/invites/{invite} | Deletes an invite|
15
+ |[**deleteProject**](#deleteproject) | **DELETE** /v1/projects/{project} | Delete project|
16
+ |[**deleteTask**](#deletetask) | **DELETE** /v1/projects/{project}/tasks/{id} | Delete Task|
17
+ |[**deleteUser**](#deleteuser) | **DELETE** /v1/projects/{project}/users/{user} | Delete a user by ID|
18
+ |[**exportTasks**](#exporttasks) | **GET** /v1/projects/{project}/tasks/export | Export all tasks|
19
+ |[**getAuth**](#getauth) | **GET** /v1/projects/{project}/auth | List auth tokens|
20
+ |[**getIntegration**](#getintegration) | **GET** /v1/projects/{project}/integrations/{integration} | Get integration|
21
+ |[**getIntegrations**](#getintegrations) | **GET** /v1/projects/{project}/integrations | List integrations|
22
+ |[**getInvites**](#getinvites) | **GET** /v1/projects/{project}/invites | List Invites|
23
+ |[**getProject**](#getproject) | **GET** /v1/projects/{project} | Get project|
24
+ |[**getProjects**](#getprojects) | **GET** /v1/projects | List projects|
25
+ |[**getTask**](#gettask) | **GET** /v1/projects/{project}/tasks/{id} | Get Task|
26
+ |[**getTemplates**](#gettemplates) | **GET** /v1/projects/templates | List templates|
27
+ |[**getUser**](#getuser) | **GET** /v1/projects/{project}/users/{user} | Get a user|
28
+ |[**getUsers**](#getusers) | **GET** /v1/projects/{project}/users | List project users|
29
+ |[**installIntegration**](#installintegration) | **POST** /v1/projects/{project}/integrations/{integration} | Install integration|
30
+ |[**installTemplate**](#installtemplate) | **POST** /v1/projects/{project}/templates/{template} | Install integration template|
31
+ |[**listBookmarks**](#listbookmarks) | **GET** /v1/projects/{project}/bookmarks | List bookmarks|
32
+ |[**listBookmarktabs**](#listbookmarktabs) | **GET** /v1/projects/{project}/bookmarktabs | List bookmark tabs|
33
+ |[**listTasks**](#listtasks) | **GET** /v1/projects/{project}/tasks | List Tasks|
34
+ |[**setupIntegration**](#setupintegration) | **POST** /v1/projects/{project}/integrations/{integration}/setup | Setup integration|
35
+ |[**uninstallIntegration**](#uninstallintegration) | **DELETE** /v1/projects/{project}/integrations/{integration} | Uninstall integration|
36
+ |[**updateBookmark**](#updatebookmark) | **PATCH** /v1/projects/{project}/bookmarks/{id} | Update bookmark|
37
+ |[**updateBookmarkTabs**](#updatebookmarktabs) | **PUT** /v1/projects/{project}/bookmarktabs | Update bookmark tabs|
38
+ |[**updateIntegration**](#updateintegration) | **PATCH** /v1/projects/{project}/integrations/{integration} | Update integration|
39
+ |[**updateProject**](#updateproject) | **PATCH** /v1/projects/{project} | Update project|
40
+ |[**updateTask**](#updatetask) | **PATCH** /v1/projects/{project}/tasks/{id} | Update Task|
41
+
42
+ # **createAuth**
43
+ > Auth createAuth()
44
+
45
+ Create an auth token for the project
46
+
47
+ ### Example
48
+
49
+ ```typescript
50
+ import {
51
+ ProjectsApi,
52
+ Configuration
53
+ } from '@teemill/projects';
54
+
55
+ const configuration = new Configuration();
56
+ const apiInstance = new ProjectsApi(configuration);
57
+
58
+ let project: string; //Projects unique identifier (default to undefined)
59
+
60
+ const { status, data } = await apiInstance.createAuth(
61
+ project
62
+ );
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ |Name | Type | Description | Notes|
68
+ |------------- | ------------- | ------------- | -------------|
69
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
70
+
71
+
72
+ ### Return type
73
+
74
+ **Auth**
75
+
76
+ ### Authorization
77
+
78
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
79
+
80
+ ### HTTP request headers
81
+
82
+ - **Content-Type**: Not defined
83
+ - **Accept**: application/json
84
+
85
+
86
+ ### HTTP response details
87
+ | Status code | Description | Response headers |
88
+ |-------------|-------------|------------------|
89
+ |**201** | Successfully retrieved an auth token | - |
90
+ |**400** | Failed validation | - |
91
+ |**401** | Not authorised to access this resource | - |
92
+ |**403** | Refuse to authorize | - |
93
+ |**500** | Unknown server error | - |
94
+
95
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
96
+
97
+ # **createBookmark**
98
+ > Bookmark createBookmark(createBookmarkRequest)
99
+
100
+ Create a bookmark in the project
101
+
102
+ ### Example
103
+
104
+ ```typescript
105
+ import {
106
+ ProjectsApi,
107
+ Configuration,
108
+ CreateBookmarkRequest
109
+ } from '@teemill/projects';
110
+
111
+ const configuration = new Configuration();
112
+ const apiInstance = new ProjectsApi(configuration);
113
+
114
+ let project: string; //Projects unique identifier (default to undefined)
115
+ let createBookmarkRequest: CreateBookmarkRequest; //Create a new bookmark in the project
116
+
117
+ const { status, data } = await apiInstance.createBookmark(
118
+ project,
119
+ createBookmarkRequest
120
+ );
121
+ ```
122
+
123
+ ### Parameters
124
+
125
+ |Name | Type | Description | Notes|
126
+ |------------- | ------------- | ------------- | -------------|
127
+ | **createBookmarkRequest** | **CreateBookmarkRequest**| Create a new bookmark in the project | |
128
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
129
+
130
+
131
+ ### Return type
132
+
133
+ **Bookmark**
134
+
135
+ ### Authorization
136
+
137
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
138
+
139
+ ### HTTP request headers
140
+
141
+ - **Content-Type**: application/json
142
+ - **Accept**: application/json
143
+
144
+
145
+ ### HTTP response details
146
+ | Status code | Description | Response headers |
147
+ |-------------|-------------|------------------|
148
+ |**201** | Successfully retrieved a bookmark | - |
149
+ |**400** | Failed validation | - |
150
+ |**401** | Not authorised to access this resource | - |
151
+ |**403** | Refuse to authorize | - |
152
+ |**500** | Unknown server error | - |
153
+
154
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
155
+
156
+ # **createInvite**
157
+ > ProjectInvite createInvite(createInviteRequest)
158
+
159
+ Creates an invite for the project
160
+
161
+ ### Example
162
+
163
+ ```typescript
164
+ import {
165
+ ProjectsApi,
166
+ Configuration,
167
+ CreateInviteRequest
168
+ } from '@teemill/projects';
169
+
170
+ const configuration = new Configuration();
171
+ const apiInstance = new ProjectsApi(configuration);
172
+
173
+ let project: string; //Projects unique identifier (default to undefined)
174
+ let createInviteRequest: CreateInviteRequest; //Request body to invite user
175
+
176
+ const { status, data } = await apiInstance.createInvite(
177
+ project,
178
+ createInviteRequest
179
+ );
180
+ ```
181
+
182
+ ### Parameters
183
+
184
+ |Name | Type | Description | Notes|
185
+ |------------- | ------------- | ------------- | -------------|
186
+ | **createInviteRequest** | **CreateInviteRequest**| Request body to invite user | |
187
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
188
+
189
+
190
+ ### Return type
191
+
192
+ **ProjectInvite**
193
+
194
+ ### Authorization
195
+
196
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
197
+
198
+ ### HTTP request headers
199
+
200
+ - **Content-Type**: application/json
201
+ - **Accept**: application/json
202
+
203
+
204
+ ### HTTP response details
205
+ | Status code | Description | Response headers |
206
+ |-------------|-------------|------------------|
207
+ |**201** | Successfully retrieved a project invite | - |
208
+ |**400** | Failed validation | - |
209
+ |**401** | Not authorised to access this resource | - |
210
+ |**403** | Refuse to authorize | - |
211
+ |**500** | Unknown server error | - |
212
+
213
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
214
+
215
+ # **createProject**
216
+ > Project createProject(createProjectRequest)
217
+
218
+ Create a new projects
219
+
220
+ ### Example
221
+
222
+ ```typescript
223
+ import {
224
+ ProjectsApi,
225
+ Configuration,
226
+ CreateProjectRequest
227
+ } from '@teemill/projects';
228
+
229
+ const configuration = new Configuration();
230
+ const apiInstance = new ProjectsApi(configuration);
231
+
232
+ let createProjectRequest: CreateProjectRequest; //Project to create
233
+
234
+ const { status, data } = await apiInstance.createProject(
235
+ createProjectRequest
236
+ );
237
+ ```
238
+
239
+ ### Parameters
240
+
241
+ |Name | Type | Description | Notes|
242
+ |------------- | ------------- | ------------- | -------------|
243
+ | **createProjectRequest** | **CreateProjectRequest**| Project to create | |
244
+
245
+
246
+ ### Return type
247
+
248
+ **Project**
249
+
250
+ ### Authorization
251
+
252
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
253
+
254
+ ### HTTP request headers
255
+
256
+ - **Content-Type**: application/json
257
+ - **Accept**: application/json
258
+
259
+
260
+ ### HTTP response details
261
+ | Status code | Description | Response headers |
262
+ |-------------|-------------|------------------|
263
+ |**201** | Successfully retrieved a project | - |
264
+ |**400** | Failed validation | - |
265
+ |**401** | Not authorised to access this resource | - |
266
+ |**403** | Refuse to authorize | - |
267
+ |**500** | Unknown server error | - |
268
+
269
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
270
+
271
+ # **createTask**
272
+ > Task createTask()
273
+
274
+ Create a new task in the workflow
275
+
276
+ ### Example
277
+
278
+ ```typescript
279
+ import {
280
+ ProjectsApi,
281
+ Configuration,
282
+ CreateTaskRequest
283
+ } from '@teemill/projects';
284
+
285
+ const configuration = new Configuration();
286
+ const apiInstance = new ProjectsApi(configuration);
287
+
288
+ let project: string; //Projects unique identifier (default to undefined)
289
+ let createTaskRequest: CreateTaskRequest; //Create a new task in the workflow (optional)
290
+
291
+ const { status, data } = await apiInstance.createTask(
292
+ project,
293
+ createTaskRequest
294
+ );
295
+ ```
296
+
297
+ ### Parameters
298
+
299
+ |Name | Type | Description | Notes|
300
+ |------------- | ------------- | ------------- | -------------|
301
+ | **createTaskRequest** | **CreateTaskRequest**| Create a new task in the workflow | |
302
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
303
+
304
+
305
+ ### Return type
306
+
307
+ **Task**
308
+
309
+ ### Authorization
310
+
311
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
312
+
313
+ ### HTTP request headers
314
+
315
+ - **Content-Type**: application/json
316
+ - **Accept**: application/json
317
+
318
+
319
+ ### HTTP response details
320
+ | Status code | Description | Response headers |
321
+ |-------------|-------------|------------------|
322
+ |**201** | A single task in the workflow | - |
323
+ |**400** | Failed validation | - |
324
+ |**401** | Not authorised to access this resource | - |
325
+ |**403** | Refuse to authorize | - |
326
+ |**500** | Unknown server error | - |
327
+
328
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
329
+
330
+ # **deleteAuth**
331
+ > deleteAuth()
332
+
333
+ Delete an auth token for the project
334
+
335
+ ### Example
336
+
337
+ ```typescript
338
+ import {
339
+ ProjectsApi,
340
+ Configuration
341
+ } from '@teemill/projects';
342
+
343
+ const configuration = new Configuration();
344
+ const apiInstance = new ProjectsApi(configuration);
345
+
346
+ let project: string; //Projects unique identifier (default to undefined)
347
+ let auth: string; //The unique id of the auth token (default to undefined)
348
+
349
+ const { status, data } = await apiInstance.deleteAuth(
350
+ project,
351
+ auth
352
+ );
353
+ ```
354
+
355
+ ### Parameters
356
+
357
+ |Name | Type | Description | Notes|
358
+ |------------- | ------------- | ------------- | -------------|
359
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
360
+ | **auth** | [**string**] | The unique id of the auth token | defaults to undefined|
361
+
362
+
363
+ ### Return type
364
+
365
+ void (empty response body)
366
+
367
+ ### Authorization
368
+
369
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
370
+
371
+ ### HTTP request headers
372
+
373
+ - **Content-Type**: Not defined
374
+ - **Accept**: application/json
375
+
376
+
377
+ ### HTTP response details
378
+ | Status code | Description | Response headers |
379
+ |-------------|-------------|------------------|
380
+ |**204** | Auth token deleted | - |
381
+ |**400** | Failed validation | - |
382
+ |**401** | Not authorised to access this resource | - |
383
+ |**403** | Refuse to authorize | - |
384
+
385
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
386
+
387
+ # **deleteBookmark**
388
+ > deleteBookmark()
389
+
390
+ Delete a bookmark in the project
391
+
392
+ ### Example
393
+
394
+ ```typescript
395
+ import {
396
+ ProjectsApi,
397
+ Configuration
398
+ } from '@teemill/projects';
399
+
400
+ const configuration = new Configuration();
401
+ const apiInstance = new ProjectsApi(configuration);
402
+
403
+ let project: string; //Projects unique identifier (default to undefined)
404
+ let id: string; //The unique id of the bookmark (default to undefined)
405
+
406
+ const { status, data } = await apiInstance.deleteBookmark(
407
+ project,
408
+ id
409
+ );
410
+ ```
411
+
412
+ ### Parameters
413
+
414
+ |Name | Type | Description | Notes|
415
+ |------------- | ------------- | ------------- | -------------|
416
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
417
+ | **id** | [**string**] | The unique id of the bookmark | defaults to undefined|
418
+
419
+
420
+ ### Return type
421
+
422
+ void (empty response body)
423
+
424
+ ### Authorization
425
+
426
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
427
+
428
+ ### HTTP request headers
429
+
430
+ - **Content-Type**: Not defined
431
+ - **Accept**: application/json
432
+
433
+
434
+ ### HTTP response details
435
+ | Status code | Description | Response headers |
436
+ |-------------|-------------|------------------|
437
+ |**204** | Bookmark deleted | - |
438
+ |**401** | Not authorised to access this resource | - |
439
+ |**403** | Refuse to authorize | - |
440
+ |**404** | Resource not found | - |
441
+ |**500** | Unknown server error | - |
442
+
443
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
444
+
445
+ # **deleteInvite**
446
+ > deleteInvite()
447
+
448
+ Deletes an invite to the project
449
+
450
+ ### Example
451
+
452
+ ```typescript
453
+ import {
454
+ ProjectsApi,
455
+ Configuration
456
+ } from '@teemill/projects';
457
+
458
+ const configuration = new Configuration();
459
+ const apiInstance = new ProjectsApi(configuration);
460
+
461
+ let project: string; //Projects unique identifier (default to undefined)
462
+ let invite: string; //The unique id of the invite (default to undefined)
463
+
464
+ const { status, data } = await apiInstance.deleteInvite(
465
+ project,
466
+ invite
467
+ );
468
+ ```
469
+
470
+ ### Parameters
471
+
472
+ |Name | Type | Description | Notes|
473
+ |------------- | ------------- | ------------- | -------------|
474
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
475
+ | **invite** | [**string**] | The unique id of the invite | defaults to undefined|
476
+
477
+
478
+ ### Return type
479
+
480
+ void (empty response body)
481
+
482
+ ### Authorization
483
+
484
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
485
+
486
+ ### HTTP request headers
487
+
488
+ - **Content-Type**: Not defined
489
+ - **Accept**: application/json
490
+
491
+
492
+ ### HTTP response details
493
+ | Status code | Description | Response headers |
494
+ |-------------|-------------|------------------|
495
+ |**204** | Invite deleted | - |
496
+ |**400** | Failed validation | - |
497
+ |**401** | Not authorised to access this resource | - |
498
+ |**403** | Refuse to authorize | - |
499
+ |**500** | Unknown server error | - |
500
+
501
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
502
+
503
+ # **deleteProject**
504
+ > deleteProject()
505
+
506
+ Delete a project
507
+
508
+ ### Example
509
+
510
+ ```typescript
511
+ import {
512
+ ProjectsApi,
513
+ Configuration
514
+ } from '@teemill/projects';
515
+
516
+ const configuration = new Configuration();
517
+ const apiInstance = new ProjectsApi(configuration);
518
+
519
+ let project: string; //Projects unique identifier (default to undefined)
520
+
521
+ const { status, data } = await apiInstance.deleteProject(
522
+ project
523
+ );
524
+ ```
525
+
526
+ ### Parameters
527
+
528
+ |Name | Type | Description | Notes|
529
+ |------------- | ------------- | ------------- | -------------|
530
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
531
+
532
+
533
+ ### Return type
534
+
535
+ void (empty response body)
536
+
537
+ ### Authorization
538
+
539
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
540
+
541
+ ### HTTP request headers
542
+
543
+ - **Content-Type**: Not defined
544
+ - **Accept**: application/json
545
+
546
+
547
+ ### HTTP response details
548
+ | Status code | Description | Response headers |
549
+ |-------------|-------------|------------------|
550
+ |**204** | Project deleted | - |
551
+ |**400** | Failed validation | - |
552
+ |**401** | Not authorised to access this resource | - |
553
+ |**403** | Refuse to authorize | - |
554
+ |**404** | Resource not found | - |
555
+ |**500** | Unknown server error | - |
556
+
557
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
558
+
559
+ # **deleteTask**
560
+ > deleteTask()
561
+
562
+ Delete a task in the workflow
563
+
564
+ ### Example
565
+
566
+ ```typescript
567
+ import {
568
+ ProjectsApi,
569
+ Configuration
570
+ } from '@teemill/projects';
571
+
572
+ const configuration = new Configuration();
573
+ const apiInstance = new ProjectsApi(configuration);
574
+
575
+ let project: string; //Projects unique identifier (default to undefined)
576
+ let id: string; //The unique id of the task (default to undefined)
577
+
578
+ const { status, data } = await apiInstance.deleteTask(
579
+ project,
580
+ id
581
+ );
582
+ ```
583
+
584
+ ### Parameters
585
+
586
+ |Name | Type | Description | Notes|
587
+ |------------- | ------------- | ------------- | -------------|
588
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
589
+ | **id** | [**string**] | The unique id of the task | defaults to undefined|
590
+
591
+
592
+ ### Return type
593
+
594
+ void (empty response body)
595
+
596
+ ### Authorization
597
+
598
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
599
+
600
+ ### HTTP request headers
601
+
602
+ - **Content-Type**: Not defined
603
+ - **Accept**: application/json
604
+
605
+
606
+ ### HTTP response details
607
+ | Status code | Description | Response headers |
608
+ |-------------|-------------|------------------|
609
+ |**204** | Task deleted | - |
610
+ |**401** | Not authorised to access this resource | - |
611
+ |**403** | Refuse to authorize | - |
612
+ |**404** | Resource not found | - |
613
+ |**500** | Unknown server error | - |
614
+
615
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
616
+
617
+ # **deleteUser**
618
+ > deleteUser()
619
+
620
+ Delete a project user by ID
621
+
622
+ ### Example
623
+
624
+ ```typescript
625
+ import {
626
+ ProjectsApi,
627
+ Configuration
628
+ } from '@teemill/projects';
629
+
630
+ const configuration = new Configuration();
631
+ const apiInstance = new ProjectsApi(configuration);
632
+
633
+ let project: string; //Projects unique identifier (default to undefined)
634
+ let user: string; //the unique id of the user (default to undefined)
635
+
636
+ const { status, data } = await apiInstance.deleteUser(
637
+ project,
638
+ user
639
+ );
640
+ ```
641
+
642
+ ### Parameters
643
+
644
+ |Name | Type | Description | Notes|
645
+ |------------- | ------------- | ------------- | -------------|
646
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
647
+ | **user** | [**string**] | the unique id of the user | defaults to undefined|
648
+
649
+
650
+ ### Return type
651
+
652
+ void (empty response body)
653
+
654
+ ### Authorization
655
+
656
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
657
+
658
+ ### HTTP request headers
659
+
660
+ - **Content-Type**: Not defined
661
+ - **Accept**: application/json
662
+
663
+
664
+ ### HTTP response details
665
+ | Status code | Description | Response headers |
666
+ |-------------|-------------|------------------|
667
+ |**204** | Successfully deleted a user | - |
668
+ |**400** | Failed validation | - |
669
+ |**401** | Not authorised to access this resource | - |
670
+ |**403** | Refuse to authorize | - |
671
+ |**404** | Resource not found | - |
672
+ |**500** | Unknown server error | - |
673
+
674
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
675
+
676
+ # **exportTasks**
677
+ > File exportTasks()
678
+
679
+ Export all the tasks in the workflow
680
+
681
+ ### Example
682
+
683
+ ```typescript
684
+ import {
685
+ ProjectsApi,
686
+ Configuration
687
+ } from '@teemill/projects';
688
+
689
+ const configuration = new Configuration();
690
+ const apiInstance = new ProjectsApi(configuration);
691
+
692
+ let project: string; //Projects unique identifier (default to undefined)
693
+
694
+ const { status, data } = await apiInstance.exportTasks(
695
+ project
696
+ );
697
+ ```
698
+
699
+ ### Parameters
700
+
701
+ |Name | Type | Description | Notes|
702
+ |------------- | ------------- | ------------- | -------------|
703
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
704
+
705
+
706
+ ### Return type
707
+
708
+ **File**
709
+
710
+ ### Authorization
711
+
712
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
713
+
714
+ ### HTTP request headers
715
+
716
+ - **Content-Type**: Not defined
717
+ - **Accept**: text/csv; charset=utf-8, application/json
718
+
719
+
720
+ ### HTTP response details
721
+ | Status code | Description | Response headers |
722
+ |-------------|-------------|------------------|
723
+ |**200** | Returns the CSV export | - |
724
+ |**202** | Export started. When complete, the export will be available for download from a notification within PodOS Dashboard. | - |
725
+ |**401** | Not authorised to access this resource | - |
726
+ |**403** | Refuse to authorize | - |
727
+ |**500** | Unknown server error | - |
728
+
729
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
730
+
731
+ # **getAuth**
732
+ > AuthResponse getAuth()
733
+
734
+ Lists the auth tokens for the project
735
+
736
+ ### Example
737
+
738
+ ```typescript
739
+ import {
740
+ ProjectsApi,
741
+ Configuration
742
+ } from '@teemill/projects';
743
+
744
+ const configuration = new Configuration();
745
+ const apiInstance = new ProjectsApi(configuration);
746
+
747
+ let project: string; //Projects unique identifier (default to undefined)
748
+
749
+ const { status, data } = await apiInstance.getAuth(
750
+ project
751
+ );
752
+ ```
753
+
754
+ ### Parameters
755
+
756
+ |Name | Type | Description | Notes|
757
+ |------------- | ------------- | ------------- | -------------|
758
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
759
+
760
+
761
+ ### Return type
762
+
763
+ **AuthResponse**
764
+
765
+ ### Authorization
766
+
767
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
768
+
769
+ ### HTTP request headers
770
+
771
+ - **Content-Type**: Not defined
772
+ - **Accept**: application/json
773
+
774
+
775
+ ### HTTP response details
776
+ | Status code | Description | Response headers |
777
+ |-------------|-------------|------------------|
778
+ |**200** | Successfully retrieved all auth tokens | - |
779
+ |**400** | Failed validation | - |
780
+ |**401** | Not authorised to access this resource | - |
781
+ |**403** | Refuse to authorize | - |
782
+ |**500** | Unknown server error | - |
783
+
784
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
785
+
786
+ # **getIntegration**
787
+ > Integration getIntegration()
788
+
789
+ Get an integration
790
+
791
+ ### Example
792
+
793
+ ```typescript
794
+ import {
795
+ ProjectsApi,
796
+ Configuration
797
+ } from '@teemill/projects';
798
+
799
+ const configuration = new Configuration();
800
+ const apiInstance = new ProjectsApi(configuration);
801
+
802
+ let project: string; //Projects unique identifier (default to undefined)
803
+ let integration: string; //Integrations unique code (default to undefined)
804
+
805
+ const { status, data } = await apiInstance.getIntegration(
806
+ project,
807
+ integration
808
+ );
809
+ ```
810
+
811
+ ### Parameters
812
+
813
+ |Name | Type | Description | Notes|
814
+ |------------- | ------------- | ------------- | -------------|
815
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
816
+ | **integration** | [**string**] | Integrations unique code | defaults to undefined|
817
+
818
+
819
+ ### Return type
820
+
821
+ **Integration**
822
+
823
+ ### Authorization
824
+
825
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
826
+
827
+ ### HTTP request headers
828
+
829
+ - **Content-Type**: Not defined
830
+ - **Accept**: application/json
831
+
832
+
833
+ ### HTTP response details
834
+ | Status code | Description | Response headers |
835
+ |-------------|-------------|------------------|
836
+ |**200** | Successfully retrieved a integration | - |
837
+ |**400** | Failed validation | - |
838
+ |**401** | Not authorised to access this resource | - |
839
+ |**403** | Refuse to authorize | - |
840
+ |**404** | Resource not found | - |
841
+ |**500** | Unknown server error | - |
842
+
843
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
844
+
845
+ # **getIntegrations**
846
+ > IntegrationsResponse getIntegrations()
847
+
848
+ List all integrations installed on a project
849
+
850
+ ### Example
851
+
852
+ ```typescript
853
+ import {
854
+ ProjectsApi,
855
+ Configuration
856
+ } from '@teemill/projects';
857
+
858
+ const configuration = new Configuration();
859
+ const apiInstance = new ProjectsApi(configuration);
860
+
861
+ let project: string; //Projects unique identifier (default to undefined)
862
+ let withUninstalled: string; //Include soft deleted integrations (optional) (default to undefined)
863
+
864
+ const { status, data } = await apiInstance.getIntegrations(
865
+ project,
866
+ withUninstalled
867
+ );
868
+ ```
869
+
870
+ ### Parameters
871
+
872
+ |Name | Type | Description | Notes|
873
+ |------------- | ------------- | ------------- | -------------|
874
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
875
+ | **withUninstalled** | [**string**] | Include soft deleted integrations | (optional) defaults to undefined|
876
+
877
+
878
+ ### Return type
879
+
880
+ **IntegrationsResponse**
881
+
882
+ ### Authorization
883
+
884
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
885
+
886
+ ### HTTP request headers
887
+
888
+ - **Content-Type**: Not defined
889
+ - **Accept**: application/json
890
+
891
+
892
+ ### HTTP response details
893
+ | Status code | Description | Response headers |
894
+ |-------------|-------------|------------------|
895
+ |**200** | Successfully retrieved projects integrations | - |
896
+ |**400** | Failed validation | - |
897
+ |**401** | Not authorised to access this resource | - |
898
+ |**403** | Refuse to authorize | - |
899
+ |**500** | Unknown server error | - |
900
+
901
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
902
+
903
+ # **getInvites**
904
+ > ProjectInvites getInvites()
905
+
906
+ List the invites associated with a project
907
+
908
+ ### Example
909
+
910
+ ```typescript
911
+ import {
912
+ ProjectsApi,
913
+ Configuration
914
+ } from '@teemill/projects';
915
+
916
+ const configuration = new Configuration();
917
+ const apiInstance = new ProjectsApi(configuration);
918
+
919
+ let project: string; //Projects unique identifier (default to undefined)
920
+ let search: string; //Search term used to filter results by (optional) (default to undefined)
921
+ let pageToken: number; //Page reference token (optional) (default to 1)
922
+ let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it could be smaller if there are less records than the max page size. (optional) (default to 100)
923
+
924
+ const { status, data } = await apiInstance.getInvites(
925
+ project,
926
+ search,
927
+ pageToken,
928
+ pageSize
929
+ );
930
+ ```
931
+
932
+ ### Parameters
933
+
934
+ |Name | Type | Description | Notes|
935
+ |------------- | ------------- | ------------- | -------------|
936
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
937
+ | **search** | [**string**] | Search term used to filter results by | (optional) defaults to undefined|
938
+ | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
939
+ | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it could be smaller if there are less records than the max page size. | (optional) defaults to 100|
940
+
941
+
942
+ ### Return type
943
+
944
+ **ProjectInvites**
945
+
946
+ ### Authorization
947
+
948
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
949
+
950
+ ### HTTP request headers
951
+
952
+ - **Content-Type**: Not defined
953
+ - **Accept**: application/json
954
+
955
+
956
+ ### HTTP response details
957
+ | Status code | Description | Response headers |
958
+ |-------------|-------------|------------------|
959
+ |**200** | Successfully retrieved a list of invites | - |
960
+ |**400** | Failed validation | - |
961
+ |**401** | Not authorised to access this resource | - |
962
+ |**403** | Refuse to authorize | - |
963
+ |**500** | Unknown server error | - |
964
+
965
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
966
+
967
+ # **getProject**
968
+ > Project getProject()
969
+
970
+ Get a project
971
+
972
+ ### Example
973
+
974
+ ```typescript
975
+ import {
976
+ ProjectsApi,
977
+ Configuration
978
+ } from '@teemill/projects';
979
+
980
+ const configuration = new Configuration();
981
+ const apiInstance = new ProjectsApi(configuration);
982
+
983
+ let project: string; //Projects unique identifier (default to undefined)
984
+
985
+ const { status, data } = await apiInstance.getProject(
986
+ project
987
+ );
988
+ ```
989
+
990
+ ### Parameters
991
+
992
+ |Name | Type | Description | Notes|
993
+ |------------- | ------------- | ------------- | -------------|
994
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
995
+
996
+
997
+ ### Return type
998
+
999
+ **Project**
1000
+
1001
+ ### Authorization
1002
+
1003
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1004
+
1005
+ ### HTTP request headers
1006
+
1007
+ - **Content-Type**: Not defined
1008
+ - **Accept**: application/json
1009
+
1010
+
1011
+ ### HTTP response details
1012
+ | Status code | Description | Response headers |
1013
+ |-------------|-------------|------------------|
1014
+ |**200** | Successfully retrieved a project | - |
1015
+ |**400** | Failed validation | - |
1016
+ |**401** | Not authorised to access this resource | - |
1017
+ |**403** | Refuse to authorize | - |
1018
+ |**404** | Resource not found | - |
1019
+ |**500** | Unknown server error | - |
1020
+
1021
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1022
+
1023
+ # **getProjects**
1024
+ > ProjectsResponse getProjects()
1025
+
1026
+ List all projects available
1027
+
1028
+ ### Example
1029
+
1030
+ ```typescript
1031
+ import {
1032
+ ProjectsApi,
1033
+ Configuration
1034
+ } from '@teemill/projects';
1035
+
1036
+ const configuration = new Configuration();
1037
+ const apiInstance = new ProjectsApi(configuration);
1038
+
1039
+ let project: string; //What project it is (optional) (default to undefined)
1040
+
1041
+ const { status, data } = await apiInstance.getProjects(
1042
+ project
1043
+ );
1044
+ ```
1045
+
1046
+ ### Parameters
1047
+
1048
+ |Name | Type | Description | Notes|
1049
+ |------------- | ------------- | ------------- | -------------|
1050
+ | **project** | [**string**] | What project it is | (optional) defaults to undefined|
1051
+
1052
+
1053
+ ### Return type
1054
+
1055
+ **ProjectsResponse**
1056
+
1057
+ ### Authorization
1058
+
1059
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1060
+
1061
+ ### HTTP request headers
1062
+
1063
+ - **Content-Type**: Not defined
1064
+ - **Accept**: application/json
1065
+
1066
+
1067
+ ### HTTP response details
1068
+ | Status code | Description | Response headers |
1069
+ |-------------|-------------|------------------|
1070
+ |**200** | Successfully retrieved all projects | - |
1071
+ |**400** | Failed validation | - |
1072
+ |**401** | Not authorised to access this resource | - |
1073
+ |**403** | Refuse to authorize | - |
1074
+ |**500** | Unknown server error | - |
1075
+
1076
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1077
+
1078
+ # **getTask**
1079
+ > Task getTask()
1080
+
1081
+ Get a task in the workflow
1082
+
1083
+ ### Example
1084
+
1085
+ ```typescript
1086
+ import {
1087
+ ProjectsApi,
1088
+ Configuration
1089
+ } from '@teemill/projects';
1090
+
1091
+ const configuration = new Configuration();
1092
+ const apiInstance = new ProjectsApi(configuration);
1093
+
1094
+ let project: string; //Projects unique identifier (default to undefined)
1095
+ let id: string; //The unique id of the task (default to undefined)
1096
+
1097
+ const { status, data } = await apiInstance.getTask(
1098
+ project,
1099
+ id
1100
+ );
1101
+ ```
1102
+
1103
+ ### Parameters
1104
+
1105
+ |Name | Type | Description | Notes|
1106
+ |------------- | ------------- | ------------- | -------------|
1107
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1108
+ | **id** | [**string**] | The unique id of the task | defaults to undefined|
1109
+
1110
+
1111
+ ### Return type
1112
+
1113
+ **Task**
1114
+
1115
+ ### Authorization
1116
+
1117
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1118
+
1119
+ ### HTTP request headers
1120
+
1121
+ - **Content-Type**: Not defined
1122
+ - **Accept**: application/json
1123
+
1124
+
1125
+ ### HTTP response details
1126
+ | Status code | Description | Response headers |
1127
+ |-------------|-------------|------------------|
1128
+ |**200** | A single task in the workflow | - |
1129
+ |**401** | Not authorised to access this resource | - |
1130
+ |**403** | Refuse to authorize | - |
1131
+ |**404** | Resource not found | - |
1132
+ |**410** | Resource permanently removed | - |
1133
+ |**500** | Unknown server error | - |
1134
+
1135
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1136
+
1137
+ # **getTemplates**
1138
+ > TemplatesResponse getTemplates()
1139
+
1140
+ List all templates available
1141
+
1142
+ ### Example
1143
+
1144
+ ```typescript
1145
+ import {
1146
+ ProjectsApi,
1147
+ Configuration
1148
+ } from '@teemill/projects';
1149
+
1150
+ const configuration = new Configuration();
1151
+ const apiInstance = new ProjectsApi(configuration);
1152
+
1153
+ let project: string; //The project being accessed (optional) (default to undefined)
1154
+
1155
+ const { status, data } = await apiInstance.getTemplates(
1156
+ project
1157
+ );
1158
+ ```
1159
+
1160
+ ### Parameters
1161
+
1162
+ |Name | Type | Description | Notes|
1163
+ |------------- | ------------- | ------------- | -------------|
1164
+ | **project** | [**string**] | The project being accessed | (optional) defaults to undefined|
1165
+
1166
+
1167
+ ### Return type
1168
+
1169
+ **TemplatesResponse**
1170
+
1171
+ ### Authorization
1172
+
1173
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1174
+
1175
+ ### HTTP request headers
1176
+
1177
+ - **Content-Type**: Not defined
1178
+ - **Accept**: application/json
1179
+
1180
+
1181
+ ### HTTP response details
1182
+ | Status code | Description | Response headers |
1183
+ |-------------|-------------|------------------|
1184
+ |**200** | Successfully retrieved a list of templates | - |
1185
+ |**400** | Failed validation | - |
1186
+ |**401** | Not authorised to access this resource | - |
1187
+ |**403** | Refuse to authorize | - |
1188
+ |**500** | Unknown server error | - |
1189
+
1190
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1191
+
1192
+ # **getUser**
1193
+ > ProjectUser getUser()
1194
+
1195
+ Get a project user by id
1196
+
1197
+ ### Example
1198
+
1199
+ ```typescript
1200
+ import {
1201
+ ProjectsApi,
1202
+ Configuration
1203
+ } from '@teemill/projects';
1204
+
1205
+ const configuration = new Configuration();
1206
+ const apiInstance = new ProjectsApi(configuration);
1207
+
1208
+ let project: string; //Projects unique identifier (default to undefined)
1209
+ let user: string; //the unique id of the user (default to undefined)
1210
+
1211
+ const { status, data } = await apiInstance.getUser(
1212
+ project,
1213
+ user
1214
+ );
1215
+ ```
1216
+
1217
+ ### Parameters
1218
+
1219
+ |Name | Type | Description | Notes|
1220
+ |------------- | ------------- | ------------- | -------------|
1221
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1222
+ | **user** | [**string**] | the unique id of the user | defaults to undefined|
1223
+
1224
+
1225
+ ### Return type
1226
+
1227
+ **ProjectUser**
1228
+
1229
+ ### Authorization
1230
+
1231
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1232
+
1233
+ ### HTTP request headers
1234
+
1235
+ - **Content-Type**: Not defined
1236
+ - **Accept**: application/json
1237
+
1238
+
1239
+ ### HTTP response details
1240
+ | Status code | Description | Response headers |
1241
+ |-------------|-------------|------------------|
1242
+ |**200** | Successfully retrieved a project user | - |
1243
+ |**400** | Failed validation | - |
1244
+ |**401** | Not authorised to access this resource | - |
1245
+ |**403** | Refuse to authorize | - |
1246
+ |**404** | Resource not found | - |
1247
+ |**500** | Unknown server error | - |
1248
+
1249
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1250
+
1251
+ # **getUsers**
1252
+ > ProjectUsers getUsers()
1253
+
1254
+ List the users associated with a project
1255
+
1256
+ ### Example
1257
+
1258
+ ```typescript
1259
+ import {
1260
+ ProjectsApi,
1261
+ Configuration
1262
+ } from '@teemill/projects';
1263
+
1264
+ const configuration = new Configuration();
1265
+ const apiInstance = new ProjectsApi(configuration);
1266
+
1267
+ let project: string; //Projects unique identifier (default to undefined)
1268
+ let search: string; //Search term used to filter results by (optional) (default to undefined)
1269
+ let pageToken: number; //Page reference token (optional) (default to 1)
1270
+ let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it could be smaller if there are less records than the max page size. (optional) (default to 100)
1271
+
1272
+ const { status, data } = await apiInstance.getUsers(
1273
+ project,
1274
+ search,
1275
+ pageToken,
1276
+ pageSize
1277
+ );
1278
+ ```
1279
+
1280
+ ### Parameters
1281
+
1282
+ |Name | Type | Description | Notes|
1283
+ |------------- | ------------- | ------------- | -------------|
1284
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1285
+ | **search** | [**string**] | Search term used to filter results by | (optional) defaults to undefined|
1286
+ | **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
1287
+ | **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it could be smaller if there are less records than the max page size. | (optional) defaults to 100|
1288
+
1289
+
1290
+ ### Return type
1291
+
1292
+ **ProjectUsers**
1293
+
1294
+ ### Authorization
1295
+
1296
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1297
+
1298
+ ### HTTP request headers
1299
+
1300
+ - **Content-Type**: Not defined
1301
+ - **Accept**: application/json
1302
+
1303
+
1304
+ ### HTTP response details
1305
+ | Status code | Description | Response headers |
1306
+ |-------------|-------------|------------------|
1307
+ |**200** | Successfully retrieved a list of users | - |
1308
+ |**400** | Failed validation | - |
1309
+ |**401** | Not authorised to access this resource | - |
1310
+ |**403** | Refuse to authorize | - |
1311
+ |**500** | Unknown server error | - |
1312
+
1313
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1314
+
1315
+ # **installIntegration**
1316
+ > Integration installIntegration()
1317
+
1318
+ Install an integration on the project
1319
+
1320
+ ### Example
1321
+
1322
+ ```typescript
1323
+ import {
1324
+ ProjectsApi,
1325
+ Configuration
1326
+ } from '@teemill/projects';
1327
+
1328
+ const configuration = new Configuration();
1329
+ const apiInstance = new ProjectsApi(configuration);
1330
+
1331
+ let project: string; //Projects unique identifier (default to undefined)
1332
+ let integration: string; //Integrations unique code (default to undefined)
1333
+
1334
+ const { status, data } = await apiInstance.installIntegration(
1335
+ project,
1336
+ integration
1337
+ );
1338
+ ```
1339
+
1340
+ ### Parameters
1341
+
1342
+ |Name | Type | Description | Notes|
1343
+ |------------- | ------------- | ------------- | -------------|
1344
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1345
+ | **integration** | [**string**] | Integrations unique code | defaults to undefined|
1346
+
1347
+
1348
+ ### Return type
1349
+
1350
+ **Integration**
1351
+
1352
+ ### Authorization
1353
+
1354
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1355
+
1356
+ ### HTTP request headers
1357
+
1358
+ - **Content-Type**: Not defined
1359
+ - **Accept**: application/json
1360
+
1361
+
1362
+ ### HTTP response details
1363
+ | Status code | Description | Response headers |
1364
+ |-------------|-------------|------------------|
1365
+ |**201** | Successfully retrieved a integration | - |
1366
+ |**400** | Failed validation | - |
1367
+ |**401** | Not authorised to access this resource | - |
1368
+ |**403** | Refuse to authorize | - |
1369
+ |**500** | Unknown server error | - |
1370
+
1371
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1372
+
1373
+ # **installTemplate**
1374
+ > IntegrationsResponse installTemplate(installTemplateRequest)
1375
+
1376
+ Install an integration template on the project
1377
+
1378
+ ### Example
1379
+
1380
+ ```typescript
1381
+ import {
1382
+ ProjectsApi,
1383
+ Configuration,
1384
+ InstallTemplateRequest
1385
+ } from '@teemill/projects';
1386
+
1387
+ const configuration = new Configuration();
1388
+ const apiInstance = new ProjectsApi(configuration);
1389
+
1390
+ let project: string; //Projects unique identifier (default to undefined)
1391
+ let template: TemplateCode; //Templates unique code (default to undefined)
1392
+ let installTemplateRequest: InstallTemplateRequest; //Request body to install template
1393
+
1394
+ const { status, data } = await apiInstance.installTemplate(
1395
+ project,
1396
+ template,
1397
+ installTemplateRequest
1398
+ );
1399
+ ```
1400
+
1401
+ ### Parameters
1402
+
1403
+ |Name | Type | Description | Notes|
1404
+ |------------- | ------------- | ------------- | -------------|
1405
+ | **installTemplateRequest** | **InstallTemplateRequest**| Request body to install template | |
1406
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1407
+ | **template** | **TemplateCode** | Templates unique code | defaults to undefined|
1408
+
1409
+
1410
+ ### Return type
1411
+
1412
+ **IntegrationsResponse**
1413
+
1414
+ ### Authorization
1415
+
1416
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1417
+
1418
+ ### HTTP request headers
1419
+
1420
+ - **Content-Type**: application/json
1421
+ - **Accept**: application/json
1422
+
1423
+
1424
+ ### HTTP response details
1425
+ | Status code | Description | Response headers |
1426
+ |-------------|-------------|------------------|
1427
+ |**201** | Successfully retrieved projects integrations | - |
1428
+ |**400** | Failed validation | - |
1429
+ |**401** | Not authorised to access this resource | - |
1430
+ |**403** | Refuse to authorize | - |
1431
+ |**500** | Unknown server error | - |
1432
+
1433
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1434
+
1435
+ # **listBookmarks**
1436
+ > Bookmarks listBookmarks()
1437
+
1438
+ List the bookmarks in the project
1439
+
1440
+ ### Example
1441
+
1442
+ ```typescript
1443
+ import {
1444
+ ProjectsApi,
1445
+ Configuration
1446
+ } from '@teemill/projects';
1447
+
1448
+ const configuration = new Configuration();
1449
+ const apiInstance = new ProjectsApi(configuration);
1450
+
1451
+ let project: string; //Projects unique identifier (default to undefined)
1452
+
1453
+ const { status, data } = await apiInstance.listBookmarks(
1454
+ project
1455
+ );
1456
+ ```
1457
+
1458
+ ### Parameters
1459
+
1460
+ |Name | Type | Description | Notes|
1461
+ |------------- | ------------- | ------------- | -------------|
1462
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1463
+
1464
+
1465
+ ### Return type
1466
+
1467
+ **Bookmarks**
1468
+
1469
+ ### Authorization
1470
+
1471
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1472
+
1473
+ ### HTTP request headers
1474
+
1475
+ - **Content-Type**: Not defined
1476
+ - **Accept**: application/json
1477
+
1478
+
1479
+ ### HTTP response details
1480
+ | Status code | Description | Response headers |
1481
+ |-------------|-------------|------------------|
1482
+ |**200** | Successfully retrieved a list of bookmarks | - |
1483
+ |**401** | Not authorised to access this resource | - |
1484
+ |**403** | Refuse to authorize | - |
1485
+ |**500** | Unknown server error | - |
1486
+
1487
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1488
+
1489
+ # **listBookmarktabs**
1490
+ > BookmarkTabs listBookmarktabs()
1491
+
1492
+ List the bookmark tabs in the project
1493
+
1494
+ ### Example
1495
+
1496
+ ```typescript
1497
+ import {
1498
+ ProjectsApi,
1499
+ Configuration
1500
+ } from '@teemill/projects';
1501
+
1502
+ const configuration = new Configuration();
1503
+ const apiInstance = new ProjectsApi(configuration);
1504
+
1505
+ let project: string; //Projects unique identifier (default to undefined)
1506
+
1507
+ const { status, data } = await apiInstance.listBookmarktabs(
1508
+ project
1509
+ );
1510
+ ```
1511
+
1512
+ ### Parameters
1513
+
1514
+ |Name | Type | Description | Notes|
1515
+ |------------- | ------------- | ------------- | -------------|
1516
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1517
+
1518
+
1519
+ ### Return type
1520
+
1521
+ **BookmarkTabs**
1522
+
1523
+ ### Authorization
1524
+
1525
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1526
+
1527
+ ### HTTP request headers
1528
+
1529
+ - **Content-Type**: Not defined
1530
+ - **Accept**: application/json
1531
+
1532
+
1533
+ ### HTTP response details
1534
+ | Status code | Description | Response headers |
1535
+ |-------------|-------------|------------------|
1536
+ |**200** | Successfully retrieved a list of bookmark tabs | - |
1537
+ |**401** | Not authorised to access this resource | - |
1538
+ |**403** | Refuse to authorize | - |
1539
+ |**500** | Unknown server error | - |
1540
+
1541
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1542
+
1543
+ # **listTasks**
1544
+ > ListTasksResponse listTasks()
1545
+
1546
+ List the tasks in the workflow
1547
+
1548
+ ### Example
1549
+
1550
+ ```typescript
1551
+ import {
1552
+ ProjectsApi,
1553
+ Configuration
1554
+ } from '@teemill/projects';
1555
+
1556
+ const configuration = new Configuration();
1557
+ const apiInstance = new ProjectsApi(configuration);
1558
+
1559
+ let project: string; //Projects unique identifier (default to undefined)
1560
+
1561
+ const { status, data } = await apiInstance.listTasks(
1562
+ project
1563
+ );
1564
+ ```
1565
+
1566
+ ### Parameters
1567
+
1568
+ |Name | Type | Description | Notes|
1569
+ |------------- | ------------- | ------------- | -------------|
1570
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1571
+
1572
+
1573
+ ### Return type
1574
+
1575
+ **ListTasksResponse**
1576
+
1577
+ ### Authorization
1578
+
1579
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1580
+
1581
+ ### HTTP request headers
1582
+
1583
+ - **Content-Type**: Not defined
1584
+ - **Accept**: application/json
1585
+
1586
+
1587
+ ### HTTP response details
1588
+ | Status code | Description | Response headers |
1589
+ |-------------|-------------|------------------|
1590
+ |**200** | List of tasks in the workflow | - |
1591
+ |**401** | Not authorised to access this resource | - |
1592
+ |**403** | Refuse to authorize | - |
1593
+ |**500** | Unknown server error | - |
1594
+
1595
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1596
+
1597
+ # **setupIntegration**
1598
+ > Integration setupIntegration(updateIntegrationRequest)
1599
+
1600
+ Setup an integration on the project
1601
+
1602
+ ### Example
1603
+
1604
+ ```typescript
1605
+ import {
1606
+ ProjectsApi,
1607
+ Configuration,
1608
+ UpdateIntegrationRequest
1609
+ } from '@teemill/projects';
1610
+
1611
+ const configuration = new Configuration();
1612
+ const apiInstance = new ProjectsApi(configuration);
1613
+
1614
+ let project: string; //Projects unique identifier (default to undefined)
1615
+ let integration: string; //Integrations unique code (default to undefined)
1616
+ let updateIntegrationRequest: UpdateIntegrationRequest; //Request body to setup integration
1617
+
1618
+ const { status, data } = await apiInstance.setupIntegration(
1619
+ project,
1620
+ integration,
1621
+ updateIntegrationRequest
1622
+ );
1623
+ ```
1624
+
1625
+ ### Parameters
1626
+
1627
+ |Name | Type | Description | Notes|
1628
+ |------------- | ------------- | ------------- | -------------|
1629
+ | **updateIntegrationRequest** | **UpdateIntegrationRequest**| Request body to setup integration | |
1630
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1631
+ | **integration** | [**string**] | Integrations unique code | defaults to undefined|
1632
+
1633
+
1634
+ ### Return type
1635
+
1636
+ **Integration**
1637
+
1638
+ ### Authorization
1639
+
1640
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1641
+
1642
+ ### HTTP request headers
1643
+
1644
+ - **Content-Type**: application/json
1645
+ - **Accept**: application/json
1646
+
1647
+
1648
+ ### HTTP response details
1649
+ | Status code | Description | Response headers |
1650
+ |-------------|-------------|------------------|
1651
+ |**200** | Successfully retrieved a integration | - |
1652
+ |**400** | Failed validation | - |
1653
+ |**401** | Not authorised to access this resource | - |
1654
+ |**403** | Refuse to authorize | - |
1655
+ |**500** | Unknown server error | - |
1656
+
1657
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1658
+
1659
+ # **uninstallIntegration**
1660
+ > uninstallIntegration()
1661
+
1662
+ Uninstall a projects integration
1663
+
1664
+ ### Example
1665
+
1666
+ ```typescript
1667
+ import {
1668
+ ProjectsApi,
1669
+ Configuration
1670
+ } from '@teemill/projects';
1671
+
1672
+ const configuration = new Configuration();
1673
+ const apiInstance = new ProjectsApi(configuration);
1674
+
1675
+ let project: string; //Projects unique identifier (default to undefined)
1676
+ let integration: string; //Integrations unique code (default to undefined)
1677
+
1678
+ const { status, data } = await apiInstance.uninstallIntegration(
1679
+ project,
1680
+ integration
1681
+ );
1682
+ ```
1683
+
1684
+ ### Parameters
1685
+
1686
+ |Name | Type | Description | Notes|
1687
+ |------------- | ------------- | ------------- | -------------|
1688
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1689
+ | **integration** | [**string**] | Integrations unique code | defaults to undefined|
1690
+
1691
+
1692
+ ### Return type
1693
+
1694
+ void (empty response body)
1695
+
1696
+ ### Authorization
1697
+
1698
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1699
+
1700
+ ### HTTP request headers
1701
+
1702
+ - **Content-Type**: Not defined
1703
+ - **Accept**: application/json
1704
+
1705
+
1706
+ ### HTTP response details
1707
+ | Status code | Description | Response headers |
1708
+ |-------------|-------------|------------------|
1709
+ |**200** | Integration uninstalled | - |
1710
+ |**400** | Failed validation | - |
1711
+ |**401** | Not authorised to access this resource | - |
1712
+ |**403** | Refuse to authorize | - |
1713
+ |**404** | Resource not found | - |
1714
+ |**500** | Unknown server error | - |
1715
+
1716
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1717
+
1718
+ # **updateBookmark**
1719
+ > Bookmark updateBookmark(updateBookmarkRequest)
1720
+
1721
+ Update a bookmark in the project
1722
+
1723
+ ### Example
1724
+
1725
+ ```typescript
1726
+ import {
1727
+ ProjectsApi,
1728
+ Configuration,
1729
+ UpdateBookmarkRequest
1730
+ } from '@teemill/projects';
1731
+
1732
+ const configuration = new Configuration();
1733
+ const apiInstance = new ProjectsApi(configuration);
1734
+
1735
+ let project: string; //Projects unique identifier (default to undefined)
1736
+ let id: string; //The unique id of the bookmark (default to undefined)
1737
+ let updateBookmarkRequest: UpdateBookmarkRequest; //Update a bookmark in the project
1738
+
1739
+ const { status, data } = await apiInstance.updateBookmark(
1740
+ project,
1741
+ id,
1742
+ updateBookmarkRequest
1743
+ );
1744
+ ```
1745
+
1746
+ ### Parameters
1747
+
1748
+ |Name | Type | Description | Notes|
1749
+ |------------- | ------------- | ------------- | -------------|
1750
+ | **updateBookmarkRequest** | **UpdateBookmarkRequest**| Update a bookmark in the project | |
1751
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1752
+ | **id** | [**string**] | The unique id of the bookmark | defaults to undefined|
1753
+
1754
+
1755
+ ### Return type
1756
+
1757
+ **Bookmark**
1758
+
1759
+ ### Authorization
1760
+
1761
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1762
+
1763
+ ### HTTP request headers
1764
+
1765
+ - **Content-Type**: application/json
1766
+ - **Accept**: application/json
1767
+
1768
+
1769
+ ### HTTP response details
1770
+ | Status code | Description | Response headers |
1771
+ |-------------|-------------|------------------|
1772
+ |**200** | Successfully retrieved a bookmark | - |
1773
+ |**400** | Failed validation | - |
1774
+ |**401** | Not authorised to access this resource | - |
1775
+ |**403** | Refuse to authorize | - |
1776
+ |**500** | Unknown server error | - |
1777
+
1778
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1779
+
1780
+ # **updateBookmarkTabs**
1781
+ > BookmarkTabs updateBookmarkTabs(updateBookmarkTabsRequest)
1782
+
1783
+ Update bookmark tabs
1784
+
1785
+ ### Example
1786
+
1787
+ ```typescript
1788
+ import {
1789
+ ProjectsApi,
1790
+ Configuration,
1791
+ UpdateBookmarkTabsRequest
1792
+ } from '@teemill/projects';
1793
+
1794
+ const configuration = new Configuration();
1795
+ const apiInstance = new ProjectsApi(configuration);
1796
+
1797
+ let project: string; //Projects unique identifier (default to undefined)
1798
+ let updateBookmarkTabsRequest: UpdateBookmarkTabsRequest; //Update a bookmark tab in the project
1799
+
1800
+ const { status, data } = await apiInstance.updateBookmarkTabs(
1801
+ project,
1802
+ updateBookmarkTabsRequest
1803
+ );
1804
+ ```
1805
+
1806
+ ### Parameters
1807
+
1808
+ |Name | Type | Description | Notes|
1809
+ |------------- | ------------- | ------------- | -------------|
1810
+ | **updateBookmarkTabsRequest** | **UpdateBookmarkTabsRequest**| Update a bookmark tab in the project | |
1811
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1812
+
1813
+
1814
+ ### Return type
1815
+
1816
+ **BookmarkTabs**
1817
+
1818
+ ### Authorization
1819
+
1820
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1821
+
1822
+ ### HTTP request headers
1823
+
1824
+ - **Content-Type**: application/json
1825
+ - **Accept**: application/json
1826
+
1827
+
1828
+ ### HTTP response details
1829
+ | Status code | Description | Response headers |
1830
+ |-------------|-------------|------------------|
1831
+ |**200** | Successfully retrieved a list of bookmark tabs | - |
1832
+ |**400** | Failed validation | - |
1833
+ |**401** | Not authorised to access this resource | - |
1834
+ |**403** | Refuse to authorize | - |
1835
+ |**500** | Unknown server error | - |
1836
+
1837
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1838
+
1839
+ # **updateIntegration**
1840
+ > Integration updateIntegration(updateIntegrationRequest)
1841
+
1842
+ Update an integration on the project
1843
+
1844
+ ### Example
1845
+
1846
+ ```typescript
1847
+ import {
1848
+ ProjectsApi,
1849
+ Configuration,
1850
+ UpdateIntegrationRequest
1851
+ } from '@teemill/projects';
1852
+
1853
+ const configuration = new Configuration();
1854
+ const apiInstance = new ProjectsApi(configuration);
1855
+
1856
+ let project: string; //Projects unique identifier (default to undefined)
1857
+ let integration: string; //Integrations unique code (default to undefined)
1858
+ let updateIntegrationRequest: UpdateIntegrationRequest; //Request body to update an integration
1859
+
1860
+ const { status, data } = await apiInstance.updateIntegration(
1861
+ project,
1862
+ integration,
1863
+ updateIntegrationRequest
1864
+ );
1865
+ ```
1866
+
1867
+ ### Parameters
1868
+
1869
+ |Name | Type | Description | Notes|
1870
+ |------------- | ------------- | ------------- | -------------|
1871
+ | **updateIntegrationRequest** | **UpdateIntegrationRequest**| Request body to update an integration | |
1872
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1873
+ | **integration** | [**string**] | Integrations unique code | defaults to undefined|
1874
+
1875
+
1876
+ ### Return type
1877
+
1878
+ **Integration**
1879
+
1880
+ ### Authorization
1881
+
1882
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1883
+
1884
+ ### HTTP request headers
1885
+
1886
+ - **Content-Type**: application/json
1887
+ - **Accept**: application/json
1888
+
1889
+
1890
+ ### HTTP response details
1891
+ | Status code | Description | Response headers |
1892
+ |-------------|-------------|------------------|
1893
+ |**200** | Successfully retrieved a integration | - |
1894
+ |**400** | Failed validation | - |
1895
+ |**401** | Not authorised to access this resource | - |
1896
+ |**403** | Refuse to authorize | - |
1897
+ |**500** | Unknown server error | - |
1898
+
1899
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1900
+
1901
+ # **updateProject**
1902
+ > Project updateProject(updateProjectRequest)
1903
+
1904
+ Update a project
1905
+
1906
+ ### Example
1907
+
1908
+ ```typescript
1909
+ import {
1910
+ ProjectsApi,
1911
+ Configuration,
1912
+ UpdateProjectRequest
1913
+ } from '@teemill/projects';
1914
+
1915
+ const configuration = new Configuration();
1916
+ const apiInstance = new ProjectsApi(configuration);
1917
+
1918
+ let project: string; //Projects unique identifier (default to undefined)
1919
+ let updateProjectRequest: UpdateProjectRequest; //Updated project data
1920
+
1921
+ const { status, data } = await apiInstance.updateProject(
1922
+ project,
1923
+ updateProjectRequest
1924
+ );
1925
+ ```
1926
+
1927
+ ### Parameters
1928
+
1929
+ |Name | Type | Description | Notes|
1930
+ |------------- | ------------- | ------------- | -------------|
1931
+ | **updateProjectRequest** | **UpdateProjectRequest**| Updated project data | |
1932
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1933
+
1934
+
1935
+ ### Return type
1936
+
1937
+ **Project**
1938
+
1939
+ ### Authorization
1940
+
1941
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
1942
+
1943
+ ### HTTP request headers
1944
+
1945
+ - **Content-Type**: application/json
1946
+ - **Accept**: application/json
1947
+
1948
+
1949
+ ### HTTP response details
1950
+ | Status code | Description | Response headers |
1951
+ |-------------|-------------|------------------|
1952
+ |**200** | Successfully retrieved a project | - |
1953
+ |**400** | Failed validation | - |
1954
+ |**401** | Not authorised to access this resource | - |
1955
+ |**403** | Refuse to authorize | - |
1956
+ |**404** | Resource not found | - |
1957
+ |**500** | Unknown server error | - |
1958
+
1959
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1960
+
1961
+ # **updateTask**
1962
+ > Task updateTask()
1963
+
1964
+ Update a task in the workflow
1965
+
1966
+ ### Example
1967
+
1968
+ ```typescript
1969
+ import {
1970
+ ProjectsApi,
1971
+ Configuration,
1972
+ UpdateTaskRequest
1973
+ } from '@teemill/projects';
1974
+
1975
+ const configuration = new Configuration();
1976
+ const apiInstance = new ProjectsApi(configuration);
1977
+
1978
+ let project: string; //Projects unique identifier (default to undefined)
1979
+ let id: string; //The unique id of the task (default to undefined)
1980
+ let updateTaskRequest: UpdateTaskRequest; //Update a task in the workflow (optional)
1981
+
1982
+ const { status, data } = await apiInstance.updateTask(
1983
+ project,
1984
+ id,
1985
+ updateTaskRequest
1986
+ );
1987
+ ```
1988
+
1989
+ ### Parameters
1990
+
1991
+ |Name | Type | Description | Notes|
1992
+ |------------- | ------------- | ------------- | -------------|
1993
+ | **updateTaskRequest** | **UpdateTaskRequest**| Update a task in the workflow | |
1994
+ | **project** | [**string**] | Projects unique identifier | defaults to undefined|
1995
+ | **id** | [**string**] | The unique id of the task | defaults to undefined|
1996
+
1997
+
1998
+ ### Return type
1999
+
2000
+ **Task**
2001
+
2002
+ ### Authorization
2003
+
2004
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
2005
+
2006
+ ### HTTP request headers
2007
+
2008
+ - **Content-Type**: application/json
2009
+ - **Accept**: application/json
2010
+
2011
+
2012
+ ### HTTP response details
2013
+ | Status code | Description | Response headers |
2014
+ |-------------|-------------|------------------|
2015
+ |**200** | A single task in the workflow | - |
2016
+ |**400** | Failed validation | - |
2017
+ |**401** | Not authorised to access this resource | - |
2018
+ |**403** | Refuse to authorize | - |
2019
+ |**404** | Resource not found | - |
2020
+ |**500** | Unknown server error | - |
2021
+
2022
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
2023
+