alula-ruby 1.9.17 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e9f0e6ff0e31911866a362f9760cbc37d7022bac31293e7acffefd937dc68b6
-  data.tar.gz: 4832ba87fc2f8d5e1ee84f070c8cf25f600c15ee9ff839f76665c86c9696d004
+  metadata.gz: 3a1e7ffa073f707398977ddeda42b71e4d53d0e85ec7dc43706ed54b2d5f2c97
+  data.tar.gz: 0cd33559f523abf10bd6288f5b51b5fc9e80829292e10dac8735a1accfee3ef8
 SHA512:
-  metadata.gz: b57b00d0f9b3d684d9b1127e343a6486a8b87bb241507b6567f70ed1ae9889f31a437483a5a329b1dc10cb9c862ce865b695153cd21dc9936b7b0101c786a04f
-  data.tar.gz: bda93617f2753c44b1f278c89db25bdcafd0d5d0c6ecc2e3fe13c18dab41df4f10d77c0ffda54a37140b7ccb3a9dc9b21ee45b2bcf62018030a0376dccb1b889
+  metadata.gz: 2625ebca239b0856ff1b48f48431d619a728392137d247f5880fe60a2a6b436c6ddd6aaae3c3c9b75138e40a8d6fe0b5f6968bac2325ed6720e0088e443219bb
+  data.tar.gz: cdc90a0521b929a9b583a0d8a88dca8202f7a31a4c866724375e222768d7ad913e60622e94a3cc69ab8dc06238a3ce466618ad902e7a4d3c525fe900c8864e22

data/VERSION.md

@@ -2,6 +2,7 @@
 
 | Version | Date        | Description                                                                 |
 | ------- | ------------| --------------------------------------------------------------------------- |
+| v1.10.0 | 2024-09-18  | Add DeviceUser and HelixUser resources |
 | v1.9.17 | 2024-09-17  | Bump HTTParty version |
 | v1.9.16 | 2024-09-04  | Add get camera stats proc |
 | v1.9.15 | 2024-09-02  | Add impersonated_by accessor to the ImpersonatedToken |

data/lib/alula/resources/device.rb

@@ -32,10 +32,10 @@ module Alula
     relationship :dealer, type: 'dealers', cardinality: 'To-one'
     # relationship :eventlog, type: 'devices-eventlog', cardinality: 'To-many'
     relationship :receiver_group, type: 'receivers-groups', cardinality: 'To-one'
-    # relationship :helix_users, type: 'helix-user', cardinality: 'To-many'
+    relationship :helix_users, type: 'helix-users', cardinality: 'To-many'
     relationship :notifications, type: 'devices-notifications', cardinality: 'To-many'
     relationship :video_verification_cameras, type: 'video-verification-cameras', cardinality: 'To-many'
-    # relationship :users, type: 'devices-user', cardinality: 'To-many'
+    relationship :users, type: 'devices-users', cardinality: 'To-many'
     # relationship :features_supported, type: 'devices-features-supported', cardinality: 'To-one'
     # relationship :features_disabled, type: 'devices-features-disabled', cardinality: 'To-one'
 

data/lib/alula/resources/device_user.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Alula
+  class DeviceUser < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+    extend Alula::ApiOperations::Delete
+
+    resource_path 'devices/users'
+    type 'devices-users'
+
+    relationship :device, type: 'devices', cardinality: 'To-one'
+    relationship :user, type: 'users', cardinality: 'To-one'
+    relationship :helix_users, type: 'helix-users', cardinality: 'To-many'
+    # unused relationships below
+    # relationship :hybrid_panel_users, type: 'devices-partitions-users', cardinality: 'To-many'
+
+    field :id,
+          type: :string,
+          sortable: false,
+          filterable: false
+
+    field :device_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user]
+
+    field :user_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user]
+
+    field :panel_user_index,
+          type: :number,
+          sortable: true,
+          filterable: true,
+          creatable_by: %i[system station dealer technician user],
+          patchable_by: %i[system station dealer technician user]
+  end
+end

data/lib/alula/resources/helix_user.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Alula
+  # HelixUser records are present for anything older than XiP
+  # There might be records for XiP as well, but DeviceUser should be used instead
+  class HelixUser < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+
+    resource_path 'helix/users'
+    type 'helix-users'
+
+    relationship :device, type: 'devices', cardinality: 'To-one'
+    relationship :user, type: 'users', cardinality: 'To-one'
+
+    field :id,
+          type: :string,
+          sortable: false,
+          filterable: false
+
+    field :device_id,
+          type: :string,
+          sortable: false,
+          filterable: true
+
+    field :user_id,
+          type: :string,
+          sortable: false,
+          filterable: true
+
+    field :number,
+          type: :number,
+          sortable: true,
+          filterable: false
+
+    field :pin,
+          type: :string,
+          patchable_by: %i[system station dealer technician user]
+
+    field :auth_master,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :auth_installer,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :auth_dealer,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :auth_system_test,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :auth_edit_user_credentials,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :auth_bypass_zones,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_disarm,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_stay,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_night,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_away,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_all_off,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_level1,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_level2,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_level3,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_level4,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_level5,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_level6,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_level7,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :allow_level8,
+          type: :boolean,
+          patchable_by: %i[system station dealer technician user]
+
+    field :sync_needed,
+          type: :boolean
+
+    field :is_new,
+          type: :boolean
+  end
+end

data/lib/alula/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Alula
-  VERSION = '1.9.17'
+  VERSION = '1.10.0'
 end

data/lib/alula.rb

@@ -32,6 +32,7 @@ require_relative 'alula/resources/device_credit'
 require_relative 'alula/resources/device_event_log'
 require_relative 'alula/resources/device_cellular_status'
 require_relative 'alula/resources/device_program'
+require_relative 'alula/resources/device_user'
 require_relative 'alula/resources/dealer_address'
 require_relative 'alula/resources/dealer_phone'
 require_relative 'alula/resources/dealer_account_transfer'
@@ -39,6 +40,7 @@ require_relative 'alula/resources/dealer_suspension_log'
 require_relative 'alula/resources/dealer_program'
 require_relative 'alula/resources/event_trigger'
 require_relative 'alula/resources/event_webhook'
+require_relative 'alula/resources/helix_user'
 require_relative 'alula/resources/self'
 require_relative 'alula/resources/user'
 require_relative 'alula/resources/user_phone'
@@ -121,6 +123,7 @@ module Alula
     Alula::DeviceCredit,
     Alula::DeviceEventLog,
     Alula::DeviceNotification,
+    Alula::DeviceUser,
     Alula::VideoVerificationCamera,
     Alula::DeviceProgram,
     Alula::DealerAddress,
@@ -129,6 +132,7 @@ module Alula
     Alula::FeaturePlan,
     Alula::FeaturePlanVideo,
     Alula::FeaturePrice,
+    Alula::HelixUser,
     Alula::OAuthClient,
     Alula::ReceiverGroup,
     Alula::ReceiverDisabled,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alula-ruby
 version: !ruby/object:Gem::Version
-  version: 1.9.17
+  version: 1.10.0
 platform: ruby
 authors:
 - Titus Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -270,12 +270,14 @@ files:
 - lib/alula/resources/device_event_log.rb
 - lib/alula/resources/device_notification.rb
 - lib/alula/resources/device_program.rb
+- lib/alula/resources/device_user.rb
 - lib/alula/resources/event_trigger.rb
 - lib/alula/resources/event_webhook.rb
 - lib/alula/resources/feature_bysubject.rb
 - lib/alula/resources/feature_plan.rb
 - lib/alula/resources/feature_planvideo.rb
 - lib/alula/resources/feature_price.rb
+- lib/alula/resources/helix_user.rb
 - lib/alula/resources/oauth_client.rb
 - lib/alula/resources/receiver_connection.rb
 - lib/alula/resources/receiver_disabled.rb