@benup/bensdk 1.11.0 → 1.11.2

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.
@@ -1,7 +1,7 @@
1
1
  import z from 'zod';
2
2
  export declare const BenefitDefinitionSchema: z.ZodObject<{
3
3
  benefitID: z.ZodString;
4
- availableActions: z.ZodArray<z.ZodEnum<["GRANT", "REVOKE", "DEDUCTION", "RECHARGE", "BEFORE_ALL_RECHARGE", "AFTER_ALL_RECHARGE", "GRANT_DEPENDENT", "REVOKE_DEPENDENT", "DEDUCTION_FILE_INGESTION"]>, "many">;
4
+ availableActions: z.ZodArray<z.ZodEnum<["GRANT", "REVOKE", "DEDUCTION", "RECHARGE", "BEFORE_ALL_RECHARGE", "AFTER_ALL_RECHARGE", "AFTER_ALL_GRANT_REVOKE", "GRANT_DEPENDENT", "REVOKE_DEPENDENT", "DEDUCTION_FILE_INGESTION"]>, "many">;
5
5
  stateMachine: z.ZodObject<{
6
6
  GRANT: z.ZodObject<{
7
7
  REQUESTED_GRANT: z.ZodObject<{
@@ -243,12 +243,12 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
243
243
  } & {
244
244
  [k: string]: unknown;
245
245
  };
246
- DEDUCTION?: {
247
- REQUESTED_DEDUCTION?: {
246
+ BEFORE_ALL_RECHARGE?: {
247
+ REQUESTED_BEFORE_ALL_RECHARGE?: {
248
248
  next?: string;
249
249
  };
250
250
  } & {
251
- [k: string]: unknown;
251
+ [k: string]: any;
252
252
  };
253
253
  RECHARGE?: {
254
254
  REQUESTED_RECHARGE?: {
@@ -257,19 +257,19 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
257
257
  } & {
258
258
  [k: string]: unknown;
259
259
  };
260
- BEFORE_ALL_RECHARGE?: {
261
- REQUESTED_BEFORE_ALL_RECHARGE?: {
260
+ AFTER_ALL_RECHARGE?: {
261
+ REQUESTED_AFTER_ALL_RECHARGE?: {
262
262
  next?: string;
263
263
  };
264
264
  } & {
265
265
  [k: string]: any;
266
266
  };
267
- AFTER_ALL_RECHARGE?: {
268
- REQUESTED_AFTER_ALL_RECHARGE?: {
267
+ DEDUCTION?: {
268
+ REQUESTED_DEDUCTION?: {
269
269
  next?: string;
270
270
  };
271
271
  } & {
272
- [k: string]: any;
272
+ [k: string]: unknown;
273
273
  };
274
274
  GRANT_DEPENDENT?: {
275
275
  REQUESTED_GRANT_DEPENDENT?: {
@@ -307,12 +307,12 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
307
307
  } & {
308
308
  [k: string]: unknown;
309
309
  };
310
- DEDUCTION?: {
311
- REQUESTED_DEDUCTION?: {
310
+ BEFORE_ALL_RECHARGE?: {
311
+ REQUESTED_BEFORE_ALL_RECHARGE?: {
312
312
  next?: string;
313
313
  };
314
314
  } & {
315
- [k: string]: unknown;
315
+ [k: string]: any;
316
316
  };
317
317
  RECHARGE?: {
318
318
  REQUESTED_RECHARGE?: {
@@ -321,19 +321,19 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
321
321
  } & {
322
322
  [k: string]: unknown;
323
323
  };
324
- BEFORE_ALL_RECHARGE?: {
325
- REQUESTED_BEFORE_ALL_RECHARGE?: {
324
+ AFTER_ALL_RECHARGE?: {
325
+ REQUESTED_AFTER_ALL_RECHARGE?: {
326
326
  next?: string;
327
327
  };
328
328
  } & {
329
329
  [k: string]: any;
330
330
  };
331
- AFTER_ALL_RECHARGE?: {
332
- REQUESTED_AFTER_ALL_RECHARGE?: {
331
+ DEDUCTION?: {
332
+ REQUESTED_DEDUCTION?: {
333
333
  next?: string;
334
334
  };
335
335
  } & {
336
- [k: string]: any;
336
+ [k: string]: unknown;
337
337
  };
338
338
  GRANT_DEPENDENT?: {
339
339
  REQUESTED_GRANT_DEPENDENT?: {
@@ -385,20 +385,20 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
385
385
  }, "strip", z.ZodTypeAny, {
386
386
  GRANT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
387
387
  REVOKE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
388
- DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
389
- RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
390
388
  BEFORE_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
389
+ RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
391
390
  AFTER_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
391
+ DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
392
392
  GRANT_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
393
393
  REVOKE_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
394
394
  DEDUCTION_FILE_INGESTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
395
395
  }, {
396
396
  GRANT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
397
397
  REVOKE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
398
- DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
399
- RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
400
398
  BEFORE_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
399
+ RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
401
400
  AFTER_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
401
+ DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
402
402
  GRANT_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
403
403
  REVOKE_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
404
404
  DEDUCTION_FILE_INGESTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
@@ -413,10 +413,10 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
413
413
  log?: {
414
414
  GRANT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
415
415
  REVOKE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
416
- DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
417
- RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
418
416
  BEFORE_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
417
+ RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
419
418
  AFTER_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
419
+ DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
420
420
  GRANT_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
421
421
  REVOKE_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
422
422
  DEDUCTION_FILE_INGESTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
@@ -431,10 +431,10 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
431
431
  log?: {
432
432
  GRANT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
433
433
  REVOKE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
434
- DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
435
- RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
436
434
  BEFORE_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
435
+ RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
437
436
  AFTER_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
437
+ DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
438
438
  GRANT_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
439
439
  REVOKE_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
440
440
  DEDUCTION_FILE_INGESTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
@@ -442,7 +442,7 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
442
442
  }>;
443
443
  }, "strict", z.ZodTypeAny, {
444
444
  benefitID?: string;
445
- availableActions?: ("GRANT" | "REVOKE" | "DEDUCTION" | "RECHARGE" | "BEFORE_ALL_RECHARGE" | "AFTER_ALL_RECHARGE" | "GRANT_DEPENDENT" | "REVOKE_DEPENDENT" | "DEDUCTION_FILE_INGESTION")[];
445
+ availableActions?: ("GRANT" | "REVOKE" | "BEFORE_ALL_RECHARGE" | "RECHARGE" | "AFTER_ALL_RECHARGE" | "DEDUCTION" | "GRANT_DEPENDENT" | "REVOKE_DEPENDENT" | "AFTER_ALL_GRANT_REVOKE" | "DEDUCTION_FILE_INGESTION")[];
446
446
  stateMachine?: {
447
447
  GRANT?: {
448
448
  REQUESTED_GRANT?: {
@@ -458,12 +458,12 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
458
458
  } & {
459
459
  [k: string]: unknown;
460
460
  };
461
- DEDUCTION?: {
462
- REQUESTED_DEDUCTION?: {
461
+ BEFORE_ALL_RECHARGE?: {
462
+ REQUESTED_BEFORE_ALL_RECHARGE?: {
463
463
  next?: string;
464
464
  };
465
465
  } & {
466
- [k: string]: unknown;
466
+ [k: string]: any;
467
467
  };
468
468
  RECHARGE?: {
469
469
  REQUESTED_RECHARGE?: {
@@ -472,19 +472,19 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
472
472
  } & {
473
473
  [k: string]: unknown;
474
474
  };
475
- BEFORE_ALL_RECHARGE?: {
476
- REQUESTED_BEFORE_ALL_RECHARGE?: {
475
+ AFTER_ALL_RECHARGE?: {
476
+ REQUESTED_AFTER_ALL_RECHARGE?: {
477
477
  next?: string;
478
478
  };
479
479
  } & {
480
480
  [k: string]: any;
481
481
  };
482
- AFTER_ALL_RECHARGE?: {
483
- REQUESTED_AFTER_ALL_RECHARGE?: {
482
+ DEDUCTION?: {
483
+ REQUESTED_DEDUCTION?: {
484
484
  next?: string;
485
485
  };
486
486
  } & {
487
- [k: string]: any;
487
+ [k: string]: unknown;
488
488
  };
489
489
  GRANT_DEPENDENT?: {
490
490
  REQUESTED_GRANT_DEPENDENT?: {
@@ -518,10 +518,10 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
518
518
  log?: {
519
519
  GRANT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
520
520
  REVOKE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
521
- DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
522
- RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
523
521
  BEFORE_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
522
+ RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
524
523
  AFTER_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
524
+ DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
525
525
  GRANT_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
526
526
  REVOKE_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
527
527
  DEDUCTION_FILE_INGESTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
@@ -529,7 +529,7 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
529
529
  };
530
530
  }, {
531
531
  benefitID?: string;
532
- availableActions?: ("GRANT" | "REVOKE" | "DEDUCTION" | "RECHARGE" | "BEFORE_ALL_RECHARGE" | "AFTER_ALL_RECHARGE" | "GRANT_DEPENDENT" | "REVOKE_DEPENDENT" | "DEDUCTION_FILE_INGESTION")[];
532
+ availableActions?: ("GRANT" | "REVOKE" | "BEFORE_ALL_RECHARGE" | "RECHARGE" | "AFTER_ALL_RECHARGE" | "DEDUCTION" | "GRANT_DEPENDENT" | "REVOKE_DEPENDENT" | "AFTER_ALL_GRANT_REVOKE" | "DEDUCTION_FILE_INGESTION")[];
533
533
  stateMachine?: {
534
534
  GRANT?: {
535
535
  REQUESTED_GRANT?: {
@@ -545,12 +545,12 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
545
545
  } & {
546
546
  [k: string]: unknown;
547
547
  };
548
- DEDUCTION?: {
549
- REQUESTED_DEDUCTION?: {
548
+ BEFORE_ALL_RECHARGE?: {
549
+ REQUESTED_BEFORE_ALL_RECHARGE?: {
550
550
  next?: string;
551
551
  };
552
552
  } & {
553
- [k: string]: unknown;
553
+ [k: string]: any;
554
554
  };
555
555
  RECHARGE?: {
556
556
  REQUESTED_RECHARGE?: {
@@ -559,19 +559,19 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
559
559
  } & {
560
560
  [k: string]: unknown;
561
561
  };
562
- BEFORE_ALL_RECHARGE?: {
563
- REQUESTED_BEFORE_ALL_RECHARGE?: {
562
+ AFTER_ALL_RECHARGE?: {
563
+ REQUESTED_AFTER_ALL_RECHARGE?: {
564
564
  next?: string;
565
565
  };
566
566
  } & {
567
567
  [k: string]: any;
568
568
  };
569
- AFTER_ALL_RECHARGE?: {
570
- REQUESTED_AFTER_ALL_RECHARGE?: {
569
+ DEDUCTION?: {
570
+ REQUESTED_DEDUCTION?: {
571
571
  next?: string;
572
572
  };
573
573
  } & {
574
- [k: string]: any;
574
+ [k: string]: unknown;
575
575
  };
576
576
  GRANT_DEPENDENT?: {
577
577
  REQUESTED_GRANT_DEPENDENT?: {
@@ -605,10 +605,10 @@ export declare const BenefitDefinitionSchema: z.ZodObject<{
605
605
  log?: {
606
606
  GRANT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
607
607
  REVOKE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
608
- DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
609
- RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
610
608
  BEFORE_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
609
+ RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
611
610
  AFTER_ALL_RECHARGE?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
611
+ DEDUCTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
612
612
  GRANT_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
613
613
  REVOKE_DEPENDENT?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
614
614
  DEDUCTION_FILE_INGESTION?: z.ZodObject<z.ZodRawShape, z.UnknownKeysParam, z.ZodTypeAny, unknown, unknown>;
@@ -2,6 +2,7 @@ import z from 'zod';
2
2
  import { AxiosInstance } from 'axios';
3
3
  import { BenefitDefinitionSchema } from '../schemas/benefit-definition.schema';
4
4
  import { TokenHelper } from './lib/token-helper.lib.type';
5
+ import { StateHandlerCtx, WebhookRequest, WebhookResponse } from './state-handler.types';
5
6
  type Base = z.infer<typeof BenefitDefinitionSchema>;
6
7
  export type AuthHandlerCtx = {
7
8
  tokenHelper: TokenHelper;
@@ -27,8 +28,11 @@ export type BenefitDefinition = Omit<Base, 'stateMachine'> & {
27
28
  };
28
29
  } & any;
29
30
  };
31
+ webhook?: {
32
+ handler: (request: WebhookRequest<any>, ctx: StateHandlerCtx) => Promise<WebhookResponse>;
33
+ };
30
34
  auth?: {
31
- handler: (credentials: any, ctx: AuthHandlerCtx) => Promise<AuthHandlerResult>;
35
+ handler: (credentials: any, ctx: any) => Promise<AuthHandlerResult>;
32
36
  };
33
37
  };
34
38
  export {};
@@ -0,0 +1,5 @@
1
+ export interface ActionHelper {
2
+ findByContext: (ctx: any) => Promise<any[]>;
3
+ findByExecutionID: (executionID: string) => Promise<any[]>;
4
+ updateOne: (state: string, logs: any, body: any, action: any) => Promise<void>;
5
+ }
@@ -1,10 +1,12 @@
1
- import { Message } from '@aws-sdk/client-sqs';
1
+ import { Message, SendMessageCommandOutput } from '@aws-sdk/client-sqs';
2
2
  import { AxiosInstance } from 'axios';
3
3
  import pino from 'pino';
4
4
  import z from 'zod';
5
5
  import { HandlerResponse } from '../lib/consumer';
6
6
  import ActionConsumerMessageSchema from '../schemas/action-consumer/message.schema';
7
+ import { DataPoint, DataPointContext } from './../../shared/lib/consumer/datapoint/index.js';
7
8
  import { BenefitDefinition } from './benefit-definition.types';
9
+ import { ActionHelper } from './lib/action-helper.lib.type.js';
8
10
  import { DeductionFileIngestionHelper } from './lib/deduction-file-ingestion.lib.type.js';
9
11
  export type MessageBody = z.infer<typeof ActionConsumerMessageSchema>;
10
12
  export interface StateHandlerResponse<TLogs, TCtx> {
@@ -15,6 +17,15 @@ export interface StateHandlerResponse<TLogs, TCtx> {
15
17
  ctx?: TCtx;
16
18
  };
17
19
  }
20
+ export interface WebhookRequest<TBody> {
21
+ url: string;
22
+ headers: Record<string, string>;
23
+ body: TBody;
24
+ }
25
+ export interface WebhookResponse {
26
+ status: number;
27
+ body: any;
28
+ }
18
29
  export interface StateHandlerCtx {
19
30
  /**
20
31
  * The raw message object received from sqs
@@ -55,11 +66,23 @@ export interface StateHandlerCtx {
55
66
  /**
56
67
  * benefitPartnerAPI Axios instance
57
68
  */
58
- benefitPartnerAPI: AxiosInstance;
69
+ benefitPartnerAPI?: AxiosInstance;
59
70
  /**
60
71
  * deductionFileIngestionHelper
61
72
  */
62
- deductionFileIngestionHelper: DeductionFileIngestionHelper;
73
+ deductionFileIngestionHelper?: DeductionFileIngestionHelper;
74
+ /**
75
+ * actionHelper
76
+ */
77
+ actionHelper?: ActionHelper;
78
+ /**
79
+ * send message to a queue
80
+ */
81
+ sendMessage?: (queueUrl: string, message: object, executionID?: string) => Promise<SendMessageCommandOutput>;
82
+ /**
83
+ * Create a DataPointContext object with the provided mapping
84
+ */
85
+ createDataPointContext?: (dataPoint: DataPoint, meta?: Record<string, string>) => DataPointContext;
63
86
  }
64
87
  /**
65
88
  * State Handler
@@ -0,0 +1,189 @@
1
+ # Action Fields Documentation
2
+
3
+ Este documento lista todos os campos presentes nas diferentes actions do sistema.
4
+
5
+ **Legenda:**
6
+
7
+ - 🔵 Campo compartilhado entre múltiplas actions
8
+ - 🟢 Campo específico de uma action
9
+
10
+ **Actions documentadas:** GRANT, RECHARGE, DEDUCTION, REVOKE
11
+
12
+ ## 🔵 Campos Compartilhados
13
+
14
+ Campos presentes em múltiplas actions.
15
+
16
+ | Campo | Tipo | Actions | Exemplo | Descrição |
17
+ | ------------------------------------------------------------------------------------------------------ | ------- | ---------------------------------- | ------------------------------------------------------------------ | --------- |
18
+ | `_id` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "683877a6e780f979be00048c" | |
19
+ | `action` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "GRANT" | |
20
+ | `batchID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "e05db2a3-9f9e-45c3-a5a9-f2d77bb47647" | |
21
+ | `benefitID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "NEW_VALUE" | |
22
+ | `createdAt` | Date | DEDUCTION, GRANT, RECHARGE, REVOKE | Date("2025-05-29T15:05:10.431Z") | |
23
+ | `eligibilityOptions.externalBenefitID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "NV101.1" | |
24
+ | `eligibilityOptions.plan.externalPorductID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "NV101.1" | |
25
+ | `eligibilityOptions.plan.name` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "CLUBE DE BENEFICIOS" | |
26
+ | `executionID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "e05db2a3-9f9e-45c3-a5a9-f2d77bb47647" | |
27
+ | `fingerprint` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "870036743251b6e8ada273819175df6379e18142e35ffd04d696bd2b68be9d31" | |
28
+ | `origin` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "test" | |
29
+ | `parentActionID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
30
+ | `planApprovalStatus` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "APPROVED" | |
31
+ | `planID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
32
+ | `requiresPlanApproval` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
33
+ | `state` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "INITIAL" | |
34
+ | `target.company._id` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "678016b2410559c21dd53226" | |
35
+ | `target.company.accountID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "681b75421180f14cd49dafc1" | |
36
+ | `target.company.address.city` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
37
+ | `target.company.address.complement` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
38
+ | `target.company.address.country` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
39
+ | `target.company.address.neighborhood` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
40
+ | `target.company.address.number` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
41
+ | `target.company.address.state` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
42
+ | `target.company.address.street` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
43
+ | `target.company.address.zipCode` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
44
+ | `target.company.businessName` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "RD Saude" | |
45
+ | `target.company.cnpj` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "61.585.865/0001-51" | |
46
+ | `target.company.createdAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "2025-01-09T18:34:26.466Z" | |
47
+ | `target.company.externalCompanyID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
48
+ | `target.company.tradeName` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "Raia Drogasil S/A" | |
49
+ | `target.company.updatedAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
50
+ | `target.dependent.benefits.DUMMY.isEligible` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
51
+ | `target.dependent.benefits.DUMMY.status` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "ENABLED" | |
52
+ | `target.dependent.benefits.DUMMY.statusOriginID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
53
+ | `target.dependent.benefits.DUMMY.value` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
54
+ | `target.dependent.birthDate` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
55
+ | `target.dependent.cpf` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
56
+ | `target.dependent.externalDependentCode` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
57
+ | `target.dependent.externalDependentID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
58
+ | `target.dependent.isDeleted` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
59
+ | `target.dependent.maritalStatus` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "NONE" | |
60
+ | `target.dependent.mothersName` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
61
+ | `target.dependent.name` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
62
+ | `target.dependent.relationshipType` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "OTHER" | |
63
+ | `target.dependent.sex` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "M" | |
64
+ | `target.dependent.status` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "LINKED" | |
65
+ | `target.employee._id` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "681e3f1a230ab8b41591abc1" | |
66
+ | `target.employee.address.city` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
67
+ | `target.employee.address.complement` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
68
+ | `target.employee.address.country` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
69
+ | `target.employee.address.neighborhood` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
70
+ | `target.employee.address.number` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
71
+ | `target.employee.address.state` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
72
+ | `target.employee.address.street` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
73
+ | `target.employee.address.zipCode` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
74
+ | `target.employee.birthdate` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "1979-10-10" | |
75
+ | `target.employee.cpf` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "756.896.500-72" | |
76
+ | `target.employee.createdAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
77
+ | `target.employee.documents.rg.issueDate` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
78
+ | `target.employee.documents.rg.issuer` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
79
+ | `target.employee.documents.rg.number` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
80
+ | `target.employee.documents.rg.state` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
81
+ | `target.employee.email` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
82
+ | `target.employee.maritalStatus` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "NONE" | |
83
+ | `target.employee.name` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "Gabrielle Pumpkin Verbrugghen" | |
84
+ | `target.employee.sex` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "M" | |
85
+ | `target.employee.updatedAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
86
+ | `target.employmentContract._id` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
87
+ | `target.employmentContract.accountID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
88
+ | `target.employmentContract.admissionDate` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
89
+ | `target.employmentContract.benefits.DUMMY.isEligible` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
90
+ | `target.employmentContract.benefits.DUMMY.status` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "ENABLED" | |
91
+ | `target.employmentContract.benefits.DUMMY.statusOriginID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
92
+ | `target.employmentContract.benefits.DUMMY.value` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
93
+ | `target.employmentContract.businessUnit.code` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
94
+ | `target.employmentContract.businessUnit.description` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
95
+ | `target.employmentContract.cellphone` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
96
+ | `target.employmentContract.companyID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
97
+ | `target.employmentContract.costCenter.code` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
98
+ | `target.employmentContract.costCenter.description` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
99
+ | `target.employmentContract.createdAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
100
+ | `target.employmentContract.customerID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
101
+ | `target.employmentContract.dependents` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [] | |
102
+ | `target.employmentContract.employmentContractID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
103
+ | `target.employmentContract.establishment.cnpj` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
104
+ | `target.employmentContract.establishment.code` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 0 | |
105
+ | `target.employmentContract.establishment.description` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
106
+ | `target.employmentContract.externalDeliveryAddress.address.city` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
107
+ | `target.employmentContract.externalDeliveryAddress.address.complement` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
108
+ | `target.employmentContract.externalDeliveryAddress.address.country` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
109
+ | `target.employmentContract.externalDeliveryAddress.address.neighborhood` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
110
+ | `target.employmentContract.externalDeliveryAddress.address.number` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
111
+ | `target.employmentContract.externalDeliveryAddress.address.state` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
112
+ | `target.employmentContract.externalDeliveryAddress.address.street` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
113
+ | `target.employmentContract.externalDeliveryAddress.address.zipCode` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
114
+ | `target.employmentContract.externalDeliveryAddress.externalDeliveryAddressID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
115
+ | `target.employmentContract.externalDeliveryAddress.externalEstablishmentCNPJ` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
116
+ | `target.employmentContract.externalEmploymentContractID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
117
+ | `target.employmentContract.externalPersonID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
118
+ | `target.employmentContract.fingerprint` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
119
+ | `target.employmentContract.isDeleted` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
120
+ | `target.employmentContract.mothersName` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
121
+ | `target.employmentContract.originExecutionID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
122
+ | `target.employmentContract.phone` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
123
+ | `target.employmentContract.position.code` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 0 | |
124
+ | `target.employmentContract.position.description` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
125
+ | `target.employmentContract.revision` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 0 | |
126
+ | `target.employmentContract.situation.code` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 0 | |
127
+ | `target.employmentContract.situation.description` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
128
+ | `target.employmentContract.situation.origin` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "TRANSFER_IN" | |
129
+ | `target.employmentContract.situation.transfer.from.externalCompanyID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
130
+ | `target.employmentContract.situation.transfer.from.externalEmploymentContractID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
131
+ | `target.employmentContract.situation.transfer.to.externalCompanyID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
132
+ | `target.employmentContract.situation.transfer.to.externalEmploymentContractID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
133
+ | `target.employmentContract.situation.transfer.transferredAt` | Date | DEDUCTION, GRANT, RECHARGE, REVOKE | Date("2025-05-29T15:05:10.431Z") | |
134
+ | `target.employmentContract.startDateOfCurrentSituation` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
135
+ | `target.employmentContract.status` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "ADMITTED" | |
136
+ | `target.payrollConfiguration._id` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "6836097c80d6be838db32525" | |
137
+ | `target.payrollConfiguration.accountID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "681b75421180f14cd49dafc1" | |
138
+ | `target.payrollConfiguration.companyID` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "678016b2410559c21dd53226" | |
139
+ | `target.payrollConfiguration.createdAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "2025-05-27T18:50:36.135Z" | |
140
+ | `target.payrollConfiguration.dataMapping.deduction` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [] | |
141
+ | `target.payrollConfiguration.dataMapping.eligibility` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [3 items] | |
142
+ | `target.payrollConfiguration.dataMapping.eligibility[0].benefitID` | string | DEDUCTION, GRANT, REVOKE | "FLEURY_CHECKUP" | |
143
+ | `target.payrollConfiguration.dataMapping.eligibility[0].eligibilityCode` | string | DEDUCTION, GRANT, REVOKE | "" | |
144
+ | `target.payrollConfiguration.dataMapping.eligibility[0].eligibilityMap` | array | DEDUCTION, GRANT, REVOKE | [] | |
145
+ | `target.payrollConfiguration.dataMapping.eligibility[0].eligibilityType` | string | DEDUCTION, GRANT, REVOKE | "BENEFIT" | |
146
+ | `target.payrollConfiguration.dataMapping.eligibility[0].options.contractID` | string | DEDUCTION, GRANT, REVOKE | "47d9b27a-1933-47d5-856b-6b827cb43d2c" | |
147
+ | `target.payrollConfiguration.dataMapping.eligibility[0].settings.grant.daysBeforeAdmissionDateToGrant` | number | DEDUCTION, GRANT, REVOKE | 1 | |
148
+ | `target.payrollConfiguration.dataMapping.eligibility[0].settings.grant.shouldGrantBeforeAdmissionDate` | boolean | DEDUCTION, GRANT, REVOKE | false | |
149
+ | `target.payrollConfiguration.dataMapping.eligibility[0].settings.revoke.daysInAdvanceToScheduleRevoke` | number | DEDUCTION, GRANT, REVOKE | 1 | |
150
+ | `target.payrollConfiguration.dataMapping.eligibility[0].settings.revoke.shouldScheduleRevoke` | boolean | DEDUCTION, GRANT, REVOKE | false | |
151
+ | `target.payrollConfiguration.dataMapping.events` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [] | |
152
+ | `target.payrollConfiguration.dataMapping.rechargeTemplate` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [] | |
153
+ | `target.payrollConfiguration.dataMapping.situation` | array | DEDUCTION, GRANT, RECHARGE, REVOKE | [] | |
154
+ | `target.payrollConfiguration.deletedAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
155
+ | `target.payrollConfiguration.eligibilitySource` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "BENEFIT_MODULE" | |
156
+ | `target.payrollConfiguration.isDeleted` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | false | |
157
+ | `target.payrollConfiguration.modifiedContractsWindowInDays` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 15 | |
158
+ | `target.payrollConfiguration.payrollReferenceCutoffDay` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 20 | |
159
+ | `target.payrollConfiguration.payrollSystem` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "LG_CLOUD" | |
160
+ | `target.payrollConfiguration.productToggle.isIntegratorActive` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | true | |
161
+ | `target.payrollConfiguration.productToggle.isOrchestratorActive` | boolean | DEDUCTION, GRANT, RECHARGE, REVOKE | true | |
162
+ | `target.payrollConfiguration.updatedAt` | string | DEDUCTION, GRANT, RECHARGE, REVOKE | "" | |
163
+ | `target.payrollConfiguration.version` | number | DEDUCTION, GRANT, RECHARGE, REVOKE | 3 | |
164
+ | `updatedAt` | Date | DEDUCTION, GRANT, RECHARGE, REVOKE | Date("2025-05-29T20:30:03.720Z") | |
165
+
166
+ ## 🟢 Campos Específicos por Action
167
+
168
+ ### RECHARGE
169
+
170
+ Campos exclusivos da action `RECHARGE`.
171
+
172
+ | Campo | Tipo | Exemplo | Descrição |
173
+ | --------------------------- | ------ | ------- | --------- |
174
+ | `rechargeInput.date` | string | "" | |
175
+ | `rechargeInput.productID` | string | "" | |
176
+ | `rechargeInput.quantity` | number | 0 | |
177
+ | `rechargeInput.tariffValue` | number | 0 | |
178
+ | `rechargeInput.ticketCode` | number | 0 | |
179
+ | `rechargeInput.value` | number | 0 | |
180
+
181
+ ### DEDUCTION
182
+
183
+ Campos exclusivos da action `DEDUCTION`.
184
+
185
+ | Campo | Tipo | Exemplo | Descrição |
186
+ | ------------------------------- | ------- | ------- | --------- |
187
+ | `deductionInput.date` | string | "" | |
188
+ | `deductionInput.isAccumulative` | boolean | false | |
189
+ | `deductionInput.value` | number | 0 | |