purecloudplatformclientv2 34.0.0 → 35.0.0

data/lib/purecloudplatformclientv2/api/outbound_api.rb

@@ -2295,6 +2295,123 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Query a list of basic Campaign information objects
+    # This returns a simplified version of a Campaign, consisting of name and division.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [String] :filter_type Filter type (default to Prefix)
+    # @option opts [String] :name Name
+    # @option opts [String] :sort_by Sort by
+    # @option opts [String] :sort_order Sort order (default to a)
+    # @return [CampaignDivisionViewListing]
+    def get_outbound_campaigns_divisionviews(opts = {})
+      data, _status_code, _headers = get_outbound_campaigns_divisionviews_with_http_info(opts)
+      return data
+    end
+
+    # Query a list of basic Campaign information objects
+    # This returns a simplified version of a Campaign, consisting of name and division.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @option opts [String] :filter_type Filter type
+    # @option opts [String] :name Name
+    # @option opts [String] :sort_by Sort by
+    # @option opts [String] :sort_order Sort order
+    # @return [Array<(CampaignDivisionViewListing, Fixnum, Hash)>] CampaignDivisionViewListing data, response status code and response headers
+    def get_outbound_campaigns_divisionviews_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_campaigns_divisionviews ..."
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'filter_type'] && !['Equals', 'RegEx', 'Contains', 'Prefix', 'LessThan', 'LessThanEqualTo', 'GreaterThan', 'GreaterThanEqualTo', 'BeginsWith', 'EndsWith'].include?(opts[:'filter_type'])
+        fail ArgumentError, 'invalid value for "filter_type", must be one of Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith'
+      end
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
+        fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
+      end
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/outbound/campaigns/divisionviews".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'filterType'] = opts[:'filter_type'] if opts[:'filter_type']
+      query_params[:'name'] = opts[:'name'] if opts[:'name']
+      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
+      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'CampaignDivisionViewListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OutboundApi#get_outbound_campaigns_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a dialer contact list.
     # 
     # @param contact_list_id ContactList ID

data/lib/purecloudplatformclientv2/api/routing_api.rb

@@ -1803,6 +1803,7 @@ module PureCloud
     # @option opts [String] :sort_by Sort by (default to name)
     # @option opts [String] :name Name
     # @option opts [BOOLEAN] :active Active
+    # @option opts [Array<String>] :division_id Division ID(s)
     # @return [QueueEntityListing]
     def get_routing_queues(opts = {})
       data, _status_code, _headers = get_routing_queues_with_http_info(opts)
@@ -1817,6 +1818,7 @@ module PureCloud
     # @option opts [String] :sort_by Sort by
     # @option opts [String] :name Name
     # @option opts [BOOLEAN] :active Active
+    # @option opts [Array<String>] :division_id Division ID(s)
     # @return [Array<(QueueEntityListing, Fixnum, Hash)>] QueueEntityListing data, response status code and response headers
     def get_routing_queues_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1846,6 +1848,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1863,6 +1871,7 @@ module PureCloud
       query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
       query_params[:'name'] = opts[:'name'] if opts[:'name']
       query_params[:'active'] = opts[:'active'] if opts[:'active']
+      query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
 
       # header parameters
       header_params = {}

data/lib/purecloudplatformclientv2/api/users_api.rb

@@ -1313,6 +1313,7 @@ module PureCloud
     # @option opts [Integer] :page_size Page size (default to 25)
     # @option opts [Integer] :page_number Page number (default to 1)
     # @option opts [BOOLEAN] :joined Is joined to the queue (default to true)
+    # @option opts [Array<String>] :division_id Division ID(s)
     # @return [UserQueueEntityListing]
     def get_user_queues(user_id, opts = {})
       data, _status_code, _headers = get_user_queues_with_http_info(user_id, opts)
@@ -1326,6 +1327,7 @@ module PureCloud
     # @option opts [Integer] :page_size Page size
     # @option opts [Integer] :page_number Page number
     # @option opts [BOOLEAN] :joined Is joined to the queue
+    # @option opts [Array<String>] :division_id Division ID(s)
     # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
     def get_user_queues_with_http_info(user_id, opts = {})
       if @api_client.config.debugging
@@ -1351,6 +1353,12 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1366,6 +1374,7 @@ module PureCloud
       query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
       query_params[:'joined'] = opts[:'joined'] if opts[:'joined']
+      query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
 
       # header parameters
       header_params = {}
@@ -2523,6 +2532,7 @@ module PureCloud
     # @param user_id User ID
     # @param body User Queues
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :division_id Division ID(s)
     # @return [UserQueueEntityListing]
     def patch_user_queues(user_id, body, opts = {})
       data, _status_code, _headers = patch_user_queues_with_http_info(user_id, body, opts)
@@ -2534,6 +2544,7 @@ module PureCloud
     # @param user_id User ID
     # @param body User Queues
     # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :division_id Division ID(s)
     # @return [Array<(UserQueueEntityListing, Fixnum, Hash)>] UserQueueEntityListing data, response status code and response headers
     def patch_user_queues_with_http_info(user_id, body, opts = {})
       if @api_client.config.debugging
@@ -2556,11 +2567,18 @@ module PureCloud
       
       
       
+      
+      
+      
+      
+      
+      
       # resource path
       local_var_path = "/api/v2/users/{userId}/queues".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
 
       # query parameters
       query_params = {}
+      query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_id']
 
       # header parameters
       header_params = {}

data/lib/purecloudplatformclientv2/api/workforce_management_api.rb

@@ -469,7 +469,7 @@ module PureCloud
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page_size 
-    # @option opts [Integer] :page_number  (default to 1)
+    # @option opts [Integer] :page_number 
     # @option opts [String] :expand 
     # @return [ManagementUnitListing]
     def get_workforcemanagement_managementunits(opts = {})

data/lib/purecloudplatformclientv2/api_client.rb

@@ -76,7 +76,7 @@ module PureCloud
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
-      header_params['purecloud-sdk'] = '34.0.0'
+      header_params['purecloud-sdk'] = '35.0.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/action_entity_listing.rb

@@ -30,12 +30,12 @@ module PureCloud
 
     attr_accessor :first_uri
 
-    attr_accessor :last_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.
@@ -54,12 +54,12 @@ module PureCloud
         
         :'first_uri' => :'firstUri',
         
-        :'last_uri' => :'lastUri',
-        
         :'previous_uri' => :'previousUri',
         
         :'next_uri' => :'nextUri',
         
+        :'last_uri' => :'lastUri',
+        
         :'page_count' => :'pageCount'
         
       }
@@ -81,12 +81,12 @@ module PureCloud
         
         :'first_uri' => :'String',
         
-        :'last_uri' => :'String',
-        
         :'previous_uri' => :'String',
         
         :'next_uri' => :'String',
         
+        :'last_uri' => :'String',
+        
         :'page_count' => :'Integer'
         
       }
@@ -157,28 +157,28 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
@@ -312,9 +312,9 @@ module PureCloud
           total == o.total &&
           self_uri == o.self_uri &&
           first_uri == o.first_uri &&
-          last_uri == o.last_uri &&
           previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
+          last_uri == o.last_uri &&
           page_count == o.page_count
     end
 
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, self_uri, first_uri, last_uri, previous_uri, next_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb

@@ -30,12 +30,12 @@ module PureCloud
 
     attr_accessor :first_uri
 
-    attr_accessor :last_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.
@@ -54,12 +54,12 @@ module PureCloud
         
         :'first_uri' => :'firstUri',
         
-        :'last_uri' => :'lastUri',
-        
         :'previous_uri' => :'previousUri',
         
         :'next_uri' => :'nextUri',
         
+        :'last_uri' => :'lastUri',
+        
         :'page_count' => :'pageCount'
         
       }
@@ -81,12 +81,12 @@ module PureCloud
         
         :'first_uri' => :'String',
         
-        :'last_uri' => :'String',
-        
         :'previous_uri' => :'String',
         
         :'next_uri' => :'String',
         
+        :'last_uri' => :'String',
+        
         :'page_count' => :'Integer'
         
       }
@@ -157,28 +157,28 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'previousUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        self.previous_uri = attributes[:'previousUri']
         
       
       end
 
       
-      if attributes.has_key?(:'previousUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.previous_uri = attributes[:'previousUri']
+        self.next_uri = attributes[:'nextUri']
         
       
       end
 
       
-      if attributes.has_key?(:'nextUri')
+      if attributes.has_key?(:'lastUri')
         
         
-        self.next_uri = attributes[:'nextUri']
+        self.last_uri = attributes[:'lastUri']
         
       
       end
@@ -312,9 +312,9 @@ module PureCloud
           total == o.total &&
           self_uri == o.self_uri &&
           first_uri == o.first_uri &&
-          last_uri == o.last_uri &&
           previous_uri == o.previous_uri &&
           next_uri == o.next_uri &&
+          last_uri == o.last_uri &&
           page_count == o.page_count
     end
 
@@ -327,7 +327,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [entities, page_size, page_number, total, self_uri, first_uri, last_uri, previous_uri, next_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, first_uri, previous_uri, next_uri, last_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/assigned_wrapup_code.rb

@@ -0,0 +1,308 @@
+=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 AssignedWrapupCode
+    # The user configured wrap up code id.
+    attr_accessor :code
+
+    # Text entered by the agent to describe the call or disposition.
+    attr_accessor :notes
+
+    # List of tags selected by the agent to describe the call or disposition.
+    attr_accessor :tags
+
+    # The duration in seconds of the wrap-up segment.
+    attr_accessor :duration_seconds
+
+    # The timestamp when the wrap-up segment ended. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
+    attr_accessor :end_time
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        
+        :'code' => :'code',
+        
+        :'notes' => :'notes',
+        
+        :'tags' => :'tags',
+        
+        :'duration_seconds' => :'durationSeconds',
+        
+        :'end_time' => :'endTime'
+        
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        
+        :'code' => :'String',
+        
+        :'notes' => :'String',
+        
+        :'tags' => :'Array<String>',
+        
+        :'duration_seconds' => :'Integer',
+        
+        :'end_time' => :'DateTime'
+        
+      }
+    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?(:'code')
+        
+        
+        self.code = attributes[:'code']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'notes')
+        
+        
+        self.notes = attributes[:'notes']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'tags')
+        
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+        
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'durationSeconds')
+        
+        
+        self.duration_seconds = attributes[:'durationSeconds']
+        
+      
+      end
+
+      
+      if attributes.has_key?(:'endTime')
+        
+        
+        self.end_time = attributes[:'endTime']
+        
+      
+      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 &&
+          code == o.code &&
+          notes == o.notes &&
+          tags == o.tags &&
+          duration_seconds == o.duration_seconds &&
+          end_time == o.end_time
+    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
+      [code, notes, tags, duration_seconds, end_time].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