@delopay/sdk 0.133.0 → 0.136.0

package/dist/index.cjs

@@ -1045,10 +1045,68 @@ var Customers = class {
       query: toQuery(params)
     });
   }
+  /**
+   * Retrieve one customer, scoped to the authenticated dashboard user's shop
+   * (business profile). The shop-scoped counterpart of {@link retrieve}, and
+   * what makes a shop's own customer list clickable: the list is
+   * `ProfileCustomerRead` while {@link retrieve} is merchant-level, so a shop
+   * member could see a customer they could not open.
+   *
+   * A customer belonging to a sibling shop answers `CustomerNotFound` — the
+   * same answer as a customer that does not exist, deliberately, so one shop
+   * cannot enumerate another's customer ids.
+   *
+   * `GET /customers/profile/{customerId}`
+   *
+   * @param customerId - The unique customer ID.
+   * @returns The customer, with `profile_ids` narrowed to the caller's own shop.
+   */
+  async retrieveByProfile(customerId) {
+    return this.request("GET", `/customers/profile/${encodeURIComponent(customerId)}`);
+  }
+  /**
+   * Create a customer from a shop, recording that it belongs to that shop so
+   * the shop can see the customer it just created. The shop is taken from the
+   * credential; a caller-chosen `customer_id` is rejected.
+   *
+   * `POST /customers/profile`
+   *
+   * @param params - The customer to create.
+   * @returns The created customer.
+   */
+  async createByProfile(params) {
+    return this.request("POST", "/customers/profile", { body: params });
+  }
+  /**
+   * Update a customer from a shop, if the customer belongs to that shop.
+   * A sibling shop's customer answers `CustomerNotFound`, as with
+   * {@link retrieveByProfile}.
+   *
+   * `POST /customers/profile/{customerId}`
+   *
+   * @param customerId - The customer ID to update.
+   * @param params - Fields to update.
+   * @returns The updated customer.
+   */
+  async updateByProfile(customerId, params) {
+    return this.request("POST", `/customers/profile/${encodeURIComponent(customerId)}`, {
+      body: params
+    });
+  }
   /** List mandates for a customer. `GET /customers/{customerId}/mandates` */
   async listMandates(customerId) {
     return this.request("GET", `/customers/${encodeURIComponent(customerId)}/mandates`);
   }
+  /**
+   * List one customer's mandates, scoped to the caller's shop. Same membership
+   * rule as {@link retrieveByProfile}: a sibling shop's customer answers
+   * `CustomerNotFound` before any mandate is read.
+   *
+   * `GET /customers/profile/{customerId}/mandates`
+   */
+  async listMandatesByProfile(customerId) {
+    return this.request("GET", `/customers/profile/${encodeURIComponent(customerId)}/mandates`);
+  }
 };
 
 // src/resources/disputes.ts
@@ -1218,11 +1276,39 @@ var Events = class {
       `/events/${encodeURIComponent(merchantId)}/${encodeURIComponent(eventId)}/retry`
     );
   }
+  /**
+   * Fire an outgoing webhook event by hand for one object.
+   * `POST /events/{merchant_id}/trigger` (be#318)
+   *
+   * Not a replay — see {@link EventManualTriggerRequest}. Needs the
+   * `WebhookEventTrigger` permission, which is separate from the one that
+   * authorizes {@link retryDelivery}, and is JWT-only: a forged payload must
+   * be attributable to a person.
+   */
+  async trigger(merchantId, body) {
+    return this.request("POST", `/events/${encodeURIComponent(merchantId)}/trigger`, { body });
+  }
   // --- Profile-scoped listing (Task 4.12) ---
-  /** List events (profile-scoped). `POST /events/profile/list` */
+  /**
+   * List events (profile-scoped). `POST /events/profile/list`
+   *
+   * Takes the same constraints as {@link list} — it is the same endpoint
+   * narrowed to the caller's own shop, so `profile_id` is redundant and
+   * ignored there.
+   */
   async listByProfile(params) {
     return this.request("POST", "/events/profile/list", { body: params });
   }
+  /**
+   * Fire an outgoing webhook event by hand (profile-scoped).
+   * `POST /events/profile/trigger` (be#318)
+   *
+   * The shop-user twin of {@link trigger}; the shop is taken from the auth
+   * context, so `profile_id` on the body is ignored.
+   */
+  async triggerByProfile(body) {
+    return this.request("POST", "/events/profile/trigger", { body });
+  }
 };
 
 // src/resources/fees.ts
@@ -1752,6 +1838,43 @@ var Payments = class {
       options
     );
   }
+  /**
+   * What the payment's rail says about settling each attempt: whether the
+   * money is still `pending` in the rail's hands, `available` in its balance
+   * (**not** paid out), `paid_out` to a bank — with the payout's date and
+   * reference — or came back as `payout_failed`; and, for the rest, which
+   * kind of not-knowing applies (`unavailable`, `unknown`, `not_recorded`).
+   * See {@link ConnectorSettlementStatus} for the seven values. The same
+   * status for the active attempt rides on every list row and retrieve as
+   * `connector_settlement_status`, and the list filters on it.
+   *
+   * Not the hosted-shop settlement API under `settlement.*`, which is host →
+   * shop owner and manual; this is acquirer → merchant bank, per payment.
+   *
+   * `GET /payments/{paymentId}/settlement`
+   *
+   * @param paymentId - The payment intent ID.
+   * @param options - Optional per-call extras: extra `headers`, a `timeout`
+   *   override, and an `AbortSignal`.
+   * @returns The attempts this caller may see, oldest first, each with its
+   *   settlement status.
+   * @throws If the payment does not exist (404), or the caller is a
+   *   profile-scoped (shop) role, who is refused rather than shown a redacted
+   *   body (403).
+   *
+   * @example
+   * ```typescript
+   * const { attempts } = await delopay.payments.settlement('pay_abc123');
+   * for (const attempt of attempts) {
+   *   if (attempt.status === 'paid_out') {
+   *     console.log(attempt.paid_out_at, attempt.payout_reference);
+   *   }
+   * }
+   * ```
+   */
+  async settlement(paymentId, options) {
+    return this.request("GET", `/payments/${encodeURIComponent(paymentId)}/settlement`, options);
+  }
   /**
    * Update an existing payment intent before it is confirmed.
    *
@@ -1923,7 +2046,10 @@ var Payments = class {
   /**
    * List payments by filter, scoped to the caller's profile (the shop-user
    * twin of `listByFilter`). The backend narrows to the profile from the
-   * auth context, so `profile_id` / `project_id` must not be sent.
+   * auth context, so `profile_id` / `project_id` must not be sent — and
+   * neither may `connector_settlement_status`, which this route refuses
+   * (403): a shop-scoped viewer is not shown the settlement state, and the
+   * type leaves the key out so it cannot be probed through `total_count`.
    *
    * Not to be confused with {@link Payments.listByProfile}, which is the GET
    * cursor variant and rejects this body.