Class: Worldline::Connect::SDK::V1::Merchant::Files::FilesClient

Inherits:

ApiResource

• Object
• ApiResource
• Worldline::Connect::SDK::V1::Merchant::Files::FilesClient

Defined in:

lib/worldline/connect/sdk/v1/merchant/files/files_client.rb

Overview

Files client. Thread-safe.

Instance Attribute Summary

Attributes inherited from ApiResource

#client_meta_info, #communicator

Instance Method Summary

• #get_file(file_id, context = nil) {|Array<Worldline::Connect::SDK::Communication::ResponseHeader>, IO| ... } ⇒ Object

  Resource /{merchantId}/files/{fileId} - Retrieve File.

• #initialize(parent, path_context) ⇒ FilesClient constructor

  A new instance of FilesClient.

Constructor Details

#initialize(parent, path_context) ⇒ FilesClient

Returns a new instance of FilesClient.

Parameters:

• parent (Worldline::Connect::SDK::ApiResource)
• path_context (Hash, nil)

# File 'lib/worldline/connect/sdk/v1/merchant/files/files_client.rb', line 21

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

Instance Method Details

#get_file(file_id, context = nil) {|Array<Worldline::Connect::SDK::Communication::ResponseHeader>, IO| ... } ⇒ Object

Resource /{merchantId}/files/{fileId} - Retrieve File

Parameters:

• file_id (String)
• context (Worldline::Connect::SDK::CallContext, nil) (defaults to: nil)

Yields:

• (Array<Worldline::Connect::SDK::Communication::ResponseHeader>, IO) —

  The response headers and body.

Raises:

• (Worldline::Connect::SDK::V1::IdempotenceException) —

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

• (Worldline::Connect::SDK::V1::ValidationException) —

  if the request was not correct and couldn’t be processed (HTTP status code 400)

• (Worldline::Connect::SDK::V1::AuthorizationException) —

  if the request was not allowed (HTTP status code 403)

• (Worldline::Connect::SDK::V1::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)

• (Worldline::Connect::SDK::V1::PlatformException) —

  if something went wrong at the Worldline Global Collect platform, the Worldline Global Collect 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)

• (Worldline::Connect::SDK::V1::ApiException) —

  if the Worldline Global Collect platform returned any other error

# File 'lib/worldline/connect/sdk/v1/merchant/files/files_client.rb', line 39

def get_file(file_id, context = nil)
  path_context = {
    'fileId'.freeze => file_id,
  }
  uri = instantiate_uri('/files/v1/{merchantId}/files/{fileId}', path_context)
  @communicator.get_with_binary_response(
    uri,
    client_headers,
    nil,
    context) do |headers, response_body|
    yield headers, response_body
  end
rescue ResponseException => e
  error_type = Worldline::Connect::SDK::V1::Domain::ErrorResponse
  error_object = @communicator.marshaller.unmarshal(e.body, error_type)
  raise Worldline::Connect::SDK::V1.create_exception(e.status_code, e.body, error_object, context)
end