fams-ts 1.0.26 → 1.0.30

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.
@@ -204,6 +204,36 @@ export interface Body_upload_payment_approvals_bulk_approvals_upload_bulk__post
204
204
  processMetadata?: string;
205
205
  documentNames?: string[];
206
206
  }
207
+ export interface ChecklistItemResponse {
208
+ id: string;
209
+ label: string;
210
+ description?: string;
211
+ isRequired?: boolean;
212
+ order: number;
213
+ isChecked?: boolean;
214
+ comment?: string;
215
+ }
216
+ export interface ChecklistItemSchema {
217
+ label: string;
218
+ description?: string;
219
+ isRequired?: boolean;
220
+ order?: number;
221
+ }
222
+ export interface ChecklistResponseItemSchema {
223
+ itemId: string;
224
+ isChecked?: boolean;
225
+ comment?: string;
226
+ }
227
+ export interface ChecklistTemplateResponse {
228
+ id: string;
229
+ name: string;
230
+ departmentCode?: string;
231
+ stage?: string;
232
+ description?: string;
233
+ items?: ChecklistItemResponse[];
234
+ submittedBy?: string;
235
+ submittedAt?: string;
236
+ }
207
237
  export interface CompositeInstructionLineRequest {
208
238
  amount: number | string;
209
239
  payFrom: string;
@@ -256,9 +286,14 @@ export interface DocumentExportResponse {
256
286
  objectName: string;
257
287
  url: string;
258
288
  expiresInSeconds: number;
289
+ security: ExportSecurityMetadata;
259
290
  documentType: string;
260
291
  reference: string;
261
292
  }
293
+ export interface ExportSecurityMetadata {
294
+ verificationCode: string;
295
+ issuedAt: string;
296
+ }
262
297
  export interface FolderApprovalsResponse {
263
298
  folder: FolderResponse;
264
299
  approvals: PaymentApprovalSummaryResponse[];
@@ -450,9 +485,19 @@ export interface ReturnPaymentApprovalRequest {
450
485
  reason: string;
451
486
  targetStage?: string;
452
487
  }
488
+ export interface SetupChecklistTemplateRequest {
489
+ name: string;
490
+ departmentCode?: string;
491
+ stage?: string;
492
+ description?: string;
493
+ items?: ChecklistItemSchema[];
494
+ }
453
495
  export interface SubmitApprovalRequest {
454
496
  note?: string;
455
497
  }
498
+ export interface SubmitChecklistResponseRequest {
499
+ items: ChecklistResponseItemSchema[];
500
+ }
456
501
  export interface UpdateFolderRequest {
457
502
  name?: string;
458
503
  description?: string;
package/dist/auth.d.ts CHANGED
@@ -6,6 +6,12 @@ export interface ActiveSessionSchema {
6
6
  id: string;
7
7
  ipAddress?: string;
8
8
  userAgent?: string;
9
+ deviceFingerprint?: string;
10
+ fingerprintSource?: string;
11
+ isCurrent?: boolean;
12
+ device?: SessionDeviceSchema;
13
+ location?: SessionLocationSchema;
14
+ network?: SessionNetworkSchema;
9
15
  isRevoked: boolean;
10
16
  createdAt: string;
11
17
  expiresAt: string;
@@ -44,9 +50,11 @@ export interface HTTPValidationError {
44
50
  detail?: ValidationError[];
45
51
  }
46
52
  export interface LoginResponseSchema {
47
- session: SessionSchema;
48
- user: UserInfoSchema;
49
- stageMeta: StageMetaSchema;
53
+ session?: SessionSchema;
54
+ user?: UserInfoSchema;
55
+ stageMeta?: StageMetaSchema;
56
+ requiresTwoFactor?: boolean;
57
+ twoFactorChallenge?: TwoFactorChallengeSchema;
50
58
  }
51
59
  export interface ManagedUserRegisterSchema {
52
60
  username: string;
@@ -80,6 +88,28 @@ export interface RoleSchema {
80
88
  department?: DepartmentSchema;
81
89
  permissions?: PermissionSchema[];
82
90
  }
91
+ export interface SessionDeviceSchema {
92
+ name?: string;
93
+ type?: string;
94
+ os?: string;
95
+ browser?: string;
96
+ }
97
+ export interface SessionLocationSchema {
98
+ source?: string;
99
+ isPrivateIp?: boolean;
100
+ country?: string;
101
+ countryCode?: string;
102
+ region?: string;
103
+ city?: string;
104
+ timezone?: string;
105
+ latitude?: number;
106
+ longitude?: number;
107
+ accuracyKm?: number;
108
+ }
109
+ export interface SessionNetworkSchema {
110
+ asn?: number;
111
+ organization?: string;
112
+ }
83
113
  export interface SessionSchema {
84
114
  accessToken: string;
85
115
  refreshToken: string;
@@ -91,6 +121,40 @@ export interface StageMetaSchema {
91
121
  currentStage?: string;
92
122
  nextStages?: string[];
93
123
  }
124
+ export interface TwoFactorChallengeSchema {
125
+ method?: string;
126
+ challengeToken?: string;
127
+ expiresAt?: string;
128
+ }
129
+ export interface TwoFactorDisableSchema {
130
+ password: string;
131
+ code?: string;
132
+ recoveryCode?: string;
133
+ }
134
+ export interface TwoFactorEnableSchema {
135
+ code: string;
136
+ }
137
+ export interface TwoFactorRecoveryCodesResponseSchema {
138
+ enabled: boolean;
139
+ recoveryCodes: string[];
140
+ generatedAt: string;
141
+ }
142
+ export interface TwoFactorSetupResponseSchema {
143
+ method: string;
144
+ issuer: string;
145
+ accountName: string;
146
+ manualEntryKey: string;
147
+ provisioningUri: string;
148
+ qrCodeSvgDataUri: string;
149
+ }
150
+ export interface UpdateProfileSchema {
151
+ email?: string;
152
+ title?: string;
153
+ firstName?: string;
154
+ middleName?: string;
155
+ lastName?: string;
156
+ avatar?: string;
157
+ }
94
158
  export interface UpdateRoleSchema {
95
159
  name?: string;
96
160
  departmentId?: string;
@@ -120,6 +184,9 @@ export interface UserInfoSchema {
120
184
  department?: string;
121
185
  isActive: boolean;
122
186
  permissions?: string[];
187
+ twoFactorEnabled?: boolean;
188
+ twoFactorPendingSetup?: boolean;
189
+ twoFactorConfiguredAt?: string;
123
190
  }
124
191
  export interface UserLoginSchema {
125
192
  username: string;
@@ -147,3 +214,8 @@ export interface ValidationError {
147
214
  msg: string;
148
215
  type: string;
149
216
  }
217
+ export interface VerifyLoginTwoFactorSchema {
218
+ challengeToken: string;
219
+ code?: string;
220
+ recoveryCode?: string;
221
+ }
package/dist/budget.d.ts CHANGED
@@ -92,6 +92,9 @@ export interface BudgetHeadCreateRequest {
92
92
  subHeadNo?: string;
93
93
  itemCode?: string;
94
94
  classificationCode?: string;
95
+ thresholdEnabled?: boolean;
96
+ thresholdMode?: 'PERCENT' | 'AMOUNT';
97
+ thresholdValue?: number | string;
95
98
  }
96
99
  export interface BudgetHeadResponse {
97
100
  id: string;
@@ -106,6 +109,13 @@ export interface BudgetHeadResponse {
106
109
  commitments: string;
107
110
  totalActual: string;
108
111
  available: string;
112
+ thresholdEnabled: boolean;
113
+ thresholdMode: string;
114
+ thresholdValue?: string;
115
+ thresholdAmount?: string;
116
+ alertTriggered: boolean;
117
+ alertStatus: string;
118
+ availablePercent: string;
109
119
  }
110
120
  export interface BudgetHeadTransactionEntry {
111
121
  id: string;
@@ -135,6 +145,9 @@ export interface BudgetHeadUpdateRequest {
135
145
  subHeadNo?: string;
136
146
  itemCode?: string;
137
147
  classificationCode?: string;
148
+ thresholdEnabled?: boolean;
149
+ thresholdMode?: 'PERCENT' | 'AMOUNT';
150
+ thresholdValue?: number | string;
138
151
  }
139
152
  export interface BulkBudgetHeadCreateRequest {
140
153
  items?: BudgetHeadCreateRequest[];
@@ -162,9 +175,14 @@ export interface DocumentExportResponse {
162
175
  objectName: string;
163
176
  url: string;
164
177
  expiresInSeconds: number;
178
+ security: ExportSecurityMetadata;
165
179
  documentType: string;
166
180
  reference: string;
167
181
  }
182
+ export interface ExportSecurityMetadata {
183
+ verificationCode: string;
184
+ issuedAt: string;
185
+ }
168
186
  export interface HTTPValidationError {
169
187
  detail?: ValidationError[];
170
188
  }
@@ -206,5 +224,13 @@ export interface VoteBookResponse {
206
224
  amountAuthorised2: string;
207
225
  amountAuthorised3: string;
208
226
  amountAuthorised4: string;
227
+ amountAuthorisedActualAvailable?: string;
228
+ thresholdEnabled?: boolean;
229
+ thresholdMode?: string;
230
+ thresholdValue?: string;
231
+ thresholdAmount?: string;
232
+ alertTriggered?: boolean;
233
+ alertStatus?: string;
234
+ alertSummary?: any;
209
235
  entries: VoteBookEntryResponse[];
210
236
  }
@@ -10,9 +10,14 @@ export interface DocumentExportResponse {
10
10
  objectName: string;
11
11
  url: string;
12
12
  expiresInSeconds: number;
13
+ security: ExportSecurityMetadata;
13
14
  documentType: string;
14
15
  reference: string;
15
16
  }
17
+ export interface ExportSecurityMetadata {
18
+ verificationCode: string;
19
+ issuedAt: string;
20
+ }
16
21
  export interface HTTPValidationError {
17
22
  detail?: ValidationError[];
18
23
  }
package/dist/full.d.ts CHANGED
@@ -445,40 +445,6 @@ export interface paths {
445
445
  patch?: never;
446
446
  trace?: never;
447
447
  };
448
- "/reporting/income-statement/{period}": {
449
- parameters: {
450
- query?: never;
451
- header?: never;
452
- path?: never;
453
- cookie?: never;
454
- };
455
- /** Income Statement */
456
- get: operations["income_statement_reporting_income_statement__period__get"];
457
- put?: never;
458
- post?: never;
459
- delete?: never;
460
- options?: never;
461
- head?: never;
462
- patch?: never;
463
- trace?: never;
464
- };
465
- "/reporting/balance-sheet/{period}": {
466
- parameters: {
467
- query?: never;
468
- header?: never;
469
- path?: never;
470
- cookie?: never;
471
- };
472
- /** Balance Sheet */
473
- get: operations["balance_sheet_reporting_balance_sheet__period__get"];
474
- put?: never;
475
- post?: never;
476
- delete?: never;
477
- options?: never;
478
- head?: never;
479
- patch?: never;
480
- trace?: never;
481
- };
482
448
  "/reporting/cash-flow/{period}": {
483
449
  parameters: {
484
450
  query?: never;
@@ -1636,68 +1602,6 @@ export interface operations {
1636
1602
  };
1637
1603
  };
1638
1604
  };
1639
- income_statement_reporting_income_statement__period__get: {
1640
- parameters: {
1641
- query?: never;
1642
- header?: never;
1643
- path: {
1644
- period: string;
1645
- };
1646
- cookie?: never;
1647
- };
1648
- requestBody?: never;
1649
- responses: {
1650
- /** @description Successful Response */
1651
- 200: {
1652
- headers: {
1653
- [name: string]: unknown;
1654
- };
1655
- content: {
1656
- "application/json": unknown;
1657
- };
1658
- };
1659
- /** @description Validation Error */
1660
- 422: {
1661
- headers: {
1662
- [name: string]: unknown;
1663
- };
1664
- content: {
1665
- "application/json": components["schemas"]["HTTPValidationError"];
1666
- };
1667
- };
1668
- };
1669
- };
1670
- balance_sheet_reporting_balance_sheet__period__get: {
1671
- parameters: {
1672
- query?: never;
1673
- header?: never;
1674
- path: {
1675
- period: string;
1676
- };
1677
- cookie?: never;
1678
- };
1679
- requestBody?: never;
1680
- responses: {
1681
- /** @description Successful Response */
1682
- 200: {
1683
- headers: {
1684
- [name: string]: unknown;
1685
- };
1686
- content: {
1687
- "application/json": unknown;
1688
- };
1689
- };
1690
- /** @description Validation Error */
1691
- 422: {
1692
- headers: {
1693
- [name: string]: unknown;
1694
- };
1695
- content: {
1696
- "application/json": components["schemas"]["HTTPValidationError"];
1697
- };
1698
- };
1699
- };
1700
- };
1701
1605
  cash_flow_reporting_cash_flow__period__get: {
1702
1606
  parameters: {
1703
1607
  query?: never;
package/dist/index.d.ts CHANGED
@@ -2,12 +2,12 @@
2
2
  * Auto-generated index.
3
3
  */
4
4
  export { AccountCreateRequest, AccountResponse, Body_open_period_master_periods_open__period_code___post, HTTPValidationError, OpeningBalanceRequest, OpeningBalanceResponse, PeriodResponse, SettingsCategoryRequest, SettingsCategoryResponse, ValidationError } from './account';
5
- export { AIEDetailResponse, AIEDocumentDetailsResponse, AddApprovalCommentRequest, AddApprovalInstructionRequest, AddApprovalToFolderRequest, AddApprovalToFolderResponse, AddCompositeApprovalInstructionRequest, ApplyApprovalForexRequest, ApprovalActorResponse, ApprovalCommentResponse, ApprovalDocumentUrlResponse, ApprovalForexDetailResponse, ApprovalInstructionResponse, ApprovalStageHistoryResponse, ApprovalStatusResponse, ApprovePaymentApprovalRequest, AssignApprovalRequest, AssignmentResponse, AssignmentUserSchema, AttachmentResponse, AuthorityResponse, Body_upload_attachment_approvals__id__attach__post, Body_upload_attachments_bulk_approvals__id__attach_bulk__post, Body_upload_payment_approval_approvals_upload__post, Body_upload_payment_approvals_bulk_approvals_upload_bulk__post, CompositeInstructionLineRequest, CreateAuthorityRequest, CreateDestinationRequest, CreateFolderRequest, DeleteFolderResponse, DepartmentSummaryResponse, DestinationResponse, DocumentExportResponse, FolderApprovalsResponse, FolderMembershipResponse, FolderResponse, ForexRateLookupResponse, ForexRateOptionResponse, GLPostingResponse, InlinePaymentDestinationRequest, PaymentApprovalDetailResponse, PaymentApprovalResponse, PaymentApprovalSummaryResponse, PaymentStatusResponse, PaymentVoucherDeductionResponse, PaymentVoucherDetailResponse, PaymentVoucherDocumentDetailsResponse, PostToGLRequest, ProcessedApprovalResponse, RejectPaymentApprovalRequest, RemoveApprovalFromFolderResponse, RenameApprovalDocumentRequest, RenameApprovalDocumentResponse, ReturnPaymentApprovalRequest, SubmitApprovalRequest, UpdateFolderRequest, VoucherResponse } from './approvals';
5
+ export { AIEDetailResponse, AIEDocumentDetailsResponse, AddApprovalCommentRequest, AddApprovalInstructionRequest, AddApprovalToFolderRequest, AddApprovalToFolderResponse, AddCompositeApprovalInstructionRequest, ApplyApprovalForexRequest, ApprovalActorResponse, ApprovalCommentResponse, ApprovalDocumentUrlResponse, ApprovalForexDetailResponse, ApprovalInstructionResponse, ApprovalStageHistoryResponse, ApprovalStatusResponse, ApprovePaymentApprovalRequest, AssignApprovalRequest, AssignmentResponse, AssignmentUserSchema, AttachmentResponse, AuthorityResponse, Body_upload_attachment_approvals__id__attach__post, Body_upload_attachments_bulk_approvals__id__attach_bulk__post, Body_upload_payment_approval_approvals_upload__post, Body_upload_payment_approvals_bulk_approvals_upload_bulk__post, ChecklistItemResponse, ChecklistItemSchema, ChecklistResponseItemSchema, ChecklistTemplateResponse, CompositeInstructionLineRequest, CreateAuthorityRequest, CreateDestinationRequest, CreateFolderRequest, DeleteFolderResponse, DepartmentSummaryResponse, DestinationResponse, DocumentExportResponse, ExportSecurityMetadata, FolderApprovalsResponse, FolderMembershipResponse, FolderResponse, ForexRateLookupResponse, ForexRateOptionResponse, GLPostingResponse, InlinePaymentDestinationRequest, PaymentApprovalDetailResponse, PaymentApprovalResponse, PaymentApprovalSummaryResponse, PaymentStatusResponse, PaymentVoucherDeductionResponse, PaymentVoucherDetailResponse, PaymentVoucherDocumentDetailsResponse, PostToGLRequest, ProcessedApprovalResponse, RejectPaymentApprovalRequest, RemoveApprovalFromFolderResponse, RenameApprovalDocumentRequest, RenameApprovalDocumentResponse, ReturnPaymentApprovalRequest, SetupChecklistTemplateRequest, SubmitApprovalRequest, SubmitChecklistResponseRequest, UpdateFolderRequest, VoucherResponse } from './approvals';
6
6
  export { AssetCreateSchema, LiabilityCreateSchema, ReceivableCreateSchema } from './assets';
7
- export { ActiveSessionSchema, AssignUserRoleSchema, ChangePasswordSchema, CreateDepartmentSchema, CreatePermissionSchema, CreateRoleSchema, DepartmentSchema, LoginResponseSchema, ManagedUserRegisterSchema, PermissionSchema, RefreshTokenSchema, RolePermissionsSchema, RoleSchema, SessionSchema, StageMetaSchema, UpdateRoleSchema, UserActivitySchema, UserInfoSchema, UserLoginSchema, UserLookupSchema, UserPermissionOverrideSchema } from './auth';
7
+ export { ActiveSessionSchema, AssignUserRoleSchema, ChangePasswordSchema, CreateDepartmentSchema, CreatePermissionSchema, CreateRoleSchema, DepartmentSchema, LoginResponseSchema, ManagedUserRegisterSchema, PermissionSchema, RefreshTokenSchema, RolePermissionsSchema, RoleSchema, SessionDeviceSchema, SessionLocationSchema, SessionNetworkSchema, SessionSchema, StageMetaSchema, TwoFactorChallengeSchema, TwoFactorDisableSchema, TwoFactorEnableSchema, TwoFactorRecoveryCodesResponseSchema, TwoFactorSetupResponseSchema, UpdateProfileSchema, UpdateRoleSchema, UserActivitySchema, UserInfoSchema, UserLoginSchema, UserLookupSchema, UserPermissionOverrideSchema, VerifyLoginTwoFactorSchema } from './auth';
8
8
  export { AIECompositeLineRequest, AIEDocumentDetailsRequest, AIELineResponse, AIERequest, AIEResponse, BudgetHeadCreateRequest, BudgetHeadResponse, BudgetHeadTransactionEntry, BudgetHeadTransactionHistoryResponse, BudgetHeadUpdateRequest, BulkBudgetHeadCreateRequest, BulkBudgetHeadCreateResponse, CompositeAIERequest, UpdateAIERequest, VoteBookEntryResponse, VoteBookResponse } from './budget';
9
9
  export { PaymentLineCreateRequest, PaymentLineResponse, PaymentVoucherCreateRequest, PaymentVoucherDeductionRequest, PaymentVoucherDocumentDetailsRequest, PaymentVoucherResponse } from './expenditure';
10
10
  export { MarkReadRequest, NotificationResponse } from './notifications';
11
11
  export { ReceiptResponse, RecordReceiptRequest } from './receipts';
12
- export { ReportExportAllResponse, ReportExportResponse } from './reporting';
12
+ export { ExportVerificationDevice, ExportVerificationLocation, ExportVerificationNetwork, ExportVerificationRequestContext, ExportVerificationRequester, ExportVerificationResponse, ReportExportAllResponse, ReportExportResponse } from './reporting';
13
13
  export { BankAccountCreateSchema, BankAccountSchema, OutstandingReceiptSchema, PaymentProcessSchema, ReceiptDepositBatchCreateSchema, ReceiptDepositBatchResponse } from './treasury';
@@ -2,6 +2,74 @@
2
2
  * Auto-generated by custom Python script.
3
3
  * Do not edit manually.
4
4
  */
5
+ export interface ExportSecurityMetadata {
6
+ verificationCode: string;
7
+ issuedAt: string;
8
+ }
9
+ export interface ExportVerificationDevice {
10
+ name?: string;
11
+ type?: string;
12
+ os?: string;
13
+ browser?: string;
14
+ }
15
+ export interface ExportVerificationLocation {
16
+ source?: string;
17
+ isPrivateIp?: boolean;
18
+ country?: string;
19
+ countryCode?: string;
20
+ region?: string;
21
+ city?: string;
22
+ timezone?: string;
23
+ latitude?: number;
24
+ longitude?: number;
25
+ accuracyKm?: number;
26
+ }
27
+ export interface ExportVerificationNetwork {
28
+ asn?: number;
29
+ organization?: string;
30
+ }
31
+ export interface ExportVerificationRequestContext {
32
+ ipAddress?: string;
33
+ userAgent?: string;
34
+ deviceFingerprint?: string;
35
+ fingerprintSource?: string;
36
+ device?: ExportVerificationDevice;
37
+ location?: ExportVerificationLocation;
38
+ network?: ExportVerificationNetwork;
39
+ }
40
+ export interface ExportVerificationRequester {
41
+ userId?: string;
42
+ employeeId?: string;
43
+ departmentId?: string;
44
+ username?: string;
45
+ fullName?: string;
46
+ email?: string;
47
+ roleCode?: string;
48
+ roleName?: string;
49
+ departmentCode?: string;
50
+ departmentName?: string;
51
+ session?: ExportVerificationRequestContext;
52
+ }
53
+ export interface ExportVerificationResponse {
54
+ valid: boolean;
55
+ contentIntact: boolean;
56
+ signatureValid: boolean;
57
+ exportId: string;
58
+ scope: string;
59
+ filename: string;
60
+ format: string;
61
+ issuedAt: string;
62
+ verificationCode: string;
63
+ requesterEmployeeId: string;
64
+ requesterDepartmentId: string;
65
+ requester?: ExportVerificationRequester;
66
+ requestContext?: ExportVerificationRequestContext;
67
+ contentSha256: string;
68
+ objectName: string;
69
+ signature: string;
70
+ signatureAlgorithm: string;
71
+ issues: string[];
72
+ }
5
73
  export interface HTTPValidationError {
6
74
  detail?: ValidationError[];
7
75
  }
@@ -19,6 +87,7 @@ export interface ReportExportResponse {
19
87
  objectName: string;
20
88
  url: string;
21
89
  expiresInSeconds: number;
90
+ security: ExportSecurityMetadata;
22
91
  report: string;
23
92
  period: string;
24
93
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fams-ts",
3
- "version": "1.0.26",
3
+ "version": "1.0.30",
4
4
  "description": "TypeScript types for FAMS Backend (Auto-generated)",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",