podcast_api 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 789c1376da5ce7453407f4894afda038d8af4b19f7b0a3e68cc763517db0199a
-  data.tar.gz: 9d645745c9b9f5dc595ed1dba86ccbe2befab356bc09c6f857b5289ff2218566
+  metadata.gz: a2c89e8fa63772c37d9acb31bfa776e209dba6378b95be19f0ff0973c49a320a
+  data.tar.gz: 65bda14d6a80ce94f6c6f1339e8c25f64a17f9cf3d443755995b98f290412753
 SHA512:
-  metadata.gz: 9f23d589831e74d64a8176292734c66bd21e4c743a5465b0f11780d782a9ddc6d7dab9cc95d6b75a8aea743be1c1fb00740b194177997aced5ad9743aff7666c
-  data.tar.gz: 20d10b94e456a30c0169ad54c74dfcef9f6d2f2c7137faa6bac1cf874d95625498a4c86a982b15ce99fbda8390f3c373b01f80bc954ec48ddac3a1064958da05
+  metadata.gz: 410c234d102a5625c2e3cf018de11c35770ee3bf610fbf501de3f96cb5baffe73873793afab8f9621df46261d012b66de7f63c2994aafe6ba5b1644409b13a68
+  data.tar.gz: 0316f3078d519980810a76256fcef9bf76792d0ef2ade10c7e57059282e9a2eab337c2453c262a8f1f88a7fefba5153e90158739aafe80e23c36a04e73f90a0a

data/README.md

@@ -53,6 +53,7 @@ If you have any questions, please contact [hello@listennotes.com](hello@listenno
 - [`fetch_podcasts_by_domain`](#fetch_podcasts_by_domain) — `GET /podcasts/domains/{domain_name}`
 - [`create_playlist`](#create_playlist) — `POST /playlists`
 - [`update_playlist`](#update_playlist) — `PUT /playlists/{id}`
+- [`delete_playlist`](#delete_playlist) — `DELETE /playlists/{id}`
 - [`add_playlist_item`](#add_playlist_item) — `POST /playlists/{id}/items`
 - [`delete_playlist_item`](#delete_playlist_item) — `DELETE /playlists/{id}/items/{item_id}`
 - [`update_playlist_item_notes`](#update_playlist_item_notes) — `PUT /playlists/{id}/items/{item_id}`
@@ -791,6 +792,30 @@ puts response.parsed_response
 
 [Full API documentation](https://www.listennotes.com/api/docs/#put-api-v2-playlists-id)
 
+### delete_playlist
+
+Delete a playlist.
+
+`DELETE /playlists/{id}`
+
+Permanently delete a playlist, including all episode and podcast references saved in this specific playlist and their notes. The actual episodes and podcasts remain in the Listen Notes podcast database.
+
+**Warning: Deletion cannot be undone. Once deleted, the playlist is gone, regardless of how many episodes or podcasts it contains. You, the developer, are responsible for adding a confirmation step in your app's UI before calling this endpoint to prevent accidental deletion.**
+
+Only playlists owned by your admin API account can be modified; contributor membership does not grant write access.
+
+```ruby
+require "podcast_api"
+
+client = PodcastApi::Client.new(api_key: ENV["LISTEN_API_KEY"])
+response = client.delete_playlist(**{
+  'id' => 'm1pe7z60bsw'
+})
+puts response.parsed_response
+```
+
+[Full API documentation](https://www.listennotes.com/api/docs/#delete-api-v2-playlists-id)
+
 ### add_playlist_item
 
 Add an episode or podcast to a playlist.

data/lib/api-contract.json

@@ -1,6 +1,6 @@
 {
   "schema_version": 1,
-  "version": "3.0.0",
+  "version": "3.1.0",
   "operations": [
     {
       "operationId": "search",
@@ -815,6 +815,25 @@
       "summary": "Update playlist metadata.",
       "description": "Update any subset of name, description, visibility, and type. Omitted fields remain unchanged; at least one field is required. Switching to private rotates the playlist RSS secret. Type selects the saved default view (episode_list or podcast_list) and the returned listennotes_url; changing it preserves all existing episodes and podcasts.\n\nOnly playlists owned by your admin API account can be modified; contributor membership does not grant write access."
     },
+    {
+      "operationId": "deletePlaylist",
+      "func": "delete_playlist",
+      "available_from": "3.1.0",
+      "method": "DELETE",
+      "path": "/playlists/{id}",
+      "parameters": [
+        {
+          "name": "id",
+          "in": "path",
+          "required": true
+        }
+      ],
+      "example_params": {
+        "id": "m1pe7z60bsw"
+      },
+      "summary": "Delete a playlist.",
+      "description": "Permanently delete a playlist, including all episode and podcast references saved in this specific playlist and their notes. The actual episodes and podcasts remain in the Listen Notes podcast database.\n\n**Warning: Deletion cannot be undone. Once deleted, the playlist is gone, regardless of how many episodes or podcasts it contains. You, the developer, are responsible for adding a confirmation step in your app's UI before calling this endpoint to prevent accidental deletion.**\n\nOnly playlists owned by your admin API account can be modified; contributor membership does not grant write access."
+    },
     {
       "operationId": "addPlaylistItem",
       "func": "add_playlist_item",

data/lib/api_methods.rb

@@ -138,6 +138,11 @@ module PodcastApi
                   [], kwargs)
     end
 
+    def delete_playlist(**kwargs)
+      request_api('DELETE', '/playlists/{id}',
+                  [], kwargs)
+    end
+
     def add_playlist_item(**kwargs)
       request_api('POST', '/playlists/{id}/items',
                   [], kwargs)

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PodcastApi
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: podcast_api
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Listen Notes, Inc.