payi 0.1.0a1__py3-none-any.whl

payi/types/paged_budget_list.py

@@ -0,0 +1,110 @@
+# 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__ = [
+    "PagedBudgetList",
+    "Item",
+    "ItemTotals",
+    "ItemTotalsCost",
+    "ItemTotalsCostInputCost",
+    "ItemTotalsCostOutputCost",
+    "ItemTotalsCostTotalCost",
+    "ItemTotalsRequests",
+]
+
+
+class ItemTotalsCostInputCost(BaseModel):
+    base: Optional[float] = None
+
+    overrun_base: Optional[float] = None
+
+
+class ItemTotalsCostOutputCost(BaseModel):
+    base: Optional[float] = None
+
+    overrun_base: Optional[float] = None
+
+
+class ItemTotalsCostTotalCost(BaseModel):
+    base: Optional[float] = None
+
+    overrun_base: Optional[float] = None
+
+
+class ItemTotalsCost(BaseModel):
+    input_cost: Optional[ItemTotalsCostInputCost] = FieldInfo(alias="inputCost", default=None)
+
+    output_cost: Optional[ItemTotalsCostOutputCost] = FieldInfo(alias="outputCost", default=None)
+
+    total_cost: Optional[ItemTotalsCostTotalCost] = FieldInfo(alias="totalCost", default=None)
+
+
+class ItemTotalsRequests(BaseModel):
+    blocked: Optional[int] = None
+
+    error: Optional[int] = None
+
+    exceeded: Optional[int] = None
+
+    failed: Optional[int] = None
+
+    successful: Optional[int] = None
+
+    total: Optional[int] = None
+
+
+class ItemTotals(BaseModel):
+    cost: Optional[ItemTotalsCost] = None
+
+    requests: Optional[ItemTotalsRequests] = None
+
+
+class Item(BaseModel):
+    base_cost_estimate: Literal["Max"]
+
+    budget_creation_timestamp: datetime
+
+    budget_id: str
+
+    budget_name: str
+
+    budget_response_type: Literal["Block", "Allow"]
+
+    budget_type: Literal["Conservative", "Liberal"]
+
+    budget_update_timestamp: datetime
+
+    currency: str
+
+    max: float
+
+    totals: ItemTotals
+
+    budget_tags: Optional[List[str]] = None
+
+
+class PagedBudgetList(BaseModel):
+    current_page: Optional[int] = FieldInfo(alias="currentPage", default=None)
+
+    has_next_page: Optional[bool] = FieldInfo(alias="hasNextPage", default=None)
+
+    has_previous_page: Optional[bool] = FieldInfo(alias="hasPreviousPage", default=None)
+
+    items: Optional[List[Item]] = None
+
+    message: Optional[str] = None
+
+    page_size: Optional[int] = FieldInfo(alias="pageSize", default=None)
+
+    request_id: Optional[str] = None
+
+    total_count: Optional[int] = FieldInfo(alias="totalCount", default=None)
+
+    total_pages: Optional[int] = FieldInfo(alias="totalPages", default=None)

payi/types/successful_proxy_result.py

@@ -0,0 +1,43 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["SuccessfulProxyResult", "Budgets", "Cost", "CostInput", "CostOutput", "CostTotal"]
+
+
+class Budgets(BaseModel):
+    state: Optional[str] = None
+
+
+class CostInput(BaseModel):
+    base: Optional[float] = None
+
+
+class CostOutput(BaseModel):
+    base: Optional[float] = None
+
+
+class CostTotal(BaseModel):
+    base: Optional[float] = None
+
+
+class Cost(BaseModel):
+    currency: Optional[str] = None
+
+    input: Optional[CostInput] = None
+
+    output: Optional[CostOutput] = None
+
+    total: Optional[CostTotal] = None
+
+
+class SuccessfulProxyResult(BaseModel):
+    budgets: Optional[Dict[str, Budgets]] = None
+
+    cost: Optional[Cost] = None
+
+    request_id: Optional[str] = None
+
+    request_tags: Optional[List[str]] = None

payi-0.1.0a1.dist-info/METADATA

@@ -0,0 +1,355 @@
+Metadata-Version: 2.3
+Name: payi
+Version: 0.1.0a1
+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
+Author-email: Payi <support@payi.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.7
+Requires-Dist: anyio<5,>=3.5.0
+Requires-Dist: cached-property; python_version < '3.8'
+Requires-Dist: distro<2,>=1.7.0
+Requires-Dist: httpx<1,>=0.23.0
+Requires-Dist: pydantic<3,>=1.9.0
+Requires-Dist: sniffio
+Requires-Dist: typing-extensions<5,>=4.7
+Description-Content-Type: text/markdown
+
+# Payi Python API library
+
+[![PyPI version](https://img.shields.io/pypi/v/payi.svg)](https://pypi.org/project/payi/)
+
+The Payi Python library provides convenient access to the Payi REST API from any Python 3.7+
+application. The library includes type definitions for all request params and response fields,
+and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
+
+It is generated with [Stainless](https://www.stainlessapi.com/).
+
+## Documentation
+
+The REST API documentation can be found [on docs.payi.com](https://docs.payi.com). The full API of this library can be found in [api.md](https://github.com/Pay-i/pay-i-python/tree/main/api.md).
+
+## Installation
+
+```sh
+# install from PyPI
+pip install --pre payi
+```
+
+## Usage
+
+The full API of this library can be found in [api.md](https://github.com/Pay-i/pay-i-python/tree/main/api.md).
+
+```python
+import os
+from payi import Payi
+
+client = Payi(
+    # This is the default and can be omitted
+    payi_api_key=os.environ.get("PAYI_API_KEY"),
+)
+
+budget_response = client.budgets.create(
+    budget_name="x",
+    max=0,
+)
+print(budget_response.request_id)
+```
+
+While you can provide a `payi_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.
+
+## Async usage
+
+Simply import `AsyncPayi` instead of `Payi` and use `await` with each API call:
+
+```python
+import os
+import asyncio
+from payi import AsyncPayi
+
+client = AsyncPayi(
+    # This is the default and can be omitted
+    payi_api_key=os.environ.get("PAYI_API_KEY"),
+)
+
+
+async def main() -> None:
+    budget_response = await client.budgets.create(
+        budget_name="x",
+        max=0,
+    )
+    print(budget_response.request_id)
+
+
+asyncio.run(main())
+```
+
+Functionality between the synchronous and asynchronous clients is otherwise identical.
+
+## Using types
+
+Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
+
+- Serializing back into JSON, `model.to_json()`
+- Converting to a dictionary, `model.to_dict()`
+
+Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
+
+## Handling errors
+
+When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `payi.APIConnectionError` is raised.
+
+When the API returns a non-success status code (that is, 4xx or 5xx
+response), a subclass of `payi.APIStatusError` is raised, containing `status_code` and `response` properties.
+
+All errors inherit from `payi.APIError`.
+
+```python
+import payi
+from payi import Payi
+
+client = Payi()
+
+try:
+    client.budgets.create(
+        budget_name="x",
+        max=0,
+    )
+except payi.APIConnectionError as e:
+    print("The server could not be reached")
+    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
+except payi.RateLimitError as e:
+    print("A 429 status code was received; we should back off a bit.")
+except payi.APIStatusError as e:
+    print("Another non-200-range status code was received")
+    print(e.status_code)
+    print(e.response)
+```
+
+Error codes are as followed:
+
+| Status Code | Error Type                 |
+| ----------- | -------------------------- |
+| 400         | `BadRequestError`          |
+| 401         | `AuthenticationError`      |
+| 403         | `PermissionDeniedError`    |
+| 404         | `NotFoundError`            |
+| 422         | `UnprocessableEntityError` |
+| 429         | `RateLimitError`           |
+| >=500       | `InternalServerError`      |
+| N/A         | `APIConnectionError`       |
+
+### Retries
+
+Certain errors are automatically retried 2 times by default, with a short exponential backoff.
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
+429 Rate Limit, and >=500 Internal errors are all retried by default.
+
+You can use the `max_retries` option to configure or disable retry settings:
+
+```python
+from payi import Payi
+
+# Configure the default for all requests:
+client = Payi(
+    # default is 2
+    max_retries=0,
+)
+
+# Or, configure per-request:
+client.with_options(max_retries=5).budgets.create(
+    budget_name="x",
+    max=0,
+)
+```
+
+### Timeouts
+
+By default requests time out after 1 minute. You can configure this with a `timeout` option,
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+
+```python
+from payi import Payi
+
+# Configure the default for all requests:
+client = Payi(
+    # 20 seconds (default is 1 minute)
+    timeout=20.0,
+)
+
+# More granular control:
+client = Payi(
+    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
+)
+
+# Override per-request:
+client.with_options(timeout=5.0).budgets.create(
+    budget_name="x",
+    max=0,
+)
+```
+
+On timeout, an `APITimeoutError` is thrown.
+
+Note that requests that time out are [retried twice by default](https://github.com/Pay-i/pay-i-python/tree/main/#retries).
+
+## Advanced
+
+### Logging
+
+We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
+
+You can enable logging by setting the environment variable `PAYI_LOG` to `debug`.
+
+```shell
+$ export PAYI_LOG=debug
+```
+
+### How to tell whether `None` means `null` or missing
+
+In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:
+
+```py
+if response.my_field is None:
+  if 'my_field' not in response.model_fields_set:
+    print('Got json like {}, without a "my_field" key present at all.')
+  else:
+    print('Got json like {"my_field": null}.')
+```
+
+### Accessing raw response data (e.g. headers)
+
+The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
+
+```py
+from payi import Payi
+
+client = Payi()
+response = client.budgets.with_raw_response.create(
+    budget_name="x",
+    max=0,
+)
+print(response.headers.get('X-My-Header'))
+
+budget = response.parse()  # get the object that `budgets.create()` would have returned
+print(budget.request_id)
+```
+
+These methods return an [`APIResponse`](https://github.com/Pay-i/pay-i-python/tree/main/src/payi/_response.py) object.
+
+The async client returns an [`AsyncAPIResponse`](https://github.com/Pay-i/pay-i-python/tree/main/src/payi/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+
+#### `.with_streaming_response`
+
+The above interface eagerly reads the full response body when you make the request, which may not always be what you want.
+
+To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
+
+```python
+with client.budgets.with_streaming_response.create(
+    budget_name="x",
+    max=0,
+) as response:
+    print(response.headers.get("X-My-Header"))
+
+    for line in response.iter_lines():
+        print(line)
+```
+
+The context manager is required so that the response will reliably be closed.
+
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API.
+
+If you need to access undocumented endpoints, params, or response properties, the library can still be used.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
+http verbs. Options on the client will be respected (such as retries) will be respected when making this
+request.
+
+```py
+import httpx
+
+response = client.post(
+    "/foo",
+    cast_to=httpx.Response,
+    body={"my_param": True},
+)
+
+print(response.headers.get("x-foo"))
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
+options.
+
+#### Undocumented response properties
+
+To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
+can also get all the extra fields on the Pydantic model as a dict with
+[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
+
+### Configuring the HTTP client
+
+You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:
+
+- Support for proxies
+- Custom transports
+- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality
+
+```python
+from payi import Payi, DefaultHttpxClient
+
+client = Payi(
+    # Or use the `PAYI_BASE_URL` env var
+    base_url="http://my.test.server.example.com:8083",
+    http_client=DefaultHttpxClient(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+### Managing HTTP resources
+
+By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
+
+## Versioning
+
+This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
+
+1. Changes that only affect static types, without breaking runtime behavior.
+2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
+3. Changes that we do not expect to impact the vast majority of users in practice.
+
+We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
+
+We are keen for your feedback; please open an [issue](https://www.github.com/Pay-i/pay-i-python/issues) with questions, bugs, or suggestions.
+
+## Requirements
+
+Python 3.7 or higher.

payi-0.1.0a1.dist-info/RECORD

@@ -0,0 +1,54 @@
+payi/__init__.py,sha256=LWpfR6WSMPTnmmx3ToqqZ0A8CNduLcuxY1SSOqhPxuk,2381
+payi/_base_client.py,sha256=70yaoCPiDyAppE3S2nKsAfpKOztY3SEjlhJq2898umc,65090
+payi/_client.py,sha256=3TEqpqgp7k3b6dUCJoi0zPctQfqXJqMhgC-2qszwgqY,15794
+payi/_compat.py,sha256=m0I0haqFZuVxd5m227_8nNmvA1saXyuNJ7BjidX_PTE,6389
+payi/_constants.py,sha256=JE8kyZa2Q4NK_i4fO--8siEYTzeHnT0fYbOFDgDP4uk,464
+payi/_exceptions.py,sha256=ItygKNrNXIVY0H6LsGVZvFuAHB3Vtm_VZXmWzCnpHy0,3216
+payi/_files.py,sha256=me2eyWzJCM4YKh10Gzkxw4YyIEJoikzD4BVu_20UUc0,3565
+payi/_models.py,sha256=kbTvpEMoo6a_660jyvLNARXzS7fsSlg-O0yQrjJpdBs,26876
+payi/_qs.py,sha256=AOkSz4rHtK4YI3ZU_kzea-zpwBUgEY8WniGmTPyEimc,4846
+payi/_resource.py,sha256=j2jIkTr8OIC8sU6-05nxSaCyj4MaFlbZrwlyg4_xJos,1088
+payi/_response.py,sha256=W6pADUzbnMFGnVzGY4M3FkX9uvw8AFSMTPZKPgQ_TV4,28363
+payi/_streaming.py,sha256=Z_wIyo206T6Jqh2rolFg2VXZgX24PahLmpURp0-NssU,10092
+payi/_types.py,sha256=04q-KHD-qZ1xlfwEb_muyIHWmD-nZ-KxnRxA_QEjqNk,6125
+payi/_version.py,sha256=e2If7JaNfvxUOJifzuPWASTV-94TV2d16oG-vZydnAs,164
+payi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+payi/_utils/__init__.py,sha256=q5QC6ZmVNli9QaCqTlp9VrbQyjIU9EzmCn044UhHSIk,1919
+payi/_utils/_logs.py,sha256=fmnf5D9TOgkgZKfgYmSa3PiUc3SZgkchn6CzJUeo0SQ,768
+payi/_utils/_proxy.py,sha256=DjcB-BBIRagSbMut2pF_jZavjda9sPvmQCKtVXBhs0I,1910
+payi/_utils/_reflection.py,sha256=Xloc_oanCC3gmAVBRhlMYtvYeLNZGi46gGWhDt9FtKI,275
+payi/_utils/_streams.py,sha256=SMC90diFFecpEg_zgDRVbdR3hSEIgVVij4taD-noMLM,289
+payi/_utils/_sync.py,sha256=9ex9pfOyd8xAF1LxpFx4IkqL8k0vk8srE2Ee-OTMQ0A,2840
+payi/_utils/_transform.py,sha256=NCz3q9_O-vuj60xVe-qzhEQ8uJWlZWJTsM-GwHDccf8,12958
+payi/_utils/_typing.py,sha256=tFbktdpdHCQliwzGsWysgn0P5H0JRdagkZdb_LegGkY,3838
+payi/_utils/_utils.py,sha256=FaZdW0tWil7IERdxUfKt7pVcyXL2aCnR3lo73q66qgI,11447
+payi/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
+payi/resources/__init__.py,sha256=-y_brRr5l-JY1Yw9Krm_z0NMPR56m5ar0EUC3ZeQaus,1120
+payi/resources/ingest_requests.py,sha256=UWI3dA9hfDDmA5yWdb_P98G1ic5NZtdnufuspOZqRlM,6493
+payi/resources/budgets/__init__.py,sha256=w1UhOdDXtUH4A91ME5Tw2nr9bRvPJyJY1YWiVVy7jj0,989
+payi/resources/budgets/budgets.py,sha256=mFvPXjXyDafBrFDsR4ARrohOBkcTe9MA3YVz8uHvSaI,26684
+payi/resources/budgets/tags.py,sha256=zF9N3Oqo_3ydRHMCJpv_YlPZYUci1WfJ0swZFXAtn4U,20051
+payi/types/__init__.py,sha256=aGTmOKZy8UYiOqbLBNUrA9XVWqczs0_3x3qGQX175Xw,800
+payi/types/budget_create_params.py,sha256=RBfpVn_xLnZ0dQQU6uypsdcAN8Hw0NlBP67G7VeBx04,680
+payi/types/budget_history_response.py,sha256=SeOabYz6xQvH4YkJSejbk_dUB49LZy7Y2MXZFPvrYMY,2702
+payi/types/budget_list_params.py,sha256=fZisMqFSaIytDwHb_TNyHERnMgMKxz6SrVy914vfVak,765
+payi/types/budget_response.py,sha256=yXDXIrespfRuNreWdWmlCITO6VvLC4YZn0nzXw_BGzo,2072
+payi/types/budget_update_params.py,sha256=ceAaCqoERpoKeqTOv6NY1yjXrcnZMq3BSmUxy2dI7JQ,443
+payi/types/default_response.py,sha256=o617LpRsCIZHCZxAc5nVI2JQ3HPGZo4gCDvSDkxkIJ8,270
+payi/types/ingest_request_create_params.py,sha256=5uLPGwExcBQ6dcoA_YJbBKfwLvgxjKUMFS31f85Z9UY,650
+payi/types/paged_budget_list.py,sha256=HNm834IAAy3eRNz0BjZwcbD9e-I8unWWKWxiSnlijWY,2553
+payi/types/successful_proxy_result.py,sha256=j8kQu8LAcfR3XuforqWDsYm1Bx6BQxCrezmE-3GnCWc,893
+payi/types/budgets/__init__.py,sha256=8lpRHXZQOc9ADCphhCB0JhQAH96lBIc68LbhlJn5Kys,750
+payi/types/budgets/budget_tags_response.py,sha256=o3zaMs9b0gJqKrWuui3ohUVsR2cwNGR0yttBclgXapo,513
+payi/types/budgets/tag_create_params.py,sha256=dKpX2tPtcJuiyXJcYsRni4wq_EwU7F05z35qovssleA,452
+payi/types/budgets/tag_create_response.py,sha256=2SWGig_rx8J5fEN0XUX2t6tZLnS5OQ1PcD5Bxc46rdY,244
+payi/types/budgets/tag_delete_response.py,sha256=JuXfffM_poGX_K1lLWCkW8yUdUiod1XNc8s-iN-RYdY,244
+payi/types/budgets/tag_list_response.py,sha256=9PUbi3clybFPD7Xo4Op6GmSjFet2gw7P2Kyx7IJg0_s,240
+payi/types/budgets/tag_remove_params.py,sha256=dO7yymyt2EM7kmLCr-mdR4IOGVcIpOPNCUCv7jdNEDE,452
+payi/types/budgets/tag_remove_response.py,sha256=Gc_eBGGSx6Afa51g-S5AkXqwmRcGMjshiNSBsthDZJc,244
+payi/types/budgets/tag_update_params.py,sha256=ymYX9umkDg5_l2UlhW8uJpA3CfTvoRkO25mj9vj98sQ,452
+payi/types/budgets/tag_update_response.py,sha256=5Q16vkLUMLkyzgCWRcz7aDVA0KTCHQd_eAKnx2-VoWQ,244
+payi-0.1.0a1.dist-info/METADATA,sha256=xbdw14fMkvRpo38COIfFWKbYOdN9GI5JnF8g5Sb-bVI,11872
+payi-0.1.0a1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+payi-0.1.0a1.dist-info/licenses/LICENSE,sha256=8vX1pjh3esb6D5DvXAf6NxiBcVyon8aHWNJCxmmHXeY,11334
+payi-0.1.0a1.dist-info/RECORD,,

payi-0.1.0a1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any