spotify-apimatic-sdk 1.0.0

data/lib/spotify_web_api/models/users_playlists_request.rb

@@ -0,0 +1,101 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # UsersPlaylistsRequest Model.
+  class UsersPlaylistsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name for the new playlist, for example `"Your Coolest Playlist"`. This
+    # name does not need to be unique; a user may have several playlists with
+    # the same name.
+    # @return [String]
+    attr_accessor :name
+
+    # Defaults to `true`. If `true` the playlist will be public, if `false` it
+    # will be private. To be able to create private playlists, the user must
+    # have granted the `playlist-modify-private`
+    # [scope](/documentation/web-api/concepts/scopes/#list-of-scopes)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :public
+
+    # Defaults to `false`. If `true` the playlist will be collaborative.
+    # _**Note**: to create a collaborative playlist you must also set `public`
+    # to `false`. To create collaborative playlists you must have granted
+    # `playlist-modify-private` and `playlist-modify-public`
+    # [scopes](/documentation/web-api/concepts/scopes/#list-of-scopes)._
+    # @return [TrueClass | FalseClass]
+    attr_accessor :collaborative
+
+    # value for playlist description as displayed in Spotify Clients and in the
+    # Web API.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['public'] = 'public'
+      @_hash['collaborative'] = 'collaborative'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        public
+        collaborative
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, public = SKIP, collaborative = SKIP,
+                   description = SKIP)
+      @name = name
+      @public = public unless public == SKIP
+      @collaborative = collaborative unless collaborative == SKIP
+      @description = description unless description == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      public = hash.key?('public') ? hash['public'] : SKIP
+      collaborative = hash.key?('collaborative') ? hash['collaborative'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      UsersPlaylistsRequest.new(name,
+                                public,
+                                collaborative,
+                                description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, public: #{@public}, collaborative: #{@collaborative},"\
+      " description: #{@description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, public: #{@public.inspect}, collaborative:"\
+      " #{@collaborative.inspect}, description: #{@description.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module SpotifyWebApi
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/spotify_web_api/utilities/file_wrapper.rb

@@ -0,0 +1,28 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file}, content_type: #{@content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def to_inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file.inspect}, content_type: #{@content_type.inspect}>"
+    end
+  end
+end

data/lib/spotify_web_api/utilities/union_type_lookup.rb

@@ -0,0 +1,73 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module SpotifyWebApi
+  # The `UnionTypeLookUp` class serves as a utility class for
+  # storing and managing type combinator templates. It acts as a container for the templates
+  # used in handling various oneof/anyof instances within the sdk.
+  class UnionTypeLookUp
+    include CoreLibrary
+    # rubocop:disable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+    def self.union_types
+      {
+        :PlaylistTrackObjectTrack => OneOf.new(
+          [
+            LeafType.new(TrackObject),
+            LeafType.new(EpisodeObject)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :QueueObjectCurrentlyPlaying => OneOf.new(
+          [
+            LeafType.new(TrackObject),
+            LeafType.new(EpisodeObject)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :QueueObjectQueue => OneOf.new(
+          [
+            LeafType.new(TrackObject),
+            LeafType.new(EpisodeObject)
+          ],
+          UnionTypeContext.new(
+            is_array: true,
+            is_optional: true
+          )
+        ),
+
+        :CurrentlyPlayingContextObjectItem => OneOf.new(
+          [
+            LeafType.new(TrackObject),
+            LeafType.new(EpisodeObject)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :CurrentlyPlayingObjectItem => OneOf.new(
+          [
+            LeafType.new(TrackObject),
+            LeafType.new(EpisodeObject)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        )
+      }
+    end
+    # rubocop:enable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+
+    def self.get(name)
+      UnionTypeLookUp.union_types[name]
+    end
+  end
+end

data/lib/spotify_web_api.rb

@@ -0,0 +1,200 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+require 'json'
+
+require 'apimatic_core_interfaces'
+require 'apimatic_core'
+require 'apimatic_faraday_client_adapter'
+
+require_relative 'spotify_web_api/api_helper'
+require_relative 'spotify_web_api/client'
+
+# Utilities
+require_relative 'spotify_web_api/utilities/file_wrapper'
+require_relative 'spotify_web_api/utilities/date_time_helper'
+require_relative 'spotify_web_api/utilities/union_type_lookup'
+
+# Http
+require_relative 'spotify_web_api/http/api_response'
+require_relative 'spotify_web_api/http/http_call_back'
+require_relative 'spotify_web_api/http/http_method_enum'
+require_relative 'spotify_web_api/http/http_request'
+require_relative 'spotify_web_api/http/http_response'
+require_relative 'spotify_web_api/http/proxy_settings'
+
+
+require_relative 'spotify_web_api/http/auth/o_auth2'
+
+# Models
+require_relative 'spotify_web_api/models/base_model'
+require_relative 'spotify_web_api/models/linked_track_object'
+require_relative 'spotify_web_api/models/track_restriction_object'
+require_relative 'spotify_web_api/models/album_restriction_object'
+require_relative 'spotify_web_api/models/episode_restriction_object'
+require_relative 'spotify_web_api/models/chapter_restriction_object'
+require_relative 'spotify_web_api/models/artist_object'
+require_relative 'spotify_web_api/models/simplified_artist_object'
+require_relative 'spotify_web_api/models/play_history_object'
+require_relative 'spotify_web_api/models/playlist_track_object'
+require_relative 'spotify_web_api/models/queue_object'
+require_relative 'spotify_web_api/models/currently_playing_context_object'
+require_relative 'spotify_web_api/models/disallows_object'
+require_relative 'spotify_web_api/models/error_object'
+require_relative 'spotify_web_api/models/private_user_object'
+require_relative 'spotify_web_api/models/public_user_object'
+require_relative 'spotify_web_api/models/audio_analysis_object'
+require_relative 'spotify_web_api/models/time_interval_object'
+require_relative 'spotify_web_api/models/section_object'
+require_relative 'spotify_web_api/models/segment_object'
+require_relative 'spotify_web_api/models/audio_features_object'
+require_relative 'spotify_web_api/models/simplified_track_object'
+require_relative 'spotify_web_api/models/device_object'
+require_relative 'spotify_web_api/models/cursor_object'
+require_relative 'spotify_web_api/models/cursor_paging_object'
+require_relative 'spotify_web_api/models/cursor_paging_play_history_object'
+require_relative 'spotify_web_api/models/cursor_paging_simplified_artist_object'
+require_relative 'spotify_web_api/models/paging_object'
+require_relative 'spotify_web_api/models/paging_playlist_object'
+require_relative 'spotify_web_api/models/paging_featured_playlist_object'
+require_relative 'spotify_web_api/models/paging_artist_discography_album_object'
+require_relative 'spotify_web_api/models/paging_simplified_album_object'
+require_relative 'spotify_web_api/models/paging_saved_album_object'
+require_relative 'spotify_web_api/models/paging_simplified_track_object'
+require_relative 'spotify_web_api/models/paging_saved_track_object'
+require_relative 'spotify_web_api/models/paging_track_object'
+require_relative 'spotify_web_api/models/paging_playlist_track_object'
+require_relative 'spotify_web_api/models/paging_simplified_show_object'
+require_relative 'spotify_web_api/models/paging_saved_show_object'
+require_relative 'spotify_web_api/models/paging_simplified_episode_object'
+require_relative 'spotify_web_api/models/paging_saved_episode_object'
+require_relative 'spotify_web_api/models/paging_simplified_audiobook_object'
+require_relative 'spotify_web_api/models/paging_artist_object'
+require_relative 'spotify_web_api/models/paging_simplified_chapter_object'
+require_relative 'spotify_web_api/models/recommendations_object'
+require_relative 'spotify_web_api/models/recommendation_seed_object'
+require_relative 'spotify_web_api/models/saved_album_object'
+require_relative 'spotify_web_api/models/saved_track_object'
+require_relative 'spotify_web_api/models/saved_episode_object'
+require_relative 'spotify_web_api/models/saved_show_object'
+require_relative 'spotify_web_api/models/playlist_object'
+require_relative 'spotify_web_api/models/simplified_playlist_object'
+require_relative 'spotify_web_api/models/playlist_tracks_ref_object'
+require_relative 'spotify_web_api/models/playlist_user_object'
+require_relative 'spotify_web_api/models/playlist_owner_object'
+require_relative 'spotify_web_api/models/category_object'
+require_relative 'spotify_web_api/models/track_object'
+require_relative 'spotify_web_api/models/episode_object'
+require_relative 'spotify_web_api/models/episode_base'
+require_relative 'spotify_web_api/models/resume_point_object'
+require_relative 'spotify_web_api/models/show_base'
+require_relative 'spotify_web_api/models/show_object'
+require_relative 'spotify_web_api/models/audiobook_base'
+require_relative 'spotify_web_api/models/audiobook_object'
+require_relative 'spotify_web_api/models/album_base'
+require_relative 'spotify_web_api/models/simplified_album_object'
+require_relative 'spotify_web_api/models/artist_discography_album_object'
+require_relative 'spotify_web_api/models/chapter_object'
+require_relative 'spotify_web_api/models/chapter_base'
+require_relative 'spotify_web_api/models/album_object'
+require_relative 'spotify_web_api/models/context_object'
+require_relative 'spotify_web_api/models/copyright_object'
+require_relative 'spotify_web_api/models/author_object'
+require_relative 'spotify_web_api/models/narrator_object'
+require_relative 'spotify_web_api/models/external_id_object'
+require_relative 'spotify_web_api/models/external_url_object'
+require_relative 'spotify_web_api/models/followers_object'
+require_relative 'spotify_web_api/models/image_object'
+require_relative 'spotify_web_api/models/explicit_content_settings_object'
+require_relative 'spotify_web_api/models/currently_playing_object'
+require_relative 'spotify_web_api/models/saved_audiobook_object'
+require_relative 'spotify_web_api/models/paging_saved_audiobook_object'
+require_relative 'spotify_web_api/models/categories'
+require_relative 'spotify_web_api/models/cursor_paged_artists'
+require_relative 'spotify_web_api/models/many_albums'
+require_relative 'spotify_web_api/models/many_artists'
+require_relative 'spotify_web_api/models/many_audiobooks'
+require_relative 'spotify_web_api/models/many_audio_features'
+require_relative 'spotify_web_api/models/many_chapters'
+require_relative 'spotify_web_api/models/many_devices'
+require_relative 'spotify_web_api/models/many_episodes'
+require_relative 'spotify_web_api/models/many_genres'
+require_relative 'spotify_web_api/models/many_simplified_shows'
+require_relative 'spotify_web_api/models/many_tracks'
+require_relative 'spotify_web_api/models/markets'
+require_relative 'spotify_web_api/models/me_albums_request'
+require_relative 'spotify_web_api/models/me_episodes_request'
+require_relative 'spotify_web_api/models/me_episodes_request1'
+require_relative 'spotify_web_api/models/me_following_request'
+require_relative 'spotify_web_api/models/me_following_request1'
+require_relative 'spotify_web_api/models/me_player_play_request'
+require_relative 'spotify_web_api/models/me_player_request'
+require_relative 'spotify_web_api/models/me_shows_request'
+require_relative 'spotify_web_api/models/me_tracks_request'
+require_relative 'spotify_web_api/models/me_tracks_request1'
+require_relative 'spotify_web_api/models/meta'
+require_relative 'spotify_web_api/models/paged_albums'
+require_relative 'spotify_web_api/models/paged_categories'
+require_relative 'spotify_web_api/models/playlists_followers_request'
+require_relative 'spotify_web_api/models/playlists_request'
+require_relative 'spotify_web_api/models/playlists_tracks_request'
+require_relative 'spotify_web_api/models/playlists_tracks_request1'
+require_relative 'spotify_web_api/models/playlists_tracks_request2'
+require_relative 'spotify_web_api/models/playlist_snapshot_id'
+require_relative 'spotify_web_api/models/search_items'
+require_relative 'spotify_web_api/models/track'
+require_relative 'spotify_web_api/models/track1'
+require_relative 'spotify_web_api/models/users_playlists_request'
+require_relative 'spotify_web_api/models/o_auth_token'
+require_relative 'spotify_web_api/models/album_group_enum'
+require_relative 'spotify_web_api/models/album_type_enum'
+require_relative 'spotify_web_api/models/include_external_enum'
+require_relative 'spotify_web_api/models/item_type_enum'
+require_relative 'spotify_web_api/models/item_type1_enum'
+require_relative 'spotify_web_api/models/item_type2_enum'
+require_relative 'spotify_web_api/models/item_type3_enum'
+require_relative 'spotify_web_api/models/mode_enum'
+require_relative 'spotify_web_api/models/reason_enum'
+require_relative 'spotify_web_api/models/release_date_precision_enum'
+require_relative 'spotify_web_api/models/type_enum'
+require_relative 'spotify_web_api/models/type2_enum'
+require_relative 'spotify_web_api/models/type3_enum'
+require_relative 'spotify_web_api/models/type4_enum'
+require_relative 'spotify_web_api/models/type5_enum'
+require_relative 'spotify_web_api/models/type6_enum'
+require_relative 'spotify_web_api/models/type8_enum'
+require_relative 'spotify_web_api/models/type9_enum'
+require_relative 'spotify_web_api/models/o_auth_provider_error_enum'
+require_relative 'spotify_web_api/models/o_auth_scope_enum'
+
+# Exceptions
+require_relative 'spotify_web_api/exceptions/api_exception'
+require_relative 'spotify_web_api/exceptions/bad_request_exception'
+require_relative 'spotify_web_api/exceptions/forbidden_exception'
+require_relative 'spotify_web_api/exceptions/not_found_exception'
+require_relative 'spotify_web_api/exceptions/too_many_requests_exception'
+require_relative 'spotify_web_api/exceptions/unauthorized_exception'
+require_relative 'spotify_web_api/exceptions/o_auth_provider_exception'
+
+require_relative 'spotify_web_api/configuration'
+
+# Controllers
+require_relative 'spotify_web_api/controllers/base_controller'
+require_relative 'spotify_web_api/controllers/albums_controller'
+require_relative 'spotify_web_api/controllers/artists_controller'
+require_relative 'spotify_web_api/controllers/audiobooks_controller'
+require_relative 'spotify_web_api/controllers/categories_controller'
+require_relative 'spotify_web_api/controllers/chapters_controller'
+require_relative 'spotify_web_api/controllers/episodes_controller'
+require_relative 'spotify_web_api/controllers/genres_controller'
+require_relative 'spotify_web_api/controllers/markets_controller'
+require_relative 'spotify_web_api/controllers/player_controller'
+require_relative 'spotify_web_api/controllers/playlists_controller'
+require_relative 'spotify_web_api/controllers/search_controller'
+require_relative 'spotify_web_api/controllers/shows_controller'
+require_relative 'spotify_web_api/controllers/tracks_controller'
+require_relative 'spotify_web_api/controllers/users_controller'
+require_relative 'spotify_web_api/controllers/o_auth_authorization_controller'