Package com.stripe.service.v2.reporting

Class ReportRunService

java.lang.Object

com.stripe.net.ApiService

com.stripe.service.v2.reporting.ReportRunService

public final class ReportRunService
extends ApiService

Constructor Summary

Constructors

Constructor	Description
ReportRunService(StripeResponseGetter responseGetter)

Method Summary

Modifier and Type	Method	Description
ReportRun	create(ReportRunCreateParams params)	Initiates the generation of a ReportRun based on the specified report template and user-provided parameters.
ReportRun	create(ReportRunCreateParams params, RequestOptions options)	Initiates the generation of a ReportRun based on the specified report template and user-provided parameters.
ReportRun	retrieve(String id)	Fetches the current state and details of a previously created ReportRun.
ReportRun	retrieve(String id, RequestOptions options)	Fetches the current state and details of a previously created ReportRun.

Methods inherited from class com.stripe.net.ApiService

getResponseGetter, request, requestStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ReportRunService

public ReportRunService(StripeResponseGetter responseGetter)

Method Details

create

public ReportRun create(ReportRunCreateParams params)
                 throws StripeException,
RateLimitException

Initiates the generation of a ReportRun based on the specified report template and user-provided parameters. It's the starting point for obtaining report data, and returns a ReportRun object which can be used to track the progress and retrieve the results of the report.

Throws:

StripeException

RateLimitException

create

public ReportRun create(ReportRunCreateParams params,
 RequestOptions options)
                 throws StripeException,
RateLimitException

Initiates the generation of a ReportRun based on the specified report template and user-provided parameters. It's the starting point for obtaining report data, and returns a ReportRun object which can be used to track the progress and retrieve the results of the report.

Throws:

StripeException

RateLimitException

retrieve

public ReportRun retrieve(String id)
                   throws StripeException

Fetches the current state and details of a previously created ReportRun. If the ReportRun has succeeded, the endpoint will provide details for how to retrieve the results.

Throws:

StripeException

retrieve

public ReportRun retrieve(String id,
 RequestOptions options)
                   throws StripeException

Fetches the current state and details of a previously created ReportRun. If the ReportRun has succeeded, the endpoint will provide details for how to retrieve the results.

Throws:

StripeException