clientapi_forgejo.NotificationApi

All URIs are relative to /api/v1

Method	HTTP request	Description
notify_get_list	GET /notifications	List users's notification threads
notify_get_repo_list	GET /repos/{owner}/{repo}/notifications	List users's notification threads on a specific repo
notify_get_thread	GET /notifications/threads/{id}	Get notification thread by ID
notify_new_available	GET /notifications/new	Check if unread notifications exist
notify_read_list	PUT /notifications	Mark notification threads as read, pinned or unread
notify_read_repo_list	PUT /repos/{owner}/{repo}/notifications	Mark notification threads as read, pinned or unread on a specific repo
notify_read_thread	PATCH /notifications/threads/{id}	Mark notification thread as read by ID

notify_get_list

List[NotificationThread] notify_get_list(all=all, status_types=status_types, subject_type=subject_type, since=since, before=before, page=page, limit=limit)

List users's notification threads

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.models.notification_thread import NotificationThread
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.NotificationApi(api_client)
    all = True # bool | If true, show notifications marked as read. Default value is false (optional)
    status_types = ['status_types_example'] # List[str] | Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. (optional)
    subject_type = ['subject_type_example'] # List[str] | filter notifications by subject type (optional)
    since = '2013-10-20T19:20:30+01:00' # datetime | Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
    before = '2013-10-20T19:20:30+01:00' # datetime | Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
    page = 56 # int | page number of results to return (1-based) (optional)
    limit = 56 # int | page size of results (optional)

    try:
        # List users's notification threads
        api_response = api_instance.notify_get_list(all=all, status_types=status_types, subject_type=subject_type, since=since, before=before, page=page, limit=limit)
        print("The response of NotificationApi->notify_get_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationApi->notify_get_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
all	bool	If true, show notifications marked as read. Default value is false	[optional]
status_types	List[str]	Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned.	[optional]
subject_type	List[str]	filter notifications by subject type	[optional]
since	datetime	Only show notifications updated after the given time. This is a timestamp in RFC 3339 format	[optional]
before	datetime	Only show notifications updated before the given time. This is a timestamp in RFC 3339 format	[optional]
page	int	page number of results to return (1-based)	[optional]
limit	int	page size of results	[optional]

Return type

List[NotificationThread]

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	NotificationThreadList	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notify_get_repo_list

List[NotificationThread] notify_get_repo_list(owner, repo, all=all, status_types=status_types, subject_type=subject_type, since=since, before=before, page=page, limit=limit)

List users's notification threads on a specific repo

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.models.notification_thread import NotificationThread
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.NotificationApi(api_client)
    owner = 'owner_example' # str | owner of the repo
    repo = 'repo_example' # str | name of the repo
    all = True # bool | If true, show notifications marked as read. Default value is false (optional)
    status_types = ['status_types_example'] # List[str] | Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned (optional)
    subject_type = ['subject_type_example'] # List[str] | filter notifications by subject type (optional)
    since = '2013-10-20T19:20:30+01:00' # datetime | Only show notifications updated after the given time. This is a timestamp in RFC 3339 format (optional)
    before = '2013-10-20T19:20:30+01:00' # datetime | Only show notifications updated before the given time. This is a timestamp in RFC 3339 format (optional)
    page = 56 # int | page number of results to return (1-based) (optional)
    limit = 56 # int | page size of results (optional)

    try:
        # List users's notification threads on a specific repo
        api_response = api_instance.notify_get_repo_list(owner, repo, all=all, status_types=status_types, subject_type=subject_type, since=since, before=before, page=page, limit=limit)
        print("The response of NotificationApi->notify_get_repo_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationApi->notify_get_repo_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str	owner of the repo
repo	str	name of the repo
all	bool	If true, show notifications marked as read. Default value is false	[optional]
status_types	List[str]	Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned	[optional]
subject_type	List[str]	filter notifications by subject type	[optional]
since	datetime	Only show notifications updated after the given time. This is a timestamp in RFC 3339 format	[optional]
before	datetime	Only show notifications updated before the given time. This is a timestamp in RFC 3339 format	[optional]
page	int	page number of results to return (1-based)	[optional]
limit	int	page size of results	[optional]

Return type

List[NotificationThread]

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	NotificationThreadList	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notify_get_thread

NotificationThread notify_get_thread(id)

Get notification thread by ID

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.models.notification_thread import NotificationThread
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.NotificationApi(api_client)
    id = 'id_example' # str | id of notification thread

    try:
        # Get notification thread by ID
        api_response = api_instance.notify_get_thread(id)
        print("The response of NotificationApi->notify_get_thread:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationApi->notify_get_thread: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	id of notification thread

Return type

NotificationThread

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	NotificationThread	-
403	APIForbiddenError is a forbidden error response	-
404	APINotFound is a not found error response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notify_new_available

NotificationCount notify_new_available()

Check if unread notifications exist

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.models.notification_count import NotificationCount
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.NotificationApi(api_client)

    try:
        # Check if unread notifications exist
        api_response = api_instance.notify_new_available()
        print("The response of NotificationApi->notify_new_available:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationApi->notify_new_available: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

NotificationCount

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json, text/html

HTTP response details

Status code	Description	Response headers
200	Number of unread notifications	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notify_read_list

List[NotificationThread] notify_read_list(last_read_at=last_read_at, all=all, status_types=status_types, to_status=to_status)

Mark notification threads as read, pinned or unread

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.models.notification_thread import NotificationThread
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.NotificationApi(api_client)
    last_read_at = '2013-10-20T19:20:30+01:00' # datetime | Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)
    all = 'all_example' # str | If true, mark all notifications on this repo. Default value is false (optional)
    status_types = ['status_types_example'] # List[str] | Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
    to_status = 'to_status_example' # str | Status to mark notifications as, Defaults to read. (optional)

    try:
        # Mark notification threads as read, pinned or unread
        api_response = api_instance.notify_read_list(last_read_at=last_read_at, all=all, status_types=status_types, to_status=to_status)
        print("The response of NotificationApi->notify_read_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationApi->notify_read_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
last_read_at	datetime	Describes the last point that notifications were checked. Anything updated since this time will not be updated.	[optional]
all	str	If true, mark all notifications on this repo. Default value is false	[optional]
status_types	List[str]	Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.	[optional]
to_status	str	Status to mark notifications as, Defaults to read.	[optional]

Return type

List[NotificationThread]

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
205	NotificationThreadList	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notify_read_repo_list

List[NotificationThread] notify_read_repo_list(owner, repo, all=all, status_types=status_types, to_status=to_status, last_read_at=last_read_at)

Mark notification threads as read, pinned or unread on a specific repo

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.models.notification_thread import NotificationThread
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.NotificationApi(api_client)
    owner = 'owner_example' # str | owner of the repo
    repo = 'repo_example' # str | name of the repo
    all = 'all_example' # str | If true, mark all notifications on this repo. Default value is false (optional)
    status_types = ['status_types_example'] # List[str] | Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. (optional)
    to_status = 'to_status_example' # str | Status to mark notifications as. Defaults to read. (optional)
    last_read_at = '2013-10-20T19:20:30+01:00' # datetime | Describes the last point that notifications were checked. Anything updated since this time will not be updated. (optional)

    try:
        # Mark notification threads as read, pinned or unread on a specific repo
        api_response = api_instance.notify_read_repo_list(owner, repo, all=all, status_types=status_types, to_status=to_status, last_read_at=last_read_at)
        print("The response of NotificationApi->notify_read_repo_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationApi->notify_read_repo_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
owner	str	owner of the repo
repo	str	name of the repo
all	str	If true, mark all notifications on this repo. Default value is false	[optional]
status_types	List[str]	Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.	[optional]
to_status	str	Status to mark notifications as. Defaults to read.	[optional]
last_read_at	datetime	Describes the last point that notifications were checked. Anything updated since this time will not be updated.	[optional]

Return type

List[NotificationThread]

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
205	NotificationThreadList	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notify_read_thread

NotificationThread notify_read_thread(id, to_status=to_status)

Mark notification thread as read by ID

Example

Api Key Authentication (TOTPHeader):
Api Key Authentication (AuthorizationHeaderToken):
Api Key Authentication (SudoHeader):
Basic Authentication (BasicAuth):
Api Key Authentication (AccessToken):
Api Key Authentication (SudoParam):
Api Key Authentication (Token):

import clientapi_forgejo
from clientapi_forgejo.models.notification_thread import NotificationThread
from clientapi_forgejo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clientapi_forgejo.Configuration(
    host = "/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: TOTPHeader
configuration.api_key['TOTPHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TOTPHeader'] = 'Bearer'

# Configure API key authorization: AuthorizationHeaderToken
configuration.api_key['AuthorizationHeaderToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AuthorizationHeaderToken'] = 'Bearer'

# Configure API key authorization: SudoHeader
configuration.api_key['SudoHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoHeader'] = 'Bearer'

# Configure HTTP basic authorization: BasicAuth
configuration = clientapi_forgejo.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: AccessToken
configuration.api_key['AccessToken'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['AccessToken'] = 'Bearer'

# Configure API key authorization: SudoParam
configuration.api_key['SudoParam'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['SudoParam'] = 'Bearer'

# Configure API key authorization: Token
configuration.api_key['Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Token'] = 'Bearer'

# Enter a context with an instance of the API client
with clientapi_forgejo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clientapi_forgejo.NotificationApi(api_client)
    id = 'id_example' # str | id of notification thread
    to_status = 'read' # str | Status to mark notifications as (optional) (default to 'read')

    try:
        # Mark notification thread as read by ID
        api_response = api_instance.notify_read_thread(id, to_status=to_status)
        print("The response of NotificationApi->notify_read_thread:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationApi->notify_read_thread: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	id of notification thread
to_status	str	Status to mark notifications as	[optional] [default to 'read']

Return type

NotificationThread

Authorization

TOTPHeader, AuthorizationHeaderToken, SudoHeader, BasicAuth, AccessToken, SudoParam, Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
205	NotificationThread	-
403	APIForbiddenError is a forbidden error response	-
404	APINotFound is a not found error response	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

NotificationApi.md

Latest commit

History

NotificationApi.md

File metadata and controls

clientapi_forgejo.NotificationApi

notify_get_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notify_get_repo_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notify_get_thread

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notify_new_available

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notify_read_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notify_read_repo_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

notify_read_thread

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details