exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.Schemas.Reporting_reportRun (exoapi_stripe v0.1.4)

description: The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.

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.

:created :: :integer

Time at which the object was created. Measured in seconds since the Unix epoch.

:error :: ExOAPI.Stripe.Schemas.Error

If something should go wrong during the run, a message about the failure (populated when status=failed).

:id :: :string

Unique identifier for the object.

:livemode :: :boolean

true if the report is run on live mode data and false if it is run on test mode data.

:object :: :string

String representing the object's type. Objects of the same type share the same value.

:parameters :: ExOAPI.Stripe.Schemas.FinancialReportingFinanceReportRunRunParameters

:report_type :: :string

The ID of the report type to run, such as "balance.summary.1".

:result :: ExOAPI.Stripe.Schemas.File

The file object representing the result of the report run (populated when status=succeeded).

:status :: :string

Status of this report run. This will be pending when the run is initially created. When the run finishes, this will be set to succeeded and the result field will be populated. Rarely, we may encounter an error, at which point this will be set to failed and the error field will be populated.

:succeeded_at :: :integer

Timestamp at which this run successfully finished (populated when status=succeeded). Measured in seconds since the Unix epoch.

Link to this section Summary

Types

params()
t()

Functions

changeset(struct \\ %__MODULE__{}, params)

Link to this section Types

Link to this type

params()

View Source 
@type params() :: map()
Link to this type

t()

View Source 
@type t() :: %ExOAPI.Stripe.Schemas.Reporting_reportRun{
  created: integer() | nil,
  error: String.t() | nil,
  id: String.t() | nil,
  livemode: boolean() | nil,
  object: :"reporting.report_run" | nil,
  parameters:
    ExOAPI.Stripe.Schemas.FinancialReportingFinanceReportRunRunParameters.t()
    | nil,
  report_type: String.t() | nil,
  result: ExOAPI.EctoTypes.AnyOf.t() | nil,
  status: String.t() | nil,
  succeeded_at: integer() | nil
}

Link to this section Functions

Link to this function

changeset(struct \\ %__MODULE__{}, params)

View Source 
@spec changeset(t(), params()) :: Ecto.Changeset.t()