@insurance-broker/api-client 1.27.0 → 1.28.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.
Files changed (2) hide show
  1. package/dist/schema.d.ts +122 -2
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -858,7 +858,19 @@ export interface paths {
858
858
  path?: never;
859
859
  cookie?: never;
860
860
  };
861
- get?: never;
861
+ /**
862
+ * List this broker's claims in one of three views
863
+ * @description CLM-005. The broker's claims, newest notification first, in one of three views named by `view`: `open` is every claim still being worked, and `withdrawn` and `closed` are the two concluded outcomes. Optionally narrowed by product, insurer, customer or policy. Paged by cursor.
864
+ *
865
+ * **Carries identifiers and no names.** A product's name and an insurer's live in the catalogue and a customer's in CRM, so a client joins those surfaces itself (ADR-0002).
866
+ *
867
+ * **There is no filter for the member of staff working a claim, because a claim does not record one.** Nothing in this phase assigns claim work; a renewal case carries an assignee and a claim does not, and inventing the column here would be inventing an assignment model inside a list.
868
+ *
869
+ * **`status` is what the broker is doing, never what an insurer decided** (ADR-0041 section 2). What an insurer said is a separate recorded fact with its own route and its own provenance.
870
+ *
871
+ * Another broker's claims are not in any view. The tenant is never a parameter here: it comes from the caller's own session, and the four filters this route accepts all narrow within it.
872
+ */
873
+ get: operations["ListClaims"];
862
874
  put?: never;
863
875
  /**
864
876
  * Record a first notice of loss against a policy
@@ -1326,7 +1338,17 @@ export interface paths {
1326
1338
  path?: never;
1327
1339
  cookie?: never;
1328
1340
  };
1329
- get?: never;
1341
+ /**
1342
+ * List the claims you have reported
1343
+ * @description CLM-006. Every claim of yours, most recent incident first, paged by cursor.
1344
+ *
1345
+ * **You are not named in the request.** There is no customer field and no broker field: the list is whoever is signed in, resolved from the session. Another person's claims are not in it - not filtered out of it, but absent, because a claim that is not yours is not visible to this route at all.
1346
+ *
1347
+ * **This carries nothing your broker wrote for themselves.** Each row says what the claim is and what your broker is doing about it. Your broker's working notes are a different record entirely, which nothing here can reach (ADR-0041 section 3); what they have chosen to tell you is on each claim's own timeline.
1348
+ *
1349
+ * **`status` is what your broker is doing, never what your insurer decided** (ADR-0041 section 2). What the insurer said is on each claim's own insurer-outcomes route.
1350
+ */
1351
+ get: operations["ListOwnClaims"];
1330
1352
  put?: never;
1331
1353
  /**
1332
1354
  * Report a loss on one of your own policies
@@ -3509,6 +3531,10 @@ export interface components {
3509
3531
  resolvedAtUtc: null | string;
3510
3532
  isOutstanding: boolean;
3511
3533
  };
3534
+ ClaimPage: {
3535
+ items: components["schemas"]["ClaimSummaryResponse"][];
3536
+ nextCursor: null | string;
3537
+ };
3512
3538
  ClaimResponse: {
3513
3539
  /** Format: uuid */
3514
3540
  id: string;
@@ -3526,6 +3552,27 @@ export interface components {
3526
3552
  /** Format: uuid */
3527
3553
  claimFormSubmissionId: null | string;
3528
3554
  };
3555
+ ClaimSummaryResponse: {
3556
+ /** Format: uuid */
3557
+ id: string;
3558
+ status: string;
3559
+ /** Format: uuid */
3560
+ customerId: string;
3561
+ /** Format: uuid */
3562
+ policyId: string;
3563
+ /** Format: uuid */
3564
+ productId: string;
3565
+ /** Format: uuid */
3566
+ insurerId: string;
3567
+ /** Format: date */
3568
+ incidentOn: string;
3569
+ /** Format: date-time */
3570
+ notifiedAtUtc: string;
3571
+ /** Format: date-time */
3572
+ retentionAnchorAtUtc: null | string;
3573
+ /** Format: uuid */
3574
+ claimFormSubmissionId: null | string;
3575
+ };
3529
3576
  ClaimTimelineEntryResponse: {
3530
3577
  /** Format: uuid */
3531
3578
  id: string;
@@ -3612,6 +3659,10 @@ export interface components {
3612
3659
  name: null | string;
3613
3660
  registrationNumber: null | string;
3614
3661
  };
3662
+ CustomerClaimPage: {
3663
+ items: components["schemas"]["ClaimResponse"][];
3664
+ nextCursor: null | string;
3665
+ };
3615
3666
  CustomerInsurerOutcomeResponse: {
3616
3667
  /** Format: uuid */
3617
3668
  id: string;
@@ -7379,6 +7430,43 @@ export interface operations {
7379
7430
  };
7380
7431
  };
7381
7432
  };
7433
+ ListClaims: {
7434
+ parameters: {
7435
+ query?: {
7436
+ view?: string;
7437
+ productId?: string;
7438
+ insurerId?: string;
7439
+ customerId?: string;
7440
+ policyId?: string;
7441
+ cursor?: string;
7442
+ limit?: number | string;
7443
+ };
7444
+ header?: never;
7445
+ path?: never;
7446
+ cookie?: never;
7447
+ };
7448
+ requestBody?: never;
7449
+ responses: {
7450
+ /** @description OK */
7451
+ 200: {
7452
+ headers: {
7453
+ [name: string]: unknown;
7454
+ };
7455
+ content: {
7456
+ "application/json": components["schemas"]["ClaimPage"];
7457
+ };
7458
+ };
7459
+ /** @description Bad Request */
7460
+ 400: {
7461
+ headers: {
7462
+ [name: string]: unknown;
7463
+ };
7464
+ content: {
7465
+ "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
7466
+ };
7467
+ };
7468
+ };
7469
+ };
7382
7470
  NotifyClaim: {
7383
7471
  parameters: {
7384
7472
  query?: never;
@@ -8341,6 +8429,38 @@ export interface operations {
8341
8429
  };
8342
8430
  };
8343
8431
  };
8432
+ ListOwnClaims: {
8433
+ parameters: {
8434
+ query?: {
8435
+ cursor?: string;
8436
+ limit?: number | string;
8437
+ };
8438
+ header?: never;
8439
+ path?: never;
8440
+ cookie?: never;
8441
+ };
8442
+ requestBody?: never;
8443
+ responses: {
8444
+ /** @description OK */
8445
+ 200: {
8446
+ headers: {
8447
+ [name: string]: unknown;
8448
+ };
8449
+ content: {
8450
+ "application/json": components["schemas"]["CustomerClaimPage"];
8451
+ };
8452
+ };
8453
+ /** @description Bad Request */
8454
+ 400: {
8455
+ headers: {
8456
+ [name: string]: unknown;
8457
+ };
8458
+ content: {
8459
+ "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
8460
+ };
8461
+ };
8462
+ };
8463
+ };
8344
8464
  ReportOwnClaim: {
8345
8465
  parameters: {
8346
8466
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@insurance-broker/api-client",
3
- "version": "1.27.0",
3
+ "version": "1.28.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,