@proveanything/smartlinks 1.13.17 → 1.13.18
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/dist/docs/API_SUMMARY.md +2 -1
- package/dist/docs/auth-kit.md +6 -1
- package/dist/openapi.yaml +2 -0
- package/dist/types/authKit.d.ts +1 -0
- package/docs/API_SUMMARY.md +2 -1
- package/docs/auth-kit.md +6 -1
- package/openapi.yaml +2 -0
- package/package.json +1 -1
package/dist/docs/API_SUMMARY.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Smartlinks API Summary
|
|
2
2
|
|
|
3
|
-
Version: 1.13.
|
|
3
|
+
Version: 1.13.18 | Generated: 2026-05-15T21:59:57.655Z
|
|
4
4
|
|
|
5
5
|
This is a concise summary of all available API functions and types.
|
|
6
6
|
|
|
@@ -3030,6 +3030,7 @@ interface WhatsAppReplyCta {
|
|
|
3030
3030
|
body: string
|
|
3031
3031
|
buttonLabel: string
|
|
3032
3032
|
buttonUrl: string
|
|
3033
|
+
mediaUrl?: string // optional image (JPEG/PNG, public https) — selects image card template
|
|
3033
3034
|
}
|
|
3034
3035
|
```
|
|
3035
3036
|
|
package/dist/docs/auth-kit.md
CHANGED
|
@@ -105,6 +105,7 @@ const wa = await authKit.sendWhatsApp(clientId);
|
|
|
105
105
|
// body: "You're verified and ready to bid.",
|
|
106
106
|
// buttonLabel: 'Back to Auction',
|
|
107
107
|
// buttonUrl: '{{returnUrl}}',
|
|
108
|
+
// // mediaUrl: 'https://cdn.example.com/bid-confirmed.jpg', // optional: include to use image card template
|
|
108
109
|
// },
|
|
109
110
|
// text: "You're verified. Return to the app to continue.",
|
|
110
111
|
// },
|
|
@@ -170,11 +171,15 @@ Verification status values returned by `authKit.getWhatsAppStatus` are:
|
|
|
170
171
|
Pass a `reply` object in `sendWhatsApp` to send a message back to the user after they confirm `CONFIRM <token>`. Reply resolution order:
|
|
171
172
|
|
|
172
173
|
1. `reply.contentSid` — explicit Twilio Content SID
|
|
173
|
-
2. `reply.cta` — CTA shorthand
|
|
174
|
+
2. `reply.cta` — CTA shorthand:
|
|
175
|
+
- If `cta.mediaUrl` is present (valid public `https://` URL), uses the **image card** Twilio Content template (`TWILIO_WHATSAPP_IMAGE_CTA_SID`)
|
|
176
|
+
- Otherwise uses the **text CTA** template (`TWILIO_WHATSAPP_GENERIC_CTA_SID`)
|
|
174
177
|
3. `reply.text` — plain-text fallback
|
|
175
178
|
4. Per-client default (`authKit/{clientId}.whatsapp` config)
|
|
176
179
|
5. Built-in default text
|
|
177
180
|
|
|
181
|
+
> **Important:** Only pass `mediaUrl` when you have a valid, publicly reachable `https://` JPEG or PNG. If the field is absent or blank, the text-only CTA template is selected automatically. Never pass an empty string — omit the field entirely to avoid Twilio rejecting the send.
|
|
182
|
+
|
|
178
183
|
The following template placeholders are available in `reply.text`, `reply.cta` fields, and `reply.contentVariables` values:
|
|
179
184
|
|
|
180
185
|
| Placeholder | Description |
|
package/dist/openapi.yaml
CHANGED
|
@@ -17906,6 +17906,8 @@ components:
|
|
|
17906
17906
|
type: string
|
|
17907
17907
|
buttonUrl:
|
|
17908
17908
|
type: string
|
|
17909
|
+
mediaUrl:
|
|
17910
|
+
type: string
|
|
17909
17911
|
required:
|
|
17910
17912
|
- body
|
|
17911
17913
|
- buttonLabel
|
package/dist/types/authKit.d.ts
CHANGED
package/docs/API_SUMMARY.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Smartlinks API Summary
|
|
2
2
|
|
|
3
|
-
Version: 1.13.
|
|
3
|
+
Version: 1.13.18 | Generated: 2026-05-15T21:59:57.655Z
|
|
4
4
|
|
|
5
5
|
This is a concise summary of all available API functions and types.
|
|
6
6
|
|
|
@@ -3030,6 +3030,7 @@ interface WhatsAppReplyCta {
|
|
|
3030
3030
|
body: string
|
|
3031
3031
|
buttonLabel: string
|
|
3032
3032
|
buttonUrl: string
|
|
3033
|
+
mediaUrl?: string // optional image (JPEG/PNG, public https) — selects image card template
|
|
3033
3034
|
}
|
|
3034
3035
|
```
|
|
3035
3036
|
|
package/docs/auth-kit.md
CHANGED
|
@@ -105,6 +105,7 @@ const wa = await authKit.sendWhatsApp(clientId);
|
|
|
105
105
|
// body: "You're verified and ready to bid.",
|
|
106
106
|
// buttonLabel: 'Back to Auction',
|
|
107
107
|
// buttonUrl: '{{returnUrl}}',
|
|
108
|
+
// // mediaUrl: 'https://cdn.example.com/bid-confirmed.jpg', // optional: include to use image card template
|
|
108
109
|
// },
|
|
109
110
|
// text: "You're verified. Return to the app to continue.",
|
|
110
111
|
// },
|
|
@@ -170,11 +171,15 @@ Verification status values returned by `authKit.getWhatsAppStatus` are:
|
|
|
170
171
|
Pass a `reply` object in `sendWhatsApp` to send a message back to the user after they confirm `CONFIRM <token>`. Reply resolution order:
|
|
171
172
|
|
|
172
173
|
1. `reply.contentSid` — explicit Twilio Content SID
|
|
173
|
-
2. `reply.cta` — CTA shorthand
|
|
174
|
+
2. `reply.cta` — CTA shorthand:
|
|
175
|
+
- If `cta.mediaUrl` is present (valid public `https://` URL), uses the **image card** Twilio Content template (`TWILIO_WHATSAPP_IMAGE_CTA_SID`)
|
|
176
|
+
- Otherwise uses the **text CTA** template (`TWILIO_WHATSAPP_GENERIC_CTA_SID`)
|
|
174
177
|
3. `reply.text` — plain-text fallback
|
|
175
178
|
4. Per-client default (`authKit/{clientId}.whatsapp` config)
|
|
176
179
|
5. Built-in default text
|
|
177
180
|
|
|
181
|
+
> **Important:** Only pass `mediaUrl` when you have a valid, publicly reachable `https://` JPEG or PNG. If the field is absent or blank, the text-only CTA template is selected automatically. Never pass an empty string — omit the field entirely to avoid Twilio rejecting the send.
|
|
182
|
+
|
|
178
183
|
The following template placeholders are available in `reply.text`, `reply.cta` fields, and `reply.contentVariables` values:
|
|
179
184
|
|
|
180
185
|
| Placeholder | Description |
|
package/openapi.yaml
CHANGED
|
@@ -17906,6 +17906,8 @@ components:
|
|
|
17906
17906
|
type: string
|
|
17907
17907
|
buttonUrl:
|
|
17908
17908
|
type: string
|
|
17909
|
+
mediaUrl:
|
|
17910
|
+
type: string
|
|
17909
17911
|
required:
|
|
17910
17912
|
- body
|
|
17911
17913
|
- buttonLabel
|