1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.api.integration.billing;
import com.yahoo.config.provision.TenantName;
import java.time.ZonedDateTime;
import java.util.List;
import java.util.Map;
import java.util.Optional;
/**
* Interface that talks about bills in the billing API. It is a layer on top of the SQL
* database where we store data about bills.
*
* @author olaa
* @author ogronnesby
*/
public interface BillingDatabaseClient {
boolean setActivePaymentInstrument(InstrumentOwner paymentInstrument);
Optional<InstrumentOwner> getDefaultPaymentInstrumentForTenant(TenantName from);
/**
* Create a completely new Bill in the open state with no LineItems.
*
* @param tenant The name of the tenant the bill is for
* @param agent The agent that created the bill
* @return The Id of the new bill
*/
Bill.Id createBill(TenantName tenant, ZonedDateTime startTime, ZonedDateTime endTime, String agent);
/**
* Read the given bill from the data source
*
* @param billId The Id of the bill to retrieve
* @return The Bill if it exists, Optional.empty() if not.
*/
Optional<Bill> readBill(Bill.Id billId);
/**
* Get all bills for a given tenant, ordered by date
*
* @param tenant The name of the tenant
* @return List of all bills ordered by date
*/
List<Bill> readBillsForTenant(TenantName tenant);
/**
* Read all bills, ordered by date
* @return List of all bills ordered by date
*/
List<Bill> readBills();
/**
* Add a line item to an open bill
*
* @param lineItem The line item to add
* @param billId The optional ID of the bill this line item is for
* @return The Id of the new line item
* @throws RuntimeException if the bill is not in OPEN state
*/
String addLineItem(TenantName tenantName, Bill.LineItem lineItem, Optional<Bill.Id> billId);
/**
* Set status for the given bill
*
* @param billId The ID of the bill this status is for
* @param agent The agent that added the status
* @param status The new status of the bill
*/
void setStatus(Bill.Id billId, String agent, BillStatus status);
List<Bill.LineItem> getUnusedLineItems(TenantName tenantName);
/**
* Delete a line item
* This is only allowed if the line item has not yet been associated with an bill
*
* @param lineItemId The ID of the line item
* @throws RuntimeException if the line item is associated with an bill
*/
void deleteLineItem(String lineItemId);
/**
* Associate all uncommitted line items to a given bill
* This is only allowed if the line item has not already been associated with an bill
*
* @param tenantName The tenant we want to commit line items for
* @param billId The ID of the line item
* @throws RuntimeException if the line item is already associated with an bill
*/
void commitLineItems(TenantName tenantName, Bill.Id billId);
/**
* Return the plan for the given tenant
*
* @param tenantName The tenant to retrieve the plan for
* @return Optional.of the plan if present in DN, else Optional.empty
*/
Optional<Plan> getPlan(TenantName tenantName);
/**
* Return the plan for the given tenants if present.
* If the database does not know of the tenant, the tenant is not included in the result.
*/
Map<TenantName, Optional<Plan>> getPlans(List<TenantName> tenants);
/**
* Returns a map with the count of plan usage. Plans that are not in use will not appear in this result.
*/
default Map<Plan, Long> getPlanCount(List<TenantName> tenants, Plan defaultPlan) {
return Map.of();
}
/**
* Set the current plan for the given tenant
*
* @param tenantName The tenant to set the plan for
* @param plan The plan to use
*/
void setPlan(TenantName tenantName, Plan plan);
/**
* Deactivates the default payment instrument for a tenant, if it exists.
* Used during tenant deletion
*/
void deactivateDefaultPaymentInstrument(TenantName tenant);
/**
* Get the current collection method for the tenant - if one has persisted
* @return Optional.empty if no collection method has been persisted for the tenant
*/
Optional<CollectionMethod> getCollectionMethod(TenantName tenantName);
/**
* Set the collection method for the tenant
* @param tenantName The name of the tenant to set collection method for
* @param collectionMethod The collection method for the tenant
*/
void setCollectionMethod(TenantName tenantName, CollectionMethod collectionMethod);
/**
* Performs necessary maintenance operations
*/
void maintain();
/**
* Set the invoice id from an external system for the given bill
*/
void setExportedInvoiceId(Bill.Id billId, String invoiceId);
/**
* Set the invoice item id from an external system for the given line item
*/
void setExportedInvoiceItemId(String lineItemId, String invoiceItemId);
}
|
