fusionauth_client.rb in fusionauth_client-1.36.0

- old
+ new

@@ -2074,11 +2074,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the actions for the user with the given Id. This will return all time based actions that are active,
+    # Retrieves all the actions for the user with the given Id. This will return all time based actions that are active,
     # and inactive as well as non-time based actions.
     #
     # @param user_id [string] The Id of the user to fetch the actions for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_actions(user_id)
@@ -2087,11 +2087,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.
+    # Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in.
     #
     # @param user_id [string] The Id of the user to fetch the actions for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_actions_preventing_login(user_id)
       start.uri('/api/user/action')
@@ -2100,11 +2100,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the actions for the user with the given Id that are currently active.
+    # Retrieves all the actions for the user with the given Id that are currently active.
     # An active action means one that is time based and has not been canceled, and has not ended.
     #
     # @param user_id [string] The Id of the user to fetch the actions for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_active_actions(user_id)
@@ -2126,11 +2126,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the applications.
+    # Retrieves all the applications.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_applications()
       start.uri('/api/application')
           .get()
@@ -2160,11 +2160,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the connectors.
+    # Retrieves all the connectors.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_connectors()
       start.uri('/api/connector')
           .get()
@@ -2182,11 +2182,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the consent.
+    # Retrieves all the consent.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_consents()
       start.uri('/api/consent')
           .get()
@@ -2235,11 +2235,11 @@
           .post()
           .go()
     end
 
     #
-    # Retrieves all of the email templates.
+    # Retrieves all the email templates.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_email_templates()
       start.uri('/api/email/template')
           .get()
@@ -2286,11 +2286,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the Entity Types.
+    # Retrieves all the Entity Types.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_entity_types()
       start.uri('/api/entity/type')
           .get()
@@ -2308,11 +2308,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the families that a user belongs to.
+    # Retrieves all the families that a user belongs to.
     #
     # @param user_id [string] The User's id
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_families(user_id)
       start.uri('/api/user/family')
@@ -2320,11 +2320,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the members of a family by the unique Family Id.
+    # Retrieves all the members of a family by the unique Family Id.
     #
     # @param family_id [string] The unique Id of the Family.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_family_members_by_family_id(family_id)
       start.uri('/api/user/family')
@@ -2356,21 +2356,21 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the forms fields
+    # Retrieves all the forms fields
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_form_fields()
       start.uri('/api/form/field')
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the forms.
+    # Retrieves all the forms.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_forms()
       start.uri('/api/form')
           .get()
@@ -2388,11 +2388,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the groups.
+    # Retrieves all the groups.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_groups()
       start.uri('/api/group')
           .get()
@@ -2436,21 +2436,21 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the identity providers.
+    # Retrieves all the identity providers.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_identity_providers()
       start.uri('/api/identity-provider')
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the actions for the user with the given Id that are currently inactive.
+    # Retrieves all the actions for the user with the given Id that are currently inactive.
     # An inactive action means one that is time based and has been canceled or has expired, or is not time based.
     #
     # @param user_id [string] The Id of the user to fetch the actions for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_inactive_actions(user_id)
@@ -2460,22 +2460,22 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the applications that are currently inactive.
+    # Retrieves all the applications that are currently inactive.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_inactive_applications()
       start.uri('/api/application')
           .url_parameter('inactive', true)
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the user actions that are currently inactive.
+    # Retrieves all the user actions that are currently inactive.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_inactive_user_actions()
       start.uri('/api/user-action')
           .url_parameter('inactive', true)
@@ -2548,11 +2548,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the keys.
+    # Retrieves all the keys.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_keys()
       start.uri('/api/key')
           .get()
@@ -2570,21 +2570,21 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the lambdas.
+    # Retrieves all the lambdas.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_lambdas()
       start.uri('/api/lambda')
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the lambdas for the provided type.
+    # Retrieves all the lambdas for the provided type.
     #
     # @param type [OpenStruct, Hash] The type of the lambda to return.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_lambdas_by_type(type)
       start.uri('/api/lambda')
@@ -2633,11 +2633,11 @@
           .post()
           .go()
     end
 
     #
-    # Retrieves all of the message templates.
+    # Retrieves all the message templates.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_message_templates()
       start.uri('/api/message/template')
           .get()
@@ -2655,11 +2655,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the messengers.
+    # Retrieves all the messengers.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_messengers()
       start.uri('/api/messenger')
           .get()
@@ -2732,11 +2732,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the children for the given parent email address.
+    # Retrieves all the children for the given parent email address.
     #
     # @param parent_email [string] The email of the parent.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_pending_children(parent_email)
       start.uri('/api/user/family/pending')
@@ -2866,11 +2866,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the tenants.
+    # Retrieves all the tenants.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_tenants()
       start.uri('/api/tenant')
           .get()
@@ -2888,11 +2888,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the themes.
+    # Retrieves all the themes.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_themes()
       start.uri('/api/theme')
           .get()
@@ -2969,11 +2969,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the user actions.
+    # Retrieves all the user actions.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_user_actions()
       start.uri('/api/user-action')
           .get()
@@ -3041,11 +3041,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the comments for the user with the given Id.
+    # Retrieves all the comments for the user with the given Id.
     #
     # @param user_id [string] The Id of the user.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_user_comments(user_id)
       start.uri('/api/user/comment')
@@ -3065,11 +3065,11 @@
           .get()
           .go()
     end
 
     #
-    # Retrieves all of the consents for a User.
+    # Retrieves all the consents for a User.
     #
     # @param user_id [string] The User's Id
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_user_consents(user_id)
       start.uri('/api/user/consent')
@@ -3415,10 +3415,22 @@
           .post()
           .go()
     end
 
     #
+    # Searches group members with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_group_members(request)
+      start.uri('/api/group/member/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
     # Searches the IP Access Control Lists with the specified criteria and pagination.
     #
     # @param request [OpenStruct, Hash] The search criteria and pagination information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def search_ip_access_control_lists(request)
@@ -3805,9 +3817,21 @@
     # @param request [OpenStruct, Hash] The request that contains all of the new group information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_group(group_id, request)
       start.uri('/api/group')
           .url_segment(group_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
+    #
+    # Creates a member in a group.
+    #
+    # @param request [OpenStruct, Hash] The request object that contains all the information used to create the group member(s).
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_group_members(request)
+      start.uri('/api/group/member')
           .body_handler(FusionAuth::JSONBodyHandler.new(request))
           .put()
           .go()
     end
 