Class: NewStoreApi::FulfillmentTasksController

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

Overview

FulfillmentTasksController

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

#list_fulfillment_tasks(status: nil, shipped_externally: nil, handed_over_after: nil, updated_at_after: nil) ⇒ GetTaskModel

🚧 BETA: This endpoint is in beta and may change.
See API Lifecycle Documentation for details.
TODO: type description here description here description here

Parameters:

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

    Optional parameter: TODO: type description here

  • shipped_externally (TrueClass | FalseClass) (defaults to: nil) —

    Optional parameter:

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

    Optional parameter: TODO: type

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

    Optional parameter: TODO: type

Returns:



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

def list_fulfillment_tasks(status: nil,
                           shipped_externally: nil,
                           handed_over_after: nil,
                           updated_at_after: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/fulfillment/fulfillment-tasks',
                                 Server::API)
               .query_param(new_parameter(status, key: 'status'))
               .query_param(new_parameter(shipped_externally, key: 'shipped_externally'))
               .query_param(new_parameter(handed_over_after, key: 'handed_over_after'))
               .query_param(new_parameter(updated_at_after, key: 'updated_at_after'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('oauth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(GetTaskModel.method(:from_hash)))
    .execute
end