Domain sync

Author: robotdan

src/main/python/fusionauth/fusionauth_client.py

@@ -43,7 +43,7 @@ def action_user(self, request):
 
         Attributes:
             request: The action request that includes all the information about the action being taken including
-                    the id of the action, any options and the duration (if applicable).
+                    the Id of the action, any options and the duration (if applicable).
         """
         return self.start().uri('/api/user/action') \
             .body_handler(JSONBodyHandler(request)) \
@@ -52,7 +52,7 @@ def action_user(self, request):
 
     def activate_reactor(self, request):
         """
-        Activates the FusionAuth Reactor using a license id and optionally a license text (for air-gapped deployments)
+        Activates the FusionAuth Reactor using a license Id and optionally a license text (for air-gapped deployments)
 
         Attributes:
             request: An optional request that contains the license text to activate Reactor (useful for air-gap deployments of FusionAuth).
@@ -64,10 +64,10 @@ def activate_reactor(self, request):
 
     def add_user_to_family(self, family_id, request):
         """
-        Adds a user to an existing family. The family id must be specified.
+        Adds a user to an existing family. The family Id must be specified.
 
         Attributes:
-            family_id: The id of the family.
+            family_id: The Id of the family.
             request: The request object that contains all the information used to determine which user to add to the family.
         """
         return self.start().uri('/api/user/family') \
@@ -102,7 +102,7 @@ def cancel_action(self, action_id, request):
         Cancels the user action.
 
         Attributes:
-            action_id: The action id of the action to cancel.
+            action_id: The action Id of the action to cancel.
             request: The action request that contains the information about the cancellation.
         """
         return self.start().uri('/api/user/action') \
@@ -131,7 +131,7 @@ def change_password(self, change_password_id, request):
 
     def change_password_by_identity(self, request):
         """
-        Changes a user's password using their identity (login id and password). Using a loginId instead of the changePasswordId
+        Changes a user's password using their identity (loginId and password). Using a loginId instead of the changePasswordId
         bypasses the email verification and allows a password to be changed directly without first calling the #forgotPassword
         method.
 
@@ -295,7 +295,7 @@ def create_application(self, request, application_id=None):
 
     def create_application_role(self, application_id, request, role_id=None):
         """
-        Creates a new role for an application. You must specify the id of the application you are creating the role for.
+        Creates a new role for an application. You must specify the Id of the application you are creating the role for.
         You can optionally specify an Id for the role inside the ApplicationRole object itself, if not provided one will be generated.
 
         Attributes:
@@ -397,7 +397,7 @@ def create_entity_type(self, request, entity_type_id=None):
 
     def create_entity_type_permission(self, entity_type_id, request, permission_id=None):
         """
-        Creates a new permission for an entity type. You must specify the id of the entity type you are creating the permission for.
+        Creates a new permission for an entity type. You must specify the Id of the entity type you are creating the permission for.
         You can optionally specify an Id for the permission inside the EntityTypePermission object itself, if not provided one will be generated.
 
         Attributes:
@@ -415,11 +415,11 @@ def create_entity_type_permission(self, entity_type_id, request, permission_id=N
 
     def create_family(self, request, family_id=None):
         """
-        Creates a family with the user id in the request as the owner and sole member of the family. You can optionally specify an id for the
+        Creates a family with the user Id in the request as the owner and sole member of the family. You can optionally specify an Id for the
         family, if not provided one will be generated.
 
         Attributes:
-            family_id: (Optional) The id for the family. If not provided a secure random UUID will be generated.
+            family_id: (Optional) The Id for the family. If not provided a secure random UUID will be generated.
             request: The request object that contains all the information used to create the family.
         """
         return self.start().uri('/api/user/family') \
@@ -1744,7 +1744,7 @@ def patch_application(self, application_id, request):
 
     def patch_application_role(self, application_id, role_id, request):
         """
-        Updates, via PATCH, the application role with the given id for the application.
+        Updates, via PATCH, the application role with the given Id for the application.
 
         Attributes:
             application_id: The Id of the application that the role belongs to.
@@ -1899,7 +1899,7 @@ def patch_messenger(self, messenger_id, request):
 
     def patch_registration(self, user_id, request):
         """
-        Updates, via PATCH, the registration for the user with the given id and the application defined in the request.
+        Updates, via PATCH, the registration for the user with the given Id and the application defined in the request.
 
         Attributes:
             user_id: The Id of the user whose registration is going to be updated.
@@ -2099,7 +2099,7 @@ def register(self, request, user_id=None):
         Registers a user for an application. If you provide the User and the UserRegistration object on this request, it
         will create the user as well as register them for the application. This is called a Full Registration. However, if
         you only provide the UserRegistration object, then the user must already exist and they will be registered for the
-        application. The user id can also be provided and it will either be used to look up an existing user or it will be
+        application. The user Id can also be provided and it will either be used to look up an existing user or it will be
         used for the newly created User.
 
         Attributes:
@@ -2133,8 +2133,8 @@ def remove_user_from_family(self, family_id, user_id):
         Removes a user from the family with the given id.
 
         Attributes:
-            family_id: The id of the family to remove the user from.
-            user_id: The id of the user to remove from the family.
+            family_id: The Id of the family to remove the user from.
+            user_id: The Id of the user to remove from the family.
         """
         return self.start().uri('/api/user/family') \
             .url_segment(family_id) \
@@ -2249,7 +2249,7 @@ def retrieve_active_actions(self, user_id):
 
     def retrieve_application(self, application_id=None):
         """
-        Retrieves the application for the given id or all the applications if the id is null.
+        Retrieves the application for the given Id or all the applications if the Id is null.
 
         Attributes:
             application_id: (Optional) The application id.
@@ -2545,7 +2545,7 @@ def retrieve_ip_access_control_list(self, ip_access_control_list_id):
 
     def retrieve_identity_provider(self, identity_provider_id):
         """
-        Retrieves the identity provider for the given id or all the identity providers if the id is null.
+        Retrieves the identity provider for the given Id or all the identity providers if the Id is null.
 
         Attributes:
             identity_provider_id: The identity provider Id.
@@ -2951,7 +2951,7 @@ def retrieve_refresh_tokens(self, user_id):
 
     def retrieve_registration(self, user_id, application_id):
         """
-        Retrieves the user registration for the user with the given id and the given application id.
+        Retrieves the user registration for the user with the given Id and the given application id.
 
         Attributes:
             user_id: The Id of the user.
@@ -3476,8 +3476,8 @@ def revoke_refresh_token(self, token=None, user_id=None, application_id=None):
 
         Attributes:
             token: (Optional) The refresh token to delete.
-            user_id: (Optional) The user id whose tokens to delete.
-            application_id: (Optional) The application id of the tokens to delete.
+            user_id: (Optional) The user Id whose tokens to delete.
+            application_id: (Optional) The application Id of the tokens to delete.
         """
         return self.start().uri('/api/jwt/refresh') \
             .url_parameter('token', self.convert_true_false(token)) \
@@ -3635,7 +3635,7 @@ def search_entities(self, request):
 
     def search_entities_by_ids(self, ids):
         """
-        Retrieves the entities for the given ids. If any id is invalid, it is ignored.
+        Retrieves the entities for the given ids. If any Id is invalid, it is ignored.
 
         Attributes:
             ids: The entity ids to search for.
@@ -3804,7 +3804,7 @@ def search_user_comments(self, request):
     @deprecated("This method has been renamed to search_users_by_ids, use that method instead.")
     def search_users(self, ids):
         """
-        Retrieves the users for the given ids. If any id is invalid, it is ignored.
+        Retrieves the users for the given ids. If any Id is invalid, it is ignored.
 
         Attributes:
             ids: The user ids to search for.
@@ -3816,7 +3816,7 @@ def search_users(self, ids):
 
     def search_users_by_ids(self, ids):
         """
-        Retrieves the users for the given ids. If any id is invalid, it is ignored.
+        Retrieves the users for the given ids. If any Id is invalid, it is ignored.
 
         Attributes:
             ids: The user ids to search for.
@@ -3871,7 +3871,7 @@ def send_email(self, email_template_id, request):
         pairs in the email template.
 
         Attributes:
-            email_template_id: The id for the template.
+            email_template_id: The Id for the template.
             request: The send email request that contains all the information used to send the email.
         """
         return self.start().uri('/api/email/send') \
@@ -4065,7 +4065,7 @@ def update_application(self, application_id, request):
 
     def update_application_role(self, application_id, role_id, request):
         """
-        Updates the application role with the given id for the application.
+        Updates the application role with the given Id for the application.
 
         Attributes:
             application_id: The Id of the application that the role belongs to.
@@ -4152,7 +4152,7 @@ def update_entity_type(self, entity_type_id, request):
 
     def update_entity_type_permission(self, entity_type_id, permission_id, request):
         """
-        Updates the permission with the given id for the entity type.
+        Updates the permission with the given Id for the entity type.
 
         Attributes:
             entity_type_id: The Id of the entityType that the permission belongs to.
@@ -4319,7 +4319,7 @@ def update_messenger(self, messenger_id, request):
 
     def update_registration(self, user_id, request):
         """
-        Updates the registration for the user with the given id and the application defined in the request.
+        Updates the registration for the user with the given Id and the application defined in the request.
 
         Attributes:
             user_id: The Id of the user whose registration is going to be updated.
@@ -4512,7 +4512,7 @@ def verify_email(self, verification_id):
         Confirms a email verification. The Id given is usually from an email sent to the user.
 
         Attributes:
-            verification_id: The email verification id sent to the user.
+            verification_id: The email verification Id sent to the user.
         """
         return self.start_anonymous().uri('/api/user/verify-email') \
             .url_segment(verification_id) \