Class: CyberSourceMergedSpec::NotificationOfChangesController

Inherits:
BaseController
  • Object
show all
Defined in:
lib/cyber_source_merged_spec/controllers/notification_of_changes_controller.rb

Overview

NotificationOfChangesController

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, user_agent_parameters

Constructor Details

This class inherits a constructor from CyberSourceMergedSpec::BaseController

Instance Method Details

#get_notification_of_change_report(start_time, end_time) ⇒ ApiResponse

Download the Notification of Change report. This report shows eCheck-related fields updated as a result of a response to an eCheck settlement transaction. in ISO 8601 format Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor 14) Example date format: - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z) ISO 8601 format Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor 14) Example date format: - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)

Parameters:

  • start_time (DateTime) —

    Required parameter: Valid report Start Time

  • end_time (DateTime) —

    Required parameter: Valid report End Time in

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/cyber_source_merged_spec/controllers/notification_of_changes_controller.rb', line 25

def get_notification_of_change_report(start_time,
                                      end_time)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/reporting/v3/notification-of-changes',
                                 Server::DEFAULT)
               .query_param(new_parameter(start_time, key: 'startTime')
                             .is_required(true))
               .query_param(new_parameter(end_time, key: 'endTime')
                             .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(ReportingV3NotificationofChangesGet200Response.method(:from_hash))
                .is_api_response(true)
                .local_error('400',
                             'Invalid request',
                             ReportingV3NotificationofChangesGet400ResponseException)
                .local_error('401',
                             'Unauthorized. Token provided is no more valid.',
                             APIException)
                .local_error('404',
                             'Report not found',
                             ReportingV3NotificationofChangesGet404ResponseException)
                .local_error('500',
                             'Internal Server Error',
                             ReportingV3NotificationofChangesGet500ResponseException))
    .execute
end