ledgerv1beta

type AccountEntry struct {

	// It's the entry id.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Account version at the time.
	Version int64 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// Operation: debit or credit.
	Operation Operation `protobuf:"varint,3,opt,name=operation,proto3,enum=ledger.v1beta.Operation" json:"operation,omitempty"`
	// Amount (in cents).
	Amount int64 `protobuf:"varint,4,opt,name=amount,proto3" json:"amount,omitempty"`
	// Event that generated the transaction
	Event int32 `protobuf:"varint,5,opt,name=event,proto3" json:"event,omitempty"`
	// Transaction date received on creation.
	CompetenceDate *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=competence_date,json=competenceDate,proto3" json:"competence_date,omitempty"`
	// The entry metadata.
	Metadata *structpb.Struct `protobuf:"bytes,7,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// The account responsible for the entry.
	Account string `protobuf:"bytes,8,opt,name=account,proto3" json:"account,omitempty"`
	// contains filtered or unexported fields
}

type AccountResult struct {

	// The account name
	Account string `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
	// credit
	Credit int64 `protobuf:"varint,2,opt,name=credit,proto3" json:"credit,omitempty"`
	// debit
	Debit int64 `protobuf:"varint,3,opt,name=debit,proto3" json:"debit,omitempty"`
	// contains filtered or unexported fields
}

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

type CheckResponse struct {

	// Server status.
	Status CheckResponse_ServingStatus `protobuf:"varint,1,opt,name=status,proto3,enum=ledger.v1beta.CheckResponse_ServingStatus" json:"status,omitempty"`
	// contains filtered or unexported fields
}

type CheckResponse_ServingStatus int32

type CreateTransactionRequest struct {

	// ID (UUID) to link the entries to a transaction.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The list of entries, where len(entries) must be >= 2.
	Entries []*Entry `protobuf:"bytes,2,rep,name=entries,proto3" json:"entries,omitempty"`
	// The transaction competence date (execution date).
	CompetenceDate *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=competence_date,json=competenceDate,proto3" json:"competence_date,omitempty"`
	// The ledgers owner. Eg.: company name
	Company string `protobuf:"bytes,4,opt,name=company,proto3" json:"company,omitempty"`
	// The event which triggered the transaction.
	Event uint32 `protobuf:"varint,5,opt,name=event,proto3" json:"event,omitempty"`
	// contains filtered or unexported fields
}

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

type Entry struct {

	// It's the idempotency key, and must be unique (UUID).
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Account involved in the operation.
	Account string `protobuf:"bytes,2,opt,name=account,proto3" json:"account,omitempty"`
	// To deal with optimistic lock.
	ExpectedVersion int64 `protobuf:"varint,3,opt,name=expected_version,json=expectedVersion,proto3" json:"expected_version,omitempty"`
	// Operation: debit or credit.
	Operation Operation `protobuf:"varint,4,opt,name=operation,proto3,enum=ledger.v1beta.Operation" json:"operation,omitempty"`
	// Amount (in cents).
	Amount int64 `protobuf:"varint,5,opt,name=amount,proto3" json:"amount,omitempty"`
	// The entry metadata.
	Metadata *structpb.Struct `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

type GetAccountBalanceRequest struct {

	// The account name, can be either a synthetic or an analytical one.
	Account string `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
	// Start date for calculating account balance, INCLUSIVE.
	// If passed, the version will be the most recent one within the interval.
	StartDate *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"`
	// End date for calculating account balance, EXCLUSIVE.
	// If passed, the version will be the most recent one within the interval.
	EndDate *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_date,json=endDate,proto3" json:"end_date,omitempty"`
	// contains filtered or unexported fields
}

type GetAccountBalanceResponse struct {

	// The account name.
	Account string `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
	// The account version.
	// When a synthetic account is passed, -1 will be returned.
	// If either start_date or end_date is passed, the value will be the most recent one within the interval.
	CurrentVersion int64 `protobuf:"varint,2,opt,name=current_version,json=currentVersion,proto3" json:"current_version,omitempty"`
	// The account balance.
	Balance int64 `protobuf:"varint,3,opt,name=balance,proto3" json:"balance,omitempty"`
	// contains filtered or unexported fields
}

type GetSyntheticReportFilters struct {

	// The level of the account path
	Level int32 `protobuf:"varint,1,opt,name=level,proto3" json:"level,omitempty"`
	// contains filtered or unexported fields
}

type GetSyntheticReportRequest struct {

	// The account that's going to be queried.
	Account string `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
	// Start date of the range (timestamp).
	StartDate *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"`
	// End date of the range (timestamp).
	EndDate *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_date,json=endDate,proto3" json:"end_date,omitempty"`
	// Optional filters
	Filters *GetSyntheticReportFilters `protobuf:"bytes,4,opt,name=filters,proto3" json:"filters,omitempty"` // TODO use gRPC pagination
	// contains filtered or unexported fields
}

type GetSyntheticReportResponse struct {

	// All credit accumulated
	TotalCredit int64 `protobuf:"varint,2,opt,name=total_credit,json=totalCredit,proto3" json:"total_credit,omitempty"`
	// All debit accumulated
	TotalDebit int64 `protobuf:"varint,3,opt,name=total_debit,json=totalDebit,proto3" json:"total_debit,omitempty"`
	// The paths
	Results []*AccountResult `protobuf:"bytes,4,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

type HealthAPIClient interface {
	// Check - checks the system health.
	Check(ctx context.Context, in *CheckRequest, opts ...grpc.CallOption) (*CheckResponse, error)
}

type HealthAPIServer interface {
	// Check - checks the system health.
	Check(context.Context, *CheckRequest) (*CheckResponse, error)
}

type LedgerAPIClient interface {
	CreateTransaction(ctx context.Context, in *CreateTransactionRequest, opts ...grpc.CallOption) (*CreateTransactionResponse, error)
	GetAccountBalance(ctx context.Context, in *GetAccountBalanceRequest, opts ...grpc.CallOption) (*GetAccountBalanceResponse, error)
	ListAccountEntries(ctx context.Context, in *ListAccountEntriesRequest, opts ...grpc.CallOption) (*ListAccountEntriesResponse, error)
	GetSyntheticReport(ctx context.Context, in *GetSyntheticReportRequest, opts ...grpc.CallOption) (*GetSyntheticReportResponse, error)
}

type LedgerAPIServer interface {
	CreateTransaction(context.Context, *CreateTransactionRequest) (*CreateTransactionResponse, error)
	GetAccountBalance(context.Context, *GetAccountBalanceRequest) (*GetAccountBalanceResponse, error)
	ListAccountEntries(context.Context, *ListAccountEntriesRequest) (*ListAccountEntriesResponse, error)
	GetSyntheticReport(context.Context, *GetSyntheticReportRequest) (*GetSyntheticReportResponse, error)
}

type ListAccountEntriesRequest struct {

	// The account path
	Account string `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
	// Start history date
	StartDate *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"`
	// End history date
	EndDate *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=end_date,json=endDate,proto3" json:"end_date,omitempty"`
	// Filters
	Filter *ListAccountEntriesRequest_Filter `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Pagination
	Page *RequestPagination `protobuf:"bytes,5,opt,name=page,proto3" json:"page,omitempty"`
	// contains filtered or unexported fields
}

type ListAccountEntriesRequest_Filter struct {

	// Companies
	Companies []string `protobuf:"bytes,1,rep,name=companies,proto3" json:"companies,omitempty"`
	// Events
	Events []int32 `protobuf:"varint,2,rep,packed,name=events,proto3" json:"events,omitempty"`
	// Operation
	Operation Operation `protobuf:"varint,3,opt,name=operation,proto3,enum=ledger.v1beta.Operation" json:"operation,omitempty"`
	// contains filtered or unexported fields
}

type ListAccountEntriesResponse struct {

	// List of entries of a given account
	Entries []*AccountEntry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// Cursor that references the next page. Empty string if there is no next page
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

type Operation int32

type RequestPagination struct {

	// Max of 50, defaults to 10.
	PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Cursor for the next page.
	PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedHealthAPIServer struct {
}

type UnimplementedLedgerAPIServer struct {
}

type UnsafeHealthAPIServer interface {
	// contains filtered or unexported methods
}

type UnsafeLedgerAPIServer interface {
	// contains filtered or unexported methods
}