purecloud 0.45.1 → 0.46.1

data/lib/purecloud/models/flow_report_result_item.rb

@@ -1,299 +0,0 @@
-=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
-  # Report for one active (running) process found in result to a report request.
-  class FlowReportResultItem
-    # The flow instance ID for this process
-    attr_accessor :flow_exec_id
-
-    # The flow config ID that this workitem was created from.
-    attr_accessor :flow_config_id
-
-    # The instance name for this flow in relation to its primary document.  If the flow is not a document-centric type, this value will be empty.
-    attr_accessor :flow_instance_name
-
-    # the document for this flow (if this flow was launched via a document)
-    attr_accessor :associated_document
-
-    # The flow's running status, which indicates whether the flow is running normally or in error, etc;
-    attr_accessor :flow_status
-
-    # The current state of the flow (EG what action is being processed)
-    attr_accessor :current_state
-
-    # The time the flow was started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
-    attr_accessor :start_date_time
-
-    # The time the flow ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
-    attr_accessor :end_date_time
-
-    # List of users currently assigned to a workItem
-    attr_accessor :work_item_user_assignees
-
-    # User that completed the flow
-    attr_accessor :completed_user
-
-    # Reason for completion
-    attr_accessor :completion_reason
-
-    # Additional information if the flow is in error
-    attr_accessor :flow_error_info
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        
-        :'flow_exec_id' => :'flowExecId',
-        
-        :'flow_config_id' => :'flowConfigId',
-        
-        :'flow_instance_name' => :'flowInstanceName',
-        
-        :'associated_document' => :'associatedDocument',
-        
-        :'flow_status' => :'flowStatus',
-        
-        :'current_state' => :'currentState',
-        
-        :'start_date_time' => :'startDateTime',
-        
-        :'end_date_time' => :'endDateTime',
-        
-        :'work_item_user_assignees' => :'workItemUserAssignees',
-        
-        :'completed_user' => :'completedUser',
-        
-        :'completion_reason' => :'completionReason',
-        
-        :'flow_error_info' => :'flowErrorInfo'
-        
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'flow_exec_id' => :'FlowExecId',
-        :'flow_config_id' => :'FlowConfigId',
-        :'flow_instance_name' => :'String',
-        :'associated_document' => :'AssociatedDocument',
-        :'flow_status' => :'String',
-        :'current_state' => :'String',
-        :'start_date_time' => :'DateTime',
-        :'end_date_time' => :'DateTime',
-        :'work_item_user_assignees' => :'Array<User>',
-        :'completed_user' => :'User',
-        :'completion_reason' => :'String',
-        :'flow_error_info' => :'ErrorBody'
-        
-      }
-    end
-
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-
-      
-      if attributes[:'flowExecId']
-        self.flow_exec_id = attributes[:'flowExecId']
-      end
-      
-      if attributes[:'flowConfigId']
-        self.flow_config_id = attributes[:'flowConfigId']
-      end
-      
-      if attributes[:'flowInstanceName']
-        self.flow_instance_name = attributes[:'flowInstanceName']
-      end
-      
-      if attributes[:'associatedDocument']
-        self.associated_document = attributes[:'associatedDocument']
-      end
-      
-      if attributes[:'flowStatus']
-        self.flow_status = attributes[:'flowStatus']
-      end
-      
-      if attributes[:'currentState']
-        self.current_state = attributes[:'currentState']
-      end
-      
-      if attributes[:'startDateTime']
-        self.start_date_time = attributes[:'startDateTime']
-      end
-      
-      if attributes[:'endDateTime']
-        self.end_date_time = attributes[:'endDateTime']
-      end
-      
-      if attributes[:'workItemUserAssignees']
-        if (value = attributes[:'workItemUserAssignees']).is_a?(Array)
-          self.work_item_user_assignees = value
-        end
-      end
-      
-      if attributes[:'completedUser']
-        self.completed_user = attributes[:'completedUser']
-      end
-      
-      if attributes[:'completionReason']
-        self.completion_reason = attributes[:'completionReason']
-      end
-      
-      if attributes[:'flowErrorInfo']
-        self.flow_error_info = attributes[:'flowErrorInfo']
-      end
-      
-    end
-
-    # Custom attribute writer method checking allowed values (enum).
-    def flow_status=(flow_status)
-      allowed_values = ["UNKNOWN", "RUNNING", "ERROR", "TERMINATED", "COMPLETED"]
-      if flow_status && !allowed_values.include?(flow_status)
-        fail "invalid value for 'flow_status', must be one of #{allowed_values}"
-      end
-      @flow_status = flow_status
-    end
-
-    # Check equality by comparing each attribute.
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          flow_exec_id == o.flow_exec_id &&
-          flow_config_id == o.flow_config_id &&
-          flow_instance_name == o.flow_instance_name &&
-          associated_document == o.associated_document &&
-          flow_status == o.flow_status &&
-          current_state == o.current_state &&
-          start_date_time == o.start_date_time &&
-          end_date_time == o.end_date_time &&
-          work_item_user_assignees == o.work_item_user_assignees &&
-          completed_user == o.completed_user &&
-          completion_reason == o.completion_reason &&
-          flow_error_info == o.flow_error_info
-    end
-
-    # @see the `==` method
-    def eql?(o)
-      self == o
-    end
-
-    # Calculate hash code according to all attributes.
-    def hash
-      [flow_exec_id, flow_config_id, flow_instance_name, associated_document, flow_status, current_state, start_date_time, end_date_time, work_item_user_assignees, completed_user, completion_reason, flow_error_info].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/purecloud/models/flow_search_request.rb

@@ -1,241 +0,0 @@
-=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
-  # Used to perform a search on various data stored in search engines
-  class FlowSearchRequest
-    # The search text to look for
-    attr_accessor :search_phrase
-
-    # The pageNumber to get results from (EG If there are 100 results with a pageSize of 10 and pageNumber is 3 then 10 results will be returned starting with index #31
-    attr_accessor :page_number
-
-    # Number of entries to return/calculate per page.
-    attr_accessor :page_size
-
-    # The fields to limit the searchPhrase search to
-    attr_accessor :search_fields
-
-    # List of facet requests to generate summary views from the search result set (if any)
-    attr_accessor :facet_requests
-
-    # sort the results on a field(s)
-    attr_accessor :sort
-
-    # You can also restrict the search to particular field values and ranges
-    attr_accessor :filters
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        
-        :'search_phrase' => :'searchPhrase',
-        
-        :'page_number' => :'pageNumber',
-        
-        :'page_size' => :'pageSize',
-        
-        :'search_fields' => :'searchFields',
-        
-        :'facet_requests' => :'facetRequests',
-        
-        :'sort' => :'sort',
-        
-        :'filters' => :'filters'
-        
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'search_phrase' => :'String',
-        :'page_number' => :'Integer',
-        :'page_size' => :'Integer',
-        :'search_fields' => :'Array<String>',
-        :'facet_requests' => :'Array<FacetRequest>',
-        :'sort' => :'Array<SortField>',
-        :'filters' => :'Array<FilterItem>'
-        
-      }
-    end
-
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-
-      # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
-
-      
-      if attributes[:'searchPhrase']
-        self.search_phrase = attributes[:'searchPhrase']
-      end
-      
-      if attributes[:'pageNumber']
-        self.page_number = attributes[:'pageNumber']
-      end
-      
-      if attributes[:'pageSize']
-        self.page_size = attributes[:'pageSize']
-      end
-      
-      if attributes[:'searchFields']
-        if (value = attributes[:'searchFields']).is_a?(Array)
-          self.search_fields = value
-        end
-      end
-      
-      if attributes[:'facetRequests']
-        if (value = attributes[:'facetRequests']).is_a?(Array)
-          self.facet_requests = value
-        end
-      end
-      
-      if attributes[:'sort']
-        if (value = attributes[:'sort']).is_a?(Array)
-          self.sort = value
-        end
-      end
-      
-      if attributes[:'filters']
-        if (value = attributes[:'filters']).is_a?(Array)
-          self.filters = value
-        end
-      end
-      
-    end
-
-    # Check equality by comparing each attribute.
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          search_phrase == o.search_phrase &&
-          page_number == o.page_number &&
-          page_size == o.page_size &&
-          search_fields == o.search_fields &&
-          facet_requests == o.facet_requests &&
-          sort == o.sort &&
-          filters == o.filters
-    end
-
-    # @see the `==` method
-    def eql?(o)
-      self == o
-    end
-
-    # Calculate hash code according to all attributes.
-    def hash
-      [search_phrase, page_number, page_size, search_fields, facet_requests, sort, filters].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