Function ReportRunsApiAxiosParamCreator

Returns {
    createReportRun: ((tilled_account, ReportRunCreateParams, options?) => Promise<RequestArgs>);
    getReportRun: ((tilled_account, id, options?) => Promise<RequestArgs>);
    listReportCustomColumns: ((tilled_account, report_type, options?) => Promise<RequestArgs>);
    listReportRuns: ((tilled_account, ReportRunRetrieveParams, type?, status?, offset?, limit?, options?) => Promise<RequestArgs>);
}

• createReportRun: ((tilled_account, ReportRunCreateParams, options?) => Promise<RequestArgs>)

  • • (tilled_account, ReportRunCreateParams, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getReportRun: ((tilled_account, id, options?) => Promise<RequestArgs>)

  • • (tilled_account, id, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• listReportCustomColumns: ((tilled_account, report_type, options?) => Promise<RequestArgs>)

  • • (tilled_account, report_type, options?): Promise<RequestArgs>

    • Retrieves a list of available columns for a given report run type.

      Summary

      List available columns for customization by report run type

      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.

      • report_type: string

      • Optional options: RawAxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

• listReportRuns: ((tilled_account, ReportRunRetrieveParams, type?, status?, offset?, limit?, options?) => Promise<RequestArgs>)

  • • (tilled_account, ReportRunRetrieveParams, type?, status?, offset?, limit?, options?): Promise<RequestArgs>

    • 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_2,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<RequestArgs>