sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/change_configuration_response.rb

@@ -0,0 +1,155 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Change Configuration resource definition.
+  class ChangeConfigurationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The action requested in this event; “change” for device configuration
+    # changes.
+    # @return [String]
+    attr_accessor :action
+
+    # The date and time of the change request.
+    # @return [String]
+    attr_accessor :createdon
+
+    # The device’s ThingSpace UUID.
+    # @return [String]
+    attr_accessor :deviceid
+
+    # List of fields affected by the event.
+    # @return [Fields]
+    attr_accessor :fields
+
+    # foreign id
+    # @return [String]
+    attr_accessor :foreignid
+
+    # The unique ID of this ts.event.configuration event.
+    # @return [String]
+    attr_accessor :id
+
+    # The kind of the ThingSpace resource that is being reported
+    # @return [String]
+    attr_accessor :kind
+
+    # The date and time that the event was last updated.
+    # @return [String]
+    attr_accessor :lastupdated
+
+    # The name of the event; “SetConfigurationReq” for device configuration
+    # changes.
+    # @return [String]
+    attr_accessor :name
+
+    # The current status of the request. The value will be “pending” until the
+    # device wakes up and ThingSpace can send the request to the device.
+    # @return [String]
+    attr_accessor :state
+
+    # transaction id
+    # @return [String]
+    attr_accessor :transactionid
+
+    # version
+    # @return [String]
+    attr_accessor :version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['action'] = 'action'
+      @_hash['createdon'] = 'createdon'
+      @_hash['deviceid'] = 'deviceid'
+      @_hash['fields'] = 'fields'
+      @_hash['foreignid'] = 'foreignid'
+      @_hash['id'] = 'id'
+      @_hash['kind'] = 'kind'
+      @_hash['lastupdated'] = 'lastupdated'
+      @_hash['name'] = 'name'
+      @_hash['state'] = 'state'
+      @_hash['transactionid'] = 'transactionid'
+      @_hash['version'] = 'version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action
+        createdon
+        deviceid
+        fields
+        foreignid
+        id
+        kind
+        lastupdated
+        name
+        state
+        transactionid
+        version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(action = SKIP, createdon = SKIP, deviceid = SKIP,
+                   fields = SKIP, foreignid = SKIP, id = SKIP, kind = SKIP,
+                   lastupdated = SKIP, name = SKIP, state = SKIP,
+                   transactionid = SKIP, version = SKIP)
+      @action = action unless action == SKIP
+      @createdon = createdon unless createdon == SKIP
+      @deviceid = deviceid unless deviceid == SKIP
+      @fields = fields unless fields == SKIP
+      @foreignid = foreignid unless foreignid == SKIP
+      @id = id unless id == SKIP
+      @kind = kind unless kind == SKIP
+      @lastupdated = lastupdated unless lastupdated == SKIP
+      @name = name unless name == SKIP
+      @state = state unless state == SKIP
+      @transactionid = transactionid unless transactionid == SKIP
+      @version = version unless version == 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
+      createdon = hash.key?('createdon') ? hash['createdon'] : SKIP
+      deviceid = hash.key?('deviceid') ? hash['deviceid'] : SKIP
+      fields = Fields.from_hash(hash['fields']) if hash['fields']
+      foreignid = hash.key?('foreignid') ? hash['foreignid'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+      lastupdated = hash.key?('lastupdated') ? hash['lastupdated'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      transactionid = hash.key?('transactionid') ? hash['transactionid'] : SKIP
+      version = hash.key?('version') ? hash['version'] : SKIP
+
+      # Create object from extracted values.
+      ChangeConfigurationResponse.new(action,
+                                      createdon,
+                                      deviceid,
+                                      fields,
+                                      foreignid,
+                                      id,
+                                      kind,
+                                      lastupdated,
+                                      name,
+                                      state,
+                                      transactionid,
+                                      version)
+    end
+  end
+end

data/lib/verizon/models/change_device_id_request.rb

@@ -0,0 +1,150 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Changes the identifier of a 3G or 4G device to match hardware changes made
+  # for a line of service. Use this request to transfer the line of service and
+  # the MDN to new hardware, or to change the MDN.
+  class ChangeDeviceIdRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Set to true to assign a non-Geo MDN and MSISDN, or false to assign an MDN
+    # and MSISDN from a specific NPA-NXX.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :assign_non_geo_mdn
+
+    # The type of change that you want to make for a 4G device.
+    # @return [String]
+    attr_accessor :change4g_option
+
+    # The device that you want to change, specified by a device identifier.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # The new identifier for the device. Required for all change4GOptions except
+    # ChangeMSISDN.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids_to
+
+    # The NPA NXX (area code and prefix) from which the MDN and MSISDN will be
+    # derived when assignNonGeoMDN is false. Specify the 6-digit NPA NXX of the
+    # location where the line of service will primarily be used. This API checks
+    # to see if a number starting with the NPA NXX is available. If not, this
+    # API uses the zipCode parameter, if specified, to assign a number in the
+    # area of the line of service. This parameter is required when you change an
+    # MDN/MSISDN for a B2B carrier, such as Verizon Wireless.
+    # @return [String]
+    attr_accessor :npa_nxx
+
+    # The code for a different service plan, if you want to change the service
+    # plan while changing the device identifier. Set this parameter to one of
+    # the Code values returned by GET /plans.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # The ZIP code from which the MDN and MSISDN will be derived when
+    # assignNonGeoMDN is true. Specify the zip code of the location where the
+    # line of service will primarily be used.
+    # @return [String]
+    attr_accessor :zip_code
+
+    # The ZIP code from which the MDN and MSISDN will be derived when
+    # assignNonGeoMDN is true. Specify the zip code of the location where the
+    # line of service will primarily be used.
+    # @return [String]
+    attr_accessor :smsr_oid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['assign_non_geo_mdn'] = 'assignNonGeoMdn'
+      @_hash['change4g_option'] = 'change4gOption'
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['device_ids_to'] = 'deviceIdsTo'
+      @_hash['npa_nxx'] = 'npaNxx'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['zip_code'] = 'zipCode'
+      @_hash['smsr_oid'] = 'smsrOid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        assign_non_geo_mdn
+        change4g_option
+        device_ids_to
+        npa_nxx
+        service_plan
+        zip_code
+        smsr_oid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = nil, assign_non_geo_mdn = SKIP,
+                   change4g_option = SKIP, device_ids_to = SKIP, npa_nxx = SKIP,
+                   service_plan = SKIP, zip_code = SKIP, smsr_oid = SKIP)
+      @assign_non_geo_mdn = assign_non_geo_mdn unless assign_non_geo_mdn == SKIP
+      @change4g_option = change4g_option unless change4g_option == SKIP
+      @device_ids = device_ids
+      @device_ids_to = device_ids_to unless device_ids_to == SKIP
+      @npa_nxx = npa_nxx unless npa_nxx == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @zip_code = zip_code unless zip_code == SKIP
+      @smsr_oid = smsr_oid unless smsr_oid == 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
+      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 = nil unless hash.key?('deviceIds')
+      assign_non_geo_mdn =
+        hash.key?('assignNonGeoMdn') ? hash['assignNonGeoMdn'] : SKIP
+      change4g_option =
+        hash.key?('change4gOption') ? hash['change4gOption'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      device_ids_to = nil
+      unless hash['deviceIdsTo'].nil?
+        device_ids_to = []
+        hash['deviceIdsTo'].each do |structure|
+          device_ids_to << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids_to = SKIP unless hash.key?('deviceIdsTo')
+      npa_nxx = hash.key?('npaNxx') ? hash['npaNxx'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+      zip_code = hash.key?('zipCode') ? hash['zipCode'] : SKIP
+      smsr_oid = hash.key?('smsrOid') ? hash['smsrOid'] : SKIP
+
+      # Create object from extracted values.
+      ChangeDeviceIdRequest.new(device_ids,
+                                assign_non_geo_mdn,
+                                change4g_option,
+                                device_ids_to,
+                                npa_nxx,
+                                service_plan,
+                                zip_code,
+                                smsr_oid)
+    end
+  end
+end

data/lib/verizon/models/change_plan.rb

@@ -0,0 +1,68 @@
+# 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/change_pwn_device_ipaddress_request.rb

@@ -0,0 +1,65 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ChangePWNDeviceIpaddressRequest Model.
+  class ChangePWNDeviceIpaddressRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # TODO: Write general description for this method
+    # @return [Array[DeviceListIP]]
+    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 << (DeviceListIP.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+
+      # Create object from extracted values.
+      ChangePWNDeviceIpaddressRequest.new(account_name,
+                                          device_list)
+    end
+  end
+end

data/lib/verizon/models/change_pwn_device_ipaddress_response.rb

@@ -0,0 +1,51 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to change PWN device ip address.
+  class ChangePWNDeviceIpaddressResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique string that associates the request with the results that are sent
+    # via a callback service.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'requestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP)
+      @request_id = request_id unless request_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.
+      request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+
+      # Create object from extracted values.
+      ChangePWNDeviceIpaddressResponse.new(request_id)
+    end
+  end
+end

data/lib/verizon/models/change_pwn_device_profile_request.rb

@@ -0,0 +1,73 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ChangePWNDeviceProfileRequest Model.
+  class ChangePWNDeviceProfileRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # TODO: Write general description for this method
+    # @return [Array[PWNDeviceList]]
+    attr_accessor :device_list
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :new_profile
+
+    # 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['new_profile'] = 'newProfile'
+      @_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, new_profile = nil)
+      @account_name = account_name
+      @device_list = device_list
+      @new_profile = new_profile
+    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 << (PWNDeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+      new_profile = hash.key?('newProfile') ? hash['newProfile'] : nil
+
+      # Create object from extracted values.
+      ChangePWNDeviceProfileRequest.new(account_name,
+                                        device_list,
+                                        new_profile)
+    end
+  end
+end

data/lib/verizon/models/change_pwn_device_profile_response.rb

@@ -0,0 +1,51 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to change PWN device profile
+  class ChangePWNDeviceProfileResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A unique string that associates the request with the results that are sent
+    # via a callback service.
+    # @return [String]
+    attr_accessor :request_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['request_id'] = 'requestId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        request_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(request_id = SKIP)
+      @request_id = request_id unless request_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.
+      request_id = hash.key?('requestId') ? hash['requestId'] : SKIP
+
+      # Create object from extracted values.
+      ChangePWNDeviceProfileResponse.new(request_id)
+    end
+  end
+end

data/lib/verizon/models/change_pwn_device_state_activate_request.rb

@@ -0,0 +1,73 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ChangePWNDeviceStateActivateRequest Model.
+  class ChangePWNDeviceStateActivateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # TODO: Write general description for this method
+    # @return [Array[PWNDeviceList]]
+    attr_accessor :device_list
+
+    # TODO: Write general description for this method
+    # @return [Activate]
+    attr_accessor :activate
+
+    # 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['activate'] = 'activate'
+      @_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, activate = nil)
+      @account_name = account_name
+      @device_list = device_list
+      @activate = activate
+    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 << (PWNDeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+      activate = Activate.from_hash(hash['activate']) if hash['activate']
+
+      # Create object from extracted values.
+      ChangePWNDeviceStateActivateRequest.new(account_name,
+                                              device_list,
+                                              activate)
+    end
+  end
+end