specs-sdk 1.3.0

data/lib/verizon/models/engagement.rb

@@ -0,0 +1,79 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # The engagements associated with the account.
+  class Engagement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The engagement ID.
+    # @return [String]
+    attr_accessor :engagement_id
+
+    # The charging group name.
+    # @return [String]
+    attr_accessor :charging_group
+
+    # The services associated with the account.
+    # @return [Array[AccountService]]
+    attr_accessor :services
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['engagement_id'] = 'engagementId'
+      @_hash['charging_group'] = 'chargingGroup'
+      @_hash['services'] = 'services'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        engagement_id
+        charging_group
+        services
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(engagement_id = SKIP,
+                   charging_group = SKIP,
+                   services = SKIP)
+      @engagement_id = engagement_id unless engagement_id == SKIP
+      @charging_group = charging_group unless charging_group == SKIP
+      @services = services unless services == 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.
+      engagement_id = hash.key?('engagementId') ? hash['engagementId'] : SKIP
+      charging_group = hash.key?('chargingGroup') ? hash['chargingGroup'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      services = nil
+      unless hash['services'].nil?
+        services = []
+        hash['services'].each do |structure|
+          services << (AccountService.from_hash(structure) if structure)
+        end
+      end
+
+      services = SKIP unless hash.key?('services')
+
+      # Create object from extracted values.
+      Engagement.new(engagement_id,
+                     charging_group,
+                     services)
+    end
+  end
+end

data/lib/verizon/models/error_response_code_enum.rb

@@ -0,0 +1,29 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Error Code.
+  class ErrorResponseCodeEnum
+    ERROR_RESPONSE_CODE_ENUM = [
+      # TODO: Write general description for INVALID_ACCESS
+      INVALID_ACCESS = 'INVALID_ACCESS'.freeze,
+
+      # TODO: Write general description for INVALID_PARAMETER
+      INVALID_PARAMETER = 'INVALID_PARAMETER'.freeze,
+
+      # TODO: Write general description for INTERNAL_ERROR
+      INTERNAL_ERROR = 'INTERNAL_ERROR'.freeze,
+
+      # TODO: Write general description for SUCCESS
+      SUCCESS = 'SUCCESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ERROR_RESPONSE_CODE_ENUM.include?(value)
+    end
+  end
+end

data/lib/verizon/models/esi_msubrequest.rb

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

data/lib/verizon/models/esim_device_id.rb

@@ -0,0 +1,60 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ESIMDeviceId Model.
+  class ESIMDeviceId < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @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
+      %w[
+        id
+        kind
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP,
+                   kind = SKIP)
+      @id = id unless id == SKIP
+      @kind = kind unless kind == 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
+      kind = hash.key?('kind') ? hash['kind'] : SKIP
+
+      # Create object from extracted values.
+      ESIMDeviceId.new(id,
+                       kind)
+    end
+  end
+end

data/lib/verizon/models/esim_device_list.rb

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

data/lib/verizon/models/esim_profile_request.rb

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

data/lib/verizon/models/esim_provhistory_request.rb

@@ -0,0 +1,106 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # ESIMProvhistoryRequest Model.
+  class ESIMProvhistoryRequest < 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 [Array[DeviceId2]]
+    attr_accessor :device_filter
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :earliest
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :latest
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['device_filter'] = 'deviceFilter'
+      @_hash['earliest'] = 'earliest'
+      @_hash['latest'] = 'latest'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        device_filter
+        earliest
+        latest
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = SKIP,
+                   device_filter = SKIP,
+                   earliest = SKIP,
+                   latest = SKIP)
+      @account_name = account_name unless account_name == SKIP
+      @device_filter = device_filter unless device_filter == SKIP
+      @earliest = earliest unless earliest == SKIP
+      @latest = latest unless latest == 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
+      # Parameter is an array, so we need to iterate through it
+      device_filter = nil
+      unless hash['deviceFilter'].nil?
+        device_filter = []
+        hash['deviceFilter'].each do |structure|
+          device_filter << (DeviceId2.from_hash(structure) if structure)
+        end
+      end
+
+      device_filter = SKIP unless hash.key?('deviceFilter')
+      earliest = if hash.key?('earliest')
+                   (DateTimeHelper.from_rfc3339(hash['earliest']) if hash['earliest'])
+                 else
+                   SKIP
+                 end
+      latest = if hash.key?('latest')
+                 (DateTimeHelper.from_rfc3339(hash['latest']) if hash['latest'])
+               else
+                 SKIP
+               end
+
+      # Create object from extracted values.
+      ESIMProvhistoryRequest.new(account_name,
+                                 device_filter,
+                                 earliest,
+                                 latest)
+    end
+
+    def to_custom_earliest
+      DateTimeHelper.to_rfc3339(earliest)
+    end
+
+    def to_custom_latest
+      DateTimeHelper.to_rfc3339(latest)
+    end
+  end
+end

data/lib/verizon/models/esim_request_response.rb

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

data/lib/verizon/models/esim_status_response.rb

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

data/lib/verizon/models/extended_attributes.rb

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