purecloud 0.0.0

data/lib/purecloud/models/flow_history_item.rb

@@ -0,0 +1,238 @@
+require 'date'
+
+module PureCloud
+  # Information about one flow history item
+  class FlowHistoryItem
+    # The time when the history item occurred. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :history_event_time
+
+    # The State sequence that applies to the history event, if applicable.
+    attr_accessor :state
+
+    # Information about the work item associated with the history event, if applicable.
+    attr_accessor :work_item
+
+    # The user associated with this history event, if applicable.
+    attr_accessor :user
+
+    # The queue associated with this history event, if applicable.
+    attr_accessor :queue
+
+    # Data elements associated with this history event.
+    attr_accessor :history_event_data
+
+    # The type of the history event being reported.
+    attr_accessor :history_event_type
+
+    # Whether or not the flow item was successful (if a 'notification' event this will default to true)
+    attr_accessor :success
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'history_event_time' => :'historyEventTime',
+        
+        :'state' => :'state',
+        
+        :'work_item' => :'workItem',
+        
+        :'user' => :'user',
+        
+        :'queue' => :'queue',
+        
+        :'history_event_data' => :'historyEventData',
+        
+        :'history_event_type' => :'historyEventType',
+        
+        :'success' => :'success'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'history_event_time' => :'DateTime',
+        :'state' => :'FlowState',
+        :'work_item' => :'WorkItem',
+        :'user' => :'User',
+        :'queue' => :'Queue',
+        :'history_event_data' => :'Array<DataItem>',
+        :'history_event_type' => :'String',
+        :'success' => :'BOOLEAN'
+        
+      }
+    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[:'historyEventTime']
+        self.history_event_time = attributes[:'historyEventTime']
+      end
+      
+      if attributes[:'state']
+        self.state = attributes[:'state']
+      end
+      
+      if attributes[:'workItem']
+        self.work_item = attributes[:'workItem']
+      end
+      
+      if attributes[:'user']
+        self.user = attributes[:'user']
+      end
+      
+      if attributes[:'queue']
+        self.queue = attributes[:'queue']
+      end
+      
+      if attributes[:'historyEventData']
+        if (value = attributes[:'historyEventData']).is_a?(Array)
+          self.history_event_data = value
+        end
+      end
+      
+      if attributes[:'historyEventType']
+        self.history_event_type = attributes[:'historyEventType']
+      end
+      
+      if attributes[:'success']
+        self.success = attributes[:'success']
+      else
+        self.success = false
+      end
+      
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    def history_event_type=(history_event_type)
+      allowed_values = ["FLOW_INSTANCE_START", "FLOW_INSTANCE_GOTO", "FLOW_INSTANCE_TERMINATE", "FLOW_INSTANCE_END", "TASK_INSTANCE_START", "TASK_INSTANCE_END", "WORK_ITEM_INSTANCE_SAVE", "WORK_ITEM_INSTANCE_ACQUIRE", "WORK_ITEM_INSTANCE_SUBMIT", "WORK_ITEM_INSTANCE_OFFER", "WORK_ITEM_INSTANCE_REASSIGN", "FLOW_INSTANCE_ERROR", "FLOW_INSTANCE_RETRY"]
+      if history_event_type && !allowed_values.include?(history_event_type)
+        fail "invalid value for 'history_event_type', must be one of #{allowed_values}"
+      end
+      @history_event_type = history_event_type
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          history_event_time == o.history_event_time &&
+          state == o.state &&
+          work_item == o.work_item &&
+          user == o.user &&
+          queue == o.queue &&
+          history_event_data == o.history_event_data &&
+          history_event_type == o.history_event_type &&
+          success == o.success
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [history_event_time, state, work_item, user, queue, history_event_data, history_event_type, success].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 =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      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_history_result_item.rb

@@ -0,0 +1,172 @@
+require 'date'
+
+module PureCloud
+  # Information about one flow history item
+  class FlowHistoryResultItem
+    # The flow instance information that applies to the history events.
+    attr_accessor :flow_instance
+
+    # The actions available for operating in the flow, with respect to your authorization identity.
+    attr_accessor :available_actions
+
+    # The ordered list of history events for this flow.
+    attr_accessor :history_items
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'flow_instance' => :'flowInstance',
+        
+        :'available_actions' => :'availableActions',
+        
+        :'history_items' => :'historyItems'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'flow_instance' => :'FlowDetails',
+        :'available_actions' => :'BackendFlowAvailableActions',
+        :'history_items' => :'Array<FlowHistoryItem>'
+        
+      }
+    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[:'flowInstance']
+        self.flow_instance = attributes[:'flowInstance']
+      end
+      
+      if attributes[:'availableActions']
+        self.available_actions = attributes[:'availableActions']
+      end
+      
+      if attributes[:'historyItems']
+        if (value = attributes[:'historyItems']).is_a?(Array)
+          self.history_items = value
+        end
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          flow_instance == o.flow_instance &&
+          available_actions == o.available_actions &&
+          history_items == o.history_items
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [flow_instance, available_actions, history_items].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 =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      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_history_result_item_entity_listing.rb

@@ -0,0 +1,238 @@
+require 'date'
+
+module PureCloud
+  class FlowHistoryResultItemEntityListing
+    attr_accessor :page_size
+
+    attr_accessor :page_number
+
+    attr_accessor :total
+
+    attr_accessor :entities
+
+    attr_accessor :self_uri
+
+    attr_accessor :first_uri
+
+    attr_accessor :previous_uri
+
+    attr_accessor :next_uri
+
+    attr_accessor :last_uri
+
+    attr_accessor :page_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'page_size' => :'pageSize',
+        
+        :'page_number' => :'pageNumber',
+        
+        :'total' => :'total',
+        
+        :'entities' => :'entities',
+        
+        :'self_uri' => :'selfUri',
+        
+        :'first_uri' => :'firstUri',
+        
+        :'previous_uri' => :'previousUri',
+        
+        :'next_uri' => :'nextUri',
+        
+        :'last_uri' => :'lastUri',
+        
+        :'page_count' => :'pageCount'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'page_size' => :'Integer',
+        :'page_number' => :'Integer',
+        :'total' => :'Integer',
+        :'entities' => :'Array<FlowHistoryResultItem>',
+        :'self_uri' => :'String',
+        :'first_uri' => :'String',
+        :'previous_uri' => :'String',
+        :'next_uri' => :'String',
+        :'last_uri' => :'String',
+        :'page_count' => :'Integer'
+        
+      }
+    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[:'pageSize']
+        self.page_size = attributes[:'pageSize']
+      end
+      
+      if attributes[:'pageNumber']
+        self.page_number = attributes[:'pageNumber']
+      end
+      
+      if attributes[:'total']
+        self.total = attributes[:'total']
+      end
+      
+      if attributes[:'entities']
+        if (value = attributes[:'entities']).is_a?(Array)
+          self.entities = value
+        end
+      end
+      
+      if attributes[:'selfUri']
+        self.self_uri = attributes[:'selfUri']
+      end
+      
+      if attributes[:'firstUri']
+        self.first_uri = attributes[:'firstUri']
+      end
+      
+      if attributes[:'previousUri']
+        self.previous_uri = attributes[:'previousUri']
+      end
+      
+      if attributes[:'nextUri']
+        self.next_uri = attributes[:'nextUri']
+      end
+      
+      if attributes[:'lastUri']
+        self.last_uri = attributes[:'lastUri']
+      end
+      
+      if attributes[:'pageCount']
+        self.page_count = attributes[:'pageCount']
+      end
+      
+    end
+
+    # Check equality by comparing each attribute.
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          page_size == o.page_size &&
+          page_number == o.page_number &&
+          total == o.total &&
+          entities == o.entities &&
+          self_uri == o.self_uri &&
+          first_uri == o.first_uri &&
+          previous_uri == o.previous_uri &&
+          next_uri == o.next_uri &&
+          last_uri == o.last_uri &&
+          page_count == o.page_count
+    end
+
+    # @see the `==` method
+    def eql?(o)
+      self == o
+    end
+
+    # Calculate hash code according to all attributes.
+    def hash
+      [page_size, page_number, total, entities, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].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 =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      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