bandwidth-sdk 18.0.0 → 18.1.0

data/lib/bandwidth-sdk/models/endpoint_event.rb

@@ -0,0 +1,381 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.17.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  # An event that occurred on an endpoint.
+  class EndpointEvent < ApiModelBase
+    # The unique ID of the endpoint.
+    attr_accessor :endpoint_id
+
+    attr_accessor :type
+
+    attr_accessor :status
+
+    # The time the endpoint was created. In ISO-8601 format.
+    attr_accessor :creation_timestamp
+
+    # The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours.
+    attr_accessor :expiration_timestamp
+
+    # A tag for the endpoint.
+    attr_accessor :tag
+
+    # The time the event occurred. In ISO-8601 format.
+    attr_accessor :event_time
+
+    attr_accessor :event_type
+
+    attr_accessor :device
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'endpoint_id' => :'endpointId',
+        :'type' => :'type',
+        :'status' => :'status',
+        :'creation_timestamp' => :'creationTimestamp',
+        :'expiration_timestamp' => :'expirationTimestamp',
+        :'tag' => :'tag',
+        :'event_time' => :'eventTime',
+        :'event_type' => :'eventType',
+        :'device' => :'device'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'endpoint_id' => :'String',
+        :'type' => :'EndpointTypeEnum',
+        :'status' => :'EndpointStatusEnum',
+        :'creation_timestamp' => :'Time',
+        :'expiration_timestamp' => :'Time',
+        :'tag' => :'String',
+        :'event_time' => :'Time',
+        :'event_type' => :'EndpointEventTypeEnum',
+        :'device' => :'Device'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Endpoints'
+      ]
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::EndpointEvent` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::EndpointEvent`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'endpoint_id')
+        self.endpoint_id = attributes[:'endpoint_id']
+      else
+        self.endpoint_id = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'creation_timestamp')
+        self.creation_timestamp = attributes[:'creation_timestamp']
+      else
+        self.creation_timestamp = nil
+      end
+
+      if attributes.key?(:'expiration_timestamp')
+        self.expiration_timestamp = attributes[:'expiration_timestamp']
+      else
+        self.expiration_timestamp = nil
+      end
+
+      if attributes.key?(:'tag')
+        self.tag = attributes[:'tag']
+      end
+
+      if attributes.key?(:'event_time')
+        self.event_time = attributes[:'event_time']
+      else
+        self.event_time = nil
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      else
+        self.event_type = nil
+      end
+
+      if attributes.key?(:'device')
+        self.device = attributes[:'device']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @endpoint_id.nil?
+        invalid_properties.push('invalid value for "endpoint_id", endpoint_id cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @creation_timestamp.nil?
+        invalid_properties.push('invalid value for "creation_timestamp", creation_timestamp cannot be nil.')
+      end
+
+      if @expiration_timestamp.nil?
+        invalid_properties.push('invalid value for "expiration_timestamp", expiration_timestamp cannot be nil.')
+      end
+
+      if @event_time.nil?
+        invalid_properties.push('invalid value for "event_time", event_time cannot be nil.')
+      end
+
+      if @event_type.nil?
+        invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @endpoint_id.nil?
+      return false if @type.nil?
+      return false if @status.nil?
+      return false if @creation_timestamp.nil?
+      return false if @expiration_timestamp.nil?
+      return false if @event_time.nil?
+      return false if @event_type.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] endpoint_id Value to be assigned
+    def endpoint_id=(endpoint_id)
+      if endpoint_id.nil?
+        fail ArgumentError, 'endpoint_id cannot be nil'
+      end
+
+      @endpoint_id = endpoint_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] creation_timestamp Value to be assigned
+    def creation_timestamp=(creation_timestamp)
+      if creation_timestamp.nil?
+        fail ArgumentError, 'creation_timestamp cannot be nil'
+      end
+
+      @creation_timestamp = creation_timestamp
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expiration_timestamp Value to be assigned
+    def expiration_timestamp=(expiration_timestamp)
+      if expiration_timestamp.nil?
+        fail ArgumentError, 'expiration_timestamp cannot be nil'
+      end
+
+      @expiration_timestamp = expiration_timestamp
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tag Value to be assigned
+    def tag=(tag)
+      if tag.nil?
+        fail ArgumentError, 'tag cannot be nil'
+      end
+
+      @tag = tag
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_time Value to be assigned
+    def event_time=(event_time)
+      if event_time.nil?
+        fail ArgumentError, 'event_time cannot be nil'
+      end
+
+      @event_time = event_time
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_type Value to be assigned
+    def event_type=(event_type)
+      if event_type.nil?
+        fail ArgumentError, 'event_type cannot be nil'
+      end
+
+      @event_type = event_type
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          endpoint_id == o.endpoint_id &&
+          type == o.type &&
+          status == o.status &&
+          creation_timestamp == o.creation_timestamp &&
+          expiration_timestamp == o.expiration_timestamp &&
+          tag == o.tag &&
+          event_time == o.event_time &&
+          event_type == o.event_type &&
+          device == o.device
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [endpoint_id, type, status, creation_timestamp, expiration_timestamp, tag, event_time, event_type, device].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+  end
+end

data/lib/bandwidth-sdk/models/endpoint_event_type_enum.rb

@@ -0,0 +1,40 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.17.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class EndpointEventTypeEnum
+    DEVICE_CONNECTED = 'DEVICE_CONNECTED'.freeze
+    DEVICE_DISCONNECTED = 'DEVICE_DISCONNECTED'.freeze
+
+    def self.all_vars
+      @all_vars ||= [DEVICE_CONNECTED, DEVICE_DISCONNECTED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if EndpointEventTypeEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #EndpointEventTypeEnum"
+    end
+  end
+end

data/lib/bandwidth-sdk/models/endpoint_response.rb

@@ -0,0 +1,218 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.17.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class EndpointResponse < ApiModelBase
+    attr_accessor :links
+
+    attr_accessor :data
+
+    attr_accessor :errors
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'links' => :'links',
+        :'data' => :'data',
+        :'errors' => :'errors'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'links' => :'Array<BrtcLink>',
+        :'data' => :'Endpoint',
+        :'errors' => :'Array<BrtcError>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::EndpointResponse` initialize method'
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::EndpointResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'links')
+        if (value = attributes[:'links']).is_a?(Array)
+          self.links = value
+        end
+      else
+        self.links = nil
+      end
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = nil
+      end
+
+      if attributes.key?(:'errors')
+        if (value = attributes[:'errors']).is_a?(Array)
+          self.errors = value
+        end
+      else
+        self.errors = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @links.nil?
+        invalid_properties.push('invalid value for "links", links cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      if @errors.nil?
+        invalid_properties.push('invalid value for "errors", errors cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @links.nil?
+      return false if @data.nil?
+      return false if @errors.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] links Value to be assigned
+    def links=(links)
+      if links.nil?
+        fail ArgumentError, 'links cannot be nil'
+      end
+
+      @links = links
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] errors Value to be assigned
+    def errors=(errors)
+      if errors.nil?
+        fail ArgumentError, 'errors cannot be nil'
+      end
+
+      @errors = errors
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          links == o.links &&
+          data == o.data &&
+          errors == o.errors
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [links, data, errors].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+  end
+end

data/lib/bandwidth-sdk/models/endpoint_status_enum.rb

@@ -0,0 +1,40 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.17.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class EndpointStatusEnum
+    CONNECTED = 'CONNECTED'.freeze
+    DISCONNECTED = 'DISCONNECTED'.freeze
+
+    def self.all_vars
+      @all_vars ||= [CONNECTED, DISCONNECTED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if EndpointStatusEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #EndpointStatusEnum"
+    end
+  end
+end