pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/refunds/types/__init__.py

@@ -0,0 +1,52 @@
+# 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 .create_refund_request_order_amount import CreateRefundRequestOrderAmount
+    from .create_refund_request_products_item import CreateRefundRequestProductsItem
+    from .create_refund_request_split_info import CreateRefundRequestSplitInfo
+    from .create_refund_request_split_info_split_details_item import CreateRefundRequestSplitInfoSplitDetailsItem
+    from .create_refund_request_split_info_split_details_item_amount import (
+        CreateRefundRequestSplitInfoSplitDetailsItemAmount,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateRefundRequestOrderAmount": ".create_refund_request_order_amount",
+    "CreateRefundRequestProductsItem": ".create_refund_request_products_item",
+    "CreateRefundRequestSplitInfo": ".create_refund_request_split_info",
+    "CreateRefundRequestSplitInfoSplitDetailsItem": ".create_refund_request_split_info_split_details_item",
+    "CreateRefundRequestSplitInfoSplitDetailsItemAmount": ".create_refund_request_split_info_split_details_item_amount",
+}
+
+
+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__ = [
+    "CreateRefundRequestOrderAmount",
+    "CreateRefundRequestProductsItem",
+    "CreateRefundRequestSplitInfo",
+    "CreateRefundRequestSplitInfoSplitDetailsItem",
+    "CreateRefundRequestSplitInfoSplitDetailsItemAmount",
+]

pinelabs/refunds/types/create_refund_request_order_amount.py

@@ -0,0 +1,31 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class CreateRefundRequestOrderAmount(UniversalBaseModel):
+    """
+    The refund amount details.
+    """
+
+    value: int = pydantic.Field()
+    """
+    Refund amount in the smallest currency unit (e.g., paisa for INR). Minimum ₹1 (100 paisa).
+    """
+
+    currency: str = pydantic.Field()
+    """
+    Three-letter ISO 4217 currency code.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/refunds/types/create_refund_request_products_item.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class CreateRefundRequestProductsItem(UniversalBaseModel):
+    product_code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Product code/SKU.
+    """
+
+    imei_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    IMEI number to block for partial refunds.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/refunds/types/create_refund_request_split_info.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .create_refund_request_split_info_split_details_item import CreateRefundRequestSplitInfoSplitDetailsItem
+
+
+class CreateRefundRequestSplitInfo(UniversalBaseModel):
+    """
+    Split settlement information for refunds involving split payments.
+    """
+
+    split_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Type of split.
+    """
+
+    split_details: typing.Optional[typing.List[CreateRefundRequestSplitInfoSplitDetailsItem]] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/refunds/types/create_refund_request_split_info_split_details_item.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .create_refund_request_split_info_split_details_item_amount import (
+    CreateRefundRequestSplitInfoSplitDetailsItemAmount,
+)
+
+
+class CreateRefundRequestSplitInfoSplitDetailsItem(UniversalBaseModel):
+    split_merchant_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the partner merchant.
+    """
+
+    merchant_settlement_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Merchant settlement reference for the split.
+    """
+
+    amount: typing.Optional[CreateRefundRequestSplitInfoSplitDetailsItemAmount] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/refunds/types/create_refund_request_split_info_split_details_item_amount.py

@@ -0,0 +1,20 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class CreateRefundRequestSplitInfoSplitDetailsItemAmount(UniversalBaseModel):
+    value: typing.Optional[int] = None
+    currency: typing.Optional[str] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/settlements/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+

pinelabs/settlements/client.py

@@ -0,0 +1,283 @@
+# 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.list_settlements_response import ListSettlementsResponse
+from ..types.settlement_by_utr_response import SettlementByUtrResponse
+from .raw_client import AsyncRawSettlementsClient, RawSettlementsClient
+
+
+class SettlementsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawSettlementsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawSettlementsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawSettlementsClient
+        """
+        return self._raw_client
+
+    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,
+    ) -> 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
+        -------
+        ListSettlementsResponse
+            Settlements retrieved successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.settlements.get_all_settlements(
+            start_date="2024-10-01",
+            end_date="2024-10-09",
+            page="1",
+            per_page="10",
+        )
+        """
+        _response = self._raw_client.get_all_settlements(
+            start_date=start_date, end_date=end_date, page=page, per_page=per_page, request_options=request_options
+        )
+        return _response.data
+
+    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,
+    ) -> 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
+        -------
+        SettlementByUtrResponse
+            Settlement details retrieved successfully.
+
+        Examples
+        --------
+        from pinelabs import PinelabsApi
+
+        client = PinelabsApi(
+            request_timestamp="YOUR_REQUEST_TIMESTAMP",
+            request_id="YOUR_REQUEST_ID",
+            token="YOUR_TOKEN",
+        )
+        client.settlements.get_settlements_by_utr(
+            utr="410092786849",
+            page="1",
+            per_page="10",
+        )
+        """
+        _response = self._raw_client.get_settlements_by_utr(
+            utr, page=page, per_page=per_page, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncSettlementsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawSettlementsClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawSettlementsClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawSettlementsClient
+        """
+        return self._raw_client
+
+    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,
+    ) -> 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
+        -------
+        ListSettlementsResponse
+            Settlements retrieved 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.settlements.get_all_settlements(
+                start_date="2024-10-01",
+                end_date="2024-10-09",
+                page="1",
+                per_page="10",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_all_settlements(
+            start_date=start_date, end_date=end_date, page=page, per_page=per_page, request_options=request_options
+        )
+        return _response.data
+
+    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,
+    ) -> 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
+        -------
+        SettlementByUtrResponse
+            Settlement details retrieved 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.settlements.get_settlements_by_utr(
+                utr="410092786849",
+                page="1",
+                per_page="10",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_settlements_by_utr(
+            utr, page=page, per_page=per_page, request_options=request_options
+        )
+        return _response.data