Class: Worldline::Acquiring::SDK::ApiResource

Inherits:

Object

• Object
• Worldline::Acquiring::SDK::ApiResource

Defined in:

lib/worldline/acquiring/sdk/api_resource.rb

Overview

Base class of all Worldline Acquiring platform API resources. Provides shared functionality to facilitate communication with the Worldline Acquiring platform.

Direct Known Subclasses

Client, V1::Acquirer::AcquirerClient, V1::Acquirer::Merchant::Accountverifications::AccountVerificationsClient, V1::Acquirer::Merchant::Dynamiccurrencyconversion::DynamicCurrencyConversionClient, V1::Acquirer::Merchant::MerchantClient, V1::Acquirer::Merchant::Payments::PaymentsClient, V1::Acquirer::Merchant::Refunds::RefundsClient, V1::Acquirer::Merchant::Technicalreversals::TechnicalReversalsClient, V1::Ping::PingClient, V1::V1Client

Instance Attribute Summary

• #communicator ⇒ Worldline::Acquiring::SDK::Communicator readonly

  Communicator instance that provides communication with the Worldline Acquiring platform.

Instance Method Summary

• #initialize(parent: nil, communicator: nil, path_context: nil) ⇒ ApiResource constructor

  Creates a new ApiResource.

Constructor Details

#initialize(parent: nil, communicator: nil, path_context: nil) ⇒ ApiResource

Creates a new ApiResource.

Parameters:

• parent (Worldline::Acquiring::SDK::ApiResource) (defaults to: nil) —

  parent resource instance.

• communicator (Worldline::Acquiring::SDK::Communicator) (defaults to: nil) —

  Communicator instance.

• path_context (Hash) (defaults to: nil) —

  hash that contains substitutions for generic locations in the URL path. This hash will be used to instantiate a concrete URL used to access specific resources.

Raises:

• (ArgumentError)

# File 'lib/worldline/acquiring/sdk/api_resource.rb', line 16

def initialize(parent: nil, communicator: nil, path_context: nil)
  raise ArgumentError.new('parent and/or communicator is required') if parent.nil? and communicator.nil?
  @parent = parent
  @communicator = communicator.nil? ? parent.communicator : communicator
  @path_context = path_context
end

Instance Attribute Details

#communicator ⇒ Worldline::Acquiring::SDK::Communicator (readonly)

Communicator instance that provides communication with the Worldline Acquiring platform.

Returns:

• (Worldline::Acquiring::SDK::Communicator) —

  the current value of communicator

# File 'lib/worldline/acquiring/sdk/api_resource.rb', line 8

def communicator
  @communicator
end