class Stripe::ReportingReportType

Overview

The Report Type resource corresponds to a particular type of report, such as the "Activity summary" or "Itemized payouts" reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters. Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.

Included Modules

Defined in:

stripe/models/reporting_report_type.cr

Constant Summary

ERROR_MESSAGE_FOR_OBJECT = "invalid value for \"object\", must be one of [reporting.report_type]."
MAX_LENGTH_FOR_ID = 5000
MAX_LENGTH_FOR_NAME = 5000
VALID_VALUES_FOR_OBJECT = String.static_array("reporting.report_type")

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, clone clone, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, data_available_end : Int64 | Nil = nil, data_available_start : Int64 | Nil = nil, default_columns : Array(String) | Nil = nil, id : String | Nil = nil, livemode : Bool | Nil = nil, name : String | Nil = nil, object : String | Nil = nil, updated : Int64 | Nil = nil, version : Int64 | Nil = nil) #

Initializes the object @param [Hash] attributes Model attributes in the form of hash


[View source]

Instance Method Detail

def ==(other : self) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def data_available_end : Int64 | Nil #

[View source]
def data_available_end=(new_value : Int64 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] data_available_end Object to be assigned


[View source]
def data_available_start : Int64 | Nil #

[View source]
def data_available_start=(new_value : Int64 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] data_available_start Object to be assigned


[View source]
def default_columns : Array(String) | Nil #

[View source]
def default_columns=(new_value : Array(String) | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] default_columns Object to be assigned


[View source]
def hash(hasher) #

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code


def id : String | Nil #

[View source]
def id=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned


[View source]
def list_invalid_properties : Array(String) #

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons


[View source]
def livemode : Bool | Nil #

[View source]
def livemode=(new_value : Bool | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] livemode Object to be assigned


[View source]
def name : String | Nil #

[View source]
def name=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] name Object to be assigned


[View source]
def object : String | Nil #

[View source]
def object=(new_value : String | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] object Object to be assigned


[View source]
def updated : Int64 | Nil #

[View source]
def updated=(new_value : Int64 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] updated Object to be assigned


[View source]
def valid? : Bool #

Check to see if the all the properties in the model are valid @return true if the model is valid


[View source]
def version : Int64 | Nil #

[View source]
def version=(new_value : Int64 | Nil) #

Custom attribute writer method checking allowed values (enum). @param [Object] version Object to be assigned


[View source]