sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/carrier_activate_request.rb

@@ -0,0 +1,200 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request for carrier activation.
+  class CarrierActivateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Up to 10,000 devices for which you want to activate service, specified by
+    # device identifier.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # The service plan code that you want to assign to all specified devices.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # The Zip code of the location where the line of service will primarily be
+    # used, or a Zip code that you have been told to use with these devices. For
+    # accounts that are configured for geographic numbering, this is the ZIP
+    # code from which the MDN will be derived.
+    # @return [String]
+    attr_accessor :mdn_zip_code
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The private IP pool (Carrier Group Name) from which your device IP
+    # addresses will be derived.
+    # @return [String]
+    attr_accessor :carrier_ip_pool_name
+
+    # The carrier that will perform the activation.
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # A string to identify the cost center that the device is associated with.
+    # @return [String]
+    attr_accessor :cost_center_code
+
+    # A user-defined descriptive field, limited to 50 characters.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # If you specify devices by ID in the devices parameters, this is the name
+    # of a device group that the devices should be added to.If you don't specify
+    # individual devices with the devices parameter, you can provide the name of
+    # a device group to activate all devices in that group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The ID of a “Qualified” or “Closed - Won” VPP customer lead, which is used
+    # with other values to determine MDN assignment, taxation, and compensation.
+    # @return [String]
+    attr_accessor :lead_id
+
+    # The customer name and the address of the device's primary place of use.
+    # Leave these fields empty to use the account profile address as the primary
+    # place of use. These values will be applied to all devices in the
+    # request.If the account is enabled for non-geographic MDNs and the device
+    # supports it, the primaryPlaceOfUse address will also be used to derive the
+    # MDN for the device.
+    # @return [PlaceOfUse]
+    attr_accessor :primary_place_of_use
+
+    # For devices with static IP addresses on the public network, this specifies
+    # whether the devices have general access to the Internet.
+    # @return [String]
+    attr_accessor :public_ip_restriction
+
+    # The Stock Keeping Unit (SKU) of a 4G device type can be used with ICCID
+    # device identifiers in lieu of an IMEI when activating 4G devices. The
+    # SkuNumber will be used with all devices in the request, so all devices
+    # must be of the same type.
+    # @return [String]
+    attr_accessor :sku_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['devices'] = 'devices'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['mdn_zip_code'] = 'mdnZipCode'
+      @_hash['account_name'] = 'accountName'
+      @_hash['carrier_ip_pool_name'] = 'carrierIpPoolName'
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash['cost_center_code'] = 'costCenterCode'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['group_name'] = 'groupName'
+      @_hash['lead_id'] = 'leadId'
+      @_hash['primary_place_of_use'] = 'primaryPlaceOfUse'
+      @_hash['public_ip_restriction'] = 'publicIpRestriction'
+      @_hash['sku_number'] = 'skuNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        carrier_ip_pool_name
+        carrier_name
+        cost_center_code
+        custom_fields
+        group_name
+        lead_id
+        primary_place_of_use
+        public_ip_restriction
+        sku_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(devices = nil, service_plan = nil, mdn_zip_code = nil,
+                   account_name = SKIP, carrier_ip_pool_name = SKIP,
+                   carrier_name = SKIP, cost_center_code = SKIP,
+                   custom_fields = SKIP, group_name = SKIP, lead_id = SKIP,
+                   primary_place_of_use = SKIP, public_ip_restriction = SKIP,
+                   sku_number = SKIP)
+      @devices = devices
+      @service_plan = service_plan
+      @mdn_zip_code = mdn_zip_code
+      @account_name = account_name unless account_name == SKIP
+      @carrier_ip_pool_name = carrier_ip_pool_name unless carrier_ip_pool_name == SKIP
+      @carrier_name = carrier_name unless carrier_name == SKIP
+      @cost_center_code = cost_center_code unless cost_center_code == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @lead_id = lead_id unless lead_id == SKIP
+      @primary_place_of_use = primary_place_of_use unless primary_place_of_use == SKIP
+      @public_ip_restriction = public_ip_restriction unless public_ip_restriction == SKIP
+      @sku_number = sku_number unless sku_number == 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 << (AccountDeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      devices = nil unless hash.key?('devices')
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : nil
+      mdn_zip_code = hash.key?('mdnZipCode') ? hash['mdnZipCode'] : nil
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      carrier_ip_pool_name =
+        hash.key?('carrierIpPoolName') ? hash['carrierIpPoolName'] : SKIP
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : SKIP
+      cost_center_code =
+        hash.key?('costCenterCode') ? hash['costCenterCode'] : 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')
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      lead_id = hash.key?('leadId') ? hash['leadId'] : SKIP
+      primary_place_of_use = PlaceOfUse.from_hash(hash['primaryPlaceOfUse']) if
+        hash['primaryPlaceOfUse']
+      public_ip_restriction =
+        hash.key?('publicIpRestriction') ? hash['publicIpRestriction'] : SKIP
+      sku_number = hash.key?('skuNumber') ? hash['skuNumber'] : SKIP
+
+      # Create object from extracted values.
+      CarrierActivateRequest.new(devices,
+                                 service_plan,
+                                 mdn_zip_code,
+                                 account_name,
+                                 carrier_ip_pool_name,
+                                 carrier_name,
+                                 cost_center_code,
+                                 custom_fields,
+                                 group_name,
+                                 lead_id,
+                                 primary_place_of_use,
+                                 public_ip_restriction,
+                                 sku_number)
+    end
+  end
+end

data/lib/verizon/models/carrier_deactivate_request.rb

@@ -0,0 +1,142 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to deactivate a carrier.
+  class CarrierDeactivateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The devices for which you want to deactivate service, specified by device
+    # identifier.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # Code identifying the reason for the deactivation. Currently the only valid
+    # reason code is “FF”, which corresponds to General Admin/Maintenance.
+    # @return [String]
+    attr_accessor :reason_code
+
+    # Custom field names and values, if you want to only include devices that
+    # have matching values.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # Fees may be assessed for deactivating Verizon Wireless devices, depending
+    # on the account contract. The etfWaiver parameter waives the Early
+    # Termination Fee (ETF), if applicable.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :etf_waiver
+
+    # The name of a device group, if you want to deactivate all devices in that
+    # group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The name of a service plan, if you want to only include devices that have
+    # that service plan.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # The name of a service plan, if you want to only include devices that have
+    # that service plan.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :delete_after_deactivation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['devices'] = 'devices'
+      @_hash['reason_code'] = 'reasonCode'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['etf_waiver'] = 'etfWaiver'
+      @_hash['group_name'] = 'groupName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['delete_after_deactivation'] = 'deleteAfterDeactivation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        custom_fields
+        etf_waiver
+        group_name
+        service_plan
+        delete_after_deactivation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil, devices = nil, reason_code = nil,
+                   custom_fields = SKIP, etf_waiver = SKIP, group_name = SKIP,
+                   service_plan = SKIP, delete_after_deactivation = SKIP)
+      @account_name = account_name
+      @devices = devices
+      @reason_code = reason_code
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @etf_waiver = etf_waiver unless etf_waiver == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      unless delete_after_deactivation == SKIP
+        @delete_after_deactivation =
+          delete_after_deactivation
+      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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      # 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 = nil unless hash.key?('devices')
+      reason_code = hash.key?('reasonCode') ? hash['reasonCode'] : nil
+      # 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')
+      etf_waiver = hash.key?('etfWaiver') ? hash['etfWaiver'] : SKIP
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+      delete_after_deactivation =
+        hash.key?('deleteAfterDeactivation') ? hash['deleteAfterDeactivation'] : SKIP
+
+      # Create object from extracted values.
+      CarrierDeactivateRequest.new(account_name,
+                                   devices,
+                                   reason_code,
+                                   custom_fields,
+                                   etf_waiver,
+                                   group_name,
+                                   service_plan,
+                                   delete_after_deactivation)
+    end
+  end
+end

data/lib/verizon/models/carrier_information.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Information about the carrier.
+  class CarrierInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The carrier that will perform the activation. This parameter is only
+    # required if you have more than one carrier.
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # The service plan code that is assigned to the device.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # The device state. Valid values include: Activate, Suspend, Deactive,
+    # Pre-active.
+    # @return [String]
+    attr_accessor :state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['state'] = 'state'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_name
+        service_plan
+        state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(carrier_name = SKIP, service_plan = SKIP, state = SKIP)
+      @carrier_name = carrier_name unless carrier_name == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @state = state unless 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.
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+
+      # Create object from extracted values.
+      CarrierInformation.new(carrier_name,
+                             service_plan,
+                             state)
+    end
+  end
+end

data/lib/verizon/models/carrier_service_plan.rb

@@ -0,0 +1,83 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # CarrierServicePlan Model.
+  class CarrierServicePlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the service plan
+    # @return [String]
+    attr_accessor :name
+
+    # The inventory name or system name of the service plan
+    # @return [String]
+    attr_accessor :code
+
+    # The ammount of space the service plan will occupy on the Subscriber
+    # Information Module (SIM)
+    # @return [String]
+    attr_accessor :size_kb
+
+    # The billing record ID. This can be numeric, alpha or alphanumeric.
+    # @return [String]
+    attr_accessor :carrier_service_plan_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['code'] = 'code'
+      @_hash['size_kb'] = 'sizeKb'
+      @_hash['carrier_service_plan_code'] = 'carrierServicePlanCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        code
+        size_kb
+        carrier_service_plan_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, code = SKIP, size_kb = SKIP,
+                   carrier_service_plan_code = SKIP)
+      @name = name unless name == SKIP
+      @code = code unless code == SKIP
+      @size_kb = size_kb unless size_kb == SKIP
+      unless carrier_service_plan_code == SKIP
+        @carrier_service_plan_code =
+          carrier_service_plan_code
+      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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
+      size_kb = hash.key?('sizeKb') ? hash['sizeKb'] : SKIP
+      carrier_service_plan_code =
+        hash.key?('carrierServicePlanCode') ? hash['carrierServicePlanCode'] : SKIP
+
+      # Create object from extracted values.
+      CarrierServicePlan.new(name,
+                             code,
+                             size_kb,
+                             carrier_service_plan_code)
+    end
+  end
+end

data/lib/verizon/models/change_configuration_request.rb

@@ -0,0 +1,73 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The request body identifies the device and the values to set.
+  class ChangeConfigurationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of the authenticating billing account, in the format
+    # `{"billingaccountid":"1234567890-12345"}`.
+    # @return [AccountIdentifier]
+    attr_accessor :accountidentifier
+
+    # The ID of the target to delete, in the format {"id":
+    # "dd1682d3-2d80-cefc-f3ee-25154800beff"}.
+    # @return [ResourceIdentifier]
+    attr_accessor :resourceidentifier
+
+    # List of the field names and values to set.
+    # @return [Configuration]
+    attr_accessor :configuration
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accountidentifier'] = 'accountidentifier'
+      @_hash['resourceidentifier'] = 'resourceidentifier'
+      @_hash['configuration'] = 'configuration'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accountidentifier
+        resourceidentifier
+        configuration
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accountidentifier = SKIP, resourceidentifier = SKIP,
+                   configuration = SKIP)
+      @accountidentifier = accountidentifier unless accountidentifier == SKIP
+      @resourceidentifier = resourceidentifier unless resourceidentifier == SKIP
+      @configuration = configuration unless configuration == 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.
+      accountidentifier = AccountIdentifier.from_hash(hash['accountidentifier']) if
+        hash['accountidentifier']
+      resourceidentifier = ResourceIdentifier.from_hash(hash['resourceidentifier']) if
+        hash['resourceidentifier']
+      configuration = Configuration.from_hash(hash['configuration']) if hash['configuration']
+
+      # Create object from extracted values.
+      ChangeConfigurationRequest.new(accountidentifier,
+                                     resourceidentifier,
+                                     configuration)
+    end
+  end
+end