@delopay/sdk 0.280.0 → 0.285.0

package/dist/index.cjs

@@ -80,6 +80,7 @@ __export(index_exports, {
   Forex: () => Forex,
   GOOGLE_PAY_BUTTON_COLORS: () => GOOGLE_PAY_BUTTON_COLORS,
   GOOGLE_PAY_BUTTON_TYPES: () => GOOGLE_PAY_BUTTON_TYPES,
+  IdentityVerifications: () => IdentityVerifications,
   InvoiceSettingsResource: () => InvoiceSettingsResource,
   Invoices: () => Invoices,
   LOCALIZABLE_COPY_FIELDS: () => LOCALIZABLE_COPY_FIELDS,
@@ -171,6 +172,7 @@ __export(index_exports, {
   cardFieldFontPx: () => cardFieldFontPx,
   cardFieldWeightValue: () => cardFieldWeightValue,
   checkoutCopy: () => checkoutCopy,
+  checkoutEntryUrl: () => checkoutEntryUrl,
   checkoutLocaleDir: () => checkoutLocaleDir,
   cloneBranding: () => cloneBranding,
   cloneCustomField: () => cloneCustomField,
@@ -217,6 +219,7 @@ __export(index_exports, {
   fontWeightValue: () => fontWeightValue,
   inputPadValue: () => inputPadValue,
   isCheckboxChecked: () => isCheckboxChecked,
+  isCheckoutOpenEntryMessage: () => isCheckoutOpenEntryMessage,
   isConfirmedChild: () => isConfirmedChild,
   isDarkSurface: () => isDarkSurface,
   isDefaultBadgeSet: () => isDefaultBadgeSet,
@@ -3062,6 +3065,29 @@ var Payments = class {
       body: params ?? {}
     });
   }
+  /**
+   * Mark a payment as an integration test, or remove the mark.
+   *
+   * A marked payment stays live or test as it was; only analytics leave it
+   * out, from their next refresh on. Every change is recorded in the
+   * payment's status history with the person who made it. Needs a dashboard
+   * JWT with write access to transactions. Asking for the mark the payment
+   * already carries changes nothing (`changed: false`).
+   *
+   * `POST /payments/{paymentId}/integration-test`
+   *
+   * @example
+   * ```typescript
+   * const { is_integration_test } = await delopay.payments.setIntegrationTest('pay_123', {
+   *   is_integration_test: true,
+   * });
+   * ```
+   */
+  async setIntegrationTest(paymentId, params) {
+    return this.request("POST", `/payments/${encodeURIComponent(paymentId)}/integration-test`, {
+      body: params
+    });
+  }
   /**
    * List payment intents, optionally filtered by customer or date range.
    *
@@ -5419,6 +5445,76 @@ var Verification = class {
   }
 };
 
+// src/resources/identityVerifications.ts
+var IdentityVerifications = class {
+  constructor(request) {
+    this.request = request;
+  }
+  /**
+   * Start a verification of a person or a business. The provider-side
+   * workflow decides the checks. With a `return_url`, the provider's session
+   * is created at once and its page returned in `verification_url`. With a
+   * `payment_id` and no `return_url`, the payment's checkout starts it.
+   *
+   * `POST /identity-verifications`
+   */
+  async create(params, options) {
+    return this.request("POST", "/identity-verifications", { body: params, ...options });
+  }
+  /**
+   * The merchant's verifications, newest first. A caller limited to one shop
+   * sees that shop's only.
+   *
+   * `GET /identity-verifications`
+   */
+  async list(query, options) {
+    return this.request("GET", "/identity-verifications", {
+      query,
+      ...options
+    });
+  }
+  /**
+   * One verification. With `force_sync: true`, a verification the provider
+   * can still change (pending or in review) is read from the provider first.
+   *
+   * `GET /identity-verifications/{verification_id}`
+   */
+  async retrieve(verificationId, query, options) {
+    return this.request("GET", `/identity-verifications/${encodeURIComponent(verificationId)}`, {
+      query,
+      ...options
+    });
+  }
+  /**
+   * A subject's latest verification in one environment (live unless
+   * `test_mode: true`), with its checks. This is what risk rules read.
+   * `verification` is `null` when the subject has none.
+   *
+   * `GET /identity-verifications/subjects/{subject_reference}`
+   */
+  async subject(subjectReference, query, options) {
+    return this.request(
+      "GET",
+      `/identity-verifications/subjects/${encodeURIComponent(subjectReference)}`,
+      { query, ...options }
+    );
+  }
+  /**
+   * The provider-side workflows an account can run in one environment, read
+   * from the provider with that environment's credentials. Pass a `flow_id`
+   * as `provider_flow_id` to {@link IdentityVerifications.create}.
+   *
+   * `GET /identity-verifications/accounts/{merchant_connector_id}/flows`
+   */
+  async flows(merchantConnectorId, query, options) {
+    return this.request(
+      "GET",
+      `/identity-verifications/accounts/${encodeURIComponent(merchantConnectorId)}/flows`,
+      { query, ...options }
+    );
+  }
+};
+
 // src/resources/webhooks.ts
 function isSubscriptionLifecycleWebhook(object) {
   return typeof object.transition_id === "string";
@@ -7608,7 +7704,48 @@ var CheckoutMethods = class {
       query: { merchant_id: merchantId }
     });
   }
+  /**
+   * The shop's checkout entries: separate ways into the hosted checkout of
+   * one payment (`?entry=<key>`), such as a card form embedded in the shop's
+   * page, a "Pay with crypto" checkout and an "Other payment methods"
+   * checkout, each in its own named look. Live's by default; `environment:
+   * 'test'` reads the Test checkout's, used by payments with `test_mode: true`.
+   * Refused (403) to a caller that may not see or change every method.
+   * `GET /checkout-methods/{profile_id}/entries` (`/test/entries`)
+   */
+  async entries(merchantId, profileId, params = {}) {
+    return this.request("GET", entriesPath(profileId, params.environment), {
+      query: { merchant_id: merchantId }
+    });
+  }
+  /**
+   * Replace the shop's entries of one environment. Refused when a key is
+   * malformed or used twice, when an entry lists a method, group or card form
+   * that environment's layout does not place, or when a card entry's
+   * `other_entry` is not another `methods` entry.
+   * `PUT /checkout-methods/{profile_id}/entries` (`/test/entries`)
+   */
+  async updateEntries(merchantId, profileId, body, params = {}) {
+    return this.request("PUT", entriesPath(profileId, params.environment), {
+      query: { merchant_id: merchantId },
+      body
+    });
+  }
+  /**
+   * Delete every entry of one environment. A link that still names an entry
+   * then offers nothing.
+   * `DELETE /checkout-methods/{profile_id}/entries` (`/test/entries`)
+   */
+  async clearEntries(merchantId, profileId, params = {}) {
+    return this.request("DELETE", entriesPath(profileId, params.environment), {
+      query: { merchant_id: merchantId }
+    });
+  }
 };
+function entriesPath(profileId, environment) {
+  const shop = `/checkout-methods/${encodeURIComponent(profileId)}`;
+  return environment === "test" ? `${shop}/test/entries` : `${shop}/entries`;
+}
 
 // src/resources/subscriptions.ts
 var Subscriptions = class {
@@ -9626,6 +9763,7 @@ var Delopay = class {
     this.profileAcquirers = new ProfileAcquirers(request);
     this.authentication = new Authentication(request);
     this.verification = new Verification(request);
+    this.identityVerifications = new IdentityVerifications(request);
     this.users = new Users(request);
     this.apiKeys = new ApiKeys(request);
     this.billing = new Billing(request);
@@ -13487,6 +13625,10 @@ var CheckoutSession = class {
    * `cardAccount` name that form's connector and account; absent or blank
    * matches any.
    *
+   * `entry` opens one of the shop's checkout entries (`?entry=`): the layout
+   * holds only that entry's methods and is drawn in its named look, and
+   * `entry` on the answer says whether it had anything to offer.
+   *
    * `GET /payment-link/data/{merchantId}/{paymentId}`
    */
   async fetchCheckoutData(params, options) {
@@ -13500,7 +13642,8 @@ var CheckoutSession = class {
           country: country || void 0,
           card_only: params?.cardOnly || void 0,
           card_provider: params?.cardOnly ? params.cardProvider?.trim() || void 0 : void 0,
-          card_account: params?.cardOnly ? params.cardAccount?.trim() || void 0 : void 0
+          card_account: params?.cardOnly ? params.cardAccount?.trim() || void 0 : void 0,
+          entry: params?.entry?.trim() || void 0
         },
         ...options,
         headers: {
@@ -13981,6 +14124,43 @@ var CheckoutSession = class {
       headers: this.bearerHeaders(options?.headers)
     });
   }
+  /**
+   * The payment's identity verification step: whether the payment asked for
+   * one, its outcome, and the provider's page while it is pending. A pending
+   * verification is read from the provider first, so call this when the buyer
+   * comes back from the provider's page.
+   *
+   * `required` is `false` when the payment asked for no verification.
+   * `can_retry` is `true` after an expired or abandoned attempt; start a new
+   * one with {@link CheckoutSession.startIdentityVerification}.
+   *
+   * `GET /payment-link/{merchantId}/{paymentId}/identity-verification`
+   */
+  async identityVerification(options) {
+    return this.client.request("GET", `${this.linkBase}/identity-verification`, {
+      ...options,
+      headers: this.bearerHeaders(options?.headers)
+    });
+  }
+  /**
+   * Resume the payment's pending identity verification, start it, or start a
+   * new attempt after an expired or abandoned one. Send the buyer to the
+   * returned `verification_url`; the provider sends them back to `return_url`,
+   * which must be on the payment's checkout origin.
+   *
+   * Refusals throw a `DelopayError`: `400` when the return URL is not on the
+   * payment's checkout or the verification is already decided, `404` when the
+   * payment asked for no verification.
+   *
+   * `POST /payment-link/{merchantId}/{paymentId}/identity-verification`
+   */
+  async startIdentityVerification(params, options) {
+    return this.client.request("POST", `${this.linkBase}/identity-verification`, {
+      body: params,
+      ...options,
+      headers: this.bearerHeaders(options?.headers)
+    });
+  }
   /**
    * Ask whether NomuPay's COPYandPAY widget may submit a card, from the
    * form's pre-submit hook.
@@ -14703,6 +14883,20 @@ function focusedCheckoutUrl(params) {
   if (params.customFieldsCollected) query.set("cf", "1");
   return `${path}?${query.toString()}`;
 }
+function checkoutEntryUrl(params) {
+  const base = params.checkoutBaseUrl.replace(/\/+$/, "");
+  const path = params.paymentLinkId && OPAQUE_PAYMENT_LINK_ID.test(params.paymentLinkId) ? `${base}/pay/${params.paymentLinkId}` : `${base}/pay/${encodeURIComponent(params.merchantId)}/${encodeURIComponent(
+    params.paymentId
+  )}`;
+  const query = new URLSearchParams({ entry: params.entry.trim() });
+  if (params.locale) query.set("locale", params.locale);
+  return `${path}?${query.toString()}`;
+}
+function isCheckoutOpenEntryMessage(data) {
+  if (typeof data !== "object" || data === null) return false;
+  const message = data;
+  return message.type === "open_entry" && typeof message.source === "string" && typeof message.payment_id === "string" && typeof message.entry === "string" && typeof message.url === "string";
+}
 var CHECKOUT_EVENT_KINDS = [
   "native_pane_selected",
   "native_pane_tab_opened",
@@ -14791,6 +14985,7 @@ var encodeNativePanes = encodePanes;
   Forex,
   GOOGLE_PAY_BUTTON_COLORS,
   GOOGLE_PAY_BUTTON_TYPES,
+  IdentityVerifications,
   InvoiceSettingsResource,
   Invoices,
   LOCALIZABLE_COPY_FIELDS,
@@ -14882,6 +15077,7 @@ var encodeNativePanes = encodePanes;
   cardFieldFontPx,
   cardFieldWeightValue,
   checkoutCopy,
+  checkoutEntryUrl,
   checkoutLocaleDir,
   cloneBranding,
   cloneCustomField,
@@ -14928,6 +15124,7 @@ var encodeNativePanes = encodePanes;
   fontWeightValue,
   inputPadValue,
   isCheckboxChecked,
+  isCheckoutOpenEntryMessage,
   isConfirmedChild,
   isDarkSurface,
   isDefaultBadgeSet,