pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/types/challan_response.py

@@ -0,0 +1,77 @@
+# 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
+
+
+class ChallanResponse(UniversalBaseModel):
+    """
+    Response from the Create/Get Challan API.
+    """
+
+    challan_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the challan.
+    """
+
+    order_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the order.
+    """
+
+    virtual_account_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique customer account identifier.
+    """
+
+    account_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Account holder's name.
+    """
+
+    account_ifsc: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    IFSC code of the account.
+    """
+
+    account_bank_name: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Name of the bank.
+    """
+
+    account_bank_branch: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Branch of the bank.
+    """
+
+    challan_pdf_url: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    URL to download the challan PDF.
+    """
+
+    amount_due: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total amount due against the e-challan (in paisa).
+    """
+
+    expiry_date: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Date when the e-challan expires.
+    """
+
+    created_date: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    ISO 8601 UTC timestamp when the challan 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/check_point_balance_response.py

@@ -0,0 +1,43 @@
+# 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 .check_point_balance_response_balance import CheckPointBalanceResponseBalance
+from .check_point_balance_response_redeemable_amount import CheckPointBalanceResponseRedeemableAmount
+
+
+class CheckPointBalanceResponse(UniversalBaseModel):
+    """
+    Response from the Check Point Balance API.
+    """
+
+    balance: typing.Optional[CheckPointBalanceResponseBalance] = pydantic.Field(default=None)
+    """
+    Card balance details.
+    """
+
+    redeemable_amount: typing.Optional[CheckPointBalanceResponseRedeemableAmount] = pydantic.Field(default=None)
+    """
+    Redeemable amount details.
+    """
+
+    redeemable_points: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Total redeemable points available on the card.
+    """
+
+    is_eligible: typing.Optional[bool] = pydantic.Field(default=None)
+    """
+    Card eligibility status for pay by points.
+    """
+
+    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/check_point_balance_response_balance.py

@@ -0,0 +1,28 @@
+# 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 CheckPointBalanceResponseBalance(UniversalBaseModel):
+    """
+    Card balance details.
+    """
+
+    value: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Balance available on the card (in paisa).
+    """
+
+    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/check_point_balance_response_redeemable_amount.py

@@ -0,0 +1,28 @@
+# 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 CheckPointBalanceResponseRedeemableAmount(UniversalBaseModel):
+    """
+    Redeemable amount details.
+    """
+
+    value: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    Redeemable amount on card (in paisa).
+    """
+
+    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/checkout_customer.py

@@ -0,0 +1,55 @@
+# 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 .address import Address
+
+
+class CheckoutCustomer(UniversalBaseModel):
+    """
+    Customer details for checkout.
+    """
+
+    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.
+    """
+
+    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[Address] = None
+    shipping_address: typing.Optional[Address] = 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/checkout_product.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 CheckoutProduct(UniversalBaseModel):
+    """
+    Product details for checkout order.
+    """
+
+    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/checkout_purchase_details.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 .checkout_customer import CheckoutCustomer
+from .checkout_product import CheckoutProduct
+
+
+class CheckoutPurchaseDetails(UniversalBaseModel):
+    """
+    Object that contains the details of customer information and product details.
+    """
+
+    customer: typing.Optional[CheckoutCustomer] = None
+    product: typing.Optional[typing.List[CheckoutProduct]] = pydantic.Field(default=None)
+    """
+    Mandatory for EMI Order. An array of objects that contains the list of product 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/create_bulk_payout_response.py

@@ -0,0 +1,48 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .create_bulk_payout_response_status import CreateBulkPayoutResponseStatus
+from .payout_link import PayoutLink
+
+
+class CreateBulkPayoutResponse(UniversalBaseModel):
+    """
+    Response returned after creating a bulk payout via file upload.
+    """
+
+    request_reference_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="requestReferenceId"),
+        pydantic.Field(
+            alias="requestReferenceId", description="Unique identifier of the bulk request in Pine Labs database."
+        ),
+    ] = None
+    status: typing.Optional[CreateBulkPayoutResponseStatus] = pydantic.Field(default=None)
+    """
+    Bulk payout processing status.
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Message corresponding to the bulk payout status.
+    """
+
+    links: typing_extensions.Annotated[
+        typing.Optional[typing.List[PayoutLink]],
+        FieldMetadata(alias="_links"),
+        pydantic.Field(alias="_links", description="HATEOAS navigation links."),
+    ] = 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/create_bulk_payout_response_status.py

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

pinelabs/types/create_debit_response.py

@@ -0,0 +1,56 @@
+# 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 .create_debit_response_status import CreateDebitResponseStatus
+from .subscription_amount import SubscriptionAmount
+
+
+class CreateDebitResponse(UniversalBaseModel):
+    """
+    Response returned after creating a debit.
+    """
+
+    subscription_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the subscription.
+    """
+
+    presentation_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the presentation.
+    """
+
+    due_date: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The ISO 8601 UTC Timestamp when the payment is due.
+    """
+
+    amount: typing.Optional[SubscriptionAmount] = None
+    merchant_presentation_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the merchant presentation reference.
+    """
+
+    status: typing.Optional[CreateDebitResponseStatus] = pydantic.Field(default=None)
+    """
+    Debit status.
+    - CREATED: Presentation request successfully received.
+    - PENDING: Pre-debit notification initiated.
+    - PAUSED: Subscription is paused.
+    - CANCELLED: Subscription is cancelled.
+    - FAILED: Pre-debit notification or customer debit fails (up to 3 retries).
+    - COMPLETED: Debit is successful.
+    """
+
+    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/create_debit_response_status.py

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

pinelabs/types/create_payout_response.py

@@ -0,0 +1,100 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.serialization import FieldMetadata
+from .create_payout_response_mode import CreatePayoutResponseMode
+from .create_payout_response_status import CreatePayoutResponseStatus
+from .payout_amount import PayoutAmount
+from .payout_link import PayoutLink
+
+
+class CreatePayoutResponse(UniversalBaseModel):
+    """
+    Response returned after creating a payout.
+    """
+
+    client_reference_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="clientReferenceId"),
+        pydantic.Field(alias="clientReferenceId", description="Unique identifier to track the payout."),
+    ] = None
+    request_reference_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="requestReferenceId"),
+        pydantic.Field(
+            alias="requestReferenceId", description="Unique identifier of the request in Pine Labs database."
+        ),
+    ] = None
+    payment_reference_id: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="paymentReferenceId"),
+        pydantic.Field(
+            alias="paymentReferenceId", description="Unique identifier of the payment in Pine Labs database."
+        ),
+    ] = None
+    payee_name: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="payeeName"),
+        pydantic.Field(alias="payeeName", description="Name of the beneficiary."),
+    ] = None
+    account_number: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="accountNumber"),
+        pydantic.Field(alias="accountNumber", description="Masked account number of the beneficiary."),
+    ] = None
+    branch_code: typing_extensions.Annotated[
+        typing.Optional[str],
+        FieldMetadata(alias="branchCode"),
+        pydantic.Field(alias="branchCode", description="IFSC code of the beneficiary's bank."),
+    ] = None
+    amount: typing.Optional[PayoutAmount] = None
+    mode: typing.Optional[CreatePayoutResponseMode] = pydantic.Field(default=None)
+    """
+    Payment mode used for the payout.
+    """
+
+    status: typing.Optional[CreatePayoutResponseStatus] = pydantic.Field(default=None)
+    """
+    Current payout status.
+    - SCHEDULED: Request successfully received.
+    - PENDING: Funding account has insufficient balance.
+    - PROCESSING: Sent to bank, not yet processed.
+    - PROCESSED: Bank processed, confirmation pending.
+    - SUCCESS: Amount debited and credited successfully.
+    - FAILED: Transaction failed.
+    """
+
+    message: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Message corresponding to the payout status.
+    """
+
+    scheduled_at: typing_extensions.Annotated[
+        typing.Optional[dt.datetime],
+        FieldMetadata(alias="scheduledAt"),
+        pydantic.Field(alias="scheduledAt", description="Scheduled execution time in UTC."),
+    ] = None
+    remarks: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Description or reference text for the transaction.
+    """
+
+    links: typing_extensions.Annotated[
+        typing.Optional[typing.List[PayoutLink]],
+        FieldMetadata(alias="_links"),
+        pydantic.Field(alias="_links", description="HATEOAS navigation links."),
+    ] = 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/create_payout_response_mode.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreatePayoutResponseMode = typing.Union[typing.Literal["UPI", "IMPS", "NEFT", "RTGS"], typing.Any]

pinelabs/types/create_payout_response_status.py

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

pinelabs/types/create_presentation_response.py

@@ -0,0 +1,58 @@
+# 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 .create_presentation_response_status import CreatePresentationResponseStatus
+from .subscription_amount import SubscriptionAmount
+
+
+class CreatePresentationResponse(UniversalBaseModel):
+    """
+    Response returned after creating a presentation.
+    """
+
+    subscription_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the subscription.
+    """
+
+    presentation_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier for the presentation.
+    """
+
+    due_date: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    The ISO 8601 UTC Timestamp when the payment is due.
+    """
+
+    amount: typing.Optional[SubscriptionAmount] = None
+    status: typing.Optional[CreatePresentationResponseStatus] = pydantic.Field(default=None)
+    """
+    Presentation status.
+    - CREATED: Presentation request created successfully.
+    - PENDING: Request sent to bank, awaiting response.
+    - COMPLETED: Successfully processed.
+    - FAILED: Request failed at bank's end.
+    - CANCELLED: Presentation request cancelled.
+    - PAUSED: Subscription is currently paused.
+    - PARTIALLY_REFUNDED: Partial refund issued.
+    - REFUNDED: Full refund issued.
+    """
+
+    merchant_presentation_reference: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Unique identifier of the merchant presentation reference.
+    """
+
+    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/create_presentation_response_status.py

@@ -0,0 +1,10 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CreatePresentationResponseStatus = typing.Union[
+    typing.Literal[
+        "CREATED", "PENDING", "COMPLETED", "FAILED", "CANCELLED", "PAUSED", "PARTIALLY_REFUNDED", "REFUNDED"
+    ],
+    typing.Any,
+]