licenses

Documentation

Index

• type LicensesRequestBuilder
  • func NewLicensesRequestBuilder(rawUrl string, ...) *LicensesRequestBuilder
  • func NewLicensesRequestBuilderInternal(pathParameters map[string]string, ...) *LicensesRequestBuilder
  • func (m *LicensesRequestBuilder) ByLicense(license string) *WithLicenseItemRequestBuilder
  • func (m *LicensesRequestBuilder) Get(ctx context.Context, ...) (...)
  • func (m *LicensesRequestBuilder) ToGetRequestInformation(ctx context.Context, ...) (...)
  • func (m *LicensesRequestBuilder) WithUrl(rawUrl string) *LicensesRequestBuilder
• type LicensesRequestBuilderGetQueryParameters
• type WithLicenseItemRequestBuilder
  • func NewWithLicenseItemRequestBuilder(rawUrl string, ...) *WithLicenseItemRequestBuilder
  • func NewWithLicenseItemRequestBuilderInternal(pathParameters map[string]string, ...) *WithLicenseItemRequestBuilder
  • func (m *WithLicenseItemRequestBuilder) Get(ctx context.Context, ...) (i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.Licenseable, ...)
  • func (m *WithLicenseItemRequestBuilder) ToGetRequestInformation(ctx context.Context, ...) (...)
  • func (m *WithLicenseItemRequestBuilder) WithUrl(rawUrl string) *WithLicenseItemRequestBuilder

Types

type LicensesRequestBuilder

type LicensesRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

LicensesRequestBuilder builds and executes requests for operations under \licenses

func NewLicensesRequestBuilder

func NewLicensesRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *LicensesRequestBuilder

NewLicensesRequestBuilder instantiates a new LicensesRequestBuilder and sets the default values.

func NewLicensesRequestBuilderInternal

func NewLicensesRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *LicensesRequestBuilder

NewLicensesRequestBuilderInternal instantiates a new LicensesRequestBuilder and sets the default values.

func (*LicensesRequestBuilder) ByLicense

func (m *LicensesRequestBuilder) ByLicense(license string) *WithLicenseItemRequestBuilder

ByLicense gets an item from the github.com/octokit/go-sdk/pkg/github.licenses.item collection returns a *WithLicenseItemRequestBuilder when successful

func (*LicensesRequestBuilder) Get

func (m *LicensesRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[LicensesRequestBuilderGetQueryParameters]) ([]i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.LicenseSimpleable, error)

Get lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." returns a []LicenseSimpleable when successful API method documentation

func (*LicensesRequestBuilder) ToGetRequestInformation

func (m *LicensesRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[LicensesRequestBuilderGetQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToGetRequestInformation lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." returns a *RequestInformation when successful

func (*LicensesRequestBuilder) WithUrl

func (m *LicensesRequestBuilder) WithUrl(rawUrl string) *LicensesRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *LicensesRequestBuilder when successful

type LicensesRequestBuilderGetQueryParameters

type LicensesRequestBuilderGetQueryParameters struct {
	Featured *bool `uriparametername:"featured"`
	// 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"`
}

LicensesRequestBuilderGetQueryParameters lists the most commonly used licenses on GitHub. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."

type WithLicenseItemRequestBuilder

type WithLicenseItemRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

WithLicenseItemRequestBuilder builds and executes requests for operations under \licenses\{license}

func NewWithLicenseItemRequestBuilder

func NewWithLicenseItemRequestBuilder(rawUrl string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *WithLicenseItemRequestBuilder

NewWithLicenseItemRequestBuilder instantiates a new WithLicenseItemRequestBuilder and sets the default values.

func NewWithLicenseItemRequestBuilderInternal

func NewWithLicenseItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *WithLicenseItemRequestBuilder

NewWithLicenseItemRequestBuilderInternal instantiates a new WithLicenseItemRequestBuilder and sets the default values.

func (*WithLicenseItemRequestBuilder) Get

func (m *WithLicenseItemRequestBuilder) Get(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (i59ea7d99994c6a4bb9ef742ed717844297d055c7fd3742131406eea67a6404b6.Licenseable, error)

Get gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." returns a Licenseable 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 API method documentation

func (*WithLicenseItemRequestBuilder) ToGetRequestInformation

func (m *WithLicenseItemRequestBuilder) ToGetRequestInformation(ctx context.Context, requestConfiguration *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestConfiguration[i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.DefaultQueryParameters]) (*i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestInformation, error)

ToGetRequestInformation gets information about a specific license. For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." returns a *RequestInformation when successful

func (*WithLicenseItemRequestBuilder) WithUrl

func (m *WithLicenseItemRequestBuilder) WithUrl(rawUrl string) *WithLicenseItemRequestBuilder

WithUrl returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored. returns a *WithLicenseItemRequestBuilder when successful