users_api.rb in purecloudplatformclientv2-7.0.0

- old
+ new

@@ -1224,10 +1224,11 @@
     # @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)
     # @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)
       return data
     end
@@ -1238,27 +1239,32 @@
     # @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
     # @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
         @api_client.config.logger.debug "Calling API: UsersApi.get_users ..."
       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
+      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')
 
       # 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']
       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 = {}
 
       # HTTP header 'Accept' (if needed)