@delopay/sdk 0.51.0 → 0.53.0

package/dist/index.d.cts

@@ -582,6 +582,17 @@ interface CustomerListParams {
     limit?: number | null;
     offset?: number | null;
     email?: string | null;
+    /**
+     * Filter customers by the shop (business profile) they have transacted in.
+     * Membership is derived from `payment_intent` — a customer who never
+     * transacted appears under no shop.
+     */
+    profile_id?: string | null;
+    /**
+     * Filter customers by project; expands to all shops (business profiles)
+     * under that project.
+     */
+    project_id?: string | null;
 }
 interface PaymentMethodCreateRequest {
     payment_method: PaymentMethod;
@@ -2910,18 +2921,47 @@ declare class Customers {
      */
     delete(customerId: string): Promise<CustomerResponse>;
     /**
-     * List customers, optionally filtered by email.
+     * List customers, optionally filtered by email, shop (`profile_id`), or
+     * project (`project_id`).
      *
      * @param params - Optional filter and pagination parameters.
      * @returns Array of customer objects.
+     *
+     * @example
+     * ```typescript
+     * // Customers who have transacted in a specific shop.
+     * const customers = await delopay.customers.list({ profile_id: 'pro_abc123' });
+     * ```
      */
     list(params?: CustomerListParams): Promise<CustomerResponse[]>;
-    /** List customers with count. `GET /customers/list-with-count` */
+    /**
+     * List customers with count. Supports the same `profile_id` / `project_id`
+     * shop filters as {@link list}. `GET /customers/list-with-count`
+     */
     listWithCount(params?: CustomerListParams): Promise<{
         count: number;
         total_count: number;
         data: CustomerResponse[];
     }>;
+    /**
+     * List customers scoped to the authenticated dashboard user's shop
+     * (business profile). The JWT auto-scopes to its own `profile`; an explicit
+     * `profile_id` / `project_id` outside that scope is rejected with
+     * `AccessForbidden`. `GET /customers/profile/list`
+     *
+     * @param params - Optional filter and pagination parameters.
+     * @returns Array of customer objects.
+     */
+    listByProfile(params?: CustomerListParams): Promise<CustomerResponse[]>;
+    /**
+     * Profile-scoped variant of {@link listWithCount}.
+     * `GET /customers/profile/list-with-count`
+     */
+    listByProfileWithCount(params?: CustomerListParams): Promise<{
+        count: number;
+        total_count: number;
+        data: CustomerResponse[];
+    }>;
     /** List mandates for a customer. `GET /customers/{customerId}/mandates` */
     listMandates(customerId: string): Promise<Record<string, unknown>[]>;
 }
@@ -4663,18 +4703,59 @@ declare class DelopayAuthenticationError extends DelopayError {
     });
 }
 
+/**
+ * The payload of a webhook event, tagged by kind.
+ *
+ * Mirrors the backend's `{ "type": …, "object": … }` envelope: `type` names the
+ * payload shape and `object` carries it. Narrow on `content.type` to get a
+ * fully-typed `object`:
+ *
+ * ```typescript
+ * if (event.content.type === 'payment_details') {
+ *   event.content.object.payment_id; // typed as PaymentResponse
+ * }
+ * ```
+ */
+type WebhookContent = {
+    type: 'payment_details';
+    object: PaymentResponse;
+} | {
+    type: 'refund_details';
+    object: RefundResponse;
+} | {
+    type: 'dispute_details';
+    object: DisputeResponse;
+} | {
+    type: 'mandate_details';
+    object: MandateResponse;
+} | {
+    type: 'payout_details';
+    object: PayoutResponse;
+} | {
+    type: 'subscription_details';
+    object: ConfirmSubscriptionResponse;
+};
 /**
  * A parsed and verified Delopay webhook event.
  *
- * The `type` field identifies the event (e.g. `'payment_succeeded'`).
- * Specific event payload shapes are nested under `data`.
+ * Matches the signed wire body exactly:
+ * `{ merchant_id, event_id, event_type, content: { type, object }, timestamp }`.
+ *
+ * - `event_type` identifies the event, e.g. `'payment_succeeded'`.
+ * - `content.type` tags the payload kind, e.g. `'payment_details'`.
+ * - `content.object` is the payload; narrow on `content.type` to type it.
  */
 interface WebhookEvent {
+    /** ID of the merchant that owns this event. */
+    merchant_id: string;
+    /** Unique ID for this event (stable across delivery retries). */
+    event_id: string;
     /** Event type identifier, e.g. `'payment_succeeded'` or `'refund_succeeded'`. */
-    type: string;
-    /** Event payload. Shape depends on `type`. */
-    data: Record<string, unknown>;
-    [key: string]: unknown;
+    event_type: EventType;
+    /** The event payload, tagged by kind. Narrow on `content.type` to type `object`. */
+    content: WebhookContent;
+    /** ISO 8601 timestamp at which the webhook was sent. */
+    timestamp: string;
 }
 declare const Webhooks: {
     /**
@@ -4709,7 +4790,7 @@ declare const Webhooks: {
      *       req.header('x-webhook-signature-512') ?? '',
      *       process.env.DELOPAY_WEBHOOK_SECRET!,
      *     );
-     *     console.log(event.type, event.data);
+     *     console.log(event.event_type, event.content.object);
      *     res.sendStatus(200);
      *   } catch {
      *     res.status(400).send('Invalid signature');

package/dist/index.d.ts

@@ -582,6 +582,17 @@ interface CustomerListParams {
     limit?: number | null;
     offset?: number | null;
     email?: string | null;
+    /**
+     * Filter customers by the shop (business profile) they have transacted in.
+     * Membership is derived from `payment_intent` — a customer who never
+     * transacted appears under no shop.
+     */
+    profile_id?: string | null;
+    /**
+     * Filter customers by project; expands to all shops (business profiles)
+     * under that project.
+     */
+    project_id?: string | null;
 }
 interface PaymentMethodCreateRequest {
     payment_method: PaymentMethod;
@@ -2910,18 +2921,47 @@ declare class Customers {
      */
     delete(customerId: string): Promise<CustomerResponse>;
     /**
-     * List customers, optionally filtered by email.
+     * List customers, optionally filtered by email, shop (`profile_id`), or
+     * project (`project_id`).
      *
      * @param params - Optional filter and pagination parameters.
      * @returns Array of customer objects.
+     *
+     * @example
+     * ```typescript
+     * // Customers who have transacted in a specific shop.
+     * const customers = await delopay.customers.list({ profile_id: 'pro_abc123' });
+     * ```
      */
     list(params?: CustomerListParams): Promise<CustomerResponse[]>;
-    /** List customers with count. `GET /customers/list-with-count` */
+    /**
+     * List customers with count. Supports the same `profile_id` / `project_id`
+     * shop filters as {@link list}. `GET /customers/list-with-count`
+     */
     listWithCount(params?: CustomerListParams): Promise<{
         count: number;
         total_count: number;
         data: CustomerResponse[];
     }>;
+    /**
+     * List customers scoped to the authenticated dashboard user's shop
+     * (business profile). The JWT auto-scopes to its own `profile`; an explicit
+     * `profile_id` / `project_id` outside that scope is rejected with
+     * `AccessForbidden`. `GET /customers/profile/list`
+     *
+     * @param params - Optional filter and pagination parameters.
+     * @returns Array of customer objects.
+     */
+    listByProfile(params?: CustomerListParams): Promise<CustomerResponse[]>;
+    /**
+     * Profile-scoped variant of {@link listWithCount}.
+     * `GET /customers/profile/list-with-count`
+     */
+    listByProfileWithCount(params?: CustomerListParams): Promise<{
+        count: number;
+        total_count: number;
+        data: CustomerResponse[];
+    }>;
     /** List mandates for a customer. `GET /customers/{customerId}/mandates` */
     listMandates(customerId: string): Promise<Record<string, unknown>[]>;
 }
@@ -4663,18 +4703,59 @@ declare class DelopayAuthenticationError extends DelopayError {
     });
 }
 
+/**
+ * The payload of a webhook event, tagged by kind.
+ *
+ * Mirrors the backend's `{ "type": …, "object": … }` envelope: `type` names the
+ * payload shape and `object` carries it. Narrow on `content.type` to get a
+ * fully-typed `object`:
+ *
+ * ```typescript
+ * if (event.content.type === 'payment_details') {
+ *   event.content.object.payment_id; // typed as PaymentResponse
+ * }
+ * ```
+ */
+type WebhookContent = {
+    type: 'payment_details';
+    object: PaymentResponse;
+} | {
+    type: 'refund_details';
+    object: RefundResponse;
+} | {
+    type: 'dispute_details';
+    object: DisputeResponse;
+} | {
+    type: 'mandate_details';
+    object: MandateResponse;
+} | {
+    type: 'payout_details';
+    object: PayoutResponse;
+} | {
+    type: 'subscription_details';
+    object: ConfirmSubscriptionResponse;
+};
 /**
  * A parsed and verified Delopay webhook event.
  *
- * The `type` field identifies the event (e.g. `'payment_succeeded'`).
- * Specific event payload shapes are nested under `data`.
+ * Matches the signed wire body exactly:
+ * `{ merchant_id, event_id, event_type, content: { type, object }, timestamp }`.
+ *
+ * - `event_type` identifies the event, e.g. `'payment_succeeded'`.
+ * - `content.type` tags the payload kind, e.g. `'payment_details'`.
+ * - `content.object` is the payload; narrow on `content.type` to type it.
  */
 interface WebhookEvent {
+    /** ID of the merchant that owns this event. */
+    merchant_id: string;
+    /** Unique ID for this event (stable across delivery retries). */
+    event_id: string;
     /** Event type identifier, e.g. `'payment_succeeded'` or `'refund_succeeded'`. */
-    type: string;
-    /** Event payload. Shape depends on `type`. */
-    data: Record<string, unknown>;
-    [key: string]: unknown;
+    event_type: EventType;
+    /** The event payload, tagged by kind. Narrow on `content.type` to type `object`. */
+    content: WebhookContent;
+    /** ISO 8601 timestamp at which the webhook was sent. */
+    timestamp: string;
 }
 declare const Webhooks: {
     /**
@@ -4709,7 +4790,7 @@ declare const Webhooks: {
      *       req.header('x-webhook-signature-512') ?? '',
      *       process.env.DELOPAY_WEBHOOK_SECRET!,
      *     );
-     *     console.log(event.type, event.data);
+     *     console.log(event.event_type, event.content.object);
      *     res.sendStatus(200);
      *   } catch {
      *     res.status(400).send('Invalid signature');

package/dist/index.js

@@ -49,7 +49,7 @@ import {
   shadowFor,
   surfacePadValue,
   verticalGapValue
-} from "./chunk-P45MMRTD.js";
+} from "./chunk-QH5ESES3.js";
 export {
   Analytics,
   AnalyticsDashboard,

package/dist/internal.cjs

@@ -537,10 +537,17 @@ var Customers = class {
     return this.request("DELETE", `/customers/${encodeURIComponent(customerId)}`);
   }
   /**
-   * List customers, optionally filtered by email.
+   * List customers, optionally filtered by email, shop (`profile_id`), or
+   * project (`project_id`).
    *
    * @param params - Optional filter and pagination parameters.
    * @returns Array of customer objects.
+   *
+   * @example
+   * ```typescript
+   * // Customers who have transacted in a specific shop.
+   * const customers = await delopay.customers.list({ profile_id: 'pro_abc123' });
+   * ```
    */
   async list(params) {
     return this.request("GET", "/customers/list", {
@@ -548,12 +555,38 @@ var Customers = class {
     });
   }
   // --- OLAP extensions (Task 4.6) ---
-  /** List customers with count. `GET /customers/list-with-count` */
+  /**
+   * List customers with count. Supports the same `profile_id` / `project_id`
+   * shop filters as {@link list}. `GET /customers/list-with-count`
+   */
   async listWithCount(params) {
     return this.request("GET", "/customers/list-with-count", {
       query: params
     });
   }
+  /**
+   * List customers scoped to the authenticated dashboard user's shop
+   * (business profile). The JWT auto-scopes to its own `profile`; an explicit
+   * `profile_id` / `project_id` outside that scope is rejected with
+   * `AccessForbidden`. `GET /customers/profile/list`
+   *
+   * @param params - Optional filter and pagination parameters.
+   * @returns Array of customer objects.
+   */
+  async listByProfile(params) {
+    return this.request("GET", "/customers/profile/list", {
+      query: params
+    });
+  }
+  /**
+   * Profile-scoped variant of {@link listWithCount}.
+   * `GET /customers/profile/list-with-count`
+   */
+  async listByProfileWithCount(params) {
+    return this.request("GET", "/customers/profile/list-with-count", {
+      query: params
+    });
+  }
   /** List mandates for a customer. `GET /customers/{customerId}/mandates` */
   async listMandates(customerId) {
     return this.request("GET", `/customers/${encodeURIComponent(customerId)}/mandates`);
@@ -1172,11 +1205,7 @@ var Payments = class {
    * ```
    */
   async listAttempts(paymentId, options) {
-    return this.request(
-      "GET",
-      `/payments/${encodeURIComponent(paymentId)}/attempts`,
-      options
-    );
+    return this.request("GET", `/payments/${encodeURIComponent(paymentId)}/attempts`, options);
   }
   /**
    * Update an existing payment intent before it is confirmed.
@@ -2521,7 +2550,7 @@ var Webhooks = {
    *       req.header('x-webhook-signature-512') ?? '',
    *       process.env.DELOPAY_WEBHOOK_SECRET!,
    *     );
-   *     console.log(event.type, event.data);
+   *     console.log(event.event_type, event.content.object);
    *     res.sendStatus(200);
    *   } catch {
    *     res.status(400).send('Invalid signature');