Merge pull request #273 from algolia/rename_user_key

rename user_key to api_key

Author: LeoErcolanelli

algoliasearch/client.py

@@ -330,25 +330,40 @@ def init_index(self, index_name):
     def listUserKeys(self):
         return self.list_user_keys()
 
+    @deprecated
     def list_user_keys(self):
-        """List all existing user keys with their associated ACLs."""
+        """Use `list_api_keys`"""
+        return self.list_api_keys()
+
+    def list_api_keys(self):
+        """List all existing api keys with their associated ACLs."""
         return self._req(True, '/1/keys', 'GET')
 
     @deprecated
     def getUserKeyACL(self, key):
         return self.get_user_key_acl(key)
 
+    @deprecated
     def get_user_key_acl(self, key):
-        """'Get ACL of a user key."""
+        """Use `get_api_key_acl`"""
+        return self.get_api_key_acl(key)
+
+    def get_api_key_acl(self, key):
+        """'Get ACL of an api key."""
         path = '/1/keys/%s' % key
         return self._req(True, path, 'GET')
 
     @deprecated
     def deleteUserKey(self, key):
         return self.delete_user_key(key)
 
+    @deprecated
     def delete_user_key(self, key):
-        """Delete an existing user key."""
+        """Use `delete_api_key`"""
+        return self.delete_api_key(key)
+
+    def delete_api_key(self, key):
+        """Delete an existing api key."""
         path = '/1/keys/%s' % key
         return self._req(False, path, 'DELETE')
 
@@ -361,13 +376,25 @@ def addUserKey(self, obj,
         return self.add_user_key(obj, validity, max_queries_per_ip_per_hour,
                                  max_hits_per_query, indexes)
 
+    @deprecated
     def add_user_key(self, obj,
                      validity=0,
                      max_queries_per_ip_per_hour=0,
                      max_hits_per_query=0,
                      indexes=None):
+        """Use `add_api_key`"""
+        return self.add_api_key(
+            obj, validity, max_queries_per_ip_per_hour, max_hits_per_query,
+            indexes
+        )
+
+    def add_api_key(self, obj,
+                    validity=0,
+                    max_queries_per_ip_per_hour=0,
+                    max_hits_per_query=0,
+                    indexes=None):
         """
-        Create a new user key.
+        Create a new api key.
 
         @param obj can be two different parameters:
             The list of parameters for this key. Defined by a NSDictionary that
@@ -410,13 +437,26 @@ def add_user_key(self, obj,
 
         return self._req(False, '/1/keys', 'POST', data=obj)
 
+    @deprecated
     def update_user_key(self, key, obj,
                         validity=None,
                         max_queries_per_ip_per_hour=None,
                         max_hits_per_query=None,
                         indexes=None):
+        """Use `update_api_key`"""
+        return self.update_api_key(
+            key, obj, validity, max_queries_per_ip_per_hour,
+            max_hits_per_query, indexes
+        )
+
+
+    def update_api_key(self, key, obj,
+                        validity=None,
+                        max_queries_per_ip_per_hour=None,
+                        max_hits_per_query=None,
+                        indexes=None):
         """
-        Update a user key.
+        Update a api key.
 
         @param obj can be two different parameters:
             The list of parameters for this key. Defined by a NSDictionary that

algoliasearch/index.py

@@ -798,27 +798,42 @@ def set_settings(self, settings, forward_to_slaves=True,
     def listUserKeys(self):
         return self.list_user_keys()
 
+    @deprecated
     def list_user_keys(self):
+        """Use `list_api_keys`"""
+        return self.list_api_keys()
+
+    def list_api_keys(self):
         """
-        List all existing user keys of this index with their associated ACLs.
+        List all existing api keys of this index with their associated ACLs.
         """
         return self._req(True, '/keys', 'GET')
 
     @deprecated
     def getUserKeyACL(self, key):
         return self.get_user_key_acl(key)
 
+    @deprecated
     def get_user_key_acl(self, key):
-        """Get ACL of a user key associated to this index."""
+        """Use `get_api_key_acl`"""
+        return self.get_api_key_acl(key)
+
+    def get_api_key_acl(self, key):
+        """Get ACL of a api key associated to this index."""
         path = '/keys/%s' % key
         return self._req(True, path, 'GET')
 
     @deprecated
     def deleteUserKey(self, key):
         return self.delete_user_key(key)
 
+    @deprecated
     def delete_user_key(self, key):
-        """Delete an existing user key associated to this index."""
+        """Use `delete_api_key`"""
+        return self.delete_api_key(key)
+
+    def delete_api_key(self, key):
+        """Delete an existing api key associated to this index."""
         path = '/keys/%s' % key
         return self._req(False, path, 'DELETE')
 
@@ -828,10 +843,19 @@ def addUserKey(self, obj, validity=0, max_queries_per_ip_per_hour=0,
         return self.add_user_key(obj, validity, max_queries_per_ip_per_hour,
                                  max_hits_per_query)
 
+    @deprecated
     def add_user_key(self, obj, validity=0, max_queries_per_ip_per_hour=0,
                      max_hits_per_query=0):
+        """Use `add_api_key`"""
+        return self.add_api_key(
+            obj, validity, max_queries_per_ip_per_hour,
+            max_hits_per_query
+        )
+
+    def add_api_key(self, obj, validity=0, max_queries_per_ip_per_hour=0,
+                    max_hits_per_query=0):
         """
-        Create a new user key associated to this index (can only access to
+        Create a new api key associated to this index (can only access to
         this index).
 
         @param obj can be two different parameters:
@@ -872,11 +896,21 @@ def add_user_key(self, obj, validity=0, max_queries_per_ip_per_hour=0,
 
         return self._req(False, '/keys', 'POST', data=obj)
 
+    @deprecated
     def update_user_key(self, key, obj, validity=None,
                         max_queries_per_ip_per_hour=None,
                         max_hits_per_query=None):
+        """Use `update_api_key`"""
+        return self.update_api_key(
+            key, obj, validity, max_queries_per_ip_per_hour,
+            max_hits_per_query
+        )
+
+    def update_api_key(self, key, obj, validity=None,
+                        max_queries_per_ip_per_hour=None,
+                        max_hits_per_query=None):
         """
-        Update a user key associated to this index (can only access to this index).
+        Update a api key associated to this index (can only access to this index).
 
         @param obj can be two different parameters:
             The list of parameters for this key. Defined by a dictionary that

algoliasearch/version.py

@@ -1 +1 @@
-VERSION = "1.11.2"
+VERSION = "1.11.3"