@bradgarropy/captivate-sdk
Advanced tools
Captivate JavaScript SDK for retrieving podcast information.
This package is hosted on npm.
npm install @bradgarropy/captivate-sdk
Start off by creating a Captivate client, then authenticate to the Captivate API. Now you can use the client to retrieve your podcast shows and episodes.
const captivate = new Captivate("abc123", "123456789")
const show = await captivate.shows.getShow("abc123")
const episode = await captivate.episodes.getEpisode("xyz123")
Captivate(userId, apiKey)| Name | Type | Example | Description |
|---|---|---|---|
userId | string | "abc123" | Captivate user id. |
apiKey | string | "123456789" | Captivate api key. |
Create a Captivate client.
const captivate = new Captivate("abc123", "123456789")
captivate.authentication.authenticateUser()Authenticate a user to the Captivate API.
captivate.authentication.authenticateUser()
captivate.users.getUser(userId)| Name | Type | Example | Description |
|---|---|---|---|
userId | string | "abc123" | User id. |
Get a user.
captivate.users.getUser("abc123")
captivate.users.getUsersShows(userId)| Name | Type | Example | Description |
|---|---|---|---|
userId | string | "abc123" | User id. |
Get a list of podcasts that a user belongs to.
captivate.users.getUsersShows("abc123")
captivate.users.getUsersManagedShows(userId)| Name | Type | Example | Description |
|---|---|---|---|
userId | string | "abc123" | User id. |
Get a list of podcasts that a user manages.
captivate.users.getUsersManagedShows("abc123")
captivate.shows.getShow(showId)| Name | Type | Example | Description |
|---|---|---|---|
showId | string | "abc123" | Podcast show id. |
Get a podcast.
captivate.shows.getShow("abc123")
captivate.shows.updateShow()// TODO
captivate.shows.updateShowArtwork()// TODO
captivate.shows.getShowEpisodes(showId)| Name | Type | Example | Description |
|---|---|---|---|
showId | string | "abc123" | Podcast show id. |
Get all episodes from a podcast.
captivate.shows.getShowEpisodes("abc123")
captivate.shows.getShowScheduledEpisodes()// TODO
captivate.shows.getShowFeedUrl()// TODO
captivate.media.getMedia()// TODO
captivate.media.uploadMedia()// TODO
captivate.media.getShowMedia()// TODO
captivate.media.searchShowMedia()// TODO
captivate.episodes.getEpisode(episodeId)| Name | Type | Example | Description |
|---|---|---|---|
episodeId | string | "xyz123" | Podcast episode id. |
Get a podcast episode.
captivate.episodes.getEpisode("xyz123")
captivate.episodes.createEpisode()// TODO
captivate.episodes.updateEpisode()// TODO
🐛 report bugs by filing issues
📢 provide feedback with issues or on twitter
🙋🏼♂️ use my ama or twitter to ask any other questions
 Brad Garropy 💻 📖 ⚠️ 🚇 |
FAQs
🎤 captivate sdk
The npm package @bradgarropy/captivate-sdk receives a total of 0 weekly downloads. As such, @bradgarropy/captivate-sdk popularity was classified as not popular.
We found that @bradgarropy/captivate-sdk demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.