@insurance-broker/api-client 5.42.0 → 5.43.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 -0
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -5345,6 +5345,36 @@ export interface paths {
5345
5345
  patch?: never;
5346
5346
  trace?: never;
5347
5347
  };
5348
+ "/api/v1/renewals/{id}/assignment": {
5349
+ parameters: {
5350
+ query?: never;
5351
+ header?: never;
5352
+ path?: never;
5353
+ cookie?: never;
5354
+ };
5355
+ get?: never;
5356
+ put?: never;
5357
+ /**
5358
+ * Give a renewal to a member of staff, or move it to a different one
5359
+ * @description REN-002 and REN-008. Records who is working a renewal, which is what the list's `assignedToSubjectId` filter groups by. The sweep opens every renewal unassigned (ADR-0040 section 2).
5360
+ *
5361
+ * The assignee must be an active member of this broker who holds `policies.renewals.manage` - somebody who can work the renewal they are given. A subject that is not, or that belongs to another broker, is refused with the same `400`, so the route cannot be used to learn who works where.
5362
+ *
5363
+ * Giving a renewal to the person who already has it changes nothing and answers `200`. A renewal that has concluded is refused with `409` and type `urn:brokerplatform:problem:renewal-concluded`: its assignee is kept as the record of who had it.
5364
+ *
5365
+ * **Never shown to the customer.** The customer's view of their renewal carries no member of staff.
5366
+ */
5367
+ post: operations["AssignRenewal"];
5368
+ /**
5369
+ * Take a renewal off whoever has it
5370
+ * @description Returns a renewal to unassigned work. A renewal nobody has changes nothing and answers `200`. A renewal that has concluded is refused with `409`, for the reason assigning one is.
5371
+ */
5372
+ delete: operations["UnassignRenewal"];
5373
+ options?: never;
5374
+ head?: never;
5375
+ patch?: never;
5376
+ trace?: never;
5377
+ };
5348
5378
  "/api/v1/customer/policy-documents": {
5349
5379
  parameters: {
5350
5380
  query?: never;
@@ -6919,6 +6949,9 @@ export interface components {
6919
6949
  AssignQuoteRequestRequest: {
6920
6950
  advisorSubjectId: null | string;
6921
6951
  };
6952
+ AssignRenewalRequest: {
6953
+ assigneeSubjectId: null | string;
6954
+ };
6922
6955
  AttachProductInsurerRequest: {
6923
6956
  /** Format: uuid */
6924
6957
  insurerId: null | string;
@@ -23422,6 +23455,95 @@ export interface operations {
23422
23455
  };
23423
23456
  };
23424
23457
  };
23458
+ AssignRenewal: {
23459
+ parameters: {
23460
+ query?: never;
23461
+ header?: never;
23462
+ path: {
23463
+ id: string;
23464
+ };
23465
+ cookie?: never;
23466
+ };
23467
+ requestBody: {
23468
+ content: {
23469
+ "application/json": components["schemas"]["AssignRenewalRequest"];
23470
+ };
23471
+ };
23472
+ responses: {
23473
+ /** @description OK */
23474
+ 200: {
23475
+ headers: {
23476
+ [name: string]: unknown;
23477
+ };
23478
+ content: {
23479
+ "application/json": components["schemas"]["RenewalCaseSummaryResponse"];
23480
+ };
23481
+ };
23482
+ /** @description Bad Request */
23483
+ 400: {
23484
+ headers: {
23485
+ [name: string]: unknown;
23486
+ };
23487
+ content: {
23488
+ "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
23489
+ };
23490
+ };
23491
+ /** @description Not Found */
23492
+ 404: {
23493
+ headers: {
23494
+ [name: string]: unknown;
23495
+ };
23496
+ content?: never;
23497
+ };
23498
+ /** @description Conflict. A type of urn:brokerplatform:problem:concurrency-conflict means someone else changed the record first and nothing was written: read it again and decide again. Any other type is a conflict this operation decided itself, and retrying it unchanged will not help. */
23499
+ 409: {
23500
+ headers: {
23501
+ [name: string]: unknown;
23502
+ };
23503
+ content: {
23504
+ "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
23505
+ };
23506
+ };
23507
+ };
23508
+ };
23509
+ UnassignRenewal: {
23510
+ parameters: {
23511
+ query?: never;
23512
+ header?: never;
23513
+ path: {
23514
+ id: string;
23515
+ };
23516
+ cookie?: never;
23517
+ };
23518
+ requestBody?: never;
23519
+ responses: {
23520
+ /** @description OK */
23521
+ 200: {
23522
+ headers: {
23523
+ [name: string]: unknown;
23524
+ };
23525
+ content: {
23526
+ "application/json": components["schemas"]["RenewalCaseSummaryResponse"];
23527
+ };
23528
+ };
23529
+ /** @description Not Found */
23530
+ 404: {
23531
+ headers: {
23532
+ [name: string]: unknown;
23533
+ };
23534
+ content?: never;
23535
+ };
23536
+ /** @description Conflict. A type of urn:brokerplatform:problem:concurrency-conflict means someone else changed the record first and nothing was written: read it again and decide again. Any other type is a conflict this operation decided itself, and retrying it unchanged will not help. */
23537
+ 409: {
23538
+ headers: {
23539
+ [name: string]: unknown;
23540
+ };
23541
+ content: {
23542
+ "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
23543
+ };
23544
+ };
23545
+ };
23546
+ };
23425
23547
  ListCustomerPolicyDocuments: {
23426
23548
  parameters: {
23427
23549
  query?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@insurance-broker/api-client",
3
- "version": "5.42.0",
3
+ "version": "5.43.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,