Package com.stripe.model.reporting

Class ReportType

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.reporting.ReportType
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class ReportType extends ApiResource implements HasId
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.

  • Constructor Details

    • ReportType

      public ReportType()

  • Method Details

    • list

      public static ReportTypeCollection list(Map<String,Object> params) throws StripeException
      Returns a full list of Report Types.
      Throws:
      StripeException

    • list

      public static ReportTypeCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      Returns a full list of Report Types.
      Throws:
      StripeException

    • list

      public static ReportTypeCollection list(ReportTypeListParams params) throws StripeException
      Returns a full list of Report Types.
      Throws:
      StripeException

    • list

      public static ReportTypeCollection list(ReportTypeListParams params, RequestOptions options) throws StripeException
      Returns a full list of Report Types.
      Throws:
      StripeException

    • retrieve

      public static ReportType retrieve(String reportType) throws StripeException
      Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)
      Throws:
      StripeException

    • retrieve

      public static ReportType retrieve(String reportType, RequestOptions options) throws StripeException
      Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)
      Throws:
      StripeException

    • retrieve

      public static ReportType retrieve(String reportType, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)
      Throws:
      StripeException

    • retrieve

      public static ReportType retrieve(String reportType, ReportTypeRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)
      Throws:
      StripeException

    • getDataAvailableEnd

      public Long getDataAvailableEnd()
      Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.

    • getDataAvailableStart

      public Long getDataAvailableStart()
      Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.

    • getDefaultColumns

      public List<String> getDefaultColumns()
      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.)

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getName

      public String getName()
      Human-readable name of the Report Type.

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to reporting.report_type.

    • getUpdated

      public Long getUpdated()
      When this Report Type was latest updated. Measured in seconds since the Unix epoch.

    • getVersion

      public Long getVersion()
      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.

    • setDataAvailableEnd

      public void setDataAvailableEnd(Long dataAvailableEnd)
      Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.

    • setDataAvailableStart

      public void setDataAvailableStart(Long dataAvailableStart)
      Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.

    • setDefaultColumns

      public void setDefaultColumns(List<String> defaultColumns)
      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.)

    • setId

      public void setId(String id)
      The ID of the Report Type, such as balance.summary.1.

    • setLivemode

      public void setLivemode(Boolean livemode)
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • setName

      public void setName(String name)
      Human-readable name of the Report Type.

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to reporting.report_type.

    • setUpdated

      public void setUpdated(Long updated)
      When this Report Type was latest updated. Measured in seconds since the Unix epoch.

    • setVersion

      public void setVersion(Long version)
      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.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      The ID of the Report Type, such as balance.summary.1.
      Specified by:
      getId in interface HasId