storj/satellite/payments/stripe/customers.go
Michal Niewrzal 8a50a3baa3 satellite/payments: rename 'stripecoinpayments' package to 'stripe'
Automatic rename. May require some more cleanups later.

Change-Id: I18220a4278056d25c41fb137832bb81f2b876ac1
2023-04-06 16:51:43 +00:00

54 lines
1.8 KiB
Go

// Copyright (C) 2019 Storj Labs, Inc.
// See LICENSE for copying information.
package stripe
import (
"context"
"time"
"storj.io/common/uuid"
"storj.io/storj/satellite/satellitedb/dbx"
)
// ErrNoCustomer is error class defining that there is no customer for user.
var ErrNoCustomer = Error.New("customer doesn't exist")
// CustomersDB is interface for working with stripe customers table.
//
// architecture: Database
type CustomersDB interface {
// Insert inserts a stripe customer into the database.
Insert(ctx context.Context, userID uuid.UUID, customerID string) error
// GetCustomerID return stripe customers id.
GetCustomerID(ctx context.Context, userID uuid.UUID) (string, error)
// GetUserID return userID given stripe customer id.
GetUserID(ctx context.Context, customerID string) (uuid.UUID, error)
// List returns page with customers ids created before specified date.
List(ctx context.Context, offset int64, limit int, before time.Time) (CustomersPage, error)
// UpdatePackage updates the customer's package plan and purchase time.
UpdatePackage(ctx context.Context, userID uuid.UUID, packagePlan *string, timestamp *time.Time) (*Customer, error)
// GetPackageInfo returns the package plan and time of purchase for a user.
GetPackageInfo(ctx context.Context, userID uuid.UUID) (packagePlan *string, purchaseTime *time.Time, err error)
// TODO: get rid of this.
Raw() *dbx.DB
}
// Customer holds customer id, user id, and package information.
type Customer struct {
ID string
UserID uuid.UUID
PackagePlan *string
PackagePurchasedAt *time.Time
}
// CustomersPage holds customers and
// indicates if there is more data available
// and provides next offset.
type CustomersPage struct {
Customers []Customer
Next bool
NextOffset int64
}