electric-coop-api 0.1.49 → 0.1.52

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (68) hide show
  1. package/.openapi-generator/FILES +9 -0
  2. package/README.md +2 -2
  3. package/dist/apis/AdminAuditLogsApi.d.ts +84 -0
  4. package/dist/apis/AdminAuditLogsApi.js +123 -0
  5. package/dist/apis/AdminNotificationsApi.d.ts +50 -0
  6. package/dist/apis/AdminNotificationsApi.js +71 -0
  7. package/dist/apis/AdminWorkOrdersApi.d.ts +3 -1
  8. package/dist/apis/AdminWorkOrdersApi.js +3 -0
  9. package/dist/apis/index.d.ts +2 -0
  10. package/dist/apis/index.js +2 -0
  11. package/dist/esm/apis/AdminAuditLogsApi.d.ts +84 -0
  12. package/dist/esm/apis/AdminAuditLogsApi.js +119 -0
  13. package/dist/esm/apis/AdminNotificationsApi.d.ts +50 -0
  14. package/dist/esm/apis/AdminNotificationsApi.js +67 -0
  15. package/dist/esm/apis/AdminWorkOrdersApi.d.ts +3 -1
  16. package/dist/esm/apis/AdminWorkOrdersApi.js +3 -0
  17. package/dist/esm/apis/index.d.ts +2 -0
  18. package/dist/esm/apis/index.js +2 -0
  19. package/dist/esm/models/AdminAuditLogsPaginatedResponse.d.ts +52 -0
  20. package/dist/esm/models/AdminAuditLogsPaginatedResponse.js +55 -0
  21. package/dist/esm/models/AdminSendNotificationDto.d.ts +58 -0
  22. package/dist/esm/models/AdminSendNotificationDto.js +59 -0
  23. package/dist/esm/models/AdminSendNotificationResponse.d.ts +44 -0
  24. package/dist/esm/models/AdminSendNotificationResponse.js +49 -0
  25. package/dist/esm/models/AuditLog.d.ts +98 -0
  26. package/dist/esm/models/AuditLog.js +79 -0
  27. package/dist/esm/models/AuditLogEntityTypeFilterDto.d.ts +38 -0
  28. package/dist/esm/models/AuditLogEntityTypeFilterDto.js +47 -0
  29. package/dist/esm/models/AuditLogsFiltersResponseDto.d.ts +33 -0
  30. package/dist/esm/models/AuditLogsFiltersResponseDto.js +44 -0
  31. package/dist/esm/models/NotificationTargetEnum.d.ts +27 -0
  32. package/dist/esm/models/NotificationTargetEnum.js +45 -0
  33. package/dist/esm/models/UpdateWorkOrderDto.d.ts +6 -0
  34. package/dist/esm/models/UpdateWorkOrderDto.js +2 -0
  35. package/dist/esm/models/index.d.ts +7 -0
  36. package/dist/esm/models/index.js +7 -0
  37. package/dist/models/AdminAuditLogsPaginatedResponse.d.ts +52 -0
  38. package/dist/models/AdminAuditLogsPaginatedResponse.js +62 -0
  39. package/dist/models/AdminSendNotificationDto.d.ts +58 -0
  40. package/dist/models/AdminSendNotificationDto.js +66 -0
  41. package/dist/models/AdminSendNotificationResponse.d.ts +44 -0
  42. package/dist/models/AdminSendNotificationResponse.js +56 -0
  43. package/dist/models/AuditLog.d.ts +98 -0
  44. package/dist/models/AuditLog.js +86 -0
  45. package/dist/models/AuditLogEntityTypeFilterDto.d.ts +38 -0
  46. package/dist/models/AuditLogEntityTypeFilterDto.js +54 -0
  47. package/dist/models/AuditLogsFiltersResponseDto.d.ts +33 -0
  48. package/dist/models/AuditLogsFiltersResponseDto.js +51 -0
  49. package/dist/models/NotificationTargetEnum.d.ts +27 -0
  50. package/dist/models/NotificationTargetEnum.js +53 -0
  51. package/dist/models/UpdateWorkOrderDto.d.ts +6 -0
  52. package/dist/models/UpdateWorkOrderDto.js +2 -0
  53. package/dist/models/index.d.ts +7 -0
  54. package/dist/models/index.js +7 -0
  55. package/package.json +1 -1
  56. package/src/apis/AdminAuditLogsApi.ts +198 -0
  57. package/src/apis/AdminNotificationsApi.ts +111 -0
  58. package/src/apis/AdminWorkOrdersApi.ts +7 -1
  59. package/src/apis/index.ts +2 -0
  60. package/src/models/AdminAuditLogsPaginatedResponse.ts +107 -0
  61. package/src/models/AdminSendNotificationDto.ts +118 -0
  62. package/src/models/AdminSendNotificationResponse.ts +83 -0
  63. package/src/models/AuditLog.ts +161 -0
  64. package/src/models/AuditLogEntityTypeFilterDto.ts +75 -0
  65. package/src/models/AuditLogsFiltersResponseDto.ts +74 -0
  66. package/src/models/NotificationTargetEnum.ts +55 -0
  67. package/src/models/UpdateWorkOrderDto.ts +8 -0
  68. package/src/models/index.ts +7 -0
@@ -0,0 +1,161 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Electric Cooperative Consumer Portal API
5
+ * Multi-tenant SaaS platform for Philippine electric cooperatives
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface AuditLog
20
+ */
21
+ export interface AuditLog {
22
+ /**
23
+ *
24
+ * @type {string}
25
+ * @memberof AuditLog
26
+ */
27
+ id: string;
28
+ /**
29
+ *
30
+ * @type {Date}
31
+ * @memberof AuditLog
32
+ */
33
+ createdAt: Date;
34
+ /**
35
+ *
36
+ * @type {Date}
37
+ * @memberof AuditLog
38
+ */
39
+ updatedAt: Date;
40
+ /**
41
+ *
42
+ * @type {Date}
43
+ * @memberof AuditLog
44
+ */
45
+ deletedAt?: Date;
46
+ /**
47
+ *
48
+ * @type {string}
49
+ * @memberof AuditLog
50
+ */
51
+ tenantId: string;
52
+ /**
53
+ *
54
+ * @type {string}
55
+ * @memberof AuditLog
56
+ */
57
+ userId: string;
58
+ /**
59
+ *
60
+ * @type {string}
61
+ * @memberof AuditLog
62
+ */
63
+ actorEmail?: string;
64
+ /**
65
+ * CREATE | UPDATE | ASSIGN | STATUS_CHANGE
66
+ * @type {string}
67
+ * @memberof AuditLog
68
+ */
69
+ action: string;
70
+ /**
71
+ * outage | work_order
72
+ * @type {string}
73
+ * @memberof AuditLog
74
+ */
75
+ entityType: string;
76
+ /**
77
+ *
78
+ * @type {string}
79
+ * @memberof AuditLog
80
+ */
81
+ entityId: string;
82
+ /**
83
+ *
84
+ * @type {string}
85
+ * @memberof AuditLog
86
+ */
87
+ entityLabel?: string;
88
+ /**
89
+ * Before/after snapshot of changed fields
90
+ * @type {object}
91
+ * @memberof AuditLog
92
+ */
93
+ changes?: object;
94
+ }
95
+
96
+ /**
97
+ * Check if a given object implements the AuditLog interface.
98
+ */
99
+ export function instanceOfAuditLog(value: object): value is AuditLog {
100
+ if (!('id' in value) || value['id'] === undefined) return false;
101
+ if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
102
+ if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
103
+ if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
104
+ if (!('userId' in value) || value['userId'] === undefined) return false;
105
+ if (!('action' in value) || value['action'] === undefined) return false;
106
+ if (!('entityType' in value) || value['entityType'] === undefined) return false;
107
+ if (!('entityId' in value) || value['entityId'] === undefined) return false;
108
+ return true;
109
+ }
110
+
111
+ export function AuditLogFromJSON(json: any): AuditLog {
112
+ return AuditLogFromJSONTyped(json, false);
113
+ }
114
+
115
+ export function AuditLogFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuditLog {
116
+ if (json == null) {
117
+ return json;
118
+ }
119
+ return {
120
+
121
+ 'id': json['id'],
122
+ 'createdAt': (new Date(json['createdAt'])),
123
+ 'updatedAt': (new Date(json['updatedAt'])),
124
+ 'deletedAt': json['deletedAt'] == null ? undefined : (new Date(json['deletedAt'])),
125
+ 'tenantId': json['tenantId'],
126
+ 'userId': json['userId'],
127
+ 'actorEmail': json['actorEmail'] == null ? undefined : json['actorEmail'],
128
+ 'action': json['action'],
129
+ 'entityType': json['entityType'],
130
+ 'entityId': json['entityId'],
131
+ 'entityLabel': json['entityLabel'] == null ? undefined : json['entityLabel'],
132
+ 'changes': json['changes'] == null ? undefined : json['changes'],
133
+ };
134
+ }
135
+
136
+ export function AuditLogToJSON(json: any): AuditLog {
137
+ return AuditLogToJSONTyped(json, false);
138
+ }
139
+
140
+ export function AuditLogToJSONTyped(value?: AuditLog | null, ignoreDiscriminator: boolean = false): any {
141
+ if (value == null) {
142
+ return value;
143
+ }
144
+
145
+ return {
146
+
147
+ 'id': value['id'],
148
+ 'createdAt': ((value['createdAt']).toISOString()),
149
+ 'updatedAt': ((value['updatedAt']).toISOString()),
150
+ 'deletedAt': value['deletedAt'] == null ? undefined : ((value['deletedAt']).toISOString()),
151
+ 'tenantId': value['tenantId'],
152
+ 'userId': value['userId'],
153
+ 'actorEmail': value['actorEmail'],
154
+ 'action': value['action'],
155
+ 'entityType': value['entityType'],
156
+ 'entityId': value['entityId'],
157
+ 'entityLabel': value['entityLabel'],
158
+ 'changes': value['changes'],
159
+ };
160
+ }
161
+
@@ -0,0 +1,75 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Electric Cooperative Consumer Portal API
5
+ * Multi-tenant SaaS platform for Philippine electric cooperatives
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ /**
17
+ *
18
+ * @export
19
+ * @interface AuditLogEntityTypeFilterDto
20
+ */
21
+ export interface AuditLogEntityTypeFilterDto {
22
+ /**
23
+ * Entity type name
24
+ * @type {string}
25
+ * @memberof AuditLogEntityTypeFilterDto
26
+ */
27
+ entityType: string;
28
+ /**
29
+ * Actions available for this entity type
30
+ * @type {Array<string>}
31
+ * @memberof AuditLogEntityTypeFilterDto
32
+ */
33
+ actions: Array<string>;
34
+ }
35
+
36
+ /**
37
+ * Check if a given object implements the AuditLogEntityTypeFilterDto interface.
38
+ */
39
+ export function instanceOfAuditLogEntityTypeFilterDto(value: object): value is AuditLogEntityTypeFilterDto {
40
+ if (!('entityType' in value) || value['entityType'] === undefined) return false;
41
+ if (!('actions' in value) || value['actions'] === undefined) return false;
42
+ return true;
43
+ }
44
+
45
+ export function AuditLogEntityTypeFilterDtoFromJSON(json: any): AuditLogEntityTypeFilterDto {
46
+ return AuditLogEntityTypeFilterDtoFromJSONTyped(json, false);
47
+ }
48
+
49
+ export function AuditLogEntityTypeFilterDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuditLogEntityTypeFilterDto {
50
+ if (json == null) {
51
+ return json;
52
+ }
53
+ return {
54
+
55
+ 'entityType': json['entityType'],
56
+ 'actions': json['actions'],
57
+ };
58
+ }
59
+
60
+ export function AuditLogEntityTypeFilterDtoToJSON(json: any): AuditLogEntityTypeFilterDto {
61
+ return AuditLogEntityTypeFilterDtoToJSONTyped(json, false);
62
+ }
63
+
64
+ export function AuditLogEntityTypeFilterDtoToJSONTyped(value?: AuditLogEntityTypeFilterDto | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'entityType': value['entityType'],
72
+ 'actions': value['actions'],
73
+ };
74
+ }
75
+
@@ -0,0 +1,74 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Electric Cooperative Consumer Portal API
5
+ * Multi-tenant SaaS platform for Philippine electric cooperatives
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+ import { mapValues } from '../runtime';
16
+ import type { AuditLogEntityTypeFilterDto } from './AuditLogEntityTypeFilterDto';
17
+ import {
18
+ AuditLogEntityTypeFilterDtoFromJSON,
19
+ AuditLogEntityTypeFilterDtoFromJSONTyped,
20
+ AuditLogEntityTypeFilterDtoToJSON,
21
+ AuditLogEntityTypeFilterDtoToJSONTyped,
22
+ } from './AuditLogEntityTypeFilterDto';
23
+
24
+ /**
25
+ *
26
+ * @export
27
+ * @interface AuditLogsFiltersResponseDto
28
+ */
29
+ export interface AuditLogsFiltersResponseDto {
30
+ /**
31
+ * Distinct entity types and their available actions observed in the audit log
32
+ * @type {Array<AuditLogEntityTypeFilterDto>}
33
+ * @memberof AuditLogsFiltersResponseDto
34
+ */
35
+ entityTypes: Array<AuditLogEntityTypeFilterDto>;
36
+ }
37
+
38
+ /**
39
+ * Check if a given object implements the AuditLogsFiltersResponseDto interface.
40
+ */
41
+ export function instanceOfAuditLogsFiltersResponseDto(value: object): value is AuditLogsFiltersResponseDto {
42
+ if (!('entityTypes' in value) || value['entityTypes'] === undefined) return false;
43
+ return true;
44
+ }
45
+
46
+ export function AuditLogsFiltersResponseDtoFromJSON(json: any): AuditLogsFiltersResponseDto {
47
+ return AuditLogsFiltersResponseDtoFromJSONTyped(json, false);
48
+ }
49
+
50
+ export function AuditLogsFiltersResponseDtoFromJSONTyped(json: any, ignoreDiscriminator: boolean): AuditLogsFiltersResponseDto {
51
+ if (json == null) {
52
+ return json;
53
+ }
54
+ return {
55
+
56
+ 'entityTypes': ((json['entityTypes'] as Array<any>).map(AuditLogEntityTypeFilterDtoFromJSON)),
57
+ };
58
+ }
59
+
60
+ export function AuditLogsFiltersResponseDtoToJSON(json: any): AuditLogsFiltersResponseDto {
61
+ return AuditLogsFiltersResponseDtoToJSONTyped(json, false);
62
+ }
63
+
64
+ export function AuditLogsFiltersResponseDtoToJSONTyped(value?: AuditLogsFiltersResponseDto | null, ignoreDiscriminator: boolean = false): any {
65
+ if (value == null) {
66
+ return value;
67
+ }
68
+
69
+ return {
70
+
71
+ 'entityTypes': ((value['entityTypes'] as Array<any>).map(AuditLogEntityTypeFilterDtoToJSON)),
72
+ };
73
+ }
74
+
@@ -0,0 +1,55 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Electric Cooperative Consumer Portal API
5
+ * Multi-tenant SaaS platform for Philippine electric cooperatives
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ /**
17
+ * Who to send the notification to
18
+ * @export
19
+ */
20
+ export const NotificationTargetEnum = {
21
+ All: 'all',
22
+ Consumers: 'consumers',
23
+ Admins: 'admins',
24
+ User: 'user'
25
+ } as const;
26
+ export type NotificationTargetEnum = typeof NotificationTargetEnum[keyof typeof NotificationTargetEnum];
27
+
28
+
29
+ export function instanceOfNotificationTargetEnum(value: any): boolean {
30
+ for (const key in NotificationTargetEnum) {
31
+ if (Object.prototype.hasOwnProperty.call(NotificationTargetEnum, key)) {
32
+ if (NotificationTargetEnum[key as keyof typeof NotificationTargetEnum] === value) {
33
+ return true;
34
+ }
35
+ }
36
+ }
37
+ return false;
38
+ }
39
+
40
+ export function NotificationTargetEnumFromJSON(json: any): NotificationTargetEnum {
41
+ return NotificationTargetEnumFromJSONTyped(json, false);
42
+ }
43
+
44
+ export function NotificationTargetEnumFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotificationTargetEnum {
45
+ return json as NotificationTargetEnum;
46
+ }
47
+
48
+ export function NotificationTargetEnumToJSON(value?: NotificationTargetEnum | null): any {
49
+ return value as any;
50
+ }
51
+
52
+ export function NotificationTargetEnumToJSONTyped(value: any, ignoreDiscriminator: boolean): NotificationTargetEnum {
53
+ return value as NotificationTargetEnum;
54
+ }
55
+
@@ -76,6 +76,12 @@ export interface UpdateWorkOrderDto {
76
76
  * @memberof UpdateWorkOrderDto
77
77
  */
78
78
  remarks?: string;
79
+ /**
80
+ * Link or unlink a related outage
81
+ * @type {object}
82
+ * @memberof UpdateWorkOrderDto
83
+ */
84
+ outageId?: object;
79
85
  }
80
86
 
81
87
 
@@ -104,6 +110,7 @@ export function UpdateWorkOrderDtoFromJSONTyped(json: any, ignoreDiscriminator:
104
110
  'assignedTo': json['assignedTo'] == null ? undefined : json['assignedTo'],
105
111
  'location': json['location'] == null ? undefined : json['location'],
106
112
  'remarks': json['remarks'] == null ? undefined : json['remarks'],
113
+ 'outageId': json['outageId'] == null ? undefined : json['outageId'],
107
114
  };
108
115
  }
109
116
 
@@ -125,6 +132,7 @@ export function UpdateWorkOrderDtoToJSONTyped(value?: UpdateWorkOrderDto | null,
125
132
  'assignedTo': value['assignedTo'],
126
133
  'location': value['location'],
127
134
  'remarks': value['remarks'],
135
+ 'outageId': value['outageId'],
128
136
  };
129
137
  }
130
138
 
@@ -5,10 +5,13 @@ export * from './AccountDto';
5
5
  export * from './AccountList';
6
6
  export * from './AccountListDto';
7
7
  export * from './AdminAssignWorkOrderResponse';
8
+ export * from './AdminAuditLogsPaginatedResponse';
8
9
  export * from './AdminCreateWorkOrderResponse';
9
10
  export * from './AdminLoginDto';
10
11
  export * from './AdminOutageStatsResponse';
11
12
  export * from './AdminOutagesPaginatedResponse';
13
+ export * from './AdminSendNotificationDto';
14
+ export * from './AdminSendNotificationResponse';
12
15
  export * from './AdminServiceRequestResponse';
13
16
  export * from './AdminServiceRequestStatsResponse';
14
17
  export * from './AdminServiceRequestsPaginatedResponse';
@@ -19,6 +22,9 @@ export * from './AdminWorkOrderStatsResponse';
19
22
  export * from './AdminWorkOrdersPaginatedResponse';
20
23
  export * from './ApproveRateAdjustmentDto';
21
24
  export * from './AssignWorkOrderDto';
25
+ export * from './AuditLog';
26
+ export * from './AuditLogEntityTypeFilterDto';
27
+ export * from './AuditLogsFiltersResponseDto';
22
28
  export * from './AuthAdminLoginResponse';
23
29
  export * from './AuthConsumerAccountDto';
24
30
  export * from './AuthLoginResponse';
@@ -88,6 +94,7 @@ export * from './MeterStatsResponseDto';
88
94
  export * from './MeterStatsSuccessResponse';
89
95
  export * from './Notification';
90
96
  export * from './NotificationMarkedAsRead';
97
+ export * from './NotificationTargetEnum';
91
98
  export * from './NotificationTypeEnum';
92
99
  export * from './NotificationUnreadCount';
93
100
  export * from './NotificationUnreadCountResponseDto';