electric-coop-api 0.1.49 → 0.1.52

package/src/apis/AdminAuditLogsApi.ts

@@ -0,0 +1,198 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  AdminAuditLogsPaginatedResponse,
+  AuditLogsFiltersResponseDto,
+  ErrorResponseDto,
+} from '../models/index';
+import {
+    AdminAuditLogsPaginatedResponseFromJSON,
+    AdminAuditLogsPaginatedResponseToJSON,
+    AuditLogsFiltersResponseDtoFromJSON,
+    AuditLogsFiltersResponseDtoToJSON,
+    ErrorResponseDtoFromJSON,
+    ErrorResponseDtoToJSON,
+} from '../models/index';
+
+export interface GetAdminAuditLogsRequest {
+    page?: number;
+    limit?: number;
+    search?: string;
+    entityType?: string;
+    action?: string;
+    userId?: string;
+    from?: string;
+    to?: string;
+}
+
+/**
+ * AdminAuditLogsApi - interface
+ * 
+ * @export
+ * @interface AdminAuditLogsApiInterface
+ */
+export interface AdminAuditLogsApiInterface {
+    /**
+     * 
+     * @summary List audit logs (admin)
+     * @param {number} [page] 
+     * @param {number} [limit] 
+     * @param {string} [search] 
+     * @param {string} [entityType] outage | work_order
+     * @param {string} [action] CREATE | UPDATE | ASSIGN | STATUS_CHANGE
+     * @param {string} [userId] Filter by actor user ID
+     * @param {string} [from] From date (ISO)
+     * @param {string} [to] To date (ISO)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminAuditLogsApiInterface
+     */
+    getAdminAuditLogsRaw(requestParameters: GetAdminAuditLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminAuditLogsPaginatedResponse>>;
+
+    /**
+     * List audit logs (admin)
+     */
+    getAdminAuditLogs(requestParameters: GetAdminAuditLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminAuditLogsPaginatedResponse>;
+
+    /**
+     * 
+     * @summary Get available filter values (entity types & actions)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminAuditLogsApiInterface
+     */
+    getAdminAuditLogsFiltersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuditLogsFiltersResponseDto>>;
+
+    /**
+     * Get available filter values (entity types & actions)
+     */
+    getAdminAuditLogsFilters(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuditLogsFiltersResponseDto>;
+
+}
+
+/**
+ * 
+ */
+export class AdminAuditLogsApi extends runtime.BaseAPI implements AdminAuditLogsApiInterface {
+
+    /**
+     * List audit logs (admin)
+     */
+    async getAdminAuditLogsRaw(requestParameters: GetAdminAuditLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminAuditLogsPaginatedResponse>> {
+        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['entityType'] != null) {
+            queryParameters['entityType'] = requestParameters['entityType'];
+        }
+
+        if (requestParameters['action'] != null) {
+            queryParameters['action'] = requestParameters['action'];
+        }
+
+        if (requestParameters['userId'] != null) {
+            queryParameters['userId'] = requestParameters['userId'];
+        }
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = requestParameters['from'];
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = requestParameters['to'];
+        }
+
+        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/audit-logs`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdminAuditLogsPaginatedResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List audit logs (admin)
+     */
+    async getAdminAuditLogs(requestParameters: GetAdminAuditLogsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminAuditLogsPaginatedResponse> {
+        const response = await this.getAdminAuditLogsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get available filter values (entity types & actions)
+     */
+    async getAdminAuditLogsFiltersRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AuditLogsFiltersResponseDto>> {
+        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/audit-logs/filters`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AuditLogsFiltersResponseDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Get available filter values (entity types & actions)
+     */
+    async getAdminAuditLogsFilters(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AuditLogsFiltersResponseDto> {
+        const response = await this.getAdminAuditLogsFiltersRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/AdminNotificationsApi.ts

@@ -0,0 +1,111 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  AdminSendNotificationDto,
+  AdminSendNotificationResponse,
+  ErrorResponseDto,
+} from '../models/index';
+import {
+    AdminSendNotificationDtoFromJSON,
+    AdminSendNotificationDtoToJSON,
+    AdminSendNotificationResponseFromJSON,
+    AdminSendNotificationResponseToJSON,
+    ErrorResponseDtoFromJSON,
+    ErrorResponseDtoToJSON,
+} from '../models/index';
+
+export interface AdminSendNotificationRequest {
+    adminSendNotificationDto: AdminSendNotificationDto;
+}
+
+/**
+ * AdminNotificationsApi - interface
+ * 
+ * @export
+ * @interface AdminNotificationsApiInterface
+ */
+export interface AdminNotificationsApiInterface {
+    /**
+     * 
+     * @summary Send/broadcast a notification (admin)
+     * @param {AdminSendNotificationDto} adminSendNotificationDto 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AdminNotificationsApiInterface
+     */
+    adminSendNotificationRaw(requestParameters: AdminSendNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminSendNotificationResponse>>;
+
+    /**
+     * Send/broadcast a notification (admin)
+     */
+    adminSendNotification(requestParameters: AdminSendNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminSendNotificationResponse>;
+
+}
+
+/**
+ * 
+ */
+export class AdminNotificationsApi extends runtime.BaseAPI implements AdminNotificationsApiInterface {
+
+    /**
+     * Send/broadcast a notification (admin)
+     */
+    async adminSendNotificationRaw(requestParameters: AdminSendNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminSendNotificationResponse>> {
+        if (requestParameters['adminSendNotificationDto'] == null) {
+            throw new runtime.RequiredError(
+                'adminSendNotificationDto',
+                'Required parameter "adminSendNotificationDto" was null or undefined when calling adminSendNotification().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        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/send`;
+
+        const response = await this.request({
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: AdminSendNotificationDtoToJSON(requestParameters['adminSendNotificationDto']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => AdminSendNotificationResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Send/broadcast a notification (admin)
+     */
+    async adminSendNotification(requestParameters: AdminSendNotificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminSendNotificationResponse> {
+        const response = await this.adminSendNotificationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/AdminWorkOrdersApi.ts

@@ -76,6 +76,7 @@ export interface GetAdminWorkOrdersRequest {
     type?: WorkOrderTypeEnum;
     assignedTo?: string;
     consumerId?: string;
+    outageId?: string;
 }
 
 export interface UpdateAdminWorkOrderRequest {
@@ -155,11 +156,12 @@ export interface AdminWorkOrdersApiInterface {
      * @summary List work orders (admin)
      * @param {number} [page] 
      * @param {number} [limit] 
-     * @param {string} [search] 
+     * @param {string} [search] Search by work order number, title, or location
      * @param {WorkOrderStatusEnum} [status] 
      * @param {WorkOrderTypeEnum} [type] 
      * @param {string} [assignedTo] 
      * @param {string} [consumerId] 
+     * @param {string} [outageId] Filter work orders by linked outage
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AdminWorkOrdersApiInterface
@@ -412,6 +414,10 @@ export class AdminWorkOrdersApi extends runtime.BaseAPI implements AdminWorkOrde
             queryParameters['consumerId'] = requestParameters['consumerId'];
         }
 
+        if (requestParameters['outageId'] != null) {
+            queryParameters['outageId'] = requestParameters['outageId'];
+        }
+
         const headerParameters: runtime.HTTPHeaders = {};
 
         if (this.configuration && this.configuration.accessToken) {

package/src/apis/index.ts

@@ -1,10 +1,12 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './AdminApi';
+export * from './AdminAuditLogsApi';
 export * from './AdminAuthApi';
 export * from './AdminBillsApi';
 export * from './AdminComplaintsApi';
 export * from './AdminConsumersApi';
+export * from './AdminNotificationsApi';
 export * from './AdminOutagesApi';
 export * from './AdminServiceRequestsApi';
 export * from './AdminWorkOrdersApi';

package/src/models/AdminAuditLogsPaginatedResponse.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 { AuditLog } from './AuditLog';
+import {
+    AuditLogFromJSON,
+    AuditLogFromJSONTyped,
+    AuditLogToJSON,
+    AuditLogToJSONTyped,
+} from './AuditLog';
+
+/**
+ * 
+ * @export
+ * @interface AdminAuditLogsPaginatedResponse
+ */
+export interface AdminAuditLogsPaginatedResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AdminAuditLogsPaginatedResponse
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminAuditLogsPaginatedResponse
+     */
+    error?: string;
+    /**
+     * 
+     * @type {Array<AuditLog>}
+     * @memberof AdminAuditLogsPaginatedResponse
+     */
+    data: Array<AuditLog>;
+    /**
+     * 
+     * @type {PaginationMetaDto}
+     * @memberof AdminAuditLogsPaginatedResponse
+     */
+    meta: PaginationMetaDto;
+}
+
+/**
+ * Check if a given object implements the AdminAuditLogsPaginatedResponse interface.
+ */
+export function instanceOfAdminAuditLogsPaginatedResponse(value: object): value is AdminAuditLogsPaginatedResponse {
+    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 AdminAuditLogsPaginatedResponseFromJSON(json: any): AdminAuditLogsPaginatedResponse {
+    return AdminAuditLogsPaginatedResponseFromJSONTyped(json, false);
+}
+
+export function AdminAuditLogsPaginatedResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminAuditLogsPaginatedResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'data': ((json['data'] as Array<any>).map(AuditLogFromJSON)),
+        'meta': PaginationMetaDtoFromJSON(json['meta']),
+    };
+}
+
+export function AdminAuditLogsPaginatedResponseToJSON(json: any): AdminAuditLogsPaginatedResponse {
+    return AdminAuditLogsPaginatedResponseToJSONTyped(json, false);
+}
+
+export function AdminAuditLogsPaginatedResponseToJSONTyped(value?: AdminAuditLogsPaginatedResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error': value['error'],
+        'data': ((value['data'] as Array<any>).map(AuditLogToJSON)),
+        'meta': PaginationMetaDtoToJSON(value['meta']),
+    };
+}
+

package/src/models/AdminSendNotificationDto.ts

@@ -0,0 +1,118 @@
+/* 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 { NotificationTargetEnum } from './NotificationTargetEnum';
+import {
+    NotificationTargetEnumFromJSON,
+    NotificationTargetEnumFromJSONTyped,
+    NotificationTargetEnumToJSON,
+    NotificationTargetEnumToJSONTyped,
+} from './NotificationTargetEnum';
+import type { NotificationTypeEnum } from './NotificationTypeEnum';
+import {
+    NotificationTypeEnumFromJSON,
+    NotificationTypeEnumFromJSONTyped,
+    NotificationTypeEnumToJSON,
+    NotificationTypeEnumToJSONTyped,
+} from './NotificationTypeEnum';
+
+/**
+ * 
+ * @export
+ * @interface AdminSendNotificationDto
+ */
+export interface AdminSendNotificationDto {
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminSendNotificationDto
+     */
+    title: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminSendNotificationDto
+     */
+    message: string;
+    /**
+     * 
+     * @type {NotificationTypeEnum}
+     * @memberof AdminSendNotificationDto
+     */
+    type: NotificationTypeEnum;
+    /**
+     * Who to send the notification to
+     * @type {NotificationTargetEnum}
+     * @memberof AdminSendNotificationDto
+     */
+    target: NotificationTargetEnum;
+    /**
+     * Required when target is "user"
+     * @type {string}
+     * @memberof AdminSendNotificationDto
+     */
+    userId?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the AdminSendNotificationDto interface.
+ */
+export function instanceOfAdminSendNotificationDto(value: object): value is AdminSendNotificationDto {
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('target' in value) || value['target'] === undefined) return false;
+    return true;
+}
+
+export function AdminSendNotificationDtoFromJSON(json: any): AdminSendNotificationDto {
+    return AdminSendNotificationDtoFromJSONTyped(json, false);
+}
+
+export function AdminSendNotificationDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminSendNotificationDto {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'title': json['title'],
+        'message': json['message'],
+        'type': NotificationTypeEnumFromJSON(json['type']),
+        'target': NotificationTargetEnumFromJSON(json['target']),
+        'userId': json['userId'] == null ? undefined : json['userId'],
+    };
+}
+
+export function AdminSendNotificationDtoToJSON(json: any): AdminSendNotificationDto {
+    return AdminSendNotificationDtoToJSONTyped(json, false);
+}
+
+export function AdminSendNotificationDtoToJSONTyped(value?: AdminSendNotificationDto | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'title': value['title'],
+        'message': value['message'],
+        'type': NotificationTypeEnumToJSON(value['type']),
+        'target': NotificationTargetEnumToJSON(value['target']),
+        'userId': value['userId'],
+    };
+}
+

package/src/models/AdminSendNotificationResponse.ts

@@ -0,0 +1,83 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface AdminSendNotificationResponse
+ */
+export interface AdminSendNotificationResponse {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof AdminSendNotificationResponse
+     */
+    success: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof AdminSendNotificationResponse
+     */
+    error?: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof AdminSendNotificationResponse
+     */
+    data: object;
+}
+
+/**
+ * Check if a given object implements the AdminSendNotificationResponse interface.
+ */
+export function instanceOfAdminSendNotificationResponse(value: object): value is AdminSendNotificationResponse {
+    if (!('success' in value) || value['success'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function AdminSendNotificationResponseFromJSON(json: any): AdminSendNotificationResponse {
+    return AdminSendNotificationResponseFromJSONTyped(json, false);
+}
+
+export function AdminSendNotificationResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): AdminSendNotificationResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'success': json['success'],
+        'error': json['error'] == null ? undefined : json['error'],
+        'data': json['data'],
+    };
+}
+
+export function AdminSendNotificationResponseToJSON(json: any): AdminSendNotificationResponse {
+    return AdminSendNotificationResponseToJSONTyped(json, false);
+}
+
+export function AdminSendNotificationResponseToJSONTyped(value?: AdminSendNotificationResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'success': value['success'],
+        'error': value['error'],
+        'data': value['data'],
+    };
+}
+