sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/models/billable_usage_report.rb

@@ -0,0 +1,121 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Bill usage report.
+  class BillableUsageReport < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Account identifier.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The usage is for a single or multiple accounts.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :usage_for_all_accounts
+
+    # SKU Name of the service subscription.
+    # @return [String]
+    attr_accessor :sku_name
+
+    # The number of location requests included with the subscription type.
+    # @return [String]
+    attr_accessor :transactions_allowed
+
+    # The total number of billable device location requests during the reporting
+    # period from all included accounts.
+    # @return [String]
+    attr_accessor :total_transaction_count
+
+    # The total number of billable device location requests during the reporting
+    # period from all included accounts.
+    # @return [ServiceUsage]
+    attr_accessor :primary_account
+
+    # Zero or more managed accounts.
+    # @return [Array[ServiceUsage]]
+    attr_accessor :managed_accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['usage_for_all_accounts'] = 'usageForAllAccounts'
+      @_hash['sku_name'] = 'skuName'
+      @_hash['transactions_allowed'] = 'transactionsAllowed'
+      @_hash['total_transaction_count'] = 'totalTransactionCount'
+      @_hash['primary_account'] = 'PrimaryAccount'
+      @_hash['managed_accounts'] = 'ManagedAccounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        usage_for_all_accounts
+        sku_name
+        transactions_allowed
+        total_transaction_count
+        primary_account
+        managed_accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP, usage_for_all_accounts = SKIP,
+                   sku_name = SKIP, transactions_allowed = SKIP,
+                   total_transaction_count = SKIP, primary_account = SKIP,
+                   managed_accounts = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @usage_for_all_accounts = usage_for_all_accounts unless usage_for_all_accounts == SKIP
+      @sku_name = sku_name unless sku_name == SKIP
+      @transactions_allowed = transactions_allowed unless transactions_allowed == SKIP
+      @total_transaction_count = total_transaction_count unless total_transaction_count == SKIP
+      @primary_account = primary_account unless primary_account == SKIP
+      @managed_accounts = managed_accounts unless managed_accounts == 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
+      usage_for_all_accounts =
+        hash.key?('usageForAllAccounts') ? hash['usageForAllAccounts'] : SKIP
+      sku_name = hash.key?('skuName') ? hash['skuName'] : SKIP
+      transactions_allowed =
+        hash.key?('transactionsAllowed') ? hash['transactionsAllowed'] : SKIP
+      total_transaction_count =
+        hash.key?('totalTransactionCount') ? hash['totalTransactionCount'] : SKIP
+      primary_account = ServiceUsage.from_hash(hash['PrimaryAccount']) if hash['PrimaryAccount']
+      # Parameter is an array, so we need to iterate through it
+      managed_accounts = nil
+      unless hash['ManagedAccounts'].nil?
+        managed_accounts = []
+        hash['ManagedAccounts'].each do |structure|
+          managed_accounts << (ServiceUsage.from_hash(structure) if structure)
+        end
+      end
+
+      managed_accounts = SKIP unless hash.key?('ManagedAccounts')
+
+      # Create object from extracted values.
+      BillableUsageReport.new(account_name,
+                              usage_for_all_accounts,
+                              sku_name,
+                              transactions_allowed,
+                              total_transaction_count,
+                              primary_account,
+                              managed_accounts)
+    end
+  end
+end

data/lib/verizon/models/billedusage_list_request.rb

@@ -0,0 +1,87 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Information required to associate a usage segmentation label with a device
+  # to retrieve billing.
+  class BilledusageListRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :account_name
+
+    # TODO: Write general description for this method
+    # @return [LabelsList]
+    attr_accessor :labels
+
+    # TODO: Write general description for this method
+    # @return [Array[DeviceList]]
+    attr_accessor :device_ids
+
+    # TODO: Write general description for this method
+    # @return [BillingCycle]
+    attr_accessor :billing_cycle
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['labels'] = 'labels'
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['billing_cycle'] = 'billingCycle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        labels
+        device_ids
+        billing_cycle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil, labels = SKIP, device_ids = SKIP,
+                   billing_cycle = SKIP)
+      @account_name = account_name
+      @labels = labels unless labels == SKIP
+      @device_ids = device_ids unless device_ids == SKIP
+      @billing_cycle = billing_cycle unless billing_cycle == 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
+      labels = LabelsList.from_hash(hash['labels']) if hash['labels']
+      # 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 << (DeviceList.from_hash(structure) if structure)
+        end
+      end
+
+      device_ids = SKIP unless hash.key?('deviceIds')
+      billing_cycle = BillingCycle.from_hash(hash['billingCycle']) if hash['billingCycle']
+
+      # Create object from extracted values.
+      BilledusageListRequest.new(account_name,
+                                 labels,
+                                 device_ids,
+                                 billing_cycle)
+    end
+  end
+end

data/lib/verizon/models/billing_cycle.rb

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

data/lib/verizon/models/bullseye_service_request.rb

@@ -0,0 +1,65 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Account number and list of devices.
+  class BullseyeServiceRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of devices.
+    # @return [Array[DeviceServiceRequest]]
+    attr_accessor :device_list
+
+    # A unique identifier for an account.
+    # @return [String]
+    attr_accessor :account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_list'] = 'deviceList'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_list = nil, account_number = nil)
+      @device_list = device_list
+      @account_number = account_number
+    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_list = nil
+      unless hash['deviceList'].nil?
+        device_list = []
+        hash['deviceList'].each do |structure|
+          device_list << (DeviceServiceRequest.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = nil unless hash.key?('deviceList')
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : nil
+
+      # Create object from extracted values.
+      BullseyeServiceRequest.new(device_list,
+                                 account_number)
+    end
+  end
+end

data/lib/verizon/models/bullseye_service_result.rb

@@ -0,0 +1,79 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Status of Hyper Precise Location on the device.
+  class BullseyeServiceResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account the device belongs to.
+    # @return [String]
+    attr_accessor :account_number
+
+    # List of devices.
+    # @return [Array[DeviceServiceInformation]]
+    attr_accessor :device_list
+
+    # ResponseCode and/or a message indicating success or failure of the
+    # request.
+    # @return [ApiResponseCode]
+    attr_accessor :response_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['device_list'] = 'deviceList'
+      @_hash['response_type'] = 'responseType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_number
+        device_list
+        response_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_number = SKIP, device_list = SKIP,
+                   response_type = SKIP)
+      @account_number = account_number unless account_number == SKIP
+      @device_list = device_list unless device_list == SKIP
+      @response_type = response_type unless response_type == 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_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      device_list = nil
+      unless hash['deviceList'].nil?
+        device_list = []
+        hash['deviceList'].each do |structure|
+          device_list << (DeviceServiceInformation.from_hash(structure) if structure)
+        end
+      end
+
+      device_list = SKIP unless hash.key?('deviceList')
+      response_type = ApiResponseCode.from_hash(hash['responseType']) if hash['responseType']
+
+      # Create object from extracted values.
+      BullseyeServiceResult.new(account_number,
+                                device_list,
+                                response_type)
+    end
+  end
+end

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,59 @@
+# 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,68 @@
+# 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,57 @@
+# 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,78 @@
+# 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