You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Sources/copilot/Client.swift
+12-19
Original file line number
Diff line number
Diff line change
@@ -612,6 +612,9 @@ public struct Client: APIProtocol {
612
612
}
613
613
/// Get Copilot metrics for an enterprise team
614
614
///
615
+
/// > [!NOTE]
616
+
/// > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)."
617
+
///
615
618
/// Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
616
619
///
617
620
/// The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,
@@ -806,7 +809,7 @@ public struct Client: APIProtocol {
806
809
/// Get a summary of Copilot usage for an enterprise team
807
810
///
808
811
/// > [!NOTE]
809
-
/// > This endpoint is in public preview and is subject to change.
812
+
/// > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)."
810
813
///
811
814
/// You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
812
815
/// for users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.
@@ -1354,13 +1357,11 @@ public struct Client: APIProtocol {
1354
1357
/// Purchases a GitHub Copilot seat for all users within each specified team.
1355
1358
/// The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."
1356
1359
///
1357
-
/// Only organization owners can add Copilot seats for their organization members.
1358
-
///
1359
-
/// In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.
1360
+
/// Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
1360
1361
/// For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)."
1361
1362
/// For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)."
1362
1363
///
1363
-
/// The response will contain the total number of new seats that were created and existing seats that were refreshed.
1364
+
/// The response contains the total number of new seats that were created and existing seats that were refreshed.
1364
1365
///
1365
1366
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
1366
1367
///
@@ -1530,14 +1531,11 @@ public struct Client: APIProtocol {
1530
1531
///
1531
1532
/// Sets seats for all members of each team specified to "pending cancellation".
1532
1533
/// This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through another team.
1533
-
///
1534
-
/// For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."
1535
-
///
1536
-
/// For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."
1534
+
/// For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."
1537
1535
///
1538
1536
/// Only organization owners can cancel Copilot seats for their organization members.
1539
1537
///
1540
-
/// The response will contain the total number of seats set to "pending cancellation".
1538
+
/// The response contains the total number of seats set to "pending cancellation".
1541
1539
///
1542
1540
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
1543
1541
///
@@ -1708,13 +1706,11 @@ public struct Client: APIProtocol {
1708
1706
/// Purchases a GitHub Copilot seat for each user specified.
1709
1707
/// The organization will be billed for each seat based on the organization's Copilot plan. For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."
1710
1708
///
1711
-
/// Only organization owners can add Copilot seats for their organization members.
1712
-
///
1713
-
/// In order for an admin to use this endpoint, the organization must have a Copilot Business or Enterprise subscription and a configured suggestion matching policy.
1709
+
/// Only organization owners can purchase Copilot seats for their organization members. The organization must have a Copilot Business or Copilot Enterprise subscription and a configured suggestion matching policy.
1714
1710
/// For more information about setting up a Copilot subscription, see "[Subscribing to Copilot for your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/subscribing-to-copilot-for-your-organization)."
1715
1711
/// For more information about setting a suggestion matching policy, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/setting-policies-for-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#policies-for-suggestion-matching)."
1716
1712
///
1717
-
/// The response will contain the total number of new seats that were created and existing seats that were refreshed.
1713
+
/// The response contains the total number of new seats that were created and existing seats that were refreshed.
1718
1714
///
1719
1715
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
1720
1716
///
@@ -1884,14 +1880,11 @@ public struct Client: APIProtocol {
1884
1880
///
1885
1881
/// Sets seats for all users specified to "pending cancellation".
1886
1882
/// This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle unless they retain access through team membership.
1887
-
///
1888
-
/// For more information about Copilot pricing, see "[About billing for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-the-copilot-subscription-for-your-organization/about-billing-for-github-copilot-in-your-organization)."
1889
-
///
1890
-
/// For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."
1883
+
/// For more information about disabling access to Copilot, see "[Revoking access to Copilot for members of your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-access-to-github-copilot-in-your-organization/revoking-access-to-copilot-for-members-of-your-organization)."
1891
1884
///
1892
1885
/// Only organization owners can cancel Copilot seats for their organization members.
1893
1886
///
1894
-
/// The response will contain the total number of seats set to "pending cancellation".
1887
+
/// The response contains the total number of seats set to "pending cancellation".
1895
1888
///
1896
1889
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
0 commit comments