Class: WhiteLabelMachineName::RefundService
- Inherits:
-
Object
- Object
- WhiteLabelMachineName::RefundService
- Defined in:
- lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#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)>
Count Counts the number of items in the database as restricted by the given filter.
-
#fail(space_id, refund_id, opts = {}) ⇒ Refund
fail This operation allows to mark a refund as failed which is in state MANUAL_CHECK.
-
#fail_with_http_info(space_id, refund_id, opts = {}) ⇒ Array<(Refund, Fixnum, Hash)>
fail This operation allows to mark a refund as failed which is in state MANUAL_CHECK.
-
#get_refund_document(space_id, id, opts = {}) ⇒ RenderedDocument
getRefundDocument Returns the PDF document for the refund with given id.
-
#get_refund_document_with_http_info(space_id, id, opts = {}) ⇒ Array<(RenderedDocument, Fixnum, Hash)>
getRefundDocument Returns the PDF document for the refund with given id.
-
#get_refund_document_with_target_media_type(space_id, id, target_media_type_id, opts = {}) ⇒ RenderedDocument
getRefundDocumentWithTargetMediaType Returns the PDF document for the refund with given id and the given target media type.
-
#get_refund_document_with_target_media_type_with_http_info(space_id, id, target_media_type_id, opts = {}) ⇒ Array<(RenderedDocument, Fixnum, Hash)>
getRefundDocumentWithTargetMediaType Returns the PDF document for the refund with given id and the given target media type.
-
#initialize(api_client = ApiClient.default) ⇒ RefundService
constructor
A new instance of RefundService.
-
#read(space_id, id, opts = {}) ⇒ Refund
Read Reads the entity with the given ‘id’ and returns it.
-
#read_with_http_info(space_id, id, opts = {}) ⇒ Array<(Refund, Fixnum, Hash)>
Read Reads the entity with the given 'id' and returns it.
-
#refund(space_id, refund, opts = {}) ⇒ Refund
create This operation creates and executes a refund of a particular transaction.
-
#refund_with_http_info(space_id, refund, opts = {}) ⇒ Array<(Refund, Fixnum, Hash)>
create This operation creates and executes a refund of a particular transaction.
-
#search(space_id, query, opts = {}) ⇒ Array<Refund>
Search Searches for the entities as specified by the given query.
-
#search_with_http_info(space_id, query, opts = {}) ⇒ Array<(Array<Refund>, Fixnum, Hash)>
Search Searches for the entities as specified by the given query.
-
#succeed(space_id, refund_id, opts = {}) ⇒ Refund
succeed This operation allows to mark a refund as successful which is in state MANUAL_CHECK.
-
#succeed_with_http_info(space_id, refund_id, opts = {}) ⇒ Array<(Refund, Fixnum, Hash)>
succeed This operation allows to mark a refund as successful which is in state MANUAL_CHECK.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ RefundService
Returns a new instance of RefundService.
24 25 26 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_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/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 22 def api_client @api_client end |
Instance Method Details
#count(space_id, opts = {}) ⇒ Integer
Count Counts the number of items in the database as restricted by the given filter.
34 35 36 37 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 34 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)>
Count Counts the number of items in the database as restricted by the given filter.
45 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 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 45 def count_with_http_info(space_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RefundService.count ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundService.count" if space_id.nil? # resource path local_var_path = "/refund/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: RefundService#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#fail(space_id, refund_id, opts = {}) ⇒ Refund
fail This operation allows to mark a refund as failed which is in state MANUAL_CHECK.
94 95 96 97 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 94 def fail(space_id, refund_id, opts = {}) data, _status_code, _headers = fail_with_http_info(space_id, refund_id, opts) return data end |
#fail_with_http_info(space_id, refund_id, opts = {}) ⇒ Array<(Refund, Fixnum, Hash)>
fail This operation allows to mark a refund as failed which is in state MANUAL_CHECK.
105 106 107 108 109 110 111 112 113 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 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 105 def fail_with_http_info(space_id, refund_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RefundService.fail ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundService.fail" if space_id.nil? # verify the required parameter 'refund_id' is set fail ArgumentError, "Missing the required parameter 'refund_id' when calling RefundService.fail" if refund_id.nil? # resource path local_var_path = "/refund/fail".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'refundId'] = refund_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 => 'Refund') if @api_client.config.debugging @api_client.config.logger.debug "API called: RefundService#fail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_refund_document(space_id, id, opts = {}) ⇒ RenderedDocument
getRefundDocument Returns the PDF document for the refund with given id.
157 158 159 160 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 157 def get_refund_document(space_id, id, opts = {}) data, _status_code, _headers = get_refund_document_with_http_info(space_id, id, opts) return data end |
#get_refund_document_with_http_info(space_id, id, opts = {}) ⇒ Array<(RenderedDocument, Fixnum, Hash)>
getRefundDocument Returns the PDF document for the refund with given id.
168 169 170 171 172 173 174 175 176 177 178 179 180 181 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 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 168 def get_refund_document_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RefundService.get_refund_document ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundService.get_refund_document" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling RefundService.get_refund_document" if id.nil? # resource path local_var_path = "/refund/getRefundDocument".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 => 'RenderedDocument') if @api_client.config.debugging @api_client.config.logger.debug "API called: RefundService#get_refund_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_refund_document_with_target_media_type(space_id, id, target_media_type_id, opts = {}) ⇒ RenderedDocument
getRefundDocumentWithTargetMediaType Returns the PDF document for the refund with given id and the given target media type.
221 222 223 224 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 221 def get_refund_document_with_target_media_type(space_id, id, target_media_type_id, opts = {}) data, _status_code, _headers = get_refund_document_with_target_media_type_with_http_info(space_id, id, target_media_type_id, opts) return data end |
#get_refund_document_with_target_media_type_with_http_info(space_id, id, target_media_type_id, opts = {}) ⇒ Array<(RenderedDocument, Fixnum, Hash)>
getRefundDocumentWithTargetMediaType Returns the PDF document for the refund with given id and the given target media type.
233 234 235 236 237 238 239 240 241 242 243 244 245 246 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 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 233 def get_refund_document_with_target_media_type_with_http_info(space_id, id, target_media_type_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RefundService.get_refund_document_with_target_media_type ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundService.get_refund_document_with_target_media_type" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling RefundService.get_refund_document_with_target_media_type" if id.nil? # verify the required parameter 'target_media_type_id' is set fail ArgumentError, "Missing the required parameter 'target_media_type_id' when calling RefundService.get_refund_document_with_target_media_type" if target_media_type_id.nil? # resource path local_var_path = "/refund/getRefundDocumentWithTargetMediaType".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'id'] = id query_params[:'targetMediaTypeId'] = target_media_type_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 => 'RenderedDocument') if @api_client.config.debugging @api_client.config.logger.debug "API called: RefundService#get_refund_document_with_target_media_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#read(space_id, id, opts = {}) ⇒ Refund
Read Reads the entity with the given ‘id’ and returns it.
288 289 290 291 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 288 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<(Refund, Fixnum, Hash)>
Read Reads the entity with the given 'id' and returns it.
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 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 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 299 def read_with_http_info(space_id, id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RefundService.read ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundService.read" if space_id.nil? # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling RefundService.read" if id.nil? # resource path local_var_path = "/refund/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 => 'Refund') if @api_client.config.debugging @api_client.config.logger.debug "API called: RefundService#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#refund(space_id, refund, opts = {}) ⇒ Refund
create This operation creates and executes a refund of a particular transaction.
351 352 353 354 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 351 def refund(space_id, refund, opts = {}) data, _status_code, _headers = refund_with_http_info(space_id, refund, opts) return data end |
#refund_with_http_info(space_id, refund, opts = {}) ⇒ Array<(Refund, Fixnum, Hash)>
create This operation creates and executes a refund of a particular transaction.
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 362 def refund_with_http_info(space_id, refund, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RefundService.refund ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundService.refund" if space_id.nil? # verify the required parameter 'refund' is set fail ArgumentError, "Missing the required parameter 'refund' when calling RefundService.refund" if refund.nil? # resource path local_var_path = "/refund/refund".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(refund) 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 => 'Refund') if @api_client.config.debugging @api_client.config.logger.debug "API called: RefundService#refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#search(space_id, query, opts = {}) ⇒ Array<Refund>
Search Searches for the entities as specified by the given query.
413 414 415 416 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 413 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<Refund>, Fixnum, Hash)>
Search Searches for the entities as specified by the given query.
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 424 def search_with_http_info(space_id, query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RefundService.search ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundService.search" if space_id.nil? # verify the required parameter 'query' is set fail ArgumentError, "Missing the required parameter 'query' when calling RefundService.search" if query.nil? # resource path local_var_path = "/refund/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<Refund>') if @api_client.config.debugging @api_client.config.logger.debug "API called: RefundService#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#succeed(space_id, refund_id, opts = {}) ⇒ Refund
succeed This operation allows to mark a refund as successful which is in state MANUAL_CHECK.
475 476 477 478 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 475 def succeed(space_id, refund_id, opts = {}) data, _status_code, _headers = succeed_with_http_info(space_id, refund_id, opts) return data end |
#succeed_with_http_info(space_id, refund_id, opts = {}) ⇒ Array<(Refund, Fixnum, Hash)>
succeed This operation allows to mark a refund as successful which is in state MANUAL_CHECK.
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 |
# File 'lib/whitelabelmachinename-ruby-sdk/api/refund_service_api.rb', line 486 def succeed_with_http_info(space_id, refund_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: RefundService.succeed ..." end # verify the required parameter 'space_id' is set fail ArgumentError, "Missing the required parameter 'space_id' when calling RefundService.succeed" if space_id.nil? # verify the required parameter 'refund_id' is set fail ArgumentError, "Missing the required parameter 'refund_id' when calling RefundService.succeed" if refund_id.nil? # resource path local_var_path = "/refund/succeed".sub('{format}','json') # query parameters query_params = {} query_params[:'spaceId'] = space_id query_params[:'refundId'] = refund_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 => 'Refund') if @api_client.config.debugging @api_client.config.logger.debug "API called: RefundService#succeed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |