github.com/stripe/stripe-go/v76@v76.25.0/reporting_reporttype.go (about)

     1  //
     2  //
     3  // File generated from our OpenAPI spec
     4  //
     5  //
     6  
     7  package stripe
     8  
     9  // Returns a full list of Report Types.
    10  type ReportingReportTypeListParams struct {
    11  	ListParams `form:"*"`
    12  	// Specifies which fields in the response should be expanded.
    13  	Expand []*string `form:"expand"`
    14  }
    15  
    16  // AddExpand appends a new field to expand.
    17  func (p *ReportingReportTypeListParams) AddExpand(f string) {
    18  	p.Expand = append(p.Expand, &f)
    19  }
    20  
    21  // Retrieves the details of a Report Type. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)
    22  type ReportingReportTypeParams struct {
    23  	Params `form:"*"`
    24  	// Specifies which fields in the response should be expanded.
    25  	Expand []*string `form:"expand"`
    26  }
    27  
    28  // AddExpand appends a new field to expand.
    29  func (p *ReportingReportTypeParams) AddExpand(f string) {
    30  	p.Expand = append(p.Expand, &f)
    31  }
    32  
    33  // The Report Type resource corresponds to a particular type of report, such as
    34  // the "Activity summary" or "Itemized payouts" reports. These objects are
    35  // identified by an ID belonging to a set of enumerated values. See
    36  // [API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api)
    37  // for those Report Type IDs, along with required and optional parameters.
    38  //
    39  // Note that certain report types can only be run based on your live-mode data (not test-mode
    40  // data), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).
    41  type ReportingReportType struct {
    42  	APIResource
    43  	// Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
    44  	DataAvailableEnd int64 `json:"data_available_end"`
    45  	// Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
    46  	DataAvailableStart int64 `json:"data_available_start"`
    47  	// List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)
    48  	DefaultColumns []string `json:"default_columns"`
    49  	// The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.
    50  	ID string `json:"id"`
    51  	// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
    52  	Livemode bool `json:"livemode"`
    53  	// Human-readable name of the Report Type
    54  	Name string `json:"name"`
    55  	// String representing the object's type. Objects of the same type share the same value.
    56  	Object string `json:"object"`
    57  	// When this Report Type was latest updated. Measured in seconds since the Unix epoch.
    58  	Updated int64 `json:"updated"`
    59  	// Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.
    60  	Version int64 `json:"version"`
    61  }
    62  
    63  // ReportingReportTypeList is a list of ReportTypes as retrieved from a list endpoint.
    64  type ReportingReportTypeList struct {
    65  	APIResource
    66  	ListMeta
    67  	Data []*ReportingReportType `json:"data"`
    68  }