viam-sdk 0.25.2__py3-none-linux_armv7l.whl → 0.62.0__py3-none-linux_armv7l.whl

viam/app/billing_client.py

@@ -5,6 +5,8 @@ from grpclib.client import Channel, Stream
 from viam import logging
 from viam.proto.app.billing import (
     BillingServiceStub,
+    CreateInvoiceAndChargeImmediatelyRequest,
+    CreateInvoiceAndChargeImmediatelyResponse,
     GetCurrentMonthUsageRequest,
     GetCurrentMonthUsageResponse,
     GetInvoicePdfRequest,
@@ -40,16 +42,14 @@ class BillingClient:
 
         async def main():
             # Make a ViamClient
-            viam_client = await connect()
-            # Instantiate a BillingClient to run billing client API methods on
-            billing_client = viam_client.billing_client
-
-            viam_client.close()
+            async with await connect() as viam_client:
+                # Instantiate a BillingClient to run billing client API methods on
+                billing_client = viam_client.billing_client
 
         if __name__ == '__main__':
             asyncio.run(main())
 
-    For more information, see `Billing Client API <https://docs.viam.com/appendix/apis/billing-client/>`_.
+    For more information, see `Billing Client API <https://docs.viam.com/dev/reference/apis/billing-client/>`_.
     """
 
     def __init__(self, channel: Channel, metadata: Mapping[str, str]):
@@ -72,15 +72,15 @@ class BillingClient:
 
         ::
 
-           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/>`_.
+        For more information, see `Billing Client API <https://docs.viam.com/dev/reference/apis/billing-client/#getcurrentmonthusage>`_.
         """
         request = GetCurrentMonthUsageRequest(org_id=org_id)
         return await self._billing_client.GetCurrentMonthUsage(request, metadata=self._metadata, timeout=timeout)
@@ -90,14 +90,14 @@ class BillingClient:
 
         ::
 
-            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/>`_.
+        For more information, see `Billing Client API <https://docs.viam.com/dev/reference/apis/billing-client/#getinvoicepdf>`_.
         """
         stream: Stream[GetInvoicePdfRequest, GetInvoicePdfResponse]
         async with self._billing_client.GetInvoicePdf.open(timeout=timeout, metadata=self._metadata) as stream:
@@ -111,15 +111,15 @@ class BillingClient:
 
         ::
 
-            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/>`_.
+        For more information, see `Billing Client API <https://docs.viam.com/dev/reference/apis/billing-client/#getinvoicessummary>`_.
         """
         request = GetInvoicesSummaryRequest(org_id=org_id)
         return await self._billing_client.GetInvoicesSummary(request, metadata=self._metadata, timeout=timeout)
@@ -129,15 +129,57 @@ class BillingClient:
 
         ::
 
-            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/>`_.
+        For more information, see `Billing Client API <https://docs.viam.com/dev/reference/apis/billing-client/#getorgbillinginformation>`_.
         """
         request = GetOrgBillingInformationRequest(org_id=org_id)
         return await self._billing_client.GetOrgBillingInformation(request, metadata=self._metadata, timeout=timeout)
+
+    async def create_invoice_and_charge_immediately(
+        self,
+        org_id_to_charge: str,
+        amount: float,
+        description: Optional[str] = None,
+        org_id_for_branding: Optional[str] = None,
+        disable_email: bool = False,
+    ) -> CreateInvoiceAndChargeImmediatelyResponse:
+        """Create a flat fee invoice and charge the organization on the spot. The caller must be an owner of the organization being charged.
+        This function returns the invoice id once the payment intent is successfully sent for processing. Callers may poll the invoice for
+        its status using the `get_invoices_summary` function and the returned invoice id. The status will be "payment_processing" if the
+        payment is being processed, "paid" if it succeeds, or "outstanding" if it fails.
+
+        ::
+
+            invoice_id = await billing_client.create_invoice_and_charge_immediately(
+                "<ORG-ID-TO-CHARGE>",
+                <AMOUNT>,
+                <DESCRIPTION>,
+                "<ORG-ID-FOR-BRANDING>",
+                False,
+            )
+
+        Args:
+            org_id_to_charge (str): the organization to charge
+            amount (float): the amount to charge in dollars
+            description (str): a short description of the charge to display on the invoice PDF (must be 100 characters or less)
+            org_id_for_branding (str): the organization whose branding to use in the invoice confirmation email
+            disable_email (bool): whether or not to disable sending an email confirmation for the invoice
+
+        Returns:
+            viam.proto.app.billing.CreateInvoiceAndChargeImmediatelyResponse: the invoice id
+        """
+        request = CreateInvoiceAndChargeImmediatelyRequest(
+            org_id_to_charge=org_id_to_charge,
+            amount=amount,
+            description=description,
+            org_id_for_branding=org_id_for_branding,
+            disable_email=disable_email,
+        )
+        return await self._billing_client.CreateInvoiceAndChargeImmediately(request, metadata=self._metadata)