RubyGems - alula-ruby - Versions diffs - 0.50.1 - Mend

alula-ruby 0.50.1

Files changed (102) hide show

checksums.yaml +7 -0
data/.circleci/config.yml +14 -0
data/.env.example +8 -0
data/.github/workflows/gem-push.yml +45 -0
data/.gitignore +23 -0
data/.rspec +3 -0
data/.travis.yml +7 -0
data/Dockerfile +6 -0
data/Gemfile +12 -0
data/Guardfile +42 -0
data/README.md +423 -0
data/Rakefile +6 -0
data/VERSION.md +84 -0
data/alula-docker-compose.yml +80 -0
data/alula.gemspec +38 -0
data/bin/console +15 -0
data/bin/docparse +36 -0
data/bin/genresource +79 -0
data/bin/setup +8 -0
data/bin/testauth +24 -0
data/bin/testprep +9 -0
data/data/docs/Alula_API_Documentation_2021-04-06.html +16240 -0
data/docker-compose.yml +11 -0
data/lib/alula/alula_response.rb +20 -0
data/lib/alula/api_operations/delete.rb +52 -0
data/lib/alula/api_operations/list.rb +45 -0
data/lib/alula/api_operations/request.rb +44 -0
data/lib/alula/api_operations/save.rb +81 -0
data/lib/alula/api_resource.rb +196 -0
data/lib/alula/client.rb +142 -0
data/lib/alula/errors.rb +169 -0
data/lib/alula/filter_builder.rb +271 -0
data/lib/alula/helpers/device_attribute_translations.rb +68 -0
data/lib/alula/list_object.rb +64 -0
data/lib/alula/meta.rb +16 -0
data/lib/alula/monkey_patches.rb +24 -0
data/lib/alula/oauth.rb +118 -0
data/lib/alula/pagination.rb +25 -0
data/lib/alula/procedures/dealer_device_stats_proc.rb +16 -0
data/lib/alula/procedures/dealer_restore_proc.rb +25 -0
data/lib/alula/procedures/dealer_suspend_proc.rb +25 -0
data/lib/alula/procedures/device_assign_proc.rb +23 -0
data/lib/alula/procedures/device_cellular_history_proc.rb +33 -0
data/lib/alula/procedures/device_rateplan_get_proc.rb +21 -0
data/lib/alula/procedures/device_register_proc.rb +31 -0
data/lib/alula/procedures/device_signal_add_proc.rb +42 -0
data/lib/alula/procedures/device_signal_delivered_proc.rb +31 -0
data/lib/alula/procedures/device_signal_update_proc.rb +32 -0
data/lib/alula/procedures/device_unassign_proc.rb +16 -0
data/lib/alula/procedures/device_unregister_proc.rb +21 -0
data/lib/alula/procedures/upload_touchpad_branding_proc.rb +24 -0
data/lib/alula/procedures/user_plansvideo_price_get.rb +21 -0
data/lib/alula/procedures/user_transfer_accept.rb +19 -0
data/lib/alula/procedures/user_transfer_authorize.rb +18 -0
data/lib/alula/procedures/user_transfer_cancel.rb +18 -0
data/lib/alula/procedures/user_transfer_deny.rb +19 -0
data/lib/alula/procedures/user_transfer_reject.rb +19 -0
data/lib/alula/procedures/user_transfer_request.rb +19 -0
data/lib/alula/query_interface.rb +142 -0
data/lib/alula/rate_limit.rb +11 -0
data/lib/alula/relationship_attributes.rb +107 -0
data/lib/alula/resource_attributes.rb +206 -0
data/lib/alula/resources/admin_user.rb +207 -0
data/lib/alula/resources/billing_program.rb +41 -0
data/lib/alula/resources/dealer.rb +218 -0
data/lib/alula/resources/dealer_account_transfer.rb +172 -0
data/lib/alula/resources/dealer_address.rb +89 -0
data/lib/alula/resources/dealer_branding.rb +226 -0
data/lib/alula/resources/dealer_program.rb +75 -0
data/lib/alula/resources/dealer_suspension_log.rb +49 -0
data/lib/alula/resources/device.rb +716 -0
data/lib/alula/resources/device_cellular_status.rb +134 -0
data/lib/alula/resources/device_charge.rb +70 -0
data/lib/alula/resources/device_event_log.rb +167 -0
data/lib/alula/resources/device_program.rb +54 -0
data/lib/alula/resources/event_trigger.rb +75 -0
data/lib/alula/resources/event_webhook.rb +47 -0
data/lib/alula/resources/feature_bysubject.rb +74 -0
data/lib/alula/resources/feature_plan.rb +57 -0
data/lib/alula/resources/feature_planvideo.rb +54 -0
data/lib/alula/resources/feature_price.rb +46 -0
data/lib/alula/resources/receiver_connection.rb +95 -0
data/lib/alula/resources/receiver_group.rb +74 -0
data/lib/alula/resources/revision.rb +91 -0
data/lib/alula/resources/self.rb +61 -0
data/lib/alula/resources/station.rb +130 -0
data/lib/alula/resources/token_exchange.rb +34 -0
data/lib/alula/resources/user.rb +229 -0
data/lib/alula/resources/user_address.rb +121 -0
data/lib/alula/resources/user_phone.rb +116 -0
data/lib/alula/resources/user_preferences.rb +57 -0
data/lib/alula/resources/user_pushtoken.rb +75 -0
data/lib/alula/resources/user_videoprofile.rb +38 -0
data/lib/alula/rest_resource.rb +17 -0
data/lib/alula/rpc_resource.rb +40 -0
data/lib/alula/rpc_response.rb +14 -0
data/lib/alula/singleton_rest_resource.rb +26 -0
data/lib/alula/util.rb +107 -0
data/lib/alula/version.rb +5 -0
data/lib/alula.rb +135 -0
data/lib/parser.rb +199 -0
metadata +282 -0

data/lib/alula/resources/device.rb ADDED Viewed

@@ -0,0 +1,716 @@
+module Alula
+  class Device < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+    include Alula::DeviceAttributeTranslations
+    resource_path 'devices'
+    type 'devices'
+    # Relationships
+    relationship :customer, type: 'users', cardinality: 'To-one'
+    # relationship :deactive_customer, type: 'user', cardinality: 'To-one'
+    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 :notifications, type: 'devices-notification', cardinality: 'To-many'
+    # relationship :users, type: 'devices-user', cardinality: 'To-many'
+    # relationship :features_supported, type: 'devices-features-supported', cardinality: 'To-one'
+    # relationship :features_disabled, type: 'devices-features-disabled', cardinality: 'To-one'
+    # Resource Fields
+    # Not all params are used at the moment. See Alula::ResourceAttributes for details
+    # on how params are parsed,
+    field :id,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :mac,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :sn,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :dealer_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :deactive_customer_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :customer_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :relay_group_enabled,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :interactive_enabled,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :remote_user_logging_feature_enabled,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :push_notification_enabled,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :user_sync_disabled,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :auto_cfg,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :connected_panel,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system]
+    field :program_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system]
+    field :version_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system]
+    field :meid,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system]
+    field :imei,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system]
+    field :iccid,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system]
+    field :mno,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system]
+    field :timezone,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :online_status,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system]
+    field :online_status_timestamp,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :registered_by,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :date_inserted,
+          type: :date,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :date_registered,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :date_activated,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :friendly_name,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :station_phone_number,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :caller_id_phone_number,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :station_account_number,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :station_aux_number,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :override_account_number,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :signal_suppress_open_close,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :signal_suppress_bypass,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :open_close_suppression,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :convert_sia_to_contact_id,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :downloader_phone_number,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :receiver_group_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :network_trouble_timeout,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :physical_address1,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_address2,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_street_number,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_street_name,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_street_direction,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_city,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_state,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_zip,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_site_number,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_suite,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_floor,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :physical_description,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician, :user]
+    field :two_way_voice_enabled,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :sia_two_way_voice_enabled,
+          type: :boolean,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system, :station, :dealer, :technician]
+    field :date_deactivated,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :moved_to,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :moved_by,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :moved_at,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :enforce_features,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system]
+    field :bvn,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [],
+          hex_convert_required: true
+    field :features_selected,
+          type: :object,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :any_trouble,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :ac_failure,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :low_battery,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :server_comm_fail,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :cs_comm_fail,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :onboard_ethernet_trouble,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :expansion_slot1_trouble,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :expansion_slot2_trouble,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :expansion_slot3_trouble,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :local_security_app_device_trouble,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :alarm_panel_cover_tamper,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :alarm_panel_wall_tamper,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :low_battery_zones,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :supervisory_zones,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :tamper_zones,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :alarm_zones,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :arming_protest,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :siren_trouble_condition,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :pin_pad_trouble,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :helipad_trouble,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :trouble_zones,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :receiver_jam,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :missing_battery,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :arming_protest_generic,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :keyfob_trouble,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :keypads_locked_out,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :keystroke_tamper,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :ce_arming_supervision_trouble_zones,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :master_code_out_of_sync,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :dealer_code_out_of_sync,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :panel_generic_trouble,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field 'features_selected.alarm_transmission'.to_sym,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field 'features_selected.alarm_notifications'.to_sym,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field 'features_selected.interactive_services'.to_sym,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field 'features_selected.home_automation'.to_sym,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field 'features_selected.two_way_voice'.to_sym,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field 'features_selected.vigilance'.to_sym,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field 'features_selected.alarm_verification'.to_sym,
+          type: :boolean,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+  end
+end