fusionauth_client 1.29.0 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f1f43b28cf211f2c01b2e47171059047f9819dcf6188c8d707784c25070fa57
-  data.tar.gz: 54c810e12716603c4496c2563b4284602cb591def4e7c5d83da9fce343e1911a
+  metadata.gz: 797d23a1d462217a91f20bf6a6bc9176f186f9522ffbd739bd526e728c3945f4
+  data.tar.gz: dbbe0ceeb2c7674889a8be4064b99856aa05cec8eddbb2221add95907331f1c2
 SHA512:
-  metadata.gz: 641e630a66bf0bd324cb744aeb0fc29b44142ce4d0723704e2728949a88c5732a2afe5a2c591076bdb0626da9c136cd4ce98a9e0c5358cb6bf3f96a12f45cab9
-  data.tar.gz: 318b5443dd8221ee5916c6aef850a1404172196e079358eb5c5777960a3dc81e988ffb24794854838c00ab194517a59ac0c867698f9d9e78049b76996ce22356
+  metadata.gz: faef055bf17d8ae7328cb621056531732081015b06e5b8f6dbc728af9cafe5f3793bd52858e3801022b7541b9a6e0b29350b6f544e74a9c56eb64f2f1ad772a6
+  data.tar.gz: b80fa21d86d76e1dfd6b44b5bb4ae051d6d629a97948ad5352af3a46cf07116a3ade7883dc020cad43470dd9acde8527616b1e95438bbcd8837394fc62cbfe23

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fusionauth_client (1.29.0)
+    fusionauth_client (1.31.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.29.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.31.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.29.0'
+  spec.version       = '1.31.0'
   spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -357,6 +357,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
+    #
+    # @param access_control_list_id [string] (Optional) The Id for the IP Access Control List. 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 IP Access Control List.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def create_ip_access_control_list(access_control_list_id, request)
+      start.uri('/api/ip-acl')
+          .url_segment(access_control_list_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
     #
@@ -785,6 +799,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the IP Access Control List for the given Id.
+    #
+    # @param ip_access_control_list_id [string] The Id of the IP Access Control List to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_ip_access_control_list(ip_access_control_list_id)
+      start.uri('/api/ip-acl')
+          .url_segment(ip_access_control_list_id)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the identity provider for the given Id.
     #
@@ -860,7 +886,24 @@ module FusionAuth
     end
 
     #
-    # Deletes the tenant for the given Id.
+    # Deletes the user registration for the given user and application along with the given JSON body that contains the event information.
+    #
+    # @param user_id [string] The Id of the user whose registration is being deleted.
+    # @param application_id [string] The Id of the application to remove the registration for.
+    # @param request [OpenStruct, Hash] The request body that contains the event information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_registration_with_request(user_id, application_id, request)
+      start.uri('/api/user/registration')
+          .url_segment(user_id)
+          .url_segment(application_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .delete()
+          .go()
+    end
+
+    #
+    # Deletes the tenant based on the given Id on the URL. This permanently deletes all information, metrics, reports and data associated
+    # with the tenant and everything under the tenant (applications, users, etc).
     #
     # @param tenant_id [string] The Id of the tenant to delete.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -885,6 +928,21 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the tenant based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated
+    # with the tenant and everything under the tenant (applications, users, etc).
+    #
+    # @param tenant_id [string] The Id of the tenant to delete.
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to delete the user.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_tenant_with_request(tenant_id, request)
+      start.uri('/api/tenant')
+          .url_segment(tenant_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the theme for the given Id.
     #
@@ -953,6 +1011,21 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the user based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated
+    # with the user.
+    #
+    # @param user_id [string] The Id of the user to delete (required).
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to delete the user.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_user_with_request(user_id, request)
+      start.uri('/api/user')
+          .url_segment(user_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .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.
@@ -1007,13 +1080,27 @@ module FusionAuth
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def disable_two_factor(user_id, method_id, code)
       start.uri('/api/user/two-factor')
-          .url_parameter('userId', user_id)
+          .url_segment(user_id)
           .url_parameter('methodId', method_id)
           .url_parameter('code', code)
           .delete()
           .go()
     end
 
+    #
+    # Disable Two Factor authentication for a user using a JSON body rather than URL parameters.
+    #
+    # @param user_id [string] The Id of the User for which you're disabling Two Factor authentication.
+    # @param request [OpenStruct, Hash] The request information that contains the code and methodId along with any event information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def disable_two_factor_with_request(user_id, request)
+      start.uri('/api/user/two-factor')
+          .url_segment(user_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .delete()
+          .go()
+    end
+
     #
     # Enable Two Factor authentication for a user.
     #
@@ -1391,6 +1478,19 @@ module FusionAuth
           .go()
     end
 
+    #
+    # The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the
+    # client and revoke the refresh token stored. This API takes the refresh token in the JSON body.
+    #
+    # @param request [OpenStruct, Hash] The request object that contains all of the information used to logout the user.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def logout_with_request(request)
+      startAnonymous.uri('/api/logout')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Retrieves the identity provider for the given domain. A 200 response code indicates the domain is managed
     # by a registered identity provider. A 404 indicates the domain is not managed.
@@ -2248,6 +2348,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the IP Access Control List with the given Id.
+    #
+    # @param ip_access_control_list_id [string] The Id of the IP Access Control List.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_ip_access_control_list(ip_access_control_list_id)
+      start.uri('/api/ip-acl')
+          .url_segment(ip_access_control_list_id)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the identity provider for the given id or all of the identity providers if the id is null.
     #
@@ -2582,6 +2694,16 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieves the FusionAuth Reactor metrics.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_reactor_metrics()
+      start.uri('/api/reactor/metrics')
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the FusionAuth Reactor status.
     #
@@ -3146,6 +3268,19 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Revokes refresh tokens using the information in the JSON body. The handling for this method is the same as the revokeRefreshToken method
+    # and is based on the information you provide in the RefreshDeleteRequest object. See that method for additional information.
+    #
+    # @param request [OpenStruct, Hash] The request information used to revoke the refresh tokens.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_tokens_with_request(request)
+      start.uri('/api/jwt/refresh')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .delete()
+          .go()
+    end
+
     #
     # Revokes a single User consent by Id.
     #
@@ -3230,6 +3365,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Searches the IP Access Control Lists with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_ip_access_control_lists(request)
+      start.uri('/api/ip-acl/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Searches the login records with the specified criteria and pagination.
     #
@@ -3614,6 +3761,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Updates the IP Access Control List with the given Id.
+    #
+    # @param access_control_list_id [string] The Id of the IP Access Control List to update.
+    # @param request [OpenStruct, Hash] The request that contains all of the new IP Access Control List information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_ip_access_control_list(access_control_list_id, request)
+      start.uri('/api/ip-acl')
+          .url_segment(access_control_list_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put()
+          .go()
+    end
+
     #
     # Updates the identity provider with the given Id.
     #
@@ -3865,6 +4026,26 @@ module FusionAuth
           .go()
     end
 
+    #
+    # It's a JWT vending machine!
+    # 
+    # Issue a new access token (JWT) with the provided claims in the request. This JWT is not scoped to a tenant or user, it is a free form 
+    # token that will contain what claims you provide.
+    # <p>
+    # The iat, exp and jti claims will be added by FusionAuth, all other claims must be provided by the caller.
+    # 
+    # If a TTL is not provided in the request, the TTL will be retrieved from the default Tenant or the Tenant specified on the request either 
+    # by way of the X-FusionAuth-TenantId request header, or a tenant scoped API key.
+    #
+    # @param request [OpenStruct, Hash] The request that contains all of the claims for this JWT.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def vend_jwt(request)
+      start.uri('/api/jwt/vend')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Confirms a email verification. The Id given is usually from an email sent to the user.
     #

metadata

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