fusionauth_client 1.26.0 → 1.28.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a950e65ea4b1b98b030175aa96aa10e60eaa283adffb60f940e7faaf03ea3db8
-  data.tar.gz: fb0218fa311d0c815042e7d062319827c5361a84831d42abd3be103886335a9e
+  metadata.gz: 2f5c7cb69f901d83dc3b55ed925aea41ada2b94c81807017034173b54f707281
+  data.tar.gz: ff270948d4d1fbc257ccbc176d6d7955a77eb40599c31b85e3ba926295d003d7
 SHA512:
-  metadata.gz: 76a87d490167744f343858a59f416fcf97ecf351421d4b89463a8f523fe51bdd44c46724bf3824a5570ebf2e0db43287d8a256f4d5e581563716596560f9a8d8
-  data.tar.gz: cbe4905cd5fa7266e968a3fd506bcd0a7db27d1309ec03f11fe9c35a59f0e535ba20a400a7fbef1a089c4b05a8a8e724e1844daaf737db2263cfa03fd50d6b7e
+  metadata.gz: b0ffcab47aeba93d264758a13c68c0145476b1a3bff94898d04978495a2c6c3144980885d8d35fb3715c6ccbc3c7bf407c4c252c391a8cb117fdcf8cdbd5ea7d
+  data.tar.gz: cfc5c3bea25ffe600f04c4665c6d07dfd9ca1427d25a5bebc5d763b4bd0373d101e9ba33cdcdb7f1ca5db19f2b29f131fcedd4d798b92589c69714fe223156df

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fusionauth_client (1.26.0)
+    fusionauth_client (1.28.1)
 
 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.28.1", 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.26.0.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl description="Build fusionauth_client-1.28.1.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 description="Build and install fusionauth_client-1.28.1.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" />
+              <RakeTaskImpl description="Build and install fusionauth_client-1.28.1.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="Create tag v1.28.1 and build and push fusionauth_client-1.28.1.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.26.0'
+  spec.version       = '1.28.1'
   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()
@@ -105,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()
@@ -501,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.
     #
@@ -927,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.
@@ -1803,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.
     #
@@ -2619,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.
     #
@@ -2864,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.
@@ -2930,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.
     #
@@ -3777,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)
@@ -3784,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)
@@ -3796,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.26.0
+  version: 1.28.1
 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-06-21 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.