app

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Dec 12, 2023 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateHookConfigPatchRequestBodyFromDiscriminatorValue

CreateHookConfigPatchRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

func CreateHookDeliveriesItemAttemptsPostResponseFromDiscriminatorValue

CreateHookDeliveriesItemAttemptsPostResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

func CreateHookDeliveriesItemAttemptsResponseFromDiscriminatorValue

CreateHookDeliveriesItemAttemptsResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

func CreateInstallationsItemAccess_tokensPostRequestBodyFromDiscriminatorValue

CreateInstallationsItemAccess_tokensPostRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value

Types

type AppRequestBuilder

AppRequestBuilder builds and executes requests for operations under \app

func NewAppRequestBuilder

NewAppRequestBuilder instantiates a new AppRequestBuilder and sets the default values.

func NewAppRequestBuilderInternal

func NewAppRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *AppRequestBuilder

NewAppRequestBuilderInternal instantiates a new AppRequestBuilder and sets the default values.

func (*AppRequestBuilder) Get

Get returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. API method documentation

func (*AppRequestBuilder) Hook

Hook the hook property

func (*AppRequestBuilder) InstallationRequests

func (m *AppRequestBuilder) InstallationRequests() *InstallationRequestsRequestBuilder

InstallationRequests the installationRequests property

func (*AppRequestBuilder) Installations

func (m *AppRequestBuilder) Installations() *InstallationsRequestBuilder

Installations the installations property

func (*AppRequestBuilder) ToGetRequestInformation

ToGetRequestInformation returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations for the authenticated app](https://docs.github.com/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*AppRequestBuilder) WithUrl

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

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

type AppRequestBuilderGetRequestConfiguration

type AppRequestBuilderGetRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

AppRequestBuilderGetRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type HookConfigPatchRequestBody

type HookConfigPatchRequestBody struct {
	// contains filtered or unexported fields
}

HookConfigPatchRequestBody

func NewHookConfigPatchRequestBody

func NewHookConfigPatchRequestBody() *HookConfigPatchRequestBody

NewHookConfigPatchRequestBody instantiates a new HookConfigPatchRequestBody and sets the default values.

func (*HookConfigPatchRequestBody) GetAdditionalData

func (m *HookConfigPatchRequestBody) 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.

func (*HookConfigPatchRequestBody) GetContentType

func (m *HookConfigPatchRequestBody) GetContentType() *string

GetContentType gets the content_type property value. The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.

func (*HookConfigPatchRequestBody) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model

func (*HookConfigPatchRequestBody) GetInsecureSsl

GetInsecureSsl gets the insecure_ssl property value. The insecure_ssl property

func (*HookConfigPatchRequestBody) GetSecret

func (m *HookConfigPatchRequestBody) GetSecret() *string

GetSecret gets the secret property value. If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).

func (*HookConfigPatchRequestBody) GetUrl

func (m *HookConfigPatchRequestBody) GetUrl() *string

GetUrl gets the url property value. The URL to which the payloads will be delivered.

func (*HookConfigPatchRequestBody) Serialize

Serialize serializes information the current object

func (*HookConfigPatchRequestBody) SetAdditionalData

func (m *HookConfigPatchRequestBody) 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 (*HookConfigPatchRequestBody) SetContentType

func (m *HookConfigPatchRequestBody) SetContentType(value *string)

SetContentType sets the content_type property value. The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.

func (*HookConfigPatchRequestBody) SetInsecureSsl

SetInsecureSsl sets the insecure_ssl property value. The insecure_ssl property

func (*HookConfigPatchRequestBody) SetSecret

func (m *HookConfigPatchRequestBody) SetSecret(value *string)

SetSecret sets the secret property value. If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).

func (*HookConfigPatchRequestBody) SetUrl

func (m *HookConfigPatchRequestBody) SetUrl(value *string)

SetUrl sets the url property value. The URL to which the payloads will be delivered.

type HookConfigRequestBuilder

HookConfigRequestBuilder builds and executes requests for operations under \app\hook\config

func NewHookConfigRequestBuilder

NewHookConfigRequestBuilder instantiates a new ConfigRequestBuilder and sets the default values.

func NewHookConfigRequestBuilderInternal

func NewHookConfigRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *HookConfigRequestBuilder

NewHookConfigRequestBuilderInternal instantiates a new ConfigRequestBuilder and sets the default values.

func (*HookConfigRequestBuilder) Get

Get returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. API method documentation

func (*HookConfigRequestBuilder) Patch

Patch updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. API method documentation

func (*HookConfigRequestBuilder) ToGetRequestInformation

ToGetRequestInformation returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*HookConfigRequestBuilder) ToPatchRequestInformation

ToPatchRequestInformation updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*HookConfigRequestBuilder) WithUrl

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

type HookConfigRequestBuilderGetRequestConfiguration

type HookConfigRequestBuilderGetRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

HookConfigRequestBuilderGetRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type HookConfigRequestBuilderPatchRequestConfiguration

type HookConfigRequestBuilderPatchRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

HookConfigRequestBuilderPatchRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type HookDeliveriesItemAttemptsPostResponse

type HookDeliveriesItemAttemptsPostResponse struct {
	// contains filtered or unexported fields
}

HookDeliveriesItemAttemptsPostResponse

func NewHookDeliveriesItemAttemptsPostResponse

func NewHookDeliveriesItemAttemptsPostResponse() *HookDeliveriesItemAttemptsPostResponse

NewHookDeliveriesItemAttemptsPostResponse instantiates a new HookDeliveriesItemAttemptsPostResponse and sets the default values.

func (*HookDeliveriesItemAttemptsPostResponse) GetAdditionalData

func (m *HookDeliveriesItemAttemptsPostResponse) 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.

func (*HookDeliveriesItemAttemptsPostResponse) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model

func (*HookDeliveriesItemAttemptsPostResponse) Serialize

Serialize serializes information the current object

func (*HookDeliveriesItemAttemptsPostResponse) SetAdditionalData

func (m *HookDeliveriesItemAttemptsPostResponse) 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.

type HookDeliveriesItemAttemptsRequestBuilder

type HookDeliveriesItemAttemptsRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

HookDeliveriesItemAttemptsRequestBuilder builds and executes requests for operations under \app\hook\deliveries\{delivery_id}\attempts

func NewHookDeliveriesItemAttemptsRequestBuilder

NewHookDeliveriesItemAttemptsRequestBuilder instantiates a new AttemptsRequestBuilder and sets the default values.

func NewHookDeliveriesItemAttemptsRequestBuilderInternal

func NewHookDeliveriesItemAttemptsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *HookDeliveriesItemAttemptsRequestBuilder

NewHookDeliveriesItemAttemptsRequestBuilderInternal instantiates a new AttemptsRequestBuilder and sets the default values.

func (*HookDeliveriesItemAttemptsRequestBuilder) Post

Post redeliver a delivery for the webhook configured for a GitHub App.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. Deprecated: This method is obsolete. Use PostAsAttemptsPostResponse instead. API method documentation

func (*HookDeliveriesItemAttemptsRequestBuilder) PostAsAttemptsPostResponse

PostAsAttemptsPostResponse redeliver a delivery for the webhook configured for a GitHub App.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. API method documentation

func (*HookDeliveriesItemAttemptsRequestBuilder) ToPostRequestInformation

ToPostRequestInformation redeliver a delivery for the webhook configured for a GitHub App.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*HookDeliveriesItemAttemptsRequestBuilder) WithUrl

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

type HookDeliveriesItemAttemptsRequestBuilderPostRequestConfiguration

type HookDeliveriesItemAttemptsRequestBuilderPostRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

HookDeliveriesItemAttemptsRequestBuilderPostRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type HookDeliveriesItemAttemptsResponse

type HookDeliveriesItemAttemptsResponse struct {
	HookDeliveriesItemAttemptsPostResponse
}

HookDeliveriesItemAttemptsResponse Deprecated: This class is obsolete. Use attemptsPostResponse instead.

func NewHookDeliveriesItemAttemptsResponse

func NewHookDeliveriesItemAttemptsResponse() *HookDeliveriesItemAttemptsResponse

NewHookDeliveriesItemAttemptsResponse instantiates a new HookDeliveriesItemAttemptsResponse and sets the default values.

type HookDeliveriesItemAttemptsResponseable

HookDeliveriesItemAttemptsResponseable Deprecated: This class is obsolete. Use attemptsPostResponse instead.

type HookDeliveriesRequestBuilder

HookDeliveriesRequestBuilder builds and executes requests for operations under \app\hook\deliveries

func NewHookDeliveriesRequestBuilder

NewHookDeliveriesRequestBuilder instantiates a new DeliveriesRequestBuilder and sets the default values.

func NewHookDeliveriesRequestBuilderInternal

func NewHookDeliveriesRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *HookDeliveriesRequestBuilder

NewHookDeliveriesRequestBuilderInternal instantiates a new DeliveriesRequestBuilder and sets the default values.

func (*HookDeliveriesRequestBuilder) ByDelivery_id

ByDelivery_id gets an item from the github.com/octokit/go-sdk/pkg/github/.app.hook.deliveries.item collection Deprecated: This indexer is deprecated and will be removed in the next major version. Use the one with the typed parameter instead.

func (*HookDeliveriesRequestBuilder) ByDelivery_idInteger

ByDelivery_idInteger gets an item from the github.com/octokit/go-sdk/pkg/github/.app.hook.deliveries.item collection

func (*HookDeliveriesRequestBuilder) Get

Get returns a list of webhook deliveries for the webhook configured for a GitHub App.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. API method documentation

func (*HookDeliveriesRequestBuilder) ToGetRequestInformation

ToGetRequestInformation returns a list of webhook deliveries for the webhook configured for a GitHub App.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*HookDeliveriesRequestBuilder) WithUrl

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

type HookDeliveriesRequestBuilderGetQueryParameters

type HookDeliveriesRequestBuilderGetQueryParameters struct {
	// Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.
	Cursor *string `uriparametername:"cursor"`
	// The number of results per page (max 100).
	Per_page *int32 `uriparametername:"per_page"`
	//
	Redelivery *bool `uriparametername:"redelivery"`
}

HookDeliveriesRequestBuilderGetQueryParameters returns a list of webhook deliveries for the webhook configured for a GitHub App.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

type HookDeliveriesRequestBuilderGetRequestConfiguration

type HookDeliveriesRequestBuilderGetRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
	// Request query parameters
	QueryParameters *HookDeliveriesRequestBuilderGetQueryParameters
}

HookDeliveriesRequestBuilderGetRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type HookDeliveriesWithDelivery_ItemRequestBuilder

type HookDeliveriesWithDelivery_ItemRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

HookDeliveriesWithDelivery_ItemRequestBuilder builds and executes requests for operations under \app\hook\deliveries\{delivery_id}

func NewHookDeliveriesWithDelivery_ItemRequestBuilder

NewHookDeliveriesWithDelivery_ItemRequestBuilder instantiates a new WithDelivery_ItemRequestBuilder and sets the default values.

func NewHookDeliveriesWithDelivery_ItemRequestBuilderInternal

func NewHookDeliveriesWithDelivery_ItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *HookDeliveriesWithDelivery_ItemRequestBuilder

NewHookDeliveriesWithDelivery_ItemRequestBuilderInternal instantiates a new WithDelivery_ItemRequestBuilder and sets the default values.

func (*HookDeliveriesWithDelivery_ItemRequestBuilder) Attempts

Attempts the attempts property

func (*HookDeliveriesWithDelivery_ItemRequestBuilder) ToGetRequestInformation

ToGetRequestInformation returns a delivery for the webhook configured for a GitHub App.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*HookDeliveriesWithDelivery_ItemRequestBuilder) WithUrl

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

type HookDeliveriesWithDelivery_ItemRequestBuilderGetRequestConfiguration

type HookDeliveriesWithDelivery_ItemRequestBuilderGetRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

HookDeliveriesWithDelivery_ItemRequestBuilderGetRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type HookRequestBuilder

HookRequestBuilder builds and executes requests for operations under \app\hook

func NewHookRequestBuilder

NewHookRequestBuilder instantiates a new HookRequestBuilder and sets the default values.

func NewHookRequestBuilderInternal

func NewHookRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *HookRequestBuilder

NewHookRequestBuilderInternal instantiates a new HookRequestBuilder and sets the default values.

func (*HookRequestBuilder) Config

Config the config property

func (*HookRequestBuilder) Deliveries

Deliveries the deliveries property

type InstallationRequestsRequestBuilder

InstallationRequestsRequestBuilder builds and executes requests for operations under \app\installation-requests

func NewInstallationRequestsRequestBuilder

NewInstallationRequestsRequestBuilder instantiates a new InstallationRequestsRequestBuilder and sets the default values.

func NewInstallationRequestsRequestBuilderInternal

func NewInstallationRequestsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *InstallationRequestsRequestBuilder

NewInstallationRequestsRequestBuilderInternal instantiates a new InstallationRequestsRequestBuilder and sets the default values.

func (*InstallationRequestsRequestBuilder) Get

Get lists all the pending installation requests for the authenticated GitHub App. API method documentation

func (*InstallationRequestsRequestBuilder) ToGetRequestInformation

ToGetRequestInformation lists all the pending installation requests for the authenticated GitHub App.

func (*InstallationRequestsRequestBuilder) WithUrl

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

type InstallationRequestsRequestBuilderGetQueryParameters

type InstallationRequestsRequestBuilderGetQueryParameters struct {
	// Page number of the results to fetch.
	Page *int32 `uriparametername:"page"`
	// The number of results per page (max 100).
	Per_page *int32 `uriparametername:"per_page"`
}

InstallationRequestsRequestBuilderGetQueryParameters lists all the pending installation requests for the authenticated GitHub App.

type InstallationRequestsRequestBuilderGetRequestConfiguration

type InstallationRequestsRequestBuilderGetRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
	// Request query parameters
	QueryParameters *InstallationRequestsRequestBuilderGetQueryParameters
}

InstallationRequestsRequestBuilderGetRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type InstallationsItemAccess_tokensPostRequestBody

type InstallationsItemAccess_tokensPostRequestBody struct {
	// contains filtered or unexported fields
}

InstallationsItemAccess_tokensPostRequestBody

func NewInstallationsItemAccess_tokensPostRequestBody

func NewInstallationsItemAccess_tokensPostRequestBody() *InstallationsItemAccess_tokensPostRequestBody

NewInstallationsItemAccess_tokensPostRequestBody instantiates a new InstallationsItemAccess_tokensPostRequestBody and sets the default values.

func (*InstallationsItemAccess_tokensPostRequestBody) GetAdditionalData

func (m *InstallationsItemAccess_tokensPostRequestBody) 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.

func (*InstallationsItemAccess_tokensPostRequestBody) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model

func (*InstallationsItemAccess_tokensPostRequestBody) GetPermissions

GetPermissions gets the permissions property value. The permissions granted to the user access token.

func (*InstallationsItemAccess_tokensPostRequestBody) GetRepositories

GetRepositories gets the repositories property value. List of repository names that the token should have access to

func (*InstallationsItemAccess_tokensPostRequestBody) GetRepositoryIds

func (m *InstallationsItemAccess_tokensPostRequestBody) GetRepositoryIds() []int32

GetRepositoryIds gets the repository_ids property value. List of repository IDs that the token should have access to

func (*InstallationsItemAccess_tokensPostRequestBody) Serialize

Serialize serializes information the current object

func (*InstallationsItemAccess_tokensPostRequestBody) SetAdditionalData

func (m *InstallationsItemAccess_tokensPostRequestBody) 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 (*InstallationsItemAccess_tokensPostRequestBody) SetPermissions

SetPermissions sets the permissions property value. The permissions granted to the user access token.

func (*InstallationsItemAccess_tokensPostRequestBody) SetRepositories

func (m *InstallationsItemAccess_tokensPostRequestBody) SetRepositories(value []string)

SetRepositories sets the repositories property value. List of repository names that the token should have access to

func (*InstallationsItemAccess_tokensPostRequestBody) SetRepositoryIds

func (m *InstallationsItemAccess_tokensPostRequestBody) SetRepositoryIds(value []int32)

SetRepositoryIds sets the repository_ids property value. List of repository IDs that the token should have access to

type InstallationsItemAccess_tokensPostRequestBodyable

InstallationsItemAccess_tokensPostRequestBodyable

type InstallationsItemAccess_tokensRequestBuilder

type InstallationsItemAccess_tokensRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

InstallationsItemAccess_tokensRequestBuilder builds and executes requests for operations under \app\installations\{installation_id}\access_tokens

func NewInstallationsItemAccess_tokensRequestBuilder

NewInstallationsItemAccess_tokensRequestBuilder instantiates a new Access_tokensRequestBuilder and sets the default values.

func NewInstallationsItemAccess_tokensRequestBuilderInternal

func NewInstallationsItemAccess_tokensRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *InstallationsItemAccess_tokensRequestBuilder

NewInstallationsItemAccess_tokensRequestBuilderInternal instantiates a new Access_tokensRequestBuilder and sets the default values.

func (*InstallationsItemAccess_tokensRequestBuilder) Post

Post creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. API method documentation

func (*InstallationsItemAccess_tokensRequestBuilder) ToPostRequestInformation

ToPostRequestInformation creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*InstallationsItemAccess_tokensRequestBuilder) WithUrl

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

type InstallationsItemAccess_tokensRequestBuilderPostRequestConfiguration

type InstallationsItemAccess_tokensRequestBuilderPostRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

InstallationsItemAccess_tokensRequestBuilderPostRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type InstallationsItemSuspendedRequestBuilder

type InstallationsItemSuspendedRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

InstallationsItemSuspendedRequestBuilder builds and executes requests for operations under \app\installations\{installation_id}\suspended

func NewInstallationsItemSuspendedRequestBuilder

NewInstallationsItemSuspendedRequestBuilder instantiates a new SuspendedRequestBuilder and sets the default values.

func NewInstallationsItemSuspendedRequestBuilderInternal

func NewInstallationsItemSuspendedRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *InstallationsItemSuspendedRequestBuilder

NewInstallationsItemSuspendedRequestBuilderInternal instantiates a new SuspendedRequestBuilder and sets the default values.

func (*InstallationsItemSuspendedRequestBuilder) Delete

Delete removes a GitHub App installation suspension.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. API method documentation

func (*InstallationsItemSuspendedRequestBuilder) Put

Put suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. API method documentation

func (*InstallationsItemSuspendedRequestBuilder) ToDeleteRequestInformation

ToDeleteRequestInformation removes a GitHub App installation suspension.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*InstallationsItemSuspendedRequestBuilder) ToPutRequestInformation

ToPutRequestInformation suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub API or webhook events is blocked for that account.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*InstallationsItemSuspendedRequestBuilder) WithUrl

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

type InstallationsItemSuspendedRequestBuilderDeleteRequestConfiguration

type InstallationsItemSuspendedRequestBuilderDeleteRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

InstallationsItemSuspendedRequestBuilderDeleteRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type InstallationsItemSuspendedRequestBuilderPutRequestConfiguration

type InstallationsItemSuspendedRequestBuilderPutRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

InstallationsItemSuspendedRequestBuilderPutRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type InstallationsRequestBuilder

InstallationsRequestBuilder builds and executes requests for operations under \app\installations

func NewInstallationsRequestBuilder

NewInstallationsRequestBuilder instantiates a new InstallationsRequestBuilder and sets the default values.

func NewInstallationsRequestBuilderInternal

func NewInstallationsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *InstallationsRequestBuilder

NewInstallationsRequestBuilderInternal instantiates a new InstallationsRequestBuilder and sets the default values.

func (*InstallationsRequestBuilder) ByInstallation_id

ByInstallation_id gets an item from the github.com/octokit/go-sdk/pkg/github/.app.installations.item collection Deprecated: This indexer is deprecated and will be removed in the next major version. Use the one with the typed parameter instead.

func (*InstallationsRequestBuilder) ByInstallation_idInteger

func (m *InstallationsRequestBuilder) ByInstallation_idInteger(installation_id int32) *InstallationsWithInstallation_ItemRequestBuilder

ByInstallation_idInteger gets an item from the github.com/octokit/go-sdk/pkg/github/.app.installations.item collection

func (*InstallationsRequestBuilder) Get

Get you must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.The permissions the installation has are included under the `permissions` key. API method documentation

func (*InstallationsRequestBuilder) ToGetRequestInformation

ToGetRequestInformation you must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.The permissions the installation has are included under the `permissions` key.

func (*InstallationsRequestBuilder) WithUrl

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

type InstallationsRequestBuilderGetQueryParameters

type InstallationsRequestBuilderGetQueryParameters struct {
	//
	Outdated *string `uriparametername:"outdated"`
	// Page number of the results to fetch.
	Page *int32 `uriparametername:"page"`
	// The number of results per page (max 100).
	Per_page *int32 `uriparametername:"per_page"`
	// Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
	Since *i336074805fc853987abe6f7fe3ad97a6a6f3077a16391fec744f671a015fbd7e.Time `uriparametername:"since"`
}

InstallationsRequestBuilderGetQueryParameters you must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.The permissions the installation has are included under the `permissions` key.

type InstallationsRequestBuilderGetRequestConfiguration

type InstallationsRequestBuilderGetRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
	// Request query parameters
	QueryParameters *InstallationsRequestBuilderGetQueryParameters
}

InstallationsRequestBuilderGetRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type InstallationsWithInstallation_ItemRequestBuilder

type InstallationsWithInstallation_ItemRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

InstallationsWithInstallation_ItemRequestBuilder builds and executes requests for operations under \app\installations\{installation_id}

func NewInstallationsWithInstallation_ItemRequestBuilder

NewInstallationsWithInstallation_ItemRequestBuilder instantiates a new WithInstallation_ItemRequestBuilder and sets the default values.

func NewInstallationsWithInstallation_ItemRequestBuilderInternal

func NewInstallationsWithInstallation_ItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *InstallationsWithInstallation_ItemRequestBuilder

NewInstallationsWithInstallation_ItemRequestBuilderInternal instantiates a new WithInstallation_ItemRequestBuilder and sets the default values.

func (*InstallationsWithInstallation_ItemRequestBuilder) Access_tokens

Access_tokens the access_tokens property

func (*InstallationsWithInstallation_ItemRequestBuilder) Delete

Delete uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. API method documentation

func (*InstallationsWithInstallation_ItemRequestBuilder) Get

Get enables an authenticated GitHub App to find an installation's information using the installation id.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. API method documentation

func (*InstallationsWithInstallation_ItemRequestBuilder) Suspended

Suspended the suspended property

func (*InstallationsWithInstallation_ItemRequestBuilder) ToDeleteRequestInformation

ToDeleteRequestInformation uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the "[Suspend an app installation](https://docs.github.com/rest/apps/apps#suspend-an-app-installation)" endpoint.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*InstallationsWithInstallation_ItemRequestBuilder) ToGetRequestInformation

ToGetRequestInformation enables an authenticated GitHub App to find an installation's information using the installation id.You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.

func (*InstallationsWithInstallation_ItemRequestBuilder) WithUrl

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

type InstallationsWithInstallation_ItemRequestBuilderDeleteRequestConfiguration

type InstallationsWithInstallation_ItemRequestBuilderDeleteRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

InstallationsWithInstallation_ItemRequestBuilderDeleteRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

type InstallationsWithInstallation_ItemRequestBuilderGetRequestConfiguration

type InstallationsWithInstallation_ItemRequestBuilderGetRequestConfiguration struct {
	// Request headers
	Headers *i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestHeaders
	// Request options
	Options []i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestOption
}

InstallationsWithInstallation_ItemRequestBuilderGetRequestConfiguration configuration for the request such as headers, query parameters, and middleware options.

Jump to

Keyboard shortcuts

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