@waffo/pancake-ts 0.20.0 → 0.22.0

package/dist/index.d.cts

@@ -351,10 +351,14 @@ interface NotificationSettings {
     emailSubscriptionRevoked: boolean;
     emailSubscriptionPastDue: boolean;
     emailTrialStarted: boolean;
+    /** Customer email sent before a paid trial ends — merchant-writable, per store */
     emailTrialEnding: boolean;
+    /** Customer email sent before a renewal is charged — merchant-writable, per store */
     emailUpcomingCharge: boolean;
     /** One toggle for all three plan-change customer emails (scheduled / failed / applied) */
     emailSubscriptionPlanChanged: boolean;
+    /** Customer email sent when a refund on their payment completes */
+    emailRefundSucceeded: boolean;
     notifyNewOrders: boolean;
     notifyNewSubscriptions: boolean;
     notifySubscriptionCanceled: boolean;
@@ -364,16 +368,29 @@ interface NotificationSettings {
     notifySubscriptionUncanceled: boolean;
     notifySubscriptionPlanChanged: boolean;
     notifyChargeback: boolean;
+    /** Merchant notification sent when a refund on a payment completes */
+    notifyRefundSucceeded: boolean;
 }
 /**
  * Merchant-writable subset of {@link NotificationSettings}.
  *
- * Consumer-email toggles (`email*`) are managed by the PANCAKE platform and **not**
- * writable from this SDK; they would be silently dropped by the `update-store`
- * endpoint if included. Payout result notifications are platform-managed and always
- * delivered — they have no toggle key. Use this type for any merchant-side update.
+ * Every `notify*` toggle, plus the two customer reminders a merchant may switch off:
+ * `emailUpcomingCharge` (renewal) and `emailTrialEnding` (trial ending). Switching
+ * either off silences it for every buyer of that store — `emailUpcomingCharge` for
+ * every billing period, yearly plans included, and `emailTrialEnding` for every paid
+ * trial. Both are decided per store; there is no per-recipient form of them.
+ *
+ * Every other consumer-email toggle (`email*`) is managed by the PANCAKE
+ * platform and **not** writable from this SDK; the `update-store` endpoint silently
+ * drops them and names them in the response's `warnings`. Payout result
+ * notifications are platform-managed and always delivered — they have no toggle
+ * key. Use this type for any merchant-side update.
+ *
+ * Passing `notificationSettings: null` to `update-store` clears every key in this
+ * type back to its default (on), both reminders included. Send a partial update
+ * carrying only the keys you want to change to keep a reminder switched off.
  */
-type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionPlanChanged" | "notifyChargeback">;
+type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionPlanChanged" | "notifyChargeback" | "notifyRefundSucceeded" | "emailUpcomingCharge" | "emailTrialEnding">;
 /**
  * Single-theme checkout page styling.
  * @see docs/api-reference/endpoints/stores/overview.mdx
@@ -444,7 +461,10 @@ interface UpdateStoreParams {
     status?: EntityStatus;
     /** Store logo URL (set to `null` to remove) */
     logo?: string | null;
-    /** Notification preferences (partial update — omitted fields keep existing values, set to `null` to clear all) */
+    /**
+     * Notification preferences (partial update — omitted fields keep existing values,
+     * set to `null` to clear all merchant-writable keys back to their default of on)
+     */
     notificationSettings?: Partial<MerchantWritableNotificationSettings> | null;
     /** Checkout page theme configuration (partial update — omitted fields keep existing values, set to `null` to clear all) */
     checkoutSettings?: Partial<CheckoutSettings> | null;
@@ -1115,6 +1135,8 @@ interface WebhookEventData {
     paymentFailureReason?: string;
     /** Payment date (ISO 8601 date, e.g., "2026-04-18") */
     paymentDate?: string;
+    /** Billing period this event refers to, as reported by the payment channel; see the webhook docs for the full semantics. */
+    periodNumber?: number;
     /** Billing period: "weekly", "monthly", "quarterly", "yearly" */
     billingPeriod?: string;
     /** Current billing period start date (ISO 8601, e.g., "2026-04-01") */
@@ -1889,6 +1911,12 @@ declare class StoresResource {
      * partial updates: omitted sub-fields keep existing values, `null` clears a
      * field. Pass the entire settings object as `null` to clear all fields.
      *
+     * `notificationSettings` accepts the merchant-writable keys only — every
+     * `notify*` toggle plus the two customer reminders `emailUpcomingCharge` and
+     * `emailTrialEnding`. Other `email*` keys are dropped and named in `warnings`.
+     * Passing `notificationSettings: null` clears the writable keys back to their
+     * default of on, so send a partial update to keep a reminder switched off.
+     *
      * **BREAKING (2026-05)**: the legacy `webhookSettings` parameter is removed.
      * Use `client.webhooks.add / update / remove` to manage webhook endpoints,
      * and query the configured webhook list via GraphQL `Store.storeWebhooks`.
@@ -1907,7 +1935,14 @@ declare class StoresResource {
      * // Toggle a notification preference
      * const { store } = await client.stores.update({
      *   id: "STO_xxx",
-     *   notificationSettings: { emailOrderConfirmation: false },
+     *   notificationSettings: { notifyNewOrders: false },
+     * });
+     *
+     * @example
+     * // Stop reminding this store's buyers that their trial is about to end
+     * const { store } = await client.stores.update({
+     *   id: "STO_xxx",
+     *   notificationSettings: { emailTrialEnding: false },
      * });
      */
     update(params: UpdateStoreParams): Promise<{

package/dist/index.d.ts

@@ -351,10 +351,14 @@ interface NotificationSettings {
     emailSubscriptionRevoked: boolean;
     emailSubscriptionPastDue: boolean;
     emailTrialStarted: boolean;
+    /** Customer email sent before a paid trial ends — merchant-writable, per store */
     emailTrialEnding: boolean;
+    /** Customer email sent before a renewal is charged — merchant-writable, per store */
     emailUpcomingCharge: boolean;
     /** One toggle for all three plan-change customer emails (scheduled / failed / applied) */
     emailSubscriptionPlanChanged: boolean;
+    /** Customer email sent when a refund on their payment completes */
+    emailRefundSucceeded: boolean;
     notifyNewOrders: boolean;
     notifyNewSubscriptions: boolean;
     notifySubscriptionCanceled: boolean;
@@ -364,16 +368,29 @@ interface NotificationSettings {
     notifySubscriptionUncanceled: boolean;
     notifySubscriptionPlanChanged: boolean;
     notifyChargeback: boolean;
+    /** Merchant notification sent when a refund on a payment completes */
+    notifyRefundSucceeded: boolean;
 }
 /**
  * Merchant-writable subset of {@link NotificationSettings}.
  *
- * Consumer-email toggles (`email*`) are managed by the PANCAKE platform and **not**
- * writable from this SDK; they would be silently dropped by the `update-store`
- * endpoint if included. Payout result notifications are platform-managed and always
- * delivered — they have no toggle key. Use this type for any merchant-side update.
+ * Every `notify*` toggle, plus the two customer reminders a merchant may switch off:
+ * `emailUpcomingCharge` (renewal) and `emailTrialEnding` (trial ending). Switching
+ * either off silences it for every buyer of that store — `emailUpcomingCharge` for
+ * every billing period, yearly plans included, and `emailTrialEnding` for every paid
+ * trial. Both are decided per store; there is no per-recipient form of them.
+ *
+ * Every other consumer-email toggle (`email*`) is managed by the PANCAKE
+ * platform and **not** writable from this SDK; the `update-store` endpoint silently
+ * drops them and names them in the response's `warnings`. Payout result
+ * notifications are platform-managed and always delivered — they have no toggle
+ * key. Use this type for any merchant-side update.
+ *
+ * Passing `notificationSettings: null` to `update-store` clears every key in this
+ * type back to its default (on), both reminders included. Send a partial update
+ * carrying only the keys you want to change to keep a reminder switched off.
  */
-type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionPlanChanged" | "notifyChargeback">;
+type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionPlanChanged" | "notifyChargeback" | "notifyRefundSucceeded" | "emailUpcomingCharge" | "emailTrialEnding">;
 /**
  * Single-theme checkout page styling.
  * @see docs/api-reference/endpoints/stores/overview.mdx
@@ -444,7 +461,10 @@ interface UpdateStoreParams {
     status?: EntityStatus;
     /** Store logo URL (set to `null` to remove) */
     logo?: string | null;
-    /** Notification preferences (partial update — omitted fields keep existing values, set to `null` to clear all) */
+    /**
+     * Notification preferences (partial update — omitted fields keep existing values,
+     * set to `null` to clear all merchant-writable keys back to their default of on)
+     */
     notificationSettings?: Partial<MerchantWritableNotificationSettings> | null;
     /** Checkout page theme configuration (partial update — omitted fields keep existing values, set to `null` to clear all) */
     checkoutSettings?: Partial<CheckoutSettings> | null;
@@ -1115,6 +1135,8 @@ interface WebhookEventData {
     paymentFailureReason?: string;
     /** Payment date (ISO 8601 date, e.g., "2026-04-18") */
     paymentDate?: string;
+    /** Billing period this event refers to, as reported by the payment channel; see the webhook docs for the full semantics. */
+    periodNumber?: number;
     /** Billing period: "weekly", "monthly", "quarterly", "yearly" */
     billingPeriod?: string;
     /** Current billing period start date (ISO 8601, e.g., "2026-04-01") */
@@ -1889,6 +1911,12 @@ declare class StoresResource {
      * partial updates: omitted sub-fields keep existing values, `null` clears a
      * field. Pass the entire settings object as `null` to clear all fields.
      *
+     * `notificationSettings` accepts the merchant-writable keys only — every
+     * `notify*` toggle plus the two customer reminders `emailUpcomingCharge` and
+     * `emailTrialEnding`. Other `email*` keys are dropped and named in `warnings`.
+     * Passing `notificationSettings: null` clears the writable keys back to their
+     * default of on, so send a partial update to keep a reminder switched off.
+     *
      * **BREAKING (2026-05)**: the legacy `webhookSettings` parameter is removed.
      * Use `client.webhooks.add / update / remove` to manage webhook endpoints,
      * and query the configured webhook list via GraphQL `Store.storeWebhooks`.
@@ -1907,7 +1935,14 @@ declare class StoresResource {
      * // Toggle a notification preference
      * const { store } = await client.stores.update({
      *   id: "STO_xxx",
-     *   notificationSettings: { emailOrderConfirmation: false },
+     *   notificationSettings: { notifyNewOrders: false },
+     * });
+     *
+     * @example
+     * // Stop reminding this store's buyers that their trial is about to end
+     * const { store } = await client.stores.update({
+     *   id: "STO_xxx",
+     *   notificationSettings: { emailTrialEnding: false },
      * });
      */
     update(params: UpdateStoreParams): Promise<{

package/dist/index.js

@@ -880,6 +880,12 @@ var StoresResource = class {
    * partial updates: omitted sub-fields keep existing values, `null` clears a
    * field. Pass the entire settings object as `null` to clear all fields.
    *
+   * `notificationSettings` accepts the merchant-writable keys only — every
+   * `notify*` toggle plus the two customer reminders `emailUpcomingCharge` and
+   * `emailTrialEnding`. Other `email*` keys are dropped and named in `warnings`.
+   * Passing `notificationSettings: null` clears the writable keys back to their
+   * default of on, so send a partial update to keep a reminder switched off.
+   *
    * **BREAKING (2026-05)**: the legacy `webhookSettings` parameter is removed.
    * Use `client.webhooks.add / update / remove` to manage webhook endpoints,
    * and query the configured webhook list via GraphQL `Store.storeWebhooks`.
@@ -898,7 +904,14 @@ var StoresResource = class {
    * // Toggle a notification preference
    * const { store } = await client.stores.update({
    *   id: "STO_xxx",
-   *   notificationSettings: { emailOrderConfirmation: false },
+   *   notificationSettings: { notifyNewOrders: false },
+   * });
+   *
+   * @example
+   * // Stop reminding this store's buyers that their trial is about to end
+   * const { store } = await client.stores.update({
+   *   id: "STO_xxx",
+   *   notificationSettings: { emailTrialEnding: false },
    * });
    */
   async update(params) {