Skip to content

docs(billing): add missing documentation #901

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 3, 2023
Merged

docs(billing): add missing documentation #901

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions packages/clients/src/api/billing/v2alpha1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ import type {
* This API allows you to query your consumption. Billing API.
*/
export class API extends ParentAPI {
/**
* Get current month's consumption. The consumption reflects the amount of
* money you have spent for the products you have used. The consumption value
* is monetary and is not computed in real time.
*
* @param request - The request {@link GetConsumptionRequest}
* @returns A Promise of GetConsumptionResponse
*/
getConsumption = (request: Readonly<GetConsumptionRequest> = {}) =>
this.client.fetch<GetConsumptionResponse>(
{
Expand Down Expand Up @@ -60,9 +68,22 @@ export class API extends ParentAPI {
unmarshalListInvoicesResponse,
)

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

/**
* Download an invoice. Download a specific invoice, specified by its ID.
*
* @param request - The request {@link DownloadInvoiceRequest}
* @returns A Promise of Blob
*/
downloadInvoice = (request: Readonly<DownloadInvoiceRequest>) =>
this.client.fetch<Blob>({
method: 'GET',
Expand Down