openmeter 1.0.0b53__py3-none-any.whl → 2.0.0__py3-none-any.whl

openmeter/types/notifications/rule_list_params.py

@@ -0,0 +1,54 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["RuleListParams"]
+
+
+class RuleListParams(TypedDict, total=False):
+    channel: List[str]
+    """Filtering by multiple notifiaction channel ids.
+
+    Usage: `?channel=01ARZ3NDEKTSV4RRFFQ69G5FAV&channel=01J8J2Y5X4NNGQS32CF81W95E3`
+    """
+
+    feature: List[str]
+    """Filtering by multiple feature ids/keys.
+
+    Usage: `?feature=feature-1&feature=feature-2`
+    """
+
+    include_deleted: Annotated[bool, PropertyInfo(alias="includeDeleted")]
+    """Include deleted notification rules in response.
+
+    Usage: `?includeDeleted=true`
+    """
+
+    include_disabled: Annotated[bool, PropertyInfo(alias="includeDisabled")]
+    """Include disabled notification rules in response.
+
+    Usage: `?includeDisabled=false`
+    """
+
+    order: Literal["ASC", "DESC"]
+    """The order direction."""
+
+    order_by: Annotated[Literal["id", "type", "createdAt", "updatedAt"], PropertyInfo(alias="orderBy")]
+    """The order by field."""
+
+    page: int
+    """Start date-time in RFC 3339 format.
+
+    Inclusive.
+    """
+
+    page_size: Annotated[int, PropertyInfo(alias="pageSize")]
+    """Number of items per page.
+
+    Default is 100.
+    """

openmeter/types/notifications/rule_list_response.py

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+from .notification_rule import NotificationRule
+
+__all__ = ["RuleListResponse"]
+
+
+class RuleListResponse(BaseModel):
+    items: List[NotificationRule]
+    """The items in the current page."""
+
+    page: int
+    """The items in the current page."""
+
+    page_size: int = FieldInfo(alias="pageSize")
+    """The items in the current page."""
+
+    total_count: int = FieldInfo(alias="totalCount")
+    """The items in the current page."""

openmeter/types/notifications/rule_update_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Iterable
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["RuleUpdateParams", "Threshold"]
+
+
+class RuleUpdateParams(TypedDict, total=False):
+    channels: Required[List[str]]
+    """List of notification channels the rule is applied to."""
+
+    name: Required[str]
+    """The user friendly name of the notification rule."""
+
+    thresholds: Required[Iterable[Threshold]]
+    """List of thresholds the rule suppose to be triggered."""
+
+    type: Required[Literal["entitlements.balance.threshold"]]
+    """Notification rule type."""
+
+    disabled: bool
+    """Whether the rule is disabled or not."""
+
+    features: List[str]
+    """Optional field for defining the scope of notification by feature.
+
+    It may contain features by id or key.
+    """
+
+
+class Threshold(TypedDict, total=False):
+    type: Required[Literal["PERCENT", "NUMBER"]]
+    """Type of the rule in the balance threshold specification."""
+
+    value: Required[float]
+    """Value of the threshold."""

openmeter/types/notifications/webhook_svix_params.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["WebhookSvixParams"]
+
+
+class WebhookSvixParams(TypedDict, total=False):
+    data: Required[Dict[str, str]]
+    """The payload of the Svix operational webhook request."""
+
+    type: Required[
+        Literal[
+            "endpoint.created",
+            "endpoint.deleted",
+            "endpoint.disabled",
+            "endpoint.updated",
+            "message.attempt.exhausted",
+            "message.attempt.failing",
+            "message.attempt.recovered",
+        ]
+    ]
+    """The type of the Svix operational webhook request."""

openmeter/types/portal/__init__.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .portal_token import PortalToken as PortalToken
+from .token_list_params import TokenListParams as TokenListParams
+from .meter_query_params import MeterQueryParams as MeterQueryParams
+from .token_create_params import TokenCreateParams as TokenCreateParams
+from .token_list_response import TokenListResponse as TokenListResponse
+from .token_invalidate_params import TokenInvalidateParams as TokenInvalidateParams

openmeter/types/portal/meter_query_params.py

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, List, Union
+from datetime import datetime
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["MeterQueryParams"]
+
+
+class MeterQueryParams(TypedDict, total=False):
+    filter_group_by: Annotated[Dict[str, str], PropertyInfo(alias="filterGroupBy")]
+    """Simple filter for group bys with exact match.
+
+    Usage: `?filterGroupBy[type]=input&filterGroupBy[model]=gpt-4`
+    """
+
+    from_: Annotated[Union[str, datetime], PropertyInfo(alias="from", format="iso8601")]
+    """Start date-time in RFC 3339 format. Inclusive."""
+
+    group_by: Annotated[List[str], PropertyInfo(alias="groupBy")]
+    """
+    If not specified a single aggregate will be returned for each subject and time
+    window. `subject` is a reserved group by value.
+    """
+
+    to: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """End date-time in RFC 3339 format. Inclusive."""
+
+    window_size: Annotated[Literal["MINUTE", "HOUR", "DAY"], PropertyInfo(alias="windowSize")]
+    """
+    If not specified, a single usage aggregate will be returned for the entirety of
+    the specified period for each subject and group.
+    """
+
+    window_time_zone: Annotated[str, PropertyInfo(alias="windowTimeZone")]
+    """
+    The value is the name of the time zone as defined in the IANA Time Zone Database
+    (http://www.iana.org/time-zones). If not specified, the UTC timezone will be
+    used.
+    """

openmeter/types/portal/portal_token.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["PortalToken"]
+
+
+class PortalToken(BaseModel):
+    subject: str
+
+    id: Optional[str] = None
+
+    token: Optional[str] = None
+    """The token is only returned at creation."""
+
+    allowed_meter_slugs: Optional[List[str]] = FieldInfo(alias="allowedMeterSlugs", default=None)
+    """Optional, if defined only the specified meters will be allowed"""
+
+    created_at: Optional[datetime] = FieldInfo(alias="createdAt", default=None)
+
+    expired: Optional[bool] = None
+
+    expires_at: Optional[datetime] = FieldInfo(alias="expiresAt", default=None)

openmeter/types/portal/token_create_params.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["TokenCreateParams"]
+
+
+class TokenCreateParams(TypedDict, total=False):
+    subject: Required[str]
+
+    allowed_meter_slugs: Annotated[List[str], PropertyInfo(alias="allowedMeterSlugs")]
+    """Optional, if defined only the specified meters will be allowed"""

openmeter/types/portal/token_invalidate_params.py

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["TokenInvalidateParams"]
+
+
+class TokenInvalidateParams(TypedDict, total=False):
+    id: str
+    """Invalidate a portal token by ID."""
+
+    subject: str
+    """Invalidate all portal tokens for a subject."""

openmeter/types/portal/token_list_params.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+__all__ = ["TokenListParams"]
+
+
+class TokenListParams(TypedDict, total=False):
+    limit: int
+    """Number of portal tokens to return. Default is 25."""

openmeter/types/portal/token_list_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .portal_token import PortalToken
+
+__all__ = ["TokenListResponse"]
+
+TokenListResponse = List[PortalToken]

openmeter/types/shared/__init__.py

@@ -0,0 +1,3 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .meter_query_result import MeterQueryResult as MeterQueryResult

openmeter/types/subject.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["Subject"]
+
+
+class Subject(BaseModel):
+    id: str
+    """A unique identifier for the subject."""
+
+    key: str
+    """A unique, human-readable identifier for the subject."""
+
+    current_period_end: Optional[datetime] = FieldInfo(alias="currentPeriodEnd", default=None)
+    """
+    [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in
+    UTC.
+    """
+
+    current_period_start: Optional[datetime] = FieldInfo(alias="currentPeriodStart", default=None)
+    """
+    [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in
+    UTC.
+    """
+
+    display_name: Optional[str] = FieldInfo(alias="displayName", default=None)
+    """A human-readable display name for the subject."""
+
+    metadata: Optional[Dict[str, object]] = None
+
+    stripe_customer_id: Optional[str] = FieldInfo(alias="stripeCustomerId", default=None)

openmeter/types/subject_list_response.py

@@ -0,0 +1,9 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+
+from .subject import Subject
+
+__all__ = ["SubjectListResponse"]
+
+SubjectListResponse = List[Subject]

openmeter/types/subject_param.py

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SubjectParam"]
+
+
+class SubjectParam(TypedDict, total=False):
+    key: Required[str]
+
+    current_period_end: Annotated[Union[str, datetime, None], PropertyInfo(alias="currentPeriodEnd", format="iso8601")]
+
+    current_period_start: Annotated[
+        Union[str, datetime, None], PropertyInfo(alias="currentPeriodStart", format="iso8601")
+    ]
+
+    display_name: Annotated[Optional[str], PropertyInfo(alias="displayName")]
+
+    metadata: Optional[Dict[str, object]]
+
+    stripe_customer_id: Annotated[Optional[str], PropertyInfo(alias="stripeCustomerId")]

openmeter/types/subject_upsert_params.py

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Dict, Union, Iterable, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["SubjectUpsertParams", "Body"]
+
+
+class SubjectUpsertParams(TypedDict, total=False):
+    body: Required[Iterable[Body]]
+
+
+class Body(TypedDict, total=False):
+    key: Required[str]
+    """A unique, human-readable identifier for the subject."""
+
+    current_period_end: Annotated[Union[str, datetime], PropertyInfo(alias="currentPeriodEnd", format="iso8601")]
+    """
+    [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in
+    UTC.
+    """
+
+    current_period_start: Annotated[Union[str, datetime], PropertyInfo(alias="currentPeriodStart", format="iso8601")]
+    """
+    [RFC3339](https://tools.ietf.org/html/rfc3339) formatted date-time string in
+    UTC.
+    """
+
+    display_name: Annotated[Optional[str], PropertyInfo(alias="displayName")]
+    """A human-readable display name for the subject."""
+
+    metadata: Optional[Dict[str, object]]
+
+    stripe_customer_id: Annotated[Optional[str], PropertyInfo(alias="stripeCustomerId")]

openmeter/types/subject_upsert_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from .subject import Subject
+
+__all__ = ["SubjectUpsertResponse"]
+
+SubjectUpsertResponse: TypeAlias = List[Subject]

openmeter/types/subjects/__init__.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .entitlement_value import EntitlementValue as EntitlementValue
+from .entitlement_list_params import EntitlementListParams as EntitlementListParams
+from .entitlement_reset_params import EntitlementResetParams as EntitlementResetParams
+from .entitlement_value_params import EntitlementValueParams as EntitlementValueParams
+from .entitlement_create_params import EntitlementCreateParams as EntitlementCreateParams
+from .entitlement_list_response import EntitlementListResponse as EntitlementListResponse
+from .entitlement_history_params import EntitlementHistoryParams as EntitlementHistoryParams
+from .entitlement_override_params import EntitlementOverrideParams as EntitlementOverrideParams
+from .entitlement_history_response import EntitlementHistoryResponse as EntitlementHistoryResponse

openmeter/types/subjects/entitlement_history_params.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from datetime import datetime
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["EntitlementHistoryParams"]
+
+
+class EntitlementHistoryParams(TypedDict, total=False):
+    subject_id_or_key: Required[Annotated[str, PropertyInfo(alias="subjectIdOrKey")]]
+
+    window_size: Required[Annotated[Literal["MINUTE", "HOUR", "DAY"], PropertyInfo(alias="windowSize")]]
+    """Windowsize"""
+
+    from_: Annotated[Union[str, datetime], PropertyInfo(alias="from", format="iso8601")]
+    """Start of time range to query entitlement: date-time in RFC 3339 format.
+
+    Defaults to the last reset. Gets truncated to the granularity of the underlying
+    meter.
+    """
+
+    to: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """End of time range to query entitlement: date-time in RFC 3339 format.
+
+    Defaults to now. If not now then gets truncated to the granularity of the
+    underlying meter.
+    """
+
+    window_time_zone: Annotated[str, PropertyInfo(alias="windowTimeZone")]
+    """The timezone used when calculating the windows."""

openmeter/types/subjects/entitlement_history_response.py

@@ -0,0 +1,98 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = [
+    "EntitlementHistoryResponse",
+    "BurndownHistory",
+    "BurndownHistoryGrantUsage",
+    "BurndownHistoryPeriod",
+    "WindowedHistory",
+    "WindowedHistoryPeriod",
+]
+
+
+class BurndownHistoryGrantUsage(BaseModel):
+    grant_id: str = FieldInfo(alias="grantId")
+    """The id of the grant"""
+
+    usage: float
+    """The usage in the period"""
+
+
+class BurndownHistoryPeriod(BaseModel):
+    from_: datetime = FieldInfo(alias="from")
+    """Period start time."""
+
+    to: datetime
+    """Period end time."""
+
+
+class BurndownHistory(BaseModel):
+    balance_at_end: float = FieldInfo(alias="balanceAtEnd")
+    """The entitlement balance at the end of the period."""
+
+    balance_at_start: float = FieldInfo(alias="balanceAtStart")
+    """entitlement balance at the start of the period."""
+
+    grant_balances_at_end: Dict[str, float] = FieldInfo(alias="grantBalancesAtEnd")
+    """
+    The balance breakdown of each active grant at the end of the period: GrantID:
+    Balance
+    """
+
+    grant_balances_at_start: Dict[str, float] = FieldInfo(alias="grantBalancesAtStart")
+    """
+    The balance breakdown of each active grant at the start of the period: GrantID:
+    Balance
+    """
+
+    grant_usages: List[BurndownHistoryGrantUsage] = FieldInfo(alias="grantUsages")
+    """Which grants were actually burnt down in the period and by what amount."""
+
+    overage: float
+    """Overuse that wasn't covered by grants."""
+
+    period: BurndownHistoryPeriod
+    """A period with a start and end time."""
+
+    usage: float
+    """The total usage of the grant in the period."""
+
+
+class WindowedHistoryPeriod(BaseModel):
+    from_: datetime = FieldInfo(alias="from")
+    """Period start time."""
+
+    to: datetime
+    """Period end time."""
+
+
+class WindowedHistory(BaseModel):
+    balance_at_start: float = FieldInfo(alias="balanceAtStart")
+    """The entitlement balance at the start of the period."""
+
+    period: WindowedHistoryPeriod
+    """A period with a start and end time."""
+
+    usage: float
+    """The total usage of the feature in the period."""
+
+
+class EntitlementHistoryResponse(BaseModel):
+    burndown_history: List[BurndownHistory] = FieldInfo(alias="burndownHistory")
+    """Grant burndown history."""
+
+    windowed_history: List[WindowedHistory] = FieldInfo(alias="windowedHistory")
+    """The windowed balance history.
+
+    - It only returns rows for windows where there was usage.
+    - The windows are inclusive at their start and exclusive at their end.
+    - The last window may be smaller than the window size and is inclusive at both
+      ends.
+    """

openmeter/types/subjects/entitlement_list_response.py

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List
+from typing_extensions import TypeAlias
+
+from ..entitlement import Entitlement
+
+__all__ = ["EntitlementListResponse"]
+
+EntitlementListResponse: TypeAlias = List[Entitlement]

openmeter/types/subjects/entitlements/__init__.py

@@ -0,0 +1,8 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .entitlement_grant import EntitlementGrant as EntitlementGrant
+from .grant_list_params import GrantListParams as GrantListParams
+from .grant_create_params import GrantCreateParams as GrantCreateParams
+from .grant_list_response import GrantListResponse as GrantListResponse