purecloudplatformclientv2 75.1.0 → 79.0.0

data/lib/purecloudplatformclientv2/models/create_management_unit_api_request.rb

@@ -22,10 +22,10 @@ module PureCloud
     # The name of the management unit
     attr_accessor :name
 
-    # The default time zone to use for this management unit
+    # The default time zone to use for this management unit.  Moving to Business Unit
     attr_accessor :time_zone
 
-    # The configured first day of the week for scheduling and forecasting purposes
+    # The configured first day of the week for scheduling and forecasting purposes. Moving to Business Unit
     attr_accessor :start_day_of_week
 
     # The configuration for the management unit.  If omitted, reasonable defaults will be assigned
@@ -34,6 +34,9 @@ module PureCloud
     # The id of the division to which this management unit belongs.  Defaults to home division ID
     attr_accessor :division_id
 
+    # The id of the business unit to which this management unit belongs.  Required after business unit launch
+    attr_accessor :business_unit_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -46,7 +49,9 @@ module PureCloud
         
         :'settings' => :'settings',
         
-        :'division_id' => :'divisionId'
+        :'division_id' => :'divisionId',
+        
+        :'business_unit_id' => :'businessUnitId'
         
       }
     end
@@ -63,7 +68,9 @@ module PureCloud
         
         :'settings' => :'CreateManagementUnitSettingsRequest',
         
-        :'division_id' => :'String'
+        :'division_id' => :'String',
+        
+        :'business_unit_id' => :'String'
         
       }
     end
@@ -122,6 +129,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'businessUnitId')
+        
+        
+        self.business_unit_id = attributes[:'businessUnitId']
+        
+      
+      end
+
+      
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -147,21 +163,11 @@ module PureCloud
       
       
       
-      if @time_zone.nil?
-        return false
-      end
-
       
       
       
       
       
-      if @start_day_of_week.nil?
-        return false
-      end
-
-      
-      
       allowed_values = ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
       if @start_day_of_week && !allowed_values.include?(@start_day_of_week)
         return false
@@ -177,6 +183,15 @@ module PureCloud
       
       
       
+      
+      if @business_unit_id.nil?
+        return false
+      end
+
+      
+      
+      
+      
     end
 
     
@@ -214,6 +229,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -223,7 +243,8 @@ module PureCloud
           time_zone == o.time_zone &&
           start_day_of_week == o.start_day_of_week &&
           settings == o.settings &&
-          division_id == o.division_id
+          division_id == o.division_id &&
+          business_unit_id == o.business_unit_id
     end
 
     # @see the `==` method
@@ -235,7 +256,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, time_zone, start_day_of_week, settings, division_id].hash
+      [name, time_zone, start_day_of_week, settings, division_id, business_unit_id].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/create_management_unit_settings_request.rb

@@ -22,7 +22,7 @@ module PureCloud
     # Adherence settings for this management unit
     attr_accessor :adherence
 
-    # Short term forecasting settings for this management unit
+    # Short term forecasting settings for this management unit.  Moving to Business Unit
     attr_accessor :short_term_forecasting
 
     # Time off request settings for this management unit

data/lib/purecloudplatformclientv2/models/create_work_plan_shift.rb

@@ -37,7 +37,7 @@ module PureCloud
     # Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true
     attr_accessor :latest_start_time_minutes_from_midnight
 
-    # Whether the latest stop time constraint for the shift is enabled
+    # Whether the latest stop time constraint for the shift is enabled.  Deprecated, use constrainLatestStopTime instead
     attr_accessor :constrain_stop_time
 
     # Whether the latest stop time constraint for the shift is enabled

data/lib/purecloudplatformclientv2/models/data_table_export_job.rb

@@ -0,0 +1,455 @@
+=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: UNLICENSED
+https://help.mypurecloud.com/articles/terms-and-conditions/
+
+Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
+
+=end
+
+require 'date'
+
+module PureCloud
+  # State information for an export job of rows from a datatable
+  class DataTableExportJob
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # The PureCloud user who started the export job
+    attr_accessor :owner
+
+    # The status of the export job
+    attr_accessor :status
+
+    # The timestamp of when the export began. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_created
+
+    # The timestamp of when the export stopped (either successfully or unsuccessfully). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :date_completed
+
+    # The URL of the location at which the caller can download the export file, when available
+    attr_accessor :download_uri
+
+    # Any error information, or null of the processing is not in an error state
+    attr_accessor :error_information
+
+    # The current count of the number of records processed
+    attr_accessor :count_records_processed
+
+    # 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',
+        
+        :'owner' => :'owner',
+        
+        :'status' => :'status',
+        
+        :'date_created' => :'dateCreated',
+        
+        :'date_completed' => :'dateCompleted',
+        
+        :'download_uri' => :'downloadURI',
+        
+        :'error_information' => :'errorInformation',
+        
+        :'count_records_processed' => :'countRecordsProcessed',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'id' => :'String',
+        
+        :'name' => :'String',
+        
+        :'owner' => :'AddressableEntityRef',
+        
+        :'status' => :'String',
+        
+        :'date_created' => :'DateTime',
+        
+        :'date_completed' => :'DateTime',
+        
+        :'download_uri' => :'String',
+        
+        :'error_information' => :'ErrorBody',
+        
+        :'count_records_processed' => :'Integer',
+        
+        :'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?(:'owner')
+        
+        
+        self.owner = attributes[:'owner']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'status')
+        
+        
+        self.status = attributes[:'status']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'dateCreated')
+        
+        
+        self.date_created = attributes[:'dateCreated']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'dateCompleted')
+        
+        
+        self.date_completed = attributes[:'dateCompleted']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'downloadURI')
+        
+        
+        self.download_uri = attributes[:'downloadURI']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'errorInformation')
+        
+        
+        self.error_information = attributes[:'errorInformation']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'countRecordsProcessed')
+        
+        
+        self.count_records_processed = attributes[:'countRecordsProcessed']
+        
+      
+      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?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if @status.nil?
+        return false
+      end
+
+      
+      
+      allowed_values = ["Processing", "Failed", "Succeeded"]
+      if @status && !allowed_values.include?(@status)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      allowed_values = ["Processing", "Failed", "Succeeded"]
+      if status && !allowed_values.include?(status)
+        fail ArgumentError, "invalid value for 'status', must be one of #{allowed_values}."
+      end
+      @status = status
+    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 &&
+          owner == o.owner &&
+          status == o.status &&
+          date_created == o.date_created &&
+          date_completed == o.date_completed &&
+          download_uri == o.download_uri &&
+          error_information == o.error_information &&
+          count_records_processed == o.count_records_processed &&
+          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, owner, status, date_created, date_completed, download_uri, error_information, count_records_processed, 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