class BudgeaClient::ProvidersApi
Attributes
Public Class Methods
# File lib/budgea_client/api/providers_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get list of connectors
@param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse2008]
# File lib/budgea_client/api/providers_api.rb, line 27 def banks_get(opts = {}) data, _status_code, _headers = banks_get_with_http_info(opts) data end
Get list of connectors
@param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse2008
, Fixnum, Hash)>] InlineResponse2008
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 37 def banks_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.banks_get ...' end # resource path local_var_path = '/banks' # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse2008') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#banks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20010]
# File lib/budgea_client/api/providers_api.rb, line 79 def banks_id_connector_logos_get(id_connector, opts = {}) data, _status_code, _headers = banks_id_connector_logos_get_with_http_info(id_connector, opts) data end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20010
, Fixnum, Hash)>] InlineResponse20010
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 90 def banks_id_connector_logos_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.banks_id_connector_logos_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.banks_id_connector_logos_get" end # resource path local_var_path = '/banks/{id_connector}/logos'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20010') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#banks_id_connector_logos_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20010]
# File lib/budgea_client/api/providers_api.rb, line 136 def banks_id_connector_logos_main_get(id_connector, opts = {}) data, _status_code, _headers = banks_id_connector_logos_main_get_with_http_info(id_connector, opts) data end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20010
, Fixnum, Hash)>] InlineResponse20010
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 147 def banks_id_connector_logos_main_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.banks_id_connector_logos_main_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.banks_id_connector_logos_main_get" end # resource path local_var_path = '/banks/{id_connector}/logos/main'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20010') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#banks_id_connector_logos_main_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20010]
# File lib/budgea_client/api/providers_api.rb, line 193 def banks_id_connector_logos_thumbnail_get(id_connector, opts = {}) data, _status_code, _headers = banks_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts) data end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20010
, Fixnum, Hash)>] InlineResponse20010
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 204 def banks_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.banks_id_connector_logos_thumbnail_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.banks_id_connector_logos_thumbnail_get" end # resource path local_var_path = '/banks/{id_connector}/logos/thumbnail'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20010') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#banks_id_connector_logos_thumbnail_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get list of connector sources
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20011]
# File lib/budgea_client/api/providers_api.rb, line 250 def banks_id_connector_sources_get(id_connector, opts = {}) data, _status_code, _headers = banks_id_connector_sources_get_with_http_info(id_connector, opts) data end
Get list of connector sources
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20011
, Fixnum, Hash)>] InlineResponse20011
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 261 def banks_id_connector_sources_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.banks_id_connector_sources_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.banks_id_connector_sources_get" end # resource path local_var_path = '/banks/{id_connector}/sources'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20011') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#banks_id_connector_sources_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get connections without a user
@param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse2009]
# File lib/budgea_client/api/providers_api.rb, line 306 def connections_get(opts = {}) data, _status_code, _headers = connections_get_with_http_info(opts) data end
Get connections without a user
@param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse2009
, Fixnum, Hash)>] InlineResponse2009
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 316 def connections_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connections_get ...' end # resource path local_var_path = '/connections' # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse2009') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connections_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get connection logs Get logs about connections.
@param id_connection @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal date @option opts [Date] :max_date maximum date @option opts [Integer] :state state of user @option opts [String] :period period to group logs @option opts [Integer] :id_user ID of a user @option opts [Integer] :id_connection2 ID of a connection @option opts [Integer] :id_connector ID of a connector @option opts [BOOLEAN] :charged consider only logs for charged connectors @option opts [Integer] :id_source ID of a source @option opts [String] :expand @return [InlineResponse20015]
# File lib/budgea_client/api/providers_api.rb, line 369 def connections_id_connection_logs_get(id_connection, opts = {}) data, _status_code, _headers = connections_id_connection_logs_get_with_http_info(id_connection, opts) data end
Get connection logs Get logs about connections.<br><br> @param id_connection @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal date @option opts [Date] :max_date maximum date @option opts [Integer] :state state of user @option opts [String] :period period to group logs @option opts [Integer] :id_user ID of a user @option opts [Integer] :id_connection2 ID of a connection @option opts [Integer] :id_connector ID of a connector @option opts [BOOLEAN] :charged consider only logs for charged connectors @option opts [Integer] :id_source ID of a source @option opts [String] :expand @return [Array<(InlineResponse20015
, Fixnum, Hash)>] InlineResponse20015
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 391 def connections_id_connection_logs_get_with_http_info(id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connections_id_connection_logs_get ...' end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.connections_id_connection_logs_get" end # resource path local_var_path = '/connections/{id_connection}/logs'.sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil? query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil? query_params[:'id_user'] = opts[:'id_user'] if !opts[:'id_user'].nil? query_params[:'id_connection'] = opts[:'id_connection2'] if !opts[:'id_connection2'].nil? query_params[:'id_connector'] = opts[:'id_connector'] if !opts[:'id_connector'].nil? query_params[:'charged'] = opts[:'charged'] if !opts[:'charged'].nil? query_params[:'id_source'] = opts[:'id_source'] if !opts[:'id_source'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20015') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connections_id_connection_logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get connection sources
@param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20016]
# File lib/budgea_client/api/providers_api.rb, line 448 def connections_id_connection_sources_get(id_connection, opts = {}) data, _status_code, _headers = connections_id_connection_sources_get_with_http_info(id_connection, opts) data end
Get connection sources
@param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20016
, Fixnum, Hash)>] InlineResponse20016
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 459 def connections_id_connection_sources_get_with_http_info(id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connections_id_connection_sources_get ...' end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.connections_id_connection_sources_get" end # resource path local_var_path = '/connections/{id_connection}/sources'.sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20016') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connections_id_connection_sources_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Disable a connection source This will make it so the specified source will not be synchronized anymore.
@param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [ConnectionSource]
# File lib/budgea_client/api/providers_api.rb, line 506 def connections_id_connection_sources_id_source_delete(id_connection, id_source, opts = {}) data, _status_code, _headers = connections_id_connection_sources_id_source_delete_with_http_info(id_connection, id_source, opts) data end
Disable a connection source This will make it so the specified source will not be synchronized anymore.<br><br> @param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(ConnectionSource
, Fixnum, Hash)>] ConnectionSource
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 518 def connections_id_connection_sources_id_source_delete_with_http_info(id_connection, id_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connections_id_connection_sources_id_source_delete ...' end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.connections_id_connection_sources_id_source_delete" end # verify the required parameter 'id_source' is set if @api_client.config.client_side_validation && id_source.nil? fail ArgumentError, "Missing the required parameter 'id_source' when calling ProvidersApi.connections_id_connection_sources_id_source_delete" end # resource path local_var_path = '/connections/{id_connection}/sources/{id_source}'.sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_source' + '}', id_source.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectionSource') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connections_id_connection_sources_id_source_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Enable connection source This will make it so the specified source will be able to be synchronized.
@param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [ConnectionSource]
# File lib/budgea_client/api/providers_api.rb, line 569 def connections_id_connection_sources_id_source_post(id_connection, id_source, opts = {}) data, _status_code, _headers = connections_id_connection_sources_id_source_post_with_http_info(id_connection, id_source, opts) data end
Enable connection source This will make it so the specified source will be able to be synchronized.<br><br> @param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(ConnectionSource
, Fixnum, Hash)>] ConnectionSource
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 581 def connections_id_connection_sources_id_source_post_with_http_info(id_connection, id_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connections_id_connection_sources_id_source_post ...' end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.connections_id_connection_sources_id_source_post" end # verify the required parameter 'id_source' is set if @api_client.config.client_side_validation && id_source.nil? fail ArgumentError, "Missing the required parameter 'id_source' when calling ProvidersApi.connections_id_connection_sources_id_source_post" end # resource path local_var_path = '/connections/{id_connection}/sources/{id_source}'.sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_source' + '}', id_source.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'ConnectionSource') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connections_id_connection_sources_id_source_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Enable connection source This will make it so the specified source will be able to be synchronized.
@param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [ConnectionSource]
# File lib/budgea_client/api/providers_api.rb, line 632 def connections_id_connection_sources_id_source_put(id_connection, id_source, opts = {}) data, _status_code, _headers = connections_id_connection_sources_id_source_put_with_http_info(id_connection, id_source, opts) data end
Enable connection source This will make it so the specified source will be able to be synchronized.<br><br> @param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(ConnectionSource
, Fixnum, Hash)>] ConnectionSource
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 644 def connections_id_connection_sources_id_source_put_with_http_info(id_connection, id_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connections_id_connection_sources_id_source_put ...' end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.connections_id_connection_sources_id_source_put" end # verify the required parameter 'id_source' is set if @api_client.config.client_side_validation && id_source.nil? fail ArgumentError, "Missing the required parameter 'id_source' when calling ProvidersApi.connections_id_connection_sources_id_source_put" end # resource path local_var_path = '/connections/{id_connection}/sources/{id_source}'.sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_source' + '}', id_source.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectionSource') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connections_id_connection_sources_id_source_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get list of connectors
@param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20017]
# File lib/budgea_client/api/providers_api.rb, line 693 def connectors_get(opts = {}) data, _status_code, _headers = connectors_get_with_http_info(opts) data end
Get list of connectors
@param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20017
, Fixnum, Hash)>] InlineResponse20017
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 703 def connectors_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_get ...' end # resource path local_var_path = '/connectors' # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20017') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20010]
# File lib/budgea_client/api/providers_api.rb, line 745 def connectors_id_connector_logos_get(id_connector, opts = {}) data, _status_code, _headers = connectors_id_connector_logos_get_with_http_info(id_connector, opts) data end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20010
, Fixnum, Hash)>] InlineResponse20010
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 756 def connectors_id_connector_logos_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_logos_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.connectors_id_connector_logos_get" end # resource path local_var_path = '/connectors/{id_connector}/logos'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20010') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_logos_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a single Logo object.
@param id_connector @param id_logo @param [Hash] opts the optional parameters @option opts [String] :expand @return [ConnectorLogo]
# File lib/budgea_client/api/providers_api.rb, line 803 def connectors_id_connector_logos_id_logo_delete(id_connector, id_logo, opts = {}) data, _status_code, _headers = connectors_id_connector_logos_id_logo_delete_with_http_info(id_connector, id_logo, opts) data end
Delete a single Logo object.
@param id_connector @param id_logo @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(ConnectorLogo
, Fixnum, Hash)>] ConnectorLogo
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 815 def connectors_id_connector_logos_id_logo_delete_with_http_info(id_connector, id_logo, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_logos_id_logo_delete ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.connectors_id_connector_logos_id_logo_delete" end # verify the required parameter 'id_logo' is set if @api_client.config.client_side_validation && id_logo.nil? fail ArgumentError, "Missing the required parameter 'id_logo' when calling ProvidersApi.connectors_id_connector_logos_id_logo_delete" end # resource path local_var_path = '/connectors/{id_connector}/logos/{id_logo}'.sub('{' + 'id_connector' + '}', id_connector.to_s).sub('{' + 'id_logo' + '}', id_logo.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectorLogo') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_logos_id_logo_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create or Update a connector Logo. This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).
Form params: - id_file (integer): The id of the file to link with that connector.
@param id_connector @param id_logo @param [Hash] opts the optional parameters @option opts [String] :expand @return [ConnectorLogo]
# File lib/budgea_client/api/providers_api.rb, line 866 def connectors_id_connector_logos_id_logo_put(id_connector, id_logo, opts = {}) data, _status_code, _headers = connectors_id_connector_logos_id_logo_put_with_http_info(id_connector, id_logo, opts) data end
Create or Update a connector Logo. This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).<br><br>Form params: - id_file (integer): The id of the file to link with that connector.<br><br> @param id_connector @param id_logo @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(ConnectorLogo
, Fixnum, Hash)>] ConnectorLogo
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 878 def connectors_id_connector_logos_id_logo_put_with_http_info(id_connector, id_logo, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_logos_id_logo_put ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.connectors_id_connector_logos_id_logo_put" end # verify the required parameter 'id_logo' is set if @api_client.config.client_side_validation && id_logo.nil? fail ArgumentError, "Missing the required parameter 'id_logo' when calling ProvidersApi.connectors_id_connector_logos_id_logo_put" end # resource path local_var_path = '/connectors/{id_connector}/logos/{id_logo}'.sub('{' + 'id_connector' + '}', id_connector.to_s).sub('{' + 'id_logo' + '}', id_logo.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectorLogo') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_logos_id_logo_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20010]
# File lib/budgea_client/api/providers_api.rb, line 928 def connectors_id_connector_logos_main_get(id_connector, opts = {}) data, _status_code, _headers = connectors_id_connector_logos_main_get_with_http_info(id_connector, opts) data end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20010
, Fixnum, Hash)>] InlineResponse20010
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 939 def connectors_id_connector_logos_main_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_logos_main_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.connectors_id_connector_logos_main_get" end # resource path local_var_path = '/connectors/{id_connector}/logos/main'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20010') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_logos_main_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a connector Logo This endpoint creates a connector logo. You can either pass a file to as a parameter to insert and link it with the connector or pass an id_file to link a connector with an existing file. Will fail if the file is already linked with that connector.
Form params: - id_file (integer): The id of the file to link with that connector. - img (string): Path to the image to link with that connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [ConnectorLogo]
# File lib/budgea_client/api/providers_api.rb, line 985 def connectors_id_connector_logos_post(id_connector, opts = {}) data, _status_code, _headers = connectors_id_connector_logos_post_with_http_info(id_connector, opts) data end
Create a connector Logo This endpoint creates a connector logo. You can either pass a file to as a parameter to insert and link it with the connector or pass an id_file to link a connector with an existing file. Will fail if the file is already linked with that connector.<br><br>Form params: - id_file (integer): The id of the file to link with that connector. - img (string): Path to the image to link with that connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(ConnectorLogo
, Fixnum, Hash)>] ConnectorLogo
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 996 def connectors_id_connector_logos_post_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_logos_post ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.connectors_id_connector_logos_post" end # resource path local_var_path = '/connectors/{id_connector}/logos'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'ConnectorLogo') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_logos_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create or Update a connector Logo This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).
Form params: - id_file (integer): The id of the file to link with that connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [ConnectorLogo]
# File lib/budgea_client/api/providers_api.rb, line 1042 def connectors_id_connector_logos_put(id_connector, opts = {}) data, _status_code, _headers = connectors_id_connector_logos_put_with_http_info(id_connector, opts) data end
Create or Update a connector Logo This endpoint creates or update a connector logo. This logo is a mapping between a file (/file route) and a connector (/connectors route) or a provider (/providers route).<br><br>Form params: - id_file (integer): The id of the file to link with that connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(ConnectorLogo
, Fixnum, Hash)>] ConnectorLogo
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1053 def connectors_id_connector_logos_put_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_logos_put ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.connectors_id_connector_logos_put" end # resource path local_var_path = '/connectors/{id_connector}/logos'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectorLogo') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_logos_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20010]
# File lib/budgea_client/api/providers_api.rb, line 1099 def connectors_id_connector_logos_thumbnail_get(id_connector, opts = {}) data, _status_code, _headers = connectors_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts) data end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20010
, Fixnum, Hash)>] InlineResponse20010
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1110 def connectors_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_logos_thumbnail_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.connectors_id_connector_logos_thumbnail_get" end # resource path local_var_path = '/connectors/{id_connector}/logos/thumbnail'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20010') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_logos_thumbnail_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get list of connector sources
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20011]
# File lib/budgea_client/api/providers_api.rb, line 1156 def connectors_id_connector_sources_get(id_connector, opts = {}) data, _status_code, _headers = connectors_id_connector_sources_get_with_http_info(id_connector, opts) data end
Get list of connector sources
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20011
, Fixnum, Hash)>] InlineResponse20011
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1167 def connectors_id_connector_sources_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_sources_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.connectors_id_connector_sources_get" end # resource path local_var_path = '/connectors/{id_connector}/sources'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20011') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_sources_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit the provided connector source
@param id_connector @param id_source @param [Hash] opts the optional parameters @option opts [String] :auth_mechanism the authentication mechanism to use for this connector source @option opts [DateTime] :disabled to enable or disable connector source @option opts [String] :expand @return [ConnectorSource]
# File lib/budgea_client/api/providers_api.rb, line 1216 def connectors_id_connector_sources_id_source_put(id_connector, id_source, opts = {}) data, _status_code, _headers = connectors_id_connector_sources_id_source_put_with_http_info(id_connector, id_source, opts) data end
Edit the provided connector source
@param id_connector @param id_source @param [Hash] opts the optional parameters @option opts [String] :auth_mechanism the authentication mechanism to use for this connector source @option opts [DateTime] :disabled to enable or disable connector source @option opts [String] :expand @return [Array<(ConnectorSource
, Fixnum, Hash)>] ConnectorSource
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1230 def connectors_id_connector_sources_id_source_put_with_http_info(id_connector, id_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_id_connector_sources_id_source_put ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.connectors_id_connector_sources_id_source_put" end # verify the required parameter 'id_source' is set if @api_client.config.client_side_validation && id_source.nil? fail ArgumentError, "Missing the required parameter 'id_source' when calling ProvidersApi.connectors_id_connector_sources_id_source_put" end # resource path local_var_path = '/connectors/{id_connector}/sources/{id_source}'.sub('{' + 'id_connector' + '}', id_connector.to_s).sub('{' + 'id_source' + '}', id_source.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['auth_mechanism'] = opts[:'auth_mechanism'] if !opts[:'auth_mechanism'].nil? form_params['disabled'] = opts[:'disabled'] if !opts[:'disabled'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectorSource') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_id_connector_sources_id_source_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Request a new connector Send a request to add a new connector
@param name Name of the bank or provider @param login Users login @param password Users password @param [Hash] opts the optional parameters @option opts [String] :url Url of the bank @option opts [String] :email Email of the user @option opts [String] :types Type of connector, eg. banks or providers @option opts [String] :comment Optionnal comment @option opts [BOOLEAN] :sendmail if set, send an email to user @option opts [String] :expand @return [Connector]
# File lib/budgea_client/api/providers_api.rb, line 1289 def connectors_post(name, login, password, opts = {}) data, _status_code, _headers = connectors_post_with_http_info(name, login, password, opts) data end
Request a new connector Send a request to add a new connector<br><br> @param name Name of the bank or provider @param login Users login @param password Users password @param [Hash] opts the optional parameters @option opts [String] :url Url of the bank @option opts [String] :email Email of the user @option opts [String] :types Type of connector, eg. banks or providers @option opts [String] :comment Optionnal comment @option opts [BOOLEAN] :sendmail if set, send an email to user @option opts [String] :expand @return [Array<(Connector
, Fixnum, Hash)>] Connector
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1307 def connectors_post_with_http_info(name, login, password, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.connectors_post ...' end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling ProvidersApi.connectors_post" end # verify the required parameter 'login' is set if @api_client.config.client_side_validation && login.nil? fail ArgumentError, "Missing the required parameter 'login' when calling ProvidersApi.connectors_post" end # verify the required parameter 'password' is set if @api_client.config.client_side_validation && password.nil? fail ArgumentError, "Missing the required parameter 'password' when calling ProvidersApi.connectors_post" end # resource path local_var_path = '/connectors' # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['name'] = name form_params['login'] = login form_params['password'] = password form_params['url'] = opts[:'url'] if !opts[:'url'].nil? form_params['email'] = opts[:'email'] if !opts[:'email'].nil? form_params['types'] = opts[:'types'] if !opts[:'types'].nil? form_params['comment'] = opts[:'comment'] if !opts[:'comment'].nil? form_params['sendmail'] = opts[:'sendmail'] if !opts[:'sendmail'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Connector') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#connectors_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get document types
@param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20018]
# File lib/budgea_client/api/providers_api.rb, line 1368 def documenttypes_get(opts = {}) data, _status_code, _headers = documenttypes_get_with_http_info(opts) data end
Get document types
@param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20018
, Fixnum, Hash)>] InlineResponse20018
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1378 def documenttypes_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.documenttypes_get ...' end # resource path local_var_path = '/documenttypes' # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20018') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#documenttypes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document type Change value of a document type.
@param id_documenttype @param name Displayed name of document type @param attacheable If true, documents of this type can be attached to a transaction, and have amount related meta-data @param [Hash] opts the optional parameters @option opts [String] :expand @return [DocumentType]
# File lib/budgea_client/api/providers_api.rb, line 1422 def documenttypes_id_documenttype_put(id_documenttype, name, attacheable, opts = {}) data, _status_code, _headers = documenttypes_id_documenttype_put_with_http_info(id_documenttype, name, attacheable, opts) data end
Edit a document type Change value of a document type.<br><br> @param id_documenttype @param name Displayed name of document type @param attacheable If true, documents of this type can be attached to a transaction, and have amount related meta-data @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(DocumentType
, Fixnum, Hash)>] DocumentType
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1435 def documenttypes_id_documenttype_put_with_http_info(id_documenttype, name, attacheable, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.documenttypes_id_documenttype_put ...' end # verify the required parameter 'id_documenttype' is set if @api_client.config.client_side_validation && id_documenttype.nil? fail ArgumentError, "Missing the required parameter 'id_documenttype' when calling ProvidersApi.documenttypes_id_documenttype_put" end # verify the required parameter 'name' is set if @api_client.config.client_side_validation && name.nil? fail ArgumentError, "Missing the required parameter 'name' when calling ProvidersApi.documenttypes_id_documenttype_put" end # verify the required parameter 'attacheable' is set if @api_client.config.client_side_validation && attacheable.nil? fail ArgumentError, "Missing the required parameter 'attacheable' when calling ProvidersApi.documenttypes_id_documenttype_put" end # resource path local_var_path = '/documenttypes/{id_documenttype}'.sub('{' + 'id_documenttype' + '}', id_documenttype.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['name'] = name form_params['attacheable'] = attacheable # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'DocumentType') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#documenttypes_id_documenttype_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get connection logs Get logs about connections.
@param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal date @option opts [Date] :max_date maximum date @option opts [Integer] :state state of user @option opts [String] :period period to group logs @option opts [Integer] :id_user ID of a user @option opts [Integer] :id_connection ID of a connection @option opts [Integer] :id_connector ID of a connector @option opts [BOOLEAN] :charged consider only logs for charged connectors @option opts [Integer] :id_source ID of a source @option opts [String] :expand @return [InlineResponse20015]
# File lib/budgea_client/api/providers_api.rb, line 1501 def logs_get(opts = {}) data, _status_code, _headers = logs_get_with_http_info(opts) data end
Get connection logs Get logs about connections.<br><br> @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal date @option opts [Date] :max_date maximum date @option opts [Integer] :state state of user @option opts [String] :period period to group logs @option opts [Integer] :id_user ID of a user @option opts [Integer] :id_connection ID of a connection @option opts [Integer] :id_connector ID of a connector @option opts [BOOLEAN] :charged consider only logs for charged connectors @option opts [Integer] :id_source ID of a source @option opts [String] :expand @return [Array<(InlineResponse20015
, Fixnum, Hash)>] InlineResponse20015
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1522 def logs_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.logs_get ...' end # resource path local_var_path = '/logs' # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil? query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil? query_params[:'id_user'] = opts[:'id_user'] if !opts[:'id_user'].nil? query_params[:'id_connection'] = opts[:'id_connection'] if !opts[:'id_connection'].nil? query_params[:'id_connector'] = opts[:'id_connector'] if !opts[:'id_connector'].nil? query_params[:'charged'] = opts[:'charged'] if !opts[:'charged'].nil? query_params[:'id_source'] = opts[:'id_source'] if !opts[:'id_source'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20015') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.
@param file File
of the document @param [Hash] opts the optional parameters @option opts [Integer] :id_transaction Transaction
used to help OCR to find data @option opts [String] :name Name of the document @return [nil]
# File lib/budgea_client/api/providers_api.rb, line 1576 def ocr_post(file, opts = {}) ocr_post_with_http_info(file, opts) nil end
Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.<br><br> @param file File
of the document @param [Hash] opts the optional parameters @option opts [Integer] :id_transaction Transaction
used to help OCR to find data @option opts [String] :name Name of the document @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1588 def ocr_post_with_http_info(file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.ocr_post ...' end # verify the required parameter 'file' is set if @api_client.config.client_side_validation && file.nil? fail ArgumentError, "Missing the required parameter 'file' when calling ProvidersApi.ocr_post" end # resource path local_var_path = '/ocr' # query parameters query_params = {} # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['file'] = file form_params['id_transaction'] = opts[:'id_transaction'] if !opts[:'id_transaction'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#ocr_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get list of connectors
@param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20020]
# File lib/budgea_client/api/providers_api.rb, line 1634 def providers_get(opts = {}) data, _status_code, _headers = providers_get_with_http_info(opts) data end
Get list of connectors
@param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20020
, Fixnum, Hash)>] InlineResponse20020
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1644 def providers_get_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.providers_get ...' end # resource path local_var_path = '/providers' # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20020') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#providers_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20010]
# File lib/budgea_client/api/providers_api.rb, line 1686 def providers_id_connector_logos_get(id_connector, opts = {}) data, _status_code, _headers = providers_id_connector_logos_get_with_http_info(id_connector, opts) data end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20010
, Fixnum, Hash)>] InlineResponse20010
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1697 def providers_id_connector_logos_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.providers_id_connector_logos_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.providers_id_connector_logos_get" end # resource path local_var_path = '/providers/{id_connector}/logos'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20010') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#providers_id_connector_logos_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20010]
# File lib/budgea_client/api/providers_api.rb, line 1743 def providers_id_connector_logos_main_get(id_connector, opts = {}) data, _status_code, _headers = providers_id_connector_logos_main_get_with_http_info(id_connector, opts) data end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20010
, Fixnum, Hash)>] InlineResponse20010
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1754 def providers_id_connector_logos_main_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.providers_id_connector_logos_main_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.providers_id_connector_logos_main_get" end # resource path local_var_path = '/providers/{id_connector}/logos/main'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20010') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#providers_id_connector_logos_main_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20010]
# File lib/budgea_client/api/providers_api.rb, line 1800 def providers_id_connector_logos_thumbnail_get(id_connector, opts = {}) data, _status_code, _headers = providers_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts) data end
Get all links to the files associated with this connector. This endpoint returns all links to files associated with this connector.<br><br> @param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20010
, Fixnum, Hash)>] InlineResponse20010
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1811 def providers_id_connector_logos_thumbnail_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.providers_id_connector_logos_thumbnail_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.providers_id_connector_logos_thumbnail_get" end # resource path local_var_path = '/providers/{id_connector}/logos/thumbnail'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20010') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#providers_id_connector_logos_thumbnail_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get list of connector sources
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20011]
# File lib/budgea_client/api/providers_api.rb, line 1857 def providers_id_connector_sources_get(id_connector, opts = {}) data, _status_code, _headers = providers_id_connector_sources_get_with_http_info(id_connector, opts) data end
Get list of connector sources
@param id_connector @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20011
, Fixnum, Hash)>] InlineResponse20011
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1868 def providers_id_connector_sources_get_with_http_info(id_connector, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.providers_id_connector_sources_get ...' end # verify the required parameter 'id_connector' is set if @api_client.config.client_side_validation && id_connector.nil? fail ArgumentError, "Missing the required parameter 'id_connector' when calling ProvidersApi.providers_id_connector_sources_get" end # resource path local_var_path = '/providers/{id_connector}/sources'.sub('{' + 'id_connector' + '}', id_connector.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20011') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#providers_id_connector_sources_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 1916 def users_id_user_accounts_id_account_transactions_id_transaction_documents_delete(id_user, id_account, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_delete_with_http_info(id_user, id_account, id_transaction, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 1929 def users_id_user_accounts_id_account_transactions_id_transaction_documents_delete_with_http_info(id_user, id_account, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_delete" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 1994 def users_id_user_accounts_id_account_transactions_id_transaction_documents_get(id_user, id_account, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_get_with_http_info(id_user, id_account, id_transaction, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2016 def users_id_user_accounts_id_account_transactions_id_transaction_documents_get_with_http_info(id_user, id_account, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_get" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 2082 def users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete(id_user, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_account, id_transaction, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2096 def users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 2168 def users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put(id_user, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_account, id_transaction, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2193 def users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 2276 def users_id_user_accounts_id_account_transactions_id_transaction_documents_post(id_user, id_account, id_transaction, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_account, id_transaction, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2301 def users_id_user_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_account, id_transaction, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_post" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 2378 def users_id_user_accounts_id_account_transactions_id_transaction_documents_put(id_user, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_account, id_transaction, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2392 def users_id_user_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactions_id_transaction_documents_put" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 2453 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_account, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_account, id_transactions_cluster, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2466 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_account, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 2531 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_account, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_account, id_transactions_cluster, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2553 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_account, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 2619 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2633 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 2705 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2730 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 2813 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_account, id_transactions_cluster, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_account, id_transactions_cluster, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2838 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_account, id_transactions_cluster, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 2915 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_account @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2929 def users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # resource path local_var_path = '/users/{id_user}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete all connections
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :expand @return [Connection]
# File lib/budgea_client/api/providers_api.rb, line 2988 def users_id_user_connections_delete(id_user, opts = {}) data, _status_code, _headers = users_id_user_connections_delete_with_http_info(id_user, opts) data end
Delete all connections
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Connection
, Fixnum, Hash)>] Connection
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 2999 def users_id_user_connections_delete_with_http_info(id_user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_delete" end # resource path local_var_path = '/users/{id_user}/connections'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Connection') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get connections
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse2009]
# File lib/budgea_client/api/providers_api.rb, line 3045 def users_id_user_connections_get(id_user, opts = {}) data, _status_code, _headers = users_id_user_connections_get_with_http_info(id_user, opts) data end
Get connections
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse2009
, Fixnum, Hash)>] InlineResponse2009
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3056 def users_id_user_connections_get_with_http_info(id_user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_get" end # resource path local_var_path = '/users/{id_user}/connections'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse2009') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 3105 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete(id_user, id_connection, id_account, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_account, id_transaction, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3119 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 3189 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get(id_user, id_connection, id_account, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_account, id_transaction, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3212 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_account, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 3283 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3298 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 3375 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3401 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 3489 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post(id_user, id_connection, id_account, id_transaction, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_account, id_transaction, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3515 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_account, id_transaction, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 3597 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3612 def users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_account, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 3678 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3692 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 3762 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3785 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 3856 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3871 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 3948 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 3974 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 4062 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_connection, id_account, id_transactions_cluster, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4088 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 4170 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_account @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4185 def users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_account, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_account' is set if @api_client.config.client_side_validation && id_account.nil? fail ArgumentError, "Missing the required parameter 'id_account' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/accounts/{id_account}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_account' + '}', id_account.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_accounts_id_account_transactionsclusters_id_transactions_cluster_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a connection. This endpoint deletes a connection and all related accounts and transactions.
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Connection]
# File lib/budgea_client/api/providers_api.rb, line 4249 def users_id_user_connections_id_connection_delete(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_delete_with_http_info(id_user, id_connection, opts) data end
Delete a connection. This endpoint deletes a connection and all related accounts and transactions.<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Connection
, Fixnum, Hash)>] Connection
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4261 def users_id_user_connections_id_connection_delete_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Connection') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 4312 def users_id_user_connections_id_connection_documents_delete(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_delete_with_http_info(id_user, id_connection, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4324 def users_id_user_connections_id_connection_documents_delete_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 4384 def users_id_user_connections_id_connection_documents_get(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_get_with_http_info(id_user, id_connection, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4405 def users_id_user_connections_id_connection_documents_get_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 4466 def users_id_user_connections_id_connection_documents_id_document_delete(id_user, id_connection, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_id_document_delete_with_http_info(id_user, id_connection, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4479 def users_id_user_connections_id_connection_documents_id_document_delete_with_http_info(id_user, id_connection, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 4546 def users_id_user_connections_id_connection_documents_id_document_put(id_user, id_connection, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_id_document_put_with_http_info(id_user, id_connection, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4570 def users_id_user_connections_id_connection_documents_id_document_put_with_http_info(id_user, id_connection, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 4648 def users_id_user_connections_id_connection_documents_post(id_user, id_connection, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_post_with_http_info(id_user, id_connection, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4672 def users_id_user_connections_id_connection_documents_post_with_http_info(id_user, id_connection, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_connections_id_connection_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 4744 def users_id_user_connections_id_connection_documents_put(id_user, id_connection, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_documents_put_with_http_info(id_user, id_connection, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4757 def users_id_user_connections_id_connection_documents_put_with_http_info(id_user, id_connection, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get connection Get connection by ID @param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Connection]
# File lib/budgea_client/api/providers_api.rb, line 4813 def users_id_user_connections_id_connection_get(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_get_with_http_info(id_user, id_connection, opts) data end
Get connection Get connection by ID @param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Connection
, Fixnum, Hash)>] Connection
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4825 def users_id_user_connections_id_connection_get_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Connection') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get connection additionnal informations
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse2009]
# File lib/budgea_client/api/providers_api.rb, line 4876 def users_id_user_connections_id_connection_informations_get(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_informations_get_with_http_info(id_user, id_connection, opts) data end
Get connection additionnal informations <br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse2009
, Fixnum, Hash)>] InlineResponse2009
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4888 def users_id_user_connections_id_connection_informations_get_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_informations_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_informations_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_informations_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/informations'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse2009') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_informations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get connection logs Get logs about connections.
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal date @option opts [Date] :max_date maximum date @option opts [Integer] :state state of user @option opts [String] :period period to group logs @option opts [Integer] :id_user2 ID of a user @option opts [Integer] :id_connection2 ID of a connection @option opts [Integer] :id_connector ID of a connector @option opts [BOOLEAN] :charged consider only logs for charged connectors @option opts [Integer] :id_source ID of a source @option opts [String] :expand @return [InlineResponse20015]
# File lib/budgea_client/api/providers_api.rb, line 4950 def users_id_user_connections_id_connection_logs_get(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_logs_get_with_http_info(id_user, id_connection, opts) data end
Get connection logs Get logs about connections.<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal date @option opts [Date] :max_date maximum date @option opts [Integer] :state state of user @option opts [String] :period period to group logs @option opts [Integer] :id_user2 ID of a user @option opts [Integer] :id_connection2 ID of a connection @option opts [Integer] :id_connector ID of a connector @option opts [BOOLEAN] :charged consider only logs for charged connectors @option opts [Integer] :id_source ID of a source @option opts [String] :expand @return [Array<(InlineResponse20015
, Fixnum, Hash)>] InlineResponse20015
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 4973 def users_id_user_connections_id_connection_logs_get_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_logs_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_logs_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_logs_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/logs'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil? query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil? query_params[:'id_user'] = opts[:'id_user2'] if !opts[:'id_user2'].nil? query_params[:'id_connection'] = opts[:'id_connection2'] if !opts[:'id_connection2'].nil? query_params[:'id_connector'] = opts[:'id_connector'] if !opts[:'id_connector'].nil? query_params[:'charged'] = opts[:'charged'] if !opts[:'charged'].nil? query_params[:'id_source'] = opts[:'id_source'] if !opts[:'id_source'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20015') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a connection. Give new parameters to change on the configuration of this connection (for example "password").
It tests connection to website, and if it fails, a 400 response is given with the error code "wrongpass" or "websiteUnavailable".
You can also supply meta-parameters on connection, like 'active' or 'expire'.
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @option opts [Object] :connection @return [Connection]
# File lib/budgea_client/api/providers_api.rb, line 5036 def users_id_user_connections_id_connection_post(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_post_with_http_info(id_user, id_connection, opts) data end
Update a connection. Give new parameters to change on the configuration of this connection (for example "password").<br><br>It tests connection to website, and if it fails, a 400 response is given with the error code "wrongpass" or "websiteUnavailable".<br><br>You can also supply meta-parameters on connection, like 'active' or 'expire'.<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @option opts [Object] :connection @return [Array<(Connection
, Fixnum, Hash)>] Connection
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5049 def users_id_user_connections_id_connection_post_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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 = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'connection']) auth_names = ['api_key'] 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 => 'Connection') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Force synchronisation of a connection. We suggest to pass parameter expand=accounts to get all new and updated transactions.
Query params: - expand (string): fields to expand - last_update (dateTime): if supplied, get transactions inserted since this date
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Connection]
# File lib/budgea_client/api/providers_api.rb, line 5100 def users_id_user_connections_id_connection_put(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_put_with_http_info(id_user, id_connection, opts) data end
Force synchronisation of a connection. We suggest to pass parameter expand=accounts to get all new and updated transactions.<br><br>Query params: - expand (string): fields to expand - last_update (dateTime): if supplied, get transactions inserted since this date<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Connection
, Fixnum, Hash)>] Connection
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5112 def users_id_user_connections_id_connection_put_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Connection') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get connection sources
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [InlineResponse20016]
# File lib/budgea_client/api/providers_api.rb, line 5163 def users_id_user_connections_id_connection_sources_get(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_sources_get_with_http_info(id_user, id_connection, opts) data end
Get connection sources
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(InlineResponse20016
, Fixnum, Hash)>] InlineResponse20016
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5175 def users_id_user_connections_id_connection_sources_get_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_sources_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_sources_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_sources_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/sources'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20016') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_sources_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Disable a connection source This will make it so the specified source will not be synchronized anymore.
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [ConnectionSource]
# File lib/budgea_client/api/providers_api.rb, line 5227 def users_id_user_connections_id_connection_sources_id_source_delete(id_user, id_connection, id_source, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_sources_id_source_delete_with_http_info(id_user, id_connection, id_source, opts) data end
Disable a connection source This will make it so the specified source will not be synchronized anymore.<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(ConnectionSource
, Fixnum, Hash)>] ConnectionSource
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5240 def users_id_user_connections_id_connection_sources_id_source_delete_with_http_info(id_user, id_connection, id_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_sources_id_source_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_sources_id_source_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_sources_id_source_delete" end # verify the required parameter 'id_source' is set if @api_client.config.client_side_validation && id_source.nil? fail ArgumentError, "Missing the required parameter 'id_source' when calling ProvidersApi.users_id_user_connections_id_connection_sources_id_source_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/sources/{id_source}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_source' + '}', id_source.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectionSource') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_sources_id_source_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Enable connection source This will make it so the specified source will be able to be synchronized.
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [ConnectionSource]
# File lib/budgea_client/api/providers_api.rb, line 5296 def users_id_user_connections_id_connection_sources_id_source_post(id_user, id_connection, id_source, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_sources_id_source_post_with_http_info(id_user, id_connection, id_source, opts) data end
Enable connection source This will make it so the specified source will be able to be synchronized.<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(ConnectionSource
, Fixnum, Hash)>] ConnectionSource
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5309 def users_id_user_connections_id_connection_sources_id_source_post_with_http_info(id_user, id_connection, id_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_sources_id_source_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_sources_id_source_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_sources_id_source_post" end # verify the required parameter 'id_source' is set if @api_client.config.client_side_validation && id_source.nil? fail ArgumentError, "Missing the required parameter 'id_source' when calling ProvidersApi.users_id_user_connections_id_connection_sources_id_source_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/sources/{id_source}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_source' + '}', id_source.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'ConnectionSource') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_sources_id_source_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Enable connection source This will make it so the specified source will be able to be synchronized.
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [ConnectionSource]
# File lib/budgea_client/api/providers_api.rb, line 5365 def users_id_user_connections_id_connection_sources_id_source_put(id_user, id_connection, id_source, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_sources_id_source_put_with_http_info(id_user, id_connection, id_source, opts) data end
Enable connection source This will make it so the specified source will be able to be synchronized.<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_source @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(ConnectionSource
, Fixnum, Hash)>] ConnectionSource
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5378 def users_id_user_connections_id_connection_sources_id_source_put_with_http_info(id_user, id_connection, id_source, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_sources_id_source_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_sources_id_source_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_sources_id_source_put" end # verify the required parameter 'id_source' is set if @api_client.config.client_side_validation && id_source.nil? fail ArgumentError, "Missing the required parameter 'id_source' when calling ProvidersApi.users_id_user_connections_id_connection_sources_id_source_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/sources/{id_source}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_source' + '}', id_source.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ConnectionSource') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_sources_id_source_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a subscription. It deletes a specific subscription.
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Subscription]
# File lib/budgea_client/api/providers_api.rb, line 5434 def users_id_user_connections_id_connection_subscriptions_id_subscription_delete(id_user, id_connection, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_delete_with_http_info(id_user, id_connection, id_subscription, opts) data end
Delete a subscription. It deletes a specific subscription.<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Subscription
, Fixnum, Hash)>] Subscription
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5447 def users_id_user_connections_id_connection_subscriptions_id_subscription_delete_with_http_info(id_user, id_connection, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_delete" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Subscription') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 5503 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete(id_user, id_connection, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_connection, id_subscription, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5516 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_connection, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 5581 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get(id_user, id_connection, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_connection, id_subscription, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5603 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_connection, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 5669 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete(id_user, id_connection, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_connection, id_subscription, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5683 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 5755 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put(id_user, id_connection, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5780 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 5863 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post(id_user, id_connection, id_subscription, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_connection, id_subscription, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5888 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_connection, id_subscription, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 5965 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put(id_user, id_connection, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 5979 def users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_connection, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get subscriptions logs. Get logs of subscription.
By default, it selects logs for the last month. You can use "min_date" and "max_date" to change boundary dates.
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [String] :expand @return [InlineResponse20037]
# File lib/budgea_client/api/providers_api.rb, line 6044 def users_id_user_connections_id_connection_subscriptions_id_subscription_logs_get(id_user, id_connection, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_logs_get_with_http_info(id_user, id_connection, id_subscription, opts) data end
Get subscriptions logs. Get logs of subscription.<br><br>By default, it selects logs for the last month. You can use "min_date" and "max_date" to change boundary dates.<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [String] :expand @return [Array<(InlineResponse20037
, Fixnum, Hash)>] InlineResponse20037
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6061 def users_id_user_connections_id_connection_subscriptions_id_subscription_logs_get_with_http_info(id_user, id_connection, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_logs_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_logs_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_logs_get" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_logs_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}/logs'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20037') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a subscription It updates a specific subscription
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :name Label of the subscription @option opts [BOOLEAN] :disabled If the subscription is disabled (not synchronized) @option opts [String] :expand @return [Subscription]
# File lib/budgea_client/api/providers_api.rb, line 6123 def users_id_user_connections_id_connection_subscriptions_id_subscription_put(id_user, id_connection, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_id_subscription_put_with_http_info(id_user, id_connection, id_subscription, opts) data end
Update a subscription It updates a specific subscription<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :name Label of the subscription @option opts [BOOLEAN] :disabled If the subscription is disabled (not synchronized) @option opts [String] :expand @return [Array<(Subscription
, Fixnum, Hash)>] Subscription
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6138 def users_id_user_connections_id_connection_subscriptions_id_subscription_put_with_http_info(id_user, id_connection, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_put" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_id_subscription_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions/{id_subscription}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['name'] = opts[:'name'] if !opts[:'name'].nil? form_params['disabled'] = opts[:'disabled'] if !opts[:'disabled'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Subscription') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_id_subscription_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update many subscriptions at once
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Subscription]
# File lib/budgea_client/api/providers_api.rb, line 6195 def users_id_user_connections_id_connection_subscriptions_put(id_user, id_connection, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_subscriptions_put_with_http_info(id_user, id_connection, opts) data end
Update many subscriptions at once
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Subscription
, Fixnum, Hash)>] Subscription
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6207 def users_id_user_connections_id_connection_subscriptions_put_with_http_info(id_user, id_connection, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_subscriptions_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_subscriptions_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/subscriptions'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Subscription') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_subscriptions_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 6259 def users_id_user_connections_id_connection_transactions_id_transaction_documents_delete(id_user, id_connection, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_transaction, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6272 def users_id_user_connections_id_connection_transactions_id_transaction_documents_delete_with_http_info(id_user, id_connection, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 6337 def users_id_user_connections_id_connection_transactions_id_transaction_documents_get(id_user, id_connection, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_transaction, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6359 def users_id_user_connections_id_connection_transactions_id_transaction_documents_get_with_http_info(id_user, id_connection, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 6425 def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete(id_user, id_connection, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_transaction, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6439 def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 6511 def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put(id_user, id_connection, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6536 def users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 6619 def users_id_user_connections_id_connection_transactions_id_transaction_documents_post(id_user, id_connection, id_transaction, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_transaction, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6644 def users_id_user_connections_id_connection_transactions_id_transaction_documents_post_with_http_info(id_user, id_connection, id_transaction, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 6721 def users_id_user_connections_id_connection_transactions_id_transaction_documents_put(id_user, id_connection, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6735 def users_id_user_connections_id_connection_transactions_id_transaction_documents_put_with_http_info(id_user, id_connection, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactions_id_transaction_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 6796 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_connection, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_transactions_cluster, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6809 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 6874 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_connection, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_transactions_cluster, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6896 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_connection, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 6962 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 6976 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 7048 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7073 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 7156 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_transactions_cluster, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7181 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_connection, id_transactions_cluster, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 7258 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_connection @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7272 def users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_connection, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_connection' is set if @api_client.config.client_side_validation && id_connection.nil? fail ArgumentError, "Missing the required parameter 'id_connection' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put" end # resource path local_var_path = '/users/{id_user}/connections/{id_connection}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_connection' + '}', id_connection.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_id_connection_transactionsclusters_id_transactions_cluster_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new connection. Create a new connection to a given bank or provider. You have to give all needed parameters (use /banks/ID/fields or /providers/ID/fields to get them).
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :source optional comma-separated list of sources to use for the connection synchronization @option opts [String] :expand @option opts [Object] :connection @return [Connection]
# File lib/budgea_client/api/providers_api.rb, line 7333 def users_id_user_connections_post(id_user, opts = {}) data, _status_code, _headers = users_id_user_connections_post_with_http_info(id_user, opts) data end
Add a new connection. Create a new connection to a given bank or provider. You have to give all needed parameters (use /banks/ID/fields or /providers/ID/fields to get them).<br><br> @param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :source optional comma-separated list of sources to use for the connection synchronization @option opts [String] :expand @option opts [Object] :connection @return [Array<(Connection
, Fixnum, Hash)>] Connection
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7346 def users_id_user_connections_post_with_http_info(id_user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_connections_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_connections_post" end # resource path local_var_path = '/users/{id_user}/connections'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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 = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'connection']) auth_names = ['api_key'] 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 => 'Connection') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_connections_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 7393 def users_id_user_documents_delete(id_user, opts = {}) data, _status_code, _headers = users_id_user_documents_delete_with_http_info(id_user, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7404 def users_id_user_documents_delete_with_http_info(id_user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_documents_delete" end # resource path local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 7459 def users_id_user_documents_get(id_user, opts = {}) data, _status_code, _headers = users_id_user_documents_get_with_http_info(id_user, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7479 def users_id_user_documents_get_with_http_info(id_user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_documents_get" end # resource path local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 7535 def users_id_user_documents_id_document_delete(id_user, id_document, opts = {}) data, _status_code, _headers = users_id_user_documents_id_document_delete_with_http_info(id_user, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7547 def users_id_user_documents_id_document_delete_with_http_info(id_user, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 7609 def users_id_user_documents_id_document_put(id_user, id_document, opts = {}) data, _status_code, _headers = users_id_user_documents_id_document_put_with_http_info(id_user, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7632 def users_id_user_documents_id_document_put_with_http_info(id_user, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 7705 def users_id_user_documents_post(id_user, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_documents_post_with_http_info(id_user, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7728 def users_id_user_documents_post_with_http_info(id_user, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_documents_post" end # resource path local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 7795 def users_id_user_documents_put(id_user, id_document, opts = {}) data, _status_code, _headers = users_id_user_documents_put_with_http_info(id_user, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7807 def users_id_user_documents_put_with_http_info(id_user, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_documents_put" end # resource path local_var_path = '/users/{id_user}/documents'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get connection logs Get logs about connections.
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal date @option opts [Date] :max_date maximum date @option opts [Integer] :state state of user @option opts [String] :period period to group logs @option opts [Integer] :id_user2 ID of a user @option opts [Integer] :id_connection ID of a connection @option opts [Integer] :id_connector ID of a connector @option opts [BOOLEAN] :charged consider only logs for charged connectors @option opts [Integer] :id_source ID of a source @option opts [String] :expand @return [InlineResponse20015]
# File lib/budgea_client/api/providers_api.rb, line 7869 def users_id_user_logs_get(id_user, opts = {}) data, _status_code, _headers = users_id_user_logs_get_with_http_info(id_user, opts) data end
Get connection logs Get logs about connections.<br><br> @param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal date @option opts [Date] :max_date maximum date @option opts [Integer] :state state of user @option opts [String] :period period to group logs @option opts [Integer] :id_user2 ID of a user @option opts [Integer] :id_connection ID of a connection @option opts [Integer] :id_connector ID of a connector @option opts [BOOLEAN] :charged consider only logs for charged connectors @option opts [Integer] :id_source ID of a source @option opts [String] :expand @return [Array<(InlineResponse20015
, Fixnum, Hash)>] InlineResponse20015
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7891 def users_id_user_logs_get_with_http_info(id_user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_logs_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_logs_get" end # resource path local_var_path = '/users/{id_user}/logs'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil? query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil? query_params[:'id_user'] = opts[:'id_user2'] if !opts[:'id_user2'].nil? query_params[:'id_connection'] = opts[:'id_connection'] if !opts[:'id_connection'].nil? query_params[:'id_connector'] = opts[:'id_connector'] if !opts[:'id_connector'].nil? query_params[:'charged'] = opts[:'charged'] if !opts[:'charged'].nil? query_params[:'id_source'] = opts[:'id_source'] if !opts[:'id_source'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20015') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.
@param id_user Hint: you can use 'me' or 'all' @param file File
of the document @param [Hash] opts the optional parameters @option opts [Integer] :id_transaction Transaction
used to help OCR to find data @option opts [String] :name Name of the document @return [nil]
# File lib/budgea_client/api/providers_api.rb, line 7950 def users_id_user_ocr_post(id_user, file, opts = {}) users_id_user_ocr_post_with_http_info(id_user, file, opts) nil end
Post an image with OCR Post an image and apply OCR on it to obtain found meta-data.<br><br> @param id_user Hint: you can use 'me' or 'all' @param file File
of the document @param [Hash] opts the optional parameters @option opts [Integer] :id_transaction Transaction
used to help OCR to find data @option opts [String] :name Name of the document @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 7963 def users_id_user_ocr_post_with_http_info(id_user, file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_ocr_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_ocr_post" end # verify the required parameter 'file' is set if @api_client.config.client_side_validation && file.nil? fail ArgumentError, "Missing the required parameter 'file' when calling ProvidersApi.users_id_user_ocr_post" end # resource path local_var_path = '/users/{id_user}/ocr'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['file'] = file form_params['id_transaction'] = opts[:'id_transaction'] if !opts[:'id_transaction'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_ocr_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a subscription. It deletes a specific subscription.
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Subscription]
# File lib/budgea_client/api/providers_api.rb, line 8015 def users_id_user_subscriptions_id_subscription_delete(id_user, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_delete_with_http_info(id_user, id_subscription, opts) data end
Delete a subscription. It deletes a specific subscription.<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Subscription
, Fixnum, Hash)>] Subscription
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8027 def users_id_user_subscriptions_id_subscription_delete_with_http_info(id_user, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_delete" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_delete" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Subscription') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 8078 def users_id_user_subscriptions_id_subscription_documents_delete(id_user, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_subscription, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8090 def users_id_user_subscriptions_id_subscription_documents_delete_with_http_info(id_user, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_delete" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_delete" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 8150 def users_id_user_subscriptions_id_subscription_documents_get(id_user, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_subscription, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8171 def users_id_user_subscriptions_id_subscription_documents_get_with_http_info(id_user, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_get" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_get" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 8232 def users_id_user_subscriptions_id_subscription_documents_id_document_delete(id_user, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_subscription, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8245 def users_id_user_subscriptions_id_subscription_documents_id_document_delete_with_http_info(id_user, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 8312 def users_id_user_subscriptions_id_subscription_documents_id_document_put(id_user, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_subscription, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8336 def users_id_user_subscriptions_id_subscription_documents_id_document_put_with_http_info(id_user, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_put" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 8414 def users_id_user_subscriptions_id_subscription_documents_post(id_user, id_subscription, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_subscription, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8438 def users_id_user_subscriptions_id_subscription_documents_post_with_http_info(id_user, id_subscription, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_post" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_post" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 8510 def users_id_user_subscriptions_id_subscription_documents_put(id_user, id_subscription, id_document, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_subscription, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8523 def users_id_user_subscriptions_id_subscription_documents_put_with_http_info(id_user, id_subscription, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_put" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_documents_put" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get subscriptions logs. Get logs of subscription.
By default, it selects logs for the last month. You can use "min_date" and "max_date" to change boundary dates.
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [String] :expand @return [InlineResponse20037]
# File lib/budgea_client/api/providers_api.rb, line 8583 def users_id_user_subscriptions_id_subscription_logs_get(id_user, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_logs_get_with_http_info(id_user, id_subscription, opts) data end
Get subscriptions logs. Get logs of subscription.<br><br>By default, it selects logs for the last month. You can use "min_date" and "max_date" to change boundary dates.<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [String] :expand @return [Array<(InlineResponse20037
, Fixnum, Hash)>] InlineResponse20037
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8599 def users_id_user_subscriptions_id_subscription_logs_get_with_http_info(id_user, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_logs_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_logs_get" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_logs_get" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}/logs'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20037') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_logs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a subscription It updates a specific subscription
@param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :name Label of the subscription @option opts [BOOLEAN] :disabled If the subscription is disabled (not synchronized) @option opts [String] :expand @return [Subscription]
# File lib/budgea_client/api/providers_api.rb, line 8656 def users_id_user_subscriptions_id_subscription_put(id_user, id_subscription, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_id_subscription_put_with_http_info(id_user, id_subscription, opts) data end
Update a subscription It updates a specific subscription<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_subscription @param [Hash] opts the optional parameters @option opts [String] :name Label of the subscription @option opts [BOOLEAN] :disabled If the subscription is disabled (not synchronized) @option opts [String] :expand @return [Array<(Subscription
, Fixnum, Hash)>] Subscription
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8670 def users_id_user_subscriptions_id_subscription_put_with_http_info(id_user, id_subscription, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_id_subscription_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_put" end # verify the required parameter 'id_subscription' is set if @api_client.config.client_side_validation && id_subscription.nil? fail ArgumentError, "Missing the required parameter 'id_subscription' when calling ProvidersApi.users_id_user_subscriptions_id_subscription_put" end # resource path local_var_path = '/users/{id_user}/subscriptions/{id_subscription}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_subscription' + '}', id_subscription.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['name'] = opts[:'name'] if !opts[:'name'].nil? form_params['disabled'] = opts[:'disabled'] if !opts[:'disabled'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Subscription') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_id_subscription_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update many subscriptions at once
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :expand @return [Subscription]
# File lib/budgea_client/api/providers_api.rb, line 8722 def users_id_user_subscriptions_put(id_user, opts = {}) data, _status_code, _headers = users_id_user_subscriptions_put_with_http_info(id_user, opts) data end
Update many subscriptions at once
@param id_user Hint: you can use 'me' or 'all' @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Subscription
, Fixnum, Hash)>] Subscription
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8733 def users_id_user_subscriptions_put_with_http_info(id_user, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_subscriptions_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_subscriptions_put" end # resource path local_var_path = '/users/{id_user}/subscriptions'.sub('{' + 'id_user' + '}', id_user.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Subscription') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_subscriptions_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 8780 def users_id_user_transactions_id_transaction_documents_delete(id_user, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_delete_with_http_info(id_user, id_transaction, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8792 def users_id_user_transactions_id_transaction_documents_delete_with_http_info(id_user, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_delete" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 8852 def users_id_user_transactions_id_transaction_documents_get(id_user, id_transaction, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_get_with_http_info(id_user, id_transaction, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_transaction @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8873 def users_id_user_transactions_id_transaction_documents_get_with_http_info(id_user, id_transaction, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_get" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_get" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 8934 def users_id_user_transactions_id_transaction_documents_id_document_delete(id_user, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_transaction, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 8947 def users_id_user_transactions_id_transaction_documents_id_document_delete_with_http_info(id_user, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 9014 def users_id_user_transactions_id_transaction_documents_id_document_put(id_user, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_transaction, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 9038 def users_id_user_transactions_id_transaction_documents_id_document_put_with_http_info(id_user, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 9116 def users_id_user_transactions_id_transaction_documents_post(id_user, id_transaction, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_post_with_http_info(id_user, id_transaction, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_transaction @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 9140 def users_id_user_transactions_id_transaction_documents_post_with_http_info(id_user, id_transaction, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_post" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_post" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 9212 def users_id_user_transactions_id_transaction_documents_put(id_user, id_transaction, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactions_id_transaction_documents_put_with_http_info(id_user, id_transaction, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_transaction @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 9225 def users_id_user_transactions_id_transaction_documents_put_with_http_info(id_user, id_transaction, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactions_id_transaction_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_put" end # verify the required parameter 'id_transaction' is set if @api_client.config.client_side_validation && id_transaction.nil? fail ArgumentError, "Missing the required parameter 'id_transaction' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactions_id_transaction_documents_put" end # resource path local_var_path = '/users/{id_user}/transactions/{id_transaction}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transaction' + '}', id_transaction.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactions_id_transaction_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 9281 def users_id_user_transactionsclusters_id_transactions_cluster_documents_delete(id_user, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_transactions_cluster, opts) data end
Delete documents
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 9293 def users_id_user_transactionsclusters_id_transactions_cluster_documents_delete_with_http_info(id_user, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_delete" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get documents Get list of documents
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [InlineResponse20032]
# File lib/budgea_client/api/providers_api.rb, line 9353 def users_id_user_transactionsclusters_id_transactions_cluster_documents_get(id_user, id_transactions_cluster, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_transactions_cluster, opts) data end
Get documents Get list of documents<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param [Hash] opts the optional parameters @option opts [Integer] :limit limit number of results @option opts [Integer] :offset offset of first result @option opts [Date] :min_date minimal (inclusive) date @option opts [Date] :max_date maximum (inclusive) date @option opts [Float] :min_amount minimal (inclusive) amount @option opts [Float] :max_amount maximum (inclusive) amount @option opts [Float] :min_timestamp minimal (inclusive) timestamp @option opts [Float] :max_timestamp maximum (inclusive) timestamp @option opts [Integer] :id_type filter with a document type @option opts [String] :expand @return [Array<(InlineResponse20032
, Fixnum, Hash)>] InlineResponse20032
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 9374 def users_id_user_transactionsclusters_id_transactions_cluster_documents_get_with_http_info(id_user, id_transactions_cluster, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_get" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'min_date'] = opts[:'min_date'] if !opts[:'min_date'].nil? query_params[:'max_date'] = opts[:'max_date'] if !opts[:'max_date'].nil? query_params[:'min_amount'] = opts[:'min_amount'] if !opts[:'min_amount'].nil? query_params[:'max_amount'] = opts[:'max_amount'] if !opts[:'max_amount'].nil? query_params[:'min_timestamp'] = opts[:'min_timestamp'] if !opts[:'min_timestamp'].nil? query_params[:'max_timestamp'] = opts[:'max_timestamp'] if !opts[:'max_timestamp'].nil? query_params[:'id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20032') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 9435 def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete(id_user, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_transactions_cluster, id_document, opts) data end
Delete a document
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 9448 def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 9515 def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put(id_user, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_transactions_cluster, id_document, opts) data end
Edit a document Edit meta-data of a specific document. @param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Date] :date Date of document @option opts [Date] :duedate Due date of document @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [Integer] :income Is an income or an outcome @option opts [Integer] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 9539 def users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents/{id_document}'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s).sub('{' + 'id_document' + '}', id_document.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['date'] = opts[:'date'] if !opts[:'date'].nil? form_params['duedate'] = opts[:'duedate'] if !opts[:'duedate'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_id_document_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new document Add a new document
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 9617 def users_id_user_transactionsclusters_id_transactions_cluster_documents_post(id_user, id_transactions_cluster, date, duedate, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_transactions_cluster, date, duedate, opts) data end
Add a new document Add a new document<br><br> @param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param date Date of document @param duedate Due date of document @param [Hash] opts the optional parameters @option opts [Integer] :id_type Type of this document @option opts [Integer] :id_category Related category @option opts [Float] :total_amount Taxed amount @option opts [Float] :untaxed_amount Untaxed amount @option opts [Float] :vat VAT amount @option opts [BOOLEAN] :income Is an income or an outcome @option opts [BOOLEAN] :readonly Is this file readonly @option opts [File] :file File
of the document @option opts [Integer] :id_ocr Related OCR process @option opts [String] :name Name of the document @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 9641 def users_id_user_transactionsclusters_id_transactions_cluster_documents_post_with_http_info(id_user, id_transactions_cluster, date, duedate, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'date' is set if @api_client.config.client_side_validation && date.nil? fail ArgumentError, "Missing the required parameter 'date' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post" end # verify the required parameter 'duedate' is set if @api_client.config.client_side_validation && duedate.nil? fail ArgumentError, "Missing the required parameter 'duedate' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_post" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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(['multipart/form-data']) # form parameters form_params = {} form_params['date'] = date form_params['duedate'] = duedate form_params['id_type'] = opts[:'id_type'] if !opts[:'id_type'].nil? form_params['id_category'] = opts[:'id_category'] if !opts[:'id_category'].nil? form_params['total_amount'] = opts[:'total_amount'] if !opts[:'total_amount'].nil? form_params['untaxed_amount'] = opts[:'untaxed_amount'] if !opts[:'untaxed_amount'].nil? form_params['vat'] = opts[:'vat'] if !opts[:'vat'].nil? form_params['income'] = opts[:'income'] if !opts[:'income'].nil? form_params['readonly'] = opts[:'readonly'] if !opts[:'readonly'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['id_ocr'] = opts[:'id_ocr'] if !opts[:'id_ocr'].nil? form_params['name'] = opts[:'name'] if !opts[:'name'].nil? # http body (model) post_body = nil auth_names = ['api_key'] 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 => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Document]
# File lib/budgea_client/api/providers_api.rb, line 9713 def users_id_user_transactionsclusters_id_transactions_cluster_documents_put(id_user, id_transactions_cluster, id_document, opts = {}) data, _status_code, _headers = users_id_user_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_transactions_cluster, id_document, opts) data end
Attach an existing document to a transaction or a transactions_cluster
@param id_user Hint: you can use 'me' or 'all' @param id_transactions_cluster @param id_document id of the document you want to attach the file to @param [Hash] opts the optional parameters @option opts [String] :expand @return [Array<(Document
, Fixnum, Hash)>] Document
data, response status code and response headers
# File lib/budgea_client/api/providers_api.rb, line 9726 def users_id_user_transactionsclusters_id_transactions_cluster_documents_put_with_http_info(id_user, id_transactions_cluster, id_document, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put ...' end # verify the required parameter 'id_user' is set if @api_client.config.client_side_validation && id_user.nil? fail ArgumentError, "Missing the required parameter 'id_user' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_transactions_cluster' is set if @api_client.config.client_side_validation && id_transactions_cluster.nil? fail ArgumentError, "Missing the required parameter 'id_transactions_cluster' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put" end # verify the required parameter 'id_document' is set if @api_client.config.client_side_validation && id_document.nil? fail ArgumentError, "Missing the required parameter 'id_document' when calling ProvidersApi.users_id_user_transactionsclusters_id_transactions_cluster_documents_put" end # resource path local_var_path = '/users/{id_user}/transactionsclusters/{id_transactions_cluster}/documents'.sub('{' + 'id_user' + '}', id_user.to_s).sub('{' + 'id_transactions_cluster' + '}', id_transactions_cluster.to_s) # query parameters query_params = {} query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil? # header parameters 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/x-www-form-urlencoded']) # form parameters form_params = {} form_params['id_document'] = id_document # http body (model) post_body = nil auth_names = ['api_key'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Document') if @api_client.config.debugging @api_client.config.logger.debug "API called: ProvidersApi#users_id_user_transactionsclusters_id_transactions_cluster_documents_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end