Class: Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook

Inherits:
Spotted::Models::AudiobookBase show all
Defined in:
lib/spotted/models/audiobook_bulk_retrieve_response.rb

Defined Under Namespace

Classes: Chapters

Instance Attribute Summary collapse

Attributes inherited from Spotted::Models::AudiobookBase

#authors, #available_markets, #copyrights, #description, #edition, #explicit, #external_urls, #href, #html_description, #id, #images, #languages, #media_type, #name, #narrators, #published, #publisher, #total_chapters, #type, #uri

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(audiobooks:) ⇒ Object

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/spotted/models/audiobook_bulk_retrieve_response.rb', line 16

class Audiobook < Spotted::Models::AudiobookBase
  # @!attribute chapters
  #   The chapters of the audiobook.
  #
  #   @return [Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook::Chapters]
  required :chapters, -> { Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook::Chapters }

  # @!method initialize(chapters:)
  #   Some parameter documentations has been truncated, see
  #   {Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook} for more details.
  #
  #   @param chapters [Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook::Chapters] The chapters of the audiobook.

  class Chapters < Spotted::Internal::Type::BaseModel
    # @!attribute href
    #   A link to the Web API endpoint returning the full result of the request
    #
    #   @return [String]
    required :href, String

    # @!attribute limit
    #   The maximum number of items in the response (as set in the query or by default).
    #
    #   @return [Integer]
    required :limit, Integer

    # @!attribute next_
    #   URL to the next page of items. ( `null` if none)
    #
    #   @return [String, nil]
    required :next_, String, api_name: :next, nil?: true

    # @!attribute offset
    #   The offset of the items returned (as set in the query or by default)
    #
    #   @return [Integer]
    required :offset, Integer

    # @!attribute previous
    #   URL to the previous page of items. ( `null` if none)
    #
    #   @return [String, nil]
    required :previous, String, nil?: true

    # @!attribute total
    #   The total number of items available to return.
    #
    #   @return [Integer]
    required :total, Integer

    # @!attribute items
    #
    #   @return [Array<Spotted::Models::SimplifiedChapterObject>, nil]
    optional :items, -> { Spotted::Internal::Type::ArrayOf[Spotted::SimplifiedChapterObject] }

    # @!attribute published
    #   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)
    #
    #   @return [Boolean, nil]
    optional :published, Spotted::Internal::Type::Boolean

    # @!method initialize(href:, limit:, next_:, offset:, previous:, total:, items: nil, published: nil)
    #   Some parameter documentations has been truncated, see
    #   {Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook::Chapters} for more
    #   details.
    #
    #   The chapters of the audiobook.
    #
    #   @param href [String] A link to the Web API endpoint returning the full result of the request
    #
    #   @param limit [Integer] The maximum number of items in the response (as set in the query or by default).
    #
    #   @param next_ [String, nil] URL to the next page of items. ( `null` if none)
    #
    #   @param offset [Integer] The offset of the items returned (as set in the query or by default)
    #
    #   @param previous [String, nil] URL to the previous page of items. ( `null` if none)
    #
    #   @param total [Integer] The total number of items available to return.
    #
    #   @param items [Array<Spotted::Models::SimplifiedChapterObject>]
    #
    #   @param published [Boolean] The playlist's public/private status (if it should be added to the user's profil
  end
end

Instance Attribute Details

#chapters ⇒ Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook::Chapters

The chapters of the audiobook.

Returns:



21
 
# File 'lib/spotted/models/audiobook_bulk_retrieve_response.rb', line 21

required :chapters, -> { Spotted::Models::AudiobookBulkRetrieveResponse::Audiobook::Chapters }