purecloud 0.52.1 → 0.53.1

data/lib/purecloud/models/location_search_request.rb

@@ -18,16 +18,22 @@ require 'date'
 
 module PureCloud
   class LocationSearchRequest
+    # The sort order for results
     attr_accessor :sort_order
 
+    # The field in the resource that you want to sort the results by
     attr_accessor :sort_by
 
+    # The number of results per page
     attr_accessor :page_size
 
+    # The page of resources you want to retrieve
     attr_accessor :page_number
 
+    # A List of strings containing the resource field paths that you want to return
     attr_accessor :return_fields
 
+    # Provides more details about a specified resource
     attr_accessor :expand
 
     attr_accessor :query

data/lib/purecloud/models/locations_search_response.rb

@@ -18,22 +18,31 @@ require 'date'
 
 module PureCloud
   class LocationsSearchResponse
+    # The total number of results found
     attr_accessor :total
 
+    # The total number of pages
     attr_accessor :page_count
 
+    # The current page size
     attr_accessor :page_size
 
+    # The current page number
     attr_accessor :page_number
 
+    # Q64 value for the previous page of results
     attr_accessor :previous_page
 
+    # Q64 value for the current page of results
     attr_accessor :current_page
 
+    # Q64 value for the next page of results
     attr_accessor :next_page
 
+    # Resource types the search was performed against
     attr_accessor :types
 
+    # Search results
     attr_accessor :results
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloud/models/logical_interface_entity_listing.rb

@@ -28,12 +28,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
@@ -52,12 +52,12 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
-        :'next_uri' => :'nextUri',
-        
         :'first_uri' => :'firstUri',
         
         :'previous_uri' => :'previousUri',
         
+        :'next_uri' => :'nextUri',
+        
         :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
@@ -73,9 +73,9 @@ module PureCloud
         :'page_number' => :'Integer',
         :'total' => :'Integer',
         :'self_uri' => :'String',
-        :'next_uri' => :'String',
         :'first_uri' => :'String',
         :'previous_uri' => :'String',
+        :'next_uri' => :'String',
         :'last_uri' => :'String',
         :'page_count' => :'Integer'
         
@@ -111,10 +111,6 @@ 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
@@ -123,6 +119,10 @@ 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
@@ -142,9 +142,9 @@ module PureCloud
           page_number == o.page_number &&
           total == o.total &&
           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
@@ -156,7 +156,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [entities, page_size, page_number, total, self_uri, next_uri, first_uri, previous_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/management_unit.rb

@@ -0,0 +1,230 @@
+=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@inin.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
+  # Management Unit object for Workforce Management.
+  class ManagementUnit
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # Start day of week for workforce management planning purposes
+    attr_accessor :start_day_of_week
+
+    # The time zone for the management unit in standard Olson Format (See https://en.wikipedia.org/wiki/Tz_database)
+    attr_accessor :timezone
+
+    # The version of the underlying ManagementUnit object. Useful for handling eventual consistency issues.  User must submit the current version they of the ManagementUnit in any write requests
+    attr_accessor :version
+
+    # 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',
+        
+        :'start_day_of_week' => :'startDayOfWeek',
+        
+        :'timezone' => :'timezone',
+        
+        :'version' => :'version',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'start_day_of_week' => :'String',
+        :'timezone' => :'String',
+        :'version' => :'Integer',
+        :'self_uri' => :'String'
+        
+      }
+    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[:'id']
+        self.id = attributes[:'id']
+      end
+      
+      if attributes[:'name']
+        self.name = attributes[:'name']
+      end
+      
+      if attributes[:'startDayOfWeek']
+        self.start_day_of_week = attributes[:'startDayOfWeek']
+      end
+      
+      if attributes[:'timezone']
+        self.timezone = attributes[:'timezone']
+      end
+      
+      if attributes[:'version']
+        self.version = attributes[:'version']
+      end
+      
+      if attributes[:'selfUri']
+        self.self_uri = attributes[:'selfUri']
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def start_day_of_week=(start_day_of_week)
+      allowed_values = ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"]
+      if start_day_of_week && !allowed_values.include?(start_day_of_week)
+        fail "invalid value for 'start_day_of_week', must be one of #{allowed_values}"
+      end
+      @start_day_of_week = start_day_of_week
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          name == o.name &&
+          start_day_of_week == o.start_day_of_week &&
+          timezone == o.timezone &&
+          version == o.version &&
+          self_uri == o.self_uri
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [id, name, start_day_of_week, timezone, version, 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

data/lib/purecloud/models/o_auth_client_entity_listing.rb

@@ -28,12 +28,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
@@ -52,12 +52,12 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
-        :'next_uri' => :'nextUri',
-        
         :'first_uri' => :'firstUri',
         
         :'previous_uri' => :'previousUri',
         
+        :'next_uri' => :'nextUri',
+        
         :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
@@ -73,9 +73,9 @@ module PureCloud
         :'page_number' => :'Integer',
         :'total' => :'Integer',
         :'self_uri' => :'String',
-        :'next_uri' => :'String',
         :'first_uri' => :'String',
         :'previous_uri' => :'String',
+        :'next_uri' => :'String',
         :'last_uri' => :'String',
         :'page_count' => :'Integer'
         
@@ -111,10 +111,6 @@ 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
@@ -123,6 +119,10 @@ 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
@@ -142,9 +142,9 @@ module PureCloud
           page_number == o.page_number &&
           total == o.total &&
           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
@@ -156,7 +156,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [entities, page_size, page_number, total, self_uri, next_uri, first_uri, previous_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloud/models/o_auth_provider_entity_listing.rb

@@ -28,12 +28,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
@@ -52,12 +52,12 @@ module PureCloud
         
         :'self_uri' => :'selfUri',
         
-        :'next_uri' => :'nextUri',
-        
         :'first_uri' => :'firstUri',
         
         :'previous_uri' => :'previousUri',
         
+        :'next_uri' => :'nextUri',
+        
         :'last_uri' => :'lastUri',
         
         :'page_count' => :'pageCount'
@@ -73,9 +73,9 @@ module PureCloud
         :'page_number' => :'Integer',
         :'total' => :'Integer',
         :'self_uri' => :'String',
-        :'next_uri' => :'String',
         :'first_uri' => :'String',
         :'previous_uri' => :'String',
+        :'next_uri' => :'String',
         :'last_uri' => :'String',
         :'page_count' => :'Integer'
         
@@ -111,10 +111,6 @@ 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
@@ -123,6 +119,10 @@ 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
@@ -142,9 +142,9 @@ module PureCloud
           page_number == o.page_number &&
           total == o.total &&
           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
@@ -156,7 +156,7 @@ module PureCloud
 
     # Calculate hash code according to all attributes.
     def hash
-      [entities, page_size, page_number, total, self_uri, next_uri, first_uri, previous_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash