notifications

package
v0.0.6-GHES.3.11 Latest Latest
Warning

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

Go to latest
Published: Sep 20, 2024 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateNotificationsPutRequestBodyFromDiscriminatorValue

CreateNotificationsPutRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateNotificationsPutResponseFromDiscriminatorValue

CreateNotificationsPutResponseFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

func CreateThreadsItemSubscriptionPutRequestBodyFromDiscriminatorValue

CreateThreadsItemSubscriptionPutRequestBodyFromDiscriminatorValue creates a new instance of the appropriate class based on discriminator value returns a Parsable when successful

Types

type NotificationsPutRequestBody

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

func NewNotificationsPutRequestBody

func NewNotificationsPutRequestBody() *NotificationsPutRequestBody

NewNotificationsPutRequestBody instantiates a new NotificationsPutRequestBody and sets the default values.

func (*NotificationsPutRequestBody) GetAdditionalData

func (m *NotificationsPutRequestBody) 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 (*NotificationsPutRequestBody) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*NotificationsPutRequestBody) GetLastReadAt

GetLastReadAt gets the last_read_at property value. Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. returns a *Time when successful

func (*NotificationsPutRequestBody) GetRead

func (m *NotificationsPutRequestBody) GetRead() *bool

GetRead gets the read property value. Whether the notification has been read. returns a *bool when successful

func (*NotificationsPutRequestBody) Serialize

Serialize serializes information the current object

func (*NotificationsPutRequestBody) SetAdditionalData

func (m *NotificationsPutRequestBody) 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 (*NotificationsPutRequestBody) SetLastReadAt

SetLastReadAt sets the last_read_at property value. Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.

func (*NotificationsPutRequestBody) SetRead

func (m *NotificationsPutRequestBody) SetRead(value *bool)

SetRead sets the read property value. Whether the notification has been read.

type NotificationsPutResponse

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

func NewNotificationsPutResponse

func NewNotificationsPutResponse() *NotificationsPutResponse

NewNotificationsPutResponse instantiates a new NotificationsPutResponse and sets the default values.

func (*NotificationsPutResponse) GetAdditionalData

func (m *NotificationsPutResponse) 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 (*NotificationsPutResponse) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*NotificationsPutResponse) GetMessage

func (m *NotificationsPutResponse) GetMessage() *string

GetMessage gets the message property value. The message property returns a *string when successful

func (*NotificationsPutResponse) Serialize

Serialize serializes information the current object

func (*NotificationsPutResponse) SetAdditionalData

func (m *NotificationsPutResponse) 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 (*NotificationsPutResponse) SetMessage

func (m *NotificationsPutResponse) SetMessage(value *string)

SetMessage sets the message property value. The message property

type NotificationsRequestBuilder

NotificationsRequestBuilder builds and executes requests for operations under \notifications

func NewNotificationsRequestBuilder

NewNotificationsRequestBuilder instantiates a new NotificationsRequestBuilder and sets the default values.

func NewNotificationsRequestBuilderInternal

func NewNotificationsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *NotificationsRequestBuilder

NewNotificationsRequestBuilderInternal instantiates a new NotificationsRequestBuilder and sets the default values.

func (*NotificationsRequestBuilder) Get

Get list all notifications for the current user, sorted by most recently updated. returns a []Threadable 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 ValidationError error when the service returns a 422 status code API method documentation

func (*NotificationsRequestBuilder) Put

Put marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. returns a NotificationsPutResponseable 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 API method documentation

func (*NotificationsRequestBuilder) Threads

Threads the threads property returns a *ThreadsRequestBuilder when successful

func (*NotificationsRequestBuilder) ToGetRequestInformation

ToGetRequestInformation list all notifications for the current user, sorted by most recently updated. returns a *RequestInformation when successful

func (*NotificationsRequestBuilder) ToPutRequestInformation

ToPutRequestInformation marks all notifications as "read" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as "read." To check whether any "unread" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`. returns a *RequestInformation when successful

func (*NotificationsRequestBuilder) 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 *NotificationsRequestBuilder when successful

type NotificationsRequestBuilderGetQueryParameters

type NotificationsRequestBuilderGetQueryParameters struct {
	// If `true`, show notifications marked as read.
	All *bool `uriparametername:"all"`
	// Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.
	Before *i336074805fc853987abe6f7fe3ad97a6a6f3077a16391fec744f671a015fbd7e.Time `uriparametername:"before"`
	// The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	Page *int32 `uriparametername:"page"`
	// If `true`, only shows notifications in which the user is directly participating or mentioned.
	Participating *bool `uriparametername:"participating"`
	// The number of results per page (max 50). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.11/rest/using-the-rest-api/using-pagination-in-the-rest-api)."
	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"`
}

NotificationsRequestBuilderGetQueryParameters list all notifications for the current user, sorted by most recently updated.

type ThreadsItemSubscriptionPutRequestBody

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

func NewThreadsItemSubscriptionPutRequestBody

func NewThreadsItemSubscriptionPutRequestBody() *ThreadsItemSubscriptionPutRequestBody

NewThreadsItemSubscriptionPutRequestBody instantiates a new ThreadsItemSubscriptionPutRequestBody and sets the default values.

func (*ThreadsItemSubscriptionPutRequestBody) GetAdditionalData

func (m *ThreadsItemSubscriptionPutRequestBody) 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 (*ThreadsItemSubscriptionPutRequestBody) GetFieldDeserializers

GetFieldDeserializers the deserialization information for the current model returns a map[string]func(i878a80d2330e89d26896388a3f487eef27b0a0e6c010c493bf80be1452208f91.ParseNode)(error) when successful

func (*ThreadsItemSubscriptionPutRequestBody) GetIgnored

GetIgnored gets the ignored property value. Whether to block all notifications from a thread. returns a *bool when successful

func (*ThreadsItemSubscriptionPutRequestBody) Serialize

Serialize serializes information the current object

func (*ThreadsItemSubscriptionPutRequestBody) SetAdditionalData

func (m *ThreadsItemSubscriptionPutRequestBody) 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 (*ThreadsItemSubscriptionPutRequestBody) SetIgnored

func (m *ThreadsItemSubscriptionPutRequestBody) SetIgnored(value *bool)

SetIgnored sets the ignored property value. Whether to block all notifications from a thread.

type ThreadsItemSubscriptionRequestBuilder

type ThreadsItemSubscriptionRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

ThreadsItemSubscriptionRequestBuilder builds and executes requests for operations under \notifications\threads\{thread_id}\subscription

func NewThreadsItemSubscriptionRequestBuilder

NewThreadsItemSubscriptionRequestBuilder instantiates a new ThreadsItemSubscriptionRequestBuilder and sets the default values.

func NewThreadsItemSubscriptionRequestBuilderInternal

func NewThreadsItemSubscriptionRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ThreadsItemSubscriptionRequestBuilder

NewThreadsItemSubscriptionRequestBuilderInternal instantiates a new ThreadsItemSubscriptionRequestBuilder and sets the default values.

func (*ThreadsItemSubscriptionRequestBuilder) Delete

Delete mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. returns a BasicError error when the service returns a 401 status code returns a BasicError error when the service returns a 403 status code API method documentation

func (*ThreadsItemSubscriptionRequestBuilder) Get

Get this checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#get-a-repository-subscription).Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. returns a ThreadSubscriptionable 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 API method documentation

func (*ThreadsItemSubscriptionRequestBuilder) Put

Put if you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#delete-a-thread-subscription) endpoint. returns a ThreadSubscriptionable 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 API method documentation

func (*ThreadsItemSubscriptionRequestBuilder) ToDeleteRequestInformation

ToDeleteRequestInformation mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#set-a-thread-subscription) endpoint and set `ignore` to `true`. returns a *RequestInformation when successful

func (*ThreadsItemSubscriptionRequestBuilder) ToGetRequestInformation

ToGetRequestInformation this checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/watching#get-a-repository-subscription).Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread. returns a *RequestInformation when successful

func (*ThreadsItemSubscriptionRequestBuilder) ToPutRequestInformation

ToPutRequestInformation if you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.11/rest/activity/notifications#delete-a-thread-subscription) endpoint. returns a *RequestInformation when successful

func (*ThreadsItemSubscriptionRequestBuilder) 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 *ThreadsItemSubscriptionRequestBuilder when successful

type ThreadsRequestBuilder

ThreadsRequestBuilder builds and executes requests for operations under \notifications\threads

func NewThreadsRequestBuilder

NewThreadsRequestBuilder instantiates a new ThreadsRequestBuilder and sets the default values.

func NewThreadsRequestBuilderInternal

func NewThreadsRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ThreadsRequestBuilder

NewThreadsRequestBuilderInternal instantiates a new ThreadsRequestBuilder and sets the default values.

func (*ThreadsRequestBuilder) ByThread_id

ByThread_id gets an item from the github.com/octokit/go-sdk-enterprise-server/pkg/github.notifications.threads.item collection returns a *ThreadsWithThread_ItemRequestBuilder when successful

type ThreadsWithThread_ItemRequestBuilder

type ThreadsWithThread_ItemRequestBuilder struct {
	i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.BaseRequestBuilder
}

ThreadsWithThread_ItemRequestBuilder builds and executes requests for operations under \notifications\threads\{thread_id}

func NewThreadsWithThread_ItemRequestBuilder

NewThreadsWithThread_ItemRequestBuilder instantiates a new ThreadsWithThread_ItemRequestBuilder and sets the default values.

func NewThreadsWithThread_ItemRequestBuilderInternal

func NewThreadsWithThread_ItemRequestBuilderInternal(pathParameters map[string]string, requestAdapter i2ae4187f7daee263371cb1c977df639813ab50ffa529013b7437480d1ec0158f.RequestAdapter) *ThreadsWithThread_ItemRequestBuilder

NewThreadsWithThread_ItemRequestBuilderInternal instantiates a new ThreadsWithThread_ItemRequestBuilder and sets the default values.

func (*ThreadsWithThread_ItemRequestBuilder) Get

Get gets information about a notification thread. returns a Threadable 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 API method documentation

func (*ThreadsWithThread_ItemRequestBuilder) Patch

Patch marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. returns a BasicError error when the service returns a 403 status code API method documentation

func (*ThreadsWithThread_ItemRequestBuilder) Subscription

Subscription the subscription property returns a *ThreadsItemSubscriptionRequestBuilder when successful

func (*ThreadsWithThread_ItemRequestBuilder) ToGetRequestInformation

ToGetRequestInformation gets information about a notification thread. returns a *RequestInformation when successful

func (*ThreadsWithThread_ItemRequestBuilder) ToPatchRequestInformation

ToPatchRequestInformation marks a thread as "read." Marking a thread as "read" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications. returns a *RequestInformation when successful

func (*ThreadsWithThread_ItemRequestBuilder) 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 *ThreadsWithThread_ItemRequestBuilder when successful

Jump to

Keyboard shortcuts

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