Development

Midday go SDK

Midday is a platform for Invoicing, Time tracking, File reconciliation, Storage, Financial Overview & your own Assistant.

SDK Installation

To add the SDK as a dependency to your project:

go get github.com/midday-ai/midday-go

SDK Example Usage

Example

package main

import (
	"context"
	middaygo "github.com/midday-ai/midday-go"
	"github.com/midday-ai/midday-go/models/operations"
	"log"
)

func main() {
	ctx := context.Background()

	s := middaygo.New(
		middaygo.WithSecurity("MIDDAY_API_KEY"),
	)

	res, err := s.Transactions.List(ctx, operations.ListTransactionsRequest{
		Cursor: middaygo.String("eyJpZCI6IjEyMyJ9"),
		Sort: []string{
			"date",
			"desc",
		},
		PageSize: middaygo.Float64(50),
		Q:        middaygo.String("office supplies"),
		Categories: []string{
			"office-supplies",
			"travel",
		},
		Tags: []string{
			"tag-1",
			"tag-2",
		},
		Start: middaygo.String("2024-04-01T00:00:00.000Z"),
		End:   middaygo.String("2024-04-30T23:59:59.999Z"),
		Accounts: []string{
			"account-1",
			"account-2",
		},
		Assignees: []string{
			"user-1",
			"user-2",
		},
		Statuses: []string{
			"pending",
			"completed",
		},
		Recurring: []string{
			"monthly",
			"annually",
		},
		Attachments: operations.AttachmentsInclude.ToPointer(),
		AmountRange: []*float64{
			middaygo.Float64(100),
			middaygo.Float64(1000),
		},
		Amount: []string{
			"150.75",
			"299.99",
		},
		Type: operations.ListTransactionsTypeExpense.ToPointer(),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`Token`	http	HTTP Bearer	`MIDDAY_TOKEN`

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

package main

import (
	"context"
	middaygo "github.com/midday-ai/midday-go"
	"github.com/midday-ai/midday-go/models/operations"
	"log"
)

func main() {
	ctx := context.Background()

	s := middaygo.New(
		middaygo.WithSecurity("MIDDAY_API_KEY"),
	)

	res, err := s.Transactions.List(ctx, operations.ListTransactionsRequest{
		Cursor: middaygo.String("eyJpZCI6IjEyMyJ9"),
		Sort: []string{
			"date",
			"desc",
		},
		PageSize: middaygo.Float64(50),
		Q:        middaygo.String("office supplies"),
		Categories: []string{
			"office-supplies",
			"travel",
		},
		Tags: []string{
			"tag-1",
			"tag-2",
		},
		Start: middaygo.String("2024-04-01T00:00:00.000Z"),
		End:   middaygo.String("2024-04-30T23:59:59.999Z"),
		Accounts: []string{
			"account-1",
			"account-2",
		},
		Assignees: []string{
			"user-1",
			"user-2",
		},
		Statuses: []string{
			"pending",
			"completed",
		},
		Recurring: []string{
			"monthly",
			"annually",
		},
		Attachments: operations.AttachmentsInclude.ToPointer(),
		AmountRange: []*float64{
			middaygo.Float64(100),
			middaygo.Float64(1000),
		},
		Amount: []string{
			"150.75",
			"299.99",
		},
		Type: operations.ListTransactionsTypeExpense.ToPointer(),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Available Resources and Operations

Available methods

BankAccounts

List - List all bank accounts
Create - Create a bank account
Get - Retrieve a bank account
Delete - Delete a bank account
Update - Update a bank account

Customers

List - List all customers
Create - Create customer
Get - Retrieve a customer
Delete - Delete a customer
Update - Update a customer

Documents

List - List all documents
Get - Retrieve a document
Delete - Delete a document

Inbox

List - List all inbox items
Get - Retrieve a inbox item
Delete - Delete a inbox item
Update - Update a inbox item

Invoices

List - List all invoices
GetInvoicesPaymentStatus - Payment status
Summary - Invoice summary
Get - Retrieve a invoice
Delete - Delete a invoice

Metrics

Revenue - Revenue metrics
Profit - Profit metrics
BurnRate - Burn rate metrics
Runway - Runway metrics
Expenses - Expense metrics
Spending - Spending metrics

Search

Search - Search

Teams

List - List all teams
Get - Retrieve a team
Update - Update a team
Members - List all team members

Tracker

Delete - Delete a tracker entry

TrackerEntries

List - List all tracker entries

TrackerProjects

List - List all tracker projects
Create - Create a tracker project
Get - Retrieve a tracker project
Delete - Delete a tracker project
Update - Update a tracker project

Transactions

List - List all transactions
Create - Create a transaction
Get - Retrieve a transaction
Delete - Delete a transaction
Update - Update a transaction
CreateMany - Bulk create transactions
DeleteMany - Bulk delete transactions
UpdateMany - Bulk update transactions

Users

Get - Retrieve the current user
Update - Update the current user

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

package main

import (
	"context"
	middaygo "github.com/midday-ai/midday-go"
	"github.com/midday-ai/midday-go/models/operations"
	"github.com/midday-ai/midday-go/retry"
	"log"
	"models/operations"
)

func main() {
	ctx := context.Background()

	s := middaygo.New(
		middaygo.WithSecurity("MIDDAY_API_KEY"),
	)

	res, err := s.Transactions.List(ctx, operations.ListTransactionsRequest{
		Cursor: middaygo.String("eyJpZCI6IjEyMyJ9"),
		Sort: []string{
			"date",
			"desc",
		},
		PageSize: middaygo.Float64(50),
		Q:        middaygo.String("office supplies"),
		Categories: []string{
			"office-supplies",
			"travel",
		},
		Tags: []string{
			"tag-1",
			"tag-2",
		},
		Start: middaygo.String("2024-04-01T00:00:00.000Z"),
		End:   middaygo.String("2024-04-30T23:59:59.999Z"),
		Accounts: []string{
			"account-1",
			"account-2",
		},
		Assignees: []string{
			"user-1",
			"user-2",
		},
		Statuses: []string{
			"pending",
			"completed",
		},
		Recurring: []string{
			"monthly",
			"annually",
		},
		Attachments: operations.AttachmentsInclude.ToPointer(),
		AmountRange: []*float64{
			middaygo.Float64(100),
			middaygo.Float64(1000),
		},
		Amount: []string{
			"150.75",
			"299.99",
		},
		Type: operations.ListTransactionsTypeExpense.ToPointer(),
	}, operations.WithRetries(
		retry.Config{
			Strategy: "backoff",
			Backoff: &retry.BackoffStrategy{
				InitialInterval: 1,
				MaxInterval:     50,
				Exponent:        1.1,
				MaxElapsedTime:  100,
			},
			RetryConnectionErrors: false,
		}))
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

package main

import (
	"context"
	middaygo "github.com/midday-ai/midday-go"
	"github.com/midday-ai/midday-go/models/operations"
	"github.com/midday-ai/midday-go/retry"
	"log"
)

func main() {
	ctx := context.Background()

	s := middaygo.New(
		middaygo.WithRetryConfig(
			retry.Config{
				Strategy: "backoff",
				Backoff: &retry.BackoffStrategy{
					InitialInterval: 1,
					MaxInterval:     50,
					Exponent:        1.1,
					MaxElapsedTime:  100,
				},
				RetryConnectionErrors: false,
			}),
		middaygo.WithSecurity("MIDDAY_API_KEY"),
	)

	res, err := s.Transactions.List(ctx, operations.ListTransactionsRequest{
		Cursor: middaygo.String("eyJpZCI6IjEyMyJ9"),
		Sort: []string{
			"date",
			"desc",
		},
		PageSize: middaygo.Float64(50),
		Q:        middaygo.String("office supplies"),
		Categories: []string{
			"office-supplies",
			"travel",
		},
		Tags: []string{
			"tag-1",
			"tag-2",
		},
		Start: middaygo.String("2024-04-01T00:00:00.000Z"),
		End:   middaygo.String("2024-04-30T23:59:59.999Z"),
		Accounts: []string{
			"account-1",
			"account-2",
		},
		Assignees: []string{
			"user-1",
			"user-2",
		},
		Statuses: []string{
			"pending",
			"completed",
		},
		Recurring: []string{
			"monthly",
			"annually",
		},
		Attachments: operations.AttachmentsInclude.ToPointer(),
		AmountRange: []*float64{
			middaygo.Float64(100),
			middaygo.Float64(1000),
		},
		Amount: []string{
			"150.75",
			"299.99",
		},
		Type: operations.ListTransactionsTypeExpense.ToPointer(),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return apierrors.APIError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the List function may return the following errors:

Error Type	Status Code	Content Type
apierrors.APIError	4XX, 5XX	/

Example

package main

import (
	"context"
	"errors"
	middaygo "github.com/midday-ai/midday-go"
	"github.com/midday-ai/midday-go/models/apierrors"
	"github.com/midday-ai/midday-go/models/operations"
	"log"
)

func main() {
	ctx := context.Background()

	s := middaygo.New(
		middaygo.WithSecurity("MIDDAY_API_KEY"),
	)

	res, err := s.Transactions.List(ctx, operations.ListTransactionsRequest{
		Cursor: middaygo.String("eyJpZCI6IjEyMyJ9"),
		Sort: []string{
			"date",
			"desc",
		},
		PageSize: middaygo.Float64(50),
		Q:        middaygo.String("office supplies"),
		Categories: []string{
			"office-supplies",
			"travel",
		},
		Tags: []string{
			"tag-1",
			"tag-2",
		},
		Start: middaygo.String("2024-04-01T00:00:00.000Z"),
		End:   middaygo.String("2024-04-30T23:59:59.999Z"),
		Accounts: []string{
			"account-1",
			"account-2",
		},
		Assignees: []string{
			"user-1",
			"user-2",
		},
		Statuses: []string{
			"pending",
			"completed",
		},
		Recurring: []string{
			"monthly",
			"annually",
		},
		Attachments: operations.AttachmentsInclude.ToPointer(),
		AmountRange: []*float64{
			middaygo.Float64(100),
			middaygo.Float64(1000),
		},
		Amount: []string{
			"150.75",
			"299.99",
		},
		Type: operations.ListTransactionsTypeExpense.ToPointer(),
	})
	if err != nil {

		var e *apierrors.APIError
		if errors.As(err, &e) {
			// handle error
			log.Fatal(e.Error())
		}
	}
}

Server Selection

Override Server URL Per-Client

The default server can be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

package main

import (
	"context"
	middaygo "github.com/midday-ai/midday-go"
	"github.com/midday-ai/midday-go/models/operations"
	"log"
)

func main() {
	ctx := context.Background()

	s := middaygo.New(
		middaygo.WithServerURL("https://api.midday.ai"),
		middaygo.WithSecurity("MIDDAY_API_KEY"),
	)

	res, err := s.Transactions.List(ctx, operations.ListTransactionsRequest{
		Cursor: middaygo.String("eyJpZCI6IjEyMyJ9"),
		Sort: []string{
			"date",
			"desc",
		},
		PageSize: middaygo.Float64(50),
		Q:        middaygo.String("office supplies"),
		Categories: []string{
			"office-supplies",
			"travel",
		},
		Tags: []string{
			"tag-1",
			"tag-2",
		},
		Start: middaygo.String("2024-04-01T00:00:00.000Z"),
		End:   middaygo.String("2024-04-30T23:59:59.999Z"),
		Accounts: []string{
			"account-1",
			"account-2",
		},
		Assignees: []string{
			"user-1",
			"user-2",
		},
		Statuses: []string{
			"pending",
			"completed",
		},
		Recurring: []string{
			"monthly",
			"annually",
		},
		Attachments: operations.AttachmentsInclude.ToPointer(),
		AmountRange: []*float64{
			middaygo.Float64(100),
			middaygo.Float64(1000),
		},
		Amount: []string{
			"150.75",
			"299.99",
		},
		Type: operations.ListTransactionsTypeExpense.ToPointer(),
	})
	if err != nil {
		log.Fatal(err)
	}
	if res.Object != nil {
		// handle response
	}
}

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

import (
	"net/http"
	"time"
	"github.com/myorg/your-go-sdk"
)

var (
	httpClient = &http.Client{Timeout: 30 * time.Second}
	sdkClient  = sdk.New(sdk.WithClient(httpClient))
)

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Name		Name	Last commit message	Last commit date
Latest commit History 5 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
.speakeasy		.speakeasy
docs		docs
internal		internal
models		models
retry		retry
types		types
.gitattributes		.gitattributes
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
USAGE.md		USAGE.md
bankaccounts.go		bankaccounts.go
customers.go		customers.go
documents.go		documents.go
go.mod		go.mod
hero.jpg		hero.jpg
inbox.go		inbox.go
invoices.go		invoices.go
metrics.go		metrics.go
midday.go		midday.go
search.go		search.go
tags.go		tags.go
teams.go		teams.go
tracker.go		tracker.go
trackerentries.go		trackerentries.go
trackerprojects.go		trackerprojects.go
transactions.go		transactions.go
users.go		users.go

midday-ai/midday-go

Folders and files

Latest commit

History

Repository files navigation

Midday go SDK

Table of Contents

SDK Installation

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Available Resources and Operations

Retries

Error Handling

Example

Server Selection

Override Server URL Per-Client

Custom HTTP Client

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Uh oh!

Stars

Watchers

Forks

Uh oh!

Languages