up-go

+ 📚 A Go abstraction over the Up Bank API: https://developer.up.com.au/docs.

- This is a WORK-IN-PROGRESS. Use at your own risk!

! This repository has no ties to Up.

API Coverage

The following API endpoints are currently covered by this package:

• List accounts.
• Get an account by id.
• List attachments.
• Get an attachment by id.
• List categories.
• Get a category by id.
• Add a category to a transaction.
• List tags.
• Add tags to a transaction.
• Remote tags from a transaction.
• List transactions.
• Get a transaction by id.
• List transactions by account.
• Utility - Ping.
• List webhooks.
• Create a webhook.
• Get a webhook by id.
• Delete webhook.
• Ping a webhook.
• List webhook logs.

Usage

Below is a basic example of how to get started with this package:

package main

import (
	"context"
	"fmt"
	"log/slog"
	"os"

	"github.com/jmpa-io/up-go"
)

func main() {

	// setup tracing.
	ctx := context.TODO()

	// retrieve token.
	token := os.Getenv("UP_TOKEN")

	// setup client.
	c, err := up.New(ctx, token, up.WithLogLevel(slog.LevelWarn))
	if err != nil {
		fmt.Printf("failed to setup client: %v\n", err)
		os.Exit(1)
	}

	// ping!
	p, err := c.Ping(ctx)
	if err != nil {
		fmt.Printf("failed to ping: %v\n", err)
		os.Exit(1)
	}
	fmt.Printf("%s\n", p.Meta.StatusEmoji)
}

For more explicit examples, see the cmd/*/main.go files for details.

License

This work is published under the MIT license.

Please see the LICENSE file for details.