specs-sdk 1.3.0

data/lib/verizon/models/provisioning_history.rb

@@ -0,0 +1,130 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The provisioning history of a specified device during a specified time
+  # period.
+  class ProvisioningHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The date and time when the provisioning event occured.
+    # @return [String]
+    attr_accessor :occurred_at
+
+    # The success or failure of the provisioning event.
+    # @return [String]
+    attr_accessor :status
+
+    # The user who performed the provisioning event.
+    # @return [String]
+    attr_accessor :event_by
+
+    # The provisioning action:Activate,Suspend,Restore,Deactivate,Device Move.
+    # @return [String]
+    attr_accessor :event_type
+
+    # The MDN assigned to the device after the provisioning event.
+    # @return [String]
+    attr_accessor :mdn
+
+    # The MSISDN assigned to the device after the provisioning event.
+    # @return [String]
+    attr_accessor :msisdn
+
+    # The service plan of the device after the provisioning event occurred.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # Any extended attributes for the event, as Key and Value pairs.
+    # @return [Array[CustomFields]]
+    attr_accessor :extended_attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['occurred_at'] = 'occurredAt'
+      @_hash['status'] = 'status'
+      @_hash['event_by'] = 'eventBy'
+      @_hash['event_type'] = 'eventType'
+      @_hash['mdn'] = 'mdn'
+      @_hash['msisdn'] = 'msisdn'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['extended_attributes'] = 'extendedAttributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        occurred_at
+        status
+        event_by
+        event_type
+        mdn
+        msisdn
+        service_plan
+        extended_attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(occurred_at = SKIP,
+                   status = SKIP,
+                   event_by = SKIP,
+                   event_type = SKIP,
+                   mdn = SKIP,
+                   msisdn = SKIP,
+                   service_plan = SKIP,
+                   extended_attributes = SKIP)
+      @occurred_at = occurred_at unless occurred_at == SKIP
+      @status = status unless status == SKIP
+      @event_by = event_by unless event_by == SKIP
+      @event_type = event_type unless event_type == SKIP
+      @mdn = mdn unless mdn == SKIP
+      @msisdn = msisdn unless msisdn == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @extended_attributes = extended_attributes unless extended_attributes == 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.
+      occurred_at = hash.key?('occurredAt') ? hash['occurredAt'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      event_by = hash.key?('eventBy') ? hash['eventBy'] : SKIP
+      event_type = hash.key?('eventType') ? hash['eventType'] : SKIP
+      mdn = hash.key?('mdn') ? hash['mdn'] : SKIP
+      msisdn = hash.key?('msisdn') ? hash['msisdn'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      extended_attributes = nil
+      unless hash['extendedAttributes'].nil?
+        extended_attributes = []
+        hash['extendedAttributes'].each do |structure|
+          extended_attributes << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      extended_attributes = SKIP unless hash.key?('extendedAttributes')
+
+      # Create object from extracted values.
+      ProvisioningHistory.new(occurred_at,
+                              status,
+                              event_by,
+                              event_type,
+                              mdn,
+                              msisdn,
+                              service_plan,
+                              extended_attributes)
+    end
+  end
+end

data/lib/verizon/models/qos_device_id.rb

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

data/lib/verizon/models/qos_device_info.rb

@@ -0,0 +1,78 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # QosDeviceInfo Model.
+  class QosDeviceInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [QosDeviceId]
+    attr_accessor :device_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :device_i_pv6_addr
+
+    # TODO: Write general description for this method
+    # @return [Array[FlowInfo]]
+    attr_accessor :flow_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['device_i_pv6_addr'] = 'deviceIPv6Addr'
+      @_hash['flow_info'] = 'flowInfo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_i_pv6_addr
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   flow_info = nil,
+                   device_i_pv6_addr = SKIP)
+      @device_id = device_id
+      @device_i_pv6_addr = device_i_pv6_addr unless device_i_pv6_addr == SKIP
+      @flow_info = flow_info
+    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 = QosDeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      # Parameter is an array, so we need to iterate through it
+      flow_info = nil
+      unless hash['flowInfo'].nil?
+        flow_info = []
+        hash['flowInfo'].each do |structure|
+          flow_info << (FlowInfo.from_hash(structure) if structure)
+        end
+      end
+
+      flow_info = nil unless hash.key?('flowInfo')
+      device_i_pv6_addr =
+        hash.key?('deviceIPv6Addr') ? hash['deviceIPv6Addr'] : SKIP
+
+      # Create object from extracted values.
+      QosDeviceInfo.new(device_id,
+                        flow_info,
+                        device_i_pv6_addr)
+    end
+  end
+end

data/lib/verizon/models/query_mec_performance_metrics_request.rb

@@ -0,0 +1,57 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # MEC performance metrics request.
+  class QueryMECPerformanceMetricsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The 15-digit International Mobile Equipment Identifier.
+    # @return [String]
+    attr_accessor :imei
+
+    # The 12-digit Mobile Station International Subscriber Directory Number.
+    # @return [String]
+    attr_accessor :msisdn
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['imei'] = 'IMEI'
+      @_hash['msisdn'] = 'MSISDN'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(imei = nil,
+                   msisdn = nil)
+      @imei = imei
+      @msisdn = msisdn
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      imei = hash.key?('IMEI') ? hash['IMEI'] : nil
+      msisdn = hash.key?('MSISDN') ? hash['MSISDN'] : nil
+
+      # Create object from extracted values.
+      QueryMECPerformanceMetricsRequest.new(imei,
+                                            msisdn)
+    end
+  end
+end

data/lib/verizon/models/query_subscription_request.rb

@@ -0,0 +1,78 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Fields and values to match.
+  class QuerySubscriptionRequest < 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
+
+    # A comma-separated list of properties and comparator values to match
+    # against subscriptions in the ThingSpace account. See Working with Query
+    # Filters for more information. If the request does not include
+    # `$selection`, the response will include all subscriptions to which the
+    # requesting user has access.
+    # @return [Hash[String, String]]
+    attr_accessor :selection
+
+    # The ID of the target to delete, in the format {"id":
+    # "dd1682d3-2d80-cefc-f3ee-25154800beff"}.
+    # @return [ResourceIdentifier]
+    attr_accessor :resourceidentifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accountidentifier'] = 'accountidentifier'
+      @_hash['selection'] = '$selection'
+      @_hash['resourceidentifier'] = 'resourceidentifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accountidentifier
+        selection
+        resourceidentifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accountidentifier = SKIP,
+                   selection = SKIP,
+                   resourceidentifier = SKIP)
+      @accountidentifier = accountidentifier unless accountidentifier == SKIP
+      @selection = selection unless selection == SKIP
+      @resourceidentifier = resourceidentifier unless resourceidentifier == 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']
+      selection = hash.key?('$selection') ? hash['$selection'] : SKIP
+      resourceidentifier = ResourceIdentifier.from_hash(hash['resourceidentifier']) if
+        hash['resourceidentifier']
+
+      # Create object from extracted values.
+      QuerySubscriptionRequest.new(accountidentifier,
+                                   selection,
+                                   resourceidentifier)
+    end
+  end
+end

data/lib/verizon/models/query_target_request.rb

@@ -0,0 +1,78 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Search for targets by property values.
+  class QueryTargetRequest < 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
+
+    # A comma-separated list of properties and comparator values to match
+    # against subscriptions in the ThingSpace account. See Working with Query
+    # Filters for more information. If the request does not include
+    # `$selection`, the response will include all subscriptions to which the
+    # requesting user has access.
+    # @return [Hash[String, String]]
+    attr_accessor :selection
+
+    # The ID of the target to delete, in the format {"id":
+    # "dd1682d3-2d80-cefc-f3ee-25154800beff"}.
+    # @return [ResourceIdentifier]
+    attr_accessor :resourceidentifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accountidentifier'] = 'accountidentifier'
+      @_hash['selection'] = '$selection'
+      @_hash['resourceidentifier'] = 'resourceidentifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accountidentifier
+        selection
+        resourceidentifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accountidentifier = SKIP,
+                   selection = SKIP,
+                   resourceidentifier = SKIP)
+      @accountidentifier = accountidentifier unless accountidentifier == SKIP
+      @selection = selection unless selection == SKIP
+      @resourceidentifier = resourceidentifier unless resourceidentifier == 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']
+      selection = hash.key?('$selection') ? hash['$selection'] : SKIP
+      resourceidentifier = ResourceIdentifier.from_hash(hash['resourceidentifier']) if
+        hash['resourceidentifier']
+
+      # Create object from extracted values.
+      QueryTargetRequest.new(accountidentifier,
+                             selection,
+                             resourceidentifier)
+    end
+  end
+end

data/lib/verizon/models/ready_sim_device_id.rb

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

data/lib/verizon/models/ready_sim_service_plan.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ReadySimServicePlan Model.
+  class ReadySimServicePlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['service_plan'] = 'servicePlan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        service_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(service_plan = 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.
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+
+      # Create object from extracted values.
+      ReadySimServicePlan.new(service_plan)
+    end
+  end
+end

data/lib/verizon/models/region.rb

@@ -0,0 +1,100 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Information representing a certain geographical or logical area where MEC
+  # resources and services are provided.
+  class Region < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The unique identifier of the region.
+    # @return [String]
+    attr_accessor :region_id
+
+    # A relevant and identifiable region name.
+    # @return [String]
+    attr_accessor :name
+
+    # A two-character alpha code for a country, based on ISO 3166-1 alpha-2.
+    # This is future functionality, so the value returned is 'null'.
+    # @return [String]
+    attr_accessor :country_code
+
+    # The metropolitan area or 'City' value.  This is future functionality, so
+    # the value returned is 'null'.
+    # @return [String]
+    attr_accessor :metro
+
+    # This is a sub-set of 'City' and is similar to 'Zone'. This is future
+    # functionality, so the value returned is 'null'.
+    # @return [String]
+    attr_accessor :area
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['region_id'] = 'regionId'
+      @_hash['name'] = 'name'
+      @_hash['country_code'] = 'countryCode'
+      @_hash['metro'] = 'metro'
+      @_hash['area'] = 'area'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        region_id
+        name
+        country_code
+        metro
+        area
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        region_id
+        name
+        country_code
+        metro
+        area
+      ]
+    end
+
+    def initialize(region_id = SKIP,
+                   name = SKIP,
+                   country_code = SKIP,
+                   metro = SKIP,
+                   area = SKIP)
+      @region_id = region_id unless region_id == SKIP
+      @name = name unless name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @metro = metro unless metro == SKIP
+      @area = area unless area == 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.
+      region_id = hash.key?('regionId') ? hash['regionId'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      country_code = hash.key?('countryCode') ? hash['countryCode'] : SKIP
+      metro = hash.key?('metro') ? hash['metro'] : SKIP
+      area = hash.key?('area') ? hash['area'] : SKIP
+
+      # Create object from extracted values.
+      Region.new(region_id,
+                 name,
+                 country_code,
+                 metro,
+                 area)
+    end
+  end
+end