pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/types/payment_link_cart_item.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 .amount import Amount
+
+
+class PaymentLinkCartItem(UniversalBaseModel):
+    """
+    Individual cart item.
+    """
+
+    product_code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique product identifier.
+    """
+
+    product_amount: typing.Optional[Amount] = 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/payment_link_customer.py

@@ -0,0 +1,64 @@
+# 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 .payment_link_address import PaymentLinkAddress
+
+
+class PaymentLinkCustomer(UniversalBaseModel):
+    """
+    Customer information for payment link.
+    """
+
+    email_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Customer's email address.
+    """
+
+    first_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Customer's first name.
+    """
+
+    last_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Customer's last name.
+    """
+
+    customer_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the customer in the Pine Labs Online database.
+    """
+
+    mobile_number: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Customer's mobile number.
+    """
+
+    country_code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Country code of the mobile number.
+    """
+
+    billing_address: typing.Optional[PaymentLinkAddress] = None
+    shipping_address: typing.Optional[PaymentLinkAddress] = None
+    merchant_customer_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the customer for the request.
+    """
+
+    gstin: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Customer's GSTIN.
+    """
+
+    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/payment_link_product_detail.py

@@ -0,0 +1,30 @@
+# 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 .amount import Amount
+
+
+class PaymentLinkProductDetail(UniversalBaseModel):
+    """
+    Product details associated with the payment link.
+    """
+
+    product_code: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique product identifier.
+    """
+
+    product_amount: typing.Optional[Amount] = None
+    product_coupon_discount_amount: typing.Optional[Amount] = 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/payment_link_response.py

@@ -0,0 +1,113 @@
+# 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 .merchant_metadata import MerchantMetadata
+from .payment_link_account_details import PaymentLinkAccountDetails
+from .payment_link_customer import PaymentLinkCustomer
+from .payment_link_product_detail import PaymentLinkProductDetail
+from .payment_link_response_allowed_payment_methods_item import PaymentLinkResponseAllowedPaymentMethodsItem
+from .payment_link_response_status import PaymentLinkResponseStatus
+from .payment_link_split_info import PaymentLinkSplitInfo
+
+
+class PaymentLinkResponse(UniversalBaseModel):
+    """
+    Response returned from Payment Link APIs.
+    """
+
+    payment_link: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The payment link URL.
+    """
+
+    payment_link_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the payment link in the Pine Labs Online database.
+    """
+
+    status: typing.Optional[PaymentLinkResponseStatus] = pydantic.Field(default=None)
+    """
+    Payment link status.
+    """
+
+    amount: typing.Optional[Amount] = None
+    amount_due: typing.Optional[Amount] = None
+    order_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the order in the Pine Labs Online database.
+    """
+
+    merchant_payment_link_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier entered while creating a payment link.
+    """
+
+    description: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Description message against the payment link.
+    """
+
+    expire_by: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp when the payment link expires.
+    """
+
+    allowed_payment_methods: typing.Optional[typing.List[PaymentLinkResponseAllowedPaymentMethodsItem]] = (
+        pydantic.Field(default=None)
+    )
+    """
+    Payment methods offered to the customer.
+    """
+
+    pre_auth: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    The pre-authorization type.
+    true: When pre-authorization is needed.
+    false (default): When pre-authorization is not required.
+    """
+
+    failure_callback_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to redirect customers to a failure page.
+    """
+
+    is_mcc_transaction: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Identifies the Payment Link type.
+    true: Processed for a MCC transaction.
+    false (default): Processed for a regular transaction.
+    """
+
+    customer: typing.Optional[PaymentLinkCustomer] = None
+    product_details: typing.Optional[typing.List[PaymentLinkProductDetail]] = pydantic.Field(default=None)
+    """
+    List of products associated with the payment.
+    """
+
+    split_info: typing.Optional[PaymentLinkSplitInfo] = None
+    account_details: typing.Optional[PaymentLinkAccountDetails] = None
+    cart_coupon_discount_amount: typing.Optional[Amount] = None
+    merchant_metadata: typing.Optional[MerchantMetadata] = None
+    created_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC Timestamp when the payment link was created.
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC Timestamp when the payment link was last updated.
+    """
+
+    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/payment_link_response_allowed_payment_methods_item.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PaymentLinkResponseAllowedPaymentMethodsItem = typing.Union[
+    typing.Literal["CARD", "UPI", "POINTS", "NETBANKING", "WALLET", "CREDIT_EMI", "DEBIT_EMI"], typing.Any
+]

pinelabs/types/payment_link_response_status.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PaymentLinkResponseStatus = typing.Union[
+    typing.Literal["CREATED", "CLICKED", "PAYMENT_INITIATED", "PROCESSED", "PARTIAL_PROCESSED", "EXPIRED", "CANCELLED"],
+    typing.Any,
+]

pinelabs/types/payment_link_split_detail.py

@@ -0,0 +1,57 @@
+# 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 .payment_link_split_detail_status import PaymentLinkSplitDetailStatus
+
+
+class PaymentLinkSplitDetail(UniversalBaseModel):
+    """
+    Individual split detail entry.
+    """
+
+    split_merchant_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of your partner merchant in the Pine Labs Online database.
+    """
+
+    merchant_settlement_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier entered while creating an order in split.
+    """
+
+    split_settlement_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the split settlement in the Pine Labs Online database.
+    """
+
+    amount: typing.Optional[Amount] = None
+    on_hold: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Indicate whether the settlement is on hold for future release.
+    true: The settlement is placed on hold.
+    false: The settlement is processed immediately.
+    """
+
+    status: typing.Optional[PaymentLinkSplitDetailStatus] = pydantic.Field(default=None)
+    """
+    Split Settlement status.
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC Timestamp when the split order was created.
+    """
+
+    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/payment_link_split_detail_status.py

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

pinelabs/types/payment_link_split_info.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 .payment_link_split_detail import PaymentLinkSplitDetail
+
+
+class PaymentLinkSplitInfo(UniversalBaseModel):
+    """
+    Split settlement information.
+    """
+
+    split_type: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Type of split.
+    """
+
+    split_details: typing.Optional[typing.List[PaymentLinkSplitDetail]] = pydantic.Field(default=None)
+    """
+    An array of objects that contains the split 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/payment_object.py

@@ -0,0 +1,51 @@
+# 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 .payment_object_acquirer_data import PaymentObjectAcquirerData
+from .payment_object_payment_amount import PaymentObjectPaymentAmount
+from .payment_object_payment_method import PaymentObjectPaymentMethod
+from .payment_object_status import PaymentObjectStatus
+
+
+class PaymentObject(UniversalBaseModel):
+    """
+    Payment details associated with the refund.
+    """
+
+    id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the payment.
+    """
+
+    status: typing.Optional[PaymentObjectStatus] = pydantic.Field(default=None)
+    """
+    Payment status.
+    """
+
+    payment_amount: typing.Optional[PaymentObjectPaymentAmount] = None
+    payment_method: typing.Optional[PaymentObjectPaymentMethod] = pydantic.Field(default=None)
+    """
+    Type of payment method.
+    """
+
+    acquirer_data: typing.Optional[PaymentObjectAcquirerData] = None
+    offer_data: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Offer details associated with the payment.
+    """
+
+    created_at: typing.Optional[dt.datetime] = None
+    updated_at: typing.Optional[dt.datetime] = 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/payment_object_acquirer_data.py

@@ -0,0 +1,23 @@
+# 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 PaymentObjectAcquirerData(UniversalBaseModel):
+    approval_code: typing.Optional[str] = None
+    acquirer_reference: typing.Optional[str] = None
+    rrn: typing.Optional[str] = None
+    is_aggregator: typing.Optional[bool] = None
+    acquirer_name: 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/payment_object_payment_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 PaymentObjectPaymentAmount(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/types/payment_object_payment_method.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PaymentObjectPaymentMethod = typing.Union[typing.Literal["CARD", "UPI", "POINTS", "NETBANKING", "WALLET"], typing.Any]

pinelabs/types/payment_object_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PaymentObjectStatus = typing.Union[
+    typing.Literal["PENDING", "AUTHORIZED", "CANCELLED", "PROCESSED", "FAILED"], typing.Any
+]

pinelabs/types/payment_request_item.py

@@ -0,0 +1,54 @@
+# 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 .amount import Amount
+from .payment_request_item_device_info import PaymentRequestItemDeviceInfo
+from .payment_request_item_offer_data import PaymentRequestItemOfferData
+from .payment_request_item_payment_method import PaymentRequestItemPaymentMethod
+from .payment_request_item_payment_option import PaymentRequestItemPaymentOption
+
+
+class PaymentRequestItem(UniversalBaseModel):
+    """
+    A single payment request item. The `payment_method` field acts as a
+    discriminator to determine which `payment_option` structure applies.
+    """
+
+    merchant_payment_reference: str = pydantic.Field()
+    """
+    **Idempotency Key.** Unique payment reference assigned by the merchant. Duplicate requests with the same `merchant_payment_reference` will return the existing payment instead of creating a new one.
+    """
+
+    payment_amount: Amount
+    payment_method: PaymentRequestItemPaymentMethod = pydantic.Field()
+    """
+    Type of payment method for this payment.
+    """
+
+    payment_option: typing.Optional[PaymentRequestItemPaymentOption] = pydantic.Field(default=None)
+    """
+    **Mandatory object**<br><br>An object that contains the details of the payment options.<br><br>You can use either `card_details` or `card_token_details` or `cardless_details` as a payment option. One object is mandatory to process the request.
+    """
+
+    device_info: typing.Optional[PaymentRequestItemDeviceInfo] = pydantic.Field(default=None)
+    """
+    Device information details.
+    **Mandatory for SIMPL and SIMPL3 BNPL providers.**
+    """
+
+    offer_data: typing.Optional[PaymentRequestItemOfferData] = pydantic.Field(default=None)
+    """
+    An object that contains the offer data details. **Required for CREDIT_EMI, DEBIT_EMI, and CARDLESS_EMI payment methods.**
+    """
+
+    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/payment_request_item_device_info.py

@@ -0,0 +1,53 @@
+# 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 .payment_request_item_device_info_operating_system import PaymentRequestItemDeviceInfoOperatingSystem
+
+
+class PaymentRequestItemDeviceInfo(UniversalBaseModel):
+    """
+    Device information details.
+    **Mandatory for SIMPL and SIMPL3 BNPL providers.**
+    """
+
+    operating_system: typing.Optional[PaymentRequestItemDeviceInfoOperatingSystem] = pydantic.Field(default=None)
+    """
+    Type of operating system. **Mandatory when the request is made from a mobile platform.**
+    """
+
+    source_ip_address: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The IP address of the user's device initiating the request.
+    """
+
+    browser_ip_address: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The IP address captured from the user's browser during the transaction.
+    """
+
+    browser_user_agent: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The user's browser information string.
+    """
+
+    device_model: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The model of the user's device.
+    """
+
+    device_manufacturer: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    The name of the company that manufactured the user's device.
+    """
+
+    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/payment_request_item_device_info_operating_system.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+PaymentRequestItemDeviceInfoOperatingSystem = typing.Union[
+    typing.Literal["ANDROID", "IOS", "MACOS", "WINDOWS"], typing.Any
+]

pinelabs/types/payment_request_item_offer_data.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 .payment_request_item_offer_data_offer_details import PaymentRequestItemOfferDataOfferDetails
+
+
+class PaymentRequestItemOfferData(UniversalBaseModel):
+    """
+    An object that contains the offer data details. **Required for CREDIT_EMI, DEBIT_EMI, and CARDLESS_EMI payment methods.**
+    """
+
+    offer_details: typing.Optional[PaymentRequestItemOfferDataOfferDetails] = pydantic.Field(default=None)
+    """
+    An object that contains the offer 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/payment_request_item_offer_data_offer_details.py

@@ -0,0 +1,52 @@
+# 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 .payment_request_item_offer_data_offer_details_tenure import PaymentRequestItemOfferDataOfferDetailsTenure
+
+
+class PaymentRequestItemOfferDataOfferDetails(UniversalBaseModel):
+    """
+    An object that contains the offer details.
+    """
+
+    id: str = pydantic.Field()
+    """
+    Unique identifier of the Issuer offering the offer.
+    """
+
+    name: str = pydantic.Field()
+    """
+    Name of the issuer.
+    """
+
+    display_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Display name of the issuer.
+    """
+
+    issuer_type: str = pydantic.Field()
+    """
+    The type of the Issuer offering the offer.<br><br>Possible values<ul><li>`CC_BANK`</li><li>`DC_BANK`</ul></li>
+    """
+
+    priority: str = pydantic.Field()
+    """
+    The priority of the Issuer offering the offer.
+    """
+
+    tenure: typing.Optional[PaymentRequestItemOfferDataOfferDetailsTenure] = pydantic.Field(default=None)
+    """
+    An object that contains the EMI tenure details against the offer.
+    """
+
+    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