lws 9.0.0 → 9.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 150a1779762e57c9f006a834ca999285c0097a93ca8700afc1d5d869ebcf5308
-  data.tar.gz: b681cd289673fab747aec364a7d50397266770fa0f8334740d10c7482196852c
+  metadata.gz: cb45ec2506f9fd04eb49e0c1f93963abbf26d3ab0ee3c613fd9912a799f190ca
+  data.tar.gz: 493c7dce245f07ca9715ac954078edabefd4d5771c69023f04b1710bd4bf22b7
 SHA512:
-  metadata.gz: 854b6b3ec5fa1ef0844c949379e324d7d5079669ac6ebe8c3e40dfeb191cb923ae25735ef65bf813b29d571be3efb57b40c5a5d4616e73a7a13b0c0064a9376d
-  data.tar.gz: 985eba4a689ee5bbdd30ea1269df0b4b88c80b558d9574daa13d9792ca3c66bab6b356fe8a79d501f279df03fbab1bde99baec732b3ea6926a784b3c1740ccc5
+  metadata.gz: e0d79ee284170f38c5be9ab66fc5a5c67e2fbcf85593d0cde02c73a1e6df0d10379f8ef76778bb5c0a8aff73d6ed750c119466c1038192ed3466bc5601162ccd
+  data.tar.gz: eaddf89999075ac539ada4c691f741724dc44b5b4a5cccb854e90b923243a62a49044e5114989064c409fbf411e565b8873b965ac5a0fa09d05185f31d09c47d

data/lib/lws/apps/auth.rb

@@ -43,6 +43,11 @@ module LWS::Auth
     #   @return [String] the avatar URL of the account
     attribute :avatar_url
 
+    # @!attribute app_ids
+    #   @return [Array<Integer>] the IDS of the apps that are assigned to the
+    #     account
+    attribute :app_ids
+
     # @!attribute apps
     #   @return [Array<App>] the apps that are assigned to the account
     has_many :apps
@@ -55,6 +60,11 @@ module LWS::Auth
     #   @return [Integer] the ID of the company that the account belongs to
     attribute :company_id
 
+    # @!attribute device_ids
+    #   @return [Array<Integer>] the IDs of the devices that are assigned to the
+    #     account
+    attribute :device_ids
+
     # @!attribute devices
     #   @return [Array<Device>] the devices that are assigned to the account
     has_many :devices
@@ -69,6 +79,11 @@ module LWS::Auth
     #     (at least 8 characters long)
     attribute :name
 
+    # @!attribute user_ids
+    #   @return [Array<Integer>] the IDS of the users that are assigned to the
+    #     account
+    attribute :user_ids
+
     # @!attribute users
     #   @return [Array<User>] the users that are assigned to the account
     has_many :users
@@ -78,6 +93,10 @@ module LWS::Auth
   class App < LWS::Generic::Model
     use_api LWS::Auth.api
 
+    # @!attribute account_ids
+    #   @return [Array<Integer>] the IDs of the accounts using the app
+    attribute :account_ids
+
     # @!attribute accounts
     #   @return [Array<Account>] the accounts using the app
     has_many :accounts
@@ -91,6 +110,10 @@ module LWS::Auth
     #     a newly created account and/or company
     attribute :autoassign
 
+    # @!attribute company_ids
+    #   @return [Array<Integer>] the IDS of the companies using the app
+    attribute :company_ids
+
     # @!attribute companies
     #   @return [Array<Company>] the companies using the app
     has_many :companies
@@ -99,6 +122,11 @@ module LWS::Auth
     #   @return [String] the icon ID/name of the app
     attribute :icon
 
+    # @!attribute license_ids
+    #   @return [Array<Integer>] the IDs of the licenses that provide access to
+    #     the app
+    attribute :license_ids
+
     # @!attribute licenses
     #   @return [Array<License>] the licenses that provide access to the app
     has_many :licenses
@@ -125,6 +153,11 @@ module LWS::Auth
   class Company < LWS::Generic::Model
     use_api LWS::Auth.api
 
+    # @!attribute account_ids
+    #   @return [Array<Integer>] the IDs of the accounts that are assigned to
+    #     the company
+    attribute :account_ids
+
     # @!attribute accounts
     #   @return [Array<Account>] the accounts that are assigned to the company
     has_many :accounts
@@ -133,6 +166,11 @@ module LWS::Auth
     #   @return [Boolean] whether the company has been activated
     attribute :activated
 
+    # @!attribute app_ids
+    #   @return [Array<Integer>] the IDs of the apps that are assigned to the
+    #     company
+    attribute :app_ids
+
     # @!attribute apps
     #   @return [Array<App>] the apps that are assigned to the company
     has_many :apps
@@ -157,6 +195,10 @@ module LWS::Auth
     #   @return [Integer] the ID of the contact person of the company
     attribute :contact_person_id
 
+    # @!attribute contracts
+    #   @return [Array<Integer>] the IDs of the contracts of the company
+    attribute :contract_ids
+
     # @!attribute contracts
     #   @return [Array<Contract>] the contracts of the company
     has_many :contracts, uri: "companies/:company_id/contracts(/:id)"
@@ -171,6 +213,10 @@ module LWS::Auth
     #     after the contract ends
     attribute :expire
 
+    # @!attribute licence_ids
+    #   @return [Array<Integer>] the IDs of the licenses that provide access to the app
+    attribute :license_ids
+
     # @!attribute licenses
     #   @return [Array<License>] the licenses of the company
     has_many :licenses, uri: "companies/:company_id/licenses(/:id)"
@@ -205,6 +251,11 @@ module LWS::Auth
     #      (at least 2 characters long)
     attribute :telephone_number
 
+    # @!attribute usage_report_ids
+    #   @return [Array<Integer>] the IDs of the usage reports
+    #     available/generated for the company
+    attribute :usage_report_ids
+
     # @!attribute usage_reports
     #   @return [Array<UsageReport>] the usage reports available/generated
     #     for the company

data/lib/lws/apps/corporate_website.rb

@@ -132,6 +132,11 @@ module LWS::CorporateWebsite
   class Page < LWS::Generic::Model
     use_api LWS::CorporateWebsite.api
 
+    # @!attribute article_ids
+    #   @return [Array<Integer>] the IDs of the articles that are part of the
+    #     page
+    attribute :article_ids
+
     # @!attribute articles
     #   @return [Array<Article>] the articles that are part of the page
     has_many :articles,

data/lib/lws/apps/digital_signage.rb

@@ -74,6 +74,10 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID of the display of the channel
     attribute :display_id
 
+    # @!attribute group_ids
+    #   @return [Array<Integer>] the IDs of the groups the channel is a member of
+    attribute :group_ids
+
     # @!attribute groups
     #   @return [Array<Channel::Group>] the groups the channel is a member of
     has_many :groups, class_name: "LWS::DigitalSignage::Channel::Group"
@@ -101,6 +105,10 @@ module LWS::DigitalSignage
     #      network connection
     attribute :persistent_connection
 
+    # @!attribute player_ids
+    #   @return [Array<Integer>] the IDs of the players linked to the channel
+    attribute :player_ids
+
     # @!attribute players
     #   @return [Array<Player>] the players linked to the channel
     has_many :players, class_name: "LWS::DigitalSignage::Player"
@@ -109,10 +117,18 @@ module LWS::DigitalSignage
     #   @return [Boolean] whether remote control is enabled for the channel
     attribute :remote_control
 
+    # @!attribute slide_ids
+    #   @return [Array<Integer>] the IDs of the slides schedules on the channel
+    attribute :slide_ids
+
     # @!attribute slides
     #   @return [Array<Slide>] the slides schedules on the channel
     has_many :slides, class_name: "LWS::DigitalSignage::Slide"
 
+    # @!attribute tag_ids
+    #   @return [Array<Integer>] the IDs of the tags of the channel
+    attribute :tag_ids
+
     # @!attribute tags
     #   @return [Array<Channel::Tag>] the tags of the channel
     has_many :tags, class_name: "LWS::DigitalSignage::Channel::Tag"
@@ -126,6 +142,11 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID of the time schedule of the channel
     attribute :time_schedule_id
 
+    # @!attribute time_schedule_override_ids
+    #   @return [Array<Integer>] the IDs of the time schedule overrides of the
+    #     channel
+    attribute :time_schedule_override_ids
+
     # @!attribute time_schedule_overrides
     #   @return [Array<Channel::TimeScheduleOverride>] the time schedule
     #      overrides of the channel
@@ -145,6 +166,11 @@ module LWS::DigitalSignage
     use_api LWS::DigitalSignage.api
     uri "channel/groups(/:id)"
 
+    # @!attribute channel_ids
+    #   @return [Array<Integer>] the IDs of the channels that are part of the
+    #     channel group
+    attribute :channel_ids
+
     # @!attribute channels
     #   @return [Array<Channel>] the channels that are part of the channel group
     has_many :channels, class_name: "LWS::DigitalSignage::Channel",
@@ -172,15 +198,29 @@ module LWS::DigitalSignage
     #   @return [Integer, nil] the ID of the parent group of the channel group
     attribute :parent_id
 
+    # @!attribute slide_ids
+    #   @return [Array<Integer>] the IDs of the slides schedules on the channel
+    #     group
+    attribute :slide_ids
+
     # @!attribute slides
     #   @return [Array<Slide>] the slides schedules on the channel group
     has_many :slides, class_name: "LWS::DigitalSignage::Slide"
 
+    #@!attribute tag_ids
+    #   @return [Array<Integer>] the IDs of the tags of the channel group
+    attribute :tag_ids
+
     #@!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(/:id)"
 
+    # @!attribute time_schedule_override_ids
+    #   @return [Array<Integer>] the IDs of the time schedule overrides of the
+    #     channel group
+    attribute :time_schedule_override_ids
+
     # @!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",
@@ -260,11 +300,21 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID of the company the channel time schedule belongs to
     attribute :company_id
 
+    # @!attribute channel_ids
+    #   @return [Array<Integer>] the IDs of the channels using the time
+    #     schedule
+    attribute :channel_ids
+
     # @!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(/:id)"
 
+    # @!attribute day_ids
+    #   @return [Array<Integer>] the IDs of the days included in the channel
+    #     time schedule
+    attribute :day_ids
+
     # @!attribute days
     #   @return [Array<Channel::TimeSchedule::Day>] the days included in the
     #     channel time schedule
@@ -313,6 +363,11 @@ module LWS::DigitalSignage
     use_api LWS::DigitalSignage.api
     uri "channel/time_schedule_overrides(/:id)"
 
+    # @!attribute channel_ids
+    #   @return [Array<Integer>] the IDs of the channels using the time
+    #     schedule override
+    attribute :channel_ids
+
     # @!attribute channels
     #   @return [Array<Channel>] the channels using the time schedule override
     has_many :channels, class_name: "LWS::DigitalSignage::Channel",
@@ -330,7 +385,12 @@ module LWS::DigitalSignage
     #   @return [String] the end date (inclusive) of the channel time schedule override
     attribute :end
 
-    # @!attribute channel_groups
+    # @!attribute group_ids
+    #   @return [Array<Integer>] the IDs of the channel groups using the time
+    #     schedule override
+    attribute :group_ids
+
+    # @!attribute 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(/:id)"
@@ -364,6 +424,10 @@ module LWS::DigitalSignage
     #   @return [String] the baud rate of the RS232 connection to the display
     attribute :baud_rate
 
+    # @!attribute channel_ids
+    #   @return [Array<Integer>] the IDs of the channels using the display
+    attribute :channel_ids
+
     # @!attribute channels
     #   @return [Array<Channel>] the channels using the display
     has_many :channels, class_name: "LWS::DigitalSignage::Channel"
@@ -372,6 +436,10 @@ module LWS::DigitalSignage
     #   @return [String] the data bits setting of the RS232 connection to the display
     attribute :data_bits
 
+    # @!attribute input_ids
+    #   @return [Array<Integer>] the IDs of the inputs supported by the display
+    attribute :input_ids
+
     # @!attribute inputs
     #   @return [Array<Display::Input>] the inputs supported by the display
     has_many :inputs, class_name: "LWS::DigitalSignage::Display::Input"
@@ -409,6 +477,10 @@ module LWS::DigitalSignage
     #   @return [String, nil] the result of the feedback command to turn the display off via the RS232 connection
     attribute :power_off_feedback_result
 
+    # @!attribute resolution_ids
+    #   @return [Array<Integer>] the IDs of the resolutions supported by the display
+    attribute :resolution_ids
+
     # @!attribute resolutions
     #   @return [Array<Display::Resolution>] the resolutions supported by the display
     has_many :resolutions, class_name: "LWS::DigitalSignage::Display::Resolution"
@@ -473,6 +545,11 @@ module LWS::DigitalSignage
     #   @return [String] the aspect ratio of the resolution
     attribute :aspect_ratio
 
+    # @!attribute display_ids
+    #   @return [Array<Integer>] the IDs of the displays supporting the display
+    #     resolution
+    attribute :display_ids
+
     # @!attribute displays
     #   @return [Array<Display>] the displays supporting the display resolution
     has_many :displays, class_name: "LWS::DigitalSignage::Display",
@@ -482,6 +559,11 @@ module LWS::DigitalSignage
     #   @return [Integer] the height of the resolution
     attribute :height
 
+    # @!attribute model_ids
+    #   @return [Array<Integer>] the IDs of the player models that support the
+    #     display resolution
+    attribute :model_ids
+
     # @!attribute models
     #   @return [Array<Player::Model>] the player models that support the
     #     display resolution
@@ -581,6 +663,10 @@ module LWS::DigitalSignage
     #     layout
     attribute :rotation
 
+    # @!attribute slide_ids
+    #   @return [Array<Integer>] the IDs of the slides using the layout
+    attribute :slide_ids
+
     # @!attribute slides
     #   @return [Array<Slide>] the slides using the layout
     has_many :slides, class_name: "LWS::DigitalSignage::Slide",
@@ -604,6 +690,10 @@ module LWS::DigitalSignage
     #   @return [Integer] the duration of the transition of the entire layout
     attribute :trans_duration
 
+    # @!attribute version_ids
+    #   @return [Array<Integer>] the IDs of the versions of the layout
+    attribute :version_ids
+
     # @!attribute versions
     #   @return [Array<Version>] the versions of the layout
     has_many :versions, class_name: "LWS::DigitalSignage::Layout::Version",
@@ -619,6 +709,11 @@ module LWS::DigitalSignage
     #   @return [String, nil] the description of the layout category
     attribute :description
 
+    # @!attribute layout_ids
+    #   @return [Array<Integer>] the IDs of the layouts that are associated
+    #     with the category
+    attribute :layout_ids
+
     # @!attribute layouts
     #   @return [Array<Layout>] the layouts that are associated with
     #     the category
@@ -653,6 +748,11 @@ module LWS::DigitalSignage
     #   @return [Array<Hash{String => String}>] the assets of the layout element
     attribute :asset_urls
 
+    # @!attribute customizable_ids
+    #  @return [Array<Integer>] the IDs of the customizable properties of the
+    #    layout element
+    attribute :customizable_ids
+
     # @!attribute customizables
     #  @return [Array<Layout::Element::Customizable>] the customizable properties
     #    of the layout element
@@ -683,6 +783,10 @@ module LWS::DigitalSignage
     #   @return [Integer, nil] the ID of the parent of the layout element
     attribute :parent_id
 
+    # @!attribute property_ids
+    #  @return [Array<Integer>] the IDs of the properties of the layout element
+    attribute :property_ids
+
     # @!attribute properties
     #  @return [Array<Layout::Element::Property>] the properties of the layout
     #    element
@@ -803,6 +907,11 @@ module LWS::DigitalSignage
     #     version (if accessible)
     attribute :archive_url
 
+    # @!attribute element_ids
+    #   @return [Array<Integer>] the IDs of the elements contained in the
+    #     layout version
+    attribute :element_ids
+
     # @!attribute elements
     #   @return [Array<Layout::Element>] the elements contained in the layout
     #     version
@@ -863,6 +972,10 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID of the company the player belongs to
     attribute :company_id
 
+    # @!attribute component_ids
+    #   @return [Array<Integer>] the IDs of the components of the player
+    attribute :component_ids
+
     # @!attribute components
     #   @return [Array<Player::Component>] the components of the player
     has_many :components, class_name: "LWS::DigitalSignage::Player::Component"
@@ -888,6 +1001,10 @@ module LWS::DigitalSignage
     #   @return [String] the hostname used by the player (for DHCP for example)
     attribute :hostname
 
+    # @!attribute log_ids
+    #   @return [Array<Integer>] the IDs of the logs of the player
+    attribute :log_ids
+
     # @!attribute logs
     #   @return [Array<Player::Log>] the logs of the player
     has_many :logs, class_name: "LWS::DigitalSignage::Player::Log"
@@ -913,6 +1030,10 @@ module LWS::DigitalSignage
     #   @return [String] the name of the player
     attribute :name
 
+    # @!attribute notification_ids
+    #   @return [Array<Integer>] the IDs of the notifications for the player
+    attribute :notification_ids
+
     # @!attribute notifications
     #   @return [Array<Player::Notification>] the notifications for the player
     has_many :notifications, class_name: "LWS::DigitalSignage::Player::Notification"
@@ -930,6 +1051,10 @@ module LWS::DigitalSignage
     #   @return [String, nil] the OS version the player is using (if known)
     attribute :os_release_version
 
+    # @!attribute part_ids
+    #   @return [Array<Integer>] the IDs of the parts of the player
+    attribute :part_ids
+
     # @!attribute parts
     #   @return [Array<Player::Component::Part>] the parts of the player
     has_many :parts, class_name: "LWS::DigitalSignage::Player::Component::Part"
@@ -953,10 +1078,18 @@ module LWS::DigitalSignage
     #     player
     attribute :release_channel_id
 
+    # @!attribute request_ids
+    #   @return [Array<Integer>] the IDs of the requests for the player
+    attribute :request_ids
+
     # @!attribute requests
     #   @return [Array<Player::Request>] the requests for the player
     has_many :requests, class_name: "LWS::DigitalSignage::Player::Request"
 
+    # @!attribute screenshot_ids
+    #   @return [Array<Integer>] the IDs of the screenshots of the player
+    attribute :screenshot_ids
+
     # @!attribute screenshots
     #   @return [Array<Player::Screenshot>] the screenshots of the player
     has_many :screenshots, class_name: "LWS::DigitalSignage::Player::Screenshot"
@@ -987,6 +1120,10 @@ module LWS::DigitalSignage
     #   @return [String] the date/time the status was last updated
     attribute :status_updated_at
 
+    # @!attribute tag_ids
+    #   @return [Array<Tag>] the IDs of the tags of the player
+    attribute :tag_ids
+
     # @!attribute tags
     #   @return [Array<Player::Tag>] the tags of the player
     has_many :tags, class_name: "LWS::DigitalSignage::Player::Tag"
@@ -1001,6 +1138,11 @@ module LWS::DigitalSignage
     #   @return [String, nil] the description of the player component
     attribute :description
 
+    # @!attribute model_ids
+    #   @return [Array<Integer>] the IDs of the player models that use the
+    #     component
+    attribute :model_ids
+
     # @!attribute models
     #   @return [Array<Player::Model>] the player models that use the component
     has_many :models, class_name: "LWS::DigitalSignage::Player::Model",
@@ -1010,6 +1152,10 @@ module LWS::DigitalSignage
     #   @return [String] the name of the player component
     attribute :name
 
+    # @!attribute part_ids
+    #   @return [Array<Integer>] the IDs of the parts the component is made out of
+    attribute :part_ids
+
     # @!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",
@@ -1082,6 +1228,11 @@ module LWS::DigitalSignage
     #   @return [String] the name of the player configuration
     attribute :name
 
+    # @!attribute player_ids
+    #   @return [Array<Integer>] the IDs of the players the configuration is
+    #     used for
+    attribute :player_ids
+
     # @!attribute players
     #   @return [Array<Player>] the players the configuration is used for
     has_many :players, class_name: "LWS::DigitalSignage::Player",
@@ -1098,8 +1249,14 @@ module LWS::DigitalSignage
     #     as a basis for the player configuration
     attribute :predefined_configuration_id
 
+    # @!attribute setting_ids
+    #    @return [Array<Integer>] the IDs of the settings of the player
+    #      configuration
+    attribute :setting_ids
+
     # @!attribute settings
-    #    @return [Player::Configuration::Setting] the settings of the player configuration
+    #    @return [Array<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(/:id)"
   end
@@ -1167,18 +1324,33 @@ module LWS::DigitalSignage
     use_api LWS::DigitalSignage.api
     uri "player/models(/:id)"
 
+    # @!attribute branch_ids
+    #   @return [Array<Integer>] the IDs of the player OS branches allowed for
+    #     the player model
+    attribute :branch_ids
+
     # @!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(/:id)"
 
+    # @!attribute capability_ids
+    #   @return [Array<Integer>] the IDs of the capabilities of the player
+    #     model
+    attribute :capability_ids
+
     # @!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(/:id)"
 
+    # @!attribute component_ids
+    #   @return [Array<Integer>] the IDs of the player components that are used
+    #     in the player model
+    attribute :component_ids
+
     # @!attribute components
     #   @return [Array<Player::Component>] the player components that are
     #     used in the player model
@@ -1194,17 +1366,32 @@ module LWS::DigitalSignage
     #   @return [String] the name of the player model
     attribute :name
 
+    # @!attribute player_ids
+    #   @return [Array<Integer>] the IDs of the player that have the player
+    #     model
+    attribute :player_ids
+
     # @!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(/:id)"
 
+    # @!attribute release_channel_ids
+    #   @return [Array<Integer>] the IDs of the player OS release channels used
+    #     for the player model
+    attribute :release_channel_ids
+
     # @!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(/:id)"
 
+    # @!attribute resolution_ids
+    #   @return [Array<Integer>] the IDs of the display resolutions supported
+    #     by the player model
+    attribute :resolution_ids
+
     # @!attribute resolutions
     #   @return [Array<Display::Resolution>] the display resolutions
     #     supported by the player model
@@ -1308,6 +1495,11 @@ module LWS::DigitalSignage
     use_api LWS::DigitalSignage.api
     uri "player/os/branches(/:id)"
 
+    # @!attribute model_ids
+    #   @return [Array<Integer>] the IDs of the player models that allow the
+    #     player OS branch to be used
+    attribute :model_ids
+
     # @!attribute models
     #   @return [Array<Player::Model>] the player models that allow the player
     #     OS branch to be used
@@ -1328,6 +1520,11 @@ module LWS::DigitalSignage
     #     is for
     attribute :release_channel_id
 
+    # @!attribute release_ids
+    #   @return [Array<Integer>] the IDs of the releases that are part of the
+    #     branch
+    attribute :release_ids
+
     # @!attribute releases
     #   @return [Array<Player::Os::Branch::Release>] the releases that are part
     #     of the branch
@@ -1369,6 +1566,11 @@ module LWS::DigitalSignage
     #   @return [String] the message of the release (commit)
     attribute :commit_message
 
+    # @!attribute package_version_ids
+    #   @return [Array<Integer>] the IDs of the player OS package versions in
+    #     this release
+    attribute :package_version_ids
+
     # @!attribute package_versions
     #   @return [Array<Player::Os::Package::Version>] the player OS package
     #     versions in this release
@@ -1376,6 +1578,11 @@ module LWS::DigitalSignage
     has_many :package_versions, class_name: "LWS::DigitalSignage::Player::Os::Package::Version",
                                 uri: "player/os/branches/:branch_id/releases/:release_id/package_versions(/:id)"
 
+    # @!attribute package_version_change_ids
+    #   @return [Array<Integer>] the IDs of the player OS package version
+    #     changes in this release
+    attribute :package_version_change_ids
+
     # @!attribute package_version_changes
     #   @return [Array<Player::Os::Package::VersionChange>] the player OS package
     #     version changes in this release
@@ -1406,10 +1613,15 @@ module LWS::DigitalSignage
     #    release is a promotion of
     attribute :promoted_release_id
 
+    # @!attribute promoting_release_ids
+    #   @return [Array<Integer>] the IDs of the player OS branch releases that
+    #     promote the release
+    attribute :promoting_release_ids
+
     # @!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"
+    has_many :promoting_releases, class_name: "LWS::DigitalSignage::Player::Os::Branch::Release"
 
     # @!attribute version
     #   @return [String] the version of the release
@@ -1425,12 +1637,22 @@ module LWS::DigitalSignage
     #   @return [String] the name of the player OS package
     attribute :name
 
+    # @!attribute version_change_ids
+    #   @return [Array<Integer>] the IDs of the version changes of the player
+    #     OS package present in branches
+    attribute :version_change_ids
+
     # @!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(/:id)"
 
+    # @!attribute version_ids
+    #   @return [Array<Integer>] the IDs of the versions of the player OS
+    #     package present in branches
+    attribute :version_ids
+
     # @!attribute versions
     #   @return [Array<Player::Os::Package::Version>] the versions of the
     #     player OS package present in branches
@@ -1460,6 +1682,11 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID the player OS package the version is of
     attribute :package_id
 
+    # @!attribute branch_release_ids
+    #   @return [Array<Integer>] the IDs of the branch releases the player OS
+    #     package version is a part of
+    attribute :branch_release_ids
+
     # @!attribute branch_releases
     #   @return [Array<Player::Os::Branch::Release>] the branch releases the
     #     player OS package version is a part of
@@ -1554,6 +1781,11 @@ module LWS::DigitalSignage
     use_api LWS::DigitalSignage.api
     uri "player/os/release_channels(/:id)"
 
+    # @!attribute branch_ids
+    #   @return [Array<Integer>] the IDs of the branches that belong to the
+    #     player OS release channel
+    attribute :branch_ids
+
     # @!attribute branches
     #   @return [Array<Player::Os::Branch>] the branches that belong to the
     #     player OS release channel
@@ -1564,6 +1796,11 @@ module LWS::DigitalSignage
     #   @return [String] the name of the player OS release channel
     attribute :name
 
+    # @!attribute player_ids
+    #   @return [Array<Integer>] the IDs of the players that use the player OS
+    #     release channel
+    attribute :player_ids
+
     # @!attribute players
     #   @return [Array<Player>] the players that use the player OS release channel
     has_many :players, class_name: "LWS::DigitalSignage::Player",
@@ -1587,6 +1824,11 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID of the company the predefined player configuration belongs to
     attribute :compandy_id
 
+    # @!attribute configuration_ids
+    #   @return [Array<Integer>] the IDs of the player configurations that use
+    #     the predefined player configuration as a basis
+    attribute :configuration_ids
+
     # @!attribute configurations
     #   @return [Array<Player::Configuration>] the player configurations that use
     #     the predefined player configuration as a basis
@@ -1601,9 +1843,14 @@ module LWS::DigitalSignage
     #   @return [String] the name of the predefined player configuration
     attribute :name
 
+    # @!attribute setting_ids
+    #    @return [Array<Integer>] the IDs of the settings of the predefined
+    #      player configuration
+    attribute :setting_ids
+
     # @!attribute settings
-    #    @return [Player::PredefinedConfiguration::Setting] the settings of the
-    #      predefined player configuration
+    #    @return [Array<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(/:id)"
   end
@@ -1769,10 +2016,19 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID of the account used for creating the slide
     attribute :account_id
 
+    # @!attribute channel_ids
+    #   @return [Array<Integer>] the IDs of the channels the slide is scheduled on
+    attribute :channel_ids
+
     # @!attribute channels
     #   @return [Array<Channel>] the channels the slide is scheduled on
     has_many :channels, class_name: "LWS::DigitalSignage::Channel"
 
+    # @!attribute channel_group_ids
+    #   @return [Array<Integer>] the IDs of the channel group the slide is
+    #     scheduled on
+    attribute :channel_group_ids
+
     # @!attribute channel_groups
     #   @return [Array<Channel::Group>] the channel group the slide is
     #     scheduled on
@@ -1819,6 +2075,11 @@ module LWS::DigitalSignage
     #   @return [Integer] the order priority within a playlist for a channel
     attribute :order_priority
 
+    # @!attribute schedule_ids
+    #   @return [Array<Integer>] the IDs of the slide schedules that apply for
+    #     the slide
+    attribute :schedule_ids
+
     # @!attribute schedules
     #   @return [Array<Schedule>] the slide schedules that apply for the slide
     has_many :schedules, class_name: "LWS::DigitalSignage::Slide::Schedule"
@@ -1867,6 +2128,11 @@ module LWS::DigitalSignage
     #     schedule
     attribute :skip_every
 
+    # @!attribute slide_ids
+    #   @return [Array<Integer>] the IDs of the slides that use the slide
+    #     schedule
+    attribute :slide_ids
+
     # @!attribute slides
     #   @return [Array<Slide>] the slides that use the slide schedule
     # FIXME: Missing endpoint in LWS

data/lib/lws/apps/generic.rb

@@ -64,7 +64,7 @@ module LWS::Generic
     # @private
     # @!visibility private
     #
-    # Adds an attribute for this class.
+    # Adds an attribute for this class; also adds change tracking.
     #
     # @note
     #   This is just a singular version helper method of the +attributes+
@@ -80,6 +80,34 @@ module LWS::Generic
       end
     end
 
+    # @private
+    # @!visibility private
+    #
+    # Adds change tracking for the +_ids+ method related to has-many
+    # assocation.
+    #
+    # @param [Symbol] name the name of the has-many relation
+    # @param [Hash] options the options of the has-many relation
+    # @raise [NameError] if the +_ids+ method has not been defined as an
+    #   attribute (yet)
+    # @return [void]
+    def self.has_many(name, options = {})
+      name_sing = name.to_s.singularize
+      unless method_defined?("#{name_sing}_ids")
+        raise NameError, "missing definition of attribute #{name_sing}_ids"
+      end
+
+      super
+
+      alias_method :"orig_#{name_sing}_ids=", :"#{name_sing}_ids="
+      define_method(:"#{name_sing}_ids=") do |ids|
+        unless ids.reject(&:blank?) == send(:"#{name_sing}_ids")
+          send(:"#{name_sing}_ids_will_change!")
+        end
+        send(:"orig_#{name_sing}_ids=", ids)
+      end
+    end
+
     # @private
     # @!visibility private
     #

data/lib/lws/apps/maps.rb

@@ -47,8 +47,12 @@ module LWS::Maps
     #   @return [Integer] the ID of the company that maintains/owns the map
     attribute :company_id
 
+    # @!attribute marker_ids
+    #   @return [Array<Integer>] the IDs of the associated markers
+    attribute :marker_ids
+
     # @!attribute markers
-    #   @return [Array<Marker>] the list of associated markers
+    #   @return [Array<Marker>] the associated markers
     has_many :markers
 
     # @!attribute name
@@ -102,6 +106,10 @@ module LWS::Maps
     #      map source
     attribute :key
 
+    # @!attribute map_ids
+    #   @return [Array<Integer>] the IDs of the maps using the map source
+    attribute :map_ids
+
     # @!attribute maps
     #   @return [Array<Map>] the maps using the map source
     has_many :maps

data/lib/lws/apps/presence.rb

@@ -75,6 +75,11 @@ module LWS::Presence
     #   @return [Fixnum] the ID of the organiser of the appointment
     attribute :organiser_id
 
+    # @!attribute person_ids
+    #   @return [Array<Integer>] the IDs of the people associated with the
+    #     appointment
+    attribute :person_ids
+
     # @!attribute people
     #   @return [Array<Person>] the people associated with the appointment
     has_many :people
@@ -137,6 +142,11 @@ module LWS::Presence
     #     including the location itself
     attribute :ancestor_ids
 
+    # @!attribute appointment_ids
+    #   @return [Array<Integer>] the IDs of the appointments taking place at
+    #     the location
+    attribute :appointment_ids
+
     # @!attribute appointments
     #   @return [Array<Appointment>] the appointments taking place at the location
     has_many :appointments
@@ -225,6 +235,11 @@ module LWS::Presence
     #     appointments involving the location
     attribute :invite_remarks
 
+    # @!attribute journal_ids
+    #   @return [Array<Integer>] the IDs of the journal (entries) associated
+    #     with the location
+    attribute :journal_ids
+
     # @!attribute journals
     #   @return [Array<Journal>] the journal (entries) associated with the location
     has_many :journals, class: "LWS::Presence::Journal"
@@ -243,11 +258,20 @@ module LWS::Presence
     #   @return [Float] the longitude of the location
     attribute :long
 
+    # @!attribute map_position_ids
+    #   @return [Array<Integer>] the IDs of the location map positions that
+    #     track this location
+    attribute :map_position_ids
+
     # @!attribute map_positions
     #   @return [Array<Location::Map::Position>] the location map positions
     #     that track this location
     has_many :map_positions, class_name: "LWS::Presence::Location::Map::Position"
 
+    # @attribute map_ids
+    #   @return [Array<Integer>] the IDs of the maps for this location
+    attribute :map_ids
+
     # @attribute maps
     #   @return [Array<Location::Map>] the maps for this location
     has_many :maps, class_name: "LWS::Presence::Location::Map"
@@ -276,10 +300,20 @@ module LWS::Presence
     #   @return [Integer] the ID of the parent of the location
     attribute :parent_id
 
+    # @!attribute person_ids
+    #   @return [Array<Integer>] the IDs of the people associated with the
+    #     location
+    attribute :person_ids
+
     # @!attribute people
     #   @return [Array<Person>] the people associated with the location
     has_many :people
 
+    # @!attribute people_tree_ids
+    #   @return [Array<Integer>] the IDs of the people associated with the
+    #   location including descendant locations
+    attribute :people_tree_ids
+
     # @!attribute people_tree
     #   @return [Array<Person>] the people associated with the location
     #     including descendant locations
@@ -289,6 +323,11 @@ module LWS::Presence
     #   @return [Integer] the range around the location in meters
     attribute :range
 
+    # @!attribute reader_ids
+    #   @return [Array<Integer>] the IDs of the (RFID/code/ID/...) readers
+    #     linked to this location
+    attribute :reader_ids
+
     # @!attribute readers
     #   @return [Array<Reader>] the (RFID/code/ID/...) readers linked to this location
     has_many :readers
@@ -358,6 +397,10 @@ module LWS::Presence
     #     present
     attribute :position
 
+    # @!attribute position_ids
+    #   @return [Array<Integer>] the IDs of the positions linked to this map
+    attribute :position_ids
+
     # @!attribute positions
     #   @return [Array<Location::Map::Position>] the positions linked to this
     #     map
@@ -458,6 +501,11 @@ module LWS::Presence
     #   @return [String, nil] the address of the person
     attribute :address
 
+    # @!attribute appointment_ids
+    #   @return [Array<Appointment>] the IDs of the appointments involving the
+    #     person
+    attribute :appointment_ids
+
     # @!attribute appointments
     #   @return [Array<Appointment>] the appointments involving the person
     has_many :appointments
@@ -563,6 +611,11 @@ module LWS::Presence
     #   @return [String] the name of the person
     attribute :name
 
+    # @!attribute people_responsible_for_ids
+    #   @return [Array<Integer>] the IDs of the people the person is
+    #     responsible for
+    attribute :people_responsible_for_ids
+
     # @!attribute people_responsible_for
     #   @return [Array<Person>] the people the person is responsible for
     has_many :people_responsible_for, class_name: "LWS::Presence::Person"

data/lib/lws/apps/resource.rb

@@ -88,11 +88,17 @@ module LWS::Resource
     #     filed in
     attribute :folder_id
 
+    # @!attribute item_ids
+    #   @return [Array<Integer>] the ID of the items that are part of the
+    #     collection
+    attribute :item_ids
+
     # @!attribute items
-    #   The returned object are of a class that is determined by the kind of
-    #   this collection.
+    #   The returned cllection item (sub)class that is determined by the kind
+    #   of this collection.
     #
-    #   @return [Collection::Item] the items that are part of the collection
+    #   @return [Array<Collection::Item>] the items that are part of the
+    #     collection
     has_many :items, class_name: "LWS::Resource::Collection::Item"
 
     # @!attribute kind
@@ -116,76 +122,6 @@ module LWS::Resource
     # @!attribute uuid
     #   @return [String] the UUID used for unique file name generation
     attribute :uuid
-
-
-    # @!group Collection Items Attribute Summary
-
-    # @!attribute config
-    #   @return [Collection::Config] the configuration that is part of the
-    #     collection (if kind is +:config+)
-    has_one :config
-
-    # @!attribute feed
-    #   @return [Collection::Feed] the feed that is part of the collection
-    #     (if kind is +:feed+)
-    has_one :feed
-
-    # @!attribute feeds
-    #   @return [Array<Collection::Feed>] the feeds that are part of the collection
-    #     (if kind is +:feeds+)
-    has_many :feeds
-
-    # @!attribute image
-    #   @return [Collection::Image] the image that is part of the collection
-    #     (if kind is +:image+)
-    has_one :image
-
-    # @!attribute images
-    #   @return [Array<Collection::Image>] the images that are part of the
-    #     collection (if kind is +:images+)
-    has_many :images
-
-    # @!attribute powerpoint
-    #   @return [Collection::PowerPoint] the PowerPoint presentation that is
-    #     part of the collection (if kind is +:powerpoint+)
-    has_one :powerpoint
-
-    # @!attribute youtube
-    #   @return [Collection::YouTube] the YouTube video that is part of the collection
-    #     (if kind is +:youtube+)
-    has_one :youtube
-
-    # @!attribute youtubes
-    #   @return [Array<Collection::YouTube>] the YouTube videos that are part
-    #     of the collection (if kind is +:youtubes+)
-    has_many :youtubes
-
-    # @!attribute video
-    #   @return [Collection::Video] the video that is part of the collection
-    #     (if kind is +:video+)
-    has_one :video
-
-    # @!attribute videos
-    #   @return [Array<Collection::Video>] the videos that are part of the
-    #     collection (if kind is +:videos+)
-    has_many :videos
-
-    # @!attribute vimeo
-    #   @return [Collection::Vimeo] the Vimeo video that is part of the collection
-    #     (if kind is +:vimeo+)
-    has_one :vimeo
-
-    # @!attribute vimeos
-    #   @return [Array<Collection::Vimeo>] the Vimeo videos that are part of
-    #     the collection (if kind is +:vimeos+)
-    has_many :vimeos
-
-    # @!attribute weather_location
-    #   @return [Collection::WeatherLocation] the weather collection that is
-    #     part of the collection (if kind is +:weather_location+)
-    has_one :weather_location
-
-    # @!endgroup Collection Items Attribute Summary
   end
 
   # = The collection item class
@@ -297,6 +233,10 @@ module LWS::Resource
     #   @return [String] the URL of the feed
     attribute :feed_url
 
+    # @!attribute post_ids
+    #   @return [Collection::Post] the IDs of the posts included in the feed
+    attribute :post_ids
+
     # @!attribute posts
     #   @return [Collection::Post] the posts included in the feed
     has_many :posts,
@@ -402,6 +342,10 @@ module LWS::Resource
     #   @return [String] the URL of the feed of the weather location
     attribute :feed_url
 
+    # @!attribute forecast_ids
+    #   @return [Forecast] the IDs of the forecasts for the weather location
+    attribute :forecast_ids
+
     # @!attribute forecasts
     #   @return [Forecast] the forecasts for the weather location
     has_many :forecasts,
@@ -502,6 +446,10 @@ module LWS::Resource
     #     the folder
     attribute :account_id
 
+    # @!attribute collection_ids
+    #   @return [Array<Integer>] the IDs of the collections filed in the folder
+    attribute :collection_ids
+
     # @!attribute collections
     #   @return [Array<Collection>] the collections filed in the folder
     has_many :collections
@@ -524,9 +472,15 @@ module LWS::Resource
 
     # @!attribute email [r]
     #   @return [String] the email adress of the folder
+    attribute :email
+
+    # @!attribute folder_ids
+    #   @return [Array<Integer>] the IDs of the (child) folders contained in
+    #     the folder
+    attribute :folder_ids
 
     # @!attribute folders
-    #   @return [Array<Folder>] the folders contained in the folder
+    #   @return [Array<Folder>] the (child) folders contained in the folder
     has_many :folders
 
     # @!attribute favourite

data/lib/lws/apps/ticket.rb

@@ -83,6 +83,11 @@ module LWS::Ticket
     #   @return [String] the slug of the ticket group
     attribute :slug
 
+    # @!attribute ticket_ids
+    #   @return [Array<Integer>] the IDs of the tickets that are assigned to
+    #     the ticket group
+    attribute :ticket_ids
+
     # @!attribute tickets
     #   @return [Array<Ticket>] the tickets that are assigned to the ticket
     #     group
@@ -103,6 +108,11 @@ module LWS::Ticket
     #     ticket message
     attribute :account_id
 
+    # @!attribute attachment_ids
+    #   @return [Array<Integer>] the IDs of the attachments associated with the
+    #     ticket message
+    attribute :attachment_ids
+
     # @!attribute attachments
     #   @return [Array<Attachment>] the attachments associated with the ticket
     #     message
@@ -163,6 +173,10 @@ module LWS::Ticket
     #   @return [String] the slug of the ticket tag
     attribute :slug
 
+    # @!attribute ticket_ids
+    #   @return [Array<Ticket>] the IDs of the ticket associated with the tag
+    attribute :ticket_ids
+
     # @!attribute tickets
     #   @return [Array<Ticket>] the ticket associated with the tag
     has_many :tickets
@@ -224,6 +238,11 @@ module LWS::Ticket
     #   @return [Integer] the ID of the group the ticket belongs to
     attribute :group_id
 
+    # @!attribute message_ids
+    #   @return [Array<Integer>] the IDs of the messages associated with the
+    #     ticket
+    attribute :message_ids
+
     # @!attribute messages
     #   @return [Array<Message>] the messages associated with the ticket
     has_many :messages
@@ -248,6 +267,10 @@ module LWS::Ticket
     #     "feedback", "priority", "reassign"] the current ticket status
     attribute :status
 
+    # @!attribute tag_ids
+    #   @return [Array<Integer>] the IDs of the tags associated with the ticket
+    attribute :tag_ids
+
     # @!attribute tags
     #   @return [Array<Tag>] the tags associated with the ticket
     has_many :tags

data/lib/lws/version.rb

@@ -14,6 +14,6 @@ module LWS
 
   # The LWS library version.
   # @note The major and minor version parts match the LWS API version!
-  VERSION = "9.0.0".freeze
+  VERSION = "9.0.1".freeze
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.0.1
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache