pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/settlements/raw_client.py

@@ -0,0 +1,421 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import encode_path_param
+from ..core.parse_error import ParsingError
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..errors.bad_request_error import BadRequestError
+from ..errors.internal_server_error import InternalServerError
+from ..errors.unauthorized_error import UnauthorizedError
+from ..types.error_response import ErrorResponse
+from ..types.list_settlements_response import ListSettlementsResponse
+from ..types.settlement_by_utr_response import SettlementByUtrResponse
+from pydantic import ValidationError
+
+
+class RawSettlementsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_all_settlements(
+        self,
+        *,
+        start_date: str,
+        end_date: str,
+        page: typing.Optional[str] = None,
+        per_page: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[ListSettlementsResponse]:
+        """
+        Retrieves all settlements within a specified date range.
+
+        **Notes:**
+        - Maximum date range for retrieving settlement data is 60 days.
+        - API supports a maximum of 10 records per page, one page at a time.
+
+        Parameters
+        ----------
+        start_date : str
+            Start date for settlement retrieval.
+
+        end_date : str
+            End date for settlement retrieval.
+
+        page : typing.Optional[str]
+            Page number to retrieve.
+
+        per_page : typing.Optional[str]
+            Number of records per page (max 10).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[ListSettlementsResponse]
+            Settlements retrieved successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "api/settlements/v1/list",
+            method="GET",
+            params={
+                "start_date": start_date,
+                "end_date": end_date,
+                "page": page,
+                "per_page": per_page,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ListSettlementsResponse,
+                    parse_obj_as(
+                        type_=ListSettlementsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def get_settlements_by_utr(
+        self,
+        utr: str,
+        *,
+        page: typing.Optional[str] = None,
+        per_page: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[SettlementByUtrResponse]:
+        """
+        Retrieves detailed settlement information for a specific UTR (Unique Transaction Reference).
+
+        **Notes:**
+        - Maximum date range for retrieving settlement data is 60 days.
+        - API supports a maximum of 10 records per page, one page at a time.
+
+        Parameters
+        ----------
+        utr : str
+            Unique Transaction Reference number.
+
+        page : typing.Optional[str]
+            Page number to retrieve.
+
+        per_page : typing.Optional[str]
+            Number of records per page (max 10).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[SettlementByUtrResponse]
+            Settlement details retrieved successfully.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"api/settlements/v1/detail/{encode_path_param(utr)}",
+            method="GET",
+            params={
+                "page": page,
+                "per_page": per_page,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SettlementByUtrResponse,
+                    parse_obj_as(
+                        type_=SettlementByUtrResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawSettlementsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_all_settlements(
+        self,
+        *,
+        start_date: str,
+        end_date: str,
+        page: typing.Optional[str] = None,
+        per_page: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[ListSettlementsResponse]:
+        """
+        Retrieves all settlements within a specified date range.
+
+        **Notes:**
+        - Maximum date range for retrieving settlement data is 60 days.
+        - API supports a maximum of 10 records per page, one page at a time.
+
+        Parameters
+        ----------
+        start_date : str
+            Start date for settlement retrieval.
+
+        end_date : str
+            End date for settlement retrieval.
+
+        page : typing.Optional[str]
+            Page number to retrieve.
+
+        per_page : typing.Optional[str]
+            Number of records per page (max 10).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[ListSettlementsResponse]
+            Settlements retrieved successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "api/settlements/v1/list",
+            method="GET",
+            params={
+                "start_date": start_date,
+                "end_date": end_date,
+                "page": page,
+                "per_page": per_page,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ListSettlementsResponse,
+                    parse_obj_as(
+                        type_=ListSettlementsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def get_settlements_by_utr(
+        self,
+        utr: str,
+        *,
+        page: typing.Optional[str] = None,
+        per_page: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[SettlementByUtrResponse]:
+        """
+        Retrieves detailed settlement information for a specific UTR (Unique Transaction Reference).
+
+        **Notes:**
+        - Maximum date range for retrieving settlement data is 60 days.
+        - API supports a maximum of 10 records per page, one page at a time.
+
+        Parameters
+        ----------
+        utr : str
+            Unique Transaction Reference number.
+
+        page : typing.Optional[str]
+            Page number to retrieve.
+
+        per_page : typing.Optional[str]
+            Number of records per page (max 10).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[SettlementByUtrResponse]
+            Settlement details retrieved successfully.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"api/settlements/v1/detail/{encode_path_param(utr)}",
+            method="GET",
+            params={
+                "page": page,
+                "per_page": per_page,
+            },
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SettlementByUtrResponse,
+                    parse_obj_as(
+                        type_=SettlementByUtrResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        ErrorResponse,
+                        parse_obj_as(
+                            type_=ErrorResponse,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

pinelabs/split_settlements/__init__.py

@@ -0,0 +1,34 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import ReleaseSettlementRequestReleaseAmount
+_dynamic_imports: typing.Dict[str, str] = {"ReleaseSettlementRequestReleaseAmount": ".types"}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = ["ReleaseSettlementRequestReleaseAmount"]

pinelabs/split_settlements/client.py

@@ -0,0 +1,254 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.split_settlement_response import SplitSettlementResponse
+from .raw_client import AsyncRawSplitSettlementsClient, RawSplitSettlementsClient
+from .types.release_settlement_request_release_amount import ReleaseSettlementRequestReleaseAmount
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class SplitSettlementsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawSplitSettlementsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawSplitSettlementsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawSplitSettlementsClient
+        """
+        return self._raw_client
+
+    def release_settlement(
+        self,
+        order_id: str,
+        settlement_id: str,
+        *,
+        release_amount: typing.Optional[ReleaseSettlementRequestReleaseAmount] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SplitSettlementResponse:
+        """
+        Releases a held split settlement for a specific order.
+
+        **Notes:**
+        - This API can only be used for orders with split settlements.
+        - Use the Create Orders API to create a split settlement order.
+
+        Parameters
+        ----------
+        order_id : str
+            The unique order identifier.
+
+        settlement_id : str
+            The unique split settlement identifier.
+
+        release_amount : typing.Optional[ReleaseSettlementRequestReleaseAmount]
+            The amount to release from the held settlement.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SplitSettlementResponse
+            Settlement released successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+        from pinelabs.split_settlements import ReleaseSettlementRequestReleaseAmount
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.split_settlements.release_settlement(
+            order_id="v1-250513055632-aa-rjIIWX",
+            settlement_id="v1-250513055632-aa-rjIIWX-ss-f",
+            release_amount=ReleaseSettlementRequestReleaseAmount(
+                value=10000,
+                currency="INR",
+            ),
+        )
+        """
+        _response = self._raw_client.release_settlement(
+            order_id, settlement_id, release_amount=release_amount, request_options=request_options
+        )
+        return _response.data
+
+    def cancel_settlement(
+        self, order_id: str, settlement_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> SplitSettlementResponse:
+        """
+        Cancels a held split settlement for a specific order.
+
+        Parameters
+        ----------
+        order_id : str
+            The unique order identifier.
+
+        settlement_id : str
+            The unique split settlement identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SplitSettlementResponse
+            Settlement cancelled successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.split_settlements.cancel_settlement(
+            order_id="v1-250513055632-aa-rjIIWX",
+            settlement_id="v1-250513055632-aa-rjIIWX-ss-g",
+        )
+        """
+        _response = self._raw_client.cancel_settlement(order_id, settlement_id, request_options=request_options)
+        return _response.data
+
+
+class AsyncSplitSettlementsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawSplitSettlementsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawSplitSettlementsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawSplitSettlementsClient
+        """
+        return self._raw_client
+
+    async def release_settlement(
+        self,
+        order_id: str,
+        settlement_id: str,
+        *,
+        release_amount: typing.Optional[ReleaseSettlementRequestReleaseAmount] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> SplitSettlementResponse:
+        """
+        Releases a held split settlement for a specific order.
+
+        **Notes:**
+        - This API can only be used for orders with split settlements.
+        - Use the Create Orders API to create a split settlement order.
+
+        Parameters
+        ----------
+        order_id : str
+            The unique order identifier.
+
+        settlement_id : str
+            The unique split settlement identifier.
+
+        release_amount : typing.Optional[ReleaseSettlementRequestReleaseAmount]
+            The amount to release from the held settlement.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SplitSettlementResponse
+            Settlement released successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi
+        from pinelabs.split_settlements import ReleaseSettlementRequestReleaseAmount
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.split_settlements.release_settlement(
+                order_id="v1-250513055632-aa-rjIIWX",
+                settlement_id="v1-250513055632-aa-rjIIWX-ss-f",
+                release_amount=ReleaseSettlementRequestReleaseAmount(
+                    value=10000,
+                    currency="INR",
+                ),
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.release_settlement(
+            order_id, settlement_id, release_amount=release_amount, request_options=request_options
+        )
+        return _response.data
+
+    async def cancel_settlement(
+        self, order_id: str, settlement_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> SplitSettlementResponse:
+        """
+        Cancels a held split settlement for a specific order.
+
+        Parameters
+        ----------
+        order_id : str
+            The unique order identifier.
+
+        settlement_id : str
+            The unique split settlement identifier.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        SplitSettlementResponse
+            Settlement cancelled successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from pinelabs import AsyncPinelabsApi
+
+        client = AsyncPinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+
+
+        async def main() -> None:
+            await client.split_settlements.cancel_settlement(
+                order_id="v1-250513055632-aa-rjIIWX",
+                settlement_id="v1-250513055632-aa-rjIIWX-ss-g",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.cancel_settlement(order_id, settlement_id, request_options=request_options)
+        return _response.data