sdksio-verizon-apis-sdk 1.4.0 → 1.5.0

data/lib/verizon/http/auth/{oauth_2.rb → thingspace_oauth.rb}

@@ -5,25 +5,25 @@
 
 module Verizon
   # Utility class for OAuth 2 authorization and token management.
-  class OAuth2 < CoreLibrary::HeaderAuth
+  class ThingspaceOauth < CoreLibrary::HeaderAuth
     include CoreLibrary
     # Display error message on occurrence of authentication failure.
     # @returns [String] The oAuth error message.
     def error_message
-      'ClientCredentialsAuth: OAuthToken is undefined or expired.'
+      'ThingspaceOauth: OAuthToken is undefined or expired.'
     end
 
     # Initialization constructor.
-    def initialize(client_credentials_auth_credentials, config)
+    def initialize(thingspace_oauth_credentials, config)
       auth_params = {}
-      @_oauth_client_id = client_credentials_auth_credentials.oauth_client_id unless
-        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.oauth_client_id.nil?
-      @_oauth_client_secret = client_credentials_auth_credentials.oauth_client_secret unless
-        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.oauth_client_secret.nil?
-      @_oauth_token = client_credentials_auth_credentials.oauth_token unless
-        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.oauth_token.nil?
-      @_oauth_scopes = client_credentials_auth_credentials.oauth_scopes unless
-        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.oauth_scopes.nil?
+      @_oauth_client_id = thingspace_oauth_credentials.oauth_client_id unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_client_id.nil?
+      @_oauth_client_secret = thingspace_oauth_credentials.oauth_client_secret unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_client_secret.nil?
+      @_oauth_token = thingspace_oauth_credentials.oauth_token unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_token.nil?
+      @_oauth_scopes = thingspace_oauth_credentials.oauth_scopes unless
+        thingspace_oauth_credentials.nil? || thingspace_oauth_credentials.oauth_scopes.nil?
       @_o_auth_api = OauthAuthorizationController.new(config)
       auth_params['Authorization'] = "Bearer #{@_oauth_token.access_token}" unless @_oauth_token.nil?
 
@@ -46,7 +46,7 @@ module Verizon
     # @param [Hash] additional_params Any additional form parameters.
     # @return [OAuthToken] The oAuth token instance.
     def fetch_token(additional_params: nil)
-      token = @_o_auth_api.request_token(
+      token = @_o_auth_api.request_token_thingspace_oauth(
         build_basic_auth_header,
         scope: !@_oauth_scopes.nil? ? Array(@_oauth_scopes).compact.join(' ') : @_oauth_scopes,
         _field_parameters: additional_params
@@ -65,8 +65,8 @@ module Verizon
     end
   end
 
-  # Data class for ClientCredentialsAuthCredentials.
-  class ClientCredentialsAuthCredentials
+  # Data class for ThingspaceOauthCredentials.
+  class ThingspaceOauthCredentials
     attr_reader :oauth_client_id, :oauth_client_secret, :oauth_token,
                 :oauth_scopes
 
@@ -88,11 +88,10 @@ module Verizon
       oauth_token ||= self.oauth_token
       oauth_scopes ||= self.oauth_scopes
 
-      ClientCredentialsAuthCredentials.new(
-        oauth_client_id: oauth_client_id,
-        oauth_client_secret: oauth_client_secret, oauth_token: oauth_token,
-        oauth_scopes: oauth_scopes
-      )
+      ThingspaceOauthCredentials.new(oauth_client_id: oauth_client_id,
+                                     oauth_client_secret: oauth_client_secret,
+                                     oauth_token: oauth_token,
+                                     oauth_scopes: oauth_scopes)
     end
   end
 end

data/lib/verizon/http/auth/vz_m2m_token.rb

@@ -0,0 +1,42 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Utility class for custom header authorization.
+  class VzM2mToken < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'VZM2MToken: vz_m2m_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(vz_m2m_token_credentials)
+      auth_params = {}
+      auth_params['VZ-M2M-Token'] = vz_m2m_token_credentials.vz_m2m_token unless
+        vz_m2m_token_credentials.nil? || vz_m2m_token_credentials.vz_m2m_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for VZM2MTokenCredentials.
+  # Data class for VZM2MTokenCredentials.
+  class VZM2MTokenCredentials
+    attr_reader :vz_m2m_token
+
+    def initialize(vz_m2m_token:)
+      raise ArgumentError, 'vz_m2m_token cannot be nil' if vz_m2m_token.nil?
+
+      @vz_m2m_token = vz_m2m_token
+    end
+
+    def clone_with(vz_m2m_token: nil)
+      vz_m2m_token ||= self.vz_m2m_token
+
+      VZM2MTokenCredentials.new(vz_m2m_token: vz_m2m_token)
+    end
+  end
+end

data/lib/verizon/models/account_group_share.rb

@@ -0,0 +1,55 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # AccountGroupShare Model.
+  class AccountGroupShare < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [AccountGroupShareIndividual]
+    attr_accessor :account_group_share_individual
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_group_share_individual'] = 'accountGroupShareIndividual'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_group_share_individual
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_group_share_individual = SKIP)
+      unless account_group_share_individual == SKIP
+        @account_group_share_individual =
+          account_group_share_individual
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      if hash['accountGroupShareIndividual']
+        account_group_share_individual = AccountGroupShareIndividual.from_hash(hash['accountGroupShareIndividual'])
+      end
+
+      # Create object from extracted values.
+      AccountGroupShare.new(account_group_share_individual)
+    end
+  end
+end

data/lib/verizon/models/account_group_share_individual.rb

@@ -0,0 +1,71 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # AccountGroupShareIndividual Model.
+  class AccountGroupShareIndividual < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [FilterCriteriaAccountGroupShare]
+    attr_accessor :filter_criteria
+
+    # TODO: Write general description for this method
+    # @return [ConditionAccountGroupShare]
+    attr_accessor :condition
+
+    # TODO: Write general description for this method
+    # @return [ActionAccountGroupShare]
+    attr_accessor :action
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['filter_criteria'] = 'filterCriteria'
+      @_hash['condition'] = 'condition'
+      @_hash['action'] = 'action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        filter_criteria
+        condition
+        action
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(filter_criteria = SKIP,
+                   condition = SKIP,
+                   action = SKIP)
+      @filter_criteria = filter_criteria unless filter_criteria == SKIP
+      @condition = condition unless condition == SKIP
+      @action = action unless action == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      filter_criteria = FilterCriteriaAccountGroupShare.from_hash(hash['filterCriteria']) if
+        hash['filterCriteria']
+      condition = ConditionAccountGroupShare.from_hash(hash['condition']) if hash['condition']
+      action = ActionAccountGroupShare.from_hash(hash['action']) if hash['action']
+
+      # Create object from extracted values.
+      AccountGroupShareIndividual.new(filter_criteria,
+                                      condition,
+                                      action)
+    end
+  end
+end

data/lib/verizon/models/action_account_group_share.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ActionAccountGroupShare Model.
+  class ActionAccountGroupShare < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ChangePlan]
+    attr_accessor :change_plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['change_plan'] = 'changePlan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        change_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(change_plan = SKIP)
+      @change_plan = change_plan unless change_plan == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      change_plan = ChangePlan.from_hash(hash['changePlan']) if hash['changePlan']
+
+      # Create object from extracted values.
+      ActionAccountGroupShare.new(change_plan)
+    end
+  end
+end

data/lib/verizon/models/aggregate_usage_item.rb

@@ -23,12 +23,18 @@ module Verizon
     # @return [Integer]
     attr_accessor :bytes_transferred
 
+    # The amount of data transferred by the device reporting usage, measured in
+    # Bytes.
+    # @return [Object]
+    attr_accessor :example
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
       @_hash['imei'] = 'imei'
       @_hash['number_of_sessions'] = 'numberOfSessions'
       @_hash['bytes_transferred'] = 'bytesTransferred'
+      @_hash['example'] = 'example'
       @_hash
     end
 
@@ -38,6 +44,7 @@ module Verizon
         imei
         number_of_sessions
         bytes_transferred
+        example
       ]
     end
 
@@ -48,10 +55,12 @@ module Verizon
 
     def initialize(imei = SKIP,
                    number_of_sessions = SKIP,
-                   bytes_transferred = SKIP)
+                   bytes_transferred = SKIP,
+                   example = SKIP)
       @imei = imei unless imei == SKIP
       @number_of_sessions = number_of_sessions unless number_of_sessions == SKIP
       @bytes_transferred = bytes_transferred unless bytes_transferred == SKIP
+      @example = example unless example == SKIP
     end
 
     # Creates an instance of the object from a hash.
@@ -64,11 +73,13 @@ module Verizon
         hash.key?('numberOfSessions') ? hash['numberOfSessions'] : SKIP
       bytes_transferred =
         hash.key?('bytesTransferred') ? hash['bytesTransferred'] : SKIP
+      example = hash.key?('example') ? hash['example'] : SKIP
 
       # Create object from extracted values.
       AggregateUsageItem.new(imei,
                              number_of_sessions,
-                             bytes_transferred)
+                             bytes_transferred,
+                             example)
     end
   end
 end

data/lib/verizon/models/change_plan.rb

@@ -0,0 +1,69 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ChangePlan Model.
+  class ChangePlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :trigger_date
+
+    # TODO: Write general description for this method
+    # @return [Array[SharePlan]]
+    attr_accessor :share_plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['trigger_date'] = 'triggerDate'
+      @_hash['share_plan'] = 'sharePlan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        trigger_date
+        share_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(trigger_date = SKIP,
+                   share_plan = SKIP)
+      @trigger_date = trigger_date unless trigger_date == SKIP
+      @share_plan = share_plan unless share_plan == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      trigger_date = hash.key?('triggerDate') ? hash['triggerDate'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      share_plan = nil
+      unless hash['sharePlan'].nil?
+        share_plan = []
+        hash['sharePlan'].each do |structure|
+          share_plan << (SharePlan.from_hash(structure) if structure)
+        end
+      end
+
+      share_plan = SKIP unless hash.key?('sharePlan')
+
+      # Create object from extracted values.
+      ChangePlan.new(trigger_date,
+                     share_plan)
+    end
+  end
+end

data/lib/verizon/models/condition_account_group_share.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ConditionAccountGroupShare Model.
+  class ConditionAccountGroupShare < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :action
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action'] = 'action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(action = SKIP)
+      @action = action unless action == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      action = hash.key?('action') ? hash['action'] : SKIP
+
+      # Create object from extracted values.
+      ConditionAccountGroupShare.new(action)
+    end
+  end
+end

data/lib/verizon/models/create_trigger_request_options.rb

@@ -28,7 +28,7 @@ module Verizon
     attr_accessor :anomaly_trigger_request
 
     # The notification details of the trigger.
-    # @return [Notification]
+    # @return [TriggerNotification]
     attr_accessor :notification
 
     # Indicates anomaly detection is active<br />True - Anomaly detection is
@@ -90,7 +90,7 @@ module Verizon
       account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
       anomaly_trigger_request = AnomalyTriggerRequest.from_hash(hash['anomalyTriggerRequest']) if
         hash['anomalyTriggerRequest']
-      notification = Notification.from_hash(hash['notification']) if hash['notification']
+      notification = TriggerNotification.from_hash(hash['notification']) if hash['notification']
       active = hash.key?('active') ? hash['active'] : SKIP
 
       # Create object from extracted values.

data/lib/verizon/models/create_trigger_v2_request.rb

@@ -0,0 +1,113 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Create Trigger Request
+  class CreateTriggerV2Request < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :trigger_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :ecpd_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :device_group_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :trigger_category
+
+    # TODO: Write general description for this method
+    # @return [PricePlanTrigger]
+    attr_accessor :price_plan_trigger
+
+    # TODO: Write general description for this method
+    # @return [Notification]
+    attr_accessor :notification
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :active
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['trigger_name'] = 'triggerName'
+      @_hash['ecpd_id'] = 'ecpdId'
+      @_hash['device_group_name'] = 'deviceGroupName'
+      @_hash['trigger_category'] = 'triggerCategory'
+      @_hash['price_plan_trigger'] = 'pricePlanTrigger'
+      @_hash['notification'] = 'notification'
+      @_hash['active'] = 'active'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        trigger_name
+        ecpd_id
+        device_group_name
+        trigger_category
+        price_plan_trigger
+        notification
+        active
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(trigger_name = SKIP,
+                   ecpd_id = SKIP,
+                   device_group_name = SKIP,
+                   trigger_category = SKIP,
+                   price_plan_trigger = SKIP,
+                   notification = SKIP,
+                   active = SKIP)
+      @trigger_name = trigger_name unless trigger_name == SKIP
+      @ecpd_id = ecpd_id unless ecpd_id == SKIP
+      @device_group_name = device_group_name unless device_group_name == SKIP
+      @trigger_category = trigger_category unless trigger_category == SKIP
+      @price_plan_trigger = price_plan_trigger unless price_plan_trigger == SKIP
+      @notification = notification unless notification == SKIP
+      @active = active unless active == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      trigger_name = hash.key?('triggerName') ? hash['triggerName'] : SKIP
+      ecpd_id = hash.key?('ecpdId') ? hash['ecpdId'] : SKIP
+      device_group_name =
+        hash.key?('deviceGroupName') ? hash['deviceGroupName'] : SKIP
+      trigger_category =
+        hash.key?('triggerCategory') ? hash['triggerCategory'] : SKIP
+      price_plan_trigger = PricePlanTrigger.from_hash(hash['pricePlanTrigger']) if
+        hash['pricePlanTrigger']
+      notification = Notification.from_hash(hash['notification']) if hash['notification']
+      active = hash.key?('active') ? hash['active'] : SKIP
+
+      # Create object from extracted values.
+      CreateTriggerV2Request.new(trigger_name,
+                                 ecpd_id,
+                                 device_group_name,
+                                 trigger_category,
+                                 price_plan_trigger,
+                                 notification,
+                                 active)
+    end
+  end
+end

data/lib/verizon/models/device_id_search.rb

@@ -40,7 +40,6 @@ module Verizon
     # An array for optional fields
     def self.optionals
       %w[
-        contains
         startswith
         endswith
       ]
@@ -51,11 +50,11 @@ module Verizon
       []
     end
 
-    def initialize(kind = nil,
-                   contains = SKIP,
+    def initialize(contains = nil,
+                   kind = nil,
                    startswith = SKIP,
                    endswith = SKIP)
-      @contains = contains unless contains == SKIP
+      @contains = contains
       @startswith = startswith unless startswith == SKIP
       @endswith = endswith unless endswith == SKIP
       @kind = kind
@@ -66,14 +65,14 @@ module Verizon
       return nil unless hash
 
       # Extract variables from the hash.
+      contains = hash.key?('contains') ? hash['contains'] : nil
       kind = hash.key?('kind') ? hash['kind'] : nil
-      contains = hash.key?('contains') ? hash['contains'] : SKIP
       startswith = hash.key?('startswith') ? hash['startswith'] : SKIP
       endswith = hash.key?('endswith') ? hash['endswith'] : SKIP
 
       # Create object from extracted values.
-      DeviceIdSearch.new(kind,
-                         contains,
+      DeviceIdSearch.new(contains,
+                         kind,
                          startswith,
                          endswith)
     end

data/lib/verizon/models/filter_criteria_account_group_share.rb

@@ -0,0 +1,51 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # FilterCriteriaAccountGroupShare Model.
+  class FilterCriteriaAccountGroupShare < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :rate_plan_group_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['rate_plan_group_id'] = 'ratePlanGroupId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        rate_plan_group_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(rate_plan_group_id = SKIP)
+      @rate_plan_group_id = rate_plan_group_id unless rate_plan_group_id == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      rate_plan_group_id =
+        hash.key?('ratePlanGroupId') ? hash['ratePlanGroupId'] : SKIP
+
+      # Create object from extracted values.
+      FilterCriteriaAccountGroupShare.new(rate_plan_group_id)
+    end
+  end
+end