specs-sdk 1.3.0

data/lib/verizon/models/gio_device_list.rb

@@ -0,0 +1,59 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # GIODeviceList Model.
+  class GIODeviceList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[GIODeviceId]]
+    attr_accessor :device_ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = SKIP)
+      @device_ids = device_ids unless device_ids == 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 << (GIODeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = SKIP unless hash.key?('deviceIds')
+
+      # Create object from extracted values.
+      GIODeviceList.new(device_ids)
+    end
+  end
+end

data/lib/verizon/models/gio_profile_request.rb

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

data/lib/verizon/models/gio_request_response.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # GIORequestResponse Model.
+  class GIORequestResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @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.
+      GIORequestResponse.new(request_id)
+    end
+  end
+end

data/lib/verizon/models/gio_sms_message.rb

@@ -0,0 +1,88 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # GIOSmsMessage Model.
+  class GIOSmsMessage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[GIODeviceId]]
+    attr_accessor :device_ids
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['message'] = 'message'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+        message
+        timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = SKIP,
+                   message = SKIP,
+                   timestamp = SKIP)
+      @device_ids = device_ids unless device_ids == SKIP
+      @message = message unless message == SKIP
+      @timestamp = timestamp unless timestamp == 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 << (GIODeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = SKIP unless hash.key?('deviceIds')
+      message = hash.key?('message') ? hash['message'] : SKIP
+      timestamp = if hash.key?('timestamp')
+                    (DateTimeHelper.from_rfc3339(hash['timestamp']) if hash['timestamp'])
+                  else
+                    SKIP
+                  end
+
+      # Create object from extracted values.
+      GIOSmsMessage.new(device_ids,
+                        message,
+                        timestamp)
+    end
+
+    def to_custom_timestamp
+      DateTimeHelper.to_rfc3339(timestamp)
+    end
+  end
+end

data/lib/verizon/models/giosms_send_request.rb

@@ -0,0 +1,136 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # GIOSMSSendRequest Model.
+  class GIOSMSSendRequest < 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[KvPair]]
+    attr_accessor :custom_fields
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :data_encoding
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :group_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 :time_to_live
+
+    # TODO: Write general description for this method
+    # @return [Array[GIODeviceId]]
+    attr_accessor :device_ids
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :sms_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['data_encoding'] = 'dataEncoding'
+      @_hash['group_name'] = 'groupName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['time_to_live'] = 'timeToLive'
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['sms_message'] = 'smsMessage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        custom_fields
+        data_encoding
+        group_name
+        service_plan
+        time_to_live
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = nil,
+                   sms_message = nil,
+                   account_name = SKIP,
+                   custom_fields = SKIP,
+                   data_encoding = SKIP,
+                   group_name = SKIP,
+                   service_plan = SKIP,
+                   time_to_live = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @data_encoding = data_encoding unless data_encoding == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @time_to_live = time_to_live unless time_to_live == SKIP
+      @device_ids = device_ids
+      @sms_message = sms_message
+    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 << (GIODeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = nil unless hash.key?('deviceIds')
+      sms_message = hash.key?('smsMessage') ? hash['smsMessage'] : nil
+      account_name = hash.key?('accountName') ? hash['accountName'] : 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 << (KvPair.from_hash(structure) if structure)
+        end
+      end
+
+      custom_fields = SKIP unless hash.key?('customFields')
+      data_encoding = hash.key?('dataEncoding') ? hash['dataEncoding'] : SKIP
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+      time_to_live = hash.key?('timeToLive') ? hash['timeToLive'] : SKIP
+
+      # Create object from extracted values.
+      GIOSMSSendRequest.new(device_ids,
+                            sms_message,
+                            account_name,
+                            custom_fields,
+                            data_encoding,
+                            group_name,
+                            service_plan,
+                            time_to_live)
+    end
+  end
+end

data/lib/verizon/models/go_to_state_request.rb

@@ -0,0 +1,222 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Changes the provisioning state of one or more devices to a specified
+  # customer-defined service and state.
+  class GoToStateRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a customer-defined service to push the devices to.
+    # @return [String]
+    attr_accessor :service_name
+
+    # The name of a customer-defined stage state to push the devices to.
+    # @return [String]
+    attr_accessor :state_name
+
+    # The service plan code that you want to assign to all specified devices in
+    # the new state.
+    # @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
+
+    # Up to 10,000 devices that you want to push to a different state, specified
+    # by device identifier.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # Specify the kind of the device identifier, the type of match, and the
+    # string that you want to match.
+    # @return [DeviceFilter]
+    attr_accessor :filter
+
+    # The pool from which your device IP addresses will be derived if the
+    # service or state change requires new IP addresses.If you do not include
+    # this element, the default pool will be used.
+    # @return [String]
+    attr_accessor :carrier_ip_pool_name
+
+    # For devices with static IP addresses on the public network, this specifies
+    # whether the devices have general access to the Internet. Valid values are
+    # “restricted” or “unrestricted”.
+    # @return [String]
+    attr_accessor :public_ip_restriction
+
+    # The Stock Keeping Unit (SKU) number of a 4G device type with an embedded
+    # SIM. Can be used with ICCID or EID 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
+
+    # The names and values of any custom fields that you want to set for the
+    # devices.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # This is an array that associates an IP address with a device identifier.
+    # This variable is only relevant for Business Internet/Fixed Wireless Access
+    # @return [Array[Object]]
+    attr_accessor :devices_with_service_address
+
+    # The IP address of the device.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # The name of a device group that the devices should be added to.
+    # @return [String]
+    attr_accessor :group_name
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['service_name'] = 'serviceName'
+      @_hash['state_name'] = 'stateName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['mdn_zip_code'] = 'mdnZipCode'
+      @_hash['devices'] = 'devices'
+      @_hash['filter'] = 'filter'
+      @_hash['carrier_ip_pool_name'] = 'carrierIpPoolName'
+      @_hash['public_ip_restriction'] = 'publicIpRestriction'
+      @_hash['sku_number'] = 'skuNumber'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['devices_with_service_address'] = 'devicesWithServiceAddress'
+      @_hash['ip_address'] = 'ipAddress'
+      @_hash['group_name'] = 'groupName'
+      @_hash['primary_place_of_use'] = 'primaryPlaceOfUse'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        devices
+        filter
+        carrier_ip_pool_name
+        public_ip_restriction
+        sku_number
+        custom_fields
+        devices_with_service_address
+        ip_address
+        group_name
+        primary_place_of_use
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(service_name = nil,
+                   state_name = nil,
+                   service_plan = nil,
+                   mdn_zip_code = nil,
+                   devices = SKIP,
+                   filter = SKIP,
+                   carrier_ip_pool_name = SKIP,
+                   public_ip_restriction = SKIP,
+                   sku_number = SKIP,
+                   custom_fields = SKIP,
+                   devices_with_service_address = SKIP,
+                   ip_address = SKIP,
+                   group_name = SKIP,
+                   primary_place_of_use = SKIP)
+      @service_name = service_name
+      @state_name = state_name
+      @service_plan = service_plan
+      @mdn_zip_code = mdn_zip_code
+      @devices = devices unless devices == SKIP
+      @filter = filter unless filter == SKIP
+      @carrier_ip_pool_name = carrier_ip_pool_name unless carrier_ip_pool_name == SKIP
+      @public_ip_restriction = public_ip_restriction unless public_ip_restriction == SKIP
+      @sku_number = sku_number unless sku_number == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      unless devices_with_service_address == SKIP
+        @devices_with_service_address =
+          devices_with_service_address
+      end
+      @ip_address = ip_address unless ip_address == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @primary_place_of_use = primary_place_of_use unless primary_place_of_use == 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.
+      service_name = hash.key?('serviceName') ? hash['serviceName'] : nil
+      state_name = hash.key?('stateName') ? hash['stateName'] : nil
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : nil
+      mdn_zip_code = hash.key?('mdnZipCode') ? hash['mdnZipCode'] : 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 = SKIP unless hash.key?('devices')
+      filter = DeviceFilter.from_hash(hash['filter']) if hash['filter']
+      carrier_ip_pool_name =
+        hash.key?('carrierIpPoolName') ? hash['carrierIpPoolName'] : SKIP
+      public_ip_restriction =
+        hash.key?('publicIpRestriction') ? hash['publicIpRestriction'] : SKIP
+      sku_number = hash.key?('skuNumber') ? hash['skuNumber'] : 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')
+      devices_with_service_address =
+        hash.key?('devicesWithServiceAddress') ? hash['devicesWithServiceAddress'] : SKIP
+      ip_address = hash.key?('ipAddress') ? hash['ipAddress'] : SKIP
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      primary_place_of_use = PlaceOfUse.from_hash(hash['primaryPlaceOfUse']) if
+        hash['primaryPlaceOfUse']
+
+      # Create object from extracted values.
+      GoToStateRequest.new(service_name,
+                           state_name,
+                           service_plan,
+                           mdn_zip_code,
+                           devices,
+                           filter,
+                           carrier_ip_pool_name,
+                           public_ip_restriction,
+                           sku_number,
+                           custom_fields,
+                           devices_with_service_address,
+                           ip_address,
+                           group_name,
+                           primary_place_of_use)
+    end
+  end
+end