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
+33-18
Original file line number
Diff line number
Diff line change
@@ -43,11 +43,14 @@ public struct Client: APIProtocol {
43
43
/// > [!NOTE]
44
44
/// > This endpoint is in public preview and is subject to change.
45
45
///
46
-
/// Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.
46
+
/// Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.
47
47
///
48
48
/// Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.
49
49
///
50
50
/// For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.
51
+
/// Each seat object contains information about the assigned user's most recent Copilot activity. Users must have
52
+
/// telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,
53
+
/// see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)."
51
54
///
52
55
/// Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.
53
56
///
@@ -425,6 +428,8 @@ public struct Client: APIProtocol {
425
428
/// and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
426
429
/// they must have telemetry enabled in their IDE.
427
430
///
431
+
/// The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time.
432
+
///
428
433
/// Only owners and billing managers can view Copilot usage metrics for the enterprise.
429
434
///
430
435
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.
@@ -1002,7 +1007,7 @@ public struct Client: APIProtocol {
1002
1007
///
1003
1008
/// Gets information about an organization's Copilot subscription, including seat breakdown
1004
1009
/// and feature policies. To configure these settings, go to your organization's settings on GitHub.com.
1005
-
/// For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)".
1010
+
/// For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)."
1006
1011
///
1007
1012
/// Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.
1008
1013
///
@@ -1163,9 +1168,12 @@ public struct Client: APIProtocol {
1163
1168
/// > [!NOTE]
1164
1169
/// > This endpoint is in public preview and is subject to change.
1165
1170
///
1166
-
/// Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription.
1171
+
/// Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed.
1167
1172
/// Only organization owners can view assigned seats.
1168
1173
///
1174
+
/// Each seat object contains information about the assigned user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.
1175
+
/// For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)."
1176
+
///
1169
1177
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.
@@ -1344,13 +1352,13 @@ public struct Client: APIProtocol {
1344
1352
/// > This endpoint is in public preview and is subject to change.
1345
1353
///
1346
1354
/// Purchases a GitHub Copilot seat for all users within each specified team.
1347
-
/// The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
1355
+
/// 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)."
1348
1356
///
1349
1357
/// Only organization owners can add Copilot seats for their organization members.
1350
1358
///
1351
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.
1352
-
/// For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)".
1353
-
/// For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
1360
+
/// 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
+
/// 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)."
1354
1362
///
1355
1363
/// The response will contain the total number of new seats that were created and existing seats that were refreshed.
1356
1364
///
@@ -1520,15 +1528,17 @@ public struct Client: APIProtocol {
1520
1528
/// > [!NOTE]
1521
1529
/// > This endpoint is in public preview and is subject to change.
1522
1530
///
1523
-
/// Cancels the Copilot seat assignment for all members of each team specified.
1524
-
/// This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
1531
+
/// Sets seats for all members of each team specified to "pending cancellation".
1532
+
/// 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.
1525
1533
///
1526
-
/// For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
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)."
1527
1535
///
1528
-
/// For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
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)."
1529
1537
///
1530
1538
/// Only organization owners can cancel Copilot seats for their organization members.
1531
1539
///
1540
+
/// The response will contain the total number of seats set to "pending cancellation".
1541
+
///
1532
1542
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
@@ -1696,13 +1706,13 @@ public struct Client: APIProtocol {
1696
1706
/// > This endpoint is in public preview and is subject to change.
1697
1707
///
1698
1708
/// Purchases a GitHub Copilot seat for each user specified.
1699
-
/// The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
1709
+
/// 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)."
1700
1710
///
1701
1711
/// Only organization owners can add Copilot seats for their organization members.
1702
1712
///
1703
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.
1704
-
/// For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)".
1705
-
/// For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)".
1714
+
/// 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
+
/// 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)."
1706
1716
///
1707
1717
/// The response will contain the total number of new seats that were created and existing seats that were refreshed.
1708
1718
///
@@ -1872,15 +1882,17 @@ public struct Client: APIProtocol {
1872
1882
/// > [!NOTE]
1873
1883
/// > This endpoint is in public preview and is subject to change.
1874
1884
///
1875
-
/// Cancels the Copilot seat assignment for each user specified.
1876
-
/// This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users.
1885
+
/// Sets seats for all users specified to "pending cancellation".
1886
+
/// 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.
1877
1887
///
1878
-
/// For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)".
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)."
1879
1889
///
1880
-
/// For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)".
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)."
1881
1891
///
1882
1892
/// Only organization owners can cancel Copilot seats for their organization members.
1883
1893
///
1894
+
/// The response will contain the total number of seats set to "pending cancellation".
1895
+
///
1884
1896
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
@@ -2432,7 +2444,10 @@ public struct Client: APIProtocol {
2432
2444
/// > [!NOTE]
2433
2445
/// > This endpoint is in public preview and is subject to change.
2434
2446
///
2435
-
/// Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot.
2447
+
/// Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot.
2448
+
///
2449
+
/// The seat object contains information about the user's most recent Copilot activity. Users must have telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`.
2450
+
/// For more information about activity data, see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)."
2436
2451
///
2437
2452
/// Only organization owners can view Copilot seat assignment details for members of their organization.
0 commit comments