Skip to content

DOCS-2903: Update billing_client.py #728

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 2 commits into from
Sep 13, 2024
Merged

DOCS-2903: Update billing_client.py #728

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc8e359
DOCS-2903: Update billing_client.py
npentrel Sep 12, 2024
0b27531
update
npentrel Sep 12, 2024
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
16 changes: 8 additions & 8 deletions src/viam/app/billing_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,13 @@ async def get_current_month_usage(self, org_id: str, timeout: Optional[float] =

::

usage = await viam_client.billing_client.get_current_month_usage("<ORG-ID>")
usage = await billing_client.get_current_month_usage("<ORG-ID>")

Args:
org_id (str): the ID of the organization to request usage data for

Returns:
viam.proto.app.billing.GetCurrentMonthUsageResponse: Current month usage information
viam.proto.app.billing.GetCurrentMonthUsageResponse: the current month usage information

For more information, see `Billing Client API <https://docs.viam.com/appendix/apis/billing-client/>`_.
"""
Expand All @@ -90,12 +90,12 @@ async def get_invoice_pdf(self, invoice_id: str, org_id: str, dest: str, timeout

::

await viam_client.billing_client.get_invoice_pdf("<INVOICE-ID>", "<ORG-ID>", "<FILENAME>")
await billing_client.get_invoice_pdf("<INVOICE-ID>", "<ORG-ID>", "invoice.pdf")

Args:
invoice_id (str): the ID of the invoice being requested
org_id (str): the ID of the org to request data from
dest (str): filepath to save the invoice to
dest (str): the filepath to save the invoice to

For more information, see `Billing Client API <https://docs.viam.com/appendix/apis/billing-client/>`_.
"""
Expand All @@ -111,13 +111,13 @@ async def get_invoices_summary(self, org_id: str, timeout: Optional[float] = Non

::

summary = await viam_client.billing_client.get_invoices_summary("<ORG-ID>")
summary = await billing_client.get_invoices_summary("<ORG-ID>")

Args:
org_id (str): the ID of the org to request data for

Returns:
viam.proto.app.billing.GetInvoicesSummaryResponse: Summary of org invoices
viam.proto.app.billing.GetInvoicesSummaryResponse: the summaries of all org invoices

For more information, see `Billing Client API <https://docs.viam.com/appendix/apis/billing-client/>`_.
"""
Expand All @@ -129,13 +129,13 @@ async def get_org_billing_information(self, org_id: str, timeout: Optional[float

::

information = await viam_client.billing_client.get_org_billing_information("<ORG-ID>")
information = await billing_client.get_org_billing_information("<ORG-ID>")

Args:
org_id (str): the ID of the org to request data for

Returns:
viam.proto.app.billing.GetOrgBillingInformationResponse: The org billing information
viam.proto.app.billing.GetOrgBillingInformationResponse: the org billing information

For more information, see `Billing Client API <https://docs.viam.com/appendix/apis/billing-client/>`_.
"""
Expand Down