fusionauth_client 1.56.0 → 1.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 817271c704c56e0f62dfd5ee99c6dbdd79353377ff6ea836e5bad191e2c2c7fa
-  data.tar.gz: 1f6aee97af885e67a85c3c01d304bd3db663cc178d9e652ded072026580344c4
+  metadata.gz: f06ceac18ef4f1734bc2d63657291958dae0b2591d336030826589f3801b5e2f
+  data.tar.gz: 28b3a2778f69f15ac5c0c850781a38ff38bb9c9717f3e0a9f29301ae1254faa2
 SHA512:
-  metadata.gz: 483eca10733228fb337c283c964c37676d7e770cf365cfeefa90140766a52baa67d3b80ac45251b496978a36d6464435a16a585c91322e8507c01395ff74bed7
-  data.tar.gz: d5a450ee453cf7987dd143841eb907c39fab24016f424dc131d51dae43c51265bec2fbfc71d5ddd3f4f3e244b17e8eaf99e18169a0b1d66a4a3accdb27db7aa8
+  metadata.gz: 858e37978cc8e31ee054164370719cfa78f9d40db41d33180df04035fe882472ba6704d24632e51fef33a5d3620355b8291a590858239c921049018314569e79
+  data.tar.gz: d66be2e746892494ac3d1fba0a333e70b02fa7d3950032c87e7ff0e54b2354b054011a87a93db1cd92dea87473d8b5da3e4eb9e8557d08f25ecf76b3f65b1713

data/.github/workflows/deploy.yaml

@@ -1,10 +1,4 @@
-# Run locally with act:
-#
-# act pull_request [--input command=[command]] \
-#  --platform fusionauth-standard=[ecr-repo-name]/fusionauth-standard:latest] \
-#  --workflows ./.github/workflows/deploy.yaml \
-#  --env-file <(aws configure export-credentials --profile [aws-profile] --format env)
-
+---
 name: Deploy
 
 on:
@@ -26,39 +20,57 @@ on:
 
 permissions:
   contents: read
+  id-token: write
 
 jobs:
-  build:
-    if: |
-      github.event_name == 'pull_request' ||
-      github.event_name == 'push' ||
-      github.event_name == 'workflow_dispatch' && inputs.command == 'build'
-    runs-on: fusionauth-standard
+  deploy:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: /usr/bin/bash -l -e -o pipefail {0}
     steps:
       - name: checkout
         uses: actions/checkout@v4
 
+      - name: setup java
+        uses: actions/setup-java@v4
+        with:
+          distribution: temurin
+          java-version: 21
+          java-package: jre
+
+      - name: install savant
+        run: |
+          curl -O https://repository.savantbuild.org/org/savantbuild/savant-core/2.0.0/savant-2.0.0.tar.gz
+          tar xzvf savant-2.0.0.tar.gz
+          savant-2.0.0/bin/sb --version
+          SAVANT_PATH=$(realpath -s "./savant-2.0.0/bin")
+          echo "${SAVANT_PATH}" >> $GITHUB_PATH
+          mkdir -p ~/.savant/plugins
+          cat << EOF > ~/.savant/plugins/org.savantbuild.plugin.java.properties
+          21=${JAVA_HOME}
+          EOF
+
+      # Installs the version specified in the .ruby-version file in the repo root.
+      - name: install ruby
+        uses: ruby/setup-ruby@v1
+
       - name: compile
         shell: bash -l {0}
         run: sb compile
 
-  deploy:
-    if: |
-      github.event_name == 'workflow_dispatch' &&
-      (inputs.command == 'release' || inputs.command == 'publish')
-    runs-on: fusionauth-standard
-    steps:
-      - name: checkout
-        uses: actions/checkout@v4
+      ### Everything below this line will only run on a workflow_dispatch
 
       - name: set aws credentials
+        if: inputs.command == 'release' || inputs.command == 'publish'
         uses: aws-actions/configure-aws-credentials@v4
         with:
-          role-to-assume: arn:aws:iam::752443094709:role/github-actions
+          role-to-assume: arn:aws:iam::752443094709:role/gha-fusionauth-ruby-client
           role-session-name: aws-auth-action
           aws-region: us-west-2
 
       - name: get secret
+        if: inputs.command == 'release' || inputs.command == 'publish'
         run: |
           while IFS=$'\t' read -r key value; do
             echo "::add-mask::${value}"
@@ -71,6 +83,7 @@ jobs:
             jq -r 'to_entries[] | [.key, .value] | @tsv')
 
       - name: set gem credentials
+        if: inputs.command == 'release' || inputs.command == 'publish'
         run: |
           mkdir -p ~/.gem
           echo ":rubygems_api_key: ${{ env.API_KEY }}" > ~/.gem/credentials
@@ -78,10 +91,8 @@ jobs:
 
       - name: release to svn
         if: inputs.command == 'release'
-        shell: bash -l {0}
         run: sb release
 
       - name: publish to rubygems
         if: inputs.command == 'publish'
-        shell: bash -l {0}
         run: sb publish

data/.github/workflows/test.yml

@@ -3,10 +3,13 @@ name: Test Library
 on:
   push:
     branches:
+      - develop
       - main
   pull_request:
     branches:
+      - develop
       - main
+  workflow_dispatch:
 
 permissions:
   contents: read

data/.ruby-version

@@ -1 +1 @@
-2.7.5
+3.4.2

data/Gemfile

@@ -13,10 +13,10 @@
 # language governing permissions and limitations under the License.
 
 source 'https://rubygems.org'
-ruby '2.7.5'
+ruby '3.4.2'
 
-gem 'minitest',      '~> 5.22', '>= 5.22.3'
-gem 'rake',          '~> 13.2', '>= 13.2.1'
+gem 'minitest',      '~> 5.25'
+gem 'rake',          '~> 13.2'
 gem 'rdoc-markdown', '~> 0.4.2'
 
 # Specify your gem's dependencies in fusionauth_client.gemspec

data/Gemfile.lock

@@ -1,27 +1,39 @@
 PATH
   remote: .
   specs:
-    fusionauth_client (1.56.0)
+    fusionauth_client (1.58.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    cgi (0.4.1)
+    cgi (0.4.2)
+    date (3.4.1)
     erb (2.2.3)
       cgi
     extralite-bundle (1.27)
-    minitest (5.22.3)
-    nokogiri (1.15.6-aarch64-linux)
+    minitest (5.25.5)
+    nokogiri (1.18.6-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.15.6-arm64-darwin)
+    nokogiri (1.18.6-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.15.6-x86_64-linux)
+    nokogiri (1.18.6-arm-linux-gnu)
       racc (~> 1.4)
-    psych (5.1.2)
+    nokogiri (1.18.6-arm-linux-musl)
+      racc (~> 1.4)
+    nokogiri (1.18.6-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.6-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.18.6-x86_64-linux-gnu)
+      racc (~> 1.4)
+    nokogiri (1.18.6-x86_64-linux-musl)
+      racc (~> 1.4)
+    psych (5.2.3)
+      date
       stringio
-    racc (1.7.3)
+    racc (1.8.1)
     rake (13.2.1)
-    rdoc (6.6.3.1)
+    rdoc (6.13.0)
       psych (>= 4.0.0)
     rdoc-markdown (0.4.2)
       erb (~> 2.0)
@@ -31,22 +43,27 @@ GEM
       unindent (~> 1.0)
     reverse_markdown (2.1.1)
       nokogiri
-    stringio (3.1.0)
+    stringio (3.1.6)
     unindent (1.0)
 
 PLATFORMS
-  aarch64-linux
-  arm64-darwin-23
-  x86_64-linux
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
 
 DEPENDENCIES
   fusionauth_client!
-  minitest (~> 5.22, >= 5.22.3)
-  rake (~> 13.2, >= 13.2.1)
+  minitest (~> 5.25)
+  rake (~> 13.2)
   rdoc-markdown (~> 0.4.2)
 
 RUBY VERSION
-   ruby 2.7.5p203
+   ruby 3.4.2p28
 
 BUNDLED WITH
-   2.4.22
+   2.6.2

data/Rakefile

@@ -1,10 +1,10 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
+require "minitest/test_task"
 
-Rake::TestTask.new(:test) do |t|
+Minitest::TestTask.create(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*test.rb']
+  t.test_globs = FileList['test/**/*test.rb']
 end
 
 task :default => :test

data/build.savant

@@ -15,7 +15,7 @@
  */
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.56.0", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.58.0", licenses: ["ApacheV2_0"]) {
   workflow {
     fetch {
       cache()

data/fusionauth-ruby-client.iml

@@ -6,11 +6,11 @@
       <sourceFolder url="file://$MODULE_DIR$/lib" isTestSource="false" />
       <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
     </content>
-    <orderEntry type="jdk" jdkName="rbenv: 2.7.5" jdkType="RUBY_SDK" />
+    <orderEntry type="jdk" jdkName="rbenv: 3.4.2" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.4.22, rbenv: 2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="cgi (v0.4.1, rbenv: 2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="psych (v5.1.2, rbenv: 2.7.5) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rake (v13.2.1, rbenv: 2.7.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.6.2, rbenv: 3.4.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="cgi (v0.4.2, rbenv: 3.4.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="psych (v5.2.3, rbenv: 3.4.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.2.1, rbenv: 3.4.2) [gem]" level="application" />
   </component>
-</module>
+</module>

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

data/lib/fusionauth/fusionauth_client.rb

@@ -2,7 +2,7 @@ require 'ostruct'
 require 'fusionauth/rest_client'
 
 #
-# Copyright (c) 2018-2023, FusionAuth, All Rights Reserved
+# Copyright (c) 2018-2025, 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.
@@ -134,6 +134,23 @@ module FusionAuth
           .go
     end
 
+    #
+    # Changes a user's password using their access token (JWT) instead of the changePasswordId
+    # A common use case for this method will be if you want to allow the user to change their own password.
+    # 
+    # Remember to send refreshToken in the request body if you want to get a new refresh token when login using the returned oneTimePassword.
+    #
+    # @param encoded_jwt [string] The encoded JWT (access token).
+    # @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_jwt(encoded_jwt, request)
+      startAnonymous.uri('/api/user/change-password')
+          .authorization('Bearer ' + encoded_jwt)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .post
+          .go
+    end
+
     #
     # Changes a user's password using their identity (loginId and password). Using a loginId instead of the changePasswordId
     # bypasses the email verification and allows a password to be changed directly without first calling the #forgotPassword
@@ -734,7 +751,7 @@ module FusionAuth
     end
 
     #
-    # Deactivates the users with the given ids.
+    # Deactivates the users with the given Ids.
     #
     # @param user_ids [Array] The ids of the users to deactivate.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -749,7 +766,7 @@ module FusionAuth
     end
 
     #
-    # Deactivates the users with the given ids.
+    # Deactivates the users with the given Ids.
     #
     # @param user_ids [Array] The ids of the users to deactivate.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -1191,8 +1208,8 @@ module FusionAuth
     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.
+    # 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.
     # 
     # This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.
     # Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
@@ -1208,8 +1225,8 @@ module FusionAuth
     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.
+    # 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.
     # 
     # This method can be used to deactivate or permanently delete (hard-delete) users based upon the hardDelete boolean in the request body.
     # Using the dryRun parameter you may also request the result of the action without actually deleting or deactivating any users.
@@ -1730,7 +1747,7 @@ module FusionAuth
     # Modifies a temporal user action by changing the expiration of the action and optionally adding a comment to the
     # action.
     #
-    # @param action_id [string] The Id of the action to modify. This is technically the user action log id.
+    # @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 the information about the modification.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def modify_action(action_id, request)
@@ -1754,16 +1771,16 @@ module FusionAuth
     end
 
     #
-    # Updates an authentication API key by given id
+    # Updates an API key with the 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 the information needed to create the APIKey.
+    # @param key_id [string] The Id of the API key. If not provided a secure random api key will be generated.
+    # @param request [OpenStruct, Hash] The request object that contains all the information needed to create the API key.
     # @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
+          .patch
           .go
     end
 
@@ -1840,6 +1857,20 @@ module FusionAuth
           .go
     end
 
+    #
+    # Updates, via PATCH, the Entity with the given Id.
+    #
+    # @param entity_id [string] The Id of the Entity Type to update.
+    # @param request [OpenStruct, Hash] The request that contains just the new Entity information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_entity(entity_id, request)
+      start.uri('/api/entity')
+          .url_segment(entity_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch
+          .go
+    end
+
     #
     # Updates, via PATCH, the Entity Type with the given Id.
     #
@@ -1854,6 +1885,51 @@ module FusionAuth
           .go
     end
 
+    #
+    # Patches 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 patch.
+    # @param request [OpenStruct, Hash] The request that contains the new permission information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_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))
+          .patch
+          .go
+    end
+
+    #
+    # Patches the form with the given Id.
+    #
+    # @param form_id [string] The Id of the form to patch.
+    # @param request [OpenStruct, Hash] The request object that contains the new form information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_form(form_id, request)
+      start.uri('/api/form')
+          .url_segment(form_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch
+          .go
+    end
+
+    #
+    # Patches the form field with the given Id.
+    #
+    # @param field_id [string] The Id of the form field to patch.
+    # @param request [OpenStruct, Hash] The request object that contains the new form field information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_form_field(field_id, request)
+      start.uri('/api/form/field')
+          .url_segment(field_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch
+          .go
+    end
+
     #
     # Updates, via PATCH, the group with the given Id.
     #
@@ -1868,6 +1944,20 @@ module FusionAuth
           .go
     end
 
+    #
+    # Update the IP Access Control List with the given Id.
+    #
+    # @param access_control_list_id [string] The Id of the IP Access Control List to patch.
+    # @param request [OpenStruct, Hash] The request that contains the new IP Access Control List information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_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))
+          .patch
+          .go
+    end
+
     #
     # Updates, via PATCH, the identity provider with the given Id.
     #
@@ -2063,6 +2153,20 @@ module FusionAuth
           .go
     end
 
+    #
+    # Patches 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 the new webhook information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def patch_webhook(webhook_id, request)
+      start.uri('/api/webhook')
+          .url_segment(webhook_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .patch
+          .go
+    end
+
     #
     # Reactivates the application with the given Id.
     #
@@ -2185,7 +2289,7 @@ module FusionAuth
     end
 
     #
-    # Removes a user from the family with the given id.
+    # Removes a user from the family with the given Id.
     #
     # @param family_id [string] The Id of the family to remove the user from.
     # @param user_id [string] The Id of the user to remove from the family.
@@ -2240,7 +2344,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves an authentication API key for the given id
+    # 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.
@@ -2306,7 +2410,7 @@ module FusionAuth
     #
     # Retrieves the application for the given Id or all the applications if the Id is null.
     #
-    # @param application_id [string] (Optional) The application id.
+    # @param application_id [string] (Optional) The application Id.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def retrieve_application(application_id)
       start.uri('/api/application')
@@ -2382,10 +2486,10 @@ module FusionAuth
     end
 
     #
-    # Retrieves the daily active user report between the two instants. If you specify an application id, it will only
+    # Retrieves the daily active user report between the two instants. If you specify an application Id, it will only
     # return the daily active counts for that application.
     #
-    # @param application_id [string] (Optional) The application id.
+    # @param application_id [string] (Optional) The application Id.
     # @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
     # @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2399,7 +2503,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the email template for the given Id. If you don't specify the id, this will return all 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.
@@ -2782,10 +2886,10 @@ module FusionAuth
     end
 
     #
-    # Retrieves the login report between the two instants. If you specify an application id, it will only return the
+    # Retrieves the login report between the two instants. If you specify an application Id, it will only return the
     # login counts for that application.
     #
-    # @param application_id [string] (Optional) The application id.
+    # @param application_id [string] (Optional) The application Id.
     # @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
     # @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -2799,7 +2903,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the message template for the given Id. If you don't specify the id, this will return all 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.
@@ -2855,10 +2959,10 @@ module FusionAuth
     end
 
     #
-    # Retrieves the monthly active user report between the two instants. If you specify an application id, it will only
+    # 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.
     #
-    # @param application_id [string] (Optional) The application id.
+    # @param application_id [string] (Optional) The application Id.
     # @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
     # @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3021,7 +3125,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the user registration for the user with the given Id and the given application id.
+    # Retrieves the user registration for the user with the given Id and the given application Id.
     #
     # @param user_id [string] The Id of the user.
     # @param application_id [string] The Id of the application.
@@ -3035,10 +3139,10 @@ module FusionAuth
     end
 
     #
-    # Retrieves the registration report between the two instants. If you specify an application id, it will only return
+    # Retrieves the registration report between the two instants. If you specify an application Id, it will only return
     # the registration counts for that application.
     #
-    # @param application_id [string] (Optional) The application id.
+    # @param application_id [string] (Optional) The application Id.
     # @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
     # @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3201,7 +3305,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the user action for the given Id. If you pass in null for the id, this will return all 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.
@@ -3214,7 +3318,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 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.
@@ -3313,8 +3417,8 @@ module FusionAuth
     # 
     # 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 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)
@@ -3427,11 +3531,11 @@ module FusionAuth
     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
+    # 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.
     #
-    # @param application_id [string] (Optional) The application id.
-    # @param user_id [string] The userId id.
+    # @param application_id [string] (Optional) The application Id.
+    # @param user_id [string] The userId Id.
     # @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
     # @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3446,11 +3550,11 @@ module FusionAuth
     end
 
     #
-    # Retrieves the login report between the two instants for a particular user by login Id. If you specify an application id, it will only return the
+    # Retrieves the login report between the two instants for a particular user by login Id. If you specify an application Id, it will only return the
     # login counts for that application.
     #
-    # @param application_id [string] (Optional) The application id.
-    # @param login_id [string] The userId id.
+    # @param application_id [string] (Optional) The application Id.
+    # @param login_id [string] The userId Id.
     # @param start [OpenStruct, Hash] The start instant as UTC milliseconds since Epoch.
     # @param _end [OpenStruct, Hash] The end instant as UTC milliseconds since Epoch.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3527,7 +3631,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the webhook for the given Id. If you pass in null for the id, this will return all the webhooks.
+    # Retrieves the webhook for the given Id. If you pass in null for the Id, this will return all the webhooks.
     #
     # @param webhook_id [string] (Optional) The Id of the webhook.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3759,7 +3863,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the entities for the given ids. If any Id is invalid, it is ignored.
+    # 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.
@@ -3927,7 +4031,7 @@ module FusionAuth
     end
 
     #
-    # Retrieves the users for the given ids. If any Id is invalid, it is ignored.
+    # Retrieves the users for the given Ids. If any Id is invalid, it is ignored.
     #
     # @param ids [Array] The user ids to search for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -3940,9 +4044,9 @@ module FusionAuth
     end
 
     #
-    # Retrieves the users for the given ids. If any Id is invalid, it is ignored.
+    # Retrieves the users for the given Ids. If any Id is invalid, it is ignored.
     #
-    # @param ids [Array] The user ids to search for.
+    # @param ids [Array] The user Ids to search for.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def search_users_by_ids(ids)
       start.uri('/api/user/search')
@@ -4003,7 +4107,7 @@ module FusionAuth
     end
 
     #
-    # Send an email using an email template id. You can optionally provide <code>requestData</code> to access key value
+    # 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.
@@ -4173,14 +4277,14 @@ module FusionAuth
     end
 
     #
-    # Updates an API key by given id
+    # Updates an API key with the 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 the information used to create the API Key.
+    # @param key_id [string] The Id of the API key to update.
+    # @param request [OpenStruct, Hash] The request that contains all the new API key information.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
-    def update_api_key(api_key_id, request)
+    def update_api_key(key_id, request)
       start.uri('/api/api-key')
-          .url_segment(api_key_id)
+          .url_segment(key_id)
           .body_handler(FusionAuth::JSONBodyHandler.new(request))
           .put
           .go
@@ -4304,6 +4408,20 @@ module FusionAuth
           .go
     end
 
+    #
+    # Updates a family with a given Id.
+    #
+    # @param family_id [string] The Id of the family to update.
+    # @param request [OpenStruct, Hash] The request object that contains all the new family information.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def update_family(family_id, request)
+      start.uri('/api/user/family')
+          .url_segment(family_id)
+          .body_handler(FusionAuth::JSONBodyHandler.new(request))
+          .put
+          .go
+    end
+
     #
     # Updates the form with the given Id.
     #
@@ -4615,7 +4733,7 @@ module FusionAuth
     # If you build your own activation form you should validate the user provided code prior to beginning the Authorization grant.
     #
     # @param user_code [string] The end-user verification code.
-    # @param client_id [string] The client id.
+    # @param client_id [string] The client Id.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     def validate_device(user_code, client_id)
       startAnonymous.uri('/oauth2/device/validate')

data/run-act.sh

@@ -0,0 +1,130 @@
+#!/usr/bin/env bash
+
+set -o errexit
+set -o nounset
+set -o pipefail
+
+EVENT="workflow_dispatch"
+INPUTS=""
+PARSED_INPUTS=()
+PROFILE=""
+VERBOSE=false
+WORKFLOW=""
+
+# Script metadata. Don't modify this.
+MYDIR=$(cd -- "$(dirname "$0")" >/dev/null 2>&1; pwd -P)
+cd "${MYDIR}"
+MYNAME=$(basename "$0")
+
+# Configure colorful messages.
+GRAY=$(tput setaf 248)
+GREEN=$(tput setaf 2)
+RED=$(tput setaf 202)
+RESET=$(tput sgr0)
+
+# Output formatting.
+function success() { echo -e "${GREEN}${1}${RESET}"; }
+function info()    { echo -e "${GRAY}${1}${RESET}"; }
+function error()   { echo -e "${RED}ERROR: ${1}${RESET}" >&2; }
+function fail()    { echo -e "\n${RED}ERROR: ${1}${RESET}" >&2; exit 1; }
+function argerr()  { echo -e "\n${RED}ERROR: ${1}${RESET}" >&2; show_help; }
+
+# Helper functions.
+function file_missing() { if [[ -f "${1}" ]]; then return 1; else return 0; fi }
+
+function show_help() {
+  echo -e "\nUsage: ${MYNAME} --workflow [workflow-name.yaml] --profile [aws-profile-name]\n"
+  echo -e "    Flags            Description                     Req    Default"
+  echo -e "    -------------    ----------------------------    ---    -------------------"
+  echo -e "    -e --event       Github event to simulate               workflow_dispatch"
+  echo -e "    -i --inputs      CSV list of k/v pairs            *     ${GRAY}null${RESET}"
+  echo -e "    -p --profile     AWS profile to use for auth      Y     ${GRAY}null${RESET}"
+  echo -e "    -v --verbose     Enable verbose mode (set -xv)          ${GRAY}disabled${RESET}"
+  echo -e "    -w --workflow    Path/file of workflow to run     Y     ${GRAY}null${RESET}"
+  echo -e "    -h --help        Show this message\n"
+  echo -e "    * --inputs requirements are determined by the workflow.\n"
+  echo -e "See https://nektosact.com/ for more info about 'act'.\n"
+  exit
+}
+
+
+function parse_args() {
+  # Parse the args.
+  while [[ $# -gt 0 ]]; do
+    case $1 in
+      -e|--event) shift
+        if (( $# < 1 )); then argerr "--event requires an event type [push|pull_request|workflow_dispatch]"
+        else EVENT="${1}"; fi
+        shift;;
+      -i|--inputs) shift
+        if (( $# < 1 )); then argerr "--inputs requires a csv list of input args"
+        else INPUTS="${1}"; fi
+        shift;;
+      -p|--profile) shift
+        if (( $# < 1 )); then argerr "--profile requires an AWS profile name"
+        else PROFILE="${1}"; fi
+        shift;;
+      -w|--workflow) shift
+        if (( $# < 1 )); then argerr "--workflow requires a path to a workflow file"
+        else WORKFLOW="${1}"; fi
+        shift;;
+      -v|--verbose) VERBOSE=true; shift;;
+      -h|--help) show_help;;
+      *) argerr "Unknown argument '$1'";;
+    esac
+  done
+
+  # Enable verbose mode if requested.
+  if [ "${VERBOSE}" = true ]; then set -xv; fi
+
+  # Make sure --workflow is passed.
+  if [[ -z "${WORKFLOW}" ]]; then argerr "--workflow is required"; fi
+  # Make sure --workflow is passed.
+  if [[ -z "${PROFILE}" ]]; then argerr "--profile is required"; fi
+  # Make sure workflow file exists
+  if file_missing "${WORKFLOW}"; then fail "Workflow '${WORKFLOW}' does not exist"; fi
+}
+
+
+function validate_prereqs() {
+  local prereqs="act gh"
+  for p in ${prereqs}; do
+    if ! command -v "${p}" &>/dev/null; then
+      error "${p} not found. Install it and try again."
+      if [[ "${p}" == "gh" ]]; then
+        info "\nAfter installing gh, login:"
+        info "    gh auth login"
+        info "\nMake sure you can get a token:"
+        info "    gh auth token"
+      fi
+      exit 1
+    fi
+  done
+}
+
+
+function parse_inputs() {
+  if [[ -n "${INPUTS}" ]]; then
+    IFS=","
+    for i in ${INPUTS}; do
+      PARSED_INPUTS+=(--input "${i}")
+    done
+  fi
+}
+
+
+function main() {
+  parse_args "$@"
+  validate_prereqs
+  parse_inputs
+
+  act "${EVENT}" \
+    --secret GITHUB_TOKEN="$(gh auth token)" \
+    --secret-file .env \
+    --workflows "${WORKFLOW}" \
+    --env-file <(aws configure export-credentials --profile "${PROFILE}" --format env) \
+    "${PARSED_INPUTS[@]}"
+}
+
+
+main "$@"

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.56.0
+  version: 1.58.0
 platform: ruby
 authors:
 - Brian Pontarelli
 - Daniel DeGroff
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-07 00:00:00.000000000 Z
+date: 2025-07-21 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.
@@ -90,12 +89,12 @@ files:
 - fusionauth_client.gemspec
 - lib/fusionauth/fusionauth_client.rb
 - lib/fusionauth/rest_client.rb
+- run-act.sh
 homepage: https://github.com/FusionAuth/fusionauth-ruby-client
 licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -110,8 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: The Ruby client library for FusionAuth
 test_files: []