sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/delete_devices_result.rb

@@ -0,0 +1,73 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response for a request made to delete a device.
+  class DeleteDevicesResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # One object per device to be deleted. Each object must contain a kind and
+    # id element identifying the device.
+    # @return [Object]
+    attr_accessor :device_ids
+
+    # “Success” if the device was deleted, or “Failed” if there was a problem.
+    # @return [String]
+    attr_accessor :status
+
+    # Not present if status=Success. One of these messages if status=Failed:The
+    # device is not in deactivate state.The user does not have access to delete
+    # the device.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['status'] = 'status'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+        status
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = SKIP,
+                   status = SKIP,
+                   message = SKIP)
+      @device_ids = device_ids unless device_ids == SKIP
+      @status = status unless status == SKIP
+      @message = message unless message == 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.
+      device_ids = hash.key?('deviceIds') ? hash['deviceIds'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+
+      # Create object from extracted values.
+      DeleteDevicesResult.new(device_ids,
+                              status,
+                              message)
+    end
+  end
+end

data/lib/verizon/models/delete_service_profile_result.rb

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

data/lib/verizon/models/delete_subscription_request.rb

@@ -0,0 +1,64 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The subscription to delete.
+  class DeleteSubscriptionRequest < 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accountidentifier'] = 'accountidentifier'
+      @_hash['resourceidentifier'] = 'resourceidentifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accountidentifier
+        resourceidentifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accountidentifier = SKIP,
+                   resourceidentifier = SKIP)
+      @accountidentifier = accountidentifier unless accountidentifier == 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']
+      resourceidentifier = ResourceIdentifier.from_hash(hash['resourceidentifier']) if
+        hash['resourceidentifier']
+
+      # Create object from extracted values.
+      DeleteSubscriptionRequest.new(accountidentifier,
+                                    resourceidentifier)
+    end
+  end
+end

data/lib/verizon/models/delete_target_request.rb

@@ -0,0 +1,64 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Target to delete.
+  class DeleteTargetRequest < 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['accountidentifier'] = 'accountidentifier'
+      @_hash['resourceidentifier'] = 'resourceidentifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        accountidentifier
+        resourceidentifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accountidentifier = SKIP,
+                   resourceidentifier = SKIP)
+      @accountidentifier = accountidentifier unless accountidentifier == 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']
+      resourceidentifier = ResourceIdentifier.from_hash(hash['resourceidentifier']) if
+        hash['resourceidentifier']
+
+      # Create object from extracted values.
+      DeleteTargetRequest.new(accountidentifier,
+                              resourceidentifier)
+    end
+  end
+end

data/lib/verizon/models/deregister_service_endpoint_result.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to deregister an application's Service Endpoint from one or more
+  # Multi-access Edge Compute (MEC) Platforms.
+  class DeregisterServiceEndpointResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # HTTP status code.
+    # @return [String]
+    attr_accessor :status
+
+    # EdgeAppServicesID that are deleted or error details in case of an error.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status = SKIP,
+                   message = SKIP)
+      @status = status unless status == SKIP
+      @message = message unless message == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+
+      # Create object from extracted values.
+      DeregisterServiceEndpointResult.new(status,
+                                          message)
+    end
+  end
+end

data/lib/verizon/models/device.rb

@@ -0,0 +1,57 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Identifies a particular IoT device.
+  class Device < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Device identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # Device kind identifier.
+    # @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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   kind = nil)
+      @id = id
+      @kind = kind
+    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'] : nil
+      kind = hash.key?('kind') ? hash['kind'] : nil
+
+      # Create object from extracted values.
+      Device.new(id,
+                 kind)
+    end
+  end
+end

data/lib/verizon/models/device_activation_request.rb

@@ -0,0 +1,67 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request for device status to check availability of activation.
+  class DeviceActivationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Up to 10,000 devices that you want to move to a different account,
+    # specified by device identifier.
+    # @return [Array[AccountDeviceList]]
+    attr_accessor :devices
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   devices = nil)
+      @account_name = account_name
+      @devices = devices
+    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')
+
+      # Create object from extracted values.
+      DeviceActivationRequest.new(account_name,
+                                  devices)
+    end
+  end
+end

data/lib/verizon/models/device_aggregate_usage_list_request.rb

@@ -0,0 +1,121 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to list device aggregate usage.
+  class DeviceAggregateUsageListRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The beginning of the reporting period. The startTime cannot be more than 6
+    # months before the current date.
+    # @return [String]
+    attr_accessor :start_time
+
+    # The end of the reporting period. The endTime date must be within on month
+    # of the startTime date.
+    # @return [String]
+    attr_accessor :end_time
+
+    # One or more devices for which you want aggregate data, specified by device
+    # ID.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of a device group, if you want to only include devices in that
+    # group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The name of a device group, if you want to only include devices in that
+    # group.
+    # @return [Array[Label]]
+    attr_accessor :label
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_time'] = 'startTime'
+      @_hash['end_time'] = 'endTime'
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['account_name'] = 'accountName'
+      @_hash['group_name'] = 'groupName'
+      @_hash['label'] = 'label'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+        account_name
+        group_name
+        label
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_time = nil,
+                   end_time = nil,
+                   device_ids = SKIP,
+                   account_name = SKIP,
+                   group_name = SKIP,
+                   label = SKIP)
+      @start_time = start_time
+      @end_time = end_time
+      @device_ids = device_ids unless device_ids == SKIP
+      @account_name = account_name unless account_name == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @label = label unless label == 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.
+      start_time = hash.key?('startTime') ? hash['startTime'] : nil
+      end_time = hash.key?('endTime') ? hash['endTime'] : nil
+      # 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 << (DeviceId.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = SKIP unless hash.key?('deviceIds')
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      label = nil
+      unless hash['label'].nil?
+        label = []
+        hash['label'].each do |structure|
+          label << (Label.from_hash(structure) if structure)
+        end
+      end
+
+      label = SKIP unless hash.key?('label')
+
+      # Create object from extracted values.
+      DeviceAggregateUsageListRequest.new(start_time,
+                                          end_time,
+                                          device_ids,
+                                          account_name,
+                                          group_name,
+                                          label)
+    end
+  end
+end

data/lib/verizon/models/device_connection_list_request.rb

@@ -0,0 +1,67 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to list of network connection events for a device during a specified
+  # time period.
+  class DeviceConnectionListRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An identifier for a single device.
+    # @return [DeviceId]
+    attr_accessor :device_id
+
+    # The earliest date and time for which you want connection events.
+    # @return [String]
+    attr_accessor :earliest
+
+    # The last date and time for which you want connection events.
+    # @return [String]
+    attr_accessor :latest
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_id'] = 'deviceId'
+      @_hash['earliest'] = 'earliest'
+      @_hash['latest'] = 'latest'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   earliest = nil,
+                   latest = nil)
+      @device_id = device_id
+      @earliest = earliest
+      @latest = latest
+    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 = DeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      earliest = hash.key?('earliest') ? hash['earliest'] : nil
+      latest = hash.key?('latest') ? hash['latest'] : nil
+
+      # Create object from extracted values.
+      DeviceConnectionListRequest.new(device_id,
+                                      earliest,
+                                      latest)
+    end
+  end
+end