purecloudplatformclientv2 17.0.0 → 18.0.0

data/lib/purecloudplatformclientv2/models/phone.rb

@@ -24,24 +24,31 @@ module PureCloud
     # The name of the entity.
     attr_accessor :name
 
+    # The resource's description.
     attr_accessor :description
 
+    # The current version of the resource.
     attr_accessor :version
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
+    # The ID of the user that last modified the resource.
     attr_accessor :modified_by
 
+    # The ID of the user that created the resource.
     attr_accessor :created_by
 
+    # Indicates if the resource is active, inactive, or deleted.
     attr_accessor :state
 
+    # The application that last modified the resource.
     attr_accessor :modified_by_app
 
+    # The application that created the resource.
     attr_accessor :created_by_app
 
     # The site associated to the phone.

data/lib/purecloudplatformclientv2/models/phone_base.rb

@@ -24,24 +24,31 @@ module PureCloud
     # The name of the entity.
     attr_accessor :name
 
+    # The resource's description.
     attr_accessor :description
 
+    # The current version of the resource.
     attr_accessor :version
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
+    # The ID of the user that last modified the resource.
     attr_accessor :modified_by
 
+    # The ID of the user that created the resource.
     attr_accessor :created_by
 
+    # Indicates if the resource is active, inactive, or deleted.
     attr_accessor :state
 
+    # The application that last modified the resource.
     attr_accessor :modified_by_app
 
+    # The application that created the resource.
     attr_accessor :created_by_app
 
     # A phone metabase is essentially a database for storing phone configuration settings, which simplifies the configuration process.

data/lib/purecloudplatformclientv2/models/queue.rb

@@ -23,24 +23,31 @@ module PureCloud
 
     attr_accessor :name
 
+    # The resource's description.
     attr_accessor :description
 
+    # The current version of the resource.
     attr_accessor :version
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
+    # The ID of the user that last modified the resource.
     attr_accessor :modified_by
 
+    # The ID of the user that created the resource.
     attr_accessor :created_by
 
+    # Indicates if the resource is active, inactive, or deleted.
     attr_accessor :state
 
+    # The application that last modified the resource.
     attr_accessor :modified_by_app
 
+    # The application that created the resource.
     attr_accessor :created_by_app
 
     # The media settings for the queue. Valid Key Values: CALL, CALLBACK, CHAT, EMAIL, SOCIAL_EXPRESSION

data/lib/purecloudplatformclientv2/models/recording.rb

@@ -469,7 +469,7 @@ module PureCloud
       
       
       
-      allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING"]
+      allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING", "ERROR"]
       if @file_state && !allowed_values.include?(@file_state)
         return false
       end
@@ -586,7 +586,7 @@ module PureCloud
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] file_state Object to be assigned
     def file_state=(file_state)
-      allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING"]
+      allowed_values = ["ARCHIVED", "AVAILABLE", "DELETED", "RESTORED", "RESTORING", "UPLOADING", "ERROR"]
       if file_state && !allowed_values.include?(file_state)
         fail ArgumentError, "invalid value for 'file_state', must be one of #{allowed_values}."
       end

data/lib/purecloudplatformclientv2/models/schedule.rb

@@ -22,26 +22,34 @@ module PureCloud
     # The globally unique identifier for the object.
     attr_accessor :id
 
+    # The name of the entity.
     attr_accessor :name
 
+    # The resource's description.
     attr_accessor :description
 
+    # The current version of the resource.
     attr_accessor :version
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
+    # The ID of the user that last modified the resource.
     attr_accessor :modified_by
 
+    # The ID of the user that created the resource.
     attr_accessor :created_by
 
+    # Indicates if the resource is active, inactive, or deleted.
     attr_accessor :state
 
+    # The application that last modified the resource.
     attr_accessor :modified_by_app
 
+    # The application that created the resource.
     attr_accessor :created_by_app
 
     # Date time is represented as an ISO-8601 string without a timezone. For example: yyyy-MM-ddTHH:mm:ss.SSS
@@ -294,6 +302,11 @@ module PureCloud
       
       
       
+      if @name.nil?
+        return false
+      end
+
+      
       
       
       

data/lib/purecloudplatformclientv2/models/schedule_group.rb

@@ -22,26 +22,34 @@ module PureCloud
     # The globally unique identifier for the object.
     attr_accessor :id
 
+    # The name of the entity.
     attr_accessor :name
 
+    # The resource's description.
     attr_accessor :description
 
+    # The current version of the resource.
     attr_accessor :version
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
+    # The ID of the user that last modified the resource.
     attr_accessor :modified_by
 
+    # The ID of the user that created the resource.
     attr_accessor :created_by
 
+    # Indicates if the resource is active, inactive, or deleted.
     attr_accessor :state
 
+    # The application that last modified the resource.
     attr_accessor :modified_by_app
 
+    # The application that created the resource.
     attr_accessor :created_by_app
 
     # The timezone the schedules are a part of.  This is not a schedule property to allow a schedule to be used in multiple timezones.
@@ -298,6 +306,11 @@ module PureCloud
       
       
       
+      if @name.nil?
+        return false
+      end
+
+      
       
       
       

data/lib/purecloudplatformclientv2/models/schema_category.rb

@@ -24,24 +24,31 @@ module PureCloud
     # The name of the entity.
     attr_accessor :name
 
+    # The resource's description.
     attr_accessor :description
 
+    # The current version of the resource.
     attr_accessor :version
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
+    # The ID of the user that last modified the resource.
     attr_accessor :modified_by
 
+    # The ID of the user that created the resource.
     attr_accessor :created_by
 
+    # Indicates if the resource is active, inactive, or deleted.
     attr_accessor :state
 
+    # The application that last modified the resource.
     attr_accessor :modified_by_app
 
+    # The application that created the resource.
     attr_accessor :created_by_app
 
     # The URI for this object

data/lib/purecloudplatformclientv2/models/site.rb

@@ -24,24 +24,31 @@ module PureCloud
     # The name of the entity.
     attr_accessor :name
 
+    # The resource's description.
     attr_accessor :description
 
+    # The current version of the resource.
     attr_accessor :version
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
+    # The ID of the user that last modified the resource.
     attr_accessor :modified_by
 
+    # The ID of the user that created the resource.
     attr_accessor :created_by
 
+    # Indicates if the resource is active, inactive, or deleted.
     attr_accessor :state
 
+    # The application that last modified the resource.
     attr_accessor :modified_by_app
 
+    # The application that created the resource.
     attr_accessor :created_by_app
 
     attr_accessor :primary_sites

data/lib/purecloudplatformclientv2/models/trunk.rb

@@ -24,24 +24,31 @@ module PureCloud
     # The name of the entity.
     attr_accessor :name
 
+    # The resource's description.
     attr_accessor :description
 
+    # The current version of the resource.
     attr_accessor :version
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
+    # The ID of the user that last modified the resource.
     attr_accessor :modified_by
 
+    # The ID of the user that created the resource.
     attr_accessor :created_by
 
+    # Indicates if the resource is active, inactive, or deleted.
     attr_accessor :state
 
+    # The application that last modified the resource.
     attr_accessor :modified_by_app
 
+    # The application that created the resource.
     attr_accessor :created_by_app
 
     # The type of this trunk.

data/lib/purecloudplatformclientv2/models/trunk_base.rb

@@ -24,24 +24,31 @@ module PureCloud
     # The name of the entity.
     attr_accessor :name
 
+    # The resource's description.
     attr_accessor :description
 
+    # The current version of the resource.
     attr_accessor :version
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_created
 
-    # Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    # The date of the last modification to the resource. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
     attr_accessor :date_modified
 
+    # The ID of the user that last modified the resource.
     attr_accessor :modified_by
 
+    # The ID of the user that created the resource.
     attr_accessor :created_by
 
+    # Indicates if the resource is active, inactive, or deleted.
     attr_accessor :state
 
+    # The application that last modified the resource.
     attr_accessor :modified_by_app
 
+    # The application that created the resource.
     attr_accessor :created_by_app
 
     # The meta-base this trunk is based on.

data/lib/purecloudplatformclientv2/models/user_device.rb

@@ -0,0 +1,478 @@
+=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: ININ
+http://www.inin.com
+
+Terms of Service: https://developer.mypurecloud.com/tos
+
+=end
+
+require 'date'
+
+module PureCloud
+  class UserDevice
+    # The globally unique identifier for the object.
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # device token sent by mobile clients.
+    attr_accessor :device_token
+
+    # notification id of the device.
+    attr_accessor :notification_id
+
+    # make of the device.
+    attr_accessor :make
+
+    # Device model
+    attr_accessor :model
+
+    # if the device accepts notifications
+    attr_accessor :accept_notifications
+
+    # type of the device; ios or android
+    attr_accessor :type
+
+    attr_accessor :session_hash
+
+    # 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',
+        
+        :'device_token' => :'deviceToken',
+        
+        :'notification_id' => :'notificationId',
+        
+        :'make' => :'make',
+        
+        :'model' => :'model',
+        
+        :'accept_notifications' => :'acceptNotifications',
+        
+        :'type' => :'type',
+        
+        :'session_hash' => :'sessionHash',
+        
+        :'self_uri' => :'selfUri'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'id' => :'String',
+        
+        :'name' => :'String',
+        
+        :'device_token' => :'String',
+        
+        :'notification_id' => :'String',
+        
+        :'make' => :'String',
+        
+        :'model' => :'String',
+        
+        :'accept_notifications' => :'BOOLEAN',
+        
+        :'type' => :'String',
+        
+        :'session_hash' => :'String',
+        
+        :'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?(:'deviceToken')
+        
+        
+        self.device_token = attributes[:'deviceToken']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'notificationId')
+        
+        
+        self.notification_id = attributes[:'notificationId']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'make')
+        
+        
+        self.make = attributes[:'make']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'model')
+        
+        
+        self.model = attributes[:'model']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'acceptNotifications')
+        
+        
+        self.accept_notifications = attributes[:'acceptNotifications']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'type')
+        
+        
+        self.type = attributes[:'type']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'sessionHash')
+        
+        
+        self.session_hash = attributes[:'sessionHash']
+        
+      
+      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 @device_token.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @notification_id.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @make.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @model.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @accept_notifications.nil?
+        return false
+      end
+
+      
+      
+      
+      
+      
+      if @type.nil?
+        return false
+      end
+
+      
+      
+      allowed_values = ["android", "ios"]
+      if @type && !allowed_values.include?(@type)
+        return false
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+    end
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      allowed_values = ["android", "ios"]
+      if type && !allowed_values.include?(type)
+        fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
+      end
+      @type = 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 &&
+          name == o.name &&
+          device_token == o.device_token &&
+          notification_id == o.notification_id &&
+          make == o.make &&
+          model == o.model &&
+          accept_notifications == o.accept_notifications &&
+          type == o.type &&
+          session_hash == o.session_hash &&
+          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, device_token, notification_id, make, model, accept_notifications, type, session_hash, 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