@simplyhomes/sos-sdk/dist/generated/src/apis/NotificationsAPIV4Api.d.ts

TypeScript SDK for Simply Homes SoS API v4

/**
 * API v4
 * Swagger documentation for API v4
 *
 * The version of the OpenAPI document: 4.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import * as runtime from '../runtime';
import type { SoSViewEntityFilterOperationString, V4NotificationsCreateNotificationBodyDto, V4NotificationsCreateNotificationResponseDto, V4NotificationsDeleteNotificationResponseDto, V4NotificationsGetNotificationResponseDto, V4NotificationsGetNotificationsFilteredByResponseDto, V4NotificationsGetNotificationsInViewResponseDto, V4NotificationsGetNotificationsResponseDto, V4NotificationsGetUniqueValuesResponseDto, V4NotificationsMarkAllNotificationsReadResponseDto, V4NotificationsUpdateNotificationBodyDto, V4NotificationsUpdateNotificationResponseDto } from '../models/index';
export interface V4NotificationsControllerCreateNotificationV4Request {
    v4NotificationsCreateNotificationBodyDto: V4NotificationsCreateNotificationBodyDto;
}
export interface V4NotificationsControllerDeleteNotificationV4Request {
    notificationId: number;
}
export interface V4NotificationsControllerGetNotificationV4Request {
    notificationId: number;
    viewId?: number;
}
export interface V4NotificationsControllerGetNotificationsFilteredByV4Request {
    column: string;
    value: string;
    viewId?: number;
    columns?: string;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
    filterOperation?: SoSViewEntityFilterOperationString;
}
export interface V4NotificationsControllerGetNotificationsInViewV4Request {
    viewId: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4NotificationsControllerGetNotificationsV4Request {
    viewId?: number;
    limit?: number;
    offset?: number;
    countOnly?: boolean;
}
export interface V4NotificationsControllerGetUniqueValuesV4Request {
    column: string;
    limit?: number;
    offset?: number;
    viewId?: number;
}
export interface V4NotificationsControllerUpdateNotificationV4Request {
    notificationId: number;
    v4NotificationsUpdateNotificationBodyDto: V4NotificationsUpdateNotificationBodyDto;
}
/**
 * NotificationsAPIV4Api - interface
 *
 * @export
 * @interface NotificationsAPIV4ApiInterface
 */
export interface NotificationsAPIV4ApiInterface {
    /**
     * Create a new notification for the authenticated user
     * @summary Create a new notification
     * @param {V4NotificationsCreateNotificationBodyDto} v4NotificationsCreateNotificationBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NotificationsAPIV4ApiInterface
     */
    v4NotificationsControllerCreateNotificationV4Raw(requestParameters: V4NotificationsControllerCreateNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsCreateNotificationResponseDto>>;
    /**
     * Create a new notification for the authenticated user
     * Create a new notification
     */
    v4NotificationsControllerCreateNotificationV4(requestParameters: V4NotificationsControllerCreateNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsCreateNotificationResponseDto>;
    /**
     * Permanently delete a notification for the authenticated user
     * @summary Delete a specific notification by notificationId
     * @param {number} notificationId The unique identifier of the notification
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NotificationsAPIV4ApiInterface
     */
    v4NotificationsControllerDeleteNotificationV4Raw(requestParameters: V4NotificationsControllerDeleteNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsDeleteNotificationResponseDto>>;
    /**
     * Permanently delete a notification for the authenticated user
     * Delete a specific notification by notificationId
     */
    v4NotificationsControllerDeleteNotificationV4(requestParameters: V4NotificationsControllerDeleteNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsDeleteNotificationResponseDto>;
    /**
     * Retrieve detailed information about a specific notification for the authenticated user
     * @summary Get a specific notification by notificationId
     * @param {number} notificationId The unique identifier of the notification
     * @param {number} [viewId] The ID of the view to use for retrieving the repository
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NotificationsAPIV4ApiInterface
     */
    v4NotificationsControllerGetNotificationV4Raw(requestParameters: V4NotificationsControllerGetNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsGetNotificationResponseDto>>;
    /**
     * Retrieve detailed information about a specific notification for the authenticated user
     * Get a specific notification by notificationId
     */
    v4NotificationsControllerGetNotificationV4(requestParameters: V4NotificationsControllerGetNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsGetNotificationResponseDto>;
    /**
     * Retrieve notifications for the authenticated user filtered by column value
     * @summary Get notifications filtered by a specific column and value
     * @param {string} column The name of the column to filter by
     * @param {string} value The value to filter by
     * @param {number} [viewId] The ID of the view to use for retrieving the repository
     * @param {string} [columns] The columns to select from the object
     * @param {number} [limit] The maximum number of objects to return
     * @param {number} [offset] The offset for pagination, used to skip a number of objects
     * @param {boolean} [countOnly] Whether to return only the count of objects instead of the objects themselves
     * @param {SoSViewEntityFilterOperationString} [filterOperation] Filter operation to apply
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NotificationsAPIV4ApiInterface
     */
    v4NotificationsControllerGetNotificationsFilteredByV4Raw(requestParameters: V4NotificationsControllerGetNotificationsFilteredByV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsGetNotificationsFilteredByResponseDto>>;
    /**
     * Retrieve notifications for the authenticated user filtered by column value
     * Get notifications filtered by a specific column and value
     */
    v4NotificationsControllerGetNotificationsFilteredByV4(requestParameters: V4NotificationsControllerGetNotificationsFilteredByV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsGetNotificationsFilteredByResponseDto>;
    /**
     * Retrieve notifications for the authenticated user filtered by a specific view
     * @summary Get notifications with a specific viewId
     * @param {number} viewId The unique identifier of the view
     * @param {number} [limit] The maximum number of objects to return
     * @param {number} [offset] The offset for pagination, used to skip a number of objects
     * @param {boolean} [countOnly] Whether to return only the count of objects instead of the objects themselves
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NotificationsAPIV4ApiInterface
     */
    v4NotificationsControllerGetNotificationsInViewV4Raw(requestParameters: V4NotificationsControllerGetNotificationsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsGetNotificationsInViewResponseDto>>;
    /**
     * Retrieve notifications for the authenticated user filtered by a specific view
     * Get notifications with a specific viewId
     */
    v4NotificationsControllerGetNotificationsInViewV4(requestParameters: V4NotificationsControllerGetNotificationsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsGetNotificationsInViewResponseDto>;
    /**
     * Retrieve a list of notifications for the authenticated user with optional view filtering
     * @summary Get notifications with optional viewId
     * @param {number} [viewId] The ID of the view to use for retrieving the repository
     * @param {number} [limit] The maximum number of objects to return
     * @param {number} [offset] The offset for pagination, used to skip a number of objects
     * @param {boolean} [countOnly] Whether to return only the count of objects instead of the objects themselves
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NotificationsAPIV4ApiInterface
     */
    v4NotificationsControllerGetNotificationsV4Raw(requestParameters: V4NotificationsControllerGetNotificationsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsGetNotificationsResponseDto>>;
    /**
     * Retrieve a list of notifications for the authenticated user with optional view filtering
     * Get notifications with optional viewId
     */
    v4NotificationsControllerGetNotificationsV4(requestParameters: V4NotificationsControllerGetNotificationsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsGetNotificationsResponseDto>;
    /**
     * Retrieve unique values for the authenticated user\'s notifications with occurrence counts
     * @summary Get unique values for a specific notification column with counts
     * @param {string} column The name of the column to get unique values for
     * @param {number} [limit] Maximum number of unique values to return
     * @param {number} [offset] Offset for pagination
     * @param {number} [viewId] Optional view ID to filter by
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NotificationsAPIV4ApiInterface
     */
    v4NotificationsControllerGetUniqueValuesV4Raw(requestParameters: V4NotificationsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsGetUniqueValuesResponseDto>>;
    /**
     * Retrieve unique values for the authenticated user\'s notifications with occurrence counts
     * Get unique values for a specific notification column with counts
     */
    v4NotificationsControllerGetUniqueValuesV4(requestParameters: V4NotificationsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsGetUniqueValuesResponseDto>;
    /**
     * Marks all unread notifications as read for the authenticated user
     * @summary Mark all notifications as read
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NotificationsAPIV4ApiInterface
     */
    v4NotificationsControllerMarkAllNotificationsAsReadV4Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsMarkAllNotificationsReadResponseDto>>;
    /**
     * Marks all unread notifications as read for the authenticated user
     * Mark all notifications as read
     */
    v4NotificationsControllerMarkAllNotificationsAsReadV4(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsMarkAllNotificationsReadResponseDto>;
    /**
     * Update notification properties (e.g., mark as read/unread, star/unstar)
     * @summary Update a specific notification by notificationId
     * @param {number} notificationId The unique identifier of the notification
     * @param {V4NotificationsUpdateNotificationBodyDto} v4NotificationsUpdateNotificationBodyDto
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof NotificationsAPIV4ApiInterface
     */
    v4NotificationsControllerUpdateNotificationV4Raw(requestParameters: V4NotificationsControllerUpdateNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsUpdateNotificationResponseDto>>;
    /**
     * Update notification properties (e.g., mark as read/unread, star/unstar)
     * Update a specific notification by notificationId
     */
    v4NotificationsControllerUpdateNotificationV4(requestParameters: V4NotificationsControllerUpdateNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsUpdateNotificationResponseDto>;
}
/**
 *
 */
export declare class NotificationsAPIV4Api extends runtime.BaseAPI implements NotificationsAPIV4ApiInterface {
    /**
     * Create a new notification for the authenticated user
     * Create a new notification
     */
    v4NotificationsControllerCreateNotificationV4Raw(requestParameters: V4NotificationsControllerCreateNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsCreateNotificationResponseDto>>;
    /**
     * Create a new notification for the authenticated user
     * Create a new notification
     */
    v4NotificationsControllerCreateNotificationV4(requestParameters: V4NotificationsControllerCreateNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsCreateNotificationResponseDto>;
    /**
     * Permanently delete a notification for the authenticated user
     * Delete a specific notification by notificationId
     */
    v4NotificationsControllerDeleteNotificationV4Raw(requestParameters: V4NotificationsControllerDeleteNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsDeleteNotificationResponseDto>>;
    /**
     * Permanently delete a notification for the authenticated user
     * Delete a specific notification by notificationId
     */
    v4NotificationsControllerDeleteNotificationV4(requestParameters: V4NotificationsControllerDeleteNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsDeleteNotificationResponseDto>;
    /**
     * Retrieve detailed information about a specific notification for the authenticated user
     * Get a specific notification by notificationId
     */
    v4NotificationsControllerGetNotificationV4Raw(requestParameters: V4NotificationsControllerGetNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsGetNotificationResponseDto>>;
    /**
     * Retrieve detailed information about a specific notification for the authenticated user
     * Get a specific notification by notificationId
     */
    v4NotificationsControllerGetNotificationV4(requestParameters: V4NotificationsControllerGetNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsGetNotificationResponseDto>;
    /**
     * Retrieve notifications for the authenticated user filtered by column value
     * Get notifications filtered by a specific column and value
     */
    v4NotificationsControllerGetNotificationsFilteredByV4Raw(requestParameters: V4NotificationsControllerGetNotificationsFilteredByV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsGetNotificationsFilteredByResponseDto>>;
    /**
     * Retrieve notifications for the authenticated user filtered by column value
     * Get notifications filtered by a specific column and value
     */
    v4NotificationsControllerGetNotificationsFilteredByV4(requestParameters: V4NotificationsControllerGetNotificationsFilteredByV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsGetNotificationsFilteredByResponseDto>;
    /**
     * Retrieve notifications for the authenticated user filtered by a specific view
     * Get notifications with a specific viewId
     */
    v4NotificationsControllerGetNotificationsInViewV4Raw(requestParameters: V4NotificationsControllerGetNotificationsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsGetNotificationsInViewResponseDto>>;
    /**
     * Retrieve notifications for the authenticated user filtered by a specific view
     * Get notifications with a specific viewId
     */
    v4NotificationsControllerGetNotificationsInViewV4(requestParameters: V4NotificationsControllerGetNotificationsInViewV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsGetNotificationsInViewResponseDto>;
    /**
     * Retrieve a list of notifications for the authenticated user with optional view filtering
     * Get notifications with optional viewId
     */
    v4NotificationsControllerGetNotificationsV4Raw(requestParameters: V4NotificationsControllerGetNotificationsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsGetNotificationsResponseDto>>;
    /**
     * Retrieve a list of notifications for the authenticated user with optional view filtering
     * Get notifications with optional viewId
     */
    v4NotificationsControllerGetNotificationsV4(requestParameters?: V4NotificationsControllerGetNotificationsV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsGetNotificationsResponseDto>;
    /**
     * Retrieve unique values for the authenticated user\'s notifications with occurrence counts
     * Get unique values for a specific notification column with counts
     */
    v4NotificationsControllerGetUniqueValuesV4Raw(requestParameters: V4NotificationsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsGetUniqueValuesResponseDto>>;
    /**
     * Retrieve unique values for the authenticated user\'s notifications with occurrence counts
     * Get unique values for a specific notification column with counts
     */
    v4NotificationsControllerGetUniqueValuesV4(requestParameters: V4NotificationsControllerGetUniqueValuesV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsGetUniqueValuesResponseDto>;
    /**
     * Marks all unread notifications as read for the authenticated user
     * Mark all notifications as read
     */
    v4NotificationsControllerMarkAllNotificationsAsReadV4Raw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsMarkAllNotificationsReadResponseDto>>;
    /**
     * Marks all unread notifications as read for the authenticated user
     * Mark all notifications as read
     */
    v4NotificationsControllerMarkAllNotificationsAsReadV4(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsMarkAllNotificationsReadResponseDto>;
    /**
     * Update notification properties (e.g., mark as read/unread, star/unstar)
     * Update a specific notification by notificationId
     */
    v4NotificationsControllerUpdateNotificationV4Raw(requestParameters: V4NotificationsControllerUpdateNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<V4NotificationsUpdateNotificationResponseDto>>;
    /**
     * Update notification properties (e.g., mark as read/unread, star/unstar)
     * Update a specific notification by notificationId
     */
    v4NotificationsControllerUpdateNotificationV4(requestParameters: V4NotificationsControllerUpdateNotificationV4Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<V4NotificationsUpdateNotificationResponseDto>;
}
//# sourceMappingURL=NotificationsAPIV4Api.d.ts.map