Class: StraddlePay::Resources::Reports

Inherits:
Base
  • Object
show all
Defined in:
lib/straddle_pay/resources/reports.rb

Overview

Generate reports from the Straddle API.

Constant Summary

Constants inherited from Base

Base::HEADER_KEYS

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from StraddlePay::Resources::Base

Instance Method Details

#total_customers_by_status(**options) ⇒ Hash

Get total customers grouped by status.

Parameters:

  • options (Hash) —

    optional filters

Returns:

  • (Hash) —

    report data



11
12
13
14
 
# File 'lib/straddle_pay/resources/reports.rb', line 11

def total_customers_by_status(**options)
  headers = extract_headers(options)
  @client.post("v1/reports/total_customers_by_status", options.empty? ? nil : options, headers: headers)
end