-
Notifications
You must be signed in to change notification settings - Fork 12
/
apis.ts
6322 lines (5297 loc) · 306 KB
/
apis.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import fetch, {Response, RequestInit} from 'node-fetch'
import {version} from '../package.json'
import FormData = require('form-data')
import {AppCardCreateRequest} from '../model/appCardCreateRequest'
import {AppCardItem} from '../model/appCardItem'
import {AppCardUpdateRequest} from '../model/appCardUpdateRequest'
import {GetBoards400Response} from '../model/getBoards400Response'
import {GetMetrics200ResponseInner} from '../model/getMetrics200ResponseInner'
import {GetMetrics404Response} from '../model/getMetrics404Response'
import {GetMetricsTotal200Response} from '../model/getMetricsTotal200Response'
import {GetMetricsTotal404Response} from '../model/getMetricsTotal404Response'
import {AuditPage} from '../model/auditPage'
import {BoardDataClassificationLabel} from '../model/boardDataClassificationLabel'
import {DataClassificationLabelId} from '../model/dataClassificationLabelId'
import {DataClassificationOrganizationSettings} from '../model/dataClassificationOrganizationSettings'
import {DataClassificationTeamSettings} from '../model/dataClassificationTeamSettings'
import {UpdateBoardsDataClassificationLabel} from '../model/updateBoardsDataClassificationLabel'
import {UpdateBoardsDataClassificationLabelRequest} from '../model/updateBoardsDataClassificationLabelRequest'
import {UpdateTeamSettingsRequest} from '../model/updateTeamSettingsRequest'
import {GetBoardItemContentLogsResponse} from '../model/getBoardItemContentLogsResponse'
import {BoardExportJobId} from '../model/boardExportJobId'
import {BoardExportJobStatus} from '../model/boardExportJobStatus'
import {BoardExportResult} from '../model/boardExportResult'
import {CreateBoardExportRequest} from '../model/createBoardExportRequest'
import {BoardMemberChanges} from '../model/boardMemberChanges'
import {BoardMemberWithLinks} from '../model/boardMemberWithLinks'
import {BoardMembersInvite} from '../model/boardMembersInvite'
import {BoardMembersPagedResponse} from '../model/boardMembersPagedResponse'
import {InvitationResult} from '../model/invitationResult'
import {BoardChanges} from '../model/boardChanges'
import {BoardWithLinks} from '../model/boardWithLinks'
import {BoardWithLinksAndLastOpened} from '../model/boardWithLinksAndLastOpened'
import {BoardWithLinksAndWithoutProject} from '../model/boardWithLinksAndWithoutProject'
import {BoardsPagedResponse} from '../model/boardsPagedResponse'
import {CopyBoardChanges} from '../model/copyBoardChanges'
import {BulkOperationError} from '../model/bulkOperationError'
import {ItemCreate} from '../model/itemCreate'
import {Items} from '../model/items'
import {CardCreateRequest} from '../model/cardCreateRequest'
import {CardItem} from '../model/cardItem'
import {CardUpdateRequest} from '../model/cardUpdateRequest'
import {ConnectorChangesData} from '../model/connectorChangesData'
import {ConnectorCreationData} from '../model/connectorCreationData'
import {ConnectorWithLinks} from '../model/connectorWithLinks'
import {ConnectorsCursorPaged} from '../model/connectorsCursorPaged'
import {CreateDocumentItemUsingFileFromDeviceRequestData} from '../model/createDocumentItemUsingFileFromDeviceRequestData'
import {DocumentCreateRequest} from '../model/documentCreateRequest'
import {DocumentItem} from '../model/documentItem'
import {DocumentUpdateRequest} from '../model/documentUpdateRequest'
import {UploadFileFromDeviceData} from '../model/uploadFileFromDeviceData'
import {EmbedCreateRequest} from '../model/embedCreateRequest'
import {EmbedItem} from '../model/embedItem'
import {EmbedUpdateRequest} from '../model/embedUpdateRequest'
import {GenericItem} from '../model/genericItem'
import {GenericItemCursorPaged} from '../model/genericItemCursorPaged'
import {ShapeCreateRequest} from '../model/shapeCreateRequest'
import {ShapeItem} from '../model/shapeItem'
import {ShapeUpdateRequest} from '../model/shapeUpdateRequest'
import {FrameCreateRequest} from '../model/frameCreateRequest'
import {FrameItem} from '../model/frameItem'
import {FrameUpdateRequest} from '../model/frameUpdateRequest'
import {GetAllGroups200Response} from '../model/getAllGroups200Response'
import {GetAllGroups400Response} from '../model/getAllGroups400Response'
import {GetAllGroups404Response} from '../model/getAllGroups404Response'
import {GetAllGroups429Response} from '../model/getAllGroups429Response'
import {GetItemsByGroupId200Response} from '../model/getItemsByGroupId200Response'
import {Group} from '../model/group'
import {GroupResponseShort} from '../model/groupResponseShort'
import {UnGroup400Response} from '../model/unGroup400Response'
import {UnGroup404Response} from '../model/unGroup404Response'
import {UnGroup429Response} from '../model/unGroup429Response'
import {ImageCreateRequest} from '../model/imageCreateRequest'
import {ImageItem} from '../model/imageItem'
import {ImageUpdateRequest} from '../model/imageUpdateRequest'
import {GenericItemUpdate} from '../model/genericItemUpdate'
import {MindmapCreateRequest} from '../model/mindmapCreateRequest'
import {MindmapCursorPaged} from '../model/mindmapCursorPaged'
import {MindmapItem} from '../model/mindmapItem'
import {EnterpriseGetOrganizationMembers200Response} from '../model/enterpriseGetOrganizationMembers200Response'
import {OrganizationMember} from '../model/organizationMember'
import {Organization} from '../model/organization'
import {AddProjectMemberRequest} from '../model/addProjectMemberRequest'
import {Error400} from '../model/error400'
import {Error401} from '../model/error401'
import {Error403} from '../model/error403'
import {Error404} from '../model/error404'
import {Error409} from '../model/error409'
import {Error429} from '../model/error429'
import {ProjectMember} from '../model/projectMember'
import {ProjectMemberPage} from '../model/projectMemberPage'
import {UpdateProjectMemberRequest} from '../model/updateProjectMemberRequest'
import {ProjectSettings} from '../model/projectSettings'
import {UpdateProjectSettingsRequest} from '../model/updateProjectSettingsRequest'
import {CreateProjectRequest} from '../model/createProjectRequest'
import {Project} from '../model/project'
import {ProjectPage} from '../model/projectPage'
import {UpdateProjectRequest} from '../model/updateProjectRequest'
import {StickyNoteCreateRequest} from '../model/stickyNoteCreateRequest'
import {StickyNoteItem} from '../model/stickyNoteItem'
import {StickyNoteUpdateRequest} from '../model/stickyNoteUpdateRequest'
import {GetTagsFromItem400Response} from '../model/getTagsFromItem400Response'
import {GetTagsResponse} from '../model/getTagsResponse'
import {ItemPagedResponse} from '../model/itemPagedResponse'
import {TagCreateRequest} from '../model/tagCreateRequest'
import {TagUpdateRequest} from '../model/tagUpdateRequest'
import {TagWithLinks} from '../model/tagWithLinks'
import {TagsPagedResponse} from '../model/tagsPagedResponse'
import {TeamMember} from '../model/teamMember'
import {TeamMemberChanges} from '../model/teamMemberChanges'
import {TeamMemberInvite} from '../model/teamMemberInvite'
import {TeamMembersPage} from '../model/teamMembersPage'
import {TeamSettings} from '../model/teamSettings'
import {TeamSettingsChanges} from '../model/teamSettingsChanges'
import {CreateTeamRequest} from '../model/createTeamRequest'
import {Team} from '../model/team'
import {TeamChanges} from '../model/teamChanges'
import {TeamsPage} from '../model/teamsPage'
import {TextCreateRequest} from '../model/textCreateRequest'
import {TextItem} from '../model/textItem'
import {TextUpdateRequest} from '../model/textUpdateRequest'
import {TokenInformation} from '../model/tokenInformation'
import {BoardSubscription} from '../model/boardSubscription'
import {CreateBoardSubscriptionRequest} from '../model/createBoardSubscriptionRequest'
import {GenericSubscription} from '../model/genericSubscription'
import {GenericSubscriptionsCursorPaged} from '../model/genericSubscriptionsCursorPaged'
import {UpdateBoardSubscriptionRequest} from '../model/updateBoardSubscriptionRequest'
import {ObjectSerializer, RequestFile} from '../model/models'
let defaultBasePath = 'https://api.miro.com'
export type Logger = (...thing: any) => void
export class MiroApi {
accessToken: string | (() => Promise<string>)
basePath: string
logger?: Logger
httpTimeout?: number
constructor(
accessToken: string | (() => Promise<string>),
basePath: string = defaultBasePath,
logger?: Logger,
httpTimeout?: number,
) {
this.accessToken = accessToken
this.basePath = basePath
this.logger = logger
this.httpTimeout = httpTimeout
}
/**
* Adds an app card item to a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a><br/>
* @summary Create app card item
* @param boardId Unique identifier (ID) of the board where you want to create the item.
* @param appCardCreateRequest
*/
async createAppCardItem(
boardId: string,
appCardCreateRequest: AppCardCreateRequest,
): Promise<{response: Response; body: AppCardItem}> {
const localVarPath = '/v2/boards/{board_id}/app_cards'.replace(
'{' + 'board_id' + '}',
encodeURIComponent(String(boardId)),
)
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'boardId' is not null or undefined
if (boardId === null || boardId === undefined) {
throw new Error('Required parameter boardId was null or undefined when calling createAppCardItem.')
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'POST',
urlResource,
JSON.stringify(ObjectSerializer.serialize(appCardCreateRequest, 'AppCardCreateRequest')),
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'AppCardItem')
return {response, body}
}
/**
* Deletes an app card item from a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 3</a><br/>
* @summary Delete app card item
* @param boardId Unique identifier (ID) of the board from which you want to delete an item.
* @param itemId Unique identifier (ID) of the item that you want to delete.
*/
async deleteAppCardItem(boardId: string, itemId: string): Promise<{response: Response; body: object}> {
const localVarPath = '/v2/boards/{board_id}/app_cards/{item_id}'
.replace('{' + 'board_id' + '}', encodeURIComponent(String(boardId)))
.replace('{' + 'item_id' + '}', encodeURIComponent(String(itemId)))
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'boardId' is not null or undefined
if (boardId === null || boardId === undefined) {
throw new Error('Required parameter boardId was null or undefined when calling deleteAppCardItem.')
}
// verify required parameter 'itemId' is not null or undefined
if (itemId === null || itemId === undefined) {
throw new Error('Required parameter itemId was null or undefined when calling deleteAppCardItem.')
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'DELETE',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'object')
return {response, body}
}
/**
* Retrieves information for a specific app card item on a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 1</a><br/>
* @summary Get app card item
* @param boardId Unique identifier (ID) of the board from which you want to retrieve a specific item.
* @param itemId Unique identifier (ID) of the item that you want to retrieve.
*/
async getAppCardItem(boardId: string, itemId: string): Promise<{response: Response; body: AppCardItem}> {
const localVarPath = '/v2/boards/{board_id}/app_cards/{item_id}'
.replace('{' + 'board_id' + '}', encodeURIComponent(String(boardId)))
.replace('{' + 'item_id' + '}', encodeURIComponent(String(itemId)))
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'boardId' is not null or undefined
if (boardId === null || boardId === undefined) {
throw new Error('Required parameter boardId was null or undefined when calling getAppCardItem.')
}
// verify required parameter 'itemId' is not null or undefined
if (itemId === null || itemId === undefined) {
throw new Error('Required parameter itemId was null or undefined when calling getAppCardItem.')
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'GET',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'AppCardItem')
return {response, body}
}
/**
* Updates an app card item on a board based on the data and style properties provided in the request body.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a><br/>
* @summary Update app card item
* @param boardId Unique identifier (ID) of the board where you want to update the item.
* @param itemId Unique identifier (ID) of the item that you want to update.
* @param appCardUpdateRequest
*/
async updateAppCardItem(
boardId: string,
itemId: string,
appCardUpdateRequest: AppCardUpdateRequest,
): Promise<{response: Response; body: AppCardItem}> {
const localVarPath = '/v2/boards/{board_id}/app_cards/{item_id}'
.replace('{' + 'board_id' + '}', encodeURIComponent(String(boardId)))
.replace('{' + 'item_id' + '}', encodeURIComponent(String(itemId)))
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'boardId' is not null or undefined
if (boardId === null || boardId === undefined) {
throw new Error('Required parameter boardId was null or undefined when calling updateAppCardItem.')
}
// verify required parameter 'itemId' is not null or undefined
if (itemId === null || itemId === undefined) {
throw new Error('Required parameter itemId was null or undefined when calling updateAppCardItem.')
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'PATCH',
urlResource,
JSON.stringify(ObjectSerializer.serialize(appCardUpdateRequest, 'AppCardUpdateRequest')),
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'AppCardItem')
return {response, body}
}
/**
* Returns a list of usage metrics for a specific app for a given time range, grouped by requested time period. This endpoint requires an app management API token. It can be generated in the <a href=\"https://developers.miro.com/?features=appMetricsToken#your-apps\">Your Apps</a> section of Developer Hub.
* @summary Get app metrics
* @param appId ID of the app to get metrics for.
* @param startDate Start date of the period in UTC format. For example, 2024-12-31.
* @param endDate End date of the period in UTC format. For example, 2024-12-31.
* @param period Group data by this time period.
*/
async getMetrics(
appId: string,
startDate: string,
endDate: string,
query?: {
period?: 'DAY' | 'WEEK' | 'MONTH'
},
): Promise<{response: Response; body: Array<GetMetrics200ResponseInner>}> {
const localVarPath = '/v2-experimental/apps/{app_id}/metrics'.replace(
'{' + 'app_id' + '}',
encodeURIComponent(String(appId)),
)
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'appId' is not null or undefined
if (appId === null || appId === undefined) {
throw new Error('Required parameter appId was null or undefined when calling getMetrics.')
}
// verify required parameter 'startDate' is not null or undefined
if (startDate === null || startDate === undefined) {
throw new Error('Required parameter startDate was null or undefined when calling getMetrics.')
}
if (startDate !== undefined) {
localVarQueryParameters.append('startDate', ObjectSerializer.serialize(startDate, 'string'))
}
// verify required parameter 'endDate' is not null or undefined
if (endDate === null || endDate === undefined) {
throw new Error('Required parameter endDate was null or undefined when calling getMetrics.')
}
if (endDate !== undefined) {
localVarQueryParameters.append('endDate', ObjectSerializer.serialize(endDate, 'string'))
}
if (query?.period !== undefined) {
localVarQueryParameters.append('period', ObjectSerializer.serialize(query?.period, "'DAY' | 'WEEK' | 'MONTH'"))
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'GET',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'Array<GetMetrics200ResponseInner>')
return {response, body}
}
/**
* Returns total usage metrics for a specific app since the app was created. This endpoint requires an app management API token. It can be generated in <a href=\"https://developers.miro.com/?features=appMetricsToken#your-apps\">your apps</a> section of Developer Hub.
* @summary Get total app metrics
* @param appId ID of the app to get total metrics for.
*/
async getMetricsTotal(appId: string): Promise<{response: Response; body: GetMetricsTotal200Response}> {
const localVarPath = '/v2-experimental/apps/{app_id}/metrics-total'.replace(
'{' + 'app_id' + '}',
encodeURIComponent(String(appId)),
)
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'appId' is not null or undefined
if (appId === null || appId === undefined) {
throw new Error('Required parameter appId was null or undefined when calling getMetricsTotal.')
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'GET',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'GetMetricsTotal200Response')
return {response, body}
}
/**
* Retrieves a page of audit events.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>auditlogs:read</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a>
* @summary Get audit logs
* @param createdAfter Retrieve audit logs created after the date and time provided. This is the start date of the duration for which you want to retrieve audit logs. For example, if you want to retrieve audit logs between `2023-03-30T17:26:50.000Z` and `2023-04-30T17:26:50.000Z`, provide `2023-03-30T17:26:50.000Z` as the value for the `createdAfter` parameter.<br>Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), including milliseconds and a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).\"
* @param createdBefore Retrieve audit logs created before the date and time provided. This is the end date of the duration for which you want to retrieve audit logs. For example, if you want to retrieve audit logs between `2023-03-30T17:26:50.000Z` and `2023-04-30T17:26:50.000Z`, provide `2023-04-30T17:26:50.000Z` as the value for the `createdBefore` parameter.<br>Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), including milliseconds and a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
* @param cursor A cursor-paginated method returns a portion of the total set of results based on the `limit` specified and a `cursor` that points to the next portion of the results. To retrieve the next set of results of the collection, set the `cursor` parameter in your next request to the appropriate cursor value returned in the response.
* @param limit Maximum number of results returned based on the `limit` specified in the request. For example, if there are `30` results, the request has no `cursor` value, and the `limit` is set to `20`,the `size` of the results will be `20`. The rest of the results will not be returned. To retrieve the rest of the results, you must make another request and set the appropriate value for the `cursor` parameter value that you obtained from the response.<br>Default: `100`
* @param sorting Sort order in which you want to view the result set. Based on the value you provide, the results are sorted in an ascending or descending order of the audit log creation date (audit log `createdAt` parameter).<br>Default: `ASC`
*/
async enterpriseGetAuditLogs(
createdAfter: string,
createdBefore: string,
query?: {
cursor?: string
limit?: number
sorting?: 'ASC' | 'DESC'
},
): Promise<{response: Response; body: AuditPage}> {
const localVarPath = '/v2/audit/logs'
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'createdAfter' is not null or undefined
if (createdAfter === null || createdAfter === undefined) {
throw new Error('Required parameter createdAfter was null or undefined when calling enterpriseGetAuditLogs.')
}
if (createdAfter !== undefined) {
localVarQueryParameters.append('createdAfter', ObjectSerializer.serialize(createdAfter, 'string'))
}
// verify required parameter 'createdBefore' is not null or undefined
if (createdBefore === null || createdBefore === undefined) {
throw new Error('Required parameter createdBefore was null or undefined when calling enterpriseGetAuditLogs.')
}
if (createdBefore !== undefined) {
localVarQueryParameters.append('createdBefore', ObjectSerializer.serialize(createdBefore, 'string'))
}
if (query?.cursor !== undefined) {
localVarQueryParameters.append('cursor', ObjectSerializer.serialize(query?.cursor, 'string'))
}
if (query?.limit !== undefined) {
localVarQueryParameters.append('limit', ObjectSerializer.serialize(query?.limit, 'number'))
}
if (query?.sorting !== undefined) {
localVarQueryParameters.append('sorting', ObjectSerializer.serialize(query?.sorting, "'ASC' | 'DESC'"))
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'GET',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'AuditPage')
return {response, body}
}
/**
* Retrieves board classification for a board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:read</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=_blank href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href=\"https://miro-survey.typeform.com/to/BVPTNWJ9\">this form</a>.</p>
* @summary Get board classification
* @param orgId id of the organization
* @param teamId id of the team
* @param boardId Unique identifier of the board that you want to retrieve.
*/
async enterpriseDataclassificationBoardGet(
orgId: string,
teamId: string,
boardId: string,
): Promise<{response: Response; body: BoardDataClassificationLabel}> {
const localVarPath = '/v2/orgs/{org_id}/teams/{team_id}/boards/{board_id}/data-classification'
.replace('{' + 'org_id' + '}', encodeURIComponent(String(orgId)))
.replace('{' + 'team_id' + '}', encodeURIComponent(String(teamId)))
.replace('{' + 'board_id' + '}', encodeURIComponent(String(boardId)))
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'orgId' is not null or undefined
if (orgId === null || orgId === undefined) {
throw new Error(
'Required parameter orgId was null or undefined when calling enterpriseDataclassificationBoardGet.',
)
}
// verify required parameter 'teamId' is not null or undefined
if (teamId === null || teamId === undefined) {
throw new Error(
'Required parameter teamId was null or undefined when calling enterpriseDataclassificationBoardGet.',
)
}
// verify required parameter 'boardId' is not null or undefined
if (boardId === null || boardId === undefined) {
throw new Error(
'Required parameter boardId was null or undefined when calling enterpriseDataclassificationBoardGet.',
)
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'GET',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'BoardDataClassificationLabel')
return {response, body}
}
/**
* Updates board classification for an existing board.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=_blank href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href=\"https://miro-survey.typeform.com/to/BVPTNWJ9\">this form</a>.</p>
* @summary Update board classification
* @param orgId id of the organization
* @param teamId id of the team
* @param boardId Unique identifier of the board that you want to update.
* @param dataClassificationLabelId
*/
async enterpriseDataclassificationBoardSet(
orgId: string,
teamId: string,
boardId: string,
dataClassificationLabelId: DataClassificationLabelId,
): Promise<{response: Response; body: BoardDataClassificationLabel}> {
const localVarPath = '/v2/orgs/{org_id}/teams/{team_id}/boards/{board_id}/data-classification'
.replace('{' + 'org_id' + '}', encodeURIComponent(String(orgId)))
.replace('{' + 'team_id' + '}', encodeURIComponent(String(teamId)))
.replace('{' + 'board_id' + '}', encodeURIComponent(String(boardId)))
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'orgId' is not null or undefined
if (orgId === null || orgId === undefined) {
throw new Error(
'Required parameter orgId was null or undefined when calling enterpriseDataclassificationBoardSet.',
)
}
// verify required parameter 'teamId' is not null or undefined
if (teamId === null || teamId === undefined) {
throw new Error(
'Required parameter teamId was null or undefined when calling enterpriseDataclassificationBoardSet.',
)
}
// verify required parameter 'boardId' is not null or undefined
if (boardId === null || boardId === undefined) {
throw new Error(
'Required parameter boardId was null or undefined when calling enterpriseDataclassificationBoardSet.',
)
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'POST',
urlResource,
JSON.stringify(ObjectSerializer.serialize(dataClassificationLabelId, 'DataClassificationLabelId')),
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'BoardDataClassificationLabel')
return {response, body}
}
/**
* Retrieves board classification settings for an existing organization.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organizations:read</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=_blank href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href=\"https://miro-survey.typeform.com/to/BVPTNWJ9\">this form</a>.</p>
* @summary Get organization settings
* @param orgId id of the organization
*/
async enterpriseDataclassificationOrganizationSettingsGet(
orgId: string,
): Promise<{response: Response; body: DataClassificationOrganizationSettings}> {
const localVarPath = '/v2/orgs/{org_id}/data-classification-settings'.replace(
'{' + 'org_id' + '}',
encodeURIComponent(String(orgId)),
)
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'orgId' is not null or undefined
if (orgId === null || orgId === undefined) {
throw new Error(
'Required parameter orgId was null or undefined when calling enterpriseDataclassificationOrganizationSettingsGet.',
)
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'GET',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'DataClassificationOrganizationSettings')
return {response, body}
}
/**
* Updates board classification for not-classified only or all boards in an existing team.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:write</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 4</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=_blank href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href=\"https://miro-survey.typeform.com/to/BVPTNWJ9\">this form</a>.</p>
* @summary Bulk update boards classification
* @param orgId id of the organization
* @param teamId id of the team
* @param updateBoardsDataClassificationLabelRequest
*/
async enterpriseDataclassificationTeamBoardsBulk(
orgId: string,
teamId: string,
updateBoardsDataClassificationLabelRequest: UpdateBoardsDataClassificationLabelRequest,
): Promise<{response: Response; body: UpdateBoardsDataClassificationLabel}> {
const localVarPath = '/v2/orgs/{org_id}/teams/{team_id}/data-classification'
.replace('{' + 'org_id' + '}', encodeURIComponent(String(orgId)))
.replace('{' + 'team_id' + '}', encodeURIComponent(String(teamId)))
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'orgId' is not null or undefined
if (orgId === null || orgId === undefined) {
throw new Error(
'Required parameter orgId was null or undefined when calling enterpriseDataclassificationTeamBoardsBulk.',
)
}
// verify required parameter 'teamId' is not null or undefined
if (teamId === null || teamId === undefined) {
throw new Error(
'Required parameter teamId was null or undefined when calling enterpriseDataclassificationTeamBoardsBulk.',
)
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'PATCH',
urlResource,
JSON.stringify(
ObjectSerializer.serialize(
updateBoardsDataClassificationLabelRequest,
'UpdateBoardsDataClassificationLabelRequest',
),
),
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'UpdateBoardsDataClassificationLabel')
return {response, body}
}
/**
* Retrieves board classification settings for an existing team.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organizations:teams:read</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=_blank href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href=\"https://miro-survey.typeform.com/to/BVPTNWJ9\">this form</a>.</p>
* @summary Get team settings
* @param orgId id of the organization
* @param teamId id of the team
*/
async enterpriseDataclassificationTeamSettingsGet(
orgId: string,
teamId: string,
): Promise<{response: Response; body: DataClassificationTeamSettings}> {
const localVarPath = '/v2/orgs/{org_id}/teams/{team_id}/data-classification-settings'
.replace('{' + 'org_id' + '}', encodeURIComponent(String(orgId)))
.replace('{' + 'team_id' + '}', encodeURIComponent(String(teamId)))
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'orgId' is not null or undefined
if (orgId === null || orgId === undefined) {
throw new Error(
'Required parameter orgId was null or undefined when calling enterpriseDataclassificationTeamSettingsGet.',
)
}
// verify required parameter 'teamId' is not null or undefined
if (teamId === null || teamId === undefined) {
throw new Error(
'Required parameter teamId was null or undefined when calling enterpriseDataclassificationTeamSettingsGet.',
)
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'GET',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'DataClassificationTeamSettings')
return {response, body}
}
/**
* Updates board classification settings for an existing team.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>organizations:teams:write</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 2</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=_blank href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href=\"https://miro-survey.typeform.com/to/BVPTNWJ9\">this form</a>.</p>
* @summary Update team settings
* @param orgId id of the organization
* @param teamId id of the team
* @param updateTeamSettingsRequest
*/
async enterpriseDataclassificationTeamSettingsSet(
orgId: string,
teamId: string,
updateTeamSettingsRequest: UpdateTeamSettingsRequest,
): Promise<{response: Response; body: DataClassificationTeamSettings}> {
const localVarPath = '/v2/orgs/{org_id}/teams/{team_id}/data-classification-settings'
.replace('{' + 'org_id' + '}', encodeURIComponent(String(orgId)))
.replace('{' + 'team_id' + '}', encodeURIComponent(String(teamId)))
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'orgId' is not null or undefined
if (orgId === null || orgId === undefined) {
throw new Error(
'Required parameter orgId was null or undefined when calling enterpriseDataclassificationTeamSettingsSet.',
)
}
// verify required parameter 'teamId' is not null or undefined
if (teamId === null || teamId === undefined) {
throw new Error(
'Required parameter teamId was null or undefined when calling enterpriseDataclassificationTeamSettingsSet.',
)
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'PATCH',
urlResource,
JSON.stringify(ObjectSerializer.serialize(updateTeamSettingsRequest, 'UpdateTeamSettingsRequest')),
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'DataClassificationTeamSettings')
return {response, body}
}
/**
* Retrieves content changes for board items within your organization. Content changes are actions that users can perform on board items, such as updating a sticky note\'s text. You can retrieve results for a specific time period. You can also filter results based on the board IDs and the emails of users who created, modified, or deleted a board item. Additionally, results can be paginated for easier viewing and processing. <br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>contentlogs:export</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 4</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=_blank href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin.</p>
* @summary Retrieve content change logs of board items
* @param orgId Unique identifier of the organization.
* @param from Filter content logs based on the date and time when the board item was last modified. This is the start date and time for the modified date duration. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
* @param to Filter content logs based on the date and time when the board item was last modified. This is the end date and time for the modified date duration. Format: UTC, adheres to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601), includes a [trailing Z offset](https://en.wikipedia.org/wiki/ISO_8601#Coordinated_Universal_Time_(UTC)).
* @param boardIds List of board IDs for which you want to retrieve the content logs.
* @param emails Filter content logs based on the list of emails of users who created, modified, or deleted the board item.
* @param cursor A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, set the cursor parameter equal to the cursor value you received in the response of the previous request.
* @param limit The maximum number of results to return per call. If the number of logs in the response is greater than the limit specified, the response returns the cursor parameter with a value.
* @param sorting Sort order in which you want to view the result set based on the modified date. To sort by an ascending modified date, specify `asc`. To sort by a descending modified date, specify `desc`.
*/
async enterpriseBoardContentItemLogsFetch(
orgId: string,
from: Date,
to: Date,
query?: {
boardIds?: Array<string>
emails?: Array<string>
cursor?: string
limit?: number
sorting?: 'asc' | 'desc'
},
): Promise<{response: Response; body: GetBoardItemContentLogsResponse}> {
const localVarPath = '/v2/orgs/{org_id}/content-logs/items'.replace(
'{' + 'org_id' + '}',
encodeURIComponent(String(orgId)),
)
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'orgId' is not null or undefined
if (orgId === null || orgId === undefined) {
throw new Error(
'Required parameter orgId was null or undefined when calling enterpriseBoardContentItemLogsFetch.',
)
}
if (query?.boardIds !== undefined) {
localVarQueryParameters.append('board_ids', ObjectSerializer.serialize(query?.boardIds, 'Array<string>'))
}
if (query?.emails !== undefined) {
localVarQueryParameters.append('emails', ObjectSerializer.serialize(query?.emails, 'Array<string>'))
}
// verify required parameter 'from' is not null or undefined
if (from === null || from === undefined) {
throw new Error('Required parameter from was null or undefined when calling enterpriseBoardContentItemLogsFetch.')
}
if (from !== undefined) {
localVarQueryParameters.append('from', ObjectSerializer.serialize(from, 'Date'))
}
// verify required parameter 'to' is not null or undefined
if (to === null || to === undefined) {
throw new Error('Required parameter to was null or undefined when calling enterpriseBoardContentItemLogsFetch.')
}
if (to !== undefined) {
localVarQueryParameters.append('to', ObjectSerializer.serialize(to, 'Date'))
}
if (query?.cursor !== undefined) {
localVarQueryParameters.append('cursor', ObjectSerializer.serialize(query?.cursor, 'string'))
}
if (query?.limit !== undefined) {
localVarQueryParameters.append('limit', ObjectSerializer.serialize(query?.limit, 'number'))
}
if (query?.sorting !== undefined) {
localVarQueryParameters.append('sorting', ObjectSerializer.serialize(query?.sorting, "'asc' | 'desc'"))
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'GET',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'GetBoardItemContentLogsResponse')
return {response, body}
}
/**
* Retrieves the result of the board export job. The response provides more information about the board export job, such as the S3 link to the files created.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:export</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 4</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=_blank href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using <a target=_blank href=\"https://miro-survey.typeform.com/to/BVPTNWJ9\">this form</a>.</p>
* @summary Get results for board export job
* @param orgId Unique identifier of the organization.
* @param jobId Unique identifier of the job.
*/
async enterpriseBoardExportJobResults(
orgId: string,
jobId: string,
): Promise<{response: Response; body: BoardExportResult}> {
const localVarPath = '/v2/orgs/{org_id}/boards/export/jobs/{job_id}/results'
.replace('{' + 'org_id' + '}', encodeURIComponent(String(orgId)))
.replace('{' + 'job_id' + '}', encodeURIComponent(String(jobId)))
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'orgId' is not null or undefined
if (orgId === null || orgId === undefined) {
throw new Error('Required parameter orgId was null or undefined when calling enterpriseBoardExportJobResults.')
}
// verify required parameter 'jobId' is not null or undefined
if (jobId === null || jobId === undefined) {
throw new Error('Required parameter jobId was null or undefined when calling enterpriseBoardExportJobResults.')
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'GET',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'BoardExportResult')
return {response, body}
}
/**
* Retrieves the status of the board export job.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:export</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 4</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=_blank href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using <a target=_blank href=\"https://miro-survey.typeform.com/to/BVPTNWJ9\">this form</a>.</p>
* @summary Get board export job status
* @param orgId Unique identifier of the organization.
* @param jobId Unique identifier of the board export job.
*/
async enterpriseBoardExportJobStatus(
orgId: string,
jobId: string,
): Promise<{response: Response; body: BoardExportJobStatus}> {
const localVarPath = '/v2/orgs/{org_id}/boards/export/jobs/{job_id}'
.replace('{' + 'org_id' + '}', encodeURIComponent(String(orgId)))
.replace('{' + 'job_id' + '}', encodeURIComponent(String(jobId)))
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'orgId' is not null or undefined
if (orgId === null || orgId === undefined) {
throw new Error('Required parameter orgId was null or undefined when calling enterpriseBoardExportJobStatus.')
}
// verify required parameter 'jobId' is not null or undefined
if (jobId === null || jobId === undefined) {
throw new Error('Required parameter jobId was null or undefined when calling enterpriseBoardExportJobStatus.')
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()
const {response, bodyAsJson} = await makeJsonRequest(
typeof this.accessToken === 'function' ? await this.accessToken() : this.accessToken,
'GET',
urlResource,
undefined,
this.logger,
)
const body = ObjectSerializer.deserialize(bodyAsJson, 'BoardExportJobStatus')
return {response, body}
}
/**
* Creates an export job for one or more boards.<br/><h3>Required scope</h3> <a target=_blank href=https://developers.miro.com/reference/scopes>boards:export</a> <br/><h3>Rate limiting</h3> <a target=_blank href=\"/docs/miro-rest-api-introduction#rate-limiting\">Level 4</a> <br/><h3>Enterprise only</h3> <p>This API is available only for <a target=_blank href=\"/reference/api-reference#enterprise-plan\">Enterprise plan</a> users. You can only use this endpoint if you have the role of a Company Admin and eDiscovery is enabled in the Settings. You can request temporary access to Enterprise APIs using <a target=_blank href=\"https://miro-survey.typeform.com/to/BVPTNWJ9\">this form</a>.</p>
* @summary Create board export job
* @param orgId Unique identifier of the organization.
* @param requestId Unique identifier of the board export job.
* @param createBoardExportRequest
*/
async enterpriseCreateBoardExport(
orgId: string,
requestId: string,
createBoardExportRequest: CreateBoardExportRequest,
): Promise<{response: Response; body: BoardExportJobId}> {
const localVarPath = '/v2/orgs/{org_id}/boards/export/jobs'.replace(
'{' + 'org_id' + '}',
encodeURIComponent(String(orgId)),
)
let localVarQueryParameters = new URLSearchParams()
// verify required parameter 'orgId' is not null or undefined
if (orgId === null || orgId === undefined) {
throw new Error('Required parameter orgId was null or undefined when calling enterpriseCreateBoardExport.')
}
// verify required parameter 'requestId' is not null or undefined
if (requestId === null || requestId === undefined) {
throw new Error('Required parameter requestId was null or undefined when calling enterpriseCreateBoardExport.')
}
if (requestId !== undefined) {
localVarQueryParameters.append('request_id', ObjectSerializer.serialize(requestId, 'string'))
}
const urlResource = new URL(localVarPath, this.basePath)
urlResource.search = localVarQueryParameters.toString()