Skip to content

Commit e078dd4

Browse files
Merge pull request #86 from Wei18/dependabot/submodules/Submodule/github/rest-api-description-4162f99
Bump Submodule/github/rest-api-description from `10e2f15` to `4162f99`
2 parents b7e0b5b + ef2a9dd commit e078dd4

File tree

7 files changed

+250
-93
lines changed

7 files changed

+250
-93
lines changed

Sources/copilot/Client.swift

+33-18
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,14 @@ public struct Client: APIProtocol {
4343
/// > [!NOTE]
4444
/// > This endpoint is in public preview and is subject to change.
4545
///
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.
4747
///
4848
/// Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.
4949
///
5050
/// 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)."
5154
///
5255
/// Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.
5356
///
@@ -425,6 +428,8 @@ public struct Client: APIProtocol {
425428
/// and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,
426429
/// they must have telemetry enabled in their IDE.
427430
///
431+
/// The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time.
432+
///
428433
/// Only owners and billing managers can view Copilot usage metrics for the enterprise.
429434
///
430435
/// 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 {
10021007
///
10031008
/// Gets information about an organization's Copilot subscription, including seat breakdown
10041009
/// 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)."
10061011
///
10071012
/// Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription.
10081013
///
@@ -1163,9 +1168,12 @@ public struct Client: APIProtocol {
11631168
/// > [!NOTE]
11641169
/// > This endpoint is in public preview and is subject to change.
11651170
///
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.
11671172
/// Only organization owners can view assigned seats.
11681173
///
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+
///
11691177
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint.
11701178
///
11711179
/// - Remark: HTTP `GET /orgs/{org}/copilot/billing/seats`.
@@ -1344,13 +1352,13 @@ public struct Client: APIProtocol {
13441352
/// > This endpoint is in public preview and is subject to change.
13451353
///
13461354
/// 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)."
13481356
///
13491357
/// Only organization owners can add Copilot seats for their organization members.
13501358
///
13511359
/// 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)."
13541362
///
13551363
/// The response will contain the total number of new seats that were created and existing seats that were refreshed.
13561364
///
@@ -1520,15 +1528,17 @@ public struct Client: APIProtocol {
15201528
/// > [!NOTE]
15211529
/// > This endpoint is in public preview and is subject to change.
15221530
///
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.
15251533
///
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)."
15271535
///
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)."
15291537
///
15301538
/// Only organization owners can cancel Copilot seats for their organization members.
15311539
///
1540+
/// The response will contain the total number of seats set to "pending cancellation".
1541+
///
15321542
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
15331543
///
15341544
/// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_teams`.
@@ -1696,13 +1706,13 @@ public struct Client: APIProtocol {
16961706
/// > This endpoint is in public preview and is subject to change.
16971707
///
16981708
/// 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)."
17001710
///
17011711
/// Only organization owners can add Copilot seats for their organization members.
17021712
///
17031713
/// 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)."
17061716
///
17071717
/// The response will contain the total number of new seats that were created and existing seats that were refreshed.
17081718
///
@@ -1872,15 +1882,17 @@ public struct Client: APIProtocol {
18721882
/// > [!NOTE]
18731883
/// > This endpoint is in public preview and is subject to change.
18741884
///
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.
18771887
///
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)."
18791889
///
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)."
18811891
///
18821892
/// Only organization owners can cancel Copilot seats for their organization members.
18831893
///
1894+
/// The response will contain the total number of seats set to "pending cancellation".
1895+
///
18841896
/// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint.
18851897
///
18861898
/// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_users`.
@@ -2432,7 +2444,10 @@ public struct Client: APIProtocol {
24322444
/// > [!NOTE]
24332445
/// > This endpoint is in public preview and is subject to change.
24342446
///
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)."
24362451
///
24372452
/// Only organization owners can view Copilot seat assignment details for members of their organization.
24382453
///

0 commit comments

Comments
 (0)