@insurance-broker/api-client 1.10.0 → 1.11.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 +74 -0
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -1871,6 +1871,32 @@ export interface paths {
1871
1871
  patch?: never;
1872
1872
  trace?: never;
1873
1873
  };
1874
+ "/api/v1/renewals/{id}": {
1875
+ parameters: {
1876
+ query?: never;
1877
+ header?: never;
1878
+ path?: never;
1879
+ cookie?: never;
1880
+ };
1881
+ /**
1882
+ * Read one renewal and its checklist
1883
+ * @description REN-002 and REN-006. The case's identifiers and stored status, the identifiers of what satisfied its reconfirmation and its terms, and its checklist: one row per condition with which side owes it, what enforces it, whether this case requires it, and when it was satisfied.
1884
+ *
1885
+ * **`enforcedBy` is the field to read before trusting `satisfiedAtUtc`.** A condition nothing on this platform enforces reports `NotBuilt`, so a satisfied payment condition means a payment rule that does not exist is vacuously satisfied - not that a payment was taken (ADR-0040 section 4).
1886
+ *
1887
+ * Every condition is resolved onto every case, so `approval` is present with `isRequired` false rather than absent. Read `isRequired` instead of assuming: a broker's configuration moves the flag, not the row (ADR-0040 section 4).
1888
+ *
1889
+ * Carries identifiers and no names, and not the previous policy's pinned snapshot. Another broker's case, another customer's case and a case that does not exist are one 404, so the route cannot be used to discover which renewals exist.
1890
+ */
1891
+ get: operations["GetRenewal"];
1892
+ put?: never;
1893
+ post?: never;
1894
+ delete?: never;
1895
+ options?: never;
1896
+ head?: never;
1897
+ patch?: never;
1898
+ trace?: never;
1899
+ };
1874
1900
  "/api/v1/renewals/{id}/customer-information": {
1875
1901
  parameters: {
1876
1902
  query?: never;
@@ -3803,6 +3829,15 @@ export interface components {
3803
3829
  RenameFormDefinitionRequest: {
3804
3830
  name: null | string;
3805
3831
  };
3832
+ RenewalCaseDetailResponse: {
3833
+ case: components["schemas"]["RenewalCaseSummaryResponse"];
3834
+ /** Format: uuid */
3835
+ customerInformationSubmissionId: null | string;
3836
+ customerInformationDefinitionContentHash: null | string;
3837
+ /** Format: uuid */
3838
+ quoteRequestId: null | string;
3839
+ checklist: components["schemas"]["RenewalChecklistItemResponse"][];
3840
+ };
3806
3841
  RenewalCasePage: {
3807
3842
  items: components["schemas"]["RenewalCaseSummaryResponse"][];
3808
3843
  nextCursor: null | string;
@@ -3829,6 +3864,14 @@ export interface components {
3829
3864
  /** Format: date-time */
3830
3865
  openedAtUtc: string;
3831
3866
  };
3867
+ RenewalChecklistItemResponse: {
3868
+ condition: string;
3869
+ owedBy: string;
3870
+ enforcedBy: string;
3871
+ isRequired: boolean;
3872
+ /** Format: date-time */
3873
+ satisfiedAtUtc: null | string;
3874
+ };
3832
3875
  RenewalCompletionResponse: {
3833
3876
  /** Format: uuid */
3834
3877
  renewalCaseId: string;
@@ -9054,6 +9097,37 @@ export interface operations {
9054
9097
  };
9055
9098
  };
9056
9099
  };
9100
+ GetRenewal: {
9101
+ parameters: {
9102
+ query?: never;
9103
+ header?: never;
9104
+ path: {
9105
+ id: string;
9106
+ };
9107
+ cookie?: never;
9108
+ };
9109
+ requestBody?: never;
9110
+ responses: {
9111
+ /** @description OK */
9112
+ 200: {
9113
+ headers: {
9114
+ [name: string]: unknown;
9115
+ };
9116
+ content: {
9117
+ "application/json": components["schemas"]["RenewalCaseDetailResponse"];
9118
+ };
9119
+ };
9120
+ /** @description Not Found */
9121
+ 404: {
9122
+ headers: {
9123
+ [name: string]: unknown;
9124
+ };
9125
+ content: {
9126
+ "application/problem+json": components["schemas"]["ProblemDetails"];
9127
+ };
9128
+ };
9129
+ };
9130
+ };
9057
9131
  RecordRenewalCustomerInformation: {
9058
9132
  parameters: {
9059
9133
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@insurance-broker/api-client",
3
- "version": "1.10.0",
3
+ "version": "1.11.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,