sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/device_aggregate_usage_list_request.rb

@@ -0,0 +1,117 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to list device aggregate usage.
+  class DeviceAggregateUsageListRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The beginning of the reporting period. The startTime cannot be more than 6
+    # months before the current date.
+    # @return [String]
+    attr_accessor :start_time
+
+    # The end of the reporting period. The endTime date must be within on month
+    # of the startTime date.
+    # @return [String]
+    attr_accessor :end_time
+
+    # One or more devices for which you want aggregate data, specified by device
+    # ID.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of a device group, if you want to only include devices in that
+    # group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The name of a device group, if you want to only include devices in that
+    # group.
+    # @return [Array[Label]]
+    attr_accessor :label
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_time'] = 'startTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['account_name'] = 'accountName'
+      @_hash['group_name'] = 'groupName'
+      @_hash['label'] = 'label'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+        account_name
+        group_name
+        label
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_time = nil, end_time = nil, device_ids = SKIP,
+                   account_name = SKIP, group_name = SKIP, label = SKIP)
+      @start_time = start_time
+      @end_time = end_time
+      @device_ids = device_ids unless device_ids == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @label = label unless label == 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.
+      start_time = hash.key?('startTime') ? hash['startTime'] : nil
+      end_time = hash.key?('endTime') ? hash['endTime'] : nil
+      # 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')
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      label = nil
+      unless hash['label'].nil?
+        label = []
+        hash['label'].each do |structure|
+          label << (Label.from_hash(structure) if structure)
+        end
+      end
+
+      label = SKIP unless hash.key?('label')
+
+      # Create object from extracted values.
+      DeviceAggregateUsageListRequest.new(start_time,
+                                          end_time,
+                                          device_ids,
+                                          account_name,
+                                          group_name,
+                                          label)
+    end
+  end
+end

data/lib/verizon/models/device_connection_list_request.rb

@@ -0,0 +1,65 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to list of network connection events for a device during a specified
+  # time period.
+  class DeviceConnectionListRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An identifier for a single device.
+    # @return [DeviceId]
+    attr_accessor :device_id
+
+    # The earliest date and time for which you want connection events.
+    # @return [String]
+    attr_accessor :earliest
+
+    # The last date and time for which you want connection events.
+    # @return [String]
+    attr_accessor :latest
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['earliest'] = 'earliest'
+      @_hash['latest'] = 'latest'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil, earliest = nil, latest = nil)
+      @device_id = device_id
+      @earliest = earliest
+      @latest = latest
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      device_id = DeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      earliest = hash.key?('earliest') ? hash['earliest'] : nil
+      latest = hash.key?('latest') ? hash['latest'] : nil
+
+      # Create object from extracted values.
+      DeviceConnectionListRequest.new(device_id,
+                                      earliest,
+                                      latest)
+    end
+  end
+end

data/lib/verizon/models/device_cost_center_request.rb

@@ -0,0 +1,149 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to retrieve cost center value of a device.
+  class DeviceCostCenterRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The new cost center code. Valid values are any string of up to 36
+    # alphanumeric characters, space, dash, exclamation point, and pound sign.
+    # @return [String]
+    attr_accessor :cost_center
+
+    # Custom field names and values, if you want to only include devices that
+    # have matching values.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # A list of the devices that you want to change, specified by device
+    # identifier. Do not include accountName, groupName, customFields, or
+    # servicePlan if you use this parameter.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # The name of a device group, if you want to only include devices in that
+    # group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The customer name and the address of the device's primary place of use.
+    # These values are applied to all devices in the request.The Primary Place
+    # of Use location may affect taxation or have other legal implications. You
+    # may want to speak with legal and/or financial advisers before entering
+    # values for these fields.
+    # @return [Object]
+    attr_accessor :primary_place_of_use
+
+    # Set to true to remove the cost center code value. This flag takes
+    # precedence over a new costCenter value. If this flag is true and
+    # costCenter has a value, the cost center code is removed. Do not include
+    # this parameter, or set it to false to change the costCenter value.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :remove_cost_center
+
+    # The name of a service plan, if you want to only include devices that have
+    # that service plan.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['cost_center'] = 'costCenter'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['devices'] = 'devices'
+      @_hash['group_name'] = 'groupName'
+      @_hash['primary_place_of_use'] = 'primaryPlaceOfUse'
+      @_hash['remove_cost_center'] = 'removeCostCenter'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        cost_center
+        custom_fields
+        devices
+        group_name
+        primary_place_of_use
+        remove_cost_center
+        service_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, cost_center = SKIP,
+                   custom_fields = SKIP, devices = SKIP, group_name = SKIP,
+                   primary_place_of_use = SKIP, remove_cost_center = SKIP,
+                   service_plan = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @cost_center = cost_center unless cost_center == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @devices = devices unless devices == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @primary_place_of_use = primary_place_of_use unless primary_place_of_use == SKIP
+      @remove_cost_center = remove_cost_center unless remove_cost_center == SKIP
+      @service_plan = service_plan unless service_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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      cost_center = hash.key?('costCenter') ? hash['costCenter'] : 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
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (AccountDeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = SKIP unless hash.key?('devices')
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      primary_place_of_use =
+        hash.key?('primaryPlaceOfUse') ? hash['primaryPlaceOfUse'] : SKIP
+      remove_cost_center =
+        hash.key?('removeCostCenter') ? hash['removeCostCenter'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+
+      # Create object from extracted values.
+      DeviceCostCenterRequest.new(account_name,
+                                  cost_center,
+                                  custom_fields,
+                                  devices,
+                                  group_name,
+                                  primary_place_of_use,
+                                  remove_cost_center,
+                                  service_plan)
+    end
+  end
+end

data/lib/verizon/models/device_diagnostics_callback.rb

@@ -0,0 +1,92 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # Callback information of an existing diagnostics subscription.
+  class DeviceDiagnosticsCallback < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the billing account for which callback messages will be sent.
+    # Format: "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of the callback service, which identifies the type and format of
+    # messages that will be sent to the registered URL.
+    # @return [String]
+    attr_accessor :service_name
+
+    # The URL for your web server.
+    # @return [String]
+    attr_accessor :endpoint
+
+    # The date and time of when this request was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # Your HTTP headers.
+    # @return [Object]
+    attr_accessor :http_headers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['service_name'] = 'serviceName'
+      @_hash['endpoint'] = 'endpoint'
+      @_hash['created_on'] = 'createdOn'
+      @_hash['http_headers'] = 'httpHeaders'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        http_headers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil, service_name = nil, endpoint = nil,
+                   created_on = nil, http_headers = SKIP)
+      @account_name = account_name
+      @service_name = service_name
+      @endpoint = endpoint
+      @created_on = created_on
+      @http_headers = http_headers unless http_headers == 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'] : nil
+      service_name = hash.key?('serviceName') ? hash['serviceName'] : nil
+      endpoint = hash.key?('endpoint') ? hash['endpoint'] : nil
+      created_on = if hash.key?('createdOn')
+                     (DateTimeHelper.from_rfc3339(hash['createdOn']) if hash['createdOn'])
+                   end
+      http_headers = hash.key?('httpHeaders') ? hash['httpHeaders'] : SKIP
+
+      # Create object from extracted values.
+      DeviceDiagnosticsCallback.new(account_name,
+                                    service_name,
+                                    endpoint,
+                                    created_on,
+                                    http_headers)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+  end
+end

data/lib/verizon/models/device_extended_diagnostics_request.rb

@@ -0,0 +1,67 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request for obtaining device extended diagnostics.
+  class DeviceExtendedDiagnosticsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Verizon billing account that the device belongs to. An account name is
+    # usually numeric, and must include any leading zeros.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The device for which you want diagnostic information, specified by the
+    # device's MDN.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_list
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil, device_list = nil)
+      @account_name = account_name
+      @device_list = device_list
+    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'] : nil
+      # Parameter is an array, so we need to iterate through it
+      device_list = nil
+      unless hash['deviceList'].nil?
+        device_list = []
+        hash['deviceList'].each do |structure|
+          device_list << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      DeviceExtendedDiagnosticsRequest.new(account_name,
+                                           device_list)
+    end
+  end
+end

data/lib/verizon/models/device_extended_diagnostics_result.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Result for a request to obtain device extended diagnostics.
+  class DeviceExtendedDiagnosticsResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The response includes various types of information about the device,
+    # grouped into categories. Each category object contains the category name
+    # and a list of Extended Attribute objects as key-value pairs.
+    # @return [Array[DiagnosticsCategory]]
+    attr_accessor :categories
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['categories'] = 'categories'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        categories
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(categories = SKIP)
+      @categories = categories unless categories == 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.
+      # Parameter is an array, so we need to iterate through it
+      categories = nil
+      unless hash['categories'].nil?
+        categories = []
+        hash['categories'].each do |structure|
+          categories << (DiagnosticsCategory.from_hash(structure) if structure)
+        end
+      end
+
+      categories = SKIP unless hash.key?('categories')
+
+      # Create object from extracted values.
+      DeviceExtendedDiagnosticsResult.new(categories)
+    end
+  end
+end

data/lib/verizon/models/device_filter.rb

@@ -0,0 +1,89 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Specify the kind of the device identifier, the type of match, and the string
+  # that you want to match.
+  class DeviceFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The the billing account that the devices belong to.
+    # @return [String]
+    attr_accessor :account
+
+    # Only include devices that are in this device group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # Only include devices that have this service plan.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # Custom field names and values, if you want to only include devices that
+    # have matching values.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'account'
+      @_hash['group_name'] = 'groupName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+        group_name
+        service_plan
+        custom_fields
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account = SKIP, group_name = SKIP, service_plan = SKIP,
+                   custom_fields = SKIP)
+      @account = account unless account == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @custom_fields = custom_fields unless custom_fields == 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 = hash.key?('account') ? hash['account'] : SKIP
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : 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')
+
+      # Create object from extracted values.
+      DeviceFilter.new(account,
+                       group_name,
+                       service_plan,
+                       custom_fields)
+    end
+  end
+end