spotted 0.25.0 → 0.26.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.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/spotted/models/me/album_remove_params.rb +13 -1
  5. data/lib/spotted/models/me/album_save_params.rb +13 -1
  6. data/lib/spotted/models/me/episode_remove_params.rb +13 -1
  7. data/lib/spotted/models/me/episode_save_params.rb +13 -1
  8. data/lib/spotted/models/me/following_follow_params.rb +13 -1
  9. data/lib/spotted/models/me/following_unfollow_params.rb +13 -1
  10. data/lib/spotted/models/me/player_start_playback_params.rb +13 -1
  11. data/lib/spotted/models/me/player_transfer_params.rb +13 -1
  12. data/lib/spotted/models/me/show_remove_params.rb +13 -1
  13. data/lib/spotted/models/me/show_save_params.rb +13 -1
  14. data/lib/spotted/models/me/track_remove_params.rb +13 -1
  15. data/lib/spotted/models/me/track_save_params.rb +13 -1
  16. data/lib/spotted/models/playlist_update_params.rb +13 -1
  17. data/lib/spotted/models/playlists/follower_follow_params.rb +13 -1
  18. data/lib/spotted/models/playlists/track_add_params.rb +13 -1
  19. data/lib/spotted/models/playlists/track_remove_params.rb +13 -1
  20. data/lib/spotted/models/playlists/track_update_params.rb +13 -1
  21. data/lib/spotted/models/users/playlist_create_params.rb +13 -1
  22. data/lib/spotted/resources/me/albums.rb +6 -2
  23. data/lib/spotted/resources/me/episodes.rb +6 -2
  24. data/lib/spotted/resources/me/following.rb +6 -2
  25. data/lib/spotted/resources/me/player.rb +6 -2
  26. data/lib/spotted/resources/me/shows.rb +6 -2
  27. data/lib/spotted/resources/me/tracks.rb +6 -2
  28. data/lib/spotted/resources/playlists/followers.rb +3 -1
  29. data/lib/spotted/resources/playlists/tracks.rb +9 -3
  30. data/lib/spotted/resources/playlists.rb +3 -1
  31. data/lib/spotted/resources/users/playlists.rb +3 -1
  32. data/lib/spotted/version.rb +1 -1
  33. data/rbi/spotted/models/me/album_remove_params.rbi +23 -1
  34. data/rbi/spotted/models/me/album_save_params.rbi +23 -1
  35. data/rbi/spotted/models/me/episode_remove_params.rbi +23 -1
  36. data/rbi/spotted/models/me/episode_save_params.rbi +23 -1
  37. data/rbi/spotted/models/me/following_follow_params.rbi +23 -1
  38. data/rbi/spotted/models/me/following_unfollow_params.rbi +23 -1
  39. data/rbi/spotted/models/me/player_start_playback_params.rbi +19 -0
  40. data/rbi/spotted/models/me/player_transfer_params.rbi +19 -0
  41. data/rbi/spotted/models/me/show_remove_params.rbi +23 -1
  42. data/rbi/spotted/models/me/show_save_params.rbi +23 -1
  43. data/rbi/spotted/models/me/track_remove_params.rbi +23 -1
  44. data/rbi/spotted/models/me/track_save_params.rbi +19 -0
  45. data/rbi/spotted/models/playlist_update_params.rbi +19 -0
  46. data/rbi/spotted/models/playlists/follower_follow_params.rbi +23 -1
  47. data/rbi/spotted/models/playlists/track_add_params.rbi +19 -0
  48. data/rbi/spotted/models/playlists/track_remove_params.rbi +19 -0
  49. data/rbi/spotted/models/playlists/track_update_params.rbi +19 -0
  50. data/rbi/spotted/models/users/playlist_create_params.rbi +19 -0
  51. data/rbi/spotted/resources/me/albums.rbi +14 -0
  52. data/rbi/spotted/resources/me/episodes.rbi +14 -0
  53. data/rbi/spotted/resources/me/following.rbi +14 -0
  54. data/rbi/spotted/resources/me/player.rbi +14 -0
  55. data/rbi/spotted/resources/me/shows.rbi +14 -0
  56. data/rbi/spotted/resources/me/tracks.rbi +14 -0
  57. data/rbi/spotted/resources/playlists/followers.rbi +7 -0
  58. data/rbi/spotted/resources/playlists/tracks.rbi +21 -0
  59. data/rbi/spotted/resources/playlists.rbi +7 -0
  60. data/rbi/spotted/resources/users/playlists.rbi +7 -0
  61. data/sig/spotted/models/me/album_remove_params.rbs +8 -1
  62. data/sig/spotted/models/me/album_save_params.rbs +8 -1
  63. data/sig/spotted/models/me/episode_remove_params.rbs +8 -1
  64. data/sig/spotted/models/me/episode_save_params.rbs +8 -1
  65. data/sig/spotted/models/me/following_follow_params.rbs +8 -1
  66. data/sig/spotted/models/me/following_unfollow_params.rbs +8 -1
  67. data/sig/spotted/models/me/player_start_playback_params.rbs +7 -0
  68. data/sig/spotted/models/me/player_transfer_params.rbs +7 -1
  69. data/sig/spotted/models/me/show_remove_params.rbs +8 -1
  70. data/sig/spotted/models/me/show_save_params.rbs +8 -1
  71. data/sig/spotted/models/me/track_remove_params.rbs +8 -1
  72. data/sig/spotted/models/me/track_save_params.rbs +7 -0
  73. data/sig/spotted/models/playlist_update_params.rbs +13 -1
  74. data/sig/spotted/models/playlists/follower_follow_params.rbs +8 -1
  75. data/sig/spotted/models/playlists/track_add_params.rbs +7 -1
  76. data/sig/spotted/models/playlists/track_remove_params.rbs +7 -0
  77. data/sig/spotted/models/playlists/track_update_params.rbs +7 -0
  78. data/sig/spotted/models/users/playlist_create_params.rbs +13 -1
  79. data/sig/spotted/resources/me/albums.rbs +2 -0
  80. data/sig/spotted/resources/me/episodes.rbs +2 -0
  81. data/sig/spotted/resources/me/following.rbs +2 -0
  82. data/sig/spotted/resources/me/player.rbs +2 -0
  83. data/sig/spotted/resources/me/shows.rbs +2 -0
  84. data/sig/spotted/resources/me/tracks.rbs +2 -0
  85. data/sig/spotted/resources/playlists/followers.rbs +1 -0
  86. data/sig/spotted/resources/playlists/tracks.rbs +3 -0
  87. data/sig/spotted/resources/playlists.rbs +1 -0
  88. data/sig/spotted/resources/users/playlists.rbs +1 -0
  89. metadata +1 -1
@@ -67,10 +67,12 @@ module Spotted
67
67
  # Add the current user as a follower of one or more artists or other Spotify
68
68
  # users.
69
69
  #
70
- # @overload follow(ids:, request_options: {})
70
+ # @overload follow(ids:, published: nil, request_options: {})
71
71
  #
72
72
  # @param ids [Array<String>] A JSON array of the artist or user [Spotify IDs](/documentation/web-api/concepts
73
73
  #
74
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
75
+ #
74
76
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
75
77
  #
76
78
  # @return [nil]
@@ -87,10 +89,12 @@ module Spotted
87
89
  # Remove the current user as a follower of one or more artists or other Spotify
88
90
  # users.
89
91
  #
90
- # @overload unfollow(ids: nil, request_options: {})
92
+ # @overload unfollow(ids: nil, published: nil, request_options: {})
91
93
  #
92
94
  # @param ids [Array<String>] A JSON array of the artist or user [Spotify IDs](/documentation/web-api/concepts
93
95
  #
96
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
97
+ #
94
98
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
95
99
  #
96
100
  # @return [nil]
@@ -287,7 +287,7 @@ module Spotted
287
287
  # API only works for users who have Spotify Premium. The order of execution is not
288
288
  # guaranteed when you use this API with other Player API endpoints.
289
289
  #
290
- # @overload start_playback(device_id: nil, context_uri: nil, offset: nil, position_ms: nil, uris: nil, request_options: {})
290
+ # @overload start_playback(device_id: nil, context_uri: nil, offset: nil, position_ms: nil, published: nil, uris: nil, request_options: {})
291
291
  #
292
292
  # @param device_id [String] Query param: The id of the device this command is targeting. If not supplied, th
293
293
  #
@@ -297,6 +297,8 @@ module Spotted
297
297
  #
298
298
  # @param position_ms [Integer] Body param: Indicates from what position to start playback. Must be a positive n
299
299
  #
300
+ # @param published [Boolean] Body param: The playlist's public/private status (if it should be added to the u
301
+ #
300
302
  # @param uris [Array<String>] Body param: Optional. A JSON array of the Spotify track URIs to play.
301
303
  #
302
304
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -353,12 +355,14 @@ module Spotted
353
355
  # works for users who have Spotify Premium. The order of execution is not
354
356
  # guaranteed when you use this API with other Player API endpoints.
355
357
  #
356
- # @overload transfer(device_ids:, play: nil, request_options: {})
358
+ # @overload transfer(device_ids:, play: nil, published: nil, request_options: {})
357
359
  #
358
360
  # @param device_ids [Array<String>] A JSON array containing the ID of the device on which playback should be started
359
361
  #
360
362
  # @param play [Boolean] **true**: ensure playback happens on new device.<br/>**false** or not provided:
361
363
  #
364
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
365
+ #
362
366
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
363
367
  #
364
368
  # @return [nil]
@@ -64,10 +64,12 @@ module Spotted
64
64
  #
65
65
  # Delete one or more shows from current Spotify user's library.
66
66
  #
67
- # @overload remove(ids: nil, request_options: {})
67
+ # @overload remove(ids: nil, published: nil, request_options: {})
68
68
  #
69
69
  # @param ids [Array<String>] A JSON array of the [Spotify IDs](https://developer.spotify.com/documentation/we
70
70
  #
71
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
72
+ #
71
73
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
72
74
  #
73
75
  # @return [nil]
@@ -83,10 +85,12 @@ module Spotted
83
85
  #
84
86
  # Save one or more shows to current Spotify user's library.
85
87
  #
86
- # @overload save(ids: nil, request_options: {})
88
+ # @overload save(ids: nil, published: nil, request_options: {})
87
89
  #
88
90
  # @param ids [Array<String>] A JSON array of the [Spotify IDs](https://developer.spotify.com/documentation/we
89
91
  #
92
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
93
+ #
90
94
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
91
95
  #
92
96
  # @return [nil]
@@ -66,10 +66,12 @@ module Spotted
66
66
  #
67
67
  # Remove one or more tracks from the current user's 'Your Music' library.
68
68
  #
69
- # @overload remove(ids: nil, request_options: {})
69
+ # @overload remove(ids: nil, published: nil, request_options: {})
70
70
  #
71
71
  # @param ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
72
72
  #
73
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
74
+ #
73
75
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
74
76
  #
75
77
  # @return [nil]
@@ -85,10 +87,12 @@ module Spotted
85
87
  #
86
88
  # Save one or more tracks to the current user's 'Your Music' library.
87
89
  #
88
- # @overload save(ids:, timestamped_ids: nil, request_options: {})
90
+ # @overload save(ids:, published: nil, timestamped_ids: nil, request_options: {})
89
91
  #
90
92
  # @param ids [Array<String>] A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-i
91
93
  #
94
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
95
+ #
92
96
  # @param timestamped_ids [Array<Spotted::Models::Me::TrackSaveParams::TimestampedID>] A JSON array of objects containing track IDs with their corresponding timestamps
93
97
  #
94
98
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -36,12 +36,14 @@ module Spotted
36
36
  #
37
37
  # Add the current user as a follower of a playlist.
38
38
  #
39
- # @overload follow(playlist_id, public: nil, request_options: {})
39
+ # @overload follow(playlist_id, public: nil, published: 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
43
  # @param public [Boolean] Defaults to `true`. If `true` the playlist will be included in user's public pla
44
44
  #
45
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
46
+ #
45
47
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
46
48
  #
47
49
  # @return [nil]
@@ -17,12 +17,14 @@ module Spotted
17
17
  # have different parameters. These operations can't be applied together in a
18
18
  # single request.
19
19
  #
20
- # @overload update(playlist_id, insert_before: nil, range_length: nil, range_start: nil, snapshot_id: nil, uris: nil, request_options: {})
20
+ # @overload update(playlist_id, insert_before: nil, published: nil, range_length: nil, range_start: nil, snapshot_id: nil, uris: nil, request_options: {})
21
21
  #
22
22
  # @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
23
23
  #
24
24
  # @param insert_before [Integer] The position where the items should be inserted.<br/>To reorder the items to the
25
25
  #
26
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
27
+ #
26
28
  # @param range_length [Integer] The amount of items to be reordered. Defaults to 1 if not set.<br/>The range of
27
29
  #
28
30
  # @param range_start [Integer] The position of the first item to be reordered.
@@ -88,12 +90,14 @@ module Spotted
88
90
  #
89
91
  # Add one or more items to a user's playlist.
90
92
  #
91
- # @overload add(playlist_id, position: nil, uris: nil, request_options: {})
93
+ # @overload add(playlist_id, position: nil, published: nil, uris: nil, request_options: {})
92
94
  #
93
95
  # @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
94
96
  #
95
97
  # @param position [Integer] The position to insert the items, a zero-based index. For example, to insert the
96
98
  #
99
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
100
+ #
97
101
  # @param uris [Array<String>] A JSON array of the [Spotify URIs](/documentation/web-api/concepts/spotify-uris-
98
102
  #
99
103
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -117,12 +121,14 @@ module Spotted
117
121
  #
118
122
  # Remove one or more items from a user's playlist.
119
123
  #
120
- # @overload remove(playlist_id, tracks:, snapshot_id: nil, request_options: {})
124
+ # @overload remove(playlist_id, tracks:, published: nil, snapshot_id: nil, request_options: {})
121
125
  #
122
126
  # @param playlist_id [String] The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) of the playli
123
127
  #
124
128
  # @param tracks [Array<Spotted::Models::Playlists::TrackRemoveParams::Track>] An array of objects containing [Spotify URIs](/documentation/web-api/concepts/sp
125
129
  #
130
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
131
+ #
126
132
  # @param snapshot_id [String] The playlist's snapshot ID against which you want to make the changes.
127
133
  #
128
134
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -49,7 +49,7 @@ 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, collaborative: nil, description: nil, name: nil, public: nil, request_options: {})
52
+ # @overload update(playlist_id, collaborative: nil, description: nil, name: nil, public: nil, published: 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
  #
@@ -61,6 +61,8 @@ module Spotted
61
61
  #
62
62
  # @param public [Boolean] The playlist's public/private status (if it should be added to the user's profil
63
63
  #
64
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
65
+ #
64
66
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
65
67
  #
66
68
  # @return [nil]
@@ -11,7 +11,7 @@ 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:, collaborative: nil, description: nil, public: nil, request_options: {})
14
+ # @overload create(user_id, name:, collaborative: nil, description: nil, public: nil, published: 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
  #
@@ -24,6 +24,8 @@ module Spotted
24
24
  #
25
25
  # @param public [Boolean] Defaults to `true`. The playlist's public/private status (if it should be added
26
26
  #
27
+ # @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
28
+ #
27
29
  # @param request_options [Spotted::RequestOptions, Hash{Symbol=>Object}, nil]
28
30
  #
29
31
  # @return [Spotted::Models::Users::PlaylistCreateResponse]
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Spotted
4
- VERSION = "0.25.0"
4
+ VERSION = "0.26.0"
5
5
  end
@@ -23,9 +23,21 @@ module Spotted
23
23
  sig { params(ids: T::Array[String]).void }
24
24
  attr_writer :ids
25
25
 
26
+ # The playlist's public/private status (if it should be added to the user's
27
+ # profile or not): `true` the playlist will be public, `false` the playlist will
28
+ # be private, `null` the playlist status is not relevant. For more about
29
+ # public/private status, see
30
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
31
+ sig { returns(T.nilable(T::Boolean)) }
32
+ attr_reader :published
33
+
34
+ sig { params(published: T::Boolean).void }
35
+ attr_writer :published
36
+
26
37
  sig do
27
38
  params(
28
39
  ids: T::Array[String],
40
+ published: T::Boolean,
29
41
  request_options: Spotted::RequestOptions::OrHash
30
42
  ).returns(T.attached_class)
31
43
  end
@@ -36,13 +48,23 @@ module Spotted
36
48
  # can be specified in one request. _**Note**: if the `ids` parameter is present in
37
49
  # the query string, any IDs listed here in the body will be ignored._
38
50
  ids: nil,
51
+ # The playlist's public/private status (if it should be added to the user's
52
+ # profile or not): `true` the playlist will be public, `false` the playlist will
53
+ # be private, `null` the playlist status is not relevant. For more about
54
+ # public/private status, see
55
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
56
+ published: nil,
39
57
  request_options: {}
40
58
  )
41
59
  end
42
60
 
43
61
  sig do
44
62
  override.returns(
45
- { ids: T::Array[String], request_options: Spotted::RequestOptions }
63
+ {
64
+ ids: T::Array[String],
65
+ published: T::Boolean,
66
+ request_options: Spotted::RequestOptions
67
+ }
46
68
  )
47
69
  end
48
70
  def to_hash
@@ -23,9 +23,21 @@ module Spotted
23
23
  sig { params(ids: T::Array[String]).void }
24
24
  attr_writer :ids
25
25
 
26
+ # The playlist's public/private status (if it should be added to the user's
27
+ # profile or not): `true` the playlist will be public, `false` the playlist will
28
+ # be private, `null` the playlist status is not relevant. For more about
29
+ # public/private status, see
30
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
31
+ sig { returns(T.nilable(T::Boolean)) }
32
+ attr_reader :published
33
+
34
+ sig { params(published: T::Boolean).void }
35
+ attr_writer :published
36
+
26
37
  sig do
27
38
  params(
28
39
  ids: T::Array[String],
40
+ published: T::Boolean,
29
41
  request_options: Spotted::RequestOptions::OrHash
30
42
  ).returns(T.attached_class)
31
43
  end
@@ -36,13 +48,23 @@ module Spotted
36
48
  # can be specified in one request. _**Note**: if the `ids` parameter is present in
37
49
  # the query string, any IDs listed here in the body will be ignored._
38
50
  ids: nil,
51
+ # The playlist's public/private status (if it should be added to the user's
52
+ # profile or not): `true` the playlist will be public, `false` the playlist will
53
+ # be private, `null` the playlist status is not relevant. For more about
54
+ # public/private status, see
55
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
56
+ published: nil,
39
57
  request_options: {}
40
58
  )
41
59
  end
42
60
 
43
61
  sig do
44
62
  override.returns(
45
- { ids: T::Array[String], request_options: Spotted::RequestOptions }
63
+ {
64
+ ids: T::Array[String],
65
+ published: T::Boolean,
66
+ request_options: Spotted::RequestOptions
67
+ }
46
68
  )
47
69
  end
48
70
  def to_hash
@@ -23,9 +23,21 @@ module Spotted
23
23
  sig { params(ids: T::Array[String]).void }
24
24
  attr_writer :ids
25
25
 
26
+ # The playlist's public/private status (if it should be added to the user's
27
+ # profile or not): `true` the playlist will be public, `false` the playlist will
28
+ # be private, `null` the playlist status is not relevant. For more about
29
+ # public/private status, see
30
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
31
+ sig { returns(T.nilable(T::Boolean)) }
32
+ attr_reader :published
33
+
34
+ sig { params(published: T::Boolean).void }
35
+ attr_writer :published
36
+
26
37
  sig do
27
38
  params(
28
39
  ids: T::Array[String],
40
+ published: T::Boolean,
29
41
  request_options: Spotted::RequestOptions::OrHash
30
42
  ).returns(T.attached_class)
31
43
  end
@@ -36,13 +48,23 @@ module Spotted
36
48
  # is present in the query string, any IDs listed here in the body will be
37
49
  # ignored._
38
50
  ids: nil,
51
+ # The playlist's public/private status (if it should be added to the user's
52
+ # profile or not): `true` the playlist will be public, `false` the playlist will
53
+ # be private, `null` the playlist status is not relevant. For more about
54
+ # public/private status, see
55
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
56
+ published: nil,
39
57
  request_options: {}
40
58
  )
41
59
  end
42
60
 
43
61
  sig do
44
62
  override.returns(
45
- { ids: T::Array[String], request_options: Spotted::RequestOptions }
63
+ {
64
+ ids: T::Array[String],
65
+ published: T::Boolean,
66
+ request_options: Spotted::RequestOptions
67
+ }
46
68
  )
47
69
  end
48
70
  def to_hash
@@ -20,9 +20,21 @@ module Spotted
20
20
  sig { returns(T::Array[String]) }
21
21
  attr_accessor :ids
22
22
 
23
+ # The playlist's public/private status (if it should be added to the user's
24
+ # profile or not): `true` the playlist will be public, `false` the playlist will
25
+ # be private, `null` the playlist status is not relevant. For more about
26
+ # public/private status, see
27
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
28
+ sig { returns(T.nilable(T::Boolean)) }
29
+ attr_reader :published
30
+
31
+ sig { params(published: T::Boolean).void }
32
+ attr_writer :published
33
+
23
34
  sig do
24
35
  params(
25
36
  ids: T::Array[String],
37
+ published: T::Boolean,
26
38
  request_options: Spotted::RequestOptions::OrHash
27
39
  ).returns(T.attached_class)
28
40
  end
@@ -33,13 +45,23 @@ module Spotted
33
45
  # is present in the query string, any IDs listed here in the body will be
34
46
  # ignored._
35
47
  ids:,
48
+ # The playlist's public/private status (if it should be added to the user's
49
+ # profile or not): `true` the playlist will be public, `false` the playlist will
50
+ # be private, `null` the playlist status is not relevant. For more about
51
+ # public/private status, see
52
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
53
+ published: nil,
36
54
  request_options: {}
37
55
  )
38
56
  end
39
57
 
40
58
  sig do
41
59
  override.returns(
42
- { ids: T::Array[String], request_options: Spotted::RequestOptions }
60
+ {
61
+ ids: T::Array[String],
62
+ published: T::Boolean,
63
+ request_options: Spotted::RequestOptions
64
+ }
43
65
  )
44
66
  end
45
67
  def to_hash
@@ -23,9 +23,21 @@ module Spotted
23
23
  sig { returns(T::Array[String]) }
24
24
  attr_accessor :ids
25
25
 
26
+ # The playlist's public/private status (if it should be added to the user's
27
+ # profile or not): `true` the playlist will be public, `false` the playlist will
28
+ # be private, `null` the playlist status is not relevant. For more about
29
+ # public/private status, see
30
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
31
+ sig { returns(T.nilable(T::Boolean)) }
32
+ attr_reader :published
33
+
34
+ sig { params(published: T::Boolean).void }
35
+ attr_writer :published
36
+
26
37
  sig do
27
38
  params(
28
39
  ids: T::Array[String],
40
+ published: T::Boolean,
29
41
  request_options: Spotted::RequestOptions::OrHash
30
42
  ).returns(T.attached_class)
31
43
  end
@@ -36,13 +48,23 @@ module Spotted
36
48
  # IDs can be sent in one request. _**Note**: if the `ids` parameter is present in
37
49
  # the query string, any IDs listed here in the body will be ignored._
38
50
  ids:,
51
+ # The playlist's public/private status (if it should be added to the user's
52
+ # profile or not): `true` the playlist will be public, `false` the playlist will
53
+ # be private, `null` the playlist status is not relevant. For more about
54
+ # public/private status, see
55
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
56
+ published: nil,
39
57
  request_options: {}
40
58
  )
41
59
  end
42
60
 
43
61
  sig do
44
62
  override.returns(
45
- { ids: T::Array[String], request_options: Spotted::RequestOptions }
63
+ {
64
+ ids: T::Array[String],
65
+ published: T::Boolean,
66
+ request_options: Spotted::RequestOptions
67
+ }
46
68
  )
47
69
  end
48
70
  def to_hash
@@ -26,9 +26,21 @@ module Spotted
26
26
  sig { params(ids: T::Array[String]).void }
27
27
  attr_writer :ids
28
28
 
29
+ # The playlist's public/private status (if it should be added to the user's
30
+ # profile or not): `true` the playlist will be public, `false` the playlist will
31
+ # be private, `null` the playlist status is not relevant. For more about
32
+ # public/private status, see
33
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
34
+ sig { returns(T.nilable(T::Boolean)) }
35
+ attr_reader :published
36
+
37
+ sig { params(published: T::Boolean).void }
38
+ attr_writer :published
39
+
29
40
  sig do
30
41
  params(
31
42
  ids: T::Array[String],
43
+ published: T::Boolean,
32
44
  request_options: Spotted::RequestOptions::OrHash
33
45
  ).returns(T.attached_class)
34
46
  end
@@ -39,13 +51,23 @@ module Spotted
39
51
  # IDs can be sent in one request. _**Note**: if the `ids` parameter is present in
40
52
  # the query string, any IDs listed here in the body will be ignored._
41
53
  ids: nil,
54
+ # The playlist's public/private status (if it should be added to the user's
55
+ # profile or not): `true` the playlist will be public, `false` the playlist will
56
+ # be private, `null` the playlist status is not relevant. For more about
57
+ # public/private status, see
58
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
59
+ published: nil,
42
60
  request_options: {}
43
61
  )
44
62
  end
45
63
 
46
64
  sig do
47
65
  override.returns(
48
- { ids: T::Array[String], request_options: Spotted::RequestOptions }
66
+ {
67
+ ids: T::Array[String],
68
+ published: T::Boolean,
69
+ request_options: Spotted::RequestOptions
70
+ }
49
71
  )
50
72
  end
51
73
  def to_hash
@@ -51,6 +51,17 @@ module Spotted
51
51
  sig { params(position_ms: Integer).void }
52
52
  attr_writer :position_ms
53
53
 
54
+ # The playlist's public/private status (if it should be added to the user's
55
+ # profile or not): `true` the playlist will be public, `false` the playlist will
56
+ # be private, `null` the playlist status is not relevant. For more about
57
+ # public/private status, see
58
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
59
+ sig { returns(T.nilable(T::Boolean)) }
60
+ attr_reader :published
61
+
62
+ sig { params(published: T::Boolean).void }
63
+ attr_writer :published
64
+
54
65
  # Optional. A JSON array of the Spotify track URIs to play. For example:
55
66
  # `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "spotify:track:1301WleyT98MSxVHPZCA6M"]}`
56
67
  sig { returns(T.nilable(T::Array[String])) }
@@ -65,6 +76,7 @@ module Spotted
65
76
  context_uri: String,
66
77
  offset: T::Hash[Symbol, T.anything],
67
78
  position_ms: Integer,
79
+ published: T::Boolean,
68
80
  uris: T::Array[String],
69
81
  request_options: Spotted::RequestOptions::OrHash
70
82
  ).returns(T.attached_class)
@@ -86,6 +98,12 @@ module Spotted
86
98
  # Passing in a position that is greater than the length of the track will cause
87
99
  # the player to start playing the next song.
88
100
  position_ms: nil,
101
+ # The playlist's public/private status (if it should be added to the user's
102
+ # profile or not): `true` the playlist will be public, `false` the playlist will
103
+ # be private, `null` the playlist status is not relevant. For more about
104
+ # public/private status, see
105
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
106
+ published: nil,
89
107
  # Optional. A JSON array of the Spotify track URIs to play. For example:
90
108
  # `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "spotify:track:1301WleyT98MSxVHPZCA6M"]}`
91
109
  uris: nil,
@@ -100,6 +118,7 @@ module Spotted
100
118
  context_uri: String,
101
119
  offset: T::Hash[Symbol, T.anything],
102
120
  position_ms: Integer,
121
+ published: T::Boolean,
103
122
  uris: T::Array[String],
104
123
  request_options: Spotted::RequestOptions
105
124
  }
@@ -28,10 +28,22 @@ module Spotted
28
28
  sig { params(play: T::Boolean).void }
29
29
  attr_writer :play
30
30
 
31
+ # The playlist's public/private status (if it should be added to the user's
32
+ # profile or not): `true` the playlist will be public, `false` the playlist will
33
+ # be private, `null` the playlist status is not relevant. For more about
34
+ # public/private status, see
35
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
36
+ sig { returns(T.nilable(T::Boolean)) }
37
+ attr_reader :published
38
+
39
+ sig { params(published: T::Boolean).void }
40
+ attr_writer :published
41
+
31
42
  sig do
32
43
  params(
33
44
  device_ids: T::Array[String],
34
45
  play: T::Boolean,
46
+ published: T::Boolean,
35
47
  request_options: Spotted::RequestOptions::OrHash
36
48
  ).returns(T.attached_class)
37
49
  end
@@ -45,6 +57,12 @@ module Spotted
45
57
  # **true**: ensure playback happens on new device.<br/>**false** or not provided:
46
58
  # keep the current playback state.
47
59
  play: nil,
60
+ # The playlist's public/private status (if it should be added to the user's
61
+ # profile or not): `true` the playlist will be public, `false` the playlist will
62
+ # be private, `null` the playlist status is not relevant. For more about
63
+ # public/private status, see
64
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
65
+ published: nil,
48
66
  request_options: {}
49
67
  )
50
68
  end
@@ -54,6 +72,7 @@ module Spotted
54
72
  {
55
73
  device_ids: T::Array[String],
56
74
  play: T::Boolean,
75
+ published: T::Boolean,
57
76
  request_options: Spotted::RequestOptions
58
77
  }
59
78
  )
@@ -23,9 +23,21 @@ module Spotted
23
23
  sig { params(ids: T::Array[String]).void }
24
24
  attr_writer :ids
25
25
 
26
+ # The playlist's public/private status (if it should be added to the user's
27
+ # profile or not): `true` the playlist will be public, `false` the playlist will
28
+ # be private, `null` the playlist status is not relevant. For more about
29
+ # public/private status, see
30
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
31
+ sig { returns(T.nilable(T::Boolean)) }
32
+ attr_reader :published
33
+
34
+ sig { params(published: T::Boolean).void }
35
+ attr_writer :published
36
+
26
37
  sig do
27
38
  params(
28
39
  ids: T::Array[String],
40
+ published: T::Boolean,
29
41
  request_options: Spotted::RequestOptions::OrHash
30
42
  ).returns(T.attached_class)
31
43
  end
@@ -36,13 +48,23 @@ module Spotted
36
48
  # parameter is present in the query string, any IDs listed here in the body will
37
49
  # be ignored._
38
50
  ids: nil,
51
+ # The playlist's public/private status (if it should be added to the user's
52
+ # profile or not): `true` the playlist will be public, `false` the playlist will
53
+ # be private, `null` the playlist status is not relevant. For more about
54
+ # public/private status, see
55
+ # [Working with Playlists](/documentation/web-api/concepts/playlists)
56
+ published: nil,
39
57
  request_options: {}
40
58
  )
41
59
  end
42
60
 
43
61
  sig do
44
62
  override.returns(
45
- { ids: T::Array[String], request_options: Spotted::RequestOptions }
63
+ {
64
+ ids: T::Array[String],
65
+ published: T::Boolean,
66
+ request_options: Spotted::RequestOptions
67
+ }
46
68
  )
47
69
  end
48
70
  def to_hash