/** * Gitea API. * This documentation describes the Gitea API. * * OpenAPI spec version: 1.15.0+dev-49-gaee5ef005 * * * NOTE: This class is auto generated by the swagger code generator program. * https://github.com/swagger-api/swagger-codegen.git * Do not edit the class manually. */ import { AxiosPromise, AxiosInstance } from 'axios'; import { Configuration } from '../configuration'; import { RequestArgs, BaseAPI } from '../base'; import { NotificationCount } from '../models'; import { NotificationThread } from '../models'; /** * NotificationApi - axios parameter creator * @export */ export declare const NotificationApiAxiosParamCreator: (configuration?: Configuration) => { /** * * @summary List users's notification threads * @param {string} [all] If true, show notifications marked as read. Default value is false * @param {Array<string>} [status_types] Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. * @param {Date} [since] Only show notifications updated after the given time. This is a timestamp in RFC 3339 format * @param {Date} [before] Only show notifications updated before the given time. This is a timestamp in RFC 3339 format * @param {number} [page] page number of results to return (1-based) * @param {number} [limit] page size of results * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyGetList: (all?: string, status_types?: Array, since?: Date, before?: Date, page?: number, limit?: number, options?: any) => Promise; /** * * @summary List users's notification threads on a specific repo * @param {string} owner owner of the repo * @param {string} repo name of the repo * @param {string} [all] If true, show notifications marked as read. Default value is false * @param {Array<string>} [status_types] Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned * @param {Date} [since] Only show notifications updated after the given time. This is a timestamp in RFC 3339 format * @param {Date} [before] Only show notifications updated before the given time. This is a timestamp in RFC 3339 format * @param {number} [page] page number of results to return (1-based) * @param {number} [limit] page size of results * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyGetRepoList: (owner: string, repo: string, all?: string, status_types?: Array, since?: Date, before?: Date, page?: number, limit?: number, options?: any) => Promise; /** * * @summary Get notification thread by ID * @param {string} id id of notification thread * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyGetThread: (id: string, options?: any) => Promise; /** * * @summary Check if unread notifications exist * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyNewAvailable: (options?: any) => Promise; /** * * @summary Mark notification threads as read, pinned or unread * @param {Date} [last_read_at] Describes the last point that notifications were checked. Anything updated since this time will not be updated. * @param {string} [all] If true, mark all notifications on this repo. Default value is false * @param {Array<string>} [status_types] Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. * @param {string} [to_status] Status to mark notifications as, Defaults to read. * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyReadList: (last_read_at?: Date, all?: string, status_types?: Array, to_status?: string, options?: any) => Promise; /** * * @summary Mark notification threads as read, pinned or unread on a specific repo * @param {string} owner owner of the repo * @param {string} repo name of the repo * @param {string} [all] If true, mark all notifications on this repo. Default value is false * @param {Array<string>} [status_types] Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. * @param {string} [to_status] Status to mark notifications as. Defaults to read. * @param {Date} [last_read_at] Describes the last point that notifications were checked. Anything updated since this time will not be updated. * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyReadRepoList: (owner: string, repo: string, all?: string, status_types?: Array, to_status?: string, last_read_at?: Date, options?: any) => Promise; /** * * @summary Mark notification thread as read by ID * @param {string} id id of notification thread * @param {string} [to_status] Status to mark notifications as * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyReadThread: (id: string, to_status?: string, options?: any) => Promise; }; /** * NotificationApi - functional programming interface * @export */ export declare const NotificationApiFp: (configuration?: Configuration) => { /** * * @summary List users's notification threads * @param {string} [all] If true, show notifications marked as read. Default value is false * @param {Array<string>} [status_types] Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. * @param {Date} [since] Only show notifications updated after the given time. This is a timestamp in RFC 3339 format * @param {Date} [before] Only show notifications updated before the given time. This is a timestamp in RFC 3339 format * @param {number} [page] page number of results to return (1-based) * @param {number} [limit] page size of results * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyGetList(all?: string, status_types?: Array, since?: Date, before?: Date, page?: number, limit?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary List users's notification threads on a specific repo * @param {string} owner owner of the repo * @param {string} repo name of the repo * @param {string} [all] If true, show notifications marked as read. Default value is false * @param {Array<string>} [status_types] Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned * @param {Date} [since] Only show notifications updated after the given time. This is a timestamp in RFC 3339 format * @param {Date} [before] Only show notifications updated before the given time. This is a timestamp in RFC 3339 format * @param {number} [page] page number of results to return (1-based) * @param {number} [limit] page size of results * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyGetRepoList(owner: string, repo: string, all?: string, status_types?: Array, since?: Date, before?: Date, page?: number, limit?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * * @summary Get notification thread by ID * @param {string} id id of notification thread * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyGetThread(id: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Check if unread notifications exist * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyNewAvailable(options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Mark notification threads as read, pinned or unread * @param {Date} [last_read_at] Describes the last point that notifications were checked. Anything updated since this time will not be updated. * @param {string} [all] If true, mark all notifications on this repo. Default value is false * @param {Array<string>} [status_types] Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. * @param {string} [to_status] Status to mark notifications as, Defaults to read. * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyReadList(last_read_at?: Date, all?: string, status_types?: Array, to_status?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Mark notification threads as read, pinned or unread on a specific repo * @param {string} owner owner of the repo * @param {string} repo name of the repo * @param {string} [all] If true, mark all notifications on this repo. Default value is false * @param {Array<string>} [status_types] Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. * @param {string} [to_status] Status to mark notifications as. Defaults to read. * @param {Date} [last_read_at] Describes the last point that notifications were checked. Anything updated since this time will not be updated. * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyReadRepoList(owner: string, repo: string, all?: string, status_types?: Array, to_status?: string, last_read_at?: Date, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @summary Mark notification thread as read by ID * @param {string} id id of notification thread * @param {string} [to_status] Status to mark notifications as * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyReadThread(id: string, to_status?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * NotificationApi - factory interface * @export */ export declare const NotificationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * * @summary List users's notification threads * @param {string} [all] If true, show notifications marked as read. Default value is false * @param {Array<string>} [status_types] Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. * @param {Date} [since] Only show notifications updated after the given time. This is a timestamp in RFC 3339 format * @param {Date} [before] Only show notifications updated before the given time. This is a timestamp in RFC 3339 format * @param {number} [page] page number of results to return (1-based) * @param {number} [limit] page size of results * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyGetList(all?: string, status_types?: Array, since?: Date, before?: Date, page?: number, limit?: number, options?: any): AxiosPromise>; /** * * @summary List users's notification threads on a specific repo * @param {string} owner owner of the repo * @param {string} repo name of the repo * @param {string} [all] If true, show notifications marked as read. Default value is false * @param {Array<string>} [status_types] Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned * @param {Date} [since] Only show notifications updated after the given time. This is a timestamp in RFC 3339 format * @param {Date} [before] Only show notifications updated before the given time. This is a timestamp in RFC 3339 format * @param {number} [page] page number of results to return (1-based) * @param {number} [limit] page size of results * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyGetRepoList(owner: string, repo: string, all?: string, status_types?: Array, since?: Date, before?: Date, page?: number, limit?: number, options?: any): AxiosPromise>; /** * * @summary Get notification thread by ID * @param {string} id id of notification thread * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyGetThread(id: string, options?: any): AxiosPromise; /** * * @summary Check if unread notifications exist * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyNewAvailable(options?: any): AxiosPromise; /** * * @summary Mark notification threads as read, pinned or unread * @param {Date} [last_read_at] Describes the last point that notifications were checked. Anything updated since this time will not be updated. * @param {string} [all] If true, mark all notifications on this repo. Default value is false * @param {Array<string>} [status_types] Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. * @param {string} [to_status] Status to mark notifications as, Defaults to read. * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyReadList(last_read_at?: Date, all?: string, status_types?: Array, to_status?: string, options?: any): AxiosPromise; /** * * @summary Mark notification threads as read, pinned or unread on a specific repo * @param {string} owner owner of the repo * @param {string} repo name of the repo * @param {string} [all] If true, mark all notifications on this repo. Default value is false * @param {Array<string>} [status_types] Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. * @param {string} [to_status] Status to mark notifications as. Defaults to read. * @param {Date} [last_read_at] Describes the last point that notifications were checked. Anything updated since this time will not be updated. * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyReadRepoList(owner: string, repo: string, all?: string, status_types?: Array, to_status?: string, last_read_at?: Date, options?: any): AxiosPromise; /** * * @summary Mark notification thread as read by ID * @param {string} id id of notification thread * @param {string} [to_status] Status to mark notifications as * @param {*} [options] Override http request option. * @throws {RequiredError} */ notifyReadThread(id: string, to_status?: string, options?: any): AxiosPromise; }; /** * NotificationApi - object-oriented interface * @export * @class NotificationApi * @extends {BaseAPI} */ export declare class NotificationApi extends BaseAPI { /** * * @summary List users's notification threads * @param {string} [all] If true, show notifications marked as read. Default value is false * @param {Array<string>} [status_types] Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned. * @param {Date} [since] Only show notifications updated after the given time. This is a timestamp in RFC 3339 format * @param {Date} [before] Only show notifications updated before the given time. This is a timestamp in RFC 3339 format * @param {number} [page] page number of results to return (1-based) * @param {number} [limit] page size of results * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ notifyGetList(all?: string, status_types?: Array, since?: Date, before?: Date, page?: number, limit?: number, options?: any): Promise>; /** * * @summary List users's notification threads on a specific repo * @param {string} owner owner of the repo * @param {string} repo name of the repo * @param {string} [all] If true, show notifications marked as read. Default value is false * @param {Array<string>} [status_types] Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread & pinned * @param {Date} [since] Only show notifications updated after the given time. This is a timestamp in RFC 3339 format * @param {Date} [before] Only show notifications updated before the given time. This is a timestamp in RFC 3339 format * @param {number} [page] page number of results to return (1-based) * @param {number} [limit] page size of results * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ notifyGetRepoList(owner: string, repo: string, all?: string, status_types?: Array, since?: Date, before?: Date, page?: number, limit?: number, options?: any): Promise>; /** * * @summary Get notification thread by ID * @param {string} id id of notification thread * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ notifyGetThread(id: string, options?: any): Promise>; /** * * @summary Check if unread notifications exist * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ notifyNewAvailable(options?: any): Promise>; /** * * @summary Mark notification threads as read, pinned or unread * @param {Date} [last_read_at] Describes the last point that notifications were checked. Anything updated since this time will not be updated. * @param {string} [all] If true, mark all notifications on this repo. Default value is false * @param {Array<string>} [status_types] Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. * @param {string} [to_status] Status to mark notifications as, Defaults to read. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ notifyReadList(last_read_at?: Date, all?: string, status_types?: Array, to_status?: string, options?: any): Promise>; /** * * @summary Mark notification threads as read, pinned or unread on a specific repo * @param {string} owner owner of the repo * @param {string} repo name of the repo * @param {string} [all] If true, mark all notifications on this repo. Default value is false * @param {Array<string>} [status_types] Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread. * @param {string} [to_status] Status to mark notifications as. Defaults to read. * @param {Date} [last_read_at] Describes the last point that notifications were checked. Anything updated since this time will not be updated. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ notifyReadRepoList(owner: string, repo: string, all?: string, status_types?: Array, to_status?: string, last_read_at?: Date, options?: any): Promise>; /** * * @summary Mark notification thread as read by ID * @param {string} id id of notification thread * @param {string} [to_status] Status to mark notifications as * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationApi */ notifyReadThread(id: string, to_status?: string, options?: any): Promise>; }