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_cellular_status.rb ADDED Viewed

@@ -0,0 +1,134 @@
+module Alula
+  class DeviceCellularStatus < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    resource_path 'devices/cellular/status'
+    type 'devices-cellular-status'
+    # Relationships
+    # None
+    # Resource Fields
+    field :id,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :meid,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :imei,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :esn,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :mdn,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :iccid,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :imsi,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :account_name,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :carrier_name,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :device_group,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :rate_plan,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :state,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :ip_address,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :created_at,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :updated_at,
+          type: :date,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :connected,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :signal_strength,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+  end
+end

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

@@ -0,0 +1,70 @@
+module Alula
+  class DeviceCharge < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+    resource_path 'devices/charges'
+    type 'devices-charge'
+    # 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 :device_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+    field :name,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+    field :description,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: []
+    field :price,
+          type: :string,
+          sortable: true,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: [:system]
+    field :date_modified,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :date_created,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+    field :date_charged,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+  end
+end

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

@@ -0,0 +1,167 @@
+module Alula
+  class DeviceEventLog < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    resource_path 'devices/eventlog'
+    type 'devices-eventlog'
+    # Relationships
+    relationship :device, type: 'devices', cardinality: 'To-one'
+    relationship :customer, type: 'users', cardinality: 'To-one'
+    relationship :dealer, type: 'dealers', 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 :device_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :dealer_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 :group_id,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :date_entered,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :relay,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :action,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :npv,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :relay_status,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :signal_account_number,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :signal_event_qualifier,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :signal_event_code,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :signal_event_description,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :signal_partition,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :signal_user_zone,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :signal_user_zone_type,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :signal_user_zone_alias,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    field :signal_protocol,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    def relay_status_name
+      relay_status_names = {
+        0 => 'eventLog.relayStatus.notRelayed',
+        1 => 'eventLog.relayStatus.attemptingToRelay',
+        2 => 'eventLog.relayStatus.suppressed',
+        3 => 'eventLog.relayStatus.timedOutCannotRelay',
+        4 => 'eventLog.relayStatus.noReceiversConfigured',
+        8 => 'eventLog.relayStatus.noStartTone',
+        9 => 'eventLog.relayStatus.negativeAcknowledgement',
+        10 => 'eventLog.relayStatus.relayCompleted'
+      }
+      relay_status_names[relay_status]
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module Alula
+  class DeviceProgram < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::RelationshipAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+    resource_path 'devices/programs'
+    type 'devices-program'
+    # Relationships
+    relationship :device, type: 'devices', cardinality: 'To-one'
+    relationship :dealer_billing_program, type: 'dealers-programs', 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 :device_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+    field :dealer_program_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+    field :date_modified,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :date_created,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+  end
+end

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

@@ -0,0 +1,75 @@
+module Alula
+  class EventTrigger < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+    # You should update this to be a slash-separated, literal path to the resource
+    # without the prefix /api/v1 or the suffix of an ID
+    resource_path 'events/triggers'
+    # Relationships
+    # None
+    # 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: [:all],
+          patchable_by: [:all]
+    field :user_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+    field :reference,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [:all],
+          patchable_by: [:all]
+    field :event,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:all],
+          patchable_by: []
+    field :conditions,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:all],
+          patchable_by: [:all]
+    field :action,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:all],
+          patchable_by: [:all]
+    field :ttl,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:all],
+          patchable_by: [:all]
+    field :expires,
+          type: :string,
+          sortable: true,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+  end
+end

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

@@ -0,0 +1,47 @@
+module Alula
+  class EventWebhook < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+    # You should update this to be a slash-separated, literal path to the resource
+    # without the prefix /api/v1 or the suffix of an ID
+    resource_path 'events/webhooks'
+    # Relationships
+    # None
+    # 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: [:system, :dealer],
+          patchable_by: [:system, :dealer]
+    field :reference,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [:system, :dealer],
+          patchable_by: [:system, :dealer]
+    field :url,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:system, :dealer],
+          patchable_by: [:system, :dealer]
+    field :secret,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:system, :dealer],
+          patchable_by: [:system, :dealer]
+  end
+end

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

@@ -0,0 +1,74 @@
+module Alula
+  class FeatureBySubject < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+    resource_path 'features/bysubject'
+    type 'feature-bysubject'
+    field :id,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: []
+    field :gp_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+    field :subject_id,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+    field :subject_type,
+          type: :string,
+          sortable: true,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: []
+    field :date_start,
+          type: :date,
+          sortable: true,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: [:system]
+    field :date_end,
+          type: :date,
+          sortable: true,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: [:system]
+    field :date_assigned,
+          type: :date,
+          sortable: true,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: []
+    field :assigned_by,
+          type: :string,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: []
+    field :assignment_type,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+  end
+end

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

@@ -0,0 +1,57 @@
+module Alula
+  class FeaturePlan < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+    extend Alula::ApiOperations::Delete
+    resource_path 'features/plans'
+    type 'feature-plan'
+    # 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: [:system],
+          patchable_by: []
+    field :gp_id,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+    field :name,
+          type: :string,
+          sortable: true,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: [:system]
+    field :description,
+          type: :object,
+          sortable: false,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: [:system]
+    field :date_created,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+    field :date_modified,
+          type: :date,
+          sortable: true,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: [:system]
+  end
+end