Class: PostFinanceCheckout::ChargeFlowService
- Inherits:
-
Object
- Object
- PostFinanceCheckout::ChargeFlowService
- Defined in:
- lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#apply_flow(space_id, id, opts = {}) ⇒ Transaction
applyFlow.
-
#apply_flow_with_http_info(space_id, id, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>
Transaction data, response status code and response headers.
-
#cancel_charge_flow(space_id, id, opts = {}) ⇒ Transaction
Cancel Charge Flow This operation cancels the charge flow that is linked with the transaction indicated by the given ID.
-
#cancel_charge_flow_with_http_info(space_id, id, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>
Transaction data, response status code and response headers.
-
#count(space_id, opts = {}) ⇒ Integer
Count Counts the number of items in the database as restricted by the given filter.
-
#count_with_http_info(space_id, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>
Integer data, response status code and response headers.
-
#fetch_charge_flow_payment_page_url(space_id, id, opts = {}) ⇒ String
Fetch Charge Flow Payment Page URL This operation allows to fetch the payment page URL that is been applied on the charge flow linked with the provided transaction.
-
#fetch_charge_flow_payment_page_url_with_http_info(space_id, id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
String data, response status code and response headers.
-
#initialize(api_client = ApiClient.default) ⇒ ChargeFlowService
constructor
A new instance of ChargeFlowService.
-
#read(space_id, id, opts = {}) ⇒ ChargeFlow
Read Reads the entity with the given ‘id’ and returns it.
-
#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(ChargeFlow, Fixnum, Hash)>
ChargeFlow data, response status code and response headers.
-
#search(space_id, query, opts = {}) ⇒ Array<ChargeFlow>
Search Searches for the entities as specified by the given query.
-
#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<ChargeFlow>, Fixnum, Hash)>
Array<ChargeFlow> data, response status code and response headers.
-
#update_recipient(space_id, transaction_id, type, recipient, opts = {}) ⇒ nil
updateRecipient.
-
#update_recipient_with_http_info(space_id, transaction_id, type, recipient, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Nil, response status code and response headers.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ChargeFlowService
Returns a new instance of ChargeFlowService.
24 25 26 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 24 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
22 23 24 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 22 def api_client @api_client end |
Instance Method Details
#apply_flow(space_id, id, opts = {}) ⇒ Transaction
applyFlow
34 35 36 37 |
# 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 |
#apply_flow_with_http_info(space_id, id, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>
Returns Transaction data, response status code and response headers.
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 46 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 = {} # connection timeout timeout = @api_client.get_connection_timeout() # 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, :timeout => timeout, :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 |
#cancel_charge_flow(space_id, id, opts = {}) ⇒ Transaction
Cancel Charge Flow This operation cancels the charge flow that is linked with the transaction indicated by the given ID.
102 103 104 105 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 102 def cancel_charge_flow(space_id, id, opts = {}) data, _status_code, _headers = cancel_charge_flow_with_http_info(space_id, id, opts) return data end |
#cancel_charge_flow_with_http_info(space_id, id, opts = {}) ⇒ Array<(Transaction, Fixnum, Hash)>
Returns Transaction data, response status code and response headers.
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 114 def cancel_charge_flow_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ChargeFlowService.cancel_charge_flow ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ChargeFlowService.cancel_charge_flow" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling ChargeFlowService.cancel_charge_flow" if id.nil? # resource path local_var_path = "/charge-flow/cancel-charge-flow".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'] 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 = {} # connection timeout timeout = @api_client.get_connection_timeout() # 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, :timeout => timeout, :auth_names => auth_names, :return_type => 'Transaction') if @api_client.config.debugging @api_client.config.logger.debug "API called: ChargeFlowService#cancel_charge_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#count(space_id, opts = {}) ⇒ Integer
Count Counts the number of items in the database as restricted by the given filter.
170 171 172 173 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 170 def count(space_id, opts = {}) data, _status_code, _headers = count_with_http_info(space_id, opts) return data end |
#count_with_http_info(space_id, opts = {}) ⇒ Array<(Integer, Fixnum, Hash)>
Returns Integer data, response status code and response headers.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 182 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 = {} # connection timeout timeout = @api_client.get_connection_timeout() # 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, :timeout => timeout, :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 |
#fetch_charge_flow_payment_page_url(space_id, id, opts = {}) ⇒ String
Fetch Charge Flow Payment Page URL This operation allows to fetch the payment page URL that is been applied on the charge flow linked with the provided transaction. The operation might return an empty result when no payment page is needed or can be invoked.
235 236 237 238 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 235 def fetch_charge_flow_payment_page_url(space_id, id, opts = {}) data, _status_code, _headers = fetch_charge_flow_payment_page_url_with_http_info(space_id, id, opts) return data end |
#fetch_charge_flow_payment_page_url_with_http_info(space_id, id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>
Returns String data, response status code and response headers.
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 247 def fetch_charge_flow_payment_page_url_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ChargeFlowService.fetch_charge_flow_payment_page_url ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling ChargeFlowService.fetch_charge_flow_payment_page_url" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling ChargeFlowService.fetch_charge_flow_payment_page_url" if id.nil? # resource path local_var_path = "/charge-flow/fetch-charge-flow-payment-page-url".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', 'text/plain;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 = {} # connection timeout timeout = @api_client.get_connection_timeout() # 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, :timeout => timeout, :auth_names => auth_names, :return_type => 'String') if @api_client.config.debugging @api_client.config.logger.debug "API called: ChargeFlowService#fetch_charge_flow_payment_page_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read(space_id, id, opts = {}) ⇒ ChargeFlow
Read Reads the entity with the given ‘id’ and returns it.
303 304 305 306 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 303 def read(space_id, id, opts = {}) data, _status_code, _headers = read_with_http_info(space_id, id, opts) return data end |
#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(ChargeFlow, Fixnum, Hash)>
Returns ChargeFlow data, response status code and response headers.
315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 315 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 = {} # connection timeout timeout = @api_client.get_connection_timeout() # 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, :timeout => timeout, :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(space_id, query, opts = {}) ⇒ Array<ChargeFlow>
Search Searches for the entities as specified by the given query.
371 372 373 374 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 371 def search(space_id, query, opts = {}) data, _status_code, _headers = search_with_http_info(space_id, query, opts) return data end |
#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<ChargeFlow>, Fixnum, Hash)>
Returns Array<ChargeFlow> data, response status code and response headers.
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 383 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 = {} # connection timeout timeout = @api_client.get_connection_timeout() # 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, :timeout => timeout, :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 |
#update_recipient(space_id, transaction_id, type, recipient, opts = {}) ⇒ nil
updateRecipient
440 441 442 443 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 440 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 |
#update_recipient_with_http_info(space_id, transaction_id, type, recipient, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Returns nil, response status code and response headers.
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 |
# File 'lib/postfinancecheckout-ruby-sdk/api/charge_flow_service_api.rb', line 454 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 = {} # connection timeout timeout = @api_client.get_connection_timeout() # 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, :timeout => timeout, :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 |