fusionauth_client 1.7.4 → 1.8.0.pre.RC.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d09ed3b772db0195e022fde02310254b46308ff7cece92f57d21660a0fdfd14
-  data.tar.gz: d3b1090cc099807c14f21777f47cb710e9b61e7a26100592829a8622f47095bc
+  metadata.gz: 27967872feca0c922a9b412bdf91253ac0ecfeab88bb0a8d3420fb26abd834ad
+  data.tar.gz: 51c7fd5a7f78f5d664e2d5466c32b66574226e14252e9b70a1be718d042be852
 SHA512:
-  metadata.gz: 29a5d0aff4132295cae412214dcfd3d44b6e1f9f9598eafab1e78183f948559a842b1a4607d866f17ec350b3efc25aaf65c9285e16d170293cfd59beb701c3f0
-  data.tar.gz: 51572a4fb87bfea8ec1b3df062d54ab45007975397049a40a1042546977518ad9561e1f8eebbff7e04c8796b03865c361fc904b832691ec84432239c5f852197
+  metadata.gz: 8eb200301e1bc5f1303a5cc01973b6bbbd0660ea6c7730956ea143fe2c79c418b8dd4be4db13a53149d68e41cf116b77369b089247fcea586911bdd1f26c362e
+  data.tar.gz: b86d9d43c8391881b296fdd33bd5e3cb5e99d38ae5aca5cba371d8a772bfceeaa7e4155a4aa8a1ea8c3a4d4f61b9347eb51b6d82be90a3389e0d55e50ac6aad7

data/build.savant

@@ -16,7 +16,7 @@
 savantVersion = "1.0.0"
 
 pubVersion = ""
-project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.7.4", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-ruby-client", version: "1.8.0-RC.1", 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.7.4'
+  spec.version       = '1.8.0-RC.1'
   spec.authors       = ['Brian Pontarelli', 'Daniel DeGroff']
   spec.email         = %w(brian@fusionauth.io daniel@fusionauth.io)
 

data/lib/fusionauth/fusionauth_client.rb

@@ -296,6 +296,21 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
+    #
+    # @param theme_id [string] (Optional) The Id for the theme. 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 theme.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def create_theme(theme_id, request)
+      start.uri('/api/theme')
+           .url_segment(theme_id)
+           .body_handler(FusionAuth::JSONBodyHandler.new(request))
+           .post()
+           .go()
+    end
+
     #
     # Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
     #
@@ -578,6 +593,19 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Deletes the theme for the given Id.
+    #
+    # @param theme_id [string] The Id of the theme to delete.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def delete_theme(theme_id)
+      start.uri('/api/theme')
+           .url_segment(theme_id)
+           .delete()
+           .go()
+    end
+
     #
     # Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data associated
     # with the user.
@@ -713,7 +741,7 @@ module FusionAuth
     def generate_email_verification_id(email)
       start.uri('/api/user/verify-email')
            .url_parameter('email', email)
-           .url_parameter('sendVerifyPasswordEmail', false)
+           .url_parameter('sendVerifyEmail', false)
            .put()
            .go()
     end
@@ -843,7 +871,9 @@ module FusionAuth
     end
 
     #
-    # Logs a user in.
+    # Authenticates a user to FusionAuth. 
+    # 
+    # This API optionally requires an API key. See <code>Application.loginConfiguration.requireAuthentication</code>.
     #
     # @param request [OpenStruct, Hash] The login request that contains the user credentials used to log them in.
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
@@ -993,6 +1023,20 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Request a refresh of the User search index. This API is not generally necessary and the search index will become consistent in a
+    # reasonable amount of time. There may be scenarios where you may wish to manually request an index refresh. One example may be 
+    # if you are using the Search API or Delete Tenant API immediately following a User Create etc, you may wish to request a refresh to
+    #  ensure the index immediately current before making a query request to the search index.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def refresh_user_search_index()
+      start.uri('/api/user/search')
+           .put()
+           .go()
+    end
+
     #
     # Registers a user for an application. If you provide the User and the UserRegistration object on this request, it
     # will create the user as well as register them for the application. This is called a Full Registration. However, if
@@ -1367,16 +1411,27 @@ module FusionAuth
     end
 
     #
-    # Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id. If the key Id is provided a
-    # single public key will be returned if one is found by that id. If the optional parameter key Id is not provided all
-    # public keys will be returned.
+    # Retrieves the Public Key configured for verifying JSON Web Tokens (JWT) by the key Id (kid).
     #
-    # @param key_id [string] (Optional) The Id of the public key.
+    # @param key_id [string] The Id of the public key (kid).
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     #
     def retrieve_jwt_public_key(key_id)
       start.uri('/api/jwt/public-key')
-           .url_segment(key_id)
+           .url_parameter('kid', key_id)
+           .get()
+           .go()
+    end
+
+    #
+    # Retrieves the Public Key configured for verifying the JSON Web Tokens (JWT) issued by the Login API by the Application Id.
+    #
+    # @param application_id [string] The Id of the Application for which this key is used.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_jwt_public_key_by_application_id(application_id)
+      start.uri('/api/jwt/public-key')
+           .url_parameter('applicationId', application_id)
            .get()
            .go()
     end
@@ -1504,12 +1559,30 @@ module FusionAuth
     end
 
     #
-    # Retrieves the password validation rules.
+    # Retrieves the password validation rules for a specific tenant. This method requires a tenantId to be provided 
+    # through the use of a Tenant scoped API key or an HTTP header X-FusionAuth-TenantId to specify the Tenant Id.
+    # 
+    # This API does not require an API key.
     #
     # @return [FusionAuth::ClientResponse] The ClientResponse object.
     #
     def retrieve_password_validation_rules()
-      start.uri('/api/system-configuration/password-validation-rules')
+      start.uri('/api/tenant/password-validation-rules')
+           .get()
+           .go()
+    end
+
+    #
+    # Retrieves the password validation rules for a specific tenant.
+    # 
+    # This API does not require an API key.
+    #
+    # @param tenant_id [string] The Id of the tenant.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_password_validation_rules_with_tenant_id(tenant_id)
+      start.uri('/api/tenant/password-validation-rules')
+           .url_segment(tenant_id)
            .get()
            .go()
     end
@@ -1623,6 +1696,30 @@ module FusionAuth
            .go()
     end
 
+    #
+    # Retrieves the theme for the given Id.
+    #
+    # @param theme_id [string] The Id of the theme.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_theme(theme_id)
+      start.uri('/api/theme')
+           .url_segment(theme_id)
+           .get()
+           .go()
+    end
+
+    #
+    # Retrieves all of the themes.
+    #
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def retrieve_themes()
+      start.uri('/api/theme')
+           .get()
+           .go()
+    end
+
     #
     # Retrieves the totals report. This contains all of the total counts for each application and the global registration
     # count.
@@ -2255,6 +2352,21 @@ module FusionAuth
            .go()
     end
 
+    #
+    # 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.
+    # @return [FusionAuth::ClientResponse] The ClientResponse object.
+    #
+    def update_theme(theme_id, request)
+      start.uri('/api/theme')
+           .url_segment(theme_id)
+           .body_handler(FusionAuth::JSONBodyHandler.new(request))
+           .put()
+           .go()
+    end
+
     #
     # Updates the user with the given Id.
     #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fusionauth_client
 version: !ruby/object:Gem::Version
-  version: 1.7.4
+  version: 1.8.0.pre.RC.1
 platform: ruby
 authors:
 - Brian Pontarelli
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-22 00:00:00.000000000 Z
+date: 2019-09-08 00:00:00.000000000 Z
 dependencies: []
 description: This library contains the Ruby client library that helps you connect
   your application to FusionAuth.
@@ -47,9 +47,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.2
 signing_key: