alula-ruby 0.58.0 → 0.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 911939bc3e4bcf671c33629537486291a1b1788a352ba80b7dae91fcab553eec
-  data.tar.gz: 857657d8eaef5dd34c922e47bfeeb722d356d90b6177b290c0453615719f4b0b
+  metadata.gz: d1ede6cdbfb53c529ab1304e84f394710e6992929620377bf3195aed80a1bc56
+  data.tar.gz: 942d3e61791f29b62f3b6129dfcbc71ec62718204db7fd3ae2763660bbbdbd31
 SHA512:
-  metadata.gz: ac1d5c2a78d373c258d4cfae8428ce9717c099ff9ebef5e8553c4655b50b86de394c5e3bd5fc92eda605e58f3dade181e1faf1130f325f00b4ff568814b0ab8d
-  data.tar.gz: 8393d161bd94feb80e86ab313b1bd58bbb8b43f53cca057c0ea679ed137a33fe1dcc7cd3b1fe827fc41b5c5e75212aad95a42346b964561f8f61ae6386bf86bb
+  metadata.gz: 1d8bc08cee3bd717877b0816d4d21007ac34439ba6b64264f263bcc82889a95c0bdc7bc3e2cb334b530474d01337c4e58663311acf0a3d57d39a06a68e2a6f18
+  data.tar.gz: 62b5b93a4de3d71a4ab0f0df03798e0a0b526149f18bdf5822532bc593da6f1f5c9e6bff03e3c8908d5eeb01bfecdc5651ddd2cd943e064c24868e5cb7bf3eb0

data/VERSION.md

@@ -90,3 +90,6 @@
 | v0.56.0 | 2022-07-08  | Add save! that raises an exception |
 | v0.57.0 | 2022-07-19  | Add Alula Messenger to device object |
 | v0.58.0 | 2022-07-21  | Add clone method, that creates a copy of a resource |
+| v0.59.0 | 2022-08-10  | Add clone RPC method for Feature Plans |
+| v0.60.0 | 2022-08-16  | Add Device Credits resource |
+| v0.61.0 | 2022-08-19  | User hidden resource |

data/lib/alula/procedures/feature_plan_clone_proc.rb

@@ -0,0 +1,48 @@
+##
+# source_gp_id   string  The source feature id
+# new_gp_id  string  New feature id
+# name   string  New Feature Plan name
+# description  boolean   New Feature Plan description
+# 
+
+# Method: featurePlans.clone
+module Alula
+  class FeaturePlanCloneProc < Alula::RpcResource
+
+    class Response < Alula::RpcResponse
+      def initialize(response)
+        super(response)
+        #
+        # This RPC response gives a new FeaturePlan item
+        data = response.data['result'][0]
+        attributes = {
+          id: data['id'],
+          gp_id: data['gp_id'],
+          name: data['name'],
+          description: data['description'],
+        }
+        @data = Alula::FeaturePlan.new(data['id'], attributes)
+      end
+
+      def ok?
+        @result.is_a?(Array) || (@result['errors'].nil? && @result['error'].nil?)
+      end
+    end
+
+    def self.call(source_gp_id:, new_gp_id:, name:, description: "")
+      payload = {
+        sourceGpId: source_gp_id,
+        newGpId: new_gp_id,
+        name: name,
+        description: description
+      }
+
+      request( 
+        http_method: :post,
+        path: '/rpc/v1/features/clone',
+        payload: payload,
+        handler: Response
+      )
+    end
+  end
+end

data/lib/alula/resources/device_credit.rb

@@ -0,0 +1,70 @@
+module Alula
+  class DeviceCredit < Alula::RestResource
+    extend Alula::ResourceAttributes
+    extend Alula::ApiOperations::Request
+    extend Alula::ApiOperations::List
+    extend Alula::ApiOperations::Save
+
+    resource_path 'devices/credits'
+    type 'devices-credit'
+
+    # 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: true,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: []
+
+    field :device_id,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+
+    field :credit_type,
+          type: :string,
+          sortable: true,
+          filterable: true,
+          creatable_by: [:system],
+          patchable_by: []
+
+    field :initial_amount,
+          type: :number,
+          sortable: true,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: [:system]
+      
+    field :used_amount,
+          type: :number,
+          sortable: true,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: [:system]
+    
+    field :date_modified,
+          type: :date,
+          sortable: true,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    
+    field :date_created,
+          type: :date,
+          sortable: true,
+          filterable: false,
+          creatable_by: [],
+          patchable_by: []
+    
+    field :expiration_date,
+          type: :date,
+          sortable: true,
+          filterable: false,
+          creatable_by: [:system],
+          patchable_by: [:system]
+  end
+end

data/lib/alula/resources/user.rb

@@ -198,6 +198,17 @@ module Alula
           creatable_by: %i[system station dealer technician user],
           patchable_by: %i[system station dealer technician user sub_user]
 
+    field :hidden,
+          type: :string,
+          sortable: false,
+          filterable: true,
+          creatable_by: [],
+          patchable_by: %i[system]
+
+    def hidden?
+      hidden == '1'
+    end
+
     def user_role
       # pre-alula api users will be u_type 32, newer ones are 96. need to differentiate
       # between account users and account owners by checking if they own themselves

data/lib/alula/version.rb

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

data/lib/alula.rb

@@ -32,6 +32,7 @@ require_relative 'alula/helpers/device_attribute_translations'
 require_relative 'alula/resources/billing_program'
 require_relative 'alula/resources/device'
 require_relative 'alula/resources/device_charge'
+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'
@@ -43,7 +44,6 @@ require_relative 'alula/resources/event_trigger'
 require_relative 'alula/resources/event_webhook'
 require_relative 'alula/resources/self'
 require_relative 'alula/resources/user'
-require_relative 'alula/resources/admin_user'
 require_relative 'alula/resources/user_phone'
 require_relative 'alula/resources/user_address'
 require_relative 'alula/resources/user_pushtoken'
@@ -74,6 +74,7 @@ require_relative 'alula/procedures/device_unassign_proc'
 require_relative 'alula/procedures/device_signal_add_proc'
 require_relative 'alula/procedures/device_signal_update_proc'
 require_relative 'alula/procedures/device_signal_delivered_proc'
+require_relative 'alula/procedures/feature_plan_clone_proc'
 require_relative 'alula/procedures/dealer_device_stats_proc'
 require_relative 'alula/procedures/dealer_suspend_proc'
 require_relative 'alula/procedures/dealer_restore_proc'
@@ -98,6 +99,7 @@ module Alula
     Alula::BillingProgram,
     Alula::Device,
     Alula::DeviceCharge,
+    Alula::DeviceCredit,
     Alula::DeviceEventLog,
     Alula::DeviceProgram,
     Alula::DealerAddress,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alula-ruby
 version: !ruby/object:Gem::Version
-  version: 0.58.0
+  version: 0.61.0
 platform: ruby
 authors:
 - Titus Johnson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -222,6 +222,7 @@ files:
 - lib/alula/procedures/device_signal_update_proc.rb
 - lib/alula/procedures/device_unassign_proc.rb
 - lib/alula/procedures/device_unregister_proc.rb
+- lib/alula/procedures/feature_plan_clone_proc.rb
 - lib/alula/procedures/upload_touchpad_branding_proc.rb
 - lib/alula/procedures/user_plansvideo_price_get.rb
 - lib/alula/procedures/user_transfer_accept.rb
@@ -234,7 +235,6 @@ files:
 - lib/alula/rate_limit.rb
 - lib/alula/relationship_attributes.rb
 - lib/alula/resource_attributes.rb
-- lib/alula/resources/admin_user.rb
 - lib/alula/resources/billing_program.rb
 - lib/alula/resources/dealer.rb
 - lib/alula/resources/dealer_account_transfer.rb
@@ -245,6 +245,7 @@ files:
 - lib/alula/resources/device.rb
 - lib/alula/resources/device_cellular_status.rb
 - lib/alula/resources/device_charge.rb
+- lib/alula/resources/device_credit.rb
 - lib/alula/resources/device_event_log.rb
 - lib/alula/resources/device_program.rb
 - lib/alula/resources/event_trigger.rb

data/lib/alula/resources/admin_user.rb

@@ -1,207 +0,0 @@
-module Alula
-  class AdminUser < Alula::User
-    extend Alula::ResourceAttributes
-    extend Alula::RelationshipAttributes
-    extend Alula::ApiOperations::Request
-    extend Alula::ApiOperations::List
-    extend Alula::ApiOperations::Save
-
-    resource_path 'admins/users'
-    type 'admins-users'
-
-    relationship :devices, type: 'devices', cardinality: 'To-many'
-    relationship :dealer, type: 'dealers', cardinality: 'To-one'
-    relationship :phone, type: 'users-phones', cardinality: 'To-one'
-    relationship :address, type: 'users-addresses', cardinality: 'To-one'
-    relationship :pushtokens, type: 'users-pushtokens', cardinality: 'To-many'
-    relationship :preferences, type: 'users-preferences', cardinality: 'To-one'
-    relationship :videoprofiles, type: 'users-videoprofiles', cardinality: 'To-many'
-
-    # 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 :username,
-          type: :string,
-          sortable: true,
-          filterable: true,
-          creatable_by: [:system, :station, :dealer, :technician, :user],
-          patchable_by: [:system, :station, :dealer, :technician, :user, :sub_user]
-
-    field :password,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [:system, :station, :dealer, :technician, :user],
-          patchable_by: []
-
-    field :u_type,
-          type: :string,
-          sortable: false,
-          filterable: true,
-          creatable_by: [:system, :station, :dealer, :technician, :user],
-          patchable_by: []
-
-    field :user_type,
-          type: :string,
-          sortable: false,
-          filterable: true,
-          creatable_by: [:system, :station, :dealer, :technician, :user],
-          patchable_by: [],
-          symbolize: true
-
-    field :u_level,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [],
-          patchable_by: []
-
-    field :parent_id,
-          type: :string,
-          sortable: false,
-          filterable: true,
-          creatable_by: [:system, :station, :dealer, :technician, :user],
-          patchable_by: []
-
-    field :dealer_id,
-          type: :string,
-          sortable: false,
-          filterable: true,
-          creatable_by: [:system, :station, :dealer, :technician, :user],
-          patchable_by: []
-
-    field :station_id,
-          type: :string,
-          sortable: false,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
-
-    field :last_login,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [],
-          patchable_by: []
-
-    field :date_entered,
-          type: :date,
-          sortable: true,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
-
-    field :date_modified,
-          type: :date,
-          sortable: true,
-          filterable: true,
-          creatable_by: [],
-          patchable_by: []
-
-    field :entered_by,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [],
-          patchable_by: []
-
-    field :modified_by,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [],
-          patchable_by: []
-
-    field :pwch,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [],
-          patchable_by: []
-
-    field :features_selected,
-          type: :object,
-          sortable: false,
-          filterable: false,
-          creatable_by: [:system, :station, :dealer, :technician],
-          patchable_by: [:system, :station, :dealer, :technician]
-
-    field :eula,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [],
-          patchable_by: [:system, :station, :dealer, :technician, :user, :sub_user]
-
-    field :def_mod,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [],
-          patchable_by: []
-
-    field :rg_activated,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [],
-          patchable_by: []
-
-    field :company_name,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [],
-          patchable_by: []
-
-    field :name_first,
-          type: :string,
-          sortable: true,
-          filterable: true,
-          creatable_by: [:system, :station, :dealer, :technician, :user],
-          patchable_by: [:system, :station, :dealer, :technician, :user, :sub_user]
-
-    field :name_last,
-          type: :string,
-          sortable: true,
-          filterable: true,
-          creatable_by: [:system, :station, :dealer, :technician, :user],
-          patchable_by: [:system, :station, :dealer, :technician, :user, :sub_user]
-
-    field :email,
-          type: :string,
-          sortable: true,
-          filterable: true,
-          creatable_by: [:system, :station, :dealer, :technician, :user],
-          patchable_by: [:system, :station, :dealer, :technician, :user, :sub_user]
-
-    field :time_offset,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [],
-          patchable_by: []
-
-    field :timezone,
-          type: :string,
-          sortable: false,
-          filterable: false,
-          creatable_by: [:system, :station, :dealer, :technician, :user],
-          patchable_by: [:system, :station, :dealer, :technician, :user, :sub_user]
-
-    field :hidden,
-          type: :boolean,
-          sortable: true,
-          filterable: true,
-          creatable_by: [:system],
-          patchable_by: [:system]
-
-  end
-end