purecloudplatformclientv2 3.1.7 → 4.0.0

data/lib/purecloudplatformclientv2/models/prompt_notification_notification_current_operation.rb

@@ -0,0 +1,280 @@
+=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@inin.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 PromptNotificationNotificationCurrentOperation
+    attr_accessor :id
+
+    attr_accessor :complete
+
+    attr_accessor :user
+
+    attr_accessor :action_name
+
+    attr_accessor :action_status
+
+    attr_accessor :error_message
+
+    attr_accessor :error_code
+
+    attr_accessor :error_message_params
+
+    attr_accessor :error_details
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'complete' => :'complete',
+        :'user' => :'user',
+        :'action_name' => :'actionName',
+        :'action_status' => :'actionStatus',
+        :'error_message' => :'errorMessage',
+        :'error_code' => :'errorCode',
+        :'error_message_params' => :'errorMessageParams',
+        :'error_details' => :'errorDetails'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'complete' => :'BOOLEAN',
+        :'user' => :'DependencyTrackingBuildNotificationNotificationUser',
+        :'action_name' => :'String',
+        :'action_status' => :'String',
+        :'error_message' => :'String',
+        :'error_code' => :'String',
+        :'error_message_params' => :'PromptNotificationNotificationCurrentOperationErrorMessageParams',
+        :'error_details' => :'Array<PromptNotificationNotificationCurrentOperationErrorDetails>'
+      }
+    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?(:'complete')
+        self.complete = attributes[:'complete']
+      end
+
+      if attributes.has_key?(:'user')
+        self.user = attributes[:'user']
+      end
+
+      if attributes.has_key?(:'actionName')
+        self.action_name = attributes[:'actionName']
+      end
+
+      if attributes.has_key?(:'actionStatus')
+        self.action_status = attributes[:'actionStatus']
+      end
+
+      if attributes.has_key?(:'errorMessage')
+        self.error_message = attributes[:'errorMessage']
+      end
+
+      if attributes.has_key?(:'errorCode')
+        self.error_code = attributes[:'errorCode']
+      end
+
+      if attributes.has_key?(:'errorMessageParams')
+        self.error_message_params = attributes[:'errorMessageParams']
+      end
+
+      if attributes.has_key?(:'errorDetails')
+        if (value = attributes[:'errorDetails']).is_a?(Array)
+          self.error_details = 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?
+      allowed_values = ["CHECKIN", "DEBUG", "DELETE", "PUBLISH", "STATE_CHANGE", "VALIDATE"]
+      if @action_name && !allowed_values.include?(@action_name)
+        return false
+      end
+      allowed_values = ["LOCKED", "UNLOCKED", "STARTED", "PENDING_GENERATION", "PENDING_BACKEND_NOTIFICATION", "SUCCESS", "FAILURE"]
+      if @action_status && !allowed_values.include?(@action_status)
+        return false
+      end
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action_name Object to be assigned
+    def action_name=(action_name)
+      allowed_values = ["CHECKIN", "DEBUG", "DELETE", "PUBLISH", "STATE_CHANGE", "VALIDATE"]
+      if action_name && !allowed_values.include?(action_name)
+        fail ArgumentError, "invalid value for 'action_name', must be one of #{allowed_values}."
+      end
+      @action_name = action_name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action_status Object to be assigned
+    def action_status=(action_status)
+      allowed_values = ["LOCKED", "UNLOCKED", "STARTED", "PENDING_GENERATION", "PENDING_BACKEND_NOTIFICATION", "SUCCESS", "FAILURE"]
+      if action_status && !allowed_values.include?(action_status)
+        fail ArgumentError, "invalid value for 'action_status', must be one of #{allowed_values}."
+      end
+      @action_status = action_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 &&
+          complete == o.complete &&
+          user == o.user &&
+          action_name == o.action_name &&
+          action_status == o.action_status &&
+          error_message == o.error_message &&
+          error_code == o.error_code &&
+          error_message_params == o.error_message_params &&
+          error_details == o.error_details
+    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, complete, user, action_name, action_status, error_message, error_code, error_message_params, error_details].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/prompt_notification_notification_current_operation_error_details.rb

@@ -0,0 +1,205 @@
+=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@inin.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 PromptNotificationNotificationCurrentOperationErrorDetails
+    attr_accessor :error_code
+
+    attr_accessor :entity_id
+
+    attr_accessor :entity_name
+
+    attr_accessor :field_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error_code' => :'errorCode',
+        :'entity_id' => :'entityId',
+        :'entity_name' => :'entityName',
+        :'field_name' => :'fieldName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'error_code' => :'String',
+        :'entity_id' => :'String',
+        :'entity_name' => :'String',
+        :'field_name' => :'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?(:'errorCode')
+        self.error_code = attributes[:'errorCode']
+      end
+
+      if attributes.has_key?(:'entityId')
+        self.entity_id = attributes[:'entityId']
+      end
+
+      if attributes.has_key?(:'entityName')
+        self.entity_name = attributes[:'entityName']
+      end
+
+      if attributes.has_key?(:'fieldName')
+        self.field_name = attributes[:'fieldName']
+      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 &&
+          error_code == o.error_code &&
+          entity_id == o.entity_id &&
+          entity_name == o.entity_name &&
+          field_name == o.field_name
+    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
+      [error_code, entity_id, entity_name, field_name].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