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

openmeter/types/meter_query_result.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["MeterQueryResult", "Data"]
+
+
+class Data(BaseModel):
+    value: float
+
+    window_end: datetime = FieldInfo(alias="windowEnd")
+
+    window_start: datetime = FieldInfo(alias="windowStart")
+
+    group_by: Optional[Dict[str, str]] = FieldInfo(alias="groupBy", default=None)
+
+    subject: Optional[str] = None
+    """The subject of the meter value."""
+
+
+class MeterQueryResult(BaseModel):
+    data: List[Data]
+
+    from_: Optional[datetime] = FieldInfo(alias="from", default=None)
+
+    to: Optional[datetime] = None
+
+    window_size: Optional[Literal["MINUTE", "HOUR", "DAY"]] = FieldInfo(alias="windowSize", default=None)
+    """Aggregation window size."""

openmeter/types/meters/__init__.py

@@ -0,0 +1,5 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .subject_list_response import SubjectListResponse as SubjectListResponse

openmeter/types/meters/subject_list_response.py

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

openmeter/types/notifications/__init__.py

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .rule_list_params import RuleListParams as RuleListParams
+from .event_list_params import EventListParams as EventListParams
+from .notification_rule import NotificationRule as NotificationRule
+from .notification_event import NotificationEvent as NotificationEvent
+from .rule_create_params import RuleCreateParams as RuleCreateParams
+from .rule_list_response import RuleListResponse as RuleListResponse
+from .rule_update_params import RuleUpdateParams as RuleUpdateParams
+from .channel_list_params import ChannelListParams as ChannelListParams
+from .event_list_response import EventListResponse as EventListResponse
+from .webhook_svix_params import WebhookSvixParams as WebhookSvixParams
+from .notification_channel import NotificationChannel as NotificationChannel
+from .channel_create_params import ChannelCreateParams as ChannelCreateParams
+from .channel_list_response import ChannelListResponse as ChannelListResponse
+from .channel_update_params import ChannelUpdateParams as ChannelUpdateParams

openmeter/types/notifications/channel_create_params.py

@@ -0,0 +1,34 @@
+# 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, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ChannelCreateParams"]
+
+
+class ChannelCreateParams(TypedDict, total=False):
+    name: Required[str]
+    """User friendly name of the channel."""
+
+    type: Required[Literal["WEBHOOK"]]
+    """Notification channel type."""
+
+    url: Required[str]
+    """Webhook URL where the notification is sent."""
+
+    custom_headers: Annotated[Dict[str, str], PropertyInfo(alias="customHeaders")]
+    """Custom HTTP headers sent as part of the webhook request."""
+
+    disabled: bool
+    """Whether the channel is disabled or not."""
+
+    signing_secret: Annotated[str, PropertyInfo(alias="signingSecret")]
+    """Signing secret used for webhook request validation on the receiving end.
+
+    Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
+    Recommended size: 24
+    """

openmeter/types/notifications/channel_list_params.py

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ChannelListParams"]
+
+
+class ChannelListParams(TypedDict, total=False):
+    include_deleted: Annotated[bool, PropertyInfo(alias="includeDeleted")]
+    """Include deleted notification channels in response.
+
+    Usage: `?includeDeleted=true`
+    """
+
+    include_disabled: Annotated[bool, PropertyInfo(alias="includeDisabled")]
+    """Include disabled notification channels 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/channel_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_channel import NotificationChannel
+
+__all__ = ["ChannelListResponse"]
+
+
+class ChannelListResponse(BaseModel):
+    items: List[NotificationChannel]
+    """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/channel_update_params.py

@@ -0,0 +1,34 @@
+# 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, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["ChannelUpdateParams"]
+
+
+class ChannelUpdateParams(TypedDict, total=False):
+    name: Required[str]
+    """User friendly name of the channel."""
+
+    type: Required[Literal["WEBHOOK"]]
+    """Notification channel type."""
+
+    url: Required[str]
+    """Webhook URL where the notification is sent."""
+
+    custom_headers: Annotated[Dict[str, str], PropertyInfo(alias="customHeaders")]
+    """Custom HTTP headers sent as part of the webhook request."""
+
+    disabled: bool
+    """Whether the channel is disabled or not."""
+
+    signing_secret: Annotated[str, PropertyInfo(alias="signingSecret")]
+    """Signing secret used for webhook request validation on the receiving end.
+
+    Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
+    Recommended size: 24
+    """

openmeter/types/notifications/event_list_params.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union
+from datetime import datetime
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["EventListParams"]
+
+
+class EventListParams(TypedDict, total=False):
+    channel: List[str]
+    """Filtering by multiple channel ids.
+
+    Usage: `?channel=01J8J4RXH778XB056JS088PCYT&channel=01J8J4S1R1G9EVN62RG23A9M6J`
+    """
+
+    feature: List[str]
+    """Filtering by multiple feature ids or keys.
+
+    Usage: `?feature=feature-1&feature=feature-2`
+    """
+
+    from_: Annotated[Union[str, datetime], PropertyInfo(alias="from", format="iso8601")]
+    """Start date-time in RFC 3339 format. Inclusive."""
+
+    order: Literal["ASC", "DESC"]
+    """The order direction."""
+
+    order_by: Annotated[Literal["id", "createdAt"], 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.
+    """
+
+    rule: List[str]
+    """Filtering by multiple rule ids.
+
+    Usage: `?rule=01J8J2XYZ2N5WBYK09EDZFBSZM&rule=01J8J4R4VZH180KRKQ63NB2VA5`
+    """
+
+    subject: List[str]
+    """Filtering by multiple subject ids or keys.
+
+    Usage: `?subject=subject-1&subject=subject-2`
+    """
+
+    to: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """End date-time in RFC 3339 format. Inclusive."""

openmeter/types/notifications/event_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_event import NotificationEvent
+
+__all__ = ["EventListResponse"]
+
+
+class EventListResponse(BaseModel):
+    items: List[NotificationEvent]
+    """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/notification_channel.py

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["NotificationChannel"]
+
+
+class NotificationChannel(BaseModel):
+    id: str
+    """Identifies the notification channel."""
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Timestamp of when the resource was created."""
+
+    name: str
+    """User friendly name of the channel."""
+
+    type: Literal["WEBHOOK"]
+    """Notification channel type."""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Timestamp of when the resource was last updated."""
+
+    url: str
+    """Webhook URL where the notification is sent."""
+
+    custom_headers: Optional[Dict[str, str]] = FieldInfo(alias="customHeaders", default=None)
+    """Custom HTTP headers sent as part of the webhook request."""
+
+    deleted_at: Optional[datetime] = FieldInfo(alias="deletedAt", default=None)
+    """Timestamp of when the resource was permanently deleted."""
+
+    disabled: Optional[bool] = None
+    """Whether the channel is disabled or not."""
+
+    signing_secret: Optional[str] = FieldInfo(alias="signingSecret", default=None)
+    """Signing secret used for webhook request validation on the receiving end.
+
+    Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
+    Recommended size: 24
+    """

openmeter/types/notifications/notification_event.py

@@ -0,0 +1,215 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..subject import Subject
+from ..._models import BaseModel
+from .notification_rule import NotificationRule
+from ..entitlements.feature import Feature
+from ..subjects.entitlement_value import EntitlementValue
+
+__all__ = [
+    "NotificationEvent",
+    "DeliveryStatus",
+    "DeliveryStatusChannel",
+    "Payload",
+    "PayloadData",
+    "PayloadDataEntitlement",
+    "PayloadDataEntitlementCurrentUsagePeriod",
+    "PayloadDataEntitlementUsagePeriod",
+    "PayloadDataThreshold",
+]
+
+
+class DeliveryStatusChannel(BaseModel):
+    id: str
+    """Identifies the notification channel."""
+
+    type: Literal["WEBHOOK"]
+    """Type of the notification channel."""
+
+
+class DeliveryStatus(BaseModel):
+    channel: DeliveryStatusChannel
+    """Metadata only fields of a notification channel."""
+
+    reason: str
+    """The reason of the last deliverry state update."""
+
+    state: Literal["SUCCESS", "FAILED", "SENDING", "PENDING"]
+    """The delivery state of the notification event to the channel."""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Timestamp of when the status was last updated in RFC 3339 format."""
+
+
+class PayloadDataEntitlementCurrentUsagePeriod(BaseModel):
+    from_: datetime = FieldInfo(alias="from")
+    """Period start time."""
+
+    to: datetime
+    """Period end time."""
+
+
+class PayloadDataEntitlementUsagePeriod(BaseModel):
+    anchor: datetime
+    """A date-time anchor to base the recurring period on."""
+
+    interval: Literal["DAY", "WEEK", "MONTH", "YEAR"]
+    """The unit of time for the interval. One of: `day`, `week`, `month`, or `year`."""
+
+
+class PayloadDataEntitlement(BaseModel):
+    id: str
+    """Readonly unique ULID identifier."""
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Timestamp of when the resource was created."""
+
+    current_usage_period: PayloadDataEntitlementCurrentUsagePeriod = FieldInfo(alias="currentUsagePeriod")
+    """A period with a start and end time."""
+
+    feature_id: str = FieldInfo(alias="featureId")
+    """The feature the subject is entitled to use."""
+
+    feature_key: str = FieldInfo(alias="featureKey")
+    """The feature the subject is entitled to use."""
+
+    last_reset: datetime = FieldInfo(alias="lastReset")
+    """The time the last reset happened."""
+
+    measure_usage_from: datetime = FieldInfo(alias="measureUsageFrom")
+    """The time from which usage is measured.
+
+    If not specified on creation, defaults to entitlement creation time.
+    """
+
+    subject_key: str = FieldInfo(alias="subjectKey")
+    """The identifier key unique to the subject"""
+
+    type: Literal["metered"]
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Timestamp of when the resource was last updated."""
+
+    usage_period: PayloadDataEntitlementUsagePeriod = FieldInfo(alias="usagePeriod")
+    """Recurring period with an interval and an anchor."""
+
+    deleted_at: Optional[datetime] = FieldInfo(alias="deletedAt", default=None)
+    """Timestamp of when the resource was permanently deleted."""
+
+    is_soft_limit: Optional[bool] = FieldInfo(alias="isSoftLimit", default=None)
+    """
+    If softLimit=true the subject can use the feature even if the entitlement is
+    exhausted, hasAccess will always be true.
+    """
+
+    issue_after_reset: Optional[float] = FieldInfo(alias="issueAfterReset", default=None)
+    """
+    You can grant usage automatically alongside the entitlement, the example
+    scenario would be creating a starting balance. If an amount is specified here, a
+    grant will be created alongside the entitlement with the specified amount. That
+    grant will have it's rollover settings configured in a way that after each reset
+    operation, the balance will return the original amount specified here. Manually
+    creating such a grant would mean having the "amount", "minRolloverAmount", and
+    "maxRolloverAmount" fields all be the same.
+    """
+
+    issue_after_reset_priority: Optional[int] = FieldInfo(alias="issueAfterResetPriority", default=None)
+    """Defines the grant priority for the default grant."""
+
+    is_unlimited: Optional[bool] = FieldInfo(alias="isUnlimited", default=None)
+    """Deprecated, ignored by the backend.
+
+    Please use isSoftLimit instead; this field will be removed in the future.
+    """
+
+    metadata: Optional[Dict[str, str]] = None
+    """
+    Set of key-value pairs. Metadata can be used to store additional information
+    about a resource.
+    """
+
+    preserve_overage_at_reset: Optional[bool] = FieldInfo(alias="preserveOverageAtReset", default=None)
+    """If true, the overage is preserved at reset. If false, the usage is reset to 0."""
+
+
+class PayloadDataThreshold(BaseModel):
+    type: Literal["PERCENT", "NUMBER"]
+    """Type of the rule in the balance threshold specification."""
+
+    value: float
+    """Value of the threshold."""
+
+
+class PayloadData(BaseModel):
+    entitlement: PayloadDataEntitlement
+    """
+    Metered entitlements are useful for many different use cases, from setting up
+    usage based access to implementing complex credit systems. Access is determined
+    based on feature usage using a balance calculation (the "usage allowance"
+    provided by the issued grants is "burnt down" by the usage).
+    """
+
+    feature: Feature
+    """
+    Represents a feature that can be enabled or disabled for a plan. Used both for
+    product catalog and entitlements.
+    """
+
+    subject: Subject
+    """A subject is a unique identifier for a user or entity."""
+
+    threshold: PayloadDataThreshold
+    """Threshold value with multiple supported types."""
+
+    value: EntitlementValue
+    """Entitlements are the core of OpenMeter access management.
+
+    They define access to features for subjects. Entitlements can be metered,
+    boolean, or static.
+    """
+
+
+class Payload(BaseModel):
+    id: str
+    """A unique identifier for the notification event the payload belongs to."""
+
+    data: PayloadData
+    """
+    Data of the payload for notification event with `entitlements.balance.threshold`
+    type.
+    """
+
+    timestamp: datetime
+    """Timestamp when the notification event was created in RFC 3339 format."""
+
+    type: Literal["entitlements.balance.threshold"]
+    """Type of the notification event."""
+
+
+class NotificationEvent(BaseModel):
+    id: str
+    """A unique identifier of the notification event."""
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Timestamp when the notification event was created in RFC 3339 format."""
+
+    delivery_status: List[DeliveryStatus] = FieldInfo(alias="deliveryStatus")
+    """The delivery status of the notification event."""
+
+    payload: Payload
+    """Payload for notification event with `entitlements.balance.threshold` type."""
+
+    rule: NotificationRule
+    """Notification rule with entitlements.balance.threshold type."""
+
+    type: Literal["entitlements.balance.threshold"]
+    """Type of the notification event."""
+
+    annotations: Optional[Dict[str, object]] = None
+    """Set of key-value pairs managed by the system. Cannot be modified by user."""

openmeter/types/notifications/notification_rule.py

@@ -0,0 +1,70 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from datetime import datetime
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["NotificationRule", "Channel", "Threshold", "Feature"]
+
+
+class Channel(BaseModel):
+    id: str
+    """Identifies the notification channel."""
+
+    type: Literal["WEBHOOK"]
+    """Type of the notification channel."""
+
+
+class Threshold(BaseModel):
+    type: Literal["PERCENT", "NUMBER"]
+    """Type of the rule in the balance threshold specification."""
+
+    value: float
+    """Value of the threshold."""
+
+
+class Feature(BaseModel):
+    id: str
+    """Unique identifier of a feature."""
+
+    key: str
+    """
+    The key is an immutable unique identifier of the feature used throughout the
+    API, for example when interacting with a subject's entitlements.
+    """
+
+
+class NotificationRule(BaseModel):
+    id: str
+    """Identifies the notification rule."""
+
+    channels: List[Channel]
+    """List of notification channels the rule applies to."""
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """Timestamp of when the resource was created."""
+
+    name: str
+    """The user friendly name of the notification rule."""
+
+    thresholds: List[Threshold]
+    """List of thresholds the rule suppose to be triggered."""
+
+    type: Literal["entitlements.balance.threshold"]
+    """Notification rule type."""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """Timestamp of when the resource was last updated."""
+
+    deleted_at: Optional[datetime] = FieldInfo(alias="deletedAt", default=None)
+    """Timestamp of when the resource was permanently deleted."""
+
+    disabled: Optional[bool] = None
+    """Whether the rule is disabled or not."""
+
+    features: Optional[List[Feature]] = None
+    """Optional field containing list of features the rule applies to."""

openmeter/types/notifications/rule_create_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__ = ["RuleCreateParams", "Threshold"]
+
+
+class RuleCreateParams(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."""