49571f1a23
To avoid including multiple months in a single invoice, we need all inspector's invoice commands to run in for specific period. See https://storjlabs.atlassian.net/browse/USR-725 Change-Id: I3637dc189234f02350daca8d897c21765762ea55
60 lines
2.0 KiB
Go
60 lines
2.0 KiB
Go
// Copyright (C) 2019 Storj Labs, Inc.
|
|
// See LICENSE for copying information.
|
|
|
|
package stripecoinpayments
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"storj.io/common/uuid"
|
|
)
|
|
|
|
// ErrProjectRecordExists is error class defining that such project record already exists.
|
|
var ErrProjectRecordExists = Error.New("invoice project record already exists")
|
|
|
|
// ProjectRecordsDB is interface for working with invoice project records.
|
|
//
|
|
// architecture: Database
|
|
type ProjectRecordsDB interface {
|
|
// Create creates new invoice project record with coupon usages and credits spendings in the DB.
|
|
Create(ctx context.Context, records []CreateProjectRecord, couponUsages []CouponUsage, creditsSpendings []CreditsSpending, start, end time.Time) error
|
|
// Check checks if invoice project record for specified project and billing period exists.
|
|
Check(ctx context.Context, projectID uuid.UUID, start, end time.Time) error
|
|
// Get returns record for specified project and billing period.
|
|
Get(ctx context.Context, projectID uuid.UUID, start, end time.Time) (*ProjectRecord, error)
|
|
// Consume consumes invoice project record.
|
|
Consume(ctx context.Context, id uuid.UUID) error
|
|
// ListUnapplied returns project records page with unapplied project records.
|
|
ListUnapplied(ctx context.Context, offset int64, limit int, start, end time.Time) (ProjectRecordsPage, error)
|
|
}
|
|
|
|
// CreateProjectRecord holds info needed for creation new invoice
|
|
// project record.
|
|
type CreateProjectRecord struct {
|
|
ProjectID uuid.UUID
|
|
Storage float64
|
|
Egress int64
|
|
Objects float64
|
|
}
|
|
|
|
// ProjectRecord holds project usage particular for billing period.
|
|
type ProjectRecord struct {
|
|
ID uuid.UUID
|
|
ProjectID uuid.UUID
|
|
Storage float64
|
|
Egress int64
|
|
Objects float64
|
|
PeriodStart time.Time
|
|
PeriodEnd time.Time
|
|
}
|
|
|
|
// ProjectRecordsPage holds project records and
|
|
// indicates if there is more data available
|
|
// and provides next offset.
|
|
type ProjectRecordsPage struct {
|
|
Records []ProjectRecord
|
|
Next bool
|
|
NextOffset int64
|
|
}
|