Rename access_key_id to key in Access Keys API to be consistent with Keen API. Fix parameter name in README

Author: wiktorolko

README.rst

@@ -567,48 +567,48 @@ The Python client enables the creation and manipulation of `Access Keys <https:/
     )
 
     # Create an access key. See: https://keen.io/docs/access/access-keys/#customizing-your-access-key
-    client.create_access_key(name="Dave_Barry_Key", is_enabled=True, permitted=["writes", "cached_queries"],
+    client.create_access_key(name="Dave_Barry_Key", is_active=True, permitted=["writes", "cached_queries"],
                              options={"cached_queries": {"allowed": ["dave_barry_in_cyberspace_sales"]}})
 
     # Display all access keys associated with this client's project.
     client.list_access_keys()
 
     # Get details on a particular access key.
-    client.get_access_key(access_key_id="ABCDEFGHIJKLMNOPQRSTUVWXYZ")
+    client.get_access_key(key="ABCDEFGHIJKLMNOPQRSTUVWXYZ")
 
     # Revoke (disable) an access key.
-    client.revoke_access_key(access_key_id="ABCDEFGHIJKLMNOPQRSTUVWXYZ")
+    client.revoke_access_key(key="ABCDEFGHIJKLMNOPQRSTUVWXYZ")
 
     # Unrevoke (re-enable) an access key.
-    client.unrevoke_access_key(access_key_id="ABCDEFGHIJKLMNOPQRSTUVWXYZ")
+    client.unrevoke_access_key(key="ABCDEFGHIJKLMNOPQRSTUVWXYZ")
 
     # Delete an access key
-    client.delete_access_key(access_key_id="ABCDEFGHIJKLMNOPQRSTUVWXYZ")
+    client.delete_access_key(key="ABCDEFGHIJKLMNOPQRSTUVWXYZ")
 
     # Change just the name of an access key.
-    client.update_access_key_name(access_key_id="ABCDEFGHIJKLMNOPQRSTUVWXYZ", name="Some_New_Name")
+    client.update_access_key_name(key="ABCDEFGHIJKLMNOPQRSTUVWXYZ", name="Some_New_Name")
 
     # Add new access key permissions to existing permissions on a given key.
     # In this case the set of permissions currently contains "writes" and "cached_queries".
     # This function call keeps the old permissions and adds "queries" to that set.
     #     ("writes", "cached_queries") + ("queries") = ("writes", "cached_queries", "queries")
-    client.add_access_key_permissions(access_key_id="ABCDEFGHIJKLMNOPQRSTUVWXYZ", permissions=["queries"])
+    client.add_access_key_permissions(key="ABCDEFGHIJKLMNOPQRSTUVWXYZ", permissions=["queries"])
 
     # Remove one or more access key permissions from a given key.
     # In this case the set of permissions currently contains "writes", "cached_queries", and "queries".
     # This function call will keep the old permissions not explicitly removed here.
     # So we will remove both "writes" and "queries" from the set, leaving only "cached_queries".
     #     ("writes", "cached_queries", "queries") - ("writes", "queries") = ("cached_queries")
-    client.remove_access_key_permissions(access_key_id="ABCDEFGHIJKLMNOPQRSTUVWXYZ", permissions=["writes", "queries"])
+    client.remove_access_key_permissions(key="ABCDEFGHIJKLMNOPQRSTUVWXYZ", permissions=["writes", "queries"])
 
     # We can also perform a full update on the permissions, replacing all existing permissions with a new list.
     # In this case our existing permissions contains only "cached_queries".
     # We will replace this set with the "writes" permission with this function call.
     #     ("cached_queries") REPLACE-WITH ("writes") = ("writes")
-    client.update_access_key_permissions(access_key_id="ABCDEFGHIJKLMNOPQRSTUVWXYZ", permissions=["writes"])
+    client.update_access_key_permissions(key="ABCDEFGHIJKLMNOPQRSTUVWXYZ", permissions=["writes"])
 
     # Replace all existing key options with this new options object.
-    client.update_access_key_options(access_key_id="ABCDEFGHIJKLMNOPQRSTUVWXYZ", options={"writes": {
+    client.update_access_key_options(key="ABCDEFGHIJKLMNOPQRSTUVWXYZ", options={"writes": {
         "autofill": {
             "customer": {
                 "id": "93iskds39kd93id",
@@ -620,7 +620,7 @@ The Python client enables the creation and manipulation of `Access Keys <https:/
     # Replace everything but the key ID with what is supplied here.
     # If a field is not supplied here, it will be set to a blank value.
     # In this case, no options are supplied, so all options will be removed.
-    client.update_access_key_full(access_key_id="ABCDEFGHIJKLMNOPQRSTUVWXYZ", name="Strong_Bad", is_active=True, permitted=["queries"])
+    client.update_access_key_full(key="ABCDEFGHIJKLMNOPQRSTUVWXYZ", name="Strong_Bad", is_active=True, permitted=["queries"])
 
 
 Create Scoped Keys (**Deprecated**)

keen/__init__.py

@@ -519,112 +519,112 @@ def list_access_keys():
     _initialize_client_from_environment()
     return _client.list_access_keys()
 
-def get_access_key(access_key_id):
+def get_access_key(key):
     """
     Returns details on a particular access key. A master key must be set first.
 
-    :param access_key_id: the 'key' value of the access key to retreive data from
+    :param key: the 'key' value of the access key to retreive data from
     """
     _initialize_client_from_environment()
-    return _client.get_access_key(access_key_id)
+    return _client.get_access_key(key)
 
-def update_access_key_name(access_key_id, name):
+def update_access_key_name(key, name):
     """
     Updates only the name portion of an access key.
 
-    :param access_key_id: the 'key' value of the access key to change the name of
+    :param key: the 'key' value of the access key to change the name of
     :param name: the new name to give this access key
     """
     _initialize_client_from_environment()
-    return _client.update_access_key_name(access_key_id, name)
+    return _client.update_access_key_name(key, name)
 
-def add_access_key_permissions(access_key_id, permissions):
+def add_access_key_permissions(key, permissions):
     """
     Adds to the existing list of permissions on this key with the contents of this list.
     Will not remove any existing permissions or modify the remainder of the key.
 
-    :param access_key_id: the 'key' value of the access key to add permissions to
+    :param key: the 'key' value of the access key to add permissions to
     :param permissions: the new permissions to add to the existing list of permissions
     """
     _initialize_client_from_environment()
-    return _client.add_access_key_permissions(access_key_id, permissions)
+    return _client.add_access_key_permissions(key, permissions)
 
-def remove_access_key_permissions(access_key_id, permissions):
+def remove_access_key_permissions(key, permissions):
     """
     Removes a list of permissions from the existing list of permissions.
     Will not remove all existing permissions unless all such permissions are included
     in this list. Not to be confused with key revocation.
 
     See also: revoke_access_key()
 
-    :param access_key_id: the 'key' value of the access key to remove some permissions from
+    :param key: the 'key' value of the access key to remove some permissions from
     :param permissions: the permissions you wish to remove from this access key
     """
     _initialize_client_from_environment()
-    return _client.remove_access_key_permissions(access_key_id, permissions)
+    return _client.remove_access_key_permissions(key, permissions)
 
-def update_access_key_permissions(access_key_id, permissions):
+def update_access_key_permissions(key, permissions):
     """
     Replaces all of the permissions on the access key but does not change
     non-permission properties such as the key's name.
 
     See also: add_access_key_permissions() and remove_access_key_permissions().
 
-    :param access_key_id: the 'key' value of the access key to change the permissions of
+    :param key: the 'key' value of the access key to change the permissions of
     :param permissions: the new list of permissions for this key
     """
     _initialize_client_from_environment()
-    return _client.update_access_key_permissions(access_key_id, permissions)
+    return _client.update_access_key_permissions(key, permissions)
 
-def update_access_key_options(access_key_id, options):
+def update_access_key_options(key, options):
     """
     Replaces all of the options on the access key but does not change
     non-option properties such as permissions or the key's name.
 
-    :param access_key_id: the 'key' value of the access key to change the options of
+    :param key: the 'key' value of the access key to change the options of
     :param options: the new dictionary of options for this key
     """
     _initialize_client_from_environment()
-    return _client.update_access_key_options(access_key_id, options)
+    return _client.update_access_key_options(key, options)
 
-def update_access_key_full(access_key_id, name, is_active, permitted, options):
+def update_access_key_full(key, name, is_active, permitted, options):
     """
     Replaces the 'name', 'is_active', 'permitted', and 'options' values of a given key.
     A master key must be set first.
 
-    :param access_key_id: the 'key' value of the access key for which the values will be replaced
+    :param key: the 'key' value of the access key for which the values will be replaced
     :param name: the new name desired for this access key
     :param is_active: whether the key should become enabled (True) or revoked (False)
     :param permitted: the new list of permissions desired for this access key
     :param options: the new dictionary of options for this access key
     """
     _initialize_client_from_environment()
-    return _client.update_access_key_full(access_key_id, name, is_active, permitted, options)
+    return _client.update_access_key_full(key, name, is_active, permitted, options)
 
-def revoke_access_key(access_key_id):
+def revoke_access_key(key):
     """
     Revokes an access key. "Bad dog! No biscuit!"
 
-    :param access_key_id: the 'key' value of the access key to revoke
+    :param key: the 'key' value of the access key to revoke
     """
     _initialize_client_from_environment()
-    return _client.revoke_access_key(access_key_id)
+    return _client.revoke_access_key(key)
 
-def unrevoke_access_key(access_key_id):
+def unrevoke_access_key(key):
     """
     Re-enables an access key.
 
-    :param access_key_id: the 'key' value of the access key to re-enable (unrevoke)
+    :param key: the 'key' value of the access key to re-enable (unrevoke)
     """
     _initialize_client_from_environment()
-    return _client.unrevoke_access_key(access_key_id)
+    return _client.unrevoke_access_key(key)
 
 
-def delete_access_key(access_key_id):
+def delete_access_key(key):
     """
     Deletes an access key.
 
-    :param access_key_id: the 'key' value of the access key to delete
+    :param key: the 'key' value of the access key to delete
     """
     _initialize_client_from_environment()
-    return _client.delete_access_key(access_key_id)
+    return _client.delete_access_key(key)