fusionauth_client 1.21.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2112fbc16e044c2716b50a04c2a720acc7616e99e0119bc494c721947282504
-  data.tar.gz: 902dcf9aa23e9ea20ec66636d9cdb30d210adc6735cc56e60058c6c8eb643235
+  metadata.gz: d68378f0743777cc83d27ffb6bf0cdaf348f4f7630776b818d37995d00e9b883
+  data.tar.gz: e35f01e8cfb2bba85296c4b12da1118362c5e02d14c2f78707479e7766d6f3e3
 SHA512:
-  metadata.gz: 3c754dbde8485f89dc21b9b746b8ca4880ea8135612af8dcf056798ff92c0d98267b981d78fe1643574348cd4e4b8892df6b0807ff34581fcbfb89e403c266e1
-  data.tar.gz: 240debc7317d5c870636dcccf5aea0380b98dfe95ec10db183992658b8eb140970ac8c5084366ff013b7fcf09412d69b1e9fb2a5d9e3143935e06559004e5a9b
+  metadata.gz: 6966b6e5029bfb6f8ec8d4cdfacc2076fa03f26a891dd1be19296755d58dd4a86d8b217889c1c664743b354fa193b1768668014fdd2c40fa793f8e99a21491f4
+  data.tar.gz: 6cf37a3976925582cde557bba703ec767c2ab17fa80ba36fc3c2d8760571c33582aaf84b669c13d7f6f36683bb50ab69df2c4e0e937ec224faf4013403f7f2e5

data/README.md

@@ -59,12 +59,19 @@ response = client.login({
 user = response.success.response.user
 ```
 
-## Contributing
+## Questions and support
+
+If you have a question or support issue regarding this client library, we'd love to hear from you.
+
+If you have a paid edition with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid editions here](https://fusionauth.io/pricing/).
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/FusionAuth/fusionauth-ruby-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Otherwise, please [post your question in the community forum](https://fusionauth.io/community/forum/).
+
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/FusionAuth/fusionauth-ruby-client.
 
 ## License
 
-The gem is available as open source under the terms of the [Apache v2.0 License](https://opensource.org/licenses/Apache-2.0).
+This code is available as open source under the terms of the [Apache v2.0 License](https://opensource.org/licenses/Apache-2.0).
 

data/build.savant

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

data/fusionauth-ruby-client.iml

@@ -8,7 +8,7 @@
     </content>
     <orderEntry type="jdk" jdkName="rbenv: 2.5.1" jdkType="RUBY_SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.1.4, rbenv: 2.5.1) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.2.5, rbenv: 2.5.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.8.3, rbenv: 2.5.1) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, rbenv: 2.5.1) [gem]" level="application" />
   </component>

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

data/lib/fusionauth/fusionauth_client.rb

@@ -652,6 +652,20 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Deletes the tenant for the given Id asynchronously.
+    # This method is helpful if you do not want to wait for the delete operation to complete.
+    #
+    # @param tenant_id [string] The Id of the tenant to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def delete_tenant_async(tenant_id)
+      start.uri('/api/tenant')
+          .url_segment(tenant_id)
+          .url_parameter('async', true)
+          .delete()
+          .go()
+    end
+
     #
     # Deletes the theme for the given Id.
     #
@@ -2470,8 +2484,30 @@ module FusionAuth
     end
 
     #
-    # Revokes a single refresh token, all tokens for a user or all tokens for an application. If you provide a user id
-    # and an application id, this will delete all the refresh tokens for that user for that application.
+    # Revokes refresh tokens.
+    # 
+    # Usage examples:
+    #   - Delete a single refresh token, pass in only the token.
+    #       revokeRefreshToken(token)
+    # 
+    #   - Delete all refresh tokens for a user, pass in only the userId.
+    #       revokeRefreshToken(null, userId)
+    # 
+    #   - Delete all refresh tokens for a user for a specific application, pass in both the userId and the applicationId.
+    #       revokeRefreshToken(null, userId, applicationId)
+    # 
+    #   - Delete all refresh tokens for an application
+    #       revokeRefreshToken(null, null, applicationId)
+    # 
+    # Note: <code>null</code> may be handled differently depending upon the programming language.
+    # 
+    # See also: (method names may vary by language... but you'll figure it out)
+    # 
+    #  - revokeRefreshTokenById
+    #  - revokeRefreshTokenByToken
+    #  - revokeRefreshTokensByUserId
+    #  - revokeRefreshTokensByApplicationId
+    #  - revokeRefreshTokensByUserIdForApplication
     #
     # @param token [string] (Optional) The refresh token to delete.
     # @param user_id [string] (Optional) The user id whose tokens to delete.
@@ -2486,6 +2522,68 @@ module FusionAuth
           .go()
     end
 
+    #
+    # Revokes a single refresh token by the unique Id. The unique Id is not sensitive as it cannot be used to obtain another JWT.
+    #
+    # @param token_id [string] The unique Id of the token to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_token_by_id(token_id)
+      start.uri('/api/jwt/refresh')
+          .url_segment(token_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Revokes a single refresh token by using the actual refresh token value. This refresh token value is sensitive, so  be careful with this API request.
+    #
+    # @param token [string] The refresh token to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_token_by_token(token)
+      start.uri('/api/jwt/refresh')
+          .url_parameter('token', token)
+          .delete()
+          .go()
+    end
+
+    #
+    # Revoke all refresh tokens that belong to an application by applicationId.
+    #
+    # @param application_id [string] The unique Id of the application that you want to delete all refresh tokens for.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_tokens_by_application_id(application_id)
+      start.uri('/api/jwt/refresh')
+          .url_parameter('applicationId', application_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Revoke all refresh tokens that belong to a user by user Id.
+    #
+    # @param user_id [string] The unique Id of the user that you want to delete all refresh tokens for.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_tokens_by_user_id(user_id)
+      start.uri('/api/jwt/refresh')
+          .url_parameter('userId', user_id)
+          .delete()
+          .go()
+    end
+
+    #
+    # Revoke all refresh tokens that belong to a user by user Id for a specific application by applicationId.
+    #
+    # @param user_id [string] The unique Id of the user that you want to delete all refresh tokens for.
+    # @param application_id [string] The unique Id of the application that you want to delete refresh tokens for.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    def revoke_refresh_tokens_by_user_id_for_application(user_id, application_id)
+      start.uri('/api/jwt/refresh')
+          .url_parameter('userId', user_id)
+          .url_parameter('applicationId', application_id)
+          .delete()
+          .go()
+    end
+
     #
     # Revokes a single User consent by Id.
     #

metadata

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