reportrun

Documentation

Overview

Package reportrun provides the /reporting/report_runs APIs

Index

• func Get(id string, params *stripe.ReportingReportRunParams) (*stripe.ReportingReportRun, error)
• func New(params *stripe.ReportingReportRunParams) (*stripe.ReportingReportRun, error)
• type Client
  • func (c Client) Get(id string, params *stripe.ReportingReportRunParams) (*stripe.ReportingReportRun, error)
  • func (c Client) List(listParams *stripe.ReportingReportRunListParams) *Iter
  • func (c Client) New(params *stripe.ReportingReportRunParams) (*stripe.ReportingReportRun, error)
• type Iter
  • func List(params *stripe.ReportingReportRunListParams) *Iter
  • func (i *Iter) ReportingReportRun() *stripe.ReportingReportRun
  • func (i *Iter) ReportingReportRunList() *stripe.ReportingReportRunList

Functions

func Get

func Get(id string, params *stripe.ReportingReportRunParams) (*stripe.ReportingReportRun, error)

Retrieves the details of an existing Report Run.

func New

func New(params *stripe.ReportingReportRunParams) (*stripe.ReportingReportRun, error)

Creates a new object and begin running the report. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)

Types

type Client

type Client struct {
	B   stripe.Backend
	Key string
}

Client is used to invoke /reporting/report_runs APIs.

func (Client) Get

func (c Client) Get(id string, params *stripe.ReportingReportRunParams) (*stripe.ReportingReportRun, error)

Retrieves the details of an existing Report Run.

func (Client) List

func (c Client) List(listParams *stripe.ReportingReportRunListParams) *Iter

Returns a list of Report Runs, with the most recent appearing first.

func (Client) New

func (c Client) New(params *stripe.ReportingReportRunParams) (*stripe.ReportingReportRun, error)

Creates a new object and begin running the report. (Certain report types require a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).)

type Iter

type Iter struct {
	*stripe.Iter
}

Iter is an iterator for reporting report runs.

func List

func List(params *stripe.ReportingReportRunListParams) *Iter

Returns a list of Report Runs, with the most recent appearing first.

func (*Iter) ReportingReportRun

func (i *Iter) ReportingReportRun() *stripe.ReportingReportRun

ReportingReportRun returns the reporting report run which the iterator is currently pointing to.

func (*Iter) ReportingReportRunList

func (i *Iter) ReportingReportRunList() *stripe.ReportingReportRunList

ReportingReportRunList returns the current list object which the iterator is currently using. List objects will change as new API calls are made to continue pagination.