@tunnelhub/connector-closecare 0.0.0-stage → 0.1.0

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.
@@ -0,0 +1,667 @@
1
+ import { ConnectorLogger, BusinessError } from '@tunnelhub/connector-core';
2
+
3
+ type CloseCareConfig = {
4
+ baseUrl?: string;
5
+ companyId: string;
6
+ clientId: string;
7
+ clientSecret: string;
8
+ oauthTokenUrl?: string;
9
+ timeout?: number;
10
+ logger?: ConnectorLogger;
11
+ };
12
+ declare function closeCareInterceptorIgnoreUrls(config: Pick<CloseCareConfig, "baseUrl" | "oauthTokenUrl">): (string | RegExp)[];
13
+
14
+ interface PeopleImportInput {
15
+ items?: {
16
+ nome_funcionario?: string;
17
+ nome_social_funcionario?: string;
18
+ cpf: string;
19
+ /**
20
+ * Data de nascimento, no formato YYYY-MM-DD
21
+ */
22
+ nascimento: string;
23
+ matricula?: string;
24
+ /**
25
+ * Formato YYYY-MM-DD
26
+ */
27
+ data_admissao: string;
28
+ /**
29
+ * Formato YYYY-MM-DD
30
+ */
31
+ data_demissao: string;
32
+ sexo?: string;
33
+ /**
34
+ * Identifica unicamente a filial a que o funcionário está vinculado.
35
+ */
36
+ unidade_codigo: string;
37
+ /**
38
+ * Nome da filial. A filial é criada na primeira vez que for enviada. E atualizado na seguintes, usando o codigo anterior como chave
39
+ */
40
+ unidade_nome?: string;
41
+ unidade_cnpj?: string;
42
+ /**
43
+ * Esse campo já pode ser enviado, **mas ainda não vai ser processado**. A regional é sempre vinculada às filiais que forem enviadas junto. 2 filiais podem ser da mesma regional, mas uma filial não pode estar vinculada a 2 regionais diferentes.
44
+ */
45
+ regional_codigo?: string;
46
+ /**
47
+ * Esse campo já pode ser enviado, **mas ainda não vai ser processado**. A regional é sempre vinculada às filiais que forem enviadas junto. 2 filiais podem ser da mesma regional, mas uma filial não pode estar vinculada a 2 regionais diferentes.
48
+ */
49
+ regional_nome?: string;
50
+ departamento_codigo?: string;
51
+ departamento_nome?: string;
52
+ cargo_codigo?: string;
53
+ cargo_nome?: string;
54
+ email_corporativo?: string;
55
+ gestor_primeiro_cpf?: string;
56
+ gestor_primeiro_matricula?: string;
57
+ salario_mensal?: string;
58
+ horas_mensal?: string;
59
+ /**
60
+ * (Não disponível ainda) Nome do sindicato ao qual o funcionário está vinculado. Opcional, pode ser enviado apenas o código do sindicato em sindicato_codigo
61
+ */
62
+ sindicato_nome?: string;
63
+ /**
64
+ * (Não disponível ainda) Código do sindicato ao qual o funcionário está vinculado. Pode ser usado na ferramenta para definir regras específicas
65
+ */
66
+ sindicato_codigo?: string;
67
+ /**
68
+ * Indica se o funcionario pode enviar atestados no momento ou não. Se ativo = false, ele vai ser impedido de enviar atestados.
69
+ */
70
+ ativo?: boolean;
71
+ /**
72
+ * Indica o status atual do funcionario. Normalmente utilizado junto do campo "ativo", para indicar o motivo pelo qual o funcionario está inativo. Por exemplo "Demitido", "Férias" etc.
73
+ */
74
+ status?: string;
75
+ /**
76
+ * Lista de dependentes do funcionário. Para que os dados sejam usados, tanto o nome quanto data de nascimento devem ser enviados.
77
+ */
78
+ dependentes?: {
79
+ /**
80
+ * (Obrigatório) Nome do dependente
81
+ */
82
+ nome?: string;
83
+ /**
84
+ * (Obrigatório) Data de nascimento do dependente no formato YYYY-MM-DD
85
+ */
86
+ nascimento?: string;
87
+ /**
88
+ * (Opcional) Descrição do parentesco. Texto livre, pode ser Filho, Pais, etc
89
+ */
90
+ parentesco?: string;
91
+ }[];
92
+ /**
93
+ * Vinculos do funcionário. \<nivel\> é uma chave única que representa o nivel do vínculo, podendo ser n1, n2, n3, n4.
94
+ */
95
+ vinculos?: {
96
+ n1?: {
97
+ codigo?: string;
98
+ codigo_integracao?: {};
99
+ nome?: string;
100
+ };
101
+ n2?: {
102
+ codigo?: string;
103
+ codigo_integracao?: {};
104
+ nome?: string;
105
+ };
106
+ n3?: {
107
+ codigo?: string;
108
+ codigo_integracao?: {};
109
+ nome?: string;
110
+ };
111
+ n4?: {
112
+ codigo?: string;
113
+ codigo_integracao?: {};
114
+ nome?: string;
115
+ };
116
+ };
117
+ }[];
118
+ }
119
+ interface PeopleImportResult {
120
+ batch_id?: string;
121
+ }
122
+ interface PersonInput {
123
+ /**
124
+ * Informa se funcionário está ativo ou não. Nulo é considerado como inativo
125
+ */
126
+ ativo?: boolean;
127
+ /**
128
+ * (OBRIGATÓRIO) CPF do funcionário. Se já tiver registro do cpf, a API retorna erro 409.
129
+ */
130
+ cpf: string;
131
+ /**
132
+ * Data de admissão do funcionário (formato YYYY-MM-DD). Deve ser enviado como `null` quando ainda não definida.
133
+ */
134
+ data_admissao?: string | null;
135
+ /**
136
+ * Data de demissão do funcionário (formato YYYY-MM-DD). Deve ser enviado como `null` quando ainda não definida.
137
+ */
138
+ data_demissao?: string | null;
139
+ /**
140
+ * Endereço de email do funcionário.
141
+ */
142
+ email_corporativo?: string;
143
+ matricula?: string;
144
+ /**
145
+ * Data de nascimento, formato (YYYY-MM-DD)
146
+ */
147
+ nascimento?: string;
148
+ /**
149
+ * Nome completo do funcionário
150
+ */
151
+ nome_funcionario?: string;
152
+ nome_social_funcionario?: string;
153
+ /**
154
+ * M - masculino, F - feminino e OTHER - outro.
155
+ */
156
+ sexo?: "M" | "F" | "OTHER";
157
+ /**
158
+ * Indica o status atual do funcionário. Normalmente utilizado junto do campo "ativo", para indicar o motivo pelo qual o funcionário está inativo. Por exemplo "Demitido", "Férias" etc.
159
+ */
160
+ status?: string;
161
+ /**
162
+ * Telefone do funcionário
163
+ */
164
+ telefone?: string;
165
+ }
166
+ interface PersonResult {
167
+ id?: string;
168
+ }
169
+ interface LeaveDocumentInput {
170
+ /**
171
+ * (opcional) ID do atestado no software original que o coletou (sistema de ponto, por exemplo).
172
+ * Esse ID vai ser enviado no retorno do atestado, para que possa ser feito o relacionamento.
173
+ * ATENÇÃO! Se o id_externo já existir na Closecare, o documento será atualizado aqui, voltando ao início do fluxo de aprovação.
174
+ */
175
+ id_externo?: string;
176
+ /**
177
+ * (OBRIGATÓRIO) CPF do funcionário
178
+ */
179
+ cpf: string;
180
+ /**
181
+ * Tipo de afastamento (de acordo com códigos previamente parametrizados na Closecare)
182
+ */
183
+ tipo: string;
184
+ /**
185
+ * Lista de arquivos desse afastamento.
186
+ * Formatos aceitos:[pdf, png, jpg, jpeg].
187
+ */
188
+ arquivos?: {
189
+ /**
190
+ * O arquivo no formato base64
191
+ */
192
+ conteudo_base64?: string;
193
+ /**
194
+ * O MIME type do arquivo (image/jpg, application/pdf, ...)
195
+ */
196
+ tipo?: string;
197
+ }[];
198
+ /**
199
+ * Data/hora de início do afastamento.
200
+ * A Data início e a data de retorno são campos chave para afastamento. Se outro documento com as mesmas datas já existir, a API retorna erro 409.
201
+ */
202
+ data_inicio?: string;
203
+ /**
204
+ * Data/hora (UTC) de lançamento do documento no sistema do cliente.
205
+ */
206
+ data_lancamento?: string;
207
+ /**
208
+ * Data/hora de RETORNO AO TRABALHO. (dia seguinte em atestados de dias ou data/hora final em atestados de horas).
209
+ */
210
+ data_retorno?: string;
211
+ /**
212
+ * Códigos da doença (CID), com 3 ou 4 dígitos.
213
+ */
214
+ cids?: string[];
215
+ /**
216
+ * Dados do médico/dentista ou outro profissional de saúde
217
+ */
218
+ prestador?: {
219
+ /**
220
+ * Número do registro profissional no conselho (número do CRM, por ex)
221
+ */
222
+ identificador?: string;
223
+ /**
224
+ * Estado do registro
225
+ */
226
+ estado?: string;
227
+ /**
228
+ * Sigla do conselho (CRM | CRO | COREN ...)
229
+ */
230
+ tipo?: string;
231
+ /**
232
+ * Nome do profissional emissor
233
+ */
234
+ nome?: string;
235
+ };
236
+ /**
237
+ * Local de emissão do atestado
238
+ */
239
+ local?: string;
240
+ /**
241
+ * Observações sobre o atestado
242
+ */
243
+ observacao?: string;
244
+ /**
245
+ * Email do funcionario, para que ele receba mensagens com atualizações sobre o seu atestado
246
+ */
247
+ email?: string;
248
+ /**
249
+ * Celular do funcionário, para que ele receba mensagens com atualizações sobre o seu atestado
250
+ */
251
+ celular?: string;
252
+ /**
253
+ * Minutos do deslocamento
254
+ */
255
+ minutos_deslocamento?: {
256
+ /**
257
+ * Minutos gastos até a chegada
258
+ */
259
+ antes?: number;
260
+ /**
261
+ * Minutos gastos na volta
262
+ */
263
+ depois?: number;
264
+ };
265
+ }
266
+ interface LeaveDocumentResult {
267
+ /**
268
+ * Protocolo do atestado
269
+ */
270
+ protocolo?: string;
271
+ }
272
+ interface OccupationalDocumentInput {
273
+ /**
274
+ * (OBRIGATÓRIO) CPF do funcionário.
275
+ */
276
+ cpf: string;
277
+ /**
278
+ * (OBRIGATÓRIO) Tipo de documentos ocupacionais (de acordo com códigos previamente parametrizados na Closecare).
279
+ */
280
+ tipo: string;
281
+ /**
282
+ * (OBRIGATÓRIO) Lista de arquivos desse documento.
283
+ * Formatos aceitos:[pdf, png, jpg, jpeg].
284
+ */
285
+ arquivos: {
286
+ /**
287
+ * O arquivo no formato base64.
288
+ */
289
+ conteudo_base64?: string;
290
+ /**
291
+ * O MIME type do arquivo (image/jpg, application/pdf, ...).
292
+ */
293
+ tipo?: string;
294
+ }[];
295
+ /**
296
+ * (opcional) ID do documento no software original que o coletou (sistema de ponto, por exemplo).
297
+ * Esse ID vai ser enviado no retorno do atestado, para que possa ser feito o relacionamento.
298
+ */
299
+ id_externo?: string;
300
+ /**
301
+ * Data/hora de emissão do documento.
302
+ */
303
+ data_emissao?: string;
304
+ /**
305
+ * Observações sobre o documento.
306
+ */
307
+ observacao?: string;
308
+ /**
309
+ * CPF do médico coordenador
310
+ */
311
+ cpf_medico_coordenador?: string;
312
+ /**
313
+ * Dados do médico que realizou a avaliação
314
+ */
315
+ prestador?: {
316
+ /**
317
+ * CRM do médico
318
+ */
319
+ identificador?: string;
320
+ /**
321
+ * Estado do registro
322
+ */
323
+ estado?: string;
324
+ /**
325
+ * Nome do profissional emissor
326
+ */
327
+ nome?: string;
328
+ };
329
+ /**
330
+ * Email do funcionário, para que ele receba mensagens com atualizações sobre o seu documento
331
+ */
332
+ email?: string;
333
+ /**
334
+ * Celular do funcionário, para que ele receba mensagens com atualizações sobre o seu documento
335
+ */
336
+ celular?: string;
337
+ }
338
+ interface OccupationalDocumentResult {
339
+ /**
340
+ * Protocolo do documento
341
+ */
342
+ protocolo?: string;
343
+ }
344
+ interface SickNotesInput {
345
+ /**
346
+ * Informar cada atestado que foi corretamente importado ou que não foi importado devido a erro. Essa informação será refletida no sistema para controle de quais atestados foram sincronizados e quais precisam de alguma ação.
347
+ *
348
+ */
349
+ items?: {
350
+ /**
351
+ * ID do atestado dentro da Closecare, como recebido da API de Listar atestados /sick_notes
352
+ *
353
+ */
354
+ sick_note_id?: string;
355
+ /**
356
+ * Protocolo do atestado dentro da Closecare, como recebido da API /documents/leave*
357
+ *
358
+ */
359
+ short_id?: string;
360
+ /**
361
+ * True se o atestado foi importado corretamente no sistema de Folha/Ponto. False se ocorreu algum erro e ele não foi importado
362
+ *
363
+ */
364
+ success?: boolean;
365
+ /**
366
+ * Código para identificar o software que fez a integração. Caso não seja fornecido, é considerado "default". Esse campo é usado para permitir múltiplas integrações com a Closecare.
367
+ *
368
+ */
369
+ vendor?: string;
370
+ /**
371
+ * Objeto obrigatório apenas se houve erro ao importar esse atestado. Pode ser ausente ou null se a importação dessa linha foi bem sucedida.
372
+ *
373
+ */
374
+ error?: {
375
+ /**
376
+ * Mensagem de erro conforme recebido do sistema. Idealmente uma mensagem que faça sentido para o usuário, pois pode ser exibida no sistema Closecare.
377
+ *
378
+ */
379
+ message?: string;
380
+ /**
381
+ * Código de erro, conforme tabela de opções disponível. Faça um De-Para entre o código de erro do sistema destino com essa tabela para definir o código mais apropriado.
382
+ *
383
+ */
384
+ code?: string;
385
+ };
386
+ }[];
387
+ }
388
+ interface LeaveListResult {
389
+ items?: {
390
+ id_atestado?: string;
391
+ /**
392
+ * ID fornecido pelo cliente, casos exista
393
+ */
394
+ id_externo?: string;
395
+ protocolo?: string;
396
+ periodos?: {
397
+ /**
398
+ * Formato dd/mm/yyyy
399
+ */
400
+ data_inicio?: string;
401
+ /**
402
+ * Indica a data de RETORNO do afastamento. Então se inicia em 10/02 e
403
+ * tem 2 dias de duração, a data_retorno é 12/02. O último dia de afastamento
404
+ * é 11/02. Formato dd/mm/yyyy
405
+ */
406
+ data_retorno?: string;
407
+ /**
408
+ * Formato HH:MM
409
+ */
410
+ hora_inicio?: string;
411
+ /**
412
+ * Formato HH:MM
413
+ */
414
+ hora_fim?: string;
415
+ /**
416
+ * Quantidade em minutos entre a data de inicio e a data de retorno
417
+ */
418
+ minutos?: number;
419
+ /**
420
+ * Número de dias justificados (pagos pela empresa), usados em casos de
421
+ * INSS. Só enviado para afastamentos de 1 dia ou mais e em algumas
422
+ * situações, conforme parametrizado pela empresa
423
+ */
424
+ dias_justificados?: number;
425
+ /**
426
+ * Situação escolhida pelo operador do sistema. Esse
427
+ * código é parametrizado para o cliente, então normalmente é o mesmo
428
+ * usado no sistema de destino
429
+ */
430
+ codigo_situacao?: string;
431
+ }[];
432
+ cids?: {
433
+ cid?: string;
434
+ descricao?: string;
435
+ }[];
436
+ /**
437
+ * Formato dd/mm/yyyy HH:MM:SS
438
+ */
439
+ data_lancamento?: string;
440
+ /**
441
+ * Formato dd/mm/yyyy HH:MM:SS
442
+ */
443
+ data_atualizacao?: string;
444
+ fuso_horario?: string;
445
+ /**
446
+ * Nome do local de atendimento
447
+ */
448
+ local?: string;
449
+ /**
450
+ * Dados do médico/dentista ou outro profissional de saúde
451
+ */
452
+ prestador?: {
453
+ /**
454
+ * Número do registro profissional no conselho (número do CRM, por ex)
455
+ */
456
+ identificador?: string;
457
+ /**
458
+ * Estado do registro
459
+ */
460
+ estado?: string;
461
+ /**
462
+ * Sigla do conselho (CRM | CRO | COREN ...)
463
+ */
464
+ tipo?: string;
465
+ /**
466
+ * Nome do profissional emissor
467
+ */
468
+ nome?: string;
469
+ };
470
+ observacao?: string;
471
+ mensagem_funcionario?: string;
472
+ /**
473
+ * Um atestado pode mudar de status a
474
+ * qualquer momento, o que também atualiza a data do update_at.
475
+ * Recomenda-se incluir/atualizar os casos com status 'valid' e excluir os afastamentos do sistema de folha/ponto se o
476
+ * atestado tiver status 'invalid'.
477
+ *
478
+ * - pending: Recebido
479
+ * - warning, verified: Em análise
480
+ * - triage: Convocado para o ambulatório
481
+ * - valid: Aprovado
482
+ * - invalid: Recusado
483
+ */
484
+ status?: string;
485
+ /**
486
+ * Minutos do deslocamento
487
+ */
488
+ minutos_deslocamento?: {
489
+ /**
490
+ * Minutos gastos até a chegada
491
+ */
492
+ antes?: number;
493
+ /**
494
+ * Minutos gastos na volta
495
+ */
496
+ depois?: number;
497
+ };
498
+ /**
499
+ * Tipo do afastamento, conforme parametrizado pelo cliente
500
+ */
501
+ tipo?: {
502
+ codigo?: string;
503
+ descricao?: string;
504
+ };
505
+ funcionario?: {
506
+ cpf?: string;
507
+ matricula?: string;
508
+ nome?: string;
509
+ nome_social?: string;
510
+ unidade?: {
511
+ cnae?: string;
512
+ cnpj?: string;
513
+ codigo?: string;
514
+ nome?: string;
515
+ };
516
+ /**
517
+ * Vinculos do funcionário. \<nivel\> é uma chave única que represente o nivel do vínculo, podendo ser n1 ... nX, por exemplo.
518
+ */
519
+ vinculos?: {
520
+ "<nivel>"?: {
521
+ codigo?: string;
522
+ codigo_integracao?: {};
523
+ nome?: string;
524
+ };
525
+ };
526
+ };
527
+ atestado_relacionado?: {
528
+ id_atestado?: string;
529
+ /**
530
+ * ID fornecido pelo cliente, casos exista
531
+ */
532
+ id_externo?: string;
533
+ protocolo?: string;
534
+ periodos?: {
535
+ /**
536
+ * Formato dd/mm/yyyy
537
+ */
538
+ data_inicio?: string;
539
+ /**
540
+ * Indica a data de RETORNO do afastamento. Então se inicia em 10/02 e
541
+ * tem 2 dias de duração, a data_fim é 12/02. O último dia de afastamento
542
+ * é 11/02. Formato dd/mm/yyyy
543
+ */
544
+ data_retorno?: string;
545
+ /**
546
+ * Formato HH:MM
547
+ */
548
+ hora_inicio?: string;
549
+ /**
550
+ * Formato HH:MM
551
+ */
552
+ hora_fim?: string;
553
+ /**
554
+ * Quantidade em minutos entre a data de inicio e a data de retorno
555
+ */
556
+ minutos?: number;
557
+ /**
558
+ * Número de dias justificados (pagos pela empresa), usados em casos de
559
+ * INSS. Só enviado para afastamentos de 1 dia ou mais e em algumas
560
+ * situações, conforme parametrizado pela empresa
561
+ */
562
+ dias_justificados?: number;
563
+ /**
564
+ * Situação escolhida pelo operador do sistema. Esse
565
+ * código é parametrizado para o cliente, então normalmente é o mesmo
566
+ * usado no sistema de destino
567
+ */
568
+ codigo_situacao?: string;
569
+ }[];
570
+ /**
571
+ * Tipo do afastamento, conforme parametrizado pelo cliente
572
+ */
573
+ tipo?: {
574
+ codigo?: string;
575
+ descricao?: string;
576
+ };
577
+ };
578
+ /**
579
+ * Caso o parâmetro incluir_arquivos seja false ou ausente, o payload não terá arquivos
580
+ */
581
+ arquivos?: {
582
+ nome?: string;
583
+ tipo_conteudo?: string;
584
+ /**
585
+ * url para acessar imagem
586
+ */
587
+ url_assinada?: string;
588
+ }[];
589
+ }[];
590
+ }
591
+
592
+ declare class CloseCareDuplicateError extends BusinessError {
593
+ readonly existingId?: string | undefined;
594
+ name: string;
595
+ constructor(existingId?: string | undefined);
596
+ }
597
+
598
+ type LeaveListParams = {
599
+ data_atualizacao_min?: string;
600
+ data_atualizacao_max?: string;
601
+ dataAtualizacaoMin?: string;
602
+ incluir_arquivos?: boolean;
603
+ status?: string;
604
+ sync?: string | string[];
605
+ excluir_situacao?: string | string[];
606
+ tipo?: string | string[];
607
+ duracao_min?: number;
608
+ duracao_max?: number;
609
+ fornecedor?: string;
610
+ };
611
+ type LeaveList = Omit<LeaveListResult, "items"> & {
612
+ items: NonNullable<LeaveListResult["items"]>;
613
+ total: number;
614
+ };
615
+ declare const manifest: {
616
+ readonly pessoas: {
617
+ readonly importar: {
618
+ readonly kind: "write";
619
+ readonly stability: "exposed";
620
+ };
621
+ readonly cadastrar: {
622
+ readonly kind: "write";
623
+ readonly stability: "exposed";
624
+ };
625
+ };
626
+ readonly atestados: {
627
+ readonly list: {
628
+ readonly kind: "read";
629
+ readonly stability: "exposed";
630
+ };
631
+ readonly sendLeaveJson: {
632
+ readonly kind: "write";
633
+ readonly stability: "exposed";
634
+ };
635
+ };
636
+ readonly documentos: {
637
+ readonly sendOccupationalJson: {
638
+ readonly kind: "write";
639
+ readonly stability: "exposed";
640
+ };
641
+ };
642
+ readonly sync: {
643
+ readonly sickNotes: {
644
+ readonly kind: "write";
645
+ readonly stability: "exposed";
646
+ };
647
+ };
648
+ };
649
+ declare class CloseCareConnector {
650
+ readonly pessoas: {
651
+ importar(input: PeopleImportInput): Promise<PeopleImportResult>;
652
+ cadastrar(input: PersonInput): Promise<PersonResult>;
653
+ };
654
+ readonly atestados: {
655
+ list(params?: LeaveListParams): Promise<LeaveList>;
656
+ sendLeaveJson(input: LeaveDocumentInput): Promise<LeaveDocumentResult>;
657
+ };
658
+ readonly documentos: {
659
+ sendOccupationalJson(input: OccupationalDocumentInput): Promise<OccupationalDocumentResult>;
660
+ };
661
+ readonly sync: {
662
+ sickNotes(input: SickNotesInput): Promise<void>;
663
+ };
664
+ constructor(input: CloseCareConfig);
665
+ }
666
+
667
+ export { type CloseCareConfig, CloseCareConnector, CloseCareDuplicateError, type LeaveDocumentInput, type LeaveDocumentResult, type LeaveList, type LeaveListParams, type LeaveListResult, type OccupationalDocumentInput, type OccupationalDocumentResult, type PeopleImportInput, type PeopleImportResult, type PersonInput, type PersonResult, type SickNotesInput, closeCareInterceptorIgnoreUrls, manifest };