sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/http/auth/oauth_2.rb

@@ -0,0 +1,98 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Utility class for OAuth 2 authorization and token management.
+  class OAuth2 < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'ClientCredentialsAuth: OAuthToken is undefined or expired.'
+    end
+
+    # Initialization constructor.
+    def initialize(client_credentials_auth_credentials, config)
+      auth_params = {}
+      @_oauth_client_id = client_credentials_auth_credentials.oauth_client_id unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.oauth_client_id.nil?
+      @_oauth_client_secret = client_credentials_auth_credentials.oauth_client_secret unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.oauth_client_secret.nil?
+      @_oauth_token = client_credentials_auth_credentials.oauth_token unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.oauth_token.nil?
+      @_oauth_scopes = client_credentials_auth_credentials.oauth_scopes unless
+        client_credentials_auth_credentials.nil? || client_credentials_auth_credentials.oauth_scopes.nil?
+      @_o_auth_api = OauthAuthorizationController.new(config)
+      auth_params['Authorization'] = "Bearer #{@_oauth_token.access_token}" unless @_oauth_token.nil?
+
+      super auth_params
+    end
+
+    # Validates the oAuth token.
+    # @return [Boolean] true if the token is present and not expired.
+    def valid
+      !@_oauth_token.nil? && !token_expired?(@_oauth_token)
+    end
+
+    # Builds the basic auth header for endpoints in the OAuth Authorization Controller.
+    # @return [String] The value of the Authentication header.
+    def build_basic_auth_header
+      "Basic #{AuthHelper.get_base64_encoded_value(@_oauth_client_id, @_oauth_client_secret)}"
+    end
+
+    # Fetches the token.
+    # @param [Hash] additional_params Any additional form parameters.
+    # @return [OAuthToken] The oAuth token instance.
+    def fetch_token(additional_params: nil)
+      token = @_o_auth_api.request_token(
+        build_basic_auth_header,
+        scope: !@_oauth_scopes.nil? ? Array(@_oauth_scopes).compact.join(' ') : @_oauth_scopes,
+        _field_parameters: additional_params
+      ).data
+      if token.respond_to?('expires_in') && !token.expires_in.nil?
+        token.expiry = AuthHelper.get_token_expiry(token.expires_in, Time.now.utc.to_i)
+      end
+      token
+    end
+
+    # Checks if OAuth token has expired.
+    # @param [OAuthToken] token The oAuth token instance.
+    # @return [Boolean] true if the token's expiry exist and also the token is expired, false otherwise.
+    def token_expired?(token)
+      token.respond_to?('expiry') && AuthHelper.token_expired?(token.expiry)
+    end
+  end
+
+  # Data class for ClientCredentialsAuthCredentials.
+  class ClientCredentialsAuthCredentials
+    attr_reader :oauth_client_id, :oauth_client_secret, :oauth_token,
+                :oauth_scopes
+
+    def initialize(oauth_client_id:, oauth_client_secret:, oauth_token: nil,
+                   oauth_scopes: nil)
+      raise ArgumentError, 'oauth_client_id cannot be nil' if oauth_client_id.nil?
+      raise ArgumentError, 'oauth_client_secret cannot be nil' if oauth_client_secret.nil?
+
+      @oauth_client_id = oauth_client_id
+      @oauth_client_secret = oauth_client_secret
+      @oauth_token = oauth_token
+      @oauth_scopes = oauth_scopes
+    end
+
+    def clone_with(oauth_client_id: nil, oauth_client_secret: nil,
+                   oauth_token: nil, oauth_scopes: nil)
+      oauth_client_id ||= self.oauth_client_id
+      oauth_client_secret ||= self.oauth_client_secret
+      oauth_token ||= self.oauth_token
+      oauth_scopes ||= self.oauth_scopes
+
+      ClientCredentialsAuthCredentials.new(
+        oauth_client_id: oauth_client_id,
+        oauth_client_secret: oauth_client_secret, oauth_token: oauth_token,
+        oauth_scopes: oauth_scopes
+      )
+    end
+  end
+end

data/lib/verizon/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/verizon/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/verizon/http/http_request.rb

@@ -0,0 +1,10 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/verizon/http/http_response.rb

@@ -0,0 +1,10 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/verizon/models/acceleration.rb

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

data/lib/verizon/models/account.rb

@@ -0,0 +1,142 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Returns information about a specified account.
+  class Account < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The billing number of the account.
+    # @return [String]
+    attr_accessor :account_number
+
+    # The name of the organization that the account is part of.
+    # @return [String]
+    attr_accessor :organization_name
+
+    # True if devices can be added to the account and activated with a single
+    # request. False if devices must be added to the account before they can be
+    # activated.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_provisioning_allowed
+
+    # The names of all carriers for the account.
+    # @return [Array[String]]
+    attr_accessor :carriers
+
+    # The names of features that are enabled for the account.
+    # @return [Array[String]]
+    attr_accessor :features
+
+    # Array of IP pools that are available to the account.
+    # @return [Array[IPPool]]
+    attr_accessor :i_p_pools
+
+    # Array of service plans that are available to the account.
+    # @return [Array[ServicePlan]]
+    attr_accessor :service_plans
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['organization_name'] = 'organizationName'
+      @_hash['is_provisioning_allowed'] = 'isProvisioningAllowed'
+      @_hash['carriers'] = 'carriers'
+      @_hash['features'] = 'features'
+      @_hash['i_p_pools'] = 'iPPools'
+      @_hash['service_plans'] = 'servicePlans'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        account_number
+        organization_name
+        is_provisioning_allowed
+        carriers
+        features
+        i_p_pools
+        service_plans
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   account_number = SKIP,
+                   organization_name = SKIP,
+                   is_provisioning_allowed = SKIP,
+                   carriers = SKIP,
+                   features = SKIP,
+                   i_p_pools = SKIP,
+                   service_plans = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @organization_name = organization_name unless organization_name == SKIP
+      @is_provisioning_allowed = is_provisioning_allowed unless is_provisioning_allowed == SKIP
+      @carriers = carriers unless carriers == SKIP
+      @features = features unless features == SKIP
+      @i_p_pools = i_p_pools unless i_p_pools == SKIP
+      @service_plans = service_plans unless service_plans == 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
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      organization_name =
+        hash.key?('organizationName') ? hash['organizationName'] : SKIP
+      is_provisioning_allowed =
+        hash.key?('isProvisioningAllowed') ? hash['isProvisioningAllowed'] : SKIP
+      carriers = hash.key?('carriers') ? hash['carriers'] : SKIP
+      features = hash.key?('features') ? hash['features'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      i_p_pools = nil
+      unless hash['iPPools'].nil?
+        i_p_pools = []
+        hash['iPPools'].each do |structure|
+          i_p_pools << (IPPool.from_hash(structure) if structure)
+        end
+      end
+
+      i_p_pools = SKIP unless hash.key?('iPPools')
+      # Parameter is an array, so we need to iterate through it
+      service_plans = nil
+      unless hash['servicePlans'].nil?
+        service_plans = []
+        hash['servicePlans'].each do |structure|
+          service_plans << (ServicePlan.from_hash(structure) if structure)
+        end
+      end
+
+      service_plans = SKIP unless hash.key?('servicePlans')
+
+      # Create object from extracted values.
+      Account.new(account_name,
+                  account_number,
+                  organization_name,
+                  is_provisioning_allowed,
+                  carriers,
+                  features,
+                  i_p_pools,
+                  service_plans)
+    end
+  end
+end

data/lib/verizon/models/account_device_list.rb

@@ -0,0 +1,69 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # A list of deviceId objects to use when requesting information from multiple
+  # devices.
+  class AccountDeviceList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # All identifiers for the device.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # All identifiers for the device.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['ip_address'] = 'ipAddress'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ip_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = nil,
+                   ip_address = SKIP)
+      @device_ids = device_ids
+      @ip_address = ip_address unless ip_address == 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_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 = nil unless hash.key?('deviceIds')
+      ip_address = hash.key?('ipAddress') ? hash['ipAddress'] : SKIP
+
+      # Create object from extracted values.
+      AccountDeviceList.new(device_ids,
+                            ip_address)
+    end
+  end
+end

data/lib/verizon/models/account_device_list_filter.rb

@@ -0,0 +1,58 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Filter for a list of devices.
+  class AccountDeviceListFilter < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specify the kind of the device identifier, the type of match, and the
+    # string that you want to match.
+    # @return [Array[DeviceIdSearch]]
+    attr_accessor :device_identifier_filters
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_identifier_filters'] = 'deviceIdentifierFilters'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_identifier_filters = nil)
+      @device_identifier_filters = device_identifier_filters
+    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_identifier_filters = nil
+      unless hash['deviceIdentifierFilters'].nil?
+        device_identifier_filters = []
+        hash['deviceIdentifierFilters'].each do |structure|
+          device_identifier_filters << (DeviceIdSearch.from_hash(structure) if structure)
+        end
+      end
+
+      device_identifier_filters = nil unless hash.key?('deviceIdentifierFilters')
+
+      # Create object from extracted values.
+      AccountDeviceListFilter.new(device_identifier_filters)
+    end
+  end
+end

data/lib/verizon/models/account_device_list_request.rb

@@ -0,0 +1,164 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request for listing account devices.
+  class AccountDeviceListRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The billing account for which a list of devices is returned. If you don't
+    # specify an accountName, the list includes all devices to which you have
+    # access.
+    # @return [String]
+    attr_accessor :account_name
+
+    # An identifier for a single device.
+    # @return [DeviceId]
+    attr_accessor :device_id
+
+    # Filter for a list of devices.
+    # @return [AccountDeviceListFilter]
+    attr_accessor :filter
+
+    # The name of a device state, to only include devices in that state.
+    # @return [String]
+    attr_accessor :current_state
+
+    # Custom field names and values, if you want to only include devices that
+    # have matching values.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # Only include devices that were added after this date and time.
+    # @return [String]
+    attr_accessor :earliest
+
+    # Only include devices that are in this device group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # Only include devices that were added before this date and time.
+    # @return [String]
+    attr_accessor :latest
+
+    # Only include devices that have this service plan.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # Only include devices that have this service plan.
+    # @return [Integer]
+    attr_accessor :max_number_of_devices
+
+    # Only include devices that have this service plan.
+    # @return [Integer]
+    attr_accessor :largest_device_id_seen
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['device_id'] = 'deviceId'
+      @_hash['filter'] = 'filter'
+      @_hash['current_state'] = 'currentState'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['earliest'] = 'earliest'
+      @_hash['group_name'] = 'groupName'
+      @_hash['latest'] = 'latest'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash['max_number_of_devices'] = 'maxNumberOfDevices'
+      @_hash['largest_device_id_seen'] = 'largestDeviceIdSeen'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        device_id
+        filter
+        current_state
+        custom_fields
+        earliest
+        group_name
+        latest
+        service_plan
+        max_number_of_devices
+        largest_device_id_seen
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   device_id = SKIP,
+                   filter = SKIP,
+                   current_state = SKIP,
+                   custom_fields = SKIP,
+                   earliest = SKIP,
+                   group_name = SKIP,
+                   latest = SKIP,
+                   service_plan = SKIP,
+                   max_number_of_devices = SKIP,
+                   largest_device_id_seen = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @device_id = device_id unless device_id == SKIP
+      @filter = filter unless filter == SKIP
+      @current_state = current_state unless current_state == SKIP
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @earliest = earliest unless earliest == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @latest = latest unless latest == SKIP
+      @service_plan = service_plan unless service_plan == SKIP
+      @max_number_of_devices = max_number_of_devices unless max_number_of_devices == SKIP
+      @largest_device_id_seen = largest_device_id_seen unless largest_device_id_seen == 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
+      device_id = DeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      filter = AccountDeviceListFilter.from_hash(hash['filter']) if hash['filter']
+      current_state = hash.key?('currentState') ? hash['currentState'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      custom_fields = nil
+      unless hash['customFields'].nil?
+        custom_fields = []
+        hash['customFields'].each do |structure|
+          custom_fields << (CustomFields.from_hash(structure) if structure)
+        end
+      end
+
+      custom_fields = SKIP unless hash.key?('customFields')
+      earliest = hash.key?('earliest') ? hash['earliest'] : SKIP
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      latest = hash.key?('latest') ? hash['latest'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+      max_number_of_devices =
+        hash.key?('maxNumberOfDevices') ? hash['maxNumberOfDevices'] : SKIP
+      largest_device_id_seen =
+        hash.key?('largestDeviceIdSeen') ? hash['largestDeviceIdSeen'] : SKIP
+
+      # Create object from extracted values.
+      AccountDeviceListRequest.new(account_name,
+                                   device_id,
+                                   filter,
+                                   current_state,
+                                   custom_fields,
+                                   earliest,
+                                   group_name,
+                                   latest,
+                                   service_plan,
+                                   max_number_of_devices,
+                                   largest_device_id_seen)
+    end
+  end
+end