Class: OnlinePayments::SDK::ApiResource

Inherits:

Object

• Object
• OnlinePayments::SDK::ApiResource

Defined in:

lib/onlinepayments/sdk/api_resource.rb

Overview

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

Direct Known Subclasses

Client, Merchant::Captures::CapturesClient, Merchant::Complete::CompleteClient, Merchant::HostedCheckout::HostedCheckoutClient, Merchant::HostedTokenization::HostedTokenizationClient, Merchant::Mandates::MandatesClient, Merchant::MerchantClient, Merchant::PaymentLinks::PaymentLinksClient, Merchant::Payments::PaymentsClient, Merchant::Payouts::PayoutsClient, Merchant::PrivacyPolicy::PrivacyPolicyClient, Merchant::ProductGroups::ProductGroupsClient, Merchant::Products::ProductsClient, Merchant::Refunds::RefundsClient, Merchant::Services::ServicesClient, Merchant::Sessions::SessionsClient, Merchant::Tokens::TokensClient, Merchant::Webhooks::WebhooksClient

Instance Attribute Summary

• #client_meta_info ⇒ String readonly

  JSON string containing client info specific to the current client.

• #communicator ⇒ OnlinePayments::SDK::Communicator readonly

  Communicator instance that provides communication with the Online Payments platform.

Instance Method Summary

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

  Creates a new ApiResource.

Constructor Details

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

Creates a new ApiResource.

Parameters:

• parent (OnlinePayments::SDK::ApiResource) (defaults to: nil) —

  parent resource instance.

• communicator (OnlinePayments::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.

• client_meta_info (String) (defaults to: nil) —

  JSON string containing the metadata for the client.

Raises:

• (ArgumentError)

# File 'lib/onlinepayments/sdk/api_resource.rb', line 19

def initialize(parent: nil, communicator: nil, path_context: nil, client_meta_info: 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
  @client_meta_info = client_meta_info || parent.nil? ? client_meta_info : parent.client_meta_info
end

Instance Attribute Details

#client_meta_info ⇒ String (readonly)

JSON string containing client info specific to the current client.

Returns:

• (String) —

  the current value of client_meta_info

# File 'lib/onlinepayments/sdk/api_resource.rb', line 10

def client_meta_info
  @client_meta_info
end

#communicator ⇒ OnlinePayments::SDK::Communicator (readonly)

Communicator instance that provides communication with the Online Payments platform.

Returns:

• (OnlinePayments::SDK::Communicator) —

  the current value of communicator

# File 'lib/onlinepayments/sdk/api_resource.rb', line 10

def communicator
  @communicator
end