@insurance-broker/api-client 1.43.0 → 1.44.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/dist/schema.d.ts +405 -0
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -4636,6 +4636,126 @@ export interface paths {
|
|
|
4636
4636
|
patch?: never;
|
|
4637
4637
|
trace?: never;
|
|
4638
4638
|
};
|
|
4639
|
+
"/api/v1/audit-entries": {
|
|
4640
|
+
parameters: {
|
|
4641
|
+
query?: never;
|
|
4642
|
+
header?: never;
|
|
4643
|
+
path?: never;
|
|
4644
|
+
cookie?: never;
|
|
4645
|
+
};
|
|
4646
|
+
/**
|
|
4647
|
+
* What happened to this broker's records, and who did it
|
|
4648
|
+
* @description NFR-012's question — reconstruct who changed a sensitive record — over this broker's own trail and no one else's. Newest first, paged by an opaque cursor, with no total count. Filter by action, actor, entity, correlation identifier, outcome and period; every filter has an index behind it. An action this platform does not record is refused rather than answered with an empty page.
|
|
4649
|
+
*/
|
|
4650
|
+
get: operations["SearchAuditTrail"];
|
|
4651
|
+
put?: never;
|
|
4652
|
+
post?: never;
|
|
4653
|
+
delete?: never;
|
|
4654
|
+
options?: never;
|
|
4655
|
+
head?: never;
|
|
4656
|
+
patch?: never;
|
|
4657
|
+
trace?: never;
|
|
4658
|
+
};
|
|
4659
|
+
"/api/v1/audit-entries/actions": {
|
|
4660
|
+
parameters: {
|
|
4661
|
+
query?: never;
|
|
4662
|
+
header?: never;
|
|
4663
|
+
path?: never;
|
|
4664
|
+
cookie?: never;
|
|
4665
|
+
};
|
|
4666
|
+
/**
|
|
4667
|
+
* The values the action filter accepts
|
|
4668
|
+
* @description Built from the platform's audit action inventory rather than from a seeded catalogue (ADR-0014). The same list on every deployment. It is six values short while issue #313 is open, which the response says rather than leaves to be inferred.
|
|
4669
|
+
*/
|
|
4670
|
+
get: operations["ListAuditTrailActions"];
|
|
4671
|
+
put?: never;
|
|
4672
|
+
post?: never;
|
|
4673
|
+
delete?: never;
|
|
4674
|
+
options?: never;
|
|
4675
|
+
head?: never;
|
|
4676
|
+
patch?: never;
|
|
4677
|
+
trace?: never;
|
|
4678
|
+
};
|
|
4679
|
+
"/api/v1/platform/audit-entries": {
|
|
4680
|
+
parameters: {
|
|
4681
|
+
query?: never;
|
|
4682
|
+
header?: never;
|
|
4683
|
+
path?: never;
|
|
4684
|
+
cookie?: never;
|
|
4685
|
+
};
|
|
4686
|
+
/**
|
|
4687
|
+
* What platform operations did, and who did it
|
|
4688
|
+
* @description The platform's record of itself: credentials issued, rotated and revoked, administrators granted and withdrawn, and every cross-tenant read of a broker's trail. Newest first, paged by an opaque cursor, with no total count. Filter by action, operator, entity, correlation identifier, outcome, period and the broker an entry was about.
|
|
4689
|
+
*/
|
|
4690
|
+
get: operations["SearchPlatformAuditTrail"];
|
|
4691
|
+
put?: never;
|
|
4692
|
+
post?: never;
|
|
4693
|
+
delete?: never;
|
|
4694
|
+
options?: never;
|
|
4695
|
+
head?: never;
|
|
4696
|
+
patch?: never;
|
|
4697
|
+
trace?: never;
|
|
4698
|
+
};
|
|
4699
|
+
"/api/v1/platform/audit-entries/actions": {
|
|
4700
|
+
parameters: {
|
|
4701
|
+
query?: never;
|
|
4702
|
+
header?: never;
|
|
4703
|
+
path?: never;
|
|
4704
|
+
cookie?: never;
|
|
4705
|
+
};
|
|
4706
|
+
/**
|
|
4707
|
+
* The values the action filter accepts
|
|
4708
|
+
* @description Built from the platform's audit action inventory rather than from a seeded catalogue (ADR-0014). One list for both trails, because both carry one vocabulary and one check constraint. It is six values short while issue #313 is open.
|
|
4709
|
+
*/
|
|
4710
|
+
get: operations["ListPlatformAuditTrailActions"];
|
|
4711
|
+
put?: never;
|
|
4712
|
+
post?: never;
|
|
4713
|
+
delete?: never;
|
|
4714
|
+
options?: never;
|
|
4715
|
+
head?: never;
|
|
4716
|
+
patch?: never;
|
|
4717
|
+
trace?: never;
|
|
4718
|
+
};
|
|
4719
|
+
"/api/v1/platform/tenants/{tenantKey}/audit-entries": {
|
|
4720
|
+
parameters: {
|
|
4721
|
+
query?: never;
|
|
4722
|
+
header?: never;
|
|
4723
|
+
path?: never;
|
|
4724
|
+
cookie?: never;
|
|
4725
|
+
};
|
|
4726
|
+
/**
|
|
4727
|
+
* What a named broker's staff did, read from platform scope
|
|
4728
|
+
* @description The question support is asked after an incident and cannot otherwise answer. Every invocation writes a platform audit entry naming the broker read, the operator who read it and what they filtered for — ADR-0010's accountability rests on that entry, so the read is refused if it cannot be recorded. Newest first, paged by an opaque cursor, with no total count.
|
|
4729
|
+
*/
|
|
4730
|
+
get: operations["SearchTenantAuditTrail"];
|
|
4731
|
+
put?: never;
|
|
4732
|
+
post?: never;
|
|
4733
|
+
delete?: never;
|
|
4734
|
+
options?: never;
|
|
4735
|
+
head?: never;
|
|
4736
|
+
patch?: never;
|
|
4737
|
+
trace?: never;
|
|
4738
|
+
};
|
|
4739
|
+
"/api/v1/platform/tenants/{tenantKey}/audit-entries/actions": {
|
|
4740
|
+
parameters: {
|
|
4741
|
+
query?: never;
|
|
4742
|
+
header?: never;
|
|
4743
|
+
path?: never;
|
|
4744
|
+
cookie?: never;
|
|
4745
|
+
};
|
|
4746
|
+
/**
|
|
4747
|
+
* The values the action filter accepts
|
|
4748
|
+
* @description Built from the platform's audit action inventory rather than from a seeded catalogue (ADR-0014). It discloses nothing about the broker named in the path — the vocabulary is a property of the software — so unlike the listing beside it, this route records no audit entry. It is six values short while issue #313 is open.
|
|
4749
|
+
*/
|
|
4750
|
+
get: operations["ListTenantAuditTrailActions"];
|
|
4751
|
+
put?: never;
|
|
4752
|
+
post?: never;
|
|
4753
|
+
delete?: never;
|
|
4754
|
+
options?: never;
|
|
4755
|
+
head?: never;
|
|
4756
|
+
patch?: never;
|
|
4757
|
+
trace?: never;
|
|
4758
|
+
};
|
|
4639
4759
|
}
|
|
4640
4760
|
export type webhooks = Record<string, never>;
|
|
4641
4761
|
export interface components {
|
|
@@ -4717,6 +4837,39 @@ export interface components {
|
|
|
4717
4837
|
/** Format: uuid */
|
|
4718
4838
|
insurerId: null | string;
|
|
4719
4839
|
};
|
|
4840
|
+
AuditActionsResponse: {
|
|
4841
|
+
actions: string[];
|
|
4842
|
+
incomplete: boolean;
|
|
4843
|
+
};
|
|
4844
|
+
AuditChangeResponse: {
|
|
4845
|
+
property: string;
|
|
4846
|
+
from: null | string;
|
|
4847
|
+
to: null | string;
|
|
4848
|
+
};
|
|
4849
|
+
AuditEntryPage: {
|
|
4850
|
+
items: components["schemas"]["AuditEntryResponse"][];
|
|
4851
|
+
nextCursor: null | string;
|
|
4852
|
+
};
|
|
4853
|
+
AuditEntryResponse: {
|
|
4854
|
+
/** Format: uuid */
|
|
4855
|
+
id: string;
|
|
4856
|
+
/** Format: date-time */
|
|
4857
|
+
occurredAtUtc: string;
|
|
4858
|
+
action: string;
|
|
4859
|
+
outcome: string;
|
|
4860
|
+
entityType: string;
|
|
4861
|
+
entityId: string;
|
|
4862
|
+
reference: null | string;
|
|
4863
|
+
actorSubjectId: null | string;
|
|
4864
|
+
/** Format: uuid */
|
|
4865
|
+
actingPartyId: null | string;
|
|
4866
|
+
source: string;
|
|
4867
|
+
correlationId: null | string;
|
|
4868
|
+
clientIpAddress: null | string;
|
|
4869
|
+
clientUserAgent: null | string;
|
|
4870
|
+
detail: null | string;
|
|
4871
|
+
changes: components["schemas"]["AuditChangeResponse"][];
|
|
4872
|
+
};
|
|
4720
4873
|
BranchResponse: {
|
|
4721
4874
|
/** Format: uuid */
|
|
4722
4875
|
id: string;
|
|
@@ -5928,6 +6081,31 @@ export interface components {
|
|
|
5928
6081
|
/** Format: date-time */
|
|
5929
6082
|
updatedAtUtc: string;
|
|
5930
6083
|
};
|
|
6084
|
+
PlatformAuditEntryPage: {
|
|
6085
|
+
items: components["schemas"]["PlatformAuditEntryResponse"][];
|
|
6086
|
+
nextCursor: null | string;
|
|
6087
|
+
};
|
|
6088
|
+
PlatformAuditEntryResponse: {
|
|
6089
|
+
/** Format: uuid */
|
|
6090
|
+
id: string;
|
|
6091
|
+
/** Format: date-time */
|
|
6092
|
+
occurredAtUtc: string;
|
|
6093
|
+
action: string;
|
|
6094
|
+
outcome: string;
|
|
6095
|
+
entityType: string;
|
|
6096
|
+
entityId: string;
|
|
6097
|
+
reference: null | string;
|
|
6098
|
+
/** Format: uuid */
|
|
6099
|
+
affectedTenantId: null | string;
|
|
6100
|
+
affectedTenantKey: null | string;
|
|
6101
|
+
actorSubjectId: null | string;
|
|
6102
|
+
source: string;
|
|
6103
|
+
correlationId: null | string;
|
|
6104
|
+
clientIpAddress: null | string;
|
|
6105
|
+
clientUserAgent: null | string;
|
|
6106
|
+
detail: null | string;
|
|
6107
|
+
changes: components["schemas"]["AuditChangeResponse"][];
|
|
6108
|
+
};
|
|
5931
6109
|
PlatformPlanFeatureResponse: {
|
|
5932
6110
|
featureKey: string;
|
|
5933
6111
|
value: string;
|
|
@@ -18402,4 +18580,231 @@ export interface operations {
|
|
|
18402
18580
|
};
|
|
18403
18581
|
};
|
|
18404
18582
|
};
|
|
18583
|
+
SearchAuditTrail: {
|
|
18584
|
+
parameters: {
|
|
18585
|
+
query?: {
|
|
18586
|
+
action?: string;
|
|
18587
|
+
actor?: string;
|
|
18588
|
+
entityType?: string;
|
|
18589
|
+
entityId?: string;
|
|
18590
|
+
correlationId?: string;
|
|
18591
|
+
outcome?: string;
|
|
18592
|
+
from?: string;
|
|
18593
|
+
to?: string;
|
|
18594
|
+
cursor?: string;
|
|
18595
|
+
limit?: number | string;
|
|
18596
|
+
};
|
|
18597
|
+
header?: never;
|
|
18598
|
+
path?: never;
|
|
18599
|
+
cookie?: never;
|
|
18600
|
+
};
|
|
18601
|
+
requestBody?: never;
|
|
18602
|
+
responses: {
|
|
18603
|
+
/** @description OK */
|
|
18604
|
+
200: {
|
|
18605
|
+
headers: {
|
|
18606
|
+
[name: string]: unknown;
|
|
18607
|
+
};
|
|
18608
|
+
content: {
|
|
18609
|
+
"application/json": components["schemas"]["AuditEntryPage"];
|
|
18610
|
+
};
|
|
18611
|
+
};
|
|
18612
|
+
/** @description Bad Request */
|
|
18613
|
+
400: {
|
|
18614
|
+
headers: {
|
|
18615
|
+
[name: string]: unknown;
|
|
18616
|
+
};
|
|
18617
|
+
content: {
|
|
18618
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
18619
|
+
};
|
|
18620
|
+
};
|
|
18621
|
+
};
|
|
18622
|
+
};
|
|
18623
|
+
ListAuditTrailActions: {
|
|
18624
|
+
parameters: {
|
|
18625
|
+
query?: never;
|
|
18626
|
+
header?: never;
|
|
18627
|
+
path?: never;
|
|
18628
|
+
cookie?: never;
|
|
18629
|
+
};
|
|
18630
|
+
requestBody?: never;
|
|
18631
|
+
responses: {
|
|
18632
|
+
/** @description OK */
|
|
18633
|
+
200: {
|
|
18634
|
+
headers: {
|
|
18635
|
+
[name: string]: unknown;
|
|
18636
|
+
};
|
|
18637
|
+
content: {
|
|
18638
|
+
"application/json": components["schemas"]["AuditActionsResponse"];
|
|
18639
|
+
};
|
|
18640
|
+
};
|
|
18641
|
+
};
|
|
18642
|
+
};
|
|
18643
|
+
SearchPlatformAuditTrail: {
|
|
18644
|
+
parameters: {
|
|
18645
|
+
query?: {
|
|
18646
|
+
action?: string;
|
|
18647
|
+
actor?: string;
|
|
18648
|
+
entityType?: string;
|
|
18649
|
+
entityId?: string;
|
|
18650
|
+
correlationId?: string;
|
|
18651
|
+
outcome?: string;
|
|
18652
|
+
from?: string;
|
|
18653
|
+
to?: string;
|
|
18654
|
+
affectedTenant?: string;
|
|
18655
|
+
cursor?: string;
|
|
18656
|
+
limit?: number | string;
|
|
18657
|
+
};
|
|
18658
|
+
header?: never;
|
|
18659
|
+
path?: never;
|
|
18660
|
+
cookie?: never;
|
|
18661
|
+
};
|
|
18662
|
+
requestBody?: never;
|
|
18663
|
+
responses: {
|
|
18664
|
+
/** @description OK */
|
|
18665
|
+
200: {
|
|
18666
|
+
headers: {
|
|
18667
|
+
[name: string]: unknown;
|
|
18668
|
+
};
|
|
18669
|
+
content: {
|
|
18670
|
+
"application/json": components["schemas"]["PlatformAuditEntryPage"];
|
|
18671
|
+
};
|
|
18672
|
+
};
|
|
18673
|
+
/** @description Bad Request */
|
|
18674
|
+
400: {
|
|
18675
|
+
headers: {
|
|
18676
|
+
[name: string]: unknown;
|
|
18677
|
+
};
|
|
18678
|
+
content: {
|
|
18679
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
18680
|
+
};
|
|
18681
|
+
};
|
|
18682
|
+
/** @description Forbidden */
|
|
18683
|
+
403: {
|
|
18684
|
+
headers: {
|
|
18685
|
+
[name: string]: unknown;
|
|
18686
|
+
};
|
|
18687
|
+
content?: never;
|
|
18688
|
+
};
|
|
18689
|
+
};
|
|
18690
|
+
};
|
|
18691
|
+
ListPlatformAuditTrailActions: {
|
|
18692
|
+
parameters: {
|
|
18693
|
+
query?: never;
|
|
18694
|
+
header?: never;
|
|
18695
|
+
path?: never;
|
|
18696
|
+
cookie?: never;
|
|
18697
|
+
};
|
|
18698
|
+
requestBody?: never;
|
|
18699
|
+
responses: {
|
|
18700
|
+
/** @description OK */
|
|
18701
|
+
200: {
|
|
18702
|
+
headers: {
|
|
18703
|
+
[name: string]: unknown;
|
|
18704
|
+
};
|
|
18705
|
+
content: {
|
|
18706
|
+
"application/json": components["schemas"]["AuditActionsResponse"];
|
|
18707
|
+
};
|
|
18708
|
+
};
|
|
18709
|
+
/** @description Forbidden */
|
|
18710
|
+
403: {
|
|
18711
|
+
headers: {
|
|
18712
|
+
[name: string]: unknown;
|
|
18713
|
+
};
|
|
18714
|
+
content?: never;
|
|
18715
|
+
};
|
|
18716
|
+
};
|
|
18717
|
+
};
|
|
18718
|
+
SearchTenantAuditTrail: {
|
|
18719
|
+
parameters: {
|
|
18720
|
+
query?: {
|
|
18721
|
+
action?: string;
|
|
18722
|
+
actor?: string;
|
|
18723
|
+
entityType?: string;
|
|
18724
|
+
entityId?: string;
|
|
18725
|
+
correlationId?: string;
|
|
18726
|
+
outcome?: string;
|
|
18727
|
+
from?: string;
|
|
18728
|
+
to?: string;
|
|
18729
|
+
cursor?: string;
|
|
18730
|
+
limit?: number | string;
|
|
18731
|
+
};
|
|
18732
|
+
header?: never;
|
|
18733
|
+
path: {
|
|
18734
|
+
tenantKey: string;
|
|
18735
|
+
};
|
|
18736
|
+
cookie?: never;
|
|
18737
|
+
};
|
|
18738
|
+
requestBody?: never;
|
|
18739
|
+
responses: {
|
|
18740
|
+
/** @description OK */
|
|
18741
|
+
200: {
|
|
18742
|
+
headers: {
|
|
18743
|
+
[name: string]: unknown;
|
|
18744
|
+
};
|
|
18745
|
+
content: {
|
|
18746
|
+
"application/json": components["schemas"]["AuditEntryPage"];
|
|
18747
|
+
};
|
|
18748
|
+
};
|
|
18749
|
+
/** @description Bad Request */
|
|
18750
|
+
400: {
|
|
18751
|
+
headers: {
|
|
18752
|
+
[name: string]: unknown;
|
|
18753
|
+
};
|
|
18754
|
+
content: {
|
|
18755
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
18756
|
+
};
|
|
18757
|
+
};
|
|
18758
|
+
/** @description Forbidden */
|
|
18759
|
+
403: {
|
|
18760
|
+
headers: {
|
|
18761
|
+
[name: string]: unknown;
|
|
18762
|
+
};
|
|
18763
|
+
content?: never;
|
|
18764
|
+
};
|
|
18765
|
+
/** @description Not Found */
|
|
18766
|
+
404: {
|
|
18767
|
+
headers: {
|
|
18768
|
+
[name: string]: unknown;
|
|
18769
|
+
};
|
|
18770
|
+
content?: never;
|
|
18771
|
+
};
|
|
18772
|
+
};
|
|
18773
|
+
};
|
|
18774
|
+
ListTenantAuditTrailActions: {
|
|
18775
|
+
parameters: {
|
|
18776
|
+
query?: never;
|
|
18777
|
+
header?: never;
|
|
18778
|
+
path: {
|
|
18779
|
+
tenantKey: string;
|
|
18780
|
+
};
|
|
18781
|
+
cookie?: never;
|
|
18782
|
+
};
|
|
18783
|
+
requestBody?: never;
|
|
18784
|
+
responses: {
|
|
18785
|
+
/** @description OK */
|
|
18786
|
+
200: {
|
|
18787
|
+
headers: {
|
|
18788
|
+
[name: string]: unknown;
|
|
18789
|
+
};
|
|
18790
|
+
content: {
|
|
18791
|
+
"application/json": components["schemas"]["AuditActionsResponse"];
|
|
18792
|
+
};
|
|
18793
|
+
};
|
|
18794
|
+
/** @description Forbidden */
|
|
18795
|
+
403: {
|
|
18796
|
+
headers: {
|
|
18797
|
+
[name: string]: unknown;
|
|
18798
|
+
};
|
|
18799
|
+
content?: never;
|
|
18800
|
+
};
|
|
18801
|
+
/** @description Not Found */
|
|
18802
|
+
404: {
|
|
18803
|
+
headers: {
|
|
18804
|
+
[name: string]: unknown;
|
|
18805
|
+
};
|
|
18806
|
+
content?: never;
|
|
18807
|
+
};
|
|
18808
|
+
};
|
|
18809
|
+
};
|
|
18405
18810
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@insurance-broker/api-client",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.44.0",
|
|
4
4
|
"description": "Generated TypeScript client for the Insurance Broker Platform API. Do not edit by hand: regenerate with scripts/update-api-contract.",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
6
|
"private": false,
|