sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/account_device_list_result.rb

@@ -0,0 +1,71 @@
+# 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_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,77 @@
+# 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,72 @@
+# 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,69 @@
+# 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,70 @@
+# 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

data/lib/verizon/models/account_license_info.rb

@@ -0,0 +1,113 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Account license information.
+  class AccountLicenseInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier in "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # Number of monthly licenses in an MRC subscription.
+    # @return [Integer]
+    attr_accessor :total_licenses
+
+    # Number of licenses currently assigned to devices.
+    # @return [Integer]
+    attr_accessor :assigned_licenses
+
+    # True if there are more devices to retrieve.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # If hasMoreData=true, the startIndex to use for the next request. 0 if
+    # hasMoreData=false.
+    # @return [Integer]
+    attr_accessor :last_seen_device_id
+
+    # The list of devices that have licenses assigned, including the date and
+    # time of when each license was assigned.
+    # @return [Array[AccountLicenseDeviceListItem]]
+    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['total_licenses'] = 'totalLicenses'
+      @_hash['assigned_licenses'] = 'assignedLicenses'
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['last_seen_device_id'] = 'lastSeenDeviceId'
+      @_hash['device_list'] = 'deviceList'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        total_licenses
+        assigned_licenses
+        has_more_data
+        last_seen_device_id
+        device_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   total_licenses = SKIP,
+                   assigned_licenses = SKIP,
+                   has_more_data = SKIP,
+                   last_seen_device_id = SKIP,
+                   device_list = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @total_licenses = total_licenses unless total_licenses == SKIP
+      @assigned_licenses = assigned_licenses unless assigned_licenses == SKIP
+      @has_more_data = has_more_data unless has_more_data == SKIP
+      @last_seen_device_id = last_seen_device_id unless last_seen_device_id == SKIP
+      @device_list = device_list unless device_list == 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
+      total_licenses = hash.key?('totalLicenses') ? hash['totalLicenses'] : SKIP
+      assigned_licenses =
+        hash.key?('assignedLicenses') ? hash['assignedLicenses'] : SKIP
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+      last_seen_device_id =
+        hash.key?('lastSeenDeviceId') ? hash['lastSeenDeviceId'] : SKIP
+      # 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 << (AccountLicenseDeviceListItem.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = SKIP unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      AccountLicenseInfo.new(account_name,
+                             total_licenses,
+                             assigned_licenses,
+                             has_more_data,
+                             last_seen_device_id,
+                             device_list)
+    end
+  end
+end

data/lib/verizon/models/account_service.rb

@@ -0,0 +1,79 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Service associated with the account.
+  class AccountService < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the service plan.
+    # @return [String]
+    attr_accessor :name
+
+    # The description of the service plan.
+    # @return [String]
+    attr_accessor :description
+
+    # The state of the service plan.
+    # @return [Array[State]]
+    attr_accessor :states
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['states'] = 'states'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        description
+        states
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP,
+                   description = SKIP,
+                   states = SKIP)
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @states = states unless states == 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
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      states = nil
+      unless hash['states'].nil?
+        states = []
+        hash['states'].each do |structure|
+          states << (State.from_hash(structure) if structure)
+        end
+      end
+
+      states = SKIP unless hash.key?('states')
+
+      # Create object from extracted values.
+      AccountService.new(name,
+                         description,
+                         states)
+    end
+  end
+end

data/lib/verizon/models/account_states_and_services.rb

@@ -0,0 +1,58 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Returns a list and details of all custom services and states defined for a
+  # specified account.
+  class AccountStatesAndServices < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The engagements associated with the account.
+    # @return [Array[Engagement]]
+    attr_accessor :engagement
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['engagement'] = 'engagement'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(engagement = nil)
+      @engagement = engagement
+    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
+      engagement = nil
+      unless hash['engagement'].nil?
+        engagement = []
+        hash['engagement'].each do |structure|
+          engagement << (Engagement.from_hash(structure) if structure)
+        end
+      end
+
+      engagement = nil unless hash.key?('engagement')
+
+      # Create object from extracted values.
+      AccountStatesAndServices.new(engagement)
+    end
+  end
+end

data/lib/verizon/models/accuracy_mode_enum.rb

@@ -0,0 +1,20 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Accurary, currently only 0-coarse supported.
+  class AccuracyModeEnum
+    ACCURACY_MODE_ENUM = [
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = '0'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCURACY_MODE_ENUM.include?(value)
+    end
+  end
+end