checkbook 1.0.1

data/lib/checkbook/api/user.rb

@@ -0,0 +1,687 @@
+=begin
+#Checkbook API
+
+#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@checkbook.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'cgi'
+
+module Checkbook
+  class User
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete API key for user
+    # Delete API key for user
+    # @param key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_api_key(key_id, opts = {})
+      delete_api_key_with_http_info(key_id, opts)
+      nil
+    end
+
+    # Delete API key for user
+    # Delete API key for user
+    # @param key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_api_key_with_http_info(key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: User.delete_api_key ...'
+      end
+      # verify the required parameter 'key_id' is set
+      if @api_client.config.client_side_validation && key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'key_id' when calling User.delete_api_key"
+      end
+      # resource path
+      local_var_path = '/v3/user/api_key/{key_id}'.sub('{' + 'key_id' + '}', CGI.escape(key_id.to_s))
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"User.delete_api_key",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: User#delete_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Remove marketplace user
+    # Delete a marketplace user.  > [!NOTE] > **Tip**   > The id that gets passed in needs to be the Checkbook system generated `id`, not the `user_id`.  > Users with active transactions may not be deleted.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_user(id, opts = {})
+      delete_user_with_http_info(id, opts)
+      nil
+    end
+
+    # Remove marketplace user
+    # Delete a marketplace user.  &gt; [!NOTE] &gt; **Tip**   &gt; The id that gets passed in needs to be the Checkbook system generated &#x60;id&#x60;, not the &#x60;user_id&#x60;.  &gt; Users with active transactions may not be deleted.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_user_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: User.delete_user ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling User.delete_user"
+      end
+      # resource path
+      local_var_path = '/v3/user/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"User.delete_user",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: User#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get API keys for user
+    # Return the API keys for the user
+    # @param [Hash] opts the optional parameters
+    # @return [APIKeyListResponse]
+    def get_api_keys(opts = {})
+      data, _status_code, _headers = get_api_keys_with_http_info(opts)
+      data
+    end
+
+    # Get API keys for user
+    # Return the API keys for the user
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(APIKeyListResponse, Integer, Hash)>] APIKeyListResponse data, response status code and response headers
+    def get_api_keys_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: User.get_api_keys ...'
+      end
+      # resource path
+      local_var_path = '/v3/user/api_key'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'APIKeyListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"User.get_api_keys",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: User#get_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get user details
+    # Get user information
+    # @param [Hash] opts the optional parameters
+    # @return [GetUserResponse]
+    def get_user(opts = {})
+      data, _status_code, _headers = get_user_with_http_info(opts)
+      data
+    end
+
+    # Get user details
+    # Get user information
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetUserResponse, Integer, Hash)>] GetUserResponse data, response status code and response headers
+    def get_user_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: User.get_user ...'
+      end
+      # resource path
+      local_var_path = '/v3/user'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetUserResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"User.get_user",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: User#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get marketplace users
+    # Return the marketplace users
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (default to 1)
+    # @option opts [Integer] :per_page Items per page (default to 50)
+    # @option opts [String] :q Query
+    # @option opts [String] :sort Sort
+    # @return [UserQueryResponse]
+    def get_users(opts = {})
+      data, _status_code, _headers = get_users_with_http_info(opts)
+      data
+    end
+
+    # Get marketplace users
+    # Return the marketplace users
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (default to 1)
+    # @option opts [Integer] :per_page Items per page (default to 50)
+    # @option opts [String] :q Query
+    # @option opts [String] :sort Sort
+    # @return [Array<(UserQueryResponse, Integer, Hash)>] UserQueryResponse data, response status code and response headers
+    def get_users_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: User.get_users ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling User.get_users, must be greater than or equal to 1.'
+      end
+
+      allowable_values = [10, 25, 50, 100, 250]
+      if @api_client.config.client_side_validation && opts[:'per_page'] && !allowable_values.include?(opts[:'per_page'])
+        fail ArgumentError, "invalid value for \"per_page\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'q'].nil? && opts[:'q'].to_s.length > 180
+        fail ArgumentError, 'invalid value for "opts[:"q"]" when calling User.get_users, the character length must be smaller than or equal to 180.'
+      end
+
+      allowable_values = ["+DATE", "-DATE", "+USER_ID", "-USER_ID"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v3/user/list'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UserQueryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"User.get_users",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: User#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Generate new API Key for user
+    # Generate new API keys for the user
+    # @param new_api_key_request [NewApiKeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [NewApiKeyResponse]
+    def new_api_key(new_api_key_request, opts = {})
+      data, _status_code, _headers = new_api_key_with_http_info(new_api_key_request, opts)
+      data
+    end
+
+    # Generate new API Key for user
+    # Generate new API keys for the user
+    # @param new_api_key_request [NewApiKeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NewApiKeyResponse, Integer, Hash)>] NewApiKeyResponse data, response status code and response headers
+    def new_api_key_with_http_info(new_api_key_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: User.new_api_key ...'
+      end
+      # verify the required parameter 'new_api_key_request' is set
+      if @api_client.config.client_side_validation && new_api_key_request.nil?
+        fail ArgumentError, "Missing the required parameter 'new_api_key_request' when calling User.new_api_key"
+      end
+      # resource path
+      local_var_path = '/v3/user/api_key'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(new_api_key_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'NewApiKeyResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"User.new_api_key",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: User#new_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create user
+    # Create a new marketplace user.   > [!NOTE] > **Common Errors** > > - **`403: FORBIDDEN`**: Please ensure you are using the Marketplace Owner's keys. If the `403` error persists, it may indicate that marketplace is not enabled for your account or you do not have an active billing bank account onboarded. Contact support@checkbook.io for more details.
+    # @param create_user_request [CreateUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateUserResponse]
+    def post_user(create_user_request, opts = {})
+      data, _status_code, _headers = post_user_with_http_info(create_user_request, opts)
+      data
+    end
+
+    # Create user
+    # Create a new marketplace user.   &gt; [!NOTE] &gt; **Common Errors** &gt; &gt; - **&#x60;403: FORBIDDEN&#x60;**: Please ensure you are using the Marketplace Owner&#39;s keys. If the &#x60;403&#x60; error persists, it may indicate that marketplace is not enabled for your account or you do not have an active billing bank account onboarded. Contact support@checkbook.io for more details.
+    # @param create_user_request [CreateUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateUserResponse, Integer, Hash)>] CreateUserResponse data, response status code and response headers
+    def post_user_with_http_info(create_user_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: User.post_user ...'
+      end
+      # verify the required parameter 'create_user_request' is set
+      if @api_client.config.client_side_validation && create_user_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_user_request' when calling User.post_user"
+      end
+      # resource path
+      local_var_path = '/v3/user'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_user_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateUserResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"User.post_user",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: User#post_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Add signature for user
+    # Add signature
+    # @param signature_request [SignatureRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def post_user_signature(signature_request, opts = {})
+      post_user_signature_with_http_info(signature_request, opts)
+      nil
+    end
+
+    # Add signature for user
+    # Add signature
+    # @param signature_request [SignatureRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_user_signature_with_http_info(signature_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: User.post_user_signature ...'
+      end
+      # verify the required parameter 'signature_request' is set
+      if @api_client.config.client_side_validation && signature_request.nil?
+        fail ArgumentError, "Missing the required parameter 'signature_request' when calling User.post_user_signature"
+      end
+      # resource path
+      local_var_path = '/v3/user/signature'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(signature_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"User.post_user_signature",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: User#post_user_signature\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update user
+    # Update existing user information.   > [!NOTE] > **Note**   > This endpoint is used for updating a user's KYB/KYC information. Checkbook validates this information asynchronously.
+    # @param update_user_request [UpdateUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def put_user(update_user_request, opts = {})
+      put_user_with_http_info(update_user_request, opts)
+      nil
+    end
+
+    # Update user
+    # Update existing user information.   &gt; [!NOTE] &gt; **Note**   &gt; This endpoint is used for updating a user&#39;s KYB/KYC information. Checkbook validates this information asynchronously.
+    # @param update_user_request [UpdateUserRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def put_user_with_http_info(update_user_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: User.put_user ...'
+      end
+      # verify the required parameter 'update_user_request' is set
+      if @api_client.config.client_side_validation && update_user_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_user_request' when calling User.put_user"
+      end
+      # resource path
+      local_var_path = '/v3/user'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_user_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"User.put_user",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: User#put_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a sandbox user status
+    # Update a user's status in the sandbox environment.
+    # @param trigger_user_webhook_request [TriggerUserWebhookRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def put_user_webhook(trigger_user_webhook_request, opts = {})
+      put_user_webhook_with_http_info(trigger_user_webhook_request, opts)
+      nil
+    end
+
+    # Update a sandbox user status
+    # Update a user&#39;s status in the sandbox environment.
+    # @param trigger_user_webhook_request [TriggerUserWebhookRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def put_user_webhook_with_http_info(trigger_user_webhook_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: User.put_user_webhook ...'
+      end
+      # verify the required parameter 'trigger_user_webhook_request' is set
+      if @api_client.config.client_side_validation && trigger_user_webhook_request.nil?
+        fail ArgumentError, "Missing the required parameter 'trigger_user_webhook_request' when calling User.put_user_webhook"
+      end
+      # resource path
+      local_var_path = '/v3/user/webhook'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(trigger_user_webhook_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"User.put_user_webhook",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: User#put_user_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end