fusionauth_client 1.24.0 → 1.27.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d68378f0743777cc83d27ffb6bf0cdaf348f4f7630776b818d37995d00e9b883
-  data.tar.gz: e35f01e8cfb2bba85296c4b12da1118362c5e02d14c2f78707479e7766d6f3e3
+  metadata.gz: c3be99d4a422cd75a0161a5fa7a93bcde4c83c28abb43284d43b22e490fadfb7
+  data.tar.gz: fc5c5fcb80f985800cb8bd81308b4adeff01082bcfacf53603fecb61206e952a
 SHA512:
-  metadata.gz: 6966b6e5029bfb6f8ec8d4cdfacc2076fa03f26a891dd1be19296755d58dd4a86d8b217889c1c664743b354fa193b1768668014fdd2c40fa793f8e99a21491f4
-  data.tar.gz: 6cf37a3976925582cde557bba703ec767c2ab17fa80ba36fc3c2d8760571c33582aaf84b669c13d7f6f36683bb50ab69df2c4e0e937ec224faf4013403f7f2e5
+  metadata.gz: ceb82d839e3bc5e1f1769d59d033fbc92834c6af96331f514eb2b0a8f583b49586167a61530a2fc23abcf000405bb59b87e10db0a83b636ee4bcfd6aab6ded79
+  data.tar.gz: 20fdd61ccc7b0e029a628b105801fa2546b58f0ac8abf0b260dd916ad2ba805846934a74abe783ee2a018253210f6fda315f870084c3b31def6e18967d5c69a2

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.27.2)
+
+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.24.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.27.2", licenses: ["ApacheV2_0"]) {
   workflow {
     standard()
   }

data/fusionauth-ruby-client.iml

@@ -12,4 +12,32 @@
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.5.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.5.1) [gem]" level="application" />
   </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <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.26.0.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <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.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" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
 </module>

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.24.0'
+  spec.version       = '1.27.2'
   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.
     #
@@ -421,6 +525,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 +588,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 +668,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 +809,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.
     #
@@ -767,11 +974,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 +1168,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 +1403,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 +1490,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 +1558,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 +1747,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 +1773,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
@@ -1556,6 +1856,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 +2051,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.
     #
@@ -1844,7 +2207,7 @@ module FusionAuth
     #
     # Retrieves the identity provider for the given id or all of the identity providers if the id is null.
     #
-    # @param identity_provider_id [string] (Optional) The identity provider id.
+    # @param identity_provider_id [string] The identity provider Id.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_identity_provider(identity_provider_id)
       start.uri('/api/identity-provider')
@@ -1853,6 +2216,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves one or more identity provider for the given type. For types such as Google, Facebook, Twitter and LinkedIn, only a single 
+    # identity provider can exist. For types such as OpenID Connect and SAMLv2 more than one identity provider can be configured so this request 
+    # may return multiple identity providers.
+    #
+    # @param type [OpenStruct, Hash] The type of the identity provider.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_identity_provider_by_type(type)
+      start.uri('/api/identity-provider')
+          .url_parameter('type', type)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves all of the identity providers.
     #
@@ -2026,6 +2403,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.
@@ -2105,6 +2538,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.
     #
@@ -2119,6 +2562,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token, if you have that, you already have what you need..
+    #
+    # @param user_id [string] The Id of the user.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_refresh_token_by_id(user_id)
+      start.uri('/api/jwt/refresh')
+          .url_segment(user_id)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the refresh tokens that belong to the user with the given Id.
     #
@@ -2227,6 +2682,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.
     #
@@ -2461,6 +2928,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.
     #
@@ -2608,6 +3085,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.
     #
@@ -2728,6 +3253,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))
@@ -2735,11 +3261,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)
@@ -2747,6 +3286,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.
     #
@@ -2773,6 +3326,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
     #
@@ -2785,6 +3355,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.
     #
@@ -2858,6 +3442,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.
     #
@@ -2954,6 +3583,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.
     #
@@ -3078,6 +3735,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.
@@ -3113,6 +3785,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)
@@ -3120,11 +3793,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)
@@ -3132,6 +3823,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.24.0
+  version: 1.27.2
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-11 00:00:00.000000000 Z
+date: 2021-05-10 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