Class: Ingenico::Connect::SDK::Merchant::Refunds::RefundsClient

Inherits:
ApiResource
  • Object
show all
Defined in:
lib/ingenico/connect/sdk/merchant/refunds/refunds_client.rb

Overview

Refunds client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary collapse

Constructor Details

#initialize(parent, path_context) ⇒ RefundsClient

parent

ApiResource

path_context

Hash of String to String



20
21
22
 
# File 'lib/ingenico/connect/sdk/merchant/refunds/refunds_client.rb', line 20

def initialize(parent, path_context)
  super(parent, path_context)
end

Instance Method Details

#approve(refund_id, body, context = nil) ⇒ Object

Resource /{merchantId}/refunds/{refundId}/approve

Approve refund

refund_id

String

body

Domain::Refund::ApproveRefundRequest

context

CallContext

Raises

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raises

AuthorizationException if the request was not allowed (HTTP status code 403)

Raises

IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)

Raises

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed,

or there was a conflict (HTTP status code 404, 409 or 410)

Raises

GlobalCollectException if something went wrong at the Ingenico ePayments platform,

the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,

or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raises

ApiException if the Ingenico ePayments platform returned any other error



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/ingenico/connect/sdk/merchant/refunds/refunds_client.rb', line 100

def approve(refund_id, body, context=nil)
  path_context = {
    'refundId' => refund_id,
  }
  uri = instantiate_uri('/{apiVersion}/{merchantId}/refunds/{refundId}/approve', path_context)
  return @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    nil,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#cancel(refund_id, context = nil) ⇒ Object

Resource /{merchantId}/refunds/{refundId}/cancel

Cancel refund

refund_id

String

context

CallContext

Raises

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raises

AuthorizationException if the request was not allowed (HTTP status code 403)

Raises

IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)

Raises

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed,

or there was a conflict (HTTP status code 404, 409 or 410)

Raises

GlobalCollectException if something went wrong at the Ingenico ePayments platform,

the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,

or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raises

ApiException if the Ingenico ePayments platform returned any other error



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ingenico/connect/sdk/merchant/refunds/refunds_client.rb', line 132

def cancel(refund_id, context=nil)
  path_context = {
    'refundId' => refund_id,
  }
  uri = instantiate_uri('/{apiVersion}/{merchantId}/refunds/{refundId}/cancel', path_context)
  return @communicator.post(
    uri,
    client_headers,
    nil,
    nil,
    nil,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#cancelapproval(refund_id, context = nil) ⇒ Object

Resource /{merchantId}/refunds/{refundId}/cancelapproval

Undo approve refund

refund_id

String

context

CallContext

Raises

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raises

AuthorizationException if the request was not allowed (HTTP status code 403)

Raises

IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)

Raises

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed,

or there was a conflict (HTTP status code 404, 409 or 410)

Raises

GlobalCollectException if something went wrong at the Ingenico ePayments platform,

the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,

or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raises

ApiException if the Ingenico ePayments platform returned any other error



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/ingenico/connect/sdk/merchant/refunds/refunds_client.rb', line 164

def cancelapproval(refund_id, context=nil)
  path_context = {
    'refundId' => refund_id,
  }
  uri = instantiate_uri('/{apiVersion}/{merchantId}/refunds/{refundId}/cancelapproval', path_context)
  return @communicator.post(
    uri,
    client_headers,
    nil,
    nil,
    nil,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#find(query, context = nil) ⇒ Object

Resource /{merchantId}/refunds

Find refunds

query

FindRefundsParams

context

CallContext

Returns

Domain::Refund::FindRefundsResponse

Raises

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raises

AuthorizationException if the request was not allowed (HTTP status code 403)

Raises

IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)

Raises

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed,

or there was a conflict (HTTP status code 404, 409 or 410)

Raises

GlobalCollectException if something went wrong at the Ingenico ePayments platform,

the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,

or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raises

ApiException if the Ingenico ePayments platform returned any other error



39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/ingenico/connect/sdk/merchant/refunds/refunds_client.rb', line 39

def find(query, context=nil)
  uri = instantiate_uri('/{apiVersion}/{merchantId}/refunds', nil)
  return @communicator.get(
    uri,
    client_headers,
    query,
    Ingenico::Connect::SDK::Domain::Refund::FindRefundsResponse,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#get(refund_id, context = nil) ⇒ Object

Resource /{merchantId}/refunds/{refundId}

Get refund

refund_id

String

context

CallContext

Returns

Domain::Refund::RefundResponse

Raises

ValidationException if the request was not correct and couldn’t be processed (HTTP status code 400)

Raises

AuthorizationException if the request was not allowed (HTTP status code 403)

Raises

IdempotenceException if an idempotent request caused a conflict (HTTP status code 409)

Raises

ReferenceException if an object was attempted to be referenced that doesn’t exist or has been removed,

or there was a conflict (HTTP status code 404, 409 or 410)

Raises

GlobalCollectException if something went wrong at the Ingenico ePayments platform,

the Ingenico ePayments platform was unable to process a message from a downstream partner/acquirer,

or the service that you’re trying to reach is temporary unavailable (HTTP status code 500, 502 or 503)

Raises

ApiException if the Ingenico ePayments platform returned any other error



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/ingenico/connect/sdk/merchant/refunds/refunds_client.rb', line 68

def get(refund_id, context=nil)
  path_context = {
    'refundId' => refund_id,
  }
  uri = instantiate_uri('/{apiVersion}/{merchantId}/refunds/{refundId}', path_context)
  return @communicator.get(
    uri,
    client_headers,
    nil,
    Ingenico::Connect::SDK::Domain::Refund::RefundResponse,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end