lws 0.4.2 → 6.1.0.beta1

data/lib/lws/digital_signage.rb

@@ -0,0 +1,1796 @@
+#
+# Copyright © 2017 LeftClick B.V.
+#
+# This software is property of LeftClick B.V. and cannot be redistributed
+# and/or modified without permission.  The software or any of its parts
+# cannot be used for any other purposes than the LeftClick services and
+# only during a valid license subscription.  For more information, please
+# contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
+# Netherlands, info@leftclick.eu, +31492-782120.
+
+
+# = The digital_signage app module
+module LWS::DigitalSignage
+
+  # :nocov:
+  unless defined? ENDPOINT
+    # The API endpoint for the digital signage app
+    ENDPOINT = { production: "https://cm.leftclick.cloud/" ,
+                 development: "https://cm-dev.leftclick.cloud/" }
+  end
+  # :nocov:
+
+  # @!visibility private
+  def self.api
+    LWS.setup_api(LWS.config.endpoints[:digital_signage] ||
+                  ENDPOINT[LWS.config.environment])
+  end
+
+  ### Generic classes
+
+  # (see Generic::Configuration)
+  class Configuration < LWS::Generic::Configuration
+    use_api LWS::DigitalSignage.api
+  end
+
+  ### App specific classes
+
+  # = The channel class
+  class Channel < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the channel
+    attribute :id
+
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the channel belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
+
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company the channel belongs to
+    attribute :company_id
+
+    # @!attribute display
+    #   @return [Display] the display of the channel
+    belongs_to :display, class_name: "LWS::DigitalSignage::Display"
+    # :nocov:
+    def display
+      # Create a dummy method so that the original #display method is not used 
+      association(:display).load
+    end
+    # :nocov:
+
+    # @!attribute display_id
+    #   @return [Fixnum] the ID of the display of the channel
+    attribute :display_id
+
+    # @!attribute groups
+    #   @return [Array<Channel::Group>] the groups the channel is a member of
+    has_many :groups, class_name: "LWS::DigitalSignage::Channel::Group"
+
+    # @!attribute name
+    #   @return [String] the name of the channel
+    attribute :name
+
+    # @!attribute orientation
+    #   @return ["normal", "left", "right", "inverted"] the orientation of
+    #     the channel
+    attribute :orientation
+
+    # @!attribute players
+    #   @return [Array<Player>] the players linked to the channel
+    has_many :players, class_name: "LWS::DigitalSignage::Player"
+
+    # @!attribute tags
+    #   @return [Array<Channel::Tag>] the tags of the channel
+    has_many :tags, class_name: "LWS::DigitalSignage::Channel::Tag"
+
+    # @!attribute time_schedule
+    #   @return [Channel::TimeSchedule] the time schedule of the channel
+    belongs_to :time_schedule, class_name: "LWS::DigitalSignage::Channel::TimeSchedule",
+                               uri: "channel/time_schedules/:id"
+
+    # @!attribute time_schedule_id
+    #   @return [Fixnum] the ID of the time schedule of the channel
+    attribute :time_schedule_id
+
+    # @!attribute time_schedule_overrides
+    #   @return [Array<Channel::TimeScheduleOverride>] the time schedule
+    #      overrides of the channel
+    has_many :time_schedule_overrides, class_name: "LWS::DigitalSignage::Channel::TimeScheduleOverride"
+
+    # @!attribute time_zone
+    #   @return [String] the time zone for the channel
+    attribute :time_zone
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the channel was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the channel was last updated
+    attribute :updated_at
+  end
+
+  # = The channel group class
+  class Channel::Group < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "channel/groups/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the channel group
+    attribute :id
+
+    # @!attribute channels
+    #   @return [Array<Channel>] the channels that are part of the channel group
+    has_many :channels, class_name: "LWS::DigitalSignage::Channel",
+                        uri: "channel/groups/:group_id/channels"
+
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the channel group belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
+
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company the channel group belongs to
+    attribute :company_id
+
+    # @!attribute name
+    #   @return [String] the name of the channel group
+    attribute :name
+
+    # @!attribute parent
+    #   @return [Channel::Group, nil] the parent group of the channel group
+    belongs_to :parent, class_name: "LWS::DigitalSignage::Channel::Group",
+                        foreign_key: "parent_id",
+                        uri: "channel/groups/:id"
+
+    # @!attribute parent_id
+    #   @return [Fixnum, nil] the ID of the parent group of the channel group
+    attribute :parent_id
+
+    #@!attribute tags
+    #   @return [Array<Channel::Group::Tag>] the tags of the channel group
+    has_many :tags, class_name: "LWS::DigitalSignage::Channel::Group::Tag",
+                    uri: "channel/groups/:group_id/tags"
+
+    # @!attribute time_schedule_overrides
+    #   @return [Array<Channel::TimeScheduleOverride>] the time schedule overrides of the channel group
+    has_many :time_schedule_overrides, class_name: "LWS::DigitalSignage::Channel::TimeScheduleOverride",
+                                       uri: "channel/groups/:group_id/time_schedule_overrides"
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the channel group was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the channel group was last updated
+    attribute :updated_at
+  end
+
+  # = The channel group tag class
+  #
+  # @note
+  #   This class is only used within the context of the {Channel::Group}
+  #   class.
+  class Channel::Group::Tag < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the display
+    attribute :id
+
+    # @!attribute group
+    #   @return [Channel::Group] the channel group associated with the tag
+    belongs_to :group, class_names: "LWS::DigitalSignage::Channel::Group",
+                       uri: "channel/groups/:id"
+
+    # @!attribute group_id
+    #   @return [Fixnum] the ID of the channel group associated with the tag
+    attribute :group_id
+
+    # @!attribute key
+    #   @return [String] the key of the channel group tag
+    attribute :key
+
+    # @!attribute protected_value
+    #   @return [Boolean] whether the value of the channel group tag should
+    #     return a protected representation of the value
+    attribute :protected_value
+
+    # @!attribute value
+    #   @return [String, nil] the value of the channel group tag
+    attribute :value
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the channel group was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the channel group was last updated
+    attribute :updated_at
+  end
+
+  # = The channel tag class
+  #
+  # @note
+  #   This class is only used within the context of the {Channel} class.
+  class Channel::Tag < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the channel tag
+    attribute :id
+
+    # @!attribute channel
+    #   @return [Channel] the channel associated with the tag
+    belongs_to :channel, class_name: "LWS::DigitalSignage::Channel"
+
+    # @!attribute channel_id
+    #   @return [Fixnum] the ID of the channel associated with the tag
+    attribute :channel_id
+
+    # @!attribute key
+    #   @return [String] the key of the channel tag
+    attribute :key
+
+    # @!attribute protected_value
+    #   @return [Boolean] whether the value of the channel tag should
+    #     return a protected representation of the value
+    attribute :protected_value
+
+    # @!attribute value
+    #   @return [String, nil] the value of the channel tag
+    attribute :value
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the channel was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the channel was last updated
+    attribute :updated_at
+  end
+
+  # = The channel time schedule class
+  class Channel::TimeSchedule < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "channel/time_schedules/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the channel time schedule
+    attribute :id
+
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the channel time schedule belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
+
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company the channel time schedule belongs to
+    attribute :company_id
+
+    # @!attribute channels
+    #   @return [Array<Channel>] the channels using the time schedule
+    has_many :channels, class_name: "LWS::DigitalSignage::Channel",
+                        uri: "channel/time_schedules/:time_schedule_id/channels"
+
+    # @!attribute days
+    #   @return [Array<Channel::TimeSchedule::Day>] the days included in the
+    #     channel time schedule
+    has_many :days, class_name: "LWS::DigitalSignage::Channel::TimeSchedule::Day",
+                    uri: "channel/time_schedules/:time_schedule_id/days"
+
+    # @!attribute name
+    #   @return [String] the name of the channel time schedule
+    attribute :name
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the channel time schedule was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the channel time schedule was last updated
+    attribute :updated_at
+  end
+
+  # = The channel time schedule day class
+  #
+  # @note
+  #   This class is only used within the context of the {Channel::TimeSchedule}
+  #   class.
+  class Channel::TimeSchedule::Day < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "channel/time_schedules/:time_schedule_id/days/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the channel time schedule day
+    attribute :id
+
+    # @!attribute day
+    #   @return [Fixnum] the ID of the day of the channel time schedule
+    #     (0 = Sunday, 1 = Monday, ..., 6 = Saturday)
+    attribute :day
+
+    # @!attribute shutdown
+    #   @return [String] the shutdown time of the channel
+    attribute :shutdown
+
+    # @!attribute time_schedule
+    #   @return [Channel::TimeSchedule] the time schedule the day belongs to
+    belongs_to :time_schedule, class_name: "LWS::DigitalSignage::Channel::TimeSchedule",
+                               uri: "channel/time_schedules/:id"
+
+    # @!attribute time_schedule_id
+    #   @return [Fixnum] the ID of the time schedule the day belongs to
+    attribute :time_schedule_id
+
+    # @!attribute wakeup
+    #   @return [String] the wakeup time of the channel
+    attribute :wakeup
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the channel time schedule day was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the channel time schedule day was last updated
+    attribute :updated_at
+  end
+
+  # = The channel time override schedule class
+  class Channel::TimeScheduleOverride < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "channel/time_schedule_overrides/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the channel time schedule override
+    attribute :id
+
+    # @!attribute channels
+    #   @return [Array<Channel>] the channels using the time schedule override
+    has_many :channels, class_name: "LWS::DigitalSignage::Channel",
+                        uri: "channel/time_schedule_overrides/:time_schedule_override_id/channels"
+
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the channel time schedule override belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
+
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company the channel time schedule override belongs to
+    attribute :company_id
+
+    # @!attribute end
+    #   @return [String] the end date (inclusive) of the channel time schedule override
+    attribute :end
+
+    # @!attribute channel_groups
+    #   @return [Array<Channel::Group>] the channel groups using the time schedule override
+    has_many :groups, class_name: "LWS::DigitalSignage::Channel::Group",
+                      uri: "channel/time_schedule_overrides/:time_schedule_override_id/groups"
+
+    # @!attribute name
+    #   @return [String] the name of the channel time schedule override
+    attribute :name
+
+    # @!attribute shutdown
+    #   @return [String] the shutdown time of the channel
+    attribute :shutdown
+
+    # @!attribute start
+    #   @return [String] the start date of the channel time schedule override
+    attribute :start
+
+    # @!attribute wakeup
+    #   @return [String] the wakeup time of the channel
+    attribute :wakeup
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the channel time schedule override was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the channel time schedule override was last updated
+    attribute :updated_at
+  end
+
+  # = The display class
+  class Display < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the display
+    attribute :id
+
+    # @!attribute aspect_ratio
+    #   @return [String, nil] the aspect ratio of the display
+    attribute :aspect_ratio
+
+    # @!attribute baud_rate
+    #   @return [String] the baud rate of the RS232 connection to the display
+    attribute :baud_rate
+
+    # @!attribute channels
+    #   @return [Array<Channel>] the channels using the display
+    has_many :channels, class_name: "LWS::DigitalSignage::Channel"
+
+    # @!attribute data_bits
+    #   @return [String] the data bits setting of the RS232 connection to the display
+    attribute :data_bits
+
+    # @!attribute inputs
+    #   @return [Array<Display::Input>] the inputs supported by the display
+    has_many :inputs, class_name: "LWS::DigitalSignage::Display::Input"
+
+    # @!attribute name
+    #   @return [String] the name of the display
+    attribute :name
+
+    # @!attribute parity
+    #   @return ["none", "odd", "even" "mark", "space"] the parity setting of
+    #     the RS232 connection to the display
+    attribute :parity
+
+    # @!attribute power_on_command
+    #   @return [String, nil] the command to turn the display on via the RS232 connection
+    attribute :power_on_command
+
+    # @!attribute power_on_feedback_command
+    #   @return [String, nil] the feedback command to turn the display on via the RS232 connection
+    attribute :power_on_feedback_command
+
+    # @!attribute power_on_feedback_result
+    #   @return [String, nil] the result of the feedback command to turn the display on via the RS232 connection
+    attribute :power_on_feedback_result
+
+    # @!attribute power_off_command
+    #   @return [String, nil] the command to turn the display off via the RS232 connection
+    attribute :power_off_command
+
+    # @!attribute power_off_feedback_command
+    #   @return [String, nil] the feedback command to turn the display off via the RS232 connection
+    attribute :power_off_feedback_command
+
+    # @!attribute power_off_feedback_result
+    #   @return [String, nil] the result of the feedback command to turn the display off via the RS232 connection
+    attribute :power_off_feedback_result
+
+    # @!attribute resolutions
+    #   @return [Array<Display::Resolution>] the resolutions supported by the display
+    has_many :resolutions, class_name: "LWS::DigitalSignage::Display::Resolution"
+
+    # @!attribute slug [r]
+    #   @return [String] the slug(ified name) of the display
+    attribute :slug
+
+    # @!attribute stop_bits
+    #   @return [String] the stop bits setting of the RS232 connection to the display
+    attribute :stop_bits
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the display was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the display was last updated
+    attribute :updated_at
+  end
+
+  # = The display input class
+  #
+  # @note
+  #   This class is only used within the context of the {Display} class.
+  class Display::Input < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "displays/:display_id/inputs/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the display input
+    attribute :id
+
+    # @!attribute command
+    #   @return [String, nil] the command to send to select the display input
+    attribute :command
+
+    # @!attribute display
+    #   @return [Display] the display associated with the input
+    belongs_to :display, class_name: "LWS::DigitalSignage::Display"
+    # :nocov:
+    def display
+      # Create a dummy method so that the original #display method is not used 
+      association(:display).load
+    end
+    # :nocov:
+
+    # @!attribute display_id
+    #   @return [Fixnum] the ID of the display associated with the input
+    attribute :display_id
+
+    # @!attribute feedback_command
+    #   @return [String, nil] the feedback command to check to the display input
+    attribute :feedback_command
+
+    # @!attribute feedback_result
+    #   @return [String, nil] the result of the feedback command sent to check the display input
+    attribute :feedback_result
+
+    # @!attribute name
+    #   @return [String] the name of the display input
+    attribute :name
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the display input was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the display input was last updated
+    attribute :updated_at
+  end
+
+  # = The display resolution class
+  class Display::Resolution < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "display/resolutions/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the display resolution
+    attribute :id
+
+    # @!attribute aspect_ratio [r]
+    #   The aspect ratio is recalculated immediately when the width and/or
+    #   height of the resolution changes.
+    # 
+    #   @return [String] the aspect ratio of the resolution
+    attribute :aspect_ratio
+
+    # @!attribute displays
+    #   @return [Array<Display>] the displays supporting the display resolution
+    has_many :displays, class_name: "LWS::DigitalSignage::Display",
+                        uri: "display/resolutions/:resolution_id/displays"
+
+    # @!attribute height
+    #   @return [Fixnum] the height of the resolution
+    attribute :height
+
+    # @!attribute models
+    #   @return [Array<Player::Model>] the player models that support the
+    #     display resolution
+    has_many :models, class_name: "LWS::DigitalSignage::Player::Model",
+                      uri: "display/resolutions/:resolution_id/models"
+
+    # @!attribute scanning_mode
+    #   @return ["progressive", "interlaced"] the scanning mode setting of
+    #     the display resolution
+    attribute :scanning_mode
+
+    # @!attribute width
+    #   @return [Fixnum] the width of the resolution
+    attribute :width
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the display resolution was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the display resolution was last updated
+    attribute :updated_at
+  end
+
+  # = The player class
+  class Player < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player
+    attribute :id
+
+    # @!attribute channel
+    #   @return [Channel] the channel of the player
+    belongs_to :channel, class_name: "LWS::DigitalSignage::Channel"
+
+    # @!attribute channel_id
+    #   @return [Fixnum] the ID of the channel of the player
+    attribute :channel_id
+
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the player belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
+
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company the player belongs to
+    attribute :company_id
+
+    # @!attribute components
+    #   @return [Array<Player::Component>] the components of the player
+    has_many :components, class_name: "LWS::DigitalSignage::Player::Component"
+
+    # @!attribute configuration
+    #   @return [Player::Configuration] the configuration of the player
+    belongs_to :configuration, class_name: "LWS::DigitalSignage::Player::Configuration",
+                               uri: "player/configurations/:id"
+
+    # @!attribute configuration_id
+    #   @return [Fixnum] the ID of the configuration of the player
+    attribute :configuration_id
+
+    # @!attribute feedbacks
+    #   @return [Array<Player::Feedback>] the feedbacks for the player
+    has_many :feedbacks, class_name: "LWS::DigitalSignage::Player::Feedback"
+
+    # @!attribute logs
+    #   @return [Array<Player::Log>] the logs of the player
+    has_many :logs, class_name: "LWS::DigitalSignage::Player::Log"
+
+    # @!attribute mac_lan
+    #   @return [String, nil] the MAC address of the LAN interface of the player
+    attribute :mac_lan
+
+    # @!attribute mac_wifi
+    #   @return [String, nil] the MAC address of the Wi-Fi interface of the player
+    attribute :mac_wifi
+
+    # @!attribute model
+    #   @return [Player::Model] the model of the player
+    belongs_to :model, class_name: "LWS::DigitalSignage::Player::Model",
+                                   uri: "player/models/:id"
+
+    # @!attribute model_id
+    #   @return [Fixnum] the ID of the model of the player
+    attribute :model_id
+
+    # @!attribute notifications
+    #   @return [Array<Player::Notification>] the notifications for the player
+    has_many :notifications, class_name: "LWS::DigitalSignage::Player::Notification"
+
+    # @!attribute operational_since
+    #   @return [String, nil] the date/time when the player became operational
+    #     for the first time
+    attribute :operational_since
+
+    # @!attribute parts
+    #   @return [Array<Player::Component::Part>] the parts of the player
+    has_many :parts, class_name: "LWS::DigitalSignage::Player::Component::Part"
+
+    # @!attribute release_channel
+    #   @return [Player::Os::ReleaseChannel] the player OS release channel used
+    #     by the player
+    belongs_to :release_channel, class_name: "LWS::DigitalSignage::Player::Os::ReleaseChannel",
+                                 uri: "player/os/release_channels/:id"
+
+    # @!attribute release_channel_id
+    #   @return [Fixnum] the ID of the player OS release channel used by the
+    #     player
+    attribute :releasee_channel_id
+
+    # @!attribute requests
+    #   @return [Array<Player::Feedback>] the requests for the player
+    has_many :requests, class_name: "LWS::DigitalSignage::Player::Request"
+
+    # @!attribute screenshots
+    #   @return [Array<Player::Screenshot>] the screenshots of the player
+    has_many :screenshots, class_name: "LWS::DigitalSignage::Player::Screenshot"
+
+    # @!attribute serial_number [r]
+    #   @return [String] the serial number of the player
+    attribute :serial_number
+
+    # @!attribute service
+    #   @return [Boolean] whether the player is being serviced/is in service
+    attribute :service
+
+    # @!attribute status
+    #   @return ["unknown", "good", "warning", "bad"] the player status
+    attribute :status
+
+    # @!attribute tags
+    #   @return [Array<Player::Tag>] the tags of the player
+    has_many :tags, class_name: "LWS::DigitalSignage::Player::Tag"
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player was last updated
+    attribute :updated_at
+  end
+
+  # = The player component class
+  class Player::Component < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/components/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player component
+    attribute :id
+
+    # @!attribute description
+    #   @return [String, nil] the description of the player component
+    attribute :description
+
+    # @!attribute models
+    #   @return [Array<Player::Model>] the player models that use the component
+    has_many :models, class_name: "LWS::DigitalSignage::Player::Model",
+                      uri: "player/components/:component_id/models"
+
+    # @!attribute name
+    #   @return [String] the name of the player component
+    attribute :name
+
+    # @!attribute parts
+    #   @return [Array<Player::Component::Part>] the parts the component is made out of
+    has_many :parts, class_name: "LWS::DigitalSignage::Player::Component::Part",
+                     uri: "player/components/:component_id/parts"
+
+    # @!attribute slug [r]
+    #   @return [String] the slug(ified name) of the player component
+    attribute :slug
+
+    # @!attribute supplier
+    #   @return [LWS::Auth::Company] the supplier of the component part
+    belongs_to :supplier, class_name: "LWS::Auth::Company",
+                          foreign_key: "supplier_id",
+                          uri: "companies/:id"
+
+    # @!attribute supplier_id
+    #   @return [Fixnum] the ID of the supplier of the component part
+    attribute :supplier_id
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player component was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player component was last updated
+    attribute :updated_at
+  end
+
+  # = The player component part class
+  #
+  # @note
+  #   This class is only used within the context of the {Player::Component}
+  #   class.
+  class Player::Component::Part < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "players/components/:component_id/parts/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player component part
+    attribute :id
+
+    # @!attribute component
+    #   @return [Player::Component] the player component that uses the part
+    belongs_to :component, class_name: "LWS::DigitalSignage::Player::Component",
+                           uri: "player/components/:id"
+
+    # @!attribute component_id
+    #   @return [Fixnum] the ID of the player component that uses the part
+    attribute :component_id
+
+    # @!attribute player
+    #   @return [Player, nil] the player the component part is used in
+    belongs_to :player, class_name: "LWS::DigitalSignage::Player"
+
+    # @!attribute player_id
+    #   @return [Fixnum, nil] the ID of the player the component part is used in
+    attribute :player_id
+
+    # @!attribute serial_number
+    #   @return [String] the serial number of the player component part
+    attribute :serial_number
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player component part was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player component part was last updated
+    attribute :updated_at
+  end
+
+  # = The player configuration class
+  class Player::Configuration < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/configurations/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player configuration
+    attribute :id
+
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the player configuration belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
+
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company the player configuration belongs to
+    attribute :company_id
+
+    # @!attribute description
+    #   @return [String, nil] the description of the player configuration
+    attribute :description
+
+    # @!attribute name
+    #   @return [String] the name of the player configuration
+    attribute :name
+
+    # @!attribute players
+    #   @return [Array<Player>] the players the configuration is used for
+    has_many :players, class_name: "LWS::DigitalSignage::Player",
+                       uri: "player/configurations/:configuration_id/players"
+
+    # @!attribute predefined_configuration
+    #   @return [Player::PredefinedConfiguration, nil] the predefined
+    #     configuration that is used as a bases for the configuration
+    belongs_to :predefined_configuration, class_name: "LWS::DigitalSignage::Player::PredefinedConfiguration",
+                                          uri: "player/predefined_configurations/:id"
+
+    # @!attribute predefined_configuration_id
+    #   @return [Fixnum, nil] the ID of the predefined configuration that is used
+    #     as a basis for the player configuration
+    attribute :predefined_configuration_id
+
+    # @!attribute settings
+    #    @return [Player::Configuration::Setting] the settings of the player configuration
+    has_many :settings, class_name: "LWS::DigitalSignage::Player::Configuration::Setting",
+                        uri: "player/configurations/:configuration_id/settings"
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player configuration was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player configuration was last updated
+    attribute :updated_at
+  end
+
+  # = The player configuration setting class
+  #
+  # @note
+  #   This class is only used within the context of the {Player::Configuration}
+  #   class.
+  class Player::Configuration::Setting < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/configurations/:configuration_id/settings/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player configuration setting
+    attribute :id
+
+    # @!attribute configuration
+    #   @return [Player::Configuration] the player configuration the setting
+    #     is defined in
+    belongs_to :configuration, class_name: "LWS::DigitalSignage::Player::Configuration",
+                               uri: "player/configurations/:id"
+
+    # @!attribute configuration_id
+    #   @return [Fixnum] the ID of the player configuration the setting is defined in
+    attribute :configuration_id
+
+    # @!attribute key
+    #   @return [String] the key of the player configuration setting
+    attribute :key
+
+    # @!attribute protected_value
+    #   @return [Boolean] whether the value of the player configuration setting
+    #     should return a protected representation of the value
+    attribute :protected_value
+
+    # @!attribute value
+    #   @return [String, nil] the value of the player configuration setting
+    attribute :value
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player configuration setting was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player configuration setting was last updated
+    attribute :updated_at
+  end
+
+  # = The player feedback class
+  #
+  # @note
+  #   This class is only used within the context of the {Player} class.
+  class Player::Feedback < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "players/:player_id/feedbacks/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player feedback
+    attribute :id
+
+    # @!attribute player
+    #   @return [Player] the player the feedback is originating from
+    belongs_to :player, class_name: "LWS::DigitalSignage::Player"
+
+    # @!attribute player_id
+    #   @return [Fixnum] the ID of the player the feedback is originating from
+    attribute :player_id
+
+    # @!attribute release
+    #   @return [Player::Os::Branch::Release] the player OS branch release the
+    #      feedback is related to
+    # FIXME: Missing branch_id field in LWS
+    belongs_to :release, class_name: "LWS::DigitalSignage::Player::Os::Branch::Release",
+                         uri: "player/os/branches/:branch_id/releases/:id"
+
+    # @!attribute release_id
+    #   @return [Fixnum] the ID of the player OS branch release the feedback
+    #     is related to
+
+    # @!attribute results
+    #   @return [Array<Player::Feedback::Result>] the results of the player feedback
+    # FIXME: Chained associations don't work yet in Spyke (#89)
+    has_many :results, class_name: "LWS::DigitalSignage::Player::Feedback::Result",
+                       uri: "players/:player_id/feedbacks/:feedback_id/results"
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player feedback was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player feedback was last updated
+    attribute :updated_at
+  end
+
+  # = The player feedback result class
+  #
+  # @note
+  #   This class is only used within the context of the {Player::Feedback}
+  #   class.
+  class Player::Feedback::Result < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "players/:player_id/feedbacks/:feedback_id/results/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player feedback result
+    attribute :id
+
+    # @!attribute feedback
+    #   @return [Player::Feedback] the player feedback the result is a part of
+    belongs_to :feedback, class_name: "LWS::DigitalSignage::Player::Feedback",
+                          uri: "players/:player_id/feedbacks/:id"
+
+    # @!attribute feedback_id
+    #   @return [Player::Feedback] the ID of the player feedback the result is a part of
+    attribute :feedback_id
+
+    # @!attribute key
+    #   @return [String] the key of the player feedback result
+    attribute :key
+
+    # @!attribute player
+    #   @return [Player] the player the feedback result is for
+    belongs_to :player, class_name: "LWS::DigitalSignage::Player"
+
+    # @!attribute player_id
+    #   @return [Fixnum] the ID of the player the feedback result is for
+    attribute :player_id
+
+    # @!attribute value
+    #   @return [String] the value of the player feedback result
+    attribute :value
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player feedback result was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player feedback result was last updated
+    attribute :updated_at
+  end
+
+  # = The player log class
+  #
+  # @note
+  #   This class is only used within the context of the {Player} class.
+  class Player::Log < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "players/:player_id/logs/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player log
+    attribute :id
+
+    # @!attribute log_object
+    #   @return [String] the URL of the player log object
+    attribute :log_object
+
+    # @!attribute player
+    #   @return [Player] the player the log is produced by
+    belongs_to :player, class_name: "LWS::DigitalSignage::Player"
+
+    # @!attribute player_id
+    #   @return [Fixnum] the ID of the player the log is produced by
+    attribute :player_id
+
+    # @!attribute processed
+    #   @return [Boolean] whether the player log has been processed
+    attribute :processed
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player log was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player log was last updated
+    attribute :updated_at
+  end
+
+  # = The player model
+  class Player::Model < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/models/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player model
+    attribute :id
+
+    # @!attribute branches
+    #   @return [Array<Player::Os::Branch>] the player OS branches allowed for
+    #     the player model
+    has_many :branches, class_name: "LWS::DigitalSignage::Player::Os::Branch",
+                        uri: "player/models/:model_id/branches"
+
+    # @!attribute capabilities
+    #   @return [Array<Player::Model::Capability>] the capabilities of the
+    #     player model
+    has_many :capabilities, class_name: "LWS::DigitalSignage::Player::Model::Capability",
+                            uri: "player/models/:model_id/capabilities"
+
+    # @!attribute components
+    #   @return [Array<Player::Component>] the player components that are
+    #     used in the player model
+    has_many :components, class_name: "LWS::DigitalSignage::Player::Component",
+                          uri: "player/models/:model_id/components"
+
+    # @!attribute mbf_hours
+    #   @return [Fixnum] the MBF (mean time between failures) in hours of
+    #     the player mode
+    attribute :mbf_hours
+
+    # @!attribute name
+    #   @return [String] the name of the player model
+    attribute :name
+
+    # @!attribute players
+    #   @return [Array<Player>] the player that have the player model
+    has_many :players, class_name: "LWS::DigitalSignage::Player",
+                       uri: "player/models/:model_id/players"
+
+    # @!attribute release_channels
+    #   @return [Array<Player::Os::ReleaseChannel>] the player OS release
+    #     channels used for the player model
+    has_many :release_channels, class_name: "LWS::DigitalSignage::Player::Os::ReleaseChannel",
+                                uri: "player/models/:model_id/release_channels"
+
+    # @!attribute resolutions
+    #   @return [Array<Display::Resolution>] the display resolutions
+    #     supported by the player model
+    has_many :resolutions, class_name: "LWS::DigitalSignage::Display::Resolution",
+                           uri: "player/models/:model_id/resolutions"
+
+    # @!attribute slug [r]
+    #   @return [String] the slug(ified name) of the player model
+    attribute :slug
+
+    # @!attribute support_end
+    #   @return [String] the end date of support for the model
+    attribute :support_end
+
+    # @!attribute support_eol
+    #   @return [String] the date when the model is considered end-of-life in
+    #     terms of support
+    attribute :support_eol
+
+    # @!attribute support_starts
+    #   @return [String] the start date of support for the model
+    attribute :support_starts
+
+    # @!attribute temperature_critical
+    #   @return [Fixnum, nil] the critical temperature threshold (°C) for the
+    #     player model
+    attribute :temperature_critical
+
+    # @!attribute temperature_warning
+    #   @return [Fixnum, nil] the warning temperature threshold (°C) for the
+    #     player model
+    attribute :temperature_warning
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player model was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player model was last updated
+    attribute :updated_at
+  end
+
+  # = The player model capability class
+  #
+  # @note
+  #   This class is only used within the context of the {Player::Model}
+  #   class.
+  class Player::Model::Capability < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/models/:model_id/capabilities/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player model capability
+    attribute :id
+
+    # @!attribute key
+    #   @return [String] the key of the player model capability
+    attribute :key
+
+    # @!attribute model
+    #   @return [Player::Model] the player model that has the capability
+    belongs_to :model, class_name: "LWS::DigitalSignage::Player::Model",
+                       uri: "player/models/:id"
+
+    # @!attribute model_id
+    #   @return [Fixnum] the ID of the player model that has the capability
+    attribute :model_id
+
+    # @!attribute value
+    #   @return [String] the value of the player model capability
+    attribute :value
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player model capability was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player model capability was last updated
+    attribute :updated_at
+  end
+
+  # = The player notification
+  #
+  # @note
+  #   This class is only used within the context of the {Player} class.
+  class Player::Notification < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "players/:player_id/notifications/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player notification
+    attribute :id
+
+    # @!attribute key
+    #   @return [String] the key of the player notification
+    attribute :key
+
+    # @!attribute player
+    #   @return [Player] the player the notification is sent by
+    belongs_to :player, class_name: "LWS::DigitalSignage::Player"
+
+    # @!attribute player_id
+    #   @return [Fixnum] the ID of the player the notification is sent by
+    attribute :player_id
+
+    # @!attribute protected_value
+    #   @return [Boolean] whether the value of the player nofication should
+    #     return a protected representation of the value
+    attribute :protected_value
+
+    # @!attribute repeated
+    #   @return [Fixnum, nil] the number of times the notification was repeated
+    attribute :repeated
+
+    # @!attribute value
+    #   @return [String] the value of the player notification
+    attribute :value
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player notification was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player notification was last updated
+    attribute :updated_at
+  end
+
+  # = The player OS module
+  module Player::Os; end
+
+  # = The player OS branch class
+  class Player::Os::Branch < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/os/branches/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player OS branch
+    attribute :id
+
+    # @!attribute models
+    #   @return [Array<Player::Model>] the player models that allow the player
+    #     OS branch to be used
+    has_many :models, class_name: "LWS::DigitalSignage::Player::Model"
+
+    # @!attribute name
+    #   @return [String] the name of the player OS branch
+    attribute :name
+
+    # @!attribute release_channel
+    #   @return [Player::Os::Branch::ReleaseChannel] the player OS release
+    #     channel the branch is for
+    belongs_to :release_channel, class_name: "LWS::DigitalSignage::Player::Os::ReleaseChannel",
+                                 uri: "player/os/release_channels/:id"
+
+    # @!attribute release_channel_id
+    #   @return [Fixnum] the ID of the player OS release channel the branch
+    #     is for
+    attribute :release_channel_id
+
+    # @!attribute releases
+    #   @return [Array<Player::Os::Branch::Release>] the releases that are part
+    #     of the branch
+    has_many :releases, class_name: "LWS::DigitalSignage::Player::Os::Branch::Release",
+                        uri: "player/os/branches/:branch_id/releases"
+
+    # @!attribute slug [r]
+    #   @return [String] the slug(ified name) of the player OS branch
+    attribute :slug
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player OS branch was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player OS branch was last updated
+    attribute :updated_at
+  end
+
+  # = The player OS branch release class
+  #
+  # @note
+  #   This class is only used within the context of the {Player::Os::Branch}
+  #   class.
+  class Player::Os::Branch::Release < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/os/branches/:branch_id/releases/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player OS branch release
+    attribute :id
+
+    # @!attribute branch
+    #   @return [Player::Os::Branch] the player OS branch the release is for
+    belongs_to :branch, class_name: "LWS::DigitalSignage::Player::Os::Branch",
+                        uri: "player/os/branches/:id"
+
+    # @!attribute branch_id
+    #   @return [Fixnum] the ID of the player OS branch the release is for
+    attribute :branch_id
+
+    # @!attribute commit_date
+    #   @return [String] the date/time of the release (commit)
+    attribute :commit_date
+
+    # @!attribute commit_hash
+    #   @return [String] the SHA256 commit hash of the release (commit)
+    attribute :commit_hash
+
+    # @!attribute commit_message
+    #   @return [String] the message of the release (commit)
+    attribute :commit_message
+
+    # @!attribute package_versions
+    #   @return [Array<Player::Os::Package::Version>] the player OS package
+    #     versions in this release
+    # FIXME: Chained associations don't work yet in Spyke (#89)
+    has_many :package_versions, class_name: "LWS::DigitalSignage::Player::Os::Package::Version",
+                                uri: "player/os/branches/:branch_id/releases/:release_id/package_versions"
+
+    # @!attribute package_version_changes
+    #   @return [Array<Player::Os::Package::VersionChange>] the player OS package
+    #     version changes in this release
+    # FIXME: Chained associations don't work yet in Spyke (#89)
+    has_many :package_version_changes, class_name: "LWS::DigitalSignage::Player::Os::Package::VersionChange",
+                                       uri: "player/os/branches/:branch_id/releases/:release_id/package_version_changes"
+
+    # @!attribute parent
+    #   @return [Player::Os::Branch::Release, nil] the parent of the player OS
+    #     branch release
+    belongs_to :parent, class_name: "LWS::DigitalSignage::Player::Os::Branch::Release",
+                        foreign_key: :parent_id,
+                        uri: "player/os/branches/:branch_id/releases/:id"
+
+    # @!attribute parent_id
+    #   @return [Fixnum, nil] the ID of the parent of the player OS branch release
+    attribute :parent_id
+
+    # @!attribute promoted_release
+    #   @return [Player::Os::Branch::Release, nil] the player OS branch
+    #     release that the release is a promotion of
+    belongs_to :promoted_release, class_name: "LWS::DigitalSignage::Player::Os::Branch::Release",
+                                  foreign_key: :promoted_release_id,
+                                  uri: "player/os/branches/:branch_id/releases/:id"
+
+    # @!attribute promoted_release_id
+    #  @return [Fixnum, nil] the ID of the player OS branch release that the
+    #    release is a promotion of
+    attribute :promoted_release_id
+
+    # @!attribute promoting_releases
+    #   @return [Array<Player::Os::Branch::Release>] the player OS branch releases
+    #     that promote the release
+    has_many :promoting_release, class_name: "LWS::DigitalSignage::Player::Os::Branch::Release"
+
+    # @!attribute version
+    #   @return [String] the version of the release
+    attribute :version
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player OS branch release was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player OS branch release was last updated
+    attribute :updated_at
+  end
+
+  # = The player OS package class
+  class Player::Os::Package < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/os/packages/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player OS package
+    attribute :id
+
+    # @!attribute name
+    #   @return [String] the name of the player OS package
+    attribute :name
+
+    # @!attribute version_changes
+    #   @return [Array<Player::Os::Package::VersionChange>] the version
+    #     changes of the player OS package present in branches
+    has_many :version_changes, class_name: "LWS::DigitalSignage::Player::Os::Package::VersionChange",
+                               uri: "player/os/packages/:package_id/version_changes"
+
+    # @!attribute versions
+    #   @return [Array<Player::Os::Package::Version>] the versions of the
+    #     player OS package present in branches
+    has_many :versions, class_name: "LWS::DigitalSignage::Player::Os::Package::Version",
+                        uri: "player/os/packages/:package_id/versions"
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player OS package was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player OS package was last updated
+    attribute :updated_at
+  end
+
+  # = The player OS package version class
+  #
+  # @note
+  #   This class is only used within the context of the {Player::Os::Package}
+  #   class.
+  class Player::Os::Package::Version < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/os/packages/:package_id/versions/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player OS package version
+    attribute :id
+
+    # @!attribute number
+    #   @return [String] the number of the player OS package version
+    attribute :number
+
+    # @!attribute package
+    #   @return [Player::Os::Package] the player OS package the version is of
+    belongs_to :package, class_name: "LWS::DigitalSignage::Player::Os::Package",
+                         uri: "player/os/packages/:id"
+
+    # @!attribute package_id
+    #   @return [Fixnum] the ID the player OS package the version is of
+    attribute :package_id
+
+    # @!attribute branch_releases
+    #   @return [Array<Player::Os::Branch::Release>] the branch releases the
+    #     player OS package version is a part of
+    # FIXME: Missing branch_id in LWS
+    has_many :branch_releases, class_name: "LWS::DigitalSignage::Player::Os::Branch::Release",
+                               foreign_key: :branch_release_id,
+                               uri: "player/os/branches/:branch_id/releases/:id"
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player OS package version was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player OS package version was last updated
+    attribute :updated_at
+  end
+
+  # = The player OS package version change class
+  #
+  # @note
+  #   This class is only used within the context of the {Player::Os::Package}
+  #   class.
+  class Player::Os::Package::VersionChange < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/os/packages/:package_id/version_changes/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player OS package version change
+    attribute :id
+
+    # @!attribute branch_release
+    #   @return [Player::Os::Branch::Release] the branch release the player OS
+    #     package version change is included in
+    # FIXME: Missing branch_id in LWS
+    belongs_to :branch_release, class_name: "LWS::DigitalSignage::Player::Os::Branch::Release",
+                                foreign_key: :branch_release_id,
+                                uri: "player/os/branches/:branch_id/releases/:id"
+
+    # @!attribute branch_release_id
+    #   @return [Fixnum] the ID of the branch release the player OS package
+    #      version change is included in
+    attribute :branch_release_id
+
+    # @!attribute from_number
+    #   @note Either the from (version) number or the to (version) number
+    #     needs to be set.
+    #   @return [String, nil] the number the player OS package version was before
+    #     the change
+    attribute :from_number
+
+    # @!attribute from_version
+    #   @return [Player::Os::Package::Version, nil] the version the player OS
+    #     package was before the change
+    belongs_to :from_version, class_name: "LWS::DigitalSignage::Player::Os::Package::Version",
+                              foreign_key: :from_version_id,
+                              uri: "player/os/packages/:package_id/versions/:id"
+
+    # @!attribute from_version_id
+    #   @return [Fixnum, nil] the ID of the number the player OS package
+    #     version was before the change
+    attribute :from_version_id
+
+    # @!attribute log
+    #   @return [String] the log of the player OS package version change
+    attribute :log
+
+    # @!attribute package
+    #   @return [Player::Os::Package] the player OS package the version change is for
+    belongs_to :package, class_name: "LWS::DigitalSignage::Player::Os::Package",
+                         uri: "player/os/packages/:id"
+
+    # @!attribute package_id
+    #   @return [Fixnum] the ID the player OS package the version change is of
+    attribute :package_id
+
+    # @!attribute state
+    #   @return ["waiting", "processing", "done", "error"] the processing
+    #     state of the player OS version change
+    attribute :state
+
+    # @!attribute to_number
+    #   @note Either the from (version) number or the to (version) number
+    #     needs to be set.
+    #   @return [String, nil] the number of the player OS package version was
+    #     after the change
+    attribute :to_number
+
+    # @!attribute to_version
+    #   @return [Player::Os::Package::Version, nil] the version the player OS
+    #     package was after the change
+    belongs_to :to_version, class_name: "LWS::DigitalSignage::Player::Os::Package::Version",
+                            foreign_key: :to_version_id,
+                            uri: "player/os/packages/:package_id/versions/:id"
+
+    # @!attribute to_version_id
+    #   @return [Fixnum, nil] the ID of the version the player OS package was
+    #     after the change
+    attribute :to_version_id
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player OS package version change was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player OS package version change was last updated
+    attribute :updated_at
+  end
+
+  # = The player OS release channel class
+  class Player::Os::ReleaseChannel < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/os/release_channels/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player OS release channel
+    attribute :id
+
+    # @!attribute branches
+    #   @return [Array<Player::Os::Branch>] the branches that belong to the
+    #     player OS release channel
+    has_many :branches, class_name: "LWS::DigitalSignage::Player::Os::Branch",
+                        uri: "player/os/release_channels/:release_channel_id/branches"
+
+    # @!attribute name
+    #   @return [String] the name of the player OS release channel
+    attribute :name
+
+    # @!attribute players
+    #   @return [Array<Player>] the players that use the player OS release channel
+    has_many :players, class_name: "LWS::DigitalSignage::Player",
+                       uri: "player/os/release_channels/:release_channel_id/players"
+
+    # @!attribute slug [r]
+    #   @return [String] the slug(ified name) of the player OS release channel
+    attribute :slug
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player OS release channel was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player OS release channel was last updated
+    attribute :updated_at
+  end
+
+  # = The predefined player configuration
+  class Player::PredefinedConfiguration < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/predefined_configurations/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the predefined player configuration
+    attribute :id
+
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the predefined player configuration belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
+
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the company the predefined player configuration belongs to
+    attribute :compandy_id
+
+    # @!attribute configurations
+    #   @return [Array<Player::Configuration>] the player configurations that use
+    #     the predefined player configuration as a basis
+    has_many :configurations, class_name: "LWS::DigitalSignage::Player::Configuration",
+                              uri: "player/predefined_configurations/:predefined_configuration_id/configurations"
+
+    # @!attribute description
+    #   @return [String] the description of the predefined player configuration
+    attribute :description
+
+    # @!attribute name
+    #   @return [String] the name of the predefined player configuration
+    attribute :name
+
+    # @!attribute settings
+    #    @return [Player::PredefinedConfiguration::Setting] the settings of the
+    #      predefined player configuration
+    has_many :settings, class_name: "LWS::DigitalSignage::Player::PredefinedConfiguration::Setting",
+                        uri: "player/predefined_configurations/:predefined_configuration_id/settings"
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the predefined player configuration was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the predefined player configuration was last updated
+    attribute :updated_at
+  end
+
+  # = The predefined player configuration setting class
+  #
+  # @note
+  #   This class is only used within the context of the {Player::PredefinedConfiguration}
+  #   class.
+  class Player::PredefinedConfiguration::Setting < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "player/predefined_configurations/:configuration_id/settings/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the predefined player configuration setting
+    attribute :id
+
+    # @!attribute key
+    #   @return [String] the key of the predefined player configuration setting
+    attribute :key
+
+    # @!attribute predefined_configuration
+    #   @return [Player::PredefinedConfiguration] the predefined player
+    #     configuration the setting is defined in
+    belongs_to :predefined_configuration, class_name: "LWS::DigitalSignage::Player::PredefinedConfiguration",
+                                          uri: "player/predefined_configurations/:id"
+
+    # @!attribute predefined_configuration_id
+    #   @return [Fixnum] the ID of the predefined player configuration the setting is defined in
+    attribute :predefined_configuration_id
+
+    # @!attribute protected_value
+    #   @return [Boolean] whether the value of the predefined player configuration setting
+    #     should return a protected representation of the value
+    attribute :protected_value
+
+    # @!attribute value
+    #   @return [String, nil] the value of the predefined player configuration setting
+    attribute :value
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the predefined player configuration setting was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the predefined player configuration setting was last updated
+    attribute :updated_at
+  end
+
+  # = The player request class
+  #
+  # @note
+  #   This class is only used within the context of the {Player} class.
+  class Player::Request < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "players/:player_id/requests/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player request
+    attribute :id
+
+    # @!attribute action
+    #   @return ["unknown", "send_logs", "clear_logs", "clear_content",
+    #     "clear_layouts", "send_screenshot", "reboot", "retrieve_playlist",
+    #     "os_switch_branch", "os_deploy", "os_pull", "restart_lc_session",
+    #     "send_feedback", "apply_configuration"] the player request action
+    attribute :action
+
+    # @!attribute argument
+    #   @return [String, nil] the optional argument for the player request
+    attribute :argument
+
+    # @!attribute feedback
+    #   This field should be set once the action has been processed (see
+    #   {#processed}) and the action is +"send_feedback"+.
+    #
+    #   @return [Player::Feedback, nil] the player feedback as a response to the
+    #     action request +"send_status"+
+    belongs_to :feedback, class_name: "LWS::DigitalSignage::Player::Feedback",
+                          uri: "players/:player_id/feedbacks/:id"
+
+    # @!attribute feedback_id
+    #   @return [Fixnum, nil] the ID of the player feedback as a response to the
+    #     action request +"send_status"+
+    attribute :feedback_id
+
+    # @!attribute log
+    #   This field should be set once the action has been processed (see
+    #   {#processed}) and the action is +"send_logs"+.
+    #
+    #   @return [Player::Log, nil] the player log as a response to the action
+    #     request +"send_logs"+
+    belongs_to :log, class_name: "LWS::DigitalSignage::Player::Log",
+                     uri: "players/:player_id/logs/:id"
+
+    # @!attribute log_id
+    #   @return [Fixnum, nil] the ID of the player log as a response to the action
+    #     request +"send_logs"+
+    attribute :log_id
+
+    # @!attribute player
+    #   @return [Player] the player the request is sent to
+    belongs_to :player, class_name: "LWS::DigitalSignage::Player"
+
+    # @!attribute player_id
+    #   @return [Fixnum] the ID of the player the request is sent to
+    attribute :player_id
+
+    # @!attribute processed
+    #   @return [Boolean] whether the request has been processed by the player
+    attribute :processed
+
+    # @!attribute response
+    #   @return [String, nil] the player request response text (if the response
+    #     is not a specific object)
+    attribute :response
+
+    # @!attribute screenshot
+    #   This field should be set once the action has been processed (see
+    #   {#processed}) and the action is +"send_screenshot"+.
+    #  
+    #   @return [Player::Screenshot, nil] the player screenshot as a response to
+    #     the action request +"send_screenshot"+
+    belongs_to :screenshot, class_name: "LWS::DigitalSignage::Player::Screenshot",
+                            uri: "players/:player_id/screenshots/:id"
+
+    # @!attribute screenshot_id
+    #   @return [Fixnum, nil] the ID of the player screenshot as a response to
+    #     the action request +"send_screenshot"+
+    attribute :screenshot_id
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player request was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player request was last updated
+    attribute :updated_at
+  end
+
+  # = The player screenshot class
+  #
+  # @note
+  #   This class is only used within the context of the {Player} class.
+  class Player::Screenshot < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "players/:player_id/screenshots/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player screenshot
+    attribute :id
+
+    # @!attribute player
+    #   @return [Player] the player the screenshot is made by
+    belongs_to :player, class_name: "LWS::DigitalSignage::Player"
+
+    # @!attribute player_id
+    #   @return [Fixnum] the ID of the player the screenshot is made by
+    attribute :player_id
+
+    # @!attribute screenshot_object
+    #   @return [String] the URL of the player screenshot object
+    attribute :screenshot_object
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player screenshot was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player screenshot was last updated
+    attribute :updated_at
+  end
+
+  # = The player tag class
+  #
+  # @note
+  #   This class is only used within the context of the {Player} class.
+  class Player::Tag < LWS::Generic::Model
+    use_api LWS::DigitalSignage.api
+    uri "players/:player_id/tags/(:id)"
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the player tag
+    attribute :id
+
+    # @!attribute key
+    #   @return [String] the key of the player tag
+    attribute :key
+
+    # @!attribute player
+    #   @return [Player] the player associated with the tag
+    belongs_to :player, class_name: "LWS::DigitalSignage::Player"
+
+    # @!attribute player_id
+    #   @return [Fixnum] the ID of the player associated with the tag
+    attribute :player_id
+
+    # @!attribute protected_value
+    #   @return [Boolean] whether the value of the player tag should
+    #     return a protected representation of the value
+    attribute :protected_value
+
+    # @!attribute value
+    #   @return [String, nil] the value of the player tag
+    attribute :value
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the player was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the player was last updated
+    attribute :updated_at
+  end
+
+end