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

openmeter/types/entitlements/__init__.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .feature import Feature as Feature
+from .grant_list_params import GrantListParams as GrantListParams
+from .feature_list_params import FeatureListParams as FeatureListParams
+from .grant_list_response import GrantListResponse as GrantListResponse
+from .list_features_result import ListFeaturesResult as ListFeaturesResult
+from .feature_create_params import FeatureCreateParams as FeatureCreateParams
+from .grant_paginated_response import GrantPaginatedResponse as GrantPaginatedResponse

openmeter/types/entitlements/feature.py

@@ -0,0 +1,61 @@
+# 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__ = ["Feature"]
+
+
+class Feature(BaseModel):
+    id: str
+    """Readonly unique ULID identifier."""
+
+    created_at: datetime = FieldInfo(alias="createdAt")
+    """The date and time the resource was created."""
+
+    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. The key has to
+    be unique across all active features, but archived features can share the same
+    key. The key should consist of lowercase alphanumeric characters and dashes.
+    """
+
+    name: str
+    """The name of the feature."""
+
+    updated_at: datetime = FieldInfo(alias="updatedAt")
+    """The date and time the resource was last updated.
+
+    The initial value is the same as createdAt.
+    """
+
+    archived_at: Optional[datetime] = FieldInfo(alias="archivedAt", default=None)
+    """If the feature is archived, no new entitlements can be created for it."""
+
+    deleted_at: Optional[datetime] = FieldInfo(alias="deletedAt", default=None)
+    """The date and time the resource was deleted."""
+
+    metadata: Optional[Dict[str, str]] = None
+    """
+    Additional metadata for the feature, useful for syncing with external systems
+    and annotating custom fields.
+    """
+
+    meter_group_by_filters: Optional[Dict[str, str]] = FieldInfo(alias="meterGroupByFilters", default=None)
+    """Optional meter group by filters.
+
+    Useful if the meter scope is broader than what feature tracks. Example scenario
+    would be a meter tracking all token use with groupBy fields for the model, then
+    the feature could filter for model=gpt-4.
+    """
+
+    meter_slug: Optional[str] = FieldInfo(alias="meterSlug", default=None)
+    """
+    The meter that the feature is associated with and and based on which usage is
+    calculated. The meter selected must have SUM or COUNT aggregation.
+    """

openmeter/types/entitlements/feature_create_params.py

@@ -0,0 +1,43 @@
+# 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 Required, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["FeatureCreateParams"]
+
+
+class FeatureCreateParams(TypedDict, total=False):
+    key: Required[str]
+    """
+    The key is an immutable unique identifier of the feature used throughout the
+    API, for example when interacting with a subject's entitlements. The key has to
+    be unique across all active features, but archived features can share the same
+    key. The key should consist of lowercase alphanumeric characters and dashes.
+    """
+
+    name: Required[str]
+    """The name of the feature."""
+
+    metadata: Dict[str, str]
+    """
+    Additional metadata for the feature, useful for syncing with external systems
+    and annotating custom fields.
+    """
+
+    meter_group_by_filters: Annotated[Dict[str, str], PropertyInfo(alias="meterGroupByFilters")]
+    """Optional meter group by filters.
+
+    Useful if the meter scope is broader than what feature tracks. Example scenario
+    would be a meter tracking all token use with groupBy fields for the model, then
+    the feature could filter for model=gpt-4.
+    """
+
+    meter_slug: Annotated[str, PropertyInfo(alias="meterSlug")]
+    """
+    The meter that the feature is associated with and and based on which usage is
+    calculated. The meter selected must have SUM or COUNT aggregation.
+    """

openmeter/types/entitlements/feature_list_params.py

@@ -0,0 +1,23 @@
+# 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__ = ["FeatureListParams"]
+
+
+class FeatureListParams(TypedDict, total=False):
+    include_archived: Annotated[bool, PropertyInfo(alias="includeArchived")]
+    """Include archived features."""
+
+    limit: int
+    """Number of entries to return"""
+
+    offset: int
+    """Number of entries to skip"""
+
+    order_by: Annotated[Literal["id", "createdAt", "updatedAt"], PropertyInfo(alias="orderBy")]
+    """Order by field"""

openmeter/types/entitlements/grant_list_params.py

@@ -0,0 +1,57 @@
+# 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__ = ["GrantListParams"]
+
+
+class GrantListParams(TypedDict, total=False):
+    feature: List[str]
+    """Filtering by multiple features.
+
+    Usage: `?feature=feature-1&feature=feature-2`
+    """
+
+    include_deleted: Annotated[bool, PropertyInfo(alias="includeDeleted")]
+    """Include deleted"""
+
+    limit: int
+    """Number of items to return.
+
+    Default is 100.
+    """
+
+    offset: int
+    """Number of items to skip.
+
+    Default is 0.
+    """
+
+    order: Literal["ASC", "DESC"]
+    """The order direction."""
+
+    order_by: Annotated[Literal["id", "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.
+    """
+
+    subject: List[str]
+    """Filtering by multiple subjects.
+
+    Usage: `?subject=customer-1&subject=customer-2`
+    """

openmeter/types/entitlements/grant_list_response.py

@@ -0,0 +1,11 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union
+from typing_extensions import TypeAlias
+
+from .grant_paginated_response import GrantPaginatedResponse
+from ..subjects.entitlements.entitlement_grant import EntitlementGrant
+
+__all__ = ["GrantListResponse"]
+
+GrantListResponse: TypeAlias = Union[List[EntitlementGrant], GrantPaginatedResponse]

openmeter/types/entitlements/grant_paginated_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 ..subjects.entitlements.entitlement_grant import EntitlementGrant
+
+__all__ = ["GrantPaginatedResponse"]
+
+
+class GrantPaginatedResponse(BaseModel):
+    items: List[EntitlementGrant]
+    """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/entitlements/list_features_result.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union
+from typing_extensions import TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .feature import Feature
+from ..._models import BaseModel
+
+__all__ = ["ListFeaturesResult", "FeaturePaginatedResponse"]
+
+
+class FeaturePaginatedResponse(BaseModel):
+    items: List[Feature]
+    """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."""
+
+
+ListFeaturesResult: TypeAlias = Union[List[Feature], FeaturePaginatedResponse]

openmeter/types/event_ingest_params.py

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Optional
+from datetime import datetime
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["EventIngestParams"]
+
+
+class EventIngestParams(TypedDict, total=False):
+    id: Required[str]
+    """Identifies the event."""
+
+    source: Required[str]
+    """Identifies the context in which an event happened."""
+
+    specversion: Required[str]
+    """The version of the CloudEvents specification which the event uses."""
+
+    subject: Required[str]
+    """
+    Describes the subject of the event in the context of the event producer
+    (identified by source).
+    """
+
+    type: Required[str]
+    """
+    Contains a value describing the type of event related to the originating
+    occurrence.
+    """
+
+    data: Union[str, object, None]
+    """The event payload."""
+
+    datacontenttype: Optional[str]
+    """Content type of the data value. Must adhere to RFC 2046 format."""
+
+    dataschema: Optional[str]
+    """Identifies the schema that data adheres to."""
+
+    time: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
+    """Timestamp of when the occurrence happened. Must adhere to RFC 3339."""

openmeter/types/event_ingest_response.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union, Optional
+from datetime import datetime
+
+from .._models import BaseModel
+
+__all__ = ["EventIngestResponse"]
+
+
+class EventIngestResponse(BaseModel):
+    id: str
+    """Identifies the event."""
+
+    source: str
+    """Identifies the context in which an event happened."""
+
+    specversion: str
+    """The version of the CloudEvents specification which the event uses."""
+
+    subject: str
+    """
+    Describes the subject of the event in the context of the event producer
+    (identified by source).
+    """
+
+    type: str
+    """
+    Contains a value describing the type of event related to the originating
+    occurrence.
+    """
+
+    data: Union[str, object, None] = None
+    """The event payload."""
+
+    datacontenttype: Optional[str] = None
+    """Content type of the data value. Must adhere to RFC 2046 format."""
+
+    dataschema: Optional[str] = None
+    """Identifies the schema that data adheres to."""
+
+    time: Optional[datetime] = None
+    """Timestamp of when the occurrence happened. Must adhere to RFC 3339."""

openmeter/types/event_list_params.py

@@ -0,0 +1,22 @@
+# 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 Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["EventListParams"]
+
+
+class EventListParams(TypedDict, total=False):
+    from_: Annotated[Union[str, datetime], PropertyInfo(alias="from", format="iso8601")]
+    """Start date-time in RFC 3339 format. Inclusive."""
+
+    limit: int
+    """Number of events to return"""
+
+    to: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+    """End date-time in RFC 3339 format. Inclusive."""

openmeter/types/event_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 .ingested_event import IngestedEvent
+
+__all__ = ["EventListResponse"]
+
+EventListResponse = List[IngestedEvent]

openmeter/types/ingested_event.py

@@ -0,0 +1,59 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Union, Optional
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["IngestedEvent", "Event"]
+
+
+class Event(BaseModel):
+    id: str
+    """Identifies the event."""
+
+    source: str
+    """Identifies the context in which an event happened."""
+
+    specversion: str
+    """The version of the CloudEvents specification which the event uses."""
+
+    subject: str
+    """
+    Describes the subject of the event in the context of the event producer
+    (identified by source).
+    """
+
+    type: str
+    """
+    Contains a value describing the type of event related to the originating
+    occurrence.
+    """
+
+    data: Union[str, object, None] = None
+    """The event payload."""
+
+    datacontenttype: Optional[str] = None
+    """Content type of the data value. Must adhere to RFC 2046 format."""
+
+    dataschema: Optional[str] = None
+    """Identifies the schema that data adheres to."""
+
+    time: Optional[datetime] = None
+    """Timestamp of when the occurrence happened. Must adhere to RFC 3339."""
+
+
+class IngestedEvent(BaseModel):
+    event: Event
+    """CloudEvents Specification JSON Schema"""
+
+    ingested_at: datetime = FieldInfo(alias="ingestedAt")
+    """The date and time the event was ingested."""
+
+    stored_at: datetime = FieldInfo(alias="storedAt")
+    """The date and time the event was stored."""
+
+    validation_error: Optional[str] = FieldInfo(alias="validationError", default=None)
+    """The validation error if the event failed validation."""

openmeter/types/list_entitlements_result.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Union
+from typing_extensions import TypeAlias
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+from .entitlement import Entitlement
+
+__all__ = ["ListEntitlementsResult", "EntitlementPaginatedResponse"]
+
+
+class EntitlementPaginatedResponse(BaseModel):
+    items: List[Entitlement]
+    """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."""
+
+
+ListEntitlementsResult: TypeAlias = Union[List[Entitlement], EntitlementPaginatedResponse]

openmeter/types/meter.py

@@ -0,0 +1,53 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from typing_extensions import Literal
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = ["Meter"]
+
+
+class Meter(BaseModel):
+    id: str
+    """A unique identifier for the meter."""
+
+    aggregation: Literal["SUM", "COUNT", "UNIQUE_COUNT", "AVG", "MIN", "MAX"]
+    """The aggregation type to use for the meter."""
+
+    event_type: str = FieldInfo(alias="eventType")
+    """The event type to aggregate."""
+
+    slug: str
+    """
+    A unique, human-readable identifier for the meter. Must consist only
+    alphanumeric and underscore characters.
+    """
+
+    window_size: Literal["MINUTE", "HOUR", "DAY"] = FieldInfo(alias="windowSize")
+    """Aggregation window size."""
+
+    description: Optional[str] = None
+    """A description of the meter."""
+
+    group_by: Optional[Dict[str, str]] = FieldInfo(alias="groupBy", default=None)
+    """Named JSONPath expressions to extract the group by values from the event data.
+
+    Keys must be unique and consist only alphanumeric and underscore characters.
+
+    TODO: add key format enforcement
+    """
+
+    value_property: Optional[str] = FieldInfo(alias="valueProperty", default=None)
+    """
+    JSONPath expression to extract the value from the ingested event's data
+    property.
+
+    The ingested value for SUM, AVG, MIN, and MAX aggregations is a number or a
+    string that can be parsed to a number.
+
+    For UNIQUE_COUNT aggregation, the ingested value must be a string. For COUNT
+    aggregation the valueProperty is ignored.
+    """

openmeter/types/meter_create_params.py

@@ -0,0 +1,50 @@
+# 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__ = ["MeterCreateParams"]
+
+
+class MeterCreateParams(TypedDict, total=False):
+    aggregation: Required[Literal["SUM", "COUNT", "UNIQUE_COUNT", "AVG", "MIN", "MAX"]]
+    """The aggregation type to use for the meter."""
+
+    event_type: Required[Annotated[str, PropertyInfo(alias="eventType")]]
+    """The event type to aggregate."""
+
+    slug: Required[str]
+    """
+    A unique, human-readable identifier for the meter. Must consist only
+    alphanumeric and underscore characters.
+    """
+
+    window_size: Required[Annotated[Literal["MINUTE", "HOUR", "DAY"], PropertyInfo(alias="windowSize")]]
+    """Aggregation window size."""
+
+    description: str
+    """A description of the meter."""
+
+    group_by: Annotated[Dict[str, str], PropertyInfo(alias="groupBy")]
+    """Named JSONPath expressions to extract the group by values from the event data.
+
+    Keys must be unique and consist only alphanumeric and underscore characters.
+
+    TODO: add key format enforcement
+    """
+
+    value_property: Annotated[str, PropertyInfo(alias="valueProperty")]
+    """
+    JSONPath expression to extract the value from the ingested event's data
+    property.
+
+    The ingested value for SUM, AVG, MIN, and MAX aggregations is a number or a
+    string that can be parsed to a number.
+
+    For UNIQUE_COUNT aggregation, the ingested value must be a string. For COUNT
+    aggregation the valueProperty is ignored.
+    """

openmeter/types/meter_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 .meter import Meter
+
+__all__ = ["MeterListResponse"]
+
+MeterListResponse = List[Meter]

openmeter/types/meter_query_params.py

@@ -0,0 +1,50 @@
+# 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.
+    """
+
+    subject: List[str]
+    """Filtering by multiple subjects.
+
+    Usage: ?subject=customer-1&subject=customer-2
+    """
+
+    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.
+    """