purecloudplatformclientv2 4.0.0 → 5.0.0

data/docs/VoicemailMessageEntityListing.md

@@ -12,10 +12,10 @@ title: VoicemailMessageEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/WorkspaceEntityListing.md

@@ -12,10 +12,10 @@ title: WorkspaceEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/WorkspaceMemberEntityListing.md

@@ -12,10 +12,10 @@ title: WorkspaceMemberEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/docs/WrapupCodeEntityListing.md

@@ -12,10 +12,10 @@ title: WrapupCodeEntityListing
 | **page_number** | **Integer** |  | [optional] |
 | **total** | **Integer** |  | [optional] |
 | **self_uri** | **String** |  | [optional] |
-| **first_uri** | **String** |  | [optional] |
 | **previous_uri** | **String** |  | [optional] |
 | **next_uri** | **String** |  | [optional] |
 | **last_uri** | **String** |  | [optional] |
+| **first_uri** | **String** |  | [optional] |
 | **page_count** | **Integer** |  | [optional] |
 {: class="table table-striped"}
 

data/lib/purecloudplatformclientv2.rb

@@ -314,6 +314,7 @@ require 'purecloudplatformclientv2/models/detail'
 require 'purecloudplatformclientv2/models/dialer_action'
 require 'purecloudplatformclientv2/models/dialer_audit_request'
 require 'purecloudplatformclientv2/models/dialer_contact'
+require 'purecloudplatformclientv2/models/dialer_event_entity_listing'
 require 'purecloudplatformclientv2/models/dialer_preview'
 require 'purecloudplatformclientv2/models/dialer_rule'
 require 'purecloudplatformclientv2/models/digit_length'
@@ -425,6 +426,8 @@ require 'purecloudplatformclientv2/models/evaluation_form_entity_listing'
 require 'purecloudplatformclientv2/models/evaluation_scoring_set'
 require 'purecloudplatformclientv2/models/evaluator_activity'
 require 'purecloudplatformclientv2/models/evaluator_activity_entity_listing'
+require 'purecloudplatformclientv2/models/event_log'
+require 'purecloudplatformclientv2/models/event_message'
 require 'purecloudplatformclientv2/models/expansion_criterium'
 require 'purecloudplatformclientv2/models/export_uri'
 require 'purecloudplatformclientv2/models/export_uri_notification'

data/lib/purecloudplatformclientv2/api/outbound_api.rb

@@ -2257,6 +2257,143 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get Dialer Event
+    # 
+    # @param event_id Event Log ID
+    # @param [Hash] opts the optional parameters
+    # @return [EventLog]
+    def get_outbound_event(event_id, opts = {})
+      data, _status_code, _headers = get_outbound_event_with_http_info(event_id, opts)
+      return data
+    end
+
+    # Get Dialer Event
+    # 
+    # @param event_id Event Log ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EventLog, Fixnum, Hash)>] EventLog data, response status code and response headers
+    def get_outbound_event_with_http_info(event_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_event ..."
+      end
+      # verify the required parameter 'event_id' is set
+      fail ArgumentError, "Missing the required parameter 'event_id' when calling OutboundApi.get_outbound_event" if event_id.nil?
+      # resource path
+      local_var_path = "/api/v2/outbound/events/{eventId}".sub('{format}','json').sub('{' + 'eventId' + '}', event_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # 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 => 'EventLog')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OutboundApi#get_outbound_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Query Event Logs
+    # 
+    # @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] :category Category
+    # @option opts [String] :level Level
+    # @option opts [String] :sort_by Sort by
+    # @option opts [String] :sort_order Sort order (default to a)
+    # @return [DialerEventEntityListing]
+    def get_outbound_events(opts = {})
+      data, _status_code, _headers = get_outbound_events_with_http_info(opts)
+      return data
+    end
+
+    # Query Event Logs
+    # 
+    # @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] :category Category
+    # @option opts [String] :level Level
+    # @option opts [String] :sort_by Sort by
+    # @option opts [String] :sort_order Sort order
+    # @return [Array<(DialerEventEntityListing, Fixnum, Hash)>] DialerEventEntityListing data, response status code and response headers
+    def get_outbound_events_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: OutboundApi.get_outbound_events ..."
+      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/events".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[:'category'] = opts[:'category'] if opts[:'category']
+      query_params[:'level'] = opts[:'level'] if opts[:'level']
+      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 => 'DialerEventEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OutboundApi#get_outbound_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get a Rule Set by ID.
     # 
     # @param rule_set_id Rule Set ID

data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb

@@ -3508,6 +3508,7 @@ module PureCloud
     # @option opts [Integer] :page_number Page number (default to 1)
     # @option opts [String] :sort_by Value by which to sort (default to name)
     # @option opts [String] :sort_order Sort order (default to ASC)
+    # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
     # @option opts [String] :name Name
     # @return [PhoneBaseEntityListing]
     def get_telephony_providers_edges_phonebasesettings(opts = {})
@@ -3522,6 +3523,7 @@ module PureCloud
     # @option opts [Integer] :page_number Page number
     # @option opts [String] :sort_by Value by which to sort
     # @option opts [String] :sort_order Sort order
+    # @option opts [Array<String>] :expand Fields to expand in the response, comma-separated
     # @option opts [String] :name Name
     # @return [Array<(PhoneBaseEntityListing, Fixnum, Hash)>] PhoneBaseEntityListing data, response status code and response headers
     def get_telephony_providers_edges_phonebasesettings_with_http_info(opts = {})
@@ -3537,6 +3539,7 @@ module PureCloud
       query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
       query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
       query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+      query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
       query_params[:'name'] = opts[:'name'] if opts[:'name']
 
       # header parameters

data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb

@@ -28,14 +28,14 @@ module PureCloud
 
     attr_accessor :self_uri
 
-    attr_accessor :first_uri
-
     attr_accessor :previous_uri
 
     attr_accessor :next_uri
 
     attr_accessor :last_uri
 
+    attr_accessor :first_uri
+
     attr_accessor :page_count
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -46,10 +46,10 @@ module PureCloud
         :'page_number' => :'pageNumber',
         :'total' => :'total',
         :'self_uri' => :'selfUri',
-        :'first_uri' => :'firstUri',
         :'previous_uri' => :'previousUri',
         :'next_uri' => :'nextUri',
         :'last_uri' => :'lastUri',
+        :'first_uri' => :'firstUri',
         :'page_count' => :'pageCount'
       }
     end
@@ -62,10 +62,10 @@ module PureCloud
         :'page_number' => :'Integer',
         :'total' => :'Integer',
         :'self_uri' => :'String',
-        :'first_uri' => :'String',
         :'previous_uri' => :'String',
         :'next_uri' => :'String',
         :'last_uri' => :'String',
+        :'first_uri' => :'String',
         :'page_count' => :'Integer'
       }
     end
@@ -100,10 +100,6 @@ module PureCloud
         self.self_uri = attributes[:'selfUri']
       end
 
-      if attributes.has_key?(:'firstUri')
-        self.first_uri = attributes[:'firstUri']
-      end
-
       if attributes.has_key?(:'previousUri')
         self.previous_uri = attributes[:'previousUri']
       end
@@ -116,6 +112,10 @@ module PureCloud
         self.last_uri = attributes[:'lastUri']
       end
 
+      if attributes.has_key?(:'firstUri')
+        self.first_uri = attributes[:'firstUri']
+      end
+
       if attributes.has_key?(:'pageCount')
         self.page_count = attributes[:'pageCount']
       end
@@ -144,10 +144,10 @@ module PureCloud
           page_number == o.page_number &&
           total == o.total &&
           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 &&
+          first_uri == o.first_uri &&
           page_count == o.page_count
     end
 
@@ -160,7 +160,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, previous_uri, next_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, previous_uri, next_uri, last_uri, first_uri, page_count].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/attempt_limits.rb

@@ -42,6 +42,9 @@ module PureCloud
     # After how long the number of attempts will be set back to 0
     attr_accessor :reset_period
 
+    # Configuration for recall attempts
+    attr_accessor :recall_entries
+
     # The URI for this object
     attr_accessor :self_uri
 
@@ -57,6 +60,7 @@ module PureCloud
         :'max_attempts_per_number' => :'maxAttemptsPerNumber',
         :'time_zone_id' => :'timeZoneId',
         :'reset_period' => :'resetPeriod',
+        :'recall_entries' => :'recallEntries',
         :'self_uri' => :'selfUri'
       }
     end
@@ -73,6 +77,7 @@ module PureCloud
         :'max_attempts_per_number' => :'Integer',
         :'time_zone_id' => :'String',
         :'reset_period' => :'String',
+        :'recall_entries' => :'Hash<String, RecallEntry>',
         :'self_uri' => :'String'
       }
     end
@@ -121,6 +126,12 @@ module PureCloud
         self.reset_period = attributes[:'resetPeriod']
       end
 
+      if attributes.has_key?(:'recallEntries')
+        if (value = attributes[:'recallEntries']).is_a?(Array)
+          self.recall_entries = value
+        end
+      end
+
       if attributes.has_key?(:'selfUri')
         self.self_uri = attributes[:'selfUri']
       end
@@ -167,6 +178,7 @@ module PureCloud
           max_attempts_per_number == o.max_attempts_per_number &&
           time_zone_id == o.time_zone_id &&
           reset_period == o.reset_period &&
+          recall_entries == o.recall_entries &&
           self_uri == o.self_uri
     end
 
@@ -179,7 +191,7 @@ module PureCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, name, date_created, date_modified, version, max_attempts_per_contact, max_attempts_per_number, time_zone_id, reset_period, self_uri].hash
+      [id, name, date_created, date_modified, version, max_attempts_per_contact, max_attempts_per_number, time_zone_id, reset_period, recall_entries, self_uri].hash
     end
 
     # build the object from hash

data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb

@@ -28,14 +28,14 @@ module PureCloud
 
     attr_accessor :self_uri
 
-    attr_accessor :first_uri
-
     attr_accessor :previous_uri
 
     attr_accessor :next_uri
 
     attr_accessor :last_uri
 
+    attr_accessor :first_uri
+
     attr_accessor :page_count
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -46,10 +46,10 @@ module PureCloud
         :'page_number' => :'pageNumber',
         :'total' => :'total',
         :'self_uri' => :'selfUri',
-        :'first_uri' => :'firstUri',
         :'previous_uri' => :'previousUri',
         :'next_uri' => :'nextUri',
         :'last_uri' => :'lastUri',
+        :'first_uri' => :'firstUri',
         :'page_count' => :'pageCount'
       }
     end
@@ -62,10 +62,10 @@ module PureCloud
         :'page_number' => :'Integer',
         :'total' => :'Integer',
         :'self_uri' => :'String',
-        :'first_uri' => :'String',
         :'previous_uri' => :'String',
         :'next_uri' => :'String',
         :'last_uri' => :'String',
+        :'first_uri' => :'String',
         :'page_count' => :'Integer'
       }
     end
@@ -100,10 +100,6 @@ module PureCloud
         self.self_uri = attributes[:'selfUri']
       end
 
-      if attributes.has_key?(:'firstUri')
-        self.first_uri = attributes[:'firstUri']
-      end
-
       if attributes.has_key?(:'previousUri')
         self.previous_uri = attributes[:'previousUri']
       end
@@ -116,6 +112,10 @@ module PureCloud
         self.last_uri = attributes[:'lastUri']
       end
 
+      if attributes.has_key?(:'firstUri')
+        self.first_uri = attributes[:'firstUri']
+      end
+
       if attributes.has_key?(:'pageCount')
         self.page_count = attributes[:'pageCount']
       end
@@ -144,10 +144,10 @@ module PureCloud
           page_number == o.page_number &&
           total == o.total &&
           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 &&
+          first_uri == o.first_uri &&
           page_count == o.page_count
     end
 
@@ -160,7 +160,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, previous_uri, next_uri, last_uri, page_count].hash
+      [entities, page_size, page_number, total, self_uri, previous_uri, next_uri, last_uri, first_uri, page_count].hash
     end
 
     # build the object from hash