purecloudplatformclientv2 29.0.0 → 30.0.0

data/lib/purecloudplatformclientv2/api/external_contacts_api.rb

@@ -590,8 +590,8 @@ module PureCloud
     # 
     # @param contact_id ExternalContact Id
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size (default to 20)
-    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
     # @option opts [String] :sort_order Sort order
     # @option opts [Array<String>] :expand which fields, if any, to expand
     # @return [NoteListing]
@@ -604,8 +604,8 @@ module PureCloud
     # 
     # @param contact_id ExternalContact Id
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size
-    # @option opts [Integer] :page_number Page number
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
     # @option opts [String] :sort_order Sort order
     # @option opts [Array<String>] :expand which fields, if any, to expand
     # @return [Array<(NoteListing, Fixnum, Hash)>] NoteListing data, response status code and response headers
@@ -690,8 +690,8 @@ module PureCloud
     # Search for external contacts
     # 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size (default to 20)
-    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)
     # @option opts [String] :q User supplied search keywords (no special syntax is currently supported)
     # @option opts [String] :sort_order Sort order
     # @option opts [Array<String>] :expand which fields, if any, to expand
@@ -704,8 +704,8 @@ module PureCloud
     # Search for external contacts
     # 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size
-    # @option opts [Integer] :page_number Page number
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
     # @option opts [String] :q User supplied search keywords (no special syntax is currently supported)
     # @option opts [String] :sort_order Sort order
     # @option opts [Array<String>] :expand which fields, if any, to expand
@@ -878,8 +878,8 @@ module PureCloud
     # 
     # @param external_organization_id External Organization ID
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size (default to 20)
-    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)
     # @option opts [String] :q User supplied search keywords (no special syntax is currently supported)
     # @option opts [String] :sort_order Sort order
     # @option opts [Array<String>] :expand which fields, if any, to expand
@@ -893,8 +893,8 @@ module PureCloud
     # 
     # @param external_organization_id External Organization ID
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size
-    # @option opts [Integer] :page_number Page number
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
     # @option opts [String] :q User supplied search keywords (no special syntax is currently supported)
     # @option opts [String] :sort_order Sort order
     # @option opts [Array<String>] :expand which fields, if any, to expand
@@ -1072,8 +1072,8 @@ module PureCloud
     # 
     # @param external_organization_id External Organization Id
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size (default to 20)
-    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)
     # @option opts [String] :sort_order Sort order
     # @option opts [Array<String>] :expand which fields, if any, to expand
     # @return [NoteListing]
@@ -1086,8 +1086,8 @@ module PureCloud
     # 
     # @param external_organization_id External Organization Id
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size
-    # @option opts [Integer] :page_number Page number
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
     # @option opts [String] :sort_order Sort order
     # @option opts [Array<String>] :expand which fields, if any, to expand
     # @return [Array<(NoteListing, Fixnum, Hash)>] NoteListing data, response status code and response headers
@@ -1173,8 +1173,8 @@ module PureCloud
     # 
     # @param external_organization_id External Organization ID
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size (default to 20)
-    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)
     # @option opts [String] :expand which fields, if any, to expand
     # @option opts [String] :sort_order Sort order
     # @return [RelationshipListing]
@@ -1187,8 +1187,8 @@ module PureCloud
     # 
     # @param external_organization_id External Organization ID
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size
-    # @option opts [Integer] :page_number Page number
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
     # @option opts [String] :expand which fields, if any, to expand
     # @option opts [String] :sort_order Sort order
     # @return [Array<(RelationshipListing, Fixnum, Hash)>] RelationshipListing data, response status code and response headers
@@ -1277,8 +1277,8 @@ module PureCloud
     # Search for external organizations
     # 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size (default to 20)
-    # @option opts [Integer] :page_number Page number (default to 1)
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 20)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000) (default to 1)
     # @option opts [String] :q Search query
     # @option opts [Array<String>] :trustor_id Search for external organizations by trustorIds (limit 25). If supplied, the &#39;q&#39; parameters is ignored. Items are returned in the order requested
     # @option opts [String] :sort_order Sort order
@@ -1293,8 +1293,8 @@ module PureCloud
     # Search for external organizations
     # 
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_size Page size
-    # @option opts [Integer] :page_number Page number
+    # @option opts [Integer] :page_size Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
+    # @option opts [Integer] :page_number Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be &lt;= 1,000)
     # @option opts [String] :q Search query
     # @option opts [Array<String>] :trustor_id Search for external organizations by trustorIds (limit 25). If supplied, the &#39;q&#39; parameters is ignored. Items are returned in the order requested
     # @option opts [String] :sort_order Sort order

data/lib/purecloudplatformclientv2/api/groups_api.rb

@@ -300,7 +300,72 @@ module PureCloud
       return data, status_code, headers
     end
 
-    # Get group members
+    # Get all individuals associated with the group
+    # 
+    # @param group_id Group ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<UserEntityListing>]
+    def get_group_individuals(group_id, opts = {})
+      data, _status_code, _headers = get_group_individuals_with_http_info(group_id, opts)
+      return data
+    end
+
+    # Get all individuals associated with the group
+    # 
+    # @param group_id Group ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<UserEntityListing>, Fixnum, Hash)>] Array<UserEntityListing> data, response status code and response headers
+    def get_group_individuals_with_http_info(group_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: GroupsApi.get_group_individuals ..."
+      end
+      
+      
+      # verify the required parameter 'group_id' is set
+      fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_group_individuals" if group_id.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/groups/{groupId}/individuals".sub('{format}','json').sub('{' + 'groupId' + '}', group_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 => 'Array<UserEntityListing>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GroupsApi#get_group_individuals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get group members, includes individuals, owners, and dynamically included people
     # 
     # @param group_id Group ID
     # @param [Hash] opts the optional parameters
@@ -314,7 +379,7 @@ module PureCloud
       return data
     end
 
-    # Get group members
+    # Get group members, includes individuals, owners, and dynamically included people
     # 
     # @param group_id Group ID
     # @param [Hash] opts the optional parameters
@@ -649,6 +714,101 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # Get group profile listing
+    # 
+    # @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 [Array<String>] :id id
+    # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
+    # @return [GroupProfileEntityListing]
+    def get_profiles_groups(opts = {})
+      data, _status_code, _headers = get_profiles_groups_with_http_info(opts)
+      return data
+    end
+
+    # Get group profile listing
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @option opts [Array<String>] :id id
+    # @option opts [String] :sort_order Ascending or descending sort order
+    # @return [Array<(GroupProfileEntityListing, Fixnum, Hash)>] GroupProfileEntityListing data, response status code and response headers
+    def get_profiles_groups_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: GroupsApi.get_profiles_groups ..."
+      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/profiles/groups".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[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
+      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 => 'GroupProfileEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GroupsApi#get_profiles_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Add members
     # 
     # @param group_id Group ID

data/lib/purecloudplatformclientv2/api/users_api.rb

@@ -1689,6 +1689,89 @@ module PureCloud
       return data, status_code, headers
     end
 
+    # List the organizations that have authorized/trusted the user.
+    # 
+    # @param user_id User ID
+    # @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)
+    # @return [TrustorEntityListing]
+    def get_user_trustors(user_id, opts = {})
+      data, _status_code, _headers = get_user_trustors_with_http_info(user_id, opts)
+      return data
+    end
+
+    # List the organizations that have authorized/trusted the user.
+    # 
+    # @param user_id User ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page_size Page size
+    # @option opts [Integer] :page_number Page number
+    # @return [Array<(TrustorEntityListing, Fixnum, Hash)>] TrustorEntityListing data, response status code and response headers
+    def get_user_trustors_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: UsersApi.get_user_trustors ..."
+      end
+      
+      
+      # verify the required parameter 'user_id' is set
+      fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_trustors" if user_id.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/api/v2/users/{userId}/trustors".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
+      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
+
+      # 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 => 'TrustorEntityListing')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: UsersApi#get_user_trustors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get the list of available users.
     # 
     # @param [Hash] opts the optional parameters

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'] = '29.0.0'
+      header_params['purecloud-sdk'] = '30.0.0'
       query_params = opts[:query_params] || {}
       form_params = opts[:form_params] || {}
 

data/lib/purecloudplatformclientv2/models/action_entity_listing.rb

@@ -32,10 +32,10 @@ module PureCloud
 
     attr_accessor :previous_uri
 
-    attr_accessor :last_uri
-
     attr_accessor :next_uri
 
+    attr_accessor :last_uri
+
     attr_accessor :page_count
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -56,10 +56,10 @@ module PureCloud
         
         :'previous_uri' => :'previousUri',
         
-        :'last_uri' => :'lastUri',
-        
         :'next_uri' => :'nextUri',
         
+        :'last_uri' => :'lastUri',
+        
         :'page_count' => :'pageCount'
         
       }
@@ -83,10 +83,10 @@ module PureCloud
         
         :'previous_uri' => :'String',
         
-        :'last_uri' => :'String',
-        
         :'next_uri' => :'String',
         
+        :'last_uri' => :'String',
+        
         :'page_count' => :'Integer'
         
       }
@@ -166,19 +166,19 @@ module PureCloud
       end
 
       
-      if attributes.has_key?(:'lastUri')
+      if attributes.has_key?(:'nextUri')
         
         
-        self.last_uri = attributes[:'lastUri']
+        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
@@ -313,8 +313,8 @@ module PureCloud
           self_uri == o.self_uri &&
           first_uri == o.first_uri &&
           previous_uri == o.previous_uri &&
-          last_uri == o.last_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, previous_uri, last_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