Class: NewStoreApi::TransferringController

Inherits:
BaseController show all
Defined in:
lib/new_store_api/controllers/transferring_controller.rb

Overview

TransferringController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent

Constructor Details

This class inherits a constructor from NewStoreApi::BaseController

Instance Method Details

#show_transfer_transaction(transfer_id) ⇒ GetTransferTransactionResponse

🚧 BETA: This endpoint is in beta and may change.
See API Lifecycle Documentation for details.
Get the details of a Transfer Transaction. Transaction identifier.

Parameters:

  • transfer_id (UUID | String) —

    Required parameter: Transfer

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/new_store_api/controllers/transferring_controller.rb', line 22

def show_transfer_transaction(transfer_id)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/inventory/transfer-transactions/{transfer_id}',
                                 Server::API)
               .template_param(new_parameter(transfer_id, key: 'transfer_id')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('oauth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(GetTransferTransactionResponse.method(:from_hash)))
    .execute
end