@insurance-broker/api-client 5.50.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 +199 -120
- package/package.json +1 -1
package/dist/schema.d.ts
CHANGED
|
@@ -3080,7 +3080,7 @@ export interface paths {
|
|
|
3080
3080
|
patch?: never;
|
|
3081
3081
|
trace?: never;
|
|
3082
3082
|
};
|
|
3083
|
-
"/api/v1/
|
|
3083
|
+
"/api/v1/customers/{id}/timeline": {
|
|
3084
3084
|
parameters: {
|
|
3085
3085
|
query?: never;
|
|
3086
3086
|
header?: never;
|
|
@@ -3088,12 +3088,14 @@ export interface paths {
|
|
|
3088
3088
|
cookie?: never;
|
|
3089
3089
|
};
|
|
3090
3090
|
/**
|
|
3091
|
-
*
|
|
3092
|
-
* @description
|
|
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
3093
|
*
|
|
3094
|
-
*
|
|
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`.
|
|
3095
3097
|
*/
|
|
3096
|
-
get: operations["
|
|
3098
|
+
get: operations["ListCustomerTimeline"];
|
|
3097
3099
|
put?: never;
|
|
3098
3100
|
post?: never;
|
|
3099
3101
|
delete?: never;
|
|
@@ -3102,7 +3104,35 @@ export interface paths {
|
|
|
3102
3104
|
patch?: never;
|
|
3103
3105
|
trace?: never;
|
|
3104
3106
|
};
|
|
3105
|
-
"/api/v1/customer-
|
|
3107
|
+
"/api/v1/customer-verification-methods": {
|
|
3108
|
+
parameters: {
|
|
3109
|
+
query?: never;
|
|
3110
|
+
header?: never;
|
|
3111
|
+
path?: never;
|
|
3112
|
+
cookie?: never;
|
|
3113
|
+
};
|
|
3114
|
+
/**
|
|
3115
|
+
* The ways this broker's staff may verify a customer before signing them out, in the broker's order.
|
|
3116
|
+
* @description The broker's closed set of verification methods (ADR-0049). A member of staff signing a customer out of every session picks one of these keys and the choice is recorded in the audit entry. The set is configuration, never without an active method once configured; an empty list means this broker has not configured one yet, and staff-assisted sign-out is refused until it does.
|
|
3117
|
+
*
|
|
3118
|
+
* **Only active methods by default**, because only those can be chosen. `includeRetired=true` adds the retired ones, marked `isActive: false` with `retiredAtUtc`, for somebody managing the set (#648); they cannot be chosen and keep their keys.
|
|
3119
|
+
*/
|
|
3120
|
+
get: operations["ListCustomerVerificationMethods"];
|
|
3121
|
+
put?: never;
|
|
3122
|
+
/**
|
|
3123
|
+
* Add a way this broker's staff may verify a customer before signing them out
|
|
3124
|
+
* @description #648. `key` is a stable identifier — lower-case letters, digits and hyphens, at most 64 characters — unique within this broker and never changed or reused, because audit entries for staff sign-outs record it. `name` is what staff read, at most 120 characters; `description`, optional and at most 500, says what staff must actually have checked. Neither may hold control or invisible formatting characters. The method is appended to the end of the set and is active at once. A broker with no set may add its first method here.
|
|
3125
|
+
*
|
|
3126
|
+
* **Refusals.** `400` for a malformed field. `409` `urn:brokerplatform:problem:verification-method-key-taken` when this broker already has a method with that key, active or retired: choose another key, or reactivate the retired one.
|
|
3127
|
+
*/
|
|
3128
|
+
post: operations["AddCustomerVerificationMethod"];
|
|
3129
|
+
delete?: never;
|
|
3130
|
+
options?: never;
|
|
3131
|
+
head?: never;
|
|
3132
|
+
patch?: never;
|
|
3133
|
+
trace?: never;
|
|
3134
|
+
};
|
|
3135
|
+
"/api/v1/customers/{id}/sessions/revocation": {
|
|
3106
3136
|
parameters: {
|
|
3107
3137
|
query?: never;
|
|
3108
3138
|
header?: never;
|
|
@@ -3112,40 +3142,40 @@ export interface paths {
|
|
|
3112
3142
|
get?: never;
|
|
3113
3143
|
put?: never;
|
|
3114
3144
|
/**
|
|
3115
|
-
* Signs
|
|
3116
|
-
* @description **Every sign-in this customer established up to now stops working against this API on its next request —
|
|
3145
|
+
* Signs a customer out of every session they have established, after a member of staff has verified them.
|
|
3146
|
+
* @description **Every sign-in this customer established up to now stops working against this API on its next request** — the same effect as the customer's own `POST /api/v1/customer-account/sessions/revocation`, for a customer who rings in because a device was lost or stolen (SEC-012). The customer signs in again afterwards on the device they hold.
|
|
3117
3147
|
*
|
|
3118
|
-
* **
|
|
3148
|
+
* **Verify the customer first, then say how.** `verificationMethod` is a key from `GET /api/v1/customer-verification-methods`, this broker's closed set; `reason` is required, at most 500 characters, and is recorded with the method and the member of staff in the audit entry on the customer record (action `crm.customer.sessions-revoked-by-staff`). Tell the customer to change their password and secure their email account: signing out does not stop somebody who knows the password.
|
|
3119
3149
|
*
|
|
3120
|
-
* **
|
|
3150
|
+
* **Refusals.** `400` when either field is missing or the reason is too long. `404` when the customer is not this broker's. `409` with problem type `urn:brokerplatform:problem:verification-method-not-offered` when the method is not in this broker's set, has been retired, or the broker has configured none — read the set and choose from it. `409` with no type when the customer has never attached a sign-in account, so has no session to end.
|
|
3121
3151
|
*
|
|
3122
|
-
* **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.
|
|
3152
|
+
* **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, on this member of staff's own sign-in: the request is recorded here and carried out in the background. It does not list sessions.
|
|
3123
3153
|
*/
|
|
3124
|
-
post: operations["
|
|
3154
|
+
post: operations["RevokeCustomerSessions"];
|
|
3125
3155
|
delete?: never;
|
|
3126
3156
|
options?: never;
|
|
3127
3157
|
head?: never;
|
|
3128
3158
|
patch?: never;
|
|
3129
3159
|
trace?: never;
|
|
3130
3160
|
};
|
|
3131
|
-
"/api/v1/customer
|
|
3161
|
+
"/api/v1/customer/contexts": {
|
|
3132
3162
|
parameters: {
|
|
3133
3163
|
query?: never;
|
|
3134
3164
|
header?: never;
|
|
3135
3165
|
path?: never;
|
|
3136
3166
|
cookie?: never;
|
|
3137
3167
|
};
|
|
3138
|
-
|
|
3168
|
+
/** The parties the signed-in customer may act as: themselves, and every organisation they hold an active membership of. The identifier of each is what X-Broker-Acting-For takes. */
|
|
3169
|
+
get: operations["ListActingContexts"];
|
|
3139
3170
|
put?: never;
|
|
3140
|
-
|
|
3141
|
-
post: operations["RedeemCustomerInvitation"];
|
|
3171
|
+
post?: never;
|
|
3142
3172
|
delete?: never;
|
|
3143
3173
|
options?: never;
|
|
3144
3174
|
head?: never;
|
|
3145
3175
|
patch?: never;
|
|
3146
3176
|
trace?: never;
|
|
3147
3177
|
};
|
|
3148
|
-
"/api/v1/customer-
|
|
3178
|
+
"/api/v1/customer-account": {
|
|
3149
3179
|
parameters: {
|
|
3150
3180
|
query?: never;
|
|
3151
3181
|
header?: never;
|
|
@@ -3153,27 +3183,21 @@ export interface paths {
|
|
|
3153
3183
|
cookie?: never;
|
|
3154
3184
|
};
|
|
3155
3185
|
/**
|
|
3156
|
-
* The
|
|
3157
|
-
* @description
|
|
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.
|
|
3158
3188
|
*
|
|
3159
|
-
* **
|
|
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.
|
|
3160
3190
|
*/
|
|
3161
|
-
get: operations["
|
|
3191
|
+
get: operations["GetOwnCustomerAccount"];
|
|
3162
3192
|
put?: never;
|
|
3163
|
-
|
|
3164
|
-
* Add a way this broker's staff may verify a customer before signing them out
|
|
3165
|
-
* @description #648. `key` is a stable identifier — lower-case letters, digits and hyphens, at most 64 characters — unique within this broker and never changed or reused, because audit entries for staff sign-outs record it. `name` is what staff read, at most 120 characters; `description`, optional and at most 500, says what staff must actually have checked. Neither may hold control or invisible formatting characters. The method is appended to the end of the set and is active at once. A broker with no set may add its first method here.
|
|
3166
|
-
*
|
|
3167
|
-
* **Refusals.** `400` for a malformed field. `409` `urn:brokerplatform:problem:verification-method-key-taken` when this broker already has a method with that key, active or retired: choose another key, or reactivate the retired one.
|
|
3168
|
-
*/
|
|
3169
|
-
post: operations["AddCustomerVerificationMethod"];
|
|
3193
|
+
post?: never;
|
|
3170
3194
|
delete?: never;
|
|
3171
3195
|
options?: never;
|
|
3172
3196
|
head?: never;
|
|
3173
3197
|
patch?: never;
|
|
3174
3198
|
trace?: never;
|
|
3175
3199
|
};
|
|
3176
|
-
"/api/v1/
|
|
3200
|
+
"/api/v1/customer-account/sessions/revocation": {
|
|
3177
3201
|
parameters: {
|
|
3178
3202
|
query?: never;
|
|
3179
3203
|
header?: never;
|
|
@@ -3183,33 +3207,33 @@ export interface paths {
|
|
|
3183
3207
|
get?: never;
|
|
3184
3208
|
put?: never;
|
|
3185
3209
|
/**
|
|
3186
|
-
* Signs
|
|
3187
|
-
* @description **Every sign-in this customer established up to now stops working against this API on its next request
|
|
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.
|
|
3188
3212
|
*
|
|
3189
|
-
* **
|
|
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.
|
|
3190
3214
|
*
|
|
3191
|
-
* **
|
|
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.
|
|
3192
3216
|
*
|
|
3193
|
-
* **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
|
|
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.
|
|
3194
3218
|
*/
|
|
3195
|
-
post: operations["
|
|
3219
|
+
post: operations["RevokeOwnCustomerSessions"];
|
|
3196
3220
|
delete?: never;
|
|
3197
3221
|
options?: never;
|
|
3198
3222
|
head?: never;
|
|
3199
3223
|
patch?: never;
|
|
3200
3224
|
trace?: never;
|
|
3201
3225
|
};
|
|
3202
|
-
"/api/v1/customer/
|
|
3226
|
+
"/api/v1/customer-account/redemption": {
|
|
3203
3227
|
parameters: {
|
|
3204
3228
|
query?: never;
|
|
3205
3229
|
header?: never;
|
|
3206
3230
|
path?: never;
|
|
3207
3231
|
cookie?: never;
|
|
3208
3232
|
};
|
|
3209
|
-
|
|
3210
|
-
get: operations["ListActingContexts"];
|
|
3233
|
+
get?: never;
|
|
3211
3234
|
put?: never;
|
|
3212
|
-
|
|
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"];
|
|
3213
3237
|
delete?: never;
|
|
3214
3238
|
options?: never;
|
|
3215
3239
|
head?: never;
|
|
@@ -8059,6 +8083,20 @@ export interface components {
|
|
|
8059
8083
|
help: null | string;
|
|
8060
8084
|
section: null | string;
|
|
8061
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
|
+
};
|
|
8062
8100
|
CustomerVerificationMethodResponse: {
|
|
8063
8101
|
key: string;
|
|
8064
8102
|
name: string;
|
|
@@ -17957,14 +17995,16 @@ export interface operations {
|
|
|
17957
17995
|
};
|
|
17958
17996
|
};
|
|
17959
17997
|
};
|
|
17960
|
-
|
|
17998
|
+
ListCustomerTimeline: {
|
|
17961
17999
|
parameters: {
|
|
17962
|
-
query?:
|
|
17963
|
-
|
|
17964
|
-
|
|
17965
|
-
|
|
18000
|
+
query?: {
|
|
18001
|
+
cursor?: string;
|
|
18002
|
+
limit?: number | string;
|
|
18003
|
+
};
|
|
18004
|
+
header?: never;
|
|
18005
|
+
path: {
|
|
18006
|
+
id: string;
|
|
17966
18007
|
};
|
|
17967
|
-
path?: never;
|
|
17968
18008
|
cookie?: never;
|
|
17969
18009
|
};
|
|
17970
18010
|
requestBody?: never;
|
|
@@ -17972,101 +18012,30 @@ export interface operations {
|
|
|
17972
18012
|
/** @description OK */
|
|
17973
18013
|
200: {
|
|
17974
18014
|
headers: {
|
|
17975
|
-
/** @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. */
|
|
17976
|
-
"X-Broker-Acting-For"?: string;
|
|
17977
18015
|
[name: string]: unknown;
|
|
17978
18016
|
};
|
|
17979
18017
|
content: {
|
|
17980
|
-
"application/json": components["schemas"]["
|
|
18018
|
+
"application/json": components["schemas"]["CustomerTimelinePage"];
|
|
17981
18019
|
};
|
|
17982
18020
|
};
|
|
17983
|
-
/** @description
|
|
17984
|
-
|
|
18021
|
+
/** @description Bad Request */
|
|
18022
|
+
400: {
|
|
17985
18023
|
headers: {
|
|
17986
|
-
/** @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. */
|
|
17987
|
-
"X-Broker-Acting-For"?: string;
|
|
17988
18024
|
[name: string]: unknown;
|
|
17989
18025
|
};
|
|
17990
18026
|
content: {
|
|
17991
|
-
"application/problem+json": components["schemas"]["
|
|
18027
|
+
"application/problem+json": components["schemas"]["HttpValidationProblemDetails"];
|
|
17992
18028
|
};
|
|
17993
18029
|
};
|
|
17994
18030
|
/** @description Not Found */
|
|
17995
18031
|
404: {
|
|
17996
18032
|
headers: {
|
|
17997
|
-
/** @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. */
|
|
17998
|
-
"X-Broker-Acting-For"?: string;
|
|
17999
18033
|
[name: string]: unknown;
|
|
18000
18034
|
};
|
|
18001
18035
|
content?: never;
|
|
18002
18036
|
};
|
|
18003
18037
|
};
|
|
18004
18038
|
};
|
|
18005
|
-
RevokeOwnCustomerSessions: {
|
|
18006
|
-
parameters: {
|
|
18007
|
-
query?: never;
|
|
18008
|
-
header?: {
|
|
18009
|
-
/** @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. */
|
|
18010
|
-
"X-Broker-Acting-For"?: components["parameters"]["ActingFor"];
|
|
18011
|
-
};
|
|
18012
|
-
path?: never;
|
|
18013
|
-
cookie?: never;
|
|
18014
|
-
};
|
|
18015
|
-
requestBody?: never;
|
|
18016
|
-
responses: {
|
|
18017
|
-
/** @description OK */
|
|
18018
|
-
200: {
|
|
18019
|
-
headers: {
|
|
18020
|
-
/** @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. */
|
|
18021
|
-
"X-Broker-Acting-For"?: string;
|
|
18022
|
-
[name: string]: unknown;
|
|
18023
|
-
};
|
|
18024
|
-
content: {
|
|
18025
|
-
"application/json": components["schemas"]["CustomerSessionRevocationResponse"];
|
|
18026
|
-
};
|
|
18027
|
-
};
|
|
18028
|
-
/** @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. */
|
|
18029
|
-
409: {
|
|
18030
|
-
headers: {
|
|
18031
|
-
/** @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. */
|
|
18032
|
-
"X-Broker-Acting-For"?: string;
|
|
18033
|
-
[name: string]: unknown;
|
|
18034
|
-
};
|
|
18035
|
-
content: {
|
|
18036
|
-
"application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
|
|
18037
|
-
};
|
|
18038
|
-
};
|
|
18039
|
-
};
|
|
18040
|
-
};
|
|
18041
|
-
RedeemCustomerInvitation: {
|
|
18042
|
-
parameters: {
|
|
18043
|
-
query?: never;
|
|
18044
|
-
header?: never;
|
|
18045
|
-
path?: never;
|
|
18046
|
-
cookie?: never;
|
|
18047
|
-
};
|
|
18048
|
-
requestBody?: never;
|
|
18049
|
-
responses: {
|
|
18050
|
-
/** @description OK */
|
|
18051
|
-
200: {
|
|
18052
|
-
headers: {
|
|
18053
|
-
[name: string]: unknown;
|
|
18054
|
-
};
|
|
18055
|
-
content: {
|
|
18056
|
-
"application/json": components["schemas"]["RedeemedCustomerAccountResponse"];
|
|
18057
|
-
};
|
|
18058
|
-
};
|
|
18059
|
-
/** @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. */
|
|
18060
|
-
409: {
|
|
18061
|
-
headers: {
|
|
18062
|
-
[name: string]: unknown;
|
|
18063
|
-
};
|
|
18064
|
-
content: {
|
|
18065
|
-
"application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
|
|
18066
|
-
};
|
|
18067
|
-
};
|
|
18068
|
-
};
|
|
18069
|
-
};
|
|
18070
18039
|
ListCustomerVerificationMethods: {
|
|
18071
18040
|
parameters: {
|
|
18072
18041
|
query?: {
|
|
@@ -18207,6 +18176,116 @@ export interface operations {
|
|
|
18207
18176
|
};
|
|
18208
18177
|
};
|
|
18209
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
|
+
};
|
|
18210
18289
|
RelabelCustomerVerificationMethod: {
|
|
18211
18290
|
parameters: {
|
|
18212
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,
|