electric-coop-api 0.1.77 → 0.1.78

package/src/apis/AdminNotificationsApi.ts

@@ -15,23 +15,43 @@
 
 import * as runtime from '../runtime';
 import type {
+  AdminNotificationMarkedAsRead,
+  AdminNotificationUnreadCount,
   AdminSendNotificationDto,
   AdminSendNotificationResponse,
   ErrorResponseDto,
+  PaginatedAdminNotifications,
 } from '../models/index';
 import {
+    AdminNotificationMarkedAsReadFromJSON,
+    AdminNotificationMarkedAsReadToJSON,
+    AdminNotificationUnreadCountFromJSON,
+    AdminNotificationUnreadCountToJSON,
     AdminSendNotificationDtoFromJSON,
     AdminSendNotificationDtoToJSON,
     AdminSendNotificationResponseFromJSON,
     AdminSendNotificationResponseToJSON,
     ErrorResponseDtoFromJSON,
     ErrorResponseDtoToJSON,
+    PaginatedAdminNotificationsFromJSON,
+    PaginatedAdminNotificationsToJSON,
 } from '../models/index';
 
 export interface AdminSendNotificationRequest {
     adminSendNotificationDto: AdminSendNotificationDto;
 }
 
+export interface GetAdminNotificationsRequest {
+    page?: number;
+    limit?: number;
+    search?: string;
+    unreadOnly?: boolean;
+}
+
+export interface MarkAdminNotificationReadRequest {
+    id: string;
+}
+
 /**
  * AdminNotificationsApi - interface
  * 
@@ -41,7 +61,7 @@ export interface AdminSendNotificationRequest {
 export interface AdminNotificationsApiInterface {
     /**
      * 
-     * @summary Send/broadcast a notification (admin)
+     * @summary Broadcast a notification to admins, consumers or a specific user
      * @param {AdminSendNotificationDto} adminSendNotificationDto 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -50,10 +70,71 @@ export interface AdminNotificationsApiInterface {
     adminSendNotificationRaw(requestParameters: AdminSendNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminSendNotificationResponse>>;
 
     /**
-     * Send/broadcast a notification (admin)
+     * Broadcast a notification to admins, consumers or a specific user
      */
     adminSendNotification(requestParameters: AdminSendNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminSendNotificationResponse>;
 
+    /**
+     * 
+     * @summary List admin notifications (paginated)
+     * @param {number} [page] 
+     * @param {number} [limit] 
+     * @param {string} [search] 
+     * @param {boolean} [unreadOnly] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminNotificationsApiInterface
+     */
+    getAdminNotificationsRaw(requestParameters: GetAdminNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedAdminNotifications>>;
+
+    /**
+     * List admin notifications (paginated)
+     */
+    getAdminNotifications(requestParameters: GetAdminNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedAdminNotifications>;
+
+    /**
+     * 
+     * @summary Get unread admin notification count
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminNotificationsApiInterface
+     */
+    getAdminUnreadNotificationCountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminNotificationUnreadCount>>;
+
+    /**
+     * Get unread admin notification count
+     */
+    getAdminUnreadNotificationCount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminNotificationUnreadCount>;
+
+    /**
+     * 
+     * @summary Mark admin notification as read
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminNotificationsApiInterface
+     */
+    markAdminNotificationReadRaw(requestParameters: MarkAdminNotificationReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminNotificationMarkedAsRead>>;
+
+    /**
+     * Mark admin notification as read
+     */
+    markAdminNotificationRead(requestParameters: MarkAdminNotificationReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminNotificationMarkedAsRead>;
+
+    /**
+     * 
+     * @summary Mark all admin notifications as read
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminNotificationsApiInterface
+     */
+    markAllAdminNotificationsReadRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Mark all admin notifications as read
+     */
+    markAllAdminNotificationsRead(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
 }
 
 /**
@@ -62,7 +143,7 @@ export interface AdminNotificationsApiInterface {
 export class AdminNotificationsApi extends runtime.BaseAPI implements AdminNotificationsApiInterface {
 
     /**
-     * Send/broadcast a notification (admin)
+     * Broadcast a notification to admins, consumers or a specific user
      */
     async adminSendNotificationRaw(requestParameters: AdminSendNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminSendNotificationResponse>> {
         if (requestParameters['adminSendNotificationDto'] == null) {
@@ -101,11 +182,182 @@ export class AdminNotificationsApi extends runtime.BaseAPI implements AdminNotif
     }
 
     /**
-     * Send/broadcast a notification (admin)
+     * Broadcast a notification to admins, consumers or a specific user
      */
     async adminSendNotification(requestParameters: AdminSendNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminSendNotificationResponse> {
         const response = await this.adminSendNotificationRaw(requestParameters, initOverrides);
         return await response.value();
     }
 
+    /**
+     * List admin notifications (paginated)
+     */
+    async getAdminNotificationsRaw(requestParameters: GetAdminNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PaginatedAdminNotifications>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        if (requestParameters['search'] != null) {
+            queryParameters['search'] = requestParameters['search'];
+        }
+
+        if (requestParameters['unreadOnly'] != null) {
+            queryParameters['unreadOnly'] = requestParameters['unreadOnly'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/admin/notifications`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PaginatedAdminNotificationsFromJSON(jsonValue));
+    }
+
+    /**
+     * List admin notifications (paginated)
+     */
+    async getAdminNotifications(requestParameters: GetAdminNotificationsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PaginatedAdminNotifications> {
+        const response = await this.getAdminNotificationsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get unread admin notification count
+     */
+    async getAdminUnreadNotificationCountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminNotificationUnreadCount>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/admin/notifications/unread-count`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdminNotificationUnreadCountFromJSON(jsonValue));
+    }
+
+    /**
+     * Get unread admin notification count
+     */
+    async getAdminUnreadNotificationCount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminNotificationUnreadCount> {
+        const response = await this.getAdminUnreadNotificationCountRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Mark admin notification as read
+     */
+    async markAdminNotificationReadRaw(requestParameters: MarkAdminNotificationReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminNotificationMarkedAsRead>> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling markAdminNotificationRead().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/admin/notifications/{id}/read`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdminNotificationMarkedAsReadFromJSON(jsonValue));
+    }
+
+    /**
+     * Mark admin notification as read
+     */
+    async markAdminNotificationRead(requestParameters: MarkAdminNotificationReadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminNotificationMarkedAsRead> {
+        const response = await this.markAdminNotificationReadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Mark all admin notifications as read
+     */
+    async markAllAdminNotificationsReadRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/api/v1/admin/notifications/mark-all-read`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'PATCH',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Mark all admin notifications as read
+     */
+    async markAllAdminNotificationsRead(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.markAllAdminNotificationsReadRaw(initOverrides);
+    }
+
 }

package/src/apis/index.ts

@@ -21,9 +21,7 @@ export * from './FieldWorkOrdersApi';
 export * from './ManagementDashboardApi';
 export * from './MetersApi';
 export * from './NotificationsApi';
-export * from './RateAdjustmentsApi';
 export * from './RateDisplayApi';
-export * from './RatesApi';
 export * from './ReportsApi';
 export * from './SettingsApi';
 export * from './UsersApi';

package/src/models/AdminNotificationMarkedAsRead.ts

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Electric Cooperative Consumer Portal API
+ * Multi-tenant SaaS platform for Philippine electric cooperatives
+ *
+ * The version of the OpenAPI document: 1.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 { mapValues } from '../runtime';
+import type { Notification } from './Notification';
+import {
+    NotificationFromJSON,
+    NotificationFromJSONTyped,
+    NotificationToJSON,
+    NotificationToJSONTyped,
+} from './Notification';
+
+/**
+ * 
+ * @export
+ * @interface AdminNotificationMarkedAsRead
+ */
+export interface AdminNotificationMarkedAsRead {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AdminNotificationMarkedAsRead
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminNotificationMarkedAsRead
+     */
+    error?: string;
+    /**
+     * 
+     * @type {Notification}
+     * @memberof AdminNotificationMarkedAsRead
+     */
+    data: Notification;
+}
+
+/**
+ * Check if a given object implements the AdminNotificationMarkedAsRead interface.
+ */
+export function instanceOfAdminNotificationMarkedAsRead(value: object): value is AdminNotificationMarkedAsRead {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function AdminNotificationMarkedAsReadFromJSON(json: any): AdminNotificationMarkedAsRead {
+    return AdminNotificationMarkedAsReadFromJSONTyped(json, false);
+}
+
+export function AdminNotificationMarkedAsReadFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminNotificationMarkedAsRead {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'data': NotificationFromJSON(json['data']),
+    };
+}
+
+export function AdminNotificationMarkedAsReadToJSON(json: any): AdminNotificationMarkedAsRead {
+    return AdminNotificationMarkedAsReadToJSONTyped(json, false);
+}
+
+export function AdminNotificationMarkedAsReadToJSONTyped(value?: AdminNotificationMarkedAsRead | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error': value['error'],
+        'data': NotificationToJSON(value['data']),
+    };
+}
+

package/src/models/AdminNotificationUnreadCount.ts

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Electric Cooperative Consumer Portal API
+ * Multi-tenant SaaS platform for Philippine electric cooperatives
+ *
+ * The version of the OpenAPI document: 1.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 { mapValues } from '../runtime';
+import type { NotificationUnreadCountResponseDto } from './NotificationUnreadCountResponseDto';
+import {
+    NotificationUnreadCountResponseDtoFromJSON,
+    NotificationUnreadCountResponseDtoFromJSONTyped,
+    NotificationUnreadCountResponseDtoToJSON,
+    NotificationUnreadCountResponseDtoToJSONTyped,
+} from './NotificationUnreadCountResponseDto';
+
+/**
+ * 
+ * @export
+ * @interface AdminNotificationUnreadCount
+ */
+export interface AdminNotificationUnreadCount {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AdminNotificationUnreadCount
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminNotificationUnreadCount
+     */
+    error?: string;
+    /**
+     * 
+     * @type {NotificationUnreadCountResponseDto}
+     * @memberof AdminNotificationUnreadCount
+     */
+    data: NotificationUnreadCountResponseDto;
+}
+
+/**
+ * Check if a given object implements the AdminNotificationUnreadCount interface.
+ */
+export function instanceOfAdminNotificationUnreadCount(value: object): value is AdminNotificationUnreadCount {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function AdminNotificationUnreadCountFromJSON(json: any): AdminNotificationUnreadCount {
+    return AdminNotificationUnreadCountFromJSONTyped(json, false);
+}
+
+export function AdminNotificationUnreadCountFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminNotificationUnreadCount {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'data': NotificationUnreadCountResponseDtoFromJSON(json['data']),
+    };
+}
+
+export function AdminNotificationUnreadCountToJSON(json: any): AdminNotificationUnreadCount {
+    return AdminNotificationUnreadCountToJSONTyped(json, false);
+}
+
+export function AdminNotificationUnreadCountToJSONTyped(value?: AdminNotificationUnreadCount | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error': value['error'],
+        'data': NotificationUnreadCountResponseDtoToJSON(value['data']),
+    };
+}
+

package/src/models/AuditLogEntityTypeEnum.ts

@@ -26,6 +26,7 @@ export const AuditLogEntityTypeEnum = {
     Complaint: 'complaint',
     Consumer: 'consumer',
     RateAdjustment: 'rate_adjustment',
+    RateDisplay: 'rate_display',
     Bill: 'bill',
     Settings: 'settings'
 } as const;

package/src/models/NotificationTypeEnum.ts

@@ -20,7 +20,12 @@
 export const NotificationTypeEnum = {
     Bill: 'bill',
     Complaint: 'complaint',
-    System: 'system'
+    System: 'system',
+    ServiceRequest: 'service_request',
+    WorkOrder: 'work_order',
+    Outage: 'outage',
+    Payment: 'payment',
+    MeterReading: 'meter_reading'
 } as const;
 export type NotificationTypeEnum = typeof NotificationTypeEnum[keyof typeof NotificationTypeEnum];
 

package/src/models/PaginatedAdminNotifications.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Electric Cooperative Consumer Portal API
+ * Multi-tenant SaaS platform for Philippine electric cooperatives
+ *
+ * The version of the OpenAPI document: 1.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 { mapValues } from '../runtime';
+import type { PaginationMetaDto } from './PaginationMetaDto';
+import {
+    PaginationMetaDtoFromJSON,
+    PaginationMetaDtoFromJSONTyped,
+    PaginationMetaDtoToJSON,
+    PaginationMetaDtoToJSONTyped,
+} from './PaginationMetaDto';
+import type { PaginatedResponseDto } from './PaginatedResponseDto';
+import {
+    PaginatedResponseDtoFromJSON,
+    PaginatedResponseDtoFromJSONTyped,
+    PaginatedResponseDtoToJSON,
+    PaginatedResponseDtoToJSONTyped,
+} from './PaginatedResponseDto';
+
+/**
+ * 
+ * @export
+ * @interface PaginatedAdminNotifications
+ */
+export interface PaginatedAdminNotifications {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof PaginatedAdminNotifications
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof PaginatedAdminNotifications
+     */
+    error?: string;
+    /**
+     * 
+     * @type {Array<PaginatedResponseDto>}
+     * @memberof PaginatedAdminNotifications
+     */
+    data: Array<PaginatedResponseDto>;
+    /**
+     * 
+     * @type {PaginationMetaDto}
+     * @memberof PaginatedAdminNotifications
+     */
+    meta: PaginationMetaDto;
+}
+
+/**
+ * Check if a given object implements the PaginatedAdminNotifications interface.
+ */
+export function instanceOfPaginatedAdminNotifications(value: object): value is PaginatedAdminNotifications {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    if (!('meta' in value) || value['meta'] === undefined) return false;
+    return true;
+}
+
+export function PaginatedAdminNotificationsFromJSON(json: any): PaginatedAdminNotifications {
+    return PaginatedAdminNotificationsFromJSONTyped(json, false);
+}
+
+export function PaginatedAdminNotificationsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaginatedAdminNotifications {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'data': ((json['data'] as Array<any>).map(PaginatedResponseDtoFromJSON)),
+        'meta': PaginationMetaDtoFromJSON(json['meta']),
+    };
+}
+
+export function PaginatedAdminNotificationsToJSON(json: any): PaginatedAdminNotifications {
+    return PaginatedAdminNotificationsToJSONTyped(json, false);
+}
+
+export function PaginatedAdminNotificationsToJSONTyped(value?: PaginatedAdminNotifications | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error': value['error'],
+        'data': ((value['data'] as Array<any>).map(PaginatedResponseDtoToJSON)),
+        'meta': PaginationMetaDtoToJSON(value['meta']),
+    };
+}
+