specs-sdk 1.3.0

data/lib/verizon/models/search_device_by_property_response.rb

@@ -0,0 +1,192 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The device identifier and fields to match in the search.
+  class SearchDeviceByPropertyResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Billing account ID of the resource.
+    # @return [String]
+    attr_accessor :billingaccountid
+
+    # The date the resource was created.
+    # @return [String]
+    attr_accessor :createdon
+
+    # The date the resource was created.
+    # @return [String]
+    attr_accessor :eventretention
+
+    # The date the resource was created.
+    # @return [Fields1]
+    attr_accessor :fields
+
+    # Cellular SIM card identifier.
+    # @return [String]
+    attr_accessor :iccid
+
+    # ThingSpace unique ID for the device that was added.
+    # @return [String]
+    attr_accessor :id
+
+    # 4G hardware device identifier.
+    # @return [String]
+    attr_accessor :imei
+
+    # Identifies the resource kind.
+    # @return [String]
+    attr_accessor :kind
+
+    # The date the resource was last updated.
+    # @return [String]
+    attr_accessor :lastupdated
+
+    # The device’s service provider.
+    # @return [String]
+    attr_accessor :providerid
+
+    # The value of the refidtype identifier.
+    # @return [String]
+    attr_accessor :refid
+
+    # The device identifier type used to refer to this device.
+    # @return [String]
+    attr_accessor :refidtype
+
+    # Service state of the device.
+    # @return [String]
+    attr_accessor :state
+
+    # Version of the underlying schema resource.
+    # @return [String]
+    attr_accessor :version
+
+    # The version of the resource.
+    # @return [String]
+    attr_accessor :versionid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['billingaccountid'] = 'billingaccountid'
+      @_hash['createdon'] = 'createdon'
+      @_hash['eventretention'] = 'eventretention'
+      @_hash['fields'] = 'fields'
+      @_hash['iccid'] = 'iccid'
+      @_hash['id'] = 'id'
+      @_hash['imei'] = 'imei'
+      @_hash['kind'] = 'kind'
+      @_hash['lastupdated'] = 'lastupdated'
+      @_hash['providerid'] = 'providerid'
+      @_hash['refid'] = 'refid'
+      @_hash['refidtype'] = 'refidtype'
+      @_hash['state'] = 'state'
+      @_hash['version'] = 'version'
+      @_hash['versionid'] = 'versionid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        billingaccountid
+        createdon
+        eventretention
+        fields
+        iccid
+        id
+        imei
+        kind
+        lastupdated
+        providerid
+        refid
+        refidtype
+        state
+        version
+        versionid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(billingaccountid = SKIP,
+                   createdon = SKIP,
+                   eventretention = SKIP,
+                   fields = SKIP,
+                   iccid = SKIP,
+                   id = SKIP,
+                   imei = SKIP,
+                   kind = SKIP,
+                   lastupdated = SKIP,
+                   providerid = SKIP,
+                   refid = SKIP,
+                   refidtype = SKIP,
+                   state = SKIP,
+                   version = SKIP,
+                   versionid = SKIP)
+      @billingaccountid = billingaccountid unless billingaccountid == SKIP
+      @createdon = createdon unless createdon == SKIP
+      @eventretention = eventretention unless eventretention == SKIP
+      @fields = fields unless fields == SKIP
+      @iccid = iccid unless iccid == SKIP
+      @id = id unless id == SKIP
+      @imei = imei unless imei == SKIP
+      @kind = kind unless kind == SKIP
+      @lastupdated = lastupdated unless lastupdated == SKIP
+      @providerid = providerid unless providerid == SKIP
+      @refid = refid unless refid == SKIP
+      @refidtype = refidtype unless refidtype == SKIP
+      @state = state unless state == SKIP
+      @version = version unless version == SKIP
+      @versionid = versionid unless versionid == 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.
+      billingaccountid =
+        hash.key?('billingaccountid') ? hash['billingaccountid'] : SKIP
+      createdon = hash.key?('createdon') ? hash['createdon'] : SKIP
+      eventretention =
+        hash.key?('eventretention') ? hash['eventretention'] : SKIP
+      fields = Fields1.from_hash(hash['fields']) if hash['fields']
+      iccid = hash.key?('iccid') ? hash['iccid'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      imei = hash.key?('imei') ? hash['imei'] : SKIP
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+      lastupdated = hash.key?('lastupdated') ? hash['lastupdated'] : SKIP
+      providerid = hash.key?('providerid') ? hash['providerid'] : SKIP
+      refid = hash.key?('refid') ? hash['refid'] : SKIP
+      refidtype = hash.key?('refidtype') ? hash['refidtype'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      version = hash.key?('version') ? hash['version'] : SKIP
+      versionid = hash.key?('versionid') ? hash['versionid'] : SKIP
+
+      # Create object from extracted values.
+      SearchDeviceByPropertyResponse.new(billingaccountid,
+                                         createdon,
+                                         eventretention,
+                                         fields,
+                                         iccid,
+                                         id,
+                                         imei,
+                                         kind,
+                                         lastupdated,
+                                         providerid,
+                                         refid,
+                                         refidtype,
+                                         state,
+                                         version,
+                                         versionid)
+    end
+  end
+end

data/lib/verizon/models/search_device_by_property_response_list.rb

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

data/lib/verizon/models/search_device_event_history_request.rb

@@ -0,0 +1,96 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Search Device By Property resource definition.
+  class SearchDeviceEventHistoryRequest < 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
+
+    # The maximum number of events to include in the response.
+    # @return [Integer]
+    attr_accessor :limitnumber
+
+    # The maximum number of events to include in the response.
+    # @return [String]
+    attr_accessor :page
+
+    # 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['limitnumber'] = '$limitnumber'
+      @_hash['page'] = '$page'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        selection
+        limitnumber
+        page
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accountidentifier = nil,
+                   resourceidentifier = nil,
+                   selection = SKIP,
+                   limitnumber = SKIP,
+                   page = SKIP)
+      @accountidentifier = accountidentifier
+      @selection = selection unless selection == SKIP
+      @resourceidentifier = resourceidentifier
+      @limitnumber = limitnumber unless limitnumber == SKIP
+      @page = page unless page == 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']
+      selection = hash.key?('$selection') ? hash['$selection'] : SKIP
+      limitnumber = hash.key?('$limitnumber') ? hash['$limitnumber'] : SKIP
+      page = hash.key?('$page') ? hash['$page'] : SKIP
+
+      # Create object from extracted values.
+      SearchDeviceEventHistoryRequest.new(accountidentifier,
+                                          resourceidentifier,
+                                          selection,
+                                          limitnumber,
+                                          page)
+    end
+  end
+end

data/lib/verizon/models/search_device_event_history_response_list.rb

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

data/lib/verizon/models/search_device_response.rb

@@ -0,0 +1,173 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A success response includes an array of all matching events. Each event
+  # includes the full event resource definition.
+  class SearchDeviceResponse < 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 [Fields2]
+    attr_accessor :fields
+
+    # The unique ID of this ts.event.configuration event.
+    # @return [String]
+    attr_accessor :id
+
+    # The kind of the ThingSpace resource that is being reported;
+    # “ts.event.configuration” for device configuration changes.
+    # @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
+    # @return [String]
+    attr_accessor :name
+
+    # The current status of the request.
+    # @return [String]
+    attr_accessor :state
+
+    # UUIDs of tag resources that are applied to this device.
+    # @return [Array[String]]
+    attr_accessor :tagids
+
+    # transaction id
+    # @return [String]
+    attr_accessor :transactionid
+
+    # The version of the resource.
+    # @return [String]
+    attr_accessor :version
+
+    # The version of the resource.
+    # @return [String]
+    attr_accessor :versionid
+
+    # 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['id'] = 'id'
+      @_hash['kind'] = 'kind'
+      @_hash['lastupdated'] = 'lastupdated'
+      @_hash['name'] = 'name'
+      @_hash['state'] = 'state'
+      @_hash['tagids'] = 'tagids'
+      @_hash['transactionid'] = 'transactionid'
+      @_hash['version'] = 'version'
+      @_hash['versionid'] = 'versionid'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        action
+        createdon
+        deviceid
+        fields
+        id
+        kind
+        lastupdated
+        name
+        state
+        tagids
+        transactionid
+        version
+        versionid
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(action = SKIP,
+                   createdon = SKIP,
+                   deviceid = SKIP,
+                   fields = SKIP,
+                   id = SKIP,
+                   kind = SKIP,
+                   lastupdated = SKIP,
+                   name = SKIP,
+                   state = SKIP,
+                   tagids = SKIP,
+                   transactionid = SKIP,
+                   version = SKIP,
+                   versionid = SKIP)
+      @action = action unless action == SKIP
+      @createdon = createdon unless createdon == SKIP
+      @deviceid = deviceid unless deviceid == SKIP
+      @fields = fields unless fields == 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
+      @tagids = tagids unless tagids == SKIP
+      @transactionid = transactionid unless transactionid == SKIP
+      @version = version unless version == SKIP
+      @versionid = versionid unless versionid == 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 = Fields2.from_hash(hash['fields']) if hash['fields']
+      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
+      tagids = hash.key?('tagids') ? hash['tagids'] : SKIP
+      transactionid = hash.key?('transactionid') ? hash['transactionid'] : SKIP
+      version = hash.key?('version') ? hash['version'] : SKIP
+      versionid = hash.key?('versionid') ? hash['versionid'] : SKIP
+
+      # Create object from extracted values.
+      SearchDeviceResponse.new(action,
+                               createdon,
+                               deviceid,
+                               fields,
+                               id,
+                               kind,
+                               lastupdated,
+                               name,
+                               state,
+                               tagids,
+                               transactionid,
+                               version,
+                               versionid)
+    end
+  end
+end

data/lib/verizon/models/search_sensor_history_request.rb

@@ -0,0 +1,82 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Search Device By Property resource definition.
+  class SearchSensorHistoryRequest < 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
+
+    # The maximum number of events to include in the response.
+    # @return [Integer]
+    attr_accessor :limitnumber
+
+    # The maximum number of events to include in the response.
+    # @return [String]
+    attr_accessor :page
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accountidentifier'] = 'accountidentifier'
+      @_hash['resourceidentifier'] = 'resourceidentifier'
+      @_hash['limitnumber'] = '$limitnumber'
+      @_hash['page'] = '$page'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        limitnumber
+        page
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accountidentifier = nil,
+                   resourceidentifier = nil,
+                   limitnumber = SKIP,
+                   page = SKIP)
+      @accountidentifier = accountidentifier
+      @resourceidentifier = resourceidentifier
+      @limitnumber = limitnumber unless limitnumber == SKIP
+      @page = page unless page == 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']
+      limitnumber = hash.key?('$limitnumber') ? hash['$limitnumber'] : SKIP
+      page = hash.key?('$page') ? hash['$page'] : SKIP
+
+      # Create object from extracted values.
+      SearchSensorHistoryRequest.new(accountidentifier,
+                                     resourceidentifier,
+                                     limitnumber,
+                                     page)
+    end
+  end
+end