octocrab 0.49.9

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

use chrono::NaiveDate;

use super::super::*;

// implements https://docs.github.com/en/rest/copilot/copilot-metrics
// as of API Version 2022-11-28
// missing:
// - copilot_dotcom_chat
// - copilot_dotcom_pull_requests
// - copilot_ide_chat
//
// OAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot, read:org, or read:enterprise scopes to use this endpoint.
// Some of these permissions, as of writing, are only available to GitHub Enterprise customers and further limited to Enterprise Administrators.

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct CopilotMetrics {
    pub date: NaiveDate,
    pub total_active_users: u32,
    pub total_engaged_users: u32,
    pub copilot_ide_code_completions: CopilotIdeCodeCompletions,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct CopilotIdeCodeCompletions {
    pub total_engaged_users: u32,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub languages: Option<Vec<Language>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub editors: Option<Vec<Editor>>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct Language {
    pub name: String,
    pub total_engaged_users: u32,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct Editor {
    pub name: String,
    pub total_engaged_users: u32,
    pub models: Vec<Model>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct Model {
    pub name: String,
    pub is_custom_model: bool,
    pub custom_model_training_date: Option<NaiveDate>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub total_engaged_users: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub languages: Option<Vec<EditorLanguage>>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct EditorLanguage {
    pub name: String,
    pub total_engaged_users: u32,
    pub total_code_suggestions: u32,
    pub total_code_acceptances: u32,
    pub total_code_lines_suggested: u32,
    pub total_code_lines_accepted: u32,
}