sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/account_device_list_request.rb

@@ -0,0 +1,157 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request for listing account devices.
+  class AccountDeviceListRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The billing account for which a list of devices is returned. If you don't
+    # specify an accountName, the list includes all devices to which you have
+    # access.
+    # @return [String]
+    attr_accessor :account_name
+
+    # An identifier for a single device.
+    # @return [DeviceId]
+    attr_accessor :device_id
+
+    # Filter for a list of devices.
+    # @return [AccountDeviceListFilter]
+    attr_accessor :filter
+
+    # The name of a device state, to only include devices in that state.
+    # @return [String]
+    attr_accessor :current_state
+
+    # Custom field names and values, if you want to only include devices that
+    # have matching values.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # Only include devices that were added after this date and time.
+    # @return [String]
+    attr_accessor :earliest
+
+    # Only include devices that are in this device group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # Only include devices that were added before this date and time.
+    # @return [String]
+    attr_accessor :latest
+
+    # Only include devices that have this service plan.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # Only include devices that have this service plan.
+    # @return [Integer]
+    attr_accessor :max_number_of_devices
+
+    # Only include devices that have this service plan.
+    # @return [Integer]
+    attr_accessor :largest_device_id_seen
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['device_id'] = 'deviceId'
+      @_hash['filter'] = 'filter'
+      @_hash['current_state'] = 'currentState'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['earliest'] = 'earliest'
+      @_hash['group_name'] = 'groupName'
+      @_hash['latest'] = 'latest'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['max_number_of_devices'] = 'maxNumberOfDevices'
+      @_hash['largest_device_id_seen'] = 'largestDeviceIdSeen'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        device_id
+        filter
+        current_state
+        custom_fields
+        earliest
+        group_name
+        latest
+        service_plan
+        max_number_of_devices
+        largest_device_id_seen
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, device_id = SKIP, filter = SKIP,
+                   current_state = SKIP, custom_fields = SKIP, earliest = SKIP,
+                   group_name = SKIP, latest = SKIP, service_plan = SKIP,
+                   max_number_of_devices = SKIP, largest_device_id_seen = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @device_id = device_id unless device_id == SKIP
+      @filter = filter unless filter == SKIP
+      @current_state = current_state unless current_state == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @earliest = earliest unless earliest == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @latest = latest unless latest == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @max_number_of_devices = max_number_of_devices unless max_number_of_devices == SKIP
+      @largest_device_id_seen = largest_device_id_seen unless largest_device_id_seen == 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
+      device_id = DeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      filter = AccountDeviceListFilter.from_hash(hash['filter']) if hash['filter']
+      current_state = hash.key?('currentState') ? hash['currentState'] : 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')
+      earliest = hash.key?('earliest') ? hash['earliest'] : SKIP
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      latest = hash.key?('latest') ? hash['latest'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+      max_number_of_devices =
+        hash.key?('maxNumberOfDevices') ? hash['maxNumberOfDevices'] : SKIP
+      largest_device_id_seen =
+        hash.key?('largestDeviceIdSeen') ? hash['largestDeviceIdSeen'] : SKIP
+
+      # Create object from extracted values.
+      AccountDeviceListRequest.new(account_name,
+                                   device_id,
+                                   filter,
+                                   current_state,
+                                   custom_fields,
+                                   earliest,
+                                   group_name,
+                                   latest,
+                                   service_plan,
+                                   max_number_of_devices,
+                                   largest_device_id_seen)
+    end
+  end
+end

data/lib/verizon/models/account_device_list_result.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response for a request to list down account devices.
+  class AccountDeviceListResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Up to 10,000 devices that you want to move to a different account,
+    # specified by device identifier.
+    # @return [Array[ThingspaceDevice]]
+    attr_accessor :devices
+
+    # False for a status 200 response.True for a status 202 response, indicating
+    # that there is more data to be retrieved.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['devices'] = 'devices'
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        devices
+        has_more_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(devices = SKIP, has_more_data = SKIP)
+      @devices = devices unless devices == SKIP
+      @has_more_data = has_more_data unless has_more_data == 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
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (ThingspaceDevice.from_hash(structure) if structure)
+        end
+      end
+
+      devices = SKIP unless hash.key?('devices')
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+
+      # Create object from extracted values.
+      AccountDeviceListResult.new(devices,
+                                  has_more_data)
+    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,69 @@
+# 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/account_identifier.rb

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

data/lib/verizon/models/account_labels.rb

@@ -0,0 +1,76 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Maximum of 2,000 objects are allowed in the array.
+  class AccountLabels < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[DeviceList]]
+    attr_accessor :devices
+
+    # TODO: Write general description for this method
+    # @return [Array[DeviceLabels]]
+    attr_accessor :label
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['devices'] = 'devices'
+      @_hash['label'] = 'label'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        label
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(devices = nil, label = SKIP)
+      @devices = devices
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      devices = nil
+      unless hash['devices'].nil?
+        devices = []
+        hash['devices'].each do |structure|
+          devices << (DeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = nil unless hash.key?('devices')
+      # Parameter is an array, so we need to iterate through it
+      label = nil
+      unless hash['label'].nil?
+        label = []
+        hash['label'].each do |structure|
+          label << (DeviceLabels.from_hash(structure) if structure)
+        end
+      end
+
+      label = SKIP unless hash.key?('label')
+
+      # Create object from extracted values.
+      AccountLabels.new(devices,
+                        label)
+    end
+  end
+end

data/lib/verizon/models/account_lead.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A successful response returns an array of lead objects.
+  class AccountLead < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The customer address for the line's primary place of use, for line usage
+    # taxation.
+    # @return [Address]
+    attr_accessor :address
+
+    # Unique number for each lead. Use this value in the leadId parameter when
+    # activating devices to credit the activations to the lead.
+    # @return [String]
+    attr_accessor :lead_id
+
+    # The current state of the lead, such as “Qualified” or “Closed.”
+    # @return [String]
+    attr_accessor :lead_state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'address'
+      @_hash['lead_id'] = 'leadId'
+      @_hash['lead_state'] = 'leadState'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address
+        lead_id
+        lead_state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address = SKIP, lead_id = SKIP, lead_state = SKIP)
+      @address = address unless address == SKIP
+      @lead_id = lead_id unless lead_id == SKIP
+      @lead_state = lead_state unless lead_state == 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.
+      address = Address.from_hash(hash['address']) if hash['address']
+      lead_id = hash.key?('leadId') ? hash['leadId'] : SKIP
+      lead_state = hash.key?('leadState') ? hash['leadState'] : SKIP
+
+      # Create object from extracted values.
+      AccountLead.new(address,
+                      lead_id,
+                      lead_state)
+    end
+  end
+end

data/lib/verizon/models/account_leads_result.rb

@@ -0,0 +1,68 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Returns information for all leads associated with an account.
+  class AccountLeadsResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # False if no more leads.True if there is more data to be retrieved.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # The leads associated with an account.
+    # @return [Array[AccountLead]]
+    attr_accessor :leads
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['leads'] = 'leads'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        has_more_data
+        leads
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(has_more_data = SKIP, leads = SKIP)
+      @has_more_data = has_more_data unless has_more_data == SKIP
+      @leads = leads unless leads == 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.
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      leads = nil
+      unless hash['leads'].nil?
+        leads = []
+        hash['leads'].each do |structure|
+          leads << (AccountLead.from_hash(structure) if structure)
+        end
+      end
+
+      leads = SKIP unless hash.key?('leads')
+
+      # Create object from extracted values.
+      AccountLeadsResult.new(has_more_data,
+                             leads)
+    end
+  end
+end

data/lib/verizon/models/account_license_device_list_item.rb

@@ -0,0 +1,69 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # The list of devices that have licenses assigned, including the date and time
+  # of when each license was assigned.
+  class AccountLicenseDeviceListItem < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :device_id
+
+    # Timestamp of when a license was assigned to the device.
+    # @return [DateTime]
+    attr_accessor :assignment_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['assignment_time'] = 'assignmentTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_id
+        assignment_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = SKIP, assignment_time = SKIP)
+      @device_id = device_id unless device_id == SKIP
+      @assignment_time = assignment_time unless assignment_time == 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.
+      device_id = hash.key?('deviceId') ? hash['deviceId'] : SKIP
+      assignment_time = if hash.key?('assignmentTime')
+                          (DateTimeHelper.from_rfc3339(hash['assignmentTime']) if hash['assignmentTime'])
+                        else
+                          SKIP
+                        end
+
+      # Create object from extracted values.
+      AccountLicenseDeviceListItem.new(device_id,
+                                       assignment_time)
+    end
+
+    def to_custom_assignment_time
+      DateTimeHelper.to_rfc3339(assignment_time)
+    end
+  end
+end