sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/profile_request.rb

@@ -0,0 +1,133 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ProfileRequest Model.
+  class ProfileRequest < 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[DeviceList]]
+    attr_accessor :devices
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :service_plan
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :mdn_zip_code
+
+    # TODO: Write general description for this method
+    # @return [Array[PrimaryPlaceOfUse]]
+    attr_accessor :primary_place_of_use
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :smsr_oid
+
+    # The name of the pool of IP addresses assigned to the profile.
+    # @return [String]
+    attr_accessor :carrier_ip_pool_name
+
+    # 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['carrier_name'] = 'carrierName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['mdn_zip_code'] = 'mdnZipCode'
+      @_hash['primary_place_of_use'] = 'primaryPlaceOfUse'
+      @_hash['smsr_oid'] = 'smsrOid'
+      @_hash['carrier_ip_pool_name'] = 'carrierIpPoolName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_name
+        service_plan
+        mdn_zip_code
+        primary_place_of_use
+        smsr_oid
+        carrier_ip_pool_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil, devices = nil, carrier_name = SKIP,
+                   service_plan = SKIP, mdn_zip_code = SKIP,
+                   primary_place_of_use = SKIP, smsr_oid = SKIP,
+                   carrier_ip_pool_name = SKIP)
+      @account_name = account_name
+      @devices = devices
+      @carrier_name = carrier_name unless carrier_name == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @mdn_zip_code = mdn_zip_code unless mdn_zip_code == SKIP
+      @primary_place_of_use = primary_place_of_use unless primary_place_of_use == SKIP
+      @smsr_oid = smsr_oid unless smsr_oid == SKIP
+      @carrier_ip_pool_name = carrier_ip_pool_name unless carrier_ip_pool_name == 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
+      # 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')
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+      mdn_zip_code = hash.key?('mdnZipCode') ? hash['mdnZipCode'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      primary_place_of_use = nil
+      unless hash['primaryPlaceOfUse'].nil?
+        primary_place_of_use = []
+        hash['primaryPlaceOfUse'].each do |structure|
+          primary_place_of_use << (PrimaryPlaceOfUse.from_hash(structure) if structure)
+        end
+      end
+
+      primary_place_of_use = SKIP unless hash.key?('primaryPlaceOfUse')
+      smsr_oid = hash.key?('smsrOid') ? hash['smsrOid'] : SKIP
+      carrier_ip_pool_name =
+        hash.key?('carrierIpPoolName') ? hash['carrierIpPoolName'] : SKIP
+
+      # Create object from extracted values.
+      ProfileRequest.new(account_name,
+                         devices,
+                         carrier_name,
+                         service_plan,
+                         mdn_zip_code,
+                         primary_place_of_use,
+                         smsr_oid,
+                         carrier_ip_pool_name)
+    end
+  end
+end

data/lib/verizon/models/profile_request2.rb

@@ -0,0 +1,106 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ProfileRequest2 Model.
+  class ProfileRequest2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[DeviceList2]]
+    attr_accessor :devices
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :carrier_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reason_code
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :etf_waiver
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :check_fallback_profile
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['devices'] = 'devices'
+      @_hash['account_name'] = 'accountName'
+      @_hash['carrier_name'] = 'carrierName'
+      @_hash['reason_code'] = 'reasonCode'
+      @_hash['etf_waiver'] = 'etfWaiver'
+      @_hash['check_fallback_profile'] = 'checkFallbackProfile'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        devices
+        account_name
+        carrier_name
+        reason_code
+        etf_waiver
+        check_fallback_profile
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(devices = SKIP, account_name = SKIP, carrier_name = SKIP,
+                   reason_code = SKIP, etf_waiver = true,
+                   check_fallback_profile = false)
+      @devices = devices unless devices == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @carrier_name = carrier_name unless carrier_name == SKIP
+      @reason_code = reason_code unless reason_code == SKIP
+      @etf_waiver = etf_waiver unless etf_waiver == SKIP
+      @check_fallback_profile = check_fallback_profile unless check_fallback_profile == 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 << (DeviceList2.from_hash(structure) if structure)
+        end
+      end
+
+      devices = SKIP unless hash.key?('devices')
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      carrier_name = hash.key?('carrierName') ? hash['carrierName'] : SKIP
+      reason_code = hash.key?('reasonCode') ? hash['reasonCode'] : SKIP
+      etf_waiver = hash['etfWaiver'] ||= true
+      check_fallback_profile = hash['checkFallbackProfile'] ||= false
+
+      # Create object from extracted values.
+      ProfileRequest2.new(devices,
+                          account_name,
+                          carrier_name,
+                          reason_code,
+                          etf_waiver,
+                          check_fallback_profile)
+    end
+  end
+end

data/lib/verizon/models/profile_status_filter_enum.rb

@@ -0,0 +1,38 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The last status of the device's profile as a filter.
+  class ProfileStatusFilterEnum
+    PROFILE_STATUS_FILTER_ENUM = [
+      # TODO: Write general description for ENABLE
+      ENABLE = 'ENABLE'.freeze,
+
+      # TODO: Write general description for DISABLE
+      DISABLE = 'DISABLE'.freeze,
+
+      # TODO: Write general description for DOWNLOAD_DISABLE
+      DOWNLOAD_DISABLE = 'DOWNLOAD_DISABLE'.freeze,
+
+      # TODO: Write general description for DOWNLOAD_ENABLE
+      DOWNLOAD_ENABLE = 'DOWNLOAD_ENABLE'.freeze,
+
+      # TODO: Write general description for NOT_DOWNLOADED
+      NOT_DOWNLOADED = 'NOT_DOWNLOADED'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze,
+
+      # TODO: Write general description for DELETE
+      DELETE = 'DELETE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PROFILE_STATUS_FILTER_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/promo_alert.rb

@@ -0,0 +1,88 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # PromoAlert Model.
+  class PromoAlert < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ReadySimServicePlan]]
+    attr_accessor :filter_criteria
+
+    # TODO: Write general description for this method
+    # @return [Array[Keyschunk2]]
+    attr_accessor :condition
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_promo_exp
+
+    # 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['enable_promo_exp'] = 'enablePromoExp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        filter_criteria
+        condition
+        enable_promo_exp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(filter_criteria = SKIP, condition = SKIP,
+                   enable_promo_exp = SKIP)
+      @filter_criteria = filter_criteria unless filter_criteria == SKIP
+      @condition = condition unless condition == SKIP
+      @enable_promo_exp = enable_promo_exp unless enable_promo_exp == 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
+      filter_criteria = nil
+      unless hash['filterCriteria'].nil?
+        filter_criteria = []
+        hash['filterCriteria'].each do |structure|
+          filter_criteria << (ReadySimServicePlan.from_hash(structure) if structure)
+        end
+      end
+
+      filter_criteria = SKIP unless hash.key?('filterCriteria')
+      # Parameter is an array, so we need to iterate through it
+      condition = nil
+      unless hash['condition'].nil?
+        condition = []
+        hash['condition'].each do |structure|
+          condition << (Keyschunk2.from_hash(structure) if structure)
+        end
+      end
+
+      condition = SKIP unless hash.key?('condition')
+      enable_promo_exp =
+        hash.key?('enablePromoExp') ? hash['enablePromoExp'] : SKIP
+
+      # Create object from extracted values.
+      PromoAlert.new(filter_criteria,
+                     condition,
+                     enable_promo_exp)
+    end
+  end
+end

data/lib/verizon/models/promo_alert1.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # PromoAlert1 Model.
+  class PromoAlert1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Object]]
+    attr_accessor :filter_criteria
+
+    # TODO: Write general description for this method
+    # @return [Array[Keyschunk2]]
+    attr_accessor :condition
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_promo_exp
+
+    # 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['enable_promo_exp'] = 'enablePromoExp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        filter_criteria
+        condition
+        enable_promo_exp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(filter_criteria = SKIP, condition = SKIP,
+                   enable_promo_exp = SKIP)
+      @filter_criteria = filter_criteria unless filter_criteria == SKIP
+      @condition = condition unless condition == SKIP
+      @enable_promo_exp = enable_promo_exp unless enable_promo_exp == 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 =
+        hash.key?('filterCriteria') ? hash['filterCriteria'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      condition = nil
+      unless hash['condition'].nil?
+        condition = []
+        hash['condition'].each do |structure|
+          condition << (Keyschunk2.from_hash(structure) if structure)
+        end
+      end
+
+      condition = SKIP unless hash.key?('condition')
+      enable_promo_exp =
+        hash.key?('enablePromoExp') ? hash['enablePromoExp'] : SKIP
+
+      # Create object from extracted values.
+      PromoAlert1.new(filter_criteria,
+                      condition,
+                      enable_promo_exp)
+    end
+  end
+end

data/lib/verizon/models/promo_alert_trigger_request.rb

@@ -0,0 +1,114 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # PromoAlertTriggerRequest Model.
+  class PromoAlertTriggerRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :data_percentage50
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :data_percentage75
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :data_percentage90
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :no_of_days_b4_promo_exp
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :sms_percentage50
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :sms_percentage75
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :sms_percentage90
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data_percentage50'] = 'dataPercentage50'
+      @_hash['data_percentage75'] = 'dataPercentage75'
+      @_hash['data_percentage90'] = 'dataPercentage90'
+      @_hash['no_of_days_b4_promo_exp'] = 'noOfDaysB4PromoExp'
+      @_hash['sms_percentage50'] = 'smsPercentage50'
+      @_hash['sms_percentage75'] = 'smsPercentage75'
+      @_hash['sms_percentage90'] = 'smsPercentage90'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data_percentage50
+        data_percentage75
+        data_percentage90
+        no_of_days_b4_promo_exp
+        sms_percentage50
+        sms_percentage75
+        sms_percentage90
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data_percentage50 = SKIP, data_percentage75 = SKIP,
+                   data_percentage90 = SKIP, no_of_days_b4_promo_exp = SKIP,
+                   sms_percentage50 = SKIP, sms_percentage75 = SKIP,
+                   sms_percentage90 = SKIP)
+      @data_percentage50 = data_percentage50 unless data_percentage50 == SKIP
+      @data_percentage75 = data_percentage75 unless data_percentage75 == SKIP
+      @data_percentage90 = data_percentage90 unless data_percentage90 == SKIP
+      @no_of_days_b4_promo_exp = no_of_days_b4_promo_exp unless no_of_days_b4_promo_exp == SKIP
+      @sms_percentage50 = sms_percentage50 unless sms_percentage50 == SKIP
+      @sms_percentage75 = sms_percentage75 unless sms_percentage75 == SKIP
+      @sms_percentage90 = sms_percentage90 unless sms_percentage90 == 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.
+      data_percentage50 =
+        hash.key?('dataPercentage50') ? hash['dataPercentage50'] : SKIP
+      data_percentage75 =
+        hash.key?('dataPercentage75') ? hash['dataPercentage75'] : SKIP
+      data_percentage90 =
+        hash.key?('dataPercentage90') ? hash['dataPercentage90'] : SKIP
+      no_of_days_b4_promo_exp =
+        hash.key?('noOfDaysB4PromoExp') ? hash['noOfDaysB4PromoExp'] : SKIP
+      sms_percentage50 =
+        hash.key?('smsPercentage50') ? hash['smsPercentage50'] : SKIP
+      sms_percentage75 =
+        hash.key?('smsPercentage75') ? hash['smsPercentage75'] : SKIP
+      sms_percentage90 =
+        hash.key?('smsPercentage90') ? hash['smsPercentage90'] : SKIP
+
+      # Create object from extracted values.
+      PromoAlertTriggerRequest.new(data_percentage50,
+                                   data_percentage75,
+                                   data_percentage90,
+                                   no_of_days_b4_promo_exp,
+                                   sms_percentage50,
+                                   sms_percentage75,
+                                   sms_percentage90)
+    end
+  end
+end

data/lib/verizon/models/property_device_id.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # PropertyDeviceId Model.
+  class PropertyDeviceId < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # The type of the device identifier. Valid types of identifiers are:ESN
+    # (decimal),EID,ICCID (up to 20 digits),IMEI (up to 16 digits),MDN,MEID
+    # (hexadecimal),MSISDN.
+    # @return [String]
+    attr_accessor :kind
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['kind'] = 'kind'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        kind
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, kind = SKIP)
+      @id = id unless id == SKIP
+      @kind = kind unless kind == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+
+      # Create object from extracted values.
+      PropertyDeviceId.new(id,
+                           kind)
+    end
+  end
+end