purecloud 0.27.0 → 0.28.0

data/lib/purecloud/models/time_zone_entity_listing.rb

@@ -12,12 +12,12 @@ module PureCloud
 
     attr_accessor :self_uri
 
+    attr_accessor :next_uri
+
     attr_accessor :first_uri
 
     attr_accessor :previous_uri
 
-    attr_accessor :next_uri
-
     attr_accessor :last_uri
 
     attr_accessor :page_count
@@ -36,12 +36,12 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
+        :'next_uri' => :'nextUri',
+        
         :'first_uri' => :'firstUri',
         
         :'previous_uri' => :'previousUri',
         
-        :'next_uri' => :'nextUri',
-        
         :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
@@ -57,9 +57,9 @@ module PureCloud
         :'total' => :'Integer',
         :'entities' => :'Array<TimeZone>',
         :'self_uri' => :'String',
+        :'next_uri' => :'String',
         :'first_uri' => :'String',
         :'previous_uri' => :'String',
-        :'next_uri' => :'String',
         :'last_uri' => :'String',
         :'page_count' => :'Integer'
         
@@ -95,6 +95,10 @@ module PureCloud
         self.self_uri = attributes[:'selfUri']
       end
       
+      if attributes[:'nextUri']
+        self.next_uri = attributes[:'nextUri']
+      end
+      
       if attributes[:'firstUri']
         self.first_uri = attributes[:'firstUri']
       end
@@ -103,10 +107,6 @@ module PureCloud
         self.previous_uri = attributes[:'previousUri']
       end
       
-      if attributes[:'nextUri']
-        self.next_uri = attributes[:'nextUri']
-      end
-      
       if attributes[:'lastUri']
         self.last_uri = attributes[:'lastUri']
       end
@@ -126,9 +126,9 @@ module PureCloud
           total == o.total &&
           entities == o.entities &&
           self_uri == o.self_uri &&
+          next_uri == o.next_uri &&
           first_uri == o.first_uri &&
           previous_uri == o.previous_uri &&
-          next_uri == o.next_uri &&
           last_uri == o.last_uri &&
           page_count == o.page_count
     end
@@ -140,7 +140,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [page_size, page_number, total, entities, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
+      [page_size, page_number, total, entities, self_uri, next_uri, first_uri, previous_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/transfer_request.rb

@@ -0,0 +1,193 @@
+require 'date'
+
+module PureCloud
+  class TransferRequest
+    # The user ID of the transfer target.
+    attr_accessor :user_id
+
+    # The phone number or address of the transfer target.
+    attr_accessor :address
+
+    # The user name of the transfer target.
+    attr_accessor :user_name
+
+    # The queue ID of the transfer target.
+    attr_accessor :queue_id
+
+    # If true, then transfer to the user's voicemail.
+    attr_accessor :voicemail
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'user_id' => :'userId',
+        
+        :'address' => :'address',
+        
+        :'user_name' => :'userName',
+        
+        :'queue_id' => :'queueId',
+        
+        :'voicemail' => :'voicemail'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'user_id' => :'String',
+        :'address' => :'String',
+        :'user_name' => :'String',
+        :'queue_id' => :'String',
+        :'voicemail' => :'BOOLEAN'
+        
+      }
+    end
+
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+
+      
+      if attributes[:'userId']
+        self.user_id = attributes[:'userId']
+      end
+      
+      if attributes[:'address']
+        self.address = attributes[:'address']
+      end
+      
+      if attributes[:'userName']
+        self.user_name = attributes[:'userName']
+      end
+      
+      if attributes[:'queueId']
+        self.queue_id = attributes[:'queueId']
+      end
+      
+      if attributes[:'voicemail']
+        self.voicemail = attributes[:'voicemail']
+      else
+        self.voicemail = false
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          user_id == o.user_id &&
+          address == o.address &&
+          user_name == o.user_name &&
+          queue_id == o.queue_id &&
+          voicemail == o.voicemail
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [user_id, address, user_name, queue_id, voicemail].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 =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      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

data/lib/purecloud/models/trunk_metabase_entity_listing.rb

@@ -12,12 +12,12 @@ module PureCloud
 
     attr_accessor :self_uri
 
+    attr_accessor :next_uri
+
     attr_accessor :first_uri
 
     attr_accessor :previous_uri
 
-    attr_accessor :next_uri
-
     attr_accessor :last_uri
 
     attr_accessor :page_count
@@ -36,12 +36,12 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
+        :'next_uri' => :'nextUri',
+        
         :'first_uri' => :'firstUri',
         
         :'previous_uri' => :'previousUri',
         
-        :'next_uri' => :'nextUri',
-        
         :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
@@ -57,9 +57,9 @@ module PureCloud
         :'total' => :'Integer',
         :'entities' => :'Array<Metabase>',
         :'self_uri' => :'String',
+        :'next_uri' => :'String',
         :'first_uri' => :'String',
         :'previous_uri' => :'String',
-        :'next_uri' => :'String',
         :'last_uri' => :'String',
         :'page_count' => :'Integer'
         
@@ -95,6 +95,10 @@ module PureCloud
         self.self_uri = attributes[:'selfUri']
       end
       
+      if attributes[:'nextUri']
+        self.next_uri = attributes[:'nextUri']
+      end
+      
       if attributes[:'firstUri']
         self.first_uri = attributes[:'firstUri']
       end
@@ -103,10 +107,6 @@ module PureCloud
         self.previous_uri = attributes[:'previousUri']
       end
       
-      if attributes[:'nextUri']
-        self.next_uri = attributes[:'nextUri']
-      end
-      
       if attributes[:'lastUri']
         self.last_uri = attributes[:'lastUri']
       end
@@ -126,9 +126,9 @@ module PureCloud
           total == o.total &&
           entities == o.entities &&
           self_uri == o.self_uri &&
+          next_uri == o.next_uri &&
           first_uri == o.first_uri &&
           previous_uri == o.previous_uri &&
-          next_uri == o.next_uri &&
           last_uri == o.last_uri &&
           page_count == o.page_count
     end
@@ -140,7 +140,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [page_size, page_number, total, entities, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
+      [page_size, page_number, total, entities, self_uri, next_uri, first_uri, previous_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/user.rb

@@ -7,53 +7,53 @@ module PureCloud
 
     attr_accessor :name
 
-    attr_accessor :username
+    attr_accessor :chat
 
-    attr_accessor :email
+    attr_accessor :department
 
-    attr_accessor :display_name
+    attr_accessor :email
 
-    attr_accessor :phone_number
+    # Auto populated from addresses.
+    attr_accessor :primary_contact_info
 
-    attr_accessor :user_images
+    attr_accessor :addresses
 
-    attr_accessor :chat
+    # The current state for this user.
+    attr_accessor :state
 
-    attr_accessor :roles
+    attr_accessor :title
 
-    attr_accessor :voicemail_enabled
+    attr_accessor :username
 
-    attr_accessor :department
+    attr_accessor :images
 
-    attr_accessor :title
+    # Required when updating. Version must be the current version. Only the system can assign version.
+    attr_accessor :version
 
+    # ACD routing status
     attr_accessor :routing_status
 
-    attr_accessor :password
-
+    # Active presence
     attr_accessor :primary_presence
 
-    attr_accessor :conversations
-
+    # Summary of conversion statistics for conversation types.
     attr_accessor :conversation_summary
 
+    # Determine if out of office is enabled
     attr_accessor :out_of_office
 
+    # Current geolocation position
     attr_accessor :geolocation
 
-    attr_accessor :permissions
+    # Effective, default, and last station information
+    attr_accessor :station
+
+    # Roles and permissions assigned to the user
+    attr_accessor :authorization
 
     # The URI for this object
     attr_accessor :self_uri
 
-    attr_accessor :requested_status
-
-    attr_accessor :default_station_uri
-
-    attr_accessor :station_uri
-
-    attr_accessor :last_station_uri
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -62,51 +62,41 @@ module PureCloud
         
         :'name' => :'name',
         
-        :'username' => :'username',
+        :'chat' => :'chat',
         
-        :'email' => :'email',
+        :'department' => :'department',
         
-        :'display_name' => :'displayName',
+        :'email' => :'email',
         
-        :'phone_number' => :'phoneNumber',
+        :'primary_contact_info' => :'primaryContactInfo',
         
-        :'user_images' => :'userImages',
+        :'addresses' => :'addresses',
         
-        :'chat' => :'chat',
+        :'state' => :'state',
         
-        :'roles' => :'roles',
+        :'title' => :'title',
         
-        :'voicemail_enabled' => :'voicemailEnabled',
+        :'username' => :'username',
         
-        :'department' => :'department',
+        :'images' => :'images',
         
-        :'title' => :'title',
+        :'version' => :'version',
         
         :'routing_status' => :'routingStatus',
         
-        :'password' => :'password',
-        
         :'primary_presence' => :'primaryPresence',
         
-        :'conversations' => :'conversations',
-        
         :'conversation_summary' => :'conversationSummary',
         
         :'out_of_office' => :'outOfOffice',
         
         :'geolocation' => :'geolocation',
         
-        :'permissions' => :'permissions',
-        
-        :'self_uri' => :'selfUri',
+        :'station' => :'station',
         
-        :'requested_status' => :'requestedStatus',
+        :'authorization' => :'authorization',
         
-        :'default_station_uri' => :'defaultStationUri',
-        
-        :'station_uri' => :'stationUri',
-        
-        :'last_station_uri' => :'lastStationUri'
+        :'self_uri' => :'selfUri'
         
       }
     end
@@ -116,29 +106,24 @@ module PureCloud
       {
         :'id' => :'String',
         :'name' => :'String',
-        :'username' => :'String',
-        :'email' => :'String',
-        :'display_name' => :'String',
-        :'phone_number' => :'String',
-        :'user_images' => :'Array<UserImage>',
         :'chat' => :'Chat',
-        :'roles' => :'Array<DomainOrganizationRole>',
-        :'voicemail_enabled' => :'BOOLEAN',
         :'department' => :'String',
+        :'email' => :'String',
+        :'primary_contact_info' => :'Array<Contact>',
+        :'addresses' => :'Array<Contact>',
+        :'state' => :'String',
         :'title' => :'String',
+        :'username' => :'String',
+        :'images' => :'Array<UserImage>',
+        :'version' => :'String',
         :'routing_status' => :'RoutingStatus',
-        :'password' => :'String',
         :'primary_presence' => :'UserPresence',
-        :'conversations' => :'UserConversationSummary',
         :'conversation_summary' => :'UserConversationSummary',
         :'out_of_office' => :'OutOfOffice',
         :'geolocation' => :'Geolocation',
-        :'permissions' => :'Array<String>',
-        :'self_uri' => :'String',
-        :'requested_status' => :'UserStatus',
-        :'default_station_uri' => :'String',
-        :'station_uri' => :'String',
-        :'last_station_uri' => :'String'
+        :'station' => :'UserStations',
+        :'authorization' => :'UserAuthorization',
+        :'self_uri' => :'String'
         
       }
     end
@@ -158,68 +143,60 @@ module PureCloud
         self.name = attributes[:'name']
       end
       
-      if attributes[:'username']
-        self.username = attributes[:'username']
+      if attributes[:'chat']
+        self.chat = attributes[:'chat']
       end
       
-      if attributes[:'email']
-        self.email = attributes[:'email']
+      if attributes[:'department']
+        self.department = attributes[:'department']
       end
       
-      if attributes[:'displayName']
-        self.display_name = attributes[:'displayName']
+      if attributes[:'email']
+        self.email = attributes[:'email']
       end
       
-      if attributes[:'phoneNumber']
-        self.phone_number = attributes[:'phoneNumber']
+      if attributes[:'primaryContactInfo']
+        if (value = attributes[:'primaryContactInfo']).is_a?(Array)
+          self.primary_contact_info = value
+        end
       end
       
-      if attributes[:'userImages']
-        if (value = attributes[:'userImages']).is_a?(Array)
-          self.user_images = value
+      if attributes[:'addresses']
+        if (value = attributes[:'addresses']).is_a?(Array)
+          self.addresses = value
         end
       end
       
-      if attributes[:'chat']
-        self.chat = attributes[:'chat']
+      if attributes[:'state']
+        self.state = attributes[:'state']
       end
       
-      if attributes[:'roles']
-        if (value = attributes[:'roles']).is_a?(Array)
-          self.roles = value
-        end
+      if attributes[:'title']
+        self.title = attributes[:'title']
       end
       
-      if attributes[:'voicemailEnabled']
-        self.voicemail_enabled = attributes[:'voicemailEnabled']
-      else
-        self.voicemail_enabled = false
+      if attributes[:'username']
+        self.username = attributes[:'username']
       end
       
-      if attributes[:'department']
-        self.department = attributes[:'department']
+      if attributes[:'images']
+        if (value = attributes[:'images']).is_a?(Array)
+          self.images = value
+        end
       end
       
-      if attributes[:'title']
-        self.title = attributes[:'title']
+      if attributes[:'version']
+        self.version = attributes[:'version']
       end
       
       if attributes[:'routingStatus']
         self.routing_status = attributes[:'routingStatus']
       end
       
-      if attributes[:'password']
-        self.password = attributes[:'password']
-      end
-      
       if attributes[:'primaryPresence']
         self.primary_presence = attributes[:'primaryPresence']
       end
       
-      if attributes[:'conversations']
-        self.conversations = attributes[:'conversations']
-      end
-      
       if attributes[:'conversationSummary']
         self.conversation_summary = attributes[:'conversationSummary']
       end
@@ -232,32 +209,27 @@ module PureCloud
         self.geolocation = attributes[:'geolocation']
       end
       
-      if attributes[:'permissions']
-        if (value = attributes[:'permissions']).is_a?(Array)
-          self.permissions = value
-        end
-      end
-      
-      if attributes[:'selfUri']
-        self.self_uri = attributes[:'selfUri']
-      end
-      
-      if attributes[:'requestedStatus']
-        self.requested_status = attributes[:'requestedStatus']
+      if attributes[:'station']
+        self.station = attributes[:'station']
       end
       
-      if attributes[:'defaultStationUri']
-        self.default_station_uri = attributes[:'defaultStationUri']
+      if attributes[:'authorization']
+        self.authorization = attributes[:'authorization']
       end
       
-      if attributes[:'stationUri']
-        self.station_uri = attributes[:'stationUri']
+      if attributes[:'selfUri']
+        self.self_uri = attributes[:'selfUri']
       end
       
-      if attributes[:'lastStationUri']
-        self.last_station_uri = attributes[:'lastStationUri']
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def state=(state)
+      allowed_values = ["ACTIVE", "INACTIVE", "DELETED"]
+      if state && !allowed_values.include?(state)
+        fail "invalid value for 'state', must be one of #{allowed_values}"
       end
-      
+      @state = state
     end
 
     # Check equality by comparing each attribute.
@@ -266,29 +238,24 @@ module PureCloud
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
-          username == o.username &&
-          email == o.email &&
-          display_name == o.display_name &&
-          phone_number == o.phone_number &&
-          user_images == o.user_images &&
           chat == o.chat &&
-          roles == o.roles &&
-          voicemail_enabled == o.voicemail_enabled &&
           department == o.department &&
+          email == o.email &&
+          primary_contact_info == o.primary_contact_info &&
+          addresses == o.addresses &&
+          state == o.state &&
           title == o.title &&
+          username == o.username &&
+          images == o.images &&
+          version == o.version &&
           routing_status == o.routing_status &&
-          password == o.password &&
           primary_presence == o.primary_presence &&
-          conversations == o.conversations &&
           conversation_summary == o.conversation_summary &&
           out_of_office == o.out_of_office &&
           geolocation == o.geolocation &&
-          permissions == o.permissions &&
-          self_uri == o.self_uri &&
-          requested_status == o.requested_status &&
-          default_station_uri == o.default_station_uri &&
-          station_uri == o.station_uri &&
-          last_station_uri == o.last_station_uri
+          station == o.station &&
+          authorization == o.authorization &&
+          self_uri == o.self_uri
     end
 
     # @see the `==` method
@@ -298,7 +265,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [id, name, username, email, display_name, phone_number, user_images, chat, roles, voicemail_enabled, department, title, routing_status, password, primary_presence, conversations, conversation_summary, out_of_office, geolocation, permissions, self_uri, requested_status, default_station_uri, station_uri, last_station_uri].hash
+      [id, name, chat, department, email, primary_contact_info, addresses, state, title, username, images, version, routing_status, primary_presence, conversation_summary, out_of_office, geolocation, station, authorization, self_uri].hash
     end
 
     # build the object from hash