electric-coop-api 0.1.7 → 0.1.8

package/.openapi-generator/FILES

@@ -16,6 +16,7 @@ src/apis/ConsumersApi.ts
 src/apis/DashboardApi.ts
 src/apis/MetersApi.ts
 src/apis/NotificationsApi.ts
+src/apis/RateAdjustmentsApi.ts
 src/apis/RateDisplayApi.ts
 src/apis/RatesApi.ts
 src/apis/UsersApi.ts
@@ -25,6 +26,7 @@ src/models/Account.ts
 src/models/AccountDto.ts
 src/models/AccountList.ts
 src/models/AccountListDto.ts
+src/models/ActivateRateDisplayVersionResponse.ts
 src/models/AdminLoginDto.ts
 src/models/ApproveRateAdjustmentDto.ts
 src/models/AuthAdminLoginResponse.ts
@@ -65,12 +67,14 @@ src/models/ConsumersSuccessResponse.ts
 src/models/CreateBillDto.ts
 src/models/CreateConsumerDto.ts
 src/models/CreateRateAdjustmentDto.ts
+src/models/CreateRateDisplayVersionDto.ts
+src/models/CreateRateDisplayVersionResponse.ts
 src/models/CreateServiceRequestDto.ts
 src/models/CreateUserDto.ts
 src/models/DashboardStatsResponse.ts
 src/models/DashboardStatsResponseDto.ts
-src/models/ElectricityRate.ts
-src/models/ElectricityRatesSuccessResponse.ts
+src/models/DeleteRateDisplayStructureResponse.ts
+src/models/DeleteRateDisplayVersionResponse.ts
 src/models/LastReadingDto.ts
 src/models/LoginDto.ts
 src/models/LogoutDto.ts
@@ -88,12 +92,22 @@ src/models/PaginatedResponseDto.ts
 src/models/PaginatedStaffUsers.ts
 src/models/PaginatedUsers.ts
 src/models/PaginationMetaDto.ts
+src/models/Rate.ts
 src/models/RateAdjustment.ts
 src/models/RateAdjustmentChargeDto.ts
 src/models/RateAdjustmentStatusEnum.ts
 src/models/RateAdjustmentsSuccessResponse.ts
+src/models/RateCategoryDto.ts
 src/models/RateChargeTypeEnum.ts
+src/models/RateDisplayConfig.ts
+src/models/RateDisplayDeleteResponseDto.ts
+src/models/RateDisplayStructureDto.ts
+src/models/RateDisplayStructureResponse.ts
+src/models/RateDisplayVersionResponse.ts
+src/models/RateDisplayVersionsResponse.ts
+src/models/RateSectionDto.ts
 src/models/RateStatusEnum.ts
+src/models/RatesSuccessResponse.ts
 src/models/ReadingHistoryItemDto.ts
 src/models/RefreshTokenDto.ts
 src/models/RefreshTokenResponse.ts
@@ -107,6 +121,8 @@ src/models/TenantStatusEnum.ts
 src/models/UpdateBillDto.ts
 src/models/UpdateComplaintDto.ts
 src/models/UpdateConsumerDto.ts
+src/models/UpdateRateDisplayStructureDto.ts
+src/models/UpdateRateDisplayStructureResponse.ts
 src/models/UpdateServiceRequestDto.ts
 src/models/UpdateUserDto.ts
 src/models/User.ts

package/README.md

@@ -1,4 +1,4 @@
-## electric-coop-api@0.1.7
+## electric-coop-api@0.1.8
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install electric-coop-api@0.1.7 --save
+npm install electric-coop-api@0.1.8 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/RateAdjustmentsApi.d.ts

@@ -0,0 +1,150 @@
+/**
+ * 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 { ApproveRateAdjustmentDto, CreateRateAdjustmentDto, RateAdjustmentStatusEnum, RateAdjustmentsSuccessResponse, RejectRateAdjustmentDto } from '../models/index';
+export interface ApproveRateAdjustmentRequest {
+    id: string;
+    approveRateAdjustmentDto: ApproveRateAdjustmentDto;
+}
+export interface CreateRateAdjustmentRequest {
+    createRateAdjustmentDto: CreateRateAdjustmentDto;
+}
+export interface GetRateAdjustmentsRequest {
+    status?: RateAdjustmentStatusEnum;
+}
+export interface ReapplyRateAdjustmentRequest {
+    id: string;
+}
+export interface RejectRateAdjustmentRequest {
+    id: string;
+    rejectRateAdjustmentDto: RejectRateAdjustmentDto;
+}
+/**
+ * RateAdjustmentsApi - interface
+ *
+ * @export
+ * @interface RateAdjustmentsApiInterface
+ */
+export interface RateAdjustmentsApiInterface {
+    /**
+     *
+     * @summary Approve rate adjustment
+     * @param {string} id
+     * @param {ApproveRateAdjustmentDto} approveRateAdjustmentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RateAdjustmentsApiInterface
+     */
+    approveRateAdjustmentRaw(requestParameters: ApproveRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RateAdjustmentsSuccessResponse>>;
+    /**
+     * Approve rate adjustment
+     */
+    approveRateAdjustment(requestParameters: ApproveRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RateAdjustmentsSuccessResponse>;
+    /**
+     *
+     * @summary Create rate adjustment
+     * @param {CreateRateAdjustmentDto} createRateAdjustmentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RateAdjustmentsApiInterface
+     */
+    createRateAdjustmentRaw(requestParameters: CreateRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RateAdjustmentsSuccessResponse>>;
+    /**
+     * Create rate adjustment
+     */
+    createRateAdjustment(requestParameters: CreateRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RateAdjustmentsSuccessResponse>;
+    /**
+     *
+     * @summary List rate adjustments
+     * @param {RateAdjustmentStatusEnum} [status]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RateAdjustmentsApiInterface
+     */
+    getRateAdjustmentsRaw(requestParameters: GetRateAdjustmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RateAdjustmentsSuccessResponse>>;
+    /**
+     * List rate adjustments
+     */
+    getRateAdjustments(requestParameters: GetRateAdjustmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RateAdjustmentsSuccessResponse>;
+    /**
+     *
+     * @summary Reapply approved rate adjustment
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RateAdjustmentsApiInterface
+     */
+    reapplyRateAdjustmentRaw(requestParameters: ReapplyRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Reapply approved rate adjustment
+     */
+    reapplyRateAdjustment(requestParameters: ReapplyRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @summary Reject rate adjustment
+     * @param {string} id
+     * @param {RejectRateAdjustmentDto} rejectRateAdjustmentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof RateAdjustmentsApiInterface
+     */
+    rejectRateAdjustmentRaw(requestParameters: RejectRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RateAdjustmentsSuccessResponse>>;
+    /**
+     * Reject rate adjustment
+     */
+    rejectRateAdjustment(requestParameters: RejectRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RateAdjustmentsSuccessResponse>;
+}
+/**
+ *
+ */
+export declare class RateAdjustmentsApi extends runtime.BaseAPI implements RateAdjustmentsApiInterface {
+    /**
+     * Approve rate adjustment
+     */
+    approveRateAdjustmentRaw(requestParameters: ApproveRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RateAdjustmentsSuccessResponse>>;
+    /**
+     * Approve rate adjustment
+     */
+    approveRateAdjustment(requestParameters: ApproveRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RateAdjustmentsSuccessResponse>;
+    /**
+     * Create rate adjustment
+     */
+    createRateAdjustmentRaw(requestParameters: CreateRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RateAdjustmentsSuccessResponse>>;
+    /**
+     * Create rate adjustment
+     */
+    createRateAdjustment(requestParameters: CreateRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RateAdjustmentsSuccessResponse>;
+    /**
+     * List rate adjustments
+     */
+    getRateAdjustmentsRaw(requestParameters: GetRateAdjustmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RateAdjustmentsSuccessResponse>>;
+    /**
+     * List rate adjustments
+     */
+    getRateAdjustments(requestParameters?: GetRateAdjustmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RateAdjustmentsSuccessResponse>;
+    /**
+     * Reapply approved rate adjustment
+     */
+    reapplyRateAdjustmentRaw(requestParameters: ReapplyRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Reapply approved rate adjustment
+     */
+    reapplyRateAdjustment(requestParameters: ReapplyRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reject rate adjustment
+     */
+    rejectRateAdjustmentRaw(requestParameters: RejectRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RateAdjustmentsSuccessResponse>>;
+    /**
+     * Reject rate adjustment
+     */
+    rejectRateAdjustment(requestParameters: RejectRateAdjustmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RateAdjustmentsSuccessResponse>;
+}

package/dist/apis/RateAdjustmentsApi.js

@@ -0,0 +1,227 @@
+"use strict";
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateAdjustmentsApi = void 0;
+const runtime = require("../runtime");
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class RateAdjustmentsApi extends runtime.BaseAPI {
+    /**
+     * Approve rate adjustment
+     */
+    approveRateAdjustmentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling approveRateAdjustment().');
+            }
+            if (requestParameters['approveRateAdjustmentDto'] == null) {
+                throw new runtime.RequiredError('approveRateAdjustmentDto', 'Required parameter "approveRateAdjustmentDto" was null or undefined when calling approveRateAdjustment().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearer", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/api/v1/rate-adjustments/{id}/approve`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.ApproveRateAdjustmentDtoToJSON)(requestParameters['approveRateAdjustmentDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RateAdjustmentsSuccessResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Approve rate adjustment
+     */
+    approveRateAdjustment(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.approveRateAdjustmentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Create rate adjustment
+     */
+    createRateAdjustmentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createRateAdjustmentDto'] == null) {
+                throw new runtime.RequiredError('createRateAdjustmentDto', 'Required parameter "createRateAdjustmentDto" was null or undefined when calling createRateAdjustment().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearer", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/api/v1/rate-adjustments`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.CreateRateAdjustmentDtoToJSON)(requestParameters['createRateAdjustmentDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RateAdjustmentsSuccessResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Create rate adjustment
+     */
+    createRateAdjustment(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createRateAdjustmentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * List rate adjustments
+     */
+    getRateAdjustmentsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            if (requestParameters['status'] != null) {
+                queryParameters['status'] = requestParameters['status'];
+            }
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearer", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/api/v1/rate-adjustments`;
+            const response = yield this.request({
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RateAdjustmentsSuccessResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * List rate adjustments
+     */
+    getRateAdjustments() {
+        return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
+            const response = yield this.getRateAdjustmentsRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Reapply approved rate adjustment
+     */
+    reapplyRateAdjustmentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling reapplyRateAdjustment().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearer", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/api/v1/rate-adjustments/{id}/reapply`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            }, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Reapply approved rate adjustment
+     */
+    reapplyRateAdjustment(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.reapplyRateAdjustmentRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Reject rate adjustment
+     */
+    rejectRateAdjustmentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['id'] == null) {
+                throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling rejectRateAdjustment().');
+            }
+            if (requestParameters['rejectRateAdjustmentDto'] == null) {
+                throw new runtime.RequiredError('rejectRateAdjustmentDto', 'Required parameter "rejectRateAdjustmentDto" was null or undefined when calling rejectRateAdjustment().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearer", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/api/v1/rate-adjustments/{id}/reject`;
+            urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+            const response = yield this.request({
+                path: urlPath,
+                method: 'PUT',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.RejectRateAdjustmentDtoToJSON)(requestParameters['rejectRateAdjustmentDto']),
+            }, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RateAdjustmentsSuccessResponseFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Reject rate adjustment
+     */
+    rejectRateAdjustment(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.rejectRateAdjustmentRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.RateAdjustmentsApi = RateAdjustmentsApi;