purecloudplatformclientv2 91.0.0 → 96.0.0

data/lib/purecloudplatformclientv2/models/reporting_export_job_response.rb

@@ -23,6 +23,9 @@ module PureCloud
 
     attr_accessor :name
 
+    # The unique run id of the export schedule execute
+    attr_accessor :run_id
+
     # The current status of the export request
     attr_accessor :status
 
@@ -71,6 +74,12 @@ module PureCloud
     # Indicates if filters will be split in aggregate detail exports
     attr_accessor :has_split_filters
 
+    # Excludes empty rows from the exports
+    attr_accessor :exclude_empty_rows
+
+    # Indicates if media type will be split in aggregate detail exports
+    attr_accessor :has_split_by_media
+
     # The list of ordered selected columns from the export view by the user
     attr_accessor :selected_columns
 
@@ -83,6 +92,8 @@ module PureCloud
     # The status of individual email addresses as a map
     attr_accessor :email_statuses
 
+    attr_accessor :enabled
+
     # The URI for this object
     attr_accessor :self_uri
 
@@ -94,6 +105,8 @@ module PureCloud
         
         :'name' => :'name',
         
+        :'run_id' => :'runId',
+        
         :'status' => :'status',
         
         :'time_zone' => :'timeZone',
@@ -126,6 +139,10 @@ module PureCloud
         
         :'has_split_filters' => :'hasSplitFilters',
         
+        :'exclude_empty_rows' => :'excludeEmptyRows',
+        
+        :'has_split_by_media' => :'hasSplitByMedia',
+        
         :'selected_columns' => :'selectedColumns',
         
         :'has_custom_participant_attributes' => :'hasCustomParticipantAttributes',
@@ -134,6 +151,8 @@ module PureCloud
         
         :'email_statuses' => :'emailStatuses',
         
+        :'enabled' => :'enabled',
+        
         :'self_uri' => :'selfUri'
         
       }
@@ -147,6 +166,8 @@ module PureCloud
         
         :'name' => :'String',
         
+        :'run_id' => :'String',
+        
         :'status' => :'String',
         
         :'time_zone' => :'String',
@@ -179,6 +200,10 @@ module PureCloud
         
         :'has_split_filters' => :'BOOLEAN',
         
+        :'exclude_empty_rows' => :'BOOLEAN',
+        
+        :'has_split_by_media' => :'BOOLEAN',
+        
         :'selected_columns' => :'Array<SelectedColumns>',
         
         :'has_custom_participant_attributes' => :'BOOLEAN',
@@ -187,6 +212,8 @@ module PureCloud
         
         :'email_statuses' => :'Hash<String, String>',
         
+        :'enabled' => :'BOOLEAN',
+        
         :'self_uri' => :'String'
         
       }
@@ -219,6 +246,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'runId')
+        
+        
+        self.run_id = attributes[:'runId']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'status')
         
         
@@ -363,6 +399,24 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'excludeEmptyRows')
+        
+        
+        self.exclude_empty_rows = attributes[:'excludeEmptyRows']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'hasSplitByMedia')
+        
+        
+        self.has_split_by_media = attributes[:'hasSplitByMedia']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'selectedColumns')
         
         if (value = attributes[:'selectedColumns']).is_a?(Array)
@@ -405,6 +459,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'enabled')
+        
+        
+        self.enabled = attributes[:'enabled']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'selfUri')
         
         
@@ -438,6 +501,15 @@ module PureCloud
       
       
       
+      if @run_id.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
       if @status.nil?
         return false
       end
@@ -588,6 +660,18 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -615,6 +699,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
@@ -739,6 +828,21 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
     
     
     
@@ -762,6 +866,7 @@ module PureCloud
       self.class == o.class &&
           id == o.id &&
           name == o.name &&
+          run_id == o.run_id &&
           status == o.status &&
           time_zone == o.time_zone &&
           export_format == o.export_format &&
@@ -778,10 +883,13 @@ module PureCloud
           percentage_complete == o.percentage_complete &&
           has_format_durations == o.has_format_durations &&
           has_split_filters == o.has_split_filters &&
+          exclude_empty_rows == o.exclude_empty_rows &&
+          has_split_by_media == o.has_split_by_media &&
           selected_columns == o.selected_columns &&
           has_custom_participant_attributes == o.has_custom_participant_attributes &&
           recipient_emails == o.recipient_emails &&
           email_statuses == o.email_statuses &&
+          enabled == o.enabled &&
           self_uri == o.self_uri
     end
 
@@ -794,7 +902,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, status, time_zone, export_format, interval, download_url, view_type, export_error_messages_type, period, filter, read, created_date_time, modified_date_time, locale, percentage_complete, has_format_durations, has_split_filters, selected_columns, has_custom_participant_attributes, recipient_emails, email_statuses, self_uri].hash
+      [id, name, run_id, status, time_zone, export_format, interval, download_url, view_type, export_error_messages_type, period, filter, read, created_date_time, modified_date_time, locale, percentage_complete, has_format_durations, has_split_filters, exclude_empty_rows, has_split_by_media, selected_columns, has_custom_participant_attributes, recipient_emails, email_statuses, enabled, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/response.rb

@@ -327,7 +327,7 @@ module PureCloud
       
       
       
-      allowed_values = ["MessagingTemplate"]
+      allowed_values = ["MessagingTemplate", "CampaignSmsTemplate"]
       if @response_type && !allowed_values.include?(@response_type)
         return false
       end
@@ -408,7 +408,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] response_type Object to be assigned
     def response_type=(response_type)
-      allowed_values = ["MessagingTemplate"]
+      allowed_values = ["MessagingTemplate", "CampaignSmsTemplate"]
       if response_type && !allowed_values.include?(response_type)
         fail ArgumentError, "invalid value for 'response_type', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/schedule_generation_message.rb

@@ -92,7 +92,7 @@ module PureCloud
       
       
       
-      allowed_values = ["AgentNotFound", "AgentNotInSelectedManagementUnit", "AgentNotLicensed", "AgentWithoutWorkPlan", "WorkPlanNotEnabled", "WorkPlanNotFound", "AgentWithoutCapability", "NoNeedDays", "UnableToScheduleMaxConsecutiveWorkingDays", "UnableToScheduleMaxConsecutiveWorkingWeekends", "UnableToScheduleMaxWeeklyPaidTime", "UnableToScheduleMaxWeeklyWorkDays", "UnableToScheduleMaxWorkDayPaidTime", "UnableToScheduleMinConsecutiveNonWorkingTimePerWeek", "UnableToScheduleMinIntershiftTime", "UnableToScheduleMinShiftStartDistance", "UnableToScheduleMinWeeklyPaidTime", "UnableToScheduleMinWeeklyWorkDays", "UnableToScheduleMinWorkDayPaidTime", "UnableToSchedulePlanningPeriodMaxDaysOff", "UnableToSchedulePlanningPeriodMaxPaidTime", "UnableToSchedulePlanningPeriodMinDaysOff", "UnableToSchedulePlanningPeriodMinPaidTime", "UnableToScheduleShiftVariance", "UnableToScheduleWorkDay"]
+      allowed_values = ["AgentNotFound", "AgentNotInSelectedManagementUnit", "AgentNotLicensed", "AgentWithoutWorkPlan", "WorkPlanNotEnabled", "WorkPlanNotFound", "AgentWithoutCapability", "NoNeedDays", "UnableToProduceAgentSchedule", "UnableToScheduleMaxConsecutiveWorkingDays", "UnableToScheduleMaxConsecutiveWorkingWeekends", "UnableToScheduleMaxWeeklyPaidTime", "UnableToScheduleMaxWeeklyWorkDays", "UnableToScheduleMaxWorkDayPaidTime", "UnableToScheduleMinConsecutiveNonWorkingTimePerWeek", "UnableToScheduleMinIntershiftTime", "UnableToScheduleMinShiftStartDistance", "UnableToScheduleMinWeeklyPaidTime", "UnableToScheduleMinWeeklyWorkDays", "UnableToScheduleMinWorkDayPaidTime", "UnableToSchedulePlanningPeriodMaxDaysOff", "UnableToSchedulePlanningPeriodMaxPaidTime", "UnableToSchedulePlanningPeriodMinDaysOff", "UnableToSchedulePlanningPeriodMinPaidTime", "UnableToScheduleShiftVariance", "UnableToScheduleWorkDay"]
       if @type && !allowed_values.include?(@type)
         return false
       end
@@ -110,7 +110,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      allowed_values = ["AgentNotFound", "AgentNotInSelectedManagementUnit", "AgentNotLicensed", "AgentWithoutWorkPlan", "WorkPlanNotEnabled", "WorkPlanNotFound", "AgentWithoutCapability", "NoNeedDays", "UnableToScheduleMaxConsecutiveWorkingDays", "UnableToScheduleMaxConsecutiveWorkingWeekends", "UnableToScheduleMaxWeeklyPaidTime", "UnableToScheduleMaxWeeklyWorkDays", "UnableToScheduleMaxWorkDayPaidTime", "UnableToScheduleMinConsecutiveNonWorkingTimePerWeek", "UnableToScheduleMinIntershiftTime", "UnableToScheduleMinShiftStartDistance", "UnableToScheduleMinWeeklyPaidTime", "UnableToScheduleMinWeeklyWorkDays", "UnableToScheduleMinWorkDayPaidTime", "UnableToSchedulePlanningPeriodMaxDaysOff", "UnableToSchedulePlanningPeriodMaxPaidTime", "UnableToSchedulePlanningPeriodMinDaysOff", "UnableToSchedulePlanningPeriodMinPaidTime", "UnableToScheduleShiftVariance", "UnableToScheduleWorkDay"]
+      allowed_values = ["AgentNotFound", "AgentNotInSelectedManagementUnit", "AgentNotLicensed", "AgentWithoutWorkPlan", "WorkPlanNotEnabled", "WorkPlanNotFound", "AgentWithoutCapability", "NoNeedDays", "UnableToProduceAgentSchedule", "UnableToScheduleMaxConsecutiveWorkingDays", "UnableToScheduleMaxConsecutiveWorkingWeekends", "UnableToScheduleMaxWeeklyPaidTime", "UnableToScheduleMaxWeeklyWorkDays", "UnableToScheduleMaxWorkDayPaidTime", "UnableToScheduleMinConsecutiveNonWorkingTimePerWeek", "UnableToScheduleMinIntershiftTime", "UnableToScheduleMinShiftStartDistance", "UnableToScheduleMinWeeklyPaidTime", "UnableToScheduleMinWeeklyWorkDays", "UnableToScheduleMinWorkDayPaidTime", "UnableToSchedulePlanningPeriodMaxDaysOff", "UnableToSchedulePlanningPeriodMaxPaidTime", "UnableToSchedulePlanningPeriodMinDaysOff", "UnableToSchedulePlanningPeriodMinPaidTime", "UnableToScheduleShiftVariance", "UnableToScheduleWorkDay"]
       if type && !allowed_values.include?(type)
         fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/scim_config_resource_type.rb

@@ -19,7 +19,7 @@ require 'date'
 module PureCloud
   # Defines a SCIM resource.
   class ScimConfigResourceType
-    # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"Mutability\" is set to \"readOnly\". \"Returned\" is set to \"always\".
+    # The ID of the SCIM resource. Set by the service provider. \"caseExact\" is set to \"true\". \"mutability\" is set to \"readOnly\". \"returned\" is set to \"always\".
     attr_accessor :id
 
     # The list of supported schemas.
@@ -40,7 +40,7 @@ module PureCloud
     # The HTTP-addressable endpoint of the resource type. Appears after the base URL.
     attr_accessor :endpoint
 
-    # The metadata of the SCIM resource.
+    # The metadata of the SCIM resource. Only location and resourceType are set for ResourceType resources.
     attr_accessor :meta
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/purecloudplatformclientv2/models/scim_genesys_user_external_id.rb

@@ -0,0 +1,229 @@
+=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
+  # External Identifiers of user. The external identifier must be unique within the organization and the 'authority'
+  class ScimGenesysUserExternalId
+    # Authority, or scope, of the external id.  Allows multiple external ids to be defined and should represent the source of the external identifier
+    attr_accessor :authority
+
+    # Identifier of the user in an external system.
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'authority' => :'authority',
+        
+        :'value' => :'value'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'authority' => :'String',
+        
+        :'value' => :'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?(:'authority')
+        
+        
+        self.authority = attributes[:'authority']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'value')
+        
+        
+        self.value = attributes[:'value']
+        
+      
+      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?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    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 &&
+          authority == o.authority &&
+          value == o.value
+    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
+      [authority, value].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