@didit-protocol/sdk-node 2.13.1 → 2.15.0

package/dist/index.js

@@ -324,7 +324,7 @@ function decodeDates(value, plan, named, depth = 0) {
 }
 
 // src/core/version.ts
-var VERSION = "2.13.1";
+var VERSION = "2.15.0";
 
 // src/core/runtime.ts
 function processLike() {
@@ -1632,6 +1632,7 @@ var DATE_PLANS = {
     p: { results: { i: { p: { biometric_template_expires_at: 1 } } } }
   },
   SessionsCreateKybPartyDraftResponse: { p: { created_at: 1, updated_at: 1 } },
+  SessionsCreateResponse: { p: { expires_at: 1 } },
   SessionsDeleteResponse: { p: { biometric_template_expires_at: 1 } },
   SessionsImportsListActiveJobsResponse: { p: { results: { i: "ImportJobSummary" } } },
   SessionsImportsListErrorsResponse: { p: { results: { i: "SessionImportError" } } },
@@ -1716,7 +1717,8 @@ var DATE_PLANS = {
       data_unmasked: "TravelRuleDataUnmasked",
       counterparty_vasp: { p: { dd_assessed_at: 1 } },
       delivery: "TravelRuleDelivery",
-      discovery: { i: "TravelRuleDiscoveryStep" }
+      discovery: { i: "TravelRuleDiscoveryStep" },
+      user_choice: "TravelRuleUserChoice"
     }
   },
   TransactionNote: { p: { created_at: 1 } },
@@ -1728,7 +1730,8 @@ var DATE_PLANS = {
       counterparty_vasp: { p: { dd_assessed_at: 1 } },
       delivery: "TravelRuleDelivery",
       discovery: { i: "TravelRuleDiscoveryStep" },
-      deliveries: { i: "TravelRuleDeliveryLogEntry" }
+      deliveries: { i: "TravelRuleDeliveryLogEntry" },
+      user_choice: "TravelRuleUserChoice"
     }
   },
   TransactionWalletOwnershipAction: { p: { expires_at: 1 } },
@@ -1822,12 +1825,15 @@ var DATE_PLANS = {
       created_at: 1,
       delivery: "TravelRuleDelivery",
       discovery: { i: "TravelRuleDiscoveryStep" },
-      deliveries: { i: "TravelRuleDeliveryLogEntry" }
+      deliveries: { i: "TravelRuleDeliveryLogEntry" },
+      user_choice: "TravelRuleUserChoice"
     }
   },
   TravelRuleTransferRow: { p: { txn_date: 1, deadline_at: 1, created_at: 1 } },
   TravelRuleTransfersListResponse: { p: { results: { i: "TravelRuleTransferRow" } } },
   TravelRuleUnmatchedDepositsListResponse: { p: { results: { i: "TravelRuleTransferRow" } } },
+  TravelRuleUserChoice: { p: { link_expires_at: 1 } },
+  TravelRuleUserLinkResponse: { p: { expires_at: 1 } },
   TravelRuleWalletAddressesListResponse: { p: { results: { i: "WalletAddressEntry" } } },
   TravelRuleWalletProofReview: { p: { method_chosen_at: 1, decided_at: 1, created_at: 1 } },
   TravelRuleWalletProofsListResponse: { p: { results: { i: "TravelRuleWalletProofReview" } } },
@@ -2136,7 +2142,7 @@ var AddressValidation = class extends APIResource {
    *
    * **Billing.** A live call costs $0.10 per validated address. An `unavailable` result is not charged. Nothing is stored apart from the usage record: no session is created and the result is returned only in this response.
    *
-   * **Sandbox.** Sandbox keys validate the request and always return a deterministic `verified` result that echoes the address sent, without consuming credits.
+   * **Sandbox.** Sandbox keys validate the request and always return a deterministic `verified` result that echoes the address sent, with `address_type` and `is_residential` always `null` (the keys are present), without consuming credits.
    *
    * **Authentication.** Send your application's API key in `x-api-key`. Missing or invalid credentials return `403` - this API never returns `401`.
    *
@@ -2330,13 +2336,13 @@ var Bank = class extends APIResource {
    *
    * **What you send.** The account's `country` (ISO 3166-1 alpha-3), the `account` the way that country writes it, and the `holder` name: `full_name` for a person or `business_name` for a company. A business name checks a business account.
    *
-   * **What you get back.** `result` is `match`, `close_match`, `no_match` or `cannot_verify`. On a `close_match`, `holder_name` is the name the bank holds the account under, when the bank returned it. `account` comes back masked to its last 4 characters.
+   * **What you get back.** `result` is `match`, `close_match`, `no_match` or `cannot_verify`. On a `close_match`, `holder_name` is the name the bank holds the account under, when the bank returned it. `name_match_score` is the 0 to 100 similarity `result` was decided on, so you can apply your own threshold; `result` stays authoritative, decided with the default thresholds (a `match` from 85, a `close_match` from 70). It is `null` when no name was compared: a `cannot_verify`, or a `no_match` for an account that does not exist. `account` comes back masked to its last 4 characters.
    *
    * **Billing.** Each check the bank answers is billed once at the Account check price of the account's country, whatever the result: a `no_match`, an account that does not exist and a `cannot_verify` are billed too. A request answered with an error is never billed.
    *
    * **Every request is a new check.** There is no idempotency key and no endpoint to read a check back, so a retried request runs, and is billed, again. Store the response.
    *
-   * **Sandbox.** Use a sandbox API key with the sample account details. A sandbox key calls no bank and is charged nothing. The last 4 characters of the IBAN, else of the account number, choose the answer: `0001` a `close_match` with a `holder_name`, `0002` a `close_match` without one, `0003` and `0006` a `no_match`, `0004` `cannot_verify`, `0005` a `503` and `0009` a `400`. Any other ending is a `match`.
+   * **Sandbox.** Use a sandbox API key with the sample account details. A sandbox key calls no bank and is charged nothing. The last 4 characters of the IBAN, else of the account number, choose the answer: `0001` a `close_match` with a `holder_name`, `0002` a `close_match` without one (`name_match_score` 78), `0003` a `no_match` (`name_match_score` 0), `0006` a `no_match` for an account that does not exist (`name_match_score` null), `0004` `cannot_verify`, `0005` a `503` and `0009` a `400`. Any other ending is a `match` (`name_match_score` 100).
    *
    * **API keys.** A scoped API key needs write access to sessions.
    *
@@ -2829,6 +2835,12 @@ var Businesses = class extends APIResource {
 };
 
 // src/resources/cases.ts
+var CASES_BLUEPRINTS_AI_DRAFT = {
+  method: "POST",
+  path: "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/ai-draft/",
+  scope: "application",
+  body: "json"
+};
 var CASES_BLUEPRINTS_CREATE = {
   method: "POST",
   path: "/v3/organization/{organization_id}/application/{application_id}/cases/blueprints/",
@@ -3303,10 +3315,20 @@ var CASES_UPDATE = {
   dates: "CaseDetail"
 };
 var CasesBlueprints = class extends APIResource {
+  /**
+   * Draft case blueprint with AI
+   *
+   * Generate an unsaved blueprint proposal. Requires write:cases. Returns a draft object, not a blueprint UUID; no blueprint or saved policy draft is created. Review the proposal, choose assignees and any teams, approvals or routing, then create or update a blueprint separately. Invalid generated content or generation failure returns 503. See [blueprint AI drafts](/management-api/case-blueprints/ai-draft).
+   *
+   * `POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/ai-draft/`
+   */
+  aiDraft(params, options) {
+    return this._client.request(CASES_BLUEPRINTS_AI_DRAFT, [], params, options);
+  }
   /**
    * Create blueprint
    *
-   * Create a case blueprint: general settings (assignment, escalation, transfer, 4-eyes pairing) plus content_config, the six sections that drive the case page. Set publish=false to create an unpublished draft; Publish creates its first live version. Discarding a never-published draft deletes it.
+   * Create a case blueprint: general settings (assignment, escalation, transfer, 4-eyes pairing) plus content_config, the six sections that drive the case page. Set publish=false to create an unpublished draft; Publish creates its first live version. Discarding a never-published draft deletes it. applies_to accepts the six case-type values. content_config.stages.items[].worked_by is an optional active review-team UUID from this application. These settings are preserved in case policy snapshots; later edits do not change existing snapshots.
    *
    * `POST /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/`
    */
@@ -3420,7 +3442,7 @@ var CasesBlueprints = class extends APIResource {
   /**
    * Update blueprint
    *
-   * Partially update a blueprint's general settings or content_config.
+   * Partially update a blueprint's general settings or content_config. applies_to accepts the six case-type values. content_config.stages.items[].worked_by is an optional active review-team UUID from this application. These settings are preserved in case policy snapshots; later edits do not change existing snapshots.
    *
    * `PATCH /v3/organization/{organization_id}/application/{application_id}/cases/blueprints/{blueprint_uuid}/`
    *
@@ -3461,7 +3483,7 @@ var CasesLinks = class extends APIResource {
   /**
    * Add case link
    *
-   * Attach a session, business session, or transaction to the case. Rejected with 400 if the entity belongs to a different subject than the case.
+   * Attach a session, business session, transaction, or network to the case. Rejected with 400 if the entity belongs to a different subject than the case. Network links require write:cases plus read:networks, Networks access and investigation access for the network scope. The network must be visible and contain the case subject. Manually adding links to network-generated cases is not allowed.
    *
    * `POST /v3/organization/{organization_id}/application/{application_id}/cases/{case_uuid}/links/`
    *
@@ -3878,7 +3900,7 @@ var Cases = class extends APIResource {
   /**
    * Create case
    *
-   * Create a case anchored to exactly one subject (a user or a business), directly or by deriving the subject from an attached session/transaction link. Source is always `MANUAL` for API-created cases.
+   * Create a case anchored to exactly one subject (a user or a business), directly or by deriving the subject from an attached session/transaction link. Source is always `MANUAL` for API-created cases. Network links require write:cases plus read:networks, Networks access and investigation access for the network scope. The network must be visible and contain the case subject. Manually adding links to network-generated cases is not allowed. An explicit subject is required whenever links includes a network.
    *
    * `POST /v3/organization/{organization_id}/application/{application_id}/cases/`
    */
@@ -6748,7 +6770,12 @@ var SESSIONS_CANCEL_FEATURE_OVERRIDE = {
   path: "/v3/session/{sessionId}/features/overrides/{overrideId}/cancel/",
   dates: "FeatureStatusOverride"
 };
-var SESSIONS_CREATE = { method: "POST", path: "/v3/session/", body: "json" };
+var SESSIONS_CREATE = {
+  method: "POST",
+  path: "/v3/session/",
+  body: "json",
+  dates: { p: { expires_at: 1 } }
+};
 var SESSIONS_CREATE_KYB_PARTY_DRAFT = {
   method: "POST",
   path: "/v3/session/{sessionId}/kyb/parties/drafts/",
@@ -7393,9 +7420,9 @@ var Sessions = class extends APIResource {
    *
    * Call this from your backend (never the browser - the API key is a secret) whenever a user or business needs to be verified: at signup, before a sensitive action, or when re-verification is required. Prerequisites: a published workflow (created in the Console [Workflows](https://docs.didit.me/console/workflows) page) and an application API key with available credits. Sandbox applications bypass the credit check.
    *
-   * **Idempotency:** when `vendor_data` is provided and an unfinished session (`Not Started`, `In Progress`, `Resubmitted`, or `Awaiting User`) with the same `vendor_data` already exists on the workflow's **current latest published version** (and that session already has a hosted verification URL), the existing session is returned (still `201`) instead of creating a duplicate - with its `callback` and `metadata` updated to the newly provided values. An unfinished session created on an older version of the workflow (one that has since been republished) is **not** reused; a new session pinned to the latest published version is created instead. Sessions in `Approved`, `Declined`, `In Review`, `Expired`, `Abandoned`, or `Kyc Expired` are never reused.
+   * **Idempotency:** for a User Verification workflow, when `vendor_data` is provided and an unfinished session (`Not Started`, `In Progress`, `Resubmitted`, or `Awaiting User`) with the same `vendor_data` already exists on the workflow's **current latest published version** (and that session already has a hosted verification URL), the existing session is returned (still `201`) instead of creating a duplicate - with its `callback` and `metadata` updated to the newly provided values. An unfinished session created on an older version of the workflow (one that has since been republished) is **not** reused; a new session pinned to the latest published version is created instead. Sessions in `Approved`, `Declined`, `In Review`, `Expired`, `Abandoned`, or `Kyc Expired` are never reused. A Business Verification workflow creates a new session on every call.
    *
-   * **Side effects:** the hosted verification URL is generated and stored; if `contact_details.send_notification_emails` is `true` and an email is provided, a verification invite email is sent. The session expires after the workflow's configured session expiration time. For KYB workflows, `contact_details.phone` and `expected_details` are ignored.
+   * **Side effects:** the hosted verification URL is generated and stored; if `contact_details.send_notification_emails` is `true` and an email is provided, a verification invite email is sent. The session expires after `session_expiration_time` seconds when the request sets it, otherwise after the workflow's configured session expiration time. For KYB workflows, `contact_details.phone` and `expected_details` are ignored.
    *
    * `POST /v3/session/`
    */
@@ -8106,6 +8133,12 @@ var TRANSACTIONS_TRAVEL_RULE_CREATE_MESSAGE = {
   body: "json",
   dates: "TravelRuleMessage"
 };
+var TRANSACTIONS_TRAVEL_RULE_CREATE_USER_LINK = {
+  method: "POST",
+  path: "/v3/transactions/{transaction_id}/travel-rule/user-link/",
+  body: "json",
+  dates: "TravelRuleUserLinkResponse"
+};
 var TRANSACTIONS_TRAVEL_RULE_LIST_DELIVERIES = {
   method: "GET",
   path: "/v3/transactions/{transaction_id}/travel-rule/deliveries/",
@@ -8357,6 +8390,23 @@ var TransactionsTravelRule = class extends APIResource {
       options
     );
   }
+  /**
+   * Create or email a Travel Rule end-user link
+   *
+   * Issue a new link and revoke previous open links for this transfer. Requires write access to transactions and an outbound transfer in AWAITING_COUNTERPARTY, COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, UNCONFIRMED_OWNERSHIP or ON_HOLD. channel=email uses the end user's Didit-record email and verification-session language when available. A send failure returns the link with emailed_to empty; email_available reports address availability, not delivery. See [User links](/management-api/travel-rule/create-user-link).
+   *
+   * `POST /v3/transactions/{transaction_id}/travel-rule/user-link/`
+   *
+   * @param transactionId Didit-stable transaction UUID that owns the transfer.
+   */
+  createUserLink(transactionId, params = {}, options) {
+    return this._client.request(
+      TRANSACTIONS_TRAVEL_RULE_CREATE_USER_LINK,
+      [transactionId],
+      params,
+      options
+    );
+  }
   /**
    * List Travel Rule delivery history
    *
@@ -8407,9 +8457,9 @@ var TransactionsTravelRule = class extends APIResource {
     );
   }
   /**
-   * Finish, cancel, resend, or update the originator wallet of a Travel Rule transfer
+   * Update a Travel Rule transfer
    *
-   * Provide `payment_txn_id` to report the on-chain hash and move an outbound COMPLETED transfer to FINISHED (its INTERNAL-rail counterpart also moves to FINISHED), `{"action": "cancel"}` to cancel a non-terminal transfer, or `{"action": "resend"}` to route an outbound transfer stuck in COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, or NOT_ENOUGH_COUNTERPARTY_DATA again (improve the counterparty data first, e.g. add a travel_address to the destination wallet entry). resend applies to outbound transfers only. `{"action": "update_compliance_email", "compliance_email": "desk@example.com"}` replaces the compliance email of an outbound transfer in one of those three statuses, the fix for `reason: email_undeliverable`: the status does not change, and the next `resend` sends the request to that address. A resend is queued, not run inside the request: the response shows the transfer back in AWAITING_COUNTERPARTY with a `resend queued` timeline entry and a queued `delivery`, and where it went arrives as a `travel_rule.status.updated` webhook. When the transfer went over GTR, VerifyVASP or Sygna Bridge, the network learns the on-chain hash or the cancellation after the response, with retries; `delivery` shows how that message stands. `{"action": "update_originator_wallet", "wallet_address": "..."}` records the wallet the funds actually left from on an outbound transfer, for example the address a UTXO withdrawal was broadcast from rather than the main wallet you declared. It changes the record only: nothing is sent to the counterparty again and the status stays. The originator becomes `chain_details.originator` with `source: updated`, the change is added to the `timeline` with the previous and the new wallet, and the INTERNAL-rail counterpart of the transfer is updated the same way. `{"action": "beneficiary_vasp", "beneficiary_vasp": "<directory VASP id>"}` names the counterparty yourself when discovery could not, on an outbound transfer in COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE or NOT_ENOUGH_COUNTERPARTY_DATA: the transfer is routed to that VASP and sent again.
+   * Provide `payment_txn_id` to report the on-chain hash and move an outbound COMPLETED transfer to FINISHED (its INTERNAL-rail counterpart also moves to FINISHED), `{"action": "cancel"}` to cancel a non-terminal transfer, or `{"action": "resend"}` to route an outbound transfer stuck in COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE, or NOT_ENOUGH_COUNTERPARTY_DATA again (improve the counterparty data first, e.g. add a travel_address to the destination wallet entry). resend applies to outbound transfers only. `{"action": "update_compliance_email", "compliance_email": "desk@example.com"}` replaces the compliance email of an outbound transfer in one of those three statuses, the fix for `reason: email_undeliverable`: the status does not change, and the next `resend` sends the request to that address. A resend is queued, not run inside the request: the response shows the transfer back in AWAITING_COUNTERPARTY with a `resend queued` timeline entry and a queued `delivery`, and where it went arrives as a `travel_rule.status.updated` webhook. When the transfer went over GTR, VerifyVASP or Sygna Bridge, the network learns the on-chain hash or the cancellation after the response, with retries; `delivery` shows how that message stands. `{"action": "update_originator_wallet", "wallet_address": "..."}` records the wallet the funds actually left from on an outbound transfer, for example the address a UTXO withdrawal was broadcast from rather than the main wallet you declared. It changes the record only: nothing is sent to the counterparty again and the status stays. The originator becomes `chain_details.originator` with `source: updated`, the change is added to the `timeline` with the previous and the new wallet, and the INTERNAL-rail counterpart of the transfer is updated the same way. `{"action": "beneficiary_vasp", "beneficiary_vasp": "<directory VASP id>"}` names the counterparty yourself when discovery could not, on an outbound transfer in COUNTERPARTY_VASP_NOT_FOUND, COUNTERPARTY_VASP_NOT_REACHABLE or NOT_ENOUGH_COUNTERPARTY_DATA: the transfer is routed to that VASP and sent again. Cancellation accepts an optional reason and returns cancel_reason and cancelled_by. Resend accepts notify_on_answer; omission preserves the saved preference, initially false. Resend invalidates the previous counterparty pickup link. action=add_vasp_hint requires name, accepts lei and country, saves the hint and re-runs discovery under the same outbound/status restrictions as resend. update_compliance_email also accepts vasp_name and saves the address as an application-private contact when the transfer has a known directory VASP.
    *
    * `PATCH /v3/transactions/{transaction_id}/travel-rule/`
    *
@@ -8596,6 +8646,7 @@ var TRAVEL_RULE_TRANSFERS_LIST = {
   method: "GET",
   path: "/v3/travel-rule/transfers/",
   query: [
+    "search",
     "direction",
     "status",
     "rail",
@@ -8709,6 +8760,12 @@ var TRAVEL_RULE_CLEAR_VASP_DECISION = {
   path: "/v3/travel-rule/vasps/{vasp_id}/decision/",
   dates: "TravelRuleCounterpartyDecisionResponse"
 };
+var TRAVEL_RULE_CREATE_VASP = {
+  method: "POST",
+  path: "/v3/travel-rule/vasps/",
+  body: "json",
+  dates: "VaspDirectoryEntry"
+};
 var TRAVEL_RULE_CREATE_WIDGET_SESSION = {
   method: "POST",
   path: "/v3/travel-rule/widget-session/",
@@ -9098,6 +9155,16 @@ var TravelRule = class extends APIResource {
   clearVaspDecision(vaspId, options) {
     return this._client.request(TRAVEL_RULE_CLEAR_VASP_DECISION, [vaspId], void 0, options);
   }
+  /**
+   * Create a private VASP directory entry
+   *
+   * Add a VASP privately to your application and optionally invite it. Requires write access to transactions. The response uses source=added_by_you. A matching visible name or LEI returns 409 with the existing vasp_id. See [Search the directory](/management-api/travel-rule/search-vasps).
+   *
+   * `POST /v3/travel-rule/vasps/`
+   */
+  createVasp(params, options) {
+    return this._client.request(TRAVEL_RULE_CREATE_VASP, [], params, options);
+  }
   /**
    * Mint a wallet-ownership widget session
    *
@@ -9123,7 +9190,7 @@ var TravelRule = class extends APIResource {
   /**
    * Search the VASP directory
    *
-   * Paginated, name-sorted search of the VASP directory: the shared directory entries, which Didit builds from the ESMA interim MiCA register, the public TRISA directory, the global LEI register and its own curation, plus the members of the Didit network. Each row carries the routes your application has to it today. Your own application's profile is never listed. Rows also carry the shared due-diligence assessment and your application's own decision, entity screening and questionnaires.
+   * Paginated, name-sorted search of the VASP directory: the shared directory entries, which Didit builds from the ESMA interim MiCA register, the public TRISA directory, the global LEI register and its own curation, plus the members of the Didit network. Each row carries the routes your application has to it today. Your own application's profile is never listed. Rows also carry the shared due-diligence assessment and your application's own decision, entity screening and questionnaires. Includes entries your application added privately. The optional source field distinguishes their provenance; kind=didit member results may omit source.
    *
    * `GET /v3/travel-rule/vasps/`
    */