payi 0.1.0a17__tar.gz → 0.1.0a19__tar.gz

payi-0.1.0a19/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0-alpha.19"
+}

{payi-0.1.0a17 → payi-0.1.0a19}/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 0.1.0-alpha.19 (2024-08-09)
+
+Full Changelog: [v0.1.0-alpha.18...v0.1.0-alpha.19](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.18...v0.1.0-alpha.19)
+
+### Features
+
+* **api:** update via SDK Studio ([#89](https://github.com/Pay-i/pay-i-python/issues/89)) ([b031428](https://github.com/Pay-i/pay-i-python/commit/b03142879e9d1798d08288578d078eab98e86353))
+
+
+### Chores
+
+* **ci:** bump prism mock server version ([#91](https://github.com/Pay-i/pay-i-python/issues/91)) ([6cd2937](https://github.com/Pay-i/pay-i-python/commit/6cd29379f24f7a7d261ed6beea8e4833e01eacfd))
+* **internal:** ensure package is importable in lint cmd ([#92](https://github.com/Pay-i/pay-i-python/issues/92)) ([5af85e5](https://github.com/Pay-i/pay-i-python/commit/5af85e57dac94be4da96b45b406e683701150365))
+
+## 0.1.0-alpha.18 (2024-08-08)
+
+Full Changelog: [v0.1.0-alpha.17...v0.1.0-alpha.18](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.17...v0.1.0-alpha.18)
+
+### Features
+
+* **api:** update via SDK Studio ([#83](https://github.com/Pay-i/pay-i-python/issues/83)) ([c78b273](https://github.com/Pay-i/pay-i-python/commit/c78b273d807606abe94212e0092eff80895da96d))
+* **api:** update via SDK Studio ([#86](https://github.com/Pay-i/pay-i-python/issues/86)) ([ea1bc86](https://github.com/Pay-i/pay-i-python/commit/ea1bc86c6a3671b49ba7394841b5534d7e8c0263))
+
+
+### Chores
+
+* **internal:** remove deprecated ruff config ([#85](https://github.com/Pay-i/pay-i-python/issues/85)) ([744ae88](https://github.com/Pay-i/pay-i-python/commit/744ae888b57aa5a424e4a4729d7c0e85776b6d08))
+
 ## 0.1.0-alpha.17 (2024-08-07)
 
 Full Changelog: [v0.1.0-alpha.16...v0.1.0-alpha.17](https://github.com/Pay-i/pay-i-python/compare/v0.1.0-alpha.16...v0.1.0-alpha.17)

{payi-0.1.0a17 → payi-0.1.0a19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: payi
-Version: 0.1.0a17
+Version: 0.1.0a19
 Summary: The official Python library for the payi API
 Project-URL: Homepage, https://github.com/Pay-i/pay-i-python
 Project-URL: Repository, https://github.com/Pay-i/pay-i-python
@@ -63,7 +63,7 @@ from payi import Payi
 
 client = Payi(
     # This is the default and can be omitted
-    payi_api_key=os.environ.get("PAYI_API_KEY"),
+    api_key=os.environ.get("PAYI_API_KEY"),
 )
 
 budget_response = client.budgets.create(
@@ -73,10 +73,10 @@ budget_response = client.budgets.create(
 print(budget_response.request_id)
 ```
 
-While you can provide a `payi_api_key` keyword argument,
+While you can provide an `api_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `PAYI_API_KEY="My Payi API Key"` to your `.env` file
-so that your Payi API Key is not stored in source control.
+to add `PAYI_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
 
 ## Async usage
 
@@ -89,7 +89,7 @@ from payi import AsyncPayi
 
 client = AsyncPayi(
     # This is the default and can be omitted
-    payi_api_key=os.environ.get("PAYI_API_KEY"),
+    api_key=os.environ.get("PAYI_API_KEY"),
 )
 
 

{payi-0.1.0a17 → payi-0.1.0a19}/README.md

@@ -29,7 +29,7 @@ from payi import Payi
 
 client = Payi(
     # This is the default and can be omitted
-    payi_api_key=os.environ.get("PAYI_API_KEY"),
+    api_key=os.environ.get("PAYI_API_KEY"),
 )
 
 budget_response = client.budgets.create(
@@ -39,10 +39,10 @@ budget_response = client.budgets.create(
 print(budget_response.request_id)
 ```
 
-While you can provide a `payi_api_key` keyword argument,
+While you can provide an `api_key` keyword argument,
 we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
-to add `PAYI_API_KEY="My Payi API Key"` to your `.env` file
-so that your Payi API Key is not stored in source control.
+to add `PAYI_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
 
 ## Async usage
 
@@ -55,7 +55,7 @@ from payi import AsyncPayi
 
 client = AsyncPayi(
     # This is the default and can be omitted
-    payi_api_key=os.environ.get("PAYI_API_KEY"),
+    api_key=os.environ.get("PAYI_API_KEY"),
 )
 
 

{payi-0.1.0a17 → payi-0.1.0a19}/api.md

@@ -52,7 +52,7 @@ Methods:
 Types:
 
 ```python
-from payi.types import BulkIngestResponse, IngestEvent, IngestResponse
+from payi.types import BulkIngestResponse, IngestEvent, IngestResponse, IngestUnits
 ```
 
 Methods:
@@ -93,9 +93,9 @@ from payi.types.categories import ResourceListResponse
 Methods:
 
 - <code title="post /api/v1/categories/{category}/resources/{resource}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">create</a>(resource, \*, category, \*\*<a href="src/payi/types/categories/resource_create_params.py">params</a>) -> <a href="./src/payi/types/category_resource_response.py">CategoryResourceResponse</a></code>
-- <code title="get /api/v1/categories/{category}/resources/{resource}/{start_timestamp}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">retrieve</a>(start_timestamp, \*, category, resource) -> <a href="./src/payi/types/category_resource_response.py">CategoryResourceResponse</a></code>
+- <code title="get /api/v1/categories/{category}/resources/{resource}/{resource_id}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">retrieve</a>(resource_id, \*, category, resource) -> <a href="./src/payi/types/category_resource_response.py">CategoryResourceResponse</a></code>
 - <code title="get /api/v1/categories/{category}/resources/{resource}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">list</a>(resource, \*, category) -> <a href="./src/payi/types/categories/resource_list_response.py">ResourceListResponse</a></code>
-- <code title="delete /api/v1/categories/{category}/resources/{resource}/{start_timestamp}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">delete</a>(start_timestamp, \*, category, resource) -> <a href="./src/payi/types/category_resource_response.py">CategoryResourceResponse</a></code>
+- <code title="delete /api/v1/categories/{category}/resources/{resource}/{resource_id}">client.categories.resources.<a href="./src/payi/resources/categories/resources.py">delete</a>(resource_id, \*, category, resource) -> <a href="./src/payi/types/category_resource_response.py">CategoryResourceResponse</a></code>
 
 # Experiences
 

{payi-0.1.0a17 → payi-0.1.0a19}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "payi"
-version = "0.1.0-alpha.17"
+version = "0.1.0-alpha.19"
 description = "The official Python library for the payi API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -76,10 +76,13 @@ format = { chain = [
 "lint" = { chain = [
   "check:ruff",
   "typecheck",
+  "check:importable",
 ]}
 "check:ruff" = "ruff check ."
 "fix:ruff" = "ruff check --fix ."
 
+"check:importable" = "python -c 'import payi'"
+
 typecheck = { chain = [
   "typecheck:pyright",
   "typecheck:mypy"
@@ -195,7 +198,6 @@ unfixable = [
   "T201",
   "T203",
 ]
-ignore-init-module-imports = true
 
 [tool.ruff.lint.flake8-tidy-imports.banned-api]
 "functools.lru_cache".msg = "This function does not retain type information for the wrapped function's arguments; The `lru_cache` function from `_utils` should be used instead"
@@ -207,7 +209,7 @@ combine-as-imports = true
 extra-standard-library = ["typing_extensions"]
 known-first-party = ["payi", "tests"]
 
-[tool.ruff.per-file-ignores]
+[tool.ruff.lint.per-file-ignores]
 "bin/**.py" = ["T201", "T203"]
 "scripts/**.py" = ["T201", "T203"]
 "tests/**.py" = ["T201", "T203"]

{payi-0.1.0a17 → payi-0.1.0a19}/src/payi/_client.py

@@ -54,12 +54,12 @@ class Payi(SyncAPIClient):
     with_streaming_response: PayiWithStreamedResponse
 
     # client options
-    payi_api_key: str
+    api_key: str
 
     def __init__(
         self,
         *,
-        payi_api_key: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -81,15 +81,15 @@ class Payi(SyncAPIClient):
     ) -> None:
         """Construct a new synchronous payi client instance.
 
-        This automatically infers the `payi_api_key` argument from the `PAYI_API_KEY` environment variable if it is not provided.
+        This automatically infers the `api_key` argument from the `PAYI_API_KEY` environment variable if it is not provided.
         """
-        if payi_api_key is None:
-            payi_api_key = os.environ.get("PAYI_API_KEY")
-        if payi_api_key is None:
+        if api_key is None:
+            api_key = os.environ.get("PAYI_API_KEY")
+        if api_key is None:
             raise PayiError(
-                "The payi_api_key client option must be set either by passing payi_api_key to the client or by setting the PAYI_API_KEY environment variable"
+                "The api_key client option must be set either by passing api_key to the client or by setting the PAYI_API_KEY environment variable"
             )
-        self.payi_api_key = payi_api_key
+        self.api_key = api_key
 
         if base_url is None:
             base_url = os.environ.get("PAYI_BASE_URL")
@@ -122,8 +122,8 @@ class Payi(SyncAPIClient):
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        payi_api_key = self.payi_api_key
-        return {"Authorization": payi_api_key}
+        api_key = self.api_key
+        return {"Authorization": api_key}
 
     @property
     @override
@@ -137,7 +137,7 @@ class Payi(SyncAPIClient):
     def copy(
         self,
         *,
-        payi_api_key: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.Client | None = None,
@@ -171,7 +171,7 @@ class Payi(SyncAPIClient):
 
         http_client = http_client or self._client
         return self.__class__(
-            payi_api_key=payi_api_key or self.payi_api_key,
+            api_key=api_key or self.api_key,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,
@@ -228,12 +228,12 @@ class AsyncPayi(AsyncAPIClient):
     with_streaming_response: AsyncPayiWithStreamedResponse
 
     # client options
-    payi_api_key: str
+    api_key: str
 
     def __init__(
         self,
         *,
-        payi_api_key: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: Union[float, Timeout, None, NotGiven] = NOT_GIVEN,
         max_retries: int = DEFAULT_MAX_RETRIES,
@@ -255,15 +255,15 @@ class AsyncPayi(AsyncAPIClient):
     ) -> None:
         """Construct a new async payi client instance.
 
-        This automatically infers the `payi_api_key` argument from the `PAYI_API_KEY` environment variable if it is not provided.
+        This automatically infers the `api_key` argument from the `PAYI_API_KEY` environment variable if it is not provided.
         """
-        if payi_api_key is None:
-            payi_api_key = os.environ.get("PAYI_API_KEY")
-        if payi_api_key is None:
+        if api_key is None:
+            api_key = os.environ.get("PAYI_API_KEY")
+        if api_key is None:
             raise PayiError(
-                "The payi_api_key client option must be set either by passing payi_api_key to the client or by setting the PAYI_API_KEY environment variable"
+                "The api_key client option must be set either by passing api_key to the client or by setting the PAYI_API_KEY environment variable"
             )
-        self.payi_api_key = payi_api_key
+        self.api_key = api_key
 
         if base_url is None:
             base_url = os.environ.get("PAYI_BASE_URL")
@@ -296,8 +296,8 @@ class AsyncPayi(AsyncAPIClient):
     @property
     @override
     def auth_headers(self) -> dict[str, str]:
-        payi_api_key = self.payi_api_key
-        return {"Authorization": payi_api_key}
+        api_key = self.api_key
+        return {"Authorization": api_key}
 
     @property
     @override
@@ -311,7 +311,7 @@ class AsyncPayi(AsyncAPIClient):
     def copy(
         self,
         *,
-        payi_api_key: str | None = None,
+        api_key: str | None = None,
         base_url: str | httpx.URL | None = None,
         timeout: float | Timeout | None | NotGiven = NOT_GIVEN,
         http_client: httpx.AsyncClient | None = None,
@@ -345,7 +345,7 @@ class AsyncPayi(AsyncAPIClient):
 
         http_client = http_client or self._client
         return self.__class__(
-            payi_api_key=payi_api_key or self.payi_api_key,
+            api_key=api_key or self.api_key,
             base_url=base_url or self.base_url,
             timeout=self.timeout if isinstance(timeout, NotGiven) else timeout,
             http_client=http_client,

{payi-0.1.0a17 → payi-0.1.0a19}/src/payi/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "payi"
-__version__ = "0.1.0-alpha.17"  # x-release-please-version
+__version__ = "0.1.0-alpha.19"  # x-release-please-version

{payi-0.1.0a17 → payi-0.1.0a19}/src/payi/resources/categories/resources.py

@@ -90,7 +90,7 @@ class ResourcesResource(SyncAPIResource):
 
     def retrieve(
         self,
-        start_timestamp: Union[str, datetime],
+        resource_id: str,
         *,
         category: str,
         resource: str,
@@ -117,10 +117,10 @@ class ResourcesResource(SyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `category` but received {category!r}")
         if not resource:
             raise ValueError(f"Expected a non-empty value for `resource` but received {resource!r}")
-        if not start_timestamp:
-            raise ValueError(f"Expected a non-empty value for `start_timestamp` but received {start_timestamp!r}")
+        if not resource_id:
+            raise ValueError(f"Expected a non-empty value for `resource_id` but received {resource_id!r}")
         return self._get(
-            f"/api/v1/categories/{category}/resources/{resource}/{start_timestamp}",
+            f"/api/v1/categories/{category}/resources/{resource}/{resource_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -165,7 +165,7 @@ class ResourcesResource(SyncAPIResource):
 
     def delete(
         self,
-        start_timestamp: Union[str, datetime],
+        resource_id: str,
         *,
         category: str,
         resource: str,
@@ -192,10 +192,10 @@ class ResourcesResource(SyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `category` but received {category!r}")
         if not resource:
             raise ValueError(f"Expected a non-empty value for `resource` but received {resource!r}")
-        if not start_timestamp:
-            raise ValueError(f"Expected a non-empty value for `start_timestamp` but received {start_timestamp!r}")
+        if not resource_id:
+            raise ValueError(f"Expected a non-empty value for `resource_id` but received {resource_id!r}")
         return self._delete(
-            f"/api/v1/categories/{category}/resources/{resource}/{start_timestamp}",
+            f"/api/v1/categories/{category}/resources/{resource}/{resource_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -265,7 +265,7 @@ class AsyncResourcesResource(AsyncAPIResource):
 
     async def retrieve(
         self,
-        start_timestamp: Union[str, datetime],
+        resource_id: str,
         *,
         category: str,
         resource: str,
@@ -292,10 +292,10 @@ class AsyncResourcesResource(AsyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `category` but received {category!r}")
         if not resource:
             raise ValueError(f"Expected a non-empty value for `resource` but received {resource!r}")
-        if not start_timestamp:
-            raise ValueError(f"Expected a non-empty value for `start_timestamp` but received {start_timestamp!r}")
+        if not resource_id:
+            raise ValueError(f"Expected a non-empty value for `resource_id` but received {resource_id!r}")
         return await self._get(
-            f"/api/v1/categories/{category}/resources/{resource}/{start_timestamp}",
+            f"/api/v1/categories/{category}/resources/{resource}/{resource_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -340,7 +340,7 @@ class AsyncResourcesResource(AsyncAPIResource):
 
     async def delete(
         self,
-        start_timestamp: Union[str, datetime],
+        resource_id: str,
         *,
         category: str,
         resource: str,
@@ -367,10 +367,10 @@ class AsyncResourcesResource(AsyncAPIResource):
             raise ValueError(f"Expected a non-empty value for `category` but received {category!r}")
         if not resource:
             raise ValueError(f"Expected a non-empty value for `resource` but received {resource!r}")
-        if not start_timestamp:
-            raise ValueError(f"Expected a non-empty value for `start_timestamp` but received {start_timestamp!r}")
+        if not resource_id:
+            raise ValueError(f"Expected a non-empty value for `resource_id` but received {resource_id!r}")
         return await self._delete(
-            f"/api/v1/categories/{category}/resources/{resource}/{start_timestamp}",
+            f"/api/v1/categories/{category}/resources/{resource}/{resource_id}",
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

{payi-0.1.0a17 → payi-0.1.0a19}/src/payi/resources/ingest.py

@@ -7,7 +7,7 @@ from datetime import datetime
 
 import httpx
 
-from ..types import ingest_bulk_params, ingest_units_params
+from ..types import ingest_units_params
 from .._types import NOT_GIVEN, Body, Query, Headers, NotGiven
 from .._utils import (
     maybe_transform,
@@ -24,6 +24,7 @@ from .._response import (
 )
 from .._base_client import make_request_options
 from ..types.ingest_response import IngestResponse
+from ..types.ingest_event_param import IngestEventParam
 from ..types.bulk_ingest_response import BulkIngestResponse
 
 __all__ = ["IngestResource", "AsyncIngestResource"]
@@ -41,7 +42,7 @@ class IngestResource(SyncAPIResource):
     def bulk(
         self,
         *,
-        events: Iterable[ingest_bulk_params.Event],
+        events: Iterable[IngestEventParam],
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -66,7 +67,7 @@ class IngestResource(SyncAPIResource):
         """
         return self._post(
             "/api/v1/ingest/bulk",
-            body=maybe_transform(events, Iterable[ingest_bulk_params.Event]),
+            body=maybe_transform(events, Iterable[IngestEventParam]),
             options=make_request_options(
                     extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),
@@ -191,7 +192,7 @@ class AsyncIngestResource(AsyncAPIResource):
     async def bulk(
         self,
         *,
-        events: Iterable[ingest_bulk_params.Event],
+        events: Iterable[IngestEventParam],
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
         extra_headers: Headers | None = None,
@@ -215,7 +216,7 @@ class AsyncIngestResource(AsyncAPIResource):
         """
         return await self._post(
             "/api/v1/ingest/bulk",
-            body=await async_maybe_transform(events, Iterable[ingest_bulk_params.Event]),
+            body=await async_maybe_transform(events, Iterable[IngestEventParam]),
             options=make_request_options(
                 extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
             ),

{payi-0.1.0a17 → payi-0.1.0a19}/src/payi/types/__init__.py

@@ -13,6 +13,7 @@ from .category_response import CategoryResponse as CategoryResponse
 from .paged_budget_list import PagedBudgetList as PagedBudgetList
 from .budget_list_params import BudgetListParams as BudgetListParams
 from .ingest_bulk_params import IngestBulkParams as IngestBulkParams
+from .ingest_event_param import IngestEventParam as IngestEventParam
 from .experience_instance import ExperienceInstance as ExperienceInstance
 from .ingest_units_params import IngestUnitsParams as IngestUnitsParams
 from .budget_create_params import BudgetCreateParams as BudgetCreateParams

{payi-0.1.0a17 → payi-0.1.0a19}/src/payi/types/category_resource_response.py

@@ -13,6 +13,8 @@ class CategoryResourceResponse(BaseModel):
 
     resource: str
 
+    resource_id: str
+
     start_timestamp: datetime
 
     input_price: Optional[float] = None

payi-0.1.0a19/src/payi/types/ingest_bulk_params.py

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Required, TypedDict
+
+from .ingest_event_param import IngestEventParam
+
+__all__ = ["IngestBulkParams"]
+
+
+class IngestBulkParams(TypedDict, total=False):
+    events: Required[Iterable[IngestEventParam]]

payi-0.1.0a17/src/payi/types/ingest_bulk_params.py → payi-0.1.0a19/src/payi/types/ingest_event_param.py

@@ -2,19 +2,16 @@
 
 from __future__ import annotations
 
-from typing import List, Union, Iterable, Optional
+from typing import List, Union, Optional
 from datetime import datetime
 from typing_extensions import Required, Annotated, TypedDict
 
 from .._utils import PropertyInfo
 
-__all__ = ["IngestBulkParams", "Event"]
+__all__ = ["IngestEventParam"]
 
 
-class IngestBulkParams(TypedDict, total=False):
-    events: Required[Iterable[Event]]
-
-class Event(TypedDict, total=False):
+class IngestEventParam(TypedDict, total=False):
     category: Required[str]
 
     input: Required[int]