Skip to content

Commit 407e33d

Browse files
authored
docs(billing): add missing documentation (#901)
1 parent b0fca26 commit 407e33d

File tree

1 file changed

+21
-0
lines changed
  • packages/clients/src/api/billing/v2alpha1

1 file changed

+21
-0
lines changed

packages/clients/src/api/billing/v2alpha1/api.gen.ts

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@ import type {
2424
* This API allows you to query your consumption. Billing API.
2525
*/
2626
export class API extends ParentAPI {
27+
/**
28+
* Get current month's consumption. The consumption reflects the amount of
29+
* money you have spent for the products you have used. The consumption value
30+
* is monetary and is not computed in real time.
31+
*
32+
* @param request - The request {@link GetConsumptionRequest}
33+
* @returns A Promise of GetConsumptionResponse
34+
*/
2735
getConsumption = (request: Readonly<GetConsumptionRequest> = {}) =>
2836
this.client.fetch<GetConsumptionResponse>(
2937
{
@@ -60,9 +68,22 @@ export class API extends ParentAPI {
6068
unmarshalListInvoicesResponse,
6169
)
6270

71+
/**
72+
* List invoices. List all your invoices, filtering by `start_date` and
73+
* `invoice_type`. Each invoice has its own ID.
74+
*
75+
* @param request - The request {@link ListInvoicesRequest}
76+
* @returns A Promise of ListInvoicesResponse
77+
*/
6378
listInvoices = (request: Readonly<ListInvoicesRequest> = {}) =>
6479
enrichForPagination('invoices', this.pageOfListInvoices, request)
6580

81+
/**
82+
* Download an invoice. Download a specific invoice, specified by its ID.
83+
*
84+
* @param request - The request {@link DownloadInvoiceRequest}
85+
* @returns A Promise of Blob
86+
*/
6687
downloadInvoice = (request: Readonly<DownloadInvoiceRequest>) =>
6788
this.client.fetch<Blob>({
6889
method: 'GET',

0 commit comments

Comments
 (0)