@delopay/sdk 0.226.0 → 0.227.0

package/dist/index.d.cts

@@ -10149,13 +10149,17 @@ interface SellToRestrictionCapabilitiesResponse {
     rails: SellToRestrictionRailCapability[];
 }
 /**
- * What a buyer blocklist entry matches: the buyer's email address (compared
- * without surrounding spaces and without regard to case), one IPv4 or IPv6
- * address (equivalent notations are one entry), or a customer id. A
- * `customer_id` entry always names a shop, because a customer id is unique
- * inside one shop only.
- */
-type BuyerBlocklistKind = 'email' | 'ip' | 'customer_id';
+ * A kind of identifier a buyer blocklist entry can name: the buyer's email
+ * address (compared without surrounding spaces and without regard to case),
+ * one IPv4 or IPv6 address (equivalent notations are one address), a customer
+ * id, or DeloPay's device identifier (`device_id`, as shown on a payment's
+ * device details; the signature after the last `.` may be left out). An entry
+ * naming a `customer_id` always names a shop, because a customer id is unique
+ * inside one shop only. A `device_id` is matched when the buyer opens the
+ * hosted checkout and when the buyer's browser confirms; a merchant's
+ * server-side create carries none.
+ */
+type BuyerBlocklistKind = 'email' | 'ip' | 'customer_id' | 'device_id';
 /**
  * Which entries {@link BuyerBlocklist.list} returns: the entries that block in
  * every shop together with every shop's own entries (`all`), only the entries
@@ -10172,24 +10176,51 @@ interface BuyerBlocklistListQuery {
     scope?: BuyerBlocklistListScope | null;
     /** The shop to list, with `scope: 'shop'`. */
     profile_id?: string | null;
-    /** Only entries of this kind. */
+    /**
+     * Only entries that include an identifier of this kind, whatever else they
+     * name: `email` also lists an entry naming an email together with an IP.
+     */
     kind?: BuyerBlocklistKind | null;
-    /** Matches the blocked value or the note, ignoring case. */
+    /** Matches any of the entry's identifiers or its note, ignoring case. */
     search?: string | null;
     /** Page size, 1 to 100. Defaults to 20. */
     limit?: number | null;
     /** How many entries to skip. Defaults to 0. */
     offset?: number | null;
 }
-/** Body of {@link BuyerBlocklist.create}: block a buyer. */
+/**
+ * Body of {@link BuyerBlocklist.create}: block a buyer, named by one or more
+ * identifiers. The entry blocks a payment when any one of them matches. At
+ * least one of `email`, `ip`, `customer_id` and `device_id` is required, and
+ * each identifier may be named by only one entry in the same scope.
+ */
 interface BuyerBlocklistEntryCreateRequest {
-    kind: BuyerBlocklistKind;
-    /** The email address, IP address or customer id to block. */
-    value: string;
+    /** The buyer's email address. */
+    email?: string | null;
+    /** One IPv4 or IPv6 address of the buyer. */
+    ip?: string | null;
+    /** A customer id of the shop named in `profile_id`. */
+    customer_id?: string | null;
+    /** DeloPay's device identifier of the buyer's browser. */
+    device_id?: string | null;
+    /**
+     * One identifier as `kind` and `value`, sent together. When given, it is
+     * added to the identifier fields, and refused when it disagrees with the
+     * field of its kind.
+     *
+     * @deprecated Use `email`, `ip`, `customer_id` or `device_id` instead.
+     */
+    kind?: BuyerBlocklistKind | null;
+    /**
+     * The identifier named by `kind`, sent together with it.
+     *
+     * @deprecated Use `email`, `ip`, `customer_id` or `device_id` instead.
+     */
+    value?: string | null;
     /**
      * The shop the entry blocks in. Omitted, the entry blocks in every shop of
-     * the merchant, which a `customer_id` entry cannot, and which only a
-     * merchant role may add.
+     * the merchant, which an entry naming a `customer_id` cannot, and which only
+     * a merchant role may add.
      */
     profile_id?: string | null;
     /**
@@ -10209,11 +10240,32 @@ interface BuyerBlocklistEntryDeleteRequest {
     /** Why the buyer is unblocked, kept in the audit log. At most 1024 characters. */
     reason?: string | null;
 }
-/** One blocked buyer. */
+/**
+ * One blocked buyer. The entry blocks a payment when any one of its
+ * identifiers matches; at least one of them is not `null`.
+ */
 interface BuyerBlocklistEntryResponse {
     id: string;
+    /** The buyer's email address, normalised as it is matched. `null` when the entry names none. */
+    email: string | null;
+    /** The buyer's IP address in canonical form. `null` when the entry names none. */
+    ip: string | null;
+    /** The blocked customer id. `null` when the entry names none. */
+    customer_id: string | null;
+    /** The blocked device identifier, without its signature. `null` when the entry names none. */
+    device_id: string | null;
+    /**
+     * The kind of the entry's first identifier, in the order `customer_id`,
+     * `email`, `ip`, `device_id`.
+     *
+     * @deprecated Read `email`, `ip`, `customer_id` and `device_id` instead.
+     */
     kind: BuyerBlocklistKind;
-    /** The blocked value, normalised as it is matched. */
+    /**
+     * The entry's first identifier (see `kind`), normalised as it is matched.
+     *
+     * @deprecated Read `email`, `ip`, `customer_id` and `device_id` instead.
+     */
     value: string;
     /** The shop the entry blocks in. `null` when it blocks in every shop. */
     profile_id: string | null;
@@ -20041,9 +20093,11 @@ declare class SellToRestrictions {
 }
 
 /**
- * Buyer blocklist: the buyers a merchant refuses to sell to again, by email
- * address, IP address or customer id, in every shop of the merchant or in one
- * shop. A blocked buyer's hosted checkout and confirms fail with error code
+ * Buyer blocklist: the buyers a merchant refuses to sell to again, in every
+ * shop of the merchant or in one shop. One entry names the buyer by email
+ * address, IP address, customer id and device id, at most one of each and at
+ * least one in total, and blocks a payment when any one of them matches. A
+ * blocked buyer's hosted checkout and confirms fail with error code
  * `DE_14`, and the payments create response marks the buyer with
  * `buyer_blocked` and the entry's `buyer_block_note`. This is not the card
  * blocklist (`client.blocklist`), which is a separate list.
@@ -20057,16 +20111,18 @@ declare class BuyerBlocklist {
     private readonly request;
     constructor(request: RequestFn);
     /**
-     * One page of blocked buyers, newest first, filtered by scope, kind and a
-     * search over the value and the note. Expired entries are not listed.
+     * One page of blocked buyers, newest first, filtered by scope, by `kind`
+     * (the entries that include an identifier of that kind) and by a search
+     * over every identifier and the note. Expired entries are not listed.
      * `GET /buyer-blocklist`
      */
     list(params?: BuyerBlocklistListQuery): Promise<BuyerBlocklistListResponse>;
     /**
      * Block a buyer in one shop or, without `profile_id`, in every shop of the
-     * merchant. The value is normalised as it is matched; a value already
-     * blocked in that scope is refused. The change is recorded in the audit log
-     * before it is made.
+     * merchant, named by one or more of `email`, `ip`, `customer_id` and
+     * `device_id`. Each identifier is normalised as it is matched; an
+     * identifier another entry already names in that scope is refused. The
+     * change is recorded in the audit log before it is made.
      * `POST /buyer-blocklist`
      */
     create(params: BuyerBlocklistEntryCreateRequest): Promise<BuyerBlocklistEntryResponse>;

package/dist/index.d.ts

@@ -10149,13 +10149,17 @@ interface SellToRestrictionCapabilitiesResponse {
     rails: SellToRestrictionRailCapability[];
 }
 /**
- * What a buyer blocklist entry matches: the buyer's email address (compared
- * without surrounding spaces and without regard to case), one IPv4 or IPv6
- * address (equivalent notations are one entry), or a customer id. A
- * `customer_id` entry always names a shop, because a customer id is unique
- * inside one shop only.
- */
-type BuyerBlocklistKind = 'email' | 'ip' | 'customer_id';
+ * A kind of identifier a buyer blocklist entry can name: the buyer's email
+ * address (compared without surrounding spaces and without regard to case),
+ * one IPv4 or IPv6 address (equivalent notations are one address), a customer
+ * id, or DeloPay's device identifier (`device_id`, as shown on a payment's
+ * device details; the signature after the last `.` may be left out). An entry
+ * naming a `customer_id` always names a shop, because a customer id is unique
+ * inside one shop only. A `device_id` is matched when the buyer opens the
+ * hosted checkout and when the buyer's browser confirms; a merchant's
+ * server-side create carries none.
+ */
+type BuyerBlocklistKind = 'email' | 'ip' | 'customer_id' | 'device_id';
 /**
  * Which entries {@link BuyerBlocklist.list} returns: the entries that block in
  * every shop together with every shop's own entries (`all`), only the entries
@@ -10172,24 +10176,51 @@ interface BuyerBlocklistListQuery {
     scope?: BuyerBlocklistListScope | null;
     /** The shop to list, with `scope: 'shop'`. */
     profile_id?: string | null;
-    /** Only entries of this kind. */
+    /**
+     * Only entries that include an identifier of this kind, whatever else they
+     * name: `email` also lists an entry naming an email together with an IP.
+     */
     kind?: BuyerBlocklistKind | null;
-    /** Matches the blocked value or the note, ignoring case. */
+    /** Matches any of the entry's identifiers or its note, ignoring case. */
     search?: string | null;
     /** Page size, 1 to 100. Defaults to 20. */
     limit?: number | null;
     /** How many entries to skip. Defaults to 0. */
     offset?: number | null;
 }
-/** Body of {@link BuyerBlocklist.create}: block a buyer. */
+/**
+ * Body of {@link BuyerBlocklist.create}: block a buyer, named by one or more
+ * identifiers. The entry blocks a payment when any one of them matches. At
+ * least one of `email`, `ip`, `customer_id` and `device_id` is required, and
+ * each identifier may be named by only one entry in the same scope.
+ */
 interface BuyerBlocklistEntryCreateRequest {
-    kind: BuyerBlocklistKind;
-    /** The email address, IP address or customer id to block. */
-    value: string;
+    /** The buyer's email address. */
+    email?: string | null;
+    /** One IPv4 or IPv6 address of the buyer. */
+    ip?: string | null;
+    /** A customer id of the shop named in `profile_id`. */
+    customer_id?: string | null;
+    /** DeloPay's device identifier of the buyer's browser. */
+    device_id?: string | null;
+    /**
+     * One identifier as `kind` and `value`, sent together. When given, it is
+     * added to the identifier fields, and refused when it disagrees with the
+     * field of its kind.
+     *
+     * @deprecated Use `email`, `ip`, `customer_id` or `device_id` instead.
+     */
+    kind?: BuyerBlocklistKind | null;
+    /**
+     * The identifier named by `kind`, sent together with it.
+     *
+     * @deprecated Use `email`, `ip`, `customer_id` or `device_id` instead.
+     */
+    value?: string | null;
     /**
      * The shop the entry blocks in. Omitted, the entry blocks in every shop of
-     * the merchant, which a `customer_id` entry cannot, and which only a
-     * merchant role may add.
+     * the merchant, which an entry naming a `customer_id` cannot, and which only
+     * a merchant role may add.
      */
     profile_id?: string | null;
     /**
@@ -10209,11 +10240,32 @@ interface BuyerBlocklistEntryDeleteRequest {
     /** Why the buyer is unblocked, kept in the audit log. At most 1024 characters. */
     reason?: string | null;
 }
-/** One blocked buyer. */
+/**
+ * One blocked buyer. The entry blocks a payment when any one of its
+ * identifiers matches; at least one of them is not `null`.
+ */
 interface BuyerBlocklistEntryResponse {
     id: string;
+    /** The buyer's email address, normalised as it is matched. `null` when the entry names none. */
+    email: string | null;
+    /** The buyer's IP address in canonical form. `null` when the entry names none. */
+    ip: string | null;
+    /** The blocked customer id. `null` when the entry names none. */
+    customer_id: string | null;
+    /** The blocked device identifier, without its signature. `null` when the entry names none. */
+    device_id: string | null;
+    /**
+     * The kind of the entry's first identifier, in the order `customer_id`,
+     * `email`, `ip`, `device_id`.
+     *
+     * @deprecated Read `email`, `ip`, `customer_id` and `device_id` instead.
+     */
     kind: BuyerBlocklistKind;
-    /** The blocked value, normalised as it is matched. */
+    /**
+     * The entry's first identifier (see `kind`), normalised as it is matched.
+     *
+     * @deprecated Read `email`, `ip`, `customer_id` and `device_id` instead.
+     */
     value: string;
     /** The shop the entry blocks in. `null` when it blocks in every shop. */
     profile_id: string | null;
@@ -20041,9 +20093,11 @@ declare class SellToRestrictions {
 }
 
 /**
- * Buyer blocklist: the buyers a merchant refuses to sell to again, by email
- * address, IP address or customer id, in every shop of the merchant or in one
- * shop. A blocked buyer's hosted checkout and confirms fail with error code
+ * Buyer blocklist: the buyers a merchant refuses to sell to again, in every
+ * shop of the merchant or in one shop. One entry names the buyer by email
+ * address, IP address, customer id and device id, at most one of each and at
+ * least one in total, and blocks a payment when any one of them matches. A
+ * blocked buyer's hosted checkout and confirms fail with error code
  * `DE_14`, and the payments create response marks the buyer with
  * `buyer_blocked` and the entry's `buyer_block_note`. This is not the card
  * blocklist (`client.blocklist`), which is a separate list.
@@ -20057,16 +20111,18 @@ declare class BuyerBlocklist {
     private readonly request;
     constructor(request: RequestFn);
     /**
-     * One page of blocked buyers, newest first, filtered by scope, kind and a
-     * search over the value and the note. Expired entries are not listed.
+     * One page of blocked buyers, newest first, filtered by scope, by `kind`
+     * (the entries that include an identifier of that kind) and by a search
+     * over every identifier and the note. Expired entries are not listed.
      * `GET /buyer-blocklist`
      */
     list(params?: BuyerBlocklistListQuery): Promise<BuyerBlocklistListResponse>;
     /**
      * Block a buyer in one shop or, without `profile_id`, in every shop of the
-     * merchant. The value is normalised as it is matched; a value already
-     * blocked in that scope is refused. The change is recorded in the audit log
-     * before it is made.
+     * merchant, named by one or more of `email`, `ip`, `customer_id` and
+     * `device_id`. Each identifier is normalised as it is matched; an
+     * identifier another entry already names in that scope is refused. The
+     * change is recorded in the audit log before it is made.
      * `POST /buyer-blocklist`
      */
     create(params: BuyerBlocklistEntryCreateRequest): Promise<BuyerBlocklistEntryResponse>;

package/dist/index.js

@@ -222,7 +222,7 @@ import {
   validatePanes,
   verticalGapValue,
   visibleCustomFields
-} from "./chunk-ILCBRQSO.js";
+} from "./chunk-J6JKP5UX.js";
 export {
   AIRWALLEX_AUTOFILL_TREATMENTS,
   AIRWALLEX_CARD_LAYOUTS,

package/dist/internal.cjs

@@ -5391,8 +5391,9 @@ var BuyerBlocklist = class {
     this.request = request;
   }
   /**
-   * One page of blocked buyers, newest first, filtered by scope, kind and a
-   * search over the value and the note. Expired entries are not listed.
+   * One page of blocked buyers, newest first, filtered by scope, by `kind`
+   * (the entries that include an identifier of that kind) and by a search
+   * over every identifier and the note. Expired entries are not listed.
    * `GET /buyer-blocklist`
    */
   async list(params) {
@@ -5402,9 +5403,10 @@ var BuyerBlocklist = class {
   }
   /**
    * Block a buyer in one shop or, without `profile_id`, in every shop of the
-   * merchant. The value is normalised as it is matched; a value already
-   * blocked in that scope is refused. The change is recorded in the audit log
-   * before it is made.
+   * merchant, named by one or more of `email`, `ip`, `customer_id` and
+   * `device_id`. Each identifier is normalised as it is matched; an
+   * identifier another entry already names in that scope is refused. The
+   * change is recorded in the audit log before it is made.
    * `POST /buyer-blocklist`
    */
   async create(params) {