purecloudplatformclientv2 27.1.0 → 28.0.0

data/lib/purecloudplatformclientv2/models/sms_available_phone_number.rb

@@ -0,0 +1,465 @@
+=begin
+PureCloud Platform API
+
+With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
+
+OpenAPI spec version: v2
+Contact: DeveloperEvangelists@genesys.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+License: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  class SmsAvailablePhoneNumber
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # A phone number available for provisioning in E.164 format. E.g. +13175555555 or +34234234234
+    attr_accessor :phone_number
+
+    # The ISO 3166-1 alpha-2 country code of the country this phone number is associated with.
+    attr_accessor :country_code
+
+    # The region/province/state the phone number is associated with.
+    attr_accessor :region
+
+    # The city the phone number is associated with.
+    attr_accessor :city
+
+    # The capabilities of the phone number available for provisioning.
+    attr_accessor :capabilities
+
+    # The type of phone number available for provisioning.
+    attr_accessor :phone_number_type
+
+    # The address requirement needed for provisioning this number. If there is a requirement, the address must be the residence or place of business of the individual or entity using the phone number.
+    attr_accessor :address_requirement
+
+    # The URI for this object
+    attr_accessor :self_uri
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'id' => :'id',
+        
+        :'name' => :'name',
+        
+        :'phone_number' => :'phoneNumber',
+        
+        :'country_code' => :'countryCode',
+        
+        :'region' => :'region',
+        
+        :'city' => :'city',
+        
+        :'capabilities' => :'capabilities',
+        
+        :'phone_number_type' => :'phoneNumberType',
+        
+        :'address_requirement' => :'addressRequirement',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'id' => :'String',
+        
+        :'name' => :'String',
+        
+        :'phone_number' => :'String',
+        
+        :'country_code' => :'String',
+        
+        :'region' => :'String',
+        
+        :'city' => :'String',
+        
+        :'capabilities' => :'Array<String>',
+        
+        :'phone_number_type' => :'String',
+        
+        :'address_requirement' => :'String',
+        
+        :'self_uri' => :'String'
+        
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      
+      if attributes.has_key?(:'id')
+        
+        
+        self.id = attributes[:'id']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'name')
+        
+        
+        self.name = attributes[:'name']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'phoneNumber')
+        
+        
+        self.phone_number = attributes[:'phoneNumber']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'countryCode')
+        
+        
+        self.country_code = attributes[:'countryCode']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'region')
+        
+        
+        self.region = attributes[:'region']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'city')
+        
+        
+        self.city = attributes[:'city']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'capabilities')
+        
+        if (value = attributes[:'capabilities']).is_a?(Array)
+          self.capabilities = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'phoneNumberType')
+        
+        
+        self.phone_number_type = attributes[:'phoneNumberType']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'addressRequirement')
+        
+        
+        self.address_requirement = attributes[:'addressRequirement']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'selfUri')
+        
+        
+        self.self_uri = attributes[:'selfUri']
+        
+      
+      end
+
+      
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      
+      
+      return 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?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      allowed_values = ["local", "mobile", "tollfree", "shortcode"]
+      if @phone_number_type && !allowed_values.include?(@phone_number_type)
+        return false
+      end
+      
+      
+      
+      
+      
+      allowed_values = ["none", "any", "local", "foreign"]
+      if @address_requirement && !allowed_values.include?(@address_requirement)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] phone_number_type Object to be assigned
+    def phone_number_type=(phone_number_type)
+      allowed_values = ["local", "mobile", "tollfree", "shortcode"]
+      if phone_number_type && !allowed_values.include?(phone_number_type)
+        fail ArgumentError, "invalid value for 'phone_number_type', must be one of #{allowed_values}."
+      end
+      @phone_number_type = phone_number_type
+    end
+
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] address_requirement Object to be assigned
+    def address_requirement=(address_requirement)
+      allowed_values = ["none", "any", "local", "foreign"]
+      if address_requirement && !allowed_values.include?(address_requirement)
+        fail ArgumentError, "invalid value for 'address_requirement', must be one of #{allowed_values}."
+      end
+      @address_requirement = address_requirement
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          phone_number == o.phone_number &&
+          country_code == o.country_code &&
+          region == o.region &&
+          city == o.city &&
+          capabilities == o.capabilities &&
+          phone_number_type == o.phone_number_type &&
+          address_requirement == o.address_requirement &&
+          self_uri == o.self_uri
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [id, name, phone_number, country_code, region, city, capabilities, phone_number_type, address_requirement, self_uri].hash
+    end
+
+    # build the object from hash
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          else
+            #TODO show warning in debug mode
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        else
+          # data not found in attributes(hash), not an issue as the data can be optional
+        end
+      end
+
+      self
+    end
+
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        _model = Object.const_get("PureCloud").const_get(type).new
+        _model.build_from_hash(value)
+      end
+    end
+
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_body (backward compatibility))
+    def to_body
+      to_hash
+    end
+
+    # return the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Method to output non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end