Class: Ingenico::Connect::SDK::Merchant::Hostedmandatemanagements::HostedmandatemanagementsClient

Inherits:

ApiResource

Object
ApiResource
Ingenico::Connect::SDK::Merchant::Hostedmandatemanagements::HostedmandatemanagementsClient

show all

Defined in:: lib/ingenico/connect/sdk/merchant/hostedmandatemanagements/hostedmandatemanagements_client.rb

Overview

Hostedmandatemanagements client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary collapse

#create(body, context = nil) ⇒ Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::CreateHostedMandateManagementResponse

Resource /{merchantId}/hostedmandatemanagements - Create hosted mandate management.
#get(hosted_mandate_management_id, context = nil) ⇒ Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::GetHostedMandateManagementResponse

Resource /{merchantId}/hostedmandatemanagements/{hostedMandateManagementId} - Get hosted mandate management status.
#initialize(parent, path_context) ⇒ HostedmandatemanagementsClient constructor

A new instance of HostedmandatemanagementsClient.

Constructor Details

#initialize(parent, path_context) ⇒ `HostedmandatemanagementsClient`



21
22
23

# File 'lib/ingenico/connect/sdk/merchant/hostedmandatemanagements/hostedmandatemanagements_client.rb', line 21

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

Instance Method Details

#create(body, context = nil) ⇒ `Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::CreateHostedMandateManagementResponse`

Resource /{merchantId}/hostedmandatemanagements - Create hosted mandate management

Raises:

(Ingenico::Connect::SDK::ValidationException) —

if the request was not correct and couldn’t be processed (HTTP status code 400)
(Ingenico::Connect::SDK::AuthorizationException) —

if the request was not allowed (HTTP status code 403)
(Ingenico::Connect::SDK::IdempotenceException) —

if an idempotent request caused a conflict (HTTP status code 409)
(Ingenico::Connect::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)
(Ingenico::Connect::SDK::GlobalCollectException) —

if something went wrong at the Ingenico ePayments platform, the Ingenico ePayments 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)
(Ingenico::Connect::SDK::ApiException) —

if the Ingenico ePayments platform returned any other error

# File 'lib/ingenico/connect/sdk/merchant/hostedmandatemanagements/hostedmandatemanagements_client.rb', line 38

def create(body, context = nil)
  uri = instantiate_uri('/v1/{merchantId}/hostedmandatemanagements', nil)
  @communicator.post(
    uri,
    client_headers,
    nil,
    body,
    Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::CreateHostedMandateManagementResponse,
    context)
rescue ResponseException => e
  error_type = Ingenico::Connect::SDK::Domain::Errors::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise create_exception(e.status_code, e.body, error_object, context)
end

#get(hosted_mandate_management_id, context = nil) ⇒ `Ingenico::Connect::SDK::Domain::Hostedmandatemanagement::GetHostedMandateManagementResponse`

Resource /{merchantId}/hostedmandatemanagements/{hostedMandateManagementId} - Get hosted mandate management status