@waffo/pancake-ts 0.21.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 +9 -4
- package/dist/index.cjs +14 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +32 -6
- package/dist/index.d.ts +32 -6
- package/dist/index.js +14 -1
- package/dist/index.js.map +1 -1
- package/docs/api-reference.md +15 -13
- package/package.json +1 -1
package/docs/api-reference.md
CHANGED
|
@@ -84,9 +84,11 @@ const { store } = await client.stores.update({
|
|
|
84
84
|
notificationSettings: {
|
|
85
85
|
notifyNewOrders: true,
|
|
86
86
|
notifyNewSubscriptions: true,
|
|
87
|
-
// The
|
|
88
|
-
// toggles are platform-managed and dropped with a warning
|
|
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.
|
|
89
90
|
emailUpcomingCharge: false,
|
|
91
|
+
emailTrialEnding: false,
|
|
90
92
|
},
|
|
91
93
|
checkoutSettings: {
|
|
92
94
|
light: {
|
|
@@ -111,17 +113,17 @@ const { store } = await client.stores.update({
|
|
|
111
113
|
|
|
112
114
|
**Parameters `UpdateStoreParams`**:
|
|
113
115
|
|
|
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)
|
|
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) |
|
|
125
127
|
|
|
126
128
|
**Returns `{ store: Store }`**
|
|
127
129
|
|
package/package.json
CHANGED