Class: OnlinePayments::SDK::Merchant::ProductGroups::ProductGroupsClient

Inherits:

ApiResource

• Object
• ApiResource
• OnlinePayments::SDK::Merchant::ProductGroups::ProductGroupsClient

Defined in:

lib/onlinepayments/sdk/merchant/productgroups/product_groups_client.rb

Overview

ProductGroups client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary

• #get_product_group(payment_product_group_id, query, context = nil) ⇒ OnlinePayments::SDK::Domain::PaymentProductGroup

  Resource /v2/{merchantId}/productgroups/{paymentProductGroupId}.

• #get_product_groups(query, context = nil) ⇒ OnlinePayments::SDK::Domain::GetPaymentProductGroupsResponse

  Resource /v2/{merchantId}/productgroups.

• #initialize(parent, path_context = nil) ⇒ ProductGroupsClient constructor

  A new instance of ProductGroupsClient.

Constructor Details

#initialize(parent, path_context = nil) ⇒ ProductGroupsClient

Returns a new instance of ProductGroupsClient.

Parameters:

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

# File 'lib/onlinepayments/sdk/merchant/productgroups/product_groups_client.rb', line 21

def initialize(parent, path_context = nil)
  super(parent, path_context)
end

Instance Method Details

#get_product_group(payment_product_group_id, query, context = nil) ⇒ OnlinePayments::SDK::Domain::PaymentProductGroup

Resource /v2/{merchantId}/productgroups/{paymentProductGroupId}

Parameters:

• payment_product_group_id (String)
• query (OnlinePayments::SDK::Merchant::ProductGroups::GetProductGroupParams)
• context (OnlinePayments::SDK::CallContext) (defaults to: nil)

Returns:

• (OnlinePayments::SDK::Domain::PaymentProductGroup)

Raises:

• (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::IdempotenceException) —

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

• (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::PaymentPlatformException) —

  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/productgroups/product_groups_client.rb', line 67

def get_product_group(payment_product_group_id, query, context = nil)
  path_context = {
    'paymentProductGroupId'.freeze => payment_product_group_id,
  }
  uri = instantiate_uri('/v2/{merchantId}/productgroups/{paymentProductGroupId}', path_context)
  @communicator.get(
    uri,
    client_headers,
    query,
    OnlinePayments::SDK::Domain::PaymentProductGroup,
    context
  )
rescue ResponseException => e
  error_type = OnlinePayments::SDK::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#get_product_groups(query, context = nil) ⇒ OnlinePayments::SDK::Domain::GetPaymentProductGroupsResponse

Resource /v2/{merchantId}/productgroups

Parameters:

• query (OnlinePayments::SDK::Merchant::ProductGroups::GetProductGroupsParams)
• context (OnlinePayments::SDK::CallContext) (defaults to: nil)

Returns:

• (OnlinePayments::SDK::Domain::GetPaymentProductGroupsResponse)

Raises:

• (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::IdempotenceException) —

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

• (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::PaymentPlatformException) —

  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/productgroups/product_groups_client.rb', line 38

def get_product_groups(query, context = nil)
  uri = instantiate_uri('/v2/{merchantId}/productgroups')
  @communicator.get(
    uri,
    client_headers,
    query,
    OnlinePayments::SDK::Domain::GetPaymentProductGroupsResponse,
    context
  )
rescue ResponseException => e
  error_type = OnlinePayments::SDK::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end