Class: OnlinePayments::SDK::Merchant::Webhooks::WebhooksClient

Inherits:

ApiResource

• Object
• ApiResource
• OnlinePayments::SDK::Merchant::Webhooks::WebhooksClient

Defined in:

lib/onlinepayments/sdk/merchant/webhooks/webhooks_client.rb

Overview

Webhooks client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary

• #initialize(parent, path_context) ⇒ WebhooksClient constructor

  A new instance of WebhooksClient.

• #send_test_webhook(body, context = nil) ⇒ Object

  Resource /v2/{merchantId}/webhooks/sendtest - Send test.

• #validate_webhook_credentials(body, context = nil) ⇒ OnlinePayments::SDK::Domain::ValidateCredentialsResponse

  Resource /v2/{merchantId}/webhooks/validateCredentials - Validate credentials.

Constructor Details

#initialize(parent, path_context) ⇒ WebhooksClient

Returns a new instance of WebhooksClient.

Parameters:

• parent (OnlinePayments::SDK::ApiResource)
• path_context (Hash, nil)

# File 'lib/onlinepayments/sdk/merchant/webhooks/webhooks_client.rb', line 19

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

Instance Method Details

#send_test_webhook(body, context = nil) ⇒ Object

Resource /v2/{merchantId}/webhooks/sendtest - Send test

Parameters:

• body (OnlinePayments::SDK::Domain::SendTestRequest)
• context (OnlinePayments::SDK::CallContext, nil) (defaults to: nil)

Raises:

• (OnlinePayments::SDK::IdempotenceException) —

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

• (OnlinePayments::SDK::ValidationException) —

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

• (OnlinePayments::SDK::AuthorizationException) —

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

• (OnlinePayments::SDK::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)

• (OnlinePayments::SDK::PlatformException) —

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

• (OnlinePayments::SDK::ApiException) —

  if the payment platform returned any other error

# File 'lib/onlinepayments/sdk/merchant/webhooks/webhooks_client.rb', line 65

def send_test_webhook(body, context = nil)
  uri = instantiate_uri('/v2/{merchantId}/webhooks/sendtest', nil)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    nil,
    context)
rescue OnlinePayments::SDK::Communication::ResponseException => e
  error_type = OnlinePayments::SDK::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise OnlinePayments::SDK.create_exception(e.status_code, e.body, error_object, context)
end

#validate_webhook_credentials(body, context = nil) ⇒ OnlinePayments::SDK::Domain::ValidateCredentialsResponse

Resource /v2/{merchantId}/webhooks/validateCredentials - Validate credentials

Parameters:

• body (OnlinePayments::SDK::Domain::ValidateCredentialsRequest)
• context (OnlinePayments::SDK::CallContext, nil) (defaults to: nil)

Returns:

• (OnlinePayments::SDK::Domain::ValidateCredentialsResponse)

Raises:

• (OnlinePayments::SDK::IdempotenceException) —

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

• (OnlinePayments::SDK::ValidationException) —

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

• (OnlinePayments::SDK::AuthorizationException) —

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

• (OnlinePayments::SDK::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)

• (OnlinePayments::SDK::PlatformException) —

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

• (OnlinePayments::SDK::ApiException) —

  if the payment platform returned any other error

# File 'lib/onlinepayments/sdk/merchant/webhooks/webhooks_client.rb', line 37

def validate_webhook_credentials(body, context = nil)
  uri = instantiate_uri('/v2/{merchantId}/webhooks/validateCredentials', nil)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    OnlinePayments::SDK::Domain::ValidateCredentialsResponse,
    context)
rescue OnlinePayments::SDK::Communication::ResponseException => e
  error_type = OnlinePayments::SDK::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise OnlinePayments::SDK.create_exception(e.status_code, e.body, error_object, context)
end