sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/cache_mode_enum.rb

@@ -0,0 +1,26 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Location cache mode.
+  class CacheModeEnum
+    CACHE_MODE_ENUM = [
+      # TODO: Write general description for ENUM_0
+      ENUM_0 = '0'.freeze,
+
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = '1'.freeze,
+
+      # TODO: Write general description for ENUM_2
+      ENUM_2 = '2'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CACHE_MODE_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/callback_action_result.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to a callback action.
+  class CallbackActionResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of the callback service that was registered/deregistered.
+    # @return [String]
+    attr_accessor :service_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['service_name'] = 'serviceName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        service_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   service_name = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @service_name = service_name unless service_name == 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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : SKIP
+      service_name = hash.key?('serviceName') ? hash['serviceName'] : SKIP
+
+      # Create object from extracted values.
+      CallbackActionResult.new(account_name,
+                               service_name)
+    end
+  end
+end

data/lib/verizon/models/callback_created.rb

@@ -0,0 +1,70 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # CallbackCreated Model.
+  class CallbackCreated < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The billing account number 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.
+    # @return [String]
+    attr_accessor :name
+
+    # The address of the callback listening service where the ThingSpace
+    # Platform will send callback messages for the service type.
+    # @return [String]
+    attr_accessor :url
+
+    # 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
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(aname = nil,
+                   name = nil,
+                   url = SKIP)
+      @aname = aname
+      @name = name
+      @url = url unless url == 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'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create object from extracted values.
+      CallbackCreated.new(aname,
+                          name,
+                          url)
+    end
+  end
+end

data/lib/verizon/models/callback_registered.rb

@@ -0,0 +1,58 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Registered callback listener.
+  class CallbackRegistered < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The billing account number for which callback messages will be sent.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of the callback service, which identifies the type and format of
+    # messages that will be sent to the registered URL.
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['name'] = 'name'
+      @_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,
+                   name = nil)
+      @account_name = account_name
+      @name = name
+    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
+      name = hash.key?('name') ? hash['name'] : nil
+
+      # Create object from extracted values.
+      CallbackRegistered.new(account_name,
+                             name)
+    end
+  end
+end

data/lib/verizon/models/callback_registration_request.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Specifies the callback service that is being subscribed to and the URL where
+  # the listening service is running.
+  class CallbackRegistrationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the billing account for which callback messages will be sent.
+    # Format: "##########-#####".
+    # @return [String]
+    attr_accessor :account_name
+
+    # The name of the callback service, which identifies the type and format of
+    # messages that will be sent to the registered URL.
+    # @return [String]
+    attr_accessor :service_name
+
+    # The URL for your web server.
+    # @return [String]
+    attr_accessor :endpoint
+
+    # Your HTTP headers.
+    # @return [Object]
+    attr_accessor :http_headers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['service_name'] = 'serviceName'
+      @_hash['endpoint'] = 'endpoint'
+      @_hash['http_headers'] = 'httpHeaders'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        http_headers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   service_name = nil,
+                   endpoint = nil,
+                   http_headers = SKIP)
+      @account_name = account_name
+      @service_name = service_name
+      @endpoint = endpoint
+      @http_headers = http_headers unless http_headers == 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.
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      service_name = hash.key?('serviceName') ? hash['serviceName'] : nil
+      endpoint = hash.key?('endpoint') ? hash['endpoint'] : nil
+      http_headers = hash.key?('httpHeaders') ? hash['httpHeaders'] : SKIP
+
+      # Create object from extracted values.
+      CallbackRegistrationRequest.new(account_name,
+                                      service_name,
+                                      endpoint,
+                                      http_headers)
+    end
+  end
+end

data/lib/verizon/models/callback_registration_result.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # CallbackRegistrationResult Model.
+  class CallbackRegistrationResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the account that registered the callback URL.
+    # @return [String]
+    attr_accessor :account
+
+    # The name of the callback service.
+    # @return [CallbackServiceNameEnum]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'account'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account = SKIP,
+                   name = SKIP)
+      @account = account unless account == SKIP
+      @name = name unless name == 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.
+      account = hash.key?('account') ? hash['account'] : SKIP
+      name = hash.key?('name') ? hash['name'] : SKIP
+
+      # Create object from extracted values.
+      CallbackRegistrationResult.new(account,
+                                     name)
+    end
+  end
+end

data/lib/verizon/models/callback_service_enum.rb

@@ -0,0 +1,20 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Callback type. Must be 'Fota' for Software Management Services API.
+  class CallbackServiceEnum
+    CALLBACK_SERVICE_ENUM = [
+      # TODO: Write general description for FOTA
+      FOTA = 'Fota'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CALLBACK_SERVICE_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/callback_service_name_enum.rb

@@ -0,0 +1,23 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The name of the callback service.
+  class CallbackServiceNameEnum
+    CALLBACK_SERVICE_NAME_ENUM = [
+      # TODO: Write general description for LOCATION
+      LOCATION = 'Location'.freeze,
+
+      # TODO: Write general description for DEVICELOCATION
+      DEVICELOCATION = 'DeviceLocation'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CALLBACK_SERVICE_NAME_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/callback_summary.rb

@@ -0,0 +1,50 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Registered callback information.
+  class CallbackSummary < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Callback URL for an subscribed service.
+    # @return [String]
+    attr_accessor :url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        url
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(url = SKIP)
+      @url = url unless url == 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.
+      url = hash.key?('url') ? hash['url'] : SKIP
+
+      # Create object from extracted values.
+      CallbackSummary.new(url)
+    end
+  end
+end

data/lib/verizon/models/campaign.rb

@@ -0,0 +1,174 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Firmware upgrade information.
+  class Campaign < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Upgrade identifier.
+    # @return [String]
+    attr_accessor :id
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # Campaign name.
+    # @return [String]
+    attr_accessor :campaign_name
+
+    # Name of firmware.
+    # @return [String]
+    attr_accessor :firmware_name
+
+    # Old firmware version.
+    # @return [String]
+    attr_accessor :firmware_from
+
+    # New firmware version.
+    # @return [String]
+    attr_accessor :firmware_to
+
+    # The protocol of the firmware distribution. Default: LWM2M.
+    # @return [String]
+    attr_accessor :protocol
+
+    # Applicable make.
+    # @return [String]
+    attr_accessor :make
+
+    # Applicable model.
+    # @return [String]
+    attr_accessor :model
+
+    # Campaign start date.
+    # @return [Date]
+    attr_accessor :start_date
+
+    # Campaign end date.
+    # @return [Date]
+    attr_accessor :end_date
+
+    # List of allowed campaign time windows.
+    # @return [Array[V3TimeWindow]]
+    attr_accessor :campaign_time_window_list
+
+    # Firmware upgrade status.
+    # @return [String]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['account_name'] = 'accountName'
+      @_hash['campaign_name'] = 'campaignName'
+      @_hash['firmware_name'] = 'firmwareName'
+      @_hash['firmware_from'] = 'firmwareFrom'
+      @_hash['firmware_to'] = 'firmwareTo'
+      @_hash['protocol'] = 'protocol'
+      @_hash['make'] = 'make'
+      @_hash['model'] = 'model'
+      @_hash['start_date'] = 'startDate'
+      @_hash['end_date'] = 'endDate'
+      @_hash['campaign_time_window_list'] = 'campaignTimeWindowList'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        campaign_name
+        firmware_name
+        firmware_from
+        firmware_to
+        campaign_time_window_list
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = nil,
+                   account_name = nil,
+                   protocol = 'LWM2M',
+                   make = nil,
+                   model = nil,
+                   start_date = nil,
+                   end_date = nil,
+                   status = nil,
+                   campaign_name = SKIP,
+                   firmware_name = SKIP,
+                   firmware_from = SKIP,
+                   firmware_to = SKIP,
+                   campaign_time_window_list = SKIP)
+      @id = id
+      @account_name = account_name
+      @campaign_name = campaign_name unless campaign_name == SKIP
+      @firmware_name = firmware_name unless firmware_name == SKIP
+      @firmware_from = firmware_from unless firmware_from == SKIP
+      @firmware_to = firmware_to unless firmware_to == SKIP
+      @protocol = protocol
+      @make = make
+      @model = model
+      @start_date = start_date
+      @end_date = end_date
+      unless campaign_time_window_list == SKIP
+        @campaign_time_window_list =
+          campaign_time_window_list
+      end
+      @status = status
+    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
+      account_name = hash.key?('accountName') ? hash['accountName'] : nil
+      protocol = hash['protocol'] ||= 'LWM2M'
+      make = hash.key?('make') ? hash['make'] : nil
+      model = hash.key?('model') ? hash['model'] : nil
+      start_date = hash.key?('startDate') ? hash['startDate'] : nil
+      end_date = hash.key?('endDate') ? hash['endDate'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      campaign_name = hash.key?('campaignName') ? hash['campaignName'] : SKIP
+      firmware_name = hash.key?('firmwareName') ? hash['firmwareName'] : SKIP
+      firmware_from = hash.key?('firmwareFrom') ? hash['firmwareFrom'] : SKIP
+      firmware_to = hash.key?('firmwareTo') ? hash['firmwareTo'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      campaign_time_window_list = nil
+      unless hash['campaignTimeWindowList'].nil?
+        campaign_time_window_list = []
+        hash['campaignTimeWindowList'].each do |structure|
+          campaign_time_window_list << (V3TimeWindow.from_hash(structure) if structure)
+        end
+      end
+
+      campaign_time_window_list = SKIP unless hash.key?('campaignTimeWindowList')
+
+      # Create object from extracted values.
+      Campaign.new(id,
+                   account_name,
+                   protocol,
+                   make,
+                   model,
+                   start_date,
+                   end_date,
+                   status,
+                   campaign_name,
+                   firmware_name,
+                   firmware_from,
+                   firmware_to,
+                   campaign_time_window_list)
+    end
+  end
+end