sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/register_callback_request.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to register a callback.
+  class RegisterCallbackRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the callback service that you want to subscribe to.
+    # @return [String]
+    attr_accessor :name
+
+    # The address on your server where you have enabled a listening service for
+    # callback messages.
+    # @return [String]
+    attr_accessor :url
+
+    # The user name that the M2M Platform should return in the callback
+    # messages.
+    # @return [String]
+    attr_accessor :username
+
+    # The password that the M2M Platform should return in the callback messages.
+    # @return [String]
+    attr_accessor :password
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['url'] = 'url'
+      @_hash['username'] = 'username'
+      @_hash['password'] = 'password'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        username
+        password
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil,
+                   url = nil,
+                   username = SKIP,
+                   password = SKIP)
+      @name = name
+      @url = url
+      @username = username unless username == SKIP
+      @password = password unless password == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      url = hash.key?('url') ? hash['url'] : nil
+      username = hash.key?('username') ? hash['username'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+
+      # Create object from extracted values.
+      RegisterCallbackRequest.new(name,
+                                  url,
+                                  username,
+                                  password)
+    end
+  end
+end

data/lib/verizon/models/register_service_endpoint_result.rb

@@ -0,0 +1,53 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to register Service Endpoints of a deployed application to
+  # specified Muli-access Edge Compute (MEC) Platforms.
+  class RegisterServiceEndpointResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A system-defined string identifier representing one or more registered
+    # Service Endpoints.
+    # @return [String]
+    attr_accessor :service_endpoints_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['service_endpoints_id'] = 'serviceEndpointsId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        service_endpoints_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(service_endpoints_id = SKIP)
+      @service_endpoints_id = service_endpoints_id unless service_endpoints_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.
+      service_endpoints_id =
+        hash.key?('serviceEndpointsId') ? hash['serviceEndpointsId'] : SKIP
+
+      # Create object from extracted values.
+      RegisterServiceEndpointResult.new(service_endpoints_id)
+    end
+  end
+end

data/lib/verizon/models/registered_callbacks.rb

@@ -0,0 +1,92 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # List of registered callback endpoints.
+  class RegisteredCallbacks < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the billing account for which callback messages will be sent.
+    # @return [String]
+    attr_accessor :aname
+
+    # The name of the callback service, which identifies the type and format of
+    # messages that will be sent to the registered URL. This will be 'Fota' for
+    # the Software Management Services callback.
+    # @return [String]
+    attr_accessor :name
+
+    # The address to which callback messages will be sent.
+    # @return [String]
+    attr_accessor :url
+
+    # The user name that ThingSpace will return in the callback messages.
+    # @return [String]
+    attr_accessor :username
+
+    # The password that ThingSpace will return in the callback messages.
+    # @return [String]
+    attr_accessor :password
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['aname'] = 'aname'
+      @_hash['name'] = 'name'
+      @_hash['url'] = 'url'
+      @_hash['username'] = 'username'
+      @_hash['password'] = 'password'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        aname
+        name
+        url
+        username
+        password
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(aname = SKIP,
+                   name = SKIP,
+                   url = SKIP,
+                   username = SKIP,
+                   password = SKIP)
+      @aname = aname unless aname == SKIP
+      @name = name unless name == SKIP
+      @url = url unless url == SKIP
+      @username = username unless username == SKIP
+      @password = password unless password == 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.
+      aname = hash.key?('aname') ? hash['aname'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+      url = hash.key?('url') ? hash['url'] : SKIP
+      username = hash.key?('username') ? hash['username'] : SKIP
+      password = hash.key?('password') ? hash['password'] : SKIP
+
+      # Create object from extracted values.
+      RegisteredCallbacks.new(aname,
+                              name,
+                              url,
+                              username,
+                              password)
+    end
+  end
+end

data/lib/verizon/models/remove_device_request.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The request body identifies the device to delete.
+  class RemoveDeviceRequest < 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
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(accountidentifier = nil,
+                   resourceidentifier = nil)
+      @accountidentifier = accountidentifier
+      @resourceidentifier = resourceidentifier
+    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.
+      RemoveDeviceRequest.new(accountidentifier,
+                              resourceidentifier)
+    end
+  end
+end

data/lib/verizon/models/report_status_enum.rb

@@ -0,0 +1,26 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Status of the report.
+  class ReportStatusEnum
+    REPORT_STATUS_ENUM = [
+      # TODO: Write general description for QUEUED
+      QUEUED = 'QUEUED'.freeze,
+
+      # TODO: Write general description for INPROGRESS
+      INPROGRESS = 'INPROGRESS'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'COMPLETED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REPORT_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/request_body_for_usage.rb

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

data/lib/verizon/models/request_response.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # RequestResponse Model.
+  class RequestResponse < 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.
+      RequestResponse.new(request_id)
+    end
+  end
+end

data/lib/verizon/models/request_status_enum.rb

@@ -0,0 +1,26 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The current status of the callback response.
+  class RequestStatusEnum
+    REQUEST_STATUS_ENUM = [
+      # TODO: Write general description for PENDING
+      PENDING = 'Pending'.freeze,
+
+      # TODO: Write general description for SUCCESS
+      SUCCESS = 'Success'.freeze,
+
+      # TODO: Write general description for FAILURE
+      FAILURE = 'Failure'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REQUEST_STATUS_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/request_trigger.rb

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

data/lib/verizon/models/resource_identifier.rb

@@ -0,0 +1,61 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The ID of the target to delete, in the format {"id":
+  # "dd1682d3-2d80-cefc-f3ee-25154800beff"}.
+  class ResourceIdentifier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Target ID.
+    # @return [String]
+    attr_accessor :id
+
+    # Device IMEI.
+    # @return [String]
+    attr_accessor :imei
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['imei'] = 'imei'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        imei
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   imei = SKIP)
+      @id = id unless id == SKIP
+      @imei = imei unless imei == 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
+      imei = hash.key?('imei') ? hash['imei'] : SKIP
+
+      # Create object from extracted values.
+      ResourceIdentifier.new(id,
+                             imei)
+    end
+  end
+end