@waffo/pancake-ts 0.20.0 → 0.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +14 -5
- package/dist/index.d.ts +14 -5
- package/dist/index.js.map +1 -1
- package/docs/api-reference.md +15 -18
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -355,6 +355,8 @@ interface NotificationSettings {
|
|
|
355
355
|
emailUpcomingCharge: boolean;
|
|
356
356
|
/** One toggle for all three plan-change customer emails (scheduled / failed / applied) */
|
|
357
357
|
emailSubscriptionPlanChanged: boolean;
|
|
358
|
+
/** Customer email sent when a refund on their payment completes */
|
|
359
|
+
emailRefundSucceeded: boolean;
|
|
358
360
|
notifyNewOrders: boolean;
|
|
359
361
|
notifyNewSubscriptions: boolean;
|
|
360
362
|
notifySubscriptionCanceled: boolean;
|
|
@@ -364,16 +366,23 @@ interface NotificationSettings {
|
|
|
364
366
|
notifySubscriptionUncanceled: boolean;
|
|
365
367
|
notifySubscriptionPlanChanged: boolean;
|
|
366
368
|
notifyChargeback: boolean;
|
|
369
|
+
/** Merchant notification sent when a refund on a payment completes */
|
|
370
|
+
notifyRefundSucceeded: boolean;
|
|
367
371
|
}
|
|
368
372
|
/**
|
|
369
373
|
* Merchant-writable subset of {@link NotificationSettings}.
|
|
370
374
|
*
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
+
* Every `notify*` toggle, plus `emailUpcomingCharge` — the renewal reminder is the
|
|
376
|
+
* one consumer email a merchant may switch off, and switching it off silences it
|
|
377
|
+
* for every billing period in that store, yearly plans included.
|
|
378
|
+
*
|
|
379
|
+
* Every other consumer-email toggle (`email*`) is managed by the PANCAKE
|
|
380
|
+
* platform and **not** writable from this SDK; the `update-store` endpoint silently
|
|
381
|
+
* drops them and names them in the response's `warnings`. Payout result
|
|
382
|
+
* notifications are platform-managed and always delivered — they have no toggle
|
|
383
|
+
* key. Use this type for any merchant-side update.
|
|
375
384
|
*/
|
|
376
|
-
type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionPlanChanged" | "notifyChargeback">;
|
|
385
|
+
type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionPlanChanged" | "notifyChargeback" | "notifyRefundSucceeded" | "emailUpcomingCharge">;
|
|
377
386
|
/**
|
|
378
387
|
* Single-theme checkout page styling.
|
|
379
388
|
* @see docs/api-reference/endpoints/stores/overview.mdx
|
package/dist/index.d.ts
CHANGED
|
@@ -355,6 +355,8 @@ interface NotificationSettings {
|
|
|
355
355
|
emailUpcomingCharge: boolean;
|
|
356
356
|
/** One toggle for all three plan-change customer emails (scheduled / failed / applied) */
|
|
357
357
|
emailSubscriptionPlanChanged: boolean;
|
|
358
|
+
/** Customer email sent when a refund on their payment completes */
|
|
359
|
+
emailRefundSucceeded: boolean;
|
|
358
360
|
notifyNewOrders: boolean;
|
|
359
361
|
notifyNewSubscriptions: boolean;
|
|
360
362
|
notifySubscriptionCanceled: boolean;
|
|
@@ -364,16 +366,23 @@ interface NotificationSettings {
|
|
|
364
366
|
notifySubscriptionUncanceled: boolean;
|
|
365
367
|
notifySubscriptionPlanChanged: boolean;
|
|
366
368
|
notifyChargeback: boolean;
|
|
369
|
+
/** Merchant notification sent when a refund on a payment completes */
|
|
370
|
+
notifyRefundSucceeded: boolean;
|
|
367
371
|
}
|
|
368
372
|
/**
|
|
369
373
|
* Merchant-writable subset of {@link NotificationSettings}.
|
|
370
374
|
*
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
+
* Every `notify*` toggle, plus `emailUpcomingCharge` — the renewal reminder is the
|
|
376
|
+
* one consumer email a merchant may switch off, and switching it off silences it
|
|
377
|
+
* for every billing period in that store, yearly plans included.
|
|
378
|
+
*
|
|
379
|
+
* Every other consumer-email toggle (`email*`) is managed by the PANCAKE
|
|
380
|
+
* platform and **not** writable from this SDK; the `update-store` endpoint silently
|
|
381
|
+
* drops them and names them in the response's `warnings`. Payout result
|
|
382
|
+
* notifications are platform-managed and always delivered — they have no toggle
|
|
383
|
+
* key. Use this type for any merchant-side update.
|
|
375
384
|
*/
|
|
376
|
-
type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionPlanChanged" | "notifyChargeback">;
|
|
385
|
+
type MerchantWritableNotificationSettings = Pick<NotificationSettings, "notifyNewOrders" | "notifyNewSubscriptions" | "notifySubscriptionCanceled" | "notifySubscriptionEnded" | "notifySubscriptionPastDue" | "notifySubscriptionRenewed" | "notifySubscriptionUncanceled" | "notifySubscriptionPlanChanged" | "notifyChargeback" | "notifyRefundSucceeded" | "emailUpcomingCharge">;
|
|
377
386
|
/**
|
|
378
387
|
* Single-theme checkout page styling.
|
|
379
388
|
* @see docs/api-reference/endpoints/stores/overview.mdx
|