@insurance-broker/api-client 5.49.0 → 5.51.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 +549 -57
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -2990,7 +2990,7 @@ export interface paths {
|
|
|
2990
2990
|
patch?: never;
|
|
2991
2991
|
trace?: never;
|
|
2992
2992
|
};
|
|
2993
|
-
"/api/v1/
|
|
2993
|
+
"/api/v1/customers/{id}/notes": {
|
|
2994
2994
|
parameters: {
|
|
2995
2995
|
query?: never;
|
|
2996
2996
|
header?: never;
|
|
@@ -2998,21 +2998,25 @@ export interface paths {
|
|
|
2998
2998
|
cookie?: never;
|
|
2999
2999
|
};
|
|
3000
3000
|
/**
|
|
3001
|
-
*
|
|
3002
|
-
* @description
|
|
3003
|
-
*
|
|
3004
|
-
* **The `404` is retained for compatibility and is not the unattached state.** It means the caller holds the permission and the record is gone, which cannot happen through this API today; a client keying its onboarding branch on `404` will never reach it.
|
|
3001
|
+
* Read a customer's internal notes, logged calls and emails
|
|
3002
|
+
* @description CRM-009. Newest first, each saying who wrote it and whether it has been shared with the customer. Paged by cursor (ADR-0031): pass `nextCursor` back as `cursor` until it is null. A cursor this list did not issue is a `400`.
|
|
3005
3003
|
*/
|
|
3006
|
-
get: operations["
|
|
3004
|
+
get: operations["ListCustomerNotes"];
|
|
3007
3005
|
put?: never;
|
|
3008
|
-
|
|
3006
|
+
/**
|
|
3007
|
+
* Write an internal note about a customer, or log a call or an email
|
|
3008
|
+
* @description CRM-009. `kind` is `Consultation`, `Call` or `Email`. The note is internal: **the customer never sees it** unless a member of staff shares it. Writing one counts as contact with the customer, so it moves their last activity forward.
|
|
3009
|
+
*
|
|
3010
|
+
* A closed customer takes no further notes, because its retention clock has already started (409).
|
|
3011
|
+
*/
|
|
3012
|
+
post: operations["WriteCustomerNote"];
|
|
3009
3013
|
delete?: never;
|
|
3010
3014
|
options?: never;
|
|
3011
3015
|
head?: never;
|
|
3012
3016
|
patch?: never;
|
|
3013
3017
|
trace?: never;
|
|
3014
3018
|
};
|
|
3015
|
-
"/api/v1/
|
|
3019
|
+
"/api/v1/customers/{id}/notes/{noteId}/sharing": {
|
|
3016
3020
|
parameters: {
|
|
3017
3021
|
query?: never;
|
|
3018
3022
|
header?: never;
|
|
@@ -3022,23 +3026,41 @@ export interface paths {
|
|
|
3022
3026
|
get?: never;
|
|
3023
3027
|
put?: never;
|
|
3024
3028
|
/**
|
|
3025
|
-
*
|
|
3026
|
-
* @description
|
|
3027
|
-
*
|
|
3028
|
-
* **What a client must do afterwards.** Every request from a session established before the returned `revokedAtUtc` (plus a few seconds' clock allowance) is answered `401` with problem type `urn:brokerplatform:problem:session-revoked` — on any customer route, not only this one. **Do not refresh in answer to it**: the identity provider will issue a new token and that token will be refused the same way, because it belongs to the same sign-in. **Do not answer it with a `prompt=login` sign-in alone either**: on a device that still holds the identity provider's session cookie, that re-authenticates the *same* session and re-admits every refresh token copied from it. End the identity provider's session first (RP-initiated logout with `id_token_hint`), discard the stored tokens, then sign in.
|
|
3029
|
-
*
|
|
3030
|
-
* **Tell the customer to change their password, and to secure their email account.** Signing out does not stop somebody who knows the password from signing in again, and a password can be reset through the email address.
|
|
3031
|
-
*
|
|
3032
|
-
* **Where a deployment has enabled the isolated identity-management component (ADR-0049), the identity provider's sessions are also ended**, shortly after this answer and not before it: the request is recorded here and carried out in the background. Nowhere is that a reason to skip the steps above. It does not list sessions, or end one and keep the others. A `409` means the caller is acting for an organisation: sessions belong to the person, so act personally to revoke them.
|
|
3029
|
+
* Share an internal note's words with the customer
|
|
3030
|
+
* @description CRM-009. Copies the note's words into what the customer may be shown, recording who decided to and when. **A copy, not a flag**: the note is unchanged, a share cannot be undone, and sharing the same note twice is a `409`. A closed customer's notes cannot be shared (409).
|
|
3033
3031
|
*/
|
|
3034
|
-
post: operations["
|
|
3032
|
+
post: operations["ShareCustomerNote"];
|
|
3035
3033
|
delete?: never;
|
|
3036
3034
|
options?: never;
|
|
3037
3035
|
head?: never;
|
|
3038
3036
|
patch?: never;
|
|
3039
3037
|
trace?: never;
|
|
3040
3038
|
};
|
|
3041
|
-
"/api/v1/
|
|
3039
|
+
"/api/v1/customers/{id}/next-actions": {
|
|
3040
|
+
parameters: {
|
|
3041
|
+
query?: never;
|
|
3042
|
+
header?: never;
|
|
3043
|
+
path?: never;
|
|
3044
|
+
cookie?: never;
|
|
3045
|
+
};
|
|
3046
|
+
/**
|
|
3047
|
+
* Read a customer's next actions, open and done
|
|
3048
|
+
* @description CRM-008, CRM-009. Newest first, each with its owner, due date and whether it is done. Paged by cursor (ADR-0031): pass `nextCursor` back as `cursor` until it is null.
|
|
3049
|
+
*/
|
|
3050
|
+
get: operations["ListCustomerNextActions"];
|
|
3051
|
+
put?: never;
|
|
3052
|
+
/**
|
|
3053
|
+
* Record what a member of staff has to do next for a customer
|
|
3054
|
+
* @description CRM-009. An owner, a due date and a description. The owner must be an active member of this broker holding `crm.customer-actions.manage`. A closed customer takes no further actions (409).
|
|
3055
|
+
*/
|
|
3056
|
+
post: operations["RecordCustomerNextAction"];
|
|
3057
|
+
delete?: never;
|
|
3058
|
+
options?: never;
|
|
3059
|
+
head?: never;
|
|
3060
|
+
patch?: never;
|
|
3061
|
+
trace?: never;
|
|
3062
|
+
};
|
|
3063
|
+
"/api/v1/customers/{id}/next-actions/{actionId}/completion": {
|
|
3042
3064
|
parameters: {
|
|
3043
3065
|
query?: never;
|
|
3044
3066
|
header?: never;
|
|
@@ -3047,8 +3069,35 @@ export interface paths {
|
|
|
3047
3069
|
};
|
|
3048
3070
|
get?: never;
|
|
3049
3071
|
put?: never;
|
|
3050
|
-
/**
|
|
3051
|
-
|
|
3072
|
+
/**
|
|
3073
|
+
* Mark a customer's next action done
|
|
3074
|
+
* @description CRM-009. Records who did it and when. An action already done is a `409`, and so is the second of two completions racing each other.
|
|
3075
|
+
*/
|
|
3076
|
+
post: operations["CompleteCustomerNextAction"];
|
|
3077
|
+
delete?: never;
|
|
3078
|
+
options?: never;
|
|
3079
|
+
head?: never;
|
|
3080
|
+
patch?: never;
|
|
3081
|
+
trace?: never;
|
|
3082
|
+
};
|
|
3083
|
+
"/api/v1/customers/{id}/timeline": {
|
|
3084
|
+
parameters: {
|
|
3085
|
+
query?: never;
|
|
3086
|
+
header?: never;
|
|
3087
|
+
path?: never;
|
|
3088
|
+
cookie?: never;
|
|
3089
|
+
};
|
|
3090
|
+
/**
|
|
3091
|
+
* Read what has happened on a customer's relationship with the broker
|
|
3092
|
+
* @description CRM-008. Policies, claims, payments, quotes and form submissions as their modules report them, with the notes, logged calls and emails, shares and next actions staff recorded here. Newest first. Each row says what kind of thing happened and when. It never carries a note's words: read those through the notes route, which needs `crm.customer-notes.read`.
|
|
3093
|
+
*
|
|
3094
|
+
* The timeline begins when this release was deployed; earlier activity is not on it.
|
|
3095
|
+
*
|
|
3096
|
+
* Paged by cursor (ADR-0031): pass `nextCursor` back as `cursor` until it is null. A cursor this list did not issue is a `400`.
|
|
3097
|
+
*/
|
|
3098
|
+
get: operations["ListCustomerTimeline"];
|
|
3099
|
+
put?: never;
|
|
3100
|
+
post?: never;
|
|
3052
3101
|
delete?: never;
|
|
3053
3102
|
options?: never;
|
|
3054
3103
|
head?: never;
|
|
@@ -3126,6 +3175,71 @@ export interface paths {
|
|
|
3126
3175
|
patch?: never;
|
|
3127
3176
|
trace?: never;
|
|
3128
3177
|
};
|
|
3178
|
+
"/api/v1/customer-account": {
|
|
3179
|
+
parameters: {
|
|
3180
|
+
query?: never;
|
|
3181
|
+
header?: never;
|
|
3182
|
+
path?: never;
|
|
3183
|
+
cookie?: never;
|
|
3184
|
+
};
|
|
3185
|
+
/**
|
|
3186
|
+
* The account this broker holds for the signed-in customer.
|
|
3187
|
+
* @description **A `403` here is usually not an error.** `urn:brokerplatform:problem:customer-not-attached` means this sign-in has never been linked to a broker — the ordinary state of a customer who has registered but not yet redeemed an invitation, and the cue to show onboarding rather than a failure. A `403` *without* that type is an ordinary refusal and must not be read as onboarding: it is what a caller whose broker may not transact receives, and what a caller whose account the broker has suspended or closed receives.
|
|
3188
|
+
*
|
|
3189
|
+
* **The `404` is retained for compatibility and is not the unattached state.** It means the caller holds the permission and the record is gone, which cannot happen through this API today; a client keying its onboarding branch on `404` will never reach it.
|
|
3190
|
+
*/
|
|
3191
|
+
get: operations["GetOwnCustomerAccount"];
|
|
3192
|
+
put?: never;
|
|
3193
|
+
post?: never;
|
|
3194
|
+
delete?: never;
|
|
3195
|
+
options?: never;
|
|
3196
|
+
head?: never;
|
|
3197
|
+
patch?: never;
|
|
3198
|
+
trace?: never;
|
|
3199
|
+
};
|
|
3200
|
+
"/api/v1/customer-account/sessions/revocation": {
|
|
3201
|
+
parameters: {
|
|
3202
|
+
query?: never;
|
|
3203
|
+
header?: never;
|
|
3204
|
+
path?: never;
|
|
3205
|
+
cookie?: never;
|
|
3206
|
+
};
|
|
3207
|
+
get?: never;
|
|
3208
|
+
put?: never;
|
|
3209
|
+
/**
|
|
3210
|
+
* Signs the customer out of every session they have established, including this one.
|
|
3211
|
+
* @description **Every sign-in this customer established up to now stops working against this API on its next request — including the one making this call.** That is the stolen-device remedy (SEC-012): a phone that is lost keeps a session the customer cannot reach, and this ends what that session can do here without needing the phone.
|
|
3212
|
+
*
|
|
3213
|
+
* **What a client must do afterwards.** Every request from a session established before the returned `revokedAtUtc` (plus a few seconds' clock allowance) is answered `401` with problem type `urn:brokerplatform:problem:session-revoked` — on any customer route, not only this one. **Do not refresh in answer to it**: the identity provider will issue a new token and that token will be refused the same way, because it belongs to the same sign-in. **Do not answer it with a `prompt=login` sign-in alone either**: on a device that still holds the identity provider's session cookie, that re-authenticates the *same* session and re-admits every refresh token copied from it. End the identity provider's session first (RP-initiated logout with `id_token_hint`), discard the stored tokens, then sign in.
|
|
3214
|
+
*
|
|
3215
|
+
* **Tell the customer to change their password, and to secure their email account.** Signing out does not stop somebody who knows the password from signing in again, and a password can be reset through the email address.
|
|
3216
|
+
*
|
|
3217
|
+
* **Where a deployment has enabled the isolated identity-management component (ADR-0049), the identity provider's sessions are also ended**, shortly after this answer and not before it: the request is recorded here and carried out in the background. Nowhere is that a reason to skip the steps above. It does not list sessions, or end one and keep the others. A `409` means the caller is acting for an organisation: sessions belong to the person, so act personally to revoke them.
|
|
3218
|
+
*/
|
|
3219
|
+
post: operations["RevokeOwnCustomerSessions"];
|
|
3220
|
+
delete?: never;
|
|
3221
|
+
options?: never;
|
|
3222
|
+
head?: never;
|
|
3223
|
+
patch?: never;
|
|
3224
|
+
trace?: never;
|
|
3225
|
+
};
|
|
3226
|
+
"/api/v1/customer-account/redemption": {
|
|
3227
|
+
parameters: {
|
|
3228
|
+
query?: never;
|
|
3229
|
+
header?: never;
|
|
3230
|
+
path?: never;
|
|
3231
|
+
cookie?: never;
|
|
3232
|
+
};
|
|
3233
|
+
get?: never;
|
|
3234
|
+
put?: never;
|
|
3235
|
+
/** Attaches the signed-in account to the customer an invitation was issued for. The code travels in the X-Broker-Invitation header. */
|
|
3236
|
+
post: operations["RedeemCustomerInvitation"];
|
|
3237
|
+
delete?: never;
|
|
3238
|
+
options?: never;
|
|
3239
|
+
head?: never;
|
|
3240
|
+
patch?: never;
|
|
3241
|
+
trace?: never;
|
|
3242
|
+
};
|
|
3129
3243
|
"/api/v1/customer-verification-methods/{key}/label": {
|
|
3130
3244
|
parameters: {
|
|
3131
3245
|
query?: never;
|
|
@@ -7600,6 +7714,44 @@ export interface components {
|
|
|
7600
7714
|
/** Format: date-time */
|
|
7601
7715
|
revokedAtUtc: null | string;
|
|
7602
7716
|
};
|
|
7717
|
+
CustomerNextActionPage: {
|
|
7718
|
+
items: components["schemas"]["CustomerNextActionResponse"][];
|
|
7719
|
+
nextCursor: null | string;
|
|
7720
|
+
};
|
|
7721
|
+
CustomerNextActionResponse: {
|
|
7722
|
+
/** Format: uuid */
|
|
7723
|
+
id: string;
|
|
7724
|
+
/** Format: uuid */
|
|
7725
|
+
customerId: string;
|
|
7726
|
+
description: string;
|
|
7727
|
+
ownerSubjectId: string;
|
|
7728
|
+
/** Format: date */
|
|
7729
|
+
dueOn: string;
|
|
7730
|
+
done: boolean;
|
|
7731
|
+
/** Format: date-time */
|
|
7732
|
+
createdAtUtc: string;
|
|
7733
|
+
createdBySubjectId: string;
|
|
7734
|
+
/** Format: date-time */
|
|
7735
|
+
completedAtUtc: null | string;
|
|
7736
|
+
completedBySubjectId: null | string;
|
|
7737
|
+
};
|
|
7738
|
+
CustomerNotePage: {
|
|
7739
|
+
items: components["schemas"]["CustomerNoteResponse"][];
|
|
7740
|
+
nextCursor: null | string;
|
|
7741
|
+
};
|
|
7742
|
+
CustomerNoteResponse: {
|
|
7743
|
+
/** Format: uuid */
|
|
7744
|
+
id: string;
|
|
7745
|
+
/** Format: uuid */
|
|
7746
|
+
customerId: string;
|
|
7747
|
+
kind: string;
|
|
7748
|
+
body: string;
|
|
7749
|
+
/** Format: date-time */
|
|
7750
|
+
writtenAtUtc: string;
|
|
7751
|
+
writtenBySubjectId: string;
|
|
7752
|
+
/** Format: date-time */
|
|
7753
|
+
sharedAtUtc: null | string;
|
|
7754
|
+
};
|
|
7603
7755
|
CustomerNotificationPage: {
|
|
7604
7756
|
items: components["schemas"]["CustomerNotificationResponse"][];
|
|
7605
7757
|
nextCursor: null | string;
|
|
@@ -7887,6 +8039,19 @@ export interface components {
|
|
|
7887
8039
|
/** Format: date-time */
|
|
7888
8040
|
revokedAtUtc: string;
|
|
7889
8041
|
};
|
|
8042
|
+
CustomerSharedNoteResponse: {
|
|
8043
|
+
/** Format: uuid */
|
|
8044
|
+
id: string;
|
|
8045
|
+
/** Format: uuid */
|
|
8046
|
+
noteId: string;
|
|
8047
|
+
/** Format: uuid */
|
|
8048
|
+
customerId: string;
|
|
8049
|
+
kind: string;
|
|
8050
|
+
body: string;
|
|
8051
|
+
/** Format: date-time */
|
|
8052
|
+
sharedAtUtc: string;
|
|
8053
|
+
sharedBySubjectId: string;
|
|
8054
|
+
};
|
|
7890
8055
|
CustomerSubmissionAttachmentResponse: {
|
|
7891
8056
|
/** Format: uuid */
|
|
7892
8057
|
id: string;
|
|
@@ -7918,6 +8083,20 @@ export interface components {
|
|
|
7918
8083
|
help: null | string;
|
|
7919
8084
|
section: null | string;
|
|
7920
8085
|
};
|
|
8086
|
+
CustomerTimelineEntryResponse: {
|
|
8087
|
+
/** Format: uuid */
|
|
8088
|
+
id: string;
|
|
8089
|
+
kind: string;
|
|
8090
|
+
source: string;
|
|
8091
|
+
/** Format: uuid */
|
|
8092
|
+
referenceId: null | string;
|
|
8093
|
+
/** Format: date-time */
|
|
8094
|
+
occurredAtUtc: string;
|
|
8095
|
+
};
|
|
8096
|
+
CustomerTimelinePage: {
|
|
8097
|
+
items: components["schemas"]["CustomerTimelineEntryResponse"][];
|
|
8098
|
+
nextCursor: null | string;
|
|
8099
|
+
};
|
|
7921
8100
|
CustomerVerificationMethodResponse: {
|
|
7922
8101
|
key: string;
|
|
7923
8102
|
name: string;
|
|
@@ -9886,6 +10065,12 @@ export interface components {
|
|
|
9886
10065
|
/** Format: uuid */
|
|
9887
10066
|
submissionId: string;
|
|
9888
10067
|
};
|
|
10068
|
+
RecordCustomerNextActionRequest: {
|
|
10069
|
+
description: null | string;
|
|
10070
|
+
ownerSubjectId: null | string;
|
|
10071
|
+
/** Format: date */
|
|
10072
|
+
dueOn: null | string;
|
|
10073
|
+
};
|
|
9889
10074
|
RecordFollowUpRequest: {
|
|
9890
10075
|
/** Format: date */
|
|
9891
10076
|
dueOn: null | string;
|
|
@@ -10946,6 +11131,10 @@ export interface components {
|
|
|
10946
11131
|
WriteClaimNoteRequest: {
|
|
10947
11132
|
body: string;
|
|
10948
11133
|
};
|
|
11134
|
+
WriteCustomerNoteRequest: {
|
|
11135
|
+
kind: null | string;
|
|
11136
|
+
body: null | string;
|
|
11137
|
+
};
|
|
10949
11138
|
WriteOffObligationRequest: {
|
|
10950
11139
|
reason: string;
|
|
10951
11140
|
};
|
|
@@ -17544,14 +17733,16 @@ export interface operations {
|
|
|
17544
17733
|
};
|
|
17545
17734
|
};
|
|
17546
17735
|
};
|
|
17547
|
-
|
|
17736
|
+
ListCustomerNotes: {
|
|
17548
17737
|
parameters: {
|
|
17549
|
-
query?:
|
|
17550
|
-
|
|
17551
|
-
|
|
17552
|
-
|
|
17738
|
+
query?: {
|
|
17739
|
+
cursor?: string;
|
|
17740
|
+
limit?: number | string;
|
|
17741
|
+
};
|
|
17742
|
+
header?: never;
|
|
17743
|
+
path: {
|
|
17744
|
+
id: string;
|
|
17553
17745
|
};
|
|
17554
|
-
path?: never;
|
|
17555
17746
|
cookie?: never;
|
|
17556
17747
|
};
|
|
17557
17748
|
requestBody?: never;
|
|
@@ -17559,64 +17750,73 @@ export interface operations {
|
|
|
17559
17750
|
/** @description OK */
|
|
17560
17751
|
200: {
|
|
17561
17752
|
headers: {
|
|
17562
|
-
/** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
|
|
17563
|
-
"X-Broker-Acting-For"?: string;
|
|
17564
17753
|
[name: string]: unknown;
|
|
17565
17754
|
};
|
|
17566
17755
|
content: {
|
|
17567
|
-
"application/json": components["schemas"]["
|
|
17756
|
+
"application/json": components["schemas"]["CustomerNotePage"];
|
|
17568
17757
|
};
|
|
17569
17758
|
};
|
|
17570
|
-
/** @description
|
|
17571
|
-
|
|
17759
|
+
/** @description Bad Request */
|
|
17760
|
+
400: {
|
|
17572
17761
|
headers: {
|
|
17573
|
-
/** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
|
|
17574
|
-
"X-Broker-Acting-For"?: string;
|
|
17575
17762
|
[name: string]: unknown;
|
|
17576
17763
|
};
|
|
17577
17764
|
content: {
|
|
17578
|
-
"application/problem+json": components["schemas"]["
|
|
17765
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
17579
17766
|
};
|
|
17580
17767
|
};
|
|
17581
17768
|
/** @description Not Found */
|
|
17582
17769
|
404: {
|
|
17583
17770
|
headers: {
|
|
17584
|
-
/** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
|
|
17585
|
-
"X-Broker-Acting-For"?: string;
|
|
17586
17771
|
[name: string]: unknown;
|
|
17587
17772
|
};
|
|
17588
17773
|
content?: never;
|
|
17589
17774
|
};
|
|
17590
17775
|
};
|
|
17591
17776
|
};
|
|
17592
|
-
|
|
17777
|
+
WriteCustomerNote: {
|
|
17593
17778
|
parameters: {
|
|
17594
17779
|
query?: never;
|
|
17595
|
-
header?:
|
|
17596
|
-
|
|
17597
|
-
|
|
17780
|
+
header?: never;
|
|
17781
|
+
path: {
|
|
17782
|
+
id: string;
|
|
17598
17783
|
};
|
|
17599
|
-
path?: never;
|
|
17600
17784
|
cookie?: never;
|
|
17601
17785
|
};
|
|
17602
|
-
requestBody
|
|
17786
|
+
requestBody: {
|
|
17787
|
+
content: {
|
|
17788
|
+
"application/json": components["schemas"]["WriteCustomerNoteRequest"];
|
|
17789
|
+
};
|
|
17790
|
+
};
|
|
17603
17791
|
responses: {
|
|
17604
|
-
/** @description
|
|
17605
|
-
|
|
17792
|
+
/** @description Created */
|
|
17793
|
+
201: {
|
|
17606
17794
|
headers: {
|
|
17607
|
-
/** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
|
|
17608
|
-
"X-Broker-Acting-For"?: string;
|
|
17609
17795
|
[name: string]: unknown;
|
|
17610
17796
|
};
|
|
17611
17797
|
content: {
|
|
17612
|
-
"application/json": components["schemas"]["
|
|
17798
|
+
"application/json": components["schemas"]["CustomerNoteResponse"];
|
|
17613
17799
|
};
|
|
17614
17800
|
};
|
|
17801
|
+
/** @description Bad Request */
|
|
17802
|
+
400: {
|
|
17803
|
+
headers: {
|
|
17804
|
+
[name: string]: unknown;
|
|
17805
|
+
};
|
|
17806
|
+
content: {
|
|
17807
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
17808
|
+
};
|
|
17809
|
+
};
|
|
17810
|
+
/** @description Not Found */
|
|
17811
|
+
404: {
|
|
17812
|
+
headers: {
|
|
17813
|
+
[name: string]: unknown;
|
|
17814
|
+
};
|
|
17815
|
+
content?: never;
|
|
17816
|
+
};
|
|
17615
17817
|
/** @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. */
|
|
17616
17818
|
409: {
|
|
17617
17819
|
headers: {
|
|
17618
|
-
/** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
|
|
17619
|
-
"X-Broker-Acting-For"?: string;
|
|
17620
17820
|
[name: string]: unknown;
|
|
17621
17821
|
};
|
|
17622
17822
|
content: {
|
|
@@ -17625,27 +17825,37 @@ export interface operations {
|
|
|
17625
17825
|
};
|
|
17626
17826
|
};
|
|
17627
17827
|
};
|
|
17628
|
-
|
|
17828
|
+
ShareCustomerNote: {
|
|
17629
17829
|
parameters: {
|
|
17630
17830
|
query?: never;
|
|
17631
17831
|
header?: never;
|
|
17632
|
-
path
|
|
17832
|
+
path: {
|
|
17833
|
+
id: string;
|
|
17834
|
+
noteId: string;
|
|
17835
|
+
};
|
|
17633
17836
|
cookie?: never;
|
|
17634
17837
|
};
|
|
17635
17838
|
requestBody?: never;
|
|
17636
17839
|
responses: {
|
|
17637
|
-
/** @description
|
|
17638
|
-
|
|
17840
|
+
/** @description Created */
|
|
17841
|
+
201: {
|
|
17639
17842
|
headers: {
|
|
17640
17843
|
[name: string]: unknown;
|
|
17641
17844
|
};
|
|
17642
17845
|
content: {
|
|
17643
|
-
"application/json": components["schemas"]["
|
|
17846
|
+
"application/json": components["schemas"]["CustomerSharedNoteResponse"];
|
|
17644
17847
|
};
|
|
17645
17848
|
};
|
|
17646
|
-
/** @description
|
|
17647
|
-
|
|
17648
|
-
headers: {
|
|
17849
|
+
/** @description Not Found */
|
|
17850
|
+
404: {
|
|
17851
|
+
headers: {
|
|
17852
|
+
[name: string]: unknown;
|
|
17853
|
+
};
|
|
17854
|
+
content?: never;
|
|
17855
|
+
};
|
|
17856
|
+
/** @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. */
|
|
17857
|
+
409: {
|
|
17858
|
+
headers: {
|
|
17649
17859
|
[name: string]: unknown;
|
|
17650
17860
|
};
|
|
17651
17861
|
content: {
|
|
@@ -17654,6 +17864,178 @@ export interface operations {
|
|
|
17654
17864
|
};
|
|
17655
17865
|
};
|
|
17656
17866
|
};
|
|
17867
|
+
ListCustomerNextActions: {
|
|
17868
|
+
parameters: {
|
|
17869
|
+
query?: {
|
|
17870
|
+
cursor?: string;
|
|
17871
|
+
limit?: number | string;
|
|
17872
|
+
};
|
|
17873
|
+
header?: never;
|
|
17874
|
+
path: {
|
|
17875
|
+
id: string;
|
|
17876
|
+
};
|
|
17877
|
+
cookie?: never;
|
|
17878
|
+
};
|
|
17879
|
+
requestBody?: never;
|
|
17880
|
+
responses: {
|
|
17881
|
+
/** @description OK */
|
|
17882
|
+
200: {
|
|
17883
|
+
headers: {
|
|
17884
|
+
[name: string]: unknown;
|
|
17885
|
+
};
|
|
17886
|
+
content: {
|
|
17887
|
+
"application/json": components["schemas"]["CustomerNextActionPage"];
|
|
17888
|
+
};
|
|
17889
|
+
};
|
|
17890
|
+
/** @description Bad Request */
|
|
17891
|
+
400: {
|
|
17892
|
+
headers: {
|
|
17893
|
+
[name: string]: unknown;
|
|
17894
|
+
};
|
|
17895
|
+
content: {
|
|
17896
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
17897
|
+
};
|
|
17898
|
+
};
|
|
17899
|
+
/** @description Not Found */
|
|
17900
|
+
404: {
|
|
17901
|
+
headers: {
|
|
17902
|
+
[name: string]: unknown;
|
|
17903
|
+
};
|
|
17904
|
+
content?: never;
|
|
17905
|
+
};
|
|
17906
|
+
};
|
|
17907
|
+
};
|
|
17908
|
+
RecordCustomerNextAction: {
|
|
17909
|
+
parameters: {
|
|
17910
|
+
query?: never;
|
|
17911
|
+
header?: never;
|
|
17912
|
+
path: {
|
|
17913
|
+
id: string;
|
|
17914
|
+
};
|
|
17915
|
+
cookie?: never;
|
|
17916
|
+
};
|
|
17917
|
+
requestBody: {
|
|
17918
|
+
content: {
|
|
17919
|
+
"application/json": components["schemas"]["RecordCustomerNextActionRequest"];
|
|
17920
|
+
};
|
|
17921
|
+
};
|
|
17922
|
+
responses: {
|
|
17923
|
+
/** @description Created */
|
|
17924
|
+
201: {
|
|
17925
|
+
headers: {
|
|
17926
|
+
[name: string]: unknown;
|
|
17927
|
+
};
|
|
17928
|
+
content: {
|
|
17929
|
+
"application/json": components["schemas"]["CustomerNextActionResponse"];
|
|
17930
|
+
};
|
|
17931
|
+
};
|
|
17932
|
+
/** @description Bad Request */
|
|
17933
|
+
400: {
|
|
17934
|
+
headers: {
|
|
17935
|
+
[name: string]: unknown;
|
|
17936
|
+
};
|
|
17937
|
+
content: {
|
|
17938
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
17939
|
+
};
|
|
17940
|
+
};
|
|
17941
|
+
/** @description Not Found */
|
|
17942
|
+
404: {
|
|
17943
|
+
headers: {
|
|
17944
|
+
[name: string]: unknown;
|
|
17945
|
+
};
|
|
17946
|
+
content?: never;
|
|
17947
|
+
};
|
|
17948
|
+
/** @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. */
|
|
17949
|
+
409: {
|
|
17950
|
+
headers: {
|
|
17951
|
+
[name: string]: unknown;
|
|
17952
|
+
};
|
|
17953
|
+
content: {
|
|
17954
|
+
"application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
|
|
17955
|
+
};
|
|
17956
|
+
};
|
|
17957
|
+
};
|
|
17958
|
+
};
|
|
17959
|
+
CompleteCustomerNextAction: {
|
|
17960
|
+
parameters: {
|
|
17961
|
+
query?: never;
|
|
17962
|
+
header?: never;
|
|
17963
|
+
path: {
|
|
17964
|
+
id: string;
|
|
17965
|
+
actionId: string;
|
|
17966
|
+
};
|
|
17967
|
+
cookie?: never;
|
|
17968
|
+
};
|
|
17969
|
+
requestBody?: never;
|
|
17970
|
+
responses: {
|
|
17971
|
+
/** @description OK */
|
|
17972
|
+
200: {
|
|
17973
|
+
headers: {
|
|
17974
|
+
[name: string]: unknown;
|
|
17975
|
+
};
|
|
17976
|
+
content: {
|
|
17977
|
+
"application/json": components["schemas"]["CustomerNextActionResponse"];
|
|
17978
|
+
};
|
|
17979
|
+
};
|
|
17980
|
+
/** @description Not Found */
|
|
17981
|
+
404: {
|
|
17982
|
+
headers: {
|
|
17983
|
+
[name: string]: unknown;
|
|
17984
|
+
};
|
|
17985
|
+
content?: never;
|
|
17986
|
+
};
|
|
17987
|
+
/** @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. */
|
|
17988
|
+
409: {
|
|
17989
|
+
headers: {
|
|
17990
|
+
[name: string]: unknown;
|
|
17991
|
+
};
|
|
17992
|
+
content: {
|
|
17993
|
+
"application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
|
|
17994
|
+
};
|
|
17995
|
+
};
|
|
17996
|
+
};
|
|
17997
|
+
};
|
|
17998
|
+
ListCustomerTimeline: {
|
|
17999
|
+
parameters: {
|
|
18000
|
+
query?: {
|
|
18001
|
+
cursor?: string;
|
|
18002
|
+
limit?: number | string;
|
|
18003
|
+
};
|
|
18004
|
+
header?: never;
|
|
18005
|
+
path: {
|
|
18006
|
+
id: string;
|
|
18007
|
+
};
|
|
18008
|
+
cookie?: never;
|
|
18009
|
+
};
|
|
18010
|
+
requestBody?: never;
|
|
18011
|
+
responses: {
|
|
18012
|
+
/** @description OK */
|
|
18013
|
+
200: {
|
|
18014
|
+
headers: {
|
|
18015
|
+
[name: string]: unknown;
|
|
18016
|
+
};
|
|
18017
|
+
content: {
|
|
18018
|
+
"application/json": components["schemas"]["CustomerTimelinePage"];
|
|
18019
|
+
};
|
|
18020
|
+
};
|
|
18021
|
+
/** @description Bad Request */
|
|
18022
|
+
400: {
|
|
18023
|
+
headers: {
|
|
18024
|
+
[name: string]: unknown;
|
|
18025
|
+
};
|
|
18026
|
+
content: {
|
|
18027
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
18028
|
+
};
|
|
18029
|
+
};
|
|
18030
|
+
/** @description Not Found */
|
|
18031
|
+
404: {
|
|
18032
|
+
headers: {
|
|
18033
|
+
[name: string]: unknown;
|
|
18034
|
+
};
|
|
18035
|
+
content?: never;
|
|
18036
|
+
};
|
|
18037
|
+
};
|
|
18038
|
+
};
|
|
17657
18039
|
ListCustomerVerificationMethods: {
|
|
17658
18040
|
parameters: {
|
|
17659
18041
|
query?: {
|
|
@@ -17794,6 +18176,116 @@ export interface operations {
|
|
|
17794
18176
|
};
|
|
17795
18177
|
};
|
|
17796
18178
|
};
|
|
18179
|
+
GetOwnCustomerAccount: {
|
|
18180
|
+
parameters: {
|
|
18181
|
+
query?: never;
|
|
18182
|
+
header?: {
|
|
18183
|
+
/** @description The organisation to act for: one of the identifiers GET /api/v1/customer/contexts lists. Omit it, or send it empty, to act for your own account; there is no mode in which it becomes mandatory. A value you hold no active membership of, or one that is not an organisation identifier, is refused with 403 naming nothing, and never quietly treated as your own account. */
|
|
18184
|
+
"X-Broker-Acting-For"?: components["parameters"]["ActingFor"];
|
|
18185
|
+
};
|
|
18186
|
+
path?: never;
|
|
18187
|
+
cookie?: never;
|
|
18188
|
+
};
|
|
18189
|
+
requestBody?: never;
|
|
18190
|
+
responses: {
|
|
18191
|
+
/** @description OK */
|
|
18192
|
+
200: {
|
|
18193
|
+
headers: {
|
|
18194
|
+
/** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
|
|
18195
|
+
"X-Broker-Acting-For"?: string;
|
|
18196
|
+
[name: string]: unknown;
|
|
18197
|
+
};
|
|
18198
|
+
content: {
|
|
18199
|
+
"application/json": components["schemas"]["OwnCustomerAccountResponse"];
|
|
18200
|
+
};
|
|
18201
|
+
};
|
|
18202
|
+
/** @description Forbidden */
|
|
18203
|
+
403: {
|
|
18204
|
+
headers: {
|
|
18205
|
+
/** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
|
|
18206
|
+
"X-Broker-Acting-For"?: string;
|
|
18207
|
+
[name: string]: unknown;
|
|
18208
|
+
};
|
|
18209
|
+
content: {
|
|
18210
|
+
"application/problem+json": components["schemas"]["ProblemDetails"];
|
|
18211
|
+
};
|
|
18212
|
+
};
|
|
18213
|
+
/** @description Not Found */
|
|
18214
|
+
404: {
|
|
18215
|
+
headers: {
|
|
18216
|
+
/** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
|
|
18217
|
+
"X-Broker-Acting-For"?: string;
|
|
18218
|
+
[name: string]: unknown;
|
|
18219
|
+
};
|
|
18220
|
+
content?: never;
|
|
18221
|
+
};
|
|
18222
|
+
};
|
|
18223
|
+
};
|
|
18224
|
+
RevokeOwnCustomerSessions: {
|
|
18225
|
+
parameters: {
|
|
18226
|
+
query?: never;
|
|
18227
|
+
header?: {
|
|
18228
|
+
/** @description The organisation to act for: one of the identifiers GET /api/v1/customer/contexts lists. Omit it, or send it empty, to act for your own account; there is no mode in which it becomes mandatory. A value you hold no active membership of, or one that is not an organisation identifier, is refused with 403 naming nothing, and never quietly treated as your own account. */
|
|
18229
|
+
"X-Broker-Acting-For"?: components["parameters"]["ActingFor"];
|
|
18230
|
+
};
|
|
18231
|
+
path?: never;
|
|
18232
|
+
cookie?: never;
|
|
18233
|
+
};
|
|
18234
|
+
requestBody?: never;
|
|
18235
|
+
responses: {
|
|
18236
|
+
/** @description OK */
|
|
18237
|
+
200: {
|
|
18238
|
+
headers: {
|
|
18239
|
+
/** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
|
|
18240
|
+
"X-Broker-Acting-For"?: string;
|
|
18241
|
+
[name: string]: unknown;
|
|
18242
|
+
};
|
|
18243
|
+
content: {
|
|
18244
|
+
"application/json": components["schemas"]["CustomerSessionRevocationResponse"];
|
|
18245
|
+
};
|
|
18246
|
+
};
|
|
18247
|
+
/** @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. */
|
|
18248
|
+
409: {
|
|
18249
|
+
headers: {
|
|
18250
|
+
/** @description The party this request actually acted for. Present, carrying the organisation identifier, when it acted for an organisation; absent when it acted for your own account. It mirrors the request header, so it can be sent back unchanged. Compare it with what you meant to send: it is the only way to see that a request you meant for an organisation was made personally. */
|
|
18251
|
+
"X-Broker-Acting-For"?: string;
|
|
18252
|
+
[name: string]: unknown;
|
|
18253
|
+
};
|
|
18254
|
+
content: {
|
|
18255
|
+
"application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
|
|
18256
|
+
};
|
|
18257
|
+
};
|
|
18258
|
+
};
|
|
18259
|
+
};
|
|
18260
|
+
RedeemCustomerInvitation: {
|
|
18261
|
+
parameters: {
|
|
18262
|
+
query?: never;
|
|
18263
|
+
header?: never;
|
|
18264
|
+
path?: never;
|
|
18265
|
+
cookie?: never;
|
|
18266
|
+
};
|
|
18267
|
+
requestBody?: never;
|
|
18268
|
+
responses: {
|
|
18269
|
+
/** @description OK */
|
|
18270
|
+
200: {
|
|
18271
|
+
headers: {
|
|
18272
|
+
[name: string]: unknown;
|
|
18273
|
+
};
|
|
18274
|
+
content: {
|
|
18275
|
+
"application/json": components["schemas"]["RedeemedCustomerAccountResponse"];
|
|
18276
|
+
};
|
|
18277
|
+
};
|
|
18278
|
+
/** @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. */
|
|
18279
|
+
409: {
|
|
18280
|
+
headers: {
|
|
18281
|
+
[name: string]: unknown;
|
|
18282
|
+
};
|
|
18283
|
+
content: {
|
|
18284
|
+
"application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
|
|
18285
|
+
};
|
|
18286
|
+
};
|
|
18287
|
+
};
|
|
18288
|
+
};
|
|
17797
18289
|
RelabelCustomerVerificationMethod: {
|
|
17798
18290
|
parameters: {
|
|
17799
18291
|
query?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@insurance-broker/api-client",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.51.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,
|