Class: OnlinePayments::SDK::Merchant::HostedFields::HostedFieldsClient

Inherits:

ApiResource

• Object
• ApiResource
• OnlinePayments::SDK::Merchant::HostedFields::HostedFieldsClient

Defined in:

lib/onlinepayments/sdk/merchant/hostedfields/hosted_fields_client.rb

Overview

HostedFields client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary

• #create_hosted_fields_session(body, context = nil) ⇒ OnlinePayments::SDK::Domain::CreateHostedFieldsSessionResponse

  Resource /v2/{merchantId}/hostedfields/sessions - Create hosted fields session.

• #get_hosted_fields_session(session_id, context = nil) ⇒ OnlinePayments::SDK::Domain::GetHostedFieldsSessionResponse

  Resource /v2/{merchantId}/hostedfields/sessions/{sessionId} - Get hosted fields session.

• #initialize(parent, path_context) ⇒ HostedFieldsClient constructor

  A new instance of HostedFieldsClient.

Constructor Details

#initialize(parent, path_context) ⇒ HostedFieldsClient

Returns a new instance of HostedFieldsClient.

Parameters:

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

# File 'lib/onlinepayments/sdk/merchant/hostedfields/hosted_fields_client.rb', line 21

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

Instance Method Details

#create_hosted_fields_session(body, context = nil) ⇒ OnlinePayments::SDK::Domain::CreateHostedFieldsSessionResponse

Resource /v2/{merchantId}/hostedfields/sessions - Create hosted fields session

Parameters:

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

Returns:

• (OnlinePayments::SDK::Domain::CreateHostedFieldsSessionResponse)

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/hostedfields/hosted_fields_client.rb', line 39

def create_hosted_fields_session(body, context = nil)
  uri = instantiate_uri('/v2/{merchantId}/hostedfields/sessions', nil)


  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    OnlinePayments::SDK::Domain::CreateHostedFieldsSessionResponse,
    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

#get_hosted_fields_session(session_id, context = nil) ⇒ OnlinePayments::SDK::Domain::GetHostedFieldsSessionResponse

Resource /v2/{merchantId}/hostedfields/sessions/{sessionId} - Get hosted fields session

Parameters:

• session_id (String)
• context (OnlinePayments::SDK::CallContext, nil) (defaults to: nil)

Returns:

• (OnlinePayments::SDK::Domain::GetHostedFieldsSessionResponse)

Raises:

• (OnlinePayments::SDK::ProblemDetailsException) —

  if the payment platform returned a problem details error response

• (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/hostedfields/hosted_fields_client.rb', line 71

def get_hosted_fields_session(session_id, context = nil)
  path_context = {
    'sessionId'.freeze => session_id,
  }
  uri = instantiate_uri('/v2/{merchantId}/hostedfields/sessions/{sessionId}', path_context)


  @communicator.get(
    uri,
    client_headers,
    nil,
    OnlinePayments::SDK::Domain::GetHostedFieldsSessionResponse,
    context)
rescue OnlinePayments::SDK::Communication::ResponseException => e
  error_type = OnlinePayments::SDK::Domain::ProblemDetailsResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise OnlinePayments::SDK.create_exception(e.status_code, e.body, error_object, context)
end