octocrab 0.54.2

A modern, extensible GitHub API client.
Documentation
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
//! Organization Dependabot API.
//!
//! See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot?apiVersion=2022-11-28)

use http::StatusCode;

use crate::models::dependabot::{
    DependabotAlert, DependabotDefaultRepositoryAccessLevel, DependabotRepositoryAccess,
    SelectedRepositories, SetDependabotDefaultRepositoryAccessLevel, SetSelectedRepositories,
    UpdateDependabotRepositoryAccess,
};
use crate::models::orgs::secrets::{
    CreateOrganizationSecret, CreateOrganizationSecretResponse, OrganizationSecret,
};
use crate::models::{PublicKey, RepositoryId};
use crate::params::Direction;
use crate::{Octocrab, Page, Result};

/// Handler for organization Dependabot functionality.
pub struct OrgDependabotHandler<'octo> {
    crab: &'octo Octocrab,
    owner: String,
}

impl<'octo> OrgDependabotHandler<'octo> {
    pub(crate) fn new(crab: &'octo Octocrab, owner: impl Into<String>) -> Self {
        Self {
            crab,
            owner: owner.into(),
        }
    }

    /// Handler for managing organization Dependabot secrets.
    pub fn secrets(&self) -> OrgDependabotSecretsHandler<'octo> {
        OrgDependabotSecretsHandler::new(self.crab, self.owner.clone())
    }

    /// Handler for managing organization Dependabot alerts.
    pub fn alerts(&self) -> OrgDependabotAlertsHandler<'octo> {
        OrgDependabotAlertsHandler::new(self.crab, self.owner.clone())
    }

    /// Handler for managing organization Dependabot repository access.
    pub fn repository_access(&self) -> OrgDependabotRepositoryAccessHandler<'octo> {
        OrgDependabotRepositoryAccessHandler::new(self.crab, self.owner.clone())
    }
}

/// Handler for organization Dependabot secrets.
pub struct OrgDependabotSecretsHandler<'octo> {
    crab: &'octo Octocrab,
    owner: String,
}

impl<'octo> OrgDependabotSecretsHandler<'octo> {
    pub(crate) fn new(crab: &'octo Octocrab, owner: impl Into<String>) -> Self {
        Self {
            crab,
            owner: owner.into(),
        }
    }

    /// Lists organization Dependabot secrets.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/secrets?apiVersion=2022-11-28#list-organization-secrets)
    pub fn list(&self) -> ListOrgDependabotSecretsBuilder<'octo, '_> {
        ListOrgDependabotSecretsBuilder::new(self)
    }

    /// Gets the organization public key for Dependabot secrets encryption.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/secrets?apiVersion=2022-11-28#get-an-organization-public-key)
    pub async fn get_public_key(&self) -> Result<PublicKey> {
        let route = format!("/orgs/{}/dependabot/secrets/public-key", self.owner);
        self.crab.get(route, None::<&()>).await
    }

    /// Gets an organization Dependabot secret.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/secrets?apiVersion=2022-11-28#get-an-organization-secret)
    pub async fn get(&self, secret_name: impl AsRef<str>) -> Result<OrganizationSecret> {
        let route = format!(
            "/orgs/{}/dependabot/secrets/{}",
            self.owner,
            secret_name.as_ref()
        );
        self.crab.get(route, None::<&()>).await
    }

    /// Creates or updates an organization Dependabot secret.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret)
    pub async fn create_or_update(
        &self,
        secret_name: impl AsRef<str>,
        secret: &CreateOrganizationSecret<'_>,
    ) -> Result<CreateOrganizationSecretResponse> {
        let route = format!(
            "/orgs/{}/dependabot/secrets/{}",
            self.owner,
            secret_name.as_ref()
        );
        let resp = self.crab._put(route, Some(secret)).await?;
        let resp = crate::map_github_error(resp).await?;
        match resp.status() {
            StatusCode::CREATED => Ok(CreateOrganizationSecretResponse::Created),
            StatusCode::NO_CONTENT => Ok(CreateOrganizationSecretResponse::Updated),
            status => Err(crate::Error::Other {
                source: format!("Unexpected status code from request: {}", status.as_str()).into(),
                backtrace: snafu::Backtrace::capture(),
            }),
        }
    }

    /// Deletes an organization Dependabot secret.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/secrets?apiVersion=2022-11-28#delete-an-organization-secret)
    pub async fn delete(&self, secret_name: impl AsRef<str>) -> Result<()> {
        let route = format!(
            "/orgs/{}/dependabot/secrets/{}",
            self.owner,
            secret_name.as_ref()
        );
        let resp = self.crab._delete(route, None::<&()>).await?;
        crate::map_github_error(resp).await?;
        Ok(())
    }

    /// Handler for managing selected repositories for an organization Dependabot secret.
    pub fn repositories(
        &self,
        secret_name: impl Into<String>,
    ) -> DependabotSecretRepositoriesHandler<'octo> {
        DependabotSecretRepositoriesHandler::new(self.crab, self.owner.clone(), secret_name.into())
    }
}

/// Builder for listing organization Dependabot secrets.
#[derive(serde::Serialize)]
pub struct ListOrgDependabotSecretsBuilder<'octo, 'r> {
    #[serde(skip)]
    handler: &'r OrgDependabotSecretsHandler<'octo>,
    #[serde(skip_serializing_if = "Option::is_none")]
    per_page: Option<u8>,
    #[serde(skip_serializing_if = "Option::is_none")]
    page: Option<u32>,
}

impl<'octo, 'r> ListOrgDependabotSecretsBuilder<'octo, 'r> {
    pub(crate) fn new(handler: &'r OrgDependabotSecretsHandler<'octo>) -> Self {
        Self {
            handler,
            per_page: None,
            page: None,
        }
    }

    /// 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
    }

    /// Page number of the results to fetch.
    pub fn page(mut self, page: impl Into<u32>) -> Self {
        self.page = Some(page.into());
        self
    }

    /// Sends the request and returns the resulting page of secrets.
    pub async fn send(self) -> Result<Page<OrganizationSecret>> {
        let route = format!("/orgs/{}/dependabot/secrets", self.handler.owner);
        self.handler.crab.get(route, Some(&self)).await
    }
}

/// Handler for selected repositories for an organization Dependabot secret.
pub struct DependabotSecretRepositoriesHandler<'octo> {
    crab: &'octo Octocrab,
    owner: String,
    secret_name: String,
}

impl<'octo> DependabotSecretRepositoriesHandler<'octo> {
    pub(crate) fn new(
        crab: &'octo Octocrab,
        owner: impl Into<String>,
        secret_name: impl Into<String>,
    ) -> Self {
        Self {
            crab,
            owner: owner.into(),
            secret_name: secret_name.into(),
        }
    }

    /// Lists selected repositories for an organization Dependabot secret.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/secrets?apiVersion=2022-11-28#list-selected-repositories-for-an-organization-secret)
    pub async fn list(&self) -> Result<SelectedRepositories> {
        let route = format!(
            "/orgs/{}/dependabot/secrets/{}/repositories",
            self.owner, self.secret_name
        );
        self.crab.get(route, None::<&()>).await
    }

    /// Sets selected repositories for an organization Dependabot secret.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/secrets?apiVersion=2022-11-28#set-selected-repositories-for-an-organization-secret)
    pub async fn set(&self, repository_ids: &[RepositoryId]) -> Result<()> {
        let route = format!(
            "/orgs/{}/dependabot/secrets/{}/repositories",
            self.owner, self.secret_name
        );
        let body = SetSelectedRepositories {
            selected_repository_ids: repository_ids,
        };
        let resp = self.crab._put(route, Some(&body)).await?;
        crate::map_github_error(resp).await?;
        Ok(())
    }

    /// Adds a selected repository to an organization Dependabot secret.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/secrets?apiVersion=2022-11-28#add-selected-repository-to-an-organization-secret)
    pub async fn add(&self, repository_id: RepositoryId) -> Result<()> {
        let route = format!(
            "/orgs/{}/dependabot/secrets/{}/repositories/{}",
            self.owner, self.secret_name, repository_id
        );
        let resp = self.crab._put(route, None::<&()>).await?;
        crate::map_github_error(resp).await?;
        Ok(())
    }

    /// Removes a selected repository from an organization Dependabot secret.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/secrets?apiVersion=2022-11-28#remove-selected-repository-from-an-organization-secret)
    pub async fn remove(&self, repository_id: RepositoryId) -> Result<()> {
        let route = format!(
            "/orgs/{}/dependabot/secrets/{}/repositories/{}",
            self.owner, self.secret_name, repository_id
        );
        let resp = self.crab._delete(route, None::<&()>).await?;
        crate::map_github_error(resp).await?;
        Ok(())
    }
}

/// Handler for organization Dependabot alerts.
pub struct OrgDependabotAlertsHandler<'octo> {
    crab: &'octo Octocrab,
    owner: String,
}

impl<'octo> OrgDependabotAlertsHandler<'octo> {
    pub(crate) fn new(crab: &'octo Octocrab, owner: impl Into<String>) -> Self {
        Self {
            crab,
            owner: owner.into(),
        }
    }

    /// Lists organization Dependabot alerts.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/alerts?apiVersion=2022-11-28#list-dependabot-alerts-for-an-organization)
    pub fn list(&self) -> ListOrgDependabotAlertsBuilder<'octo, '_> {
        ListOrgDependabotAlertsBuilder::new(self)
    }
}

/// Builder for listing organization Dependabot alerts.
#[derive(serde::Serialize)]
pub struct ListOrgDependabotAlertsBuilder<'octo, 'r> {
    #[serde(skip)]
    handler: &'r OrgDependabotAlertsHandler<'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> ListOrgDependabotAlertsBuilder<'octo, 'r> {
    pub(crate) fn new(handler: &'r OrgDependabotAlertsHandler<'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!("/orgs/{}/dependabot/alerts", self.handler.owner);
        self.handler.crab.get(route, Some(&self)).await
    }
}

/// Handler for organization Dependabot repository access.
pub struct OrgDependabotRepositoryAccessHandler<'octo> {
    crab: &'octo Octocrab,
    owner: String,
}

impl<'octo> OrgDependabotRepositoryAccessHandler<'octo> {
    pub(crate) fn new(crab: &'octo Octocrab, owner: impl Into<String>) -> Self {
        Self {
            crab,
            owner: owner.into(),
        }
    }

    /// Lists repositories that Dependabot can access for the organization.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/repository-access?apiVersion=2022-11-28#list-repositories-dependabot-can-access)
    pub fn list(&self) -> ListOrgDependabotRepositoryAccessBuilder<'octo, '_> {
        ListOrgDependabotRepositoryAccessBuilder::new(self)
    }

    /// Updates the repositories that Dependabot can access for the organization.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/repository-access?apiVersion=2022-11-28#update-the-dependabot-repository-access-list)
    pub fn update(&self) -> UpdateOrgDependabotRepositoryAccessBuilder<'octo, '_> {
        UpdateOrgDependabotRepositoryAccessBuilder::new(self)
    }

    /// Sets the default repository access level for Dependabot in the organization.
    ///
    /// See: [GitHub REST API Documentation](https://docs.github.com/en/rest/dependabot/repository-access?apiVersion=2022-11-28#set-the-default-repository-access-level)
    pub async fn set_default_level(
        &self,
        default_level: DependabotDefaultRepositoryAccessLevel,
    ) -> Result<()> {
        let route = format!(
            "/orgs/{}/dependabot/repository-access/default-level",
            self.owner
        );
        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.
#[derive(serde::Serialize)]
pub struct ListOrgDependabotRepositoryAccessBuilder<'octo, 'r> {
    #[serde(skip)]
    handler: &'r OrgDependabotRepositoryAccessHandler<'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> ListOrgDependabotRepositoryAccessBuilder<'octo, 'r> {
    pub(crate) fn new(handler: &'r OrgDependabotRepositoryAccessHandler<'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!("/orgs/{}/dependabot/repository-access", self.handler.owner);
        self.handler.crab.get(route, Some(&self)).await
    }
}

/// Builder for updating the repositories Dependabot can access.
pub struct UpdateOrgDependabotRepositoryAccessBuilder<'octo, 'r> {
    handler: &'r OrgDependabotRepositoryAccessHandler<'octo>,
    repository_ids_to_add: Vec<RepositoryId>,
    repository_ids_to_remove: Vec<RepositoryId>,
}

impl<'octo, 'r> UpdateOrgDependabotRepositoryAccessBuilder<'octo, 'r> {
    pub(crate) fn new(handler: &'r OrgDependabotRepositoryAccessHandler<'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!("/orgs/{}/dependabot/repository-access", self.handler.owner);
        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(())
    }
}