Class: Spotted::Models::MeRetrieveResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/spotted/models/me_retrieve_response.rb

Overview

See Also:

Defined Under Namespace

Classes: ExplicitContent

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id: nil, country: nil, display_name: nil, email: nil, explicit_content: nil, external_urls: nil, followers: nil, href: nil, images: nil, product: nil, published: nil, type: nil, uri: nil) ⇒ Object

Some parameter documentations has been truncated, see Spotted::Models::MeRetrieveResponse for more details.

_*

cur

Parameters:

  • id (String) (defaults to: nil) —

    The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for the

  • country (String) (defaults to: nil) —

    The country of the user, as set in the user’s account profile. An [ISO 3166-1 al

  • display_name (String) (defaults to: nil) —

    The name displayed on the user’s profile. ‘null` if not available.

  • email (String) (defaults to: nil) —

    The user’s email address, as entered by the user when creating their account.

  • explicit_content (Spotted::Models::MeRetrieveResponse::ExplicitContent) (defaults to: nil) —

    The user’s explicit content settings. _This field is only available when the

  • external_urls (Spotted::Models::ExternalURLObject) (defaults to: nil) —

    Known external URLs for this user.

  • followers (Spotted::Models::FollowersObject) (defaults to: nil) —

    Information about the followers of the user.

  • href (String) (defaults to: nil) —

    A link to the Web API endpoint for this user.

  • images (Array<Spotted::Models::ImageObject>) (defaults to: nil) —

    The user’s profile image.

  • product (String) (defaults to: nil) —

    The user’s Spotify subscription level: “premium”, “free”, etc. (The subscription

  • published (Boolean) (defaults to: nil) —

    The playlist’s public/private status (if it should be added to the user’s profil

  • type (String) (defaults to: nil) —

    The object type: “user”

  • uri (String) (defaults to: nil) —

    The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the user




# File 'lib/spotted/models/me_retrieve_response.rb', line 107

Instance Attribute Details

#country ⇒ String?

The country of the user, as set in the user’s account profile. An [ISO 3166-1 alpha-2 country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2). _This field is only available when the current user has granted access to the [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes) scope._

Returns:

  • (String, nil) 


22
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 22

optional :country, String

#display_name ⇒ String?

The name displayed on the user’s profile. ‘null` if not available.

Returns:

  • (String, nil) 


28
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 28

optional :display_name, String

#email ⇒ String?

The user’s email address, as entered by the user when creating their account. _**Important!** This email address is unverified; there is no proof that it actually belongs to the user._ _This field is only available when the current user has granted access to the [user-read-email](/documentation/web-api/concepts/scopes/#list-of-scopes) scope._

Returns:

  • (String, nil) 


39
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 39

optional :email, String

#explicit_content ⇒ Spotted::Models::MeRetrieveResponse::ExplicitContent?

The user’s explicit content settings. _This field is only available when the current user has granted access to the [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes) scope._

Returns:



48
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 48

optional :explicit_content, -> { Spotted::Models::MeRetrieveResponse::ExplicitContent }

#external_urls ⇒ Spotted::Models::ExternalURLObject?

Known external URLs for this user.

Returns:



54
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 54

optional :external_urls, -> { Spotted::ExternalURLObject }

#followers ⇒ Spotted::Models::FollowersObject?

Information about the followers of the user.

Returns:



60
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 60

optional :followers, -> { Spotted::FollowersObject }

#href ⇒ String?

A link to the Web API endpoint for this user.

Returns:

  • (String, nil) 


66
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 66

optional :href, String

#id ⇒ String?

The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids) for the user.

Returns:

  • (String, nil) 


12
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 12

optional :id, String

#images ⇒ Array<Spotted::Models::ImageObject>?

The user’s profile image.

Returns:



72
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 72

optional :images, -> { Spotted::Internal::Type::ArrayOf[Spotted::ImageObject] }

#product ⇒ String?

The user’s Spotify subscription level: “premium”, “free”, etc. (The subscription level “open” can be considered the same as “free”.) _This field is only available when the current user has granted access to the [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes) scope._

Returns:

  • (String, nil) 


82
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 82

optional :product, String

#published ⇒ Boolean?

The playlist’s public/private status (if it should be added to the user’s profile or not): ‘true` the playlist will be public, `false` the playlist will be private, `null` the playlist status is not relevant. For more about public/private status, see [Working with Playlists](/documentation/web-api/concepts/playlists)

Returns:

  • (Boolean, nil) 


92
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 92

optional :published, Spotted::Internal::Type::Boolean

#type ⇒ String?

The object type: “user”

Returns:

  • (String, nil) 


98
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 98

optional :type, String

#uri ⇒ String?

The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for the user.

Returns:

  • (String, nil) 


105
 
# File 'lib/spotted/models/me_retrieve_response.rb', line 105

optional :uri, String