purecloudplatformclientv2 87.0.0 → 92.0.0

data/lib/purecloudplatformclientv2/models/coaching_notification.rb

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

data/lib/purecloudplatformclientv2/models/content_actions.rb

@@ -0,0 +1,309 @@
+=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
+  # User actions available on the content. All actions are optional and all actions are executed simultaneously.
+  class ContentActions
+    # A URL for a web page to redirect the user to
+    attr_accessor :url
+
+    # The target window or tab within the URL's web page. If empty will open a blank page or tab.
+    attr_accessor :url_target
+
+    # Text to be sent back in reply when a list item is selected
+    attr_accessor :textback
+
+    # Execute an organization's specific command
+    attr_accessor :command_name
+
+    # Additional context for the command
+    attr_accessor :context
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'url' => :'url',
+        
+        :'url_target' => :'urlTarget',
+        
+        :'textback' => :'textback',
+        
+        :'command_name' => :'commandName',
+        
+        :'context' => :'context'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'url' => :'String',
+        
+        :'url_target' => :'String',
+        
+        :'textback' => :'String',
+        
+        :'command_name' => :'String',
+        
+        :'context' => :'Hash<String, Object>'
+        
+      }
+    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?(:'url')
+        
+        
+        self.url = attributes[:'url']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'urlTarget')
+        
+        
+        self.url_target = attributes[:'urlTarget']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'textback')
+        
+        
+        self.textback = attributes[:'textback']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'commandName')
+        
+        
+        self.command_name = attributes[:'commandName']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'context')
+        
+        if (value = attributes[:'context']).is_a?(Array)
+          self.context = 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?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    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 &&
+          url == o.url &&
+          url_target == o.url_target &&
+          textback == o.textback &&
+          command_name == o.command_name &&
+          context == o.context
+    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
+      [url, url_target, textback, command_name, context].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/content_attachment.rb

@@ -0,0 +1,378 @@
+=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
+  # Attachment object
+  class ContentAttachment
+    # Vendor specific ID for media. For example, a LINE sticker ID
+    attr_accessor :id
+
+    # The type of media this instance represents
+    attr_accessor :media_type
+
+    # Content element url
+    attr_accessor :url
+
+    # Content mime type from https://www.iana.org/assignments/media-types/media-types.xhtml
+    attr_accessor :mime
+
+    # Text message associated with media element: e.g. caption in case of image.
+    attr_accessor :text
+
+    # Secure hash of the media content
+    attr_accessor :sha256
+
+    # Suggested file name for media file
+    attr_accessor :filename
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'id' => :'id',
+        
+        :'media_type' => :'mediaType',
+        
+        :'url' => :'url',
+        
+        :'mime' => :'mime',
+        
+        :'text' => :'text',
+        
+        :'sha256' => :'sha256',
+        
+        :'filename' => :'filename'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'id' => :'String',
+        
+        :'media_type' => :'String',
+        
+        :'url' => :'String',
+        
+        :'mime' => :'String',
+        
+        :'text' => :'String',
+        
+        :'sha256' => :'String',
+        
+        :'filename' => :'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?(:'mediaType')
+        
+        
+        self.media_type = attributes[:'mediaType']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'url')
+        
+        
+        self.url = attributes[:'url']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'mime')
+        
+        
+        self.mime = attributes[:'mime']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'text')
+        
+        
+        self.text = attributes[:'text']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'sha256')
+        
+        
+        self.sha256 = attributes[:'sha256']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'filename')
+        
+        
+        self.filename = attributes[:'filename']
+        
+      
+      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 @media_type.nil?
+        return false
+      end
+
+      
+      
+      allowed_values = ["Image", "Video", "Audio", "File"]
+      if @media_type && !allowed_values.include?(@media_type)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] media_type Object to be assigned
+    def media_type=(media_type)
+      allowed_values = ["Image", "Video", "Audio", "File"]
+      if media_type && !allowed_values.include?(media_type)
+        fail ArgumentError, "invalid value for 'media_type', must be one of #{allowed_values}."
+      end
+      @media_type = media_type
+    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 &&
+          media_type == o.media_type &&
+          url == o.url &&
+          mime == o.mime &&
+          text == o.text &&
+          sha256 == o.sha256 &&
+          filename == o.filename
+    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, media_type, url, mime, text, sha256, filename].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