Class: CyberSource::PurchaseAndRefundDetailsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/api/purchase_and_refund_details_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default, config) ⇒ PurchaseAndRefundDetailsApi

Returns a new instance of PurchaseAndRefundDetailsApi.



19
20
21
22
 
# File 'lib/cybersource_rest_client/api/purchase_and_refund_details_api.rb', line 19

def initialize(api_client = ApiClient.default, config)
  @api_client = api_client
  @api_client.set_configuration(config)
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cybersource_rest_client/api/purchase_and_refund_details_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_purchase_and_refund_details(start_time, end_time, opts = {}) ⇒ ReportingV3PurchaseRefundDetailsGet200Response

Get Purchase and Refund Details Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.

Parameters:

  • start_time —

    Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)

  • end_time —

    Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organization_id (String) —

    Valid Organization Id

  • :payment_subtype (String) —

    Payment Subtypes. - ALL: All Payment Subtypes - VI : Visa - MC : Master Card - AX : American Express - DI : Discover - DP : Pinless Debit (default to ALL)

  • :view_by (String) —

    View results by Request Date or Submission Date. - requestDate : Request Date - submissionDate: Submission Date (default to requestDate)

  • :group_name (String) —

    Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds

  • :offset (Integer) —

    Offset of the Purchase and Refund Results.

  • :limit (Integer) —

    Results count per page. Range(1-2000) (default to 2000)

Returns:



35
36
37
38
 
# File 'lib/cybersource_rest_client/api/purchase_and_refund_details_api.rb', line 35

def get_purchase_and_refund_details(start_time, end_time, opts = {})
  data, status_code, headers = get_purchase_and_refund_details_with_http_info(start_time, end_time, opts)
  return data, status_code, headers
end

#get_purchase_and_refund_details_with_http_info(start_time, end_time, opts = {}) ⇒ Array<(ReportingV3PurchaseRefundDetailsGet200Response, Fixnum, Hash)>

Get Purchase and Refund Details Download the Purchase and Refund Details report. This report report includes all purchases and refund transactions, as well as all activities related to transactions resulting in an adjustment to the net proceeds.

Parameters:

  • start_time —

    Valid report Start Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)

  • end_time —

    Valid report End Time in **ISO 8601 format** Please refer the following link to know more about ISO 8601 format.[Rfc Date Format](xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) **Example date format:** - yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSSZ (e.g. 2018-01-01T00:00:00.000Z)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :organization_id (String) —

    Valid Organization Id

  • :payment_subtype (String) —

    Payment Subtypes. - ALL: All Payment Subtypes - VI : Visa - MC : Master Card - AX : American Express - DI : Discover - DP : Pinless Debit

  • :view_by (String) —

    View results by Request Date or Submission Date. - requestDate : Request Date - submissionDate: Submission Date

  • :group_name (String) —

    Valid CyberSource Group Name.User can define groups using CBAPI and Group Management Module in EBC2. Groups are collection of organizationIds

  • :offset (Integer) —

    Offset of the Purchase and Refund Results.

  • :limit (Integer) —

    Results count per page. Range(1-2000)

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/cybersource_rest_client/api/purchase_and_refund_details_api.rb', line 52

def get_purchase_and_refund_details_with_http_info(start_time, end_time, opts = {})

  if @api_client.config.debugging
      begin
        raise
            @api_client.config.logger.debug 'Calling API: PurchaseAndRefundDetailsApi.get_purchase_and_refund_details ...'
        rescue
            puts 'Cannot write to log'
        end
  end
  # verify the required parameter 'start_time' is set
  if @api_client.config.client_side_validation && start_time.nil?
    fail ArgumentError, "Missing the required parameter 'start_time' when calling PurchaseAndRefundDetailsApi.get_purchase_and_refund_details"
  end
  # verify the required parameter 'end_time' is set
  if @api_client.config.client_side_validation && end_time.nil?
    fail ArgumentError, "Missing the required parameter 'end_time' when calling PurchaseAndRefundDetailsApi.get_purchase_and_refund_details"
  end
  if @api_client.config.client_side_validation && !opts[:'organization_id'].nil? && opts[:'organization_id'].to_s.length > 32
    fail ArgumentError, 'invalid value for "opts[:"organization_id"]" when calling PurchaseAndRefundDetailsApi.get_purchase_and_refund_details, the character length must be smaller than or equal to 32.'
  end

  if @api_client.config.client_side_validation && !opts[:'organization_id'].nil? && opts[:'organization_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"organization_id"]" when calling PurchaseAndRefundDetailsApi.get_purchase_and_refund_details, the character length must be great than or equal to 1.'
  end

  #if @api_client.config.client_side_validation && !opts[:'organization_id'].nil? && opts[:'organization_id'] !~ Regexp.new(/[a-zA-Z0-9-_]+/)
    #fail ArgumentError, "invalid value for 'opts[:\"organization_id\"]' when calling PurchaseAndRefundDetailsApi.get_purchase_and_refund_details, must conform to the pattern /[a-zA-Z0-9-_]+/."
  #end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 2000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PurchaseAndRefundDetailsApi.get_purchase_and_refund_details, must be smaller than or equal to 2000.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PurchaseAndRefundDetailsApi.get_purchase_and_refund_details, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = 'reporting/v3/purchase-refund-details'

  # query parameters
  query_params = {}
  query_params[:'startTime'] = start_time
  query_params[:'endTime'] = end_time
  query_params[:'organizationId'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
  query_params[:'paymentSubtype'] = opts[:'payment_subtype'] if !opts[:'payment_subtype'].nil?
  query_params[:'viewBy'] = opts[:'view_by'] if !opts[:'view_by'].nil?
  query_params[:'groupName'] = opts[:'group_name'] if !opts[:'group_name'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/xml', 'text/csv'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json;charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ReportingV3PurchaseRefundDetailsGet200Response')
  if @api_client.config.debugging
    begin
    raise
        @api_client.config.logger.debug "API called: PurchaseAndRefundDetailsApi#get_purchase_and_refund_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
    rescue
        puts 'Cannot write to log'
    end
  end
  return data, status_code, headers
end