omnata-plugin-runtime 0.3.9a20__py3-none-any.whl → 0.3.9a23__py3-none-any.whl

omnata_plugin_runtime/omnata_plugin.py

@@ -4,6 +4,15 @@ Omnata Plugin Runtime.
 Includes data container classes and defines the contract for a plugin.
 """
 from __future__ import annotations
+import sys
+from typing import Union
+if tuple(sys.version_info[:2]) >= (3, 9):
+    # Python 3.9 and above
+    from typing import Annotated  # pylint: disable=ungrouped-imports
+else:
+    # Python 3.8 and below
+    from typing_extensions import Annotated
+
 
 import datetime
 import http
@@ -20,7 +29,7 @@ import jinja2
 import pandas
 import pydantic
 import pydantic.json
-from pydantic import parse_obj_as, root_validator
+from pydantic import Field, parse_obj_as, root_validator
 from dateutil.parser import parse
 from jinja2 import Environment
 from pydantic import BaseModel  # pylint: disable=no-name-in-module
@@ -1208,17 +1217,37 @@ class SnowflakeBillingEvent(BaseModel):
                 raise ValueError("start_timestamp must be timezone aware")
         return values
 
-class BillingEventRequest(BaseModel):
+class DailyBillingEventRequest(BaseModel):
     """
     Represents a request to provide billing events for that day.
+    These will occur at midnight, and cover the previous 24 hours.
+    Provides enough information for the plugin to create billing events for the day.
+    """
+
+    billing_schedule: Literal["DAILY"] = "DAILY"
+    billable_connections_inbound: int = 0
+    billable_connections_outbound: int = 0
+    # below is deprecated
+    has_active_inbound: bool = False
+    has_active_outbound: bool = False
+
+class MonthlyBillingEventRequest(BaseModel):
+    """
+    Represents a request to provide billing events for that month.
+    These will occur at midnight on the first of each month, and cover the whole previous month.
+    Currently, these exist to provide a way to bill for the number of active ngrok connections
+    and associated data overages.
     """
 
-    billing_schedule: Literal["DAILY"]
-    has_active_inbound: bool
-    has_active_outbound: bool
+    billing_schedule: Literal["MONTHLY"] = "MONTHLY"
+    distinct_active_ngrok_connections: int = 0
+    ngrok_data_usage_bytes: int = 0
+    # below is deprecated
+    has_active_inbound: bool = False
+    has_active_outbound: bool = False
 
 
-# BillingEventRequest = Annotated[Union[DailyBillingEventRequest,...],Field(discriminator='billing_schedule')]
+BillingEventRequest = Annotated[Union[DailyBillingEventRequest,MonthlyBillingEventRequest],Field(discriminator='billing_schedule')]
 
 
 class OmnataPlugin(ABC):

{omnata_plugin_runtime-0.3.9a20.dist-info → omnata_plugin_runtime-0.3.9a23.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.3.9a20
+Version: 0.3.9a23
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

{omnata_plugin_runtime-0.3.9a20.dist-info → omnata_plugin_runtime-0.3.9a23.dist-info}/RECORD

@@ -3,10 +3,10 @@ omnata_plugin_runtime/api.py,sha256=_N5ok5LN7GDO4J9n3yduXp3tpjmhpySY__U2baiygrs,
 omnata_plugin_runtime/configuration.py,sha256=at29ExowF_T4_2U9gY0BF4IVdwC-vDytmNRHL7UCWh8,34742
 omnata_plugin_runtime/forms.py,sha256=30CJB24TqfLYNnkplZdUbeqA-P9rUIBujVKXw_S-wKY,18371
 omnata_plugin_runtime/logging.py,sha256=bn7eKoNWvtuyTk7RTwBS9UARMtqkiICtgMtzq3KA2V0,3272
-omnata_plugin_runtime/omnata_plugin.py,sha256=oOB_PUU0qCUzJDEyKnlKo9_j-GVPugIEuf-0EthBJLU,88491
+omnata_plugin_runtime/omnata_plugin.py,sha256=oSDBMEL8gJK_MA6eiawG3ELuT_eka-YM-0AmIHHABNE,89659
 omnata_plugin_runtime/plugin_entrypoints.py,sha256=T6cGdEacgGxoMT9xWJ2DayeDanu8cO58kicdqKsp4Uw,27604
 omnata_plugin_runtime/rate_limiting.py,sha256=se6MftQI5NrVHaLb1hByPCgAESPQhkAgIG7KIU1clDU,16562
-omnata_plugin_runtime-0.3.9a20.dist-info/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
-omnata_plugin_runtime-0.3.9a20.dist-info/METADATA,sha256=esWe3xRYAzfhTMa27Qp_uYCz7kpU2AVaUb32NjuemfM,1603
-omnata_plugin_runtime-0.3.9a20.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-omnata_plugin_runtime-0.3.9a20.dist-info/RECORD,,
+omnata_plugin_runtime-0.3.9a23.dist-info/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
+omnata_plugin_runtime-0.3.9a23.dist-info/METADATA,sha256=5zxT-AufDn6CQdTZjq_FbgL_Px6DojX0RS-AfbtyBM4,1603
+omnata_plugin_runtime-0.3.9a23.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+omnata_plugin_runtime-0.3.9a23.dist-info/RECORD,,