@waffo/pancake-ts 0.20.0 → 0.22.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/CHANGELOG.md +13 -0
- package/README.md +14 -4
- package/dist/index.cjs +14 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +42 -7
- package/dist/index.d.ts +42 -7
- package/dist/index.js +14 -1
- package/dist/index.js.map +1 -1
- package/docs/api-reference.md +17 -18
- package/package.json +1 -1
package/docs/api-reference.md
CHANGED
|
@@ -82,14 +82,13 @@ const { store } = await client.stores.update({
|
|
|
82
82
|
prodEvents: [],
|
|
83
83
|
},
|
|
84
84
|
notificationSettings: {
|
|
85
|
-
emailOrderConfirmation: true,
|
|
86
|
-
emailSubscriptionConfirmation: true,
|
|
87
|
-
emailSubscriptionCycled: true,
|
|
88
|
-
emailSubscriptionCanceled: true,
|
|
89
|
-
emailSubscriptionRevoked: true,
|
|
90
|
-
emailSubscriptionPastDue: true,
|
|
91
85
|
notifyNewOrders: true,
|
|
92
86
|
notifyNewSubscriptions: true,
|
|
87
|
+
// The two consumer emails a merchant may switch off, both per store. The
|
|
88
|
+
// other `email*` toggles are platform-managed and dropped with a warning
|
|
89
|
+
// if passed.
|
|
90
|
+
emailUpcomingCharge: false,
|
|
91
|
+
emailTrialEnding: false,
|
|
93
92
|
},
|
|
94
93
|
checkoutSettings: {
|
|
95
94
|
light: {
|
|
@@ -114,17 +113,17 @@ const { store } = await client.stores.update({
|
|
|
114
113
|
|
|
115
114
|
**Parameters `UpdateStoreParams`**:
|
|
116
115
|
|
|
117
|
-
| Field | Type
|
|
118
|
-
| ---------------------- |
|
|
119
|
-
| `id` | `string`
|
|
120
|
-
| `name` | `string`
|
|
121
|
-
| `status` | `EntityStatus`
|
|
122
|
-
| `logo` | `string \| null`
|
|
123
|
-
| `supportEmail` | `string \| null`
|
|
124
|
-
| `website` | `string \| null`
|
|
125
|
-
| `webhookSettings` | `WebhookSettings \| null`
|
|
126
|
-
| `notificationSettings` | `
|
|
127
|
-
| `checkoutSettings` | `CheckoutSettings \| null`
|
|
116
|
+
| Field | Type | Required | Description |
|
|
117
|
+
| ---------------------- | ------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
118
|
+
| `id` | `string` | Yes | Store ID |
|
|
119
|
+
| `name` | `string` | No | Store name (1–100 characters) |
|
|
120
|
+
| `status` | `EntityStatus` | No | Store status |
|
|
121
|
+
| `logo` | `string \| null` | No | Logo (Base64 encoded image) |
|
|
122
|
+
| `supportEmail` | `string \| null` | No | Support email address |
|
|
123
|
+
| `website` | `string \| null` | No | Store website URL |
|
|
124
|
+
| `webhookSettings` | `WebhookSettings \| null` | No | Webhook endpoint configuration (test/prod URLs and subscribed event types) |
|
|
125
|
+
| `notificationSettings` | `Partial<MerchantWritableNotificationSettings> \| null` | No | Notification preferences: every `notify*` toggle plus the two customer reminders `emailUpcomingCharge` and `emailTrialEnding`. The other `email*` toggles are platform-managed and dropped with a `warnings` entry. Passing `null` clears the writable keys back to their default of on |
|
|
126
|
+
| `checkoutSettings` | `CheckoutSettings \| null` | No | Checkout page theme (light/dark) |
|
|
128
127
|
|
|
129
128
|
**Returns `{ store: Store }`**
|
|
130
129
|
|
|
@@ -861,7 +860,7 @@ All exported type interfaces:
|
|
|
861
860
|
| `UpdateStoreParams` | Update store request |
|
|
862
861
|
| `DeleteStoreParams` | Delete store request |
|
|
863
862
|
| `WebhookSettings` | Webhook endpoint configuration (test/prod) |
|
|
864
|
-
| `NotificationSettings` |
|
|
863
|
+
| `NotificationSettings` | 21 notification toggles (10 `notify*` + 11 `email*`) |
|
|
865
864
|
| `CheckoutSettings` | Checkout page theme (light/dark) |
|
|
866
865
|
| `CheckoutThemeSettings` | Single-theme checkout styling |
|
|
867
866
|
| **Store Merchant** | |
|
package/package.json
CHANGED