@insurance-broker/api-client 1.20.0 → 1.23.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 +161 -0
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -901,6 +901,56 @@ export interface paths {
901
901
  patch?: never;
902
902
  trace?: never;
903
903
  };
904
+ "/api/v1/claims/{id}/form": {
905
+ parameters: {
906
+ query?: never;
907
+ header?: never;
908
+ path?: never;
909
+ cookie?: never;
910
+ };
911
+ get?: never;
912
+ /**
913
+ * Record the claim form the customer answered
914
+ * @description CLM-002. The customer answers the product's published claim form through the form routes; this records which submission it was.
915
+ *
916
+ * **Nothing here captures or validates an answer.** A claim form is an ordinary form definition of kind `Claim` against the same product, read by the same engine that serves quotes (ADR-0041 section 4).
917
+ *
918
+ * Refused if the submission is not a submitted claim form for this claim's product, or if it was submitted before the claim was reported - a submission that predates the claim cannot be an account of it. A submission already recorded against another claim is refused too.
919
+ *
920
+ * **A submission with no owner is accepted.** A claim already knows whose it is, from the policy it was checked against, so it asks nothing of the submission's ownership - which is what lets a broker take a first notice of loss over the telephone and answer the form with the customer on the line.
921
+ */
922
+ put: operations["RecordClaimForm"];
923
+ post?: never;
924
+ delete?: never;
925
+ options?: never;
926
+ head?: never;
927
+ patch?: never;
928
+ trace?: never;
929
+ };
930
+ "/api/v1/claims/{id}/closure": {
931
+ parameters: {
932
+ query?: never;
933
+ header?: never;
934
+ path?: never;
935
+ cookie?: never;
936
+ };
937
+ get?: never;
938
+ put?: never;
939
+ /**
940
+ * Finish a claim, recording why
941
+ * @description CLM-005. Records that the broker has stopped helping, and why.
942
+ *
943
+ * **The reason is your own words, not a code from a list.** A list of closure reasons would have to name settlements and declinatures, and those are the insurer's decisions rather than this platform's (ADR-0041 section 2). What the insurer decided is recorded separately, attributed to whoever wrote it down.
944
+ *
945
+ * **Closing starts the retention clock** on the claim and on everything filed against it. There is no route that reopens a claim: a disposal clock that can be wound back is not one. A claim that must be worked again is reported again.
946
+ */
947
+ post: operations["CloseClaim"];
948
+ delete?: never;
949
+ options?: never;
950
+ head?: never;
951
+ patch?: never;
952
+ trace?: never;
953
+ };
904
954
  "/api/v1/claims/{id}/withdrawal": {
905
955
  parameters: {
906
956
  query?: never;
@@ -3067,6 +3117,8 @@ export interface components {
3067
3117
  status: string;
3068
3118
  /** Format: date-time */
3069
3119
  retentionAnchorAtUtc: null | string;
3120
+ /** Format: uuid */
3121
+ claimFormSubmissionId: null | string;
3070
3122
  };
3071
3123
  ClaimTimelineEntryResponse: {
3072
3124
  /** Format: uuid */
@@ -3077,6 +3129,9 @@ export interface components {
3077
3129
  /** Format: date-time */
3078
3130
  occurredAtUtc: string;
3079
3131
  };
3132
+ CloseClaimRequest: {
3133
+ reason: string;
3134
+ };
3080
3135
  ComparedAttributeResponse: {
3081
3136
  key: string;
3082
3137
  label: string;
@@ -4054,6 +4109,10 @@ export interface components {
4054
4109
  answers: null | components["schemas"]["JsonElement"];
4055
4110
  source: null | string;
4056
4111
  };
4112
+ RecordClaimFormRequest: {
4113
+ /** Format: uuid */
4114
+ submissionId: string;
4115
+ };
4057
4116
  RecordFollowUpRequest: {
4058
4117
  /** Format: date */
4059
4118
  dueOn: null | string;
@@ -6887,6 +6946,108 @@ export interface operations {
6887
6946
  };
6888
6947
  };
6889
6948
  };
6949
+ RecordClaimForm: {
6950
+ parameters: {
6951
+ query?: never;
6952
+ header?: never;
6953
+ path: {
6954
+ id: string;
6955
+ };
6956
+ cookie?: never;
6957
+ };
6958
+ requestBody: {
6959
+ content: {
6960
+ "application/json": components["schemas"]["RecordClaimFormRequest"];
6961
+ };
6962
+ };
6963
+ responses: {
6964
+ /** @description OK */
6965
+ 200: {
6966
+ headers: {
6967
+ [name: string]: unknown;
6968
+ };
6969
+ content: {
6970
+ "application/json": components["schemas"]["ClaimResponse"];
6971
+ };
6972
+ };
6973
+ /** @description Bad Request */
6974
+ 400: {
6975
+ headers: {
6976
+ [name: string]: unknown;
6977
+ };
6978
+ content: {
6979
+ "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
6980
+ };
6981
+ };
6982
+ /** @description Not Found */
6983
+ 404: {
6984
+ headers: {
6985
+ [name: string]: unknown;
6986
+ };
6987
+ content?: never;
6988
+ };
6989
+ /** @description Conflict */
6990
+ 409: {
6991
+ headers: {
6992
+ [name: string]: unknown;
6993
+ };
6994
+ content: {
6995
+ "application/problem+json": components["schemas"]["ProblemDetails"];
6996
+ };
6997
+ };
6998
+ };
6999
+ };
7000
+ CloseClaim: {
7001
+ parameters: {
7002
+ query?: never;
7003
+ header?: never;
7004
+ path: {
7005
+ id: string;
7006
+ };
7007
+ cookie?: never;
7008
+ };
7009
+ requestBody: {
7010
+ content: {
7011
+ "application/json": components["schemas"]["CloseClaimRequest"];
7012
+ };
7013
+ };
7014
+ responses: {
7015
+ /** @description OK */
7016
+ 200: {
7017
+ headers: {
7018
+ [name: string]: unknown;
7019
+ };
7020
+ content: {
7021
+ "application/json": components["schemas"]["ClaimResponse"];
7022
+ };
7023
+ };
7024
+ /** @description Bad Request */
7025
+ 400: {
7026
+ headers: {
7027
+ [name: string]: unknown;
7028
+ };
7029
+ content: {
7030
+ "application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
7031
+ };
7032
+ };
7033
+ /** @description Not Found */
7034
+ 404: {
7035
+ headers: {
7036
+ [name: string]: unknown;
7037
+ };
7038
+ content?: never;
7039
+ };
7040
+ /** @description Conflict */
7041
+ 409: {
7042
+ headers: {
7043
+ [name: string]: unknown;
7044
+ };
7045
+ content: {
7046
+ "application/problem+json": components["schemas"]["ProblemDetails"];
7047
+ };
7048
+ };
7049
+ };
7050
+ };
6890
7051
  WithdrawClaim: {
6891
7052
  parameters: {
6892
7053
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@insurance-broker/api-client",
3
- "version": "1.20.0",
3
+ "version": "1.23.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,