fusionauth_client 1.25.0 → 1.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61ebe66291227393968cfd972f5668175aca99e0780bc45f5b69b17b99524a82
-  data.tar.gz: 5579794527c8a3dfa909779b714cfe76c6f95e4561c8a01801d7b91595e45f47
+  metadata.gz: ba0a948430d381623a2284f06d8fab72d1a6547475df8b1a7f19208e785fc72f
+  data.tar.gz: 5c848be1487fc76c2bd45bb5982204a1d38305b40547f40203f099ed352e2b4d
 SHA512:
-  metadata.gz: f925ced42b1e203af544a548260e120c944fede38dcaf9d785d5c59ee0ed7f3093044a8662136618e2c44d3e5815ba1be815a11c117d1b5e8b6bd4ef1b88d8a3
-  data.tar.gz: a120d54a3319323474804b9514198dd05bf459c5eca9ffbffb57d710dfd7e3cfa98e99e457d7b306d4d27aac8e6131e2c5b24b9d65de4a1eff3c7c8d797fd35c
+  metadata.gz: 2e4efd2ed79453f1ec5137abe1b030ac90e45b5c8975139cc1f527fcb3b307eca88bde3d6a83ac81718dff160085ce99a3a108b38dfc02d4cd1c5ee26aa212c7
+  data.tar.gz: 8e8b75dc51af13f096e7606463a1cf0effe265c866de3656a3df68e674b880c9de9185e4d06281272c43dfa71e9539ebdf2d861ca3e4610ee58da0c943c39fd4

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    fusionauth_client (1.28.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.8.3)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-19
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  fusionauth_client!
+  minitest (= 5.8.3)
+  rake (= 12.3.3)
+
+RUBY VERSION
+   ruby 2.5.1p57
+
+BUNDLED WITH
+   2.2.5

data/build.savant

@@ -16,7 +16,7 @@
 savantVersion = "1.0.0"
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.25.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.28.0", licenses: ["ApacheV2_0"]) {
   workflow {
     standard()
   }

data/fusionauth-ruby-client.iml

@@ -16,16 +16,16 @@
     <option name="myRootTask">
       <RakeTaskImpl id="rake">
         <subtasks>
-          <RakeTaskImpl description="Build fusionauth_client-1.24.1.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl description="Build fusionauth_client-1.26.0.gem into the pkg directory" fullCommand="build" id="build" />
           <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
           <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
-          <RakeTaskImpl description="Build and install fusionauth_client-1.24.1.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl description="Build and install fusionauth_client-1.26.0.gem into system gems" fullCommand="install" id="install" />
           <RakeTaskImpl id="install">
             <subtasks>
-              <RakeTaskImpl description="Build and install fusionauth_client-1.24.1.gem into system gems without network access" fullCommand="install:local" id="local" />
+              <RakeTaskImpl description="Build and install fusionauth_client-1.26.0.gem into system gems without network access" fullCommand="install:local" id="local" />
             </subtasks>
           </RakeTaskImpl>
-          <RakeTaskImpl description="Create tag v1.24.1 and build and push fusionauth_client-1.24.1.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Create tag v1.26.0 and build and push fusionauth_client-1.26.0.gem to https://rubygems.org" fullCommand="release[remote]" id="release[remote]" />
           <RakeTaskImpl description="Run tests" fullCommand="test" id="test" />
           <RakeTaskImpl description="" fullCommand="default" id="default" />
           <RakeTaskImpl description="" fullCommand="release" id="release" />

data/fusionauth_client.gemspec

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

data/lib/fusionauth/fusionauth_client.rb

@@ -55,6 +55,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # 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.
+    def activate_reactor(request)
+      start.uri('/api/reactor')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Adds a user to an existing family. The family id must be specified.
     #
@@ -91,7 +103,7 @@ module FusionAuth
     # @param request [OpenStruct, Hash] The change password request that contains all of the information used to change the password.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def change_password(change_password_id, request)
-      start.uri('/api/user/change-password')
+      startAnonymous.uri('/api/user/change-password')
           .url_segment(change_password_id)
           .body_handler(FusionAuth::JSONBodyHandler.new(request))
           .post()
@@ -124,6 +136,24 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Creates an API key. You can optionally specify a unique Id for the key, if not provided one will be generated.
+    # an API key can only be created with equal or lesser authority. An API key cannot create another API key unless it is granted 
+    # to that API key.
+    # 
+    # If an API key is locked to a tenant, it can only create API Keys for that same tenant.
+    #
+    # @param key_id [string] (Optional) The unique Id of the API key. If not provided a secure random Id will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information needed to create the APIKey.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_api_key(key_id, request)
+      start.uri('/api/api-key')
+          .url_segment(key_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
     #
@@ -212,6 +242,52 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
+    #
+    # @param entity_id [string] (Optional) The Id for the Entity. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the Entity.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_entity(entity_id, request)
+      start.uri('/api/entity')
+          .url_segment(entity_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
+    #
+    # @param entity_type_id [string] (Optional) The Id for the Entity Type. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the Entity Type.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_entity_type(entity_type_id, request)
+      start.uri('/api/entity/type')
+          .url_segment(entity_type_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # 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.
+    # @param permission_id [string] (Optional) The Id of the permission. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the permission.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_entity_type_permission(entity_type_id, permission_id, request)
+      start.uri('/api/entity/type')
+          .url_segment(entity_type_id)
+          .url_segment("permission")
+          .url_segment(permission_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    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
     # family, if not provided one will be generated.
@@ -309,6 +385,34 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
+    #
+    # @param message_template_id [string] (Optional) The Id for the template. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the message template.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_message_template(message_template_id, request)
+      start.uri('/api/message/template')
+          .url_segment(message_template_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Creates a messenger.  You can optionally specify an Id for the messenger, if not provided one will be generated.
+    #
+    # @param messenger_id [string] (Optional) The Id for the messenger. If not provided a secure random UUID will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the messenger.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_messenger(messenger_id, request)
+      start.uri('/api/messenger')
+          .url_segment(messenger_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
     #
@@ -395,6 +499,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Link an external user from a 3rd party identity provider to a FusionAuth user.
+    #
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to link the FusionAuth user.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_user_link(request)
+      start.uri('/api/identity-provider/link')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
     #
@@ -421,6 +537,16 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deactivates the FusionAuth Reactor.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def deactivate_reactor()
+      start.uri('/api/reactor')
+          .delete()
+          .go()
+    end
+
     #
     # Deactivates the user with the given Id.
     #
@@ -474,6 +600,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the API key for the given Id.
+    #
+    # @param key_id [string] The Id of the authentication API key to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_api_key(key_id)
+      start.uri('/api/api-key')
+          .url_segment(key_id)
+          .delete()
+          .go()
+    end
+
     #
     # Hard deletes an application. This is a dangerous operation and should not be used in most circumstances. This will
     # delete the application, any registrations for that application, metrics and reports for the application, all the
@@ -542,6 +680,63 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the Entity for the given Id.
+    #
+    # @param entity_id [string] The Id of the Entity to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_entity(entity_id)
+      start.uri('/api/entity')
+          .url_segment(entity_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Deletes an Entity Grant for the given User or Entity.
+    #
+    # @param entity_id [string] The Id of the Entity that the Entity Grant is being deleted for.
+    # @param recipient_entity_id [string] (Optional) The Id of the Entity that the Entity Grant is for.
+    # @param user_id [string] (Optional) The Id of the User that the Entity Grant is for.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_entity_grant(entity_id, recipient_entity_id, user_id)
+      start.uri('/api/entity')
+          .url_segment(entity_id)
+          .url_segment("grant")
+          .url_parameter('recipientEntityId', recipient_entity_id)
+          .url_parameter('userId', user_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Deletes the Entity Type for the given Id.
+    #
+    # @param entity_type_id [string] The Id of the Entity Type to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_entity_type(entity_type_id)
+      start.uri('/api/entity/type')
+          .url_segment(entity_type_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Hard deletes a permission. This is a dangerous operation and should not be used in most circumstances. This
+    # permanently removes the given permission from all grants that had it.
+    #
+    # @param entity_type_id [string] The Id of the entityType the the permission belongs to.
+    # @param permission_id [string] The Id of the permission to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_entity_type_permission(entity_type_id, permission_id)
+      start.uri('/api/entity/type')
+          .url_segment(entity_type_id)
+          .url_segment("permission")
+          .url_segment(permission_id)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the form for the given Id.
     #
@@ -626,6 +821,30 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the message template for the given Id.
+    #
+    # @param message_template_id [string] The Id of the message template to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_message_template(message_template_id)
+      start.uri('/api/message/template')
+          .url_segment(message_template_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Deletes the messenger for the given Id.
+    #
+    # @param messenger_id [string] The Id of the messenger to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_messenger(messenger_id)
+      start.uri('/api/messenger')
+          .url_segment(messenger_id)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the user registration for the given user and application.
     #
@@ -718,6 +937,22 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Remove an existing link that has been made from a 3rd party identity provider to a FusionAuth user.
+    #
+    # @param identity_provider_id [string] The unique Id of the identity provider.
+    # @param identity_provider_user_id [string] The unique Id of the user in the 3rd party identity provider to unlink.
+    # @param user_id [string] The unique Id of the FusionAuth user to unlink.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_user_link(identity_provider_id, identity_provider_user_id, user_id)
+      start.uri('/api/identity-provider/link')
+          .url_parameter('identityProviderId', identity_provider_id)
+          .url_parameter('identityProviderUserId', identity_provider_user_id)
+          .url_parameter('userId', user_id)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the users with the given ids, or users matching the provided JSON query or queryString.
     # The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.
@@ -767,11 +1002,13 @@ module FusionAuth
     # Disable Two Factor authentication for a user.
     #
     # @param user_id [string] The Id of the User for which you're disabling Two Factor authentication.
+    # @param method_id [string] The two-factor method identifier you wish to disable
     # @param code [string] The Two Factor code used verify the the caller knows the Two Factor secret.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
-    def disable_two_factor(user_id, code)
+    def disable_two_factor(user_id, method_id, code)
       start.uri('/api/user/two-factor')
           .url_parameter('userId', user_id)
+          .url_parameter('methodId', method_id)
           .url_parameter('code', code)
           .delete()
           .go()
@@ -959,6 +1196,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Generate two-factor recovery codes for a user. Generating two-factor recovery codes will invalidate any existing recovery codes. 
+    #
+    # @param user_id [string] The Id of the user to generate new Two Factor recovery codes.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def generate_two_factor_recovery_codes(user_id)
+      start.uri('/api/user/two-factor/recovery-code')
+          .url_segment(user_id)
+          .post()
+          .go()
+    end
+
     #
     # Generate a Two Factor secret that can be used to enable Two Factor authentication for a User. The response will contain
     # both the secret and a Base32 encoded form of the secret which can be shown to a User when using a 2 Step Authentication
@@ -1182,6 +1431,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates an authentication API key by given id
+    #
+    # @param key_id [string] The Id of the authentication key. If not provided a secure random api key will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information needed to create the APIKey.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_api_key(key_id, request)
+      start.uri('/api/api-key')
+          .url_segment(key_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Updates, via PATCH, the application with the given Id.
     #
@@ -1255,6 +1518,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates, via PATCH, the Entity Type with the given Id.
+    #
+    # @param entity_type_id [string] The Id of the Entity Type to update.
+    # @param request [OpenStruct, Hash] The request that contains just the new Entity Type information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_entity_type(entity_type_id, request)
+      start.uri('/api/entity/type')
+          .url_segment(entity_type_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch()
+          .go()
+    end
+
     #
     # Updates, via PATCH, the group with the given Id.
     #
@@ -1309,6 +1586,34 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates, via PATCH, the message template with the given Id.
+    #
+    # @param message_template_id [string] The Id of the message template to update.
+    # @param request [OpenStruct, Hash] The request that contains just the new message template information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_message_template(message_template_id, request)
+      start.uri('/api/message/template')
+          .url_segment(message_template_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch()
+          .go()
+    end
+
+    #
+    # Updates, via PATCH, the messenger with the given Id.
+    #
+    # @param messenger_id [string] The Id of the messenger to update.
+    # @param request [OpenStruct, Hash] The request that contains just the new messenger information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_messenger(messenger_id, request)
+      start.uri('/api/messenger')
+          .url_segment(messenger_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch()
+          .go()
+    end
+
     #
     # Updates, via PATCH, the registration for the user with the given id and the application defined in the request.
     #
@@ -1470,6 +1775,19 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Request a refresh of the Entity search index. This API is not generally necessary and the search index will become consistent in a
+    # reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be 
+    # if you are using the Search API or Delete Tenant API immediately following a Entity Create etc, you may wish to request a refresh to
+    #  ensure the index immediately current before making a query request to the search index.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def refresh_entity_search_index()
+      start.uri('/api/entity/search')
+          .put()
+          .go()
+    end
+
     #
     # Request a refresh of the User search index. This API is not generally necessary and the search index will become consistent in a
     # reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be 
@@ -1483,6 +1801,16 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Regenerates any keys that are used by the FusionAuth Reactor.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def regenerate_reactor_keys()
+      start.uri('/api/reactor')
+          .put()
+          .go()
+    end
+
     #
     # 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
@@ -1501,6 +1829,22 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Requests Elasticsearch to delete and rebuild the index for FusionAuth users or entities. Be very careful when running this request as it will 
+    # increase the CPU and I/O load on your database until the operation completes. Generally speaking you do not ever need to run this operation unless 
+    # instructed by FusionAuth support, or if you are migrating a database another system and you are not brining along the Elasticsearch index. 
+    # 
+    # You have been warned.
+    #
+    # @param request [OpenStruct, Hash] The request that contains the index name.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def reindex(request)
+      start.uri('/api/system/reindex')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Removes a user from the family with the given id.
     #
@@ -1556,6 +1900,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves an authentication API key for the given id
+    #
+    # @param key_id [string] The Id of the API key to retrieve.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_api_key(key_id)
+      start.uri('/api/api-key')
+          .url_segment(key_id)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves a single action log (the log of a user action that was taken on a user previously) for the given Id.
     #
@@ -1739,6 +2095,57 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the Entity for the given Id.
+    #
+    # @param entity_id [string] The Id of the Entity.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_entity(entity_id)
+      start.uri('/api/entity')
+          .url_segment(entity_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves an Entity Grant for the given Entity and User/Entity.
+    #
+    # @param entity_id [string] The Id of the Entity.
+    # @param recipient_entity_id [string] (Optional) The Id of the Entity that the Entity Grant is for.
+    # @param user_id [string] (Optional) The Id of the User that the Entity Grant is for.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_entity_grant(entity_id, recipient_entity_id, user_id)
+      start.uri('/api/entity')
+          .url_segment(entity_id)
+          .url_segment("grant")
+          .url_parameter('recipientEntityId', recipient_entity_id)
+          .url_parameter('userId', user_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves the Entity Type for the given Id.
+    #
+    # @param entity_type_id [string] The Id of the Entity Type.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_entity_type(entity_type_id)
+      start.uri('/api/entity/type')
+          .url_segment(entity_type_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves all of the Entity Types.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_entity_types()
+      start.uri('/api/entity/type')
+          .get()
+          .go()
+    end
+
     #
     # Retrieves a single event log for the given Id.
     #
@@ -2040,6 +2447,62 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the message template for the given Id. If you don't specify the id, this will return all of the message templates.
+    #
+    # @param message_template_id [string] (Optional) The Id of the message template.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_message_template(message_template_id)
+      start.uri('/api/message/template')
+          .url_segment(message_template_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Creates a preview of the message template provided in the request, normalized to a given locale.
+    #
+    # @param request [OpenStruct, Hash] The request that contains the email template and optionally a locale to render it in.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_message_template_preview(request)
+      start.uri('/api/message/template/preview')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Retrieves all of the message templates.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_message_templates()
+      start.uri('/api/message/template')
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves the messenger with the given Id.
+    #
+    # @param messenger_id [string] The Id of the messenger.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_messenger(messenger_id)
+      start.uri('/api/messenger')
+          .url_segment(messenger_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieves all of the messengers.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_messengers()
+      start.uri('/api/messenger')
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the monthly active user report between the two instants. If you specify an application id, it will only
     # return the monthly active counts for that application.
@@ -2119,6 +2582,16 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the FusionAuth Reactor status.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_reactor_status()
+      start.uri('/api/reactor')
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the last number of login records.
     #
@@ -2188,6 +2661,17 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieve the status of a re-index process. A status code of 200 indicates the re-index is in progress, a status code of  
+    # 404 indicates no re-index is in progress.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_reindex_status()
+      start.uri('/api/system/reindex')
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the system configuration.
     #
@@ -2253,6 +2737,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieve two-factor recovery codes for a user.
+    #
+    # @param user_id [string] The Id of the user to retrieve Two Factor recovery codes.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_two_factor_recovery_codes(user_id)
+      start.uri('/api/user/two-factor/recovery-code')
+          .url_segment(user_id)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the user for the given Id.
     #
@@ -2421,6 +2917,36 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieve a single Identity Provider user (link).
+    #
+    # @param identity_provider_id [string] The unique Id of the identity provider.
+    # @param identity_provider_user_id [string] The unique Id of the user in the 3rd party identity provider.
+    # @param user_id [string] The unique Id of the FusionAuth user.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_user_link(identity_provider_id, identity_provider_user_id, user_id)
+      start.uri('/api/identity-provider/link')
+          .url_parameter('identityProviderId', identity_provider_id)
+          .url_parameter('identityProviderUserId', identity_provider_user_id)
+          .url_parameter('userId', user_id)
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieve all Identity Provider users (links) for the user. Specify the optional identityProviderId to retrieve links for a particular IdP.
+    #
+    # @param identity_provider_id [string] (Optional) The unique Id of the identity provider. Specify this value to reduce the links returned to those for a particular IdP.
+    # @param user_id [string] The unique Id of the user.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_user_links_by_user_id(identity_provider_id, user_id)
+      start.uri('/api/identity-provider/link')
+          .url_parameter('identityProviderId', identity_provider_id)
+          .url_parameter('userId', user_id)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the login report between the two instants for a particular user by Id. If you specify an application id, it will only return the
     # login counts for that application.
@@ -2487,6 +3013,16 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the FusionAuth version string.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_version()
+      start.uri('/api/system/version')
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
     #
@@ -2634,6 +3170,54 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Searches entities with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_entities(request)
+      start.uri('/api/entity/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # 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.
+    def search_entities_by_ids(ids)
+      start.uri('/api/entity/search')
+          .url_parameter('ids', ids)
+          .get()
+          .go()
+    end
+
+    #
+    # Searches Entity Grants with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_entity_grants(request)
+      start.uri('/api/entity/grant/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Searches the entity types with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_entity_types(request)
+      start.uri('/api/entity/type/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Searches the event logs with the specified criteria and pagination.
     #
@@ -2754,6 +3338,7 @@ module FusionAuth
     #
     # @param request [OpenStruct, Hash] The request object that contains all of the information used to send the code.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    # @deprecated This method has been renamed to send_two_factor_code_for_enable_disable, use that method instead.
     def send_two_factor_code(request)
       start.uri('/api/two-factor/send')
           .body_handler(FusionAuth::JSONBodyHandler.new(request))
@@ -2761,11 +3346,24 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
+    #
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to send the code.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def send_two_factor_code_for_enable_disable(request)
+      start.uri('/api/two-factor/send')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Send a Two Factor authentication code to allow the completion of Two Factor authentication.
     #
     # @param two_factor_id [string] The Id returned by the Login API necessary to complete Two Factor authentication.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    # @deprecated This method has been renamed to send_two_factor_code_for_login_using_method, use that method instead.
     def send_two_factor_code_for_login(two_factor_id)
       startAnonymous.uri('/api/two-factor/send')
           .url_segment(two_factor_id)
@@ -2773,6 +3371,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Send a Two Factor authentication code to allow the completion of Two Factor authentication.
+    #
+    # @param two_factor_id [string] The Id returned by the Login API necessary to complete Two Factor authentication.
+    # @param request [OpenStruct, Hash] The Two Factor send request that contains all of the information used to send the Two Factor code to the user.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def send_two_factor_code_for_login_using_method(two_factor_id, request)
+      startAnonymous.uri('/api/two-factor/send')
+          .url_segment(two_factor_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Begins a login request for a 3rd party login that requires user interaction such as HYPR.
     #
@@ -2799,6 +3411,23 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Start a Two-Factor login request by generating a two-factor identifier. This code can then be sent to the Two Factor Send 
+    # API (/api/two-factor/send)in order to send a one-time use code to a user. You can also use one-time use code returned 
+    # to send the code out-of-band. The Two-Factor login is completed by making a request to the Two-Factor Login 
+    # API (/api/two-factor/login). with the two-factor identifier and the one-time use code.
+    # 
+    # This API is intended to allow you to begin a Two-Factor login outside of a normal login that originated from the Login API (/api/login).
+    #
+    # @param request [OpenStruct, Hash] The Two-Factor start request that contains all of the information used to begin the Two-Factor login request.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def start_two_factor_login(request)
+      start.uri('/api/two-factor/start')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Complete login using a 2FA challenge
     #
@@ -2811,6 +3440,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates an API key by given id
+    #
+    # @param api_key_id [string] The Id of the API key to update.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the API Key.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_api_key(api_key_id, request)
+      start.uri('/api/api-key')
+          .url_segment(api_key_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
     #
     # Updates the application with the given Id.
     #
@@ -2884,6 +3527,51 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates the Entity with the given Id.
+    #
+    # @param entity_id [string] The Id of the Entity to update.
+    # @param request [OpenStruct, Hash] The request that contains all of the new Entity information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_entity(entity_id, request)
+      start.uri('/api/entity')
+          .url_segment(entity_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
+    #
+    # Updates the Entity Type with the given Id.
+    #
+    # @param entity_type_id [string] The Id of the Entity Type to update.
+    # @param request [OpenStruct, Hash] The request that contains all of the new Entity Type information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_entity_type(entity_type_id, request)
+      start.uri('/api/entity/type')
+          .url_segment(entity_type_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
+    #
+    # 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.
+    # @param request [OpenStruct, Hash] The request that contains all of the new permission information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_entity_type_permission(entity_type_id, permission_id, request)
+      start.uri('/api/entity/type')
+          .url_segment(entity_type_id)
+          .url_segment("permission")
+          .url_segment(permission_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
     #
     # Updates the form with the given Id.
     #
@@ -2980,6 +3668,34 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates the message template with the given Id.
+    #
+    # @param message_template_id [string] The Id of the message template to update.
+    # @param request [OpenStruct, Hash] The request that contains all of the new message template information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_message_template(message_template_id, request)
+      start.uri('/api/message/template')
+          .url_segment(message_template_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
+    #
+    # Updates the messenger with the given Id.
+    #
+    # @param messenger_id [string] The Id of the messenger to update.
+    # @param request [OpenStruct, Hash] The request object that contains all of the new messenger information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_messenger(messenger_id, request)
+      start.uri('/api/messenger')
+          .url_segment(messenger_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
     #
     # Updates the registration for the user with the given id and the application defined in the request.
     #
@@ -3104,6 +3820,21 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
+    #
+    # @param entity_id [string] The Id of the Entity that the User/Entity is being granted access to.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to create the Entity Grant.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def upsert_entity_grant(entity_id, request)
+      start.uri('/api/entity')
+          .url_segment(entity_id)
+          .url_segment("grant")
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Validates the end-user provided user_code from the user-interaction of the Device Authorization Grant.
     # If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant.
@@ -3139,6 +3870,7 @@ module FusionAuth
     #
     # @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)
       startAnonymous.uri('/api/user/verify-email')
           .url_segment(verification_id)
@@ -3146,11 +3878,29 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Confirms a user's email address. 
+    # 
+    # The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When 
+    # the tenant is configured to gate a user until their email address is verified, this procedures requires two values instead of one. 
+    # The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The 
+    # two values together are able to confirm a user's email address and mark the user's email address as verified.
+    #
+    # @param request [OpenStruct, Hash] The request that contains the verificationId and optional one-time use code paired with the verificationId.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def verify_email_address(request)
+      startAnonymous.uri('/api/user/verify-email')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Confirms an application registration. The Id given is usually from an email sent to the user.
     #
     # @param verification_id [string] The registration verification Id sent to the user.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    # @deprecated This method has been renamed to verify_user_registration and changed to take a JSON request body, use that method instead.
     def verify_registration(verification_id)
       startAnonymous.uri('/api/user/verify-registration')
           .url_segment(verification_id)
@@ -3158,6 +3908,23 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Confirms a user's registration. 
+    # 
+    # The request body will contain the verificationId. You may also be required to send a one-time use code based upon your configuration. When 
+    # the application is configured to gate a user until their registration is verified, this procedures requires two values instead of one. 
+    # The verificationId is a high entropy value and the one-time use code is a low entropy value that is easily entered in a user interactive form. The 
+    # two values together are able to confirm a user's registration and mark the user's registration as verified.
+    #
+    # @param request [OpenStruct, Hash] The request that contains the verificationId and optional one-time use code paired with the verificationId.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def verify_user_registration(request)
+      startAnonymous.uri('/api/user/verify-registration')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Starts the HTTP call
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.25.0
+  version: 1.28.0
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.
@@ -23,6 +23,7 @@ files:
 - ".gitignore"
 - ".ruby-version"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile