Class: Spotted::Models::Me::FollowingUnfollowParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Spotted::Models::Me::FollowingUnfollowParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/spotted/models/me/following_unfollow_params.rb

Overview

See Also:

• Resources::Me::Following#unfollow

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #body_ids ⇒ Array<String>^?

  A JSON array of the artist or user [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids).

• #type ⇒ Symbol, Spotted::Models::Me::FollowingUnfollowParams::Type

  The ID type: either ‘artist` or `user`.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(type: , body_ids: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see FollowingUnfollowParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(type: , body_ids: nil, request_options: {}) ⇒ Object

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

Parameters:

• type (Symbol, Spotted::Models::Me::FollowingUnfollowParams::Type) (defaults to: ) —

  The ID type: either ‘artist` or `user`.

• body_ids (Array<String>) (defaults to: nil) —

  A JSON array of the artist or user [Spotify IDs](/documentation/web-api/concepts

• request_options (Spotted::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/spotted/models/me/following_unfollow_params.rb', line 27

Instance Attribute Details

#body_ids ⇒ Array<String>^?

A JSON array of the artist or user [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: ‘“08td7MxkoHQkXnWAYD8d6Q”]`. A maximum of 50 IDs can be sent in one request. _Note: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._

Returns:

• (Array<String>, nil)

# File 'lib/spotted/models/me/following_unfollow_params.rb', line 19

optional :body_ids, Spotted::Internal::Type::ArrayOf[String], api_name: :ids

#type ⇒ Symbol, Spotted::Models::Me::FollowingUnfollowParams::Type

The ID type: either ‘artist` or `user`.

Returns:

• (Symbol, Spotted::Models::Me::FollowingUnfollowParams::Type)

# File 'lib/spotted/models/me/following_unfollow_params.rb', line 25

required :type, enum: -> { Spotted::Me::FollowingUnfollowParams::Type }