fusionauth_client 1.48.0 → 1.49.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2883c3474e5b77f5aeaadf6c8d2ce8aad98129beac6d6ae8ef145796c25d87b2
-  data.tar.gz: 72f588866593d1fb67c9ab6d275e9898cd27dd054037c2a4119750b3c4d9db39
+  metadata.gz: a52be92b848e67c0506bf9706082bd7cd0fe08a4c4caceedd7c10f45c8d5533c
+  data.tar.gz: 6c6ccec915997b8162b4c2b43f0b30e1faf9cf29e1da377564584186e8e15199
 SHA512:
-  metadata.gz: b73e0209ecd5575d495e8b334bbfb9b726360e8c25894d5f97366a6a24b7629f9e4c4e455a6db8f340d57052b0b5eb3c61933f5141a5676b8806382c5fdcbc3b
-  data.tar.gz: c1957c0e7f3fddbed0345afe9dc0110c0729a7603095660143d0c41bb35ae83a026787c5ac65d23b150adf7a008c397f476b1d5e501ef4b3c18f8601c3b504fe
+  metadata.gz: 7a70a442af01bc63721eee306616a3018bb61eac5ffd9fdf0d70bc7c1b98a6fd06cd95491e1bf54151314610e6d1454ae93f919739a423e8328360979f7663db
+  data.tar.gz: ce1fd04311af248318fe103c184a76318ac64a68219659492a43a1898d7ace0a20e70d817bbb3928a2015033f4829391044a709774fe93b5e10c9e968249dbd5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fusionauth_client (1.48.0)
+    fusionauth_client (1.49.1)
 
 GEM
   remote: https://rubygems.org/

data/build.savant

@@ -15,7 +15,7 @@
  */
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.48.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.49.1", licenses: ["ApacheV2_0"]) {
   workflow {
     fetch {
       cache()

data/fusionauth_client.gemspec

@@ -19,7 +19,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name = 'fusionauth_client'
-  spec.version = '1.48.0'
+  spec.version = '1.49.1'
   spec.authors = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -46,7 +46,7 @@ module FusionAuth
     # "actioner". Both user ids are required in the request object.
     #
     # @param request [OpenStruct, Hash] 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 [FusionAuth::ClientResponse] The ClientResponse object.
     def action_user(request)
       start.uri('/api/user/action')
@@ -56,7 +56,7 @@ module FusionAuth
     end
 
     #
-    # 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)
     #
     # @param request [OpenStruct, Hash] An optional request that contains the license text to activate Reactor (useful for air-gap deployments of FusionAuth).
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -68,9 +68,9 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
-    # @param family_id [string] The id of the family.
+    # @param family_id [string] The Id of the family.
     # @param request [OpenStruct, Hash] The request object that contains all the information used to determine which user to add to the family.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def add_user_to_family(family_id, request)
@@ -105,7 +105,7 @@ module FusionAuth
     #
     # Cancels the user action.
     #
-    # @param action_id [string] The action id of the action to cancel.
+    # @param action_id [string] The action Id of the action to cancel.
     # @param request [OpenStruct, Hash] The action request that contains the information about the cancellation.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def cancel_action(action_id, request)
@@ -135,7 +135,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
@@ -299,7 +299,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param application_id [string] The Id of the application to create the role on.
@@ -401,7 +401,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param entity_type_id [string] The Id of the entity type to create the permission on.
@@ -419,10 +419,10 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
-    # @param family_id [string] (Optional) The id for the family. If not provided a secure random UUID will be generated.
+    # @param family_id [string] (Optional) The Id for the family. If not provided a secure random UUID will be generated.
     # @param request [OpenStruct, Hash] The request object that contains all the information used to create the family.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def create_family(family_id, request)
@@ -1748,7 +1748,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param application_id [string] The Id of the application that the role belongs to.
     # @param role_id [string] The Id of the role to update.
@@ -1903,7 +1903,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param user_id [string] The Id of the user whose registration is going to be updated.
     # @param request [OpenStruct, Hash] The request that contains just the new registration information.
@@ -2103,7 +2103,7 @@ module FusionAuth
     # 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.
     #
     # @param user_id [string] (Optional) The Id of the user being registered for the application and optionally created.
@@ -2136,8 +2136,8 @@ module FusionAuth
     #
     # Removes a user from the family with the given id.
     #
-    # @param family_id [string] The id of the family to remove the user from.
-    # @param user_id [string] The id of the user to remove from the family.
+    # @param family_id [string] The Id of the family to remove the user from.
+    # @param user_id [string] The Id of the user to remove from the family.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def remove_user_from_family(family_id, user_id)
       start.uri('/api/user/family')
@@ -2253,7 +2253,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param application_id [string] (Optional) The application id.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2549,7 +2549,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param identity_provider_id [string] The identity provider Id.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2955,7 +2955,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param user_id [string] The Id of the user.
     # @param application_id [string] The Id of the application.
@@ -3479,8 +3479,8 @@ module FusionAuth
     #  - revokeRefreshTokensByUserIdForApplication
     #
     # @param token [string] (Optional) The refresh token to delete.
-    # @param user_id [string] (Optional) The user id whose tokens to delete.
-    # @param application_id [string] (Optional) The application id of the tokens to delete.
+    # @param user_id [string] (Optional) The user Id whose tokens to delete.
+    # @param application_id [string] (Optional) The application Id of the tokens to delete.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def revoke_refresh_token(token, user_id, application_id)
       start.uri('/api/jwt/refresh')
@@ -3639,7 +3639,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param ids [Array] The entity ids to search for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3807,7 +3807,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param ids [Array] The user ids to search for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3820,7 +3820,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param ids [Array] The user ids to search for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3874,7 +3874,7 @@ module FusionAuth
     # Send an email using an email template id. You can optionally provide <code>requestData</code> to access key value
     # pairs in the email template.
     #
-    # @param email_template_id [string] The id for the template.
+    # @param email_template_id [string] The Id for the template.
     # @param request [OpenStruct, Hash] The send email request that contains all the information used to send the email.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def send_email(email_template_id, request)
@@ -4069,7 +4069,7 @@ module FusionAuth
     end
 
     #
-    # Updates the application role with the given id for the application.
+    # Updates the application role with the given Id for the application.
     #
     # @param application_id [string] The Id of the application that the role belongs to.
     # @param role_id [string] The Id of the role to update.
@@ -4156,7 +4156,7 @@ module FusionAuth
     end
 
     #
-    # Updates the permission with the given id for the entity type.
+    # Updates the permission with the given Id for the entity type.
     #
     # @param entity_type_id [string] The Id of the entityType that the permission belongs to.
     # @param permission_id [string] The Id of the permission to update.
@@ -4323,7 +4323,7 @@ module FusionAuth
     end
 
     #
-    # 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.
     #
     # @param user_id [string] The Id of the user whose registration is going to be updated.
     # @param request [OpenStruct, Hash] The request that contains all the new registration information.
@@ -4514,7 +4514,7 @@ module FusionAuth
     #
     # Confirms a email verification. The Id given is usually from an email sent to the user.
     #
-    # @param verification_id [string] The email verification id sent to the user.
+    # @param verification_id [string] The email verification Id sent to the user.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     # @deprecated This method has been renamed to verify_email_address and changed to take a JSON request body, use that method instead.
     def verify_email(verification_id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.48.0
+  version: 1.49.1
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.