pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/types/issuer_offer.py

@@ -0,0 +1,59 @@
+# 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 .issuer_offer_issuer_data import IssuerOfferIssuerData
+from .issuer_offer_issuer_type import IssuerOfferIssuerType
+from .tenure import Tenure
+
+
+class IssuerOffer(UniversalBaseModel):
+    """
+    Issuer with available EMI offers.
+    """
+
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the issuer id in the Pine Labs Online database.
+    """
+
+    name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Name of the Issuer.
+    """
+
+    display_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Name of the issuer offering the offer.
+    """
+
+    issuer_type: typing.Optional[IssuerOfferIssuerType] = pydantic.Field(default=None)
+    """
+    The type of the Issuer offering the offer.
+    """
+
+    priority: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    The priority of the issuer providing the offer.
+    """
+
+    tenures: typing.Optional[typing.List[Tenure]] = pydantic.Field(default=None)
+    """
+    Available EMI tenures for this issuer.
+    """
+
+    issuer_data: typing.Optional[IssuerOfferIssuerData] = pydantic.Field(default=None)
+    """
+    Issuer-specific data including OTP and consent details.
+    """
+
+    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/types/issuer_offer_issuer_data.py

@@ -0,0 +1,79 @@
+# 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 .issuer_offer_issuer_data_auth_type import IssuerOfferIssuerDataAuthType
+from .issuer_offer_issuer_data_penny_transaction_amount import IssuerOfferIssuerDataPennyTransactionAmount
+
+
+class IssuerOfferIssuerData(UniversalBaseModel):
+    """
+    Issuer-specific data including OTP and consent details.
+    """
+
+    otp_length: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Length of the OTP.
+    """
+
+    otp_time_in_sec: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    OTP validity time in seconds.
+    """
+
+    otp_retry_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Maximum OTP retry count.
+    """
+
+    is_consent_page_required: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether consent page is required.
+    """
+
+    consent_data: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Transaction consent data (HTML).
+    """
+
+    terms_and_conditions: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Transaction terms and conditions.
+    """
+
+    show_key_fact_statement: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether key fact statement needs to be displayed.
+    """
+
+    auth_type: typing.Optional[IssuerOfferIssuerDataAuthType] = pydantic.Field(default=None)
+    """
+    Authentication type.
+    """
+
+    penny_transaction_amount: typing.Optional[IssuerOfferIssuerDataPennyTransactionAmount] = None
+    is_tokenized_transaction_supported: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether tokenized transactions are supported.
+    """
+
+    pan_number_last_digit_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Last digit count of PAN.
+    """
+
+    offer_validation_parameters_required: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Parameters required in offer validation API.
+    """
+
+    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/types/issuer_offer_issuer_data_auth_type.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+IssuerOfferIssuerDataAuthType = typing.Union[typing.Literal["PENNY_DROP", "OTP"], typing.Any]

pinelabs/types/issuer_offer_issuer_data_penny_transaction_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 IssuerOfferIssuerDataPennyTransactionAmount(UniversalBaseModel):
+    currency: typing.Optional[str] = None
+    value: typing.Optional[int] = 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/types/issuer_offer_issuer_type.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+IssuerOfferIssuerType = typing.Union[
+    typing.Literal[
+        "CC_BANK", "DC_BANK", "CARDLESS_BANK", "CC_NBFC", "DC_NBFC", "CARDLESS_NBFC", "NTB", "NTB_BANK", "NTB_NBFC"
+    ],
+    typing.Any,
+]

pinelabs/types/list_plans_response.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
+from .page_info import PageInfo
+from .pagination_links import PaginationLinks
+from .plan_response import PlanResponse
+
+
+class ListPlansResponse(UniversalBaseModel):
+    """
+    Response returned when listing all plans.
+    """
+
+    links: typing.Optional[PaginationLinks] = None
+    page: typing.Optional[PageInfo] = None
+    plans: typing.Optional[typing.List[PlanResponse]] = pydantic.Field(default=None)
+    """
+    List of plan records.
+    """
+
+    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/types/list_presentations_response.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
+from .page_info import PageInfo
+from .pagination_links import PaginationLinks
+from .presentation_detail import PresentationDetail
+
+
+class ListPresentationsResponse(UniversalBaseModel):
+    """
+    Response returned when listing presentations by subscription ID.
+    """
+
+    links: typing.Optional[PaginationLinks] = None
+    page: typing.Optional[PageInfo] = None
+    presentations: typing.Optional[typing.List[PresentationDetail]] = pydantic.Field(default=None)
+    """
+    List of presentation records.
+    """
+
+    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/types/list_settlements_response.py

@@ -0,0 +1,42 @@
+# 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 .settlement_summary import SettlementSummary
+
+
+class ListSettlementsResponse(UniversalBaseModel):
+    """
+    Response from the Get All Settlements API.
+    """
+
+    data: typing.Optional[typing.List[SettlementSummary]] = pydantic.Field(default=None)
+    """
+    Array of settlement summary objects.
+    """
+
+    total_settlement_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total number of settlements matching the query.
+    """
+
+    total_transactions_count: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total number of transactions across all settlements.
+    """
+
+    total_settlement_amount: typing.Optional[float] = pydantic.Field(default=None)
+    """
+    Total settlement amount across all settlements.
+    """
+
+    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/types/list_subscriptions_response.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
+from .page_info import PageInfo
+from .pagination_links import PaginationLinks
+from .subscription_detail import SubscriptionDetail
+
+
+class ListSubscriptionsResponse(UniversalBaseModel):
+    """
+    Response returned when listing all subscriptions.
+    """
+
+    links: typing.Optional[PaginationLinks] = None
+    page: typing.Optional[PageInfo] = None
+    subscriptions: typing.Optional[typing.List[SubscriptionDetail]] = pydantic.Field(default=None)
+    """
+    List of subscription records.
+    """
+
+    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/types/merchant_metadata.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+MerchantMetadata = typing.Dict[str, str]
+"""
+Arbitrary key-value pairs for merchant use. Maximum 10 pairs, 256 characters each.
+"""

pinelabs/types/net_banking_data_response.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 .net_banking_data_response_txn_mode import NetBankingDataResponseTxnMode
+
+
+class NetBankingDataResponse(UniversalBaseModel):
+    """
+    Net banking details returned in the payment response.
+    """
+
+    pay_code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Bank code used for the transaction.
+    """
+
+    txn_mode: typing.Optional[NetBankingDataResponseTxnMode] = pydantic.Field(default=None)
+    """
+    Net banking transaction mode.
+    """
+
+    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/types/net_banking_data_response_txn_mode.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+NetBankingDataResponseTxnMode = typing.Union[typing.Literal["REDIRECT", "QR", "INTENT"], typing.Any]

pinelabs/types/offer_discovery_error_response.py

@@ -0,0 +1,34 @@
+# 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 .offer_discovery_error_response_additional_error_details import OfferDiscoveryErrorResponseAdditionalErrorDetails
+
+
+class OfferDiscoveryErrorResponse(UniversalBaseModel):
+    """
+    Error response for Offer Discovery API.
+    """
+
+    code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error code.
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message.
+    """
+
+    additional_error_details: typing.Optional[OfferDiscoveryErrorResponseAdditionalErrorDetails] = 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/types/offer_discovery_error_response_additional_error_details.py

@@ -0,0 +1,22 @@
+# 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 OfferDiscoveryErrorResponseAdditionalErrorDetails(UniversalBaseModel):
+    source: typing.Optional[str] = None
+    step: typing.Optional[str] = None
+    field: typing.Optional[str] = None
+    reason: 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/types/offer_discovery_response.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
+from .issuer_offer import IssuerOffer
+
+
+class OfferDiscoveryResponse(UniversalBaseModel):
+    """
+    Response containing discovered offers with EMI details.
+    """
+
+    issuers: typing.Optional[typing.List[IssuerOffer]] = pydantic.Field(default=None)
+    """
+    List of issuers with available offers.
+    """
+
+    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/types/offer_validation_error_response.py

@@ -0,0 +1,22 @@
+# 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 .offer_validation_error_response_additional_error_details import OfferValidationErrorResponseAdditionalErrorDetails
+
+
+class OfferValidationErrorResponse(UniversalBaseModel):
+    code: typing.Optional[str] = None
+    message: typing.Optional[str] = None
+    additional_error_details: typing.Optional[OfferValidationErrorResponseAdditionalErrorDetails] = 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/types/offer_validation_error_response_additional_error_details.py

@@ -0,0 +1,22 @@
+# 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 OfferValidationErrorResponseAdditionalErrorDetails(UniversalBaseModel):
+    source: typing.Optional[str] = None
+    step: typing.Optional[str] = None
+    field: typing.Optional[str] = None
+    reason: 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/types/offer_validation_response.py

@@ -0,0 +1,24 @@
+# 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 OfferValidationResponse(UniversalBaseModel):
+    """
+    Response containing validated offer result.
+    """
+
+    code: typing.Optional[str] = None
+    message: 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/types/order_response.py

@@ -0,0 +1,24 @@
+# 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 .order_response_data import OrderResponseData
+
+
+class OrderResponse(UniversalBaseModel):
+    """
+    Response containing order details.
+    """
+
+    data: typing.Optional[OrderResponseData] = 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/types/order_response_data.py

@@ -0,0 +1,127 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from .amount import Amount
+from .order_response_data_integration_mode import OrderResponseDataIntegrationMode
+from .order_response_data_purchase_details import OrderResponseDataPurchaseDetails
+from .order_response_data_status import OrderResponseDataStatus
+from .order_response_data_type import OrderResponseDataType
+from .payment_item import PaymentItem
+
+
+class OrderResponseData(UniversalBaseModel):
+    order_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the order in the Pine Labs Online database.
+    """
+
+    merchant_order_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier entered while creating the order.
+    """
+
+    type: typing.Optional[OrderResponseDataType] = pydantic.Field(default=None)
+    """
+    Payment type.
+    """
+
+    status: typing.Optional[OrderResponseDataStatus] = pydantic.Field(default=None)
+    """
+    Order status.
+    """
+
+    challenge_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to accept payment. Returned only after payment is linked against the order_id.
+    """
+
+    merchant_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the merchant in the Pine Labs Online database.
+    """
+
+    order_amount: typing.Optional[Amount] = None
+    pre_auth: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether pre-authorization is needed.
+    """
+
+    part_payment: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether part payment is enabled.
+    """
+
+    allowed_payment_methods: typing.Optional[typing.List[str]] = None
+    notes: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Note shown against the order.
+    """
+
+    callback_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to redirect customers after successful payment.
+    """
+
+    failure_callback_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to redirect customers after failed payment.
+    """
+
+    purchase_details: typing.Optional[OrderResponseDataPurchaseDetails] = None
+    payments: typing.Optional[typing.List[PaymentItem]] = pydantic.Field(default=None)
+    """
+    Array of payment details. Returned only for orders linked with a payment.
+    """
+
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the order was created.
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the order was last updated.
+    """
+
+    integration_mode: typing.Optional[OrderResponseDataIntegrationMode] = pydantic.Field(default=None)
+    """
+    Type of integration.
+    """
+
+    image_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    QR code image URL. Returned for UPI Intent with QR flow.
+    """
+
+    payment_retries_remaining: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Number of retry attempts remaining before payment is marked as failed.
+    """
+
+    is_mcc_transaction: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether the order is a MCC transaction.
+    """
+
+    is_domestic_txn_for_risk_enabled: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Whether risk evaluation is enabled for domestic transactions.
+    """
+
+    order_token: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the order token.
+    """
+
+    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