turnkey_client 0.0.13 → 0.0.14

data/lib/turnkey_client/api/user_verification_api.rb

@@ -0,0 +1,135 @@
+=begin
+#API Reference
+
+#Review our [API Introduction](../api-introduction) to get started.
+
+OpenAPI spec version: 1.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+=end
+
+module TurnkeyClient
+  class UserVerificationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Init generic OTP
+    # Initiate a generic OTP activity.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [ActivityResponse]
+    def init_otp(body, opts = {})
+      data, _status_code, _headers = init_otp_with_http_info(body, opts)
+      data
+    end
+
+    # Init generic OTP
+    # Initiate a generic OTP activity.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
+    def init_otp_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserVerificationApi.init_otp ...'
+      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 UserVerificationApi.init_otp"
+      end
+      # resource path
+      local_var_path = '/public/v1/submit/init_otp'
+
+      # 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: UserVerificationApi#init_otp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Verify generic OTP
+    # Verify a generic OTP.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [ActivityResponse]
+    def verify_otp(body, opts = {})
+      data, _status_code, _headers = verify_otp_with_http_info(body, opts)
+      data
+    end
+
+    # Verify generic OTP
+    # Verify a generic OTP.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
+    def verify_otp_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UserVerificationApi.verify_otp ...'
+      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 UserVerificationApi.verify_otp"
+      end
+      # resource path
+      local_var_path = '/public/v1/submit/verify_otp'
+
+      # 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: UserVerificationApi#verify_otp\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/turnkey_client/api/users_api.rb

@@ -15,8 +15,8 @@ module TurnkeyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create Users
-    # Create Users in an existing Organization
+    # Create users
+    # Create users in an existing organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -25,8 +25,8 @@ module TurnkeyClient
       data
     end
 
-    # Create Users
-    # Create Users in an existing Organization
+    # Create users
+    # Create users in an existing organization.
     # @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 Users
-    # Delete Users within an Organization
+    # Delete users
+    # Delete users within an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -83,8 +83,8 @@ module TurnkeyClient
       data
     end
 
-    # Delete Users
-    # Delete Users within an Organization
+    # Delete users
+    # Delete users 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
-    # Get User
-    # Get details about a User
+    # Get user
+    # Get details about a user.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [GetUserResponse]
@@ -141,8 +141,8 @@ module TurnkeyClient
       data
     end
 
-    # Get User
-    # Get details about a User
+    # Get user
+    # Get details about a user.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetUserResponse, Integer, Hash)>] GetUserResponse data, response status code and response headers
@@ -189,8 +189,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # List Users
-    # List all Users within an Organization
+    # List users
+    # List all users within an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [GetUsersResponse]
@@ -199,8 +199,8 @@ module TurnkeyClient
       data
     end
 
-    # List Users
-    # List all Users within an Organization
+    # List users
+    # List all users within an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetUsersResponse, Integer, Hash)>] GetUsersResponse data, response status code and response headers
@@ -247,8 +247,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Update User
-    # Update a User in an existing Organization
+    # Update user
+    # Update a user in an existing organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -257,8 +257,8 @@ module TurnkeyClient
       data
     end
 
-    # Update User
-    # Update a User in an existing Organization
+    # Update user
+    # Update a user in an existing organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -305,5 +305,179 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
+    # Update user's email
+    # Update a user's email in an existing organization.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [ActivityResponse]
+    def update_user_email(body, opts = {})
+      data, _status_code, _headers = update_user_email_with_http_info(body, opts)
+      data
+    end
+
+    # Update user&#x27;s email
+    # Update a user&#x27;s email in an existing organization.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
+    def update_user_email_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.update_user_email ...'
+      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 UsersApi.update_user_email"
+      end
+      # resource path
+      local_var_path = '/public/v1/submit/update_user_email'
+
+      # 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: UsersApi#update_user_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Update user's name
+    # Update a user's name in an existing organization.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [ActivityResponse]
+    def update_user_name(body, opts = {})
+      data, _status_code, _headers = update_user_name_with_http_info(body, opts)
+      data
+    end
+
+    # Update user&#x27;s name
+    # Update a user&#x27;s name in an existing organization.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
+    def update_user_name_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.update_user_name ...'
+      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 UsersApi.update_user_name"
+      end
+      # resource path
+      local_var_path = '/public/v1/submit/update_user_name'
+
+      # 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: UsersApi#update_user_name\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Update user's phone number
+    # Update a user's phone number in an existing organization.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [ActivityResponse]
+    def update_user_phone_number(body, opts = {})
+      data, _status_code, _headers = update_user_phone_number_with_http_info(body, opts)
+      data
+    end
+
+    # Update user&#x27;s phone number
+    # Update a user&#x27;s phone number in an existing organization.
+    # @param body 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
+    def update_user_phone_number_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.update_user_phone_number ...'
+      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 UsersApi.update_user_phone_number"
+      end
+      # resource path
+      local_var_path = '/public/v1/submit/update_user_phone_number'
+
+      # 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: UsersApi#update_user_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/turnkey_client/api/wallets_api.rb

@@ -15,8 +15,8 @@ module TurnkeyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create Wallet
-    # Create a Wallet and derive addresses
+    # Create wallet
+    # Create a wallet and derive addresses.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -25,8 +25,8 @@ module TurnkeyClient
       data
     end
 
-    # Create Wallet
-    # Create a Wallet and derive addresses
+    # Create wallet
+    # Create a wallet and derive addresses.
     # @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 Wallet Accounts
-    # Derive additional addresses using an existing wallet
+    # Create wallet accounts
+    # Derive additional addresses using an existing wallet.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -83,8 +83,8 @@ module TurnkeyClient
       data
     end
 
-    # Create Wallet Accounts
-    # Derive additional addresses using an existing wallet
+    # Create wallet accounts
+    # Derive additional addresses using an existing wallet.
     # @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
-    # Delete Wallets
-    # Deletes wallets for an organization
+    # Delete wallets
+    # Delete wallets for an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -141,8 +141,8 @@ module TurnkeyClient
       data
     end
 
-    # Delete Wallets
-    # Deletes wallets for an organization
+    # Delete wallets
+    # Delete wallets for an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -189,8 +189,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Export Wallet
-    # Exports a Wallet
+    # Export wallet
+    # Export a wallet.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -199,8 +199,8 @@ module TurnkeyClient
       data
     end
 
-    # Export Wallet
-    # Exports a Wallet
+    # Export wallet
+    # Export a wallet.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -247,8 +247,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Export Wallet Account
-    # Exports a Wallet Account
+    # Export wallet account
+    # Export a wallet account.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -257,8 +257,8 @@ module TurnkeyClient
       data
     end
 
-    # Export Wallet Account
-    # Exports a Wallet Account
+    # Export wallet account
+    # Export a wallet account.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -305,8 +305,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Get Wallet
-    # Get details about a Wallet
+    # Get wallet
+    # Get details about a wallet.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [GetWalletResponse]
@@ -315,8 +315,8 @@ module TurnkeyClient
       data
     end
 
-    # Get Wallet
-    # Get details about a Wallet
+    # Get wallet
+    # Get details about a wallet.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetWalletResponse, Integer, Hash)>] GetWalletResponse data, response status code and response headers
@@ -363,8 +363,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Get Wallet Account
-    # Get a single wallet account
+    # Get wallet account
+    # Get a single wallet account.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [GetWalletAccountResponse]
@@ -373,8 +373,8 @@ module TurnkeyClient
       data
     end
 
-    # Get Wallet Account
-    # Get a single wallet account
+    # Get wallet account
+    # Get a single wallet account.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetWalletAccountResponse, Integer, Hash)>] GetWalletAccountResponse data, response status code and response headers
@@ -421,8 +421,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # List Wallets Accounts
-    # List all Accounts within a Wallet
+    # List wallets accounts
+    # List all accounts within a wallet.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [GetWalletAccountsResponse]
@@ -431,8 +431,8 @@ module TurnkeyClient
       data
     end
 
-    # List Wallets Accounts
-    # List all Accounts within a Wallet
+    # List wallets accounts
+    # List all accounts within a wallet.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetWalletAccountsResponse, Integer, Hash)>] GetWalletAccountsResponse data, response status code and response headers
@@ -479,8 +479,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # List Wallets
-    # List all Wallets within an Organization
+    # List wallets
+    # List all wallets within an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [GetWalletsResponse]
@@ -489,8 +489,8 @@ module TurnkeyClient
       data
     end
 
-    # List Wallets
-    # List all Wallets within an Organization
+    # List wallets
+    # List all wallets within an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetWalletsResponse, Integer, Hash)>] GetWalletsResponse data, response status code and response headers
@@ -537,8 +537,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Import Wallet
-    # Imports a wallet
+    # Import wallet
+    # Import a wallet.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -547,8 +547,8 @@ module TurnkeyClient
       data
     end
 
-    # Import Wallet
-    # Imports a wallet
+    # Import wallet
+    # Import a wallet.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -595,8 +595,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Init Import Wallet
-    # Initializes a new wallet import
+    # Init import wallet
+    # Initialize a new wallet import.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -605,8 +605,8 @@ module TurnkeyClient
       data
     end
 
-    # Init Import Wallet
-    # Initializes a new wallet import
+    # Init import wallet
+    # Initialize a new wallet import.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers
@@ -653,8 +653,8 @@ module TurnkeyClient
       end
       return data, status_code, headers
     end
-    # Update Wallet
-    # Update a wallet for an organization
+    # Update wallet
+    # Update a wallet for an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [ActivityResponse]
@@ -663,8 +663,8 @@ module TurnkeyClient
       data
     end
 
-    # Update Wallet
-    # Update a wallet for an organization
+    # Update wallet
+    # Update a wallet for an organization.
     # @param body 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ActivityResponse, Integer, Hash)>] ActivityResponse data, response status code and response headers