fusionauth_client 1.26.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a950e65ea4b1b98b030175aa96aa10e60eaa283adffb60f940e7faaf03ea3db8
-  data.tar.gz: fb0218fa311d0c815042e7d062319827c5361a84831d42abd3be103886335a9e
+  metadata.gz: fee219ef1738d6ccb97d8bb5cdba190a5658dcc9263dcb460c811d97c02da025
+  data.tar.gz: f9858eb19f04b69197b1dcf3f2c35a6e7429e331bfd764a95b55101f6b101cc4
 SHA512:
-  metadata.gz: 76a87d490167744f343858a59f416fcf97ecf351421d4b89463a8f523fe51bdd44c46724bf3824a5570ebf2e0db43287d8a256f4d5e581563716596560f9a8d8
-  data.tar.gz: cbe4905cd5fa7266e968a3fd506bcd0a7db27d1309ec03f11fe9c35a59f0e535ba20a400a7fbef1a089c4b05a8a8e724e1844daaf737db2263cfa03fd50d6b7e
+  metadata.gz: 71dae847ef49057df21dfc2966596f22b0fe65e5ccd6b37af5cb883b26aa21bc6be6ca0092e25e3e74126c0c74a553d566937f513adf2381d2c438ed1e8f6062
+  data.tar.gz: 0c9ab46e8f349387417374abfb4ad2d4ec085d399f25fa489d02e83c2d69bffa09fd0a5eaccb3828d345545856f443c14b42d6e910a94aa8438a9145241c2973

data/Gemfile.lock

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

data/build.savant

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

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.26.0'
+  spec.version       = '1.27.0'
   spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -58,12 +58,10 @@ module FusionAuth
     #
     # Activates the FusionAuth Reactor using a license id and optionally a license text (for air-gapped deployments)
     #
-    # @param license_id [string] The license id
     # @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(license_id, request)
+    def activate_reactor(request)
       start.uri('/api/reactor')
-          .url_segment(license_id)
           .body_handler(FusionAuth::JSONBodyHandler.new(request))
           .post()
           .go()
@@ -2930,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.
     #
@@ -3777,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)
@@ -3784,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)
@@ -3796,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.26.0
+  version: 1.27.0
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2021-05-05 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.