purecloudplatformclientv2 75.1.0 → 79.0.0

data/lib/purecloudplatformclientv2/models/bu_schedule_reference.rb

@@ -0,0 +1,254 @@
+=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
+  class BuScheduleReference
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    # The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
+    attr_accessor :week_date
+
+    # 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',
+        
+        :'week_date' => :'weekDate',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'id' => :'String',
+        
+        :'week_date' => :'Date',
+        
+        :'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?(:'weekDate')
+        
+        
+        self.week_date = attributes[:'weekDate']
+        
+      
+      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?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    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 &&
+          week_date == o.week_date &&
+          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, week_date, 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/purecloudplatformclientv2/models/call.rb

@@ -173,7 +173,7 @@ module PureCloud
         
         :'segments' => :'Array<Segment>',
         
-        :'error_info' => :'ErrorBody',
+        :'error_info' => :'ErrorInfo',
         
         :'disconnect_type' => :'String',
         

data/lib/purecloudplatformclientv2/models/call_basic.rb

@@ -173,7 +173,7 @@ module PureCloud
         
         :'segments' => :'Array<Segment>',
         
-        :'error_info' => :'ErrorBody',
+        :'error_info' => :'ErrorInfo',
         
         :'disconnect_type' => :'String',
         

data/lib/purecloudplatformclientv2/models/call_media_participant.rb

@@ -283,7 +283,7 @@ module PureCloud
         
         :'attributes' => :'Hash<String, String>',
         
-        :'error_info' => :'ErrorBody',
+        :'error_info' => :'ErrorInfo',
         
         :'script' => :'DomainEntityRef',
         

data/lib/purecloudplatformclientv2/models/callback_media_participant.rb

@@ -263,7 +263,7 @@ module PureCloud
         
         :'attributes' => :'Hash<String, String>',
         
-        :'error_info' => :'ErrorBody',
+        :'error_info' => :'ErrorInfo',
         
         :'script' => :'DomainEntityRef',
         

data/lib/purecloudplatformclientv2/models/campaign_progress.rb

@@ -24,9 +24,12 @@ module PureCloud
     # Identifier of the contact list
     attr_accessor :contact_list
 
-    # Number of contacts processed during the campaign
+    # Number of contacts called during the campaign
     attr_accessor :number_of_contacts_called
 
+    # Number of contacts messaged during the campaign
+    attr_accessor :number_of_contacts_messaged
+
     # Total number of contacts in the campaign
     attr_accessor :total_number_of_contacts
 
@@ -43,6 +46,8 @@ module PureCloud
         
         :'number_of_contacts_called' => :'numberOfContactsCalled',
         
+        :'number_of_contacts_messaged' => :'numberOfContactsMessaged',
+        
         :'total_number_of_contacts' => :'totalNumberOfContacts',
         
         :'percentage' => :'percentage'
@@ -60,6 +65,8 @@ module PureCloud
         
         :'number_of_contacts_called' => :'Integer',
         
+        :'number_of_contacts_messaged' => :'Integer',
+        
         :'total_number_of_contacts' => :'Integer',
         
         :'percentage' => :'Integer'
@@ -103,6 +110,15 @@ module PureCloud
       end
 
       
+      if attributes.has_key?(:'numberOfContactsMessaged')
+        
+        
+        self.number_of_contacts_messaged = attributes[:'numberOfContactsMessaged']
+        
+      
+      end
+
+      
       if attributes.has_key?(:'totalNumberOfContacts')
         
         
@@ -165,6 +181,10 @@ module PureCloud
       
       
       
+      
+      
+      
+      
       
     end
 
@@ -188,6 +208,11 @@ module PureCloud
     
     
     
+    
+    
+    
+    
+    
     
     
     
@@ -202,6 +227,7 @@ module PureCloud
           campaign == o.campaign &&
           contact_list == o.contact_list &&
           number_of_contacts_called == o.number_of_contacts_called &&
+          number_of_contacts_messaged == o.number_of_contacts_messaged &&
           total_number_of_contacts == o.total_number_of_contacts &&
           percentage == o.percentage
     end
@@ -215,7 +241,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [campaign, contact_list, number_of_contacts_called, total_number_of_contacts, percentage].hash
+      [campaign, contact_list, number_of_contacts_called, number_of_contacts_messaged, total_number_of_contacts, percentage].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/chat_media_participant.rb

@@ -233,7 +233,7 @@ module PureCloud
         
         :'attributes' => :'Hash<String, String>',
         
-        :'error_info' => :'ErrorBody',
+        :'error_info' => :'ErrorInfo',
         
         :'script' => :'DomainEntityRef',
         

data/lib/purecloudplatformclientv2/models/cobrowse_media_participant.rb

@@ -248,7 +248,7 @@ module PureCloud
         
         :'attributes' => :'Hash<String, String>',
         
-        :'error_info' => :'ErrorBody',
+        :'error_info' => :'ErrorInfo',
         
         :'script' => :'DomainEntityRef',
         

data/lib/purecloudplatformclientv2/models/conversation_aggregate_query_predicate.rb

@@ -147,7 +147,7 @@ module PureCloud
       
       
       
-      allowed_values = ["addressFrom", "addressTo", "agentScore", "ani", "conversationId", "convertedFrom", "convertedTo", "direction", "disconnectType", "divisionId", "dnis", "edgeId", "externalMediaCount", "externalOrganizationId", "flaggedReason", "flowOutType", "groupId", "interactionType", "journeyActionId", "journeyActionMapId", "journeyActionMapVersion", "journeyCustomerId", "journeyCustomerIdType", "journeyCustomerSessionId", "journeyCustomerSessionIdType", "mediaCount", "mediaType", "messageType", "originatingDirection", "outboundCampaignId", "outboundContactId", "outboundContactListId", "participantName", "peerId", "provider", "purpose", "queueId", "remote", "requestedLanguageId", "requestedRoutingSkillId", "roomId", "routingPriority", "scoredAgentId", "sessionDnis", "sessionId", "stationId", "userId", "wrapUpCode"]
+      allowed_values = ["addressFrom", "addressTo", "agentScore", "ani", "conversationId", "convertedFrom", "convertedTo", "direction", "disconnectType", "divisionId", "dnis", "edgeId", "externalMediaCount", "externalOrganizationId", "flaggedReason", "flowOutType", "groupId", "interactionType", "journeyActionId", "journeyActionMapId", "journeyActionMapVersion", "journeyCustomerId", "journeyCustomerIdType", "journeyCustomerSessionId", "journeyCustomerSessionIdType", "mediaCount", "mediaType", "messageType", "originatingDirection", "outboundCampaignId", "outboundContactId", "outboundContactListId", "participantName", "peerId", "provider", "purpose", "queueId", "remote", "requestedLanguageId", "requestedRoutingSkillId", "roomId", "routingPriority", "scoredAgentId", "sessionDnis", "sessionId", "stationId", "teamId", "userId", "wrapUpCode"]
       if @dimension && !allowed_values.include?(@dimension)
         return false
       end
@@ -192,7 +192,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] dimension Object to be assigned
     def dimension=(dimension)
-      allowed_values = ["addressFrom", "addressTo", "agentScore", "ani", "conversationId", "convertedFrom", "convertedTo", "direction", "disconnectType", "divisionId", "dnis", "edgeId", "externalMediaCount", "externalOrganizationId", "flaggedReason", "flowOutType", "groupId", "interactionType", "journeyActionId", "journeyActionMapId", "journeyActionMapVersion", "journeyCustomerId", "journeyCustomerIdType", "journeyCustomerSessionId", "journeyCustomerSessionIdType", "mediaCount", "mediaType", "messageType", "originatingDirection", "outboundCampaignId", "outboundContactId", "outboundContactListId", "participantName", "peerId", "provider", "purpose", "queueId", "remote", "requestedLanguageId", "requestedRoutingSkillId", "roomId", "routingPriority", "scoredAgentId", "sessionDnis", "sessionId", "stationId", "userId", "wrapUpCode"]
+      allowed_values = ["addressFrom", "addressTo", "agentScore", "ani", "conversationId", "convertedFrom", "convertedTo", "direction", "disconnectType", "divisionId", "dnis", "edgeId", "externalMediaCount", "externalOrganizationId", "flaggedReason", "flowOutType", "groupId", "interactionType", "journeyActionId", "journeyActionMapId", "journeyActionMapVersion", "journeyCustomerId", "journeyCustomerIdType", "journeyCustomerSessionId", "journeyCustomerSessionIdType", "mediaCount", "mediaType", "messageType", "originatingDirection", "outboundCampaignId", "outboundContactId", "outboundContactListId", "participantName", "peerId", "provider", "purpose", "queueId", "remote", "requestedLanguageId", "requestedRoutingSkillId", "roomId", "routingPriority", "scoredAgentId", "sessionDnis", "sessionId", "stationId", "teamId", "userId", "wrapUpCode"]
       if dimension && !allowed_values.include?(dimension)
         fail ArgumentError, "invalid value for 'dimension', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/copy_attachments_request.rb

@@ -0,0 +1,240 @@
+=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
+  class CopyAttachmentsRequest
+    # A reference to the email message within the current conversation that owns the attachments to be copied
+    attr_accessor :source_message
+
+    # A list of attachments that will be copied from the source message to the current draft
+    attr_accessor :attachments
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'source_message' => :'sourceMessage',
+        
+        :'attachments' => :'attachments'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'source_message' => :'DomainEntityRef',
+        
+        :'attachments' => :'Array<Attachment>'
+        
+      }
+    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?(:'sourceMessage')
+        
+        
+        self.source_message = attributes[:'sourceMessage']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'attachments')
+        
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+        
+        
+      
+      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 @source_message.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @attachments.nil?
+        return false
+      end
+
+      
+      
+      
+      
+    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 &&
+          source_message == o.source_message &&
+          attachments == o.attachments
+    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
+      [source_message, attachments].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