expensify

Documentation

Index

• func LoadCookiesFromJSON(filePath string) ([]*http.Cookie, error)
• type Client
  • func NewClient(partnerUserID, partnerUserSecret string) (*Client, error)
  • func (c *Client) ConfigureFileExport(config FileExportConfig, sendEmailOnFinish *OnFinishSendEmail, ...) error
  • func (c *Client) DownloadReport(ctx context.Context, report *ExpensifyReport) error
  • func (c *Client) ExecuteFileExport(ctx context.Context, reportFields []string, expenseFields []string) ([]*ExpensifyReport, error)
• type ExpensifyReport
  • func (er *ExpensifyReport) WriteToDisk(ctx context.Context, filePath string) error
• type FileExportConfig
• type Image
  • func GetImage(url string, cookies []*http.Cookie) (*Image, error)
  • func (i *Image) WriteToDisk(path string) error
• type OnFinishMarkAsExported
• type OnFinishSendEmail
• type OnFinishSftpUploadData

Functions

func LoadCookiesFromJSON

func LoadCookiesFromJSON(filePath string) ([]*http.Cookie, error)

loadCookiesFromJSON reads cookies from a JSON file and returns them

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a struct to hold the ExpensifyClient information

func NewClient

func NewClient(partnerUserID, partnerUserSecret string) (*Client, error)

NewClient creates a new ExpensifyClient

func (*Client) ConfigureFileExport

func (c *Client) ConfigureFileExport(config FileExportConfig,
	sendEmailOnFinish *OnFinishSendEmail,
	markAsExportedOnFinish *OnFinishMarkAsExported,
	uploadToSftpOnFinish *OnFinishSftpUploadData,
) error

func (*Client) DownloadReport

func (c *Client) DownloadReport(ctx context.Context, report *ExpensifyReport) error

DownloadReport downloads the data of exported report

func (*Client) ExecuteFileExport

func (c *Client) ExecuteFileExport(ctx context.Context, reportFields []string, expenseFields []string) ([]*ExpensifyReport, error)

ExecuteFileExport configures the export request. Everything that is marked a point is nullable (meaning it is optional to configure) -filterByMarkedAsApprovedTag : pass the tag you are looking for

type ExpensifyReport

type ExpensifyReport struct {
	FileName   string `json:"fileName"`
	FileSystem string `json:"fileSystem"`
	Data       []byte `json:"data"`
}

func (*ExpensifyReport) WriteToDisk

func (er *ExpensifyReport) WriteToDisk(ctx context.Context, filePath string) error

type FileExportConfig

type FileExportConfig struct {
	FilterByReportId              []string
	FilterByPolicyId              []string
	FilterByStartDate             *time.Time
	FilterByEndDate               *time.Time
	FilterByApprovedAfterDate     *time.Time
	FilterByMarkedAsApprovedTag   *string
	FilterByEmployeeEmail         *string
	FilterByReportState           []string
	LimitNumberOfReportsExported  *int
	OutputFileExtension           string
	OutputFileBaseName            *string
	OutputIncludeFullPageReceipts bool
	IsThisAtestCall               bool
}

type Image

type Image struct {
	FileName string
	FileExt  string
	Data     []byte
}

Image struct holds the file name, file extension, and data

func GetImage

func GetImage(url string, cookies []*http.Cookie) (*Image, error)

GetImage get image downloads the image from a URL, it requires a set of active session cookies

func (*Image) WriteToDisk

func (i *Image) WriteToDisk(path string) error

type OnFinishMarkAsExported

type OnFinishMarkAsExported struct {
	Label string `json:"label"`
}

type OnFinishSendEmail

type OnFinishSendEmail struct {
	Recipients []string `json:"recipients"`
	Message    string   `json:"message"`
}

type OnFinishSftpUploadData

type OnFinishSftpUploadData struct {
	SftpData struct {
		Host     string `json:"host"`
		Login    string `json:"login"`
		Password string `json:"password"`
		Port     int    `json:"port"`
	} `json:"sftpData"`
}