fusionauth_client 1.44.0 → 1.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd37dba87638d7ace8c827371d1183c52219a1f407a4836a564b31bff0216b59
-  data.tar.gz: d25c25c4ca2925a91cfd3d5731fb7e5790c82f5869f0095c0d3a5af46e6a85d8
+  metadata.gz: 188a214d179542598a99c19b42cee7ded5a4fe5401833b7cd68c61f1ed116bc0
+  data.tar.gz: 7648163d9f63e75d8463a38d86108264036859942bf67208f671b49e363add09
 SHA512:
-  metadata.gz: ed71e7ea71bf4f07121fa42d4993ef8948b49e613af238c7ac763366627264995cfc6751e1bb8001902beba24ce17ef0c548b64ecdcf508576ae53d6f3307403
-  data.tar.gz: 744c65076908365082ddd0a5c02077cf9d6126fa54d3a47a4611b5e03f4ff42c67fd1df6f56eb7d9fddcf10e645d509af8875dd5ae3a337479c25e1fa0a0f014
+  metadata.gz: f8858c3bc5dce7ab05d4a74d647fbc5e0081c9c60dd10e9325172f41f770ce65a01f12cab19ba0b457d8833849ff812284b9fb619f4175ebd9ec10185f33b17a
+  data.tar.gz: 3d0db52b315ccbadbc0706e3f9030249d569f928e62d8def29a82bfdb0e51e2730ed397eb6a7f42e8bb3c97491dca6cbe44e279bb0c4639760a59df7d8d6ef45

data/.gitignore

@@ -8,3 +8,4 @@
 .rakeTasks
 /build
 **/.DS_Store
+.savant/cache

data/Gemfile.lock

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

data/build.savant

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018-2022, FusionAuth, All Rights Reserved
+ * Copyright (c) 2018-2023, FusionAuth, All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,7 @@
  */
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.44.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.46.0", licenses: ["ApacheV2_0"]) {
   workflow {
     fetch {
       cache()
@@ -39,8 +39,8 @@ project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.44.0
 }
 
 // Plugins
-file = loadPlugin(id: "org.savantbuild.plugin:file:2.0.0-RC.4")
-release = loadPlugin(id: "org.savantbuild.plugin:release-git:2.0.0-RC.4")
+file = loadPlugin(id: "org.savantbuild.plugin:file:2.0.0-RC.6")
+release = loadPlugin(id: "org.savantbuild.plugin:release-git:2.0.0-RC.6")
 
 target(name: "clean", description: "Cleans build directory") {
   file.prune(dir: 'pkg')

data/fusionauth_client.gemspec

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

data/lib/fusionauth/fusionauth_client.rb

@@ -45,7 +45,7 @@ module FusionAuth
     # Takes an action on a user. The user being actioned is called the "actionee" and the user taking the action is called the
     # "actioner". Both user ids are required in the request object.
     #
-    # @param request [OpenStruct, Hash] The action request that includes all of the information about the action being taken including
+    # @param request [OpenStruct, Hash] The action request that includes all the information about the action being taken including
     #     the id of the action, any options and the duration (if applicable).
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def action_user(request)
@@ -81,6 +81,27 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Approve a device grant.
+    #
+    # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
+    # @param client_secret [string] (Optional) The client secret. This value will be required if client authentication is enabled.
+    # @param token [string] The access token used to identify the user.
+    # @param user_code [string] The end-user verification code.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def approve_device(client_id, client_secret, token, user_code)
+      body = {
+        "client_id" => client_id,
+        "client_secret" => client_secret,
+        "token" => token,
+        "user_code" => user_code
+      }
+      start.uri('/oauth2/device/approve')
+          .body_handler(FusionAuth::FormDataBodyHandler.new(body))
+          .post()
+          .go()
+    end
+
     #
     # Cancels the user action.
     #
@@ -103,7 +124,7 @@ module FusionAuth
     # the value in the request body.
     #
     # @param change_password_id [string] The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
-    # @param request [OpenStruct, Hash] The change password request that contains all of the information used to change the password.
+    # @param request [OpenStruct, Hash] The change password request that contains all the information used to change the password.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def change_password(change_password_id, request)
       startAnonymous.uri('/api/user/change-password')
@@ -118,7 +139,7 @@ module FusionAuth
     # bypasses the email verification and allows a password to be changed directly without first calling the #forgotPassword
     # method.
     #
-    # @param request [OpenStruct, Hash] The change password request that contains all of the information used to change the password.
+    # @param request [OpenStruct, Hash] The change password request that contains all the information used to change the password.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def change_password_by_identity(request)
       start.uri('/api/user/change-password')
@@ -178,8 +199,10 @@ module FusionAuth
     #
     # Make a Client Credentials grant request to obtain an access token.
     #
-    # @param client_id [string] The client identifier. The client Id is the Id of the FusionAuth Entity in which you are attempting to authenticate.
-    # @param client_secret [string] The client secret used to authenticate this request.
+    # @param client_id [string] (Optional) The client identifier. The client Id is the Id of the FusionAuth Entity in which you are attempting to authenticate.
+    #     This parameter is optional when Basic Authorization is used to authenticate this request.
+    # @param client_secret [string] (Optional) The client secret used to authenticate this request.
+    #     This parameter is optional when Basic Authorization is used to authenticate this request.
     # @param scope [string] (Optional) This parameter is used to indicate which target entity you are requesting access. To request access to an entity, use the format target-entity:<target-entity-id>:<roles>. Roles are an optional comma separated list.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def client_credentials_grant(client_id, client_secret, scope)
@@ -251,7 +274,7 @@ module FusionAuth
     # 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.
+    # @param request [OpenStruct, Hash] The request object that contains all 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')
@@ -897,7 +920,7 @@ module FusionAuth
     #
     # Removes users as members of a group.
     #
-    # @param request [OpenStruct, Hash] The member request that contains all of the information used to remove members to the group.
+    # @param request [OpenStruct, Hash] The member request that contains all the information used to remove members to the group.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def delete_group_members(request)
       start.uri('/api/group/member')
@@ -1239,7 +1262,8 @@ module FusionAuth
     # Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
     #
     # @param code [string] The authorization code returned on the /oauth2/authorize response.
-    # @param client_id [string] The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
+    # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
+    #     This parameter is optional when Basic Authorization is used to authenticate this request.
     # @param client_secret [string] (Optional) The client secret. This value will be required if client authentication is enabled.
     # @param redirect_uri [string] The URI to redirect to upon a successful request.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -1263,6 +1287,7 @@ module FusionAuth
     #
     # @param code [string] The authorization code returned on the /oauth2/authorize response.
     # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
+    #     This parameter is optional when Basic Authorization is used to authenticate this request.
     # @param client_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
     # @param redirect_uri [string] The URI to redirect to upon a successful request.
     # @param code_verifier [string] The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.
@@ -1288,6 +1313,7 @@ module FusionAuth
     #
     # @param refresh_token [string] The refresh token that you would like to use to exchange for an access token.
     # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
+    #     This parameter is optional when Basic Authorization is used to authenticate this request.
     # @param client_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
     # @param scope [string] (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
     # @param user_code [string] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
@@ -1326,6 +1352,7 @@ module FusionAuth
     # @param username [string] The login identifier of the user. The login identifier can be either the email or the username.
     # @param password [string] The user’s password.
     # @param client_id [string] (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
+    #     This parameter is optional when Basic Authorization is used to authenticate this request.
     # @param client_secret [string] (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
     # @param scope [string] (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
     # @param user_code [string] (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
@@ -1478,7 +1505,7 @@ module FusionAuth
     # body with specific validation errors. This will slow the request down but will allow you to identify the cause of
     # the failure. See the validateDbConstraints request parameter.
     #
-    # @param request [OpenStruct, Hash] The request that contains all of the information about all of the refresh tokens to import.
+    # @param request [OpenStruct, Hash] The request that contains all the information about all the refresh tokens to import.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def import_refresh_tokens(request)
       start.uri('/api/user/refresh-token/import')
@@ -1497,7 +1524,7 @@ module FusionAuth
     # body with specific validation errors. This will slow the request down but will allow you to identify the cause of the failure. See
     # the validateDbConstraints request parameter.
     #
-    # @param request [OpenStruct, Hash] The request that contains all of the information about all of the users to import.
+    # @param request [OpenStruct, Hash] The request that contains all the information about all the users to import.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def import_users(request)
       start.uri('/api/user/import')
@@ -1519,10 +1546,10 @@ module FusionAuth
     end
 
     #
-    # Inspect an access token issued by FusionAuth.
+    # Inspect an access token issued as the result of the User based grant such as the Authorization Code Grant, Implicit Grant, the User Credentials Grant or the Refresh Grant.
     #
     # @param client_id [string] The unique client identifier. The client Id is the Id of the FusionAuth Application for which this token was generated.
-    # @param token [string] The access token returned by this OAuth provider as the result of a successful authentication.
+    # @param token [string] The access token returned by this OAuth provider as the result of a successful client credentials grant.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def introspect_access_token(client_id, token)
       body = {
@@ -1535,6 +1562,21 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Inspect an access token issued as the result of the Client Credentials Grant.
+    #
+    # @param token [string] The access token returned by this OAuth provider as the result of a successful client credentials grant.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def introspect_client_credentials_access_token(token)
+      body = {
+        "token" => token
+      }
+      startAnonymous.uri('/oauth2/introspect')
+          .body_handler(FusionAuth::FormDataBodyHandler.new(body))
+          .post()
+          .go()
+    end
+
     #
     # Issue a new access token (JWT) for the requested Application after ensuring the provided JWT is valid. A valid
     # access token is properly signed and not expired.
@@ -1611,7 +1653,7 @@ module FusionAuth
     # client and revoke the refresh token stored. This API does nothing if the request does not contain an access
     # token or refresh token cookies.
     #
-    # @param global [Boolean] When this value is set to true all of the refresh tokens issued to the owner of the
+    # @param global [Boolean] When this value is set to true all the refresh tokens issued to the owner of the
     #     provided token will be revoked.
     # @param refresh_token [string] (Optional) The refresh_token as a request parameter instead of coming in via a cookie.
     #     If provided this takes precedence over the cookie.
@@ -1655,7 +1697,7 @@ module FusionAuth
     # action.
     #
     # @param action_id [string] The Id of the action to modify. This is technically the user action log id.
-    # @param request [OpenStruct, Hash] The request that contains all of the information about the modification.
+    # @param request [OpenStruct, Hash] The request that contains all the information about the modification.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def modify_action(action_id, request)
       start.uri('/api/user/action')
@@ -1668,7 +1710,7 @@ module FusionAuth
     #
     # Complete a login request using a passwordless code
     #
-    # @param request [OpenStruct, Hash] The passwordless login request that contains all of the information used to complete login.
+    # @param request [OpenStruct, Hash] The passwordless login request that contains all the information used to complete login.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def passwordless_login(request)
       startAnonymous.uri('/api/passwordless/login')
@@ -1681,7 +1723,7 @@ module FusionAuth
     # 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.
+    # @param request [OpenStruct, Hash] The request object that contains all 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')
@@ -2211,7 +2253,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the application for the given id or all of the applications if the id is null.
+    # Retrieves the application for the given id or all the applications if the id is null.
     #
     # @param application_id [string] (Optional) The application id.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2306,7 +2348,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the email template for the given Id. If you don't specify the id, this will return all of the email templates.
+    # Retrieves the email template for the given Id. If you don't specify the id, this will return all the email templates.
     #
     # @param email_template_id [string] (Optional) The Id of the email template.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2507,7 +2549,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the identity provider for the given id or all of the identity providers if the id is null.
+    # Retrieves the identity provider for the given id or all the identity providers if the id is null.
     #
     # @param identity_provider_id [string] The identity provider Id.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2706,7 +2748,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the message template for the given Id. If you don't specify the id, this will return all of the message templates.
+    # Retrieves the message template for the given Id. If you don't specify the id, this will return all the message templates.
     #
     # @param message_template_id [string] (Optional) The Id of the message template.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2840,6 +2882,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieve a pending identity provider link. This is useful to validate a pending link and retrieve meta-data about the identity provider link.
+    #
+    # @param p_ending_link_id [string] The pending link Id.
+    # @param user_id [string] The optional userId. When provided additional meta-data will be provided to identify how many links if any the user already has.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_pending_link(pending_link_id, user_id)
+      start.uri('/api/identity-provider/link/pending')
+          .url_segment(pending_link_id)
+          .url_parameter('userId', user_id)
+          .get()
+          .go()
+    end
+
     #
     # Retrieves the FusionAuth Reactor metrics.
     #
@@ -2995,7 +3051,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the totals report. This contains all of the total counts for each application and the global registration
+    # Retrieves the totals report. This contains all the total counts for each application and the global registration
     # count.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3049,7 +3105,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the user action for the given Id. If you pass in null for the id, this will return all of the user
+    # Retrieves the user action for the given Id. If you pass in null for the id, this will return all the user
     # actions.
     #
     # @param user_action_id [string] (Optional) The Id of the user action.
@@ -3062,7 +3118,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all of the user
+    # Retrieves the user action reason for the given Id. If you pass in null for the id, this will return all the user
     # action reasons.
     #
     # @param user_action_reason_id [string] (Optional) The Id of the user action reason.
@@ -3156,6 +3212,46 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Retrieve a user_code that is part of an in-progress Device Authorization Grant.
+    # 
+    # This API is useful if you want to build your own login workflow to complete a device grant.
+    #
+    # @param client_id [string] The client id.
+    # @param client_secret [string] The client id.
+    # @param user_code [string] The end-user verification code.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_user_code(client_id, client_secret, user_code)
+      body = {
+        "client_id" => client_id,
+        "client_secret" => client_secret,
+        "user_code" => user_code
+      }
+      startAnonymous.uri('/oauth2/device/user-code')
+          .body_handler(FusionAuth::FormDataBodyHandler.new(body))
+          .get()
+          .go()
+    end
+
+    #
+    # Retrieve a user_code that is part of an in-progress Device Authorization Grant.
+    # 
+    # This API is useful if you want to build your own login workflow to complete a device grant.
+    # 
+    # This request will require an API key.
+    #
+    # @param user_code [string] The end-user verification code.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def retrieve_user_code_using_api_key(user_code)
+      body = {
+        "user_code" => user_code
+      }
+      startAnonymous.uri('/oauth2/device/user-code')
+          .body_handler(FusionAuth::FormDataBodyHandler.new(body))
+          .get()
+          .go()
+    end
+
     #
     # Retrieves all the comments for the user with the given Id.
     #
@@ -3482,6 +3578,18 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Searches applications with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_applications(request)
+      start.uri('/api/application/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Searches the audit logs with the specified criteria and pagination.
     #
@@ -3494,6 +3602,30 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Searches consents with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_consents(request)
+      start.uri('/api/consent/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Searches email templates with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_email_templates(request)
+      start.uri('/api/email/template/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Searches entities with the specified criteria and pagination.
     #
@@ -3590,6 +3722,42 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Searches identity providers with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_identity_providers(request)
+      start.uri('/api/identity-provider/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Searches keys with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_keys(request)
+      start.uri('/api/key/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Searches lambdas with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_lambdas(request)
+      start.uri('/api/lambda/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Searches the login records with the specified criteria and pagination.
     #
@@ -3602,6 +3770,42 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Searches tenants with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_tenants(request)
+      start.uri('/api/tenant/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Searches themes with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_themes(request)
+      start.uri('/api/theme/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
+    #
+    # Searches user comments with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_user_comments(request)
+      start.uri('/api/user/comment/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Retrieves the users for the given ids. If any id is invalid, it is ignored.
     #
@@ -3654,12 +3858,24 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Searches webhooks with the specified criteria and pagination.
+    #
+    # @param request [OpenStruct, Hash] The search criteria and pagination information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def search_webhooks(request)
+      start.uri('/api/webhook/search')
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post()
+          .go()
+    end
+
     #
     # Send an email using an email template id. You can optionally provide <code>requestData</code> to access key value
     # pairs in the email template.
     #
     # @param email_template_id [string] The id for the template.
-    # @param request [OpenStruct, Hash] The send email request that contains all of the information used to send the email.
+    # @param request [OpenStruct, Hash] The send email request that contains all the information used to send the email.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def send_email(email_template_id, request)
       start.uri('/api/email/send')
@@ -3684,7 +3900,7 @@ module FusionAuth
     #
     # Send a passwordless authentication code in an email to complete login.
     #
-    # @param request [OpenStruct, Hash] The passwordless send request that contains all of the information used to send an email containing a code.
+    # @param request [OpenStruct, Hash] The passwordless send request that contains all the information used to send an email containing a code.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def send_passwordless_code(request)
       startAnonymous.uri('/api/passwordless/send')
@@ -3735,7 +3951,7 @@ module FusionAuth
     # 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.
+    # @param request [OpenStruct, Hash] The Two Factor send request that contains all 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')
@@ -3762,7 +3978,7 @@ module FusionAuth
     # Start a passwordless login request by generating a passwordless code. This code can be sent to the User using the Send
     # Passwordless Code API or using a mechanism outside of FusionAuth. The passwordless login is completed by using the Passwordless Login API with this code.
     #
-    # @param request [OpenStruct, Hash] The passwordless start request that contains all of the information used to begin the passwordless login request.
+    # @param request [OpenStruct, Hash] The passwordless start request that contains all the information used to begin the passwordless login request.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def start_passwordless_login(request)
       start.uri('/api/passwordless/start')
@@ -3777,9 +3993,9 @@ module FusionAuth
     # 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).
+    # This API is intended to allow you to begin a Two-Factor login outside 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.
+    # @param request [OpenStruct, Hash] The Two-Factor start request that contains all 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')
@@ -3842,7 +4058,7 @@ module FusionAuth
     # Updates the application with the given Id.
     #
     # @param application_id [string] The Id of the application to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new application information.
+    # @param request [OpenStruct, Hash] The request that contains all the new application information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_application(application_id, request)
       start.uri('/api/application')
@@ -3857,7 +4073,7 @@ module FusionAuth
     #
     # @param application_id [string] The Id of the application that the role belongs to.
     # @param role_id [string] The Id of the role to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new role information.
+    # @param request [OpenStruct, Hash] The request that contains all the new role information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_application_role(application_id, role_id, request)
       start.uri('/api/application')
@@ -3873,7 +4089,7 @@ module FusionAuth
     # Updates the connector with the given Id.
     #
     # @param connector_id [string] The Id of the connector to update.
-    # @param request [OpenStruct, Hash] The request object that contains all of the new connector information.
+    # @param request [OpenStruct, Hash] The request object that contains all the new connector information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_connector(connector_id, request)
       start.uri('/api/connector')
@@ -3887,7 +4103,7 @@ module FusionAuth
     # Updates the consent with the given Id.
     #
     # @param consent_id [string] The Id of the consent to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new consent information.
+    # @param request [OpenStruct, Hash] The request that contains all the new consent information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_consent(consent_id, request)
       start.uri('/api/consent')
@@ -3901,7 +4117,7 @@ module FusionAuth
     # Updates the email template with the given Id.
     #
     # @param email_template_id [string] The Id of the email template to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new email template information.
+    # @param request [OpenStruct, Hash] The request that contains all the new email template information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_email_template(email_template_id, request)
       start.uri('/api/email/template')
@@ -3915,7 +4131,7 @@ module FusionAuth
     # 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.
+    # @param request [OpenStruct, Hash] The request that contains all the new Entity information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_entity(entity_id, request)
       start.uri('/api/entity')
@@ -3929,7 +4145,7 @@ module FusionAuth
     # 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.
+    # @param request [OpenStruct, Hash] The request that contains all the new Entity Type information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_entity_type(entity_type_id, request)
       start.uri('/api/entity/type')
@@ -3944,7 +4160,7 @@ module FusionAuth
     #
     # @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.
+    # @param request [OpenStruct, Hash] The request that contains all 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')
@@ -3960,7 +4176,7 @@ module FusionAuth
     # Updates the form with the given Id.
     #
     # @param form_id [string] The Id of the form to update.
-    # @param request [OpenStruct, Hash] The request object that contains all of the new form information.
+    # @param request [OpenStruct, Hash] The request object that contains all the new form information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_form(form_id, request)
       start.uri('/api/form')
@@ -3974,7 +4190,7 @@ module FusionAuth
     # Updates the form field with the given Id.
     #
     # @param field_id [string] The Id of the form field to update.
-    # @param request [OpenStruct, Hash] The request object that contains all of the new form field information.
+    # @param request [OpenStruct, Hash] The request object that contains all the new form field information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_form_field(field_id, request)
       start.uri('/api/form/field')
@@ -3988,7 +4204,7 @@ module FusionAuth
     # Updates the group with the given Id.
     #
     # @param group_id [string] The Id of the group to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new group information.
+    # @param request [OpenStruct, Hash] The request that contains all the new group information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_group(group_id, request)
       start.uri('/api/group')
@@ -4014,7 +4230,7 @@ module FusionAuth
     # 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.
+    # @param request [OpenStruct, Hash] The request that contains all 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')
@@ -4041,7 +4257,7 @@ module FusionAuth
     #
     # Updates the available integrations.
     #
-    # @param request [OpenStruct, Hash] The request that contains all of the new integration information.
+    # @param request [OpenStruct, Hash] The request that contains all the new integration information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_integrations(request)
       start.uri('/api/integration')
@@ -4054,7 +4270,7 @@ module FusionAuth
     # Updates the key with the given Id.
     #
     # @param key_id [string] The Id of the key to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new key information.
+    # @param request [OpenStruct, Hash] The request that contains all the new key information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_key(key_id, request)
       start.uri('/api/key')
@@ -4068,7 +4284,7 @@ module FusionAuth
     # Updates the lambda with the given Id.
     #
     # @param lambda_id [string] The Id of the lambda to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new lambda information.
+    # @param request [OpenStruct, Hash] The request that contains all the new lambda information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_lambda(lambda_id, request)
       start.uri('/api/lambda')
@@ -4082,7 +4298,7 @@ module FusionAuth
     # 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.
+    # @param request [OpenStruct, Hash] The request that contains all the new message template information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_message_template(message_template_id, request)
       start.uri('/api/message/template')
@@ -4096,7 +4312,7 @@ module FusionAuth
     # 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.
+    # @param request [OpenStruct, Hash] The request object that contains all the new messenger information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_messenger(messenger_id, request)
       start.uri('/api/messenger')
@@ -4110,7 +4326,7 @@ module FusionAuth
     # Updates the registration for the user with the given id and the application defined in the request.
     #
     # @param user_id [string] The Id of the user whose registration is going to be updated.
-    # @param request [OpenStruct, Hash] The request that contains all of the new registration information.
+    # @param request [OpenStruct, Hash] The request that contains all the new registration information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_registration(user_id, request)
       start.uri('/api/user/registration')
@@ -4123,7 +4339,7 @@ module FusionAuth
     #
     # Updates the system configuration.
     #
-    # @param request [OpenStruct, Hash] The request that contains all of the new system configuration information.
+    # @param request [OpenStruct, Hash] The request that contains all the new system configuration information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_system_configuration(request)
       start.uri('/api/system-configuration')
@@ -4136,7 +4352,7 @@ module FusionAuth
     # Updates the tenant with the given Id.
     #
     # @param tenant_id [string] The Id of the tenant to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new tenant information.
+    # @param request [OpenStruct, Hash] The request that contains all the new tenant information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_tenant(tenant_id, request)
       start.uri('/api/tenant')
@@ -4150,7 +4366,7 @@ module FusionAuth
     # Updates the theme with the given Id.
     #
     # @param theme_id [string] The Id of the theme to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new theme information.
+    # @param request [OpenStruct, Hash] The request that contains all the new theme information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_theme(theme_id, request)
       start.uri('/api/theme')
@@ -4164,7 +4380,7 @@ module FusionAuth
     # Updates the user with the given Id.
     #
     # @param user_id [string] The Id of the user to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new user information.
+    # @param request [OpenStruct, Hash] The request that contains all the new user information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_user(user_id, request)
       start.uri('/api/user')
@@ -4178,7 +4394,7 @@ module FusionAuth
     # Updates the user action with the given Id.
     #
     # @param user_action_id [string] The Id of the user action to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new user action information.
+    # @param request [OpenStruct, Hash] The request that contains all the new user action information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_user_action(user_action_id, request)
       start.uri('/api/user-action')
@@ -4192,7 +4408,7 @@ module FusionAuth
     # Updates the user action reason with the given Id.
     #
     # @param user_action_reason_id [string] The Id of the user action reason to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new user action reason information.
+    # @param request [OpenStruct, Hash] The request that contains all the new user action reason information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_user_action_reason(user_action_reason_id, request)
       start.uri('/api/user-action-reason')
@@ -4220,7 +4436,7 @@ module FusionAuth
     # Updates the webhook with the given Id.
     #
     # @param webhook_id [string] The Id of the webhook to update.
-    # @param request [OpenStruct, Hash] The request that contains all of the new webhook information.
+    # @param request [OpenStruct, Hash] The request that contains all the new webhook information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def update_webhook(webhook_id, request)
       start.uri('/api/webhook')
@@ -4286,7 +4502,7 @@ module FusionAuth
     # 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.
+    # @param request [OpenStruct, Hash] The request that contains all the claims for this JWT.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def vend_jwt(request)
       start.uri('/api/jwt/vend')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.44.0
+  version: 1.46.0
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.