View Source GitHub.Copilot (GitHub REST API Client v0.3.1)

Provides API endpoints related to copilot

Link to this section Summary

Functions

Add teams to the Copilot subscription for an organization

Add users to the Copilot subscription for an organization

Remove teams from the Copilot subscription for an organization

Remove users from the Copilot subscription for an organization

Get Copilot seat information and settings for an organization

Get Copilot seat assignment details for a user

List all Copilot seat assignments for an organization

Link to this section Types

Link to this type

add_copilot_seats_for_teams_201_json_resp()

View Source
@type add_copilot_seats_for_teams_201_json_resp() :: %{
  __info__: map(),
  seats_created: integer()
}
Link to this type

add_copilot_seats_for_users_201_json_resp()

View Source
@type add_copilot_seats_for_users_201_json_resp() :: %{
  __info__: map(),
  seats_created: integer()
}
Link to this type

cancel_copilot_seat_assignment_for_teams_200_json_resp()

View Source
@type cancel_copilot_seat_assignment_for_teams_200_json_resp() :: %{
  __info__: map(),
  seats_cancelled: integer()
}
Link to this type

cancel_copilot_seat_assignment_for_users_200_json_resp()

View Source
@type cancel_copilot_seat_assignment_for_users_200_json_resp() :: %{
  __info__: map(),
  seats_cancelled: integer()
}
Link to this type

list_copilot_seats_200_json_resp()

View Source
@type list_copilot_seats_200_json_resp() :: %{
  __info__: map(),
  seats: [GitHub.Copilot.SeatDetails.t()] | nil,
  total_seats: integer() | nil
}

Link to this section Functions

Link to this function

add_copilot_seats_for_teams(org, body, opts \\ [])

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

Add teams to the Copilot subscription for an organization

Note: This endpoint is in beta 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".

Only organization owners can configure GitHub Copilot in their organization.

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". For more information about setting a suggestion matching policy, see "Configuring suggestion matching policies for GitHub Copilot in your organization".

OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.

resources

Resources

Link to this function

add_copilot_seats_for_users(org, body, opts \\ [])

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

Add users to the Copilot subscription for an organization

Note: This endpoint is in beta 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".

Only organization owners can configure GitHub Copilot in their organization.

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". For more information about setting a suggestion matching policy, see "Configuring suggestion matching policies for GitHub Copilot in your organization".

OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.

resources

Resources

Link to this function

cancel_copilot_seat_assignment_for_teams(org, body, opts \\ [])

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

Remove teams from the Copilot subscription for an organization

Note: This endpoint is in beta 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.

For more information about Copilot pricing, see "Pricing for GitHub Copilot".

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

Only organization owners can configure GitHub Copilot in their organization.

OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.

resources

Resources

Link to this function

cancel_copilot_seat_assignment_for_users(org, body, opts \\ [])

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

Remove users from the Copilot subscription for an organization

Note: This endpoint is in beta 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.

For more information about Copilot pricing, see "Pricing for GitHub Copilot".

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

Only organization owners can configure GitHub Copilot in their organization.

OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.

resources

Resources

Link to this function

get_copilot_organization_details(org, opts \\ [])

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

Get Copilot 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 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 "Managing policies for Copilot in your organization".

Only organization owners can configure and view details about the organization's Copilot Business subscription.

OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.

resources

Resources

Link to this function

get_copilot_seat_details_for_user(org, username, opts \\ [])

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

Get Copilot seat assignment details for a user

Note: This endpoint is in beta 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.

Organization owners can view GitHub Copilot seat assignment details for members in their organization.

OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.

resources

Resources

Link to this function

list_copilot_seats(org, opts \\ [])

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

List all Copilot seat assignments for an organization

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

Lists all Copilot 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 can configure and view details about the organization's Copilot Business or Enterprise subscription.

OAuth app tokens and personal access tokens (classic) need the manage_billing:copilot scope to use this endpoint.

options

Options

resources

Resources