@spec add_copilot_for_business_seats_for_teams(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

Add teams to the Copilot for Business subscription for an organization

Note: This endpoint is in beta and is subject to change.

Purchases a GitHub Copilot for Business seat for all users within each specified team. The organization will be billed accordingly. For more information about Copilot for Business pricing, see "About billing for GitHub Copilot for Business".

Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the manage_billing:copilot scope to use this endpoint.

In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. For more information about setting up a Copilot for Business subscription, see "Setting up a Copilot for Business subscription for your organization". For more information about setting a suggestion matching policy, see "Configuring suggestion matching policies for GitHub Copilot in your organization".

resources

Resources

• API method documentation

@spec add_copilot_for_business_seats_for_users(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

Add users to the Copilot for Business subscription for an organization

Note: This endpoint is in beta and is subject to change.

Purchases a GitHub Copilot for Business seat for each user specified. The organization will be billed accordingly. For more information about Copilot for Business pricing, see "About billing for GitHub Copilot for Business".

Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the manage_billing:copilot scope to use this endpoint.

In order for an admin to use this endpoint, the organization must have a Copilot for Business subscription and a configured suggestion matching policy. For more information about setting up a Copilot for Business subscription, see "Setting up a Copilot for Business subscription for your organization". For more information about setting a suggestion matching policy, see "Configuring suggestion matching policies for GitHub Copilot in your organization".

resources

Resources

• API method documentation

@spec cancel_copilot_seat_assignment_for_teams(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

Remove teams from the Copilot for Business subscription for an organization

Note: This endpoint is in beta and is subject to change.

Cancels the Copilot for Business 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.

For more information about Copilot for Business pricing, see "About billing for GitHub Copilot for Business".

For more information about disabling access to Copilot for Business, see "Disabling access to GitHub Copilot for specific users in your organization".

Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the manage_billing:copilot scope to use this endpoint.

resources

Resources

• API method documentation

@spec cancel_copilot_seat_assignment_for_users(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, GitHub.Error.t()}

Remove users from the Copilot for Business subscription for an organization

Note: This endpoint is in beta and is subject to change.

Cancels the Copilot for Business 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.

For more information about Copilot for Business pricing, see "About billing for GitHub Copilot for Business"

For more information about disabling access to Copilot for Business, see "Disabling access to GitHub Copilot for specific users in your organization".

Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must authenticate using an access token with the manage_billing:copilot scope to use this endpoint.

resources

Resources

• API method documentation

@spec get_copilot_organization_details(
  String.t(),
  keyword()
) :: {:ok, GitHub.Copilot.OrganizationDetails.t()} | {:error, GitHub.Error.t()}

Get Copilot for Business seat information and settings for an organization

Note: This endpoint is in beta and is subject to change.

Gets information about an organization's Copilot for Business subscription, including seat breakdown and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. For more information, see "Configuring GitHub Copilot settings in your organization".

Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must authenticate using an access token with the manage_billing:copilot scope to use this endpoint.

resources

Resources

• API method documentation

@spec get_copilot_seat_assignment_details_for_user(String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Copilot.SeatDetails.t()} | {:error, GitHub.Error.t()}

Get Copilot for Business seat assignment details for a user

Note: This endpoint is in beta and is subject to change.

Gets the GitHub Copilot for Business seat assignment details for a member of an organization who currently has access to GitHub Copilot.

Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the manage_billing:copilot scope to use this endpoint.

resources

Resources

• API method documentation

@spec list_copilot_seats(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, GitHub.Error.t()}

List all Copilot for Business seat assignments for an organization

Note: This endpoint is in beta and is subject to change.

Lists all Copilot for Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle).

Only organization owners and members with admin permissions can configure and view details about the organization's Copilot for Business subscription. You must authenticate using an access token with the manage_billing:copilot scope to use this endpoint.

options

Options

• page: Page number of the results to fetch.
• per_page: The number of results per page (max 100).

resources

Resources

• API method documentation