Class: Worldline::Connect::SDK::V1::Merchant::Captures::CapturesClient

Inherits:

ApiResource

• Object
• ApiResource
• Worldline::Connect::SDK::V1::Merchant::Captures::CapturesClient

Defined in:

lib/worldline/connect/sdk/v1/merchant/captures/captures_client.rb

Overview

Captures client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary

• #get(capture_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::CaptureResponse

  Resource /{merchantId}/captures/{captureId} - Get capture.

• #initialize(parent, path_context) ⇒ CapturesClient constructor

  A new instance of CapturesClient.

• #refund(capture_id, body, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::RefundResponse

  Resource /{merchantId}/captures/{captureId}/refund - Create Refund.

Constructor Details

#initialize(parent, path_context) ⇒ CapturesClient

Returns a new instance of CapturesClient.

Parameters:

• parent (Worldline::Connect::SDK::ApiResource)
• path_context (Hash, nil)

# File 'lib/worldline/connect/sdk/v1/merchant/captures/captures_client.rb', line 24

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

Instance Method Details

#get(capture_id, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::CaptureResponse

Resource /{merchantId}/captures/{captureId} - Get capture

Parameters:

• capture_id (String)
• context (Worldline::Connect::SDK::CallContext, nil) (defaults to: nil)

Returns:

• (Worldline::Connect::SDK::V1::Domain::CaptureResponse)

Raises:

• (Worldline::Connect::SDK::V1::IdempotenceException) —

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

• (Worldline::Connect::SDK::V1::ValidationException) —

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

• (Worldline::Connect::SDK::V1::AuthorizationException) —

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

• (Worldline::Connect::SDK::V1::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)

• (Worldline::Connect::SDK::V1::PlatformException) —

  if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect 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)

• (Worldline::Connect::SDK::V1::ApiException) —

  if the Worldline Global Collect platform returned any other error

# File 'lib/worldline/connect/sdk/v1/merchant/captures/captures_client.rb', line 42

def get(capture_id, context = nil)
  path_context = {
    'captureId'.freeze => capture_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/captures/{captureId}', path_context)
  @communicator.get(
    uri,
    client_headers,
    nil,
    Worldline::Connect::SDK::V1::Domain::CaptureResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end

#refund(capture_id, body, context = nil) ⇒ Worldline::Connect::SDK::V1::Domain::RefundResponse

Resource /{merchantId}/captures/{captureId}/refund - Create Refund

Parameters:

• capture_id (String)
• body (Worldline::Connect::SDK::V1::Domain::RefundRequest)
• context (Worldline::Connect::SDK::CallContext, nil) (defaults to: nil)

Returns:

• (Worldline::Connect::SDK::V1::Domain::RefundResponse)

Raises:

• (Worldline::Connect::SDK::V1::DeclinedRefundException) —

  if the Worldline Global Collect platform declined / rejected the refund. The refund result will be available from the exception.

• (Worldline::Connect::SDK::V1::IdempotenceException) —

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

• (Worldline::Connect::SDK::V1::ValidationException) —

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

• (Worldline::Connect::SDK::V1::AuthorizationException) —

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

• (Worldline::Connect::SDK::V1::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)

• (Worldline::Connect::SDK::V1::PlatformException) —

  if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect 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)

• (Worldline::Connect::SDK::V1::ApiException) —

  if the Worldline Global Collect platform returned any other error

# File 'lib/worldline/connect/sdk/v1/merchant/captures/captures_client.rb', line 75

def refund(capture_id, body, context = nil)
  path_context = {
    'captureId'.freeze => capture_id,
  }
  uri = instantiate_uri('/v1/{merchantId}/captures/{captureId}/refund', path_context)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Worldline::Connect::SDK::V1::Domain::RefundResponse,
    context)
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::RefundErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end