@delopay/sdk 0.177.0 → 0.179.0

package/dist/index.cjs

@@ -1060,8 +1060,8 @@ var Customers = class {
     return this.request("DELETE", `/customers/${encodeURIComponent(customerId)}`);
   }
   /**
-   * List customers, optionally filtered by email, shop (`profile_id`), or
-   * project (`project_id`).
+   * List customers, optionally filtered by customer id/name/email prefix,
+   * shop (`profile_id`), or project (`project_id`).
    *
    * @param params - Optional filter and pagination parameters.
    * @returns Array of customer objects.
@@ -3972,7 +3972,8 @@ var Users = class {
     return this.request("GET", `/user/preferences/${encodeURIComponent(key)}`);
   }
   /**
-   * Atomically replace one own preference (last write wins). The JSON object is
+   * Save one own preference: omitted/false if_absent replaces it (last write wins);
+   * true preserves an existing object and returns the winner. The JSON object is
    * limited to 16 KiB of compact UTF-8 JSON. For layouts, use one namespaced key
    * per page (e.g. merchant.analytics.payments) and ordered widget IDs per region,
    * without titles, fetched metrics or rendered state. Requires a login JWT.
@@ -3980,7 +3981,25 @@ var Users = class {
   async setPreference(key, params) {
     return this.request("PUT", `/user/preferences/${encodeURIComponent(key)}`, { body: params });
   }
-  /** Reset an own preference to defaults. Idempotent; returns value null. Login JWT only. */
+  /**
+   * Initialize only a missing preference. Existing objects, including a client
+   * reset marker saved with setPreference (for example { reset: true }), win. Render/cache the returned value, which may differ from
+   * the proposed value. Safe for migration retries after a lost response.
+   * Explicit edits and reset markers use setPreference with no if_absent flag.
+   * DELETE removes the key; it leaves no marker and permits initialization again.
+   * Requires a login JWT and the same key/object limits as setPreference.
+   */
+  async initializePreference(key, value) {
+    return this.request("PUT", `/user/preferences/${encodeURIComponent(key)}`, {
+      body: { value, if_absent: true }
+    });
+  }
+  /**
+   * Remove an own preference. Idempotent; returns value null, without storing a
+   * tombstone. Later initialization may import a value again. To suppress legacy
+   * migration after a reset, save a client reset-marker object with setPreference.
+   * Login JWT only.
+   */
   async deletePreference(key) {
     return this.request("DELETE", `/user/preferences/${encodeURIComponent(key)}`);
   }
@@ -4628,6 +4647,49 @@ var Analytics = class {
       query: params
     });
   }
+  /**
+   * Every analytics exclusion of the merchant, with the payments each one
+   * matched in the lookback window (todos#184).
+   *
+   * These rules change what the merchant's own dashboards count. Financial
+   * records and transaction lists are never filtered by them.
+   *
+   * ⚠️ `matched_payments` **overlaps between rules and must not be summed**:
+   * a payment matched by three rules is counted once by each. The envelope's
+   * `best_effort` and `lookback_days` qualify every row — matching runs on
+   * client signals that may be absent or expired, within that window.
+   * `GET /analytics/exclusions`
+   */
+  async listExclusions() {
+    return this.request("GET", "/analytics/exclusions");
+  }
+  /**
+   * Write a new exclusion. A shop-scoped user must name their own shop in
+   * `profile_id`; omitting it applies the rule to every shop of the merchant.
+   * Omitting `surfaces` means **all five**, not none.
+   * `POST /analytics/exclusions`
+   */
+  async createExclusion(rule) {
+    return this.request("POST", "/analytics/exclusions", { body: rule });
+  }
+  /**
+   * Replace a stored exclusion **completely**. This is not a patch: every
+   * field you leave out reverts to its default rather than keeping its stored
+   * value, so send the whole rule — including an explicit `null` for a
+   * `profile_id`, `value`, `valid_from`, `valid_until` or `note` you mean to
+   * clear, and the full `surfaces` list you mean to keep.
+   * `PUT /analytics/exclusions/{id}`
+   */
+  async updateExclusion(id, rule) {
+    return this.request("PUT", `/analytics/exclusions/${encodeURIComponent(id)}`, { body: rule });
+  }
+  /**
+   * Delete a stored exclusion. Returns the rule as it was, so a caller can
+   * say what it removed. `DELETE /analytics/exclusions/{id}`
+   */
+  async deleteExclusion(id) {
+    return this.request("DELETE", `/analytics/exclusions/${encodeURIComponent(id)}`);
+  }
   /** Global search. `POST /analytics/search` */
   async search(params) {
     return this.request("POST", "/analytics/search", { body: params });