sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/models/sms_event_history_request.rb

@@ -0,0 +1,86 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module Verizon
+  # SMSEventHistoryRequest Model.
+  class SMSEventHistoryRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [GIODeviceId]
+    attr_accessor :device_id
+
+    # 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['device_id'] = 'deviceId'
+      @_hash['earliest'] = 'earliest'
+      @_hash['latest'] = 'latest'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        earliest
+        latest
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_id = nil,
+                   earliest = SKIP,
+                   latest = SKIP)
+      @device_id = device_id
+      @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.
+      device_id = GIODeviceId.from_hash(hash['deviceId']) if hash['deviceId']
+      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.
+      SMSEventHistoryRequest.new(device_id,
+                                 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/sms_message.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # SMS messages sent by all M2M devices associated with a billing account.
+  class SMSMessage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # One or more IDs of the device that sent the message.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # The contents of the SMS message.
+    # @return [String]
+    attr_accessor :message
+
+    # The date and time that the message was received by the Verizon ThingSpace
+    # Platform.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['message'] = 'message'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        device_ids
+        message
+        timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = SKIP,
+                   message = SKIP,
+                   timestamp = SKIP)
+      @device_ids = device_ids unless device_ids == SKIP
+      @message = message unless message == SKIP
+      @timestamp = timestamp unless timestamp == 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 = SKIP unless hash.key?('deviceIds')
+      message = hash.key?('message') ? hash['message'] : SKIP
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+
+      # Create object from extracted values.
+      SMSMessage.new(device_ids,
+                     message,
+                     timestamp)
+    end
+  end
+end

data/lib/verizon/models/sms_messages_query_result.rb

@@ -0,0 +1,72 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Response to SMS messages sent by all M2M devices associated with a billing
+  # account.
+  class SMSMessagesQueryResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # False for a status 200 response.True for a status 202 response, indicating
+    # that there is more data to be retrieved.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more_data
+
+    # An array of up to 100 SMS messages that were sent by devices in the
+    # account.
+    # @return [Array[SMSMessage]]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['has_more_data'] = 'hasMoreData'
+      @_hash['messages'] = 'messages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        has_more_data
+        messages
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(has_more_data = SKIP,
+                   messages = SKIP)
+      @has_more_data = has_more_data unless has_more_data == SKIP
+      @messages = messages unless messages == 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.
+      has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      messages = nil
+      unless hash['messages'].nil?
+        messages = []
+        hash['messages'].each do |structure|
+          messages << (SMSMessage.from_hash(structure) if structure)
+        end
+      end
+
+      messages = SKIP unless hash.key?('messages')
+
+      # Create object from extracted values.
+      SMSMessagesQueryResult.new(has_more_data,
+                                 messages)
+    end
+  end
+end

data/lib/verizon/models/sms_messages_response.rb

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

data/lib/verizon/models/sms_number.rb

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

data/lib/verizon/models/sms_options_send_request.rb

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

data/lib/verizon/models/sms_send_request.rb

@@ -0,0 +1,132 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # Request to send SMS.
+  class SMSSendRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of a billing account.
+    # @return [String]
+    attr_accessor :account_name
+
+    # The contents of the SMS message. The SMS message is limited to 160
+    # characters in 7-bit format, or 140 characters in 8-bit format.
+    # @return [String]
+    attr_accessor :sms_message
+
+    # The names and values of custom fields, if you want to only include devices
+    # that have matching custom fields.
+    # @return [Array[CustomFields]]
+    attr_accessor :custom_fields
+
+    # The SMS message encoding, which can be 7-bit (default), 8-bit-ASCII,
+    # 8-bit-UTF-8, 8-bit-DATA.
+    # @return [String]
+    attr_accessor :data_encoding
+
+    # The devices that you want to send the message to, specified by device
+    # identifier.
+    # @return [Array[DeviceId]]
+    attr_accessor :device_ids
+
+    # The name of a device group, if you want to send the SMS message to all
+    # devices in the device group.
+    # @return [String]
+    attr_accessor :group_name
+
+    # The name of a service plan, if you want to only include devices that have
+    # that service plan.
+    # @return [String]
+    attr_accessor :service_plan
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_name'] = 'accountName'
+      @_hash['sms_message'] = 'smsMessage'
+      @_hash['custom_fields'] = 'customFields'
+      @_hash['data_encoding'] = 'dataEncoding'
+      @_hash['device_ids'] = 'deviceIds'
+      @_hash['group_name'] = 'groupName'
+      @_hash['service_plan'] = 'servicePlan'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        custom_fields
+        data_encoding
+        device_ids
+        group_name
+        service_plan
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_name = nil,
+                   sms_message = nil,
+                   custom_fields = SKIP,
+                   data_encoding = SKIP,
+                   device_ids = SKIP,
+                   group_name = SKIP,
+                   service_plan = SKIP)
+      @account_name = account_name
+      @sms_message = sms_message
+      @custom_fields = custom_fields unless custom_fields == SKIP
+      @data_encoding = data_encoding unless data_encoding == SKIP
+      @device_ids = device_ids unless device_ids == SKIP
+      @group_name = group_name unless group_name == SKIP
+      @service_plan = service_plan unless service_plan == 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
+      sms_message = hash.key?('smsMessage') ? hash['smsMessage'] : nil
+      # 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')
+      data_encoding = hash.key?('dataEncoding') ? hash['dataEncoding'] : SKIP
+      # 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 = SKIP unless hash.key?('deviceIds')
+      group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
+      service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
+
+      # Create object from extracted values.
+      SMSSendRequest.new(account_name,
+                         sms_message,
+                         custom_fields,
+                         data_encoding,
+                         device_ids,
+                         group_name,
+                         service_plan)
+    end
+  end
+end

data/lib/verizon/models/sms_trigger_request.rb

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