openmeter 1.0.0b122__py3-none-any.whl → 1.0.0b123__py3-none-any.whl

openmeter/_operations/_operations.py

@@ -385,7 +385,13 @@ def build_query_portal_meter_request(
 
 
 def build_list_entitlements_request(
-    *, limit: int = 1000, offset: int = 0, order_by: str = "createdAt", **kwargs: Any
+    *,
+    page: int = 1,
+    page_size: int = 100,
+    limit: int = 1000,
+    offset: int = 0,
+    order_by: str = "createdAt",
+    **kwargs: Any
 ) -> HttpRequest:
     _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
     _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
@@ -396,6 +402,10 @@ def build_list_entitlements_request(
     _url = "/api/v1/entitlements"
 
     # Construct parameters
+    if page is not None:
+        _params["page"] = _SERIALIZER.query("page", page, "int", minimum=1)
+    if page_size is not None:
+        _params["pageSize"] = _SERIALIZER.query("page_size", page_size, "int", maximum=1000, minimum=1)
     if limit is not None:
         _params["limit"] = _SERIALIZER.query("limit", limit, "int", maximum=1000, minimum=1)
     if offset is not None:
@@ -410,7 +420,14 @@ def build_list_entitlements_request(
 
 
 def build_list_features_request(
-    *, limit: int = 1000, offset: int = 0, order_by: str = "updatedAt", include_archived: bool = False, **kwargs: Any
+    *,
+    page: int = 1,
+    page_size: int = 100,
+    limit: int = 1000,
+    offset: int = 0,
+    order_by: str = "updatedAt",
+    include_archived: bool = False,
+    **kwargs: Any
 ) -> HttpRequest:
     _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
     _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
@@ -421,6 +438,10 @@ def build_list_features_request(
     _url = "/api/v1/features"
 
     # Construct parameters
+    if page is not None:
+        _params["page"] = _SERIALIZER.query("page", page, "int", minimum=1)
+    if page_size is not None:
+        _params["pageSize"] = _SERIALIZER.query("page_size", page_size, "int", maximum=1000, minimum=1)
     if limit is not None:
         _params["limit"] = _SERIALIZER.query("limit", limit, "int", maximum=1000, minimum=1)
     if offset is not None:
@@ -492,7 +513,15 @@ def build_delete_feature_request(feature_id: str, **kwargs: Any) -> HttpRequest:
 
 
 def build_list_grants_request(
-    *, limit: int = 1000, offset: int = 0, order_by: str = "updatedAt", include_deleted: bool = False, **kwargs: Any
+    *,
+    page: int = 1,
+    page_size: int = 100,
+    limit: int = 1000,
+    offset: int = 0,
+    order: str = "ASC",
+    order_by: str = "updatedAt",
+    include_deleted: bool = False,
+    **kwargs: Any
 ) -> HttpRequest:
     _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
     _params = case_insensitive_dict(kwargs.pop("params", {}) or {})
@@ -503,10 +532,16 @@ def build_list_grants_request(
     _url = "/api/v1/grants"
 
     # Construct parameters
+    if page is not None:
+        _params["page"] = _SERIALIZER.query("page", page, "int", minimum=1)
+    if page_size is not None:
+        _params["pageSize"] = _SERIALIZER.query("page_size", page_size, "int", maximum=1000, minimum=1)
     if limit is not None:
         _params["limit"] = _SERIALIZER.query("limit", limit, "int", maximum=1000, minimum=1)
     if offset is not None:
         _params["offset"] = _SERIALIZER.query("offset", offset, "int", minimum=0)
+    if order is not None:
+        _params["order"] = _SERIALIZER.query("order", order, "str")
     if order_by is not None:
         _params["orderBy"] = _SERIALIZER.query("order_by", order_by, "str")
     if include_deleted is not None:
@@ -2889,13 +2924,25 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
 
     @distributed_trace
     def list_entitlements(
-        self, *, limit: int = 1000, offset: int = 0, order_by: str = "createdAt", **kwargs: Any
-    ) -> List[JSON]:
+        self,
+        *,
+        page: int = 1,
+        page_size: int = 100,
+        limit: int = 1000,
+        offset: int = 0,
+        order_by: str = "createdAt",
+        **kwargs: Any
+    ) -> Any:
         """List entitlements.
 
         List all entitlements regardless of subject. This endpoint is intended for administrative
         purposes.
+        If page is provided that takes precedence and the paginated response is returned.
 
+        :keyword page: Page number to return. Default value is 1.
+        :paramtype page: int
+        :keyword page_size: Number of entries to return per page. Default value is 100.
+        :paramtype page_size: int
         :keyword limit: Number of entries to return. Default value is 1000.
         :paramtype limit: int
         :keyword offset: Number of entries to skip. Default value is 0.
@@ -2903,17 +2950,9 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
         :keyword order_by: Order by field. Known values are: "createdAt" and "updatedAt". Default value
          is "createdAt".
         :paramtype order_by: str
-        :return: list of JSON object
-        :rtype: list[JSON]
+        :return: any
+        :rtype: any
         :raises ~azure.core.exceptions.HttpResponseError:
-
-        Example:
-            .. code-block:: python
-
-                # response body for status code(s): 200
-                response == [
-                    {}
-                ]
         """
         error_map = {
             404: ResourceNotFoundError,
@@ -2927,9 +2966,11 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
         _headers = kwargs.pop("headers", {}) or {}
         _params = kwargs.pop("params", {}) or {}
 
-        cls: ClsType[List[JSON]] = kwargs.pop("cls", None)
+        cls: ClsType[Any] = kwargs.pop("cls", None)
 
         _request = build_list_entitlements_request(
+            page=page,
+            page_size=page_size,
             limit=limit,
             offset=offset,
             order_by=order_by,
@@ -2957,25 +2998,31 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
             deserialized = None
 
         if cls:
-            return cls(pipeline_response, cast(List[JSON], deserialized), {})  # type: ignore
+            return cls(pipeline_response, cast(Any, deserialized), {})  # type: ignore
 
-        return cast(List[JSON], deserialized)  # type: ignore
+        return cast(Any, deserialized)  # type: ignore
 
     @distributed_trace
     def list_features(
         self,
         *,
+        page: int = 1,
+        page_size: int = 100,
         limit: int = 1000,
         offset: int = 0,
         order_by: str = "updatedAt",
         include_archived: bool = False,
         **kwargs: Any
-    ) -> List[JSON]:
-        # pylint: disable=line-too-long
+    ) -> Any:
         """List features.
 
-        List all features.
+        List all features. If page is provided that takes precedence and the paginated response is
+        returned.
 
+        :keyword page: Page number to return. Default value is 1.
+        :paramtype page: int
+        :keyword page_size: Number of entries to return per page. Default value is 100.
+        :paramtype page_size: int
         :keyword limit: Number of entries to return. Default value is 1000.
         :paramtype limit: int
         :keyword offset: Number of entries to skip. Default value is 0.
@@ -2985,47 +3032,9 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
         :paramtype order_by: str
         :keyword include_archived: Include archived features. Default value is False.
         :paramtype include_archived: bool
-        :return: list of JSON object
-        :rtype: list[JSON]
+        :return: any
+        :rtype: any
         :raises ~azure.core.exceptions.HttpResponseError:
-
-        Example:
-            .. code-block:: python
-
-                # response body for status code(s): 200
-                response == [
-                    {
-                        "createdAt": "2020-02-20 00:00:00",  # The date and time the resource
-                          was created. Required.
-                        "id": "str",  # Readonly unique ULID identifier. Required.
-                        "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. Required.
-                        "name": "str",  # The name of the feature. Required.
-                        "updatedAt": "2020-02-20 00:00:00",  # The date and time the resource
-                          was last updated. The initial value is the same as createdAt. Required.
-                        "archivedAt": "2020-02-20 00:00:00",  # Optional. If the feature is
-                          archived, no new entitlements can be created for it.
-                        "deletedAt": "2020-02-20 00:00:00",  # Optional. The date and time
-                          the resource was deleted.
-                        "metadata": {
-                            "str": "str"  # Optional. Additional metadata for the
-                              feature, useful for syncing with external systems and annotating custom
-                              fields.
-                        },
-                        "meterGroupByFilters": {
-                            "str": "str"  # Optional. 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.
-                        },
-                        "meterSlug": "str"  # Optional. 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.
-                    }
-                ]
         """
         error_map = {
             404: ResourceNotFoundError,
@@ -3039,9 +3048,11 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
         _headers = kwargs.pop("headers", {}) or {}
         _params = kwargs.pop("params", {}) or {}
 
-        cls: ClsType[List[JSON]] = kwargs.pop("cls", None)
+        cls: ClsType[Any] = kwargs.pop("cls", None)
 
         _request = build_list_features_request(
+            page=page,
+            page_size=page_size,
             limit=limit,
             offset=offset,
             order_by=order_by,
@@ -3070,9 +3081,9 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
             deserialized = None
 
         if cls:
-            return cls(pipeline_response, cast(List[JSON], deserialized), {})  # type: ignore
+            return cls(pipeline_response, cast(Any, deserialized), {})  # type: ignore
 
-        return cast(List[JSON], deserialized)  # type: ignore
+        return cast(Any, deserialized)  # type: ignore
 
     @overload
     def create_feature(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> JSON:
@@ -3492,97 +3503,43 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
     def list_grants(
         self,
         *,
+        page: int = 1,
+        page_size: int = 100,
         limit: int = 1000,
         offset: int = 0,
+        order: str = "ASC",
         order_by: str = "updatedAt",
         include_deleted: bool = False,
         **kwargs: Any
-    ) -> List[JSON]:
-        # pylint: disable=line-too-long
+    ) -> Any:
         """List grants.
 
         List all grants for all the subjects and entitlements. This endpoint is intended for
         administrative purposes only. To fetch the grants of a specific entitlement please use the
         /api/v1/subjects/{subjectKeyOrID}/entitlements/{entitlementOrFeatureID}/grants endpoint.
 
+        If page is provided that takes precedence and the paginated response is returned.
+
+        :keyword page: Page number to return. Default value is 1.
+        :paramtype page: int
+        :keyword page_size: Number of entries to return per page. Default value is 100.
+        :paramtype page_size: int
         :keyword limit: Number of entries to return. Default value is 1000.
         :paramtype limit: int
         :keyword offset: Number of entries to skip. Default value is 0.
         :paramtype offset: int
+        :keyword order: Order by field.
+
+         Usage: ``?order=ASC``. Known values are: "ASC" and "DESC". Default value is "ASC".
+        :paramtype order: str
         :keyword order_by: Order by field. Known values are: "id", "createdAt", and "updatedAt".
          Default value is "updatedAt".
         :paramtype order_by: str
         :keyword include_deleted: Include deleted entries. Default value is False.
         :paramtype include_deleted: bool
-        :return: list of JSON object
-        :rtype: list[JSON]
+        :return: any
+        :rtype: any
         :raises ~azure.core.exceptions.HttpResponseError:
-
-        Example:
-            .. code-block:: python
-
-                # response body for status code(s): 200
-                response == [
-                    {
-                        "amount": 0.0,  # The amount to grant. Should be a positive number.
-                          Required.
-                        "createdAt": "2020-02-20 00:00:00",  # The date and time the resource
-                          was created. Required.
-                        "effectiveAt": "2020-02-20 00:00:00",  # Effective date for grants
-                          and anchor for recurring grants. Provided value will be ceiled to metering
-                          windowSize (minute). Required.
-                        "entitlementId": "str",  # The unique entitlement ULID that the grant
-                          is associated with. Required.
-                        "expiration": {
-                            "count": 0,  # The expiration period count like 12 months.
-                              Required.
-                            "duration": "str"  # The expiration period duration like
-                              month. Required. Known values are: "HOUR", "DAY", "WEEK", "MONTH", and
-                              "YEAR".
-                        },
-                        "id": "str",  # Readonly unique ULID identifier. Required.
-                        "updatedAt": "2020-02-20 00:00:00",  # The date and time the resource
-                          was last updated. The initial value is the same as createdAt. Required.
-                        "deletedAt": "2020-02-20 00:00:00",  # Optional. The date and time
-                          the resource was deleted.
-                        "expiresAt": "2020-02-20 00:00:00",  # Optional. The expiration date
-                          of the grant.
-                        "maxRolloverAmount": 0,  # Optional. Default value is 0. Grants are
-                          rolled over at reset, after which they can have a different balance compared
-                          to what they had before the reset.  Balance after the reset is calculated as:
-                          Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset,
-                          MinRolloverAmount)).
-                        "metadata": {
-                            "str": "str"  # Optional. Dictionary of :code:`<string>`.
-                        },
-                        "minRolloverAmount": 0,  # Optional. Default value is 0. Grants are
-                          rolled over at reset, after which they can have a different balance compared
-                          to what they had before the reset.  Balance after the reset is calculated as:
-                          Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset,
-                          MinRolloverAmount)).
-                        "nextRecurrence": "2020-02-20 00:00:00",  # Optional. The next time
-                          the grant will recurr.
-                        "priority": 1,  # Optional. Default value is 1. The priority of the
-                          grant. Grants with higher priority are applied first. Priority is a positive
-                          decimal numbers. With lower numbers indicating higher importance. For
-                          example, a priority of 1 is more urgent than a priority of 2. When there are
-                          several grants available for the same subject, the system selects the grant
-                          with the highest priority. In cases where grants share the same priority
-                          level, the grant closest to its expiration will be used first. In the case of
-                          two grants have identical priorities and expiration dates, the system will
-                          use the grant that was created first.
-                        "recurrence": {
-                            "anchor": "2020-02-20 00:00:00",  # An arbitrary anchor to
-                              base the recurring period on. Required.
-                            "interval": "str"  # List of pre-defined periods that can be
-                              used for recurring & scheduling.  DAY:      Every day WEEK:     Every
-                              week MONTH:    Every month YEAR:     Every year. Required. Known values
-                              are: "DAY", "WEEK", "MONTH", and "YEAR".
-                        },
-                        "voidedAt": "2020-02-20 00:00:00"  # Optional. The date and time the
-                          grant was voided (cannot be used after that).
-                    }
-                ]
         """
         error_map = {
             404: ResourceNotFoundError,
@@ -3595,11 +3552,14 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
         _headers = kwargs.pop("headers", {}) or {}
         _params = kwargs.pop("params", {}) or {}
 
-        cls: ClsType[List[JSON]] = kwargs.pop("cls", None)
+        cls: ClsType[Any] = kwargs.pop("cls", None)
 
         _request = build_list_grants_request(
+            page=page,
+            page_size=page_size,
             limit=limit,
             offset=offset,
+            order=order,
             order_by=order_by,
             include_deleted=include_deleted,
             headers=_headers,
@@ -3626,9 +3586,9 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
             deserialized = None
 
         if cls:
-            return cls(pipeline_response, cast(List[JSON], deserialized), {})  # type: ignore
+            return cls(pipeline_response, cast(Any, deserialized), {})  # type: ignore
 
-        return cast(List[JSON], deserialized)  # type: ignore
+        return cast(Any, deserialized)  # type: ignore
 
     @distributed_trace
     def void_grant(self, grant_id: str, **kwargs: Any) -> Optional[JSON]:

openmeter/aio/_operations/_operations.py

@@ -1904,13 +1904,25 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
 
     @distributed_trace_async
     async def list_entitlements(
-        self, *, limit: int = 1000, offset: int = 0, order_by: str = "createdAt", **kwargs: Any
-    ) -> List[JSON]:
+        self,
+        *,
+        page: int = 1,
+        page_size: int = 100,
+        limit: int = 1000,
+        offset: int = 0,
+        order_by: str = "createdAt",
+        **kwargs: Any
+    ) -> Any:
         """List entitlements.
 
         List all entitlements regardless of subject. This endpoint is intended for administrative
         purposes.
+        If page is provided that takes precedence and the paginated response is returned.
 
+        :keyword page: Page number to return. Default value is 1.
+        :paramtype page: int
+        :keyword page_size: Number of entries to return per page. Default value is 100.
+        :paramtype page_size: int
         :keyword limit: Number of entries to return. Default value is 1000.
         :paramtype limit: int
         :keyword offset: Number of entries to skip. Default value is 0.
@@ -1918,17 +1930,9 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
         :keyword order_by: Order by field. Known values are: "createdAt" and "updatedAt". Default value
          is "createdAt".
         :paramtype order_by: str
-        :return: list of JSON object
-        :rtype: list[JSON]
+        :return: any
+        :rtype: any
         :raises ~azure.core.exceptions.HttpResponseError:
-
-        Example:
-            .. code-block:: python
-
-                # response body for status code(s): 200
-                response == [
-                    {}
-                ]
         """
         error_map = {
             404: ResourceNotFoundError,
@@ -1942,9 +1946,11 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
         _headers = kwargs.pop("headers", {}) or {}
         _params = kwargs.pop("params", {}) or {}
 
-        cls: ClsType[List[JSON]] = kwargs.pop("cls", None)
+        cls: ClsType[Any] = kwargs.pop("cls", None)
 
         _request = build_list_entitlements_request(
+            page=page,
+            page_size=page_size,
             limit=limit,
             offset=offset,
             order_by=order_by,
@@ -1972,25 +1978,31 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
             deserialized = None
 
         if cls:
-            return cls(pipeline_response, cast(List[JSON], deserialized), {})  # type: ignore
+            return cls(pipeline_response, cast(Any, deserialized), {})  # type: ignore
 
-        return cast(List[JSON], deserialized)  # type: ignore
+        return cast(Any, deserialized)  # type: ignore
 
     @distributed_trace_async
     async def list_features(
         self,
         *,
+        page: int = 1,
+        page_size: int = 100,
         limit: int = 1000,
         offset: int = 0,
         order_by: str = "updatedAt",
         include_archived: bool = False,
         **kwargs: Any
-    ) -> List[JSON]:
-        # pylint: disable=line-too-long
+    ) -> Any:
         """List features.
 
-        List all features.
+        List all features. If page is provided that takes precedence and the paginated response is
+        returned.
 
+        :keyword page: Page number to return. Default value is 1.
+        :paramtype page: int
+        :keyword page_size: Number of entries to return per page. Default value is 100.
+        :paramtype page_size: int
         :keyword limit: Number of entries to return. Default value is 1000.
         :paramtype limit: int
         :keyword offset: Number of entries to skip. Default value is 0.
@@ -2000,47 +2012,9 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
         :paramtype order_by: str
         :keyword include_archived: Include archived features. Default value is False.
         :paramtype include_archived: bool
-        :return: list of JSON object
-        :rtype: list[JSON]
+        :return: any
+        :rtype: any
         :raises ~azure.core.exceptions.HttpResponseError:
-
-        Example:
-            .. code-block:: python
-
-                # response body for status code(s): 200
-                response == [
-                    {
-                        "createdAt": "2020-02-20 00:00:00",  # The date and time the resource
-                          was created. Required.
-                        "id": "str",  # Readonly unique ULID identifier. Required.
-                        "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. Required.
-                        "name": "str",  # The name of the feature. Required.
-                        "updatedAt": "2020-02-20 00:00:00",  # The date and time the resource
-                          was last updated. The initial value is the same as createdAt. Required.
-                        "archivedAt": "2020-02-20 00:00:00",  # Optional. If the feature is
-                          archived, no new entitlements can be created for it.
-                        "deletedAt": "2020-02-20 00:00:00",  # Optional. The date and time
-                          the resource was deleted.
-                        "metadata": {
-                            "str": "str"  # Optional. Additional metadata for the
-                              feature, useful for syncing with external systems and annotating custom
-                              fields.
-                        },
-                        "meterGroupByFilters": {
-                            "str": "str"  # Optional. 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.
-                        },
-                        "meterSlug": "str"  # Optional. 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.
-                    }
-                ]
         """
         error_map = {
             404: ResourceNotFoundError,
@@ -2054,9 +2028,11 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
         _headers = kwargs.pop("headers", {}) or {}
         _params = kwargs.pop("params", {}) or {}
 
-        cls: ClsType[List[JSON]] = kwargs.pop("cls", None)
+        cls: ClsType[Any] = kwargs.pop("cls", None)
 
         _request = build_list_features_request(
+            page=page,
+            page_size=page_size,
             limit=limit,
             offset=offset,
             order_by=order_by,
@@ -2085,9 +2061,9 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
             deserialized = None
 
         if cls:
-            return cls(pipeline_response, cast(List[JSON], deserialized), {})  # type: ignore
+            return cls(pipeline_response, cast(Any, deserialized), {})  # type: ignore
 
-        return cast(List[JSON], deserialized)  # type: ignore
+        return cast(Any, deserialized)  # type: ignore
 
     @overload
     async def create_feature(self, body: JSON, *, content_type: str = "application/json", **kwargs: Any) -> JSON:
@@ -2509,97 +2485,43 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
     async def list_grants(
         self,
         *,
+        page: int = 1,
+        page_size: int = 100,
         limit: int = 1000,
         offset: int = 0,
+        order: str = "ASC",
         order_by: str = "updatedAt",
         include_deleted: bool = False,
         **kwargs: Any
-    ) -> List[JSON]:
-        # pylint: disable=line-too-long
+    ) -> Any:
         """List grants.
 
         List all grants for all the subjects and entitlements. This endpoint is intended for
         administrative purposes only. To fetch the grants of a specific entitlement please use the
         /api/v1/subjects/{subjectKeyOrID}/entitlements/{entitlementOrFeatureID}/grants endpoint.
 
+        If page is provided that takes precedence and the paginated response is returned.
+
+        :keyword page: Page number to return. Default value is 1.
+        :paramtype page: int
+        :keyword page_size: Number of entries to return per page. Default value is 100.
+        :paramtype page_size: int
         :keyword limit: Number of entries to return. Default value is 1000.
         :paramtype limit: int
         :keyword offset: Number of entries to skip. Default value is 0.
         :paramtype offset: int
+        :keyword order: Order by field.
+
+         Usage: ``?order=ASC``. Known values are: "ASC" and "DESC". Default value is "ASC".
+        :paramtype order: str
         :keyword order_by: Order by field. Known values are: "id", "createdAt", and "updatedAt".
          Default value is "updatedAt".
         :paramtype order_by: str
         :keyword include_deleted: Include deleted entries. Default value is False.
         :paramtype include_deleted: bool
-        :return: list of JSON object
-        :rtype: list[JSON]
+        :return: any
+        :rtype: any
         :raises ~azure.core.exceptions.HttpResponseError:
-
-        Example:
-            .. code-block:: python
-
-                # response body for status code(s): 200
-                response == [
-                    {
-                        "amount": 0.0,  # The amount to grant. Should be a positive number.
-                          Required.
-                        "createdAt": "2020-02-20 00:00:00",  # The date and time the resource
-                          was created. Required.
-                        "effectiveAt": "2020-02-20 00:00:00",  # Effective date for grants
-                          and anchor for recurring grants. Provided value will be ceiled to metering
-                          windowSize (minute). Required.
-                        "entitlementId": "str",  # The unique entitlement ULID that the grant
-                          is associated with. Required.
-                        "expiration": {
-                            "count": 0,  # The expiration period count like 12 months.
-                              Required.
-                            "duration": "str"  # The expiration period duration like
-                              month. Required. Known values are: "HOUR", "DAY", "WEEK", "MONTH", and
-                              "YEAR".
-                        },
-                        "id": "str",  # Readonly unique ULID identifier. Required.
-                        "updatedAt": "2020-02-20 00:00:00",  # The date and time the resource
-                          was last updated. The initial value is the same as createdAt. Required.
-                        "deletedAt": "2020-02-20 00:00:00",  # Optional. The date and time
-                          the resource was deleted.
-                        "expiresAt": "2020-02-20 00:00:00",  # Optional. The expiration date
-                          of the grant.
-                        "maxRolloverAmount": 0,  # Optional. Default value is 0. Grants are
-                          rolled over at reset, after which they can have a different balance compared
-                          to what they had before the reset.  Balance after the reset is calculated as:
-                          Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset,
-                          MinRolloverAmount)).
-                        "metadata": {
-                            "str": "str"  # Optional. Dictionary of :code:`<string>`.
-                        },
-                        "minRolloverAmount": 0,  # Optional. Default value is 0. Grants are
-                          rolled over at reset, after which they can have a different balance compared
-                          to what they had before the reset.  Balance after the reset is calculated as:
-                          Balance_After_Reset = MIN(MaxRolloverAmount, MAX(Balance_Before_Reset,
-                          MinRolloverAmount)).
-                        "nextRecurrence": "2020-02-20 00:00:00",  # Optional. The next time
-                          the grant will recurr.
-                        "priority": 1,  # Optional. Default value is 1. The priority of the
-                          grant. Grants with higher priority are applied first. Priority is a positive
-                          decimal numbers. With lower numbers indicating higher importance. For
-                          example, a priority of 1 is more urgent than a priority of 2. When there are
-                          several grants available for the same subject, the system selects the grant
-                          with the highest priority. In cases where grants share the same priority
-                          level, the grant closest to its expiration will be used first. In the case of
-                          two grants have identical priorities and expiration dates, the system will
-                          use the grant that was created first.
-                        "recurrence": {
-                            "anchor": "2020-02-20 00:00:00",  # An arbitrary anchor to
-                              base the recurring period on. Required.
-                            "interval": "str"  # List of pre-defined periods that can be
-                              used for recurring & scheduling.  DAY:      Every day WEEK:     Every
-                              week MONTH:    Every month YEAR:     Every year. Required. Known values
-                              are: "DAY", "WEEK", "MONTH", and "YEAR".
-                        },
-                        "voidedAt": "2020-02-20 00:00:00"  # Optional. The date and time the
-                          grant was voided (cannot be used after that).
-                    }
-                ]
         """
         error_map = {
             404: ResourceNotFoundError,
@@ -2612,11 +2534,14 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
         _headers = kwargs.pop("headers", {}) or {}
         _params = kwargs.pop("params", {}) or {}
 
-        cls: ClsType[List[JSON]] = kwargs.pop("cls", None)
+        cls: ClsType[Any] = kwargs.pop("cls", None)
 
         _request = build_list_grants_request(
+            page=page,
+            page_size=page_size,
             limit=limit,
             offset=offset,
+            order=order,
             order_by=order_by,
             include_deleted=include_deleted,
             headers=_headers,
@@ -2643,9 +2568,9 @@ class ClientOperationsMixin(ClientMixinABC):  # pylint: disable=too-many-public-
             deserialized = None
 
         if cls:
-            return cls(pipeline_response, cast(List[JSON], deserialized), {})  # type: ignore
+            return cls(pipeline_response, cast(Any, deserialized), {})  # type: ignore
 
-        return cast(List[JSON], deserialized)  # type: ignore
+        return cast(Any, deserialized)  # type: ignore
 
     @distributed_trace_async
     async def void_grant(self, grant_id: str, **kwargs: Any) -> Optional[JSON]:

{openmeter-1.0.0b122.dist-info → openmeter-1.0.0b123.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openmeter
-Version: 1.0.0b122
+Version: 1.0.0b123
 Summary: Client for OpenMeter: Real-Time and Scalable Usage Metering
 Home-page: https://openmeter.io
 License: Apache-2.0

{openmeter-1.0.0b122.dist-info → openmeter-1.0.0b123.dist-info}/RECORD

@@ -2,7 +2,7 @@ openmeter/__init__.py,sha256=7klRT7LAGDqBcZsl7LGZrgrABVwyncgVUlidfaPiJm4,702
 openmeter/_client.py,sha256=TIXIPi_UVO-d5BHra7_xIiKmLfZBrmc4L_Xq2gxi4lM,3982
 openmeter/_configuration.py,sha256=CIdMxPaIXwDLaCsnvmdmHTfplV_cRp24101RJCEWtes,1807
 openmeter/_operations/__init__.py,sha256=GVYObnS1nT-wbN8ONRxlAiH6NBeAXlOBi7olGJE9niA,682
-openmeter/_operations/_operations.py,sha256=x1rcD2qSPRWA8inFpE22Apk6Gt4NcuLxYe8r59a7aC8,275309
+openmeter/_operations/_operations.py,sha256=DsbYC_Htg0vGy_FzpEJAHp8Iedk8Hc_Wj6rYeVHdY-g,270306
 openmeter/_operations/_patch.py,sha256=ptSL-JhY1fbGT9Cw2cUkPF1TPz5qVgXwTMMT5h41XUc,4874
 openmeter/_patch.py,sha256=P7PMm3Gbjlk56lI6B_Ra43hSW5qGMEmN3cNYGH5uZ3s,674
 openmeter/_serialization.py,sha256=vQIv-wuCQabtiIq2DXOr7-InGADqxlXTGNEKv9OlDPs,78873
@@ -11,11 +11,11 @@ openmeter/aio/__init__.py,sha256=7klRT7LAGDqBcZsl7LGZrgrABVwyncgVUlidfaPiJm4,702
 openmeter/aio/_client.py,sha256=O0VpMfw42UuTN_ZTIL3dw944PviLIrBBCSp7UaexyKQ,4100
 openmeter/aio/_configuration.py,sha256=NtT-cxQWkt8q_FvMfwqqil18Tt9zJmWGVju4U9s7OsE,1817
 openmeter/aio/_operations/__init__.py,sha256=GVYObnS1nT-wbN8ONRxlAiH6NBeAXlOBi7olGJE9niA,682
-openmeter/aio/_operations/_operations.py,sha256=FAySZ4qobFRmUf3yj3WgyND-ei81G4T2OBVpNm_2a7s,239814
+openmeter/aio/_operations/_operations.py,sha256=g7Ee_FcWPMvfQ6oyglHXDXNV71XEVxwhs2aXYD6Nixo,233797
 openmeter/aio/_operations/_patch.py,sha256=P7PMm3Gbjlk56lI6B_Ra43hSW5qGMEmN3cNYGH5uZ3s,674
 openmeter/aio/_patch.py,sha256=P7PMm3Gbjlk56lI6B_Ra43hSW5qGMEmN3cNYGH5uZ3s,674
 openmeter/aio/_vendor.py,sha256=CFsSbXOBydpg_f_uciu6Pe6cvF__6ofZ6KFEhkaMMEU,862
 openmeter/py.typed,sha256=dcrsqJrcYfTX-ckLFJMTaj6mD8aDe2u0tkQG-ZYxnEg,26
-openmeter-1.0.0b122.dist-info/METADATA,sha256=Nd2jITIRm60ezMr1MalD1SeMyvpBtDXA-t8FC-g4uG4,2258
-openmeter-1.0.0b122.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-openmeter-1.0.0b122.dist-info/RECORD,,
+openmeter-1.0.0b123.dist-info/METADATA,sha256=JM9HkJFxRjiCVD-IpOecYqfgk9S-4o-k8ZQgZtU2P_E,2258
+openmeter-1.0.0b123.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+openmeter-1.0.0b123.dist-info/RECORD,,