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