class PostFinanceCheckout::ChargeFlowService
Attributes
Public Class Methods
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 24 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
applyFlow
@param space_id @param id The transaction id of the transaction which should be process asynchronously. @param [Hash] opts the optional parameters @return [Transaction]
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 34 def apply_flow(space_id, id, opts = {}) data, _status_code, _headers = apply_flow_with_http_info(space_id, id, opts) return data end
applyFlow
@param space_id @param id The transaction id of the transaction which should be process asynchronously. @param [Hash] opts the optional parameters @return [Array<(Transaction
, Fixnum, Hash)>] Transaction
data, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 45 def apply_flow_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ChargeFlowService.apply_flow ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ChargeFlowService.apply_flow" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling ChargeFlowService.apply_flow" if id.nil? # resource path local_var_path = "/charge-flow/applyFlow".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'id'] = id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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 => 'Transaction') if @api_client.config.debugging @api_client.config.logger.debug "API called: ChargeFlowService#apply_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Count Counts the number of items in the database as restricted by the given filter. @param space_id @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Integer]
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 97 def count(space_id, opts = {}) data, _status_code, _headers = count_with_http_info(space_id, opts) return data end
Count Counts the number of items in the database as restricted by the given filter. @param space_id @param [Hash] opts the optional parameters @option opts [EntityQueryFilter] :filter The filter which restricts the entities which are used to calculate the count. @return [Array<(Integer, Fixnum, Hash)>] Integer data, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 108 def count_with_http_info(space_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ChargeFlowService.count ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ChargeFlowService.count" if space_id.nil? # resource path local_var_path = "/charge-flow/count".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json;charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'filter']) auth_names = [] 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 => 'Integer') if @api_client.config.debugging @api_client.config.logger.debug "API called: ChargeFlowService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Read Reads the entity with the given 'id' and returns it. @param space_id @param id The id of the charge flow which should be returned. @param [Hash] opts the optional parameters @return [ChargeFlow]
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 157 def read(space_id, id, opts = {}) data, _status_code, _headers = read_with_http_info(space_id, id, opts) return data end
Read Reads the entity with the given 'id' and returns it. @param space_id @param id The id of the charge flow which should be returned. @param [Hash] opts the optional parameters @return [Array<(ChargeFlow
, Fixnum, Hash)>] ChargeFlow
data, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 168 def read_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ChargeFlowService.read ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ChargeFlowService.read" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling ChargeFlowService.read" if id.nil? # resource path local_var_path = "/charge-flow/read".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'id'] = id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['*/*'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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 => 'ChargeFlow') if @api_client.config.debugging @api_client.config.logger.debug "API called: ChargeFlowService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Search Searches for the entities as specified by the given query. @param space_id @param query The query restricts the charge flows which are returned by the search. @param [Hash] opts the optional parameters @return [Array<ChargeFlow>]
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 220 def search(space_id, query, opts = {}) data, _status_code, _headers = search_with_http_info(space_id, query, opts) return data end
Search Searches for the entities as specified by the given query. @param space_id @param query The query restricts the charge flows which are returned by the search. @param [Hash] opts the optional parameters @return [Array<(Array<ChargeFlow>, Fixnum, Hash)>] Array<ChargeFlow> data, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 231 def search_with_http_info(space_id, query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ChargeFlowService.search ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ChargeFlowService.search" if space_id.nil? # verify the required parameter 'query' is set fail ArgumentError, "Missing the required parameter 'query' when calling ChargeFlowService.search" if query.nil? # resource path local_var_path = "/charge-flow/search".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json;charset=utf-8'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(query) auth_names = [] 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 => 'Array<ChargeFlow>') if @api_client.config.debugging @api_client.config.logger.debug "API called: ChargeFlowService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
updateRecipient
@param space_id @param transaction_id The transaction id of the transaction whose recipient should be updated. @param type The id of the charge flow configuration type to recipient should be updated for. @param recipient The recipient address that should be used to send the payment URL. @param [Hash] opts the optional parameters @return [nil]
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 284 def update_recipient(space_id, transaction_id, type, recipient, opts = {}) update_recipient_with_http_info(space_id, transaction_id, type, recipient, opts) return nil end
updateRecipient
@param space_id @param transaction_id The transaction id of the transaction whose recipient should be updated. @param type The id of the charge flow configuration type to recipient should be updated for. @param recipient The recipient address that should be used to send the payment URL. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb, line 297 def update_recipient_with_http_info(space_id, transaction_id, type, recipient, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ChargeFlowService.update_recipient ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ChargeFlowService.update_recipient" if space_id.nil? # verify the required parameter 'transaction_id' is set fail ArgumentError, "Missing the required parameter 'transaction_id' when calling ChargeFlowService.update_recipient" if transaction_id.nil? # verify the required parameter 'type' is set fail ArgumentError, "Missing the required parameter 'type' when calling ChargeFlowService.update_recipient" if type.nil? # verify the required parameter 'recipient' is set fail ArgumentError, "Missing the required parameter 'recipient' when calling ChargeFlowService.update_recipient" if recipient.nil? # resource path local_var_path = "/charge-flow/updateRecipient".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'transactionId'] = transaction_id query_params[:'type'] = type query_params[:'recipient'] = recipient # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json;charset=utf-8'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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: ChargeFlowService#update_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end