enterprises

package
v0.0.15 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 3, 2024 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EnterprisesRequestBuilder

EnterprisesRequestBuilder builds and executes requests for operations under \enterprises

func NewEnterprisesRequestBuilder

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

ByEnterprise gets an item from the github.com/octokit/go-sdk/pkg/github/.enterprises.item collection returns a *WithEnterpriseItemRequestBuilder when successful

type ItemCopilotRequestBuilder added in v0.0.12

ItemCopilotRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\copilot

func NewItemCopilotRequestBuilder added in v0.0.12

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) Usage added in v0.0.12

Usage the usage property returns a *ItemCopilotUsageRequestBuilder when successful

type ItemCopilotUsageRequestBuilder added in v0.0.12

ItemCopilotUsageRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\copilot\usage

func NewItemCopilotUsageRequestBuilder added in v0.0.12

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

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 the prior 28 days. 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 the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usagemetrics for the enterprise.OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope 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

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 the prior 28 days. 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 the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usagemetrics for the enterprise.OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. returns a *RequestInformation when successful

func (*ItemCopilotUsageRequestBuilder) WithUrl added in v0.0.12

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 the prior 28 days. 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 the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usagemetrics for the enterprise.OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint.

type ItemDependabotAlertsRequestBuilder

ItemDependabotAlertsRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\dependabot\alerts

func NewItemDependabotAlertsRequestBuilder

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

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

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

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

ItemDependabotRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\dependabot

func NewItemDependabotRequestBuilder

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

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

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

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

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

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 "[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)"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

ItemSecretScanningRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}\secret-scanning

func NewItemSecretScanningRequestBuilder

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

Alerts the alerts property returns a *ItemSecretScanningAlertsRequestBuilder when successful

type WithEnterpriseItemRequestBuilder

WithEnterpriseItemRequestBuilder builds and executes requests for operations under \enterprises\{enterprise}

func NewWithEnterpriseItemRequestBuilder

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

Copilot the copilot property returns a *ItemCopilotRequestBuilder when successful

func (*WithEnterpriseItemRequestBuilder) Dependabot

Dependabot the dependabot property returns a *ItemDependabotRequestBuilder when successful

func (*WithEnterpriseItemRequestBuilder) SecretScanning

SecretScanning the secretScanning property returns a *ItemSecretScanningRequestBuilder when successful

Directories

Path Synopsis
item

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL