purecloudplatformclientv2 6.0.0 → 7.0.0

data/lib/purecloudplatformclientv2/api/telephony_providers_edge_api.rb

@@ -1804,6 +1804,84 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get the list of available trunks for the given Edge.
+    # Trunks are created by assigning trunk base settings to an Edge or Edge Group.
+    # @param edge_id Edge ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [Integer] :page_size Page size (default to 25)
+    # @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 [String] :trunk_base_id Filter by Trunk Base Ids
+    # @option opts [String] :trunk_type Filter by a Trunk type
+    # @return [TrunkEntityListing]
+    def get_telephony_providers_edge_trunks(edge_id, opts = {})
+      data, _status_code, _headers = get_telephony_providers_edge_trunks_with_http_info(edge_id, opts)
+      return data
+    end
+
+    # Get the list of available trunks for the given Edge.
+    # Trunks are created by assigning trunk base settings to an Edge or Edge Group.
+    # @param edge_id Edge ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_number Page number
+    # @option opts [Integer] :page_size Page size
+    # @option opts [String] :sort_by Value by which to sort
+    # @option opts [String] :sort_order Sort order
+    # @option opts [String] :trunk_base_id Filter by Trunk Base Ids
+    # @option opts [String] :trunk_type Filter by a Trunk type
+    # @return [Array<(TrunkEntityListing, Fixnum, Hash)>] TrunkEntityListing data, response status code and response headers
+    def get_telephony_providers_edge_trunks_with_http_info(edge_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: TelephonyProvidersEdgeApi.get_telephony_providers_edge_trunks ..."
+      end
+      # verify the required parameter 'edge_id' is set
+      fail ArgumentError, "Missing the required parameter 'edge_id' when calling TelephonyProvidersEdgeApi.get_telephony_providers_edge_trunks" if edge_id.nil?
+      if opts[:'trunk_type'] && !['EXTERNAL', 'PHONE', 'EDGE'].include?(opts[:'trunk_type'])
+        fail ArgumentError, 'invalid value for "trunk_type", must be one of EXTERNAL, PHONE, EDGE'
+      end
+      # resource path
+      local_var_path = "/api/v2/telephony/providers/edges/{edgeId}/trunks".sub('{format}','json').sub('{' + 'edgeId' + '}', edge_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
+      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
+      query_params[:'trunkBase.id'] = opts[:'trunk_base_id'] if opts[:'trunk_base_id']
+      query_params[:'trunkType'] = opts[:'trunk_type'] if opts[:'trunk_type']
+
+      # 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 => 'TrunkEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TelephonyProvidersEdgeApi#get_telephony_providers_edge_trunks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get the list of edges.
     # 
     # @param [Hash] opts the optional parameters

data/lib/purecloudplatformclientv2/api/users_api.rb

@@ -1226,6 +1226,7 @@ module PureCloud
     # @option opts [Array<String>] :id id
     # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :state Only list users of this state (default to active)
     # @return [UserEntityListing]
     def get_users(opts = {})
       data, _status_code, _headers = get_users_with_http_info(opts)
@@ -1240,6 +1241,7 @@ module PureCloud
     # @option opts [Array<String>] :id id
     # @option opts [String] :sort_order Ascending or descending sort order
     # @option opts [Array<String>] :expand Which fields, if any, to expand
+    # @option opts [String] :state Only list users of this state
     # @return [Array<(UserEntityListing, Fixnum, Hash)>] UserEntityListing data, response status code and response headers
     def get_users_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1248,6 +1250,9 @@ module PureCloud
       if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
         fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
       end
+      if opts[:'state'] && !['active', 'deleted'].include?(opts[:'state'])
+        fail ArgumentError, 'invalid value for "state", must be one of active, deleted'
+      end
       # resource path
       local_var_path = "/api/v2/users".sub('{format}','json')
 
@@ -1258,6 +1263,7 @@ module PureCloud
       query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
       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[:'state'] = opts[:'state'] if opts[:'state']
 
       # header parameters
       header_params = {}

data/lib/purecloudplatformclientv2/api/workforce_management_api.rb

@@ -84,7 +84,7 @@ module PureCloud
 
     # Get activity codes corresponding to a management unit
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or 'mine' for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @return [ActivityCodeContainer]
     def get_workforcemanagement_managementunit_activitycodes(mu_id, opts = {})
@@ -94,7 +94,7 @@ module PureCloud
 
     # Get activity codes corresponding to a management unit
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or 'mine' for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityCodeContainer, Fixnum, Hash)>] ActivityCodeContainer data, response status code and response headers
     def get_workforcemanagement_managementunit_activitycodes_with_http_info(mu_id, opts = {})
@@ -141,7 +141,7 @@ module PureCloud
 
     # Get intraday queues for the given date
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param date ISO-8601 date string with no time or timezone component, interpreted in the configured management unit time zone, e.g. 2017-01-23
     # @param [Hash] opts the optional parameters
     # @return [WfmIntradayQueueListing]
@@ -152,7 +152,7 @@ module PureCloud
 
     # Get intraday queues for the given date
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param date ISO-8601 date string with no time or timezone component, interpreted in the configured management unit time zone, e.g. 2017-01-23
     # @param [Hash] opts the optional parameters
     # @return [Array<(WfmIntradayQueueListing, Fixnum, Hash)>] WfmIntradayQueueListing data, response status code and response headers
@@ -203,7 +203,7 @@ module PureCloud
 
     # Get a time off request by id
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param user_id The userId to whom the Time Off Request applies.
     # @param time_off_request_id Time Off Request Id
     # @param [Hash] opts the optional parameters
@@ -215,7 +215,7 @@ module PureCloud
 
     # Get a time off request by id
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param user_id The userId to whom the Time Off Request applies.
     # @param time_off_request_id Time Off Request Id
     # @param [Hash] opts the optional parameters
@@ -268,7 +268,7 @@ module PureCloud
 
     # Get a list of time off requests for any user
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param user_id The userId to whom the Time Off Request applies.
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
@@ -280,7 +280,7 @@ module PureCloud
 
     # Get a list of time off requests for any user
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param user_id The userId to whom the Time Off Request applies.
     # @param [Hash] opts the optional parameters
     # @option opts [BOOLEAN] :recently_reviewed Limit results to requests that have been reviewed within the preceding 30 days
@@ -332,7 +332,7 @@ module PureCloud
 
     # Get agents in the management unit
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @return [WfmUserEntityListing]
     def get_workforcemanagement_managementunit_users(mu_id, opts = {})
@@ -342,7 +342,7 @@ module PureCloud
 
     # Get agents in the management unit
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @return [Array<(WfmUserEntityListing, Fixnum, Hash)>] WfmUserEntityListing data, response status code and response headers
     def get_workforcemanagement_managementunit_users_with_http_info(mu_id, opts = {})
@@ -622,7 +622,7 @@ module PureCloud
 
     # Get intraday data for the given date for the requested queueIds
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @option opts [IntradayQueryDataCommand] :body body
     # @return [IntradayResponse]
@@ -633,7 +633,7 @@ module PureCloud
 
     # Get intraday data for the given date for the requested queueIds
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @option opts [IntradayQueryDataCommand] :body body
     # @return [Array<(IntradayResponse, Fixnum, Hash)>] IntradayResponse data, response status code and response headers
@@ -681,7 +681,7 @@ module PureCloud
 
     # Get user schedules within the given time range
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @option opts [UserListScheduleRequestBody] :body body
     # @return [UserScheduleContainer]
@@ -692,7 +692,7 @@ module PureCloud
 
     # Get user schedules within the given time range
     # 
-    # @param mu_id The muId of the management unit.
+    # @param mu_id The muId of the management unit, or &#39;mine&#39; for the management unit of the logged-in user.
     # @param [Hash] opts the optional parameters
     # @option opts [UserListScheduleRequestBody] :body body
     # @return [Array<(UserScheduleContainer, Fixnum, Hash)>] UserScheduleContainer data, response status code and response headers

data/lib/purecloudplatformclientv2/models/agent_activity_entity_listing.rb

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

data/lib/purecloudplatformclientv2/models/attempt_limits_entity_listing.rb

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

data/lib/purecloudplatformclientv2/models/attribute_entity_listing.rb

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