Documentation
¶
Index ¶
- func CreateItemCopilotBillingSeatsGetResponseFromDiscriminatorValue(...) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, ...)
- type EnterprisesRequestBuilder
- type ItemCopilotBillingRequestBuilder
- type ItemCopilotBillingSeatsGetResponse
- func (m *ItemCopilotBillingSeatsGetResponse) GetAdditionalData() map[string]any
- func (m *ItemCopilotBillingSeatsGetResponse) GetFieldDeserializers() ...
- func (m *ItemCopilotBillingSeatsGetResponse) GetSeats() ...
- func (m *ItemCopilotBillingSeatsGetResponse) GetTotalSeats() *int32
- func (m *ItemCopilotBillingSeatsGetResponse) Serialize(...) error
- func (m *ItemCopilotBillingSeatsGetResponse) SetAdditionalData(value map[string]any)
- func (m *ItemCopilotBillingSeatsGetResponse) SetSeats(...)
- func (m *ItemCopilotBillingSeatsGetResponse) SetTotalSeats(value *int32)
- type ItemCopilotBillingSeatsGetResponseable
- type ItemCopilotBillingSeatsRequestBuilder
- func (m *ItemCopilotBillingSeatsRequestBuilder) Get(ctx context.Context, ...) (ItemCopilotBillingSeatsGetResponseable, error)
- func (m *ItemCopilotBillingSeatsRequestBuilder) ToGetRequestInformation(ctx context.Context, ...) (...)
- func (m *ItemCopilotBillingSeatsRequestBuilder) WithUrl(rawUrl string) *ItemCopilotBillingSeatsRequestBuilder
- type ItemCopilotBillingSeatsRequestBuilderGetQueryParameters
- type ItemCopilotRequestBuilder
- type ItemCopilotUsageRequestBuilder
- type ItemCopilotUsageRequestBuilderGetQueryParameters
- type ItemDependabotAlertsRequestBuilder
- type ItemDependabotAlertsRequestBuilderGetQueryParameters
- type ItemDependabotRequestBuilder
- type ItemSecretScanningAlertsRequestBuilder
- func (m *ItemSecretScanningAlertsRequestBuilder) Get(ctx context.Context, ...) (...)
- func (m *ItemSecretScanningAlertsRequestBuilder) ToGetRequestInformation(ctx context.Context, ...) (...)
- func (m *ItemSecretScanningAlertsRequestBuilder) WithUrl(rawUrl string) *ItemSecretScanningAlertsRequestBuilder
- type ItemSecretScanningAlertsRequestBuilderGetQueryParameters
- type ItemSecretScanningRequestBuilder
- type ItemTeamItemCopilotRequestBuilder
- type ItemTeamItemCopilotUsageRequestBuilder
- func (m *ItemTeamItemCopilotUsageRequestBuilder) Get(ctx context.Context, ...) (...)
- func (m *ItemTeamItemCopilotUsageRequestBuilder) ToGetRequestInformation(ctx context.Context, ...) (...)
- func (m *ItemTeamItemCopilotUsageRequestBuilder) WithUrl(rawUrl string) *ItemTeamItemCopilotUsageRequestBuilder
- type ItemTeamItemCopilotUsageRequestBuilderGetQueryParameters
- type ItemTeamRequestBuilder
- type ItemTeamWithTeam_slugItemRequestBuilder
- type WithEnterpriseItemRequestBuilder
- func (m *WithEnterpriseItemRequestBuilder) Copilot() *ItemCopilotRequestBuilder
- func (m *WithEnterpriseItemRequestBuilder) Dependabot() *ItemDependabotRequestBuilder
- func (m *WithEnterpriseItemRequestBuilder) SecretScanning() *ItemSecretScanningRequestBuilder
- func (m *WithEnterpriseItemRequestBuilder) Team() *ItemTeamRequestBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateItemCopilotBillingSeatsGetResponseFromDiscriminatorValue ¶ added in v0.0.17
func CreateItemCopilotBillingSeatsGetResponseFromDiscriminatorValue(parseNode i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) (i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable, error)
CreateItemCopilotBillingSeatsGetResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful
Types ¶
type EnterprisesRequestBuilder ¶
type EnterprisesRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
EnterprisesRequestBuilder builds and executes requests for operations under \enterprises
func NewEnterprisesRequestBuilder ¶
func NewEnterprisesRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *EnterprisesRequestBuilder
NewEnterprisesRequestBuilder instantiates a new EnterprisesRequestBuilder and sets the default values.
func NewEnterprisesRequestBuilderInternal ¶
func NewEnterprisesRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *EnterprisesRequestBuilder
NewEnterprisesRequestBuilderInternal instantiates a new EnterprisesRequestBuilder and sets the default values.
func (*EnterprisesRequestBuilder) ByEnterprise ¶
func (m *EnterprisesRequestBuilder) ByEnterprise(enterprise string) *WithEnterpriseItemRequestBuilder
ByEnterprise gets an item from the github.com/octokit/go-sdk/pkg/github.enterprises.item collection returns a *WithEnterpriseItemRequestBuilder when successful
type ItemCopilotBillingRequestBuilder ¶ added in v0.0.17
type ItemCopilotBillingRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemCopilotBillingRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\copilot\billing
func NewItemCopilotBillingRequestBuilder ¶ added in v0.0.17
func NewItemCopilotBillingRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemCopilotBillingRequestBuilder
NewItemCopilotBillingRequestBuilder instantiates a new ItemCopilotBillingRequestBuilder and sets the default values.
func NewItemCopilotBillingRequestBuilderInternal ¶ added in v0.0.17
func NewItemCopilotBillingRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemCopilotBillingRequestBuilder
NewItemCopilotBillingRequestBuilderInternal instantiates a new ItemCopilotBillingRequestBuilder and sets the default values.
func (*ItemCopilotBillingRequestBuilder) Seats ¶ added in v0.0.17
func (m *ItemCopilotBillingRequestBuilder) Seats() *ItemCopilotBillingSeatsRequestBuilder
Seats the seats property returns a *ItemCopilotBillingSeatsRequestBuilder when successful
type ItemCopilotBillingSeatsGetResponse ¶ added in v0.0.17
type ItemCopilotBillingSeatsGetResponse struct {
// contains filtered or unexported fields
}
func NewItemCopilotBillingSeatsGetResponse ¶ added in v0.0.17
func NewItemCopilotBillingSeatsGetResponse() *ItemCopilotBillingSeatsGetResponse
NewItemCopilotBillingSeatsGetResponse instantiates a new ItemCopilotBillingSeatsGetResponse and sets the default values.
func (*ItemCopilotBillingSeatsGetResponse) GetAdditionalData ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsGetResponse) GetAdditionalData() map[string]any
GetAdditionalData gets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well. returns a map[string]any when successful
func (*ItemCopilotBillingSeatsGetResponse) GetFieldDeserializers ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsGetResponse) GetFieldDeserializers() map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode) error
GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful
func (*ItemCopilotBillingSeatsGetResponse) GetSeats ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsGetResponse) GetSeats() []i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.CopilotSeatDetailsable
GetSeats gets the seats property value. The seats property returns a []CopilotSeatDetailsable when successful
func (*ItemCopilotBillingSeatsGetResponse) GetTotalSeats ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsGetResponse) GetTotalSeats() *int32
GetTotalSeats gets the total_seats property value. The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once. returns a *int32 when successful
func (*ItemCopilotBillingSeatsGetResponse) Serialize ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsGetResponse) Serialize(writer i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.SerializationWriter) error
Serialize serializes information the current object
func (*ItemCopilotBillingSeatsGetResponse) SetAdditionalData ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsGetResponse) SetAdditionalData(value map[string]any)
SetAdditionalData sets the AdditionalData property value. Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.
func (*ItemCopilotBillingSeatsGetResponse) SetSeats ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsGetResponse) SetSeats(value []i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.CopilotSeatDetailsable)
SetSeats sets the seats property value. The seats property
func (*ItemCopilotBillingSeatsGetResponse) SetTotalSeats ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsGetResponse) SetTotalSeats(value *int32)
SetTotalSeats sets the total_seats property value. The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once.
type ItemCopilotBillingSeatsGetResponseable ¶ added in v0.0.17
type ItemCopilotBillingSeatsGetResponseable interface { i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.AdditionalDataHolder i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.Parsable GetSeats() []i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.CopilotSeatDetailsable GetTotalSeats() *int32 SetSeats(value []i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.CopilotSeatDetailsable) SetTotalSeats(value *int32) }
type ItemCopilotBillingSeatsRequestBuilder ¶ added in v0.0.17
type ItemCopilotBillingSeatsRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemCopilotBillingSeatsRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\copilot\billing\seats
func NewItemCopilotBillingSeatsRequestBuilder ¶ added in v0.0.17
func NewItemCopilotBillingSeatsRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemCopilotBillingSeatsRequestBuilder
NewItemCopilotBillingSeatsRequestBuilder instantiates a new ItemCopilotBillingSeatsRequestBuilder and sets the default values.
func NewItemCopilotBillingSeatsRequestBuilderInternal ¶ added in v0.0.17
func NewItemCopilotBillingSeatsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemCopilotBillingSeatsRequestBuilder
NewItemCopilotBillingSeatsRequestBuilderInternal instantiates a new ItemCopilotBillingSeatsRequestBuilder and sets the default values.
func (*ItemCopilotBillingSeatsRequestBuilder) Get ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemCopilotBillingSeatsRequestBuilderGetQueryParameters]) (ItemCopilotBillingSeatsGetResponseable, error)
Get > [!NOTE]> This endpoint is in beta 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.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.Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. returns a ItemCopilotBillingSeatsGetResponseable when successful returns a BasicError error when the service returns a 401 status code returns a BasicError error when the service returns a 403 status code returns a BasicError error when the service returns a 404 status code returns a BasicError error when the service returns a 500 status code API method documentation
func (*ItemCopilotBillingSeatsRequestBuilder) ToGetRequestInformation ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemCopilotBillingSeatsRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation > [!NOTE]> This endpoint is in beta 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.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.Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. returns a *RequestInformation when successful
func (*ItemCopilotBillingSeatsRequestBuilder) WithUrl ¶ added in v0.0.17
func (m *ItemCopilotBillingSeatsRequestBuilder) WithUrl(rawUrl string) *ItemCopilotBillingSeatsRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemCopilotBillingSeatsRequestBuilder when successful
type ItemCopilotBillingSeatsRequestBuilderGetQueryParameters ¶ added in v0.0.17
type ItemCopilotBillingSeatsRequestBuilderGetQueryParameters struct { // The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Page *int32 `uriparametername:"page"` // The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Per_page *int32 `uriparametername:"per_page"` }
ItemCopilotBillingSeatsRequestBuilderGetQueryParameters > [!NOTE]> This endpoint is in beta 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.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.Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.
type ItemCopilotRequestBuilder ¶ added in v0.0.12
type ItemCopilotRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemCopilotRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\copilot
func NewItemCopilotRequestBuilder ¶ added in v0.0.12
func NewItemCopilotRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemCopilotRequestBuilder
NewItemCopilotRequestBuilder instantiates a new ItemCopilotRequestBuilder and sets the default values.
func NewItemCopilotRequestBuilderInternal ¶ added in v0.0.12
func NewItemCopilotRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemCopilotRequestBuilder
NewItemCopilotRequestBuilderInternal instantiates a new ItemCopilotRequestBuilder and sets the default values.
func (*ItemCopilotRequestBuilder) Billing ¶ added in v0.0.17
func (m *ItemCopilotRequestBuilder) Billing() *ItemCopilotBillingRequestBuilder
Billing the billing property returns a *ItemCopilotBillingRequestBuilder when successful
func (*ItemCopilotRequestBuilder) Usage ¶ added in v0.0.12
func (m *ItemCopilotRequestBuilder) Usage() *ItemCopilotUsageRequestBuilder
Usage the usage property returns a *ItemCopilotUsageRequestBuilder when successful
type ItemCopilotUsageRequestBuilder ¶ added in v0.0.12
type ItemCopilotUsageRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemCopilotUsageRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\copilot\usage
func NewItemCopilotUsageRequestBuilder ¶ added in v0.0.12
func NewItemCopilotUsageRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemCopilotUsageRequestBuilder
NewItemCopilotUsageRequestBuilder instantiates a new ItemCopilotUsageRequestBuilder and sets the default values.
func NewItemCopilotUsageRequestBuilderInternal ¶ added in v0.0.12
func NewItemCopilotUsageRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemCopilotUsageRequestBuilder
NewItemCopilotUsageRequestBuilderInternal instantiates a new ItemCopilotUsageRequestBuilder and sets the default values.
func (*ItemCopilotUsageRequestBuilder) Get ¶ added in v0.0.12
func (m *ItemCopilotUsageRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemCopilotUsageRequestBuilderGetQueryParameters]) ([]i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.CopilotUsageMetricsable, error)
Get > [!NOTE]> This endpoint is in beta and is subject to change.You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDEfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,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.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. returns a []CopilotUsageMetricsable when successful returns a BasicError error when the service returns a 401 status code returns a BasicError error when the service returns a 403 status code returns a BasicError error when the service returns a 404 status code returns a BasicError error when the service returns a 500 status code API method documentation
func (*ItemCopilotUsageRequestBuilder) ToGetRequestInformation ¶ added in v0.0.12
func (m *ItemCopilotUsageRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemCopilotUsageRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation > [!NOTE]> This endpoint is in beta and is subject to change.You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDEfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,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.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. returns a *RequestInformation when successful
func (*ItemCopilotUsageRequestBuilder) WithUrl ¶ added in v0.0.12
func (m *ItemCopilotUsageRequestBuilder) WithUrl(rawUrl string) *ItemCopilotUsageRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemCopilotUsageRequestBuilder when successful
type ItemCopilotUsageRequestBuilderGetQueryParameters ¶ added in v0.0.12
type ItemCopilotUsageRequestBuilderGetQueryParameters struct { // The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Page *int32 `uriparametername:"page"` // The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Per_page *int32 `uriparametername:"per_page"` // Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. Since *string `uriparametername:"since"` // Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. Until *string `uriparametername:"until"` }
ItemCopilotUsageRequestBuilderGetQueryParameters > [!NOTE]> This endpoint is in beta and is subject to change.You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDEfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,and number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,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.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.
type ItemDependabotAlertsRequestBuilder ¶
type ItemDependabotAlertsRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemDependabotAlertsRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\dependabot\alerts
func NewItemDependabotAlertsRequestBuilder ¶
func NewItemDependabotAlertsRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemDependabotAlertsRequestBuilder
NewItemDependabotAlertsRequestBuilder instantiates a new ItemDependabotAlertsRequestBuilder and sets the default values.
func NewItemDependabotAlertsRequestBuilderInternal ¶
func NewItemDependabotAlertsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemDependabotAlertsRequestBuilder
NewItemDependabotAlertsRequestBuilderInternal instantiates a new ItemDependabotAlertsRequestBuilder and sets the default values.
func (*ItemDependabotAlertsRequestBuilder) Get ¶
func (m *ItemDependabotAlertsRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemDependabotAlertsRequestBuilderGetQueryParameters]) ([]i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.DependabotAlertWithRepositoryable, error)
Get lists Dependabot alerts for repositories that are owned by the specified enterprise.The authenticated user must be a member of the enterprise to use this endpoint.Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. returns a []DependabotAlertWithRepositoryable when successful returns a BasicError error when the service returns a 403 status code returns a BasicError error when the service returns a 404 status code returns a ValidationErrorSimple error when the service returns a 422 status code API method documentation
func (*ItemDependabotAlertsRequestBuilder) ToGetRequestInformation ¶
func (m *ItemDependabotAlertsRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemDependabotAlertsRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation lists Dependabot alerts for repositories that are owned by the specified enterprise.The authenticated user must be a member of the enterprise to use this endpoint.Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. returns a *RequestInformation when successful
func (*ItemDependabotAlertsRequestBuilder) WithUrl ¶
func (m *ItemDependabotAlertsRequestBuilder) WithUrl(rawUrl string) *ItemDependabotAlertsRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemDependabotAlertsRequestBuilder when successful
type ItemDependabotAlertsRequestBuilderGetQueryParameters ¶
type ItemDependabotAlertsRequestBuilderGetQueryParameters struct { // A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." After *string `uriparametername:"after"` // A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Before *string `uriparametername:"before"` // The direction to sort the results by. Direction *i77c38d6454f4c9dc55005405729b416470b652fa12f001a040f72bc1395cc732.GetDirectionQueryParameterType `uriparametername:"direction"` // A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` Ecosystem *string `uriparametername:"ecosystem"` // **Deprecated**. The number of results per page (max 100), starting from the first matching result.This parameter must not be used in combination with `last`.Instead, use `per_page` in combination with `after` to fetch the first page of results. First *int32 `uriparametername:"first"` // **Deprecated**. The number of results per page (max 100), starting from the last matching result.This parameter must not be used in combination with `first`.Instead, use `per_page` in combination with `before` to fetch the last page of results. Last *int32 `uriparametername:"last"` // A comma-separated list of package names. If specified, only alerts for these packages will be returned. Package *string `uriparametername:"package"` // The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Per_page *int32 `uriparametername:"per_page"` // The scope of the vulnerable dependency. If specified, only alerts with this scope will be returned. Scope *i77c38d6454f4c9dc55005405729b416470b652fa12f001a040f72bc1395cc732.GetScopeQueryParameterType `uriparametername:"scope"` // A comma-separated list of severities. If specified, only alerts with these severities will be returned.Can be: `low`, `medium`, `high`, `critical` Severity *string `uriparametername:"severity"` // The property by which to sort the results.`created` means when the alert was created.`updated` means when the alert's state last changed. Sort *i77c38d6454f4c9dc55005405729b416470b652fa12f001a040f72bc1395cc732.GetSortQueryParameterType `uriparametername:"sort"` // A comma-separated list of states. If specified, only alerts with these states will be returned.Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` State *string `uriparametername:"state"` }
ItemDependabotAlertsRequestBuilderGetQueryParameters lists Dependabot alerts for repositories that are owned by the specified enterprise.The authenticated user must be a member of the enterprise to use this endpoint.Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.
type ItemDependabotRequestBuilder ¶
type ItemDependabotRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemDependabotRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\dependabot
func NewItemDependabotRequestBuilder ¶
func NewItemDependabotRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemDependabotRequestBuilder
NewItemDependabotRequestBuilder instantiates a new ItemDependabotRequestBuilder and sets the default values.
func NewItemDependabotRequestBuilderInternal ¶
func NewItemDependabotRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemDependabotRequestBuilder
NewItemDependabotRequestBuilderInternal instantiates a new ItemDependabotRequestBuilder and sets the default values.
func (*ItemDependabotRequestBuilder) Alerts ¶
func (m *ItemDependabotRequestBuilder) Alerts() *ItemDependabotAlertsRequestBuilder
Alerts the alerts property returns a *ItemDependabotAlertsRequestBuilder when successful
type ItemSecretScanningAlertsRequestBuilder ¶
type ItemSecretScanningAlertsRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemSecretScanningAlertsRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\secret-scanning\alerts
func NewItemSecretScanningAlertsRequestBuilder ¶
func NewItemSecretScanningAlertsRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemSecretScanningAlertsRequestBuilder
NewItemSecretScanningAlertsRequestBuilder instantiates a new ItemSecretScanningAlertsRequestBuilder and sets the default values.
func NewItemSecretScanningAlertsRequestBuilderInternal ¶
func NewItemSecretScanningAlertsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemSecretScanningAlertsRequestBuilder
NewItemSecretScanningAlertsRequestBuilderInternal instantiates a new ItemSecretScanningAlertsRequestBuilder and sets the default values.
func (*ItemSecretScanningAlertsRequestBuilder) Get ¶
func (m *ItemSecretScanningAlertsRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemSecretScanningAlertsRequestBuilderGetQueryParameters]) ([]i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.OrganizationSecretScanningAlertable, error)
Get lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).The authenticated user must be a member of the enterprise in order to use this endpoint.OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. returns a []OrganizationSecretScanningAlertable when successful returns a BasicError error when the service returns a 404 status code returns a Alerts503Error error when the service returns a 503 status code API method documentation
func (*ItemSecretScanningAlertsRequestBuilder) ToGetRequestInformation ¶
func (m *ItemSecretScanningAlertsRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemSecretScanningAlertsRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).The authenticated user must be a member of the enterprise in order to use this endpoint.OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. returns a *RequestInformation when successful
func (*ItemSecretScanningAlertsRequestBuilder) WithUrl ¶
func (m *ItemSecretScanningAlertsRequestBuilder) WithUrl(rawUrl string) *ItemSecretScanningAlertsRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemSecretScanningAlertsRequestBuilder when successful
type ItemSecretScanningAlertsRequestBuilderGetQueryParameters ¶
type ItemSecretScanningAlertsRequestBuilderGetQueryParameters struct { // A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." After *string `uriparametername:"after"` // A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Before *string `uriparametername:"before"` // The direction to sort the results by. Direction *i001db24e943d0f84422b7e2ee3ebec420ca587ebd5e378cf50225876c7468a70.GetDirectionQueryParameterType `uriparametername:"direction"` // The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Per_page *int32 `uriparametername:"per_page"` // A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`. Resolution *string `uriparametername:"resolution"` // A comma-separated list of secret types to return. By default all secret types are returned.See "[Supported secret scanning patterns](https://docs.github.com/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)"for a complete list of secret types. Secret_type *string `uriparametername:"secret_type"` // The property to sort the results by. `created` means when the alert was created. `updated` means when the alert was updated or resolved. Sort *i001db24e943d0f84422b7e2ee3ebec420ca587ebd5e378cf50225876c7468a70.GetSortQueryParameterType `uriparametername:"sort"` // Set to `open` or `resolved` to only list secret scanning alerts in a specific state. State *i001db24e943d0f84422b7e2ee3ebec420ca587ebd5e378cf50225876c7468a70.GetStateQueryParameterType `uriparametername:"state"` // A comma-separated list of validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. Validity *string `uriparametername:"validity"` }
ItemSecretScanningAlertsRequestBuilderGetQueryParameters lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest.Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).The authenticated user must be a member of the enterprise in order to use this endpoint.OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint.
type ItemSecretScanningRequestBuilder ¶
type ItemSecretScanningRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemSecretScanningRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\secret-scanning
func NewItemSecretScanningRequestBuilder ¶
func NewItemSecretScanningRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemSecretScanningRequestBuilder
NewItemSecretScanningRequestBuilder instantiates a new ItemSecretScanningRequestBuilder and sets the default values.
func NewItemSecretScanningRequestBuilderInternal ¶
func NewItemSecretScanningRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemSecretScanningRequestBuilder
NewItemSecretScanningRequestBuilderInternal instantiates a new ItemSecretScanningRequestBuilder and sets the default values.
func (*ItemSecretScanningRequestBuilder) Alerts ¶
func (m *ItemSecretScanningRequestBuilder) Alerts() *ItemSecretScanningAlertsRequestBuilder
Alerts the alerts property returns a *ItemSecretScanningAlertsRequestBuilder when successful
type ItemTeamItemCopilotRequestBuilder ¶ added in v0.0.25
type ItemTeamItemCopilotRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemTeamItemCopilotRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\team\{team_slug}\copilot
func NewItemTeamItemCopilotRequestBuilder ¶ added in v0.0.25
func NewItemTeamItemCopilotRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemTeamItemCopilotRequestBuilder
NewItemTeamItemCopilotRequestBuilder instantiates a new ItemTeamItemCopilotRequestBuilder and sets the default values.
func NewItemTeamItemCopilotRequestBuilderInternal ¶ added in v0.0.25
func NewItemTeamItemCopilotRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemTeamItemCopilotRequestBuilder
NewItemTeamItemCopilotRequestBuilderInternal instantiates a new ItemTeamItemCopilotRequestBuilder and sets the default values.
func (*ItemTeamItemCopilotRequestBuilder) Usage ¶ added in v0.0.25
func (m *ItemTeamItemCopilotRequestBuilder) Usage() *ItemTeamItemCopilotUsageRequestBuilder
Usage the usage property returns a *ItemTeamItemCopilotUsageRequestBuilder when successful
type ItemTeamItemCopilotUsageRequestBuilder ¶ added in v0.0.25
type ItemTeamItemCopilotUsageRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemTeamItemCopilotUsageRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\team\{team_slug}\copilot\usage
func NewItemTeamItemCopilotUsageRequestBuilder ¶ added in v0.0.25
func NewItemTeamItemCopilotUsageRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemTeamItemCopilotUsageRequestBuilder
NewItemTeamItemCopilotUsageRequestBuilder instantiates a new ItemTeamItemCopilotUsageRequestBuilder and sets the default values.
func NewItemTeamItemCopilotUsageRequestBuilderInternal ¶ added in v0.0.25
func NewItemTeamItemCopilotUsageRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemTeamItemCopilotUsageRequestBuilder
NewItemTeamItemCopilotUsageRequestBuilderInternal instantiates a new ItemTeamItemCopilotUsageRequestBuilder and sets the default values.
func (*ItemTeamItemCopilotUsageRequestBuilder) Get ¶ added in v0.0.25
func (m *ItemTeamItemCopilotUsageRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemTeamItemCopilotUsageRequestBuilderGetQueryParameters]) ([]i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.CopilotUsageMetricsable, error)
Get > [!NOTE]> This endpoint is in beta and is subject to change.You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDEfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.See the response schema tab for detailed metrics definitions.The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,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.> [!NOTE]> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. returns a []CopilotUsageMetricsable when successful returns a BasicError error when the service returns a 401 status code returns a BasicError error when the service returns a 403 status code returns a BasicError error when the service returns a 404 status code returns a BasicError error when the service returns a 500 status code API method documentation
func (*ItemTeamItemCopilotUsageRequestBuilder) ToGetRequestInformation ¶ added in v0.0.25
func (m *ItemTeamItemCopilotUsageRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[ItemTeamItemCopilotUsageRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)
ToGetRequestInformation > [!NOTE]> This endpoint is in beta and is subject to change.You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDEfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.See the response schema tab for detailed metrics definitions.The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,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.> [!NOTE]> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. returns a *RequestInformation when successful
func (*ItemTeamItemCopilotUsageRequestBuilder) WithUrl ¶ added in v0.0.25
func (m *ItemTeamItemCopilotUsageRequestBuilder) WithUrl(rawUrl string) *ItemTeamItemCopilotUsageRequestBuilder
WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *ItemTeamItemCopilotUsageRequestBuilder when successful
type ItemTeamItemCopilotUsageRequestBuilderGetQueryParameters ¶ added in v0.0.25
type ItemTeamItemCopilotUsageRequestBuilderGetQueryParameters struct { // The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Page *int32 `uriparametername:"page"` // The number of days of metrics to display per page (max 28). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." Per_page *int32 `uriparametername:"per_page"` // Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago. Since *string `uriparametername:"since"` // Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed. Until *string `uriparametername:"until"` }
ItemTeamItemCopilotUsageRequestBuilderGetQueryParameters > [!NOTE]> This endpoint is in beta and is subject to change.You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDEfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.See the response schema tab for detailed metrics definitions.The response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,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.> [!NOTE]> This endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.
type ItemTeamRequestBuilder ¶ added in v0.0.25
type ItemTeamRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemTeamRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\team
func NewItemTeamRequestBuilder ¶ added in v0.0.25
func NewItemTeamRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemTeamRequestBuilder
NewItemTeamRequestBuilder instantiates a new ItemTeamRequestBuilder and sets the default values.
func NewItemTeamRequestBuilderInternal ¶ added in v0.0.25
func NewItemTeamRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemTeamRequestBuilder
NewItemTeamRequestBuilderInternal instantiates a new ItemTeamRequestBuilder and sets the default values.
func (*ItemTeamRequestBuilder) ByTeam_slug ¶ added in v0.0.25
func (m *ItemTeamRequestBuilder) ByTeam_slug(team_slug string) *ItemTeamWithTeam_slugItemRequestBuilder
ByTeam_slug gets an item from the github.com/octokit/go-sdk/pkg/github.enterprises.item.team.item collection returns a *ItemTeamWithTeam_slugItemRequestBuilder when successful
type ItemTeamWithTeam_slugItemRequestBuilder ¶ added in v0.0.25
type ItemTeamWithTeam_slugItemRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
ItemTeamWithTeam_slugItemRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\team\{team_slug}
func NewItemTeamWithTeam_slugItemRequestBuilder ¶ added in v0.0.25
func NewItemTeamWithTeam_slugItemRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemTeamWithTeam_slugItemRequestBuilder
NewItemTeamWithTeam_slugItemRequestBuilder instantiates a new ItemTeamWithTeam_slugItemRequestBuilder and sets the default values.
func NewItemTeamWithTeam_slugItemRequestBuilderInternal ¶ added in v0.0.25
func NewItemTeamWithTeam_slugItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ItemTeamWithTeam_slugItemRequestBuilder
NewItemTeamWithTeam_slugItemRequestBuilderInternal instantiates a new ItemTeamWithTeam_slugItemRequestBuilder and sets the default values.
func (*ItemTeamWithTeam_slugItemRequestBuilder) Copilot ¶ added in v0.0.25
func (m *ItemTeamWithTeam_slugItemRequestBuilder) Copilot() *ItemTeamItemCopilotRequestBuilder
Copilot the copilot property returns a *ItemTeamItemCopilotRequestBuilder when successful
type WithEnterpriseItemRequestBuilder ¶
type WithEnterpriseItemRequestBuilder struct {
i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}
WithEnterpriseItemRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}
func NewWithEnterpriseItemRequestBuilder ¶
func NewWithEnterpriseItemRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *WithEnterpriseItemRequestBuilder
NewWithEnterpriseItemRequestBuilder instantiates a new WithEnterpriseItemRequestBuilder and sets the default values.
func NewWithEnterpriseItemRequestBuilderInternal ¶
func NewWithEnterpriseItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *WithEnterpriseItemRequestBuilder
NewWithEnterpriseItemRequestBuilderInternal instantiates a new WithEnterpriseItemRequestBuilder and sets the default values.
func (*WithEnterpriseItemRequestBuilder) Copilot ¶ added in v0.0.12
func (m *WithEnterpriseItemRequestBuilder) Copilot() *ItemCopilotRequestBuilder
Copilot the copilot property returns a *ItemCopilotRequestBuilder when successful
func (*WithEnterpriseItemRequestBuilder) Dependabot ¶
func (m *WithEnterpriseItemRequestBuilder) Dependabot() *ItemDependabotRequestBuilder
Dependabot the dependabot property returns a *ItemDependabotRequestBuilder when successful
func (*WithEnterpriseItemRequestBuilder) SecretScanning ¶
func (m *WithEnterpriseItemRequestBuilder) SecretScanning() *ItemSecretScanningRequestBuilder
SecretScanning the secretScanning property returns a *ItemSecretScanningRequestBuilder when successful
func (*WithEnterpriseItemRequestBuilder) Team ¶ added in v0.0.25
func (m *WithEnterpriseItemRequestBuilder) Team() *ItemTeamRequestBuilder
Team the team property returns a *ItemTeamRequestBuilder when successful
Source Files
¶
- enterprises_request_builder.go
- item_copilot_billing_request_builder.go
- item_copilot_billing_seats_get_response.go
- item_copilot_billing_seats_request_builder.go
- item_copilot_request_builder.go
- item_copilot_usage_request_builder.go
- item_dependabot_alerts_request_builder.go
- item_dependabot_request_builder.go
- item_secret_scanning_alerts_request_builder.go
- item_secret_scanning_request_builder.go
- item_team_item_copilot_request_builder.go
- item_team_item_copilot_usage_request_builder.go
- item_team_request_builder.go
- item_team_with_team_escaped_slug_item_request_builder.go
- with_enterprise_item_request_builder.go