octocrab 0.54.7

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
use serde::Serialize;

use crate::models::agents::{
    AgentAutomation, AgentAutomationsResponse, AgentAvailableTool, AgentAvailableTrigger,
    AgentPublicKey, AgentRepositoriesResponse, AgentSecret, AgentSecretsResponse, AgentTask,
    AgentTasksResponse, AgentVariable, AgentVariablesResponse,
};
use crate::{Octocrab, Result};

/// A client to GitHub's Agents API.
///
/// Created with [`Octocrab::agents`].
pub struct AgentsHandler<'octo> {
    crab: &'octo Octocrab,
}

impl<'octo> AgentsHandler<'octo> {
    pub(crate) fn new(crab: &'octo Octocrab) -> Self {
        Self { crab }
    }

    /// Access agent automations API.
    pub fn automations(&self) -> AgentAutomationsHandler<'octo> {
        AgentAutomationsHandler { crab: self.crab }
    }

    /// Access agent tasks API.
    pub fn tasks(&self) -> AgentTasksHandler<'octo> {
        AgentTasksHandler { crab: self.crab }
    }
}

/// Handler for agent automations.
pub struct AgentAutomationsHandler<'octo> {
    crab: &'octo Octocrab,
}

impl<'octo> AgentAutomationsHandler<'octo> {
    /// List automations for user.
    pub async fn list(&self) -> Result<Vec<AgentAutomation>> {
        self.crab.get("/agents/automations", None::<&()>).await
    }

    /// List available automation tools.
    pub async fn get_available_tools(&self) -> Result<Vec<AgentAvailableTool>> {
        self.crab
            .get("/agents/automations/available-tools", None::<&()>)
            .await
    }

    /// List available automation triggers.
    pub async fn get_available_triggers(&self) -> Result<Vec<AgentAvailableTrigger>> {
        self.crab
            .get("/agents/automations/available-triggers", None::<&()>)
            .await
    }

    /// Get an automation by ID.
    pub async fn get(&self, automation_id: impl AsRef<str>) -> Result<AgentAutomation> {
        let route = format!("/agents/automations/{}", automation_id.as_ref());
        self.crab.get(route, None::<&()>).await
    }

    /// List tasks for an automation.
    pub async fn list_tasks(&self, automation_id: impl AsRef<str>) -> Result<AgentTasksResponse> {
        let route = format!("/agents/automations/{}/tasks", automation_id.as_ref());
        self.crab.get(route, None::<&()>).await
    }
}

/// Handler for agent tasks.
pub struct AgentTasksHandler<'octo> {
    crab: &'octo Octocrab,
}

impl<'octo> AgentTasksHandler<'octo> {
    /// List agent tasks.
    pub async fn list(&self) -> Result<AgentTasksResponse> {
        self.crab.get("/agents/tasks", None::<&()>).await
    }

    /// Get a task by ID.
    pub async fn get(&self, task_id: impl AsRef<str>) -> Result<AgentTask> {
        let route = format!("/agents/tasks/{}", task_id.as_ref());
        self.crab.get(route, None::<&()>).await
    }
}

// --------------------------- Repository Agents Handlers ---------------------------

use crate::api::repos::RepoHandler;

/// Handler for repository-scoped agent operations.
pub struct RepoAgentsHandler<'octo, 'b> {
    handler: &'b RepoHandler<'octo>,
}

impl<'octo, 'b> RepoAgentsHandler<'octo, 'b> {
    pub(crate) fn new(handler: &'b RepoHandler<'octo>) -> Self {
        Self { handler }
    }

    pub fn automations(&self) -> RepoAgentAutomationsHandler<'octo, 'b> {
        RepoAgentAutomationsHandler {
            handler: self.handler,
        }
    }

    pub fn tasks(&self) -> RepoAgentTasksHandler<'octo, 'b> {
        RepoAgentTasksHandler {
            handler: self.handler,
        }
    }

    pub fn secrets(&self) -> RepoAgentSecretsHandler<'octo, 'b> {
        RepoAgentSecretsHandler {
            handler: self.handler,
        }
    }

    pub fn variables(&self) -> RepoAgentVariablesHandler<'octo, 'b> {
        RepoAgentVariablesHandler {
            handler: self.handler,
        }
    }
}

pub struct RepoAgentAutomationsHandler<'octo, 'b> {
    handler: &'b RepoHandler<'octo>,
}

impl<'octo, 'b> RepoAgentAutomationsHandler<'octo, 'b> {
    /// List automations for a repository.
    pub async fn list(&self) -> Result<AgentAutomationsResponse> {
        let route = format!("/agents/{}/automations", self.handler.repo);
        self.handler.crab.get(route, None::<&()>).await
    }

    /// Create an automation for a repository.
    pub async fn create(&self, body: &impl Serialize) -> Result<AgentAutomation> {
        let route = format!("/agents/{}/automations", self.handler.repo);
        self.handler.crab.post(route, Some(body)).await
    }

    /// Get an automation for a repository.
    pub async fn get(&self, automation_id: impl AsRef<str>) -> Result<AgentAutomation> {
        let route = format!(
            "/agents/{}/automations/{}",
            self.handler.repo,
            automation_id.as_ref()
        );
        self.handler.crab.get(route, None::<&()>).await
    }

    /// Edit an automation for a repository.
    pub async fn update(
        &self,
        automation_id: impl AsRef<str>,
        body: &impl Serialize,
    ) -> Result<AgentAutomation> {
        let route = format!(
            "/agents/{}/automations/{}",
            self.handler.repo,
            automation_id.as_ref()
        );
        self.handler.crab.patch(route, Some(body)).await
    }

    /// Delete an automation for a repository.
    pub async fn delete(&self, automation_id: impl AsRef<str>) -> Result<()> {
        let route = format!(
            "/agents/{}/automations/{}",
            self.handler.repo,
            automation_id.as_ref()
        );
        let res = self.handler.crab._delete(route, None::<&()>).await?;
        crate::map_github_error(res).await.map(drop)
    }
}

pub struct RepoAgentTasksHandler<'octo, 'b> {
    handler: &'b RepoHandler<'octo>,
}

impl<'octo, 'b> RepoAgentTasksHandler<'octo, 'b> {
    /// List tasks for repository.
    pub async fn list(&self) -> Result<AgentTasksResponse> {
        let route = format!("/agents/{}/tasks", self.handler.repo);
        self.handler.crab.get(route, None::<&()>).await
    }

    /// Start a task.
    pub async fn start(&self, body: &impl Serialize) -> Result<AgentTask> {
        let route = format!("/agents/{}/tasks", self.handler.repo);
        self.handler.crab.post(route, Some(body)).await
    }

    /// Get a task by repo.
    pub async fn get(&self, task_id: impl AsRef<str>) -> Result<AgentTask> {
        let route = format!("/agents/{}/tasks/{}", self.handler.repo, task_id.as_ref());
        self.handler.crab.get(route, None::<&()>).await
    }
}

pub struct RepoAgentSecretsHandler<'octo, 'b> {
    handler: &'b RepoHandler<'octo>,
}

impl<'octo, 'b> RepoAgentSecretsHandler<'octo, 'b> {
    /// List repository organization secrets.
    pub async fn list_org_secrets(&self) -> Result<AgentSecretsResponse> {
        let route = format!("/{}/agents/organization-secrets", self.handler.repo);
        self.handler.crab.get(route, None::<&()>).await
    }

    /// List repository secrets.
    pub async fn list(&self) -> Result<AgentSecretsResponse> {
        let route = format!("/{}/agents/secrets", self.handler.repo);
        self.handler.crab.get(route, None::<&()>).await
    }

    /// Get a repository public key.
    pub async fn get_public_key(&self) -> Result<AgentPublicKey> {
        let route = format!("/{}/agents/secrets/public-key", self.handler.repo);
        self.handler.crab.get(route, None::<&()>).await
    }

    /// Get a repository secret.
    pub async fn get(&self, secret_name: impl AsRef<str>) -> Result<AgentSecret> {
        let route = format!(
            "/{}/agents/secrets/{}",
            self.handler.repo,
            secret_name.as_ref()
        );
        self.handler.crab.get(route, None::<&()>).await
    }

    /// Create or update a repository secret.
    pub async fn create_or_update(
        &self,
        secret_name: impl AsRef<str>,
        body: &impl Serialize,
    ) -> Result<()> {
        let route = format!(
            "/{}/agents/secrets/{}",
            self.handler.repo,
            secret_name.as_ref()
        );
        let res = self.handler.crab._put(route, Some(body)).await?;
        crate::map_github_error(res).await.map(drop)
    }

    /// Delete a repository secret.
    pub async fn delete(&self, secret_name: impl AsRef<str>) -> Result<()> {
        let route = format!(
            "/{}/agents/secrets/{}",
            self.handler.repo,
            secret_name.as_ref()
        );
        let res = self.handler.crab._delete(route, None::<&()>).await?;
        crate::map_github_error(res).await.map(drop)
    }
}

pub struct RepoAgentVariablesHandler<'octo, 'b> {
    handler: &'b RepoHandler<'octo>,
}

impl<'octo, 'b> RepoAgentVariablesHandler<'octo, 'b> {
    /// List repository organization variables.
    pub async fn list_org_variables(&self) -> Result<AgentVariablesResponse> {
        let route = format!("/{}/agents/organization-variables", self.handler.repo);
        self.handler.crab.get(route, None::<&()>).await
    }

    /// List repository variables.
    pub async fn list(&self) -> Result<AgentVariablesResponse> {
        let route = format!("/{}/agents/variables", self.handler.repo);
        self.handler.crab.get(route, None::<&()>).await
    }

    /// Create a repository variable.
    pub async fn create(&self, body: &impl Serialize) -> Result<AgentVariable> {
        let route = format!("/{}/agents/variables", self.handler.repo);
        self.handler.crab.post(route, Some(body)).await
    }

    /// Get a repository variable.
    pub async fn get(&self, name: impl AsRef<str>) -> Result<AgentVariable> {
        let route = format!("/{}/agents/variables/{}", self.handler.repo, name.as_ref());
        self.handler.crab.get(route, None::<&()>).await
    }

    /// Update a repository variable.
    pub async fn update(&self, name: impl AsRef<str>, body: &impl Serialize) -> Result<()> {
        let route = format!("/{}/agents/variables/{}", self.handler.repo, name.as_ref());
        let res = self.handler.crab._patch(route, Some(body)).await?;
        crate::map_github_error(res).await.map(drop)
    }

    /// Delete a repository variable.
    pub async fn delete(&self, name: impl AsRef<str>) -> Result<()> {
        let route = format!("/{}/agents/variables/{}", self.handler.repo, name.as_ref());
        let res = self.handler.crab._delete(route, None::<&()>).await?;
        crate::map_github_error(res).await.map(drop)
    }
}

// --------------------------- Organization Agents Handlers ---------------------------

/// Handler for organization-scoped agent operations.
pub struct OrgAgentsHandler<'octo, 'b> {
    crab: &'octo Octocrab,
    org: &'b str,
}

impl<'octo, 'b> OrgAgentsHandler<'octo, 'b> {
    pub(crate) fn new(crab: &'octo Octocrab, org: &'b str) -> Self {
        Self { crab, org }
    }

    pub fn secrets(&self) -> OrgAgentSecretsHandler<'octo, 'b> {
        OrgAgentSecretsHandler {
            crab: self.crab,
            org: self.org,
        }
    }

    pub fn variables(&self) -> OrgAgentVariablesHandler<'octo, 'b> {
        OrgAgentVariablesHandler {
            crab: self.crab,
            org: self.org,
        }
    }
}

pub struct OrgAgentSecretsHandler<'octo, 'b> {
    crab: &'octo Octocrab,
    org: &'b str,
}

impl<'octo, 'b> OrgAgentSecretsHandler<'octo, 'b> {
    /// List organization secrets.
    pub async fn list(&self) -> Result<AgentSecretsResponse> {
        let route = format!("/orgs/{}/agents/secrets", self.org);
        self.crab.get(route, None::<&()>).await
    }

    /// Get an organization public key.
    pub async fn get_public_key(&self) -> Result<AgentPublicKey> {
        let route = format!("/orgs/{}/agents/secrets/public-key", self.org);
        self.crab.get(route, None::<&()>).await
    }

    /// Get an organization secret.
    pub async fn get(&self, secret_name: impl AsRef<str>) -> Result<AgentSecret> {
        let route = format!("/orgs/{}/agents/secrets/{}", self.org, secret_name.as_ref());
        self.crab.get(route, None::<&()>).await
    }

    /// Create or update an organization secret.
    pub async fn create_or_update(
        &self,
        secret_name: impl AsRef<str>,
        body: &impl Serialize,
    ) -> Result<()> {
        let route = format!("/orgs/{}/agents/secrets/{}", self.org, secret_name.as_ref());
        let res = self.crab._put(route, Some(body)).await?;
        crate::map_github_error(res).await.map(drop)
    }

    /// Delete an organization secret.
    pub async fn delete(&self, secret_name: impl AsRef<str>) -> Result<()> {
        let route = format!("/orgs/{}/agents/secrets/{}", self.org, secret_name.as_ref());
        let res = self.crab._delete(route, None::<&()>).await?;
        crate::map_github_error(res).await.map(drop)
    }

    /// List selected repositories for an organization secret.
    pub async fn list_repositories(
        &self,
        secret_name: impl AsRef<str>,
    ) -> Result<AgentRepositoriesResponse> {
        let route = format!(
            "/orgs/{}/agents/secrets/{}/repositories",
            self.org,
            secret_name.as_ref()
        );
        self.crab.get(route, None::<&()>).await
    }

    /// Set selected repositories for an organization secret.
    pub async fn set_repositories(
        &self,
        secret_name: impl AsRef<str>,
        body: &impl Serialize,
    ) -> Result<()> {
        let route = format!(
            "/orgs/{}/agents/secrets/{}/repositories",
            self.org,
            secret_name.as_ref()
        );
        let res = self.crab._put(route, Some(body)).await?;
        crate::map_github_error(res).await.map(drop)
    }

    /// Add selected repository to an organization secret.
    pub async fn add_repository(
        &self,
        secret_name: impl AsRef<str>,
        repository_id: u64,
    ) -> Result<()> {
        let route = format!(
            "/orgs/{}/agents/secrets/{}/repositories/{}",
            self.org,
            secret_name.as_ref(),
            repository_id
        );
        let res = self.crab._put(route, None::<&()>).await?;
        crate::map_github_error(res).await.map(drop)
    }

    /// Remove selected repository from an organization secret.
    pub async fn remove_repository(
        &self,
        secret_name: impl AsRef<str>,
        repository_id: u64,
    ) -> Result<()> {
        let route = format!(
            "/orgs/{}/agents/secrets/{}/repositories/{}",
            self.org,
            secret_name.as_ref(),
            repository_id
        );
        let res = self.crab._delete(route, None::<&()>).await?;
        crate::map_github_error(res).await.map(drop)
    }
}

pub struct OrgAgentVariablesHandler<'octo, 'b> {
    crab: &'octo Octocrab,
    org: &'b str,
}

impl<'octo, 'b> OrgAgentVariablesHandler<'octo, 'b> {
    /// List organization variables.
    pub async fn list(&self) -> Result<AgentVariablesResponse> {
        let route = format!("/orgs/{}/agents/variables", self.org);
        self.crab.get(route, None::<&()>).await
    }

    /// Create an organization variable.
    pub async fn create(&self, body: &impl Serialize) -> Result<AgentVariable> {
        let route = format!("/orgs/{}/agents/variables", self.org);
        self.crab.post(route, Some(body)).await
    }

    /// Get an organization variable.
    pub async fn get(&self, name: impl AsRef<str>) -> Result<AgentVariable> {
        let route = format!("/orgs/{}/agents/variables/{}", self.org, name.as_ref());
        self.crab.get(route, None::<&()>).await
    }

    /// Update an organization variable.
    pub async fn update(&self, name: impl AsRef<str>, body: &impl Serialize) -> Result<()> {
        let route = format!("/orgs/{}/agents/variables/{}", self.org, name.as_ref());
        let res = self.crab._patch(route, Some(body)).await?;
        crate::map_github_error(res).await.map(drop)
    }

    /// Delete an organization variable.
    pub async fn delete(&self, name: impl AsRef<str>) -> Result<()> {
        let route = format!("/orgs/{}/agents/variables/{}", self.org, name.as_ref());
        let res = self.crab._delete(route, None::<&()>).await?;
        crate::map_github_error(res).await.map(drop)
    }

    /// List selected repositories for an organization variable.
    pub async fn list_repositories(
        &self,
        name: impl AsRef<str>,
    ) -> Result<AgentRepositoriesResponse> {
        let route = format!(
            "/orgs/{}/agents/variables/{}/repositories",
            self.org,
            name.as_ref()
        );
        self.crab.get(route, None::<&()>).await
    }

    /// Set selected repositories for an organization variable.
    pub async fn set_repositories(
        &self,
        name: impl AsRef<str>,
        body: &impl Serialize,
    ) -> Result<()> {
        let route = format!(
            "/orgs/{}/agents/variables/{}/repositories",
            self.org,
            name.as_ref()
        );
        let res = self.crab._put(route, Some(body)).await?;
        crate::map_github_error(res).await.map(drop)
    }

    /// Add selected repository to an organization variable.
    pub async fn add_repository(&self, name: impl AsRef<str>, repository_id: u64) -> Result<()> {
        let route = format!(
            "/orgs/{}/agents/variables/{}/repositories/{}",
            self.org,
            name.as_ref(),
            repository_id
        );
        let res = self.crab._put(route, None::<&()>).await?;
        crate::map_github_error(res).await.map(drop)
    }

    /// Remove selected repository from an organization variable.
    pub async fn remove_repository(&self, name: impl AsRef<str>, repository_id: u64) -> Result<()> {
        let route = format!(
            "/orgs/{}/agents/variables/{}/repositories/{}",
            self.org,
            name.as_ref(),
            repository_id
        );
        let res = self.crab._delete(route, None::<&()>).await?;
        crate::map_github_error(res).await.map(drop)
    }
}