spotted 0.16.0 → 0.18.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -0
- data/README.md +2 -2
- data/lib/spotted/models/playlist_retrieve_response.rb +12 -14
- data/lib/spotted/models/playlist_update_params.rb +13 -15
- data/lib/spotted/models/playlists/follower_follow_params.rb +4 -6
- data/lib/spotted/models/simplified_playlist_object.rb +12 -14
- data/lib/spotted/models/users/playlist_create_params.rb +15 -17
- data/lib/spotted/models/users/playlist_create_response.rb +12 -14
- data/lib/spotted/resources/playlists/followers.rb +2 -2
- data/lib/spotted/resources/playlists.rb +3 -3
- data/lib/spotted/resources/users/playlists.rb +3 -3
- data/lib/spotted/version.rb +1 -1
- data/rbi/spotted/models/playlist_retrieve_response.rbi +17 -17
- data/rbi/spotted/models/playlist_update_params.rbi +19 -26
- data/rbi/spotted/models/playlists/follower_follow_params.rbi +6 -16
- data/rbi/spotted/models/simplified_playlist_object.rbi +17 -17
- data/rbi/spotted/models/users/playlist_create_params.rbi +23 -30
- data/rbi/spotted/models/users/playlist_create_response.rbi +17 -17
- data/rbi/spotted/resources/playlists/followers.rbi +2 -3
- data/rbi/spotted/resources/playlists.rbi +7 -8
- data/rbi/spotted/resources/users/playlists.rbi +9 -10
- data/sig/spotted/models/playlist_retrieve_response.rbs +7 -7
- data/sig/spotted/models/playlist_update_params.rbs +7 -14
- data/sig/spotted/models/playlists/follower_follow_params.rbs +5 -10
- data/sig/spotted/models/simplified_playlist_object.rbs +7 -7
- data/sig/spotted/models/users/playlist_create_params.rbs +7 -14
- data/sig/spotted/models/users/playlist_create_response.rbs +7 -7
- data/sig/spotted/resources/playlists/followers.rbs +1 -1
- data/sig/spotted/resources/playlists.rbs +1 -1
- data/sig/spotted/resources/users/playlists.rbs +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 81ed9fd92bd5767bb29c32e6d42c181b9953f750de22051c703863e645a54f4c
|
|
4
|
+
data.tar.gz: 2e8f08bb5b24962b6ed0613f1716ac24497cba04447a4d885ca088396ff5ee7a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: eefebabf917f4e6069d413c2384e9cbeee8297d40bad3026713870a6a43c692918fcc1e55d1be90692724065f87b5866739ab733f4bbc89ba2cffb5db7620b05
|
|
7
|
+
data.tar.gz: d60b5ef9a0987561866f0cf538bf34f8b5b076c3bc17bb55394c629b27a8d34bab1d2001ad13a7eb7dec959b90c13dcf7d5ad9f6779eab91091e5a351f911b71
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,29 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.18.0 (2025-11-20)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v0.17.0...v0.18.0](https://github.com/cjavdev/spotted/compare/v0.17.0...v0.18.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** manual updates ([3272e24](https://github.com/cjavdev/spotted/commit/3272e24a5afcc5864cd1e9e23ca1951bb84524e4))
|
|
10
|
+
|
|
11
|
+
## 0.17.0 (2025-11-20)
|
|
12
|
+
|
|
13
|
+
Full Changelog: [v0.16.0...v0.17.0](https://github.com/cjavdev/spotted/compare/v0.16.0...v0.17.0)
|
|
14
|
+
|
|
15
|
+
### Features
|
|
16
|
+
|
|
17
|
+
* **api:** manual updates ([e260dd2](https://github.com/cjavdev/spotted/commit/e260dd2787657b4fa3cb412fe730d68fad2989ce))
|
|
18
|
+
|
|
19
|
+
## 0.17.0 (2025-11-20)
|
|
20
|
+
|
|
21
|
+
Full Changelog: [v0.16.0...v0.17.0](https://github.com/cjavdev/spotted/compare/v0.16.0...v0.17.0)
|
|
22
|
+
|
|
23
|
+
### Features
|
|
24
|
+
|
|
25
|
+
* **api:** manual updates ([e260dd2](https://github.com/cjavdev/spotted/commit/e260dd2787657b4fa3cb412fe730d68fad2989ce))
|
|
26
|
+
|
|
3
27
|
## 0.16.0 (2025-11-20)
|
|
4
28
|
|
|
5
29
|
Full Changelog: [v0.15.0...v0.16.0](https://github.com/cjavdev/spotted/compare/v0.15.0...v0.16.0)
|
data/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Spotted Ruby API library
|
|
2
2
|
|
|
3
|
-
The Spotted Ruby library provides convenient access to the
|
|
3
|
+
The Spotted Ruby library provides convenient access to the Spotify API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/cjavdev/spotted#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
|
|
4
4
|
|
|
5
5
|
It is generated with [Stainless](https://www.stainless.com/).
|
|
6
6
|
|
|
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
|
17
17
|
<!-- x-release-please-start-version -->
|
|
18
18
|
|
|
19
19
|
```ruby
|
|
20
|
-
gem "spotted", "~> 0.
|
|
20
|
+
gem "spotted", "~> 0.18.0"
|
|
21
21
|
```
|
|
22
22
|
|
|
23
23
|
<!-- x-release-please-end -->
|
|
@@ -11,17 +11,6 @@ module Spotted
|
|
|
11
11
|
# @return [String, nil]
|
|
12
12
|
optional :id, String
|
|
13
13
|
|
|
14
|
-
# @!attribute components_schemas_properties_published
|
|
15
|
-
# The playlist's public/private status (if it is added to the user's profile):
|
|
16
|
-
# `true` the playlist is public, `false` the playlist is private, `null` the
|
|
17
|
-
# playlist status is not relevant. For more about public/private status, see
|
|
18
|
-
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
19
|
-
#
|
|
20
|
-
# @return [Boolean, nil]
|
|
21
|
-
optional :components_schemas_properties_published,
|
|
22
|
-
Spotted::Internal::Type::Boolean,
|
|
23
|
-
api_name: :"$.components.schemas.*.properties.published"
|
|
24
|
-
|
|
25
14
|
# @!attribute collaborative
|
|
26
15
|
# `true` if the owner allows other users to modify the playlist.
|
|
27
16
|
#
|
|
@@ -75,6 +64,15 @@ module Spotted
|
|
|
75
64
|
# @return [Spotted::Models::PlaylistRetrieveResponse::Owner, nil]
|
|
76
65
|
optional :owner, -> { Spotted::Models::PlaylistRetrieveResponse::Owner }
|
|
77
66
|
|
|
67
|
+
# @!attribute published
|
|
68
|
+
# The playlist's public/private status (if it is added to the user's profile):
|
|
69
|
+
# `true` the playlist is public, `false` the playlist is private, `null` the
|
|
70
|
+
# playlist status is not relevant. For more about public/private status, see
|
|
71
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
72
|
+
#
|
|
73
|
+
# @return [Boolean, nil]
|
|
74
|
+
optional :published, Spotted::Internal::Type::Boolean
|
|
75
|
+
|
|
78
76
|
# @!attribute snapshot_id
|
|
79
77
|
# The version identifier for the current playlist. Can be supplied in other
|
|
80
78
|
# requests to target a specific playlist version
|
|
@@ -101,14 +99,12 @@ module Spotted
|
|
|
101
99
|
# @return [String, nil]
|
|
102
100
|
optional :uri, String
|
|
103
101
|
|
|
104
|
-
# @!method initialize(id: nil,
|
|
102
|
+
# @!method initialize(id: nil, collaborative: nil, description: nil, external_urls: nil, followers: nil, href: nil, images: nil, name: nil, owner: nil, published: nil, snapshot_id: nil, tracks: nil, type: nil, uri: nil)
|
|
105
103
|
# Some parameter documentations has been truncated, see
|
|
106
104
|
# {Spotted::Models::PlaylistRetrieveResponse} for more details.
|
|
107
105
|
#
|
|
108
106
|
# @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the playl
|
|
109
107
|
#
|
|
110
|
-
# @param components_schemas_properties_published [Boolean] The playlist's public/private status (if it is added to the user's profile): `tr
|
|
111
|
-
#
|
|
112
108
|
# @param collaborative [Boolean] `true` if the owner allows other users to modify the playlist.
|
|
113
109
|
#
|
|
114
110
|
# @param description [String, nil] The playlist description. \_Only returned for modified, verified playlists,
|
|
@@ -126,6 +122,8 @@ module Spotted
|
|
|
126
122
|
#
|
|
127
123
|
# @param owner [Spotted::Models::PlaylistRetrieveResponse::Owner] The user who owns the playlist
|
|
128
124
|
#
|
|
125
|
+
# @param published [Boolean] The playlist's public/private status (if it is added to the user's profile): `tr
|
|
126
|
+
#
|
|
129
127
|
# @param snapshot_id [String] The version identifier for the current playlist. Can be supplied in other reques
|
|
130
128
|
#
|
|
131
129
|
# @param tracks [Spotted::Models::PlaylistRetrieveResponse::Tracks] The tracks of the playlist.
|
|
@@ -7,18 +7,6 @@ module Spotted
|
|
|
7
7
|
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Spotted::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!attribute paths_request_body_content_application_json_schema_properties_published
|
|
11
|
-
# The playlist's public/private status (if it should be added to the user's
|
|
12
|
-
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
13
|
-
# be private, `null` the playlist status is not relevant. For more about
|
|
14
|
-
# public/private status, see
|
|
15
|
-
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
16
|
-
#
|
|
17
|
-
# @return [Boolean, nil]
|
|
18
|
-
optional :paths_request_body_content_application_json_schema_properties_published,
|
|
19
|
-
Spotted::Internal::Type::Boolean,
|
|
20
|
-
api_name: :"$.paths['*'].*.requestBody.content['application/json'].schema.properties.published"
|
|
21
|
-
|
|
22
10
|
# @!attribute collaborative
|
|
23
11
|
# If `true`, the playlist will become collaborative and other users will be able
|
|
24
12
|
# to modify the playlist in their Spotify client. <br/> _**Note**: You can only
|
|
@@ -40,18 +28,28 @@ module Spotted
|
|
|
40
28
|
# @return [String, nil]
|
|
41
29
|
optional :name, String
|
|
42
30
|
|
|
43
|
-
# @!
|
|
31
|
+
# @!attribute public
|
|
32
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
33
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
34
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
35
|
+
# public/private status, see
|
|
36
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
37
|
+
#
|
|
38
|
+
# @return [Boolean, nil]
|
|
39
|
+
optional :public, Spotted::Internal::Type::Boolean
|
|
40
|
+
|
|
41
|
+
# @!method initialize(collaborative: nil, description: nil, name: nil, public: nil, request_options: {})
|
|
44
42
|
# Some parameter documentations has been truncated, see
|
|
45
43
|
# {Spotted::Models::PlaylistUpdateParams} for more details.
|
|
46
44
|
#
|
|
47
|
-
# @param paths_request_body_content_application_json_schema_properties_published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
48
|
-
#
|
|
49
45
|
# @param collaborative [Boolean] If `true`, the playlist will become collaborative and other users will be able t
|
|
50
46
|
#
|
|
51
47
|
# @param description [String] Value for playlist description as displayed in Spotify Clients and in the Web AP
|
|
52
48
|
#
|
|
53
49
|
# @param name [String] The new name for the playlist, for example `"My New Playlist Title"`
|
|
54
50
|
#
|
|
51
|
+
# @param public [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
52
|
+
#
|
|
55
53
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
56
54
|
end
|
|
57
55
|
end
|
|
@@ -8,22 +8,20 @@ module Spotted
|
|
|
8
8
|
extend Spotted::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Spotted::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!attribute
|
|
11
|
+
# @!attribute public
|
|
12
12
|
# Defaults to `true`. If `true` the playlist will be included in user's public
|
|
13
13
|
# playlists (added to profile), if `false` it will remain private. For more about
|
|
14
14
|
# public/private status, see
|
|
15
15
|
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
16
16
|
#
|
|
17
17
|
# @return [Boolean, nil]
|
|
18
|
-
optional :
|
|
19
|
-
Spotted::Internal::Type::Boolean,
|
|
20
|
-
api_name: :"$.paths['*'].*.requestBody.content['application/json'].schema.properties.published"
|
|
18
|
+
optional :public, Spotted::Internal::Type::Boolean
|
|
21
19
|
|
|
22
|
-
# @!method initialize(
|
|
20
|
+
# @!method initialize(public: nil, request_options: {})
|
|
23
21
|
# Some parameter documentations has been truncated, see
|
|
24
22
|
# {Spotted::Models::Playlists::FollowerFollowParams} for more details.
|
|
25
23
|
#
|
|
26
|
-
# @param
|
|
24
|
+
# @param public [Boolean] Defaults to `true`. If `true` the playlist will be included in user's public pla
|
|
27
25
|
#
|
|
28
26
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
29
27
|
end
|
|
@@ -10,17 +10,6 @@ module Spotted
|
|
|
10
10
|
# @return [String, nil]
|
|
11
11
|
optional :id, String
|
|
12
12
|
|
|
13
|
-
# @!attribute components_schemas_properties_published
|
|
14
|
-
# The playlist's public/private status (if it is added to the user's profile):
|
|
15
|
-
# `true` the playlist is public, `false` the playlist is private, `null` the
|
|
16
|
-
# playlist status is not relevant. For more about public/private status, see
|
|
17
|
-
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
18
|
-
#
|
|
19
|
-
# @return [Boolean, nil]
|
|
20
|
-
optional :components_schemas_properties_published,
|
|
21
|
-
Spotted::Internal::Type::Boolean,
|
|
22
|
-
api_name: :"$.components.schemas.*.properties.published"
|
|
23
|
-
|
|
24
13
|
# @!attribute collaborative
|
|
25
14
|
# `true` if the owner allows other users to modify the playlist.
|
|
26
15
|
#
|
|
@@ -68,6 +57,15 @@ module Spotted
|
|
|
68
57
|
# @return [Spotted::Models::SimplifiedPlaylistObject::Owner, nil]
|
|
69
58
|
optional :owner, -> { Spotted::SimplifiedPlaylistObject::Owner }
|
|
70
59
|
|
|
60
|
+
# @!attribute published
|
|
61
|
+
# The playlist's public/private status (if it is added to the user's profile):
|
|
62
|
+
# `true` the playlist is public, `false` the playlist is private, `null` the
|
|
63
|
+
# playlist status is not relevant. For more about public/private status, see
|
|
64
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
65
|
+
#
|
|
66
|
+
# @return [Boolean, nil]
|
|
67
|
+
optional :published, Spotted::Internal::Type::Boolean
|
|
68
|
+
|
|
71
69
|
# @!attribute snapshot_id
|
|
72
70
|
# The version identifier for the current playlist. Can be supplied in other
|
|
73
71
|
# requests to target a specific playlist version
|
|
@@ -97,14 +95,12 @@ module Spotted
|
|
|
97
95
|
# @return [String, nil]
|
|
98
96
|
optional :uri, String
|
|
99
97
|
|
|
100
|
-
# @!method initialize(id: nil,
|
|
98
|
+
# @!method initialize(id: nil, collaborative: nil, description: nil, external_urls: nil, href: nil, images: nil, name: nil, owner: nil, published: nil, snapshot_id: nil, tracks: nil, type: nil, uri: nil)
|
|
101
99
|
# Some parameter documentations has been truncated, see
|
|
102
100
|
# {Spotted::Models::SimplifiedPlaylistObject} for more details.
|
|
103
101
|
#
|
|
104
102
|
# @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the playl
|
|
105
103
|
#
|
|
106
|
-
# @param components_schemas_properties_published [Boolean] The playlist's public/private status (if it is added to the user's profile): `tr
|
|
107
|
-
#
|
|
108
104
|
# @param collaborative [Boolean] `true` if the owner allows other users to modify the playlist.
|
|
109
105
|
#
|
|
110
106
|
# @param description [String] The playlist description. \_Only returned for modified, verified playlists,
|
|
@@ -120,6 +116,8 @@ module Spotted
|
|
|
120
116
|
#
|
|
121
117
|
# @param owner [Spotted::Models::SimplifiedPlaylistObject::Owner] The user who owns the playlist
|
|
122
118
|
#
|
|
119
|
+
# @param published [Boolean] The playlist's public/private status (if it is added to the user's profile): `tr
|
|
120
|
+
#
|
|
123
121
|
# @param snapshot_id [String] The version identifier for the current playlist. Can be supplied in other reques
|
|
124
122
|
#
|
|
125
123
|
# @param tracks [Spotted::Models::PlaylistTracksRefObject] A collection containing a link ( `href` ) to the Web API endpoint where full det
|
|
@@ -16,20 +16,6 @@ module Spotted
|
|
|
16
16
|
# @return [String]
|
|
17
17
|
required :name, String
|
|
18
18
|
|
|
19
|
-
# @!attribute paths_request_body_content_application_json_schema_properties_published
|
|
20
|
-
# Defaults to `true`. The playlist's public/private status (if it should be added
|
|
21
|
-
# to the user's profile or not): `true` the playlist will be public, `false` the
|
|
22
|
-
# playlist will be private. To be able to create private playlists, the user must
|
|
23
|
-
# have granted the `playlist-modify-private`
|
|
24
|
-
# [scope](/documentation/web-api/concepts/scopes/#list-of-scopes). For more about
|
|
25
|
-
# public/private status, see
|
|
26
|
-
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
27
|
-
#
|
|
28
|
-
# @return [Boolean, nil]
|
|
29
|
-
optional :paths_request_body_content_application_json_schema_properties_published,
|
|
30
|
-
Spotted::Internal::Type::Boolean,
|
|
31
|
-
api_name: :"$.paths['*'].*.requestBody.content['application/json'].schema.properties.published"
|
|
32
|
-
|
|
33
19
|
# @!attribute collaborative
|
|
34
20
|
# Defaults to `false`. If `true` the playlist will be collaborative. _**Note**: to
|
|
35
21
|
# create a collaborative playlist you must also set `public` to `false`. To create
|
|
@@ -47,19 +33,31 @@ module Spotted
|
|
|
47
33
|
# @return [String, nil]
|
|
48
34
|
optional :description, String
|
|
49
35
|
|
|
50
|
-
# @!
|
|
36
|
+
# @!attribute public
|
|
37
|
+
# Defaults to `true`. The playlist's public/private status (if it should be added
|
|
38
|
+
# to the user's profile or not): `true` the playlist will be public, `false` the
|
|
39
|
+
# playlist will be private. To be able to create private playlists, the user must
|
|
40
|
+
# have granted the `playlist-modify-private`
|
|
41
|
+
# [scope](/documentation/web-api/concepts/scopes/#list-of-scopes). For more about
|
|
42
|
+
# public/private status, see
|
|
43
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
44
|
+
#
|
|
45
|
+
# @return [Boolean, nil]
|
|
46
|
+
optional :public, Spotted::Internal::Type::Boolean
|
|
47
|
+
|
|
48
|
+
# @!method initialize(name:, collaborative: nil, description: nil, public: nil, request_options: {})
|
|
51
49
|
# Some parameter documentations has been truncated, see
|
|
52
50
|
# {Spotted::Models::Users::PlaylistCreateParams} for more details.
|
|
53
51
|
#
|
|
54
52
|
# @param name [String] The name for the new playlist, for example `"Your Coolest Playlist"`. This name
|
|
55
53
|
#
|
|
56
|
-
# @param paths_request_body_content_application_json_schema_properties_published [Boolean] Defaults to `true`. The playlist's public/private status (if it should be added
|
|
57
|
-
#
|
|
58
54
|
# @param collaborative [Boolean] Defaults to `false`. If `true` the playlist will be collaborative. \_**Note**:
|
|
59
55
|
# to
|
|
60
56
|
#
|
|
61
57
|
# @param description [String] value for playlist description as displayed in Spotify Clients and in the Web AP
|
|
62
58
|
#
|
|
59
|
+
# @param public [Boolean] Defaults to `true`. The playlist's public/private status (if it should be added
|
|
60
|
+
#
|
|
63
61
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}]
|
|
64
62
|
end
|
|
65
63
|
end
|
|
@@ -12,17 +12,6 @@ module Spotted
|
|
|
12
12
|
# @return [String, nil]
|
|
13
13
|
optional :id, String
|
|
14
14
|
|
|
15
|
-
# @!attribute components_schemas_properties_published
|
|
16
|
-
# The playlist's public/private status (if it is added to the user's profile):
|
|
17
|
-
# `true` the playlist is public, `false` the playlist is private, `null` the
|
|
18
|
-
# playlist status is not relevant. For more about public/private status, see
|
|
19
|
-
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
20
|
-
#
|
|
21
|
-
# @return [Boolean, nil]
|
|
22
|
-
optional :components_schemas_properties_published,
|
|
23
|
-
Spotted::Internal::Type::Boolean,
|
|
24
|
-
api_name: :"$.components.schemas.*.properties.published"
|
|
25
|
-
|
|
26
15
|
# @!attribute collaborative
|
|
27
16
|
# `true` if the owner allows other users to modify the playlist.
|
|
28
17
|
#
|
|
@@ -76,6 +65,15 @@ module Spotted
|
|
|
76
65
|
# @return [Spotted::Models::Users::PlaylistCreateResponse::Owner, nil]
|
|
77
66
|
optional :owner, -> { Spotted::Models::Users::PlaylistCreateResponse::Owner }
|
|
78
67
|
|
|
68
|
+
# @!attribute published
|
|
69
|
+
# The playlist's public/private status (if it is added to the user's profile):
|
|
70
|
+
# `true` the playlist is public, `false` the playlist is private, `null` the
|
|
71
|
+
# playlist status is not relevant. For more about public/private status, see
|
|
72
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
73
|
+
#
|
|
74
|
+
# @return [Boolean, nil]
|
|
75
|
+
optional :published, Spotted::Internal::Type::Boolean
|
|
76
|
+
|
|
79
77
|
# @!attribute snapshot_id
|
|
80
78
|
# The version identifier for the current playlist. Can be supplied in other
|
|
81
79
|
# requests to target a specific playlist version
|
|
@@ -102,14 +100,12 @@ module Spotted
|
|
|
102
100
|
# @return [String, nil]
|
|
103
101
|
optional :uri, String
|
|
104
102
|
|
|
105
|
-
# @!method initialize(id: nil,
|
|
103
|
+
# @!method initialize(id: nil, collaborative: nil, description: nil, external_urls: nil, followers: nil, href: nil, images: nil, name: nil, owner: nil, published: nil, snapshot_id: nil, tracks: nil, type: nil, uri: nil)
|
|
106
104
|
# Some parameter documentations has been truncated, see
|
|
107
105
|
# {Spotted::Models::Users::PlaylistCreateResponse} for more details.
|
|
108
106
|
#
|
|
109
107
|
# @param id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the playl
|
|
110
108
|
#
|
|
111
|
-
# @param components_schemas_properties_published [Boolean] The playlist's public/private status (if it is added to the user's profile): `tr
|
|
112
|
-
#
|
|
113
109
|
# @param collaborative [Boolean] `true` if the owner allows other users to modify the playlist.
|
|
114
110
|
#
|
|
115
111
|
# @param description [String, nil] The playlist description. \_Only returned for modified, verified playlists,
|
|
@@ -127,6 +123,8 @@ module Spotted
|
|
|
127
123
|
#
|
|
128
124
|
# @param owner [Spotted::Models::Users::PlaylistCreateResponse::Owner] The user who owns the playlist
|
|
129
125
|
#
|
|
126
|
+
# @param published [Boolean] The playlist's public/private status (if it is added to the user's profile): `tr
|
|
127
|
+
#
|
|
130
128
|
# @param snapshot_id [String] The version identifier for the current playlist. Can be supplied in other reques
|
|
131
129
|
#
|
|
132
130
|
# @param tracks [Spotted::Models::Users::PlaylistCreateResponse::Tracks] The tracks of the playlist.
|
|
@@ -36,11 +36,11 @@ module Spotted
|
|
|
36
36
|
#
|
|
37
37
|
# Add the current user as a follower of a playlist.
|
|
38
38
|
#
|
|
39
|
-
# @overload follow(playlist_id,
|
|
39
|
+
# @overload follow(playlist_id, public: nil, request_options: {})
|
|
40
40
|
#
|
|
41
41
|
# @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
|
|
42
42
|
#
|
|
43
|
-
# @param
|
|
43
|
+
# @param public [Boolean] Defaults to `true`. If `true` the playlist will be included in user's public pla
|
|
44
44
|
#
|
|
45
45
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
46
46
|
#
|
|
@@ -49,18 +49,18 @@ module Spotted
|
|
|
49
49
|
# Change a playlist's name and public/private state. (The user must, of course,
|
|
50
50
|
# own the playlist.)
|
|
51
51
|
#
|
|
52
|
-
# @overload update(playlist_id,
|
|
52
|
+
# @overload update(playlist_id, collaborative: nil, description: nil, name: nil, public: nil, request_options: {})
|
|
53
53
|
#
|
|
54
54
|
# @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
|
|
55
55
|
#
|
|
56
|
-
# @param paths_request_body_content_application_json_schema_properties_published [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
57
|
-
#
|
|
58
56
|
# @param collaborative [Boolean] If `true`, the playlist will become collaborative and other users will be able t
|
|
59
57
|
#
|
|
60
58
|
# @param description [String] Value for playlist description as displayed in Spotify Clients and in the Web AP
|
|
61
59
|
#
|
|
62
60
|
# @param name [String] The new name for the playlist, for example `"My New Playlist Title"`
|
|
63
61
|
#
|
|
62
|
+
# @param public [Boolean] The playlist's public/private status (if it should be added to the user's profil
|
|
63
|
+
#
|
|
64
64
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
65
65
|
#
|
|
66
66
|
# @return [nil]
|
|
@@ -11,19 +11,19 @@ module Spotted
|
|
|
11
11
|
# [add tracks](/documentation/web-api/reference/add-tracks-to-playlist).) Each
|
|
12
12
|
# user is generally limited to a maximum of 11000 playlists.
|
|
13
13
|
#
|
|
14
|
-
# @overload create(user_id, name:,
|
|
14
|
+
# @overload create(user_id, name:, collaborative: nil, description: nil, public: nil, request_options: {})
|
|
15
15
|
#
|
|
16
16
|
# @param user_id [String] The user's [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids).
|
|
17
17
|
#
|
|
18
18
|
# @param name [String] The name for the new playlist, for example `"Your Coolest Playlist"`. This name
|
|
19
19
|
#
|
|
20
|
-
# @param paths_request_body_content_application_json_schema_properties_published [Boolean] Defaults to `true`. The playlist's public/private status (if it should be added
|
|
21
|
-
#
|
|
22
20
|
# @param collaborative [Boolean] Defaults to `false`. If `true` the playlist will be collaborative. \_**Note**:
|
|
23
21
|
# to
|
|
24
22
|
#
|
|
25
23
|
# @param description [String] value for playlist description as displayed in Spotify Clients and in the Web AP
|
|
26
24
|
#
|
|
25
|
+
# @param public [Boolean] Defaults to `true`. The playlist's public/private status (if it should be added
|
|
26
|
+
#
|
|
27
27
|
# @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
28
28
|
#
|
|
29
29
|
# @return [Spotted::Models::Users::PlaylistCreateResponse]
|
data/lib/spotted/version.rb
CHANGED
|
@@ -19,16 +19,6 @@ module Spotted
|
|
|
19
19
|
sig { params(id: String).void }
|
|
20
20
|
attr_writer :id
|
|
21
21
|
|
|
22
|
-
# The playlist's public/private status (if it is added to the user's profile):
|
|
23
|
-
# `true` the playlist is public, `false` the playlist is private, `null` the
|
|
24
|
-
# playlist status is not relevant. For more about public/private status, see
|
|
25
|
-
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
26
|
-
sig { returns(T.nilable(T::Boolean)) }
|
|
27
|
-
attr_reader :components_schemas_properties_published
|
|
28
|
-
|
|
29
|
-
sig { params(components_schemas_properties_published: T::Boolean).void }
|
|
30
|
-
attr_writer :components_schemas_properties_published
|
|
31
|
-
|
|
32
22
|
# `true` if the owner allows other users to modify the playlist.
|
|
33
23
|
sig { returns(T.nilable(T::Boolean)) }
|
|
34
24
|
attr_reader :collaborative
|
|
@@ -93,6 +83,16 @@ module Spotted
|
|
|
93
83
|
end
|
|
94
84
|
attr_writer :owner
|
|
95
85
|
|
|
86
|
+
# The playlist's public/private status (if it is added to the user's profile):
|
|
87
|
+
# `true` the playlist is public, `false` the playlist is private, `null` the
|
|
88
|
+
# playlist status is not relevant. For more about public/private status, see
|
|
89
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
90
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
91
|
+
attr_reader :published
|
|
92
|
+
|
|
93
|
+
sig { params(published: T::Boolean).void }
|
|
94
|
+
attr_writer :published
|
|
95
|
+
|
|
96
96
|
# The version identifier for the current playlist. Can be supplied in other
|
|
97
97
|
# requests to target a specific playlist version
|
|
98
98
|
sig { returns(T.nilable(String)) }
|
|
@@ -132,7 +132,6 @@ module Spotted
|
|
|
132
132
|
sig do
|
|
133
133
|
params(
|
|
134
134
|
id: String,
|
|
135
|
-
components_schemas_properties_published: T::Boolean,
|
|
136
135
|
collaborative: T::Boolean,
|
|
137
136
|
description: T.nilable(String),
|
|
138
137
|
external_urls: Spotted::ExternalURLObject::OrHash,
|
|
@@ -141,6 +140,7 @@ module Spotted
|
|
|
141
140
|
images: T::Array[Spotted::ImageObject::OrHash],
|
|
142
141
|
name: String,
|
|
143
142
|
owner: Spotted::Models::PlaylistRetrieveResponse::Owner::OrHash,
|
|
143
|
+
published: T::Boolean,
|
|
144
144
|
snapshot_id: String,
|
|
145
145
|
tracks: Spotted::Models::PlaylistRetrieveResponse::Tracks::OrHash,
|
|
146
146
|
type: String,
|
|
@@ -151,11 +151,6 @@ module Spotted
|
|
|
151
151
|
# The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
|
|
152
152
|
# playlist.
|
|
153
153
|
id: nil,
|
|
154
|
-
# The playlist's public/private status (if it is added to the user's profile):
|
|
155
|
-
# `true` the playlist is public, `false` the playlist is private, `null` the
|
|
156
|
-
# playlist status is not relevant. For more about public/private status, see
|
|
157
|
-
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
158
|
-
components_schemas_properties_published: nil,
|
|
159
154
|
# `true` if the owner allows other users to modify the playlist.
|
|
160
155
|
collaborative: nil,
|
|
161
156
|
# The playlist description. _Only returned for modified, verified playlists,
|
|
@@ -177,6 +172,11 @@ module Spotted
|
|
|
177
172
|
name: nil,
|
|
178
173
|
# The user who owns the playlist
|
|
179
174
|
owner: nil,
|
|
175
|
+
# The playlist's public/private status (if it is added to the user's profile):
|
|
176
|
+
# `true` the playlist is public, `false` the playlist is private, `null` the
|
|
177
|
+
# playlist status is not relevant. For more about public/private status, see
|
|
178
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
179
|
+
published: nil,
|
|
180
180
|
# The version identifier for the current playlist. Can be supplied in other
|
|
181
181
|
# requests to target a specific playlist version
|
|
182
182
|
snapshot_id: nil,
|
|
@@ -194,7 +194,6 @@ module Spotted
|
|
|
194
194
|
override.returns(
|
|
195
195
|
{
|
|
196
196
|
id: String,
|
|
197
|
-
components_schemas_properties_published: T::Boolean,
|
|
198
197
|
collaborative: T::Boolean,
|
|
199
198
|
description: T.nilable(String),
|
|
200
199
|
external_urls: Spotted::ExternalURLObject,
|
|
@@ -203,6 +202,7 @@ module Spotted
|
|
|
203
202
|
images: T::Array[Spotted::ImageObject],
|
|
204
203
|
name: String,
|
|
205
204
|
owner: Spotted::Models::PlaylistRetrieveResponse::Owner,
|
|
205
|
+
published: T::Boolean,
|
|
206
206
|
snapshot_id: String,
|
|
207
207
|
tracks: Spotted::Models::PlaylistRetrieveResponse::Tracks,
|
|
208
208
|
type: String,
|
|
@@ -11,22 +11,6 @@ module Spotted
|
|
|
11
11
|
T.any(Spotted::PlaylistUpdateParams, Spotted::Internal::AnyHash)
|
|
12
12
|
end
|
|
13
13
|
|
|
14
|
-
# The playlist's public/private status (if it should be added to the user's
|
|
15
|
-
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
16
|
-
# be private, `null` the playlist status is not relevant. For more about
|
|
17
|
-
# public/private status, see
|
|
18
|
-
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
19
|
-
sig { returns(T.nilable(T::Boolean)) }
|
|
20
|
-
attr_reader :paths_request_body_content_application_json_schema_properties_published
|
|
21
|
-
|
|
22
|
-
sig do
|
|
23
|
-
params(
|
|
24
|
-
paths_request_body_content_application_json_schema_properties_published:
|
|
25
|
-
T::Boolean
|
|
26
|
-
).void
|
|
27
|
-
end
|
|
28
|
-
attr_writer :paths_request_body_content_application_json_schema_properties_published
|
|
29
|
-
|
|
30
14
|
# If `true`, the playlist will become collaborative and other users will be able
|
|
31
15
|
# to modify the playlist in their Spotify client. <br/> _**Note**: You can only
|
|
32
16
|
# set `collaborative` to `true` on non-public playlists._
|
|
@@ -51,23 +35,27 @@ module Spotted
|
|
|
51
35
|
sig { params(name: String).void }
|
|
52
36
|
attr_writer :name
|
|
53
37
|
|
|
38
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
39
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
40
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
41
|
+
# public/private status, see
|
|
42
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
43
|
+
sig { returns(T.nilable(T::Boolean)) }
|
|
44
|
+
attr_reader :public
|
|
45
|
+
|
|
46
|
+
sig { params(public: T::Boolean).void }
|
|
47
|
+
attr_writer :public
|
|
48
|
+
|
|
54
49
|
sig do
|
|
55
50
|
params(
|
|
56
|
-
paths_request_body_content_application_json_schema_properties_published:
|
|
57
|
-
T::Boolean,
|
|
58
51
|
collaborative: T::Boolean,
|
|
59
52
|
description: String,
|
|
60
53
|
name: String,
|
|
54
|
+
public: T::Boolean,
|
|
61
55
|
request_options: Spotted::RequestOptions::OrHash
|
|
62
56
|
).returns(T.attached_class)
|
|
63
57
|
end
|
|
64
58
|
def self.new(
|
|
65
|
-
# The playlist's public/private status (if it should be added to the user's
|
|
66
|
-
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
67
|
-
# be private, `null` the playlist status is not relevant. For more about
|
|
68
|
-
# public/private status, see
|
|
69
|
-
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
70
|
-
paths_request_body_content_application_json_schema_properties_published: nil,
|
|
71
59
|
# If `true`, the playlist will become collaborative and other users will be able
|
|
72
60
|
# to modify the playlist in their Spotify client. <br/> _**Note**: You can only
|
|
73
61
|
# set `collaborative` to `true` on non-public playlists._
|
|
@@ -77,6 +65,12 @@ module Spotted
|
|
|
77
65
|
description: nil,
|
|
78
66
|
# The new name for the playlist, for example `"My New Playlist Title"`
|
|
79
67
|
name: nil,
|
|
68
|
+
# The playlist's public/private status (if it should be added to the user's
|
|
69
|
+
# profile or not): `true` the playlist will be public, `false` the playlist will
|
|
70
|
+
# be private, `null` the playlist status is not relevant. For more about
|
|
71
|
+
# public/private status, see
|
|
72
|
+
# [Working with Playlists](/documentation/web-api/concepts/playlists)
|
|
73
|
+
public: nil,
|
|
80
74
|
request_options: {}
|
|
81
75
|
)
|
|
82
76
|
end
|
|
@@ -84,11 +78,10 @@ module Spotted
|
|
|
84
78
|
sig do
|
|
85
79
|
override.returns(
|
|
86
80
|
{
|
|
87
|
-
paths_request_body_content_application_json_schema_properties_published:
|
|
88
|
-
T::Boolean,
|
|
89
81
|
collaborative: T::Boolean,
|
|
90
82
|
description: String,
|
|
91
83
|
name: String,
|
|
84
|
+
public: T::Boolean,
|
|
92
85
|
request_options: Spotted::RequestOptions
|
|
93
86
|
}
|
|
94
87
|
)
|