Class ReportRunsResource

Index

Constructors

Methods

create retrieve list

Constructors

constructor

new ReportRunsResource(): ReportRunsResource
Returns ReportRunsResource

Methods

create

create(
params: Stripe.Reporting.ReportRunCreateParams,
options?: RequestOptions,
): Promise<Response<Stripe.Reporting.ReportRun>>
Creates a new object and begin running the report. (Certain report types require a live-mode API key.)
Parameters
- params: Stripe.Reporting.ReportRunCreateParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Reporting.ReportRun>>
- Defined in node_modules/stripe/types/Reporting/ReportRunsResource.d.ts:732

retrieve

retrieve(
    id: string,
    params?: ReportRunRetrieveParams,
    options?: RequestOptions,
): Promise<Response<Stripe.Reporting.ReportRun>>
Retrieves the details of an existing Report Run.
Parameters
- id: string
- Optionalparams: ReportRunRetrieveParams
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Reporting.ReportRun>>
- Defined in node_modules/stripe/types/Reporting/ReportRunsResource.d.ts:740
retrieve(
id: string,
options?: RequestOptions,
): Promise<Response<Stripe.Reporting.ReportRun>>
Retrieves the details of an existing Report Run.
Parameters
- id: string
- Optionaloptions: RequestOptions
Returns Promise<Response<Stripe.Reporting.ReportRun>>
- Defined in node_modules/stripe/types/Reporting/ReportRunsResource.d.ts:745

list

list(
params?: ReportRunListParams,
options?: RequestOptions,
): ApiListPromise<Stripe.Reporting.ReportRun>
Returns a list of Report Runs, with the most recent appearing first.
Parameters
- Optionalparams: ReportRunListParams
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Reporting.ReportRun>
- Defined in node_modules/stripe/types/Reporting/ReportRunsResource.d.ts:753
list(options?: RequestOptions): ApiListPromise<Stripe.Reporting.ReportRun>
Returns a list of Report Runs, with the most recent appearing first.
Parameters
- Optionaloptions: RequestOptions
Returns ApiListPromise<Stripe.Reporting.ReportRun>
- Defined in node_modules/stripe/types/Reporting/ReportRunsResource.d.ts:757