turnkey_client 0.0.13 → 0.0.14

data/lib/turnkey_client/api/sessions_api.rb

@@ -15,8 +15,8 @@ module TurnkeyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create Read Only Session
-    # Create a read only session for a user (valid for 1 hour)
+    # Create read only session
+    # Create a read only session for a user (valid for 1 hour).
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -25,8 +25,8 @@ module TurnkeyClient
       data
     end
 
-    # Create Read Only Session
-    # Create a read only session for a user (valid for 1 hour)
+    # Create read only session
+    # Create a read only session for a user (valid for 1 hour).
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -73,8 +73,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Create Read Write Session
-    # Create a read write session for a user
+    # Create read write session
+    # Create a read write session for a user.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -83,8 +83,8 @@ module TurnkeyClient
       data
     end
 
-    # Create Read Write Session
-    # Create a read write session for a user
+    # Create read write session
+    # Create a read write session for a user.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -132,7 +132,7 @@ module TurnkeyClient
       return data, status_code, headers
     end
     # Who am I?
-    # Get basic information about your current API or WebAuthN user and their organization. Affords Sub-Organization look ups via Parent Organization for WebAuthN or API key users.
+    # Get basic information about your current API or WebAuthN user and their organization. Affords sub-organization look ups via parent organization for WebAuthN or API key users.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [GetWhoamiResponse]
@@ -142,7 +142,7 @@ module TurnkeyClient
     end
 
     # Who am I?
-    # Get basic information about your current API or WebAuthN user and their organization. Affords Sub-Organization look ups via Parent Organization for WebAuthN or API key users.
+    # Get basic information about your current API or WebAuthN user and their organization. Affords sub-organization look ups via parent organization for WebAuthN or API key users.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetWhoamiResponse, Integer, Hash)>] GetWhoamiResponse data, response status code and response headers
@@ -189,5 +189,179 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
+    # Login with Oauth
+    # Create an Oauth session for a user.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [ActivityResponse]
+    def oauth_login(body, opts = {})
+      data, _status_code, _headers = oauth_login_with_http_info(body, opts)
+      data
+    end
+
+    # Login with Oauth
+    # Create an Oauth session for a user.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
+    def oauth_login_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SessionsApi.oauth_login ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling SessionsApi.oauth_login"
+      end
+      # resource path
+      local_var_path = '/public/v1/submit/oauth_login'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      return_type = opts[:return_type] || 'ActivityResponse' 
+
+      auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SessionsApi#oauth_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Login with OTP
+    # Create an OTP session for a user.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [ActivityResponse]
+    def otp_login(body, opts = {})
+      data, _status_code, _headers = otp_login_with_http_info(body, opts)
+      data
+    end
+
+    # Login with OTP
+    # Create an OTP session for a user.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
+    def otp_login_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SessionsApi.otp_login ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling SessionsApi.otp_login"
+      end
+      # resource path
+      local_var_path = '/public/v1/submit/otp_login'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      return_type = opts[:return_type] || 'ActivityResponse' 
+
+      auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SessionsApi#otp_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Login with a stamp
+    # Create a session for a user through stamping client side (API key, wallet client, or passkey client).
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [ActivityResponse]
+    def stamp_login(body, opts = {})
+      data, _status_code, _headers = stamp_login_with_http_info(body, opts)
+      data
+    end
+
+    # Login with a stamp
+    # Create a session for a user through stamping client side (API key, wallet client, or passkey client).
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
+    def stamp_login_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SessionsApi.stamp_login ...'
+      end
+      # verify the required parameter 'body' is set
+      if @api_client.config.client_side_validation && body.nil?
+        fail ArgumentError, "Missing the required parameter 'body' when calling SessionsApi.stamp_login"
+      end
+      # resource path
+      local_var_path = '/public/v1/submit/stamp_login'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(body) 
+
+      return_type = opts[:return_type] || 'ActivityResponse' 
+
+      auth_names = opts[:auth_names] || ['ApiKeyAuth', 'AuthenticatorAuth']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type)
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SessionsApi#stamp_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/turnkey_client/api/signing_api.rb

@@ -15,8 +15,8 @@ module TurnkeyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Sign Raw Payload
-    # Sign a raw payload
+    # Sign raw payload
+    # Sign a raw payload.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -25,8 +25,8 @@ module TurnkeyClient
       data
     end
 
-    # Sign Raw Payload
-    # Sign a raw payload
+    # Sign raw payload
+    # Sign a raw payload.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -73,8 +73,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Sign Raw Payloads
-    # Sign multiple raw payloads with the same signing parameters
+    # Sign raw payloads
+    # Sign multiple raw payloads with the same signing parameters.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -83,8 +83,8 @@ module TurnkeyClient
       data
     end
 
-    # Sign Raw Payloads
-    # Sign multiple raw payloads with the same signing parameters
+    # Sign raw payloads
+    # Sign multiple raw payloads with the same signing parameters.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -131,8 +131,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Sign Transaction
-    # Sign a transaction
+    # Sign transaction
+    # Sign a transaction.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -141,8 +141,8 @@ module TurnkeyClient
       data
     end
 
-    # Sign Transaction
-    # Sign a transaction
+    # Sign transaction
+    # Sign a transaction.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers

data/lib/turnkey_client/api/user_auth_api.rb

@@ -15,8 +15,8 @@ module TurnkeyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create Oauth Providers
-    # Creates Oauth providers for a specified user - BETA
+    # Create Oauth providers
+    # Create Oauth providers for a specified user.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -25,8 +25,8 @@ module TurnkeyClient
       data
     end
 
-    # Create Oauth Providers
-    # Creates Oauth providers for a specified user - BETA
+    # Create Oauth providers
+    # Create Oauth providers for a specified user.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -73,8 +73,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Delete Oauth Providers
-    # Removes Oauth providers for a specified user - BETA
+    # Delete Oauth providers
+    # Remove Oauth providers for a specified user.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -83,8 +83,8 @@ module TurnkeyClient
       data
     end
 
-    # Delete Oauth Providers
-    # Removes Oauth providers for a specified user - BETA
+    # Delete Oauth providers
+    # Remove Oauth providers for a specified user.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -131,8 +131,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Perform Email Auth
-    # Authenticate a user via Email
+    # Perform email auth
+    # Authenticate a user via email.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -141,8 +141,8 @@ module TurnkeyClient
       data
     end
 
-    # Perform Email Auth
-    # Authenticate a user via Email
+    # Perform email auth
+    # Authenticate a user via email.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -190,7 +190,7 @@ module TurnkeyClient
       return data, status_code, headers
     end
     # Get Oauth providers
-    # Get details about Oauth providers for a user
+    # Get details about Oauth providers for a user.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [GetOauthProvidersResponse]
@@ -200,7 +200,7 @@ module TurnkeyClient
     end
 
     # Get Oauth providers
-    # Get details about Oauth providers for a user
+    # Get details about Oauth providers for a user.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetOauthProvidersResponse, Integer, Hash)>] GetOauthProvidersResponse data, response status code and response headers
@@ -248,7 +248,7 @@ module TurnkeyClient
       return data, status_code, headers
     end
     # Init OTP auth
-    # Initiate an OTP auth activity
+    # Initiate an OTP auth activity.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -258,7 +258,7 @@ module TurnkeyClient
     end
 
     # Init OTP auth
-    # Initiate an OTP auth activity
+    # Initiate an OTP auth activity.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -306,7 +306,7 @@ module TurnkeyClient
       return data, status_code, headers
     end
     # Oauth
-    # Authenticate a user with an Oidc token (Oauth) - BETA
+    # Authenticate a user with an OIDC token (Oauth).
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -316,7 +316,7 @@ module TurnkeyClient
     end
 
     # Oauth
-    # Authenticate a user with an Oidc token (Oauth) - BETA
+    # Authenticate a user with an OIDC token (Oauth).
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -364,7 +364,7 @@ module TurnkeyClient
       return data, status_code, headers
     end
     # OTP auth
-    # Authenticate a user with an OTP code sent via email or SMS
+    # Authenticate a user with an OTP code sent via email or SMS.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -374,7 +374,7 @@ module TurnkeyClient
     end
 
     # OTP auth
-    # Authenticate a user with an OTP code sent via email or SMS
+    # Authenticate a user with an OTP code sent via email or SMS.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers

data/lib/turnkey_client/api/user_recovery_api.rb

@@ -15,8 +15,8 @@ module TurnkeyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Init Email Recovery
-    # Initializes a new email recovery
+    # Init email recovery
+    # Initialize a new email recovery.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -25,8 +25,8 @@ module TurnkeyClient
       data
     end
 
-    # Init Email Recovery
-    # Initializes a new email recovery
+    # Init email recovery
+    # Initialize a new email recovery.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -74,7 +74,7 @@ module TurnkeyClient
       return data, status_code, headers
     end
     # Recover a user
-    # Completes the process of recovering a user by adding an authenticator
+    # Complete the process of recovering a user by adding an authenticator.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -84,7 +84,7 @@ module TurnkeyClient
     end
 
     # Recover a user
-    # Completes the process of recovering a user by adding an authenticator
+    # Complete the process of recovering a user by adding an authenticator.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers

data/lib/turnkey_client/api/user_tags_api.rb

@@ -15,7 +15,7 @@ module TurnkeyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create User Tag
+    # Create user tag
     # Create a user tag and add it to users.
     # @param body 
     # @param [Hash] opts the optional parameters
@@ -25,7 +25,7 @@ module TurnkeyClient
       data
     end
 
-    # Create User Tag
+    # Create user tag
     # Create a user tag and add it to users.
     # @param body 
     # @param [Hash] opts the optional parameters
@@ -73,8 +73,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Delete User Tags
-    # Delete User Tags within an Organization
+    # Delete user tags
+    # Delete user tags within an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -83,8 +83,8 @@ module TurnkeyClient
       data
     end
 
-    # Delete User Tags
-    # Delete User Tags within an Organization
+    # Delete user tags
+    # Delete user tags within an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -131,8 +131,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # List User Tags
-    # List all User Tags within an Organization
+    # List user tags
+    # List all user tags within an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ListUserTagsResponse]
@@ -141,8 +141,8 @@ module TurnkeyClient
       data
     end
 
-    # List User Tags
-    # List all User Tags within an Organization
+    # List user tags
+    # List all user tags within an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ListUserTagsResponse, Integer, Hash)>] ListUserTagsResponse data, response status code and response headers
@@ -189,7 +189,7 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Update User Tag
+    # Update user tag
     # Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.
     # @param body 
     # @param [Hash] opts the optional parameters
@@ -199,7 +199,7 @@ module TurnkeyClient
       data
     end
 
-    # Update User Tag
+    # Update user tag
     # Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.
     # @param body 
     # @param [Hash] opts the optional parameters