@databolsa/credit-sdk 3.7.0 → 3.8.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.
- package/README.md +28 -50
- package/dist/index.js +2 -2
- package/dist/schema.d.ts +215 -35
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,69 +3,47 @@
|
|
|
3
3
|
[](https://www.npmjs.com/package/@databolsa/credit-sdk)
|
|
4
4
|
[](https://github.com/databolsahq/databolsa/blob/main/LICENSE)
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
**separado** do contrato de dados de mercado; este pacote é uma casca fina sobre ele e não
|
|
10
|
-
calcula nada no cliente.
|
|
6
|
+
Cliente TypeScript tipado da mesa de crédito do DataBolsa. Watchlists, notas,
|
|
7
|
+
alertas e revisões de regulamento vivem em contrato separado dos dados públicos
|
|
8
|
+
de mercado.
|
|
11
9
|
|
|
12
|
-
## Uso
|
|
10
|
+
## Uso
|
|
13
11
|
|
|
14
12
|
```bash
|
|
15
13
|
npm install @databolsa/credit-sdk
|
|
16
14
|
```
|
|
17
15
|
|
|
18
16
|
```ts
|
|
19
|
-
import { DataBolsaCredit
|
|
17
|
+
import { DataBolsaCredit } from "@databolsa/credit-sdk";
|
|
20
18
|
|
|
21
|
-
const
|
|
19
|
+
const credit = new DataBolsaCredit({
|
|
20
|
+
apiKey: process.env.DATABOLSA_CREDIT_API_KEY,
|
|
21
|
+
workspace: process.env.DATABOLSA_CREDIT_WORKSPACE,
|
|
22
|
+
});
|
|
22
23
|
|
|
23
|
-
const me = await
|
|
24
|
-
const
|
|
25
|
-
|
|
26
|
-
const { data: listas } = await desk.listWatchlists(org);
|
|
27
|
-
const quadro = await desk.getWatchlistBoard(org, listas[0].slug);
|
|
28
|
-
const { data: limiares } = await desk.listOrgRegulationTerms(org, { status: "pending" });
|
|
29
|
-
|
|
30
|
-
try {
|
|
31
|
-
await desk.createNote(org, {
|
|
32
|
-
entity_id: quadro.rows[0].cnpj,
|
|
33
|
-
entity_kind: "fidc_class",
|
|
34
|
-
body: "revisar subordinação",
|
|
35
|
-
});
|
|
36
|
-
} catch (err) {
|
|
37
|
-
if (err instanceof DataBolsaCreditError && err.problem?.code === "license_required") {
|
|
38
|
-
console.warn("licença vencida — escritas bloqueadas, leituras seguem abertas");
|
|
39
|
-
} else {
|
|
40
|
-
throw err;
|
|
41
|
-
}
|
|
42
|
-
}
|
|
24
|
+
const me = await credit.getMe();
|
|
25
|
+
const { data: watchlists } = await credit.listWatchlists(me.organizations[0].org_slug);
|
|
43
26
|
```
|
|
44
27
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
`x-databolsa-workspace`), `credentials` e um `fetch` próprio. Mantenha a chave no servidor:
|
|
50
|
-
ela abre a mesa inteira.
|
|
28
|
+
A chave é pessoal e deve permanecer no servidor. `workspace` envia o header
|
|
29
|
+
`x-databolsa-workspace`.
|
|
30
|
+
|
|
31
|
+
## Descobrir a superfície atual
|
|
51
32
|
|
|
52
|
-
|
|
33
|
+
- Consulte o [OpenAPI da mesa](https://api.databolsa.com/openapi-credit.json)
|
|
34
|
+
para operações, schemas, unidades, enums e erros.
|
|
35
|
+
- O pacote exporta `CreditPaths`, gerado do mesmo contrato.
|
|
36
|
+
- Use `npx -y @databolsa/credit-cli --list` e
|
|
37
|
+
`npx -y @databolsa/credit-cli <operação> --help` para descoberta interativa.
|
|
53
38
|
|
|
54
|
-
|
|
55
|
-
registro existe a partir do erro.
|
|
56
|
-
- **Licença trava escrita, não leitura.** Licença vencida responde **402** com
|
|
57
|
-
`code: license_required` nas escritas; as leituras continuam.
|
|
58
|
-
- **Unidade preservada.** Razões (inadimplência, alavancagem) viajam como fração
|
|
59
|
-
(`0.0445` = 4,45%); participação de cedente viaja como percentual (`90` = 90%). Ausência
|
|
60
|
-
de dado é `null`, nunca zero.
|
|
61
|
-
- Erros seguem RFC 9457: `DataBolsaCreditError` carrega o `status` HTTP e o corpo
|
|
62
|
-
`problem+json` em `problem` (`title`, `detail`, `code`). Toda escrita é auditada.
|
|
39
|
+
`DataBolsaCreditError` expõe `status` e o corpo `problem+json` em `problem`.
|
|
63
40
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
mercado (ações, FIIs, fundos, crédito, macro) em `@databolsa/sdk`.
|
|
41
|
+
Recursos fora da mesa respondem 404. Licença vencida bloqueia escritas com 402,
|
|
42
|
+
mas mantém leituras. Toda escrita é auditada. Preserve as unidades e o significado
|
|
43
|
+
de `null` descritos pelo contrato.
|
|
68
44
|
|
|
69
|
-
|
|
45
|
+
O mesmo contrato está disponível em `@databolsa/credit-cli` e
|
|
46
|
+
`@databolsa/credit-mcp`. Para dados públicos de crédito e mercado, use
|
|
47
|
+
`@databolsa/sdk`.
|
|
70
48
|
|
|
71
|
-
Apache-2.0. O DataBolsa
|
|
49
|
+
Apache-2.0. O DataBolsa fornece informação e contexto, não decisão de crédito.
|
package/dist/index.js
CHANGED
package/dist/schema.d.ts
CHANGED
|
@@ -10,7 +10,10 @@ export interface paths {
|
|
|
10
10
|
path?: never;
|
|
11
11
|
cookie?: never;
|
|
12
12
|
};
|
|
13
|
-
/**
|
|
13
|
+
/**
|
|
14
|
+
* Identidade do chamador e mesas acessíveis
|
|
15
|
+
* @description Identidade do chamador e as mesas em que tem assento, com o papel em cada uma.
|
|
16
|
+
*/
|
|
14
17
|
get: operations["deskGetMe"];
|
|
15
18
|
put?: never;
|
|
16
19
|
post?: never;
|
|
@@ -47,14 +50,20 @@ export interface paths {
|
|
|
47
50
|
path?: never;
|
|
48
51
|
cookie?: never;
|
|
49
52
|
};
|
|
50
|
-
/**
|
|
53
|
+
/**
|
|
54
|
+
* Perfil da mesa
|
|
55
|
+
* @description Cadastro da mesa: nome, slug, CNPJ, registro CVM e situação.
|
|
56
|
+
*/
|
|
51
57
|
get: operations["deskGetOrganization"];
|
|
52
58
|
put?: never;
|
|
53
59
|
post?: never;
|
|
54
60
|
delete?: never;
|
|
55
61
|
options?: never;
|
|
56
62
|
head?: never;
|
|
57
|
-
/**
|
|
63
|
+
/**
|
|
64
|
+
* Atualizar a mesa
|
|
65
|
+
* @description Altera o nome e as configurações da mesa (`settings.seatAssignment`: automatic ou manual).
|
|
66
|
+
*/
|
|
58
67
|
patch: operations["deskUpdateOrganization"];
|
|
59
68
|
trace?: never;
|
|
60
69
|
};
|
|
@@ -65,7 +74,10 @@ export interface paths {
|
|
|
65
74
|
path?: never;
|
|
66
75
|
cookie?: never;
|
|
67
76
|
};
|
|
68
|
-
/**
|
|
77
|
+
/**
|
|
78
|
+
* Licença da mesa
|
|
79
|
+
* @description Plano vigente e os limites do contrato: assentos, classes acompanhadas e validade. `expired=true` bloqueia as escritas com 402 (`license_required`); as leituras seguem abertas.
|
|
80
|
+
*/
|
|
69
81
|
get: operations["deskGetLicense"];
|
|
70
82
|
put?: never;
|
|
71
83
|
post?: never;
|
|
@@ -82,7 +94,10 @@ export interface paths {
|
|
|
82
94
|
path?: never;
|
|
83
95
|
cookie?: never;
|
|
84
96
|
};
|
|
85
|
-
/**
|
|
97
|
+
/**
|
|
98
|
+
* Membros da mesa
|
|
99
|
+
* @description Assentos da mesa: papel (owner, admin, analyst, viewer), nome de exibição e situação.
|
|
100
|
+
*/
|
|
86
101
|
get: operations["deskListMembers"];
|
|
87
102
|
put?: never;
|
|
88
103
|
/**
|
|
@@ -109,7 +124,10 @@ export interface paths {
|
|
|
109
124
|
delete?: never;
|
|
110
125
|
options?: never;
|
|
111
126
|
head?: never;
|
|
112
|
-
/**
|
|
127
|
+
/**
|
|
128
|
+
* Alterar papel ou status de um membro
|
|
129
|
+
* @description Muda o papel, o nome de exibição ou suspende/reativa um assento. Não remove a pessoa da organização na plataforma.
|
|
130
|
+
*/
|
|
113
131
|
patch: operations["deskUpdateMember"];
|
|
114
132
|
trace?: never;
|
|
115
133
|
};
|
|
@@ -120,10 +138,16 @@ export interface paths {
|
|
|
120
138
|
path?: never;
|
|
121
139
|
cookie?: never;
|
|
122
140
|
};
|
|
123
|
-
/**
|
|
141
|
+
/**
|
|
142
|
+
* Convites da mesa
|
|
143
|
+
* @description Convites da mesa com e-mail, papel, situação e validade.
|
|
144
|
+
*/
|
|
124
145
|
get: operations["deskListInvitations"];
|
|
125
146
|
put?: never;
|
|
126
|
-
/**
|
|
147
|
+
/**
|
|
148
|
+
* Convidar alguém para a mesa
|
|
149
|
+
* @description Cria um convite por e-mail com o papel dado e devolve o link de aceite. O assento nasce quando a pessoa aceita (`deskAcceptInvitation`).
|
|
150
|
+
*/
|
|
127
151
|
post: operations["deskCreateInvitation"];
|
|
128
152
|
delete?: never;
|
|
129
153
|
options?: never;
|
|
@@ -141,7 +165,10 @@ export interface paths {
|
|
|
141
165
|
get?: never;
|
|
142
166
|
put?: never;
|
|
143
167
|
post?: never;
|
|
144
|
-
/**
|
|
168
|
+
/**
|
|
169
|
+
* Revogar convite pendente
|
|
170
|
+
* @description Cancela um convite ainda não aceito.
|
|
171
|
+
*/
|
|
145
172
|
delete: operations["deskRevokeInvitation"];
|
|
146
173
|
options?: never;
|
|
147
174
|
head?: never;
|
|
@@ -155,7 +182,10 @@ export interface paths {
|
|
|
155
182
|
path?: never;
|
|
156
183
|
cookie?: never;
|
|
157
184
|
};
|
|
158
|
-
/**
|
|
185
|
+
/**
|
|
186
|
+
* Trilha de auditoria da mesa
|
|
187
|
+
* @description Trilha de auditoria da mesa, mais recente primeiro, com paginação por cursor. `entity_id` recorta por classe ou cedente (CNPJ).
|
|
188
|
+
*/
|
|
159
189
|
get: operations["deskListAudit"];
|
|
160
190
|
put?: never;
|
|
161
191
|
post?: never;
|
|
@@ -172,10 +202,16 @@ export interface paths {
|
|
|
172
202
|
path?: never;
|
|
173
203
|
cookie?: never;
|
|
174
204
|
};
|
|
175
|
-
/**
|
|
205
|
+
/**
|
|
206
|
+
* Watchlists da mesa
|
|
207
|
+
* @description Listas de acompanhamento da mesa, com tipo (`book` = o que a casa gere ou originou; `market` = o que ela observa) e a contagem de posições.
|
|
208
|
+
*/
|
|
176
209
|
get: operations["deskListWatchlists"];
|
|
177
210
|
put?: never;
|
|
178
|
-
/**
|
|
211
|
+
/**
|
|
212
|
+
* Criar watchlist
|
|
213
|
+
* @description Cria uma watchlist com nome, slug opcional, descrição e tipo (`book` ou `market`).
|
|
214
|
+
*/
|
|
179
215
|
post: operations["deskCreateWatchlist"];
|
|
180
216
|
delete?: never;
|
|
181
217
|
options?: never;
|
|
@@ -193,7 +229,10 @@ export interface paths {
|
|
|
193
229
|
get?: never;
|
|
194
230
|
put?: never;
|
|
195
231
|
post?: never;
|
|
196
|
-
/**
|
|
232
|
+
/**
|
|
233
|
+
* Remover watchlist
|
|
234
|
+
* @description Remove a watchlist e as posições acompanhadas nela.
|
|
235
|
+
*/
|
|
197
236
|
delete: operations["deskDeleteWatchlist"];
|
|
198
237
|
options?: never;
|
|
199
238
|
head?: never;
|
|
@@ -207,7 +246,10 @@ export interface paths {
|
|
|
207
246
|
path?: never;
|
|
208
247
|
cookie?: never;
|
|
209
248
|
};
|
|
210
|
-
/**
|
|
249
|
+
/**
|
|
250
|
+
* Posições acompanhadas na watchlist
|
|
251
|
+
* @description Posições acompanhadas na watchlist: CNPJ da classe ou do cedente, rótulo, relação com a mesa (`own`/`tracked`) e ordem.
|
|
252
|
+
*/
|
|
211
253
|
get: operations["deskListWatchlistItems"];
|
|
212
254
|
put?: never;
|
|
213
255
|
/**
|
|
@@ -231,7 +273,10 @@ export interface paths {
|
|
|
231
273
|
get?: never;
|
|
232
274
|
put?: never;
|
|
233
275
|
post?: never;
|
|
234
|
-
/**
|
|
276
|
+
/**
|
|
277
|
+
* Remover posição da watchlist
|
|
278
|
+
* @description Tira uma posição da watchlist pelo CNPJ.
|
|
279
|
+
*/
|
|
235
280
|
delete: operations["deskRemoveWatchlistItem"];
|
|
236
281
|
options?: never;
|
|
237
282
|
head?: never;
|
|
@@ -265,9 +310,15 @@ export interface paths {
|
|
|
265
310
|
path?: never;
|
|
266
311
|
cookie?: never;
|
|
267
312
|
};
|
|
268
|
-
/**
|
|
313
|
+
/**
|
|
314
|
+
* Colunas da grade e catálogo de métricas disponíveis
|
|
315
|
+
* @description As colunas escolhidas para a grade da mesa e o catálogo de métricas disponíveis, com rótulo, unidade e ajuda de cada uma.
|
|
316
|
+
*/
|
|
269
317
|
get: operations["deskGetGrid"];
|
|
270
|
-
/**
|
|
318
|
+
/**
|
|
319
|
+
* Definir as colunas da grade
|
|
320
|
+
* @description Define as colunas da grade (até 30 métricas do catálogo de `deskGetGrid`), na ordem dada.
|
|
321
|
+
*/
|
|
271
322
|
put: operations["deskSetGrid"];
|
|
272
323
|
post?: never;
|
|
273
324
|
delete?: never;
|
|
@@ -343,7 +394,10 @@ export interface paths {
|
|
|
343
394
|
path?: never;
|
|
344
395
|
cookie?: never;
|
|
345
396
|
};
|
|
346
|
-
/**
|
|
397
|
+
/**
|
|
398
|
+
* Regras de alerta da mesa
|
|
399
|
+
* @description Regras de alerta da mesa: métrica, comparador, limiar na unidade da métrica, severidade e se está ligada.
|
|
400
|
+
*/
|
|
347
401
|
get: operations["deskListAlertRules"];
|
|
348
402
|
/**
|
|
349
403
|
* Criar ou atualizar uma regra de alerta
|
|
@@ -367,7 +421,10 @@ export interface paths {
|
|
|
367
421
|
get?: never;
|
|
368
422
|
put?: never;
|
|
369
423
|
post?: never;
|
|
370
|
-
/**
|
|
424
|
+
/**
|
|
425
|
+
* Remover regra de alerta
|
|
426
|
+
* @description Remove uma regra de alerta. O que já foi registrado no ledger de alertas não muda.
|
|
427
|
+
*/
|
|
371
428
|
delete: operations["deskDeleteAlertRule"];
|
|
372
429
|
options?: never;
|
|
373
430
|
head?: never;
|
|
@@ -381,10 +438,16 @@ export interface paths {
|
|
|
381
438
|
path?: never;
|
|
382
439
|
cookie?: never;
|
|
383
440
|
};
|
|
384
|
-
/**
|
|
441
|
+
/**
|
|
442
|
+
* Notas da mesa
|
|
443
|
+
* @description Notas da mesa, mais recente primeiro. `entity_id` recorta por classe ou cedente (CNPJ).
|
|
444
|
+
*/
|
|
385
445
|
get: operations["deskListNotes"];
|
|
386
446
|
put?: never;
|
|
387
|
-
/**
|
|
447
|
+
/**
|
|
448
|
+
* Escrever nota sobre uma classe ou cedente
|
|
449
|
+
* @description Registra uma nota da mesa sobre uma classe de FIDC ou um cedente, identificado por CNPJ em `entity_id`.
|
|
450
|
+
*/
|
|
388
451
|
post: operations["deskCreateNote"];
|
|
389
452
|
delete?: never;
|
|
390
453
|
options?: never;
|
|
@@ -402,7 +465,10 @@ export interface paths {
|
|
|
402
465
|
get?: never;
|
|
403
466
|
put?: never;
|
|
404
467
|
post?: never;
|
|
405
|
-
/**
|
|
468
|
+
/**
|
|
469
|
+
* Remover nota
|
|
470
|
+
* @description Remove uma nota da mesa.
|
|
471
|
+
*/
|
|
406
472
|
delete: operations["deskDeleteNote"];
|
|
407
473
|
options?: never;
|
|
408
474
|
head?: never;
|
|
@@ -542,6 +608,7 @@ export interface operations {
|
|
|
542
608
|
requestBody?: {
|
|
543
609
|
content: {
|
|
544
610
|
"application/json": {
|
|
611
|
+
/** @description Token do convite, do link recebido por e-mail. */
|
|
545
612
|
token: string;
|
|
546
613
|
};
|
|
547
614
|
};
|
|
@@ -583,6 +650,7 @@ export interface operations {
|
|
|
583
650
|
query?: never;
|
|
584
651
|
header?: never;
|
|
585
652
|
path: {
|
|
653
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
586
654
|
org: string;
|
|
587
655
|
};
|
|
588
656
|
cookie?: never;
|
|
@@ -627,6 +695,7 @@ export interface operations {
|
|
|
627
695
|
query?: never;
|
|
628
696
|
header?: never;
|
|
629
697
|
path: {
|
|
698
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
630
699
|
org: string;
|
|
631
700
|
};
|
|
632
701
|
cookie?: never;
|
|
@@ -634,7 +703,9 @@ export interface operations {
|
|
|
634
703
|
requestBody?: {
|
|
635
704
|
content: {
|
|
636
705
|
"application/json": {
|
|
706
|
+
/** @description Novo nome da mesa. */
|
|
637
707
|
name?: string;
|
|
708
|
+
/** @description Configurações da mesa; `seatAssignment`: automatic ou manual. */
|
|
638
709
|
settings?: {
|
|
639
710
|
[key: string]: unknown;
|
|
640
711
|
};
|
|
@@ -680,6 +751,7 @@ export interface operations {
|
|
|
680
751
|
query?: never;
|
|
681
752
|
header?: never;
|
|
682
753
|
path: {
|
|
754
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
683
755
|
org: string;
|
|
684
756
|
};
|
|
685
757
|
cookie?: never;
|
|
@@ -723,6 +795,7 @@ export interface operations {
|
|
|
723
795
|
query?: never;
|
|
724
796
|
header?: never;
|
|
725
797
|
path: {
|
|
798
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
726
799
|
org: string;
|
|
727
800
|
};
|
|
728
801
|
cookie?: never;
|
|
@@ -768,6 +841,7 @@ export interface operations {
|
|
|
768
841
|
query?: never;
|
|
769
842
|
header?: never;
|
|
770
843
|
path: {
|
|
844
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
771
845
|
org: string;
|
|
772
846
|
};
|
|
773
847
|
cookie?: never;
|
|
@@ -775,9 +849,14 @@ export interface operations {
|
|
|
775
849
|
requestBody?: {
|
|
776
850
|
content: {
|
|
777
851
|
"application/json": {
|
|
852
|
+
/** @description Id da pessoa na plataforma (já membro da organização). */
|
|
778
853
|
user_id: string;
|
|
779
|
-
/**
|
|
854
|
+
/**
|
|
855
|
+
* @description Papel do assento.
|
|
856
|
+
* @enum {string}
|
|
857
|
+
*/
|
|
780
858
|
role: "owner" | "admin" | "analyst";
|
|
859
|
+
/** @description Nome de exibição na mesa (até 120 caracteres). */
|
|
781
860
|
display_name?: string;
|
|
782
861
|
};
|
|
783
862
|
};
|
|
@@ -820,7 +899,9 @@ export interface operations {
|
|
|
820
899
|
query?: never;
|
|
821
900
|
header?: never;
|
|
822
901
|
path: {
|
|
902
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
823
903
|
org: string;
|
|
904
|
+
/** @description Id do assento (de deskListMembers). */
|
|
824
905
|
memberId: string;
|
|
825
906
|
};
|
|
826
907
|
cookie?: never;
|
|
@@ -828,10 +909,17 @@ export interface operations {
|
|
|
828
909
|
requestBody?: {
|
|
829
910
|
content: {
|
|
830
911
|
"application/json": {
|
|
831
|
-
/**
|
|
912
|
+
/**
|
|
913
|
+
* @description Novo papel do assento.
|
|
914
|
+
* @enum {string}
|
|
915
|
+
*/
|
|
832
916
|
role?: "owner" | "admin" | "analyst";
|
|
833
|
-
/**
|
|
917
|
+
/**
|
|
918
|
+
* @description active reativa; suspended bloqueia o acesso sem apagar o assento.
|
|
919
|
+
* @enum {string}
|
|
920
|
+
*/
|
|
834
921
|
status?: "active" | "suspended";
|
|
922
|
+
/** @description Novo nome de exibição. */
|
|
835
923
|
display_name?: string;
|
|
836
924
|
};
|
|
837
925
|
};
|
|
@@ -874,6 +962,7 @@ export interface operations {
|
|
|
874
962
|
query?: never;
|
|
875
963
|
header?: never;
|
|
876
964
|
path: {
|
|
965
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
877
966
|
org: string;
|
|
878
967
|
};
|
|
879
968
|
cookie?: never;
|
|
@@ -919,6 +1008,7 @@ export interface operations {
|
|
|
919
1008
|
query?: never;
|
|
920
1009
|
header?: never;
|
|
921
1010
|
path: {
|
|
1011
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
922
1012
|
org: string;
|
|
923
1013
|
};
|
|
924
1014
|
cookie?: never;
|
|
@@ -926,9 +1016,15 @@ export interface operations {
|
|
|
926
1016
|
requestBody?: {
|
|
927
1017
|
content: {
|
|
928
1018
|
"application/json": {
|
|
929
|
-
/**
|
|
1019
|
+
/**
|
|
1020
|
+
* Format: email
|
|
1021
|
+
* @description E-mail de quem será convidado.
|
|
1022
|
+
*/
|
|
930
1023
|
email: string;
|
|
931
|
-
/**
|
|
1024
|
+
/**
|
|
1025
|
+
* @description Papel que a pessoa terá ao aceitar.
|
|
1026
|
+
* @enum {string}
|
|
1027
|
+
*/
|
|
932
1028
|
role: "owner" | "admin" | "analyst";
|
|
933
1029
|
};
|
|
934
1030
|
};
|
|
@@ -968,7 +1064,9 @@ export interface operations {
|
|
|
968
1064
|
query?: never;
|
|
969
1065
|
header?: never;
|
|
970
1066
|
path: {
|
|
1067
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
971
1068
|
org: string;
|
|
1069
|
+
/** @description Id do convite (de deskListInvitations). */
|
|
972
1070
|
invitationId: string;
|
|
973
1071
|
};
|
|
974
1072
|
cookie?: never;
|
|
@@ -1012,6 +1110,7 @@ export interface operations {
|
|
|
1012
1110
|
};
|
|
1013
1111
|
header?: never;
|
|
1014
1112
|
path: {
|
|
1113
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1015
1114
|
org: string;
|
|
1016
1115
|
};
|
|
1017
1116
|
cookie?: never;
|
|
@@ -1065,6 +1164,7 @@ export interface operations {
|
|
|
1065
1164
|
query?: never;
|
|
1066
1165
|
header?: never;
|
|
1067
1166
|
path: {
|
|
1167
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1068
1168
|
org: string;
|
|
1069
1169
|
};
|
|
1070
1170
|
cookie?: never;
|
|
@@ -1111,6 +1211,7 @@ export interface operations {
|
|
|
1111
1211
|
query?: never;
|
|
1112
1212
|
header?: never;
|
|
1113
1213
|
path: {
|
|
1214
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1114
1215
|
org: string;
|
|
1115
1216
|
};
|
|
1116
1217
|
cookie?: never;
|
|
@@ -1118,10 +1219,16 @@ export interface operations {
|
|
|
1118
1219
|
requestBody?: {
|
|
1119
1220
|
content: {
|
|
1120
1221
|
"application/json": {
|
|
1222
|
+
/** @description Nome da watchlist. */
|
|
1121
1223
|
name: string;
|
|
1224
|
+
/** @description Slug estável para a URL; derivado do nome quando omitido. */
|
|
1122
1225
|
slug?: string;
|
|
1226
|
+
/** @description Descrição livre. */
|
|
1123
1227
|
description?: string | null;
|
|
1124
|
-
/**
|
|
1228
|
+
/**
|
|
1229
|
+
* @description book = o que a casa gere ou originou; market = o que ela observa (default).
|
|
1230
|
+
* @enum {string}
|
|
1231
|
+
*/
|
|
1125
1232
|
kind?: "book" | "market";
|
|
1126
1233
|
};
|
|
1127
1234
|
};
|
|
@@ -1165,7 +1272,9 @@ export interface operations {
|
|
|
1165
1272
|
query?: never;
|
|
1166
1273
|
header?: never;
|
|
1167
1274
|
path: {
|
|
1275
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1168
1276
|
org: string;
|
|
1277
|
+
/** @description Id ou slug da watchlist (de deskListWatchlists). */
|
|
1169
1278
|
list: string;
|
|
1170
1279
|
};
|
|
1171
1280
|
cookie?: never;
|
|
@@ -1205,7 +1314,9 @@ export interface operations {
|
|
|
1205
1314
|
query?: never;
|
|
1206
1315
|
header?: never;
|
|
1207
1316
|
path: {
|
|
1317
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1208
1318
|
org: string;
|
|
1319
|
+
/** @description Id ou slug da watchlist (de deskListWatchlists). */
|
|
1209
1320
|
list: string;
|
|
1210
1321
|
};
|
|
1211
1322
|
cookie?: never;
|
|
@@ -1251,7 +1362,9 @@ export interface operations {
|
|
|
1251
1362
|
query?: never;
|
|
1252
1363
|
header?: never;
|
|
1253
1364
|
path: {
|
|
1365
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1254
1366
|
org: string;
|
|
1367
|
+
/** @description Id ou slug da watchlist (de deskListWatchlists). */
|
|
1255
1368
|
list: string;
|
|
1256
1369
|
};
|
|
1257
1370
|
cookie?: never;
|
|
@@ -1259,10 +1372,16 @@ export interface operations {
|
|
|
1259
1372
|
requestBody?: {
|
|
1260
1373
|
content: {
|
|
1261
1374
|
"application/json": {
|
|
1375
|
+
/** @description Posições a incluir na watchlist (1–500), identificadas por CNPJ. */
|
|
1262
1376
|
items: {
|
|
1377
|
+
/** @description CNPJ da classe de FIDC ou do cedente, com ou sem pontuação. */
|
|
1263
1378
|
cnpj: string;
|
|
1379
|
+
/** @description Apelido da posição na mesa. */
|
|
1264
1380
|
label?: string | null;
|
|
1265
|
-
/**
|
|
1381
|
+
/**
|
|
1382
|
+
* @description fidc_class (default) ou originator (cedente).
|
|
1383
|
+
* @enum {string}
|
|
1384
|
+
*/
|
|
1266
1385
|
entity_kind?: "fidc_class" | "originator";
|
|
1267
1386
|
/**
|
|
1268
1387
|
* @description O que a classe é PARA A MESA. `own`: a casa gere ou originou — quebra de limite aqui é operacional. `tracked` (default): exposição, avaliação ou comparação.
|
|
@@ -1308,8 +1427,11 @@ export interface operations {
|
|
|
1308
1427
|
query?: never;
|
|
1309
1428
|
header?: never;
|
|
1310
1429
|
path: {
|
|
1430
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1311
1431
|
org: string;
|
|
1432
|
+
/** @description Id ou slug da watchlist (de deskListWatchlists). */
|
|
1312
1433
|
list: string;
|
|
1434
|
+
/** @description CNPJ da classe de FIDC ou do cedente, 14 dígitos. */
|
|
1313
1435
|
cnpj: string;
|
|
1314
1436
|
};
|
|
1315
1437
|
cookie?: never;
|
|
@@ -1349,7 +1471,9 @@ export interface operations {
|
|
|
1349
1471
|
query?: never;
|
|
1350
1472
|
header?: never;
|
|
1351
1473
|
path: {
|
|
1474
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1352
1475
|
org: string;
|
|
1476
|
+
/** @description Id ou slug da watchlist (de deskListWatchlists). */
|
|
1353
1477
|
list: string;
|
|
1354
1478
|
};
|
|
1355
1479
|
cookie?: never;
|
|
@@ -1418,6 +1542,7 @@ export interface operations {
|
|
|
1418
1542
|
query?: never;
|
|
1419
1543
|
header?: never;
|
|
1420
1544
|
path: {
|
|
1545
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1421
1546
|
org: string;
|
|
1422
1547
|
};
|
|
1423
1548
|
cookie?: never;
|
|
@@ -1466,6 +1591,7 @@ export interface operations {
|
|
|
1466
1591
|
query?: never;
|
|
1467
1592
|
header?: never;
|
|
1468
1593
|
path: {
|
|
1594
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1469
1595
|
org: string;
|
|
1470
1596
|
};
|
|
1471
1597
|
cookie?: never;
|
|
@@ -1473,6 +1599,7 @@ export interface operations {
|
|
|
1473
1599
|
requestBody?: {
|
|
1474
1600
|
content: {
|
|
1475
1601
|
"application/json": {
|
|
1602
|
+
/** @description Métricas do catálogo de deskGetGrid, na ordem das colunas (até 30). */
|
|
1476
1603
|
metrics: string[];
|
|
1477
1604
|
};
|
|
1478
1605
|
};
|
|
@@ -1511,7 +1638,9 @@ export interface operations {
|
|
|
1511
1638
|
query?: never;
|
|
1512
1639
|
header?: never;
|
|
1513
1640
|
path: {
|
|
1641
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1514
1642
|
org: string;
|
|
1643
|
+
/** @description Id ou slug da watchlist (de deskListWatchlists). */
|
|
1515
1644
|
list: string;
|
|
1516
1645
|
};
|
|
1517
1646
|
cookie?: never;
|
|
@@ -1536,9 +1665,11 @@ export interface operations {
|
|
|
1536
1665
|
metric: string;
|
|
1537
1666
|
value: number | null;
|
|
1538
1667
|
threshold: number | null;
|
|
1668
|
+
/** @description Quanto falta para cruzar o limiar, na unidade da métrica. Negativo = já cruzou. */
|
|
1539
1669
|
distance: number | null;
|
|
1540
1670
|
reference_date: string | null;
|
|
1541
1671
|
title: string;
|
|
1672
|
+
/** @description Procedência do limiar no regulamento. Presente só quando a origem é covenant. */
|
|
1542
1673
|
evidence: {
|
|
1543
1674
|
doc_id: string | null;
|
|
1544
1675
|
page: number | null;
|
|
@@ -1546,6 +1677,7 @@ export interface operations {
|
|
|
1546
1677
|
} | null;
|
|
1547
1678
|
/** @enum {string} */
|
|
1548
1679
|
status: "open" | "acknowledged" | "muted";
|
|
1680
|
+
/** @description Primeira vez que este alerta foi observado (ledger append-only). */
|
|
1549
1681
|
first_detected_at?: string | null;
|
|
1550
1682
|
}[];
|
|
1551
1683
|
meta: {
|
|
@@ -1581,6 +1713,7 @@ export interface operations {
|
|
|
1581
1713
|
};
|
|
1582
1714
|
header?: never;
|
|
1583
1715
|
path: {
|
|
1716
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1584
1717
|
org: string;
|
|
1585
1718
|
};
|
|
1586
1719
|
cookie?: never;
|
|
@@ -1635,7 +1768,9 @@ export interface operations {
|
|
|
1635
1768
|
query?: never;
|
|
1636
1769
|
header?: never;
|
|
1637
1770
|
path: {
|
|
1771
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1638
1772
|
org: string;
|
|
1773
|
+
/** @description Chave do alerta (de deskListAlerts). */
|
|
1639
1774
|
key: string;
|
|
1640
1775
|
};
|
|
1641
1776
|
cookie?: never;
|
|
@@ -1644,6 +1779,7 @@ export interface operations {
|
|
|
1644
1779
|
content: {
|
|
1645
1780
|
"application/json": {
|
|
1646
1781
|
/**
|
|
1782
|
+
* @description acknowledged = visto (default); muted = silenciado nesta competência.
|
|
1647
1783
|
* @default acknowledged
|
|
1648
1784
|
* @enum {string}
|
|
1649
1785
|
*/
|
|
@@ -1686,6 +1822,7 @@ export interface operations {
|
|
|
1686
1822
|
query?: never;
|
|
1687
1823
|
header?: never;
|
|
1688
1824
|
path: {
|
|
1825
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1689
1826
|
org: string;
|
|
1690
1827
|
};
|
|
1691
1828
|
cookie?: never;
|
|
@@ -1732,6 +1869,7 @@ export interface operations {
|
|
|
1732
1869
|
query?: never;
|
|
1733
1870
|
header?: never;
|
|
1734
1871
|
path: {
|
|
1872
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1735
1873
|
org: string;
|
|
1736
1874
|
};
|
|
1737
1875
|
cookie?: never;
|
|
@@ -1739,12 +1877,21 @@ export interface operations {
|
|
|
1739
1877
|
requestBody?: {
|
|
1740
1878
|
content: {
|
|
1741
1879
|
"application/json": {
|
|
1880
|
+
/** @description Métrica do catálogo de deskGetGrid. */
|
|
1742
1881
|
metric: string;
|
|
1743
|
-
/**
|
|
1882
|
+
/**
|
|
1883
|
+
* @description gt dispara acima do limiar; lt, abaixo.
|
|
1884
|
+
* @enum {string}
|
|
1885
|
+
*/
|
|
1744
1886
|
comparator: "gt" | "lt";
|
|
1887
|
+
/** @description Limiar na UNIDADE da métrica (fração para inadimplência: 0.05 = 5%; percentual para concentração: 60 = 60%). */
|
|
1745
1888
|
threshold: number;
|
|
1746
|
-
/**
|
|
1889
|
+
/**
|
|
1890
|
+
* @description Severidade do alerta gerado (default attention).
|
|
1891
|
+
* @enum {string}
|
|
1892
|
+
*/
|
|
1747
1893
|
severity?: "info" | "attention" | "critical";
|
|
1894
|
+
/** @description false desliga a regra sem apagá-la. */
|
|
1748
1895
|
enabled?: boolean;
|
|
1749
1896
|
};
|
|
1750
1897
|
};
|
|
@@ -1788,7 +1935,9 @@ export interface operations {
|
|
|
1788
1935
|
query?: never;
|
|
1789
1936
|
header?: never;
|
|
1790
1937
|
path: {
|
|
1938
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1791
1939
|
org: string;
|
|
1940
|
+
/** @description Id da regra (de deskListAlertRules). */
|
|
1792
1941
|
ruleId: string;
|
|
1793
1942
|
};
|
|
1794
1943
|
cookie?: never;
|
|
@@ -1831,6 +1980,7 @@ export interface operations {
|
|
|
1831
1980
|
};
|
|
1832
1981
|
header?: never;
|
|
1833
1982
|
path: {
|
|
1983
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1834
1984
|
org: string;
|
|
1835
1985
|
};
|
|
1836
1986
|
cookie?: never;
|
|
@@ -1879,6 +2029,7 @@ export interface operations {
|
|
|
1879
2029
|
query?: never;
|
|
1880
2030
|
header?: never;
|
|
1881
2031
|
path: {
|
|
2032
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1882
2033
|
org: string;
|
|
1883
2034
|
};
|
|
1884
2035
|
cookie?: never;
|
|
@@ -1886,9 +2037,14 @@ export interface operations {
|
|
|
1886
2037
|
requestBody?: {
|
|
1887
2038
|
content: {
|
|
1888
2039
|
"application/json": {
|
|
2040
|
+
/** @description CNPJ da classe de FIDC ou do cedente. */
|
|
1889
2041
|
entity_id: string;
|
|
1890
|
-
/**
|
|
2042
|
+
/**
|
|
2043
|
+
* @description fidc_class (default) ou originator.
|
|
2044
|
+
* @enum {string}
|
|
2045
|
+
*/
|
|
1891
2046
|
entity_kind?: "fidc_class" | "originator";
|
|
2047
|
+
/** @description Texto da nota (até 10.000 caracteres). */
|
|
1892
2048
|
body: string;
|
|
1893
2049
|
};
|
|
1894
2050
|
};
|
|
@@ -1927,7 +2083,9 @@ export interface operations {
|
|
|
1927
2083
|
query?: never;
|
|
1928
2084
|
header?: never;
|
|
1929
2085
|
path: {
|
|
2086
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1930
2087
|
org: string;
|
|
2088
|
+
/** @description Id da nota (de deskListNotes). */
|
|
1931
2089
|
noteId: string;
|
|
1932
2090
|
};
|
|
1933
2091
|
cookie?: never;
|
|
@@ -1970,7 +2128,9 @@ export interface operations {
|
|
|
1970
2128
|
};
|
|
1971
2129
|
header?: never;
|
|
1972
2130
|
path: {
|
|
2131
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
1973
2132
|
org: string;
|
|
2133
|
+
/** @description CNPJ da classe de FIDC ou do cedente, 14 dígitos. */
|
|
1974
2134
|
cnpj: string;
|
|
1975
2135
|
};
|
|
1976
2136
|
cookie?: never;
|
|
@@ -2029,7 +2189,9 @@ export interface operations {
|
|
|
2029
2189
|
query?: never;
|
|
2030
2190
|
header?: never;
|
|
2031
2191
|
path: {
|
|
2192
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
2032
2193
|
org: string;
|
|
2194
|
+
/** @description CNPJ da classe de FIDC ou do cedente, 14 dígitos. */
|
|
2033
2195
|
cnpj: string;
|
|
2034
2196
|
};
|
|
2035
2197
|
cookie?: never;
|
|
@@ -2037,15 +2199,27 @@ export interface operations {
|
|
|
2037
2199
|
requestBody?: {
|
|
2038
2200
|
content: {
|
|
2039
2201
|
"application/json": {
|
|
2040
|
-
/**
|
|
2202
|
+
/**
|
|
2203
|
+
* @description Qual limiar do regulamento (chave do vocabulário fechado).
|
|
2204
|
+
* @enum {string}
|
|
2205
|
+
*/
|
|
2041
2206
|
term: "subordinacao_minima" | "inadimplencia_max" | "concentracao_cedente_max" | "revolvente" | "coobrigacao_cedente" | "taxa_administracao" | "taxa_performance" | "benchmark_alvo";
|
|
2207
|
+
/** @description Valor numérico na unidade declarada (fração para razão; BRL; % a.a.). */
|
|
2042
2208
|
value_num?: number | null;
|
|
2209
|
+
/** @description Valor em texto quando o limiar não é numérico. */
|
|
2043
2210
|
value_text?: string | null;
|
|
2044
|
-
/**
|
|
2211
|
+
/**
|
|
2212
|
+
* @description Unidade do valor: ratio, brl, percent_year ou text.
|
|
2213
|
+
* @enum {string|null}
|
|
2214
|
+
*/
|
|
2045
2215
|
unit?: "ratio" | "brl" | "percent_year" | "text" | null;
|
|
2216
|
+
/** @description Documento de onde o limiar foi lido (protocolo). */
|
|
2046
2217
|
doc_id?: string | null;
|
|
2218
|
+
/** @description Página do documento. */
|
|
2047
2219
|
doc_page?: number | null;
|
|
2220
|
+
/** @description Trecho literal que sustenta o limiar. */
|
|
2048
2221
|
quote?: string | null;
|
|
2222
|
+
/** @description Confiança da extração, de 0 a 1. */
|
|
2049
2223
|
confidence?: number | null;
|
|
2050
2224
|
};
|
|
2051
2225
|
};
|
|
@@ -2101,6 +2275,7 @@ export interface operations {
|
|
|
2101
2275
|
};
|
|
2102
2276
|
header?: never;
|
|
2103
2277
|
path: {
|
|
2278
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
2104
2279
|
org: string;
|
|
2105
2280
|
};
|
|
2106
2281
|
cookie?: never;
|
|
@@ -2159,7 +2334,9 @@ export interface operations {
|
|
|
2159
2334
|
query?: never;
|
|
2160
2335
|
header?: never;
|
|
2161
2336
|
path: {
|
|
2337
|
+
/** @description Id ou slug da organização (de deskGetMe). */
|
|
2162
2338
|
org: string;
|
|
2339
|
+
/** @description Id do limiar (de deskListOrgRegulationTerms). */
|
|
2163
2340
|
termId: string;
|
|
2164
2341
|
};
|
|
2165
2342
|
cookie?: never;
|
|
@@ -2167,7 +2344,10 @@ export interface operations {
|
|
|
2167
2344
|
requestBody?: {
|
|
2168
2345
|
content: {
|
|
2169
2346
|
"application/json": {
|
|
2170
|
-
/**
|
|
2347
|
+
/**
|
|
2348
|
+
* @description confirmed liga o limiar aos alertas; rejected descarta a proposta.
|
|
2349
|
+
* @enum {string}
|
|
2350
|
+
*/
|
|
2171
2351
|
decision: "confirmed" | "rejected";
|
|
2172
2352
|
};
|
|
2173
2353
|
};
|