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
//! The Enterprise API.
use crate::api::repos::secret_scanning_alerts::Params;
use crate::models::dependabot::{
DependabotAlert, DependabotDefaultRepositoryAccessLevel, DependabotRepositoryAccess,
SetDependabotDefaultRepositoryAccessLevel, UpdateDependabotRepositoryAccess,
};
use crate::models::RepositoryId;
use crate::params::Direction;
use crate::{Octocrab, Page, Result};
pub mod code_security;
pub use code_security::{
EnterpriseCodeSecurityHandler, ListEnterpriseCodeSecurityConfigRepositoriesBuilder,
ListEnterpriseCodeSecurityConfigsBuilder,
};
/// A client to GitHub's enterprise API.
///
/// Created with [`Octocrab::enterprises`].
pub struct EnterpriseHandler<'octo> {
crab: &'octo Octocrab,
enterprise: String,
}
impl<'octo> EnterpriseHandler<'octo> {
pub(crate) fn new(crab: &'octo Octocrab, enterprise: String) -> Self {
Self { crab, enterprise }
}
/// Handle secret scanning alerts for the enterprise.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/secret-scanning?apiVersion=2022-11-28#list-secret-scanning-alerts-for-an-enterprise)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let alerts = octocrab
/// .enterprises("my-enterprise")
/// .secret_scanning()
/// .get_alerts()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn secret_scanning(&self) -> EnterpriseSecretScanningAlertsHandler<'_> {
EnterpriseSecretScanningAlertsHandler::new(self)
}
/// Handle code security configurations for the enterprise.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/code-security/configurations?apiVersion=2022-11-28)
pub fn code_security(&self) -> EnterpriseCodeSecurityHandler<'octo, '_> {
EnterpriseCodeSecurityHandler::new(self)
}
/// Handle secret scanning alerts for the enterprise (alias for [`secret_scanning`][EnterpriseHandler::secret_scanning]).
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let alerts = octocrab
/// .enterprises("my-enterprise")
/// .secrets_scanning()
/// .get_alerts()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn secrets_scanning(&self) -> EnterpriseSecretScanningAlertsHandler<'_> {
self.secret_scanning()
}
/// Handle Dependabot for the enterprise.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/dependabot?apiVersion=2022-11-28)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let alerts = octocrab
/// .enterprises("my-enterprise")
/// .dependabot()
/// .alerts()
/// .list()
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn dependabot(&self) -> EnterpriseDependabotHandler<'octo> {
EnterpriseDependabotHandler::new(self.crab, self.enterprise.clone())
}
/// Handle Copilot for the enterprise.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/copilot?apiVersion=2022-11-28)
pub fn copilot(&self) -> EnterpriseCopilotHandler<'octo, '_> {
EnterpriseCopilotHandler::new(self)
}
/// Handle GitHub Actions for the enterprise.
pub fn actions(&self) -> EnterpriseActionsHandler<'octo, '_> {
EnterpriseActionsHandler::new(self)
}
}
/// A client to GitHub Actions at the enterprise level.
pub struct EnterpriseActionsHandler<'octo, 'r> {
handler: &'r EnterpriseHandler<'octo>,
}
impl<'octo, 'r> EnterpriseActionsHandler<'octo, 'r> {
pub(crate) fn new(handler: &'r EnterpriseHandler<'octo>) -> Self {
Self { handler }
}
/// Handle cache settings for the enterprise.
pub fn cache(&self) -> crate::api::actions::cache::EnterpriseActionsCacheHandler<'octo> {
crate::api::actions::cache::EnterpriseActionsCacheHandler::new(
self.handler.crab,
self.handler.enterprise.clone(),
)
}
/// Handle OIDC customization for the enterprise.
pub fn oidc(&self) -> crate::api::actions::oidc::EnterpriseActionsOidcHandler<'octo> {
crate::api::actions::oidc::EnterpriseActionsOidcHandler::new(
self.handler.crab,
self.handler.enterprise.clone(),
)
}
}
/// A client to GitHub's enterprise Secret Scanning API.
///
/// Created with [`EnterpriseHandler::secret_scanning`].
pub struct EnterpriseSecretScanningAlertsHandler<'octo> {
handler: &'octo EnterpriseHandler<'octo>,
params: Params,
}
impl<'octo> EnterpriseSecretScanningAlertsHandler<'octo> {
pub(crate) fn new(enterprise: &'octo EnterpriseHandler<'octo>) -> Self {
Self {
handler: enterprise,
params: Params::default(),
}
}
/// Lists secret scanning alerts for eligible repositories in an enterprise.
/// You must authenticate using an access token with the `repo` or `security_events` scope to use this endpoint.
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let alerts = octocrab.enterprises("my-enterprise")
/// .secret_scanning()
/// .direction("asc")
/// .get_alerts()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn get_alerts(
&self,
) -> crate::Result<crate::Page<crate::models::repos::secret_scanning_alert::SecretScanningAlert>>
{
let route = format!(
"/enterprises/{}/secret-scanning/alerts",
self.handler.enterprise
);
self.handler.crab.get(route, Some(&self.params)).await
}
/// Results per page (max 100).
pub fn per_page(mut self, per_page: impl Into<u8>) -> Self {
self.params.per_page = Some(per_page.into());
self
}
/// Page number of the results to fetch.
pub fn page(mut self, page: impl Into<u32>) -> Self {
self.params.page = Some(page.into());
self
}
/// Filter Secret Scanning Alerts by state.
pub fn state(mut self, state: impl Into<String>) -> Self {
self.params.state = Some(state.into());
self
}
/// Filter Secret Scanning Alerts by resolution.
pub fn resolution(mut self, resolution: impl Into<Vec<String>>) -> Self {
self.params.resolution = Some(resolution.into());
self
}
/// Filter Secret Scanning Alerts by validity.
pub fn validity(mut self, validity: impl Into<Vec<String>>) -> Self {
self.params.validity = Some(validity.into());
self
}
/// Filter Secret Scanning Alerts by secret_type.
pub fn secret_type(mut self, secret_type: impl Into<String>) -> Self {
self.params.secret_type = Some(secret_type.into());
self
}
/// Filter Secret Scanning Alerts by multi repo alerts.
pub fn is_multi_repo(mut self, is_multi_repo: impl Into<bool>) -> Self {
self.params.is_multi_repo = Some(is_multi_repo.into());
self
}
/// Filter Secret Scanning Alerts by publicly leaked.
pub fn is_publicly_leaked(mut self, is_publicly_leaked: impl Into<bool>) -> Self {
self.params.is_publicly_leaked = Some(is_publicly_leaked.into());
self
}
/// Hide secrets in results.
pub fn hide_secret(mut self, hide_secret: impl Into<bool>) -> Self {
self.params.hide_secret = Some(hide_secret.into());
self
}
/// Filter Secret Scanning Alerts by push protection bypass status.
pub fn is_bypassed(mut self, is_bypassed: impl Into<bool>) -> Self {
self.params.is_bypassed = Some(is_bypassed.into());
self
}
/// Filter Secret Scanning Alerts by after cursor.
pub fn after(mut self, after: impl Into<String>) -> Self {
self.params.after = Some(after.into());
self
}
/// Filter Secret Scanning Alerts by before cursor.
pub fn before(mut self, before: impl Into<String>) -> Self {
self.params.before = Some(before.into());
self
}
/// Sort Secret Scanning Alerts.
pub fn sort(mut self, sort: impl Into<String>) -> Self {
self.params.sort = Some(sort.into());
self
}
/// Sort direction of Secret Scanning Alerts.
pub fn direction(mut self, direction: impl Into<String>) -> Self {
self.params.direction = Some(direction.into());
self
}
}
/// Handler for enterprise Dependabot functionality.
pub struct EnterpriseDependabotHandler<'octo> {
crab: &'octo Octocrab,
enterprise: String,
}
impl<'octo> EnterpriseDependabotHandler<'octo> {
pub(crate) fn new(crab: &'octo Octocrab, enterprise: impl Into<String>) -> Self {
Self {
crab,
enterprise: enterprise.into(),
}
}
/// Handler for managing enterprise Dependabot alerts.
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let alerts = octocrab
/// .enterprises("my-enterprise")
/// .dependabot()
/// .alerts()
/// .list()
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn alerts(&self) -> EnterpriseDependabotAlertsHandler<'octo> {
EnterpriseDependabotAlertsHandler::new(self.crab, self.enterprise.clone())
}
/// Handler for managing enterprise Dependabot repository access.
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let access = octocrab
/// .enterprises("my-enterprise")
/// .dependabot()
/// .repository_access()
/// .list()
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn repository_access(&self) -> EnterpriseDependabotRepositoryAccessHandler<'octo> {
EnterpriseDependabotRepositoryAccessHandler::new(self.crab, self.enterprise.clone())
}
}
/// Handler for enterprise Dependabot alerts.
pub struct EnterpriseDependabotAlertsHandler<'octo> {
crab: &'octo Octocrab,
enterprise: String,
}
impl<'octo> EnterpriseDependabotAlertsHandler<'octo> {
pub(crate) fn new(crab: &'octo Octocrab, enterprise: impl Into<String>) -> Self {
Self {
crab,
enterprise: enterprise.into(),
}
}
/// Lists enterprise Dependabot alerts.
///
/// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/alerts?apiVersion=2022-11-28#list-dependabot-alerts-for-an-enterprise)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let alerts = octocrab
/// .enterprises("my-enterprise")
/// .dependabot()
/// .alerts()
/// .list()
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn list(&self) -> ListEnterpriseDependabotAlertsBuilder<'octo, '_> {
ListEnterpriseDependabotAlertsBuilder::new(self)
}
}
/// Builder for listing enterprise Dependabot alerts.
#[derive(serde::Serialize)]
pub struct ListEnterpriseDependabotAlertsBuilder<'octo, 'r> {
#[serde(skip)]
handler: &'r EnterpriseDependabotAlertsHandler<'octo>,
#[serde(skip_serializing_if = "Option::is_none")]
state: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
severity: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
ecosystem: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
package: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
scope: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
sort: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
direction: Option<Direction>,
#[serde(skip_serializing_if = "Option::is_none")]
page: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
per_page: Option<u8>,
#[serde(skip_serializing_if = "Option::is_none")]
before: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
after: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
first: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
last: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
epss_percentage: Option<String>,
}
impl<'octo, 'r> ListEnterpriseDependabotAlertsBuilder<'octo, 'r> {
pub(crate) fn new(handler: &'r EnterpriseDependabotAlertsHandler<'octo>) -> Self {
Self {
handler,
state: None,
severity: None,
ecosystem: None,
package: None,
scope: None,
sort: None,
direction: None,
page: None,
per_page: None,
before: None,
after: None,
first: None,
last: None,
epss_percentage: None,
}
}
/// Filter by state (e.g. `auto_dismissed`, `dismissed`, `fixed`, `open`).
pub fn state(mut self, state: impl Into<String>) -> Self {
self.state = Some(state.into());
self
}
/// Filter by severity (e.g. `low`, `medium`, `high`, `critical`).
pub fn severity(mut self, severity: impl Into<String>) -> Self {
self.severity = Some(severity.into());
self
}
/// Filter by ecosystem (e.g. `npm`, `pip`, `cargo`, `maven`, etc.).
pub fn ecosystem(mut self, ecosystem: impl Into<String>) -> Self {
self.ecosystem = Some(ecosystem.into());
self
}
/// Filter by package name.
pub fn package(mut self, package: impl Into<String>) -> Self {
self.package = Some(package.into());
self
}
/// Filter by scope (e.g. `development`, `runtime`).
pub fn scope(mut self, scope: impl Into<String>) -> Self {
self.scope = Some(scope.into());
self
}
/// Property by which to sort the results (e.g. `created`, `updated`).
pub fn sort(mut self, sort: impl Into<String>) -> Self {
self.sort = Some(sort.into());
self
}
/// Direction to sort results.
pub fn direction(mut self, direction: impl Into<Direction>) -> Self {
self.direction = Some(direction.into());
self
}
/// Page number of the results to fetch.
pub fn page(mut self, page: impl Into<u32>) -> Self {
self.page = Some(page.into());
self
}
/// Results per page (max 100).
pub fn per_page(mut self, per_page: impl Into<u8>) -> Self {
self.per_page = Some(per_page.into());
self
}
/// Cursor for pagination (before).
pub fn before(mut self, before: impl Into<String>) -> Self {
self.before = Some(before.into());
self
}
/// Cursor for pagination (after).
pub fn after(mut self, after: impl Into<String>) -> Self {
self.after = Some(after.into());
self
}
/// Number of results to return from the beginning.
pub fn first(mut self, first: impl Into<u32>) -> Self {
self.first = Some(first.into());
self
}
/// Number of results to return from the end.
pub fn last(mut self, last: impl Into<u32>) -> Self {
self.last = Some(last.into());
self
}
/// Filter by EPSS percentage.
pub fn epss_percentage(mut self, epss_percentage: impl Into<String>) -> Self {
self.epss_percentage = Some(epss_percentage.into());
self
}
/// Sends the request and returns the resulting page of alerts.
pub async fn send(self) -> Result<Page<DependabotAlert>> {
let route = format!("/enterprises/{}/dependabot/alerts", self.handler.enterprise);
self.handler.crab.get(route, Some(&self)).await
}
}
/// Handler for enterprise Dependabot repository access.
pub struct EnterpriseDependabotRepositoryAccessHandler<'octo> {
crab: &'octo Octocrab,
enterprise: String,
}
impl<'octo> EnterpriseDependabotRepositoryAccessHandler<'octo> {
pub(crate) fn new(crab: &'octo Octocrab, enterprise: impl Into<String>) -> Self {
Self {
crab,
enterprise: enterprise.into(),
}
}
/// Lists repositories that Dependabot can access for the enterprise.
///
/// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/repository-access?apiVersion=2022-11-28#list-repositories-dependabot-can-access)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let access = octocrab
/// .enterprises("my-enterprise")
/// .dependabot()
/// .repository_access()
/// .list()
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn list(&self) -> ListEnterpriseDependabotRepositoryAccessBuilder<'octo, '_> {
ListEnterpriseDependabotRepositoryAccessBuilder::new(self)
}
/// Updates the repositories that Dependabot can access for the enterprise.
///
/// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/repository-access?apiVersion=2022-11-28#update-the-dependabot-repository-access-list)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// octocrab
/// .enterprises("my-enterprise")
/// .dependabot()
/// .repository_access()
/// .update()
/// .add_repository(12345u64)
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn update(&self) -> UpdateEnterpriseDependabotRepositoryAccessBuilder<'octo, '_> {
UpdateEnterpriseDependabotRepositoryAccessBuilder::new(self)
}
/// Sets the default repository access level for Dependabot in the enterprise.
///
/// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/repository-access?apiVersion=2022-11-28#set-the-default-repository-access-level)
///
/// # Examples
///
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// use octocrab::models::dependabot::DependabotDefaultRepositoryAccessLevel;
///
/// octocrab
/// .enterprises("my-enterprise")
/// .dependabot()
/// .repository_access()
/// .set_default_level(DependabotDefaultRepositoryAccessLevel::Internal)
/// .await?;
/// # Ok(())
/// # }
/// ```
pub async fn set_default_level(
&self,
default_level: DependabotDefaultRepositoryAccessLevel,
) -> Result<()> {
let route = format!(
"/enterprises/{}/dependabot/repository-access/default-level",
self.enterprise
);
let body = SetDependabotDefaultRepositoryAccessLevel { default_level };
let resp = self.crab._put(route, Some(&body)).await?;
crate::map_github_error(resp).await?;
Ok(())
}
}
/// Builder for listing repositories Dependabot can access in an enterprise.
#[derive(serde::Serialize)]
pub struct ListEnterpriseDependabotRepositoryAccessBuilder<'octo, 'r> {
#[serde(skip)]
handler: &'r EnterpriseDependabotRepositoryAccessHandler<'octo>,
#[serde(skip_serializing_if = "Option::is_none")]
page: Option<u32>,
#[serde(skip_serializing_if = "Option::is_none")]
per_page: Option<u8>,
}
impl<'octo, 'r> ListEnterpriseDependabotRepositoryAccessBuilder<'octo, 'r> {
pub(crate) fn new(handler: &'r EnterpriseDependabotRepositoryAccessHandler<'octo>) -> Self {
Self {
handler,
page: None,
per_page: None,
}
}
/// Page number of the results to fetch.
pub fn page(mut self, page: impl Into<u32>) -> Self {
self.page = Some(page.into());
self
}
/// Results per page (max 100).
pub fn per_page(mut self, per_page: impl Into<u8>) -> Self {
self.per_page = Some(per_page.into());
self
}
/// Sends the request and returns the repository access configuration.
pub async fn send(self) -> Result<DependabotRepositoryAccess> {
let route = format!(
"/enterprises/{}/dependabot/repository-access",
self.handler.enterprise
);
self.handler.crab.get(route, Some(&self)).await
}
}
/// Builder for updating the repositories Dependabot can access in an enterprise.
pub struct UpdateEnterpriseDependabotRepositoryAccessBuilder<'octo, 'r> {
handler: &'r EnterpriseDependabotRepositoryAccessHandler<'octo>,
repository_ids_to_add: Vec<RepositoryId>,
repository_ids_to_remove: Vec<RepositoryId>,
}
impl<'octo, 'r> UpdateEnterpriseDependabotRepositoryAccessBuilder<'octo, 'r> {
pub(crate) fn new(handler: &'r EnterpriseDependabotRepositoryAccessHandler<'octo>) -> Self {
Self {
handler,
repository_ids_to_add: Vec::new(),
repository_ids_to_remove: Vec::new(),
}
}
/// Add a repository ID to the access list.
pub fn add_repository(mut self, id: impl Into<RepositoryId>) -> Self {
self.repository_ids_to_add.push(id.into());
self
}
/// Add multiple repository IDs to the access list.
pub fn add_repositories(mut self, ids: impl IntoIterator<Item = RepositoryId>) -> Self {
self.repository_ids_to_add.extend(ids);
self
}
/// Remove a repository ID from the access list.
pub fn remove_repository(mut self, id: impl Into<RepositoryId>) -> Self {
self.repository_ids_to_remove.push(id.into());
self
}
/// Remove multiple repository IDs from the access list.
pub fn remove_repositories(mut self, ids: impl IntoIterator<Item = RepositoryId>) -> Self {
self.repository_ids_to_remove.extend(ids);
self
}
/// Sends the update request.
pub async fn send(self) -> Result<()> {
let route = format!(
"/enterprises/{}/dependabot/repository-access",
self.handler.enterprise
);
let body = UpdateDependabotRepositoryAccess {
repository_ids_to_add: if self.repository_ids_to_add.is_empty() {
None
} else {
Some(&self.repository_ids_to_add)
},
repository_ids_to_remove: if self.repository_ids_to_remove.is_empty() {
None
} else {
Some(&self.repository_ids_to_remove)
},
};
let resp = self.handler.crab._patch(route, Some(&body)).await?;
crate::map_github_error(resp).await?;
Ok(())
}
}
/// Handler for enterprise Copilot API.
pub struct EnterpriseCopilotHandler<'octo, 'b> {
handler: &'b EnterpriseHandler<'octo>,
}
impl<'octo, 'b> EnterpriseCopilotHandler<'octo, 'b> {
pub(crate) fn new(handler: &'b EnterpriseHandler<'octo>) -> Self {
Self { handler }
}
/// Set the coding agent policy for an enterprise.
pub async fn set_coding_agent_policy(&self, body: &impl serde::Serialize) -> crate::Result<()> {
let route = format!(
"/enterprises/{}/copilot/policies/coding_agent",
self.handler.enterprise
);
let res = self.handler.crab._put(route, Some(body)).await?;
crate::map_github_error(res).await.map(drop)
}
/// Add organizations to the enterprise coding agent policy.
pub async fn add_organizations_to_coding_agent_policy(
&self,
body: &impl serde::Serialize,
) -> crate::Result<()> {
let route = format!(
"/enterprises/{}/copilot/policies/coding_agent/organizations",
self.handler.enterprise
);
let res = self.handler.crab._post(route, Some(body)).await?;
crate::map_github_error(res).await.map(drop)
}
/// Remove organizations from the enterprise coding agent policy.
pub async fn remove_organizations_from_coding_agent_policy(
&self,
body: &impl serde::Serialize,
) -> crate::Result<()> {
let route = format!(
"/enterprises/{}/copilot/policies/coding_agent/organizations",
self.handler.enterprise
);
let res = self.handler.crab._delete(route, Some(body)).await?;
crate::map_github_error(res).await.map(drop)
}
/// Get Copilot enterprise usage metrics for a specific day.
pub async fn metrics_reports_enterprise_1_day(
&self,
day: Option<impl AsRef<str>>,
) -> crate::Result<crate::models::CopilotMetricsReport> {
let mut route = format!(
"/enterprises/{}/copilot/metrics/reports/enterprise-1-day",
self.handler.enterprise
);
if let Some(d) = day {
route.push_str("?day=");
route.push_str(d.as_ref());
}
self.handler.crab.get(route, None::<&()>).await
}
/// Get Copilot enterprise usage metrics (28-day latest).
pub async fn metrics_reports_enterprise_28_day_latest(
&self,
) -> crate::Result<crate::models::CopilotMetricsReport> {
let route = format!(
"/enterprises/{}/copilot/metrics/reports/enterprise-28-day/latest",
self.handler.enterprise
);
self.handler.crab.get(route, None::<&()>).await
}
/// Get Copilot enterprise repository report for a specific day.
pub async fn metrics_reports_repos_1_day(
&self,
day: Option<impl AsRef<str>>,
) -> crate::Result<crate::models::CopilotMetricsReport> {
let mut route = format!(
"/enterprises/{}/copilot/metrics/reports/repos-1-day",
self.handler.enterprise
);
if let Some(d) = day {
route.push_str("?day=");
route.push_str(d.as_ref());
}
self.handler.crab.get(route, None::<&()>).await
}
/// Get Copilot enterprise user-teams report for a specific day.
pub async fn metrics_reports_user_teams_1_day(
&self,
day: Option<impl AsRef<str>>,
) -> crate::Result<crate::models::CopilotMetricsReport> {
let mut route = format!(
"/enterprises/{}/copilot/metrics/reports/user-teams-1-day",
self.handler.enterprise
);
if let Some(d) = day {
route.push_str("?day=");
route.push_str(d.as_ref());
}
self.handler.crab.get(route, None::<&()>).await
}
/// Get Copilot users usage metrics for a specific day.
pub async fn metrics_reports_users_1_day(
&self,
day: Option<impl AsRef<str>>,
) -> crate::Result<crate::models::CopilotMetricsReport> {
let mut route = format!(
"/enterprises/{}/copilot/metrics/reports/users-1-day",
self.handler.enterprise
);
if let Some(d) = day {
route.push_str("?day=");
route.push_str(d.as_ref());
}
self.handler.crab.get(route, None::<&()>).await
}
/// Get Copilot users usage metrics (28-day latest).
pub async fn metrics_reports_users_28_day_latest(
&self,
) -> crate::Result<crate::models::CopilotMetricsReport> {
let route = format!(
"/enterprises/{}/copilot/metrics/reports/users-28-day/latest",
self.handler.enterprise
);
self.handler.crab.get(route, None::<&()>).await
}
}