@insurance-broker/api-client 5.17.0 → 5.18.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
@@ -1656,6 +1656,28 @@ export interface paths {
1656
1656
  patch?: never;
1657
1657
  trace?: never;
1658
1658
  };
1659
+ "/api/v1/customer/form-submissions/{id}/pinned-version": {
1660
+ parameters: {
1661
+ query?: never;
1662
+ header?: never;
1663
+ path?: never;
1664
+ cookie?: never;
1665
+ };
1666
+ get?: never;
1667
+ put?: never;
1668
+ /**
1669
+ * Moves their draft onto the version of its form that is live now.
1670
+ * @description Moves the customer's own draft onto the version of its form that is live now — the answer to a draft read with `pinnedVersionIsLive: false`. Every answer whose question survived is carried, and the ones the new version no longer asks are named in `droppedAnswerKeys`.
1671
+ *
1672
+ * **A `409` here is a settled fact, and `type` says which** (#459, #470). `urn:brokerplatform:problem:product-not-open-to-new-business` means the product is no longer offered, or no longer exists, so the draft stays on the version it has. `urn:brokerplatform:problem:form-has-no-live-version` means the broker took the form's live version down and there is nothing to move onto. `urn:brokerplatform:problem:draft-already-on-live-version` means there is nothing to move: the draft already answers the live version. `urn:brokerplatform:problem:submission-already-submitted` means the form has been submitted and is never moved. `urn:brokerplatform:problem:form-version-unreadable` means the version it is on, or the one it would move onto, is in a schema this engine cannot read. `urn:brokerplatform:problem:recorded-answers-unreadable` means the answers saved so far cannot be read, so nothing could be carried; saving them again replaces them. `urn:brokerplatform:problem:concurrency-conflict` means another of their devices wrote first; read again and retry.
1673
+ */
1674
+ post: operations["RepinCustomerFormSubmission"];
1675
+ delete?: never;
1676
+ options?: never;
1677
+ head?: never;
1678
+ patch?: never;
1679
+ trace?: never;
1680
+ };
1659
1681
  "/api/v1/form-submissions/{id}/attachments/{evidenceKey}": {
1660
1682
  parameters: {
1661
1683
  query?: never;
@@ -7149,6 +7171,11 @@ export interface components {
7149
7171
  /** Format: date-time */
7150
7172
  openedAtUtc: string;
7151
7173
  };
7174
+ CustomerRepinnedSubmissionResponse: {
7175
+ submission: components["schemas"]["CustomerFormSubmissionResponse"];
7176
+ carriedAnswerKeys: string[];
7177
+ droppedAnswerKeys: string[];
7178
+ };
7152
7179
  CustomerResponse: {
7153
7180
  /** Format: uuid */
7154
7181
  id: string;
@@ -13642,6 +13669,53 @@ export interface operations {
13642
13669
  };
13643
13670
  };
13644
13671
  };
13672
+ RepinCustomerFormSubmission: {
13673
+ parameters: {
13674
+ query?: never;
13675
+ header?: {
13676
+ /** @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. */
13677
+ "X-Broker-Acting-For"?: components["parameters"]["ActingFor"];
13678
+ };
13679
+ path: {
13680
+ id: string;
13681
+ };
13682
+ cookie?: never;
13683
+ };
13684
+ requestBody?: never;
13685
+ responses: {
13686
+ /** @description OK */
13687
+ 200: {
13688
+ headers: {
13689
+ /** @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. */
13690
+ "X-Broker-Acting-For"?: string;
13691
+ [name: string]: unknown;
13692
+ };
13693
+ content: {
13694
+ "application/json": components["schemas"]["CustomerRepinnedSubmissionResponse"];
13695
+ };
13696
+ };
13697
+ /** @description Not Found */
13698
+ 404: {
13699
+ headers: {
13700
+ /** @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. */
13701
+ "X-Broker-Acting-For"?: string;
13702
+ [name: string]: unknown;
13703
+ };
13704
+ content?: never;
13705
+ };
13706
+ /** @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. */
13707
+ 409: {
13708
+ headers: {
13709
+ /** @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. */
13710
+ "X-Broker-Acting-For"?: string;
13711
+ [name: string]: unknown;
13712
+ };
13713
+ content: {
13714
+ "application/problem+json": components["schemas"]["ConcurrencyConflictProblem"] | components["schemas"]["ProblemDetails"];
13715
+ };
13716
+ };
13717
+ };
13718
+ };
13645
13719
  UploadSubmissionAttachment: {
13646
13720
  parameters: {
13647
13721
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@insurance-broker/api-client",
3
- "version": "5.17.0",
3
+ "version": "5.18.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,