Skip to content

Commit b509c25

Browse files
Commit via running ake Sources/copilot
1 parent f805e95 commit b509c25

File tree

2 files changed

+51
-78
lines changed

2 files changed

+51
-78
lines changed

Sources/copilot/Client.swift

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -612,6 +612,9 @@ public struct Client: APIProtocol {
612612
}
613613
/// Get Copilot metrics for an enterprise team
614614
///
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+
///
615618
/// Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.
616619
///
617620
/// 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 {
806809
/// Get a summary of Copilot usage for an enterprise team
807810
///
808811
/// > [!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)."
810813
///
811814
/// You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE
812815
/// 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 {
13541357
/// Purchases a GitHub Copilot seat for all users within each specified team.
13551358
/// 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)."
13561359
///
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.
13601361
/// 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)."
13611362
/// 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)."
13621363
///
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.
13641365
///
13651366
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
13661367
///
@@ -1530,14 +1531,11 @@ public struct Client: APIProtocol {
15301531
///
15311532
/// Sets seats for all members of each team specified to "pending cancellation".
15321533
/// 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)."
15371535
///
15381536
/// Only organization owners can cancel Copilot seats for their organization members.
15391537
///
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".
15411539
///
15421540
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
15431541
///
@@ -1708,13 +1706,11 @@ public struct Client: APIProtocol {
17081706
/// Purchases a GitHub Copilot seat for each user specified.
17091707
/// 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)."
17101708
///
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.
17141710
/// 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)."
17151711
/// 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)."
17161712
///
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.
17181714
///
17191715
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
17201716
///
@@ -1884,14 +1880,11 @@ public struct Client: APIProtocol {
18841880
///
18851881
/// Sets seats for all users specified to "pending cancellation".
18861882
/// 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)."
18911884
///
18921885
/// Only organization owners can cancel Copilot seats for their organization members.
18931886
///
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".
18951888
///
18961889
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
18971890
///

0 commit comments

Comments
 (0)