Class: NewStoreApi::SimulationController

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

Overview

SimulationController

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

#create_routing_simulation(body, user_id: nil) ⇒ RoutingSimulationResponsePayload

🚧 BETA: This endpoint is in beta and may change.
See API Lifecycle Documentation for details.
Dry-run routing using only the request body (no downstream fetcher HTTP calls). type description here audit logging.

Parameters:

  • body (RoutingSimulationRequestPayload) —

    Required parameter: TODO:

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

    Optional parameter: Optional user identifier for

Returns:



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/new_store_api/controllers/simulation_controller.rb', line 25

def create_routing_simulation(body,
                              user_id: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/routing/simulations',
                                 Server::API)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter(user_id, key: 'user-id'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(Single.new('oauth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(RoutingSimulationResponsePayload.method(:from_hash)))
    .execute
end