specs-sdk 1.3.0

data/lib/verizon/models/target_authentication_body.rb

@@ -0,0 +1,90 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # TargetAuthenticationBody Model.
+  class TargetAuthenticationBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Authentication grant type.
+    # @return [String]
+    attr_accessor :grant_type
+
+    # Refresh token.
+    # @return [String]
+    attr_accessor :refresh_token
+
+    # Authentication scopes.
+    # @return [String]
+    attr_accessor :scope
+
+    # Authentication headers.
+    # @return [TargetAuthenticationBodyHeaders]
+    attr_accessor :headers
+
+    # Host information.
+    # @return [TargetAuthenticationBodyHost]
+    attr_accessor :host
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['grant_type'] = 'grant_type'
+      @_hash['refresh_token'] = 'refresh_token'
+      @_hash['scope'] = 'scope'
+      @_hash['headers'] = 'headers'
+      @_hash['host'] = 'host'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        grant_type
+        refresh_token
+        scope
+        headers
+        host
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(grant_type = SKIP,
+                   refresh_token = SKIP,
+                   scope = SKIP,
+                   headers = SKIP,
+                   host = SKIP)
+      @grant_type = grant_type unless grant_type == SKIP
+      @refresh_token = refresh_token unless refresh_token == SKIP
+      @scope = scope unless scope == SKIP
+      @headers = headers unless headers == SKIP
+      @host = host unless host == 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.
+      grant_type = hash.key?('grant_type') ? hash['grant_type'] : SKIP
+      refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
+      scope = hash.key?('scope') ? hash['scope'] : SKIP
+      headers = TargetAuthenticationBodyHeaders.from_hash(hash['headers']) if hash['headers']
+      host = TargetAuthenticationBodyHost.from_hash(hash['host']) if hash['host']
+
+      # Create object from extracted values.
+      TargetAuthenticationBody.new(grant_type,
+                                   refresh_token,
+                                   scope,
+                                   headers,
+                                   host)
+    end
+  end
+end

data/lib/verizon/models/target_authentication_body_headers.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Authentication headers.
+  class TargetAuthenticationBodyHeaders < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Authorization header.
+    # @return [String]
+    attr_accessor :authorization
+
+    # Content-Type header.
+    # @return [String]
+    attr_accessor :content_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authorization'] = 'Authorization'
+      @_hash['content_type'] = 'Content-Type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        authorization
+        content_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(authorization = SKIP,
+                   content_type = SKIP)
+      @authorization = authorization unless authorization == SKIP
+      @content_type = content_type unless content_type == 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.
+      authorization = hash.key?('Authorization') ? hash['Authorization'] : SKIP
+      content_type = hash.key?('Content-Type') ? hash['Content-Type'] : SKIP
+
+      # Create object from extracted values.
+      TargetAuthenticationBodyHeaders.new(authorization,
+                                          content_type)
+    end
+  end
+end

data/lib/verizon/models/target_authentication_body_host.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Host information.
+  class TargetAuthenticationBodyHost < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :hostandpath
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['hostandpath'] = 'hostandpath'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        hostandpath
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(hostandpath = SKIP)
+      @hostandpath = hostandpath unless hostandpath == 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.
+      hostandpath = hash.key?('hostandpath') ? hash['hostandpath'] : SKIP
+
+      # Create object from extracted values.
+      TargetAuthenticationBodyHost.new(hostandpath)
+    end
+  end
+end

data/lib/verizon/models/thingspace_device.rb

@@ -0,0 +1,213 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Device that exist in Verizon Mobile Device Management (MDM).
+  class ThingspaceDevice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The billing account that the device is associated with.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The date that the device's current billing cycle ends.
+    # @return [String]
+    attr_accessor :billing_cycle_end_date
+
+    # The carrier information associated with the device.
+    # @return [Array[CarrierInformation]]
+    attr_accessor :carrier_informations
+
+    # True if the device is connected; false if it is not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :connected
+
+    # The date and time that the device was added to the system.
+    # @return [String]
+    attr_accessor :created_at
+
+    # The custom fields and values that have been set for the device.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # All identifiers for the device.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # Any extended attributes for the device, as Key and Value pairs. The pairs
+    # listed below are returned as part of the response for a single device, but
+    # are not included if the request was for information about multiple
+    # devices.
+    # @return [Array[CustomFields]]
+    attr_accessor :extended_attributes
+
+    # The device groups that the device belongs to.
+    # @return [Array[String]]
+    attr_accessor :group_names
+
+    # The IP address of the device.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # The user who last activated the device.
+    # @return [String]
+    attr_accessor :last_activation_by
+
+    # The date and time that the device was last activated.
+    # @return [String]
+    attr_accessor :last_activation_date
+
+    # The most recent connection date and time.
+    # @return [String]
+    attr_accessor :last_connection_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['billing_cycle_end_date'] = 'billingCycleEndDate'
+      @_hash['carrier_informations'] = 'carrierInformations'
+      @_hash['connected'] = 'connected'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['extended_attributes'] = 'extendedAttributes'
+      @_hash['group_names'] = 'groupNames'
+      @_hash['ip_address'] = 'ipAddress'
+      @_hash['last_activation_by'] = 'lastActivationBy'
+      @_hash['last_activation_date'] = 'lastActivationDate'
+      @_hash['last_connection_date'] = 'lastConnectionDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        billing_cycle_end_date
+        carrier_informations
+        connected
+        created_at
+        custom_fields
+        device_ids
+        extended_attributes
+        group_names
+        ip_address
+        last_activation_by
+        last_activation_date
+        last_connection_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   billing_cycle_end_date = SKIP,
+                   carrier_informations = SKIP,
+                   connected = SKIP,
+                   created_at = SKIP,
+                   custom_fields = SKIP,
+                   device_ids = SKIP,
+                   extended_attributes = SKIP,
+                   group_names = SKIP,
+                   ip_address = SKIP,
+                   last_activation_by = SKIP,
+                   last_activation_date = SKIP,
+                   last_connection_date = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @billing_cycle_end_date = billing_cycle_end_date unless billing_cycle_end_date == SKIP
+      @carrier_informations = carrier_informations unless carrier_informations == SKIP
+      @connected = connected unless connected == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @device_ids = device_ids unless device_ids == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == SKIP
+      @group_names = group_names unless group_names == SKIP
+      @ip_address = ip_address unless ip_address == SKIP
+      @last_activation_by = last_activation_by unless last_activation_by == SKIP
+      @last_activation_date = last_activation_date unless last_activation_date == SKIP
+      @last_connection_date = last_connection_date unless last_connection_date == 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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      billing_cycle_end_date =
+        hash.key?('billingCycleEndDate') ? hash['billingCycleEndDate'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      carrier_informations = nil
+      unless hash['carrierInformations'].nil?
+        carrier_informations = []
+        hash['carrierInformations'].each do |structure|
+          carrier_informations << (CarrierInformation.from_hash(structure) if structure)
+        end
+      end
+
+      carrier_informations = SKIP unless hash.key?('carrierInformations')
+      connected = hash.key?('connected') ? hash['connected'] : SKIP
+      created_at = hash.key?('createdAt') ? hash['createdAt'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      custom_fields = nil
+      unless hash['customFields'].nil?
+        custom_fields = []
+        hash['customFields'].each do |structure|
+          custom_fields << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      custom_fields = SKIP unless hash.key?('customFields')
+      # Parameter is an array, so we need to iterate through it
+      device_ids = nil
+      unless hash['deviceIds'].nil?
+        device_ids = []
+        hash['deviceIds'].each do |structure|
+          device_ids << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = SKIP unless hash.key?('deviceIds')
+      # Parameter is an array, so we need to iterate through it
+      extended_attributes = nil
+      unless hash['extendedAttributes'].nil?
+        extended_attributes = []
+        hash['extendedAttributes'].each do |structure|
+          extended_attributes << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extendedAttributes')
+      group_names = hash.key?('groupNames') ? hash['groupNames'] : SKIP
+      ip_address = hash.key?('ipAddress') ? hash['ipAddress'] : SKIP
+      last_activation_by =
+        hash.key?('lastActivationBy') ? hash['lastActivationBy'] : SKIP
+      last_activation_date =
+        hash.key?('lastActivationDate') ? hash['lastActivationDate'] : SKIP
+      last_connection_date =
+        hash.key?('lastConnectionDate') ? hash['lastConnectionDate'] : SKIP
+
+      # Create object from extracted values.
+      ThingspaceDevice.new(account_name,
+                           billing_cycle_end_date,
+                           carrier_informations,
+                           connected,
+                           created_at,
+                           custom_fields,
+                           device_ids,
+                           extended_attributes,
+                           group_names,
+                           ip_address,
+                           last_activation_by,
+                           last_activation_date,
+                           last_connection_date)
+    end
+  end
+end

data/lib/verizon/models/transaction_id.rb

@@ -0,0 +1,51 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The transaction ID of the request that you want to cancel, from the POST
+  # /devicelocations synchronus response.
+  class TransactionID < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :txid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['txid'] = 'txid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        txid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(txid = SKIP)
+      @txid = txid unless txid == 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.
+      txid = hash.key?('txid') ? hash['txid'] : SKIP
+
+      # Create object from extracted values.
+      TransactionID.new(txid)
+    end
+  end
+end

data/lib/verizon/models/trigger_attributes_options.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # TriggerAttributesOptions Model.
+  class TriggerAttributesOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If present, the NotificationGroupName will be listed here.
+    # @return [String]
+    attr_accessor :key
+
+    # DataPercentage50<br />True - Trigger on Data percentage is over 50%
+    # used<br />False - Do not trigger when over 50% used.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'key'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        key
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = SKIP,
+                   value = SKIP)
+      @key = key unless key == SKIP
+      @value = value unless value == 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.
+      key = hash.key?('key') ? hash['key'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      TriggerAttributesOptions.new(key,
+                                   value)
+    end
+  end
+end

data/lib/verizon/models/trigger_type1.rb

@@ -0,0 +1,94 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Trigger details.
+  class TriggerType1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Trigger name.
+    # @return [String]
+    attr_accessor :name
+
+    # This is the value to use in the request body to detect anomalous
+    # behaivior. The values in this table will only be relevant when this
+    # parameter is set to this value.
+    # @return [String]
+    attr_accessor :trigger_category
+
+    # Account name.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The details of the UsageAnomaly trigger.
+    # @return [AnomalyTriggerRequest]
+    attr_accessor :anomaly_trigger_request
+
+    # The notification details of the trigger.
+    # @return [Notification]
+    attr_accessor :notification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['trigger_category'] = 'triggerCategory'
+      @_hash['account_name'] = 'accountName'
+      @_hash['anomaly_trigger_request'] = 'anomalyTriggerRequest'
+      @_hash['notification'] = 'notification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        trigger_category
+        account_name
+        anomaly_trigger_request
+        notification
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP,
+                   trigger_category = SKIP,
+                   account_name = SKIP,
+                   anomaly_trigger_request = SKIP,
+                   notification = SKIP)
+      @name = name unless name == SKIP
+      @trigger_category = trigger_category unless trigger_category == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @anomaly_trigger_request = anomaly_trigger_request unless anomaly_trigger_request == SKIP
+      @notification = notification unless notification == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      trigger_category =
+        hash.key?('triggerCategory') ? hash['triggerCategory'] : SKIP
+      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']
+
+      # Create object from extracted values.
+      TriggerType1.new(name,
+                       trigger_category,
+                       account_name,
+                       anomaly_trigger_request,
+                       notification)
+    end
+  end
+end

data/lib/verizon/models/trigger_type2.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Trigger details.
+  class TriggerType2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The details of the UsageAnomaly trigger.
+    # @return [UsageAnomalyAttributes]
+    attr_accessor :anomalyattributes
+
+    # The notification details of the trigger.
+    # @return [Notification]
+    attr_accessor :notification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['anomalyattributes'] = 'anomalyattributes'
+      @_hash['notification'] = 'notification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        anomalyattributes
+        notification
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(anomalyattributes = SKIP,
+                   notification = SKIP)
+      @anomalyattributes = anomalyattributes unless anomalyattributes == SKIP
+      @notification = notification unless notification == 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.
+      anomalyattributes = UsageAnomalyAttributes.from_hash(hash['anomalyattributes']) if
+        hash['anomalyattributes']
+      notification = Notification.from_hash(hash['notification']) if hash['notification']
+
+      # Create object from extracted values.
+      TriggerType2.new(anomalyattributes,
+                       notification)
+    end
+  end
+end