Function ReportRunsApiFp

Returns {
    createReportRun(tilled_account, ReportRunCreateParams, options?) => Promise<((axios?, basePath?) => AxiosPromise<ReportRun>)>;
    getReportRun(tilled_account, id, options?) => Promise<((axios?, basePath?) => AxiosPromise<ReportRun>)>;
    listReportRuns(tilled_account, ReportRunRetrieveParams, type?, status?, offset?, limit?, options?) => Promise<((axios?, basePath?) => AxiosPromise<ListReportRuns200Response>)>;
}

• createReportRun:function

  • createReportRun(tilled_account, ReportRunCreateParams, options?): Promise<((axios?, basePath?) => AxiosPromise<ReportRun>)>

  • Creates a Report Run.

    Summary

    Create a Report Run

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • ReportRunCreateParams: ReportRunCreateParams

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ReportRun>)>

• getReportRun:function

  • getReportRun(tilled_account, id, options?): Promise<((axios?, basePath?) => AxiosPromise<ReportRun>)>

  • Retrieves the details of an existing Report Run.

    Summary

    Get a Report Run

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • id: string

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ReportRun>)>

• listReportRuns:function

  • listReportRuns(tilled_account, ReportRunRetrieveParams, type?, status?, offset?, limit?, options?): Promise<((axios?, basePath?) => AxiosPromise<ListReportRuns200Response>)>

  • Returns a list of Report Runs. The Report Runs are sorted with the most recently created appearing first.

    Summary

    List all Report Runs

    Throws

    Parameters

    • tilled_account: string

      The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

    • ReportRunRetrieveParams: ReportRunRetrieveParams

    • Optional type: ListReportRunsType[]

      Only return ReportRuns whose type is included by this array. Examples: `?type=payments_summary_1,payouts_summary_2` and `?type=payouts_summary_2`.

    • Optional status: ListReportRunsStatus[]

      Only return ReportRuns whose status is included by this array. Examples: `?status=finished` and `?status=finished,queued`.

    • Optional offset: number

      The (zero-based) offset of the first item in the collection to return.

    • Optional limit: number

      The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

    • Optional options: RawAxiosRequestConfig<any>

      Override http request option.

    Returns Promise<((axios?, basePath?) => AxiosPromise<ListReportRuns200Response>)>