@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/docs/api-reference.md
CHANGED
|
@@ -82,14 +82,11 @@ 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 one consumer email a merchant may switch off. The other `email*`
|
|
88
|
+
// toggles are platform-managed and dropped with a warning if passed.
|
|
89
|
+
emailUpcomingCharge: false,
|
|
93
90
|
},
|
|
94
91
|
checkoutSettings: {
|
|
95
92
|
light: {
|
|
@@ -114,17 +111,17 @@ const { store } = await client.stores.update({
|
|
|
114
111
|
|
|
115
112
|
**Parameters `UpdateStoreParams`**:
|
|
116
113
|
|
|
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`
|
|
114
|
+
| Field | Type | Required | Description |
|
|
115
|
+
| ---------------------- | ------------------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
116
|
+
| `id` | `string` | Yes | Store ID |
|
|
117
|
+
| `name` | `string` | No | Store name (1–100 characters) |
|
|
118
|
+
| `status` | `EntityStatus` | No | Store status |
|
|
119
|
+
| `logo` | `string \| null` | No | Logo (Base64 encoded image) |
|
|
120
|
+
| `supportEmail` | `string \| null` | No | Support email address |
|
|
121
|
+
| `website` | `string \| null` | No | Store website URL |
|
|
122
|
+
| `webhookSettings` | `WebhookSettings \| null` | No | Webhook endpoint configuration (test/prod URLs and subscribed event types) |
|
|
123
|
+
| `notificationSettings` | `Partial<MerchantWritableNotificationSettings> \| null` | No | Notification preferences: every `notify*` toggle plus `emailUpcomingCharge`. The other `email*` toggles are platform-managed and dropped with a `warnings` entry |
|
|
124
|
+
| `checkoutSettings` | `CheckoutSettings \| null` | No | Checkout page theme (light/dark) |
|
|
128
125
|
|
|
129
126
|
**Returns `{ store: Store }`**
|
|
130
127
|
|
|
@@ -861,7 +858,7 @@ All exported type interfaces:
|
|
|
861
858
|
| `UpdateStoreParams` | Update store request |
|
|
862
859
|
| `DeleteStoreParams` | Delete store request |
|
|
863
860
|
| `WebhookSettings` | Webhook endpoint configuration (test/prod) |
|
|
864
|
-
| `NotificationSettings` |
|
|
861
|
+
| `NotificationSettings` | 21 notification toggles (10 `notify*` + 11 `email*`) |
|
|
865
862
|
| `CheckoutSettings` | Checkout page theme (light/dark) |
|
|
866
863
|
| `CheckoutThemeSettings` | Single-theme checkout styling |
|
|
867
864
|
| **Store Merchant** | |
|
package/package.json
CHANGED