diff --git a/Sources/copilot/Client.swift b/Sources/copilot/Client.swift index 4d43edfcdb4..bbde87f6ae3 100644 --- a/Sources/copilot/Client.swift +++ b/Sources/copilot/Client.swift @@ -43,11 +43,14 @@ public struct Client: APIProtocol { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + /// Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. /// /// Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. /// /// For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + /// 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`. 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)." /// /// Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. /// @@ -425,6 +428,8 @@ public struct Client: APIProtocol { /// and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, /// they must have telemetry enabled in their IDE. /// + /// The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + /// /// Only owners and billing managers can view Copilot usage metrics for the enterprise. /// /// 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 { /// /// Gets information about an organization's Copilot subscription, including seat breakdown /// and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - /// 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)". + /// 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)." /// /// Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. /// @@ -1163,9 +1168,12 @@ public struct Client: APIProtocol { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + /// Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. /// Only organization owners can view assigned seats. /// + /// 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`. + /// 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)." + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing/seats`. @@ -1344,13 +1352,13 @@ public struct Client: APIProtocol { /// > This endpoint is in public preview and is subject to change. /// /// Purchases a GitHub Copilot seat for all users within each specified team. - /// 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)". + /// 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)." /// /// Only organization owners can add Copilot seats for their organization members. /// /// 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. - /// 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)". - /// 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)". + /// 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)." + /// 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)." /// /// The response will contain the total number of new seats that were created and existing seats that were refreshed. /// @@ -1520,15 +1528,17 @@ public struct Client: APIProtocol { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Cancels the Copilot seat assignment for all members of each team specified. - /// 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. + /// Sets seats for all members of each team specified to "pending cancellation". + /// 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. /// - /// 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)". + /// 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)." /// - /// 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)". + /// 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)." /// /// Only organization owners can cancel Copilot seats for their organization members. /// + /// The response will contain the total number of seats set to "pending cancellation". + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_teams`. @@ -1696,13 +1706,13 @@ public struct Client: APIProtocol { /// > This endpoint is in public preview and is subject to change. /// /// Purchases a GitHub Copilot seat for each user specified. - /// 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)". + /// 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)." /// /// Only organization owners can add Copilot seats for their organization members. /// /// 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. - /// 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)". - /// 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)". + /// 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)." + /// 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)." /// /// The response will contain the total number of new seats that were created and existing seats that were refreshed. /// @@ -1872,15 +1882,17 @@ public struct Client: APIProtocol { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Cancels the Copilot seat assignment for each user specified. - /// 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. + /// Sets seats for all users specified to "pending cancellation". + /// 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. /// - /// 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)". + /// 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)." /// - /// 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)". + /// 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)." /// /// Only organization owners can cancel Copilot seats for their organization members. /// + /// The response will contain the total number of seats set to "pending cancellation". + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_users`. @@ -2432,7 +2444,10 @@ public struct Client: APIProtocol { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + /// Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + /// + /// 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`. + /// 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)." /// /// Only organization owners can view Copilot seat assignment details for members of their organization. /// diff --git a/Sources/copilot/Types.swift b/Sources/copilot/Types.swift index 884622db1f0..89c00e39ebf 100644 --- a/Sources/copilot/Types.swift +++ b/Sources/copilot/Types.swift @@ -16,11 +16,14 @@ public protocol APIProtocol: Sendable { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + /// Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. /// /// Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. /// /// For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + /// 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`. 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)." /// /// Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. /// @@ -58,6 +61,8 @@ public protocol APIProtocol: Sendable { /// and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, /// they must have telemetry enabled in their IDE. /// + /// The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + /// /// Only owners and billing managers can view Copilot usage metrics for the enterprise. /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -114,7 +119,7 @@ public protocol APIProtocol: Sendable { /// /// Gets information about an organization's Copilot subscription, including seat breakdown /// and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - /// 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)". + /// 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)." /// /// Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. /// @@ -128,9 +133,12 @@ public protocol APIProtocol: Sendable { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + /// Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. /// Only organization owners can view assigned seats. /// + /// 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`. + /// 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)." + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing/seats`. @@ -142,13 +150,13 @@ public protocol APIProtocol: Sendable { /// > This endpoint is in public preview and is subject to change. /// /// Purchases a GitHub Copilot seat for all users within each specified team. - /// 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)". + /// 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)." /// /// Only organization owners can add Copilot seats for their organization members. /// /// 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. - /// 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)". - /// 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)". + /// 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)." + /// 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)." /// /// The response will contain the total number of new seats that were created and existing seats that were refreshed. /// @@ -162,15 +170,17 @@ public protocol APIProtocol: Sendable { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Cancels the Copilot seat assignment for all members of each team specified. - /// 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. + /// Sets seats for all members of each team specified to "pending cancellation". + /// 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. /// - /// 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)". + /// 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)." /// - /// 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)". + /// 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)." /// /// Only organization owners can cancel Copilot seats for their organization members. /// + /// The response will contain the total number of seats set to "pending cancellation". + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_teams`. @@ -182,13 +192,13 @@ public protocol APIProtocol: Sendable { /// > This endpoint is in public preview and is subject to change. /// /// Purchases a GitHub Copilot seat for each user specified. - /// 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)". + /// 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)." /// /// Only organization owners can add Copilot seats for their organization members. /// /// 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. - /// 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)". - /// 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)". + /// 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)." + /// 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)." /// /// The response will contain the total number of new seats that were created and existing seats that were refreshed. /// @@ -202,15 +212,17 @@ public protocol APIProtocol: Sendable { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Cancels the Copilot seat assignment for each user specified. - /// 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. + /// Sets seats for all users specified to "pending cancellation". + /// 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. /// - /// 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)". + /// 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)." /// - /// 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)". + /// 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)." /// /// Only organization owners can cancel Copilot seats for their organization members. /// + /// The response will contain the total number of seats set to "pending cancellation". + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_users`. @@ -260,7 +272,10 @@ public protocol APIProtocol: Sendable { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + /// Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + /// + /// 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`. + /// 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)." /// /// Only organization owners can view Copilot seat assignment details for members of their organization. /// @@ -320,11 +335,14 @@ extension APIProtocol { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + /// Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. /// /// Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. /// /// For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + /// 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`. 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)." /// /// Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. /// @@ -382,6 +400,8 @@ extension APIProtocol { /// and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, /// they must have telemetry enabled in their IDE. /// + /// The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + /// /// Only owners and billing managers can view Copilot usage metrics for the enterprise. /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -468,7 +488,7 @@ extension APIProtocol { /// /// Gets information about an organization's Copilot subscription, including seat breakdown /// and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - /// 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)". + /// 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)." /// /// Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. /// @@ -490,9 +510,12 @@ extension APIProtocol { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + /// Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. /// Only organization owners can view assigned seats. /// + /// 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`. + /// 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)." + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing/seats`. @@ -514,13 +537,13 @@ extension APIProtocol { /// > This endpoint is in public preview and is subject to change. /// /// Purchases a GitHub Copilot seat for all users within each specified team. - /// 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)". + /// 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)." /// /// Only organization owners can add Copilot seats for their organization members. /// /// 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. - /// 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)". - /// 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)". + /// 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)." + /// 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)." /// /// The response will contain the total number of new seats that were created and existing seats that were refreshed. /// @@ -544,15 +567,17 @@ extension APIProtocol { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Cancels the Copilot seat assignment for all members of each team specified. - /// 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. + /// Sets seats for all members of each team specified to "pending cancellation". + /// 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. /// - /// 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)". + /// 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)." /// - /// 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)". + /// 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)." /// /// Only organization owners can cancel Copilot seats for their organization members. /// + /// The response will contain the total number of seats set to "pending cancellation". + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_teams`. @@ -574,13 +599,13 @@ extension APIProtocol { /// > This endpoint is in public preview and is subject to change. /// /// Purchases a GitHub Copilot seat for each user specified. - /// 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)". + /// 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)." /// /// Only organization owners can add Copilot seats for their organization members. /// /// 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. - /// 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)". - /// 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)". + /// 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)." + /// 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)." /// /// The response will contain the total number of new seats that were created and existing seats that were refreshed. /// @@ -604,15 +629,17 @@ extension APIProtocol { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Cancels the Copilot seat assignment for each user specified. - /// 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. + /// Sets seats for all users specified to "pending cancellation". + /// 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. /// - /// 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)". + /// 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)." /// - /// 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)". + /// 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)." /// /// Only organization owners can cancel Copilot seats for their organization members. /// + /// The response will contain the total number of seats set to "pending cancellation". + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_users`. @@ -692,7 +719,10 @@ extension APIProtocol { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + /// Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + /// + /// 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`. + /// 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)." /// /// Only organization owners can view Copilot seat assignment details for members of their organization. /// @@ -1314,7 +1344,7 @@ public enum Components { /// - Remark: Generated from `#/components/schemas/enterprise-team/sync_to_organizations`. public var sync_to_organizations: Swift.String /// - Remark: Generated from `#/components/schemas/enterprise-team/group_id`. - public var group_id: Swift.Int? + public var group_id: Swift.String? /// - Remark: Generated from `#/components/schemas/enterprise-team/html_url`. public var html_url: Swift.String /// - Remark: Generated from `#/components/schemas/enterprise-team/members_url`. @@ -1342,7 +1372,7 @@ public enum Components { slug: Swift.String, url: Swift.String, sync_to_organizations: Swift.String, - group_id: Swift.Int? = nil, + group_id: Swift.String? = nil, html_url: Swift.String, members_url: Swift.String, created_at: Foundation.Date, @@ -3175,11 +3205,14 @@ public enum Operations { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. + /// Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. /// /// Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. /// /// For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. + /// 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`. 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)." /// /// Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. /// @@ -3763,6 +3796,8 @@ public enum Operations { /// and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, /// they must have telemetry enabled in their IDE. /// + /// The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + /// /// Only owners and billing managers can view Copilot usage metrics for the enterprise. /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -4611,7 +4646,7 @@ public enum Operations { /// /// Gets information about an organization's Copilot subscription, including seat breakdown /// and feature policies. To configure these settings, go to your organization's settings on GitHub.com. - /// 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)". + /// 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)." /// /// Only organization owners can view details about the organization's Copilot Business or Copilot Enterprise subscription. /// @@ -4869,9 +4904,12 @@ public enum Operations { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. + /// Lists all Copilot seats for which an organization with a Copilot Business or Copilot Enterprise subscription is currently being billed. /// Only organization owners can view assigned seats. /// + /// 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`. + /// 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)." + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:org` scopes to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing/seats`. @@ -5171,13 +5209,13 @@ public enum Operations { /// > This endpoint is in public preview and is subject to change. /// /// Purchases a GitHub Copilot seat for all users within each specified team. - /// 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)". + /// 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)." /// /// Only organization owners can add Copilot seats for their organization members. /// /// 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. - /// 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)". - /// 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)". + /// 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)." + /// 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)." /// /// The response will contain the total number of new seats that were created and existing seats that were refreshed. /// @@ -5258,7 +5296,7 @@ public enum Operations { public struct Created: Sendable, Hashable { /// - Remark: Generated from `#/paths/orgs/{org}/copilot/billing/selected_teams/POST/responses/201/content`. @frozen public enum Body: Sendable, Hashable { - /// The total number of seat assignments created. + /// The total number of seats created for members of the specified team(s). /// /// - Remark: Generated from `#/paths/orgs/{org}/copilot/billing/selected_teams/POST/responses/201/content/json`. public struct jsonPayload: Codable, Hashable, Sendable { @@ -5478,15 +5516,17 @@ public enum Operations { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Cancels the Copilot seat assignment for all members of each team specified. - /// 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. + /// Sets seats for all members of each team specified to "pending cancellation". + /// 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. /// - /// 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)". + /// 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)." /// - /// 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)". + /// 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)." /// /// Only organization owners can cancel Copilot seats for their organization members. /// + /// The response will contain the total number of seats set to "pending cancellation". + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_teams`. @@ -5564,7 +5604,7 @@ public enum Operations { public struct Ok: Sendable, Hashable { /// - Remark: Generated from `#/paths/orgs/{org}/copilot/billing/selected_teams/DELETE/responses/200/content`. @frozen public enum Body: Sendable, Hashable { - /// The total number of seat assignments cancelled. + /// The total number of seats set to "pending cancellation" for members of the specified team(s). /// /// - Remark: Generated from `#/paths/orgs/{org}/copilot/billing/selected_teams/DELETE/responses/200/content/json`. public struct jsonPayload: Codable, Hashable, Sendable { @@ -5785,13 +5825,13 @@ public enum Operations { /// > This endpoint is in public preview and is subject to change. /// /// Purchases a GitHub Copilot seat for each user specified. - /// 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)". + /// 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)." /// /// Only organization owners can add Copilot seats for their organization members. /// /// 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. - /// 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)". - /// 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)". + /// 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)." + /// 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)." /// /// The response will contain the total number of new seats that were created and existing seats that were refreshed. /// @@ -5872,7 +5912,7 @@ public enum Operations { public struct Created: Sendable, Hashable { /// - Remark: Generated from `#/paths/orgs/{org}/copilot/billing/selected_users/POST/responses/201/content`. @frozen public enum Body: Sendable, Hashable { - /// The total number of seat assignments created. + /// The total number of seats created for the specified user(s). /// /// - Remark: Generated from `#/paths/orgs/{org}/copilot/billing/selected_users/POST/responses/201/content/json`. public struct jsonPayload: Codable, Hashable, Sendable { @@ -6092,15 +6132,17 @@ public enum Operations { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Cancels the Copilot seat assignment for each user specified. - /// 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. + /// Sets seats for all users specified to "pending cancellation". + /// 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. /// - /// 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)". + /// 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)." /// - /// 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)". + /// 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)." /// /// Only organization owners can cancel Copilot seats for their organization members. /// + /// The response will contain the total number of seats set to "pending cancellation". + /// /// OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:org` scopes to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_users`. @@ -6178,7 +6220,7 @@ public enum Operations { public struct Ok: Sendable, Hashable { /// - Remark: Generated from `#/paths/orgs/{org}/copilot/billing/selected_users/DELETE/responses/200/content`. @frozen public enum Body: Sendable, Hashable { - /// The total number of seat assignments cancelled. + /// The total number of seats set to "pending cancellation" for the specified users. /// /// - Remark: Generated from `#/paths/orgs/{org}/copilot/billing/selected_users/DELETE/responses/200/content/json`. public struct jsonPayload: Codable, Hashable, Sendable { @@ -6953,7 +6995,10 @@ public enum Operations { /// > [!NOTE] /// > This endpoint is in public preview and is subject to change. /// - /// Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + /// Gets the GitHub Copilot seat details for a member of an organization who currently has access to GitHub Copilot. + /// + /// 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`. + /// 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)." /// /// Only organization owners can view Copilot seat assignment details for members of their organization. /// diff --git a/Sources/dependency-graph/Types.swift b/Sources/dependency-graph/Types.swift index 8cb6940a2cb..f122c1d51fb 100644 --- a/Sources/dependency-graph/Types.swift +++ b/Sources/dependency-graph/Types.swift @@ -287,6 +287,10 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/spdxVersion`. public var spdxVersion: Swift.String + /// An optional comment about the SPDX document. + /// + /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/comment`. + public var comment: Swift.String? /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/creationInfo`. public struct creationInfoPayload: Codable, Hashable, Sendable { /// The date and time the SPDX document was created. @@ -324,10 +328,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/dataLicense`. public var dataLicense: Swift.String - /// The name of the repository that the SPDX document describes. - /// - /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/documentDescribes`. - public var documentDescribes: [Swift.String] /// The namespace for the SPDX document. /// /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/documentNamespace`. @@ -466,45 +466,88 @@ public enum Components { public typealias packagesPayload = [Components.Schemas.dependency_hyphen_graph_hyphen_spdx_hyphen_sbom.sbomPayload.packagesPayloadPayload] /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/packages`. public var packages: Components.Schemas.dependency_hyphen_graph_hyphen_spdx_hyphen_sbom.sbomPayload.packagesPayload + /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/relationshipsPayload`. + public struct relationshipsPayloadPayload: Codable, Hashable, Sendable { + /// The type of relationship between the two SPDX elements. + /// + /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/relationshipsPayload/relationshipType`. + public var relationshipType: Swift.String? + /// The SPDX identifier of the package that is the source of the relationship. + /// + /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/relationshipsPayload/spdxElementId`. + public var spdxElementId: Swift.String? + /// The SPDX identifier of the package that is the target of the relationship. + /// + /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/relationshipsPayload/relatedSpdxElement`. + public var relatedSpdxElement: Swift.String? + /// Creates a new `relationshipsPayloadPayload`. + /// + /// - Parameters: + /// - relationshipType: The type of relationship between the two SPDX elements. + /// - spdxElementId: The SPDX identifier of the package that is the source of the relationship. + /// - relatedSpdxElement: The SPDX identifier of the package that is the target of the relationship. + public init( + relationshipType: Swift.String? = nil, + spdxElementId: Swift.String? = nil, + relatedSpdxElement: Swift.String? = nil + ) { + self.relationshipType = relationshipType + self.spdxElementId = spdxElementId + self.relatedSpdxElement = relatedSpdxElement + } + public enum CodingKeys: String, CodingKey { + case relationshipType + case spdxElementId + case relatedSpdxElement + } + } + /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/relationships`. + public typealias relationshipsPayload = [Components.Schemas.dependency_hyphen_graph_hyphen_spdx_hyphen_sbom.sbomPayload.relationshipsPayloadPayload] + /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom/relationships`. + public var relationships: Components.Schemas.dependency_hyphen_graph_hyphen_spdx_hyphen_sbom.sbomPayload.relationshipsPayload? /// Creates a new `sbomPayload`. /// /// - Parameters: /// - SPDXID: The SPDX identifier for the SPDX document. /// - spdxVersion: The version of the SPDX specification that this document conforms to. + /// - comment: An optional comment about the SPDX document. /// - creationInfo: /// - name: The name of the SPDX document. /// - dataLicense: The license under which the SPDX document is licensed. - /// - documentDescribes: The name of the repository that the SPDX document describes. /// - documentNamespace: The namespace for the SPDX document. /// - packages: + /// - relationships: public init( SPDXID: Swift.String, spdxVersion: Swift.String, + comment: Swift.String? = nil, creationInfo: Components.Schemas.dependency_hyphen_graph_hyphen_spdx_hyphen_sbom.sbomPayload.creationInfoPayload, name: Swift.String, dataLicense: Swift.String, - documentDescribes: [Swift.String], documentNamespace: Swift.String, - packages: Components.Schemas.dependency_hyphen_graph_hyphen_spdx_hyphen_sbom.sbomPayload.packagesPayload + packages: Components.Schemas.dependency_hyphen_graph_hyphen_spdx_hyphen_sbom.sbomPayload.packagesPayload, + relationships: Components.Schemas.dependency_hyphen_graph_hyphen_spdx_hyphen_sbom.sbomPayload.relationshipsPayload? = nil ) { self.SPDXID = SPDXID self.spdxVersion = spdxVersion + self.comment = comment self.creationInfo = creationInfo self.name = name self.dataLicense = dataLicense - self.documentDescribes = documentDescribes self.documentNamespace = documentNamespace self.packages = packages + self.relationships = relationships } public enum CodingKeys: String, CodingKey { case SPDXID case spdxVersion + case comment case creationInfo case name case dataLicense - case documentDescribes case documentNamespace case packages + case relationships } } /// - Remark: Generated from `#/components/schemas/dependency-graph-spdx-sbom/sbom`. diff --git a/Sources/gists/Types.swift b/Sources/gists/Types.swift index b1c5539cb04..8a02d7d31ea 100644 --- a/Sources/gists/Types.swift +++ b/Sources/gists/Types.swift @@ -1072,6 +1072,10 @@ public enum Components { public var raw_url: Swift.String? /// - Remark: Generated from `#/components/schemas/base-gist/files/additionalProperties/size`. public var size: Swift.Int? + /// The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + /// + /// - Remark: Generated from `#/components/schemas/base-gist/files/additionalProperties/encoding`. + public var encoding: Swift.String? /// Creates a new `additionalPropertiesPayload`. /// /// - Parameters: @@ -1080,18 +1084,21 @@ public enum Components { /// - language: /// - raw_url: /// - size: + /// - encoding: The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. public init( filename: Swift.String? = nil, _type: Swift.String? = nil, language: Swift.String? = nil, raw_url: Swift.String? = nil, - size: Swift.Int? = nil + size: Swift.Int? = nil, + encoding: Swift.String? = nil ) { self.filename = filename self._type = _type self.language = language self.raw_url = raw_url self.size = size + self.encoding = encoding } public enum CodingKeys: String, CodingKey { case filename @@ -1099,6 +1106,7 @@ public enum Components { case language case raw_url case size + case encoding } } /// A container of undocumented properties. @@ -2078,6 +2086,10 @@ public enum Components { public var truncated: Swift.Bool? /// - Remark: Generated from `#/components/schemas/gist-simple/files/additionalProperties/content`. public var content: Swift.String? + /// The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. + /// + /// - Remark: Generated from `#/components/schemas/gist-simple/files/additionalProperties/encoding`. + public var encoding: Swift.String? /// Creates a new `additionalPropertiesPayload`. /// /// - Parameters: @@ -2088,6 +2100,7 @@ public enum Components { /// - size: /// - truncated: /// - content: + /// - encoding: The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. public init( filename: Swift.String? = nil, _type: Swift.String? = nil, @@ -2095,7 +2108,8 @@ public enum Components { raw_url: Swift.String? = nil, size: Swift.Int? = nil, truncated: Swift.Bool? = nil, - content: Swift.String? = nil + content: Swift.String? = nil, + encoding: Swift.String? = nil ) { self.filename = filename self._type = _type @@ -2104,6 +2118,7 @@ public enum Components { self.size = size self.truncated = truncated self.content = content + self.encoding = encoding } public enum CodingKeys: String, CodingKey { case filename @@ -2113,6 +2128,7 @@ public enum Components { case size case truncated case content + case encoding } } /// A container of undocumented properties. diff --git a/Sources/orgs/Types.swift b/Sources/orgs/Types.swift index ec2df9e14aa..42e99fa3fc3 100644 --- a/Sources/orgs/Types.swift +++ b/Sources/orgs/Types.swift @@ -5652,6 +5652,10 @@ public enum Components { public var updated_at: Foundation.Date /// - Remark: Generated from `#/components/schemas/organization-full/archived_at`. public var archived_at: Foundation.Date? + /// Controls whether or not deploy keys may be added and used for repositories in the organization. + /// + /// - Remark: Generated from `#/components/schemas/organization-full/deploy_keys_enabled_for_repositories`. + public var deploy_keys_enabled_for_repositories: Swift.Bool? /// Creates a new `organization_hyphen_full`. /// /// - Parameters: @@ -5712,6 +5716,7 @@ public enum Components { /// - created_at: /// - updated_at: /// - archived_at: + /// - deploy_keys_enabled_for_repositories: Controls whether or not deploy keys may be added and used for repositories in the organization. public init( login: Swift.String, id: Swift.Int, @@ -5769,7 +5774,8 @@ public enum Components { secret_scanning_push_protection_custom_link: Swift.String? = nil, created_at: Foundation.Date, updated_at: Foundation.Date, - archived_at: Foundation.Date? = nil + archived_at: Foundation.Date? = nil, + deploy_keys_enabled_for_repositories: Swift.Bool? = nil ) { self.login = login self.id = id @@ -5828,6 +5834,7 @@ public enum Components { self.created_at = created_at self.updated_at = updated_at self.archived_at = archived_at + self.deploy_keys_enabled_for_repositories = deploy_keys_enabled_for_repositories } public enum CodingKeys: String, CodingKey { case login @@ -5887,6 +5894,7 @@ public enum Components { case created_at case updated_at case archived_at + case deploy_keys_enabled_for_repositories } } /// Organization Invitation @@ -7008,6 +7016,10 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/organization-programmatic-access-grant-request/token_id`. public var token_id: Swift.Int + /// The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. + /// + /// - Remark: Generated from `#/components/schemas/organization-programmatic-access-grant-request/token_name`. + public var token_name: Swift.String /// Whether the associated fine-grained personal access token has expired. /// /// - Remark: Generated from `#/components/schemas/organization-programmatic-access-grant-request/token_expired`. @@ -7031,6 +7043,7 @@ public enum Components { /// - permissions: Permissions requested, categorized by type of permission. /// - created_at: Date and time when the request for access was created. /// - token_id: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + /// - token_name: The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. /// - token_expired: Whether the associated fine-grained personal access token has expired. /// - token_expires_at: Date and time when the associated fine-grained personal access token expires. /// - token_last_used_at: Date and time when the associated fine-grained personal access token was last used for authentication. @@ -7043,6 +7056,7 @@ public enum Components { permissions: Components.Schemas.organization_hyphen_programmatic_hyphen_access_hyphen_grant_hyphen_request.permissionsPayload, created_at: Swift.String, token_id: Swift.Int, + token_name: Swift.String, token_expired: Swift.Bool, token_expires_at: Swift.String? = nil, token_last_used_at: Swift.String? = nil @@ -7055,6 +7069,7 @@ public enum Components { self.permissions = permissions self.created_at = created_at self.token_id = token_id + self.token_name = token_name self.token_expired = token_expired self.token_expires_at = token_expires_at self.token_last_used_at = token_last_used_at @@ -7068,6 +7083,7 @@ public enum Components { case permissions case created_at case token_id + case token_name case token_expired case token_expires_at case token_last_used_at @@ -7196,6 +7212,10 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/organization-programmatic-access-grant/token_id`. public var token_id: Swift.Int + /// The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. + /// + /// - Remark: Generated from `#/components/schemas/organization-programmatic-access-grant/token_name`. + public var token_name: Swift.String /// Whether the associated fine-grained personal access token has expired. /// /// - Remark: Generated from `#/components/schemas/organization-programmatic-access-grant/token_expired`. @@ -7218,6 +7238,7 @@ public enum Components { /// - permissions: Permissions requested, categorized by type of permission. /// - access_granted_at: Date and time when the fine-grained personal access token was approved to access the organization. /// - token_id: Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants. + /// - token_name: The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens. /// - token_expired: Whether the associated fine-grained personal access token has expired. /// - token_expires_at: Date and time when the associated fine-grained personal access token expires. /// - token_last_used_at: Date and time when the associated fine-grained personal access token was last used for authentication. @@ -7229,6 +7250,7 @@ public enum Components { permissions: Components.Schemas.organization_hyphen_programmatic_hyphen_access_hyphen_grant.permissionsPayload, access_granted_at: Swift.String, token_id: Swift.Int, + token_name: Swift.String, token_expired: Swift.Bool, token_expires_at: Swift.String? = nil, token_last_used_at: Swift.String? = nil @@ -7240,6 +7262,7 @@ public enum Components { self.permissions = permissions self.access_granted_at = access_granted_at self.token_id = token_id + self.token_name = token_name self.token_expired = token_expired self.token_expires_at = token_expires_at self.token_last_used_at = token_last_used_at @@ -7252,6 +7275,7 @@ public enum Components { case permissions case access_granted_at case token_id + case token_name case token_expired case token_expires_at case token_last_used_at @@ -8509,6 +8533,10 @@ public enum Operations { /// /// - Remark: Generated from `#/paths/orgs/{org}/PATCH/requestBody/json/secret_scanning_push_protection_custom_link`. public var secret_scanning_push_protection_custom_link: Swift.String? + /// Controls whether or not deploy keys may be added and used for repositories in the organization. + /// + /// - Remark: Generated from `#/paths/orgs/{org}/PATCH/requestBody/json/deploy_keys_enabled_for_repositories`. + public var deploy_keys_enabled_for_repositories: Swift.Bool? /// Creates a new `jsonPayload`. /// /// - Parameters: @@ -8541,6 +8569,7 @@ public enum Operations { /// - secret_scanning_push_protection_enabled_for_new_repositories: **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. /// - secret_scanning_push_protection_custom_link_enabled: Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection. /// - secret_scanning_push_protection_custom_link: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret. + /// - deploy_keys_enabled_for_repositories: Controls whether or not deploy keys may be added and used for repositories in the organization. public init( billing_email: Swift.String? = nil, company: Swift.String? = nil, @@ -8570,7 +8599,8 @@ public enum Operations { secret_scanning_enabled_for_new_repositories: Swift.Bool? = nil, secret_scanning_push_protection_enabled_for_new_repositories: Swift.Bool? = nil, secret_scanning_push_protection_custom_link_enabled: Swift.Bool? = nil, - secret_scanning_push_protection_custom_link: Swift.String? = nil + secret_scanning_push_protection_custom_link: Swift.String? = nil, + deploy_keys_enabled_for_repositories: Swift.Bool? = nil ) { self.billing_email = billing_email self.company = company @@ -8601,6 +8631,7 @@ public enum Operations { self.secret_scanning_push_protection_enabled_for_new_repositories = secret_scanning_push_protection_enabled_for_new_repositories self.secret_scanning_push_protection_custom_link_enabled = secret_scanning_push_protection_custom_link_enabled self.secret_scanning_push_protection_custom_link = secret_scanning_push_protection_custom_link + self.deploy_keys_enabled_for_repositories = deploy_keys_enabled_for_repositories } public enum CodingKeys: String, CodingKey { case billing_email @@ -8632,6 +8663,7 @@ public enum Operations { case secret_scanning_push_protection_enabled_for_new_repositories case secret_scanning_push_protection_custom_link_enabled case secret_scanning_push_protection_custom_link + case deploy_keys_enabled_for_repositories } } /// - Remark: Generated from `#/paths/orgs/{org}/PATCH/requestBody/content/application\/json`. diff --git a/Sources/repos/Types.swift b/Sources/repos/Types.swift index c63ec4e96bc..de7ef389530 100644 --- a/Sources/repos/Types.swift +++ b/Sources/repos/Types.swift @@ -19824,6 +19824,8 @@ public enum Components { public var added_by: Swift.String? /// - Remark: Generated from `#/components/schemas/deploy-key/last_used`. public var last_used: Swift.String? + /// - Remark: Generated from `#/components/schemas/deploy-key/enabled`. + public var enabled: Swift.Bool? /// Creates a new `deploy_hyphen_key`. /// /// - Parameters: @@ -19836,6 +19838,7 @@ public enum Components { /// - read_only: /// - added_by: /// - last_used: + /// - enabled: public init( id: Swift.Int, key: Swift.String, @@ -19845,7 +19848,8 @@ public enum Components { created_at: Swift.String, read_only: Swift.Bool, added_by: Swift.String? = nil, - last_used: Swift.String? = nil + last_used: Swift.String? = nil, + enabled: Swift.Bool? = nil ) { self.id = id self.key = key @@ -19856,6 +19860,7 @@ public enum Components { self.read_only = read_only self.added_by = added_by self.last_used = last_used + self.enabled = enabled } public enum CodingKeys: String, CodingKey { case id @@ -19867,6 +19872,7 @@ public enum Components { case read_only case added_by case last_used + case enabled } } /// Language diff --git a/Submodule/github/rest-api-description b/Submodule/github/rest-api-description index 10e2f151b45..4162f99dbe2 160000 --- a/Submodule/github/rest-api-description +++ b/Submodule/github/rest-api-description @@ -1 +1 @@ -Subproject commit 10e2f151b45a960f135417e71bd6f0ac5ce0aa97 +Subproject commit 4162f99dbe229d95e848fd1832a797e58e8c7857