report

Documentation

Index

• func GenerateReport(data *GenerateReportParams) (*xendit.Report, *xendit.Error)
• func GenerateReportWithContext(ctx context.Context, data *GenerateReportParams) (*xendit.Report, *xendit.Error)
• func GetReport(data *GetReportParams) (*xendit.Report, *xendit.Error)
• func GetReportWithContext(ctx context.Context, data *GetReportParams) (*xendit.Report, *xendit.Error)
• type Client
  • func (c *Client) GenerateReport(data *GenerateReportParams) (*xendit.Report, *xendit.Error)
  • func (c *Client) GenerateReportWithContext(ctx context.Context, data *GenerateReportParams) (*xendit.Report, *xendit.Error)
  • func (c *Client) GetReport(data *GetReportParams) (*xendit.Report, *xendit.Error)
  • func (c *Client) GetReportWithContext(ctx context.Context, data *GetReportParams) (*xendit.Report, *xendit.Error)
• type Filter
• type GenerateReportParams
• type GetReportParams

Examples

• GenerateReport
• GetReport

Functions

func GenerateReport

func GenerateReport(data *GenerateReportParams) (*xendit.Report, *xendit.Error)

GenerateReport generates a report

Example

xendit.Opt.SecretKey = "examplesecretkey"

generateReport := GenerateReportParams{
	Type: "BALANCE_HISTORY", // "BALANCE_HISTORY", "TRANSACTIONS", "UPCOMING_TRANSACTIONS"
	Filter: Filter{
		From: "2020-01-01T00:00:00.000Z",
		To:   "2020-12-31T23:59:59.999Z",
	},
}

resp, err := GenerateReport(&generateReport)
if err != nil {
	log.Fatal(err.ErrorCode)
}

log.Printf("generated report: %+v\n", resp)

func GenerateReportWithContext

func GenerateReportWithContext(ctx context.Context, data *GenerateReportParams) (*xendit.Report, *xendit.Error)

GenerateReportWithContext generates a report with context

func GetReport

func GetReport(data *GetReportParams) (*xendit.Report, *xendit.Error)

GetReport gets a report

Example

xendit.Opt.SecretKey = "examplesecretkey"

getReport := GetReportParams{
	ReportID: "report_5c1b34a2-6ceb-4c24-aba9-c836bac82b28",
}

resp, err := GetReport(&getReport)
if err != nil {
	log.Fatal(err.ErrorCode)
}

log.Printf("retrieved report: %+v\n", resp)

func GetReportWithContext

func GetReportWithContext(ctx context.Context, data *GetReportParams) (*xendit.Report, *xendit.Error)

GetReportWithContext gets a report with context

Types

type Client

type Client struct {
	Opt          *xendit.Option
	APIRequester xendit.APIRequester
}

func (*Client) GenerateReport

func (c *Client) GenerateReport(data *GenerateReportParams) (*xendit.Report, *xendit.Error)

GenerateReport creates a report

func (*Client) GenerateReportWithContext

func (c *Client) GenerateReportWithContext(ctx context.Context, data *GenerateReportParams) (*xendit.Report, *xendit.Error)

GenerateReportWithContext creates a report with context

func (*Client) GetReport

func (c *Client) GetReport(data *GetReportParams) (*xendit.Report, *xendit.Error)

GetReport gets a report

func (*Client) GetReportWithContext

func (c *Client) GetReportWithContext(ctx context.Context, data *GetReportParams) (*xendit.Report, *xendit.Error)

GetReportWithContext gets a report with context

type Filter

type Filter struct {
	From string `json:"from"`
	To   string `json:"to"`
}

type GenerateReportParams

type GenerateReportParams struct {
	ForUserID     string `json:"-"`
	Type          string `json:"type" validate:"required"`
	Filter        Filter `json:"filter" validate:"required"`
	Format        string `json:"format"`
	Currency      string `json:"currency"`
	ReportVersion string `json:"report_version"`
}

type GetReportParams

type GetReportParams struct {
	ForUserID string `json:"-"`
	ReportID  string `json:"report_id" validate:"required"`
}